src/Scripting/NasalSys.hxx

   1 #ifndef __NASALSYS_HXX
   2 #define __NASALSYS_HXX
   3
   4 #include <simgear/misc/sg_path.hxx>
   5 #include <simgear/structure/subsystem_mgr.hxx>
   6 #include <simgear/nasal/nasal.h>
   7 #include <simgear/scene/model/model.hxx>
   8
   9 #include <map>
  10 SG_USING_STD(map);
  11
  12
  13 class FGNasalScript;
  14 class FGNasalListener;
  15
  16 class FGNasalSys : public SGSubsystem
  17 {
  18 public:
  19     FGNasalSys();
  20     virtual ~FGNasalSys();
  21     virtual void init();
  22     virtual void update(double dt) { /* noop */ }
  23
  24     // Loads a nasal script from an external file and inserts it as a
  25     // global module of the specified name.
  26     void loadModule(SGPath file, const char* moduleName);
  27
  28     // Simple hook to run arbitrary source code.  Returns a bool to
  29     // indicate successful execution.  Does *not* return any Nasal
  30     // values, because handling garbage-collected objects from C space
  31     // is deep voodoo and violates the "simple hook" idea.
  32     bool parseAndRun(const char* sourceCode);
  33
  34     // Slightly more complicated hook to get a handle to a precompiled
  35     // Nasal script that can be invoked via a call() method.  The
  36     // caller is expected to delete the FGNasalScript returned from
  37     // this function.  The "name" argument specifies the "file name"
  38     // for the source code that will be printed in Nasal stack traces
  39     // on error.
  40     FGNasalScript* parseScript(const char* src, const char* name=0);
  41
  42     // Implementation of the settimer extension function
  43     void setTimer(int argc, naRef* args);
  44
  45     // Implementation of the setlistener extension function
  46     naRef setListener(int argc, naRef* args);
  47     naRef removeListener(int argc, naRef* args);
  48
  49     // Returns a ghost wrapper for the current _cmdArg
  50     naRef cmdArgGhost();
  51
  52     // Callbacks for command and timer bindings
  53     virtual bool handleCommand(const SGPropertyNode* arg);
  54
  55     void createModule(const char* moduleName, const char* fileName,
  56                     const char* src, int len, const SGPropertyNode* arg=0);
  57
  58     void deleteModule(const char* moduleName);
  59
  60     naRef call(naRef code, naRef locals);
  61
  62 private:
  63     friend class FGNasalScript;
  64     friend class FGNasalListener;
  65
  66     //
  67     // FGTimer subclass for handling Nasal timer callbacks.
  68     // See the implementation of the settimer() extension function for
  69     // more notes.
  70     //
  71     struct NasalTimer {
  72         virtual void timerExpired();
  73         naRef handler;
  74         int gcKey;
  75         FGNasalSys* nasal;
  76     };
  77
  78     // Listener
  79     map<int, FGNasalListener *> _listener;
  80     static int _listenerId;
  81
  82     void loadPropertyScripts();
  83     void hashset(naRef hash, const char* key, naRef val);
  84     void logError(naContext);
  85     naRef parse(const char* filename, const char* buf, int len);
  86     naRef genPropsModule();
  87     naRef propNodeGhost(SGPropertyNode* handle);
  88
  89     // This mechanism is here to allow naRefs to be passed to
  90     // locations "outside" the interpreter.  Normally, such a
  91     // reference would be garbage collected unexpectedly.  By passing
  92     // it to gcSave and getting a key/handle, it can be cached in a
  93     // globals.__gcsave hash.  Be sure to release it with gcRelease
  94     // when done.
  95     int gcSave(naRef r);
  96     void gcRelease(int key);
  97
  98     naContext _context;
  99     naRef _globals;
 100
 101     SGPropertyNode_ptr _cmdArg;
 102
 103     int _nextGCKey;
 104     naRef _gcHash;
 105     int _callCount;
 106
 107     public: void handleTimer(NasalTimer* t);
 108 };
 109
 110
 111 class FGNasalScript {
 112 public:
 113     ~FGNasalScript() { _nas->gcRelease(_gcKey); }
 114
 115     bool call() {
 116         naRef n = naNil();
 117         naCall(_nas->_context, _code, 0, &n, naNil(), naNil());
 118         return naGetError(_nas->_context) == 0;
 119     }
 120
 121 private:
 122     friend class FGNasalSys;
 123     naRef _code;
 124     int _gcKey;
 125     FGNasalSys* _nas;
 126 };
 127
 128
 129 class FGNasalListener : public SGPropertyChangeListener {
 130 public:
 131     FGNasalListener(SGPropertyNode_ptr node, naRef handler,
 132                     FGNasalSys* nasal, int key);
 133
 134     ~FGNasalListener();
 135     void valueChanged(SGPropertyNode* node);
 136
 137 private:
 138     friend class FGNasalSys;
 139     SGPropertyNode_ptr _node;
 140     naRef _handler;
 141     int _gcKey;
 142     FGNasalSys* _nas;
 143     unsigned int _active;
 144 };
 145
 146
 147 class FGNasalModelData : public SGModelData {
 148 public:
 149     FGNasalModelData() : _unload(0) {}
 150     ~FGNasalModelData();
 151     void modelLoaded(const string& path, SGPropertyNode *prop, ssgBranch *);
 152
 153 private:
 154     string _module;
 155     SGConstPropertyNode_ptr _unload;
 156 };
 157
 158 #endif // __NASALSYS_HXX