OGRE  1.9.0
OgreConfigFile.h
Go to the documentation of this file.
1/*
2-----------------------------------------------------------------------------
3This source file is part of OGRE
4 (Object-oriented Graphics Rendering Engine)
5For the latest info, see http://www.ogre3d.org/
6
7Copyright (c) 2000-2014 Torus Knot Software Ltd
8
9Permission is hereby granted, free of charge, to any person obtaining a copy
10of this software and associated documentation files (the "Software"), to deal
11in the Software without restriction, including without limitation the rights
12to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13copies of the Software, and to permit persons to whom the Software is
14furnished to do so, subject to the following conditions:
15
16The above copyright notice and this permission notice shall be included in
17all copies or substantial portions of the Software.
18
19THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25THE 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"
36#include "OgreDataStream.h"
37#include "OgreHeaderPrefix.h"
38
39namespace 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
94 SettingsIterator getSettingsIterator(const String& section = StringUtil::BLANK);
95
96
97
99 void clear(void);
100 protected:
102 };
106}
107
108#include "OgreHeaderSuffix.h"
109
110#endif
#define _OgreExport
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
Class for quickly loading settings from a text file.
SettingsIterator getSettingsIterator(const String &section=StringUtil::BLANK)
Get an iterator over all the available settings in a section.
void load(const DataStreamPtr &stream, const String &separators="\t:=", bool trimWhitespace=true)
load from a data stream
multimap< String, String >::type SettingsMultiMap
void clear(void)
Clear the settings.
void load(const String &filename, const String &separators="\t:=", bool trimWhitespace=true)
load from a filename (not using resource group locations)
SettingsBySection mSettings
map< String, SettingsMultiMap * >::type SettingsBySection
Gets an iterator for stepping through all the keys / values in the file.
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.
void loadDirect(const String &filename, const String &separators="\t:=", bool trimWhitespace=true)
load from a filename (not using resource group locations)
MapIterator< SettingsBySection > SectionIterator
SectionIterator getSectionIterator(void)
Get an iterator over all the available sections in the config file.
void loadFromResourceSystem(const String &filename, const String &resourceGroup, const String &separators="\t:=", bool trimWhitespace=true)
load from a filename (using resource group locations)
StringVector getMultiSetting(const String &key, const String &section=StringUtil::BLANK) const
Gets all settings from the file with the named key.
MapIterator< SettingsMultiMap > SettingsIterator
virtual ~ConfigFile()
Reference-counted shared pointer, used for objects where implicit destruction is required.
_StringBase String
std::map< K, V, P, A > type
std::multimap< K, V, P, A > type