]> git.mxchange.org Git - flightgear.git/blobdiff - src/Scripting/NasalSys.cxx
Merge branch 'maint' into next
[flightgear.git] / src / Scripting / NasalSys.cxx
index 16f910ce09a4944ee62f9c243634b2fc5f8ad641..1941712eca92487f1ccd2b8add2ea9a9fc0cadba 100644 (file)
 #include <simgear/scene/material/mat.hxx>
 #include <simgear/structure/commands.hxx>
 #include <simgear/math/sg_geodesy.hxx>
+#include <simgear/structure/event_mgr.hxx>
 
 #include <Airports/runways.hxx>
 #include <Airports/simple.hxx>
 #include <Main/globals.hxx>
 #include <Main/fg_props.hxx>
+#include <Main/util.hxx>
 #include <Scenery/scenery.hxx>
 
 #include "NasalSys.hxx"
@@ -71,7 +73,6 @@ FGNasalSys::FGNasalSys()
     _gcHash = naNil();
     _nextGCKey = 0; // Any value will do
     _callCount = 0;
-    _purgeListeners = false;
 }
 
 // Does a naCall() in a new context.  Wrapped here to make lock
@@ -80,12 +81,12 @@ FGNasalSys::FGNasalSys()
 // 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, naRef locals)
+naRef FGNasalSys::call(naRef code, int argc, naRef* args, naRef locals)
 {
     naContext ctx = naNewContext();
     if(_callCount) naModUnlock();
     _callCount++;
-    naRef result = naCall(ctx, code, 0, 0, naNil(), locals);
+    naRef result = naCall(ctx, code, argc, args, naNil(), locals);
     if(naGetError(ctx))
         logError(ctx);
     _callCount--;
@@ -111,7 +112,7 @@ bool FGNasalSys::parseAndRun(const char* sourceCode)
                        strlen(sourceCode));
     if(naIsNil(code))
         return false;
-    call(code, naNil());
+    call(code, 0, 0, naNil());
     return true;
 }
 
@@ -222,19 +223,19 @@ static naRef f_setprop(naContext c, naRef me, int argc, naRef* args)
 
     SGPropertyNode* props = globals->get_props();
     naRef val = args[argc-1];
-    bool ret;
     try {
-        if(naIsString(val)) ret = props->setStringValue(buf, naStr_data(val));
+        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");
-            ret = props->setDoubleValue(buf, n.num);
+            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());
     }
-    if(!ret) naRuntimeError(c, "setprop(): property is not writable");
     return naNil();
 #undef BUFLEN
 }
@@ -329,6 +330,8 @@ static naRef f_interpolate(naContext c, naRef me, int argc, naRef* args)
         ->get_group(SGSubsystemMgr::INIT)->get_subsystem("interpolator"))
         ->interpolate(node, nPoints, values, deltas);
 
+    delete[] values;
+    delete[] deltas;
     return naNil();
 }
 
@@ -346,6 +349,12 @@ static naRef f_srand(naContext c, naRef me, int argc, naRef* args)
     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)
 {
@@ -373,7 +382,7 @@ static naRef f_directory(naContext c, naRef me, int argc, naRef* args)
 // <pi>        ... 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, and the file name otherwise.
+// 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]))
@@ -383,18 +392,22 @@ static naRef f_parsexml(naContext c, naRef me, int argc, naRef* args)
         if(!(naIsNil(args[i]) || naIsFunc(args[i])))
             naRuntimeError(c, "parsexml(): callback argument not a function");
 
-    const char* file = naStr_data(args[0]);
+    const char* file = fgValidatePath(naStr_data(args[0]), false);
+    if(!file) {
+        naRuntimeError(c, "parsexml(): reading '%s' denied "
+                "(unauthorized access)", naStr_data(args[0]));
+        return naNil();
+    }
     std::ifstream input(file);
     NasalXMLVisitor visitor(c, argc, args);
     try {
         readXML(input, visitor);
     } catch (const sg_exception& e) {
-        string msg = string("parsexml(): file '") + file + "' "
-                     + e.getFormattedMessage();
-        naRuntimeError(c, msg.c_str());
+        naRuntimeError(c, "parsexml(): file '%s' %s",
+                file, e.getFormattedMessage().c_str());
         return naNil();
     }
-    return args[0];
+    return naStr_fromdata(naNewString(c), const_cast<char*>(file), strlen(file));
 }
 
 // Return UNIX epoch time in seconds.
@@ -412,7 +425,6 @@ static naRef f_systime(naContext c, naRef me, int argc, naRef* args)
     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.
@@ -485,68 +497,99 @@ static naRef f_geodinfo(naContext c, naRef me, int argc, naRef* args)
 #undef HASHSET
 }
 
+class AirportInfoFilter : public FGAirport::AirportFilter
+{
+public:
+  AirportInfoFilter() :
+    type(FGPositioned::AIRPORT)
+  { }
+  
+  virtual FGPositioned::Type minType() const {
+    return type;
+  }
+  
+  virtual FGPositioned::Type maxType() const {
+    return type;
+  }
+  
+ FGPositioned::Type type;
+};
 
-class airport_filter : public FGAirportSearchFilter {
-    virtual bool pass(FGAirport *a) { return a->isAirport(); }
-} airport;
-
-// Returns airport data for given airport id ("KSFO"), or for the airport
-// nearest to a given lat/lon pair, or without arguments, to the current
-// aircraft position. Returns nil on error. Only one side of each runway is
-// returned.
+// Returns data hash for particular or nearest airport of a <type>, or nil
+// on error.
+//
+// airportinfo(<id>);                   e.g. "KSFO"
+// airportinfo(<type>);                 type := ("airport"|"seaport"|"heliport")
+// airportinfo()                        same as  airportinfo("airport")
+// airportinfo(<lat>, <lon> [, <type>]);
 static naRef f_airportinfo(naContext c, naRef me, int argc, naRef* args)
 {
-    static SGConstPropertyNode_ptr lat = fgGetNode("/position/latitude-deg", true);
-    static SGConstPropertyNode_ptr lon = fgGetNode("/position/longitude-deg", true);
-
-    // airport
-    FGAirportList *aptlst = globals->get_airports();
-    FGAirport *apt;
-    if(argc == 0)
-        apt = aptlst->search(lon->getDoubleValue(), lat->getDoubleValue(), airport);
-    else if(argc == 1 && naIsString(args[0]))
-        apt = aptlst->search(naStr_data(args[0]));
-    else if(argc == 2 && naIsNum(args[0]) && naIsNum(args[1]))
-        apt = aptlst->search(args[1].num, args[0].num, airport);
-    else {
+    static SGConstPropertyNode_ptr latn = fgGetNode("/position/latitude-deg", true);
+    static SGConstPropertyNode_ptr lonn = fgGetNode("/position/longitude-deg", true);
+    SGGeod pos;
+    FGAirport* apt = NULL;
+    
+    if(argc >= 2 && naIsNum(args[0]) && naIsNum(args[1])) {
+        pos = SGGeod::fromDeg(args[1].num, args[0].num);
+        args += 2;
+        argc -= 2;
+    } else {
+        pos = SGGeod::fromDeg(lonn->getDoubleValue(), latn->getDoubleValue());
+    }
+
+    double maxRange = 10000.0; // expose this? or pick a smaller value?
+
+    AirportInfoFilter filter; // defaults to airports only
+
+    if(argc == 0) {
+      // fine, just fall through and use AIRPORT
+    } else if(argc == 1 && naIsString(args[0])) {
+        const char *s = naStr_data(args[0]);
+        if (!strcmp(s, "airport")) filter.type = FGPositioned::AIRPORT;
+        else if(!strcmp(s, "seaport")) filter.type = FGPositioned::SEAPORT;
+        else if(!strcmp(s, "heliport")) filter.type = FGPositioned::HELIPORT;
+        else {
+            // user provided an <id>, hopefully
+            apt = FGAirport::findByIdent(s);
+            if (!apt) {
+                naRuntimeError(c, "airportinfo() couldn't find airport:%s", s);
+                return naNil();
+            }
+        }
+    } else {
         naRuntimeError(c, "airportinfo() with invalid function arguments");
         return naNil();
     }
-    if(!apt) {
-        naRuntimeError(c, "airportinfo(): no airport found");
-        return naNil();
+    
+    if (!apt) {
+        apt = FGAirport::findClosest(pos, maxRange, &filter);
+        if(!apt) return naNil();
     }
-
-    string id = apt->getId();
-    string name = apt->getName();
+    
+    string id = apt->ident();
+    string name = apt->name();
 
     // set runway hash
-    FGRunwayList *rwylst = globals->get_runways();
-    FGRunway rwy;
     naRef rwys = naNewHash(c);
-    if(rwylst->search(id, &rwy)) {
-        do {
-            if(rwy._id != id) break;
-            if(rwy._type[0] != 'r') continue;
+    for (unsigned int r=0; r<apt->numRunways(); ++r) {
+        FGRunway* rwy(apt->getRunwayByIndex(r));
+
+        naRef rwyid = naStr_fromdata(naNewString(c),
+                      const_cast<char *>(rwy->ident().c_str()),
+                      rwy->ident().length());
 
-            naRef rwydata = naNewHash(c);
+        naRef rwydata = naNewHash(c);
 #define HASHSET(s,l,n) naHash_set(rwydata, naStr_fromdata(naNewString(c),s,l),n)
-            HASHSET("lat", 3, naNum(rwy._lat));
-            HASHSET("lon", 3, naNum(rwy._lon));
-            HASHSET("heading", 7, naNum(rwy._heading));
-            HASHSET("length", 6, naNum(rwy._length * SG_FEET_TO_METER));
-            HASHSET("width", 5, naNum(rwy._width * SG_FEET_TO_METER));
-            HASHSET("threshold1", 10, naNum(rwy._displ_thresh1 * SG_FEET_TO_METER));
-            HASHSET("threshold2", 10, naNum(rwy._displ_thresh2 * SG_FEET_TO_METER));
-            HASHSET("stopway1", 8, naNum(rwy._stopway1 * SG_FEET_TO_METER));
-            HASHSET("stopway2", 8, naNum(rwy._stopway2 * SG_FEET_TO_METER));
+        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->displacedThresholdM()));
+        HASHSET("stopway", 7, naNum(rwy->stopwayM()));
 #undef HASHSET
-
-            naRef no = naStr_fromdata(naNewString(c),
-                    const_cast<char *>(rwy._rwy_no.c_str()),
-                    rwy._rwy_no.length());
-            naHash_set(rwys, no, rwydata);
-        } while(rwylst->next(&rwy));
+        naHash_set(rwys, rwyid, rwydata);
     }
 
     // set airport hash
@@ -567,7 +610,7 @@ static naRef f_airportinfo(naContext c, naRef me, int argc, naRef* args)
 
 
 // Table of extension functions.  Terminate with zeros.
-static struct { char* name; naCFunction func; } funcs[] = {
+static struct { const char* name; naCFunction func; } funcs[] = {
     { "getprop",   f_getprop },
     { "setprop",   f_setprop },
     { "print",     f_print },
@@ -579,6 +622,7 @@ static struct { char* name; naCFunction func; } funcs[] = {
     { "_interpolate",  f_interpolate },
     { "rand",  f_rand },
     { "srand",  f_srand },
+    { "abort", f_abort },
     { "directory", f_directory },
     { "parsexml", f_parsexml },
     { "systime", f_systime },
@@ -654,19 +698,24 @@ void FGNasalSys::init()
 
 void FGNasalSys::update(double)
 {
-    if(_purgeListeners) {
-        _purgeListeners = false;
-        map<int, FGNasalListener *>::iterator it;
-        for(it = _listener.begin(); it != _listener.end();) {
-            FGNasalListener *nl = it->second;
-            if(nl->_dead) {
-                _listener.erase(it++);
-                delete nl;
-            } else {
-                ++it;
-            }
-        }
+    if(!_dead_listener.empty()) {
+        vector<FGNasalListener *>::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
@@ -687,7 +736,7 @@ void FGNasalSys::loadPropertyScripts()
         int j = 0;
         SGPropertyNode *fn;
         bool file_specified = false;
-        while ( (fn = n->getChild("file", j)) != NULL ) {
+        while((fn = n->getChild("file", j)) != NULL) {
             file_specified = true;
             const char* file = fn->getStringValue();
             SGPath p(globals->get_fg_root());
@@ -756,7 +805,9 @@ void FGNasalSys::loadModule(SGPath file, const char* module)
 // used to pass an associated property node to the module, which can then
 // be accessed via cmdarg().  (This is, for example, used by XML dialogs.)
 void FGNasalSys::createModule(const char* moduleName, const char* fileName,
-                              const char* src, int len, const SGPropertyNode* arg)
+                              const char* src, int len,
+                              const SGPropertyNode* cmdarg,
+                              int argc, naRef* args)
 {
     naRef code = parse(fileName, src, len);
     if(naIsNil(code))
@@ -771,9 +822,9 @@ void FGNasalSys::createModule(const char* moduleName, const char* fileName,
     if(!naHash_get(_globals, modname, &locals))
         locals = naNewHash(_context);
 
-    _cmdArg = (SGPropertyNode*)arg;
+    _cmdArg = (SGPropertyNode*)cmdarg;
 
-    call(code, locals);
+    call(code, argc, args, locals);
     hashset(_globals, moduleName, locals);
 }
 
@@ -826,7 +877,7 @@ bool FGNasalSys::handleCommand(const SGPropertyNode* arg)
     // code doesn't need it.
     _cmdArg = (SGPropertyNode*)arg;
 
-    call(code, locals);
+    call(code, 0, 0, locals);
     return true;
 }
 
@@ -870,7 +921,7 @@ void FGNasalSys::setTimer(naContext c, int argc, naRef* args)
 
 void FGNasalSys::handleTimer(NasalTimer* t)
 {
-    call(t->handler, naNil());
+    call(t->handler, 0, 0, naNil());
     gcRelease(t->gcKey);
 }
 
@@ -894,12 +945,16 @@ void FGNasalSys::NasalTimer::timerExpired()
 
 int FGNasalSys::_listenerId = 0;
 
-// setlistener(property, func, bool) extension function.  The first argument
-// is either a ghost (SGPropertyNode_ptr*) or a string (global property
-// path), the second is a Nasal function, the optional third one a bool.
-// If the bool is true, then the listener is executed initially. The
-// setlistener() function returns a unique id number, that can be used
-// as argument to the removelistener() function.
+// setlistener(<property>, <func> [, <initial=0> [, <persistent=1>]])
+// Attaches a callback function to a property (specified as a global
+// property path string or a SGPropertyNode_ptr* ghost). If the third,
+// optional argument (default=0) is set to 1, then the function is also
+// called initially. If the fourth, optional argument is set to 0, then the
+// function is only called when the property node value actually changes.
+// Otherwise it's called independent of the value whenever the node is
+// written to (default). The setlistener() function returns a unique
+// id number, which is to be used as argument to the removelistener()
+// function.
 naRef FGNasalSys::setListener(naContext c, int argc, naRef* args)
 {
     SGPropertyNode_ptr node;
@@ -915,16 +970,17 @@ naRef FGNasalSys::setListener(naContext c, int argc, naRef* args)
         SG_LOG(SG_NASAL, SG_DEBUG, "Attaching listener to tied property " <<
                 node->getPath());
 
-    naRef handler = argc > 1 ? args[1] : naNil();
-    if(!(naIsCode(handler) || naIsCCode(handler) || naIsFunc(handler))) {
+    naRef code = argc > 1 ? args[1] : naNil();
+    if(!(naIsCode(code) || naIsCCode(code) || naIsFunc(code))) {
         naRuntimeError(c, "setlistener() with invalid function argument");
         return naNil();
     }
 
-    bool initial = argc > 2 && naTrue(args[2]);
+    int type = argc > 3 && naIsNum(args[3]) ? (int)args[3].num : 1;
+    FGNasalListener *nl = new FGNasalListener(node, code, this,
+            gcSave(code), _listenerId, type);
 
-    FGNasalListener *nl = new FGNasalListener(node, handler, this,
-            gcSave(handler), _listenerId);
+    bool initial = argc > 2 && naTrue(args[2]);
     node->addChangeListener(nl, initial);
 
     _listener[_listenerId] = nl;
@@ -943,15 +999,9 @@ naRef FGNasalSys::removeListener(naContext c, int argc, naRef* args)
         return naNil();
     }
 
-    FGNasalListener *nl = it->second;
-    if(nl->_active) {
-        nl->_dead = true;
-        _purgeListeners = true;
-        return naNum(-1);
-    }
-
+    it->second->_dead = true;
+    _dead_listener.push_back(it->second);
     _listener.erase(it);
-    delete nl;
     return naNum(_listener.size());
 }
 
@@ -959,15 +1009,19 @@ naRef FGNasalSys::removeListener(naContext c, int argc, naRef* args)
 
 // FGNasalListener class.
 
-FGNasalListener::FGNasalListener(SGPropertyNode_ptr node, naRef handler,
-                                 FGNasalSys* nasal, int key, int id) :
+FGNasalListener::FGNasalListener(SGPropertyNode *node, naRef code,
+                                 FGNasalSys* nasal, int key, int id, int type) :
     _node(node),
-    _handler(handler),
+    _code(code),
     _gcKey(key),
     _id(id),
     _nas(nasal),
+    _type(type),
     _active(0),
-    _dead(false)
+    _dead(false),
+    _first_call(true),
+    _last_int(0L),
+    _last_float(0.0)
 {
 }
 
@@ -977,19 +1031,73 @@ FGNasalListener::~FGNasalListener()
     _nas->gcRelease(_gcKey);
 }
 
-void FGNasalListener::valueChanged(SGPropertyNode* node)
+void FGNasalListener::call(SGPropertyNode* which, naRef mode)
 {
-    // drop recursive listener calls
-    if(_active || _dead)
-        return;
-
+    if(_active || _dead) return;
     SG_LOG(SG_NASAL, SG_DEBUG, "trigger listener #" << _id);
     _active++;
-    _nas->_cmdArg = node;
-    _nas->call(_handler, naNil());
+    naRef arg[4];
+    arg[0] = _nas->propNodeGhost(which);
+    arg[1] = _nas->propNodeGhost(_node);
+    arg[2] = mode;                  // value changed, child added/removed
+    arg[3] = naNum(_node != which); // child event?
+    _nas->call(_code, 4, arg, naNil());
     _active--;
 }
 
+void FGNasalListener::valueChanged(SGPropertyNode* node)
+{
+    if(_type < 2 && node != _node) return;   // skip child events
+    if(_type > 0 || changed(_node) || _first_call)
+        call(node, naNum(0));
+
+    _first_call = false;
+}
+
+void FGNasalListener::childAdded(SGPropertyNode*, SGPropertyNode* child)
+{
+    if(_type == 2) call(child, naNum(1));
+}
+
+void FGNasalListener::childRemoved(SGPropertyNode*, SGPropertyNode* child)
+{
+    if(_type == 2) call(child, naNum(-1));
+}
+
+bool FGNasalListener::changed(SGPropertyNode* node)
+{
+    SGPropertyNode::Type type = node->getType();
+    if(type == SGPropertyNode::NONE) return false;
+    if(type == SGPropertyNode::UNSPECIFIED) return true;
+
+    bool result;
+    switch(type) {
+    case SGPropertyNode::BOOL:
+    case SGPropertyNode::INT:
+    case SGPropertyNode::LONG:
+        {
+            long l = node->getLongValue();
+            result = l != _last_int;
+            _last_int = l;
+            return result;
+        }
+    case SGPropertyNode::FLOAT:
+    case SGPropertyNode::DOUBLE:
+        {
+            double d = node->getDoubleValue();
+            result = d != _last_float;
+            _last_float = d;
+            return result;
+        }
+    default:
+        {
+            string s = node->getStringValue();
+            result = s != _last_string;
+            _last_string = s;
+            return result;
+        }
+    }
+}
 
 
 
@@ -1001,12 +1109,14 @@ void FGNasalListener::valueChanged(SGPropertyNode* node)
 void FGNasalModelData::modelLoaded(const string& path, SGPropertyNode *prop,
                                    osg::Node *)
 {
-    SGPropertyNode *n = prop->getNode("nasal"), *load;
-    if(!n)
+    if(!prop)
+        return;
+    SGPropertyNode *nasal = prop->getNode("nasal");
+    if(!nasal)
         return;
 
-    load = n->getNode("load");
-    _unload = n->getNode("unload");
+    SGPropertyNode *load = nasal->getNode("load");
+    _unload = nasal->getNode("unload");
     if(!load && !_unload)
         return;
 
@@ -1014,7 +1124,13 @@ void FGNasalModelData::modelLoaded(const string& path, SGPropertyNode *prop,
     if(_props)
         _module += ':' + _props->getPath();
     const char *s = load ? load->getStringValue() : "";
-    nasalSys->createModule(_module.c_str(), _module.c_str(), s, strlen(s), _props);
+
+    naRef arg[2];
+    arg[0] = nasalSys->propNodeGhost(_root);
+    arg[1] = nasalSys->propNodeGhost(prop);
+    nasalSys->createModule(_module.c_str(), _module.c_str(), s, strlen(s),
+                           _root, 2, arg);
+    _props = 0;
 }
 
 FGNasalModelData::~FGNasalModelData()
@@ -1030,7 +1146,7 @@ FGNasalModelData::~FGNasalModelData()
 
     if(_unload) {
         const char *s = _unload->getStringValue();
-        nasalSys->createModule(_module.c_str(), _module.c_str(), s, strlen(s), _props);
+        nasalSys->createModule(_module.c_str(), _module.c_str(), s, strlen(s), _root);
     }
     nasalSys->deleteModule(_module.c_str());
 }