//-----------------------------------------------------------------------

// Copyright 2011 Ciaran McHale.

//

// Permission is hereby granted, free of charge, to any person obtaining

// a copy of this software and associated documentation files (the

// "Software"), to deal in the Software without restriction, including

// without limitation the rights to use, copy, modify, merge, publish,

// distribute, sublicense, and/or sell copies of the Software, and to

// permit persons to whom the Software is furnished to do so, subject to

// the following conditions.

//

// The above copyright notice and this permission notice shall be

// included in all copies or substantial portions of the Software.

//

// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS

// BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN

// ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN

// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

// SOFTWARE.

//----------------------------------------------------------------------

#ifndef CONFIG4CPP_CONFIGURATION_IMPL_H_

#define CONFIG4CPP_CONFIGURATION_IMPL_H_

//--------

// #include's

//--------

#include <config4cpp/Configuration.h>

#include "ConfigScope.h"

#include "UidIdentifierProcessor.h"

namespace CONFIG4CPP_NAMESPACE {

//--------

// Forward class declarations.

//--------

class ConfigParser;

struct SpellingAndValue {

const char * spelling;

int val;

};

//--------

// Class ConfigurationImpl

//--------

class ConfigurationImpl : public Configuration

{

public:

//--------

// Constructor and destructor

//--------

ConfigurationImpl();

virtual ~ConfigurationImpl();

//--------

// Public operations

//--------

virtual void setFallbackConfiguration(Configuration * cfg);

virtual void setFallbackConfiguration(

Configuration::SourceType sourceType,

const char * source,

const char * sourceDescription = "")

throw(ConfigurationException);

virtual const Configuration * getFallbackConfiguration();

virtual void setSecurityConfiguration(

Configuration * cfg,

bool takeOwnership,

const char * scope = "")

throw (ConfigurationException);

virtual void setSecurityConfiguration(

const char * cfgInput,

const char * scope = "")

throw (ConfigurationException);

virtual void getSecurityConfiguration(

const Configuration *& cfg,

const char *& scope);

virtual void parse(

Configuration::SourceType sourceType,

const char * source,

const char * sourceDescription = "")

throw(ConfigurationException);

virtual const char * fileName() const;

virtual Type type(const char* scope, const char* localName) const;

virtual void listFullyScopedNames(

const char * scope,

const char * localName,

Type typeMask,

bool recursive,

StringVector & names) const

throw(ConfigurationException);

virtual void listFullyScopedNames(

const char * scope,

const char * localName,

Type typeMask,

bool recursive,

const char * filterPattern,

StringVector & names) const

throw(ConfigurationException);

virtual void listFullyScopedNames(

const char * scope,

const char * localName,

Type typeMask,

bool recursive,

const StringVector & filterPatterns,

StringVector & names) const

throw(ConfigurationException);

virtual void listLocallyScopedNames(

const char * scope,

const char * localName,

Type typeMask,

bool recursive,

StringVector & names) const

throw(ConfigurationException);

virtual void listLocallyScopedNames(

const char * scope,

const char * localName,

Type typeMask,

bool recursive,

const char * filterPattern,

StringVector & names) const

throw(ConfigurationException);

virtual void listLocallyScopedNames(

const char * scope,

const char * localName,

Type typeMask,

bool recursive,

const StringVector & filterPatterns,

StringVector & names) const

throw(ConfigurationException);

virtual bool uidEquals(const char * s1, const char * s2) const;

virtual void expandUid(StringBuffer & spelling)

throw(ConfigurationException);

virtual const char * unexpandUid(

const char * spelling,

StringBuffer & buf) const;

virtual void dump(

StringBuffer & buf,

bool wantExpandedUidNames) const;

virtual void dump(

StringBuffer & buf,

bool wantExpandedUidNames,

const char * scope,

const char * localName) const

throw(ConfigurationException);

virtual bool isBoolean(const char * str) const;

virtual bool isInt(const char * str) const;

virtual bool isFloat(const char * str) const;

virtual bool isDurationMicroseconds(const char * str) const;

virtual bool isDurationMilliseconds(const char * str) const;

virtual bool isDurationSeconds(const char * str) const;

virtual bool isMemorySizeBytes(const char * str) const;

virtual bool isMemorySizeKB(const char * str) const;

virtual bool isMemorySizeMB(const char * str) const;

virtual bool isEnum(

const char * str,

const EnumNameAndValue * enumInfo,

int numEnums) const;

virtual bool isFloatWithUnits(

const char * str,

const char ** allowedUnits,

int allowedUnitsSize) const;

virtual bool isIntWithUnits(

const char * str,

const char ** allowedUnits,

int allowedUnitsSize) const;

virtual bool isUnitsWithFloat(

const char * str,

const char ** allowedUnits,

int allowedUnitsSize) const;

virtual bool isUnitsWithInt(

const char * str,

const char ** allowedUnits,

int allowedUnitsSize) const;

virtual bool stringToBoolean(

const char * scope,

const char * localName,

const char * str) const

throw(ConfigurationException);

virtual int stringToInt(

const char * scope,

const char * localName,

const char * str) const

throw(ConfigurationException);

virtual float stringToFloat(

const char * scope,

const char * localName,

const char * str) const

throw(ConfigurationException);

virtual int stringToDurationSeconds(

const char * scope,

const char * localName,

const char * str) const

throw(ConfigurationException);

virtual int stringToDurationMicroseconds(

const char * scope,

const char * localName,

const char * str) const

throw(ConfigurationException);

virtual int stringToDurationMilliseconds(

const char * scope,

const char * localName,

const char * str) const

throw(ConfigurationException);

virtual int stringToMemorySizeBytes(

const char * scope,

const char * localName,

const char * str) const

throw(ConfigurationException);

virtual int stringToMemorySizeKB(

const char * scope,

const char * localName,

const char * str) const

throw(ConfigurationException);

virtual int stringToMemorySizeMB(

const char * scope,

const char * localName,

const char * str) const

throw(ConfigurationException);

virtual int stringToEnum(

const char * scope,

const char * localName,

const char * typeName,

const char * str,

const EnumNameAndValue * enumInfo,

int numEnums) const

throw(ConfigurationException);

virtual void stringToFloatWithUnits(

const char * scope,

const char * localName,

const char * typeName,

const char * str,

const char ** allowedUnits,

int allowedUnitsSize,

float & floatResult,

const char *& unitsResult) const

throw(ConfigurationException);

virtual void stringToUnitsWithFloat(

const char * scope,

const char * localName,

const char * typeName,

const char * str,

const char ** allowedUnits,

int allowedUnitsSize,

float & floatResult,

const char *& unitsResult) const

throw(ConfigurationException);

virtual void stringToIntWithUnits(

const char * scope,

const char * localName,

const char * typeName,

const char * str,

const char ** allowedUnits,

int allowedUnitsSize,

int & intResult,

const char *& unitsResult) const

throw(ConfigurationException);

virtual void stringToUnitsWithInt(

const char * scope,

const char * localName,

const char * typeName,

const char * str,

const char ** allowedUnits,

int allowedUnitsSize,

int & intResult,

const char *& unitsResult) const

throw(ConfigurationException);

virtual const char * lookupString(

const char * scope,

const char * localName,

const char * defaultVal) const

throw(ConfigurationException);

virtual const char * lookupString(

const char * scope,

const char * localName) const

throw(ConfigurationException);

virtual void lookupList(

const char * scope,

const char * localName,

const char **& array,

int & arraySize,

const char ** defaultArray,

int defaultArraySize) const

throw(ConfigurationException);

virtual void lookupList(

const char * scope,

const char * localName,

const char **& array,

int & arraySize) const

throw(ConfigurationException);

virtual void lookupList(

const char * scope,

const char * localName,

StringVector & list,

const StringVector & defaultList) const

throw(ConfigurationException);

virtual void lookupList(

const char * scope,

const char * localName,

StringVector & list) const

throw(ConfigurationException);

virtual int lookupInt(

const char * scope,

const char * localName,

int defaultVal) const

throw(ConfigurationException);

virtual int lookupInt(

const char * scope,

const char * localName) const

throw(ConfigurationException);

virtual float lookupFloat(

const char * scope,

const char * localName,

float defaultVal) const

throw(ConfigurationException);

virtual float lookupFloat(

const char * scope,

const char * localName) const

throw(ConfigurationException);

virtual int lookupEnum(

const char * scope,

const char * localName,

const char * typeName,

const EnumNameAndValue * enumInfo,

int numEnums,

const char * defaultVal) const

throw(ConfigurationException);

virtual int lookupEnum(

const char * scope,

const char * localName,

const char * typeName,

const EnumNameAndValue * enumInfo,

int numEnums,

int defaultVal) const

throw(ConfigurationException);

virtual int lookupEnum(

const char * scope,

const char * localName,

const char * typeName,

const EnumNameAndValue * enumInfo,

int numEnums) const

throw(ConfigurationException);

virtual bool lookupBoolean(

const char * scope,

const char * localName,

bool defaultVal) const

throw(ConfigurationException);

virtual bool lookupBoolean(

const char * scope,

const char * localName) const

throw(ConfigurationException);

virtual void lookupFloatWithUnits(

const char * scope,

const char * localName,

const char * typeName,

const char ** allowedUnits,

int allowedUnitsSize,

float & floatResult,

const char *& unitsResult) const

throw(ConfigurationException);

virtual void lookupFloatWithUnits(

const char * scope,

const char * localName,

const char * typeName,

const char ** allowedUnits,

int allowedUnitsSize,

float & floatResult,

const char *& unitsResult,

float defaultFloat,

const char * defaultUnits) const

throw(ConfigurationException);

virtual void lookupUnitsWithFloat(

const char * scope,

const char * localName,

const char * typeName,

const char ** allowedUnits,

int allowedUnitsSize,

float & floatResult,

const char *& unitsResult) const

throw(ConfigurationException);

virtual void lookupUnitsWithFloat(

const char * scope,

const char * localName,

const char * typeName,

const char ** allowedUnits,

int allowedUnitsSize,

float & floatResult,

const char *& unitsResult,

float defaultFloat,

const char * defaultUnits) const

throw(ConfigurationException);

virtual void lookupIntWithUnits(

const char * scope,

const char * localName,

const char * typeName,

const char ** allowedUnits,

int allowedUnitsSize,

int & intResult,

const char *& unitsResult) const

throw(ConfigurationException);

virtual void lookupIntWithUnits(

const char * scope,

const char * localName,

const char * typeName,

const char ** allowedUnits,

int allowedUnitsSize,

int & intResult,

const char *& unitsResult,

int defaultInt,

const char * defaultUnits) const

throw(ConfigurationException);

virtual void lookupUnitsWithInt(

const char * scope,

const char * localName,

const char * typeName,

const char ** allowedUnits,

int allowedUnitsSize,

int & intResult,

const char *& unitsResult) const

throw(ConfigurationException);

virtual void lookupUnitsWithInt(

const char * scope,

const char * localName,

const char * typeName,

const char ** allowedUnits,

int allowedUnitsSize,

int & intResult,

const char *& unitsResult,

int defaultInt,

const char * defaultUnits) const

throw(ConfigurationException);

virtual int lookupDurationMicroseconds(

const char * scope,

const char * localName,

int defaultVal) const

throw(ConfigurationException);

virtual int lookupDurationMicroseconds(

const char * scope,

const char * localName) const

throw(ConfigurationException);

virtual int lookupDurationMilliseconds(

const char * scope,

const char * localName,

int defaultVal) const

throw(ConfigurationException);

virtual int lookupDurationMilliseconds(

const char * scope,

const char * localName) const

throw(ConfigurationException);

virtual int lookupDurationSeconds(

const char * scope,

const char * localName,

int defaultVal) const

throw(ConfigurationException);

virtual int lookupDurationSeconds(

const char * scope,

const char * localName) const

throw(ConfigurationException);

virtual int lookupMemorySizeBytes(

const char * scope,

const char * localName,

int defaultVal) const

throw(ConfigurationException);

virtual int lookupMemorySizeBytes(

const char * scope,

const char * localName) const

throw(ConfigurationException);

virtual int lookupMemorySizeKB(

const char * scope,

const char * localName,

int defaultVal) const

throw(ConfigurationException);

virtual int lookupMemorySizeKB(

const char * scope,

const char * localName) const

throw(ConfigurationException);

virtual int lookupMemorySizeMB(

const char * scope,

const char * localName,

int defaultVal) const

throw(ConfigurationException);

virtual int lookupMemorySizeMB(

const char * scope,

const char * localName) const

throw(ConfigurationException);

virtual void lookupScope(

const char * scope,

const char * localName) const

throw(ConfigurationException);

//--------

// Update operations.

//--------

virtual void insertString(

const char * scope,

const char * localName,

const char * strValue)

throw(ConfigurationException);

virtual void insertList(

const char * scope,

const char * localName,

const char ** array,

int arraySize)

throw(ConfigurationException);

virtual void insertList(

const char * scope,

const char * localName,

const char ** nullTerminatedArray)

throw(ConfigurationException);

virtual void insertList(

const char * scope,

const char * localName,

const StringVector & vec)

throw(ConfigurationException);

virtual void ensureScopeExists(

const char * scope,

const char * localName)

throw(ConfigurationException);

virtual void remove(

const char * scope,

const char * localName)

throw(ConfigurationException);

virtual void empty();

protected:

friend class ConfigParser;

//--------

// Operations called by ConfigParser

//--------

virtual void insertList(

const char * name,

const StringVector & list)

throw(ConfigurationException);

inline ConfigScope * rootScope();

inline ConfigScope * getCurrScope();

inline void setCurrScope(ConfigScope * scope);

void ensureScopeExists(

const char * name,

ConfigScope *& scope)

throw(ConfigurationException);

void ensureScopeExists(

const StringVector & vec,

int firstIndex,

int lastIndex,

ConfigScope *& scope)

throw(ConfigurationException);

bool isExecAllowed(

const char * cmdLine,

StringBuffer & trustedCmdLine);

//--------

// Helper operations

//--------

ConfigItem * lookup(

const char * fullyScopedName,

const char * localName,

bool startInRoot = false) const;

ConfigItem * lookupHelper(

ConfigScope * scope,

const StringVector & vec) const;

void stringValue(

const char * fullyScopedName,

const char * localName,

const char *& str,

Type & type) const;

void listValue(

const char * fullyScopedName,

const char * localName,

StringVector & list,

Type & type) const;

void listValue(

const char * fullyScopedName,

const char * localName,

const char **& array,

int & arraySize,

Type & type) const;

virtual bool enumVal(

const char * description,

const EnumNameAndValue * enumInfo,

int numEnums,

int & val) const;

void pushIncludedFilename(const char * fileName);

void popIncludedFilename(const char * fileName);

void checkForCircularIncludes(

const char * fileName,

int includeLineNum)

throw (ConfigurationException);

int stringToMemorySizeGeneric(

const char * typeName,

SpellingAndValue unitsInfo[],

int unitsInfoSize,

const char * allowedSizes[],

const char * scope,

const char * localName,

const char * str) const

throw(ConfigurationException);

protected:

//--------

// Instance variables

//--------

UidIdentifierProcessor m_uidIdentifierProcessor;

Configuration * m_securityCfg;

StringBuffer m_securityCfgScope;

StringBuffer m_fileName;

ConfigScope * m_rootScope;

ConfigScope * m_currScope;

StringVector m_fileNameStack;

ConfigurationImpl * m_fallbackCfg;

bool m_amOwnerOfSecurityCfg;

bool m_amOwnerOfFallbackCfg;

private:

//--------

// The following are not implemented

//--------

ConfigurationImpl(const Configuration & ex);

ConfigurationImpl & operator=(const Configuration & ex);

};

//--------

// Implementation of inline operations

//--------

inline const char *

ConfigurationImpl::fileName() const

{

return m_fileName.c_str();

}

inline ConfigScope *

ConfigurationImpl::rootScope()

{

return m_rootScope;

}

inline ConfigScope *

ConfigurationImpl::getCurrScope()

{

return m_currScope;

}

inline void

ConfigurationImpl::setCurrScope(ConfigScope * scope)

{

m_currScope = scope;

}

}; // namespace CONFIG4CPP_NAMESPACE

#endif