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>
12 // Required only for MSVC
14 # include <Scripting/NasalModelData.hxx>
21 class FGNasalListener;
23 class FGNasalModelData;
25 class FGNasalModuleListener;
27 namespace simgear { class BufferedLogCallback; }
29 SGPropertyNode* ghostToPropNode(naRef ref);
30 SGCondition* conditionGhost(naRef r);
32 class FGNasalSys : public SGSubsystem
36 virtual ~FGNasalSys();
38 virtual void shutdown();
40 virtual void update(double dt);
42 // Loads a nasal script from an external file and inserts it as a
43 // global module of the specified name.
44 bool loadModule(SGPath file, const char* moduleName);
46 // Simple hook to run arbitrary source code. Returns a bool to
47 // indicate successful execution. Does *not* return any Nasal
48 // values, because handling garbage-collected objects from C space
49 // is deep voodoo and violates the "simple hook" idea.
50 bool parseAndRun(const char* sourceCode);
52 // Slightly more complicated hook to get a handle to a precompiled
53 // Nasal script that can be invoked via a call() method. The
54 // caller is expected to delete the FGNasalScript returned from
55 // this function. The "name" argument specifies the "file name"
56 // for the source code that will be printed in Nasal stack traces
58 // FGNasalScript* parseScript(const char* src, const char* name=0);
60 // Implementation of the settimer extension function
61 void setTimer(naContext c, int argc, naRef* args);
63 // Implementation of the setlistener extension function
64 naRef setListener(naContext c, int argc, naRef* args);
65 naRef removeListener(naContext c, int argc, naRef* args);
67 // Returns a ghost wrapper for the current _cmdArg
70 void setCmdArg(SGPropertyNode* aNode);
73 * create Nasal props.Node for an SGPropertyNode*
74 * This is the actual ghost, wrapped in a Nasal sugar class.
76 naRef wrappedPropsNode(SGPropertyNode* aProps);
78 // Callbacks for command and timer bindings
79 virtual bool handleCommand( const char* moduleName,
82 const SGPropertyNode* arg = 0 );
83 virtual bool handleCommand(const SGPropertyNode* arg);
85 bool createModule(const char* moduleName, const char* fileName,
86 const char* src, int len, const SGPropertyNode* cmdarg=0,
87 int argc=0, naRef*args=0);
89 void deleteModule(const char* moduleName);
91 void addCommand(naRef func, const std::string& name);
92 void removeCommand(const std::string& name);
95 * Set member of specified hash to given value
97 void hashset(naRef hash, const char* key, naRef val);
100 * Set member of globals hash to given value
102 void globalsSet(const char* key, naRef val);
104 naRef call(naRef code, int argc, naRef* args, naRef locals);
106 naRef callMethod(naRef code, naRef self, int argc, naRef* args, naRef locals);
108 naRef propNodeGhost(SGPropertyNode* handle);
110 void registerToLoad(FGNasalModelData* data);
111 void registerToUnload(FGNasalModelData* data);
113 // can't call this 'globals' due to naming clash
114 naRef nasalGlobals() const
117 nasal::Hash getGlobals() const
118 { return nasal::Hash(_globals, _context); }
120 // This mechanism is here to allow naRefs to be passed to
121 // locations "outside" the interpreter. Normally, such a
122 // reference would be garbage collected unexpectedly. By passing
123 // it to gcSave and getting a key/handle, it can be cached in a
124 // globals.__gcsave hash. Be sure to release it with gcRelease
127 void gcRelease(int key);
129 /// retrive the associated log object, for displaying log
130 /// output somewhere (a UI, presumably)
131 simgear::BufferedLogCallback* log() const
134 //friend class FGNasalScript;
135 friend class FGNasalListener;
136 friend class FGNasalModuleListener;
138 SGLockedQueue<SGSharedPtr<FGNasalModelData> > _loadList;
139 SGLockedQueue<SGSharedPtr<FGNasalModelData> > _unloadList;
141 // Delay removing items of the _loadList to ensure the are already attached
142 // to the scene graph (eg. enables to retrieve world position in load
147 // FGTimer subclass for handling Nasal timer callbacks.
148 // See the implementation of the settimer() extension function for
152 virtual void timerExpired();
153 virtual ~NasalTimer() {}
160 std::map<int, FGNasalListener *> _listener;
161 std::vector<FGNasalListener *> _dead_listener;
163 std::vector<FGNasalModuleListener*> _moduleListeners;
165 static int _listenerId;
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();
180 SGPropertyNode_ptr _cmdArg;
182 simgear::BufferedLogCallback* _log;
184 typedef std::map<std::string, NasalCommand*> NasalCommandDict;
185 NasalCommandDict _commands;
187 naRef _wrappedNodeFunc;
189 void handleTimer(NasalTimer* t);
193 class FGNasalScript {
195 ~FGNasalScript() { _nas->gcRelease(_gcKey); }
199 naCall(_nas->_context, _code, 0, &n, naNil(), naNil());
200 return naGetError(_nas->_context) == 0;
203 FGNasalSys* sys() const { return _nas; }
205 friend class FGNasalSys;
212 #endif // __NASALSYS_HXX