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/color/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, AV400, 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 );
531 globals->get_channel_options_list()->push_back( type + "," + channel_str );
536 // The parse wp and parse flight-plan options don't work anymore, because
537 // the route manager and the airport subsystems have not yet been initialized
540 // Parse --wp=ID[@alt]
542 parse_wp( const string& arg ) {
543 string_list *waypoints = globals->get_initial_waypoints();
545 waypoints = new string_list;
546 globals->set_initial_waypoints(waypoints);
548 waypoints->push_back(arg);
552 // Parse --flight-plan=[file]
554 parse_flightplan(const string& arg)
556 string_list *waypoints = globals->get_initial_waypoints();
558 waypoints = new string_list;
559 globals->set_initial_waypoints(waypoints);
562 sg_gzifstream in(arg.c_str());
569 #if defined( macintosh )
570 getline( in, line, '\r' );
572 getline( in, line, '\n' );
574 // catch extraneous (DOS) line ending character
575 if ( line[line.length() - 1] < 32 )
576 line = line.substr( 0, line.length()-1 );
581 waypoints->push_back(line);
588 fgOptLanguage( const char *arg )
590 globals->set_locale( fgInitLocale( arg ) );
591 return FG_OPTIONS_OK;
597 fgSetString("/sim/presets/airport-id", "");
598 fgSetString("/sim/presets/vor-id", "");
599 fgSetString("/sim/presets/ndb-id", "");
600 fgSetString("/sim/presets/carrier", "");
601 fgSetString("/sim/presets/parkpos", "");
602 fgSetString("/sim/presets/fix", "");
606 fgOptVOR( const char * arg )
609 fgSetString("/sim/presets/vor-id", arg);
610 return FG_OPTIONS_OK;
614 fgOptNDB( const char * arg )
617 fgSetString("/sim/presets/ndb-id", arg);
618 return FG_OPTIONS_OK;
622 fgOptCarrier( const char * arg )
625 fgSetString("/sim/presets/carrier", arg);
626 return FG_OPTIONS_OK;
630 fgOptParkpos( const char * arg )
632 fgSetString("/sim/presets/parkpos", arg);
633 return FG_OPTIONS_OK;
637 fgOptFIX( const char * arg )
640 fgSetString("/sim/presets/fix", arg);
641 return FG_OPTIONS_OK;
645 fgOptLon( const char *arg )
648 fgSetDouble("/sim/presets/longitude-deg", parse_degree( arg ));
649 fgSetDouble("/position/longitude-deg", parse_degree( arg ));
650 return FG_OPTIONS_OK;
654 fgOptLat( const char *arg )
657 fgSetDouble("/sim/presets/latitude-deg", parse_degree( arg ));
658 fgSetDouble("/position/latitude-deg", parse_degree( arg ));
659 return FG_OPTIONS_OK;
663 fgOptAltitude( const char *arg )
665 fgSetBool("/sim/presets/onground", false);
666 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
667 fgSetDouble("/sim/presets/altitude-ft", atof( arg ));
669 fgSetDouble("/sim/presets/altitude-ft",
670 atof( arg ) * SG_METER_TO_FEET);
671 return FG_OPTIONS_OK;
675 fgOptUBody( const char *arg )
677 fgSetString("/sim/presets/speed-set", "UVW");
678 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
679 fgSetDouble("/sim/presets/uBody-fps", atof( arg ));
681 fgSetDouble("/sim/presets/uBody-fps",
682 atof( arg ) * SG_METER_TO_FEET);
683 return FG_OPTIONS_OK;
687 fgOptVBody( const char *arg )
689 fgSetString("/sim/presets/speed-set", "UVW");
690 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
691 fgSetDouble("/sim/presets/vBody-fps", atof( arg ));
693 fgSetDouble("/sim/presets/vBody-fps",
694 atof( arg ) * SG_METER_TO_FEET);
695 return FG_OPTIONS_OK;
699 fgOptWBody( const char *arg )
701 fgSetString("/sim/presets/speed-set", "UVW");
702 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
703 fgSetDouble("/sim/presets/wBody-fps", atof(arg));
705 fgSetDouble("/sim/presets/wBody-fps",
706 atof(arg) * SG_METER_TO_FEET);
707 return FG_OPTIONS_OK;
711 fgOptVNorth( const char *arg )
713 fgSetString("/sim/presets/speed-set", "NED");
714 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
715 fgSetDouble("/sim/presets/speed-north-fps", atof( arg ));
717 fgSetDouble("/sim/presets/speed-north-fps",
718 atof( arg ) * SG_METER_TO_FEET);
719 return FG_OPTIONS_OK;
723 fgOptVEast( const char *arg )
725 fgSetString("/sim/presets/speed-set", "NED");
726 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
727 fgSetDouble("/sim/presets/speed-east-fps", atof(arg));
729 fgSetDouble("/sim/presets/speed-east-fps",
730 atof(arg) * SG_METER_TO_FEET);
731 return FG_OPTIONS_OK;
735 fgOptVDown( const char *arg )
737 fgSetString("/sim/presets/speed-set", "NED");
738 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
739 fgSetDouble("/sim/presets/speed-down-fps", atof(arg));
741 fgSetDouble("/sim/presets/speed-down-fps",
742 atof(arg) * SG_METER_TO_FEET);
743 return FG_OPTIONS_OK;
747 fgOptVc( const char *arg )
749 // fgSetString("/sim/presets/speed-set", "knots");
750 // fgSetDouble("/velocities/airspeed-kt", atof(arg.substr(5)));
751 fgSetString("/sim/presets/speed-set", "knots");
752 fgSetDouble("/sim/presets/airspeed-kt", atof(arg));
753 return FG_OPTIONS_OK;
757 fgOptMach( const char *arg )
759 fgSetString("/sim/presets/speed-set", "mach");
760 fgSetDouble("/sim/presets/mach", atof(arg));
761 return FG_OPTIONS_OK;
765 fgOptRoc( const char *arg )
767 fgSetDouble("/velocities/vertical-speed-fps", atof(arg)/60);
768 return FG_OPTIONS_OK;
772 fgOptFgRoot( const char *arg )
774 globals->set_fg_root(arg);
775 return FG_OPTIONS_OK;
779 fgOptFgScenery( const char *arg )
781 globals->set_fg_scenery(arg);
782 return FG_OPTIONS_OK;
786 fgOptFov( const char *arg )
789 return FG_OPTIONS_OK;
793 fgOptGeometry( const char *arg )
795 bool geometry_ok = true;
796 int xsize = 0, ysize = 0;
797 string geometry = arg;
798 string::size_type i = geometry.find('x');
800 if (i != string::npos) {
801 xsize = atoi(geometry.substr(0, i));
802 ysize = atoi(geometry.substr(i+1));
807 if ( xsize <= 0 || ysize <= 0 ) {
813 if ( !geometry_ok ) {
814 SG_LOG( SG_GENERAL, SG_ALERT, "Unknown geometry: " << geometry );
815 SG_LOG( SG_GENERAL, SG_ALERT,
816 "Setting geometry to " << xsize << 'x' << ysize << '\n');
818 SG_LOG( SG_GENERAL, SG_INFO,
819 "Setting geometry to " << xsize << 'x' << ysize << '\n');
820 fgSetInt("/sim/startup/xsize", xsize);
821 fgSetInt("/sim/startup/ysize", ysize);
823 return FG_OPTIONS_OK;
827 fgOptBpp( const char *arg )
829 string bits_per_pix = arg;
830 if ( bits_per_pix == "16" ) {
831 fgSetInt("/sim/rendering/bits-per-pixel", 16);
832 } else if ( bits_per_pix == "24" ) {
833 fgSetInt("/sim/rendering/bits-per-pixel", 24);
834 } else if ( bits_per_pix == "32" ) {
835 fgSetInt("/sim/rendering/bits-per-pixel", 32);
837 SG_LOG(SG_GENERAL, SG_ALERT, "Unsupported bpp " << bits_per_pix);
839 return FG_OPTIONS_OK;
843 fgOptTimeOffset( const char *arg )
845 fgSetInt("/sim/startup/time-offset",
846 parse_time_offset( arg ));
847 fgSetString("/sim/startup/time-offset-type", "system-offset");
848 return FG_OPTIONS_OK;
852 fgOptStartDateSys( const char *arg )
854 fgSetInt("/sim/startup/time-offset", parse_date( arg ) );
855 fgSetString("/sim/startup/time-offset-type", "system");
856 return FG_OPTIONS_OK;
860 fgOptStartDateLat( const char *arg )
862 fgSetInt("/sim/startup/time-offset", parse_date( arg ) );
863 fgSetString("/sim/startup/time-offset-type", "latitude");
864 return FG_OPTIONS_OK;
868 fgOptStartDateGmt( const char *arg )
870 fgSetInt("/sim/startup/time-offset", parse_date( arg ) );
871 fgSetString("/sim/startup/time-offset-type", "gmt");
872 return FG_OPTIONS_OK;
876 fgSetupProxy( const char *arg )
878 string options = arg;
879 string host, port, auth;
880 string::size_type pos;
882 host = port = auth = "";
883 if ((pos = options.find("@")) != string::npos)
884 auth = options.substr(0, pos++);
888 host = options.substr(pos, options.size());
889 if ((pos = host.find(":")) != string::npos) {
890 port = host.substr(++pos, host.size());
891 host.erase(--pos, host.size());
894 fgSetString("/sim/presets/proxy/host", host.c_str());
895 fgSetString("/sim/presets/proxy/port", port.c_str());
896 fgSetString("/sim/presets/proxy/authentication", auth.c_str());
898 return FG_OPTIONS_OK;
902 fgOptTraceRead( const char *arg )
905 SG_LOG(SG_GENERAL, SG_INFO, "Tracing reads for property " << name);
906 fgGetNode(name.c_str(), true)
907 ->setAttribute(SGPropertyNode::TRACE_READ, true);
908 return FG_OPTIONS_OK;
912 fgOptLogLevel( const char *arg )
914 fgSetString("/sim/logging/classes", "all");
915 fgSetString("/sim/logging/priority", arg);
917 string priority = arg;
918 logbuf::set_log_classes(SG_ALL);
919 if (priority == "bulk") {
920 logbuf::set_log_priority(SG_BULK);
921 } else if (priority == "debug") {
922 logbuf::set_log_priority(SG_DEBUG);
923 } else if (priority == "info") {
924 logbuf::set_log_priority(SG_INFO);
925 } else if (priority == "warn") {
926 logbuf::set_log_priority(SG_WARN);
927 } else if (priority == "alert") {
928 logbuf::set_log_priority(SG_ALERT);
930 SG_LOG(SG_GENERAL, SG_WARN, "Unknown logging priority " << priority);
932 SG_LOG(SG_GENERAL, SG_DEBUG, "Logging priority is " << priority);
934 return FG_OPTIONS_OK;
939 fgOptTraceWrite( const char *arg )
942 SG_LOG(SG_GENERAL, SG_INFO, "Tracing writes for property " << name);
943 fgGetNode(name.c_str(), true)
944 ->setAttribute(SGPropertyNode::TRACE_WRITE, true);
945 return FG_OPTIONS_OK;
949 fgOptViewOffset( const char *arg )
951 // $$$ begin - added VS Renganathan, 14 Oct 2K
952 // for multi-window outside window imagery
953 string woffset = arg;
954 double default_view_offset = 0.0;
955 if ( woffset == "LEFT" ) {
956 default_view_offset = SGD_PI * 0.25;
957 } else if ( woffset == "RIGHT" ) {
958 default_view_offset = SGD_PI * 1.75;
959 } else if ( woffset == "CENTER" ) {
960 default_view_offset = 0.00;
962 default_view_offset = atof( woffset.c_str() ) * SGD_DEGREES_TO_RADIANS;
964 /* apparently not used (CLO, 11 Jun 2002)
965 FGViewer *pilot_view =
966 (FGViewer *)globals->get_viewmgr()->get_view( 0 ); */
967 // this will work without calls to the viewer...
968 fgSetDouble( "/sim/current-view/heading-offset-deg",
969 default_view_offset * SGD_RADIANS_TO_DEGREES );
970 // $$$ end - added VS Renganathan, 14 Oct 2K
971 return FG_OPTIONS_OK;
975 fgOptVisibilityMeters( const char *arg )
977 double visibility = atof( arg );
978 fgDefaultWeatherValue("visibility-m", visibility);
979 return FG_OPTIONS_OK;
983 fgOptVisibilityMiles( const char *arg )
985 double visibility = atof( arg ) * 5280.0 * SG_FEET_TO_METER;
986 fgDefaultWeatherValue("visibility-m", visibility);
987 return FG_OPTIONS_OK;
991 fgOptRandomWind( const char *arg )
993 double min_hdg = sg_random() * 360.0;
994 double max_hdg = min_hdg + (20 - sqrt(sg_random() * 400));
995 double speed = sg_random() * sg_random() * 40;
996 double gust = speed + (10 - sqrt(sg_random() * 100));
997 fgSetupWind(min_hdg, max_hdg, speed, gust);
998 return FG_OPTIONS_OK;
1002 fgOptWind( const char *arg )
1004 double min_hdg, max_hdg, speed, gust;
1005 if (!parse_wind( arg, &min_hdg, &max_hdg, &speed, &gust)) {
1006 SG_LOG( SG_GENERAL, SG_ALERT, "bad wind value " << arg );
1007 return FG_OPTIONS_ERROR;
1009 fgSetupWind(min_hdg, max_hdg, speed, gust);
1010 return FG_OPTIONS_OK;
1014 fgOptTurbulence( const char *arg )
1016 fgDefaultWeatherValue("turbulence/magnitude-norm", atof(arg));
1017 return FG_OPTIONS_OK;
1021 fgOptCeiling( const char *arg )
1023 double elevation, thickness;
1025 string::size_type pos = spec.find(':');
1026 if (pos == string::npos) {
1027 elevation = atof(spec.c_str());
1030 elevation = atof(spec.substr(0, pos).c_str());
1031 thickness = atof(spec.substr(pos + 1).c_str());
1033 fgSetDouble("/environment/clouds/layer[0]/elevation-ft", elevation);
1034 fgSetDouble("/environment/clouds/layer[0]/thickness-ft", thickness);
1035 fgSetString("/environment/clouds/layer[0]/coverage", "overcast");
1036 return FG_OPTIONS_OK;
1040 fgOptWp( const char *arg )
1043 return FG_OPTIONS_OK;
1047 fgOptFlightPlan( const char *arg )
1049 parse_flightplan ( arg );
1050 return FG_OPTIONS_OK;
1054 fgOptConfig( const char *arg )
1058 readProperties(file, globals->get_props());
1059 } catch (const sg_exception &e) {
1060 string message = "Error loading config file: ";
1061 message += e.getFormattedMessage() + e.getOrigin();
1062 SG_LOG(SG_INPUT, SG_ALERT, message);
1065 return FG_OPTIONS_OK;
1069 parse_colon (const string &s, double * val1, double * val2)
1071 string::size_type pos = s.find(':');
1072 if (pos == string::npos) {
1076 *val1 = atof(s.substr(0, pos).c_str());
1077 *val2 = atof(s.substr(pos+1).c_str());
1084 fgOptFailure( const char * arg )
1088 fgSetBool("/systems/pitot/serviceable", false);
1089 } else if (a == "static") {
1090 fgSetBool("/systems/static/serviceable", false);
1091 } else if (a == "vacuum") {
1092 fgSetBool("/systems/vacuum/serviceable", false);
1093 } else if (a == "electrical") {
1094 fgSetBool("/systems/electrical/serviceable", false);
1096 SG_LOG(SG_INPUT, SG_ALERT, "Unknown failure mode: " << a);
1097 return FG_OPTIONS_ERROR;
1100 return FG_OPTIONS_OK;
1105 fgOptNAV1( const char * arg )
1107 double radial, freq;
1108 if (parse_colon(arg, &radial, &freq))
1109 fgSetDouble("/instrumentation/nav[0]/radials/selected-deg", radial);
1110 fgSetDouble("/instrumentation/nav[0]/frequencies/selected-mhz", freq);
1111 return FG_OPTIONS_OK;
1115 fgOptNAV2( const char * arg )
1117 double radial, freq;
1118 if (parse_colon(arg, &radial, &freq))
1119 fgSetDouble("/instrumentation/nav[1]/radials/selected-deg", radial);
1120 fgSetDouble("/instrumentation/nav[1]/frequencies/selected-mhz", freq);
1121 return FG_OPTIONS_OK;
1125 fgOptADF( const char * arg )
1128 if (parse_colon(arg, &rot, &freq))
1129 fgSetDouble("/instrumentation/adf/rotation-deg", rot);
1130 fgSetDouble("/instrumentation/adf/frequencies/selected-khz", freq);
1131 return FG_OPTIONS_OK;
1135 fgOptDME( const char *arg )
1138 if (opt == "nav1") {
1139 fgSetInt("/instrumentation/dme/switch-position", 1);
1140 fgSetString("/instrumentation/dme/frequencies/source",
1141 "/instrumentation/nav[0]/frequencies/selected-mhz");
1142 } else if (opt == "nav2") {
1143 fgSetInt("/instrumentation/dme/switch-position", 3);
1144 fgSetString("/instrumentation/dme/frequencies/source",
1145 "/instrumentation/nav[1]/frequencies/selected-mhz");
1147 fgSetInt("/instrumentation/dme/switch-position", 2);
1148 fgSetString("/instrumentation/dme/frequencies/source",
1149 "/instrumentation/dme/frequencies/selected-mhz");
1150 fgSetString("/instrumentation/dme/frequencies/selected-mhz", arg);
1152 return FG_OPTIONS_OK;
1156 fgOptLivery( const char *arg )
1159 string livery_path = "livery/" + opt;
1160 fgSetString("/sim/model/texture-path", livery_path.c_str() );
1161 return FG_OPTIONS_OK;
1165 fgOptScenario( const char *arg )
1167 SGPropertyNode_ptr ai_node = fgGetNode( "/sim/ai", true );
1168 vector<SGPropertyNode_ptr> scenarii = ai_node->getChildren( "scenario" );
1170 for ( size_t i = 0; i < scenarii.size(); ++i ) {
1171 int ind = scenarii[i]->getIndex();
1172 if ( index < ind ) {
1176 SGPropertyNode_ptr scenario = ai_node->getNode( "scenario", index + 1, true );
1177 scenario->setStringValue( arg );
1178 ai_node->setBoolValue( "enabled", true );
1179 return FG_OPTIONS_OK;
1183 fgOptRunway( const char *arg )
1185 fgSetString("/sim/presets/runway", arg );
1186 fgSetBool("/sim/presets/runway-requested", true );
1187 return FG_OPTIONS_OK;
1190 static map<string,size_t> fgOptionMap;
1193 option has_param type property b_param s_param func
1196 option : name of the option
1197 has_param : option is --name=value if true or --name if false
1198 type : OPTION_BOOL - property is a boolean
1199 OPTION_STRING - property is a string
1200 OPTION_DOUBLE - property is a double
1201 OPTION_INT - property is an integer
1202 OPTION_CHANNEL - name of option is the name of a channel
1203 OPTION_FUNC - the option trigger a function
1204 b_param : if type==OPTION_BOOL,
1205 value set to the property (has_param is false for boolean)
1206 s_param : if type==OPTION_STRING,
1207 value set to the property if has_param is false
1208 func : function called if type==OPTION_FUNC. if has_param is true,
1209 the value is passed to the function as a string, otherwise,
1212 For OPTION_DOUBLE and OPTION_INT, the parameter value is converted into a
1213 double or an integer and set to the property.
1215 For OPTION_CHANNEL, add_channel is called with the parameter value as the
1219 enum OptionType { OPTION_BOOL, OPTION_STRING, OPTION_DOUBLE, OPTION_INT, OPTION_CHANNEL, OPTION_FUNC };
1223 enum OptionType type;
1227 int (*func)( const char * );
1228 } fgOptionArray[] = {
1230 {"language", true, OPTION_FUNC, "", false, "", fgOptLanguage },
1231 {"disable-game-mode", false, OPTION_BOOL, "/sim/startup/game-mode", false, "", 0 },
1232 {"enable-game-mode", false, OPTION_BOOL, "/sim/startup/game-mode", true, "", 0 },
1233 {"disable-splash-screen", false, OPTION_BOOL, "/sim/startup/splash-screen", false, "", 0 },
1234 {"enable-splash-screen", false, OPTION_BOOL, "/sim/startup/splash-screen", true, "", 0 },
1235 {"disable-intro-music", false, OPTION_BOOL, "/sim/startup/intro-music", false, "", 0 },
1236 {"enable-intro-music", false, OPTION_BOOL, "/sim/startup/intro-music", true, "", 0 },
1237 {"disable-mouse-pointer", false, OPTION_STRING, "/sim/startup/mouse-pointer", false, "disabled", 0 },
1238 {"enable-mouse-pointer", false, OPTION_STRING, "/sim/startup/mouse-pointer", false, "enabled", 0 },
1239 {"disable-random-objects", false, OPTION_BOOL, "/sim/rendering/random-objects", false, "", 0 },
1240 {"enable-random-objects", false, OPTION_BOOL, "/sim/rendering/random-objects", true, "", 0 },
1241 {"disable-real-weather-fetch", false, OPTION_BOOL, "/environment/params/real-world-weather-fetch", false, "", 0 },
1242 {"enable-real-weather-fetch", false, OPTION_BOOL, "/environment/params/real-world-weather-fetch", true, "", 0 },
1243 {"disable-ai-models", false, OPTION_BOOL, "/sim/ai/enabled", false, "", 0 },
1244 {"enable-ai-models", false, OPTION_BOOL, "/sim/ai/enabled", true, "", 0 },
1245 {"disable-freeze", false, OPTION_BOOL, "/sim/freeze/master", false, "", 0 },
1246 {"enable-freeze", false, OPTION_BOOL, "/sim/freeze/master", true, "", 0 },
1247 {"disable-fuel-freeze", false, OPTION_BOOL, "/sim/freeze/fuel", false, "", 0 },
1248 {"enable-fuel-freeze", false, OPTION_BOOL, "/sim/freeze/fuel", true, "", 0 },
1249 {"disable-clock-freeze", false, OPTION_BOOL, "/sim/freeze/clock", false, "", 0 },
1250 {"enable-clock-freeze", false, OPTION_BOOL, "/sim/freeze/clock", true, "", 0 },
1251 {"disable-hud-3d", false, OPTION_BOOL, "/sim/hud/enable3d", false, "", 0 },
1252 {"enable-hud-3d", false, OPTION_BOOL, "/sim/hud/enable3d", true, "", 0 },
1253 {"disable-anti-alias-hud", false, OPTION_BOOL, "/sim/hud/color/antialiased", false, "", 0 },
1254 {"enable-anti-alias-hud", false, OPTION_BOOL, "/sim/hud/color/antialiased", true, "", 0 },
1255 {"control", true, OPTION_STRING, "/sim/control-mode", false, "", 0 },
1256 {"disable-auto-coordination", false, OPTION_BOOL, "/sim/auto-coordination", false, "", 0 },
1257 {"enable-auto-coordination", false, OPTION_BOOL, "/sim/auto-coordination", true, "", 0 },
1258 {"browser-app", true, OPTION_STRING, "/sim/startup/browser-app", false, "", 0 },
1259 {"disable-hud", false, OPTION_BOOL, "/sim/hud/visibility", false, "", 0 },
1260 {"enable-hud", false, OPTION_BOOL, "/sim/hud/visibility", true, "", 0 },
1261 {"disable-panel", false, OPTION_BOOL, "/sim/panel/visibility", false, "", 0 },
1262 {"enable-panel", false, OPTION_BOOL, "/sim/panel/visibility", true, "", 0 },
1263 {"disable-sound", false, OPTION_BOOL, "/sim/sound/pause", true, "", 0 },
1264 {"enable-sound", false, OPTION_BOOL, "/sim/sound/pause", false, "", 0 },
1265 {"airport", true, OPTION_STRING, "/sim/presets/airport-id", false, "", 0 },
1266 {"airport-id", true, OPTION_STRING, "/sim/presets/airport-id", false, "", 0 },
1267 {"runway", true, OPTION_FUNC, "", false, "", fgOptRunway },
1268 {"vor", true, OPTION_FUNC, "", false, "", fgOptVOR },
1269 {"ndb", true, OPTION_FUNC, "", false, "", fgOptNDB },
1270 {"carrier", true, OPTION_FUNC, "", false, "", fgOptCarrier },
1271 {"parkpos", true, OPTION_FUNC, "", false, "", fgOptParkpos },
1272 {"fix", true, OPTION_FUNC, "", false, "", fgOptFIX },
1273 {"offset-distance", true, OPTION_DOUBLE, "/sim/presets/offset-distance", false, "", 0 },
1274 {"offset-azimuth", true, OPTION_DOUBLE, "/sim/presets/offset-azimuth", false, "", 0 },
1275 {"lon", true, OPTION_FUNC, "", false, "", fgOptLon },
1276 {"lat", true, OPTION_FUNC, "", false, "", fgOptLat },
1277 {"altitude", true, OPTION_FUNC, "", false, "", fgOptAltitude },
1278 {"uBody", true, OPTION_FUNC, "", false, "", fgOptUBody },
1279 {"vBody", true, OPTION_FUNC, "", false, "", fgOptVBody },
1280 {"wBody", true, OPTION_FUNC, "", false, "", fgOptWBody },
1281 {"vNorth", true, OPTION_FUNC, "", false, "", fgOptVNorth },
1282 {"vEast", true, OPTION_FUNC, "", false, "", fgOptVEast },
1283 {"vDown", true, OPTION_FUNC, "", false, "", fgOptVDown },
1284 {"vc", true, OPTION_FUNC, "", false, "", fgOptVc },
1285 {"mach", true, OPTION_FUNC, "", false, "", fgOptMach },
1286 {"heading", true, OPTION_DOUBLE, "/sim/presets/heading-deg", false, "", 0 },
1287 {"roll", true, OPTION_DOUBLE, "/sim/presets/roll-deg", false, "", 0 },
1288 {"pitch", true, OPTION_DOUBLE, "/sim/presets/pitch-deg", false, "", 0 },
1289 {"glideslope", true, OPTION_DOUBLE, "/sim/presets/glideslope-deg", false, "", 0 },
1290 {"roc", true, OPTION_FUNC, "", false, "", fgOptRoc },
1291 {"fg-root", true, OPTION_FUNC, "", false, "", fgOptFgRoot },
1292 {"fg-scenery", true, OPTION_FUNC, "", false, "", fgOptFgScenery },
1293 {"fdm", true, OPTION_STRING, "/sim/flight-model", false, "", 0 },
1294 {"aero", true, OPTION_STRING, "/sim/aero", false, "", 0 },
1295 {"aircraft-dir", true, OPTION_STRING, "/sim/aircraft-dir", false, "", 0 },
1296 {"model-hz", true, OPTION_INT, "/sim/model-hz", false, "", 0 },
1297 {"speed", true, OPTION_INT, "/sim/speed-up", false, "", 0 },
1298 {"trim", false, OPTION_BOOL, "/sim/presets/trim", true, "", 0 },
1299 {"notrim", false, OPTION_BOOL, "/sim/presets/trim", false, "", 0 },
1300 {"on-ground", false, OPTION_BOOL, "/sim/presets/onground", true, "", 0 },
1301 {"in-air", false, OPTION_BOOL, "/sim/presets/onground", false, "", 0 },
1302 {"fog-disable", false, OPTION_STRING, "/sim/rendering/fog", false, "disabled", 0 },
1303 {"fog-fastest", false, OPTION_STRING, "/sim/rendering/fog", false, "fastest", 0 },
1304 {"fog-nicest", false, OPTION_STRING, "/sim/rendering/fog", false, "nicest", 0 },
1305 {"disable-horizon-effect", false, OPTION_BOOL, "/sim/rendering/horizon-effect", false, "", 0 },
1306 {"enable-horizon-effect", false, OPTION_BOOL, "/sim/rendering/horizon-effect", true, "", 0 },
1307 {"disable-enhanced-lighting", false, OPTION_BOOL, "/sim/rendering/enhanced-lighting", false, "", 0 },
1308 {"enable-enhanced-lighting", false, OPTION_BOOL, "/sim/rendering/enhanced-lighting", true, "", 0 },
1309 {"disable-distance-attenuation", false, OPTION_BOOL, "/sim/rendering/distance-attenuation", false, "", 0 },
1310 {"enable-distance-attenuation", false, OPTION_BOOL, "/sim/rendering/distance-attenuation", true, "", 0 },
1311 {"disable-specular-highlight", false, OPTION_BOOL, "/sim/rendering/specular-highlight", false, "", 0 },
1312 {"enable-specular-highlight", false, OPTION_BOOL, "/sim/rendering/specular-highlight", true, "", 0 },
1313 {"disable-clouds", false, OPTION_BOOL, "/environment/clouds/status", false, "", 0 },
1314 {"enable-clouds", false, OPTION_BOOL, "/environment/clouds/status", true, "", 0 },
1315 {"disable-clouds3d", false, OPTION_BOOL, "/sim/rendering/clouds3d-enable", false, "", 0 },
1316 {"enable-clouds3d", false, OPTION_BOOL, "/sim/rendering/clouds3d-enable", true, "", 0 },
1317 {"fov", true, OPTION_FUNC, "", false, "", fgOptFov },
1318 {"aspect-ratio-multiplier", true, OPTION_DOUBLE, "/sim/current-view/aspect-ratio-multiplier", false, "", 0 },
1319 {"disable-fullscreen", false, OPTION_BOOL, "/sim/startup/fullscreen", false, "", 0 },
1320 {"enable-fullscreen", false, OPTION_BOOL, "/sim/startup/fullscreen", true, "", 0 },
1321 {"disable-save-on-exit", false, OPTION_BOOL, "/sim/startup/save-on-exit", false, "", 0 },
1322 {"enable-save-on-exit", false, OPTION_BOOL, "/sim/startup/save-on-exit", true, "", 0 },
1323 {"shading-flat", false, OPTION_BOOL, "/sim/rendering/shading", false, "", 0 },
1324 {"shading-smooth", false, OPTION_BOOL, "/sim/rendering/shading", true, "", 0 },
1325 {"disable-skyblend", false, OPTION_BOOL, "/sim/rendering/skyblend", false, "", 0 },
1326 {"enable-skyblend", false, OPTION_BOOL, "/sim/rendering/skyblend", true, "", 0 },
1327 {"disable-textures", false, OPTION_BOOL, "/sim/rendering/textures", false, "", 0 },
1328 {"enable-textures", false, OPTION_BOOL, "/sim/rendering/textures", true, "", 0 },
1329 {"disable-wireframe", false, OPTION_BOOL, "/sim/rendering/wireframe", false, "", 0 },
1330 {"enable-wireframe", false, OPTION_BOOL, "/sim/rendering/wireframe", true, "", 0 },
1331 {"geometry", true, OPTION_FUNC, "", false, "", fgOptGeometry },
1332 {"bpp", true, OPTION_FUNC, "", false, "", fgOptBpp },
1333 {"units-feet", false, OPTION_STRING, "/sim/startup/units", false, "feet", 0 },
1334 {"units-meters", false, OPTION_STRING, "/sim/startup/units", false, "meters", 0 },
1335 {"timeofday", true, OPTION_STRING, "/sim/startup/time-offset-type", false, "noon", 0 },
1336 {"season", true, OPTION_STRING, "/sim/startup/season", false, "summer", 0 },
1337 {"time-offset", true, OPTION_FUNC, "", false, "", fgOptTimeOffset },
1338 {"time-match-real", false, OPTION_STRING, "/sim/startup/time-offset-type", false, "system-offset", 0 },
1339 {"time-match-local", false, OPTION_STRING, "/sim/startup/time-offset-type", false, "latitude-offset", 0 },
1340 {"start-date-sys", true, OPTION_FUNC, "", false, "", fgOptStartDateSys },
1341 {"start-date-lat", true, OPTION_FUNC, "", false, "", fgOptStartDateLat },
1342 {"start-date-gmt", true, OPTION_FUNC, "", false, "", fgOptStartDateGmt },
1343 {"hud-tris", false, OPTION_STRING, "/sim/hud/frame-stat-type", false, "tris", 0 },
1344 {"hud-culled", false, OPTION_STRING, "/sim/hud/frame-stat-type", false, "culled", 0 },
1345 {"atcsim", true, OPTION_CHANNEL, "", false, "dummy", 0 },
1346 {"atlas", true, OPTION_CHANNEL, "", false, "", 0 },
1347 {"httpd", true, OPTION_CHANNEL, "", false, "", 0 },
1348 #ifdef FG_JPEG_SERVER
1349 {"jpg-httpd", true, OPTION_CHANNEL, "", false, "", 0 },
1351 {"native", true, OPTION_CHANNEL, "", false, "", 0 },
1352 {"native-ctrls", true, OPTION_CHANNEL, "", false, "", 0 },
1353 {"native-fdm", true, OPTION_CHANNEL, "", false, "", 0 },
1354 {"native-gui", true, OPTION_CHANNEL, "", false, "", 0 },
1355 {"opengc", true, OPTION_CHANNEL, "", false, "", 0 },
1356 {"AV400", true, OPTION_CHANNEL, "", false, "", 0 },
1357 {"garmin", true, OPTION_CHANNEL, "", false, "", 0 },
1358 {"nmea", true, OPTION_CHANNEL, "", false, "", 0 },
1359 {"generic", true, OPTION_CHANNEL, "", false, "", 0 },
1360 {"props", true, OPTION_CHANNEL, "", false, "", 0 },
1361 {"telnet", true, OPTION_CHANNEL, "", false, "", 0 },
1362 {"pve", true, OPTION_CHANNEL, "", false, "", 0 },
1363 {"ray", true, OPTION_CHANNEL, "", false, "", 0 },
1364 {"rul", true, OPTION_CHANNEL, "", false, "", 0 },
1365 {"joyclient", true, OPTION_CHANNEL, "", false, "", 0 },
1366 {"jsclient", true, OPTION_CHANNEL, "", false, "", 0 },
1367 {"proxy", true, OPTION_FUNC, "", false, "", fgSetupProxy },
1368 {"callsign", true, OPTION_STRING, "sim/multiplay/callsign", false, "", 0 },
1369 {"multiplay", true, OPTION_CHANNEL, "", false, "", 0 },
1370 {"trace-read", true, OPTION_FUNC, "", false, "", fgOptTraceRead },
1371 {"trace-write", true, OPTION_FUNC, "", false, "", fgOptTraceWrite },
1372 {"log-level", true, OPTION_FUNC, "", false, "", fgOptLogLevel },
1373 {"view-offset", true, OPTION_FUNC, "", false, "", fgOptViewOffset },
1374 {"visibility", true, OPTION_FUNC, "", false, "", fgOptVisibilityMeters },
1375 {"visibility-miles", true, OPTION_FUNC, "", false, "", fgOptVisibilityMiles },
1376 {"random-wind", false, OPTION_FUNC, "", false, "", fgOptRandomWind },
1377 {"wind", true, OPTION_FUNC, "", false, "", fgOptWind },
1378 {"turbulence", true, OPTION_FUNC, "", false, "", fgOptTurbulence },
1379 {"ceiling", true, OPTION_FUNC, "", false, "", fgOptCeiling },
1380 {"wp", true, OPTION_FUNC, "", false, "", fgOptWp },
1381 {"flight-plan", true, OPTION_FUNC, "", false, "", fgOptFlightPlan },
1382 {"config", true, OPTION_FUNC, "", false, "", fgOptConfig },
1383 {"aircraft", true, OPTION_STRING, "/sim/aircraft", false, "", 0 },
1384 {"failure", true, OPTION_FUNC, "", false, "", fgOptFailure },
1385 {"com1", true, OPTION_DOUBLE, "/instrumentation/comm[0]/frequencies/selected-mhz", false, "", 0 },
1386 {"com2", true, OPTION_DOUBLE, "/instrumentation/comm[1]/frequencies/selected-mhz", false, "", 0 },
1387 {"nav1", true, OPTION_FUNC, "", false, "", fgOptNAV1 },
1388 {"nav2", true, OPTION_FUNC, "", false, "", fgOptNAV2 },
1389 {"adf", true, OPTION_FUNC, "", false, "", fgOptADF },
1390 {"dme", true, OPTION_FUNC, "", false, "", fgOptDME },
1391 {"min-status", true, OPTION_STRING, "/sim/aircraft-min-status", false, "all", 0 },
1392 {"livery", true, OPTION_FUNC, "", false, "", fgOptLivery },
1393 {"ai-scenario", true, OPTION_FUNC, "", false, "", fgOptScenario },
1398 // Parse a single option
1400 parse_option (const string& arg)
1402 if ( fgOptionMap.size() == 0 ) {
1404 OptionDesc *pt = &fgOptionArray[ 0 ];
1405 while ( pt->option != 0 ) {
1406 fgOptionMap[ pt->option ] = i;
1413 if ( (arg == "--help") || (arg == "-h") ) {
1414 // help/usage request
1415 return(FG_OPTIONS_HELP);
1416 } else if ( (arg == "--verbose") || (arg == "-v") ) {
1417 // verbose help/usage request
1418 return(FG_OPTIONS_VERBOSE_HELP);
1419 } else if ( arg.find( "--show-aircraft") == 0) {
1420 return(FG_OPTIONS_SHOW_AIRCRAFT);
1421 } else if ( arg.find( "--prop:" ) == 0 ) {
1422 string assign = arg.substr(7);
1423 string::size_type pos = assign.find('=');
1424 if ( pos == arg.npos || pos == 0 || pos + 1 == assign.size() ) {
1425 SG_LOG( SG_GENERAL, SG_ALERT, "Bad property assignment: " << arg );
1426 return FG_OPTIONS_ERROR;
1428 string name = assign.substr(0, pos);
1429 string value = assign.substr(pos + 1);
1430 fgSetString(name.c_str(), value.c_str());
1432 } else if ( arg.find( "--" ) == 0 ) {
1433 size_t pos = arg.find( '=' );
1435 if ( pos == string::npos ) {
1436 arg_name = arg.substr( 2 );
1438 arg_name = arg.substr( 2, pos - 2 );
1440 map<string,size_t>::iterator it = fgOptionMap.find( arg_name );
1441 if ( it != fgOptionMap.end() ) {
1442 OptionDesc *pt = &fgOptionArray[ it->second ];
1443 switch ( pt->type ) {
1445 fgSetBool( pt->property, pt->b_param );
1448 if ( pt->has_param && pos != string::npos && pos + 1 < arg.size() ) {
1449 fgSetString( pt->property, arg.substr( pos + 1 ).c_str() );
1450 } else if ( !pt->has_param && pos == string::npos ) {
1451 fgSetString( pt->property, pt->s_param );
1452 } else if ( pt->has_param ) {
1453 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << arg << "' needs a parameter" );
1454 return FG_OPTIONS_ERROR;
1456 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << arg << "' does not have a parameter" );
1457 return FG_OPTIONS_ERROR;
1461 if ( pos != string::npos && pos + 1 < arg.size() ) {
1462 fgSetDouble( pt->property, atof( arg.substr( pos + 1 ) ) );
1464 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << arg << "' needs a parameter" );
1465 return FG_OPTIONS_ERROR;
1469 if ( pos != string::npos && pos + 1 < arg.size() ) {
1470 fgSetInt( pt->property, atoi( arg.substr( pos + 1 ) ) );
1472 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << arg << "' needs a parameter" );
1473 return FG_OPTIONS_ERROR;
1476 case OPTION_CHANNEL:
1477 if ( pt->has_param && pos != string::npos && pos + 1 < arg.size() ) {
1478 add_channel( pt->option, arg.substr( pos + 1 ) );
1479 } else if ( !pt->has_param && pos == string::npos ) {
1480 add_channel( pt->option, pt->s_param );
1481 } else if ( pt->has_param ) {
1482 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << arg << "' needs a parameter" );
1483 return FG_OPTIONS_ERROR;
1485 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << arg << "' does not have a parameter" );
1486 return FG_OPTIONS_ERROR;
1490 if ( pt->has_param && pos != string::npos && pos + 1 < arg.size() ) {
1491 return pt->func( arg.substr( pos + 1 ).c_str() );
1492 } else if ( !pt->has_param && pos == string::npos ) {
1493 return pt->func( 0 );
1494 } else if ( pt->has_param ) {
1495 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << arg << "' needs a parameter" );
1496 return FG_OPTIONS_ERROR;
1498 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << arg << "' does not have a parameter" );
1499 return FG_OPTIONS_ERROR;
1504 SG_LOG( SG_GENERAL, SG_ALERT, "Unknown option '" << arg << "'" );
1505 return FG_OPTIONS_ERROR;
1508 SG_LOG( SG_GENERAL, SG_ALERT, "Unknown option '" << arg << "'" );
1509 return FG_OPTIONS_ERROR;
1512 return FG_OPTIONS_OK;
1516 // Parse the command line options
1518 fgParseArgs (int argc, char **argv)
1520 bool in_options = true;
1521 bool verbose = false;
1524 SG_LOG(SG_GENERAL, SG_INFO, "Processing command line arguments");
1526 for (int i = 1; i < argc; i++) {
1527 string arg = argv[i];
1529 if (in_options && (arg.find('-') == 0)) {
1533 int result = parse_option(arg);
1534 if ((result == FG_OPTIONS_HELP) || (result == FG_OPTIONS_ERROR))
1537 else if (result == FG_OPTIONS_VERBOSE_HELP)
1540 else if (result == FG_OPTIONS_SHOW_AIRCRAFT) {
1541 fgOptLogLevel( "alert" );
1542 SGPath path( globals->get_fg_root() );
1543 path.append("Aircraft");
1544 fgShowAircraft(path, true);
1550 SG_LOG(SG_GENERAL, SG_INFO,
1551 "Reading command-line property file " << arg);
1552 readProperties(arg, globals->get_props());
1557 fgOptLogLevel( "alert" );
1562 SG_LOG(SG_GENERAL, SG_INFO, "Finished command line arguments");
1566 // Parse config file options
1568 fgParseOptions (const string& path) {
1569 sg_gzifstream in( path );
1570 if ( !in.is_open() ) {
1574 SG_LOG( SG_GENERAL, SG_INFO, "Processing config file: " << path );
1578 while ( ! in.eof() ) {
1581 while ( in.get(c) && c != '\0' ) {
1586 #if defined( macintosh )
1587 getline( in, line, '\r' );
1589 getline( in, line, '\n' );
1592 // catch extraneous (DOS) line ending character
1594 for (i = line.length(); i > 0; i--)
1595 if (line[i - 1] > 32)
1597 line = line.substr( 0, i );
1599 if ( parse_option( line ) == FG_OPTIONS_ERROR ) {
1600 cerr << endl << "Config file parse error: " << path << " '"
1601 << line << "'" << endl;
1610 // Print usage message
1612 fgUsage (bool verbose)
1614 SGPropertyNode *locale = globals->get_locale();
1616 SGPropertyNode options_root;
1618 SG_LOG( SG_GENERAL, SG_ALERT, "" ); // To popup the console on Windows
1622 fgLoadProps("options.xml", &options_root);
1623 } catch (const sg_exception &) {
1624 cout << "Unable to read the help file." << endl;
1625 cout << "Make sure the file options.xml is located in the FlightGear base directory," << endl;
1626 cout << "and the location of the base directory is specified by setting $FG_ROOT or" << endl;
1627 cout << "by adding --fg-root=path as a program argument." << endl;
1632 SGPropertyNode *options = options_root.getNode("options");
1634 SG_LOG( SG_GENERAL, SG_ALERT,
1635 "Error reading options.xml: <options> directive not found." );
1639 SGPropertyNode *usage = locale->getNode(options->getStringValue("usage"));
1641 cout << "Usage: " << usage->getStringValue() << endl;
1644 vector<SGPropertyNode_ptr>section = options->getChildren("section");
1645 for (unsigned int j = 0; j < section.size(); j++) {
1648 vector<SGPropertyNode_ptr>option = section[j]->getChildren("option");
1649 for (unsigned int k = 0; k < option.size(); k++) {
1651 SGPropertyNode *name = option[k]->getNode("name");
1652 SGPropertyNode *short_name = option[k]->getNode("short");
1653 SGPropertyNode *key = option[k]->getNode("key");
1654 SGPropertyNode *arg = option[k]->getNode("arg");
1655 bool brief = option[k]->getNode("brief") != 0;
1657 if ((brief || verbose) && name) {
1658 string tmp = name->getStringValue();
1662 tmp.append(key->getStringValue());
1666 tmp.append(arg->getStringValue());
1670 tmp.append(short_name->getStringValue());
1673 if (tmp.size() <= 25) {
1676 msg.append( 27-tmp.size(), ' ');
1680 msg.append(32, ' ');
1682 // There may be more than one <description> tag assosiated
1685 vector<SGPropertyNode_ptr> desc;
1686 desc = option[k]->getChildren("description");
1687 if (desc.size() > 0) {
1688 for ( unsigned int l = 0; l < desc.size(); l++) {
1690 // There may be more than one translation line.
1692 string t = desc[l]->getStringValue();
1693 SGPropertyNode *n = locale->getNode("strings");
1694 vector<SGPropertyNode_ptr>trans_desc =
1695 n->getChildren(t.substr(8).c_str());
1697 for ( unsigned int m = 0; m < trans_desc.size(); m++ ) {
1698 string t_str = trans_desc[m]->getStringValue();
1700 if ((m > 0) || ((l > 0) && m == 0)) {
1701 msg.append( 32, ' ');
1704 // If the string is too large to fit on the screen,
1705 // then split it up in several pieces.
1707 while ( t_str.size() > 47 ) {
1709 unsigned int m = t_str.rfind(' ', 47);
1710 msg += t_str.substr(0, m) + '\n';
1711 msg.append( 32, ' ');
1713 t_str.erase(t_str.begin(), t_str.begin() + m + 1);
1715 msg += t_str + '\n';
1722 SGPropertyNode *name;
1723 name = locale->getNode(section[j]->getStringValue("name"));
1725 if (!msg.empty() && name) {
1726 cout << endl << name->getStringValue() << ":" << endl;
1734 cout << "For a complete list of options use --help --verbose" << endl;
1737 cout << "Hit a key to continue..." << endl;
1742 // A simple function to return an integer depending on the position
1743 // of the status string within the array in order to determine the hierarchy.
1744 unsigned int getNumMaturity(const char * str)
1746 // changes should also be reflected in $FG_ROOT/data/options.xml &
1747 // $FG_ROOT/data/Translations/string-default.xml
1748 const char levels[][20]= {"alpha","beta","early-production","production",0};
1750 for (unsigned int i=0; i<(sizeof(levels)/sizeof(levels[0])-1);i++)
1751 if (strcmp(str,levels[i])==0)
1758 static void fgSearchAircraft(const SGPath &path, string_list &aircraft,
1763 ulDir *dirp = ulOpenDir(path.str().c_str());
1765 cerr << "Unable to open aircraft directory '" << path.str() << '\'' << endl;
1769 while ((dire = ulReadDir(dirp)) != NULL) {
1772 if (dire->d_isdir) {
1773 if (recursive && strcmp("CVS", dire->d_name)
1774 && strcmp(".", dire->d_name) && strcmp("..", dire->d_name))
1777 next.append(dire->d_name);
1779 fgSearchAircraft(next, aircraft, true);
1781 } else if ((ptr = strstr(dire->d_name, "-set.xml")) && (ptr[8] == '\0')) {
1783 SGPath afile = path;
1784 afile.append(dire->d_name);
1788 SGPropertyNode root;
1790 readProperties(afile.str(), &root);
1795 SGPropertyNode *desc = NULL;
1796 SGPropertyNode *status = NULL;
1798 SGPropertyNode *node = root.getNode("sim");
1800 desc = node->getNode("description");
1801 // if a status tag is found, read it in
1802 if (node->hasValue("status"))
1803 status = node->getNode("status");
1806 //additionally display status information where it is available
1808 string descStr(" ");
1809 descStr += dire->d_name;
1811 if (descStr.size() <= 27+3) {
1812 descStr.append(29+3-descStr.size(), ' ');
1815 descStr.append( 32, ' ');
1817 descStr += desc->getStringValue();
1820 SGPropertyNode * required_status
1821 = fgGetNode ("/sim/aircraft-min-status", true);
1823 // If the node holds the value "all", then there wasn't any status
1824 // level specified, so we simply go ahead and output ALL aircraft
1825 if (strcmp(required_status->getStringValue(),"all")==0) {
1826 aircraft.push_back(descStr);
1830 // If the node doesn't hold "all" as its value, then we are supposed
1831 // to show only aircraft meeting specific status (development status)
1834 if (node->hasValue("status")) {
1835 //Compare (minimally) required status level with actual aircraft status:
1836 if ( getNumMaturity(status->getStringValue() ) >=
1837 getNumMaturity(required_status->getStringValue() ) )
1838 aircraft.push_back(descStr); }
1850 * Search in the current directory, and in on directory deeper
1851 * for <aircraft>-set.xml configuration files and show the aircaft name
1852 * and the contents of the<description> tag in a sorted manner.
1854 * @parampath the directory to search for configuration files
1855 * @param recursive defines whether the directory should be searched recursively
1857 void fgShowAircraft(const SGPath &path, bool recursive) {
1858 string_list aircraft;
1860 fgSearchAircraft( path, aircraft, recursive );
1862 sort(aircraft.begin(), aircraft.end());
1863 SG_LOG( SG_GENERAL, SG_ALERT, "" ); // To popup the console on Windows
1864 cout << "Available aircraft:" << endl;
1865 for ( unsigned int i = 0; i < aircraft.size(); i++ ) {
1866 cout << aircraft[i] << endl;
1869 cout << "Hit a key to continue..." << endl;