src/Scripting/NasalSys.cxx

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