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.58 by root, Thu Nov 8 19:43:25 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
11# define is_constant(c) 0 32# define is_constant(c) 0
12# define expect(expr,value) (expr) 33# define expect(expr,value) (expr)
13# define prefetch(addr,rw,locality) 34# define prefetch(addr,rw,locality)
14#endif 35#endif
15 36
37#if __GNUC__ < 4 || (__GNUC__ == 4 || __GNUC_MINOR__ < 4)
38# define decltype(x) typeof(x)
39#endif
40
16// put into ifs if you are very sure that the expression 41// put into ifs if you are very sure that the expression
17// is mostly true or mosty false. note that these return 42// is mostly true or mosty false. note that these return
18// booleans, not the expression. 43// booleans, not the expression.
19#define expect_false(expr) expect ((expr) != 0, 0) 44#define expect_false(expr) expect ((expr) != 0, 0)
20#define expect_true(expr) expect ((expr) != 0, 1) 45#define expect_true(expr) expect ((expr) != 0, 1)
27#include <glib.h> 52#include <glib.h>
28 53
29#include <shstr.h> 54#include <shstr.h>
30#include <traits.h> 55#include <traits.h>
31 56
32// 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)
33#define auto(var,expr) typeof(expr) var = (expr) 58#define auto(var,expr) decltype(expr) var = (expr)
34 59
35// very ugly macro that basicaly declares and initialises a variable 60// very ugly macro that basicaly declares and initialises a variable
36// that is in scope for the next statement only 61// that is in scope for the next statement only
37// 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
38// (note: works great for pointers) 63// (note: works great for pointers)
39// most ugly macro I ever wrote 64// most ugly macro I ever wrote
40#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)
41 66
42// in range including end 67// in range including end
43#define IN_RANGE_INC(val,beg,end) \ 68#define IN_RANGE_INC(val,beg,end) \
44 ((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))
45 70
147absdir (int d) 172absdir (int d)
148{ 173{
149 return ((d - 1) & 7) + 1; 174 return ((d - 1) & 7) + 1;
150} 175}
151 176
177extern size_t slice_alloc; // statistics
178
152// makes dynamically allocated objects zero-initialised 179// makes dynamically allocated objects zero-initialised
153struct zero_initialised 180struct zero_initialised
154{ 181{
155 void *operator new (size_t s, void *p) 182 void *operator new (size_t s, void *p)
156 { 183 {
158 return p; 185 return p;
159 } 186 }
160 187
161 void *operator new (size_t s) 188 void *operator new (size_t s)
162 { 189 {
190 slice_alloc += s;
163 return g_slice_alloc0 (s); 191 return g_slice_alloc0 (s);
164 } 192 }
165 193
166 void *operator new[] (size_t s) 194 void *operator new[] (size_t s)
167 { 195 {
196 slice_alloc += s;
168 return g_slice_alloc0 (s); 197 return g_slice_alloc0 (s);
169 } 198 }
170 199
171 void operator delete (void *p, size_t s) 200 void operator delete (void *p, size_t s)
172 { 201 {
202 slice_alloc -= s;
173 g_slice_free1 (s, p); 203 g_slice_free1 (s, p);
174 } 204 }
175 205
176 void operator delete[] (void *p, size_t s) 206 void operator delete[] (void *p, size_t s)
177 { 207 {
208 slice_alloc -= s;
178 g_slice_free1 (s, p); 209 g_slice_free1 (s, p);
179 } 210 }
180}; 211};
181 212
182void *salloc_ (int n) throw (std::bad_alloc); 213void *salloc_ (int n) throw (std::bad_alloc);
200inline void sfree (T *ptr, int n = 1) throw () 231inline void sfree (T *ptr, int n = 1) throw ()
201{ 232{
202#ifdef PREFER_MALLOC 233#ifdef PREFER_MALLOC
203 free (ptr); 234 free (ptr);
204#else 235#else
236 slice_alloc -= n * sizeof (T);
205 g_slice_free1 (n * sizeof (T), (void *)ptr); 237 g_slice_free1 (n * sizeof (T), (void *)ptr);
206#endif 238#endif
207} 239}
208 240
209// a STL-compatible allocator that uses g_slice 241// a STL-compatible allocator that uses g_slice
308 340
309typedef tausworthe_random_generator rand_gen; 341typedef tausworthe_random_generator rand_gen;
310 342
311extern rand_gen rndm; 343extern rand_gen rndm;
312 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
313template<class T> 360template<class T>
314struct refptr 361struct refptr
315{ 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
316 T *p; 382 T *p;
317 383
318 refptr () : p(0) { } 384 refptr () : p(0) { }
319 refptr (const refptr<T> &p) : p(p.p) { if (p) p->refcnt_inc (); } 385 refptr (const refptr<T> &p) : p(p.p) { refcnt_inc (); }
320 refptr (T *p) : p(p) { if (p) p->refcnt_inc (); } 386 refptr (T *p) : p(p) { refcnt_inc (); }
321 ~refptr () { if (p) p->refcnt_dec (); } 387 ~refptr () { refcnt_dec (); }
322 388
323 const refptr<T> &operator =(T *o) 389 const refptr<T> &operator =(T *o)
324 { 390 {
391 // if decrementing ever destroys we need to reverse the order here
325 if (p) p->refcnt_dec (); 392 refcnt_dec ();
326 p = o; 393 p = o;
327 if (p) p->refcnt_inc (); 394 refcnt_inc ();
328
329 return *this; 395 return *this;
330 } 396 }
331 397
332 const refptr<T> &operator =(const refptr<T> o) 398 const refptr<T> &operator =(const refptr<T> &o)
333 { 399 {
334 *this = o.p; 400 *this = o.p;
335 return *this; 401 return *this;
336 } 402 }
337 403
338 T &operator * () const { return *p; } 404 T &operator * () const { return *p; }
339 T *operator ->() const { return p; } 405 T *operator ->() const { return p; }
340 406
341 operator T *() const { return p; } 407 operator T *() const { return p; }
342}; 408};
343 409
344typedef refptr<maptile> maptile_ptr; 410typedef refptr<maptile> maptile_ptr;
379 { 445 {
380 return !strcmp (a, b); 446 return !strcmp (a, b);
381 } 447 }
382}; 448};
383 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
384template<class T> 454template<class T>
385struct unordered_vector : std::vector<T, slice_allocator<T> > 455struct unordered_vector : std::vector<T, slice_allocator<T> >
386{ 456{
387 typedef typename unordered_vector::iterator iterator; 457 typedef typename unordered_vector::iterator iterator;
388 458
398 { 468 {
399 erase ((unsigned int )(i - this->begin ())); 469 erase ((unsigned int )(i - this->begin ()));
400 } 470 }
401}; 471};
402 472
403template<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>
404struct object_vector : std::vector<T *, slice_allocator<T *> > 488struct object_vector : std::vector<T *, slice_allocator<T *> >
405{ 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
406 void insert (T *obj) 510 void insert (T *obj)
407 { 511 {
408 assert (!(obj->*index));
409 push_back (obj); 512 push_back (obj);
410 obj->*index = this->size ();
411 } 513 }
412 514
413 void insert (T &obj) 515 void insert (T &obj)
414 { 516 {
415 insert (&obj); 517 insert (&obj);
416 } 518 }
417 519
418 void erase (T *obj) 520 void erase (T *obj)
419 { 521 {
420 assert (obj->*index);
421 unsigned int pos = obj->*index; 522 unsigned int pos = obj->*indexmember;
422 obj->*index = 0; 523 obj->*indexmember = 0;
423 524
424 if (pos < this->size ()) 525 if (pos < this->size ())
425 { 526 {
426 (*this)[pos - 1] = (*this)[this->size () - 1]; 527 (*this)[pos - 1] = (*this)[this->size () - 1];
427 (*this)[pos - 1]->*index = pos; 528 (*this)[pos - 1]->*indexmember = pos;
428 } 529 }
429 530
430 this->pop_back (); 531 this->pop_back ();
431 } 532 }
432 533
433 void erase (T &obj) 534 void erase (T &obj)
434 { 535 {
435 errase (&obj); 536 erase (&obj);
436 } 537 }
437}; 538};
438 539
439// 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
440void assign (char *dst, const char *src, int maxlen); 541void assign (char *dst, const char *src, int maxlen);
451// return current time as timestampe 552// return current time as timestampe
452tstamp now (); 553tstamp now ();
453 554
454int similar_direction (int a, int b); 555int similar_direction (int a, int b);
455 556
456// like printf, but returns a std::string 557// like sprintf, but returns a "static" buffer
457const std::string format (const char *format, ...); 558const char *format (const char *format, ...);
458 559
459#endif 560#endif
460 561

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines