PageRenderTime 47ms CodeModel.GetById 17ms RepoModel.GetById 1ms app.codeStats 0ms

/tags/rel-1-3-15/SWIG/Source/Swig/swig.h

#
C++ Header | 478 lines | 363 code | 73 blank | 42 comment | 0 complexity | 1991d6dea45a54c72a9dbe0a3c6f7083 MD5 | raw file
Possible License(s): LGPL-2.1, Cube, GPL-3.0, 0BSD, GPL-2.0
  1. /* -----------------------------------------------------------------------------
  2. * swig.h
  3. *
  4. * Header file for the SWIG core.
  5. *
  6. * Author(s) : David Beazley (beazley@cs.uchicago.edu)
  7. * Dustin Mitchell (djmitche@cs.uchicago.edu)
  8. *
  9. * Copyright (C) 1999-2000. The University of Chicago
  10. * See the file LICENSE for information on usage and redistribution.
  11. *
  12. * $Header$
  13. * ----------------------------------------------------------------------------- */
  14. #ifndef _SWIGCORE_H
  15. #define _SWIGCORE_H
  16. #include <stdio.h>
  17. #include <string.h>
  18. #include <stdlib.h>
  19. #include <assert.h>
  20. #include "doh.h"
  21. /* Status codes */
  22. #define SWIG_OK 1
  23. #define SWIG_ERROR 0
  24. #define SWIG_NOWRAP 0
  25. /* Short names for common data types */
  26. typedef DOH String;
  27. typedef DOH Hash;
  28. typedef DOH List;
  29. typedef DOH String_or_char;
  30. typedef DOH File;
  31. typedef DOH Parm;
  32. typedef DOH ParmList;
  33. typedef DOH Node;
  34. typedef DOH Symtab;
  35. typedef DOH Typetab;
  36. typedef DOH SwigType;
  37. /* --- Legacy DataType interface. These type codes are provided solely
  38. for backwards compatibility with older modules --- */
  39. /* --- The ordering of type values is used to determine type-promotion
  40. in the parser. Do not change */
  41. /* Numeric types */
  42. #define T_BOOL 1
  43. #define T_SCHAR 2
  44. #define T_UCHAR 3
  45. #define T_SHORT 4
  46. #define T_USHORT 5
  47. #define T_ENUM 6
  48. #define T_INT 7
  49. #define T_UINT 8
  50. #define T_LONG 9
  51. #define T_ULONG 10
  52. #define T_LONGLONG 11
  53. #define T_ULONGLONG 12
  54. #define T_FLOAT 20
  55. #define T_DOUBLE 21
  56. #define T_NUMERIC 22
  57. /* non-numeric */
  58. #define T_CHAR 30
  59. #define T_USER 31
  60. #define T_VOID 32
  61. #define T_STRING 33
  62. #define T_POINTER 34
  63. #define T_REFERENCE 35
  64. #define T_ARRAY 36
  65. #define T_FUNCTION 37
  66. #define T_MPOINTER 38
  67. #define T_VARARGS 39
  68. #define T_SYMBOL 98
  69. #define T_ERROR 99
  70. /* --- File interface --- */
  71. extern void Swig_add_directory(const String_or_char *dirname);
  72. extern String *Swig_last_file();
  73. extern List *Swig_search_path();
  74. extern FILE *Swig_open(const String_or_char *name);
  75. extern String *Swig_read_file(FILE *f);
  76. extern String *Swig_include(const String_or_char *name);
  77. extern int Swig_insert_file(const String_or_char *name, File *outfile);
  78. extern void Swig_set_config_file(const String_or_char *filename);
  79. extern String *Swig_get_config_file(void);
  80. extern void Swig_swiglib_set(const String_or_char *);
  81. extern String *Swig_swiglib_get();
  82. extern void Swig_register_filebyname(const String_or_char *filename, File *outfile);
  83. extern File *Swig_filebyname(const String_or_char *filename);
  84. extern char *Swig_file_suffix(const String_or_char *filename);
  85. extern char *Swig_file_basename(const String_or_char *filename);
  86. extern char *Swig_file_filename(const String_or_char *filename);
  87. extern char *Swig_file_dirname(const String_or_char *filename);
  88. #ifdef MACSWIG
  89. # define SWIG_FILE_DELIMETER ":"
  90. #else
  91. # define SWIG_FILE_DELIMETER "/"
  92. #endif
  93. /* --- Command line parsing --- */
  94. extern void Swig_init_args(int argc, char **argv);
  95. extern void Swig_mark_arg(int n);
  96. extern int Swig_check_marked(int n);
  97. extern void Swig_check_options();
  98. extern void Swig_arg_error();
  99. /* --- Scanner Interface --- */
  100. typedef struct SwigScanner SwigScanner;
  101. extern SwigScanner *NewSwigScanner();
  102. extern void DelSwigScanner(SwigScanner *);
  103. extern void SwigScanner_clear(SwigScanner *);
  104. extern void SwigScanner_push(SwigScanner *, String *);
  105. extern void SwigScanner_pushtoken(SwigScanner *, int);
  106. extern int SwigScanner_token(SwigScanner *);
  107. extern String *SwigScanner_text(SwigScanner *);
  108. extern void SwigScanner_skip_line(SwigScanner *);
  109. extern int SwigScanner_skip_balanced(SwigScanner *, int startchar, int endchar);
  110. extern void SwigScanner_set_location(SwigScanner *, String *file, int line);
  111. extern String *SwigScanner_get_file(SwigScanner *);
  112. extern int SwigScanner_get_line(SwigScanner *);
  113. extern void SwigScanner_idstart(SwigScanner *, char *idchar);
  114. #define SWIG_MAXTOKENS 512
  115. #define SWIG_TOKEN_LPAREN 1
  116. #define SWIG_TOKEN_RPAREN 2
  117. #define SWIG_TOKEN_SEMI 3
  118. #define SWIG_TOKEN_COMMA 4
  119. #define SWIG_TOKEN_STAR 5
  120. #define SWIG_TOKEN_LBRACE 6
  121. #define SWIG_TOKEN_RBRACE 7
  122. #define SWIG_TOKEN_EQUAL 8
  123. #define SWIG_TOKEN_EQUALTO 9
  124. #define SWIG_TOKEN_NOTEQUAL 10
  125. #define SWIG_TOKEN_PLUS 11
  126. #define SWIG_TOKEN_MINUS 12
  127. #define SWIG_TOKEN_AND 13
  128. #define SWIG_TOKEN_LAND 14
  129. #define SWIG_TOKEN_OR 15
  130. #define SWIG_TOKEN_LOR 16
  131. #define SWIG_TOKEN_XOR 17
  132. #define SWIG_TOKEN_LESSTHAN 18
  133. #define SWIG_TOKEN_GREATERTHAN 19
  134. #define SWIG_TOKEN_LTEQUAL 20
  135. #define SWIG_TOKEN_GTEQUAL 21
  136. #define SWIG_TOKEN_NOT 22
  137. #define SWIG_TOKEN_LNOT 23
  138. #define SWIG_TOKEN_LBRACKET 24
  139. #define SWIG_TOKEN_RBRACKET 25
  140. #define SWIG_TOKEN_SLASH 26
  141. #define SWIG_TOKEN_BACKSLASH 27
  142. #define SWIG_TOKEN_ENDLINE 28
  143. #define SWIG_TOKEN_STRING 29
  144. #define SWIG_TOKEN_POUND 30
  145. #define SWIG_TOKEN_PERCENT 31
  146. #define SWIG_TOKEN_COLON 32
  147. #define SWIG_TOKEN_DCOLON 33
  148. #define SWIG_TOKEN_LSHIFT 34
  149. #define SWIG_TOKEN_RSHIFT 35
  150. #define SWIG_TOKEN_ID 36
  151. #define SWIG_TOKEN_FLOAT 37
  152. #define SWIG_TOKEN_DOUBLE 38
  153. #define SWIG_TOKEN_INT 39
  154. #define SWIG_TOKEN_UINT 40
  155. #define SWIG_TOKEN_LONG 41
  156. #define SWIG_TOKEN_ULONG 42
  157. #define SWIG_TOKEN_CHAR 43
  158. #define SWIG_TOKEN_PERIOD 44
  159. #define SWIG_TOKEN_AT 45
  160. #define SWIG_TOKEN_DOLLAR 46
  161. #define SWIG_TOKEN_CODEBLOCK 47
  162. #define SWIG_TOKEN_RSTRING 48
  163. #define SWIG_TOKEN_LONGLONG 49
  164. #define SWIG_TOKEN_ULONGLONG 50
  165. #define SWIG_TOKEN_ILLEGAL 98
  166. #define SWIG_TOKEN_LAST 99
  167. /* --- Functions for manipulating the string-based type encoding --- */
  168. extern SwigType *NewSwigType(int typecode);
  169. extern void SwigType_add_pointer(SwigType *t);
  170. extern void SwigType_add_memberpointer(SwigType *t, String_or_char *qual);
  171. extern void SwigType_del_pointer(SwigType *t);
  172. extern void SwigType_add_array(SwigType *t, String_or_char *size);
  173. extern SwigType *SwigType_pop_arrays(SwigType *t);
  174. extern void SwigType_add_reference(SwigType *t);
  175. extern void SwigType_add_qualifier(SwigType *t, String_or_char *qual);
  176. extern void SwigType_add_function(SwigType *t, ParmList *parms);
  177. extern void SwigType_add_template(SwigType *t, ParmList *parms);
  178. extern SwigType *SwigType_pop_function(SwigType *t);
  179. extern ParmList *SwigType_function_parms(SwigType *t);
  180. extern List *SwigType_split(SwigType *t);
  181. extern String *SwigType_pop(SwigType *t);
  182. extern void SwigType_push(SwigType *t, SwigType *s);
  183. extern List *SwigType_parmlist(const SwigType *p);
  184. extern String *SwigType_parm(String *p);
  185. extern String *SwigType_str(SwigType *s, const String_or_char *id);
  186. extern String *SwigType_lstr(SwigType *s, const String_or_char *id);
  187. extern String *SwigType_rcaststr(SwigType *s, const String_or_char *id);
  188. extern String *SwigType_lcaststr(SwigType *s, const String_or_char *id);
  189. extern String *SwigType_manglestr(SwigType *t);
  190. extern SwigType *SwigType_ltype(SwigType *t);
  191. extern int SwigType_ispointer(SwigType *t);
  192. extern int SwigType_ismemberpointer(SwigType *t);
  193. extern int SwigType_isreference(SwigType *t);
  194. extern int SwigType_isarray(SwigType *t);
  195. extern int SwigType_isfunction(SwigType *t);
  196. extern int SwigType_isqualifier(SwigType *t);
  197. extern int SwigType_isconst(SwigType *t);
  198. extern int SwigType_issimple(SwigType *t);
  199. extern int SwigType_ismutable(SwigType *t);
  200. extern int SwigType_isvarargs(const SwigType *t);
  201. extern int SwigType_istemplate(const SwigType *t);
  202. extern int SwigType_isenum(SwigType *t);
  203. extern int SwigType_check_decl(SwigType *t, const String_or_char *decl);
  204. extern SwigType *SwigType_strip_qualifiers(SwigType *t);
  205. extern String *SwigType_base(SwigType *t);
  206. extern String *SwigType_namestr(const SwigType *t);
  207. extern String *SwigType_templateprefix(SwigType *t);
  208. extern String *SwigType_templatesuffix(const SwigType *t);
  209. extern String *SwigType_templateargs(SwigType *t);
  210. extern String *SwigType_prefix(SwigType *t);
  211. extern int SwigType_array_ndim(SwigType *t);
  212. extern String *SwigType_array_getdim(SwigType *t, int n);
  213. extern void SwigType_array_setdim(SwigType *t, int n, String_or_char *rep);
  214. extern SwigType *SwigType_array_type(SwigType *t);
  215. extern String *SwigType_default(SwigType *t);
  216. extern void SwigType_typename_replace(SwigType *t, String *pat, String *rep);
  217. /* --- Type-system managment --- */
  218. extern void SwigType_typesystem_init();
  219. extern int SwigType_typedef(SwigType *type, String_or_char *name);
  220. extern int SwigType_typedef_class(String_or_char *name);
  221. extern int SwigType_typedef_using(String_or_char *qname);
  222. extern void SwigType_inherit(String *subclass, String *baseclass, String *cast);
  223. extern int SwigType_issubtype(SwigType *subtype, SwigType *basetype);
  224. extern void SwigType_scope_alias(String *aliasname, Typetab *t);
  225. extern void SwigType_using_scope(Typetab *t);
  226. extern void SwigType_new_scope(String_or_char *name);
  227. extern void SwigType_reset_scopes();
  228. extern void SwigType_set_scope_name(String_or_char *name);
  229. extern void SwigType_inherit_scope(Typetab *scope);
  230. extern Typetab *SwigType_pop_scope();
  231. extern Typetab *SwigType_set_scope(Typetab *h);
  232. extern void SwigType_print_scope(Typetab *t);
  233. extern SwigType *SwigType_typedef_resolve(SwigType *t);
  234. extern SwigType *SwigType_typedef_resolve_all(SwigType *t);
  235. extern SwigType *SwigType_typedef_qualified(SwigType *t);
  236. extern int SwigType_istypedef(SwigType *t);
  237. extern int SwigType_isclass(SwigType *t);
  238. extern void SwigType_attach_symtab(Symtab *syms);
  239. extern void SwigType_remember(SwigType *t);
  240. extern void SwigType_remember_clientdata(SwigType *t, const String_or_char *clientdata);
  241. extern void (*SwigType_remember_trace(void (*tf)(SwigType *, String *, String *)))(SwigType *, String *, String *);
  242. extern void SwigType_emit_type_table(File *f_headers, File *f_table);
  243. extern int SwigType_type(SwigType *t);
  244. /* --- Symbol table module --- */
  245. extern void Swig_symbol_init();
  246. extern void Swig_symbol_setscopename(const String_or_char *name);
  247. extern String *Swig_symbol_getscopename();
  248. extern String *Swig_symbol_qualifiedscopename(Symtab *symtab);
  249. extern Symtab *Swig_symbol_newscope();
  250. extern Symtab *Swig_symbol_setscope(Symtab *);
  251. extern Symtab *Swig_symbol_getscope(const String_or_char *symname);
  252. extern Symtab *Swig_symbol_current();
  253. extern Symtab *Swig_symbol_popscope();
  254. extern Node *Swig_symbol_add(String_or_char *symname, Node *node);
  255. extern void Swig_symbol_cadd(String_or_char *symname, Node *node);
  256. extern Node *Swig_symbol_clookup(String_or_char *symname, Symtab *tab);
  257. extern Symtab *Swig_symbol_cscope(String_or_char *symname, Symtab *tab);
  258. extern Node *Swig_symbol_clookup_local(String_or_char *symname, Symtab *tab);
  259. extern String *Swig_symbol_qualified(Node *node);
  260. extern Node *Swig_symbol_isoverloaded(Node *node);
  261. extern void Swig_symbol_remove(Node *node);
  262. extern void Swig_symbol_alias(String_or_char *aliasname, Symtab *tab);
  263. extern void Swig_symbol_inherit(Symtab *tab);
  264. extern SwigType *Swig_symbol_type_qualify(SwigType *ty, Symtab *tab);
  265. extern String *Swig_symbol_string_qualify(String *s, Symtab *tab);
  266. extern SwigType *Swig_symbol_typedef_reduce(SwigType *ty, Symtab *tab);
  267. /* --- Parameters and Parameter Lists --- */
  268. /* Parameters are really just hidden behind a DOH object. The following
  269. interface will probably be simplified even further. */
  270. extern Parm *NewParm(SwigType *type, String_or_char *n);
  271. extern Parm *CopyParm(Parm *p);
  272. extern ParmList *CopyParmList(ParmList *);
  273. extern int ParmList_len(ParmList *);
  274. extern int ParmList_numarg(ParmList *);
  275. extern int ParmList_numrequired(ParmList *);
  276. extern String *ParmList_str(ParmList *);
  277. extern String *ParmList_protostr(ParmList *);
  278. /* --- Parse tree support --- */
  279. /* DOM-like node access */
  280. #define nodeType(x) Getattr(x,"nodeType")
  281. #define parentNode(x) Getattr(x,"parentNode")
  282. #define previousSibling(x) Getattr(x,"previousSibling")
  283. #define nextSibling(x) Getattr(x,"nextSibling")
  284. #define firstChild(x) Getattr(x,"firstChild")
  285. #define lastChild(x) Getattr(x,"lastChild")
  286. extern int checkAttribute(Node *obj, const String_or_char *name, const String_or_char *value);
  287. /* Macros to set up the DOM tree (mostly used by the parser) */
  288. #define set_nodeType(x,v) Setattr(x,"nodeType",v)
  289. #define set_parentNode(x,v) Setattr(x,"parentNode",v)
  290. #define set_previousSibling(x,v) Setattr(x,"previousSibling",v)
  291. #define set_nextSibling(x,v) Setattr(x,"nextSibling",v)
  292. #define set_firstChild(x,v) Setattr(x,"firstChild",v)
  293. #define set_lastChild(x,v) Setattr(x,"lastChild",v)
  294. extern void appendChild(Node *node, Node *child);
  295. extern void deleteNode(Node *node);
  296. extern Node *copyNode(Node *node);
  297. extern void Swig_tag_nodes(Node *node, const String_or_char *attrname, DOH *value);
  298. extern int Swig_require(Node **node, ...);
  299. extern int Swig_save(Node **node,...);
  300. extern void Swig_restore(Node **node);
  301. /* Debugging of parse trees */
  302. extern void Swig_debug_emit(int);
  303. extern void Swig_print_tags(File *obj, Node *root);
  304. extern void Swig_print_tree(Node *obj);
  305. extern void Swig_print_node(Node *obj);
  306. /* -- Wrapper function Object */
  307. typedef struct {
  308. Hash *localh;
  309. String *def;
  310. String *locals;
  311. String *code;
  312. } Wrapper;
  313. extern Wrapper *NewWrapper();
  314. extern void DelWrapper(Wrapper *w);
  315. extern void Wrapper_pretty_print(String *str, File *f);
  316. extern void Wrapper_print(Wrapper *w, File *f);
  317. extern int Wrapper_add_local(Wrapper *w, const String_or_char *name, const String_or_char *decl);
  318. extern int Wrapper_add_localv(Wrapper *w, const String_or_char *name, ...);
  319. extern int Wrapper_check_local(Wrapper *w, const String_or_char *name);
  320. extern char *Wrapper_new_local(Wrapper *w, const String_or_char *name, const String_or_char *decl);
  321. extern char *Wrapper_new_localv(Wrapper *w, const String_or_char *name, ...);
  322. /* --- Naming functions --- */
  323. extern void Swig_name_register(const String_or_char *method, const String_or_char *format);
  324. extern void Swig_name_unregister(const String_or_char *method);
  325. extern String *Swig_name_mangle(const String_or_char *s);
  326. extern String *Swig_name_wrapper(const String_or_char *fname);
  327. extern String *Swig_name_member(const String_or_char *classname, const String_or_char *mname);
  328. extern String *Swig_name_get(const String_or_char *vname);
  329. extern String *Swig_name_set(const String_or_char *vname);
  330. extern String *Swig_name_construct(const String_or_char *classname);
  331. extern String *Swig_name_copyconstructor(const String_or_char *classname);
  332. extern String *Swig_name_destroy(const String_or_char *classname);
  333. /* --- parameterized rename functions --- */
  334. extern void Swig_name_object_set(Hash *namehash, String_or_char *name, SwigType *decl, DOH *object);
  335. extern DOH *Swig_name_object_get(Hash *namehash, String_or_char *prefix, String_or_char *name, SwigType *decl);
  336. extern void Swig_name_object_inherit(Hash *namehash, String *base, String *derived);
  337. extern void Swig_features_get(Hash *features, String_or_char *prefix, String_or_char *name, SwigType *decl, Node *n);
  338. extern void Swig_feature_set(Hash *features, String_or_char *name, SwigType *decl, String_or_char *fname, String *value);
  339. /* --- Misc --- */
  340. extern char *Swig_copy_string(const char *c);
  341. extern void Swig_banner(File *f);
  342. extern String *Swig_string_escape(String *s);
  343. extern String *Swig_string_mangle(String *s);
  344. extern String *Swig_scopename_prefix(String *s);
  345. extern String *Swig_scopename_last(String *s);
  346. extern String *Swig_scopename_first(String *s);
  347. extern String *Swig_scopename_suffix(String *s);
  348. extern int Swig_scopename_check(String *s);
  349. extern void Swig_init();
  350. extern void Swig_warn(const char *filename, int line, const char *msg);
  351. #define WARNING(msg) Swig_warn(__FILE__,__LINE__,msg)
  352. extern void Swig_warning(int num, const String_or_char *filename, int line, const char *fmt, ...);
  353. extern void Swig_error(const String_or_char *filename, int line, const char *fmt, ...);
  354. extern int Swig_error_count(void);
  355. extern void Swig_error_silent(int s);
  356. extern void Swig_warnfilter(const String_or_char *wlist, int val);
  357. extern void Swig_warnall(void);
  358. extern int Swig_warn_count(void);
  359. /* --- C Wrappers --- */
  360. extern String *Swig_cparm_name(Parm *p, int i);
  361. extern String *Swig_clocal(SwigType *t, String_or_char *name, String_or_char *value);
  362. extern String *Swig_wrapped_var_type(SwigType *t);
  363. extern String *Swig_wrapped_var_deref(SwigType *t, String_or_char *name);
  364. extern String *Swig_wrapped_var_assign(SwigType *t, String_or_char *name);
  365. extern int Swig_cargs(Wrapper *w, ParmList *l);
  366. extern String *Swig_cresult(SwigType *t, const String_or_char *name, const String_or_char *decl);
  367. extern String *Swig_cfunction_call(String_or_char *name, ParmList *parms);
  368. extern String *Swig_cmethod_call(String_or_char *name, ParmList *parms, String_or_char *self);
  369. extern String *Swig_cconstructor_call(String_or_char *name);
  370. extern String *Swig_cppconstructor_call(String_or_char *name, ParmList *parms);
  371. extern String *Swig_cdestructor_call();
  372. extern String *Swig_cppdestructor_call();
  373. extern String *Swig_cmemberset_call(String_or_char *name, SwigType *type, String_or_char *self);
  374. extern String *Swig_cmemberget_call(String_or_char *name, SwigType *t, String_or_char *self);
  375. /* --- Transformations --- */
  376. extern int Swig_MethodToFunction(Node *n, String *classname, int flags);
  377. extern int Swig_ConstructorToFunction(Node *n, String *classname, int cplus, int flags);
  378. extern int Swig_DestructorToFunction(Node *n, String *classname, int cplus, int flags);
  379. extern int Swig_MembersetToFunction(Node *n, String *classname, int flags);
  380. extern int Swig_MembergetToFunction(Node *n, String *classname, int flags);
  381. extern int Swig_VargetToFunction(Node *n);
  382. extern int Swig_VarsetToFunction(Node *n);
  383. #define CWRAP_EXTEND 0x01
  384. #define CWRAP_SMART_POINTER 0x02
  385. /* --- Legacy Typemap API (somewhat simplified, ha!) --- */
  386. extern void Swig_typemap_init();
  387. extern void Swig_typemap_register(const String_or_char *op, ParmList *pattern, String_or_char *code, ParmList *locals, ParmList *kwargs);
  388. extern int Swig_typemap_copy(const String_or_char *op, ParmList *srcpattern, ParmList *pattern);
  389. extern void Swig_typemap_clear(const String_or_char *op, ParmList *pattern);
  390. extern int Swig_typemap_apply(ParmList *srcpat, ParmList *destpat);
  391. extern void Swig_typemap_clear_apply(ParmList *pattern);
  392. extern void Swig_typemap_debug();
  393. extern Hash *Swig_typemap_search(const String_or_char *op, SwigType *type, String_or_char *pname);
  394. extern Hash *Swig_typemap_search_multi(const String_or_char *op, ParmList *parms, int *nmatch);
  395. extern String *Swig_typemap_lookup(const String_or_char *op, SwigType *type, String_or_char *pname, String_or_char *lname,
  396. String_or_char *source, String_or_char *target, Wrapper *f);
  397. extern String *Swig_typemap_lookup_new(const String_or_char *op, Node *n, const String_or_char *lname, Wrapper *f);
  398. extern String *Swig_typemap_lookup_multi(const String_or_char *op, ParmList *parms, String_or_char *source, Wrapper *f, int *nmatch);
  399. extern void Swig_typemap_new_scope();
  400. extern Hash *Swig_typemap_pop_scope();
  401. extern void Swig_typemap_attach_parms(const String_or_char *op, ParmList *parms, Wrapper *f);
  402. /* --- Code fragment support --- */
  403. extern void Swig_fragment_register(String *name, String *section, String *code);
  404. extern void Swig_fragment_emit(String *name);
  405. #endif