/*
 * This source file is part of KEOS (Free 3D Engine)
 * For the latest info, see http://www.keosengine.org/
 * E-mails : thierry.vouriot@keosengine.org, yeri@keosengine.org
 * 
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free Software
 * Foundation; either version 2 of the License, or (at your option) any later
 * version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
 * Place - Suite 330, Boston, MA 02111-1307, USA, or go to
 * http://www.gnu.org/copyleft/lesser.txt.
 *
 */
#ifndef KEOS_CONFIGFILE_H
#define KEOS_CONFIGFILE_H

#include "KeosPrerequisites.h"
#include "KeosConfigOption.h"

namespace Keos {

    /** Class for quickly loading settings from a XML file.
     *  The file must be in a format like that :
     *      <?xml version="1.0" encoding="UTF-8"?>
     *      <properties>
     *          <property name="videomode" value="1024x768" />
     *          <property name="colordepth" value="32" />
     *          <property name="fullscreen" value="no" />
     *      </properties>
     */
    class KEOS_EXPORT CXMLConfigFile
    {
    public:

        /** Constructor.
         */
        CXMLConfigFile();

        /** Destructor.
         */
        virtual ~CXMLConfigFile();
        
        /** Load from a file name.
         *  @param strFilename Path of the XML config file.
         *  @return False if the file cannot be read, true else.
         */
        bool Load(const String& strFilename);

        /** Save ConfigOptionMap in a file.
         *  @param strFilename Path of the XML config file.
         *  @param ConfigMap Map which contains the configuration options.
         *  @return False if the file cannot be saved, true else.
         */
        bool Save(const String& strFilename, ConfigOptionMap ConfigMap);

        /** Get the setting value from the setting name.
         *  @param strKey The name of the setting.
         *  @return The value of the setting.
         */
        String GetSetting(const String& strKey) const;
        
        /** Get the settings map.
         */
        SettingsMap& GetSettingsMap(void) 
        { return m_Settings; }

        /** Clear the settings 
         */
        void Clear(void);

    protected:

        //! Map of all the settings
        SettingsMap m_Settings;
    };

} // namespace Keos

#endif // KEOS_CONFIGFILE_H
