configman.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos 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.
 *
 * xoreos 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 xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

// Inspired by ScummVM's config file and manager code

#ifndef COMMON_CONFIGMAN_H
#define COMMON_CONFIGMAN_H

#include "src/common/types.h"
#include "src/common/error.h"
#include "src/common/scopedptr.h"
#include "src/common/singleton.h"
#include "src/common/ustring.h"

namespace Common {

class ConfigFile;
class ConfigDomain;

class SeekableReadStream;
class WriteStream;

enum ConfigRealm {
    kConfigRealmDefault , 
    kConfigRealmGameTemp  
};

class ConfigManager : public Singleton<ConfigManager> {
public:
    ConfigManager();
    ~ConfigManager();

    UString getConfigFile() const;

    void setConfigFile(const UString &file = "");

    void clear();
    void clearCommandline();

    bool fileExists() const;

    bool changed() const;

    bool load();
    void load(SeekableReadStream &stream);

    bool save();
    void save(WriteStream &stream, bool clearChanged = false);

    void create();

    UString findGame(const UString &path);
    UString createGame(const UString &path, UString target = "");

    bool hasGame(const UString &gameID);

    bool setGame(const UString &gameID = "");

    bool isInGame() const;

    bool hasKey(const UString &key) const;
    bool getKey(const UString &key, UString &value) const;

    // Specialized getters
    UString getString(const UString &key) const;
    bool    getBool  (const UString &key) const;
    int     getInt   (const UString &key) const;
    double  getDouble(const UString &key) const;

    UString getString(const UString &key, const UString &def) const;
    bool    getBool  (const UString &key,       bool     def) const;
    int     getInt   (const UString &key,       int      def) const;
    double  getDouble(const UString &key,       double   def) const;

    void setKey(const UString &key, const UString &value, bool update = false);

    // Specialized setters
    void setString(const UString &key, const UString &value, bool update = false);
    void setBool  (const UString &key,       bool     value, bool update = false);
    void setInt   (const UString &key,       int      value, bool update = false);
    void setDouble(const UString &key,       double   value, bool update = false);

    void setKey(ConfigRealm realm, const UString &key, const UString &value);

    // Specialized realm setters
    void setString(ConfigRealm realm, const UString &key, const UString &value);
    void setBool  (ConfigRealm realm, const UString &key,       bool     value);
    void setInt   (ConfigRealm realm, const UString &key,       int      value);
    void setDouble(ConfigRealm realm, const UString &key,       double   value);

    void setDefaults();

    bool hasDefaultKey(const UString &key) const;
    UString getDefaultKey(const UString &key) const;

    // Specialized defaults getters
    UString getDefaultString(const UString &key) const;
    bool    getDefaultBool  (const UString &key) const;
    int     getDefaultInt   (const UString &key) const;
    double  getDefaultDouble(const UString &key) const;

    void setCommandlineKey(const UString &key, const UString &value);

private:
    static const char *kDomainApp; 

    UString _configFile; 

    bool _changed;

    ScopedPtr<ConfigFile> _config; 

    ScopedPtr<ConfigDomain> _domainDefaultApp;  
    ScopedPtr<ConfigDomain> _domainDefaultGame; 
    ScopedPtr<ConfigDomain> _domainCommandline; 
    ScopedPtr<ConfigDomain> _domainGameTemp;    

    ConfigDomain *_domainApp;  
    ConfigDomain *_domainGame; 

    static UString getDefaultConfigFile();

    UString createGameID(const UString &path);

    // Helpers
    bool hasKey(const ConfigDomain *domain, const UString &key) const;
    bool getKey(const ConfigDomain *domain, const UString &key, UString &value) const;
    bool setKey(ConfigDomain *domain, const UString &key, const UString &value);
};

} // End of namespace Common

#define ConfigMan Common::ConfigManager::instance()

#endif // COMMON_CONFIGMAN_H