/ray/src/lib/sconfig.h

Go to the documentation of this file.

/*
 * lib/sconfig.h
 * 
 * Standard / shared basic config include for all lib/ files. 
 * 
 * Copyright (c) 2004 by Wolfgang Wieser ] wwieser (a) gmx <*> de [ 
 * 
 * This file may be distributed and/or modified under the terms of the 
 * GNU General Public License version 2 as published by the Free Software 
 * Foundation. (See COPYING.GPL for details.)
 * 
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 * 
 */

#ifndef _LIB_SCONFIG_H_
#define _LIB_SCONFIG_H_ 1

/*
 * NOTE about #if and defined(): 
 * (This holds at least for gcc-3.4)
 * 
 * In case a symbol is NOT defined at all, then: 
 *   #if SYMBOL      will NOT be compiled
 *   #ifdef SYMBOL   will NOT be compiled
 *   #if !SYMBOL     WILL be compiled
 * 
 * In case a symbol is defined and empty (i.e. #define SYMBOL), then: 
 *   #if SYMBOL      is an error (#if with no expression)
 *   #ifdef SYMBOL   WILL be compiled
 *   #if !SYMBOL     is an error (operator '!' has no right operand)
 * 
 * In case a symbol is defined as 1 (i.e. #define SYMBOL 1), then: 
 *   #if SYMBOL      WILL be compiled
 *   #ifdef SYMBOL   WILL be compiled
 *   #if !SYMBOL     will NOT be compiled
 * 
 * In case a symbol is defined as 0 (i.e. #define SYMBOL 1), then: 
 *   #if SYMBOL      will NOT be compiled
 *   #ifdef SYMBOL   WILL be compiled
 *   #if !SYMBOL     WILL be compiled
 * 
 * NOTE also that identifiers are not compared as one may expect: 
 * #define SYMBOL foo
 *   #if SYMBOL == bar         WILL be compiled (although foo!=bar)
 *   #if SYMBOL != bar         will NOT compiled (although foo!=bar)
 *   #if SYMBOL                will NOT compiled
 *   #if !SYMBOL               WILL be compiled
 * 
 * HENCE, since configure will not define HAVE_XXX if we do not have it 
 *        and WILL define it to 1 if we DO have it, the following DOES 
 *        work: 
 *          #if HAVE_XXX        -> we have it
 *          #if !HAVE_XXX       -> we do not have it
 *        ...and note that this still works when we define HAVE_XXX to 0 
 *        in case we do NOT "have" it. AND it even works correctly when 
 *        we use && and || in the expression. 
 * 
 */

/*#warning (------- Reading sconfig.h -------)*/

/* THIS HERE... are the first lines of any source code file in hlib 
 * seen by the compiler. So this is the right place to make some 
 * important definitions. 
 */
#if /*defined(__GNUC__) &&*/ !defined(_GNU_SOURCE)
# define _GNU_SOURCE
#endif

/* This is (probably) needed on some systems. */
#ifndef _REENTRANT
# define _REENTRANT
#endif

/* NOTE: We do not rely on defined(__GNUC__) any more as nowadays the Intel 
 * compiler defines __GNUC__ as well. */

#if !defined(__cplusplus) && \
  (defined(__CPLUSPLUS) || defined(c_plusplus) || defined(C_PLUSPLUS))
#define __cplusplus 1
#endif

/*** FIRST, INCLUDE GLIB CONFIGURATION ***/

#include <glibconfig.h>
//#include "../3rdparty/glib/glibconfig.h"
/* For win32, also include some extra config: */
#if defined(G_OS_WIN32)
# include "config-w32.h"
#endif

/* Include config header as generated by configure: */
#if HAVE_CONFIG_H
# include <config.h>
#endif

/* Need NULL, etc. */
/* This is copied from autoconf manual and meant 
 * to save a lot of trouble... */
#if STDC_HEADERS
# include <stdlib.h>
# include <stddef.h>
#else
# if HAVE_STDLIB_H
#  include <stdlib.h>
# endif
#endif
#if HAVE_STRING_H
# if !STDC_HEADERS && HAVE_MEMORY_H
#  include <memory.h>
# endif
# include <string.h>
#endif
#if HAVE_STRINGS_H
# include <strings.h>
#endif
#if HAVE_INTTYPES_H
# include <inttypes.h>
#else
# if HAVE_STDINT_H
#  include <stdint.h>
# endif
#endif

/*** ALL INCLUDES DONE. ***/

#ifndef G_THREADS_ENABLED
# error "You need to enable threads in glib."
#endif

#ifndef USE_PRIVATE__PTHREADS
# ifdef G_THREADS_IMPL_POSIX
  /* Good, we're using the posix threads. So we can use or own native 
   * version which should be somewhat faster since it gets all inlined :) */
#  define USE_PRIVATE__PTHREADS 1
# else
#  define USE_PRIVATE__PTHREADS 0
# endif
#endif

/* See if we use Posix semaphores or if we emulate them using a mutex. */
#ifndef USE_PRIVATE__POSIX_SEMAPHORES
# if USE_PRIVATE__PTHREADS && HAVE_SEMAPHORE_H
#  define USE_PRIVATE__POSIX_SEMAPHORES 1
# else
#  define USE_PRIVATE__POSIX_SEMAPHORES 0
# endif
#endif

/* See if we use private atomic implementation. */
#ifndef USE_PRIVATE__ATOMIC
# if HAVE_ASM_ATOMIC_H || HAVE_ATOMIC_H
#  define USE_PRIVATE__ATOMIC 1
# else
#  define USE_PRIVATE__ATOMIC 0
# endif
#endif

/* See if we use private gettimeofday implementation. */
// NOTE...
#ifndef USE_PRIVATE__TIMEVAL
# if HAVE_GETTIMEOFDAY
#  define USE_PRIVATE__TIMEVAL 1
#else
#  define USE_PRIVATE__TIMEVAL 0
# endif
#endif


typedef unsigned char uchar;

typedef unsigned int uint;    // one word on the system

typedef unsigned char uint8;  // 1 byte

typedef signed char int8;  // 1 byte

typedef guint16 uint16;     // 2 bytes

typedef gint16 int16;     // 2 bytes

typedef guint32 uint32;     // 4 bytes

typedef gint32 int32;     // 4 bytes

typedef guint64 uint64;     // 8 bytes

typedef gint64 int64;     // 8 bytes


typedef int64 filepos_t;

typedef double dbl;

typedef float flt;


#if !HAVE_SSIZE_T
typedef signed int ssize_t;
#endif

#if HAVE_ATTRIBUTE_ALWAYS_INLINE
# ifdef __OPTIMIZE__
#  define inline inline __attribute__((always_inline))
# endif
#endif

#if HAVE_ATTRIBUTE_NOINLINE
# define _noinline_  __attribute__((noinline))
#endif

/* USAGE: void _constfn_ _deprecated_ _pure_ ... function() { ... } */

#if HAVE_ATTRIBUTE_CONST
# define _constfn_  __attribute__((__const__))
/*# warning "Attribute const present."*/
#else
# define _constfn_
/*# warning "Attribute const missing."*/
#endif

#if HAVE_ATTRIBUTE_PURE
# define _purefn_  __attribute__((pure))
#else
# define _purefn_
#endif

#if HAVE_ATTRIBUTE_DEPRECATED
# define _deprecated_  __attribute__((deprecated))
#else
# define _deprecated_
#endif

/* USAGE: class _packed_ X {}; */
#if HAVE_ATTRIBUTE_PACKED
# define _packed_ __attribute__((__packed__))
#else
# define _packed_
#endif

/* USAGE: A::sprintf(const char *fmt,...) _fnformat_(__printf__,2,3); */
#if HAVE_ATTRIBUTE_FORMAT
# define _fnformat_(A,B,C) __attribute__((__format__ (A, B, C)))
#else
# define _fnformat_(A,B,C)
#endif

/* USAGE: int _unused_ rv; */
#if HAVE_ATTRIBUTE_UNUSED
# define _unused_ __attribute__((__unused__))
#else
# define _unused_
#endif


#if HAVE_FIELD_COLON_VALUE_INIT
// This is the way g++ supports it. ISO C99 way (ala .x=) is yet missing in 
// the C++ frontend while the C frontend has it. 
#  define INIT_FIELD(x)  x:
#else
// 
#  define INIT_FIELD(x) .x=
#endif

/* Finally, the static const member issue... */
#if HAVE_STATIC_CONST_FP_MEMB
#  define USE_STATIC_CONST_FP_MEMB 1
#else
#  define USE_STATIC_CONST_FP_MEMB 0
#endif

#ifndef DOXYGEN_IS_SCANNING
/* These are useful for conditions which are (un)likely to happen, e.g. 
 *   if(unlikely(ptr==NULL))
 * This is actually taken from Linux kernel code. */
#if HAVE_BUILTIN_EXPECT
# define likely(x)    __builtin_expect(!!(x), 1)
# define unlikely(x)  __builtin_expect(!!(x), 0)
#else
/*#warning "Do not have likely/unlikely."*/
# define likely(x)    (x)
# define unlikely(x)  (x)
#endif
#else  /* !defined(DOXYGEN_IS_SCANNING) */

#error "We may not be here!"

#define likely(x)

#define unlikely(x)

#endif  /* DOXYGEN_IS_SCANNING */


/* Do some tweaks for doxygen: */
#if defined(DOXYGEN_IS_SCANNING)
# error "You may not compile with DOXYGEN_IS_SCANNING enabled."
/*# undef _fnformat_
#   define _fnformat_
# undef _packed_
#   define _packed_
# undef _deprecated_
#   define _deprecated_
# undef _purefn_
#   define _purefn_
# undef _constfn_
#   define _constfn_
# undef _noinline_
#   define _noinline_*/
#endif


#include <assert.h>

#define Assert(X)    do { if(!likely(X)) assert(X); } while(0)

#define CritAssert(X)   do { if(!likely(X)) assert(X); } while(0)


#ifndef LMALLOC_DEBUGGING
#define LMALLOC_DEBUGGING 1     /* Currently defaults to 1. */
#endif

#ifndef USE_MALLOC_USABLE_SIZE
# define USE_MALLOC_USABLE_SIZE HAVE_MALLOC_USABLE_SIZE
#endif

/* We MUST include this to provide the correct operator new/delete. */
#include <lib/salloc.h>

#endif  /* _LIB_SCONFIG_H_ */

---