dbnamedefs.h

/* dbnamedefs.h
   started from Id: dbname.h,v 1.16 2003/02/14 16:20:08 vlad Exp */
/* $Id: dbnamedefs.h,v 1.1 2006/02/01 15:54:43 ibadm Exp $ */
#ifndef __dbnamedefs_h
#define __dbnamedefs_h


#ifdef __cplusplus
extern "C" {
#endif

#include <mix/Types.h>
#include <mix/General.h>
#include <ldb/dbdefs.h>


/*
 * Compatibility with LDB v<4
 */

/* Main data types, used in dbtc API */
#define TV_INT      INT_4
#define TV_LONG     INT_8
#define TV_FLOAT    REAL_8
#define TV_CHAR     CHAR_1
#define TV_DBPTR    DBTPTR
#define TV_NO_TYPE  __NO_TYPE__

/* Lengths */
#define DB_DMAX     DB_IDENT_LEN
#define DB_TMAX     DB_IDENT_LEN
#define DB_UMAX     8


/*
 * Maximum length of pointed fields of name
 */
#define DB_PREFIX_LEN           3
#define DB_TABLE_LEN            DB_IDENT_LEN
#define DB_WELL_LEN         DB_IDENT_LEN
#define DB_SP_LEN           4
#define DB_SP_VAL           9999
#define DB_MOD_LEN          4
#define DB_MOD_VAL          9999
#define DB_FILE_NAME_LEN        (DB_PREFIX_LEN + 1 + \
                     DB_WELL_LEN + 1 + \
                     DB_SP_LEN + 1 + \
                     DB_TABLE_LEN + 1 + \
                     DB_MOD_LEN)
/* DB_FILE_NAME_LEN + 1 == DBTPTR_LEN --> see mix/Types.h */

#define szDBprefix          "VSP"
#define szDBseparator           "."
#define cDBseparator            '.'


typedef struct
{
  int   mask;   
  char  table[DB_TABLE_LEN+1];  
  char  well[DB_WELL_LEN+1];    
  int   sp;         
  int   mod;            
}   dbNameStruct;


typedef struct
{
  dbNameStruct  list;   /* db name of root table */
  int       line;   /* non-negative index of line in list;
               -1 means "new line" in the list */
}   dbItem;


#define DB_NEW_ITEM     (-1)



typedef struct
{
  dbNameStruct  name;
  char      project[PROJECT_LEN+1];

}   dbPointer;


/*************************************************************
 * Flags and error codes
 *************************************************************/

/* Part of structured file name of data base */
#define DB_TABLE    (1<<0)  
#define DB_WELL     (1<<1)  
#define DB_SP       (1<<2)  
#define DB_MOD      (1<<3)  
#define DB_LIST     (1<<4)  
#define DB_PARSE_ERROR  (1<<5)

/* Typical masks */
#define DBM_LIST    (DB_LIST|DB_TABLE)
#define DBM_WELL    (DB_TABLE|DB_WELL|DB_MOD)
#define DBM_WELL_SP (DB_TABLE|DB_WELL|DB_SP|DB_MOD)
#define DBM_ALL     (DB_LIST|DB_TABLE|DB_WELL|DB_SP|DB_MOD)

/* Flags extraction from mask */
#define IsDBmod(x)      (!!((x)&DB_MOD))
#define IsDBsp(x)       (!!((x)&DB_SP))
#define IsDBwell(x)     (!!((x)&DB_WELL))
#define IsDBtable(x)        (!!((x)&DB_TABLE))
#define IsDBlist(x)     (!!((x)&DB_LIST))
#define IsDBparseError(x)   (!!((x)&DB_PARSE_ERROR))
#define IsDBempty(x)        (!!((x)&DBM_WELL_SP))


typedef enum
{
  DbMemory = 0,     
  DbReadOnlyFile,   
  DbReadWriteFile,  
  DbCreateFile,     
  DbAccessMask = 0x0f,  
  DbNoLock = (1 << 4),      
  DbNoHistory = (1 << 5),   
  DbSmallPreread = (1 << 6),    
  DbReadAtOnce = (1 << 7)   
}   DbAccess;

#define DbAccessMode(x)     ((DbAccess)((x)&DbAccessMask))

#define DbAccessFlags(x)    ((DbAccess)((x)&~DbAccessMask))

#define DbAccessMix(m,f)    ((DbAccess)(DbAccessMode(m)|(f)))



/*************************************************************
 *
 *              Operations on dbNameStruct
 *
 *************************************************************/

int dbParseFileName (const char* szFileName,
             dbNameStruct* dbNS);

char*   dbBuildFileName (const dbNameStruct* dbNS,
             char szFileName[DB_FILE_NAME_LEN+1]);

void    dbCopyByMask (dbNameStruct* dbDst,
              const dbNameStruct* dbSrc,
              int mask);

void    dbNameCopy (dbNameStruct* dbDst, const dbNameStruct* dbSrc);


Compar  dbNameCompare (const dbNameStruct* dbns1,
               const dbNameStruct* dbns2);


#ifdef __cplusplus
};
#endif


#endif /* dbnamedefs.h */