7 # include <sys/time.h> // gettimeofday
12 #include <sys/types.h>
17 #include <simgear/nasal/nasal.h>
18 #include <simgear/props/props.hxx>
19 #include <simgear/math/sg_random.h>
20 #include <simgear/misc/sg_path.hxx>
21 #include <simgear/misc/sg_dir.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>
34 #include <Navaids/navlist.hxx>
35 #include <Navaids/procedure.hxx>
38 #include "NasalSys.hxx"
40 static FGNasalSys* nasalSys = 0;
42 // Listener class for loading Nasal modules on demand
43 class FGNasalModuleListener : public SGPropertyChangeListener
46 FGNasalModuleListener(SGPropertyNode* node);
48 virtual void valueChanged(SGPropertyNode* node);
51 SGPropertyNode_ptr _node;
54 FGNasalModuleListener::FGNasalModuleListener(SGPropertyNode* node) : _node(node)
58 void FGNasalModuleListener::valueChanged(SGPropertyNode*)
60 if (_node->getBoolValue("enabled",false)&&
61 !_node->getBoolValue("loaded",true))
63 nasalSys->loadPropertyScripts(_node);
68 // Read and return file contents in a single buffer. Note use of
69 // stat() to get the file size. This is a win32 function, believe it
70 // or not. :) Note the REALLY IMPORTANT use of the "b" flag to fopen.
71 // Text mode brain damage will kill us if we're trying to do bytewise
73 static char* readfile(const char* file, int* lenOut)
76 if(stat(file, &data) != 0) return 0;
77 FILE* f = fopen(file, "rb");
79 char* buf = new char[data.st_size];
80 *lenOut = fread(buf, 1, data.st_size, f);
82 if(*lenOut != data.st_size) {
83 // Shouldn't happen, but warn anyway since it represents a
84 // platform bug and not a typical runtime error (missing file,
86 SG_LOG(SG_NASAL, SG_ALERT,
87 "ERROR in Nasal initialization: " <<
88 "short count returned from fread() of " << file <<
89 ". Check your C library!");
96 FGNasalSys::FGNasalSys()
102 _nextGCKey = 0; // Any value will do
106 // Does a naCall() in a new context. Wrapped here to make lock
107 // tracking easier. Extension functions are called with the lock, but
108 // we have to release it before making a new naCall(). So rather than
109 // drop the lock in every extension function that might call back into
110 // Nasal, we keep a stack depth counter here and only unlock/lock
111 // around the naCall if it isn't the first one.
112 naRef FGNasalSys::call(naRef code, int argc, naRef* args, naRef locals)
114 naContext ctx = naNewContext();
115 if(_callCount) naModUnlock();
117 naRef result = naCall(ctx, code, argc, args, naNil(), locals);
121 if(_callCount) naModLock();
126 FGNasalSys::~FGNasalSys()
129 map<int, FGNasalListener *>::iterator it, end = _listener.end();
130 for(it = _listener.begin(); it != end; ++it)
133 naFreeContext(_context);
137 bool FGNasalSys::parseAndRun(const char* sourceCode)
139 naRef code = parse("FGNasalSys::parseAndRun()", sourceCode,
143 call(code, 0, 0, naNil());
147 FGNasalScript* FGNasalSys::parseScript(const char* src, const char* name)
149 FGNasalScript* script = new FGNasalScript();
150 script->_gcKey = -1; // important, if we delete it on a parse
151 script->_nas = this; // error, don't clobber a real handle!
155 sprintf(buf, "FGNasalScript@%p", (void *)script);
159 script->_code = parse(name, src, strlen(src));
160 if(naIsNil(script->_code)) {
165 script->_gcKey = gcSave(script->_code);
169 // Utility. Sets a named key in a hash by C string, rather than nasal
171 void FGNasalSys::hashset(naRef hash, const char* key, naRef val)
173 naRef s = naNewString(_context);
174 naStr_fromdata(s, (char*)key, strlen(key));
175 naHash_set(hash, s, val);
178 // The get/setprop functions accept a *list* of strings and walk
179 // through the property tree with them to find the appropriate node.
180 // This allows a Nasal object to hold onto a property path and use it
181 // like a node object, e.g. setprop(ObjRoot, "size-parsecs", 2.02). This
182 // is the utility function that walks the property tree.
183 // Future enhancement: support integer arguments to specify array
185 static SGPropertyNode* findnode(naContext c, naRef* vec, int len)
187 SGPropertyNode* p = globals->get_props();
189 for(int i=0; i<len; i++) {
191 if(!naIsString(a)) return 0;
192 p = p->getNode(naStr_data(a));
195 } catch (const string& err) {
196 naRuntimeError(c, (char *)err.c_str());
202 // getprop() extension function. Concatenates its string arguments as
203 // property names and returns the value of the specified property. Or
204 // nil if it doesn't exist.
205 static naRef f_getprop(naContext c, naRef me, int argc, naRef* args)
207 using namespace simgear;
208 const SGPropertyNode* p = findnode(c, args, argc);
209 if(!p) return naNil();
211 switch(p->getType()) {
212 case props::BOOL: case props::INT:
213 case props::LONG: case props::FLOAT:
216 double dv = p->getDoubleValue();
217 if (osg::isNaN(dv)) {
218 SG_LOG(SG_GENERAL, SG_ALERT, "Nasal getprop: property " << p->getPath() << " is NaN");
226 case props::UNSPECIFIED:
228 naRef nastr = naNewString(c);
229 const char* val = p->getStringValue();
230 naStr_fromdata(nastr, (char*)val, strlen(val));
233 case props::ALIAS: // <--- FIXME, recurse?
239 // setprop() extension function. Concatenates its string arguments as
240 // property names and sets the value of the specified property to the
242 static naRef f_setprop(naContext c, naRef me, int argc, naRef* args)
245 char buf[BUFLEN + 1];
249 if(argc < 2) naRuntimeError(c, "setprop() expects at least 2 arguments");
250 for(int i=0; i<argc-1; i++) {
251 naRef s = naStringValue(c, args[i]);
252 if(naIsNil(s)) return naNil();
253 strncpy(p, naStr_data(s), buflen);
255 buflen = BUFLEN - (p - buf);
256 if(i < (argc-2) && buflen > 0) {
262 SGPropertyNode* props = globals->get_props();
263 naRef val = args[argc-1];
266 if(naIsString(val)) result = props->setStringValue(buf, naStr_data(val));
268 naRef n = naNumValue(val);
270 naRuntimeError(c, "setprop() value is not string or number");
272 if (osg::isNaN(n.num)) {
273 naRuntimeError(c, "setprop() passed a NaN");
276 result = props->setDoubleValue(buf, n.num);
278 } catch (const string& err) {
279 naRuntimeError(c, (char *)err.c_str());
281 return naNum(result);
285 // print() extension function. Concatenates and prints its arguments
286 // to the FlightGear log. Uses the highest log level (SG_ALERT), to
287 // make sure it appears. Is there better way to do this?
288 static naRef f_print(naContext c, naRef me, int argc, naRef* args)
292 for(int i=0; i<n; i++) {
293 naRef s = naStringValue(c, args[i]);
294 if(naIsNil(s)) continue;
295 buf += naStr_data(s);
297 SG_LOG(SG_GENERAL, SG_ALERT, buf);
298 return naNum(buf.length());
301 // fgcommand() extension function. Executes a named command via the
302 // FlightGear command manager. Takes a single property node name as
304 static naRef f_fgcommand(naContext c, naRef me, int argc, naRef* args)
306 naRef cmd = argc > 0 ? args[0] : naNil();
307 naRef props = argc > 1 ? args[1] : naNil();
308 if(!naIsString(cmd) || (!naIsNil(props) && !naIsGhost(props)))
309 naRuntimeError(c, "bad arguments to fgcommand()");
310 SGPropertyNode_ptr tmp, *node;
312 node = (SGPropertyNode_ptr*)naGhost_ptr(props);
314 tmp = new SGPropertyNode();
317 return naNum(globals->get_commands()->execute(naStr_data(cmd), *node));
320 // settimer(func, dt, simtime) extension function. Falls through to
321 // FGNasalSys::setTimer(). See there for docs.
322 static naRef f_settimer(naContext c, naRef me, int argc, naRef* args)
324 nasalSys->setTimer(c, argc, args);
328 // setlistener(func, property, bool) extension function. Falls through to
329 // FGNasalSys::setListener(). See there for docs.
330 static naRef f_setlistener(naContext c, naRef me, int argc, naRef* args)
332 return nasalSys->setListener(c, argc, args);
335 // removelistener(int) extension function. Falls through to
336 // FGNasalSys::removeListener(). See there for docs.
337 static naRef f_removelistener(naContext c, naRef me, int argc, naRef* args)
339 return nasalSys->removeListener(c, argc, args);
342 // Returns a ghost handle to the argument to the currently executing
344 static naRef f_cmdarg(naContext c, naRef me, int argc, naRef* args)
346 return nasalSys->cmdArgGhost();
349 // Sets up a property interpolation. The first argument is either a
350 // ghost (SGPropertyNode_ptr*) or a string (global property path) to
351 // interpolate. The second argument is a vector of pairs of
352 // value/delta numbers.
353 static naRef f_interpolate(naContext c, naRef me, int argc, naRef* args)
355 SGPropertyNode* node;
356 naRef prop = argc > 0 ? args[0] : naNil();
357 if(naIsString(prop)) node = fgGetNode(naStr_data(prop), true);
358 else if(naIsGhost(prop)) node = *(SGPropertyNode_ptr*)naGhost_ptr(prop);
361 naRef curve = argc > 1 ? args[1] : naNil();
362 if(!naIsVector(curve)) return naNil();
363 int nPoints = naVec_size(curve) / 2;
364 double* values = new double[nPoints];
365 double* deltas = new double[nPoints];
366 for(int i=0; i<nPoints; i++) {
367 values[i] = naNumValue(naVec_get(curve, 2*i)).num;
368 deltas[i] = naNumValue(naVec_get(curve, 2*i+1)).num;
371 ((SGInterpolator*)globals->get_subsystem_mgr()
372 ->get_group(SGSubsystemMgr::INIT)->get_subsystem("interpolator"))
373 ->interpolate(node, nPoints, values, deltas);
380 // This is a better RNG than the one in the default Nasal distribution
381 // (which is based on the C library rand() implementation). It will
383 static naRef f_rand(naContext c, naRef me, int argc, naRef* args)
385 return naNum(sg_random());
388 static naRef f_srand(naContext c, naRef me, int argc, naRef* args)
394 static naRef f_abort(naContext c, naRef me, int argc, naRef* args)
400 // Return an array listing of all files in a directory
401 static naRef f_directory(naContext c, naRef me, int argc, naRef* args)
403 if(argc != 1 || !naIsString(args[0]))
404 naRuntimeError(c, "bad arguments to directory()");
406 simgear::Dir d(SGPath(naStr_data(args[0])));
407 if(!d.exists()) return naNil();
408 naRef result = naNewVector(c);
410 simgear::PathList paths = d.children(simgear::Dir::TYPE_FILE | simgear::Dir::TYPE_DIR);
411 for (unsigned int i=0; i<paths.size(); ++i) {
412 std::string p = paths[i].file();
413 naVec_append(result, naStr_fromdata(naNewString(c), p.c_str(), p.size()));
420 * Given a data path, resolve it in FG_ROOT or an FG_AIRCRFT directory
422 static naRef f_resolveDataPath(naContext c, naRef me, int argc, naRef* args)
424 if(argc != 1 || !naIsString(args[0]))
425 naRuntimeError(c, "bad arguments to resolveDataPath()");
427 SGPath p = globals->resolve_maybe_aircraft_path(naStr_data(args[0]));
428 const char* pdata = p.c_str();
429 return naStr_fromdata(naNewString(c), const_cast<char*>(pdata), strlen(pdata));
433 // parsexml(<path> [, <start-tag> [, <end-tag> [, <data> [, <pi>]]]]);
435 // <path> ... absolute path to an XML file
436 // <start-tag> ... callback function with two args: tag name, attribute hash
437 // <end-tag> ... callback function with one arg: tag name
438 // <data> ... callback function with one arg: data
439 // <pi> ... callback function with two args: target, data
440 // (pi = "processing instruction")
441 // All four callback functions are optional and default to nil.
442 // The function returns nil on error, or the validated file name otherwise.
443 static naRef f_parsexml(naContext c, naRef me, int argc, naRef* args)
445 if(argc < 1 || !naIsString(args[0]))
446 naRuntimeError(c, "parsexml(): path argument missing or not a string");
447 if(argc > 5) argc = 5;
448 for(int i=1; i<argc; i++)
449 if(!(naIsNil(args[i]) || naIsFunc(args[i])))
450 naRuntimeError(c, "parsexml(): callback argument not a function");
452 const char* file = fgValidatePath(naStr_data(args[0]), false);
454 naRuntimeError(c, "parsexml(): reading '%s' denied "
455 "(unauthorized access)", naStr_data(args[0]));
458 std::ifstream input(file);
459 NasalXMLVisitor visitor(c, argc, args);
461 readXML(input, visitor);
462 } catch (const sg_exception& e) {
463 naRuntimeError(c, "parsexml(): file '%s' %s",
464 file, e.getFormattedMessage().c_str());
467 return naStr_fromdata(naNewString(c), const_cast<char*>(file), strlen(file));
470 // Return UNIX epoch time in seconds.
471 static naRef f_systime(naContext c, naRef me, int argc, naRef* args)
475 GetSystemTimeAsFileTime(&ft);
476 double t = (4294967296.0 * ft.dwHighDateTime + ft.dwLowDateTime);
477 // Converts from 100ns units in 1601 epoch to unix epoch in sec
478 return naNum((t * 1e-7) - 11644473600.0);
481 gettimeofday(&td, 0);
482 return naNum(td.tv_sec + 1e-6 * td.tv_usec);
486 // Convert a cartesian point to a geodetic lat/lon/altitude.
487 static naRef f_carttogeod(naContext c, naRef me, int argc, naRef* args)
489 double lat, lon, alt, xyz[3];
490 if(argc != 3) naRuntimeError(c, "carttogeod() expects 3 arguments");
491 for(int i=0; i<3; i++)
492 xyz[i] = naNumValue(args[i]).num;
493 sgCartToGeod(xyz, &lat, &lon, &alt);
494 lat *= SG_RADIANS_TO_DEGREES;
495 lon *= SG_RADIANS_TO_DEGREES;
496 naRef vec = naNewVector(c);
497 naVec_append(vec, naNum(lat));
498 naVec_append(vec, naNum(lon));
499 naVec_append(vec, naNum(alt));
503 // Convert a geodetic lat/lon/altitude to a cartesian point.
504 static naRef f_geodtocart(naContext c, naRef me, int argc, naRef* args)
506 if(argc != 3) naRuntimeError(c, "geodtocart() expects 3 arguments");
507 double lat = naNumValue(args[0]).num * SG_DEGREES_TO_RADIANS;
508 double lon = naNumValue(args[1]).num * SG_DEGREES_TO_RADIANS;
509 double alt = naNumValue(args[2]).num;
511 sgGeodToCart(lat, lon, alt, xyz);
512 naRef vec = naNewVector(c);
513 naVec_append(vec, naNum(xyz[0]));
514 naVec_append(vec, naNum(xyz[1]));
515 naVec_append(vec, naNum(xyz[2]));
519 // For given geodetic point return array with elevation, and a material data
520 // hash, or nil if there's no information available (tile not loaded). If
521 // information about the material isn't available, then nil is returned instead
523 static naRef f_geodinfo(naContext c, naRef me, int argc, naRef* args)
525 #define HASHSET(s,l,n) naHash_set(matdata, naStr_fromdata(naNewString(c),s,l),n)
526 if(argc < 2 || argc > 3)
527 naRuntimeError(c, "geodinfo() expects 2 or 3 arguments: lat, lon [, maxalt]");
528 double lat = naNumValue(args[0]).num;
529 double lon = naNumValue(args[1]).num;
530 double elev = argc == 3 ? naNumValue(args[2]).num : 10000;
531 const SGMaterial *mat;
532 SGGeod geod = SGGeod::fromDegM(lon, lat, elev);
533 if(!globals->get_scenery()->get_elevation_m(geod, elev, &mat))
535 naRef vec = naNewVector(c);
536 naVec_append(vec, naNum(elev));
537 naRef matdata = naNil();
539 matdata = naNewHash(c);
540 naRef names = naNewVector(c);
541 const vector<string> n = mat->get_names();
542 for(unsigned int i=0; i<n.size(); i++)
543 naVec_append(names, naStr_fromdata(naNewString(c),
544 const_cast<char*>(n[i].c_str()), n[i].size()));
545 HASHSET("names", 5, names);
546 HASHSET("solid", 5, naNum(mat->get_solid()));
547 HASHSET("friction_factor", 15, naNum(mat->get_friction_factor()));
548 HASHSET("rolling_friction", 16, naNum(mat->get_rolling_friction()));
549 HASHSET("load_resistance", 15, naNum(mat->get_load_resistance()));
550 HASHSET("bumpiness", 9, naNum(mat->get_bumpiness()));
551 HASHSET("light_coverage", 14, naNum(mat->get_light_coverage()));
553 naVec_append(vec, matdata);
559 class AirportInfoFilter : public FGAirport::AirportFilter
562 AirportInfoFilter() : type(FGPositioned::AIRPORT) {
565 virtual FGPositioned::Type minType() const {
569 virtual FGPositioned::Type maxType() const {
573 FGPositioned::Type type;
576 // Returns data hash for particular or nearest airport of a <type>, or nil
579 // airportinfo(<id>); e.g. "KSFO"
580 // airportinfo(<type>); type := ("airport"|"seaport"|"heliport")
581 // airportinfo() same as airportinfo("airport")
582 // airportinfo(<lat>, <lon> [, <type>]);
583 static naRef f_airportinfo(naContext c, naRef me, int argc, naRef* args)
585 static SGConstPropertyNode_ptr latn = fgGetNode("/position/latitude-deg", true);
586 static SGConstPropertyNode_ptr lonn = fgGetNode("/position/longitude-deg", true);
588 FGAirport* apt = NULL;
590 if(argc >= 2 && naIsNum(args[0]) && naIsNum(args[1])) {
591 pos = SGGeod::fromDeg(args[1].num, args[0].num);
595 pos = SGGeod::fromDeg(lonn->getDoubleValue(), latn->getDoubleValue());
598 double maxRange = 10000.0; // expose this? or pick a smaller value?
600 AirportInfoFilter filter; // defaults to airports only
603 // fall through and use AIRPORT
604 } else if(argc == 1 && naIsString(args[0])) {
605 const char *s = naStr_data(args[0]);
606 if(!strcmp(s, "airport")) filter.type = FGPositioned::AIRPORT;
607 else if(!strcmp(s, "seaport")) filter.type = FGPositioned::SEAPORT;
608 else if(!strcmp(s, "heliport")) filter.type = FGPositioned::HELIPORT;
610 // user provided an <id>, hopefully
611 apt = FGAirport::findByIdent(s);
613 // return nil here, but don't raise a runtime error; this is a
614 // legitamate way to validate an ICAO code, for example in a
615 // dialog box or similar.
620 naRuntimeError(c, "airportinfo() with invalid function arguments");
625 apt = FGAirport::findClosest(pos, maxRange, &filter);
626 if(!apt) return naNil();
629 string id = apt->ident();
630 string name = apt->name();
633 naRef rwys = naNewHash(c);
634 for(unsigned int r=0; r<apt->numRunways(); ++r) {
635 FGRunway* rwy(apt->getRunwayByIndex(r));
637 naRef rwyid = naStr_fromdata(naNewString(c),
638 const_cast<char *>(rwy->ident().c_str()),
639 rwy->ident().length());
641 naRef rwydata = naNewHash(c);
642 #define HASHSET(s,l,n) naHash_set(rwydata, naStr_fromdata(naNewString(c),s,l),n)
643 HASHSET("id", 2, rwyid);
644 HASHSET("lat", 3, naNum(rwy->latitude()));
645 HASHSET("lon", 3, naNum(rwy->longitude()));
646 HASHSET("heading", 7, naNum(rwy->headingDeg()));
647 HASHSET("length", 6, naNum(rwy->lengthM()));
648 HASHSET("width", 5, naNum(rwy->widthM()));
649 HASHSET("threshold", 9, naNum(rwy->displacedThresholdM()));
650 HASHSET("stopway", 7, naNum(rwy->stopwayM()));
653 HASHSET("ils_frequency_mhz", 17, naNum(rwy->ILS()->get_freq() / 100.0));
656 std::vector<flightgear::SID*> sids(rwy->getSIDs());
657 naRef sidVec = naNewVector(c);
659 for (unsigned int s=0; s < sids.size(); ++s) {
660 naRef procId = naStr_fromdata(naNewString(c),
661 const_cast<char *>(sids[s]->ident().c_str()),
662 sids[s]->ident().length());
663 naVec_append(sidVec, procId);
665 HASHSET("sids", 4, sidVec);
667 std::vector<flightgear::STAR*> stars(rwy->getSTARs());
668 naRef starVec = naNewVector(c);
670 for (unsigned int s=0; s < stars.size(); ++s) {
671 naRef procId = naStr_fromdata(naNewString(c),
672 const_cast<char *>(stars[s]->ident().c_str()),
673 stars[s]->ident().length());
674 naVec_append(starVec, procId);
676 HASHSET("stars", 5, starVec);
679 naHash_set(rwys, rwyid, rwydata);
683 naRef aptdata = naNewHash(c);
684 #define HASHSET(s,l,n) naHash_set(aptdata, naStr_fromdata(naNewString(c),s,l),n)
685 HASHSET("id", 2, naStr_fromdata(naNewString(c),
686 const_cast<char *>(id.c_str()), id.length()));
687 HASHSET("name", 4, naStr_fromdata(naNewString(c),
688 const_cast<char *>(name.c_str()), name.length()));
689 HASHSET("lat", 3, naNum(apt->getLatitude()));
690 HASHSET("lon", 3, naNum(apt->getLongitude()));
691 HASHSET("elevation", 9, naNum(apt->getElevation() * SG_FEET_TO_METER));
692 HASHSET("has_metar", 9, naNum(apt->getMetar()));
693 HASHSET("runways", 7, rwys);
699 // Returns vector of data hash for navaid of a <type>, nil on error
700 // navaids sorted by ascending distance
701 // navinfo([<lat>,<lon>],[<type>],[<id>])
702 // lat/lon (numeric): use latitude/longitude instead of ac position
703 // type: ("fix"|"vor"|"ndb"|"ils"|"dme"|"tacan"|"any")
704 // id: (partial) id of the fix
706 // navinfo("vor") returns all vors
707 // navinfo("HAM") return all navaids who's name start with "HAM"
708 // navinfo("vor", "HAM") return all vor who's name start with "HAM"
709 //navinfo(34,48,"vor","HAM") return all vor who's name start with "HAM"
710 // sorted by distance relative to lat=34, lon=48
711 static naRef f_navinfo(naContext c, naRef me, int argc, naRef* args)
713 static SGConstPropertyNode_ptr latn = fgGetNode("/position/latitude-deg", true);
714 static SGConstPropertyNode_ptr lonn = fgGetNode("/position/longitude-deg", true);
717 if(argc >= 2 && naIsNum(args[0]) && naIsNum(args[1])) {
718 pos = SGGeod::fromDeg(args[1].num, args[0].num);
722 pos = SGGeod::fromDeg(lonn->getDoubleValue(), latn->getDoubleValue());
725 FGPositioned::Type type = FGPositioned::INVALID;
726 nav_list_type navlist;
727 const char * id = "";
729 if(argc > 0 && naIsString(args[0])) {
730 const char *s = naStr_data(args[0]);
731 if(!strcmp(s, "any")) type = FGPositioned::INVALID;
732 else if(!strcmp(s, "fix")) type = FGPositioned::FIX;
733 else if(!strcmp(s, "vor")) type = FGPositioned::VOR;
734 else if(!strcmp(s, "ndb")) type = FGPositioned::NDB;
735 else if(!strcmp(s, "ils")) type = FGPositioned::ILS;
736 else if(!strcmp(s, "dme")) type = FGPositioned::DME;
737 else if(!strcmp(s, "tacan")) type = FGPositioned::TACAN;
738 else id = s; // this is an id
743 if(argc > 0 && naIsString(args[0])) {
745 naRuntimeError(c, "navinfo() called with navaid id");
748 id = naStr_data(args[0]);
754 naRuntimeError(c, "navinfo() called with too many arguments");
758 navlist = globals->get_navlist()->findByIdentAndFreq( pos, id, 0.0, type );
760 naRef reply = naNewVector(c);
761 for( nav_list_type::const_iterator it = navlist.begin(); it != navlist.end(); ++it ) {
762 const FGNavRecord * nav = *it;
765 naRef navdata = naNewHash(c);
766 #define HASHSET(s,l,n) naHash_set(navdata, naStr_fromdata(naNewString(c),s,l),n)
767 HASHSET("id", 2, naStr_fromdata(naNewString(c),
768 const_cast<char *>(nav->ident().c_str()), nav->ident().length()));
769 HASHSET("name", 4, naStr_fromdata(naNewString(c),
770 const_cast<char *>(nav->name().c_str()), nav->name().length()));
771 HASHSET("frequency", 9, naNum(nav->get_freq()));
772 HASHSET("lat", 3, naNum(nav->get_lat()));
773 HASHSET("lon", 3, naNum(nav->get_lon()));
774 HASHSET("elevation", 9, naNum(nav->get_elev_ft() * SG_FEET_TO_METER));
775 HASHSET("type", 4, naStr_fromdata(naNewString(c),
776 const_cast<char *>(nav->nameForType(nav->type())), strlen(nav->nameForType(nav->type()))));
777 HASHSET("distance", 8, naNum(SGGeodesy::distanceNm( pos, nav->geod() ) * SG_NM_TO_METER ) );
778 HASHSET("bearing", 7, naNum(SGGeodesy::courseDeg( pos, nav->geod() ) ) );
780 naVec_append( reply, navdata );
785 // Table of extension functions. Terminate with zeros.
786 static struct { const char* name; naCFunction func; } funcs[] = {
787 { "getprop", f_getprop },
788 { "setprop", f_setprop },
789 { "print", f_print },
790 { "_fgcommand", f_fgcommand },
791 { "settimer", f_settimer },
792 { "_setlistener", f_setlistener },
793 { "removelistener", f_removelistener },
794 { "_cmdarg", f_cmdarg },
795 { "_interpolate", f_interpolate },
797 { "srand", f_srand },
798 { "abort", f_abort },
799 { "directory", f_directory },
800 { "resolvepath", f_resolveDataPath },
801 { "parsexml", f_parsexml },
802 { "systime", f_systime },
803 { "carttogeod", f_carttogeod },
804 { "geodtocart", f_geodtocart },
805 { "geodinfo", f_geodinfo },
806 { "airportinfo", f_airportinfo },
807 { "navinfo", f_navinfo },
811 naRef FGNasalSys::cmdArgGhost()
813 return propNodeGhost(_cmdArg);
816 void FGNasalSys::init()
820 _context = naNewContext();
822 // Start with globals. Add it to itself as a recursive
823 // sub-reference under the name "globals". This gives client-code
824 // write access to the namespace if someone wants to do something
826 _globals = naInit_std(_context);
827 naSave(_context, _globals);
828 hashset(_globals, "globals", _globals);
830 hashset(_globals, "math", naInit_math(_context));
831 hashset(_globals, "bits", naInit_bits(_context));
832 hashset(_globals, "io", naInit_io(_context));
833 hashset(_globals, "thread", naInit_thread(_context));
834 hashset(_globals, "utf8", naInit_utf8(_context));
836 // Add our custom extension functions:
837 for(i=0; funcs[i].name; i++)
838 hashset(_globals, funcs[i].name,
839 naNewFunc(_context, naNewCCode(_context, funcs[i].func)));
841 // And our SGPropertyNode wrapper
842 hashset(_globals, "props", genPropsModule());
844 // Make a "__gcsave" hash to hold the naRef objects which get
845 // passed to handles outside the interpreter (to protect them from
846 // begin garbage-collected).
847 _gcHash = naNewHash(_context);
848 hashset(_globals, "__gcsave", _gcHash);
850 // Now load the various source files in the Nasal directory
851 simgear::Dir nasalDir(SGPath(globals->get_fg_root(), "Nasal"));
852 loadScriptDirectory(nasalDir);
854 // Add modules in Nasal subdirectories to property tree
855 simgear::PathList directories = nasalDir.children(simgear::Dir::TYPE_DIR+
856 simgear::Dir::NO_DOT_OR_DOTDOT, "");
857 for (unsigned int i=0; i<directories.size(); ++i) {
858 simgear::Dir dir(directories[i]);
859 simgear::PathList scripts = dir.children(simgear::Dir::TYPE_FILE, ".nas");
860 addModule(directories[i].file(), scripts);
863 // set signal and remove node to avoid restoring at reinit
864 const char *s = "nasal-dir-initialized";
865 SGPropertyNode *signal = fgGetNode("/sim/signals", true);
866 signal->setBoolValue(s, true);
867 signal->removeChildren(s, false);
869 // Pull scripts out of the property tree, too
870 loadPropertyScripts();
873 void FGNasalSys::update(double)
875 if(!_dead_listener.empty()) {
876 vector<FGNasalListener *>::iterator it, end = _dead_listener.end();
877 for(it = _dead_listener.begin(); it != end; ++it) delete *it;
878 _dead_listener.clear();
881 // The global context is a legacy thing. We use dynamically
882 // created contexts for naCall() now, so that we can call them
883 // recursively. But there are still spots that want to use it for
884 // naNew*() calls, which end up leaking memory because the context
885 // only clears out its temporary vector when it's *used*. So just
886 // junk it and fetch a new/reinitialized one every frame. This is
887 // clumsy: the right solution would use the dynamic context in all
888 // cases and eliminate _context entirely. But that's more work,
889 // and this works fine (yes, they say "New" and "Free", but
890 // they're very fast, just trust me). -Andy
891 naFreeContext(_context);
892 _context = naNewContext();
895 bool pathSortPredicate(const SGPath& p1, const SGPath& p2)
897 return p1.file() < p2.file();
900 // Loads all scripts in given directory
901 void FGNasalSys::loadScriptDirectory(simgear::Dir nasalDir)
903 simgear::PathList scripts = nasalDir.children(simgear::Dir::TYPE_FILE, ".nas");
904 // sort scripts, avoid loading sequence effects due to file system's
905 // random directory order
906 std::sort(scripts.begin(), scripts.end(), pathSortPredicate);
908 for (unsigned int i=0; i<scripts.size(); ++i) {
909 SGPath fullpath(scripts[i]);
910 SGPath file = fullpath.file();
911 loadModule(fullpath, file.base().c_str());
915 // Create module with list of scripts
916 void FGNasalSys::addModule(string moduleName, simgear::PathList scripts)
918 if (scripts.size()>0)
920 SGPropertyNode* nasal = globals->get_props()->getNode("nasal");
921 SGPropertyNode* module_node = nasal->getChild(moduleName,0,true);
922 for (unsigned int i=0; i<scripts.size(); ++i) {
923 SGPropertyNode* pFileNode = module_node->getChild("file",i,true);
924 pFileNode->setStringValue(scripts[i].c_str());
926 if (!module_node->hasChild("enabled",0))
928 SGPropertyNode* node = module_node->getChild("enabled",0,true);
929 node->setBoolValue(true);
930 node->setAttribute(SGPropertyNode::USERARCHIVE,true);
935 // Loads the scripts found under /nasal in the global tree
936 void FGNasalSys::loadPropertyScripts()
938 SGPropertyNode* nasal = globals->get_props()->getNode("nasal");
941 for(int i=0; i<nasal->nChildren(); i++)
943 SGPropertyNode* n = nasal->getChild(i);
944 loadPropertyScripts(n);
948 // Loads the scripts found under /nasal in the global tree
949 void FGNasalSys::loadPropertyScripts(SGPropertyNode* n)
951 bool is_loaded = false;
953 const char* module = n->getName();
954 if(n->hasChild("module"))
955 module = n->getStringValue("module");
956 if (n->getBoolValue("enabled",true))
958 // allow multiple files to be specified within a single
962 bool file_specified = false;
964 while((fn = n->getChild("file", j)) != NULL) {
965 file_specified = true;
966 const char* file = fn->getStringValue();
968 if (!p.isAbsolute() || !p.exists())
970 p = globals->resolve_maybe_aircraft_path(file);
973 SG_LOG(SG_NASAL, SG_ALERT, "Cannot find Nasal script '" <<
974 file << "' for module '" << module << "'.");
977 ok &= p.isNull() ? false : loadModule(p, module);
981 const char* src = n->getStringValue("script");
982 if(!n->hasChild("script")) src = 0; // Hrm...
984 createModule(module, n->getPath().c_str(), src, strlen(src));
986 if(!file_specified && !src)
988 // module no longer exists - clear the archived "enable" flag
989 n->setAttribute(SGPropertyNode::USERARCHIVE,false);
990 SGPropertyNode* node = n->getChild("enabled",0,false);
992 node->setAttribute(SGPropertyNode::USERARCHIVE,false);
994 SG_LOG(SG_NASAL, SG_ALERT, "Nasal error: " <<
995 "no <file> or <script> defined in " <<
996 "/nasal/" << module);
1003 SGPropertyNode* enable = n->getChild("enabled");
1006 FGNasalModuleListener* listener = new FGNasalModuleListener(n);
1007 enable->addChangeListener(listener, false);
1010 SGPropertyNode* loaded = n->getChild("loaded",0,true);
1011 loaded->setAttribute(SGPropertyNode::PRESERVE,true);
1012 loaded->setBoolValue(is_loaded);
1015 // Logs a runtime error, with stack trace, to the FlightGear log stream
1016 void FGNasalSys::logError(naContext context)
1018 SG_LOG(SG_NASAL, SG_ALERT,
1019 "Nasal runtime error: " << naGetError(context));
1020 SG_LOG(SG_NASAL, SG_ALERT,
1021 " at " << naStr_data(naGetSourceFile(context, 0)) <<
1022 ", line " << naGetLine(context, 0));
1023 for(int i=1; i<naStackDepth(context); i++)
1024 SG_LOG(SG_NASAL, SG_ALERT,
1025 " called from: " << naStr_data(naGetSourceFile(context, i)) <<
1026 ", line " << naGetLine(context, i));
1029 // Reads a script file, executes it, and places the resulting
1030 // namespace into the global namespace under the specified module
1032 bool FGNasalSys::loadModule(SGPath file, const char* module)
1035 char* buf = readfile(file.c_str(), &len);
1037 SG_LOG(SG_NASAL, SG_ALERT,
1038 "Nasal error: could not read script file " << file.c_str()
1039 << " into module " << module);
1043 bool ok = createModule(module, file.c_str(), buf, len);
1048 // Parse and run. Save the local variables namespace, as it will
1049 // become a sub-object of globals. The optional "arg" argument can be
1050 // used to pass an associated property node to the module, which can then
1051 // be accessed via cmdarg(). (This is, for example, used by XML dialogs.)
1052 bool FGNasalSys::createModule(const char* moduleName, const char* fileName,
1053 const char* src, int len,
1054 const SGPropertyNode* cmdarg,
1055 int argc, naRef* args)
1057 naRef code = parse(fileName, src, len);
1061 // See if we already have a module hash to use. This allows the
1062 // user to, for example, add functions to the built-in math
1063 // module. Make a new one if necessary.
1065 naRef modname = naNewString(_context);
1066 naStr_fromdata(modname, (char*)moduleName, strlen(moduleName));
1067 if(!naHash_get(_globals, modname, &locals))
1068 locals = naNewHash(_context);
1070 _cmdArg = (SGPropertyNode*)cmdarg;
1072 call(code, argc, args, locals);
1073 hashset(_globals, moduleName, locals);
1077 void FGNasalSys::deleteModule(const char* moduleName)
1079 naRef modname = naNewString(_context);
1080 naStr_fromdata(modname, (char*)moduleName, strlen(moduleName));
1081 naHash_delete(_globals, modname);
1084 naRef FGNasalSys::parse(const char* filename, const char* buf, int len)
1087 naRef srcfile = naNewString(_context);
1088 naStr_fromdata(srcfile, (char*)filename, strlen(filename));
1089 naRef code = naParseCode(_context, srcfile, 1, (char*)buf, len, &errLine);
1091 SG_LOG(SG_NASAL, SG_ALERT,
1092 "Nasal parse error: " << naGetError(_context) <<
1093 " in "<< filename <<", line " << errLine);
1097 // Bind to the global namespace before returning
1098 return naBindFunction(_context, code, _globals);
1101 bool FGNasalSys::handleCommand(const SGPropertyNode* arg)
1103 const char* nasal = arg->getStringValue("script");
1104 const char* moduleName = arg->getStringValue("module");
1105 naRef code = parse(arg->getPath(true).c_str(), nasal, strlen(nasal));
1106 if(naIsNil(code)) return false;
1108 // Commands can be run "in" a module. Make sure that module
1109 // exists, and set it up as the local variables hash for the
1111 naRef locals = naNil();
1113 naRef modname = naNewString(_context);
1114 naStr_fromdata(modname, (char*)moduleName, strlen(moduleName));
1115 if(!naHash_get(_globals, modname, &locals)) {
1116 locals = naNewHash(_context);
1117 naHash_set(_globals, modname, locals);
1121 // Cache this command's argument for inspection via cmdarg(). For
1122 // performance reasons, we won't bother with it if the invoked
1123 // code doesn't need it.
1124 _cmdArg = (SGPropertyNode*)arg;
1126 call(code, 0, 0, locals);
1130 // settimer(func, dt, simtime) extension function. The first argument
1131 // is a Nasal function to call, the second is a delta time (from now),
1132 // in seconds. The third, if present, is a boolean value indicating
1133 // that "real world" time (rather than simulator time) is to be used.
1135 // Implementation note: the FGTimer objects don't live inside the
1136 // garbage collector, so the Nasal handler functions have to be
1137 // "saved" somehow lest they be inadvertently cleaned. In this case,
1138 // they are inserted into a globals.__gcsave hash and removed on
1140 void FGNasalSys::setTimer(naContext c, int argc, naRef* args)
1142 // Extract the handler, delta, and simtime arguments:
1143 naRef handler = argc > 0 ? args[0] : naNil();
1144 if(!(naIsCode(handler) || naIsCCode(handler) || naIsFunc(handler))) {
1145 naRuntimeError(c, "settimer() with invalid function argument");
1149 naRef delta = argc > 1 ? args[1] : naNil();
1150 if(naIsNil(delta)) {
1151 naRuntimeError(c, "settimer() with invalid time argument");
1155 bool simtime = (argc > 2 && naTrue(args[2])) ? false : true;
1157 // Generate and register a C++ timer handler
1158 NasalTimer* t = new NasalTimer;
1159 t->handler = handler;
1160 t->gcKey = gcSave(handler);
1163 globals->get_event_mgr()->addEvent("NasalTimer",
1164 t, &NasalTimer::timerExpired,
1165 delta.num, simtime);
1168 void FGNasalSys::handleTimer(NasalTimer* t)
1170 call(t->handler, 0, 0, naNil());
1171 gcRelease(t->gcKey);
1174 int FGNasalSys::gcSave(naRef r)
1176 int key = _nextGCKey++;
1177 naHash_set(_gcHash, naNum(key), r);
1181 void FGNasalSys::gcRelease(int key)
1183 naHash_delete(_gcHash, naNum(key));
1186 void FGNasalSys::NasalTimer::timerExpired()
1188 nasal->handleTimer(this);
1192 int FGNasalSys::_listenerId = 0;
1194 // setlistener(<property>, <func> [, <initial=0> [, <persistent=1>]])
1195 // Attaches a callback function to a property (specified as a global
1196 // property path string or a SGPropertyNode_ptr* ghost). If the third,
1197 // optional argument (default=0) is set to 1, then the function is also
1198 // called initially. If the fourth, optional argument is set to 0, then the
1199 // function is only called when the property node value actually changes.
1200 // Otherwise it's called independent of the value whenever the node is
1201 // written to (default). The setlistener() function returns a unique
1202 // id number, which is to be used as argument to the removelistener()
1204 naRef FGNasalSys::setListener(naContext c, int argc, naRef* args)
1206 SGPropertyNode_ptr node;
1207 naRef prop = argc > 0 ? args[0] : naNil();
1208 if(naIsString(prop)) node = fgGetNode(naStr_data(prop), true);
1209 else if(naIsGhost(prop)) node = *(SGPropertyNode_ptr*)naGhost_ptr(prop);
1211 naRuntimeError(c, "setlistener() with invalid property argument");
1216 SG_LOG(SG_NASAL, SG_DEBUG, "Attaching listener to tied property " <<
1219 naRef code = argc > 1 ? args[1] : naNil();
1220 if(!(naIsCode(code) || naIsCCode(code) || naIsFunc(code))) {
1221 naRuntimeError(c, "setlistener() with invalid function argument");
1225 int init = argc > 2 && naIsNum(args[2]) ? int(args[2].num) : 0;
1226 int type = argc > 3 && naIsNum(args[3]) ? int(args[3].num) : 1;
1227 FGNasalListener *nl = new FGNasalListener(node, code, this,
1228 gcSave(code), _listenerId, init, type);
1230 node->addChangeListener(nl, init != 0);
1232 _listener[_listenerId] = nl;
1233 return naNum(_listenerId++);
1236 // removelistener(int) extension function. The argument is the id of
1237 // a listener as returned by the setlistener() function.
1238 naRef FGNasalSys::removeListener(naContext c, int argc, naRef* args)
1240 naRef id = argc > 0 ? args[0] : naNil();
1241 map<int, FGNasalListener *>::iterator it = _listener.find(int(id.num));
1243 if(!naIsNum(id) || it == _listener.end() || it->second->_dead) {
1244 naRuntimeError(c, "removelistener() with invalid listener id");
1248 it->second->_dead = true;
1249 _dead_listener.push_back(it->second);
1250 _listener.erase(it);
1251 return naNum(_listener.size());
1256 // FGNasalListener class.
1258 FGNasalListener::FGNasalListener(SGPropertyNode *node, naRef code,
1259 FGNasalSys* nasal, int key, int id,
1260 int init, int type) :
1273 if(_type == 0 && !_init)
1277 FGNasalListener::~FGNasalListener()
1279 _node->removeChangeListener(this);
1280 _nas->gcRelease(_gcKey);
1283 void FGNasalListener::call(SGPropertyNode* which, naRef mode)
1285 if(_active || _dead) return;
1286 SG_LOG(SG_NASAL, SG_DEBUG, "trigger listener #" << _id);
1289 arg[0] = _nas->propNodeGhost(which);
1290 arg[1] = _nas->propNodeGhost(_node);
1291 arg[2] = mode; // value changed, child added/removed
1292 arg[3] = naNum(_node != which); // child event?
1293 _nas->call(_code, 4, arg, naNil());
1297 void FGNasalListener::valueChanged(SGPropertyNode* node)
1299 if(_type < 2 && node != _node) return; // skip child events
1300 if(_type > 0 || changed(_node) || _init)
1301 call(node, naNum(0));
1306 void FGNasalListener::childAdded(SGPropertyNode*, SGPropertyNode* child)
1308 if(_type == 2) call(child, naNum(1));
1311 void FGNasalListener::childRemoved(SGPropertyNode*, SGPropertyNode* child)
1313 if(_type == 2) call(child, naNum(-1));
1316 bool FGNasalListener::changed(SGPropertyNode* node)
1318 using namespace simgear;
1319 props::Type type = node->getType();
1320 if(type == props::NONE) return false;
1321 if(type == props::UNSPECIFIED) return true;
1329 long l = node->getLongValue();
1330 result = l != _last_int;
1337 double d = node->getDoubleValue();
1338 result = d != _last_float;
1344 string s = node->getStringValue();
1345 result = s != _last_string;
1354 // FGNasalModelData class. If sgLoad3DModel() is called with a pointer to
1355 // such a class, then it lets modelLoaded() run the <load> script, and the
1356 // destructor the <unload> script. The latter happens when the model branch
1357 // is removed from the scene graph.
1359 unsigned int FGNasalModelData::_module_id = 0;
1361 void FGNasalModelData::modelLoaded(const string& path, SGPropertyNode *prop,
1366 SGPropertyNode *nasal = prop->getNode("nasal");
1370 SGPropertyNode *load = nasal->getNode("load");
1371 _unload = nasal->getNode("unload");
1372 if(!load && !_unload)
1375 std::stringstream m;
1376 m << "__model" << _module_id++;
1379 const char *s = load ? load->getStringValue() : "";
1382 arg[0] = nasalSys->propNodeGhost(_root);
1383 arg[1] = nasalSys->propNodeGhost(prop);
1384 nasalSys->createModule(_module.c_str(), path.c_str(), s, strlen(s),
1388 FGNasalModelData::~FGNasalModelData()
1394 SG_LOG(SG_NASAL, SG_WARN, "Trying to run an <unload> script "
1395 "without Nasal subsystem present.");
1400 const char *s = _unload->getStringValue();
1401 nasalSys->createModule(_module.c_str(), _module.c_str(), s, strlen(s), _root);
1403 nasalSys->deleteModule(_module.c_str());
1408 // NasalXMLVisitor class: handles EasyXML visitor callback for parsexml()
1410 NasalXMLVisitor::NasalXMLVisitor(naContext c, int argc, naRef* args) :
1411 _c(naSubContext(c)),
1412 _start_element(argc > 1 ? args[1] : naNil()),
1413 _end_element(argc > 2 ? args[2] : naNil()),
1414 _data(argc > 3 ? args[3] : naNil()),
1415 _pi(argc > 4 ? args[4] : naNil())
1419 void NasalXMLVisitor::startElement(const char* tag, const XMLAttributes& a)
1421 if(naIsNil(_start_element)) return;
1422 naRef attr = naNewHash(_c);
1423 for(int i=0; i<a.size(); i++) {
1424 naRef name = make_string(a.getName(i));
1425 naRef value = make_string(a.getValue(i));
1426 naHash_set(attr, name, value);
1428 call(_start_element, 2, make_string(tag), attr);
1431 void NasalXMLVisitor::endElement(const char* tag)
1433 if(!naIsNil(_end_element)) call(_end_element, 1, make_string(tag));
1436 void NasalXMLVisitor::data(const char* str, int len)
1438 if(!naIsNil(_data)) call(_data, 1, make_string(str, len));
1441 void NasalXMLVisitor::pi(const char* target, const char* data)
1443 if(!naIsNil(_pi)) call(_pi, 2, make_string(target), make_string(data));
1446 void NasalXMLVisitor::call(naRef func, int num, naRef a, naRef b)
1451 naCall(_c, func, num, args, naNil(), naNil());
1456 naRef NasalXMLVisitor::make_string(const char* s, int n)
1458 return naStr_fromdata(naNewString(_c), const_cast<char *>(s),
1459 n < 0 ? strlen(s) : n);