src/squirrel/include/squirrel.h

   1 /*\r
   2 Copyright (c) 2003-2006 Alberto Demichelis\r
   3 \r
   4 This software is provided 'as-is', without any \r
   5 express or implied warranty. In no event will the \r
   6 authors be held liable for any damages arising from \r
   7 the use of this software.\r
   8 \r
   9 Permission is granted to anyone to use this software \r
  10 for any purpose, including commercial applications, \r
  11 and to alter it and redistribute it freely, subject \r
  12 to the following restrictions:\r
  13 \r
  14                 1. The origin of this software must not be \r
  15                 misrepresented; you must not claim that \r
  16                 you wrote the original software. If you \r
  17                 use this software in a product, an \r
  18                 acknowledgment in the product \r
  19                 documentation would be appreciated but is \r
  20                 not required.\r
  21 \r
  22                 2. Altered source versions must be plainly \r
  23                 marked as such, and must not be \r
  24                 misrepresented as being the original \r
  25                 software.\r
  26 \r
  27                 3. This notice may not be removed or \r
  28                 altered from any source distribution.\r
  29 \r
  30 */\r
  31 #ifndef _SQUIRREL_H_\r
  32 #define _SQUIRREL_H_\r
  33 \r
  34 #ifdef __cplusplus\r
  35 extern "C" {\r
  36 #endif\r
  37 \r
  38 #ifndef SQUIRREL_API\r
  39 #define SQUIRREL_API extern\r
  40 #endif\r
  41 \r
  42 #ifdef _SQ64\r
  43 #ifdef _MSC_VER\r
  44 typedef __int64 SQInteger;\r
  45 typedef unsigned __int64 SQUnsignedInteger;\r
  46 typedef unsigned __int64 SQHash; /*should be the same size of a pointer*/\r
  47 #else\r
  48 typedef long SQInteger;\r
  49 typedef unsigned long SQUnsignedInteger;\r
  50 typedef unsigned long SQHash; /*should be the same size of a pointer*/\r
  51 #endif\r
  52 typedef int SQInt32; \r
  53 #else \r
  54 typedef int SQInteger;\r
  55 typedef int SQInt32; /*must be 32 bits(also on 64bits processors)*/\r
  56 typedef unsigned int SQUnsignedInteger;\r
  57 typedef unsigned int SQHash; /*should be the same size of a pointer*/\r
  58 #endif\r
  59 \r
  60 typedef float SQFloat;\r
  61 typedef void* SQUserPointer;\r
  62 typedef SQUnsignedInteger SQBool;\r
  63 typedef SQInteger SQRESULT;\r
  64 \r
  65 #define SQTrue  (1)\r
  66 #define SQFalse (0)\r
  67 \r
  68 \r
  69 struct SQVM;\r
  70 struct SQTable;\r
  71 struct SQArray;\r
  72 struct SQString;\r
  73 struct SQClosure;\r
  74 struct SQGenerator;\r
  75 struct SQNativeClosure;\r
  76 struct SQUserData;\r
  77 struct SQFunctionProto;\r
  78 struct SQRefCounted;\r
  79 struct SQClass;\r
  80 struct SQInstance;\r
  81 struct SQDelegable;\r
  82 \r
  83 #ifdef _UNICODE\r
  84 #define SQUNICODE\r
  85 #endif\r
  86 \r
  87 #ifdef SQUNICODE\r
  88 #if defined(wchar_t) //this is if the compiler considers wchar_t as native type\r
  89 #define wchar_t unsigned short\r
  90 #endif\r
  91 typedef wchar_t SQChar;\r
  92 #define _SC(a) L##a\r
  93 #define scstrcmp        wcscmp\r
  94 #define scsprintf       swprintf\r
  95 #define scstrlen        wcslen\r
  96 #define scstrtod        wcstod\r
  97 #define scstrtol        wcstol\r
  98 #define scatoi          _wtoi\r
  99 #define scstrtoul       wcstoul\r
 100 #define scvsprintf      vswprintf\r
 101 #define scstrstr        wcsstr\r
 102 #define scisspace       iswspace\r
 103 #define scisdigit       iswdigit\r
 104 #define scisxdigit      iswxdigit\r
 105 #define scisalpha       iswalpha\r
 106 #define sciscntrl       iswcntrl\r
 107 #define scisalnum       iswalnum\r
 108 #define scprintf        wprintf\r
 109 #define MAX_CHAR 0xFFFF\r
 110 #else\r
 111 typedef char SQChar;\r
 112 #define _SC(a) a\r
 113 #define scstrcmp        strcmp\r
 114 #define scsprintf       sprintf\r
 115 #define scstrlen        strlen\r
 116 #define scstrtod        strtod\r
 117 #define scstrtol        strtol\r
 118 #define scatoi          atoi\r
 119 #define scstrtoul       strtoul\r
 120 #define scvsprintf      vsprintf\r
 121 #define scstrstr        strstr\r
 122 #define scisspace       isspace\r
 123 #define scisdigit       isdigit\r
 124 #define scisxdigit      isxdigit\r
 125 #define sciscntrl       iscntrl\r
 126 #define scisalpha       isalpha\r
 127 #define scisalnum       isalnum\r
 128 #define scprintf        printf\r
 129 #define MAX_CHAR 0xFF\r
 130 #endif\r
 131 \r
 132 #define SQUIRREL_VERSION        _SC("Squirrel 2.1 stable")\r
 133 #define SQUIRREL_COPYRIGHT      _SC("Copyright (C) 2003-2006 Alberto Demichelis")\r
 134 #define SQUIRREL_AUTHOR         _SC("Alberto Demichelis")\r
 135 \r
 136 #define SQ_VMSTATE_IDLE                 0\r
 137 #define SQ_VMSTATE_RUNNING              1\r
 138 #define SQ_VMSTATE_SUSPENDED    2\r
 139 \r
 140 #define SQUIRREL_EOB 0\r
 141 #define SQ_BYTECODE_STREAM_TAG  0xFAFA\r
 142 \r
 143 #define SQOBJECT_REF_COUNTED    0x08000000\r
 144 #define SQOBJECT_NUMERIC                0x04000000\r
 145 #define SQOBJECT_DELEGABLE              0x02000000\r
 146 #define SQOBJECT_CANBEFALSE             0x01000000\r
 147 \r
 148 #define SQ_MATCHTYPEMASKSTRING (-99999)\r
 149 \r
 150 #define _RT_MASK 0x00FFFFFF\r
 151 #define _RAW_TYPE(type) (type&_RT_MASK)\r
 152 \r
 153 #define _RT_NULL                        0x00000001\r
 154 #define _RT_INTEGER                     0x00000002\r
 155 #define _RT_FLOAT                       0x00000004\r
 156 #define _RT_BOOL                        0x00000008\r
 157 #define _RT_STRING                      0x00000010\r
 158 #define _RT_TABLE                       0x00000020\r
 159 #define _RT_ARRAY                       0x00000040\r
 160 #define _RT_USERDATA            0x00000080\r
 161 #define _RT_CLOSURE                     0x00000100\r
 162 #define _RT_NATIVECLOSURE       0x00000200\r
 163 #define _RT_GENERATOR           0x00000400\r
 164 #define _RT_USERPOINTER         0x00000800\r
 165 #define _RT_THREAD                      0x00001000\r
 166 #define _RT_FUNCPROTO           0x00002000\r
 167 #define _RT_CLASS                       0x00004000\r
 168 #define _RT_INSTANCE            0x00008000\r
 169 #define _RT_WEAKREF                     0x00010000\r
 170 \r
 171 typedef enum tagSQObjectType{\r
 172         OT_NULL =                       (_RT_NULL|SQOBJECT_CANBEFALSE),\r
 173         OT_INTEGER =            (_RT_INTEGER|SQOBJECT_NUMERIC|SQOBJECT_CANBEFALSE),\r
 174         OT_FLOAT =                      (_RT_FLOAT|SQOBJECT_NUMERIC|SQOBJECT_CANBEFALSE),\r
 175         OT_BOOL =                       (_RT_BOOL|SQOBJECT_CANBEFALSE),\r
 176         OT_STRING =                     (_RT_STRING|SQOBJECT_REF_COUNTED),\r
 177         OT_TABLE =                      (_RT_TABLE|SQOBJECT_REF_COUNTED|SQOBJECT_DELEGABLE),\r
 178         OT_ARRAY =                      (_RT_ARRAY|SQOBJECT_REF_COUNTED),\r
 179         OT_USERDATA =           (_RT_USERDATA|SQOBJECT_REF_COUNTED|SQOBJECT_DELEGABLE),\r
 180         OT_CLOSURE =            (_RT_CLOSURE|SQOBJECT_REF_COUNTED),\r
 181         OT_NATIVECLOSURE =      (_RT_NATIVECLOSURE|SQOBJECT_REF_COUNTED),\r
 182         OT_GENERATOR =          (_RT_GENERATOR|SQOBJECT_REF_COUNTED),\r
 183         OT_USERPOINTER =        _RT_USERPOINTER,\r
 184         OT_THREAD =                     (_RT_THREAD|SQOBJECT_REF_COUNTED) ,\r
 185         OT_FUNCPROTO =          (_RT_FUNCPROTO|SQOBJECT_REF_COUNTED), //internal usage only\r
 186         OT_CLASS =                      (_RT_CLASS|SQOBJECT_REF_COUNTED),\r
 187         OT_INSTANCE =           (_RT_INSTANCE|SQOBJECT_REF_COUNTED|SQOBJECT_DELEGABLE),\r
 188         OT_WEAKREF =            (_RT_WEAKREF|SQOBJECT_REF_COUNTED)\r
 189 }SQObjectType;\r
 190 \r
 191 #define ISREFCOUNTED(t) (t&SQOBJECT_REF_COUNTED)\r
 192 \r
 193 \r
 194 typedef union tagSQObjectValue\r
 195 {\r
 196         struct SQTable *pTable;\r
 197         struct SQArray *pArray;\r
 198         struct SQClosure *pClosure;\r
 199         struct SQGenerator *pGenerator;\r
 200         struct SQNativeClosure *pNativeClosure;\r
 201         struct SQString *pString;\r
 202         struct SQUserData *pUserData;\r
 203         SQInteger nInteger;\r
 204         SQFloat fFloat;\r
 205         SQUserPointer pUserPointer;\r
 206         struct SQFunctionProto *pFunctionProto;\r
 207         struct SQRefCounted *pRefCounted;\r
 208         struct SQDelegable *pDelegable;\r
 209         struct SQVM *pThread;\r
 210         struct SQClass *pClass;\r
 211         struct SQInstance *pInstance;\r
 212         struct SQWeakRef *pWeakRef;\r
 213 }SQObjectValue;\r
 214 \r
 215 \r
 216 typedef struct tagSQObject\r
 217 {\r
 218         SQObjectValue _unVal;\r
 219         SQObjectType _type;\r
 220 }SQObject;\r
 221 \r
 222 typedef struct tagSQStackInfos{\r
 223         const SQChar* funcname;\r
 224         const SQChar* source;\r
 225         SQInteger line;\r
 226 }SQStackInfos;\r
 227 \r
 228 typedef struct SQVM* HSQUIRRELVM;\r
 229 typedef SQObject HSQOBJECT;\r
 230 typedef SQInteger (*SQFUNCTION)(HSQUIRRELVM);\r
 231 typedef SQInteger (*SQRELEASEHOOK)(SQUserPointer,SQInteger size);\r
 232 typedef void (*SQCOMPILERERROR)(HSQUIRRELVM,const SQChar * /*desc*/,const SQChar * /*source*/,SQInteger /*line*/,SQInteger /*column*/);\r
 233 typedef void (*SQPRINTFUNCTION)(HSQUIRRELVM,const SQChar * ,...);\r
 234 \r
 235 typedef SQInteger (*SQWRITEFUNC)(SQUserPointer,SQUserPointer,SQInteger);\r
 236 typedef SQInteger (*SQREADFUNC)(SQUserPointer,SQUserPointer,SQInteger);\r
 237 \r
 238 typedef SQInteger (*SQLEXREADFUNC)(SQUserPointer);\r
 239 \r
 240 typedef struct tagSQRegFunction{\r
 241         const SQChar *name;\r
 242         SQFUNCTION f;\r
 243         SQInteger nparamscheck;\r
 244         const SQChar *typemask;\r
 245 }SQRegFunction;\r
 246 \r
 247 /*vm*/\r
 248 SQUIRREL_API HSQUIRRELVM sq_open(SQInteger initialstacksize);\r
 249 SQUIRREL_API HSQUIRRELVM sq_newthread(HSQUIRRELVM friendvm, SQInteger initialstacksize);\r
 250 SQUIRREL_API void sq_seterrorhandler(HSQUIRRELVM v);\r
 251 SQUIRREL_API void sq_close(HSQUIRRELVM v);\r
 252 SQUIRREL_API void sq_setforeignptr(HSQUIRRELVM v,SQUserPointer p);\r
 253 SQUIRREL_API SQUserPointer sq_getforeignptr(HSQUIRRELVM v);\r
 254 SQUIRREL_API void sq_setprintfunc(HSQUIRRELVM v, SQPRINTFUNCTION printfunc);\r
 255 SQUIRREL_API SQPRINTFUNCTION sq_getprintfunc(HSQUIRRELVM v);\r
 256 SQUIRREL_API SQRESULT sq_suspendvm(HSQUIRRELVM v);\r
 257 SQUIRREL_API SQRESULT sq_wakeupvm(HSQUIRRELVM v,SQBool resumedret,SQBool retval,SQBool raiseerror);\r
 258 SQUIRREL_API SQInteger sq_getvmstate(HSQUIRRELVM v);\r
 259 \r
 260 /*compiler*/\r
 261 SQUIRREL_API SQRESULT sq_compile(HSQUIRRELVM v,SQLEXREADFUNC read,SQUserPointer p,const SQChar *sourcename,SQBool raiseerror);\r
 262 SQUIRREL_API SQRESULT sq_compilebuffer(HSQUIRRELVM v,const SQChar *s,SQInteger size,const SQChar *sourcename,SQBool raiseerror);\r
 263 SQUIRREL_API void sq_enabledebuginfo(HSQUIRRELVM v, SQBool enable);\r
 264 SQUIRREL_API void sq_notifyallexceptions(HSQUIRRELVM v, SQBool enable);\r
 265 SQUIRREL_API void sq_setcompilererrorhandler(HSQUIRRELVM v,SQCOMPILERERROR f);\r
 266 \r
 267 /*stack operations*/\r
 268 SQUIRREL_API void sq_push(HSQUIRRELVM v,SQInteger idx);\r
 269 SQUIRREL_API void sq_pop(HSQUIRRELVM v,SQInteger nelemstopop);\r
 270 SQUIRREL_API void sq_poptop(HSQUIRRELVM v);\r
 271 SQUIRREL_API void sq_remove(HSQUIRRELVM v,SQInteger idx);\r
 272 SQUIRREL_API SQInteger sq_gettop(HSQUIRRELVM v);\r
 273 SQUIRREL_API void sq_settop(HSQUIRRELVM v,SQInteger newtop);\r
 274 SQUIRREL_API void sq_reservestack(HSQUIRRELVM v,SQInteger nsize);\r
 275 SQUIRREL_API SQInteger sq_cmp(HSQUIRRELVM v);\r
 276 SQUIRREL_API void sq_move(HSQUIRRELVM dest,HSQUIRRELVM src,SQInteger idx);\r
 277 \r
 278 /*object creation handling*/\r
 279 SQUIRREL_API SQUserPointer sq_newuserdata(HSQUIRRELVM v,SQUnsignedInteger size);\r
 280 SQUIRREL_API void sq_newtable(HSQUIRRELVM v);\r
 281 SQUIRREL_API void sq_newarray(HSQUIRRELVM v,SQInteger size);\r
 282 SQUIRREL_API void sq_newclosure(HSQUIRRELVM v,SQFUNCTION func,SQUnsignedInteger nfreevars);\r
 283 SQUIRREL_API SQRESULT sq_setparamscheck(HSQUIRRELVM v,SQInteger nparamscheck,const SQChar *typemask);\r
 284 SQUIRREL_API SQRESULT sq_bindenv(HSQUIRRELVM v,SQInteger idx);\r
 285 SQUIRREL_API void sq_pushstring(HSQUIRRELVM v,const SQChar *s,SQInteger len);\r
 286 SQUIRREL_API void sq_pushfloat(HSQUIRRELVM v,SQFloat f);\r
 287 SQUIRREL_API void sq_pushinteger(HSQUIRRELVM v,SQInteger n);\r
 288 SQUIRREL_API void sq_pushbool(HSQUIRRELVM v,SQBool b);\r
 289 SQUIRREL_API void sq_pushuserpointer(HSQUIRRELVM v,SQUserPointer p);\r
 290 SQUIRREL_API void sq_pushnull(HSQUIRRELVM v);\r
 291 SQUIRREL_API SQObjectType sq_gettype(HSQUIRRELVM v,SQInteger idx);\r
 292 SQUIRREL_API SQInteger sq_getsize(HSQUIRRELVM v,SQInteger idx);\r
 293 SQUIRREL_API SQRESULT sq_getbase(HSQUIRRELVM v,SQInteger idx);\r
 294 SQUIRREL_API SQBool sq_instanceof(HSQUIRRELVM v);\r
 295 SQUIRREL_API void sq_tostring(HSQUIRRELVM v,SQInteger idx);\r
 296 SQUIRREL_API void sq_tobool(HSQUIRRELVM v, SQInteger idx, SQBool *b);\r
 297 SQUIRREL_API SQRESULT sq_getstring(HSQUIRRELVM v,SQInteger idx,const SQChar **c);\r
 298 SQUIRREL_API SQRESULT sq_getinteger(HSQUIRRELVM v,SQInteger idx,SQInteger *i);\r
 299 SQUIRREL_API SQRESULT sq_getfloat(HSQUIRRELVM v,SQInteger idx,SQFloat *f);\r
 300 SQUIRREL_API SQRESULT sq_getbool(HSQUIRRELVM v,SQInteger idx,SQBool *b);\r
 301 SQUIRREL_API SQRESULT sq_getthread(HSQUIRRELVM v,SQInteger idx,HSQUIRRELVM *thread);\r
 302 SQUIRREL_API SQRESULT sq_getuserpointer(HSQUIRRELVM v,SQInteger idx,SQUserPointer *p);\r
 303 SQUIRREL_API SQRESULT sq_getuserdata(HSQUIRRELVM v,SQInteger idx,SQUserPointer *p,SQUserPointer *typetag);\r
 304 SQUIRREL_API SQRESULT sq_settypetag(HSQUIRRELVM v,SQInteger idx,SQUserPointer typetag);\r
 305 SQUIRREL_API SQRESULT sq_gettypetag(HSQUIRRELVM v,SQInteger idx,SQUserPointer *typetag);\r
 306 SQUIRREL_API void sq_setreleasehook(HSQUIRRELVM v,SQInteger idx,SQRELEASEHOOK hook);\r
 307 SQUIRREL_API SQChar *sq_getscratchpad(HSQUIRRELVM v,SQInteger minsize);\r
 308 SQUIRREL_API SQRESULT sq_getclosureinfo(HSQUIRRELVM v,SQInteger idx,SQUnsignedInteger *nparams,SQUnsignedInteger *nfreevars);\r
 309 SQUIRREL_API SQRESULT sq_setnativeclosurename(HSQUIRRELVM v,SQInteger idx,const SQChar *name);\r
 310 SQUIRREL_API SQRESULT sq_setinstanceup(HSQUIRRELVM v, SQInteger idx, SQUserPointer p);\r
 311 SQUIRREL_API SQRESULT sq_getinstanceup(HSQUIRRELVM v, SQInteger idx, SQUserPointer *p,SQUserPointer typetag);\r
 312 SQUIRREL_API SQRESULT sq_newclass(HSQUIRRELVM v,SQBool hasbase);\r
 313 SQUIRREL_API SQRESULT sq_createinstance(HSQUIRRELVM v,SQInteger idx);\r
 314 SQUIRREL_API SQRESULT sq_setattributes(HSQUIRRELVM v,SQInteger idx);\r
 315 SQUIRREL_API SQRESULT sq_getattributes(HSQUIRRELVM v,SQInteger idx);\r
 316 SQUIRREL_API SQRESULT sq_getclass(HSQUIRRELVM v,SQInteger idx);\r
 317 SQUIRREL_API void sq_weakref(HSQUIRRELVM v,SQInteger idx);\r
 318 SQUIRREL_API SQRESULT sq_getdefaultdelegate(HSQUIRRELVM v,SQObjectType t);\r
 319 \r
 320 /*object manipulation*/\r
 321 SQUIRREL_API void sq_pushroottable(HSQUIRRELVM v);\r
 322 SQUIRREL_API void sq_pushregistrytable(HSQUIRRELVM v);\r
 323 SQUIRREL_API SQRESULT sq_setroottable(HSQUIRRELVM v);\r
 324 /*SQUIRREL_API SQRESULT sq_createslot(HSQUIRRELVM v,SQInteger idx);*/\r
 325 SQRESULT sq_newslot(HSQUIRRELVM v, SQInteger idx, SQBool bstatic);\r
 326 SQUIRREL_API SQRESULT sq_deleteslot(HSQUIRRELVM v,SQInteger idx,SQBool pushval);\r
 327 SQUIRREL_API SQRESULT sq_set(HSQUIRRELVM v,SQInteger idx);\r
 328 SQUIRREL_API SQRESULT sq_get(HSQUIRRELVM v,SQInteger idx);\r
 329 SQUIRREL_API SQRESULT sq_rawget(HSQUIRRELVM v,SQInteger idx);\r
 330 SQUIRREL_API SQRESULT sq_rawset(HSQUIRRELVM v,SQInteger idx);\r
 331 SQUIRREL_API SQRESULT sq_rawdeleteslot(HSQUIRRELVM v,SQInteger idx,SQBool pushval);\r
 332 SQUIRREL_API SQRESULT sq_arrayappend(HSQUIRRELVM v,SQInteger idx);\r
 333 SQUIRREL_API SQRESULT sq_arraypop(HSQUIRRELVM v,SQInteger idx,SQBool pushval); \r
 334 SQUIRREL_API SQRESULT sq_arrayresize(HSQUIRRELVM v,SQInteger idx,SQInteger newsize); \r
 335 SQUIRREL_API SQRESULT sq_arrayreverse(HSQUIRRELVM v,SQInteger idx); \r
 336 SQUIRREL_API SQRESULT sq_setdelegate(HSQUIRRELVM v,SQInteger idx);\r
 337 SQUIRREL_API SQRESULT sq_getdelegate(HSQUIRRELVM v,SQInteger idx);\r
 338 SQUIRREL_API SQRESULT sq_clone(HSQUIRRELVM v,SQInteger idx);\r
 339 SQUIRREL_API SQRESULT sq_setfreevariable(HSQUIRRELVM v,SQInteger idx,SQUnsignedInteger nval);\r
 340 SQUIRREL_API SQRESULT sq_next(HSQUIRRELVM v,SQInteger idx);\r
 341 SQUIRREL_API SQRESULT sq_getweakrefval(HSQUIRRELVM v,SQInteger idx);\r
 342 \r
 343 /*calls*/\r
 344 SQUIRREL_API SQRESULT sq_call(HSQUIRRELVM v,SQInteger params,SQBool retval,SQBool raiseerror);\r
 345 SQUIRREL_API SQRESULT sq_resume(HSQUIRRELVM v,SQBool retval,SQBool raiseerror);\r
 346 SQUIRREL_API const SQChar *sq_getlocal(HSQUIRRELVM v,SQUnsignedInteger level,SQUnsignedInteger idx);\r
 347 SQUIRREL_API const SQChar *sq_getfreevariable(HSQUIRRELVM v,SQInteger idx,SQUnsignedInteger nval);\r
 348 SQUIRREL_API SQRESULT sq_throwerror(HSQUIRRELVM v,const SQChar *err);\r
 349 SQUIRREL_API void sq_reseterror(HSQUIRRELVM v);\r
 350 SQUIRREL_API void sq_getlasterror(HSQUIRRELVM v);\r
 351 \r
 352 /*raw object handling*/\r
 353 SQUIRREL_API SQRESULT sq_getstackobj(HSQUIRRELVM v,SQInteger idx,HSQOBJECT *po);\r
 354 SQUIRREL_API void sq_pushobject(HSQUIRRELVM v,HSQOBJECT obj);\r
 355 SQUIRREL_API void sq_addref(HSQUIRRELVM v,HSQOBJECT *po);\r
 356 SQUIRREL_API SQBool sq_release(HSQUIRRELVM v,HSQOBJECT *po);\r
 357 SQUIRREL_API void sq_resetobject(HSQOBJECT *po);\r
 358 SQUIRREL_API const SQChar *sq_objtostring(HSQOBJECT *o);\r
 359 SQUIRREL_API SQBool sq_objtobool(HSQOBJECT *o);\r
 360 SQUIRREL_API SQInteger sq_objtointeger(HSQOBJECT *o);\r
 361 SQUIRREL_API SQFloat sq_objtofloat(HSQOBJECT *o);\r
 362 SQUIRREL_API SQRESULT sq_getobjtypetag(HSQOBJECT *o,SQUserPointer * typetag);\r
 363 \r
 364 /*GC*/\r
 365 SQUIRREL_API SQInteger sq_collectgarbage(HSQUIRRELVM v);\r
 366 \r
 367 /*serialization*/\r
 368 SQUIRREL_API SQRESULT sq_writeclosure(HSQUIRRELVM vm,SQWRITEFUNC writef,SQUserPointer up);\r
 369 SQUIRREL_API SQRESULT sq_readclosure(HSQUIRRELVM vm,SQREADFUNC readf,SQUserPointer up);\r
 370 \r
 371 /*mem allocation*/\r
 372 SQUIRREL_API void *sq_malloc(SQUnsignedInteger size);\r
 373 SQUIRREL_API void *sq_realloc(void* p,SQUnsignedInteger oldsize,SQUnsignedInteger newsize);\r
 374 SQUIRREL_API void sq_free(void *p,SQUnsignedInteger size);\r
 375 \r
 376 /*debug*/\r
 377 SQUIRREL_API SQRESULT sq_stackinfos(HSQUIRRELVM v,SQInteger level,SQStackInfos *si);\r
 378 SQUIRREL_API void sq_setdebughook(HSQUIRRELVM v);\r
 379 \r
 380 /*UTILITY MACRO*/\r
 381 #define sq_isnumeric(o) ((o)._type&SQOBJECT_NUMERIC)\r
 382 #define sq_istable(o) ((o)._type==OT_TABLE)\r
 383 #define sq_isarray(o) ((o)._type==OT_ARRAY)\r
 384 #define sq_isfunction(o) ((o)._type==OT_FUNCPROTO)\r
 385 #define sq_isclosure(o) ((o)._type==OT_CLOSURE)\r
 386 #define sq_isgenerator(o) ((o)._type==OT_GENERATOR)\r
 387 #define sq_isnativeclosure(o) ((o)._type==OT_NATIVECLOSURE)\r
 388 #define sq_isstring(o) ((o)._type==OT_STRING)\r
 389 #define sq_isinteger(o) ((o)._type==OT_INTEGER)\r
 390 #define sq_isfloat(o) ((o)._type==OT_FLOAT)\r
 391 #define sq_isuserpointer(o) ((o)._type==OT_USERPOINTER)\r
 392 #define sq_isuserdata(o) ((o)._type==OT_USERDATA)\r
 393 #define sq_isthread(o) ((o)._type==OT_THREAD)\r
 394 #define sq_isnull(o) ((o)._type==OT_NULL)\r
 395 #define sq_isclass(o) ((o)._type==OT_CLASS)\r
 396 #define sq_isinstance(o) ((o)._type==OT_INSTANCE)\r
 397 #define sq_isbool(o) ((o)._type==OT_BOOL)\r
 398 #define sq_isweakref(o) ((o)._type==OT_WEAKREF)\r
 399 #define sq_type(o) ((o)._type)\r
 400 \r
 401 /* deprecated */\r
 402 #define sq_createslot(v,n) sq_newslot(v,n,SQFalse)\r
 403 \r
 404 #define SQ_OK (0)\r
 405 #define SQ_ERROR (-1)\r
 406 \r
 407 #define SQ_FAILED(res) (res<0)\r
 408 #define SQ_SUCCEEDED(res) (res>=0)\r
 409 \r
 410 #ifdef __cplusplus\r
 411 } /*extern "C"*/\r
 412 #endif\r
 413 \r
 414 #endif /*_SQUIRREL_H_*/\r