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