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.37 by root, Thu Feb 15 15:43:36 2007 UTC vs.
Revision 1.59 by root, Sun Dec 16 02:50:33 2007 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
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 AUTODECL(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
45template<typename T, typename U> static inline T max (T a, U b) { return (U)a > b ? (U)a : b; } 80template<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; } 81template<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
48template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; } 83template<typename T, typename U> static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; }
49 84
85template<typename T>
86static inline T
87lerp (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}
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: this sucks, use a better checksum algo 95//TODO: that sucks, use a better checksum algo
54static inline uint32_t 96static inline uint32_t
55rotate_right (uint32_t c) 97rotate_right (uint32_t c, uint32_t count = 1)
56{ 98{
57 return (c << 31) | (c >> 1); 99 return (c << (32 - count)) | (c >> count);
100}
101
102static inline uint32_t
103rotate_left (uint32_t c, uint32_t count = 1)
104{
105 return (c >> (32 - count)) | (c << count);
58} 106}
59 107
60// Return abs(a-b) 108// Return abs(a-b)
61// Both a and b must not have the most significant bit set 109// Both a and b must not have the most significant bit set
62static inline uint32_t 110static inline uint32_t
124absdir (int d) 172absdir (int d)
125{ 173{
126 return ((d - 1) & 7) + 1; 174 return ((d - 1) & 7) + 1;
127} 175}
128 176
177extern size_t slice_alloc; // statistics
178
129// makes dynamically allocated objects zero-initialised 179// makes dynamically allocated objects zero-initialised
130struct zero_initialised 180struct zero_initialised
131{ 181{
132 void *operator new (size_t s, void *p) 182 void *operator new (size_t s, void *p)
133 { 183 {
135 return p; 185 return p;
136 } 186 }
137 187
138 void *operator new (size_t s) 188 void *operator new (size_t s)
139 { 189 {
190 slice_alloc += s;
140 return g_slice_alloc0 (s); 191 return g_slice_alloc0 (s);
141 } 192 }
142 193
143 void *operator new[] (size_t s) 194 void *operator new[] (size_t s)
144 { 195 {
196 slice_alloc += s;
145 return g_slice_alloc0 (s); 197 return g_slice_alloc0 (s);
146 } 198 }
147 199
148 void operator delete (void *p, size_t s) 200 void operator delete (void *p, size_t s)
149 { 201 {
202 slice_alloc -= s;
150 g_slice_free1 (s, p); 203 g_slice_free1 (s, p);
151 } 204 }
152 205
153 void operator delete[] (void *p, size_t s) 206 void operator delete[] (void *p, size_t s)
154 { 207 {
208 slice_alloc -= s;
155 g_slice_free1 (s, p); 209 g_slice_free1 (s, p);
156 } 210 }
157}; 211};
158 212
159void *salloc_ (int n) throw (std::bad_alloc); 213void *salloc_ (int n) throw (std::bad_alloc);
177inline void sfree (T *ptr, int n = 1) throw () 231inline void sfree (T *ptr, int n = 1) throw ()
178{ 232{
179#ifdef PREFER_MALLOC 233#ifdef PREFER_MALLOC
180 free (ptr); 234 free (ptr);
181#else 235#else
236 slice_alloc -= n * sizeof (T);
182 g_slice_free1 (n * sizeof (T), (void *)ptr); 237 g_slice_free1 (n * sizeof (T), (void *)ptr);
183#endif 238#endif
184} 239}
185 240
186// a STL-compatible allocator that uses g_slice 241// a STL-compatible allocator that uses g_slice
256 311
257 void seed (uint32_t seed); 312 void seed (uint32_t seed);
258 uint32_t next (); 313 uint32_t next ();
259 314
260 // uniform distribution 315 // uniform distribution
261 uint32_t operator ()(uint32_t r_max) 316 uint32_t operator ()(uint32_t num)
262 { 317 {
263 return is_constant (r_max) 318 return is_constant (num)
264 ? this->next () % r_max 319 ? (next () * (uint64_t)num) >> 32U
265 : get_range (r_max); 320 : get_range (num);
266 } 321 }
267 322
268 // return a number within (min .. max) 323 // return a number within (min .. max)
269 int operator () (int r_min, int r_max) 324 int operator () (int r_min, int r_max)
270 { 325 {
271 return is_constant (r_min) && is_constant (r_max) 326 return is_constant (r_min) && is_constant (r_max) && r_min <= r_max
272 ? r_min + (*this) (max (r_max - r_min + 1, 1)) 327 ? r_min + operator ()(r_max - r_min + 1)
273 : get_range (r_min, r_max); 328 : get_range (r_min, r_max);
274 } 329 }
275 330
276 double operator ()() 331 double operator ()()
277 { 332 {
285 340
286typedef tausworthe_random_generator rand_gen; 341typedef tausworthe_random_generator rand_gen;
287 342
288extern rand_gen rndm; 343extern rand_gen rndm;
289 344
345INTERFACE_CLASS (attachable)
346struct refcnt_base
347{
348 typedef int refcnt_t;
349 mutable refcnt_t ACC (RW, refcnt);
350
351 MTH void refcnt_inc () const { ++refcnt; }
352 MTH void refcnt_dec () const { --refcnt; }
353
354 refcnt_base () : refcnt (0) { }
355};
356
357// to avoid branches with more advanced compilers
358extern refcnt_base::refcnt_t refcnt_dummy;
359
290template<class T> 360template<class T>
291struct refptr 361struct refptr
292{ 362{
363 // p if not null
364 refcnt_base::refcnt_t *refcnt_ref () { return p ? &p->refcnt : &refcnt_dummy; }
365
366 void refcnt_dec ()
367 {
368 if (!is_constant (p))
369 --*refcnt_ref ();
370 else if (p)
371 --p->refcnt;
372 }
373
374 void refcnt_inc ()
375 {
376 if (!is_constant (p))
377 ++*refcnt_ref ();
378 else if (p)
379 ++p->refcnt;
380 }
381
293 T *p; 382 T *p;
294 383
295 refptr () : p(0) { } 384 refptr () : p(0) { }
296 refptr (const refptr<T> &p) : p(p.p) { if (p) p->refcnt_inc (); } 385 refptr (const refptr<T> &p) : p(p.p) { refcnt_inc (); }
297 refptr (T *p) : p(p) { if (p) p->refcnt_inc (); } 386 refptr (T *p) : p(p) { refcnt_inc (); }
298 ~refptr () { if (p) p->refcnt_dec (); } 387 ~refptr () { refcnt_dec (); }
299 388
300 const refptr<T> &operator =(T *o) 389 const refptr<T> &operator =(T *o)
301 { 390 {
391 // if decrementing ever destroys we need to reverse the order here
302 if (p) p->refcnt_dec (); 392 refcnt_dec ();
303 p = o; 393 p = o;
304 if (p) p->refcnt_inc (); 394 refcnt_inc ();
305
306 return *this; 395 return *this;
307 } 396 }
308 397
309 const refptr<T> &operator =(const refptr<T> o) 398 const refptr<T> &operator =(const refptr<T> &o)
310 { 399 {
311 *this = o.p; 400 *this = o.p;
312 return *this; 401 return *this;
313 } 402 }
314 403
315 T &operator * () const { return *p; } 404 T &operator * () const { return *p; }
316 T *operator ->() const { return p; } 405 T *operator ->() const { return p; }
317 406
318 operator T *() const { return p; } 407 operator T *() const { return p; }
319}; 408};
320 409
321typedef refptr<maptile> maptile_ptr; 410typedef refptr<maptile> maptile_ptr;
356 { 445 {
357 return !strcmp (a, b); 446 return !strcmp (a, b);
358 } 447 }
359}; 448};
360 449
450// Mostly the same as std::vector, but insert/erase can reorder
451// the elements, making append(=insert)/remove O(1) instead of O(n).
452//
453// NOTE: only some forms of erase are available
361template<class T> 454template<class T>
362struct unordered_vector : std::vector<T, slice_allocator<T> > 455struct unordered_vector : std::vector<T, slice_allocator<T> >
363{ 456{
364 typedef typename unordered_vector::iterator iterator; 457 typedef typename unordered_vector::iterator iterator;
365 458
375 { 468 {
376 erase ((unsigned int )(i - this->begin ())); 469 erase ((unsigned int )(i - this->begin ()));
377 } 470 }
378}; 471};
379 472
380template<class T, int T::* index> 473// This container blends advantages of linked lists
474// (efficiency) with vectors (random access) by
475// by using an unordered vector and storing the vector
476// index inside the object.
477//
478// + memory-efficient on most 64 bit archs
479// + O(1) insert/remove
480// + free unique (but varying) id for inserted objects
481// + cache-friendly iteration
482// - only works for pointers to structs
483//
484// NOTE: only some forms of erase/insert are available
485typedef int object_vector_index;
486
487template<class T, object_vector_index T::*indexmember>
381struct object_vector : std::vector<T *, slice_allocator<T *> > 488struct object_vector : std::vector<T *, slice_allocator<T *> >
382{ 489{
490 typedef typename object_vector::iterator iterator;
491
492 bool contains (const T *obj) const
493 {
494 return obj->*indexmember;
495 }
496
497 iterator find (const T *obj)
498 {
499 return obj->*indexmember
500 ? this->begin () + obj->*indexmember - 1
501 : this->end ();
502 }
503
504 void push_back (T *obj)
505 {
506 std::vector<T *, slice_allocator<T *> >::push_back (obj);
507 obj->*indexmember = this->size ();
508 }
509
383 void insert (T *obj) 510 void insert (T *obj)
384 { 511 {
385 assert (!(obj->*index));
386 push_back (obj); 512 push_back (obj);
387 obj->*index = this->size ();
388 } 513 }
389 514
390 void insert (T &obj) 515 void insert (T &obj)
391 { 516 {
392 insert (&obj); 517 insert (&obj);
393 } 518 }
394 519
395 void erase (T *obj) 520 void erase (T *obj)
396 { 521 {
397 assert (obj->*index);
398 int pos = obj->*index; 522 unsigned int pos = obj->*indexmember;
399 obj->*index = 0; 523 obj->*indexmember = 0;
400 524
401 if (pos < this->size ()) 525 if (pos < this->size ())
402 { 526 {
403 (*this)[pos - 1] = (*this)[this->size () - 1]; 527 (*this)[pos - 1] = (*this)[this->size () - 1];
404 (*this)[pos - 1]->*index = pos; 528 (*this)[pos - 1]->*indexmember = pos;
405 } 529 }
406 530
407 this->pop_back (); 531 this->pop_back ();
408 } 532 }
409 533
410 void erase (T &obj) 534 void erase (T &obj)
411 { 535 {
412 errase (&obj); 536 erase (&obj);
413 } 537 }
414}; 538};
415 539
416// basically does what strncpy should do, but appends "..." to strings exceeding length 540// basically does what strncpy should do, but appends "..." to strings exceeding length
417void assign (char *dst, const char *src, int maxlen); 541void assign (char *dst, const char *src, int maxlen);
423 assign ((char *)&dst, src, N); 547 assign ((char *)&dst, src, N);
424} 548}
425 549
426typedef double tstamp; 550typedef double tstamp;
427 551
428// return current time as timestampe 552// return current time as timestamp
429tstamp now (); 553tstamp now ();
430 554
431int similar_direction (int a, int b); 555int similar_direction (int a, int b);
432 556
557// like sprintf, but returns a "static" buffer
558const char *format (const char *format, ...);
559
433#endif 560#endif
434 561

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines