summaryrefslogtreecommitdiff
path: root/src/script/squirrel.hpp
diff options
context:
space:
mode:
authortruebrain <truebrain@openttd.org>2009-01-12 17:11:45 +0000
committertruebrain <truebrain@openttd.org>2009-01-12 17:11:45 +0000
commita3dd7506d377b1434f913bd65c019eed52b64b6e (patch)
treeced1a262eb143ad6e64ec02f4a4c89835c0c32fd /src/script/squirrel.hpp
parent9294f9616866b9778c22076c19b5a32b4f85f788 (diff)
downloadopenttd-a3dd7506d377b1434f913bd65c019eed52b64b6e.tar.xz
(svn r15027) -Merge: tomatos and bananas left to be, here is NoAI for all to see.
NoAI is an API (a framework) to build your own AIs in. See: http://wiki.openttd.org/wiki/index.php/AI:Main_Page With many thanks to: - glx and Rubidium for their syncing, feedback and hard work - Yexo for his feedback, patches, and AIs which tested the system very deep - Morloth for his feedback and patches - TJIP for hosting a challenge which kept NoAI on track - All AI authors for testing our AI API, and all other people who helped in one way or another -Remove: all old AIs and their cheats/hacks
Diffstat (limited to 'src/script/squirrel.hpp')
-rw-r--r--src/script/squirrel.hpp185
1 files changed, 185 insertions, 0 deletions
diff --git a/src/script/squirrel.hpp b/src/script/squirrel.hpp
new file mode 100644
index 000000000..bd9a10cfc
--- /dev/null
+++ b/src/script/squirrel.hpp
@@ -0,0 +1,185 @@
+/* $Id$ */
+
+/** @file squirrel.hpp defines the Squirrel class */
+
+#ifndef SQUIRREL_HPP
+#define SQUIRREL_HPP
+
+class Squirrel {
+private:
+ typedef void (SQPrintFunc)(bool error_msg, const SQChar *message);
+
+ HSQUIRRELVM vm; ///< The VirtualMachine instnace for squirrel
+ void *global_pointer; ///< Can be set by who ever initializes Squirrel
+ SQPrintFunc *print_func; ///< Points to either NULL, or a custom print handler
+
+ /**
+ * The internal RunError handler. It looks up the real error and calls RunError with it.
+ */
+ static SQInteger _RunError(HSQUIRRELVM vm);
+
+ /**
+ * Get the squirrel VM. Try to avoid using this.
+ */
+ HSQUIRRELVM GetVM() { return this->vm; }
+
+protected:
+ /**
+ * The CompileError handler.
+ */
+ static void CompileError(HSQUIRRELVM vm, const SQChar *desc, const SQChar *source, SQInteger line, SQInteger column);
+
+ /**
+ * The RunError handler.
+ */
+ static void RunError(HSQUIRRELVM vm, const SQChar *error);
+
+ /**
+ * If a user runs 'print' inside a script, this function gets the params.
+ */
+ static void PrintFunc(HSQUIRRELVM vm, const SQChar *s, ...);
+
+ /**
+ * If an error has to be print, this function is called.
+ */
+ static void ErrorPrintFunc(HSQUIRRELVM vm, const SQChar *s, ...);
+
+public:
+ friend class AIController;
+ friend class AIScanner;
+ friend class AIInstance;
+
+ Squirrel();
+ ~Squirrel();
+
+ /**
+ * Load a script.
+ * @param script The full script-name to load.
+ * @return False if loading failed.
+ */
+ bool LoadScript(const char *script);
+ static bool LoadScript(HSQUIRRELVM vm, const char *script, bool in_root = true);
+
+ /**
+ * Load a file to a given VM.
+ */
+ static SQRESULT LoadFile(HSQUIRRELVM vm, const char *filename, SQBool printerror);
+
+ /**
+ * Adds a function to the stack. Depending on the current state this means
+ * either a method or a global function.
+ */
+ void AddMethod(const char *method_name, SQFUNCTION proc, uint nparam = 0, const char *params = NULL, void *userdata = NULL, int size = 0);
+
+ /**
+ * Adds a const to the stack. Depending on the current state this means
+ * either a const to a class or to the global space.
+ */
+ void AddConst(const char *var_name, int value);
+
+ /**
+ * Adds a class to the global scope. Make sure to call AddClassEnd when you
+ * are done adding methods.
+ */
+ void AddClassBegin(const char *class_name);
+
+ /**
+ * Adds a class to the global scope, extending 'parent_class'.
+ * Make sure to call AddClassEnd when you are done adding methods.
+ */
+ void AddClassBegin(const char *class_name, const char *parent_class);
+
+ /**
+ * Finishes adding a class to the global scope. If this isn't called, no
+ * class is really created.
+ */
+ void AddClassEnd();
+
+ /**
+ * Resume a VM when it was suspended via a throw.
+ */
+ bool Resume(int suspend = -1);
+
+ void InsertResult(bool result);
+ void InsertResult(int result);
+
+ /**
+ * Call a method of an instance, in various flavors.
+ */
+ bool CallMethod(HSQOBJECT instance, const char *method_name, HSQOBJECT *ret, int suspend = -1);
+ bool CallMethod(HSQOBJECT instance, const char *method_name, int suspend = -1) { return this->CallMethod(instance, method_name, NULL, suspend); }
+ const char *CallStringMethodStrdup(HSQOBJECT instance, const char *method_name, int suspend = -1) { HSQOBJECT ret; this->CallMethod(instance, method_name, &ret, suspend); return strdup(ObjectToString(&ret)); }
+ int CallIntegerMethod(HSQOBJECT instance, const char *method_name, int suspend = -1) { HSQOBJECT ret; this->CallMethod(instance, method_name, &ret, suspend); return ObjectToInteger(&ret); }
+
+ /**
+ * Check if a method exists in an instance.
+ */
+ bool MethodExists(HSQOBJECT instance, const char *method_name);
+
+ /**
+ * Creates a class instance.
+ * @param class_name The name of the class of which we create an instance.
+ * @param real_instance The instance to the real class, if it represents a real class.
+ * @param instance Returning value with the pointer to the instance.
+ * @param release_hook Optional param to give a release hook.
+ * @return False if creating failed.
+ */
+ static bool CreateClassInstanceVM(HSQUIRRELVM vm, const char *class_name, void *real_instance, HSQOBJECT *instance, SQRELEASEHOOK release_hook);
+
+ /**
+ * Exactly the same as CreateClassInstanceVM, only callable without instance of Squirrel.
+ */
+ bool CreateClassInstance(const char *class_name, void *real_instance, HSQOBJECT *instance);
+
+ /**
+ * Get the real-instance pointer.
+ * @note This will only work just after a function-call from within Squirrel
+ * to your C++ function.
+ */
+ static bool GetRealInstance(HSQUIRRELVM vm, SQUserPointer *ptr) { return SQ_SUCCEEDED(sq_getinstanceup(vm, 1, ptr, 0)); }
+
+ /**
+ * Get the Squirrel-instance pointer.
+ * @note This will only work just after a function-call from within Squirrel
+ * to your C++ function.
+ */
+ static bool GetInstance(HSQUIRRELVM vm, HSQOBJECT *ptr, int pos = 1) { sq_getclass(vm, pos); sq_getstackobj(vm, pos, ptr); sq_pop(vm, 1); return true; }
+
+ /**
+ * Convert a Squirrel-object to a string.
+ */
+ static const char *ObjectToString(HSQOBJECT *ptr) { return FS2OTTD(sq_objtostring(ptr)); }
+
+ /**
+ * Convert a Squirrel-object to an integer.
+ */
+ static int ObjectToInteger(HSQOBJECT *ptr) { return sq_objtointeger(ptr); }
+
+ /**
+ * Sets a pointer in the VM that is reachable from where ever you are in SQ.
+ * Useful to keep track of the main instance.
+ */
+ void SetGlobalPointer(void *ptr) { this->global_pointer = ptr; }
+
+ /**
+ * Get the pointer as set by SetGlobalPointer.
+ */
+ static void *GetGlobalPointer(HSQUIRRELVM vm) { return ((Squirrel *)sq_getforeignptr(vm))->global_pointer; }
+
+ /**
+ * Set a custom print function, so you can handle outputs from SQ yourself.
+ */
+ void SetPrintFunction(SQPrintFunc *func) { this->print_func = func; }
+
+ /**
+ * Throw a Squirrel error that will be nicely displayed to the user.
+ */
+ void ThrowError(const char *error) { sq_throwerror(this->vm, OTTD2FS(error)); }
+
+ /**
+ * Release a SQ object.
+ */
+ void ReleaseObject(HSQOBJECT *ptr) { sq_release(this->vm, ptr); }
+};
+
+#endif /* SQUIRREL_HPP */