diff options
Diffstat (limited to 'ingen/Configuration.hpp')
| -rw-r--r-- | ingen/Configuration.hpp | 160 |
1 files changed, 0 insertions, 160 deletions
diff --git a/ingen/Configuration.hpp b/ingen/Configuration.hpp deleted file mode 100644 index 6759b4b0..00000000 --- a/ingen/Configuration.hpp +++ /dev/null @@ -1,160 +0,0 @@ -/* - This file is part of Ingen. - Copyright 2007-2015 David Robillard <http://drobilla.net/> - - Ingen is free software: you can redistribute it and/or modify it under the - terms of the GNU Affero General Public License as published by the Free - Software Foundation, either version 3 of the License, or any later version. - - Ingen 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 Affero General Public License for details. - - You should have received a copy of the GNU Affero General Public License - along with Ingen. If not, see <http://www.gnu.org/licenses/>. -*/ - -#ifndef INGEN_CONFIGURATION_HPP -#define INGEN_CONFIGURATION_HPP - -#include <cstdlib> -#include <list> -#include <map> -#include <ostream> -#include <string> - -#include "ingen/Atom.hpp" -#include "ingen/ingen.h" -#include "lv2/lv2plug.in/ns/ext/urid/urid.h" -#include "raul/Exception.hpp" - -namespace Ingen { - -class FilePath; -class Forge; -class URIMap; - -/** Ingen configuration (command line options and/or configuration file). - * @ingroup IngenShared - */ -class INGEN_API Configuration { -public: - explicit Configuration(Forge& forge); - - /** The scope of a configuration option. - * - * This controls when and where an option will be saved or restored. - */ - enum Scope { - GLOBAL = 1, ///< Applies to any Ingen instance - SESSION = 1<<1, ///< Applies to this Ingen instance only - GUI = 1<<2 ///< Persistent GUI settings saved at exit - }; - - /** Add a configuration option. - * - * @param key URI local name, in camelCase - * @param name Long option name (without leading "--") - * @param letter Short option name (without leading "-") - * @param desc Description - * @param scope Scope of option - * @param type Type - * @param value Default value - */ - Configuration& add(const std::string& key, - const std::string& name, - char letter, - const std::string& desc, - Scope scope, - const LV2_URID type, - const Atom& value); - - void print_usage(const std::string& program, std::ostream& os); - - struct OptionError : public Raul::Exception { - explicit OptionError(const std::string& m) : Exception(m) {} - }; - - struct FileError : public Raul::Exception { - explicit FileError(const std::string& m) : Exception(m) {} - }; - - /** Parse a command line. - * - * @throw OptionError - */ - void parse(int argc, char **argv); - - /** Load a specific file. */ - bool load(const FilePath& path); - - /** Save configuration to a file. - * - * @param uri_map URI map. - * - * @param app Application name. - * - * @param filename If absolute, the configuration will be saved to this - * path. Otherwise the configuration will be saved to the user - * configuration directory (e.g. ~/.config/ingen/filename). - * - * @param scopes Bitwise OR of Scope values. Only options which match the - * given scopes will be saved. - * - * @return The absolute path of the saved configuration file. - */ - FilePath save(URIMap& uri_map, - const std::string& app, - const FilePath& filename, - unsigned scopes); - - /** Load files from the standard configuration directories for the app. - * - * The system configuration file(s), e.g. /etc/xdg/appname/filename, - * will be loaded before the user's, e.g. ~/.config/appname/filename, - * so the user options will override the system options. - */ - std::list<FilePath> load_default(const std::string& app, - const FilePath& filename); - - const Atom& option(const std::string& long_name) const; - bool set(const std::string& long_name, const Atom& value); - -private: - struct Option { - std::string key; - std::string name; - char letter; - std::string desc; - Scope scope; - LV2_URID type; - Atom value; - }; - - struct OptionNameOrder { - inline bool operator()(const Option& a, const Option& b) { - return a.name < b.name; - } - }; - - typedef std::map<std::string, Option> Options; - typedef std::map<char, std::string> ShortNames; - typedef std::map<std::string, std::string> Keys; - - std::string variable_string(LV2_URID type) const; - - int set_value_from_string(Configuration::Option& option, - const std::string& value); - - Forge& _forge; - const std::string _shortdesc; - const std::string _desc; - Options _options; - Keys _keys; - ShortNames _short_names; - size_t _max_name_length; -}; - -} // namespace Ingen - -#endif // INGEN_CONFIGURATION_HPP |