configfile.h

#pragma once

#include "library/sp.h"
#include "library/strings.h"
#include <boost/any.hpp>
#include <map>
#include <vector>

namespace OpenApoc
{

class ConfigFileImpl;
class ConfigOption;

class ConfigFile
{
  private:
	up<ConfigFileImpl> pimpl;
	ConfigFile();

  public:
	~ConfigFile();
	bool save();

	// Returns true if the settings have been read
	bool loaded() const;

	int getInt(const UString &key);
	bool getBool(const UString &key);
	UString getString(const UString &key);
	float getFloat(const UString &key);
	bool get(const UString &key); // returns true if the option was specified
	UString describe(const UString &section, const UString &name);

	void set(const UString &key, const bool value);
	void set(const UString &key, const int value);
	void set(const UString &key, const UString value);
	void set(const UString &key, const float value);

	void addOptionString(const UString section, const UString longName, const UString shortName,
	                     const UString description, const UString defaultValue);
	void addOptionInt(const UString section, const UString longName, const UString shortName,
	                  const UString description, const int defaultValue);
	void addOptionBool(const UString section, const UString longName, const UString shortName,
	                   const UString description, const bool defaultValue);
	void addOptionFloat(const UString section, const UString longName, const UString shortName,
	                    const UString description, const float defaultValue);
	void addOption(const UString section, const UString longName, const UString shortName,
	               const UString description);
	void addPositionalArgument(const UString name, const UString description);

	// returns 'true' if the program should exit (invalid option/'--help' specified)
	bool parseOptions(int argc, char *argv[]);

	// Prints out the help to stdout, used if the running program has decided some argument is
	// invalid
	void showHelp();

	std::map<UString, std::vector<ConfigOption>> getOptions();

	static ConfigFile &getInstance();
};

class ConfigOption
{
  private:
	UString section;
	UString name;
	UString description;

  public:
	ConfigOption(const UString section, const UString name, const UString description);
	UString getName() const { return name; }
	UString getDescription() const { return description; }
	UString getKey() const;
};

class ConfigOptionString : public ConfigOption
{
  private:
	UString defaultValue;

  public:
	ConfigOptionString(const UString section, const UString name, const UString description,
	                   const UString defaultValue = "");
	UString get() const;
};

class ConfigOptionInt : public ConfigOption
{
  private:
	int defaultValue;

  public:
	ConfigOptionInt(const UString section, const UString name, const UString description,
	                const int defaultValue = 0);
	int get() const;
};

class ConfigOptionBool : public ConfigOption
{
  private:
	bool defaultValue;

  public:
	ConfigOptionBool(const UString section, const UString name, const UString description,
	                 const bool defaultValue = false);
	bool get() const;
};

class ConfigOptionFloat : public ConfigOption
{
  private:
	float defaultValue;

  public:
	ConfigOptionFloat(const UString section, const UString name, const UString description,
	                  const float defaultValue = 0.0f);
	bool get() const;
};
static inline ConfigFile &config() { return ConfigFile::getInstance(); }

// validate overload required by boost::program_options for UString
// boost should find this through ADL.
// this is required for string values with spaces
void validate(boost::any &v, const std::vector<std::string> &values, UString *, int);

}; // namespace OpenApoc