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.h>
38 #include <Include/fg_constants.h>
39 #include <Include/fg_zlib.h>
41 #include "options.hxx"
44 atof( const string& str )
46 return ::atof( str.c_str() );
50 atoi( const string& str )
52 return ::atoi( str.c_str() );
55 // Defined the shared options class here
56 fgOPTIONS current_options;
60 fgOPTIONS::fgOPTIONS() :
61 // starting longitude in degrees (west = -)
62 // starting latitude in degrees (south = -)
64 // Default initial position is Globe, AZ (P13)
68 // North of the city of Globe
72 // North of the city of Globe
76 // Near where I used to live in Globe, AZ
80 // 10125 Jewell St. NE
84 // Near KHSP (Hot Springs, VA)
85 // lon(-79.8338964 + 0.01),
86 // lat( 37.9514564 + 0.008),
88 // (SEZ) SEDONA airport
89 // lon(-111.7884614 + 0.01),
90 // lat( 34.8486289 - 0.015),
92 // Somewhere near the Grand Canyon
96 // Jim Brennon's Kingmont Observatory
100 // Huaras, Peru (S09d 31.871' W077d 31.498')
104 // Eclipse Watching w73.5 n10 (approx) 18:00 UT
113 // lon(-90.1953055556),
114 // lat( 45.4511388889),
116 // starting altitude in meters (this will be reset to ground level
117 // if it is lower than the terrain
120 // Initial Orientation
121 heading(270.0), // heading (yaw) angle in degress (Psi)
122 roll(0.0), // roll angle in degrees (Phi)
123 pitch(0.424), // pitch angle in degrees (Theta)
137 // Flight Model options
138 flight_model(FG_LARCSIM),
141 fog(FG_FOG_NICEST), // nicest
158 // set initial values/defaults
159 char* envp = ::getenv( "FG_ROOT" );
161 if ( envp != NULL ) {
162 // fg_root could be anywhere, so default to environmental
163 // variable $FG_ROOT if it is set.
166 // Otherwise, default to a random compiled in location if
167 // $FG_ROOT is not set. This can still be overridden from the
168 // command line or a config file.
171 fg_root = "\\FlightGear";
173 fg_root = "/usr/local/lib/FlightGear";
177 airport_id = ""; // default airport id
182 fgOPTIONS::parse_time(const string& time_in) {
183 char *time_str, num[256];
184 double hours, minutes, seconds;
189 time_str = (char *)time_in.c_str();
191 // printf("parse_time(): %s\n", time_str);
194 if ( strlen(time_str) ) {
195 if ( time_str[0] == '+' ) {
198 } else if ( time_str[0] == '-' ) {
203 // printf("sign = %d\n", sign);
206 if ( strlen(time_str) ) {
208 while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
209 num[i] = time_str[0];
213 if ( time_str[0] == ':' ) {
218 // printf("hours = %.2lf\n", hours);
224 if ( strlen(time_str) ) {
226 while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
227 num[i] = time_str[0];
231 if ( time_str[0] == ':' ) {
236 // printf("minutes = %.2lf\n", minutes);
238 result += minutes / 60.0;
242 if ( strlen(time_str) ) {
244 while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
245 num[i] = time_str[0];
251 // printf("seconds = %.2lf\n", seconds);
253 result += seconds / 3600.0;
256 return(sign * result);
260 // parse degree in the form of [+/-]hhh:mm:ss
262 fgOPTIONS::parse_degree( const string& degree_str) {
263 double result = parse_time( degree_str );
265 // printf("Degree = %.4f\n", result);
271 // parse time offset command line option
273 fgOPTIONS::parse_time_offset( const string& time_str) {
276 // printf("time offset = %s\n", time_str);
279 result = (int)rint(parse_time(time_str) * 3600.0);
281 result = (int)(parse_time(time_str) * 3600.0);
284 // printf("parse_time_offset(): %d\n", result);
290 // Parse --tile-diameter=n type option
293 fgOPTIONS::parse_tile_radius( const string& arg ) {
294 int radius = atoi( arg );
296 if ( radius < FG_RADIUS_MIN ) { radius = FG_RADIUS_MIN; }
297 if ( radius > FG_RADIUS_MAX ) { radius = FG_RADIUS_MAX; }
299 // printf("parse_tile_radius(): radius = %d\n", radius);
305 // Parse --flightmode=abcdefg type option
307 fgOPTIONS::parse_flight_model( const string& fm ) {
308 // printf("flight model = %s\n", fm);
310 if ( fm == "slew" ) {
312 } else if ( (fm == "larcsim") || (fm == "LaRCsim") ) {
315 fgPrintf( FG_GENERAL, FG_EXIT, "Unknown flight model = %s\n",
319 // we'll never get here, but it makes the compiler happy.
324 // Parse --fov=x.xx type option
326 fgOPTIONS::parse_fov( const string& arg ) {
327 double fov = atof(arg);
329 if ( fov < FG_FOV_MIN ) { fov = FG_FOV_MIN; }
330 if ( fov > FG_FOV_MAX ) { fov = FG_FOV_MAX; }
332 // printf("parse_fov(): result = %.4f\n", fov);
338 // Parse a single option
339 int fgOPTIONS::parse_option( const string& arg ) {
341 if ( (arg == "--help") || (arg == "-h") ) {
342 // help/usage request
343 return(FG_OPTIONS_HELP);
344 } else if ( arg == "--disable-game-mode") {
346 } else if ( arg == "--enable-game-mode" ) {
348 } else if ( arg == "--disable-splash-screen" ) {
349 splash_screen = false;
350 } else if ( arg == "--enable-splash-screen" ) {
351 splash_screen = true;
352 } else if ( arg == "--disable-intro-music" ) {
354 } else if ( arg == "--enable-intro-music" ) {
356 } else if ( arg == "--disable-mouse-pointer" ) {
358 } else if ( arg == "--enable-mouse-pointer" ) {
360 } else if ( arg == "--disable-pause" ) {
362 } else if ( arg == "--enable-pause" ) {
364 } else if ( arg == "--disable-hud" ) {
366 } else if ( arg == "--enable-hud" ) {
368 } else if ( arg == "--disable-panel" ) {
369 panel_status = false;
370 } else if ( arg == "--enable-panel" ) {
372 } else if ( arg == "--disable-sound" ) {
374 } else if ( arg == "--enable-sound" ) {
376 } else if ( arg.find( "--airport-id=") != string::npos ) {
377 airport_id = arg.substr( 13 );
378 } else if ( arg.find( "--lon=" ) != string::npos ) {
379 lon = parse_degree( arg.substr(6) );
380 } else if ( arg.find( "--lat=" ) != string::npos ) {
381 lat = parse_degree( arg.substr(6) );
382 } else if ( arg.find( "--altitude=" ) != string::npos ) {
383 altitude = atof( arg.substr(11) );
384 } else if ( arg.find( "--heading=" ) != string::npos ) {
385 heading = atof( arg.substr(10) );
386 } else if ( arg.find( "--roll=" ) != string::npos ) {
387 roll = atof( arg.substr(7) );
388 } else if ( arg.find( "--pitch=" ) != string::npos ) {
389 pitch = atof( arg.substr(8) );
390 } else if ( arg.find( "--fg-root=" ) != string::npos ) {
391 fg_root = arg.substr( 10 );
392 } else if ( arg.find( "--flight-model=" ) != string::npos ) {
393 flight_model = parse_flight_model( arg.substr(15) );
394 } else if ( arg == "--fog-disable" ) {
395 fog = FG_FOG_DISABLED;
396 } else if ( arg == "--fog-fastest" ) {
397 fog = FG_FOG_FASTEST;
398 } else if ( arg == "--fog-nicest" ) {
400 } else if ( arg.find( "--fov=" ) != string::npos ) {
401 fov = parse_fov( arg.substr(6) );
402 } else if ( arg == "--disable-fullscreen" ) {
404 } else if ( arg== "--enable-fullscreen") {
406 } else if ( arg == "--shading-flat") {
408 } else if ( arg == "--shading-smooth") {
410 } else if ( arg == "--disable-skyblend") {
412 } else if ( arg== "--enable-skyblend" ) {
414 } else if ( arg == "--disable-textures" ) {
416 } else if ( arg == "--enable-textures" ) {
418 } else if ( arg == "--disable-wireframe" ) {
420 } else if ( arg == "--enable-wireframe" ) {
422 } else if ( arg.find( "--tile-radius=" ) != string::npos ) {
423 tile_radius = parse_tile_radius( arg.substr(14) );
424 tile_diameter = tile_radius * 2 + 1;
425 } else if ( arg.find( "--time-offset=" ) != string::npos ) {
426 time_offset = parse_time_offset( (arg.substr(14)) );
427 } else if ( arg == "--hud-tris" ) {
429 } else if ( arg == "--hud-culled" ) {
432 fgPrintf( FG_GENERAL, FG_EXIT, "Unknown option '%s'\n",
434 return(FG_OPTIONS_ERROR);
437 return(FG_OPTIONS_OK);
441 // Parse the command line options
442 int fgOPTIONS::parse_command_line( int argc, char **argv ) {
446 fgPrintf(FG_GENERAL, FG_INFO, "Processing command line arguments\n");
449 fgPrintf(FG_GENERAL, FG_DEBUG, "argv[%d] = %s\n", i, argv[i]);
451 result = parse_option(argv[i]);
452 if ( (result == FG_OPTIONS_HELP) || (result == FG_OPTIONS_ERROR) ) {
459 return(FG_OPTIONS_OK);
463 // Parse config file options
464 int fgOPTIONS::parse_config_file( const string& path ) {
468 string fgpath = path + ".gz";
470 // first try "path.gz"
471 if ( (f = fgopen(fgpath.c_str(), "rb")) == NULL ) {
473 if ( (f = fgopen(path.c_str(), "rb")) == NULL ) {
474 return(FG_OPTIONS_ERROR);
478 fgPrintf( FG_GENERAL, FG_INFO, "Processing config file: %s\n",
481 while ( fggets(f, line, 250) != NULL ) {
482 // strip trailing newline if it exists
484 if ( line[len-1] == '\n' ) {
488 // strip dos ^M if it exists
490 if ( line[len-1] == '\r' ) {
494 if ( parse_option( line ) == FG_OPTIONS_ERROR ) {
495 fgPrintf( FG_GENERAL, FG_EXIT,
496 "Config file parse error: %s '%s'\n",
497 path.c_str(), line );
502 return FG_OPTIONS_OK;
506 // Print usage message
507 void fgOPTIONS::usage ( void ) {
508 printf("Usage: fg [ options ... ]\n");
511 printf("General Options:\n");
512 printf("\t--help -h: print usage\n");
513 printf("\t--fg-root=path: specify the root path for all the data files\n");
514 printf("\t--disable-gamemode: disable full-screen game mode\n");
515 printf("\t--enable-gamemode: enable full-screen game mode\n");
516 printf("\t--disable-splash-screen: disable splash screen\n");
517 printf("\t--enable-splash-screen: enable splash screen\n");
518 printf("\t--disable-intro-music: disable introduction music\n");
519 printf("\t--enable-intro-music: enable introduction music\n");
520 printf("\t--disable-mouse-pointer: disable extra mouse pointer\n");
521 printf("\t--enable-mouse-pointer: enable extra mouse pointer (i.e. for\n");
522 printf("\t\tfull screen voodoo/voodoo-II based cards.)\n");
523 printf("\t--disable-pause: start out in an active state\n");
524 printf("\t--enable-pause: start out in a paused state\n");
527 printf("Features:\n");
528 printf("\t--disable-hud: disable heads up display\n");
529 printf("\t--enable-hud: enable heads up display\n");
530 printf("\t--disable-panel: disable instrument panel\n");
531 printf("\t--enable-panel: enable instrumetn panel\n");
532 printf("\t--disable-sound: disable sound effects\n");
533 printf("\t--enable-sound: enable sound effects\n");
536 printf("Initial Position and Orientation:\n");
537 printf("\t--airport-id=ABCD: specify starting postion by airport id\n");
538 printf("\t--lon=degrees: starting longitude in degrees (west = -)\n");
539 printf("\t--lat=degrees: starting latitude in degrees (south = -)\n");
540 printf("\t--altitude=meters: starting altitude in meters\n");
541 printf("\t--heading=degrees: heading (yaw) angle in degress (Psi)\n");
542 printf("\t--roll=degrees: roll angle in degrees (Phi)\n");
543 printf("\t--pitch=degrees: pitch angle in degrees (Theta)\n");
546 printf("Rendering Options:\n");
547 printf("\t--fog-disable: disable fog/haze\n");
548 printf("\t--fog-fastest: enable fastest fog/haze\n");
549 printf("\t--fog-nicest: enable nicest fog/haze\n");
550 printf("\t--fov=xx.x: specify initial field of view angle in degrees\n");
551 printf("\t--disable-fullscreen: disable fullscreen mode\n");
552 printf("\t--enable-fullscreen: enable fullscreen mode\n");
553 printf("\t--shading-flat: enable flat shading\n");
554 printf("\t--shading-smooth: enable smooth shading\n");
555 printf("\t--disable-skyblend: disable sky blending\n");
556 printf("\t--enable-skyblend: enable sky blending\n");
557 printf("\t--disable-textures: disable textures\n");
558 printf("\t--enable-textures: enable textures\n");
559 printf("\t--disable-wireframe: disable wireframe drawing mode\n");
560 printf("\t--enable-wireframe: enable wireframe drawing mode\n");
563 printf("Scenery Options:\n");
564 printf("\t--tile-radius=n: specify tile radius, must be 1 - 4\n");
567 printf("Hud Options:\n");
568 printf("\t--hud-tris: Hud displays number of triangles rendered\n");
569 printf("\t--hud-culled: Hud displays percentage of triangles culled\n");
571 printf("Time Options:\n");
572 printf("\t--time-offset=[+-]hh:mm:ss: offset local time by this amount\n");
577 fgOPTIONS::~fgOPTIONS( void ) {
582 // Revision 1.23 1998/08/27 17:02:07 curt
583 // Contributions from Bernie Bright <bbright@c031.aone.net.au>
584 // - use strings for fg_root and airport_id and added methods to return
586 // - inlined all access methods,
587 // - made the parsing functions private methods,
588 // - deleted some unused functions.
589 // - propogated some of these changes out a bit further.
591 // Revision 1.22 1998/08/24 20:11:13 curt
592 // Added i/I to toggle full vs. minimal HUD.
593 // Added a --hud-tris vs --hud-culled option.
594 // Moved options accessor funtions to options.hxx.
596 // Revision 1.21 1998/08/20 15:10:34 curt
597 // Added GameGLUT support.
599 // Revision 1.20 1998/07/30 23:48:28 curt
600 // Output position & orientation when pausing.
601 // Eliminated libtool use.
602 // Added options to specify initial position and orientation.
603 // Changed default fov to 55 degrees.
604 // Added command line option to start in paused or unpaused state.
606 // Revision 1.19 1998/07/27 18:41:25 curt
607 // Added a pause command "p"
608 // Fixed some initialization order problems between pui and glut.
609 // Added an --enable/disable-sound option.
611 // Revision 1.18 1998/07/22 01:27:03 curt
612 // Strip out \r when parsing config file in case we are on a windoze system.
614 // Revision 1.17 1998/07/16 17:33:38 curt
615 // "H" / "h" now control hud brightness as well with off being one of the
617 // Better checking for xmesa/fx 3dfx fullscreen/window support for deciding
618 // whether or not to build in the feature.
619 // Translucent menu support.
620 // HAVE_AUDIO_SUPPORT -> ENABLE_AUDIO_SUPPORT
621 // Use fork() / wait() for playing mp3 init music in background under unix.
622 // Changed default tile diameter to 5.
624 // Revision 1.16 1998/07/13 21:01:39 curt
625 // Wrote access functions for current fgOPTIONS.
627 // Revision 1.15 1998/07/06 21:34:19 curt
628 // Added an enable/disable splash screen option.
629 // Added an enable/disable intro music option.
630 // Added an enable/disable instrument panel option.
631 // Added an enable/disable mouse pointer option.
632 // Added using namespace std for compilers that support this.
634 // Revision 1.14 1998/07/04 00:52:26 curt
635 // Add my own version of gluLookAt() (which is nearly identical to the
636 // Mesa/glu version.) But, by calculating the Model View matrix our selves
637 // we can save this matrix without having to read it back in from the video
638 // card. This hopefully allows us to save a few cpu cycles when rendering
639 // out the fragments because we can just use glLoadMatrixd() with the
640 // precalculated matrix for each tile rather than doing a push(), translate(),
641 // pop() for every fragment.
643 // Panel status defaults to off for now until it gets a bit more developed.
645 // Extract OpenGL driver info on initialization.
647 // Revision 1.13 1998/06/27 16:54:34 curt
648 // Replaced "extern displayInstruments" with a entry in fgOPTIONS.
649 // Don't change the view port when displaying the panel.
651 // Revision 1.12 1998/06/17 21:35:13 curt
652 // Refined conditional audio support compilation.
653 // Moved texture parameter setup calls to ../Scenery/materials.cxx
654 // #include <string.h> before various STL includes.
655 // Make HUD default state be enabled.
657 // Revision 1.11 1998/06/13 00:40:33 curt
658 // Tweaked fog command line options.
660 // Revision 1.10 1998/05/16 13:08:36 curt
661 // C++ - ified views.[ch]xx
662 // Shuffled some additional view parameters into the fgVIEW class.
663 // Changed tile-radius to tile-diameter because it is a much better
665 // Added a WORLD_TO_EYE transformation to views.cxx. This allows us
666 // to transform world space to eye space for view frustum culling.
668 // Revision 1.9 1998/05/13 18:29:59 curt
669 // Added a keyboard binding to dynamically adjust field of view.
670 // Added a command line option to specify fov.
671 // Adjusted terrain color.
672 // Root path info moved to fgOPTIONS.
673 // Added ability to parse options out of a config file.
675 // Revision 1.8 1998/05/07 23:14:16 curt
676 // Added "D" key binding to set autopilot heading.
677 // Made frame rate calculation average out over last 10 frames.
678 // Borland C++ floating point exception workaround.
679 // Added a --tile-radius=n option.
681 // Revision 1.7 1998/05/06 03:16:25 curt
682 // Added an averaged global frame rate counter.
683 // Added an option to control tile radius.
685 // Revision 1.6 1998/05/03 00:47:32 curt
686 // Added an option to enable/disable full-screen mode.
688 // Revision 1.5 1998/04/30 12:34:19 curt
689 // Added command line rendering options:
690 // enable/disable fog/haze
691 // specify smooth/flat shading
692 // disable sky blending and just use a solid color
693 // enable wireframe drawing mode
695 // Revision 1.4 1998/04/28 01:20:22 curt
696 // Type-ified fgTIME and fgVIEW.
697 // Added a command line option to disable textures.
699 // Revision 1.3 1998/04/26 05:01:19 curt
700 // Added an rint() / HAVE_RINT check.
702 // Revision 1.2 1998/04/25 15:11:12 curt
703 // Added an command line option to set starting position based on airport ID.
705 // Revision 1.1 1998/04/24 00:49:21 curt
706 // Wrapped "#include <config.h>" in "#ifdef HAVE_CONFIG_H"
707 // Trying out some different option parsing code.
708 // Some code reorganization.