AaronCameron.net

I care not for your petty politics.

• 
• 
• 
• 
• 

Not a Member? - Login or Create an Account

Tuesday the 7th of February 2012 @ 05:59pm

Front Page Journal Projects Your Profile About

LibN2L N2L Home Older News Downloads Documentation (n2l5) Class Hierarchy Compound List File List n2l:: Members Functions Whole n2l:: Ref Documentation (libN2L-4) Class Hierarchy Compound List File List n2l:: Members Functions Whole n2l:: Ref Bugtracker Project Page Report a Bug Bug List Related Things Life 2130 Devel Game Journal

LibN2L-4 Library Code Reference Classes Compounds Files Members Method Index Full Reference cConfigurationTemplate.cpp Go to the documentation of this file. /************************************************************************ Nova-2 Library (libN2L, or simply n2l) Game development C++ Library Copyright (C) 2003 Aaron Cameron This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA A copy of the GNU Lesser General Public License has been provided with this library in the file 'COPYING'. Contact information for the author of this library has been provided with this library in the file 'AUTHOR'. ************************************************************************/ #include "cConfigurationTemplate.h" #include "cConfParsingErrors.h" #include "cConfParsingError.h" #include "cConfFailedValidationException.h" namespace n2l { /* ************************************************************ */ cConfigurationTemplate::cConfigurationTemplate() : mAllowUnvalidatedKeys(true) { } /* ************************************************************ */ cConfigurationTemplate::~cConfigurationTemplate() { } /* ************************************************************ */ const cConfigurationTemplate::tConstIterator cConfigurationTemplate::begin() const { return mValidators.begin(); } /* ************************************************************ */ const cConfigurationTemplate::tIterator cConfigurationTemplate::begin() { return mValidators.begin(); } /* ************************************************************ */ const cConfigurationTemplate::tConstIterator cConfigurationTemplate::end() const { return mValidators.end(); } /* ************************************************************ */ const cConfigurationTemplate::tIterator cConfigurationTemplate::end() { return mValidators.end(); } /* ************************************************************ */ void cConfigurationTemplate::validate( cConfiguration & ioConfig ) const { static const cConfValidatorNoValidator * const NoValidatorValidator = new cConfValidatorNoValidator(); cConfParsingErrors errors; // Prefill all defaults applyDefaults( ioConfig ); // Check values one at a time, keying by the validator for (tConstIterator validator = begin(); validator!=end(); ++validator) { cConfiguration::tConstIterator confPair = ioConfig.find(validator->first); if (confPair==ioConfig.end()) { tRequiredContainer::const_iterator requirement = mRequired.find(validator->first); if (requirement->second == Requirement_Required) errors.add( cConfParsingError( cConfParsingError::ErrorType_ValidationFailed, "Missing required value", validator->first ) ); } else { // Validate it. const cConfValidatorInterface * failedValidation; if ((failedValidation=validator->second->valueOk(confPair->second))) errors.add( cConfParsingError( cConfParsingError::ErrorType_ValidationFailed, failedValidation->describe(), validator->first, confPair->second ) ); } } // Reverse scan the entries against the validator if optional keys are // not allowed if (!allowUnvalidatedKeys()) { for (cConfiguration::tConstIterator setting = ioConfig.begin(); setting!=ioConfig.end(); ++setting) if (!isset(setting->first)) errors.add( cConfParsingError( cConfParsingError::ErrorType_ValidationFailed, NoValidatorValidator->describe(), setting->first, setting->second ) ); } if (!errors.empty()) throw cConfFailedValidationException( errors ); } /* ************************************************************ */ void cConfigurationTemplate::applyDefaults( cConfiguration & ioConfig ) const { for (tDefaultsContainer::const_iterator defaultIt = mDefaults.begin(); defaultIt!=mDefaults.end(); ++defaultIt) if (!ioConfig.isSet(defaultIt->first)) ioConfig[defaultIt->first] = defaultIt->second; } /* ************************************************************ */ void cConfigurationTemplate::addPair( const tString & iKey, const cAutoPtr<cConfValidatorInterface> iValidator, const tBool iValueRequired ) { mValidators[iKey] = iValidator; if (iValueRequired) mRequired[iKey] = Requirement_Required; else mRequired[iKey] = Requirement_Optional; } /* ************************************************************ */ void cConfigurationTemplate::addPairWithDefault(const tString & iKey, const cAutoPtr<cConfValidatorInterface> iValidator, const cDynVar & iDefault ) { mValidators[iKey] = iValidator; mRequired[iKey] = Requirement_Override; mDefaults[iKey] = iDefault; } /* ************************************************************ */ const cConfValidatorInterface * const cConfigurationTemplate::pairIsOk( const tString & iName, const cDynVar & iValue ) const { static const cConfValidatorNoValidator * const NoValidatorValidator = new cConfValidatorNoValidator(); tConstIterator validator = mValidators.find( iName ); if (validator==mValidators.end()) { if (!allowUnvalidatedKeys()) return NoValidatorValidator; return 0; } return validator->second->valueOk( iValue ); } /* ************************************************************ */ const tBool cConfigurationTemplate::isset( const tString & iName ) const { tConstIterator validator = mValidators.find( iName ); return (validator!=end()); } /* ************************************************************ */ const tBool cConfigurationTemplate::empty() const { return mValidators.empty(); } /* ************************************************************ */ const cConfigurationTemplate::tSize cConfigurationTemplate::size() const { return mValidators.size(); } /* ************************************************************ */ void cConfigurationTemplate::clear() { return mValidators.clear(); } /* ************************************************************ */ void cConfigurationTemplate::setUnvalidatedKeysAllowed( const tBool iAllowed ) { mAllowUnvalidatedKeys = iAllowed; } /* ************************************************************ */ const tBool cConfigurationTemplate::allowUnvalidatedKeys() const { return mAllowUnvalidatedKeys; } /* ************************************************************ */ const tString cConfigurationTemplate::dump() const { tString temp("<configuration template>\n"); tConstIterator validator = begin(); const tConstIterator EndValidator = end(); for (; EndValidator!=validator; ++validator) temp += (tString("\t") + validator->first + " =\t" + validator->second->describe() + "\n"); temp += "</configuration template>"; return temp; } /* ************************************************************ */ cConfigurationTemplate::cConfValidatorNoValidator::~cConfValidatorNoValidator() { } /* ************************************************************ */ const cConfValidatorInterface * const cConfigurationTemplate::cConfValidatorNoValidator::valueOk( const cDynVar & ) const { // This is a meta-validator of sorts, it doesnt actually check // anything, so just return false; return this; } /* ************************************************************ */ const tString cConfigurationTemplate::cConfValidatorNoValidator::describe() const { static const tString Message("No validator for this key"); return Message; } }

©2012 Aaron Cameron