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 <Network/http/httpd.hxx>
69 #include "AircraftDirVisitorBase.hxx"
71 #include <osg/Version>
73 #if defined( HAVE_VERSION_H ) && HAVE_VERSION_H
74 # include <Include/version.h>
75 # include <simgear/version.h>
77 # include <Include/no_version.h>
88 using namespace flightgear;
90 #define NEW_DEFAULT_MODEL_HZ 120
92 static flightgear::Options* shared_instance = NULL;
95 atof( const string& str )
97 return ::atof( str.c_str() );
101 atoi( const string& str )
103 return ::atoi( str.c_str() );
106 static int fgSetupProxy( const char *arg );
109 * Set a few fail-safe default property values.
111 * These should all be set in $FG_ROOT/preferences.xml, but just
112 * in case, we provide some initial sane values here. This method
113 * should be invoked *before* reading any init files.
115 void fgSetDefaults ()
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/splash-screen", true);
162 // we want mouse-pointer to have an undefined value if nothing is
163 // specified so we can do the right thing for voodoo-1/2 cards.
164 // fgSetString("/sim/startup/mouse-pointer", "disabled");
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 fgOptHttpd( const char * arg )
955 // port may be any valid address:port notation
956 // like 127.0.0.1:8080
957 // or just the port 8080
958 string port = simgear::strutils::strip(string(arg));
959 if( port.empty() ) return FG_OPTIONS_ERROR;
960 fgSetString( string(flightgear::http::PROPERTY_ROOT).append("/options/listening-port").c_str(), port );
961 return FG_OPTIONS_OK;
965 fgSetupProxy( const char *arg )
967 string options = simgear::strutils::strip( arg );
968 string host, port, auth;
969 string::size_type pos;
971 // this is NURLP - NURLP is not an url parser
972 if( simgear::strutils::starts_with( options, "http://" ) )
973 options = options.substr( 7 );
974 if( simgear::strutils::ends_with( options, "/" ) )
975 options = options.substr( 0, options.length() - 1 );
977 host = port = auth = "";
978 if ((pos = options.find("@")) != string::npos)
979 auth = options.substr(0, pos++);
983 host = options.substr(pos, options.size());
984 if ((pos = host.find(":")) != string::npos) {
985 port = host.substr(++pos, host.size());
986 host.erase(--pos, host.size());
989 fgSetString("/sim/presets/proxy/host", host.c_str());
990 fgSetString("/sim/presets/proxy/port", port.c_str());
991 fgSetString("/sim/presets/proxy/authentication", auth.c_str());
993 return FG_OPTIONS_OK;
997 fgOptTraceRead( const char *arg )
1000 SG_LOG(SG_GENERAL, SG_INFO, "Tracing reads for property " << name);
1001 fgGetNode(name.c_str(), true)
1002 ->setAttribute(SGPropertyNode::TRACE_READ, true);
1003 return FG_OPTIONS_OK;
1007 fgOptLogLevel( const char *arg )
1009 fgSetString("/sim/logging/priority", arg);
1010 setLoggingPriority(arg);
1012 return FG_OPTIONS_OK;
1016 fgOptLogClasses( const char *arg )
1018 fgSetString("/sim/logging/classes", arg);
1019 setLoggingClasses (arg);
1021 return FG_OPTIONS_OK;
1025 fgOptTraceWrite( const char *arg )
1028 SG_LOG(SG_GENERAL, SG_INFO, "Tracing writes for property " << name);
1029 fgGetNode(name.c_str(), true)
1030 ->setAttribute(SGPropertyNode::TRACE_WRITE, true);
1031 return FG_OPTIONS_OK;
1035 fgOptViewOffset( const char *arg )
1037 // $$$ begin - added VS Renganathan, 14 Oct 2K
1038 // for multi-window outside window imagery
1039 string woffset = arg;
1040 double default_view_offset = 0.0;
1041 if ( woffset == "LEFT" ) {
1042 default_view_offset = SGD_PI * 0.25;
1043 } else if ( woffset == "RIGHT" ) {
1044 default_view_offset = SGD_PI * 1.75;
1045 } else if ( woffset == "CENTER" ) {
1046 default_view_offset = 0.00;
1048 default_view_offset = atof( woffset.c_str() ) * SGD_DEGREES_TO_RADIANS;
1050 /* apparently not used (CLO, 11 Jun 2002)
1051 FGViewer *pilot_view =
1052 (FGViewer *)globals->get_viewmgr()->get_view( 0 ); */
1053 // this will work without calls to the viewer...
1054 fgSetDouble( "/sim/current-view/heading-offset-deg",
1055 default_view_offset * SGD_RADIANS_TO_DEGREES );
1056 // $$$ end - added VS Renganathan, 14 Oct 2K
1057 return FG_OPTIONS_OK;
1061 fgOptVisibilityMeters( const char *arg )
1063 Environment::Presets::VisibilitySingleton::instance()->preset( atof( arg ) );
1064 return FG_OPTIONS_OK;
1068 fgOptVisibilityMiles( const char *arg )
1070 Environment::Presets::VisibilitySingleton::instance()->preset( atof( arg ) * 5280.0 * SG_FEET_TO_METER );
1071 return FG_OPTIONS_OK;
1075 fgOptRandomWind( const char *arg )
1077 double min_hdg = sg_random() * 360.0;
1078 double max_hdg = min_hdg + (20 - sqrt(sg_random() * 400));
1079 double speed = sg_random() * sg_random() * 40;
1080 double gust = speed + (10 - sqrt(sg_random() * 100));
1081 Environment::Presets::WindSingleton::instance()->preset(min_hdg, max_hdg, speed, gust);
1082 return FG_OPTIONS_OK;
1086 fgOptWind( const char *arg )
1088 double min_hdg = 0.0, max_hdg = 0.0, speed = 0.0, gust = 0.0;
1089 if (!parse_wind( arg, &min_hdg, &max_hdg, &speed, &gust)) {
1090 SG_LOG( SG_GENERAL, SG_ALERT, "bad wind value " << arg );
1091 return FG_OPTIONS_ERROR;
1093 Environment::Presets::WindSingleton::instance()->preset(min_hdg, max_hdg, speed, gust);
1094 return FG_OPTIONS_OK;
1098 fgOptTurbulence( const char *arg )
1100 Environment::Presets::TurbulenceSingleton::instance()->preset( atof(arg) );
1101 return FG_OPTIONS_OK;
1105 fgOptCeiling( const char *arg )
1107 double elevation, thickness;
1109 string::size_type pos = spec.find(':');
1110 if (pos == string::npos) {
1111 elevation = atof(spec.c_str());
1114 elevation = atof(spec.substr(0, pos).c_str());
1115 thickness = atof(spec.substr(pos + 1).c_str());
1117 Environment::Presets::CeilingSingleton::instance()->preset( elevation, thickness );
1118 return FG_OPTIONS_OK;
1122 fgOptWp( const char *arg )
1124 string_list *waypoints = globals->get_initial_waypoints();
1126 waypoints = new string_list;
1127 globals->set_initial_waypoints(waypoints);
1129 waypoints->push_back(arg);
1130 return FG_OPTIONS_OK;
1134 fgOptConfig( const char *arg )
1138 readProperties(file, globals->get_props());
1139 } catch (const sg_exception &e) {
1140 string message = "Error loading config file: ";
1141 message += e.getFormattedMessage() + e.getOrigin();
1142 SG_LOG(SG_INPUT, SG_ALERT, message);
1143 return FG_OPTIONS_ERROR;
1145 return FG_OPTIONS_OK;
1149 parse_colon (const string &s, double * val1, double * val2)
1151 string::size_type pos = s.find(':');
1152 if (pos == string::npos) {
1156 *val1 = atof(s.substr(0, pos).c_str());
1157 *val2 = atof(s.substr(pos+1).c_str());
1164 fgOptFailure( const char * arg )
1168 fgSetBool("/systems/pitot/serviceable", false);
1169 } else if (a == "static") {
1170 fgSetBool("/systems/static/serviceable", false);
1171 } else if (a == "vacuum") {
1172 fgSetBool("/systems/vacuum/serviceable", false);
1173 } else if (a == "electrical") {
1174 fgSetBool("/systems/electrical/serviceable", false);
1176 SG_LOG(SG_INPUT, SG_ALERT, "Unknown failure mode: " << a);
1177 return FG_OPTIONS_ERROR;
1180 return FG_OPTIONS_OK;
1185 fgOptNAV1( const char * arg )
1187 double radial, freq;
1188 if (parse_colon(arg, &radial, &freq))
1189 fgSetDouble("/instrumentation/nav[0]/radials/selected-deg", radial);
1190 fgSetDouble("/instrumentation/nav[0]/frequencies/selected-mhz", freq);
1191 return FG_OPTIONS_OK;
1195 fgOptNAV2( const char * arg )
1197 double radial, freq;
1198 if (parse_colon(arg, &radial, &freq))
1199 fgSetDouble("/instrumentation/nav[1]/radials/selected-deg", radial);
1200 fgSetDouble("/instrumentation/nav[1]/frequencies/selected-mhz", freq);
1201 return FG_OPTIONS_OK;
1205 fgOptADF1( const char * arg )
1208 if (parse_colon(arg, &rot, &freq))
1209 fgSetDouble("/instrumentation/adf[0]/rotation-deg", rot);
1210 fgSetDouble("/instrumentation/adf[0]/frequencies/selected-khz", freq);
1211 return FG_OPTIONS_OK;
1215 fgOptADF2( const char * arg )
1218 if (parse_colon(arg, &rot, &freq))
1219 fgSetDouble("/instrumentation/adf[1]/rotation-deg", rot);
1220 fgSetDouble("/instrumentation/adf[1]/frequencies/selected-khz", freq);
1221 return FG_OPTIONS_OK;
1225 fgOptDME( const char *arg )
1228 if (opt == "nav1") {
1229 fgSetInt("/instrumentation/dme/switch-position", 1);
1230 fgSetString("/instrumentation/dme/frequencies/source",
1231 "/instrumentation/nav[0]/frequencies/selected-mhz");
1232 } else if (opt == "nav2") {
1233 fgSetInt("/instrumentation/dme/switch-position", 3);
1234 fgSetString("/instrumentation/dme/frequencies/source",
1235 "/instrumentation/nav[1]/frequencies/selected-mhz");
1237 double frequency = atof(arg);
1240 SG_LOG(SG_INPUT, SG_ALERT, "Invalid DME frequency: '" << arg << "'.");
1241 return FG_OPTIONS_ERROR;
1243 fgSetInt("/instrumentation/dme/switch-position", 2);
1244 fgSetString("/instrumentation/dme/frequencies/source",
1245 "/instrumentation/dme/frequencies/selected-mhz");
1246 fgSetDouble("/instrumentation/dme/frequencies/selected-mhz", frequency);
1248 return FG_OPTIONS_OK;
1252 fgOptLivery( const char *arg )
1255 string livery_path = "livery/" + opt;
1256 fgSetString("/sim/model/texture-path", livery_path.c_str() );
1257 return FG_OPTIONS_OK;
1261 fgOptScenario( const char *arg )
1263 SGPropertyNode_ptr ai_node = fgGetNode( "/sim/ai", true );
1264 vector<SGPropertyNode_ptr> scenarii = ai_node->getChildren( "scenario" );
1266 for ( size_t i = 0; i < scenarii.size(); ++i ) {
1267 int ind = scenarii[i]->getIndex();
1268 if ( index < ind ) {
1272 SGPropertyNode_ptr scenario = ai_node->getNode( "scenario", index + 1, true );
1273 scenario->setStringValue( arg );
1274 return FG_OPTIONS_OK;
1278 fgOptRunway( const char *arg )
1280 fgSetString("/sim/presets/runway", arg );
1281 fgSetBool("/sim/presets/runway-requested", true );
1282 return FG_OPTIONS_OK;
1286 fgOptParking( const char *arg )
1288 cerr << "Processing argument " << arg << endl;
1289 fgSetString("/sim/presets/parking", arg );
1290 fgSetBool ("/sim/presets/parking-requested", true );
1291 return FG_OPTIONS_OK;
1295 fgOptVersion( const char *arg )
1297 cerr << "FlightGear version: " << FLIGHTGEAR_VERSION << endl;
1298 cerr << "Revision: " << REVISION << endl;
1299 cerr << "Build-Id: " << HUDSON_BUILD_ID << endl;
1300 cerr << "FG_ROOT=" << globals->get_fg_root() << endl;
1301 cerr << "FG_HOME=" << globals->get_fg_home() << endl;
1302 cerr << "FG_SCENERY=";
1305 string_list scn = globals->get_fg_scenery();
1306 for (string_list::const_iterator it = scn.begin(); it != scn.end(); it++)
1308 if (didsome) cerr << ":";
1313 cerr << "SimGear version: " << SG_STRINGIZE(SIMGEAR_VERSION) << endl;
1314 cerr << "PLIB version: " << PLIB_VERSION << endl;
1315 return FG_OPTIONS_EXIT;
1319 fgOptCallSign(const char * arg)
1323 strncpy(callsign,arg,10);
1325 for (i=0;callsign[i];i++)
1327 char c = callsign[i];
1328 if (c >= 'A' && c <= 'Z') continue;
1329 if (c >= 'a' && c <= 'z') continue;
1330 if (c >= '0' && c <= '9') continue;
1331 if (c == '-' || c == '_') continue;
1332 // convert any other illegal characters
1335 fgSetString("sim/multiplay/callsign", callsign );
1336 return FG_OPTIONS_OK;
1340 fgOptIgnoreAutosave(const char* arg)
1342 fgSetBool("/sim/startup/ignore-autosave", true);
1343 // don't overwrite autosave on exit
1344 fgSetBool("/sim/startup/save-on-exit", false);
1345 return FG_OPTIONS_OK;
1348 // Set a property for the --prop: option. Syntax: --prop:[<type>:]<name>=<value>
1349 // <type> can be "double" etc. but also only the first letter "d".
1350 // Examples: --prop:alpha=1 --prop:bool:beta=true --prop:d:gamma=0.123
1352 fgOptSetProperty(const char* raw)
1355 string::size_type pos = arg.find('=');
1356 if (pos == arg.npos || pos == 0 || pos + 1 == arg.size())
1357 return FG_OPTIONS_ERROR;
1359 string name = arg.substr(0, pos);
1360 string value = arg.substr(pos + 1);
1362 pos = name.find(':');
1364 if (pos != name.npos && pos != 0 && pos + 1 != name.size()) {
1365 type = name.substr(0, pos);
1366 name = name.substr(pos + 1);
1368 SGPropertyNode *n = fgGetNode(name.c_str(), true);
1370 bool writable = n->getAttribute(SGPropertyNode::WRITE);
1372 n->setAttribute(SGPropertyNode::WRITE, true);
1376 ret = n->setUnspecifiedValue(value.c_str());
1377 else if (type == "s" || type == "string")
1378 ret = n->setStringValue(value.c_str());
1379 else if (type == "d" || type == "double")
1380 ret = n->setDoubleValue(strtod(value.c_str(), 0));
1381 else if (type == "f" || type == "float")
1382 ret = n->setFloatValue(atof(value.c_str()));
1383 else if (type == "l" || type == "long")
1384 ret = n->setLongValue(strtol(value.c_str(), 0, 0));
1385 else if (type == "i" || type == "int")
1386 ret = n->setIntValue(atoi(value.c_str()));
1387 else if (type == "b" || type == "bool")
1388 ret = n->setBoolValue(value == "true" || atoi(value.c_str()) != 0);
1391 n->setAttribute(SGPropertyNode::WRITE, false);
1392 return ret ? FG_OPTIONS_OK : FG_OPTIONS_ERROR;
1398 option has_param type property b_param s_param func
1401 option : name of the option
1402 has_param : option is --name=value if true or --name if false
1403 type : OPTION_BOOL - property is a boolean
1404 OPTION_STRING - property is a string
1405 OPTION_DOUBLE - property is a double
1406 OPTION_INT - property is an integer
1407 OPTION_CHANNEL - name of option is the name of a channel
1408 OPTION_FUNC - the option trigger a function
1409 b_param : if type==OPTION_BOOL,
1410 value set to the property (has_param is false for boolean)
1411 s_param : if type==OPTION_STRING,
1412 value set to the property if has_param is false
1413 func : function called if type==OPTION_FUNC. if has_param is true,
1414 the value is passed to the function as a string, otherwise,
1417 For OPTION_DOUBLE and OPTION_INT, the parameter value is converted into a
1418 double or an integer and set to the property.
1420 For OPTION_CHANNEL, add_channel is called with the parameter value as the
1424 enum OptionType { OPTION_BOOL = 0, OPTION_STRING, OPTION_DOUBLE, OPTION_INT, OPTION_CHANNEL, OPTION_FUNC, OPTION_IGNORE };
1425 const int OPTION_MULTI = 1 << 17;
1431 const char *property;
1433 const char *s_param;
1434 int (*func)( const char * );
1435 } fgOptionArray[] = {
1437 {"language", true, OPTION_IGNORE, "", false, "", 0 },
1438 {"console", false, OPTION_IGNORE, "", false, "", 0 },
1439 {"disable-rembrandt", false, OPTION_BOOL, "/sim/rendering/rembrandt/enabled", false, "", 0 },
1440 {"enable-rembrandt", false, OPTION_BOOL, "/sim/rendering/rembrandt/enabled", true, "", 0 },
1441 {"renderer", true, OPTION_STRING, "/sim/rendering/rembrandt/renderer", false, "", 0 },
1442 {"disable-splash-screen", false, OPTION_BOOL, "/sim/startup/splash-screen", false, "", 0 },
1443 {"enable-splash-screen", false, OPTION_BOOL, "/sim/startup/splash-screen", true, "", 0 },
1444 {"disable-mouse-pointer", false, OPTION_STRING, "/sim/startup/mouse-pointer", false, "disabled", 0 },
1445 {"enable-mouse-pointer", false, OPTION_STRING, "/sim/startup/mouse-pointer", false, "enabled", 0 },
1446 {"disable-random-objects", false, OPTION_BOOL, "/sim/rendering/random-objects", false, "", 0 },
1447 {"enable-random-objects", false, OPTION_BOOL, "/sim/rendering/random-objects", true, "", 0 },
1448 {"disable-random-vegetation", false, OPTION_BOOL, "/sim/rendering/random-vegetation", false, "", 0 },
1449 {"enable-random-vegetation", false, OPTION_BOOL, "/sim/rendering/random-vegetation", true, "", 0 },
1450 {"disable-random-buildings", false, OPTION_BOOL, "/sim/rendering/random-buildings", false, "", 0 },
1451 {"enable-random-buildings", false, OPTION_BOOL, "/sim/rendering/random-buildings", true, "", 0 },
1452 {"disable-real-weather-fetch", false, OPTION_BOOL, "/environment/realwx/enabled", false, "", 0 },
1453 {"enable-real-weather-fetch", false, OPTION_BOOL, "/environment/realwx/enabled", true, "", 0 },
1454 {"metar", true, OPTION_STRING, "/environment/metar/data", false, "", 0 },
1455 {"disable-ai-models", false, OPTION_BOOL, "/sim/ai/enabled", false, "", 0 },
1456 {"enable-ai-models", false, OPTION_BOOL, "/sim/ai/enabled", true, "", 0 },
1457 {"disable-ai-traffic", false, OPTION_BOOL, "/sim/traffic-manager/enabled", false, "", 0 },
1458 {"enable-ai-traffic", false, OPTION_BOOL, "/sim/traffic-manager/enabled", true, "", 0 },
1459 {"disable-freeze", false, OPTION_BOOL, "/sim/freeze/master", false, "", 0 },
1460 {"enable-freeze", false, OPTION_BOOL, "/sim/freeze/master", true, "", 0 },
1461 {"disable-fuel-freeze", false, OPTION_BOOL, "/sim/freeze/fuel", false, "", 0 },
1462 {"enable-fuel-freeze", false, OPTION_BOOL, "/sim/freeze/fuel", true, "", 0 },
1463 {"disable-clock-freeze", false, OPTION_BOOL, "/sim/freeze/clock", false, "", 0 },
1464 {"enable-clock-freeze", false, OPTION_BOOL, "/sim/freeze/clock", true, "", 0 },
1465 {"disable-hud-3d", false, OPTION_BOOL, "/sim/hud/enable3d[1]", false, "", 0 },
1466 {"enable-hud-3d", false, OPTION_BOOL, "/sim/hud/enable3d[1]", true, "", 0 },
1467 {"disable-anti-alias-hud", false, OPTION_BOOL, "/sim/hud/color/antialiased", false, "", 0 },
1468 {"enable-anti-alias-hud", false, OPTION_BOOL, "/sim/hud/color/antialiased", true, "", 0 },
1469 {"disable-auto-coordination", false, OPTION_BOOL, "/controls/flight/auto-coordination", false, "", 0 },
1470 {"enable-auto-coordination", false, OPTION_BOOL, "/controls/flight/auto-coordination", true, "", 0 },
1471 {"browser-app", true, OPTION_STRING, "/sim/startup/browser-app", false, "", 0 },
1472 {"disable-hud", false, OPTION_BOOL, "/sim/hud/visibility[1]", false, "", 0 },
1473 {"enable-hud", false, OPTION_BOOL, "/sim/hud/visibility[1]", true, "", 0 },
1474 {"disable-panel", false, OPTION_BOOL, "/sim/panel/visibility", false, "", 0 },
1475 {"enable-panel", false, OPTION_BOOL, "/sim/panel/visibility", true, "", 0 },
1476 {"disable-sound", false, OPTION_BOOL, "/sim/sound/working", false, "", 0 },
1477 {"enable-sound", false, OPTION_BOOL, "/sim/sound/working", true, "", 0 },
1478 {"sound-device", true, OPTION_STRING, "/sim/sound/device-name", false, "", 0 },
1479 {"airport", true, OPTION_STRING, "/sim/presets/airport-id", false, "", 0 },
1480 {"runway", true, OPTION_FUNC, "", false, "", fgOptRunway },
1481 {"vor", true, OPTION_FUNC, "", false, "", fgOptVOR },
1482 {"vor-frequency", true, OPTION_DOUBLE, "/sim/presets/vor-freq", false, "", fgOptVOR },
1483 {"ndb", true, OPTION_FUNC, "", false, "", fgOptNDB },
1484 {"ndb-frequency", true, OPTION_DOUBLE, "/sim/presets/ndb-freq", false, "", fgOptVOR },
1485 {"carrier", true, OPTION_FUNC, "", false, "", fgOptCarrier },
1486 {"parkpos", true, OPTION_FUNC, "", false, "", fgOptParkpos },
1487 {"fix", true, OPTION_FUNC, "", false, "", fgOptFIX },
1488 {"offset-distance", true, OPTION_DOUBLE, "/sim/presets/offset-distance-nm", false, "", 0 },
1489 {"offset-azimuth", true, OPTION_DOUBLE, "/sim/presets/offset-azimuth-deg", false, "", 0 },
1490 {"lon", true, OPTION_FUNC, "", false, "", fgOptLon },
1491 {"lat", true, OPTION_FUNC, "", false, "", fgOptLat },
1492 {"altitude", true, OPTION_FUNC, "", false, "", fgOptAltitude },
1493 {"uBody", true, OPTION_FUNC, "", false, "", fgOptUBody },
1494 {"vBody", true, OPTION_FUNC, "", false, "", fgOptVBody },
1495 {"wBody", true, OPTION_FUNC, "", false, "", fgOptWBody },
1496 {"vNorth", true, OPTION_FUNC, "", false, "", fgOptVNorth },
1497 {"vEast", true, OPTION_FUNC, "", false, "", fgOptVEast },
1498 {"vDown", true, OPTION_FUNC, "", false, "", fgOptVDown },
1499 {"vc", true, OPTION_FUNC, "", false, "", fgOptVc },
1500 {"mach", true, OPTION_FUNC, "", false, "", fgOptMach },
1501 {"heading", true, OPTION_DOUBLE, "/sim/presets/heading-deg", false, "", 0 },
1502 {"roll", true, OPTION_DOUBLE, "/sim/presets/roll-deg", false, "", 0 },
1503 {"pitch", true, OPTION_DOUBLE, "/sim/presets/pitch-deg", false, "", 0 },
1504 {"glideslope", true, OPTION_DOUBLE, "/sim/presets/glideslope-deg", false, "", 0 },
1505 {"roc", true, OPTION_FUNC, "", false, "", fgOptRoc },
1506 {"fg-root", true, OPTION_IGNORE, "", false, "", 0 },
1507 {"fg-scenery", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptFgScenery },
1508 {"fg-aircraft", true, OPTION_IGNORE | OPTION_MULTI, "", false, "", 0 },
1509 {"fdm", true, OPTION_STRING, "/sim/flight-model", false, "", 0 },
1510 {"aero", true, OPTION_STRING, "/sim/aero", false, "", 0 },
1511 {"aircraft-dir", true, OPTION_IGNORE, "", false, "", 0 },
1512 {"model-hz", true, OPTION_INT, "/sim/model-hz", false, "", 0 },
1513 {"max-fps", true, OPTION_DOUBLE, "/sim/frame-rate-throttle-hz", false, "", 0 },
1514 {"speed", true, OPTION_DOUBLE, "/sim/speed-up", false, "", 0 },
1515 {"trim", false, OPTION_BOOL, "/sim/presets/trim", true, "", 0 },
1516 {"notrim", false, OPTION_BOOL, "/sim/presets/trim", false, "", 0 },
1517 {"on-ground", false, OPTION_BOOL, "/sim/presets/onground", true, "", 0 },
1518 {"in-air", false, OPTION_BOOL, "/sim/presets/onground", false, "", 0 },
1519 {"fog-disable", false, OPTION_STRING, "/sim/rendering/fog", false, "disabled", 0 },
1520 {"fog-fastest", false, OPTION_STRING, "/sim/rendering/fog", false, "fastest", 0 },
1521 {"fog-nicest", false, OPTION_STRING, "/sim/rendering/fog", false, "nicest", 0 },
1522 {"disable-horizon-effect", false, OPTION_BOOL, "/sim/rendering/horizon-effect", false, "", 0 },
1523 {"enable-horizon-effect", false, OPTION_BOOL, "/sim/rendering/horizon-effect", true, "", 0 },
1524 {"disable-enhanced-lighting", false, OPTION_BOOL, "/sim/rendering/enhanced-lighting", false, "", 0 },
1525 {"enable-enhanced-lighting", false, OPTION_BOOL, "/sim/rendering/enhanced-lighting", true, "", 0 },
1526 {"disable-distance-attenuation", false, OPTION_BOOL, "/sim/rendering/distance-attenuation", false, "", 0 },
1527 {"enable-distance-attenuation", false, OPTION_BOOL, "/sim/rendering/distance-attenuation", true, "", 0 },
1528 {"disable-specular-highlight", false, OPTION_BOOL, "/sim/rendering/specular-highlight", false, "", 0 },
1529 {"enable-specular-highlight", false, OPTION_BOOL, "/sim/rendering/specular-highlight", true, "", 0 },
1530 {"disable-clouds", false, OPTION_BOOL, "/environment/clouds/status", false, "", 0 },
1531 {"enable-clouds", false, OPTION_BOOL, "/environment/clouds/status", true, "", 0 },
1532 {"disable-clouds3d", false, OPTION_BOOL, "/sim/rendering/clouds3d-enable", false, "", 0 },
1533 {"enable-clouds3d", false, OPTION_BOOL, "/sim/rendering/clouds3d-enable", true, "", 0 },
1534 {"fov", true, OPTION_FUNC, "", false, "", fgOptFov },
1535 {"aspect-ratio-multiplier", true, OPTION_DOUBLE, "/sim/current-view/aspect-ratio-multiplier", false, "", 0 },
1536 {"disable-fullscreen", false, OPTION_BOOL, "/sim/startup/fullscreen", false, "", 0 },
1537 {"enable-fullscreen", false, OPTION_BOOL, "/sim/startup/fullscreen", true, "", 0 },
1538 {"disable-save-on-exit", false, OPTION_BOOL, "/sim/startup/save-on-exit", false, "", 0 },
1539 {"enable-save-on-exit", false, OPTION_BOOL, "/sim/startup/save-on-exit", true, "", 0 },
1540 {"read-only", false, OPTION_BOOL, "/sim/fghome-readonly", true, "", 0 },
1541 {"ignore-autosave", false, OPTION_FUNC, "", false, "", fgOptIgnoreAutosave },
1542 {"restore-defaults", false, OPTION_BOOL, "/sim/startup/restore-defaults", true, "", 0 },
1543 {"shading-flat", false, OPTION_BOOL, "/sim/rendering/shading", false, "", 0 },
1544 {"shading-smooth", false, OPTION_BOOL, "/sim/rendering/shading", true, "", 0 },
1545 {"texture-filtering", false, OPTION_INT, "/sim/rendering/filtering", 1, "", 0 },
1546 {"disable-wireframe", false, OPTION_BOOL, "/sim/rendering/wireframe", false, "", 0 },
1547 {"enable-wireframe", false, OPTION_BOOL, "/sim/rendering/wireframe", true, "", 0 },
1548 {"materials-file", true, OPTION_STRING, "/sim/rendering/materials-file", false, "", 0 },
1549 {"disable-terrasync", false, OPTION_BOOL, "/sim/terrasync/enabled", false, "", 0 },
1550 {"enable-terrasync", false, OPTION_BOOL, "/sim/terrasync/enabled", true, "", 0 },
1551 {"terrasync-dir", true, OPTION_STRING, "/sim/terrasync/scenery-dir", false, "", 0 },
1552 {"geometry", true, OPTION_FUNC, "", false, "", fgOptGeometry },
1553 {"bpp", true, OPTION_FUNC, "", false, "", fgOptBpp },
1554 {"units-feet", false, OPTION_STRING, "/sim/startup/units", false, "feet", 0 },
1555 {"units-meters", false, OPTION_STRING, "/sim/startup/units", false, "meters", 0 },
1556 {"timeofday", true, OPTION_STRING, "/sim/startup/time-offset-type", false, "noon", 0 },
1557 {"season", true, OPTION_STRING, "/sim/startup/season", false, "summer", 0 },
1558 {"time-offset", true, OPTION_FUNC, "", false, "", fgOptTimeOffset },
1559 {"time-match-real", false, OPTION_STRING, "/sim/startup/time-offset-type", false, "system-offset", 0 },
1560 {"time-match-local", false, OPTION_STRING, "/sim/startup/time-offset-type", false, "latitude-offset", 0 },
1561 {"start-date-sys", true, OPTION_FUNC, "", false, "", fgOptStartDateSys },
1562 {"start-date-lat", true, OPTION_FUNC, "", false, "", fgOptStartDateLat },
1563 {"start-date-gmt", true, OPTION_FUNC, "", false, "", fgOptStartDateGmt },
1564 {"hud-tris", false, OPTION_STRING, "/sim/hud/frame-stat-type", false, "tris", 0 },
1565 {"hud-culled", false, OPTION_STRING, "/sim/hud/frame-stat-type", false, "culled", 0 },
1566 {"atcsim", true, OPTION_CHANNEL, "", false, "dummy", 0 },
1567 {"atlas", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1568 {"httpd", true, OPTION_FUNC , "", false, "", fgOptHttpd },
1569 {"jpg-httpd", true, OPTION_CHANNEL, "", false, "", 0 },
1570 {"native", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1571 {"native-ctrls", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1572 {"native-fdm", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1573 {"native-gui", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1574 {"opengc", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1575 {"AV400", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1576 {"AV400Sim", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1577 {"AV400WSimA", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1578 {"AV400WSimB", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1579 {"garmin", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1580 {"igc", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1581 {"nmea", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1582 {"generic", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1583 {"props", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1584 {"telnet", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1585 {"pve", true, OPTION_CHANNEL, "", false, "", 0 },
1586 {"ray", true, OPTION_CHANNEL, "", false, "", 0 },
1587 {"rul", true, OPTION_CHANNEL, "", false, "", 0 },
1588 {"joyclient", true, OPTION_CHANNEL, "", false, "", 0 },
1589 {"jsclient", true, OPTION_CHANNEL, "", false, "", 0 },
1590 {"proxy", true, OPTION_FUNC, "", false, "", fgSetupProxy },
1591 {"callsign", true, OPTION_FUNC, "", false, "", fgOptCallSign},
1592 {"multiplay", true, OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1594 {"hla", true, OPTION_CHANNEL, "", false, "", 0 },
1595 {"hla-local", true, OPTION_CHANNEL, "", false, "", 0 },
1597 {"trace-read", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptTraceRead },
1598 {"trace-write", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptTraceWrite },
1599 {"log-level", true, OPTION_FUNC, "", false, "", fgOptLogLevel },
1600 {"log-class", true, OPTION_FUNC, "", false, "", fgOptLogClasses },
1601 {"view-offset", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptViewOffset },
1602 {"visibility", true, OPTION_FUNC, "", false, "", fgOptVisibilityMeters },
1603 {"visibility-miles", true, OPTION_FUNC, "", false, "", fgOptVisibilityMiles },
1604 {"random-wind", false, OPTION_FUNC, "", false, "", fgOptRandomWind },
1605 {"wind", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptWind },
1606 {"turbulence", true, OPTION_FUNC, "", false, "", fgOptTurbulence },
1607 {"ceiling", true, OPTION_FUNC, "", false, "", fgOptCeiling },
1608 {"wp", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptWp },
1609 {"flight-plan", true, OPTION_STRING, "/autopilot/route-manager/file-path", false, "", NULL },
1610 {"config", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptConfig },
1611 {"aircraft", true, OPTION_STRING, "/sim/aircraft", false, "", 0 },
1612 {"vehicle", true, OPTION_STRING, "/sim/aircraft", false, "", 0 },
1613 {"failure", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptFailure },
1615 {"enable-fgcom", false, OPTION_BOOL, "/sim/fgcom/enabled", true, "", 0 },
1616 {"disable-fgcom", false, OPTION_BOOL, "/sim/fgcom/enabled", false, "", 0 },
1618 {"com1", true, OPTION_DOUBLE, "/instrumentation/comm[0]/frequencies/selected-mhz", false, "", 0 },
1619 {"com2", true, OPTION_DOUBLE, "/instrumentation/comm[1]/frequencies/selected-mhz", false, "", 0 },
1620 {"nav1", true, OPTION_FUNC, "", false, "", fgOptNAV1 },
1621 {"nav2", true, OPTION_FUNC, "", false, "", fgOptNAV2 },
1622 {"adf", /*legacy*/ true, OPTION_FUNC, "", false, "", fgOptADF1 },
1623 {"adf1", true, OPTION_FUNC, "", false, "", fgOptADF1 },
1624 {"adf2", true, OPTION_FUNC, "", false, "", fgOptADF2 },
1625 {"dme", true, OPTION_FUNC, "", false, "", fgOptDME },
1626 {"min-status", true, OPTION_STRING, "/sim/aircraft-min-status", false, "all", 0 },
1627 {"livery", true, OPTION_FUNC, "", false, "", fgOptLivery },
1628 {"ai-scenario", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptScenario },
1629 {"parking-id", true, OPTION_FUNC, "", false, "", fgOptParking },
1630 {"version", false, OPTION_FUNC, "", false, "", fgOptVersion },
1631 {"enable-fpe", false, OPTION_IGNORE, "", false, "", 0},
1632 {"fgviewer", false, OPTION_IGNORE, "", false, "", 0},
1633 {"no-default-config", false, OPTION_IGNORE, "", false, "", 0},
1634 {"prop", true, OPTION_FUNC | OPTION_MULTI, "", false, "", fgOptSetProperty},
1639 namespace flightgear
1643 * internal storage of a value->option binding
1648 OptionValue(OptionDesc* d, const string& v) :
1656 typedef std::vector<OptionValue> OptionValueVec;
1657 typedef std::map<string, OptionDesc*> OptionDescDict;
1659 class Options::OptionsPrivate
1663 OptionValueVec::const_iterator findValue(const string& key) const
1665 OptionValueVec::const_iterator it = values.begin();
1666 for (; it != values.end(); ++it) {
1668 continue; // ignore markers
1671 if (it->desc->option == key) {
1674 } // of set values iteration
1676 return it; // not found
1679 OptionDesc* findOption(const string& key) const
1681 OptionDescDict::const_iterator it = options.find(key);
1682 if (it == options.end()) {
1689 int processOption(OptionDesc* desc, const string& arg_value)
1692 return FG_OPTIONS_OK; // tolerate marker options
1695 switch ( desc->type & 0xffff ) {
1697 fgSetBool( desc->property, desc->b_param );
1700 if ( desc->has_param && !arg_value.empty() ) {
1701 fgSetString( desc->property, arg_value.c_str() );
1702 } else if ( !desc->has_param && arg_value.empty() ) {
1703 fgSetString( desc->property, desc->s_param );
1704 } else if ( desc->has_param ) {
1705 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' needs a parameter" );
1706 return FG_OPTIONS_ERROR;
1708 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' does not have a parameter" );
1709 return FG_OPTIONS_ERROR;
1713 if ( !arg_value.empty() ) {
1714 fgSetDouble( desc->property, atof( arg_value ) );
1716 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' needs a parameter" );
1717 return FG_OPTIONS_ERROR;
1721 if ( !arg_value.empty() ) {
1722 fgSetInt( desc->property, atoi( arg_value ) );
1724 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' needs a parameter" );
1725 return FG_OPTIONS_ERROR;
1728 case OPTION_CHANNEL:
1729 // XXX return value of add_channel should be checked?
1730 if ( desc->has_param && !arg_value.empty() ) {
1731 add_channel( desc->option, arg_value );
1732 } else if ( !desc->has_param && arg_value.empty() ) {
1733 add_channel( desc->option, desc->s_param );
1734 } else if ( desc->has_param ) {
1735 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' needs a parameter" );
1736 return FG_OPTIONS_ERROR;
1738 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' does not have a parameter" );
1739 return FG_OPTIONS_ERROR;
1743 if ( desc->has_param && !arg_value.empty() ) {
1744 return desc->func( arg_value.c_str() );
1745 } else if ( !desc->has_param && arg_value.empty() ) {
1746 return desc->func( desc->s_param );
1747 } else if ( desc->has_param ) {
1748 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' needs a parameter" );
1749 return FG_OPTIONS_ERROR;
1751 SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' does not have a parameter" );
1752 return FG_OPTIONS_ERROR;
1760 return FG_OPTIONS_OK;
1764 * insert a marker value into the values vector. This is necessary
1765 * when processing options, to ensure the correct ordering, where we scan
1766 * for marker values in reverse, and then forwards within each group.
1768 void insertGroupMarker()
1770 values.push_back(OptionValue(NULL, "-"));
1774 * given a current iterator into the values, find the preceeding group marker,
1775 * or return the beginning of the value vector.
1777 OptionValueVec::const_iterator rfindGroup(OptionValueVec::const_iterator pos) const
1779 while (--pos != values.begin()) {
1780 if (pos->desc == NULL) {
1781 return pos; // found a marker, we're done
1791 shouldLoadDefaultConfig;
1793 OptionDescDict options;
1794 OptionValueVec values;
1795 simgear::PathList propertyFiles;
1798 Options* Options::sharedInstance()
1800 if (shared_instance == NULL) {
1801 shared_instance = new Options;
1804 return shared_instance;
1807 Options::Options() :
1808 p(new OptionsPrivate())
1810 p->showHelp = false;
1812 p->showAircraft = false;
1813 p->shouldLoadDefaultConfig = true;
1816 OptionDesc *desc = &fgOptionArray[ 0 ];
1817 while ( desc->option != 0 ) {
1818 p->options[ desc->option ] = desc;
1827 void Options::init(int argc, char **argv, const SGPath& appDataPath)
1829 // first, process the command line
1830 bool inOptions = true;
1831 for (int i=1; i<argc; ++i) {
1832 if (inOptions && (argv[i][0] == '-')) {
1833 if (strcmp(argv[i], "--") == 0) { // end of options delimiter
1838 int result = parseOption(argv[i]);
1839 processArgResult(result);
1841 // XML properties file
1844 SG_LOG(SG_GENERAL, SG_ALERT, "config file not found:" << f.str());
1846 p->propertyFiles.push_back(f);
1849 } // of arguments iteration
1850 p->insertGroupMarker(); // command line is one group
1852 // establish log-level before anything else - otherwise it is not possible
1853 // to show extra (debug/info/warning) messages for the start-up phase.
1854 fgOptLogLevel(valueForOption("log-level", "alert").c_str());
1856 if (!p->shouldLoadDefaultConfig) {
1861 // then config files
1863 std::string homedir;
1864 if (getenv("HOME")) {
1865 homedir = getenv("HOME");
1868 if( !homedir.empty() && !hostname.empty() ) {
1869 // Check for ~/.fgfsrc.hostname
1870 config.set(homedir);
1871 config.append(".fgfsrc");
1872 config.concat( "." );
1873 config.concat( hostname );
1877 // Check for ~/.fgfsrc
1878 if( !homedir.empty() ) {
1879 config.set(homedir);
1880 config.append(".fgfsrc");
1884 // check for a config file in app data
1885 SGPath appDataConfig(appDataPath);
1886 appDataConfig.append("fgfsrc");
1887 if (appDataConfig.exists()) {
1888 readConfig(appDataConfig);
1894 // system.fgfsrc handling
1895 if( ! hostname.empty() ) {
1896 config.set(globals->get_fg_root());
1897 config.append( "system.fgfsrc" );
1898 config.concat( "." );
1899 config.concat( hostname );
1903 config.set(globals->get_fg_root());
1904 config.append( "system.fgfsrc" );
1908 void Options::initAircraft()
1910 BOOST_FOREACH(const string& paths, valuesForOption("fg-aircraft")) {
1911 globals->append_aircraft_paths(paths);
1914 const char* envp = ::getenv("FG_AIRCRAFT");
1916 globals->append_aircraft_paths(envp);
1920 if (isOptionSet("aircraft")) {
1921 aircraft = valueForOption("aircraft");
1922 } else if (isOptionSet("vehicle")) {
1923 aircraft = valueForOption("vehicle");
1926 if (!aircraft.empty()) {
1927 SG_LOG(SG_INPUT, SG_INFO, "aircraft = " << aircraft );
1928 fgSetString("/sim/aircraft", aircraft.c_str() );
1930 SG_LOG(SG_INPUT, SG_INFO, "No user specified aircraft, using default" );
1933 if (p->showAircraft) {
1934 fgOptLogLevel( "alert" );
1935 SGPath path( globals->get_fg_root() );
1936 path.append("Aircraft");
1937 fgShowAircraft(path);
1941 if (isOptionSet("aircraft-dir")) {
1942 // set this now, so it's available in FindAndCacheAircraft
1943 fgSetString("/sim/aircraft-dir", valueForOption("aircraft-dir"));
1947 void Options::processArgResult(int result)
1949 if ((result == FG_OPTIONS_HELP) || (result == FG_OPTIONS_ERROR))
1951 else if (result == FG_OPTIONS_VERBOSE_HELP)
1953 else if (result == FG_OPTIONS_SHOW_AIRCRAFT) {
1954 p->showAircraft = true;
1955 } else if (result == FG_OPTIONS_NO_DEFAULT_CONFIG) {
1956 p->shouldLoadDefaultConfig = false;
1957 } else if (result == FG_OPTIONS_SHOW_SOUND_DEVICES) {
1961 string vendor = smgr.get_vendor();
1962 string renderer = smgr.get_renderer();
1963 cout << renderer << " provided by " << vendor << endl;
1964 cout << endl << "No. Device" << endl;
1966 vector <const char*>devices = smgr.get_available_devices();
1967 for (vector <const char*>::size_type i=0; i<devices.size(); i++) {
1968 cout << i << ". \"" << devices[i] << "\"" << endl;
1973 } else if (result == FG_OPTIONS_EXIT) {
1978 void Options::readConfig(const SGPath& path)
1980 sg_gzifstream in( path.str() );
1981 if ( !in.is_open() ) {
1985 SG_LOG( SG_GENERAL, SG_INFO, "Processing config file: " << path.str() );
1988 while ( ! in.eof() ) {
1990 getline( in, line, '\n' );
1992 // catch extraneous (DOS) line ending character
1994 for (i = line.length(); i > 0; i--)
1995 if (line[i - 1] > 32)
1997 line = line.substr( 0, i );
1999 if ( parseOption( line ) == FG_OPTIONS_ERROR ) {
2000 cerr << endl << "Config file parse error: " << path.str() << " '"
2001 << line << "'" << endl;
2007 p->insertGroupMarker(); // each config file is a group
2010 int Options::parseOption(const string& s)
2012 if ((s == "--help") || (s=="-h")) {
2013 return FG_OPTIONS_HELP;
2014 } else if ( (s == "--verbose") || (s == "-v") ) {
2015 // verbose help/usage request
2016 return FG_OPTIONS_VERBOSE_HELP;
2017 } else if ((s == "--console") || (s == "-c")) {
2018 simgear::requestConsole();
2019 return FG_OPTIONS_OK;
2020 } else if (s.find("-psn") == 0) {
2021 // on Mac, when launched from the GUI, we are passed the ProcessSerialNumber
2022 // as an argument (and no others). Silently ignore the argument here.
2023 return FG_OPTIONS_OK;
2024 } else if ( s.find( "--show-aircraft") == 0) {
2025 return(FG_OPTIONS_SHOW_AIRCRAFT);
2026 } else if ( s.find( "--show-sound-devices") == 0) {
2027 return(FG_OPTIONS_SHOW_SOUND_DEVICES);
2028 } else if ( s.find( "--no-default-config") == 0) {
2029 return FG_OPTIONS_NO_DEFAULT_CONFIG;
2030 } else if ( s.find( "--prop:") == 0) {
2031 // property setting has a slightly different syntax, so fudge things
2032 OptionDesc* desc = p->findOption("prop");
2033 if (s.find("=", 7) == string::npos) { // no equals token
2034 SG_LOG(SG_GENERAL, SG_ALERT, "malformed property option:" << s);
2035 return FG_OPTIONS_ERROR;
2038 p->values.push_back(OptionValue(desc, s.substr(7)));
2039 return FG_OPTIONS_OK;
2040 } else if ( s.find( "--" ) == 0 ) {
2041 size_t eqPos = s.find( '=' );
2043 if (eqPos == string::npos) {
2046 key = s.substr( 2, eqPos - 2 );
2047 value = s.substr( eqPos + 1);
2050 return addOption(key, value);
2052 flightgear::modalMessageBox("Unknown option", "Unknown command-line option: " + s);
2053 return FG_OPTIONS_ERROR;
2057 int Options::addOption(const string &key, const string &value)
2059 OptionDesc* desc = p->findOption(key);
2061 flightgear::modalMessageBox("Unknown option", "Unknown command-line option: " + key);
2062 return FG_OPTIONS_ERROR;
2065 if (!(desc->type & OPTION_MULTI)) {
2066 OptionValueVec::const_iterator it = p->findValue(key);
2067 if (it != p->values.end()) {
2068 SG_LOG(SG_GENERAL, SG_WARN, "multiple values forbidden for option:" << key << ", ignoring:" << value);
2069 return FG_OPTIONS_OK;
2073 p->values.push_back(OptionValue(desc, value));
2074 return FG_OPTIONS_OK;
2077 bool Options::isOptionSet(const string &key) const
2079 OptionValueVec::const_iterator it = p->findValue(key);
2080 return (it != p->values.end());
2083 string Options::valueForOption(const string& key, const string& defValue) const
2085 OptionValueVec::const_iterator it = p->findValue(key);
2086 if (it == p->values.end()) {
2093 string_list Options::valuesForOption(const std::string& key) const
2096 OptionValueVec::const_iterator it = p->values.begin();
2097 for (; it != p->values.end(); ++it) {
2099 continue; // ignore marker values
2102 if (it->desc->option == key) {
2103 result.push_back(it->value);
2111 static string defaultTerrasyncDir()
2113 #if defined(SG_WINDOWS)
2114 SGPath p(SGPath::documents());
2115 p.append("FlightGear");
2117 SGPath p(globals->get_fg_home());
2119 p.append("TerraSync");
2124 OptionResult Options::processOptions()
2126 // establish locale before showing help (this selects the default locale,
2127 // when no explicit option was set)
2128 globals->get_locale()->selectLanguage(valueForOption("language").c_str());
2130 // now FG_ROOT is setup, process various command line options that bail us
2131 // out quickly, but rely on aircraft / root settings
2134 return FG_OPTIONS_EXIT;
2137 // processing order is complicated. We must process groups LIFO, but the
2138 // values *within* each group in FIFO order, to retain consistency with
2139 // older versions of FG, and existing user configs.
2140 // in practice this means system.fgfsrc must be *processed* before
2141 // .fgfsrc, which must be processed before the command line args, and so on.
2142 OptionValueVec::const_iterator groupEnd = p->values.end();
2144 while (groupEnd != p->values.begin()) {
2145 OptionValueVec::const_iterator groupBegin = p->rfindGroup(groupEnd);
2146 // run over the group in FIFO order
2147 OptionValueVec::const_iterator it;
2148 for (it = groupBegin; it != groupEnd; ++it) {
2149 int result = p->processOption(it->desc, it->value);
2152 case FG_OPTIONS_ERROR:
2154 return FG_OPTIONS_ERROR;
2156 case FG_OPTIONS_EXIT:
2157 return FG_OPTIONS_EXIT;
2164 groupEnd = groupBegin;
2167 BOOST_FOREACH(const SGPath& file, p->propertyFiles) {
2168 SG_LOG(SG_GENERAL, SG_INFO,
2169 "Reading command-line property file " << file.str());
2170 readProperties(file.str(), globals->get_props());
2173 // now options are process, do supplemental fixup
2174 const char *envp = ::getenv( "FG_SCENERY" );
2176 globals->append_fg_scenery(envp);
2179 // terrasync directory fixup
2180 string terrasyncDir = fgGetString("/sim/terrasync/scenery-dir");
2181 if (terrasyncDir.empty()) {
2182 terrasyncDir = defaultTerrasyncDir();
2183 // auto-save it for next time
2185 SG_LOG(SG_GENERAL, SG_INFO,
2186 "Using default TerraSync: " << terrasyncDir);
2187 fgSetString("/sim/terrasync/scenery-dir", terrasyncDir);
2190 SGPath p(terrasyncDir);
2192 // following is necessary to ensure NavDataCache sees stable scenery paths from
2193 // terrasync. Ensure the Terrain and Objects subdirs exist immediately, rather
2194 // than waiting for the first tiles to be scheduled.
2195 simgear::Dir terrainDir(SGPath(p, "Terrain")),
2196 objectsDir(SGPath(p, "Objects"));
2197 if (!terrainDir.exists()) {
2198 terrainDir.create(0755);
2201 if (!objectsDir.exists()) {
2202 objectsDir.create(0755);
2204 if (fgGetBool("/sim/terrasync/enabled")) {
2205 const string_list& scenery_paths(globals->get_fg_scenery());
2206 if (std::find(scenery_paths.begin(), scenery_paths.end(), terrasyncDir) == scenery_paths.end()) {
2207 // terrasync dir is not in the scenery paths, add it
2208 globals->append_fg_scenery(terrasyncDir);
2212 if (globals->get_fg_scenery().empty()) {
2213 // no scenery paths set *at all*, use the data in FG_ROOT
2214 SGPath root(globals->get_fg_root());
2215 root.append("Scenery");
2216 globals->append_fg_scenery(root.str());
2219 return FG_OPTIONS_OK;
2222 void Options::showUsage() const
2224 fgOptLogLevel( "alert" );
2226 FGLocale *locale = globals->get_locale();
2227 SGPropertyNode options_root;
2229 simgear::requestConsole(); // ensure console is shown on Windows
2233 fgLoadProps("options.xml", &options_root);
2234 } catch (const sg_exception &) {
2235 cout << "Unable to read the help file." << endl;
2236 cout << "Make sure the file options.xml is located in the FlightGear base directory," << endl;
2237 cout << "and the location of the base directory is specified by setting $FG_ROOT or" << endl;
2238 cout << "by adding --fg-root=path as a program argument." << endl;
2243 SGPropertyNode *options = options_root.getNode("options");
2245 SG_LOG( SG_GENERAL, SG_ALERT,
2246 "Error reading options.xml: <options> directive not found." );
2250 if (!locale->loadResource("options"))
2252 cout << "Unable to read the language resource." << endl;
2256 const char* usage = locale->getLocalizedString(options->getStringValue("usage"), "options");
2258 cout << usage << endl;
2261 vector<SGPropertyNode_ptr>section = options->getChildren("section");
2262 for (unsigned int j = 0; j < section.size(); j++) {
2265 vector<SGPropertyNode_ptr>option = section[j]->getChildren("option");
2266 for (unsigned int k = 0; k < option.size(); k++) {
2268 SGPropertyNode *name = option[k]->getNode("name");
2269 SGPropertyNode *short_name = option[k]->getNode("short");
2270 SGPropertyNode *key = option[k]->getNode("key");
2271 SGPropertyNode *arg = option[k]->getNode("arg");
2272 bool brief = option[k]->getNode("brief") != 0;
2274 if ((brief || p->verbose) && name) {
2275 string tmp = name->getStringValue();
2279 tmp.append(key->getStringValue());
2283 tmp.append(arg->getStringValue());
2287 tmp.append(short_name->getStringValue());
2290 if (tmp.size() <= 25) {
2293 msg.append( 27-tmp.size(), ' ');
2297 msg.append(32, ' ');
2299 // There may be more than one <description> tag associated
2302 vector<SGPropertyNode_ptr> desc;
2303 desc = option[k]->getChildren("description");
2304 if (! desc.empty()) {
2305 for ( unsigned int l = 0; l < desc.size(); l++) {
2306 string t = desc[l]->getStringValue();
2308 // There may be more than one translation line.
2309 vector<SGPropertyNode_ptr>trans_desc = locale->getLocalizedStrings(t.c_str(),"options");
2310 for ( unsigned int m = 0; m < trans_desc.size(); m++ ) {
2311 string t_str = trans_desc[m]->getStringValue();
2313 if ((m > 0) || ((l > 0) && m == 0)) {
2314 msg.append( 32, ' ');
2317 // If the string is too large to fit on the screen,
2318 // then split it up in several pieces.
2320 while ( t_str.size() > 47 ) {
2322 string::size_type m = t_str.rfind(' ', 47);
2323 msg += t_str.substr(0, m) + '\n';
2324 msg.append( 32, ' ');
2326 t_str.erase(t_str.begin(), t_str.begin() + m + 1);
2328 msg += t_str + '\n';
2335 const char* name = locale->getLocalizedString(section[j]->getStringValue("name"),"options");
2336 if (!msg.empty() && name) {
2337 cout << endl << name << ":" << endl;
2343 if ( !p->verbose ) {
2344 const char* verbose_help = locale->getLocalizedString(options->getStringValue("verbose-help"),"options");
2346 cout << endl << verbose_help << endl;
2349 std::cout << "Hit a key to continue..." << std::endl;
2354 #if defined(__CYGWIN__)
2355 string Options::platformDefaultRoot() const
2360 #elif defined(SG_WINDOWS)
2361 string Options::platformDefaultRoot() const
2365 #elif defined(SG_MAC)
2366 // platformDefaultRoot defined in CocoaHelpers.mm
2368 string Options::platformDefaultRoot() const
2374 void Options::setupRoot()
2377 if (isOptionSet("fg-root")) {
2378 root = valueForOption("fg-root"); // easy!
2380 // Next check if fg-root is set as an env variable
2381 char *envp = ::getenv( "FG_ROOT" );
2382 if ( envp != NULL ) {
2385 root = platformDefaultRoot();
2389 SG_LOG(SG_INPUT, SG_INFO, "fg_root = " << root );
2390 globals->set_fg_root(root);
2393 static char required_version[] = FLIGHTGEAR_VERSION;
2394 string base_version = fgBasePackageVersion();
2395 if (base_version.empty()) {
2396 flightgear::fatalMessageBox("Base package not found",
2397 "Required data files not found, check your installation.",
2398 "Looking for base-package files at: '" + root + "'");
2403 if (base_version != required_version) {
2404 // tell the operator how to use this application
2406 flightgear::fatalMessageBox("Base package version mismatch",
2407 "Version check failed: please check your installation.",
2408 "Found data files for version '" + base_version +
2409 "' at '" + globals->get_fg_root() + "', version '"
2410 + required_version + "' is required.");
2416 bool Options::shouldLoadDefaultConfig() const
2418 return p->shouldLoadDefaultConfig;
2421 bool Options::checkForArg(int argc, char* argv[], const char* checkArg)
2423 for (int i = 0; i < argc; ++i) {
2424 char* arg = argv[i];
2425 if (!strncmp("--", arg, 2) && !strcmp(arg + 2, checkArg)) {
2429 if ((arg[0] == '-') && !strcmp(arg + 1, checkArg)) {
2437 } // of namespace flightgear