GloTypes.h

Go to the documentation of this file.

#ifndef INC_GLOTYPES_H
#define INC_GLOTYPES_H
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
#ifdef _MSC_VER
  /* 'Bezeichner': Klasse 'Typ' benötigt eine DLL-Schnittstelle, die von... */
  #pragma warning( disable : 4251 )
#endif
//-----------------------------------------------------------------------------
#include "GloErrors.h"
#include "EuDef_NULL_PTR.h"
#include "GloRecordAttributeTypes.h"
#include <stack>
#include <vector>
#include <string>
#include <climits>
//=============================================================================
// DLL-Export, -Import definitions
#if defined(_MSC_VER) || defined(__MINGW32__) || defined(__MINGW64__)
  #ifdef __GLO_EXPORT_DLL
    #define __glo_export_dll __declspec(dllexport)
    #if defined(_MSC_VER)
      #pragma message ( "Benutze Export defines fuer __glo_export_dll" )
    #endif
  #else
    #define __glo_export_dll  //__declspec(dllimport)
    #if defined(_MSC_VER)
      #pragma message ( "Benutze Import defines fuer __glo_export_dll" )
    #endif
  #endif
#elif defined(__GNUC__)
  #ifdef __GLO_EXPORT_DLL
    #define __glo_export_dll //__attribute__ ((visibility("default")))
  #else
    #define __glo_export_dll //__attribute__ ((visibility ("hidden")))
  #endif
#endif
//-----------------------------------------------------------------------------
namespace glo
{
  //===========================================================================
  /* Forwards */
  class CallBack;
  class ObjID;
  class BaseAllSet;
  //===========================================================================
  const char g_cIndexDelimiter = '|';
  //===========================================================================
  //const char g_cTableColumnDelimiter = '|';
  const char g_cTableColumnDelimiter = '\a';
  //===========================================================================
  #if defined ( _MSC_VER ) || defined ( __MINGW32__ ) || defined ( __MINGW64__ )
    const std::string g_sEOL = "\r\n";
  #elif defined ( __GNUC__ )
    const std::string g_sEOL = "\n";
  #endif
  //===========================================================================
 
  //===========================================================================
  enum EnSeekMode
  {
    //---------------------------------------------------------------------------
    START,
    //---------------------------------------------------------------------------
    END,
    //---------------------------------------------------------------------------
    CURRENT,
    //---------------------------------------------------------------------------
    NEXT,
    //---------------------------------------------------------------------------
    PREVIOUS
    //---------------------------------------------------------------------------
  };
  //===========================================================================
 
  //===========================================================================
  //-----------------------------------------------------------------------------
  // doxygen -> warning: unable to resolve reference to 'PAGE_GLO_REFERENCES' for \ref command
  // doxygen -> warning: unable to resolve reference to 'GLO_INTRODUCTION' for \ref command
  // Is a reference to the GlobalObjects documentation.
  //-----------------------------------------------------------------------------
  enum EnDeepMode 
  {
    //---------------------------------------------------------------------------
    DM_NONE = 0,
    //---------------------------------------------------------------------------
    DM_FLAT = 1,
    //---------------------------------------------------------------------------
    // doxygen -> warning: unable to resolve reference to 'GLO_REF_DEPENDENT' for \ref command
    // Is a reference to the GlobalObjects documentation.
    //---------------------------------------------------------------------------
    DM_SHALLOW = 2,
    //---------------------------------------------------------------------------
    DM_NOONDEMAND = 3,
    //---------------------------------------------------------------------------
    // doxygen -> warning: unable to resolve reference to 'GLO_REF_DEPENDENT' for \ref command
    // Is a reference to the GlobalObjects documentation.
    //---------------------------------------------------------------------------
    DM_DEEP = 4
    //---------------------------------------------------------------------------
  };
  //===========================================================================
 
  //===========================================================================
  //-----------------------------------------------------------------------------
  // doxygen -> warning: unable to resolve reference to 'PAGE_GLO_WATCH_NOTIFY' for \ref command
  // doxygen -> warning: unable to resolve reference to 'GLO_INTRODUCTION' for \ref command
  // doxygen -> warning: unable to resolve reference to 'GLO_REF_DEPENDENT' for \ref command
  // Is a reference to the GlobalObjects documentation.
  //-----------------------------------------------------------------------------
  typedef unsigned long TdWatchNotifyMode;
  //---------------------------------------------------------------------------
  const TdWatchNotifyMode WNM_NONE                    = 0;
  //---------------------------------------------------------------------------
  const TdWatchNotifyMode WNM_READ                    = 1;
  //---------------------------------------------------------------------------
  const TdWatchNotifyMode WNM_READ_TRANSACTION        = 2;
  //---------------------------------------------------------------------------
  const TdWatchNotifyMode WNM_WRITE                   = 4;
  //---------------------------------------------------------------------------
  const TdWatchNotifyMode WNM_WRITE_TRANSACTION       = 8;
  //---------------------------------------------------------------------------
  const TdWatchNotifyMode WNM_DELETE                  = 16;
  //---------------------------------------------------------------------------
  const TdWatchNotifyMode WNM_DELETE_TRANSACTION      = 32;
  //---------------------------------------------------------------------------
  const TdWatchNotifyMode WNM_LOCK                    = 64;
  //---------------------------------------------------------------------------
  const TdWatchNotifyMode WNM_UNLOCK                  = 128;
  //---------------------------------------------------------------------------
  const TdWatchNotifyMode WNM_INSERT                  = 256;
  //---------------------------------------------------------------------------
  const TdWatchNotifyMode WNM_INSERT_TRANSACTION      = 512;
  //---------------------------------------------------------------------------
  const TdWatchNotifyMode WNM_CLIENT_CONNECTSERVER    = 1024;
  //---------------------------------------------------------------------------
  const TdWatchNotifyMode WNM_CLIENT_DISCONNECTSERVER = 2048;
  //---------------------------------------------------------------------------
  const TdWatchNotifyMode WNM_CLIENT_OPENBASE         = 4096;
  //---------------------------------------------------------------------------
  const TdWatchNotifyMode WNM_CLIENT_CLOSEBASE        = 8192;
  //---------------------------------------------------------------------------
  const TdWatchNotifyMode WNM_INDEX_READ              = 16384;
  //---------------------------------------------------------------------------
  const TdWatchNotifyMode WNM_INDEX_WRITE             = 32768;
  //---------------------------------------------------------------------------
  const TdWatchNotifyMode WNM_INDEX_REINDEX           = 65536;
  //---------------------------------------------------------------------------
  const TdWatchNotifyMode WNM_DATABASE_COMPRESS       = 131072;
  //---------------------------------------------------------------------------
  const TdWatchNotifyMode WNM_DATABASE_REPAIR         = 262144;
  //---------------------------------------------------------------------------
  const TdWatchNotifyMode WNM_DATABASE_CHECK          = 524288;
  //---------------------------------------------------------------------------
  const TdWatchNotifyMode WNM_SERVER_WSAECONNRESET    = 1048576;
  //---------------------------------------------------------------------------
  //===========================================================================
 
  //===========================================================================
  //-----------------------------------------------------------------------------
  // doxygen -> warning: unable to resolve reference to 'GLO_SERVER_SL' for \ref command
  // doxygen -> warning: unable to resolve reference to 'PAGE_GLO_SERVER' for \ref command
  // Is a reference to the GlobalObjects documentation.
  //-----------------------------------------------------------------------------
  typedef unsigned long ShowLevel;
  //---------------------------------------------------------------------------
  const ShowLevel SHOW_NONE               =  0; 
  const ShowLevel SHOW_TCP                =  1; 
  const ShowLevel SHOW_READ_WRITE         =  2;
  const ShowLevel SHOW_ORDER_ACTION       =  4;
  const ShowLevel SHOW_REINDEX_ACTION     =  8;
  const ShowLevel SHOW_READINDEX_ACTION   = 16;
  const ShowLevel SHOW_WRITEINDEX_ACTION  = 32;
  const ShowLevel SHOW_COMPRESS_ACTION    = 64;
  const ShowLevel SHOW_CHECK_BASE_ACTION    = 128;
  const ShowLevel SHOW_REPAIR_BASE_ACTION    = 256;
  //===========================================================================
 
  //===========================================================================
  //---------------------------------------------------------------------------
  // doxygen -> warning: unable to resolve reference to 'PAGE_GLO_LOCKING' for \ref command
  // doxygen -> warning: unable to resolve reference to 'GLO_INTRODUCTION' for \ref command
  // Is a reference to the GlobalObjects documentation.
  //---------------------------------------------------------------------------
  // |==============================================================================|
  // |            Obj1              |                      Obj2                     |
  // |------------------------------------------------------------------------------|
  // |LOCK | Guarantee | Protection | Allowed LOCKs  | Possibilities | Restrictions |
  // |==============================================================================|
  // | NN  | none      | none       | all            | all           | none         |
  // | RD  | R         | D          | RD, RW, WW, TW | R, W          | D            |
  // | RW  | R         | D, W       | RD, RW         | R             | D, W         |
  // | WW  | R, W      | D, W       | RD             | R             | D, W         |
  // | DW  | R, W, D   | D, W       | none           | R             | D, W         |
  // | DR  | R, W, D   | D, W, R    | none           | none          | D, W, R      |
  // | EX  | R, W, D   | D, W, R    | none           | none          | D, W, R      |
  // | TW  | R, W      | D, W       | RD             | R             | D, W         |
  // | TD  | R, W, D   | D, W       | none           | R             | D, W         |
  // |==============================================================================|
 
  enum EnLockMode
  {
    LK_NONE = 0,
    LK_READvDELETE = 1,
    LK_READvWRITE = 2,
    LK_WRITEvWRITE = 3,
    LK_DELETEvWRITE = 4,
    LK_DELETEvREAD = 5,
    LK_EXCLUSIVE = 6,
    LK_TRANSACTION_WRITE = 7,
    LK_TRANSACTION_DELETE = 8
  };
  //===========================================================================
 
  //===========================================================================
  enum EnQueryType
  {
    eQUERY_DIRECT,
    eQUERY_OQL 
  };
  //===========================================================================
 
  //===========================================================================
  template <typename T> class Forgeter
  {
    public:
      void operator()(T * ptr )
      {
        ptr->forget();
      }
  };
  //===========================================================================
  
  //===========================================================================
  struct LockPossibleSpecification
  {
    public:
      //============== Attribute
      //-----------------------------------------------------------------------
      bool m_bRead;
      //-----------------------------------------------------------------------
      bool m_bWrite;
      //-----------------------------------------------------------------------
      bool m_bDelete;
      //-----------------------------------------------------------------------
 
      //============== Konstruktoren
      //-----------------------------------------------------------------------
      LockPossibleSpecification()
      : m_bRead(false),
        m_bWrite(false),
        m_bDelete(false)
      {};
      //-----------------------------------------------------------------------
      LockPossibleSpecification( unsigned long ulValue )
      : m_bRead(false),
        m_bWrite(false),
        m_bDelete(false)
      {
        this->set( ulValue );
      };
      //-----------------------------------------------------------------------
      virtual ~LockPossibleSpecification()
      {};
      //-----------------------------------------------------------------------
      LockPossibleSpecification( const LockPossibleSpecification & rT )
      : m_bRead( rT.m_bRead ),
      m_bWrite( rT.m_bWrite ),
      m_bDelete( rT.m_bDelete )
      {
      };
      //-----------------------------------------------------------------------
 
      //============== Methoden
      //-----------------------------------------------------------------------
      unsigned long getAsUL()
      {
        unsigned long    t_ulRetVal(0);
 
        if ( m_bRead ) t_ulRetVal |= 1;
        if ( m_bWrite ) t_ulRetVal |= 2;
        if ( m_bDelete ) t_ulRetVal |= 4;
        return t_ulRetVal;
      };
      //-----------------------------------------------------------------------
      void set( unsigned long ulValue )
      {
        m_bRead = false;
        m_bWrite = false;
        m_bDelete = false;
        if ( ulValue & 1 ) m_bRead = true;
        if ( ulValue & 2 ) m_bWrite = true;
        if ( ulValue & 4 ) m_bDelete = true;
      };
      //-----------------------------------------------------------------------
 
      //============== Operatoren
      //-----------------------------------------------------------------------
      inline LockPossibleSpecification & operator= ( const LockPossibleSpecification & rT )
      {
        if( this != & rT )
        {
          m_bRead = rT.m_bRead;
          m_bWrite = rT.m_bWrite;
          m_bDelete = rT.m_bDelete;
        }
        return *this;
      };
      //-----------------------------------------------------------------------
 
      inline bool operator== ( const LockPossibleSpecification & rT ) const
      {
        if  ( m_bRead == rT.m_bRead
              &&
              m_bWrite == rT.m_bWrite
              &&
              m_bDelete == rT.m_bDelete )
        {
          return true;
        }
        return false;
      };
      //-----------------------------------------------------------------------
      inline bool operator!= ( const LockPossibleSpecification & rT ) const
      {
        if ( *this == rT )
        {
          return false;
        }
        return true;
      };
      //-----------------------------------------------------------------------
  };
  //===========================================================================
 
  //===========================================================================
  struct OpenSpecification
  {
    public:
      //============== Attribute
      //-----------------------------------------------------------------------
      unsigned long m_ulVersion;
      //-----------------------------------------------------------------------
  };
  //===========================================================================
 
  //===========================================================================
  struct DependentObjsWithDeepMode
  {
    public:
      //============== Attribute
      //-----------------------------------------------------------------------
      std::stack< ObjID > * m_pDependObjIdStack;
      //-----------------------------------------------------------------------
      EnDeepMode m_eDeepMode;
      //-----------------------------------------------------------------------
  };
  //===========================================================================
 
 
  //===========================================================================
  enum EnComparisionOp
  {
    EQUAL,
    GREATER,
    GREATER_EQUAL,
    LESS,
    LESS_EQUAL,
    NOT_EQUAL
  };
  //===========================================================================
} // namespace glo
//-----------------------------------------------------------------------------
#ifdef _MSC_VER
  /* 'Bezeichner': Klasse 'Typ' benötigt eine DLL-Schnittstelle, die von... */
  #pragma warning( default : 4251 )
#endif
//-----------------------------------------------------------------------------
#endif