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  - curt@me.umn.edu
   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., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 //
  21 // $Id$
  22
  23
  24 #ifndef _OPTIONS_HXX
  25 #define _OPTIONS_HXX
  26
  27
  28 #ifndef __cplusplus
  29 # error This library requires C++
  30 #endif
  31
  32 #ifdef HAVE_CONFIG_H
  33 #  include <config.h>
  34 #endif
  35
  36 #include <Include/compiler.h>
  37
  38 #ifdef HAVE_WINDOWS_H
  39 #  include <windows.h>
  40 #endif
  41
  42 #include <GL/glut.h>
  43 #include <XGL/xgl.h>
  44
  45 #if defined(FX) && defined(XMESA)
  46 extern bool global_fullscreen;
  47 #endif
  48
  49 #include STL_STRING
  50 #include <vector>
  51
  52 FG_USING_STD(vector);
  53 FG_USING_STD(string);
  54
  55 typedef vector < string > str_container;
  56 typedef str_container::iterator str_iterator;
  57 typedef str_container::const_iterator const_str_iterator;
  58
  59
  60 class fgOPTIONS {
  61
  62 public:
  63
  64     enum
  65     {
  66         FG_OPTIONS_OK = 0,
  67         FG_OPTIONS_HELP = 1,
  68         FG_OPTIONS_ERROR = 2
  69     };
  70
  71     enum
  72     {
  73         FG_UNITS_FEET = 0,
  74         FG_UNITS_METERS = 1
  75     };
  76
  77     enum fgFogKind
  78     {
  79         FG_FOG_DISABLED = 0,
  80         FG_FOG_FASTEST  = 1,
  81         FG_FOG_NICEST   = 2
  82     };
  83
  84     enum
  85     {
  86         FG_RADIUS_MIN = 1,
  87         FG_RADIUS_MAX = 4
  88     };
  89
  90 private:
  91
  92     // The flight gear "root" directory
  93     string fg_root;
  94
  95     // Starting position and orientation
  96     string airport_id;  // ID of initial starting airport
  97     double lon;         // starting longitude in degrees (west = -)
  98     double lat;         // starting latitude in degrees (south = -)
  99     double altitude;    // starting altitude in meters
 100     double heading;     // heading (yaw) angle in degress (Psi)
 101     double roll;        // roll angle in degrees (Phi)
 102     double pitch;       // pitch angle in degrees (Theta)
 103     double uBody;       // Body axis X velocity (U)
 104     double vBody;       // Body axis Y velocity (V)
 105     double wBody;       // Body axis Z velocity (W)
 106
 107     // Miscellaneous
 108     bool game_mode;     // Game mode enabled/disabled
 109     bool splash_screen; // show splash screen
 110     bool intro_music;   // play introductory music
 111     int mouse_pointer;  // show mouse pointer
 112     bool pause;         // pause intially enabled/disabled
 113
 114     // Features
 115     bool hud_status;    // HUD on/off
 116     bool panel_status;  // Panel on/off
 117     bool sound;         // play sound effects
 118
 119     // Flight Model options
 120     int flight_model;   // Flight Model:  FG_SLEW, FG_LARCSIM, etc.
 121
 122     // Rendering options
 123     fgFogKind fog;      // Fog nicest/fastest/disabled
 124     double fov;         // Field of View
 125     bool fullscreen;    // Full screen mode enabled/disabled
 126     int shading;        // shading method, 0 = Flat, 1 = Smooth
 127     bool skyblend;      // Blend sky to haze (using polygons) or just clear
 128     bool textures;      // Textures enabled/disabled
 129     bool wireframe;     // Wireframe mode enabled/disabled
 130     int xsize, ysize;   // window size derived from geometry string
 131
 132     // Scenery options
 133     int tile_radius;   // Square radius of rendered tiles (around center
 134                        // square.)
 135     int tile_diameter; // Diameter of rendered tiles.  for instance
 136                        // if tile_diameter = 3 then a 3 x 3 grid of tiles will
 137                        // be drawn.  Increase this to see terrain that is
 138                        // further away.
 139
 140     // HUD options
 141     int units;         // feet or meters
 142     int tris_or_culled;
 143
 144     // Time options
 145     int time_offset;   // Offset true time by this many seconds
 146     long int start_gst;     // Specify a greenwich sidereal time (gst)
 147     long int start_lst;     // Specify a local sidereal time (lst)
 148
 149     // Serial Ports, we currently support up to four channels
 150     // fgSerialPortKind port_a_kind;  // Port a kind
 151     // fgSerialPortKind port_b_kind;  // Port b kind
 152     // fgSerialPortKind port_c_kind;  // Port c kind
 153     // fgSerialPortKind port_d_kind;  // Port d kind
 154
 155     // Serial port configuration strings
 156     str_container port_options_list;
 157
 158     // Network options
 159     string net_id;
 160
 161 public:
 162
 163     fgOPTIONS();
 164     ~fgOPTIONS();
 165
 166     // Parse a single option
 167     int parse_option( const string& arg );
 168
 169     // Parse the command line options
 170     int parse_command_line( int argc, char **argv );
 171
 172     // Parse the command line options
 173     int parse_config_file( const string& path );
 174
 175     // Print usage message
 176     void usage ( void );
 177
 178     // Query functions
 179     inline string get_fg_root() const { return fg_root; }
 180     inline string get_airport_id() const { return airport_id; }
 181     inline double get_lon() const { return lon; }
 182     inline double get_lat() const { return lat; }
 183     inline double get_altitude() const { return altitude; }
 184     inline double get_heading() const { return heading; }
 185     inline double get_roll() const { return roll; }
 186     inline double get_pitch() const { return pitch; }
 187     inline double get_uBody() const {return uBody;}
 188     inline double get_vBody() const {return vBody;}
 189     inline double get_wBody() const {return wBody;}
 190     inline bool get_game_mode() const { return game_mode; }
 191     inline bool get_splash_screen() const { return splash_screen; }
 192     inline bool get_intro_music() const { return intro_music; }
 193     inline int get_mouse_pointer() const { return mouse_pointer; }
 194     inline bool get_pause() const { return pause; }
 195     inline bool get_hud_status() const { return hud_status; }
 196     inline bool get_panel_status() const { return panel_status; }
 197     inline bool get_sound() const { return sound; }
 198     inline int get_flight_model() const { return flight_model; }
 199     inline bool fog_enabled() const { return fog != FG_FOG_DISABLED; }
 200     inline fgFogKind get_fog() const { return fog; }
 201     inline double get_fov() const { return fov; }
 202     inline bool get_fullscreen() const { return fullscreen; }
 203     inline int get_shading() const { return shading; }
 204     inline bool get_skyblend() const { return skyblend; }
 205     inline bool get_textures() const { return textures; }
 206     inline bool get_wireframe() const { return wireframe; }
 207     inline int get_xsize() const { return xsize; }
 208     inline int get_ysize() const { return ysize; }
 209     inline int get_tile_radius() const { return tile_radius; }
 210     inline int get_tile_diameter() const { return tile_diameter; }
 211
 212     inline int get_units() const { return units; }
 213     inline int get_tris_or_culled() const { return tris_or_culled; }
 214
 215     inline int get_time_offset() const { return time_offset; }
 216     inline long int get_start_gst() const { return start_gst; };
 217     inline long int get_start_lst() const { return start_lst; }
 218
 219     inline str_container get_port_options_list() const {
 220         return port_options_list;
 221     }
 222     inline string get_net_id() const { return net_id; }
 223
 224     // Update functions
 225     inline void set_airport_id( const string id ) { airport_id = id; }
 226     inline void set_hud_status( bool status ) { hud_status = status; }
 227     inline void set_fov( double amount ) { fov = amount; }
 228     inline void set_textures( bool status ) { textures = status; }
 229     inline void cycle_fog( void ) {
 230         if ( fog == FG_FOG_DISABLED ) {
 231             fog = FG_FOG_FASTEST;
 232         } else if ( fog == FG_FOG_FASTEST ) {
 233             fog = FG_FOG_NICEST;
 234             xglHint ( GL_FOG_HINT, GL_NICEST );
 235         } else if ( fog == FG_FOG_NICEST ) {
 236             fog = FG_FOG_DISABLED;
 237             xglHint ( GL_FOG_HINT, GL_FASTEST );
 238         }
 239     }
 240     void toggle_panel();
 241     inline void set_xsize( int x ) { xsize= x; }
 242     inline void set_ysize( int y ) { xsize= y; }
 243     inline void set_net_id( const string id ) { net_id = id; }
 244
 245 private:
 246
 247     double parse_time( const string& time_str );
 248     long int parse_date( const string& date_str );
 249     double parse_degree( const string& degree_str );
 250     int parse_time_offset( const string& time_str );
 251     int parse_tile_radius( const string& arg );
 252     int parse_fdm( const string& fm );
 253     double parse_fov( const string& arg );
 254     bool parse_serial( const string& serial_str );
 255 };
 256
 257
 258 extern fgOPTIONS current_options;
 259
 260
 261 #endif /* _OPTIONS_HXX */
 262
 263