10 #ifdef HAVE_SYS_TIME_H
11 # include <sys/time.h> // gettimeofday
16 #include <sys/types.h>
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/structure/commands.hxx>
27 #include <simgear/math/sg_geodesy.hxx>
28 #include <simgear/structure/event_mgr.hxx>
29 #include <simgear/debug/BufferedLogCallback.hxx>
31 #include <simgear/nasal/cppbind/from_nasal.hxx>
32 #include <simgear/nasal/cppbind/to_nasal.hxx>
33 #include <simgear/nasal/cppbind/Ghost.hxx>
34 #include <simgear/nasal/cppbind/NasalHash.hxx>
36 #include "NasalSys.hxx"
37 #include "NasalSys_private.hxx"
38 #include "NasalModelData.hxx"
39 #include "NasalPositioned.hxx"
40 #include "NasalCanvas.hxx"
41 #include "NasalClipboard.hxx"
42 #include "NasalCondition.hxx"
43 #include "NasalString.hxx"
45 #include <Main/globals.hxx>
46 #include <Main/util.hxx>
47 #include <Main/fg_props.hxx>
51 void postinitNasalGUI(naRef globals, naContext c);
53 static FGNasalSys* nasalSys = 0;
55 // Listener class for loading Nasal modules on demand
56 class FGNasalModuleListener : public SGPropertyChangeListener
59 FGNasalModuleListener(SGPropertyNode* node);
61 virtual void valueChanged(SGPropertyNode* node);
64 SGPropertyNode_ptr _node;
67 FGNasalModuleListener::FGNasalModuleListener(SGPropertyNode* node) : _node(node)
71 void FGNasalModuleListener::valueChanged(SGPropertyNode*)
73 if (_node->getBoolValue("enabled",false)&&
74 !_node->getBoolValue("loaded",true))
76 nasalSys->loadPropertyScripts(_node);
80 //////////////////////////////////////////////////////////////////////////
83 class TimerObj : public SGReferenced
86 TimerObj(FGNasalSys* sys, naRef f, naRef self, double interval) :
95 snprintf(nm, 128, "nasal-timer-%p", this);
97 _gcRoot = sys->gcSave(f);
98 _gcSelf = sys->gcSave(self);
104 _sys->gcRelease(_gcRoot);
105 _sys->gcRelease(_gcSelf);
108 bool isRunning() const { return _isRunning; }
113 globals->get_event_mgr()->removeTask(_name);
126 globals->get_event_mgr()->addEvent(_name, this, &TimerObj::invoke, _interval);
128 globals->get_event_mgr()->addTask(_name, this, &TimerObj::invoke, _interval);
132 // stop and then start -
133 void restart(double newInterval)
135 _interval = newInterval;
143 _sys->callMethod(_func, _self, 0, args, naNil() /* locals */);
149 void setSingleShot(bool aSingleShot)
151 _singleShot = aSingleShot;
154 bool isSingleShot() const
155 { return _singleShot; }
160 int _gcRoot, _gcSelf;
166 typedef SGSharedPtr<TimerObj> TimerObjRef;
167 typedef nasal::Ghost<TimerObjRef> NasalTimerObj;
169 ///////////////////////////////////////////////////////////////////////////
171 // Read and return file contents in a single buffer. Note use of
172 // stat() to get the file size. This is a win32 function, believe it
173 // or not. :) Note the REALLY IMPORTANT use of the "b" flag to fopen.
174 // Text mode brain damage will kill us if we're trying to do bytewise
176 static char* readfile(const char* file, int* lenOut)
179 if(stat(file, &data) != 0) return 0;
180 FILE* f = fopen(file, "rb");
182 char* buf = new char[data.st_size];
183 *lenOut = fread(buf, 1, data.st_size, f);
185 if(*lenOut != data.st_size) {
186 // Shouldn't happen, but warn anyway since it represents a
187 // platform bug and not a typical runtime error (missing file,
189 SG_LOG(SG_NASAL, SG_ALERT,
190 "ERROR in Nasal initialization: " <<
191 "short count returned from fread() of " << file <<
192 ". Check your C library!");
199 FGNasalSys::FGNasalSys()
206 _nextGCKey = 0; // Any value will do
209 _log = new simgear::BufferedLogCallback(SG_NASAL, SG_INFO);
210 _log->truncateAt(255);
211 sglog().addCallback(_log);
214 // Utility. Sets a named key in a hash by C string, rather than nasal
216 void FGNasalSys::hashset(naRef hash, const char* key, naRef val)
218 naRef s = naNewString(_context);
219 naStr_fromdata(s, (char*)key, strlen(key));
220 naHash_set(hash, s, val);
223 void FGNasalSys::globalsSet(const char* key, naRef val)
225 hashset(_globals, key, val);
228 naRef FGNasalSys::call(naRef code, int argc, naRef* args, naRef locals)
230 return callMethod(code, naNil(), argc, args, locals);
233 // Does a naCall() in a new context. Wrapped here to make lock
234 // tracking easier. Extension functions are called with the lock, but
235 // we have to release it before making a new naCall(). So rather than
236 // drop the lock in every extension function that might call back into
237 // Nasal, we keep a stack depth counter here and only unlock/lock
238 // around the naCall if it isn't the first one.
240 naRef FGNasalSys::callMethod(naRef code, naRef self, int argc, naRef* args, naRef locals)
242 naContext ctx = naNewContext();
243 if(_callCount) naModUnlock();
245 naRef result = naCall(ctx, code, argc, args, self, locals);
249 if(_callCount) naModLock();
254 FGNasalSys::~FGNasalSys()
257 map<int, FGNasalListener *>::iterator it, end = _listener.end();
258 for(it = _listener.begin(); it != end; ++it)
261 naFreeContext(_context);
266 bool FGNasalSys::parseAndRun(const char* sourceCode)
268 naRef code = parse("FGNasalSys::parseAndRun()", sourceCode,
272 call(code, 0, 0, naNil());
277 FGNasalScript* FGNasalSys::parseScript(const char* src, const char* name)
279 FGNasalScript* script = new FGNasalScript();
280 script->_gcKey = -1; // important, if we delete it on a parse
281 script->_nas = this; // error, don't clobber a real handle!
285 sprintf(buf, "FGNasalScript@%p", (void *)script);
289 script->_code = parse(name, src, strlen(src));
290 if(naIsNil(script->_code)) {
295 script->_gcKey = gcSave(script->_code);
300 // The get/setprop functions accept a *list* of strings and walk
301 // through the property tree with them to find the appropriate node.
302 // This allows a Nasal object to hold onto a property path and use it
303 // like a node object, e.g. setprop(ObjRoot, "size-parsecs", 2.02). This
304 // is the utility function that walks the property tree.
305 // Future enhancement: support integer arguments to specify array
307 static SGPropertyNode* findnode(naContext c, naRef* vec, int len)
309 SGPropertyNode* p = globals->get_props();
311 for(int i=0; i<len; i++) {
313 if(!naIsString(a)) return 0;
314 p = p->getNode(naStr_data(a));
317 } catch (const string& err) {
318 naRuntimeError(c, (char *)err.c_str());
324 // getprop() extension function. Concatenates its string arguments as
325 // property names and returns the value of the specified property. Or
326 // nil if it doesn't exist.
327 static naRef f_getprop(naContext c, naRef me, int argc, naRef* args)
329 using namespace simgear;
330 const SGPropertyNode* p = findnode(c, args, argc);
331 if(!p) return naNil();
333 switch(p->getType()) {
334 case props::BOOL: case props::INT:
335 case props::LONG: case props::FLOAT:
338 double dv = p->getDoubleValue();
339 if (SGMisc<double>::isNaN(dv)) {
340 SG_LOG(SG_NASAL, SG_ALERT, "Nasal getprop: property " << p->getPath() << " is NaN");
348 case props::UNSPECIFIED:
350 naRef nastr = naNewString(c);
351 const char* val = p->getStringValue();
352 naStr_fromdata(nastr, (char*)val, strlen(val));
355 case props::ALIAS: // <--- FIXME, recurse?
361 // setprop() extension function. Concatenates its string arguments as
362 // property names and sets the value of the specified property to the
364 static naRef f_setprop(naContext c, naRef me, int argc, naRef* args)
367 char buf[BUFLEN + 1];
371 if(argc < 2) naRuntimeError(c, "setprop() expects at least 2 arguments");
372 for(int i=0; i<argc-1; i++) {
373 naRef s = naStringValue(c, args[i]);
374 if(naIsNil(s)) return naNil();
375 strncpy(p, naStr_data(s), buflen);
377 buflen = BUFLEN - (p - buf);
378 if(i < (argc-2) && buflen > 0) {
384 SGPropertyNode* props = globals->get_props();
385 naRef val = args[argc-1];
388 if(naIsString(val)) result = props->setStringValue(buf, naStr_data(val));
390 naRef n = naNumValue(val);
392 naRuntimeError(c, "setprop() value is not string or number");
394 if (SGMisc<double>::isNaN(n.num)) {
395 naRuntimeError(c, "setprop() passed a NaN");
398 result = props->setDoubleValue(buf, n.num);
400 } catch (const string& err) {
401 naRuntimeError(c, (char *)err.c_str());
403 return naNum(result);
407 // print() extension function. Concatenates and prints its arguments
408 // to the FlightGear log. Uses the highest log level (SG_ALERT), to
409 // make sure it appears. Is there better way to do this?
410 static naRef f_print(naContext c, naRef me, int argc, naRef* args)
414 for(int i=0; i<n; i++) {
415 naRef s = naStringValue(c, args[i]);
416 if(naIsNil(s)) continue;
417 buf += naStr_data(s);
419 SG_LOG(SG_NASAL, SG_ALERT, buf);
420 return naNum(buf.length());
423 // logprint() extension function. Same as above, all arguments after the
424 // first argument are concatenated. Argument 0 is the log-level, matching
426 static naRef f_logprint(naContext c, naRef me, int argc, naRef* args)
429 naRuntimeError(c, "no prioirty argument to logprint()");
431 naRef priority = args[0];
434 for(int i=1; i<n; i++) {
435 naRef s = naStringValue(c, args[i]);
436 if(naIsNil(s)) continue;
437 buf += naStr_data(s);
439 // use the nasal source file and line for the message location, since
440 // that's more useful than the location here!
441 sglog().log(SG_NASAL, (sgDebugPriority)(int) priority.num,
442 naStr_data(naGetSourceFile(c, 0)),
443 naGetLine(c, 0), buf);
444 return naNum(buf.length());
448 // fgcommand() extension function. Executes a named command via the
449 // FlightGear command manager. Takes a single property node name as
451 static naRef f_fgcommand(naContext c, naRef me, int argc, naRef* args)
453 naRef cmd = argc > 0 ? args[0] : naNil();
454 naRef props = argc > 1 ? args[1] : naNil();
455 if(!naIsString(cmd) || (!naIsNil(props) && !naIsGhost(props)))
456 naRuntimeError(c, "bad arguments to fgcommand()");
457 SGPropertyNode_ptr tmp, *node;
459 node = (SGPropertyNode_ptr*)naGhost_ptr(props);
461 tmp = new SGPropertyNode();
464 return naNum(globals->get_commands()->execute(naStr_data(cmd), *node));
467 // settimer(func, dt, simtime) extension function. Falls through to
468 // FGNasalSys::setTimer(). See there for docs.
469 static naRef f_settimer(naContext c, naRef me, int argc, naRef* args)
471 nasalSys->setTimer(c, argc, args);
475 static naRef f_makeTimer(naContext c, naRef me, int argc, naRef* args)
477 if (!naIsNum(args[0])) {
478 naRuntimeError(c, "bad interval argument to maketimer");
481 naRef func, self = naNil();
482 if (naIsFunc(args[1])) {
484 } else if ((argc == 3) && naIsFunc(args[2])) {
489 TimerObj* timerObj = new TimerObj(nasalSys, func, self, args[0].num);
490 return NasalTimerObj::create(c, timerObj);
493 // setlistener(func, property, bool) extension function. Falls through to
494 // FGNasalSys::setListener(). See there for docs.
495 static naRef f_setlistener(naContext c, naRef me, int argc, naRef* args)
497 return nasalSys->setListener(c, argc, args);
500 // removelistener(int) extension function. Falls through to
501 // FGNasalSys::removeListener(). See there for docs.
502 static naRef f_removelistener(naContext c, naRef me, int argc, naRef* args)
504 return nasalSys->removeListener(c, argc, args);
507 // Returns a ghost handle to the argument to the currently executing
509 static naRef f_cmdarg(naContext c, naRef me, int argc, naRef* args)
511 return nasalSys->cmdArgGhost();
514 // Sets up a property interpolation. The first argument is either a
515 // ghost (SGPropertyNode_ptr*) or a string (global property path) to
516 // interpolate. The second argument is a vector of pairs of
517 // value/delta numbers.
518 static naRef f_interpolate(naContext c, naRef me, int argc, naRef* args)
520 SGPropertyNode* node;
521 naRef prop = argc > 0 ? args[0] : naNil();
522 if(naIsString(prop)) node = fgGetNode(naStr_data(prop), true);
523 else if(naIsGhost(prop)) node = *(SGPropertyNode_ptr*)naGhost_ptr(prop);
526 naRef curve = argc > 1 ? args[1] : naNil();
527 if(!naIsVector(curve)) return naNil();
528 int nPoints = naVec_size(curve) / 2;
530 simgear::PropertyList value_nodes;
531 value_nodes.reserve(nPoints);
533 deltas.reserve(nPoints);
535 for( int i = 0; i < nPoints; ++i )
537 SGPropertyNode* val = new SGPropertyNode;
538 val->setDoubleValue(naNumValue(naVec_get(curve, 2*i)).num);
539 value_nodes.push_back(val);
540 deltas.push_back(naNumValue(naVec_get(curve, 2*i+1)).num);
543 node->interpolate("numeric", value_nodes, deltas, "linear");
547 // This is a better RNG than the one in the default Nasal distribution
548 // (which is based on the C library rand() implementation). It will
550 static naRef f_rand(naContext c, naRef me, int argc, naRef* args)
552 return naNum(sg_random());
555 static naRef f_srand(naContext c, naRef me, int argc, naRef* args)
561 static naRef f_abort(naContext c, naRef me, int argc, naRef* args)
567 // Return an array listing of all files in a directory
568 static naRef f_directory(naContext c, naRef me, int argc, naRef* args)
570 if(argc != 1 || !naIsString(args[0]))
571 naRuntimeError(c, "bad arguments to directory()");
573 simgear::Dir d(SGPath(naStr_data(args[0])));
574 if(!d.exists()) return naNil();
575 naRef result = naNewVector(c);
577 simgear::PathList paths = d.children(simgear::Dir::TYPE_FILE | simgear::Dir::TYPE_DIR);
578 for (unsigned int i=0; i<paths.size(); ++i) {
579 std::string p = paths[i].file();
580 naVec_append(result, naStr_fromdata(naNewString(c), p.c_str(), p.size()));
587 * Given a data path, resolve it in FG_ROOT or an FG_AIRCRFT directory
589 static naRef f_resolveDataPath(naContext c, naRef me, int argc, naRef* args)
591 if(argc != 1 || !naIsString(args[0]))
592 naRuntimeError(c, "bad arguments to resolveDataPath()");
594 SGPath p = globals->resolve_maybe_aircraft_path(naStr_data(args[0]));
595 const char* pdata = p.c_str();
596 return naStr_fromdata(naNewString(c), const_cast<char*>(pdata), strlen(pdata));
599 class NasalCommand : public SGCommandMgr::Command
602 NasalCommand(FGNasalSys* sys, naRef f) :
606 _gcRoot = sys->gcSave(f);
609 virtual ~NasalCommand()
611 _sys->gcRelease(_gcRoot);
614 virtual bool operator()(const SGPropertyNode* aNode)
616 _sys->setCmdArg(const_cast<SGPropertyNode*>(aNode));
618 args[0] = _sys->wrappedPropsNode(const_cast<SGPropertyNode*>(aNode));
620 _sys->callMethod(_func, naNil(), 1, args, naNil() /* locals */);
631 static naRef f_addCommand(naContext c, naRef me, int argc, naRef* args)
633 if(argc != 2 || !naIsString(args[0]) || !naIsFunc(args[1]))
634 naRuntimeError(c, "bad arguments to addcommand()");
636 naRef func = args[1];
637 NasalCommand* cmd = new NasalCommand(nasalSys, func);
638 globals->get_commands()->addCommandObject(naStr_data(args[0]), cmd);
642 static naRef f_removeCommand(naContext c, naRef me, int argc, naRef* args)
644 SGCommandMgr::Command* cmd = globals->get_commands()->getCommand(naStr_data(args[0]));
646 // SGCommandMgr::Command* cmd = globals->get_commands()->removeCommand(naStr_data(args[0]))
654 // parsexml(<path> [, <start-tag> [, <end-tag> [, <data> [, <pi>]]]]);
656 // <path> ... absolute path to an XML file
657 // <start-tag> ... callback function with two args: tag name, attribute hash
658 // <end-tag> ... callback function with one arg: tag name
659 // <data> ... callback function with one arg: data
660 // <pi> ... callback function with two args: target, data
661 // (pi = "processing instruction")
662 // All four callback functions are optional and default to nil.
663 // The function returns nil on error, or the validated file name otherwise.
664 static naRef f_parsexml(naContext c, naRef me, int argc, naRef* args)
666 if(argc < 1 || !naIsString(args[0]))
667 naRuntimeError(c, "parsexml(): path argument missing or not a string");
668 if(argc > 5) argc = 5;
669 for(int i=1; i<argc; i++)
670 if(!(naIsNil(args[i]) || naIsFunc(args[i])))
671 naRuntimeError(c, "parsexml(): callback argument not a function");
673 const char* file = fgValidatePath(naStr_data(args[0]), false);
675 naRuntimeError(c, "parsexml(): reading '%s' denied "
676 "(unauthorized access)", naStr_data(args[0]));
679 std::ifstream input(file);
680 NasalXMLVisitor visitor(c, argc, args);
682 readXML(input, visitor);
683 } catch (const sg_exception& e) {
684 naRuntimeError(c, "parsexml(): file '%s' %s",
685 file, e.getFormattedMessage().c_str());
688 return naStr_fromdata(naNewString(c), const_cast<char*>(file), strlen(file));
691 // Return UNIX epoch time in seconds.
692 static naRef f_systime(naContext c, naRef me, int argc, naRef* args)
696 GetSystemTimeAsFileTime(&ft);
697 double t = (4294967296.0 * ft.dwHighDateTime + ft.dwLowDateTime);
698 // Converts from 100ns units in 1601 epoch to unix epoch in sec
699 return naNum((t * 1e-7) - 11644473600.0);
702 gettimeofday(&td, 0);
703 return naNum(td.tv_sec + 1e-6 * td.tv_usec);
707 // Table of extension functions. Terminate with zeros.
708 static struct { const char* name; naCFunction func; } funcs[] = {
709 { "getprop", f_getprop },
710 { "setprop", f_setprop },
711 { "print", f_print },
712 { "logprint", f_logprint },
713 { "_fgcommand", f_fgcommand },
714 { "settimer", f_settimer },
715 { "maketimer", f_makeTimer },
716 { "_setlistener", f_setlistener },
717 { "removelistener", f_removelistener },
718 { "addcommand", f_addCommand },
719 { "removecommand", f_removeCommand },
720 { "_cmdarg", f_cmdarg },
721 { "_interpolate", f_interpolate },
723 { "srand", f_srand },
724 { "abort", f_abort },
725 { "directory", f_directory },
726 { "resolvepath", f_resolveDataPath },
727 { "parsexml", f_parsexml },
728 { "systime", f_systime },
732 naRef FGNasalSys::cmdArgGhost()
734 return propNodeGhost(_cmdArg);
737 void FGNasalSys::setCmdArg(SGPropertyNode* aNode)
742 void FGNasalSys::init()
746 _context = naNewContext();
748 // Start with globals. Add it to itself as a recursive
749 // sub-reference under the name "globals". This gives client-code
750 // write access to the namespace if someone wants to do something
752 _globals = naInit_std(_context);
753 naSave(_context, _globals);
754 hashset(_globals, "globals", _globals);
756 hashset(_globals, "math", naInit_math(_context));
757 hashset(_globals, "bits", naInit_bits(_context));
758 hashset(_globals, "io", naInit_io(_context));
759 hashset(_globals, "thread", naInit_thread(_context));
760 hashset(_globals, "utf8", naInit_utf8(_context));
762 // Add our custom extension functions:
763 for(i=0; funcs[i].name; i++)
764 hashset(_globals, funcs[i].name,
765 naNewFunc(_context, naNewCCode(_context, funcs[i].func)));
767 // And our SGPropertyNode wrapper
768 hashset(_globals, "props", genPropsModule());
770 // Make a "__gcsave" hash to hold the naRef objects which get
771 // passed to handles outside the interpreter (to protect them from
772 // begin garbage-collected).
773 _gcHash = naNewHash(_context);
774 hashset(_globals, "__gcsave", _gcHash);
776 // Add string methods
777 _string = naInit_string(_context);
778 naSave(_context, _string);
779 initNasalString(_globals, _string, _context, _gcHash);
781 initNasalPositioned(_globals, _context, _gcHash);
782 initNasalPositioned_cppbind(_globals, _context, _gcHash);
783 NasalClipboard::init(this);
784 initNasalCanvas(_globals, _context, _gcHash);
785 initNasalCondition(_globals, _context, _gcHash);
787 NasalTimerObj::init("Timer")
788 .method("start", &TimerObj::start)
789 .method("stop", &TimerObj::stop)
790 .method("restart", &TimerObj::restart)
791 .member("singleShot", &TimerObj::isSingleShot, &TimerObj::setSingleShot)
792 .member("isRunning", &TimerObj::isRunning);
794 // Now load the various source files in the Nasal directory
795 simgear::Dir nasalDir(SGPath(globals->get_fg_root(), "Nasal"));
796 loadScriptDirectory(nasalDir);
798 // Add modules in Nasal subdirectories to property tree
799 simgear::PathList directories = nasalDir.children(simgear::Dir::TYPE_DIR+
800 simgear::Dir::NO_DOT_OR_DOTDOT, "");
801 for (unsigned int i=0; i<directories.size(); ++i) {
802 simgear::Dir dir(directories[i]);
803 simgear::PathList scripts = dir.children(simgear::Dir::TYPE_FILE, ".nas");
804 addModule(directories[i].file(), scripts);
807 // set signal and remove node to avoid restoring at reinit
808 const char *s = "nasal-dir-initialized";
809 SGPropertyNode *signal = fgGetNode("/sim/signals", true);
810 signal->setBoolValue(s, true);
811 signal->removeChildren(s, false);
813 // Pull scripts out of the property tree, too
814 loadPropertyScripts();
816 // now Nasal modules are loaded, we can do some delayed work
817 postinitNasalPositioned(_globals, _context);
818 postinitNasalGUI(_globals, _context);
821 naRef FGNasalSys::wrappedPropsNode(SGPropertyNode* aProps)
823 static naRef wrapNodeFunc = naNil();
824 if (naIsNil(wrapNodeFunc)) {
825 nasal::Hash props = getGlobals().get<nasal::Hash>("props");
826 wrapNodeFunc = props.get("wrapNode");
830 args[0] = propNodeGhost(aProps);
831 return naCall(_context, wrapNodeFunc, 1, args, naNil(), naNil());
834 void FGNasalSys::update(double)
836 if( NasalClipboard::getInstance() )
837 NasalClipboard::getInstance()->update();
839 if(!_dead_listener.empty()) {
840 vector<FGNasalListener *>::iterator it, end = _dead_listener.end();
841 for(it = _dead_listener.begin(); it != end; ++it) delete *it;
842 _dead_listener.clear();
845 if (!_loadList.empty())
847 // process Nasal load hook (only one per update loop to avoid excessive lags)
848 _loadList.pop()->load();
851 if (!_unloadList.empty())
853 // process pending Nasal unload hooks after _all_ load hooks were processed
854 // (only unload one per update loop to avoid excessive lags)
855 _unloadList.pop()->unload();
858 // The global context is a legacy thing. We use dynamically
859 // created contexts for naCall() now, so that we can call them
860 // recursively. But there are still spots that want to use it for
861 // naNew*() calls, which end up leaking memory because the context
862 // only clears out its temporary vector when it's *used*. So just
863 // junk it and fetch a new/reinitialized one every frame. This is
864 // clumsy: the right solution would use the dynamic context in all
865 // cases and eliminate _context entirely. But that's more work,
866 // and this works fine (yes, they say "New" and "Free", but
867 // they're very fast, just trust me). -Andy
868 naFreeContext(_context);
869 _context = naNewContext();
872 bool pathSortPredicate(const SGPath& p1, const SGPath& p2)
874 return p1.file() < p2.file();
877 // Loads all scripts in given directory
878 void FGNasalSys::loadScriptDirectory(simgear::Dir nasalDir)
880 simgear::PathList scripts = nasalDir.children(simgear::Dir::TYPE_FILE, ".nas");
881 // Note: simgear::Dir already reports file entries in a deterministic order,
882 // so a fixed loading sequence is guaranteed (same for every user)
883 for (unsigned int i=0; i<scripts.size(); ++i) {
884 SGPath fullpath(scripts[i]);
885 SGPath file = fullpath.file();
886 loadModule(fullpath, file.base().c_str());
890 // Create module with list of scripts
891 void FGNasalSys::addModule(string moduleName, simgear::PathList scripts)
893 if (scripts.size()>0)
895 SGPropertyNode* nasal = globals->get_props()->getNode("nasal");
896 SGPropertyNode* module_node = nasal->getChild(moduleName,0,true);
897 for (unsigned int i=0; i<scripts.size(); ++i) {
898 SGPropertyNode* pFileNode = module_node->getChild("file",i,true);
899 pFileNode->setStringValue(scripts[i].c_str());
901 if (!module_node->hasChild("enabled",0))
903 SGPropertyNode* node = module_node->getChild("enabled",0,true);
904 node->setBoolValue(true);
905 node->setAttribute(SGPropertyNode::USERARCHIVE,true);
910 // Loads the scripts found under /nasal in the global tree
911 void FGNasalSys::loadPropertyScripts()
913 SGPropertyNode* nasal = globals->get_props()->getNode("nasal");
916 for(int i=0; i<nasal->nChildren(); i++)
918 SGPropertyNode* n = nasal->getChild(i);
919 loadPropertyScripts(n);
923 // Loads the scripts found under /nasal in the global tree
924 void FGNasalSys::loadPropertyScripts(SGPropertyNode* n)
926 bool is_loaded = false;
928 const char* module = n->getName();
929 if(n->hasChild("module"))
930 module = n->getStringValue("module");
931 if (n->getBoolValue("enabled",true))
933 // allow multiple files to be specified within a single
937 bool file_specified = false;
939 while((fn = n->getChild("file", j)) != NULL) {
940 file_specified = true;
941 const char* file = fn->getStringValue();
943 if (!p.isAbsolute() || !p.exists())
945 p = globals->resolve_maybe_aircraft_path(file);
948 SG_LOG(SG_NASAL, SG_ALERT, "Cannot find Nasal script '" <<
949 file << "' for module '" << module << "'.");
952 ok &= p.isNull() ? false : loadModule(p, module);
956 const char* src = n->getStringValue("script");
957 if(!n->hasChild("script")) src = 0; // Hrm...
959 createModule(module, n->getPath().c_str(), src, strlen(src));
961 if(!file_specified && !src)
963 // module no longer exists - clear the archived "enable" flag
964 n->setAttribute(SGPropertyNode::USERARCHIVE,false);
965 SGPropertyNode* node = n->getChild("enabled",0,false);
967 node->setAttribute(SGPropertyNode::USERARCHIVE,false);
969 SG_LOG(SG_NASAL, SG_ALERT, "Nasal error: " <<
970 "no <file> or <script> defined in " <<
971 "/nasal/" << module);
978 SGPropertyNode* enable = n->getChild("enabled");
981 FGNasalModuleListener* listener = new FGNasalModuleListener(n);
982 enable->addChangeListener(listener, false);
985 SGPropertyNode* loaded = n->getChild("loaded",0,true);
986 loaded->setAttribute(SGPropertyNode::PRESERVE,true);
987 loaded->setBoolValue(is_loaded);
990 // Logs a runtime error, with stack trace, to the FlightGear log stream
991 void FGNasalSys::logError(naContext context)
993 SG_LOG(SG_NASAL, SG_ALERT,
994 "Nasal runtime error: " << naGetError(context));
995 SG_LOG(SG_NASAL, SG_ALERT,
996 " at " << naStr_data(naGetSourceFile(context, 0)) <<
997 ", line " << naGetLine(context, 0));
998 for(int i=1; i<naStackDepth(context); i++)
999 SG_LOG(SG_NASAL, SG_ALERT,
1000 " called from: " << naStr_data(naGetSourceFile(context, i)) <<
1001 ", line " << naGetLine(context, i));
1004 // Reads a script file, executes it, and places the resulting
1005 // namespace into the global namespace under the specified module
1007 bool FGNasalSys::loadModule(SGPath file, const char* module)
1010 char* buf = readfile(file.c_str(), &len);
1012 SG_LOG(SG_NASAL, SG_ALERT,
1013 "Nasal error: could not read script file " << file.c_str()
1014 << " into module " << module);
1018 bool ok = createModule(module, file.c_str(), buf, len);
1023 // Parse and run. Save the local variables namespace, as it will
1024 // become a sub-object of globals. The optional "arg" argument can be
1025 // used to pass an associated property node to the module, which can then
1026 // be accessed via cmdarg(). (This is, for example, used by XML dialogs.)
1027 bool FGNasalSys::createModule(const char* moduleName, const char* fileName,
1028 const char* src, int len,
1029 const SGPropertyNode* cmdarg,
1030 int argc, naRef* args)
1032 naRef code = parse(fileName, src, len);
1036 // See if we already have a module hash to use. This allows the
1037 // user to, for example, add functions to the built-in math
1038 // module. Make a new one if necessary.
1040 naRef modname = naNewString(_context);
1041 naStr_fromdata(modname, (char*)moduleName, strlen(moduleName));
1042 if(!naHash_get(_globals, modname, &locals))
1043 locals = naNewHash(_context);
1045 _cmdArg = (SGPropertyNode*)cmdarg;
1047 call(code, argc, args, locals);
1048 hashset(_globals, moduleName, locals);
1052 void FGNasalSys::deleteModule(const char* moduleName)
1054 naRef modname = naNewString(_context);
1055 naStr_fromdata(modname, (char*)moduleName, strlen(moduleName));
1056 naHash_delete(_globals, modname);
1059 naRef FGNasalSys::parse(const char* filename, const char* buf, int len)
1062 naRef srcfile = naNewString(_context);
1063 naStr_fromdata(srcfile, (char*)filename, strlen(filename));
1064 naRef code = naParseCode(_context, srcfile, 1, (char*)buf, len, &errLine);
1066 SG_LOG(SG_NASAL, SG_ALERT,
1067 "Nasal parse error: " << naGetError(_context) <<
1068 " in "<< filename <<", line " << errLine);
1072 // Bind to the global namespace before returning
1073 return naBindFunction(_context, code, _globals);
1076 bool FGNasalSys::handleCommand( const char* moduleName,
1077 const char* fileName,
1079 const SGPropertyNode* arg )
1081 naRef code = parse(fileName, src, strlen(src));
1082 if(naIsNil(code)) return false;
1084 // Commands can be run "in" a module. Make sure that module
1085 // exists, and set it up as the local variables hash for the
1087 naRef locals = naNil();
1089 naRef modname = naNewString(_context);
1090 naStr_fromdata(modname, (char*)moduleName, strlen(moduleName));
1091 if(!naHash_get(_globals, modname, &locals)) {
1092 locals = naNewHash(_context);
1093 naHash_set(_globals, modname, locals);
1097 // Cache this command's argument for inspection via cmdarg(). For
1098 // performance reasons, we won't bother with it if the invoked
1099 // code doesn't need it.
1100 _cmdArg = (SGPropertyNode*)arg;
1102 call(code, 0, 0, locals);
1106 bool FGNasalSys::handleCommand(const SGPropertyNode* arg)
1108 const char* src = arg->getStringValue("script");
1109 const char* moduleName = arg->getStringValue("module");
1111 return handleCommand( moduleName,
1112 arg ? arg->getPath(true).c_str() : moduleName,
1117 // settimer(func, dt, simtime) extension function. The first argument
1118 // is a Nasal function to call, the second is a delta time (from now),
1119 // in seconds. The third, if present, is a boolean value indicating
1120 // that "real world" time (rather than simulator time) is to be used.
1122 // Implementation note: the FGTimer objects don't live inside the
1123 // garbage collector, so the Nasal handler functions have to be
1124 // "saved" somehow lest they be inadvertently cleaned. In this case,
1125 // they are inserted into a globals.__gcsave hash and removed on
1127 void FGNasalSys::setTimer(naContext c, int argc, naRef* args)
1129 // Extract the handler, delta, and simtime arguments:
1130 naRef handler = argc > 0 ? args[0] : naNil();
1131 if(!(naIsCode(handler) || naIsCCode(handler) || naIsFunc(handler))) {
1132 naRuntimeError(c, "settimer() with invalid function argument");
1136 naRef delta = argc > 1 ? args[1] : naNil();
1137 if(naIsNil(delta)) {
1138 naRuntimeError(c, "settimer() with invalid time argument");
1142 bool simtime = (argc > 2 && naTrue(args[2])) ? false : true;
1144 // Generate and register a C++ timer handler
1145 NasalTimer* t = new NasalTimer;
1146 t->handler = handler;
1147 t->gcKey = gcSave(handler);
1150 globals->get_event_mgr()->addEvent("NasalTimer",
1151 t, &NasalTimer::timerExpired,
1152 delta.num, simtime);
1155 void FGNasalSys::handleTimer(NasalTimer* t)
1157 call(t->handler, 0, 0, naNil());
1158 gcRelease(t->gcKey);
1161 int FGNasalSys::gcSave(naRef r)
1163 int key = _nextGCKey++;
1164 naHash_set(_gcHash, naNum(key), r);
1168 void FGNasalSys::gcRelease(int key)
1170 naHash_delete(_gcHash, naNum(key));
1173 void FGNasalSys::NasalTimer::timerExpired()
1175 nasal->handleTimer(this);
1179 int FGNasalSys::_listenerId = 0;
1181 // setlistener(<property>, <func> [, <initial=0> [, <persistent=1>]])
1182 // Attaches a callback function to a property (specified as a global
1183 // property path string or a SGPropertyNode_ptr* ghost). If the third,
1184 // optional argument (default=0) is set to 1, then the function is also
1185 // called initially. If the fourth, optional argument is set to 0, then the
1186 // function is only called when the property node value actually changes.
1187 // Otherwise it's called independent of the value whenever the node is
1188 // written to (default). The setlistener() function returns a unique
1189 // id number, which is to be used as argument to the removelistener()
1191 naRef FGNasalSys::setListener(naContext c, int argc, naRef* args)
1193 SGPropertyNode_ptr node;
1194 naRef prop = argc > 0 ? args[0] : naNil();
1195 if(naIsString(prop)) node = fgGetNode(naStr_data(prop), true);
1196 else if(naIsGhost(prop)) node = *(SGPropertyNode_ptr*)naGhost_ptr(prop);
1198 naRuntimeError(c, "setlistener() with invalid property argument");
1203 SG_LOG(SG_NASAL, SG_DEBUG, "Attaching listener to tied property " <<
1206 naRef code = argc > 1 ? args[1] : naNil();
1207 if(!(naIsCode(code) || naIsCCode(code) || naIsFunc(code))) {
1208 naRuntimeError(c, "setlistener() with invalid function argument");
1212 int init = argc > 2 && naIsNum(args[2]) ? int(args[2].num) : 0;
1213 int type = argc > 3 && naIsNum(args[3]) ? int(args[3].num) : 1;
1214 FGNasalListener *nl = new FGNasalListener(node, code, this,
1215 gcSave(code), _listenerId, init, type);
1217 node->addChangeListener(nl, init != 0);
1219 _listener[_listenerId] = nl;
1220 return naNum(_listenerId++);
1223 // removelistener(int) extension function. The argument is the id of
1224 // a listener as returned by the setlistener() function.
1225 naRef FGNasalSys::removeListener(naContext c, int argc, naRef* args)
1227 naRef id = argc > 0 ? args[0] : naNil();
1228 map<int, FGNasalListener *>::iterator it = _listener.find(int(id.num));
1230 if(!naIsNum(id) || it == _listener.end() || it->second->_dead) {
1231 naRuntimeError(c, "removelistener() with invalid listener id");
1235 it->second->_dead = true;
1236 _dead_listener.push_back(it->second);
1237 _listener.erase(it);
1238 return naNum(_listener.size());
1241 void FGNasalSys::registerToLoad(FGNasalModelData *data)
1243 _loadList.push(data);
1246 void FGNasalSys::registerToUnload(FGNasalModelData *data)
1248 _unloadList.push(data);
1251 //////////////////////////////////////////////////////////////////////////
1252 // FGNasalListener class.
1254 FGNasalListener::FGNasalListener(SGPropertyNode *node, naRef code,
1255 FGNasalSys* nasal, int key, int id,
1256 int init, int type) :
1269 if(_type == 0 && !_init)
1273 FGNasalListener::~FGNasalListener()
1275 _node->removeChangeListener(this);
1276 _nas->gcRelease(_gcKey);
1279 void FGNasalListener::call(SGPropertyNode* which, naRef mode)
1281 if(_active || _dead) return;
1282 SG_LOG(SG_NASAL, SG_DEBUG, "trigger listener #" << _id);
1285 arg[0] = _nas->propNodeGhost(which);
1286 arg[1] = _nas->propNodeGhost(_node);
1287 arg[2] = mode; // value changed, child added/removed
1288 arg[3] = naNum(_node != which); // child event?
1289 _nas->call(_code, 4, arg, naNil());
1293 void FGNasalListener::valueChanged(SGPropertyNode* node)
1295 if(_type < 2 && node != _node) return; // skip child events
1296 if(_type > 0 || changed(_node) || _init)
1297 call(node, naNum(0));
1302 void FGNasalListener::childAdded(SGPropertyNode*, SGPropertyNode* child)
1304 if(_type == 2) call(child, naNum(1));
1307 void FGNasalListener::childRemoved(SGPropertyNode*, SGPropertyNode* child)
1309 if(_type == 2) call(child, naNum(-1));
1312 bool FGNasalListener::changed(SGPropertyNode* node)
1314 using namespace simgear;
1315 props::Type type = node->getType();
1316 if(type == props::NONE) return false;
1317 if(type == props::UNSPECIFIED) return true;
1325 long l = node->getLongValue();
1326 result = l != _last_int;
1333 double d = node->getDoubleValue();
1334 result = d != _last_float;
1340 string s = node->getStringValue();
1341 result = s != _last_string;
1348 // NasalXMLVisitor class: handles EasyXML visitor callback for parsexml()
1350 NasalXMLVisitor::NasalXMLVisitor(naContext c, int argc, naRef* args) :
1351 _c(naSubContext(c)),
1352 _start_element(argc > 1 ? args[1] : naNil()),
1353 _end_element(argc > 2 ? args[2] : naNil()),
1354 _data(argc > 3 ? args[3] : naNil()),
1355 _pi(argc > 4 ? args[4] : naNil())
1359 void NasalXMLVisitor::startElement(const char* tag, const XMLAttributes& a)
1361 if(naIsNil(_start_element)) return;
1362 naRef attr = naNewHash(_c);
1363 for(int i=0; i<a.size(); i++) {
1364 naRef name = make_string(a.getName(i));
1365 naRef value = make_string(a.getValue(i));
1366 naHash_set(attr, name, value);
1368 call(_start_element, 2, make_string(tag), attr);
1371 void NasalXMLVisitor::endElement(const char* tag)
1373 if(!naIsNil(_end_element)) call(_end_element, 1, make_string(tag));
1376 void NasalXMLVisitor::data(const char* str, int len)
1378 if(!naIsNil(_data)) call(_data, 1, make_string(str, len));
1381 void NasalXMLVisitor::pi(const char* target, const char* data)
1383 if(!naIsNil(_pi)) call(_pi, 2, make_string(target), make_string(data));
1386 void NasalXMLVisitor::call(naRef func, int num, naRef a, naRef b)
1391 naCall(_c, func, num, args, naNil(), naNil());
1396 naRef NasalXMLVisitor::make_string(const char* s, int n)
1398 return naStr_fromdata(naNewString(_c), const_cast<char *>(s),
1399 n < 0 ? strlen(s) : n);