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