ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/include/util.h
(Generate patch)

Comparing deliantra/server/include/util.h (file contents):
Revision 1.45 by root, Sat May 26 15:44:05 2007 UTC vs.
Revision 1.63 by root, Sat Mar 15 13:52:38 2008 UTC

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
4//#define PREFER_MALLOC 25//#define PREFER_MALLOC
26#define DEBUG_SALLOC
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)
8# define expect(expr,value) __builtin_expect ((expr),(value)) 30# define expect(expr,value) __builtin_expect ((expr),(value))
9# define prefetch(addr,rw,locality) __builtin_prefetch (addr, rw, locality) 31# define prefetch(addr,rw,locality) __builtin_prefetch (addr, rw, locality)
11# define is_constant(c) 0 33# define is_constant(c) 0
12# define expect(expr,value) (expr) 34# define expect(expr,value) (expr)
13# define prefetch(addr,rw,locality) 35# define prefetch(addr,rw,locality)
14#endif 36#endif
15 37
38#if __GNUC__ < 4 || (__GNUC__ == 4 || __GNUC_MINOR__ < 4)
39# define decltype(x) typeof(x)
40#endif
41
16// put into ifs if you are very sure that the expression 42// put into ifs if you are very sure that the expression
17// is mostly true or mosty false. note that these return 43// is mostly true or mosty false. note that these return
18// booleans, not the expression. 44// booleans, not the expression.
19#define expect_false(expr) expect ((expr) != 0, 0) 45#define expect_false(expr) expect ((expr) != 0, 0)
20#define expect_true(expr) expect ((expr) != 0, 1) 46#define expect_true(expr) expect ((expr) != 0, 1)
27#include <glib.h> 53#include <glib.h>
28 54
29#include <shstr.h> 55#include <shstr.h>
30#include <traits.h> 56#include <traits.h>
31 57
58#ifdef 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)
62void *g_slice_alloc (unsigned long size);
63void *g_slice_alloc0 (unsigned long size);
64void g_slice_free1 (unsigned long size, void *ptr);
65#endif
66
32// 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)
33#define auto(var,expr) typeof(expr) var = (expr) 68#define auto(var,expr) decltype(expr) var = (expr)
34 69
35// very ugly macro that basicaly declares and initialises a variable 70// very ugly macro that basicaly declares and initialises a variable
36// that is in scope for the next statement only 71// that is in scope for the next statement only
37// 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
38// (note: works great for pointers) 73// (note: works great for pointers)
39// most ugly macro I ever wrote 74// most ugly macro I ever wrote
40#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)
41 76
42// in range including end 77// in range including end
43#define IN_RANGE_INC(val,beg,end) \ 78#define IN_RANGE_INC(val,beg,end) \
44 ((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))
45 80
54template<typename T, typename U> static inline T min (T a, U b) { return (U)a < b ? (U)a : b; } 89template<typename T, typename U> static inline T min (T a, U b) { return (U)a < b ? (U)a : b; }
55template<typename T, typename U> static inline T max (T a, U b) { return (U)a > b ? (U)a : b; } 90template<typename T, typename U> static inline T max (T a, U b) { return (U)a > b ? (U)a : b; }
56template<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; } 91template<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; }
57 92
58template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; } 93template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; }
94
95template<typename T, typename U, typename V> static inline T min (T a, U b, V c) { return min (a, min (b, c)); }
96template<typename T, typename U, typename V> static inline T max (T a, U b, V c) { return max (a, max (b, c)); }
59 97
60template<typename T> 98template<typename T>
61static inline T 99static inline T
62lerp (T val, T min_in, T max_in, T min_out, T max_out) 100lerp (T val, T min_in, T max_in, T min_out, T max_out)
63{ 101{
147absdir (int d) 185absdir (int d)
148{ 186{
149 return ((d - 1) & 7) + 1; 187 return ((d - 1) & 7) + 1;
150} 188}
151 189
190extern size_t slice_alloc; // statistics
191
152// makes dynamically allocated objects zero-initialised 192// makes dynamically allocated objects zero-initialised
153struct zero_initialised 193struct zero_initialised
154{ 194{
155 void *operator new (size_t s, void *p) 195 void *operator new (size_t s, void *p)
156 { 196 {
158 return p; 198 return p;
159 } 199 }
160 200
161 void *operator new (size_t s) 201 void *operator new (size_t s)
162 { 202 {
203 slice_alloc += s;
163 return g_slice_alloc0 (s); 204 return g_slice_alloc0 (s);
164 } 205 }
165 206
166 void *operator new[] (size_t s) 207 void *operator new[] (size_t s)
167 { 208 {
209 slice_alloc += s;
168 return g_slice_alloc0 (s); 210 return g_slice_alloc0 (s);
169 } 211 }
170 212
171 void operator delete (void *p, size_t s) 213 void operator delete (void *p, size_t s)
172 { 214 {
215 slice_alloc -= s;
173 g_slice_free1 (s, p); 216 g_slice_free1 (s, p);
174 } 217 }
175 218
176 void operator delete[] (void *p, size_t s) 219 void operator delete[] (void *p, size_t s)
177 { 220 {
221 slice_alloc -= s;
178 g_slice_free1 (s, p); 222 g_slice_free1 (s, p);
179 } 223 }
180}; 224};
181 225
182void *salloc_ (int n) throw (std::bad_alloc); 226void *salloc_ (int n) throw (std::bad_alloc);
200inline void sfree (T *ptr, int n = 1) throw () 244inline void sfree (T *ptr, int n = 1) throw ()
201{ 245{
202#ifdef PREFER_MALLOC 246#ifdef PREFER_MALLOC
203 free (ptr); 247 free (ptr);
204#else 248#else
249 slice_alloc -= n * sizeof (T);
205 g_slice_free1 (n * sizeof (T), (void *)ptr); 250 g_slice_free1 (n * sizeof (T), (void *)ptr);
206#endif 251#endif
207} 252}
208 253
209// a STL-compatible allocator that uses g_slice 254// a STL-compatible allocator that uses g_slice
308 353
309typedef tausworthe_random_generator rand_gen; 354typedef tausworthe_random_generator rand_gen;
310 355
311extern rand_gen rndm; 356extern rand_gen rndm;
312 357
358INTERFACE_CLASS (attachable)
359struct 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
371extern refcnt_base::refcnt_t refcnt_dummy;
372
313template<class T> 373template<class T>
314struct refptr 374struct refptr
315{ 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
316 T *p; 395 T *p;
317 396
318 refptr () : p(0) { } 397 refptr () : p(0) { }
319 refptr (const refptr<T> &p) : p(p.p) { if (p) p->refcnt_inc (); } 398 refptr (const refptr<T> &p) : p(p.p) { refcnt_inc (); }
320 refptr (T *p) : p(p) { if (p) p->refcnt_inc (); } 399 refptr (T *p) : p(p) { refcnt_inc (); }
321 ~refptr () { if (p) p->refcnt_dec (); } 400 ~refptr () { refcnt_dec (); }
322 401
323 const refptr<T> &operator =(T *o) 402 const refptr<T> &operator =(T *o)
324 { 403 {
404 // if decrementing ever destroys we need to reverse the order here
325 if (p) p->refcnt_dec (); 405 refcnt_dec ();
326 p = o; 406 p = o;
327 if (p) p->refcnt_inc (); 407 refcnt_inc ();
328
329 return *this; 408 return *this;
330 } 409 }
331 410
332 const refptr<T> &operator =(const refptr<T> o) 411 const refptr<T> &operator =(const refptr<T> &o)
333 { 412 {
334 *this = o.p; 413 *this = o.p;
335 return *this; 414 return *this;
336 } 415 }
337 416
338 T &operator * () const { return *p; } 417 T &operator * () const { return *p; }
339 T *operator ->() const { return p; } 418 T *operator ->() const { return p; }
340 419
341 operator T *() const { return p; } 420 operator T *() const { return p; }
342}; 421};
343 422
344typedef refptr<maptile> maptile_ptr; 423typedef refptr<maptile> maptile_ptr;
379 { 458 {
380 return !strcmp (a, b); 459 return !strcmp (a, b);
381 } 460 }
382}; 461};
383 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
384template<class T> 467template<class T>
385struct unordered_vector : std::vector<T, slice_allocator<T> > 468struct unordered_vector : std::vector<T, slice_allocator<T> >
386{ 469{
387 typedef typename unordered_vector::iterator iterator; 470 typedef typename unordered_vector::iterator iterator;
388 471
398 { 481 {
399 erase ((unsigned int )(i - this->begin ())); 482 erase ((unsigned int )(i - this->begin ()));
400 } 483 }
401}; 484};
402 485
403template<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
498typedef int object_vector_index;
499
500template<class T, object_vector_index T::*indexmember>
404struct object_vector : std::vector<T *, slice_allocator<T *> > 501struct object_vector : std::vector<T *, slice_allocator<T *> >
405{ 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
406 void insert (T *obj) 523 void insert (T *obj)
407 { 524 {
408 assert (!(obj->*index));
409 push_back (obj); 525 push_back (obj);
410 obj->*index = this->size ();
411 } 526 }
412 527
413 void insert (T &obj) 528 void insert (T &obj)
414 { 529 {
415 insert (&obj); 530 insert (&obj);
416 } 531 }
417 532
418 void erase (T *obj) 533 void erase (T *obj)
419 { 534 {
420 assert (obj->*index);
421 unsigned int pos = obj->*index; 535 unsigned int pos = obj->*indexmember;
422 obj->*index = 0; 536 obj->*indexmember = 0;
423 537
424 if (pos < this->size ()) 538 if (pos < this->size ())
425 { 539 {
426 (*this)[pos - 1] = (*this)[this->size () - 1]; 540 (*this)[pos - 1] = (*this)[this->size () - 1];
427 (*this)[pos - 1]->*index = pos; 541 (*this)[pos - 1]->*indexmember = pos;
428 } 542 }
429 543
430 this->pop_back (); 544 this->pop_back ();
431 } 545 }
432 546
433 void erase (T &obj) 547 void erase (T &obj)
434 { 548 {
435 errase (&obj); 549 erase (&obj);
436 } 550 }
437}; 551};
438 552
439// 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
440void assign (char *dst, const char *src, int maxlen); 554void assign (char *dst, const char *src, int maxlen);
446 assign ((char *)&dst, src, N); 560 assign ((char *)&dst, src, N);
447} 561}
448 562
449typedef double tstamp; 563typedef double tstamp;
450 564
451// return current time as timestampe 565// return current time as timestamp
452tstamp now (); 566tstamp now ();
453 567
454int similar_direction (int a, int b); 568int similar_direction (int a, int b);
455 569
456// like printf, but returns a std::string 570// like sprintf, but returns a "static" buffer
457const std::string format (const char *format, ...); 571const char *format (const char *format, ...);
458 572
459#endif 573#endif
460 574

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines