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