COMMON/global.h

Go to the documentation of this file.

// -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//

#ifndef BALL_COMMON_GLOBAL_H
#define BALL_COMMON_GLOBAL_H

#ifndef BALL_CONFIG_CONFIG_H
# include <BALL/CONFIG/config.h>
#endif

#include <limits>
#include <time.h>

#ifdef BALL_HAS_BASETSD_H
# include <basetsd.h>
#endif

// If possible use the ISO C99-compliant header stdint.h
// to define the portable integer types.
#ifdef BALL_HAS_STDINT_H
# include <stdint.h>
#endif

#ifdef BALL_COMPILER_MSVC
# define BALL_HIDE
# ifdef BALL_BUILD_DLL
#   define BALL_EXPORT __declspec(dllexport)
#   define BALL_EXTERN_VARIABLE __declspec(dllexport) extern
# else
#   define BALL_EXPORT __declspec(dllimport)
#   define BALL_EXTERN_VARIABLE __declspec(dllimport) extern
# endif
# ifdef BALL_VIEW_BUILD_DLL
#   define BALL_VIEW_EXPORT __declspec(dllexport)
# else
#   define BALL_VIEW_EXPORT __declspec(dllimport)
# endif
#elif defined(BALL_COMPILER_GXX) && (BALL_COMPILER_VERSION_MAJOR > 4 || (BALL_COMPILER_VERSION_MAJOR == 4 && BALL_COMPILER_VERSION_MINOR >= 3))
# define BALL_EXPORT __attribute__((visibility ("default")))
# define BALL_HIDE __attribute__((visibility ("hidden")))
# define BALL_VIEW_EXPORT __attribute__((visibility ("default")))
# define BALL_EXTERN_VARIABLE extern __attribute__((visibility ("default")))
# elif defined(BALL_COMPILER_LLVM)
# define BALL_EXPORT __attribute__((visibility ("default")))
# define BALL_HIDE __attribute__((visibility ("hidden")))
# define BALL_VIEW_EXPORT __attribute__((visibility ("default")))
# define BALL_EXTERN_VARIABLE extern __attribute__((visibility ("default")))
#else
# define BALL_EXPORT
# define BALL_HIDE
# define BALL_VIEW_EXPORT
# define BALL_EXTERN_VARIABLE extern
#endif

//This declares a BALL_DEPRECATED macro that can be used to mark deprecated api
//It is essentially copied from Qt 4.4.1 but simplified, thus there might be
//some cases where it does not work as expected, yet.
#if defined(BALL_COMPILER_MSVC) && (_MSC_VER >= 1300)
    #define BALL_DEPRECATED __declspec(deprecated)
#elif defined(BALL_COMPILER_GXX) && (BALL_COMPILER_VERSION_MAJOR - 0 > 3 || (BALL_COMPILER_VERSION_MAJOR - 0 == 3 && BALL_COMPILER_VERSION_MINOR - 0 >= 2))
    #define BALL_DEPRECATED __attribute__((deprecated))
#elif defined(BALL_COMPILER_LLVM)
    #define BALL_DEPRECATED __attribute__((deprecated))
#else
    #define BALL_DEPRECATED
#endif

namespace BALL
{

  typedef int (*ComparatorType)(const void *, const void *);


  typedef BALL_INDEX_TYPE Distance; 

  typedef BALL_SIZE_TYPE  Handle;

  typedef BALL_INDEX_TYPE Index;

  typedef BALL_SIZE_TYPE  Size;

  typedef time_t  Time;

  typedef BALL_SIZE_TYPE  HashIndex;

  typedef BALL_SIZE_TYPE  Position;

  typedef float Real;

  typedef double DoubleReal;

  typedef BALL_SIZE_TYPE Property;

  typedef BALL_INDEX_TYPE ErrorCode;


  typedef unsigned char Byte;

  typedef BALL_ULONG64_TYPE LongSize;

  typedef BALL_LONG64_TYPE LongIndex;

  typedef BALL_POINTERSIZEUINT_TYPE PointerSizeUInt;


  enum ASCII
  {
    ASCII__BACKSPACE        = '\b',
    ASCII__BELL             = '\a',
    ASCII__CARRIAGE_RETURN  = '\r',
    ASCII__HORIZONTAL_TAB   = '\t',
    ASCII__NEWLINE          = '\n',
    ASCII__RETURN           = ASCII__NEWLINE,
    ASCII__SPACE            = ' ',
    ASCII__TAB              = ASCII__HORIZONTAL_TAB,
    ASCII__VERTICAL_TAB     = '\v',

    ASCII__COLON            = ':',
    ASCII__COMMA            = ',',
    ASCII__EXCLAMATION_MARK = '!',
    ASCII__POINT            = '.',
    ASCII__QUESTION_MARK    = '?',
    ASCII__SEMICOLON        = ';'
  };

  static const Distance INVALID_DISTANCE = std::numeric_limits<Distance>::max();
  static const Distance DISTANCE_MIN = (std::numeric_limits<Distance>::min() + 1);
  static const Distance DISTANCE_MAX = std::numeric_limits<Distance>::max();

  static const Handle INVALID_HANDLE = std::numeric_limits<Handle>::max();
  static const Handle HANDLE_MIN = 0 ;
  static const Handle HANDLE_MAX = std::numeric_limits<Handle>::max() - 1;

  static const Index INVALID_INDEX = -1;
  static const Index INDEX_MIN = 0;
  static const Index INDEX_MAX = std::numeric_limits<Index>::max();

  static const Position INVALID_POSITION = std::numeric_limits<Position>::max();
  static const Position POSITION_MIN = 0;
  static const Position POSITION_MAX = std::numeric_limits<Position>::max() - 1;

# undef SIZE_MAX
  static const Size INVALID_SIZE = std::numeric_limits<Size>::max();
  static const Size SIZE_MIN = 0;
  static const Size SIZE_MAX = std::numeric_limits<Size>::max() - 1;


}

#endif // BALL_COMMON_GLOBAL_H