src/Scripting/NasalSys.cxx

   1
   2 #ifdef HAVE_CONFIG_H
   3 #  include "config.h"
   4 #endif
   5
   6 #ifdef HAVE_SYS_TIME_H
   7 #  include <sys/time.h>  // gettimeofday
   8 #endif
   9
  10 #include <string.h>
  11 #include <stdio.h>
  12 #include <sys/types.h>
  13 #include <sys/stat.h>
  14 #include <fstream>
  15 #include <sstream>
  16
  17 #include <simgear/nasal/nasal.h>
  18 #include <simgear/props/props.hxx>
  19 #include <simgear/math/sg_random.h>
  20 #include <simgear/misc/sg_path.hxx>
  21 #include <simgear/misc/sg_dir.hxx>
  22 #include <simgear/misc/interpolator.hxx>
  23 #include <simgear/scene/material/mat.hxx>
  24 #include <simgear/structure/commands.hxx>
  25 #include <simgear/math/sg_geodesy.hxx>
  26 #include <simgear/structure/event_mgr.hxx>
  27
  28 #include <Airports/runways.hxx>
  29 #include <Airports/simple.hxx>
  30 #include <Main/globals.hxx>
  31 #include <Main/fg_props.hxx>
  32 #include <Main/util.hxx>
  33 #include <Scenery/scenery.hxx>
  34 #include <Navaids/navlist.hxx>
  35 #include <Navaids/procedure.hxx>
  36 #include <Radio/radio.hxx>
  37
  38
  39 #include "NasalSys.hxx"
  40
  41 static FGNasalSys* nasalSys = 0;
  42
  43 // Listener class for loading Nasal modules on demand
  44 class FGNasalModuleListener : public SGPropertyChangeListener
  45 {
  46 public:
  47     FGNasalModuleListener(SGPropertyNode* node);
  48
  49     virtual void valueChanged(SGPropertyNode* node);
  50
  51 private:
  52     SGPropertyNode_ptr _node;
  53 };
  54
  55 FGNasalModuleListener::FGNasalModuleListener(SGPropertyNode* node) : _node(node)
  56 {
  57 }
  58
  59 void FGNasalModuleListener::valueChanged(SGPropertyNode*)
  60 {
  61     if (_node->getBoolValue("enabled",false)&&
  62         !_node->getBoolValue("loaded",true))
  63     {
  64         nasalSys->loadPropertyScripts(_node);
  65     }
  66 }
  67
  68
  69 // Read and return file contents in a single buffer.  Note use of
  70 // stat() to get the file size.  This is a win32 function, believe it
  71 // or not. :) Note the REALLY IMPORTANT use of the "b" flag to fopen.
  72 // Text mode brain damage will kill us if we're trying to do bytewise
  73 // I/O.
  74 static char* readfile(const char* file, int* lenOut)
  75 {
  76     struct stat data;
  77     if(stat(file, &data) != 0) return 0;
  78     FILE* f = fopen(file, "rb");
  79     if(!f) return 0;
  80     char* buf = new char[data.st_size];
  81     *lenOut = fread(buf, 1, data.st_size, f);
  82     fclose(f);
  83     if(*lenOut != data.st_size) {
  84         // Shouldn't happen, but warn anyway since it represents a
  85         // platform bug and not a typical runtime error (missing file,
  86         // etc...)
  87         SG_LOG(SG_NASAL, SG_ALERT,
  88                "ERROR in Nasal initialization: " <<
  89                "short count returned from fread() of " << file <<
  90                ".  Check your C library!");
  91         delete[] buf;
  92         return 0;
  93     }
  94     return buf;
  95 }
  96
  97 FGNasalSys::FGNasalSys()
  98 {
  99     nasalSys = this;
 100     _context = 0;
 101     _globals = naNil();
 102     _gcHash = naNil();
 103     _nextGCKey = 0; // Any value will do
 104     _callCount = 0;
 105 }
 106
 107 // Does a naCall() in a new context.  Wrapped here to make lock
 108 // tracking easier.  Extension functions are called with the lock, but
 109 // we have to release it before making a new naCall().  So rather than
 110 // drop the lock in every extension function that might call back into
 111 // Nasal, we keep a stack depth counter here and only unlock/lock
 112 // around the naCall if it isn't the first one.
 113 naRef FGNasalSys::call(naRef code, int argc, naRef* args, naRef locals)
 114 {
 115     naContext ctx = naNewContext();
 116     if(_callCount) naModUnlock();
 117     _callCount++;
 118     naRef result = naCall(ctx, code, argc, args, naNil(), locals);
 119     if(naGetError(ctx))
 120         logError(ctx);
 121     _callCount--;
 122     if(_callCount) naModLock();
 123     naFreeContext(ctx);
 124     return result;
 125 }
 126
 127 FGNasalSys::~FGNasalSys()
 128 {
 129     nasalSys = 0;
 130     map<int, FGNasalListener *>::iterator it, end = _listener.end();
 131     for(it = _listener.begin(); it != end; ++it)
 132         delete it->second;
 133
 134     naFreeContext(_context);
 135     _globals = naNil();
 136 }
 137
 138 bool FGNasalSys::parseAndRun(const char* sourceCode)
 139 {
 140     naRef code = parse("FGNasalSys::parseAndRun()", sourceCode,
 141                        strlen(sourceCode));
 142     if(naIsNil(code))
 143         return false;
 144     call(code, 0, 0, naNil());
 145     return true;
 146 }
 147
 148 FGNasalScript* FGNasalSys::parseScript(const char* src, const char* name)
 149 {
 150     FGNasalScript* script = new FGNasalScript();
 151     script->_gcKey = -1; // important, if we delete it on a parse
 152     script->_nas = this; // error, don't clobber a real handle!
 153
 154     char buf[256];
 155     if(!name) {
 156         sprintf(buf, "FGNasalScript@%p", (void *)script);
 157         name = buf;
 158     }
 159
 160     script->_code = parse(name, src, strlen(src));
 161     if(naIsNil(script->_code)) {
 162         delete script;
 163         return 0;
 164     }
 165
 166     script->_gcKey = gcSave(script->_code);
 167     return script;
 168 }
 169
 170 // Utility.  Sets a named key in a hash by C string, rather than nasal
 171 // string object.
 172 void FGNasalSys::hashset(naRef hash, const char* key, naRef val)
 173 {
 174     naRef s = naNewString(_context);
 175     naStr_fromdata(s, (char*)key, strlen(key));
 176     naHash_set(hash, s, val);
 177 }
 178
 179 // The get/setprop functions accept a *list* of strings and walk
 180 // through the property tree with them to find the appropriate node.
 181 // This allows a Nasal object to hold onto a property path and use it
 182 // like a node object, e.g. setprop(ObjRoot, "size-parsecs", 2.02).  This
 183 // is the utility function that walks the property tree.
 184 // Future enhancement: support integer arguments to specify array
 185 // elements.
 186 static SGPropertyNode* findnode(naContext c, naRef* vec, int len)
 187 {
 188     SGPropertyNode* p = globals->get_props();
 189     try {
 190         for(int i=0; i<len; i++) {
 191             naRef a = vec[i];
 192             if(!naIsString(a)) return 0;
 193             p = p->getNode(naStr_data(a));
 194             if(p == 0) return 0;
 195         }
 196     } catch (const string& err) {
 197         naRuntimeError(c, (char *)err.c_str());
 198         return 0;
 199     }
 200     return p;
 201 }
 202
 203 // getprop() extension function.  Concatenates its string arguments as
 204 // property names and returns the value of the specified property.  Or
 205 // nil if it doesn't exist.
 206 static naRef f_getprop(naContext c, naRef me, int argc, naRef* args)
 207 {
 208     using namespace simgear;
 209     const SGPropertyNode* p = findnode(c, args, argc);
 210     if(!p) return naNil();
 211
 212     switch(p->getType()) {
 213     case props::BOOL:   case props::INT:
 214     case props::LONG:   case props::FLOAT:
 215     case props::DOUBLE:
 216         {
 217         double dv = p->getDoubleValue();
 218         if (osg::isNaN(dv)) {
 219           SG_LOG(SG_GENERAL, SG_ALERT, "Nasal getprop: property " << p->getPath() << " is NaN");
 220           return naNil();
 221         }
 222
 223         return naNum(dv);
 224         }
 225
 226     case props::STRING:
 227     case props::UNSPECIFIED:
 228         {
 229             naRef nastr = naNewString(c);
 230             const char* val = p->getStringValue();
 231             naStr_fromdata(nastr, (char*)val, strlen(val));
 232             return nastr;
 233         }
 234     case props::ALIAS: // <--- FIXME, recurse?
 235     default:
 236         return naNil();
 237     }
 238 }
 239
 240 // setprop() extension function.  Concatenates its string arguments as
 241 // property names and sets the value of the specified property to the
 242 // final argument.
 243 static naRef f_setprop(naContext c, naRef me, int argc, naRef* args)
 244 {
 245 #define BUFLEN 1024
 246     char buf[BUFLEN + 1];
 247     buf[BUFLEN] = 0;
 248     char* p = buf;
 249     int buflen = BUFLEN;
 250     if(argc < 2) naRuntimeError(c, "setprop() expects at least 2 arguments");
 251     for(int i=0; i<argc-1; i++) {
 252         naRef s = naStringValue(c, args[i]);
 253         if(naIsNil(s)) return naNil();
 254         strncpy(p, naStr_data(s), buflen);
 255         p += naStr_len(s);
 256         buflen = BUFLEN - (p - buf);
 257         if(i < (argc-2) && buflen > 0) {
 258             *p++ = '/';
 259             buflen--;
 260         }
 261     }
 262
 263     SGPropertyNode* props = globals->get_props();
 264     naRef val = args[argc-1];
 265     bool result = false;
 266     try {
 267         if(naIsString(val)) result = props->setStringValue(buf, naStr_data(val));
 268         else {
 269             naRef n = naNumValue(val);
 270             if(naIsNil(n))
 271                 naRuntimeError(c, "setprop() value is not string or number");
 272
 273             if (osg::isNaN(n.num)) {
 274                 naRuntimeError(c, "setprop() passed a NaN");
 275             }
 276
 277             result = props->setDoubleValue(buf, n.num);
 278         }
 279     } catch (const string& err) {
 280         naRuntimeError(c, (char *)err.c_str());
 281     }
 282     return naNum(result);
 283 #undef BUFLEN
 284 }
 285
 286 // print() extension function.  Concatenates and prints its arguments
 287 // to the FlightGear log.  Uses the highest log level (SG_ALERT), to
 288 // make sure it appears.  Is there better way to do this?
 289 static naRef f_print(naContext c, naRef me, int argc, naRef* args)
 290 {
 291     string buf;
 292     int n = argc;
 293     for(int i=0; i<n; i++) {
 294         naRef s = naStringValue(c, args[i]);
 295         if(naIsNil(s)) continue;
 296         buf += naStr_data(s);
 297     }
 298     SG_LOG(SG_GENERAL, SG_ALERT, buf);
 299     return naNum(buf.length());
 300 }
 301
 302 // fgcommand() extension function.  Executes a named command via the
 303 // FlightGear command manager.  Takes a single property node name as
 304 // an argument.
 305 static naRef f_fgcommand(naContext c, naRef me, int argc, naRef* args)
 306 {
 307     naRef cmd = argc > 0 ? args[0] : naNil();
 308     naRef props = argc > 1 ? args[1] : naNil();
 309     if(!naIsString(cmd) || (!naIsNil(props) && !naIsGhost(props)))
 310         naRuntimeError(c, "bad arguments to fgcommand()");
 311     SGPropertyNode_ptr tmp, *node;
 312     if(!naIsNil(props))
 313         node = (SGPropertyNode_ptr*)naGhost_ptr(props);
 314     else {
 315         tmp = new SGPropertyNode();
 316         node = &tmp;
 317     }
 318     return naNum(globals->get_commands()->execute(naStr_data(cmd), *node));
 319 }
 320
 321 // settimer(func, dt, simtime) extension function.  Falls through to
 322 // FGNasalSys::setTimer().  See there for docs.
 323 static naRef f_settimer(naContext c, naRef me, int argc, naRef* args)
 324 {
 325     nasalSys->setTimer(c, argc, args);
 326     return naNil();
 327 }
 328
 329 // setlistener(func, property, bool) extension function.  Falls through to
 330 // FGNasalSys::setListener().  See there for docs.
 331 static naRef f_setlistener(naContext c, naRef me, int argc, naRef* args)
 332 {
 333     return nasalSys->setListener(c, argc, args);
 334 }
 335
 336 // removelistener(int) extension function. Falls through to
 337 // FGNasalSys::removeListener(). See there for docs.
 338 static naRef f_removelistener(naContext c, naRef me, int argc, naRef* args)
 339 {
 340     return nasalSys->removeListener(c, argc, args);
 341 }
 342
 343 // Returns a ghost handle to the argument to the currently executing
 344 // command
 345 static naRef f_cmdarg(naContext c, naRef me, int argc, naRef* args)
 346 {
 347     return nasalSys->cmdArgGhost();
 348 }
 349
 350 // Sets up a property interpolation.  The first argument is either a
 351 // ghost (SGPropertyNode_ptr*) or a string (global property path) to
 352 // interpolate.  The second argument is a vector of pairs of
 353 // value/delta numbers.
 354 static naRef f_interpolate(naContext c, naRef me, int argc, naRef* args)
 355 {
 356     SGPropertyNode* node;
 357     naRef prop = argc > 0 ? args[0] : naNil();
 358     if(naIsString(prop)) node = fgGetNode(naStr_data(prop), true);
 359     else if(naIsGhost(prop)) node = *(SGPropertyNode_ptr*)naGhost_ptr(prop);
 360     else return naNil();
 361
 362     naRef curve = argc > 1 ? args[1] : naNil();
 363     if(!naIsVector(curve)) return naNil();
 364     int nPoints = naVec_size(curve) / 2;
 365     double* values = new double[nPoints];
 366     double* deltas = new double[nPoints];
 367     for(int i=0; i<nPoints; i++) {
 368         values[i] = naNumValue(naVec_get(curve, 2*i)).num;
 369         deltas[i] = naNumValue(naVec_get(curve, 2*i+1)).num;
 370     }
 371
 372     ((SGInterpolator*)globals->get_subsystem_mgr()
 373         ->get_group(SGSubsystemMgr::INIT)->get_subsystem("interpolator"))
 374         ->interpolate(node, nPoints, values, deltas);
 375
 376     delete[] values;
 377     delete[] deltas;
 378     return naNil();
 379 }
 380
 381 // This is a better RNG than the one in the default Nasal distribution
 382 // (which is based on the C library rand() implementation). It will
 383 // override.
 384 static naRef f_rand(naContext c, naRef me, int argc, naRef* args)
 385 {
 386     return naNum(sg_random());
 387 }
 388
 389 static naRef f_srand(naContext c, naRef me, int argc, naRef* args)
 390 {
 391     sg_srandom_time();
 392     return naNum(0);
 393 }
 394
 395 static naRef f_abort(naContext c, naRef me, int argc, naRef* args)
 396 {
 397     abort();
 398     return naNil();
 399 }
 400
 401 // Return an array listing of all files in a directory
 402 static naRef f_directory(naContext c, naRef me, int argc, naRef* args)
 403 {
 404     if(argc != 1 || !naIsString(args[0]))
 405         naRuntimeError(c, "bad arguments to directory()");
 406
 407     simgear::Dir d(SGPath(naStr_data(args[0])));
 408     if(!d.exists()) return naNil();
 409     naRef result = naNewVector(c);
 410
 411     simgear::PathList paths = d.children(simgear::Dir::TYPE_FILE | simgear::Dir::TYPE_DIR);
 412     for (unsigned int i=0; i<paths.size(); ++i) {
 413       std::string p = paths[i].file();
 414       naVec_append(result, naStr_fromdata(naNewString(c), p.c_str(), p.size()));
 415     }
 416
 417     return result;
 418 }
 419
 420 /**
 421  * Given a data path, resolve it in FG_ROOT or an FG_AIRCRFT directory
 422  */
 423 static naRef f_resolveDataPath(naContext c, naRef me, int argc, naRef* args)
 424 {
 425     if(argc != 1 || !naIsString(args[0]))
 426         naRuntimeError(c, "bad arguments to resolveDataPath()");
 427
 428     SGPath p = globals->resolve_maybe_aircraft_path(naStr_data(args[0]));
 429     const char* pdata = p.c_str();
 430     return naStr_fromdata(naNewString(c), const_cast<char*>(pdata), strlen(pdata));
 431 }
 432
 433 // Parse XML file.
 434 //     parsexml(<path> [, <start-tag> [, <end-tag> [, <data> [, <pi>]]]]);
 435 //
 436 // <path>      ... absolute path to an XML file
 437 // <start-tag> ... callback function with two args: tag name, attribute hash
 438 // <end-tag>   ... callback function with one arg:  tag name
 439 // <data>      ... callback function with one arg:  data
 440 // <pi>        ... callback function with two args: target, data
 441 //                 (pi = "processing instruction")
 442 // All four callback functions are optional and default to nil.
 443 // The function returns nil on error, or the validated file name otherwise.
 444 static naRef f_parsexml(naContext c, naRef me, int argc, naRef* args)
 445 {
 446     if(argc < 1 || !naIsString(args[0]))
 447         naRuntimeError(c, "parsexml(): path argument missing or not a string");
 448     if(argc > 5) argc = 5;
 449     for(int i=1; i<argc; i++)
 450         if(!(naIsNil(args[i]) || naIsFunc(args[i])))
 451             naRuntimeError(c, "parsexml(): callback argument not a function");
 452
 453     const char* file = fgValidatePath(naStr_data(args[0]), false);
 454     if(!file) {
 455         naRuntimeError(c, "parsexml(): reading '%s' denied "
 456                 "(unauthorized access)", naStr_data(args[0]));
 457         return naNil();
 458     }
 459     std::ifstream input(file);
 460     NasalXMLVisitor visitor(c, argc, args);
 461     try {
 462         readXML(input, visitor);
 463     } catch (const sg_exception& e) {
 464         naRuntimeError(c, "parsexml(): file '%s' %s",
 465                 file, e.getFormattedMessage().c_str());
 466         return naNil();
 467     }
 468     return naStr_fromdata(naNewString(c), const_cast<char*>(file), strlen(file));
 469 }
 470
 471 // Return UNIX epoch time in seconds.
 472 static naRef f_systime(naContext c, naRef me, int argc, naRef* args)
 473 {
 474 #ifdef _WIN32
 475     FILETIME ft;
 476     GetSystemTimeAsFileTime(&ft);
 477     double t = (4294967296.0 * ft.dwHighDateTime + ft.dwLowDateTime);
 478     // Converts from 100ns units in 1601 epoch to unix epoch in sec
 479     return naNum((t * 1e-7) - 11644473600.0);
 480 #else
 481     struct timeval td;
 482     gettimeofday(&td, 0);
 483     return naNum(td.tv_sec + 1e-6 * td.tv_usec);
 484 #endif
 485 }
 486
 487 // Convert a cartesian point to a geodetic lat/lon/altitude.
 488 static naRef f_carttogeod(naContext c, naRef me, int argc, naRef* args)
 489 {
 490     double lat, lon, alt, xyz[3];
 491     if(argc != 3) naRuntimeError(c, "carttogeod() expects 3 arguments");
 492     for(int i=0; i<3; i++)
 493         xyz[i] = naNumValue(args[i]).num;
 494     sgCartToGeod(xyz, &lat, &lon, &alt);
 495     lat *= SG_RADIANS_TO_DEGREES;
 496     lon *= SG_RADIANS_TO_DEGREES;
 497     naRef vec = naNewVector(c);
 498     naVec_append(vec, naNum(lat));
 499     naVec_append(vec, naNum(lon));
 500     naVec_append(vec, naNum(alt));
 501     return vec;
 502 }
 503
 504 // Convert a geodetic lat/lon/altitude to a cartesian point.
 505 static naRef f_geodtocart(naContext c, naRef me, int argc, naRef* args)
 506 {
 507     if(argc != 3) naRuntimeError(c, "geodtocart() expects 3 arguments");
 508     double lat = naNumValue(args[0]).num * SG_DEGREES_TO_RADIANS;
 509     double lon = naNumValue(args[1]).num * SG_DEGREES_TO_RADIANS;
 510     double alt = naNumValue(args[2]).num;
 511     double xyz[3];
 512     sgGeodToCart(lat, lon, alt, xyz);
 513     naRef vec = naNewVector(c);
 514     naVec_append(vec, naNum(xyz[0]));
 515     naVec_append(vec, naNum(xyz[1]));
 516     naVec_append(vec, naNum(xyz[2]));
 517     return vec;
 518 }
 519
 520 // For given geodetic point return array with elevation, and a material data
 521 // hash, or nil if there's no information available (tile not loaded). If
 522 // information about the material isn't available, then nil is returned instead
 523 // of the hash.
 524 static naRef f_geodinfo(naContext c, naRef me, int argc, naRef* args)
 525 {
 526 #define HASHSET(s,l,n) naHash_set(matdata, naStr_fromdata(naNewString(c),s,l),n)
 527     if(argc < 2 || argc > 3)
 528         naRuntimeError(c, "geodinfo() expects 2 or 3 arguments: lat, lon [, maxalt]");
 529     double lat = naNumValue(args[0]).num;
 530     double lon = naNumValue(args[1]).num;
 531     double elev = argc == 3 ? naNumValue(args[2]).num : 10000;
 532     const SGMaterial *mat;
 533     SGGeod geod = SGGeod::fromDegM(lon, lat, elev);
 534     if(!globals->get_scenery()->get_elevation_m(geod, elev, &mat))
 535         return naNil();
 536     naRef vec = naNewVector(c);
 537     naVec_append(vec, naNum(elev));
 538     naRef matdata = naNil();
 539     if(mat) {
 540         matdata = naNewHash(c);
 541         naRef names = naNewVector(c);
 542         const vector<string> n = mat->get_names();
 543         for(unsigned int i=0; i<n.size(); i++)
 544             naVec_append(names, naStr_fromdata(naNewString(c),
 545                     const_cast<char*>(n[i].c_str()), n[i].size()));
 546         HASHSET("names", 5, names);
 547         HASHSET("solid", 5, naNum(mat->get_solid()));
 548         HASHSET("friction_factor", 15, naNum(mat->get_friction_factor()));
 549         HASHSET("rolling_friction", 16, naNum(mat->get_rolling_friction()));
 550         HASHSET("load_resistance", 15, naNum(mat->get_load_resistance()));
 551         HASHSET("bumpiness", 9, naNum(mat->get_bumpiness()));
 552         HASHSET("light_coverage", 14, naNum(mat->get_light_coverage()));
 553     }
 554     naVec_append(vec, matdata);
 555     return vec;
 556 #undef HASHSET
 557 }
 558
 559 // Expose a radio transmission interface to Nasal.
 560 static naRef f_radioTransmission(naContext c, naRef me, int argc, naRef* args)
 561 {
 562     double lat, lon, elev, heading, pitch;
 563     if(argc != 5) naRuntimeError(c, "radioTransmission() expects 5 arguments");
 564     for(int i=0; i<argc; i++) {
 565         if(naIsNil(args[i]))
 566                 return naNil();
 567     }
 568     lat = naNumValue(args[0]).num;
 569     lon = naNumValue(args[1]).num;
 570     elev = naNumValue(args[2]).num;
 571     heading = naNumValue(args[3]).num;
 572     pitch = naNumValue(args[4]).num;
 573     SGGeod geod = SGGeod::fromDegM(lon, lat, elev * SG_FEET_TO_METER);
 574     FGRadioTransmission *radio = new FGRadioTransmission;
 575     double signal = radio->receiveBeacon(geod, heading, pitch);
 576     delete radio;
 577     return naNum(signal);
 578 }
 579
 580
 581 class AirportInfoFilter : public FGAirport::AirportFilter
 582 {
 583 public:
 584     AirportInfoFilter() : type(FGPositioned::AIRPORT) {
 585     }
 586
 587     virtual FGPositioned::Type minType() const {
 588         return type;
 589     }
 590
 591     virtual FGPositioned::Type maxType() const {
 592         return type;
 593     }
 594
 595     FGPositioned::Type type;
 596 };
 597
 598 // Returns data hash for particular or nearest airport of a <type>, or nil
 599 // on error.
 600 //
 601 // airportinfo(<id>);                   e.g. "KSFO"
 602 // airportinfo(<type>);                 type := ("airport"|"seaport"|"heliport")
 603 // airportinfo()                        same as  airportinfo("airport")
 604 // airportinfo(<lat>, <lon> [, <type>]);
 605 static naRef f_airportinfo(naContext c, naRef me, int argc, naRef* args)
 606 {
 607     static SGConstPropertyNode_ptr latn = fgGetNode("/position/latitude-deg", true);
 608     static SGConstPropertyNode_ptr lonn = fgGetNode("/position/longitude-deg", true);
 609     SGGeod pos;
 610     FGAirport* apt = NULL;
 611
 612     if(argc >= 2 && naIsNum(args[0]) && naIsNum(args[1])) {
 613         pos = SGGeod::fromDeg(args[1].num, args[0].num);
 614         args += 2;
 615         argc -= 2;
 616     } else {
 617         pos = SGGeod::fromDeg(lonn->getDoubleValue(), latn->getDoubleValue());
 618     }
 619
 620     double maxRange = 10000.0; // expose this? or pick a smaller value?
 621
 622     AirportInfoFilter filter; // defaults to airports only
 623
 624     if(argc == 0) {
 625         // fall through and use AIRPORT
 626     } else if(argc == 1 && naIsString(args[0])) {
 627         const char *s = naStr_data(args[0]);
 628         if(!strcmp(s, "airport")) filter.type = FGPositioned::AIRPORT;
 629         else if(!strcmp(s, "seaport")) filter.type = FGPositioned::SEAPORT;
 630         else if(!strcmp(s, "heliport")) filter.type = FGPositioned::HELIPORT;
 631         else {
 632             // user provided an <id>, hopefully
 633             apt = FGAirport::findByIdent(s);
 634             if (!apt) {
 635                 // return nil here, but don't raise a runtime error; this is a
 636                 // legitamate way to validate an ICAO code, for example in a
 637                 // dialog box or similar.
 638                 return naNil();
 639             }
 640         }
 641     } else {
 642         naRuntimeError(c, "airportinfo() with invalid function arguments");
 643         return naNil();
 644     }
 645
 646     if(!apt) {
 647         apt = FGAirport::findClosest(pos, maxRange, &filter);
 648         if(!apt) return naNil();
 649     }
 650
 651     string id = apt->ident();
 652     string name = apt->name();
 653
 654     // set runway hash
 655     naRef rwys = naNewHash(c);
 656     for(unsigned int r=0; r<apt->numRunways(); ++r) {
 657         FGRunway* rwy(apt->getRunwayByIndex(r));
 658
 659         naRef rwyid = naStr_fromdata(naNewString(c),
 660                       const_cast<char *>(rwy->ident().c_str()),
 661                       rwy->ident().length());
 662
 663         naRef rwydata = naNewHash(c);
 664 #define HASHSET(s,l,n) naHash_set(rwydata, naStr_fromdata(naNewString(c),s,l),n)
 665         HASHSET("id", 2, rwyid);
 666         HASHSET("lat", 3, naNum(rwy->latitude()));
 667         HASHSET("lon", 3, naNum(rwy->longitude()));
 668         HASHSET("heading", 7, naNum(rwy->headingDeg()));
 669         HASHSET("length", 6, naNum(rwy->lengthM()));
 670         HASHSET("width", 5, naNum(rwy->widthM()));
 671         HASHSET("threshold", 9, naNum(rwy->displacedThresholdM()));
 672         HASHSET("stopway", 7, naNum(rwy->stopwayM()));
 673
 674         if (rwy->ILS()) {
 675           HASHSET("ils_frequency_mhz", 17, naNum(rwy->ILS()->get_freq() / 100.0));
 676         }
 677
 678         std::vector<flightgear::SID*> sids(rwy->getSIDs());
 679         naRef sidVec = naNewVector(c);
 680
 681         for (unsigned int s=0; s < sids.size(); ++s) {
 682           naRef procId = naStr_fromdata(naNewString(c),
 683                     const_cast<char *>(sids[s]->ident().c_str()),
 684                     sids[s]->ident().length());
 685           naVec_append(sidVec, procId);
 686         }
 687         HASHSET("sids", 4, sidVec);
 688
 689         std::vector<flightgear::STAR*> stars(rwy->getSTARs());
 690         naRef starVec = naNewVector(c);
 691
 692         for (unsigned int s=0; s < stars.size(); ++s) {
 693           naRef procId = naStr_fromdata(naNewString(c),
 694                     const_cast<char *>(stars[s]->ident().c_str()),
 695                     stars[s]->ident().length());
 696           naVec_append(starVec, procId);
 697         }
 698         HASHSET("stars", 5, starVec);
 699
 700 #undef HASHSET
 701         naHash_set(rwys, rwyid, rwydata);
 702     }
 703
 704     // set airport hash
 705     naRef aptdata = naNewHash(c);
 706 #define HASHSET(s,l,n) naHash_set(aptdata, naStr_fromdata(naNewString(c),s,l),n)
 707     HASHSET("id", 2, naStr_fromdata(naNewString(c),
 708             const_cast<char *>(id.c_str()), id.length()));
 709     HASHSET("name", 4, naStr_fromdata(naNewString(c),
 710             const_cast<char *>(name.c_str()), name.length()));
 711     HASHSET("lat", 3, naNum(apt->getLatitude()));
 712     HASHSET("lon", 3, naNum(apt->getLongitude()));
 713     HASHSET("elevation", 9, naNum(apt->getElevation() * SG_FEET_TO_METER));
 714     HASHSET("has_metar", 9, naNum(apt->getMetar()));
 715     HASHSET("runways", 7, rwys);
 716 #undef HASHSET
 717     return aptdata;
 718 }
 719
 720
 721 // Returns vector of data hash for navaid of a <type>, nil on error
 722 // navaids sorted by ascending distance
 723 // navinfo([<lat>,<lon>],[<type>],[<id>])
 724 // lat/lon (numeric): use latitude/longitude instead of ac position
 725 // type:              ("fix"|"vor"|"ndb"|"ils"|"dme"|"tacan"|"any")
 726 // id:                (partial) id of the fix
 727 // examples:
 728 // navinfo("vor")     returns all vors
 729 // navinfo("HAM")     return all navaids who's name start with "HAM"
 730 // navinfo("vor", "HAM") return all vor who's name start with "HAM"
 731 //navinfo(34,48,"vor","HAM") return all vor who's name start with "HAM"
 732 //                           sorted by distance relative to lat=34, lon=48
 733 static naRef f_navinfo(naContext c, naRef me, int argc, naRef* args)
 734 {
 735     static SGConstPropertyNode_ptr latn = fgGetNode("/position/latitude-deg", true);
 736     static SGConstPropertyNode_ptr lonn = fgGetNode("/position/longitude-deg", true);
 737     SGGeod pos;
 738
 739     if(argc >= 2 && naIsNum(args[0]) && naIsNum(args[1])) {
 740         pos = SGGeod::fromDeg(args[1].num, args[0].num);
 741         args += 2;
 742         argc -= 2;
 743     } else {
 744         pos = SGGeod::fromDeg(lonn->getDoubleValue(), latn->getDoubleValue());
 745     }
 746
 747     FGPositioned::Type type = FGPositioned::INVALID;
 748     nav_list_type navlist;
 749     const char * id = "";
 750
 751     if(argc > 0 && naIsString(args[0])) {
 752         const char *s = naStr_data(args[0]);
 753         if(!strcmp(s, "any")) type = FGPositioned::INVALID;
 754         else if(!strcmp(s, "fix")) type = FGPositioned::FIX;
 755         else if(!strcmp(s, "vor")) type = FGPositioned::VOR;
 756         else if(!strcmp(s, "ndb")) type = FGPositioned::NDB;
 757         else if(!strcmp(s, "ils")) type = FGPositioned::ILS;
 758         else if(!strcmp(s, "dme")) type = FGPositioned::DME;
 759         else if(!strcmp(s, "tacan")) type = FGPositioned::TACAN;
 760         else id = s; // this is an id
 761         ++args;
 762         --argc;
 763     }
 764
 765     if(argc > 0 && naIsString(args[0])) {
 766         if( *id != 0 ) {
 767             naRuntimeError(c, "navinfo() called with navaid id");
 768             return naNil();
 769         }
 770         id = naStr_data(args[0]);
 771         ++args;
 772         --argc;
 773     }
 774
 775     if( argc > 0 ) {
 776         naRuntimeError(c, "navinfo() called with too many arguments");
 777         return naNil();
 778     }
 779
 780     navlist = globals->get_navlist()->findByIdentAndFreq( pos, id, 0.0, type );
 781
 782     naRef reply = naNewVector(c);
 783     for( nav_list_type::const_iterator it = navlist.begin(); it != navlist.end(); ++it ) {
 784         const FGNavRecord * nav = *it;
 785
 786         // set navdata hash
 787         naRef navdata = naNewHash(c);
 788 #define HASHSET(s,l,n) naHash_set(navdata, naStr_fromdata(naNewString(c),s,l),n)
 789         HASHSET("id", 2, naStr_fromdata(naNewString(c),
 790             const_cast<char *>(nav->ident().c_str()), nav->ident().length()));
 791         HASHSET("name", 4, naStr_fromdata(naNewString(c),
 792             const_cast<char *>(nav->name().c_str()), nav->name().length()));
 793         HASHSET("frequency", 9, naNum(nav->get_freq()));
 794         HASHSET("lat", 3, naNum(nav->get_lat()));
 795         HASHSET("lon", 3, naNum(nav->get_lon()));
 796         HASHSET("elevation", 9, naNum(nav->get_elev_ft() * SG_FEET_TO_METER));
 797         HASHSET("type", 4, naStr_fromdata(naNewString(c),
 798             const_cast<char *>(nav->nameForType(nav->type())), strlen(nav->nameForType(nav->type()))));
 799         HASHSET("distance", 8, naNum(SGGeodesy::distanceNm( pos, nav->geod() ) * SG_NM_TO_METER ) );
 800         HASHSET("bearing", 7, naNum(SGGeodesy::courseDeg( pos, nav->geod() ) ) );
 801 #undef HASHSET
 802         naVec_append( reply, navdata );
 803     }
 804     return reply;
 805 }
 806
 807 // Table of extension functions.  Terminate with zeros.
 808 static struct { const char* name; naCFunction func; } funcs[] = {
 809     { "getprop",   f_getprop },
 810     { "setprop",   f_setprop },
 811     { "print",     f_print },
 812     { "_fgcommand", f_fgcommand },
 813     { "settimer",  f_settimer },
 814     { "_setlistener", f_setlistener },
 815     { "removelistener", f_removelistener },
 816     { "_cmdarg",  f_cmdarg },
 817     { "_interpolate",  f_interpolate },
 818     { "rand",  f_rand },
 819     { "srand",  f_srand },
 820     { "abort", f_abort },
 821     { "directory", f_directory },
 822     { "resolvepath", f_resolveDataPath },
 823     { "parsexml", f_parsexml },
 824     { "systime", f_systime },
 825     { "carttogeod", f_carttogeod },
 826     { "geodtocart", f_geodtocart },
 827     { "geodinfo", f_geodinfo },
 828     { "airportinfo", f_airportinfo },
 829     { "navinfo", f_navinfo },
 830     { "radioTransmission", f_radioTransmission },
 831     { 0, 0 }
 832 };
 833
 834 naRef FGNasalSys::cmdArgGhost()
 835 {
 836     return propNodeGhost(_cmdArg);
 837 }
 838
 839 void FGNasalSys::init()
 840 {
 841     int i;
 842
 843     _context = naNewContext();
 844
 845     // Start with globals.  Add it to itself as a recursive
 846     // sub-reference under the name "globals".  This gives client-code
 847     // write access to the namespace if someone wants to do something
 848     // fancy.
 849     _globals = naInit_std(_context);
 850     naSave(_context, _globals);
 851     hashset(_globals, "globals", _globals);
 852
 853     hashset(_globals, "math", naInit_math(_context));
 854     hashset(_globals, "bits", naInit_bits(_context));
 855     hashset(_globals, "io", naInit_io(_context));
 856     hashset(_globals, "thread", naInit_thread(_context));
 857     hashset(_globals, "utf8", naInit_utf8(_context));
 858
 859     // Add our custom extension functions:
 860     for(i=0; funcs[i].name; i++)
 861         hashset(_globals, funcs[i].name,
 862                 naNewFunc(_context, naNewCCode(_context, funcs[i].func)));
 863
 864     // And our SGPropertyNode wrapper
 865     hashset(_globals, "props", genPropsModule());
 866
 867     // Make a "__gcsave" hash to hold the naRef objects which get
 868     // passed to handles outside the interpreter (to protect them from
 869     // begin garbage-collected).
 870     _gcHash = naNewHash(_context);
 871     hashset(_globals, "__gcsave", _gcHash);
 872
 873     // Now load the various source files in the Nasal directory
 874     simgear::Dir nasalDir(SGPath(globals->get_fg_root(), "Nasal"));
 875     loadScriptDirectory(nasalDir);
 876
 877     // Add modules in Nasal subdirectories to property tree
 878     simgear::PathList directories = nasalDir.children(simgear::Dir::TYPE_DIR+
 879             simgear::Dir::NO_DOT_OR_DOTDOT, "");
 880     for (unsigned int i=0; i<directories.size(); ++i) {
 881         simgear::Dir dir(directories[i]);
 882         simgear::PathList scripts = dir.children(simgear::Dir::TYPE_FILE, ".nas");
 883         addModule(directories[i].file(), scripts);
 884     }
 885
 886     // set signal and remove node to avoid restoring at reinit
 887     const char *s = "nasal-dir-initialized";
 888     SGPropertyNode *signal = fgGetNode("/sim/signals", true);
 889     signal->setBoolValue(s, true);
 890     signal->removeChildren(s, false);
 891
 892     // Pull scripts out of the property tree, too
 893     loadPropertyScripts();
 894 }
 895
 896 void FGNasalSys::update(double)
 897 {
 898     if(!_dead_listener.empty()) {
 899         vector<FGNasalListener *>::iterator it, end = _dead_listener.end();
 900         for(it = _dead_listener.begin(); it != end; ++it) delete *it;
 901         _dead_listener.clear();
 902     }
 903
 904     // The global context is a legacy thing.  We use dynamically
 905     // created contexts for naCall() now, so that we can call them
 906     // recursively.  But there are still spots that want to use it for
 907     // naNew*() calls, which end up leaking memory because the context
 908     // only clears out its temporary vector when it's *used*.  So just
 909     // junk it and fetch a new/reinitialized one every frame.  This is
 910     // clumsy: the right solution would use the dynamic context in all
 911     // cases and eliminate _context entirely.  But that's more work,
 912     // and this works fine (yes, they say "New" and "Free", but
 913     // they're very fast, just trust me). -Andy
 914     naFreeContext(_context);
 915     _context = naNewContext();
 916 }
 917
 918 bool pathSortPredicate(const SGPath& p1, const SGPath& p2)
 919 {
 920   return p1.file() < p2.file();
 921 }
 922
 923 // Loads all scripts in given directory
 924 void FGNasalSys::loadScriptDirectory(simgear::Dir nasalDir)
 925 {
 926     simgear::PathList scripts = nasalDir.children(simgear::Dir::TYPE_FILE, ".nas");
 927     // sort scripts, avoid loading sequence effects due to file system's
 928     // random directory order
 929     std::sort(scripts.begin(), scripts.end(), pathSortPredicate);
 930
 931     for (unsigned int i=0; i<scripts.size(); ++i) {
 932       SGPath fullpath(scripts[i]);
 933       SGPath file = fullpath.file();
 934       loadModule(fullpath, file.base().c_str());
 935     }
 936 }
 937
 938 // Create module with list of scripts
 939 void FGNasalSys::addModule(string moduleName, simgear::PathList scripts)
 940 {
 941     if (scripts.size()>0)
 942     {
 943         SGPropertyNode* nasal = globals->get_props()->getNode("nasal");
 944         SGPropertyNode* module_node = nasal->getChild(moduleName,0,true);
 945         for (unsigned int i=0; i<scripts.size(); ++i) {
 946             SGPropertyNode* pFileNode = module_node->getChild("file",i,true);
 947             pFileNode->setStringValue(scripts[i].c_str());
 948         }
 949         if (!module_node->hasChild("enabled",0))
 950         {
 951             SGPropertyNode* node = module_node->getChild("enabled",0,true);
 952             node->setBoolValue(true);
 953             node->setAttribute(SGPropertyNode::USERARCHIVE,true);
 954         }
 955     }
 956 }
 957
 958 // Loads the scripts found under /nasal in the global tree
 959 void FGNasalSys::loadPropertyScripts()
 960 {
 961     SGPropertyNode* nasal = globals->get_props()->getNode("nasal");
 962     if(!nasal) return;
 963
 964     for(int i=0; i<nasal->nChildren(); i++)
 965     {
 966         SGPropertyNode* n = nasal->getChild(i);
 967         loadPropertyScripts(n);
 968     }
 969 }
 970
 971 // Loads the scripts found under /nasal in the global tree
 972 void FGNasalSys::loadPropertyScripts(SGPropertyNode* n)
 973 {
 974     bool is_loaded = false;
 975
 976     const char* module = n->getName();
 977     if(n->hasChild("module"))
 978         module = n->getStringValue("module");
 979     if (n->getBoolValue("enabled",true))
 980     {
 981         // allow multiple files to be specified within a single
 982         // Nasal module tag
 983         int j = 0;
 984         SGPropertyNode *fn;
 985         bool file_specified = false;
 986         bool ok=true;
 987         while((fn = n->getChild("file", j)) != NULL) {
 988             file_specified = true;
 989             const char* file = fn->getStringValue();
 990             SGPath p(file);
 991             if (!p.isAbsolute() || !p.exists())
 992             {
 993                 p = globals->resolve_maybe_aircraft_path(file);
 994                 if (p.isNull())
 995                 {
 996                     SG_LOG(SG_NASAL, SG_ALERT, "Cannot find Nasal script '" <<
 997                             file << "' for module '" << module << "'.");
 998                 }
 999             }
1000             ok &= p.isNull() ? false : loadModule(p, module);
1001             j++;
1002         }
1003
1004         const char* src = n->getStringValue("script");
1005         if(!n->hasChild("script")) src = 0; // Hrm...
1006         if(src)
1007             createModule(module, n->getPath().c_str(), src, strlen(src));
1008
1009         if(!file_specified && !src)
1010         {
1011             // module no longer exists - clear the archived "enable" flag
1012             n->setAttribute(SGPropertyNode::USERARCHIVE,false);
1013             SGPropertyNode* node = n->getChild("enabled",0,false);
1014             if (node)
1015                 node->setAttribute(SGPropertyNode::USERARCHIVE,false);
1016
1017             SG_LOG(SG_NASAL, SG_ALERT, "Nasal error: " <<
1018                     "no <file> or <script> defined in " <<
1019                     "/nasal/" << module);
1020         }
1021         else
1022             is_loaded = ok;
1023     }
1024     else
1025     {
1026         SGPropertyNode* enable = n->getChild("enabled");
1027         if (enable)
1028         {
1029             FGNasalModuleListener* listener = new FGNasalModuleListener(n);
1030             enable->addChangeListener(listener, false);
1031         }
1032     }
1033     SGPropertyNode* loaded = n->getChild("loaded",0,true);
1034     loaded->setAttribute(SGPropertyNode::PRESERVE,true);
1035     loaded->setBoolValue(is_loaded);
1036 }
1037
1038 // Logs a runtime error, with stack trace, to the FlightGear log stream
1039 void FGNasalSys::logError(naContext context)
1040 {
1041     SG_LOG(SG_NASAL, SG_ALERT,
1042            "Nasal runtime error: " << naGetError(context));
1043     SG_LOG(SG_NASAL, SG_ALERT,
1044            "  at " << naStr_data(naGetSourceFile(context, 0)) <<
1045            ", line " << naGetLine(context, 0));
1046     for(int i=1; i<naStackDepth(context); i++)
1047         SG_LOG(SG_NASAL, SG_ALERT,
1048                "  called from: " << naStr_data(naGetSourceFile(context, i)) <<
1049                ", line " << naGetLine(context, i));
1050 }
1051
1052 // Reads a script file, executes it, and places the resulting
1053 // namespace into the global namespace under the specified module
1054 // name.
1055 bool FGNasalSys::loadModule(SGPath file, const char* module)
1056 {
1057     int len = 0;
1058     char* buf = readfile(file.c_str(), &len);
1059     if(!buf) {
1060         SG_LOG(SG_NASAL, SG_ALERT,
1061                "Nasal error: could not read script file " << file.c_str()
1062                << " into module " << module);
1063         return false;
1064     }
1065
1066     bool ok = createModule(module, file.c_str(), buf, len);
1067     delete[] buf;
1068     return ok;
1069 }
1070
1071 // Parse and run.  Save the local variables namespace, as it will
1072 // become a sub-object of globals.  The optional "arg" argument can be
1073 // used to pass an associated property node to the module, which can then
1074 // be accessed via cmdarg().  (This is, for example, used by XML dialogs.)
1075 bool FGNasalSys::createModule(const char* moduleName, const char* fileName,
1076                               const char* src, int len,
1077                               const SGPropertyNode* cmdarg,
1078                               int argc, naRef* args)
1079 {
1080     naRef code = parse(fileName, src, len);
1081     if(naIsNil(code))
1082         return false;
1083
1084     // See if we already have a module hash to use.  This allows the
1085     // user to, for example, add functions to the built-in math
1086     // module.  Make a new one if necessary.
1087     naRef locals;
1088     naRef modname = naNewString(_context);
1089     naStr_fromdata(modname, (char*)moduleName, strlen(moduleName));
1090     if(!naHash_get(_globals, modname, &locals))
1091         locals = naNewHash(_context);
1092
1093     _cmdArg = (SGPropertyNode*)cmdarg;
1094
1095     call(code, argc, args, locals);
1096     hashset(_globals, moduleName, locals);
1097     return true;
1098 }
1099
1100 void FGNasalSys::deleteModule(const char* moduleName)
1101 {
1102     naRef modname = naNewString(_context);
1103     naStr_fromdata(modname, (char*)moduleName, strlen(moduleName));
1104     naHash_delete(_globals, modname);
1105 }
1106
1107 naRef FGNasalSys::parse(const char* filename, const char* buf, int len)
1108 {
1109     int errLine = -1;
1110     naRef srcfile = naNewString(_context);
1111     naStr_fromdata(srcfile, (char*)filename, strlen(filename));
1112     naRef code = naParseCode(_context, srcfile, 1, (char*)buf, len, &errLine);
1113     if(naIsNil(code)) {
1114         SG_LOG(SG_NASAL, SG_ALERT,
1115                "Nasal parse error: " << naGetError(_context) <<
1116                " in "<< filename <<", line " << errLine);
1117         return naNil();
1118     }
1119
1120     // Bind to the global namespace before returning
1121     return naBindFunction(_context, code, _globals);
1122 }
1123
1124 bool FGNasalSys::handleCommand(const SGPropertyNode* arg)
1125 {
1126     const char* nasal = arg->getStringValue("script");
1127     const char* moduleName = arg->getStringValue("module");
1128     naRef code = parse(arg->getPath(true).c_str(), nasal, strlen(nasal));
1129     if(naIsNil(code)) return false;
1130
1131     // Commands can be run "in" a module.  Make sure that module
1132     // exists, and set it up as the local variables hash for the
1133     // command.
1134     naRef locals = naNil();
1135     if(moduleName[0]) {
1136         naRef modname = naNewString(_context);
1137         naStr_fromdata(modname, (char*)moduleName, strlen(moduleName));
1138         if(!naHash_get(_globals, modname, &locals)) {
1139             locals = naNewHash(_context);
1140             naHash_set(_globals, modname, locals);
1141         }
1142     }
1143
1144     // Cache this command's argument for inspection via cmdarg().  For
1145     // performance reasons, we won't bother with it if the invoked
1146     // code doesn't need it.
1147     _cmdArg = (SGPropertyNode*)arg;
1148
1149     call(code, 0, 0, locals);
1150     return true;
1151 }
1152
1153 // settimer(func, dt, simtime) extension function.  The first argument
1154 // is a Nasal function to call, the second is a delta time (from now),
1155 // in seconds.  The third, if present, is a boolean value indicating
1156 // that "real world" time (rather than simulator time) is to be used.
1157 //
1158 // Implementation note: the FGTimer objects don't live inside the
1159 // garbage collector, so the Nasal handler functions have to be
1160 // "saved" somehow lest they be inadvertently cleaned.  In this case,
1161 // they are inserted into a globals.__gcsave hash and removed on
1162 // expiration.
1163 void FGNasalSys::setTimer(naContext c, int argc, naRef* args)
1164 {
1165     // Extract the handler, delta, and simtime arguments:
1166     naRef handler = argc > 0 ? args[0] : naNil();
1167     if(!(naIsCode(handler) || naIsCCode(handler) || naIsFunc(handler))) {
1168         naRuntimeError(c, "settimer() with invalid function argument");
1169         return;
1170     }
1171
1172     naRef delta = argc > 1 ? args[1] : naNil();
1173     if(naIsNil(delta)) {
1174         naRuntimeError(c, "settimer() with invalid time argument");
1175         return;
1176     }
1177
1178     bool simtime = (argc > 2 && naTrue(args[2])) ? false : true;
1179
1180     // Generate and register a C++ timer handler
1181     NasalTimer* t = new NasalTimer;
1182     t->handler = handler;
1183     t->gcKey = gcSave(handler);
1184     t->nasal = this;
1185
1186     globals->get_event_mgr()->addEvent("NasalTimer",
1187                                        t, &NasalTimer::timerExpired,
1188                                        delta.num, simtime);
1189 }
1190
1191 void FGNasalSys::handleTimer(NasalTimer* t)
1192 {
1193     call(t->handler, 0, 0, naNil());
1194     gcRelease(t->gcKey);
1195 }
1196
1197 int FGNasalSys::gcSave(naRef r)
1198 {
1199     int key = _nextGCKey++;
1200     naHash_set(_gcHash, naNum(key), r);
1201     return key;
1202 }
1203
1204 void FGNasalSys::gcRelease(int key)
1205 {
1206     naHash_delete(_gcHash, naNum(key));
1207 }
1208
1209 void FGNasalSys::NasalTimer::timerExpired()
1210 {
1211     nasal->handleTimer(this);
1212     delete this;
1213 }
1214
1215 int FGNasalSys::_listenerId = 0;
1216
1217 // setlistener(<property>, <func> [, <initial=0> [, <persistent=1>]])
1218 // Attaches a callback function to a property (specified as a global
1219 // property path string or a SGPropertyNode_ptr* ghost). If the third,
1220 // optional argument (default=0) is set to 1, then the function is also
1221 // called initially. If the fourth, optional argument is set to 0, then the
1222 // function is only called when the property node value actually changes.
1223 // Otherwise it's called independent of the value whenever the node is
1224 // written to (default). The setlistener() function returns a unique
1225 // id number, which is to be used as argument to the removelistener()
1226 // function.
1227 naRef FGNasalSys::setListener(naContext c, int argc, naRef* args)
1228 {
1229     SGPropertyNode_ptr node;
1230     naRef prop = argc > 0 ? args[0] : naNil();
1231     if(naIsString(prop)) node = fgGetNode(naStr_data(prop), true);
1232     else if(naIsGhost(prop)) node = *(SGPropertyNode_ptr*)naGhost_ptr(prop);
1233     else {
1234         naRuntimeError(c, "setlistener() with invalid property argument");
1235         return naNil();
1236     }
1237
1238     if(node->isTied())
1239         SG_LOG(SG_NASAL, SG_DEBUG, "Attaching listener to tied property " <<
1240                 node->getPath());
1241
1242     naRef code = argc > 1 ? args[1] : naNil();
1243     if(!(naIsCode(code) || naIsCCode(code) || naIsFunc(code))) {
1244         naRuntimeError(c, "setlistener() with invalid function argument");
1245         return naNil();
1246     }
1247
1248     int init = argc > 2 && naIsNum(args[2]) ? int(args[2].num) : 0;
1249     int type = argc > 3 && naIsNum(args[3]) ? int(args[3].num) : 1;
1250     FGNasalListener *nl = new FGNasalListener(node, code, this,
1251             gcSave(code), _listenerId, init, type);
1252
1253     node->addChangeListener(nl, init != 0);
1254
1255     _listener[_listenerId] = nl;
1256     return naNum(_listenerId++);
1257 }
1258
1259 // removelistener(int) extension function. The argument is the id of
1260 // a listener as returned by the setlistener() function.
1261 naRef FGNasalSys::removeListener(naContext c, int argc, naRef* args)
1262 {
1263     naRef id = argc > 0 ? args[0] : naNil();
1264     map<int, FGNasalListener *>::iterator it = _listener.find(int(id.num));
1265
1266     if(!naIsNum(id) || it == _listener.end() || it->second->_dead) {
1267         naRuntimeError(c, "removelistener() with invalid listener id");
1268         return naNil();
1269     }
1270
1271     it->second->_dead = true;
1272     _dead_listener.push_back(it->second);
1273     _listener.erase(it);
1274     return naNum(_listener.size());
1275 }
1276
1277
1278
1279 // FGNasalListener class.
1280
1281 FGNasalListener::FGNasalListener(SGPropertyNode *node, naRef code,
1282                                  FGNasalSys* nasal, int key, int id,
1283                                  int init, int type) :
1284     _node(node),
1285     _code(code),
1286     _gcKey(key),
1287     _id(id),
1288     _nas(nasal),
1289     _init(init),
1290     _type(type),
1291     _active(0),
1292     _dead(false),
1293     _last_int(0L),
1294     _last_float(0.0)
1295 {
1296     if(_type == 0 && !_init)
1297         changed(node);
1298 }
1299
1300 FGNasalListener::~FGNasalListener()
1301 {
1302     _node->removeChangeListener(this);
1303     _nas->gcRelease(_gcKey);
1304 }
1305
1306 void FGNasalListener::call(SGPropertyNode* which, naRef mode)
1307 {
1308     if(_active || _dead) return;
1309     SG_LOG(SG_NASAL, SG_DEBUG, "trigger listener #" << _id);
1310     _active++;
1311     naRef arg[4];
1312     arg[0] = _nas->propNodeGhost(which);
1313     arg[1] = _nas->propNodeGhost(_node);
1314     arg[2] = mode;                  // value changed, child added/removed
1315     arg[3] = naNum(_node != which); // child event?
1316     _nas->call(_code, 4, arg, naNil());
1317     _active--;
1318 }
1319
1320 void FGNasalListener::valueChanged(SGPropertyNode* node)
1321 {
1322     if(_type < 2 && node != _node) return;   // skip child events
1323     if(_type > 0 || changed(_node) || _init)
1324         call(node, naNum(0));
1325
1326     _init = 0;
1327 }
1328
1329 void FGNasalListener::childAdded(SGPropertyNode*, SGPropertyNode* child)
1330 {
1331     if(_type == 2) call(child, naNum(1));
1332 }
1333
1334 void FGNasalListener::childRemoved(SGPropertyNode*, SGPropertyNode* child)
1335 {
1336     if(_type == 2) call(child, naNum(-1));
1337 }
1338
1339 bool FGNasalListener::changed(SGPropertyNode* node)
1340 {
1341     using namespace simgear;
1342     props::Type type = node->getType();
1343     if(type == props::NONE) return false;
1344     if(type == props::UNSPECIFIED) return true;
1345
1346     bool result;
1347     switch(type) {
1348     case props::BOOL:
1349     case props::INT:
1350     case props::LONG:
1351         {
1352             long l = node->getLongValue();
1353             result = l != _last_int;
1354             _last_int = l;
1355             return result;
1356         }
1357     case props::FLOAT:
1358     case props::DOUBLE:
1359         {
1360             double d = node->getDoubleValue();
1361             result = d != _last_float;
1362             _last_float = d;
1363             return result;
1364         }
1365     default:
1366         {
1367             string s = node->getStringValue();
1368             result = s != _last_string;
1369             _last_string = s;
1370             return result;
1371         }
1372     }
1373 }
1374
1375
1376
1377 // FGNasalModelData class.  If sgLoad3DModel() is called with a pointer to
1378 // such a class, then it lets modelLoaded() run the <load> script, and the
1379 // destructor the <unload> script. The latter happens when the model branch
1380 // is removed from the scene graph.
1381
1382 unsigned int FGNasalModelData::_module_id = 0;
1383
1384 void FGNasalModelData::modelLoaded(const string& path, SGPropertyNode *prop,
1385                                    osg::Node *)
1386 {
1387     if(!prop)
1388         return;
1389     SGPropertyNode *nasal = prop->getNode("nasal");
1390     if(!nasal)
1391         return;
1392
1393     SGPropertyNode *load = nasal->getNode("load");
1394     _unload = nasal->getNode("unload");
1395     if(!load && !_unload)
1396         return;
1397
1398     std::stringstream m;
1399     m << "__model" << _module_id++;
1400     _module = m.str();
1401
1402     const char *s = load ? load->getStringValue() : "";
1403
1404     naRef arg[2];
1405     arg[0] = nasalSys->propNodeGhost(_root);
1406     arg[1] = nasalSys->propNodeGhost(prop);
1407     nasalSys->createModule(_module.c_str(), path.c_str(), s, strlen(s),
1408                            _root, 2, arg);
1409 }
1410
1411 FGNasalModelData::~FGNasalModelData()
1412 {
1413     if(_module.empty())
1414         return;
1415
1416     if(!nasalSys) {
1417         SG_LOG(SG_NASAL, SG_WARN, "Trying to run an <unload> script "
1418                 "without Nasal subsystem present.");
1419         return;
1420     }
1421
1422     if(_unload) {
1423         const char *s = _unload->getStringValue();
1424         nasalSys->createModule(_module.c_str(), _module.c_str(), s, strlen(s), _root);
1425     }
1426     nasalSys->deleteModule(_module.c_str());
1427 }
1428
1429
1430
1431 // NasalXMLVisitor class: handles EasyXML visitor callback for parsexml()
1432 //
1433 NasalXMLVisitor::NasalXMLVisitor(naContext c, int argc, naRef* args) :
1434     _c(naSubContext(c)),
1435     _start_element(argc > 1 ? args[1] : naNil()),
1436     _end_element(argc > 2 ? args[2] : naNil()),
1437     _data(argc > 3 ? args[3] : naNil()),
1438     _pi(argc > 4 ? args[4] : naNil())
1439 {
1440 }
1441
1442 void NasalXMLVisitor::startElement(const char* tag, const XMLAttributes& a)
1443 {
1444     if(naIsNil(_start_element)) return;
1445     naRef attr = naNewHash(_c);
1446     for(int i=0; i<a.size(); i++) {
1447         naRef name = make_string(a.getName(i));
1448         naRef value = make_string(a.getValue(i));
1449         naHash_set(attr, name, value);
1450     }
1451     call(_start_element, 2, make_string(tag), attr);
1452 }
1453
1454 void NasalXMLVisitor::endElement(const char* tag)
1455 {
1456     if(!naIsNil(_end_element)) call(_end_element, 1, make_string(tag));
1457 }
1458
1459 void NasalXMLVisitor::data(const char* str, int len)
1460 {
1461     if(!naIsNil(_data)) call(_data, 1, make_string(str, len));
1462 }
1463
1464 void NasalXMLVisitor::pi(const char* target, const char* data)
1465 {
1466     if(!naIsNil(_pi)) call(_pi, 2, make_string(target), make_string(data));
1467 }
1468
1469 void NasalXMLVisitor::call(naRef func, int num, naRef a, naRef b)
1470 {
1471     naRef args[2];
1472     args[0] = a;
1473     args[1] = b;
1474     naCall(_c, func, num, args, naNil(), naNil());
1475     if(naGetError(_c))
1476         naRethrowError(_c);
1477 }
1478
1479 naRef NasalXMLVisitor::make_string(const char* s, int n)
1480 {
1481     return naStr_fromdata(naNewString(_c), const_cast<char *>(s),
1482                           n < 0 ? strlen(s) : n);
1483 }
1484
1485