1

/* $Id$ */

     2

     3

/** @file squirrel.hpp defines the Squirrel class */

     4

     5

#ifndef SQUIRREL_HPP

     6

#define SQUIRREL_HPP

     7

     8

class Squirrel {

     9

private:

    10

	HSQUIRRELVM vm;        ///< The VirtualMachine instnace for squirrel

    11

    12

	/**

    13

	 * The internal RunError handler. It looks up the real error and calls RunError with it.

    14

	 */

    15

	static SQInteger _RunError(HSQUIRRELVM vm);

    16

    17

protected:

    18

	/**

    19

	 * The CompileError handler.

    20

	 */

    21

	static void CompileError(HSQUIRRELVM vm, const SQChar *desc, const SQChar *source, SQInteger line, SQInteger column);

    22

    23

	/**

    24

	 * The RunError handler.

    25

	 */

    26

	static void RunError(HSQUIRRELVM vm, const char *error);

    27

    28

	/**

    29

	 * If a user runs 'print' inside a script, this function gets the params.

    30

	 */

    31

	static void PrintFunc(HSQUIRRELVM vm, const SQChar *s, ...);

    32

    33

public:

    34

	Squirrel();

    35

	~Squirrel();

    36

    37

	/**

    38

	 * Load a script.

    39

	 * @param script The full script-name to load.

    40

	 * @return False if loading failed.

    41

	 */

    42

	bool LoadScript(const char *script);

    43

    44

	/**

    45

	 * Adds a function to the stack. Depending on the current state this means

    46

	 *  either a method or a global function.

    47

	 */

    49

    50

	/**

    51

	 * Adds a const to the stack. Depending on the current state this means

    52

	 *  either a const to a class or to the global space.

    53

	 */

    54

	void AddConst(const char *var_name, int value);

    55

    56

	/**

    57

	 * Adds a class to the global scope. Make sure to call AddClassEnd when you

    58

	 *  are done adding methods.

    59

	 */

    60

	void AddClassBegin(const char *class_name);

    61

    62

	/**

    63

	 * Finishes adding a class to the global scope. If this isn't called, no

    64

	 *  class is really created.

    65

	 */

    66

	void AddClassEnd();

    67

    68

	/**

    69

	 * Call a method of an instance, in various flavors.

    70

	 */

    71

	void CallMethod(HSQOBJECT instance, const char *method_name, HSQOBJECT *ret);

    72

	void CallMethod(HSQOBJECT instance, const char *method_name) { this->CallMethod(instance, method_name, NULL); }

    73

	const char *CallStringMethod(HSQOBJECT instance, const char *method_name) { HSQOBJECT ret; this->CallMethod(instance, method_name, &ret); return ObjectToString(&ret); }

    74

	int CallIntegerMethod(HSQOBJECT instance, const char *method_name) { HSQOBJECT ret; this->CallMethod(instance, method_name, &ret); return ObjectToInteger(&ret); }

    75

    76

	/**

    77

	 * Check if a method exists in an instance.

    78

	 */

    79

	bool MethodExists(HSQOBJECT instance, const char *method_name);

    80

    81

	/**

    82

	 * Creates a class instance.

    83

	 * @param class_name The name of the class of which we create an instance.

    84

	 * @param real_instance The instance to the real class, if it represents a real class.

    85

	 * @param instance Returning value with the pointer to the instance.

    86

	 * @return False if creating failed.

    87

	 */

    88

	bool CreateClassInstance(const char *class_name, void *real_instance, HSQOBJECT *instance);

    89

    90

	/**

    91

	 * Get the real-instance pointer.

    92

	 * @note This will only work just after a function-call from within Squirrel

    93

	 *  to your C++ function.

    94

	 */

    95

	static bool GetRealInstance(HSQUIRRELVM vm, SQUserPointer *ptr) { return SQ_SUCCEEDED(sq_getinstanceup(vm, 1, ptr, 0)); }

    96

    97

	/**

    98

	 * Get the Squirrel-instance pointer.

    99

	 * @note This will only work just after a function-call from within Squirrel

   100

	 *  to your C++ function.

   101

	 */

   102

	static bool GetInstance(HSQUIRRELVM vm, HSQOBJECT *ptr) { sq_getclass(vm, 1); sq_getstackobj(vm, 1, ptr); return true; }

   103

   104

	/**

   105

	 * Convert a Squirrel-object to a string.

   106

	 */

   107

	static const char *ObjectToString(HSQOBJECT *ptr) { return FS2OTTD(sq_objtostring(ptr)); }

   108

   109

	/**

   110

	 * Convert a Squirrel-object to an integer.

   111

	 */

   112

	static int ObjectToInteger(HSQOBJECT *ptr) { return sq_objtointeger(ptr); }

   113

   114

	/**

   115

	 * Sets a pointer in the VM that is reasable from where ever you are, what

   116

	 *  ever your state is. Useful to keep track of the main instance.

   117

	 */

   118

	void SetGlobalPointer(void *ptr) { sq_setforeignptr(this->vm, ptr); }

   119

   120

	/**

   121

	 * Get the pointer as set by SetGlobalPointer.

   122

	 */

   123

	static void *GetGlobalPointer(HSQUIRRELVM vm) { return sq_getforeignptr(vm); }

   124

   125

	/**

   126

	 * Throw a Squirrel error that will be nicely displayed to the user.

   127

	 */

   128

	void ThrowError(const char *error) { sq_throwerror(this->vm, OTTD2FS(error)); }

   129

};

   130

   131

#endif /* SQUIRREL_HPP */