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 using namespace flightgear;
89 #define NEW_DEFAULT_MODEL_HZ 120
91 static flightgear::Options* shared_instance = NULL;
94 atof( const string& str )
96 return ::atof( str.c_str() );
100 atoi( const string& str )
102 return ::atoi( str.c_str() );
105 static int fgSetupProxy( const char *arg );
108 * Set a few fail-safe default property values.
110 * These should all be set in $FG_ROOT/preferences.xml, but just
111 * in case, we provide some initial sane values here. This method
112 * should be invoked *before* reading any init files.
118 // Position (deliberately out of range)
119 fgSetDouble("/position/longitude-deg", 9999.0);
120 fgSetDouble("/position/latitude-deg", 9999.0);
121 fgSetDouble("/position/altitude-ft", -9999.0);
124 fgSetDouble("/orientation/heading-deg", 9999.0);
125 fgSetDouble("/orientation/roll-deg", 0.0);
126 fgSetDouble("/orientation/pitch-deg", 0.424);
129 fgSetDouble("/velocities/uBody-fps", 0.0);
130 fgSetDouble("/velocities/vBody-fps", 0.0);
131 fgSetDouble("/velocities/wBody-fps", 0.0);
132 fgSetDouble("/velocities/speed-north-fps", 0.0);
133 fgSetDouble("/velocities/speed-east-fps", 0.0);
134 fgSetDouble("/velocities/speed-down-fps", 0.0);
135 fgSetDouble("/velocities/airspeed-kt", 0.0);
136 fgSetDouble("/velocities/mach", 0.0);
139 fgSetDouble("/sim/presets/longitude-deg", 9999.0);
140 fgSetDouble("/sim/presets/latitude-deg", 9999.0);
141 fgSetDouble("/sim/presets/altitude-ft", -9999.0);
143 fgSetDouble("/sim/presets/heading-deg", 9999.0);
144 fgSetDouble("/sim/presets/roll-deg", 0.0);
145 fgSetDouble("/sim/presets/pitch-deg", 0.424);
147 fgSetString("/sim/presets/speed-set", "knots");
148 fgSetDouble("/sim/presets/airspeed-kt", 0.0);
149 fgSetDouble("/sim/presets/mach", 0.0);
150 fgSetDouble("/sim/presets/uBody-fps", 0.0);
151 fgSetDouble("/sim/presets/vBody-fps", 0.0);
152 fgSetDouble("/sim/presets/wBody-fps", 0.0);
153 fgSetDouble("/sim/presets/speed-north-fps", 0.0);
154 fgSetDouble("/sim/presets/speed-east-fps", 0.0);
155 fgSetDouble("/sim/presets/speed-down-fps", 0.0);
157 fgSetBool("/sim/presets/onground", true);
158 fgSetBool("/sim/presets/trim", false);
161 fgSetBool("/sim/startup/game-mode", false);
162 fgSetBool("/sim/startup/splash-screen", true);
163 fgSetBool("/sim/startup/intro-music", true);
164 // we want mouse-pointer to have an undefined value if nothing is
165 // specified so we can do the right thing for voodoo-1/2 cards.
166 // fgSetString("/sim/startup/mouse-pointer", "disabled");
167 fgSetString("/sim/control-mode", "joystick");
168 fgSetBool("/controls/flight/auto-coordination", false);
169 fgSetString("/sim/logging/priority", "alert");
172 fgSetBool("/sim/hud/color/antialiased", false);
173 fgSetBool("/sim/hud/enable3d[1]", true);
174 fgSetBool("/sim/hud/visibility[1]", false);
175 fgSetBool("/sim/panel/visibility", true);
176 fgSetBool("/sim/sound/enabled", true);
177 fgSetBool("/sim/sound/working", true);
178 fgSetBool("/sim/fgcom/enabled", false);
180 // Flight Model options
181 fgSetString("/sim/flight-model", "jsb");
182 fgSetString("/sim/aero", "c172");
183 fgSetInt("/sim/model-hz", NEW_DEFAULT_MODEL_HZ);
184 fgSetDouble("/sim/speed-up", 1.0);
187 fgSetString("/sim/rendering/fog", "nicest");
188 fgSetBool("/environment/clouds/status", true);
189 fgSetBool("/sim/startup/fullscreen", false);
190 fgSetBool("/sim/rendering/shading", true);
191 fgSetBool("/sim/rendering/skyblend", true);
192 fgSetBool("/sim/rendering/textures", true);
193 fgTie( "/sim/rendering/filtering", SGGetTextureFilter, SGSetTextureFilter, false);
194 fgSetInt("/sim/rendering/filtering", 1);
195 fgSetBool("/sim/rendering/wireframe", false);
196 fgSetBool("/sim/rendering/horizon-effect", false);
197 fgSetBool("/sim/rendering/enhanced-lighting", false);
198 fgSetBool("/sim/rendering/distance-attenuation", false);
199 fgSetBool("/sim/rendering/specular-highlight", true);
200 fgSetString("/sim/rendering/materials-file", "materials.xml");
201 fgSetInt("/sim/startup/xsize", 800);
202 fgSetInt("/sim/startup/ysize", 600);
203 fgSetInt("/sim/rendering/bits-per-pixel", 16);
204 fgSetString("/sim/view-mode", "pilot");
205 fgSetDouble("/sim/current-view/heading-offset-deg", 0);
208 fgSetString("/sim/startup/units", "feet");
209 fgSetString("/sim/hud/frame-stat-type", "tris");
212 fgSetInt("/sim/startup/time-offset", 0);
213 fgSetString("/sim/startup/time-offset-type", "system-offset");
214 fgSetLong("/sim/time/cur-time-override", 0);
217 fgSetBool("/sim/freeze/master", false);
218 fgSetBool("/sim/freeze/position", false);
219 fgSetBool("/sim/freeze/clock", false);
220 fgSetBool("/sim/freeze/fuel", false);
222 fgSetString("/sim/multiplay/callsign", "callsign");
223 fgSetString("/sim/multiplay/rxhost", "");
224 fgSetString("/sim/multiplay/txhost", "");
225 fgSetInt("/sim/multiplay/rxport", 0);
226 fgSetInt("/sim/multiplay/txport", 0);
228 SGPropertyNode* v = globals->get_props()->getNode("/sim/version", true);
229 v->setValueReadOnly("flightgear", FLIGHTGEAR_VERSION);
230 v->setValueReadOnly("simgear", SG_STRINGIZE(SIMGEAR_VERSION));
231 v->setValueReadOnly("openscenegraph", osgGetVersion());
232 v->setValueReadOnly("openscenegraph-thread-safe-reference-counting",
233 osg::Referenced::getThreadSafeReferenceCounting());
234 v->setValueReadOnly("revision", REVISION);
235 v->setValueReadOnly("build-number", HUDSON_BUILD_NUMBER);
236 v->setValueReadOnly("build-id", HUDSON_BUILD_ID);
237 v->setValueReadOnly("hla-support", bool(FG_HAVE_HLA));
239 char* envp = ::getenv( "http_proxy" );
241 fgSetupProxy( envp );
245 parse_wind (const string &wind, double * min_hdg, double * max_hdg,
246 double * speed, double * gust)
248 string::size_type pos = wind.find('@');
249 if (pos == string::npos)
251 string dir = wind.substr(0, pos);
252 string spd = wind.substr(pos+1);
254 if (pos == string::npos) {
255 *min_hdg = *max_hdg = atof(dir.c_str());
257 *min_hdg = atof(dir.substr(0,pos).c_str());
258 *max_hdg = atof(dir.substr(pos+1).c_str());
261 if (pos == string::npos) {
262 *speed = *gust = atof(spd.c_str());
264 *speed = atof(spd.substr(0,pos).c_str());
265 *gust = atof(spd.substr(pos+1).c_str());
271 parseIntValue(char** ppParserPos, int* pValue,int min, int max, const char* field, const char* argument)
273 if ( !strlen(*ppParserPos) )
279 while ( isdigit((*ppParserPos)[0]) && (i<255) )
281 num[i] = (*ppParserPos)[0];
287 switch ((*ppParserPos)[0])
295 SG_LOG(SG_GENERAL, SG_ALERT, "Illegal character in time string for " << field << ": '" <<
296 (*ppParserPos)[0] << "'.");
297 // invalid field - skip rest of string to avoid further errors
298 while ((*ppParserPos)[0])
306 int value = atoi(num);
307 if ((value < min)||(value > max))
309 SG_LOG(SG_GENERAL, SG_ALERT, "Invalid " << field << " in '" << argument <<
310 "'. Valid range is " << min << "-" << max << ".");
320 // parse a time string ([+/-]%f[:%f[:%f]]) into hours
322 parse_time(const string& time_in) {
323 char *time_str, num[256];
324 double hours, minutes, seconds;
329 time_str = (char *)time_in.c_str();
331 // printf("parse_time(): %s\n", time_str);
334 if ( strlen(time_str) ) {
335 if ( time_str[0] == '+' ) {
338 } else if ( time_str[0] == '-' ) {
343 // printf("sign = %d\n", sign);
346 if ( strlen(time_str) ) {
348 while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
349 num[i] = time_str[0];
353 if ( time_str[0] == ':' ) {
358 // printf("hours = %.2lf\n", hours);
364 if ( strlen(time_str) ) {
366 while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
367 num[i] = time_str[0];
371 if ( time_str[0] == ':' ) {
376 // printf("minutes = %.2lf\n", minutes);
378 result += minutes / 60.0;
382 if ( strlen(time_str) ) {
384 while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
385 num[i] = time_str[0];
391 // printf("seconds = %.2lf\n", seconds);
393 result += seconds / 3600.0;
396 SG_LOG( SG_GENERAL, SG_INFO, " parse_time() = " << sign * result );
398 return(sign * result);
401 // parse a date string (yyyy:mm:dd:hh:mm:ss) into a time_t (seconds)
403 parse_date( const string& date, const char* timeType)
405 struct tm gmt,*pCurrentTime;
406 int year,month,day,hour,minute,second;
407 char *argument, *date_str;
410 CurrentTime.update(SGGeod(),0,0);
412 // FIXME This should obtain system/aircraft/GMT time depending on timeType
413 pCurrentTime = CurrentTime.getGmt();
415 // initialize all fields with current time
416 year = pCurrentTime->tm_year + 1900;
417 month = pCurrentTime->tm_mon + 1;
418 day = pCurrentTime->tm_mday;
419 hour = pCurrentTime->tm_hour;
420 minute = pCurrentTime->tm_min;
421 second = pCurrentTime->tm_sec;
423 argument = (char *)date.c_str();
426 // start with parsing year
427 if (!strlen(date_str) ||
428 !parseIntValue(&date_str,&year,0,9999,"year",argument))
435 SG_LOG(SG_GENERAL, SG_ALERT, "Invalid year '" << year << "'. Use 1970 or later.");
439 parseIntValue(&date_str, &month, 1, 12, "month", argument);
440 parseIntValue(&date_str, &day, 1, 31, "day", argument);
441 parseIntValue(&date_str, &hour, 0, 23, "hour", argument);
442 parseIntValue(&date_str, &minute, 0, 59, "minute", argument);
443 parseIntValue(&date_str, &second, 0, 59, "second", argument);
449 gmt.tm_mon = month - 1;
450 gmt.tm_year = year -1900;
451 gmt.tm_isdst = 0; // ignore daylight savings time for the moment
453 time_t theTime = sgTimeGetGMT( gmt.tm_year, gmt.tm_mon, gmt.tm_mday,
454 gmt.tm_hour, gmt.tm_min, gmt.tm_sec );
456 SG_LOG(SG_GENERAL, SG_INFO, "Configuring startup time to " << ctime(&theTime));
462 // parse angle in the form of [+/-]ddd:mm:ss into degrees
464 parse_degree( const string& degree_str) {
465 double result = parse_time( degree_str );
467 // printf("Degree = %.4f\n", result);
473 // parse time offset string into seconds
475 parse_time_offset( const string& time_str) {
478 // printf("time offset = %s\n", time_str);
481 result = (int)rint(parse_time(time_str) * 3600.0);
483 result = (int)(parse_time(time_str) * 3600.0);
486 // printf("parse_time_offset(): %d\n", result);
492 // Parse --fov=x.xx type option
494 parse_fov( const string& arg ) {
495 double fov = atof(arg);
497 if ( fov < FG_FOV_MIN ) { fov = FG_FOV_MIN; }
498 if ( fov > FG_FOV_MAX ) { fov = FG_FOV_MAX; }
500 fgSetDouble("/sim/view[0]/config/default-field-of-view-deg", fov);
502 // printf("parse_fov(): result = %.4f\n", fov);
508 // Parse I/O channel option
510 // Format is "--protocol=medium,direction,hz,medium_options,..."
512 // protocol = { native, nmea, garmin, AV400, AV400Sim, fgfs, rul, pve, etc. }
513 // medium = { serial, socket, file, etc. }
514 // direction = { in, out, bi }
515 // hz = number of times to process channel per second (floating
516 // point values are ok.
518 // Serial example "--nmea=serial,dir,hz,device,baud" where
520 // device = OS device name of serial line to be open()'ed
521 // baud = {300, 1200, 2400, ..., 230400}
523 // Socket exacmple "--native=socket,dir,hz,machine,port,style" where
525 // machine = machine name or ip address if client (leave empty if server)
526 // port = port, leave empty to let system choose
527 // style = tcp or udp
529 // File example "--garmin=file,dir,hz,filename" where
531 // filename = file system file name
534 add_channel( const string& type, const string& channel_str ) {
535 // This check is neccessary to prevent fgviewer from segfaulting when given
536 // weird options. (It doesn't run the full initailization)
537 if(!globals->get_channel_options_list())
539 SG_LOG(SG_GENERAL, SG_ALERT, "Option " << type << "=" << channel_str
543 SG_LOG(SG_GENERAL, SG_INFO, "Channel string = " << channel_str );
544 globals->get_channel_options_list()->push_back( type + "," + channel_str );
551 fgSetString("/sim/presets/airport-id", "");
552 fgSetString("/sim/presets/vor-id", "");
553 fgSetString("/sim/presets/ndb-id", "");
554 fgSetString("/sim/presets/carrier", "");
555 fgSetString("/sim/presets/parkpos", "");
556 fgSetString("/sim/presets/fix", "");
560 fgOptVOR( const char * arg )
563 fgSetString("/sim/presets/vor-id", arg);
564 return FG_OPTIONS_OK;
568 fgOptNDB( const char * arg )
571 fgSetString("/sim/presets/ndb-id", arg);
572 return FG_OPTIONS_OK;
576 fgOptCarrier( const char * arg )
579 fgSetString("/sim/presets/carrier", arg);
580 return FG_OPTIONS_OK;
584 fgOptParkpos( const char * arg )
586 fgSetString("/sim/presets/parkpos", arg);
587 return FG_OPTIONS_OK;
591 fgOptFIX( const char * arg )
594 fgSetString("/sim/presets/fix", arg);
595 return FG_OPTIONS_OK;
599 fgOptLon( const char *arg )
602 fgSetDouble("/sim/presets/longitude-deg", parse_degree( arg ));
603 fgSetDouble("/position/longitude-deg", parse_degree( arg ));
604 return FG_OPTIONS_OK;
608 fgOptLat( const char *arg )
611 fgSetDouble("/sim/presets/latitude-deg", parse_degree( arg ));
612 fgSetDouble("/position/latitude-deg", parse_degree( arg ));
613 return FG_OPTIONS_OK;
617 fgOptAltitude( const char *arg )
619 fgSetBool("/sim/presets/onground", false);
620 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
621 fgSetDouble("/sim/presets/altitude-ft", atof( arg ));
623 fgSetDouble("/sim/presets/altitude-ft",
624 atof( arg ) * SG_METER_TO_FEET);
625 return FG_OPTIONS_OK;
629 fgOptUBody( const char *arg )
631 fgSetString("/sim/presets/speed-set", "UVW");
632 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
633 fgSetDouble("/sim/presets/uBody-fps", atof( arg ));
635 fgSetDouble("/sim/presets/uBody-fps",
636 atof( arg ) * SG_METER_TO_FEET);
637 return FG_OPTIONS_OK;
641 fgOptVBody( const char *arg )
643 fgSetString("/sim/presets/speed-set", "UVW");
644 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
645 fgSetDouble("/sim/presets/vBody-fps", atof( arg ));
647 fgSetDouble("/sim/presets/vBody-fps",
648 atof( arg ) * SG_METER_TO_FEET);
649 return FG_OPTIONS_OK;
653 fgOptWBody( const char *arg )
655 fgSetString("/sim/presets/speed-set", "UVW");
656 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
657 fgSetDouble("/sim/presets/wBody-fps", atof(arg));
659 fgSetDouble("/sim/presets/wBody-fps",
660 atof(arg) * SG_METER_TO_FEET);
661 return FG_OPTIONS_OK;
665 fgOptVNorth( const char *arg )
667 fgSetString("/sim/presets/speed-set", "NED");
668 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
669 fgSetDouble("/sim/presets/speed-north-fps", atof( arg ));
671 fgSetDouble("/sim/presets/speed-north-fps",
672 atof( arg ) * SG_METER_TO_FEET);
673 return FG_OPTIONS_OK;
677 fgOptVEast( const char *arg )
679 fgSetString("/sim/presets/speed-set", "NED");
680 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
681 fgSetDouble("/sim/presets/speed-east-fps", atof(arg));
683 fgSetDouble("/sim/presets/speed-east-fps",
684 atof(arg) * SG_METER_TO_FEET);
685 return FG_OPTIONS_OK;
689 fgOptVDown( const char *arg )
691 fgSetString("/sim/presets/speed-set", "NED");
692 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
693 fgSetDouble("/sim/presets/speed-down-fps", atof(arg));
695 fgSetDouble("/sim/presets/speed-down-fps",
696 atof(arg) * SG_METER_TO_FEET);
697 return FG_OPTIONS_OK;
701 fgOptVc( const char *arg )
703 // fgSetString("/sim/presets/speed-set", "knots");
704 // fgSetDouble("/velocities/airspeed-kt", atof(arg.substr(5)));
705 fgSetString("/sim/presets/speed-set", "knots");
706 fgSetDouble("/sim/presets/airspeed-kt", atof(arg));
707 return FG_OPTIONS_OK;
711 fgOptMach( const char *arg )
713 fgSetString("/sim/presets/speed-set", "mach");
714 fgSetDouble("/sim/presets/mach", atof(arg));
715 return FG_OPTIONS_OK;
719 fgOptRoc( const char *arg )
721 fgSetDouble("/sim/presets/vertical-speed-fps", atof(arg)/60);
722 return FG_OPTIONS_OK;
726 fgOptFgScenery( const char *arg )
728 globals->append_fg_scenery(arg);
729 return FG_OPTIONS_OK;
733 fgOptFov( const char *arg )
736 return FG_OPTIONS_OK;
740 fgOptGeometry( const char *arg )
742 bool geometry_ok = true;
743 int xsize = 0, ysize = 0;
744 string geometry = arg;
745 string::size_type i = geometry.find('x');
747 if (i != string::npos) {
748 xsize = atoi(geometry.substr(0, i));
749 ysize = atoi(geometry.substr(i+1));
754 if ( xsize <= 0 || ysize <= 0 ) {
760 if ( !geometry_ok ) {
761 SG_LOG( SG_GENERAL, SG_ALERT, "Unknown geometry: " << geometry );
762 SG_LOG( SG_GENERAL, SG_ALERT,
763 "Setting geometry to " << xsize << 'x' << ysize << '\n');
765 SG_LOG( SG_GENERAL, SG_INFO,
766 "Setting geometry to " << xsize << 'x' << ysize << '\n');
767 fgSetInt("/sim/startup/xsize", xsize);
768 fgSetInt("/sim/startup/ysize", ysize);
770 return FG_OPTIONS_OK;
774 fgOptBpp( const char *arg )
776 string bits_per_pix = arg;
777 if ( bits_per_pix == "16" ) {
778 fgSetInt("/sim/rendering/bits-per-pixel", 16);
779 } else if ( bits_per_pix == "24" ) {
780 fgSetInt("/sim/rendering/bits-per-pixel", 24);
781 } else if ( bits_per_pix == "32" ) {
782 fgSetInt("/sim/rendering/bits-per-pixel", 32);
784 SG_LOG(SG_GENERAL, SG_ALERT, "Unsupported bpp " << bits_per_pix);
786 return FG_OPTIONS_OK;
790 fgOptTimeOffset( const char *arg )
792 fgSetLong("/sim/startup/time-offset",
793 parse_time_offset( arg ));
794 fgSetString("/sim/startup/time-offset-type", "system-offset");
795 return FG_OPTIONS_OK;
799 fgOptStartDateSys( const char *arg )
801 long int theTime = parse_date( arg, "system" );
804 fgSetLong("/sim/startup/time-offset", theTime);
805 fgSetString("/sim/startup/time-offset-type", "system");
807 return FG_OPTIONS_OK;
811 fgOptStartDateLat( const char *arg )
813 long int theTime = parse_date( arg, "latitude" );
816 fgSetLong("/sim/startup/time-offset", theTime);
817 fgSetString("/sim/startup/time-offset-type", "latitude");
819 return FG_OPTIONS_OK;
823 fgOptStartDateGmt( const char *arg )
825 long int theTime = parse_date( arg, "gmt" );
828 fgSetLong("/sim/startup/time-offset", theTime);
829 fgSetString("/sim/startup/time-offset-type", "gmt");
831 return FG_OPTIONS_OK;
835 fgSetupProxy( const char *arg )
837 string options = simgear::strutils::strip( arg );
838 string host, port, auth;
839 string::size_type pos;
841 // this is NURLP - NURLP is not an url parser
842 if( simgear::strutils::starts_with( options, "http://" ) )
843 options = options.substr( 7 );
844 if( simgear::strutils::ends_with( options, "/" ) )
845 options = options.substr( 0, options.length() - 1 );
847 host = port = auth = "";
848 if ((pos = options.find("@")) != string::npos)
849 auth = options.substr(0, pos++);
853 host = options.substr(pos, options.size());
854 if ((pos = host.find(":")) != string::npos) {
855 port = host.substr(++pos, host.size());
856 host.erase(--pos, host.size());
859 fgSetString("/sim/presets/proxy/host", host.c_str());
860 fgSetString("/sim/presets/proxy/port", port.c_str());
861 fgSetString("/sim/presets/proxy/authentication", auth.c_str());
863 return FG_OPTIONS_OK;
867 fgOptTraceRead( const char *arg )
870 SG_LOG(SG_GENERAL, SG_INFO, "Tracing reads for property " << name);
871 fgGetNode(name.c_str(), true)
872 ->setAttribute(SGPropertyNode::TRACE_READ, true);
873 return FG_OPTIONS_OK;
877 fgOptLogLevel( const char *arg )
879 fgSetString("/sim/logging/priority", arg);
880 setLoggingPriority(arg);
882 return FG_OPTIONS_OK;
886 fgOptLogClasses( const char *arg )
888 fgSetString("/sim/logging/classes", arg);
889 setLoggingClasses (arg);
891 return FG_OPTIONS_OK;
895 fgOptTraceWrite( const char *arg )
898 SG_LOG(SG_GENERAL, SG_INFO, "Tracing writes for property " << name);
899 fgGetNode(name.c_str(), true)
900 ->setAttribute(SGPropertyNode::TRACE_WRITE, true);
901 return FG_OPTIONS_OK;
905 fgOptViewOffset( const char *arg )
907 // $$$ begin - added VS Renganathan, 14 Oct 2K
908 // for multi-window outside window imagery
909 string woffset = arg;
910 double default_view_offset = 0.0;
911 if ( woffset == "LEFT" ) {
912 default_view_offset = SGD_PI * 0.25;
913 } else if ( woffset == "RIGHT" ) {
914 default_view_offset = SGD_PI * 1.75;
915 } else if ( woffset == "CENTER" ) {
916 default_view_offset = 0.00;
918 default_view_offset = atof( woffset.c_str() ) * SGD_DEGREES_TO_RADIANS;
920 /* apparently not used (CLO, 11 Jun 2002)
921 FGViewer *pilot_view =
922 (FGViewer *)globals->get_viewmgr()->get_view( 0 ); */
923 // this will work without calls to the viewer...
924 fgSetDouble( "/sim/current-view/heading-offset-deg",
925 default_view_offset * SGD_RADIANS_TO_DEGREES );
926 // $$$ end - added VS Renganathan, 14 Oct 2K
927 return FG_OPTIONS_OK;
931 fgOptVisibilityMeters( const char *arg )
933 Environment::Presets::VisibilitySingleton::instance()->preset( atof( arg ) );
934 return FG_OPTIONS_OK;
938 fgOptVisibilityMiles( const char *arg )
940 Environment::Presets::VisibilitySingleton::instance()->preset( atof( arg ) * 5280.0 * SG_FEET_TO_METER );
941 return FG_OPTIONS_OK;
945 fgOptRandomWind( const char *arg )
947 double min_hdg = sg_random() * 360.0;
948 double max_hdg = min_hdg + (20 - sqrt(sg_random() * 400));
949 double speed = sg_random() * sg_random() * 40;
950 double gust = speed + (10 - sqrt(sg_random() * 100));
951 Environment::Presets::WindSingleton::instance()->preset(min_hdg, max_hdg, speed, gust);
952 return FG_OPTIONS_OK;
956 fgOptWind( const char *arg )
958 double min_hdg = 0.0, max_hdg = 0.0, speed = 0.0, gust = 0.0;
959 if (!parse_wind( arg, &min_hdg, &max_hdg, &speed, &gust)) {
960 SG_LOG( SG_GENERAL, SG_ALERT, "bad wind value " << arg );
961 return FG_OPTIONS_ERROR;
963 Environment::Presets::WindSingleton::instance()->preset(min_hdg, max_hdg, speed, gust);
964 return FG_OPTIONS_OK;
968 fgOptTurbulence( const char *arg )
970 Environment::Presets::TurbulenceSingleton::instance()->preset( atof(arg) );
971 return FG_OPTIONS_OK;
975 fgOptCeiling( const char *arg )
977 double elevation, thickness;
979 string::size_type pos = spec.find(':');
980 if (pos == string::npos) {
981 elevation = atof(spec.c_str());
984 elevation = atof(spec.substr(0, pos).c_str());
985 thickness = atof(spec.substr(pos + 1).c_str());
987 Environment::Presets::CeilingSingleton::instance()->preset( elevation, thickness );
988 return FG_OPTIONS_OK;
992 fgOptWp( const char *arg )
994 string_list *waypoints = globals->get_initial_waypoints();
996 waypoints = new string_list;
997 globals->set_initial_waypoints(waypoints);
999 waypoints->push_back(arg);
1000 return FG_OPTIONS_OK;
1004 fgOptConfig( const char *arg )
1008 readProperties(file, globals->get_props());
1009 } catch (const sg_exception &e) {
1010 string message = "Error loading config file: ";
1011 message += e.getFormattedMessage() + e.getOrigin();
1012 SG_LOG(SG_INPUT, SG_ALERT, message);
1013 return FG_OPTIONS_ERROR;
1015 return FG_OPTIONS_OK;
1019 parse_colon (const string &s, double * val1, double * val2)
1021 string::size_type pos = s.find(':');
1022 if (pos == string::npos) {
1026 *val1 = atof(s.substr(0, pos).c_str());
1027 *val2 = atof(s.substr(pos+1).c_str());
1034 fgOptFailure( const char * arg )
1038 fgSetBool("/systems/pitot/serviceable", false);
1039 } else if (a == "static") {
1040 fgSetBool("/systems/static/serviceable", false);
1041 } else if (a == "vacuum") {
1042 fgSetBool("/systems/vacuum/serviceable", false);
1043 } else if (a == "electrical") {
1044 fgSetBool("/systems/electrical/serviceable", false);
1046 SG_LOG(SG_INPUT, SG_ALERT, "Unknown failure mode: " << a);
1047 return FG_OPTIONS_ERROR;
1050 return FG_OPTIONS_OK;
1055 fgOptNAV1( const char * arg )
1057 double radial, freq;
1058 if (parse_colon(arg, &radial, &freq))
1059 fgSetDouble("/instrumentation/nav[0]/radials/selected-deg", radial);
1060 fgSetDouble("/instrumentation/nav[0]/frequencies/selected-mhz", freq);
1061 return FG_OPTIONS_OK;
1065 fgOptNAV2( const char * arg )
1067 double radial, freq;
1068 if (parse_colon(arg, &radial, &freq))
1069 fgSetDouble("/instrumentation/nav[1]/radials/selected-deg", radial);
1070 fgSetDouble("/instrumentation/nav[1]/frequencies/selected-mhz", freq);
1071 return FG_OPTIONS_OK;
1075 fgOptADF1( const char * arg )
1078 if (parse_colon(arg, &rot, &freq))
1079 fgSetDouble("/instrumentation/adf[0]/rotation-deg", rot);
1080 fgSetDouble("/instrumentation/adf[0]/frequencies/selected-khz", freq);
1081 return FG_OPTIONS_OK;
1085 fgOptADF2( const char * arg )
1088 if (parse_colon(arg, &rot, &freq))
1089 fgSetDouble("/instrumentation/adf[1]/rotation-deg", rot);
1090 fgSetDouble("/instrumentation/adf[1]/frequencies/selected-khz", freq);
1091 return FG_OPTIONS_OK;
1095 fgOptDME( const char *arg )
1098 if (opt == "nav1") {
1099 fgSetInt("/instrumentation/dme/switch-position", 1);
1100 fgSetString("/instrumentation/dme/frequencies/source",
1101 "/instrumentation/nav[0]/frequencies/selected-mhz");
1102 } else if (opt == "nav2") {
1103 fgSetInt("/instrumentation/dme/switch-position", 3);
1104 fgSetString("/instrumentation/dme/frequencies/source",
1105 "/instrumentation/nav[1]/frequencies/selected-mhz");
1107 double frequency = atof(arg);
1110 SG_LOG(SG_INPUT, SG_ALERT, "Invalid DME frequency: '" << arg << "'.");
1111 return FG_OPTIONS_ERROR;
1113 fgSetInt("/instrumentation/dme/switch-position", 2);
1114 fgSetString("/instrumentation/dme/frequencies/source",
1115 "/instrumentation/dme/frequencies/selected-mhz");
1116 fgSetDouble("/instrumentation/dme/frequencies/selected-mhz", frequency);
1118 return FG_OPTIONS_OK;
1122 fgOptLivery( const char *arg )
1125 string livery_path = "livery/" + opt;
1126 fgSetString("/sim/model/texture-path", livery_path.c_str() );
1127 return FG_OPTIONS_OK;
1131 fgOptScenario( const char *arg )
1133 SGPropertyNode_ptr ai_node = fgGetNode( "/sim/ai", true );
1134 vector<SGPropertyNode_ptr> scenarii = ai_node->getChildren( "scenario" );
1136 for ( size_t i = 0; i < scenarii.size(); ++i ) {
1137 int ind = scenarii[i]->getIndex();
1138 if ( index < ind ) {
1142 SGPropertyNode_ptr scenario = ai_node->getNode( "scenario", index + 1, true );
1143 scenario->setStringValue( arg );
1144 return FG_OPTIONS_OK;
1148 fgOptRunway( const char *arg )
1150 fgSetString("/sim/presets/runway", arg );
1151 fgSetBool("/sim/presets/runway-requested", true );
1152 return FG_OPTIONS_OK;
1156 fgOptParking( const char *arg )
1158 cerr << "Processing argument " << arg << endl;
1159 fgSetString("/sim/presets/parking", arg );
1160 fgSetBool ("/sim/presets/parking-requested", true );
1161 return FG_OPTIONS_OK;
1165 fgOptVersion( const char *arg )
1167 cerr << "FlightGear version: " << FLIGHTGEAR_VERSION << endl;
1168 cerr << "Revision: " << REVISION << endl;
1169 cerr << "Build-Id: " << HUDSON_BUILD_ID << endl;
1170 cerr << "FG_ROOT=" << globals->get_fg_root() << endl;
1171 cerr << "FG_HOME=" << globals->get_fg_home() << endl;
1172 cerr << "FG_SCENERY=";
1175 string_list scn = globals->get_fg_scenery();
1176 for (string_list::const_iterator it = scn.begin(); it != scn.end(); it++)
1178 if (didsome) cerr << ":";
1183 cerr << "SimGear version: " << SG_STRINGIZE(SIMGEAR_VERSION) << endl;
1184 cerr << "PLIB version: " << PLIB_VERSION << endl;
1185 return FG_OPTIONS_EXIT;
1189 fgOptCallSign(const char * arg)
1193 strncpy(callsign,arg,10);
1195 for (i=0;callsign[i];i++)
1197 char c = callsign[i];
1198 if (c >= 'A' && c <= 'Z') continue;
1199 if (c >= 'a' && c <= 'z') continue;
1200 if (c >= '0' && c <= '9') continue;
1201 if (c == '-' || c == '_') continue;
1202 // convert any other illegal characters
1205 fgSetString("sim/multiplay/callsign", callsign );
1206 return FG_OPTIONS_OK;
1210 fgOptIgnoreAutosave(const char* arg)
1212 fgSetBool("/sim/startup/ignore-autosave", true);
1213 // don't overwrite autosave on exit
1214 fgSetBool("/sim/startup/save-on-exit", false);
1215 return FG_OPTIONS_OK;
1218 // Set a property for the --prop: option. Syntax: --prop:[<type>:]<name>=<value>
1219 // <type> can be "double" etc. but also only the first letter "d".
1220 // Examples: --prop:alpha=1 --prop:bool:beta=true --prop:d:gamma=0.123
1222 fgOptSetProperty(const char* raw)
1225 string::size_type pos = arg.find('=');
1226 if (pos == arg.npos || pos == 0 || pos + 1 == arg.size())
1227 return FG_OPTIONS_ERROR;
1229 string name = arg.substr(0, pos);
1230 string value = arg.substr(pos + 1);
1232 pos = name.find(':');
1234 if (pos != name.npos && pos != 0 && pos + 1 != name.size()) {
1235 type = name.substr(0, pos);
1236 name = name.substr(pos + 1);
1238 SGPropertyNode *n = fgGetNode(name.c_str(), true);
1240 bool writable = n->getAttribute(SGPropertyNode::WRITE);
1242 n->setAttribute(SGPropertyNode::WRITE, true);
1246 ret = n->setUnspecifiedValue(value.c_str());
1247 else if (type == "s" || type == "string")
1248 ret = n->setStringValue(value.c_str());
1249 else if (type == "d" || type == "double")
1250 ret = n->setDoubleValue(strtod(value.c_str(), 0));
1251 else if (type == "f" || type == "float")
1252 ret = n->setFloatValue(atof(value.c_str()));
1253 else if (type == "l" || type == "long")
1254 ret = n->setLongValue(strtol(value.c_str(), 0, 0));
1255 else if (type == "i" || type == "int")
1256 ret = n->setIntValue(atoi(value.c_str()));
1257 else if (type == "b" || type == "bool")
1258 ret = n->setBoolValue(value == "true" || atoi(value.c_str()) != 0);
1261 n->setAttribute(SGPropertyNode::WRITE, false);
1262 return ret ? FG_OPTIONS_OK : FG_OPTIONS_ERROR;
1268 option has_param type property b_param s_param func
1271 option : name of the option
1272 has_param : option is --name=value if true or --name if false
1273 type : OPTION_BOOL - property is a boolean
1274 OPTION_STRING - property is a string
1275 OPTION_DOUBLE - property is a double
1276 OPTION_INT - property is an integer
1277 OPTION_CHANNEL - name of option is the name of a channel
1278 OPTION_FUNC - the option trigger a function
1279 b_param : if type==OPTION_BOOL,
1280 value set to the property (has_param is false for boolean)
1281 s_param : if type==OPTION_STRING,
1282 value set to the property if has_param is false
1283 func : function called if type==OPTION_FUNC. if has_param is true,
1284 the value is passed to the function as a string, otherwise,
1287 For OPTION_DOUBLE and OPTION_INT, the parameter value is converted into a
1288 double or an integer and set to the property.
1290 For OPTION_CHANNEL, add_channel is called with the parameter value as the
1294 enum OptionType { OPTION_BOOL = 0, OPTION_STRING, OPTION_DOUBLE, OPTION_INT, OPTION_CHANNEL, OPTION_FUNC, OPTION_IGNORE };
1295 const int OPTION_MULTI = 1 << 17;
1301 const char *property;
1303 const char *s_param;
1304 int (*func)( const char * );
1305 } fgOptionArray[] = {
1307 {"language", true, OPTION_IGNORE, "", false, "", 0 },
1308 {"console", false, OPTION_IGNORE, "", false, "", 0 },
1309 {"disable-rembrandt", false, OPTION_BOOL, "/sim/rendering/rembrandt/enabled", false, "", 0 },
1310 {"enable-rembrandt", false, OPTION_BOOL, "/sim/rendering/rembrandt/enabled", true, "", 0 },
1311 {"renderer", true, OPTION_STRING, "/sim/rendering/rembrandt/renderer", false, "", 0 },
1312 {"disable-game-mode", false, OPTION_BOOL, "/sim/startup/game-mode", false, "", 0 },
1313 {"enable-game-mode", false, OPTION_BOOL, "/sim/startup/game-mode", true, "", 0 },
1314 {"disable-splash-screen", false, OPTION_BOOL, "/sim/startup/splash-screen", false, "", 0 },
1315 {"enable-splash-screen", false, OPTION_BOOL, "/sim/startup/splash-screen", true, "", 0 },
1316 {"disable-intro-music", false, OPTION_BOOL, "/sim/startup/intro-music", false, "", 0 },
1317 {"enable-intro-music", false, OPTION_BOOL, "/sim/startup/intro-music", true, "", 0 },
1318 {"disable-mouse-pointer", false, OPTION_STRING, "/sim/startup/mouse-pointer", false, "disabled", 0 },
1319 {"enable-mouse-pointer", false, OPTION_STRING, "/sim/startup/mouse-pointer", false, "enabled", 0 },
1320 {"disable-random-objects", false, OPTION_BOOL, "/sim/rendering/random-objects", false, "", 0 },
1321 {"enable-random-objects", false, OPTION_BOOL, "/sim/rendering/random-objects", true, "", 0 },
1322 {"disable-random-vegetation", false, OPTION_BOOL, "/sim/rendering/random-vegetation", false, "", 0 },
1323 {"enable-random-vegetation", false, OPTION_BOOL, "/sim/rendering/random-vegetation", true, "", 0 },
1324 {"disable-random-buildings", false, OPTION_BOOL, "/sim/rendering/random-buildings", false, "", 0 },
1325 {"enable-random-buildings", false, OPTION_BOOL, "/sim/rendering/random-buildings", true, "", 0 },
1326 {"disable-real-weather-fetch", false, OPTION_BOOL, "/environment/realwx/enabled", false, "", 0 },
1327 {"enable-real-weather-fetch", false, OPTION_BOOL, "/environment/realwx/enabled", true, "", 0 },
1328 {"metar", true, OPTION_STRING, "/environment/metar/data", false, "", 0 },
1329 {"disable-ai-models", false, OPTION_BOOL, "/sim/ai/enabled", false, "", 0 },
1330 {"enable-ai-models", false, OPTION_BOOL, "/sim/ai/enabled", true, "", 0 },
1331 {"disable-ai-traffic", false, OPTION_BOOL, "/sim/traffic-manager/enabled", false, "", 0 },
1332 {"enable-ai-traffic", false, OPTION_BOOL, "/sim/traffic-manager/enabled", true, "", 0 },
1333 {"disable-freeze", false, OPTION_BOOL, "/sim/freeze/master", false, "", 0 },
1334 {"enable-freeze", false, OPTION_BOOL, "/sim/freeze/master", true, "", 0 },
1335 {"disable-fuel-freeze", false, OPTION_BOOL, "/sim/freeze/fuel", false, "", 0 },
1336 {"enable-fuel-freeze", false, OPTION_BOOL, "/sim/freeze/fuel", true, "", 0 },
1337 {"disable-clock-freeze", false, OPTION_BOOL, "/sim/freeze/clock", false, "", 0 },
1338 {"enable-clock-freeze", false, OPTION_BOOL, "/sim/freeze/clock", true, "", 0 },
1339 {"disable-hud-3d", false, OPTION_BOOL, "/sim/hud/enable3d[1]", false, "", 0 },
1340 {"enable-hud-3d", false, OPTION_BOOL, "/sim/hud/enable3d[1]", true, "", 0 },
1341 {"disable-anti-alias-hud", false, OPTION_BOOL, "/sim/hud/color/antialiased", false, "", 0 },
1342 {"enable-anti-alias-hud", false, OPTION_BOOL, "/sim/hud/color/antialiased", true, "", 0 },
1343 {"control", true, OPTION_STRING, "/sim/control-mode", false, "", 0 },
1344 {"disable-auto-coordination", false, OPTION_BOOL, "/controls/flight/auto-coordination", false, "", 0 },
1345 {"enable-auto-coordination", false, OPTION_BOOL, "/controls/flight/auto-coordination", true, "", 0 },
1346 {"browser-app", true, OPTION_STRING, "/sim/startup/browser-app", false, "", 0 },
1347 {"disable-hud", false, OPTION_BOOL, "/sim/hud/visibility[1]", false, "", 0 },
1348 {"enable-hud", false, OPTION_BOOL, "/sim/hud/visibility[1]", true, "", 0 },
1349 {"disable-panel", false, OPTION_BOOL, "/sim/panel/visibility", false, "", 0 },
1350 {"enable-panel", false, OPTION_BOOL, "/sim/panel/visibility", true, "", 0 },
1351 {"disable-sound", false, OPTION_BOOL, "/sim/sound/working", false, "", 0 },
1352 {"enable-sound", false, OPTION_BOOL, "/sim/sound/working", true, "", 0 },
1353 {"sound-device", true, OPTION_STRING, "/sim/sound/device-name", false, "", 0 },
1354 {"airport", true, OPTION_STRING, "/sim/presets/airport-id", false, "", 0 },
1355 {"runway", true, OPTION_FUNC, "", false, "", fgOptRunway },
1356 {"vor", true, OPTION_FUNC, "", false, "", fgOptVOR },
1357 {"vor-frequency", true, OPTION_DOUBLE, "/sim/presets/vor-freq", false, "", fgOptVOR },
1358 {"ndb", true, OPTION_FUNC, "", false, "", fgOptNDB },
1359 {"ndb-frequency", true, OPTION_DOUBLE, "/sim/presets/ndb-freq", false, "", fgOptVOR },
1360 {"carrier", true, OPTION_FUNC, "", false, "", fgOptCarrier },
1361 {"parkpos", true, OPTION_FUNC, "", false, "", fgOptParkpos },
1362 {"fix", true, OPTION_FUNC, "", false, "", fgOptFIX },
1363 {"offset-distance", true, OPTION_DOUBLE, "/sim/presets/offset-distance-nm", false, "", 0 },
1364 {"offset-azimuth", true, OPTION_DOUBLE, "/sim/presets/offset-azimuth-deg", false, "", 0 },
1365 {"lon", true, OPTION_FUNC, "", false, "", fgOptLon },
1366 {"lat", true, OPTION_FUNC, "", false, "", fgOptLat },
1367 {"altitude", true, OPTION_FUNC, "", false, "", fgOptAltitude },
1368 {"uBody", true, OPTION_FUNC, "", false, "", fgOptUBody },
1369 {"vBody", true, OPTION_FUNC, "", false, "", fgOptVBody },
1370 {"wBody", true, OPTION_FUNC, "", false, "", fgOptWBody },
1371 {"vNorth", true, OPTION_FUNC, "", false, "", fgOptVNorth },
1372 {"vEast", true, OPTION_FUNC, "", false, "", fgOptVEast },
1373 {"vDown", true, OPTION_FUNC, "", false, "", fgOptVDown },
1374 {"vc", true, OPTION_FUNC, "", false, "", fgOptVc },
1375 {"mach", true, OPTION_FUNC, "", false, "", fgOptMach },
1376 {"heading", true, OPTION_DOUBLE, "/sim/presets/heading-deg", false, "", 0 },
1377 {"roll", true, OPTION_DOUBLE, "/sim/presets/roll-deg", false, "", 0 },
1378 {"pitch", true, OPTION_DOUBLE, "/sim/presets/pitch-deg", false, "", 0 },
1379 {"glideslope", true, OPTION_DOUBLE, "/sim/presets/glideslope-deg", false, "", 0 },
1380 {"roc", true, OPTION_FUNC, "", false, "", fgOptRoc },
1381 {"fg-root", true, OPTION_IGNORE, "", false, "", 0 },
1382 {"fg-scenery", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptFgScenery },
1383 {"fg-aircraft", true, OPTION_IGNORE | OPTION_MULTI, "", false, "", 0 },
1384 {"fdm", true, OPTION_STRING, "/sim/flight-model", false, "", 0 },
1385 {"aero", true, OPTION_STRING, "/sim/aero", false, "", 0 },
1386 {"aircraft-dir", true, OPTION_IGNORE, "", false, "", 0 },
1387 {"model-hz", true, OPTION_INT, "/sim/model-hz", false, "", 0 },
1388 {"max-fps", true, OPTION_DOUBLE, "/sim/frame-rate-throttle-hz", false, "", 0 },
1389 {"speed", true, OPTION_DOUBLE, "/sim/speed-up", false, "", 0 },
1390 {"trim", false, OPTION_BOOL, "/sim/presets/trim", true, "", 0 },
1391 {"notrim", false, OPTION_BOOL, "/sim/presets/trim", false, "", 0 },
1392 {"on-ground", false, OPTION_BOOL, "/sim/presets/onground", true, "", 0 },
1393 {"in-air", false, OPTION_BOOL, "/sim/presets/onground", false, "", 0 },
1394 {"fog-disable", false, OPTION_STRING, "/sim/rendering/fog", false, "disabled", 0 },
1395 {"fog-fastest", false, OPTION_STRING, "/sim/rendering/fog", false, "fastest", 0 },
1396 {"fog-nicest", false, OPTION_STRING, "/sim/rendering/fog", false, "nicest", 0 },
1397 {"disable-horizon-effect", false, OPTION_BOOL, "/sim/rendering/horizon-effect", false, "", 0 },
1398 {"enable-horizon-effect", false, OPTION_BOOL, "/sim/rendering/horizon-effect", true, "", 0 },
1399 {"disable-enhanced-lighting", false, OPTION_BOOL, "/sim/rendering/enhanced-lighting", false, "", 0 },
1400 {"enable-enhanced-lighting", false, OPTION_BOOL, "/sim/rendering/enhanced-lighting", true, "", 0 },
1401 {"disable-distance-attenuation", false, OPTION_BOOL, "/sim/rendering/distance-attenuation", false, "", 0 },
1402 {"enable-distance-attenuation", false, OPTION_BOOL, "/sim/rendering/distance-attenuation", true, "", 0 },
1403 {"disable-specular-highlight", false, OPTION_BOOL, "/sim/rendering/specular-highlight", false, "", 0 },
1404 {"enable-specular-highlight", false, OPTION_BOOL, "/sim/rendering/specular-highlight", true, "", 0 },
1405 {"disable-clouds", false, OPTION_BOOL, "/environment/clouds/status", false, "", 0 },
1406 {"enable-clouds", false, OPTION_BOOL, "/environment/clouds/status", true, "", 0 },
1407 {"disable-clouds3d", false, OPTION_BOOL, "/sim/rendering/clouds3d-enable", false, "", 0 },
1408 {"enable-clouds3d", false, OPTION_BOOL, "/sim/rendering/clouds3d-enable", true, "", 0 },
1409 {"fov", true, OPTION_FUNC, "", false, "", fgOptFov },
1410 {"aspect-ratio-multiplier", true, OPTION_DOUBLE, "/sim/current-view/aspect-ratio-multiplier", false, "", 0 },
1411 {"disable-fullscreen", false, OPTION_BOOL, "/sim/startup/fullscreen", false, "", 0 },
1412 {"enable-fullscreen", false, OPTION_BOOL, "/sim/startup/fullscreen", true, "", 0 },
1413 {"disable-save-on-exit", false, OPTION_BOOL, "/sim/startup/save-on-exit", false, "", 0 },
1414 {"enable-save-on-exit", false, OPTION_BOOL, "/sim/startup/save-on-exit", true, "", 0 },
1415 {"ignore-autosave", false, OPTION_FUNC, "", false, "", fgOptIgnoreAutosave },
1416 {"restore-defaults", false, OPTION_BOOL, "/sim/startup/restore-defaults", true, "", 0 },
1417 {"shading-flat", false, OPTION_BOOL, "/sim/rendering/shading", false, "", 0 },
1418 {"shading-smooth", false, OPTION_BOOL, "/sim/rendering/shading", true, "", 0 },
1419 {"disable-skyblend", false, OPTION_BOOL, "/sim/rendering/skyblend", false, "", 0 },
1420 {"enable-skyblend", false, OPTION_BOOL, "/sim/rendering/skyblend", true, "", 0 },
1421 {"disable-textures", false, OPTION_BOOL, "/sim/rendering/textures", false, "", 0 },
1422 {"enable-textures", false, OPTION_BOOL, "/sim/rendering/textures", true, "", 0 },
1423 {"texture-filtering", false, OPTION_INT, "/sim/rendering/filtering", 1, "", 0 },
1424 {"disable-wireframe", false, OPTION_BOOL, "/sim/rendering/wireframe", false, "", 0 },
1425 {"enable-wireframe", false, OPTION_BOOL, "/sim/rendering/wireframe", true, "", 0 },
1426 {"materials-file", true, OPTION_STRING, "/sim/rendering/materials-file", false, "", 0 },
1427 {"disable-terrasync", false, OPTION_BOOL, "/sim/terrasync/enabled", false, "", 0 },
1428 {"enable-terrasync", false, OPTION_BOOL, "/sim/terrasync/enabled", true, "", 0 },
1429 {"terrasync-dir", true, OPTION_STRING, "/sim/terrasync/scenery-dir", false, "", 0 },
1430 {"geometry", true, OPTION_FUNC, "", false, "", fgOptGeometry },
1431 {"bpp", true, OPTION_FUNC, "", false, "", fgOptBpp },
1432 {"units-feet", false, OPTION_STRING, "/sim/startup/units", false, "feet", 0 },
1433 {"units-meters", false, OPTION_STRING, "/sim/startup/units", false, "meters", 0 },
1434 {"timeofday", true, OPTION_STRING, "/sim/startup/time-offset-type", false, "noon", 0 },
1435 {"season", true, OPTION_STRING, "/sim/startup/season", false, "summer", 0 },
1436 {"time-offset", true, OPTION_FUNC, "", false, "", fgOptTimeOffset },
1437 {"time-match-real", false, OPTION_STRING, "/sim/startup/time-offset-type", false, "system-offset", 0 },
1438 {"time-match-local", false, OPTION_STRING, "/sim/startup/time-offset-type", false, "latitude-offset", 0 },
1439 {"start-date-sys", true, OPTION_FUNC, "", false, "", fgOptStartDateSys },
1440 {"start-date-lat", true, OPTION_FUNC, "", false, "", fgOptStartDateLat },
1441 {"start-date-gmt", true, OPTION_FUNC, "", false, "", fgOptStartDateGmt },
1442 {"hud-tris", false, OPTION_STRING, "/sim/hud/frame-stat-type", false, "tris", 0 },
1443 {"hud-culled", false, OPTION_STRING, "/sim/hud/frame-stat-type", false, "culled", 0 },
1444 {"atcsim", true, OPTION_CHANNEL, "", false, "dummy", 0 },
1445 {"atlas", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1446 {"httpd", true, OPTION_CHANNEL, "", false, "", 0 },
1447 #ifdef FG_JPEG_SERVER
1448 {"jpg-httpd", true, OPTION_CHANNEL, "", false, "", 0 },
1450 {"native", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1451 {"native-ctrls", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1452 {"native-fdm", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1453 {"native-gui", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1454 {"opengc", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1455 {"AV400", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1456 {"AV400Sim", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1457 {"AV400WSimA", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1458 {"AV400WSimB", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1459 {"garmin", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1460 {"igc", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1461 {"nmea", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1462 {"generic", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1463 {"props", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1464 {"telnet", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1465 {"pve", true, OPTION_CHANNEL, "", false, "", 0 },
1466 {"ray", true, OPTION_CHANNEL, "", false, "", 0 },
1467 {"rul", true, OPTION_CHANNEL, "", false, "", 0 },
1468 {"joyclient", true, OPTION_CHANNEL, "", false, "", 0 },
1469 {"jsclient", true, OPTION_CHANNEL, "", false, "", 0 },
1470 {"proxy", true, OPTION_FUNC, "", false, "", fgSetupProxy },
1471 {"callsign", true, OPTION_FUNC, "", false, "", fgOptCallSign},
1472 {"multiplay", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1474 {"hla", true, OPTION_CHANNEL, "", false, "", 0 },
1475 {"hla-local", true, OPTION_CHANNEL, "", false, "", 0 },
1477 {"trace-read", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptTraceRead },
1478 {"trace-write", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptTraceWrite },
1479 {"log-level", true, OPTION_FUNC, "", false, "", fgOptLogLevel },
1480 {"log-class", true, OPTION_FUNC, "", false, "", fgOptLogClasses },
1481 {"view-offset", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptViewOffset },
1482 {"visibility", true, OPTION_FUNC, "", false, "", fgOptVisibilityMeters },
1483 {"visibility-miles", true, OPTION_FUNC, "", false, "", fgOptVisibilityMiles },
1484 {"random-wind", false, OPTION_FUNC, "", false, "", fgOptRandomWind },
1485 {"wind", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptWind },
1486 {"turbulence", true, OPTION_FUNC, "", false, "", fgOptTurbulence },
1487 {"ceiling", true, OPTION_FUNC, "", false, "", fgOptCeiling },
1488 {"wp", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptWp },
1489 {"flight-plan", true, OPTION_STRING, "/autopilot/route-manager/file-path", false, "", NULL },
1490 {"config", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptConfig },
1491 {"aircraft", true, OPTION_STRING, "/sim/aircraft", false, "", 0 },
1492 {"vehicle", true, OPTION_STRING, "/sim/aircraft", false, "", 0 },
1493 {"failure", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptFailure },
1495 {"enable-fgcom", false, OPTION_BOOL, "/sim/fgcom/enabled", true, "", 0 },
1496 {"disable-fgcom", false, OPTION_BOOL, "/sim/fgcom/enabled", false, "", 0 },
1498 {"com1", true, OPTION_DOUBLE, "/instrumentation/comm[0]/frequencies/selected-mhz", false, "", 0 },
1499 {"com2", true, OPTION_DOUBLE, "/instrumentation/comm[1]/frequencies/selected-mhz", false, "", 0 },
1500 {"nav1", true, OPTION_FUNC, "", false, "", fgOptNAV1 },
1501 {"nav2", true, OPTION_FUNC, "", false, "", fgOptNAV2 },
1502 {"adf", /*legacy*/ true, OPTION_FUNC, "", false, "", fgOptADF1 },
1503 {"adf1", true, OPTION_FUNC, "", false, "", fgOptADF1 },
1504 {"adf2", true, OPTION_FUNC, "", false, "", fgOptADF2 },
1505 {"dme", true, OPTION_FUNC, "", false, "", fgOptDME },
1506 {"min-status", true, OPTION_STRING, "/sim/aircraft-min-status", false, "all", 0 },
1507 {"livery", true, OPTION_FUNC, "", false, "", fgOptLivery },
1508 {"ai-scenario", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptScenario },
1509 {"parking-id", true, OPTION_FUNC, "", false, "", fgOptParking },
1510 {"version", false, OPTION_FUNC, "", false, "", fgOptVersion },
1511 {"enable-fpe", false, OPTION_IGNORE, "", false, "", 0},
1512 {"fgviewer", false, OPTION_IGNORE, "", false, "", 0},
1513 {"no-default-config", false, OPTION_IGNORE, "", false, "", 0},
1514 {"prop", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptSetProperty},
1519 namespace flightgear
1523 * internal storage of a value->option binding
1528 OptionValue(OptionDesc* d, const string& v) :
1536 typedef std::vector<OptionValue> OptionValueVec;
1537 typedef std::map<string, OptionDesc*> OptionDescDict;
1539 class Options::OptionsPrivate
1543 OptionValueVec::const_iterator findValue(const string& key) const
1545 OptionValueVec::const_iterator it = values.begin();
1546 for (; it != values.end(); ++it) {
1548 continue; // ignore markers
1551 if (it->desc->option == key) {
1554 } // of set values iteration
1556 return it; // not found
1559 OptionDesc* findOption(const string& key) const
1561 OptionDescDict::const_iterator it = options.find(key);
1562 if (it == options.end()) {
1569 int processOption(OptionDesc* desc, const string& arg_value)
1572 return FG_OPTIONS_OK; // tolerate marker options
1575 switch ( desc->type & 0xffff ) {
1577 fgSetBool( desc->property, desc->b_param );
1580 if ( desc->has_param && !arg_value.empty() ) {
1581 fgSetString( desc->property, arg_value.c_str() );
1582 } else if ( !desc->has_param && arg_value.empty() ) {
1583 fgSetString( desc->property, desc->s_param );
1584 } else if ( desc->has_param ) {
1585 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' needs a parameter" );
1586 return FG_OPTIONS_ERROR;
1588 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' does not have a parameter" );
1589 return FG_OPTIONS_ERROR;
1593 if ( !arg_value.empty() ) {
1594 fgSetDouble( desc->property, atof( arg_value ) );
1596 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' needs a parameter" );
1597 return FG_OPTIONS_ERROR;
1601 if ( !arg_value.empty() ) {
1602 fgSetInt( desc->property, atoi( arg_value ) );
1604 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' needs a parameter" );
1605 return FG_OPTIONS_ERROR;
1608 case OPTION_CHANNEL:
1609 // XXX return value of add_channel should be checked?
1610 if ( desc->has_param && !arg_value.empty() ) {
1611 add_channel( desc->option, arg_value );
1612 } else if ( !desc->has_param && arg_value.empty() ) {
1613 add_channel( desc->option, desc->s_param );
1614 } else if ( desc->has_param ) {
1615 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' needs a parameter" );
1616 return FG_OPTIONS_ERROR;
1618 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' does not have a parameter" );
1619 return FG_OPTIONS_ERROR;
1623 if ( desc->has_param && !arg_value.empty() ) {
1624 return desc->func( arg_value.c_str() );
1625 } else if ( !desc->has_param && arg_value.empty() ) {
1626 return desc->func( desc->s_param );
1627 } else if ( desc->has_param ) {
1628 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' needs a parameter" );
1629 return FG_OPTIONS_ERROR;
1631 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' does not have a parameter" );
1632 return FG_OPTIONS_ERROR;
1640 return FG_OPTIONS_OK;
1644 * insert a marker value into the values vector. This is necessary
1645 * when processing options, to ensure the correct ordering, where we scan
1646 * for marker values in reverse, and then forwards within each group.
1648 void insertGroupMarker()
1650 values.push_back(OptionValue(NULL, "-"));
1654 * given a current iterator into the values, find the preceeding group marker,
1655 * or return the beginning of the value vector.
1657 OptionValueVec::const_iterator rfindGroup(OptionValueVec::const_iterator pos) const
1659 while (--pos != values.begin()) {
1660 if (pos->desc == NULL) {
1661 return pos; // found a marker, we're done
1671 shouldLoadDefaultConfig;
1673 OptionDescDict options;
1674 OptionValueVec values;
1675 simgear::PathList propertyFiles;
1678 Options* Options::sharedInstance()
1680 if (shared_instance == NULL) {
1681 shared_instance = new Options;
1684 return shared_instance;
1687 Options::Options() :
1688 p(new OptionsPrivate())
1690 p->showHelp = false;
1692 p->showAircraft = false;
1693 p->shouldLoadDefaultConfig = true;
1696 OptionDesc *desc = &fgOptionArray[ 0 ];
1697 while ( desc->option != 0 ) {
1698 p->options[ desc->option ] = desc;
1707 void Options::init(int argc, char **argv, const SGPath& appDataPath)
1711 // first, process the command line
1712 bool inOptions = true;
1713 for (int i=1; i<argc; ++i) {
1714 if (inOptions && (argv[i][0] == '-')) {
1715 if (strcmp(argv[i], "--") == 0) { // end of options delimiter
1720 int result = parseOption(argv[i]);
1721 processArgResult(result);
1723 // XML properties file
1726 SG_LOG(SG_GENERAL, SG_ALERT, "config file not found:" << f.str());
1730 p->propertyFiles.push_back(f);
1732 } // of arguments iteration
1733 p->insertGroupMarker(); // command line is one group
1735 // establish log-level before anything else - otherwise it is not possible
1736 // to show extra (debug/info/warning) messages for the start-up phase.
1737 fgOptLogLevel(valueForOption("log-level", "alert").c_str());
1739 if (!p->shouldLoadDefaultConfig) {
1744 // then config files
1746 std::string homedir;
1747 if (getenv("HOME")) {
1748 homedir = getenv("HOME");
1751 if( !homedir.empty() && !hostname.empty() ) {
1752 // Check for ~/.fgfsrc.hostname
1753 config.set(homedir);
1754 config.append(".fgfsrc");
1755 config.concat( "." );
1756 config.concat( hostname );
1760 // Check for ~/.fgfsrc
1761 if( !homedir.empty() ) {
1762 config.set(homedir);
1763 config.append(".fgfsrc");
1767 // check for a config file in app data
1768 SGPath appDataConfig(appDataPath);
1769 appDataConfig.append("fgfsrc");
1770 if (appDataConfig.exists()) {
1771 readConfig(appDataConfig);
1777 // system.fgfsrc handling
1778 if( ! hostname.empty() ) {
1779 config.set(globals->get_fg_root());
1780 config.append( "system.fgfsrc" );
1781 config.concat( "." );
1782 config.concat( hostname );
1786 config.set(globals->get_fg_root());
1787 config.append( "system.fgfsrc" );
1791 void Options::initAircraft()
1793 BOOST_FOREACH(const string& paths, valuesForOption("fg-aircraft")) {
1794 globals->append_aircraft_paths(paths);
1797 const char* envp = ::getenv("FG_AIRCRAFT");
1799 globals->append_aircraft_paths(envp);
1803 if (isOptionSet("aircraft")) {
1804 aircraft = valueForOption("aircraft");
1805 } else if (isOptionSet("vehicle")) {
1806 aircraft = valueForOption("vehicle");
1809 if (!aircraft.empty()) {
1810 SG_LOG(SG_INPUT, SG_INFO, "aircraft = " << aircraft );
1811 fgSetString("/sim/aircraft", aircraft.c_str() );
1813 SG_LOG(SG_INPUT, SG_INFO, "No user specified aircraft, using default" );
1816 if (p->showAircraft) {
1817 fgOptLogLevel( "alert" );
1818 SGPath path( globals->get_fg_root() );
1819 path.append("Aircraft");
1820 fgShowAircraft(path);
1824 if (isOptionSet("aircraft-dir")) {
1825 // set this now, so it's available in FindAndCacheAircraft
1826 fgSetString("/sim/aircraft-dir", valueForOption("aircraft-dir"));
1830 void Options::processArgResult(int result)
1832 if ((result == FG_OPTIONS_HELP) || (result == FG_OPTIONS_ERROR))
1834 else if (result == FG_OPTIONS_VERBOSE_HELP)
1836 else if (result == FG_OPTIONS_SHOW_AIRCRAFT) {
1837 p->showAircraft = true;
1838 } else if (result == FG_OPTIONS_NO_DEFAULT_CONFIG) {
1839 p->shouldLoadDefaultConfig = false;
1840 } else if (result == FG_OPTIONS_SHOW_SOUND_DEVICES) {
1844 string vendor = smgr.get_vendor();
1845 string renderer = smgr.get_renderer();
1846 cout << renderer << " provided by " << vendor << endl;
1847 cout << endl << "No. Device" << endl;
1849 vector <const char*>devices = smgr.get_available_devices();
1850 for (vector <const char*>::size_type i=0; i<devices.size(); i++) {
1851 cout << i << ". \"" << devices[i] << "\"" << endl;
1856 } else if (result == FG_OPTIONS_EXIT) {
1861 void Options::readConfig(const SGPath& path)
1863 sg_gzifstream in( path.str() );
1864 if ( !in.is_open() ) {
1868 SG_LOG( SG_GENERAL, SG_INFO, "Processing config file: " << path.str() );
1871 while ( ! in.eof() ) {
1873 getline( in, line, '\n' );
1875 // catch extraneous (DOS) line ending character
1877 for (i = line.length(); i > 0; i--)
1878 if (line[i - 1] > 32)
1880 line = line.substr( 0, i );
1882 if ( parseOption( line ) == FG_OPTIONS_ERROR ) {
1883 cerr << endl << "Config file parse error: " << path.str() << " '"
1884 << line << "'" << endl;
1890 p->insertGroupMarker(); // each config file is a group
1893 int Options::parseOption(const string& s)
1895 if ((s == "--help") || (s=="-h")) {
1896 return FG_OPTIONS_HELP;
1897 } else if ( (s == "--verbose") || (s == "-v") ) {
1898 // verbose help/usage request
1899 return FG_OPTIONS_VERBOSE_HELP;
1900 } else if ((s == "--console") || (s == "-c")) {
1901 simgear::requestConsole();
1902 return FG_OPTIONS_OK;
1903 } else if (s.find("-psn") == 0) {
1904 // on Mac, when launched from the GUI, we are passed the ProcessSerialNumber
1905 // as an argument (and no others). Silently ignore the argument here.
1906 return FG_OPTIONS_OK;
1907 } else if ( s.find( "--show-aircraft") == 0) {
1908 return(FG_OPTIONS_SHOW_AIRCRAFT);
1909 } else if ( s.find( "--show-sound-devices") == 0) {
1910 return(FG_OPTIONS_SHOW_SOUND_DEVICES);
1911 } else if ( s.find( "--no-default-config") == 0) {
1912 return FG_OPTIONS_NO_DEFAULT_CONFIG;
1913 } else if ( s.find( "--prop:") == 0) {
1914 // property setting has a slightly different syntax, so fudge things
1915 OptionDesc* desc = p->findOption("prop");
1916 if (s.find("=", 7) == string::npos) { // no equals token
1917 SG_LOG(SG_GENERAL, SG_ALERT, "malformed property option:" << s);
1918 return FG_OPTIONS_ERROR;
1921 p->values.push_back(OptionValue(desc, s.substr(7)));
1922 return FG_OPTIONS_OK;
1923 } else if ( s.find( "--" ) == 0 ) {
1924 size_t eqPos = s.find( '=' );
1926 if (eqPos == string::npos) {
1929 key = s.substr( 2, eqPos - 2 );
1930 value = s.substr( eqPos + 1);
1933 return addOption(key, value);
1935 SG_LOG(SG_GENERAL, SG_ALERT, "unknown option:" << s);
1936 return FG_OPTIONS_ERROR;
1940 int Options::addOption(const string &key, const string &value)
1942 OptionDesc* desc = p->findOption(key);
1944 SG_LOG(SG_GENERAL, SG_ALERT, "unknown option:" << key);
1945 return FG_OPTIONS_ERROR;
1948 if (!(desc->type & OPTION_MULTI)) {
1949 OptionValueVec::const_iterator it = p->findValue(key);
1950 if (it != p->values.end()) {
1951 SG_LOG(SG_GENERAL, SG_INFO, "multiple values forbidden for option:" << key << ", ignoring:" << value);
1952 return FG_OPTIONS_OK;
1956 p->values.push_back(OptionValue(desc, value));
1957 return FG_OPTIONS_OK;
1960 bool Options::isOptionSet(const string &key) const
1962 OptionValueVec::const_iterator it = p->findValue(key);
1963 return (it != p->values.end());
1966 string Options::valueForOption(const string& key, const string& defValue) const
1968 OptionValueVec::const_iterator it = p->findValue(key);
1969 if (it == p->values.end()) {
1976 string_list Options::valuesForOption(const std::string& key) const
1979 OptionValueVec::const_iterator it = p->values.begin();
1980 for (; it != p->values.end(); ++it) {
1982 continue; // ignore marker values
1985 if (it->desc->option == key) {
1986 result.push_back(it->value);
1993 OptionResult Options::processOptions()
1995 // establish locale before showing help (this selects the default locale,
1996 // when no explicit option was set)
1997 globals->get_locale()->selectLanguage(valueForOption("language").c_str());
1999 // now FG_ROOT is setup, process various command line options that bail us
2000 // out quickly, but rely on aircraft / root settings
2003 return FG_OPTIONS_EXIT;
2006 // processing order is complicated. We must process groups LIFO, but the
2007 // values *within* each group in FIFO order, to retain consistency with
2008 // older versions of FG, and existing user configs.
2009 // in practice this means system.fgfsrc must be *processed* before
2010 // .fgfsrc, which must be processed before the command line args, and so on.
2011 OptionValueVec::const_iterator groupEnd = p->values.end();
2013 while (groupEnd != p->values.begin()) {
2014 OptionValueVec::const_iterator groupBegin = p->rfindGroup(groupEnd);
2015 // run over the group in FIFO order
2016 OptionValueVec::const_iterator it;
2017 for (it = groupBegin; it != groupEnd; ++it) {
2018 int result = p->processOption(it->desc, it->value);
2021 case FG_OPTIONS_ERROR:
2023 return FG_OPTIONS_ERROR;
2025 case FG_OPTIONS_EXIT:
2026 return FG_OPTIONS_EXIT;
2033 groupEnd = groupBegin;
2036 BOOST_FOREACH(const SGPath& file, p->propertyFiles) {
2037 if (!file.exists()) {
2038 SG_LOG(SG_GENERAL, SG_ALERT, "config file not found:" << file.str());
2042 SG_LOG(SG_GENERAL, SG_INFO,
2043 "Reading command-line property file " << file.str());
2044 readProperties(file.str(), globals->get_props());
2047 // now options are process, do supplemental fixup
2048 const char *envp = ::getenv( "FG_SCENERY" );
2050 globals->append_fg_scenery(envp);
2053 // terrasync directory fixup
2054 if (fgGetBool("/sim/terrasync/enabled")) {
2055 string terrasyncDir = fgGetString("/sim/terrasync/scenery-dir");
2056 if (terrasyncDir.empty()) {
2057 SGPath p(globals->get_fg_home());
2058 p.append("TerraSync");
2059 terrasyncDir = p.str();
2060 SG_LOG(SG_GENERAL, SG_INFO,
2061 "Using default TerraSync dir: " << terrasyncDir);
2062 fgSetString("/sim/terrasync/scenery-dir", terrasyncDir);
2065 SGPath p(terrasyncDir);
2066 // following is necessary to ensure NavDataCache sees stable scenery paths from
2067 // terrasync. Ensure the Terrain and Objects subdirs exist immediately, rather
2068 // than waiting for the first tiles to be scheduled.
2069 simgear::Dir terrainDir(SGPath(p, "Terrain")),
2070 objectsDir(SGPath(p, "Objects"));
2071 if (!terrainDir.exists()) {
2072 terrainDir.create(0755);
2075 if (!objectsDir.exists()) {
2076 objectsDir.create(0755);
2079 const string_list& scenery_paths(globals->get_fg_scenery());
2080 if (std::find(scenery_paths.begin(), scenery_paths.end(), terrasyncDir) == scenery_paths.end()) {
2081 // terrasync dir is not in the scenery paths, add it
2082 globals->append_fg_scenery(terrasyncDir);
2086 if (globals->get_fg_scenery().empty()) {
2087 // no scenery paths set *at all*, use the data in FG_ROOT
2088 SGPath root(globals->get_fg_root());
2089 root.append("Scenery");
2090 globals->append_fg_scenery(root.str());
2093 return FG_OPTIONS_OK;
2096 void Options::showUsage() const
2098 fgOptLogLevel( "alert" );
2100 FGLocale *locale = globals->get_locale();
2101 SGPropertyNode options_root;
2103 simgear::requestConsole(); // ensure console is shown on Windows
2107 fgLoadProps("options.xml", &options_root);
2108 } catch (const sg_exception &) {
2109 cout << "Unable to read the help file." << endl;
2110 cout << "Make sure the file options.xml is located in the FlightGear base directory," << endl;
2111 cout << "and the location of the base directory is specified by setting $FG_ROOT or" << endl;
2112 cout << "by adding --fg-root=path as a program argument." << endl;
2117 SGPropertyNode *options = options_root.getNode("options");
2119 SG_LOG( SG_GENERAL, SG_ALERT,
2120 "Error reading options.xml: <options> directive not found." );
2124 if (!locale->loadResource("options"))
2126 cout << "Unable to read the language resource." << endl;
2130 const char* usage = locale->getLocalizedString(options->getStringValue("usage"), "options");
2132 cout << usage << endl;
2135 vector<SGPropertyNode_ptr>section = options->getChildren("section");
2136 for (unsigned int j = 0; j < section.size(); j++) {
2139 vector<SGPropertyNode_ptr>option = section[j]->getChildren("option");
2140 for (unsigned int k = 0; k < option.size(); k++) {
2142 SGPropertyNode *name = option[k]->getNode("name");
2143 SGPropertyNode *short_name = option[k]->getNode("short");
2144 SGPropertyNode *key = option[k]->getNode("key");
2145 SGPropertyNode *arg = option[k]->getNode("arg");
2146 bool brief = option[k]->getNode("brief") != 0;
2148 if ((brief || p->verbose) && name) {
2149 string tmp = name->getStringValue();
2153 tmp.append(key->getStringValue());
2157 tmp.append(arg->getStringValue());
2161 tmp.append(short_name->getStringValue());
2164 if (tmp.size() <= 25) {
2167 msg.append( 27-tmp.size(), ' ');
2171 msg.append(32, ' ');
2173 // There may be more than one <description> tag associated
2176 vector<SGPropertyNode_ptr> desc;
2177 desc = option[k]->getChildren("description");
2178 if (! desc.empty()) {
2179 for ( unsigned int l = 0; l < desc.size(); l++) {
2180 string t = desc[l]->getStringValue();
2182 // There may be more than one translation line.
2183 vector<SGPropertyNode_ptr>trans_desc = locale->getLocalizedStrings(t.c_str(),"options");
2184 for ( unsigned int m = 0; m < trans_desc.size(); m++ ) {
2185 string t_str = trans_desc[m]->getStringValue();
2187 if ((m > 0) || ((l > 0) && m == 0)) {
2188 msg.append( 32, ' ');
2191 // If the string is too large to fit on the screen,
2192 // then split it up in several pieces.
2194 while ( t_str.size() > 47 ) {
2196 string::size_type m = t_str.rfind(' ', 47);
2197 msg += t_str.substr(0, m) + '\n';
2198 msg.append( 32, ' ');
2200 t_str.erase(t_str.begin(), t_str.begin() + m + 1);
2202 msg += t_str + '\n';
2209 const char* name = locale->getLocalizedString(section[j]->getStringValue("name"),"options");
2210 if (!msg.empty() && name) {
2211 cout << endl << name << ":" << endl;
2217 if ( !p->verbose ) {
2218 const char* verbose_help = locale->getLocalizedString(options->getStringValue("verbose-help"),"options");
2220 cout << endl << verbose_help << endl;
2223 std::cout << "Hit a key to continue..." << std::endl;
2228 #if defined(__CYGWIN__)
2229 string Options::platformDefaultRoot() const
2234 #elif defined(_WIN32)
2235 string Options::platformDefaultRoot() const
2239 #elif defined(__APPLE__)
2240 string Options::platformDefaultRoot() const
2243 The following code looks for the base package inside the application
2244 bundle, in the standard Contents/Resources location.
2246 CFURLRef resourcesUrl = CFBundleCopyResourcesDirectoryURL(CFBundleGetMainBundle());
2248 // look for a 'data' subdir
2249 CFURLRef dataDir = CFURLCreateCopyAppendingPathComponent(NULL, resourcesUrl, CFSTR("data"), true);
2251 CFURLRef absoluteDataUrl = CFURLCopyAbsoluteURL(dataDir);
2253 // now convert down to a path, and the a c-string
2254 CFStringRef path = CFURLCopyFileSystemPath(absoluteDataUrl, kCFURLPOSIXPathStyle);
2255 string root = CFStringGetCStringPtr(path, CFStringGetSystemEncoding());
2257 CFRelease(absoluteDataUrl);
2258 CFRelease(resourcesUrl);
2265 string Options::platformDefaultRoot() const
2271 void Options::setupRoot()
2274 if (isOptionSet("fg-root")) {
2275 root = valueForOption("fg-root"); // easy!
2277 // Next check if fg-root is set as an env variable
2278 char *envp = ::getenv( "FG_ROOT" );
2279 if ( envp != NULL ) {
2282 root = platformDefaultRoot();
2286 SG_LOG(SG_INPUT, SG_INFO, "fg_root = " << root );
2287 globals->set_fg_root(root);
2290 static char required_version[] = FLIGHTGEAR_VERSION;
2291 string base_version = fgBasePackageVersion();
2292 if ( !(base_version == required_version) ) {
2293 // tell the operator how to use this application
2295 simgear::requestConsole(); // ensure console is shown on Windows
2297 cerr << endl << "Base package check failed:" << endl \
2298 << " Version " << base_version << " found at: " \
2299 << globals->get_fg_root() << endl \
2300 << " Version " << required_version << " is required." << endl \
2301 << "Please upgrade/downgrade base package and set the path to your fgdata" << endl \
2302 << "with --fg-root=path_to_your_fgdata" << endl;
2304 cerr << "Hit a key to continue..." << endl;
2311 bool Options::shouldLoadDefaultConfig() const
2313 return p->shouldLoadDefaultConfig;
2316 } // of namespace flightgear