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)
146 // Initialize current options velocities to 0.0
147 uBody(0.0), vBody(0.0), wBody(0.0),
155 control_mode(FG_JOYSTICK),
162 // Flight Model options
163 flight_model( FGInterface::FG_LARCSIM ),
164 model_hz( NEW_DEFAULT_MODEL_HZ ),
168 fog(FG_FOG_NICEST), // nicest
182 units(FG_UNITS_FEET),
191 // set initial values/defaults
192 char* envp = ::getenv( "FG_ROOT" );
194 if ( envp != NULL ) {
195 // fg_root could be anywhere, so default to environmental
196 // variable $FG_ROOT if it is set.
199 // Otherwise, default to a random compiled in location if
200 // $FG_ROOT is not set. This can still be overridden from the
201 // command line or a config file.
204 fg_root = "\\FlightGear";
205 #elif defined( MACOS )
212 airport_id = ""; // default airport id
213 net_id = "Johnney"; // default pilot's name
215 // initialize port config string list
216 port_options_list.erase ( port_options_list.begin(),
217 port_options_list.end() );
221 fgOPTIONS::toggle_panel() {
223 FGTime *t = FGTime::cur_time_params;
225 int toggle_pause = t->getPause();
228 t->togglePauseMode();
231 panel_status = false;
235 if ( panel_status ) {
236 if( FGPanel::OurPanel == 0)
240 fov *= (1.0 / 0.4232);
242 fgReshape( xsize, ysize);
245 t->togglePauseMode();
249 fgOPTIONS::parse_time(const string& time_in) {
250 char *time_str, num[256];
251 double hours, minutes, seconds;
256 time_str = (char *)time_in.c_str();
258 // printf("parse_time(): %s\n", time_str);
261 if ( strlen(time_str) ) {
262 if ( time_str[0] == '+' ) {
265 } else if ( time_str[0] == '-' ) {
270 // printf("sign = %d\n", sign);
273 if ( strlen(time_str) ) {
275 while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
276 num[i] = time_str[0];
280 if ( time_str[0] == ':' ) {
285 // printf("hours = %.2lf\n", hours);
291 if ( strlen(time_str) ) {
293 while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
294 num[i] = time_str[0];
298 if ( time_str[0] == ':' ) {
303 // printf("minutes = %.2lf\n", minutes);
305 result += minutes / 60.0;
309 if ( strlen(time_str) ) {
311 while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
312 num[i] = time_str[0];
318 // printf("seconds = %.2lf\n", seconds);
320 result += seconds / 3600.0;
323 return(sign * result);
327 long int fgOPTIONS::parse_date( const string& date)
330 char * date_str, num[256];
332 // initialize to zero
339 gmt.tm_isdst = 0; // ignore daylight savingtime for the moment
340 date_str = (char *)date.c_str();
342 if ( strlen(date_str) ) {
344 while ( (date_str[0] != ':') && (date_str[0] != '\0') ) {
345 num[i] = date_str[0];
349 if ( date_str[0] == ':' ) {
353 gmt.tm_year = atoi(num) - 1900;
356 if ( strlen(date_str) ) {
358 while ( (date_str[0] != ':') && (date_str[0] != '\0') ) {
359 num[i] = date_str[0];
363 if ( date_str[0] == ':' ) {
367 gmt.tm_mon = atoi(num) -1;
370 if ( strlen(date_str) ) {
372 while ( (date_str[0] != ':') && (date_str[0] != '\0') ) {
373 num[i] = date_str[0];
377 if ( date_str[0] == ':' ) {
381 gmt.tm_mday = atoi(num);
384 if ( strlen(date_str) ) {
386 while ( (date_str[0] != ':') && (date_str[0] != '\0') ) {
387 num[i] = date_str[0];
391 if ( date_str[0] == ':' ) {
395 gmt.tm_hour = atoi(num);
398 if ( strlen(date_str) ) {
400 while ( (date_str[0] != ':') && (date_str[0] != '\0') ) {
401 num[i] = date_str[0];
405 if ( date_str[0] == ':' ) {
409 gmt.tm_min = atoi(num);
412 if ( strlen(date_str) ) {
414 while ( (date_str[0] != ':') && (date_str[0] != '\0') ) {
415 num[i] = date_str[0];
419 if ( date_str[0] == ':' ) {
423 gmt.tm_sec = atoi(num);
425 time_t theTime = FGTime::cur_time_params->get_gmt(gmt.tm_year,
431 //printf ("Date is %s\n", ctime(&theTime));
432 //printf ("in seconds that is %d\n", theTime);
438 // parse degree in the form of [+/-]hhh:mm:ss
439 void fgOPTIONS::parse_control( const string& mode ) {
440 if ( mode == "joystick" ) {
441 control_mode = FG_JOYSTICK;
442 } else if ( mode == "mouse" ) {
443 control_mode = FG_MOUSE;
445 control_mode = FG_KEYBOARD;
450 /// parse degree in the form of [+/-]hhh:mm:ss
452 fgOPTIONS::parse_degree( const string& degree_str) {
453 double result = parse_time( degree_str );
455 // printf("Degree = %.4f\n", result);
461 // parse time offset command line option
463 fgOPTIONS::parse_time_offset( const string& time_str) {
466 // printf("time offset = %s\n", time_str);
469 result = (int)rint(parse_time(time_str) * 3600.0);
471 result = (int)(parse_time(time_str) * 3600.0);
474 // printf("parse_time_offset(): %d\n", result);
480 // Parse --tile-diameter=n type option
483 fgOPTIONS::parse_tile_radius( const string& arg ) {
484 int radius = atoi( arg );
486 if ( radius < FG_RADIUS_MIN ) { radius = FG_RADIUS_MIN; }
487 if ( radius > FG_RADIUS_MAX ) { radius = FG_RADIUS_MAX; }
489 // printf("parse_tile_radius(): radius = %d\n", radius);
495 // Parse --fdm=abcdefg type option
497 fgOPTIONS::parse_fdm( const string& fm ) {
498 // printf("fdm = %s\n", fm);
500 if ( fm == "slew" ) {
501 return FGInterface::FG_SLEW;
502 } else if ( fm == "jsb" ) {
503 return FGInterface::FG_JSBSIM;
504 } else if ( (fm == "larcsim") || (fm == "LaRCsim") ) {
505 return FGInterface::FG_LARCSIM;
506 } else if ( fm == "external" ) {
507 return FGInterface::FG_EXTERNAL;
509 FG_LOG( FG_GENERAL, FG_ALERT, "Unknown fdm = " << fm );
513 // we'll never get here, but it makes the compiler happy.
518 // Parse --fov=x.xx type option
520 fgOPTIONS::parse_fov( const string& arg ) {
521 double fov = atof(arg);
523 if ( fov < FG_FOV_MIN ) { fov = FG_FOV_MIN; }
524 if ( fov > FG_FOV_MAX ) { fov = FG_FOV_MAX; }
526 // printf("parse_fov(): result = %.4f\n", fov);
532 // Parse serial port option --serial=/dev/ttyS1,nmea,4800,out
534 // Format is "--serial=device,format,baud,direction" where
536 // device = OS device name to be open()'ed
537 // format = {nmea, garmin,fgfs,rul}
538 // baud = {300, 1200, 2400, ..., 230400}
539 // direction = {in, out, bi}
542 fgOPTIONS::parse_serial( const string& serial_str ) {
543 string::size_type pos;
545 // cout << "Serial string = " << serial_str << endl;
547 // a flailing attempt to see if the port config string has a
548 // chance at being valid
549 pos = serial_str.find(",");
550 if ( pos == string::npos ) {
551 FG_LOG( FG_GENERAL, FG_ALERT,
552 "Malformed serial port configure string" );
556 port_options_list.push_back( serial_str );
562 // Parse a single option
563 int fgOPTIONS::parse_option( const string& arg ) {
565 if ( (arg == "--help") || (arg == "-h") ) {
566 // help/usage request
567 return(FG_OPTIONS_HELP);
568 } else if ( arg == "--disable-game-mode") {
570 } else if ( arg == "--enable-game-mode" ) {
572 } else if ( arg == "--disable-splash-screen" ) {
573 splash_screen = false;
574 } else if ( arg == "--enable-splash-screen" ) {
575 splash_screen = true;
576 } else if ( arg == "--disable-intro-music" ) {
578 } else if ( arg == "--enable-intro-music" ) {
580 } else if ( arg == "--disable-mouse-pointer" ) {
582 } else if ( arg == "--enable-mouse-pointer" ) {
584 } else if ( arg == "--disable-pause" ) {
586 } else if ( arg == "--enable-pause" ) {
588 } else if ( arg.find( "--control=") != string::npos ) {
589 parse_control( arg.substr(10) );
590 } else if ( arg == "--disable-hud" ) {
592 } else if ( arg == "--enable-hud" ) {
594 } else if ( arg == "--disable-panel" ) {
595 panel_status = false;
596 } else if ( arg == "--enable-panel" ) {
599 } else if ( arg == "--disable-sound" ) {
601 } else if ( arg == "--enable-sound" ) {
603 } else if ( arg.find( "--airport-id=") != string::npos ) {
604 airport_id = arg.substr( 13 );
605 } else if ( arg.find( "--lon=" ) != string::npos ) {
606 lon = parse_degree( arg.substr(6) );
607 } else if ( arg.find( "--lat=" ) != string::npos ) {
608 lat = parse_degree( arg.substr(6) );
609 } else if ( arg.find( "--altitude=" ) != string::npos ) {
610 if ( units == FG_UNITS_FEET ) {
611 altitude = atof( arg.substr(11) ) * FEET_TO_METER;
613 altitude = atof( arg.substr(11) );
615 } else if ( arg.find( "--uBody=" ) != string::npos ) {
616 if ( units == FG_UNITS_FEET ) {
617 uBody = atof( arg.substr(8) ) * FEET_TO_METER;
619 uBody = atof( arg.substr(8) );
621 } else if ( arg.find( "--vBody=" ) != string::npos ) {
622 if ( units == FG_UNITS_FEET ) {
623 vBody = atof( arg.substr(8) ) * FEET_TO_METER;
625 vBody = atof( arg.substr(8) );
627 } else if ( arg.find( "--wBody=" ) != string::npos ) {
628 if ( units == FG_UNITS_FEET ) {
629 wBody = atof( arg.substr(8) ) * FEET_TO_METER;
631 wBody = atof( arg.substr(8) );
633 } else if ( arg.find( "--heading=" ) != string::npos ) {
634 heading = atof( arg.substr(10) );
635 } else if ( arg.find( "--roll=" ) != string::npos ) {
636 roll = atof( arg.substr(7) );
637 } else if ( arg.find( "--pitch=" ) != string::npos ) {
638 pitch = atof( arg.substr(8) );
639 } else if ( arg.find( "--fg-root=" ) != string::npos ) {
640 fg_root = arg.substr( 10 );
641 } else if ( arg.find( "--fdm=" ) != string::npos ) {
642 flight_model = parse_fdm( arg.substr(6) );
643 } else if ( arg.find( "--model-hz=" ) != string::npos ) {
644 model_hz = atoi( arg.substr(11) );
645 } else if ( arg.find( "--speed=" ) != string::npos ) {
646 speed_up = atoi( arg.substr(8) );
647 } else if ( arg == "--fog-disable" ) {
648 fog = FG_FOG_DISABLED;
649 } else if ( arg == "--fog-fastest" ) {
650 fog = FG_FOG_FASTEST;
651 } else if ( arg == "--fog-nicest" ) {
653 } else if ( arg.find( "--fov=" ) != string::npos ) {
654 fov = parse_fov( arg.substr(6) );
655 } else if ( arg == "--disable-fullscreen" ) {
657 } else if ( arg== "--enable-fullscreen") {
659 } else if ( arg == "--shading-flat") {
661 } else if ( arg == "--shading-smooth") {
663 } else if ( arg == "--disable-skyblend") {
665 } else if ( arg== "--enable-skyblend" ) {
667 } else if ( arg == "--disable-textures" ) {
669 } else if ( arg == "--enable-textures" ) {
671 } else if ( arg == "--disable-wireframe" ) {
673 } else if ( arg == "--enable-wireframe" ) {
675 } else if ( arg.find( "--geometry=" ) != string::npos ) {
676 bool geometry_ok = true;
677 string geometry = arg.substr( 11 );
678 string::size_type i = geometry.find('x');
680 if (i != string::npos) {
681 xsize = atoi(geometry.substr(0, i));
682 ysize = atoi(geometry.substr(i+1));
683 // cout << "Geometry is " << xsize << 'x' << ysize << '\n';
688 if ( xsize <= 0 || ysize <= 0 ) {
694 if ( !geometry_ok ) {
695 FG_LOG( FG_GENERAL, FG_ALERT, "Unknown geometry: " << geometry );
696 FG_LOG( FG_GENERAL, FG_ALERT,
697 "Setting geometry to " << xsize << 'x' << ysize << '\n');
699 } else if ( arg == "--units-feet" ) {
700 units = FG_UNITS_FEET;
701 } else if ( arg == "--units-meters" ) {
702 units = FG_UNITS_METERS;
703 } else if ( arg.find( "--tile-radius=" ) != string::npos ) {
704 tile_radius = parse_tile_radius( arg.substr(14) );
705 tile_diameter = tile_radius * 2 + 1;
706 } else if ( arg.find( "--time-offset=" ) != string::npos ) {
707 time_offset = parse_time_offset( (arg.substr(14)) );
708 } else if (arg.find( "--start-date-gmt=") != string::npos ) {
709 start_gst = parse_date( (arg.substr(17)) );
710 } else if (arg.find( "--start-data-lst=") != string::npos ) {
711 start_lst = parse_date( (arg.substr(17)) );
712 } else if ( arg == "--hud-tris" ) {
714 } else if ( arg == "--hud-culled" ) {
716 } else if ( arg.find( "--serial=" ) != string::npos ) {
717 parse_serial( arg.substr(9) );
718 #ifdef FG_NETWORK_OLK
719 } else if ( arg == "--net-hud" ) {
721 } else if ( arg.find( "--net-id=") != string::npos ) {
722 net_id = arg.substr( 9 );
725 FG_LOG( FG_GENERAL, FG_ALERT, "Unknown option '" << arg << "'" );
726 return FG_OPTIONS_ERROR;
729 return FG_OPTIONS_OK;
733 // Parse the command line options
734 int fgOPTIONS::parse_command_line( int argc, char **argv ) {
738 FG_LOG(FG_GENERAL, FG_INFO, "Processing command line arguments");
741 FG_LOG( FG_GENERAL, FG_DEBUG, "argv[" << i << "] = " << argv[i] );
743 result = parse_option(argv[i]);
744 if ( (result == FG_OPTIONS_HELP) || (result == FG_OPTIONS_ERROR) ) {
751 return(FG_OPTIONS_OK);
755 // Parse config file options
756 int fgOPTIONS::parse_config_file( const string& path ) {
757 fg_gzifstream in( path );
759 return(FG_OPTIONS_ERROR);
761 FG_LOG( FG_GENERAL, FG_INFO, "Processing config file: " << path );
765 while ( ! in.eof() ) {
768 while ( in.get(c) && c != '\0' ) {
773 #ifdef GETLINE_NEEDS_TERMINATOR
774 getline( in, line, '\n' );
779 if ( parse_option( line ) == FG_OPTIONS_ERROR ) {
780 FG_LOG( FG_GENERAL, FG_ALERT,
781 "Config file parse error: " << path << " '"
788 return FG_OPTIONS_OK;
792 // Print usage message
793 void fgOPTIONS::usage ( void ) {
794 printf("Usage: fg [ options ... ]\n");
797 printf("General Options:\n");
798 printf("\t--help -h: print usage\n");
799 printf("\t--fg-root=path: specify the root path for all the data files\n");
800 printf("\t--disable-game-mode: disable full-screen game mode\n");
801 printf("\t--enable-game-mode: enable full-screen game mode\n");
802 printf("\t--disable-splash-screen: disable splash screen\n");
803 printf("\t--enable-splash-screen: enable splash screen\n");
804 printf("\t--disable-intro-music: disable introduction music\n");
805 printf("\t--enable-intro-music: enable introduction music\n");
806 printf("\t--disable-mouse-pointer: disable extra mouse pointer\n");
807 printf("\t--enable-mouse-pointer: enable extra mouse pointer (i.e. for\n");
808 printf("\t\tfull screen voodoo/voodoo-II based cards.)\n");
809 printf("\t--disable-pause: start out in an active state\n");
810 printf("\t--enable-pause: start out in a paused state\n");
811 printf("\t--control=mode: primary control mode (joystick, keyboard, mouse)\n");
814 printf("Features:\n");
815 printf("\t--disable-hud: disable heads up display\n");
816 printf("\t--enable-hud: enable heads up display\n");
817 printf("\t--disable-panel: disable instrument panel\n");
818 printf("\t--enable-panel: enable instrumetn panel\n");
819 printf("\t--disable-sound: disable sound effects\n");
820 printf("\t--enable-sound: enable sound effects\n");
823 printf("Flight Model:\n");
824 printf("\t--fdm=abcd: one of slew, jsb, larcsim, or external\n");
825 printf("\t--model-hz=n: run the FDM this rate (iterations per second)\n");
826 printf("\t--speed=n: run the FDM this much faster than real time\n");
829 printf("Initial Position and Orientation:\n");
830 printf("\t--airport-id=ABCD: specify starting postion by airport id\n");
831 printf("\t--lon=degrees: starting longitude in degrees (west = -)\n");
832 printf("\t--lat=degrees: starting latitude in degrees (south = -)\n");
833 printf("\t--altitude=feet: starting altitude in feet\n");
834 printf("\t\t(unless --units-meters specified\n");
835 printf("\t--heading=degrees: heading (yaw) angle in degress (Psi)\n");
836 printf("\t--roll=degrees: roll angle in degrees (Phi)\n");
837 printf("\t--pitch=degrees: pitch angle in degrees (Theta)\n");
838 printf("\t--uBody=feet per second: velocity along the body X axis\n");
839 printf("\t--vBody=feet per second: velocity along the body Y axis\n");
840 printf("\t--wBody=feet per second: velocity along the body Z axis\n");
841 printf("\t\t(unless --units-meters specified\n");
844 printf("Rendering Options:\n");
845 printf("\t--fog-disable: disable fog/haze\n");
846 printf("\t--fog-fastest: enable fastest fog/haze\n");
847 printf("\t--fog-nicest: enable nicest fog/haze\n");
848 printf("\t--fov=xx.x: specify initial field of view angle in degrees\n");
849 printf("\t--disable-fullscreen: disable fullscreen mode\n");
850 printf("\t--enable-fullscreen: enable fullscreen mode\n");
851 printf("\t--shading-flat: enable flat shading\n");
852 printf("\t--shading-smooth: enable smooth shading\n");
853 printf("\t--disable-skyblend: disable sky blending\n");
854 printf("\t--enable-skyblend: enable sky blending\n");
855 printf("\t--disable-textures: disable textures\n");
856 printf("\t--enable-textures: enable textures\n");
857 printf("\t--disable-wireframe: disable wireframe drawing mode\n");
858 printf("\t--enable-wireframe: enable wireframe drawing mode\n");
859 printf("\t--geometry=WWWxHHH: window geometry: 640x480, 800x600, etc.\n");
862 printf("Scenery Options:\n");
863 printf("\t--tile-radius=n: specify tile radius, must be 1 - 4\n");
866 printf("Hud Options:\n");
867 printf("\t--units-feet: Hud displays units in feet\n");
868 printf("\t--units-meters: Hud displays units in meters\n");
869 printf("\t--hud-tris: Hud displays number of triangles rendered\n");
870 printf("\t--hud-culled: Hud displays percentage of triangles culled\n");
873 printf("Time Options:\n");
874 printf("\t--time-offset=[+-]hh:mm:ss: offset local time by this amount\n");
875 printf("\t--start-date-gmt=yyyy:mm:dd:hh:mm:ss: specify a starting date/time. Time is Greenwich Mean Time\n");
876 printf("\t--start-date-lst=yyyy:mm:dd:hh:mm:ss: specify a starting date/time. Uses local sidereal time\n");
877 #ifdef FG_NETWORK_OLK
880 printf("Network Options:\n");
881 printf("\t--net-hud: Hud displays network info\n");
882 printf("\t--net-id=name: specify your own callsign\n");
888 fgOPTIONS::~fgOPTIONS( void ) {