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.56 by root, Sun Sep 9 06:25:46 2007 UTC

1/*
2 * This file is part of Crossfire TRT, the Roguelike Realtime MORPG.
3 *
4 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team
5 *
6 * Crossfire TRT 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 <crossfire@schmorp.de>
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
256 304
257 void seed (uint32_t seed); 305 void seed (uint32_t seed);
258 uint32_t next (); 306 uint32_t next ();
259 307
260 // uniform distribution 308 // uniform distribution
261 uint32_t operator ()(uint32_t r_max) 309 uint32_t operator ()(uint32_t num)
262 { 310 {
263 return is_constant (r_max) 311 return is_constant (num)
264 ? this->next () % r_max 312 ? (next () * (uint64_t)num) >> 32U
265 : get_range (r_max); 313 : get_range (num);
266 } 314 }
267 315
268 // return a number within (min .. max) 316 // return a number within (min .. max)
269 int operator () (int r_min, int r_max) 317 int operator () (int r_min, int r_max)
270 { 318 {
271 return is_constant (r_min) && is_constant (r_max) 319 return is_constant (r_min) && is_constant (r_max) && r_min <= r_max
272 ? r_min + (*this) (max (r_max - r_min + 1, 1)) 320 ? r_min + operator ()(r_max - r_min + 1)
273 : get_range (r_min, r_max); 321 : get_range (r_min, r_max);
274 } 322 }
275 323
276 double operator ()() 324 double operator ()()
277 { 325 {
285 333
286typedef tausworthe_random_generator rand_gen; 334typedef tausworthe_random_generator rand_gen;
287 335
288extern rand_gen rndm; 336extern rand_gen rndm;
289 337
338INTERFACE_CLASS (attachable)
339struct refcnt_base
340{
341 typedef int refcnt_t;
342 mutable refcnt_t ACC (RW, refcnt);
343
344 MTH void refcnt_inc () const { ++refcnt; }
345 MTH void refcnt_dec () const { --refcnt; }
346
347 refcnt_base () : refcnt (0) { }
348};
349
350// to avoid branches with more advanced compilers
351extern refcnt_base::refcnt_t refcnt_dummy;
352
290template<class T> 353template<class T>
291struct refptr 354struct refptr
292{ 355{
356 // p if not null
357 refcnt_base::refcnt_t *refcnt_ref () { return p ? &p->refcnt : &refcnt_dummy; }
358
359 void refcnt_dec ()
360 {
361 if (!is_constant (p))
362 --*refcnt_ref ();
363 else if (p)
364 --p->refcnt;
365 }
366
367 void refcnt_inc ()
368 {
369 if (!is_constant (p))
370 ++*refcnt_ref ();
371 else if (p)
372 ++p->refcnt;
373 }
374
293 T *p; 375 T *p;
294 376
295 refptr () : p(0) { } 377 refptr () : p(0) { }
296 refptr (const refptr<T> &p) : p(p.p) { if (p) p->refcnt_inc (); } 378 refptr (const refptr<T> &p) : p(p.p) { refcnt_inc (); }
297 refptr (T *p) : p(p) { if (p) p->refcnt_inc (); } 379 refptr (T *p) : p(p) { refcnt_inc (); }
298 ~refptr () { if (p) p->refcnt_dec (); } 380 ~refptr () { refcnt_dec (); }
299 381
300 const refptr<T> &operator =(T *o) 382 const refptr<T> &operator =(T *o)
301 { 383 {
384 // if decrementing ever destroys we need to reverse the order here
302 if (p) p->refcnt_dec (); 385 refcnt_dec ();
303 p = o; 386 p = o;
304 if (p) p->refcnt_inc (); 387 refcnt_inc ();
305
306 return *this; 388 return *this;
307 } 389 }
308 390
309 const refptr<T> &operator =(const refptr<T> o) 391 const refptr<T> &operator =(const refptr<T> &o)
310 { 392 {
311 *this = o.p; 393 *this = o.p;
312 return *this; 394 return *this;
313 } 395 }
314 396
315 T &operator * () const { return *p; } 397 T &operator * () const { return *p; }
316 T *operator ->() const { return p; } 398 T *operator ->() const { return p; }
317 399
318 operator T *() const { return p; } 400 operator T *() const { return p; }
319}; 401};
320 402
321typedef refptr<maptile> maptile_ptr; 403typedef refptr<maptile> maptile_ptr;
356 { 438 {
357 return !strcmp (a, b); 439 return !strcmp (a, b);
358 } 440 }
359}; 441};
360 442
443// Mostly the same as std::vector, but insert/erase can reorder
444// the elements, making append(=insert)/remove O(1) instead of O(n).
445//
446// NOTE: only some forms of erase are available
361template<class T> 447template<class T>
362struct unordered_vector : std::vector<T, slice_allocator<T> > 448struct unordered_vector : std::vector<T, slice_allocator<T> >
363{ 449{
364 typedef typename unordered_vector::iterator iterator; 450 typedef typename unordered_vector::iterator iterator;
365 451
375 { 461 {
376 erase ((unsigned int )(i - this->begin ())); 462 erase ((unsigned int )(i - this->begin ()));
377 } 463 }
378}; 464};
379 465
380template<class T, int T::* index> 466// This container blends advantages of linked lists
467// (efficiency) with vectors (random access) by
468// by using an unordered vector and storing the vector
469// index inside the object.
470//
471// + memory-efficient on most 64 bit archs
472// + O(1) insert/remove
473// + free unique (but varying) id for inserted objects
474// + cache-friendly iteration
475// - only works for pointers to structs
476//
477// NOTE: only some forms of erase/insert are available
478typedef int object_vector_index;
479
480template<class T, object_vector_index T::*indexmember>
381struct object_vector : std::vector<T *, slice_allocator<T *> > 481struct object_vector : std::vector<T *, slice_allocator<T *> >
382{ 482{
483 typedef typename object_vector::iterator iterator;
484
485 bool contains (const T *obj) const
486 {
487 return obj->*indexmember;
488 }
489
490 iterator find (const T *obj)
491 {
492 return obj->*indexmember
493 ? this->begin () + obj->*indexmember - 1
494 : this->end ();
495 }
496
497 void push_back (T *obj)
498 {
499 std::vector<T *, slice_allocator<T *> >::push_back (obj);
500 obj->*indexmember = this->size ();
501 }
502
383 void insert (T *obj) 503 void insert (T *obj)
384 { 504 {
385 assert (!(obj->*index));
386 push_back (obj); 505 push_back (obj);
387 obj->*index = this->size ();
388 } 506 }
389 507
390 void insert (T &obj) 508 void insert (T &obj)
391 { 509 {
392 insert (&obj); 510 insert (&obj);
393 } 511 }
394 512
395 void erase (T *obj) 513 void erase (T *obj)
396 { 514 {
397 assert (obj->*index);
398 int pos = obj->*index; 515 unsigned int pos = obj->*indexmember;
399 obj->*index = 0; 516 obj->*indexmember = 0;
400 517
401 if (pos < this->size ()) 518 if (pos < this->size ())
402 { 519 {
403 (*this)[pos - 1] = (*this)[this->size () - 1]; 520 (*this)[pos - 1] = (*this)[this->size () - 1];
404 (*this)[pos - 1]->*index = pos; 521 (*this)[pos - 1]->*indexmember = pos;
405 } 522 }
406 523
407 this->pop_back (); 524 this->pop_back ();
408 } 525 }
409 526
410 void erase (T &obj) 527 void erase (T &obj)
411 { 528 {
412 errase (&obj); 529 erase (&obj);
413 } 530 }
414}; 531};
415 532
416// basically does what strncpy should do, but appends "..." to strings exceeding length 533// basically does what strncpy should do, but appends "..." to strings exceeding length
417void assign (char *dst, const char *src, int maxlen); 534void assign (char *dst, const char *src, int maxlen);
428// return current time as timestampe 545// return current time as timestampe
429tstamp now (); 546tstamp now ();
430 547
431int similar_direction (int a, int b); 548int similar_direction (int a, int b);
432 549
550// like sprintf, but returns a "static" buffer
551const char *format (const char *format, ...);
552
433#endif 553#endif
434 554

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines