]> 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 4c8eddbb1295ddeaadd7412b8ac98feb880966c3..a270a27d189934ecc0b130bb995640838a9043e3 100644 (file)
@@ -1,3 +1,8 @@
+
+#ifdef HAVE_CONFIG_H
+#  include "config.h"
+#endif
+
 #include <string.h>
 #include <stdio.h>
 #include <sys/types.h>
@@ -16,7 +21,6 @@
 #include <Main/fg_props.hxx>
 
 #include "NasalSys.hxx"
-#include "NasalDisplay.hxx"
 
 // 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
@@ -52,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
@@ -71,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();
-    return false;
+    call(code, naNil());
+    return true;
 }
 
 FGNasalScript* FGNasalSys::parseScript(const char* src, const char* name)
@@ -120,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;
 }
@@ -181,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
 }
@@ -221,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
@@ -235,13 +273,20 @@ static naRef f_settimer(naContext c, naRef me, int argc, naRef* args)
     return naNil();
 }
 
-// setlistener(func, property) extension function.  Falls through to
+// 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)
 {
     FGNasalSys* nasal = (FGNasalSys*)globals->get_subsystem("nasal");
-    nasal->setListener(argc, args);
-    return naNil();
+    return nasal->setListener(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)
+{
+    FGNasalSys* nasal = (FGNasalSys*)globals->get_subsystem("nasal");
+    return nasal->removeListener(c, argc, args);
 }
 
 // Returns a ghost handle to the argument to the currently executing
@@ -288,15 +333,27 @@ static naRef f_rand(naContext c, naRef me, int argc, naRef* args)
     return naNum(sg_random());
 }
 
-// Wrapper function for screenPrint
-static naRef f_screenPrint(naContext c, naRef me, int argc, naRef* args)
+static naRef f_srand(naContext c, naRef me, int argc, naRef* args)
+{
+    sg_srandom_time();
+    return naNum(0);
+}
+
+// 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 screenPrint()");
-    naRef lmsg = args[0];
-    FGNasalSys* nasal = (FGNasalSys*)globals->get_subsystem("nasal");
-    nasal->screenPrint(naStr_data(lmsg));
-    return naNil();
+        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;
 }
 
 // Table of extension functions.  Terminate with zeros.
@@ -307,10 +364,12 @@ static struct { char* name; naCFunction func; } funcs[] = {
     { "_fgcommand", f_fgcommand },
     { "settimer",  f_settimer },
     { "_setlistener", f_setlistener },
+    { "removelistener", f_removelistener },
     { "_cmdarg",  f_cmdarg },
     { "_interpolate",  f_interpolate },
     { "rand",  f_rand },
-    { "screenPrint", f_screenPrint },
+    { "srand",  f_srand },
+    { "directory", f_directory },
     { 0, 0 }
 };
 
@@ -336,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,
@@ -362,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()
 {
@@ -418,17 +504,17 @@ void FGNasalSys::loadPropertyScripts()
 }
 
 // Logs a runtime error, with stack trace, to the FlightGear log stream
-void FGNasalSys::logError()
+void FGNasalSys::logError(naContext context)
 {
     SG_LOG(SG_NASAL, SG_ALERT,
-           "Nasal runtime error: " << naGetError(_context));
+           "Nasal runtime error: " << naGetError(context));
     SG_LOG(SG_NASAL, SG_ALERT,
-           "  at " << naStr_data(naGetSourceFile(_context, 0)) <<
-           ", line " << naGetLine(_context, 0));
-    for(int i=1; i<naStackDepth(_context); i++)
+           "  at " << naStr_data(naGetSourceFile(context, 0)) <<
+           ", line " << naGetLine(context, 0));
+    for(int i=1; i<naStackDepth(context); i++)
         SG_LOG(SG_NASAL, SG_ALERT,
-               "  called from: " << naStr_data(naGetSourceFile(_context, i)) <<
-               ", line " << naGetLine(_context, i));
+               "  called from: " << naStr_data(naGetSourceFile(context, i)) <<
+               ", line " << naGetLine(context, i));
 }
 
 // Reads a script file, executes it, and places the resulting
@@ -450,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))
@@ -467,14 +555,19 @@ 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();
-        return;
-    }
+    _cmdArg = (SGPropertyNode*)arg;
+
+    call(code, locals);
     hashset(_globals, moduleName, locals);
 }
 
+void FGNasalSys::deleteModule(const char* moduleName)
+{
+    naRef modname = naNewString(_context);
+    naStr_fromdata(modname, (char*)moduleName, strlen(moduleName));
+    naHash_delete(_globals, modname);
+}
+
 naRef FGNasalSys::parse(const char* filename, const char* buf, int len)
 {
     int errLine = -1;
@@ -499,12 +592,13 @@ bool FGNasalSys::handleCommand(const SGPropertyNode* arg)
     naRef code = parse(arg->getPath(true), nasal, strlen(nasal));
     if(naIsNil(code)) return false;
 
+    naContext c = naNewContext();
     naRef locals = naNil();
-    if (moduleName[0]) {
-        naRef modname = naNewString(_context);
+    if(moduleName[0]) {
+        naRef modname = naNewString(c);
         naStr_fromdata(modname, (char*)moduleName, strlen(moduleName));
         if(!naHash_get(_globals, modname, &locals))
-            locals = naNewHash(_context);
+            locals = naNewHash(c);
     }
     // Cache the command argument for inspection via cmdarg().  For
     // performance reasons, we won't bother with it if the invoked
@@ -512,10 +606,8 @@ bool FGNasalSys::handleCommand(const SGPropertyNode* arg)
     _cmdArg = (SGPropertyNode*)arg;
 
     // Call it!
-    naRef result = naCall(_context, code, 0, 0, naNil(), locals);
-    if(!naGetError(_context)) return true;
-    logError();
-    return false;
+    call(code, locals);
+    return true;
 }
 
 // settimer(func, dt, simtime) extension function.  The first argument
@@ -537,7 +629,7 @@ void FGNasalSys::setTimer(int argc, naRef* args)
 
     naRef delta = argc > 1 ? args[1] : naNil();
     if(naIsNil(delta)) return;
-    
+
     bool simtime = (argc > 2 && naTrue(args[2])) ? false : true;
 
     // Generate and register a C++ timer handler
@@ -553,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();
+    call(t->handler, naNil());
     gcRelease(t->gcKey);
 }
 
@@ -577,26 +667,140 @@ void FGNasalSys::NasalTimer::timerExpired()
     delete this;
 }
 
-// setlistener(property, func) extension function.  The first argument
+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.
-void FGNasalSys::setListener(int argc, naRef* args)
+// 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.
+naRef FGNasalSys::setListener(int argc, naRef* args)
 {
-    SGPropertyNode* node;
+    SGPropertyNode_ptr 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;
+    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();
+
+    bool initial = argc > 2 && naTrue(args[2]);
+
+    FGNasalListener *nl = new FGNasalListener(node, handler, this,
+            gcSave(handler));
+    node->addChangeListener(nl, initial);
+
+    _listener[_listenerId] = nl;
+    return naNum(_listenerId++);
+}
+
+// removelistener(int) extension function. The argument is the id of
+// a listener as returned by the setlistener() function.
+naRef FGNasalSys::removeListener(naContext c, int argc, naRef* args)
+{
+    naRef id = argc > 0 ? args[0] : naNil();
+    map<int, FGNasalListener *>::iterator it = _listener.find(int(id.num));
+
+    if(!naIsNum(id) || it == _listener.end() || it->second->_dead) {
+        naRuntimeError(c, "removelistener() with invalid listener id");
+        return naNil();
+    }
+
+    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;
 
-    node->addChangeListener(new FGNasalListener(handler, this, gcSave(handler)));
+    _active++;
+    _nas->_cmdArg = node;
+    _nas->call(_handler, naNil());
+    _active--;
 }
 
-// functions providing access to the NasalDisplay - used to display text directly on the screen
-void FGNasalSys::screenPrint(const char* src)
+
+
+
+// FGNasalModelData class.  If sgLoad3DModel() is called with a pointer to
+// 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,
+                                   osg::Node *)
 {
-  globals->get_Nasal_display()->RegisterSingleMessage(src, 0);
+    SGPropertyNode *n = prop->getNode("nasal"), *load;
+    if(!n)
+        return;
+
+    load = n->getNode("load");
+    _unload = n->getNode("unload");
+    if(!load && !_unload)
+        return;
+
+    _module = path;
+    const char *s = load ? load->getStringValue() : "";
+    FGNasalSys *nas = (FGNasalSys *)globals->get_subsystem("nasal");
+    nas->createModule(_module.c_str(), _module.c_str(), s, strlen(s));
 }
+
+FGNasalModelData::~FGNasalModelData()
+{
+    if(_module.empty())
+        return;
+
+    FGNasalSys *nas = (FGNasalSys *)globals->get_subsystem("nasal");
+    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));
+    }
+    nas->deleteModule(_module.c_str());
+}
+
+