generic_configuration_interface.h

#ifndef SDK_BASE_CONFIGURATION_INTERFACE_H_
#define SDK_BASE_CONFIGURATION_INTERFACE_H_
 
#include <base/inc/base_types.h>
#include <base/inc/sdk_ref_ptr.h>
#include <base/inc/sdk_component_interface.h>
 
namespace sdk {
namespace base {
 
FWD_DECL_INTERFACE(ISDKConfiguration);
FWD_DECL_INTERFACE(ISDKConfigurationEnumerator);
FWD_DECL_INTERFACE(ISDKConfigEntriesEnumerator);
FWD_DECL_INTERFACE(ISDKConfigEntryParser);
typedef SDKRefPtr<ISDKConfiguration> SDKConfigurationSP;
typedef SDKRefPtr<ISDKConfigurationEnumerator> SDKConfigurationEnumeratorSP;
typedef SDKRefPtr<ISDKConfigEntriesEnumerator> SDKConfigEntriesEnumeratorSP;
typedef SDKRefPtr<ISDKConfigEntryParser> SDKConfigEntryParserSP;
 
static const wchar_t* kConfigProperty_EntryParser = L"entry_parser";
 
class ISDKConfiguration : public ISDKComponent
{
 public:
  virtual SDKResult SDK_CALLTYPE GetSubConfig(const SDKString& path, 
    SDKConfigurationSP& config) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE AddSubConfig(const SDKString& path, 
    SDKConfigurationSP& config) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE DeleteSubConfig(const SDKString& path) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE EnumSubConfigs(
    SDKConfigurationEnumeratorSP& configs) throw() = 0;
  
  virtual SDKResult SDK_CALLTYPE GetConfigEntry(const SDKString& name,
    SDKAny& value) throw() = 0;
  virtual SDKResult SDK_CALLTYPE SetConfigEntry(const SDKString& name,
    const SDKAny& value) throw() = 0;
  virtual SDKResult SDK_CALLTYPE AddConfigEntry(const SDKString& name,
    const SDKAny& value) throw() = 0;
  virtual SDKResult SDK_CALLTYPE DeleteConfigEntry(
    const SDKString& name) throw() = 0;
  virtual SDKResult SDK_CALLTYPE EnumConfigEntries(
    SDKConfigEntriesEnumeratorSP& entries) throw() = 0;
  virtual SDKResult SDK_CALLTYPE Flush() throw() = 0;
 
  SDK_IMPLEMENT_IID(ISDKConfiguration)
  SDK_END_INTERFACE(ISDKConfiguration)
};
SDK_DECLARE_IID(ISDKConfiguration)
 
class ISDKConfigurationEnumerator : public ISDKComponent
{
public:
  virtual SDKResult SDK_CALLTYPE Reset() throw() = 0;
  virtual SDKResult SDK_CALLTYPE Next(SDKString& name, 
    SDKConfigurationSP& config) throw() = 0;
 
  SDK_IMPLEMENT_IID(ISDKConfigurationEnumerator)
  SDK_END_INTERFACE(ISDKConfigurationEnumerator)
};
SDK_DECLARE_IID(ISDKConfigurationEnumerator)
 
class ISDKConfigEntriesEnumerator : public ISDKComponent
{
public:
  virtual SDKResult SDK_CALLTYPE Reset() throw() = 0;
  virtual SDKResult SDK_CALLTYPE Next(SDKString& name, SDKAny& value) throw() = 0;
 
  SDK_IMPLEMENT_IID(ISDKConfigEntriesEnumerator)
  SDK_END_INTERFACE(ISDKConfigEntriesEnumerator)
};
SDK_DECLARE_IID(ISDKConfigEntriesEnumerator)
 
/* \internal */
 
class ISDKConfigEntryParser : public ISDKComponent
{
public:
  virtual SDKResult SDK_CALLTYPE GetName(SDKString& name) throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetType(SDKString& type) throw() = 0;
  virtual SDKResult SDK_CALLTYPE Parse(const SDKString& value_str, 
    SDKAny& value) throw() = 0;
 
  SDK_IMPLEMENT_IID(ISDKConfigEntryParser)
  SDK_END_INTERFACE(ISDKConfigEntryParser)
};
SDK_DECLARE_IID(ISDKConfigEntryParser)
 
/* \endinternal */
 
} // namespace base
} // namespace sdk 
 
#endif // SDK_BASE_CONFIGURATION_INTERFACE_H_