|
|
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 | |
4 | //#define PREFER_MALLOC |
25 | //#define PREFER_MALLOC |
5 | |
26 | |
6 | #if __GNUC__ >= 3 |
27 | #if __GNUC__ >= 3 |
7 | # 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) |
8 | #else |
31 | #else |
9 | # define is_constant(c) 0 |
32 | # define is_constant(c) 0 |
|
|
33 | # define expect(expr,value) (expr) |
|
|
34 | # define prefetch(addr,rw,locality) |
10 | #endif |
35 | #endif |
|
|
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) |
11 | |
46 | |
12 | #include <cstddef> |
47 | #include <cstddef> |
13 | #include <cmath> |
48 | #include <cmath> |
14 | #include <new> |
49 | #include <new> |
15 | #include <vector> |
50 | #include <vector> |
… | |
… | |
17 | #include <glib.h> |
52 | #include <glib.h> |
18 | |
53 | |
19 | #include <shstr.h> |
54 | #include <shstr.h> |
20 | #include <traits.h> |
55 | #include <traits.h> |
21 | |
56 | |
22 | // 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) |
23 | #define auto(var,expr) typeof(expr) var = (expr) |
58 | #define auto(var,expr) decltype(expr) var = (expr) |
24 | |
59 | |
25 | // very ugly macro that basicaly declares and initialises a variable |
60 | // very ugly macro that basicaly declares and initialises a variable |
26 | // that is in scope for the next statement only |
61 | // that is in scope for the next statement only |
27 | // 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 |
28 | // (note: works great for pointers) |
63 | // (note: works great for pointers) |
29 | // most ugly macro I ever wrote |
64 | // most ugly macro I ever wrote |
30 | #define declvar(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) |
31 | |
66 | |
32 | // in range including end |
67 | // in range including end |
33 | #define IN_RANGE_INC(val,beg,end) \ |
68 | #define IN_RANGE_INC(val,beg,end) \ |
34 | ((unsigned int)(val) - (unsigned int)(beg) <= (unsigned int)(end) - (unsigned int)(beg)) |
69 | ((unsigned int)(val) - (unsigned int)(beg) <= (unsigned int)(end) - (unsigned int)(beg)) |
35 | |
70 | |
… | |
… | |
44 | template<typename T, typename U> static inline T min (T a, U b) { return (U)a < b ? (U)a : b; } |
79 | 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; } |
80 | 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; } |
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; } |
47 | |
82 | |
48 | template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; } |
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 | } |
49 | |
91 | |
50 | // lots of stuff taken from FXT |
92 | // lots of stuff taken from FXT |
51 | |
93 | |
52 | /* Rotate right. This is used in various places for checksumming */ |
94 | /* Rotate right. This is used in various places for checksumming */ |
53 | //TODO: that sucks, use a better checksum algo |
95 | //TODO: that sucks, use a better checksum algo |
… | |
… | |
291 | |
333 | |
292 | typedef tausworthe_random_generator rand_gen; |
334 | typedef tausworthe_random_generator rand_gen; |
293 | |
335 | |
294 | extern rand_gen rndm; |
336 | extern rand_gen rndm; |
295 | |
337 | |
|
|
338 | INTERFACE_CLASS (attachable) |
|
|
339 | struct refcnt_base |
|
|
340 | { |
|
|
341 | typedef int refcnt_t; |
|
|
342 | mutable refcnt_t ACC (RW, refcnt); |
|
|
343 | |
|
|
344 | MTH void refcnt_inc () const { ++refcnt; } |
|
|
345 | MTH void refcnt_dec () const { --refcnt; } |
|
|
346 | |
|
|
347 | refcnt_base () : refcnt (0) { } |
|
|
348 | }; |
|
|
349 | |
|
|
350 | // to avoid branches with more advanced compilers |
|
|
351 | extern refcnt_base::refcnt_t refcnt_dummy; |
|
|
352 | |
296 | template<class T> |
353 | template<class T> |
297 | struct refptr |
354 | struct refptr |
298 | { |
355 | { |
|
|
356 | // p if not null |
|
|
357 | refcnt_base::refcnt_t *refcnt_ref () { return p ? &p->refcnt : &refcnt_dummy; } |
|
|
358 | |
|
|
359 | void refcnt_dec () |
|
|
360 | { |
|
|
361 | if (!is_constant (p)) |
|
|
362 | --*refcnt_ref (); |
|
|
363 | else if (p) |
|
|
364 | --p->refcnt; |
|
|
365 | } |
|
|
366 | |
|
|
367 | void refcnt_inc () |
|
|
368 | { |
|
|
369 | if (!is_constant (p)) |
|
|
370 | ++*refcnt_ref (); |
|
|
371 | else if (p) |
|
|
372 | ++p->refcnt; |
|
|
373 | } |
|
|
374 | |
299 | T *p; |
375 | T *p; |
300 | |
376 | |
301 | refptr () : p(0) { } |
377 | refptr () : p(0) { } |
302 | refptr (const refptr<T> &p) : p(p.p) { if (p) p->refcnt_inc (); } |
378 | refptr (const refptr<T> &p) : p(p.p) { refcnt_inc (); } |
303 | refptr (T *p) : p(p) { if (p) p->refcnt_inc (); } |
379 | refptr (T *p) : p(p) { refcnt_inc (); } |
304 | ~refptr () { if (p) p->refcnt_dec (); } |
380 | ~refptr () { refcnt_dec (); } |
305 | |
381 | |
306 | const refptr<T> &operator =(T *o) |
382 | const refptr<T> &operator =(T *o) |
307 | { |
383 | { |
|
|
384 | // if decrementing ever destroys we need to reverse the order here |
308 | if (p) p->refcnt_dec (); |
385 | refcnt_dec (); |
309 | p = o; |
386 | p = o; |
310 | if (p) p->refcnt_inc (); |
387 | refcnt_inc (); |
311 | |
|
|
312 | return *this; |
388 | return *this; |
313 | } |
389 | } |
314 | |
390 | |
315 | const refptr<T> &operator =(const refptr<T> o) |
391 | const refptr<T> &operator =(const refptr<T> &o) |
316 | { |
392 | { |
317 | *this = o.p; |
393 | *this = o.p; |
318 | return *this; |
394 | return *this; |
319 | } |
395 | } |
320 | |
396 | |
321 | T &operator * () const { return *p; } |
397 | T &operator * () const { return *p; } |
322 | T *operator ->() const { return p; } |
398 | T *operator ->() const { return p; } |
323 | |
399 | |
324 | operator T *() const { return p; } |
400 | operator T *() const { return p; } |
325 | }; |
401 | }; |
326 | |
402 | |
327 | typedef refptr<maptile> maptile_ptr; |
403 | typedef refptr<maptile> maptile_ptr; |
… | |
… | |
362 | { |
438 | { |
363 | return !strcmp (a, b); |
439 | return !strcmp (a, b); |
364 | } |
440 | } |
365 | }; |
441 | }; |
366 | |
442 | |
|
|
443 | // Mostly the same as std::vector, but insert/erase can reorder |
|
|
444 | // the elements, making append(=insert)/remove O(1) instead of O(n). |
|
|
445 | // |
|
|
446 | // NOTE: only some forms of erase are available |
367 | template<class T> |
447 | template<class T> |
368 | struct unordered_vector : std::vector<T, slice_allocator<T> > |
448 | struct unordered_vector : std::vector<T, slice_allocator<T> > |
369 | { |
449 | { |
370 | typedef typename unordered_vector::iterator iterator; |
450 | typedef typename unordered_vector::iterator iterator; |
371 | |
451 | |
… | |
… | |
381 | { |
461 | { |
382 | erase ((unsigned int )(i - this->begin ())); |
462 | erase ((unsigned int )(i - this->begin ())); |
383 | } |
463 | } |
384 | }; |
464 | }; |
385 | |
465 | |
386 | template<class T, int T::* index> |
466 | // This container blends advantages of linked lists |
|
|
467 | // (efficiency) with vectors (random access) by |
|
|
468 | // by using an unordered vector and storing the vector |
|
|
469 | // index inside the object. |
|
|
470 | // |
|
|
471 | // + memory-efficient on most 64 bit archs |
|
|
472 | // + O(1) insert/remove |
|
|
473 | // + free unique (but varying) id for inserted objects |
|
|
474 | // + cache-friendly iteration |
|
|
475 | // - only works for pointers to structs |
|
|
476 | // |
|
|
477 | // NOTE: only some forms of erase/insert are available |
|
|
478 | typedef int object_vector_index; |
|
|
479 | |
|
|
480 | template<class T, object_vector_index T::*indexmember> |
387 | struct object_vector : std::vector<T *, slice_allocator<T *> > |
481 | struct object_vector : std::vector<T *, slice_allocator<T *> > |
388 | { |
482 | { |
|
|
483 | typedef typename object_vector::iterator iterator; |
|
|
484 | |
|
|
485 | bool contains (const T *obj) const |
|
|
486 | { |
|
|
487 | return obj->*indexmember; |
|
|
488 | } |
|
|
489 | |
|
|
490 | iterator find (const T *obj) |
|
|
491 | { |
|
|
492 | return obj->*indexmember |
|
|
493 | ? this->begin () + obj->*indexmember - 1 |
|
|
494 | : this->end (); |
|
|
495 | } |
|
|
496 | |
|
|
497 | void push_back (T *obj) |
|
|
498 | { |
|
|
499 | std::vector<T *, slice_allocator<T *> >::push_back (obj); |
|
|
500 | obj->*indexmember = this->size (); |
|
|
501 | } |
|
|
502 | |
389 | void insert (T *obj) |
503 | void insert (T *obj) |
390 | { |
504 | { |
391 | assert (!(obj->*index)); |
|
|
392 | push_back (obj); |
505 | push_back (obj); |
393 | obj->*index = this->size (); |
|
|
394 | } |
506 | } |
395 | |
507 | |
396 | void insert (T &obj) |
508 | void insert (T &obj) |
397 | { |
509 | { |
398 | insert (&obj); |
510 | insert (&obj); |
399 | } |
511 | } |
400 | |
512 | |
401 | void erase (T *obj) |
513 | void erase (T *obj) |
402 | { |
514 | { |
403 | assert (obj->*index); |
|
|
404 | unsigned int pos = obj->*index; |
515 | unsigned int pos = obj->*indexmember; |
405 | obj->*index = 0; |
516 | obj->*indexmember = 0; |
406 | |
517 | |
407 | if (pos < this->size ()) |
518 | if (pos < this->size ()) |
408 | { |
519 | { |
409 | (*this)[pos - 1] = (*this)[this->size () - 1]; |
520 | (*this)[pos - 1] = (*this)[this->size () - 1]; |
410 | (*this)[pos - 1]->*index = pos; |
521 | (*this)[pos - 1]->*indexmember = pos; |
411 | } |
522 | } |
412 | |
523 | |
413 | this->pop_back (); |
524 | this->pop_back (); |
414 | } |
525 | } |
415 | |
526 | |
416 | void erase (T &obj) |
527 | void erase (T &obj) |
417 | { |
528 | { |
418 | errase (&obj); |
529 | erase (&obj); |
419 | } |
530 | } |
420 | }; |
531 | }; |
421 | |
532 | |
422 | // basically does what strncpy should do, but appends "..." to strings exceeding length |
533 | // basically does what strncpy should do, but appends "..." to strings exceeding length |
423 | void assign (char *dst, const char *src, int maxlen); |
534 | void assign (char *dst, const char *src, int maxlen); |
… | |
… | |
434 | // return current time as timestampe |
545 | // return current time as timestampe |
435 | tstamp now (); |
546 | tstamp now (); |
436 | |
547 | |
437 | int similar_direction (int a, int b); |
548 | int similar_direction (int a, int b); |
438 | |
549 | |
|
|
550 | // like sprintf, but returns a "static" buffer |
|
|
551 | const char *format (const char *format, ...); |
|
|
552 | |
439 | #endif |
553 | #endif |
440 | |
554 | |