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.43 by root, Mon Apr 23 18:09:57 2007 UTC vs.
Revision 1.62 by root, Fri Jan 25 18:13:57 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)
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#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
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 auto(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
44template<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; }
45template<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; }
46template<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; }
47 92
48template<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>
96static inline T
97lerp (T val, T min_in, T max_in, T min_out, T max_out)
98{
99 return (val - min_in) * (max_out - min_out) / (max_in - min_in) + min_out;
100}
49 101
50// lots of stuff taken from FXT 102// lots of stuff taken from FXT
51 103
52/* Rotate right. This is used in various places for checksumming */ 104/* Rotate right. This is used in various places for checksumming */
53//TODO: that sucks, use a better checksum algo 105//TODO: that sucks, use a better checksum algo
130absdir (int d) 182absdir (int d)
131{ 183{
132 return ((d - 1) & 7) + 1; 184 return ((d - 1) & 7) + 1;
133} 185}
134 186
187extern size_t slice_alloc; // statistics
188
135// makes dynamically allocated objects zero-initialised 189// makes dynamically allocated objects zero-initialised
136struct zero_initialised 190struct zero_initialised
137{ 191{
138 void *operator new (size_t s, void *p) 192 void *operator new (size_t s, void *p)
139 { 193 {
141 return p; 195 return p;
142 } 196 }
143 197
144 void *operator new (size_t s) 198 void *operator new (size_t s)
145 { 199 {
200 slice_alloc += s;
146 return g_slice_alloc0 (s); 201 return g_slice_alloc0 (s);
147 } 202 }
148 203
149 void *operator new[] (size_t s) 204 void *operator new[] (size_t s)
150 { 205 {
206 slice_alloc += s;
151 return g_slice_alloc0 (s); 207 return g_slice_alloc0 (s);
152 } 208 }
153 209
154 void operator delete (void *p, size_t s) 210 void operator delete (void *p, size_t s)
155 { 211 {
212 slice_alloc -= s;
156 g_slice_free1 (s, p); 213 g_slice_free1 (s, p);
157 } 214 }
158 215
159 void operator delete[] (void *p, size_t s) 216 void operator delete[] (void *p, size_t s)
160 { 217 {
218 slice_alloc -= s;
161 g_slice_free1 (s, p); 219 g_slice_free1 (s, p);
162 } 220 }
163}; 221};
164 222
165void *salloc_ (int n) throw (std::bad_alloc); 223void *salloc_ (int n) throw (std::bad_alloc);
183inline void sfree (T *ptr, int n = 1) throw () 241inline void sfree (T *ptr, int n = 1) throw ()
184{ 242{
185#ifdef PREFER_MALLOC 243#ifdef PREFER_MALLOC
186 free (ptr); 244 free (ptr);
187#else 245#else
246 slice_alloc -= n * sizeof (T);
188 g_slice_free1 (n * sizeof (T), (void *)ptr); 247 g_slice_free1 (n * sizeof (T), (void *)ptr);
189#endif 248#endif
190} 249}
191 250
192// a STL-compatible allocator that uses g_slice 251// a STL-compatible allocator that uses g_slice
291 350
292typedef tausworthe_random_generator rand_gen; 351typedef tausworthe_random_generator rand_gen;
293 352
294extern rand_gen rndm; 353extern rand_gen rndm;
295 354
355INTERFACE_CLASS (attachable)
356struct refcnt_base
357{
358 typedef int refcnt_t;
359 mutable refcnt_t ACC (RW, refcnt);
360
361 MTH void refcnt_inc () const { ++refcnt; }
362 MTH void refcnt_dec () const { --refcnt; }
363
364 refcnt_base () : refcnt (0) { }
365};
366
367// to avoid branches with more advanced compilers
368extern refcnt_base::refcnt_t refcnt_dummy;
369
296template<class T> 370template<class T>
297struct refptr 371struct refptr
298{ 372{
373 // p if not null
374 refcnt_base::refcnt_t *refcnt_ref () { return p ? &p->refcnt : &refcnt_dummy; }
375
376 void refcnt_dec ()
377 {
378 if (!is_constant (p))
379 --*refcnt_ref ();
380 else if (p)
381 --p->refcnt;
382 }
383
384 void refcnt_inc ()
385 {
386 if (!is_constant (p))
387 ++*refcnt_ref ();
388 else if (p)
389 ++p->refcnt;
390 }
391
299 T *p; 392 T *p;
300 393
301 refptr () : p(0) { } 394 refptr () : p(0) { }
302 refptr (const refptr<T> &p) : p(p.p) { if (p) p->refcnt_inc (); } 395 refptr (const refptr<T> &p) : p(p.p) { refcnt_inc (); }
303 refptr (T *p) : p(p) { if (p) p->refcnt_inc (); } 396 refptr (T *p) : p(p) { refcnt_inc (); }
304 ~refptr () { if (p) p->refcnt_dec (); } 397 ~refptr () { refcnt_dec (); }
305 398
306 const refptr<T> &operator =(T *o) 399 const refptr<T> &operator =(T *o)
307 { 400 {
401 // if decrementing ever destroys we need to reverse the order here
308 if (p) p->refcnt_dec (); 402 refcnt_dec ();
309 p = o; 403 p = o;
310 if (p) p->refcnt_inc (); 404 refcnt_inc ();
311
312 return *this; 405 return *this;
313 } 406 }
314 407
315 const refptr<T> &operator =(const refptr<T> o) 408 const refptr<T> &operator =(const refptr<T> &o)
316 { 409 {
317 *this = o.p; 410 *this = o.p;
318 return *this; 411 return *this;
319 } 412 }
320 413
321 T &operator * () const { return *p; } 414 T &operator * () const { return *p; }
322 T *operator ->() const { return p; } 415 T *operator ->() const { return p; }
323 416
324 operator T *() const { return p; } 417 operator T *() const { return p; }
325}; 418};
326 419
327typedef refptr<maptile> maptile_ptr; 420typedef refptr<maptile> maptile_ptr;
362 { 455 {
363 return !strcmp (a, b); 456 return !strcmp (a, b);
364 } 457 }
365}; 458};
366 459
460// Mostly the same as std::vector, but insert/erase can reorder
461// the elements, making append(=insert)/remove O(1) instead of O(n).
462//
463// NOTE: only some forms of erase are available
367template<class T> 464template<class T>
368struct unordered_vector : std::vector<T, slice_allocator<T> > 465struct unordered_vector : std::vector<T, slice_allocator<T> >
369{ 466{
370 typedef typename unordered_vector::iterator iterator; 467 typedef typename unordered_vector::iterator iterator;
371 468
381 { 478 {
382 erase ((unsigned int )(i - this->begin ())); 479 erase ((unsigned int )(i - this->begin ()));
383 } 480 }
384}; 481};
385 482
386template<class T, int T::* index> 483// This container blends advantages of linked lists
484// (efficiency) with vectors (random access) by
485// by using an unordered vector and storing the vector
486// index inside the object.
487//
488// + memory-efficient on most 64 bit archs
489// + O(1) insert/remove
490// + free unique (but varying) id for inserted objects
491// + cache-friendly iteration
492// - only works for pointers to structs
493//
494// NOTE: only some forms of erase/insert are available
495typedef int object_vector_index;
496
497template<class T, object_vector_index T::*indexmember>
387struct object_vector : std::vector<T *, slice_allocator<T *> > 498struct object_vector : std::vector<T *, slice_allocator<T *> >
388{ 499{
500 typedef typename object_vector::iterator iterator;
501
502 bool contains (const T *obj) const
503 {
504 return obj->*indexmember;
505 }
506
507 iterator find (const T *obj)
508 {
509 return obj->*indexmember
510 ? this->begin () + obj->*indexmember - 1
511 : this->end ();
512 }
513
514 void push_back (T *obj)
515 {
516 std::vector<T *, slice_allocator<T *> >::push_back (obj);
517 obj->*indexmember = this->size ();
518 }
519
389 void insert (T *obj) 520 void insert (T *obj)
390 { 521 {
391 assert (!(obj->*index));
392 push_back (obj); 522 push_back (obj);
393 obj->*index = this->size ();
394 } 523 }
395 524
396 void insert (T &obj) 525 void insert (T &obj)
397 { 526 {
398 insert (&obj); 527 insert (&obj);
399 } 528 }
400 529
401 void erase (T *obj) 530 void erase (T *obj)
402 { 531 {
403 assert (obj->*index);
404 unsigned int pos = obj->*index; 532 unsigned int pos = obj->*indexmember;
405 obj->*index = 0; 533 obj->*indexmember = 0;
406 534
407 if (pos < this->size ()) 535 if (pos < this->size ())
408 { 536 {
409 (*this)[pos - 1] = (*this)[this->size () - 1]; 537 (*this)[pos - 1] = (*this)[this->size () - 1];
410 (*this)[pos - 1]->*index = pos; 538 (*this)[pos - 1]->*indexmember = pos;
411 } 539 }
412 540
413 this->pop_back (); 541 this->pop_back ();
414 } 542 }
415 543
416 void erase (T &obj) 544 void erase (T &obj)
417 { 545 {
418 errase (&obj); 546 erase (&obj);
419 } 547 }
420}; 548};
421 549
422// basically does what strncpy should do, but appends "..." to strings exceeding length 550// basically does what strncpy should do, but appends "..." to strings exceeding length
423void assign (char *dst, const char *src, int maxlen); 551void assign (char *dst, const char *src, int maxlen);
429 assign ((char *)&dst, src, N); 557 assign ((char *)&dst, src, N);
430} 558}
431 559
432typedef double tstamp; 560typedef double tstamp;
433 561
434// return current time as timestampe 562// return current time as timestamp
435tstamp now (); 563tstamp now ();
436 564
437int similar_direction (int a, int b); 565int similar_direction (int a, int b);
438 566
439// like printf, but returns a std::string 567// like sprintf, but returns a "static" buffer
440const std::string format (const char *format, ...); 568const char *format (const char *format, ...);
441 569
442#endif 570#endif
443 571

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines