1 | /* |
1 | /* |
2 | * This file is part of Deliantra, the Roguelike Realtime MMORPG. |
2 | * This file is part of Deliantra, the Roguelike Realtime MMORPG. |
3 | * |
3 | * |
4 | * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Deliantra team |
4 | * Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team |
5 | * |
5 | * |
6 | * Deliantra is free software: you can redistribute it and/or modify |
6 | * Deliantra is free software: you can redistribute it and/or modify it under |
7 | * it under the terms of the GNU General Public License as published by |
7 | * the terms of the Affero GNU General Public License as published by the |
8 | * the Free Software Foundation, either version 3 of the License, or |
8 | * Free Software Foundation, either version 3 of the License, or (at your |
9 | * (at your option) any later version. |
9 | * option) any later version. |
10 | * |
10 | * |
11 | * This program is distributed in the hope that it will be useful, |
11 | * This program is distributed in the hope that it will be useful, |
12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
14 | * GNU General Public License for more details. |
14 | * GNU General Public License for more details. |
15 | * |
15 | * |
16 | * You should have received a copy of the GNU General Public License |
16 | * You should have received a copy of the Affero GNU General Public License |
17 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
17 | * and the GNU General Public License along with this program. If not, see |
|
|
18 | * <http://www.gnu.org/licenses/>. |
18 | * |
19 | * |
19 | * The authors can be reached via e-mail to <support@deliantra.net> |
20 | * The authors can be reached via e-mail to <support@deliantra.net> |
20 | */ |
21 | */ |
21 | |
22 | |
22 | #ifndef UTIL_H__ |
23 | #ifndef UTIL_H__ |
23 | #define UTIL_H__ |
24 | #define UTIL_H__ |
24 | |
25 | |
|
|
26 | #include <compiler.h> |
|
|
27 | |
25 | #define DEBUG_POISON 0x00 // poison memory before freeing it if != 0 |
28 | #define DEBUG_POISON 0x00 // poison memory before freeing it if != 0 |
26 | #define DEBUG_SALLOC 0 // add a debug wrapper around all sallocs |
29 | #define DEBUG_SALLOC 0 // add a debug wrapper around all sallocs |
27 | #define PREFER_MALLOC 0 // use malloc and not the slice allocator |
30 | #define PREFER_MALLOC 0 // use malloc and not the slice allocator |
28 | |
|
|
29 | #if __GNUC__ >= 3 |
|
|
30 | # define is_constant(c) __builtin_constant_p (c) |
|
|
31 | # define expect(expr,value) __builtin_expect ((expr),(value)) |
|
|
32 | # define prefetch(addr,rw,locality) __builtin_prefetch (addr, rw, locality) |
|
|
33 | #else |
|
|
34 | # define is_constant(c) 0 |
|
|
35 | # define expect(expr,value) (expr) |
|
|
36 | # define prefetch(addr,rw,locality) |
|
|
37 | #endif |
|
|
38 | |
|
|
39 | #if __GNUC__ < 4 || (__GNUC__ == 4 || __GNUC_MINOR__ < 4) |
|
|
40 | # define decltype(x) typeof(x) |
|
|
41 | #endif |
|
|
42 | |
|
|
43 | // put into ifs if you are very sure that the expression |
|
|
44 | // is mostly true or mosty false. note that these return |
|
|
45 | // booleans, not the expression. |
|
|
46 | #define expect_false(expr) expect ((expr) != 0, 0) |
|
|
47 | #define expect_true(expr) expect ((expr) != 0, 1) |
|
|
48 | |
31 | |
49 | #include <pthread.h> |
32 | #include <pthread.h> |
50 | |
33 | |
51 | #include <cstddef> |
34 | #include <cstddef> |
52 | #include <cmath> |
35 | #include <cmath> |
… | |
… | |
72 | #endif |
55 | #endif |
73 | |
56 | |
74 | // use C0X decltype for auto declarations until ISO C++ sanctifies them (if ever) |
57 | // use C0X decltype for auto declarations until ISO C++ sanctifies them (if ever) |
75 | #define auto(var,expr) decltype(expr) var = (expr) |
58 | #define auto(var,expr) decltype(expr) var = (expr) |
76 | |
59 | |
77 | // very ugly macro that basicaly declares and initialises a variable |
60 | // very ugly macro that basically declares and initialises a variable |
78 | // that is in scope for the next statement only |
61 | // that is in scope for the next statement only |
79 | // 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 |
80 | // (note: works great for pointers) |
63 | // (note: works great for pointers) |
81 | // most ugly macro I ever wrote |
64 | // most ugly macro I ever wrote |
82 | #define statementvar(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) |
… | |
… | |
96 | // as a is often a constant while b is the variable. it is still a bug, though. |
79 | // as a is often a constant while b is the variable. it is still a bug, though. |
97 | 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; } |
98 | 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; } |
99 | 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; } |
100 | |
83 | |
|
|
84 | template<typename T, typename U> static inline void min_it (T &v, U m) { v = min (v, (T)m); } |
|
|
85 | template<typename T, typename U> static inline void max_it (T &v, U m) { v = max (v, (T)m); } |
|
|
86 | template<typename T, typename U, typename V> static inline void clamp_it (T &v, U a, V b) { v = clamp (v, (T)a, (T)b); } |
|
|
87 | |
101 | template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; } |
88 | template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; } |
102 | |
89 | |
103 | template<typename T, typename U, typename V> static inline T min (T a, U b, V c) { return min (a, min (b, c)); } |
90 | template<typename T, typename U, typename V> static inline T min (T a, U b, V c) { return min (a, min (b, c)); } |
104 | template<typename T, typename U, typename V> static inline T max (T a, U b, V c) { return max (a, max (b, c)); } |
91 | template<typename T, typename U, typename V> static inline T max (T a, U b, V c) { return max (a, max (b, c)); } |
105 | |
92 | |
|
|
93 | // sign returns -1 or +1 |
|
|
94 | template<typename T> |
|
|
95 | static inline T sign (T v) { return v < 0 ? -1 : +1; } |
|
|
96 | // relies on 2c representation |
|
|
97 | template<> |
|
|
98 | inline sint8 sign (sint8 v) { return 1 - (sint8 (uint8 (v) >> 7) * 2); } |
|
|
99 | |
|
|
100 | // sign0 returns -1, 0 or +1 |
|
|
101 | template<typename T> |
|
|
102 | static inline T sign0 (T v) { return v ? sign (v) : 0; } |
|
|
103 | |
|
|
104 | // div* only work correctly for div > 0 |
|
|
105 | // div, with correct rounding (< 0.5 downwards, >=0.5 upwards) |
|
|
106 | template<typename T> static inline T div (T val, T div) |
|
|
107 | { |
|
|
108 | return expect_false (val < 0) ? - ((-val + (div - 1) / 2) / div) : (val + div / 2) / div; |
|
|
109 | } |
|
|
110 | // div, round-up |
|
|
111 | template<typename T> static inline T div_ru (T val, T div) |
|
|
112 | { |
|
|
113 | return expect_false (val < 0) ? - ((-val ) / div) : (val + div - 1) / div; |
|
|
114 | } |
|
|
115 | // div, round-down |
|
|
116 | template<typename T> static inline T div_rd (T val, T div) |
|
|
117 | { |
|
|
118 | return expect_false (val < 0) ? - ((-val + (div - 1) ) / div) : (val ) / div; |
|
|
119 | } |
|
|
120 | |
|
|
121 | // lerp* only work correctly for min_in < max_in |
|
|
122 | // Linear intERPolate, scales val from min_in..max_in to min_out..max_out |
106 | template<typename T> |
123 | template<typename T> |
107 | static inline T |
124 | static inline T |
108 | lerp (T val, T min_in, T max_in, T min_out, T max_out) |
125 | lerp (T val, T min_in, T max_in, T min_out, T max_out) |
109 | { |
126 | { |
110 | return (val - min_in) * (max_out - min_out) / (max_in - min_in) + min_out; |
127 | return min_out + div <T> ((val - min_in) * (max_out - min_out), max_in - min_in); |
|
|
128 | } |
|
|
129 | |
|
|
130 | // lerp, round-down |
|
|
131 | template<typename T> |
|
|
132 | static inline T |
|
|
133 | lerp_rd (T val, T min_in, T max_in, T min_out, T max_out) |
|
|
134 | { |
|
|
135 | return min_out + div_rd<T> ((val - min_in) * (max_out - min_out), max_in - min_in); |
|
|
136 | } |
|
|
137 | |
|
|
138 | // lerp, round-up |
|
|
139 | template<typename T> |
|
|
140 | static inline T |
|
|
141 | lerp_ru (T val, T min_in, T max_in, T min_out, T max_out) |
|
|
142 | { |
|
|
143 | return min_out + div_ru<T> ((val - min_in) * (max_out - min_out), max_in - min_in); |
111 | } |
144 | } |
112 | |
145 | |
113 | // lots of stuff taken from FXT |
146 | // lots of stuff taken from FXT |
114 | |
147 | |
115 | /* Rotate right. This is used in various places for checksumming */ |
148 | /* Rotate right. This is used in various places for checksumming */ |
… | |
… | |
153 | int32_t d = b - a; |
186 | int32_t d = b - a; |
154 | d &= d >> 31; |
187 | d &= d >> 31; |
155 | return b - d; |
188 | return b - d; |
156 | } |
189 | } |
157 | |
190 | |
158 | // this is much faster than crossfires original algorithm |
191 | // this is much faster than crossfire's original algorithm |
159 | // on modern cpus |
192 | // on modern cpus |
160 | inline int |
193 | inline int |
161 | isqrt (int n) |
194 | isqrt (int n) |
162 | { |
195 | { |
163 | return (int)sqrtf ((float)n); |
196 | return (int)sqrtf ((float)n); |
|
|
197 | } |
|
|
198 | |
|
|
199 | // this is kind of like the ^^ operator, if it would exist, without sequence point. |
|
|
200 | // more handy than it looks like, due to the implicit !! done on its arguments |
|
|
201 | inline bool |
|
|
202 | logical_xor (bool a, bool b) |
|
|
203 | { |
|
|
204 | return a != b; |
|
|
205 | } |
|
|
206 | |
|
|
207 | inline bool |
|
|
208 | logical_implies (bool a, bool b) |
|
|
209 | { |
|
|
210 | return a <= b; |
164 | } |
211 | } |
165 | |
212 | |
166 | // this is only twice as fast as naive sqrtf (dx*dy+dy*dy) |
213 | // this is only twice as fast as naive sqrtf (dx*dy+dy*dy) |
167 | #if 0 |
214 | #if 0 |
168 | // and has a max. error of 6 in the range -100..+100. |
215 | // and has a max. error of 6 in the range -100..+100. |
… | |
… | |
224 | g_slice_free1 (n * sizeof (T), (void *)ptr); |
271 | g_slice_free1 (n * sizeof (T), (void *)ptr); |
225 | assert (slice_alloc >= 0);//D |
272 | assert (slice_alloc >= 0);//D |
226 | } |
273 | } |
227 | } |
274 | } |
228 | |
275 | |
|
|
276 | // nulls the pointer |
|
|
277 | template<typename T> |
|
|
278 | inline void sfree0 (T *&ptr, int n = 1) throw () |
|
|
279 | { |
|
|
280 | sfree<T> (ptr, n); |
|
|
281 | ptr = 0; |
|
|
282 | } |
|
|
283 | |
229 | // makes dynamically allocated objects zero-initialised |
284 | // makes dynamically allocated objects zero-initialised |
230 | struct zero_initialised |
285 | struct zero_initialised |
231 | { |
286 | { |
232 | void *operator new (size_t s, void *p) |
287 | void *operator new (size_t s, void *p) |
233 | { |
288 | { |
… | |
… | |
241 | } |
296 | } |
242 | |
297 | |
243 | void *operator new[] (size_t s) |
298 | void *operator new[] (size_t s) |
244 | { |
299 | { |
245 | return salloc0<char> (s); |
300 | return salloc0<char> (s); |
|
|
301 | } |
|
|
302 | |
|
|
303 | void operator delete (void *p, size_t s) |
|
|
304 | { |
|
|
305 | sfree ((char *)p, s); |
|
|
306 | } |
|
|
307 | |
|
|
308 | void operator delete[] (void *p, size_t s) |
|
|
309 | { |
|
|
310 | sfree ((char *)p, s); |
|
|
311 | } |
|
|
312 | }; |
|
|
313 | |
|
|
314 | // makes dynamically allocated objects zero-initialised |
|
|
315 | struct slice_allocated |
|
|
316 | { |
|
|
317 | void *operator new (size_t s, void *p) |
|
|
318 | { |
|
|
319 | return p; |
|
|
320 | } |
|
|
321 | |
|
|
322 | void *operator new (size_t s) |
|
|
323 | { |
|
|
324 | return salloc<char> (s); |
|
|
325 | } |
|
|
326 | |
|
|
327 | void *operator new[] (size_t s) |
|
|
328 | { |
|
|
329 | return salloc<char> (s); |
246 | } |
330 | } |
247 | |
331 | |
248 | void operator delete (void *p, size_t s) |
332 | void operator delete (void *p, size_t s) |
249 | { |
333 | { |
250 | sfree ((char *)p, s); |
334 | sfree ((char *)p, s); |
… | |
… | |
314 | // P. L'Ecuyer, “Maximally Equidistributed Combined Tausworthe Generators”, Mathematics of Computation, 65, 213 (1996), 203–213. |
398 | // P. L'Ecuyer, “Maximally Equidistributed Combined Tausworthe Generators”, Mathematics of Computation, 65, 213 (1996), 203–213. |
315 | // http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps |
399 | // http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps |
316 | // http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps |
400 | // http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps |
317 | struct tausworthe_random_generator |
401 | struct tausworthe_random_generator |
318 | { |
402 | { |
319 | // generator |
|
|
320 | uint32_t state [4]; |
403 | uint32_t state [4]; |
321 | |
404 | |
322 | void operator =(const tausworthe_random_generator &src) |
405 | void operator =(const tausworthe_random_generator &src) |
323 | { |
406 | { |
324 | state [0] = src.state [0]; |
407 | state [0] = src.state [0]; |
… | |
… | |
327 | state [3] = src.state [3]; |
410 | state [3] = src.state [3]; |
328 | } |
411 | } |
329 | |
412 | |
330 | void seed (uint32_t seed); |
413 | void seed (uint32_t seed); |
331 | uint32_t next (); |
414 | uint32_t next (); |
|
|
415 | }; |
332 | |
416 | |
333 | // uniform distribution |
417 | // Xorshift RNGs, George Marsaglia |
|
|
418 | // http://www.jstatsoft.org/v08/i14/paper |
|
|
419 | // this one is about 40% faster than the tausworthe one above (i.e. not much), |
|
|
420 | // despite the inlining, and has the issue of only creating 2**32-1 numbers. |
|
|
421 | // see also http://www.iro.umontreal.ca/~lecuyer/myftp/papers/xorshift.pdf |
|
|
422 | struct xorshift_random_generator |
|
|
423 | { |
|
|
424 | uint32_t x, y; |
|
|
425 | |
|
|
426 | void operator =(const xorshift_random_generator &src) |
|
|
427 | { |
|
|
428 | x = src.x; |
|
|
429 | y = src.y; |
|
|
430 | } |
|
|
431 | |
|
|
432 | void seed (uint32_t seed) |
|
|
433 | { |
|
|
434 | x = seed; |
|
|
435 | y = seed * 69069U; |
|
|
436 | } |
|
|
437 | |
|
|
438 | uint32_t next () |
|
|
439 | { |
|
|
440 | uint32_t t = x ^ (x << 10); |
|
|
441 | x = y; |
|
|
442 | y = y ^ (y >> 13) ^ t ^ (t >> 10); |
|
|
443 | return y; |
|
|
444 | } |
|
|
445 | }; |
|
|
446 | |
|
|
447 | template<class generator> |
|
|
448 | struct random_number_generator : generator |
|
|
449 | { |
|
|
450 | // uniform distribution, 0 .. max (0, num - 1) |
334 | uint32_t operator ()(uint32_t num) |
451 | uint32_t operator ()(uint32_t num) |
335 | { |
452 | { |
336 | return is_constant (num) |
453 | return !is_constant (num) ? get_range (num) // non-constant |
337 | ? (next () * (uint64_t)num) >> 32U |
454 | : num & (num - 1) ? (this->next () * (uint64_t)num) >> 32U // constant, non-power-of-two |
338 | : get_range (num); |
455 | : this->next () & (num - 1); // constant, power-of-two |
339 | } |
456 | } |
340 | |
457 | |
341 | // return a number within (min .. max) |
458 | // return a number within (min .. max) |
342 | int operator () (int r_min, int r_max) |
459 | int operator () (int r_min, int r_max) |
343 | { |
460 | { |
… | |
… | |
354 | protected: |
471 | protected: |
355 | uint32_t get_range (uint32_t r_max); |
472 | uint32_t get_range (uint32_t r_max); |
356 | int get_range (int r_min, int r_max); |
473 | int get_range (int r_min, int r_max); |
357 | }; |
474 | }; |
358 | |
475 | |
359 | typedef tausworthe_random_generator rand_gen; |
476 | typedef random_number_generator<tausworthe_random_generator> rand_gen; |
360 | |
477 | |
361 | extern rand_gen rndm; |
478 | extern rand_gen rndm, rmg_rndm; |
362 | |
479 | |
363 | INTERFACE_CLASS (attachable) |
480 | INTERFACE_CLASS (attachable) |
364 | struct refcnt_base |
481 | struct refcnt_base |
365 | { |
482 | { |
366 | typedef int refcnt_t; |
483 | typedef int refcnt_t; |
… | |
… | |
433 | |
550 | |
434 | struct str_hash |
551 | struct str_hash |
435 | { |
552 | { |
436 | std::size_t operator ()(const char *s) const |
553 | std::size_t operator ()(const char *s) const |
437 | { |
554 | { |
438 | unsigned long hash = 0; |
555 | #if 0 |
|
|
556 | uint32_t hash = 0; |
439 | |
557 | |
440 | /* use the one-at-a-time hash function, which supposedly is |
558 | /* use the one-at-a-time hash function, which supposedly is |
441 | * better than the djb2-like one used by perl5.005, but |
559 | * better than the djb2-like one used by perl5.005, but |
442 | * certainly is better then the bug used here before. |
560 | * certainly is better then the bug used here before. |
443 | * see http://burtleburtle.net/bob/hash/doobs.html |
561 | * see http://burtleburtle.net/bob/hash/doobs.html |
… | |
… | |
450 | } |
568 | } |
451 | |
569 | |
452 | hash += hash << 3; |
570 | hash += hash << 3; |
453 | hash ^= hash >> 11; |
571 | hash ^= hash >> 11; |
454 | hash += hash << 15; |
572 | hash += hash << 15; |
|
|
573 | #else |
|
|
574 | // use FNV-1a hash (http://isthe.com/chongo/tech/comp/fnv/) |
|
|
575 | // it is about twice as fast as the one-at-a-time one, |
|
|
576 | // with good distribution. |
|
|
577 | // FNV-1a is faster on many cpus because the multiplication |
|
|
578 | // runs concurrent with the looping logic. |
|
|
579 | uint32_t hash = 2166136261; |
|
|
580 | |
|
|
581 | while (*s) |
|
|
582 | hash = (hash ^ *s++) * 16777619; |
|
|
583 | #endif |
455 | |
584 | |
456 | return hash; |
585 | return hash; |
457 | } |
586 | } |
458 | }; |
587 | }; |
459 | |
588 | |
… | |
… | |
554 | erase (&obj); |
683 | erase (&obj); |
555 | } |
684 | } |
556 | }; |
685 | }; |
557 | |
686 | |
558 | // basically does what strncpy should do, but appends "..." to strings exceeding length |
687 | // basically does what strncpy should do, but appends "..." to strings exceeding length |
|
|
688 | // returns the number of bytes actually used (including \0) |
559 | void assign (char *dst, const char *src, int maxlen); |
689 | int assign (char *dst, const char *src, int maxsize); |
560 | |
690 | |
561 | // type-safe version of assign |
691 | // type-safe version of assign |
562 | template<int N> |
692 | template<int N> |
563 | inline void assign (char (&dst)[N], const char *src) |
693 | inline int assign (char (&dst)[N], const char *src) |
564 | { |
694 | { |
565 | assign ((char *)&dst, src, N); |
695 | return assign ((char *)&dst, src, N); |
566 | } |
696 | } |
567 | |
697 | |
568 | typedef double tstamp; |
698 | typedef double tstamp; |
569 | |
699 | |
570 | // return current time as timestamp |
700 | // return current time as timestamp |
571 | tstamp now (); |
701 | tstamp now (); |
572 | |
702 | |
573 | int similar_direction (int a, int b); |
703 | int similar_direction (int a, int b); |
574 | |
704 | |
575 | // like sprintf, but returns a "static" buffer |
705 | // like v?sprintf, but returns a "static" buffer |
576 | const char *format (const char *format, ...); |
706 | char *vformat (const char *format, va_list ap); |
|
|
707 | char *format (const char *format, ...) attribute ((format (printf, 1, 2))); |
|
|
708 | |
|
|
709 | // safety-check player input which will become object->msg |
|
|
710 | bool msg_is_safe (const char *msg); |
577 | |
711 | |
578 | ///////////////////////////////////////////////////////////////////////////// |
712 | ///////////////////////////////////////////////////////////////////////////// |
579 | // threads, very very thin wrappers around pthreads |
713 | // threads, very very thin wrappers around pthreads |
580 | |
714 | |
581 | struct thread |
715 | struct thread |