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