[]Jimmy's World.org
Because you all make me very, very tired.
[]
Jimmy's World Games
Not a Member? - Login or Create an Account
[] Tuesday the 6th of January 2009 @ 04:15am
News Journal Creative Writing Projects Your JW About

LibN2L-4 Library Code Reference

Classes
Compounds
Files
Members
Method Index
Full Reference

cConfigurationTemplate.h

Go to the documentation of this file.
00001 /************************************************************************
00002 Nova-2 Library (libN2L, or simply n2l) Game development C++ Library
00003 Copyright (C) 2003  Aaron Cameron
00004 
00005 This library is free software; you can redistribute it and/or
00006 modify it under the terms of the GNU Lesser General Public
00007 License as published by the Free Software Foundation; either
00008 version 2.1 of the License, or (at your option) any later version.
00009 
00010 This library is distributed in the hope that it will be useful,
00011 but WITHOUT ANY WARRANTY; without even the implied warranty of
00012 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013 Lesser General Public License for more details.
00014 
00015 You should have received a copy of the GNU Lesser General Public
00016 License along with this library; if not, write to the Free Software
00017 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
00018 
00019 A copy of the GNU Lesser General Public License has been provided with
00020 this library in the file 'COPYING'.
00021 
00022 Contact information for the author of this library has been provided
00023 with this library in the file 'AUTHOR'.
00024 ************************************************************************/
00025 #ifndef _n2l4_cConfigurationTemplate_h
00026 #define _n2l4_cConfigurationTemplate_h
00027 
00028 #include "n2l/n2l.h"
00029 #include "cConfValidatorInterface.h"
00030 #include "cConfiguration.h"
00031 #include <map>
00032 
00033 namespace n2l
00034 {
00035     class cDynVar;
00036 
00037     class cConfigurationTemplate
00038     {
00039     protected:
00040         enum tRequirement
00041         {
00042             Requirement_Optional,
00043             Requirement_Required,
00044             Requirement_Override
00045         };
00046         typedef std::map<tString,cAutoPtr<cConfValidatorInterface> > tContainer;
00047         typedef std::map<tString,tRequirement> tRequiredContainer;
00048         typedef std::map<tString,cDynVar> tDefaultsContainer;
00049         
00050     public:
00054         class cConfValidatorNoValidator : public cConfValidatorInterface
00055         {
00056         public:
00057             virtual ~cConfValidatorNoValidator();
00058             virtual const cConfValidatorInterface * const valueOk(const cDynVar & iValue ) const;
00059             virtual const tString describe() const;
00060         };
00061 
00062         typedef tContainer::const_iterator tConstIterator;
00063         typedef tContainer::iterator tIterator;
00064 
00065         typedef tContainer::size_type tSize;
00066         
00067         cConfigurationTemplate();
00068         ~cConfigurationTemplate();
00069 
00070         const cConfValidatorInterface * const  pairIsOk(const tString & iName,
00071                                                         const cDynVar & iValue ) const;
00072 
00073         void validate( cConfiguration & ioConfig ) const;
00074         void applyDefaults( cConfiguration & ioConfig ) const;
00075 
00076         void addPair(   const tString & iKey,
00077                         const cAutoPtr<cConfValidatorInterface> iValidator,
00078                         const tBool iValueRequired = true );
00079         void addPairWithDefault(    const tString & iKey,
00080                                     const cAutoPtr<cConfValidatorInterface> iValidator,
00081                                     const cDynVar & iDefault );
00082 
00083         const tBool isset( const tString & iName ) const;
00084 
00085         const tBool empty() const;
00086         const tSize size() const;
00087 
00088         void clear();
00089 
00090         void setUnvalidatedKeysAllowed( const tBool iAllowed );
00091 
00092         const tBool allowUnvalidatedKeys() const;
00093 
00094         const tString dump() const;
00095 
00096     protected:
00097         const tConstIterator begin() const;
00098         const tIterator begin();
00099 
00100         const tConstIterator end() const;
00101         const tIterator end();
00102 
00103     private:
00104         tContainer          mValidators;
00105         tRequiredContainer  mRequired;
00106         tDefaultsContainer  mDefaults;
00107         tBool               mAllowUnvalidatedKeys;
00108 
00109     };
00110 
00111 }
00112 
00113 #endif
©2009 Aaron Cameron
Benchmarks