OgreConfigFile.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OGRE
    (Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2013 Torus Knot Software Ltd

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/
#ifndef __ConfigFile_H__
#define __ConfigFile_H__

#include "OgrePrerequisites.h"

#include "OgreString.h"
#include "OgreStringVector.h"
#include "OgreIteratorWrappers.h"
#include "OgreDataStream.h"
#include "OgreHeaderPrefix.h"

namespace Ogre {

    class _OgreExport ConfigFile : public ConfigAlloc
    {
    public:

        ConfigFile();
        virtual ~ConfigFile();
        void load(const String& filename, const String& separators = "\t:=", bool trimWhitespace = true);
        void load(const DataStreamPtr& stream, const String& separators = "\t:=", bool trimWhitespace = true);
        void loadDirect(const String& filename, const String& separators = "\t:=", bool trimWhitespace = true);
        void loadFromResourceSystem(const String& filename, const String& resourceGroup, const String& separators = "\t:=", bool trimWhitespace = true);

        String getSetting(const String& key, const String& section = StringUtil::BLANK, const String& defaultValue = StringUtil::BLANK) const;
        StringVector getMultiSetting(const String& key, const String& section = StringUtil::BLANK) const;

        typedef multimap<String, String>::type SettingsMultiMap;
        typedef MapIterator<SettingsMultiMap> SettingsIterator;
        typedef map<String, SettingsMultiMap*>::type SettingsBySection;
        typedef MapIterator<SettingsBySection> SectionIterator;
        SectionIterator getSectionIterator(void);
        SettingsIterator getSettingsIterator(const String& section = StringUtil::BLANK);


        
        void clear(void);
    protected:
        SettingsBySection mSettings;
    };
}

#include "OgreHeaderSuffix.h"

#endif