src/Scripting/NasalSys.cxx

   1
   2 #ifdef HAVE_CONFIG_H
   3 #  include "config.h"
   4 #endif
   5
   6 #ifdef HAVE_WINDOWS_H
   7 #include <windows.h>
   8 #endif
   9
  10 #ifdef HAVE_SYS_TIME_H
  11 #  include <sys/time.h>  // gettimeofday
  12 #endif
  13
  14 #include <string.h>
  15 #include <errno.h>
  16 #include <stdio.h>
  17 #include <sys/types.h>
  18 #include <sys/stat.h>
  19 #include <fstream>
  20 #include <sstream>
  21
  22 #include <simgear/nasal/nasal.h>
  23 #include <simgear/nasal/iolib.h>
  24 #include <simgear/props/props.hxx>
  25 #include <simgear/math/sg_random.h>
  26 #include <simgear/misc/sg_path.hxx>
  27 #include <simgear/misc/sg_dir.hxx>
  28 #include <simgear/misc/SimpleMarkdown.hxx>
  29 #include <simgear/structure/commands.hxx>
  30 #include <simgear/math/sg_geodesy.hxx>
  31 #include <simgear/structure/event_mgr.hxx>
  32 #include <simgear/debug/BufferedLogCallback.hxx>
  33
  34 #include <simgear/nasal/cppbind/from_nasal.hxx>
  35 #include <simgear/nasal/cppbind/to_nasal.hxx>
  36 #include <simgear/nasal/cppbind/Ghost.hxx>
  37 #include <simgear/nasal/cppbind/NasalHash.hxx>
  38
  39 #include "NasalSGPath.hxx"
  40 #include "NasalSys.hxx"
  41 #include "NasalSys_private.hxx"
  42 #include "NasalAircraft.hxx"
  43 #include "NasalModelData.hxx"
  44 #include "NasalPositioned.hxx"
  45 #include "NasalCanvas.hxx"
  46 #include "NasalClipboard.hxx"
  47 #include "NasalCondition.hxx"
  48 #include "NasalHTTP.hxx"
  49 #include "NasalString.hxx"
  50
  51 #include <Main/globals.hxx>
  52 #include <Main/util.hxx>
  53 #include <Main/fg_props.hxx>
  54
  55 using std::map;
  56 using std::string;
  57 using std::vector;
  58
  59 void postinitNasalGUI(naRef globals, naContext c);
  60
  61 static FGNasalSys* nasalSys = 0;
  62
  63 // Listener class for loading Nasal modules on demand
  64 class FGNasalModuleListener : public SGPropertyChangeListener
  65 {
  66 public:
  67     FGNasalModuleListener(SGPropertyNode* node);
  68
  69     virtual void valueChanged(SGPropertyNode* node);
  70
  71 private:
  72     SGPropertyNode_ptr _node;
  73 };
  74
  75 FGNasalModuleListener::FGNasalModuleListener(SGPropertyNode* node) : _node(node)
  76 {
  77 }
  78
  79 void FGNasalModuleListener::valueChanged(SGPropertyNode*)
  80 {
  81     if (_node->getBoolValue("enabled",false)&&
  82         !_node->getBoolValue("loaded",true))
  83     {
  84         nasalSys->loadPropertyScripts(_node);
  85     }
  86 }
  87
  88 //////////////////////////////////////////////////////////////////////////
  89
  90
  91 class TimerObj : public SGReferenced
  92 {
  93 public:
  94   TimerObj(FGNasalSys* sys, naRef f, naRef self, double interval) :
  95     _sys(sys),
  96     _func(f),
  97     _self(self),
  98     _isRunning(false),
  99     _interval(interval),
 100     _singleShot(false)
 101   {
 102     char nm[128];
 103     snprintf(nm, 128, "nasal-timer-%p", this);
 104     _name = nm;
 105     _gcRoot =  sys->gcSave(f);
 106     _gcSelf = sys->gcSave(self);
 107   }
 108
 109   virtual ~TimerObj()
 110   {
 111     stop();
 112     _sys->gcRelease(_gcRoot);
 113     _sys->gcRelease(_gcSelf);
 114   }
 115
 116   bool isRunning() const { return _isRunning; }
 117
 118   void stop()
 119   {
 120     if (_isRunning) {
 121       globals->get_event_mgr()->removeTask(_name);
 122       _isRunning = false;
 123     }
 124   }
 125
 126   void start()
 127   {
 128     if (_isRunning) {
 129       return;
 130     }
 131
 132     _isRunning = true;
 133     if (_singleShot) {
 134       globals->get_event_mgr()->addEvent(_name, this, &TimerObj::invoke, _interval);
 135     } else {
 136       globals->get_event_mgr()->addTask(_name, this, &TimerObj::invoke,
 137                                         _interval, _interval /* delay */);
 138     }
 139   }
 140
 141   // stop and then start -
 142   void restart(double newInterval)
 143   {
 144     _interval = newInterval;
 145     stop();
 146     start();
 147   }
 148
 149   void invoke()
 150   {
 151     if( _singleShot )
 152       // Callback may restart the timer, so update status before callback is
 153       // called (Prevent warnings of deleting not existing tasks from the
 154       // event manager).
 155       _isRunning = false;
 156
 157     naRef *args = NULL;
 158     _sys->callMethod(_func, _self, 0, args, naNil() /* locals */);
 159   }
 160
 161   void setSingleShot(bool aSingleShot)
 162   {
 163     _singleShot = aSingleShot;
 164   }
 165
 166   bool isSingleShot() const
 167   { return _singleShot; }
 168 private:
 169   std::string _name;
 170   FGNasalSys* _sys;
 171   naRef _func, _self;
 172   int _gcRoot, _gcSelf;
 173   bool _isRunning;
 174   double _interval;
 175   bool _singleShot;
 176 };
 177
 178 typedef SGSharedPtr<TimerObj> TimerObjRef;
 179 typedef nasal::Ghost<TimerObjRef> NasalTimerObj;
 180
 181 ///////////////////////////////////////////////////////////////////////////
 182
 183 // Read and return file contents in a single buffer.  Note use of
 184 // stat() to get the file size.  This is a win32 function, believe it
 185 // or not. :) Note the REALLY IMPORTANT use of the "b" flag to fopen.
 186 // Text mode brain damage will kill us if we're trying to do bytewise
 187 // I/O.
 188 static char* readfile(const char* file, int* lenOut)
 189 {
 190     struct stat data;
 191     if(stat(file, &data) != 0) return 0;
 192     FILE* f = fopen(file, "rb");
 193     if(!f) return 0;
 194     char* buf = new char[data.st_size];
 195     *lenOut = fread(buf, 1, data.st_size, f);
 196     fclose(f);
 197     if(*lenOut != data.st_size) {
 198         // Shouldn't happen, but warn anyway since it represents a
 199         // platform bug and not a typical runtime error (missing file,
 200         // etc...)
 201         SG_LOG(SG_NASAL, SG_ALERT,
 202                "ERROR in Nasal initialization: " <<
 203                "short count returned from fread() of " << file <<
 204                ".  Check your C library!");
 205         delete[] buf;
 206         return 0;
 207     }
 208     return buf;
 209 }
 210
 211 FGNasalSys::FGNasalSys() :
 212     _inited(false)
 213 {
 214     nasalSys = this;
 215     _context = 0;
 216     _globals = naNil();
 217     _string = naNil();
 218     _wrappedNodeFunc = naNil();
 219
 220     _log = new simgear::BufferedLogCallback(SG_NASAL, SG_INFO);
 221     _log->truncateAt(255);
 222     sglog().addCallback(_log);
 223
 224     naSetErrorHandler(&logError);
 225 }
 226
 227 // Utility.  Sets a named key in a hash by C string, rather than nasal
 228 // string object.
 229 void FGNasalSys::hashset(naRef hash, const char* key, naRef val)
 230 {
 231     naRef s = naNewString(_context);
 232     naStr_fromdata(s, (char*)key, strlen(key));
 233     naHash_set(hash, s, val);
 234 }
 235
 236 void FGNasalSys::globalsSet(const char* key, naRef val)
 237 {
 238   hashset(_globals, key, val);
 239 }
 240
 241 naRef FGNasalSys::call(naRef code, int argc, naRef* args, naRef locals)
 242 {
 243   return callMethod(code, naNil(), argc, args, locals);
 244 }
 245
 246 naRef FGNasalSys::callWithContext(naContext ctx, naRef code, int argc, naRef* args, naRef locals)
 247 {
 248   return callMethodWithContext(ctx, code, naNil(), argc, args, locals);
 249 }
 250
 251 // Does a naCall() in a new context.  Wrapped here to make lock
 252 // tracking easier.  Extension functions are called with the lock, but
 253 // we have to release it before making a new naCall().  So rather than
 254 // drop the lock in every extension function that might call back into
 255 // Nasal, we keep a stack depth counter here and only unlock/lock
 256 // around the naCall if it isn't the first one.
 257
 258 naRef FGNasalSys::callMethod(naRef code, naRef self, int argc, naRef* args, naRef locals)
 259 {
 260   return naCallMethod(code, self, argc, args, locals);
 261 }
 262
 263 naRef FGNasalSys::callMethodWithContext(naContext ctx, naRef code, naRef self, int argc, naRef* args, naRef locals)
 264 {
 265   return naCallMethodCtx(ctx, code, self, argc, args, locals);
 266 }
 267
 268 FGNasalSys::~FGNasalSys()
 269 {
 270     if (_inited) {
 271         SG_LOG(SG_GENERAL, SG_ALERT, "Nasal was not shutdown");
 272     }
 273     nasalSys = 0;
 274 }
 275
 276 bool FGNasalSys::parseAndRun(const char* sourceCode)
 277 {
 278     naContext ctx = naNewContext();
 279     naRef code = parse(ctx, "FGNasalSys::parseAndRun()", sourceCode,
 280                        strlen(sourceCode));
 281     if(naIsNil(code)) {
 282         naFreeContext(ctx);
 283         return false;
 284     }
 285     callWithContext(ctx, code, 0, 0, naNil());
 286     naFreeContext(ctx);
 287     return true;
 288 }
 289
 290 #if 0
 291 FGNasalScript* FGNasalSys::parseScript(const char* src, const char* name)
 292 {
 293     FGNasalScript* script = new FGNasalScript();
 294     script->_gcKey = -1; // important, if we delete it on a parse
 295     script->_nas = this; // error, don't clobber a real handle!
 296
 297     char buf[256];
 298     if(!name) {
 299         sprintf(buf, "FGNasalScript@%p", (void *)script);
 300         name = buf;
 301     }
 302
 303     script->_code = parse(name, src, strlen(src));
 304     if(naIsNil(script->_code)) {
 305         delete script;
 306         return 0;
 307     }
 308
 309     script->_gcKey = gcSave(script->_code);
 310     return script;
 311 }
 312 #endif
 313
 314 // The get/setprop functions accept a *list* of strings and walk
 315 // through the property tree with them to find the appropriate node.
 316 // This allows a Nasal object to hold onto a property path and use it
 317 // like a node object, e.g. setprop(ObjRoot, "size-parsecs", 2.02).  This
 318 // is the utility function that walks the property tree.
 319 static SGPropertyNode* findnode(naContext c, naRef* vec, int len, bool create=false)
 320 {
 321     SGPropertyNode* p = globals->get_props();
 322     try {
 323         for(int i=0; i<len; i++) {
 324             naRef a = vec[i];
 325             if(!naIsString(a)) {
 326                 naRuntimeError(c, "bad argument to setprop/getprop path: expected a string");
 327             }
 328             naRef b = i < len-1 ? naNumValue(vec[i+1]) : naNil();
 329             if (!naIsNil(b)) {
 330                 p = p->getNode(naStr_data(a), (int)b.num, create);
 331                 i++;
 332             } else {
 333                 p = p->getNode(naStr_data(a), create);
 334             }
 335             if(p == 0) return 0;
 336         }
 337     } catch (const string& err) {
 338         naRuntimeError(c, (char *)err.c_str());
 339     }
 340     return p;
 341 }
 342
 343 // getprop() extension function.  Concatenates its string arguments as
 344 // property names and returns the value of the specified property.  Or
 345 // nil if it doesn't exist.
 346 static naRef f_getprop(naContext c, naRef me, int argc, naRef* args)
 347 {
 348     using namespace simgear;
 349     if (argc < 1) {
 350         naRuntimeError(c, "getprop() expects at least 1 argument");
 351     }
 352     const SGPropertyNode* p = findnode(c, args, argc, false);
 353     if(!p) return naNil();
 354
 355     switch(p->getType()) {
 356     case props::BOOL:   case props::INT:
 357     case props::LONG:   case props::FLOAT:
 358     case props::DOUBLE:
 359         {
 360         double dv = p->getDoubleValue();
 361         if (SGMisc<double>::isNaN(dv)) {
 362           SG_LOG(SG_NASAL, SG_ALERT, "Nasal getprop: property " << p->getPath() << " is NaN");
 363           return naNil();
 364         }
 365
 366         return naNum(dv);
 367         }
 368
 369     case props::STRING:
 370     case props::UNSPECIFIED:
 371         {
 372             naRef nastr = naNewString(c);
 373             const char* val = p->getStringValue();
 374             naStr_fromdata(nastr, (char*)val, strlen(val));
 375             return nastr;
 376         }
 377     case props::ALIAS: // <--- FIXME, recurse?
 378     default:
 379         return naNil();
 380     }
 381 }
 382
 383 // setprop() extension function.  Concatenates its string arguments as
 384 // property names and sets the value of the specified property to the
 385 // final argument.
 386 static naRef f_setprop(naContext c, naRef me, int argc, naRef* args)
 387 {
 388     if (argc < 2) {
 389         naRuntimeError(c, "setprop() expects at least 2 arguments");
 390     }
 391     naRef val = args[argc - 1];
 392     SGPropertyNode* p = findnode(c, args, argc-1, true);
 393
 394     bool result = false;
 395     try {
 396         if(naIsString(val)) result = p->setStringValue(naStr_data(val));
 397         else {
 398             if(!naIsNum(val))
 399                 naRuntimeError(c, "setprop() value is not string or number");
 400
 401             if (SGMisc<double>::isNaN(val.num)) {
 402                 naRuntimeError(c, "setprop() passed a NaN");
 403             }
 404
 405             result = p->setDoubleValue(val.num);
 406         }
 407     } catch (const string& err) {
 408         naRuntimeError(c, (char *)err.c_str());
 409     }
 410     return naNum(result);
 411 }
 412
 413 // print() extension function.  Concatenates and prints its arguments
 414 // to the FlightGear log.  Uses the highest log level (SG_ALERT), to
 415 // make sure it appears.  Is there better way to do this?
 416 static naRef f_print(naContext c, naRef me, int argc, naRef* args)
 417 {
 418     string buf;
 419     int n = argc;
 420     for(int i=0; i<n; i++) {
 421         naRef s = naStringValue(c, args[i]);
 422         if(naIsNil(s)) continue;
 423         buf += naStr_data(s);
 424     }
 425     SG_LOG(SG_NASAL, SG_ALERT, buf);
 426     return naNum(buf.length());
 427 }
 428
 429 // logprint() extension function.  Same as above, all arguments after the
 430 // first argument are concatenated. Argument 0 is the log-level, matching
 431 // sgDebugPriority.
 432 static naRef f_logprint(naContext c, naRef me, int argc, naRef* args)
 433 {
 434   if (argc < 1)
 435     naRuntimeError(c, "no prioirty argument to logprint()");
 436
 437   naRef priority = args[0];
 438   string buf;
 439   int n = argc;
 440   for(int i=1; i<n; i++) {
 441     naRef s = naStringValue(c, args[i]);
 442     if(naIsNil(s)) continue;
 443     buf += naStr_data(s);
 444   }
 445 // use the nasal source file and line for the message location, since
 446 // that's more useful than the location here!
 447   sglog().log(SG_NASAL, (sgDebugPriority)(int) priority.num,
 448                naStr_data(naGetSourceFile(c, 0)),
 449                naGetLine(c, 0), buf);
 450   return naNum(buf.length());
 451 }
 452
 453
 454 // fgcommand() extension function.  Executes a named command via the
 455 // FlightGear command manager.  Takes a single property node name as
 456 // an argument.
 457 static naRef f_fgcommand(naContext c, naRef me, int argc, naRef* args)
 458 {
 459     naRef cmd = argc > 0 ? args[0] : naNil();
 460     naRef props = argc > 1 ? args[1] : naNil();
 461     if(!naIsString(cmd) || (!naIsNil(props) && !naIsGhost(props)))
 462         naRuntimeError(c, "bad arguments to fgcommand()");
 463     SGPropertyNode_ptr node;
 464     if(!naIsNil(props))
 465         node = static_cast<SGPropertyNode*>(naGhost_ptr(props));
 466     else
 467         node = new SGPropertyNode;
 468
 469     return naNum(globals->get_commands()->execute(naStr_data(cmd), node));
 470 }
 471
 472 // settimer(func, dt, simtime) extension function.  Falls through to
 473 // FGNasalSys::setTimer().  See there for docs.
 474 static naRef f_settimer(naContext c, naRef me, int argc, naRef* args)
 475 {
 476     nasalSys->setTimer(c, argc, args);
 477     return naNil();
 478 }
 479
 480 static naRef f_makeTimer(naContext c, naRef me, int argc, naRef* args)
 481 {
 482   if (!naIsNum(args[0])) {
 483     naRuntimeError(c, "bad interval argument to maketimer");
 484   }
 485
 486   naRef func, self = naNil();
 487   if (naIsFunc(args[1])) {
 488     func = args[1];
 489   } else if ((argc == 3) && naIsFunc(args[2])) {
 490     self = args[1];
 491     func = args[2];
 492   }
 493
 494   TimerObj* timerObj = new TimerObj(nasalSys, func, self, args[0].num);
 495   return nasal::to_nasal(c, timerObj);
 496 }
 497
 498 // setlistener(func, property, bool) extension function.  Falls through to
 499 // FGNasalSys::setListener().  See there for docs.
 500 static naRef f_setlistener(naContext c, naRef me, int argc, naRef* args)
 501 {
 502     return nasalSys->setListener(c, argc, args);
 503 }
 504
 505 // removelistener(int) extension function. Falls through to
 506 // FGNasalSys::removeListener(). See there for docs.
 507 static naRef f_removelistener(naContext c, naRef me, int argc, naRef* args)
 508 {
 509     return nasalSys->removeListener(c, argc, args);
 510 }
 511
 512 // Returns a ghost handle to the argument to the currently executing
 513 // command
 514 static naRef f_cmdarg(naContext c, naRef me, int argc, naRef* args)
 515 {
 516     return nasalSys->cmdArgGhost();
 517 }
 518
 519 // Sets up a property interpolation.  The first argument is either a
 520 // ghost (SGPropertyNode*) or a string (global property path) to
 521 // interpolate.  The second argument is a vector of pairs of
 522 // value/delta numbers.
 523 static naRef f_interpolate(naContext c, naRef me, int argc, naRef* args)
 524 {
 525   SGPropertyNode* node;
 526   naRef prop = argc > 0 ? args[0] : naNil();
 527   if(naIsString(prop)) node = fgGetNode(naStr_data(prop), true);
 528   else if(naIsGhost(prop)) node = static_cast<SGPropertyNode*>(naGhost_ptr(prop));
 529   else return naNil();
 530
 531   naRef curve = argc > 1 ? args[1] : naNil();
 532   if(!naIsVector(curve)) return naNil();
 533   int nPoints = naVec_size(curve) / 2;
 534
 535   simgear::PropertyList value_nodes;
 536   value_nodes.reserve(nPoints);
 537   double_list deltas;
 538   deltas.reserve(nPoints);
 539
 540   for( int i = 0; i < nPoints; ++i )
 541   {
 542     SGPropertyNode* val = new SGPropertyNode;
 543     val->setDoubleValue(naNumValue(naVec_get(curve, 2*i)).num);
 544     value_nodes.push_back(val);
 545     deltas.push_back(naNumValue(naVec_get(curve, 2*i+1)).num);
 546   }
 547
 548   node->interpolate("numeric", value_nodes, deltas, "linear");
 549   return naNil();
 550 }
 551
 552 // This is a better RNG than the one in the default Nasal distribution
 553 // (which is based on the C library rand() implementation). It will
 554 // override.
 555 static naRef f_rand(naContext c, naRef me, int argc, naRef* args)
 556 {
 557     return naNum(sg_random());
 558 }
 559
 560 static naRef f_srand(naContext c, naRef me, int argc, naRef* args)
 561 {
 562     sg_srandom_time();
 563     return naNum(0);
 564 }
 565
 566 static naRef f_abort(naContext c, naRef me, int argc, naRef* args)
 567 {
 568     abort();
 569     return naNil();
 570 }
 571
 572 // Return an array listing of all files in a directory
 573 static naRef f_directory(naContext c, naRef me, int argc, naRef* args)
 574 {
 575     if(argc != 1 || !naIsString(args[0]))
 576         naRuntimeError(c, "bad arguments to directory()");
 577
 578     simgear::Dir d(SGPath(naStr_data(args[0])));
 579     if(!d.exists()) return naNil();
 580     naRef result = naNewVector(c);
 581
 582     simgear::PathList paths = d.children(simgear::Dir::TYPE_FILE | simgear::Dir::TYPE_DIR);
 583     for (unsigned int i=0; i<paths.size(); ++i) {
 584       std::string p = paths[i].file();
 585       naVec_append(result, naStr_fromdata(naNewString(c), p.c_str(), p.size()));
 586     }
 587
 588     return result;
 589 }
 590
 591 /**
 592  * Given a data path, resolve it in FG_ROOT or an FG_AIRCRFT directory
 593  */
 594 static naRef f_resolveDataPath(naContext c, naRef me, int argc, naRef* args)
 595 {
 596     if(argc != 1 || !naIsString(args[0]))
 597         naRuntimeError(c, "bad arguments to resolveDataPath()");
 598
 599     SGPath p = globals->resolve_maybe_aircraft_path(naStr_data(args[0]));
 600     const char* pdata = p.c_str();
 601     return naStr_fromdata(naNewString(c), const_cast<char*>(pdata), strlen(pdata));
 602 }
 603
 604 static naRef f_findDataDir(naContext c, naRef me, int argc, naRef* args)
 605 {
 606     if(argc != 1 || !naIsString(args[0]))
 607         naRuntimeError(c, "bad arguments to findDataDir()");
 608
 609     SGPath p = globals->find_data_dir(naStr_data(args[0]));
 610     const char* pdata = p.c_str();
 611     return naStr_fromdata(naNewString(c), const_cast<char*>(pdata), strlen(pdata));
 612 }
 613
 614 class NasalCommand : public SGCommandMgr::Command
 615 {
 616 public:
 617     NasalCommand(FGNasalSys* sys, naRef f, const std::string& name) :
 618         _sys(sys),
 619         _func(f),
 620         _name(name)
 621     {
 622         globals->get_commands()->addCommandObject(_name, this);
 623         _gcRoot =  sys->gcSave(f);
 624     }
 625
 626     virtual ~NasalCommand()
 627     {
 628         _sys->gcRelease(_gcRoot);
 629     }
 630
 631     virtual bool operator()(const SGPropertyNode* aNode)
 632     {
 633         _sys->setCmdArg(const_cast<SGPropertyNode*>(aNode));
 634         naRef args[1];
 635         args[0] = _sys->wrappedPropsNode(const_cast<SGPropertyNode*>(aNode));
 636
 637         _sys->callMethod(_func, naNil(), 1, args, naNil() /* locals */);
 638
 639         return true;
 640     }
 641
 642 private:
 643     FGNasalSys* _sys;
 644     naRef _func;
 645     int _gcRoot;
 646     std::string _name;
 647 };
 648
 649 static naRef f_addCommand(naContext c, naRef me, int argc, naRef* args)
 650 {
 651     if(argc != 2 || !naIsString(args[0]) || !naIsFunc(args[1]))
 652         naRuntimeError(c, "bad arguments to addcommand()");
 653
 654     nasalSys->addCommand(args[1], naStr_data(args[0]));
 655     return naNil();
 656 }
 657
 658 static naRef f_removeCommand(naContext c, naRef me, int argc, naRef* args)
 659 {
 660     if ((argc < 1) || !naIsString(args[0]))
 661         naRuntimeError(c, "bad argument to removecommand()");
 662
 663     globals->get_commands()->removeCommand(naStr_data(args[0]));
 664     return naNil();
 665 }
 666
 667 static naRef f_open(naContext c, naRef me, int argc, naRef* args)
 668 {
 669     FILE* f;
 670     naRef file = argc > 0 ? naStringValue(c, args[0]) : naNil();
 671     naRef mode = argc > 1 ? naStringValue(c, args[1]) : naNil();
 672     if(!naStr_data(file)) naRuntimeError(c, "bad argument to open()");
 673     const char* modestr = naStr_data(mode) ? naStr_data(mode) : "rb";
 674     std::string filename = fgValidatePath(naStr_data(file),
 675         strcmp(modestr, "rb") && strcmp(modestr, "r"));
 676     if(filename.empty()) {
 677         naRuntimeError(c, "open(): reading/writing '%s' denied "
 678                 "(unauthorized access)", naStr_data(file));
 679         return naNil();
 680     }
 681     f = fopen(filename.c_str(), modestr);
 682     if(!f) naRuntimeError(c, strerror(errno));
 683     return naIOGhost(c, f);
 684 }
 685
 686 // Parse XML file.
 687 //     parsexml(<path> [, <start-tag> [, <end-tag> [, <data> [, <pi>]]]]);
 688 //
 689 // <path>      ... absolute path to an XML file
 690 // <start-tag> ... callback function with two args: tag name, attribute hash
 691 // <end-tag>   ... callback function with one arg:  tag name
 692 // <data>      ... callback function with one arg:  data
 693 // <pi>        ... callback function with two args: target, data
 694 //                 (pi = "processing instruction")
 695 // All four callback functions are optional and default to nil.
 696 // The function returns nil on error, or the validated file name otherwise.
 697 static naRef f_parsexml(naContext c, naRef me, int argc, naRef* args)
 698 {
 699     if(argc < 1 || !naIsString(args[0]))
 700         naRuntimeError(c, "parsexml(): path argument missing or not a string");
 701     if(argc > 5) argc = 5;
 702     for(int i=1; i<argc; i++)
 703         if(!(naIsNil(args[i]) || naIsFunc(args[i])))
 704             naRuntimeError(c, "parsexml(): callback argument not a function");
 705
 706     std::string file = fgValidatePath(naStr_data(args[0]), false);
 707     if(file.empty()) {
 708         naRuntimeError(c, "parsexml(): reading '%s' denied "
 709                 "(unauthorized access)", naStr_data(args[0]));
 710         return naNil();
 711     }
 712     std::ifstream input(file.c_str());
 713     NasalXMLVisitor visitor(c, argc, args);
 714     try {
 715         readXML(input, visitor);
 716     } catch (const sg_exception& e) {
 717         naRuntimeError(c, "parsexml(): file '%s' %s",
 718                 file.c_str(), e.getFormattedMessage().c_str());
 719         return naNil();
 720     }
 721     return naStr_fromdata(naNewString(c), file.c_str(), file.length());
 722 }
 723
 724 /**
 725  * Parse very simple and small subset of markdown
 726  *
 727  * parse_markdown(src)
 728  */
 729 static naRef f_parse_markdown(naContext c, naRef me, int argc, naRef* args)
 730 {
 731   nasal::CallContext ctx(c, me, argc, args);
 732   return ctx.to_nasal(
 733     simgear::SimpleMarkdown::parse(ctx.requireArg<std::string>(0))
 734   );
 735 }
 736
 737 /**
 738  * Create md5 hash from given string
 739  *
 740  * md5(str)
 741  */
 742 static naRef f_md5(naContext c, naRef me, int argc, naRef* args)
 743 {
 744   if( argc != 1 || !naIsString(args[0]) )
 745     naRuntimeError(c, "md5(): wrong type or number of arguments");
 746
 747   return nasal::to_nasal(
 748     c,
 749     simgear::strutils::md5(naStr_data(args[0]), naStr_len(args[0]))
 750   );
 751 }
 752
 753 // Return UNIX epoch time in seconds.
 754 static naRef f_systime(naContext c, naRef me, int argc, naRef* args)
 755 {
 756 #ifdef _WIN32
 757     FILETIME ft;
 758     GetSystemTimeAsFileTime(&ft);
 759     double t = (4294967296.0 * ft.dwHighDateTime + ft.dwLowDateTime);
 760     // Converts from 100ns units in 1601 epoch to unix epoch in sec
 761     return naNum((t * 1e-7) - 11644473600.0);
 762 #else
 763     struct timeval td;
 764     gettimeofday(&td, 0);
 765     return naNum(td.tv_sec + 1e-6 * td.tv_usec);
 766 #endif
 767 }
 768
 769 // Table of extension functions.  Terminate with zeros.
 770 static struct { const char* name; naCFunction func; } funcs[] = {
 771     { "getprop",   f_getprop },
 772     { "setprop",   f_setprop },
 773     { "print",     f_print },
 774     { "logprint",  f_logprint },
 775     { "_fgcommand", f_fgcommand },
 776     { "settimer",  f_settimer },
 777     { "maketimer", f_makeTimer },
 778     { "_setlistener", f_setlistener },
 779     { "removelistener", f_removelistener },
 780     { "addcommand", f_addCommand },
 781     { "removecommand", f_removeCommand },
 782     { "_cmdarg",  f_cmdarg },
 783     { "_interpolate",  f_interpolate },
 784     { "rand",  f_rand },
 785     { "srand",  f_srand },
 786     { "abort", f_abort },
 787     { "directory", f_directory },
 788     { "resolvepath", f_resolveDataPath },
 789     { "finddata", f_findDataDir },
 790     { "parsexml", f_parsexml },
 791     { "parse_markdown", f_parse_markdown },
 792     { "md5", f_md5 },
 793     { "systime", f_systime },
 794     { 0, 0 }
 795 };
 796
 797 naRef FGNasalSys::cmdArgGhost()
 798 {
 799     return propNodeGhost(_cmdArg);
 800 }
 801
 802 void FGNasalSys::setCmdArg(SGPropertyNode* aNode)
 803 {
 804     _cmdArg = aNode;
 805 }
 806
 807 void FGNasalSys::init()
 808 {
 809     if (_inited) {
 810         SG_LOG(SG_GENERAL, SG_ALERT, "duplicate init of Nasal");
 811     }
 812     int i;
 813
 814     _context = naNewContext();
 815
 816     // Start with globals.  Add it to itself as a recursive
 817     // sub-reference under the name "globals".  This gives client-code
 818     // write access to the namespace if someone wants to do something
 819     // fancy.
 820     _globals = naInit_std(_context);
 821     naSave(_context, _globals);
 822     hashset(_globals, "globals", _globals);
 823
 824     hashset(_globals, "math", naInit_math(_context));
 825     hashset(_globals, "bits", naInit_bits(_context));
 826     hashset(_globals, "io", naInit_io(_context));
 827     hashset(_globals, "thread", naInit_thread(_context));
 828     hashset(_globals, "utf8", naInit_utf8(_context));
 829
 830     // Add our custom extension functions:
 831     for(i=0; funcs[i].name; i++)
 832         hashset(_globals, funcs[i].name,
 833                 naNewFunc(_context, naNewCCode(_context, funcs[i].func)));
 834     nasal::Hash io_module = nasal::Hash(_globals, _context).get<nasal::Hash>("io");
 835     io_module.set("open", f_open);
 836
 837     // And our SGPropertyNode wrapper
 838     hashset(_globals, "props", genPropsModule());
 839
 840     // Add string methods
 841     _string = naInit_string(_context);
 842     naSave(_context, _string);
 843     initNasalString(_globals, _string, _context);
 844
 845     initNasalPositioned(_globals, _context);
 846     initNasalPositioned_cppbind(_globals, _context);
 847     initNasalAircraft(_globals, _context);
 848     NasalClipboard::init(this);
 849     initNasalCanvas(_globals, _context);
 850     initNasalCondition(_globals, _context);
 851     initNasalHTTP(_globals, _context);
 852     initNasalSGPath(_globals, _context);
 853
 854     NasalTimerObj::init("Timer")
 855       .method("start", &TimerObj::start)
 856       .method("stop", &TimerObj::stop)
 857       .method("restart", &TimerObj::restart)
 858       .member("singleShot", &TimerObj::isSingleShot, &TimerObj::setSingleShot)
 859       .member("isRunning", &TimerObj::isRunning);
 860
 861     // Set allowed paths for Nasal I/O
 862     fgInitAllowedPaths();
 863
 864     // Now load the various source files in the Nasal directory
 865     simgear::Dir nasalDir(SGPath(globals->get_fg_root(), "Nasal"));
 866     loadScriptDirectory(nasalDir);
 867
 868     // Add modules in Nasal subdirectories to property tree
 869     simgear::PathList directories = nasalDir.children(simgear::Dir::TYPE_DIR+
 870             simgear::Dir::NO_DOT_OR_DOTDOT, "");
 871     for (unsigned int i=0; i<directories.size(); ++i) {
 872         simgear::Dir dir(directories[i]);
 873         simgear::PathList scripts = dir.children(simgear::Dir::TYPE_FILE, ".nas");
 874         addModule(directories[i].file(), scripts);
 875     }
 876
 877     // set signal and remove node to avoid restoring at reinit
 878     const char *s = "nasal-dir-initialized";
 879     SGPropertyNode *signal = fgGetNode("/sim/signals", true);
 880     signal->setBoolValue(s, true);
 881     signal->removeChildren(s);
 882
 883     // Pull scripts out of the property tree, too
 884     loadPropertyScripts();
 885
 886     // now Nasal modules are loaded, we can do some delayed work
 887     postinitNasalPositioned(_globals, _context);
 888     postinitNasalGUI(_globals, _context);
 889
 890     _inited = true;
 891 }
 892
 893 void FGNasalSys::shutdown()
 894 {
 895     if (!_inited) {
 896         return;
 897     }
 898
 899     shutdownNasalPositioned();
 900
 901     map<int, FGNasalListener *>::iterator it, end = _listener.end();
 902     for(it = _listener.begin(); it != end; ++it)
 903         delete it->second;
 904     _listener.clear();
 905
 906     NasalCommandDict::iterator j = _commands.begin();
 907     for (; j != _commands.end(); ++j) {
 908         globals->get_commands()->removeCommand(j->first);
 909     }
 910     _commands.clear();
 911
 912     std::vector<FGNasalModuleListener*>::iterator k = _moduleListeners.begin();
 913     for(; k!= _moduleListeners.end(); ++k)
 914         delete *k;
 915     _moduleListeners.clear();
 916
 917     naClearSaved();
 918
 919     _string = naNil(); // will be freed by _context
 920     naFreeContext(_context);
 921
 922     //setWatchedRef(_globals);
 923
 924     // remove the recursive reference in globals
 925     hashset(_globals, "globals", naNil());
 926     _globals = naNil();
 927
 928     naGC();
 929     _inited = false;
 930 }
 931
 932 naRef FGNasalSys::wrappedPropsNode(SGPropertyNode* aProps)
 933 {
 934     if (naIsNil(_wrappedNodeFunc)) {
 935         nasal::Hash props = getGlobals().get<nasal::Hash>("props");
 936         _wrappedNodeFunc = props.get("wrapNode");
 937     }
 938
 939     naRef args[1];
 940     args[0] = propNodeGhost(aProps);
 941     naContext ctx = naNewContext();
 942     naRef wrapped = naCallMethodCtx(ctx, _wrappedNodeFunc, naNil(), 1, args, naNil());
 943     naFreeContext(ctx);
 944     return wrapped;
 945 }
 946
 947 void FGNasalSys::update(double)
 948 {
 949     if( NasalClipboard::getInstance() )
 950         NasalClipboard::getInstance()->update();
 951
 952     if(!_dead_listener.empty()) {
 953         vector<FGNasalListener *>::iterator it, end = _dead_listener.end();
 954         for(it = _dead_listener.begin(); it != end; ++it) delete *it;
 955         _dead_listener.clear();
 956     }
 957
 958     if (!_loadList.empty())
 959     {
 960         if( _delay_load )
 961           _delay_load = false;
 962         else
 963           // process Nasal load hook (only one per update loop to avoid excessive lags)
 964           _loadList.pop()->load();
 965     }
 966     else
 967     if (!_unloadList.empty())
 968     {
 969         // process pending Nasal unload hooks after _all_ load hooks were processed
 970         // (only unload one per update loop to avoid excessive lags)
 971         _unloadList.pop()->unload();
 972     }
 973
 974     // Destroy all queued ghosts
 975     nasal::ghostProcessDestroyList();
 976
 977     // The global context is a legacy thing.  We use dynamically
 978     // created contexts for naCall() now, so that we can call them
 979     // recursively.  But there are still spots that want to use it for
 980     // naNew*() calls, which end up leaking memory because the context
 981     // only clears out its temporary vector when it's *used*.  So just
 982     // junk it and fetch a new/reinitialized one every frame.  This is
 983     // clumsy: the right solution would use the dynamic context in all
 984     // cases and eliminate _context entirely.  But that's more work,
 985     // and this works fine (yes, they say "New" and "Free", but
 986     // they're very fast, just trust me). -Andy
 987     naFreeContext(_context);
 988     _context = naNewContext();
 989 }
 990
 991 bool pathSortPredicate(const SGPath& p1, const SGPath& p2)
 992 {
 993   return p1.file() < p2.file();
 994 }
 995
 996 // Loads all scripts in given directory
 997 void FGNasalSys::loadScriptDirectory(simgear::Dir nasalDir)
 998 {
 999     simgear::PathList scripts = nasalDir.children(simgear::Dir::TYPE_FILE, ".nas");
1000     // Note: simgear::Dir already reports file entries in a deterministic order,
1001     // so a fixed loading sequence is guaranteed (same for every user)
1002     for (unsigned int i=0; i<scripts.size(); ++i) {
1003       SGPath fullpath(scripts[i]);
1004       SGPath file = fullpath.file();
1005       loadModule(fullpath, file.base().c_str());
1006     }
1007 }
1008
1009 // Create module with list of scripts
1010 void FGNasalSys::addModule(string moduleName, simgear::PathList scripts)
1011 {
1012     if (! scripts.empty())
1013     {
1014         SGPropertyNode* nasal = globals->get_props()->getNode("nasal");
1015         SGPropertyNode* module_node = nasal->getChild(moduleName,0,true);
1016         for (unsigned int i=0; i<scripts.size(); ++i) {
1017             SGPropertyNode* pFileNode = module_node->getChild("file",i,true);
1018             pFileNode->setStringValue(scripts[i].c_str());
1019         }
1020         if (!module_node->hasChild("enabled",0))
1021         {
1022             SGPropertyNode* node = module_node->getChild("enabled",0,true);
1023             node->setBoolValue(true);
1024             node->setAttribute(SGPropertyNode::USERARCHIVE,true);
1025         }
1026     }
1027 }
1028
1029 // Loads the scripts found under /nasal in the global tree
1030 void FGNasalSys::loadPropertyScripts()
1031 {
1032     SGPropertyNode* nasal = globals->get_props()->getNode("nasal");
1033     if(!nasal) return;
1034
1035     for(int i=0; i<nasal->nChildren(); i++)
1036     {
1037         SGPropertyNode* n = nasal->getChild(i);
1038         loadPropertyScripts(n);
1039     }
1040 }
1041
1042 // Loads the scripts found under /nasal in the global tree
1043 void FGNasalSys::loadPropertyScripts(SGPropertyNode* n)
1044 {
1045     bool is_loaded = false;
1046
1047     const char* module = n->getName();
1048     if(n->hasChild("module"))
1049         module = n->getStringValue("module");
1050     if (n->getBoolValue("enabled",true))
1051     {
1052         // allow multiple files to be specified within a single
1053         // Nasal module tag
1054         int j = 0;
1055         SGPropertyNode *fn;
1056         bool file_specified = false;
1057         bool ok=true;
1058         while((fn = n->getChild("file", j)) != NULL) {
1059             file_specified = true;
1060             const char* file = fn->getStringValue();
1061             SGPath p(file);
1062             if (!p.isAbsolute() || !p.exists())
1063             {
1064                 p = globals->resolve_maybe_aircraft_path(file);
1065                 if (p.isNull())
1066                 {
1067                     SG_LOG(SG_NASAL, SG_ALERT, "Cannot find Nasal script '" <<
1068                             file << "' for module '" << module << "'.");
1069                 }
1070             }
1071             ok &= p.isNull() ? false : loadModule(p, module);
1072             j++;
1073         }
1074
1075         const char* src = n->getStringValue("script");
1076         if(!n->hasChild("script")) src = 0; // Hrm...
1077         if(src)
1078             createModule(module, n->getPath().c_str(), src, strlen(src));
1079
1080         if(!file_specified && !src)
1081         {
1082             // module no longer exists - clear the archived "enable" flag
1083             n->setAttribute(SGPropertyNode::USERARCHIVE,false);
1084             SGPropertyNode* node = n->getChild("enabled",0,false);
1085             if (node)
1086                 node->setAttribute(SGPropertyNode::USERARCHIVE,false);
1087
1088             SG_LOG(SG_NASAL, SG_ALERT, "Nasal error: " <<
1089                     "no <file> or <script> defined in " <<
1090                     "/nasal/" << module);
1091         }
1092         else
1093             is_loaded = ok;
1094     }
1095     else
1096     {
1097         SGPropertyNode* enable = n->getChild("enabled");
1098         if (enable)
1099         {
1100             FGNasalModuleListener* listener = new FGNasalModuleListener(n);
1101             _moduleListeners.push_back(listener);
1102             enable->addChangeListener(listener, false);
1103         }
1104     }
1105     SGPropertyNode* loaded = n->getChild("loaded",0,true);
1106     loaded->setAttribute(SGPropertyNode::PRESERVE,true);
1107     loaded->setBoolValue(is_loaded);
1108 }
1109
1110 // Logs a runtime error, with stack trace, to the FlightGear log stream
1111 void FGNasalSys::logError(naContext context)
1112 {
1113     SG_LOG(SG_NASAL, SG_ALERT, "Nasal runtime error: " << naGetError(context));
1114     int stack_depth = naStackDepth(context);
1115     if( stack_depth < 1 )
1116       return;
1117     SG_LOG(SG_NASAL, SG_ALERT,
1118            "  at " << naStr_data(naGetSourceFile(context, 0)) <<
1119            ", line " << naGetLine(context, 0));
1120     for(int i=1; i<stack_depth; i++)
1121         SG_LOG(SG_NASAL, SG_ALERT,
1122                "  called from: " << naStr_data(naGetSourceFile(context, i)) <<
1123                ", line " << naGetLine(context, i));
1124 }
1125
1126 // Reads a script file, executes it, and places the resulting
1127 // namespace into the global namespace under the specified module
1128 // name.
1129 bool FGNasalSys::loadModule(SGPath file, const char* module)
1130 {
1131     int len = 0;
1132     char* buf = readfile(file.c_str(), &len);
1133     if(!buf) {
1134         SG_LOG(SG_NASAL, SG_ALERT,
1135                "Nasal error: could not read script file " << file.c_str()
1136                << " into module " << module);
1137         return false;
1138     }
1139
1140     bool ok = createModule(module, file.c_str(), buf, len);
1141     delete[] buf;
1142     return ok;
1143 }
1144
1145 // Parse and run.  Save the local variables namespace, as it will
1146 // become a sub-object of globals.  The optional "arg" argument can be
1147 // used to pass an associated property node to the module, which can then
1148 // be accessed via cmdarg().  (This is, for example, used by XML dialogs.)
1149 bool FGNasalSys::createModule(const char* moduleName, const char* fileName,
1150                               const char* src, int len,
1151                               const SGPropertyNode* cmdarg,
1152                               int argc, naRef* args)
1153 {
1154     naContext ctx = naNewContext();
1155     naRef code = parse(ctx, fileName, src, len);
1156     if(naIsNil(code)) {
1157         naFreeContext(ctx);
1158         return false;
1159     }
1160
1161
1162     // See if we already have a module hash to use.  This allows the
1163     // user to, for example, add functions to the built-in math
1164     // module.  Make a new one if necessary.
1165     naRef locals;
1166     naRef modname = naNewString(ctx);
1167     naStr_fromdata(modname, (char*)moduleName, strlen(moduleName));
1168     if(!naHash_get(_globals, modname, &locals))
1169         locals = naNewHash(ctx);
1170
1171     _cmdArg = (SGPropertyNode*)cmdarg;
1172
1173     callWithContext(ctx, code, argc, args, locals);
1174     hashset(_globals, moduleName, locals);
1175
1176     naFreeContext(ctx);
1177     return true;
1178 }
1179
1180 void FGNasalSys::deleteModule(const char* moduleName)
1181 {
1182     if (!_inited) {
1183         // can occur on shutdown due to us being shutdown first, but other
1184         // subsystems having Nasal objects.
1185         return;
1186     }
1187
1188     naContext ctx = naNewContext();
1189     naRef modname = naNewString(ctx);
1190     naStr_fromdata(modname, (char*)moduleName, strlen(moduleName));
1191     naHash_delete(_globals, modname);
1192     naFreeContext(ctx);
1193 }
1194
1195 naRef FGNasalSys::parse(naContext ctx, const char* filename, const char* buf, int len)
1196 {
1197     int errLine = -1;
1198     naRef srcfile = naNewString(ctx);
1199     naStr_fromdata(srcfile, (char*)filename, strlen(filename));
1200     naRef code = naParseCode(ctx, srcfile, 1, (char*)buf, len, &errLine);
1201     if(naIsNil(code)) {
1202         SG_LOG(SG_NASAL, SG_ALERT,
1203                "Nasal parse error: " << naGetError(ctx) <<
1204                " in "<< filename <<", line " << errLine);
1205         return naNil();
1206     }
1207
1208     // Bind to the global namespace before returning
1209     return naBindFunction(ctx, code, _globals);
1210 }
1211
1212 bool FGNasalSys::handleCommand( const char* moduleName,
1213                                 const char* fileName,
1214                                 const char* src,
1215                                 const SGPropertyNode* arg )
1216 {
1217     naContext ctx = naNewContext();
1218     naRef code = parse(ctx, fileName, src, strlen(src));
1219     if(naIsNil(code)) {
1220         naFreeContext(ctx);
1221         return false;
1222     }
1223
1224     // Commands can be run "in" a module.  Make sure that module
1225     // exists, and set it up as the local variables hash for the
1226     // command.
1227     naRef locals = naNil();
1228     if(moduleName[0]) {
1229         naRef modname = naNewString(ctx);
1230         naStr_fromdata(modname, (char*)moduleName, strlen(moduleName));
1231         if(!naHash_get(_globals, modname, &locals)) {
1232             locals = naNewHash(ctx);
1233             naHash_set(_globals, modname, locals);
1234         }
1235     }
1236
1237     // Cache this command's argument for inspection via cmdarg().  For
1238     // performance reasons, we won't bother with it if the invoked
1239     // code doesn't need it.
1240     _cmdArg = (SGPropertyNode*)arg;
1241
1242     callWithContext(ctx, code, 0, 0, locals);
1243     naFreeContext(ctx);
1244     return true;
1245 }
1246
1247 bool FGNasalSys::handleCommand(const SGPropertyNode* arg)
1248 {
1249   const char* src = arg->getStringValue("script");
1250   const char* moduleName = arg->getStringValue("module");
1251
1252   return handleCommand( moduleName,
1253                         arg->getPath(true).c_str(),
1254                         src,
1255                         arg );
1256 }
1257
1258 // settimer(func, dt, simtime) extension function.  The first argument
1259 // is a Nasal function to call, the second is a delta time (from now),
1260 // in seconds.  The third, if present, is a boolean value indicating
1261 // that "real world" time (rather than simulator time) is to be used.
1262 //
1263 // Implementation note: the FGTimer objects don't live inside the
1264 // garbage collector, so the Nasal handler functions have to be
1265 // "saved" somehow lest they be inadvertently cleaned.  In this case,
1266 // they are inserted into a globals.__gcsave hash and removed on
1267 // expiration.
1268 void FGNasalSys::setTimer(naContext c, int argc, naRef* args)
1269 {
1270     // Extract the handler, delta, and simtime arguments:
1271     naRef handler = argc > 0 ? args[0] : naNil();
1272     if(!(naIsCode(handler) || naIsCCode(handler) || naIsFunc(handler))) {
1273         naRuntimeError(c, "settimer() with invalid function argument");
1274         return;
1275     }
1276
1277     naRef delta = argc > 1 ? args[1] : naNil();
1278     if(naIsNil(delta)) {
1279         naRuntimeError(c, "settimer() with invalid time argument");
1280         return;
1281     }
1282
1283     bool simtime = (argc > 2 && naTrue(args[2])) ? false : true;
1284
1285     // Generate and register a C++ timer handler
1286     NasalTimer* t = new NasalTimer;
1287     t->handler = handler;
1288     t->gcKey = gcSave(handler);
1289     t->nasal = this;
1290
1291     globals->get_event_mgr()->addEvent("NasalTimer",
1292                                        t, &NasalTimer::timerExpired,
1293                                        delta.num, simtime);
1294 }
1295
1296 void FGNasalSys::handleTimer(NasalTimer* t)
1297 {
1298     call(t->handler, 0, 0, naNil());
1299     gcRelease(t->gcKey);
1300 }
1301
1302 int FGNasalSys::gcSave(naRef r)
1303 {
1304     return naGCSave(r);
1305 }
1306
1307 void FGNasalSys::gcRelease(int key)
1308 {
1309     naGCRelease(key);
1310 }
1311
1312
1313 //------------------------------------------------------------------------------
1314 void FGNasalSys::NasalTimer::timerExpired()
1315 {
1316     nasal->handleTimer(this);
1317     delete this;
1318 }
1319
1320 int FGNasalSys::_listenerId = 0;
1321
1322 // setlistener(<property>, <func> [, <initial=0> [, <persistent=1>]])
1323 // Attaches a callback function to a property (specified as a global
1324 // property path string or a SGPropertyNode* ghost). If the third,
1325 // optional argument (default=0) is set to 1, then the function is also
1326 // called initially. If the fourth, optional argument is set to 0, then the
1327 // function is only called when the property node value actually changes.
1328 // Otherwise it's called independent of the value whenever the node is
1329 // written to (default). The setlistener() function returns a unique
1330 // id number, which is to be used as argument to the removelistener()
1331 // function.
1332 naRef FGNasalSys::setListener(naContext c, int argc, naRef* args)
1333 {
1334     SGPropertyNode_ptr node;
1335     naRef prop = argc > 0 ? args[0] : naNil();
1336     if(naIsString(prop)) node = fgGetNode(naStr_data(prop), true);
1337     else if(naIsGhost(prop)) node = static_cast<SGPropertyNode*>(naGhost_ptr(prop));
1338     else {
1339         naRuntimeError(c, "setlistener() with invalid property argument");
1340         return naNil();
1341     }
1342
1343     if(node->isTied())
1344         SG_LOG(SG_NASAL, SG_DEBUG, "Attaching listener to tied property " <<
1345                 node->getPath());
1346
1347     naRef code = argc > 1 ? args[1] : naNil();
1348     if(!(naIsCode(code) || naIsCCode(code) || naIsFunc(code))) {
1349         naRuntimeError(c, "setlistener() with invalid function argument");
1350         return naNil();
1351     }
1352
1353     int init = argc > 2 && naIsNum(args[2]) ? int(args[2].num) : 0;
1354     int type = argc > 3 && naIsNum(args[3]) ? int(args[3].num) : 1;
1355     FGNasalListener *nl = new FGNasalListener(node, code, this,
1356             gcSave(code), _listenerId, init, type);
1357
1358     node->addChangeListener(nl, init != 0);
1359
1360     _listener[_listenerId] = nl;
1361     return naNum(_listenerId++);
1362 }
1363
1364 // removelistener(int) extension function. The argument is the id of
1365 // a listener as returned by the setlistener() function.
1366 naRef FGNasalSys::removeListener(naContext c, int argc, naRef* args)
1367 {
1368     naRef id = argc > 0 ? args[0] : naNil();
1369     map<int, FGNasalListener *>::iterator it = _listener.find(int(id.num));
1370
1371     if(!naIsNum(id) || it == _listener.end() || it->second->_dead) {
1372         naRuntimeError(c, "removelistener() with invalid listener id");
1373         return naNil();
1374     }
1375
1376     it->second->_dead = true;
1377     _dead_listener.push_back(it->second);
1378     _listener.erase(it);
1379     return naNum(_listener.size());
1380 }
1381
1382 void FGNasalSys::registerToLoad(FGNasalModelData *data)
1383 {
1384   if( _loadList.empty() )
1385     _delay_load = true;
1386   _loadList.push(data);
1387 }
1388
1389 void FGNasalSys::registerToUnload(FGNasalModelData *data)
1390 {
1391     _unloadList.push(data);
1392 }
1393
1394 void FGNasalSys::addCommand(naRef func, const std::string& name)
1395 {
1396     if (_commands.find(name) != _commands.end()) {
1397         SG_LOG(SG_NASAL, SG_WARN, "duplicate add of command:" << name);
1398         return;
1399     }
1400
1401     NasalCommand* cmd = new NasalCommand(this, func, name);
1402     _commands[name] = cmd;
1403 }
1404
1405 void FGNasalSys::removeCommand(const std::string& name)
1406 {
1407     NasalCommandDict::iterator it = _commands.find(name);
1408     if (it == _commands.end()) {
1409         SG_LOG(SG_NASAL, SG_WARN, "remove of unknwon command:" << name);
1410         return;
1411     }
1412
1413     // will delete the NasalCommand instance
1414     globals->get_commands()->removeCommand(name);
1415     _commands.erase(it);
1416 }
1417
1418 //////////////////////////////////////////////////////////////////////////
1419 // FGNasalListener class.
1420
1421 FGNasalListener::FGNasalListener(SGPropertyNode *node, naRef code,
1422                                  FGNasalSys* nasal, int key, int id,
1423                                  int init, int type) :
1424     _node(node),
1425     _code(code),
1426     _gcKey(key),
1427     _id(id),
1428     _nas(nasal),
1429     _init(init),
1430     _type(type),
1431     _active(0),
1432     _dead(false),
1433     _last_int(0L),
1434     _last_float(0.0)
1435 {
1436     if(_type == 0 && !_init)
1437         changed(node);
1438 }
1439
1440 FGNasalListener::~FGNasalListener()
1441 {
1442     _node->removeChangeListener(this);
1443     _nas->gcRelease(_gcKey);
1444 }
1445
1446 void FGNasalListener::call(SGPropertyNode* which, naRef mode)
1447 {
1448     if(_active || _dead) return;
1449     _active++;
1450     naRef arg[4];
1451     arg[0] = _nas->propNodeGhost(which);
1452     arg[1] = _nas->propNodeGhost(_node);
1453     arg[2] = mode;                  // value changed, child added/removed
1454     arg[3] = naNum(_node != which); // child event?
1455     _nas->call(_code, 4, arg, naNil());
1456     _active--;
1457 }
1458
1459 void FGNasalListener::valueChanged(SGPropertyNode* node)
1460 {
1461     if(_type < 2 && node != _node) return;   // skip child events
1462     if(_type > 0 || changed(_node) || _init)
1463         call(node, naNum(0));
1464
1465     _init = 0;
1466 }
1467
1468 void FGNasalListener::childAdded(SGPropertyNode*, SGPropertyNode* child)
1469 {
1470     if(_type == 2) call(child, naNum(1));
1471 }
1472
1473 void FGNasalListener::childRemoved(SGPropertyNode*, SGPropertyNode* child)
1474 {
1475     if(_type == 2) call(child, naNum(-1));
1476 }
1477
1478 bool FGNasalListener::changed(SGPropertyNode* node)
1479 {
1480     using namespace simgear;
1481     props::Type type = node->getType();
1482     if(type == props::NONE) return false;
1483     if(type == props::UNSPECIFIED) return true;
1484
1485     bool result;
1486     switch(type) {
1487     case props::BOOL:
1488     case props::INT:
1489     case props::LONG:
1490         {
1491             long l = node->getLongValue();
1492             result = l != _last_int;
1493             _last_int = l;
1494             return result;
1495         }
1496     case props::FLOAT:
1497     case props::DOUBLE:
1498         {
1499             double d = node->getDoubleValue();
1500             result = d != _last_float;
1501             _last_float = d;
1502             return result;
1503         }
1504     default:
1505         {
1506             string s = node->getStringValue();
1507             result = s != _last_string;
1508             _last_string = s;
1509             return result;
1510         }
1511     }
1512 }
1513
1514 // NasalXMLVisitor class: handles EasyXML visitor callback for parsexml()
1515 //
1516 NasalXMLVisitor::NasalXMLVisitor(naContext c, int argc, naRef* args) :
1517     _c(naSubContext(c)),
1518     _start_element(argc > 1 ? args[1] : naNil()),
1519     _end_element(argc > 2 ? args[2] : naNil()),
1520     _data(argc > 3 ? args[3] : naNil()),
1521     _pi(argc > 4 ? args[4] : naNil())
1522 {
1523 }
1524
1525 void NasalXMLVisitor::startElement(const char* tag, const XMLAttributes& a)
1526 {
1527     if(naIsNil(_start_element)) return;
1528     naRef attr = naNewHash(_c);
1529     for(int i=0; i<a.size(); i++) {
1530         naRef name = make_string(a.getName(i));
1531         naRef value = make_string(a.getValue(i));
1532         naHash_set(attr, name, value);
1533     }
1534     call(_start_element, 2, make_string(tag), attr);
1535 }
1536
1537 void NasalXMLVisitor::endElement(const char* tag)
1538 {
1539     if(!naIsNil(_end_element)) call(_end_element, 1, make_string(tag));
1540 }
1541
1542 void NasalXMLVisitor::data(const char* str, int len)
1543 {
1544     if(!naIsNil(_data)) call(_data, 1, make_string(str, len));
1545 }
1546
1547 void NasalXMLVisitor::pi(const char* target, const char* data)
1548 {
1549     if(!naIsNil(_pi)) call(_pi, 2, make_string(target), make_string(data));
1550 }
1551
1552 void NasalXMLVisitor::call(naRef func, int num, naRef a, naRef b)
1553 {
1554     naRef args[2];
1555     args[0] = a;
1556     args[1] = b;
1557     naCall(_c, func, num, args, naNil(), naNil());
1558     if(naGetError(_c))
1559         naRethrowError(_c);
1560 }
1561
1562 naRef NasalXMLVisitor::make_string(const char* s, int n)
1563 {
1564     return naStr_fromdata(naNewString(_c), const_cast<char *>(s),
1565                           n < 0 ? strlen(s) : n);
1566 }
1567
1568