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.46 by root, Mon May 28 21:15:56 2007 UTC vs.
Revision 1.65 by root, Tue Apr 1 19:50:38 2008 UTC

1/* 1/*
2 * This file is part of Crossfire TRT, the Multiplayer Online Role Playing Game. 2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 * 3 *
4 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team 4 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 * 5 *
6 * Crossfire TRT is free software; you can redistribute it and/or modify it 6 * Deliantra is free software: you can redistribute it and/or modify
7 * under the terms of the GNU General Public License as published by the Free 7 * it under the terms of the GNU General Public License as published by
8 * Software Foundation; either version 2 of the License, or (at your option) 8 * the Free Software Foundation, either version 3 of the License, or
9 * any later version. 9 * (at your option) any later version.
10 * 10 *
11 * This program is distributed in the hope that it will be useful, but 11 * This program is distributed in the hope that it will be useful,
12 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * 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 along 16 * You should have received a copy of the GNU General Public License
17 * with Crossfire TRT; if not, write to the Free Software Foundation, Inc. 51 17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 * 18 *
20 * The authors can be reached via e-mail to <crossfire@schmorp.de> 19 * The authors can be reached via e-mail to <support@deliantra.net>
21 */ 20 */
22 21
23#ifndef UTIL_H__ 22#ifndef UTIL_H__
24#define UTIL_H__ 23#define UTIL_H__
25 24
25#define DEBUG_SALLOC 0
26//#define PREFER_MALLOC 26#define PREFER_MALLOC 0
27 27
28#if __GNUC__ >= 3 28#if __GNUC__ >= 3
29# 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)) 30# define expect(expr,value) __builtin_expect ((expr),(value))
31# define prefetch(addr,rw,locality) __builtin_prefetch (addr, rw, locality) 31# define prefetch(addr,rw,locality) __builtin_prefetch (addr, rw, locality)
33# define is_constant(c) 0 33# define is_constant(c) 0
34# define expect(expr,value) (expr) 34# define expect(expr,value) (expr)
35# define prefetch(addr,rw,locality) 35# define prefetch(addr,rw,locality)
36#endif 36#endif
37 37
38#if __GNUC__ < 4 || (__GNUC__ == 4 || __GNUC_MINOR__ < 4)
39# define decltype(x) typeof(x)
40#endif
41
38// put into ifs if you are very sure that the expression 42// put into ifs if you are very sure that the expression
39// is mostly true or mosty false. note that these return 43// is mostly true or mosty false. note that these return
40// booleans, not the expression. 44// booleans, not the expression.
41#define expect_false(expr) expect ((expr) != 0, 0) 45#define expect_false(expr) expect ((expr) != 0, 0)
42#define expect_true(expr) expect ((expr) != 0, 1) 46#define expect_true(expr) expect ((expr) != 0, 1)
49#include <glib.h> 53#include <glib.h>
50 54
51#include <shstr.h> 55#include <shstr.h>
52#include <traits.h> 56#include <traits.h>
53 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)
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
54// 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)
55#define auto(var,expr) typeof(expr) var = (expr) 68#define auto(var,expr) decltype(expr) var = (expr)
56 69
57// very ugly macro that basicaly declares and initialises a variable 70// very ugly macro that basicaly declares and initialises a variable
58// that is in scope for the next statement only 71// that is in scope for the next statement only
59// 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
60// (note: works great for pointers) 73// (note: works great for pointers)
61// most ugly macro I ever wrote 74// most ugly macro I ever wrote
62#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)
63 76
64// in range including end 77// in range including end
65#define IN_RANGE_INC(val,beg,end) \ 78#define IN_RANGE_INC(val,beg,end) \
66 ((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))
67 80
76template<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; }
77template<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; }
78template<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; }
79 92
80template<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)); }
81 97
82template<typename T> 98template<typename T>
83static inline T 99static inline T
84lerp (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)
85{ 101{
169absdir (int d) 185absdir (int d)
170{ 186{
171 return ((d - 1) & 7) + 1; 187 return ((d - 1) & 7) + 1;
172} 188}
173 189
190extern size_t slice_alloc; // statistics
191
174// makes dynamically allocated objects zero-initialised 192// makes dynamically allocated objects zero-initialised
175struct zero_initialised 193struct zero_initialised
176{ 194{
177 void *operator new (size_t s, void *p) 195 void *operator new (size_t s, void *p)
178 { 196 {
180 return p; 198 return p;
181 } 199 }
182 200
183 void *operator new (size_t s) 201 void *operator new (size_t s)
184 { 202 {
203 slice_alloc += s;
185 return g_slice_alloc0 (s); 204 return g_slice_alloc0 (s);
186 } 205 }
187 206
188 void *operator new[] (size_t s) 207 void *operator new[] (size_t s)
189 { 208 {
209 slice_alloc += s;
190 return g_slice_alloc0 (s); 210 return g_slice_alloc0 (s);
191 } 211 }
192 212
193 void operator delete (void *p, size_t s) 213 void operator delete (void *p, size_t s)
194 { 214 {
215 slice_alloc -= s;
195 g_slice_free1 (s, p); 216 g_slice_free1 (s, p);
196 } 217 }
197 218
198 void operator delete[] (void *p, size_t s) 219 void operator delete[] (void *p, size_t s)
199 { 220 {
221 slice_alloc -= s;
200 g_slice_free1 (s, p); 222 g_slice_free1 (s, p);
201 } 223 }
202}; 224};
203 225
204void *salloc_ (int n) throw (std::bad_alloc); 226void *salloc_ (int n) throw (std::bad_alloc);
219 241
220// for symmetry 242// for symmetry
221template<typename T> 243template<typename T>
222inline void sfree (T *ptr, int n = 1) throw () 244inline void sfree (T *ptr, int n = 1) throw ()
223{ 245{
224#ifdef PREFER_MALLOC 246#if PREFER_MALLOC
225 free (ptr); 247 free (ptr);
226#else 248#else
249 slice_alloc -= n * sizeof (T);
227 g_slice_free1 (n * sizeof (T), (void *)ptr); 250 g_slice_free1 (n * sizeof (T), (void *)ptr);
228#endif 251#endif
229} 252}
230 253
231// a STL-compatible allocator that uses g_slice 254// a STL-compatible allocator that uses g_slice
246 { 269 {
247 typedef slice_allocator<U> other; 270 typedef slice_allocator<U> other;
248 }; 271 };
249 272
250 slice_allocator () throw () { } 273 slice_allocator () throw () { }
251 slice_allocator (const slice_allocator &o) throw () { } 274 slice_allocator (const slice_allocator &) throw () { }
252 template<typename Tp2> 275 template<typename Tp2>
253 slice_allocator (const slice_allocator<Tp2> &) throw () { } 276 slice_allocator (const slice_allocator<Tp2> &) throw () { }
254 277
255 ~slice_allocator () { } 278 ~slice_allocator () { }
256 279
265 void deallocate (pointer p, size_type n) 288 void deallocate (pointer p, size_type n)
266 { 289 {
267 sfree<Tp> (p, n); 290 sfree<Tp> (p, n);
268 } 291 }
269 292
270 size_type max_size ()const throw () 293 size_type max_size () const throw ()
271 { 294 {
272 return size_t (-1) / sizeof (Tp); 295 return size_t (-1) / sizeof (Tp);
273 } 296 }
274 297
275 void construct (pointer p, const Tp &val) 298 void construct (pointer p, const Tp &val)
330 353
331typedef tausworthe_random_generator rand_gen; 354typedef tausworthe_random_generator rand_gen;
332 355
333extern rand_gen rndm; 356extern rand_gen rndm;
334 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
335template<class T> 373template<class T>
336struct refptr 374struct refptr
337{ 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
338 T *p; 395 T *p;
339 396
340 refptr () : p(0) { } 397 refptr () : p(0) { }
341 refptr (const refptr<T> &p) : p(p.p) { if (p) p->refcnt_inc (); } 398 refptr (const refptr<T> &p) : p(p.p) { refcnt_inc (); }
342 refptr (T *p) : p(p) { if (p) p->refcnt_inc (); } 399 refptr (T *p) : p(p) { refcnt_inc (); }
343 ~refptr () { if (p) p->refcnt_dec (); } 400 ~refptr () { refcnt_dec (); }
344 401
345 const refptr<T> &operator =(T *o) 402 const refptr<T> &operator =(T *o)
346 { 403 {
404 // if decrementing ever destroys we need to reverse the order here
347 if (p) p->refcnt_dec (); 405 refcnt_dec ();
348 p = o; 406 p = o;
349 if (p) p->refcnt_inc (); 407 refcnt_inc ();
350
351 return *this; 408 return *this;
352 } 409 }
353 410
354 const refptr<T> &operator =(const refptr<T> o) 411 const refptr<T> &operator =(const refptr<T> &o)
355 { 412 {
356 *this = o.p; 413 *this = o.p;
357 return *this; 414 return *this;
358 } 415 }
359 416
360 T &operator * () const { return *p; } 417 T &operator * () const { return *p; }
361 T *operator ->() const { return p; } 418 T *operator ->() const { return p; }
362 419
363 operator T *() const { return p; } 420 operator T *() const { return p; }
364}; 421};
365 422
366typedef refptr<maptile> maptile_ptr; 423typedef refptr<maptile> maptile_ptr;
401 { 458 {
402 return !strcmp (a, b); 459 return !strcmp (a, b);
403 } 460 }
404}; 461};
405 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
406template<class T> 467template<class T>
407struct unordered_vector : std::vector<T, slice_allocator<T> > 468struct unordered_vector : std::vector<T, slice_allocator<T> >
408{ 469{
409 typedef typename unordered_vector::iterator iterator; 470 typedef typename unordered_vector::iterator iterator;
410 471
420 { 481 {
421 erase ((unsigned int )(i - this->begin ())); 482 erase ((unsigned int )(i - this->begin ()));
422 } 483 }
423}; 484};
424 485
425template<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>
426struct object_vector : std::vector<T *, slice_allocator<T *> > 501struct object_vector : std::vector<T *, slice_allocator<T *> >
427{ 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
428 void insert (T *obj) 523 void insert (T *obj)
429 { 524 {
430 assert (!(obj->*index));
431 push_back (obj); 525 push_back (obj);
432 obj->*index = this->size ();
433 } 526 }
434 527
435 void insert (T &obj) 528 void insert (T &obj)
436 { 529 {
437 insert (&obj); 530 insert (&obj);
438 } 531 }
439 532
440 void erase (T *obj) 533 void erase (T *obj)
441 { 534 {
442 assert (obj->*index);
443 unsigned int pos = obj->*index; 535 unsigned int pos = obj->*indexmember;
444 obj->*index = 0; 536 obj->*indexmember = 0;
445 537
446 if (pos < this->size ()) 538 if (pos < this->size ())
447 { 539 {
448 (*this)[pos - 1] = (*this)[this->size () - 1]; 540 (*this)[pos - 1] = (*this)[this->size () - 1];
449 (*this)[pos - 1]->*index = pos; 541 (*this)[pos - 1]->*indexmember = pos;
450 } 542 }
451 543
452 this->pop_back (); 544 this->pop_back ();
453 } 545 }
454 546
455 void erase (T &obj) 547 void erase (T &obj)
456 { 548 {
457 errase (&obj); 549 erase (&obj);
458 } 550 }
459}; 551};
460 552
461// 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
462void assign (char *dst, const char *src, int maxlen); 554void assign (char *dst, const char *src, int maxlen);
468 assign ((char *)&dst, src, N); 560 assign ((char *)&dst, src, N);
469} 561}
470 562
471typedef double tstamp; 563typedef double tstamp;
472 564
473// return current time as timestampe 565// return current time as timestamp
474tstamp now (); 566tstamp now ();
475 567
476int similar_direction (int a, int b); 568int similar_direction (int a, int b);
477 569
478// like printf, but returns a std::string 570// like sprintf, but returns a "static" buffer
479const std::string format (const char *format, ...); 571const char *format (const char *format, ...);
480 572
481#endif 573#endif
482 574

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines