|
|
1 | /* |
|
|
2 | * This file is part of Deliantra, the Roguelike Realtime MMORPG. |
|
|
3 | * |
|
|
4 | * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Deliantra team |
|
|
5 | * |
|
|
6 | * Deliantra 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 <support@deliantra.net> |
|
|
20 | */ |
|
|
21 | |
1 | #ifndef UTIL_H__ |
22 | #ifndef UTIL_H__ |
2 | #define UTIL_H__ |
23 | #define UTIL_H__ |
3 | |
24 | |
|
|
25 | #define DEBUG_SALLOC 0 |
4 | //#define PREFER_MALLOC |
26 | #define PREFER_MALLOC 0 |
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 | |
|
|
58 | #if DEBUG_SALLOC |
|
|
59 | # define g_slice_alloc0(s) debug_slice_alloc0(s) |
|
|
60 | # define g_slice_alloc(s) debug_slice_alloc(s) |
|
|
61 | # define g_slice_free1(s,p) debug_slice_free1(s,p) |
|
|
62 | void *g_slice_alloc (unsigned long size); |
|
|
63 | void *g_slice_alloc0 (unsigned long size); |
|
|
64 | void g_slice_free1 (unsigned long size, void *ptr); |
|
|
65 | #endif |
|
|
66 | |
22 | // use a gcc extension for auto declarations until ISO C++ sanctifies them |
67 | // use C0X decltype for auto declarations until ISO C++ sanctifies them (if ever) |
23 | #define AUTODECL(var,expr) typeof(expr) var = (expr) |
68 | #define auto(var,expr) decltype(expr) var = (expr) |
24 | |
69 | |
25 | // very ugly macro that basicaly declares and initialises a variable |
70 | // very ugly macro that basicaly declares and initialises a variable |
26 | // that is in scope for the next statement only |
71 | // that is in scope for the next statement only |
27 | // works only for stuff that can be assigned 0 and converts to false |
72 | // works only for stuff that can be assigned 0 and converts to false |
28 | // (note: works great for pointers) |
73 | // (note: works great for pointers) |
29 | // most ugly macro I ever wrote |
74 | // most ugly macro I ever wrote |
30 | #define declvar(type, name, value) if (type name = 0) { } else if (((name) = (value)), 1) |
75 | #define statementvar(type, name, value) if (type name = 0) { } else if (((name) = (value)), 1) |
31 | |
76 | |
32 | // in range including end |
77 | // in range including end |
33 | #define IN_RANGE_INC(val,beg,end) \ |
78 | #define IN_RANGE_INC(val,beg,end) \ |
34 | ((unsigned int)(val) - (unsigned int)(beg) <= (unsigned int)(end) - (unsigned int)(beg)) |
79 | ((unsigned int)(val) - (unsigned int)(beg) <= (unsigned int)(end) - (unsigned int)(beg)) |
35 | |
80 | |
… | |
… | |
45 | template<typename T, typename U> static inline T max (T a, U b) { return (U)a > b ? (U)a : b; } |
90 | 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; } |
91 | 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 | |
92 | |
48 | template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; } |
93 | template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; } |
49 | |
94 | |
|
|
95 | template<typename T, typename U, typename V> static inline T min (T a, U b, V c) { return min (a, min (b, c)); } |
|
|
96 | template<typename T, typename U, typename V> static inline T max (T a, U b, V c) { return max (a, max (b, c)); } |
|
|
97 | |
|
|
98 | template<typename T> |
|
|
99 | static inline T |
|
|
100 | lerp (T val, T min_in, T max_in, T min_out, T max_out) |
|
|
101 | { |
|
|
102 | return (val - min_in) * (max_out - min_out) / (max_in - min_in) + min_out; |
|
|
103 | } |
|
|
104 | |
50 | // lots of stuff taken from FXT |
105 | // lots of stuff taken from FXT |
51 | |
106 | |
52 | /* Rotate right. This is used in various places for checksumming */ |
107 | /* Rotate right. This is used in various places for checksumming */ |
53 | //TODO: this sucks, use a better checksum algo |
108 | //TODO: that sucks, use a better checksum algo |
54 | static inline uint32_t |
109 | static inline uint32_t |
55 | rotate_right (uint32_t c) |
110 | rotate_right (uint32_t c, uint32_t count = 1) |
56 | { |
111 | { |
57 | return (c << 31) | (c >> 1); |
112 | return (c << (32 - count)) | (c >> count); |
|
|
113 | } |
|
|
114 | |
|
|
115 | static inline uint32_t |
|
|
116 | rotate_left (uint32_t c, uint32_t count = 1) |
|
|
117 | { |
|
|
118 | return (c >> (32 - count)) | (c << count); |
58 | } |
119 | } |
59 | |
120 | |
60 | // Return abs(a-b) |
121 | // Return abs(a-b) |
61 | // Both a and b must not have the most significant bit set |
122 | // Both a and b must not have the most significant bit set |
62 | static inline uint32_t |
123 | static inline uint32_t |
… | |
… | |
124 | absdir (int d) |
185 | absdir (int d) |
125 | { |
186 | { |
126 | return ((d - 1) & 7) + 1; |
187 | return ((d - 1) & 7) + 1; |
127 | } |
188 | } |
128 | |
189 | |
|
|
190 | extern size_t slice_alloc; // statistics |
|
|
191 | |
129 | // makes dynamically allocated objects zero-initialised |
192 | // makes dynamically allocated objects zero-initialised |
130 | struct zero_initialised |
193 | struct zero_initialised |
131 | { |
194 | { |
132 | void *operator new (size_t s, void *p) |
195 | void *operator new (size_t s, void *p) |
133 | { |
196 | { |
… | |
… | |
135 | return p; |
198 | return p; |
136 | } |
199 | } |
137 | |
200 | |
138 | void *operator new (size_t s) |
201 | void *operator new (size_t s) |
139 | { |
202 | { |
|
|
203 | slice_alloc += s; |
140 | return g_slice_alloc0 (s); |
204 | return g_slice_alloc0 (s); |
141 | } |
205 | } |
142 | |
206 | |
143 | void *operator new[] (size_t s) |
207 | void *operator new[] (size_t s) |
144 | { |
208 | { |
|
|
209 | slice_alloc += s; |
145 | return g_slice_alloc0 (s); |
210 | return g_slice_alloc0 (s); |
146 | } |
211 | } |
147 | |
212 | |
148 | void operator delete (void *p, size_t s) |
213 | void operator delete (void *p, size_t s) |
149 | { |
214 | { |
|
|
215 | slice_alloc -= s; |
150 | g_slice_free1 (s, p); |
216 | g_slice_free1 (s, p); |
151 | } |
217 | } |
152 | |
218 | |
153 | void operator delete[] (void *p, size_t s) |
219 | void operator delete[] (void *p, size_t s) |
154 | { |
220 | { |
|
|
221 | slice_alloc -= s; |
155 | g_slice_free1 (s, p); |
222 | g_slice_free1 (s, p); |
156 | } |
223 | } |
157 | }; |
224 | }; |
158 | |
225 | |
159 | void *salloc_ (int n) throw (std::bad_alloc); |
226 | void *salloc_ (int n) throw (std::bad_alloc); |
… | |
… | |
174 | |
241 | |
175 | // for symmetry |
242 | // for symmetry |
176 | template<typename T> |
243 | template<typename T> |
177 | inline void sfree (T *ptr, int n = 1) throw () |
244 | inline void sfree (T *ptr, int n = 1) throw () |
178 | { |
245 | { |
179 | #ifdef PREFER_MALLOC |
246 | #if PREFER_MALLOC |
180 | free (ptr); |
247 | free (ptr); |
181 | #else |
248 | #else |
|
|
249 | slice_alloc -= n * sizeof (T); |
182 | g_slice_free1 (n * sizeof (T), (void *)ptr); |
250 | g_slice_free1 (n * sizeof (T), (void *)ptr); |
183 | #endif |
251 | #endif |
184 | } |
252 | } |
185 | |
253 | |
186 | // a STL-compatible allocator that uses g_slice |
254 | // a STL-compatible allocator that uses g_slice |
… | |
… | |
201 | { |
269 | { |
202 | typedef slice_allocator<U> other; |
270 | typedef slice_allocator<U> other; |
203 | }; |
271 | }; |
204 | |
272 | |
205 | slice_allocator () throw () { } |
273 | slice_allocator () throw () { } |
206 | slice_allocator (const slice_allocator &o) throw () { } |
274 | slice_allocator (const slice_allocator &) throw () { } |
207 | template<typename Tp2> |
275 | template<typename Tp2> |
208 | slice_allocator (const slice_allocator<Tp2> &) throw () { } |
276 | slice_allocator (const slice_allocator<Tp2> &) throw () { } |
209 | |
277 | |
210 | ~slice_allocator () { } |
278 | ~slice_allocator () { } |
211 | |
279 | |
… | |
… | |
220 | void deallocate (pointer p, size_type n) |
288 | void deallocate (pointer p, size_type n) |
221 | { |
289 | { |
222 | sfree<Tp> (p, n); |
290 | sfree<Tp> (p, n); |
223 | } |
291 | } |
224 | |
292 | |
225 | size_type max_size ()const throw () |
293 | size_type max_size () const throw () |
226 | { |
294 | { |
227 | return size_t (-1) / sizeof (Tp); |
295 | return size_t (-1) / sizeof (Tp); |
228 | } |
296 | } |
229 | |
297 | |
230 | void construct (pointer p, const Tp &val) |
298 | void construct (pointer p, const Tp &val) |
… | |
… | |
256 | |
324 | |
257 | void seed (uint32_t seed); |
325 | void seed (uint32_t seed); |
258 | uint32_t next (); |
326 | uint32_t next (); |
259 | |
327 | |
260 | // uniform distribution |
328 | // uniform distribution |
261 | uint32_t operator ()(uint32_t r_max) |
329 | uint32_t operator ()(uint32_t num) |
262 | { |
330 | { |
263 | return is_constant (r_max) |
331 | return is_constant (num) |
264 | ? this->next () % r_max |
332 | ? (next () * (uint64_t)num) >> 32U |
265 | : get_range (r_max); |
333 | : get_range (num); |
266 | } |
334 | } |
267 | |
335 | |
268 | // return a number within (min .. max) |
336 | // return a number within (min .. max) |
269 | int operator () (int r_min, int r_max) |
337 | int operator () (int r_min, int r_max) |
270 | { |
338 | { |
271 | return is_constant (r_min) && is_constant (r_max) |
339 | return is_constant (r_min) && is_constant (r_max) && r_min <= r_max |
272 | ? r_min + (*this) (max (r_max - r_min + 1, 1)) |
340 | ? r_min + operator ()(r_max - r_min + 1) |
273 | : get_range (r_min, r_max); |
341 | : get_range (r_min, r_max); |
274 | } |
342 | } |
275 | |
343 | |
276 | double operator ()() |
344 | double operator ()() |
277 | { |
345 | { |
… | |
… | |
285 | |
353 | |
286 | typedef tausworthe_random_generator rand_gen; |
354 | typedef tausworthe_random_generator rand_gen; |
287 | |
355 | |
288 | extern rand_gen rndm; |
356 | extern rand_gen rndm; |
289 | |
357 | |
|
|
358 | INTERFACE_CLASS (attachable) |
|
|
359 | struct refcnt_base |
|
|
360 | { |
|
|
361 | typedef int refcnt_t; |
|
|
362 | mutable refcnt_t ACC (RW, refcnt); |
|
|
363 | |
|
|
364 | MTH void refcnt_inc () const { ++refcnt; } |
|
|
365 | MTH void refcnt_dec () const { --refcnt; } |
|
|
366 | |
|
|
367 | refcnt_base () : refcnt (0) { } |
|
|
368 | }; |
|
|
369 | |
|
|
370 | // to avoid branches with more advanced compilers |
|
|
371 | extern refcnt_base::refcnt_t refcnt_dummy; |
|
|
372 | |
290 | template<class T> |
373 | template<class T> |
291 | struct refptr |
374 | struct refptr |
292 | { |
375 | { |
|
|
376 | // p if not null |
|
|
377 | refcnt_base::refcnt_t *refcnt_ref () { return p ? &p->refcnt : &refcnt_dummy; } |
|
|
378 | |
|
|
379 | void refcnt_dec () |
|
|
380 | { |
|
|
381 | if (!is_constant (p)) |
|
|
382 | --*refcnt_ref (); |
|
|
383 | else if (p) |
|
|
384 | --p->refcnt; |
|
|
385 | } |
|
|
386 | |
|
|
387 | void refcnt_inc () |
|
|
388 | { |
|
|
389 | if (!is_constant (p)) |
|
|
390 | ++*refcnt_ref (); |
|
|
391 | else if (p) |
|
|
392 | ++p->refcnt; |
|
|
393 | } |
|
|
394 | |
293 | T *p; |
395 | T *p; |
294 | |
396 | |
295 | refptr () : p(0) { } |
397 | refptr () : p(0) { } |
296 | refptr (const refptr<T> &p) : p(p.p) { if (p) p->refcnt_inc (); } |
398 | refptr (const refptr<T> &p) : p(p.p) { refcnt_inc (); } |
297 | refptr (T *p) : p(p) { if (p) p->refcnt_inc (); } |
399 | refptr (T *p) : p(p) { refcnt_inc (); } |
298 | ~refptr () { if (p) p->refcnt_dec (); } |
400 | ~refptr () { refcnt_dec (); } |
299 | |
401 | |
300 | const refptr<T> &operator =(T *o) |
402 | const refptr<T> &operator =(T *o) |
301 | { |
403 | { |
|
|
404 | // if decrementing ever destroys we need to reverse the order here |
302 | if (p) p->refcnt_dec (); |
405 | refcnt_dec (); |
303 | p = o; |
406 | p = o; |
304 | if (p) p->refcnt_inc (); |
407 | refcnt_inc (); |
305 | |
|
|
306 | return *this; |
408 | return *this; |
307 | } |
409 | } |
308 | |
410 | |
309 | const refptr<T> &operator =(const refptr<T> o) |
411 | const refptr<T> &operator =(const refptr<T> &o) |
310 | { |
412 | { |
311 | *this = o.p; |
413 | *this = o.p; |
312 | return *this; |
414 | return *this; |
313 | } |
415 | } |
314 | |
416 | |
315 | T &operator * () const { return *p; } |
417 | T &operator * () const { return *p; } |
316 | T *operator ->() const { return p; } |
418 | T *operator ->() const { return p; } |
317 | |
419 | |
318 | operator T *() const { return p; } |
420 | operator T *() const { return p; } |
319 | }; |
421 | }; |
320 | |
422 | |
321 | typedef refptr<maptile> maptile_ptr; |
423 | typedef refptr<maptile> maptile_ptr; |
… | |
… | |
356 | { |
458 | { |
357 | return !strcmp (a, b); |
459 | return !strcmp (a, b); |
358 | } |
460 | } |
359 | }; |
461 | }; |
360 | |
462 | |
|
|
463 | // Mostly the same as std::vector, but insert/erase can reorder |
|
|
464 | // the elements, making append(=insert)/remove O(1) instead of O(n). |
|
|
465 | // |
|
|
466 | // NOTE: only some forms of erase are available |
361 | template<class T> |
467 | template<class T> |
362 | struct unordered_vector : std::vector<T, slice_allocator<T> > |
468 | struct unordered_vector : std::vector<T, slice_allocator<T> > |
363 | { |
469 | { |
364 | typedef typename unordered_vector::iterator iterator; |
470 | typedef typename unordered_vector::iterator iterator; |
365 | |
471 | |
… | |
… | |
375 | { |
481 | { |
376 | erase ((unsigned int )(i - this->begin ())); |
482 | erase ((unsigned int )(i - this->begin ())); |
377 | } |
483 | } |
378 | }; |
484 | }; |
379 | |
485 | |
380 | template<class T, int T::* index> |
486 | // This container blends advantages of linked lists |
|
|
487 | // (efficiency) with vectors (random access) by |
|
|
488 | // by using an unordered vector and storing the vector |
|
|
489 | // index inside the object. |
|
|
490 | // |
|
|
491 | // + memory-efficient on most 64 bit archs |
|
|
492 | // + O(1) insert/remove |
|
|
493 | // + free unique (but varying) id for inserted objects |
|
|
494 | // + cache-friendly iteration |
|
|
495 | // - only works for pointers to structs |
|
|
496 | // |
|
|
497 | // NOTE: only some forms of erase/insert are available |
|
|
498 | typedef int object_vector_index; |
|
|
499 | |
|
|
500 | template<class T, object_vector_index T::*indexmember> |
381 | struct object_vector : std::vector<T *, slice_allocator<T *> > |
501 | struct object_vector : std::vector<T *, slice_allocator<T *> > |
382 | { |
502 | { |
|
|
503 | typedef typename object_vector::iterator iterator; |
|
|
504 | |
|
|
505 | bool contains (const T *obj) const |
|
|
506 | { |
|
|
507 | return obj->*indexmember; |
|
|
508 | } |
|
|
509 | |
|
|
510 | iterator find (const T *obj) |
|
|
511 | { |
|
|
512 | return obj->*indexmember |
|
|
513 | ? this->begin () + obj->*indexmember - 1 |
|
|
514 | : this->end (); |
|
|
515 | } |
|
|
516 | |
|
|
517 | void push_back (T *obj) |
|
|
518 | { |
|
|
519 | std::vector<T *, slice_allocator<T *> >::push_back (obj); |
|
|
520 | obj->*indexmember = this->size (); |
|
|
521 | } |
|
|
522 | |
383 | void insert (T *obj) |
523 | void insert (T *obj) |
384 | { |
524 | { |
385 | assert (!(obj->*index)); |
|
|
386 | push_back (obj); |
525 | push_back (obj); |
387 | obj->*index = this->size (); |
|
|
388 | } |
526 | } |
389 | |
527 | |
390 | void insert (T &obj) |
528 | void insert (T &obj) |
391 | { |
529 | { |
392 | insert (&obj); |
530 | insert (&obj); |
393 | } |
531 | } |
394 | |
532 | |
395 | void erase (T *obj) |
533 | void erase (T *obj) |
396 | { |
534 | { |
397 | assert (obj->*index); |
|
|
398 | int pos = obj->*index; |
535 | unsigned int pos = obj->*indexmember; |
399 | obj->*index = 0; |
536 | obj->*indexmember = 0; |
400 | |
537 | |
401 | if (pos < this->size ()) |
538 | if (pos < this->size ()) |
402 | { |
539 | { |
403 | (*this)[pos - 1] = (*this)[this->size () - 1]; |
540 | (*this)[pos - 1] = (*this)[this->size () - 1]; |
404 | (*this)[pos - 1]->*index = pos; |
541 | (*this)[pos - 1]->*indexmember = pos; |
405 | } |
542 | } |
406 | |
543 | |
407 | this->pop_back (); |
544 | this->pop_back (); |
408 | } |
545 | } |
409 | |
546 | |
410 | void erase (T &obj) |
547 | void erase (T &obj) |
411 | { |
548 | { |
412 | errase (&obj); |
549 | erase (&obj); |
413 | } |
550 | } |
414 | }; |
551 | }; |
415 | |
552 | |
416 | // basically does what strncpy should do, but appends "..." to strings exceeding length |
553 | // basically does what strncpy should do, but appends "..." to strings exceeding length |
417 | void assign (char *dst, const char *src, int maxlen); |
554 | void assign (char *dst, const char *src, int maxlen); |
… | |
… | |
423 | assign ((char *)&dst, src, N); |
560 | assign ((char *)&dst, src, N); |
424 | } |
561 | } |
425 | |
562 | |
426 | typedef double tstamp; |
563 | typedef double tstamp; |
427 | |
564 | |
428 | // return current time as timestampe |
565 | // return current time as timestamp |
429 | tstamp now (); |
566 | tstamp now (); |
430 | |
567 | |
431 | int similar_direction (int a, int b); |
568 | int similar_direction (int a, int b); |
432 | |
569 | |
433 | #endif |
570 | // like sprintf, but returns a "static" buffer |
|
|
571 | const char *format (const char *format, ...); |
434 | |
572 | |
|
|
573 | #endif |
|
|
574 | |