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>
31 #include <simgear/timing/sg_time.hxx>
32 #include <simgear/misc/sg_dir.hxx>
34 #include <boost/foreach.hpp>
36 #include <math.h> // rint()
38 #include <stdlib.h> // atof(), atoi()
39 #include <string.h> // strcmp()
45 #include <simgear/math/sg_random.h>
46 #include <simgear/props/props_io.hxx>
47 #include <simgear/misc/sgstream.hxx>
48 #include <simgear/misc/sg_path.hxx>
49 #include <simgear/scene/material/mat.hxx>
50 #include <simgear/sound/soundmgr_openal.hxx>
51 #include <simgear/misc/strutils.hxx>
52 #include <Autopilot/route_mgr.hxx>
55 #include "globals.hxx"
56 #include "fg_init.hxx"
57 #include "fg_props.hxx"
58 #include "options.hxx"
62 #include <Viewer/viewer.hxx>
63 #include <Viewer/viewmgr.hxx>
64 #include <Environment/presets.hxx>
66 #include <osg/Version>
68 #if defined( HAVE_VERSION_H ) && HAVE_VERSION_H
69 # include <Include/version.h>
70 # include <simgear/version.h>
72 # include <Include/no_version.h>
76 # include <CoreFoundation/CoreFoundation.h>
87 #define NEW_DEFAULT_MODEL_HZ 120
95 FG_OPTIONS_VERBOSE_HELP = 4,
96 FG_OPTIONS_SHOW_AIRCRAFT = 5,
97 FG_OPTIONS_SHOW_SOUND_DEVICES = 6
100 static flightgear::Options* shared_instance = NULL;
103 atof( const string& str )
105 return ::atof( str.c_str() );
109 atoi( const string& str )
111 return ::atoi( str.c_str() );
114 static int fgSetupProxy( const char *arg );
117 * Set a few fail-safe default property values.
119 * These should all be set in $FG_ROOT/preferences.xml, but just
120 * in case, we provide some initial sane values here. This method
121 * should be invoked *before* reading any init files.
127 // Position (deliberately out of range)
128 fgSetDouble("/position/longitude-deg", 9999.0);
129 fgSetDouble("/position/latitude-deg", 9999.0);
130 fgSetDouble("/position/altitude-ft", -9999.0);
133 fgSetDouble("/orientation/heading-deg", 9999.0);
134 fgSetDouble("/orientation/roll-deg", 0.0);
135 fgSetDouble("/orientation/pitch-deg", 0.424);
138 fgSetDouble("/velocities/uBody-fps", 0.0);
139 fgSetDouble("/velocities/vBody-fps", 0.0);
140 fgSetDouble("/velocities/wBody-fps", 0.0);
141 fgSetDouble("/velocities/speed-north-fps", 0.0);
142 fgSetDouble("/velocities/speed-east-fps", 0.0);
143 fgSetDouble("/velocities/speed-down-fps", 0.0);
144 fgSetDouble("/velocities/airspeed-kt", 0.0);
145 fgSetDouble("/velocities/mach", 0.0);
148 fgSetDouble("/sim/presets/longitude-deg", 9999.0);
149 fgSetDouble("/sim/presets/latitude-deg", 9999.0);
150 fgSetDouble("/sim/presets/altitude-ft", -9999.0);
152 fgSetDouble("/sim/presets/heading-deg", 9999.0);
153 fgSetDouble("/sim/presets/roll-deg", 0.0);
154 fgSetDouble("/sim/presets/pitch-deg", 0.424);
156 fgSetString("/sim/presets/speed-set", "knots");
157 fgSetDouble("/sim/presets/airspeed-kt", 0.0);
158 fgSetDouble("/sim/presets/mach", 0.0);
159 fgSetDouble("/sim/presets/uBody-fps", 0.0);
160 fgSetDouble("/sim/presets/vBody-fps", 0.0);
161 fgSetDouble("/sim/presets/wBody-fps", 0.0);
162 fgSetDouble("/sim/presets/speed-north-fps", 0.0);
163 fgSetDouble("/sim/presets/speed-east-fps", 0.0);
164 fgSetDouble("/sim/presets/speed-down-fps", 0.0);
166 fgSetBool("/sim/presets/onground", true);
167 fgSetBool("/sim/presets/trim", false);
170 fgSetBool("/sim/startup/game-mode", false);
171 fgSetBool("/sim/startup/splash-screen", true);
172 fgSetBool("/sim/startup/intro-music", true);
173 // we want mouse-pointer to have an undefined value if nothing is
174 // specified so we can do the right thing for voodoo-1/2 cards.
175 // fgSetString("/sim/startup/mouse-pointer", "disabled");
176 fgSetString("/sim/control-mode", "joystick");
177 fgSetBool("/controls/flight/auto-coordination", false);
179 fgSetString("/sim/startup/browser-app", "webrun.bat");
180 #elif defined(__APPLE__)
181 fgSetString("/sim/startup/browser-app", "open");
183 fgSetString("/sim/startup/browser-app", "launchWebJumper");
185 const char* browserEnv = ::getenv( "WEBBROWSER" );
186 if (!browserEnv) browserEnv = "netscape";
187 fgSetString("/sim/startup/browser-app", browserEnv);
189 fgSetString("/sim/logging/priority", "alert");
192 fgSetBool("/sim/hud/color/antialiased", false);
193 fgSetBool("/sim/hud/enable3d[1]", true);
194 fgSetBool("/sim/hud/visibility[1]", false);
195 fgSetBool("/sim/panel/visibility", true);
196 fgSetBool("/sim/sound/enabled", true);
197 fgSetBool("/sim/sound/working", true);
199 // Flight Model options
200 fgSetString("/sim/flight-model", "jsb");
201 fgSetString("/sim/aero", "c172");
202 fgSetInt("/sim/model-hz", NEW_DEFAULT_MODEL_HZ);
203 fgSetInt("/sim/speed-up", 1);
206 fgSetString("/sim/rendering/fog", "nicest");
207 fgSetBool("/environment/clouds/status", true);
208 fgSetBool("/sim/startup/fullscreen", false);
209 fgSetBool("/sim/rendering/shading", true);
210 fgSetBool("/sim/rendering/skyblend", true);
211 fgSetBool("/sim/rendering/textures", true);
212 fgTie( "/sim/rendering/filtering", SGGetTextureFilter, SGSetTextureFilter, false);
213 fgSetInt("/sim/rendering/filtering", 1);
214 fgSetBool("/sim/rendering/wireframe", false);
215 fgSetBool("/sim/rendering/horizon-effect", false);
216 fgSetBool("/sim/rendering/enhanced-lighting", false);
217 fgSetBool("/sim/rendering/distance-attenuation", false);
218 fgSetBool("/sim/rendering/specular-highlight", true);
219 fgSetString("/sim/rendering/materials-file", "materials.xml");
220 fgSetInt("/sim/startup/xsize", 800);
221 fgSetInt("/sim/startup/ysize", 600);
222 fgSetInt("/sim/rendering/bits-per-pixel", 16);
223 fgSetString("/sim/view-mode", "pilot");
224 fgSetDouble("/sim/current-view/heading-offset-deg", 0);
227 fgSetString("/sim/startup/units", "feet");
228 fgSetString("/sim/hud/frame-stat-type", "tris");
231 fgSetInt("/sim/startup/time-offset", 0);
232 fgSetString("/sim/startup/time-offset-type", "system-offset");
233 fgSetLong("/sim/time/cur-time-override", 0);
236 fgSetBool("/sim/freeze/master", false);
237 fgSetBool("/sim/freeze/position", false);
238 fgSetBool("/sim/freeze/clock", false);
239 fgSetBool("/sim/freeze/fuel", false);
241 fgSetString("/sim/multiplay/callsign", "callsign");
242 fgSetString("/sim/multiplay/rxhost", "");
243 fgSetString("/sim/multiplay/txhost", "");
244 fgSetInt("/sim/multiplay/rxport", 0);
245 fgSetInt("/sim/multiplay/txport", 0);
247 fgSetString("/sim/version/flightgear", FLIGHTGEAR_VERSION);
248 fgSetString("/sim/version/simgear", SG_STRINGIZE(SIMGEAR_VERSION));
249 fgSetString("/sim/version/openscenegraph", osgGetVersion());
250 fgSetString("/sim/version/revision", REVISION);
251 fgSetInt("/sim/version/build-number", HUDSON_BUILD_NUMBER);
252 fgSetString("/sim/version/build-id", HUDSON_BUILD_ID);
254 char* envp = ::getenv( "http_proxy" );
256 fgSetupProxy( envp );
260 parse_wind (const string &wind, double * min_hdg, double * max_hdg,
261 double * speed, double * gust)
263 string::size_type pos = wind.find('@');
264 if (pos == string::npos)
266 string dir = wind.substr(0, pos);
267 string spd = wind.substr(pos+1);
269 if (pos == string::npos) {
270 *min_hdg = *max_hdg = atof(dir.c_str());
272 *min_hdg = atof(dir.substr(0,pos).c_str());
273 *max_hdg = atof(dir.substr(pos+1).c_str());
276 if (pos == string::npos) {
277 *speed = *gust = atof(spd.c_str());
279 *speed = atof(spd.substr(0,pos).c_str());
280 *gust = atof(spd.substr(pos+1).c_str());
286 parseIntValue(char** ppParserPos, int* pValue,int min, int max, const char* field, const char* argument)
288 if ( !strlen(*ppParserPos) )
294 while ( isdigit((*ppParserPos)[0]) && (i<255) )
296 num[i] = (*ppParserPos)[0];
302 switch ((*ppParserPos)[0])
310 SG_LOG(SG_GENERAL, SG_ALERT, "Illegal character in time string for " << field << ": '" <<
311 (*ppParserPos)[0] << "'.");
312 // invalid field - skip rest of string to avoid further errors
313 while ((*ppParserPos)[0])
321 int value = atoi(num);
322 if ((value < min)||(value > max))
324 SG_LOG(SG_GENERAL, SG_ALERT, "Invalid " << field << " in '" << argument <<
325 "'. Valid range is " << min << "-" << max << ".");
335 // parse a time string ([+/-]%f[:%f[:%f]]) into hours
337 parse_time(const string& time_in) {
338 char *time_str, num[256];
339 double hours, minutes, seconds;
344 time_str = (char *)time_in.c_str();
346 // printf("parse_time(): %s\n", time_str);
349 if ( strlen(time_str) ) {
350 if ( time_str[0] == '+' ) {
353 } else if ( time_str[0] == '-' ) {
358 // printf("sign = %d\n", sign);
361 if ( strlen(time_str) ) {
363 while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
364 num[i] = time_str[0];
368 if ( time_str[0] == ':' ) {
373 // printf("hours = %.2lf\n", hours);
379 if ( strlen(time_str) ) {
381 while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
382 num[i] = time_str[0];
386 if ( time_str[0] == ':' ) {
391 // printf("minutes = %.2lf\n", minutes);
393 result += minutes / 60.0;
397 if ( strlen(time_str) ) {
399 while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
400 num[i] = time_str[0];
406 // printf("seconds = %.2lf\n", seconds);
408 result += seconds / 3600.0;
411 SG_LOG( SG_GENERAL, SG_INFO, " parse_time() = " << sign * result );
413 return(sign * result);
416 // parse a date string (yyyy:mm:dd:hh:mm:ss) into a time_t (seconds)
418 parse_date( const string& date, const char* timeType)
420 struct tm gmt,*pCurrentTime;
421 int year,month,day,hour,minute,second;
422 char *argument, *date_str;
424 SGTime CurrentTime = SGTime();
425 CurrentTime.update(0,0,0,0);
427 // FIXME This should obtain system/aircraft/GMT time depending on timeType
428 pCurrentTime = CurrentTime.getGmt();
430 // initialize all fields with current time
431 year = pCurrentTime->tm_year + 1900;
432 month = pCurrentTime->tm_mon + 1;
433 day = pCurrentTime->tm_mday;
434 hour = pCurrentTime->tm_hour;
435 minute = pCurrentTime->tm_min;
436 second = pCurrentTime->tm_sec;
438 argument = (char *)date.c_str();
441 // start with parsing year
442 if (!strlen(date_str) ||
443 !parseIntValue(&date_str,&year,0,9999,"year",argument))
450 SG_LOG(SG_GENERAL, SG_ALERT, "Invalid year '" << year << "'. Use 1970 or later.");
454 parseIntValue(&date_str, &month, 1, 12, "month", argument);
455 parseIntValue(&date_str, &day, 1, 31, "day", argument);
456 parseIntValue(&date_str, &hour, 0, 23, "hour", argument);
457 parseIntValue(&date_str, &minute, 0, 59, "minute", argument);
458 parseIntValue(&date_str, &second, 0, 59, "second", argument);
464 gmt.tm_mon = month - 1;
465 gmt.tm_year = year -1900;
466 gmt.tm_isdst = 0; // ignore daylight savings time for the moment
468 time_t theTime = sgTimeGetGMT( gmt.tm_year, gmt.tm_mon, gmt.tm_mday,
469 gmt.tm_hour, gmt.tm_min, gmt.tm_sec );
471 SG_LOG(SG_GENERAL, SG_INFO, "Configuring startup time to " << ctime(&theTime));
477 // parse angle in the form of [+/-]ddd:mm:ss into degrees
479 parse_degree( const string& degree_str) {
480 double result = parse_time( degree_str );
482 // printf("Degree = %.4f\n", result);
488 // parse time offset string into seconds
490 parse_time_offset( const string& time_str) {
493 // printf("time offset = %s\n", time_str);
496 result = (int)rint(parse_time(time_str) * 3600.0);
498 result = (int)(parse_time(time_str) * 3600.0);
501 // printf("parse_time_offset(): %d\n", result);
507 // Parse --fov=x.xx type option
509 parse_fov( const string& arg ) {
510 double fov = atof(arg);
512 if ( fov < FG_FOV_MIN ) { fov = FG_FOV_MIN; }
513 if ( fov > FG_FOV_MAX ) { fov = FG_FOV_MAX; }
515 fgSetDouble("/sim/view[0]/config/default-field-of-view-deg", fov);
517 // printf("parse_fov(): result = %.4f\n", fov);
523 // Parse I/O channel option
525 // Format is "--protocol=medium,direction,hz,medium_options,..."
527 // protocol = { native, nmea, garmin, AV400, AV400Sim, fgfs, rul, pve, etc. }
528 // medium = { serial, socket, file, etc. }
529 // direction = { in, out, bi }
530 // hz = number of times to process channel per second (floating
531 // point values are ok.
533 // Serial example "--nmea=serial,dir,hz,device,baud" where
535 // device = OS device name of serial line to be open()'ed
536 // baud = {300, 1200, 2400, ..., 230400}
538 // Socket exacmple "--native=socket,dir,hz,machine,port,style" where
540 // machine = machine name or ip address if client (leave empty if server)
541 // port = port, leave empty to let system choose
542 // style = tcp or udp
544 // File example "--garmin=file,dir,hz,filename" where
546 // filename = file system file name
549 add_channel( const string& type, const string& channel_str ) {
550 // This check is neccessary to prevent fgviewer from segfaulting when given
551 // weird options. (It doesn't run the full initailization)
552 if(!globals->get_channel_options_list())
554 SG_LOG(SG_GENERAL, SG_ALERT, "Option " << type << "=" << channel_str
558 SG_LOG(SG_GENERAL, SG_INFO, "Channel string = " << channel_str );
559 globals->get_channel_options_list()->push_back( type + "," + channel_str );
566 fgSetString("/sim/presets/airport-id", "");
567 fgSetString("/sim/presets/vor-id", "");
568 fgSetString("/sim/presets/ndb-id", "");
569 fgSetString("/sim/presets/carrier", "");
570 fgSetString("/sim/presets/parkpos", "");
571 fgSetString("/sim/presets/fix", "");
575 fgOptVOR( const char * arg )
578 fgSetString("/sim/presets/vor-id", arg);
579 return FG_OPTIONS_OK;
583 fgOptNDB( const char * arg )
586 fgSetString("/sim/presets/ndb-id", arg);
587 return FG_OPTIONS_OK;
591 fgOptCarrier( const char * arg )
594 fgSetString("/sim/presets/carrier", arg);
595 return FG_OPTIONS_OK;
599 fgOptParkpos( const char * arg )
601 fgSetString("/sim/presets/parkpos", arg);
602 return FG_OPTIONS_OK;
606 fgOptFIX( const char * arg )
609 fgSetString("/sim/presets/fix", arg);
610 return FG_OPTIONS_OK;
614 fgOptLon( const char *arg )
617 fgSetDouble("/sim/presets/longitude-deg", parse_degree( arg ));
618 fgSetDouble("/position/longitude-deg", parse_degree( arg ));
619 return FG_OPTIONS_OK;
623 fgOptLat( const char *arg )
626 fgSetDouble("/sim/presets/latitude-deg", parse_degree( arg ));
627 fgSetDouble("/position/latitude-deg", parse_degree( arg ));
628 return FG_OPTIONS_OK;
632 fgOptAltitude( const char *arg )
634 fgSetBool("/sim/presets/onground", false);
635 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
636 fgSetDouble("/sim/presets/altitude-ft", atof( arg ));
638 fgSetDouble("/sim/presets/altitude-ft",
639 atof( arg ) * SG_METER_TO_FEET);
640 return FG_OPTIONS_OK;
644 fgOptUBody( const char *arg )
646 fgSetString("/sim/presets/speed-set", "UVW");
647 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
648 fgSetDouble("/sim/presets/uBody-fps", atof( arg ));
650 fgSetDouble("/sim/presets/uBody-fps",
651 atof( arg ) * SG_METER_TO_FEET);
652 return FG_OPTIONS_OK;
656 fgOptVBody( const char *arg )
658 fgSetString("/sim/presets/speed-set", "UVW");
659 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
660 fgSetDouble("/sim/presets/vBody-fps", atof( arg ));
662 fgSetDouble("/sim/presets/vBody-fps",
663 atof( arg ) * SG_METER_TO_FEET);
664 return FG_OPTIONS_OK;
668 fgOptWBody( const char *arg )
670 fgSetString("/sim/presets/speed-set", "UVW");
671 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
672 fgSetDouble("/sim/presets/wBody-fps", atof(arg));
674 fgSetDouble("/sim/presets/wBody-fps",
675 atof(arg) * SG_METER_TO_FEET);
676 return FG_OPTIONS_OK;
680 fgOptVNorth( const char *arg )
682 fgSetString("/sim/presets/speed-set", "NED");
683 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
684 fgSetDouble("/sim/presets/speed-north-fps", atof( arg ));
686 fgSetDouble("/sim/presets/speed-north-fps",
687 atof( arg ) * SG_METER_TO_FEET);
688 return FG_OPTIONS_OK;
692 fgOptVEast( const char *arg )
694 fgSetString("/sim/presets/speed-set", "NED");
695 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
696 fgSetDouble("/sim/presets/speed-east-fps", atof(arg));
698 fgSetDouble("/sim/presets/speed-east-fps",
699 atof(arg) * SG_METER_TO_FEET);
700 return FG_OPTIONS_OK;
704 fgOptVDown( const char *arg )
706 fgSetString("/sim/presets/speed-set", "NED");
707 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
708 fgSetDouble("/sim/presets/speed-down-fps", atof(arg));
710 fgSetDouble("/sim/presets/speed-down-fps",
711 atof(arg) * SG_METER_TO_FEET);
712 return FG_OPTIONS_OK;
716 fgOptVc( const char *arg )
718 // fgSetString("/sim/presets/speed-set", "knots");
719 // fgSetDouble("/velocities/airspeed-kt", atof(arg.substr(5)));
720 fgSetString("/sim/presets/speed-set", "knots");
721 fgSetDouble("/sim/presets/airspeed-kt", atof(arg));
722 return FG_OPTIONS_OK;
726 fgOptMach( const char *arg )
728 fgSetString("/sim/presets/speed-set", "mach");
729 fgSetDouble("/sim/presets/mach", atof(arg));
730 return FG_OPTIONS_OK;
734 fgOptRoc( const char *arg )
736 fgSetDouble("/velocities/vertical-speed-fps", atof(arg)/60);
737 return FG_OPTIONS_OK;
741 fgOptFgScenery( const char *arg )
743 globals->append_fg_scenery(arg);
744 return FG_OPTIONS_OK;
748 fgOptFov( const char *arg )
751 return FG_OPTIONS_OK;
755 fgOptGeometry( const char *arg )
757 bool geometry_ok = true;
758 int xsize = 0, ysize = 0;
759 string geometry = arg;
760 string::size_type i = geometry.find('x');
762 if (i != string::npos) {
763 xsize = atoi(geometry.substr(0, i));
764 ysize = atoi(geometry.substr(i+1));
769 if ( xsize <= 0 || ysize <= 0 ) {
775 if ( !geometry_ok ) {
776 SG_LOG( SG_GENERAL, SG_ALERT, "Unknown geometry: " << geometry );
777 SG_LOG( SG_GENERAL, SG_ALERT,
778 "Setting geometry to " << xsize << 'x' << ysize << '\n');
780 SG_LOG( SG_GENERAL, SG_INFO,
781 "Setting geometry to " << xsize << 'x' << ysize << '\n');
782 fgSetInt("/sim/startup/xsize", xsize);
783 fgSetInt("/sim/startup/ysize", ysize);
785 return FG_OPTIONS_OK;
789 fgOptBpp( const char *arg )
791 string bits_per_pix = arg;
792 if ( bits_per_pix == "16" ) {
793 fgSetInt("/sim/rendering/bits-per-pixel", 16);
794 } else if ( bits_per_pix == "24" ) {
795 fgSetInt("/sim/rendering/bits-per-pixel", 24);
796 } else if ( bits_per_pix == "32" ) {
797 fgSetInt("/sim/rendering/bits-per-pixel", 32);
799 SG_LOG(SG_GENERAL, SG_ALERT, "Unsupported bpp " << bits_per_pix);
801 return FG_OPTIONS_OK;
805 fgOptTimeOffset( const char *arg )
807 fgSetLong("/sim/startup/time-offset",
808 parse_time_offset( arg ));
809 fgSetString("/sim/startup/time-offset-type", "system-offset");
810 return FG_OPTIONS_OK;
814 fgOptStartDateSys( const char *arg )
816 long int theTime = parse_date( arg, "system" );
819 fgSetLong("/sim/startup/time-offset", theTime);
820 fgSetString("/sim/startup/time-offset-type", "system");
822 return FG_OPTIONS_OK;
826 fgOptStartDateLat( const char *arg )
828 long int theTime = parse_date( arg, "latitude" );
831 fgSetLong("/sim/startup/time-offset", theTime);
832 fgSetString("/sim/startup/time-offset-type", "latitude");
834 return FG_OPTIONS_OK;
838 fgOptStartDateGmt( const char *arg )
840 long int theTime = parse_date( arg, "gmt" );
843 fgSetLong("/sim/startup/time-offset", theTime);
844 fgSetString("/sim/startup/time-offset-type", "gmt");
846 return FG_OPTIONS_OK;
850 fgSetupProxy( const char *arg )
852 string options = simgear::strutils::strip( arg );
853 string host, port, auth;
854 string::size_type pos;
856 // this is NURLP - NURLP is not an url parser
857 if( simgear::strutils::starts_with( options, "http://" ) )
858 options = options.substr( 7 );
859 if( simgear::strutils::ends_with( options, "/" ) )
860 options = options.substr( 0, options.length() - 1 );
862 host = port = auth = "";
863 if ((pos = options.find("@")) != string::npos)
864 auth = options.substr(0, pos++);
868 host = options.substr(pos, options.size());
869 if ((pos = host.find(":")) != string::npos) {
870 port = host.substr(++pos, host.size());
871 host.erase(--pos, host.size());
874 fgSetString("/sim/presets/proxy/host", host.c_str());
875 fgSetString("/sim/presets/proxy/port", port.c_str());
876 fgSetString("/sim/presets/proxy/authentication", auth.c_str());
878 return FG_OPTIONS_OK;
882 fgOptTraceRead( const char *arg )
885 SG_LOG(SG_GENERAL, SG_INFO, "Tracing reads for property " << name);
886 fgGetNode(name.c_str(), true)
887 ->setAttribute(SGPropertyNode::TRACE_READ, true);
888 return FG_OPTIONS_OK;
892 fgOptLogLevel( const char *arg )
894 fgSetString("/sim/logging/priority", arg);
895 setLoggingPriority(arg);
897 return FG_OPTIONS_OK;
901 fgOptLogClasses( const char *arg )
903 fgSetString("/sim/logging/classes", arg);
904 setLoggingClasses (arg);
906 return FG_OPTIONS_OK;
910 fgOptTraceWrite( const char *arg )
913 SG_LOG(SG_GENERAL, SG_INFO, "Tracing writes for property " << name);
914 fgGetNode(name.c_str(), true)
915 ->setAttribute(SGPropertyNode::TRACE_WRITE, true);
916 return FG_OPTIONS_OK;
920 fgOptViewOffset( const char *arg )
922 // $$$ begin - added VS Renganathan, 14 Oct 2K
923 // for multi-window outside window imagery
924 string woffset = arg;
925 double default_view_offset = 0.0;
926 if ( woffset == "LEFT" ) {
927 default_view_offset = SGD_PI * 0.25;
928 } else if ( woffset == "RIGHT" ) {
929 default_view_offset = SGD_PI * 1.75;
930 } else if ( woffset == "CENTER" ) {
931 default_view_offset = 0.00;
933 default_view_offset = atof( woffset.c_str() ) * SGD_DEGREES_TO_RADIANS;
935 /* apparently not used (CLO, 11 Jun 2002)
936 FGViewer *pilot_view =
937 (FGViewer *)globals->get_viewmgr()->get_view( 0 ); */
938 // this will work without calls to the viewer...
939 fgSetDouble( "/sim/current-view/heading-offset-deg",
940 default_view_offset * SGD_RADIANS_TO_DEGREES );
941 // $$$ end - added VS Renganathan, 14 Oct 2K
942 return FG_OPTIONS_OK;
946 fgOptVisibilityMeters( const char *arg )
948 Environment::Presets::VisibilitySingleton::instance()->preset( atof( arg ) );
949 return FG_OPTIONS_OK;
953 fgOptVisibilityMiles( const char *arg )
955 Environment::Presets::VisibilitySingleton::instance()->preset( atof( arg ) * 5280.0 * SG_FEET_TO_METER );
956 return FG_OPTIONS_OK;
960 fgOptRandomWind( const char *arg )
962 double min_hdg = sg_random() * 360.0;
963 double max_hdg = min_hdg + (20 - sqrt(sg_random() * 400));
964 double speed = sg_random() * sg_random() * 40;
965 double gust = speed + (10 - sqrt(sg_random() * 100));
966 Environment::Presets::WindSingleton::instance()->preset(min_hdg, max_hdg, speed, gust);
967 return FG_OPTIONS_OK;
971 fgOptWind( const char *arg )
973 double min_hdg = 0.0, max_hdg = 0.0, speed = 0.0, gust = 0.0;
974 if (!parse_wind( arg, &min_hdg, &max_hdg, &speed, &gust)) {
975 SG_LOG( SG_GENERAL, SG_ALERT, "bad wind value " << arg );
976 return FG_OPTIONS_ERROR;
978 Environment::Presets::WindSingleton::instance()->preset(min_hdg, max_hdg, speed, gust);
979 return FG_OPTIONS_OK;
983 fgOptTurbulence( const char *arg )
985 Environment::Presets::TurbulenceSingleton::instance()->preset( atof(arg) );
986 return FG_OPTIONS_OK;
990 fgOptCeiling( const char *arg )
992 double elevation, thickness;
994 string::size_type pos = spec.find(':');
995 if (pos == string::npos) {
996 elevation = atof(spec.c_str());
999 elevation = atof(spec.substr(0, pos).c_str());
1000 thickness = atof(spec.substr(pos + 1).c_str());
1002 Environment::Presets::CeilingSingleton::instance()->preset( elevation, thickness );
1003 return FG_OPTIONS_OK;
1007 fgOptWp( const char *arg )
1009 string_list *waypoints = globals->get_initial_waypoints();
1011 waypoints = new string_list;
1012 globals->set_initial_waypoints(waypoints);
1014 waypoints->push_back(arg);
1015 return FG_OPTIONS_OK;
1019 fgOptConfig( const char *arg )
1023 readProperties(file, globals->get_props());
1024 } catch (const sg_exception &e) {
1025 string message = "Error loading config file: ";
1026 message += e.getFormattedMessage() + e.getOrigin();
1027 SG_LOG(SG_INPUT, SG_ALERT, message);
1030 return FG_OPTIONS_OK;
1034 parse_colon (const string &s, double * val1, double * val2)
1036 string::size_type pos = s.find(':');
1037 if (pos == string::npos) {
1041 *val1 = atof(s.substr(0, pos).c_str());
1042 *val2 = atof(s.substr(pos+1).c_str());
1049 fgOptFailure( const char * arg )
1053 fgSetBool("/systems/pitot/serviceable", false);
1054 } else if (a == "static") {
1055 fgSetBool("/systems/static/serviceable", false);
1056 } else if (a == "vacuum") {
1057 fgSetBool("/systems/vacuum/serviceable", false);
1058 } else if (a == "electrical") {
1059 fgSetBool("/systems/electrical/serviceable", false);
1061 SG_LOG(SG_INPUT, SG_ALERT, "Unknown failure mode: " << a);
1062 return FG_OPTIONS_ERROR;
1065 return FG_OPTIONS_OK;
1070 fgOptNAV1( const char * arg )
1072 double radial, freq;
1073 if (parse_colon(arg, &radial, &freq))
1074 fgSetDouble("/instrumentation/nav[0]/radials/selected-deg", radial);
1075 fgSetDouble("/instrumentation/nav[0]/frequencies/selected-mhz", freq);
1076 return FG_OPTIONS_OK;
1080 fgOptNAV2( const char * arg )
1082 double radial, freq;
1083 if (parse_colon(arg, &radial, &freq))
1084 fgSetDouble("/instrumentation/nav[1]/radials/selected-deg", radial);
1085 fgSetDouble("/instrumentation/nav[1]/frequencies/selected-mhz", freq);
1086 return FG_OPTIONS_OK;
1090 fgOptADF1( const char * arg )
1093 if (parse_colon(arg, &rot, &freq))
1094 fgSetDouble("/instrumentation/adf[0]/rotation-deg", rot);
1095 fgSetDouble("/instrumentation/adf[0]/frequencies/selected-khz", freq);
1096 return FG_OPTIONS_OK;
1100 fgOptADF2( const char * arg )
1103 if (parse_colon(arg, &rot, &freq))
1104 fgSetDouble("/instrumentation/adf[1]/rotation-deg", rot);
1105 fgSetDouble("/instrumentation/adf[1]/frequencies/selected-khz", freq);
1106 return FG_OPTIONS_OK;
1110 fgOptDME( const char *arg )
1113 if (opt == "nav1") {
1114 fgSetInt("/instrumentation/dme/switch-position", 1);
1115 fgSetString("/instrumentation/dme/frequencies/source",
1116 "/instrumentation/nav[0]/frequencies/selected-mhz");
1117 } else if (opt == "nav2") {
1118 fgSetInt("/instrumentation/dme/switch-position", 3);
1119 fgSetString("/instrumentation/dme/frequencies/source",
1120 "/instrumentation/nav[1]/frequencies/selected-mhz");
1122 double frequency = atof(arg);
1125 SG_LOG(SG_INPUT, SG_ALERT, "Invalid DME frequency: '" << arg << "'.");
1126 return FG_OPTIONS_ERROR;
1128 fgSetInt("/instrumentation/dme/switch-position", 2);
1129 fgSetString("/instrumentation/dme/frequencies/source",
1130 "/instrumentation/dme/frequencies/selected-mhz");
1131 fgSetDouble("/instrumentation/dme/frequencies/selected-mhz", frequency);
1133 return FG_OPTIONS_OK;
1137 fgOptLivery( const char *arg )
1140 string livery_path = "livery/" + opt;
1141 fgSetString("/sim/model/texture-path", livery_path.c_str() );
1142 return FG_OPTIONS_OK;
1146 fgOptScenario( const char *arg )
1148 SGPropertyNode_ptr ai_node = fgGetNode( "/sim/ai", true );
1149 vector<SGPropertyNode_ptr> scenarii = ai_node->getChildren( "scenario" );
1151 for ( size_t i = 0; i < scenarii.size(); ++i ) {
1152 int ind = scenarii[i]->getIndex();
1153 if ( index < ind ) {
1157 SGPropertyNode_ptr scenario = ai_node->getNode( "scenario", index + 1, true );
1158 scenario->setStringValue( arg );
1159 ai_node->setBoolValue( "scenarios-enabled", true );
1160 return FG_OPTIONS_OK;
1164 fgOptNoScenarios( const char *arg )
1166 SGPropertyNode_ptr ai_node = fgGetNode( "/sim/ai", true );
1167 ai_node->removeChildren("scenario",false);
1168 ai_node->setBoolValue( "scenarios-enabled", false );
1169 return FG_OPTIONS_OK;
1173 fgOptRunway( const char *arg )
1175 fgSetString("/sim/presets/runway", arg );
1176 fgSetBool("/sim/presets/runway-requested", true );
1177 return FG_OPTIONS_OK;
1181 fgOptParking( const char *arg )
1183 cerr << "Processing argument " << arg << endl;
1184 fgSetString("/sim/presets/parking", arg );
1185 fgSetBool ("/sim/presets/parking-requested", true );
1186 return FG_OPTIONS_OK;
1190 fgOptVersion( const char *arg )
1192 cerr << "FlightGear version: " << FLIGHTGEAR_VERSION << endl;
1193 cerr << "Revision: " << REVISION << endl;
1194 cerr << "Build-Id: " << HUDSON_BUILD_ID << endl;
1195 cerr << "FG_ROOT=" << globals->get_fg_root() << endl;
1196 cerr << "FG_HOME=" << fgGetString("/sim/fg-home") << endl;
1197 cerr << "FG_SCENERY=";
1200 string_list scn = globals->get_fg_scenery();
1201 for (string_list::const_iterator it = scn.begin(); it != scn.end(); it++)
1203 if (didsome) cerr << ":";
1208 cerr << "SimGear version: " << SG_STRINGIZE(SIMGEAR_VERSION) << endl;
1209 cerr << "PLIB version: " << PLIB_VERSION << endl;
1210 return FG_OPTIONS_EXIT;
1214 fgOptCallSign(const char * arg)
1218 strncpy(callsign,arg,10);
1220 for (i=0;callsign[i];i++)
1222 char c = callsign[i];
1223 if (c >= 'A' && c <= 'Z') continue;
1224 if (c >= 'a' && c <= 'z') continue;
1225 if (c >= '0' && c <= '9') continue;
1226 if (c == '-' || c == '_') continue;
1227 // convert any other illegal characters
1230 fgSetString("sim/multiplay/callsign", callsign );
1231 return FG_OPTIONS_OK;
1235 // Set a property for the --prop: option. Syntax: --prop:[<type>:]<name>=<value>
1236 // <type> can be "double" etc. but also only the first letter "d".
1237 // Examples: --prop:alpha=1 --prop:bool:beta=true --prop:d:gamma=0.123
1239 fgOptSetProperty(const char* raw)
1242 string::size_type pos = arg.find('=');
1243 if (pos == arg.npos || pos == 0 || pos + 1 == arg.size())
1244 return FG_OPTIONS_ERROR;
1246 string name = arg.substr(0, pos);
1247 string value = arg.substr(pos + 1);
1249 pos = name.find(':');
1251 if (pos != name.npos && pos != 0 && pos + 1 != name.size()) {
1252 type = name.substr(0, pos);
1253 name = name.substr(pos + 1);
1255 SGPropertyNode *n = fgGetNode(name.c_str(), true);
1257 bool writable = n->getAttribute(SGPropertyNode::WRITE);
1259 n->setAttribute(SGPropertyNode::WRITE, true);
1263 ret = n->setUnspecifiedValue(value.c_str());
1264 else if (type == "s" || type == "string")
1265 ret = n->setStringValue(value.c_str());
1266 else if (type == "d" || type == "double")
1267 ret = n->setDoubleValue(strtod(value.c_str(), 0));
1268 else if (type == "f" || type == "float")
1269 ret = n->setFloatValue(atof(value.c_str()));
1270 else if (type == "l" || type == "long")
1271 ret = n->setLongValue(strtol(value.c_str(), 0, 0));
1272 else if (type == "i" || type == "int")
1273 ret = n->setIntValue(atoi(value.c_str()));
1274 else if (type == "b" || type == "bool")
1275 ret = n->setBoolValue(value == "true" || atoi(value.c_str()) != 0);
1278 n->setAttribute(SGPropertyNode::WRITE, false);
1279 return ret ? FG_OPTIONS_OK : FG_OPTIONS_ERROR;
1285 option has_param type property b_param s_param func
1288 option : name of the option
1289 has_param : option is --name=value if true or --name if false
1290 type : OPTION_BOOL - property is a boolean
1291 OPTION_STRING - property is a string
1292 OPTION_DOUBLE - property is a double
1293 OPTION_INT - property is an integer
1294 OPTION_CHANNEL - name of option is the name of a channel
1295 OPTION_FUNC - the option trigger a function
1296 b_param : if type==OPTION_BOOL,
1297 value set to the property (has_param is false for boolean)
1298 s_param : if type==OPTION_STRING,
1299 value set to the property if has_param is false
1300 func : function called if type==OPTION_FUNC. if has_param is true,
1301 the value is passed to the function as a string, otherwise,
1304 For OPTION_DOUBLE and OPTION_INT, the parameter value is converted into a
1305 double or an integer and set to the property.
1307 For OPTION_CHANNEL, add_channel is called with the parameter value as the
1311 enum OptionType { OPTION_BOOL = 0, OPTION_STRING, OPTION_DOUBLE, OPTION_INT, OPTION_CHANNEL, OPTION_FUNC, OPTION_IGNORE };
1312 const int OPTION_MULTI = 1 << 17;
1318 const char *property;
1320 const char *s_param;
1321 int (*func)( const char * );
1322 } fgOptionArray[] = {
1324 {"language", true, OPTION_IGNORE, "", false, "", 0 },
1325 {"disable-rembrandt", false, OPTION_BOOL, "/sim/rendering/rembrandt", false, "", 0 },
1326 {"enable-rembrandt", false, OPTION_BOOL, "/sim/rendering/rembrandt", true, "", 0 },
1327 {"disable-game-mode", false, OPTION_BOOL, "/sim/startup/game-mode", false, "", 0 },
1328 {"enable-game-mode", false, OPTION_BOOL, "/sim/startup/game-mode", true, "", 0 },
1329 {"disable-splash-screen", false, OPTION_BOOL, "/sim/startup/splash-screen", false, "", 0 },
1330 {"enable-splash-screen", false, OPTION_BOOL, "/sim/startup/splash-screen", true, "", 0 },
1331 {"disable-intro-music", false, OPTION_BOOL, "/sim/startup/intro-music", false, "", 0 },
1332 {"enable-intro-music", false, OPTION_BOOL, "/sim/startup/intro-music", true, "", 0 },
1333 {"disable-mouse-pointer", false, OPTION_STRING, "/sim/startup/mouse-pointer", false, "disabled", 0 },
1334 {"enable-mouse-pointer", false, OPTION_STRING, "/sim/startup/mouse-pointer", false, "enabled", 0 },
1335 {"disable-random-objects", false, OPTION_BOOL, "/sim/rendering/random-objects", false, "", 0 },
1336 {"enable-random-objects", false, OPTION_BOOL, "/sim/rendering/random-objects", true, "", 0 },
1337 {"disable-real-weather-fetch", false, OPTION_BOOL, "/environment/realwx/enabled", false, "", 0 },
1338 {"enable-real-weather-fetch", false, OPTION_BOOL, "/environment/realwx/enabled", true, "", 0 },
1339 {"metar", true, OPTION_STRING, "/environment/metar/data", false, "", 0 },
1340 {"disable-ai-models", false, OPTION_BOOL, "/sim/ai/enabled", false, "", 0 },
1341 {"enable-ai-models", false, OPTION_BOOL, "/sim/ai/enabled", true, "", 0 },
1342 {"disable-ai-traffic", false, OPTION_BOOL, "/sim/traffic-manager/enabled", false, "", 0 },
1343 {"enable-ai-traffic", false, OPTION_BOOL, "/sim/traffic-manager/enabled", true, "", 0 },
1344 {"disable-freeze", false, OPTION_BOOL, "/sim/freeze/master", false, "", 0 },
1345 {"enable-freeze", false, OPTION_BOOL, "/sim/freeze/master", true, "", 0 },
1346 {"disable-fuel-freeze", false, OPTION_BOOL, "/sim/freeze/fuel", false, "", 0 },
1347 {"enable-fuel-freeze", false, OPTION_BOOL, "/sim/freeze/fuel", true, "", 0 },
1348 {"disable-clock-freeze", false, OPTION_BOOL, "/sim/freeze/clock", false, "", 0 },
1349 {"enable-clock-freeze", false, OPTION_BOOL, "/sim/freeze/clock", true, "", 0 },
1350 {"disable-hud-3d", false, OPTION_BOOL, "/sim/hud/enable3d[1]", false, "", 0 },
1351 {"enable-hud-3d", false, OPTION_BOOL, "/sim/hud/enable3d[1]", true, "", 0 },
1352 {"disable-anti-alias-hud", false, OPTION_BOOL, "/sim/hud/color/antialiased", false, "", 0 },
1353 {"enable-anti-alias-hud", false, OPTION_BOOL, "/sim/hud/color/antialiased", true, "", 0 },
1354 {"control", true, OPTION_STRING, "/sim/control-mode", false, "", 0 },
1355 {"disable-auto-coordination", false, OPTION_BOOL, "/controls/flight/auto-coordination", false, "", 0 },
1356 {"enable-auto-coordination", false, OPTION_BOOL, "/controls/flight/auto-coordination", true, "", 0 },
1357 {"browser-app", true, OPTION_STRING, "/sim/startup/browser-app", false, "", 0 },
1358 {"disable-hud", false, OPTION_BOOL, "/sim/hud/visibility[1]", false, "", 0 },
1359 {"enable-hud", false, OPTION_BOOL, "/sim/hud/visibility[1]", true, "", 0 },
1360 {"disable-panel", false, OPTION_BOOL, "/sim/panel/visibility", false, "", 0 },
1361 {"enable-panel", false, OPTION_BOOL, "/sim/panel/visibility", true, "", 0 },
1362 {"disable-sound", false, OPTION_BOOL, "/sim/sound/working", false, "", 0 },
1363 {"enable-sound", false, OPTION_BOOL, "/sim/sound/working", true, "", 0 },
1364 {"sound-device", true, OPTION_STRING, "/sim/sound/device-name", false, "", 0 },
1365 {"airport", true, OPTION_STRING, "/sim/presets/airport-id", false, "", 0 },
1366 {"runway", true, OPTION_FUNC, "", false, "", fgOptRunway },
1367 {"vor", true, OPTION_FUNC, "", false, "", fgOptVOR },
1368 {"vor-frequency", true, OPTION_DOUBLE, "/sim/presets/vor-freq", false, "", fgOptVOR },
1369 {"ndb", true, OPTION_FUNC, "", false, "", fgOptNDB },
1370 {"ndb-frequency", true, OPTION_DOUBLE, "/sim/presets/ndb-freq", false, "", fgOptVOR },
1371 {"carrier", true, OPTION_FUNC, "", false, "", fgOptCarrier },
1372 {"parkpos", true, OPTION_FUNC, "", false, "", fgOptParkpos },
1373 {"fix", true, OPTION_FUNC, "", false, "", fgOptFIX },
1374 {"offset-distance", true, OPTION_DOUBLE, "/sim/presets/offset-distance-nm", false, "", 0 },
1375 {"offset-azimuth", true, OPTION_DOUBLE, "/sim/presets/offset-azimuth-deg", false, "", 0 },
1376 {"lon", true, OPTION_FUNC, "", false, "", fgOptLon },
1377 {"lat", true, OPTION_FUNC, "", false, "", fgOptLat },
1378 {"altitude", true, OPTION_FUNC, "", false, "", fgOptAltitude },
1379 {"uBody", true, OPTION_FUNC, "", false, "", fgOptUBody },
1380 {"vBody", true, OPTION_FUNC, "", false, "", fgOptVBody },
1381 {"wBody", true, OPTION_FUNC, "", false, "", fgOptWBody },
1382 {"vNorth", true, OPTION_FUNC, "", false, "", fgOptVNorth },
1383 {"vEast", true, OPTION_FUNC, "", false, "", fgOptVEast },
1384 {"vDown", true, OPTION_FUNC, "", false, "", fgOptVDown },
1385 {"vc", true, OPTION_FUNC, "", false, "", fgOptVc },
1386 {"mach", true, OPTION_FUNC, "", false, "", fgOptMach },
1387 {"heading", true, OPTION_DOUBLE, "/sim/presets/heading-deg", false, "", 0 },
1388 {"roll", true, OPTION_DOUBLE, "/sim/presets/roll-deg", false, "", 0 },
1389 {"pitch", true, OPTION_DOUBLE, "/sim/presets/pitch-deg", false, "", 0 },
1390 {"glideslope", true, OPTION_DOUBLE, "/sim/presets/glideslope-deg", false, "", 0 },
1391 {"roc", true, OPTION_FUNC, "", false, "", fgOptRoc },
1392 {"fg-root", true, OPTION_IGNORE, "", false, "", 0 },
1393 {"fg-scenery", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptFgScenery },
1394 {"fg-aircraft", true, OPTION_IGNORE | OPTION_MULTI, "", false, "", 0 },
1395 {"fdm", true, OPTION_STRING, "/sim/flight-model", false, "", 0 },
1396 {"aero", true, OPTION_STRING, "/sim/aero", false, "", 0 },
1397 {"aircraft-dir", true, OPTION_IGNORE, "", false, "", 0 },
1398 {"model-hz", true, OPTION_INT, "/sim/model-hz", false, "", 0 },
1399 {"max-fps", true, OPTION_DOUBLE, "/sim/frame-rate-throttle-hz", false, "", 0 },
1400 {"speed", true, OPTION_INT, "/sim/speed-up", false, "", 0 },
1401 {"trim", false, OPTION_BOOL, "/sim/presets/trim", true, "", 0 },
1402 {"notrim", false, OPTION_BOOL, "/sim/presets/trim", false, "", 0 },
1403 {"on-ground", false, OPTION_BOOL, "/sim/presets/onground", true, "", 0 },
1404 {"in-air", false, OPTION_BOOL, "/sim/presets/onground", false, "", 0 },
1405 {"fog-disable", false, OPTION_STRING, "/sim/rendering/fog", false, "disabled", 0 },
1406 {"fog-fastest", false, OPTION_STRING, "/sim/rendering/fog", false, "fastest", 0 },
1407 {"fog-nicest", false, OPTION_STRING, "/sim/rendering/fog", false, "nicest", 0 },
1408 {"disable-horizon-effect", false, OPTION_BOOL, "/sim/rendering/horizon-effect", false, "", 0 },
1409 {"enable-horizon-effect", false, OPTION_BOOL, "/sim/rendering/horizon-effect", true, "", 0 },
1410 {"disable-enhanced-lighting", false, OPTION_BOOL, "/sim/rendering/enhanced-lighting", false, "", 0 },
1411 {"enable-enhanced-lighting", false, OPTION_BOOL, "/sim/rendering/enhanced-lighting", true, "", 0 },
1412 {"disable-distance-attenuation", false, OPTION_BOOL, "/sim/rendering/distance-attenuation", false, "", 0 },
1413 {"enable-distance-attenuation", false, OPTION_BOOL, "/sim/rendering/distance-attenuation", true, "", 0 },
1414 {"disable-specular-highlight", false, OPTION_BOOL, "/sim/rendering/specular-highlight", false, "", 0 },
1415 {"enable-specular-highlight", false, OPTION_BOOL, "/sim/rendering/specular-highlight", true, "", 0 },
1416 {"disable-clouds", false, OPTION_BOOL, "/environment/clouds/status", false, "", 0 },
1417 {"enable-clouds", false, OPTION_BOOL, "/environment/clouds/status", true, "", 0 },
1418 {"disable-clouds3d", false, OPTION_BOOL, "/sim/rendering/clouds3d-enable", false, "", 0 },
1419 {"enable-clouds3d", false, OPTION_BOOL, "/sim/rendering/clouds3d-enable", true, "", 0 },
1420 {"fov", true, OPTION_FUNC, "", false, "", fgOptFov },
1421 {"aspect-ratio-multiplier", true, OPTION_DOUBLE, "/sim/current-view/aspect-ratio-multiplier", false, "", 0 },
1422 {"disable-fullscreen", false, OPTION_BOOL, "/sim/startup/fullscreen", false, "", 0 },
1423 {"enable-fullscreen", false, OPTION_BOOL, "/sim/startup/fullscreen", true, "", 0 },
1424 {"disable-save-on-exit", false, OPTION_BOOL, "/sim/startup/save-on-exit", false, "", 0 },
1425 {"enable-save-on-exit", false, OPTION_BOOL, "/sim/startup/save-on-exit", true, "", 0 },
1426 {"shading-flat", false, OPTION_BOOL, "/sim/rendering/shading", false, "", 0 },
1427 {"shading-smooth", false, OPTION_BOOL, "/sim/rendering/shading", true, "", 0 },
1428 {"disable-skyblend", false, OPTION_BOOL, "/sim/rendering/skyblend", false, "", 0 },
1429 {"enable-skyblend", false, OPTION_BOOL, "/sim/rendering/skyblend", true, "", 0 },
1430 {"disable-textures", false, OPTION_BOOL, "/sim/rendering/textures", false, "", 0 },
1431 {"enable-textures", false, OPTION_BOOL, "/sim/rendering/textures", true, "", 0 },
1432 {"texture-filtering", false, OPTION_INT, "/sim/rendering/filtering", 1, "", 0 },
1433 {"disable-wireframe", false, OPTION_BOOL, "/sim/rendering/wireframe", false, "", 0 },
1434 {"enable-wireframe", false, OPTION_BOOL, "/sim/rendering/wireframe", true, "", 0 },
1435 {"materials-file", true, OPTION_STRING, "/sim/rendering/materials-file", false, "", 0 },
1436 {"disable-terrasync", false, OPTION_BOOL, "/sim/terrasync/enabled", false, "", 0 },
1437 {"enable-terrasync", false, OPTION_BOOL, "/sim/terrasync/enabled", true, "", 0 },
1438 {"terrasync-dir", true, OPTION_STRING, "/sim/terrasync/scenery-dir", false, "", 0 },
1439 {"geometry", true, OPTION_FUNC, "", false, "", fgOptGeometry },
1440 {"bpp", true, OPTION_FUNC, "", false, "", fgOptBpp },
1441 {"units-feet", false, OPTION_STRING, "/sim/startup/units", false, "feet", 0 },
1442 {"units-meters", false, OPTION_STRING, "/sim/startup/units", false, "meters", 0 },
1443 {"timeofday", true, OPTION_STRING, "/sim/startup/time-offset-type", false, "noon", 0 },
1444 {"season", true, OPTION_STRING, "/sim/startup/season", false, "summer", 0 },
1445 {"time-offset", true, OPTION_FUNC, "", false, "", fgOptTimeOffset },
1446 {"time-match-real", false, OPTION_STRING, "/sim/startup/time-offset-type", false, "system-offset", 0 },
1447 {"time-match-local", false, OPTION_STRING, "/sim/startup/time-offset-type", false, "latitude-offset", 0 },
1448 {"start-date-sys", true, OPTION_FUNC, "", false, "", fgOptStartDateSys },
1449 {"start-date-lat", true, OPTION_FUNC, "", false, "", fgOptStartDateLat },
1450 {"start-date-gmt", true, OPTION_FUNC, "", false, "", fgOptStartDateGmt },
1451 {"hud-tris", false, OPTION_STRING, "/sim/hud/frame-stat-type", false, "tris", 0 },
1452 {"hud-culled", false, OPTION_STRING, "/sim/hud/frame-stat-type", false, "culled", 0 },
1453 {"atcsim", true, OPTION_CHANNEL, "", false, "dummy", 0 },
1454 {"atlas", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1455 {"httpd", true, OPTION_CHANNEL, "", false, "", 0 },
1456 #ifdef FG_JPEG_SERVER
1457 {"jpg-httpd", true, OPTION_CHANNEL, "", false, "", 0 },
1459 {"native", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1460 {"native-ctrls", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1461 {"native-fdm", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1462 {"native-gui", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1463 {"opengc", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1464 {"AV400", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1465 {"AV400Sim", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1466 {"AV400WSimA", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1467 {"AV400WSimB", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1468 {"garmin", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1469 {"nmea", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1470 {"generic", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1471 {"props", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1472 {"telnet", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1473 {"pve", true, OPTION_CHANNEL, "", false, "", 0 },
1474 {"ray", true, OPTION_CHANNEL, "", false, "", 0 },
1475 {"rul", true, OPTION_CHANNEL, "", false, "", 0 },
1476 {"joyclient", true, OPTION_CHANNEL, "", false, "", 0 },
1477 {"jsclient", true, OPTION_CHANNEL, "", false, "", 0 },
1478 {"proxy", true, OPTION_FUNC, "", false, "", fgSetupProxy },
1479 {"callsign", true, OPTION_FUNC, "", false, "", fgOptCallSign},
1480 {"multiplay", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1482 {"hla", true, OPTION_CHANNEL, "", false, "", 0 },
1484 {"trace-read", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptTraceRead },
1485 {"trace-write", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptTraceWrite },
1486 {"log-level", true, OPTION_FUNC, "", false, "", fgOptLogLevel },
1487 {"log-class", true, OPTION_FUNC, "", false, "", fgOptLogClasses },
1488 {"view-offset", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptViewOffset },
1489 {"visibility", true, OPTION_FUNC, "", false, "", fgOptVisibilityMeters },
1490 {"visibility-miles", true, OPTION_FUNC, "", false, "", fgOptVisibilityMiles },
1491 {"random-wind", false, OPTION_FUNC, "", false, "", fgOptRandomWind },
1492 {"wind", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptWind },
1493 {"turbulence", true, OPTION_FUNC, "", false, "", fgOptTurbulence },
1494 {"ceiling", true, OPTION_FUNC, "", false, "", fgOptCeiling },
1495 {"wp", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptWp },
1496 {"flight-plan", true, OPTION_STRING, "/autopilot/route-manager/file-path", false, "", NULL },
1497 {"config", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptConfig },
1498 {"aircraft", true, OPTION_STRING, "/sim/aircraft", false, "", 0 },
1499 {"vehicle", true, OPTION_STRING, "/sim/aircraft", false, "", 0 },
1500 {"failure", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptFailure },
1501 {"com1", true, OPTION_DOUBLE, "/instrumentation/comm[0]/frequencies/selected-mhz", false, "", 0 },
1502 {"com2", true, OPTION_DOUBLE, "/instrumentation/comm[1]/frequencies/selected-mhz", false, "", 0 },
1503 {"nav1", true, OPTION_FUNC, "", false, "", fgOptNAV1 },
1504 {"nav2", true, OPTION_FUNC, "", false, "", fgOptNAV2 },
1505 {"adf", /*legacy*/ true, OPTION_FUNC, "", false, "", fgOptADF1 },
1506 {"adf1", true, OPTION_FUNC, "", false, "", fgOptADF1 },
1507 {"adf2", true, OPTION_FUNC, "", false, "", fgOptADF2 },
1508 {"dme", true, OPTION_FUNC, "", false, "", fgOptDME },
1509 {"min-status", true, OPTION_STRING, "/sim/aircraft-min-status", false, "all", 0 },
1510 {"livery", true, OPTION_FUNC, "", false, "", fgOptLivery },
1511 {"ai-scenario", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptScenario },
1512 {"disable-ai-scenarios", false, OPTION_FUNC, "", false, "", fgOptNoScenarios},
1513 {"parking-id", true, OPTION_FUNC, "", false, "", fgOptParking },
1514 {"version", false, OPTION_FUNC, "", false, "", fgOptVersion },
1515 {"enable-fpe", false, OPTION_IGNORE, "", false, "", 0},
1516 {"fgviewer", false, OPTION_IGNORE, "", false, "", 0},
1517 {"prop", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptSetProperty},
1522 namespace flightgear
1526 * internal storage of a value->option binding
1531 OptionValue(OptionDesc* d, const string& v) :
1539 typedef std::vector<OptionValue> OptionValueVec;
1540 typedef std::map<string, OptionDesc*> OptionDescDict;
1542 class Options::OptionsPrivate
1546 OptionValueVec::const_iterator findValue(const string& key) const
1548 OptionValueVec::const_iterator it = values.begin();
1549 for (; it != values.end(); ++it) {
1551 continue; // ignore markers
1554 if (it->desc->option == key) {
1557 } // of set values iteration
1559 return it; // not found
1562 OptionDesc* findOption(const string& key) const
1564 OptionDescDict::const_iterator it = options.find(key);
1565 if (it == options.end()) {
1572 int processOption(OptionDesc* desc, const string& arg_value)
1575 return FG_OPTIONS_OK; // tolerate marker options
1578 switch ( desc->type & 0xffff ) {
1580 fgSetBool( desc->property, desc->b_param );
1583 if ( desc->has_param && !arg_value.empty() ) {
1584 fgSetString( desc->property, arg_value.c_str() );
1585 } else if ( !desc->has_param && arg_value.empty() ) {
1586 fgSetString( desc->property, desc->s_param );
1587 } else if ( desc->has_param ) {
1588 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' needs a parameter" );
1589 return FG_OPTIONS_ERROR;
1591 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' does not have a parameter" );
1592 return FG_OPTIONS_ERROR;
1596 if ( !arg_value.empty() ) {
1597 fgSetDouble( desc->property, atof( arg_value ) );
1599 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' needs a parameter" );
1600 return FG_OPTIONS_ERROR;
1604 if ( !arg_value.empty() ) {
1605 fgSetInt( desc->property, atoi( arg_value ) );
1607 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' needs a parameter" );
1608 return FG_OPTIONS_ERROR;
1611 case OPTION_CHANNEL:
1612 // XXX return value of add_channel should be checked?
1613 if ( desc->has_param && !arg_value.empty() ) {
1614 add_channel( desc->option, arg_value );
1615 } else if ( !desc->has_param && arg_value.empty() ) {
1616 add_channel( desc->option, desc->s_param );
1617 } else if ( desc->has_param ) {
1618 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' needs a parameter" );
1619 return FG_OPTIONS_ERROR;
1621 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' does not have a parameter" );
1622 return FG_OPTIONS_ERROR;
1626 if ( desc->has_param && !arg_value.empty() ) {
1627 return desc->func( arg_value.c_str() );
1628 } else if ( !desc->has_param && arg_value.empty() ) {
1629 return desc->func( desc->s_param );
1630 } else if ( desc->has_param ) {
1631 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' needs a parameter" );
1632 return FG_OPTIONS_ERROR;
1634 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' does not have a parameter" );
1635 return FG_OPTIONS_ERROR;
1643 return FG_OPTIONS_OK;
1647 * insert a marker value into the values vector. This is necessary
1648 * when processing options, to ensure the correct ordering, where we scan
1649 * for marker values in reverse, and then forwards within each group.
1651 void insertGroupMarker()
1653 values.push_back(OptionValue(NULL, "-"));
1657 * given a current iterator into the values, find the preceeding group marker,
1658 * or return the beginning of the value vector.
1660 OptionValueVec::const_iterator rfindGroup(OptionValueVec::const_iterator pos) const
1662 while (--pos != values.begin()) {
1663 if (pos->desc == NULL) {
1664 return pos; // found a marker, we're done
1675 OptionDescDict options;
1676 OptionValueVec values;
1677 simgear::PathList propertyFiles;
1680 Options* Options::sharedInstance()
1682 if (shared_instance == NULL) {
1683 shared_instance = new Options;
1686 return shared_instance;
1689 Options::Options() :
1690 p(new OptionsPrivate())
1692 p->showHelp = false;
1694 p->showAircraft = false;
1697 OptionDesc *desc = &fgOptionArray[ 0 ];
1698 while ( desc->option != 0 ) {
1699 p->options[ desc->option ] = desc;
1708 void Options::init(int argc, char **argv, const SGPath& appDataPath)
1712 // first, process the command line
1713 bool inOptions = true;
1714 for (int i=1; i<argc; ++i) {
1715 if (inOptions && (argv[i][0] == '-')) {
1716 if (strcmp(argv[i], "--") == 0) { // end of options delimiter
1721 int result = parseOption(argv[i]);
1722 processArgResult(result);
1724 // XML properties file
1727 SG_LOG(SG_GENERAL, SG_ALERT, "config file not found:" << f.str());
1731 p->propertyFiles.push_back(f);
1733 } // of arguments iteration
1734 p->insertGroupMarker(); // command line is one group
1736 // then config files
1739 if( homedir.size() && hostname.size() ) {
1740 // Check for ~/.fgfsrc.hostname
1741 config.set(homedir);
1742 config.append(".fgfsrc");
1743 config.concat( "." );
1744 config.concat( hostname );
1748 // Check for ~/.fgfsrc
1749 if( homedir.size() ) {
1750 config.set(homedir);
1751 config.append(".fgfsrc");
1755 // check for a config file in app data
1756 SGPath appDataConfig(appDataPath);
1757 appDataConfig.append("fgfsrc");
1758 if (appDataConfig.exists()) {
1759 readConfig(appDataConfig);
1765 // system.fgfsrc handling
1766 if( hostname.size() > 0 ) {
1767 config.set(globals->get_fg_root());
1768 config.append( "system.fgfsrc" );
1769 config.concat( "." );
1770 config.concat( hostname );
1774 config.set(globals->get_fg_root());
1775 config.append( "system.fgfsrc" );
1779 void Options::initAircraft()
1781 BOOST_FOREACH(const string& paths, valuesForOption("fg-aircraft")) {
1782 globals->append_aircraft_paths(paths);
1785 const char* envp = ::getenv("FG_AIRCRAFT");
1787 globals->append_aircraft_paths(envp);
1791 if (isOptionSet("aircraft")) {
1792 aircraft = valueForOption("aircraft");
1793 } else if (isOptionSet("vehicle")) {
1794 aircraft = valueForOption("vehicle");
1797 if (!aircraft.empty()) {
1798 SG_LOG(SG_INPUT, SG_INFO, "aircraft = " << aircraft );
1799 fgSetString("/sim/aircraft", aircraft.c_str() );
1801 SG_LOG(SG_INPUT, SG_INFO, "No user specified aircraft, using default" );
1804 if (p->showAircraft) {
1805 fgOptLogLevel( "alert" );
1806 SGPath path( globals->get_fg_root() );
1807 path.append("Aircraft");
1808 fgShowAircraft(path);
1812 if (isOptionSet("aircraft-dir")) {
1813 // set this now, so it's available in FindAndCacheAircraft
1814 fgSetString("/sim/aircraft-dir", valueForOption("aircraft-dir"));
1818 void Options::processArgResult(int result)
1820 if ((result == FG_OPTIONS_HELP) || (result == FG_OPTIONS_ERROR))
1822 else if (result == FG_OPTIONS_VERBOSE_HELP)
1824 else if (result == FG_OPTIONS_SHOW_AIRCRAFT) {
1825 p->showAircraft = true;
1826 } else if (result == FG_OPTIONS_SHOW_SOUND_DEVICES) {
1830 string vendor = smgr.get_vendor();
1831 string renderer = smgr.get_renderer();
1832 cout << renderer << " provided by " << vendor << endl;
1833 cout << endl << "No. Device" << endl;
1835 vector <const char*>devices = smgr.get_available_devices();
1836 for (vector <const char*>::size_type i=0; i<devices.size(); i++) {
1837 cout << i << ". \"" << devices[i] << "\"" << endl;
1841 } else if (result == FG_OPTIONS_EXIT) {
1846 void Options::readConfig(const SGPath& path)
1848 sg_gzifstream in( path.str() );
1849 if ( !in.is_open() ) {
1853 SG_LOG( SG_GENERAL, SG_INFO, "Processing config file: " << path.str() );
1856 while ( ! in.eof() ) {
1858 getline( in, line, '\n' );
1860 // catch extraneous (DOS) line ending character
1862 for (i = line.length(); i > 0; i--)
1863 if (line[i - 1] > 32)
1865 line = line.substr( 0, i );
1867 if ( parseOption( line ) == FG_OPTIONS_ERROR ) {
1868 cerr << endl << "Config file parse error: " << path.str() << " '"
1869 << line << "'" << endl;
1875 p->insertGroupMarker(); // each config file is a group
1878 int Options::parseOption(const string& s)
1880 if ((s == "--help") || (s=="-h")) {
1881 return FG_OPTIONS_HELP;
1882 } else if ( (s == "--verbose") || (s == "-v") ) {
1883 // verbose help/usage request
1884 return FG_OPTIONS_VERBOSE_HELP;
1885 } else if (s.find("-psn") == 0) {
1886 // on Mac, when launched from the GUI, we are passed the ProcessSerialNumber
1887 // as an argument (and no others). Silently ignore the argument here.
1888 return FG_OPTIONS_OK;
1889 } else if ( s.find( "--show-aircraft") == 0) {
1890 return(FG_OPTIONS_SHOW_AIRCRAFT);
1891 } else if ( s.find( "--show-sound-devices") == 0) {
1892 return(FG_OPTIONS_SHOW_SOUND_DEVICES);
1893 } else if ( s.find( "--prop:") == 0) {
1894 // property setting has a slightly different syntax, so fudge things
1895 OptionDesc* desc = p->findOption("prop");
1896 if (s.find("=", 7) == string::npos) { // no equals token
1897 SG_LOG(SG_GENERAL, SG_ALERT, "malformed property option:" << s);
1898 return FG_OPTIONS_ERROR;
1901 p->values.push_back(OptionValue(desc, s.substr(7)));
1902 return FG_OPTIONS_OK;
1903 } else if ( s.find( "--" ) == 0 ) {
1904 size_t eqPos = s.find( '=' );
1906 if (eqPos == string::npos) {
1909 key = s.substr( 2, eqPos - 2 );
1910 value = s.substr( eqPos + 1);
1913 return addOption(key, value);
1915 SG_LOG(SG_GENERAL, SG_ALERT, "unknown option:" << s);
1916 return FG_OPTIONS_ERROR;
1920 int Options::addOption(const string &key, const string &value)
1922 OptionDesc* desc = p->findOption(key);
1924 SG_LOG(SG_GENERAL, SG_ALERT, "unknown option:" << key);
1925 return FG_OPTIONS_ERROR;
1928 if (!(desc->type & OPTION_MULTI)) {
1929 OptionValueVec::const_iterator it = p->findValue(key);
1930 if (it != p->values.end()) {
1931 SG_LOG(SG_GENERAL, SG_INFO, "multiple values forbidden for option:" << key << ", ignoring:" << value);
1932 return FG_OPTIONS_OK;
1936 p->values.push_back(OptionValue(desc, value));
1937 return FG_OPTIONS_OK;
1940 bool Options::isOptionSet(const string &key) const
1942 OptionValueVec::const_iterator it = p->findValue(key);
1943 return (it != p->values.end());
1946 string Options::valueForOption(const string& key, const string& defValue) const
1948 OptionValueVec::const_iterator it = p->findValue(key);
1949 if (it == p->values.end()) {
1956 string_list Options::valuesForOption(const std::string& key) const
1959 OptionValueVec::const_iterator it = p->values.begin();
1960 for (; it != p->values.end(); ++it) {
1962 continue; // ignore marker values
1965 if (it->desc->option == key) {
1966 result.push_back(it->value);
1973 void Options::processOptions()
1975 // establish locale before showing help (this selects the default locale,
1976 // when no explicit option was set)
1977 globals->get_locale()->selectLanguage(valueForOption("language").c_str());
1979 // now FG_ROOT is setup, process various command line options that bail us
1980 // out quickly, but rely on aircraft / root settings
1986 // processing order is complicated. We must process groups LIFO, but the
1987 // values *within* each group in FIFO order, to retain consistency with
1988 // older versions of FG, and existing user configs.
1989 // in practice this means system.fgfsrc must be *processed* before
1990 // .fgfsrc, which must be processed before the command line args, and so on.
1991 OptionValueVec::const_iterator groupEnd = p->values.end();
1993 while (groupEnd != p->values.begin()) {
1994 OptionValueVec::const_iterator groupBegin = p->rfindGroup(groupEnd);
1995 // run over the group in FIFO order
1996 OptionValueVec::const_iterator it;
1997 for (it = groupBegin; it != groupEnd; ++it) {
1998 int result = p->processOption(it->desc, it->value);
2001 case FG_OPTIONS_ERROR:
2003 exit(-1); // exit and return an error
2004 case FG_OPTIONS_EXIT:
2005 exit(0); // clean exit
2011 groupEnd = groupBegin;
2014 BOOST_FOREACH(const SGPath& file, p->propertyFiles) {
2015 if (!file.exists()) {
2016 SG_LOG(SG_GENERAL, SG_ALERT, "config file not found:" << file.str());
2020 SG_LOG(SG_GENERAL, SG_INFO,
2021 "Reading command-line property file " << file.str());
2022 readProperties(file.str(), globals->get_props());
2025 // now options are process, do supplemental fixup
2026 const char *envp = ::getenv( "FG_SCENERY" );
2028 globals->append_fg_scenery(envp);
2031 // terrasync directory fixup
2032 if (fgGetBool("/sim/terrasync/enabled")) {
2033 string terrasyncDir = fgGetString("/sim/terrasync/scenery-dir");
2034 if (terrasyncDir.empty()) {
2035 SGPath p(fgGetString("/sim/fg-home"));
2036 p.append("TerraSync");
2042 terrasyncDir = p.str();
2043 SG_LOG(SG_GENERAL, SG_INFO,
2044 "Using default TerraSync dir: " << terrasyncDir);
2045 fgSetString("/sim/terrasync/scenery-dir", terrasyncDir);
2048 const string_list& scenery_paths(globals->get_fg_scenery());
2049 if (std::find(scenery_paths.begin(), scenery_paths.end(), terrasyncDir) == scenery_paths.end()) {
2050 // terrasync dir is not in the scenery paths, add it
2051 globals->append_fg_scenery(terrasyncDir);
2055 if (globals->get_fg_scenery().empty()) {
2056 // no scenery paths set *at all*, use the data in FG_ROOT
2057 SGPath root(globals->get_fg_root());
2058 root.append("Scenery");
2059 globals->append_fg_scenery(root.str());
2063 void Options::showUsage() const
2065 fgOptLogLevel( "alert" );
2067 FGLocale *locale = globals->get_locale();
2068 SGPropertyNode options_root;
2070 SG_LOG( SG_GENERAL, SG_ALERT, "" ); // To popup the console on Windows
2074 fgLoadProps("options.xml", &options_root);
2075 } catch (const sg_exception &) {
2076 cout << "Unable to read the help file." << endl;
2077 cout << "Make sure the file options.xml is located in the FlightGear base directory," << endl;
2078 cout << "and the location of the base directory is specified by setting $FG_ROOT or" << endl;
2079 cout << "by adding --fg-root=path as a program argument." << endl;
2084 SGPropertyNode *options = options_root.getNode("options");
2086 SG_LOG( SG_GENERAL, SG_ALERT,
2087 "Error reading options.xml: <options> directive not found." );
2091 if (!locale->loadResource("options"))
2093 cout << "Unable to read the language resource." << endl;
2097 const char* usage = locale->getLocalizedString(options->getStringValue("usage"), "options");
2099 cout << usage << endl;
2102 vector<SGPropertyNode_ptr>section = options->getChildren("section");
2103 for (unsigned int j = 0; j < section.size(); j++) {
2106 vector<SGPropertyNode_ptr>option = section[j]->getChildren("option");
2107 for (unsigned int k = 0; k < option.size(); k++) {
2109 SGPropertyNode *name = option[k]->getNode("name");
2110 SGPropertyNode *short_name = option[k]->getNode("short");
2111 SGPropertyNode *key = option[k]->getNode("key");
2112 SGPropertyNode *arg = option[k]->getNode("arg");
2113 bool brief = option[k]->getNode("brief") != 0;
2115 if ((brief || p->verbose) && name) {
2116 string tmp = name->getStringValue();
2120 tmp.append(key->getStringValue());
2124 tmp.append(arg->getStringValue());
2128 tmp.append(short_name->getStringValue());
2131 if (tmp.size() <= 25) {
2134 msg.append( 27-tmp.size(), ' ');
2138 msg.append(32, ' ');
2140 // There may be more than one <description> tag associated
2143 vector<SGPropertyNode_ptr> desc;
2144 desc = option[k]->getChildren("description");
2145 if (desc.size() > 0) {
2146 for ( unsigned int l = 0; l < desc.size(); l++) {
2147 string t = desc[l]->getStringValue();
2149 // There may be more than one translation line.
2150 vector<SGPropertyNode_ptr>trans_desc = locale->getLocalizedStrings(t.c_str(),"options");
2151 for ( unsigned int m = 0; m < trans_desc.size(); m++ ) {
2152 string t_str = trans_desc[m]->getStringValue();
2154 if ((m > 0) || ((l > 0) && m == 0)) {
2155 msg.append( 32, ' ');
2158 // If the string is too large to fit on the screen,
2159 // then split it up in several pieces.
2161 while ( t_str.size() > 47 ) {
2163 string::size_type m = t_str.rfind(' ', 47);
2164 msg += t_str.substr(0, m) + '\n';
2165 msg.append( 32, ' ');
2167 t_str.erase(t_str.begin(), t_str.begin() + m + 1);
2169 msg += t_str + '\n';
2176 const char* name = locale->getLocalizedString(section[j]->getStringValue("name"),"options");
2177 if (!msg.empty() && name) {
2178 cout << endl << name << ":" << endl;
2184 if ( !p->verbose ) {
2185 const char* verbose_help = locale->getLocalizedString(options->getStringValue("verbose-help"),"options");
2187 cout << endl << verbose_help << endl;
2190 std::cout << "Hit a key to continue..." << std::endl;
2195 #if defined(__CYGWIN__)
2196 string Options::platformDefaultRoot() const
2201 #elif defined(_WIN32)
2202 string Options::platformDefaultRoot() const
2206 #elif defined(__APPLE__)
2207 string Options::platformDefaultRoot() const
2210 The following code looks for the base package inside the application
2211 bundle, in the standard Contents/Resources location.
2213 CFURLRef resourcesUrl = CFBundleCopyResourcesDirectoryURL(CFBundleGetMainBundle());
2215 // look for a 'data' subdir
2216 CFURLRef dataDir = CFURLCreateCopyAppendingPathComponent(NULL, resourcesUrl, CFSTR("data"), true);
2218 // now convert down to a path, and the a c-string
2219 CFStringRef path = CFURLCopyFileSystemPath(dataDir, kCFURLPOSIXPathStyle);
2220 string root = CFStringGetCStringPtr(path, CFStringGetSystemEncoding());
2222 CFRelease(resourcesUrl);
2229 string Options::platformDefaultRoot() const
2235 void Options::setupRoot()
2238 if (isOptionSet("fg-root")) {
2239 root = valueForOption("fg-root"); // easy!
2241 // Next check if fg-root is set as an env variable
2242 char *envp = ::getenv( "FG_ROOT" );
2243 if ( envp != NULL ) {
2246 root = platformDefaultRoot();
2250 SG_LOG(SG_INPUT, SG_INFO, "fg_root = " << root );
2251 globals->set_fg_root(root);
2254 static char required_version[] = FLIGHTGEAR_VERSION;
2255 string base_version = fgBasePackageVersion();
2256 if ( !(base_version == required_version) ) {
2257 // tell the operator how to use this application
2259 SG_LOG( SG_GENERAL, SG_ALERT, "" ); // To popup the console on windows
2260 cerr << endl << "Base package check failed:" << endl \
2261 << " Version " << base_version << " found at: " \
2262 << globals->get_fg_root() << endl \
2263 << " Version " << required_version << " is required." << endl \
2264 << "Please upgrade/downgrade base package and set the path to your fgdata" << endl \
2265 << "with --fg-root=path_to_your_fgdata" << endl;
2267 cerr << "Hit a key to continue..." << endl;
2274 } // of namespace flightgear