basic.h

Go to the documentation of this file.

/*
 * $Revision: 2320 $
 * 
 * last checkin:
 *   $Author: gutwenger $ 
 *   $Date: 2012-05-09 14:37:44 +0200 (Wed, 09 May 2012) $ 
 ***************************************************************/
 
#ifdef _MSC_VER
#pragma once
#endif

#ifndef OGDF_BASIC_H
#define OGDF_BASIC_H


//---------------------------------------------------------
// assertions
//---------------------------------------------------------

#ifdef OGDF_DEBUG
#include <assert.h>
#define OGDF_ASSERT(expr) assert(expr);
#define OGDF_ASSERT_IF(minLevel,expr) \
    if (int(ogdf::debugLevel) >= int(minLevel)) assert(expr); else ;
#define OGDF_SET_DEBUG_LEVEL(level) ogdf::debugLevel = level;

#else
#define OGDF_ASSERT(expr)
#define OGDF_ASSERT_IF(minLevel,expr)
#define OGDF_SET_DEBUG_LEVEL(level)
#endif


//---------------------------------------------------------
// macros for optimization
//---------------------------------------------------------

// Visual C++ compiler
#ifdef _MSC_VER

#define OGDF_LIKELY(x)    (x)
#define OGDF_UNLIKELY(x)  (x)

#ifdef OGDF_DEBUG
#define OGDF_NODEFAULT    default: assert(0);
#else
#define OGDF_NODEFAULT    default: __assume(0);
#endif

#define OGDF_DECL_ALIGN(b) __declspec(align(b))
#define OGDF_DECL_THREAD __declspec(thread)


// GNU gcc compiler (also Intel compiler)
#elif defined(__GNUC__)

//#define __STDC_LIMIT_MACROS
//#include <stdint.h>

#define OGDF_LIKELY(x)    __builtin_expect((x),1)
#define OGDF_UNLIKELY(x)  __builtin_expect((x),0)
#define OGDF_NODEFAULT    default: ;

#define OGDF_DECL_ALIGN(b) __attribute__ ((aligned(b)))
#define OGDF_DECL_THREAD __thread


// other compiler
#else
#define OGDF_LIKELY(x)    (x)
#define OGDF_UNLIKELY(x)  (x)
#define OGDF_NODEFAULT

#define OGDF_DECL_ALIGN(b)
#endif

#ifndef __SIZEOF_POINTER__
#ifdef _M_X64
#define __SIZEOF_POINTER__ 8
#else
#define __SIZEOF_POINTER__ 4
#endif
#endif


#if defined(__CYGWIN__) || defined(__APPLE__) || defined(__sparc__)
#define OGDF_NO_COMPILER_TLS
#elif defined(__GNUC__)
#if __GNUC__ < 4
#define OGDF_NO_COMPILER_TLS
#endif
#endif


//---------------------------------------------------------
// detection of the system
//---------------------------------------------------------

#if defined(unix) || defined(__unix__) || defined(__unix) || defined(_AIX) || defined(__APPLE__)
#define OGDF_SYSTEM_UNIX
#endif

#if defined(__WIN32__) || defined(_WIN32) || defined(__NT__)
#define OGDF_SYSTEM_WINDOWS
#endif

// Note: Apple OS X machines will be both OGDF_SYSTEM_UNIX and OGDF_SYSTEM_OSX
#if defined(__APPLE__)
#define OGDF_SYSTEM_OSX
#endif


#if defined(USE_COIN) || defined(OGDF_OWN_LPSOLVER)
#define OGDF_LP_SOLVER
#endif

#if defined(USE_COIN) && !defined(COIN_OSI_CPX) && !defined(COIN_OSI_SYM) && !defined(COIN_OSI_CLP)
#error "Compiler-flag USE_COIN requires an additional COIN_OSI_xxx-flag to choose the LP solver backend."
#endif


//---------------------------------------------------------
// macros for compiling OGDF as DLL
//---------------------------------------------------------

#ifdef OGDF_DLL

#ifdef OGDF_INSTALL
#define OGDF_EXPORT __declspec(dllexport)

#else
#define OGDF_EXPORT __declspec(dllimport)
#endif

#else
#define OGDF_EXPORT

#endif


//---------------------------------------------------------
// define data types with known size
//---------------------------------------------------------

#ifdef _MSC_VER

typedef unsigned __int8  __uint8;
typedef unsigned __int16 __uint16;
typedef unsigned __int32 __uint32;
typedef unsigned __int64 __uint64;

#else

typedef signed char        __int8;
typedef short              __int16;
typedef int                __int32;
typedef long long          __int64;
typedef unsigned char      __uint8;
typedef unsigned short     __uint16;
typedef unsigned int       __uint32;
typedef unsigned long long __uint64;
#endif


//---------------------------------------------------------
// common includes
//---------------------------------------------------------

#include <iostream>
#include <fstream>

using std::ios;
using std::istream;
using std::ifstream;
using std::ostream;
using std::ofstream;
using std::cin;
using std::cout;
using std::cerr;
using std::endl;
using std::flush;
using std::swap;

#include <stdio.h>
#include <stdarg.h>
#include <time.h>
#include <string.h>
#include <math.h>


#ifdef OGDF_SYSTEM_UNIX
#include <stdint.h>
#endif
// make sure that SIZE_MAX gets defined
#ifndef SIZE_MAX
#define SIZE_MAX ((size_t)-1)
#endif


#include <ogdf/basic/exceptions.h>
#include <ogdf/basic/memory.h>
#include <ogdf/basic/comparer.h>
    


//---------------------------------------------------------
// compiler adaptions
//---------------------------------------------------------

#ifdef _MSC_VER

// disable useless warnings
#pragma warning(disable:4250)
#pragma warning(disable:4290)
#pragma warning(disable:4291)
#pragma warning(disable:4355)

// missing dll-interface
#pragma warning(disable:4251)
#pragma warning(disable:4275)

#endif


namespace ogdf {

#ifndef OGDF_DLL

class Initialization {
    static int s_count;

public:
    Initialization();
    ~Initialization();
};

static Initialization s_ogdfInitializer;

#endif


//---------------------------------------------------------
// global basic functions
//---------------------------------------------------------

    // forward declarations
    template<class E> class List;
    class OGDF_EXPORT String;


    enum Direction { before, after };

#ifndef OGDF_NOMINMAX
#ifndef min

    template<class T>
    inline T min(const T& x, const T& y) { return (x<y) ? x : y; }
#endif

#ifndef max

    template<class T>
    inline T max(const T& x, const T& y) { return (x>y) ? x : y; }
#endif
#endif

    inline int randomNumber(int low, int high) {
#if RAND_MAX == 32767
        // We get only 15 random bits on some systems (Windows, Solaris)!
        int r1 = (rand() & ((1 << 16) - 1));
        int r2 = (rand() & ((1 << 16) - 1));
        int r = (r1 << 15) | r2;
#else
        int r = rand();
#endif
        return low + (r % (high-low+1));
    }

    inline double randomDouble(double low, double high) {
        double val = low +(rand()*(high-low))/RAND_MAX;
        OGDF_ASSERT(val >= low && val <= high);
        return val;
    }

    inline double randomDoubleNormal(double m, double sd)
    {
        double x1, x2, y1, w, rndVal;
    
        do {
            rndVal = randomDouble(0,1);
            x1 = 2.0 * rndVal - 1.0;
            rndVal = randomDouble(0,1);
            x2 = 2.0 * rndVal - 1.0;
            w = x1*x1 + x2*x2;
        } while (w >= 1.0);

        w = sqrt((-2.0 * log(w))/w) ;
        y1 = x1*w;

        return(m + y1*sd);
    }



    OGDF_EXPORT double usedTime(double& T);

    template<class E>inline bool doDestruction(const E *) { return true; }
    
    // specializations
    template<>inline bool doDestruction(const char *) { return false; }
    template<>inline bool doDestruction<int>(const int *) { return false; }
    template<>inline bool doDestruction<double>(const double *) { return false; }


    //---------------------------------------------------------
    // handling files and directories
    //---------------------------------------------------------

    enum FileType {
        ftEntry,     
        ftFile,      
        ftDirectory  
    };

    OGDF_EXPORT bool isFile(const char *fileName);

    OGDF_EXPORT bool isDirectory(const char *fileName);

    OGDF_EXPORT bool changeDir(const char *dirName);
    

    OGDF_EXPORT void getFiles(const char *dirName,
        List<String> &files,
        const char *pattern = "*");


    OGDF_EXPORT void getFilesAppend(const char *dirName,
        List<String> &files,
        const char *pattern = "*");



    OGDF_EXPORT void getSubdirs(const char *dirName,
        List<String> &subdirs,
        const char *pattern = "*");


    OGDF_EXPORT void getSubdirsAppend(const char *dirName,
        List<String> &subdirs,
        const char *pattern = "*");



    OGDF_EXPORT void getEntries(const char *dirName,
        List<String> &entries,
        const char *pattern = "*");


    OGDF_EXPORT void getEntriesAppend(const char *dirName,
        List<String> &entries,
        const char *pattern = "*");



    OGDF_EXPORT void getEntries(const char *dirName,
        FileType t,
        List<String> &entries,
        const char *pattern = "*");


    OGDF_EXPORT void getEntriesAppend(const char *dirName,
        FileType t,
        List<String> &entries,
        const char *pattern = "*");

    //---------------------------------------------------------
    // handling markup formatting
    //---------------------------------------------------------
    
    const char NEWLINE('\n');                   // newline character
    const char INDENTCHAR(' ');             // indent character
    const int INDENTSIZE(2);                    // indent size

#ifdef OGDF_DEBUG

    enum DebugLevel {
        dlMinimal, dlExtendedChecking, dlConsistencyChecks, dlHeavyChecks
    };
    extern DebugLevel debugLevel;
#endif



template<class E> class BucketFunc
{
public:
    virtual ~BucketFunc() { }

    virtual int getBucket(const E &x) = 0;
};



#if _MSC_VER >= 1400

inline int sprintf(char *buffer, size_t sizeOfBuffer, const char *format, ...)
{
    va_list args;
    va_start(args, format);

    return vsprintf_s(buffer, sizeOfBuffer, format, args);
}

inline int vsprintf(char *buffer, size_t sizeInBytes, const char *format, va_list argptr)
{
    return vsprintf_s(buffer, sizeInBytes, format, argptr);
}

inline int strcat(char *strDest, size_t sizeOfDest, const char *strSource)
{
    return (int)strcat_s(strDest, sizeOfDest, strSource);
}

inline int strcpy(char *strDest, size_t sizeOfDest, const char *strSource)
{
    return (int)strcpy_s(strDest, sizeOfDest, strSource);
}

inline int strncpy(char *strDest, size_t sizeOfDest, const char *strSource, size_t count)
{
    return (int)strncpy_s(strDest, sizeOfDest, strSource, count);
}

inline char *strtok(char *strToken, const char *strDelimit)
{
    //provide a persistent context pointer for strtok_s
    static char *context;
    return strtok_s(strToken, strDelimit, &context);
}

#define scanf scanf_s
#define fscanf fscanf_s
#define sscanf sscanf_s

inline FILE *fopen(const char *filename, const char *mode)
{
    FILE *stream;
    if(fopen_s(&stream, filename, mode)) stream = 0;
    return stream;
}

inline int localtime(struct tm *ptm, const time_t *timer)
{
    return (int)localtime_s(ptm,timer);
}

#else ///////////////////////////////////////////////////////////////////////////////

inline int sprintf(char *buffer, size_t, const char *format, ...)
{
    va_list args;
    va_start(args, format);

    return ::vsprintf(buffer, format, args);
}


inline int vsprintf(char *buffer, size_t, const char *format, va_list argptr)
{
    return ::vsprintf(buffer, format, argptr);
}


inline int strcat(char *strDest, size_t, const char *strSource)
{
    ::strcat(strDest, strSource);
    return 0;
}

inline int strcpy(char *strDest, size_t, const char *strSource)
{
    ::strcpy(strDest, strSource);
    return 0;
}

inline int strncpy(char *strDest, size_t, const char *strSource, size_t count)
{
    ::strncpy(strDest, strSource, count);
    return 0;
}

inline int localtime(struct tm *ptm, const time_t *timer)
{
    struct tm *newtime = ::localtime(timer);
    if(newtime) {
        *ptm = *newtime;
        return 0;
    }
    return 1; // indicates error
}

#endif

} // end namespace ogdf


#endif