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 <simgear/compiler.h>
  37
  38 #ifdef HAVE_WINDOWS_H
  39 #  include <windows.h>
  40 #endif
  41
  42 #include <GL/glut.h>
  43 #include <simgear/xgl/xgl.h>
  44
  45 #if defined(FX) && defined(XMESA)
  46 extern bool global_fullscreen;
  47 #endif
  48
  49 #include <simgear/math/sg_types.hxx>
  50 #include <simgear/timing/sg_time.hxx>
  51
  52 #include STL_STRING
  53 #include <vector>
  54
  55 FG_USING_STD(vector);
  56 FG_USING_STD(string);
  57
  58 #define NEW_DEFAULT_MODEL_HZ 120
  59
  60
  61 class FGOptions {
  62
  63 public:
  64
  65     enum
  66     {
  67         FG_OPTIONS_OK = 0,
  68         FG_OPTIONS_HELP = 1,
  69         FG_OPTIONS_ERROR = 2
  70     };
  71
  72     enum
  73     {
  74         FG_UNITS_FEET = 0,
  75         FG_UNITS_METERS = 1
  76     };
  77
  78     enum fgFogKind
  79     {
  80         FG_FOG_DISABLED = 0,
  81         FG_FOG_FASTEST  = 1,
  82         FG_FOG_NICEST   = 2
  83     };
  84
  85     enum
  86     {
  87         FG_RADIUS_MIN = 1,
  88         FG_RADIUS_MAX = 4
  89     };
  90
  91     enum fgControlMode
  92     {
  93         FG_JOYSTICK = 0,
  94         FG_KEYBOARD = 1,
  95         FG_MOUSE = 2
  96     };
  97
  98     enum fgViewMode
  99     {
 100         FG_VIEW_PILOT = 0,      // Pilot perspective
 101         FG_VIEW_FOLLOW  = 1,    // Following in the "foot steps" so to speak
 102         FG_VIEW_CHASE = 2,      // Chase
 103         FG_VIEW_CIRCLING = 3,   // Circling
 104         FG_VIEW_SATELLITE = 4,  // From high above
 105         FG_VIEW_ANCHOR = 5,     // Drop an anchor and watch from there
 106         FG_VIEW_TOWER = 6,      // From nearest tower?
 107         FG_VIEW_SPOTTER = 7     // Fron a ground spotter
 108     };
 109
 110     enum fgAutoCoordMode
 111     {
 112         FG_AUTO_COORD_NOT_SPECIFIED = 0,
 113         FG_AUTO_COORD_DISABLED = 1,
 114         FG_AUTO_COORD_ENABLED = 2
 115     };
 116
 117     enum fgTimingOffsetType {
 118         FG_TIME_SYS_OFFSET   = 0,
 119         FG_TIME_GMT_OFFSET   = 1,
 120         FG_TIME_LAT_OFFSET   = 2,
 121         FG_TIME_SYS_ABSOLUTE = 3,
 122         FG_TIME_GMT_ABSOLUTE = 4,
 123         FG_TIME_LAT_ABSOLUTE = 5
 124     };
 125
 126 private:
 127
 128     // The flight gear "root" directory
 129     string fg_root;
 130
 131     // The scenery "root" directory
 132     string fg_scenery;
 133
 134     // Starting position and orientation
 135     string airport_id;  // ID of initial starting airport
 136     double lon;         // starting longitude in degrees (west = -)
 137     double lat;         // starting latitude in degrees (south = -)
 138     double altitude;    // starting altitude in meters
 139     double heading;     // heading (yaw) angle in degress (Psi)
 140     double roll;        // roll angle in degrees (Phi)
 141     double pitch;       // pitch angle in degrees (Theta)
 142     double uBody;       // Body axis X velocity (U)
 143     double vBody;       // Body axis Y velocity (V)
 144     double wBody;       // Body axis Z velocity (W)
 145     double vkcas;       // Calibrated airspeed, knots
 146     double mach;        // Mach number
 147
 148     // Miscellaneous
 149     bool game_mode;     // Game mode enabled/disabled
 150     bool splash_screen; // show splash screen
 151     bool intro_music;   // play introductory music
 152     int mouse_pointer;  // show mouse pointer
 153     fgControlMode control_mode; // primary control mode
 154     fgAutoCoordMode auto_coordination;  // enable auto coordination
 155
 156     // Features
 157     bool hud_status;    // HUD on/off
 158     bool panel_status;  // Panel on/off
 159     bool sound;         // play sound effects
 160     bool anti_alias_hud;
 161
 162     // Flight Model options
 163     int flight_model;   // Core flight model code:  jsb, larcsim, magic, etc.
 164     string aircraft;    // Aircraft to model
 165     int model_hz;       // number of FDM iterations per second
 166     int speed_up;       // Sim mechanics run this much faster than normal speed
 167     int trim;           // use the FDM trimming routine during init
 168                         // <0 --notrim set, 0 no trim, >0 trim
 169                         // default behavior is to enable trimming for jsbsim
 170                         // disable for all other fdm's
 171
 172     // Rendering options
 173     fgFogKind fog;      // Fog nicest/fastest/disabled
 174     bool clouds;        // Enable clouds
 175     double clouds_asl;  // Cloud layer height above sea level
 176     double fov;         // Field of View
 177     bool fullscreen;    // Full screen mode enabled/disabled
 178     int shading;        // shading method, 0 = Flat, 1 = Smooth
 179     bool skyblend;      // Blend sky to haze (using polygons) or just clear
 180     bool textures;      // Textures enabled/disabled
 181     bool wireframe;     // Wireframe mode enabled/disabled
 182     int xsize, ysize;   // window size derived from geometry string
 183     int bpp;            // bits per pixel
 184     fgViewMode view_mode; // view mode
 185     double default_view_offset; // default forward view offset (for use by
 186                                 // multi-display configuration
 187
 188     // Scenery options
 189     int tile_radius;   // Square radius of rendered tiles (around center
 190                        // square.)
 191     int tile_diameter; // Diameter of rendered tiles.  for instance
 192                        // if tile_diameter = 3 then a 3 x 3 grid of tiles will
 193                        // be drawn.  Increase this to see terrain that is
 194                        // further away.
 195
 196     // HUD options
 197     int units;         // feet or meters
 198     int tris_or_culled;
 199
 200     // Time options
 201     int time_offset;            // Use this value to change time.
 202     fgTimingOffsetType time_offset_type; // Will be set to one of the
 203                                 // FG_TIME_* enums, to deterine how
 204                                 // time_offset should be used
 205
 206     // Serial port configuration strings
 207     string_list channel_options_list;
 208
 209     // Network options
 210     bool network_olk;
 211     string net_id;
 212
 213 public:
 214
 215     FGOptions();
 216     ~FGOptions();
 217
 218     // Parse a single option
 219     int parse_option( const string& arg );
 220
 221     // Scan the command line options for an fg_root definition and set
 222     // just that.
 223     int scan_command_line_for_root( int argc, char **argv );
 224
 225     // Scan the config file for an fg_root definition and set just
 226     // that.
 227     int scan_config_file_for_root( const string& path );
 228
 229     // Parse the command line options
 230     int parse_command_line( int argc, char **argv );
 231
 232     // Parse the command line options
 233     int parse_config_file( const string& path );
 234
 235     // Print usage message
 236     void usage ( void );
 237
 238     // Query functions
 239     inline string get_fg_root() const { return fg_root; }
 240     inline string get_fg_scenery() const { return fg_scenery; }
 241     inline string get_airport_id() const { return airport_id; }
 242     inline double get_lon() const { return lon; }
 243     inline double get_lat() const { return lat; }
 244     inline double get_altitude() const { return altitude; }
 245     inline double get_heading() const { return heading; }
 246     inline double get_roll() const { return roll; }
 247     inline double get_pitch() const { return pitch; }
 248     inline double get_uBody() const {return uBody;}
 249     inline double get_vBody() const {return vBody;}
 250     inline double get_wBody() const {return wBody;}
 251     inline double get_vc() const {return vkcas;}
 252     inline double get_mach() const {return mach;}
 253
 254     inline bool get_game_mode() const { return game_mode; }
 255     inline bool get_splash_screen() const { return splash_screen; }
 256     inline bool get_intro_music() const { return intro_music; }
 257     inline int get_mouse_pointer() const { return mouse_pointer; }
 258     inline bool get_anti_alias_hud() const { return anti_alias_hud; }
 259     inline fgControlMode get_control_mode() const { return control_mode; }
 260     inline void set_control_mode( fgControlMode mode ) { control_mode = mode; }
 261     inline fgAutoCoordMode get_auto_coordination() const {
 262         return auto_coordination;
 263     }
 264     inline void set_auto_coordination(fgAutoCoordMode m) {
 265         auto_coordination = m;
 266     }
 267     inline bool get_hud_status() const { return hud_status; }
 268     inline bool get_panel_status() const { return panel_status; }
 269     inline bool get_sound() const { return sound; }
 270     inline int get_flight_model() const { return flight_model; }
 271     inline string get_aircraft() const { return aircraft; }
 272     inline int get_model_hz() const { return model_hz; }
 273     inline int get_speed_up() const { return speed_up; }
 274     inline void set_speed_up( int speed ) { speed_up = speed; }
 275     inline int get_trim_mode(void) { return trim; }
 276
 277     inline bool fog_enabled() const { return fog != FG_FOG_DISABLED; }
 278     inline fgFogKind get_fog() const { return fog; }
 279     inline bool get_clouds() const { return clouds; }
 280     inline double get_clouds_asl() const { return clouds_asl; }
 281     inline double get_fov() const { return fov; }
 282     inline bool get_fullscreen() const { return fullscreen; }
 283     inline int get_shading() const { return shading; }
 284     inline bool get_skyblend() const { return skyblend; }
 285     inline bool get_textures() const { return textures; }
 286     inline bool get_wireframe() const { return wireframe; }
 287     inline int get_xsize() const { return xsize; }
 288     inline int get_ysize() const { return ysize; }
 289     inline int get_bpp() const { return bpp; }
 290     inline fgViewMode get_view_mode() const { return view_mode; }
 291     inline double get_default_view_offset() const {
 292         return default_view_offset;
 293     }
 294
 295
 296     inline int get_tile_radius() const { return tile_radius; }
 297     inline int get_tile_diameter() const { return tile_diameter; }
 298
 299     inline int get_units() const { return units; }
 300     inline int get_tris_or_culled() const { return tris_or_culled; }
 301
 302     inline int get_time_offset() const { return time_offset; }
 303     inline fgTimingOffsetType  get_time_offset_type() const {
 304         return time_offset_type;
 305     };
 306
 307     inline string_list get_channel_options_list() const {
 308         return channel_options_list;
 309     }
 310
 311     inline bool get_network_olk() const { return network_olk; }
 312     inline string get_net_id() const { return net_id; }
 313
 314     // Update functions
 315     inline void set_fg_root (const string value) { fg_root = value; }
 316     inline void set_fg_scenery (const string value) { fg_scenery = value; }
 317     inline void set_airport_id( const string id ) { airport_id = id; }
 318     inline void set_lon (double value) { lon = value; }
 319     inline void set_lat (double value) { lat = value; }
 320     inline void set_altitude (double value) { altitude = value; }
 321     inline void set_heading (double value) { heading = value; }
 322     inline void set_roll (double value) { roll = value; }
 323     inline void set_pitch (double value) { pitch = value; }
 324     inline void set_uBody (double value) { uBody = value; }
 325     inline void set_vBody (double value) { vBody = value; }
 326     inline void set_wBody (double value) { wBody = value; }
 327     inline void set_vc (double value) { vkcas = value; }
 328     inline void set_mach(double value) { mach = value; }
 329     inline void set_game_mode (bool value) { game_mode = value; }
 330     inline void set_splash_screen (bool value) { splash_screen = value; }
 331     inline void set_intro_music (bool value) { intro_music = value; }
 332     inline void set_mouse_pointer (int value) { mouse_pointer = value; }
 333     inline void set_anti_alias_hud (bool value) { anti_alias_hud = value; }
 334     inline void set_hud_status( bool status ) { hud_status = status; }
 335     inline void set_sound (bool value) { sound = value; }
 336     inline void set_flight_model (int value) { flight_model = value; }
 337     inline void set_aircraft (const string &ac) { aircraft = ac; }
 338     inline void set_model_hz (int value) { model_hz = value; }
 339     inline void set_trim_mode(int value) { trim = value; }
 340     inline void set_fog (fgFogKind value) { fog = value; }
 341     inline void set_clouds( bool value ) { clouds = value; }
 342     inline void set_clouds_asl( double value ) { clouds_asl = value; }
 343     inline void set_fov( double amount ) { fov = amount; }
 344     inline void set_fullscreen (bool value) { fullscreen = value; }
 345     inline void set_shading (int value) { shading = value; }
 346     inline void set_skyblend (bool value) { skyblend = value; }
 347     inline void set_textures( bool status ) { textures = status; }
 348     inline void set_wireframe (bool status) { wireframe = status; }
 349     inline void cycle_fog( void ) {
 350         if ( fog == FG_FOG_DISABLED ) {
 351             fog = FG_FOG_FASTEST;
 352         } else if ( fog == FG_FOG_FASTEST ) {
 353             fog = FG_FOG_NICEST;
 354             xglHint ( GL_FOG_HINT, GL_NICEST );
 355         } else if ( fog == FG_FOG_NICEST ) {
 356             fog = FG_FOG_DISABLED;
 357             xglHint ( GL_FOG_HINT, GL_FASTEST );
 358         }
 359     }
 360     void toggle_panel();
 361     inline void set_xsize( int x ) { xsize = x; }
 362     inline void set_ysize( int y ) { ysize = y; }
 363     inline void set_view_mode (fgViewMode value) { view_mode = value; }
 364     inline void set_tile_radius (int value) { tile_radius = value; }
 365     inline void set_tile_diameter (int value) { tile_diameter = value; }
 366     inline void set_units (int value) { units = value; }
 367     inline void set_tris_or_culled (int value) { tris_or_culled = value; }
 368     inline void set_time_offset (int value) { time_offset = value; }
 369     inline void set_time_offset_type (fgTimingOffsetType value) {
 370         time_offset_type = value;
 371     }
 372     inline void cycle_view_mode() {
 373         if ( view_mode == FG_VIEW_PILOT ) {
 374             view_mode = FG_VIEW_FOLLOW;
 375         } else if ( view_mode == FG_VIEW_FOLLOW ) {
 376             view_mode = FG_VIEW_PILOT;
 377         }
 378     }
 379
 380     inline void set_network_olk( bool net ) { network_olk = net; }
 381     inline void set_net_id( const string id ) { net_id = id; }
 382
 383 private:
 384
 385     void parse_control( const string& mode );
 386     double parse_time( const string& time_str );
 387     long int parse_date( const string& date_str );
 388     double parse_degree( const string& degree_str );
 389     int parse_time_offset( const string& time_str );
 390     int parse_tile_radius( const string& arg );
 391     int parse_fdm( const string& fm );
 392     double parse_fov( const string& arg );
 393     bool parse_channel( const string& type, const string& channel_str );
 394     bool parse_wp( const string& arg );
 395 };
 396
 397
 398 // extern FGOptions current_options;
 399
 400
 401 #endif /* _OPTIONS_HXX */
 402
 403