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