2 // options.cxx -- class to handle command line options
4 // Written by Curtis Olson, started April 1998.
6 // Copyright (C) 1998 Curtis L. Olson - curt@me.umn.edu
8 // This program is free software; you can redistribute it and/or
9 // modify it under the terms of the GNU General Public License as
10 // published by the Free Software Foundation; either version 2 of the
11 // License, or (at your option) any later version.
13 // This program is distributed in the hope that it will be useful, but
14 // WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 // General Public License for more details.
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the Free Software
20 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 // (Log is kept at end of this file)
30 #include <math.h> // rint()
32 #include <stdlib.h> // atof(), atoi()
36 #include <Debug/fg_debug.h>
37 #include <Flight/flight.hxx>
38 #include <Include/fg_constants.h>
39 #include <Misc/fgstream.hxx>
41 #include "options.hxx"
43 const int fgOPTIONS::FG_RADIUS_MIN;
44 const int fgOPTIONS::FG_RADIUS_MAX;
47 atof( const string& str )
49 return ::atof( str.c_str() );
53 atoi( const string& str )
55 return ::atoi( str.c_str() );
58 // Defined the shared options class here
59 fgOPTIONS current_options;
63 fgOPTIONS::fgOPTIONS() :
64 // starting longitude in degrees (west = -)
65 // starting latitude in degrees (south = -)
67 // Default initial position is Globe, AZ (P13)
71 // North of the city of Globe
75 // North of the city of Globe
79 // Near where I used to live in Globe, AZ
83 // 10125 Jewell St. NE
87 // Near KHSP (Hot Springs, VA)
88 // lon(-79.8338964 + 0.01),
89 // lat( 37.9514564 + 0.008),
91 // (SEZ) SEDONA airport
92 // lon(-111.7884614 + 0.01),
93 // lat( 34.8486289 - 0.015),
95 // Somewhere near the Grand Canyon
99 // Jim Brennon's Kingmont Observatory
100 // lon(-121.1131667),
103 // Huaras, Peru (S09d 31.871' W077d 31.498')
107 // Eclipse Watching w73.5 n10 (approx) 18:00 UT
116 // lon(-90.1953055556),
117 // lat( 45.4511388889),
119 // starting altitude in meters (this will be reset to ground level
120 // if it is lower than the terrain
123 // Initial Orientation
124 heading(270.0), // heading (yaw) angle in degress (Psi)
125 roll(0.0), // roll angle in degrees (Phi)
126 pitch(0.424), // pitch angle in degrees (Theta)
140 // Flight Model options
141 flight_model(FG_LARCSIM),
144 fog(FG_FOG_NICEST), // nicest
156 units(FG_UNITS_FEET),
162 // set initial values/defaults
163 char* envp = ::getenv( "FG_ROOT" );
165 if ( envp != NULL ) {
166 // fg_root could be anywhere, so default to environmental
167 // variable $FG_ROOT if it is set.
170 // Otherwise, default to a random compiled in location if
171 // $FG_ROOT is not set. This can still be overridden from the
172 // command line or a config file.
175 fg_root = "\\FlightGear";
177 fg_root = "/usr/local/lib/FlightGear";
181 airport_id = ""; // default airport id
186 fgOPTIONS::parse_time(const string& time_in) {
187 char *time_str, num[256];
188 double hours, minutes, seconds;
193 time_str = (char *)time_in.c_str();
195 // printf("parse_time(): %s\n", time_str);
198 if ( strlen(time_str) ) {
199 if ( time_str[0] == '+' ) {
202 } else if ( time_str[0] == '-' ) {
207 // printf("sign = %d\n", sign);
210 if ( strlen(time_str) ) {
212 while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
213 num[i] = time_str[0];
217 if ( time_str[0] == ':' ) {
222 // printf("hours = %.2lf\n", hours);
228 if ( strlen(time_str) ) {
230 while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
231 num[i] = time_str[0];
235 if ( time_str[0] == ':' ) {
240 // printf("minutes = %.2lf\n", minutes);
242 result += minutes / 60.0;
246 if ( strlen(time_str) ) {
248 while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
249 num[i] = time_str[0];
255 // printf("seconds = %.2lf\n", seconds);
257 result += seconds / 3600.0;
260 return(sign * result);
264 // parse degree in the form of [+/-]hhh:mm:ss
266 fgOPTIONS::parse_degree( const string& degree_str) {
267 double result = parse_time( degree_str );
269 // printf("Degree = %.4f\n", result);
275 // parse time offset command line option
277 fgOPTIONS::parse_time_offset( const string& time_str) {
280 // printf("time offset = %s\n", time_str);
283 result = (int)rint(parse_time(time_str) * 3600.0);
285 result = (int)(parse_time(time_str) * 3600.0);
288 // printf("parse_time_offset(): %d\n", result);
294 // Parse --tile-diameter=n type option
297 fgOPTIONS::parse_tile_radius( const string& arg ) {
298 int radius = atoi( arg );
300 if ( radius < FG_RADIUS_MIN ) { radius = FG_RADIUS_MIN; }
301 if ( radius > FG_RADIUS_MAX ) { radius = FG_RADIUS_MAX; }
303 // printf("parse_tile_radius(): radius = %d\n", radius);
309 // Parse --flightmode=abcdefg type option
311 fgOPTIONS::parse_flight_model( const string& fm ) {
312 // printf("flight model = %s\n", fm);
314 if ( fm == "slew" ) {
316 } else if ( (fm == "larcsim") || (fm == "LaRCsim") ) {
319 fgPrintf( FG_GENERAL, FG_EXIT, "Unknown flight model = %s\n",
323 // we'll never get here, but it makes the compiler happy.
328 // Parse --fov=x.xx type option
330 fgOPTIONS::parse_fov( const string& arg ) {
331 double fov = atof(arg);
333 if ( fov < FG_FOV_MIN ) { fov = FG_FOV_MIN; }
334 if ( fov > FG_FOV_MAX ) { fov = FG_FOV_MAX; }
336 // printf("parse_fov(): result = %.4f\n", fov);
342 // Parse a single option
343 int fgOPTIONS::parse_option( const string& arg ) {
345 if ( (arg == "--help") || (arg == "-h") ) {
346 // help/usage request
347 return(FG_OPTIONS_HELP);
348 } else if ( arg == "--disable-game-mode") {
350 } else if ( arg == "--enable-game-mode" ) {
352 } else if ( arg == "--disable-splash-screen" ) {
353 splash_screen = false;
354 } else if ( arg == "--enable-splash-screen" ) {
355 splash_screen = true;
356 } else if ( arg == "--disable-intro-music" ) {
358 } else if ( arg == "--enable-intro-music" ) {
360 } else if ( arg == "--disable-mouse-pointer" ) {
362 } else if ( arg == "--enable-mouse-pointer" ) {
364 } else if ( arg == "--disable-pause" ) {
366 } else if ( arg == "--enable-pause" ) {
368 } else if ( arg == "--disable-hud" ) {
370 } else if ( arg == "--enable-hud" ) {
372 } else if ( arg == "--disable-panel" ) {
373 panel_status = false;
374 } else if ( arg == "--enable-panel" ) {
376 } else if ( arg == "--disable-sound" ) {
378 } else if ( arg == "--enable-sound" ) {
380 } else if ( arg.find( "--airport-id=") != string::npos ) {
381 airport_id = arg.substr( 13 );
382 } else if ( arg.find( "--lon=" ) != string::npos ) {
383 lon = parse_degree( arg.substr(6) );
384 } else if ( arg.find( "--lat=" ) != string::npos ) {
385 lat = parse_degree( arg.substr(6) );
386 } else if ( arg.find( "--altitude=" ) != string::npos ) {
387 altitude = atof( arg.substr(11) );
388 } else if ( arg.find( "--heading=" ) != string::npos ) {
389 heading = atof( arg.substr(10) );
390 } else if ( arg.find( "--roll=" ) != string::npos ) {
391 roll = atof( arg.substr(7) );
392 } else if ( arg.find( "--pitch=" ) != string::npos ) {
393 pitch = atof( arg.substr(8) );
394 } else if ( arg.find( "--fg-root=" ) != string::npos ) {
395 fg_root = arg.substr( 10 );
396 } else if ( arg.find( "--flight-model=" ) != string::npos ) {
397 flight_model = parse_flight_model( arg.substr(15) );
398 } else if ( arg == "--fog-disable" ) {
399 fog = FG_FOG_DISABLED;
400 } else if ( arg == "--fog-fastest" ) {
401 fog = FG_FOG_FASTEST;
402 } else if ( arg == "--fog-nicest" ) {
404 } else if ( arg.find( "--fov=" ) != string::npos ) {
405 fov = parse_fov( arg.substr(6) );
406 } else if ( arg == "--disable-fullscreen" ) {
408 } else if ( arg== "--enable-fullscreen") {
410 } else if ( arg == "--shading-flat") {
412 } else if ( arg == "--shading-smooth") {
414 } else if ( arg == "--disable-skyblend") {
416 } else if ( arg== "--enable-skyblend" ) {
418 } else if ( arg == "--disable-textures" ) {
420 } else if ( arg == "--enable-textures" ) {
422 } else if ( arg == "--disable-wireframe" ) {
424 } else if ( arg == "--enable-wireframe" ) {
426 } else if ( arg == "--units-feet" ) {
427 units = FG_UNITS_FEET;
428 } else if ( arg == "--units-meters" ) {
429 units = FG_UNITS_METERS;
430 } else if ( arg.find( "--tile-radius=" ) != string::npos ) {
431 tile_radius = parse_tile_radius( arg.substr(14) );
432 tile_diameter = tile_radius * 2 + 1;
433 } else if ( arg.find( "--time-offset=" ) != string::npos ) {
434 time_offset = parse_time_offset( (arg.substr(14)) );
435 } else if ( arg == "--hud-tris" ) {
437 } else if ( arg == "--hud-culled" ) {
440 fgPrintf( FG_GENERAL, FG_EXIT, "Unknown option '%s'\n",
442 return(FG_OPTIONS_ERROR);
445 return(FG_OPTIONS_OK);
449 // Parse the command line options
450 int fgOPTIONS::parse_command_line( int argc, char **argv ) {
454 fgPrintf(FG_GENERAL, FG_INFO, "Processing command line arguments\n");
457 fgPrintf(FG_GENERAL, FG_DEBUG, "argv[%d] = %s\n", i, argv[i]);
459 result = parse_option(argv[i]);
460 if ( (result == FG_OPTIONS_HELP) || (result == FG_OPTIONS_ERROR) ) {
467 return(FG_OPTIONS_OK);
471 // Parse config file options
472 int fgOPTIONS::parse_config_file( const string& path ) {
473 fg_gzifstream in( path );
475 return(FG_OPTIONS_ERROR);
477 fgPrintf( FG_GENERAL, FG_INFO, "Processing config file: %s\n",
486 if ( parse_option( line ) == FG_OPTIONS_ERROR ) {
487 fgPrintf( FG_GENERAL, FG_EXIT,
488 "Config file parse error: %s '%s'\n",
489 path.c_str(), line.c_str() );
494 return FG_OPTIONS_OK;
498 // Print usage message
499 void fgOPTIONS::usage ( void ) {
500 printf("Usage: fg [ options ... ]\n");
503 printf("General Options:\n");
504 printf("\t--help -h: print usage\n");
505 printf("\t--fg-root=path: specify the root path for all the data files\n");
506 printf("\t--disable-game-mode: disable full-screen game mode\n");
507 printf("\t--enable-game-mode: enable full-screen game mode\n");
508 printf("\t--disable-splash-screen: disable splash screen\n");
509 printf("\t--enable-splash-screen: enable splash screen\n");
510 printf("\t--disable-intro-music: disable introduction music\n");
511 printf("\t--enable-intro-music: enable introduction music\n");
512 printf("\t--disable-mouse-pointer: disable extra mouse pointer\n");
513 printf("\t--enable-mouse-pointer: enable extra mouse pointer (i.e. for\n");
514 printf("\t\tfull screen voodoo/voodoo-II based cards.)\n");
515 printf("\t--disable-pause: start out in an active state\n");
516 printf("\t--enable-pause: start out in a paused state\n");
519 printf("Features:\n");
520 printf("\t--disable-hud: disable heads up display\n");
521 printf("\t--enable-hud: enable heads up display\n");
522 printf("\t--disable-panel: disable instrument panel\n");
523 printf("\t--enable-panel: enable instrumetn panel\n");
524 printf("\t--disable-sound: disable sound effects\n");
525 printf("\t--enable-sound: enable sound effects\n");
528 printf("Initial Position and Orientation:\n");
529 printf("\t--airport-id=ABCD: specify starting postion by airport id\n");
530 printf("\t--lon=degrees: starting longitude in degrees (west = -)\n");
531 printf("\t--lat=degrees: starting latitude in degrees (south = -)\n");
532 printf("\t--altitude=meters: starting altitude in meters\n");
533 printf("\t--heading=degrees: heading (yaw) angle in degress (Psi)\n");
534 printf("\t--roll=degrees: roll angle in degrees (Phi)\n");
535 printf("\t--pitch=degrees: pitch angle in degrees (Theta)\n");
538 printf("Rendering Options:\n");
539 printf("\t--fog-disable: disable fog/haze\n");
540 printf("\t--fog-fastest: enable fastest fog/haze\n");
541 printf("\t--fog-nicest: enable nicest fog/haze\n");
542 printf("\t--fov=xx.x: specify initial field of view angle in degrees\n");
543 printf("\t--disable-fullscreen: disable fullscreen mode\n");
544 printf("\t--enable-fullscreen: enable fullscreen mode\n");
545 printf("\t--shading-flat: enable flat shading\n");
546 printf("\t--shading-smooth: enable smooth shading\n");
547 printf("\t--disable-skyblend: disable sky blending\n");
548 printf("\t--enable-skyblend: enable sky blending\n");
549 printf("\t--disable-textures: disable textures\n");
550 printf("\t--enable-textures: enable textures\n");
551 printf("\t--disable-wireframe: disable wireframe drawing mode\n");
552 printf("\t--enable-wireframe: enable wireframe drawing mode\n");
555 printf("Scenery Options:\n");
556 printf("\t--tile-radius=n: specify tile radius, must be 1 - 4\n");
559 printf("Hud Options:\n");
560 printf("\t--units-feet: Hud displays units in feet\n");
561 printf("\t--units-meters: Hud displays units in meters\n");
562 printf("\t--hud-tris: Hud displays number of triangles rendered\n");
563 printf("\t--hud-culled: Hud displays percentage of triangles culled\n");
565 printf("Time Options:\n");
566 printf("\t--time-offset=[+-]hh:mm:ss: offset local time by this amount\n");
571 fgOPTIONS::~fgOPTIONS( void ) {
576 // Revision 1.28 1998/11/06 14:47:03 curt
577 // Changes to track Bernie's updates to fgstream.
579 // Revision 1.27 1998/11/02 23:04:04 curt
580 // HUD units now display in feet by default with meters being a command line
583 // Revision 1.26 1998/10/17 01:34:24 curt
586 // Revision 1.25 1998/09/15 02:09:27 curt
587 // Include/fg_callback.hxx
588 // Moved code inline to stop g++ 2.7 from complaining.
590 // Simulator/Time/event.[ch]xx
591 // Changed return type of fgEVENT::printStat(). void caused g++ 2.7 to
592 // complain bitterly.
594 // Minor bugfix and changes.
596 // Simulator/Main/GLUTmain.cxx
597 // Added missing type to idle_state definition - eliminates a warning.
599 // Simulator/Main/fg_init.cxx
600 // Changes to airport lookup.
602 // Simulator/Main/options.cxx
603 // Uses fg_gzifstream when loading config file.
605 // Revision 1.24 1998/09/08 15:04:33 curt
606 // Optimizations by Norman Vine.
608 // Revision 1.23 1998/08/27 17:02:07 curt
609 // Contributions from Bernie Bright <bbright@c031.aone.net.au>
610 // - use strings for fg_root and airport_id and added methods to return
612 // - inlined all access methods,
613 // - made the parsing functions private methods,
614 // - deleted some unused functions.
615 // - propogated some of these changes out a bit further.
617 // Revision 1.22 1998/08/24 20:11:13 curt
618 // Added i/I to toggle full vs. minimal HUD.
619 // Added a --hud-tris vs --hud-culled option.
620 // Moved options accessor funtions to options.hxx.
622 // Revision 1.21 1998/08/20 15:10:34 curt
623 // Added GameGLUT support.
625 // Revision 1.20 1998/07/30 23:48:28 curt
626 // Output position & orientation when pausing.
627 // Eliminated libtool use.
628 // Added options to specify initial position and orientation.
629 // Changed default fov to 55 degrees.
630 // Added command line option to start in paused or unpaused state.
632 // Revision 1.19 1998/07/27 18:41:25 curt
633 // Added a pause command "p"
634 // Fixed some initialization order problems between pui and glut.
635 // Added an --enable/disable-sound option.
637 // Revision 1.18 1998/07/22 01:27:03 curt
638 // Strip out \r when parsing config file in case we are on a windoze system.
640 // Revision 1.17 1998/07/16 17:33:38 curt
641 // "H" / "h" now control hud brightness as well with off being one of the
643 // Better checking for xmesa/fx 3dfx fullscreen/window support for deciding
644 // whether or not to build in the feature.
645 // Translucent menu support.
646 // HAVE_AUDIO_SUPPORT -> ENABLE_AUDIO_SUPPORT
647 // Use fork() / wait() for playing mp3 init music in background under unix.
648 // Changed default tile diameter to 5.
650 // Revision 1.16 1998/07/13 21:01:39 curt
651 // Wrote access functions for current fgOPTIONS.
653 // Revision 1.15 1998/07/06 21:34:19 curt
654 // Added an enable/disable splash screen option.
655 // Added an enable/disable intro music option.
656 // Added an enable/disable instrument panel option.
657 // Added an enable/disable mouse pointer option.
658 // Added using namespace std for compilers that support this.
660 // Revision 1.14 1998/07/04 00:52:26 curt
661 // Add my own version of gluLookAt() (which is nearly identical to the
662 // Mesa/glu version.) But, by calculating the Model View matrix our selves
663 // we can save this matrix without having to read it back in from the video
664 // card. This hopefully allows us to save a few cpu cycles when rendering
665 // out the fragments because we can just use glLoadMatrixd() with the
666 // precalculated matrix for each tile rather than doing a push(), translate(),
667 // pop() for every fragment.
669 // Panel status defaults to off for now until it gets a bit more developed.
671 // Extract OpenGL driver info on initialization.
673 // Revision 1.13 1998/06/27 16:54:34 curt
674 // Replaced "extern displayInstruments" with a entry in fgOPTIONS.
675 // Don't change the view port when displaying the panel.
677 // Revision 1.12 1998/06/17 21:35:13 curt
678 // Refined conditional audio support compilation.
679 // Moved texture parameter setup calls to ../Scenery/materials.cxx
680 // #include <string.h> before various STL includes.
681 // Make HUD default state be enabled.
683 // Revision 1.11 1998/06/13 00:40:33 curt
684 // Tweaked fog command line options.
686 // Revision 1.10 1998/05/16 13:08:36 curt
687 // C++ - ified views.[ch]xx
688 // Shuffled some additional view parameters into the fgVIEW class.
689 // Changed tile-radius to tile-diameter because it is a much better
691 // Added a WORLD_TO_EYE transformation to views.cxx. This allows us
692 // to transform world space to eye space for view frustum culling.
694 // Revision 1.9 1998/05/13 18:29:59 curt
695 // Added a keyboard binding to dynamically adjust field of view.
696 // Added a command line option to specify fov.
697 // Adjusted terrain color.
698 // Root path info moved to fgOPTIONS.
699 // Added ability to parse options out of a config file.
701 // Revision 1.8 1998/05/07 23:14:16 curt
702 // Added "D" key binding to set autopilot heading.
703 // Made frame rate calculation average out over last 10 frames.
704 // Borland C++ floating point exception workaround.
705 // Added a --tile-radius=n option.
707 // Revision 1.7 1998/05/06 03:16:25 curt
708 // Added an averaged global frame rate counter.
709 // Added an option to control tile radius.
711 // Revision 1.6 1998/05/03 00:47:32 curt
712 // Added an option to enable/disable full-screen mode.
714 // Revision 1.5 1998/04/30 12:34:19 curt
715 // Added command line rendering options:
716 // enable/disable fog/haze
717 // specify smooth/flat shading
718 // disable sky blending and just use a solid color
719 // enable wireframe drawing mode
721 // Revision 1.4 1998/04/28 01:20:22 curt
722 // Type-ified fgTIME and fgVIEW.
723 // Added a command line option to disable textures.
725 // Revision 1.3 1998/04/26 05:01:19 curt
726 // Added an rint() / HAVE_RINT check.
728 // Revision 1.2 1998/04/25 15:11:12 curt
729 // Added an command line option to set starting position based on airport ID.
731 // Revision 1.1 1998/04/24 00:49:21 curt
732 // Wrapped "#include <config.h>" in "#ifdef HAVE_CONFIG_H"
733 // Trying out some different option parsing code.
734 // Some code reorganization.