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()
35 #include <Debug/fg_debug.h>
36 #include <Flight/flight.h>
37 #include <Include/fg_constants.h>
38 #include <Include/fg_zlib.h>
40 #include "options.hxx"
43 // Defined the shared options class here
44 fgOPTIONS current_options;
48 fgOPTIONS::fgOPTIONS( void ) {
49 // set initial values/defaults
51 if ( getenv("FG_ROOT") != NULL ) {
52 // fg_root could be anywhere, so default to environmental
53 // variable $FG_ROOT if it is set.
55 strcpy(fg_root, getenv("FG_ROOT"));
57 // Otherwise, default to a random compiled in location if
58 // $FG_ROOT is not set. This can still be overridden from the
59 // command line or a config file.
62 strcpy(fg_root, "\\FlightGear");
64 strcpy(fg_root, "/usr/local/lib/FlightGear");
68 // Starting posistion and orientation
69 strcpy(airport_id, ""); // default airport id
70 lon = 0.0; // starting longitude in degrees (west = -)
71 lat = 0.0; // starting latitude in degrees (south = -)
73 // If nothing else is specified, default initial position is
78 // North of the city of Globe
82 // North of the city of Globe
86 // Near where I used to live in Globe, AZ
90 // 10125 Jewell St. NE
94 // Near KHSP (Hot Springs, VA)
95 // lon = -79.8338964 + 0.01;
96 // lat = 37.9514564 + 0.008;
98 // (SEZ) SEDONA airport
99 // lon = -111.7884614 + 0.01;
100 // lat = 34.8486289 - 0.015;
102 // Somewhere near the Grand Canyon
106 // Jim Brennon's Kingmont Observatory
107 // lon = -121.1131667;
110 // Huaras, Peru (S09d 31.871' W077d 31.498')
111 // lon = -77.5249667;
114 // Eclipse Watching w73.5 n10 (approx) 18:00 UT
123 // lon = -90.1953055556;
124 // lat = 45.4511388889;
126 altitude = -9999.0; // starting altitude in meters (this will be
127 // reset to ground level if it is lower
130 // Initial Orientation
131 heading = 270.0; // heading (yaw) angle in degress (Psi)
132 roll = 0.0; // roll angle in degrees (Phi)
133 pitch = 0.424; // pitch angle in degrees (Theta)
145 // Flight Model options
146 flight_model = FG_LARCSIM;
165 // Parse an int out of a --foo-bar=n type option
166 static int parse_int(char *arg) {
169 // advance past the '='
170 while ( (arg[0] != '=') && (arg[0] != '\0') ) {
174 if ( arg[0] == '=' ) {
178 // printf("parse_int(): arg = %s\n", arg);
182 // printf("parse_int(): result = %d\n", result);
188 // Parse an int out of a --foo-bar=n type option
189 static double parse_double(char *arg) {
192 // advance past the '='
193 while ( (arg[0] != '=') && (arg[0] != '\0') ) {
197 if ( arg[0] == '=' ) {
201 // printf("parse_double(): arg = %s\n", arg);
205 // printf("parse_double(): result = %.4f\n", result);
211 static double parse_time(char *time_str) {
213 double hours, minutes, seconds;
218 // printf("parse_time(): %s\n", time_str);
221 if ( strlen(time_str) ) {
222 if ( time_str[0] == '+' ) {
225 } else if ( time_str[0] == '-' ) {
230 // printf("sign = %d\n", sign);
233 if ( strlen(time_str) ) {
235 while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
236 num[i] = time_str[0];
240 if ( time_str[0] == ':' ) {
245 // printf("hours = %.2lf\n", hours);
251 if ( strlen(time_str) ) {
253 while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
254 num[i] = time_str[0];
258 if ( time_str[0] == ':' ) {
263 // printf("minutes = %.2lf\n", minutes);
265 result += minutes / 60.0;
269 if ( strlen(time_str) ) {
271 while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
272 num[i] = time_str[0];
278 // printf("seconds = %.2lf\n", seconds);
280 result += seconds / 3600.0;
283 return(sign * result);
287 // parse degree in the form of [+/-]hhh:mm:ss
288 static double parse_degree(char *degree_str) {
291 // advance past the '='
292 while ( (degree_str[0] != '=') && (degree_str[0] != '\0') ) {
296 if ( degree_str[0] == '=' ) {
300 result = parse_time(degree_str);
302 // printf("Degree = %.4f\n", result);
308 // parse time offset command line option
309 static int parse_time_offset(char *time_str) {
312 // advance past the '='
313 while ( (time_str[0] != '=') && (time_str[0] != '\0') ) {
317 if ( time_str[0] == '=' ) {
321 // printf("time offset = %s\n", time_str);
324 result = (int)rint(parse_time(time_str) * 3600.0);
326 result = (int)(parse_time(time_str) * 3600.0);
329 // printf("parse_time_offset(): %d\n", result);
335 // Parse --tile-diameter=n type option
337 #define FG_RADIUS_MIN 1
338 #define FG_RADIUS_MAX 4
340 static int parse_tile_radius(char *arg) {
343 radius = parse_int(arg);
345 if ( radius < FG_RADIUS_MIN ) { radius = FG_RADIUS_MIN; }
346 if ( radius > FG_RADIUS_MAX ) { radius = FG_RADIUS_MAX; }
348 // printf("parse_tile_radius(): radius = %d\n", radius);
354 // Parse --flightmode=abcdefg type option
355 static int parse_flight_model(char *fm) {
358 // printf("flight model = %s\n", fm);
360 if ( strcmp(fm, "slew") == 0 ) {
362 } else if ( strcmp(fm, "larcsim") == 0 ) {
364 } else if ( strcmp(fm, "LaRCsim") == 0 ) {
367 fgPrintf( FG_GENERAL, FG_EXIT, "Unknown flight model = %s\n", fm);
370 // we'll never get here, but it makes the compiler happy.
375 // Parse --fov=x.xx type option
376 static double parse_fov(char *arg) {
379 fov = parse_double(arg);
381 if ( fov < FG_FOV_MIN ) { fov = FG_FOV_MIN; }
382 if ( fov > FG_FOV_MAX ) { fov = FG_FOV_MAX; }
384 // printf("parse_fov(): result = %.4f\n", fov);
390 // Parse a single option
391 int fgOPTIONS::parse_option( char *arg ) {
393 if ( (strcmp(arg, "--help") == 0) ||
394 (strcmp(arg, "-h") == 0) ) {
395 // help/usage request
396 return(FG_OPTIONS_HELP);
397 } else if ( strcmp(arg, "--disable-splash-screen") == 0 ) {
399 } else if ( strcmp(arg, "--enable-splash-screen") == 0 ) {
401 } else if ( strcmp(arg, "--disable-intro-music") == 0 ) {
403 } else if ( strcmp(arg, "--enable-intro-music") == 0 ) {
405 } else if ( strcmp(arg, "--disable-mouse-pointer") == 0 ) {
407 } else if ( strcmp(arg, "--enable-mouse-pointer") == 0 ) {
409 } else if ( strcmp(arg, "--disable-pause") == 0 ) {
411 } else if ( strcmp(arg, "--enable-pause") == 0 ) {
413 } else if ( strcmp(arg, "--disable-hud") == 0 ) {
415 } else if ( strcmp(arg, "--enable-hud") == 0 ) {
417 } else if ( strcmp(arg, "--disable-panel") == 0 ) {
419 } else if ( strcmp(arg, "--enable-panel") == 0 ) {
421 } else if ( strcmp(arg, "--disable-sound") == 0 ) {
423 } else if ( strcmp(arg, "--enable-sound") == 0 ) {
425 } else if ( strncmp(arg, "--airport-id=", 13) == 0 ) {
427 strncpy(airport_id, arg, 4);
428 } else if ( strncmp(arg, "--lon=", 6) == 0 ) {
429 lon = parse_degree(arg);
430 } else if ( strncmp(arg, "--lat=", 6) == 0 ) {
431 lat = parse_degree(arg);
432 } else if ( strncmp(arg, "--altitude=", 11) == 0 ) {
433 altitude = parse_double(arg);
434 } else if ( strncmp(arg, "--heading=", 6) == 0 ) {
435 heading = parse_double(arg);
436 } else if ( strncmp(arg, "--roll=", 7) == 0 ) {
437 roll = parse_double(arg);
438 } else if ( strncmp(arg, "--pitch=", 8) == 0 ) {
439 pitch = parse_double(arg);
440 } else if ( strncmp(arg, "--fg-root=", 10) == 0 ) {
442 strcpy(fg_root, arg);
443 } else if ( strncmp(arg, "--flight-model=", 15) == 0 ) {
444 flight_model = parse_flight_model(arg);
445 } else if ( strcmp(arg, "--fog-disable") == 0 ) {
447 } else if ( strcmp(arg, "--fog-fastest") == 0 ) {
449 } else if ( strcmp(arg, "--fog-nicest") == 0 ) {
451 } else if ( strncmp(arg, "--fov=", 6) == 0 ) {
452 fov = parse_fov(arg);
453 } else if ( strcmp(arg, "--disable-fullscreen") == 0 ) {
455 } else if ( strcmp(arg, "--enable-fullscreen") == 0 ) {
457 } else if ( strcmp(arg, "--shading-flat") == 0 ) {
459 } else if ( strcmp(arg, "--shading-smooth") == 0 ) {
461 } else if ( strcmp(arg, "--disable-skyblend") == 0 ) {
463 } else if ( strcmp(arg, "--enable-skyblend") == 0 ) {
465 } else if ( strcmp(arg, "--disable-textures") == 0 ) {
467 } else if ( strcmp(arg, "--enable-textures") == 0 ) {
469 } else if ( strcmp(arg, "--disable-wireframe") == 0 ) {
471 } else if ( strcmp(arg, "--enable-wireframe") == 0 ) {
473 } else if ( strncmp(arg, "--tile-radius=", 14) == 0 ) {
474 tile_radius = parse_tile_radius(arg);
475 tile_diameter = tile_radius * 2 + 1;
476 } else if ( strncmp(arg, "--time-offset=", 14) == 0 ) {
477 time_offset = parse_time_offset(arg);
479 fgPrintf( FG_GENERAL, FG_EXIT, "Unknown option '%s'\n", arg);
480 return(FG_OPTIONS_ERROR);
483 return(FG_OPTIONS_OK);
487 // Parse the command line options
488 int fgOPTIONS::parse_command_line( int argc, char **argv ) {
492 fgPrintf(FG_GENERAL, FG_INFO, "Processing command line arguments\n");
495 fgPrintf(FG_GENERAL, FG_DEBUG, "argv[%d] = %s\n", i, argv[i]);
497 result = parse_option(argv[i]);
498 if ( (result == FG_OPTIONS_HELP) || (result == FG_OPTIONS_ERROR) ) {
505 return(FG_OPTIONS_OK);
509 // Parse the command line options
510 int fgOPTIONS::parse_config_file( char *path ) {
511 char fgpath[256], line[256];
515 strcpy(fgpath, path);
516 strcat(fgpath, ".gz");
518 // first try "path.gz"
519 if ( (f = fgopen(fgpath, "rb")) == NULL ) {
521 if ( (f = fgopen(path, "rb")) == NULL ) {
522 return(FG_OPTIONS_ERROR);
526 fgPrintf(FG_GENERAL, FG_INFO, "Processing config file: %s\n", path);
528 while ( fggets(f, line, 250) != NULL ) {
529 // strip trailing newline if it exists
531 if ( line[len-1] == '\n' ) {
535 // strip dos ^M if it exists
537 if ( line[len-1] == '\r' ) {
541 result = parse_option(line);
542 if ( result == FG_OPTIONS_ERROR ) {
543 fgPrintf( FG_GENERAL, FG_EXIT,
544 "Config file parse error: %s '%s'\n", path, line );
549 return(FG_OPTIONS_OK);
553 // Print usage message
554 void fgOPTIONS::usage ( void ) {
555 printf("Usage: fg [ options ... ]\n");
558 printf("General Options:\n");
559 printf("\t--help -h: print usage\n");
560 printf("\t--fg-root=path: specify the root path for all the data files\n");
561 printf("\t--disable-splash-screen: disable splash screen\n");
562 printf("\t--enable-splash-screen: enable splash screen\n");
563 printf("\t--disable-intro-music: disable introduction music\n");
564 printf("\t--enable-intro-music: enable introduction music\n");
565 printf("\t--disable-mouse-pointer: disable extra mouse pointer\n");
566 printf("\t--enable-mouse-pointer: enable extra mouse pointer (i.e. for\n");
567 printf("\t\tfull screen voodoo/voodoo-II based cards.)\n");
568 printf("\t--disable-pause: start out in an active state\n");
569 printf("\t--enable-pause: start out in a paused state\n");
572 printf("Features:\n");
573 printf("\t--disable-hud: disable heads up display\n");
574 printf("\t--enable-hud: enable heads up display\n");
575 printf("\t--disable-panel: disable instrument panel\n");
576 printf("\t--enable-panel: enable instrumetn panel\n");
577 printf("\t--disable-sound: disable sound effects\n");
578 printf("\t--enable-sound: enable sound effects\n");
581 printf("Initial Position and Orientation:\n");
582 printf("\t--airport-id=ABCD: specify starting postion by airport id\n");
583 printf("\t--lon=degrees: starting longitude in degrees (west = -)\n");
584 printf("\t--lat=degrees: starting latitude in degrees (south = -)\n");
585 printf("\t--altitude=meters: starting altitude in meters\n");
586 printf("\t--heading=degrees: heading (yaw) angle in degress (Psi)\n");
587 printf("\t--roll=degrees: roll angle in degrees (Phi)\n");
588 printf("\t--pitch=degrees: pitch angle in degrees (Theta)\n");
591 printf("Rendering Options:\n");
592 printf("\t--fog-disable: disable fog/haze\n");
593 printf("\t--fog-fastest: enable fastest fog/haze\n");
594 printf("\t--fog-nicest: enable nicest fog/haze\n");
595 printf("\t--fov=xx.x: specify initial field of view angle in degrees\n");
596 printf("\t--disable-fullscreen: disable fullscreen mode\n");
597 printf("\t--enable-fullscreen: enable fullscreen mode\n");
598 printf("\t--shading-flat: enable flat shading\n");
599 printf("\t--shading-smooth: enable smooth shading\n");
600 printf("\t--disable-skyblend: disable sky blending\n");
601 printf("\t--enable-skyblend: enable sky blending\n");
602 printf("\t--disable-textures: disable textures\n");
603 printf("\t--enable-textures: enable textures\n");
604 printf("\t--disable-wireframe: disable wireframe drawing mode\n");
605 printf("\t--enable-wireframe: enable wireframe drawing mode\n");
608 printf("Scenery Options:\n");
609 printf("\t--tile-radius=n: specify tile radius, must be 1 - 4\n");
612 printf("Time Options:\n");
613 printf("\t--time-offset=[+-]hh:mm:ss: offset local time by this amount\n");
618 void fgOPTIONS::get_fg_root(char *root) { strcpy(root, fg_root); }
619 void fgOPTIONS::get_airport_id(char *id) { strcpy(id, airport_id); }
620 double fgOPTIONS::get_lon( void ) { return(lon); }
621 double fgOPTIONS::get_lat( void ) { return(lat); }
622 double fgOPTIONS::get_altitude( void ) { return(altitude); }
623 double fgOPTIONS::get_heading( void ) { return(heading); }
624 double fgOPTIONS::get_roll( void ) { return(roll); }
625 double fgOPTIONS::get_pitch( void ) { return(pitch); }
626 int fgOPTIONS::get_splash_screen( void ) { return(splash_screen); }
627 int fgOPTIONS::get_intro_music( void ) { return(intro_music); }
628 int fgOPTIONS::get_mouse_pointer( void ) { return(mouse_pointer); }
629 int fgOPTIONS::get_pause( void ) { return(pause); }
630 int fgOPTIONS::get_hud_status( void ) { return(hud_status); }
631 int fgOPTIONS::get_panel_status( void ) { return(panel_status); }
632 int fgOPTIONS::get_sound( void ) { return(sound); }
633 int fgOPTIONS::get_flight_model( void ) { return(flight_model); }
634 int fgOPTIONS::get_fog( void ) { return(fog); }
635 double fgOPTIONS::get_fov( void ) { return(fov); }
636 int fgOPTIONS::get_fullscreen( void ) { return(fullscreen); }
637 int fgOPTIONS::get_shading( void ) { return(shading); }
638 int fgOPTIONS::get_skyblend( void ) { return(skyblend); }
639 int fgOPTIONS::get_textures( void ) { return(textures); }
640 int fgOPTIONS::get_wireframe( void ) { return(wireframe); }
641 int fgOPTIONS::get_tile_radius( void ) { return(tile_radius); }
642 int fgOPTIONS::get_tile_diameter( void ) { return(tile_diameter); }
643 int fgOPTIONS::get_time_offset( void ) { return(time_offset); }
647 void fgOPTIONS::set_hud_status( int status ) { hud_status = status; }
648 void fgOPTIONS::set_fov( double amount ) { fov = amount; }
651 fgOPTIONS::~fgOPTIONS( void ) {
656 // Revision 1.20 1998/07/30 23:48:28 curt
657 // Output position & orientation when pausing.
658 // Eliminated libtool use.
659 // Added options to specify initial position and orientation.
660 // Changed default fov to 55 degrees.
661 // Added command line option to start in paused or unpaused state.
663 // Revision 1.19 1998/07/27 18:41:25 curt
664 // Added a pause command "p"
665 // Fixed some initialization order problems between pui and glut.
666 // Added an --enable/disable-sound option.
668 // Revision 1.18 1998/07/22 01:27:03 curt
669 // Strip out \r when parsing config file in case we are on a windoze system.
671 // Revision 1.17 1998/07/16 17:33:38 curt
672 // "H" / "h" now control hud brightness as well with off being one of the
674 // Better checking for xmesa/fx 3dfx fullscreen/window support for deciding
675 // whether or not to build in the feature.
676 // Translucent menu support.
677 // HAVE_AUDIO_SUPPORT -> ENABLE_AUDIO_SUPPORT
678 // Use fork() / wait() for playing mp3 init music in background under unix.
679 // Changed default tile diameter to 5.
681 // Revision 1.16 1998/07/13 21:01:39 curt
682 // Wrote access functions for current fgOPTIONS.
684 // Revision 1.15 1998/07/06 21:34:19 curt
685 // Added an enable/disable splash screen option.
686 // Added an enable/disable intro music option.
687 // Added an enable/disable instrument panel option.
688 // Added an enable/disable mouse pointer option.
689 // Added using namespace std for compilers that support this.
691 // Revision 1.14 1998/07/04 00:52:26 curt
692 // Add my own version of gluLookAt() (which is nearly identical to the
693 // Mesa/glu version.) But, by calculating the Model View matrix our selves
694 // we can save this matrix without having to read it back in from the video
695 // card. This hopefully allows us to save a few cpu cycles when rendering
696 // out the fragments because we can just use glLoadMatrixd() with the
697 // precalculated matrix for each tile rather than doing a push(), translate(),
698 // pop() for every fragment.
700 // Panel status defaults to off for now until it gets a bit more developed.
702 // Extract OpenGL driver info on initialization.
704 // Revision 1.13 1998/06/27 16:54:34 curt
705 // Replaced "extern displayInstruments" with a entry in fgOPTIONS.
706 // Don't change the view port when displaying the panel.
708 // Revision 1.12 1998/06/17 21:35:13 curt
709 // Refined conditional audio support compilation.
710 // Moved texture parameter setup calls to ../Scenery/materials.cxx
711 // #include <string.h> before various STL includes.
712 // Make HUD default state be enabled.
714 // Revision 1.11 1998/06/13 00:40:33 curt
715 // Tweaked fog command line options.
717 // Revision 1.10 1998/05/16 13:08:36 curt
718 // C++ - ified views.[ch]xx
719 // Shuffled some additional view parameters into the fgVIEW class.
720 // Changed tile-radius to tile-diameter because it is a much better
722 // Added a WORLD_TO_EYE transformation to views.cxx. This allows us
723 // to transform world space to eye space for view frustum culling.
725 // Revision 1.9 1998/05/13 18:29:59 curt
726 // Added a keyboard binding to dynamically adjust field of view.
727 // Added a command line option to specify fov.
728 // Adjusted terrain color.
729 // Root path info moved to fgOPTIONS.
730 // Added ability to parse options out of a config file.
732 // Revision 1.8 1998/05/07 23:14:16 curt
733 // Added "D" key binding to set autopilot heading.
734 // Made frame rate calculation average out over last 10 frames.
735 // Borland C++ floating point exception workaround.
736 // Added a --tile-radius=n option.
738 // Revision 1.7 1998/05/06 03:16:25 curt
739 // Added an averaged global frame rate counter.
740 // Added an option to control tile radius.
742 // Revision 1.6 1998/05/03 00:47:32 curt
743 // Added an option to enable/disable full-screen mode.
745 // Revision 1.5 1998/04/30 12:34:19 curt
746 // Added command line rendering options:
747 // enable/disable fog/haze
748 // specify smooth/flat shading
749 // disable sky blending and just use a solid color
750 // enable wireframe drawing mode
752 // Revision 1.4 1998/04/28 01:20:22 curt
753 // Type-ified fgTIME and fgVIEW.
754 // Added a command line option to disable textures.
756 // Revision 1.3 1998/04/26 05:01:19 curt
757 // Added an rint() / HAVE_RINT check.
759 // Revision 1.2 1998/04/25 15:11:12 curt
760 // Added an command line option to set starting position based on airport ID.
762 // Revision 1.1 1998/04/24 00:49:21 curt
763 // Wrapped "#include <config.h>" in "#ifdef HAVE_CONFIG_H"
764 // Trying out some different option parsing code.
765 // Some code reorganization.