|
|
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 | |
|
|
25 | //#define PREFER_MALLOC |
|
|
26 | |
| 4 | #if __GNUC__ >= 3 |
27 | #if __GNUC__ >= 3 |
| 5 | # 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) |
| 6 | #else |
31 | #else |
| 7 | # define is_constant(c) 0 |
32 | # define is_constant(c) 0 |
|
|
33 | # define expect(expr,value) (expr) |
|
|
34 | # define prefetch(addr,rw,locality) |
| 8 | #endif |
35 | #endif |
| 9 | |
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) |
|
|
46 | |
| 10 | #include <cstddef> |
47 | #include <cstddef> |
|
|
48 | #include <cmath> |
|
|
49 | #include <new> |
|
|
50 | #include <vector> |
| 11 | |
51 | |
| 12 | #include <glib.h> |
52 | #include <glib.h> |
| 13 | |
53 | |
|
|
54 | #include <shstr.h> |
|
|
55 | #include <traits.h> |
|
|
56 | |
| 14 | // 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) |
| 15 | #define AUTODECL(var,expr) typeof(expr) var = (expr) |
58 | #define auto(var,expr) decltype(expr) var = (expr) |
|
|
59 | |
|
|
60 | // very ugly macro that basicaly declares and initialises a variable |
|
|
61 | // that is in scope for the next statement only |
|
|
62 | // works only for stuff that can be assigned 0 and converts to false |
|
|
63 | // (note: works great for pointers) |
|
|
64 | // most ugly macro I ever wrote |
|
|
65 | #define statementvar(type, name, value) if (type name = 0) { } else if (((name) = (value)), 1) |
|
|
66 | |
|
|
67 | // in range including end |
|
|
68 | #define IN_RANGE_INC(val,beg,end) \ |
|
|
69 | ((unsigned int)(val) - (unsigned int)(beg) <= (unsigned int)(end) - (unsigned int)(beg)) |
|
|
70 | |
|
|
71 | // in range excluding end |
|
|
72 | #define IN_RANGE_EXC(val,beg,end) \ |
|
|
73 | ((unsigned int)(val) - (unsigned int)(beg) < (unsigned int)(end) - (unsigned int)(beg)) |
|
|
74 | |
|
|
75 | void fork_abort (const char *msg); |
|
|
76 | |
|
|
77 | // rationale for using (U) not (T) is to reduce signed/unsigned issues, |
|
|
78 | // as a is often a constant while b is the variable. it is still a bug, though. |
|
|
79 | 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 max (T a, U b) { return (U)a > b ? (U)a : b; } |
|
|
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; } |
|
|
82 | |
|
|
83 | template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; } |
|
|
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 | |
|
|
92 | // lots of stuff taken from FXT |
|
|
93 | |
|
|
94 | /* Rotate right. This is used in various places for checksumming */ |
|
|
95 | //TODO: that sucks, use a better checksum algo |
|
|
96 | static inline uint32_t |
|
|
97 | rotate_right (uint32_t c, uint32_t count = 1) |
|
|
98 | { |
|
|
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); |
|
|
106 | } |
|
|
107 | |
|
|
108 | // Return abs(a-b) |
|
|
109 | // Both a and b must not have the most significant bit set |
|
|
110 | static inline uint32_t |
|
|
111 | upos_abs_diff (uint32_t a, uint32_t b) |
|
|
112 | { |
|
|
113 | long d1 = b - a; |
|
|
114 | long d2 = (d1 & (d1 >> 31)) << 1; |
|
|
115 | |
|
|
116 | return d1 - d2; // == (b - d) - (a + d); |
|
|
117 | } |
|
|
118 | |
|
|
119 | // Both a and b must not have the most significant bit set |
|
|
120 | static inline uint32_t |
|
|
121 | upos_min (uint32_t a, uint32_t b) |
|
|
122 | { |
|
|
123 | int32_t d = b - a; |
|
|
124 | d &= d >> 31; |
|
|
125 | return a + d; |
|
|
126 | } |
|
|
127 | |
|
|
128 | // Both a and b must not have the most significant bit set |
|
|
129 | static inline uint32_t |
|
|
130 | upos_max (uint32_t a, uint32_t b) |
|
|
131 | { |
|
|
132 | int32_t d = b - a; |
|
|
133 | d &= d >> 31; |
|
|
134 | return b - d; |
|
|
135 | } |
|
|
136 | |
|
|
137 | // this is much faster than crossfires original algorithm |
|
|
138 | // on modern cpus |
|
|
139 | inline int |
|
|
140 | isqrt (int n) |
|
|
141 | { |
|
|
142 | return (int)sqrtf ((float)n); |
|
|
143 | } |
|
|
144 | |
|
|
145 | // this is only twice as fast as naive sqrtf (dx*dy+dy*dy) |
|
|
146 | #if 0 |
|
|
147 | // and has a max. error of 6 in the range -100..+100. |
|
|
148 | #else |
|
|
149 | // and has a max. error of 9 in the range -100..+100. |
|
|
150 | #endif |
|
|
151 | inline int |
|
|
152 | idistance (int dx, int dy) |
|
|
153 | { |
|
|
154 | unsigned int dx_ = abs (dx); |
|
|
155 | unsigned int dy_ = abs (dy); |
|
|
156 | |
|
|
157 | #if 0 |
|
|
158 | return dx_ > dy_ |
|
|
159 | ? (dx_ * 61685 + dy_ * 26870) >> 16 |
|
|
160 | : (dy_ * 61685 + dx_ * 26870) >> 16; |
|
|
161 | #else |
|
|
162 | return dx_ + dy_ - min (dx_, dy_) * 5 / 8; |
|
|
163 | #endif |
|
|
164 | } |
|
|
165 | |
|
|
166 | /* |
|
|
167 | * absdir(int): Returns a number between 1 and 8, which represent |
|
|
168 | * the "absolute" direction of a number (it actually takes care of |
|
|
169 | * "overflow" in previous calculations of a direction). |
|
|
170 | */ |
|
|
171 | inline int |
|
|
172 | absdir (int d) |
|
|
173 | { |
|
|
174 | return ((d - 1) & 7) + 1; |
|
|
175 | } |
| 16 | |
176 | |
| 17 | // makes dynamically allocated objects zero-initialised |
177 | // makes dynamically allocated objects zero-initialised |
| 18 | struct zero_initialised |
178 | struct zero_initialised |
| 19 | { |
179 | { |
| 20 | void *operator new (size_t s, void *p) |
180 | void *operator new (size_t s, void *p) |
| … | |
… | |
| 42 | { |
202 | { |
| 43 | g_slice_free1 (s, p); |
203 | g_slice_free1 (s, p); |
| 44 | } |
204 | } |
| 45 | }; |
205 | }; |
| 46 | |
206 | |
|
|
207 | void *salloc_ (int n) throw (std::bad_alloc); |
|
|
208 | void *salloc_ (int n, void *src) throw (std::bad_alloc); |
|
|
209 | |
| 47 | // strictly the same as g_slice_alloc, but never returns 0 |
210 | // strictly the same as g_slice_alloc, but never returns 0 |
| 48 | void *alloc (int s) throw (std::bad_alloc); |
211 | template<typename T> |
|
|
212 | inline T *salloc (int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T)); } |
|
|
213 | |
|
|
214 | // also copies src into the new area, like "memdup" |
|
|
215 | // if src is 0, clears the memory |
|
|
216 | template<typename T> |
|
|
217 | inline T *salloc (int n, T *src) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), (void *)src); } |
|
|
218 | |
|
|
219 | // clears the memory |
|
|
220 | template<typename T> |
|
|
221 | inline T *salloc0(int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), 0); } |
|
|
222 | |
| 49 | // for symmetry |
223 | // for symmetry |
| 50 | inline void dealloc (void *p, int s) throw () |
224 | template<typename T> |
|
|
225 | inline void sfree (T *ptr, int n = 1) throw () |
| 51 | { |
226 | { |
| 52 | g_slice_free1 (s, p); |
227 | #ifdef PREFER_MALLOC |
|
|
228 | free (ptr); |
|
|
229 | #else |
|
|
230 | g_slice_free1 (n * sizeof (T), (void *)ptr); |
|
|
231 | #endif |
| 53 | } |
232 | } |
| 54 | |
233 | |
| 55 | // a STL-compatible allocator that uses g_slice |
234 | // a STL-compatible allocator that uses g_slice |
| 56 | // boy, this is verbose |
235 | // boy, this is verbose |
| 57 | template<typename Tp> |
236 | template<typename Tp> |
| … | |
… | |
| 81 | pointer address (reference x) const { return &x; } |
260 | pointer address (reference x) const { return &x; } |
| 82 | const_pointer address (const_reference x) const { return &x; } |
261 | const_pointer address (const_reference x) const { return &x; } |
| 83 | |
262 | |
| 84 | pointer allocate (size_type n, const_pointer = 0) |
263 | pointer allocate (size_type n, const_pointer = 0) |
| 85 | { |
264 | { |
| 86 | return static_cast<pointer>(alloc (n * sizeof (Tp))); |
265 | return salloc<Tp> (n); |
| 87 | } |
266 | } |
| 88 | |
267 | |
| 89 | void deallocate (pointer p, size_type n) |
268 | void deallocate (pointer p, size_type n) |
| 90 | { |
269 | { |
| 91 | dealloc (static_cast<void *>(p), n * sizeof (Tp)); |
270 | sfree<Tp> (p, n); |
| 92 | } |
271 | } |
| 93 | |
272 | |
| 94 | size_type max_size ()const throw () |
273 | size_type max_size ()const throw () |
| 95 | { |
274 | { |
| 96 | return size_t (-1) / sizeof (Tp); |
275 | return size_t (-1) / sizeof (Tp); |
| … | |
… | |
| 105 | { |
284 | { |
| 106 | p->~Tp (); |
285 | p->~Tp (); |
| 107 | } |
286 | } |
| 108 | }; |
287 | }; |
| 109 | |
288 | |
| 110 | struct refcounted |
289 | // P. L'Ecuyer, “Maximally Equidistributed Combined Tausworthe Generators”, Mathematics of Computation, 65, 213 (1996), 203–213. |
|
|
290 | // http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps |
|
|
291 | // http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps |
|
|
292 | struct tausworthe_random_generator |
| 111 | { |
293 | { |
| 112 | mutable int refcnt; |
294 | // generator |
| 113 | refcounted () : refcnt (0) { } |
295 | uint32_t state [4]; |
| 114 | void refcnt_inc () { ++refcnt; } |
296 | |
| 115 | void refcnt_dec () { --refcnt; } |
297 | void operator =(const tausworthe_random_generator &src) |
|
|
298 | { |
|
|
299 | state [0] = src.state [0]; |
|
|
300 | state [1] = src.state [1]; |
|
|
301 | state [2] = src.state [2]; |
|
|
302 | state [3] = src.state [3]; |
|
|
303 | } |
|
|
304 | |
|
|
305 | void seed (uint32_t seed); |
|
|
306 | uint32_t next (); |
|
|
307 | |
|
|
308 | // uniform distribution |
|
|
309 | uint32_t operator ()(uint32_t num) |
|
|
310 | { |
|
|
311 | return is_constant (num) |
|
|
312 | ? (next () * (uint64_t)num) >> 32U |
|
|
313 | : get_range (num); |
|
|
314 | } |
|
|
315 | |
|
|
316 | // return a number within (min .. max) |
|
|
317 | int operator () (int r_min, int r_max) |
|
|
318 | { |
|
|
319 | return is_constant (r_min) && is_constant (r_max) && r_min <= r_max |
|
|
320 | ? r_min + operator ()(r_max - r_min + 1) |
|
|
321 | : get_range (r_min, r_max); |
|
|
322 | } |
|
|
323 | |
|
|
324 | double operator ()() |
|
|
325 | { |
|
|
326 | return this->next () / (double)0xFFFFFFFFU; |
|
|
327 | } |
|
|
328 | |
|
|
329 | protected: |
|
|
330 | uint32_t get_range (uint32_t r_max); |
|
|
331 | int get_range (int r_min, int r_max); |
| 116 | }; |
332 | }; |
|
|
333 | |
|
|
334 | typedef tausworthe_random_generator rand_gen; |
|
|
335 | |
|
|
336 | extern rand_gen rndm; |
| 117 | |
337 | |
| 118 | template<class T> |
338 | template<class T> |
| 119 | struct refptr |
339 | struct refptr |
| 120 | { |
340 | { |
| 121 | T *p; |
341 | T *p; |
| … | |
… | |
| 143 | T &operator * () const { return *p; } |
363 | T &operator * () const { return *p; } |
| 144 | T *operator ->() const { return p; } |
364 | T *operator ->() const { return p; } |
| 145 | |
365 | |
| 146 | operator T *() const { return p; } |
366 | operator T *() const { return p; } |
| 147 | }; |
367 | }; |
|
|
368 | |
|
|
369 | typedef refptr<maptile> maptile_ptr; |
|
|
370 | typedef refptr<object> object_ptr; |
|
|
371 | typedef refptr<archetype> arch_ptr; |
|
|
372 | typedef refptr<client> client_ptr; |
|
|
373 | typedef refptr<player> player_ptr; |
| 148 | |
374 | |
| 149 | struct str_hash |
375 | struct str_hash |
| 150 | { |
376 | { |
| 151 | std::size_t operator ()(const char *s) const |
377 | std::size_t operator ()(const char *s) const |
| 152 | { |
378 | { |
| … | |
… | |
| 178 | { |
404 | { |
| 179 | return !strcmp (a, b); |
405 | return !strcmp (a, b); |
| 180 | } |
406 | } |
| 181 | }; |
407 | }; |
| 182 | |
408 | |
| 183 | #include <vector> |
409 | // Mostly the same as std::vector, but insert/erase can reorder |
| 184 | |
410 | // the elements, making append(=insert)/remove O(1) instead of O(n). |
|
|
411 | // |
|
|
412 | // NOTE: only some forms of erase are available |
| 185 | template<class obj> |
413 | template<class T> |
| 186 | struct unordered_vector : std::vector<obj, slice_allocator<obj> > |
414 | struct unordered_vector : std::vector<T, slice_allocator<T> > |
| 187 | { |
415 | { |
| 188 | typedef typename unordered_vector::iterator iterator; |
416 | typedef typename unordered_vector::iterator iterator; |
| 189 | |
417 | |
| 190 | void erase (unsigned int pos) |
418 | void erase (unsigned int pos) |
| 191 | { |
419 | { |
| … | |
… | |
| 199 | { |
427 | { |
| 200 | erase ((unsigned int )(i - this->begin ())); |
428 | erase ((unsigned int )(i - this->begin ())); |
| 201 | } |
429 | } |
| 202 | }; |
430 | }; |
| 203 | |
431 | |
| 204 | template<typename T, typename U> static inline T min (T a, U b) { return a < (T)b ? a : (T)b; } |
432 | // This container blends advantages of linked lists |
| 205 | template<typename T, typename U> static inline T max (T a, U b) { return a > (T)b ? a : (T)b; } |
433 | // (efficiency) with vectors (random access) by |
| 206 | template<typename T, typename U, typename V> static inline T clamp (T v, U a, V b) { return v < (T)a ? a : v >(T)b ? b : v; } |
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; |
| 207 | |
445 | |
| 208 | template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; } |
446 | template<class T, object_vector_index T::*indexmember> |
|
|
447 | struct object_vector : std::vector<T *, slice_allocator<T *> > |
|
|
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 | |
|
|
463 | void insert (T *obj) |
|
|
464 | { |
|
|
465 | push_back (obj); |
|
|
466 | obj->*indexmember = this->size (); |
|
|
467 | } |
|
|
468 | |
|
|
469 | void insert (T &obj) |
|
|
470 | { |
|
|
471 | insert (&obj); |
|
|
472 | } |
|
|
473 | |
|
|
474 | void erase (T *obj) |
|
|
475 | { |
|
|
476 | unsigned int pos = obj->*indexmember; |
|
|
477 | obj->*indexmember = 0; |
|
|
478 | |
|
|
479 | if (pos < this->size ()) |
|
|
480 | { |
|
|
481 | (*this)[pos - 1] = (*this)[this->size () - 1]; |
|
|
482 | (*this)[pos - 1]->*indexmember = pos; |
|
|
483 | } |
|
|
484 | |
|
|
485 | this->pop_back (); |
|
|
486 | } |
|
|
487 | |
|
|
488 | void erase (T &obj) |
|
|
489 | { |
|
|
490 | erase (&obj); |
|
|
491 | } |
|
|
492 | }; |
| 209 | |
493 | |
| 210 | // 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 |
| 211 | void assign (char *dst, const char *src, int maxlen); |
495 | void assign (char *dst, const char *src, int maxlen); |
| 212 | |
496 | |
| 213 | // type-safe version of assign |
497 | // type-safe version of assign |
| … | |
… | |
| 215 | inline void assign (char (&dst)[N], const char *src) |
499 | inline void assign (char (&dst)[N], const char *src) |
| 216 | { |
500 | { |
| 217 | assign ((char *)&dst, src, N); |
501 | assign ((char *)&dst, src, N); |
| 218 | } |
502 | } |
| 219 | |
503 | |
|
|
504 | typedef double tstamp; |
|
|
505 | |
|
|
506 | // return current time as timestampe |
|
|
507 | tstamp now (); |
|
|
508 | |
|
|
509 | int similar_direction (int a, int b); |
|
|
510 | |
|
|
511 | // like printf, but returns a std::string |
|
|
512 | const std::string format (const char *format, ...); |
|
|
513 | |
| 220 | #endif |
514 | #endif |
| 221 | |
515 | |
