/*
* This file is part of Deliantra, the Roguelike Realtime MMORPG.
*
* Copyright (©) 2005,2006,2007,2008,2009,2010,2011,2012,2013,2014,2015,2016 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
*
* Deliantra is free software: you can redistribute it and/or modify it under
* the terms of the Affero GNU General Public License as published by the
* Free Software Foundation, either version 3 of the License, or (at your
* option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the Affero GNU General Public License
* and the GNU General Public License along with this program. If not, see
* .
*
* The authors can be reached via e-mail to
*/
#ifndef UTIL_H__
#define UTIL_H__
#include
#define DEBUG_POISON 0x00 // poison memory before freeing it if != 0
#define DEBUG_SALLOC 0 // add a debug wrapper around all sallocs
#define PREFER_MALLOC 0 // use malloc and not the slice allocator
#include
#include
#include
#include
#include
#include
#include
#include
#if DEBUG_SALLOC
# define g_slice_alloc0(s) debug_slice_alloc0(s)
# define g_slice_alloc(s) debug_slice_alloc(s)
# define g_slice_free1(s,p) debug_slice_free1(s,p)
void *g_slice_alloc (unsigned long size);
void *g_slice_alloc0 (unsigned long size);
void g_slice_free1 (unsigned long size, void *ptr);
#elif PREFER_MALLOC
# define g_slice_alloc0(s) calloc (1, (s))
# define g_slice_alloc(s) malloc ((s))
# define g_slice_free1(s,p) free ((p))
#endif
// use C0X decltype for auto declarations until ISO C++ sanctifies them (if ever)
#define auto(var,expr) decltype(expr) var = (expr)
#if cplusplus_does_not_suck /* still sucks in codesize with gcc 6, although local types work now */
// does not work for local types (http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2008/n2657.htm)
template
static inline int array_length (const T (&arr)[N])
{
return N;
}
#else
#define array_length(name) (sizeof (name) / sizeof (name [0]))
#endif
// very ugly macro that basically declares and initialises a variable
// that is in scope for the next statement only
// works only for stuff that can be assigned 0 and converts to false
// (note: works great for pointers)
// most ugly macro I ever wrote
#define statementvar(type, name, value) if (type name = 0) { } else if (((name) = (value)), 1)
// in range including end
#define IN_RANGE_INC(val,beg,end) \
((unsigned int)(val) - (unsigned int)(beg) <= (unsigned int)(end) - (unsigned int)(beg))
// in range excluding end
#define IN_RANGE_EXC(val,beg,end) \
((unsigned int)(val) - (unsigned int)(beg) < (unsigned int)(end) - (unsigned int)(beg))
void cleanup (const char *cause, bool make_core = false);
void fork_abort (const char *msg);
// rationale for using (U) not (T) is to reduce signed/unsigned issues,
// as a is often a constant while b is the variable. it is still a bug, though.
template static inline T min (T a, U b) { return a < (T)b ? a : (T)b; }
template static inline T max (T a, U b) { return a > (T)b ? a : (T)b; }
template static inline T clamp (T v, U a, V b) { return v < (T)a ? (T)a : v >(T)b ? (T)b : v; }
template static inline void min_it (T &v, U m) { v = min (v, (T)m); }
template static inline void max_it (T &v, U m) { v = max (v, (T)m); }
template static inline void clamp_it (T &v, U a, V b) { v = clamp (v, (T)a, (T)b); }
template static inline void swap (T& a, U& b) { T t=a; a=(T)b; b=(U)t; }
template static inline T min (T a, U b, V c) { return min (a, min (b, c)); }
template static inline T max (T a, U b, V c) { return max (a, max (b, c)); }
// sign returns -1 or +1
template
static inline T sign (T v) { return v < 0 ? -1 : +1; }
// relies on 2c representation
template<>
inline sint8 sign (sint8 v) { return 1 - (sint8 (uint8 (v) >> 7) * 2); }
template<>
inline sint16 sign (sint16 v) { return 1 - (sint16 (uint16 (v) >> 15) * 2); }
template<>
inline sint32 sign (sint32 v) { return 1 - (sint32 (uint32 (v) >> 31) * 2); }
// sign0 returns -1, 0 or +1
template
static inline T sign0 (T v) { return v ? sign (v) : 0; }
//clashes with C++0x
template
static inline T copysign (T a, U b) { return a > 0 ? b : -b; }
// div* only work correctly for div > 0
// div, with correct rounding (< 0.5 downwards, >=0.5 upwards)
template static inline T div (T val, T div)
{
return expect_false (val < 0) ? - ((-val + (div - 1) / 2) / div) : (val + div / 2) / div;
}
template<> inline float div (float val, float div) { return val / div; }
template<> inline double div (double val, double div) { return val / div; }
// div, round-up
template static inline T div_ru (T val, T div)
{
return expect_false (val < 0) ? - ((-val ) / div) : (val + div - 1) / div;
}
// div, round-down
template static inline T div_rd (T val, T div)
{
return expect_false (val < 0) ? - ((-val + (div - 1) ) / div) : (val ) / div;
}
// lerp* only work correctly for min_in < max_in
// Linear intERPolate, scales val from min_in..max_in to min_out..max_out
template
static inline T
lerp (T val, T min_in, T max_in, T min_out, T max_out)
{
return min_out + div ((val - min_in) * (max_out - min_out), max_in - min_in);
}
// lerp, round-down
template
static inline T
lerp_rd (T val, T min_in, T max_in, T min_out, T max_out)
{
return min_out + div_rd ((val - min_in) * (max_out - min_out), max_in - min_in);
}
// lerp, round-up
template
static inline T
lerp_ru (T val, T min_in, T max_in, T min_out, T max_out)
{
return min_out + div_ru ((val - min_in) * (max_out - min_out), max_in - min_in);
}
// lots of stuff taken from FXT
/* Rotate right. This is used in various places for checksumming */
//TODO: that sucks, use a better checksum algo
static inline uint32_t
rotate_right (uint32_t c, uint32_t count = 1)
{
return (c << (32 - count)) | (c >> count);
}
static inline uint32_t
rotate_left (uint32_t c, uint32_t count = 1)
{
return (c >> (32 - count)) | (c << count);
}
// Return abs(a-b)
// Both a and b must not have the most significant bit set
static inline uint32_t
upos_abs_diff (uint32_t a, uint32_t b)
{
long d1 = b - a;
long d2 = (d1 & (d1 >> 31)) << 1;
return d1 - d2; // == (b - d) - (a + d);
}
// Both a and b must not have the most significant bit set
static inline uint32_t
upos_min (uint32_t a, uint32_t b)
{
int32_t d = b - a;
d &= d >> 31;
return a + d;
}
// Both a and b must not have the most significant bit set
static inline uint32_t
upos_max (uint32_t a, uint32_t b)
{
int32_t d = b - a;
d &= d >> 31;
return b - d;
}
// this is much faster than crossfire's original algorithm
// on modern cpus
inline int
isqrt (int n)
{
return (int)sqrtf ((float)n);
}
// this is kind of like the ^^ operator, if it would exist, without sequence point.
// more handy than it looks like, due to the implicit !! done on its arguments
inline bool
logical_xor (bool a, bool b)
{
return a != b;
}
inline bool
logical_implies (bool a, bool b)
{
return a <= b;
}
// this is only twice as fast as naive sqrtf (dx*dy+dy*dy)
#if 0
// and has a max. error of 6 in the range -100..+100.
#else
// and has a max. error of 9 in the range -100..+100.
#endif
inline int
idistance (int dx, int dy)
{
unsigned int dx_ = abs (dx);
unsigned int dy_ = abs (dy);
#if 0
return dx_ > dy_
? (dx_ * 61685 + dy_ * 26870) >> 16
: (dy_ * 61685 + dx_ * 26870) >> 16;
#else
return dx_ + dy_ - min (dx_, dy_) * 5 / 8;
#endif
}
// can be substantially faster than floor, if your value range allows for it
template
inline T
fastfloor (T x)
{
return std::floor (x);
}
inline float
fastfloor (float x)
{
return sint32(x) - (x < 0);
}
inline double
fastfloor (double x)
{
return sint64(x) - (x < 0);
}
/*
* absdir(int): Returns a number between 1 and 8, which represent
* the "absolute" direction of a number (it actually takes care of
* "overflow" in previous calculations of a direction).
*/
inline int
absdir (int d)
{
return ((d - 1) & 7) + 1;
}
// avoid ctz name because netbsd or freebsd spams it's namespace with it
#if GCC_VERSION(3,4)
static inline int least_significant_bit (uint32_t x)
{
return __builtin_ctz (x);
}
#else
int least_significant_bit (uint32_t x);
#endif
#define for_all_bits_sparse_32(mask, idxvar) \
for (uint32_t idxvar, mask_ = mask; \
mask_ && ((idxvar = least_significant_bit (mask_)), mask_ &= ~(1 << idxvar), 1);)
extern ssize_t slice_alloc; // statistics
void *salloc_ (int n) throw (std::bad_alloc);
void *salloc_ (int n, void *src) throw (std::bad_alloc);
// strictly the same as g_slice_alloc, but never returns 0
template
inline T *salloc (int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T)); }
// also copies src into the new area, like "memdup"
// if src is 0, clears the memory
template
inline T *salloc (int n, T *src) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), (void *)src); }
// clears the memory
template
inline T *salloc0(int n = 1) throw (std::bad_alloc) { return (T *)salloc_ (n * sizeof (T), 0); }
// for symmetry
template
inline void sfree (T *ptr, int n = 1) throw ()
{
if (expect_true (ptr))
{
slice_alloc -= n * sizeof (T);
if (DEBUG_POISON) memset (ptr, DEBUG_POISON, n * sizeof (T));
g_slice_free1 (n * sizeof (T), (void *)ptr);
}
}
// nulls the pointer
template
inline void sfree0 (T *&ptr, int n = 1) throw ()
{
sfree (ptr, n);
ptr = 0;
}
// makes dynamically allocated objects zero-initialised
struct zero_initialised
{
void *operator new (size_t s, void *p)
{
memset (p, 0, s);
return p;
}
void *operator new (size_t s)
{
return salloc0 (s);
}
void *operator new[] (size_t s)
{
return salloc0 (s);
}
void operator delete (void *p, size_t s)
{
sfree ((char *)p, s);
}
void operator delete[] (void *p, size_t s)
{
sfree ((char *)p, s);
}
};
// makes dynamically allocated objects zero-initialised
struct slice_allocated
{
void *operator new (size_t s, void *p)
{
return p;
}
void *operator new (size_t s)
{
return salloc (s);
}
void *operator new[] (size_t s)
{
return salloc (s);
}
void operator delete (void *p, size_t s)
{
sfree ((char *)p, s);
}
void operator delete[] (void *p, size_t s)
{
sfree ((char *)p, s);
}
};
// a STL-compatible allocator that uses g_slice
// boy, this is verbose
template
struct slice_allocator
{
typedef size_t size_type;
typedef ptrdiff_t difference_type;
typedef Tp *pointer;
typedef const Tp *const_pointer;
typedef Tp &reference;
typedef const Tp &const_reference;
typedef Tp value_type;
template
struct rebind
{
typedef slice_allocator other;
};
slice_allocator () throw () { }
slice_allocator (const slice_allocator &) throw () { }
template
slice_allocator (const slice_allocator &) throw () { }
~slice_allocator () { }
pointer address (reference x) const { return &x; }
const_pointer address (const_reference x) const { return &x; }
pointer allocate (size_type n, const_pointer = 0)
{
return salloc (n);
}
void deallocate (pointer p, size_type n)
{
sfree (p, n);
}
size_type max_size () const throw ()
{
return size_t (-1) / sizeof (Tp);
}
void construct (pointer p, const Tp &val)
{
::new (p) Tp (val);
}
void destroy (pointer p)
{
p->~Tp ();
}
};
// basically a memory area, but refcounted
struct refcnt_buf
{
char *data;
refcnt_buf (size_t size = 0);
refcnt_buf (void *data, size_t size);
refcnt_buf (const refcnt_buf &src)
{
data = src.data;
inc ();
}
~refcnt_buf ();
refcnt_buf &operator =(const refcnt_buf &src);
operator char *()
{
return data;
}
size_t size () const
{
return _size ();
}
protected:
enum {
overhead = sizeof (uint32_t) * 2
};
uint32_t &_size () const
{
return ((unsigned int *)data)[-2];
}
uint32_t &_refcnt () const
{
return ((unsigned int *)data)[-1];
}
void _alloc (uint32_t size)
{
data = ((char *)salloc (size + overhead)) + overhead;
_size () = size;
_refcnt () = 1;
}
void _dealloc ();
void inc ()
{
++_refcnt ();
}
void dec ()
{
if (!--_refcnt ())
_dealloc ();
}
};
INTERFACE_CLASS (attachable)
struct refcnt_base
{
typedef int refcnt_t;
mutable refcnt_t ACC (RW, refcnt);
MTH void refcnt_inc () const { ++refcnt; }
MTH void refcnt_dec () const { --refcnt; }
refcnt_base () : refcnt (0) { }
};
// to avoid branches with more advanced compilers
extern refcnt_base::refcnt_t refcnt_dummy;
template
struct refptr
{
// p if not null
refcnt_base::refcnt_t *refcnt_ref () { return p ? &p->refcnt : &refcnt_dummy; }
void refcnt_dec ()
{
if (!is_constant (p))
--*refcnt_ref ();
else if (p)
--p->refcnt;
}
void refcnt_inc ()
{
if (!is_constant (p))
++*refcnt_ref ();
else if (p)
++p->refcnt;
}
T *p;
refptr () : p(0) { }
refptr (const refptr &p) : p(p.p) { refcnt_inc (); }
refptr (T *p) : p(p) { refcnt_inc (); }
~refptr () { refcnt_dec (); }
const refptr &operator =(T *o)
{
// if decrementing ever destroys we need to reverse the order here
refcnt_dec ();
p = o;
refcnt_inc ();
return *this;
}
const refptr &operator =(const refptr &o)
{
*this = o.p;
return *this;
}
T &operator * () const { return *p; }
T *operator ->() const { return p; }
operator T *() const { return p; }
};
typedef refptr maptile_ptr;
typedef refptr