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>
39 * return the default platform dependant download directory.
40 * This must be a user-writeable location, the question is if it should
41 * be a user visible location. On Windows we default to a subdir of
42 * Documents (FlightGear), on Unixes we default to FG_HOME, which is
43 * typically invisible.
45 std::string defaultDownloadDir();
47 /// option processing can have various result values
48 /// depending on what the user requested. Note processOptions only
49 /// returns a subset of these.
56 FG_OPTIONS_VERBOSE_HELP = 4,
57 FG_OPTIONS_SHOW_AIRCRAFT = 5,
58 FG_OPTIONS_SHOW_SOUND_DEVICES = 6,
59 FG_OPTIONS_NO_DEFAULT_CONFIG = 7
68 static Options* sharedInstance();
73 * pass command line arguments, read default config files
75 void init(int argc, char* argv[], const SGPath& appDataPath);
78 * parse a config file (eg, .fgfsrc)
80 void readConfig(const SGPath& path);
83 * read the value for an option, if it has been set
85 std::string valueForOption(const std::string& key, const std::string& defValue = std::string()) const;
88 * return all values for a multi-valued option
90 string_list valuesForOption(const std::string& key) const;
93 * check if a particular option has been set (so far)
95 bool isOptionSet(const std::string& key) const;
99 * set an option value, assuming it is not already set (or multiple values
101 * This can be used to inject option values, eg based upon environment variables
103 int addOption(const std::string& key, const std::string& value);
106 * apply option values to the simulation state
107 * (set properties, etc).
109 OptionResult processOptions();
112 * process command line options relating to scenery / aircraft / data paths
117 * init the aircraft options
122 * should defualt configuration files be loaded and processed or not?
123 * There's many configuration files we have historically read by default
124 * on startup - preferences.xml, fgfs.rc in various places and so on.
125 * --no-default-config allows this behaviour to be changed, so only
126 * expicitly listed files are read - this is useful for testing. Expose
127 * the value of the option here.
129 bool shouldLoadDefaultConfig() const;
132 * check if the arguments array contains a particular string (with a '--' or
134 * Used by early startup code before Options object is created
136 static bool checkForArg(int argc, char* argv[], const char* arg);
138 void showUsage() const;
140 int parseOption(const std::string& s);
142 void processArgResult(int result);
145 * Setup the root base, and check it's valid. Bails out with exit(-1) if
146 * the root package was not found or is the incorrect version. Argv/argv
147 * are passed since we might potentially show a GUI dialog at this point
148 * to help the user our (finding a base package), and hence need to init Qt.
150 void setupRoot(int argc, char **argv);
152 std::string platformDefaultRoot() const;
154 class OptionsPrivate;
155 std::auto_ptr<OptionsPrivate> p;
158 } // of namespace flightgear
160 void fgSetDefaults();
162 #endif /* _OPTIONS_HXX */