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()
43 #include <simgear/math/sg_random.h>
44 #include <simgear/props/props_io.hxx>
45 #include <simgear/misc/sgstream.hxx>
46 #include <simgear/misc/sg_path.hxx>
47 #include <simgear/scene/material/mat.hxx>
48 #include <simgear/sound/soundmgr_openal.hxx>
50 // #include <Include/general.hxx>
51 // #include <Airports/simple.hxx>
52 // #include <Cockpit/cockpit.hxx>
53 // #include <FDM/flight.hxx>
55 #include <Autopilot/route_mgr.hxx>
58 #include "globals.hxx"
59 #include "fg_init.hxx"
60 #include "fg_props.hxx"
61 #include "options.hxx"
63 #include "viewmgr.hxx"
64 #include <Main/viewer.hxx>
73 #define VERSION "CVS "__DATE__
76 #define NEW_DEFAULT_MODEL_HZ 120
84 FG_OPTIONS_VERBOSE_HELP = 4,
85 FG_OPTIONS_SHOW_AIRCRAFT = 5,
86 FG_OPTIONS_SHOW_SOUND_DEVICES = 6
90 atof( const string& str )
92 return ::atof( str.c_str() );
96 atoi( const string& str )
98 return ::atoi( str.c_str() );
102 * Set a few fail-safe default property values.
104 * These should all be set in $FG_ROOT/preferences.xml, but just
105 * in case, we provide some initial sane values here. This method
106 * should be invoked *before* reading any init files.
111 // set a possibly independent location for scenery data
112 const char *envp = ::getenv( "FG_SCENERY" );
114 if ( envp != NULL ) {
115 // fg_root could be anywhere, so default to environmental
116 // variable $FG_ROOT if it is set.
117 globals->set_fg_scenery(envp);
119 // Otherwise, default to Scenery being in $FG_ROOT/Scenery
120 globals->set_fg_scenery("");
122 // Position (deliberately out of range)
123 fgSetDouble("/position/longitude-deg", 9999.0);
124 fgSetDouble("/position/latitude-deg", 9999.0);
125 fgSetDouble("/position/altitude-ft", -9999.0);
128 fgSetDouble("/orientation/heading-deg", 9999.0);
129 fgSetDouble("/orientation/roll-deg", 0.0);
130 fgSetDouble("/orientation/pitch-deg", 0.424);
133 fgSetDouble("/velocities/uBody-fps", 0.0);
134 fgSetDouble("/velocities/vBody-fps", 0.0);
135 fgSetDouble("/velocities/wBody-fps", 0.0);
136 fgSetDouble("/velocities/speed-north-fps", 0.0);
137 fgSetDouble("/velocities/speed-east-fps", 0.0);
138 fgSetDouble("/velocities/speed-down-fps", 0.0);
139 fgSetDouble("/velocities/airspeed-kt", 0.0);
140 fgSetDouble("/velocities/mach", 0.0);
143 fgSetDouble("/sim/presets/longitude-deg", 9999.0);
144 fgSetDouble("/sim/presets/latitude-deg", 9999.0);
145 fgSetDouble("/sim/presets/altitude-ft", -9999.0);
147 fgSetDouble("/sim/presets/heading-deg", 9999.0);
148 fgSetDouble("/sim/presets/roll-deg", 0.0);
149 fgSetDouble("/sim/presets/pitch-deg", 0.424);
151 fgSetString("/sim/presets/speed-set", "knots");
152 fgSetDouble("/sim/presets/airspeed-kt", 0.0);
153 fgSetDouble("/sim/presets/mach", 0.0);
154 fgSetDouble("/sim/presets/uBody-fps", 0.0);
155 fgSetDouble("/sim/presets/vBody-fps", 0.0);
156 fgSetDouble("/sim/presets/wBody-fps", 0.0);
157 fgSetDouble("/sim/presets/speed-north-fps", 0.0);
158 fgSetDouble("/sim/presets/speed-east-fps", 0.0);
159 fgSetDouble("/sim/presets/speed-down-fps", 0.0);
161 fgSetBool("/sim/presets/onground", true);
162 fgSetBool("/sim/presets/trim", false);
165 fgSetBool("/sim/startup/game-mode", false);
166 fgSetBool("/sim/startup/splash-screen", true);
167 fgSetBool("/sim/startup/intro-music", true);
168 // we want mouse-pointer to have an undefined value if nothing is
169 // specified so we can do the right thing for voodoo-1/2 cards.
170 // fgSetString("/sim/startup/mouse-pointer", "disabled");
171 fgSetString("/sim/control-mode", "joystick");
172 fgSetBool("/sim/auto-coordination", false);
174 fgSetString("/sim/startup/browser-app", "webrun.bat");
175 #elif defined(__APPLE__)
176 fgSetString("/sim/startup/browser-app", "open");
178 fgSetString("/sim/startup/browser-app", "launchWebJumper");
180 envp = ::getenv( "WEBBROWSER" );
181 if (!envp) envp = "netscape";
182 fgSetString("/sim/startup/browser-app", envp);
184 fgSetString("/sim/logging/priority", "alert");
187 fgSetBool("/sim/hud/color/antialiased", false);
188 fgSetBool("/sim/hud/enable3d", true);
189 fgSetBool("/sim/hud/visibility", false);
190 fgSetBool("/sim/panel/visibility", true);
191 fgSetBool("/sim/sound/enabled", true);
192 fgSetBool("/sim/sound/working", true);
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 fgTie( "/sim/rendering/filtering", SGGetTextureFilter, SGSetTextureFilter, false);
208 fgSetInt("/sim/rendering/filtering", 1);
209 fgSetBool("/sim/rendering/wireframe", false);
210 fgSetBool("/sim/rendering/horizon-effect", false);
211 fgSetBool("/sim/rendering/enhanced-lighting", false);
212 fgSetBool("/sim/rendering/distance-attenuation", false);
213 fgSetBool("/sim/rendering/specular-highlight", true);
214 fgSetInt("/sim/startup/xsize", 800);
215 fgSetInt("/sim/startup/ysize", 600);
216 fgSetInt("/sim/rendering/bits-per-pixel", 16);
217 fgSetString("/sim/view-mode", "pilot");
218 fgSetDouble("/sim/current-view/heading-offset-deg", 0);
221 fgSetString("/sim/startup/units", "feet");
222 fgSetString("/sim/hud/frame-stat-type", "tris");
225 fgSetInt("/sim/startup/time-offset", 0);
226 fgSetString("/sim/startup/time-offset-type", "system-offset");
227 fgSetLong("/sim/time/cur-time-override", 0);
230 fgSetBool("/sim/freeze/master", false);
231 fgSetBool("/sim/freeze/position", false);
232 fgSetBool("/sim/freeze/clock", false);
233 fgSetBool("/sim/freeze/fuel", false);
235 fgSetString("/sim/multiplay/callsign", "callsign");
236 fgSetString("/sim/multiplay/rxhost", "0");
237 fgSetString("/sim/multiplay/txhost", "0");
238 fgSetInt("/sim/multiplay/rxport", 0);
239 fgSetInt("/sim/multiplay/txport", 0);
243 parse_wind (const string &wind, double * min_hdg, double * max_hdg,
244 double * speed, double * gust)
246 string::size_type pos = wind.find('@');
247 if (pos == string::npos)
249 string dir = wind.substr(0, pos);
250 string spd = wind.substr(pos+1);
252 if (pos == string::npos) {
253 *min_hdg = *max_hdg = atof(dir.c_str());
255 *min_hdg = atof(dir.substr(0,pos).c_str());
256 *max_hdg = atof(dir.substr(pos+1).c_str());
259 if (pos == string::npos) {
260 *speed = *gust = atof(spd.c_str());
262 *speed = atof(spd.substr(0,pos).c_str());
263 *gust = atof(spd.substr(pos+1).c_str());
268 // parse a time string ([+/-]%f[:%f[:%f]]) into hours
270 parse_time(const string& time_in) {
271 char *time_str, num[256];
272 double hours, minutes, seconds;
277 time_str = (char *)time_in.c_str();
279 // printf("parse_time(): %s\n", time_str);
282 if ( strlen(time_str) ) {
283 if ( time_str[0] == '+' ) {
286 } else if ( time_str[0] == '-' ) {
291 // printf("sign = %d\n", sign);
294 if ( strlen(time_str) ) {
296 while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
297 num[i] = time_str[0];
301 if ( time_str[0] == ':' ) {
306 // printf("hours = %.2lf\n", hours);
312 if ( strlen(time_str) ) {
314 while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
315 num[i] = time_str[0];
319 if ( time_str[0] == ':' ) {
324 // printf("minutes = %.2lf\n", minutes);
326 result += minutes / 60.0;
330 if ( strlen(time_str) ) {
332 while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
333 num[i] = time_str[0];
339 // printf("seconds = %.2lf\n", seconds);
341 result += seconds / 3600.0;
344 SG_LOG( SG_GENERAL, SG_INFO, " parse_time() = " << sign * result );
346 return(sign * result);
350 // parse a date string (yyyy:mm:dd:hh:mm:ss) into a time_t (seconds)
352 parse_date( const string& date)
355 char * date_str, num[256];
357 // initialize to zero
364 gmt.tm_isdst = 0; // ignore daylight savings time for the moment
365 date_str = (char *)date.c_str();
367 if ( strlen(date_str) ) {
369 while ( (date_str[0] != ':') && (date_str[0] != '\0') ) {
370 num[i] = date_str[0];
374 if ( date_str[0] == ':' ) {
378 gmt.tm_year = atoi(num) - 1900;
381 if ( strlen(date_str) ) {
383 while ( (date_str[0] != ':') && (date_str[0] != '\0') ) {
384 num[i] = date_str[0];
388 if ( date_str[0] == ':' ) {
392 gmt.tm_mon = atoi(num) -1;
395 if ( strlen(date_str) ) {
397 while ( (date_str[0] != ':') && (date_str[0] != '\0') ) {
398 num[i] = date_str[0];
402 if ( date_str[0] == ':' ) {
406 gmt.tm_mday = atoi(num);
409 if ( strlen(date_str) ) {
411 while ( (date_str[0] != ':') && (date_str[0] != '\0') ) {
412 num[i] = date_str[0];
416 if ( date_str[0] == ':' ) {
420 gmt.tm_hour = atoi(num);
423 if ( strlen(date_str) ) {
425 while ( (date_str[0] != ':') && (date_str[0] != '\0') ) {
426 num[i] = date_str[0];
430 if ( date_str[0] == ':' ) {
434 gmt.tm_min = atoi(num);
437 if ( strlen(date_str) ) {
439 while ( (date_str[0] != ':') && (date_str[0] != '\0') ) {
440 num[i] = date_str[0];
444 if ( date_str[0] == ':' ) {
448 gmt.tm_sec = atoi(num);
450 time_t theTime = sgTimeGetGMT( gmt.tm_year, gmt.tm_mon, gmt.tm_mday,
451 gmt.tm_hour, gmt.tm_min, gmt.tm_sec );
452 //printf ("Date is %s\n", ctime(&theTime));
453 //printf ("in seconds that is %d\n", theTime);
459 // parse angle in the form of [+/-]ddd:mm:ss into degrees
461 parse_degree( const string& degree_str) {
462 double result = parse_time( degree_str );
464 // printf("Degree = %.4f\n", result);
470 // parse time offset string into seconds
472 parse_time_offset( const string& time_str) {
475 // printf("time offset = %s\n", time_str);
478 result = (int)rint(parse_time(time_str) * 3600.0);
480 result = (int)(parse_time(time_str) * 3600.0);
483 // printf("parse_time_offset(): %d\n", result);
489 // Parse --fov=x.xx type option
491 parse_fov( const string& arg ) {
492 double fov = atof(arg);
494 if ( fov < FG_FOV_MIN ) { fov = FG_FOV_MIN; }
495 if ( fov > FG_FOV_MAX ) { fov = FG_FOV_MAX; }
497 fgSetDouble("/sim/view[0]/config/default-field-of-view-deg", fov);
499 // printf("parse_fov(): result = %.4f\n", fov);
505 // Parse I/O channel option
507 // Format is "--protocol=medium,direction,hz,medium_options,..."
509 // protocol = { native, nmea, garmin, AV400, AV400Sim, fgfs, rul, pve, etc. }
510 // medium = { serial, socket, file, etc. }
511 // direction = { in, out, bi }
512 // hz = number of times to process channel per second (floating
513 // point values are ok.
515 // Serial example "--nmea=serial,dir,hz,device,baud" where
517 // device = OS device name of serial line to be open()'ed
518 // baud = {300, 1200, 2400, ..., 230400}
520 // Socket exacmple "--native=socket,dir,hz,machine,port,style" where
522 // machine = machine name or ip address if client (leave empty if server)
523 // port = port, leave empty to let system choose
524 // style = tcp or udp
526 // File example "--garmin=file,dir,hz,filename" where
528 // filename = file system file name
531 add_channel( const string& type, const string& channel_str ) {
532 SG_LOG(SG_GENERAL, SG_INFO, "Channel string = " << channel_str );
533 globals->get_channel_options_list()->push_back( type + "," + channel_str );
538 // The parse wp and parse flight-plan options don't work anymore, because
539 // the route manager and the airport subsystems have not yet been initialized
542 // Parse --wp=ID[@alt]
544 parse_wp( const string& arg ) {
545 string_list *waypoints = globals->get_initial_waypoints();
547 waypoints = new string_list;
548 globals->set_initial_waypoints(waypoints);
550 waypoints->push_back(arg);
554 // Parse --flight-plan=[file]
556 parse_flightplan(const string& arg)
558 string_list *waypoints = globals->get_initial_waypoints();
560 waypoints = new string_list;
561 globals->set_initial_waypoints(waypoints);
564 sg_gzifstream in(arg.c_str());
570 getline( in, line, '\n' );
572 // catch extraneous (DOS) line ending character
573 if ( line[line.length() - 1] < 32 )
574 line = line.substr( 0, line.length()-1 );
579 waypoints->push_back(line);
586 fgOptLanguage( const char *arg )
588 globals->set_locale( fgInitLocale( arg ) );
589 return FG_OPTIONS_OK;
595 fgSetString("/sim/presets/airport-id", "");
596 fgSetString("/sim/presets/vor-id", "");
597 fgSetString("/sim/presets/ndb-id", "");
598 fgSetString("/sim/presets/carrier", "");
599 fgSetString("/sim/presets/parkpos", "");
600 fgSetString("/sim/presets/fix", "");
604 fgOptVOR( const char * arg )
607 fgSetString("/sim/presets/vor-id", arg);
608 return FG_OPTIONS_OK;
612 fgOptNDB( const char * arg )
615 fgSetString("/sim/presets/ndb-id", arg);
616 return FG_OPTIONS_OK;
620 fgOptCarrier( const char * arg )
623 fgSetString("/sim/presets/carrier", arg);
624 return FG_OPTIONS_OK;
628 fgOptParkpos( const char * arg )
630 fgSetString("/sim/presets/parkpos", arg);
631 return FG_OPTIONS_OK;
635 fgOptFIX( const char * arg )
638 fgSetString("/sim/presets/fix", arg);
639 return FG_OPTIONS_OK;
643 fgOptLon( const char *arg )
646 fgSetDouble("/sim/presets/longitude-deg", parse_degree( arg ));
647 fgSetDouble("/position/longitude-deg", parse_degree( arg ));
648 return FG_OPTIONS_OK;
652 fgOptLat( const char *arg )
655 fgSetDouble("/sim/presets/latitude-deg", parse_degree( arg ));
656 fgSetDouble("/position/latitude-deg", parse_degree( arg ));
657 return FG_OPTIONS_OK;
661 fgOptAltitude( const char *arg )
663 fgSetBool("/sim/presets/onground", false);
664 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
665 fgSetDouble("/sim/presets/altitude-ft", atof( arg ));
667 fgSetDouble("/sim/presets/altitude-ft",
668 atof( arg ) * SG_METER_TO_FEET);
669 return FG_OPTIONS_OK;
673 fgOptUBody( const char *arg )
675 fgSetString("/sim/presets/speed-set", "UVW");
676 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
677 fgSetDouble("/sim/presets/uBody-fps", atof( arg ));
679 fgSetDouble("/sim/presets/uBody-fps",
680 atof( arg ) * SG_METER_TO_FEET);
681 return FG_OPTIONS_OK;
685 fgOptVBody( const char *arg )
687 fgSetString("/sim/presets/speed-set", "UVW");
688 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
689 fgSetDouble("/sim/presets/vBody-fps", atof( arg ));
691 fgSetDouble("/sim/presets/vBody-fps",
692 atof( arg ) * SG_METER_TO_FEET);
693 return FG_OPTIONS_OK;
697 fgOptWBody( const char *arg )
699 fgSetString("/sim/presets/speed-set", "UVW");
700 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
701 fgSetDouble("/sim/presets/wBody-fps", atof(arg));
703 fgSetDouble("/sim/presets/wBody-fps",
704 atof(arg) * SG_METER_TO_FEET);
705 return FG_OPTIONS_OK;
709 fgOptVNorth( const char *arg )
711 fgSetString("/sim/presets/speed-set", "NED");
712 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
713 fgSetDouble("/sim/presets/speed-north-fps", atof( arg ));
715 fgSetDouble("/sim/presets/speed-north-fps",
716 atof( arg ) * SG_METER_TO_FEET);
717 return FG_OPTIONS_OK;
721 fgOptVEast( const char *arg )
723 fgSetString("/sim/presets/speed-set", "NED");
724 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
725 fgSetDouble("/sim/presets/speed-east-fps", atof(arg));
727 fgSetDouble("/sim/presets/speed-east-fps",
728 atof(arg) * SG_METER_TO_FEET);
729 return FG_OPTIONS_OK;
733 fgOptVDown( const char *arg )
735 fgSetString("/sim/presets/speed-set", "NED");
736 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
737 fgSetDouble("/sim/presets/speed-down-fps", atof(arg));
739 fgSetDouble("/sim/presets/speed-down-fps",
740 atof(arg) * SG_METER_TO_FEET);
741 return FG_OPTIONS_OK;
745 fgOptVc( const char *arg )
747 // fgSetString("/sim/presets/speed-set", "knots");
748 // fgSetDouble("/velocities/airspeed-kt", atof(arg.substr(5)));
749 fgSetString("/sim/presets/speed-set", "knots");
750 fgSetDouble("/sim/presets/airspeed-kt", atof(arg));
751 return FG_OPTIONS_OK;
755 fgOptMach( const char *arg )
757 fgSetString("/sim/presets/speed-set", "mach");
758 fgSetDouble("/sim/presets/mach", atof(arg));
759 return FG_OPTIONS_OK;
763 fgOptRoc( const char *arg )
765 fgSetDouble("/velocities/vertical-speed-fps", atof(arg)/60);
766 return FG_OPTIONS_OK;
770 fgOptFgRoot( const char *arg )
772 globals->set_fg_root(arg);
773 return FG_OPTIONS_OK;
777 fgOptFgScenery( const char *arg )
779 globals->set_fg_scenery(arg);
780 return FG_OPTIONS_OK;
784 fgOptFov( const char *arg )
787 return FG_OPTIONS_OK;
791 fgOptGeometry( const char *arg )
793 bool geometry_ok = true;
794 int xsize = 0, ysize = 0;
795 string geometry = arg;
796 string::size_type i = geometry.find('x');
798 if (i != string::npos) {
799 xsize = atoi(geometry.substr(0, i));
800 ysize = atoi(geometry.substr(i+1));
805 if ( xsize <= 0 || ysize <= 0 ) {
811 if ( !geometry_ok ) {
812 SG_LOG( SG_GENERAL, SG_ALERT, "Unknown geometry: " << geometry );
813 SG_LOG( SG_GENERAL, SG_ALERT,
814 "Setting geometry to " << xsize << 'x' << ysize << '\n');
816 SG_LOG( SG_GENERAL, SG_INFO,
817 "Setting geometry to " << xsize << 'x' << ysize << '\n');
818 fgSetInt("/sim/startup/xsize", xsize);
819 fgSetInt("/sim/startup/ysize", ysize);
821 return FG_OPTIONS_OK;
825 fgOptBpp( const char *arg )
827 string bits_per_pix = arg;
828 if ( bits_per_pix == "16" ) {
829 fgSetInt("/sim/rendering/bits-per-pixel", 16);
830 } else if ( bits_per_pix == "24" ) {
831 fgSetInt("/sim/rendering/bits-per-pixel", 24);
832 } else if ( bits_per_pix == "32" ) {
833 fgSetInt("/sim/rendering/bits-per-pixel", 32);
835 SG_LOG(SG_GENERAL, SG_ALERT, "Unsupported bpp " << bits_per_pix);
837 return FG_OPTIONS_OK;
841 fgOptTimeOffset( const char *arg )
843 fgSetInt("/sim/startup/time-offset",
844 parse_time_offset( arg ));
845 fgSetString("/sim/startup/time-offset-type", "system-offset");
846 return FG_OPTIONS_OK;
850 fgOptStartDateSys( const char *arg )
852 fgSetInt("/sim/startup/time-offset", parse_date( arg ) );
853 fgSetString("/sim/startup/time-offset-type", "system");
854 return FG_OPTIONS_OK;
858 fgOptStartDateLat( const char *arg )
860 fgSetInt("/sim/startup/time-offset", parse_date( arg ) );
861 fgSetString("/sim/startup/time-offset-type", "latitude");
862 return FG_OPTIONS_OK;
866 fgOptStartDateGmt( const char *arg )
868 fgSetInt("/sim/startup/time-offset", parse_date( arg ) );
869 fgSetString("/sim/startup/time-offset-type", "gmt");
870 return FG_OPTIONS_OK;
874 fgSetupProxy( const char *arg )
876 string options = arg;
877 string host, port, auth;
878 string::size_type pos;
880 host = port = auth = "";
881 if ((pos = options.find("@")) != string::npos)
882 auth = options.substr(0, pos++);
886 host = options.substr(pos, options.size());
887 if ((pos = host.find(":")) != string::npos) {
888 port = host.substr(++pos, host.size());
889 host.erase(--pos, host.size());
892 fgSetString("/sim/presets/proxy/host", host.c_str());
893 fgSetString("/sim/presets/proxy/port", port.c_str());
894 fgSetString("/sim/presets/proxy/authentication", auth.c_str());
896 return FG_OPTIONS_OK;
900 fgOptTraceRead( const char *arg )
903 SG_LOG(SG_GENERAL, SG_INFO, "Tracing reads for property " << name);
904 fgGetNode(name.c_str(), true)
905 ->setAttribute(SGPropertyNode::TRACE_READ, true);
906 return FG_OPTIONS_OK;
910 fgOptLogLevel( const char *arg )
912 fgSetString("/sim/logging/classes", "all");
913 fgSetString("/sim/logging/priority", arg);
915 string priority = arg;
916 logbuf::set_log_classes(SG_ALL);
917 if (priority == "bulk") {
918 logbuf::set_log_priority(SG_BULK);
919 } else if (priority == "debug") {
920 logbuf::set_log_priority(SG_DEBUG);
921 } else if (priority == "info") {
922 logbuf::set_log_priority(SG_INFO);
923 } else if (priority == "warn") {
924 logbuf::set_log_priority(SG_WARN);
925 } else if (priority == "alert") {
926 logbuf::set_log_priority(SG_ALERT);
928 SG_LOG(SG_GENERAL, SG_WARN, "Unknown logging priority " << priority);
930 SG_LOG(SG_GENERAL, SG_DEBUG, "Logging priority is " << priority);
932 return FG_OPTIONS_OK;
937 fgOptTraceWrite( const char *arg )
940 SG_LOG(SG_GENERAL, SG_INFO, "Tracing writes for property " << name);
941 fgGetNode(name.c_str(), true)
942 ->setAttribute(SGPropertyNode::TRACE_WRITE, true);
943 return FG_OPTIONS_OK;
947 fgOptViewOffset( const char *arg )
949 // $$$ begin - added VS Renganathan, 14 Oct 2K
950 // for multi-window outside window imagery
951 string woffset = arg;
952 double default_view_offset = 0.0;
953 if ( woffset == "LEFT" ) {
954 default_view_offset = SGD_PI * 0.25;
955 } else if ( woffset == "RIGHT" ) {
956 default_view_offset = SGD_PI * 1.75;
957 } else if ( woffset == "CENTER" ) {
958 default_view_offset = 0.00;
960 default_view_offset = atof( woffset.c_str() ) * SGD_DEGREES_TO_RADIANS;
962 /* apparently not used (CLO, 11 Jun 2002)
963 FGViewer *pilot_view =
964 (FGViewer *)globals->get_viewmgr()->get_view( 0 ); */
965 // this will work without calls to the viewer...
966 fgSetDouble( "/sim/current-view/heading-offset-deg",
967 default_view_offset * SGD_RADIANS_TO_DEGREES );
968 // $$$ end - added VS Renganathan, 14 Oct 2K
969 return FG_OPTIONS_OK;
973 fgOptVisibilityMeters( const char *arg )
975 double visibility = atof( arg );
976 fgDefaultWeatherValue("visibility-m", visibility);
977 return FG_OPTIONS_OK;
981 fgOptVisibilityMiles( const char *arg )
983 double visibility = atof( arg ) * 5280.0 * SG_FEET_TO_METER;
984 fgDefaultWeatherValue("visibility-m", visibility);
985 return FG_OPTIONS_OK;
989 fgOptRandomWind( const char *arg )
991 double min_hdg = sg_random() * 360.0;
992 double max_hdg = min_hdg + (20 - sqrt(sg_random() * 400));
993 double speed = sg_random() * sg_random() * 40;
994 double gust = speed + (10 - sqrt(sg_random() * 100));
995 fgSetupWind(min_hdg, max_hdg, speed, gust);
996 return FG_OPTIONS_OK;
1000 fgOptWind( const char *arg )
1002 double min_hdg = 0.0, max_hdg = 0.0, speed = 0.0, gust = 0.0;
1003 if (!parse_wind( arg, &min_hdg, &max_hdg, &speed, &gust)) {
1004 SG_LOG( SG_GENERAL, SG_ALERT, "bad wind value " << arg );
1005 return FG_OPTIONS_ERROR;
1007 fgSetupWind(min_hdg, max_hdg, speed, gust);
1008 return FG_OPTIONS_OK;
1012 fgOptTurbulence( const char *arg )
1014 fgDefaultWeatherValue("turbulence/magnitude-norm", atof(arg));
1015 return FG_OPTIONS_OK;
1019 fgOptCeiling( const char *arg )
1021 double elevation, thickness;
1023 string::size_type pos = spec.find(':');
1024 if (pos == string::npos) {
1025 elevation = atof(spec.c_str());
1028 elevation = atof(spec.substr(0, pos).c_str());
1029 thickness = atof(spec.substr(pos + 1).c_str());
1031 fgSetDouble("/environment/clouds/layer[0]/elevation-ft", elevation);
1032 fgSetDouble("/environment/clouds/layer[0]/thickness-ft", thickness);
1033 fgSetString("/environment/clouds/layer[0]/coverage", "overcast");
1034 return FG_OPTIONS_OK;
1038 fgOptWp( const char *arg )
1041 return FG_OPTIONS_OK;
1045 fgOptFlightPlan( const char *arg )
1047 parse_flightplan ( arg );
1048 return FG_OPTIONS_OK;
1052 fgOptConfig( const char *arg )
1056 readProperties(file, globals->get_props());
1057 } catch (const sg_exception &e) {
1058 string message = "Error loading config file: ";
1059 message += e.getFormattedMessage() + e.getOrigin();
1060 SG_LOG(SG_INPUT, SG_ALERT, message);
1063 return FG_OPTIONS_OK;
1067 parse_colon (const string &s, double * val1, double * val2)
1069 string::size_type pos = s.find(':');
1070 if (pos == string::npos) {
1074 *val1 = atof(s.substr(0, pos).c_str());
1075 *val2 = atof(s.substr(pos+1).c_str());
1082 fgOptFailure( const char * arg )
1086 fgSetBool("/systems/pitot/serviceable", false);
1087 } else if (a == "static") {
1088 fgSetBool("/systems/static/serviceable", false);
1089 } else if (a == "vacuum") {
1090 fgSetBool("/systems/vacuum/serviceable", false);
1091 } else if (a == "electrical") {
1092 fgSetBool("/systems/electrical/serviceable", false);
1094 SG_LOG(SG_INPUT, SG_ALERT, "Unknown failure mode: " << a);
1095 return FG_OPTIONS_ERROR;
1098 return FG_OPTIONS_OK;
1103 fgOptNAV1( const char * arg )
1105 double radial, freq;
1106 if (parse_colon(arg, &radial, &freq))
1107 fgSetDouble("/instrumentation/nav[0]/radials/selected-deg", radial);
1108 fgSetDouble("/instrumentation/nav[0]/frequencies/selected-mhz", freq);
1109 return FG_OPTIONS_OK;
1113 fgOptNAV2( const char * arg )
1115 double radial, freq;
1116 if (parse_colon(arg, &radial, &freq))
1117 fgSetDouble("/instrumentation/nav[1]/radials/selected-deg", radial);
1118 fgSetDouble("/instrumentation/nav[1]/frequencies/selected-mhz", freq);
1119 return FG_OPTIONS_OK;
1123 fgOptADF( const char * arg )
1126 if (parse_colon(arg, &rot, &freq))
1127 fgSetDouble("/instrumentation/adf/rotation-deg", rot);
1128 fgSetDouble("/instrumentation/adf/frequencies/selected-khz", freq);
1129 return FG_OPTIONS_OK;
1133 fgOptDME( const char *arg )
1136 if (opt == "nav1") {
1137 fgSetInt("/instrumentation/dme/switch-position", 1);
1138 fgSetString("/instrumentation/dme/frequencies/source",
1139 "/instrumentation/nav[0]/frequencies/selected-mhz");
1140 } else if (opt == "nav2") {
1141 fgSetInt("/instrumentation/dme/switch-position", 3);
1142 fgSetString("/instrumentation/dme/frequencies/source",
1143 "/instrumentation/nav[1]/frequencies/selected-mhz");
1145 fgSetInt("/instrumentation/dme/switch-position", 2);
1146 fgSetString("/instrumentation/dme/frequencies/source",
1147 "/instrumentation/dme/frequencies/selected-mhz");
1148 fgSetString("/instrumentation/dme/frequencies/selected-mhz", arg);
1150 return FG_OPTIONS_OK;
1154 fgOptLivery( const char *arg )
1157 string livery_path = "livery/" + opt;
1158 fgSetString("/sim/model/texture-path", livery_path.c_str() );
1159 return FG_OPTIONS_OK;
1163 fgOptScenario( const char *arg )
1165 SGPropertyNode_ptr ai_node = fgGetNode( "/sim/ai", true );
1166 vector<SGPropertyNode_ptr> scenarii = ai_node->getChildren( "scenario" );
1168 for ( size_t i = 0; i < scenarii.size(); ++i ) {
1169 int ind = scenarii[i]->getIndex();
1170 if ( index < ind ) {
1174 SGPropertyNode_ptr scenario = ai_node->getNode( "scenario", index + 1, true );
1175 scenario->setStringValue( arg );
1176 ai_node->setBoolValue( "enabled", true );
1177 return FG_OPTIONS_OK;
1181 fgOptRunway( const char *arg )
1183 fgSetString("/sim/presets/runway", arg );
1184 fgSetBool("/sim/presets/runway-requested", true );
1185 return FG_OPTIONS_OK;
1189 fgOptParking( const char *arg )
1191 cerr << "Processing argument " << arg << endl;
1192 fgSetString("/sim/presets/parking", arg );
1193 fgSetBool ("/sim/presets/parking-requested", true );
1194 return FG_OPTIONS_OK;
1198 fgOptVersion( const char *arg )
1200 cerr << VERSION << endl;
1201 cerr << "FG_ROOT=" << globals->get_fg_root() << endl;
1202 cerr << "FG_HOME=" << fgGetString("/sim/fg-home") << endl;
1203 return FG_OPTIONS_EXIT;
1207 fgOptFpe(const char* arg)
1209 // Actually handled in bootstrap.cxx
1210 return FG_OPTIONS_OK;
1214 fgOptFgviewer(const char* arg)
1216 // Actually handled in bootstrap.cxx
1217 return FG_OPTIONS_OK;
1222 static map<string,size_t> fgOptionMap;
1225 option has_param type property b_param s_param func
1228 option : name of the option
1229 has_param : option is --name=value if true or --name if false
1230 type : OPTION_BOOL - property is a boolean
1231 OPTION_STRING - property is a string
1232 OPTION_DOUBLE - property is a double
1233 OPTION_INT - property is an integer
1234 OPTION_CHANNEL - name of option is the name of a channel
1235 OPTION_FUNC - the option trigger a function
1236 b_param : if type==OPTION_BOOL,
1237 value set to the property (has_param is false for boolean)
1238 s_param : if type==OPTION_STRING,
1239 value set to the property if has_param is false
1240 func : function called if type==OPTION_FUNC. if has_param is true,
1241 the value is passed to the function as a string, otherwise,
1244 For OPTION_DOUBLE and OPTION_INT, the parameter value is converted into a
1245 double or an integer and set to the property.
1247 For OPTION_CHANNEL, add_channel is called with the parameter value as the
1251 enum OptionType { OPTION_BOOL, OPTION_STRING, OPTION_DOUBLE, OPTION_INT, OPTION_CHANNEL, OPTION_FUNC };
1255 enum OptionType type;
1256 const char *property;
1258 const char *s_param;
1259 int (*func)( const char * );
1260 } fgOptionArray[] = {
1262 {"language", true, OPTION_FUNC, "", false, "", fgOptLanguage },
1263 {"disable-game-mode", false, OPTION_BOOL, "/sim/startup/game-mode", false, "", 0 },
1264 {"enable-game-mode", false, OPTION_BOOL, "/sim/startup/game-mode", true, "", 0 },
1265 {"disable-splash-screen", false, OPTION_BOOL, "/sim/startup/splash-screen", false, "", 0 },
1266 {"enable-splash-screen", false, OPTION_BOOL, "/sim/startup/splash-screen", true, "", 0 },
1267 {"disable-intro-music", false, OPTION_BOOL, "/sim/startup/intro-music", false, "", 0 },
1268 {"enable-intro-music", false, OPTION_BOOL, "/sim/startup/intro-music", true, "", 0 },
1269 {"disable-mouse-pointer", false, OPTION_STRING, "/sim/startup/mouse-pointer", false, "disabled", 0 },
1270 {"enable-mouse-pointer", false, OPTION_STRING, "/sim/startup/mouse-pointer", false, "enabled", 0 },
1271 {"disable-random-objects", false, OPTION_BOOL, "/sim/rendering/random-objects", false, "", 0 },
1272 {"enable-random-objects", false, OPTION_BOOL, "/sim/rendering/random-objects", true, "", 0 },
1273 {"disable-real-weather-fetch", false, OPTION_BOOL, "/environment/params/real-world-weather-fetch", false, "", 0 },
1274 {"enable-real-weather-fetch", false, OPTION_BOOL, "/environment/params/real-world-weather-fetch", true, "", 0 },
1275 {"metar", true, OPTION_STRING, "/environment/metar/data", false, "", 0 },
1276 {"disable-ai-models", false, OPTION_BOOL, "/sim/ai/enabled", false, "", 0 },
1277 {"enable-ai-models", false, OPTION_BOOL, "/sim/ai/enabled", true, "", 0 },
1278 {"disable-freeze", false, OPTION_BOOL, "/sim/freeze/master", false, "", 0 },
1279 {"enable-freeze", false, OPTION_BOOL, "/sim/freeze/master", true, "", 0 },
1280 {"disable-fuel-freeze", false, OPTION_BOOL, "/sim/freeze/fuel", false, "", 0 },
1281 {"enable-fuel-freeze", false, OPTION_BOOL, "/sim/freeze/fuel", true, "", 0 },
1282 {"disable-clock-freeze", false, OPTION_BOOL, "/sim/freeze/clock", false, "", 0 },
1283 {"enable-clock-freeze", false, OPTION_BOOL, "/sim/freeze/clock", true, "", 0 },
1284 {"disable-hud-3d", false, OPTION_BOOL, "/sim/hud/enable3d", false, "", 0 },
1285 {"enable-hud-3d", false, OPTION_BOOL, "/sim/hud/enable3d", true, "", 0 },
1286 {"disable-anti-alias-hud", false, OPTION_BOOL, "/sim/hud/color/antialiased", false, "", 0 },
1287 {"enable-anti-alias-hud", false, OPTION_BOOL, "/sim/hud/color/antialiased", true, "", 0 },
1288 {"control", true, OPTION_STRING, "/sim/control-mode", false, "", 0 },
1289 {"disable-auto-coordination", false, OPTION_BOOL, "/sim/auto-coordination", false, "", 0 },
1290 {"enable-auto-coordination", false, OPTION_BOOL, "/sim/auto-coordination", true, "", 0 },
1291 {"browser-app", true, OPTION_STRING, "/sim/startup/browser-app", false, "", 0 },
1292 {"disable-hud", false, OPTION_BOOL, "/sim/hud/visibility", false, "", 0 },
1293 {"enable-hud", false, OPTION_BOOL, "/sim/hud/visibility", true, "", 0 },
1294 {"disable-panel", false, OPTION_BOOL, "/sim/panel/visibility", false, "", 0 },
1295 {"enable-panel", false, OPTION_BOOL, "/sim/panel/visibility", true, "", 0 },
1296 {"disable-sound", false, OPTION_BOOL, "/sim/sound/working", false, "", 0 },
1297 {"enable-sound", false, OPTION_BOOL, "/sim/sound/working", true, "", 0 },
1298 {"sound-device", true, OPTION_STRING, "/sim/sound/device-name", false, "", 0 },
1299 {"airport", true, OPTION_STRING, "/sim/presets/airport-id", false, "", 0 },
1300 {"runway", true, OPTION_FUNC, "", false, "", fgOptRunway },
1301 {"vor", true, OPTION_FUNC, "", false, "", fgOptVOR },
1302 {"ndb", true, OPTION_FUNC, "", false, "", fgOptNDB },
1303 {"carrier", true, OPTION_FUNC, "", false, "", fgOptCarrier },
1304 {"parkpos", true, OPTION_FUNC, "", false, "", fgOptParkpos },
1305 {"fix", true, OPTION_FUNC, "", false, "", fgOptFIX },
1306 {"offset-distance", true, OPTION_DOUBLE, "/sim/presets/offset-distance-nm", false, "", 0 },
1307 {"offset-azimuth", true, OPTION_DOUBLE, "/sim/presets/offset-azimuth-deg", false, "", 0 },
1308 {"lon", true, OPTION_FUNC, "", false, "", fgOptLon },
1309 {"lat", true, OPTION_FUNC, "", false, "", fgOptLat },
1310 {"altitude", true, OPTION_FUNC, "", false, "", fgOptAltitude },
1311 {"uBody", true, OPTION_FUNC, "", false, "", fgOptUBody },
1312 {"vBody", true, OPTION_FUNC, "", false, "", fgOptVBody },
1313 {"wBody", true, OPTION_FUNC, "", false, "", fgOptWBody },
1314 {"vNorth", true, OPTION_FUNC, "", false, "", fgOptVNorth },
1315 {"vEast", true, OPTION_FUNC, "", false, "", fgOptVEast },
1316 {"vDown", true, OPTION_FUNC, "", false, "", fgOptVDown },
1317 {"vc", true, OPTION_FUNC, "", false, "", fgOptVc },
1318 {"mach", true, OPTION_FUNC, "", false, "", fgOptMach },
1319 {"heading", true, OPTION_DOUBLE, "/sim/presets/heading-deg", false, "", 0 },
1320 {"roll", true, OPTION_DOUBLE, "/sim/presets/roll-deg", false, "", 0 },
1321 {"pitch", true, OPTION_DOUBLE, "/sim/presets/pitch-deg", false, "", 0 },
1322 {"glideslope", true, OPTION_DOUBLE, "/sim/presets/glideslope-deg", false, "", 0 },
1323 {"roc", true, OPTION_FUNC, "", false, "", fgOptRoc },
1324 {"fg-root", true, OPTION_FUNC, "", false, "", fgOptFgRoot },
1325 {"fg-scenery", true, OPTION_FUNC, "", false, "", fgOptFgScenery },
1326 {"fdm", true, OPTION_STRING, "/sim/flight-model", false, "", 0 },
1327 {"aero", true, OPTION_STRING, "/sim/aero", false, "", 0 },
1328 {"aircraft-dir", true, OPTION_STRING, "/sim/aircraft-dir", false, "", 0 },
1329 {"model-hz", true, OPTION_INT, "/sim/model-hz", false, "", 0 },
1330 {"speed", true, OPTION_INT, "/sim/speed-up", false, "", 0 },
1331 {"trim", false, OPTION_BOOL, "/sim/presets/trim", true, "", 0 },
1332 {"notrim", false, OPTION_BOOL, "/sim/presets/trim", false, "", 0 },
1333 {"on-ground", false, OPTION_BOOL, "/sim/presets/onground", true, "", 0 },
1334 {"in-air", false, OPTION_BOOL, "/sim/presets/onground", false, "", 0 },
1335 {"fog-disable", false, OPTION_STRING, "/sim/rendering/fog", false, "disabled", 0 },
1336 {"fog-fastest", false, OPTION_STRING, "/sim/rendering/fog", false, "fastest", 0 },
1337 {"fog-nicest", false, OPTION_STRING, "/sim/rendering/fog", false, "nicest", 0 },
1338 {"disable-horizon-effect", false, OPTION_BOOL, "/sim/rendering/horizon-effect", false, "", 0 },
1339 {"enable-horizon-effect", false, OPTION_BOOL, "/sim/rendering/horizon-effect", true, "", 0 },
1340 {"disable-enhanced-lighting", false, OPTION_BOOL, "/sim/rendering/enhanced-lighting", false, "", 0 },
1341 {"enable-enhanced-lighting", false, OPTION_BOOL, "/sim/rendering/enhanced-lighting", true, "", 0 },
1342 {"disable-distance-attenuation", false, OPTION_BOOL, "/sim/rendering/distance-attenuation", false, "", 0 },
1343 {"enable-distance-attenuation", false, OPTION_BOOL, "/sim/rendering/distance-attenuation", true, "", 0 },
1344 {"disable-specular-highlight", false, OPTION_BOOL, "/sim/rendering/specular-highlight", false, "", 0 },
1345 {"enable-specular-highlight", false, OPTION_BOOL, "/sim/rendering/specular-highlight", true, "", 0 },
1346 {"disable-clouds", false, OPTION_BOOL, "/environment/clouds/status", false, "", 0 },
1347 {"enable-clouds", false, OPTION_BOOL, "/environment/clouds/status", true, "", 0 },
1348 {"disable-clouds3d", false, OPTION_BOOL, "/sim/rendering/clouds3d-enable", false, "", 0 },
1349 {"enable-clouds3d", false, OPTION_BOOL, "/sim/rendering/clouds3d-enable", true, "", 0 },
1350 {"fov", true, OPTION_FUNC, "", false, "", fgOptFov },
1351 {"aspect-ratio-multiplier", true, OPTION_DOUBLE, "/sim/current-view/aspect-ratio-multiplier", false, "", 0 },
1352 {"disable-fullscreen", false, OPTION_BOOL, "/sim/startup/fullscreen", false, "", 0 },
1353 {"enable-fullscreen", false, OPTION_BOOL, "/sim/startup/fullscreen", true, "", 0 },
1354 {"disable-save-on-exit", false, OPTION_BOOL, "/sim/startup/save-on-exit", false, "", 0 },
1355 {"enable-save-on-exit", false, OPTION_BOOL, "/sim/startup/save-on-exit", true, "", 0 },
1356 {"shading-flat", false, OPTION_BOOL, "/sim/rendering/shading", false, "", 0 },
1357 {"shading-smooth", false, OPTION_BOOL, "/sim/rendering/shading", true, "", 0 },
1358 {"disable-skyblend", false, OPTION_BOOL, "/sim/rendering/skyblend", false, "", 0 },
1359 {"enable-skyblend", false, OPTION_BOOL, "/sim/rendering/skyblend", true, "", 0 },
1360 {"disable-textures", false, OPTION_BOOL, "/sim/rendering/textures", false, "", 0 },
1361 {"enable-textures", false, OPTION_BOOL, "/sim/rendering/textures", true, "", 0 },
1362 {"texture-filtering", false, OPTION_INT, "/sim/rendering/filtering", 1, "", 0 },
1363 {"disable-wireframe", false, OPTION_BOOL, "/sim/rendering/wireframe", false, "", 0 },
1364 {"enable-wireframe", false, OPTION_BOOL, "/sim/rendering/wireframe", true, "", 0 },
1365 {"geometry", true, OPTION_FUNC, "", false, "", fgOptGeometry },
1366 {"bpp", true, OPTION_FUNC, "", false, "", fgOptBpp },
1367 {"units-feet", false, OPTION_STRING, "/sim/startup/units", false, "feet", 0 },
1368 {"units-meters", false, OPTION_STRING, "/sim/startup/units", false, "meters", 0 },
1369 {"timeofday", true, OPTION_STRING, "/sim/startup/time-offset-type", false, "noon", 0 },
1370 {"season", true, OPTION_STRING, "/sim/startup/season", false, "summer", 0 },
1371 {"time-offset", true, OPTION_FUNC, "", false, "", fgOptTimeOffset },
1372 {"time-match-real", false, OPTION_STRING, "/sim/startup/time-offset-type", false, "system-offset", 0 },
1373 {"time-match-local", false, OPTION_STRING, "/sim/startup/time-offset-type", false, "latitude-offset", 0 },
1374 {"start-date-sys", true, OPTION_FUNC, "", false, "", fgOptStartDateSys },
1375 {"start-date-lat", true, OPTION_FUNC, "", false, "", fgOptStartDateLat },
1376 {"start-date-gmt", true, OPTION_FUNC, "", false, "", fgOptStartDateGmt },
1377 {"hud-tris", false, OPTION_STRING, "/sim/hud/frame-stat-type", false, "tris", 0 },
1378 {"hud-culled", false, OPTION_STRING, "/sim/hud/frame-stat-type", false, "culled", 0 },
1379 {"atcsim", true, OPTION_CHANNEL, "", false, "dummy", 0 },
1380 {"atlas", true, OPTION_CHANNEL, "", false, "", 0 },
1381 {"httpd", true, OPTION_CHANNEL, "", false, "", 0 },
1382 #ifdef FG_JPEG_SERVER
1383 {"jpg-httpd", true, OPTION_CHANNEL, "", false, "", 0 },
1385 {"native", true, OPTION_CHANNEL, "", false, "", 0 },
1386 {"native-ctrls", true, OPTION_CHANNEL, "", false, "", 0 },
1387 {"native-fdm", true, OPTION_CHANNEL, "", false, "", 0 },
1388 {"native-gui", true, OPTION_CHANNEL, "", false, "", 0 },
1389 {"opengc", true, OPTION_CHANNEL, "", false, "", 0 },
1390 {"AV400", true, OPTION_CHANNEL, "", false, "", 0 },
1391 {"AV400Sim", true, OPTION_CHANNEL, "", false, "", 0 },
1392 {"garmin", true, OPTION_CHANNEL, "", false, "", 0 },
1393 {"nmea", true, OPTION_CHANNEL, "", false, "", 0 },
1394 {"generic", true, OPTION_CHANNEL, "", false, "", 0 },
1395 {"props", true, OPTION_CHANNEL, "", false, "", 0 },
1396 {"telnet", true, OPTION_CHANNEL, "", false, "", 0 },
1397 {"pve", true, OPTION_CHANNEL, "", false, "", 0 },
1398 {"ray", true, OPTION_CHANNEL, "", false, "", 0 },
1399 {"rul", true, OPTION_CHANNEL, "", false, "", 0 },
1400 {"joyclient", true, OPTION_CHANNEL, "", false, "", 0 },
1401 {"jsclient", true, OPTION_CHANNEL, "", false, "", 0 },
1402 {"proxy", true, OPTION_FUNC, "", false, "", fgSetupProxy },
1403 {"callsign", true, OPTION_STRING, "sim/multiplay/callsign", false, "", 0 },
1404 {"multiplay", true, OPTION_CHANNEL, "", false, "", 0 },
1405 {"trace-read", true, OPTION_FUNC, "", false, "", fgOptTraceRead },
1406 {"trace-write", true, OPTION_FUNC, "", false, "", fgOptTraceWrite },
1407 {"log-level", true, OPTION_FUNC, "", false, "", fgOptLogLevel },
1408 {"view-offset", true, OPTION_FUNC, "", false, "", fgOptViewOffset },
1409 {"visibility", true, OPTION_FUNC, "", false, "", fgOptVisibilityMeters },
1410 {"visibility-miles", true, OPTION_FUNC, "", false, "", fgOptVisibilityMiles },
1411 {"random-wind", false, OPTION_FUNC, "", false, "", fgOptRandomWind },
1412 {"wind", true, OPTION_FUNC, "", false, "", fgOptWind },
1413 {"turbulence", true, OPTION_FUNC, "", false, "", fgOptTurbulence },
1414 {"ceiling", true, OPTION_FUNC, "", false, "", fgOptCeiling },
1415 {"wp", true, OPTION_FUNC, "", false, "", fgOptWp },
1416 {"flight-plan", true, OPTION_FUNC, "", false, "", fgOptFlightPlan },
1417 {"config", true, OPTION_FUNC, "", false, "", fgOptConfig },
1418 {"aircraft", true, OPTION_STRING, "/sim/aircraft", false, "", 0 },
1419 {"vehicle", true, OPTION_STRING, "/sim/aircraft", false, "", 0 },
1420 {"failure", true, OPTION_FUNC, "", false, "", fgOptFailure },
1421 {"com1", true, OPTION_DOUBLE, "/instrumentation/comm[0]/frequencies/selected-mhz", false, "", 0 },
1422 {"com2", true, OPTION_DOUBLE, "/instrumentation/comm[1]/frequencies/selected-mhz", false, "", 0 },
1423 {"nav1", true, OPTION_FUNC, "", false, "", fgOptNAV1 },
1424 {"nav2", true, OPTION_FUNC, "", false, "", fgOptNAV2 },
1425 {"adf", true, OPTION_FUNC, "", false, "", fgOptADF },
1426 {"dme", true, OPTION_FUNC, "", false, "", fgOptDME },
1427 {"min-status", true, OPTION_STRING, "/sim/aircraft-min-status", false, "all", 0 },
1428 {"livery", true, OPTION_FUNC, "", false, "", fgOptLivery },
1429 {"ai-scenario", true, OPTION_FUNC, "", false, "", fgOptScenario },
1430 {"parking-id", true, OPTION_FUNC, "", false, "", fgOptParking },
1431 {"version", false, OPTION_FUNC, "", false, "", fgOptVersion },
1432 {"enable-fpe", false, OPTION_FUNC, "", false, "", fgOptFpe},
1433 {"fgviewer", false, OPTION_FUNC, "", false, "", fgOptFgviewer},
1438 // Set a property for the --prop: option. Syntax: --prop:[<type>:]<name>=<value>
1439 // <type> can be "double" etc. but also only the first letter "d".
1440 // Examples: --prop:alpha=1 --prop:bool:beta=true --prop:d:gamma=0.123
1442 set_property(const string& arg)
1444 string::size_type pos = arg.find('=');
1445 if (pos == arg.npos || pos == 0 || pos + 1 == arg.size())
1448 string name = arg.substr(0, pos);
1449 string value = arg.substr(pos + 1);
1451 pos = name.find(':');
1453 if (pos != name.npos && pos != 0 && pos + 1 != name.size()) {
1454 type = name.substr(0, pos);
1455 name = name.substr(pos + 1);
1457 SGPropertyNode *n = fgGetNode(name.c_str(), true);
1459 bool writable = n->getAttribute(SGPropertyNode::WRITE);
1461 n->setAttribute(SGPropertyNode::WRITE, true);
1465 ret = n->setUnspecifiedValue(value.c_str());
1466 else if (type == "s" || type == "string")
1467 ret = n->setStringValue(value.c_str());
1468 else if (type == "d" || type == "double")
1469 ret = n->setDoubleValue(strtod(value.c_str(), 0));
1470 else if (type == "f" || type == "float")
1471 ret = n->setFloatValue(atof(value.c_str()));
1472 else if (type == "l" || type == "long")
1473 ret = n->setLongValue(strtol(value.c_str(), 0, 0));
1474 else if (type == "i" || type == "int")
1475 ret = n->setIntValue(atoi(value.c_str()));
1476 else if (type == "b" || type == "bool")
1477 ret = n->setBoolValue(value == "true" || atoi(value.c_str()) != 0);
1480 n->setAttribute(SGPropertyNode::WRITE, false);
1485 // Parse a single option
1487 parse_option (const string& arg)
1489 if ( fgOptionMap.size() == 0 ) {
1491 OptionDesc *pt = &fgOptionArray[ 0 ];
1492 while ( pt->option != 0 ) {
1493 fgOptionMap[ pt->option ] = i;
1500 if ( (arg == "--help") || (arg == "-h") ) {
1501 // help/usage request
1502 return(FG_OPTIONS_HELP);
1503 } else if ( (arg == "--verbose") || (arg == "-v") ) {
1504 // verbose help/usage request
1505 return(FG_OPTIONS_VERBOSE_HELP);
1506 } else if ( arg.find( "--show-aircraft") == 0) {
1507 return(FG_OPTIONS_SHOW_AIRCRAFT);
1508 } else if ( arg.find( "--show-sound-devices") == 0) {
1509 return(FG_OPTIONS_SHOW_SOUND_DEVICES);
1510 } else if ( arg.find( "--prop:" ) == 0 ) {
1511 if (!set_property(arg.substr(7))) {
1512 SG_LOG( SG_GENERAL, SG_ALERT, "Bad property assignment: " << arg );
1513 return FG_OPTIONS_ERROR;
1515 } else if ( arg.find( "--" ) == 0 ) {
1516 size_t pos = arg.find( '=' );
1517 string arg_name, arg_value;
1518 if ( pos == string::npos ) {
1519 arg_name = arg.substr( 2 );
1521 arg_name = arg.substr( 2, pos - 2 );
1522 arg_value = arg.substr( pos + 1);
1524 map<string,size_t>::iterator it = fgOptionMap.find( arg_name );
1525 if ( it != fgOptionMap.end() ) {
1526 OptionDesc *pt = &fgOptionArray[ it->second ];
1527 switch ( pt->type ) {
1529 fgSetBool( pt->property, pt->b_param );
1532 if ( pt->has_param && !arg_value.empty() ) {
1533 fgSetString( pt->property, arg_value.c_str() );
1534 } else if ( !pt->has_param && arg_value.empty() ) {
1535 fgSetString( pt->property, pt->s_param );
1536 } else if ( pt->has_param ) {
1537 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << arg << "' needs a parameter" );
1538 return FG_OPTIONS_ERROR;
1540 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << arg << "' does not have a parameter" );
1541 return FG_OPTIONS_ERROR;
1545 if ( !arg_value.empty() ) {
1546 fgSetDouble( pt->property, atof( arg_value ) );
1548 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << arg << "' needs a parameter" );
1549 return FG_OPTIONS_ERROR;
1553 if ( !arg_value.empty() ) {
1554 fgSetInt( pt->property, atoi( arg_value ) );
1556 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << arg << "' needs a parameter" );
1557 return FG_OPTIONS_ERROR;
1560 case OPTION_CHANNEL:
1561 if ( pt->has_param && !arg_value.empty() ) {
1562 add_channel( pt->option, arg_value );
1563 } else if ( !pt->has_param && arg_value.empty() ) {
1564 add_channel( pt->option, pt->s_param );
1565 } else if ( pt->has_param ) {
1566 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << arg << "' needs a parameter" );
1567 return FG_OPTIONS_ERROR;
1569 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << arg << "' does not have a parameter" );
1570 return FG_OPTIONS_ERROR;
1574 if ( pt->has_param && !arg_value.empty() ) {
1575 return pt->func( arg_value.c_str() );
1576 } else if ( !pt->has_param && arg_value.empty() ) {
1577 return pt->func( pt->s_param );
1578 } else if ( pt->has_param ) {
1579 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << arg << "' needs a parameter" );
1580 return FG_OPTIONS_ERROR;
1582 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << arg << "' does not have a parameter" );
1583 return FG_OPTIONS_ERROR;
1588 SG_LOG( SG_GENERAL, SG_ALERT, "Unknown option '" << arg << "'" );
1589 return FG_OPTIONS_ERROR;
1592 SG_LOG( SG_GENERAL, SG_ALERT, "Unknown option '" << arg << "'" );
1593 return FG_OPTIONS_ERROR;
1596 return FG_OPTIONS_OK;
1600 // Parse the command line options
1602 fgParseArgs (int argc, char **argv)
1604 bool in_options = true;
1605 bool verbose = false;
1608 SG_LOG(SG_GENERAL, SG_INFO, "Processing command line arguments");
1610 for (int i = 1; i < argc; i++) {
1611 string arg = argv[i];
1613 if (in_options && (arg.find('-') == 0)) {
1617 int result = parse_option(arg);
1618 if ((result == FG_OPTIONS_HELP) || (result == FG_OPTIONS_ERROR))
1621 else if (result == FG_OPTIONS_VERBOSE_HELP)
1624 else if (result == FG_OPTIONS_SHOW_AIRCRAFT) {
1625 fgOptLogLevel( "alert" );
1626 SGPath path( globals->get_fg_root() );
1627 path.append("Aircraft");
1628 fgShowAircraft(path, true);
1631 } else if (result == FG_OPTIONS_SHOW_SOUND_DEVICES) {
1633 vector <const char*>devices = smgr.get_available_devices();
1634 for (int i=0; i<devices.size(); i++) {
1635 printf("%i. \"%s\"\n", i, devices[i]);
1641 else if (result == FG_OPTIONS_EXIT)
1646 SG_LOG(SG_GENERAL, SG_INFO,
1647 "Reading command-line property file " << arg);
1648 readProperties(arg, globals->get_props());
1653 fgOptLogLevel( "alert" );
1658 SG_LOG(SG_GENERAL, SG_INFO, "Finished command line arguments");
1662 // Parse config file options
1664 fgParseOptions (const string& path) {
1665 sg_gzifstream in( path );
1666 if ( !in.is_open() ) {
1670 SG_LOG( SG_GENERAL, SG_INFO, "Processing config file: " << path );
1673 while ( ! in.eof() ) {
1675 getline( in, line, '\n' );
1677 // catch extraneous (DOS) line ending character
1679 for (i = line.length(); i > 0; i--)
1680 if (line[i - 1] > 32)
1682 line = line.substr( 0, i );
1684 if ( parse_option( line ) == FG_OPTIONS_ERROR ) {
1685 cerr << endl << "Config file parse error: " << path << " '"
1686 << line << "'" << endl;
1695 // Print usage message
1697 fgUsage (bool verbose)
1699 SGPropertyNode *locale = globals->get_locale();
1701 SGPropertyNode options_root;
1703 SG_LOG( SG_GENERAL, SG_ALERT, "" ); // To popup the console on Windows
1707 fgLoadProps("options.xml", &options_root);
1708 } catch (const sg_exception &) {
1709 cout << "Unable to read the help file." << endl;
1710 cout << "Make sure the file options.xml is located in the FlightGear base directory," << endl;
1711 cout << "and the location of the base directory is specified by setting $FG_ROOT or" << endl;
1712 cout << "by adding --fg-root=path as a program argument." << endl;
1717 SGPropertyNode *options = options_root.getNode("options");
1719 SG_LOG( SG_GENERAL, SG_ALERT,
1720 "Error reading options.xml: <options> directive not found." );
1724 SGPropertyNode *usage = locale->getNode(options->getStringValue("usage"));
1726 cout << "Usage: " << usage->getStringValue() << endl;
1729 vector<SGPropertyNode_ptr>section = options->getChildren("section");
1730 for (unsigned int j = 0; j < section.size(); j++) {
1733 vector<SGPropertyNode_ptr>option = section[j]->getChildren("option");
1734 for (unsigned int k = 0; k < option.size(); k++) {
1736 SGPropertyNode *name = option[k]->getNode("name");
1737 SGPropertyNode *short_name = option[k]->getNode("short");
1738 SGPropertyNode *key = option[k]->getNode("key");
1739 SGPropertyNode *arg = option[k]->getNode("arg");
1740 bool brief = option[k]->getNode("brief") != 0;
1742 if ((brief || verbose) && name) {
1743 string tmp = name->getStringValue();
1747 tmp.append(key->getStringValue());
1751 tmp.append(arg->getStringValue());
1755 tmp.append(short_name->getStringValue());
1758 if (tmp.size() <= 25) {
1761 msg.append( 27-tmp.size(), ' ');
1765 msg.append(32, ' ');
1767 // There may be more than one <description> tag assosiated
1770 vector<SGPropertyNode_ptr> desc;
1771 desc = option[k]->getChildren("description");
1772 if (desc.size() > 0) {
1773 for ( unsigned int l = 0; l < desc.size(); l++) {
1775 // There may be more than one translation line.
1777 string t = desc[l]->getStringValue();
1778 SGPropertyNode *n = locale->getNode("strings");
1779 vector<SGPropertyNode_ptr>trans_desc =
1780 n->getChildren(t.substr(8).c_str());
1782 for ( unsigned int m = 0; m < trans_desc.size(); m++ ) {
1783 string t_str = trans_desc[m]->getStringValue();
1785 if ((m > 0) || ((l > 0) && m == 0)) {
1786 msg.append( 32, ' ');
1789 // If the string is too large to fit on the screen,
1790 // then split it up in several pieces.
1792 while ( t_str.size() > 47 ) {
1794 unsigned int m = t_str.rfind(' ', 47);
1795 msg += t_str.substr(0, m) + '\n';
1796 msg.append( 32, ' ');
1798 t_str.erase(t_str.begin(), t_str.begin() + m + 1);
1800 msg += t_str + '\n';
1807 SGPropertyNode *name;
1808 name = locale->getNode(section[j]->getStringValue("name"));
1810 if (!msg.empty() && name) {
1811 cout << endl << name->getStringValue() << ":" << endl;
1819 cout << "For a complete list of options use --help --verbose" << endl;
1822 cout << "Hit a key to continue..." << endl;
1827 // A simple function to return an integer depending on the position
1828 // of the status string within the array in order to determine the hierarchy.
1829 unsigned int getNumMaturity(const char * str)
1831 // changes should also be reflected in $FG_ROOT/data/options.xml &
1832 // $FG_ROOT/data/Translations/string-default.xml
1833 const char* levels[] = {"alpha","beta","early-production","production"};
1835 for (size_t i=0; i<(sizeof(levels)/sizeof(levels[0]));i++)
1836 if (strcmp(str,levels[i])==0)
1843 static void fgSearchAircraft(const SGPath &path, string_list &aircraft,
1848 ulDir *dirp = ulOpenDir(path.str().c_str());
1850 cerr << "Unable to open aircraft directory '" << path.str() << '\'' << endl;
1854 while ((dire = ulReadDir(dirp)) != NULL) {
1857 if (dire->d_isdir) {
1858 if (recursive && strcmp("CVS", dire->d_name)
1859 && strcmp(".", dire->d_name) && strcmp("..", dire->d_name))
1862 next.append(dire->d_name);
1864 fgSearchAircraft(next, aircraft, true);
1866 } else if ((ptr = strstr(dire->d_name, "-set.xml")) && (ptr[8] == '\0')) {
1868 SGPath afile = path;
1869 afile.append(dire->d_name);
1873 SGPropertyNode root;
1875 readProperties(afile.str(), &root);
1880 SGPropertyNode *desc = NULL;
1881 SGPropertyNode *status = NULL;
1883 SGPropertyNode *node = root.getNode("sim");
1885 desc = node->getNode("description");
1886 // if a status tag is found, read it in
1887 if (node->hasValue("status"))
1888 status = node->getNode("status");
1891 //additionally display status information where it is available
1893 string descStr(" ");
1894 descStr += dire->d_name;
1896 if (descStr.size() <= 27+3) {
1897 descStr.append(29+3-descStr.size(), ' ');
1900 descStr.append( 32, ' ');
1902 descStr += desc->getStringValue();
1905 SGPropertyNode * required_status
1906 = fgGetNode ("/sim/aircraft-min-status", true);
1908 // If the node holds the value "all", then there wasn't any status
1909 // level specified, so we simply go ahead and output ALL aircraft
1910 if (strcmp(required_status->getStringValue(),"all")==0) {
1911 aircraft.push_back(descStr);
1915 // If the node doesn't hold "all" as its value, then we are supposed
1916 // to show only aircraft meeting specific status (development status)
1919 if (node->hasValue("status")) {
1920 //Compare (minimally) required status level with actual aircraft status:
1921 if ( getNumMaturity(status->getStringValue() ) >=
1922 getNumMaturity(required_status->getStringValue() ) )
1923 aircraft.push_back(descStr); }
1935 * Search in the current directory, and in on directory deeper
1936 * for <aircraft>-set.xml configuration files and show the aircaft name
1937 * and the contents of the<description> tag in a sorted manner.
1939 * @parampath the directory to search for configuration files
1940 * @param recursive defines whether the directory should be searched recursively
1942 void fgShowAircraft(const SGPath &path, bool recursive) {
1943 string_list aircraft;
1945 fgSearchAircraft( path, aircraft, recursive );
1947 sort(aircraft.begin(), aircraft.end());
1948 SG_LOG( SG_GENERAL, SG_ALERT, "" ); // To popup the console on Windows
1949 cout << "Available aircraft:" << endl;
1950 for ( unsigned int i = 0; i < aircraft.size(); i++ ) {
1951 cout << aircraft[i] << endl;
1954 cout << "Hit a key to continue..." << endl;