2003-10-08 21:59:23 +00:00
|
|
|
/* ScummVM - Scumm Interpreter
|
|
|
|
* Copyright (C) 2001 Ludvig Strigeus
|
2004-01-06 12:45:34 +00:00
|
|
|
* Copyright (C) 2001-2004 The ScummVM project
|
2003-10-08 21:59:23 +00:00
|
|
|
*
|
|
|
|
* 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 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 General Public License for more details.
|
|
|
|
|
|
|
|
* You should have received a copy of the GNU 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.
|
|
|
|
*
|
|
|
|
* $Header$
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef COMMON_CONFIG_H
|
|
|
|
#define COMMON_CONFIG_H
|
|
|
|
|
2004-04-09 15:10:23 +00:00
|
|
|
#include "common/array.h"
|
2003-10-08 21:59:23 +00:00
|
|
|
#include "common/map.h"
|
|
|
|
#include "common/singleton.h"
|
|
|
|
#include "common/str.h"
|
|
|
|
#include "common/util.h"
|
|
|
|
|
|
|
|
namespace Common {
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The (singleton) configuration manager, used to query & set configuration
|
|
|
|
* values using string keys.
|
|
|
|
*
|
|
|
|
* @todo Implement the callback based notification system (outline below)
|
|
|
|
* which sends out notifications to interested parties whenever the value
|
|
|
|
* of some specific (or any) configuration key changes.
|
2004-03-28 20:28:45 +00:00
|
|
|
* @todo Preserve the order of the entries in the config file. Maybe even add
|
|
|
|
* an API to query/modify that order, which could be used by the launcher
|
|
|
|
* to allow arranging the game targets.
|
2003-10-08 21:59:23 +00:00
|
|
|
*/
|
|
|
|
class ConfigManager : public Singleton<ConfigManager> {
|
2003-11-07 00:45:54 +00:00
|
|
|
struct IgnoreCaseComparator {
|
2003-11-07 00:03:55 +00:00
|
|
|
int operator()(const String& x, const String& y) const { return scumm_stricmp(x.c_str(), y.c_str()); }
|
|
|
|
};
|
|
|
|
|
2003-10-08 21:59:23 +00:00
|
|
|
public:
|
2004-03-28 20:28:45 +00:00
|
|
|
typedef Map<String, String, IgnoreCaseComparator> StringMap;
|
|
|
|
|
|
|
|
class Domain : public StringMap {
|
|
|
|
private:
|
|
|
|
StringMap _keyValueComments;
|
|
|
|
String _domainComment;
|
2004-03-29 19:15:23 +00:00
|
|
|
|
2003-10-08 21:59:23 +00:00
|
|
|
public:
|
2004-03-29 19:15:23 +00:00
|
|
|
const String &get(const String &key) const;
|
|
|
|
|
|
|
|
void setDomainComment(const String &comment);
|
|
|
|
const String &getDomainComment() const;
|
2004-03-28 20:28:45 +00:00
|
|
|
|
2004-03-29 19:15:23 +00:00
|
|
|
void setKVComment(const String &key, const String &comment);
|
|
|
|
const String &getKVComment(const String &key) const;
|
|
|
|
bool hasKVComment(const String &key) const;
|
2003-10-08 21:59:23 +00:00
|
|
|
};
|
|
|
|
|
2003-11-07 00:45:54 +00:00
|
|
|
typedef Map<String, Domain, IgnoreCaseComparator> DomainMap;
|
2003-11-07 00:03:55 +00:00
|
|
|
|
2003-10-08 21:59:23 +00:00
|
|
|
/** The name of the application domain (normally 'scummvm'). */
|
|
|
|
static const String kApplicationDomain;
|
|
|
|
|
2003-11-10 23:17:11 +00:00
|
|
|
/** The transient (pseudo) domain. */
|
|
|
|
static const String kTransientDomain;
|
|
|
|
|
2004-02-07 04:53:59 +00:00
|
|
|
void switchFile(const String &filename);
|
|
|
|
|
2003-10-08 21:59:23 +00:00
|
|
|
bool hasKey(const String &key) const;
|
|
|
|
bool hasKey(const String &key, const String &dom) const;
|
|
|
|
|
2003-11-05 00:57:00 +00:00
|
|
|
void removeKey(const String &key, const String &dom);
|
|
|
|
|
2003-11-07 16:54:58 +00:00
|
|
|
const String & get(const String &key, const String &dom = String::emptyString) const;
|
2003-10-08 21:59:23 +00:00
|
|
|
int getInt(const String &key, const String &dom = String::emptyString) const;
|
|
|
|
bool getBool(const String &key, const String &dom = String::emptyString) const;
|
|
|
|
|
2003-11-11 00:26:38 +00:00
|
|
|
void set(const String &key, const String &value, const String &dom = String::emptyString);
|
2003-10-08 21:59:23 +00:00
|
|
|
void set(const String &key, const char *value, const String &dom = String::emptyString);
|
|
|
|
void set(const String &key, int value, const String &dom = String::emptyString);
|
|
|
|
void set(const String &key, bool value, const String &dom = String::emptyString);
|
|
|
|
|
|
|
|
void registerDefault(const String &key, const String &value);
|
|
|
|
void registerDefault(const String &key, const char *value);
|
|
|
|
void registerDefault(const String &key, int value);
|
|
|
|
void registerDefault(const String &key, bool value);
|
|
|
|
// ...
|
|
|
|
|
|
|
|
void flushToDisk();
|
|
|
|
|
|
|
|
void setActiveDomain(const String &domain);
|
2004-03-04 22:26:09 +00:00
|
|
|
const String & getActiveDomain() const { return _activeDomain; }
|
2003-10-08 21:59:23 +00:00
|
|
|
|
|
|
|
// void addDomain(const String &name);
|
|
|
|
void removeGameDomain(const String &name);
|
|
|
|
void renameGameDomain(const String &oldName, const String &newName);
|
|
|
|
bool hasGameDomain(const String &domain) const;
|
|
|
|
const DomainMap & getGameDomains() const { return _gameDomains; }
|
|
|
|
|
|
|
|
/*
|
|
|
|
TODO: Callback/change notification system
|
|
|
|
typedef void (*ConfigCallback)(const ConstString &key, void *refCon);
|
|
|
|
|
2004-03-21 18:54:47 +00:00
|
|
|
void registerCallback(ConfigCallback cfgc, void *refCon, const ConstString &key = String::emptyString)
|
|
|
|
void unregisterCallback(ConfigCallback cfgc, const ConstString &key = String::emptyString)
|
2003-10-08 21:59:23 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
private:
|
|
|
|
friend class Singleton<ConfigManager>;
|
|
|
|
ConfigManager();
|
|
|
|
|
|
|
|
void loadFile(const String &filename);
|
|
|
|
void writeDomain(FILE *file, const String &name, const Domain &domain);
|
|
|
|
|
2003-11-10 23:17:11 +00:00
|
|
|
Domain _transientDomain;
|
2003-10-08 21:59:23 +00:00
|
|
|
DomainMap _gameDomains;
|
|
|
|
DomainMap _globalDomains;
|
|
|
|
Domain _defaultsDomain;
|
|
|
|
|
2004-04-09 15:10:23 +00:00
|
|
|
Array<Domain *> _searchOrder;
|
2003-10-08 21:59:23 +00:00
|
|
|
|
|
|
|
String _activeDomain;
|
|
|
|
String _filename;
|
|
|
|
};
|
|
|
|
|
|
|
|
} // End of namespace Common
|
|
|
|
|
|
|
|
/** Shortcut for accessing the configuration manager. */
|
|
|
|
#define ConfMan Common::ConfigManager::instance()
|
|
|
|
|
|
|
|
#endif
|