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