]> git.mxchange.org Git - flightgear.git/blobdiff - src/Scripting/NasalSys.cxx
- fix carttogeod() function (don't convert the altitude from radian to degree ;-)
[flightgear.git] / src / Scripting / NasalSys.cxx
index 9d04fb2952691e5d6cadc3753ad7592faab9596e..991147e790c5619d3b4e0ad14e24f86fe1f47612 100644 (file)
@@ -3,10 +3,15 @@
 #  include "config.h"
 #endif
 
+#ifdef HAVE_SYS_TIME_H
+#  include <sys/time.h>  // gettimeofday
+#endif
+
 #include <string.h>
 #include <stdio.h>
 #include <sys/types.h>
 #include <sys/stat.h>
+#include <fstream>
 
 #include <plib/ul.h>
 
 #include <simgear/math/sg_random.h>
 #include <simgear/misc/sg_path.hxx>
 #include <simgear/misc/interpolator.hxx>
+#include <simgear/scene/material/mat.hxx>
 #include <simgear/structure/commands.hxx>
+#include <simgear/math/sg_geodesy.hxx>
 
 #include <Main/globals.hxx>
 #include <Main/fg_props.hxx>
+#include <Scenery/scenery.hxx>
 
 #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.
@@ -52,11 +63,13 @@ static char* readfile(const char* file, int* lenOut)
 
 FGNasalSys::FGNasalSys()
 {
+    nasalSys = this;
     _context = 0;
     _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
@@ -81,16 +94,12 @@ naRef FGNasalSys::call(naRef code, naRef locals)
 
 FGNasalSys::~FGNasalSys()
 {
+    nasalSys = 0;
     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
-    // is technically leaked (although the GC pool memory obviously
-    // won't be freed).
-    _context = 0;
+    naFreeContext(_context);
     _globals = naNil();
 }
 
@@ -112,7 +121,7 @@ FGNasalScript* FGNasalSys::parseScript(const char* src, const char* name)
 
     char buf[256];
     if(!name) {
-        sprintf(buf, "FGNasalScript@%p", script);
+        sprintf(buf, "FGNasalScript@%p", (void *)script);
         name = buf;
     }
 
@@ -231,24 +240,15 @@ static naRef f_setprop(naContext c, naRef me, int argc, naRef* args)
 // make sure it appears.  Is there better way to do this?
 static naRef f_print(naContext c, naRef me, int argc, naRef* args)
 {
-#define BUFLEN 1024
-    char buf[BUFLEN + 1];
-    buf[BUFLEN] = 0; // extra nul to handle strncpy brain damage
-    buf[0] = 0; // Zero-length in case there are no arguments
-    char* p = buf;
-    int buflen = BUFLEN;
+    string buf;
     int n = argc;
     for(int i=0; i<n; i++) {
         naRef s = naStringValue(c, args[i]);
         if(naIsNil(s)) continue;
-        strncpy(p, naStr_data(s), buflen);
-        p += naStr_len(s);
-        buflen = BUFLEN - (p - buf);
-        if(buflen <= 0) break;
+        buf += naStr_data(s);
     }
     SG_LOG(SG_GENERAL, SG_ALERT, buf);
-    return naNil();
-#undef BUFLEN
+    return naNum(buf.length());
 }
 
 // fgcommand() extension function.  Executes a named command via the
@@ -256,10 +256,17 @@ static naRef f_print(naContext c, naRef me, int argc, naRef* args)
 // an argument.
 static naRef f_fgcommand(naContext c, naRef me, int argc, naRef* args)
 {
-    if(argc < 2 || !naIsString(args[0]) || !naIsGhost(args[1]))
+    naRef cmd = argc > 0 ? args[0] : naNil();
+    naRef props = argc > 1 ? args[1] : naNil();
+    if(!naIsString(cmd) || (!naIsNil(props) && !naIsGhost(props)))
         naRuntimeError(c, "bad arguments to fgcommand()");
-    naRef cmd = args[0], props = args[1];
-    SGPropertyNode_ptr* node = (SGPropertyNode_ptr*)naGhost_ptr(props);
+    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));
 }
 
@@ -267,8 +274,7 @@ static naRef f_fgcommand(naContext c, naRef me, int argc, naRef* args)
 // FGNasalSys::setTimer().  See there for docs.
 static naRef f_settimer(naContext c, naRef me, int argc, naRef* args)
 {
-    FGNasalSys* nasal = (FGNasalSys*)globals->get_subsystem("nasal");
-    nasal->setTimer(argc, args);
+    nasalSys->setTimer(c, argc, args);
     return naNil();
 }
 
@@ -276,24 +282,21 @@ static naRef f_settimer(naContext c, naRef me, int argc, naRef* args)
 // 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");
-    return nasal->setListener(argc, 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)
 {
-    FGNasalSys* nasal = (FGNasalSys*)globals->get_subsystem("nasal");
-    return nasal->removeListener(c, argc, 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)
 {
-    FGNasalSys* nasal = (FGNasalSys*)globals->get_subsystem("nasal");
-    return nasal->cmdArgGhost();
+    return nasalSys->cmdArgGhost();
 }
 
 // Sets up a property interpolation.  The first argument is either a
@@ -318,7 +321,8 @@ static naRef f_interpolate(naContext c, naRef me, int argc, naRef* args)
         deltas[i] = naNumValue(naVec_get(curve, 2*i+1)).num;
     }
 
-    ((SGInterpolator*)globals->get_subsystem("interpolator"))
+    ((SGInterpolator*)globals->get_subsystem_mgr()
+        ->get_group(SGSubsystemMgr::INIT)->get_subsystem("interpolator"))
         ->interpolate(node, nPoints, values, deltas);
 
     return naNil();
@@ -355,6 +359,128 @@ static naRef f_directory(naContext c, naRef me, int argc, naRef* args)
     return result;
 }
 
+// Parse XML file.
+//     parsexml(<path> [, <start-tag> [, <end-tag> [, <data> [, <pi>]]]]);
+//
+// <path>      ... absolute path of an XML file
+// <start-tag> ... callback function with two args: tag name, attribute hash
+// <end-tag>   ... callback function with one arg:  tag name
+// <data>      ... callback function with one arg:  data
+// <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.
+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<argc; i++)
+        if(!(naIsNil(args[i]) || naIsFunc(args[i])))
+            naRuntimeError(c, "parsexml(): callback argument not a function");
+
+    const char* file = naStr_data(args[0]);
+    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());
+        return naNil();
+    }
+    return args[0];
+}
+
+// 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<string> n = mat->get_names();
+        for(unsigned int i=0; i<n.size(); i++)
+            naVec_append(names, naStr_fromdata(naNewString(c),
+                    const_cast<char*>(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
+}
+
 // Table of extension functions.  Terminate with zeros.
 static struct { char* name; naCFunction func; } funcs[] = {
     { "getprop",   f_getprop },
@@ -369,6 +495,11 @@ static struct { char* name; naCFunction func; } funcs[] = {
     { "rand",  f_rand },
     { "srand",  f_srand },
     { "directory", f_directory },
+    { "parsexml", f_parsexml },
+    { "systime", f_systime },
+    { "carttogeod", f_carttogeod },
+    { "geodtocart", f_geodtocart },
+    { "geodinfo", f_geodinfo },
     { 0, 0 }
 };
 
@@ -387,17 +518,15 @@ void FGNasalSys::init()
     // sub-reference under the name "globals".  This gives client-code
     // write access to the namespace if someone wants to do something
     // fancy.
-    _globals = naStdLib(_context);
+    _globals = naInit_std(_context);
     naSave(_context, _globals);
     hashset(_globals, "globals", _globals);
 
-    // 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));
+    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++)
@@ -437,6 +566,23 @@ void FGNasalSys::init()
     loadPropertyScripts();
 }
 
+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;
+            }
+        }
+    }
+}
+
 // Loads the scripts found under /nasal in the global tree
 void FGNasalSys::loadPropertyScripts()
 {
@@ -474,7 +620,7 @@ void FGNasalSys::loadPropertyScripts()
             loadModule(p, module);
         }
         */
-        
+
         const char* src = n->getStringValue("script");
         if(!n->hasChild("script")) src = 0; // Hrm...
         if(src)
@@ -576,20 +722,24 @@ bool FGNasalSys::handleCommand(const SGPropertyNode* arg)
     naRef code = parse(arg->getPath(true), nasal, strlen(nasal));
     if(naIsNil(code)) return false;
 
-    naContext c = naNewContext();
+    // Commands can be run "in" a module.  Make sure that module
+    // exists, and set it up as the local variables hash for the
+    // command.
     naRef locals = naNil();
     if(moduleName[0]) {
-        naRef modname = naNewString(c);
+        naRef modname = naNewString(_context);
         naStr_fromdata(modname, (char*)moduleName, strlen(moduleName));
-        if(!naHash_get(_globals, modname, &locals))
-            locals = naNewHash(c);
+        if(!naHash_get(_globals, modname, &locals)) {
+            locals = naNewHash(_context);
+            naHash_set(_globals, modname, locals);
+        }
     }
-    // Cache the command argument for inspection via cmdarg().  For
+
+    // Cache this command's argument for inspection via cmdarg().  For
     // performance reasons, we won't bother with it if the invoked
     // code doesn't need it.
     _cmdArg = (SGPropertyNode*)arg;
 
-    // Call it!
     call(code, locals);
     return true;
 }
@@ -604,15 +754,20 @@ bool FGNasalSys::handleCommand(const SGPropertyNode* arg)
 // "saved" somehow lest they be inadvertently cleaned.  In this case,
 // they are inserted into a globals.__gcsave hash and removed on
 // expiration.
-void FGNasalSys::setTimer(int argc, naRef* args)
+void FGNasalSys::setTimer(naContext c, int argc, naRef* args)
 {
     // Extract the handler, delta, and simtime arguments:
     naRef handler = argc > 0 ? args[0] : naNil();
-    if(!(naIsCode(handler) || naIsCCode(handler) || naIsFunc(handler)))
+    if(!(naIsCode(handler) || naIsCCode(handler) || naIsFunc(handler))) {
+        naRuntimeError(c, "settimer() with invalid function argument");
         return;
+    }
 
     naRef delta = argc > 1 ? args[1] : naNil();
-    if(naIsNil(delta)) return;
+    if(naIsNil(delta)) {
+        naRuntimeError(c, "settimer() with invalid time argument");
+        return;
+    }
 
     bool simtime = (argc > 2 && naTrue(args[2])) ? false : true;
 
@@ -659,26 +814,31 @@ int FGNasalSys::_listenerId = 0;
 // 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)
+naRef FGNasalSys::setListener(naContext c, int argc, naRef* args)
 {
     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 naNil();
+    else {
+        naRuntimeError(c, "setlistener() with invalid property argument");
+        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)))
+    if(!(naIsCode(handler) || naIsCCode(handler) || naIsFunc(handler))) {
+        naRuntimeError(c, "setlistener() with invalid function argument");
         return naNil();
+    }
 
     bool initial = argc > 2 && naTrue(args[2]);
 
     FGNasalListener *nl = new FGNasalListener(node, handler, this,
-            gcSave(handler));
+            gcSave(handler), _listenerId);
     node->addChangeListener(nl, initial);
 
     _listener[_listenerId] = nl;
@@ -690,20 +850,21 @@ naRef FGNasalSys::setListener(int argc, naRef* args)
 naRef FGNasalSys::removeListener(naContext c, int argc, naRef* args)
 {
     naRef id = argc > 0 ? args[0] : naNil();
-    int i = int(id.num);
+    map<int, FGNasalListener *>::iterator it = _listener.find(int(id.num));
 
-    if(!naIsNum(id) || _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];
+    FGNasalListener *nl = it->second;
     if(nl->_active) {
-        naRuntimeError(c, "trying to remove active listener");
-        return naNil();
+        nl->_dead = true;
+        _purgeListeners = true;
+        return naNum(-1);
     }
 
-    _listener.erase(i);
+    _listener.erase(it);
     delete nl;
     return naNum(_listener.size());
 }
@@ -713,12 +874,14 @@ naRef FGNasalSys::removeListener(naContext c, int argc, naRef* args)
 // FGNasalListener class.
 
 FGNasalListener::FGNasalListener(SGPropertyNode_ptr node, naRef handler,
-                                 FGNasalSys* nasal, int key) :
+                                 FGNasalSys* nasal, int key, int id) :
     _node(node),
     _handler(handler),
     _gcKey(key),
+    _id(id),
     _nas(nasal),
-    _active(0)
+    _active(0),
+    _dead(false)
 {
 }
 
@@ -731,9 +894,10 @@ FGNasalListener::~FGNasalListener()
 void FGNasalListener::valueChanged(SGPropertyNode* node)
 {
     // drop recursive listener calls
-    if (_active)
+    if(_active || _dead)
         return;
 
+    SG_LOG(SG_NASAL, SG_DEBUG, "trigger listener #" << _id);
     _active++;
     _nas->_cmdArg = node;
     _nas->call(_handler, naNil());
@@ -762,8 +926,7 @@ void FGNasalModelData::modelLoaded(const string& path, SGPropertyNode *prop,
 
     _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));
+    nasalSys->createModule(_module.c_str(), _module.c_str(), s, strlen(s), _props);
 }
 
 FGNasalModelData::~FGNasalModelData()
@@ -771,8 +934,7 @@ FGNasalModelData::~FGNasalModelData()
     if(_module.empty())
         return;
 
-    FGNasalSys *nas = (FGNasalSys *)globals->get_subsystem("nasal");
-    if(!nas) {
+    if(!nasalSys) {
         SG_LOG(SG_NASAL, SG_ALERT, "Trying to run an <unload> script "
                 "without Nasal subsystem present.");
         return;
@@ -780,9 +942,65 @@ FGNasalModelData::~FGNasalModelData()
 
     if(_unload) {
         const char *s = _unload->getStringValue();
-        nas->createModule(_module.c_str(), _module.c_str(), s, strlen(s));
+        nasalSys->createModule(_module.c_str(), _module.c_str(), s, strlen(s), _props);
+    }
+    nasalSys->deleteModule(_module.c_str());
+}
+
+
+
+// NasalXMLVisitor class: handles EasyXML visitor callback for parsexml()
+//
+NasalXMLVisitor::NasalXMLVisitor(naContext c, int argc, naRef* args) :
+    _c(naSubContext(c)),
+    _start_element(argc > 1 ? args[1] : naNil()),
+    _end_element(argc > 2 ? args[2] : naNil()),
+    _data(argc > 3 ? args[3] : naNil()),
+    _pi(argc > 4 ? args[4] : naNil())
+{
+}
+
+void NasalXMLVisitor::startElement(const char* tag, const XMLAttributes& a)
+{
+    if(naIsNil(_start_element)) return;
+    naRef attr = naNewHash(_c);
+    for(int i=0; i<a.size(); i++) {
+        naRef name = make_string(a.getName(i));
+        naRef value = make_string(a.getValue(i));
+        naHash_set(attr, name, value);
     }
-    nas->deleteModule(_module.c_str());
+    call(_start_element, 2, make_string(tag), attr);
+}
+
+void NasalXMLVisitor::endElement(const char* tag)
+{
+    if(!naIsNil(_end_element)) call(_end_element, 1, make_string(tag));
+}
+
+void NasalXMLVisitor::data(const char* str, int len)
+{
+    if(!naIsNil(_data)) call(_data, 1, make_string(str, len));
+}
+
+void NasalXMLVisitor::pi(const char* target, const char* data)
+{
+    if (!naIsNil(_pi)) call(_pi, 2, make_string(target), make_string(data));
+}
+
+void NasalXMLVisitor::call(naRef func, int num, naRef a, naRef b)
+{
+    naRef args[2];
+    args[0] = a;
+    args[1] = b;
+    naCall(_c, func, num, args, naNil(), naNil());
+    if(naGetError(_c))
+        naRethrowError(_c);
+}
+
+naRef NasalXMLVisitor::make_string(const char* s, int n)
+{
+    return naStr_fromdata(naNewString(_c), const_cast<char *>(s),
+                          n < 0 ? strlen(s) : n);
 }