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 #include "OgreHeaderPrefix.h"
38 
39 namespace Ogre {
40 
63  {
64  public:
65 
67  virtual ~ConfigFile();
69  void load(const String& filename, const String& separators = "\t:=", bool trimWhitespace = true);
71  void load(const DataStreamPtr& stream, const String& separators = "\t:=", bool trimWhitespace = true);
73  void loadDirect(const String& filename, const String& separators = "\t:=", bool trimWhitespace = true);
75  void loadFromResourceSystem(const String& filename, const String& resourceGroup, const String& separators = "\t:=", bool trimWhitespace = true);
76 
82  String getSetting(const String& key, const String& section = StringUtil::BLANK, const String& defaultValue = StringUtil::BLANK) const;
84  StringVector getMultiSetting(const String& key, const String& section = StringUtil::BLANK) const;
85 
95 
96 
97 
99  void clear(void);
100  protected:
102  };
106 }
107 
108 #include "OgreHeaderSuffix.h"
109 
110 #endif
OgreHeaderSuffix.h
Ogre::AllocatedObject
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
Definition: OgreMemoryAllocatedObject.h:59
Ogre
Definition: OgreAndroidLogListener.h:35
Ogre::map
Definition: OgrePrerequisites.h:534
Ogre::StringVector
vector< String >::type StringVector
Definition: OgreStringVector.h:45
Ogre::ConfigFile::SettingsIterator
MapIterator< SettingsMultiMap > SettingsIterator
Definition: OgreConfigFile.h:87
Ogre::ConfigFile::ConfigFile
ConfigFile()
Ogre::ConfigFile::getSettingsIterator
SettingsIterator getSettingsIterator(const String &section=StringUtil::BLANK)
Get an iterator over all the available settings in a section.
Ogre::ConfigFile::loadDirect
void loadDirect(const String &filename, const String &separators="\t:=", bool trimWhitespace=true)
load from a filename (not using resource group locations)
Ogre::ConfigFile::SettingsMultiMap
multimap< String, String >::type SettingsMultiMap
Definition: OgreConfigFile.h:86
Ogre::ConfigFile::getMultiSetting
StringVector getMultiSetting(const String &key, const String &section=StringUtil::BLANK) const
Gets all settings from the file with the named key.
Ogre::String
_StringBase String
Definition: OgrePrerequisites.h:439
Ogre::ConfigFile::clear
void clear(void)
Clear the settings.
Ogre::ConfigFile::load
void load(const String &filename, const String &separators="\t:=", bool trimWhitespace=true)
load from a filename (not using resource group locations)
Ogre::ConfigFile::getSetting
String getSetting(const String &key, const String &section=StringUtil::BLANK, const String &defaultValue=StringUtil::BLANK) const
Gets the first setting from the file with the named key.
Ogre::StringUtil::BLANK
static const String BLANK
Constant blank string, useful for returning by ref where local does not exist.
Definition: OgreString.h:196
Ogre::ConfigFile::load
void load(const DataStreamPtr &stream, const String &separators="\t:=", bool trimWhitespace=true)
load from a data stream
Ogre::ConfigFile
Class for quickly loading settings from a text file.
Definition: OgreConfigFile.h:63
OgreHeaderPrefix.h
OgrePrerequisites.h
Ogre::ConfigFile::loadFromResourceSystem
void loadFromResourceSystem(const String &filename, const String &resourceGroup, const String &separators="\t:=", bool trimWhitespace=true)
load from a filename (using resource group locations)
_OgreExport
#define _OgreExport
Definition: OgrePlatform.h:257
Ogre::multimap
Definition: OgrePrerequisites.h:548
Ogre::SharedPtr< DataStream >
Ogre::MapIterator
Concrete IteratorWrapper for nonconst access to the underlying key-value container.
Definition: OgreIteratorWrapper.h:319
OgreIteratorWrappers.h
Ogre::ConfigFile::SettingsBySection
map< String, SettingsMultiMap * >::type SettingsBySection
Gets an iterator for stepping through all the keys / values in the file.
Definition: OgreConfigFile.h:89
Ogre::ConfigFile::mSettings
SettingsBySection mSettings
Definition: OgreConfigFile.h:101
Ogre::ConfigFile::SectionIterator
MapIterator< SettingsBySection > SectionIterator
Definition: OgreConfigFile.h:90
OgreStringVector.h
OgreString.h
Ogre::ConfigFile::~ConfigFile
virtual ~ConfigFile()
Ogre::ConfigFile::getSectionIterator
SectionIterator getSectionIterator(void)
Get an iterator over all the available sections in the config file.
OgreDataStream.h

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.