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/misc/sg_dir.hxx>
   7 #include <simgear/nasal/cppbind/NasalHash.hxx>
   8 #include <simgear/nasal/nasal.h>
   9 #include <simgear/threads/SGQueue.hxx>
  10 #include <simgear/props/props.hxx>
  11
  12 // Required only for MSVC
  13 #ifdef _MSC_VER
  14 #   include <Scripting/NasalModelData.hxx>
  15 #endif
  16
  17 #include <map>
  18
  19
  20 class FGNasalScript;
  21 class FGNasalListener;
  22 class SGCondition;
  23 class FGNasalModelData;
  24 class NasalCommand;
  25
  26 namespace simgear { class BufferedLogCallback; }
  27
  28 SGPropertyNode* ghostToPropNode(naRef ref);
  29 SGCondition* conditionGhost(naRef r);
  30
  31 class FGNasalSys : public SGSubsystem
  32 {
  33 public:
  34     FGNasalSys();
  35     virtual ~FGNasalSys();
  36     virtual void init();
  37     virtual void shutdown();
  38
  39     virtual void update(double dt);
  40
  41     // Loads a nasal script from an external file and inserts it as a
  42     // global module of the specified name.
  43     bool loadModule(SGPath file, const char* moduleName);
  44
  45     // Simple hook to run arbitrary source code.  Returns a bool to
  46     // indicate successful execution.  Does *not* return any Nasal
  47     // values, because handling garbage-collected objects from C space
  48     // is deep voodoo and violates the "simple hook" idea.
  49     bool parseAndRun(const char* sourceCode);
  50
  51     // Slightly more complicated hook to get a handle to a precompiled
  52     // Nasal script that can be invoked via a call() method.  The
  53     // caller is expected to delete the FGNasalScript returned from
  54     // this function.  The "name" argument specifies the "file name"
  55     // for the source code that will be printed in Nasal stack traces
  56     // on error.
  57  //   FGNasalScript* parseScript(const char* src, const char* name=0);
  58
  59     // Implementation of the settimer extension function
  60     void setTimer(naContext c, int argc, naRef* args);
  61
  62     // Implementation of the setlistener extension function
  63     naRef setListener(naContext c, int argc, naRef* args);
  64     naRef removeListener(naContext c, int argc, naRef* args);
  65
  66     // Returns a ghost wrapper for the current _cmdArg
  67     naRef cmdArgGhost();
  68
  69     void setCmdArg(SGPropertyNode* aNode);
  70
  71     /**
  72      * create Nasal props.Node for an SGPropertyNode*
  73      * This is the actual ghost, wrapped in a Nasal sugar class.
  74      */
  75     naRef wrappedPropsNode(SGPropertyNode* aProps);
  76
  77     // Callbacks for command and timer bindings
  78     virtual bool handleCommand( const char* moduleName,
  79                                 const char* fileName,
  80                                 const char* src,
  81                                 const SGPropertyNode* arg = 0 );
  82     virtual bool handleCommand(const SGPropertyNode* arg);
  83
  84     bool createModule(const char* moduleName, const char* fileName,
  85                       const char* src, int len, const SGPropertyNode* cmdarg=0,
  86                       int argc=0, naRef*args=0);
  87
  88     void deleteModule(const char* moduleName);
  89
  90     void addCommand(naRef func, const std::string& name);
  91     void removeCommand(const std::string& name);
  92
  93     /**
  94      * Set member of specified hash to given value
  95      */
  96     void hashset(naRef hash, const char* key, naRef val);
  97
  98     /**
  99      * Set member of globals hash to given value
 100      */
 101     void globalsSet(const char* key, naRef val);
 102
 103     naRef call(naRef code, int argc, naRef* args, naRef locals);
 104
 105     naRef callMethod(naRef code, naRef self, int argc, naRef* args, naRef locals);
 106
 107     naRef propNodeGhost(SGPropertyNode* handle);
 108
 109     void registerToLoad(FGNasalModelData* data);
 110     void registerToUnload(FGNasalModelData* data);
 111
 112     // can't call this 'globals' due to naming clash
 113     naRef nasalGlobals() const
 114     { return _globals; }
 115
 116     naContext context() const
 117     { return _context; }
 118
 119     nasal::Hash getGlobals() const
 120     { return nasal::Hash(_globals, _context); }
 121
 122     // This mechanism is here to allow naRefs to be passed to
 123     // locations "outside" the interpreter.  Normally, such a
 124     // reference would be garbage collected unexpectedly.  By passing
 125     // it to gcSave and getting a key/handle, it can be cached in a
 126     // globals.__gcsave hash.  Be sure to release it with gcRelease
 127     // when done.
 128     int gcSave(naRef r);
 129     void gcRelease(int key);
 130
 131     /// retrive the associated log object, for displaying log
 132     /// output somewhere (a UI, presumably)
 133     simgear::BufferedLogCallback* log() const
 134     { return _log; }
 135 private:
 136     //friend class FGNasalScript;
 137     friend class FGNasalListener;
 138     friend class FGNasalModuleListener;
 139
 140     SGLockedQueue<SGSharedPtr<FGNasalModelData> > _loadList;
 141     SGLockedQueue<SGSharedPtr<FGNasalModelData> > _unloadList;
 142
 143     // Delay removing items of the _loadList to ensure the are already attached
 144     // to the scene graph (eg. enables to retrieve world position in load
 145     // callback).
 146     bool _delay_load;
 147
 148     //
 149     // FGTimer subclass for handling Nasal timer callbacks.
 150     // See the implementation of the settimer() extension function for
 151     // more notes.
 152     //
 153     struct NasalTimer {
 154         virtual void timerExpired();
 155         virtual ~NasalTimer() {}
 156         naRef handler;
 157         int gcKey;
 158         FGNasalSys* nasal;
 159     };
 160
 161     // Listener
 162     std::map<int, FGNasalListener *> _listener;
 163     std::vector<FGNasalListener *> _dead_listener;
 164
 165     static int _listenerId;
 166
 167     void loadPropertyScripts();
 168     void loadPropertyScripts(SGPropertyNode* n);
 169     void loadScriptDirectory(simgear::Dir nasalDir);
 170     void addModule(std::string moduleName, simgear::PathList scripts);
 171     static void logError(naContext);
 172     naRef parse(const char* filename, const char* buf, int len);
 173     naRef genPropsModule();
 174
 175     naContext _context;
 176     naRef _globals,
 177           _string;
 178
 179     SGPropertyNode_ptr _cmdArg;
 180
 181     simgear::BufferedLogCallback* _log;
 182
 183     typedef std::map<std::string, NasalCommand*> NasalCommandDict;
 184     NasalCommandDict _commands;
 185 public:
 186     void handleTimer(NasalTimer* t);
 187 };
 188
 189 #if 0
 190 class FGNasalScript {
 191 public:
 192     ~FGNasalScript() { _nas->gcRelease(_gcKey); }
 193
 194     bool call() {
 195         naRef n = naNil();
 196         naCall(_nas->_context, _code, 0, &n, naNil(), naNil());
 197         return naGetError(_nas->_context) == 0;
 198     }
 199
 200     FGNasalSys* sys() const { return _nas; }
 201 private:
 202     friend class FGNasalSys;
 203     naRef _code;
 204     int _gcKey;
 205     FGNasalSys* _nas;
 206 };
 207 #endif
 208
 209 #endif // __NASALSYS_HXX