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