angelscript.h 60 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801
  1. /*
  2. AngelCode Scripting Library
  3. Copyright (c) 2003-2013 Andreas Jonsson
  4. This software is provided 'as-is', without any express or implied
  5. warranty. In no event will the authors be held liable for any
  6. damages arising from the use of this software.
  7. Permission is granted to anyone to use this software for any
  8. purpose, including commercial applications, and to alter it and
  9. redistribute it freely, subject to the following restrictions:
  10. 1. The origin of this software must not be misrepresented; you
  11. must not claim that you wrote the original software. If you use
  12. this software in a product, an acknowledgment in the product
  13. documentation would be appreciated but is not required.
  14. 2. Altered source versions must be plainly marked as such, and
  15. must not be misrepresented as being the original software.
  16. 3. This notice may not be removed or altered from any source
  17. distribution.
  18. The original version of this library can be located at:
  19. http://www.angelcode.com/angelscript/
  20. Andreas Jonsson
  21. [email protected]
  22. */
  23. // Modified by Lasse Oorni for Urho3D
  24. //
  25. // angelscript.h
  26. //
  27. // The script engine interface
  28. //
  29. #ifndef ANGELSCRIPT_H
  30. #define ANGELSCRIPT_H
  31. #include <stddef.h>
  32. #ifndef _MSC_VER
  33. #include <stdint.h>
  34. #endif
  35. #ifdef AS_USE_NAMESPACE
  36. #define BEGIN_AS_NAMESPACE namespace AngelScript {
  37. #define END_AS_NAMESPACE }
  38. #define AS_NAMESPACE_QUALIFIER AngelScript::
  39. #else
  40. #define BEGIN_AS_NAMESPACE
  41. #define END_AS_NAMESPACE
  42. #define AS_NAMESPACE_QUALIFIER ::
  43. #endif
  44. BEGIN_AS_NAMESPACE
  45. // AngelScript version
  46. #define ANGELSCRIPT_VERSION 22800
  47. #define ANGELSCRIPT_VERSION_STRING "2.28.0 WIP"
  48. // Data types
  49. class asIScriptEngine;
  50. class asIScriptModule;
  51. class asIScriptContext;
  52. class asIScriptGeneric;
  53. class asIScriptObject;
  54. class asIObjectType;
  55. class asIScriptFunction;
  56. class asIBinaryStream;
  57. class asIJITCompiler;
  58. class asIThreadManager;
  59. class asILockableSharedBool;
  60. // Enumerations and constants
  61. // Engine properties
  62. enum asEEngineProp
  63. {
  64. asEP_ALLOW_UNSAFE_REFERENCES = 1,
  65. asEP_OPTIMIZE_BYTECODE = 2,
  66. asEP_COPY_SCRIPT_SECTIONS = 3,
  67. asEP_MAX_STACK_SIZE = 4,
  68. asEP_USE_CHARACTER_LITERALS = 5,
  69. asEP_ALLOW_MULTILINE_STRINGS = 6,
  70. asEP_ALLOW_IMPLICIT_HANDLE_TYPES = 7,
  71. asEP_BUILD_WITHOUT_LINE_CUES = 8,
  72. asEP_INIT_GLOBAL_VARS_AFTER_BUILD = 9,
  73. asEP_REQUIRE_ENUM_SCOPE = 10,
  74. asEP_SCRIPT_SCANNER = 11,
  75. asEP_INCLUDE_JIT_INSTRUCTIONS = 12,
  76. asEP_STRING_ENCODING = 13,
  77. asEP_PROPERTY_ACCESSOR_MODE = 14,
  78. asEP_EXPAND_DEF_ARRAY_TO_TMPL = 15,
  79. asEP_AUTO_GARBAGE_COLLECT = 16,
  80. asEP_DISALLOW_GLOBAL_VARS = 17,
  81. asEP_ALWAYS_IMPL_DEFAULT_CONSTRUCT = 18,
  82. asEP_COMPILER_WARNINGS = 19,
  83. asEP_DISALLOW_VALUE_ASSIGN_FOR_REF_TYPE = 20
  84. };
  85. // Calling conventions
  86. enum asECallConvTypes
  87. {
  88. asCALL_CDECL = 0,
  89. asCALL_STDCALL = 1,
  90. asCALL_THISCALL_ASGLOBAL = 2,
  91. asCALL_THISCALL = 3,
  92. asCALL_CDECL_OBJLAST = 4,
  93. asCALL_CDECL_OBJFIRST = 5,
  94. asCALL_GENERIC = 6
  95. };
  96. // Object type flags
  97. enum asEObjTypeFlags
  98. {
  99. asOBJ_REF = 0x01,
  100. asOBJ_VALUE = 0x02,
  101. asOBJ_GC = 0x04,
  102. asOBJ_POD = 0x08,
  103. asOBJ_NOHANDLE = 0x10,
  104. asOBJ_SCOPED = 0x20,
  105. asOBJ_TEMPLATE = 0x40,
  106. asOBJ_ASHANDLE = 0x80,
  107. asOBJ_APP_CLASS = 0x100,
  108. asOBJ_APP_CLASS_CONSTRUCTOR = 0x200,
  109. asOBJ_APP_CLASS_DESTRUCTOR = 0x400,
  110. asOBJ_APP_CLASS_ASSIGNMENT = 0x800,
  111. asOBJ_APP_CLASS_COPY_CONSTRUCTOR = 0x1000,
  112. asOBJ_APP_CLASS_C = (asOBJ_APP_CLASS + asOBJ_APP_CLASS_CONSTRUCTOR),
  113. asOBJ_APP_CLASS_CD = (asOBJ_APP_CLASS + asOBJ_APP_CLASS_CONSTRUCTOR + asOBJ_APP_CLASS_DESTRUCTOR),
  114. asOBJ_APP_CLASS_CA = (asOBJ_APP_CLASS + asOBJ_APP_CLASS_CONSTRUCTOR + asOBJ_APP_CLASS_ASSIGNMENT),
  115. asOBJ_APP_CLASS_CK = (asOBJ_APP_CLASS + asOBJ_APP_CLASS_CONSTRUCTOR + asOBJ_APP_CLASS_COPY_CONSTRUCTOR),
  116. asOBJ_APP_CLASS_CDA = (asOBJ_APP_CLASS + asOBJ_APP_CLASS_CONSTRUCTOR + asOBJ_APP_CLASS_DESTRUCTOR + asOBJ_APP_CLASS_ASSIGNMENT),
  117. asOBJ_APP_CLASS_CDK = (asOBJ_APP_CLASS + asOBJ_APP_CLASS_CONSTRUCTOR + asOBJ_APP_CLASS_DESTRUCTOR + asOBJ_APP_CLASS_COPY_CONSTRUCTOR),
  118. asOBJ_APP_CLASS_CAK = (asOBJ_APP_CLASS + asOBJ_APP_CLASS_CONSTRUCTOR + asOBJ_APP_CLASS_ASSIGNMENT + asOBJ_APP_CLASS_COPY_CONSTRUCTOR),
  119. asOBJ_APP_CLASS_CDAK = (asOBJ_APP_CLASS + asOBJ_APP_CLASS_CONSTRUCTOR + asOBJ_APP_CLASS_DESTRUCTOR + asOBJ_APP_CLASS_ASSIGNMENT + asOBJ_APP_CLASS_COPY_CONSTRUCTOR),
  120. asOBJ_APP_CLASS_D = (asOBJ_APP_CLASS + asOBJ_APP_CLASS_DESTRUCTOR),
  121. asOBJ_APP_CLASS_DA = (asOBJ_APP_CLASS + asOBJ_APP_CLASS_DESTRUCTOR + asOBJ_APP_CLASS_ASSIGNMENT),
  122. asOBJ_APP_CLASS_DK = (asOBJ_APP_CLASS + asOBJ_APP_CLASS_DESTRUCTOR + asOBJ_APP_CLASS_COPY_CONSTRUCTOR),
  123. asOBJ_APP_CLASS_DAK = (asOBJ_APP_CLASS + asOBJ_APP_CLASS_DESTRUCTOR + asOBJ_APP_CLASS_ASSIGNMENT + asOBJ_APP_CLASS_COPY_CONSTRUCTOR),
  124. asOBJ_APP_CLASS_A = (asOBJ_APP_CLASS + asOBJ_APP_CLASS_ASSIGNMENT),
  125. asOBJ_APP_CLASS_AK = (asOBJ_APP_CLASS + asOBJ_APP_CLASS_ASSIGNMENT + asOBJ_APP_CLASS_COPY_CONSTRUCTOR),
  126. asOBJ_APP_CLASS_K = (asOBJ_APP_CLASS + asOBJ_APP_CLASS_COPY_CONSTRUCTOR),
  127. asOBJ_APP_PRIMITIVE = 0x2000,
  128. asOBJ_APP_FLOAT = 0x4000,
  129. asOBJ_APP_CLASS_ALLINTS = 0x8000,
  130. asOBJ_APP_CLASS_ALLFLOATS = 0x10000,
  131. asOBJ_NOCOUNT = 0x20000,
  132. asOBJ_APP_CLASS_ALIGN8 = 0x40000,
  133. asOBJ_MASK_VALID_FLAGS = 0x7FFFF,
  134. asOBJ_SCRIPT_OBJECT = 0x80000,
  135. asOBJ_SHARED = 0x100000,
  136. asOBJ_NOINHERIT = 0x200000,
  137. asOBJ_SCRIPT_FUNCTION = 0x400000
  138. };
  139. // Behaviours
  140. enum asEBehaviours
  141. {
  142. // Value object memory management
  143. asBEHAVE_CONSTRUCT,
  144. asBEHAVE_DESTRUCT,
  145. // Reference object memory management
  146. asBEHAVE_FACTORY,
  147. asBEHAVE_LIST_FACTORY,
  148. asBEHAVE_ADDREF,
  149. asBEHAVE_RELEASE,
  150. asBEHAVE_GET_WEAKREF_FLAG,
  151. // Object operators
  152. asBEHAVE_VALUE_CAST,
  153. asBEHAVE_IMPLICIT_VALUE_CAST,
  154. asBEHAVE_REF_CAST,
  155. asBEHAVE_IMPLICIT_REF_CAST,
  156. asBEHAVE_TEMPLATE_CALLBACK,
  157. // Garbage collection behaviours
  158. asBEHAVE_FIRST_GC,
  159. asBEHAVE_GETREFCOUNT = asBEHAVE_FIRST_GC,
  160. asBEHAVE_SETGCFLAG,
  161. asBEHAVE_GETGCFLAG,
  162. asBEHAVE_ENUMREFS,
  163. asBEHAVE_RELEASEREFS,
  164. asBEHAVE_LAST_GC = asBEHAVE_RELEASEREFS,
  165. asBEHAVE_MAX
  166. };
  167. // Return codes
  168. enum asERetCodes
  169. {
  170. asSUCCESS = 0,
  171. asERROR = -1,
  172. asCONTEXT_ACTIVE = -2,
  173. asCONTEXT_NOT_FINISHED = -3,
  174. asCONTEXT_NOT_PREPARED = -4,
  175. asINVALID_ARG = -5,
  176. asNO_FUNCTION = -6,
  177. asNOT_SUPPORTED = -7,
  178. asINVALID_NAME = -8,
  179. asNAME_TAKEN = -9,
  180. asINVALID_DECLARATION = -10,
  181. asINVALID_OBJECT = -11,
  182. asINVALID_TYPE = -12,
  183. asALREADY_REGISTERED = -13,
  184. asMULTIPLE_FUNCTIONS = -14,
  185. asNO_MODULE = -15,
  186. asNO_GLOBAL_VAR = -16,
  187. asINVALID_CONFIGURATION = -17,
  188. asINVALID_INTERFACE = -18,
  189. asCANT_BIND_ALL_FUNCTIONS = -19,
  190. asLOWER_ARRAY_DIMENSION_NOT_REGISTERED = -20,
  191. asWRONG_CONFIG_GROUP = -21,
  192. asCONFIG_GROUP_IS_IN_USE = -22,
  193. asILLEGAL_BEHAVIOUR_FOR_TYPE = -23,
  194. asWRONG_CALLING_CONV = -24,
  195. asBUILD_IN_PROGRESS = -25,
  196. asINIT_GLOBAL_VARS_FAILED = -26,
  197. asOUT_OF_MEMORY = -27
  198. };
  199. // Context states
  200. enum asEContextState
  201. {
  202. asEXECUTION_FINISHED = 0,
  203. asEXECUTION_SUSPENDED = 1,
  204. asEXECUTION_ABORTED = 2,
  205. asEXECUTION_EXCEPTION = 3,
  206. asEXECUTION_PREPARED = 4,
  207. asEXECUTION_UNINITIALIZED = 5,
  208. asEXECUTION_ACTIVE = 6,
  209. asEXECUTION_ERROR = 7
  210. };
  211. // Message types
  212. enum asEMsgType
  213. {
  214. asMSGTYPE_ERROR = 0,
  215. asMSGTYPE_WARNING = 1,
  216. asMSGTYPE_INFORMATION = 2
  217. };
  218. // Garbage collector flags
  219. enum asEGCFlags
  220. {
  221. asGC_FULL_CYCLE = 1,
  222. asGC_ONE_STEP = 2,
  223. asGC_DESTROY_GARBAGE = 4,
  224. asGC_DETECT_GARBAGE = 8
  225. };
  226. // Token classes
  227. enum asETokenClass
  228. {
  229. asTC_UNKNOWN = 0,
  230. asTC_KEYWORD = 1,
  231. asTC_VALUE = 2,
  232. asTC_IDENTIFIER = 3,
  233. asTC_COMMENT = 4,
  234. asTC_WHITESPACE = 5
  235. };
  236. // Type id flags
  237. enum asETypeIdFlags
  238. {
  239. asTYPEID_VOID = 0,
  240. asTYPEID_BOOL = 1,
  241. asTYPEID_INT8 = 2,
  242. asTYPEID_INT16 = 3,
  243. asTYPEID_INT32 = 4,
  244. asTYPEID_INT64 = 5,
  245. asTYPEID_UINT8 = 6,
  246. asTYPEID_UINT16 = 7,
  247. asTYPEID_UINT32 = 8,
  248. asTYPEID_UINT64 = 9,
  249. asTYPEID_FLOAT = 10,
  250. asTYPEID_DOUBLE = 11,
  251. asTYPEID_OBJHANDLE = 0x40000000,
  252. asTYPEID_HANDLETOCONST = 0x20000000,
  253. asTYPEID_MASK_OBJECT = 0x1C000000,
  254. asTYPEID_APPOBJECT = 0x04000000,
  255. asTYPEID_SCRIPTOBJECT = 0x08000000,
  256. asTYPEID_TEMPLATE = 0x10000000,
  257. asTYPEID_MASK_SEQNBR = 0x03FFFFFF
  258. };
  259. // Type modifiers
  260. enum asETypeModifiers
  261. {
  262. asTM_NONE = 0,
  263. asTM_INREF = 1,
  264. asTM_OUTREF = 2,
  265. asTM_INOUTREF = 3,
  266. asTM_CONST = 4
  267. };
  268. // GetModule flags
  269. enum asEGMFlags
  270. {
  271. asGM_ONLY_IF_EXISTS = 0,
  272. asGM_CREATE_IF_NOT_EXISTS = 1,
  273. asGM_ALWAYS_CREATE = 2
  274. };
  275. // Compile flags
  276. enum asECompileFlags
  277. {
  278. asCOMP_ADD_TO_MODULE = 1
  279. };
  280. // Function types
  281. enum asEFuncType
  282. {
  283. asFUNC_DUMMY =-1,
  284. asFUNC_SYSTEM = 0,
  285. asFUNC_SCRIPT = 1,
  286. asFUNC_INTERFACE = 2,
  287. asFUNC_VIRTUAL = 3,
  288. asFUNC_FUNCDEF = 4,
  289. asFUNC_IMPORTED = 5,
  290. asFUNC_DELEGATE = 6
  291. };
  292. //
  293. // asBYTE = 8 bits
  294. // asWORD = 16 bits
  295. // asDWORD = 32 bits
  296. // asQWORD = 64 bits
  297. // asPWORD = size of pointer
  298. //
  299. typedef unsigned char asBYTE;
  300. typedef unsigned short asWORD;
  301. typedef unsigned int asUINT;
  302. #if (defined(_MSC_VER) && _MSC_VER <= 1200) || defined(__S3E__)
  303. // size_t is not really correct, since it only guaranteed to be large enough to hold the segment size.
  304. // For example, on 16bit systems the size_t may be 16bits only even if pointers are 32bit. But nobody
  305. // is likely to use MSVC6 to compile for 16bit systems anymore, so this should be ok.
  306. typedef size_t asPWORD;
  307. #else
  308. typedef uintptr_t asPWORD;
  309. #endif
  310. #ifdef __LP64__
  311. typedef unsigned int asDWORD;
  312. typedef unsigned long asQWORD;
  313. typedef long asINT64;
  314. #else
  315. typedef unsigned long asDWORD;
  316. #if defined(__GNUC__) || defined(__MWERKS__)
  317. typedef uint64_t asQWORD;
  318. typedef int64_t asINT64;
  319. #else
  320. typedef unsigned __int64 asQWORD;
  321. typedef __int64 asINT64;
  322. #endif
  323. #endif
  324. // Is the target a 64bit system?
  325. #if defined(__LP64__) || defined(__amd64__) || defined(__x86_64__) || defined(_M_X64)
  326. #ifndef AS_64BIT_PTR
  327. #define AS_64BIT_PTR
  328. #endif
  329. #endif
  330. typedef void (*asFUNCTION_t)();
  331. typedef void (*asGENFUNC_t)(asIScriptGeneric *);
  332. typedef void *(*asALLOCFUNC_t)(size_t);
  333. typedef void (*asFREEFUNC_t)(void *);
  334. typedef void (*asCLEANENGINEFUNC_t)(asIScriptEngine *);
  335. typedef void (*asCLEANMODULEFUNC_t)(asIScriptModule *);
  336. typedef void (*asCLEANCONTEXTFUNC_t)(asIScriptContext *);
  337. typedef void (*asCLEANFUNCTIONFUNC_t)(asIScriptFunction *);
  338. typedef void (*asCLEANOBJECTTYPEFUNC_t)(asIObjectType *);
  339. // This macro does basically the same thing as offsetof defined in stddef.h, but
  340. // GNUC should not complain about the usage as I'm not using 0 as the base pointer.
  341. #define asOFFSET(s,m) ((size_t)(&reinterpret_cast<s*>(100000)->m)-100000)
  342. #define asFUNCTION(f) asFunctionPtr(f)
  343. #if (defined(_MSC_VER) && _MSC_VER <= 1200) || (defined(__BORLANDC__) && __BORLANDC__ < 0x590)
  344. // MSVC 6 has a bug that prevents it from properly compiling using the correct asFUNCTIONPR with operator >
  345. // so we need to use ordinary C style cast instead of static_cast. The drawback is that the compiler can't
  346. // check that the cast is really valid.
  347. // BCC v5.8 (C++Builder 2006) and earlier have a similar bug which forces us to fall back to a C-style cast.
  348. #define asFUNCTIONPR(f,p,r) asFunctionPtr((void (*)())((r (*)p)(f)))
  349. #else
  350. #define asFUNCTIONPR(f,p,r) asFunctionPtr((void (*)())(static_cast<r (*)p>(f)))
  351. #endif
  352. #ifndef AS_NO_CLASS_METHODS
  353. class asCUnknownClass;
  354. typedef void (asCUnknownClass::*asMETHOD_t)();
  355. struct asSFuncPtr
  356. {
  357. asSFuncPtr(asBYTE f)
  358. {
  359. for( size_t n = 0; n < sizeof(ptr.dummy); n++ )
  360. ptr.dummy[n] = 0;
  361. flag = f;
  362. }
  363. void CopyMethodPtr(const void *mthdPtr, size_t size)
  364. {
  365. for( size_t n = 0; n < size; n++ )
  366. ptr.dummy[n] = reinterpret_cast<const char *>(mthdPtr)[n];
  367. }
  368. union
  369. {
  370. // The largest known method point is 20 bytes (MSVC 64bit),
  371. // but with 8byte alignment this becomes 24 bytes. So we need
  372. // to be able to store at least that much.
  373. char dummy[25];
  374. struct {asMETHOD_t mthd; char dummy[25-sizeof(asMETHOD_t)];} m;
  375. struct {asFUNCTION_t func; char dummy[25-sizeof(asFUNCTION_t)];} f;
  376. } ptr;
  377. asBYTE flag; // 1 = generic, 2 = global func, 3 = method
  378. };
  379. #if defined(__BORLANDC__)
  380. // A bug in BCC (QC #85374) makes it impossible to distinguish const/non-const method overloads
  381. // with static_cast<>. The workaround is to use an _implicit_cast instead.
  382. #if __BORLANDC__ < 0x590
  383. // BCC v5.8 (C++Builder 2006) and earlier have an even more annoying bug which causes
  384. // the "pretty" workaround below (with _implicit_cast<>) to fail. For these compilers
  385. // we need to use a traditional C-style cast.
  386. #define AS_METHOD_AMBIGUITY_CAST(t) (t)
  387. #else
  388. template <typename T>
  389. T _implicit_cast (T val)
  390. { return val; }
  391. #define AS_METHOD_AMBIGUITY_CAST(t) AS_NAMESPACE_QUALIFIER _implicit_cast<t >
  392. #endif
  393. #else
  394. #define AS_METHOD_AMBIGUITY_CAST(t) static_cast<t >
  395. #endif
  396. #define asMETHOD(c,m) asSMethodPtr<sizeof(void (c::*)())>::Convert((void (c::*)())(&c::m))
  397. #define asMETHODPR(c,m,p,r) asSMethodPtr<sizeof(void (c::*)())>::Convert(AS_METHOD_AMBIGUITY_CAST(r (c::*)p)(&c::m))
  398. #else // Class methods are disabled
  399. struct asSFuncPtr
  400. {
  401. asSFuncPtr(asBYTE f)
  402. {
  403. for( int n = 0; n < sizeof(ptr.dummy); n++ )
  404. ptr.dummy[n] = 0;
  405. flag = f;
  406. }
  407. union
  408. {
  409. char dummy[25]; // largest known class method pointer
  410. struct {asFUNCTION_t func; char dummy[25-sizeof(asFUNCTION_t)];} f;
  411. } ptr;
  412. asBYTE flag; // 1 = generic, 2 = global func
  413. };
  414. #endif
  415. struct asSMessageInfo
  416. {
  417. const char *section;
  418. int row;
  419. int col;
  420. asEMsgType type;
  421. const char *message;
  422. };
  423. // API functions
  424. // ANGELSCRIPT_EXPORT is defined when compiling the dll or lib
  425. // ANGELSCRIPT_DLL_LIBRARY_IMPORT is defined when dynamically linking to the
  426. // dll through the link lib automatically generated by MSVC++
  427. // ANGELSCRIPT_DLL_MANUAL_IMPORT is defined when manually loading the dll
  428. // Don't define anything when linking statically to the lib
  429. #if defined(WIN32) || defined(_WIN32) || defined(__CYGWIN__)
  430. #if defined(ANGELSCRIPT_EXPORT)
  431. #define AS_API __declspec(dllexport)
  432. #elif defined(ANGELSCRIPT_DLL_LIBRARY_IMPORT)
  433. #define AS_API __declspec(dllimport)
  434. #else // statically linked library
  435. #define AS_API
  436. #endif
  437. #elif defined(__GNUC__)
  438. #if defined(ANGELSCRIPT_EXPORT)
  439. #define AS_API __attribute__((visibility ("default")))
  440. #else
  441. #define AS_API
  442. #endif
  443. #else
  444. #define AS_API
  445. #endif
  446. #ifndef ANGELSCRIPT_DLL_MANUAL_IMPORT
  447. extern "C"
  448. {
  449. // Engine
  450. AS_API asIScriptEngine *asCreateScriptEngine(asDWORD version);
  451. AS_API const char *asGetLibraryVersion();
  452. AS_API const char *asGetLibraryOptions();
  453. // Context
  454. AS_API asIScriptContext *asGetActiveContext();
  455. // Thread support
  456. AS_API int asPrepareMultithread(asIThreadManager *externalMgr = 0);
  457. AS_API void asUnprepareMultithread();
  458. AS_API asIThreadManager *asGetThreadManager();
  459. AS_API void asAcquireExclusiveLock();
  460. AS_API void asReleaseExclusiveLock();
  461. AS_API void asAcquireSharedLock();
  462. AS_API void asReleaseSharedLock();
  463. AS_API int asAtomicInc(int &value);
  464. AS_API int asAtomicDec(int &value);
  465. AS_API int asThreadCleanup();
  466. // Memory management
  467. AS_API int asSetGlobalMemoryFunctions(asALLOCFUNC_t allocFunc, asFREEFUNC_t freeFunc);
  468. AS_API int asResetGlobalMemoryFunctions();
  469. // Auxiliary
  470. AS_API asILockableSharedBool *asCreateLockableSharedBool();
  471. }
  472. #endif // ANGELSCRIPT_DLL_MANUAL_IMPORT
  473. // Interface declarations
  474. class asIScriptEngine
  475. {
  476. public:
  477. // Memory management
  478. virtual int AddRef() const = 0;
  479. virtual int Release() const = 0;
  480. // Engine properties
  481. virtual int SetEngineProperty(asEEngineProp property, asPWORD value) = 0;
  482. virtual asPWORD GetEngineProperty(asEEngineProp property) const = 0;
  483. // Compiler messages
  484. virtual int SetMessageCallback(const asSFuncPtr &callback, void *obj, asDWORD callConv) = 0;
  485. virtual int ClearMessageCallback() = 0;
  486. virtual int WriteMessage(const char *section, int row, int col, asEMsgType type, const char *message) = 0;
  487. // JIT Compiler
  488. virtual int SetJITCompiler(asIJITCompiler *compiler) = 0;
  489. virtual asIJITCompiler *GetJITCompiler() const = 0;
  490. // Global functions
  491. virtual int RegisterGlobalFunction(const char *declaration, const asSFuncPtr &funcPointer, asDWORD callConv, void *objForThiscall = 0) = 0;
  492. virtual asUINT GetGlobalFunctionCount() const = 0;
  493. virtual asIScriptFunction *GetGlobalFunctionByIndex(asUINT index) const = 0;
  494. virtual asIScriptFunction *GetGlobalFunctionByDecl(const char *declaration) const = 0;
  495. // Global properties
  496. virtual int RegisterGlobalProperty(const char *declaration, void *pointer) = 0;
  497. virtual asUINT GetGlobalPropertyCount() const = 0;
  498. virtual int GetGlobalPropertyByIndex(asUINT index, const char **name, const char **nameSpace = 0, int *typeId = 0, bool *isConst = 0, const char **configGroup = 0, void **pointer = 0, asDWORD *accessMask = 0) const = 0;
  499. virtual int GetGlobalPropertyIndexByName(const char *name) const = 0;
  500. virtual int GetGlobalPropertyIndexByDecl(const char *decl) const = 0;
  501. // Object types
  502. virtual int RegisterObjectType(const char *obj, int byteSize, asDWORD flags) = 0;
  503. virtual int RegisterObjectProperty(const char *obj, const char *declaration, int byteOffset) = 0;
  504. virtual int RegisterObjectMethod(const char *obj, const char *declaration, const asSFuncPtr &funcPointer, asDWORD callConv) = 0;
  505. virtual int RegisterObjectBehaviour(const char *obj, asEBehaviours behaviour, const char *declaration, const asSFuncPtr &funcPointer, asDWORD callConv, void *objForThiscall = 0) = 0;
  506. virtual int RegisterInterface(const char *name) = 0;
  507. virtual int RegisterInterfaceMethod(const char *intf, const char *declaration) = 0;
  508. virtual asUINT GetObjectTypeCount() const = 0;
  509. virtual asIObjectType *GetObjectTypeByIndex(asUINT index) const = 0;
  510. virtual asIObjectType *GetObjectTypeByName(const char *name) const = 0;
  511. // String factory
  512. virtual int RegisterStringFactory(const char *datatype, const asSFuncPtr &factoryFunc, asDWORD callConv, void *objForThiscall = 0) = 0;
  513. virtual int GetStringFactoryReturnTypeId() const = 0;
  514. // Default array type
  515. virtual int RegisterDefaultArrayType(const char *type) = 0;
  516. virtual int GetDefaultArrayTypeId() const = 0;
  517. // Enums
  518. virtual int RegisterEnum(const char *type) = 0;
  519. virtual int RegisterEnumValue(const char *type, const char *name, int value) = 0;
  520. virtual asUINT GetEnumCount() const = 0;
  521. virtual const char *GetEnumByIndex(asUINT index, int *enumTypeId, const char **nameSpace = 0, const char **configGroup = 0, asDWORD *accessMask = 0) const = 0;
  522. virtual int GetEnumValueCount(int enumTypeId) const = 0;
  523. virtual const char *GetEnumValueByIndex(int enumTypeId, asUINT index, int *outValue) const = 0;
  524. // Funcdefs
  525. virtual int RegisterFuncdef(const char *decl) = 0;
  526. virtual asUINT GetFuncdefCount() const = 0;
  527. virtual asIScriptFunction *GetFuncdefByIndex(asUINT index) const = 0;
  528. // Typedefs
  529. virtual int RegisterTypedef(const char *type, const char *decl) = 0;
  530. virtual asUINT GetTypedefCount() const = 0;
  531. virtual const char *GetTypedefByIndex(asUINT index, int *typeId, const char **nameSpace = 0, const char **configGroup = 0, asDWORD *accessMask = 0) const = 0;
  532. // Configuration groups
  533. virtual int BeginConfigGroup(const char *groupName) = 0;
  534. virtual int EndConfigGroup() = 0;
  535. virtual int RemoveConfigGroup(const char *groupName) = 0;
  536. virtual asDWORD SetDefaultAccessMask(asDWORD defaultMask) = 0;
  537. virtual int SetDefaultNamespace(const char *nameSpace) = 0;
  538. virtual const char *GetDefaultNamespace() const = 0;
  539. // Script modules
  540. virtual asIScriptModule *GetModule(const char *module, asEGMFlags flag = asGM_ONLY_IF_EXISTS) = 0;
  541. virtual int DiscardModule(const char *module) = 0;
  542. // Script functions
  543. virtual asIScriptFunction *GetFunctionById(int funcId) const = 0;
  544. virtual asIScriptFunction *GetFuncDefFromTypeId(int typeId) const = 0;
  545. // Type identification
  546. virtual asIObjectType *GetObjectTypeById(int typeId) const = 0;
  547. virtual int GetTypeIdByDecl(const char *decl) const = 0;
  548. virtual const char *GetTypeDeclaration(int typeId, bool includeNamespace = false) const = 0;
  549. virtual int GetSizeOfPrimitiveType(int typeId) const = 0;
  550. // Script execution
  551. virtual asIScriptContext *CreateContext() = 0;
  552. #ifdef AS_DEPRECATED
  553. // Deprecated since 2.27.0, 2013-07-18
  554. virtual void *CreateScriptObject(int typeId) = 0;
  555. virtual void *CreateScriptObjectCopy(void *obj, int typeId) = 0;
  556. virtual void *CreateUninitializedScriptObject(int typeId) = 0;
  557. virtual void AssignScriptObject(void *dstObj, void *srcObj, int typeId) = 0;
  558. virtual void ReleaseScriptObject(void *obj, int typeId) = 0;
  559. virtual void AddRefScriptObject(void *obj, int typeId) = 0;
  560. #endif
  561. virtual void *CreateScriptObject(const asIObjectType *type) = 0;
  562. virtual void *CreateScriptObjectCopy(void *obj, const asIObjectType *type) = 0;
  563. virtual void *CreateUninitializedScriptObject(const asIObjectType *type) = 0;
  564. virtual asIScriptFunction *CreateDelegate(asIScriptFunction *func, void *obj) = 0;
  565. virtual void AssignScriptObject(void *dstObj, void *srcObj, const asIObjectType *type) = 0;
  566. virtual void ReleaseScriptObject(void *obj, const asIObjectType *type) = 0;
  567. virtual void AddRefScriptObject(void *obj, const asIObjectType *type) = 0;
  568. virtual bool IsHandleCompatibleWithObject(void *obj, int objTypeId, int handleTypeId) const = 0;
  569. virtual asILockableSharedBool *GetWeakRefFlagOfScriptObject(void *obj, const asIObjectType *type) const = 0;
  570. // String interpretation
  571. virtual asETokenClass ParseToken(const char *string, size_t stringLength = 0, int *tokenLength = 0) const = 0;
  572. // Garbage collection
  573. virtual int GarbageCollect(asDWORD flags = asGC_FULL_CYCLE) = 0;
  574. virtual void GetGCStatistics(asUINT *currentSize, asUINT *totalDestroyed = 0, asUINT *totalDetected = 0, asUINT *newObjects = 0, asUINT *totalNewDestroyed = 0) const = 0;
  575. virtual int NotifyGarbageCollectorOfNewObject(void *obj, asIObjectType *type) = 0;
  576. virtual int GetObjectInGC(asUINT idx, asUINT *seqNbr = 0, void **obj = 0, asIObjectType **type = 0) = 0;
  577. virtual void GCEnumCallback(void *reference) = 0;
  578. // User data
  579. virtual void *SetUserData(void *data, asPWORD type = 0) = 0;
  580. virtual void *GetUserData(asPWORD type = 0) const = 0;
  581. virtual void SetEngineUserDataCleanupCallback(asCLEANENGINEFUNC_t callback, asPWORD type = 0) = 0;
  582. virtual void SetModuleUserDataCleanupCallback(asCLEANMODULEFUNC_t callback) = 0;
  583. virtual void SetContextUserDataCleanupCallback(asCLEANCONTEXTFUNC_t callback) = 0;
  584. virtual void SetFunctionUserDataCleanupCallback(asCLEANFUNCTIONFUNC_t callback) = 0;
  585. virtual void SetObjectTypeUserDataCleanupCallback(asCLEANOBJECTTYPEFUNC_t callback, asPWORD type = 0) = 0;
  586. protected:
  587. virtual ~asIScriptEngine() {}
  588. };
  589. class asIThreadManager
  590. {
  591. protected:
  592. virtual ~asIThreadManager() {}
  593. };
  594. class asIScriptModule
  595. {
  596. public:
  597. virtual asIScriptEngine *GetEngine() const = 0;
  598. virtual void SetName(const char *name) = 0;
  599. virtual const char *GetName() const = 0;
  600. virtual void Discard() = 0;
  601. // Compilation
  602. virtual int AddScriptSection(const char *name, const char *code, size_t codeLength = 0, int lineOffset = 0) = 0;
  603. virtual int Build() = 0;
  604. virtual int CompileFunction(const char *sectionName, const char *code, int lineOffset, asDWORD compileFlags, asIScriptFunction **outFunc) = 0;
  605. virtual int CompileGlobalVar(const char *sectionName, const char *code, int lineOffset) = 0;
  606. virtual asDWORD SetAccessMask(asDWORD accessMask) = 0;
  607. virtual int SetDefaultNamespace(const char *nameSpace) = 0;
  608. virtual const char *GetDefaultNamespace() const = 0;
  609. // Functions
  610. virtual asUINT GetFunctionCount() const = 0;
  611. virtual asIScriptFunction *GetFunctionByIndex(asUINT index) const = 0;
  612. virtual asIScriptFunction *GetFunctionByDecl(const char *decl) const = 0;
  613. virtual asIScriptFunction *GetFunctionByName(const char *name) const = 0;
  614. virtual int RemoveFunction(asIScriptFunction *func) = 0;
  615. // Global variables
  616. virtual int ResetGlobalVars(asIScriptContext *ctx = 0) = 0;
  617. virtual asUINT GetGlobalVarCount() const = 0;
  618. virtual int GetGlobalVarIndexByName(const char *name) const = 0;
  619. virtual int GetGlobalVarIndexByDecl(const char *decl) const = 0;
  620. virtual const char *GetGlobalVarDeclaration(asUINT index, bool includeNamespace = false) const = 0;
  621. virtual int GetGlobalVar(asUINT index, const char **name, const char **nameSpace = 0, int *typeId = 0, bool *isConst = 0) const = 0;
  622. virtual void *GetAddressOfGlobalVar(asUINT index) = 0;
  623. virtual int RemoveGlobalVar(asUINT index) = 0;
  624. // Type identification
  625. virtual asUINT GetObjectTypeCount() const = 0;
  626. virtual asIObjectType *GetObjectTypeByIndex(asUINT index) const = 0;
  627. virtual asIObjectType *GetObjectTypeByName(const char *name) const = 0;
  628. virtual int GetTypeIdByDecl(const char *decl) const = 0;
  629. // Enums
  630. virtual asUINT GetEnumCount() const = 0;
  631. virtual const char *GetEnumByIndex(asUINT index, int *enumTypeId, const char **nameSpace = 0) const = 0;
  632. virtual int GetEnumValueCount(int enumTypeId) const = 0;
  633. virtual const char *GetEnumValueByIndex(int enumTypeId, asUINT index, int *outValue) const = 0;
  634. // Typedefs
  635. virtual asUINT GetTypedefCount() const = 0;
  636. virtual const char *GetTypedefByIndex(asUINT index, int *typeId, const char **nameSpace = 0) const = 0;
  637. // Dynamic binding between modules
  638. virtual asUINT GetImportedFunctionCount() const = 0;
  639. virtual int GetImportedFunctionIndexByDecl(const char *decl) const = 0;
  640. virtual const char *GetImportedFunctionDeclaration(asUINT importIndex) const = 0;
  641. virtual const char *GetImportedFunctionSourceModule(asUINT importIndex) const = 0;
  642. virtual int BindImportedFunction(asUINT importIndex, asIScriptFunction *func) = 0;
  643. virtual int UnbindImportedFunction(asUINT importIndex) = 0;
  644. virtual int BindAllImportedFunctions() = 0;
  645. virtual int UnbindAllImportedFunctions() = 0;
  646. // Bytecode saving and loading
  647. virtual int SaveByteCode(asIBinaryStream *out, bool stripDebugInfo = false) const = 0;
  648. virtual int LoadByteCode(asIBinaryStream *in, bool *wasDebugInfoStripped = 0) = 0;
  649. // User data
  650. virtual void *SetUserData(void *data) = 0;
  651. virtual void *GetUserData() const = 0;
  652. protected:
  653. virtual ~asIScriptModule() {}
  654. };
  655. class asIScriptContext
  656. {
  657. public:
  658. // Memory management
  659. virtual int AddRef() const = 0;
  660. virtual int Release() const = 0;
  661. // Miscellaneous
  662. virtual asIScriptEngine *GetEngine() const = 0;
  663. // Execution
  664. virtual int Prepare(asIScriptFunction *func) = 0;
  665. virtual int Unprepare() = 0;
  666. virtual int Execute() = 0;
  667. virtual int Abort() = 0;
  668. virtual int Suspend() = 0;
  669. virtual asEContextState GetState() const = 0;
  670. virtual int PushState() = 0;
  671. virtual int PopState() = 0;
  672. virtual bool IsNested(asUINT *nestCount = 0) const = 0;
  673. // Object pointer for calling class methods
  674. virtual int SetObject(void *obj) = 0;
  675. // Arguments
  676. virtual int SetArgByte(asUINT arg, asBYTE value) = 0;
  677. virtual int SetArgWord(asUINT arg, asWORD value) = 0;
  678. virtual int SetArgDWord(asUINT arg, asDWORD value) = 0;
  679. virtual int SetArgQWord(asUINT arg, asQWORD value) = 0;
  680. virtual int SetArgFloat(asUINT arg, float value) = 0;
  681. virtual int SetArgDouble(asUINT arg, double value) = 0;
  682. virtual int SetArgAddress(asUINT arg, void *addr) = 0;
  683. virtual int SetArgObject(asUINT arg, void *obj) = 0;
  684. virtual void *GetAddressOfArg(asUINT arg) = 0;
  685. // Return value
  686. virtual asBYTE GetReturnByte() = 0;
  687. virtual asWORD GetReturnWord() = 0;
  688. virtual asDWORD GetReturnDWord() = 0;
  689. virtual asQWORD GetReturnQWord() = 0;
  690. virtual float GetReturnFloat() = 0;
  691. virtual double GetReturnDouble() = 0;
  692. virtual void *GetReturnAddress() = 0;
  693. virtual void *GetReturnObject() = 0;
  694. virtual void *GetAddressOfReturnValue() = 0;
  695. // Exception handling
  696. virtual int SetException(const char *string) = 0;
  697. virtual int GetExceptionLineNumber(int *column = 0, const char **sectionName = 0) = 0;
  698. virtual asIScriptFunction *GetExceptionFunction() = 0;
  699. virtual const char * GetExceptionString() = 0;
  700. virtual int SetExceptionCallback(asSFuncPtr callback, void *obj, int callConv) = 0;
  701. virtual void ClearExceptionCallback() = 0;
  702. // Debugging
  703. virtual int SetLineCallback(asSFuncPtr callback, void *obj, int callConv) = 0;
  704. virtual void ClearLineCallback() = 0;
  705. virtual asUINT GetCallstackSize() const = 0;
  706. virtual asIScriptFunction *GetFunction(asUINT stackLevel = 0) = 0;
  707. virtual int GetLineNumber(asUINT stackLevel = 0, int *column = 0, const char **sectionName = 0) = 0;
  708. virtual int GetVarCount(asUINT stackLevel = 0) = 0;
  709. virtual const char *GetVarName(asUINT varIndex, asUINT stackLevel = 0) = 0;
  710. virtual const char *GetVarDeclaration(asUINT varIndex, asUINT stackLevel = 0) = 0;
  711. virtual int GetVarTypeId(asUINT varIndex, asUINT stackLevel = 0) = 0;
  712. virtual void *GetAddressOfVar(asUINT varIndex, asUINT stackLevel = 0) = 0;
  713. virtual bool IsVarInScope(asUINT varIndex, asUINT stackLevel = 0) = 0;
  714. virtual int GetThisTypeId(asUINT stackLevel = 0) = 0;
  715. virtual void *GetThisPointer(asUINT stackLevel = 0) = 0;
  716. virtual asIScriptFunction *GetSystemFunction() = 0;
  717. // User data
  718. virtual void *SetUserData(void *data) = 0;
  719. virtual void *GetUserData() const = 0;
  720. protected:
  721. virtual ~asIScriptContext() {}
  722. };
  723. class asIScriptGeneric
  724. {
  725. public:
  726. // Miscellaneous
  727. virtual asIScriptEngine *GetEngine() const = 0;
  728. virtual asIScriptFunction *GetFunction() const = 0;
  729. // Object
  730. virtual void *GetObject() = 0;
  731. virtual int GetObjectTypeId() const = 0;
  732. // Arguments
  733. virtual int GetArgCount() const = 0;
  734. virtual int GetArgTypeId(asUINT arg, asDWORD *flags = 0) const = 0;
  735. virtual asBYTE GetArgByte(asUINT arg) = 0;
  736. virtual asWORD GetArgWord(asUINT arg) = 0;
  737. virtual asDWORD GetArgDWord(asUINT arg) = 0;
  738. virtual asQWORD GetArgQWord(asUINT arg) = 0;
  739. virtual float GetArgFloat(asUINT arg) = 0;
  740. virtual double GetArgDouble(asUINT arg) = 0;
  741. virtual void *GetArgAddress(asUINT arg) = 0;
  742. virtual void *GetArgObject(asUINT arg) = 0;
  743. virtual void *GetAddressOfArg(asUINT arg) = 0;
  744. // Return value
  745. virtual int GetReturnTypeId(asDWORD *flags = 0) const = 0;
  746. virtual int SetReturnByte(asBYTE val) = 0;
  747. virtual int SetReturnWord(asWORD val) = 0;
  748. virtual int SetReturnDWord(asDWORD val) = 0;
  749. virtual int SetReturnQWord(asQWORD val) = 0;
  750. virtual int SetReturnFloat(float val) = 0;
  751. virtual int SetReturnDouble(double val) = 0;
  752. virtual int SetReturnAddress(void *addr) = 0;
  753. virtual int SetReturnObject(void *obj) = 0;
  754. virtual void *GetAddressOfReturnLocation() = 0;
  755. protected:
  756. virtual ~asIScriptGeneric() {}
  757. };
  758. class asIScriptObject
  759. {
  760. public:
  761. // Memory management
  762. virtual int AddRef() const = 0;
  763. virtual int Release() const = 0;
  764. // Type info
  765. virtual int GetTypeId() const = 0;
  766. virtual asIObjectType *GetObjectType() const = 0;
  767. // Class properties
  768. virtual asUINT GetPropertyCount() const = 0;
  769. virtual int GetPropertyTypeId(asUINT prop) const = 0;
  770. virtual const char *GetPropertyName(asUINT prop) const = 0;
  771. virtual void *GetAddressOfProperty(asUINT prop) = 0;
  772. virtual asIScriptEngine *GetEngine() const = 0;
  773. virtual int CopyFrom(asIScriptObject *other) = 0;
  774. // Urho3D: added userdata
  775. virtual void *SetUserData(void *data) = 0;
  776. virtual void *GetUserData() const = 0;
  777. protected:
  778. virtual ~asIScriptObject() {}
  779. };
  780. class asIObjectType
  781. {
  782. public:
  783. virtual asIScriptEngine *GetEngine() const = 0;
  784. virtual const char *GetConfigGroup() const = 0;
  785. virtual asDWORD GetAccessMask() const = 0;
  786. virtual asIScriptModule *GetModule() const = 0;
  787. // Memory management
  788. virtual int AddRef() const = 0;
  789. virtual int Release() const = 0;
  790. // Type info
  791. virtual const char *GetName() const = 0;
  792. virtual const char *GetNamespace() const = 0;
  793. virtual asIObjectType *GetBaseType() const = 0;
  794. virtual bool DerivesFrom(const asIObjectType *objType) const = 0;
  795. virtual asDWORD GetFlags() const = 0;
  796. virtual asUINT GetSize() const = 0;
  797. virtual int GetTypeId() const = 0;
  798. virtual int GetSubTypeId(asUINT subTypeIndex = 0) const = 0;
  799. virtual asIObjectType *GetSubType(asUINT subTypeIndex = 0) const = 0;
  800. virtual asUINT GetSubTypeCount() const = 0;
  801. // Interfaces
  802. virtual asUINT GetInterfaceCount() const = 0;
  803. virtual asIObjectType *GetInterface(asUINT index) const = 0;
  804. virtual bool Implements(const asIObjectType *objType) const = 0;
  805. // Factories
  806. virtual asUINT GetFactoryCount() const = 0;
  807. virtual asIScriptFunction *GetFactoryByIndex(asUINT index) const = 0;
  808. virtual asIScriptFunction *GetFactoryByDecl(const char *decl) const = 0;
  809. // Methods
  810. virtual asUINT GetMethodCount() const = 0;
  811. virtual asIScriptFunction *GetMethodByIndex(asUINT index, bool getVirtual = true) const = 0;
  812. virtual asIScriptFunction *GetMethodByName(const char *name, bool getVirtual = true) const = 0;
  813. virtual asIScriptFunction *GetMethodByDecl(const char *decl, bool getVirtual = true) const = 0;
  814. // Properties
  815. virtual asUINT GetPropertyCount() const = 0;
  816. virtual int GetProperty(asUINT index, const char **name, int *typeId = 0, bool *isPrivate = 0, int *offset = 0, bool *isReference = 0, asDWORD *accessMask = 0) const = 0;
  817. virtual const char *GetPropertyDeclaration(asUINT index) const = 0;
  818. // Behaviours
  819. virtual asUINT GetBehaviourCount() const = 0;
  820. virtual asIScriptFunction *GetBehaviourByIndex(asUINT index, asEBehaviours *outBehaviour) const = 0;
  821. // User data
  822. virtual void *SetUserData(void *data, asPWORD type = 0) = 0;
  823. virtual void *GetUserData(asPWORD type = 0) const = 0;
  824. protected:
  825. virtual ~asIObjectType() {}
  826. };
  827. class asIScriptFunction
  828. {
  829. public:
  830. virtual asIScriptEngine *GetEngine() const = 0;
  831. // Memory management
  832. virtual int AddRef() const = 0;
  833. virtual int Release() const = 0;
  834. // Miscellaneous
  835. virtual int GetId() const = 0;
  836. virtual asEFuncType GetFuncType() const = 0;
  837. virtual const char *GetModuleName() const = 0;
  838. virtual asIScriptModule *GetModule() const = 0;
  839. virtual const char *GetScriptSectionName() const = 0;
  840. virtual const char *GetConfigGroup() const = 0;
  841. virtual asDWORD GetAccessMask() const = 0;
  842. // Function signature
  843. virtual asIObjectType *GetObjectType() const = 0;
  844. virtual const char *GetObjectName() const = 0;
  845. virtual const char *GetName() const = 0;
  846. virtual const char *GetNamespace() const = 0;
  847. virtual const char *GetDeclaration(bool includeObjectName = true, bool includeNamespace = false) const = 0;
  848. virtual bool IsReadOnly() const = 0;
  849. virtual bool IsPrivate() const = 0;
  850. virtual bool IsFinal() const = 0;
  851. virtual bool IsOverride() const = 0;
  852. virtual bool IsShared() const = 0;
  853. virtual asUINT GetParamCount() const = 0;
  854. virtual int GetParamTypeId(asUINT index, asDWORD *flags = 0) const = 0;
  855. virtual int GetReturnTypeId(asDWORD *flags = 0) const = 0;
  856. // Type id for function pointers
  857. virtual int GetTypeId() const = 0;
  858. virtual bool IsCompatibleWithTypeId(int typeId) const = 0;
  859. // Delegates
  860. virtual void *GetDelegateObject() const = 0;
  861. virtual asIObjectType *GetDelegateObjectType() const = 0;
  862. virtual asIScriptFunction *GetDelegateFunction() const = 0;
  863. // Debug information
  864. virtual asUINT GetVarCount() const = 0;
  865. virtual int GetVar(asUINT index, const char **name, int *typeId = 0) const = 0;
  866. virtual const char *GetVarDecl(asUINT index) const = 0;
  867. virtual int FindNextLineWithCode(int line) const = 0;
  868. // For JIT compilation
  869. virtual asDWORD *GetByteCode(asUINT *length = 0) = 0;
  870. // User data
  871. virtual void *SetUserData(void *userData) = 0;
  872. virtual void *GetUserData() const = 0;
  873. protected:
  874. virtual ~asIScriptFunction() {};
  875. };
  876. class asIBinaryStream
  877. {
  878. public:
  879. virtual void Read(void *ptr, asUINT size) = 0;
  880. virtual void Write(const void *ptr, asUINT size) = 0;
  881. public:
  882. virtual ~asIBinaryStream() {}
  883. };
  884. class asILockableSharedBool
  885. {
  886. public:
  887. // Memory management
  888. virtual int AddRef() const = 0;
  889. virtual int Release() const = 0;
  890. // Value
  891. virtual bool Get() const = 0;
  892. virtual void Set(bool val) = 0;
  893. // Thread management
  894. virtual void Lock() const = 0;
  895. virtual void Unlock() const = 0;
  896. protected:
  897. virtual ~asILockableSharedBool() {}
  898. };
  899. //-----------------------------------------------------------------
  900. // Function pointers
  901. // Template function to capture all global functions,
  902. // except the ones using the generic calling convention
  903. template <class T>
  904. inline asSFuncPtr asFunctionPtr(T func)
  905. {
  906. // Mark this as a global function
  907. asSFuncPtr p(2);
  908. #ifdef AS_64BIT_PTR
  909. // The size_t cast is to avoid a compiler warning with asFUNCTION(0)
  910. // on 64bit, as 0 is interpreted as a 32bit int value
  911. p.ptr.f.func = reinterpret_cast<asFUNCTION_t>(size_t(func));
  912. #else
  913. // MSVC6 doesn't like the size_t cast above so I
  914. // solved this with a separate code for 32bit.
  915. p.ptr.f.func = reinterpret_cast<asFUNCTION_t>(func);
  916. #endif
  917. return p;
  918. }
  919. // Specialization for functions using the generic calling convention
  920. template<>
  921. inline asSFuncPtr asFunctionPtr<asGENFUNC_t>(asGENFUNC_t func)
  922. {
  923. // Mark this as a generic function
  924. asSFuncPtr p(1);
  925. p.ptr.f.func = reinterpret_cast<asFUNCTION_t>(func);
  926. return p;
  927. }
  928. #ifndef AS_NO_CLASS_METHODS
  929. // Method pointers
  930. // Declare a dummy class so that we can determine the size of a simple method pointer
  931. class asCSimpleDummy {};
  932. typedef void (asCSimpleDummy::*asSIMPLEMETHOD_t)();
  933. const int SINGLE_PTR_SIZE = sizeof(asSIMPLEMETHOD_t);
  934. // Define template
  935. template <int N>
  936. struct asSMethodPtr
  937. {
  938. template<class M>
  939. static asSFuncPtr Convert(M Mthd)
  940. {
  941. // This version of the function should never be executed, nor compiled,
  942. // as it would mean that the size of the method pointer cannot be determined.
  943. int ERROR_UnsupportedMethodPtr[N-100];
  944. asSFuncPtr p(0);
  945. return p;
  946. }
  947. };
  948. // Template specialization
  949. template <>
  950. struct asSMethodPtr<SINGLE_PTR_SIZE>
  951. {
  952. template<class M>
  953. static asSFuncPtr Convert(M Mthd)
  954. {
  955. // Mark this as a class method
  956. asSFuncPtr p(3);
  957. p.CopyMethodPtr(&Mthd, SINGLE_PTR_SIZE);
  958. return p;
  959. }
  960. };
  961. #if defined(_MSC_VER) && !defined(__MWERKS__)
  962. // MSVC and Intel uses different sizes for different class method pointers
  963. template <>
  964. struct asSMethodPtr<SINGLE_PTR_SIZE+1*sizeof(int)>
  965. {
  966. template <class M>
  967. static asSFuncPtr Convert(M Mthd)
  968. {
  969. // Mark this as a class method
  970. asSFuncPtr p(3);
  971. p.CopyMethodPtr(&Mthd, SINGLE_PTR_SIZE+sizeof(int));
  972. return p;
  973. }
  974. };
  975. template <>
  976. struct asSMethodPtr<SINGLE_PTR_SIZE+2*sizeof(int)>
  977. {
  978. template <class M>
  979. static asSFuncPtr Convert(M Mthd)
  980. {
  981. // On 32bit platforms with is where a class with virtual inheritance falls.
  982. // On 64bit platforms we can also fall here if 8byte data alignments is used.
  983. // Mark this as a class method
  984. asSFuncPtr p(3);
  985. p.CopyMethodPtr(&Mthd, SINGLE_PTR_SIZE+2*sizeof(int));
  986. // Microsoft has a terrible optimization on class methods with virtual inheritance.
  987. // They are hardcoding an important offset, which is not coming in the method pointer.
  988. #if defined(_MSC_VER) && !defined(AS_64BIT_PTR)
  989. // Method pointers for virtual inheritance is not supported,
  990. // as it requires the location of the vbase table, which is
  991. // only available to the C++ compiler, but not in the method
  992. // pointer.
  993. // You can get around this by forward declaring the class and
  994. // storing the sizeof its method pointer in a constant. Example:
  995. // class ClassWithVirtualInheritance;
  996. // const int ClassWithVirtualInheritance_workaround = sizeof(void ClassWithVirtualInheritance::*());
  997. // This will force the compiler to use the unknown type
  998. // for the class, which falls under the next case
  999. // Copy the virtual table index to the 4th dword so that AngelScript
  1000. // can properly detect and deny the use of methods with virtual inheritance.
  1001. *(reinterpret_cast<asDWORD*>(&p)+3) = *(reinterpret_cast<asDWORD*>(&p)+2);
  1002. #endif
  1003. return p;
  1004. }
  1005. };
  1006. template <>
  1007. struct asSMethodPtr<SINGLE_PTR_SIZE+3*sizeof(int)>
  1008. {
  1009. template <class M>
  1010. static asSFuncPtr Convert(M Mthd)
  1011. {
  1012. // Mark this as a class method
  1013. asSFuncPtr p(3);
  1014. p.CopyMethodPtr(&Mthd, SINGLE_PTR_SIZE+3*sizeof(int));
  1015. return p;
  1016. }
  1017. };
  1018. template <>
  1019. struct asSMethodPtr<SINGLE_PTR_SIZE+4*sizeof(int)>
  1020. {
  1021. template <class M>
  1022. static asSFuncPtr Convert(M Mthd)
  1023. {
  1024. // On 64bit platforms with 8byte data alignment
  1025. // the unknown class method pointers will come here.
  1026. // Mark this as a class method
  1027. asSFuncPtr p(3);
  1028. p.CopyMethodPtr(&Mthd, SINGLE_PTR_SIZE+4*sizeof(int));
  1029. return p;
  1030. }
  1031. };
  1032. #endif
  1033. #endif // AS_NO_CLASS_METHODS
  1034. //----------------------------------------------------------------
  1035. // JIT compiler
  1036. struct asSVMRegisters
  1037. {
  1038. asDWORD *programPointer; // points to current bytecode instruction
  1039. asDWORD *stackFramePointer; // function stack frame
  1040. asDWORD *stackPointer; // top of stack (grows downward)
  1041. asQWORD valueRegister; // temp register for primitives
  1042. void *objectRegister; // temp register for objects and handles
  1043. asIObjectType *objectType; // type of object held in object register
  1044. bool doProcessSuspend; // whether or not the JIT should break out when it encounters a suspend instruction
  1045. asIScriptContext *ctx; // the active context
  1046. };
  1047. typedef void (*asJITFunction)(asSVMRegisters *registers, asPWORD jitArg);
  1048. class asIJITCompiler
  1049. {
  1050. public:
  1051. virtual int CompileFunction(asIScriptFunction *function, asJITFunction *output) = 0;
  1052. virtual void ReleaseJITFunction(asJITFunction func) = 0;
  1053. public:
  1054. virtual ~asIJITCompiler() {}
  1055. };
  1056. // Byte code instructions
  1057. enum asEBCInstr
  1058. {
  1059. asBC_PopPtr = 0,
  1060. asBC_PshGPtr = 1,
  1061. asBC_PshC4 = 2,
  1062. asBC_PshV4 = 3,
  1063. asBC_PSF = 4,
  1064. asBC_SwapPtr = 5,
  1065. asBC_NOT = 6,
  1066. asBC_PshG4 = 7,
  1067. asBC_LdGRdR4 = 8,
  1068. asBC_CALL = 9,
  1069. asBC_RET = 10,
  1070. asBC_JMP = 11,
  1071. asBC_JZ = 12,
  1072. asBC_JNZ = 13,
  1073. asBC_JS = 14,
  1074. asBC_JNS = 15,
  1075. asBC_JP = 16,
  1076. asBC_JNP = 17,
  1077. asBC_TZ = 18,
  1078. asBC_TNZ = 19,
  1079. asBC_TS = 20,
  1080. asBC_TNS = 21,
  1081. asBC_TP = 22,
  1082. asBC_TNP = 23,
  1083. asBC_NEGi = 24,
  1084. asBC_NEGf = 25,
  1085. asBC_NEGd = 26,
  1086. asBC_INCi16 = 27,
  1087. asBC_INCi8 = 28,
  1088. asBC_DECi16 = 29,
  1089. asBC_DECi8 = 30,
  1090. asBC_INCi = 31,
  1091. asBC_DECi = 32,
  1092. asBC_INCf = 33,
  1093. asBC_DECf = 34,
  1094. asBC_INCd = 35,
  1095. asBC_DECd = 36,
  1096. asBC_IncVi = 37,
  1097. asBC_DecVi = 38,
  1098. asBC_BNOT = 39,
  1099. asBC_BAND = 40,
  1100. asBC_BOR = 41,
  1101. asBC_BXOR = 42,
  1102. asBC_BSLL = 43,
  1103. asBC_BSRL = 44,
  1104. asBC_BSRA = 45,
  1105. asBC_COPY = 46,
  1106. asBC_PshC8 = 47,
  1107. asBC_PshVPtr = 48,
  1108. asBC_RDSPtr = 49,
  1109. asBC_CMPd = 50,
  1110. asBC_CMPu = 51,
  1111. asBC_CMPf = 52,
  1112. asBC_CMPi = 53,
  1113. asBC_CMPIi = 54,
  1114. asBC_CMPIf = 55,
  1115. asBC_CMPIu = 56,
  1116. asBC_JMPP = 57,
  1117. asBC_PopRPtr = 58,
  1118. asBC_PshRPtr = 59,
  1119. asBC_STR = 60,
  1120. asBC_CALLSYS = 61,
  1121. asBC_CALLBND = 62,
  1122. asBC_SUSPEND = 63,
  1123. asBC_ALLOC = 64,
  1124. asBC_FREE = 65,
  1125. asBC_LOADOBJ = 66,
  1126. asBC_STOREOBJ = 67,
  1127. asBC_GETOBJ = 68,
  1128. asBC_REFCPY = 69,
  1129. asBC_CHKREF = 70,
  1130. asBC_GETOBJREF = 71,
  1131. asBC_GETREF = 72,
  1132. asBC_PshNull = 73,
  1133. asBC_ClrVPtr = 74,
  1134. asBC_OBJTYPE = 75,
  1135. asBC_TYPEID = 76,
  1136. asBC_SetV4 = 77,
  1137. asBC_SetV8 = 78,
  1138. asBC_ADDSi = 79,
  1139. asBC_CpyVtoV4 = 80,
  1140. asBC_CpyVtoV8 = 81,
  1141. asBC_CpyVtoR4 = 82,
  1142. asBC_CpyVtoR8 = 83,
  1143. asBC_CpyVtoG4 = 84,
  1144. asBC_CpyRtoV4 = 85,
  1145. asBC_CpyRtoV8 = 86,
  1146. asBC_CpyGtoV4 = 87,
  1147. asBC_WRTV1 = 88,
  1148. asBC_WRTV2 = 89,
  1149. asBC_WRTV4 = 90,
  1150. asBC_WRTV8 = 91,
  1151. asBC_RDR1 = 92,
  1152. asBC_RDR2 = 93,
  1153. asBC_RDR4 = 94,
  1154. asBC_RDR8 = 95,
  1155. asBC_LDG = 96,
  1156. asBC_LDV = 97,
  1157. asBC_PGA = 98,
  1158. asBC_CmpPtr = 99,
  1159. asBC_VAR = 100,
  1160. asBC_iTOf = 101,
  1161. asBC_fTOi = 102,
  1162. asBC_uTOf = 103,
  1163. asBC_fTOu = 104,
  1164. asBC_sbTOi = 105,
  1165. asBC_swTOi = 106,
  1166. asBC_ubTOi = 107,
  1167. asBC_uwTOi = 108,
  1168. asBC_dTOi = 109,
  1169. asBC_dTOu = 110,
  1170. asBC_dTOf = 111,
  1171. asBC_iTOd = 112,
  1172. asBC_uTOd = 113,
  1173. asBC_fTOd = 114,
  1174. asBC_ADDi = 115,
  1175. asBC_SUBi = 116,
  1176. asBC_MULi = 117,
  1177. asBC_DIVi = 118,
  1178. asBC_MODi = 119,
  1179. asBC_ADDf = 120,
  1180. asBC_SUBf = 121,
  1181. asBC_MULf = 122,
  1182. asBC_DIVf = 123,
  1183. asBC_MODf = 124,
  1184. asBC_ADDd = 125,
  1185. asBC_SUBd = 126,
  1186. asBC_MULd = 127,
  1187. asBC_DIVd = 128,
  1188. asBC_MODd = 129,
  1189. asBC_ADDIi = 130,
  1190. asBC_SUBIi = 131,
  1191. asBC_MULIi = 132,
  1192. asBC_ADDIf = 133,
  1193. asBC_SUBIf = 134,
  1194. asBC_MULIf = 135,
  1195. asBC_SetG4 = 136,
  1196. asBC_ChkRefS = 137,
  1197. asBC_ChkNullV = 138,
  1198. asBC_CALLINTF = 139,
  1199. asBC_iTOb = 140,
  1200. asBC_iTOw = 141,
  1201. asBC_SetV1 = 142,
  1202. asBC_SetV2 = 143,
  1203. asBC_Cast = 144,
  1204. asBC_i64TOi = 145,
  1205. asBC_uTOi64 = 146,
  1206. asBC_iTOi64 = 147,
  1207. asBC_fTOi64 = 148,
  1208. asBC_dTOi64 = 149,
  1209. asBC_fTOu64 = 150,
  1210. asBC_dTOu64 = 151,
  1211. asBC_i64TOf = 152,
  1212. asBC_u64TOf = 153,
  1213. asBC_i64TOd = 154,
  1214. asBC_u64TOd = 155,
  1215. asBC_NEGi64 = 156,
  1216. asBC_INCi64 = 157,
  1217. asBC_DECi64 = 158,
  1218. asBC_BNOT64 = 159,
  1219. asBC_ADDi64 = 160,
  1220. asBC_SUBi64 = 161,
  1221. asBC_MULi64 = 162,
  1222. asBC_DIVi64 = 163,
  1223. asBC_MODi64 = 164,
  1224. asBC_BAND64 = 165,
  1225. asBC_BOR64 = 166,
  1226. asBC_BXOR64 = 167,
  1227. asBC_BSLL64 = 168,
  1228. asBC_BSRL64 = 169,
  1229. asBC_BSRA64 = 170,
  1230. asBC_CMPi64 = 171,
  1231. asBC_CMPu64 = 172,
  1232. asBC_ChkNullS = 173,
  1233. asBC_ClrHi = 174,
  1234. asBC_JitEntry = 175,
  1235. asBC_CallPtr = 176,
  1236. asBC_FuncPtr = 177,
  1237. asBC_LoadThisR = 178,
  1238. asBC_PshV8 = 179,
  1239. asBC_DIVu = 180,
  1240. asBC_MODu = 181,
  1241. asBC_DIVu64 = 182,
  1242. asBC_MODu64 = 183,
  1243. asBC_LoadRObjR = 184,
  1244. asBC_LoadVObjR = 185,
  1245. asBC_RefCpyV = 186,
  1246. asBC_JLowZ = 187,
  1247. asBC_JLowNZ = 188,
  1248. asBC_AllocMem = 189,
  1249. asBC_SetListSize = 190,
  1250. asBC_PshListElmnt = 191,
  1251. asBC_SetListType = 192,
  1252. asBC_MAXBYTECODE = 193,
  1253. // Temporary tokens. Can't be output to the final program
  1254. asBC_VarDecl = 251,
  1255. asBC_Block = 252,
  1256. asBC_ObjInfo = 253,
  1257. asBC_LINE = 254,
  1258. asBC_LABEL = 255
  1259. };
  1260. // Instruction types
  1261. enum asEBCType
  1262. {
  1263. asBCTYPE_INFO = 0,
  1264. asBCTYPE_NO_ARG = 1,
  1265. asBCTYPE_W_ARG = 2,
  1266. asBCTYPE_wW_ARG = 3,
  1267. asBCTYPE_DW_ARG = 4,
  1268. asBCTYPE_rW_DW_ARG = 5,
  1269. asBCTYPE_QW_ARG = 6,
  1270. asBCTYPE_DW_DW_ARG = 7,
  1271. asBCTYPE_wW_rW_rW_ARG = 8,
  1272. asBCTYPE_wW_QW_ARG = 9,
  1273. asBCTYPE_wW_rW_ARG = 10,
  1274. asBCTYPE_rW_ARG = 11,
  1275. asBCTYPE_wW_DW_ARG = 12,
  1276. asBCTYPE_wW_rW_DW_ARG = 13,
  1277. asBCTYPE_rW_rW_ARG = 14,
  1278. asBCTYPE_wW_W_ARG = 15,
  1279. asBCTYPE_QW_DW_ARG = 16,
  1280. asBCTYPE_rW_QW_ARG = 17,
  1281. asBCTYPE_W_DW_ARG = 18,
  1282. asBCTYPE_rW_W_DW_ARG = 19,
  1283. asBCTYPE_rW_DW_DW_ARG = 20
  1284. };
  1285. // Instruction type sizes
  1286. const int asBCTypeSize[21] =
  1287. {
  1288. 0, // asBCTYPE_INFO
  1289. 1, // asBCTYPE_NO_ARG
  1290. 1, // asBCTYPE_W_ARG
  1291. 1, // asBCTYPE_wW_ARG
  1292. 2, // asBCTYPE_DW_ARG
  1293. 2, // asBCTYPE_rW_DW_ARG
  1294. 3, // asBCTYPE_QW_ARG
  1295. 3, // asBCTYPE_DW_DW_ARG
  1296. 2, // asBCTYPE_wW_rW_rW_ARG
  1297. 3, // asBCTYPE_wW_QW_ARG
  1298. 2, // asBCTYPE_wW_rW_ARG
  1299. 1, // asBCTYPE_rW_ARG
  1300. 2, // asBCTYPE_wW_DW_ARG
  1301. 3, // asBCTYPE_wW_rW_DW_ARG
  1302. 2, // asBCTYPE_rW_rW_ARG
  1303. 2, // asBCTYPE_wW_W_ARG
  1304. 4, // asBCTYPE_QW_DW_ARG
  1305. 3, // asBCTYPE_rW_QW_ARG
  1306. 2, // asBCTYPE_W_DW_ARG
  1307. 3, // asBCTYPE_rW_W_DW_ARG
  1308. 3 // asBCTYPE_rW_DW_DW_ARG
  1309. };
  1310. // Instruction info
  1311. struct asSBCInfo
  1312. {
  1313. asEBCInstr bc;
  1314. asEBCType type;
  1315. int stackInc;
  1316. const char *name;
  1317. };
  1318. #ifndef AS_64BIT_PTR
  1319. #define asBCTYPE_PTR_ARG asBCTYPE_DW_ARG
  1320. #define asBCTYPE_PTR_DW_ARG asBCTYPE_DW_DW_ARG
  1321. #define asBCTYPE_wW_PTR_ARG asBCTYPE_wW_DW_ARG
  1322. #define asBCTYPE_rW_PTR_ARG asBCTYPE_rW_DW_ARG
  1323. #ifndef AS_PTR_SIZE
  1324. #define AS_PTR_SIZE 1
  1325. #endif
  1326. #else
  1327. #define asBCTYPE_PTR_ARG asBCTYPE_QW_ARG
  1328. #define asBCTYPE_PTR_DW_ARG asBCTYPE_QW_DW_ARG
  1329. #define asBCTYPE_wW_PTR_ARG asBCTYPE_wW_QW_ARG
  1330. #define asBCTYPE_rW_PTR_ARG asBCTYPE_rW_QW_ARG
  1331. #ifndef AS_PTR_SIZE
  1332. #define AS_PTR_SIZE 2
  1333. #endif
  1334. #endif
  1335. #define asBCINFO(b,t,s) {asBC_##b, asBCTYPE_##t, s, #b}
  1336. #define asBCINFO_DUMMY(b) {asBC_MAXBYTECODE, asBCTYPE_INFO, 0, "BC_" #b}
  1337. const asSBCInfo asBCInfo[256] =
  1338. {
  1339. asBCINFO(PopPtr, NO_ARG, -AS_PTR_SIZE),
  1340. asBCINFO(PshGPtr, PTR_ARG, AS_PTR_SIZE),
  1341. asBCINFO(PshC4, DW_ARG, 1),
  1342. asBCINFO(PshV4, rW_ARG, 1),
  1343. asBCINFO(PSF, rW_ARG, AS_PTR_SIZE),
  1344. asBCINFO(SwapPtr, NO_ARG, 0),
  1345. asBCINFO(NOT, rW_ARG, 0),
  1346. asBCINFO(PshG4, PTR_ARG, 1),
  1347. asBCINFO(LdGRdR4, wW_PTR_ARG, 0),
  1348. asBCINFO(CALL, DW_ARG, 0xFFFF),
  1349. asBCINFO(RET, W_ARG, 0xFFFF),
  1350. asBCINFO(JMP, DW_ARG, 0),
  1351. asBCINFO(JZ, DW_ARG, 0),
  1352. asBCINFO(JNZ, DW_ARG, 0),
  1353. asBCINFO(JS, DW_ARG, 0),
  1354. asBCINFO(JNS, DW_ARG, 0),
  1355. asBCINFO(JP, DW_ARG, 0),
  1356. asBCINFO(JNP, DW_ARG, 0),
  1357. asBCINFO(TZ, NO_ARG, 0),
  1358. asBCINFO(TNZ, NO_ARG, 0),
  1359. asBCINFO(TS, NO_ARG, 0),
  1360. asBCINFO(TNS, NO_ARG, 0),
  1361. asBCINFO(TP, NO_ARG, 0),
  1362. asBCINFO(TNP, NO_ARG, 0),
  1363. asBCINFO(NEGi, rW_ARG, 0),
  1364. asBCINFO(NEGf, rW_ARG, 0),
  1365. asBCINFO(NEGd, rW_ARG, 0),
  1366. asBCINFO(INCi16, NO_ARG, 0),
  1367. asBCINFO(INCi8, NO_ARG, 0),
  1368. asBCINFO(DECi16, NO_ARG, 0),
  1369. asBCINFO(DECi8, NO_ARG, 0),
  1370. asBCINFO(INCi, NO_ARG, 0),
  1371. asBCINFO(DECi, NO_ARG, 0),
  1372. asBCINFO(INCf, NO_ARG, 0),
  1373. asBCINFO(DECf, NO_ARG, 0),
  1374. asBCINFO(INCd, NO_ARG, 0),
  1375. asBCINFO(DECd, NO_ARG, 0),
  1376. asBCINFO(IncVi, rW_ARG, 0),
  1377. asBCINFO(DecVi, rW_ARG, 0),
  1378. asBCINFO(BNOT, rW_ARG, 0),
  1379. asBCINFO(BAND, wW_rW_rW_ARG, 0),
  1380. asBCINFO(BOR, wW_rW_rW_ARG, 0),
  1381. asBCINFO(BXOR, wW_rW_rW_ARG, 0),
  1382. asBCINFO(BSLL, wW_rW_rW_ARG, 0),
  1383. asBCINFO(BSRL, wW_rW_rW_ARG, 0),
  1384. asBCINFO(BSRA, wW_rW_rW_ARG, 0),
  1385. asBCINFO(COPY, W_DW_ARG, -AS_PTR_SIZE),
  1386. asBCINFO(PshC8, QW_ARG, 2),
  1387. asBCINFO(PshVPtr, rW_ARG, AS_PTR_SIZE),
  1388. asBCINFO(RDSPtr, NO_ARG, 0),
  1389. asBCINFO(CMPd, rW_rW_ARG, 0),
  1390. asBCINFO(CMPu, rW_rW_ARG, 0),
  1391. asBCINFO(CMPf, rW_rW_ARG, 0),
  1392. asBCINFO(CMPi, rW_rW_ARG, 0),
  1393. asBCINFO(CMPIi, rW_DW_ARG, 0),
  1394. asBCINFO(CMPIf, rW_DW_ARG, 0),
  1395. asBCINFO(CMPIu, rW_DW_ARG, 0),
  1396. asBCINFO(JMPP, rW_ARG, 0),
  1397. asBCINFO(PopRPtr, NO_ARG, -AS_PTR_SIZE),
  1398. asBCINFO(PshRPtr, NO_ARG, AS_PTR_SIZE),
  1399. asBCINFO(STR, W_ARG, 1+AS_PTR_SIZE),
  1400. asBCINFO(CALLSYS, DW_ARG, 0xFFFF),
  1401. asBCINFO(CALLBND, DW_ARG, 0xFFFF),
  1402. asBCINFO(SUSPEND, NO_ARG, 0),
  1403. asBCINFO(ALLOC, PTR_DW_ARG, 0xFFFF),
  1404. asBCINFO(FREE, wW_PTR_ARG, 0),
  1405. asBCINFO(LOADOBJ, rW_ARG, 0),
  1406. asBCINFO(STOREOBJ, wW_ARG, 0),
  1407. asBCINFO(GETOBJ, W_ARG, 0),
  1408. asBCINFO(REFCPY, PTR_ARG, -AS_PTR_SIZE),
  1409. asBCINFO(CHKREF, NO_ARG, 0),
  1410. asBCINFO(GETOBJREF, W_ARG, 0),
  1411. asBCINFO(GETREF, W_ARG, 0),
  1412. asBCINFO(PshNull, NO_ARG, AS_PTR_SIZE),
  1413. asBCINFO(ClrVPtr, wW_ARG, 0),
  1414. asBCINFO(OBJTYPE, PTR_ARG, AS_PTR_SIZE),
  1415. asBCINFO(TYPEID, DW_ARG, 1),
  1416. asBCINFO(SetV4, wW_DW_ARG, 0),
  1417. asBCINFO(SetV8, wW_QW_ARG, 0),
  1418. asBCINFO(ADDSi, W_DW_ARG, 0),
  1419. asBCINFO(CpyVtoV4, wW_rW_ARG, 0),
  1420. asBCINFO(CpyVtoV8, wW_rW_ARG, 0),
  1421. asBCINFO(CpyVtoR4, rW_ARG, 0),
  1422. asBCINFO(CpyVtoR8, rW_ARG, 0),
  1423. asBCINFO(CpyVtoG4, rW_PTR_ARG, 0),
  1424. asBCINFO(CpyRtoV4, wW_ARG, 0),
  1425. asBCINFO(CpyRtoV8, wW_ARG, 0),
  1426. asBCINFO(CpyGtoV4, wW_PTR_ARG, 0),
  1427. asBCINFO(WRTV1, rW_ARG, 0),
  1428. asBCINFO(WRTV2, rW_ARG, 0),
  1429. asBCINFO(WRTV4, rW_ARG, 0),
  1430. asBCINFO(WRTV8, rW_ARG, 0),
  1431. asBCINFO(RDR1, wW_ARG, 0),
  1432. asBCINFO(RDR2, wW_ARG, 0),
  1433. asBCINFO(RDR4, wW_ARG, 0),
  1434. asBCINFO(RDR8, wW_ARG, 0),
  1435. asBCINFO(LDG, PTR_ARG, 0),
  1436. asBCINFO(LDV, rW_ARG, 0),
  1437. asBCINFO(PGA, PTR_ARG, AS_PTR_SIZE),
  1438. asBCINFO(CmpPtr, rW_rW_ARG, 0),
  1439. asBCINFO(VAR, rW_ARG, AS_PTR_SIZE),
  1440. asBCINFO(iTOf, rW_ARG, 0),
  1441. asBCINFO(fTOi, rW_ARG, 0),
  1442. asBCINFO(uTOf, rW_ARG, 0),
  1443. asBCINFO(fTOu, rW_ARG, 0),
  1444. asBCINFO(sbTOi, rW_ARG, 0),
  1445. asBCINFO(swTOi, rW_ARG, 0),
  1446. asBCINFO(ubTOi, rW_ARG, 0),
  1447. asBCINFO(uwTOi, rW_ARG, 0),
  1448. asBCINFO(dTOi, wW_rW_ARG, 0),
  1449. asBCINFO(dTOu, wW_rW_ARG, 0),
  1450. asBCINFO(dTOf, wW_rW_ARG, 0),
  1451. asBCINFO(iTOd, wW_rW_ARG, 0),
  1452. asBCINFO(uTOd, wW_rW_ARG, 0),
  1453. asBCINFO(fTOd, wW_rW_ARG, 0),
  1454. asBCINFO(ADDi, wW_rW_rW_ARG, 0),
  1455. asBCINFO(SUBi, wW_rW_rW_ARG, 0),
  1456. asBCINFO(MULi, wW_rW_rW_ARG, 0),
  1457. asBCINFO(DIVi, wW_rW_rW_ARG, 0),
  1458. asBCINFO(MODi, wW_rW_rW_ARG, 0),
  1459. asBCINFO(ADDf, wW_rW_rW_ARG, 0),
  1460. asBCINFO(SUBf, wW_rW_rW_ARG, 0),
  1461. asBCINFO(MULf, wW_rW_rW_ARG, 0),
  1462. asBCINFO(DIVf, wW_rW_rW_ARG, 0),
  1463. asBCINFO(MODf, wW_rW_rW_ARG, 0),
  1464. asBCINFO(ADDd, wW_rW_rW_ARG, 0),
  1465. asBCINFO(SUBd, wW_rW_rW_ARG, 0),
  1466. asBCINFO(MULd, wW_rW_rW_ARG, 0),
  1467. asBCINFO(DIVd, wW_rW_rW_ARG, 0),
  1468. asBCINFO(MODd, wW_rW_rW_ARG, 0),
  1469. asBCINFO(ADDIi, wW_rW_DW_ARG, 0),
  1470. asBCINFO(SUBIi, wW_rW_DW_ARG, 0),
  1471. asBCINFO(MULIi, wW_rW_DW_ARG, 0),
  1472. asBCINFO(ADDIf, wW_rW_DW_ARG, 0),
  1473. asBCINFO(SUBIf, wW_rW_DW_ARG, 0),
  1474. asBCINFO(MULIf, wW_rW_DW_ARG, 0),
  1475. asBCINFO(SetG4, PTR_DW_ARG, 0),
  1476. asBCINFO(ChkRefS, NO_ARG, 0),
  1477. asBCINFO(ChkNullV, rW_ARG, 0),
  1478. asBCINFO(CALLINTF, DW_ARG, 0xFFFF),
  1479. asBCINFO(iTOb, rW_ARG, 0),
  1480. asBCINFO(iTOw, rW_ARG, 0),
  1481. asBCINFO(SetV1, wW_DW_ARG, 0),
  1482. asBCINFO(SetV2, wW_DW_ARG, 0),
  1483. asBCINFO(Cast, DW_ARG, -AS_PTR_SIZE),
  1484. asBCINFO(i64TOi, wW_rW_ARG, 0),
  1485. asBCINFO(uTOi64, wW_rW_ARG, 0),
  1486. asBCINFO(iTOi64, wW_rW_ARG, 0),
  1487. asBCINFO(fTOi64, wW_rW_ARG, 0),
  1488. asBCINFO(dTOi64, rW_ARG, 0),
  1489. asBCINFO(fTOu64, wW_rW_ARG, 0),
  1490. asBCINFO(dTOu64, rW_ARG, 0),
  1491. asBCINFO(i64TOf, wW_rW_ARG, 0),
  1492. asBCINFO(u64TOf, wW_rW_ARG, 0),
  1493. asBCINFO(i64TOd, rW_ARG, 0),
  1494. asBCINFO(u64TOd, rW_ARG, 0),
  1495. asBCINFO(NEGi64, rW_ARG, 0),
  1496. asBCINFO(INCi64, NO_ARG, 0),
  1497. asBCINFO(DECi64, NO_ARG, 0),
  1498. asBCINFO(BNOT64, rW_ARG, 0),
  1499. asBCINFO(ADDi64, wW_rW_rW_ARG, 0),
  1500. asBCINFO(SUBi64, wW_rW_rW_ARG, 0),
  1501. asBCINFO(MULi64, wW_rW_rW_ARG, 0),
  1502. asBCINFO(DIVi64, wW_rW_rW_ARG, 0),
  1503. asBCINFO(MODi64, wW_rW_rW_ARG, 0),
  1504. asBCINFO(BAND64, wW_rW_rW_ARG, 0),
  1505. asBCINFO(BOR64, wW_rW_rW_ARG, 0),
  1506. asBCINFO(BXOR64, wW_rW_rW_ARG, 0),
  1507. asBCINFO(BSLL64, wW_rW_rW_ARG, 0),
  1508. asBCINFO(BSRL64, wW_rW_rW_ARG, 0),
  1509. asBCINFO(BSRA64, wW_rW_rW_ARG, 0),
  1510. asBCINFO(CMPi64, rW_rW_ARG, 0),
  1511. asBCINFO(CMPu64, rW_rW_ARG, 0),
  1512. asBCINFO(ChkNullS, W_ARG, 0),
  1513. asBCINFO(ClrHi, NO_ARG, 0),
  1514. asBCINFO(JitEntry, PTR_ARG, 0),
  1515. asBCINFO(CallPtr, rW_ARG, 0xFFFF),
  1516. asBCINFO(FuncPtr, PTR_ARG, AS_PTR_SIZE),
  1517. asBCINFO(LoadThisR, W_DW_ARG, 0),
  1518. asBCINFO(PshV8, rW_ARG, 2),
  1519. asBCINFO(DIVu, wW_rW_rW_ARG, 0),
  1520. asBCINFO(MODu, wW_rW_rW_ARG, 0),
  1521. asBCINFO(DIVu64, wW_rW_rW_ARG, 0),
  1522. asBCINFO(MODu64, wW_rW_rW_ARG, 0),
  1523. asBCINFO(LoadRObjR, rW_W_DW_ARG, 0),
  1524. asBCINFO(LoadVObjR, rW_W_DW_ARG, 0),
  1525. asBCINFO(RefCpyV, wW_PTR_ARG, 0),
  1526. asBCINFO(JLowZ, DW_ARG, 0),
  1527. asBCINFO(JLowNZ, DW_ARG, 0),
  1528. asBCINFO(AllocMem, wW_DW_ARG, 0),
  1529. asBCINFO(SetListSize, rW_DW_DW_ARG, 0),
  1530. asBCINFO(PshListElmnt, rW_DW_ARG, AS_PTR_SIZE),
  1531. asBCINFO(SetListType, rW_DW_DW_ARG, 0),
  1532. asBCINFO_DUMMY(193),
  1533. asBCINFO_DUMMY(194),
  1534. asBCINFO_DUMMY(195),
  1535. asBCINFO_DUMMY(196),
  1536. asBCINFO_DUMMY(197),
  1537. asBCINFO_DUMMY(198),
  1538. asBCINFO_DUMMY(199),
  1539. asBCINFO_DUMMY(200),
  1540. asBCINFO_DUMMY(201),
  1541. asBCINFO_DUMMY(202),
  1542. asBCINFO_DUMMY(203),
  1543. asBCINFO_DUMMY(204),
  1544. asBCINFO_DUMMY(205),
  1545. asBCINFO_DUMMY(206),
  1546. asBCINFO_DUMMY(207),
  1547. asBCINFO_DUMMY(208),
  1548. asBCINFO_DUMMY(209),
  1549. asBCINFO_DUMMY(210),
  1550. asBCINFO_DUMMY(211),
  1551. asBCINFO_DUMMY(212),
  1552. asBCINFO_DUMMY(213),
  1553. asBCINFO_DUMMY(214),
  1554. asBCINFO_DUMMY(215),
  1555. asBCINFO_DUMMY(216),
  1556. asBCINFO_DUMMY(217),
  1557. asBCINFO_DUMMY(218),
  1558. asBCINFO_DUMMY(219),
  1559. asBCINFO_DUMMY(220),
  1560. asBCINFO_DUMMY(221),
  1561. asBCINFO_DUMMY(222),
  1562. asBCINFO_DUMMY(223),
  1563. asBCINFO_DUMMY(224),
  1564. asBCINFO_DUMMY(225),
  1565. asBCINFO_DUMMY(226),
  1566. asBCINFO_DUMMY(227),
  1567. asBCINFO_DUMMY(228),
  1568. asBCINFO_DUMMY(229),
  1569. asBCINFO_DUMMY(230),
  1570. asBCINFO_DUMMY(231),
  1571. asBCINFO_DUMMY(232),
  1572. asBCINFO_DUMMY(233),
  1573. asBCINFO_DUMMY(234),
  1574. asBCINFO_DUMMY(235),
  1575. asBCINFO_DUMMY(236),
  1576. asBCINFO_DUMMY(237),
  1577. asBCINFO_DUMMY(238),
  1578. asBCINFO_DUMMY(239),
  1579. asBCINFO_DUMMY(240),
  1580. asBCINFO_DUMMY(241),
  1581. asBCINFO_DUMMY(242),
  1582. asBCINFO_DUMMY(243),
  1583. asBCINFO_DUMMY(244),
  1584. asBCINFO_DUMMY(245),
  1585. asBCINFO_DUMMY(246),
  1586. asBCINFO_DUMMY(247),
  1587. asBCINFO_DUMMY(248),
  1588. asBCINFO_DUMMY(249),
  1589. asBCINFO_DUMMY(250),
  1590. asBCINFO(VarDecl, W_ARG, 0),
  1591. asBCINFO(Block, INFO, 0),
  1592. asBCINFO(ObjInfo, rW_DW_ARG, 0),
  1593. asBCINFO(LINE, INFO, 0),
  1594. asBCINFO(LABEL, INFO, 0)
  1595. };
  1596. // Macros to access bytecode instruction arguments
  1597. #define asBC_DWORDARG(x) (*(((asDWORD*)x)+1))
  1598. #define asBC_INTARG(x) (*(int*)(((asDWORD*)x)+1))
  1599. #define asBC_QWORDARG(x) (*(asQWORD*)(((asDWORD*)x)+1))
  1600. #define asBC_FLOATARG(x) (*(float*)(((asDWORD*)x)+1))
  1601. #define asBC_PTRARG(x) (*(asPWORD*)(((asDWORD*)x)+1))
  1602. #define asBC_WORDARG0(x) (*(((asWORD*)x)+1))
  1603. #define asBC_WORDARG1(x) (*(((asWORD*)x)+2))
  1604. #define asBC_SWORDARG0(x) (*(((short*)x)+1))
  1605. #define asBC_SWORDARG1(x) (*(((short*)x)+2))
  1606. #define asBC_SWORDARG2(x) (*(((short*)x)+3))
  1607. END_AS_NAMESPACE
  1608. #endif