1 // options.hxx -- class to handle command line options
3 // Written by Curtis Olson, started April 1998.
5 // Copyright (C) 1998 Curtis L. Olson - http://www.flightgear.org/~curt
7 // This program is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU General Public License as
9 // published by the Free Software Foundation; either version 2 of the
10 // License, or (at your option) any later version.
12 // This program is distributed in the hope that it will be useful, but
13 // WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 // General Public License for more details.
17 // You should have received a copy of the GNU General Public License
18 // along with this program; if not, write to the Free Software
19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
30 #include <simgear/misc/strutils.hxx>
38 /// option processing can have various result values
39 /// depending on what the user requested. Note processOptions only
40 /// returns a subset of these.
47 FG_OPTIONS_VERBOSE_HELP = 4,
48 FG_OPTIONS_SHOW_AIRCRAFT = 5,
49 FG_OPTIONS_SHOW_SOUND_DEVICES = 6,
50 FG_OPTIONS_NO_DEFAULT_CONFIG = 7
59 static Options* sharedInstance();
64 * pass command line arguments, read default config files
66 void init(int argc, char* argv[], const SGPath& appDataPath);
69 * parse a config file (eg, .fgfsrc)
71 void readConfig(const SGPath& path);
74 * read the value for an option, if it has been set
76 std::string valueForOption(const std::string& key, const std::string& defValue = std::string()) const;
79 * return all values for a multi-valued option
81 string_list valuesForOption(const std::string& key) const;
84 * check if a particular option has been set (so far)
86 bool isOptionSet(const std::string& key) const;
90 * set an option value, assuming it is not already set (or multiple values
92 * This can be used to inject option values, eg based upon environment variables
94 int addOption(const std::string& key, const std::string& value);
97 * apply option values to the simulation state
98 * (set properties, etc).
100 OptionResult processOptions();
103 * init the aircraft options
108 * should defualt configuration files be loaded and processed or not?
109 * There's many configuration files we have historically read by default
110 * on startup - preferences.xml, fgfs.rc in various places and so on.
111 * --no-default-config allows this behaviour to be changed, so only
112 * expicitly listed files are read - this is useful for testing. Expose
113 * the value of the option here.
115 bool shouldLoadDefaultConfig() const;
117 void showUsage() const;
119 int parseOption(const std::string& s);
121 void processArgResult(int result);
125 std::string platformDefaultRoot() const;
127 class OptionsPrivate;
128 std::auto_ptr<OptionsPrivate> p;
131 } // of namespace flightgear
133 #endif /* _OPTIONS_HXX */