]> git.mxchange.org Git - flightgear.git/blob - src/Scripting/NasalSys.cxx
Add airport dynamics manager
[flightgear.git] / 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         SG_LOG(SG_NASAL, SG_ALERT, "open(): reading/writing '" <<
678         naStr_data(file) << "' denied (unauthorized directory - authorization"
679         " no longer follows symlinks; to authorize reading additional "
680         "directories, add them to --fg-aircraft)");
681         naRuntimeError(c, "open(): access denied (unauthorized directory)");
682         return naNil();
683     }
684     f = fopen(filename.c_str(), modestr);
685     if(!f) naRuntimeError(c, strerror(errno));
686     return naIOGhost(c, f);
687 }
688
689 // Parse XML file.
690 //     parsexml(<path> [, <start-tag> [, <end-tag> [, <data> [, <pi>]]]]);
691 //
692 // <path>      ... absolute path to an XML file
693 // <start-tag> ... callback function with two args: tag name, attribute hash
694 // <end-tag>   ... callback function with one arg:  tag name
695 // <data>      ... callback function with one arg:  data
696 // <pi>        ... callback function with two args: target, data
697 //                 (pi = "processing instruction")
698 // All four callback functions are optional and default to nil.
699 // The function returns nil on error, or the validated file name otherwise.
700 static naRef f_parsexml(naContext c, naRef me, int argc, naRef* args)
701 {
702     if(argc < 1 || !naIsString(args[0]))
703         naRuntimeError(c, "parsexml(): path argument missing or not a string");
704     if(argc > 5) argc = 5;
705     for(int i=1; i<argc; i++)
706         if(!(naIsNil(args[i]) || naIsFunc(args[i])))
707             naRuntimeError(c, "parsexml(): callback argument not a function");
708
709     std::string file = fgValidatePath(naStr_data(args[0]), false);
710     if(file.empty()) {
711         SG_LOG(SG_NASAL, SG_ALERT, "parsexml(): reading '" <<
712         naStr_data(args[0]) << "' denied (unauthorized directory - authorization"
713         " no longer follows symlinks; to authorize reading additional "
714         "directories, add them to --fg-aircraft)");
715         naRuntimeError(c, "parsexml(): access denied (unauthorized directory)");
716         return naNil();
717     }
718     std::ifstream input(file.c_str());
719     NasalXMLVisitor visitor(c, argc, args);
720     try {
721         readXML(input, visitor);
722     } catch (const sg_exception& e) {
723         naRuntimeError(c, "parsexml(): file '%s' %s",
724                 file.c_str(), e.getFormattedMessage().c_str());
725         return naNil();
726     }
727     return naStr_fromdata(naNewString(c), file.c_str(), file.length());
728 }
729
730 /**
731  * Parse very simple and small subset of markdown
732  *
733  * parse_markdown(src)
734  */
735 static naRef f_parse_markdown(naContext c, naRef me, int argc, naRef* args)
736 {
737   nasal::CallContext ctx(c, me, argc, args);
738   return ctx.to_nasal(
739     simgear::SimpleMarkdown::parse(ctx.requireArg<std::string>(0))
740   );
741 }
742
743 /**
744  * Create md5 hash from given string
745  *
746  * md5(str)
747  */
748 static naRef f_md5(naContext c, naRef me, int argc, naRef* args)
749 {
750   if( argc != 1 || !naIsString(args[0]) )
751     naRuntimeError(c, "md5(): wrong type or number of arguments");
752
753   return nasal::to_nasal(
754     c,
755     simgear::strutils::md5(naStr_data(args[0]), naStr_len(args[0]))
756   );
757 }
758
759 // Return UNIX epoch time in seconds.
760 static naRef f_systime(naContext c, naRef me, int argc, naRef* args)
761 {
762 #ifdef _WIN32
763     FILETIME ft;
764     GetSystemTimeAsFileTime(&ft);
765     double t = (4294967296.0 * ft.dwHighDateTime + ft.dwLowDateTime);
766     // Converts from 100ns units in 1601 epoch to unix epoch in sec
767     return naNum((t * 1e-7) - 11644473600.0);
768 #else
769     struct timeval td;
770     gettimeofday(&td, 0);
771     return naNum(td.tv_sec + 1e-6 * td.tv_usec);
772 #endif
773 }
774
775 // Table of extension functions.  Terminate with zeros.
776 static struct { const char* name; naCFunction func; } funcs[] = {
777     { "getprop",   f_getprop },
778     { "setprop",   f_setprop },
779     { "print",     f_print },
780     { "logprint",  f_logprint },
781     { "_fgcommand", f_fgcommand },
782     { "settimer",  f_settimer },
783     { "maketimer", f_makeTimer },
784     { "_setlistener", f_setlistener },
785     { "removelistener", f_removelistener },
786     { "addcommand", f_addCommand },
787     { "removecommand", f_removeCommand },
788     { "_cmdarg",  f_cmdarg },
789     { "_interpolate",  f_interpolate },
790     { "rand",  f_rand },
791     { "srand",  f_srand },
792     { "abort", f_abort },
793     { "directory", f_directory },
794     { "resolvepath", f_resolveDataPath },
795     { "finddata", f_findDataDir },
796     { "parsexml", f_parsexml },
797     { "parse_markdown", f_parse_markdown },
798     { "md5", f_md5 },
799     { "systime", f_systime },
800     { 0, 0 }
801 };
802
803 naRef FGNasalSys::cmdArgGhost()
804 {
805     return propNodeGhost(_cmdArg);
806 }
807
808 void FGNasalSys::setCmdArg(SGPropertyNode* aNode)
809 {
810     _cmdArg = aNode;
811 }
812
813 void FGNasalSys::init()
814 {
815     if (_inited) {
816         SG_LOG(SG_GENERAL, SG_ALERT, "duplicate init of Nasal");
817     }
818     int i;
819
820     _context = naNewContext();
821
822     // Start with globals.  Add it to itself as a recursive
823     // sub-reference under the name "globals".  This gives client-code
824     // write access to the namespace if someone wants to do something
825     // fancy.
826     _globals = naInit_std(_context);
827     naSave(_context, _globals);
828     hashset(_globals, "globals", _globals);
829
830     hashset(_globals, "math", naInit_math(_context));
831     hashset(_globals, "bits", naInit_bits(_context));
832     hashset(_globals, "io", naInit_io(_context));
833     hashset(_globals, "thread", naInit_thread(_context));
834     hashset(_globals, "utf8", naInit_utf8(_context));
835
836     // Add our custom extension functions:
837     for(i=0; funcs[i].name; i++)
838         hashset(_globals, funcs[i].name,
839                 naNewFunc(_context, naNewCCode(_context, funcs[i].func)));
840     nasal::Hash io_module = nasal::Hash(_globals, _context).get<nasal::Hash>("io");
841     io_module.set("open", f_open);
842     
843     // And our SGPropertyNode wrapper
844     hashset(_globals, "props", genPropsModule());
845
846     // Add string methods
847     _string = naInit_string(_context);
848     naSave(_context, _string);
849     initNasalString(_globals, _string, _context);
850
851     initNasalPositioned(_globals, _context);
852     initNasalPositioned_cppbind(_globals, _context);
853     initNasalAircraft(_globals, _context);
854     NasalClipboard::init(this);
855     initNasalCanvas(_globals, _context);
856     initNasalCondition(_globals, _context);
857     initNasalHTTP(_globals, _context);
858     initNasalSGPath(_globals, _context);
859   
860     NasalTimerObj::init("Timer")
861       .method("start", &TimerObj::start)
862       .method("stop", &TimerObj::stop)
863       .method("restart", &TimerObj::restart)
864       .member("singleShot", &TimerObj::isSingleShot, &TimerObj::setSingleShot)
865       .member("isRunning", &TimerObj::isRunning);
866
867     // Set allowed paths for Nasal I/O
868     fgInitAllowedPaths();
869     
870     // Now load the various source files in the Nasal directory
871     simgear::Dir nasalDir(SGPath(globals->get_fg_root(), "Nasal"));
872     loadScriptDirectory(nasalDir);
873
874     // Add modules in Nasal subdirectories to property tree
875     simgear::PathList directories = nasalDir.children(simgear::Dir::TYPE_DIR+
876             simgear::Dir::NO_DOT_OR_DOTDOT, "");
877     for (unsigned int i=0; i<directories.size(); ++i) {
878         simgear::Dir dir(directories[i]);
879         simgear::PathList scripts = dir.children(simgear::Dir::TYPE_FILE, ".nas");
880         addModule(directories[i].file(), scripts);
881     }
882
883     // set signal and remove node to avoid restoring at reinit
884     const char *s = "nasal-dir-initialized";
885     SGPropertyNode *signal = fgGetNode("/sim/signals", true);
886     signal->setBoolValue(s, true);
887     signal->removeChildren(s);
888
889     // Pull scripts out of the property tree, too
890     loadPropertyScripts();
891   
892     // now Nasal modules are loaded, we can do some delayed work
893     postinitNasalPositioned(_globals, _context);
894     postinitNasalGUI(_globals, _context);
895     
896     _inited = true;
897 }
898
899 void FGNasalSys::shutdown()
900 {
901     if (!_inited) {
902         return;
903     }
904     
905     shutdownNasalPositioned();
906     
907     map<int, FGNasalListener *>::iterator it, end = _listener.end();
908     for(it = _listener.begin(); it != end; ++it)
909         delete it->second;
910     _listener.clear();
911     
912     NasalCommandDict::iterator j = _commands.begin();
913     for (; j != _commands.end(); ++j) {
914         globals->get_commands()->removeCommand(j->first);
915     }
916     _commands.clear();
917     
918     std::vector<FGNasalModuleListener*>::iterator k = _moduleListeners.begin();
919     for(; k!= _moduleListeners.end(); ++k)
920         delete *k;
921     _moduleListeners.clear();
922     
923     naClearSaved();
924     
925     _string = naNil(); // will be freed by _context
926     naFreeContext(_context);
927    
928     //setWatchedRef(_globals);
929     
930     // remove the recursive reference in globals
931     hashset(_globals, "globals", naNil());
932     _globals = naNil();    
933     
934     naGC();
935     _inited = false;
936 }
937
938 naRef FGNasalSys::wrappedPropsNode(SGPropertyNode* aProps)
939 {
940     if (naIsNil(_wrappedNodeFunc)) {
941         nasal::Hash props = getGlobals().get<nasal::Hash>("props");
942         _wrappedNodeFunc = props.get("wrapNode");
943     }
944     
945     naRef args[1];
946     args[0] = propNodeGhost(aProps);
947     naContext ctx = naNewContext();
948     naRef wrapped = naCallMethodCtx(ctx, _wrappedNodeFunc, naNil(), 1, args, naNil());
949     naFreeContext(ctx);
950     return wrapped;
951 }
952
953 void FGNasalSys::update(double)
954 {
955     if( NasalClipboard::getInstance() )
956         NasalClipboard::getInstance()->update();
957
958     if(!_dead_listener.empty()) {
959         vector<FGNasalListener *>::iterator it, end = _dead_listener.end();
960         for(it = _dead_listener.begin(); it != end; ++it) delete *it;
961         _dead_listener.clear();
962     }
963
964     if (!_loadList.empty())
965     {
966         if( _delay_load )
967           _delay_load = false;
968         else
969           // process Nasal load hook (only one per update loop to avoid excessive lags)
970           _loadList.pop()->load();
971     }
972     else
973     if (!_unloadList.empty())
974     {
975         // process pending Nasal unload hooks after _all_ load hooks were processed
976         // (only unload one per update loop to avoid excessive lags)
977         _unloadList.pop()->unload();
978     }
979
980     // Destroy all queued ghosts
981     nasal::ghostProcessDestroyList();
982
983     // The global context is a legacy thing.  We use dynamically
984     // created contexts for naCall() now, so that we can call them
985     // recursively.  But there are still spots that want to use it for
986     // naNew*() calls, which end up leaking memory because the context
987     // only clears out its temporary vector when it's *used*.  So just
988     // junk it and fetch a new/reinitialized one every frame.  This is
989     // clumsy: the right solution would use the dynamic context in all
990     // cases and eliminate _context entirely.  But that's more work,
991     // and this works fine (yes, they say "New" and "Free", but
992     // they're very fast, just trust me). -Andy
993     naFreeContext(_context);
994     _context = naNewContext();
995 }
996
997 bool pathSortPredicate(const SGPath& p1, const SGPath& p2)
998 {
999   return p1.file() < p2.file();
1000 }
1001
1002 // Loads all scripts in given directory 
1003 void FGNasalSys::loadScriptDirectory(simgear::Dir nasalDir)
1004 {
1005     simgear::PathList scripts = nasalDir.children(simgear::Dir::TYPE_FILE, ".nas");
1006     // Note: simgear::Dir already reports file entries in a deterministic order,
1007     // so a fixed loading sequence is guaranteed (same for every user)
1008     for (unsigned int i=0; i<scripts.size(); ++i) {
1009       SGPath fullpath(scripts[i]);
1010       SGPath file = fullpath.file();
1011       loadModule(fullpath, file.base().c_str());
1012     }
1013 }
1014
1015 // Create module with list of scripts
1016 void FGNasalSys::addModule(string moduleName, simgear::PathList scripts)
1017 {
1018     if (! scripts.empty())
1019     {
1020         SGPropertyNode* nasal = globals->get_props()->getNode("nasal");
1021         SGPropertyNode* module_node = nasal->getChild(moduleName,0,true);
1022         for (unsigned int i=0; i<scripts.size(); ++i) {
1023             SGPropertyNode* pFileNode = module_node->getChild("file",i,true);
1024             pFileNode->setStringValue(scripts[i].c_str());
1025         }
1026         if (!module_node->hasChild("enabled",0))
1027         {
1028             SGPropertyNode* node = module_node->getChild("enabled",0,true);
1029             node->setBoolValue(true);
1030             node->setAttribute(SGPropertyNode::USERARCHIVE,true);
1031         }
1032     }
1033 }
1034
1035 // Loads the scripts found under /nasal in the global tree
1036 void FGNasalSys::loadPropertyScripts()
1037 {
1038     SGPropertyNode* nasal = globals->get_props()->getNode("nasal");
1039     if(!nasal) return;
1040
1041     for(int i=0; i<nasal->nChildren(); i++)
1042     {
1043         SGPropertyNode* n = nasal->getChild(i);
1044         loadPropertyScripts(n);
1045     }
1046 }
1047
1048 // Loads the scripts found under /nasal in the global tree
1049 void FGNasalSys::loadPropertyScripts(SGPropertyNode* n)
1050 {
1051     bool is_loaded = false;
1052
1053     const char* module = n->getName();
1054     if(n->hasChild("module"))
1055         module = n->getStringValue("module");
1056     if (n->getBoolValue("enabled",true))
1057     {
1058         // allow multiple files to be specified within a single
1059         // Nasal module tag
1060         int j = 0;
1061         SGPropertyNode *fn;
1062         bool file_specified = false;
1063         bool ok=true;
1064         while((fn = n->getChild("file", j)) != NULL) {
1065             file_specified = true;
1066             const char* file = fn->getStringValue();
1067             SGPath p(file);
1068             if (!p.isAbsolute() || !p.exists())
1069             {
1070                 p = globals->resolve_maybe_aircraft_path(file);
1071                 if (p.isNull())
1072                 {
1073                     SG_LOG(SG_NASAL, SG_ALERT, "Cannot find Nasal script '" <<
1074                             file << "' for module '" << module << "'.");
1075                 }
1076             }
1077             ok &= p.isNull() ? false : loadModule(p, module);
1078             j++;
1079         }
1080
1081         const char* src = n->getStringValue("script");
1082         if(!n->hasChild("script")) src = 0; // Hrm...
1083         if(src)
1084             createModule(module, n->getPath().c_str(), src, strlen(src));
1085
1086         if(!file_specified && !src)
1087         {
1088             // module no longer exists - clear the archived "enable" flag
1089             n->setAttribute(SGPropertyNode::USERARCHIVE,false);
1090             SGPropertyNode* node = n->getChild("enabled",0,false);
1091             if (node)
1092                 node->setAttribute(SGPropertyNode::USERARCHIVE,false);
1093
1094             SG_LOG(SG_NASAL, SG_ALERT, "Nasal error: " <<
1095                     "no <file> or <script> defined in " <<
1096                     "/nasal/" << module);
1097         }
1098         else
1099             is_loaded = ok;
1100     }
1101     else
1102     {
1103         SGPropertyNode* enable = n->getChild("enabled");
1104         if (enable)
1105         {
1106             FGNasalModuleListener* listener = new FGNasalModuleListener(n);
1107             _moduleListeners.push_back(listener);
1108             enable->addChangeListener(listener, false);
1109         }
1110     }
1111     SGPropertyNode* loaded = n->getChild("loaded",0,true);
1112     loaded->setAttribute(SGPropertyNode::PRESERVE,true);
1113     loaded->setBoolValue(is_loaded);
1114 }
1115
1116 // Logs a runtime error, with stack trace, to the FlightGear log stream
1117 void FGNasalSys::logError(naContext context)
1118 {
1119     SG_LOG(SG_NASAL, SG_ALERT, "Nasal runtime error: " << naGetError(context));
1120     int stack_depth = naStackDepth(context);
1121     if( stack_depth < 1 )
1122       return;
1123     SG_LOG(SG_NASAL, SG_ALERT,
1124            "  at " << naStr_data(naGetSourceFile(context, 0)) <<
1125            ", line " << naGetLine(context, 0));
1126     for(int i=1; i<stack_depth; i++)
1127         SG_LOG(SG_NASAL, SG_ALERT,
1128                "  called from: " << naStr_data(naGetSourceFile(context, i)) <<
1129                ", line " << naGetLine(context, i));
1130 }
1131
1132 // Reads a script file, executes it, and places the resulting
1133 // namespace into the global namespace under the specified module
1134 // name.
1135 bool FGNasalSys::loadModule(SGPath file, const char* module)
1136 {
1137     int len = 0;
1138     char* buf = readfile(file.c_str(), &len);
1139     if(!buf) {
1140         SG_LOG(SG_NASAL, SG_ALERT,
1141                "Nasal error: could not read script file " << file.c_str()
1142                << " into module " << module);
1143         return false;
1144     }
1145
1146     bool ok = createModule(module, file.c_str(), buf, len);
1147     delete[] buf;
1148     return ok;
1149 }
1150
1151 // Parse and run.  Save the local variables namespace, as it will
1152 // become a sub-object of globals.  The optional "arg" argument can be
1153 // used to pass an associated property node to the module, which can then
1154 // be accessed via cmdarg().  (This is, for example, used by XML dialogs.)
1155 bool FGNasalSys::createModule(const char* moduleName, const char* fileName,
1156                               const char* src, int len,
1157                               const SGPropertyNode* cmdarg,
1158                               int argc, naRef* args)
1159 {
1160     naContext ctx = naNewContext();
1161     naRef code = parse(ctx, fileName, src, len);
1162     if(naIsNil(code)) {
1163         naFreeContext(ctx);
1164         return false;
1165     }
1166
1167     
1168     // See if we already have a module hash to use.  This allows the
1169     // user to, for example, add functions to the built-in math
1170     // module.  Make a new one if necessary.
1171     naRef locals;
1172     naRef modname = naNewString(ctx);
1173     naStr_fromdata(modname, (char*)moduleName, strlen(moduleName));
1174     if (naIsNil(_globals))
1175         return false;
1176         if (!naHash_get(_globals, modname, &locals))
1177         locals = naNewHash(ctx);
1178
1179     _cmdArg = (SGPropertyNode*)cmdarg;
1180
1181     callWithContext(ctx, code, argc, args, locals);
1182     hashset(_globals, moduleName, locals);
1183     
1184     naFreeContext(ctx);
1185     return true;
1186 }
1187
1188 void FGNasalSys::deleteModule(const char* moduleName)
1189 {
1190     if (!_inited) {
1191         // can occur on shutdown due to us being shutdown first, but other
1192         // subsystems having Nasal objects.
1193         return;
1194     }
1195     
1196     naContext ctx = naNewContext();
1197     naRef modname = naNewString(ctx);
1198     naStr_fromdata(modname, (char*)moduleName, strlen(moduleName));
1199     naHash_delete(_globals, modname);
1200     naFreeContext(ctx);
1201 }
1202
1203 naRef FGNasalSys::parse(naContext ctx, const char* filename, const char* buf, int len)
1204 {
1205     int errLine = -1;
1206     naRef srcfile = naNewString(ctx);
1207     naStr_fromdata(srcfile, (char*)filename, strlen(filename));
1208     naRef code = naParseCode(ctx, srcfile, 1, (char*)buf, len, &errLine);
1209     if(naIsNil(code)) {
1210         SG_LOG(SG_NASAL, SG_ALERT,
1211                "Nasal parse error: " << naGetError(ctx) <<
1212                " in "<< filename <<", line " << errLine);
1213         return naNil();
1214     }
1215
1216     // Bind to the global namespace before returning
1217     return naBindFunction(ctx, code, _globals);
1218 }
1219
1220 bool FGNasalSys::handleCommand( const char* moduleName,
1221                                 const char* fileName,
1222                                 const char* src,
1223                                 const SGPropertyNode* arg )
1224 {
1225     naContext ctx = naNewContext();
1226     naRef code = parse(ctx, fileName, src, strlen(src));
1227     if(naIsNil(code)) {
1228         naFreeContext(ctx);
1229         return false;
1230     }
1231
1232     // Commands can be run "in" a module.  Make sure that module
1233     // exists, and set it up as the local variables hash for the
1234     // command.
1235     naRef locals = naNil();
1236     if(moduleName[0]) {
1237         naRef modname = naNewString(ctx);
1238         naStr_fromdata(modname, (char*)moduleName, strlen(moduleName));
1239         if(!naHash_get(_globals, modname, &locals)) {
1240             locals = naNewHash(ctx);
1241             naHash_set(_globals, modname, locals);
1242         }
1243     }
1244
1245     // Cache this command's argument for inspection via cmdarg().  For
1246     // performance reasons, we won't bother with it if the invoked
1247     // code doesn't need it.
1248     _cmdArg = (SGPropertyNode*)arg;
1249
1250     callWithContext(ctx, code, 0, 0, locals);
1251     naFreeContext(ctx);
1252     return true;
1253 }
1254
1255 bool FGNasalSys::handleCommand(const SGPropertyNode* arg)
1256 {
1257   const char* src = arg->getStringValue("script");
1258   const char* moduleName = arg->getStringValue("module");
1259
1260   return handleCommand( moduleName,
1261                         arg->getPath(true).c_str(),
1262                         src,
1263                         arg );
1264 }
1265
1266 // settimer(func, dt, simtime) extension function.  The first argument
1267 // is a Nasal function to call, the second is a delta time (from now),
1268 // in seconds.  The third, if present, is a boolean value indicating
1269 // that "real world" time (rather than simulator time) is to be used.
1270 //
1271 // Implementation note: the FGTimer objects don't live inside the
1272 // garbage collector, so the Nasal handler functions have to be
1273 // "saved" somehow lest they be inadvertently cleaned.  In this case,
1274 // they are inserted into a globals.__gcsave hash and removed on
1275 // expiration.
1276 void FGNasalSys::setTimer(naContext c, int argc, naRef* args)
1277 {
1278     // Extract the handler, delta, and simtime arguments:
1279     naRef handler = argc > 0 ? args[0] : naNil();
1280     if(!(naIsCode(handler) || naIsCCode(handler) || naIsFunc(handler))) {
1281         naRuntimeError(c, "settimer() with invalid function argument");
1282         return;
1283     }
1284
1285     naRef delta = argc > 1 ? args[1] : naNil();
1286     if(naIsNil(delta)) {
1287         naRuntimeError(c, "settimer() with invalid time argument");
1288         return;
1289     }
1290
1291     bool simtime = (argc > 2 && naTrue(args[2])) ? false : true;
1292
1293     // Generate and register a C++ timer handler
1294     NasalTimer* t = new NasalTimer;
1295     t->handler = handler;
1296     t->gcKey = gcSave(handler);
1297     t->nasal = this;
1298
1299     globals->get_event_mgr()->addEvent("NasalTimer",
1300                                        t, &NasalTimer::timerExpired,
1301                                        delta.num, simtime);
1302 }
1303
1304 void FGNasalSys::handleTimer(NasalTimer* t)
1305 {
1306     call(t->handler, 0, 0, naNil());
1307     gcRelease(t->gcKey);
1308 }
1309
1310 int FGNasalSys::gcSave(naRef r)
1311 {
1312     return naGCSave(r);
1313 }
1314
1315 void FGNasalSys::gcRelease(int key)
1316 {
1317     naGCRelease(key);
1318 }
1319
1320
1321 //------------------------------------------------------------------------------
1322 void FGNasalSys::NasalTimer::timerExpired()
1323 {
1324     nasal->handleTimer(this);
1325     delete this;
1326 }
1327
1328 int FGNasalSys::_listenerId = 0;
1329
1330 // setlistener(<property>, <func> [, <initial=0> [, <persistent=1>]])
1331 // Attaches a callback function to a property (specified as a global
1332 // property path string or a SGPropertyNode* ghost). If the third,
1333 // optional argument (default=0) is set to 1, then the function is also
1334 // called initially. If the fourth, optional argument is set to 0, then the
1335 // function is only called when the property node value actually changes.
1336 // Otherwise it's called independent of the value whenever the node is
1337 // written to (default). The setlistener() function returns a unique
1338 // id number, which is to be used as argument to the removelistener()
1339 // function.
1340 naRef FGNasalSys::setListener(naContext c, int argc, naRef* args)
1341 {
1342     SGPropertyNode_ptr node;
1343     naRef prop = argc > 0 ? args[0] : naNil();
1344     if(naIsString(prop)) node = fgGetNode(naStr_data(prop), true);
1345     else if(naIsGhost(prop)) node = static_cast<SGPropertyNode*>(naGhost_ptr(prop));
1346     else {
1347         naRuntimeError(c, "setlistener() with invalid property argument");
1348         return naNil();
1349     }
1350
1351     if(node->isTied())
1352         SG_LOG(SG_NASAL, SG_DEBUG, "Attaching listener to tied property " <<
1353                 node->getPath());
1354
1355     naRef code = argc > 1 ? args[1] : naNil();
1356     if(!(naIsCode(code) || naIsCCode(code) || naIsFunc(code))) {
1357         naRuntimeError(c, "setlistener() with invalid function argument");
1358         return naNil();
1359     }
1360
1361     int init = argc > 2 && naIsNum(args[2]) ? int(args[2].num) : 0;
1362     int type = argc > 3 && naIsNum(args[3]) ? int(args[3].num) : 1;
1363     FGNasalListener *nl = new FGNasalListener(node, code, this,
1364             gcSave(code), _listenerId, init, type);
1365
1366     node->addChangeListener(nl, init != 0);
1367
1368     _listener[_listenerId] = nl;
1369     return naNum(_listenerId++);
1370 }
1371
1372 // removelistener(int) extension function. The argument is the id of
1373 // a listener as returned by the setlistener() function.
1374 naRef FGNasalSys::removeListener(naContext c, int argc, naRef* args)
1375 {
1376     naRef id = argc > 0 ? args[0] : naNil();
1377     map<int, FGNasalListener *>::iterator it = _listener.find(int(id.num));
1378
1379     if(!naIsNum(id) || it == _listener.end() || it->second->_dead) {
1380         naRuntimeError(c, "removelistener() with invalid listener id");
1381         return naNil();
1382     }
1383
1384     it->second->_dead = true;
1385     _dead_listener.push_back(it->second);
1386     _listener.erase(it);
1387     return naNum(_listener.size());
1388 }
1389
1390 void FGNasalSys::registerToLoad(FGNasalModelData *data)
1391 {
1392   if( _loadList.empty() )
1393     _delay_load = true;
1394   _loadList.push(data);
1395 }
1396
1397 void FGNasalSys::registerToUnload(FGNasalModelData *data)
1398 {
1399     _unloadList.push(data);
1400 }
1401
1402 void FGNasalSys::addCommand(naRef func, const std::string& name)
1403 {
1404     if (_commands.find(name) != _commands.end()) {
1405         SG_LOG(SG_NASAL, SG_WARN, "duplicate add of command:" << name);
1406         return;
1407     }
1408     
1409     NasalCommand* cmd = new NasalCommand(this, func, name);
1410     _commands[name] = cmd;
1411 }
1412
1413 void FGNasalSys::removeCommand(const std::string& name)
1414 {
1415     NasalCommandDict::iterator it = _commands.find(name);
1416     if (it == _commands.end()) {
1417         SG_LOG(SG_NASAL, SG_WARN, "remove of unknwon command:" << name);
1418         return;
1419     }
1420
1421     // will delete the NasalCommand instance
1422     globals->get_commands()->removeCommand(name);
1423     _commands.erase(it);
1424 }
1425
1426 //////////////////////////////////////////////////////////////////////////
1427 // FGNasalListener class.
1428
1429 FGNasalListener::FGNasalListener(SGPropertyNode *node, naRef code,
1430                                  FGNasalSys* nasal, int key, int id,
1431                                  int init, int type) :
1432     _node(node),
1433     _code(code),
1434     _gcKey(key),
1435     _id(id),
1436     _nas(nasal),
1437     _init(init),
1438     _type(type),
1439     _active(0),
1440     _dead(false),
1441     _last_int(0L),
1442     _last_float(0.0)
1443 {
1444     if(_type == 0 && !_init)
1445         changed(node);
1446 }
1447
1448 FGNasalListener::~FGNasalListener()
1449 {
1450     _node->removeChangeListener(this);
1451     _nas->gcRelease(_gcKey);
1452 }
1453
1454 void FGNasalListener::call(SGPropertyNode* which, naRef mode)
1455 {
1456     if(_active || _dead) return;
1457     _active++;
1458     naRef arg[4];
1459     arg[0] = _nas->propNodeGhost(which);
1460     arg[1] = _nas->propNodeGhost(_node);
1461     arg[2] = mode;                  // value changed, child added/removed
1462     arg[3] = naNum(_node != which); // child event?
1463     _nas->call(_code, 4, arg, naNil());
1464     _active--;
1465 }
1466
1467 void FGNasalListener::valueChanged(SGPropertyNode* node)
1468 {
1469     if(_type < 2 && node != _node) return;   // skip child events
1470     if(_type > 0 || changed(_node) || _init)
1471         call(node, naNum(0));
1472
1473     _init = 0;
1474 }
1475
1476 void FGNasalListener::childAdded(SGPropertyNode*, SGPropertyNode* child)
1477 {
1478     if(_type == 2) call(child, naNum(1));
1479 }
1480
1481 void FGNasalListener::childRemoved(SGPropertyNode*, SGPropertyNode* child)
1482 {
1483     if(_type == 2) call(child, naNum(-1));
1484 }
1485
1486 bool FGNasalListener::changed(SGPropertyNode* node)
1487 {
1488     using namespace simgear;
1489     props::Type type = node->getType();
1490     if(type == props::NONE) return false;
1491     if(type == props::UNSPECIFIED) return true;
1492
1493     bool result;
1494     switch(type) {
1495     case props::BOOL:
1496     case props::INT:
1497     case props::LONG:
1498         {
1499             long l = node->getLongValue();
1500             result = l != _last_int;
1501             _last_int = l;
1502             return result;
1503         }
1504     case props::FLOAT:
1505     case props::DOUBLE:
1506         {
1507             double d = node->getDoubleValue();
1508             result = d != _last_float;
1509             _last_float = d;
1510             return result;
1511         }
1512     default:
1513         {
1514             string s = node->getStringValue();
1515             result = s != _last_string;
1516             _last_string = s;
1517             return result;
1518         }
1519     }
1520 }
1521
1522 // NasalXMLVisitor class: handles EasyXML visitor callback for parsexml()
1523 //
1524 NasalXMLVisitor::NasalXMLVisitor(naContext c, int argc, naRef* args) :
1525     _c(naSubContext(c)),
1526     _start_element(argc > 1 ? args[1] : naNil()),
1527     _end_element(argc > 2 ? args[2] : naNil()),
1528     _data(argc > 3 ? args[3] : naNil()),
1529     _pi(argc > 4 ? args[4] : naNil())
1530 {
1531 }
1532
1533 void NasalXMLVisitor::startElement(const char* tag, const XMLAttributes& a)
1534 {
1535     if(naIsNil(_start_element)) return;
1536     naRef attr = naNewHash(_c);
1537     for(int i=0; i<a.size(); i++) {
1538         naRef name = make_string(a.getName(i));
1539         naRef value = make_string(a.getValue(i));
1540         naHash_set(attr, name, value);
1541     }
1542     call(_start_element, 2, make_string(tag), attr);
1543 }
1544
1545 void NasalXMLVisitor::endElement(const char* tag)
1546 {
1547     if(!naIsNil(_end_element)) call(_end_element, 1, make_string(tag));
1548 }
1549
1550 void NasalXMLVisitor::data(const char* str, int len)
1551 {
1552     if(!naIsNil(_data)) call(_data, 1, make_string(str, len));
1553 }
1554
1555 void NasalXMLVisitor::pi(const char* target, const char* data)
1556 {
1557     if(!naIsNil(_pi)) call(_pi, 2, make_string(target), make_string(data));
1558 }
1559
1560 void NasalXMLVisitor::call(naRef func, int num, naRef a, naRef b)
1561 {
1562     naRef args[2];
1563     args[0] = a;
1564     args[1] = b;
1565     naCall(_c, func, num, args, naNil(), naNil());
1566     if(naGetError(_c))
1567         naRethrowError(_c);
1568 }
1569
1570 naRef NasalXMLVisitor::make_string(const char* s, int n)
1571 {
1572     return naStr_fromdata(naNewString(_c), const_cast<char *>(s),
1573                           n < 0 ? strlen(s) : n);
1574 }
1575
1576