OGRE  1.8
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
OgreConfigFile.h
Go to the documentation of this file.
1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4  (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org/
6 
7 Copyright (c) 2000-2013 Torus Knot Software Ltd
8 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26 -----------------------------------------------------------------------------
27 */
28 #ifndef __ConfigFile_H__
29 #define __ConfigFile_H__
30 
31 #include "OgrePrerequisites.h"
32 
33 #include "OgreString.h"
34 #include "OgreStringVector.h"
35 #include "OgreIteratorWrappers.h"
36 #include "OgreDataStream.h"
37 
38 namespace Ogre {
39 
62  {
63  public:
64 
65  ConfigFile();
66  virtual ~ConfigFile();
68  void load(const String& filename, const String& separators = "\t:=", bool trimWhitespace = true);
70  void load(const String& filename, const String& resourceGroup, const String& separators = "\t:=", bool trimWhitespace = true);
72  void load(const DataStreamPtr& stream, const String& separators = "\t:=", bool trimWhitespace = true);
74  void loadDirect(const String& filename, const String& separators = "\t:=", bool trimWhitespace = true);
76  void loadFromResourceSystem(const String& filename, const String& resourceGroup, const String& separators = "\t:=", bool trimWhitespace = true);
77 
83  String getSetting(const String& key, const String& section = StringUtil::BLANK, const String& defaultValue = StringUtil::BLANK) const;
85  StringVector getMultiSetting(const String& key, const String& section = StringUtil::BLANK) const;
86 
93  SectionIterator getSectionIterator(void);
95  SettingsIterator getSettingsIterator(const String& section = StringUtil::BLANK);
96 
97 
98 
100  void clear(void);
101  protected:
103  };
107 }
108 
109 
110 #endif
#define _OgreExport
Definition: OgrePlatform.h:233
map< String, SettingsMultiMap * >::type SettingsBySection
Gets an iterator for stepping through all the keys / values in the file.
Class for quickly loading settings from a text file.
Concrete IteratorWrapper for nonconst access to the underlying key-value container.
MapIterator< SettingsMultiMap > SettingsIterator
SettingsBySection mSettings
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
vector< String >::type StringVector
MapIterator< SettingsBySection > SectionIterator
multimap< String, String >::type SettingsMultiMap
static const String BLANK
Constant blank string, useful for returning by ref where local does not exist.
Definition: OgreString.h:196
_StringBase String