]> git.mxchange.org Git - flightgear.git/blobdiff - src/Scripting/NasalSys.cxx
allow listeners to remove themselves. This is done by marking them
[flightgear.git] / src / Scripting / NasalSys.cxx
index 36a344ef58e1fe868e390bd191f4e1ab574ba372..a270a27d189934ecc0b130bb995640838a9043e3 100644 (file)
@@ -56,10 +56,36 @@ FGNasalSys::FGNasalSys()
     _globals = naNil();
     _gcHash = naNil();
     _nextGCKey = 0; // Any value will do
+    _callCount = 0;
+    _purgeListeners = false;
+}
+
+// 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, naRef locals)
+{
+    naContext ctx = naNewContext();
+    if(_callCount) naModUnlock();
+    _callCount++;
+    naRef result = naCall(ctx, code, 0, 0, naNil(), locals);
+    if(naGetError(ctx))
+        logError(ctx);
+    _callCount--;
+    if(_callCount) naModLock();
+    naFreeContext(ctx);
+    return result;
 }
 
 FGNasalSys::~FGNasalSys()
 {
+    map<int, FGNasalListener *>::iterator it, end = _listener.end();
+    for(it = _listener.begin(); it != end; ++it)
+        delete it->second;
+
     // Nasal doesn't have a "destroy context" API yet. :(
     // Not a problem for a global subsystem that will never be
     // destroyed.  And the context is actually a global, so no memory
@@ -75,12 +101,8 @@ bool FGNasalSys::parseAndRun(const char* sourceCode)
                        strlen(sourceCode));
     if(naIsNil(code))
         return false;
-
-    naCall(_context, code, 0, 0, naNil(), naNil());
-
-    if(!naGetError(_context)) return true;
-    logError(_context);
-    return false;
+    call(code, naNil());
+    return true;
 }
 
 FGNasalScript* FGNasalSys::parseScript(const char* src, const char* name)
@@ -124,11 +146,16 @@ void FGNasalSys::hashset(naRef hash, const char* key, naRef val)
 static SGPropertyNode* findnode(naContext c, naRef* vec, int len)
 {
     SGPropertyNode* p = globals->get_props();
-    for(int i=0; i<len; i++) {
-        naRef a = vec[i];
-        if(!naIsString(a)) return 0;
-        p = p->getNode(naStr_data(a));
-        if(p == 0) return 0;
+    try {
+        for(int i=0; i<len; i++) {
+            naRef a = vec[i];
+            if(!naIsString(a)) return 0;
+            p = p->getNode(naStr_data(a));
+            if(p == 0) return 0;
+        }
+    } catch (const string& err) {
+        naRuntimeError(c, (char *)err.c_str());
+        return 0;
     }
     return p;
 }
@@ -185,8 +212,17 @@ static naRef f_setprop(naContext c, naRef me, int argc, naRef* args)
 
     SGPropertyNode* props = globals->get_props();
     naRef val = args[argc-1];
-    if(naIsString(val)) props->setStringValue(buf, naStr_data(val));
-    else                props->setDoubleValue(buf, naNumValue(val).num);
+    try {
+        if(naIsString(val)) props->setStringValue(buf, naStr_data(val));
+        else {
+            naRef n = naNumValue(val);
+            if(naIsNil(n))
+                naRuntimeError(c, "setprop() value is not string or number");
+            props->setDoubleValue(buf, n.num);
+        }
+    } catch (const string& err) {
+        naRuntimeError(c, (char *)err.c_str());
+    }
     return naNil();
 #undef BUFLEN
 }
@@ -225,9 +261,7 @@ static naRef f_fgcommand(naContext c, naRef me, int argc, naRef* args)
         naRuntimeError(c, "bad arguments to fgcommand()");
     naRef cmd = args[0], props = args[1];
     SGPropertyNode_ptr* node = (SGPropertyNode_ptr*)naGhost_ptr(props);
-    globals->get_commands()->execute(naStr_data(cmd), *node);
-    return naNil();
-
+    return naNum(globals->get_commands()->execute(naStr_data(cmd), *node));
 }
 
 // settimer(func, dt, simtime) extension function.  Falls through to
@@ -252,7 +286,7 @@ static naRef f_setlistener(naContext c, naRef me, int argc, naRef* args)
 static naRef f_removelistener(naContext c, naRef me, int argc, naRef* args)
 {
     FGNasalSys* nasal = (FGNasalSys*)globals->get_subsystem("nasal");
-    return nasal->removeListener(argc, args);
+    return nasal->removeListener(c, argc, args);
 }
 
 // Returns a ghost handle to the argument to the currently executing
@@ -361,6 +395,11 @@ void FGNasalSys::init()
     // Add in the math library under "math"
     hashset(_globals, "math", naMathLib(_context));
 
+    // Add in the IO library.  Disabled currently until after the
+    // 0.9.10 release.
+    // hashset(_globals, "io", naIOLib(_context));
+    // hashset(_globals, "bits", naBitsLib(_context));
+
     // Add our custom extension functions:
     for(i=0; funcs[i].name; i++)
         hashset(_globals, funcs[i].name,
@@ -387,11 +426,33 @@ void FGNasalSys::init()
         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(_purgeListeners) {
+        _purgeListeners = false;
+        map<int, FGNasalListener *>::iterator it, end = _listener.end();
+        for(it = _listener.end(); --it != end;) {
+            FGNasalListener *nl = it->second;
+            if(nl->_dead) {
+                _listener.erase(it);
+                delete nl;
+            }
+        }
+    }
+}
+
 // Loads the scripts found under /nasal in the global tree
 void FGNasalSys::loadPropertyScripts()
 {
@@ -475,9 +536,11 @@ void FGNasalSys::loadModule(SGPath file, const char* module)
 }
 
 // Parse and run.  Save the local variables namespace, as it will
-// become a sub-object of globals.
+// become a sub-object of globals.  The optional "arg" argument can be
+// 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 char* src, int len, const SGPropertyNode* arg)
 {
     naRef code = parse(fileName, src, len);
     if(naIsNil(code))
@@ -492,11 +555,9 @@ void FGNasalSys::createModule(const char* moduleName, const char* fileName,
     if(!naHash_get(_globals, modname, &locals))
         locals = naNewHash(_context);
 
-    naCall(_context, code, 0, 0, naNil(), locals);
-    if(naGetError(_context)) {
-        logError(_context);
-        return;
-    }
+    _cmdArg = (SGPropertyNode*)arg;
+
+    call(code, locals);
     hashset(_globals, moduleName, locals);
 }
 
@@ -504,9 +565,7 @@ void FGNasalSys::deleteModule(const char* moduleName)
 {
     naRef modname = naNewString(_context);
     naStr_fromdata(modname, (char*)moduleName, strlen(moduleName));
-    naModLock();
     naHash_delete(_globals, modname);
-    naModUnlock();
 }
 
 naRef FGNasalSys::parse(const char* filename, const char* buf, int len)
@@ -547,15 +606,8 @@ bool FGNasalSys::handleCommand(const SGPropertyNode* arg)
     _cmdArg = (SGPropertyNode*)arg;
 
     // Call it!
-    naModUnlock();
-    naRef result = naCall(c, code, 0, 0, naNil(), locals);
-    naModLock();
-    bool error = naGetError(c);
-    if(error)
-       logError(c);
-
-    naFreeContext(c);
-    return !error;
+    call(code, locals);
+    return true;
 }
 
 // settimer(func, dt, simtime) extension function.  The first argument
@@ -593,9 +645,7 @@ void FGNasalSys::setTimer(int argc, naRef* args)
 
 void FGNasalSys::handleTimer(NasalTimer* t)
 {
-    naCall(_context, t->handler, 0, 0, naNil(), naNil());
-    if(naGetError(_context))
-        logError(_context);
+    call(t->handler, naNil());
     gcRelease(t->gcKey);
 }
 
@@ -633,6 +683,10 @@ naRef FGNasalSys::setListener(int argc, naRef* args)
     else if(naIsGhost(prop)) node = *(SGPropertyNode_ptr*)naGhost_ptr(prop);
     else return naNil();
 
+    if(node->isTied())
+        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)))
         return naNil();
@@ -649,40 +703,79 @@ naRef FGNasalSys::setListener(int argc, naRef* args)
 
 // removelistener(int) extension function. The argument is the id of
 // a listener as returned by the setlistener() function.
-naRef FGNasalSys::removeListener(int argc, naRef* args)
+naRef FGNasalSys::removeListener(naContext c, int argc, naRef* args)
 {
     naRef id = argc > 0 ? args[0] : naNil();
-    if(!naIsNum(id))
-        return naNil();
+    map<int, FGNasalListener *>::iterator it = _listener.find(int(id.num));
 
-    int i = int(id.num);
-    if (_listener.find(i) == _listener.end())
+    if(!naIsNum(id) || it == _listener.end() || it->second->_dead) {
+        naRuntimeError(c, "removelistener() with invalid listener id");
         return naNil();
+    }
 
-    FGNasalListener *nl = _listener[i];
-    nl->_node->removeChangeListener(nl);
-    _listener.erase(i);
+    FGNasalListener *nl = it->second;
+    if(nl->_active) {
+        nl->_dead = true;
+        _purgeListeners = true;
+        return naNum(-1);
+    }
+
+    _listener.erase(it);
     delete nl;
     return naNum(_listener.size());
 }
 
 
 
+// FGNasalListener class.
+
+FGNasalListener::FGNasalListener(SGPropertyNode_ptr node, naRef handler,
+                                 FGNasalSys* nasal, int key) :
+    _node(node),
+    _handler(handler),
+    _gcKey(key),
+    _nas(nasal),
+    _active(0),
+    _dead(false)
+{
+}
+
+FGNasalListener::~FGNasalListener()
+{
+    _node->removeChangeListener(this);
+    _nas->gcRelease(_gcKey);
+}
+
+void FGNasalListener::valueChanged(SGPropertyNode* node)
+{
+    // drop recursive listener calls
+    if(_active || _dead)
+        return;
+
+    _active++;
+    _nas->_cmdArg = node;
+    _nas->call(_handler, naNil());
+    _active--;
+}
+
+
+
+
 // FGNasalModelData class.  If sgLoad3DModel() is called with a pointer to
-// such a class, then the modelLoaded() function is executed by the loader,
-// and the destructor when the model branch is removed from the scene graph.
-// They are used for calling a model's <load> and <unload> scripts.
+// such a class, then it lets modelLoaded() run the <load> script, and the
+// destructor the <unload> script. The latter happens when the model branch
+// is removed from the scene graph.
 
 void FGNasalModelData::modelLoaded(const string& path, SGPropertyNode *prop,
-                                   ssgBranch *)
+                                   osg::Node *)
 {
     SGPropertyNode *n = prop->getNode("nasal"), *load;
-    if (!n)
+    if(!n)
         return;
 
     load = n->getNode("load");
     _unload = n->getNode("unload");
-    if (!load && !_unload)
+    if(!load && !_unload)
         return;
 
     _module = path;
@@ -693,11 +786,17 @@ void FGNasalModelData::modelLoaded(const string& path, SGPropertyNode *prop,
 
 FGNasalModelData::~FGNasalModelData()
 {
-    if (_module.empty())
+    if(_module.empty())
         return;
 
     FGNasalSys *nas = (FGNasalSys *)globals->get_subsystem("nasal");
-    if (_unload) {
+    if(!nas) {
+        SG_LOG(SG_NASAL, SG_ALERT, "Trying to run an <unload> script "
+                "without Nasal subsystem present.");
+        return;
+    }
+
+    if(_unload) {
         const char *s = _unload->getStringValue();
         nas->createModule(_module.c_str(), _module.c_str(), s, strlen(s));
     }