|
|
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 | |
|
|
26 | //#define PREFER_MALLOC |
|
|
27 | |
4 | #if __GNUC__ >= 3 |
28 | #if __GNUC__ >= 3 |
5 | # 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) |
6 | #else |
32 | #else |
7 | # define is_constant(c) 0 |
33 | # define is_constant(c) 0 |
|
|
34 | # define expect(expr,value) (expr) |
|
|
35 | # define prefetch(addr,rw,locality) |
8 | #endif |
36 | #endif |
9 | |
37 | |
|
|
38 | // put into ifs if you are very sure that the expression |
|
|
39 | // is mostly true or mosty false. note that these return |
|
|
40 | // booleans, not the expression. |
|
|
41 | #define expect_false(expr) expect ((expr) != 0, 0) |
|
|
42 | #define expect_true(expr) expect ((expr) != 0, 1) |
|
|
43 | |
10 | #include <cstddef> |
44 | #include <cstddef> |
|
|
45 | #include <cmath> |
|
|
46 | #include <new> |
|
|
47 | #include <vector> |
11 | |
48 | |
12 | #include <glib.h> |
49 | #include <glib.h> |
13 | |
50 | |
|
|
51 | #include <shstr.h> |
|
|
52 | #include <traits.h> |
|
|
53 | |
14 | // use a gcc extension for auto declarations until ISO C++ sanctifies them |
54 | // use a gcc extension for auto declarations until ISO C++ sanctifies them |
15 | #define AUTODECL(var,expr) typeof(expr) var = (expr) |
55 | #define auto(var,expr) typeof(expr) var = (expr) |
|
|
56 | |
|
|
57 | // very ugly macro that basicaly declares and initialises a variable |
|
|
58 | // that is in scope for the next statement only |
|
|
59 | // works only for stuff that can be assigned 0 and converts to false |
|
|
60 | // (note: works great for pointers) |
|
|
61 | // most ugly macro I ever wrote |
|
|
62 | #define declvar(type, name, value) if (type name = 0) { } else if (((name) = (value)), 1) |
|
|
63 | |
|
|
64 | // in range including end |
|
|
65 | #define IN_RANGE_INC(val,beg,end) \ |
|
|
66 | ((unsigned int)(val) - (unsigned int)(beg) <= (unsigned int)(end) - (unsigned int)(beg)) |
|
|
67 | |
|
|
68 | // in range excluding end |
|
|
69 | #define IN_RANGE_EXC(val,beg,end) \ |
|
|
70 | ((unsigned int)(val) - (unsigned int)(beg) < (unsigned int)(end) - (unsigned int)(beg)) |
|
|
71 | |
|
|
72 | void fork_abort (const char *msg); |
|
|
73 | |
|
|
74 | // rationale for using (U) not (T) is to reduce signed/unsigned issues, |
|
|
75 | // as a is often a constant while b is the variable. it is still a bug, though. |
|
|
76 | template<typename T, typename U> static inline T min (T a, U b) { return (U)a < b ? (U)a : b; } |
|
|
77 | template<typename T, typename U> static inline T max (T a, U b) { return (U)a > b ? (U)a : b; } |
|
|
78 | 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; } |
|
|
79 | |
|
|
80 | template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; } |
|
|
81 | |
|
|
82 | template<typename T> |
|
|
83 | static inline T |
|
|
84 | lerp (T val, T min_in, T max_in, T min_out, T max_out) |
|
|
85 | { |
|
|
86 | return (val - min_in) * (max_out - min_out) / (max_in - min_in) + min_out; |
|
|
87 | } |
|
|
88 | |
|
|
89 | // lots of stuff taken from FXT |
|
|
90 | |
|
|
91 | /* Rotate right. This is used in various places for checksumming */ |
|
|
92 | //TODO: that sucks, use a better checksum algo |
|
|
93 | static inline uint32_t |
|
|
94 | rotate_right (uint32_t c, uint32_t count = 1) |
|
|
95 | { |
|
|
96 | return (c << (32 - count)) | (c >> count); |
|
|
97 | } |
|
|
98 | |
|
|
99 | static inline uint32_t |
|
|
100 | rotate_left (uint32_t c, uint32_t count = 1) |
|
|
101 | { |
|
|
102 | return (c >> (32 - count)) | (c << count); |
|
|
103 | } |
|
|
104 | |
|
|
105 | // Return abs(a-b) |
|
|
106 | // Both a and b must not have the most significant bit set |
|
|
107 | static inline uint32_t |
|
|
108 | upos_abs_diff (uint32_t a, uint32_t b) |
|
|
109 | { |
|
|
110 | long d1 = b - a; |
|
|
111 | long d2 = (d1 & (d1 >> 31)) << 1; |
|
|
112 | |
|
|
113 | return d1 - d2; // == (b - d) - (a + d); |
|
|
114 | } |
|
|
115 | |
|
|
116 | // Both a and b must not have the most significant bit set |
|
|
117 | static inline uint32_t |
|
|
118 | upos_min (uint32_t a, uint32_t b) |
|
|
119 | { |
|
|
120 | int32_t d = b - a; |
|
|
121 | d &= d >> 31; |
|
|
122 | return a + d; |
|
|
123 | } |
|
|
124 | |
|
|
125 | // Both a and b must not have the most significant bit set |
|
|
126 | static inline uint32_t |
|
|
127 | upos_max (uint32_t a, uint32_t b) |
|
|
128 | { |
|
|
129 | int32_t d = b - a; |
|
|
130 | d &= d >> 31; |
|
|
131 | return b - d; |
|
|
132 | } |
|
|
133 | |
|
|
134 | // this is much faster than crossfires original algorithm |
|
|
135 | // on modern cpus |
|
|
136 | inline int |
|
|
137 | isqrt (int n) |
|
|
138 | { |
|
|
139 | return (int)sqrtf ((float)n); |
|
|
140 | } |
|
|
141 | |
|
|
142 | // this is only twice as fast as naive sqrtf (dx*dy+dy*dy) |
|
|
143 | #if 0 |
|
|
144 | // and has a max. error of 6 in the range -100..+100. |
|
|
145 | #else |
|
|
146 | // and has a max. error of 9 in the range -100..+100. |
|
|
147 | #endif |
|
|
148 | inline int |
|
|
149 | idistance (int dx, int dy) |
|
|
150 | { |
|
|
151 | unsigned int dx_ = abs (dx); |
|
|
152 | unsigned int dy_ = abs (dy); |
|
|
153 | |
|
|
154 | #if 0 |
|
|
155 | return dx_ > dy_ |
|
|
156 | ? (dx_ * 61685 + dy_ * 26870) >> 16 |
|
|
157 | : (dy_ * 61685 + dx_ * 26870) >> 16; |
|
|
158 | #else |
|
|
159 | return dx_ + dy_ - min (dx_, dy_) * 5 / 8; |
|
|
160 | #endif |
|
|
161 | } |
|
|
162 | |
|
|
163 | /* |
|
|
164 | * absdir(int): Returns a number between 1 and 8, which represent |
|
|
165 | * the "absolute" direction of a number (it actually takes care of |
|
|
166 | * "overflow" in previous calculations of a direction). |
|
|
167 | */ |
|
|
168 | inline int |
|
|
169 | absdir (int d) |
|
|
170 | { |
|
|
171 | return ((d - 1) & 7) + 1; |
|
|
172 | } |
16 | |
173 | |
17 | // makes dynamically allocated objects zero-initialised |
174 | // makes dynamically allocated objects zero-initialised |
18 | struct zero_initialised |
175 | struct zero_initialised |
19 | { |
176 | { |
20 | void *operator new (size_t s, void *p) |
177 | void *operator new (size_t s, void *p) |
… | |
… | |
42 | { |
199 | { |
43 | g_slice_free1 (s, p); |
200 | g_slice_free1 (s, p); |
44 | } |
201 | } |
45 | }; |
202 | }; |
46 | |
203 | |
|
|
204 | void *salloc_ (int n) throw (std::bad_alloc); |
|
|
205 | void *salloc_ (int n, void *src) throw (std::bad_alloc); |
|
|
206 | |
47 | // strictly the same as g_slice_alloc, but never returns 0 |
207 | // strictly the same as g_slice_alloc, but never returns 0 |
48 | void *salloc (int size) throw (std::bad_alloc); |
208 | template<typename T> |
|
|
209 | inline T *salloc (int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T)); } |
|
|
210 | |
49 | // also copies src into the new area, like "memdup" |
211 | // also copies src into the new area, like "memdup" |
50 | // if src is 0, clears the memory |
212 | // if src is 0, clears the memory |
51 | void *salloc (int size, void *src) throw (std::bad_alloc); |
|
|
52 | |
|
|
53 | // and as a template |
|
|
54 | template<typename T> |
213 | template<typename T> |
55 | inline T *salloc (int size) throw (std::bad_alloc) { return (T *)salloc (size * sizeof (T)); } |
214 | inline T *salloc (int n, T *src) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), (void *)src); } |
|
|
215 | |
|
|
216 | // clears the memory |
56 | template<typename T> |
217 | template<typename T> |
57 | inline T *salloc (int size, T *src) throw (std::bad_alloc) { return (T *)salloc (size * sizeof (T), (void *)src); } |
218 | inline T *salloc0(int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), 0); } |
58 | |
219 | |
59 | // for symmetry |
220 | // for symmetry |
60 | template<typename T> |
221 | template<typename T> |
61 | inline void sfree (T *ptr, int size) throw () |
222 | inline void sfree (T *ptr, int n = 1) throw () |
62 | { |
223 | { |
|
|
224 | #ifdef PREFER_MALLOC |
|
|
225 | free (ptr); |
|
|
226 | #else |
63 | g_slice_free1 (size * sizeof (T), (void *)ptr); |
227 | g_slice_free1 (n * sizeof (T), (void *)ptr); |
|
|
228 | #endif |
64 | } |
229 | } |
65 | |
230 | |
66 | // a STL-compatible allocator that uses g_slice |
231 | // a STL-compatible allocator that uses g_slice |
67 | // boy, this is verbose |
232 | // boy, this is verbose |
68 | template<typename Tp> |
233 | template<typename Tp> |
… | |
… | |
97 | return salloc<Tp> (n); |
262 | return salloc<Tp> (n); |
98 | } |
263 | } |
99 | |
264 | |
100 | void deallocate (pointer p, size_type n) |
265 | void deallocate (pointer p, size_type n) |
101 | { |
266 | { |
102 | sfree (p, n); |
267 | sfree<Tp> (p, n); |
103 | } |
268 | } |
104 | |
269 | |
105 | size_type max_size ()const throw () |
270 | size_type max_size ()const throw () |
106 | { |
271 | { |
107 | return size_t (-1) / sizeof (Tp); |
272 | return size_t (-1) / sizeof (Tp); |
… | |
… | |
116 | { |
281 | { |
117 | p->~Tp (); |
282 | p->~Tp (); |
118 | } |
283 | } |
119 | }; |
284 | }; |
120 | |
285 | |
121 | struct refcounted |
286 | // P. L'Ecuyer, “Maximally Equidistributed Combined Tausworthe Generators”, Mathematics of Computation, 65, 213 (1996), 203–213. |
|
|
287 | // http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme.ps |
|
|
288 | // http://www.iro.umontreal.ca/~lecuyer/myftp/papers/tausme2.ps |
|
|
289 | struct tausworthe_random_generator |
122 | { |
290 | { |
123 | refcounted () : refcnt (0) { } |
291 | // generator |
124 | // virtual ~refcounted (); |
292 | uint32_t state [4]; |
125 | void refcnt_inc () { ++refcnt; } |
293 | |
126 | void refcnt_dec () { --refcnt; } |
294 | void operator =(const tausworthe_random_generator &src) |
127 | bool dead () { return refcnt == 0; } |
295 | { |
128 | mutable int refcnt; |
296 | state [0] = src.state [0]; |
129 | #if 0 |
297 | state [1] = src.state [1]; |
130 | private: |
298 | state [2] = src.state [2]; |
131 | static refcounted *rc_first; |
299 | state [3] = src.state [3]; |
132 | refcounted *rc_next; |
300 | } |
133 | #endif |
301 | |
|
|
302 | void seed (uint32_t seed); |
|
|
303 | uint32_t next (); |
|
|
304 | |
|
|
305 | // uniform distribution |
|
|
306 | uint32_t operator ()(uint32_t num) |
|
|
307 | { |
|
|
308 | return is_constant (num) |
|
|
309 | ? (next () * (uint64_t)num) >> 32U |
|
|
310 | : get_range (num); |
|
|
311 | } |
|
|
312 | |
|
|
313 | // return a number within (min .. max) |
|
|
314 | int operator () (int r_min, int r_max) |
|
|
315 | { |
|
|
316 | return is_constant (r_min) && is_constant (r_max) && r_min <= r_max |
|
|
317 | ? r_min + operator ()(r_max - r_min + 1) |
|
|
318 | : get_range (r_min, r_max); |
|
|
319 | } |
|
|
320 | |
|
|
321 | double operator ()() |
|
|
322 | { |
|
|
323 | return this->next () / (double)0xFFFFFFFFU; |
|
|
324 | } |
|
|
325 | |
|
|
326 | protected: |
|
|
327 | uint32_t get_range (uint32_t r_max); |
|
|
328 | int get_range (int r_min, int r_max); |
134 | }; |
329 | }; |
|
|
330 | |
|
|
331 | typedef tausworthe_random_generator rand_gen; |
|
|
332 | |
|
|
333 | extern rand_gen rndm; |
135 | |
334 | |
136 | template<class T> |
335 | template<class T> |
137 | struct refptr |
336 | struct refptr |
138 | { |
337 | { |
139 | T *p; |
338 | T *p; |
… | |
… | |
161 | T &operator * () const { return *p; } |
360 | T &operator * () const { return *p; } |
162 | T *operator ->() const { return p; } |
361 | T *operator ->() const { return p; } |
163 | |
362 | |
164 | operator T *() const { return p; } |
363 | operator T *() const { return p; } |
165 | }; |
364 | }; |
|
|
365 | |
|
|
366 | typedef refptr<maptile> maptile_ptr; |
|
|
367 | typedef refptr<object> object_ptr; |
|
|
368 | typedef refptr<archetype> arch_ptr; |
|
|
369 | typedef refptr<client> client_ptr; |
|
|
370 | typedef refptr<player> player_ptr; |
166 | |
371 | |
167 | struct str_hash |
372 | struct str_hash |
168 | { |
373 | { |
169 | std::size_t operator ()(const char *s) const |
374 | std::size_t operator ()(const char *s) const |
170 | { |
375 | { |
… | |
… | |
196 | { |
401 | { |
197 | return !strcmp (a, b); |
402 | return !strcmp (a, b); |
198 | } |
403 | } |
199 | }; |
404 | }; |
200 | |
405 | |
201 | #include <vector> |
|
|
202 | |
|
|
203 | template<class obj> |
406 | template<class T> |
204 | struct unordered_vector : std::vector<obj, slice_allocator<obj> > |
407 | struct unordered_vector : std::vector<T, slice_allocator<T> > |
205 | { |
408 | { |
206 | typedef typename unordered_vector::iterator iterator; |
409 | typedef typename unordered_vector::iterator iterator; |
207 | |
410 | |
208 | void erase (unsigned int pos) |
411 | void erase (unsigned int pos) |
209 | { |
412 | { |
… | |
… | |
217 | { |
420 | { |
218 | erase ((unsigned int )(i - this->begin ())); |
421 | erase ((unsigned int )(i - this->begin ())); |
219 | } |
422 | } |
220 | }; |
423 | }; |
221 | |
424 | |
222 | template<typename T, typename U> static inline T min (T a, U b) { return a < (T)b ? a : (T)b; } |
425 | template<class T, int T::* index> |
223 | template<typename T, typename U> static inline T max (T a, U b) { return a > (T)b ? a : (T)b; } |
426 | struct object_vector : std::vector<T *, slice_allocator<T *> > |
224 | 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; } |
427 | { |
|
|
428 | void insert (T *obj) |
|
|
429 | { |
|
|
430 | assert (!(obj->*index)); |
|
|
431 | push_back (obj); |
|
|
432 | obj->*index = this->size (); |
|
|
433 | } |
225 | |
434 | |
226 | template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; } |
435 | void insert (T &obj) |
|
|
436 | { |
|
|
437 | insert (&obj); |
|
|
438 | } |
|
|
439 | |
|
|
440 | void erase (T *obj) |
|
|
441 | { |
|
|
442 | assert (obj->*index); |
|
|
443 | unsigned int pos = obj->*index; |
|
|
444 | obj->*index = 0; |
|
|
445 | |
|
|
446 | if (pos < this->size ()) |
|
|
447 | { |
|
|
448 | (*this)[pos - 1] = (*this)[this->size () - 1]; |
|
|
449 | (*this)[pos - 1]->*index = pos; |
|
|
450 | } |
|
|
451 | |
|
|
452 | this->pop_back (); |
|
|
453 | } |
|
|
454 | |
|
|
455 | void erase (T &obj) |
|
|
456 | { |
|
|
457 | errase (&obj); |
|
|
458 | } |
|
|
459 | }; |
227 | |
460 | |
228 | // basically does what strncpy should do, but appends "..." to strings exceeding length |
461 | // basically does what strncpy should do, but appends "..." to strings exceeding length |
229 | void assign (char *dst, const char *src, int maxlen); |
462 | void assign (char *dst, const char *src, int maxlen); |
230 | |
463 | |
231 | // type-safe version of assign |
464 | // type-safe version of assign |
… | |
… | |
238 | typedef double tstamp; |
471 | typedef double tstamp; |
239 | |
472 | |
240 | // return current time as timestampe |
473 | // return current time as timestampe |
241 | tstamp now (); |
474 | tstamp now (); |
242 | |
475 | |
|
|
476 | int similar_direction (int a, int b); |
|
|
477 | |
|
|
478 | // like printf, but returns a std::string |
|
|
479 | const std::string format (const char *format, ...); |
|
|
480 | |
243 | #endif |
481 | #endif |
244 | |
482 | |