1

/* $Id$ */

     2

     3

/** @file squirrel_std.hpp defines the Squirrel Standard Function class */

     4

     5

#ifndef SQUIRREL_STD_HPP

     6

#define SQUIRREL_STD_HPP

     7

     8

#if defined(__APPLE__)

     9

/* Which idiotic system makes 'require' a macro? :s Oh well.... */

    10

#undef require

    11

#endif /* __APPLE__ */

    12

    13

/**

    14

 * By default we want to give a set of standard commands to a SQ script.

    15

 * Most of them are easy wrappers around internal functions. Of course we

    16

 *  could just as easy include things like the stdmath of SQ, but of those

    17

 *  functions we are sure they work on all our supported targets.

    18

 */

    19

class SquirrelStd {

    20

public:

    21

	/**

    22

	 * Make an integer absolute.

    23

	 */

    24

	static SQInteger abs(HSQUIRRELVM vm);

    25

    26

	/**

    37

	 * Load an other file on runtime.

    38

	 * @note This is always loaded on the root-level, no matter where you call this.

    39

	 * @note The filename is always relative from the script it is called from. Absolute calls are NOT allowed!

    40

	 */

    41

	static SQInteger require(HSQUIRRELVM vm);

    42

};

    43

    44

/**

    45

 * Register all standard functions we want to give to a script.

    46

 */

    47

void squirrel_register_std(Squirrel *engine);

    48

    49

/**

    50

 * Register all standard functions that are available on first startup.

    51

 * @note this set is very limited, and is only ment to load other scripts and things like that.

    52

 */

    53

void squirrel_register_global_std(Squirrel *engine);

    54

    55

#endif /* SQUIRREL_STD_HPP */