1
0
Fork 0
flightgear/src/Main/options.hxx
James Turner 3b6c2c426d Support a --no-default-config option.
For (future) easier testing of the sim, support a mode where only explicitly named config / option files are loaded, instead of the default ones. (Including, for example, preferences.xml). This currently produces a non-functional sim, but will soon be more useful :)

No behaviour should change unless you try the new option.
2012-09-29 19:02:03 +01:00

118 lines
3 KiB
C++

// options.hxx -- class to handle command line options
//
// Written by Curtis Olson, started April 1998.
//
// Copyright (C) 1998 Curtis L. Olson - http://www.flightgear.org/~curt
//
// 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
// $Id$
#ifndef _OPTIONS_HXX
#define _OPTIONS_HXX
#include <memory>
#include <string>
#include <simgear/misc/strutils.hxx>
// forward decls
class SGPath;
namespace flightgear
{
class Options
{
private:
Options();
public:
static Options* sharedInstance();
~Options();
/**
* pass command line arguments, read default config files
*/
void init(int argc, char* argv[], const SGPath& appDataPath);
/**
* parse a config file (eg, .fgfsrc)
*/
void readConfig(const SGPath& path);
/**
* read the value for an option, if it has been set
*/
std::string valueForOption(const std::string& key, const std::string& defValue = std::string()) const;
/**
* return all values for a multi-valued option
*/
string_list valuesForOption(const std::string& key) const;
/**
* check if a particular option has been set (so far)
*/
bool isOptionSet(const std::string& key) const;
/**
* set an option value, assuming it is not already set (or multiple values
* are permitted)
* This can be used to inject option values, eg based upon environment variables
*/
int addOption(const std::string& key, const std::string& value);
/**
* apply option values to the simulation state
* (set properties, etc)
*/
void processOptions();
/**
* init the aircraft options
*/
void initAircraft();
/**
* should defualt configuration files be loaded and processed or not?
* There's many configuration files we have historically read by default
* on startup - preferences.xml, fgfs.rc in various places and so on.
* --no-default-config allows this behaviour to be changed, so only
* expicitly listed files are read - this is useful for testing. Expose
* the value of the option here.
*/
bool shouldLoadDefaultConfig() const;
private:
void showUsage() const;
int parseOption(const std::string& s);
void processArgResult(int result);
void setupRoot();
std::string platformDefaultRoot() const;
class OptionsPrivate;
std::auto_ptr<OptionsPrivate> p;
};
} // of namespace flightgear
#endif /* _OPTIONS_HXX */