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 <GUI/MessageBox.hxx>
57 #include <Main/locale.hxx>
58 #include "globals.hxx"
59 #include "fg_init.hxx"
60 #include "fg_props.hxx"
61 #include "options.hxx"
65 #include <Viewer/viewer.hxx>
66 #include <Viewer/viewmgr.hxx>
67 #include <Environment/presets.hxx>
68 #include "AircraftDirVisitorBase.hxx"
70 #include <osg/Version>
72 #if defined( HAVE_VERSION_H ) && HAVE_VERSION_H
73 # include <Include/version.h>
74 # include <simgear/version.h>
76 # include <Include/no_version.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.
114 void fgSetDefaults ()
117 // Position (deliberately out of range)
118 fgSetDouble("/position/longitude-deg", 9999.0);
119 fgSetDouble("/position/latitude-deg", 9999.0);
120 fgSetDouble("/position/altitude-ft", -9999.0);
123 fgSetDouble("/orientation/heading-deg", 9999.0);
124 fgSetDouble("/orientation/roll-deg", 0.0);
125 fgSetDouble("/orientation/pitch-deg", 0.424);
128 fgSetDouble("/velocities/uBody-fps", 0.0);
129 fgSetDouble("/velocities/vBody-fps", 0.0);
130 fgSetDouble("/velocities/wBody-fps", 0.0);
131 fgSetDouble("/velocities/speed-north-fps", 0.0);
132 fgSetDouble("/velocities/speed-east-fps", 0.0);
133 fgSetDouble("/velocities/speed-down-fps", 0.0);
134 fgSetDouble("/velocities/airspeed-kt", 0.0);
135 fgSetDouble("/velocities/mach", 0.0);
138 fgSetDouble("/sim/presets/longitude-deg", 9999.0);
139 fgSetDouble("/sim/presets/latitude-deg", 9999.0);
140 fgSetDouble("/sim/presets/altitude-ft", -9999.0);
142 fgSetDouble("/sim/presets/heading-deg", 9999.0);
143 fgSetDouble("/sim/presets/roll-deg", 0.0);
144 fgSetDouble("/sim/presets/pitch-deg", 0.424);
146 fgSetString("/sim/presets/speed-set", "knots");
147 fgSetDouble("/sim/presets/airspeed-kt", 0.0);
148 fgSetDouble("/sim/presets/mach", 0.0);
149 fgSetDouble("/sim/presets/uBody-fps", 0.0);
150 fgSetDouble("/sim/presets/vBody-fps", 0.0);
151 fgSetDouble("/sim/presets/wBody-fps", 0.0);
152 fgSetDouble("/sim/presets/speed-north-fps", 0.0);
153 fgSetDouble("/sim/presets/speed-east-fps", 0.0);
154 fgSetDouble("/sim/presets/speed-down-fps", 0.0);
156 fgSetBool("/sim/presets/onground", true);
157 fgSetBool("/sim/presets/trim", false);
160 fgSetBool("/sim/startup/splash-screen", true);
161 // we want mouse-pointer to have an undefined value if nothing is
162 // specified so we can do the right thing for voodoo-1/2 cards.
163 // fgSetString("/sim/startup/mouse-pointer", "disabled");
164 fgSetString("/sim/control-mode", "joystick");
165 fgSetBool("/controls/flight/auto-coordination", false);
166 fgSetString("/sim/logging/priority", "alert");
169 fgSetBool("/sim/hud/color/antialiased", false);
170 fgSetBool("/sim/hud/enable3d[1]", true);
171 fgSetBool("/sim/hud/visibility[1]", false);
172 fgSetBool("/sim/panel/visibility", true);
173 fgSetBool("/sim/sound/enabled", true);
174 fgSetBool("/sim/sound/working", true);
175 fgSetBool("/sim/fgcom/enabled", false);
177 // Flight Model options
178 fgSetString("/sim/flight-model", "jsb");
179 fgSetString("/sim/aero", "c172");
180 fgSetInt("/sim/model-hz", NEW_DEFAULT_MODEL_HZ);
181 fgSetDouble("/sim/speed-up", 1.0);
184 fgSetString("/sim/rendering/fog", "nicest");
185 fgSetBool("/environment/clouds/status", true);
186 fgSetBool("/sim/startup/fullscreen", false);
187 fgSetBool("/sim/rendering/shading", true);
188 fgTie( "/sim/rendering/filtering", SGGetTextureFilter, SGSetTextureFilter, false);
189 fgSetInt("/sim/rendering/filtering", 1);
190 fgSetBool("/sim/rendering/wireframe", false);
191 fgSetBool("/sim/rendering/horizon-effect", false);
192 fgSetBool("/sim/rendering/enhanced-lighting", false);
193 fgSetBool("/sim/rendering/distance-attenuation", false);
194 fgSetBool("/sim/rendering/specular-highlight", true);
195 fgSetString("/sim/rendering/materials-file", "materials.xml");
196 fgSetInt("/sim/startup/xsize", 1024);
197 fgSetInt("/sim/startup/ysize", 768);
198 fgSetInt("/sim/rendering/bits-per-pixel", 32);
199 fgSetString("/sim/view-mode", "pilot");
200 fgSetDouble("/sim/current-view/heading-offset-deg", 0);
203 fgSetString("/sim/startup/units", "feet");
204 fgSetString("/sim/hud/frame-stat-type", "tris");
207 fgSetInt("/sim/startup/time-offset", 0);
208 fgSetString("/sim/startup/time-offset-type", "system-offset");
209 fgSetLong("/sim/time/cur-time-override", 0);
212 fgSetBool("/sim/freeze/master", false);
213 fgSetBool("/sim/freeze/position", false);
214 fgSetBool("/sim/freeze/clock", false);
215 fgSetBool("/sim/freeze/fuel", false);
217 fgSetString("/sim/multiplay/callsign", "callsign");
218 fgSetString("/sim/multiplay/rxhost", "");
219 fgSetString("/sim/multiplay/txhost", "");
220 fgSetInt("/sim/multiplay/rxport", 0);
221 fgSetInt("/sim/multiplay/txport", 0);
223 SGPropertyNode* v = globals->get_props()->getNode("/sim/version", true);
224 v->setValueReadOnly("flightgear", FLIGHTGEAR_VERSION);
225 v->setValueReadOnly("simgear", SG_STRINGIZE(SIMGEAR_VERSION));
226 v->setValueReadOnly("openscenegraph", osgGetVersion());
227 v->setValueReadOnly("openscenegraph-thread-safe-reference-counting",
228 osg::Referenced::getThreadSafeReferenceCounting());
229 v->setValueReadOnly("revision", REVISION);
230 v->setValueReadOnly("build-number", HUDSON_BUILD_NUMBER);
231 v->setValueReadOnly("build-id", HUDSON_BUILD_ID);
232 v->setValueReadOnly("hla-support", bool(FG_HAVE_HLA));
234 char* envp = ::getenv( "http_proxy" );
236 fgSetupProxy( envp );
239 ///////////////////////////////////////////////////////////////////////////////
240 // helper object to implement the --show-aircraft command.
241 // resides here so we can share the fgFindAircraftInDir template above,
242 // and hence ensure this command lists exectly the same aircraft as the normal
244 class ShowAircraft : public AircraftDirVistorBase
249 _minStatus = getNumMaturity(fgGetString("/sim/aircraft-min-status", "all"));
253 void show(const SGPath& path)
257 simgear::requestConsole(); // ensure console is shown on Windows
259 std::sort(_aircraft.begin(), _aircraft.end(), ciLessLibC());
260 cout << "Available aircraft:" << endl;
261 for ( unsigned int i = 0; i < _aircraft.size(); i++ ) {
262 cout << _aircraft[i] << endl;
267 virtual VisitResult visit(const SGPath& path)
271 readProperties(path.str(), &root);
272 } catch (sg_exception& ) {
273 return VISIT_CONTINUE;
278 descStr += path.file();
279 // trim common suffix from file names
280 int nPos = descStr.rfind("-set.xml");
281 if (nPos == (int)(descStr.size() - 8)) {
282 descStr.resize(nPos);
285 SGPropertyNode *node = root.getNode("sim");
287 SGPropertyNode* desc = node->getNode("description");
288 // if a status tag is found, read it in
289 if (node->hasValue("status")) {
290 maturity = getNumMaturity(node->getStringValue("status"));
294 if (descStr.size() <= 27+3) {
295 descStr.append(29+3-descStr.size(), ' ');
298 descStr.append( 32, ' ');
300 descStr += desc->getStringValue();
302 } // of have 'sim' node
304 if (maturity >= _minStatus) {
305 _aircraft.push_back(descStr);
308 return VISIT_CONTINUE;
312 int getNumMaturity(const char * str)
314 // changes should also be reflected in $FG_ROOT/data/options.xml &
315 // $FG_ROOT/data/Translations/string-default.xml
316 const char* levels[] = {"alpha","beta","early-production","production"};
318 if (!strcmp(str, "all")) {
322 for (size_t i=0; i<(sizeof(levels)/sizeof(levels[0]));i++)
323 if (strcmp(str,levels[i])==0)
329 // recommended in Meyers, Effective STL when internationalization and embedded
330 // NULLs aren't an issue. Much faster than the STL or Boost lex versions.
331 struct ciLessLibC : public std::binary_function<string, string, bool>
333 bool operator()(const std::string &lhs, const std::string &rhs) const
335 return strcasecmp(lhs.c_str(), rhs.c_str()) < 0 ? 1 : 0;
340 string_list _aircraft;
344 * Search in the current directory, and in on directory deeper
345 * for <aircraft>-set.xml configuration files and show the aircaft name
346 * and the contents of the<description> tag in a sorted manner.
348 * @parampath the directory to search for configuration files
350 void fgShowAircraft(const SGPath &path)
356 cout << "Hit a key to continue..." << endl;
363 parse_wind (const string &wind, double * min_hdg, double * max_hdg,
364 double * speed, double * gust)
366 string::size_type pos = wind.find('@');
367 if (pos == string::npos)
369 string dir = wind.substr(0, pos);
370 string spd = wind.substr(pos+1);
372 if (pos == string::npos) {
373 *min_hdg = *max_hdg = atof(dir.c_str());
375 *min_hdg = atof(dir.substr(0,pos).c_str());
376 *max_hdg = atof(dir.substr(pos+1).c_str());
379 if (pos == string::npos) {
380 *speed = *gust = atof(spd.c_str());
382 *speed = atof(spd.substr(0,pos).c_str());
383 *gust = atof(spd.substr(pos+1).c_str());
389 parseIntValue(char** ppParserPos, int* pValue,int min, int max, const char* field, const char* argument)
391 if ( !strlen(*ppParserPos) )
397 while ( isdigit((*ppParserPos)[0]) && (i<255) )
399 num[i] = (*ppParserPos)[0];
405 switch ((*ppParserPos)[0])
413 SG_LOG(SG_GENERAL, SG_ALERT, "Illegal character in time string for " << field << ": '" <<
414 (*ppParserPos)[0] << "'.");
415 // invalid field - skip rest of string to avoid further errors
416 while ((*ppParserPos)[0])
424 int value = atoi(num);
425 if ((value < min)||(value > max))
427 SG_LOG(SG_GENERAL, SG_ALERT, "Invalid " << field << " in '" << argument <<
428 "'. Valid range is " << min << "-" << max << ".");
438 // parse a time string ([+/-]%f[:%f[:%f]]) into hours
440 parse_time(const string& time_in) {
441 char *time_str, num[256];
442 double hours, minutes, seconds;
447 time_str = (char *)time_in.c_str();
449 // printf("parse_time(): %s\n", time_str);
452 if ( strlen(time_str) ) {
453 if ( time_str[0] == '+' ) {
456 } else if ( time_str[0] == '-' ) {
461 // printf("sign = %d\n", sign);
464 if ( strlen(time_str) ) {
466 while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
467 num[i] = time_str[0];
471 if ( time_str[0] == ':' ) {
476 // printf("hours = %.2lf\n", hours);
482 if ( strlen(time_str) ) {
484 while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
485 num[i] = time_str[0];
489 if ( time_str[0] == ':' ) {
494 // printf("minutes = %.2lf\n", minutes);
496 result += minutes / 60.0;
500 if ( strlen(time_str) ) {
502 while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
503 num[i] = time_str[0];
509 // printf("seconds = %.2lf\n", seconds);
511 result += seconds / 3600.0;
514 SG_LOG( SG_GENERAL, SG_INFO, " parse_time() = " << sign * result );
516 return(sign * result);
519 // parse a date string (yyyy:mm:dd:hh:mm:ss) into a time_t (seconds)
521 parse_date( const string& date, const char* timeType)
523 struct tm gmt,*pCurrentTime;
524 int year,month,day,hour,minute,second;
525 char *argument, *date_str;
528 CurrentTime.update(SGGeod(),0,0);
530 // FIXME This should obtain system/aircraft/GMT time depending on timeType
531 pCurrentTime = CurrentTime.getGmt();
533 // initialize all fields with current time
534 year = pCurrentTime->tm_year + 1900;
535 month = pCurrentTime->tm_mon + 1;
536 day = pCurrentTime->tm_mday;
537 hour = pCurrentTime->tm_hour;
538 minute = pCurrentTime->tm_min;
539 second = pCurrentTime->tm_sec;
541 argument = (char *)date.c_str();
544 // start with parsing year
545 if (!strlen(date_str) ||
546 !parseIntValue(&date_str,&year,0,9999,"year",argument))
553 SG_LOG(SG_GENERAL, SG_ALERT, "Invalid year '" << year << "'. Use 1970 or later.");
557 parseIntValue(&date_str, &month, 1, 12, "month", argument);
558 parseIntValue(&date_str, &day, 1, 31, "day", argument);
559 parseIntValue(&date_str, &hour, 0, 23, "hour", argument);
560 parseIntValue(&date_str, &minute, 0, 59, "minute", argument);
561 parseIntValue(&date_str, &second, 0, 59, "second", argument);
567 gmt.tm_mon = month - 1;
568 gmt.tm_year = year -1900;
569 gmt.tm_isdst = 0; // ignore daylight savings time for the moment
571 time_t theTime = sgTimeGetGMT( gmt.tm_year, gmt.tm_mon, gmt.tm_mday,
572 gmt.tm_hour, gmt.tm_min, gmt.tm_sec );
574 SG_LOG(SG_GENERAL, SG_INFO, "Configuring startup time to " << ctime(&theTime));
580 // parse angle in the form of [+/-]ddd:mm:ss into degrees
582 parse_degree( const string& degree_str) {
583 double result = parse_time( degree_str );
585 // printf("Degree = %.4f\n", result);
591 // parse time offset string into seconds
593 parse_time_offset( const string& time_str) {
596 // printf("time offset = %s\n", time_str);
599 result = (int)rint(parse_time(time_str) * 3600.0);
601 result = (int)(parse_time(time_str) * 3600.0);
604 // printf("parse_time_offset(): %d\n", result);
610 // Parse --fov=x.xx type option
612 parse_fov( const string& arg ) {
613 double fov = atof(arg);
615 if ( fov < FG_FOV_MIN ) { fov = FG_FOV_MIN; }
616 if ( fov > FG_FOV_MAX ) { fov = FG_FOV_MAX; }
618 fgSetDouble("/sim/view[0]/config/default-field-of-view-deg", fov);
620 // printf("parse_fov(): result = %.4f\n", fov);
626 // Parse I/O channel option
628 // Format is "--protocol=medium,direction,hz,medium_options,..."
630 // protocol = { native, nmea, garmin, AV400, AV400Sim, fgfs, rul, pve, etc. }
631 // medium = { serial, socket, file, etc. }
632 // direction = { in, out, bi }
633 // hz = number of times to process channel per second (floating
634 // point values are ok.
636 // Serial example "--nmea=serial,dir,hz,device,baud" where
638 // device = OS device name of serial line to be open()'ed
639 // baud = {300, 1200, 2400, ..., 230400}
641 // Socket exacmple "--native=socket,dir,hz,machine,port,style" where
643 // machine = machine name or ip address if client (leave empty if server)
644 // port = port, leave empty to let system choose
645 // style = tcp or udp
647 // File example "--garmin=file,dir,hz,filename" where
649 // filename = file system file name
652 add_channel( const string& type, const string& channel_str ) {
653 // This check is neccessary to prevent fgviewer from segfaulting when given
654 // weird options. (It doesn't run the full initailization)
655 if(!globals->get_channel_options_list())
657 SG_LOG(SG_GENERAL, SG_ALERT, "Option " << type << "=" << channel_str
661 SG_LOG(SG_GENERAL, SG_INFO, "Channel string = " << channel_str );
662 globals->get_channel_options_list()->push_back( type + "," + channel_str );
669 fgSetString("/sim/presets/airport-id", "");
670 fgSetString("/sim/presets/vor-id", "");
671 fgSetString("/sim/presets/ndb-id", "");
672 fgSetString("/sim/presets/carrier", "");
673 fgSetString("/sim/presets/parkpos", "");
674 fgSetString("/sim/presets/fix", "");
678 fgOptVOR( const char * arg )
681 fgSetString("/sim/presets/vor-id", arg);
682 return FG_OPTIONS_OK;
686 fgOptNDB( const char * arg )
689 fgSetString("/sim/presets/ndb-id", arg);
690 return FG_OPTIONS_OK;
694 fgOptCarrier( const char * arg )
697 fgSetString("/sim/presets/carrier", arg);
698 return FG_OPTIONS_OK;
702 fgOptParkpos( const char * arg )
704 fgSetString("/sim/presets/parkpos", arg);
705 return FG_OPTIONS_OK;
709 fgOptFIX( const char * arg )
712 fgSetString("/sim/presets/fix", arg);
713 return FG_OPTIONS_OK;
717 fgOptLon( const char *arg )
720 fgSetDouble("/sim/presets/longitude-deg", parse_degree( arg ));
721 fgSetDouble("/position/longitude-deg", parse_degree( arg ));
722 return FG_OPTIONS_OK;
726 fgOptLat( const char *arg )
729 fgSetDouble("/sim/presets/latitude-deg", parse_degree( arg ));
730 fgSetDouble("/position/latitude-deg", parse_degree( arg ));
731 return FG_OPTIONS_OK;
735 fgOptAltitude( const char *arg )
737 fgSetBool("/sim/presets/onground", false);
738 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
739 fgSetDouble("/sim/presets/altitude-ft", atof( arg ));
741 fgSetDouble("/sim/presets/altitude-ft",
742 atof( arg ) * SG_METER_TO_FEET);
743 return FG_OPTIONS_OK;
747 fgOptUBody( const char *arg )
749 fgSetString("/sim/presets/speed-set", "UVW");
750 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
751 fgSetDouble("/sim/presets/uBody-fps", atof( arg ));
753 fgSetDouble("/sim/presets/uBody-fps",
754 atof( arg ) * SG_METER_TO_FEET);
755 return FG_OPTIONS_OK;
759 fgOptVBody( const char *arg )
761 fgSetString("/sim/presets/speed-set", "UVW");
762 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
763 fgSetDouble("/sim/presets/vBody-fps", atof( arg ));
765 fgSetDouble("/sim/presets/vBody-fps",
766 atof( arg ) * SG_METER_TO_FEET);
767 return FG_OPTIONS_OK;
771 fgOptWBody( const char *arg )
773 fgSetString("/sim/presets/speed-set", "UVW");
774 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
775 fgSetDouble("/sim/presets/wBody-fps", atof(arg));
777 fgSetDouble("/sim/presets/wBody-fps",
778 atof(arg) * SG_METER_TO_FEET);
779 return FG_OPTIONS_OK;
783 fgOptVNorth( const char *arg )
785 fgSetString("/sim/presets/speed-set", "NED");
786 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
787 fgSetDouble("/sim/presets/speed-north-fps", atof( arg ));
789 fgSetDouble("/sim/presets/speed-north-fps",
790 atof( arg ) * SG_METER_TO_FEET);
791 return FG_OPTIONS_OK;
795 fgOptVEast( const char *arg )
797 fgSetString("/sim/presets/speed-set", "NED");
798 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
799 fgSetDouble("/sim/presets/speed-east-fps", atof(arg));
801 fgSetDouble("/sim/presets/speed-east-fps",
802 atof(arg) * SG_METER_TO_FEET);
803 return FG_OPTIONS_OK;
807 fgOptVDown( const char *arg )
809 fgSetString("/sim/presets/speed-set", "NED");
810 if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
811 fgSetDouble("/sim/presets/speed-down-fps", atof(arg));
813 fgSetDouble("/sim/presets/speed-down-fps",
814 atof(arg) * SG_METER_TO_FEET);
815 return FG_OPTIONS_OK;
819 fgOptVc( const char *arg )
821 // fgSetString("/sim/presets/speed-set", "knots");
822 // fgSetDouble("/velocities/airspeed-kt", atof(arg.substr(5)));
823 fgSetString("/sim/presets/speed-set", "knots");
824 fgSetDouble("/sim/presets/airspeed-kt", atof(arg));
825 return FG_OPTIONS_OK;
829 fgOptMach( const char *arg )
831 fgSetString("/sim/presets/speed-set", "mach");
832 fgSetDouble("/sim/presets/mach", atof(arg));
833 return FG_OPTIONS_OK;
837 fgOptRoc( const char *arg )
839 fgSetDouble("/sim/presets/vertical-speed-fps", atof(arg)/60);
840 return FG_OPTIONS_OK;
844 fgOptFgScenery( const char *arg )
846 globals->append_fg_scenery(arg);
847 return FG_OPTIONS_OK;
851 fgOptFov( const char *arg )
854 return FG_OPTIONS_OK;
858 fgOptGeometry( const char *arg )
860 bool geometry_ok = true;
861 int xsize = 0, ysize = 0;
862 string geometry = arg;
863 string::size_type i = geometry.find('x');
865 if (i != string::npos) {
866 xsize = atoi(geometry.substr(0, i));
867 ysize = atoi(geometry.substr(i+1));
872 if ( xsize <= 0 || ysize <= 0 ) {
878 if ( !geometry_ok ) {
879 SG_LOG( SG_GENERAL, SG_ALERT, "Unknown geometry: " << geometry );
880 SG_LOG( SG_GENERAL, SG_ALERT,
881 "Setting geometry to " << xsize << 'x' << ysize << '\n');
883 SG_LOG( SG_GENERAL, SG_INFO,
884 "Setting geometry to " << xsize << 'x' << ysize << '\n');
885 fgSetInt("/sim/startup/xsize", xsize);
886 fgSetInt("/sim/startup/ysize", ysize);
888 return FG_OPTIONS_OK;
892 fgOptBpp( const char *arg )
894 string bits_per_pix = arg;
895 if ( bits_per_pix == "16" ) {
896 fgSetInt("/sim/rendering/bits-per-pixel", 16);
897 } else if ( bits_per_pix == "24" ) {
898 fgSetInt("/sim/rendering/bits-per-pixel", 24);
899 } else if ( bits_per_pix == "32" ) {
900 fgSetInt("/sim/rendering/bits-per-pixel", 32);
902 SG_LOG(SG_GENERAL, SG_ALERT, "Unsupported bpp " << bits_per_pix);
904 return FG_OPTIONS_OK;
908 fgOptTimeOffset( const char *arg )
910 fgSetLong("/sim/startup/time-offset",
911 parse_time_offset( arg ));
912 fgSetString("/sim/startup/time-offset-type", "system-offset");
913 return FG_OPTIONS_OK;
917 fgOptStartDateSys( const char *arg )
919 long int theTime = parse_date( arg, "system" );
922 fgSetLong("/sim/startup/time-offset", theTime);
923 fgSetString("/sim/startup/time-offset-type", "system");
925 return FG_OPTIONS_OK;
929 fgOptStartDateLat( const char *arg )
931 long int theTime = parse_date( arg, "latitude" );
934 fgSetLong("/sim/startup/time-offset", theTime);
935 fgSetString("/sim/startup/time-offset-type", "latitude");
937 return FG_OPTIONS_OK;
941 fgOptStartDateGmt( const char *arg )
943 long int theTime = parse_date( arg, "gmt" );
946 fgSetLong("/sim/startup/time-offset", theTime);
947 fgSetString("/sim/startup/time-offset-type", "gmt");
949 return FG_OPTIONS_OK;
953 fgSetupProxy( const char *arg )
955 string options = simgear::strutils::strip( arg );
956 string host, port, auth;
957 string::size_type pos;
959 // this is NURLP - NURLP is not an url parser
960 if( simgear::strutils::starts_with( options, "http://" ) )
961 options = options.substr( 7 );
962 if( simgear::strutils::ends_with( options, "/" ) )
963 options = options.substr( 0, options.length() - 1 );
965 host = port = auth = "";
966 if ((pos = options.find("@")) != string::npos)
967 auth = options.substr(0, pos++);
971 host = options.substr(pos, options.size());
972 if ((pos = host.find(":")) != string::npos) {
973 port = host.substr(++pos, host.size());
974 host.erase(--pos, host.size());
977 fgSetString("/sim/presets/proxy/host", host.c_str());
978 fgSetString("/sim/presets/proxy/port", port.c_str());
979 fgSetString("/sim/presets/proxy/authentication", auth.c_str());
981 return FG_OPTIONS_OK;
985 fgOptTraceRead( const char *arg )
988 SG_LOG(SG_GENERAL, SG_INFO, "Tracing reads for property " << name);
989 fgGetNode(name.c_str(), true)
990 ->setAttribute(SGPropertyNode::TRACE_READ, true);
991 return FG_OPTIONS_OK;
995 fgOptLogLevel( const char *arg )
997 fgSetString("/sim/logging/priority", arg);
998 setLoggingPriority(arg);
1000 return FG_OPTIONS_OK;
1004 fgOptLogClasses( const char *arg )
1006 fgSetString("/sim/logging/classes", arg);
1007 setLoggingClasses (arg);
1009 return FG_OPTIONS_OK;
1013 fgOptTraceWrite( const char *arg )
1016 SG_LOG(SG_GENERAL, SG_INFO, "Tracing writes for property " << name);
1017 fgGetNode(name.c_str(), true)
1018 ->setAttribute(SGPropertyNode::TRACE_WRITE, true);
1019 return FG_OPTIONS_OK;
1023 fgOptViewOffset( const char *arg )
1025 // $$$ begin - added VS Renganathan, 14 Oct 2K
1026 // for multi-window outside window imagery
1027 string woffset = arg;
1028 double default_view_offset = 0.0;
1029 if ( woffset == "LEFT" ) {
1030 default_view_offset = SGD_PI * 0.25;
1031 } else if ( woffset == "RIGHT" ) {
1032 default_view_offset = SGD_PI * 1.75;
1033 } else if ( woffset == "CENTER" ) {
1034 default_view_offset = 0.00;
1036 default_view_offset = atof( woffset.c_str() ) * SGD_DEGREES_TO_RADIANS;
1038 /* apparently not used (CLO, 11 Jun 2002)
1039 FGViewer *pilot_view =
1040 (FGViewer *)globals->get_viewmgr()->get_view( 0 ); */
1041 // this will work without calls to the viewer...
1042 fgSetDouble( "/sim/current-view/heading-offset-deg",
1043 default_view_offset * SGD_RADIANS_TO_DEGREES );
1044 // $$$ end - added VS Renganathan, 14 Oct 2K
1045 return FG_OPTIONS_OK;
1049 fgOptVisibilityMeters( const char *arg )
1051 Environment::Presets::VisibilitySingleton::instance()->preset( atof( arg ) );
1052 return FG_OPTIONS_OK;
1056 fgOptVisibilityMiles( const char *arg )
1058 Environment::Presets::VisibilitySingleton::instance()->preset( atof( arg ) * 5280.0 * SG_FEET_TO_METER );
1059 return FG_OPTIONS_OK;
1063 fgOptRandomWind( const char *arg )
1065 double min_hdg = sg_random() * 360.0;
1066 double max_hdg = min_hdg + (20 - sqrt(sg_random() * 400));
1067 double speed = sg_random() * sg_random() * 40;
1068 double gust = speed + (10 - sqrt(sg_random() * 100));
1069 Environment::Presets::WindSingleton::instance()->preset(min_hdg, max_hdg, speed, gust);
1070 return FG_OPTIONS_OK;
1074 fgOptWind( const char *arg )
1076 double min_hdg = 0.0, max_hdg = 0.0, speed = 0.0, gust = 0.0;
1077 if (!parse_wind( arg, &min_hdg, &max_hdg, &speed, &gust)) {
1078 SG_LOG( SG_GENERAL, SG_ALERT, "bad wind value " << arg );
1079 return FG_OPTIONS_ERROR;
1081 Environment::Presets::WindSingleton::instance()->preset(min_hdg, max_hdg, speed, gust);
1082 return FG_OPTIONS_OK;
1086 fgOptTurbulence( const char *arg )
1088 Environment::Presets::TurbulenceSingleton::instance()->preset( atof(arg) );
1089 return FG_OPTIONS_OK;
1093 fgOptCeiling( const char *arg )
1095 double elevation, thickness;
1097 string::size_type pos = spec.find(':');
1098 if (pos == string::npos) {
1099 elevation = atof(spec.c_str());
1102 elevation = atof(spec.substr(0, pos).c_str());
1103 thickness = atof(spec.substr(pos + 1).c_str());
1105 Environment::Presets::CeilingSingleton::instance()->preset( elevation, thickness );
1106 return FG_OPTIONS_OK;
1110 fgOptWp( const char *arg )
1112 string_list *waypoints = globals->get_initial_waypoints();
1114 waypoints = new string_list;
1115 globals->set_initial_waypoints(waypoints);
1117 waypoints->push_back(arg);
1118 return FG_OPTIONS_OK;
1122 fgOptConfig( const char *arg )
1126 readProperties(file, globals->get_props());
1127 } catch (const sg_exception &e) {
1128 string message = "Error loading config file: ";
1129 message += e.getFormattedMessage() + e.getOrigin();
1130 SG_LOG(SG_INPUT, SG_ALERT, message);
1131 return FG_OPTIONS_ERROR;
1133 return FG_OPTIONS_OK;
1137 parse_colon (const string &s, double * val1, double * val2)
1139 string::size_type pos = s.find(':');
1140 if (pos == string::npos) {
1144 *val1 = atof(s.substr(0, pos).c_str());
1145 *val2 = atof(s.substr(pos+1).c_str());
1152 fgOptFailure( const char * arg )
1156 fgSetBool("/systems/pitot/serviceable", false);
1157 } else if (a == "static") {
1158 fgSetBool("/systems/static/serviceable", false);
1159 } else if (a == "vacuum") {
1160 fgSetBool("/systems/vacuum/serviceable", false);
1161 } else if (a == "electrical") {
1162 fgSetBool("/systems/electrical/serviceable", false);
1164 SG_LOG(SG_INPUT, SG_ALERT, "Unknown failure mode: " << a);
1165 return FG_OPTIONS_ERROR;
1168 return FG_OPTIONS_OK;
1173 fgOptNAV1( const char * arg )
1175 double radial, freq;
1176 if (parse_colon(arg, &radial, &freq))
1177 fgSetDouble("/instrumentation/nav[0]/radials/selected-deg", radial);
1178 fgSetDouble("/instrumentation/nav[0]/frequencies/selected-mhz", freq);
1179 return FG_OPTIONS_OK;
1183 fgOptNAV2( const char * arg )
1185 double radial, freq;
1186 if (parse_colon(arg, &radial, &freq))
1187 fgSetDouble("/instrumentation/nav[1]/radials/selected-deg", radial);
1188 fgSetDouble("/instrumentation/nav[1]/frequencies/selected-mhz", freq);
1189 return FG_OPTIONS_OK;
1193 fgOptADF1( const char * arg )
1196 if (parse_colon(arg, &rot, &freq))
1197 fgSetDouble("/instrumentation/adf[0]/rotation-deg", rot);
1198 fgSetDouble("/instrumentation/adf[0]/frequencies/selected-khz", freq);
1199 return FG_OPTIONS_OK;
1203 fgOptADF2( const char * arg )
1206 if (parse_colon(arg, &rot, &freq))
1207 fgSetDouble("/instrumentation/adf[1]/rotation-deg", rot);
1208 fgSetDouble("/instrumentation/adf[1]/frequencies/selected-khz", freq);
1209 return FG_OPTIONS_OK;
1213 fgOptDME( const char *arg )
1216 if (opt == "nav1") {
1217 fgSetInt("/instrumentation/dme/switch-position", 1);
1218 fgSetString("/instrumentation/dme/frequencies/source",
1219 "/instrumentation/nav[0]/frequencies/selected-mhz");
1220 } else if (opt == "nav2") {
1221 fgSetInt("/instrumentation/dme/switch-position", 3);
1222 fgSetString("/instrumentation/dme/frequencies/source",
1223 "/instrumentation/nav[1]/frequencies/selected-mhz");
1225 double frequency = atof(arg);
1228 SG_LOG(SG_INPUT, SG_ALERT, "Invalid DME frequency: '" << arg << "'.");
1229 return FG_OPTIONS_ERROR;
1231 fgSetInt("/instrumentation/dme/switch-position", 2);
1232 fgSetString("/instrumentation/dme/frequencies/source",
1233 "/instrumentation/dme/frequencies/selected-mhz");
1234 fgSetDouble("/instrumentation/dme/frequencies/selected-mhz", frequency);
1236 return FG_OPTIONS_OK;
1240 fgOptLivery( const char *arg )
1243 string livery_path = "livery/" + opt;
1244 fgSetString("/sim/model/texture-path", livery_path.c_str() );
1245 return FG_OPTIONS_OK;
1249 fgOptScenario( const char *arg )
1251 SGPropertyNode_ptr ai_node = fgGetNode( "/sim/ai", true );
1252 vector<SGPropertyNode_ptr> scenarii = ai_node->getChildren( "scenario" );
1254 for ( size_t i = 0; i < scenarii.size(); ++i ) {
1255 int ind = scenarii[i]->getIndex();
1256 if ( index < ind ) {
1260 SGPropertyNode_ptr scenario = ai_node->getNode( "scenario", index + 1, true );
1261 scenario->setStringValue( arg );
1262 return FG_OPTIONS_OK;
1266 fgOptRunway( const char *arg )
1268 fgSetString("/sim/presets/runway", arg );
1269 fgSetBool("/sim/presets/runway-requested", true );
1270 return FG_OPTIONS_OK;
1274 fgOptParking( const char *arg )
1276 cerr << "Processing argument " << arg << endl;
1277 fgSetString("/sim/presets/parking", arg );
1278 fgSetBool ("/sim/presets/parking-requested", true );
1279 return FG_OPTIONS_OK;
1283 fgOptVersion( const char *arg )
1285 cerr << "FlightGear version: " << FLIGHTGEAR_VERSION << endl;
1286 cerr << "Revision: " << REVISION << endl;
1287 cerr << "Build-Id: " << HUDSON_BUILD_ID << endl;
1288 cerr << "FG_ROOT=" << globals->get_fg_root() << endl;
1289 cerr << "FG_HOME=" << globals->get_fg_home() << endl;
1290 cerr << "FG_SCENERY=";
1293 string_list scn = globals->get_fg_scenery();
1294 for (string_list::const_iterator it = scn.begin(); it != scn.end(); it++)
1296 if (didsome) cerr << ":";
1301 cerr << "SimGear version: " << SG_STRINGIZE(SIMGEAR_VERSION) << endl;
1302 cerr << "PLIB version: " << PLIB_VERSION << endl;
1303 return FG_OPTIONS_EXIT;
1307 fgOptCallSign(const char * arg)
1311 strncpy(callsign,arg,10);
1313 for (i=0;callsign[i];i++)
1315 char c = callsign[i];
1316 if (c >= 'A' && c <= 'Z') continue;
1317 if (c >= 'a' && c <= 'z') continue;
1318 if (c >= '0' && c <= '9') continue;
1319 if (c == '-' || c == '_') continue;
1320 // convert any other illegal characters
1323 fgSetString("sim/multiplay/callsign", callsign );
1324 return FG_OPTIONS_OK;
1328 fgOptIgnoreAutosave(const char* arg)
1330 fgSetBool("/sim/startup/ignore-autosave", true);
1331 // don't overwrite autosave on exit
1332 fgSetBool("/sim/startup/save-on-exit", false);
1333 return FG_OPTIONS_OK;
1336 // Set a property for the --prop: option. Syntax: --prop:[<type>:]<name>=<value>
1337 // <type> can be "double" etc. but also only the first letter "d".
1338 // Examples: --prop:alpha=1 --prop:bool:beta=true --prop:d:gamma=0.123
1340 fgOptSetProperty(const char* raw)
1343 string::size_type pos = arg.find('=');
1344 if (pos == arg.npos || pos == 0 || pos + 1 == arg.size())
1345 return FG_OPTIONS_ERROR;
1347 string name = arg.substr(0, pos);
1348 string value = arg.substr(pos + 1);
1350 pos = name.find(':');
1352 if (pos != name.npos && pos != 0 && pos + 1 != name.size()) {
1353 type = name.substr(0, pos);
1354 name = name.substr(pos + 1);
1356 SGPropertyNode *n = fgGetNode(name.c_str(), true);
1358 bool writable = n->getAttribute(SGPropertyNode::WRITE);
1360 n->setAttribute(SGPropertyNode::WRITE, true);
1364 ret = n->setUnspecifiedValue(value.c_str());
1365 else if (type == "s" || type == "string")
1366 ret = n->setStringValue(value.c_str());
1367 else if (type == "d" || type == "double")
1368 ret = n->setDoubleValue(strtod(value.c_str(), 0));
1369 else if (type == "f" || type == "float")
1370 ret = n->setFloatValue(atof(value.c_str()));
1371 else if (type == "l" || type == "long")
1372 ret = n->setLongValue(strtol(value.c_str(), 0, 0));
1373 else if (type == "i" || type == "int")
1374 ret = n->setIntValue(atoi(value.c_str()));
1375 else if (type == "b" || type == "bool")
1376 ret = n->setBoolValue(value == "true" || atoi(value.c_str()) != 0);
1379 n->setAttribute(SGPropertyNode::WRITE, false);
1380 return ret ? FG_OPTIONS_OK : FG_OPTIONS_ERROR;
1386 option has_param type property b_param s_param func
1389 option : name of the option
1390 has_param : option is --name=value if true or --name if false
1391 type : OPTION_BOOL - property is a boolean
1392 OPTION_STRING - property is a string
1393 OPTION_DOUBLE - property is a double
1394 OPTION_INT - property is an integer
1395 OPTION_CHANNEL - name of option is the name of a channel
1396 OPTION_FUNC - the option trigger a function
1397 b_param : if type==OPTION_BOOL,
1398 value set to the property (has_param is false for boolean)
1399 s_param : if type==OPTION_STRING,
1400 value set to the property if has_param is false
1401 func : function called if type==OPTION_FUNC. if has_param is true,
1402 the value is passed to the function as a string, otherwise,
1405 For OPTION_DOUBLE and OPTION_INT, the parameter value is converted into a
1406 double or an integer and set to the property.
1408 For OPTION_CHANNEL, add_channel is called with the parameter value as the
1412 enum OptionType { OPTION_BOOL = 0, OPTION_STRING, OPTION_DOUBLE, OPTION_INT, OPTION_CHANNEL, OPTION_FUNC, OPTION_IGNORE };
1413 const int OPTION_MULTI = 1 << 17;
1419 const char *property;
1421 const char *s_param;
1422 int (*func)( const char * );
1423 } fgOptionArray[] = {
1425 {"language", true, OPTION_IGNORE, "", false, "", 0 },
1426 {"console", false, OPTION_IGNORE, "", false, "", 0 },
1427 {"disable-rembrandt", false, OPTION_BOOL, "/sim/rendering/rembrandt/enabled", false, "", 0 },
1428 {"enable-rembrandt", false, OPTION_BOOL, "/sim/rendering/rembrandt/enabled", true, "", 0 },
1429 {"renderer", true, OPTION_STRING, "/sim/rendering/rembrandt/renderer", false, "", 0 },
1430 {"disable-splash-screen", false, OPTION_BOOL, "/sim/startup/splash-screen", false, "", 0 },
1431 {"enable-splash-screen", false, OPTION_BOOL, "/sim/startup/splash-screen", true, "", 0 },
1432 {"disable-mouse-pointer", false, OPTION_STRING, "/sim/startup/mouse-pointer", false, "disabled", 0 },
1433 {"enable-mouse-pointer", false, OPTION_STRING, "/sim/startup/mouse-pointer", false, "enabled", 0 },
1434 {"disable-random-objects", false, OPTION_BOOL, "/sim/rendering/random-objects", false, "", 0 },
1435 {"enable-random-objects", false, OPTION_BOOL, "/sim/rendering/random-objects", true, "", 0 },
1436 {"disable-random-vegetation", false, OPTION_BOOL, "/sim/rendering/random-vegetation", false, "", 0 },
1437 {"enable-random-vegetation", false, OPTION_BOOL, "/sim/rendering/random-vegetation", true, "", 0 },
1438 {"disable-random-buildings", false, OPTION_BOOL, "/sim/rendering/random-buildings", false, "", 0 },
1439 {"enable-random-buildings", false, OPTION_BOOL, "/sim/rendering/random-buildings", true, "", 0 },
1440 {"disable-real-weather-fetch", false, OPTION_BOOL, "/environment/realwx/enabled", false, "", 0 },
1441 {"enable-real-weather-fetch", false, OPTION_BOOL, "/environment/realwx/enabled", true, "", 0 },
1442 {"metar", true, OPTION_STRING, "/environment/metar/data", false, "", 0 },
1443 {"disable-ai-models", false, OPTION_BOOL, "/sim/ai/enabled", false, "", 0 },
1444 {"enable-ai-models", false, OPTION_BOOL, "/sim/ai/enabled", true, "", 0 },
1445 {"disable-ai-traffic", false, OPTION_BOOL, "/sim/traffic-manager/enabled", false, "", 0 },
1446 {"enable-ai-traffic", false, OPTION_BOOL, "/sim/traffic-manager/enabled", true, "", 0 },
1447 {"disable-freeze", false, OPTION_BOOL, "/sim/freeze/master", false, "", 0 },
1448 {"enable-freeze", false, OPTION_BOOL, "/sim/freeze/master", true, "", 0 },
1449 {"disable-fuel-freeze", false, OPTION_BOOL, "/sim/freeze/fuel", false, "", 0 },
1450 {"enable-fuel-freeze", false, OPTION_BOOL, "/sim/freeze/fuel", true, "", 0 },
1451 {"disable-clock-freeze", false, OPTION_BOOL, "/sim/freeze/clock", false, "", 0 },
1452 {"enable-clock-freeze", false, OPTION_BOOL, "/sim/freeze/clock", true, "", 0 },
1453 {"disable-hud-3d", false, OPTION_BOOL, "/sim/hud/enable3d[1]", false, "", 0 },
1454 {"enable-hud-3d", false, OPTION_BOOL, "/sim/hud/enable3d[1]", true, "", 0 },
1455 {"disable-anti-alias-hud", false, OPTION_BOOL, "/sim/hud/color/antialiased", false, "", 0 },
1456 {"enable-anti-alias-hud", false, OPTION_BOOL, "/sim/hud/color/antialiased", true, "", 0 },
1457 {"control", true, OPTION_STRING, "/sim/control-mode", false, "", 0 },
1458 {"disable-auto-coordination", false, OPTION_BOOL, "/controls/flight/auto-coordination", false, "", 0 },
1459 {"enable-auto-coordination", false, OPTION_BOOL, "/controls/flight/auto-coordination", true, "", 0 },
1460 {"browser-app", true, OPTION_STRING, "/sim/startup/browser-app", false, "", 0 },
1461 {"disable-hud", false, OPTION_BOOL, "/sim/hud/visibility[1]", false, "", 0 },
1462 {"enable-hud", false, OPTION_BOOL, "/sim/hud/visibility[1]", true, "", 0 },
1463 {"disable-panel", false, OPTION_BOOL, "/sim/panel/visibility", false, "", 0 },
1464 {"enable-panel", false, OPTION_BOOL, "/sim/panel/visibility", true, "", 0 },
1465 {"disable-sound", false, OPTION_BOOL, "/sim/sound/working", false, "", 0 },
1466 {"enable-sound", false, OPTION_BOOL, "/sim/sound/working", true, "", 0 },
1467 {"sound-device", true, OPTION_STRING, "/sim/sound/device-name", false, "", 0 },
1468 {"airport", true, OPTION_STRING, "/sim/presets/airport-id", false, "", 0 },
1469 {"runway", true, OPTION_FUNC, "", false, "", fgOptRunway },
1470 {"vor", true, OPTION_FUNC, "", false, "", fgOptVOR },
1471 {"vor-frequency", true, OPTION_DOUBLE, "/sim/presets/vor-freq", false, "", fgOptVOR },
1472 {"ndb", true, OPTION_FUNC, "", false, "", fgOptNDB },
1473 {"ndb-frequency", true, OPTION_DOUBLE, "/sim/presets/ndb-freq", false, "", fgOptVOR },
1474 {"carrier", true, OPTION_FUNC, "", false, "", fgOptCarrier },
1475 {"parkpos", true, OPTION_FUNC, "", false, "", fgOptParkpos },
1476 {"fix", true, OPTION_FUNC, "", false, "", fgOptFIX },
1477 {"offset-distance", true, OPTION_DOUBLE, "/sim/presets/offset-distance-nm", false, "", 0 },
1478 {"offset-azimuth", true, OPTION_DOUBLE, "/sim/presets/offset-azimuth-deg", false, "", 0 },
1479 {"lon", true, OPTION_FUNC, "", false, "", fgOptLon },
1480 {"lat", true, OPTION_FUNC, "", false, "", fgOptLat },
1481 {"altitude", true, OPTION_FUNC, "", false, "", fgOptAltitude },
1482 {"uBody", true, OPTION_FUNC, "", false, "", fgOptUBody },
1483 {"vBody", true, OPTION_FUNC, "", false, "", fgOptVBody },
1484 {"wBody", true, OPTION_FUNC, "", false, "", fgOptWBody },
1485 {"vNorth", true, OPTION_FUNC, "", false, "", fgOptVNorth },
1486 {"vEast", true, OPTION_FUNC, "", false, "", fgOptVEast },
1487 {"vDown", true, OPTION_FUNC, "", false, "", fgOptVDown },
1488 {"vc", true, OPTION_FUNC, "", false, "", fgOptVc },
1489 {"mach", true, OPTION_FUNC, "", false, "", fgOptMach },
1490 {"heading", true, OPTION_DOUBLE, "/sim/presets/heading-deg", false, "", 0 },
1491 {"roll", true, OPTION_DOUBLE, "/sim/presets/roll-deg", false, "", 0 },
1492 {"pitch", true, OPTION_DOUBLE, "/sim/presets/pitch-deg", false, "", 0 },
1493 {"glideslope", true, OPTION_DOUBLE, "/sim/presets/glideslope-deg", false, "", 0 },
1494 {"roc", true, OPTION_FUNC, "", false, "", fgOptRoc },
1495 {"fg-root", true, OPTION_IGNORE, "", false, "", 0 },
1496 {"fg-scenery", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptFgScenery },
1497 {"fg-aircraft", true, OPTION_IGNORE | OPTION_MULTI, "", false, "", 0 },
1498 {"fdm", true, OPTION_STRING, "/sim/flight-model", false, "", 0 },
1499 {"aero", true, OPTION_STRING, "/sim/aero", false, "", 0 },
1500 {"aircraft-dir", true, OPTION_IGNORE, "", false, "", 0 },
1501 {"model-hz", true, OPTION_INT, "/sim/model-hz", false, "", 0 },
1502 {"max-fps", true, OPTION_DOUBLE, "/sim/frame-rate-throttle-hz", false, "", 0 },
1503 {"speed", true, OPTION_DOUBLE, "/sim/speed-up", false, "", 0 },
1504 {"trim", false, OPTION_BOOL, "/sim/presets/trim", true, "", 0 },
1505 {"notrim", false, OPTION_BOOL, "/sim/presets/trim", false, "", 0 },
1506 {"on-ground", false, OPTION_BOOL, "/sim/presets/onground", true, "", 0 },
1507 {"in-air", false, OPTION_BOOL, "/sim/presets/onground", false, "", 0 },
1508 {"fog-disable", false, OPTION_STRING, "/sim/rendering/fog", false, "disabled", 0 },
1509 {"fog-fastest", false, OPTION_STRING, "/sim/rendering/fog", false, "fastest", 0 },
1510 {"fog-nicest", false, OPTION_STRING, "/sim/rendering/fog", false, "nicest", 0 },
1511 {"disable-horizon-effect", false, OPTION_BOOL, "/sim/rendering/horizon-effect", false, "", 0 },
1512 {"enable-horizon-effect", false, OPTION_BOOL, "/sim/rendering/horizon-effect", true, "", 0 },
1513 {"disable-enhanced-lighting", false, OPTION_BOOL, "/sim/rendering/enhanced-lighting", false, "", 0 },
1514 {"enable-enhanced-lighting", false, OPTION_BOOL, "/sim/rendering/enhanced-lighting", true, "", 0 },
1515 {"disable-distance-attenuation", false, OPTION_BOOL, "/sim/rendering/distance-attenuation", false, "", 0 },
1516 {"enable-distance-attenuation", false, OPTION_BOOL, "/sim/rendering/distance-attenuation", true, "", 0 },
1517 {"disable-specular-highlight", false, OPTION_BOOL, "/sim/rendering/specular-highlight", false, "", 0 },
1518 {"enable-specular-highlight", false, OPTION_BOOL, "/sim/rendering/specular-highlight", true, "", 0 },
1519 {"disable-clouds", false, OPTION_BOOL, "/environment/clouds/status", false, "", 0 },
1520 {"enable-clouds", false, OPTION_BOOL, "/environment/clouds/status", true, "", 0 },
1521 {"disable-clouds3d", false, OPTION_BOOL, "/sim/rendering/clouds3d-enable", false, "", 0 },
1522 {"enable-clouds3d", false, OPTION_BOOL, "/sim/rendering/clouds3d-enable", true, "", 0 },
1523 {"fov", true, OPTION_FUNC, "", false, "", fgOptFov },
1524 {"aspect-ratio-multiplier", true, OPTION_DOUBLE, "/sim/current-view/aspect-ratio-multiplier", false, "", 0 },
1525 {"disable-fullscreen", false, OPTION_BOOL, "/sim/startup/fullscreen", false, "", 0 },
1526 {"enable-fullscreen", false, OPTION_BOOL, "/sim/startup/fullscreen", true, "", 0 },
1527 {"disable-save-on-exit", false, OPTION_BOOL, "/sim/startup/save-on-exit", false, "", 0 },
1528 {"enable-save-on-exit", false, OPTION_BOOL, "/sim/startup/save-on-exit", true, "", 0 },
1529 {"read-only", false, OPTION_BOOL, "/sim/fghome-readonly", true, "", 0 },
1530 {"ignore-autosave", false, OPTION_FUNC, "", false, "", fgOptIgnoreAutosave },
1531 {"restore-defaults", false, OPTION_BOOL, "/sim/startup/restore-defaults", true, "", 0 },
1532 {"shading-flat", false, OPTION_BOOL, "/sim/rendering/shading", false, "", 0 },
1533 {"shading-smooth", false, OPTION_BOOL, "/sim/rendering/shading", true, "", 0 },
1534 {"texture-filtering", false, OPTION_INT, "/sim/rendering/filtering", 1, "", 0 },
1535 {"disable-wireframe", false, OPTION_BOOL, "/sim/rendering/wireframe", false, "", 0 },
1536 {"enable-wireframe", false, OPTION_BOOL, "/sim/rendering/wireframe", true, "", 0 },
1537 {"materials-file", true, OPTION_STRING, "/sim/rendering/materials-file", false, "", 0 },
1538 {"disable-terrasync", false, OPTION_BOOL, "/sim/terrasync/enabled", false, "", 0 },
1539 {"enable-terrasync", false, OPTION_BOOL, "/sim/terrasync/enabled", true, "", 0 },
1540 {"terrasync-dir", true, OPTION_STRING, "/sim/terrasync/scenery-dir", false, "", 0 },
1541 {"geometry", true, OPTION_FUNC, "", false, "", fgOptGeometry },
1542 {"bpp", true, OPTION_FUNC, "", false, "", fgOptBpp },
1543 {"units-feet", false, OPTION_STRING, "/sim/startup/units", false, "feet", 0 },
1544 {"units-meters", false, OPTION_STRING, "/sim/startup/units", false, "meters", 0 },
1545 {"timeofday", true, OPTION_STRING, "/sim/startup/time-offset-type", false, "noon", 0 },
1546 {"season", true, OPTION_STRING, "/sim/startup/season", false, "summer", 0 },
1547 {"time-offset", true, OPTION_FUNC, "", false, "", fgOptTimeOffset },
1548 {"time-match-real", false, OPTION_STRING, "/sim/startup/time-offset-type", false, "system-offset", 0 },
1549 {"time-match-local", false, OPTION_STRING, "/sim/startup/time-offset-type", false, "latitude-offset", 0 },
1550 {"start-date-sys", true, OPTION_FUNC, "", false, "", fgOptStartDateSys },
1551 {"start-date-lat", true, OPTION_FUNC, "", false, "", fgOptStartDateLat },
1552 {"start-date-gmt", true, OPTION_FUNC, "", false, "", fgOptStartDateGmt },
1553 {"hud-tris", false, OPTION_STRING, "/sim/hud/frame-stat-type", false, "tris", 0 },
1554 {"hud-culled", false, OPTION_STRING, "/sim/hud/frame-stat-type", false, "culled", 0 },
1555 {"atcsim", true, OPTION_CHANNEL, "", false, "dummy", 0 },
1556 {"atlas", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1557 {"httpd", true, OPTION_CHANNEL, "", false, "", 0 },
1558 {"jpg-httpd", true, OPTION_CHANNEL, "", false, "", 0 },
1559 {"native", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1560 {"native-ctrls", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1561 {"native-fdm", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1562 {"native-gui", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1563 {"opengc", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1564 {"AV400", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1565 {"AV400Sim", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1566 {"AV400WSimA", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1567 {"AV400WSimB", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1568 {"garmin", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1569 {"igc", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1570 {"nmea", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1571 {"generic", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1572 {"props", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1573 {"telnet", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1574 {"pve", true, OPTION_CHANNEL, "", false, "", 0 },
1575 {"ray", true, OPTION_CHANNEL, "", false, "", 0 },
1576 {"rul", true, OPTION_CHANNEL, "", false, "", 0 },
1577 {"joyclient", true, OPTION_CHANNEL, "", false, "", 0 },
1578 {"jsclient", true, OPTION_CHANNEL, "", false, "", 0 },
1579 {"proxy", true, OPTION_FUNC, "", false, "", fgSetupProxy },
1580 {"callsign", true, OPTION_FUNC, "", false, "", fgOptCallSign},
1581 {"multiplay", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1583 {"hla", true, OPTION_CHANNEL, "", false, "", 0 },
1584 {"hla-local", true, OPTION_CHANNEL, "", false, "", 0 },
1586 {"trace-read", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptTraceRead },
1587 {"trace-write", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptTraceWrite },
1588 {"log-level", true, OPTION_FUNC, "", false, "", fgOptLogLevel },
1589 {"log-class", true, OPTION_FUNC, "", false, "", fgOptLogClasses },
1590 {"view-offset", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptViewOffset },
1591 {"visibility", true, OPTION_FUNC, "", false, "", fgOptVisibilityMeters },
1592 {"visibility-miles", true, OPTION_FUNC, "", false, "", fgOptVisibilityMiles },
1593 {"random-wind", false, OPTION_FUNC, "", false, "", fgOptRandomWind },
1594 {"wind", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptWind },
1595 {"turbulence", true, OPTION_FUNC, "", false, "", fgOptTurbulence },
1596 {"ceiling", true, OPTION_FUNC, "", false, "", fgOptCeiling },
1597 {"wp", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptWp },
1598 {"flight-plan", true, OPTION_STRING, "/autopilot/route-manager/file-path", false, "", NULL },
1599 {"config", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptConfig },
1600 {"aircraft", true, OPTION_STRING, "/sim/aircraft", false, "", 0 },
1601 {"vehicle", true, OPTION_STRING, "/sim/aircraft", false, "", 0 },
1602 {"failure", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptFailure },
1604 {"enable-fgcom", false, OPTION_BOOL, "/sim/fgcom/enabled", true, "", 0 },
1605 {"disable-fgcom", false, OPTION_BOOL, "/sim/fgcom/enabled", false, "", 0 },
1607 {"com1", true, OPTION_DOUBLE, "/instrumentation/comm[0]/frequencies/selected-mhz", false, "", 0 },
1608 {"com2", true, OPTION_DOUBLE, "/instrumentation/comm[1]/frequencies/selected-mhz", false, "", 0 },
1609 {"nav1", true, OPTION_FUNC, "", false, "", fgOptNAV1 },
1610 {"nav2", true, OPTION_FUNC, "", false, "", fgOptNAV2 },
1611 {"adf", /*legacy*/ true, OPTION_FUNC, "", false, "", fgOptADF1 },
1612 {"adf1", true, OPTION_FUNC, "", false, "", fgOptADF1 },
1613 {"adf2", true, OPTION_FUNC, "", false, "", fgOptADF2 },
1614 {"dme", true, OPTION_FUNC, "", false, "", fgOptDME },
1615 {"min-status", true, OPTION_STRING, "/sim/aircraft-min-status", false, "all", 0 },
1616 {"livery", true, OPTION_FUNC, "", false, "", fgOptLivery },
1617 {"ai-scenario", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptScenario },
1618 {"parking-id", true, OPTION_FUNC, "", false, "", fgOptParking },
1619 {"version", false, OPTION_FUNC, "", false, "", fgOptVersion },
1620 {"enable-fpe", false, OPTION_IGNORE, "", false, "", 0},
1621 {"fgviewer", false, OPTION_IGNORE, "", false, "", 0},
1622 {"no-default-config", false, OPTION_IGNORE, "", false, "", 0},
1623 {"prop", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptSetProperty},
1628 namespace flightgear
1632 * internal storage of a value->option binding
1637 OptionValue(OptionDesc* d, const string& v) :
1645 typedef std::vector<OptionValue> OptionValueVec;
1646 typedef std::map<string, OptionDesc*> OptionDescDict;
1648 class Options::OptionsPrivate
1652 OptionValueVec::const_iterator findValue(const string& key) const
1654 OptionValueVec::const_iterator it = values.begin();
1655 for (; it != values.end(); ++it) {
1657 continue; // ignore markers
1660 if (it->desc->option == key) {
1663 } // of set values iteration
1665 return it; // not found
1668 OptionDesc* findOption(const string& key) const
1670 OptionDescDict::const_iterator it = options.find(key);
1671 if (it == options.end()) {
1678 int processOption(OptionDesc* desc, const string& arg_value)
1681 return FG_OPTIONS_OK; // tolerate marker options
1684 switch ( desc->type & 0xffff ) {
1686 fgSetBool( desc->property, desc->b_param );
1689 if ( desc->has_param && !arg_value.empty() ) {
1690 fgSetString( desc->property, arg_value.c_str() );
1691 } else if ( !desc->has_param && arg_value.empty() ) {
1692 fgSetString( desc->property, desc->s_param );
1693 } else if ( desc->has_param ) {
1694 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' needs a parameter" );
1695 return FG_OPTIONS_ERROR;
1697 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' does not have a parameter" );
1698 return FG_OPTIONS_ERROR;
1702 if ( !arg_value.empty() ) {
1703 fgSetDouble( desc->property, atof( arg_value ) );
1705 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' needs a parameter" );
1706 return FG_OPTIONS_ERROR;
1710 if ( !arg_value.empty() ) {
1711 fgSetInt( desc->property, atoi( arg_value ) );
1713 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' needs a parameter" );
1714 return FG_OPTIONS_ERROR;
1717 case OPTION_CHANNEL:
1718 // XXX return value of add_channel should be checked?
1719 if ( desc->has_param && !arg_value.empty() ) {
1720 add_channel( desc->option, arg_value );
1721 } else if ( !desc->has_param && arg_value.empty() ) {
1722 add_channel( desc->option, desc->s_param );
1723 } else if ( desc->has_param ) {
1724 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' needs a parameter" );
1725 return FG_OPTIONS_ERROR;
1727 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' does not have a parameter" );
1728 return FG_OPTIONS_ERROR;
1732 if ( desc->has_param && !arg_value.empty() ) {
1733 return desc->func( arg_value.c_str() );
1734 } else if ( !desc->has_param && arg_value.empty() ) {
1735 return desc->func( desc->s_param );
1736 } else if ( desc->has_param ) {
1737 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' needs a parameter" );
1738 return FG_OPTIONS_ERROR;
1740 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' does not have a parameter" );
1741 return FG_OPTIONS_ERROR;
1749 return FG_OPTIONS_OK;
1753 * insert a marker value into the values vector. This is necessary
1754 * when processing options, to ensure the correct ordering, where we scan
1755 * for marker values in reverse, and then forwards within each group.
1757 void insertGroupMarker()
1759 values.push_back(OptionValue(NULL, "-"));
1763 * given a current iterator into the values, find the preceeding group marker,
1764 * or return the beginning of the value vector.
1766 OptionValueVec::const_iterator rfindGroup(OptionValueVec::const_iterator pos) const
1768 while (--pos != values.begin()) {
1769 if (pos->desc == NULL) {
1770 return pos; // found a marker, we're done
1780 shouldLoadDefaultConfig;
1782 OptionDescDict options;
1783 OptionValueVec values;
1784 simgear::PathList propertyFiles;
1787 Options* Options::sharedInstance()
1789 if (shared_instance == NULL) {
1790 shared_instance = new Options;
1793 return shared_instance;
1796 Options::Options() :
1797 p(new OptionsPrivate())
1799 p->showHelp = false;
1801 p->showAircraft = false;
1802 p->shouldLoadDefaultConfig = true;
1805 OptionDesc *desc = &fgOptionArray[ 0 ];
1806 while ( desc->option != 0 ) {
1807 p->options[ desc->option ] = desc;
1816 void Options::init(int argc, char **argv, const SGPath& appDataPath)
1818 // first, process the command line
1819 bool inOptions = true;
1820 for (int i=1; i<argc; ++i) {
1821 if (inOptions && (argv[i][0] == '-')) {
1822 if (strcmp(argv[i], "--") == 0) { // end of options delimiter
1827 int result = parseOption(argv[i]);
1828 processArgResult(result);
1830 // XML properties file
1833 SG_LOG(SG_GENERAL, SG_ALERT, "config file not found:" << f.str());
1837 p->propertyFiles.push_back(f);
1839 } // of arguments iteration
1840 p->insertGroupMarker(); // command line is one group
1842 // establish log-level before anything else - otherwise it is not possible
1843 // to show extra (debug/info/warning) messages for the start-up phase.
1844 fgOptLogLevel(valueForOption("log-level", "alert").c_str());
1846 if (!p->shouldLoadDefaultConfig) {
1851 // then config files
1853 std::string homedir;
1854 if (getenv("HOME")) {
1855 homedir = getenv("HOME");
1858 if( !homedir.empty() && !hostname.empty() ) {
1859 // Check for ~/.fgfsrc.hostname
1860 config.set(homedir);
1861 config.append(".fgfsrc");
1862 config.concat( "." );
1863 config.concat( hostname );
1867 // Check for ~/.fgfsrc
1868 if( !homedir.empty() ) {
1869 config.set(homedir);
1870 config.append(".fgfsrc");
1874 // check for a config file in app data
1875 SGPath appDataConfig(appDataPath);
1876 appDataConfig.append("fgfsrc");
1877 if (appDataConfig.exists()) {
1878 readConfig(appDataConfig);
1884 // system.fgfsrc handling
1885 if( ! hostname.empty() ) {
1886 config.set(globals->get_fg_root());
1887 config.append( "system.fgfsrc" );
1888 config.concat( "." );
1889 config.concat( hostname );
1893 config.set(globals->get_fg_root());
1894 config.append( "system.fgfsrc" );
1898 void Options::initAircraft()
1900 BOOST_FOREACH(const string& paths, valuesForOption("fg-aircraft")) {
1901 globals->append_aircraft_paths(paths);
1904 const char* envp = ::getenv("FG_AIRCRAFT");
1906 globals->append_aircraft_paths(envp);
1910 if (isOptionSet("aircraft")) {
1911 aircraft = valueForOption("aircraft");
1912 } else if (isOptionSet("vehicle")) {
1913 aircraft = valueForOption("vehicle");
1916 if (!aircraft.empty()) {
1917 SG_LOG(SG_INPUT, SG_INFO, "aircraft = " << aircraft );
1918 fgSetString("/sim/aircraft", aircraft.c_str() );
1920 SG_LOG(SG_INPUT, SG_INFO, "No user specified aircraft, using default" );
1923 // persist across reset
1924 SGPropertyNode* aircraftProp = fgGetNode("/sim/aircraft", true);
1925 aircraftProp->setAttribute(SGPropertyNode::PRESERVE, true);
1927 if (p->showAircraft) {
1928 fgOptLogLevel( "alert" );
1929 SGPath path( globals->get_fg_root() );
1930 path.append("Aircraft");
1931 fgShowAircraft(path);
1935 if (isOptionSet("aircraft-dir")) {
1936 // set this now, so it's available in FindAndCacheAircraft
1937 fgSetString("/sim/aircraft-dir", valueForOption("aircraft-dir"));
1941 void Options::processArgResult(int result)
1943 if ((result == FG_OPTIONS_HELP) || (result == FG_OPTIONS_ERROR))
1945 else if (result == FG_OPTIONS_VERBOSE_HELP)
1947 else if (result == FG_OPTIONS_SHOW_AIRCRAFT) {
1948 p->showAircraft = true;
1949 } else if (result == FG_OPTIONS_NO_DEFAULT_CONFIG) {
1950 p->shouldLoadDefaultConfig = false;
1951 } else if (result == FG_OPTIONS_SHOW_SOUND_DEVICES) {
1955 string vendor = smgr.get_vendor();
1956 string renderer = smgr.get_renderer();
1957 cout << renderer << " provided by " << vendor << endl;
1958 cout << endl << "No. Device" << endl;
1960 vector <const char*>devices = smgr.get_available_devices();
1961 for (vector <const char*>::size_type i=0; i<devices.size(); i++) {
1962 cout << i << ". \"" << devices[i] << "\"" << endl;
1967 } else if (result == FG_OPTIONS_EXIT) {
1972 void Options::readConfig(const SGPath& path)
1974 sg_gzifstream in( path.str() );
1975 if ( !in.is_open() ) {
1979 SG_LOG( SG_GENERAL, SG_INFO, "Processing config file: " << path.str() );
1982 while ( ! in.eof() ) {
1984 getline( in, line, '\n' );
1986 // catch extraneous (DOS) line ending character
1988 for (i = line.length(); i > 0; i--)
1989 if (line[i - 1] > 32)
1991 line = line.substr( 0, i );
1993 if ( parseOption( line ) == FG_OPTIONS_ERROR ) {
1994 cerr << endl << "Config file parse error: " << path.str() << " '"
1995 << line << "'" << endl;
2001 p->insertGroupMarker(); // each config file is a group
2004 int Options::parseOption(const string& s)
2006 if ((s == "--help") || (s=="-h")) {
2007 return FG_OPTIONS_HELP;
2008 } else if ( (s == "--verbose") || (s == "-v") ) {
2009 // verbose help/usage request
2010 return FG_OPTIONS_VERBOSE_HELP;
2011 } else if ((s == "--console") || (s == "-c")) {
2012 simgear::requestConsole();
2013 return FG_OPTIONS_OK;
2014 } else if (s.find("-psn") == 0) {
2015 // on Mac, when launched from the GUI, we are passed the ProcessSerialNumber
2016 // as an argument (and no others). Silently ignore the argument here.
2017 return FG_OPTIONS_OK;
2018 } else if ( s.find( "--show-aircraft") == 0) {
2019 return(FG_OPTIONS_SHOW_AIRCRAFT);
2020 } else if ( s.find( "--show-sound-devices") == 0) {
2021 return(FG_OPTIONS_SHOW_SOUND_DEVICES);
2022 } else if ( s.find( "--no-default-config") == 0) {
2023 return FG_OPTIONS_NO_DEFAULT_CONFIG;
2024 } else if ( s.find( "--prop:") == 0) {
2025 // property setting has a slightly different syntax, so fudge things
2026 OptionDesc* desc = p->findOption("prop");
2027 if (s.find("=", 7) == string::npos) { // no equals token
2028 SG_LOG(SG_GENERAL, SG_ALERT, "malformed property option:" << s);
2029 return FG_OPTIONS_ERROR;
2032 p->values.push_back(OptionValue(desc, s.substr(7)));
2033 return FG_OPTIONS_OK;
2034 } else if ( s.find( "--" ) == 0 ) {
2035 size_t eqPos = s.find( '=' );
2037 if (eqPos == string::npos) {
2040 key = s.substr( 2, eqPos - 2 );
2041 value = s.substr( eqPos + 1);
2044 return addOption(key, value);
2046 flightgear::modalMessageBox("Unknown option", "Unknown command-line option: " + s);
2047 return FG_OPTIONS_ERROR;
2051 int Options::addOption(const string &key, const string &value)
2053 OptionDesc* desc = p->findOption(key);
2055 flightgear::modalMessageBox("Unknown option", "Unknown command-line option: " + key);
2056 return FG_OPTIONS_ERROR;
2059 if (!(desc->type & OPTION_MULTI)) {
2060 OptionValueVec::const_iterator it = p->findValue(key);
2061 if (it != p->values.end()) {
2062 SG_LOG(SG_GENERAL, SG_WARN, "multiple values forbidden for option:" << key << ", ignoring:" << value);
2063 return FG_OPTIONS_OK;
2067 p->values.push_back(OptionValue(desc, value));
2068 return FG_OPTIONS_OK;
2071 bool Options::isOptionSet(const string &key) const
2073 OptionValueVec::const_iterator it = p->findValue(key);
2074 return (it != p->values.end());
2077 string Options::valueForOption(const string& key, const string& defValue) const
2079 OptionValueVec::const_iterator it = p->findValue(key);
2080 if (it == p->values.end()) {
2087 string_list Options::valuesForOption(const std::string& key) const
2090 OptionValueVec::const_iterator it = p->values.begin();
2091 for (; it != p->values.end(); ++it) {
2093 continue; // ignore marker values
2096 if (it->desc->option == key) {
2097 result.push_back(it->value);
2105 static string defaultTerrasyncDir()
2107 #if defined(SG_WINDOWS)
2108 SGPath p(SGPath::documents());
2109 p.append("FlightGear");
2111 SGPath p(globals->get_fg_home());
2113 p.append("TerraSync");
2118 OptionResult Options::processOptions()
2120 // establish locale before showing help (this selects the default locale,
2121 // when no explicit option was set)
2122 globals->get_locale()->selectLanguage(valueForOption("language").c_str());
2124 // now FG_ROOT is setup, process various command line options that bail us
2125 // out quickly, but rely on aircraft / root settings
2128 return FG_OPTIONS_EXIT;
2131 // processing order is complicated. We must process groups LIFO, but the
2132 // values *within* each group in FIFO order, to retain consistency with
2133 // older versions of FG, and existing user configs.
2134 // in practice this means system.fgfsrc must be *processed* before
2135 // .fgfsrc, which must be processed before the command line args, and so on.
2136 OptionValueVec::const_iterator groupEnd = p->values.end();
2138 while (groupEnd != p->values.begin()) {
2139 OptionValueVec::const_iterator groupBegin = p->rfindGroup(groupEnd);
2140 // run over the group in FIFO order
2141 OptionValueVec::const_iterator it;
2142 for (it = groupBegin; it != groupEnd; ++it) {
2143 int result = p->processOption(it->desc, it->value);
2146 case FG_OPTIONS_ERROR:
2148 return FG_OPTIONS_ERROR;
2150 case FG_OPTIONS_EXIT:
2151 return FG_OPTIONS_EXIT;
2158 groupEnd = groupBegin;
2161 BOOST_FOREACH(const SGPath& file, p->propertyFiles) {
2162 if (!file.exists()) {
2163 SG_LOG(SG_GENERAL, SG_ALERT, "config file not found:" << file.str());
2167 SG_LOG(SG_GENERAL, SG_INFO,
2168 "Reading command-line property file " << file.str());
2169 readProperties(file.str(), globals->get_props());
2172 // now options are process, do supplemental fixup
2173 const char *envp = ::getenv( "FG_SCENERY" );
2175 globals->append_fg_scenery(envp);
2178 // terrasync directory fixup
2179 string terrasyncDir = fgGetString("/sim/terrasync/scenery-dir");
2180 if (terrasyncDir.empty()) {
2181 terrasyncDir = defaultTerrasyncDir();
2182 // auto-save it for next time
2184 SG_LOG(SG_GENERAL, SG_INFO,
2185 "Using default TerraSync: " << terrasyncDir);
2186 fgSetString("/sim/terrasync/scenery-dir", terrasyncDir);
2189 SGPath p(terrasyncDir);
2191 // following is necessary to ensure NavDataCache sees stable scenery paths from
2192 // terrasync. Ensure the Terrain and Objects subdirs exist immediately, rather
2193 // than waiting for the first tiles to be scheduled.
2194 simgear::Dir terrainDir(SGPath(p, "Terrain")),
2195 objectsDir(SGPath(p, "Objects"));
2196 if (!terrainDir.exists()) {
2197 terrainDir.create(0755);
2200 if (!objectsDir.exists()) {
2201 objectsDir.create(0755);
2203 if (fgGetBool("/sim/terrasync/enabled")) {
2204 const string_list& scenery_paths(globals->get_fg_scenery());
2205 if (std::find(scenery_paths.begin(), scenery_paths.end(), terrasyncDir) == scenery_paths.end()) {
2206 // terrasync dir is not in the scenery paths, add it
2207 globals->append_fg_scenery(terrasyncDir);
2211 if (globals->get_fg_scenery().empty()) {
2212 // no scenery paths set *at all*, use the data in FG_ROOT
2213 SGPath root(globals->get_fg_root());
2214 root.append("Scenery");
2215 globals->append_fg_scenery(root.str());
2218 return FG_OPTIONS_OK;
2221 void Options::showUsage() const
2223 fgOptLogLevel( "alert" );
2225 FGLocale *locale = globals->get_locale();
2226 SGPropertyNode options_root;
2228 simgear::requestConsole(); // ensure console is shown on Windows
2232 fgLoadProps("options.xml", &options_root);
2233 } catch (const sg_exception &) {
2234 cout << "Unable to read the help file." << endl;
2235 cout << "Make sure the file options.xml is located in the FlightGear base directory," << endl;
2236 cout << "and the location of the base directory is specified by setting $FG_ROOT or" << endl;
2237 cout << "by adding --fg-root=path as a program argument." << endl;
2242 SGPropertyNode *options = options_root.getNode("options");
2244 SG_LOG( SG_GENERAL, SG_ALERT,
2245 "Error reading options.xml: <options> directive not found." );
2249 if (!locale->loadResource("options"))
2251 cout << "Unable to read the language resource." << endl;
2255 const char* usage = locale->getLocalizedString(options->getStringValue("usage"), "options");
2257 cout << usage << endl;
2260 vector<SGPropertyNode_ptr>section = options->getChildren("section");
2261 for (unsigned int j = 0; j < section.size(); j++) {
2264 vector<SGPropertyNode_ptr>option = section[j]->getChildren("option");
2265 for (unsigned int k = 0; k < option.size(); k++) {
2267 SGPropertyNode *name = option[k]->getNode("name");
2268 SGPropertyNode *short_name = option[k]->getNode("short");
2269 SGPropertyNode *key = option[k]->getNode("key");
2270 SGPropertyNode *arg = option[k]->getNode("arg");
2271 bool brief = option[k]->getNode("brief") != 0;
2273 if ((brief || p->verbose) && name) {
2274 string tmp = name->getStringValue();
2278 tmp.append(key->getStringValue());
2282 tmp.append(arg->getStringValue());
2286 tmp.append(short_name->getStringValue());
2289 if (tmp.size() <= 25) {
2292 msg.append( 27-tmp.size(), ' ');
2296 msg.append(32, ' ');
2298 // There may be more than one <description> tag associated
2301 vector<SGPropertyNode_ptr> desc;
2302 desc = option[k]->getChildren("description");
2303 if (! desc.empty()) {
2304 for ( unsigned int l = 0; l < desc.size(); l++) {
2305 string t = desc[l]->getStringValue();
2307 // There may be more than one translation line.
2308 vector<SGPropertyNode_ptr>trans_desc = locale->getLocalizedStrings(t.c_str(),"options");
2309 for ( unsigned int m = 0; m < trans_desc.size(); m++ ) {
2310 string t_str = trans_desc[m]->getStringValue();
2312 if ((m > 0) || ((l > 0) && m == 0)) {
2313 msg.append( 32, ' ');
2316 // If the string is too large to fit on the screen,
2317 // then split it up in several pieces.
2319 while ( t_str.size() > 47 ) {
2321 string::size_type m = t_str.rfind(' ', 47);
2322 msg += t_str.substr(0, m) + '\n';
2323 msg.append( 32, ' ');
2325 t_str.erase(t_str.begin(), t_str.begin() + m + 1);
2327 msg += t_str + '\n';
2334 const char* name = locale->getLocalizedString(section[j]->getStringValue("name"),"options");
2335 if (!msg.empty() && name) {
2336 cout << endl << name << ":" << endl;
2342 if ( !p->verbose ) {
2343 const char* verbose_help = locale->getLocalizedString(options->getStringValue("verbose-help"),"options");
2345 cout << endl << verbose_help << endl;
2348 std::cout << "Hit a key to continue..." << std::endl;
2353 #if defined(__CYGWIN__)
2354 string Options::platformDefaultRoot() const
2359 #elif defined(SG_WINDOWS)
2360 string Options::platformDefaultRoot() const
2364 #elif defined(SG_MAC)
2365 // platformDefaultRoot defined in CocoaHelpers.mm
2367 string Options::platformDefaultRoot() const
2373 void Options::setupRoot()
2376 if (isOptionSet("fg-root")) {
2377 root = valueForOption("fg-root"); // easy!
2379 // Next check if fg-root is set as an env variable
2380 char *envp = ::getenv( "FG_ROOT" );
2381 if ( envp != NULL ) {
2384 root = platformDefaultRoot();
2388 SG_LOG(SG_INPUT, SG_INFO, "fg_root = " << root );
2389 globals->set_fg_root(root);
2392 static char required_version[] = FLIGHTGEAR_VERSION;
2393 string base_version = fgBasePackageVersion();
2394 if (base_version.empty()) {
2395 flightgear::fatalMessageBox("Base package not found",
2396 "Required data files not found, check your installation.",
2397 "Looking for base-package files at: '" + root + "'");
2402 if (base_version != required_version) {
2403 // tell the operator how to use this application
2405 flightgear::fatalMessageBox("Base package version mismatch",
2406 "Version check failed: please check your installation.",
2407 "Found data files for version '" + base_version +
2408 "' at '" + globals->get_fg_root() + "', version '"
2409 + required_version + "' is required.");
2415 bool Options::shouldLoadDefaultConfig() const
2417 return p->shouldLoadDefaultConfig;
2420 bool Options::checkForArg(int argc, char* argv[], const char* checkArg)
2422 for (int i = 0; i < argc; ++i) {
2423 char* arg = argv[i];
2424 if (!strncmp("--", arg, 2) && !strcmp(arg + 2, checkArg)) {
2428 if ((arg[0] == '-') && !strcmp(arg + 1, checkArg)) {
2436 } // of namespace flightgear