7 # include <sys/time.h> // gettimeofday
12 #include <sys/types.h>
19 #include <simgear/nasal/nasal.h>
20 #include <simgear/props/props.hxx>
21 #include <simgear/math/sg_random.h>
22 #include <simgear/misc/sg_path.hxx>
23 #include <simgear/misc/interpolator.hxx>
24 #include <simgear/scene/material/mat.hxx>
25 #include <simgear/structure/commands.hxx>
26 #include <simgear/math/sg_geodesy.hxx>
27 #include <simgear/structure/event_mgr.hxx>
29 #include <Airports/runways.hxx>
30 #include <Airports/simple.hxx>
31 #include <Main/globals.hxx>
32 #include <Main/fg_props.hxx>
33 #include <Main/util.hxx>
34 #include <Scenery/scenery.hxx>
36 #include "NasalSys.hxx"
38 static FGNasalSys* nasalSys = 0;
41 // Read and return file contents in a single buffer. Note use of
42 // stat() to get the file size. This is a win32 function, believe it
43 // or not. :) Note the REALLY IMPORTANT use of the "b" flag to fopen.
44 // Text mode brain damage will kill us if we're trying to do bytewise
46 static char* readfile(const char* file, int* lenOut)
49 if(stat(file, &data) != 0) return 0;
50 FILE* f = fopen(file, "rb");
52 char* buf = new char[data.st_size];
53 *lenOut = fread(buf, 1, data.st_size, f);
55 if(*lenOut != data.st_size) {
56 // Shouldn't happen, but warn anyway since it represents a
57 // platform bug and not a typical runtime error (missing file,
59 SG_LOG(SG_NASAL, SG_ALERT,
60 "ERROR in Nasal initialization: " <<
61 "short count returned from fread() of " << file <<
62 ". Check your C library!");
69 FGNasalSys::FGNasalSys()
75 _nextGCKey = 0; // Any value will do
79 // Does a naCall() in a new context. Wrapped here to make lock
80 // tracking easier. Extension functions are called with the lock, but
81 // we have to release it before making a new naCall(). So rather than
82 // drop the lock in every extension function that might call back into
83 // Nasal, we keep a stack depth counter here and only unlock/lock
84 // around the naCall if it isn't the first one.
85 naRef FGNasalSys::call(naRef code, int argc, naRef* args, naRef locals)
87 naContext ctx = naNewContext();
88 if(_callCount) naModUnlock();
90 naRef result = naCall(ctx, code, argc, args, naNil(), locals);
94 if(_callCount) naModLock();
99 FGNasalSys::~FGNasalSys()
102 map<int, FGNasalListener *>::iterator it, end = _listener.end();
103 for(it = _listener.begin(); it != end; ++it)
106 naFreeContext(_context);
110 bool FGNasalSys::parseAndRun(const char* sourceCode)
112 naRef code = parse("FGNasalSys::parseAndRun()", sourceCode,
116 call(code, 0, 0, naNil());
120 FGNasalScript* FGNasalSys::parseScript(const char* src, const char* name)
122 FGNasalScript* script = new FGNasalScript();
123 script->_gcKey = -1; // important, if we delete it on a parse
124 script->_nas = this; // error, don't clobber a real handle!
128 sprintf(buf, "FGNasalScript@%p", (void *)script);
132 script->_code = parse(name, src, strlen(src));
133 if(naIsNil(script->_code)) {
138 script->_gcKey = gcSave(script->_code);
142 // Utility. Sets a named key in a hash by C string, rather than nasal
144 void FGNasalSys::hashset(naRef hash, const char* key, naRef val)
146 naRef s = naNewString(_context);
147 naStr_fromdata(s, (char*)key, strlen(key));
148 naHash_set(hash, s, val);
151 // The get/setprop functions accept a *list* of strings and walk
152 // through the property tree with them to find the appropriate node.
153 // This allows a Nasal object to hold onto a property path and use it
154 // like a node object, e.g. setprop(ObjRoot, "size-parsecs", 2.02). This
155 // is the utility function that walks the property tree.
156 // Future enhancement: support integer arguments to specify array
158 static SGPropertyNode* findnode(naContext c, naRef* vec, int len)
160 SGPropertyNode* p = globals->get_props();
162 for(int i=0; i<len; i++) {
164 if(!naIsString(a)) return 0;
165 p = p->getNode(naStr_data(a));
168 } catch (const string& err) {
169 naRuntimeError(c, (char *)err.c_str());
175 // getprop() extension function. Concatenates its string arguments as
176 // property names and returns the value of the specified property. Or
177 // nil if it doesn't exist.
178 static naRef f_getprop(naContext c, naRef me, int argc, naRef* args)
180 using namespace simgear::props;
181 const SGPropertyNode* p = findnode(c, args, argc);
182 if(!p) return naNil();
184 switch(p->getType()) {
186 case LONG: case FLOAT:
188 return naNum(p->getDoubleValue());
193 naRef nastr = naNewString(c);
194 const char* val = p->getStringValue();
195 naStr_fromdata(nastr, (char*)val, strlen(val));
198 case ALIAS: // <--- FIXME, recurse?
204 // setprop() extension function. Concatenates its string arguments as
205 // property names and sets the value of the specified property to the
207 static naRef f_setprop(naContext c, naRef me, int argc, naRef* args)
210 char buf[BUFLEN + 1];
214 for(int i=0; i<argc-1; i++) {
215 naRef s = naStringValue(c, args[i]);
216 if(naIsNil(s)) return naNil();
217 strncpy(p, naStr_data(s), buflen);
219 buflen = BUFLEN - (p - buf);
220 if(i < (argc-2) && buflen > 0) {
226 SGPropertyNode* props = globals->get_props();
227 naRef val = args[argc-1];
230 if(naIsString(val)) result = props->setStringValue(buf, naStr_data(val));
232 naRef n = naNumValue(val);
234 naRuntimeError(c, "setprop() value is not string or number");
235 result = props->setDoubleValue(buf, n.num);
237 } catch (const string& err) {
238 naRuntimeError(c, (char *)err.c_str());
240 return naNum(result);
244 // print() extension function. Concatenates and prints its arguments
245 // to the FlightGear log. Uses the highest log level (SG_ALERT), to
246 // make sure it appears. Is there better way to do this?
247 static naRef f_print(naContext c, naRef me, int argc, naRef* args)
251 for(int i=0; i<n; i++) {
252 naRef s = naStringValue(c, args[i]);
253 if(naIsNil(s)) continue;
254 buf += naStr_data(s);
256 SG_LOG(SG_GENERAL, SG_ALERT, buf);
257 return naNum(buf.length());
260 // fgcommand() extension function. Executes a named command via the
261 // FlightGear command manager. Takes a single property node name as
263 static naRef f_fgcommand(naContext c, naRef me, int argc, naRef* args)
265 naRef cmd = argc > 0 ? args[0] : naNil();
266 naRef props = argc > 1 ? args[1] : naNil();
267 if(!naIsString(cmd) || (!naIsNil(props) && !naIsGhost(props)))
268 naRuntimeError(c, "bad arguments to fgcommand()");
269 SGPropertyNode_ptr tmp, *node;
271 node = (SGPropertyNode_ptr*)naGhost_ptr(props);
273 tmp = new SGPropertyNode();
276 return naNum(globals->get_commands()->execute(naStr_data(cmd), *node));
279 // settimer(func, dt, simtime) extension function. Falls through to
280 // FGNasalSys::setTimer(). See there for docs.
281 static naRef f_settimer(naContext c, naRef me, int argc, naRef* args)
283 nasalSys->setTimer(c, argc, args);
287 // setlistener(func, property, bool) extension function. Falls through to
288 // FGNasalSys::setListener(). See there for docs.
289 static naRef f_setlistener(naContext c, naRef me, int argc, naRef* args)
291 return nasalSys->setListener(c, argc, args);
294 // removelistener(int) extension function. Falls through to
295 // FGNasalSys::removeListener(). See there for docs.
296 static naRef f_removelistener(naContext c, naRef me, int argc, naRef* args)
298 return nasalSys->removeListener(c, argc, args);
301 // Returns a ghost handle to the argument to the currently executing
303 static naRef f_cmdarg(naContext c, naRef me, int argc, naRef* args)
305 return nasalSys->cmdArgGhost();
308 // Sets up a property interpolation. The first argument is either a
309 // ghost (SGPropertyNode_ptr*) or a string (global property path) to
310 // interpolate. The second argument is a vector of pairs of
311 // value/delta numbers.
312 static naRef f_interpolate(naContext c, naRef me, int argc, naRef* args)
314 SGPropertyNode* node;
315 naRef prop = argc > 0 ? args[0] : naNil();
316 if(naIsString(prop)) node = fgGetNode(naStr_data(prop), true);
317 else if(naIsGhost(prop)) node = *(SGPropertyNode_ptr*)naGhost_ptr(prop);
320 naRef curve = argc > 1 ? args[1] : naNil();
321 if(!naIsVector(curve)) return naNil();
322 int nPoints = naVec_size(curve) / 2;
323 double* values = new double[nPoints];
324 double* deltas = new double[nPoints];
325 for(int i=0; i<nPoints; i++) {
326 values[i] = naNumValue(naVec_get(curve, 2*i)).num;
327 deltas[i] = naNumValue(naVec_get(curve, 2*i+1)).num;
330 ((SGInterpolator*)globals->get_subsystem_mgr()
331 ->get_group(SGSubsystemMgr::INIT)->get_subsystem("interpolator"))
332 ->interpolate(node, nPoints, values, deltas);
339 // This is a better RNG than the one in the default Nasal distribution
340 // (which is based on the C library rand() implementation). It will
342 static naRef f_rand(naContext c, naRef me, int argc, naRef* args)
344 return naNum(sg_random());
347 static naRef f_srand(naContext c, naRef me, int argc, naRef* args)
353 static naRef f_abort(naContext c, naRef me, int argc, naRef* args)
359 // Return an array listing of all files in a directory
360 static naRef f_directory(naContext c, naRef me, int argc, naRef* args)
362 if(argc != 1 || !naIsString(args[0]))
363 naRuntimeError(c, "bad arguments to directory()");
364 naRef ldir = args[0];
365 ulDir* dir = ulOpenDir(naStr_data(args[0]));
366 if(!dir) return naNil();
367 naRef result = naNewVector(c);
369 while((dent = ulReadDir(dir)))
370 naVec_append(result, naStr_fromdata(naNewString(c), dent->d_name,
371 strlen(dent->d_name)));
377 // parsexml(<path> [, <start-tag> [, <end-tag> [, <data> [, <pi>]]]]);
379 // <path> ... absolute path to an XML file
380 // <start-tag> ... callback function with two args: tag name, attribute hash
381 // <end-tag> ... callback function with one arg: tag name
382 // <data> ... callback function with one arg: data
383 // <pi> ... callback function with two args: target, data
384 // (pi = "processing instruction")
385 // All four callback functions are optional and default to nil.
386 // The function returns nil on error, or the validated file name otherwise.
387 static naRef f_parsexml(naContext c, naRef me, int argc, naRef* args)
389 if(argc < 1 || !naIsString(args[0]))
390 naRuntimeError(c, "parsexml(): path argument missing or not a string");
391 if(argc > 5) argc = 5;
392 for(int i=1; i<argc; i++)
393 if(!(naIsNil(args[i]) || naIsFunc(args[i])))
394 naRuntimeError(c, "parsexml(): callback argument not a function");
396 const char* file = fgValidatePath(naStr_data(args[0]), false);
398 naRuntimeError(c, "parsexml(): reading '%s' denied "
399 "(unauthorized access)", naStr_data(args[0]));
402 std::ifstream input(file);
403 NasalXMLVisitor visitor(c, argc, args);
405 readXML(input, visitor);
406 } catch (const sg_exception& e) {
407 naRuntimeError(c, "parsexml(): file '%s' %s",
408 file, e.getFormattedMessage().c_str());
411 return naStr_fromdata(naNewString(c), const_cast<char*>(file), strlen(file));
414 // Return UNIX epoch time in seconds.
415 static naRef f_systime(naContext c, naRef me, int argc, naRef* args)
419 GetSystemTimeAsFileTime(&ft);
420 double t = (4294967296.0 * ft.dwHighDateTime + ft.dwLowDateTime);
421 // Converts from 100ns units in 1601 epoch to unix epoch in sec
422 return naNum((t * 1e-7) - 11644473600.0);
426 do { t = time(0); gettimeofday(&td, 0); } while(t != time(0));
427 return naNum(t + 1e-6 * td.tv_usec);
431 // Convert a cartesian point to a geodetic lat/lon/altitude.
432 static naRef f_carttogeod(naContext c, naRef me, int argc, naRef* args)
434 double lat, lon, alt, xyz[3];
435 if(argc != 3) naRuntimeError(c, "carttogeod() expects 3 arguments");
436 for(int i=0; i<3; i++)
437 xyz[i] = naNumValue(args[i]).num;
438 sgCartToGeod(xyz, &lat, &lon, &alt);
439 lat *= SG_RADIANS_TO_DEGREES;
440 lon *= SG_RADIANS_TO_DEGREES;
441 naRef vec = naNewVector(c);
442 naVec_append(vec, naNum(lat));
443 naVec_append(vec, naNum(lon));
444 naVec_append(vec, naNum(alt));
448 // Convert a geodetic lat/lon/altitude to a cartesian point.
449 static naRef f_geodtocart(naContext c, naRef me, int argc, naRef* args)
451 if(argc != 3) naRuntimeError(c, "geodtocart() expects 3 arguments");
452 double lat = naNumValue(args[0]).num * SG_DEGREES_TO_RADIANS;
453 double lon = naNumValue(args[1]).num * SG_DEGREES_TO_RADIANS;
454 double alt = naNumValue(args[2]).num;
456 sgGeodToCart(lat, lon, alt, xyz);
457 naRef vec = naNewVector(c);
458 naVec_append(vec, naNum(xyz[0]));
459 naVec_append(vec, naNum(xyz[1]));
460 naVec_append(vec, naNum(xyz[2]));
464 // For given geodetic point return array with elevation, and a material data
465 // hash, or nil if there's no information available (tile not loaded). If
466 // information about the material isn't available, then nil is returned instead
468 static naRef f_geodinfo(naContext c, naRef me, int argc, naRef* args)
470 #define HASHSET(s,l,n) naHash_set(matdata, naStr_fromdata(naNewString(c),s,l),n)
471 if(argc < 2 || argc > 3)
472 naRuntimeError(c, "geodinfo() expects 2 or 3 arguments: lat, lon [, maxalt]");
473 double lat = naNumValue(args[0]).num;
474 double lon = naNumValue(args[1]).num;
475 double elev = argc == 3 ? naNumValue(args[2]).num : 10000;
476 const SGMaterial *mat;
477 SGGeod geod = SGGeod::fromDegM(lon, lat, elev);
478 if(!globals->get_scenery()->get_elevation_m(geod, elev, &mat))
480 naRef vec = naNewVector(c);
481 naVec_append(vec, naNum(elev));
482 naRef matdata = naNil();
484 matdata = naNewHash(c);
485 naRef names = naNewVector(c);
486 const vector<string> n = mat->get_names();
487 for(unsigned int i=0; i<n.size(); i++)
488 naVec_append(names, naStr_fromdata(naNewString(c),
489 const_cast<char*>(n[i].c_str()), n[i].size()));
490 HASHSET("names", 5, names);
491 HASHSET("solid", 5, naNum(mat->get_solid()));
492 HASHSET("friction_factor", 15, naNum(mat->get_friction_factor()));
493 HASHSET("rolling_friction", 16, naNum(mat->get_rolling_friction()));
494 HASHSET("load_resistance", 15, naNum(mat->get_load_resistance()));
495 HASHSET("bumpiness", 9, naNum(mat->get_bumpiness()));
496 HASHSET("light_coverage", 14, naNum(mat->get_light_coverage()));
498 naVec_append(vec, matdata);
504 class AirportInfoFilter : public FGAirport::AirportFilter
507 AirportInfoFilter() : type(FGPositioned::AIRPORT) {
510 virtual FGPositioned::Type minType() const {
514 virtual FGPositioned::Type maxType() const {
518 FGPositioned::Type type;
521 // Returns data hash for particular or nearest airport of a <type>, or nil
524 // airportinfo(<id>); e.g. "KSFO"
525 // airportinfo(<type>); type := ("airport"|"seaport"|"heliport")
526 // airportinfo() same as airportinfo("airport")
527 // airportinfo(<lat>, <lon> [, <type>]);
528 static naRef f_airportinfo(naContext c, naRef me, int argc, naRef* args)
530 static SGConstPropertyNode_ptr latn = fgGetNode("/position/latitude-deg", true);
531 static SGConstPropertyNode_ptr lonn = fgGetNode("/position/longitude-deg", true);
533 FGAirport* apt = NULL;
535 if(argc >= 2 && naIsNum(args[0]) && naIsNum(args[1])) {
536 pos = SGGeod::fromDeg(args[1].num, args[0].num);
540 pos = SGGeod::fromDeg(lonn->getDoubleValue(), latn->getDoubleValue());
543 double maxRange = 10000.0; // expose this? or pick a smaller value?
545 AirportInfoFilter filter; // defaults to airports only
548 // fall through and use AIRPORT
549 } else if(argc == 1 && naIsString(args[0])) {
550 const char *s = naStr_data(args[0]);
551 if(!strcmp(s, "airport")) filter.type = FGPositioned::AIRPORT;
552 else if(!strcmp(s, "seaport")) filter.type = FGPositioned::SEAPORT;
553 else if(!strcmp(s, "heliport")) filter.type = FGPositioned::HELIPORT;
555 // user provided an <id>, hopefully
556 apt = FGAirport::findByIdent(s);
558 naRuntimeError(c, "airportinfo() couldn't find airport: %s", s);
563 naRuntimeError(c, "airportinfo() with invalid function arguments");
568 apt = FGAirport::findClosest(pos, maxRange, &filter);
569 if(!apt) return naNil();
572 string id = apt->ident();
573 string name = apt->name();
576 naRef rwys = naNewHash(c);
577 for(unsigned int r=0; r<apt->numRunways(); ++r) {
578 FGRunway* rwy(apt->getRunwayByIndex(r));
580 naRef rwyid = naStr_fromdata(naNewString(c),
581 const_cast<char *>(rwy->ident().c_str()),
582 rwy->ident().length());
584 naRef rwydata = naNewHash(c);
585 #define HASHSET(s,l,n) naHash_set(rwydata, naStr_fromdata(naNewString(c),s,l),n)
586 HASHSET("id", 2, rwyid);
587 HASHSET("lat", 3, naNum(rwy->latitude()));
588 HASHSET("lon", 3, naNum(rwy->longitude()));
589 HASHSET("heading", 7, naNum(rwy->headingDeg()));
590 HASHSET("length", 6, naNum(rwy->lengthM()));
591 HASHSET("width", 5, naNum(rwy->widthM()));
592 HASHSET("threshold", 9, naNum(rwy->displacedThresholdM()));
593 HASHSET("stopway", 7, naNum(rwy->stopwayM()));
595 naHash_set(rwys, rwyid, rwydata);
599 naRef aptdata = naNewHash(c);
600 #define HASHSET(s,l,n) naHash_set(aptdata, naStr_fromdata(naNewString(c),s,l),n)
601 HASHSET("id", 2, naStr_fromdata(naNewString(c),
602 const_cast<char *>(id.c_str()), id.length()));
603 HASHSET("name", 4, naStr_fromdata(naNewString(c),
604 const_cast<char *>(name.c_str()), name.length()));
605 HASHSET("lat", 3, naNum(apt->getLatitude()));
606 HASHSET("lon", 3, naNum(apt->getLongitude()));
607 HASHSET("elevation", 9, naNum(apt->getElevation() * SG_FEET_TO_METER));
608 HASHSET("has_metar", 9, naNum(apt->getMetar()));
609 HASHSET("runways", 7, rwys);
615 // Table of extension functions. Terminate with zeros.
616 static struct { const char* name; naCFunction func; } funcs[] = {
617 { "getprop", f_getprop },
618 { "setprop", f_setprop },
619 { "print", f_print },
620 { "_fgcommand", f_fgcommand },
621 { "settimer", f_settimer },
622 { "_setlistener", f_setlistener },
623 { "removelistener", f_removelistener },
624 { "_cmdarg", f_cmdarg },
625 { "_interpolate", f_interpolate },
627 { "srand", f_srand },
628 { "abort", f_abort },
629 { "directory", f_directory },
630 { "parsexml", f_parsexml },
631 { "systime", f_systime },
632 { "carttogeod", f_carttogeod },
633 { "geodtocart", f_geodtocart },
634 { "geodinfo", f_geodinfo },
635 { "airportinfo", f_airportinfo },
639 naRef FGNasalSys::cmdArgGhost()
641 return propNodeGhost(_cmdArg);
644 void FGNasalSys::init()
648 _context = naNewContext();
650 // Start with globals. Add it to itself as a recursive
651 // sub-reference under the name "globals". This gives client-code
652 // write access to the namespace if someone wants to do something
654 _globals = naInit_std(_context);
655 naSave(_context, _globals);
656 hashset(_globals, "globals", _globals);
658 hashset(_globals, "math", naInit_math(_context));
659 hashset(_globals, "bits", naInit_bits(_context));
660 hashset(_globals, "io", naInit_io(_context));
661 hashset(_globals, "thread", naInit_thread(_context));
662 hashset(_globals, "utf8", naInit_utf8(_context));
664 // Add our custom extension functions:
665 for(i=0; funcs[i].name; i++)
666 hashset(_globals, funcs[i].name,
667 naNewFunc(_context, naNewCCode(_context, funcs[i].func)));
669 // And our SGPropertyNode wrapper
670 hashset(_globals, "props", genPropsModule());
672 // Make a "__gcsave" hash to hold the naRef objects which get
673 // passed to handles outside the interpreter (to protect them from
674 // begin garbage-collected).
675 _gcHash = naNewHash(_context);
676 hashset(_globals, "__gcsave", _gcHash);
678 // Now load the various source files in the Nasal directory
679 SGPath p(globals->get_fg_root());
682 ulDir* dir = ulOpenDir(p.c_str());
683 while(dir && (dent = ulReadDir(dir)) != 0) {
685 fullpath.append(dent->d_name);
686 SGPath file(dent->d_name);
687 if(file.extension() != "nas") continue;
688 loadModule(fullpath, file.base().c_str());
692 // set signal and remove node to avoid restoring at reinit
693 const char *s = "nasal-dir-initialized";
694 SGPropertyNode *signal = fgGetNode("/sim/signals", true);
695 signal->setBoolValue(s, true);
696 signal->removeChildren(s, false);
698 // Pull scripts out of the property tree, too
699 loadPropertyScripts();
702 void FGNasalSys::update(double)
704 if(!_dead_listener.empty()) {
705 vector<FGNasalListener *>::iterator it, end = _dead_listener.end();
706 for(it = _dead_listener.begin(); it != end; ++it) delete *it;
707 _dead_listener.clear();
710 // The global context is a legacy thing. We use dynamically
711 // created contexts for naCall() now, so that we can call them
712 // recursively. But there are still spots that want to use it for
713 // naNew*() calls, which end up leaking memory because the context
714 // only clears out its temporary vector when it's *used*. So just
715 // junk it and fetch a new/reinitialized one every frame. This is
716 // clumsy: the right solution would use the dynamic context in all
717 // cases and eliminate _context entirely. But that's more work,
718 // and this works fine (yes, they say "New" and "Free", but
719 // they're very fast, just trust me). -Andy
720 naFreeContext(_context);
721 _context = naNewContext();
724 // Loads the scripts found under /nasal in the global tree
725 void FGNasalSys::loadPropertyScripts()
727 SGPropertyNode* nasal = globals->get_props()->getNode("nasal");
730 for(int i=0; i<nasal->nChildren(); i++) {
731 SGPropertyNode* n = nasal->getChild(i);
733 const char* module = n->getName();
734 if(n->hasChild("module"))
735 module = n->getStringValue("module");
737 // allow multiple files to be specified within a single
741 bool file_specified = false;
742 while((fn = n->getChild("file", j)) != NULL) {
743 file_specified = true;
744 const char* file = fn->getStringValue();
745 SGPath p(globals->get_fg_root());
747 loadModule(p, module);
751 const char* src = n->getStringValue("script");
752 if(!n->hasChild("script")) src = 0; // Hrm...
754 createModule(module, n->getPath(), src, strlen(src));
756 if(!file_specified && !src)
757 SG_LOG(SG_NASAL, SG_ALERT, "Nasal error: " <<
758 "no <file> or <script> defined in " <<
759 "/nasal/" << module);
763 // Logs a runtime error, with stack trace, to the FlightGear log stream
764 void FGNasalSys::logError(naContext context)
766 SG_LOG(SG_NASAL, SG_ALERT,
767 "Nasal runtime error: " << naGetError(context));
768 SG_LOG(SG_NASAL, SG_ALERT,
769 " at " << naStr_data(naGetSourceFile(context, 0)) <<
770 ", line " << naGetLine(context, 0));
771 for(int i=1; i<naStackDepth(context); i++)
772 SG_LOG(SG_NASAL, SG_ALERT,
773 " called from: " << naStr_data(naGetSourceFile(context, i)) <<
774 ", line " << naGetLine(context, i));
777 // Reads a script file, executes it, and places the resulting
778 // namespace into the global namespace under the specified module
780 void FGNasalSys::loadModule(SGPath file, const char* module)
783 char* buf = readfile(file.c_str(), &len);
785 SG_LOG(SG_NASAL, SG_ALERT,
786 "Nasal error: could not read script file " << file.c_str()
787 << " into module " << module);
791 createModule(module, file.c_str(), buf, len);
795 // Parse and run. Save the local variables namespace, as it will
796 // become a sub-object of globals. The optional "arg" argument can be
797 // used to pass an associated property node to the module, which can then
798 // be accessed via cmdarg(). (This is, for example, used by XML dialogs.)
799 void FGNasalSys::createModule(const char* moduleName, const char* fileName,
800 const char* src, int len,
801 const SGPropertyNode* cmdarg,
802 int argc, naRef* args)
804 naRef code = parse(fileName, src, len);
808 // See if we already have a module hash to use. This allows the
809 // user to, for example, add functions to the built-in math
810 // module. Make a new one if necessary.
812 naRef modname = naNewString(_context);
813 naStr_fromdata(modname, (char*)moduleName, strlen(moduleName));
814 if(!naHash_get(_globals, modname, &locals))
815 locals = naNewHash(_context);
817 _cmdArg = (SGPropertyNode*)cmdarg;
819 call(code, argc, args, locals);
820 hashset(_globals, moduleName, locals);
823 void FGNasalSys::deleteModule(const char* moduleName)
825 naRef modname = naNewString(_context);
826 naStr_fromdata(modname, (char*)moduleName, strlen(moduleName));
827 naHash_delete(_globals, modname);
830 naRef FGNasalSys::parse(const char* filename, const char* buf, int len)
833 naRef srcfile = naNewString(_context);
834 naStr_fromdata(srcfile, (char*)filename, strlen(filename));
835 naRef code = naParseCode(_context, srcfile, 1, (char*)buf, len, &errLine);
837 SG_LOG(SG_NASAL, SG_ALERT,
838 "Nasal parse error: " << naGetError(_context) <<
839 " in "<< filename <<", line " << errLine);
843 // Bind to the global namespace before returning
844 return naBindFunction(_context, code, _globals);
847 bool FGNasalSys::handleCommand(const SGPropertyNode* arg)
849 const char* nasal = arg->getStringValue("script");
850 const char* moduleName = arg->getStringValue("module");
851 naRef code = parse(arg->getPath(true), nasal, strlen(nasal));
852 if(naIsNil(code)) return false;
854 // Commands can be run "in" a module. Make sure that module
855 // exists, and set it up as the local variables hash for the
857 naRef locals = naNil();
859 naRef modname = naNewString(_context);
860 naStr_fromdata(modname, (char*)moduleName, strlen(moduleName));
861 if(!naHash_get(_globals, modname, &locals)) {
862 locals = naNewHash(_context);
863 naHash_set(_globals, modname, locals);
867 // Cache this command's argument for inspection via cmdarg(). For
868 // performance reasons, we won't bother with it if the invoked
869 // code doesn't need it.
870 _cmdArg = (SGPropertyNode*)arg;
872 call(code, 0, 0, locals);
876 // settimer(func, dt, simtime) extension function. The first argument
877 // is a Nasal function to call, the second is a delta time (from now),
878 // in seconds. The third, if present, is a boolean value indicating
879 // that "real world" time (rather than simulator time) is to be used.
881 // Implementation note: the FGTimer objects don't live inside the
882 // garbage collector, so the Nasal handler functions have to be
883 // "saved" somehow lest they be inadvertently cleaned. In this case,
884 // they are inserted into a globals.__gcsave hash and removed on
886 void FGNasalSys::setTimer(naContext c, int argc, naRef* args)
888 // Extract the handler, delta, and simtime arguments:
889 naRef handler = argc > 0 ? args[0] : naNil();
890 if(!(naIsCode(handler) || naIsCCode(handler) || naIsFunc(handler))) {
891 naRuntimeError(c, "settimer() with invalid function argument");
895 naRef delta = argc > 1 ? args[1] : naNil();
897 naRuntimeError(c, "settimer() with invalid time argument");
901 bool simtime = (argc > 2 && naTrue(args[2])) ? false : true;
903 // Generate and register a C++ timer handler
904 NasalTimer* t = new NasalTimer;
905 t->handler = handler;
906 t->gcKey = gcSave(handler);
909 globals->get_event_mgr()->addEvent("NasalTimer",
910 t, &NasalTimer::timerExpired,
914 void FGNasalSys::handleTimer(NasalTimer* t)
916 call(t->handler, 0, 0, naNil());
920 int FGNasalSys::gcSave(naRef r)
922 int key = _nextGCKey++;
923 naHash_set(_gcHash, naNum(key), r);
927 void FGNasalSys::gcRelease(int key)
929 naHash_delete(_gcHash, naNum(key));
932 void FGNasalSys::NasalTimer::timerExpired()
934 nasal->handleTimer(this);
938 int FGNasalSys::_listenerId = 0;
940 // setlistener(<property>, <func> [, <initial=0> [, <persistent=1>]])
941 // Attaches a callback function to a property (specified as a global
942 // property path string or a SGPropertyNode_ptr* ghost). If the third,
943 // optional argument (default=0) is set to 1, then the function is also
944 // called initially. If the fourth, optional argument is set to 0, then the
945 // function is only called when the property node value actually changes.
946 // Otherwise it's called independent of the value whenever the node is
947 // written to (default). The setlistener() function returns a unique
948 // id number, which is to be used as argument to the removelistener()
950 naRef FGNasalSys::setListener(naContext c, int argc, naRef* args)
952 SGPropertyNode_ptr node;
953 naRef prop = argc > 0 ? args[0] : naNil();
954 if(naIsString(prop)) node = fgGetNode(naStr_data(prop), true);
955 else if(naIsGhost(prop)) node = *(SGPropertyNode_ptr*)naGhost_ptr(prop);
957 naRuntimeError(c, "setlistener() with invalid property argument");
962 SG_LOG(SG_NASAL, SG_DEBUG, "Attaching listener to tied property " <<
965 naRef code = argc > 1 ? args[1] : naNil();
966 if(!(naIsCode(code) || naIsCCode(code) || naIsFunc(code))) {
967 naRuntimeError(c, "setlistener() with invalid function argument");
971 int init = argc > 2 && naIsNum(args[2]) ? int(args[2].num) : 0;
972 int type = argc > 3 && naIsNum(args[3]) ? int(args[3].num) : 1;
973 FGNasalListener *nl = new FGNasalListener(node, code, this,
974 gcSave(code), _listenerId, init, type);
976 node->addChangeListener(nl, init);
978 _listener[_listenerId] = nl;
979 return naNum(_listenerId++);
982 // removelistener(int) extension function. The argument is the id of
983 // a listener as returned by the setlistener() function.
984 naRef FGNasalSys::removeListener(naContext c, int argc, naRef* args)
986 naRef id = argc > 0 ? args[0] : naNil();
987 map<int, FGNasalListener *>::iterator it = _listener.find(int(id.num));
989 if(!naIsNum(id) || it == _listener.end() || it->second->_dead) {
990 naRuntimeError(c, "removelistener() with invalid listener id");
994 it->second->_dead = true;
995 _dead_listener.push_back(it->second);
997 return naNum(_listener.size());
1002 // FGNasalListener class.
1004 FGNasalListener::FGNasalListener(SGPropertyNode *node, naRef code,
1005 FGNasalSys* nasal, int key, int id,
1006 int init, int type) :
1019 if(_type == 0 && !_init)
1023 FGNasalListener::~FGNasalListener()
1025 _node->removeChangeListener(this);
1026 _nas->gcRelease(_gcKey);
1029 void FGNasalListener::call(SGPropertyNode* which, naRef mode)
1031 if(_active || _dead) return;
1032 SG_LOG(SG_NASAL, SG_DEBUG, "trigger listener #" << _id);
1035 arg[0] = _nas->propNodeGhost(which);
1036 arg[1] = _nas->propNodeGhost(_node);
1037 arg[2] = mode; // value changed, child added/removed
1038 arg[3] = naNum(_node != which); // child event?
1039 _nas->call(_code, 4, arg, naNil());
1043 void FGNasalListener::valueChanged(SGPropertyNode* node)
1045 if(_type < 2 && node != _node) return; // skip child events
1046 if(_type > 0 || changed(_node) || _init)
1047 call(node, naNum(0));
1052 void FGNasalListener::childAdded(SGPropertyNode*, SGPropertyNode* child)
1054 if(_type == 2) call(child, naNum(1));
1057 void FGNasalListener::childRemoved(SGPropertyNode*, SGPropertyNode* child)
1059 if(_type == 2) call(child, naNum(-1));
1062 bool FGNasalListener::changed(SGPropertyNode* node)
1064 using namespace simgear::props;
1065 Type type = node->getType();
1066 if(type == NONE) return false;
1067 if(type == UNSPECIFIED) return true;
1075 long l = node->getLongValue();
1076 result = l != _last_int;
1083 double d = node->getDoubleValue();
1084 result = d != _last_float;
1090 string s = node->getStringValue();
1091 result = s != _last_string;
1100 // FGNasalModelData class. If sgLoad3DModel() is called with a pointer to
1101 // such a class, then it lets modelLoaded() run the <load> script, and the
1102 // destructor the <unload> script. The latter happens when the model branch
1103 // is removed from the scene graph.
1105 unsigned int FGNasalModelData::_module_id = 0;
1107 void FGNasalModelData::modelLoaded(const string& path, SGPropertyNode *prop,
1112 SGPropertyNode *nasal = prop->getNode("nasal");
1116 SGPropertyNode *load = nasal->getNode("load");
1117 _unload = nasal->getNode("unload");
1118 if(!load && !_unload)
1121 std::stringstream m;
1122 m << "__model" << _module_id++;
1125 const char *s = load ? load->getStringValue() : "";
1128 arg[0] = nasalSys->propNodeGhost(_root);
1129 arg[1] = nasalSys->propNodeGhost(prop);
1130 nasalSys->createModule(_module.c_str(), path.c_str(), s, strlen(s),
1134 FGNasalModelData::~FGNasalModelData()
1140 SG_LOG(SG_NASAL, SG_WARN, "Trying to run an <unload> script "
1141 "without Nasal subsystem present.");
1146 const char *s = _unload->getStringValue();
1147 nasalSys->createModule(_module.c_str(), _module.c_str(), s, strlen(s), _root);
1149 nasalSys->deleteModule(_module.c_str());
1154 // NasalXMLVisitor class: handles EasyXML visitor callback for parsexml()
1156 NasalXMLVisitor::NasalXMLVisitor(naContext c, int argc, naRef* args) :
1157 _c(naSubContext(c)),
1158 _start_element(argc > 1 ? args[1] : naNil()),
1159 _end_element(argc > 2 ? args[2] : naNil()),
1160 _data(argc > 3 ? args[3] : naNil()),
1161 _pi(argc > 4 ? args[4] : naNil())
1165 void NasalXMLVisitor::startElement(const char* tag, const XMLAttributes& a)
1167 if(naIsNil(_start_element)) return;
1168 naRef attr = naNewHash(_c);
1169 for(int i=0; i<a.size(); i++) {
1170 naRef name = make_string(a.getName(i));
1171 naRef value = make_string(a.getValue(i));
1172 naHash_set(attr, name, value);
1174 call(_start_element, 2, make_string(tag), attr);
1177 void NasalXMLVisitor::endElement(const char* tag)
1179 if(!naIsNil(_end_element)) call(_end_element, 1, make_string(tag));
1182 void NasalXMLVisitor::data(const char* str, int len)
1184 if(!naIsNil(_data)) call(_data, 1, make_string(str, len));
1187 void NasalXMLVisitor::pi(const char* target, const char* data)
1189 if(!naIsNil(_pi)) call(_pi, 2, make_string(target), make_string(data));
1192 void NasalXMLVisitor::call(naRef func, int num, naRef a, naRef b)
1197 naCall(_c, func, num, args, naNil(), naNil());
1202 naRef NasalXMLVisitor::make_string(const char* s, int n)
1204 return naStr_fromdata(naNewString(_c), const_cast<char *>(s),
1205 n < 0 ? strlen(s) : n);