#ifdef HAVE_CONFIG_H # include "config.h" #endif #ifdef HAVE_SYS_TIME_H # include // gettimeofday #endif #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include
#include
#include
#include #include "NasalSys.hxx" static FGNasalSys* nasalSys = 0; // Read and return file contents in a single buffer. Note use of // stat() to get the file size. This is a win32 function, believe it // or not. :) Note the REALLY IMPORTANT use of the "b" flag to fopen. // Text mode brain damage will kill us if we're trying to do bytewise // I/O. static char* readfile(const char* file, int* lenOut) { struct stat data; if(stat(file, &data) != 0) return 0; FILE* f = fopen(file, "rb"); if(!f) return 0; char* buf = new char[data.st_size]; *lenOut = fread(buf, 1, data.st_size, f); fclose(f); if(*lenOut != data.st_size) { // Shouldn't happen, but warn anyway since it represents a // platform bug and not a typical runtime error (missing file, // etc...) SG_LOG(SG_NASAL, SG_ALERT, "ERROR in Nasal initialization: " << "short count returned from fread() of " << file << ". Check your C library!"); delete[] buf; return 0; } return buf; } FGNasalSys::FGNasalSys() { nasalSys = this; _context = 0; _globals = naNil(); _gcHash = naNil(); _nextGCKey = 0; // Any value will do _callCount = 0; } // Does a naCall() in a new context. Wrapped here to make lock // tracking easier. Extension functions are called with the lock, but // we have to release it before making a new naCall(). So rather than // drop the lock in every extension function that might call back into // Nasal, we keep a stack depth counter here and only unlock/lock // around the naCall if it isn't the first one. naRef FGNasalSys::call(naRef code, int argc, naRef* args, naRef locals) { naContext ctx = naNewContext(); if(_callCount) naModUnlock(); _callCount++; naRef result = naCall(ctx, code, argc, args, naNil(), locals); if(naGetError(ctx)) logError(ctx); _callCount--; if(_callCount) naModLock(); naFreeContext(ctx); return result; } FGNasalSys::~FGNasalSys() { nasalSys = 0; map::iterator it, end = _listener.end(); for(it = _listener.begin(); it != end; ++it) delete it->second; naFreeContext(_context); _globals = naNil(); } bool FGNasalSys::parseAndRun(const char* sourceCode) { naRef code = parse("FGNasalSys::parseAndRun()", sourceCode, strlen(sourceCode)); if(naIsNil(code)) return false; call(code, 0, 0, naNil()); return true; } FGNasalScript* FGNasalSys::parseScript(const char* src, const char* name) { FGNasalScript* script = new FGNasalScript(); script->_gcKey = -1; // important, if we delete it on a parse script->_nas = this; // error, don't clobber a real handle! char buf[256]; if(!name) { sprintf(buf, "FGNasalScript@%p", (void *)script); name = buf; } script->_code = parse(name, src, strlen(src)); if(naIsNil(script->_code)) { delete script; return 0; } script->_gcKey = gcSave(script->_code); return script; } // Utility. Sets a named key in a hash by C string, rather than nasal // string object. void FGNasalSys::hashset(naRef hash, const char* key, naRef val) { naRef s = naNewString(_context); naStr_fromdata(s, (char*)key, strlen(key)); naHash_set(hash, s, val); } // The get/setprop functions accept a *list* of strings and walk // through the property tree with them to find the appropriate node. // This allows a Nasal object to hold onto a property path and use it // like a node object, e.g. setprop(ObjRoot, "size-parsecs", 2.02). This // is the utility function that walks the property tree. // Future enhancement: support integer arguments to specify array // elements. static SGPropertyNode* findnode(naContext c, naRef* vec, int len) { SGPropertyNode* p = globals->get_props(); try { for(int i=0; igetNode(naStr_data(a)); if(p == 0) return 0; } } catch (const string& err) { naRuntimeError(c, (char *)err.c_str()); return 0; } return p; } // getprop() extension function. Concatenates its string arguments as // property names and returns the value of the specified property. Or // nil if it doesn't exist. static naRef f_getprop(naContext c, naRef me, int argc, naRef* args) { const SGPropertyNode* p = findnode(c, args, argc); if(!p) return naNil(); switch(p->getType()) { case SGPropertyNode::BOOL: case SGPropertyNode::INT: case SGPropertyNode::LONG: case SGPropertyNode::FLOAT: case SGPropertyNode::DOUBLE: return naNum(p->getDoubleValue()); case SGPropertyNode::STRING: case SGPropertyNode::UNSPECIFIED: { naRef nastr = naNewString(c); const char* val = p->getStringValue(); naStr_fromdata(nastr, (char*)val, strlen(val)); return nastr; } case SGPropertyNode::ALIAS: // <--- FIXME, recurse? default: return naNil(); } } // setprop() extension function. Concatenates its string arguments as // property names and sets the value of the specified property to the // final argument. static naRef f_setprop(naContext c, naRef me, int argc, naRef* args) { #define BUFLEN 1024 char buf[BUFLEN + 1]; buf[BUFLEN] = 0; char* p = buf; int buflen = BUFLEN; for(int i=0; i 0) { *p++ = '/'; buflen--; } } SGPropertyNode* props = globals->get_props(); naRef val = args[argc-1]; try { bool r; if(naIsString(val)) r = props->setStringValue(buf, naStr_data(val)); else { naRef n = naNumValue(val); if(naIsNil(n)) naRuntimeError(c, "setprop() value is not string or number"); r = props->setDoubleValue(buf, n.num); } if(!r) naRuntimeError(c, "setprop(): property is not writable"); } catch (const string& err) { naRuntimeError(c, (char *)err.c_str()); } return naNil(); #undef BUFLEN } // print() extension function. Concatenates and prints its arguments // to the FlightGear log. Uses the highest log level (SG_ALERT), to // make sure it appears. Is there better way to do this? static naRef f_print(naContext c, naRef me, int argc, naRef* args) { string buf; int n = argc; for(int i=0; i 0 ? args[0] : naNil(); naRef props = argc > 1 ? args[1] : naNil(); if(!naIsString(cmd) || (!naIsNil(props) && !naIsGhost(props))) naRuntimeError(c, "bad arguments to fgcommand()"); SGPropertyNode_ptr tmp, *node; if(!naIsNil(props)) node = (SGPropertyNode_ptr*)naGhost_ptr(props); else { tmp = new SGPropertyNode(); node = &tmp; } return naNum(globals->get_commands()->execute(naStr_data(cmd), *node)); } // settimer(func, dt, simtime) extension function. Falls through to // FGNasalSys::setTimer(). See there for docs. static naRef f_settimer(naContext c, naRef me, int argc, naRef* args) { nasalSys->setTimer(c, argc, args); return naNil(); } // setlistener(func, property, bool) extension function. Falls through to // FGNasalSys::setListener(). See there for docs. static naRef f_setlistener(naContext c, naRef me, int argc, naRef* args) { return nasalSys->setListener(c, argc, args); } // removelistener(int) extension function. Falls through to // FGNasalSys::removeListener(). See there for docs. static naRef f_removelistener(naContext c, naRef me, int argc, naRef* args) { return nasalSys->removeListener(c, argc, args); } // Returns a ghost handle to the argument to the currently executing // command static naRef f_cmdarg(naContext c, naRef me, int argc, naRef* args) { return nasalSys->cmdArgGhost(); } // Sets up a property interpolation. The first argument is either a // ghost (SGPropertyNode_ptr*) or a string (global property path) to // interpolate. The second argument is a vector of pairs of // value/delta numbers. static naRef f_interpolate(naContext c, naRef me, int argc, naRef* args) { SGPropertyNode* node; naRef prop = argc > 0 ? args[0] : naNil(); if(naIsString(prop)) node = fgGetNode(naStr_data(prop), true); else if(naIsGhost(prop)) node = *(SGPropertyNode_ptr*)naGhost_ptr(prop); else return naNil(); naRef curve = argc > 1 ? args[1] : naNil(); if(!naIsVector(curve)) return naNil(); int nPoints = naVec_size(curve) / 2; double* values = new double[nPoints]; double* deltas = new double[nPoints]; for(int i=0; iget_subsystem_mgr() ->get_group(SGSubsystemMgr::INIT)->get_subsystem("interpolator")) ->interpolate(node, nPoints, values, deltas); delete[] values; delete[] deltas; return naNil(); } // This is a better RNG than the one in the default Nasal distribution // (which is based on the C library rand() implementation). It will // override. static naRef f_rand(naContext c, naRef me, int argc, naRef* args) { return naNum(sg_random()); } static naRef f_srand(naContext c, naRef me, int argc, naRef* args) { sg_srandom_time(); return naNum(0); } static naRef f_abort(naContext c, naRef me, int argc, naRef* args) { abort(); return naNil(); } // Return an array listing of all files in a directory static naRef f_directory(naContext c, naRef me, int argc, naRef* args) { if(argc != 1 || !naIsString(args[0])) naRuntimeError(c, "bad arguments to directory()"); naRef ldir = args[0]; ulDir* dir = ulOpenDir(naStr_data(args[0])); if(!dir) return naNil(); naRef result = naNewVector(c); ulDirEnt* dent; while((dent = ulReadDir(dir))) naVec_append(result, naStr_fromdata(naNewString(c), dent->d_name, strlen(dent->d_name))); ulCloseDir(dir); return result; } // Parse XML file. // parsexml( [, [, [, [, ]]]]); // // ... absolute path to an XML file // ... callback function with two args: tag name, attribute hash // ... callback function with one arg: tag name // ... callback function with one arg: data // ... callback function with two args: target, data // (pi = "processing instruction") // All four callback functions are optional and default to nil. // The function returns nil on error, or the validated file name otherwise. static naRef f_parsexml(naContext c, naRef me, int argc, naRef* args) { if(argc < 1 || !naIsString(args[0])) naRuntimeError(c, "parsexml(): path argument missing or not a string"); if(argc > 5) argc = 5; for(int i=1; i(file), strlen(file)); } // Return UNIX epoch time in seconds. static naRef f_systime(naContext c, naRef me, int argc, naRef* args) { #ifdef WIN32 FILETIME ft; GetSystemTimeAsFileTime(&ft); double t = (4294967296.0 * ft.dwHighDateTime + ft.dwLowDateTime); // Converts from 100ns units in 1601 epoch to unix epoch in sec return naNum((t * 1e-7) - 11644473600.0); #else time_t t; struct timeval td; do { t = time(0); gettimeofday(&td, 0); } while(t != time(0)); return naNum(t + 1e-6 * td.tv_usec); #endif } // Convert a cartesian point to a geodetic lat/lon/altitude. static naRef f_carttogeod(naContext c, naRef me, int argc, naRef* args) { double lat, lon, alt, xyz[3]; if(argc != 3) naRuntimeError(c, "carttogeod() expects 3 arguments"); for(int i=0; i<3; i++) xyz[i] = naNumValue(args[i]).num; sgCartToGeod(xyz, &lat, &lon, &alt); lat *= SG_RADIANS_TO_DEGREES; lon *= SG_RADIANS_TO_DEGREES; naRef vec = naNewVector(c); naVec_append(vec, naNum(lat)); naVec_append(vec, naNum(lon)); naVec_append(vec, naNum(alt)); return vec; } // Convert a geodetic lat/lon/altitude to a cartesian point. static naRef f_geodtocart(naContext c, naRef me, int argc, naRef* args) { if(argc != 3) naRuntimeError(c, "geodtocart() expects 3 arguments"); double lat = naNumValue(args[0]).num * SG_DEGREES_TO_RADIANS; double lon = naNumValue(args[1]).num * SG_DEGREES_TO_RADIANS; double alt = naNumValue(args[2]).num; double xyz[3]; sgGeodToCart(lat, lon, alt, xyz); naRef vec = naNewVector(c); naVec_append(vec, naNum(xyz[0])); naVec_append(vec, naNum(xyz[1])); naVec_append(vec, naNum(xyz[2])); return vec; } // For given geodetic point return array with elevation, and a material data // hash, or nil if there's no information available (tile not loaded). If // information about the material isn't available, then nil is returned instead // of the hash. static naRef f_geodinfo(naContext c, naRef me, int argc, naRef* args) { #define HASHSET(s,l,n) naHash_set(matdata, naStr_fromdata(naNewString(c),s,l),n) if(argc != 2) naRuntimeError(c, "geodinfo() expects 2 arguments: lat, lon"); double lat = naNumValue(args[0]).num; double lon = naNumValue(args[1]).num; double elev; const SGMaterial *mat; if(!globals->get_scenery()->get_elevation_m(lat, lon, 10000.0, elev, &mat)) return naNil(); naRef vec = naNewVector(c); naVec_append(vec, naNum(elev)); naRef matdata = naNil(); if(mat) { matdata = naNewHash(c); naRef names = naNewVector(c); const vector n = mat->get_names(); for(unsigned int i=0; i(n[i].c_str()), n[i].size())); HASHSET("names", 5, names); HASHSET("solid", 5, naNum(mat->get_solid())); HASHSET("friction_factor", 15, naNum(mat->get_friction_factor())); HASHSET("rolling_friction", 16, naNum(mat->get_rolling_friction())); HASHSET("load_resistance", 15, naNum(mat->get_load_resistance())); HASHSET("bumpiness", 9, naNum(mat->get_bumpiness())); HASHSET("light_coverage", 14, naNum(mat->get_light_coverage())); } naVec_append(vec, matdata); return vec; #undef HASHSET } class airport_filter : public FGAirportSearchFilter { virtual bool pass(FGAirport *a) { return a->isAirport(); } } airport; class seaport_filter : public FGAirportSearchFilter { virtual bool pass(FGAirport *a) { return a->isSeaport(); } } seaport; class heliport_filter : public FGAirportSearchFilter { virtual bool pass(FGAirport *a) { return a->isHeliport(); } } heliport; // Returns data hash for particular or nearest airport of a , or nil // on error. Only one side of each runway is contained. // // airportinfo(); e.g. "KSFO" // airportinfo(); type := ("airport"|"seaport"|"heliport") // airportinfo() same as airportinfo("airport") // airportinfo(, [, ]); static naRef f_airportinfo(naContext c, naRef me, int argc, naRef* args) { static SGConstPropertyNode_ptr latn = fgGetNode("/position/latitude-deg", true); static SGConstPropertyNode_ptr lonn = fgGetNode("/position/longitude-deg", true); double lat, lon; FGAirportList *aptlst = globals->get_airports(); FGAirport *apt; if(argc >= 2 && naIsNum(args[0]) && naIsNum(args[1])) { lat = args[0].num; lon = args[1].num; args += 2; argc -= 2; } else { lat = latn->getDoubleValue(); lon = lonn->getDoubleValue(); } double maxRange = 360.0; // expose this? or pick a smaller value? if(argc == 0) { apt = aptlst->search(lon, lat, maxRange, airport); } else if(argc == 1 && naIsString(args[0])) { const char *s = naStr_data(args[0]); if(!strcmp(s, "airport")) apt = aptlst->search(lon, lat, maxRange, airport); else if(!strcmp(s, "seaport")) apt = aptlst->search(lon, lat, maxRange, seaport); else if(!strcmp(s, "heliport")) apt = aptlst->search(lon, lat, maxRange, heliport); else apt = aptlst->search(s); } else { naRuntimeError(c, "airportinfo() with invalid function arguments"); return naNil(); } if(!apt) return naNil(); string id = apt->getId(); string name = apt->getName(); // set runway hash naRef rwys = naNewHash(c); for (unsigned int r=0; rnumRunways(); ++r) { FGRunway* rwy(apt->getRunwayByIndex(r)); naRef rwyid = naStr_fromdata(naNewString(c), const_cast(rwy->ident().c_str()), rwy->ident().length()); naRef rwydata = naNewHash(c); #define HASHSET(s,l,n) naHash_set(rwydata, naStr_fromdata(naNewString(c),s,l),n) HASHSET("id", 2, rwyid); HASHSET("lat", 3, naNum(rwy->latitude())); HASHSET("lon", 3, naNum(rwy->longitude())); HASHSET("heading", 7, naNum(rwy->headingDeg())); HASHSET("length", 6, naNum(rwy->lengthM())); HASHSET("width", 5, naNum(rwy->widthM())); HASHSET("threshold", 9, naNum(rwy->_displ_thresh * SG_FEET_TO_METER)); HASHSET("stopway", 7, naNum(rwy->_stopway * SG_FEET_TO_METER)); #undef HASHSET naHash_set(rwys, rwyid, rwydata); } // set airport hash naRef aptdata = naNewHash(c); #define HASHSET(s,l,n) naHash_set(aptdata, naStr_fromdata(naNewString(c),s,l),n) HASHSET("id", 2, naStr_fromdata(naNewString(c), const_cast(id.c_str()), id.length())); HASHSET("name", 4, naStr_fromdata(naNewString(c), const_cast(name.c_str()), name.length())); HASHSET("lat", 3, naNum(apt->getLatitude())); HASHSET("lon", 3, naNum(apt->getLongitude())); HASHSET("elevation", 9, naNum(apt->getElevation() * SG_FEET_TO_METER)); HASHSET("has_metar", 9, naNum(apt->getMetar())); HASHSET("runways", 7, rwys); #undef HASHSET return aptdata; } // Table of extension functions. Terminate with zeros. static struct { const char* name; naCFunction func; } funcs[] = { { "getprop", f_getprop }, { "setprop", f_setprop }, { "print", f_print }, { "_fgcommand", f_fgcommand }, { "settimer", f_settimer }, { "_setlistener", f_setlistener }, { "removelistener", f_removelistener }, { "_cmdarg", f_cmdarg }, { "_interpolate", f_interpolate }, { "rand", f_rand }, { "srand", f_srand }, { "abort", f_abort }, { "directory", f_directory }, { "parsexml", f_parsexml }, { "systime", f_systime }, { "carttogeod", f_carttogeod }, { "geodtocart", f_geodtocart }, { "geodinfo", f_geodinfo }, { "airportinfo", f_airportinfo }, { 0, 0 } }; naRef FGNasalSys::cmdArgGhost() { return propNodeGhost(_cmdArg); } void FGNasalSys::init() { int i; _context = naNewContext(); // Start with globals. Add it to itself as a recursive // sub-reference under the name "globals". This gives client-code // write access to the namespace if someone wants to do something // fancy. _globals = naInit_std(_context); naSave(_context, _globals); hashset(_globals, "globals", _globals); hashset(_globals, "math", naInit_math(_context)); hashset(_globals, "bits", naInit_bits(_context)); hashset(_globals, "io", naInit_io(_context)); hashset(_globals, "thread", naInit_thread(_context)); hashset(_globals, "utf8", naInit_utf8(_context)); // Add our custom extension functions: for(i=0; funcs[i].name; i++) hashset(_globals, funcs[i].name, naNewFunc(_context, naNewCCode(_context, funcs[i].func))); // And our SGPropertyNode wrapper hashset(_globals, "props", genPropsModule()); // Make a "__gcsave" hash to hold the naRef objects which get // passed to handles outside the interpreter (to protect them from // begin garbage-collected). _gcHash = naNewHash(_context); hashset(_globals, "__gcsave", _gcHash); // Now load the various source files in the Nasal directory SGPath p(globals->get_fg_root()); p.append("Nasal"); ulDirEnt* dent; ulDir* dir = ulOpenDir(p.c_str()); while(dir && (dent = ulReadDir(dir)) != 0) { SGPath fullpath(p); fullpath.append(dent->d_name); SGPath file(dent->d_name); if(file.extension() != "nas") continue; loadModule(fullpath, file.base().c_str()); } ulCloseDir(dir); // set signal and remove node to avoid restoring at reinit const char *s = "nasal-dir-initialized"; SGPropertyNode *signal = fgGetNode("/sim/signals", true); signal->setBoolValue(s, true); signal->removeChildren(s); // Pull scripts out of the property tree, too loadPropertyScripts(); } void FGNasalSys::update(double) { if(!_dead_listener.empty()) { vector::iterator it, end = _dead_listener.end(); for(it = _dead_listener.begin(); it != end; ++it) delete *it; _dead_listener.clear(); } // The global context is a legacy thing. We use dynamically // created contexts for naCall() now, so that we can call them // recursively. But there are still spots that want to use it for // naNew*() calls, which end up leaking memory because the context // only clears out its temporary vector when it's *used*. So just // junk it and fetch a new/reinitialized one every frame. This is // clumsy: the right solution would use the dynamic context in all // cases and eliminate _context entirely. But that's more work, // and this works fine (yes, they say "New" and "Free", but // they're very fast, just trust me). -Andy naFreeContext(_context); _context = naNewContext(); } // Loads the scripts found under /nasal in the global tree void FGNasalSys::loadPropertyScripts() { SGPropertyNode* nasal = globals->get_props()->getNode("nasal"); if(!nasal) return; for(int i=0; inChildren(); i++) { SGPropertyNode* n = nasal->getChild(i); const char* module = n->getName(); if(n->hasChild("module")) module = n->getStringValue("module"); // allow multiple files to be specified within in a single // Nasal module tag int j = 0; SGPropertyNode *fn; bool file_specified = false; while((fn = n->getChild("file", j)) != NULL) { file_specified = true; const char* file = fn->getStringValue(); SGPath p(globals->get_fg_root()); p.append(file); loadModule(p, module); j++; } // Old code which only allowed a single file to be specified per module /* const char* file = n->getStringValue("file"); if(!n->hasChild("file")) file = 0; // Hrm... if(file) { SGPath p(globals->get_fg_root()); p.append(file); loadModule(p, module); } */ const char* src = n->getStringValue("script"); if(!n->hasChild("script")) src = 0; // Hrm... if(src) createModule(module, n->getPath(), src, strlen(src)); if(!file_specified && !src) SG_LOG(SG_NASAL, SG_ALERT, "Nasal error: " << "no or