configuration.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef NUVIE_CONF_CONFIGURATION_H
#define NUVIE_CONF_CONFIGURATION_H

#include "ultima/shared/std/string.h"
#include "ultima/shared/std/containers.h"
#include "ultima/detection.h"

namespace Ultima {
namespace Shared {
class XMLTree;
} // End of namespace Shared

namespace Nuvie {

class ConfigNode;

#define NUVIE_CONF_READONLY true
#define NUVIE_CONF_READWRITE false

class Configuration {
private:
    Std::vector<Shared::XMLTree*> _trees;
    Common::HashMap<Common::String, Common::String, Common::IgnoreCase_Hash,
        Common::IgnoreCase_EqualTo> _localKeys;
    Common::HashMap<Common::String, Common::String, Common::IgnoreCase_Hash,
        Common::IgnoreCase_EqualTo> _settings;
    Std::string _configFilename;
    bool _configChanged;

    // Sets default configurations common to both enhanced and unhenaced
    void setCommonDefaults(GameId gameType);

    // sets up unenhanced version defaults
    void setUnenhancedDefaults(GameId gameType);

    // sets up enhanced version defaults
    void setEnhancedDefaults(GameId gameType);
public:
    Configuration();
    ~Configuration();

    // read config file. Multiple files may be read. Order is important.
    bool readConfigFile(const Std::string &fname, const Std::string &root, bool readonly = true);

    // Loads up the configuration settings
    void load(GameId gameId, bool isEnhanced);

    // write all (writable) config files
    void write();

    // clear everything
    void clear();

    // get value
    void value(const Std::string &key, Std::string &ret, const char *defaultvalue = "") const;
    void value(const Std::string &key, int &ret, int defaultvalue = 0) const;
    void value(const Std::string &key, bool &ret, bool defaultvalue = false) const;

    void pathFromValue(const Std::string &key, const Std::string &file, Common::Path &full_path) const;

    // set value
    bool set(const Std::string &key, const Std::string &value);
    bool set(const Std::string &key, const char *value);
    bool set(const Std::string &key, int value);
    bool set(const Std::string &key, bool value);

    // get node ref. (delete it afterwards)
    ConfigNode *getNode(const Std::string &key);

    // list all subkeys of a key. (no guaranteed order in result)
    Std::set<Std::string> listKeys(const Std::string &key, bool longformat = false) const;

    typedef Common::Pair<Common::String, Common::String> KeyType;
    typedef Common::Array<KeyType> KeyTypeList;

    void getSubkeys(KeyTypeList &ktl, const Std::string &basekey);
};

} // End of namespace Nuvie
} // End of namespace Ultima

#endif