uwe_datasource.h

/* uwe_datasource.h */
/* $Id: uwe_datasource.h,v 1.8 2008/04/21 08:45:56 vlad Exp $ */
#ifndef __uwe_datasource_h
#define __uwe_datasource_h

#include <mix/portability.h>
#include <mix/misc.h>
#include <mix/ErrCodes.h>

#ifdef __cplusplus
#include <mix/IniFile.hpp>
#endif /* C++ */


/* uds_list.ini definitions */
#define UDSLIST_DSName      "DSName"
#define UDSLIST_Mounted     "Mounted"
#define UDSLIST_Shown       "Shown"
#define UDSLIST_DrvName     "DriverName"
#define UDSLIST_DBLoc       "DataBaseLocation"
#define UDSLIST_AltDBLoc    "AltDBLocation"
#define WE_StartupMounted_ENV       UDSLIST_Mounted
#define WE_StartupShown_ENV     UDSLIST_Shown

/* Recognized values of driver name for different versions of LDB. */
#define UDSLIST_DrvLDB4Sign "univers_ldb_4."
#define UDSLIST_DrvLDB5Sign "univers_ldb_5."

/* Directory name for data, jobs, logs and locks location */
#define WE_DATA_DIR     "DATA"
#define WE_JOBS_DIR     "JOBS"
#define WE_LOGS_DIR     "LOG"
#define WE_LOCKS_DIR        "LOCKS"
#define WE_HCOPIES_DIR      "HCOPIES"
#define WE_REPORT_DIR       "REPORT"
#define WE_ARCHIVE_DIR      "ARCHIVE"



typedef struct
{
  char  *szDSName;  
  int   dbVersion;  
  Logic bMounted;   
  Logic bShown;     
  char  *szDBLoc;   
  char  *szAltDBLoc;    
  char  *szDrvName; 
  char  *szConnOptions; 
  char  *szDrvOptions;  
  int       nProjList;  
  STRLIST   lszProjList;    
}   UweDataSourceInfo;


typedef void*   UweDSHandle;



#ifdef __cplusplus
extern "C" {
#endif /* C++ */

  UNIVERS_API ErrCode CALLSPEC  UweLoadListOfDS (UweDSHandle* pHandle,
                         int* pDSNumber);

  UNIVERS_API ErrCode CALLSPEC  UweScanDSFirst (UweDSHandle pHandle,
                        UweDataSourceInfo* pInfo);

  UNIVERS_API ErrCode CALLSPEC  UweScanDSNext (UweDSHandle pHandle,
                           UweDataSourceInfo* pInfo);

  UNIVERS_API ErrCode CALLSPEC  UweFindProjectDS (UweDSHandle pHandle,
                          const char* szProject,
                          UweDataSourceInfo* pInfo);

  UNIVERS_API ErrCode CALLSPEC
  UweCreateProjectDS (const char* szProject,
              const UweDataSourceInfo* pInfo);

  UNIVERS_API void CALLSPEC UweReleaseListOfDS (UweDSHandle* pHandle);

  UNIVERS_API ErrCode CALLSPEC  UweGetDSInfo (UweDataSourceInfo* pDSInfo);


  UNIVERS_API ErrCode CALLSPEC  UweSetCurrentDS (const char* szDataSource);

  UNIVERS_API UweDataSourceInfo* CALLSPEC   UweGetCurrentDSInfo ();


  UNIVERS_API void CALLSPEC UweFreeDSInfo (UweDataSourceInfo* pInfo);


#define UDS_PROP_SHOWN      (1<<0)

  UNIVERS_API ErrCode CALLSPEC  UweChangeDSInfo (UweDSHandle pHandle,
                         const UweDataSourceInfo* pInfo,
                         int mProp);

  UNIVERS_API ErrCode CALLSPEC  UweSaveDSUserConfig (UweDSHandle pHandle);


#ifdef __cplusplus
};
#endif /* C++ */


#ifdef __cplusplus

typedef struct
{
  int       n_ds;       
  STRLIST   list_ds;    
  int       i_next_ds;  
  IniFile   *dsList;    
}   Uwe_DSHandle;


UNIVERS_API ErrCode CALLSPEC    UweAppendLDB5DS (IniFile* dsList);

UNIVERS_API ErrCode CALLSPEC    UweAppendLDB4DS (IniFile* dsList);

#endif /* C++ */



#endif /* uwe_datasource.h */