src/Main/options.hxx

   1 // options.hxx -- class to handle command line options
   2 //
   3 // Written by Curtis Olson, started April 1998.
   4 //
   5 // Copyright (C) 1998  Curtis L. Olson  - http://www.flightgear.org/~curt
   6 //
   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.
  11 //
  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.
  16 //
  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.
  20 //
  21 // $Id$
  22
  23
  24 #ifndef _OPTIONS_HXX
  25 #define _OPTIONS_HXX
  26
  27 #include <memory>
  28 #include <string>
  29
  30 #include <simgear/misc/strutils.hxx>
  31
  32 // forward decls
  33 class SGPath;
  34
  35 namespace flightgear
  36 {
  37
  38     /**
  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.
  44      */
  45     std::string defaultDownloadDir();
  46
  47 /// option processing can have various result values
  48 /// depending on what the user requested. Note processOptions only
  49 /// returns a subset of these.
  50 enum OptionResult
  51 {
  52     FG_OPTIONS_OK = 0,
  53     FG_OPTIONS_HELP = 1,
  54     FG_OPTIONS_ERROR = 2,
  55     FG_OPTIONS_EXIT = 3,
  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
  60 };
  61
  62 class Options
  63 {
  64 private:
  65   Options();
  66
  67 public:
  68   static Options* sharedInstance();
  69
  70   ~Options();
  71
  72   /**
  73    * pass command line arguments, read default config files
  74    */
  75   void init(int argc, char* argv[], const SGPath& appDataPath);
  76
  77   /**
  78     * parse a config file (eg, .fgfsrc)
  79     */
  80   void readConfig(const SGPath& path);
  81
  82   /**
  83     * read the value for an option, if it has been set
  84     */
  85   std::string valueForOption(const std::string& key, const std::string& defValue = std::string()) const;
  86
  87   /**
  88     * return all values for a multi-valued option
  89     */
  90   string_list valuesForOption(const std::string& key) const;
  91
  92   /**
  93     * check if a particular option has been set (so far)
  94     */
  95   bool isOptionSet(const std::string& key) const;
  96
  97
  98   /**
  99     * set an option value, assuming it is not already set (or multiple values
 100     * are permitted)
 101     * This can be used to inject option values, eg based upon environment variables
 102     */
 103   int addOption(const std::string& key, const std::string& value);
 104
 105   /**
 106    * apply option values to the simulation state
 107    * (set properties, etc).
 108    */
 109   OptionResult processOptions();
 110
 111     /**
 112      * process command line options relating to scenery / aircraft / data paths
 113      */
 114     void initPaths();
 115
 116   /**
 117    * init the aircraft options
 118    */
 119   void initAircraft();
 120
 121   /**
 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.
 128    */
 129   bool shouldLoadDefaultConfig() const;
 130
 131   /**
 132    * check if the arguments array contains a particular string (with a '--' or
 133    * '-' prefix).
 134    * Used by early startup code before Options object is created
 135    */
 136   static bool checkForArg(int argc, char* argv[], const char* arg);
 137
 138       std::string platformDefaultRoot() const;
 139 private:
 140   void showUsage() const;
 141
 142   int parseOption(const std::string& s);
 143
 144   void processArgResult(int result);
 145
 146     /**
 147      * Setup the root base, and check it's valid. Bails out with exit(-1) if
 148      * the root package was not found or is the incorrect version. Argv/argv
 149      * are passed since we might potentially show a GUI dialog at this point
 150      * to help the user our (finding a base package), and hence need to init Qt.
 151      */
 152   void setupRoot(int argc, char **argv);
 153
 154
 155   class OptionsPrivate;
 156   std::auto_ptr<OptionsPrivate> p;
 157 };
 158
 159 } // of namespace flightgear
 160
 161 void fgSetDefaults();
 162
 163 #endif /* _OPTIONS_HXX */