1 // options.cxx -- class to handle command line options
3 // Written by Curtis Olson, started April 1998.
5 // Copyright (C) 1998 Curtis L. Olson - curt@me.umn.edu
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.
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.
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.
28 #if defined(FX) && defined(XMESA)
29 bool global_fullscreen = true;
32 #include <Include/compiler.h>
34 #include <math.h> // rint()
36 #include <stdlib.h> // atof(), atoi()
41 #include <Include/fg_constants.h>
42 #include <Include/general.hxx>
43 #include <Cockpit/cockpit.hxx>
44 #include <Debug/logstream.hxx>
45 #include <FDM/flight.hxx>
46 #include <Misc/fgstream.hxx>
48 # include <Network/network.h>
50 #include <Time/fg_time.hxx>
52 #include "options.hxx"
53 #include "fg_serial.hxx"
56 FG_USING_NAMESPACE(std);
59 extern void fgReshape( int width, int height );
62 atof( const string& str )
66 // -dw- if ::atof is called, then we get an infinite loop
67 return std::atof( str.c_str() );
69 return ::atof( str.c_str() );
74 atoi( const string& str )
77 // -dw- if ::atoi is called, then we get an infinite loop
78 return std::atoi( str.c_str() );
80 return ::atoi( str.c_str() );
84 // Defined the shared options class here
85 fgOPTIONS current_options;
89 fgOPTIONS::fgOPTIONS() :
90 // starting longitude in degrees (west = -)
91 // starting latitude in degrees (south = -)
93 // Default initial position is Globe, AZ (P13)
97 // North of the city of Globe
101 // North of the city of Globe
105 // Near where I used to live in Globe, AZ
109 // 10125 Jewell St. NE
113 // Near KHSP (Hot Springs, VA)
114 // lon(-79.8338964 + 0.01),
115 // lat( 37.9514564 + 0.008),
117 // (SEZ) SEDONA airport
118 // lon(-111.7884614 + 0.01),
119 // lat( 34.8486289 - 0.015),
121 // Jim Brennon's Kingmont Observatory
122 // lon(-121.1131667),
125 // Huaras, Peru (S09d 31.871' W077d 31.498')
129 // Eclipse Watching w73.5 n10 (approx) 18:00 UT
134 // lon(-90.1953055556),
135 // lat( 45.4511388889),
137 // starting altitude in meters (this will be reset to ground level
138 // if it is lower than the terrain
141 // Initial Orientation
142 heading(270.0), // heading (yaw) angle in degress (Psi)
143 roll(0.0), // roll angle in degrees (Phi)
144 pitch(0.424), // pitch angle in degrees (Theta)
158 // Flight Model options
159 flight_model(FGInterface::FG_LARCSIM),
162 fog(FG_FOG_NICEST), // nicest
176 units(FG_UNITS_FEET),
185 // set initial values/defaults
186 char* envp = ::getenv( "FG_ROOT" );
188 if ( envp != NULL ) {
189 // fg_root could be anywhere, so default to environmental
190 // variable $FG_ROOT if it is set.
193 // Otherwise, default to a random compiled in location if
194 // $FG_ROOT is not set. This can still be overridden from the
195 // command line or a config file.
198 fg_root = "\\FlightGear";
199 #elif defined( MACOS )
206 airport_id = ""; // default airport id
207 net_id = "Johnney"; // default pilot's name
209 // initialize port config string list
210 port_options_list.erase ( port_options_list.begin(),
211 port_options_list.end() );
215 fgOPTIONS::toggle_panel() {
217 FGTime *t = FGTime::cur_time_params;
219 int toggle_pause = t->getPause();
222 t->togglePauseMode();
225 panel_status = false;
229 if ( panel_status ) {
230 if( FGPanel::OurPanel == 0)
234 fov *= (1.0 / 0.4232);
236 fgReshape( xsize, ysize);
239 t->togglePauseMode();
243 fgOPTIONS::parse_time(const string& time_in) {
244 char *time_str, num[256];
245 double hours, minutes, seconds;
250 time_str = (char *)time_in.c_str();
252 // printf("parse_time(): %s\n", time_str);
255 if ( strlen(time_str) ) {
256 if ( time_str[0] == '+' ) {
259 } else if ( time_str[0] == '-' ) {
264 // printf("sign = %d\n", sign);
267 if ( strlen(time_str) ) {
269 while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
270 num[i] = time_str[0];
274 if ( time_str[0] == ':' ) {
279 // printf("hours = %.2lf\n", hours);
285 if ( strlen(time_str) ) {
287 while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
288 num[i] = time_str[0];
292 if ( time_str[0] == ':' ) {
297 // printf("minutes = %.2lf\n", minutes);
299 result += minutes / 60.0;
303 if ( strlen(time_str) ) {
305 while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
306 num[i] = time_str[0];
312 // printf("seconds = %.2lf\n", seconds);
314 result += seconds / 3600.0;
317 return(sign * result);
321 long int fgOPTIONS::parse_date( const string& date)
324 char * date_str, num[256];
326 // initialize to zero
333 gmt.tm_isdst = 0; // ignore daylight savingtime for the moment
334 date_str = (char *)date.c_str();
336 if ( strlen(date_str) ) {
338 while ( (date_str[0] != ':') && (date_str[0] != '\0') ) {
339 num[i] = date_str[0];
343 if ( date_str[0] == ':' ) {
347 gmt.tm_year = atoi(num) - 1900;
350 if ( strlen(date_str) ) {
352 while ( (date_str[0] != ':') && (date_str[0] != '\0') ) {
353 num[i] = date_str[0];
357 if ( date_str[0] == ':' ) {
361 gmt.tm_mon = atoi(num) -1;
364 if ( strlen(date_str) ) {
366 while ( (date_str[0] != ':') && (date_str[0] != '\0') ) {
367 num[i] = date_str[0];
371 if ( date_str[0] == ':' ) {
375 gmt.tm_mday = atoi(num);
378 if ( strlen(date_str) ) {
380 while ( (date_str[0] != ':') && (date_str[0] != '\0') ) {
381 num[i] = date_str[0];
385 if ( date_str[0] == ':' ) {
389 gmt.tm_hour = atoi(num);
392 if ( strlen(date_str) ) {
394 while ( (date_str[0] != ':') && (date_str[0] != '\0') ) {
395 num[i] = date_str[0];
399 if ( date_str[0] == ':' ) {
403 gmt.tm_min = atoi(num);
406 if ( strlen(date_str) ) {
408 while ( (date_str[0] != ':') && (date_str[0] != '\0') ) {
409 num[i] = date_str[0];
413 if ( date_str[0] == ':' ) {
417 gmt.tm_sec = atoi(num);
419 time_t theTime = FGTime::cur_time_params->get_gmt(gmt.tm_year,
425 //printf ("Date is %s\n", ctime(&theTime));
426 //printf ("in seconds that is %d\n", theTime);
432 // parse degree in the form of [+/-]hhh:mm:ss
434 fgOPTIONS::parse_degree( const string& degree_str) {
435 double result = parse_time( degree_str );
437 // printf("Degree = %.4f\n", result);
443 // parse time offset command line option
445 fgOPTIONS::parse_time_offset( const string& time_str) {
448 // printf("time offset = %s\n", time_str);
451 result = (int)rint(parse_time(time_str) * 3600.0);
453 result = (int)(parse_time(time_str) * 3600.0);
456 // printf("parse_time_offset(): %d\n", result);
462 // Parse --tile-diameter=n type option
465 fgOPTIONS::parse_tile_radius( const string& arg ) {
466 int radius = atoi( arg );
468 if ( radius < FG_RADIUS_MIN ) { radius = FG_RADIUS_MIN; }
469 if ( radius > FG_RADIUS_MAX ) { radius = FG_RADIUS_MAX; }
471 // printf("parse_tile_radius(): radius = %d\n", radius);
477 // Parse --fdm=abcdefg type option
479 fgOPTIONS::parse_fdm( const string& fm ) {
480 // printf("fdm = %s\n", fm);
482 if ( fm == "slew" ) {
483 return FGInterface::FG_SLEW;
484 } else if ( fm == "jsb" ) {
485 return FGInterface::FG_JSBSIM;
486 } else if ( (fm == "larcsim") || (fm == "LaRCsim") ) {
487 return FGInterface::FG_LARCSIM;
488 } else if ( fm == "external" ) {
489 return FGInterface::FG_EXTERNAL;
491 FG_LOG( FG_GENERAL, FG_ALERT, "Unknown fdm = " << fm );
495 // we'll never get here, but it makes the compiler happy.
500 // Parse --fov=x.xx type option
502 fgOPTIONS::parse_fov( const string& arg ) {
503 double fov = atof(arg);
505 if ( fov < FG_FOV_MIN ) { fov = FG_FOV_MIN; }
506 if ( fov > FG_FOV_MAX ) { fov = FG_FOV_MAX; }
508 // printf("parse_fov(): result = %.4f\n", fov);
514 // Parse serial port option --serial=/dev/ttyS1,nmea,4800,out
516 // Format is "--serial=device,format,baud,direction" where
518 // device = OS device name to be open()'ed
519 // format = {nmea, garmin,fgfs,rul}
520 // baud = {300, 1200, 2400, ..., 230400}
521 // direction = {in, out, bi}
524 fgOPTIONS::parse_serial( const string& serial_str ) {
525 string::size_type pos;
527 // cout << "Serial string = " << serial_str << endl;
529 // a flailing attempt to see if the port config string has a
530 // chance at being valid
531 pos = serial_str.find(",");
532 if ( pos == string::npos ) {
533 FG_LOG( FG_GENERAL, FG_ALERT,
534 "Malformed serial port configure string" );
538 port_options_list.push_back( serial_str );
544 // Parse a single option
545 int fgOPTIONS::parse_option( const string& arg ) {
547 if ( (arg == "--help") || (arg == "-h") ) {
548 // help/usage request
549 return(FG_OPTIONS_HELP);
550 } else if ( arg == "--disable-game-mode") {
552 } else if ( arg == "--enable-game-mode" ) {
554 } else if ( arg == "--disable-splash-screen" ) {
555 splash_screen = false;
556 } else if ( arg == "--enable-splash-screen" ) {
557 splash_screen = true;
558 } else if ( arg == "--disable-intro-music" ) {
560 } else if ( arg == "--enable-intro-music" ) {
562 } else if ( arg == "--disable-mouse-pointer" ) {
564 } else if ( arg == "--enable-mouse-pointer" ) {
566 } else if ( arg == "--disable-pause" ) {
568 } else if ( arg == "--enable-pause" ) {
570 } else if ( arg == "--disable-hud" ) {
572 } else if ( arg == "--enable-hud" ) {
574 } else if ( arg == "--disable-panel" ) {
575 panel_status = false;
576 } else if ( arg == "--enable-panel" ) {
579 } else if ( arg == "--disable-sound" ) {
581 } else if ( arg == "--enable-sound" ) {
583 } else if ( arg.find( "--airport-id=") != string::npos ) {
584 airport_id = arg.substr( 13 );
585 } else if ( arg.find( "--lon=" ) != string::npos ) {
586 lon = parse_degree( arg.substr(6) );
587 } else if ( arg.find( "--lat=" ) != string::npos ) {
588 lat = parse_degree( arg.substr(6) );
589 } else if ( arg.find( "--altitude=" ) != string::npos ) {
590 if ( units == FG_UNITS_FEET ) {
591 altitude = atof( arg.substr(11) ) * FEET_TO_METER;
593 altitude = atof( arg.substr(11) );
595 } else if ( arg.find( "--heading=" ) != string::npos ) {
596 heading = atof( arg.substr(10) );
597 } else if ( arg.find( "--roll=" ) != string::npos ) {
598 roll = atof( arg.substr(7) );
599 } else if ( arg.find( "--pitch=" ) != string::npos ) {
600 pitch = atof( arg.substr(8) );
601 } else if ( arg.find( "--fg-root=" ) != string::npos ) {
602 fg_root = arg.substr( 10 );
603 } else if ( arg.find( "--fdm=" ) != string::npos ) {
604 flight_model = parse_fdm( arg.substr(6) );
605 } else if ( arg == "--fog-disable" ) {
606 fog = FG_FOG_DISABLED;
607 } else if ( arg == "--fog-fastest" ) {
608 fog = FG_FOG_FASTEST;
609 } else if ( arg == "--fog-nicest" ) {
611 } else if ( arg.find( "--fov=" ) != string::npos ) {
612 fov = parse_fov( arg.substr(6) );
613 } else if ( arg == "--disable-fullscreen" ) {
615 } else if ( arg== "--enable-fullscreen") {
617 } else if ( arg == "--shading-flat") {
619 } else if ( arg == "--shading-smooth") {
621 } else if ( arg == "--disable-skyblend") {
623 } else if ( arg== "--enable-skyblend" ) {
625 } else if ( arg == "--disable-textures" ) {
627 } else if ( arg == "--enable-textures" ) {
629 } else if ( arg == "--disable-wireframe" ) {
631 } else if ( arg == "--enable-wireframe" ) {
633 } else if ( arg.find( "--geometry=" ) != string::npos ) {
634 string geometry = arg.substr( 11 );
635 if ( geometry == "640x480" ) {
638 } else if ( geometry == "800x600" ) {
641 } else if ( geometry == "1024x768" ) {
645 FG_LOG( FG_GENERAL, FG_ALERT, "Unknown geometry: " << geometry );
648 } else if ( arg == "--units-feet" ) {
649 units = FG_UNITS_FEET;
650 } else if ( arg == "--units-meters" ) {
651 units = FG_UNITS_METERS;
652 } else if ( arg.find( "--tile-radius=" ) != string::npos ) {
653 tile_radius = parse_tile_radius( arg.substr(14) );
654 tile_diameter = tile_radius * 2 + 1;
655 } else if ( arg.find( "--time-offset=" ) != string::npos ) {
656 time_offset = parse_time_offset( (arg.substr(14)) );
657 } else if (arg.find( "--start-date-gmt=") != string::npos ) {
658 start_gst = parse_date( (arg.substr(17)) );
659 } else if (arg.find( "--start-data-lst=") != string::npos ) {
660 start_lst = parse_date( (arg.substr(17)) );
661 } else if ( arg == "--hud-tris" ) {
663 } else if ( arg == "--hud-culled" ) {
665 } else if ( arg.find( "--serial=" ) != string::npos ) {
666 parse_serial( arg.substr(9) );
667 #ifdef FG_NETWORK_OLK
668 } else if ( arg == "--net-hud" ) {
670 } else if ( arg.find( "--net-id=") != string::npos ) {
671 net_id = arg.substr( 9 );
674 FG_LOG( FG_GENERAL, FG_ALERT, "Unknown option '" << arg << "'" );
675 return FG_OPTIONS_ERROR;
678 return FG_OPTIONS_OK;
682 // Parse the command line options
683 int fgOPTIONS::parse_command_line( int argc, char **argv ) {
687 FG_LOG(FG_GENERAL, FG_INFO, "Processing command line arguments");
690 FG_LOG( FG_GENERAL, FG_DEBUG, "argv[" << i << "] = " << argv[i] );
692 result = parse_option(argv[i]);
693 if ( (result == FG_OPTIONS_HELP) || (result == FG_OPTIONS_ERROR) ) {
700 return(FG_OPTIONS_OK);
704 // Parse config file options
705 int fgOPTIONS::parse_config_file( const string& path ) {
706 fg_gzifstream in( path );
708 return(FG_OPTIONS_ERROR);
710 FG_LOG( FG_GENERAL, FG_INFO, "Processing config file: " << path );
713 while ( !in.eof() ) {
716 #ifdef GETLINE_NEEDS_TERMINATOR
717 getline( in, line, '\n' );
722 if ( parse_option( line ) == FG_OPTIONS_ERROR ) {
723 FG_LOG( FG_GENERAL, FG_ALERT,
724 "Config file parse error: " << path << " '"
731 return FG_OPTIONS_OK;
735 // Print usage message
736 void fgOPTIONS::usage ( void ) {
737 printf("Usage: fg [ options ... ]\n");
740 printf("General Options:\n");
741 printf("\t--help -h: print usage\n");
742 printf("\t--fg-root=path: specify the root path for all the data files\n");
743 printf("\t--disable-game-mode: disable full-screen game mode\n");
744 printf("\t--enable-game-mode: enable full-screen game mode\n");
745 printf("\t--disable-splash-screen: disable splash screen\n");
746 printf("\t--enable-splash-screen: enable splash screen\n");
747 printf("\t--disable-intro-music: disable introduction music\n");
748 printf("\t--enable-intro-music: enable introduction music\n");
749 printf("\t--disable-mouse-pointer: disable extra mouse pointer\n");
750 printf("\t--enable-mouse-pointer: enable extra mouse pointer (i.e. for\n");
751 printf("\t\tfull screen voodoo/voodoo-II based cards.)\n");
752 printf("\t--disable-pause: start out in an active state\n");
753 printf("\t--enable-pause: start out in a paused state\n");
756 printf("Features:\n");
757 printf("\t--disable-hud: disable heads up display\n");
758 printf("\t--enable-hud: enable heads up display\n");
759 printf("\t--disable-panel: disable instrument panel\n");
760 printf("\t--enable-panel: enable instrumetn panel\n");
761 printf("\t--disable-sound: disable sound effects\n");
762 printf("\t--enable-sound: enable sound effects\n");
765 printf("Flight Model:\n");
766 printf("\t--fdm=abcd: one of slew, jsb, larcsim, or external\n");
769 printf("Initial Position and Orientation:\n");
770 printf("\t--airport-id=ABCD: specify starting postion by airport id\n");
771 printf("\t--lon=degrees: starting longitude in degrees (west = -)\n");
772 printf("\t--lat=degrees: starting latitude in degrees (south = -)\n");
773 printf("\t--altitude=feet: starting altitude in feet\n");
774 printf("\t\t(unless --units-meters specified\n");
775 printf("\t--heading=degrees: heading (yaw) angle in degress (Psi)\n");
776 printf("\t--roll=degrees: roll angle in degrees (Phi)\n");
777 printf("\t--pitch=degrees: pitch angle in degrees (Theta)\n");
780 printf("Rendering Options:\n");
781 printf("\t--fog-disable: disable fog/haze\n");
782 printf("\t--fog-fastest: enable fastest fog/haze\n");
783 printf("\t--fog-nicest: enable nicest fog/haze\n");
784 printf("\t--fov=xx.x: specify initial field of view angle in degrees\n");
785 printf("\t--disable-fullscreen: disable fullscreen mode\n");
786 printf("\t--enable-fullscreen: enable fullscreen mode\n");
787 printf("\t--shading-flat: enable flat shading\n");
788 printf("\t--shading-smooth: enable smooth shading\n");
789 printf("\t--disable-skyblend: disable sky blending\n");
790 printf("\t--enable-skyblend: enable sky blending\n");
791 printf("\t--disable-textures: disable textures\n");
792 printf("\t--enable-textures: enable textures\n");
793 printf("\t--disable-wireframe: disable wireframe drawing mode\n");
794 printf("\t--enable-wireframe: enable wireframe drawing mode\n");
795 printf("\t--geometry=WWWxHHH: window geometry: 640x480, 800x600, etc.\n");
798 printf("Scenery Options:\n");
799 printf("\t--tile-radius=n: specify tile radius, must be 1 - 4\n");
802 printf("Hud Options:\n");
803 printf("\t--units-feet: Hud displays units in feet\n");
804 printf("\t--units-meters: Hud displays units in meters\n");
805 printf("\t--hud-tris: Hud displays number of triangles rendered\n");
806 printf("\t--hud-culled: Hud displays percentage of triangles culled\n");
809 printf("Time Options:\n");
810 printf("\t--time-offset=[+-]hh:mm:ss: offset local time by this amount\n");
811 printf("\t--start-date-gmt=yyyy:mm:dd:hh:mm:ss: specify a starting date/time. Time is Greenwich Mean Time\n");
812 printf("\t--start-date-lst=yyyy:mm:dd:hh:mm:ss: specify a starting date/time. Uses local sidereal time\n");
813 #ifdef FG_NETWORK_OLK
816 printf("Network Options:\n");
817 printf("\t--net-hud: Hud displays network info\n");
818 printf("\t--net-id=name: specify your own callsign\n");
824 fgOPTIONS::~fgOPTIONS( void ) {