|
|
1 | /* |
|
|
2 | * This file is part of Crossfire TRT, the Multiplayer Online Role Playing Game. |
|
|
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 it |
|
|
7 | * under the terms of the GNU General Public License as published by the Free |
|
|
8 | * Software Foundation; either version 2 of the License, or (at your option) |
|
|
9 | * any later version. |
|
|
10 | * |
|
|
11 | * This program is distributed in the hope that it will be useful, but |
|
|
12 | * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY |
|
|
13 | * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
|
14 | * for more details. |
|
|
15 | * |
|
|
16 | * You should have received a copy of the GNU General Public License along |
|
|
17 | * with Crossfire TRT; if not, write to the Free Software Foundation, Inc. 51 |
|
|
18 | * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
|
|
19 | * |
|
|
20 | * The authors can be reached via e-mail to <crossfire@schmorp.de> |
|
|
21 | */ |
|
|
22 | |
| 1 | #ifndef UTIL_H__ |
23 | #ifndef UTIL_H__ |
| 2 | #define UTIL_H__ |
24 | #define UTIL_H__ |
| 3 | |
25 | |
| 4 | //#define PREFER_MALLOC |
26 | //#define PREFER_MALLOC |
| 5 | |
27 | |
| 6 | #if __GNUC__ >= 3 |
28 | #if __GNUC__ >= 3 |
| 7 | # define is_constant(c) __builtin_constant_p (c) |
29 | # define is_constant(c) __builtin_constant_p (c) |
|
|
30 | # define expect(expr,value) __builtin_expect ((expr),(value)) |
|
|
31 | # define prefetch(addr,rw,locality) __builtin_prefetch (addr, rw, locality) |
| 8 | #else |
32 | #else |
| 9 | # define is_constant(c) 0 |
33 | # define is_constant(c) 0 |
|
|
34 | # define expect(expr,value) (expr) |
|
|
35 | # define prefetch(addr,rw,locality) |
| 10 | #endif |
36 | #endif |
|
|
37 | |
|
|
38 | #if __GNUC__ < 4 || (__GNUC__ == 4 || __GNUC_MINOR__ < 4) |
|
|
39 | # define decltype(x) typeof(x) |
|
|
40 | #endif |
|
|
41 | |
|
|
42 | // put into ifs if you are very sure that the expression |
|
|
43 | // is mostly true or mosty false. note that these return |
|
|
44 | // booleans, not the expression. |
|
|
45 | #define expect_false(expr) expect ((expr) != 0, 0) |
|
|
46 | #define expect_true(expr) expect ((expr) != 0, 1) |
| 11 | |
47 | |
| 12 | #include <cstddef> |
48 | #include <cstddef> |
| 13 | #include <cmath> |
49 | #include <cmath> |
| 14 | #include <new> |
50 | #include <new> |
| 15 | #include <vector> |
51 | #include <vector> |
| … | |
… | |
| 17 | #include <glib.h> |
53 | #include <glib.h> |
| 18 | |
54 | |
| 19 | #include <shstr.h> |
55 | #include <shstr.h> |
| 20 | #include <traits.h> |
56 | #include <traits.h> |
| 21 | |
57 | |
| 22 | // use a gcc extension for auto declarations until ISO C++ sanctifies them |
58 | // use C0X decltype for auto declarations until ISO C++ sanctifies them (if ever) |
| 23 | #define AUTODECL(var,expr) typeof(expr) var = (expr) |
59 | #define auto(var,expr) decltype(expr) var = (expr) |
| 24 | |
60 | |
| 25 | // very ugly macro that basicaly declares and initialises a variable |
61 | // very ugly macro that basicaly declares and initialises a variable |
| 26 | // that is in scope for the next statement only |
62 | // that is in scope for the next statement only |
| 27 | // works only for stuff that can be assigned 0 and converts to false |
63 | // works only for stuff that can be assigned 0 and converts to false |
| 28 | // (note: works great for pointers) |
64 | // (note: works great for pointers) |
| 29 | // most ugly macro I ever wrote |
65 | // most ugly macro I ever wrote |
| 30 | #define declvar(type, name, value) if (type name = 0) { } else if (((name) = (value)), 1) |
66 | #define statementvar(type, name, value) if (type name = 0) { } else if (((name) = (value)), 1) |
| 31 | |
67 | |
| 32 | // in range including end |
68 | // in range including end |
| 33 | #define IN_RANGE_INC(val,beg,end) \ |
69 | #define IN_RANGE_INC(val,beg,end) \ |
| 34 | ((unsigned int)(val) - (unsigned int)(beg) <= (unsigned int)(end) - (unsigned int)(beg)) |
70 | ((unsigned int)(val) - (unsigned int)(beg) <= (unsigned int)(end) - (unsigned int)(beg)) |
| 35 | |
71 | |
| … | |
… | |
| 44 | template<typename T, typename U> static inline T min (T a, U b) { return (U)a < b ? (U)a : b; } |
80 | template<typename T, typename U> static inline T min (T a, U b) { return (U)a < b ? (U)a : b; } |
| 45 | template<typename T, typename U> static inline T max (T a, U b) { return (U)a > b ? (U)a : b; } |
81 | 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; } |
82 | 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 | |
83 | |
| 48 | template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; } |
84 | template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; } |
|
|
85 | |
|
|
86 | template<typename T> |
|
|
87 | static inline T |
|
|
88 | lerp (T val, T min_in, T max_in, T min_out, T max_out) |
|
|
89 | { |
|
|
90 | return (val - min_in) * (max_out - min_out) / (max_in - min_in) + min_out; |
|
|
91 | } |
|
|
92 | |
|
|
93 | // lots of stuff taken from FXT |
|
|
94 | |
|
|
95 | /* Rotate right. This is used in various places for checksumming */ |
|
|
96 | //TODO: that sucks, use a better checksum algo |
|
|
97 | static inline uint32_t |
|
|
98 | rotate_right (uint32_t c, uint32_t count = 1) |
|
|
99 | { |
|
|
100 | return (c << (32 - count)) | (c >> count); |
|
|
101 | } |
|
|
102 | |
|
|
103 | static inline uint32_t |
|
|
104 | rotate_left (uint32_t c, uint32_t count = 1) |
|
|
105 | { |
|
|
106 | return (c >> (32 - count)) | (c << count); |
|
|
107 | } |
|
|
108 | |
|
|
109 | // Return abs(a-b) |
|
|
110 | // Both a and b must not have the most significant bit set |
|
|
111 | static inline uint32_t |
|
|
112 | upos_abs_diff (uint32_t a, uint32_t b) |
|
|
113 | { |
|
|
114 | long d1 = b - a; |
|
|
115 | long d2 = (d1 & (d1 >> 31)) << 1; |
|
|
116 | |
|
|
117 | return d1 - d2; // == (b - d) - (a + d); |
|
|
118 | } |
|
|
119 | |
|
|
120 | // Both a and b must not have the most significant bit set |
|
|
121 | static inline uint32_t |
|
|
122 | upos_min (uint32_t a, uint32_t b) |
|
|
123 | { |
|
|
124 | int32_t d = b - a; |
|
|
125 | d &= d >> 31; |
|
|
126 | return a + d; |
|
|
127 | } |
|
|
128 | |
|
|
129 | // Both a and b must not have the most significant bit set |
|
|
130 | static inline uint32_t |
|
|
131 | upos_max (uint32_t a, uint32_t b) |
|
|
132 | { |
|
|
133 | int32_t d = b - a; |
|
|
134 | d &= d >> 31; |
|
|
135 | return b - d; |
|
|
136 | } |
| 49 | |
137 | |
| 50 | // this is much faster than crossfires original algorithm |
138 | // this is much faster than crossfires original algorithm |
| 51 | // on modern cpus |
139 | // on modern cpus |
| 52 | inline int |
140 | inline int |
| 53 | isqrt (int n) |
141 | isqrt (int n) |
| … | |
… | |
| 217 | |
305 | |
| 218 | void seed (uint32_t seed); |
306 | void seed (uint32_t seed); |
| 219 | uint32_t next (); |
307 | uint32_t next (); |
| 220 | |
308 | |
| 221 | // uniform distribution |
309 | // uniform distribution |
| 222 | uint32_t operator ()(uint32_t r_max) |
310 | uint32_t operator ()(uint32_t num) |
| 223 | { |
311 | { |
| 224 | return is_constant (r_max) |
312 | return is_constant (num) |
| 225 | ? this->next () % r_max |
313 | ? (next () * (uint64_t)num) >> 32U |
| 226 | : get_range (r_max); |
314 | : get_range (num); |
| 227 | } |
315 | } |
| 228 | |
316 | |
| 229 | // return a number within (min .. max) |
317 | // return a number within (min .. max) |
| 230 | int operator () (int r_min, int r_max) |
318 | int operator () (int r_min, int r_max) |
| 231 | { |
319 | { |
| 232 | return is_constant (r_min) && is_constant (r_max) |
320 | return is_constant (r_min) && is_constant (r_max) && r_min <= r_max |
| 233 | ? r_min + (*this) (max (r_max - r_min + 1, 1)) |
321 | ? r_min + operator ()(r_max - r_min + 1) |
| 234 | : get_range (r_min, r_max); |
322 | : get_range (r_min, r_max); |
| 235 | } |
323 | } |
| 236 | |
324 | |
| 237 | double operator ()() |
325 | double operator ()() |
| 238 | { |
326 | { |
| … | |
… | |
| 317 | { |
405 | { |
| 318 | return !strcmp (a, b); |
406 | return !strcmp (a, b); |
| 319 | } |
407 | } |
| 320 | }; |
408 | }; |
| 321 | |
409 | |
|
|
410 | // Mostly the same as std::vector, but insert/erase can reorder |
|
|
411 | // the elements, making insret/remove O(1) instead of O(n). |
|
|
412 | // |
|
|
413 | // NOTE: only some forms of erase/insert are available |
| 322 | template<class T> |
414 | template<class T> |
| 323 | struct unordered_vector : std::vector<T, slice_allocator<T> > |
415 | struct unordered_vector : std::vector<T, slice_allocator<T> > |
| 324 | { |
416 | { |
| 325 | typedef typename unordered_vector::iterator iterator; |
417 | typedef typename unordered_vector::iterator iterator; |
| 326 | |
418 | |
| … | |
… | |
| 336 | { |
428 | { |
| 337 | erase ((unsigned int )(i - this->begin ())); |
429 | erase ((unsigned int )(i - this->begin ())); |
| 338 | } |
430 | } |
| 339 | }; |
431 | }; |
| 340 | |
432 | |
|
|
433 | // This container blends advantages of linked lists |
|
|
434 | // (efficiency) with vectors (random access) by |
|
|
435 | // by using an unordered vector and storing the vector |
|
|
436 | // index inside the object. |
|
|
437 | // |
|
|
438 | // + memory-efficient on most 64 bit archs |
|
|
439 | // + O(1) insert/remove |
|
|
440 | // + free unique (but varying) id for inserted objects |
|
|
441 | // + cache-friendly iteration |
|
|
442 | // - only works for pointers to structs |
|
|
443 | // |
|
|
444 | // NOTE: only some forms of erase/insert are available |
| 341 | template<class T, int T::* index> |
445 | template<class T, int T::* index> |
| 342 | struct object_vector : std::vector<T *, slice_allocator<T *> > |
446 | struct object_vector : std::vector<T *, slice_allocator<T *> > |
| 343 | { |
447 | { |
|
|
448 | typedef typename object_vector::iterator iterator; |
|
|
449 | |
|
|
450 | bool contains (const T *obj) const |
|
|
451 | { |
|
|
452 | return obj->*index; |
|
|
453 | } |
|
|
454 | |
|
|
455 | iterator find (const T *obj) |
|
|
456 | { |
|
|
457 | return obj->*index |
|
|
458 | ? this->begin () + obj->*index - 1 |
|
|
459 | : this->end (); |
|
|
460 | } |
|
|
461 | |
| 344 | void insert (T *obj) |
462 | void insert (T *obj) |
| 345 | { |
463 | { |
| 346 | assert (!(obj->*index)); |
|
|
| 347 | push_back (obj); |
464 | push_back (obj); |
| 348 | obj->*index = this->size (); |
465 | obj->*index = this->size (); |
| 349 | } |
466 | } |
| 350 | |
467 | |
| 351 | void insert (T &obj) |
468 | void insert (T &obj) |
| … | |
… | |
| 353 | insert (&obj); |
470 | insert (&obj); |
| 354 | } |
471 | } |
| 355 | |
472 | |
| 356 | void erase (T *obj) |
473 | void erase (T *obj) |
| 357 | { |
474 | { |
| 358 | assert (obj->*index); |
|
|
| 359 | int pos = obj->*index; |
475 | unsigned int pos = obj->*index; |
| 360 | obj->*index = 0; |
476 | obj->*index = 0; |
| 361 | |
477 | |
| 362 | if (pos < this->size ()) |
478 | if (pos < this->size ()) |
| 363 | { |
479 | { |
| 364 | (*this)[pos - 1] = (*this)[this->size () - 1]; |
480 | (*this)[pos - 1] = (*this)[this->size () - 1]; |
| … | |
… | |
| 389 | // return current time as timestampe |
505 | // return current time as timestampe |
| 390 | tstamp now (); |
506 | tstamp now (); |
| 391 | |
507 | |
| 392 | int similar_direction (int a, int b); |
508 | int similar_direction (int a, int b); |
| 393 | |
509 | |
|
|
510 | // like printf, but returns a std::string |
|
|
511 | const std::string format (const char *format, ...); |
|
|
512 | |
| 394 | #endif |
513 | #endif |
| 395 | |
514 | |
