]> git.mxchange.org Git - flightgear.git/blob - src/Main/options.cxx
Kill off platformDesktopPath entirely
[flightgear.git] / src / Main / options.cxx
1 // options.cxx -- class to handle command line options
2 //
3 // Written by Curtis Olson, started April 1998.
4 //
5 // Copyright (C) 1998  Curtis L. Olson  - http://www.flightgear.org/~curt
6 //
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.
11 //
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.
16 //
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.
20 //
21 // $Id$
22
23
24 #ifdef HAVE_CONFIG_H
25 #  include <config.h>
26 #endif
27
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>
33
34 #include <boost/foreach.hpp>
35
36 #include <math.h>               // rint()
37 #include <stdio.h>
38 #include <stdlib.h>             // atof(), atoi()
39 #include <string.h>             // strcmp()
40 #include <algorithm>
41
42 #include <iostream>
43 #include <string>
44
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>
53 #include <GUI/gui.h>
54
55 #include "globals.hxx"
56 #include "fg_init.hxx"
57 #include "fg_props.hxx"
58 #include "options.hxx"
59 #include "util.hxx"
60 #include "main.hxx"
61 #include "locale.hxx"
62 #include <Viewer/viewer.hxx>
63 #include <Viewer/viewmgr.hxx>
64 #include <Environment/presets.hxx>
65
66 #include <osg/Version>
67
68 #if defined( HAVE_VERSION_H ) && HAVE_VERSION_H
69 #  include <Include/version.h>
70 #  include <simgear/version.h>
71 #else
72 #  include <Include/no_version.h>
73 #endif
74
75 #ifdef __APPLE__
76 #  include <CoreFoundation/CoreFoundation.h>
77 #endif
78
79 using std::string;
80 using std::sort;
81 using std::cout;
82 using std::cerr;
83 using std::endl;
84 using std::vector;
85 using std::cin;
86
87 #define NEW_DEFAULT_MODEL_HZ 120
88
89 enum
90 {
91     FG_OPTIONS_OK = 0,
92     FG_OPTIONS_HELP = 1,
93     FG_OPTIONS_ERROR = 2,
94     FG_OPTIONS_EXIT = 3,
95     FG_OPTIONS_VERBOSE_HELP = 4,
96     FG_OPTIONS_SHOW_AIRCRAFT = 5,
97     FG_OPTIONS_SHOW_SOUND_DEVICES = 6,
98     FG_OPTIONS_NO_DEFAULT_CONFIG = 7
99 };
100
101 static flightgear::Options* shared_instance = NULL;
102
103 static double
104 atof( const string& str )
105 {
106     return ::atof( str.c_str() );
107 }
108
109 static int
110 atoi( const string& str )
111 {
112     return ::atoi( str.c_str() );
113 }
114
115 static int fgSetupProxy( const char *arg );
116
117 /**
118  * Set a few fail-safe default property values.
119  *
120  * These should all be set in $FG_ROOT/preferences.xml, but just
121  * in case, we provide some initial sane values here. This method
122  * should be invoked *before* reading any init files.
123  */
124 static void
125 fgSetDefaults ()
126 {
127
128                                 // Position (deliberately out of range)
129     fgSetDouble("/position/longitude-deg", 9999.0);
130     fgSetDouble("/position/latitude-deg", 9999.0);
131     fgSetDouble("/position/altitude-ft", -9999.0);
132
133                                 // Orientation
134     fgSetDouble("/orientation/heading-deg", 9999.0);
135     fgSetDouble("/orientation/roll-deg", 0.0);
136     fgSetDouble("/orientation/pitch-deg", 0.424);
137
138                                 // Velocities
139     fgSetDouble("/velocities/uBody-fps", 0.0);
140     fgSetDouble("/velocities/vBody-fps", 0.0);
141     fgSetDouble("/velocities/wBody-fps", 0.0);
142     fgSetDouble("/velocities/speed-north-fps", 0.0);
143     fgSetDouble("/velocities/speed-east-fps", 0.0);
144     fgSetDouble("/velocities/speed-down-fps", 0.0);
145     fgSetDouble("/velocities/airspeed-kt", 0.0);
146     fgSetDouble("/velocities/mach", 0.0);
147
148                                 // Presets
149     fgSetDouble("/sim/presets/longitude-deg", 9999.0);
150     fgSetDouble("/sim/presets/latitude-deg", 9999.0);
151     fgSetDouble("/sim/presets/altitude-ft", -9999.0);
152
153     fgSetDouble("/sim/presets/heading-deg", 9999.0);
154     fgSetDouble("/sim/presets/roll-deg", 0.0);
155     fgSetDouble("/sim/presets/pitch-deg", 0.424);
156
157     fgSetString("/sim/presets/speed-set", "knots");
158     fgSetDouble("/sim/presets/airspeed-kt", 0.0);
159     fgSetDouble("/sim/presets/mach", 0.0);
160     fgSetDouble("/sim/presets/uBody-fps", 0.0);
161     fgSetDouble("/sim/presets/vBody-fps", 0.0);
162     fgSetDouble("/sim/presets/wBody-fps", 0.0);
163     fgSetDouble("/sim/presets/speed-north-fps", 0.0);
164     fgSetDouble("/sim/presets/speed-east-fps", 0.0);
165     fgSetDouble("/sim/presets/speed-down-fps", 0.0);
166
167     fgSetBool("/sim/presets/onground", true);
168     fgSetBool("/sim/presets/trim", false);
169
170                                 // Miscellaneous
171     fgSetBool("/sim/startup/game-mode", false);
172     fgSetBool("/sim/startup/splash-screen", true);
173     fgSetBool("/sim/startup/intro-music", true);
174     // we want mouse-pointer to have an undefined value if nothing is
175     // specified so we can do the right thing for voodoo-1/2 cards.
176     // fgSetString("/sim/startup/mouse-pointer", "disabled");
177     fgSetString("/sim/control-mode", "joystick");
178     fgSetBool("/controls/flight/auto-coordination", false);
179     fgSetString("/sim/logging/priority", "alert");
180
181                                 // Features
182     fgSetBool("/sim/hud/color/antialiased", false);
183     fgSetBool("/sim/hud/enable3d[1]", true);
184     fgSetBool("/sim/hud/visibility[1]", false);
185     fgSetBool("/sim/panel/visibility", true);
186     fgSetBool("/sim/sound/enabled", true);
187     fgSetBool("/sim/sound/working", true);
188
189                                 // Flight Model options
190     fgSetString("/sim/flight-model", "jsb");
191     fgSetString("/sim/aero", "c172");
192     fgSetInt("/sim/model-hz", NEW_DEFAULT_MODEL_HZ);
193     fgSetDouble("/sim/speed-up", 1.0);
194
195                                 // Rendering options
196     fgSetString("/sim/rendering/fog", "nicest");
197     fgSetBool("/environment/clouds/status", true);
198     fgSetBool("/sim/startup/fullscreen", false);
199     fgSetBool("/sim/rendering/shading", true);
200     fgSetBool("/sim/rendering/skyblend", true);
201     fgSetBool("/sim/rendering/textures", true);
202     fgTie( "/sim/rendering/filtering", SGGetTextureFilter, SGSetTextureFilter, false);
203     fgSetInt("/sim/rendering/filtering", 1);
204     fgSetBool("/sim/rendering/wireframe", false);
205     fgSetBool("/sim/rendering/horizon-effect", false);
206     fgSetBool("/sim/rendering/enhanced-lighting", false);
207     fgSetBool("/sim/rendering/distance-attenuation", false);
208     fgSetBool("/sim/rendering/specular-highlight", true);
209     fgSetString("/sim/rendering/materials-file", "materials.xml");
210     fgSetInt("/sim/startup/xsize", 800);
211     fgSetInt("/sim/startup/ysize", 600);
212     fgSetInt("/sim/rendering/bits-per-pixel", 16);
213     fgSetString("/sim/view-mode", "pilot");
214     fgSetDouble("/sim/current-view/heading-offset-deg", 0);
215
216                                 // HUD options
217     fgSetString("/sim/startup/units", "feet");
218     fgSetString("/sim/hud/frame-stat-type", "tris");
219
220                                 // Time options
221     fgSetInt("/sim/startup/time-offset", 0);
222     fgSetString("/sim/startup/time-offset-type", "system-offset");
223     fgSetLong("/sim/time/cur-time-override", 0);
224
225                                 // Freeze options
226     fgSetBool("/sim/freeze/master", false);
227     fgSetBool("/sim/freeze/position", false);
228     fgSetBool("/sim/freeze/clock", false);
229     fgSetBool("/sim/freeze/fuel", false);
230
231     fgSetString("/sim/multiplay/callsign", "callsign");
232     fgSetString("/sim/multiplay/rxhost", "");
233     fgSetString("/sim/multiplay/txhost", "");
234     fgSetInt("/sim/multiplay/rxport", 0);
235     fgSetInt("/sim/multiplay/txport", 0);
236     
237     fgSetString("/sim/version/flightgear", FLIGHTGEAR_VERSION);
238     fgSetString("/sim/version/simgear", SG_STRINGIZE(SIMGEAR_VERSION));
239     fgSetString("/sim/version/openscenegraph", osgGetVersion());
240     fgSetString("/sim/version/revision", REVISION);
241     fgSetInt("/sim/version/build-number", HUDSON_BUILD_NUMBER);
242     fgSetString("/sim/version/build-id", HUDSON_BUILD_ID);
243   
244   char* envp = ::getenv( "http_proxy" );
245     if( envp != NULL )
246       fgSetupProxy( envp );
247 }
248
249 static bool
250 parse_wind (const string &wind, double * min_hdg, double * max_hdg,
251             double * speed, double * gust)
252 {
253   string::size_type pos = wind.find('@');
254   if (pos == string::npos)
255     return false;
256   string dir = wind.substr(0, pos);
257   string spd = wind.substr(pos+1);
258   pos = dir.find(':');
259   if (pos == string::npos) {
260     *min_hdg = *max_hdg = atof(dir.c_str());
261   } else {
262     *min_hdg = atof(dir.substr(0,pos).c_str());
263     *max_hdg = atof(dir.substr(pos+1).c_str());
264   }
265   pos = spd.find(':');
266   if (pos == string::npos) {
267     *speed = *gust = atof(spd.c_str());
268   } else {
269     *speed = atof(spd.substr(0,pos).c_str());
270     *gust = atof(spd.substr(pos+1).c_str());
271   }
272   return true;
273 }
274
275 static bool
276 parseIntValue(char** ppParserPos, int* pValue,int min, int max, const char* field, const char* argument)
277 {
278     if ( !strlen(*ppParserPos) )
279         return true;
280
281     char num[256];
282     int i = 0;
283
284     while ( isdigit((*ppParserPos)[0]) && (i<255) )
285     {
286         num[i] = (*ppParserPos)[0];
287         (*ppParserPos)++;
288         i++;
289     }
290     num[i] = '\0';
291
292     switch ((*ppParserPos)[0])
293     {
294         case 0:
295             break;
296         case ':':
297             (*ppParserPos)++;
298             break;
299         default:
300             SG_LOG(SG_GENERAL, SG_ALERT, "Illegal character in time string for " << field << ": '" <<
301                     (*ppParserPos)[0] << "'.");
302             // invalid field - skip rest of string to avoid further errors
303             while ((*ppParserPos)[0])
304                 (*ppParserPos)++;
305             return false;
306     }
307
308     if (i<=0)
309         return true;
310
311     int value = atoi(num);
312     if ((value < min)||(value > max))
313     {
314         SG_LOG(SG_GENERAL, SG_ALERT, "Invalid " << field << " in '" << argument <<
315                "'. Valid range is " << min << "-" << max << ".");
316         return false;
317     }
318     else
319     {
320         *pValue = value;
321         return true;
322     }
323 }
324
325 // parse a time string ([+/-]%f[:%f[:%f]]) into hours
326 static double
327 parse_time(const string& time_in) {
328     char *time_str, num[256];
329     double hours, minutes, seconds;
330     double result = 0.0;
331     int sign = 1;
332     int i;
333
334     time_str = (char *)time_in.c_str();
335
336     // printf("parse_time(): %s\n", time_str);
337
338     // check for sign
339     if ( strlen(time_str) ) {
340         if ( time_str[0] == '+' ) {
341             sign = 1;
342             time_str++;
343         } else if ( time_str[0] == '-' ) {
344             sign = -1;
345             time_str++;
346         }
347     }
348     // printf("sign = %d\n", sign);
349
350     // get hours
351     if ( strlen(time_str) ) {
352         i = 0;
353         while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
354             num[i] = time_str[0];
355             time_str++;
356             i++;
357         }
358         if ( time_str[0] == ':' ) {
359             time_str++;
360         }
361         num[i] = '\0';
362         hours = atof(num);
363         // printf("hours = %.2lf\n", hours);
364
365         result += hours;
366     }
367
368     // get minutes
369     if ( strlen(time_str) ) {
370         i = 0;
371         while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
372             num[i] = time_str[0];
373             time_str++;
374             i++;
375         }
376         if ( time_str[0] == ':' ) {
377             time_str++;
378         }
379         num[i] = '\0';
380         minutes = atof(num);
381         // printf("minutes = %.2lf\n", minutes);
382
383         result += minutes / 60.0;
384     }
385
386     // get seconds
387     if ( strlen(time_str) ) {
388         i = 0;
389         while ( (time_str[0] != ':') && (time_str[0] != '\0') ) {
390             num[i] = time_str[0];
391             time_str++;
392             i++;
393         }
394         num[i] = '\0';
395         seconds = atof(num);
396         // printf("seconds = %.2lf\n", seconds);
397
398         result += seconds / 3600.0;
399     }
400
401     SG_LOG( SG_GENERAL, SG_INFO, " parse_time() = " << sign * result );
402
403     return(sign * result);
404 }
405
406 // parse a date string (yyyy:mm:dd:hh:mm:ss) into a time_t (seconds)
407 static long int
408 parse_date( const string& date, const char* timeType)
409 {
410     struct tm gmt,*pCurrentTime;
411     int year,month,day,hour,minute,second;
412     char *argument, *date_str;
413
414     SGTime CurrentTime;
415     CurrentTime.update(SGGeod(),0,0);
416
417     // FIXME This should obtain system/aircraft/GMT time depending on timeType
418     pCurrentTime = CurrentTime.getGmt();
419
420     // initialize all fields with current time
421     year   = pCurrentTime->tm_year + 1900;
422     month  = pCurrentTime->tm_mon + 1;
423     day    = pCurrentTime->tm_mday;
424     hour   = pCurrentTime->tm_hour;
425     minute = pCurrentTime->tm_min;
426     second = pCurrentTime->tm_sec;
427
428     argument = (char *)date.c_str();
429     date_str = argument;
430
431     // start with parsing year
432     if (!strlen(date_str) ||
433         !parseIntValue(&date_str,&year,0,9999,"year",argument))
434     {
435         return -1;
436     }
437
438     if (year < 1970)
439     {
440         SG_LOG(SG_GENERAL, SG_ALERT, "Invalid year '" << year << "'. Use 1970 or later.");
441         return -1;
442     }
443
444     parseIntValue(&date_str, &month,  1, 12, "month",  argument);
445     parseIntValue(&date_str, &day,    1, 31, "day",    argument);
446     parseIntValue(&date_str, &hour,   0, 23, "hour",   argument);
447     parseIntValue(&date_str, &minute, 0, 59, "minute", argument);
448     parseIntValue(&date_str, &second, 0, 59, "second", argument);
449
450     gmt.tm_sec  = second;
451     gmt.tm_min  = minute;
452     gmt.tm_hour = hour;
453     gmt.tm_mday = day;
454     gmt.tm_mon  = month - 1;
455     gmt.tm_year = year -1900;
456     gmt.tm_isdst = 0; // ignore daylight savings time for the moment
457
458     time_t theTime = sgTimeGetGMT( gmt.tm_year, gmt.tm_mon, gmt.tm_mday,
459                                    gmt.tm_hour, gmt.tm_min, gmt.tm_sec );
460
461     SG_LOG(SG_GENERAL, SG_INFO, "Configuring startup time to " << ctime(&theTime));
462
463     return (theTime);
464 }
465
466
467 // parse angle in the form of [+/-]ddd:mm:ss into degrees
468 static double
469 parse_degree( const string& degree_str) {
470     double result = parse_time( degree_str );
471
472     // printf("Degree = %.4f\n", result);
473
474     return(result);
475 }
476
477
478 // parse time offset string into seconds
479 static long int
480 parse_time_offset( const string& time_str) {
481    long int result;
482
483     // printf("time offset = %s\n", time_str);
484
485 #ifdef HAVE_RINT
486     result = (int)rint(parse_time(time_str) * 3600.0);
487 #else
488     result = (int)(parse_time(time_str) * 3600.0);
489 #endif
490
491     // printf("parse_time_offset(): %d\n", result);
492
493     return( result );
494 }
495
496
497 // Parse --fov=x.xx type option
498 static double
499 parse_fov( const string& arg ) {
500     double fov = atof(arg);
501
502     if ( fov < FG_FOV_MIN ) { fov = FG_FOV_MIN; }
503     if ( fov > FG_FOV_MAX ) { fov = FG_FOV_MAX; }
504
505     fgSetDouble("/sim/view[0]/config/default-field-of-view-deg", fov);
506
507     // printf("parse_fov(): result = %.4f\n", fov);
508
509     return fov;
510 }
511
512
513 // Parse I/O channel option
514 //
515 // Format is "--protocol=medium,direction,hz,medium_options,..."
516 //
517 //   protocol = { native, nmea, garmin, AV400, AV400Sim, fgfs, rul, pve, etc. }
518 //   medium = { serial, socket, file, etc. }
519 //   direction = { in, out, bi }
520 //   hz = number of times to process channel per second (floating
521 //        point values are ok.
522 //
523 // Serial example "--nmea=serial,dir,hz,device,baud" where
524 //
525 //  device = OS device name of serial line to be open()'ed
526 //  baud = {300, 1200, 2400, ..., 230400}
527 //
528 // Socket exacmple "--native=socket,dir,hz,machine,port,style" where
529 //
530 //  machine = machine name or ip address if client (leave empty if server)
531 //  port = port, leave empty to let system choose
532 //  style = tcp or udp
533 //
534 // File example "--garmin=file,dir,hz,filename" where
535 //
536 //  filename = file system file name
537
538 static bool
539 add_channel( const string& type, const string& channel_str ) {
540     // This check is neccessary to prevent fgviewer from segfaulting when given
541     // weird options. (It doesn't run the full initailization)
542     if(!globals->get_channel_options_list())
543     {
544         SG_LOG(SG_GENERAL, SG_ALERT, "Option " << type << "=" << channel_str
545                                      << " ignored.");
546         return false;
547     }
548     SG_LOG(SG_GENERAL, SG_INFO, "Channel string = " << channel_str );
549     globals->get_channel_options_list()->push_back( type + "," + channel_str );
550     return true;
551 }
552
553 static void
554 clearLocation ()
555 {
556     fgSetString("/sim/presets/airport-id", "");
557     fgSetString("/sim/presets/vor-id", "");
558     fgSetString("/sim/presets/ndb-id", "");
559     fgSetString("/sim/presets/carrier", "");
560     fgSetString("/sim/presets/parkpos", "");
561     fgSetString("/sim/presets/fix", "");
562 }
563
564 static int
565 fgOptVOR( const char * arg )
566 {
567     clearLocation();
568     fgSetString("/sim/presets/vor-id", arg);
569     return FG_OPTIONS_OK;
570 }
571
572 static int
573 fgOptNDB( const char * arg )
574 {
575     clearLocation();
576     fgSetString("/sim/presets/ndb-id", arg);
577     return FG_OPTIONS_OK;
578 }
579
580 static int
581 fgOptCarrier( const char * arg )
582 {
583     clearLocation();
584     fgSetString("/sim/presets/carrier", arg);
585     return FG_OPTIONS_OK;
586 }
587
588 static int
589 fgOptParkpos( const char * arg )
590 {
591     fgSetString("/sim/presets/parkpos", arg);
592     return FG_OPTIONS_OK;
593 }
594
595 static int
596 fgOptFIX( const char * arg )
597 {
598     clearLocation();
599     fgSetString("/sim/presets/fix", arg);
600     return FG_OPTIONS_OK;
601 }
602
603 static int
604 fgOptLon( const char *arg )
605 {
606     clearLocation();
607     fgSetDouble("/sim/presets/longitude-deg", parse_degree( arg ));
608     fgSetDouble("/position/longitude-deg", parse_degree( arg ));
609     return FG_OPTIONS_OK;
610 }
611
612 static int
613 fgOptLat( const char *arg )
614 {
615     clearLocation();
616     fgSetDouble("/sim/presets/latitude-deg", parse_degree( arg ));
617     fgSetDouble("/position/latitude-deg", parse_degree( arg ));
618     return FG_OPTIONS_OK;
619 }
620
621 static int
622 fgOptAltitude( const char *arg )
623 {
624     fgSetBool("/sim/presets/onground", false);
625     if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
626         fgSetDouble("/sim/presets/altitude-ft", atof( arg ));
627     else
628         fgSetDouble("/sim/presets/altitude-ft",
629                     atof( arg ) * SG_METER_TO_FEET);
630     return FG_OPTIONS_OK;
631 }
632
633 static int
634 fgOptUBody( const char *arg )
635 {
636     fgSetString("/sim/presets/speed-set", "UVW");
637     if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
638         fgSetDouble("/sim/presets/uBody-fps", atof( arg ));
639     else
640         fgSetDouble("/sim/presets/uBody-fps",
641                     atof( arg ) * SG_METER_TO_FEET);
642     return FG_OPTIONS_OK;
643 }
644
645 static int
646 fgOptVBody( const char *arg )
647 {
648     fgSetString("/sim/presets/speed-set", "UVW");
649     if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
650         fgSetDouble("/sim/presets/vBody-fps", atof( arg ));
651     else
652         fgSetDouble("/sim/presets/vBody-fps",
653                             atof( arg ) * SG_METER_TO_FEET);
654     return FG_OPTIONS_OK;
655 }
656
657 static int
658 fgOptWBody( const char *arg )
659 {
660     fgSetString("/sim/presets/speed-set", "UVW");
661     if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
662         fgSetDouble("/sim/presets/wBody-fps", atof(arg));
663     else
664         fgSetDouble("/sim/presets/wBody-fps",
665                             atof(arg) * SG_METER_TO_FEET);
666     return FG_OPTIONS_OK;
667 }
668
669 static int
670 fgOptVNorth( const char *arg )
671 {
672     fgSetString("/sim/presets/speed-set", "NED");
673     if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
674         fgSetDouble("/sim/presets/speed-north-fps", atof( arg ));
675     else
676         fgSetDouble("/sim/presets/speed-north-fps",
677                             atof( arg ) * SG_METER_TO_FEET);
678     return FG_OPTIONS_OK;
679 }
680
681 static int
682 fgOptVEast( const char *arg )
683 {
684     fgSetString("/sim/presets/speed-set", "NED");
685     if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
686         fgSetDouble("/sim/presets/speed-east-fps", atof(arg));
687     else
688         fgSetDouble("/sim/presets/speed-east-fps",
689                     atof(arg) * SG_METER_TO_FEET);
690     return FG_OPTIONS_OK;
691 }
692
693 static int
694 fgOptVDown( const char *arg )
695 {
696     fgSetString("/sim/presets/speed-set", "NED");
697     if ( !strcmp(fgGetString("/sim/startup/units"), "feet") )
698         fgSetDouble("/sim/presets/speed-down-fps", atof(arg));
699     else
700         fgSetDouble("/sim/presets/speed-down-fps",
701                             atof(arg) * SG_METER_TO_FEET);
702     return FG_OPTIONS_OK;
703 }
704
705 static int
706 fgOptVc( const char *arg )
707 {
708     // fgSetString("/sim/presets/speed-set", "knots");
709     // fgSetDouble("/velocities/airspeed-kt", atof(arg.substr(5)));
710     fgSetString("/sim/presets/speed-set", "knots");
711     fgSetDouble("/sim/presets/airspeed-kt", atof(arg));
712     return FG_OPTIONS_OK;
713 }
714
715 static int
716 fgOptMach( const char *arg )
717 {
718     fgSetString("/sim/presets/speed-set", "mach");
719     fgSetDouble("/sim/presets/mach", atof(arg));
720     return FG_OPTIONS_OK;
721 }
722
723 static int
724 fgOptRoc( const char *arg )
725 {
726     fgSetDouble("/sim/presets/vertical-speed-fps", atof(arg)/60);
727     return FG_OPTIONS_OK;
728 }
729
730 static int
731 fgOptFgScenery( const char *arg )
732 {
733     globals->append_fg_scenery(arg);
734     return FG_OPTIONS_OK;
735 }
736
737 static int
738 fgOptFov( const char *arg )
739 {
740     parse_fov( arg );
741     return FG_OPTIONS_OK;
742 }
743
744 static int
745 fgOptGeometry( const char *arg )
746 {
747     bool geometry_ok = true;
748     int xsize = 0, ysize = 0;
749     string geometry = arg;
750     string::size_type i = geometry.find('x');
751
752     if (i != string::npos) {
753         xsize = atoi(geometry.substr(0, i));
754         ysize = atoi(geometry.substr(i+1));
755     } else {
756         geometry_ok = false;
757     }
758
759     if ( xsize <= 0 || ysize <= 0 ) {
760         xsize = 640;
761         ysize = 480;
762         geometry_ok = false;
763     }
764
765     if ( !geometry_ok ) {
766         SG_LOG( SG_GENERAL, SG_ALERT, "Unknown geometry: " << geometry );
767         SG_LOG( SG_GENERAL, SG_ALERT,
768                 "Setting geometry to " << xsize << 'x' << ysize << '\n');
769     } else {
770         SG_LOG( SG_GENERAL, SG_INFO,
771                 "Setting geometry to " << xsize << 'x' << ysize << '\n');
772         fgSetInt("/sim/startup/xsize", xsize);
773         fgSetInt("/sim/startup/ysize", ysize);
774     }
775     return FG_OPTIONS_OK;
776 }
777
778 static int
779 fgOptBpp( const char *arg )
780 {
781     string bits_per_pix = arg;
782     if ( bits_per_pix == "16" ) {
783         fgSetInt("/sim/rendering/bits-per-pixel", 16);
784     } else if ( bits_per_pix == "24" ) {
785         fgSetInt("/sim/rendering/bits-per-pixel", 24);
786     } else if ( bits_per_pix == "32" ) {
787         fgSetInt("/sim/rendering/bits-per-pixel", 32);
788     } else {
789         SG_LOG(SG_GENERAL, SG_ALERT, "Unsupported bpp " << bits_per_pix);
790     }
791     return FG_OPTIONS_OK;
792 }
793
794 static int
795 fgOptTimeOffset( const char *arg )
796 {
797     fgSetLong("/sim/startup/time-offset",
798                 parse_time_offset( arg ));
799     fgSetString("/sim/startup/time-offset-type", "system-offset");
800     return FG_OPTIONS_OK;
801 }
802
803 static int
804 fgOptStartDateSys( const char *arg )
805 {
806     long int theTime = parse_date( arg, "system" );
807     if (theTime>=0)
808     {
809         fgSetLong("/sim/startup/time-offset",  theTime);
810         fgSetString("/sim/startup/time-offset-type", "system");
811     }
812     return FG_OPTIONS_OK;
813 }
814
815 static int
816 fgOptStartDateLat( const char *arg )
817 {
818     long int theTime = parse_date( arg, "latitude" );
819     if (theTime>=0)
820     {
821         fgSetLong("/sim/startup/time-offset", theTime);
822         fgSetString("/sim/startup/time-offset-type", "latitude");
823     }
824     return FG_OPTIONS_OK;
825 }
826
827 static int
828 fgOptStartDateGmt( const char *arg )
829 {
830     long int theTime = parse_date( arg, "gmt" );
831     if (theTime>=0)
832     {
833         fgSetLong("/sim/startup/time-offset", theTime);
834         fgSetString("/sim/startup/time-offset-type", "gmt");
835     }
836     return FG_OPTIONS_OK;
837 }
838
839 static int
840 fgSetupProxy( const char *arg )
841 {
842     string options = simgear::strutils::strip( arg );
843     string host, port, auth;
844     string::size_type pos;
845
846     // this is NURLP - NURLP is not an url parser
847     if( simgear::strutils::starts_with( options, "http://" ) )
848         options = options.substr( 7 );
849     if( simgear::strutils::ends_with( options, "/" ) )
850         options = options.substr( 0, options.length() - 1 );
851
852     host = port = auth = "";
853     if ((pos = options.find("@")) != string::npos)
854         auth = options.substr(0, pos++);
855     else
856         pos = 0;
857
858     host = options.substr(pos, options.size());
859     if ((pos = host.find(":")) != string::npos) {
860         port = host.substr(++pos, host.size());
861         host.erase(--pos, host.size());
862     }
863
864     fgSetString("/sim/presets/proxy/host", host.c_str());
865     fgSetString("/sim/presets/proxy/port", port.c_str());
866     fgSetString("/sim/presets/proxy/authentication", auth.c_str());
867
868     return FG_OPTIONS_OK;
869 }
870
871 static int
872 fgOptTraceRead( const char *arg )
873 {
874     string name = arg;
875     SG_LOG(SG_GENERAL, SG_INFO, "Tracing reads for property " << name);
876     fgGetNode(name.c_str(), true)
877         ->setAttribute(SGPropertyNode::TRACE_READ, true);
878     return FG_OPTIONS_OK;
879 }
880
881 static int
882 fgOptLogLevel( const char *arg )
883 {
884     fgSetString("/sim/logging/priority", arg);
885     setLoggingPriority(arg);
886
887     return FG_OPTIONS_OK;
888 }
889
890 static int
891 fgOptLogClasses( const char *arg )
892 {
893     fgSetString("/sim/logging/classes", arg);
894     setLoggingClasses (arg);
895
896     return FG_OPTIONS_OK;
897 }
898
899 static int
900 fgOptTraceWrite( const char *arg )
901 {
902     string name = arg;
903     SG_LOG(SG_GENERAL, SG_INFO, "Tracing writes for property " << name);
904     fgGetNode(name.c_str(), true)
905         ->setAttribute(SGPropertyNode::TRACE_WRITE, true);
906     return FG_OPTIONS_OK;
907 }
908
909 static int
910 fgOptViewOffset( const char *arg )
911 {
912     // $$$ begin - added VS Renganathan, 14 Oct 2K
913     // for multi-window outside window imagery
914     string woffset = arg;
915     double default_view_offset = 0.0;
916     if ( woffset == "LEFT" ) {
917             default_view_offset = SGD_PI * 0.25;
918     } else if ( woffset == "RIGHT" ) {
919         default_view_offset = SGD_PI * 1.75;
920     } else if ( woffset == "CENTER" ) {
921         default_view_offset = 0.00;
922     } else {
923         default_view_offset = atof( woffset.c_str() ) * SGD_DEGREES_TO_RADIANS;
924     }
925     /* apparently not used (CLO, 11 Jun 2002)
926         FGViewer *pilot_view =
927             (FGViewer *)globals->get_viewmgr()->get_view( 0 ); */
928     // this will work without calls to the viewer...
929     fgSetDouble( "/sim/current-view/heading-offset-deg",
930                     default_view_offset  * SGD_RADIANS_TO_DEGREES );
931     // $$$ end - added VS Renganathan, 14 Oct 2K
932     return FG_OPTIONS_OK;
933 }
934
935 static int
936 fgOptVisibilityMeters( const char *arg )
937 {
938     Environment::Presets::VisibilitySingleton::instance()->preset( atof( arg ) );
939     return FG_OPTIONS_OK;
940 }
941
942 static int
943 fgOptVisibilityMiles( const char *arg )
944 {
945     Environment::Presets::VisibilitySingleton::instance()->preset( atof( arg ) * 5280.0 * SG_FEET_TO_METER );
946     return FG_OPTIONS_OK;
947 }
948
949 static int
950 fgOptRandomWind( const char *arg )
951 {
952     double min_hdg = sg_random() * 360.0;
953     double max_hdg = min_hdg + (20 - sqrt(sg_random() * 400));
954     double speed = sg_random() * sg_random() * 40;
955     double gust = speed + (10 - sqrt(sg_random() * 100));
956     Environment::Presets::WindSingleton::instance()->preset(min_hdg, max_hdg, speed, gust);
957     return FG_OPTIONS_OK;
958 }
959
960 static int
961 fgOptWind( const char *arg )
962 {
963     double min_hdg = 0.0, max_hdg = 0.0, speed = 0.0, gust = 0.0;
964     if (!parse_wind( arg, &min_hdg, &max_hdg, &speed, &gust)) {
965         SG_LOG( SG_GENERAL, SG_ALERT, "bad wind value " << arg );
966         return FG_OPTIONS_ERROR;
967     }
968     Environment::Presets::WindSingleton::instance()->preset(min_hdg, max_hdg, speed, gust);
969     return FG_OPTIONS_OK;
970 }
971
972 static int
973 fgOptTurbulence( const char *arg )
974 {
975     Environment::Presets::TurbulenceSingleton::instance()->preset( atof(arg) );
976     return FG_OPTIONS_OK;
977 }
978
979 static int
980 fgOptCeiling( const char *arg )
981 {
982     double elevation, thickness;
983     string spec = arg;
984     string::size_type pos = spec.find(':');
985     if (pos == string::npos) {
986         elevation = atof(spec.c_str());
987         thickness = 2000;
988     } else {
989         elevation = atof(spec.substr(0, pos).c_str());
990         thickness = atof(spec.substr(pos + 1).c_str());
991     }
992     Environment::Presets::CeilingSingleton::instance()->preset( elevation, thickness );
993     return FG_OPTIONS_OK;
994 }
995
996 static int
997 fgOptWp( const char *arg )
998 {
999     string_list *waypoints = globals->get_initial_waypoints();
1000     if (!waypoints) {
1001         waypoints = new string_list;
1002         globals->set_initial_waypoints(waypoints);
1003     }
1004     waypoints->push_back(arg);
1005     return FG_OPTIONS_OK;
1006 }
1007
1008 static int
1009 fgOptConfig( const char *arg )
1010 {
1011     string file = arg;
1012     try {
1013         readProperties(file, globals->get_props());
1014     } catch (const sg_exception &e) {
1015         string message = "Error loading config file: ";
1016         message += e.getFormattedMessage() + e.getOrigin();
1017         SG_LOG(SG_INPUT, SG_ALERT, message);
1018         exit(2);
1019     }
1020     return FG_OPTIONS_OK;
1021 }
1022
1023 static bool
1024 parse_colon (const string &s, double * val1, double * val2)
1025 {
1026     string::size_type pos = s.find(':');
1027     if (pos == string::npos) {
1028         *val2 = atof(s);
1029         return false;
1030     } else {
1031         *val1 = atof(s.substr(0, pos).c_str());
1032         *val2 = atof(s.substr(pos+1).c_str());
1033         return true;
1034     }
1035 }
1036
1037
1038 static int
1039 fgOptFailure( const char * arg )
1040 {
1041     string a = arg;
1042     if (a == "pitot") {
1043         fgSetBool("/systems/pitot/serviceable", false);
1044     } else if (a == "static") {
1045         fgSetBool("/systems/static/serviceable", false);
1046     } else if (a == "vacuum") {
1047         fgSetBool("/systems/vacuum/serviceable", false);
1048     } else if (a == "electrical") {
1049         fgSetBool("/systems/electrical/serviceable", false);
1050     } else {
1051         SG_LOG(SG_INPUT, SG_ALERT, "Unknown failure mode: " << a);
1052         return FG_OPTIONS_ERROR;
1053     }
1054
1055     return FG_OPTIONS_OK;
1056 }
1057
1058
1059 static int
1060 fgOptNAV1( const char * arg )
1061 {
1062     double radial, freq;
1063     if (parse_colon(arg, &radial, &freq))
1064         fgSetDouble("/instrumentation/nav[0]/radials/selected-deg", radial);
1065     fgSetDouble("/instrumentation/nav[0]/frequencies/selected-mhz", freq);
1066     return FG_OPTIONS_OK;
1067 }
1068
1069 static int
1070 fgOptNAV2( const char * arg )
1071 {
1072     double radial, freq;
1073     if (parse_colon(arg, &radial, &freq))
1074         fgSetDouble("/instrumentation/nav[1]/radials/selected-deg", radial);
1075     fgSetDouble("/instrumentation/nav[1]/frequencies/selected-mhz", freq);
1076     return FG_OPTIONS_OK;
1077 }
1078
1079 static int
1080 fgOptADF1( const char * arg )
1081 {
1082     double rot, freq;
1083     if (parse_colon(arg, &rot, &freq))
1084         fgSetDouble("/instrumentation/adf[0]/rotation-deg", rot);
1085     fgSetDouble("/instrumentation/adf[0]/frequencies/selected-khz", freq);
1086     return FG_OPTIONS_OK;
1087 }
1088
1089 static int
1090 fgOptADF2( const char * arg )
1091 {
1092     double rot, freq;
1093     if (parse_colon(arg, &rot, &freq))
1094         fgSetDouble("/instrumentation/adf[1]/rotation-deg", rot);
1095     fgSetDouble("/instrumentation/adf[1]/frequencies/selected-khz", freq);
1096     return FG_OPTIONS_OK;
1097 }
1098
1099 static int
1100 fgOptDME( const char *arg )
1101 {
1102     string opt = arg;
1103     if (opt == "nav1") {
1104         fgSetInt("/instrumentation/dme/switch-position", 1);
1105         fgSetString("/instrumentation/dme/frequencies/source",
1106                     "/instrumentation/nav[0]/frequencies/selected-mhz");
1107     } else if (opt == "nav2") {
1108         fgSetInt("/instrumentation/dme/switch-position", 3);
1109         fgSetString("/instrumentation/dme/frequencies/source",
1110                     "/instrumentation/nav[1]/frequencies/selected-mhz");
1111     } else {
1112         double frequency = atof(arg);
1113         if (frequency==0.0)
1114         {
1115             SG_LOG(SG_INPUT, SG_ALERT, "Invalid DME frequency: '" << arg << "'.");
1116             return FG_OPTIONS_ERROR;
1117         }
1118         fgSetInt("/instrumentation/dme/switch-position", 2);
1119         fgSetString("/instrumentation/dme/frequencies/source",
1120                     "/instrumentation/dme/frequencies/selected-mhz");
1121         fgSetDouble("/instrumentation/dme/frequencies/selected-mhz", frequency);
1122     }
1123     return FG_OPTIONS_OK;
1124 }
1125
1126 static int
1127 fgOptLivery( const char *arg )
1128 {
1129     string opt = arg;
1130     string livery_path = "livery/" + opt;
1131     fgSetString("/sim/model/texture-path", livery_path.c_str() );
1132     return FG_OPTIONS_OK;
1133 }
1134
1135 static int
1136 fgOptScenario( const char *arg )
1137 {
1138     SGPropertyNode_ptr ai_node = fgGetNode( "/sim/ai", true );
1139     vector<SGPropertyNode_ptr> scenarii = ai_node->getChildren( "scenario" );
1140     int index = -1;
1141     for ( size_t i = 0; i < scenarii.size(); ++i ) {
1142         int ind = scenarii[i]->getIndex();
1143         if ( index < ind ) {
1144             index = ind;
1145         }
1146     }
1147     SGPropertyNode_ptr scenario = ai_node->getNode( "scenario", index + 1, true );
1148     scenario->setStringValue( arg );
1149     return FG_OPTIONS_OK;
1150 }
1151
1152 static int
1153 fgOptRunway( const char *arg )
1154 {
1155     fgSetString("/sim/presets/runway", arg );
1156     fgSetBool("/sim/presets/runway-requested", true );
1157     return FG_OPTIONS_OK;
1158 }
1159
1160 static int
1161 fgOptParking( const char *arg )
1162 {
1163     cerr << "Processing argument " << arg << endl;
1164     fgSetString("/sim/presets/parking", arg );
1165     fgSetBool  ("/sim/presets/parking-requested", true );
1166     return FG_OPTIONS_OK;
1167 }
1168
1169 static int
1170 fgOptVersion( const char *arg )
1171 {
1172     cerr << "FlightGear version: " << FLIGHTGEAR_VERSION << endl;
1173     cerr << "Revision: " << REVISION << endl;
1174     cerr << "Build-Id: " << HUDSON_BUILD_ID << endl;
1175     cerr << "FG_ROOT=" << globals->get_fg_root() << endl;
1176     cerr << "FG_HOME=" << globals->get_fg_home() << endl;
1177     cerr << "FG_SCENERY=";
1178
1179     int didsome = 0;
1180     string_list scn = globals->get_fg_scenery();
1181     for (string_list::const_iterator it = scn.begin(); it != scn.end(); it++)
1182     {
1183         if (didsome) cerr << ":";
1184         didsome++;
1185         cerr << *it;
1186     }
1187     cerr << endl;
1188     cerr << "SimGear version: " << SG_STRINGIZE(SIMGEAR_VERSION) << endl;
1189     cerr << "PLIB version: " << PLIB_VERSION << endl;
1190     return FG_OPTIONS_EXIT;
1191 }
1192
1193 static int
1194 fgOptCallSign(const char * arg)
1195 {
1196     int i;
1197     char callsign[11];
1198     strncpy(callsign,arg,10);
1199     callsign[10]=0;
1200     for (i=0;callsign[i];i++)
1201     {
1202         char c = callsign[i];
1203         if (c >= 'A' && c <= 'Z') continue;
1204         if (c >= 'a' && c <= 'z') continue;
1205         if (c >= '0' && c <= '9') continue;
1206         if (c == '-' || c == '_') continue;
1207         // convert any other illegal characters
1208         callsign[i]='-';
1209     }
1210     fgSetString("sim/multiplay/callsign", callsign );
1211     return FG_OPTIONS_OK;
1212 }
1213
1214
1215 // Set a property for the --prop: option. Syntax: --prop:[<type>:]<name>=<value>
1216 // <type> can be "double" etc. but also only the first letter "d".
1217 // Examples:  --prop:alpha=1  --prop:bool:beta=true  --prop:d:gamma=0.123
1218 static int
1219 fgOptSetProperty(const char* raw)
1220 {
1221   string arg(raw);
1222   string::size_type pos = arg.find('=');
1223   if (pos == arg.npos || pos == 0 || pos + 1 == arg.size())
1224     return FG_OPTIONS_ERROR;
1225   
1226   string name = arg.substr(0, pos);
1227   string value = arg.substr(pos + 1);
1228   string type;
1229   pos = name.find(':');
1230   
1231   if (pos != name.npos && pos != 0 && pos + 1 != name.size()) {
1232     type = name.substr(0, pos);
1233     name = name.substr(pos + 1);
1234   }
1235   SGPropertyNode *n = fgGetNode(name.c_str(), true);
1236   
1237   bool writable = n->getAttribute(SGPropertyNode::WRITE);
1238   if (!writable)
1239     n->setAttribute(SGPropertyNode::WRITE, true);
1240   
1241   bool ret = false;
1242   if (type.empty())
1243     ret = n->setUnspecifiedValue(value.c_str());
1244   else if (type == "s" || type == "string")
1245     ret = n->setStringValue(value.c_str());
1246   else if (type == "d" || type == "double")
1247     ret = n->setDoubleValue(strtod(value.c_str(), 0));
1248   else if (type == "f" || type == "float")
1249     ret = n->setFloatValue(atof(value.c_str()));
1250   else if (type == "l" || type == "long")
1251     ret =  n->setLongValue(strtol(value.c_str(), 0, 0));
1252   else if (type == "i" || type == "int")
1253     ret =  n->setIntValue(atoi(value.c_str()));
1254   else if (type == "b" || type == "bool")
1255     ret =  n->setBoolValue(value == "true" || atoi(value.c_str()) != 0);
1256   
1257   if (!writable)
1258     n->setAttribute(SGPropertyNode::WRITE, false);
1259   return ret ? FG_OPTIONS_OK : FG_OPTIONS_ERROR;
1260 }
1261
1262
1263
1264 /*
1265    option       has_param type        property         b_param s_param  func
1266
1267 where:
1268  option    : name of the option
1269  has_param : option is --name=value if true or --name if false
1270  type      : OPTION_BOOL    - property is a boolean
1271              OPTION_STRING  - property is a string
1272              OPTION_DOUBLE  - property is a double
1273              OPTION_INT     - property is an integer
1274              OPTION_CHANNEL - name of option is the name of a channel
1275              OPTION_FUNC    - the option trigger a function
1276  b_param   : if type==OPTION_BOOL,
1277              value set to the property (has_param is false for boolean)
1278  s_param   : if type==OPTION_STRING,
1279              value set to the property if has_param is false
1280  func      : function called if type==OPTION_FUNC. if has_param is true,
1281              the value is passed to the function as a string, otherwise,
1282              s_param is passed.
1283
1284     For OPTION_DOUBLE and OPTION_INT, the parameter value is converted into a
1285     double or an integer and set to the property.
1286
1287     For OPTION_CHANNEL, add_channel is called with the parameter value as the
1288     argument.
1289 */
1290
1291 enum OptionType { OPTION_BOOL = 0, OPTION_STRING, OPTION_DOUBLE, OPTION_INT, OPTION_CHANNEL, OPTION_FUNC, OPTION_IGNORE };
1292 const int OPTION_MULTI = 1 << 17;
1293
1294 struct OptionDesc {
1295     const char *option;
1296     bool has_param;
1297     int type;
1298     const char *property;
1299     bool b_param;
1300     const char *s_param;
1301     int (*func)( const char * );
1302     } fgOptionArray[] = {
1303
1304     {"language",                     true,  OPTION_IGNORE, "", false, "", 0 },
1305     {"disable-rembrandt",            false, OPTION_BOOL,   "/sim/rendering/rembrandt/enabled", false, "", 0 },
1306     {"enable-rembrandt",             false, OPTION_BOOL,   "/sim/rendering/rembrandt/enabled", true, "", 0 },
1307     {"renderer",                     true,  OPTION_STRING, "/sim/rendering/rembrandt/renderer", false, "", 0 },
1308     {"disable-game-mode",            false, OPTION_BOOL,   "/sim/startup/game-mode", false, "", 0 },
1309     {"enable-game-mode",             false, OPTION_BOOL,   "/sim/startup/game-mode", true, "", 0 },
1310     {"disable-splash-screen",        false, OPTION_BOOL,   "/sim/startup/splash-screen", false, "", 0 },
1311     {"enable-splash-screen",         false, OPTION_BOOL,   "/sim/startup/splash-screen", true, "", 0 },
1312     {"disable-intro-music",          false, OPTION_BOOL,   "/sim/startup/intro-music", false, "", 0 },
1313     {"enable-intro-music",           false, OPTION_BOOL,   "/sim/startup/intro-music", true, "", 0 },
1314     {"disable-mouse-pointer",        false, OPTION_STRING, "/sim/startup/mouse-pointer", false, "disabled", 0 },
1315     {"enable-mouse-pointer",         false, OPTION_STRING, "/sim/startup/mouse-pointer", false, "enabled", 0 },
1316     {"disable-random-objects",       false, OPTION_BOOL,   "/sim/rendering/random-objects", false, "", 0 },
1317     {"enable-random-objects",        false, OPTION_BOOL,   "/sim/rendering/random-objects", true, "", 0 },
1318     {"disable-random-vegetation",    false, OPTION_BOOL,   "/sim/rendering/random-vegetation", false, "", 0 },
1319     {"enable-random-vegetation",     false, OPTION_BOOL,   "/sim/rendering/random-vegetation", true, "", 0 },
1320     {"disable-random-buildings",     false, OPTION_BOOL,   "/sim/rendering/random-buildings", false, "", 0 },
1321     {"enable-random-buildings",      false, OPTION_BOOL,   "/sim/rendering/random-buildings", true, "", 0 },
1322     {"disable-real-weather-fetch",   false, OPTION_BOOL,   "/environment/realwx/enabled", false, "", 0 },
1323     {"enable-real-weather-fetch",    false, OPTION_BOOL,   "/environment/realwx/enabled", true,  "", 0 },
1324     {"metar",                        true,  OPTION_STRING, "/environment/metar/data", false, "", 0 },
1325     {"disable-ai-models",            false, OPTION_BOOL,   "/sim/ai/enabled", false, "", 0 },
1326     {"enable-ai-models",             false, OPTION_BOOL,   "/sim/ai/enabled", true, "", 0 },
1327     {"disable-ai-traffic",           false, OPTION_BOOL,   "/sim/traffic-manager/enabled", false, "", 0 },
1328     {"enable-ai-traffic",            false, OPTION_BOOL,   "/sim/traffic-manager/enabled", true,  "", 0 },
1329     {"disable-freeze",               false, OPTION_BOOL,   "/sim/freeze/master", false, "", 0 },
1330     {"enable-freeze",                false, OPTION_BOOL,   "/sim/freeze/master", true, "", 0 },
1331     {"disable-fuel-freeze",          false, OPTION_BOOL,   "/sim/freeze/fuel", false, "", 0 },
1332     {"enable-fuel-freeze",           false, OPTION_BOOL,   "/sim/freeze/fuel", true, "", 0 },
1333     {"disable-clock-freeze",         false, OPTION_BOOL,   "/sim/freeze/clock", false, "", 0 },
1334     {"enable-clock-freeze",          false, OPTION_BOOL,   "/sim/freeze/clock", true, "", 0 },
1335     {"disable-hud-3d",               false, OPTION_BOOL,   "/sim/hud/enable3d[1]", false, "", 0 },
1336     {"enable-hud-3d",                false, OPTION_BOOL,   "/sim/hud/enable3d[1]", true, "", 0 },
1337     {"disable-anti-alias-hud",       false, OPTION_BOOL,   "/sim/hud/color/antialiased", false, "", 0 },
1338     {"enable-anti-alias-hud",        false, OPTION_BOOL,   "/sim/hud/color/antialiased", true, "", 0 },
1339     {"control",                      true,  OPTION_STRING, "/sim/control-mode", false, "", 0 },
1340     {"disable-auto-coordination",    false, OPTION_BOOL,   "/controls/flight/auto-coordination", false, "", 0 },
1341     {"enable-auto-coordination",     false, OPTION_BOOL,   "/controls/flight/auto-coordination", true, "", 0 },
1342     {"browser-app",                  true,  OPTION_STRING, "/sim/startup/browser-app", false, "", 0 },
1343     {"disable-hud",                  false, OPTION_BOOL,   "/sim/hud/visibility[1]", false, "", 0 },
1344     {"enable-hud",                   false, OPTION_BOOL,   "/sim/hud/visibility[1]", true, "", 0 },
1345     {"disable-panel",                false, OPTION_BOOL,   "/sim/panel/visibility", false, "", 0 },
1346     {"enable-panel",                 false, OPTION_BOOL,   "/sim/panel/visibility", true, "", 0 },
1347     {"disable-sound",                false, OPTION_BOOL,   "/sim/sound/working", false, "", 0 },
1348     {"enable-sound",                 false, OPTION_BOOL,   "/sim/sound/working", true, "", 0 },
1349     {"sound-device",                 true,  OPTION_STRING, "/sim/sound/device-name", false, "", 0 },
1350     {"airport",                      true,  OPTION_STRING, "/sim/presets/airport-id", false, "", 0 },
1351     {"runway",                       true,  OPTION_FUNC,   "", false, "", fgOptRunway },
1352     {"vor",                          true,  OPTION_FUNC,   "", false, "", fgOptVOR },
1353     {"vor-frequency",                true,  OPTION_DOUBLE, "/sim/presets/vor-freq", false, "", fgOptVOR },
1354     {"ndb",                          true,  OPTION_FUNC,   "", false, "", fgOptNDB },
1355     {"ndb-frequency",                true,  OPTION_DOUBLE, "/sim/presets/ndb-freq", false, "", fgOptVOR },
1356     {"carrier",                      true,  OPTION_FUNC,   "", false, "", fgOptCarrier },
1357     {"parkpos",                      true,  OPTION_FUNC,   "", false, "", fgOptParkpos },
1358     {"fix",                          true,  OPTION_FUNC,   "", false, "", fgOptFIX },
1359     {"offset-distance",              true,  OPTION_DOUBLE, "/sim/presets/offset-distance-nm", false, "", 0 },
1360     {"offset-azimuth",               true,  OPTION_DOUBLE, "/sim/presets/offset-azimuth-deg", false, "", 0 },
1361     {"lon",                          true,  OPTION_FUNC,   "", false, "", fgOptLon },
1362     {"lat",                          true,  OPTION_FUNC,   "", false, "", fgOptLat },
1363     {"altitude",                     true,  OPTION_FUNC,   "", false, "", fgOptAltitude },
1364     {"uBody",                        true,  OPTION_FUNC,   "", false, "", fgOptUBody },
1365     {"vBody",                        true,  OPTION_FUNC,   "", false, "", fgOptVBody },
1366     {"wBody",                        true,  OPTION_FUNC,   "", false, "", fgOptWBody },
1367     {"vNorth",                       true,  OPTION_FUNC,   "", false, "", fgOptVNorth },
1368     {"vEast",                        true,  OPTION_FUNC,   "", false, "", fgOptVEast },
1369     {"vDown",                        true,  OPTION_FUNC,   "", false, "", fgOptVDown },
1370     {"vc",                           true,  OPTION_FUNC,   "", false, "", fgOptVc },
1371     {"mach",                         true,  OPTION_FUNC,   "", false, "", fgOptMach },
1372     {"heading",                      true,  OPTION_DOUBLE, "/sim/presets/heading-deg", false, "", 0 },
1373     {"roll",                         true,  OPTION_DOUBLE, "/sim/presets/roll-deg", false, "", 0 },
1374     {"pitch",                        true,  OPTION_DOUBLE, "/sim/presets/pitch-deg", false, "", 0 },
1375     {"glideslope",                   true,  OPTION_DOUBLE, "/sim/presets/glideslope-deg", false, "", 0 },
1376     {"roc",                          true,  OPTION_FUNC,   "", false, "", fgOptRoc },
1377     {"fg-root",                      true,  OPTION_IGNORE,   "", false, "", 0 },
1378     {"fg-scenery",                   true,  OPTION_FUNC | OPTION_MULTI,   "", false, "", fgOptFgScenery },
1379     {"fg-aircraft",                  true,  OPTION_IGNORE | OPTION_MULTI,   "", false, "", 0 },
1380     {"fdm",                          true,  OPTION_STRING, "/sim/flight-model", false, "", 0 },
1381     {"aero",                         true,  OPTION_STRING, "/sim/aero", false, "", 0 },
1382     {"aircraft-dir",                 true,  OPTION_IGNORE,   "", false, "", 0 },
1383     {"model-hz",                     true,  OPTION_INT,    "/sim/model-hz", false, "", 0 },
1384     {"max-fps",                      true,  OPTION_DOUBLE, "/sim/frame-rate-throttle-hz", false, "", 0 },
1385     {"speed",                        true,  OPTION_DOUBLE, "/sim/speed-up", false, "", 0 },
1386     {"trim",                         false, OPTION_BOOL,   "/sim/presets/trim", true, "", 0 },
1387     {"notrim",                       false, OPTION_BOOL,   "/sim/presets/trim", false, "", 0 },
1388     {"on-ground",                    false, OPTION_BOOL,   "/sim/presets/onground", true, "", 0 },
1389     {"in-air",                       false, OPTION_BOOL,   "/sim/presets/onground", false, "", 0 },
1390     {"fog-disable",                  false, OPTION_STRING, "/sim/rendering/fog", false, "disabled", 0 },
1391     {"fog-fastest",                  false, OPTION_STRING, "/sim/rendering/fog", false, "fastest", 0 },
1392     {"fog-nicest",                   false, OPTION_STRING, "/sim/rendering/fog", false, "nicest", 0 },
1393     {"disable-horizon-effect",       false, OPTION_BOOL,   "/sim/rendering/horizon-effect", false, "", 0 },
1394     {"enable-horizon-effect",        false, OPTION_BOOL,   "/sim/rendering/horizon-effect", true, "", 0 },
1395     {"disable-enhanced-lighting",    false, OPTION_BOOL,   "/sim/rendering/enhanced-lighting", false, "", 0 },
1396     {"enable-enhanced-lighting",     false, OPTION_BOOL,   "/sim/rendering/enhanced-lighting", true, "", 0 },
1397     {"disable-distance-attenuation", false, OPTION_BOOL,   "/sim/rendering/distance-attenuation", false, "", 0 },
1398     {"enable-distance-attenuation",  false, OPTION_BOOL,   "/sim/rendering/distance-attenuation", true, "", 0 },
1399     {"disable-specular-highlight",   false, OPTION_BOOL,   "/sim/rendering/specular-highlight", false, "", 0 },
1400     {"enable-specular-highlight",    false, OPTION_BOOL,   "/sim/rendering/specular-highlight", true, "", 0 },
1401     {"disable-clouds",               false, OPTION_BOOL,   "/environment/clouds/status", false, "", 0 },
1402     {"enable-clouds",                false, OPTION_BOOL,   "/environment/clouds/status", true, "", 0 },
1403     {"disable-clouds3d",             false, OPTION_BOOL,   "/sim/rendering/clouds3d-enable", false, "", 0 },
1404     {"enable-clouds3d",              false, OPTION_BOOL,   "/sim/rendering/clouds3d-enable", true, "", 0 },
1405     {"fov",                          true,  OPTION_FUNC,   "", false, "", fgOptFov },
1406     {"aspect-ratio-multiplier",      true,  OPTION_DOUBLE, "/sim/current-view/aspect-ratio-multiplier", false, "", 0 },
1407     {"disable-fullscreen",           false, OPTION_BOOL,   "/sim/startup/fullscreen", false, "", 0 },
1408     {"enable-fullscreen",            false, OPTION_BOOL,   "/sim/startup/fullscreen", true, "", 0 },
1409     {"disable-save-on-exit",         false, OPTION_BOOL,   "/sim/startup/save-on-exit", false, "", 0 },
1410     {"enable-save-on-exit",          false, OPTION_BOOL,   "/sim/startup/save-on-exit", true, "", 0 },
1411     {"restore-defaults",             false, OPTION_BOOL,   "/sim/startup/restore-defaults", true, "", 0 },
1412     {"shading-flat",                 false, OPTION_BOOL,   "/sim/rendering/shading", false, "", 0 },
1413     {"shading-smooth",               false, OPTION_BOOL,   "/sim/rendering/shading", true, "", 0 },
1414     {"disable-skyblend",             false, OPTION_BOOL,   "/sim/rendering/skyblend", false, "", 0 },
1415     {"enable-skyblend",              false, OPTION_BOOL,   "/sim/rendering/skyblend", true, "", 0 },
1416     {"disable-textures",             false, OPTION_BOOL,   "/sim/rendering/textures", false, "", 0 },
1417     {"enable-textures",              false, OPTION_BOOL,   "/sim/rendering/textures", true, "", 0 },
1418     {"texture-filtering",            false, OPTION_INT,    "/sim/rendering/filtering", 1, "", 0 },
1419     {"disable-wireframe",            false, OPTION_BOOL,   "/sim/rendering/wireframe", false, "", 0 },
1420     {"enable-wireframe",             false, OPTION_BOOL,   "/sim/rendering/wireframe", true, "", 0 },
1421     {"materials-file",               true,  OPTION_STRING, "/sim/rendering/materials-file", false, "", 0 },
1422     {"disable-terrasync",            false, OPTION_BOOL,   "/sim/terrasync/enabled", false, "", 0 },
1423     {"enable-terrasync",             false, OPTION_BOOL,   "/sim/terrasync/enabled", true, "", 0 },
1424     {"terrasync-dir",                true,  OPTION_STRING, "/sim/terrasync/scenery-dir", false, "", 0 },
1425     {"geometry",                     true,  OPTION_FUNC,   "", false, "", fgOptGeometry },
1426     {"bpp",                          true,  OPTION_FUNC,   "", false, "", fgOptBpp },
1427     {"units-feet",                   false, OPTION_STRING, "/sim/startup/units", false, "feet", 0 },
1428     {"units-meters",                 false, OPTION_STRING, "/sim/startup/units", false, "meters", 0 },
1429     {"timeofday",                    true,  OPTION_STRING, "/sim/startup/time-offset-type", false, "noon", 0 },
1430     {"season",                       true,  OPTION_STRING, "/sim/startup/season", false, "summer", 0 },
1431     {"time-offset",                  true,  OPTION_FUNC,   "", false, "", fgOptTimeOffset },
1432     {"time-match-real",              false, OPTION_STRING, "/sim/startup/time-offset-type", false, "system-offset", 0 },
1433     {"time-match-local",             false, OPTION_STRING, "/sim/startup/time-offset-type", false, "latitude-offset", 0 },
1434     {"start-date-sys",               true,  OPTION_FUNC,   "", false, "", fgOptStartDateSys },
1435     {"start-date-lat",               true,  OPTION_FUNC,   "", false, "", fgOptStartDateLat },
1436     {"start-date-gmt",               true,  OPTION_FUNC,   "", false, "", fgOptStartDateGmt },
1437     {"hud-tris",                     false, OPTION_STRING, "/sim/hud/frame-stat-type", false, "tris", 0 },
1438     {"hud-culled",                   false, OPTION_STRING, "/sim/hud/frame-stat-type", false, "culled", 0 },
1439     {"atcsim",                       true,  OPTION_CHANNEL, "", false, "dummy", 0 },
1440     {"atlas",                        true,  OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1441     {"httpd",                        true,  OPTION_CHANNEL, "", false, "", 0 },
1442 #ifdef FG_JPEG_SERVER
1443     {"jpg-httpd",                    true,  OPTION_CHANNEL, "", false, "", 0 },
1444 #endif
1445     {"native",                       true,  OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1446     {"native-ctrls",                 true,  OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1447     {"native-fdm",                   true,  OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1448     {"native-gui",                   true,  OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1449     {"opengc",                       true,  OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1450     {"AV400",                        true,  OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1451     {"AV400Sim",                     true,  OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1452     {"AV400WSimA",                   true,  OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1453     {"AV400WSimB",                   true,  OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1454     {"garmin",                       true,  OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1455     {"nmea",                         true,  OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1456     {"generic",                      true,  OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1457     {"props",                        true,  OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1458     {"telnet",                       true,  OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1459     {"pve",                          true,  OPTION_CHANNEL, "", false, "", 0 },
1460     {"ray",                          true,  OPTION_CHANNEL, "", false, "", 0 },
1461     {"rul",                          true,  OPTION_CHANNEL, "", false, "", 0 },
1462     {"joyclient",                    true,  OPTION_CHANNEL, "", false, "", 0 },
1463     {"jsclient",                     true,  OPTION_CHANNEL, "", false, "", 0 },
1464     {"proxy",                        true,  OPTION_FUNC,    "", false, "", fgSetupProxy },
1465     {"callsign",                     true,  OPTION_FUNC,    "", false, "", fgOptCallSign},
1466     {"multiplay",                    true,  OPTION_CHANNEL | OPTION_MULTI, "", false, "", 0 },
1467 #ifdef FG_HAVE_HLA
1468     {"hla",                          true,  OPTION_CHANNEL, "", false, "", 0 },
1469     {"hla-local",                    true,  OPTION_CHANNEL, "", false, "", 0 },
1470 #endif
1471     {"trace-read",                   true,  OPTION_FUNC | OPTION_MULTI,   "", false, "", fgOptTraceRead },
1472     {"trace-write",                  true,  OPTION_FUNC | OPTION_MULTI,   "", false, "", fgOptTraceWrite },
1473     {"log-level",                    true,  OPTION_FUNC,   "", false, "", fgOptLogLevel },
1474     {"log-class",                    true,  OPTION_FUNC,   "", false, "", fgOptLogClasses },
1475     {"view-offset",                  true,  OPTION_FUNC | OPTION_MULTI,   "", false, "", fgOptViewOffset },
1476     {"visibility",                   true,  OPTION_FUNC,   "", false, "", fgOptVisibilityMeters },
1477     {"visibility-miles",             true,  OPTION_FUNC,   "", false, "", fgOptVisibilityMiles },
1478     {"random-wind",                  false, OPTION_FUNC,   "", false, "", fgOptRandomWind },
1479     {"wind",                         true,  OPTION_FUNC | OPTION_MULTI,   "", false, "", fgOptWind },
1480     {"turbulence",                   true,  OPTION_FUNC,   "", false, "", fgOptTurbulence },
1481     {"ceiling",                      true,  OPTION_FUNC,   "", false, "", fgOptCeiling },
1482     {"wp",                           true,  OPTION_FUNC | OPTION_MULTI,   "", false, "", fgOptWp },
1483     {"flight-plan",                  true,  OPTION_STRING,   "/autopilot/route-manager/file-path", false, "", NULL },
1484     {"config",                       true,  OPTION_FUNC | OPTION_MULTI,   "", false, "", fgOptConfig },
1485     {"aircraft",                     true,  OPTION_STRING, "/sim/aircraft", false, "", 0 },
1486     {"vehicle",                      true,  OPTION_STRING, "/sim/aircraft", false, "", 0 },
1487     {"failure",                      true,  OPTION_FUNC | OPTION_MULTI,   "", false, "", fgOptFailure },
1488     {"com1",                         true,  OPTION_DOUBLE, "/instrumentation/comm[0]/frequencies/selected-mhz", false, "", 0 },
1489     {"com2",                         true,  OPTION_DOUBLE, "/instrumentation/comm[1]/frequencies/selected-mhz", false, "", 0 },
1490     {"nav1",                         true,  OPTION_FUNC,   "", false, "", fgOptNAV1 },
1491     {"nav2",                         true,  OPTION_FUNC,   "", false, "", fgOptNAV2 },
1492     {"adf", /*legacy*/               true,  OPTION_FUNC,   "", false, "", fgOptADF1 },
1493     {"adf1",                         true,  OPTION_FUNC,   "", false, "", fgOptADF1 },
1494     {"adf2",                         true,  OPTION_FUNC,   "", false, "", fgOptADF2 },
1495     {"dme",                          true,  OPTION_FUNC,   "", false, "", fgOptDME },
1496     {"min-status",                   true,  OPTION_STRING,  "/sim/aircraft-min-status", false, "all", 0 },
1497     {"livery",                       true,  OPTION_FUNC,   "", false, "", fgOptLivery },
1498     {"ai-scenario",                  true,  OPTION_FUNC | OPTION_MULTI,   "", false, "", fgOptScenario },
1499     {"parking-id",                   true,  OPTION_FUNC,   "", false, "", fgOptParking  },
1500     {"version",                      false, OPTION_FUNC,   "", false, "", fgOptVersion },
1501     {"enable-fpe",                   false, OPTION_IGNORE,   "", false, "", 0},
1502     {"fgviewer",                     false, OPTION_IGNORE,   "", false, "", 0},
1503     {"no-default-config",            false, OPTION_IGNORE, "", false, "", 0},
1504     {"prop",                         true,  OPTION_FUNC | OPTION_MULTI,   "", false, "", fgOptSetProperty},
1505     {0}
1506 };
1507
1508
1509 namespace flightgear
1510 {
1511
1512 /**
1513  * internal storage of a value->option binding
1514  */
1515 class OptionValue 
1516 {
1517 public:
1518   OptionValue(OptionDesc* d, const string& v) :
1519     desc(d), value(v)
1520   {;}
1521   
1522   OptionDesc* desc;
1523   string value;
1524 };
1525
1526 typedef std::vector<OptionValue> OptionValueVec;
1527 typedef std::map<string, OptionDesc*> OptionDescDict;
1528   
1529 class Options::OptionsPrivate
1530 {
1531 public:
1532   
1533   OptionValueVec::const_iterator findValue(const string& key) const
1534   {
1535     OptionValueVec::const_iterator it = values.begin();
1536     for (; it != values.end(); ++it) {
1537       if (!it->desc) {
1538         continue; // ignore markers
1539       }
1540       
1541       if (it->desc->option == key) {
1542         return it;
1543       }
1544     } // of set values iteration
1545     
1546     return it; // not found
1547   }
1548   
1549   OptionDesc* findOption(const string& key) const
1550   {
1551     OptionDescDict::const_iterator it = options.find(key);
1552     if (it == options.end()) {
1553       return NULL;
1554     }
1555     
1556     return it->second;
1557   }
1558   
1559   int processOption(OptionDesc* desc, const string& arg_value)
1560   {
1561     if (!desc) {
1562       return FG_OPTIONS_OK; // tolerate marker options
1563     }
1564     
1565     switch ( desc->type & 0xffff ) {
1566       case OPTION_BOOL:
1567         fgSetBool( desc->property, desc->b_param );
1568         break;
1569       case OPTION_STRING:
1570         if ( desc->has_param && !arg_value.empty() ) {
1571           fgSetString( desc->property, arg_value.c_str() );
1572         } else if ( !desc->has_param && arg_value.empty() ) {
1573           fgSetString( desc->property, desc->s_param );
1574         } else if ( desc->has_param ) {
1575           SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' needs a parameter" );
1576           return FG_OPTIONS_ERROR;
1577         } else {
1578           SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' does not have a parameter" );
1579           return FG_OPTIONS_ERROR;
1580         }
1581         break;
1582       case OPTION_DOUBLE:
1583         if ( !arg_value.empty() ) {
1584           fgSetDouble( desc->property, atof( arg_value ) );
1585         } else {
1586           SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' needs a parameter" );
1587           return FG_OPTIONS_ERROR;
1588         }
1589         break;
1590       case OPTION_INT:
1591         if ( !arg_value.empty() ) {
1592           fgSetInt( desc->property, atoi( arg_value ) );
1593         } else {
1594           SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' needs a parameter" );
1595           return FG_OPTIONS_ERROR;
1596         }
1597         break;
1598       case OPTION_CHANNEL:
1599         // XXX return value of add_channel should be checked?
1600         if ( desc->has_param && !arg_value.empty() ) {
1601           add_channel( desc->option, arg_value );
1602         } else if ( !desc->has_param && arg_value.empty() ) {
1603           add_channel( desc->option, desc->s_param );
1604         } else if ( desc->has_param ) {
1605           SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' needs a parameter" );
1606           return FG_OPTIONS_ERROR;
1607         } else {
1608           SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' does not have a parameter" );
1609           return FG_OPTIONS_ERROR;
1610         }
1611         break;
1612       case OPTION_FUNC:
1613         if ( desc->has_param && !arg_value.empty() ) {
1614           return desc->func( arg_value.c_str() );
1615         } else if ( !desc->has_param && arg_value.empty() ) {
1616           return desc->func( desc->s_param );
1617         } else if ( desc->has_param ) {
1618           SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' needs a parameter" );
1619           return FG_OPTIONS_ERROR;
1620         } else {
1621           SG_LOG( SG_GENERAL, SG_ALERT, "Option '" << desc->option << "' does not have a parameter" );
1622           return FG_OPTIONS_ERROR;
1623         }
1624         break;
1625         
1626       case OPTION_IGNORE:
1627         break;
1628     }
1629     
1630     return FG_OPTIONS_OK;
1631   }
1632     
1633   /**
1634    * insert a marker value into the values vector. This is necessary
1635    * when processing options, to ensure the correct ordering, where we scan
1636    * for marker values in reverse, and then forwards within each group.
1637    */
1638   void insertGroupMarker()
1639   {
1640     values.push_back(OptionValue(NULL, "-"));
1641   }
1642   
1643   /**
1644    * given a current iterator into the values, find the preceeding group marker,
1645    * or return the beginning of the value vector.
1646    */
1647   OptionValueVec::const_iterator rfindGroup(OptionValueVec::const_iterator pos) const
1648   {
1649     while (--pos != values.begin()) {
1650       if (pos->desc == NULL) {
1651         return pos; // found a marker, we're done
1652       }
1653     }
1654     
1655     return pos;
1656   }
1657   
1658   bool showHelp,
1659     verbose,
1660     showAircraft,
1661     shouldLoadDefaultConfig;
1662     
1663   OptionDescDict options;
1664   OptionValueVec values;
1665   simgear::PathList propertyFiles;
1666 };
1667   
1668 Options* Options::sharedInstance()
1669 {
1670   if (shared_instance == NULL) {
1671     shared_instance = new Options;
1672   }
1673   
1674   return shared_instance;
1675 }
1676   
1677 Options::Options() :
1678   p(new OptionsPrivate())
1679 {
1680   p->showHelp = false;
1681   p->verbose = false;
1682   p->showAircraft = false;
1683   p->shouldLoadDefaultConfig = true;
1684   
1685 // build option map
1686   OptionDesc *desc = &fgOptionArray[ 0 ];
1687   while ( desc->option != 0 ) {
1688     p->options[ desc->option ] = desc;
1689     ++desc;
1690   }
1691 }
1692   
1693 Options::~Options()
1694 {
1695 }
1696   
1697 void Options::init(int argc, char **argv, const SGPath& appDataPath)
1698 {
1699   fgSetDefaults();
1700   
1701 // first, process the command line
1702   bool inOptions = true;
1703   for (int i=1; i<argc; ++i) {
1704     if (inOptions && (argv[i][0] == '-')) {
1705       if (strcmp(argv[i], "--") == 0) { // end of options delimiter
1706         inOptions = true;
1707         continue;
1708       }
1709       
1710       int result = parseOption(argv[i]);
1711       processArgResult(result);
1712     } else {
1713     // XML properties file
1714       SGPath f(argv[i]);
1715       if (!f.exists()) {
1716         SG_LOG(SG_GENERAL, SG_ALERT, "config file not found:" << f.str());
1717         return;
1718       }
1719       
1720       p->propertyFiles.push_back(f);
1721     }
1722   } // of arguments iteration
1723   p->insertGroupMarker(); // command line is one group
1724   
1725   // establish log-level before anything else - otherwise it is not possible
1726   // to show extra (debug/info/warning) messages for the start-up phase.
1727   fgOptLogLevel(valueForOption("log-level", "alert").c_str());
1728
1729   if (!p->shouldLoadDefaultConfig) {
1730     setupRoot();
1731     return;
1732   }
1733   
1734 // then config files
1735   SGPath config;
1736   std::string homedir;
1737   if (getenv("HOME")) {
1738     homedir = getenv("HOME");
1739   }
1740     
1741   if( !homedir.empty() && !hostname.empty() ) {
1742     // Check for ~/.fgfsrc.hostname
1743     config.set(homedir);
1744     config.append(".fgfsrc");
1745     config.concat( "." );
1746     config.concat( hostname );
1747     readConfig(config);
1748   }
1749   
1750 // Check for ~/.fgfsrc
1751   if( !homedir.empty() ) {
1752     config.set(homedir);
1753     config.append(".fgfsrc");
1754     readConfig(config);
1755   }
1756   
1757 // check for a config file in app data
1758   SGPath appDataConfig(appDataPath);
1759   appDataConfig.append("fgfsrc");
1760   if (appDataConfig.exists()) {
1761     readConfig(appDataConfig);
1762   }
1763   
1764 // setup FG_ROOT
1765   setupRoot();
1766   
1767 // system.fgfsrc handling
1768   if( hostname.size() > 0 ) {
1769     config.set(globals->get_fg_root());
1770     config.append( "system.fgfsrc" );
1771     config.concat( "." );
1772     config.concat( hostname );
1773     readConfig(config);
1774   }
1775
1776   config.set(globals->get_fg_root());
1777   config.append( "system.fgfsrc" );
1778   readConfig(config);
1779 }
1780   
1781 void Options::initAircraft()
1782 {
1783   BOOST_FOREACH(const string& paths, valuesForOption("fg-aircraft")) {
1784     globals->append_aircraft_paths(paths);
1785   }
1786   
1787   const char* envp = ::getenv("FG_AIRCRAFT");
1788   if (envp) {
1789     globals->append_aircraft_paths(envp);
1790   }
1791
1792   string aircraft;
1793   if (isOptionSet("aircraft")) {
1794     aircraft = valueForOption("aircraft");
1795   } else if (isOptionSet("vehicle")) {
1796     aircraft = valueForOption("vehicle");
1797   }
1798     
1799   if (!aircraft.empty()) {
1800     SG_LOG(SG_INPUT, SG_INFO, "aircraft = " << aircraft );
1801     fgSetString("/sim/aircraft", aircraft.c_str() );
1802   } else {
1803     SG_LOG(SG_INPUT, SG_INFO, "No user specified aircraft, using default" );
1804   }
1805   
1806   if (p->showAircraft) {
1807     fgOptLogLevel( "alert" );
1808     SGPath path( globals->get_fg_root() );
1809     path.append("Aircraft");
1810     fgShowAircraft(path);
1811     exit(0);
1812   }
1813   
1814   if (isOptionSet("aircraft-dir")) {
1815     // set this now, so it's available in FindAndCacheAircraft
1816     fgSetString("/sim/aircraft-dir", valueForOption("aircraft-dir"));
1817   }
1818 }
1819   
1820 void Options::processArgResult(int result)
1821 {
1822   if ((result == FG_OPTIONS_HELP) || (result == FG_OPTIONS_ERROR))
1823     p->showHelp = true;
1824   else if (result == FG_OPTIONS_VERBOSE_HELP)
1825     p->verbose = true;
1826   else if (result == FG_OPTIONS_SHOW_AIRCRAFT) {
1827     p->showAircraft = true;
1828   } else if (result == FG_OPTIONS_NO_DEFAULT_CONFIG) {
1829     p->shouldLoadDefaultConfig = false;
1830   } else if (result == FG_OPTIONS_SHOW_SOUND_DEVICES) {
1831     SGSoundMgr smgr;
1832     
1833     smgr.init();
1834     string vendor = smgr.get_vendor();
1835     string renderer = smgr.get_renderer();
1836     cout << renderer << " provided by " << vendor << endl;
1837     cout << endl << "No. Device" << endl;
1838     
1839     vector <const char*>devices = smgr.get_available_devices();
1840     for (vector <const char*>::size_type i=0; i<devices.size(); i++) {
1841       cout << i << ".  \"" << devices[i] << "\"" << endl;
1842     }
1843     devices.clear();
1844     smgr.stop();
1845     exit(0);
1846   } else if (result == FG_OPTIONS_EXIT) {
1847     exit(0);
1848   }
1849 }
1850   
1851 void Options::readConfig(const SGPath& path)
1852 {
1853   sg_gzifstream in( path.str() );
1854   if ( !in.is_open() ) {
1855     return;
1856   }
1857   
1858   SG_LOG( SG_GENERAL, SG_INFO, "Processing config file: " << path.str() );
1859   
1860   in >> skipcomment;
1861   while ( ! in.eof() ) {
1862     string line;
1863     getline( in, line, '\n' );
1864     
1865     // catch extraneous (DOS) line ending character
1866     int i;
1867     for (i = line.length(); i > 0; i--)
1868       if (line[i - 1] > 32)
1869         break;
1870     line = line.substr( 0, i );
1871     
1872     if ( parseOption( line ) == FG_OPTIONS_ERROR ) {
1873       cerr << endl << "Config file parse error: " << path.str() << " '"
1874       << line << "'" << endl;
1875             p->showHelp = true;
1876     }
1877     in >> skipcomment;
1878   }
1879
1880   p->insertGroupMarker(); // each config file is a group
1881 }
1882   
1883 int Options::parseOption(const string& s)
1884 {
1885   if ((s == "--help") || (s=="-h")) {
1886     return FG_OPTIONS_HELP;
1887   } else if ( (s == "--verbose") || (s == "-v") ) {
1888     // verbose help/usage request
1889     return FG_OPTIONS_VERBOSE_HELP;
1890   } else if (s.find("-psn") == 0) {
1891     // on Mac, when launched from the GUI, we are passed the ProcessSerialNumber
1892     // as an argument (and no others). Silently ignore the argument here.
1893     return FG_OPTIONS_OK;
1894   } else if ( s.find( "--show-aircraft") == 0) {
1895     return(FG_OPTIONS_SHOW_AIRCRAFT);
1896   } else if ( s.find( "--show-sound-devices") == 0) {
1897     return(FG_OPTIONS_SHOW_SOUND_DEVICES);
1898   } else if ( s.find( "--no-default-config") == 0) {
1899     return FG_OPTIONS_NO_DEFAULT_CONFIG;
1900   } else if ( s.find( "--prop:") == 0) {
1901     // property setting has a slightly different syntax, so fudge things
1902     OptionDesc* desc = p->findOption("prop");
1903     if (s.find("=", 7) == string::npos) { // no equals token
1904       SG_LOG(SG_GENERAL, SG_ALERT, "malformed property option:" << s);
1905       return FG_OPTIONS_ERROR;
1906     }
1907     
1908     p->values.push_back(OptionValue(desc, s.substr(7)));
1909     return FG_OPTIONS_OK;
1910   } else if ( s.find( "--" ) == 0 ) {
1911     size_t eqPos = s.find( '=' );
1912     string key, value;
1913     if (eqPos == string::npos) {
1914       key = s.substr(2);
1915     } else {
1916       key = s.substr( 2, eqPos - 2 );
1917       value = s.substr( eqPos + 1);
1918     }
1919     
1920     return addOption(key, value);
1921   } else {
1922     SG_LOG(SG_GENERAL, SG_ALERT, "unknown option:" << s);
1923     return FG_OPTIONS_ERROR;
1924   }
1925 }
1926   
1927 int Options::addOption(const string &key, const string &value)
1928 {
1929   OptionDesc* desc = p->findOption(key);
1930   if (!desc) {
1931     SG_LOG(SG_GENERAL, SG_ALERT, "unknown option:" << key);
1932     return FG_OPTIONS_ERROR;
1933   }
1934   
1935   if (!(desc->type & OPTION_MULTI)) {
1936     OptionValueVec::const_iterator it = p->findValue(key);
1937     if (it != p->values.end()) {
1938       SG_LOG(SG_GENERAL, SG_INFO, "multiple values forbidden for option:" << key << ", ignoring:" << value);
1939       return FG_OPTIONS_OK;
1940     }
1941   }
1942   
1943   p->values.push_back(OptionValue(desc, value));
1944   return FG_OPTIONS_OK;
1945 }
1946   
1947 bool Options::isOptionSet(const string &key) const
1948 {
1949   OptionValueVec::const_iterator it = p->findValue(key);
1950   return (it != p->values.end());
1951 }
1952   
1953 string Options::valueForOption(const string& key, const string& defValue) const
1954 {
1955   OptionValueVec::const_iterator it = p->findValue(key);
1956   if (it == p->values.end()) {
1957     return defValue;
1958   }
1959   
1960   return it->value;
1961 }
1962
1963 string_list Options::valuesForOption(const std::string& key) const
1964 {
1965   string_list result;
1966   OptionValueVec::const_iterator it = p->values.begin();
1967   for (; it != p->values.end(); ++it) {
1968     if (!it->desc) {
1969       continue; // ignore marker values
1970     }
1971     
1972     if (it->desc->option == key) {
1973       result.push_back(it->value);
1974     }
1975   }
1976   
1977   return result;
1978 }
1979
1980 void Options::processOptions()
1981 {
1982   // establish locale before showing help (this selects the default locale,
1983   // when no explicit option was set)
1984   globals->get_locale()->selectLanguage(valueForOption("language").c_str());
1985
1986   // now FG_ROOT is setup, process various command line options that bail us
1987   // out quickly, but rely on aircraft / root settings
1988   if (p->showHelp) {
1989     showUsage();
1990     exit(0);
1991   }
1992   
1993   // processing order is complicated. We must process groups LIFO, but the
1994   // values *within* each group in FIFO order, to retain consistency with
1995   // older versions of FG, and existing user configs.
1996   // in practice this means system.fgfsrc must be *processed* before
1997   // .fgfsrc, which must be processed before the command line args, and so on.
1998   OptionValueVec::const_iterator groupEnd = p->values.end();
1999
2000   while (groupEnd != p->values.begin()) {
2001     OptionValueVec::const_iterator groupBegin = p->rfindGroup(groupEnd);
2002   // run over the group in FIFO order
2003     OptionValueVec::const_iterator it;
2004     for (it = groupBegin; it != groupEnd; ++it) {      
2005       int result = p->processOption(it->desc, it->value);
2006       switch(result)
2007       {
2008           case FG_OPTIONS_ERROR:
2009               showUsage();
2010               exit(-1); // exit and return an error
2011           case FG_OPTIONS_EXIT:
2012               exit(0);  // clean exit
2013           default:
2014               break;
2015       }
2016     }
2017     
2018     groupEnd = groupBegin;
2019   }
2020
2021   BOOST_FOREACH(const SGPath& file, p->propertyFiles) {
2022     if (!file.exists()) {
2023       SG_LOG(SG_GENERAL, SG_ALERT, "config file not found:" << file.str());
2024       continue;
2025     }
2026     
2027     SG_LOG(SG_GENERAL, SG_INFO,
2028            "Reading command-line property file " << file.str());
2029           readProperties(file.str(), globals->get_props());
2030   }
2031
2032 // now options are process, do supplemental fixup
2033   const char *envp = ::getenv( "FG_SCENERY" );
2034   if (envp) {
2035     globals->append_fg_scenery(envp);
2036   }
2037     
2038 // terrasync directory fixup
2039   if (fgGetBool("/sim/terrasync/enabled")) {
2040     string terrasyncDir = fgGetString("/sim/terrasync/scenery-dir");
2041     if (terrasyncDir.empty()) {
2042       SGPath p(globals->get_fg_home());
2043       p.append("TerraSync");
2044       terrasyncDir = p.str();
2045       SG_LOG(SG_GENERAL, SG_INFO,
2046              "Using default TerraSync dir: " << terrasyncDir);
2047       fgSetString("/sim/terrasync/scenery-dir", terrasyncDir);
2048     }
2049       
2050       SGPath p(terrasyncDir);
2051       if (!p.exists()) {
2052           simgear::Dir dd(p);
2053           dd.create(0700);
2054       }
2055     
2056     const string_list& scenery_paths(globals->get_fg_scenery());
2057     if (std::find(scenery_paths.begin(), scenery_paths.end(), terrasyncDir) == scenery_paths.end()) {
2058       // terrasync dir is not in the scenery paths, add it
2059       globals->append_fg_scenery(terrasyncDir);
2060     }
2061   }
2062   
2063   if (globals->get_fg_scenery().empty()) {
2064     // no scenery paths set *at all*, use the data in FG_ROOT
2065     SGPath root(globals->get_fg_root());
2066     root.append("Scenery");
2067     globals->append_fg_scenery(root.str());
2068   }
2069 }
2070   
2071 void Options::showUsage() const
2072 {
2073   fgOptLogLevel( "alert" );
2074   
2075   FGLocale *locale = globals->get_locale();
2076   SGPropertyNode options_root;
2077   
2078   SG_LOG( SG_GENERAL, SG_ALERT, "" ); // To popup the console on Windows
2079   cout << endl;
2080
2081   try {
2082     fgLoadProps("options.xml", &options_root);
2083   } catch (const sg_exception &) {
2084     cout << "Unable to read the help file." << endl;
2085     cout << "Make sure the file options.xml is located in the FlightGear base directory," << endl;
2086     cout << "and the location of the base directory is specified by setting $FG_ROOT or" << endl;
2087     cout << "by adding --fg-root=path as a program argument." << endl;
2088     
2089     exit(-1);
2090   }
2091
2092   SGPropertyNode *options = options_root.getNode("options");
2093   if (!options) {
2094     SG_LOG( SG_GENERAL, SG_ALERT,
2095            "Error reading options.xml: <options> directive not found." );
2096     exit(-1);
2097   }
2098
2099   if (!locale->loadResource("options"))
2100   {
2101       cout << "Unable to read the language resource." << endl;
2102       exit(-1);
2103   }
2104
2105   const char* usage = locale->getLocalizedString(options->getStringValue("usage"), "options");
2106   if (usage) {
2107     cout << usage << endl;
2108   }
2109   
2110   vector<SGPropertyNode_ptr>section = options->getChildren("section");
2111   for (unsigned int j = 0; j < section.size(); j++) {
2112     string msg = "";
2113     
2114     vector<SGPropertyNode_ptr>option = section[j]->getChildren("option");
2115     for (unsigned int k = 0; k < option.size(); k++) {
2116       
2117       SGPropertyNode *name = option[k]->getNode("name");
2118       SGPropertyNode *short_name = option[k]->getNode("short");
2119       SGPropertyNode *key = option[k]->getNode("key");
2120       SGPropertyNode *arg = option[k]->getNode("arg");
2121       bool brief = option[k]->getNode("brief") != 0;
2122       
2123       if ((brief || p->verbose) && name) {
2124         string tmp = name->getStringValue();
2125         
2126         if (key){
2127           tmp.append(":");
2128           tmp.append(key->getStringValue());
2129         }
2130         if (arg) {
2131           tmp.append("=");
2132           tmp.append(arg->getStringValue());
2133         }
2134         if (short_name) {
2135           tmp.append(", -");
2136           tmp.append(short_name->getStringValue());
2137         }
2138         
2139         if (tmp.size() <= 25) {
2140           msg+= "   --";
2141           msg += tmp;
2142           msg.append( 27-tmp.size(), ' ');
2143         } else {
2144           msg += "\n   --";
2145           msg += tmp + '\n';
2146           msg.append(32, ' ');
2147         }
2148         // There may be more than one <description> tag associated
2149         // with one option
2150         
2151         vector<SGPropertyNode_ptr> desc;
2152         desc = option[k]->getChildren("description");
2153         if (desc.size() > 0) {
2154           for ( unsigned int l = 0; l < desc.size(); l++) {
2155             string t = desc[l]->getStringValue();
2156
2157             // There may be more than one translation line.
2158             vector<SGPropertyNode_ptr>trans_desc = locale->getLocalizedStrings(t.c_str(),"options");
2159             for ( unsigned int m = 0; m < trans_desc.size(); m++ ) {
2160               string t_str = trans_desc[m]->getStringValue();
2161               
2162               if ((m > 0) || ((l > 0) && m == 0)) {
2163                 msg.append( 32, ' ');
2164               }
2165               
2166               // If the string is too large to fit on the screen,
2167               // then split it up in several pieces.
2168               
2169               while ( t_str.size() > 47 ) {
2170                 
2171                 string::size_type m = t_str.rfind(' ', 47);
2172                 msg += t_str.substr(0, m) + '\n';
2173                 msg.append( 32, ' ');
2174                 
2175                 t_str.erase(t_str.begin(), t_str.begin() + m + 1);
2176               }
2177               msg += t_str + '\n';
2178             }
2179           }
2180         }
2181       }
2182     }
2183     
2184     const char* name = locale->getLocalizedString(section[j]->getStringValue("name"),"options");
2185     if (!msg.empty() && name) {
2186       cout << endl << name << ":" << endl;
2187       cout << msg;
2188       msg.erase();
2189     }
2190   }
2191   
2192   if ( !p->verbose ) {
2193     const char* verbose_help = locale->getLocalizedString(options->getStringValue("verbose-help"),"options");
2194     if (verbose_help)
2195         cout << endl << verbose_help << endl;
2196   }
2197 #ifdef _MSC_VER
2198   std::cout << "Hit a key to continue..." << std::endl;
2199   std::cin.get();
2200 #endif
2201 }
2202   
2203 #if defined(__CYGWIN__)
2204 string Options::platformDefaultRoot() const
2205 {
2206   return "../data";
2207 }
2208
2209 #elif defined(_WIN32)
2210 string Options::platformDefaultRoot() const
2211 {
2212   return "..\\data";
2213 }
2214 #elif defined(__APPLE__)
2215 string Options::platformDefaultRoot() const
2216 {
2217   /*
2218    The following code looks for the base package inside the application 
2219    bundle, in the standard Contents/Resources location. 
2220    */
2221   CFURLRef resourcesUrl = CFBundleCopyResourcesDirectoryURL(CFBundleGetMainBundle());
2222   
2223   // look for a 'data' subdir
2224   CFURLRef dataDir = CFURLCreateCopyAppendingPathComponent(NULL, resourcesUrl, CFSTR("data"), true);
2225   
2226   // now convert down to a path, and the a c-string
2227   CFStringRef path = CFURLCopyFileSystemPath(dataDir, kCFURLPOSIXPathStyle);
2228   string root = CFStringGetCStringPtr(path, CFStringGetSystemEncoding());
2229   
2230   CFRelease(resourcesUrl);
2231   CFRelease(dataDir);
2232   CFRelease(path);
2233   
2234   return root;
2235 }
2236 #else
2237 string Options::platformDefaultRoot() const
2238 {
2239   return PKGLIBDIR;
2240 }
2241 #endif
2242   
2243 void Options::setupRoot()
2244 {
2245   string root;
2246   if (isOptionSet("fg-root")) {
2247     root = valueForOption("fg-root"); // easy!
2248   } else {
2249   // Next check if fg-root is set as an env variable
2250     char *envp = ::getenv( "FG_ROOT" );
2251     if ( envp != NULL ) {
2252       root = envp;
2253     } else {
2254       root = platformDefaultRoot();
2255     }
2256   } 
2257   
2258   SG_LOG(SG_INPUT, SG_INFO, "fg_root = " << root );
2259   globals->set_fg_root(root);
2260   
2261 // validate it
2262   static char required_version[] = FLIGHTGEAR_VERSION;
2263   string base_version = fgBasePackageVersion();
2264   if ( !(base_version == required_version) ) {
2265     // tell the operator how to use this application
2266     
2267     SG_LOG( SG_GENERAL, SG_ALERT, "" ); // To popup the console on windows
2268     cerr << endl << "Base package check failed:" << endl \
2269     << "  Version " << base_version << " found at: " \
2270     << globals->get_fg_root() << endl \
2271     << "  Version " << required_version << " is required." << endl \
2272     << "Please upgrade/downgrade base package and set the path to your fgdata" << endl \
2273     << "with --fg-root=path_to_your_fgdata" << endl;
2274 #ifdef _MSC_VER
2275     cerr << "Hit a key to continue..." << endl;
2276     cin.get();
2277 #endif
2278     exit(-1);
2279   }
2280 }
2281   
2282 bool Options::shouldLoadDefaultConfig() const
2283 {
2284   return p->shouldLoadDefaultConfig;
2285 }
2286   
2287 } // of namespace flightgear
2288