1

/* $Id$ */

     2

     3

/** @file engine.hpp defines the SquirrelEngine class */

     4

     5

#ifndef SQUIRREL_CORE_HPP

     6

#define SQUIRREL_CORE_HPP

     7

     8

class SquirrelEngine {

     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

	SquirrelEngine();

    35

	~SquirrelEngine();

    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

	 */

    48

	void AddMethod(const char *method_name, SQFUNCTION proc, uint nparam, const char *params);

    49

	void AddMethod(const char *method_name, SQFUNCTION proc);

    51

    52

	/**

    53

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

    54

	 *  are done adding methods.

    55

	 */

    56

	void AddClassBegin(const char *class_name);

    57

    58

	/**

    59

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

    60

	 *  class is really created.

    61

	 */

    62

	void AddClassEnd();

    63

    64

	/**

    65

	 * Call a method of an instance.

    66

	 */

    67

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

    68

    69

	/**

    70

	 * Creates a class instance.

    71

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

    72

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

    73

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

    74

	 * @return False if creating failed.

    75

	 */

    76

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

    77

    78

	/**

    79

	 * Get the real-instance pointer.

    80

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

    81

	 *  to your C++ function.

    82

	 */

    83

	static bool GetInstance(HSQUIRRELVM vm, SQUserPointer *ptr) { if (SQ_FAILED(sq_getinstanceup(vm, 1, ptr, 0))) return false; return true; }

    84

    85

	HSQUIRRELVM GetVM() {

    86

#warning Please stop using this function ASAP

    87

		return this->vm;

    88

	}

    89

};

    90

    91

#endif /* SQUIRREL_CORE_HPP */