p6config.h

Go to the documentation of this file.

#ifndef ICONFIG_H__
#define ICONFIG_H__ 1

#include "p6i18n.h"


#ifdef  __cplusplus
namespace P6R {
extern "C" {
#endif

static const P6UINT32 MAX_IDENTIFER_SIZE = 4000;
static const P6UINT32 MAX_ENUM_BUF       = 4000*16; // MAX_IDENTIFER_SIZE*16 == 64K

typedef P6VOID (*CONFIG_NOTIFY_CHANGE)(P6INT32 eventCode,P6VOID* pContext );

typedef enum
{
  P6CONFIG_NOTIFY_NOOP     = 0x00,
  P6CONFIG_NOTIFY_FLUSH    = 0x01,
  P6CONFIG_NOTIFY_RELOAD   = 0x02,
  P6CONFIG_NOTIFY_CREATE   = 0x03,
  P6CONFIG_NOTIFY_SETVALUE = 0x04,
  P6CONFIG_NOTIFY_NEWVALUE = 0x05,
  P6CONFIG_NOTIFY_P6R      = 0x06
} P6CONFIG_NOTIFY_CODES;


#undef INTERFACE
#define INTERFACE p6IEnumConfigWSections
P6DECLAREIF_(p6IEnumConfigWSections,p6ICom)
{
   P6DECLAREICOM
   P6DECLCOMMETHOD(next)(P6THIS_  P6UINT32 cElements, const P6WCHAR** parElements, P6UINT32* pcReturned ) P6PURE;

   P6DECLCOMMETHOD(reset)(P6THIS) P6PURE;
};
#define IF_p6IEnumConfigWSections {0xf6c2f961,0x605a,0x4e33,{0x93,0x8b,0x20,0x85,0xa9,0xcb,0x3c,0xed}}


typedef struct
{
   const P6WCHAR* pName;
   const P6WCHAR* pValue;
} P6CONFIGWVALUE;


#undef INTERFACE
#define INTERFACE p6IEnumConfigWValues
P6DECLAREIF_(p6IEnumConfigWValues,p6ICom)
{
   P6DECLAREICOM
   P6DECLCOMMETHOD(next)(P6THIS_  P6UINT32 cElements, P6CONFIGWVALUE* parElements, P6UINT32* pcReturned ) P6PURE;

   P6DECLCOMMETHOD(reset)(P6THIS) P6PURE;
};
#define IF_p6IEnumConfigWValues {0x1faeacc1,0x1af2,0x4a3e,{0x80,0x47,0x5d,0x50,0xc0,0xe3,0x55,0xcf}}


#undef INTERFACE
#define INTERFACE p6IWConfigTokens
P6DECLAREIF_(p6IWConfigTokens,p6ICom)
{
   P6DECLAREICOM
   P6DECLCOMMETHOD(addToken)(P6THIS_  const P6WCHAR* pToken, const P6WCHAR* pValue ) P6PURE;
};

// {A6824833-8289-4b70-8DFC-5C5F7028419C}
#define IF_p6IWConfigTokens  {0xa6824833,0x8289,0x4b70,{0x8d,0xfc,0x5c,0x5f,0x70,0x28,0x41,0x9c}}


typedef P6UINT32 P6CONFIGFLAGS;
static const P6CONFIGFLAGS P6CONFIG_NOFLAGS  = 0x00000000;
static const P6CONFIGFLAGS P6CONFIG_READONLY = 0x00000001;

typedef P6UINT32 P6OPENFLAGS;
static const P6OPENFLAGS P6OPEN_NOFLAGS = 0x00000000;
static const P6OPENFLAGS P6OPEN_USENEW  = 0x00000001;
static const P6OPENFLAGS P6OPEN_USEOLD  = 0x00000002;


#undef INTERFACE
#define INTERFACE p6IWConfig
P6DECLAREIF_(p6IWConfig,p6ICom)
{
   P6DECLAREICOM
   P6DECLCOMMETHOD(initialize)(P6THIS_  P6CONFIGFLAGS flags, const P6CHAR* pLocale ) P6PURE;

   P6DECLCOMMETHOD(openConfigFile)(P6THIS_  P6OPENFLAGS fFlags, const P6WCHAR* pPathName ) P6PURE;

   P6DECLCOMMETHOD(createConfigFile)(P6THIS_  const P6WCHAR* pPathName, P6BOOL overWrite ) P6PURE;

   P6DECLCOMMETHOD(closeConfigFile)(P6THIS_  P6BOOL withDefaults ) P6PURE;

   P6DECLCOMMETHOD(flushConfigFile)(P6THIS_  const P6WCHAR* pAlternateName, P6BOOL withDefaults ) P6PURE;

   P6DECLCOMMETHOD(reloadConfigFile)(P6THIS) P6PURE;

   P6DECLCOMMETHOD(getConfigInt)(P6THIS_  const P6WCHAR* pSectionName, const P6WCHAR* pKeyName, P6INT32 defaultValue, P6INT32* pValue ) P6PURE;

   P6DECLCOMMETHOD(getConfigUInt)(P6THIS_  const P6WCHAR* pSectionName, const P6WCHAR* pKeyName, P6UINT32 defaultValue, P6UINT32* pValue ) P6PURE;

   P6DECLCOMMETHOD(getConfigDouble)(P6THIS_  const P6WCHAR* pSectionName, const P6WCHAR* pKeyName, P6FLOAT defaultValue, P6FLOAT* pValue ) P6PURE;

   P6DECLCOMMETHOD(getConfigString)(P6THIS_  const P6WCHAR* pSectionName,
                                 const P6WCHAR* pKeyName,
                                 const P6WCHAR* defaultValue,
                                 P6WCHAR*       pBuffer,
                                 P6UINT32       cBuffer,
                                 P6UINT32*      pWritten ) P6PURE;

   P6DECLCOMMETHOD(getConfigBool)(P6THIS_  const P6WCHAR* pSectionName, const P6WCHAR* pKeyName, P6BOOL defaultValue, P6BOOL* pValue ) P6PURE;

   P6DECLCOMMETHOD(getConfigSection)(P6THIS_  const P6WCHAR* pSectionName, P6WCHAR* pReturnBuf, P6UINT32 cBuffer, P6UINT32* pWritten ) P6PURE;

   P6DECLCOMMETHOD(setConfigInt)(P6THIS_  const P6WCHAR* pSectionName, const P6WCHAR* pKeyName, P6INT32 value ) P6PURE;

   P6DECLCOMMETHOD(setConfigUInt)(P6THIS_  const P6WCHAR* pSectionName, const P6WCHAR* pKeyName, P6UINT32 value ) P6PURE;

   P6DECLCOMMETHOD(setConfigDouble)(P6THIS_  const P6WCHAR* pSectionName, const P6WCHAR* pKeyName, P6FLOAT value ) P6PURE;

   P6DECLCOMMETHOD(setConfigString)(P6THIS_  const P6WCHAR* pSectionName, const P6WCHAR* pKeyName, const P6WCHAR* pValue ) P6PURE;

   P6DECLCOMMETHOD(setConfigStringList)(P6THIS_  const P6WCHAR* pSectionName, const P6WCHAR* pKeyName, const P6WCHAR* pstrValue ) P6PURE;


   P6DECLCOMMETHOD(setConfigBool)(P6THIS_  const P6WCHAR* pSectionName, const P6WCHAR* pKeyName, P6BOOL value ) P6PURE;

   P6DECLCOMMETHOD(deleteConfigItem)(P6THIS_  const P6WCHAR* pSectionName, const P6WCHAR* pKeyName ) P6PURE;

   P6DECLCOMMETHOD(deleteConfigSection)(P6THIS_  const P6WCHAR* pSectionName ) P6PURE;

   P6DECLCOMMETHOD(enableVersionStamp)(P6THIS_  P6BOOL enabled ) P6PURE;

   P6DECLCOMMETHOD(registerForNotify)(P6THIS_  P6CONFIG_NOTIFY_CODES regFor,
                           CONFIG_NOTIFY_CHANGE  pFn,
                           P6VOID*               pContext ) P6PURE;

   P6DECLCOMMETHOD(unregisterForNotify)(P6THIS_  P6CONFIG_NOTIFY_CODES regFor, CONFIG_NOTIFY_CHANGE pFn ) P6PURE;

   P6DECLCOMMETHOD(enumConfigSections)(P6THIS_  p6IEnumConfigWSections** ppEnum ) P6PURE;

   P6DECLCOMMETHOD(enumConfigValues)(P6THIS_  const P6WCHAR* pSectionName, p6IEnumConfigWValues** ppEnum ) P6PURE;

   P6DECLCOMMETHOD(enumConfigList)(P6THIS_  const P6WCHAR* pSectionName, const P6WCHAR* pKeyName, p6IEnumConfigWValues** ppEnum ) P6PURE;
};

// {9699FB6A-28EF-47f3-A659-1837A466F6A7}
#define IF_p6IWConfig  {0x9699fb6a,0x28ef,0x47f3,{0xa6,0x59,0x18,0x37,0xa4,0x66,0xf6,0xa7}}

// {104DEEBC-8510-4baa-A39E-4DDF8CDE58B2}
#define COMP_p6WConfig {0x104deebc,0x8510,0x4baa,{0xa3,0x9e,0x4d,0xdf,0x8c,0xde,0x58,0xb2}}

#define GLOBAL_CONFIG_INTERFACE  "P6R::p6IWConfig::ApplicationGlobalConfig\0"

#ifdef  __cplusplus
} /* extern "C" */
} // namespace
#endif



#endif