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