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>
35 #include <Navaids/navrecord.hxx>
37 #include "NasalSys.hxx"
39 static FGNasalSys* nasalSys = 0;
42 // Read and return file contents in a single buffer. Note use of
43 // stat() to get the file size. This is a win32 function, believe it
44 // or not. :) Note the REALLY IMPORTANT use of the "b" flag to fopen.
45 // Text mode brain damage will kill us if we're trying to do bytewise
47 static char* readfile(const char* file, int* lenOut)
50 if(stat(file, &data) != 0) return 0;
51 FILE* f = fopen(file, "rb");
53 char* buf = new char[data.st_size];
54 *lenOut = fread(buf, 1, data.st_size, f);
56 if(*lenOut != data.st_size) {
57 // Shouldn't happen, but warn anyway since it represents a
58 // platform bug and not a typical runtime error (missing file,
60 SG_LOG(SG_NASAL, SG_ALERT,
61 "ERROR in Nasal initialization: " <<
62 "short count returned from fread() of " << file <<
63 ". Check your C library!");
70 FGNasalSys::FGNasalSys()
76 _nextGCKey = 0; // Any value will do
80 // Does a naCall() in a new context. Wrapped here to make lock
81 // tracking easier. Extension functions are called with the lock, but
82 // we have to release it before making a new naCall(). So rather than
83 // drop the lock in every extension function that might call back into
84 // Nasal, we keep a stack depth counter here and only unlock/lock
85 // around the naCall if it isn't the first one.
86 naRef FGNasalSys::call(naRef code, int argc, naRef* args, naRef locals)
88 naContext ctx = naNewContext();
89 if(_callCount) naModUnlock();
91 naRef result = naCall(ctx, code, argc, args, naNil(), locals);
95 if(_callCount) naModLock();
100 FGNasalSys::~FGNasalSys()
103 map<int, FGNasalListener *>::iterator it, end = _listener.end();
104 for(it = _listener.begin(); it != end; ++it)
107 naFreeContext(_context);
111 bool FGNasalSys::parseAndRun(const char* sourceCode)
113 naRef code = parse("FGNasalSys::parseAndRun()", sourceCode,
117 call(code, 0, 0, naNil());
121 FGNasalScript* FGNasalSys::parseScript(const char* src, const char* name)
123 FGNasalScript* script = new FGNasalScript();
124 script->_gcKey = -1; // important, if we delete it on a parse
125 script->_nas = this; // error, don't clobber a real handle!
129 sprintf(buf, "FGNasalScript@%p", (void *)script);
133 script->_code = parse(name, src, strlen(src));
134 if(naIsNil(script->_code)) {
139 script->_gcKey = gcSave(script->_code);
143 // Utility. Sets a named key in a hash by C string, rather than nasal
145 void FGNasalSys::hashset(naRef hash, const char* key, naRef val)
147 naRef s = naNewString(_context);
148 naStr_fromdata(s, (char*)key, strlen(key));
149 naHash_set(hash, s, val);
152 // The get/setprop functions accept a *list* of strings and walk
153 // through the property tree with them to find the appropriate node.
154 // This allows a Nasal object to hold onto a property path and use it
155 // like a node object, e.g. setprop(ObjRoot, "size-parsecs", 2.02). This
156 // is the utility function that walks the property tree.
157 // Future enhancement: support integer arguments to specify array
159 static SGPropertyNode* findnode(naContext c, naRef* vec, int len)
161 SGPropertyNode* p = globals->get_props();
163 for(int i=0; i<len; i++) {
165 if(!naIsString(a)) return 0;
166 p = p->getNode(naStr_data(a));
169 } catch (const string& err) {
170 naRuntimeError(c, (char *)err.c_str());
176 // getprop() extension function. Concatenates its string arguments as
177 // property names and returns the value of the specified property. Or
178 // nil if it doesn't exist.
179 static naRef f_getprop(naContext c, naRef me, int argc, naRef* args)
181 using namespace simgear;
182 const SGPropertyNode* p = findnode(c, args, argc);
183 if(!p) return naNil();
185 switch(p->getType()) {
186 case props::BOOL: case props::INT:
187 case props::LONG: case props::FLOAT:
189 return naNum(p->getDoubleValue());
192 case props::UNSPECIFIED:
194 naRef nastr = naNewString(c);
195 const char* val = p->getStringValue();
196 naStr_fromdata(nastr, (char*)val, strlen(val));
199 case props::ALIAS: // <--- FIXME, recurse?
205 // setprop() extension function. Concatenates its string arguments as
206 // property names and sets the value of the specified property to the
208 static naRef f_setprop(naContext c, naRef me, int argc, naRef* args)
211 char buf[BUFLEN + 1];
215 for(int i=0; i<argc-1; i++) {
216 naRef s = naStringValue(c, args[i]);
217 if(naIsNil(s)) return naNil();
218 strncpy(p, naStr_data(s), buflen);
220 buflen = BUFLEN - (p - buf);
221 if(i < (argc-2) && buflen > 0) {
227 SGPropertyNode* props = globals->get_props();
228 naRef val = args[argc-1];
231 if(naIsString(val)) result = props->setStringValue(buf, naStr_data(val));
233 naRef n = naNumValue(val);
235 naRuntimeError(c, "setprop() value is not string or number");
236 result = props->setDoubleValue(buf, n.num);
238 } catch (const string& err) {
239 naRuntimeError(c, (char *)err.c_str());
241 return naNum(result);
245 // print() extension function. Concatenates and prints its arguments
246 // to the FlightGear log. Uses the highest log level (SG_ALERT), to
247 // make sure it appears. Is there better way to do this?
248 static naRef f_print(naContext c, naRef me, int argc, naRef* args)
252 for(int i=0; i<n; i++) {
253 naRef s = naStringValue(c, args[i]);
254 if(naIsNil(s)) continue;
255 buf += naStr_data(s);
257 SG_LOG(SG_GENERAL, SG_ALERT, buf);
258 return naNum(buf.length());
261 // fgcommand() extension function. Executes a named command via the
262 // FlightGear command manager. Takes a single property node name as
264 static naRef f_fgcommand(naContext c, naRef me, int argc, naRef* args)
266 naRef cmd = argc > 0 ? args[0] : naNil();
267 naRef props = argc > 1 ? args[1] : naNil();
268 if(!naIsString(cmd) || (!naIsNil(props) && !naIsGhost(props)))
269 naRuntimeError(c, "bad arguments to fgcommand()");
270 SGPropertyNode_ptr tmp, *node;
272 node = (SGPropertyNode_ptr*)naGhost_ptr(props);
274 tmp = new SGPropertyNode();
277 return naNum(globals->get_commands()->execute(naStr_data(cmd), *node));
280 // settimer(func, dt, simtime) extension function. Falls through to
281 // FGNasalSys::setTimer(). See there for docs.
282 static naRef f_settimer(naContext c, naRef me, int argc, naRef* args)
284 nasalSys->setTimer(c, argc, args);
288 // setlistener(func, property, bool) extension function. Falls through to
289 // FGNasalSys::setListener(). See there for docs.
290 static naRef f_setlistener(naContext c, naRef me, int argc, naRef* args)
292 return nasalSys->setListener(c, argc, args);
295 // removelistener(int) extension function. Falls through to
296 // FGNasalSys::removeListener(). See there for docs.
297 static naRef f_removelistener(naContext c, naRef me, int argc, naRef* args)
299 return nasalSys->removeListener(c, argc, args);
302 // Returns a ghost handle to the argument to the currently executing
304 static naRef f_cmdarg(naContext c, naRef me, int argc, naRef* args)
306 return nasalSys->cmdArgGhost();
309 // Sets up a property interpolation. The first argument is either a
310 // ghost (SGPropertyNode_ptr*) or a string (global property path) to
311 // interpolate. The second argument is a vector of pairs of
312 // value/delta numbers.
313 static naRef f_interpolate(naContext c, naRef me, int argc, naRef* args)
315 SGPropertyNode* node;
316 naRef prop = argc > 0 ? args[0] : naNil();
317 if(naIsString(prop)) node = fgGetNode(naStr_data(prop), true);
318 else if(naIsGhost(prop)) node = *(SGPropertyNode_ptr*)naGhost_ptr(prop);
321 naRef curve = argc > 1 ? args[1] : naNil();
322 if(!naIsVector(curve)) return naNil();
323 int nPoints = naVec_size(curve) / 2;
324 double* values = new double[nPoints];
325 double* deltas = new double[nPoints];
326 for(int i=0; i<nPoints; i++) {
327 values[i] = naNumValue(naVec_get(curve, 2*i)).num;
328 deltas[i] = naNumValue(naVec_get(curve, 2*i+1)).num;
331 ((SGInterpolator*)globals->get_subsystem_mgr()
332 ->get_group(SGSubsystemMgr::INIT)->get_subsystem("interpolator"))
333 ->interpolate(node, nPoints, values, deltas);
340 // This is a better RNG than the one in the default Nasal distribution
341 // (which is based on the C library rand() implementation). It will
343 static naRef f_rand(naContext c, naRef me, int argc, naRef* args)
345 return naNum(sg_random());
348 static naRef f_srand(naContext c, naRef me, int argc, naRef* args)
354 static naRef f_abort(naContext c, naRef me, int argc, naRef* args)
360 // Return an array listing of all files in a directory
361 static naRef f_directory(naContext c, naRef me, int argc, naRef* args)
363 if(argc != 1 || !naIsString(args[0]))
364 naRuntimeError(c, "bad arguments to directory()");
365 naRef ldir = args[0];
366 ulDir* dir = ulOpenDir(naStr_data(args[0]));
367 if(!dir) return naNil();
368 naRef result = naNewVector(c);
370 while((dent = ulReadDir(dir)))
371 naVec_append(result, naStr_fromdata(naNewString(c), dent->d_name,
372 strlen(dent->d_name)));
378 * Given a data path, resolve it in FG_ROOT or an FG_AIRCRFT directory
380 static naRef f_resolveDataPath(naContext c, naRef me, int argc, naRef* args)
382 if(argc != 1 || !naIsString(args[0]))
383 naRuntimeError(c, "bad arguments to resolveDataPath()");
385 SGPath p = globals->resolve_maybe_aircraft_path(naStr_data(args[0]));
386 const char* pdata = p.c_str();
387 return naStr_fromdata(naNewString(c), const_cast<char*>(pdata), strlen(pdata));
391 // parsexml(<path> [, <start-tag> [, <end-tag> [, <data> [, <pi>]]]]);
393 // <path> ... absolute path to an XML file
394 // <start-tag> ... callback function with two args: tag name, attribute hash
395 // <end-tag> ... callback function with one arg: tag name
396 // <data> ... callback function with one arg: data
397 // <pi> ... callback function with two args: target, data
398 // (pi = "processing instruction")
399 // All four callback functions are optional and default to nil.
400 // The function returns nil on error, or the validated file name otherwise.
401 static naRef f_parsexml(naContext c, naRef me, int argc, naRef* args)
403 if(argc < 1 || !naIsString(args[0]))
404 naRuntimeError(c, "parsexml(): path argument missing or not a string");
405 if(argc > 5) argc = 5;
406 for(int i=1; i<argc; i++)
407 if(!(naIsNil(args[i]) || naIsFunc(args[i])))
408 naRuntimeError(c, "parsexml(): callback argument not a function");
410 const char* file = fgValidatePath(naStr_data(args[0]), false);
412 naRuntimeError(c, "parsexml(): reading '%s' denied "
413 "(unauthorized access)", naStr_data(args[0]));
416 std::ifstream input(file);
417 NasalXMLVisitor visitor(c, argc, args);
419 readXML(input, visitor);
420 } catch (const sg_exception& e) {
421 naRuntimeError(c, "parsexml(): file '%s' %s",
422 file, e.getFormattedMessage().c_str());
425 return naStr_fromdata(naNewString(c), const_cast<char*>(file), strlen(file));
428 // Return UNIX epoch time in seconds.
429 static naRef f_systime(naContext c, naRef me, int argc, naRef* args)
433 GetSystemTimeAsFileTime(&ft);
434 double t = (4294967296.0 * ft.dwHighDateTime + ft.dwLowDateTime);
435 // Converts from 100ns units in 1601 epoch to unix epoch in sec
436 return naNum((t * 1e-7) - 11644473600.0);
440 do { t = time(0); gettimeofday(&td, 0); } while(t != time(0));
441 return naNum(t + 1e-6 * td.tv_usec);
445 // Convert a cartesian point to a geodetic lat/lon/altitude.
446 static naRef f_carttogeod(naContext c, naRef me, int argc, naRef* args)
448 double lat, lon, alt, xyz[3];
449 if(argc != 3) naRuntimeError(c, "carttogeod() expects 3 arguments");
450 for(int i=0; i<3; i++)
451 xyz[i] = naNumValue(args[i]).num;
452 sgCartToGeod(xyz, &lat, &lon, &alt);
453 lat *= SG_RADIANS_TO_DEGREES;
454 lon *= SG_RADIANS_TO_DEGREES;
455 naRef vec = naNewVector(c);
456 naVec_append(vec, naNum(lat));
457 naVec_append(vec, naNum(lon));
458 naVec_append(vec, naNum(alt));
462 // Convert a geodetic lat/lon/altitude to a cartesian point.
463 static naRef f_geodtocart(naContext c, naRef me, int argc, naRef* args)
465 if(argc != 3) naRuntimeError(c, "geodtocart() expects 3 arguments");
466 double lat = naNumValue(args[0]).num * SG_DEGREES_TO_RADIANS;
467 double lon = naNumValue(args[1]).num * SG_DEGREES_TO_RADIANS;
468 double alt = naNumValue(args[2]).num;
470 sgGeodToCart(lat, lon, alt, xyz);
471 naRef vec = naNewVector(c);
472 naVec_append(vec, naNum(xyz[0]));
473 naVec_append(vec, naNum(xyz[1]));
474 naVec_append(vec, naNum(xyz[2]));
478 // For given geodetic point return array with elevation, and a material data
479 // hash, or nil if there's no information available (tile not loaded). If
480 // information about the material isn't available, then nil is returned instead
482 static naRef f_geodinfo(naContext c, naRef me, int argc, naRef* args)
484 #define HASHSET(s,l,n) naHash_set(matdata, naStr_fromdata(naNewString(c),s,l),n)
485 if(argc < 2 || argc > 3)
486 naRuntimeError(c, "geodinfo() expects 2 or 3 arguments: lat, lon [, maxalt]");
487 double lat = naNumValue(args[0]).num;
488 double lon = naNumValue(args[1]).num;
489 double elev = argc == 3 ? naNumValue(args[2]).num : 10000;
490 const SGMaterial *mat;
491 SGGeod geod = SGGeod::fromDegM(lon, lat, elev);
492 if(!globals->get_scenery()->get_elevation_m(geod, elev, &mat))
494 naRef vec = naNewVector(c);
495 naVec_append(vec, naNum(elev));
496 naRef matdata = naNil();
498 matdata = naNewHash(c);
499 naRef names = naNewVector(c);
500 const vector<string> n = mat->get_names();
501 for(unsigned int i=0; i<n.size(); i++)
502 naVec_append(names, naStr_fromdata(naNewString(c),
503 const_cast<char*>(n[i].c_str()), n[i].size()));
504 HASHSET("names", 5, names);
505 HASHSET("solid", 5, naNum(mat->get_solid()));
506 HASHSET("friction_factor", 15, naNum(mat->get_friction_factor()));
507 HASHSET("rolling_friction", 16, naNum(mat->get_rolling_friction()));
508 HASHSET("load_resistance", 15, naNum(mat->get_load_resistance()));
509 HASHSET("bumpiness", 9, naNum(mat->get_bumpiness()));
510 HASHSET("light_coverage", 14, naNum(mat->get_light_coverage()));
512 naVec_append(vec, matdata);
518 class AirportInfoFilter : public FGAirport::AirportFilter
521 AirportInfoFilter() : type(FGPositioned::AIRPORT) {
524 virtual FGPositioned::Type minType() const {
528 virtual FGPositioned::Type maxType() const {
532 FGPositioned::Type type;
535 // Returns data hash for particular or nearest airport of a <type>, or nil
538 // airportinfo(<id>); e.g. "KSFO"
539 // airportinfo(<type>); type := ("airport"|"seaport"|"heliport")
540 // airportinfo() same as airportinfo("airport")
541 // airportinfo(<lat>, <lon> [, <type>]);
542 static naRef f_airportinfo(naContext c, naRef me, int argc, naRef* args)
544 static SGConstPropertyNode_ptr latn = fgGetNode("/position/latitude-deg", true);
545 static SGConstPropertyNode_ptr lonn = fgGetNode("/position/longitude-deg", true);
547 FGAirport* apt = NULL;
549 if(argc >= 2 && naIsNum(args[0]) && naIsNum(args[1])) {
550 pos = SGGeod::fromDeg(args[1].num, args[0].num);
554 pos = SGGeod::fromDeg(lonn->getDoubleValue(), latn->getDoubleValue());
557 double maxRange = 10000.0; // expose this? or pick a smaller value?
559 AirportInfoFilter filter; // defaults to airports only
562 // fall through and use AIRPORT
563 } else if(argc == 1 && naIsString(args[0])) {
564 const char *s = naStr_data(args[0]);
565 if(!strcmp(s, "airport")) filter.type = FGPositioned::AIRPORT;
566 else if(!strcmp(s, "seaport")) filter.type = FGPositioned::SEAPORT;
567 else if(!strcmp(s, "heliport")) filter.type = FGPositioned::HELIPORT;
569 // user provided an <id>, hopefully
570 apt = FGAirport::findByIdent(s);
572 // return nil here, but don't raise a runtime error; this is a
573 // legitamate way to validate an ICAO code, for example in a
574 // dialog box or similar.
579 naRuntimeError(c, "airportinfo() with invalid function arguments");
584 apt = FGAirport::findClosest(pos, maxRange, &filter);
585 if(!apt) return naNil();
588 string id = apt->ident();
589 string name = apt->name();
592 naRef rwys = naNewHash(c);
593 for(unsigned int r=0; r<apt->numRunways(); ++r) {
594 FGRunway* rwy(apt->getRunwayByIndex(r));
596 naRef rwyid = naStr_fromdata(naNewString(c),
597 const_cast<char *>(rwy->ident().c_str()),
598 rwy->ident().length());
600 naRef rwydata = naNewHash(c);
601 #define HASHSET(s,l,n) naHash_set(rwydata, naStr_fromdata(naNewString(c),s,l),n)
602 HASHSET("id", 2, rwyid);
603 HASHSET("lat", 3, naNum(rwy->latitude()));
604 HASHSET("lon", 3, naNum(rwy->longitude()));
605 HASHSET("heading", 7, naNum(rwy->headingDeg()));
606 HASHSET("length", 6, naNum(rwy->lengthM()));
607 HASHSET("width", 5, naNum(rwy->widthM()));
608 HASHSET("threshold", 9, naNum(rwy->displacedThresholdM()));
609 HASHSET("stopway", 7, naNum(rwy->stopwayM()));
612 HASHSET("ils_frequency_mhz", 17, naNum(rwy->ILS()->get_freq() / 100.0));
616 naHash_set(rwys, rwyid, rwydata);
620 naRef aptdata = naNewHash(c);
621 #define HASHSET(s,l,n) naHash_set(aptdata, naStr_fromdata(naNewString(c),s,l),n)
622 HASHSET("id", 2, naStr_fromdata(naNewString(c),
623 const_cast<char *>(id.c_str()), id.length()));
624 HASHSET("name", 4, naStr_fromdata(naNewString(c),
625 const_cast<char *>(name.c_str()), name.length()));
626 HASHSET("lat", 3, naNum(apt->getLatitude()));
627 HASHSET("lon", 3, naNum(apt->getLongitude()));
628 HASHSET("elevation", 9, naNum(apt->getElevation() * SG_FEET_TO_METER));
629 HASHSET("has_metar", 9, naNum(apt->getMetar()));
630 HASHSET("runways", 7, rwys);
636 // Table of extension functions. Terminate with zeros.
637 static struct { const char* name; naCFunction func; } funcs[] = {
638 { "getprop", f_getprop },
639 { "setprop", f_setprop },
640 { "print", f_print },
641 { "_fgcommand", f_fgcommand },
642 { "settimer", f_settimer },
643 { "_setlistener", f_setlistener },
644 { "removelistener", f_removelistener },
645 { "_cmdarg", f_cmdarg },
646 { "_interpolate", f_interpolate },
648 { "srand", f_srand },
649 { "abort", f_abort },
650 { "directory", f_directory },
651 { "resolvepath", f_resolveDataPath },
652 { "parsexml", f_parsexml },
653 { "systime", f_systime },
654 { "carttogeod", f_carttogeod },
655 { "geodtocart", f_geodtocart },
656 { "geodinfo", f_geodinfo },
657 { "airportinfo", f_airportinfo },
661 naRef FGNasalSys::cmdArgGhost()
663 return propNodeGhost(_cmdArg);
666 void FGNasalSys::init()
670 _context = naNewContext();
672 // Start with globals. Add it to itself as a recursive
673 // sub-reference under the name "globals". This gives client-code
674 // write access to the namespace if someone wants to do something
676 _globals = naInit_std(_context);
677 naSave(_context, _globals);
678 hashset(_globals, "globals", _globals);
680 hashset(_globals, "math", naInit_math(_context));
681 hashset(_globals, "bits", naInit_bits(_context));
682 hashset(_globals, "io", naInit_io(_context));
683 hashset(_globals, "thread", naInit_thread(_context));
684 hashset(_globals, "utf8", naInit_utf8(_context));
686 // Add our custom extension functions:
687 for(i=0; funcs[i].name; i++)
688 hashset(_globals, funcs[i].name,
689 naNewFunc(_context, naNewCCode(_context, funcs[i].func)));
691 // And our SGPropertyNode wrapper
692 hashset(_globals, "props", genPropsModule());
694 // Make a "__gcsave" hash to hold the naRef objects which get
695 // passed to handles outside the interpreter (to protect them from
696 // begin garbage-collected).
697 _gcHash = naNewHash(_context);
698 hashset(_globals, "__gcsave", _gcHash);
700 // Now load the various source files in the Nasal directory
701 SGPath p(globals->get_fg_root());
704 ulDir* dir = ulOpenDir(p.c_str());
705 while(dir && (dent = ulReadDir(dir)) != 0) {
707 fullpath.append(dent->d_name);
708 SGPath file(dent->d_name);
709 if(file.extension() != "nas") continue;
710 loadModule(fullpath, file.base().c_str());
714 // set signal and remove node to avoid restoring at reinit
715 const char *s = "nasal-dir-initialized";
716 SGPropertyNode *signal = fgGetNode("/sim/signals", true);
717 signal->setBoolValue(s, true);
718 signal->removeChildren(s, false);
720 // Pull scripts out of the property tree, too
721 loadPropertyScripts();
724 void FGNasalSys::update(double)
726 if(!_dead_listener.empty()) {
727 vector<FGNasalListener *>::iterator it, end = _dead_listener.end();
728 for(it = _dead_listener.begin(); it != end; ++it) delete *it;
729 _dead_listener.clear();
732 // The global context is a legacy thing. We use dynamically
733 // created contexts for naCall() now, so that we can call them
734 // recursively. But there are still spots that want to use it for
735 // naNew*() calls, which end up leaking memory because the context
736 // only clears out its temporary vector when it's *used*. So just
737 // junk it and fetch a new/reinitialized one every frame. This is
738 // clumsy: the right solution would use the dynamic context in all
739 // cases and eliminate _context entirely. But that's more work,
740 // and this works fine (yes, they say "New" and "Free", but
741 // they're very fast, just trust me). -Andy
742 naFreeContext(_context);
743 _context = naNewContext();
746 // Loads the scripts found under /nasal in the global tree
747 void FGNasalSys::loadPropertyScripts()
749 SGPropertyNode* nasal = globals->get_props()->getNode("nasal");
752 for(int i=0; i<nasal->nChildren(); i++) {
753 SGPropertyNode* n = nasal->getChild(i);
755 const char* module = n->getName();
756 if(n->hasChild("module"))
757 module = n->getStringValue("module");
759 // allow multiple files to be specified within a single
763 bool file_specified = false;
764 while((fn = n->getChild("file", j)) != NULL) {
765 file_specified = true;
766 const char* file = fn->getStringValue();
767 SGPath p = globals->resolve_maybe_aircraft_path(file);
768 loadModule(p, module);
772 const char* src = n->getStringValue("script");
773 if(!n->hasChild("script")) src = 0; // Hrm...
775 createModule(module, n->getPath().c_str(), src, strlen(src));
777 if(!file_specified && !src)
778 SG_LOG(SG_NASAL, SG_ALERT, "Nasal error: " <<
779 "no <file> or <script> defined in " <<
780 "/nasal/" << module);
784 // Logs a runtime error, with stack trace, to the FlightGear log stream
785 void FGNasalSys::logError(naContext context)
787 SG_LOG(SG_NASAL, SG_ALERT,
788 "Nasal runtime error: " << naGetError(context));
789 SG_LOG(SG_NASAL, SG_ALERT,
790 " at " << naStr_data(naGetSourceFile(context, 0)) <<
791 ", line " << naGetLine(context, 0));
792 for(int i=1; i<naStackDepth(context); i++)
793 SG_LOG(SG_NASAL, SG_ALERT,
794 " called from: " << naStr_data(naGetSourceFile(context, i)) <<
795 ", line " << naGetLine(context, i));
798 // Reads a script file, executes it, and places the resulting
799 // namespace into the global namespace under the specified module
801 void FGNasalSys::loadModule(SGPath file, const char* module)
804 char* buf = readfile(file.c_str(), &len);
806 SG_LOG(SG_NASAL, SG_ALERT,
807 "Nasal error: could not read script file " << file.c_str()
808 << " into module " << module);
812 createModule(module, file.c_str(), buf, len);
816 // Parse and run. Save the local variables namespace, as it will
817 // become a sub-object of globals. The optional "arg" argument can be
818 // used to pass an associated property node to the module, which can then
819 // be accessed via cmdarg(). (This is, for example, used by XML dialogs.)
820 void FGNasalSys::createModule(const char* moduleName, const char* fileName,
821 const char* src, int len,
822 const SGPropertyNode* cmdarg,
823 int argc, naRef* args)
825 naRef code = parse(fileName, src, len);
829 // See if we already have a module hash to use. This allows the
830 // user to, for example, add functions to the built-in math
831 // module. Make a new one if necessary.
833 naRef modname = naNewString(_context);
834 naStr_fromdata(modname, (char*)moduleName, strlen(moduleName));
835 if(!naHash_get(_globals, modname, &locals))
836 locals = naNewHash(_context);
838 _cmdArg = (SGPropertyNode*)cmdarg;
840 call(code, argc, args, locals);
841 hashset(_globals, moduleName, locals);
844 void FGNasalSys::deleteModule(const char* moduleName)
846 naRef modname = naNewString(_context);
847 naStr_fromdata(modname, (char*)moduleName, strlen(moduleName));
848 naHash_delete(_globals, modname);
851 naRef FGNasalSys::parse(const char* filename, const char* buf, int len)
854 naRef srcfile = naNewString(_context);
855 naStr_fromdata(srcfile, (char*)filename, strlen(filename));
856 naRef code = naParseCode(_context, srcfile, 1, (char*)buf, len, &errLine);
858 SG_LOG(SG_NASAL, SG_ALERT,
859 "Nasal parse error: " << naGetError(_context) <<
860 " in "<< filename <<", line " << errLine);
864 // Bind to the global namespace before returning
865 return naBindFunction(_context, code, _globals);
868 bool FGNasalSys::handleCommand(const SGPropertyNode* arg)
870 const char* nasal = arg->getStringValue("script");
871 const char* moduleName = arg->getStringValue("module");
872 naRef code = parse(arg->getPath(true).c_str(), nasal, strlen(nasal));
873 if(naIsNil(code)) return false;
875 // Commands can be run "in" a module. Make sure that module
876 // exists, and set it up as the local variables hash for the
878 naRef locals = naNil();
880 naRef modname = naNewString(_context);
881 naStr_fromdata(modname, (char*)moduleName, strlen(moduleName));
882 if(!naHash_get(_globals, modname, &locals)) {
883 locals = naNewHash(_context);
884 naHash_set(_globals, modname, locals);
888 // Cache this command's argument for inspection via cmdarg(). For
889 // performance reasons, we won't bother with it if the invoked
890 // code doesn't need it.
891 _cmdArg = (SGPropertyNode*)arg;
893 call(code, 0, 0, locals);
897 // settimer(func, dt, simtime) extension function. The first argument
898 // is a Nasal function to call, the second is a delta time (from now),
899 // in seconds. The third, if present, is a boolean value indicating
900 // that "real world" time (rather than simulator time) is to be used.
902 // Implementation note: the FGTimer objects don't live inside the
903 // garbage collector, so the Nasal handler functions have to be
904 // "saved" somehow lest they be inadvertently cleaned. In this case,
905 // they are inserted into a globals.__gcsave hash and removed on
907 void FGNasalSys::setTimer(naContext c, int argc, naRef* args)
909 // Extract the handler, delta, and simtime arguments:
910 naRef handler = argc > 0 ? args[0] : naNil();
911 if(!(naIsCode(handler) || naIsCCode(handler) || naIsFunc(handler))) {
912 naRuntimeError(c, "settimer() with invalid function argument");
916 naRef delta = argc > 1 ? args[1] : naNil();
918 naRuntimeError(c, "settimer() with invalid time argument");
922 bool simtime = (argc > 2 && naTrue(args[2])) ? false : true;
924 // Generate and register a C++ timer handler
925 NasalTimer* t = new NasalTimer;
926 t->handler = handler;
927 t->gcKey = gcSave(handler);
930 globals->get_event_mgr()->addEvent("NasalTimer",
931 t, &NasalTimer::timerExpired,
935 void FGNasalSys::handleTimer(NasalTimer* t)
937 call(t->handler, 0, 0, naNil());
941 int FGNasalSys::gcSave(naRef r)
943 int key = _nextGCKey++;
944 naHash_set(_gcHash, naNum(key), r);
948 void FGNasalSys::gcRelease(int key)
950 naHash_delete(_gcHash, naNum(key));
953 void FGNasalSys::NasalTimer::timerExpired()
955 nasal->handleTimer(this);
959 int FGNasalSys::_listenerId = 0;
961 // setlistener(<property>, <func> [, <initial=0> [, <persistent=1>]])
962 // Attaches a callback function to a property (specified as a global
963 // property path string or a SGPropertyNode_ptr* ghost). If the third,
964 // optional argument (default=0) is set to 1, then the function is also
965 // called initially. If the fourth, optional argument is set to 0, then the
966 // function is only called when the property node value actually changes.
967 // Otherwise it's called independent of the value whenever the node is
968 // written to (default). The setlistener() function returns a unique
969 // id number, which is to be used as argument to the removelistener()
971 naRef FGNasalSys::setListener(naContext c, int argc, naRef* args)
973 SGPropertyNode_ptr node;
974 naRef prop = argc > 0 ? args[0] : naNil();
975 if(naIsString(prop)) node = fgGetNode(naStr_data(prop), true);
976 else if(naIsGhost(prop)) node = *(SGPropertyNode_ptr*)naGhost_ptr(prop);
978 naRuntimeError(c, "setlistener() with invalid property argument");
983 SG_LOG(SG_NASAL, SG_DEBUG, "Attaching listener to tied property " <<
986 naRef code = argc > 1 ? args[1] : naNil();
987 if(!(naIsCode(code) || naIsCCode(code) || naIsFunc(code))) {
988 naRuntimeError(c, "setlistener() with invalid function argument");
992 int init = argc > 2 && naIsNum(args[2]) ? int(args[2].num) : 0;
993 int type = argc > 3 && naIsNum(args[3]) ? int(args[3].num) : 1;
994 FGNasalListener *nl = new FGNasalListener(node, code, this,
995 gcSave(code), _listenerId, init, type);
997 node->addChangeListener(nl, init);
999 _listener[_listenerId] = nl;
1000 return naNum(_listenerId++);
1003 // removelistener(int) extension function. The argument is the id of
1004 // a listener as returned by the setlistener() function.
1005 naRef FGNasalSys::removeListener(naContext c, int argc, naRef* args)
1007 naRef id = argc > 0 ? args[0] : naNil();
1008 map<int, FGNasalListener *>::iterator it = _listener.find(int(id.num));
1010 if(!naIsNum(id) || it == _listener.end() || it->second->_dead) {
1011 naRuntimeError(c, "removelistener() with invalid listener id");
1015 it->second->_dead = true;
1016 _dead_listener.push_back(it->second);
1017 _listener.erase(it);
1018 return naNum(_listener.size());
1023 // FGNasalListener class.
1025 FGNasalListener::FGNasalListener(SGPropertyNode *node, naRef code,
1026 FGNasalSys* nasal, int key, int id,
1027 int init, int type) :
1040 if(_type == 0 && !_init)
1044 FGNasalListener::~FGNasalListener()
1046 _node->removeChangeListener(this);
1047 _nas->gcRelease(_gcKey);
1050 void FGNasalListener::call(SGPropertyNode* which, naRef mode)
1052 if(_active || _dead) return;
1053 SG_LOG(SG_NASAL, SG_DEBUG, "trigger listener #" << _id);
1056 arg[0] = _nas->propNodeGhost(which);
1057 arg[1] = _nas->propNodeGhost(_node);
1058 arg[2] = mode; // value changed, child added/removed
1059 arg[3] = naNum(_node != which); // child event?
1060 _nas->call(_code, 4, arg, naNil());
1064 void FGNasalListener::valueChanged(SGPropertyNode* node)
1066 if(_type < 2 && node != _node) return; // skip child events
1067 if(_type > 0 || changed(_node) || _init)
1068 call(node, naNum(0));
1073 void FGNasalListener::childAdded(SGPropertyNode*, SGPropertyNode* child)
1075 if(_type == 2) call(child, naNum(1));
1078 void FGNasalListener::childRemoved(SGPropertyNode*, SGPropertyNode* child)
1080 if(_type == 2) call(child, naNum(-1));
1083 bool FGNasalListener::changed(SGPropertyNode* node)
1085 using namespace simgear;
1086 props::Type type = node->getType();
1087 if(type == props::NONE) return false;
1088 if(type == props::UNSPECIFIED) return true;
1096 long l = node->getLongValue();
1097 result = l != _last_int;
1104 double d = node->getDoubleValue();
1105 result = d != _last_float;
1111 string s = node->getStringValue();
1112 result = s != _last_string;
1121 // FGNasalModelData class. If sgLoad3DModel() is called with a pointer to
1122 // such a class, then it lets modelLoaded() run the <load> script, and the
1123 // destructor the <unload> script. The latter happens when the model branch
1124 // is removed from the scene graph.
1126 unsigned int FGNasalModelData::_module_id = 0;
1128 void FGNasalModelData::modelLoaded(const string& path, SGPropertyNode *prop,
1133 SGPropertyNode *nasal = prop->getNode("nasal");
1137 SGPropertyNode *load = nasal->getNode("load");
1138 _unload = nasal->getNode("unload");
1139 if(!load && !_unload)
1142 std::stringstream m;
1143 m << "__model" << _module_id++;
1146 const char *s = load ? load->getStringValue() : "";
1149 arg[0] = nasalSys->propNodeGhost(_root);
1150 arg[1] = nasalSys->propNodeGhost(prop);
1151 nasalSys->createModule(_module.c_str(), path.c_str(), s, strlen(s),
1155 FGNasalModelData::~FGNasalModelData()
1161 SG_LOG(SG_NASAL, SG_WARN, "Trying to run an <unload> script "
1162 "without Nasal subsystem present.");
1167 const char *s = _unload->getStringValue();
1168 nasalSys->createModule(_module.c_str(), _module.c_str(), s, strlen(s), _root);
1170 nasalSys->deleteModule(_module.c_str());
1175 // NasalXMLVisitor class: handles EasyXML visitor callback for parsexml()
1177 NasalXMLVisitor::NasalXMLVisitor(naContext c, int argc, naRef* args) :
1178 _c(naSubContext(c)),
1179 _start_element(argc > 1 ? args[1] : naNil()),
1180 _end_element(argc > 2 ? args[2] : naNil()),
1181 _data(argc > 3 ? args[3] : naNil()),
1182 _pi(argc > 4 ? args[4] : naNil())
1186 void NasalXMLVisitor::startElement(const char* tag, const XMLAttributes& a)
1188 if(naIsNil(_start_element)) return;
1189 naRef attr = naNewHash(_c);
1190 for(int i=0; i<a.size(); i++) {
1191 naRef name = make_string(a.getName(i));
1192 naRef value = make_string(a.getValue(i));
1193 naHash_set(attr, name, value);
1195 call(_start_element, 2, make_string(tag), attr);
1198 void NasalXMLVisitor::endElement(const char* tag)
1200 if(!naIsNil(_end_element)) call(_end_element, 1, make_string(tag));
1203 void NasalXMLVisitor::data(const char* str, int len)
1205 if(!naIsNil(_data)) call(_data, 1, make_string(str, len));
1208 void NasalXMLVisitor::pi(const char* target, const char* data)
1210 if(!naIsNil(_pi)) call(_pi, 2, make_string(target), make_string(data));
1213 void NasalXMLVisitor::call(naRef func, int num, naRef a, naRef b)
1218 naCall(_c, func, num, args, naNil(), naNil());
1223 naRef NasalXMLVisitor::make_string(const char* s, int n)
1225 return naStr_fromdata(naNewString(_c), const_cast<char *>(s),
1226 n < 0 ? strlen(s) : n);