|
|
1 | /* |
|
|
2 | * This file is part of Crossfire TRT, the Roguelike Realtime MORPG. |
|
|
3 | * |
|
|
4 | * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team |
|
|
5 | * |
|
|
6 | * Crossfire TRT is free software: you can redistribute it and/or modify |
|
|
7 | * it under the terms of the GNU General Public License as published by |
|
|
8 | * the Free Software Foundation, either version 3 of the License, or |
|
|
9 | * (at your option) any later version. |
|
|
10 | * |
|
|
11 | * This program is distributed in the hope that it will be useful, |
|
|
12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
|
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
|
14 | * GNU General Public License for more details. |
|
|
15 | * |
|
|
16 | * You should have received a copy of the GNU General Public License |
|
|
17 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
|
|
18 | * |
|
|
19 | * The authors can be reached via e-mail to <crossfire@schmorp.de> |
|
|
20 | */ |
|
|
21 | |
1 | #ifndef UTIL_H__ |
22 | #ifndef UTIL_H__ |
2 | #define UTIL_H__ |
23 | #define UTIL_H__ |
3 | |
24 | |
4 | //#define PREFER_MALLOC |
25 | //#define PREFER_MALLOC |
5 | |
26 | |
6 | #if __GNUC__ >= 3 |
27 | #if __GNUC__ >= 3 |
7 | # define is_constant(c) __builtin_constant_p (c) |
28 | # define is_constant(c) __builtin_constant_p (c) |
|
|
29 | # define expect(expr,value) __builtin_expect ((expr),(value)) |
|
|
30 | # define prefetch(addr,rw,locality) __builtin_prefetch (addr, rw, locality) |
8 | #else |
31 | #else |
9 | # define is_constant(c) 0 |
32 | # define is_constant(c) 0 |
|
|
33 | # define expect(expr,value) (expr) |
|
|
34 | # define prefetch(addr,rw,locality) |
10 | #endif |
35 | #endif |
|
|
36 | |
|
|
37 | #if __GNUC__ < 4 || (__GNUC__ == 4 || __GNUC_MINOR__ < 4) |
|
|
38 | # define decltype(x) typeof(x) |
|
|
39 | #endif |
|
|
40 | |
|
|
41 | // put into ifs if you are very sure that the expression |
|
|
42 | // is mostly true or mosty false. note that these return |
|
|
43 | // booleans, not the expression. |
|
|
44 | #define expect_false(expr) expect ((expr) != 0, 0) |
|
|
45 | #define expect_true(expr) expect ((expr) != 0, 1) |
11 | |
46 | |
12 | #include <cstddef> |
47 | #include <cstddef> |
13 | #include <cmath> |
48 | #include <cmath> |
14 | #include <new> |
49 | #include <new> |
15 | #include <vector> |
50 | #include <vector> |
… | |
… | |
17 | #include <glib.h> |
52 | #include <glib.h> |
18 | |
53 | |
19 | #include <shstr.h> |
54 | #include <shstr.h> |
20 | #include <traits.h> |
55 | #include <traits.h> |
21 | |
56 | |
22 | // use a gcc extension for auto declarations until ISO C++ sanctifies them |
57 | // use C0X decltype for auto declarations until ISO C++ sanctifies them (if ever) |
23 | #define AUTODECL(var,expr) typeof(expr) var = (expr) |
58 | #define auto(var,expr) decltype(expr) var = (expr) |
24 | |
59 | |
25 | // very ugly macro that basicaly declares and initialises a variable |
60 | // very ugly macro that basicaly declares and initialises a variable |
26 | // that is in scope for the next statement only |
61 | // that is in scope for the next statement only |
27 | // works only for stuff that can be assigned 0 and converts to false |
62 | // works only for stuff that can be assigned 0 and converts to false |
28 | // (note: works great for pointers) |
63 | // (note: works great for pointers) |
29 | // most ugly macro I ever wrote |
64 | // most ugly macro I ever wrote |
30 | #define declvar(type, name, value) if (type name = 0) { } else if (((name) = (value)), 1) |
65 | #define statementvar(type, name, value) if (type name = 0) { } else if (((name) = (value)), 1) |
31 | |
66 | |
32 | // in range including end |
67 | // in range including end |
33 | #define IN_RANGE_INC(val,beg,end) \ |
68 | #define IN_RANGE_INC(val,beg,end) \ |
34 | ((unsigned int)(val) - (unsigned int)(beg) <= (unsigned int)(end) - (unsigned int)(beg)) |
69 | ((unsigned int)(val) - (unsigned int)(beg) <= (unsigned int)(end) - (unsigned int)(beg)) |
35 | |
70 | |
… | |
… | |
45 | template<typename T, typename U> static inline T max (T a, U b) { return (U)a > b ? (U)a : b; } |
80 | template<typename T, typename U> static inline T max (T a, U b) { return (U)a > b ? (U)a : b; } |
46 | template<typename T, typename U, typename V> static inline T clamp (T v, U a, V b) { return v < (T)a ? (T)a : v >(T)b ? (T)b : v; } |
81 | template<typename T, typename U, typename V> static inline T clamp (T v, U a, V b) { return v < (T)a ? (T)a : v >(T)b ? (T)b : v; } |
47 | |
82 | |
48 | template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; } |
83 | template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; } |
49 | |
84 | |
|
|
85 | template<typename T> |
|
|
86 | static inline T |
|
|
87 | lerp (T val, T min_in, T max_in, T min_out, T max_out) |
|
|
88 | { |
|
|
89 | return (val - min_in) * (max_out - min_out) / (max_in - min_in) + min_out; |
|
|
90 | } |
|
|
91 | |
50 | // lots of stuff taken from FXT |
92 | // lots of stuff taken from FXT |
51 | |
93 | |
52 | /* Rotate right. This is used in various places for checksumming */ |
94 | /* Rotate right. This is used in various places for checksumming */ |
53 | //TODO: this sucks, use a better checksum algo |
95 | //TODO: that sucks, use a better checksum algo |
54 | static inline uint32_t |
96 | static inline uint32_t |
55 | rotate_right (uint32_t c) |
97 | rotate_right (uint32_t c, uint32_t count = 1) |
56 | { |
98 | { |
57 | return (c << 31) | (c >> 1); |
99 | return (c << (32 - count)) | (c >> count); |
|
|
100 | } |
|
|
101 | |
|
|
102 | static inline uint32_t |
|
|
103 | rotate_left (uint32_t c, uint32_t count = 1) |
|
|
104 | { |
|
|
105 | return (c >> (32 - count)) | (c << count); |
58 | } |
106 | } |
59 | |
107 | |
60 | // Return abs(a-b) |
108 | // Return abs(a-b) |
61 | // Both a and b must not have the most significant bit set |
109 | // Both a and b must not have the most significant bit set |
62 | static inline uint32_t |
110 | static inline uint32_t |
… | |
… | |
256 | |
304 | |
257 | void seed (uint32_t seed); |
305 | void seed (uint32_t seed); |
258 | uint32_t next (); |
306 | uint32_t next (); |
259 | |
307 | |
260 | // uniform distribution |
308 | // uniform distribution |
261 | uint32_t operator ()(uint32_t r_max) |
309 | uint32_t operator ()(uint32_t num) |
262 | { |
310 | { |
263 | return is_constant (r_max) |
311 | return is_constant (num) |
264 | ? this->next () % r_max |
312 | ? (next () * (uint64_t)num) >> 32U |
265 | : get_range (r_max); |
313 | : get_range (num); |
266 | } |
314 | } |
267 | |
315 | |
268 | // return a number within (min .. max) |
316 | // return a number within (min .. max) |
269 | int operator () (int r_min, int r_max) |
317 | int operator () (int r_min, int r_max) |
270 | { |
318 | { |
271 | return is_constant (r_min) && is_constant (r_max) |
319 | return is_constant (r_min) && is_constant (r_max) && r_min <= r_max |
272 | ? r_min + (*this) (max (r_max - r_min + 1, 1)) |
320 | ? r_min + operator ()(r_max - r_min + 1) |
273 | : get_range (r_min, r_max); |
321 | : get_range (r_min, r_max); |
274 | } |
322 | } |
275 | |
323 | |
276 | double operator ()() |
324 | double operator ()() |
277 | { |
325 | { |
… | |
… | |
356 | { |
404 | { |
357 | return !strcmp (a, b); |
405 | return !strcmp (a, b); |
358 | } |
406 | } |
359 | }; |
407 | }; |
360 | |
408 | |
|
|
409 | // Mostly the same as std::vector, but insert/erase can reorder |
|
|
410 | // the elements, making append(=insert)/remove O(1) instead of O(n). |
|
|
411 | // |
|
|
412 | // NOTE: only some forms of erase are available |
361 | template<class T> |
413 | template<class T> |
362 | struct unordered_vector : std::vector<T, slice_allocator<T> > |
414 | struct unordered_vector : std::vector<T, slice_allocator<T> > |
363 | { |
415 | { |
364 | typedef typename unordered_vector::iterator iterator; |
416 | typedef typename unordered_vector::iterator iterator; |
365 | |
417 | |
… | |
… | |
375 | { |
427 | { |
376 | erase ((unsigned int )(i - this->begin ())); |
428 | erase ((unsigned int )(i - this->begin ())); |
377 | } |
429 | } |
378 | }; |
430 | }; |
379 | |
431 | |
380 | template<class T, int T::* index> |
432 | // This container blends advantages of linked lists |
|
|
433 | // (efficiency) with vectors (random access) by |
|
|
434 | // by using an unordered vector and storing the vector |
|
|
435 | // index inside the object. |
|
|
436 | // |
|
|
437 | // + memory-efficient on most 64 bit archs |
|
|
438 | // + O(1) insert/remove |
|
|
439 | // + free unique (but varying) id for inserted objects |
|
|
440 | // + cache-friendly iteration |
|
|
441 | // - only works for pointers to structs |
|
|
442 | // |
|
|
443 | // NOTE: only some forms of erase/insert are available |
|
|
444 | typedef int object_vector_index; |
|
|
445 | |
|
|
446 | template<class T, object_vector_index T::*indexmember> |
381 | struct object_vector : std::vector<T *, slice_allocator<T *> > |
447 | struct object_vector : std::vector<T *, slice_allocator<T *> > |
382 | { |
448 | { |
|
|
449 | typedef typename object_vector::iterator iterator; |
|
|
450 | |
|
|
451 | bool contains (const T *obj) const |
|
|
452 | { |
|
|
453 | return obj->*indexmember; |
|
|
454 | } |
|
|
455 | |
|
|
456 | iterator find (const T *obj) |
|
|
457 | { |
|
|
458 | return obj->*indexmember |
|
|
459 | ? this->begin () + obj->*indexmember - 1 |
|
|
460 | : this->end (); |
|
|
461 | } |
|
|
462 | |
383 | void insert (T *obj) |
463 | void insert (T *obj) |
384 | { |
464 | { |
385 | assert (!(obj->*index)); |
|
|
386 | push_back (obj); |
465 | push_back (obj); |
387 | obj->*index = this->size (); |
466 | obj->*indexmember = this->size (); |
388 | } |
467 | } |
389 | |
468 | |
390 | void insert (T &obj) |
469 | void insert (T &obj) |
391 | { |
470 | { |
392 | insert (&obj); |
471 | insert (&obj); |
393 | } |
472 | } |
394 | |
473 | |
395 | void erase (T *obj) |
474 | void erase (T *obj) |
396 | { |
475 | { |
397 | assert (obj->*index); |
|
|
398 | int pos = obj->*index; |
476 | unsigned int pos = obj->*indexmember; |
399 | obj->*index = 0; |
477 | obj->*indexmember = 0; |
400 | |
478 | |
401 | if (pos < this->size ()) |
479 | if (pos < this->size ()) |
402 | { |
480 | { |
403 | (*this)[pos - 1] = (*this)[this->size () - 1]; |
481 | (*this)[pos - 1] = (*this)[this->size () - 1]; |
404 | (*this)[pos - 1]->*index = pos; |
482 | (*this)[pos - 1]->*indexmember = pos; |
405 | } |
483 | } |
406 | |
484 | |
407 | this->pop_back (); |
485 | this->pop_back (); |
408 | } |
486 | } |
409 | |
487 | |
410 | void erase (T &obj) |
488 | void erase (T &obj) |
411 | { |
489 | { |
412 | errase (&obj); |
490 | erase (&obj); |
413 | } |
491 | } |
414 | }; |
492 | }; |
415 | |
493 | |
416 | // basically does what strncpy should do, but appends "..." to strings exceeding length |
494 | // basically does what strncpy should do, but appends "..." to strings exceeding length |
417 | void assign (char *dst, const char *src, int maxlen); |
495 | void assign (char *dst, const char *src, int maxlen); |
… | |
… | |
428 | // return current time as timestampe |
506 | // return current time as timestampe |
429 | tstamp now (); |
507 | tstamp now (); |
430 | |
508 | |
431 | int similar_direction (int a, int b); |
509 | int similar_direction (int a, int b); |
432 | |
510 | |
|
|
511 | // like printf, but returns a std::string |
|
|
512 | const std::string format (const char *format, ...); |
|
|
513 | |
433 | #endif |
514 | #endif |
434 | |
515 | |