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>
46 // #include <Include/general.hxx>
47 // #include <Airports/simple.hxx>
48 // #include <Cockpit/cockpit.hxx>
49 // #include <FDM/flight.hxx>
51 #include <Autopilot/route_mgr.hxx>
54 #include "globals.hxx"
55 #include "fg_init.hxx"
56 #include "fg_props.hxx"
57 #include "options.hxx"
59 #include "viewmgr.hxx"
64 SG_USING_NAMESPACE(std);
67 #define NEW_DEFAULT_MODEL_HZ 120
74 FG_OPTIONS_VERBOSE_HELP = 3,
75 FG_OPTIONS_SHOW_AIRCRAFT = 4
79 atof( const string& str )
83 // -dw- if ::atof is called, then we get an infinite loop
84 return std::atof( str.c_str() );
86 return ::atof( str.c_str() );
91 atoi( const string& str )
94 // -dw- if ::atoi is called, then we get an infinite loop
95 return std::atoi( str.c_str() );
97 return ::atoi( str.c_str() );
103 * Set a few fail-safe default property values.
105 * These should all be set in $FG_ROOT/preferences.xml, but just
106 * in case, we provide some initial sane values here. This method
107 * should be invoked *before* reading any init files.
112 // set a possibly independent location for scenery data
113 char *envp = ::getenv( "FG_SCENERY" );
115 if ( envp != NULL ) {
116 // fg_root could be anywhere, so default to environmental
117 // variable $FG_ROOT if it is set.
118 globals->set_fg_scenery(envp);
120 // Otherwise, default to Scenery being in $FG_ROOT/Scenery
121 globals->set_fg_scenery("");
123 // Position (deliberately out of range)
124 fgSetDouble("/position/longitude-deg", 9999.0);
125 fgSetDouble("/position/latitude-deg", 9999.0);
126 fgSetDouble("/position/altitude-ft", -9999.0);
129 fgSetDouble("/orientation/heading-deg", 270);
130 fgSetDouble("/orientation/roll-deg", 0);
131 fgSetDouble("/orientation/pitch-deg", 0.424);
134 fgSetDouble("/velocities/uBody-fps", 0.0);
135 fgSetDouble("/velocities/vBody-fps", 0.0);
136 fgSetDouble("/velocities/wBody-fps", 0.0);
137 fgSetDouble("/velocities/speed-north-fps", 0.0);
138 fgSetDouble("/velocities/speed-east-fps", 0.0);
139 fgSetDouble("/velocities/speed-down-fps", 0.0);
140 fgSetDouble("/velocities/airspeed-kt", 0.0);
141 fgSetDouble("/velocities/mach", 0.0);
144 fgSetDouble("/sim/presets/longitude-deg", 9999.0);
145 fgSetDouble("/sim/presets/latitude-deg", 9999.0);
146 fgSetDouble("/sim/presets/altitude-ft", -9999.0);
148 fgSetDouble("/sim/presets/heading-deg", 270);
149 fgSetDouble("/sim/presets/roll-deg", 0);
150 fgSetDouble("/sim/presets/pitch-deg", 0.424);
152 fgSetString("/sim/presets/speed-set", "knots");
153 fgSetDouble("/sim/presets/airspeed-kt", 0.0);
154 fgSetDouble("/sim/presets/mach", 0.0);
155 fgSetDouble("/sim/presets/uBody-fps", 0.0);
156 fgSetDouble("/sim/presets/vBody-fps", 0.0);
157 fgSetDouble("/sim/presets/wBody-fps", 0.0);
158 fgSetDouble("/sim/presets/speed-north-fps", 0.0);
159 fgSetDouble("/sim/presets/speed-east-fps", 0.0);
160 fgSetDouble("/sim/presets/speed-down-fps", 0.0);
162 fgSetBool("/sim/presets/onground", true);
163 fgSetBool("/sim/presets/trim", false);
166 fgSetBool("/sim/startup/game-mode", false);
167 fgSetBool("/sim/startup/splash-screen", true);
168 fgSetBool("/sim/startup/intro-music", true);
169 // we want mouse-pointer to have an undefined value if nothing is
170 // specified so we can do the right thing for voodoo-1/2 cards.
171 // fgSetString("/sim/startup/mouse-pointer", "disabled");
172 fgSetString("/sim/control-mode", "joystick");
173 fgSetBool("/sim/auto-coordination", false);
175 fgSetString("/sim/startup/browser-app", "webrun.bat");
176 #elif defined(__APPLE__)
177 fgSetString("/sim/startup/browser-app", "open");
179 fgSetString("/sim/startup/browser-app", "launchWebJumper");
181 envp = ::getenv( "WEBBROWSER" );
182 if (!envp) envp = "netscape";
183 fgSetString("/sim/startup/browser-app", envp);
185 fgSetString("/sim/logging/priority", "alert");
188 fgSetBool("/sim/hud/antialiased", false);
189 fgSetBool("/sim/hud/enable3d", true);
190 fgSetBool("/sim/hud/visibility", false);
191 fgSetBool("/sim/panel/visibility", true);
192 fgSetBool("/sim/sound/pause", false);
194 // Flight Model options
195 fgSetString("/sim/flight-model", "jsb");
196 fgSetString("/sim/aero", "c172");
197 fgSetInt("/sim/model-hz", NEW_DEFAULT_MODEL_HZ);
198 fgSetInt("/sim/speed-up", 1);
201 fgSetString("/sim/rendering/fog", "nicest");
202 fgSetBool("/environment/clouds/status", true);
203 fgSetBool("/sim/startup/fullscreen", false);
204 fgSetBool("/sim/rendering/shading", true);
205 fgSetBool("/sim/rendering/skyblend", true);
206 fgSetBool("/sim/rendering/textures", true);
207 fgSetBool("/sim/rendering/wireframe", false);
208 fgSetBool("/sim/rendering/horizon-effect", false);
209 fgSetBool("/sim/rendering/enhanced-lighting", false);
210 fgSetBool("/sim/rendering/distance-attenuation", false);
211 fgSetBool("/sim/rendering/specular-highlight", true);
212 fgSetInt("/sim/startup/xsize", 800);
213 fgSetInt("/sim/startup/ysize", 600);
214 fgSetInt("/sim/rendering/bits-per-pixel", 16);
215 fgSetString("/sim/view-mode", "pilot");
216 fgSetDouble("/sim/current-view/heading-offset-deg", 0);
219 fgSetString("/sim/startup/units", "feet");
220 fgSetString("/sim/hud/frame-stat-type", "tris");
223 fgSetInt("/sim/startup/time-offset", 0);
224 fgSetString("/sim/startup/time-offset-type", "system-offset");
225 fgSetLong("/sim/time/cur-time-override", 0);
228 fgSetBool("/sim/freeze/master", false);
229 fgSetBool("/sim/freeze/position", false);
230 fgSetBool("/sim/freeze/clock", false);
231 fgSetBool("/sim/freeze/fuel", false);
233 fgSetString("/sim/multiplay/callsign", "callsign");
234 fgSetString("/sim/multiplay/rxhost", "0");
235 fgSetString("/sim/multiplay/txhost", "0");
236 fgSetInt("/sim/multiplay/rxport", 0);
237 fgSetInt("/sim/multiplay/txport", 0);
241 parse_wind (const string &wind, double * min_hdg, double * max_hdg,
242 double * speed, double * gust)
244 string::size_type pos = wind.find('@');
245 if (pos == string::npos)
247 string dir = wind.substr(0, pos);
248 string spd = wind.substr(pos+1);
250 if (pos == string::npos) {
251 *min_hdg = *max_hdg = atof(dir.c_str());
253 *min_hdg = atof(dir.substr(0,pos).c_str());
254 *max_hdg = atof(dir.substr(pos+1).c_str());
257 if (pos == string::npos) {
258 *speed = *gust = atof(spd.c_str());
260 *speed = atof(spd.substr(0,pos).c_str());
261 *gust = atof(spd.substr(pos+1).c_str());
266 // parse a time string ([+/-]%f[:%f[:%f]]) into hours
268 parse_time(const string& time_in) {
269 char *time_str, num[256];
270 double hours, minutes, seconds;
275 time_str = (char *)time_in.c_str();
277 // printf("parse_time(): %s\n", time_str);
280 if ( strlen(time_str) ) {
281 if ( time_str[0] == '+' ) {
284 } else if ( time_str[0] == '-' ) {
289 // printf("sign = %d\n", sign);
292 if ( strlen(time_str) ) {
294 while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
295 num[i] = time_str[0];
299 if ( time_str[0] == ':' ) {
304 // printf("hours = %.2lf\n", hours);
310 if ( strlen(time_str) ) {
312 while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
313 num[i] = time_str[0];
317 if ( time_str[0] == ':' ) {
322 // printf("minutes = %.2lf\n", minutes);
324 result += minutes / 60.0;
328 if ( strlen(time_str) ) {
330 while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
331 num[i] = time_str[0];
337 // printf("seconds = %.2lf\n", seconds);
339 result += seconds / 3600.0;
342 SG_LOG( SG_GENERAL, SG_INFO, " parse_time() = " << sign * result );
344 return(sign * result);
348 // parse a date string (yyyy:mm:dd:hh:mm:ss) into a time_t (seconds)
350 parse_date( const string& date)
353 char * date_str, num[256];
355 // initialize to zero
362 gmt.tm_isdst = 0; // ignore daylight savings time for the moment
363 date_str = (char *)date.c_str();
365 if ( strlen(date_str) ) {
367 while ( (date_str[0] != ':') && (date_str[0] != '\0') ) {
368 num[i] = date_str[0];
372 if ( date_str[0] == ':' ) {
376 gmt.tm_year = atoi(num) - 1900;
379 if ( strlen(date_str) ) {
381 while ( (date_str[0] != ':') && (date_str[0] != '\0') ) {
382 num[i] = date_str[0];
386 if ( date_str[0] == ':' ) {
390 gmt.tm_mon = atoi(num) -1;
393 if ( strlen(date_str) ) {
395 while ( (date_str[0] != ':') && (date_str[0] != '\0') ) {
396 num[i] = date_str[0];
400 if ( date_str[0] == ':' ) {
404 gmt.tm_mday = atoi(num);
407 if ( strlen(date_str) ) {
409 while ( (date_str[0] != ':') && (date_str[0] != '\0') ) {
410 num[i] = date_str[0];
414 if ( date_str[0] == ':' ) {
418 gmt.tm_hour = atoi(num);
421 if ( strlen(date_str) ) {
423 while ( (date_str[0] != ':') && (date_str[0] != '\0') ) {
424 num[i] = date_str[0];
428 if ( date_str[0] == ':' ) {
432 gmt.tm_min = atoi(num);
435 if ( strlen(date_str) ) {
437 while ( (date_str[0] != ':') && (date_str[0] != '\0') ) {
438 num[i] = date_str[0];
442 if ( date_str[0] == ':' ) {
446 gmt.tm_sec = atoi(num);
448 time_t theTime = sgTimeGetGMT( gmt.tm_year, gmt.tm_mon, gmt.tm_mday,
449 gmt.tm_hour, gmt.tm_min, gmt.tm_sec );
450 //printf ("Date is %s\n", ctime(&theTime));
451 //printf ("in seconds that is %d\n", theTime);
457 // parse angle in the form of [+/-]ddd:mm:ss into degrees
459 parse_degree( const string& degree_str) {
460 double result = parse_time( degree_str );
462 // printf("Degree = %.4f\n", result);
468 // parse time offset string into seconds
470 parse_time_offset( const string& time_str) {
473 // printf("time offset = %s\n", time_str);
476 result = (int)rint(parse_time(time_str) * 3600.0);
478 result = (int)(parse_time(time_str) * 3600.0);
481 // printf("parse_time_offset(): %d\n", result);
487 // Parse --fov=x.xx type option
489 parse_fov( const string& arg ) {
490 double fov = atof(arg);
492 if ( fov < FG_FOV_MIN ) { fov = FG_FOV_MIN; }
493 if ( fov > FG_FOV_MAX ) { fov = FG_FOV_MAX; }
495 fgSetDouble("/sim/current-view/field-of-view", fov);
497 // printf("parse_fov(): result = %.4f\n", fov);
503 // Parse I/O channel option
505 // Format is "--protocol=medium,direction,hz,medium_options,..."
507 // protocol = { native, nmea, garmin, fgfs, rul, pve, etc. }
508 // medium = { serial, socket, file, etc. }
509 // direction = { in, out, bi }
510 // hz = number of times to process channel per second (floating
511 // point values are ok.
513 // Serial example "--nmea=serial,dir,hz,device,baud" where
515 // device = OS device name of serial line to be open()'ed
516 // baud = {300, 1200, 2400, ..., 230400}
518 // Socket exacmple "--native=socket,dir,hz,machine,port,style" where
520 // machine = machine name or ip address if client (leave empty if server)
521 // port = port, leave empty to let system choose
522 // style = tcp or udp
524 // File example "--garmin=file,dir,hz,filename" where
526 // filename = file system file name
529 add_channel( const string& type, const string& channel_str ) {
530 SG_LOG(SG_GENERAL, SG_INFO, "Channel string = " << channel_str );
532 globals->get_channel_options_list()->push_back( type + "," + channel_str );
534 // cout << "here" << endl;
540 // The parse wp and parse flight-plan options don't work anymore, because
541 // the route manager and the airport subsystems have not yet been initialized
544 // Parse --wp=ID[@alt]
546 parse_wp( const string& arg ) {
547 string_list *waypoints = globals->get_initial_waypoints();
549 waypoints = new string_list;
550 globals->set_initial_waypoints(waypoints);
552 waypoints->push_back(arg);
556 // Parse --flight-plan=[file]
558 parse_flightplan(const string& arg)
560 string_list *waypoints = globals->get_initial_waypoints();
562 waypoints = new string_list;
563 globals->set_initial_waypoints(waypoints);
566 sg_gzifstream in(arg.c_str());
573 #if defined( macintosh )
574 getline( in, line, '\r' );
576 getline( in, line, '\n' );
578 // catch extraneous (DOS) line ending character
579 if ( line[line.length() - 1] < 32 )
580 line = line.substr( 0, line.length()-1 );
585 waypoints->push_back(line);
592 fgOptLanguage( const char *arg )
594 globals->set_locale( fgInitLocale( arg ) );
595 return FG_OPTIONS_OK;
601 fgSetString("/sim/presets/airport-id", "");
602 fgSetString("/sim/presets/vor-id", "");
603 fgSetString("/sim/presets/ndb-id", "");
604 fgSetString("/sim/presets/carrier", "");
605 fgSetString("/sim/presets/parkpos", "");
606 fgSetString("/sim/presets/fix", "");
610 fgOptVOR( const char * arg )
613 fgSetString("/sim/presets/vor-id", arg);
614 return FG_OPTIONS_OK;
618 fgOptNDB( const char * arg )
621 fgSetString("/sim/presets/ndb-id", arg);
622 return FG_OPTIONS_OK;
626 fgOptCarrier( const char * arg )
629 fgSetString("/sim/presets/carrier", arg);
630 return FG_OPTIONS_OK;
634 fgOptParkpos( const char * arg )
636 fgSetString("/sim/presets/parkpos", arg);
637 return FG_OPTIONS_OK;
641 fgOptFIX( const char * arg )
644 fgSetString("/sim/presets/fix", arg);
645 return FG_OPTIONS_OK;
649 fgOptLon( const char *arg )
652 fgSetDouble("/sim/presets/longitude-deg", parse_degree( arg ));
653 fgSetDouble("/position/longitude-deg", parse_degree( arg ));
654 return FG_OPTIONS_OK;
658 fgOptLat( const char *arg )
661 fgSetDouble("/sim/presets/latitude-deg", parse_degree( arg ));
662 fgSetDouble("/position/latitude-deg", parse_degree( arg ));
663 return FG_OPTIONS_OK;
667 fgOptAltitude( const char *arg )
669 fgSetBool("/sim/presets/onground", false);
670 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
671 fgSetDouble("/sim/presets/altitude-ft", atof( arg ));
673 fgSetDouble("/sim/presets/altitude-ft",
674 atof( arg ) * SG_METER_TO_FEET);
675 return FG_OPTIONS_OK;
679 fgOptUBody( const char *arg )
681 fgSetString("/sim/presets/speed-set", "UVW");
682 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
683 fgSetDouble("/sim/presets/uBody-fps", atof( arg ));
685 fgSetDouble("/sim/presets/uBody-fps",
686 atof( arg ) * SG_METER_TO_FEET);
687 return FG_OPTIONS_OK;
691 fgOptVBody( const char *arg )
693 fgSetString("/sim/presets/speed-set", "UVW");
694 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
695 fgSetDouble("/sim/presets/vBody-fps", atof( arg ));
697 fgSetDouble("/sim/presets/vBody-fps",
698 atof( arg ) * SG_METER_TO_FEET);
699 return FG_OPTIONS_OK;
703 fgOptWBody( const char *arg )
705 fgSetString("/sim/presets/speed-set", "UVW");
706 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
707 fgSetDouble("/sim/presets/wBody-fps", atof(arg));
709 fgSetDouble("/sim/presets/wBody-fps",
710 atof(arg) * SG_METER_TO_FEET);
711 return FG_OPTIONS_OK;
715 fgOptVNorth( const char *arg )
717 fgSetString("/sim/presets/speed-set", "NED");
718 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
719 fgSetDouble("/sim/presets/speed-north-fps", atof( arg ));
721 fgSetDouble("/sim/presets/speed-north-fps",
722 atof( arg ) * SG_METER_TO_FEET);
723 return FG_OPTIONS_OK;
727 fgOptVEast( const char *arg )
729 fgSetString("/sim/presets/speed-set", "NED");
730 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
731 fgSetDouble("/sim/presets/speed-east-fps", atof(arg));
733 fgSetDouble("/sim/presets/speed-east-fps",
734 atof(arg) * SG_METER_TO_FEET);
735 return FG_OPTIONS_OK;
739 fgOptVDown( const char *arg )
741 fgSetString("/sim/presets/speed-set", "NED");
742 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
743 fgSetDouble("/sim/presets/speed-down-fps", atof(arg));
745 fgSetDouble("/sim/presets/speed-down-fps",
746 atof(arg) * SG_METER_TO_FEET);
747 return FG_OPTIONS_OK;
751 fgOptVc( const char *arg )
753 // fgSetString("/sim/presets/speed-set", "knots");
754 // fgSetDouble("/velocities/airspeed-kt", atof(arg.substr(5)));
755 fgSetString("/sim/presets/speed-set", "knots");
756 fgSetDouble("/sim/presets/airspeed-kt", atof(arg));
757 return FG_OPTIONS_OK;
761 fgOptMach( const char *arg )
763 fgSetString("/sim/presets/speed-set", "mach");
764 fgSetDouble("/sim/presets/mach", atof(arg));
765 return FG_OPTIONS_OK;
769 fgOptRoc( const char *arg )
771 fgSetDouble("/velocities/vertical-speed-fps", atof(arg)/60);
772 return FG_OPTIONS_OK;
776 fgOptFgRoot( const char *arg )
778 globals->set_fg_root(arg);
779 return FG_OPTIONS_OK;
783 fgOptFgScenery( const char *arg )
785 globals->set_fg_scenery(arg);
786 return FG_OPTIONS_OK;
790 fgOptFov( const char *arg )
793 return FG_OPTIONS_OK;
797 fgOptGeometry( const char *arg )
799 bool geometry_ok = true;
800 int xsize = 0, ysize = 0;
801 string geometry = arg;
802 string::size_type i = geometry.find('x');
804 if (i != string::npos) {
805 xsize = atoi(geometry.substr(0, i));
806 ysize = atoi(geometry.substr(i+1));
811 if ( xsize <= 0 || ysize <= 0 ) {
817 if ( !geometry_ok ) {
818 SG_LOG( SG_GENERAL, SG_ALERT, "Unknown geometry: " << geometry );
819 SG_LOG( SG_GENERAL, SG_ALERT,
820 "Setting geometry to " << xsize << 'x' << ysize << '\n');
822 SG_LOG( SG_GENERAL, SG_INFO,
823 "Setting geometry to " << xsize << 'x' << ysize << '\n');
824 fgSetInt("/sim/startup/xsize", xsize);
825 fgSetInt("/sim/startup/ysize", ysize);
827 return FG_OPTIONS_OK;
831 fgOptBpp( const char *arg )
833 string bits_per_pix = arg;
834 if ( bits_per_pix == "16" ) {
835 fgSetInt("/sim/rendering/bits-per-pixel", 16);
836 } else if ( bits_per_pix == "24" ) {
837 fgSetInt("/sim/rendering/bits-per-pixel", 24);
838 } else if ( bits_per_pix == "32" ) {
839 fgSetInt("/sim/rendering/bits-per-pixel", 32);
841 SG_LOG(SG_GENERAL, SG_ALERT, "Unsupported bpp " << bits_per_pix);
843 return FG_OPTIONS_OK;
847 fgOptTimeOffset( const char *arg )
849 fgSetInt("/sim/startup/time-offset",
850 parse_time_offset( arg ));
851 fgSetString("/sim/startup/time-offset-type", "system-offset");
852 return FG_OPTIONS_OK;
856 fgOptStartDateSys( const char *arg )
858 fgSetInt("/sim/startup/time-offset", parse_date( arg ) );
859 fgSetString("/sim/startup/time-offset-type", "system");
860 return FG_OPTIONS_OK;
864 fgOptStartDateLat( const char *arg )
866 fgSetInt("/sim/startup/time-offset", parse_date( arg ) );
867 fgSetString("/sim/startup/time-offset-type", "latitude");
868 return FG_OPTIONS_OK;
872 fgOptStartDateGmt( const char *arg )
874 fgSetInt("/sim/startup/time-offset", parse_date( arg ) );
875 fgSetString("/sim/startup/time-offset-type", "gmt");
876 return FG_OPTIONS_OK;
880 fgSetupProxy( const char *arg )
882 string options = arg;
883 string host, port, auth;
886 host = port = auth = "";
887 if ((pos = options.find("@")) != string::npos)
888 auth = options.substr(0, pos++);
892 host = options.substr(pos, options.size());
893 if ((pos = host.find(":")) != string::npos) {
894 port = host.substr(++pos, host.size());
895 host.erase(--pos, host.size());
898 fgSetString("/sim/presets/proxy/host", host.c_str());
899 fgSetString("/sim/presets/proxy/port", port.c_str());
900 fgSetString("/sim/presets/proxy/authentication", auth.c_str());
902 return FG_OPTIONS_OK;
906 fgOptTraceRead( const char *arg )
909 SG_LOG(SG_GENERAL, SG_INFO, "Tracing reads for property " << name);
910 fgGetNode(name.c_str(), true)
911 ->setAttribute(SGPropertyNode::TRACE_READ, true);
912 return FG_OPTIONS_OK;
916 fgOptLogLevel( const char *arg )
918 fgSetString("/sim/logging/classes", "all");
919 fgSetString("/sim/logging/priority", arg);
921 string priority = arg;
922 logbuf::set_log_classes(SG_ALL);
923 if (priority == "bulk") {
924 logbuf::set_log_priority(SG_BULK);
925 } else if (priority == "debug") {
926 logbuf::set_log_priority(SG_DEBUG);
927 } else if (priority == "info") {
928 logbuf::set_log_priority(SG_INFO);
929 } else if (priority == "warn") {
930 logbuf::set_log_priority(SG_WARN);
931 } else if (priority == "alert") {
932 logbuf::set_log_priority(SG_ALERT);
934 SG_LOG(SG_GENERAL, SG_WARN, "Unknown logging priority " << priority);
936 SG_LOG(SG_GENERAL, SG_DEBUG, "Logging priority is " << priority);
938 return FG_OPTIONS_OK;
943 fgOptTraceWrite( const char *arg )
946 SG_LOG(SG_GENERAL, SG_INFO, "Tracing writes for property " << name);
947 fgGetNode(name.c_str(), true)
948 ->setAttribute(SGPropertyNode::TRACE_WRITE, true);
949 return FG_OPTIONS_OK;
953 fgOptViewOffset( const char *arg )
955 // $$$ begin - added VS Renganathan, 14 Oct 2K
956 // for multi-window outside window imagery
957 string woffset = arg;
958 double default_view_offset = 0.0;
959 if ( woffset == "LEFT" ) {
960 default_view_offset = SGD_PI * 0.25;
961 } else if ( woffset == "RIGHT" ) {
962 default_view_offset = SGD_PI * 1.75;
963 } else if ( woffset == "CENTER" ) {
964 default_view_offset = 0.00;
966 default_view_offset = atof( woffset.c_str() ) * SGD_DEGREES_TO_RADIANS;
968 /* apparently not used (CLO, 11 Jun 2002)
969 FGViewer *pilot_view =
970 (FGViewer *)globals->get_viewmgr()->get_view( 0 ); */
971 // this will work without calls to the viewer...
972 fgSetDouble( "/sim/current-view/heading-offset-deg",
973 default_view_offset * SGD_RADIANS_TO_DEGREES );
974 // $$$ end - added VS Renganathan, 14 Oct 2K
975 return FG_OPTIONS_OK;
979 fgOptVisibilityMeters( const char *arg )
981 double visibility = atof( arg );
982 fgDefaultWeatherValue("visibility-m", visibility);
983 return FG_OPTIONS_OK;
987 fgOptVisibilityMiles( const char *arg )
989 double visibility = atof( arg ) * 5280.0 * SG_FEET_TO_METER;
990 fgDefaultWeatherValue("visibility-m", visibility);
991 return FG_OPTIONS_OK;
995 fgOptRandomWind( const char *arg )
997 double min_hdg = sg_random() * 360.0;
998 double max_hdg = min_hdg + (20 - sqrt(sg_random() * 400));
999 double speed = sg_random() * sg_random() * 40;
1000 double gust = speed + (10 - sqrt(sg_random() * 100));
1001 fgSetupWind(min_hdg, max_hdg, speed, gust);
1002 return FG_OPTIONS_OK;
1006 fgOptWind( const char *arg )
1008 double min_hdg, max_hdg, speed, gust;
1009 if (!parse_wind( arg, &min_hdg, &max_hdg, &speed, &gust)) {
1010 SG_LOG( SG_GENERAL, SG_ALERT, "bad wind value " << arg );
1011 return FG_OPTIONS_ERROR;
1013 fgSetupWind(min_hdg, max_hdg, speed, gust);
1014 return FG_OPTIONS_OK;
1018 fgOptTurbulence( const char *arg )
1020 fgDefaultWeatherValue("turbulence/magnitude-norm", atof(arg));
1021 return FG_OPTIONS_OK;
1025 fgOptCeiling( const char *arg )
1027 double elevation, thickness;
1029 string::size_type pos = spec.find(':');
1030 if (pos == string::npos) {
1031 elevation = atof(spec.c_str());
1034 elevation = atof(spec.substr(0, pos).c_str());
1035 thickness = atof(spec.substr(pos + 1).c_str());
1037 fgSetDouble("/environment/clouds/layer[0]/elevation-ft", elevation);
1038 fgSetDouble("/environment/clouds/layer[0]/thickness-ft", thickness);
1039 fgSetString("/environment/clouds/layer[0]/coverage", "overcast");
1040 return FG_OPTIONS_OK;
1044 fgOptWp( const char *arg )
1047 return FG_OPTIONS_OK;
1051 fgOptFlightPlan( const char *arg )
1053 parse_flightplan ( arg );
1054 return FG_OPTIONS_OK;
1058 fgOptConfig( const char *arg )
1062 readProperties(file, globals->get_props());
1063 } catch (const sg_exception &e) {
1064 string message = "Error loading config file: ";
1065 message += e.getFormattedMessage() + e.getOrigin();
1066 SG_LOG(SG_INPUT, SG_ALERT, message);
1069 return FG_OPTIONS_OK;
1073 parse_colon (const string &s, double * val1, double * val2)
1075 string::size_type pos = s.find(':');
1076 if (pos == string::npos) {
1080 *val1 = atof(s.substr(0, pos).c_str());
1081 *val2 = atof(s.substr(pos+1).c_str());
1088 fgOptFailure( const char * arg )
1092 fgSetBool("/systems/pitot/serviceable", false);
1093 } else if (a == "static") {
1094 fgSetBool("/systems/static/serviceable", false);
1095 } else if (a == "vacuum") {
1096 fgSetBool("/systems/vacuum/serviceable", false);
1097 } else if (a == "electrical") {
1098 fgSetBool("/systems/electrical/serviceable", false);
1100 SG_LOG(SG_INPUT, SG_ALERT, "Unknown failure mode: " << a);
1101 return FG_OPTIONS_ERROR;
1104 return FG_OPTIONS_OK;
1109 fgOptNAV1( const char * arg )
1111 double radial, freq;
1112 if (parse_colon(arg, &radial, &freq))
1113 fgSetDouble("/instrumentation/nav[0]/radials/selected-deg", radial);
1114 fgSetDouble("/instrumentation/nav[0]/frequencies/selected-mhz", freq);
1115 return FG_OPTIONS_OK;
1119 fgOptNAV2( const char * arg )
1121 double radial, freq;
1122 if (parse_colon(arg, &radial, &freq))
1123 fgSetDouble("/instrumentation/nav[1]/radials/selected-deg", radial);
1124 fgSetDouble("/instrumentation/nav[1]/frequencies/selected-mhz", freq);
1125 return FG_OPTIONS_OK;
1129 fgOptADF( const char * arg )
1132 if (parse_colon(arg, &rot, &freq))
1133 fgSetDouble("/instrumentation/adf/rotation-deg", rot);
1134 fgSetDouble("/instrumentation/adf/frequencies/selected-khz", freq);
1135 return FG_OPTIONS_OK;
1139 fgOptDME( const char *arg )
1142 if (opt == "nav1") {
1143 fgSetInt("/instrumentation/dme/switch-position", 1);
1144 fgSetString("/instrumentation/dme/frequencies/source",
1145 "/instrumentation/nav[0]/frequencies/selected-mhz");
1146 } else if (opt == "nav2") {
1147 fgSetInt("/instrumentation/dme/switch-position", 3);
1148 fgSetString("/instrumentation/dme/frequencies/source",
1149 "/instrumentation/nav[1]/frequencies/selected-mhz");
1151 fgSetInt("/instrumentation/dme/switch-position", 2);
1152 fgSetString("/instrumentation/dme/frequencies/source",
1153 "/instrumentation/dme/frequencies/selected-mhz");
1154 fgSetString("/instrumentation/dme/frequencies/selected-mhz", arg);
1156 return FG_OPTIONS_OK;
1160 fgOptLivery( const char *arg )
1163 string livery_path = "livery/" + opt;
1164 fgSetString("/sim/model/texture-path", livery_path.c_str() );
1165 return FG_OPTIONS_OK;
1169 fgOptScenario( const char *arg )
1171 SGPropertyNode_ptr ai_node = fgGetNode( "/sim/ai", true );
1172 vector<SGPropertyNode_ptr> scenarii = ai_node->getChildren( "scenario" );
1174 for ( size_t i = 0; i < scenarii.size(); ++i ) {
1175 int ind = scenarii[i]->getIndex();
1176 if ( index < ind ) {
1180 SGPropertyNode_ptr scenario = ai_node->getNode( "scenario", index + 1, true );
1181 scenario->setStringValue( arg );
1182 ai_node->setBoolValue( "enabled", true );
1183 return FG_OPTIONS_OK;
1187 fgOptRunway( const char *arg )
1189 fgSetString("/sim/presets/runway", arg );
1190 fgSetBool("/sim/presets/runway-requested", true );
1191 return FG_OPTIONS_OK;
1194 static map<string,size_t> fgOptionMap;
1197 option has_param type property b_param s_param func
1200 option : name of the option
1201 has_param : option is --name=value if true or --name if false
1202 type : OPTION_BOOL - property is a boolean
1203 OPTION_STRING - property is a string
1204 OPTION_DOUBLE - property is a double
1205 OPTION_INT - property is an integer
1206 OPTION_CHANNEL - name of option is the name of a channel
1207 OPTION_FUNC - the option trigger a function
1208 b_param : if type==OPTION_BOOL,
1209 value set to the property (has_param is false for boolean)
1210 s_param : if type==OPTION_STRING,
1211 value set to the property if has_param is false
1212 func : function called if type==OPTION_FUNC. if has_param is true,
1213 the value is passed to the function as a string, otherwise,
1216 For OPTION_DOUBLE and OPTION_INT, the parameter value is converted into a
1217 double or an integer and set to the property.
1219 For OPTION_CHANNEL, add_channel is called with the parameter value as the
1223 enum OptionType { OPTION_BOOL, OPTION_STRING, OPTION_DOUBLE, OPTION_INT, OPTION_CHANNEL, OPTION_FUNC };
1227 enum OptionType type;
1231 int (*func)( const char * );
1232 } fgOptionArray[] = {
1234 {"language", true, OPTION_FUNC, "", false, "", fgOptLanguage },
1235 {"disable-game-mode", false, OPTION_BOOL, "/sim/startup/game-mode", false, "", 0 },
1236 {"enable-game-mode", false, OPTION_BOOL, "/sim/startup/game-mode", true, "", 0 },
1237 {"disable-splash-screen", false, OPTION_BOOL, "/sim/startup/splash-screen", false, "", 0 },
1238 {"enable-splash-screen", false, OPTION_BOOL, "/sim/startup/splash-screen", true, "", 0 },
1239 {"disable-intro-music", false, OPTION_BOOL, "/sim/startup/intro-music", false, "", 0 },
1240 {"enable-intro-music", false, OPTION_BOOL, "/sim/startup/intro-music", true, "", 0 },
1241 {"disable-mouse-pointer", false, OPTION_STRING, "/sim/startup/mouse-pointer", false, "disabled", 0 },
1242 {"enable-mouse-pointer", false, OPTION_STRING, "/sim/startup/mouse-pointer", false, "enabled", 0 },
1243 {"disable-random-objects", false, OPTION_BOOL, "/sim/rendering/random-objects", false, "", 0 },
1244 {"enable-random-objects", false, OPTION_BOOL, "/sim/rendering/random-objects", true, "", 0 },
1245 {"disable-real-weather-fetch", false, OPTION_BOOL, "/environment/params/real-world-weather-fetch", false, "", 0 },
1246 {"enable-real-weather-fetch", false, OPTION_BOOL, "/environment/params/real-world-weather-fetch", true, "", 0 },
1247 {"disable-ai-models", false, OPTION_BOOL, "/sim/ai/enabled", false, "", 0 },
1248 {"enable-ai-models", false, OPTION_BOOL, "/sim/ai/enabled", true, "", 0 },
1249 {"disable-freeze", false, OPTION_BOOL, "/sim/freeze/master", false, "", 0 },
1250 {"enable-freeze", false, OPTION_BOOL, "/sim/freeze/master", true, "", 0 },
1251 {"disable-fuel-freeze", false, OPTION_BOOL, "/sim/freeze/fuel", false, "", 0 },
1252 {"enable-fuel-freeze", false, OPTION_BOOL, "/sim/freeze/fuel", true, "", 0 },
1253 {"disable-clock-freeze", false, OPTION_BOOL, "/sim/freeze/clock", false, "", 0 },
1254 {"enable-clock-freeze", false, OPTION_BOOL, "/sim/freeze/clock", true, "", 0 },
1255 {"disable-hud-3d", false, OPTION_BOOL, "/sim/hud/enable3d", false, "", 0 },
1256 {"enable-hud-3d", false, OPTION_BOOL, "/sim/hud/enable3d", true, "", 0 },
1257 {"disable-anti-alias-hud", false, OPTION_BOOL, "/sim/hud/antialiased", false, "", 0 },
1258 {"enable-anti-alias-hud", false, OPTION_BOOL, "/sim/hud/antialiased", true, "", 0 },
1259 {"control", true, OPTION_STRING, "/sim/control-mode", false, "", 0 },
1260 {"disable-auto-coordination", false, OPTION_BOOL, "/sim/auto-coordination", false, "", 0 },
1261 {"enable-auto-coordination", false, OPTION_BOOL, "/sim/auto-coordination", true, "", 0 },
1262 {"browser-app", true, OPTION_STRING, "/sim/startup/browser-app", false, "", 0 },
1263 {"disable-hud", false, OPTION_BOOL, "/sim/hud/visibility", false, "", 0 },
1264 {"enable-hud", false, OPTION_BOOL, "/sim/hud/visibility", true, "", 0 },
1265 {"disable-panel", false, OPTION_BOOL, "/sim/panel/visibility", false, "", 0 },
1266 {"enable-panel", false, OPTION_BOOL, "/sim/panel/visibility", true, "", 0 },
1267 {"disable-sound", false, OPTION_BOOL, "/sim/sound/pause", true, "", 0 },
1268 {"enable-sound", false, OPTION_BOOL, "/sim/sound/pause", false, "", 0 },
1269 {"airport", true, OPTION_STRING, "/sim/presets/airport-id", false, "", 0 },
1270 {"airport-id", true, OPTION_STRING, "/sim/presets/airport-id", false, "", 0 },
1271 {"runway", true, OPTION_FUNC, "", false, "", fgOptRunway },
1272 {"vor", true, OPTION_FUNC, "", false, "", fgOptVOR },
1273 {"ndb", true, OPTION_FUNC, "", false, "", fgOptNDB },
1274 {"carrier", true, OPTION_FUNC, "", false, "", fgOptCarrier },
1275 {"parkpos", true, OPTION_FUNC, "", false, "", fgOptParkpos },
1276 {"fix", true, OPTION_FUNC, "", false, "", fgOptFIX },
1277 {"offset-distance", true, OPTION_DOUBLE, "/sim/presets/offset-distance", false, "", 0 },
1278 {"offset-azimuth", true, OPTION_DOUBLE, "/sim/presets/offset-azimuth", false, "", 0 },
1279 {"lon", true, OPTION_FUNC, "", false, "", fgOptLon },
1280 {"lat", true, OPTION_FUNC, "", false, "", fgOptLat },
1281 {"altitude", true, OPTION_FUNC, "", false, "", fgOptAltitude },
1282 {"uBody", true, OPTION_FUNC, "", false, "", fgOptUBody },
1283 {"vBody", true, OPTION_FUNC, "", false, "", fgOptVBody },
1284 {"wBody", true, OPTION_FUNC, "", false, "", fgOptWBody },
1285 {"vNorth", true, OPTION_FUNC, "", false, "", fgOptVNorth },
1286 {"vEast", true, OPTION_FUNC, "", false, "", fgOptVEast },
1287 {"vDown", true, OPTION_FUNC, "", false, "", fgOptVDown },
1288 {"vc", true, OPTION_FUNC, "", false, "", fgOptVc },
1289 {"mach", true, OPTION_FUNC, "", false, "", fgOptMach },
1290 {"heading", true, OPTION_DOUBLE, "/sim/presets/heading-deg", false, "", 0 },
1291 {"roll", true, OPTION_DOUBLE, "/sim/presets/roll-deg", false, "", 0 },
1292 {"pitch", true, OPTION_DOUBLE, "/sim/presets/pitch-deg", false, "", 0 },
1293 {"glideslope", true, OPTION_DOUBLE, "/sim/presets/glideslope-deg", false, "", 0 },
1294 {"roc", true, OPTION_FUNC, "", false, "", fgOptRoc },
1295 {"fg-root", true, OPTION_FUNC, "", false, "", fgOptFgRoot },
1296 {"fg-scenery", true, OPTION_FUNC, "", false, "", fgOptFgScenery },
1297 {"fdm", true, OPTION_STRING, "/sim/flight-model", false, "", 0 },
1298 {"aero", true, OPTION_STRING, "/sim/aero", false, "", 0 },
1299 {"aircraft-dir", true, OPTION_STRING, "/sim/aircraft-dir", false, "", 0 },
1300 {"model-hz", true, OPTION_INT, "/sim/model-hz", false, "", 0 },
1301 {"speed", true, OPTION_INT, "/sim/speed-up", false, "", 0 },
1302 {"trim", false, OPTION_BOOL, "/sim/presets/trim", true, "", 0 },
1303 {"notrim", false, OPTION_BOOL, "/sim/presets/trim", false, "", 0 },
1304 {"on-ground", false, OPTION_BOOL, "/sim/presets/onground", true, "", 0 },
1305 {"in-air", false, OPTION_BOOL, "/sim/presets/onground", false, "", 0 },
1306 {"fog-disable", false, OPTION_STRING, "/sim/rendering/fog", false, "disabled", 0 },
1307 {"fog-fastest", false, OPTION_STRING, "/sim/rendering/fog", false, "fastest", 0 },
1308 {"fog-nicest", false, OPTION_STRING, "/sim/rendering/fog", false, "nicest", 0 },
1309 {"disable-horizon-effect", false, OPTION_BOOL, "/sim/rendering/horizon-effect", false, "", 0 },
1310 {"enable-horizon-effect", false, OPTION_BOOL, "/sim/rendering/horizon-effect", true, "", 0 },
1311 {"disable-enhanced-lighting", false, OPTION_BOOL, "/sim/rendering/enhanced-lighting", false, "", 0 },
1312 {"enable-enhanced-lighting", false, OPTION_BOOL, "/sim/rendering/enhanced-lighting", true, "", 0 },
1313 {"disable-distance-attenuation", false, OPTION_BOOL, "/sim/rendering/distance-attenuation", false, "", 0 },
1314 {"enable-distance-attenuation", false, OPTION_BOOL, "/sim/rendering/distance-attenuation", true, "", 0 },
1315 {"disable-specular-highlight", false, OPTION_BOOL, "/sim/rendering/specular-highlight", false, "", 0 },
1316 {"enable-specular-highlight", false, OPTION_BOOL, "/sim/rendering/specular-highlight", true, "", 0 },
1317 {"disable-clouds", false, OPTION_BOOL, "/environment/clouds/status", false, "", 0 },
1318 {"enable-clouds", false, OPTION_BOOL, "/environment/clouds/status", true, "", 0 },
1319 {"disable-clouds3d", false, OPTION_BOOL, "/sim/rendering/clouds3d-enable", false, "", 0 },
1320 {"enable-clouds3d", false, OPTION_BOOL, "/sim/rendering/clouds3d-enable", true, "", 0 },
1321 {"fov", true, OPTION_FUNC, "", false, "", fgOptFov },
1322 {"aspect-ratio-multiplier", true, OPTION_DOUBLE, "/sim/current-view/aspect-ratio-multiplier", false, "", 0 },
1323 {"disable-fullscreen", false, OPTION_BOOL, "/sim/startup/fullscreen", false, "", 0 },
1324 {"enable-fullscreen", false, OPTION_BOOL, "/sim/startup/fullscreen", true, "", 0 },
1325 {"disable-save-on-exit", false, OPTION_BOOL, "/sim/startup/save-on-exit", false, "", 0 },
1326 {"enable-save-on-exit", false, OPTION_BOOL, "/sim/startup/save-on-exit", true, "", 0 },
1327 {"shading-flat", false, OPTION_BOOL, "/sim/rendering/shading", false, "", 0 },
1328 {"shading-smooth", false, OPTION_BOOL, "/sim/rendering/shading", true, "", 0 },
1329 {"disable-skyblend", false, OPTION_BOOL, "/sim/rendering/skyblend", false, "", 0 },
1330 {"enable-skyblend", false, OPTION_BOOL, "/sim/rendering/skyblend", true, "", 0 },
1331 {"disable-textures", false, OPTION_BOOL, "/sim/rendering/textures", false, "", 0 },
1332 {"enable-textures", false, OPTION_BOOL, "/sim/rendering/textures", true, "", 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 {"garmin", true, OPTION_CHANNEL, "", false, "", 0 },
1361 {"nmea", true, OPTION_CHANNEL, "", false, "", 0 },
1362 {"generic", true, OPTION_CHANNEL, "", false, "", 0 },
1363 {"props", true, OPTION_CHANNEL, "", false, "", 0 },
1364 {"telnet", true, OPTION_CHANNEL, "", false, "", 0 },
1365 {"pve", true, OPTION_CHANNEL, "", false, "", 0 },
1366 {"ray", true, OPTION_CHANNEL, "", false, "", 0 },
1367 {"rul", true, OPTION_CHANNEL, "", false, "", 0 },
1368 {"joyclient", true, OPTION_CHANNEL, "", false, "", 0 },
1369 {"jsclient", true, OPTION_CHANNEL, "", false, "", 0 },
1370 {"proxy", true, OPTION_FUNC, "", false, "", fgSetupProxy },
1371 {"callsign", true, OPTION_STRING, "sim/multiplay/callsign", false, "", 0 },
1372 {"multiplay", true, OPTION_CHANNEL, "", false, "", 0 },
1373 {"trace-read", true, OPTION_FUNC, "", false, "", fgOptTraceRead },
1374 {"trace-write", true, OPTION_FUNC, "", false, "", fgOptTraceWrite },
1375 {"log-level", true, OPTION_FUNC, "", false, "", fgOptLogLevel },
1376 {"view-offset", true, OPTION_FUNC, "", false, "", fgOptViewOffset },
1377 {"visibility", true, OPTION_FUNC, "", false, "", fgOptVisibilityMeters },
1378 {"visibility-miles", true, OPTION_FUNC, "", false, "", fgOptVisibilityMiles },
1379 {"random-wind", false, OPTION_FUNC, "", false, "", fgOptRandomWind },
1380 {"wind", true, OPTION_FUNC, "", false, "", fgOptWind },
1381 {"turbulence", true, OPTION_FUNC, "", false, "", fgOptTurbulence },
1382 {"ceiling", true, OPTION_FUNC, "", false, "", fgOptCeiling },
1383 {"wp", true, OPTION_FUNC, "", false, "", fgOptWp },
1384 {"flight-plan", true, OPTION_FUNC, "", false, "", fgOptFlightPlan },
1385 {"config", true, OPTION_FUNC, "", false, "", fgOptConfig },
1386 {"aircraft", true, OPTION_STRING, "/sim/aircraft", false, "", 0 },
1387 {"failure", true, OPTION_FUNC, "", false, "", fgOptFailure },
1388 {"com1", true, OPTION_DOUBLE, "/instrumentation/comm[0]/frequencies/selected-mhz", false, "", 0 },
1389 {"com2", true, OPTION_DOUBLE, "/instrumentation/comm[1]/frequencies/selected-mhz", false, "", 0 },
1390 {"nav1", true, OPTION_FUNC, "", false, "", fgOptNAV1 },
1391 {"nav2", true, OPTION_FUNC, "", false, "", fgOptNAV2 },
1392 {"adf", true, OPTION_FUNC, "", false, "", fgOptADF },
1393 {"dme", true, OPTION_FUNC, "", false, "", fgOptDME },
1394 {"min-status", true, OPTION_STRING, "/sim/aircraft-min-status", false, "all", 0 },
1395 {"livery", true, OPTION_FUNC, "", false, "", fgOptLivery },
1396 {"ai-scenario", true, OPTION_FUNC, "", false, "", fgOptScenario },
1401 // Parse a single option
1403 parse_option (const string& arg)
1405 if ( fgOptionMap.size() == 0 ) {
1407 OptionDesc *pt = &fgOptionArray[ 0 ];
1408 while ( pt->option != 0 ) {
1409 fgOptionMap[ pt->option ] = i;
1416 if ( (arg == "--help") || (arg == "-h") ) {
1417 // help/usage request
1418 return(FG_OPTIONS_HELP);
1419 } else if ( (arg == "--verbose") || (arg == "-v") ) {
1420 // verbose help/usage request
1421 return(FG_OPTIONS_VERBOSE_HELP);
1422 } else if ( arg.find( "--show-aircraft") == 0) {
1423 return(FG_OPTIONS_SHOW_AIRCRAFT);
1424 } else if ( arg.find( "--prop:" ) == 0 ) {
1425 string assign = arg.substr(7);
1426 string::size_type pos = assign.find('=');
1427 if ( pos == arg.npos || pos == 0 || pos + 1 == assign.size() ) {
1428 SG_LOG( SG_GENERAL, SG_ALERT, "Bad property assignment: " << arg );
1429 return FG_OPTIONS_ERROR;
1431 string name = assign.substr(0, pos);
1432 string value = assign.substr(pos + 1);
1433 fgSetString(name.c_str(), value.c_str());
1435 } else if ( arg.find( "--" ) == 0 ) {
1436 size_t pos = arg.find( '=' );
1438 if ( pos == string::npos ) {
1439 arg_name = arg.substr( 2 );
1441 arg_name = arg.substr( 2, pos - 2 );
1443 map<string,size_t>::iterator it = fgOptionMap.find( arg_name );
1444 if ( it != fgOptionMap.end() ) {
1445 OptionDesc *pt = &fgOptionArray[ it->second ];
1446 switch ( pt->type ) {
1448 fgSetBool( pt->property, pt->b_param );
1451 if ( pt->has_param && pos != string::npos && pos + 1 < arg.size() ) {
1452 fgSetString( pt->property, arg.substr( pos + 1 ).c_str() );
1453 } else if ( !pt->has_param && pos == string::npos ) {
1454 fgSetString( pt->property, pt->s_param );
1455 } else if ( pt->has_param ) {
1456 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << arg << "' needs a parameter" );
1457 return FG_OPTIONS_ERROR;
1459 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << arg << "' does not have a parameter" );
1460 return FG_OPTIONS_ERROR;
1464 if ( pos != string::npos && pos + 1 < arg.size() ) {
1465 fgSetDouble( pt->property, atof( arg.substr( pos + 1 ) ) );
1467 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << arg << "' needs a parameter" );
1468 return FG_OPTIONS_ERROR;
1472 if ( pos != string::npos && pos + 1 < arg.size() ) {
1473 fgSetInt( pt->property, atoi( arg.substr( pos + 1 ) ) );
1475 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << arg << "' needs a parameter" );
1476 return FG_OPTIONS_ERROR;
1479 case OPTION_CHANNEL:
1480 if ( pt->has_param && pos != string::npos && pos + 1 < arg.size() ) {
1481 add_channel( pt->option, arg.substr( pos + 1 ) );
1482 } else if ( !pt->has_param && pos == string::npos ) {
1483 add_channel( pt->option, pt->s_param );
1484 } else if ( pt->has_param ) {
1485 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << arg << "' needs a parameter" );
1486 return FG_OPTIONS_ERROR;
1488 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << arg << "' does not have a parameter" );
1489 return FG_OPTIONS_ERROR;
1493 if ( pt->has_param && pos != string::npos && pos + 1 < arg.size() ) {
1494 return pt->func( arg.substr( pos + 1 ).c_str() );
1495 } else if ( !pt->has_param && pos == string::npos ) {
1496 return pt->func( 0 );
1497 } else if ( pt->has_param ) {
1498 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << arg << "' needs a parameter" );
1499 return FG_OPTIONS_ERROR;
1501 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << arg << "' does not have a parameter" );
1502 return FG_OPTIONS_ERROR;
1507 SG_LOG( SG_GENERAL, SG_ALERT, "Unknown option '" << arg << "'" );
1508 return FG_OPTIONS_ERROR;
1511 SG_LOG( SG_GENERAL, SG_ALERT, "Unknown option '" << arg << "'" );
1512 return FG_OPTIONS_ERROR;
1515 return FG_OPTIONS_OK;
1519 // Parse the command line options
1521 fgParseArgs (int argc, char **argv)
1523 bool in_options = true;
1524 bool verbose = false;
1527 SG_LOG(SG_GENERAL, SG_INFO, "Processing command line arguments");
1529 for (int i = 1; i < argc; i++) {
1530 string arg = argv[i];
1532 if (in_options && (arg.find('-') == 0)) {
1536 int result = parse_option(arg);
1537 if ((result == FG_OPTIONS_HELP) || (result == FG_OPTIONS_ERROR))
1540 else if (result == FG_OPTIONS_VERBOSE_HELP)
1543 else if (result == FG_OPTIONS_SHOW_AIRCRAFT) {
1544 fgOptLogLevel( "alert" );
1545 SGPath path( globals->get_fg_root() );
1546 path.append("Aircraft");
1547 fgShowAircraft(path, true);
1553 SG_LOG(SG_GENERAL, SG_INFO,
1554 "Reading command-line property file " << arg);
1555 readProperties(arg, globals->get_props());
1560 fgOptLogLevel( "alert" );
1565 SG_LOG(SG_GENERAL, SG_INFO, "Finished command line arguments");
1569 // Parse config file options
1571 fgParseOptions (const string& path) {
1572 sg_gzifstream in( path );
1573 if ( !in.is_open() ) {
1577 SG_LOG( SG_GENERAL, SG_INFO, "Processing config file: " << path );
1581 while ( ! in.eof() ) {
1584 while ( in.get(c) && c != '\0' ) {
1589 #if defined( macintosh )
1590 getline( in, line, '\r' );
1592 getline( in, line, '\n' );
1595 // catch extraneous (DOS) line ending character
1597 for (i = line.length(); i > 0; i--)
1598 if (line[i - 1] > 32)
1600 line = line.substr( 0, i );
1602 if ( parse_option( line ) == FG_OPTIONS_ERROR ) {
1603 cerr << endl << "Config file parse error: " << path << " '"
1604 << line << "'" << endl;
1613 // Print usage message
1615 fgUsage (bool verbose)
1617 SGPropertyNode *locale = globals->get_locale();
1619 SGPropertyNode options_root;
1621 SG_LOG( SG_GENERAL, SG_ALERT, "" ); // To popup the console on Windows
1625 fgLoadProps("options.xml", &options_root);
1626 } catch (const sg_exception &ex) {
1627 cout << "Unable to read the help file." << endl;
1628 cout << "Make sure the file options.xml is located in the FlightGear base directory," << endl;
1629 cout << "and the location of the base directory is specified by setting $FG_ROOT or" << endl;
1630 cout << "by adding --fg-root=path as a program argument." << endl;
1635 SGPropertyNode *options = options_root.getNode("options");
1637 SG_LOG( SG_GENERAL, SG_ALERT,
1638 "Error reading options.xml: <options> directive not found." );
1642 SGPropertyNode *usage = locale->getNode(options->getStringValue("usage"));
1644 cout << "Usage: " << usage->getStringValue() << endl;
1647 vector<SGPropertyNode_ptr>section = options->getChildren("section");
1648 for (unsigned int j = 0; j < section.size(); j++) {
1651 vector<SGPropertyNode_ptr>option = section[j]->getChildren("option");
1652 for (unsigned int k = 0; k < option.size(); k++) {
1654 SGPropertyNode *name = option[k]->getNode("name");
1655 SGPropertyNode *short_name = option[k]->getNode("short");
1656 SGPropertyNode *key = option[k]->getNode("key");
1657 SGPropertyNode *arg = option[k]->getNode("arg");
1658 bool brief = option[k]->getNode("brief");
1660 if ((brief || verbose) && name) {
1661 string tmp = name->getStringValue();
1665 tmp.append(key->getStringValue());
1669 tmp.append(arg->getStringValue());
1673 tmp.append(short_name->getStringValue());
1677 if (tmp.size() <= 25) {
1678 snprintf(cstr, 96, " --%-27s", tmp.c_str());
1680 snprintf(cstr, 96, "\n --%s\n%32c", tmp.c_str(), ' ');
1683 // There may be more than one <description> tag assosiated
1687 vector<SGPropertyNode_ptr>desc =
1688 option[k]->getChildren("description");
1690 if (desc.size() > 0) {
1691 for ( unsigned int l = 0; l < desc.size(); l++) {
1693 // There may be more than one translation line.
1695 string t = desc[l]->getStringValue();
1696 SGPropertyNode *n = locale->getNode("strings");
1697 vector<SGPropertyNode_ptr>trans_desc =
1698 n->getChildren(t.substr(8).c_str());
1700 for ( unsigned int m = 0; m < trans_desc.size(); m++ ) {
1701 string t_str = trans_desc[m]->getStringValue();
1703 if ((m > 0) || ((l > 0) && m == 0)) {
1704 snprintf(cstr, 96, "%32c", ' ');
1709 // If the string is too large to fit on the screen,
1710 // then split it up in several pieces.
1712 while ( t_str.size() > 47 ) {
1714 unsigned int m = t_str.rfind(' ', 47);
1715 msg += t_str.substr(0, m);
1716 snprintf(cstr, 96, "\n%32c", ' ');
1719 t_str.erase(t_str.begin(), t_str.begin() + m + 1);
1721 msg += t_str + '\n';
1728 SGPropertyNode *name =
1729 locale->getNode(section[j]->getStringValue("name"));
1731 if (!msg.empty() && name) {
1732 cout << endl << name->getStringValue() << ":" << endl;
1740 cout << "For a complete list of options use --help --verbose" << endl;
1743 cout << "Hit a key to continue..." << endl;
1748 // A simple function to return an integer depending on the position
1749 // of the status string within the array in order to determine the hierarchy.
1750 unsigned int getNumMaturity(const char * str)
1752 // changes should also be reflected in $FG_ROOT/data/options.xml &
1753 // $FG_ROOT/data/Translations/string-default.xml
1754 const char levels[][20]= {"alpha","beta","early-production","production",0};
1756 for (unsigned int i=0; i<(sizeof(levels)/sizeof(levels[0])-1);i++)
1757 if (strcmp(str,levels[i])==0)
1764 static void fgSearchAircraft(const SGPath &path, string_list &aircraft,
1769 ulDir *dirp = ulOpenDir(path.str().c_str());
1771 cerr << "Unable to open aircraft directory '" << path.str() << '\'' << endl;
1775 while ((dire = ulReadDir(dirp)) != NULL) {
1778 if (dire->d_isdir) {
1779 if (recursive && strcmp("CVS", dire->d_name)
1780 && strcmp(".", dire->d_name) && strcmp("..", dire->d_name))
1783 next.append(dire->d_name);
1785 fgSearchAircraft(next, aircraft, true);
1787 } else if ((ptr = strstr(dire->d_name, "-set.xml")) && (ptr[8] == '\0')) {
1789 SGPath afile = path;
1790 afile.append(dire->d_name);
1794 SGPropertyNode root;
1796 readProperties(afile.str(), &root);
1801 SGPropertyNode *desc = NULL;
1802 SGPropertyNode *status = NULL;
1804 SGPropertyNode *node = root.getNode("sim");
1806 desc = node->getNode("description");
1807 // if a status tag is found, read it in
1808 if (node->hasValue("status"))
1809 status = node->getNode("status");
1813 //additionally display status information where it is available
1815 if (strlen(dire->d_name) <= 27) {
1816 snprintf(cstr, 96, " %-27s %s", dire->d_name,
1817 (desc) ? desc->getStringValue() : "");
1820 snprintf(cstr, 96, " %-27s\n%32c%s", dire->d_name, ' ',
1821 (desc) ? 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(cstr);
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(cstr); }
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;