1 // options.cxx -- class to handle command line options
3 // Written by Curtis Olson, started April 1998.
5 // Copyright (C) 1998 Curtis L. Olson - http://www.flightgear.org/~curt
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
28 #include <simgear/compiler.h>
29 #include <simgear/structure/exception.hxx>
30 #include <simgear/debug/logstream.hxx>
32 #include <math.h> // rint()
34 #include <stdlib.h> // atof(), atoi()
35 #include <string.h> // strcmp()
42 #include <simgear/math/sg_random.h>
43 #include <simgear/misc/sgstream.hxx>
44 #include <simgear/misc/sg_path.hxx>
45 #include <simgear/scene/material/mat.hxx>
47 // #include <Include/general.hxx>
48 // #include <Airports/simple.hxx>
49 // #include <Cockpit/cockpit.hxx>
50 // #include <FDM/flight.hxx>
52 #include <Autopilot/route_mgr.hxx>
55 #include "globals.hxx"
56 #include "fg_init.hxx"
57 #include "fg_props.hxx"
58 #include "options.hxx"
60 #include "viewmgr.hxx"
65 SG_USING_NAMESPACE(std);
68 #define NEW_DEFAULT_MODEL_HZ 120
75 FG_OPTIONS_VERBOSE_HELP = 3,
76 FG_OPTIONS_SHOW_AIRCRAFT = 4
80 atof( const string& str )
84 // -dw- if ::atof is called, then we get an infinite loop
85 return std::atof( str.c_str() );
87 return ::atof( str.c_str() );
92 atoi( const string& str )
95 // -dw- if ::atoi is called, then we get an infinite loop
96 return std::atoi( str.c_str() );
98 return ::atoi( str.c_str() );
104 * Set a few fail-safe default property values.
106 * These should all be set in $FG_ROOT/preferences.xml, but just
107 * in case, we provide some initial sane values here. This method
108 * should be invoked *before* reading any init files.
113 // set a possibly independent location for scenery data
114 char *envp = ::getenv( "FG_SCENERY" );
116 if ( envp != NULL ) {
117 // fg_root could be anywhere, so default to environmental
118 // variable $FG_ROOT if it is set.
119 globals->set_fg_scenery(envp);
121 // Otherwise, default to Scenery being in $FG_ROOT/Scenery
122 globals->set_fg_scenery("");
124 // Position (deliberately out of range)
125 fgSetDouble("/position/longitude-deg", 9999.0);
126 fgSetDouble("/position/latitude-deg", 9999.0);
127 fgSetDouble("/position/altitude-ft", -9999.0);
130 fgSetDouble("/orientation/heading-deg", 270);
131 fgSetDouble("/orientation/roll-deg", 0);
132 fgSetDouble("/orientation/pitch-deg", 0.424);
135 fgSetDouble("/velocities/uBody-fps", 0.0);
136 fgSetDouble("/velocities/vBody-fps", 0.0);
137 fgSetDouble("/velocities/wBody-fps", 0.0);
138 fgSetDouble("/velocities/speed-north-fps", 0.0);
139 fgSetDouble("/velocities/speed-east-fps", 0.0);
140 fgSetDouble("/velocities/speed-down-fps", 0.0);
141 fgSetDouble("/velocities/airspeed-kt", 0.0);
142 fgSetDouble("/velocities/mach", 0.0);
145 fgSetDouble("/sim/presets/longitude-deg", 9999.0);
146 fgSetDouble("/sim/presets/latitude-deg", 9999.0);
147 fgSetDouble("/sim/presets/altitude-ft", -9999.0);
149 fgSetDouble("/sim/presets/heading-deg", 270);
150 fgSetDouble("/sim/presets/roll-deg", 0);
151 fgSetDouble("/sim/presets/pitch-deg", 0.424);
153 fgSetString("/sim/presets/speed-set", "knots");
154 fgSetDouble("/sim/presets/airspeed-kt", 0.0);
155 fgSetDouble("/sim/presets/mach", 0.0);
156 fgSetDouble("/sim/presets/uBody-fps", 0.0);
157 fgSetDouble("/sim/presets/vBody-fps", 0.0);
158 fgSetDouble("/sim/presets/wBody-fps", 0.0);
159 fgSetDouble("/sim/presets/speed-north-fps", 0.0);
160 fgSetDouble("/sim/presets/speed-east-fps", 0.0);
161 fgSetDouble("/sim/presets/speed-down-fps", 0.0);
163 fgSetBool("/sim/presets/onground", true);
164 fgSetBool("/sim/presets/trim", false);
167 fgSetBool("/sim/startup/game-mode", false);
168 fgSetBool("/sim/startup/splash-screen", true);
169 fgSetBool("/sim/startup/intro-music", true);
170 // we want mouse-pointer to have an undefined value if nothing is
171 // specified so we can do the right thing for voodoo-1/2 cards.
172 // fgSetString("/sim/startup/mouse-pointer", "disabled");
173 fgSetString("/sim/control-mode", "joystick");
174 fgSetBool("/sim/auto-coordination", false);
176 fgSetString("/sim/startup/browser-app", "webrun.bat");
177 #elif defined(__APPLE__)
178 fgSetString("/sim/startup/browser-app", "open");
180 fgSetString("/sim/startup/browser-app", "launchWebJumper");
182 envp = ::getenv( "WEBBROWSER" );
183 if (!envp) envp = "netscape";
184 fgSetString("/sim/startup/browser-app", envp);
186 fgSetString("/sim/logging/priority", "alert");
189 fgSetBool("/sim/hud/color/antialiased", false);
190 fgSetBool("/sim/hud/enable3d", true);
191 fgSetBool("/sim/hud/visibility", false);
192 fgSetBool("/sim/panel/visibility", true);
193 fgSetBool("/sim/sound/pause", false);
195 // Flight Model options
196 fgSetString("/sim/flight-model", "jsb");
197 fgSetString("/sim/aero", "c172");
198 fgSetInt("/sim/model-hz", NEW_DEFAULT_MODEL_HZ);
199 fgSetInt("/sim/speed-up", 1);
202 fgSetString("/sim/rendering/fog", "nicest");
203 fgSetBool("/environment/clouds/status", true);
204 fgSetBool("/sim/startup/fullscreen", false);
205 fgSetBool("/sim/rendering/shading", true);
206 fgSetBool("/sim/rendering/skyblend", true);
207 fgSetBool("/sim/rendering/textures", true);
208 fgTie( "/sim/rendering/filtering", SGTextureFilterListener::getFilter, SGTextureFilterListener::setFilter, false);
209 fgSetInt("/sim/rendering/filtering", 1);
210 fgSetBool("/sim/rendering/wireframe", false);
211 fgSetBool("/sim/rendering/horizon-effect", false);
212 fgSetBool("/sim/rendering/enhanced-lighting", false);
213 fgSetBool("/sim/rendering/distance-attenuation", false);
214 fgSetBool("/sim/rendering/specular-highlight", true);
215 fgSetInt("/sim/startup/xsize", 800);
216 fgSetInt("/sim/startup/ysize", 600);
217 fgSetInt("/sim/rendering/bits-per-pixel", 16);
218 fgSetString("/sim/view-mode", "pilot");
219 fgSetDouble("/sim/current-view/heading-offset-deg", 0);
222 fgSetString("/sim/startup/units", "feet");
223 fgSetString("/sim/hud/frame-stat-type", "tris");
226 fgSetInt("/sim/startup/time-offset", 0);
227 fgSetString("/sim/startup/time-offset-type", "system-offset");
228 fgSetLong("/sim/time/cur-time-override", 0);
231 fgSetBool("/sim/freeze/master", false);
232 fgSetBool("/sim/freeze/position", false);
233 fgSetBool("/sim/freeze/clock", false);
234 fgSetBool("/sim/freeze/fuel", false);
236 fgSetString("/sim/multiplay/callsign", "callsign");
237 fgSetString("/sim/multiplay/rxhost", "0");
238 fgSetString("/sim/multiplay/txhost", "0");
239 fgSetInt("/sim/multiplay/rxport", 0);
240 fgSetInt("/sim/multiplay/txport", 0);
244 parse_wind (const string &wind, double * min_hdg, double * max_hdg,
245 double * speed, double * gust)
247 string::size_type pos = wind.find('@');
248 if (pos == string::npos)
250 string dir = wind.substr(0, pos);
251 string spd = wind.substr(pos+1);
253 if (pos == string::npos) {
254 *min_hdg = *max_hdg = atof(dir.c_str());
256 *min_hdg = atof(dir.substr(0,pos).c_str());
257 *max_hdg = atof(dir.substr(pos+1).c_str());
260 if (pos == string::npos) {
261 *speed = *gust = atof(spd.c_str());
263 *speed = atof(spd.substr(0,pos).c_str());
264 *gust = atof(spd.substr(pos+1).c_str());
269 // parse a time string ([+/-]%f[:%f[:%f]]) into hours
271 parse_time(const string& time_in) {
272 char *time_str, num[256];
273 double hours, minutes, seconds;
278 time_str = (char *)time_in.c_str();
280 // printf("parse_time(): %s\n", time_str);
283 if ( strlen(time_str) ) {
284 if ( time_str[0] == '+' ) {
287 } else if ( time_str[0] == '-' ) {
292 // printf("sign = %d\n", sign);
295 if ( strlen(time_str) ) {
297 while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
298 num[i] = time_str[0];
302 if ( time_str[0] == ':' ) {
307 // printf("hours = %.2lf\n", hours);
313 if ( strlen(time_str) ) {
315 while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
316 num[i] = time_str[0];
320 if ( time_str[0] == ':' ) {
325 // printf("minutes = %.2lf\n", minutes);
327 result += minutes / 60.0;
331 if ( strlen(time_str) ) {
333 while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
334 num[i] = time_str[0];
340 // printf("seconds = %.2lf\n", seconds);
342 result += seconds / 3600.0;
345 SG_LOG( SG_GENERAL, SG_INFO, " parse_time() = " << sign * result );
347 return(sign * result);
351 // parse a date string (yyyy:mm:dd:hh:mm:ss) into a time_t (seconds)
353 parse_date( const string& date)
356 char * date_str, num[256];
358 // initialize to zero
365 gmt.tm_isdst = 0; // ignore daylight savings time for the moment
366 date_str = (char *)date.c_str();
368 if ( strlen(date_str) ) {
370 while ( (date_str[0] != ':') && (date_str[0] != '\0') ) {
371 num[i] = date_str[0];
375 if ( date_str[0] == ':' ) {
379 gmt.tm_year = atoi(num) - 1900;
382 if ( strlen(date_str) ) {
384 while ( (date_str[0] != ':') && (date_str[0] != '\0') ) {
385 num[i] = date_str[0];
389 if ( date_str[0] == ':' ) {
393 gmt.tm_mon = atoi(num) -1;
396 if ( strlen(date_str) ) {
398 while ( (date_str[0] != ':') && (date_str[0] != '\0') ) {
399 num[i] = date_str[0];
403 if ( date_str[0] == ':' ) {
407 gmt.tm_mday = atoi(num);
410 if ( strlen(date_str) ) {
412 while ( (date_str[0] != ':') && (date_str[0] != '\0') ) {
413 num[i] = date_str[0];
417 if ( date_str[0] == ':' ) {
421 gmt.tm_hour = atoi(num);
424 if ( strlen(date_str) ) {
426 while ( (date_str[0] != ':') && (date_str[0] != '\0') ) {
427 num[i] = date_str[0];
431 if ( date_str[0] == ':' ) {
435 gmt.tm_min = atoi(num);
438 if ( strlen(date_str) ) {
440 while ( (date_str[0] != ':') && (date_str[0] != '\0') ) {
441 num[i] = date_str[0];
445 if ( date_str[0] == ':' ) {
449 gmt.tm_sec = atoi(num);
451 time_t theTime = sgTimeGetGMT( gmt.tm_year, gmt.tm_mon, gmt.tm_mday,
452 gmt.tm_hour, gmt.tm_min, gmt.tm_sec );
453 //printf ("Date is %s\n", ctime(&theTime));
454 //printf ("in seconds that is %d\n", theTime);
460 // parse angle in the form of [+/-]ddd:mm:ss into degrees
462 parse_degree( const string& degree_str) {
463 double result = parse_time( degree_str );
465 // printf("Degree = %.4f\n", result);
471 // parse time offset string into seconds
473 parse_time_offset( const string& time_str) {
476 // printf("time offset = %s\n", time_str);
479 result = (int)rint(parse_time(time_str) * 3600.0);
481 result = (int)(parse_time(time_str) * 3600.0);
484 // printf("parse_time_offset(): %d\n", result);
490 // Parse --fov=x.xx type option
492 parse_fov( const string& arg ) {
493 double fov = atof(arg);
495 if ( fov < FG_FOV_MIN ) { fov = FG_FOV_MIN; }
496 if ( fov > FG_FOV_MAX ) { fov = FG_FOV_MAX; }
498 fgSetDouble("/sim/current-view/field-of-view", fov);
500 // printf("parse_fov(): result = %.4f\n", fov);
506 // Parse I/O channel option
508 // Format is "--protocol=medium,direction,hz,medium_options,..."
510 // protocol = { native, nmea, garmin, AV400, fgfs, rul, pve, etc. }
511 // medium = { serial, socket, file, etc. }
512 // direction = { in, out, bi }
513 // hz = number of times to process channel per second (floating
514 // point values are ok.
516 // Serial example "--nmea=serial,dir,hz,device,baud" where
518 // device = OS device name of serial line to be open()'ed
519 // baud = {300, 1200, 2400, ..., 230400}
521 // Socket exacmple "--native=socket,dir,hz,machine,port,style" where
523 // machine = machine name or ip address if client (leave empty if server)
524 // port = port, leave empty to let system choose
525 // style = tcp or udp
527 // File example "--garmin=file,dir,hz,filename" where
529 // filename = file system file name
532 add_channel( const string& type, const string& channel_str ) {
533 SG_LOG(SG_GENERAL, SG_INFO, "Channel string = " << channel_str );
534 globals->get_channel_options_list()->push_back( type + "," + channel_str );
539 // The parse wp and parse flight-plan options don't work anymore, because
540 // the route manager and the airport subsystems have not yet been initialized
543 // Parse --wp=ID[@alt]
545 parse_wp( const string& arg ) {
546 string_list *waypoints = globals->get_initial_waypoints();
548 waypoints = new string_list;
549 globals->set_initial_waypoints(waypoints);
551 waypoints->push_back(arg);
555 // Parse --flight-plan=[file]
557 parse_flightplan(const string& arg)
559 string_list *waypoints = globals->get_initial_waypoints();
561 waypoints = new string_list;
562 globals->set_initial_waypoints(waypoints);
565 sg_gzifstream in(arg.c_str());
572 #if defined( macintosh )
573 getline( in, line, '\r' );
575 getline( in, line, '\n' );
577 // catch extraneous (DOS) line ending character
578 if ( line[line.length() - 1] < 32 )
579 line = line.substr( 0, line.length()-1 );
584 waypoints->push_back(line);
591 fgOptLanguage( const char *arg )
593 globals->set_locale( fgInitLocale( arg ) );
594 return FG_OPTIONS_OK;
600 fgSetString("/sim/presets/airport-id", "");
601 fgSetString("/sim/presets/vor-id", "");
602 fgSetString("/sim/presets/ndb-id", "");
603 fgSetString("/sim/presets/carrier", "");
604 fgSetString("/sim/presets/parkpos", "");
605 fgSetString("/sim/presets/fix", "");
609 fgOptVOR( const char * arg )
612 fgSetString("/sim/presets/vor-id", arg);
613 return FG_OPTIONS_OK;
617 fgOptNDB( const char * arg )
620 fgSetString("/sim/presets/ndb-id", arg);
621 return FG_OPTIONS_OK;
625 fgOptCarrier( const char * arg )
628 fgSetString("/sim/presets/carrier", arg);
629 return FG_OPTIONS_OK;
633 fgOptParkpos( const char * arg )
635 fgSetString("/sim/presets/parkpos", arg);
636 return FG_OPTIONS_OK;
640 fgOptFIX( const char * arg )
643 fgSetString("/sim/presets/fix", arg);
644 return FG_OPTIONS_OK;
648 fgOptLon( const char *arg )
651 fgSetDouble("/sim/presets/longitude-deg", parse_degree( arg ));
652 fgSetDouble("/position/longitude-deg", parse_degree( arg ));
653 return FG_OPTIONS_OK;
657 fgOptLat( const char *arg )
660 fgSetDouble("/sim/presets/latitude-deg", parse_degree( arg ));
661 fgSetDouble("/position/latitude-deg", parse_degree( arg ));
662 return FG_OPTIONS_OK;
666 fgOptAltitude( const char *arg )
668 fgSetBool("/sim/presets/onground", false);
669 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
670 fgSetDouble("/sim/presets/altitude-ft", atof( arg ));
672 fgSetDouble("/sim/presets/altitude-ft",
673 atof( arg ) * SG_METER_TO_FEET);
674 return FG_OPTIONS_OK;
678 fgOptUBody( const char *arg )
680 fgSetString("/sim/presets/speed-set", "UVW");
681 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
682 fgSetDouble("/sim/presets/uBody-fps", atof( arg ));
684 fgSetDouble("/sim/presets/uBody-fps",
685 atof( arg ) * SG_METER_TO_FEET);
686 return FG_OPTIONS_OK;
690 fgOptVBody( const char *arg )
692 fgSetString("/sim/presets/speed-set", "UVW");
693 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
694 fgSetDouble("/sim/presets/vBody-fps", atof( arg ));
696 fgSetDouble("/sim/presets/vBody-fps",
697 atof( arg ) * SG_METER_TO_FEET);
698 return FG_OPTIONS_OK;
702 fgOptWBody( const char *arg )
704 fgSetString("/sim/presets/speed-set", "UVW");
705 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
706 fgSetDouble("/sim/presets/wBody-fps", atof(arg));
708 fgSetDouble("/sim/presets/wBody-fps",
709 atof(arg) * SG_METER_TO_FEET);
710 return FG_OPTIONS_OK;
714 fgOptVNorth( const char *arg )
716 fgSetString("/sim/presets/speed-set", "NED");
717 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
718 fgSetDouble("/sim/presets/speed-north-fps", atof( arg ));
720 fgSetDouble("/sim/presets/speed-north-fps",
721 atof( arg ) * SG_METER_TO_FEET);
722 return FG_OPTIONS_OK;
726 fgOptVEast( const char *arg )
728 fgSetString("/sim/presets/speed-set", "NED");
729 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
730 fgSetDouble("/sim/presets/speed-east-fps", atof(arg));
732 fgSetDouble("/sim/presets/speed-east-fps",
733 atof(arg) * SG_METER_TO_FEET);
734 return FG_OPTIONS_OK;
738 fgOptVDown( const char *arg )
740 fgSetString("/sim/presets/speed-set", "NED");
741 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
742 fgSetDouble("/sim/presets/speed-down-fps", atof(arg));
744 fgSetDouble("/sim/presets/speed-down-fps",
745 atof(arg) * SG_METER_TO_FEET);
746 return FG_OPTIONS_OK;
750 fgOptVc( const char *arg )
752 // fgSetString("/sim/presets/speed-set", "knots");
753 // fgSetDouble("/velocities/airspeed-kt", atof(arg.substr(5)));
754 fgSetString("/sim/presets/speed-set", "knots");
755 fgSetDouble("/sim/presets/airspeed-kt", atof(arg));
756 return FG_OPTIONS_OK;
760 fgOptMach( const char *arg )
762 fgSetString("/sim/presets/speed-set", "mach");
763 fgSetDouble("/sim/presets/mach", atof(arg));
764 return FG_OPTIONS_OK;
768 fgOptRoc( const char *arg )
770 fgSetDouble("/velocities/vertical-speed-fps", atof(arg)/60);
771 return FG_OPTIONS_OK;
775 fgOptFgRoot( const char *arg )
777 globals->set_fg_root(arg);
778 return FG_OPTIONS_OK;
782 fgOptFgScenery( const char *arg )
784 globals->set_fg_scenery(arg);
785 return FG_OPTIONS_OK;
789 fgOptFov( const char *arg )
792 return FG_OPTIONS_OK;
796 fgOptGeometry( const char *arg )
798 bool geometry_ok = true;
799 int xsize = 0, ysize = 0;
800 string geometry = arg;
801 string::size_type i = geometry.find('x');
803 if (i != string::npos) {
804 xsize = atoi(geometry.substr(0, i));
805 ysize = atoi(geometry.substr(i+1));
810 if ( xsize <= 0 || ysize <= 0 ) {
816 if ( !geometry_ok ) {
817 SG_LOG( SG_GENERAL, SG_ALERT, "Unknown geometry: " << geometry );
818 SG_LOG( SG_GENERAL, SG_ALERT,
819 "Setting geometry to " << xsize << 'x' << ysize << '\n');
821 SG_LOG( SG_GENERAL, SG_INFO,
822 "Setting geometry to " << xsize << 'x' << ysize << '\n');
823 fgSetInt("/sim/startup/xsize", xsize);
824 fgSetInt("/sim/startup/ysize", ysize);
826 return FG_OPTIONS_OK;
830 fgOptBpp( const char *arg )
832 string bits_per_pix = arg;
833 if ( bits_per_pix == "16" ) {
834 fgSetInt("/sim/rendering/bits-per-pixel", 16);
835 } else if ( bits_per_pix == "24" ) {
836 fgSetInt("/sim/rendering/bits-per-pixel", 24);
837 } else if ( bits_per_pix == "32" ) {
838 fgSetInt("/sim/rendering/bits-per-pixel", 32);
840 SG_LOG(SG_GENERAL, SG_ALERT, "Unsupported bpp " << bits_per_pix);
842 return FG_OPTIONS_OK;
846 fgOptTimeOffset( const char *arg )
848 fgSetInt("/sim/startup/time-offset",
849 parse_time_offset( arg ));
850 fgSetString("/sim/startup/time-offset-type", "system-offset");
851 return FG_OPTIONS_OK;
855 fgOptStartDateSys( const char *arg )
857 fgSetInt("/sim/startup/time-offset", parse_date( arg ) );
858 fgSetString("/sim/startup/time-offset-type", "system");
859 return FG_OPTIONS_OK;
863 fgOptStartDateLat( const char *arg )
865 fgSetInt("/sim/startup/time-offset", parse_date( arg ) );
866 fgSetString("/sim/startup/time-offset-type", "latitude");
867 return FG_OPTIONS_OK;
871 fgOptStartDateGmt( const char *arg )
873 fgSetInt("/sim/startup/time-offset", parse_date( arg ) );
874 fgSetString("/sim/startup/time-offset-type", "gmt");
875 return FG_OPTIONS_OK;
879 fgSetupProxy( const char *arg )
881 string options = arg;
882 string host, port, auth;
883 string::size_type pos;
885 host = port = auth = "";
886 if ((pos = options.find("@")) != string::npos)
887 auth = options.substr(0, pos++);
891 host = options.substr(pos, options.size());
892 if ((pos = host.find(":")) != string::npos) {
893 port = host.substr(++pos, host.size());
894 host.erase(--pos, host.size());
897 fgSetString("/sim/presets/proxy/host", host.c_str());
898 fgSetString("/sim/presets/proxy/port", port.c_str());
899 fgSetString("/sim/presets/proxy/authentication", auth.c_str());
901 return FG_OPTIONS_OK;
905 fgOptTraceRead( const char *arg )
908 SG_LOG(SG_GENERAL, SG_INFO, "Tracing reads for property " << name);
909 fgGetNode(name.c_str(), true)
910 ->setAttribute(SGPropertyNode::TRACE_READ, true);
911 return FG_OPTIONS_OK;
915 fgOptLogLevel( const char *arg )
917 fgSetString("/sim/logging/classes", "all");
918 fgSetString("/sim/logging/priority", arg);
920 string priority = arg;
921 logbuf::set_log_classes(SG_ALL);
922 if (priority == "bulk") {
923 logbuf::set_log_priority(SG_BULK);
924 } else if (priority == "debug") {
925 logbuf::set_log_priority(SG_DEBUG);
926 } else if (priority == "info") {
927 logbuf::set_log_priority(SG_INFO);
928 } else if (priority == "warn") {
929 logbuf::set_log_priority(SG_WARN);
930 } else if (priority == "alert") {
931 logbuf::set_log_priority(SG_ALERT);
933 SG_LOG(SG_GENERAL, SG_WARN, "Unknown logging priority " << priority);
935 SG_LOG(SG_GENERAL, SG_DEBUG, "Logging priority is " << priority);
937 return FG_OPTIONS_OK;
942 fgOptTraceWrite( const char *arg )
945 SG_LOG(SG_GENERAL, SG_INFO, "Tracing writes for property " << name);
946 fgGetNode(name.c_str(), true)
947 ->setAttribute(SGPropertyNode::TRACE_WRITE, true);
948 return FG_OPTIONS_OK;
952 fgOptViewOffset( const char *arg )
954 // $$$ begin - added VS Renganathan, 14 Oct 2K
955 // for multi-window outside window imagery
956 string woffset = arg;
957 double default_view_offset = 0.0;
958 if ( woffset == "LEFT" ) {
959 default_view_offset = SGD_PI * 0.25;
960 } else if ( woffset == "RIGHT" ) {
961 default_view_offset = SGD_PI * 1.75;
962 } else if ( woffset == "CENTER" ) {
963 default_view_offset = 0.00;
965 default_view_offset = atof( woffset.c_str() ) * SGD_DEGREES_TO_RADIANS;
967 /* apparently not used (CLO, 11 Jun 2002)
968 FGViewer *pilot_view =
969 (FGViewer *)globals->get_viewmgr()->get_view( 0 ); */
970 // this will work without calls to the viewer...
971 fgSetDouble( "/sim/current-view/heading-offset-deg",
972 default_view_offset * SGD_RADIANS_TO_DEGREES );
973 // $$$ end - added VS Renganathan, 14 Oct 2K
974 return FG_OPTIONS_OK;
978 fgOptVisibilityMeters( const char *arg )
980 double visibility = atof( arg );
981 fgDefaultWeatherValue("visibility-m", visibility);
982 return FG_OPTIONS_OK;
986 fgOptVisibilityMiles( const char *arg )
988 double visibility = atof( arg ) * 5280.0 * SG_FEET_TO_METER;
989 fgDefaultWeatherValue("visibility-m", visibility);
990 return FG_OPTIONS_OK;
994 fgOptRandomWind( const char *arg )
996 double min_hdg = sg_random() * 360.0;
997 double max_hdg = min_hdg + (20 - sqrt(sg_random() * 400));
998 double speed = sg_random() * sg_random() * 40;
999 double gust = speed + (10 - sqrt(sg_random() * 100));
1000 fgSetupWind(min_hdg, max_hdg, speed, gust);
1001 return FG_OPTIONS_OK;
1005 fgOptWind( const char *arg )
1007 double min_hdg, max_hdg, speed, gust;
1008 if (!parse_wind( arg, &min_hdg, &max_hdg, &speed, &gust)) {
1009 SG_LOG( SG_GENERAL, SG_ALERT, "bad wind value " << arg );
1010 return FG_OPTIONS_ERROR;
1012 fgSetupWind(min_hdg, max_hdg, speed, gust);
1013 return FG_OPTIONS_OK;
1017 fgOptTurbulence( const char *arg )
1019 fgDefaultWeatherValue("turbulence/magnitude-norm", atof(arg));
1020 return FG_OPTIONS_OK;
1024 fgOptCeiling( const char *arg )
1026 double elevation, thickness;
1028 string::size_type pos = spec.find(':');
1029 if (pos == string::npos) {
1030 elevation = atof(spec.c_str());
1033 elevation = atof(spec.substr(0, pos).c_str());
1034 thickness = atof(spec.substr(pos + 1).c_str());
1036 fgSetDouble("/environment/clouds/layer[0]/elevation-ft", elevation);
1037 fgSetDouble("/environment/clouds/layer[0]/thickness-ft", thickness);
1038 fgSetString("/environment/clouds/layer[0]/coverage", "overcast");
1039 return FG_OPTIONS_OK;
1043 fgOptWp( const char *arg )
1046 return FG_OPTIONS_OK;
1050 fgOptFlightPlan( const char *arg )
1052 parse_flightplan ( arg );
1053 return FG_OPTIONS_OK;
1057 fgOptConfig( const char *arg )
1061 readProperties(file, globals->get_props());
1062 } catch (const sg_exception &e) {
1063 string message = "Error loading config file: ";
1064 message += e.getFormattedMessage() + e.getOrigin();
1065 SG_LOG(SG_INPUT, SG_ALERT, message);
1068 return FG_OPTIONS_OK;
1072 parse_colon (const string &s, double * val1, double * val2)
1074 string::size_type pos = s.find(':');
1075 if (pos == string::npos) {
1079 *val1 = atof(s.substr(0, pos).c_str());
1080 *val2 = atof(s.substr(pos+1).c_str());
1087 fgOptFailure( const char * arg )
1091 fgSetBool("/systems/pitot/serviceable", false);
1092 } else if (a == "static") {
1093 fgSetBool("/systems/static/serviceable", false);
1094 } else if (a == "vacuum") {
1095 fgSetBool("/systems/vacuum/serviceable", false);
1096 } else if (a == "electrical") {
1097 fgSetBool("/systems/electrical/serviceable", false);
1099 SG_LOG(SG_INPUT, SG_ALERT, "Unknown failure mode: " << a);
1100 return FG_OPTIONS_ERROR;
1103 return FG_OPTIONS_OK;
1108 fgOptNAV1( const char * arg )
1110 double radial, freq;
1111 if (parse_colon(arg, &radial, &freq))
1112 fgSetDouble("/instrumentation/nav[0]/radials/selected-deg", radial);
1113 fgSetDouble("/instrumentation/nav[0]/frequencies/selected-mhz", freq);
1114 return FG_OPTIONS_OK;
1118 fgOptNAV2( const char * arg )
1120 double radial, freq;
1121 if (parse_colon(arg, &radial, &freq))
1122 fgSetDouble("/instrumentation/nav[1]/radials/selected-deg", radial);
1123 fgSetDouble("/instrumentation/nav[1]/frequencies/selected-mhz", freq);
1124 return FG_OPTIONS_OK;
1128 fgOptADF( const char * arg )
1131 if (parse_colon(arg, &rot, &freq))
1132 fgSetDouble("/instrumentation/adf/rotation-deg", rot);
1133 fgSetDouble("/instrumentation/adf/frequencies/selected-khz", freq);
1134 return FG_OPTIONS_OK;
1138 fgOptDME( const char *arg )
1141 if (opt == "nav1") {
1142 fgSetInt("/instrumentation/dme/switch-position", 1);
1143 fgSetString("/instrumentation/dme/frequencies/source",
1144 "/instrumentation/nav[0]/frequencies/selected-mhz");
1145 } else if (opt == "nav2") {
1146 fgSetInt("/instrumentation/dme/switch-position", 3);
1147 fgSetString("/instrumentation/dme/frequencies/source",
1148 "/instrumentation/nav[1]/frequencies/selected-mhz");
1150 fgSetInt("/instrumentation/dme/switch-position", 2);
1151 fgSetString("/instrumentation/dme/frequencies/source",
1152 "/instrumentation/dme/frequencies/selected-mhz");
1153 fgSetString("/instrumentation/dme/frequencies/selected-mhz", arg);
1155 return FG_OPTIONS_OK;
1159 fgOptLivery( const char *arg )
1162 string livery_path = "livery/" + opt;
1163 fgSetString("/sim/model/texture-path", livery_path.c_str() );
1164 return FG_OPTIONS_OK;
1168 fgOptScenario( const char *arg )
1170 SGPropertyNode_ptr ai_node = fgGetNode( "/sim/ai", true );
1171 vector<SGPropertyNode_ptr> scenarii = ai_node->getChildren( "scenario" );
1173 for ( size_t i = 0; i < scenarii.size(); ++i ) {
1174 int ind = scenarii[i]->getIndex();
1175 if ( index < ind ) {
1179 SGPropertyNode_ptr scenario = ai_node->getNode( "scenario", index + 1, true );
1180 scenario->setStringValue( arg );
1181 ai_node->setBoolValue( "enabled", true );
1182 return FG_OPTIONS_OK;
1186 fgOptRunway( const char *arg )
1188 fgSetString("/sim/presets/runway", arg );
1189 fgSetBool("/sim/presets/runway-requested", true );
1190 return FG_OPTIONS_OK;
1193 static map<string,size_t> fgOptionMap;
1196 option has_param type property b_param s_param func
1199 option : name of the option
1200 has_param : option is --name=value if true or --name if false
1201 type : OPTION_BOOL - property is a boolean
1202 OPTION_STRING - property is a string
1203 OPTION_DOUBLE - property is a double
1204 OPTION_INT - property is an integer
1205 OPTION_CHANNEL - name of option is the name of a channel
1206 OPTION_FUNC - the option trigger a function
1207 b_param : if type==OPTION_BOOL,
1208 value set to the property (has_param is false for boolean)
1209 s_param : if type==OPTION_STRING,
1210 value set to the property if has_param is false
1211 func : function called if type==OPTION_FUNC. if has_param is true,
1212 the value is passed to the function as a string, otherwise,
1215 For OPTION_DOUBLE and OPTION_INT, the parameter value is converted into a
1216 double or an integer and set to the property.
1218 For OPTION_CHANNEL, add_channel is called with the parameter value as the
1222 enum OptionType { OPTION_BOOL, OPTION_STRING, OPTION_DOUBLE, OPTION_INT, OPTION_CHANNEL, OPTION_FUNC };
1226 enum OptionType type;
1230 int (*func)( const char * );
1231 } fgOptionArray[] = {
1233 {"language", true, OPTION_FUNC, "", false, "", fgOptLanguage },
1234 {"disable-game-mode", false, OPTION_BOOL, "/sim/startup/game-mode", false, "", 0 },
1235 {"enable-game-mode", false, OPTION_BOOL, "/sim/startup/game-mode", true, "", 0 },
1236 {"disable-splash-screen", false, OPTION_BOOL, "/sim/startup/splash-screen", false, "", 0 },
1237 {"enable-splash-screen", false, OPTION_BOOL, "/sim/startup/splash-screen", true, "", 0 },
1238 {"disable-intro-music", false, OPTION_BOOL, "/sim/startup/intro-music", false, "", 0 },
1239 {"enable-intro-music", false, OPTION_BOOL, "/sim/startup/intro-music", true, "", 0 },
1240 {"disable-mouse-pointer", false, OPTION_STRING, "/sim/startup/mouse-pointer", false, "disabled", 0 },
1241 {"enable-mouse-pointer", false, OPTION_STRING, "/sim/startup/mouse-pointer", false, "enabled", 0 },
1242 {"disable-random-objects", false, OPTION_BOOL, "/sim/rendering/random-objects", false, "", 0 },
1243 {"enable-random-objects", false, OPTION_BOOL, "/sim/rendering/random-objects", true, "", 0 },
1244 {"disable-real-weather-fetch", false, OPTION_BOOL, "/environment/params/real-world-weather-fetch", false, "", 0 },
1245 {"enable-real-weather-fetch", false, OPTION_BOOL, "/environment/params/real-world-weather-fetch", true, "", 0 },
1246 {"disable-ai-models", false, OPTION_BOOL, "/sim/ai/enabled", false, "", 0 },
1247 {"enable-ai-models", false, OPTION_BOOL, "/sim/ai/enabled", true, "", 0 },
1248 {"disable-freeze", false, OPTION_BOOL, "/sim/freeze/master", false, "", 0 },
1249 {"enable-freeze", false, OPTION_BOOL, "/sim/freeze/master", true, "", 0 },
1250 {"disable-fuel-freeze", false, OPTION_BOOL, "/sim/freeze/fuel", false, "", 0 },
1251 {"enable-fuel-freeze", false, OPTION_BOOL, "/sim/freeze/fuel", true, "", 0 },
1252 {"disable-clock-freeze", false, OPTION_BOOL, "/sim/freeze/clock", false, "", 0 },
1253 {"enable-clock-freeze", false, OPTION_BOOL, "/sim/freeze/clock", true, "", 0 },
1254 {"disable-hud-3d", false, OPTION_BOOL, "/sim/hud/enable3d", false, "", 0 },
1255 {"enable-hud-3d", false, OPTION_BOOL, "/sim/hud/enable3d", true, "", 0 },
1256 {"disable-anti-alias-hud", false, OPTION_BOOL, "/sim/hud/color/antialiased", false, "", 0 },
1257 {"enable-anti-alias-hud", false, OPTION_BOOL, "/sim/hud/color/antialiased", true, "", 0 },
1258 {"control", true, OPTION_STRING, "/sim/control-mode", false, "", 0 },
1259 {"disable-auto-coordination", false, OPTION_BOOL, "/sim/auto-coordination", false, "", 0 },
1260 {"enable-auto-coordination", false, OPTION_BOOL, "/sim/auto-coordination", true, "", 0 },
1261 {"browser-app", true, OPTION_STRING, "/sim/startup/browser-app", false, "", 0 },
1262 {"disable-hud", false, OPTION_BOOL, "/sim/hud/visibility", false, "", 0 },
1263 {"enable-hud", false, OPTION_BOOL, "/sim/hud/visibility", true, "", 0 },
1264 {"disable-panel", false, OPTION_BOOL, "/sim/panel/visibility", false, "", 0 },
1265 {"enable-panel", false, OPTION_BOOL, "/sim/panel/visibility", true, "", 0 },
1266 {"disable-sound", false, OPTION_BOOL, "/sim/sound/pause", true, "", 0 },
1267 {"enable-sound", false, OPTION_BOOL, "/sim/sound/pause", false, "", 0 },
1268 {"airport", true, OPTION_STRING, "/sim/presets/airport-id", false, "", 0 },
1269 {"airport-id", true, OPTION_STRING, "/sim/presets/airport-id", false, "", 0 },
1270 {"runway", true, OPTION_FUNC, "", false, "", fgOptRunway },
1271 {"vor", true, OPTION_FUNC, "", false, "", fgOptVOR },
1272 {"ndb", true, OPTION_FUNC, "", false, "", fgOptNDB },
1273 {"carrier", true, OPTION_FUNC, "", false, "", fgOptCarrier },
1274 {"parkpos", true, OPTION_FUNC, "", false, "", fgOptParkpos },
1275 {"fix", true, OPTION_FUNC, "", false, "", fgOptFIX },
1276 {"offset-distance", true, OPTION_DOUBLE, "/sim/presets/offset-distance", false, "", 0 },
1277 {"offset-azimuth", true, OPTION_DOUBLE, "/sim/presets/offset-azimuth", false, "", 0 },
1278 {"lon", true, OPTION_FUNC, "", false, "", fgOptLon },
1279 {"lat", true, OPTION_FUNC, "", false, "", fgOptLat },
1280 {"altitude", true, OPTION_FUNC, "", false, "", fgOptAltitude },
1281 {"uBody", true, OPTION_FUNC, "", false, "", fgOptUBody },
1282 {"vBody", true, OPTION_FUNC, "", false, "", fgOptVBody },
1283 {"wBody", true, OPTION_FUNC, "", false, "", fgOptWBody },
1284 {"vNorth", true, OPTION_FUNC, "", false, "", fgOptVNorth },
1285 {"vEast", true, OPTION_FUNC, "", false, "", fgOptVEast },
1286 {"vDown", true, OPTION_FUNC, "", false, "", fgOptVDown },
1287 {"vc", true, OPTION_FUNC, "", false, "", fgOptVc },
1288 {"mach", true, OPTION_FUNC, "", false, "", fgOptMach },
1289 {"heading", true, OPTION_DOUBLE, "/sim/presets/heading-deg", false, "", 0 },
1290 {"roll", true, OPTION_DOUBLE, "/sim/presets/roll-deg", false, "", 0 },
1291 {"pitch", true, OPTION_DOUBLE, "/sim/presets/pitch-deg", false, "", 0 },
1292 {"glideslope", true, OPTION_DOUBLE, "/sim/presets/glideslope-deg", false, "", 0 },
1293 {"roc", true, OPTION_FUNC, "", false, "", fgOptRoc },
1294 {"fg-root", true, OPTION_FUNC, "", false, "", fgOptFgRoot },
1295 {"fg-scenery", true, OPTION_FUNC, "", false, "", fgOptFgScenery },
1296 {"fdm", true, OPTION_STRING, "/sim/flight-model", false, "", 0 },
1297 {"aero", true, OPTION_STRING, "/sim/aero", false, "", 0 },
1298 {"aircraft-dir", true, OPTION_STRING, "/sim/aircraft-dir", false, "", 0 },
1299 {"model-hz", true, OPTION_INT, "/sim/model-hz", false, "", 0 },
1300 {"speed", true, OPTION_INT, "/sim/speed-up", false, "", 0 },
1301 {"trim", false, OPTION_BOOL, "/sim/presets/trim", true, "", 0 },
1302 {"notrim", false, OPTION_BOOL, "/sim/presets/trim", false, "", 0 },
1303 {"on-ground", false, OPTION_BOOL, "/sim/presets/onground", true, "", 0 },
1304 {"in-air", false, OPTION_BOOL, "/sim/presets/onground", false, "", 0 },
1305 {"fog-disable", false, OPTION_STRING, "/sim/rendering/fog", false, "disabled", 0 },
1306 {"fog-fastest", false, OPTION_STRING, "/sim/rendering/fog", false, "fastest", 0 },
1307 {"fog-nicest", false, OPTION_STRING, "/sim/rendering/fog", false, "nicest", 0 },
1308 {"disable-horizon-effect", false, OPTION_BOOL, "/sim/rendering/horizon-effect", false, "", 0 },
1309 {"enable-horizon-effect", false, OPTION_BOOL, "/sim/rendering/horizon-effect", true, "", 0 },
1310 {"disable-enhanced-lighting", false, OPTION_BOOL, "/sim/rendering/enhanced-lighting", false, "", 0 },
1311 {"enable-enhanced-lighting", false, OPTION_BOOL, "/sim/rendering/enhanced-lighting", true, "", 0 },
1312 {"disable-distance-attenuation", false, OPTION_BOOL, "/sim/rendering/distance-attenuation", false, "", 0 },
1313 {"enable-distance-attenuation", false, OPTION_BOOL, "/sim/rendering/distance-attenuation", true, "", 0 },
1314 {"disable-specular-highlight", false, OPTION_BOOL, "/sim/rendering/specular-highlight", false, "", 0 },
1315 {"enable-specular-highlight", false, OPTION_BOOL, "/sim/rendering/specular-highlight", true, "", 0 },
1316 {"disable-clouds", false, OPTION_BOOL, "/environment/clouds/status", false, "", 0 },
1317 {"enable-clouds", false, OPTION_BOOL, "/environment/clouds/status", true, "", 0 },
1318 {"disable-clouds3d", false, OPTION_BOOL, "/sim/rendering/clouds3d-enable", false, "", 0 },
1319 {"enable-clouds3d", false, OPTION_BOOL, "/sim/rendering/clouds3d-enable", true, "", 0 },
1320 {"fov", true, OPTION_FUNC, "", false, "", fgOptFov },
1321 {"aspect-ratio-multiplier", true, OPTION_DOUBLE, "/sim/current-view/aspect-ratio-multiplier", false, "", 0 },
1322 {"disable-fullscreen", false, OPTION_BOOL, "/sim/startup/fullscreen", false, "", 0 },
1323 {"enable-fullscreen", false, OPTION_BOOL, "/sim/startup/fullscreen", true, "", 0 },
1324 {"disable-save-on-exit", false, OPTION_BOOL, "/sim/startup/save-on-exit", false, "", 0 },
1325 {"enable-save-on-exit", false, OPTION_BOOL, "/sim/startup/save-on-exit", true, "", 0 },
1326 {"shading-flat", false, OPTION_BOOL, "/sim/rendering/shading", false, "", 0 },
1327 {"shading-smooth", false, OPTION_BOOL, "/sim/rendering/shading", true, "", 0 },
1328 {"disable-skyblend", false, OPTION_BOOL, "/sim/rendering/skyblend", false, "", 0 },
1329 {"enable-skyblend", false, OPTION_BOOL, "/sim/rendering/skyblend", true, "", 0 },
1330 {"disable-textures", false, OPTION_BOOL, "/sim/rendering/textures", false, "", 0 },
1331 {"enable-textures", false, OPTION_BOOL, "/sim/rendering/textures", true, "", 0 },
1332 {"texture-filtering", false, OPTION_INT, "/sim/rendering/filtering", 1, "", 0 },
1333 {"disable-wireframe", false, OPTION_BOOL, "/sim/rendering/wireframe", false, "", 0 },
1334 {"enable-wireframe", false, OPTION_BOOL, "/sim/rendering/wireframe", true, "", 0 },
1335 {"geometry", true, OPTION_FUNC, "", false, "", fgOptGeometry },
1336 {"bpp", true, OPTION_FUNC, "", false, "", fgOptBpp },
1337 {"units-feet", false, OPTION_STRING, "/sim/startup/units", false, "feet", 0 },
1338 {"units-meters", false, OPTION_STRING, "/sim/startup/units", false, "meters", 0 },
1339 {"timeofday", true, OPTION_STRING, "/sim/startup/time-offset-type", false, "noon", 0 },
1340 {"season", true, OPTION_STRING, "/sim/startup/season", false, "summer", 0 },
1341 {"time-offset", true, OPTION_FUNC, "", false, "", fgOptTimeOffset },
1342 {"time-match-real", false, OPTION_STRING, "/sim/startup/time-offset-type", false, "system-offset", 0 },
1343 {"time-match-local", false, OPTION_STRING, "/sim/startup/time-offset-type", false, "latitude-offset", 0 },
1344 {"start-date-sys", true, OPTION_FUNC, "", false, "", fgOptStartDateSys },
1345 {"start-date-lat", true, OPTION_FUNC, "", false, "", fgOptStartDateLat },
1346 {"start-date-gmt", true, OPTION_FUNC, "", false, "", fgOptStartDateGmt },
1347 {"hud-tris", false, OPTION_STRING, "/sim/hud/frame-stat-type", false, "tris", 0 },
1348 {"hud-culled", false, OPTION_STRING, "/sim/hud/frame-stat-type", false, "culled", 0 },
1349 {"atcsim", true, OPTION_CHANNEL, "", false, "dummy", 0 },
1350 {"atlas", true, OPTION_CHANNEL, "", false, "", 0 },
1351 {"httpd", true, OPTION_CHANNEL, "", false, "", 0 },
1352 #ifdef FG_JPEG_SERVER
1353 {"jpg-httpd", true, OPTION_CHANNEL, "", false, "", 0 },
1355 {"native", true, OPTION_CHANNEL, "", false, "", 0 },
1356 {"native-ctrls", true, OPTION_CHANNEL, "", false, "", 0 },
1357 {"native-fdm", true, OPTION_CHANNEL, "", false, "", 0 },
1358 {"native-gui", true, OPTION_CHANNEL, "", false, "", 0 },
1359 {"opengc", true, OPTION_CHANNEL, "", false, "", 0 },
1360 {"AV400", true, OPTION_CHANNEL, "", false, "", 0 },
1361 {"garmin", true, OPTION_CHANNEL, "", false, "", 0 },
1362 {"nmea", true, OPTION_CHANNEL, "", false, "", 0 },
1363 {"generic", true, OPTION_CHANNEL, "", false, "", 0 },
1364 {"props", true, OPTION_CHANNEL, "", false, "", 0 },
1365 {"telnet", true, OPTION_CHANNEL, "", false, "", 0 },
1366 {"pve", true, OPTION_CHANNEL, "", false, "", 0 },
1367 {"ray", true, OPTION_CHANNEL, "", false, "", 0 },
1368 {"rul", true, OPTION_CHANNEL, "", false, "", 0 },
1369 {"joyclient", true, OPTION_CHANNEL, "", false, "", 0 },
1370 {"jsclient", true, OPTION_CHANNEL, "", false, "", 0 },
1371 {"proxy", true, OPTION_FUNC, "", false, "", fgSetupProxy },
1372 {"callsign", true, OPTION_STRING, "sim/multiplay/callsign", false, "", 0 },
1373 {"multiplay", true, OPTION_CHANNEL, "", false, "", 0 },
1374 {"trace-read", true, OPTION_FUNC, "", false, "", fgOptTraceRead },
1375 {"trace-write", true, OPTION_FUNC, "", false, "", fgOptTraceWrite },
1376 {"log-level", true, OPTION_FUNC, "", false, "", fgOptLogLevel },
1377 {"view-offset", true, OPTION_FUNC, "", false, "", fgOptViewOffset },
1378 {"visibility", true, OPTION_FUNC, "", false, "", fgOptVisibilityMeters },
1379 {"visibility-miles", true, OPTION_FUNC, "", false, "", fgOptVisibilityMiles },
1380 {"random-wind", false, OPTION_FUNC, "", false, "", fgOptRandomWind },
1381 {"wind", true, OPTION_FUNC, "", false, "", fgOptWind },
1382 {"turbulence", true, OPTION_FUNC, "", false, "", fgOptTurbulence },
1383 {"ceiling", true, OPTION_FUNC, "", false, "", fgOptCeiling },
1384 {"wp", true, OPTION_FUNC, "", false, "", fgOptWp },
1385 {"flight-plan", true, OPTION_FUNC, "", false, "", fgOptFlightPlan },
1386 {"config", true, OPTION_FUNC, "", false, "", fgOptConfig },
1387 {"aircraft", true, OPTION_STRING, "/sim/aircraft", false, "", 0 },
1388 {"failure", true, OPTION_FUNC, "", false, "", fgOptFailure },
1389 {"com1", true, OPTION_DOUBLE, "/instrumentation/comm[0]/frequencies/selected-mhz", false, "", 0 },
1390 {"com2", true, OPTION_DOUBLE, "/instrumentation/comm[1]/frequencies/selected-mhz", false, "", 0 },
1391 {"nav1", true, OPTION_FUNC, "", false, "", fgOptNAV1 },
1392 {"nav2", true, OPTION_FUNC, "", false, "", fgOptNAV2 },
1393 {"adf", true, OPTION_FUNC, "", false, "", fgOptADF },
1394 {"dme", true, OPTION_FUNC, "", false, "", fgOptDME },
1395 {"min-status", true, OPTION_STRING, "/sim/aircraft-min-status", false, "all", 0 },
1396 {"livery", true, OPTION_FUNC, "", false, "", fgOptLivery },
1397 {"ai-scenario", true, OPTION_FUNC, "", false, "", fgOptScenario },
1402 // Parse a single option
1404 parse_option (const string& arg)
1406 if ( fgOptionMap.size() == 0 ) {
1408 OptionDesc *pt = &fgOptionArray[ 0 ];
1409 while ( pt->option != 0 ) {
1410 fgOptionMap[ pt->option ] = i;
1417 if ( (arg == "--help") || (arg == "-h") ) {
1418 // help/usage request
1419 return(FG_OPTIONS_HELP);
1420 } else if ( (arg == "--verbose") || (arg == "-v") ) {
1421 // verbose help/usage request
1422 return(FG_OPTIONS_VERBOSE_HELP);
1423 } else if ( arg.find( "--show-aircraft") == 0) {
1424 return(FG_OPTIONS_SHOW_AIRCRAFT);
1425 } else if ( arg.find( "--prop:" ) == 0 ) {
1426 string assign = arg.substr(7);
1427 string::size_type pos = assign.find('=');
1428 if ( pos == arg.npos || pos == 0 || pos + 1 == assign.size() ) {
1429 SG_LOG( SG_GENERAL, SG_ALERT, "Bad property assignment: " << arg );
1430 return FG_OPTIONS_ERROR;
1432 string name = assign.substr(0, pos);
1433 string value = assign.substr(pos + 1);
1434 fgSetString(name.c_str(), value.c_str());
1436 } else if ( arg.find( "--" ) == 0 ) {
1437 size_t pos = arg.find( '=' );
1439 if ( pos == string::npos ) {
1440 arg_name = arg.substr( 2 );
1442 arg_name = arg.substr( 2, pos - 2 );
1444 map<string,size_t>::iterator it = fgOptionMap.find( arg_name );
1445 if ( it != fgOptionMap.end() ) {
1446 OptionDesc *pt = &fgOptionArray[ it->second ];
1447 switch ( pt->type ) {
1449 fgSetBool( pt->property, pt->b_param );
1452 if ( pt->has_param && pos != string::npos && pos + 1 < arg.size() ) {
1453 fgSetString( pt->property, arg.substr( pos + 1 ).c_str() );
1454 } else if ( !pt->has_param && pos == string::npos ) {
1455 fgSetString( pt->property, pt->s_param );
1456 } else if ( pt->has_param ) {
1457 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << arg << "' needs a parameter" );
1458 return FG_OPTIONS_ERROR;
1460 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << arg << "' does not have a parameter" );
1461 return FG_OPTIONS_ERROR;
1465 if ( pos != string::npos && pos + 1 < arg.size() ) {
1466 fgSetDouble( pt->property, atof( arg.substr( pos + 1 ) ) );
1468 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << arg << "' needs a parameter" );
1469 return FG_OPTIONS_ERROR;
1473 if ( pos != string::npos && pos + 1 < arg.size() ) {
1474 fgSetInt( pt->property, atoi( arg.substr( pos + 1 ) ) );
1476 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << arg << "' needs a parameter" );
1477 return FG_OPTIONS_ERROR;
1480 case OPTION_CHANNEL:
1481 if ( pt->has_param && pos != string::npos && pos + 1 < arg.size() ) {
1482 add_channel( pt->option, arg.substr( pos + 1 ) );
1483 } else if ( !pt->has_param && pos == string::npos ) {
1484 add_channel( pt->option, pt->s_param );
1485 } else if ( pt->has_param ) {
1486 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << arg << "' needs a parameter" );
1487 return FG_OPTIONS_ERROR;
1489 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << arg << "' does not have a parameter" );
1490 return FG_OPTIONS_ERROR;
1494 if ( pt->has_param && pos != string::npos && pos + 1 < arg.size() ) {
1495 return pt->func( arg.substr( pos + 1 ).c_str() );
1496 } else if ( !pt->has_param && pos == string::npos ) {
1497 return pt->func( 0 );
1498 } else if ( pt->has_param ) {
1499 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << arg << "' needs a parameter" );
1500 return FG_OPTIONS_ERROR;
1502 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << arg << "' does not have a parameter" );
1503 return FG_OPTIONS_ERROR;
1508 SG_LOG( SG_GENERAL, SG_ALERT, "Unknown option '" << arg << "'" );
1509 return FG_OPTIONS_ERROR;
1512 SG_LOG( SG_GENERAL, SG_ALERT, "Unknown option '" << arg << "'" );
1513 return FG_OPTIONS_ERROR;
1516 return FG_OPTIONS_OK;
1520 // Parse the command line options
1522 fgParseArgs (int argc, char **argv)
1524 bool in_options = true;
1525 bool verbose = false;
1528 SG_LOG(SG_GENERAL, SG_INFO, "Processing command line arguments");
1530 for (int i = 1; i < argc; i++) {
1531 string arg = argv[i];
1533 if (in_options && (arg.find('-') == 0)) {
1537 int result = parse_option(arg);
1538 if ((result == FG_OPTIONS_HELP) || (result == FG_OPTIONS_ERROR))
1541 else if (result == FG_OPTIONS_VERBOSE_HELP)
1544 else if (result == FG_OPTIONS_SHOW_AIRCRAFT) {
1545 fgOptLogLevel( "alert" );
1546 SGPath path( globals->get_fg_root() );
1547 path.append("Aircraft");
1548 fgShowAircraft(path, true);
1554 SG_LOG(SG_GENERAL, SG_INFO,
1555 "Reading command-line property file " << arg);
1556 readProperties(arg, globals->get_props());
1561 fgOptLogLevel( "alert" );
1566 SG_LOG(SG_GENERAL, SG_INFO, "Finished command line arguments");
1570 // Parse config file options
1572 fgParseOptions (const string& path) {
1573 sg_gzifstream in( path );
1574 if ( !in.is_open() ) {
1578 SG_LOG( SG_GENERAL, SG_INFO, "Processing config file: " << path );
1582 while ( ! in.eof() ) {
1585 while ( in.get(c) && c != '\0' ) {
1590 #if defined( macintosh )
1591 getline( in, line, '\r' );
1593 getline( in, line, '\n' );
1596 // catch extraneous (DOS) line ending character
1598 for (i = line.length(); i > 0; i--)
1599 if (line[i - 1] > 32)
1601 line = line.substr( 0, i );
1603 if ( parse_option( line ) == FG_OPTIONS_ERROR ) {
1604 cerr << endl << "Config file parse error: " << path << " '"
1605 << line << "'" << endl;
1614 // Print usage message
1616 fgUsage (bool verbose)
1618 SGPropertyNode *locale = globals->get_locale();
1620 SGPropertyNode options_root;
1622 SG_LOG( SG_GENERAL, SG_ALERT, "" ); // To popup the console on Windows
1626 fgLoadProps("options.xml", &options_root);
1627 } catch (const sg_exception &) {
1628 cout << "Unable to read the help file." << endl;
1629 cout << "Make sure the file options.xml is located in the FlightGear base directory," << endl;
1630 cout << "and the location of the base directory is specified by setting $FG_ROOT or" << endl;
1631 cout << "by adding --fg-root=path as a program argument." << endl;
1636 SGPropertyNode *options = options_root.getNode("options");
1638 SG_LOG( SG_GENERAL, SG_ALERT,
1639 "Error reading options.xml: <options> directive not found." );
1643 SGPropertyNode *usage = locale->getNode(options->getStringValue("usage"));
1645 cout << "Usage: " << usage->getStringValue() << endl;
1648 vector<SGPropertyNode_ptr>section = options->getChildren("section");
1649 for (unsigned int j = 0; j < section.size(); j++) {
1652 vector<SGPropertyNode_ptr>option = section[j]->getChildren("option");
1653 for (unsigned int k = 0; k < option.size(); k++) {
1655 SGPropertyNode *name = option[k]->getNode("name");
1656 SGPropertyNode *short_name = option[k]->getNode("short");
1657 SGPropertyNode *key = option[k]->getNode("key");
1658 SGPropertyNode *arg = option[k]->getNode("arg");
1659 bool brief = option[k]->getNode("brief") != 0;
1661 if ((brief || verbose) && name) {
1662 string tmp = name->getStringValue();
1666 tmp.append(key->getStringValue());
1670 tmp.append(arg->getStringValue());
1674 tmp.append(short_name->getStringValue());
1677 if (tmp.size() <= 25) {
1680 msg.append( 27-tmp.size(), ' ');
1684 msg.append(32, ' ');
1686 // There may be more than one <description> tag assosiated
1689 vector<SGPropertyNode_ptr> desc;
1690 desc = option[k]->getChildren("description");
1691 if (desc.size() > 0) {
1692 for ( unsigned int l = 0; l < desc.size(); l++) {
1694 // There may be more than one translation line.
1696 string t = desc[l]->getStringValue();
1697 SGPropertyNode *n = locale->getNode("strings");
1698 vector<SGPropertyNode_ptr>trans_desc =
1699 n->getChildren(t.substr(8).c_str());
1701 for ( unsigned int m = 0; m < trans_desc.size(); m++ ) {
1702 string t_str = trans_desc[m]->getStringValue();
1704 if ((m > 0) || ((l > 0) && m == 0)) {
1705 msg.append( 32, ' ');
1708 // If the string is too large to fit on the screen,
1709 // then split it up in several pieces.
1711 while ( t_str.size() > 47 ) {
1713 unsigned int m = t_str.rfind(' ', 47);
1714 msg += t_str.substr(0, m) + '\n';
1715 msg.append( 32, ' ');
1717 t_str.erase(t_str.begin(), t_str.begin() + m + 1);
1719 msg += t_str + '\n';
1726 SGPropertyNode *name;
1727 name = locale->getNode(section[j]->getStringValue("name"));
1729 if (!msg.empty() && name) {
1730 cout << endl << name->getStringValue() << ":" << endl;
1738 cout << "For a complete list of options use --help --verbose" << endl;
1741 cout << "Hit a key to continue..." << endl;
1746 // A simple function to return an integer depending on the position
1747 // of the status string within the array in order to determine the hierarchy.
1748 unsigned int getNumMaturity(const char * str)
1750 // changes should also be reflected in $FG_ROOT/data/options.xml &
1751 // $FG_ROOT/data/Translations/string-default.xml
1752 const char levels[][20]= {"alpha","beta","early-production","production",0};
1754 for (unsigned int i=0; i<(sizeof(levels)/sizeof(levels[0])-1);i++)
1755 if (strcmp(str,levels[i])==0)
1762 static void fgSearchAircraft(const SGPath &path, string_list &aircraft,
1767 ulDir *dirp = ulOpenDir(path.str().c_str());
1769 cerr << "Unable to open aircraft directory '" << path.str() << '\'' << endl;
1773 while ((dire = ulReadDir(dirp)) != NULL) {
1776 if (dire->d_isdir) {
1777 if (recursive && strcmp("CVS", dire->d_name)
1778 && strcmp(".", dire->d_name) && strcmp("..", dire->d_name))
1781 next.append(dire->d_name);
1783 fgSearchAircraft(next, aircraft, true);
1785 } else if ((ptr = strstr(dire->d_name, "-set.xml")) && (ptr[8] == '\0')) {
1787 SGPath afile = path;
1788 afile.append(dire->d_name);
1792 SGPropertyNode root;
1794 readProperties(afile.str(), &root);
1799 SGPropertyNode *desc = NULL;
1800 SGPropertyNode *status = NULL;
1802 SGPropertyNode *node = root.getNode("sim");
1804 desc = node->getNode("description");
1805 // if a status tag is found, read it in
1806 if (node->hasValue("status"))
1807 status = node->getNode("status");
1810 //additionally display status information where it is available
1812 string descStr(" ");
1813 descStr += dire->d_name;
1815 if (descStr.size() <= 27+3) {
1816 descStr.append(29+3-descStr.size(), ' ');
1819 descStr.append( 32, ' ');
1821 descStr += desc->getStringValue();
1824 SGPropertyNode * required_status
1825 = fgGetNode ("/sim/aircraft-min-status", true);
1827 // If the node holds the value "all", then there wasn't any status
1828 // level specified, so we simply go ahead and output ALL aircraft
1829 if (strcmp(required_status->getStringValue(),"all")==0) {
1830 aircraft.push_back(descStr);
1834 // If the node doesn't hold "all" as its value, then we are supposed
1835 // to show only aircraft meeting specific status (development status)
1838 if (node->hasValue("status")) {
1839 //Compare (minimally) required status level with actual aircraft status:
1840 if ( getNumMaturity(status->getStringValue() ) >=
1841 getNumMaturity(required_status->getStringValue() ) )
1842 aircraft.push_back(descStr); }
1854 * Search in the current directory, and in on directory deeper
1855 * for <aircraft>-set.xml configuration files and show the aircaft name
1856 * and the contents of the<description> tag in a sorted manner.
1858 * @parampath the directory to search for configuration files
1859 * @param recursive defines whether the directory should be searched recursively
1861 void fgShowAircraft(const SGPath &path, bool recursive) {
1862 string_list aircraft;
1864 fgSearchAircraft( path, aircraft, recursive );
1866 sort(aircraft.begin(), aircraft.end());
1867 SG_LOG( SG_GENERAL, SG_ALERT, "" ); // To popup the console on Windows
1868 cout << "Available aircraft:" << endl;
1869 for ( unsigned int i = 0; i < aircraft.size(); i++ ) {
1870 cout << aircraft[i] << endl;
1873 cout << "Hit a key to continue..." << endl;