7 # include <sys/time.h> // gettimeofday
12 #include <sys/types.h>
17 #include <simgear/nasal/nasal.h>
18 #include <simgear/props/props.hxx>
19 #include <simgear/math/sg_random.h>
20 #include <simgear/misc/sg_path.hxx>
21 #include <simgear/misc/interpolator.hxx>
22 #include <simgear/structure/commands.hxx>
24 #include <Main/globals.hxx>
25 #include <Main/fg_props.hxx>
27 #include "NasalSys.hxx"
29 static FGNasalSys* nasalSys = 0;
32 // Read and return file contents in a single buffer. Note use of
33 // stat() to get the file size. This is a win32 function, believe it
34 // or not. :) Note the REALLY IMPORTANT use of the "b" flag to fopen.
35 // Text mode brain damage will kill us if we're trying to do bytewise
37 static char* readfile(const char* file, int* lenOut)
40 if(stat(file, &data) != 0) return 0;
41 FILE* f = fopen(file, "rb");
43 char* buf = new char[data.st_size];
44 *lenOut = fread(buf, 1, data.st_size, f);
46 if(*lenOut != data.st_size) {
47 // Shouldn't happen, but warn anyway since it represents a
48 // platform bug and not a typical runtime error (missing file,
50 SG_LOG(SG_NASAL, SG_ALERT,
51 "ERROR in Nasal initialization: " <<
52 "short count returned from fread() of " << file <<
53 ". Check your C library!");
60 FGNasalSys::FGNasalSys()
66 _nextGCKey = 0; // Any value will do
68 _purgeListeners = false;
71 // Does a naCall() in a new context. Wrapped here to make lock
72 // tracking easier. Extension functions are called with the lock, but
73 // we have to release it before making a new naCall(). So rather than
74 // drop the lock in every extension function that might call back into
75 // Nasal, we keep a stack depth counter here and only unlock/lock
76 // around the naCall if it isn't the first one.
77 naRef FGNasalSys::call(naRef code, naRef locals)
79 naContext ctx = naNewContext();
80 if(_callCount) naModUnlock();
82 naRef result = naCall(ctx, code, 0, 0, naNil(), locals);
86 if(_callCount) naModLock();
91 FGNasalSys::~FGNasalSys()
94 map<int, FGNasalListener *>::iterator it, end = _listener.end();
95 for(it = _listener.begin(); it != end; ++it)
98 naFreeContext(_context);
102 bool FGNasalSys::parseAndRun(const char* sourceCode)
104 naRef code = parse("FGNasalSys::parseAndRun()", sourceCode,
112 FGNasalScript* FGNasalSys::parseScript(const char* src, const char* name)
114 FGNasalScript* script = new FGNasalScript();
115 script->_gcKey = -1; // important, if we delete it on a parse
116 script->_nas = this; // error, don't clobber a real handle!
120 sprintf(buf, "FGNasalScript@%p", (void *)script);
124 script->_code = parse(name, src, strlen(src));
125 if(naIsNil(script->_code)) {
130 script->_gcKey = gcSave(script->_code);
134 // Utility. Sets a named key in a hash by C string, rather than nasal
136 void FGNasalSys::hashset(naRef hash, const char* key, naRef val)
138 naRef s = naNewString(_context);
139 naStr_fromdata(s, (char*)key, strlen(key));
140 naHash_set(hash, s, val);
143 // The get/setprop functions accept a *list* of strings and walk
144 // through the property tree with them to find the appropriate node.
145 // This allows a Nasal object to hold onto a property path and use it
146 // like a node object, e.g. setprop(ObjRoot, "size-parsecs", 2.02). This
147 // is the utility function that walks the property tree.
148 // Future enhancement: support integer arguments to specify array
150 static SGPropertyNode* findnode(naContext c, naRef* vec, int len)
152 SGPropertyNode* p = globals->get_props();
154 for(int i=0; i<len; i++) {
156 if(!naIsString(a)) return 0;
157 p = p->getNode(naStr_data(a));
160 } catch (const string& err) {
161 naRuntimeError(c, (char *)err.c_str());
167 // getprop() extension function. Concatenates its string arguments as
168 // property names and returns the value of the specified property. Or
169 // nil if it doesn't exist.
170 static naRef f_getprop(naContext c, naRef me, int argc, naRef* args)
172 const SGPropertyNode* p = findnode(c, args, argc);
173 if(!p) return naNil();
175 switch(p->getType()) {
176 case SGPropertyNode::BOOL: case SGPropertyNode::INT:
177 case SGPropertyNode::LONG: case SGPropertyNode::FLOAT:
178 case SGPropertyNode::DOUBLE:
179 return naNum(p->getDoubleValue());
181 case SGPropertyNode::STRING:
182 case SGPropertyNode::UNSPECIFIED:
184 naRef nastr = naNewString(c);
185 const char* val = p->getStringValue();
186 naStr_fromdata(nastr, (char*)val, strlen(val));
189 case SGPropertyNode::ALIAS: // <--- FIXME, recurse?
195 // setprop() extension function. Concatenates its string arguments as
196 // property names and sets the value of the specified property to the
198 static naRef f_setprop(naContext c, naRef me, int argc, naRef* args)
201 char buf[BUFLEN + 1];
205 for(int i=0; i<argc-1; i++) {
206 naRef s = naStringValue(c, args[i]);
207 if(naIsNil(s)) return naNil();
208 strncpy(p, naStr_data(s), buflen);
210 buflen = BUFLEN - (p - buf);
211 if(i < (argc-2) && buflen > 0) {
217 SGPropertyNode* props = globals->get_props();
218 naRef val = args[argc-1];
220 if(naIsString(val)) props->setStringValue(buf, naStr_data(val));
222 naRef n = naNumValue(val);
224 naRuntimeError(c, "setprop() value is not string or number");
225 props->setDoubleValue(buf, n.num);
227 } catch (const string& err) {
228 naRuntimeError(c, (char *)err.c_str());
234 // print() extension function. Concatenates and prints its arguments
235 // to the FlightGear log. Uses the highest log level (SG_ALERT), to
236 // make sure it appears. Is there better way to do this?
237 static naRef f_print(naContext c, naRef me, int argc, naRef* args)
241 for(int i=0; i<n; i++) {
242 naRef s = naStringValue(c, args[i]);
243 if(naIsNil(s)) continue;
244 buf += naStr_data(s);
246 SG_LOG(SG_GENERAL, SG_ALERT, buf);
247 return naNum(buf.length());
250 // fgcommand() extension function. Executes a named command via the
251 // FlightGear command manager. Takes a single property node name as
253 static naRef f_fgcommand(naContext c, naRef me, int argc, naRef* args)
255 naRef cmd = argc > 0 ? args[0] : naNil();
256 naRef props = argc > 1 ? args[1] : naNil();
257 if(!naIsString(cmd) || (!naIsNil(props) && !naIsGhost(props)))
258 naRuntimeError(c, "bad arguments to fgcommand()");
259 SGPropertyNode_ptr tmp, *node;
261 node = (SGPropertyNode_ptr*)naGhost_ptr(props);
263 tmp = new SGPropertyNode();
266 return naNum(globals->get_commands()->execute(naStr_data(cmd), *node));
269 // settimer(func, dt, simtime) extension function. Falls through to
270 // FGNasalSys::setTimer(). See there for docs.
271 static naRef f_settimer(naContext c, naRef me, int argc, naRef* args)
273 nasalSys->setTimer(c, argc, args);
277 // setlistener(func, property, bool) extension function. Falls through to
278 // FGNasalSys::setListener(). See there for docs.
279 static naRef f_setlistener(naContext c, naRef me, int argc, naRef* args)
281 return nasalSys->setListener(c, argc, args);
284 // removelistener(int) extension function. Falls through to
285 // FGNasalSys::removeListener(). See there for docs.
286 static naRef f_removelistener(naContext c, naRef me, int argc, naRef* args)
288 return nasalSys->removeListener(c, argc, args);
291 // Returns a ghost handle to the argument to the currently executing
293 static naRef f_cmdarg(naContext c, naRef me, int argc, naRef* args)
295 return nasalSys->cmdArgGhost();
298 // Sets up a property interpolation. The first argument is either a
299 // ghost (SGPropertyNode_ptr*) or a string (global property path) to
300 // interpolate. The second argument is a vector of pairs of
301 // value/delta numbers.
302 static naRef f_interpolate(naContext c, naRef me, int argc, naRef* args)
304 SGPropertyNode* node;
305 naRef prop = argc > 0 ? args[0] : naNil();
306 if(naIsString(prop)) node = fgGetNode(naStr_data(prop), true);
307 else if(naIsGhost(prop)) node = *(SGPropertyNode_ptr*)naGhost_ptr(prop);
310 naRef curve = argc > 1 ? args[1] : naNil();
311 if(!naIsVector(curve)) return naNil();
312 int nPoints = naVec_size(curve) / 2;
313 double* values = new double[nPoints];
314 double* deltas = new double[nPoints];
315 for(int i=0; i<nPoints; i++) {
316 values[i] = naNumValue(naVec_get(curve, 2*i)).num;
317 deltas[i] = naNumValue(naVec_get(curve, 2*i+1)).num;
320 ((SGInterpolator*)globals->get_subsystem_mgr()
321 ->get_group(SGSubsystemMgr::INIT)->get_subsystem("interpolator"))
322 ->interpolate(node, nPoints, values, deltas);
327 // This is a better RNG than the one in the default Nasal distribution
328 // (which is based on the C library rand() implementation). It will
330 static naRef f_rand(naContext c, naRef me, int argc, naRef* args)
332 return naNum(sg_random());
335 static naRef f_srand(naContext c, naRef me, int argc, naRef* args)
341 // Return an array listing of all files in a directory
342 static naRef f_directory(naContext c, naRef me, int argc, naRef* args)
344 if(argc != 1 || !naIsString(args[0]))
345 naRuntimeError(c, "bad arguments to directory()");
346 naRef ldir = args[0];
347 ulDir* dir = ulOpenDir(naStr_data(args[0]));
348 if(!dir) return naNil();
349 naRef result = naNewVector(c);
351 while((dent = ulReadDir(dir)))
352 naVec_append(result, naStr_fromdata(naNewString(c), dent->d_name,
353 strlen(dent->d_name)));
358 // Return UNIX epoch time in seconds.
359 static naRef f_systime(naContext c, naRef me, int argc, naRef* args)
363 GetSystemTimeAsFileTime(&ft);
364 double t = (4294967296.0 * ft.dwHighDateTime + ft.dwLowDateTime);
365 // Converts from 100ns units in 1601 epoch to unix epoch in sec
366 return naNum((t * 1e-7) - 11644473600.0);
370 do { t = time(0); gettimeofday(&td, 0); } while(t != time(0));
371 return naNum(t + 1e-6 * td.tv_usec);
376 // Table of extension functions. Terminate with zeros.
377 static struct { char* name; naCFunction func; } funcs[] = {
378 { "getprop", f_getprop },
379 { "setprop", f_setprop },
380 { "print", f_print },
381 { "_fgcommand", f_fgcommand },
382 { "settimer", f_settimer },
383 { "_setlistener", f_setlistener },
384 { "removelistener", f_removelistener },
385 { "_cmdarg", f_cmdarg },
386 { "_interpolate", f_interpolate },
388 { "srand", f_srand },
389 { "directory", f_directory },
390 { "systime", f_systime },
394 naRef FGNasalSys::cmdArgGhost()
396 return propNodeGhost(_cmdArg);
399 void FGNasalSys::init()
403 _context = naNewContext();
405 // Start with globals. Add it to itself as a recursive
406 // sub-reference under the name "globals". This gives client-code
407 // write access to the namespace if someone wants to do something
409 _globals = naInit_std(_context);
410 naSave(_context, _globals);
411 hashset(_globals, "globals", _globals);
413 hashset(_globals, "math", naInit_math(_context));
414 hashset(_globals, "bits", naInit_bits(_context));
415 hashset(_globals, "io", naInit_io(_context));
416 hashset(_globals, "thread", naInit_thread(_context));
417 hashset(_globals, "utf8", naInit_utf8(_context));
419 // Add our custom extension functions:
420 for(i=0; funcs[i].name; i++)
421 hashset(_globals, funcs[i].name,
422 naNewFunc(_context, naNewCCode(_context, funcs[i].func)));
424 // And our SGPropertyNode wrapper
425 hashset(_globals, "props", genPropsModule());
427 // Make a "__gcsave" hash to hold the naRef objects which get
428 // passed to handles outside the interpreter (to protect them from
429 // begin garbage-collected).
430 _gcHash = naNewHash(_context);
431 hashset(_globals, "__gcsave", _gcHash);
433 // Now load the various source files in the Nasal directory
434 SGPath p(globals->get_fg_root());
437 ulDir* dir = ulOpenDir(p.c_str());
438 while(dir && (dent = ulReadDir(dir)) != 0) {
440 fullpath.append(dent->d_name);
441 SGPath file(dent->d_name);
442 if(file.extension() != "nas") continue;
443 loadModule(fullpath, file.base().c_str());
447 // set signal and remove node to avoid restoring at reinit
448 const char *s = "nasal-dir-initialized";
449 SGPropertyNode *signal = fgGetNode("/sim/signals", true);
450 signal->setBoolValue(s, true);
451 signal->removeChildren(s);
453 // Pull scripts out of the property tree, too
454 loadPropertyScripts();
457 void FGNasalSys::update(double)
459 if(_purgeListeners) {
460 _purgeListeners = false;
461 map<int, FGNasalListener *>::iterator it;
462 for(it = _listener.begin(); it != _listener.end();) {
463 FGNasalListener *nl = it->second;
465 _listener.erase(it++);
474 // Loads the scripts found under /nasal in the global tree
475 void FGNasalSys::loadPropertyScripts()
477 SGPropertyNode* nasal = globals->get_props()->getNode("nasal");
480 for(int i=0; i<nasal->nChildren(); i++) {
481 SGPropertyNode* n = nasal->getChild(i);
483 const char* module = n->getName();
484 if(n->hasChild("module"))
485 module = n->getStringValue("module");
487 // allow multiple files to be specified within in a single
491 bool file_specified = false;
492 while ( (fn = n->getChild("file", j)) != NULL ) {
493 file_specified = true;
494 const char* file = fn->getStringValue();
495 SGPath p(globals->get_fg_root());
497 loadModule(p, module);
501 // Old code which only allowed a single file to be specified per module
503 const char* file = n->getStringValue("file");
504 if(!n->hasChild("file")) file = 0; // Hrm...
506 SGPath p(globals->get_fg_root());
508 loadModule(p, module);
512 const char* src = n->getStringValue("script");
513 if(!n->hasChild("script")) src = 0; // Hrm...
515 createModule(module, n->getPath(), src, strlen(src));
517 if(!file_specified && !src)
518 SG_LOG(SG_NASAL, SG_ALERT, "Nasal error: " <<
519 "no <file> or <script> defined in " <<
520 "/nasal/" << module);
524 // Logs a runtime error, with stack trace, to the FlightGear log stream
525 void FGNasalSys::logError(naContext context)
527 SG_LOG(SG_NASAL, SG_ALERT,
528 "Nasal runtime error: " << naGetError(context));
529 SG_LOG(SG_NASAL, SG_ALERT,
530 " at " << naStr_data(naGetSourceFile(context, 0)) <<
531 ", line " << naGetLine(context, 0));
532 for(int i=1; i<naStackDepth(context); i++)
533 SG_LOG(SG_NASAL, SG_ALERT,
534 " called from: " << naStr_data(naGetSourceFile(context, i)) <<
535 ", line " << naGetLine(context, i));
538 // Reads a script file, executes it, and places the resulting
539 // namespace into the global namespace under the specified module
541 void FGNasalSys::loadModule(SGPath file, const char* module)
544 char* buf = readfile(file.c_str(), &len);
546 SG_LOG(SG_NASAL, SG_ALERT,
547 "Nasal error: could not read script file " << file.c_str()
548 << " into module " << module);
552 createModule(module, file.c_str(), buf, len);
556 // Parse and run. Save the local variables namespace, as it will
557 // become a sub-object of globals. The optional "arg" argument can be
558 // used to pass an associated property node to the module, which can then
559 // be accessed via cmdarg(). (This is, for example, used by XML dialogs.)
560 void FGNasalSys::createModule(const char* moduleName, const char* fileName,
561 const char* src, int len, const SGPropertyNode* arg)
563 naRef code = parse(fileName, src, len);
567 // See if we already have a module hash to use. This allows the
568 // user to, for example, add functions to the built-in math
569 // module. Make a new one if necessary.
571 naRef modname = naNewString(_context);
572 naStr_fromdata(modname, (char*)moduleName, strlen(moduleName));
573 if(!naHash_get(_globals, modname, &locals))
574 locals = naNewHash(_context);
576 _cmdArg = (SGPropertyNode*)arg;
579 hashset(_globals, moduleName, locals);
582 void FGNasalSys::deleteModule(const char* moduleName)
584 naRef modname = naNewString(_context);
585 naStr_fromdata(modname, (char*)moduleName, strlen(moduleName));
586 naHash_delete(_globals, modname);
589 naRef FGNasalSys::parse(const char* filename, const char* buf, int len)
592 naRef srcfile = naNewString(_context);
593 naStr_fromdata(srcfile, (char*)filename, strlen(filename));
594 naRef code = naParseCode(_context, srcfile, 1, (char*)buf, len, &errLine);
596 SG_LOG(SG_NASAL, SG_ALERT,
597 "Nasal parse error: " << naGetError(_context) <<
598 " in "<< filename <<", line " << errLine);
602 // Bind to the global namespace before returning
603 return naBindFunction(_context, code, _globals);
606 bool FGNasalSys::handleCommand(const SGPropertyNode* arg)
608 const char* nasal = arg->getStringValue("script");
609 const char* moduleName = arg->getStringValue("module");
610 naRef code = parse(arg->getPath(true), nasal, strlen(nasal));
611 if(naIsNil(code)) return false;
613 // Commands can be run "in" a module. Make sure that module
614 // exists, and set it up as the local variables hash for the
616 naRef locals = naNil();
618 naRef modname = naNewString(_context);
619 naStr_fromdata(modname, (char*)moduleName, strlen(moduleName));
620 if(!naHash_get(_globals, modname, &locals)) {
621 locals = naNewHash(_context);
622 naHash_set(_globals, modname, locals);
626 // Cache this command's argument for inspection via cmdarg(). For
627 // performance reasons, we won't bother with it if the invoked
628 // code doesn't need it.
629 _cmdArg = (SGPropertyNode*)arg;
635 // settimer(func, dt, simtime) extension function. The first argument
636 // is a Nasal function to call, the second is a delta time (from now),
637 // in seconds. The third, if present, is a boolean value indicating
638 // that "real world" time (rather than simulator time) is to be used.
640 // Implementation note: the FGTimer objects don't live inside the
641 // garbage collector, so the Nasal handler functions have to be
642 // "saved" somehow lest they be inadvertently cleaned. In this case,
643 // they are inserted into a globals.__gcsave hash and removed on
645 void FGNasalSys::setTimer(naContext c, int argc, naRef* args)
647 // Extract the handler, delta, and simtime arguments:
648 naRef handler = argc > 0 ? args[0] : naNil();
649 if(!(naIsCode(handler) || naIsCCode(handler) || naIsFunc(handler))) {
650 naRuntimeError(c, "settimer() with invalid function argument");
654 naRef delta = argc > 1 ? args[1] : naNil();
656 naRuntimeError(c, "settimer() with invalid time argument");
660 bool simtime = (argc > 2 && naTrue(args[2])) ? false : true;
662 // Generate and register a C++ timer handler
663 NasalTimer* t = new NasalTimer;
664 t->handler = handler;
665 t->gcKey = gcSave(handler);
668 globals->get_event_mgr()->addEvent("NasalTimer",
669 t, &NasalTimer::timerExpired,
673 void FGNasalSys::handleTimer(NasalTimer* t)
675 call(t->handler, naNil());
679 int FGNasalSys::gcSave(naRef r)
681 int key = _nextGCKey++;
682 naHash_set(_gcHash, naNum(key), r);
686 void FGNasalSys::gcRelease(int key)
688 naHash_delete(_gcHash, naNum(key));
691 void FGNasalSys::NasalTimer::timerExpired()
693 nasal->handleTimer(this);
697 int FGNasalSys::_listenerId = 0;
699 // setlistener(property, func, bool) extension function. The first argument
700 // is either a ghost (SGPropertyNode_ptr*) or a string (global property
701 // path), the second is a Nasal function, the optional third one a bool.
702 // If the bool is true, then the listener is executed initially. The
703 // setlistener() function returns a unique id number, that can be used
704 // as argument to the removelistener() function.
705 naRef FGNasalSys::setListener(naContext c, int argc, naRef* args)
707 SGPropertyNode_ptr node;
708 naRef prop = argc > 0 ? args[0] : naNil();
709 if(naIsString(prop)) node = fgGetNode(naStr_data(prop), true);
710 else if(naIsGhost(prop)) node = *(SGPropertyNode_ptr*)naGhost_ptr(prop);
712 naRuntimeError(c, "setlistener() with invalid property argument");
717 SG_LOG(SG_NASAL, SG_DEBUG, "Attaching listener to tied property " <<
720 naRef handler = argc > 1 ? args[1] : naNil();
721 if(!(naIsCode(handler) || naIsCCode(handler) || naIsFunc(handler))) {
722 naRuntimeError(c, "setlistener() with invalid function argument");
726 bool initial = argc > 2 && naTrue(args[2]);
728 FGNasalListener *nl = new FGNasalListener(node, handler, this,
729 gcSave(handler), _listenerId);
730 node->addChangeListener(nl, initial);
732 _listener[_listenerId] = nl;
733 return naNum(_listenerId++);
736 // removelistener(int) extension function. The argument is the id of
737 // a listener as returned by the setlistener() function.
738 naRef FGNasalSys::removeListener(naContext c, int argc, naRef* args)
740 naRef id = argc > 0 ? args[0] : naNil();
741 map<int, FGNasalListener *>::iterator it = _listener.find(int(id.num));
743 if(!naIsNum(id) || it == _listener.end() || it->second->_dead) {
744 naRuntimeError(c, "removelistener() with invalid listener id");
748 FGNasalListener *nl = it->second;
751 _purgeListeners = true;
757 return naNum(_listener.size());
762 // FGNasalListener class.
764 FGNasalListener::FGNasalListener(SGPropertyNode_ptr node, naRef handler,
765 FGNasalSys* nasal, int key, int id) :
776 FGNasalListener::~FGNasalListener()
778 _node->removeChangeListener(this);
779 _nas->gcRelease(_gcKey);
782 void FGNasalListener::valueChanged(SGPropertyNode* node)
784 // drop recursive listener calls
788 SG_LOG(SG_NASAL, SG_DEBUG, "trigger listener #" << _id);
790 _nas->_cmdArg = node;
791 _nas->call(_handler, naNil());
798 // FGNasalModelData class. If sgLoad3DModel() is called with a pointer to
799 // such a class, then it lets modelLoaded() run the <load> script, and the
800 // destructor the <unload> script. The latter happens when the model branch
801 // is removed from the scene graph.
803 void FGNasalModelData::modelLoaded(const string& path, SGPropertyNode *prop,
806 SGPropertyNode *n = prop->getNode("nasal"), *load;
810 load = n->getNode("load");
811 _unload = n->getNode("unload");
812 if(!load && !_unload)
816 const char *s = load ? load->getStringValue() : "";
817 nasalSys->createModule(_module.c_str(), _module.c_str(), s, strlen(s), _props);
820 FGNasalModelData::~FGNasalModelData()
826 SG_LOG(SG_NASAL, SG_ALERT, "Trying to run an <unload> script "
827 "without Nasal subsystem present.");
832 const char *s = _unload->getStringValue();
833 nasalSys->createModule(_module.c_str(), _module.c_str(), s, strlen(s), _props);
835 nasalSys->deleteModule(_module.c_str());