7 # include <sys/time.h> // gettimeofday
12 #include <sys/types.h>
18 #include <simgear/nasal/nasal.h>
19 #include <simgear/props/props.hxx>
20 #include <simgear/math/sg_random.h>
21 #include <simgear/misc/sg_path.hxx>
22 #include <simgear/misc/interpolator.hxx>
23 #include <simgear/scene/material/mat.hxx>
24 #include <simgear/structure/commands.hxx>
25 #include <simgear/math/sg_geodesy.hxx>
26 #include <simgear/structure/event_mgr.hxx>
28 #include <Airports/runways.hxx>
29 #include <Airports/simple.hxx>
30 #include <Main/globals.hxx>
31 #include <Main/fg_props.hxx>
32 #include <Main/util.hxx>
33 #include <Scenery/scenery.hxx>
35 #include "NasalSys.hxx"
37 static FGNasalSys* nasalSys = 0;
40 // Read and return file contents in a single buffer. Note use of
41 // stat() to get the file size. This is a win32 function, believe it
42 // or not. :) Note the REALLY IMPORTANT use of the "b" flag to fopen.
43 // Text mode brain damage will kill us if we're trying to do bytewise
45 static char* readfile(const char* file, int* lenOut)
48 if(stat(file, &data) != 0) return 0;
49 FILE* f = fopen(file, "rb");
51 char* buf = new char[data.st_size];
52 *lenOut = fread(buf, 1, data.st_size, f);
54 if(*lenOut != data.st_size) {
55 // Shouldn't happen, but warn anyway since it represents a
56 // platform bug and not a typical runtime error (missing file,
58 SG_LOG(SG_NASAL, SG_ALERT,
59 "ERROR in Nasal initialization: " <<
60 "short count returned from fread() of " << file <<
61 ". Check your C library!");
68 FGNasalSys::FGNasalSys()
74 _nextGCKey = 0; // Any value will do
78 // Does a naCall() in a new context. Wrapped here to make lock
79 // tracking easier. Extension functions are called with the lock, but
80 // we have to release it before making a new naCall(). So rather than
81 // drop the lock in every extension function that might call back into
82 // Nasal, we keep a stack depth counter here and only unlock/lock
83 // around the naCall if it isn't the first one.
84 naRef FGNasalSys::call(naRef code, int argc, naRef* args, naRef locals)
86 naContext ctx = naNewContext();
87 if(_callCount) naModUnlock();
89 naRef result = naCall(ctx, code, argc, args, naNil(), locals);
93 if(_callCount) naModLock();
98 FGNasalSys::~FGNasalSys()
101 map<int, FGNasalListener *>::iterator it, end = _listener.end();
102 for(it = _listener.begin(); it != end; ++it)
105 naFreeContext(_context);
109 bool FGNasalSys::parseAndRun(const char* sourceCode)
111 naRef code = parse("FGNasalSys::parseAndRun()", sourceCode,
115 call(code, 0, 0, naNil());
119 FGNasalScript* FGNasalSys::parseScript(const char* src, const char* name)
121 FGNasalScript* script = new FGNasalScript();
122 script->_gcKey = -1; // important, if we delete it on a parse
123 script->_nas = this; // error, don't clobber a real handle!
127 sprintf(buf, "FGNasalScript@%p", (void *)script);
131 script->_code = parse(name, src, strlen(src));
132 if(naIsNil(script->_code)) {
137 script->_gcKey = gcSave(script->_code);
141 // Utility. Sets a named key in a hash by C string, rather than nasal
143 void FGNasalSys::hashset(naRef hash, const char* key, naRef val)
145 naRef s = naNewString(_context);
146 naStr_fromdata(s, (char*)key, strlen(key));
147 naHash_set(hash, s, val);
150 // The get/setprop functions accept a *list* of strings and walk
151 // through the property tree with them to find the appropriate node.
152 // This allows a Nasal object to hold onto a property path and use it
153 // like a node object, e.g. setprop(ObjRoot, "size-parsecs", 2.02). This
154 // is the utility function that walks the property tree.
155 // Future enhancement: support integer arguments to specify array
157 static SGPropertyNode* findnode(naContext c, naRef* vec, int len)
159 SGPropertyNode* p = globals->get_props();
161 for(int i=0; i<len; i++) {
163 if(!naIsString(a)) return 0;
164 p = p->getNode(naStr_data(a));
167 } catch (const string& err) {
168 naRuntimeError(c, (char *)err.c_str());
174 // getprop() extension function. Concatenates its string arguments as
175 // property names and returns the value of the specified property. Or
176 // nil if it doesn't exist.
177 static naRef f_getprop(naContext c, naRef me, int argc, naRef* args)
179 const SGPropertyNode* p = findnode(c, args, argc);
180 if(!p) return naNil();
182 switch(p->getType()) {
183 case SGPropertyNode::BOOL: case SGPropertyNode::INT:
184 case SGPropertyNode::LONG: case SGPropertyNode::FLOAT:
185 case SGPropertyNode::DOUBLE:
186 return naNum(p->getDoubleValue());
188 case SGPropertyNode::STRING:
189 case SGPropertyNode::UNSPECIFIED:
191 naRef nastr = naNewString(c);
192 const char* val = p->getStringValue();
193 naStr_fromdata(nastr, (char*)val, strlen(val));
196 case SGPropertyNode::ALIAS: // <--- FIXME, recurse?
202 // setprop() extension function. Concatenates its string arguments as
203 // property names and sets the value of the specified property to the
205 static naRef f_setprop(naContext c, naRef me, int argc, naRef* args)
208 char buf[BUFLEN + 1];
212 for(int i=0; i<argc-1; i++) {
213 naRef s = naStringValue(c, args[i]);
214 if(naIsNil(s)) return naNil();
215 strncpy(p, naStr_data(s), buflen);
217 buflen = BUFLEN - (p - buf);
218 if(i < (argc-2) && buflen > 0) {
224 SGPropertyNode* props = globals->get_props();
225 naRef val = args[argc-1];
228 if(naIsString(val)) r = props->setStringValue(buf, naStr_data(val));
230 naRef n = naNumValue(val);
232 naRuntimeError(c, "setprop() value is not string or number");
233 r = props->setDoubleValue(buf, n.num);
235 if(!r) naRuntimeError(c, "setprop(): property is not writable");
236 } catch (const string& err) {
237 naRuntimeError(c, (char *)err.c_str());
243 // print() extension function. Concatenates and prints its arguments
244 // to the FlightGear log. Uses the highest log level (SG_ALERT), to
245 // make sure it appears. Is there better way to do this?
246 static naRef f_print(naContext c, naRef me, int argc, naRef* args)
250 for(int i=0; i<n; i++) {
251 naRef s = naStringValue(c, args[i]);
252 if(naIsNil(s)) continue;
253 buf += naStr_data(s);
255 SG_LOG(SG_GENERAL, SG_ALERT, buf);
256 return naNum(buf.length());
259 // fgcommand() extension function. Executes a named command via the
260 // FlightGear command manager. Takes a single property node name as
262 static naRef f_fgcommand(naContext c, naRef me, int argc, naRef* args)
264 naRef cmd = argc > 0 ? args[0] : naNil();
265 naRef props = argc > 1 ? args[1] : naNil();
266 if(!naIsString(cmd) || (!naIsNil(props) && !naIsGhost(props)))
267 naRuntimeError(c, "bad arguments to fgcommand()");
268 SGPropertyNode_ptr tmp, *node;
270 node = (SGPropertyNode_ptr*)naGhost_ptr(props);
272 tmp = new SGPropertyNode();
275 return naNum(globals->get_commands()->execute(naStr_data(cmd), *node));
278 // settimer(func, dt, simtime) extension function. Falls through to
279 // FGNasalSys::setTimer(). See there for docs.
280 static naRef f_settimer(naContext c, naRef me, int argc, naRef* args)
282 nasalSys->setTimer(c, argc, args);
286 // setlistener(func, property, bool) extension function. Falls through to
287 // FGNasalSys::setListener(). See there for docs.
288 static naRef f_setlistener(naContext c, naRef me, int argc, naRef* args)
290 return nasalSys->setListener(c, argc, args);
293 // removelistener(int) extension function. Falls through to
294 // FGNasalSys::removeListener(). See there for docs.
295 static naRef f_removelistener(naContext c, naRef me, int argc, naRef* args)
297 return nasalSys->removeListener(c, argc, args);
300 // Returns a ghost handle to the argument to the currently executing
302 static naRef f_cmdarg(naContext c, naRef me, int argc, naRef* args)
304 return nasalSys->cmdArgGhost();
307 // Sets up a property interpolation. The first argument is either a
308 // ghost (SGPropertyNode_ptr*) or a string (global property path) to
309 // interpolate. The second argument is a vector of pairs of
310 // value/delta numbers.
311 static naRef f_interpolate(naContext c, naRef me, int argc, naRef* args)
313 SGPropertyNode* node;
314 naRef prop = argc > 0 ? args[0] : naNil();
315 if(naIsString(prop)) node = fgGetNode(naStr_data(prop), true);
316 else if(naIsGhost(prop)) node = *(SGPropertyNode_ptr*)naGhost_ptr(prop);
319 naRef curve = argc > 1 ? args[1] : naNil();
320 if(!naIsVector(curve)) return naNil();
321 int nPoints = naVec_size(curve) / 2;
322 double* values = new double[nPoints];
323 double* deltas = new double[nPoints];
324 for(int i=0; i<nPoints; i++) {
325 values[i] = naNumValue(naVec_get(curve, 2*i)).num;
326 deltas[i] = naNumValue(naVec_get(curve, 2*i+1)).num;
329 ((SGInterpolator*)globals->get_subsystem_mgr()
330 ->get_group(SGSubsystemMgr::INIT)->get_subsystem("interpolator"))
331 ->interpolate(node, nPoints, values, deltas);
338 // This is a better RNG than the one in the default Nasal distribution
339 // (which is based on the C library rand() implementation). It will
341 static naRef f_rand(naContext c, naRef me, int argc, naRef* args)
343 return naNum(sg_random());
346 static naRef f_srand(naContext c, naRef me, int argc, naRef* args)
352 static naRef f_abort(naContext c, naRef me, int argc, naRef* args)
358 // Return an array listing of all files in a directory
359 static naRef f_directory(naContext c, naRef me, int argc, naRef* args)
361 if(argc != 1 || !naIsString(args[0]))
362 naRuntimeError(c, "bad arguments to directory()");
363 naRef ldir = args[0];
364 ulDir* dir = ulOpenDir(naStr_data(args[0]));
365 if(!dir) return naNil();
366 naRef result = naNewVector(c);
368 while((dent = ulReadDir(dir)))
369 naVec_append(result, naStr_fromdata(naNewString(c), dent->d_name,
370 strlen(dent->d_name)));
376 // parsexml(<path> [, <start-tag> [, <end-tag> [, <data> [, <pi>]]]]);
378 // <path> ... absolute path to an XML file
379 // <start-tag> ... callback function with two args: tag name, attribute hash
380 // <end-tag> ... callback function with one arg: tag name
381 // <data> ... callback function with one arg: data
382 // <pi> ... callback function with two args: target, data
383 // (pi = "processing instruction")
384 // All four callback functions are optional and default to nil.
385 // The function returns nil on error, or the validated file name otherwise.
386 static naRef f_parsexml(naContext c, naRef me, int argc, naRef* args)
388 if(argc < 1 || !naIsString(args[0]))
389 naRuntimeError(c, "parsexml(): path argument missing or not a string");
390 if(argc > 5) argc = 5;
391 for(int i=1; i<argc; i++)
392 if(!(naIsNil(args[i]) || naIsFunc(args[i])))
393 naRuntimeError(c, "parsexml(): callback argument not a function");
395 const char* file = fgValidatePath(naStr_data(args[0]), false);
397 naRuntimeError(c, "parsexml(): reading '%s' denied "
398 "(unauthorized access)", naStr_data(args[0]));
401 std::ifstream input(file);
402 NasalXMLVisitor visitor(c, argc, args);
404 readXML(input, visitor);
405 } catch (const sg_exception& e) {
406 naRuntimeError(c, "parsexml(): file '%s' %s",
407 file, e.getFormattedMessage().c_str());
410 return naStr_fromdata(naNewString(c), const_cast<char*>(file), strlen(file));
413 // Return UNIX epoch time in seconds.
414 static naRef f_systime(naContext c, naRef me, int argc, naRef* args)
418 GetSystemTimeAsFileTime(&ft);
419 double t = (4294967296.0 * ft.dwHighDateTime + ft.dwLowDateTime);
420 // Converts from 100ns units in 1601 epoch to unix epoch in sec
421 return naNum((t * 1e-7) - 11644473600.0);
425 do { t = time(0); gettimeofday(&td, 0); } while(t != time(0));
426 return naNum(t + 1e-6 * td.tv_usec);
430 // Convert a cartesian point to a geodetic lat/lon/altitude.
431 static naRef f_carttogeod(naContext c, naRef me, int argc, naRef* args)
433 double lat, lon, alt, xyz[3];
434 if(argc != 3) naRuntimeError(c, "carttogeod() expects 3 arguments");
435 for(int i=0; i<3; i++)
436 xyz[i] = naNumValue(args[i]).num;
437 sgCartToGeod(xyz, &lat, &lon, &alt);
438 lat *= SG_RADIANS_TO_DEGREES;
439 lon *= SG_RADIANS_TO_DEGREES;
440 naRef vec = naNewVector(c);
441 naVec_append(vec, naNum(lat));
442 naVec_append(vec, naNum(lon));
443 naVec_append(vec, naNum(alt));
447 // Convert a geodetic lat/lon/altitude to a cartesian point.
448 static naRef f_geodtocart(naContext c, naRef me, int argc, naRef* args)
450 if(argc != 3) naRuntimeError(c, "geodtocart() expects 3 arguments");
451 double lat = naNumValue(args[0]).num * SG_DEGREES_TO_RADIANS;
452 double lon = naNumValue(args[1]).num * SG_DEGREES_TO_RADIANS;
453 double alt = naNumValue(args[2]).num;
455 sgGeodToCart(lat, lon, alt, xyz);
456 naRef vec = naNewVector(c);
457 naVec_append(vec, naNum(xyz[0]));
458 naVec_append(vec, naNum(xyz[1]));
459 naVec_append(vec, naNum(xyz[2]));
463 // For given geodetic point return array with elevation, and a material data
464 // hash, or nil if there's no information available (tile not loaded). If
465 // information about the material isn't available, then nil is returned instead
467 static naRef f_geodinfo(naContext c, naRef me, int argc, naRef* args)
469 #define HASHSET(s,l,n) naHash_set(matdata, naStr_fromdata(naNewString(c),s,l),n)
470 if(argc != 2) naRuntimeError(c, "geodinfo() expects 2 arguments: lat, lon");
471 double lat = naNumValue(args[0]).num;
472 double lon = naNumValue(args[1]).num;
474 const SGMaterial *mat;
475 if(!globals->get_scenery()->get_elevation_m(lat, lon, 10000.0, elev, &mat))
477 naRef vec = naNewVector(c);
478 naVec_append(vec, naNum(elev));
479 naRef matdata = naNil();
481 matdata = naNewHash(c);
482 naRef names = naNewVector(c);
483 const vector<string> n = mat->get_names();
484 for(unsigned int i=0; i<n.size(); i++)
485 naVec_append(names, naStr_fromdata(naNewString(c),
486 const_cast<char*>(n[i].c_str()), n[i].size()));
487 HASHSET("names", 5, names);
488 HASHSET("solid", 5, naNum(mat->get_solid()));
489 HASHSET("friction_factor", 15, naNum(mat->get_friction_factor()));
490 HASHSET("rolling_friction", 16, naNum(mat->get_rolling_friction()));
491 HASHSET("load_resistance", 15, naNum(mat->get_load_resistance()));
492 HASHSET("bumpiness", 9, naNum(mat->get_bumpiness()));
493 HASHSET("light_coverage", 14, naNum(mat->get_light_coverage()));
495 naVec_append(vec, matdata);
500 class AirportInfoFilter : public FGAirport::AirportFilter
503 AirportInfoFilter() :
504 type(FGPositioned::AIRPORT)
507 virtual FGPositioned::Type minType() const {
511 virtual FGPositioned::Type maxType() const {
515 FGPositioned::Type type;
518 // Returns data hash for particular or nearest airport of a <type>, or nil
521 // airportinfo(<id>); e.g. "KSFO"
522 // airportinfo(<type>); type := ("airport"|"seaport"|"heliport")
523 // airportinfo() same as airportinfo("airport")
524 // airportinfo(<lat>, <lon> [, <type>]);
525 static naRef f_airportinfo(naContext c, naRef me, int argc, naRef* args)
527 static SGConstPropertyNode_ptr latn = fgGetNode("/position/latitude-deg", true);
528 static SGConstPropertyNode_ptr lonn = fgGetNode("/position/longitude-deg", true);
530 FGAirport* apt = NULL;
532 if(argc >= 2 && naIsNum(args[0]) && naIsNum(args[1])) {
533 pos = SGGeod::fromDeg(args[1].num, args[0].num);
537 pos = SGGeod::fromDeg(lonn->getDoubleValue(), latn->getDoubleValue());
540 double maxRange = 10000.0; // expose this? or pick a smaller value?
542 AirportInfoFilter filter; // defaults to airports only
545 // fine, just fall through and use AIRPORT
546 } else if(argc == 1 && naIsString(args[0])) {
547 const char *s = naStr_data(args[0]);
548 if (!strcmp(s, "airport")) filter.type = FGPositioned::AIRPORT;
549 else if(!strcmp(s, "seaport")) filter.type = FGPositioned::SEAPORT;
550 else if(!strcmp(s, "heliport")) filter.type = FGPositioned::HELIPORT;
552 // user provided an <id>, hopefully
553 apt = FGAirport::findByIdent(s);
555 naRuntimeError(c, "airportinfo() couldn't find airport:%s", s);
560 naRuntimeError(c, "airportinfo() with invalid function arguments");
565 apt = FGAirport::findClosest(pos, maxRange, &filter);
566 if(!apt) return naNil();
569 string id = apt->ident();
570 string name = apt->name();
573 naRef rwys = naNewHash(c);
574 for (unsigned int r=0; r<apt->numRunways(); ++r) {
575 FGRunway* rwy(apt->getRunwayByIndex(r));
577 naRef rwyid = naStr_fromdata(naNewString(c),
578 const_cast<char *>(rwy->ident().c_str()),
579 rwy->ident().length());
581 naRef rwydata = naNewHash(c);
582 #define HASHSET(s,l,n) naHash_set(rwydata, naStr_fromdata(naNewString(c),s,l),n)
583 HASHSET("id", 2, rwyid);
584 HASHSET("lat", 3, naNum(rwy->latitude()));
585 HASHSET("lon", 3, naNum(rwy->longitude()));
586 HASHSET("heading", 7, naNum(rwy->headingDeg()));
587 HASHSET("length", 6, naNum(rwy->lengthM()));
588 HASHSET("width", 5, naNum(rwy->widthM()));
589 HASHSET("threshold", 9, naNum(rwy->displacedThresholdM()));
590 HASHSET("stopway", 7, naNum(rwy->stopwayM()));
592 naHash_set(rwys, rwyid, rwydata);
596 naRef aptdata = naNewHash(c);
597 #define HASHSET(s,l,n) naHash_set(aptdata, naStr_fromdata(naNewString(c),s,l),n)
598 HASHSET("id", 2, naStr_fromdata(naNewString(c),
599 const_cast<char *>(id.c_str()), id.length()));
600 HASHSET("name", 4, naStr_fromdata(naNewString(c),
601 const_cast<char *>(name.c_str()), name.length()));
602 HASHSET("lat", 3, naNum(apt->getLatitude()));
603 HASHSET("lon", 3, naNum(apt->getLongitude()));
604 HASHSET("elevation", 9, naNum(apt->getElevation() * SG_FEET_TO_METER));
605 HASHSET("has_metar", 9, naNum(apt->getMetar()));
606 HASHSET("runways", 7, rwys);
612 // Table of extension functions. Terminate with zeros.
613 static struct { const char* name; naCFunction func; } funcs[] = {
614 { "getprop", f_getprop },
615 { "setprop", f_setprop },
616 { "print", f_print },
617 { "_fgcommand", f_fgcommand },
618 { "settimer", f_settimer },
619 { "_setlistener", f_setlistener },
620 { "removelistener", f_removelistener },
621 { "_cmdarg", f_cmdarg },
622 { "_interpolate", f_interpolate },
624 { "srand", f_srand },
625 { "abort", f_abort },
626 { "directory", f_directory },
627 { "parsexml", f_parsexml },
628 { "systime", f_systime },
629 { "carttogeod", f_carttogeod },
630 { "geodtocart", f_geodtocart },
631 { "geodinfo", f_geodinfo },
632 { "airportinfo", f_airportinfo },
636 naRef FGNasalSys::cmdArgGhost()
638 return propNodeGhost(_cmdArg);
641 void FGNasalSys::init()
645 _context = naNewContext();
647 // Start with globals. Add it to itself as a recursive
648 // sub-reference under the name "globals". This gives client-code
649 // write access to the namespace if someone wants to do something
651 _globals = naInit_std(_context);
652 naSave(_context, _globals);
653 hashset(_globals, "globals", _globals);
655 hashset(_globals, "math", naInit_math(_context));
656 hashset(_globals, "bits", naInit_bits(_context));
657 hashset(_globals, "io", naInit_io(_context));
658 hashset(_globals, "thread", naInit_thread(_context));
659 hashset(_globals, "utf8", naInit_utf8(_context));
661 // Add our custom extension functions:
662 for(i=0; funcs[i].name; i++)
663 hashset(_globals, funcs[i].name,
664 naNewFunc(_context, naNewCCode(_context, funcs[i].func)));
666 // And our SGPropertyNode wrapper
667 hashset(_globals, "props", genPropsModule());
669 // Make a "__gcsave" hash to hold the naRef objects which get
670 // passed to handles outside the interpreter (to protect them from
671 // begin garbage-collected).
672 _gcHash = naNewHash(_context);
673 hashset(_globals, "__gcsave", _gcHash);
675 // Now load the various source files in the Nasal directory
676 SGPath p(globals->get_fg_root());
679 ulDir* dir = ulOpenDir(p.c_str());
680 while(dir && (dent = ulReadDir(dir)) != 0) {
682 fullpath.append(dent->d_name);
683 SGPath file(dent->d_name);
684 if(file.extension() != "nas") continue;
685 loadModule(fullpath, file.base().c_str());
689 // set signal and remove node to avoid restoring at reinit
690 const char *s = "nasal-dir-initialized";
691 SGPropertyNode *signal = fgGetNode("/sim/signals", true);
692 signal->setBoolValue(s, true);
693 signal->removeChildren(s);
695 // Pull scripts out of the property tree, too
696 loadPropertyScripts();
699 void FGNasalSys::update(double)
701 if(!_dead_listener.empty()) {
702 vector<FGNasalListener *>::iterator it, end = _dead_listener.end();
703 for(it = _dead_listener.begin(); it != end; ++it) delete *it;
704 _dead_listener.clear();
707 // The global context is a legacy thing. We use dynamically
708 // created contexts for naCall() now, so that we can call them
709 // recursively. But there are still spots that want to use it for
710 // naNew*() calls, which end up leaking memory because the context
711 // only clears out its temporary vector when it's *used*. So just
712 // junk it and fetch a new/reinitialized one every frame. This is
713 // clumsy: the right solution would use the dynamic context in all
714 // cases and eliminate _context entirely. But that's more work,
715 // and this works fine (yes, they say "New" and "Free", but
716 // they're very fast, just trust me). -Andy
717 naFreeContext(_context);
718 _context = naNewContext();
721 // Loads the scripts found under /nasal in the global tree
722 void FGNasalSys::loadPropertyScripts()
724 SGPropertyNode* nasal = globals->get_props()->getNode("nasal");
727 for(int i=0; i<nasal->nChildren(); i++) {
728 SGPropertyNode* n = nasal->getChild(i);
730 const char* module = n->getName();
731 if(n->hasChild("module"))
732 module = n->getStringValue("module");
734 // allow multiple files to be specified within in a single
738 bool file_specified = false;
739 while((fn = n->getChild("file", j)) != NULL) {
740 file_specified = true;
741 const char* file = fn->getStringValue();
742 SGPath p(globals->get_fg_root());
744 loadModule(p, module);
748 // Old code which only allowed a single file to be specified per module
750 const char* file = n->getStringValue("file");
751 if(!n->hasChild("file")) file = 0; // Hrm...
753 SGPath p(globals->get_fg_root());
755 loadModule(p, module);
759 const char* src = n->getStringValue("script");
760 if(!n->hasChild("script")) src = 0; // Hrm...
762 createModule(module, n->getPath(), src, strlen(src));
764 if(!file_specified && !src)
765 SG_LOG(SG_NASAL, SG_ALERT, "Nasal error: " <<
766 "no <file> or <script> defined in " <<
767 "/nasal/" << module);
771 // Logs a runtime error, with stack trace, to the FlightGear log stream
772 void FGNasalSys::logError(naContext context)
774 SG_LOG(SG_NASAL, SG_ALERT,
775 "Nasal runtime error: " << naGetError(context));
776 SG_LOG(SG_NASAL, SG_ALERT,
777 " at " << naStr_data(naGetSourceFile(context, 0)) <<
778 ", line " << naGetLine(context, 0));
779 for(int i=1; i<naStackDepth(context); i++)
780 SG_LOG(SG_NASAL, SG_ALERT,
781 " called from: " << naStr_data(naGetSourceFile(context, i)) <<
782 ", line " << naGetLine(context, i));
785 // Reads a script file, executes it, and places the resulting
786 // namespace into the global namespace under the specified module
788 void FGNasalSys::loadModule(SGPath file, const char* module)
791 char* buf = readfile(file.c_str(), &len);
793 SG_LOG(SG_NASAL, SG_ALERT,
794 "Nasal error: could not read script file " << file.c_str()
795 << " into module " << module);
799 createModule(module, file.c_str(), buf, len);
803 // Parse and run. Save the local variables namespace, as it will
804 // become a sub-object of globals. The optional "arg" argument can be
805 // used to pass an associated property node to the module, which can then
806 // be accessed via cmdarg(). (This is, for example, used by XML dialogs.)
807 void FGNasalSys::createModule(const char* moduleName, const char* fileName,
808 const char* src, int len,
809 const SGPropertyNode* cmdarg,
810 int argc, naRef* args)
812 naRef code = parse(fileName, src, len);
816 // See if we already have a module hash to use. This allows the
817 // user to, for example, add functions to the built-in math
818 // module. Make a new one if necessary.
820 naRef modname = naNewString(_context);
821 naStr_fromdata(modname, (char*)moduleName, strlen(moduleName));
822 if(!naHash_get(_globals, modname, &locals))
823 locals = naNewHash(_context);
825 _cmdArg = (SGPropertyNode*)cmdarg;
827 call(code, argc, args, locals);
828 hashset(_globals, moduleName, locals);
831 void FGNasalSys::deleteModule(const char* moduleName)
833 naRef modname = naNewString(_context);
834 naStr_fromdata(modname, (char*)moduleName, strlen(moduleName));
835 naHash_delete(_globals, modname);
838 naRef FGNasalSys::parse(const char* filename, const char* buf, int len)
841 naRef srcfile = naNewString(_context);
842 naStr_fromdata(srcfile, (char*)filename, strlen(filename));
843 naRef code = naParseCode(_context, srcfile, 1, (char*)buf, len, &errLine);
845 SG_LOG(SG_NASAL, SG_ALERT,
846 "Nasal parse error: " << naGetError(_context) <<
847 " in "<< filename <<", line " << errLine);
851 // Bind to the global namespace before returning
852 return naBindFunction(_context, code, _globals);
855 bool FGNasalSys::handleCommand(const SGPropertyNode* arg)
857 const char* nasal = arg->getStringValue("script");
858 const char* moduleName = arg->getStringValue("module");
859 naRef code = parse(arg->getPath(true), nasal, strlen(nasal));
860 if(naIsNil(code)) return false;
862 // Commands can be run "in" a module. Make sure that module
863 // exists, and set it up as the local variables hash for the
865 naRef locals = naNil();
867 naRef modname = naNewString(_context);
868 naStr_fromdata(modname, (char*)moduleName, strlen(moduleName));
869 if(!naHash_get(_globals, modname, &locals)) {
870 locals = naNewHash(_context);
871 naHash_set(_globals, modname, locals);
875 // Cache this command's argument for inspection via cmdarg(). For
876 // performance reasons, we won't bother with it if the invoked
877 // code doesn't need it.
878 _cmdArg = (SGPropertyNode*)arg;
880 call(code, 0, 0, locals);
884 // settimer(func, dt, simtime) extension function. The first argument
885 // is a Nasal function to call, the second is a delta time (from now),
886 // in seconds. The third, if present, is a boolean value indicating
887 // that "real world" time (rather than simulator time) is to be used.
889 // Implementation note: the FGTimer objects don't live inside the
890 // garbage collector, so the Nasal handler functions have to be
891 // "saved" somehow lest they be inadvertently cleaned. In this case,
892 // they are inserted into a globals.__gcsave hash and removed on
894 void FGNasalSys::setTimer(naContext c, int argc, naRef* args)
896 // Extract the handler, delta, and simtime arguments:
897 naRef handler = argc > 0 ? args[0] : naNil();
898 if(!(naIsCode(handler) || naIsCCode(handler) || naIsFunc(handler))) {
899 naRuntimeError(c, "settimer() with invalid function argument");
903 naRef delta = argc > 1 ? args[1] : naNil();
905 naRuntimeError(c, "settimer() with invalid time argument");
909 bool simtime = (argc > 2 && naTrue(args[2])) ? false : true;
911 // Generate and register a C++ timer handler
912 NasalTimer* t = new NasalTimer;
913 t->handler = handler;
914 t->gcKey = gcSave(handler);
917 globals->get_event_mgr()->addEvent("NasalTimer",
918 t, &NasalTimer::timerExpired,
922 void FGNasalSys::handleTimer(NasalTimer* t)
924 call(t->handler, 0, 0, naNil());
928 int FGNasalSys::gcSave(naRef r)
930 int key = _nextGCKey++;
931 naHash_set(_gcHash, naNum(key), r);
935 void FGNasalSys::gcRelease(int key)
937 naHash_delete(_gcHash, naNum(key));
940 void FGNasalSys::NasalTimer::timerExpired()
942 nasal->handleTimer(this);
946 int FGNasalSys::_listenerId = 0;
948 // setlistener(<property>, <func> [, <initial=0> [, <persistent=1>]])
949 // Attaches a callback function to a property (specified as a global
950 // property path string or a SGPropertyNode_ptr* ghost). If the third,
951 // optional argument (default=0) is set to 1, then the function is also
952 // called initially. If the fourth, optional argument is set to 0, then the
953 // function is only called when the property node value actually changes.
954 // Otherwise it's called independent of the value whenever the node is
955 // written to (default). The setlistener() function returns a unique
956 // id number, which is to be used as argument to the removelistener()
958 naRef FGNasalSys::setListener(naContext c, int argc, naRef* args)
960 SGPropertyNode_ptr node;
961 naRef prop = argc > 0 ? args[0] : naNil();
962 if(naIsString(prop)) node = fgGetNode(naStr_data(prop), true);
963 else if(naIsGhost(prop)) node = *(SGPropertyNode_ptr*)naGhost_ptr(prop);
965 naRuntimeError(c, "setlistener() with invalid property argument");
970 SG_LOG(SG_NASAL, SG_DEBUG, "Attaching listener to tied property " <<
973 naRef code = argc > 1 ? args[1] : naNil();
974 if(!(naIsCode(code) || naIsCCode(code) || naIsFunc(code))) {
975 naRuntimeError(c, "setlistener() with invalid function argument");
979 int type = argc > 3 && naIsNum(args[3]) ? (int)args[3].num : 1;
980 FGNasalListener *nl = new FGNasalListener(node, code, this,
981 gcSave(code), _listenerId, type);
983 bool initial = argc > 2 && naTrue(args[2]);
984 node->addChangeListener(nl, initial);
986 _listener[_listenerId] = nl;
987 return naNum(_listenerId++);
990 // removelistener(int) extension function. The argument is the id of
991 // a listener as returned by the setlistener() function.
992 naRef FGNasalSys::removeListener(naContext c, int argc, naRef* args)
994 naRef id = argc > 0 ? args[0] : naNil();
995 map<int, FGNasalListener *>::iterator it = _listener.find(int(id.num));
997 if(!naIsNum(id) || it == _listener.end() || it->second->_dead) {
998 naRuntimeError(c, "removelistener() with invalid listener id");
1002 it->second->_dead = true;
1003 _dead_listener.push_back(it->second);
1004 _listener.erase(it);
1005 return naNum(_listener.size());
1010 // FGNasalListener class.
1012 FGNasalListener::FGNasalListener(SGPropertyNode *node, naRef code,
1013 FGNasalSys* nasal, int key, int id, int type) :
1028 FGNasalListener::~FGNasalListener()
1030 _node->removeChangeListener(this);
1031 _nas->gcRelease(_gcKey);
1034 void FGNasalListener::call(SGPropertyNode* which, naRef mode)
1036 if(_active || _dead) return;
1037 SG_LOG(SG_NASAL, SG_DEBUG, "trigger listener #" << _id);
1040 arg[0] = _nas->propNodeGhost(which);
1041 arg[1] = _nas->propNodeGhost(_node);
1042 arg[2] = mode; // value changed, child added/removed
1043 arg[3] = naNum(_node != which); // child event?
1044 _nas->call(_code, 4, arg, naNil());
1048 void FGNasalListener::valueChanged(SGPropertyNode* node)
1050 if(_type < 2 && node != _node) return; // skip child events
1051 if(_type > 0 || changed(_node) || _first_call)
1052 call(node, naNum(0));
1054 _first_call = false;
1057 void FGNasalListener::childAdded(SGPropertyNode*, SGPropertyNode* child)
1059 if(_type == 2) call(child, naNum(1));
1062 void FGNasalListener::childRemoved(SGPropertyNode*, SGPropertyNode* child)
1064 if(_type == 2) call(child, naNum(-1));
1067 bool FGNasalListener::changed(SGPropertyNode* node)
1069 SGPropertyNode::Type type = node->getType();
1070 if(type == SGPropertyNode::NONE) return false;
1071 if(type == SGPropertyNode::UNSPECIFIED) return true;
1075 case SGPropertyNode::BOOL:
1076 case SGPropertyNode::INT:
1077 case SGPropertyNode::LONG:
1079 long l = node->getLongValue();
1080 result = l != _last_int;
1084 case SGPropertyNode::FLOAT:
1085 case SGPropertyNode::DOUBLE:
1087 double d = node->getDoubleValue();
1088 result = d != _last_float;
1094 string s = node->getStringValue();
1095 result = s != _last_string;
1104 // FGNasalModelData class. If sgLoad3DModel() is called with a pointer to
1105 // such a class, then it lets modelLoaded() run the <load> script, and the
1106 // destructor the <unload> script. The latter happens when the model branch
1107 // is removed from the scene graph.
1109 void FGNasalModelData::modelLoaded(const string& path, SGPropertyNode *prop,
1114 SGPropertyNode *nasal = prop->getNode("nasal");
1118 SGPropertyNode *load = nasal->getNode("load");
1119 _unload = nasal->getNode("unload");
1120 if(!load && !_unload)
1125 _module += ':' + _props->getPath();
1126 const char *s = load ? load->getStringValue() : "";
1129 arg[0] = nasalSys->propNodeGhost(_root);
1130 arg[1] = nasalSys->propNodeGhost(prop);
1131 nasalSys->createModule(_module.c_str(), _module.c_str(), s, strlen(s),
1136 FGNasalModelData::~FGNasalModelData()
1142 SG_LOG(SG_NASAL, SG_WARN, "Trying to run an <unload> script "
1143 "without Nasal subsystem present.");
1148 const char *s = _unload->getStringValue();
1149 nasalSys->createModule(_module.c_str(), _module.c_str(), s, strlen(s), _root);
1151 nasalSys->deleteModule(_module.c_str());
1156 // NasalXMLVisitor class: handles EasyXML visitor callback for parsexml()
1158 NasalXMLVisitor::NasalXMLVisitor(naContext c, int argc, naRef* args) :
1159 _c(naSubContext(c)),
1160 _start_element(argc > 1 ? args[1] : naNil()),
1161 _end_element(argc > 2 ? args[2] : naNil()),
1162 _data(argc > 3 ? args[3] : naNil()),
1163 _pi(argc > 4 ? args[4] : naNil())
1167 void NasalXMLVisitor::startElement(const char* tag, const XMLAttributes& a)
1169 if(naIsNil(_start_element)) return;
1170 naRef attr = naNewHash(_c);
1171 for(int i=0; i<a.size(); i++) {
1172 naRef name = make_string(a.getName(i));
1173 naRef value = make_string(a.getValue(i));
1174 naHash_set(attr, name, value);
1176 call(_start_element, 2, make_string(tag), attr);
1179 void NasalXMLVisitor::endElement(const char* tag)
1181 if(!naIsNil(_end_element)) call(_end_element, 1, make_string(tag));
1184 void NasalXMLVisitor::data(const char* str, int len)
1186 if(!naIsNil(_data)) call(_data, 1, make_string(str, len));
1189 void NasalXMLVisitor::pi(const char* target, const char* data)
1191 if(!naIsNil(_pi)) call(_pi, 2, make_string(target), make_string(data));
1194 void NasalXMLVisitor::call(naRef func, int num, naRef a, naRef b)
1199 naCall(_c, func, num, args, naNil(), naNil());
1204 naRef NasalXMLVisitor::make_string(const char* s, int n)
1206 return naStr_fromdata(naNewString(_c), const_cast<char *>(s),
1207 n < 0 ? strlen(s) : n);