/tags/rel-1-3-26/SWIG/Doc/Manual/Contents.html

# · HTML · 1285 lines · 1160 code · 65 blank · 60 comment · 0 complexity · cee36afe214ad4a13f0083ab974a19a4 MD5 · raw file

Large files are truncated click here to view the full file

    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    2. 

  2. <HTML>
    3. 

  3. <HEAD>
    4. 

  4. <TITLE>SWIG Users Manual</TITLE>
    5. 

  5. </HEAD>
    6. 

  6. <BODY BGCOLOR="#ffffff">
    7. 

  7. <H1>SWIG Users Manual</H1>
    8. 

  8. 

  9. <p>
    10. 

  10. 

  11. <h3><a href="Preface.html#Preface">1 Preface</a></h3>
    12. 

  12. 

  13. <!-- INDEX -->
    14. 

  14. <div class="sectiontoc">
    15. 

  15. <ul>
    16. 

  16. <li><a href="Preface.html#Preface_nn2">Introduction</a>
    17. 

  17. <li><a href="Preface.html#Preface_nn3">Special Introduction for Version 1.3</a>
    18. 

  18. <li><a href="Preface.html#Preface_nn4">SWIG Versions</a>
    19. 

  19. <li><a href="Preface.html#Preface_nn5">SWIG resources</a>
    20. 

  20. <li><a href="Preface.html#Preface_nn6">Prerequisites</a>
    21. 

  21. <li><a href="Preface.html#Preface_nn7">Organization of this manual</a>
    22. 

  22. <li><a href="Preface.html#Preface_nn8">How to avoid reading the manual</a>
    23. 

  23. <li><a href="Preface.html#Preface_nn9">Backwards Compatibility</a>
    24. 

  24. <li><a href="Preface.html#Preface_nn10">Credits</a>
    25. 

  25. <li><a href="Preface.html#Preface_nn11">Bug reports</a>
    26. 

  26. </ul>
    27. 

  27. </div>
    28. 

  28. <!-- INDEX -->
    29. 

  29. 

  30. <h3><a href="Introduction.html#Introduction">2 Introduction</a></h3>
    31. 

  31. 

  32. <!-- INDEX -->
    33. 

  33. <div class="sectiontoc">
    34. 

  34. <ul>
    35. 

  35. <li><a href="Introduction.html#Introduction_nn2">What is SWIG?</a>
    36. 

  36. <li><a href="Introduction.html#Introduction_nn3">Why use SWIG?</a>
    37. 

  37. <li><a href="Introduction.html#Introduction_nn4">A SWIG example</a>
    38. 

  38. <ul>
    39. 

  39. <li><a href="Introduction.html#Introduction_nn5">SWIG interface file</a>
    40. 

  40. <li><a href="Introduction.html#Introduction_nn6">The swig command</a>
    41. 

  41. <li><a href="Introduction.html#Introduction_nn7">Building a Perl5 module</a>
    42. 

  42. <li><a href="Introduction.html#Introduction_nn8">Building a Python module</a>
    43. 

  43. <li><a href="Introduction.html#Introduction_nn9">Shortcuts</a>
    44. 

  44. </ul>
    45. 

  45. <li><a href="Introduction.html#Introduction_nn10">Supported C/C++ language features</a>
    46. 

  46. <li><a href="Introduction.html#Introduction_nn11">Non-intrusive interface building</a>
    47. 

  47. <li><a href="Introduction.html#Introduction_build_system">Incorporating SWIG into a build system</a>
    48. 

  48. <li><a href="Introduction.html#Introduction_nn12">Hands off code generation</a>
    49. 

  49. <li><a href="Introduction.html#Introduction_nn13">SWIG and freedom</a>
    50. 

  50. </ul>
    51. 

  51. </div>
    52. 

  52. <!-- INDEX -->
    53. 

  53. 

  54. <h3><a href="Windows.html#Windows">3 Getting started on Windows </a></h3>
    55. 

  55. 

  56. <!-- INDEX -->
    57. 

  57. <div class="sectiontoc">
    58. 

  58. <ul>
    59. 

  59. <li><a href="Windows.html#Windows_nn2">Installation on Windows</a>
    60. 

  60. <ul>
    61. 

  61. <li><a href="Windows.html#Windows_nn3">Windows Executable</a>
    62. 

  62. </ul>
    63. 

  63. <li><a href="Windows.html#examples">SWIG Windows Examples</a>
    64. 

  64. <ul>
    65. 

  65. <li><a href="Windows.html#Windows_nn5">Instructions for using the Examples with Visual Studio</a>
    66. 

  66. <ul>
    67. 

  67. <li><a href="Windows.html#Windows_nn6">Python</a>
    68. 

  68. <li><a href="Windows.html#Windows_nn7">TCL</a>
    69. 

  69. <li><a href="Windows.html#Windows_nn8">Perl</a>
    70. 

  70. <li><a href="Windows.html#Windows_nn9">Java</a>
    71. 

  71. <li><a href="Windows.html#Windows_nn10">Ruby</a>
    72. 

  72. <li><a href="Windows.html#Windows_nn11">C#</a>
    73. 

  73. </ul>
    74. 

  74. <li><a href="Windows.html#Windows_nn12">Instructions for using the Examples with other compilers</a>
    75. 

  75. </ul>
    76. 

  76. <li><a href="Windows.html#Windows_nn13">SWIG on Cygwin and MinGW</a>
    77. 

  77. <ul>
    78. 

  78. <li><a href="Windows.html#swig_exe">Building swig.exe on Windows</a>
    79. 

  79. <ul>
    80. 

  80. <li><a href="Windows.html#Windows_nn15">Building swig.exe using MinGW and MSYS</a>
    81. 

  81. <li><a href="Windows.html#Windows_nn16">Building swig.exe using Cygwin</a>
    82. 

  82. <li><a href="Windows.html#Windows_nn17">Building swig.exe alternatives</a>
    83. 

  83. </ul>
    84. 

  84. <li><a href="Windows.html#examples_cygwin">Running the examples on Windows using Cygwin</a>
    85. 

  85. </ul>
    86. 

  86. </ul>
    87. 

  87. </div>
    88. 

  88. <!-- INDEX -->
    89. 

  89. 

  90. <h3><a href="Scripting.html#Scripting">4 Scripting Languages</a></h3>
    91. 

  91. 

  92. <!-- INDEX -->
    93. 

  93. <div class="sectiontoc">
    94. 

  94. <ul>
    95. 

  95. <li><a href="Scripting.html#Scripting_nn2">The two language view of the world</a>
    96. 

  96. <li><a href="Scripting.html#Scripting_nn3">How does a scripting language talk to C?</a>
    97. 

  97. <ul>
    98. 

  98. <li><a href="Scripting.html#Scripting_nn4">Wrapper functions</a>
    99. 

  99. <li><a href="Scripting.html#Scripting_nn5">Variable linking</a>
    100. 

  100. <li><a href="Scripting.html#Scripting_nn6">Constants</a>
    101. 

  101. <li><a href="Scripting.html#Scripting_nn7">Structures and classes</a>
    102. 

  102. <li><a href="Scripting.html#Scripting_nn8">Proxy classes</a>
    103. 

  103. </ul>
    104. 

  104. <li><a href="Scripting.html#Scripting_nn9">Building scripting language extensions</a>
    105. 

  105. <ul>
    106. 

  106. <li><a href="Scripting.html#Scripting_nn10">Shared libraries and dynamic loading</a>
    107. 

  107. <li><a href="Scripting.html#Scripting_nn11">Linking with shared libraries</a>
    108. 

  108. <li><a href="Scripting.html#Scripting_nn12">Static linking</a>
    109. 

  109. </ul>
    110. 

  110. </ul>
    111. 

  111. </div>
    112. 

  112. <!-- INDEX -->
    113. 

  113. 

  114. <h3><a href="SWIG.html#SWIG">5 SWIG Basics</a></h3>
    115. 

  115. 

  116. <!-- INDEX -->
    117. 

  117. <div class="sectiontoc">
    118. 

  118. <ul>
    119. 

  119. <li><a href="SWIG.html#SWIG_nn2">Running SWIG</a>
    120. 

  120. <ul>
    121. 

  121. <li><a href="SWIG.html#SWIG_nn3">Input format</a>
    122. 

  122. <li><a href="SWIG.html#output">SWIG Output</a>
    123. 

  123. <li><a href="SWIG.html#SWIG_nn5">Comments</a>
    124. 

  124. <li><a href="SWIG.html#SWIG_nn6">C Preprocessor</a>
    125. 

  125. <li><a href="SWIG.html#SWIG_nn7">SWIG Directives</a>
    126. 

  126. <li><a href="SWIG.html#SWIG_nn8">Parser Limitations</a>
    127. 

  127. </ul>
    128. 

  128. <li><a href="SWIG.html#SWIG_nn9">Wrapping Simple C Declarations</a>
    129. 

  129. <ul>
    130. 

  130. <li><a href="SWIG.html#SWIG_nn10">Basic Type Handling</a>
    131. 

  131. <li><a href="SWIG.html#SWIG_nn11">Global Variables</a>
    132. 

  132. <li><a href="SWIG.html#SWIG_nn12">Constants</a>
    133. 

  133. <li><a href="SWIG.html#SWIG_nn13">A brief word about <tt>const</tt></a>
    134. 

  134. <li><a href="SWIG.html#SWIG_nn14">A cautionary tale of <tt>char *</tt></a>
    135. 

  135. </ul>
    136. 

  136. <li><a href="SWIG.html#SWIG_nn15">Pointers and complex objects</a>
    137. 

  137. <ul>
    138. 

  138. <li><a href="SWIG.html#SWIG_nn16">Simple pointers</a>
    139. 

  139. <li><a href="SWIG.html#SWIG_nn17">Run time pointer type checking</a>
    140. 

  140. <li><a href="SWIG.html#SWIG_nn18">Derived types, structs, and classes</a>
    141. 

  141. <li><a href="SWIG.html#SWIG_nn19">Undefined datatypes</a>
    142. 

  142. <li><a href="SWIG.html#SWIG_nn20">Typedef</a>
    143. 

  143. </ul>
    144. 

  144. <li><a href="SWIG.html#SWIG_nn21">Other Practicalities</a>
    145. 

  145. <ul>
    146. 

  146. <li><a href="SWIG.html#SWIG_nn22">Passing structures by value</a>
    147. 

  147. <li><a href="SWIG.html#SWIG_nn23">Return by value</a>
    148. 

  148. <li><a href="SWIG.html#SWIG_nn24">Linking to structure variables</a>
    149. 

  149. <li><a href="SWIG.html#SWIG_nn25">Linking to <tt>char *</tt></a>
    150. 

  150. <li><a href="SWIG.html#SWIG_nn26">Arrays</a>
    151. 

  151. <li><a href="SWIG.html#SWIG_readonly_variables">Creating read-only variables</a>
    152. 

  152. <li><a href="SWIG.html#SWIG_nn28">Renaming and ignoring declarations</a>
    153. 

  153. <li><a href="SWIG.html#SWIG_default_args">Default/optional arguments</a>
    154. 

  154. <li><a href="SWIG.html#SWIG_nn30">Pointers to functions and callbacks</a>
    155. 

  155. </ul>
    156. 

  156. <li><a href="SWIG.html#SWIG_nn31">Structures and unions</a>
    157. 

  157. <ul>
    158. 

  158. <li><a href="SWIG.html#SWIG_nn32">Typedef and structures</a>
    159. 

  159. <li><a href="SWIG.html#SWIG_nn33">Character strings and structures</a>
    160. 

  160. <li><a href="SWIG.html#SWIG_nn34">Array members</a>
    161. 

  161. <li><a href="SWIG.html#SWIG_nn35">Structure data members</a>
    162. 

  162. <li><a href="SWIG.html#SWIG_nn36">C constructors and destructors </a>
    163. 

  163. <li><a href="SWIG.html#SWIG_adding_member_functions">Adding member functions to C structures</a>
    164. 

  164. <li><a href="SWIG.html#SWIG_nn38">Nested structures</a>
    165. 

  165. <li><a href="SWIG.html#SWIG_nn39">Other things to note about structure wrapping</a>
    166. 

  166. </ul>
    167. 

  167. <li><a href="SWIG.html#SWIG_nn40">Code Insertion</a>
    168. 

  168. <ul>
    169. 

  169. <li><a href="SWIG.html#SWIG_nn41">The output of SWIG</a>
    170. 

  170. <li><a href="SWIG.html#SWIG_nn42">Code insertion blocks</a>
    171. 

  171. <li><a href="SWIG.html#SWIG_nn43">Inlined code blocks</a>
    172. 

  172. <li><a href="SWIG.html#SWIG_nn44">Initialization blocks</a>
    173. 

  173. </ul>
    174. 

  174. <li><a href="SWIG.html#SWIG_nn45">An Interface Building Strategy</a>
    175. 

  175. <ul>
    176. 

  176. <li><a href="SWIG.html#SWIG_nn46">Preparing a C program for SWIG</a>
    177. 

  177. <li><a href="SWIG.html#SWIG_nn47">The SWIG interface file</a>
    178. 

  178. <li><a href="SWIG.html#SWIG_nn48">Why use separate interface files?</a>
    179. 

  179. <li><a href="SWIG.html#SWIG_nn49">Getting the right header files</a>
    180. 

  180. <li><a href="SWIG.html#SWIG_nn50">What to do with main()</a>
    181. 

  181. </ul>
    182. 

  182. </ul>
    183. 

  183. </div>
    184. 

  184. <!-- INDEX -->
    185. 

  185. 

  186. <h3><a href="SWIGPlus.html#SWIGPlus">6 SWIG and C++</a></h3>
    187. 

  187. 

  188. <!-- INDEX -->
    189. 

  189. <div class="sectiontoc">
    190. 

  190. <ul>
    191. 

  191. <li><a href="SWIGPlus.html#SWIGPlus_nn2">Comments on C++ Wrapping</a>
    192. 

  192. <li><a href="SWIGPlus.html#SWIGPlus_nn3">Approach</a>
    193. 

  193. <li><a href="SWIGPlus.html#SWIGPlus_nn4">Supported C++ features</a>
    194. 

  194. <li><a href="SWIGPlus.html#SWIGPlus_nn5">Command line options and compilation</a>
    195. 

  195. <li><a href="SWIGPlus.html#SWIGPlus_nn6">Simple C++ wrapping</a>
    196. 

  196. <ul>
    197. 

  197. <li><a href="SWIGPlus.html#SWIGPlus_nn7">Constructors and destructors</a>
    198. 

  198. <li><a href="SWIGPlus.html#SWIGPlus_nn8">Default constructors</a>
    199. 

  199. <li><a href="SWIGPlus.html#SWIGPlus_nn9">When constructor wrappers aren't created</a>
    200. 

  200. <li><a href="SWIGPlus.html#SWIGPlus_nn10">Copy constructors</a>
    201. 

  201. <li><a href="SWIGPlus.html#SWIGPlus_nn11">Member functions</a>
    202. 

  202. <li><a href="SWIGPlus.html#SWIGPlus_nn12">Static members</a>
    203. 

  203. <li><a href="SWIGPlus.html#SWIGPlus_nn13">Member data</a>
    204. 

  204. </ul>
    205. 

  205. <li><a href="SWIGPlus.html#SWIGPlus_default_args">Default arguments</a>
    206. 

  206. <li><a href="SWIGPlus.html#SWIGPlus_nn15">Protection</a>
    207. 

  207. <li><a href="SWIGPlus.html#SWIGPlus_nn16">Enums and constants</a>
    208. 

  208. <li><a href="SWIGPlus.html#SWIGPlus_nn17">Friends</a>
    209. 

  209. <li><a href="SWIGPlus.html#SWIGPlus_nn18">References and pointers</a>
    210. 

  210. <li><a href="SWIGPlus.html#SWIGPlus_nn19">Pass and return by value</a>
    211. 

  211. <li><a href="SWIGPlus.html#SWIGPlus_nn20">Inheritance</a>
    212. 

  212. <li><a href="SWIGPlus.html#SWIGPlus_nn21">A brief discussion of multiple inheritance, pointers,  and type checking</a>
    213. 

  213. <li><a href="SWIGPlus.html#SWIGPlus_nn22">Renaming</a>
    214. 

  214. <li><a href="SWIGPlus.html#SWIGPlus_overloaded_methods">Wrapping Overloaded Functions and Methods</a>
    215. 

  215. <ul>
    216. 

  216. <li><a href="SWIGPlus.html#SWIGPlus_nn24">Dispatch function generation</a>
    217. 

  217. <li><a href="SWIGPlus.html#SWIGPlus_nn25">Ambiguity in Overloading</a>
    218. 

  218. <li><a href="SWIGPlus.html#ambiguity_resolution_renaming">Ambiguity resolution and renaming</a>
    219. 

  219. <li><a href="SWIGPlus.html#SWIGPlus_nn27">Comments on overloading</a>
    220. 

  220. </ul>
    221. 

  221. <li><a href="SWIGPlus.html#SWIGPlus_nn28">Wrapping overloaded operators</a>
    222. 

  222. <li><a href="SWIGPlus.html#SWIGPlus_nn29">Class extension</a>
    223. 

  223. <li><a href="SWIGPlus.html#SWIGPlus_nn30">Templates</a>
    224. 

  224. <li><a href="SWIGPlus.html#SWIGPlus_nn31">Namespaces</a>
    225. 

  225. <li><a href="SWIGPlus.html#SWIGPlus_exception_specifications">Exception specifications</a>
    226. 

  226. <li><a href="SWIGPlus.html#SWIGPlus_nn33">Pointers to Members</a>
    227. 

  227. <li><a href="SWIGPlus.html#SWIGPlus_nn34">Smart pointers and operator-&gt;()</a>
    228. 

  228. <li><a href="SWIGPlus.html#SWIGPlus_nn35">Using declarations and inheritance</a>
    229. 

  229. <li><a href="SWIGPlus.html#SWIGPlus_nn36">Partial class definitions</a>
    230. 

  230. <li><a href="SWIGPlus.html#SWIGPlus_nn37">A brief rant about const-correctness</a>
    231. 

  231. <li><a href="SWIGPlus.html#SWIGPlus_nn38">Proxy classes</a>
    232. 

  232. <ul>
    233. 

  233. <li><a href="SWIGPlus.html#SWIGPlus_nn39">Construction of proxy classes</a>
    234. 

  234. <li><a href="SWIGPlus.html#SWIGPlus_nn40">Resource management in proxies</a>
    235. 

  235. <li><a href="SWIGPlus.html#SWIGPlus_nn41">Language specific details</a>
    236. 

  236. </ul>
    237. 

  237. <li><a href="SWIGPlus.html#SWIGPlus_nn42">Where to go for more information</a>
    238. 

  238. </ul>
    239. 

  239. </div>
    240. 

  240. <!-- INDEX -->
    241. 

  241. 

  242. <h3><a href="Preprocessor.html#Preprocessor">7 Preprocessing</a></h3>
    243. 

  243. 

  244. <!-- INDEX -->
    245. 

  245. <div class="sectiontoc">
    246. 

  246. <ul>
    247. 

  247. <li><a href="Preprocessor.html#Preprocessor_nn2">File inclusion</a>
    248. 

  248. <li><a href="Preprocessor.html#Preprocessor_nn3">File imports</a>
    249. 

  249. <li><a href="Preprocessor.html#Preprocessor_nn4">Conditional Compilation</a>
    250. 

  250. <li><a href="Preprocessor.html#Preprocessor_nn5">Macro Expansion</a>
    251. 

  251. <li><a href="Preprocessor.html#Preprocessor_nn6">SWIG Macros</a>
    252. 

  252. <li><a href="Preprocessor.html#Preprocessor_nn7">C99 and GNU Extensions</a>
    253. 

  253. <li><a href="Preprocessor.html#Preprocessor_nn8">Preprocessing and %{ ... %} blocks</a>
    254. 

  254. <li><a href="Preprocessor.html#Preprocessor_nn9">Preprocessing and { ... }</a>
    255. 

  255. <li><a href="Preprocessor.html#Preprocessor_nn10">Viewing preprocessor output</a>
    256. 

  256. </ul>
    257. 

  257. </div>
    258. 

  258. <!-- INDEX -->
    259. 

  259. 

  260. <h3><a href="Library.html#Library">8 SWIG library</a></h3>
    261. 

  261. 

  262. <!-- INDEX -->
    263. 

  263. <div class="sectiontoc">
    264. 

  264. <ul>
    265. 

  265. <li><a href="Library.html#Library_nn2">The %include directive and library search path</a>
    266. 

  266. <li><a href="Library.html#Library_nn3">C Arrays and Pointers</a>
    267. 

  267. <ul>
    268. 

  268. <li><a href="Library.html#Library_nn4">cpointer.i</a>
    269. 

  269. <li><a href="Library.html#Library_nn5">carrays.i</a>
    270. 

  270. <li><a href="Library.html#Library_nn6">cmalloc.i</a>
    271. 

  271. <li><a href="Library.html#Library_nn7">cdata.i</a>
    272. 

  272. </ul>
    273. 

  273. <li><a href="Library.html#Library_nn8">C String Handling</a>
    274. 

  274. <ul>
    275. 

  275. <li><a href="Library.html#Library_nn9">Default string handling</a>
    276. 

  276. <li><a href="Library.html#Library_nn10">Passing binary data</a>
    277. 

  277. <li><a href="Library.html#Library_nn11">Using %newobject to release memory</a>
    278. 

  278. <li><a href="Library.html#Library_nn12">cstring.i</a>
    279. 

  279. </ul>
    280. 

  280. <li><a href="Library.html#Library_stl_cpp_library">STL/C++ Library</a>
    281. 

  281. <ul>
    282. 

  282. <li><a href="Library.html#Library_nn14">std_string.i</a>
    283. 

  283. <li><a href="Library.html#Library_nn15">std_vector.i</a>
    284. 

  284. <li><a href="Library.html#Library_stl_exceptions">STL exceptions</a>
    285. 

  285. </ul>
    286. 

  286. <li><a href="Library.html#Library_nn16">Utility Libraries</a>
    287. 

  287. <ul>
    288. 

  288. <li><a href="Library.html#Library_nn17">exception.i</a>
    289. 

  289. </ul>
    290. 

  290. </ul>
    291. 

  291. </div>
    292. 

  292. <!-- INDEX -->
    293. 

  293. 

  294. <h3><a href="Arguments.html#Arguments">9 Argument Handling</a></h3>
    295. 

  295. 

  296. <!-- INDEX -->
    297. 

  297. <div class="sectiontoc">
    298. 

  298. <ul>
    299. 

  299. <li><a href="Arguments.html#Arguments_nn2">The typemaps.i library</a>
    300. 

  300. <ul>
    301. 

  301. <li><a href="Arguments.html#Arguments_nn3">Introduction</a>
    302. 

  302. <li><a href="Arguments.html#Arguments_nn4">Input parameters</a>
    303. 

  303. <li><a href="Arguments.html#Arguments_nn5">Output parameters</a>
    304. 

  304. <li><a href="Arguments.html#Arguments_nn6">Input/Output parameters</a>
    305. 

  305. <li><a href="Arguments.html#Arguments_nn7">Using different names</a>
    306. 

  306. </ul>
    307. 

  307. <li><a href="Arguments.html#Arguments_nn8">Applying constraints to input values</a>
    308. 

  308. <ul>
    309. 

  309. <li><a href="Arguments.html#Arguments_nn9">Simple constraint example</a>
    310. 

  310. <li><a href="Arguments.html#Arguments_nn10">Constraint methods</a>
    311. 

  311. <li><a href="Arguments.html#Arguments_nn11">Applying constraints to new datatypes</a>
    312. 

  312. </ul>
    313. 

  313. </ul>
    314. 

  314. </div>
    315. 

  315. <!-- INDEX -->
    316. 

  316. 

  317. <h3><a href="Typemaps.html#Typemaps">10 Typemaps</a></h3>
    318. 

  318. 

  319. <!-- INDEX -->
    320. 

  320. <div class="sectiontoc">
    321. 

  321. <ul>
    322. 

  322. <li><a href="Typemaps.html#Typemaps_nn2">Introduction</a>
    323. 

  323. <ul>
    324. 

  324. <li><a href="Typemaps.html#Typemaps_nn3">Type conversion</a>
    325. 

  325. <li><a href="Typemaps.html#Typemaps_nn4">Typemaps</a>
    326. 

  326. <li><a href="Typemaps.html#Typemaps_nn5">Pattern matching</a>
    327. 

  327. <li><a href="Typemaps.html#Typemaps_nn6">Reusing typemaps</a>
    328. 

  328. <li><a href="Typemaps.html#Typemaps_nn7">What can be done with typemaps?</a>
    329. 

  329. <li><a href="Typemaps.html#Typemaps_nn8">What can't be done with typemaps?</a>
    330. 

  330. <li><a href="Typemaps.html#Typemaps_nn9">The rest of this chapter</a>
    331. 

  331. </ul>
    332. 

  332. <li><a href="Typemaps.html#Typemaps_nn10">Typemap specifications</a>
    333. 

  333. <ul>
    334. 

  334. <li><a href="Typemaps.html#Typemaps_nn11">Defining a typemap</a>
    335. 

  335. <li><a href="Typemaps.html#Typemaps_nn12">Typemap scope</a>
    336. 

  336. <li><a href="Typemaps.html#Typemaps_nn13">Copying a typemap</a>
    337. 

  337. <li><a href="Typemaps.html#Typemaps_nn14">Deleting a typemap</a>
    338. 

  338. <li><a href="Typemaps.html#Typemaps_nn15">Placement of typemaps</a>
    339. 

  339. </ul>
    340. 

  340. <li><a href="Typemaps.html#Typemaps_nn16">Pattern matching rules</a>
    341. 

  341. <ul>
    342. 

  342. <li><a href="Typemaps.html#Typemaps_nn17">Basic matching rules</a>
    343. 

  343. <li><a href="Typemaps.html#Typemaps_nn18">Typedef reductions</a>
    344. 

  344. <li><a href="Typemaps.html#Typemaps_nn19">Default typemaps</a>
    345. 

  345. <li><a href="Typemaps.html#Typemaps_mixed_default">Mixed default typemaps</a>
    346. 

  346. <li><a href="Typemaps.html#Typemaps_nn20">Multi-arguments typemaps</a>
    347. 

  347. </ul>
    348. 

  348. <li><a href="Typemaps.html#Typemaps_nn21">Code generation rules</a>
    349. 

  349. <ul>
    350. 

  350. <li><a href="Typemaps.html#Typemaps_nn22">Scope</a>
    351. 

  351. <li><a href="Typemaps.html#Typemaps_nn23">Declaring new local variables</a>
    352. 

  352. <li><a href="Typemaps.html#Typemaps_nn24">Special variables</a>
    353. 

  353. </ul>
    354. 

  354. <li><a href="Typemaps.html#Typemaps_nn25">Common typemap methods</a>
    355. 

  355. <ul>
    356. 

  356. <li><a href="Typemaps.html#Typemaps_nn26">"in" typemap</a>
    357. 

  357. <li><a href="Typemaps.html#Typemaps_nn27">"typecheck" typemap</a>
    358. 

  358. <li><a href="Typemaps.html#Typemaps_nn28">"out" typemap</a>
    359. 

  359. <li><a href="Typemaps.html#Typemaps_nn29">"arginit" typemap</a>
    360. 

  360. <li><a href="Typemaps.html#Typemaps_nn30">"default" typemap</a>
    361. 

  361. <li><a href="Typemaps.html#Typemaps_nn31">"check" typemap</a>
    362. 

  362. <li><a href="Typemaps.html#Typemaps_nn32">"argout" typemap</a>
    363. 

  363. <li><a href="Typemaps.html#Typemaps_nn33">"freearg" typemap</a>
    364. 

  364. <li><a href="Typemaps.html#Typemaps_nn34">"newfree" typemap</a>
    365. 

  365. <li><a href="Typemaps.html#Typemaps_nn35">"memberin" typemap</a>
    366. 

  366. <li><a href="Typemaps.html#Typemaps_nn36">"varin" typemap</a>
    367. 

  367. <li><a href="Typemaps.html#Typemaps_nn37">"varout" typemap</a>
    368. 

  368. <li><a href="Typemaps.html#throws_typemap">"throws" typemap</a>
    369. 

  369. </ul>
    370. 

  370. <li><a href="Typemaps.html#Typemaps_nn39">Some typemap examples</a>
    371. 

  371. <ul>
    372. 

  372. <li><a href="Typemaps.html#Typemaps_nn40">Typemaps for arrays</a>
    373. 

  373. <li><a href="Typemaps.html#Typemaps_nn41">Implementing constraints with typemaps</a>
    374. 

  374. </ul>
    375. 

  375. <li><a href="Typemaps.html#Typemaps_nn42">Multi-argument typemaps</a>
    376. 

  376. <li><a href="Typemaps.html#runtime_type_checker">The run-time type checker</a>
    377. 

  377. <ul>
    378. 

  378. <li><a href="Typemaps.html#Typemaps_nn45">Implementation</a>
    379. 

  379. <li><a href="Typemaps.html#Typemaps_nn46">Usage</a>
    380. 

  380. </ul>
    381. 

  381. <li><a href="Typemaps.html#Typemaps_overloading">Typemaps and overloading</a>
    382. 

  382. <li><a href="Typemaps.html#Typemaps_nn48">More about <tt>%apply</tt> and <tt>%clear</tt></a>
    383. 

  383. <li><a href="Typemaps.html#Typemaps_nn49">Reducing wrapper code size</a>
    384. 

  384. <li><a href="Typemaps.html#Typemaps_nn47">Passing data between typemaps</a>
    385. 

  385. <li><a href="Typemaps.html#Typemaps_nn51">Where to go for more information?</a>
    386. 

  386. </ul>
    387. 

  387. </div>
    388. 

  388. <!-- INDEX -->
    389. 

  389. 

  390. <h3><a href="Customization.html#Customization">11 Customization Features</a></h3>
    391. 

  391. 

  392. <!-- INDEX -->
    393. 

  393. <div class="sectiontoc">
    394. 

  394. <ul>
    395. 

  395. <li><a href="Customization.html#exception">Exception handling with %exception</a>
    396. 

  396. <ul>
    397. 

  397. <li><a href="Customization.html#Customization_nn3">Handling exceptions in C code</a>
    398. 

  398. <li><a href="Customization.html#Customization_nn4">Exception handling with longjmp()</a>
    399. 

  399. <li><a href="Customization.html#Customization_nn5">Handling C++ exceptions</a>
    400. 

  400. <li><a href="Customization.html#Customization_nn6">Defining different exception handlers</a>
    401. 

  401. <li><a href="Customization.html#Customization_nn7">Using The SWIG exception library</a>
    402. 

  402. </ul>
    403. 

  403. <li><a href="Customization.html#ownership">Object ownership and %newobject</a>
    404. 

  404. <li><a href="Customization.html#features">Features and the %feature directive</a>
    405. 

  405. <ul>
    406. 

  406. <li><a href="Customization.html#Customization_feature_flags">Feature flags</a>
    407. 

  407. <li><a href="Customization.html#Customization_clearing_features">Clearing features</a>
    408. 

  408. <li><a href="Customization.html#Customization_features_default_args">Features and default arguments</a>
    409. 

  409. <li><a href="Customization.html#features_example">Feature example</a>
    410. 

  410. </ul>
    411. 

  411. </ul>
    412. 

  412. </div>
    413. 

  413. <!-- INDEX -->
    414. 

  414. 

  415. <h3><a href="Contract.html#Contract">12 Contracts</a></h3>
    416. 

  416. 

  417. <!-- INDEX -->
    418. 

  418. <div class="sectiontoc">
    419. 

  419. <ul>
    420. 

  420. <li><a href="Contract.html#Contract_nn2">The %contract directive</a>
    421. 

  421. <li><a href="Contract.html#Contract_nn3">%contract and classes</a>
    422. 

  422. <li><a href="Contract.html#Contract_nn4">Constant aggregation and %aggregate_check</a>
    423. 

  423. <li><a href="Contract.html#Contract_nn5">Notes</a>
    424. 

  424. </ul>
    425. 

  425. </div>
    426. 

  426. <!-- INDEX -->
    427. 

  427. 

  428. <h3><a href="Varargs.html#Varargs">13 Variable Length Arguments</a></h3>
    429. 

  429. 

  430. <!-- INDEX -->
    431. 

  431. <div class="sectiontoc">
    432. 

  432. <ul>
    433. 

  433. <li><a href="Varargs.html#Varargs_nn2">Introduction</a>
    434. 

  434. <li><a href="Varargs.html#Varargs_nn3">The Problem</a>
    435. 

  435. <li><a href="Varargs.html#Varargs_nn4">Default varargs support</a>
    436. 

  436. <li><a href="Varargs.html#Varargs_nn5">Argument replacement using %varargs</a>
    437. 

  437. <li><a href="Varargs.html#Varargs_nn6">Varargs and typemaps</a>
    438. 

  438. <li><a href="Varargs.html#Varargs_nn7">Varargs wrapping with libffi</a>
    439. 

  439. <li><a href="Varargs.html#Varargs_nn8">Wrapping of va_list</a>
    440. 

  440. <li><a href="Varargs.html#Varargs_nn9">C++ Issues</a>
    441. 

  441. <li><a href="Varargs.html#Varargs_nn10">Discussion</a>
    442. 

  442. </ul>
    443. 

  443. </div>
    444. 

  444. <!-- INDEX -->
    445. 

  445. 

  446. <h3><a href="Warnings.html#Warnings">14 Warning Messages</a></h3>
    447. 

  447. 

  448. <!-- INDEX -->
    449. 

  449. <div class="sectiontoc">
    450. 

  450. <ul>
    451. 

  451. <li><a href="Warnings.html#Warnings_nn2">Introduction</a>
    452. 

  452. <li><a href="Warnings.html#Warnings_nn3">Warning message suppression</a>
    453. 

  453. <li><a href="Warnings.html#Warnings_nn4">Enabling additional warnings</a>
    454. 

  454. <li><a href="Warnings.html#Warnings_nn5">Issuing a warning message</a>
    455. 

  455. <li><a href="Warnings.html#Warnings_nn6">Commentary</a>
    456. 

  456. <li><a href="Warnings.html#Warnings_nn7">Warnings as errors</a>
    457. 

  457. <li><a href="Warnings.html#Warnings_nn8">Message output format</a>
    458. 

  458. <li><a href="Warnings.html#Warnings_nn9">Warning number reference</a>
    459. 

  459. <ul>
    460. 

  460. <li><a href="Warnings.html#Warnings_nn10">Deprecated features (100-199)</a>
    461. 

  461. <li><a href="Warnings.html#Warnings_nn11">Preprocessor (200-299)</a>
    462. 

  462. <li><a href="Warnings.html#Warnings_nn12">C/C++ Parser (300-399)</a>
    463. 

  463. <li><a href="Warnings.html#Warnings_nn13">Types and typemaps (400-499) </a>
    464. 

  464. <li><a href="Warnings.html#Warnings_nn14">Code generation (500-599)</a>
    465. 

  465. <li><a href="Warnings.html#Warnings_nn15">Language module specific (800-899) </a>
    466. 

  466. <li><a href="Warnings.html#Warnings_nn16">User defined (900-999)</a>
    467. 

  467. </ul>
    468. 

  468. <li><a href="Warnings.html#Warnings_nn17">History</a>
    469. 

  469. </ul>
    470. 

  470. </div>
    471. 

  471. <!-- INDEX -->
    472. 

  472. 

  473. <h3><a href="Modules.html#Modules">15 Working with Modules</a></h3>
    474. 

  474. 

  475. <!-- INDEX -->
    476. 

  476. <div class="sectiontoc">
    477. 

  477. <ul>
    478. 

  478. <li><a href="Modules.html#Modules_nn2">The SWIG runtime code</a>
    479. 

  479. <li><a href="Modules.html#external_run_time">External access to the runtime</a>
    480. 

  480. <li><a href="Modules.html#Modules_nn4">A word of caution about static libraries</a>
    481. 

  481. <li><a href="Modules.html#Modules_nn5">References</a>
    482. 

  482. <li><a href="Modules.html#Modules_nn6">Reducing the wrapper file size</a>
    483. 

  483. </ul>
    484. 

  484. </div>
    485. 

  485. <!-- INDEX -->
    486. 

  486. 

  487. <h3><a href="CSharp.html#CSharp">16 SWIG and C#</a></h3>
    488. 

  488. 

  489. <!-- INDEX -->
    490. 

  490. <div class="sectiontoc">
    491. 

  491. <ul>
    492. 

  492. <li><a href="CSharp.html#csharp_introduction">Introduction</a>
    493. 

  493. <li><a href="CSharp.html#csharp_differences_java">Differences to the Java module</a>
    494. 

  494. <li><a href="CSharp.html#csharp_exceptions">C# Exceptions</a>
    495. 

  495. <ul>
    496. 

  496. <li><a href="CSharp.html#csharp_exception_example_check_typemap">C# exception example using "check" typemap</a>
    497. 

  497. <li><a href="CSharp.html#csharp_exception_example_percent_exception">C# exception example using %exception</a>
    498. 

  498. <li><a href="CSharp.html#csharp_exception_example_exception_specifications">C# exception example using exception specifications</a>
    499. 

  499. <li><a href="CSharp.html#csharp_custom_application_exception">Custom C# ApplicationException example</a>
    500. 

  500. </ul>
    501. 

  501. </ul>
    502. 

  502. </div>
    503. 

  503. <!-- INDEX -->
    504. 

  504. 

  505. <h3><a href="Chicken.html#Chicken">17 SWIG and Chicken</a></h3>
    506. 

  506. 

  507. <!-- INDEX -->
    508. 

  508. <div class="sectiontoc">
    509. 

  509. <ul>
    510. 

  510. <li><a href="Chicken.html#Chicken_nn2">Preliminaries</a>
    511. 

  511. <ul>
    512. 

  512. <li><a href="Chicken.html#Chicken_nn3">Running SWIG in C mode</a>
    513. 

  513. <li><a href="Chicken.html#Chicken_nn4">Running SWIG in C++ mode</a>
    514. 

  514. </ul>
    515. 

  515. <li><a href="Chicken.html#Chicken_nn5">Code Generation</a>
    516. 

  516. <ul>
    517. 

  517. <li><a href="Chicken.html#Chicken_nn6">Naming Conventions</a>
    518. 

  518. <li><a href="Chicken.html#Chicken_nn7">Modules</a>
    519. 

  519. <li><a href="Chicken.html#Chicken_nn8">Constants and Variables</a>
    520. 

  520. <li><a href="Chicken.html#Chicken_nn9">Functions</a>
    521. 

  521. <li><a href="Chicken.html#Chicken_nn10">Exceptions</a>
    522. 

  522. </ul>
    523. 

  523. <li><a href="Chicken.html#Chicken_nn11">TinyCLOS</a>
    524. 

  524. <li><a href="Chicken.html#Chicken_nn12">Linkage</a>
    525. 

  525. <ul>
    526. 

  526. <li><a href="Chicken.html#Chicken_nn13">Static binary or shared library linked at compile time</a>
    527. 

  527. <li><a href="Chicken.html#Chicken_nn14">Building chicken extension libraries</a>
    528. 

  528. <li><a href="Chicken.html#Chicken_nn15">Linking multiple SWIG modules with TinyCLOS</a>
    529. 

  529. </ul>
    530. 

  530. <li><a href="Chicken.html#Chicken_nn16">Typemaps</a>
    531. 

  531. <li><a href="Chicken.html#Chicken_nn17">Pointers</a>
    532. 

  532. <ul>
    533. 

  533. <li><a href="Chicken.html#collection">Garbage collection</a>
    534. 

  534. </ul>
    535. 

  535. <li><a href="Chicken.html#Chicken_nn18">Unsupported features and known problems</a>
    536. 

  536. </ul>
    537. 

  537. </div>
    538. 

  538. <!-- INDEX -->
    539. 

  539. 

  540. <h3><a href="Guile.html#Guile">18 SWIG and Guile</a></h3>
    541. 

  541. 

  542. <!-- INDEX -->
    543. 

  543. <div class="sectiontoc">
    544. 

  544. <ul>
    545. 

  545. <li><a href="Guile.html#Guile_nn2">Meaning of "Module"</a>
    546. 

  546. <li><a href="Guile.html#Guile_nn3">Using the SCM or GH Guile API</a>
    547. 

  547. <li><a href="Guile.html#Guile_nn4">Linkage</a>
    548. 

  548. <ul>
    549. 

  549. <li><a href="Guile.html#Guile_nn5">Simple Linkage</a>
    550. 

  550. <li><a href="Guile.html#Guile_nn6">Passive Linkage</a>
    551. 

  551. <li><a href="Guile.html#Guile_nn7">Native Guile Module Linkage</a>
    552. 

  552. <li><a href="Guile.html#Guile_nn8">Old Auto-Loading Guile Module Linkage</a>
    553. 

  553. <li><a href="Guile.html#Guile_nn9">Hobbit4D Linkage</a>
    554. 

  554. </ul>
    555. 

  555. <li><a href="Guile.html#Guile_nn10">Underscore Folding</a>
    556. 

  556. <li><a href="Guile.html#Guile_nn11">Typemaps</a>
    557. 

  557. <li><a href="Guile.html#Guile_nn12">Representation of pointers as smobs</a>
    558. 

  558. <ul>
    559. 

  559. <li><a href="Guile.html#Guile_nn13">GH Smobs</a>
    560. 

  560. <li><a href="Guile.html#Guile_nn14">SCM Smobs</a>
    561. 

  561. <li><a href="Guile.html#Guile_nn15">Garbage Collection</a>
    562. 

  562. </ul>
    563. 

  563. <li><a href="Guile.html#Guile_nn16">Exception Handling</a>
    564. 

  564. <li><a href="Guile.html#Guile_nn17">Procedure documentation</a>
    565. 

  565. <li><a href="Guile.html#Guile_nn18">Procedures with setters</a>
    566. 

  566. <li><a href="Guile.html#Guile_nn19">GOOPS Proxy Classes</a>
    567. 

  567. <ul>
    568. 

  568. <li><a href="Guile.html#Guile_nn20">Naming Issues</a>
    569. 

  569. <li><a href="Guile.html#Guile_nn21">Linking</a>
    570. 

  570. </ul>
    571. 

  571. </ul>
    572. 

  572. </div>
    573. 

  573. <!-- INDEX -->
    574. 

  574. 

  575. <h3><a href="Java.html#Java">19 SWIG and Java</a></h3>
    576. 

  576. 

  577. <!-- INDEX -->
    578. 

  578. <div class="sectiontoc">
    579. 

  579. <ul>
    580. 

  580. <li><a href="Java.html#java_overview">Overview</a>
    581. 

  581. <li><a href="Java.html#java_preliminaries">Preliminaries</a>
    582. 

  582. <ul>
    583. 

  583. <li><a href="Java.html#running_swig">Running SWIG</a>
    584. 

  584. <li><a href="Java.html#java_commandline">Additional Commandline Options</a>
    585. 

  585. <li><a href="Java.html#getting_right_headers">Getting the right header files</a>
    586. 

  586. <li><a href="Java.html#compiling_dynamic">Compiling a dynamic module</a>
    587. 

  587. <li><a href="Java.html#using_module">Using your module</a>
    588. 

  588. <li><a href="Java.html#dynamic_linking_problems">Dynamic linking problems</a>
    589. 

  589. <li><a href="Java.html#compilation_problems_cpp">Compilation problems and compiling with C++</a>
    590. 

  590. <li><a href="Java.html#building_windows">Building on Windows</a>
    591. 

  591. <ul>
    592. 

  592. <li><a href="Java.html#visual_studio">Running SWIG from Visual Studio</a>
    593. 

  593. <li><a href="Java.html#nmake">Using NMAKE</a>
    594. 

  594. </ul>
    595. 

  595. </ul>
    596. 

  596. <li><a href="Java.html#java_basic_tour">A tour of basic C/C++ wrapping</a>
    597. 

  597. <ul>
    598. 

  598. <li><a href="Java.html#module_packages_classes">Modules, packages and generated Java classes</a>
    599. 

  599. <li><a href="Java.html#functions">Functions</a>
    600. 

  600. <li><a href="Java.html#global_variables">Global variables</a>
    601. 

  601. <li><a href="Java.html#constants">Constants</a>
    602. 

  602. <li><a href="Java.html#enumerations">Enumerations</a>
    603. 

  603. <ul>
    604. 

  604. <li><a href="Java.html#anonymous_enums">Anonymous enums</a>
    605. 

  605. <li><a href="Java.html#typesafe_enums">Typesafe enums</a>
    606. 

  606. <li><a href="Java.html#proper_enums">Proper Java enums</a>
    607. 

  607. <li><a href="Java.html#typeunsafe_enums">Type unsafe enums</a>
    608. 

  608. <li><a href="Java.html#simple_enums">Simple enums</a>
    609. 

  609. </ul>
    610. 

  610. <li><a href="Java.html#pointers">Pointers</a>
    611. 

  611. <li><a href="Java.html#structures">Structures</a>
    612. 

  612. <li><a href="Java.html#classes">C++ classes</a>
    613. 

  613. <li><a href="Java.html#inheritance">C++ inheritance</a>
    614. 

  614. <li><a href="Java.html#pointers_refs_arrays">Pointers, references, arrays and pass by value</a>
    615. 

  615. <ul>
    616. 

  616. <li><a href="Java.html#null_pointers">Null pointers</a>
    617. 

  617. </ul>
    618. 

  618. <li><a href="Java.html#overloaded_functions">C++ overloaded functions</a>
    619. 

  619. <li><a href="Java.html#java_default_arguments">C++ default arguments</a>
    620. 

  620. <li><a href="Java.html#namespaces">C++ namespaces</a>
    621. 

  621. <li><a href="Java.html#templates">C++ templates</a>
    622. 

  622. <li><a href="Java.html#smart_pointers">C++ Smart Pointers</a>
    623. 

  623. </ul>
    624. 

  624. <li><a href="Java.html#further_details">Further details on the generated Java classes</a>
    625. 

  625. <ul>
    626. 

  626. <li><a href="Java.html#imclass">The intermediary JNI class</a>
    627. 

  627. <ul>
    628. 

  628. <li><a href="Java.html#imclass_pragmas">The intermediary JNI class pragmas</a>
    629. 

  629. </ul>
    630. 

  630. <li><a href="Java.html#java_module_class">The Java module class</a>
    631. 

  631. <ul>
    632. 

  632. <li><a href="Java.html#module_class_pragmas">The Java module class pragmas</a>
    633. 

  633. </ul>
    634. 

  634. <li><a href="Java.html#java_proxy_classes">Java proxy classes</a>
    635. 

  635. <ul>
    636. 

  636. <li><a href="Java.html#memory_management">Memory management</a>
    637. 

  637. <li><a href="Java.html#inheritance_mirroring">Inheritance</a>
    638. 

  638. <li><a href="Java.html#proxy_classes_gc">Proxy classes and garbage collection</a>
    639. 

  639. </ul>
    640. 

  640. <li><a href="Java.html#type_wrapper_classes">Type wrapper classes</a>
    641. 

  641. <li><a href="Java.html#enum_classes">Enum classes</a>
    642. 

  642. <ul>
    643. 

  643. <li><a href="Java.html#typesafe_enums_classes">Typesafe enum classes</a>
    644. 

  644. <li><a href="Java.html#proper_enums_classes">Proper Java enum classes</a>
    645. 

  645. <li><a href="Java.html#typeunsafe_enums_classes">Type unsafe enum classes</a>
    646. 

  646. </ul>
    647. 

  647. </ul>
    648. 

  648. <li><a href="Java.html#java_directors">Cross language polymorphism using directors (experimental)</a>
    649. 

  649. <ul>
    650. 

  650. <li><a href="Java.html#java_enabling_directors">Enabling directors</a>
    651. 

  651. <li><a href="Java.html#java_directors_classes">Director classes</a>
    652. 

  652. <li><a href="Java.html#java_directors_overhead">Overhead and code bloat</a>
    653. 

  653. <li><a href="Java.html#java_directors_example">Simple directors example</a>
    654. 

  654. </ul>
    655. 

  655. <li><a href="Java.html#common_customization">Common customization features</a>
    656. 

  656. <ul>
    657. 

  657. <li><a href="Java.html#helper_functions">C/C++ helper functions</a>
    658. 

  658. <li><a href="Java.html#class_extension">Class extension with %extend</a>
    659. 

  659. <li><a href="Java.html#exception_handling">Exception handling with %exception and %javaexception</a>
    660. 

  660. <li><a href="Java.html#method_access">Method access with %javamethodmodifiers</a>
    661. 

  661. </ul>
    662. 

  662. <li><a href="Java.html#tips_techniques">Tips and techniques</a>
    663. 

  663. <ul>
    664. 

  664. <li><a href="Java.html#input_output_parameters">Input and output parameters using primitive pointers and references</a>
    665. 

  665. <li><a href="Java.html#simple_pointers">Simple pointers</a>
    666. 

  666. <li><a href="Java.html#c_arrays">Wrapping C arrays with Java arrays</a>
    667. 

  667. <li><a href="Java.html#unbounded_c_arrays">Unbounded C Arrays</a>
    668. 

  668. </ul>
    669. 

  669. <li><a href="Java.html#java_typemaps">Java typemaps</a>
    670. 

  670. <ul>
    671. 

  671. <li><a href="Java.html#default_primitive_type_mappings">Default primitive type mappings</a>
    672. 

  672. <li><a href="Java.html#jvm64">Sixty four bit JVMs</a>
    673. 

  673. <li><a href="Java.html#what_is_typemap">What is a typemap?</a>
    674. 

  674. <li><a href="Java.html#typemaps_c_to_java_types">Typemaps for mapping C/C++ types to Java types</a>
    675. 

  675. <li><a href="Java.html#typemap_attributes">Java typemap attributes</a>
    676. 

  676. <li><a href="Java.html#special_variables">Java special variables</a>
    677. 

  677. <li><a href="Java.html#typemaps_for_c_and_c++">Typemaps for both C and C++ compilation</a>
    678. 

  678. <li><a href="Java.html#java_code_typemaps">Java code typemaps</a>
    679. 

  679. <li><a href="Java.html#java_directors_typemaps">Director specific typemaps</a>
    680. 

  680. </ul>
    681. 

  681. <li><a href="Java.html#typemap_examples">Typemap Examples</a>
    682. 

  682. <ul>
    683. 

  683. <li><a href="Java.html#simpler_enum_classes">Simpler Java enums for enums without initializers</a>
    684. 

  684. <li><a href="Java.html#exception_typemap">Handling C++ exception specifications as Java exceptions</a>
    685. 

  685. <li><a href="Java.html#nan_exception_typemap">NaN Exception - exception handling for a particular type</a>
    686. 

  686. <li><a href="Java.html#converting_java_string_arrays">Converting Java String arrays to char ** </a>
    687. 

  687. <li><a href="Java.html#expanding_java_object">Expanding a Java object to multiple arguments</a>
    688. 

  688. <li><a href="Java.html#using_typemaps_return_arguments">Using typemaps to return arguments</a>
    689. 

  689. <li><a href="Java.html#adding_downcasts">Adding Java downcasts to polymorphic return types</a>
    690. 

  690. <li><a href="Java.html#adding_equals_method">Adding an equals method to the Java classes</a>
    691. 

  691. <li><a href="Java.html#void_pointers">Void pointers and a common Java base class</a>
    692. 

  692. <li><a href="Java.html#struct_pointer_pointer">Struct pointer to pointer</a>
    693. 

  693. </ul>
    694. 

  694. <li><a href="Java.html#java_directors_faq">Living with Java Directors</a>
    695. 

  695. <li><a href="Java.html#odds_ends">Odds and ends</a>
    696. 

  696. <ul>
    697. 

  697. <li><a href="Java.html#javadoc_comments">JavaDoc comments</a>
    698. 

  698. <li><a href="Java.html#functional_interface">Functional interface without proxy classes</a>
    699. 

  699. <li><a href="Java.html#using_own_jni_functions">Using your own JNI functions</a>
    700. 

  700. <li><a href="Java.html#performance">Performance concerns and hints</a>
    701. 

  701. </ul>
    702. 

  702. <li><a href="Java.html#java_examples">Examples</a>
    703. 

  703. </ul>
    704. 

  704. </div>
    705. 

  705. <!-- INDEX -->
    706. 

  706. 

  707. <h3><a href="Modula3.html#Modula3">20 SWIG and Modula-3</a></h3>
    708. 

  708. 

  709. <!-- INDEX -->
    710. 

  710. <div class="sectiontoc">
    711. 

  711. <ul>
    712. 

  712. <li><a href="Modula3.html#modula3_overview">Overview</a>
    713. 

  713. <ul>
    714. 

  714. <li><a href="Modula3.html#whyscripting">Why not scripting ?</a>
    715. 

  715. <li><a href="Modula3.html#whymodula3">Why Modula-3 ?</a>
    716. 

  716. <li><a href="Modula3.html#whycpp">Why C / C++ ?</a>
    717. 

  717. <li><a href="Modula3.html#whyswig">Why SWIG ?</a>
    718. 

  718. </ul>
    719. 

  719. <li><a href="Modula3.html#conception">Conception</a>
    720. 

  720. <ul>
    721. 

  721. <li><a href="Modula3.html#cinterface">Interfaces to C libraries</a>
    722. 

  722. <li><a href="Modula3.html#cppinterface">Interfaces to C++ libraries</a>
    723. 

  723. </ul>
    724. 

  724. <li><a href="Modula3.html#preliminaries">Preliminaries</a>
    725. 

  725. <ul>
    726. 

  726. <li><a href="Modula3.html#compilers">Compilers</a>
    727. 

  727. <li><a href="Modula3.html#commandline">Additional Commandline Options</a>
    728. 

  728. </ul>
    729. 

  729. <li><a href="Modula3.html#modula3_typemaps">Modula-3 typemaps</a>
    730. 

  730. <ul>
    731. 

  731. <li><a href="Modula3.html#inoutparam">Inputs and outputs</a>
    732. 

  732. <li><a href="Modula3.html#ordinals">Subranges, Enumerations, Sets</a>
    733. 

  733. <li><a href="Modula3.html#class">Objects</a>
    734. 

  734. <li><a href="Modula3.html#imports">Imports</a>
    735. 

  735. <li><a href="Modula3.html#exceptions">Exceptions</a>
    736. 

  736. <li><a href="Modula3.html#typemap_example">Example</a>
    737. 

  737. </ul>
    738. 

  738. <li><a href="Modula3.html#hints">More hints to the generator</a>
    739. 

  739. <ul>
    740. 

  740. <li><a href="Modula3.html#features">Features</a>
    741. 

  741. <li><a href="Modula3.html#pragmas">Pragmas</a>
    742. 

  742. </ul>
    743. 

  743. <li><a href="Modula3.html#remarks">Remarks</a>
    744. 

  744. </ul>
    745. 

  745. </div>
    746. 

  746. <!-- INDEX -->
    747. 

  747. 

  748. <h3><a href="Mzscheme.html#Mzscheme">21 SWIG and MzScheme</a></h3>
    749. 

  749. 

  750. <!-- INDEX -->
    751. 

  751. <div class="sectiontoc">
    752. 

  752. <ul>
    753. 

  753. <li><a href="Mzscheme.html#MzScheme_nn2">Creating native MzScheme structures</a>
    754. 

  754. </ul>
    755. 

  755. </div>
    756. 

  756. <!-- INDEX -->
    757. 

  757. 

  758. <h3><a href="Ocaml.html#Ocaml">22 SWIG and Ocaml</a></h3>
    759. 

  759. 

  760. <!-- INDEX -->
    761. 

  761. <div class="sectiontoc">
    762. 

  762. <ul>
    763. 

  763. <li><a href="Ocaml.html#Ocaml_nn2">Preliminaries</a>
    764. 

  764. <ul>
    765. 

  765. <li><a href="Ocaml.html#Ocaml_nn3">Running SWIG</a>
    766. 

  766. <li><a href="Ocaml.html#Ocaml_nn4">Compiling the code</a>
    767. 

  767. <li><a href="Ocaml.html#Ocaml_nn5">The camlp4 module</a>
    768. 

  768. <li><a href="Ocaml.html#Ocaml_nn6">Using your module</a>
    769. 

  769. <li><a href="Ocaml.html#Ocaml_nn7">Compilation problems and compiling with C++</a>
    770. 

  770. </ul>
    771. 

  771. <li><a href="Ocaml.html#Ocaml_nn8">The low-level Ocaml/C interface</a>
    772. 

  772. <ul>
    773. 

  773. <li><a href="Ocaml.html#Ocaml_nn9">The generated module</a>
    774. 

  774. <li><a href="Ocaml.html#Ocaml_nn10">Enums</a>
    775. 

  775. <ul>
    776. 

  776. <li><a href="Ocaml.html#Ocaml_nn11">Enum typing in Ocaml</a>
    777. 

  777. </ul>
    778. 

  778. <li><a href="Ocaml.html#Ocaml_nn12">Arrays</a>
    779. 

  779. <ul>
    780. 

  780. <li><a href="Ocaml.html#Ocaml_nn13">Simple types of bounded arrays</a>
    781. 

  781. <li><a href="Ocaml.html#Ocaml_nn14">Complex and unbounded arrays</a>
    782. 

  782. <li><a href="Ocaml.html#Ocaml_nn15">Using an object</a>
    783. 

  783. <li><a href="Ocaml.html#Ocaml_nn16">Example typemap for a function taking float * and int</a>
    784. 

  784. </ul>
    785. 

  785. <li><a href="Ocaml.html#Ocaml_nn17">C++ Classes</a>
    786. 

  786. <ul>
    787. 

  787. <li><a href="Ocaml.html#Ocaml_nn18">STL vector and string Example</a>
    788. 

  788. <li><a href="Ocaml.html#Ocaml_nn19">C++ Class Example</a>
    789. 

  789. <li><a href="Ocaml.html#Ocaml_nn20">Compiling the example</a>
    790. 

  790. <li><a href="Ocaml.html#Ocaml_nn21">Sample Session</a>
    791. 

  791. </ul>
    792. 

  792. <li><a href="Ocaml.html#Ocaml_nn22">Director Classes</a>
    793. 

  793. <ul>
    794. 

  794. <li><a href="Ocaml.html#Ocaml_nn23">Director Introduction</a>
    795. 

  795. <li><a href="Ocaml.html#Ocaml_nn24">Overriding Methods in Ocaml</a>
    796. 

  796. <li><a href="Ocaml.html#Ocaml_nn25">Director Usage Example</a>
    797. 

  797. <li><a href="Ocaml.html#Ocaml_nn26">Creating director objects</a>
    798. 

  798. <li><a href="Ocaml.html#Ocaml_nn27">Typemaps for directors, <tt>directorin, directorout, directorargout</tt></a>
    799. 

  799. <li><a href="Ocaml.html#Ocaml_nn28"><tt>directorin</tt> typemap</a>
    800. 

  800. <li><a href="Ocaml.html#Ocaml_nn29"><tt>directorout</tt> typemap</a>
    801. 

  801. <li><a href="Ocaml.html#Ocaml_nn30"><tt>directorargout</tt> typemap</a>
    802. 

  802. </ul>
    803. 

  803. <li><a href="Ocaml.html#Ocaml_nn31">Exceptions</a>
    804. 

  804. </ul>
    805. 

  805. </ul>
    806. 

  806. </div>
    807. 

  807. <!-- INDEX -->
    808. 

  808. 

  809. <h3><a href="Perl5.html#Perl5">23 SWIG and Perl5</a></h3>
    810. 

  810. 

  811. <!-- INDEX -->
    812. 

  812. <div class="sectiontoc">
    813. 

  813. <ul>
    814. 

  814. <li><a href="Perl5.html#Perl5_nn2">Overview</a>
    815. 

  815. <li><a href="Perl5.html#Perl5_nn3">Preliminaries</a>
    816. 

  816. <ul>
    817. 

  817. <li><a href="Perl5.html#Perl5_nn4">Getting the right header files</a>
    818. 

  818. <li><a href="Perl5.html#Perl5_nn5">Compiling a dynamic module</a>
    819. 

  819. <li><a href="Perl5.html#Perl5_nn6">Building a dynamic module with MakeMaker</a>
    820. 

  820. <li><a href="Perl5.html#Perl5_nn7">Building a static version of Perl</a>
    821. 

  821. <li><a href="Perl5.html#Perl5_nn8">Using the module</a>
    822. 

  822. <li><a href="Perl5.html#Perl5_nn9">Compilation problems and compiling with C++</a>
    823. 

  823. <li><a href="Perl5.html#Perl5_nn10">Compiling for 64-bit platforms</a>
    824. 

  824. </ul>
    825. 

  825. <li><a href="Perl5.html#Perl5_nn11">Building Perl Extensions under Windows</a>
    826. 

  826. <ul>
    827. 

  827. <li><a href="Perl5.html#Perl5_nn12">Running SWIG from Developer Studio</a>
    828. 

  828. <li><a href="Perl5.html#Perl5_nn13">Using other compilers</a>
    829. 

  829. </ul>
    830. 

  830. <li><a href="Perl5.html#Perl5_nn14">The low-level interface</a>
    831. 

  831. <ul>
    832. 

  832. <li><a href="Perl5.html#Perl5_nn15">Functions</a>
    833. 

  833. <li><a href="Perl5.html#Perl5_nn16">Global variables</a>
    834. 

  834. <li><a href="Perl5.html#Perl5_nn17">Constants</a>
    835. 

  835. <li><a href="Perl5.html#Perl5_nn18">Pointers</a>
    836. 

  836. <li><a href="Perl5.html#Perl5_nn19">Structures</a>
    837. 

  837. <li><a href="Perl5.html#Perl5_nn20">C++ classes</a>
    838. 

  838. <li><a href="Perl5.html#Perl5_nn21">C++ classes and type-checking</a>
    839. 

  839. <li><a href="Perl5.html#Perl5_nn22">C++ overloaded functions</a>
    840. 

  840. <li><a href="Perl5.html#Perl5_nn23">Operators</a>
    841. 

  841. <li><a href="Perl5.html#Perl5_nn24">Modules and packages</a>
    842. 

  842. </ul>
    843. 

  843. <li><a href="Perl5.html#Perl5_nn25">Input and output parameters</a>
    844. 

  844. <li><a href="Perl5.html#Perl5_nn26">Exception handling </a>
    845. 

  845. <li><a href="Perl5.html#Perl5_nn27">Remapping datatypes with typemaps</a>
    846. 

  846. <ul>
    847. 

  847. <li><a href="Perl5.html#Perl5_nn28">A simple typemap example</a>
    848. 

  848. <li><a href="Perl5.html#Perl5_nn29">Perl5 typemaps</a>
    849. 

  849. <li><a href="Perl5.html#Perl5_nn30">Typemap variables</a>
    850. 

  850. <li><a href="Perl5.html#Perl5_nn31">Useful functions</a>
    851. 

  851. </ul>
    852. 

  852. <li><a href="Perl5.html#Perl5_nn32">Typemap Examples</a>
    853. 

  853. <ul>
    854. 

  854. <li><a href="Perl5.html#Perl5_nn33">Converting a Perl5 array to a char ** </a>
    855. 

  855. <li><a href="Perl5.html#Perl5_nn34">Return values </a>
    856. 

  856. <li><a href="Perl5.html#Perl5_nn35">Returning values from arguments</a>
    857. 

  857. <li><a href="Perl5.html#Perl5_nn36">Accessing array structure members</a>
    858. 

  858. <li><a href="Perl5.html#Perl5_nn37">Turning Perl references into C pointers</a>
    859. 

  859. <li><a href="Perl5.html#Perl5_nn38">Pointer handling</a>
    860. 

  860. </ul>
    861. 

  861. <li><a href="Perl5.html#Perl5_nn39">Proxy classes</a>
    862. 

  862. <ul>
    863. 

  863. <li><a href="Perl5.html#Perl5_nn40">Preliminaries</a>
    864. 

  864. <li><a href="Perl5.html#Perl5_nn41">Structure and class wrappers</a>
    865. 

  865. <li><a href="Perl5.html#Perl5_nn42">Object Ownership</a>
    866. 

  866. <li><a href="Perl5.html#Perl5_nn43">Nested Objects</a>
    867. 

  867. <li><a href="Perl5.html#Perl5_nn44">Proxy Functions</a>
    868. 

  868. <li><a href="Perl5.html#Perl5_nn45">Inheritance</a>
    869. 

  869. <li><a href="Perl5.html#Perl5_nn46">Modifying the proxy methods</a>
    870. 

  870. </ul>
    871. 

  871. </ul>
    872. 

  872. </div>
    873. 

  873. <!-- INDEX -->
    874. 

  874. 

  875. <h3><a href="Php.html#Php">24 SWIG and PHP4</a></h3>
    876. 

  876. 

  877. <!-- INDEX -->
    878. 

  878. <div class="sectiontoc">
    879. 

  879. <ul>
    880. 

  880. <li><a href="Php.html#Php_nn1">Generating PHP4 Extensions</a>
    881. 

  881. <ul>
    882. 

  882. <li><a href="Php.html#Php_nn1_1">Building a loadable extension</a>
    883. 

  883. <li><a href="Php.html#Php_nn1_2">Building extensions into PHP</a>
    884. 

  884. <li><a href="Php.html#Php_nn1_3">Using PHP4 Extensions</a>
    885. 

  885. </ul>
    886. 

  886. <li><a href="Php.html#Php_nn2">Basic PHP4 interface</a>
    887. 

  887. <ul>
    888. 

  888. <li><a href="Php.html#Php_nn2_1">Constants</a>
    889. 

  889. <li><a href="Php.html#Php_nn2_2">Global Variables</a>
    890. 

  890. <li><a href="Php.html#Php_nn2_3">Functions</a>
    891. 

  891. <li><a href="Php.html#Php_nn2_4">Overloading</a>
    892. 

  892. <li><a href="Php.html#Php_nn2_5">Pointers and References</a>
    893. 

  893. <li><a href="Php.html#Php_nn2_6">Structures and C++ classes</a>
    894. 

  894. <ul>
    895. 

  895. <li><a href="Php.html#Php_nn2_6_1">Using <tt>-noproxy</tt></a>
    896. 

  896. <li><a href="Php.html#Php_nn2_6_2">Constructors and Destructors</a>
    897. 

  897. <li><a href="Php.html#Php_nn2_6_3">Static Member Variables</a>
    898. 

  898. <li><a href="Php.html#Php_nn2_6_4">Static Member Functions</a>
    899. 

  899. </ul>
    900. 

  900. <li><a href="Php.html#Php_nn2_7">PHP4 Pragmas, Startup and Shutdown code</a>
    901. 

  901. </ul>
    902. 

  902. </ul>
    903. 

  903. </div>
    904. 

  904. <!-- INDEX -->
    905. 

  905. 

  906. <h3><a href="Pike.html#Pike">25 SWIG and Pike</a></h3>
    907. 

  907. 

  908. <!-- INDEX -->
    909. 

  909. <div class="sectiontoc">
    910. 

  910. <ul>
    911. 

  911. <li><a href="Pike.html#Pike_nn2">Preliminaries</a>
    912. 

  912. <ul>
    913. 

  913. <li><a href="Pike.html#Pike_nn3">Running SWIG</a>
    914. 

  914. <li><a href="Pike.html#Pike_nn4">Getting the right header files</a>
    915. 

  915. <li><a href="Pike.html#Pike_nn5">Using your module</a>
    916. 

  916. </ul>
    917. 

  917. <li><a href="Pike.html#Pike_nn6">Basic C/C++ Mapping</a>
    918. 

  918. <ul>
    919. 

  919. <li><a href="Pike.html#Pike_nn7">Modules</a>
    920. 

  920. <li><a href="Pike.html#Pike_nn8">Functions</a>
    921. 

  921. <li><a href="Pike.html#Pike_nn9">Global variables</a>
    922. 

  922. <li><a href="Pike.html#Pike_nn10">Constants and enumerated types</a>
    923. 

  923. <li><a href="Pike.html#Pike_nn11">Constructors and Destructors</a>
    924. 

  924. <li><a href="Pike.html#Pike_nn12">Static Members</a>
    925. 

  925. </ul>
    926. 

  926. </ul>
    927. 

  927. </div>
    928. 

  928. <!-- INDEX -->
    929. 

  929. 

  930. <h3><a href="Python.html#Python">26 SWIG and Python</a></h3>
    931. 

  931. 

  932. <!-- INDEX -->
    933. 

  933. <div class="sectiontoc">
    934. 

  934. <ul>
    935. 

  935. <li><a href="Python.html#Python_nn2">Overview</a>
    936. 

  936. <li><a href="Python.html#Python_nn3">Preliminaries</a>
    937. 

  937. <ul>
    938. 

  938. <li><a href="Python.html#Python_nn4">Running SWIG</a>
    939. 

  939. <li><a href="Python.html#Python_nn5">Getting the right header files</a>
    940. 

  940. <li><a href="Python.html#Python_nn6">Compiling a dynamic module</a>
    941. 

  941. <li><a href="Python.html#Python_nn7">Using distutils</a>
    942. 

  942. <li><a href="Python.html#Python_nn8">Static linking</a>
    943. 

  943. <li><a href="Python.html#Python_nn9">Using your module</a>
    944. 

  944. <li><a href="Python.html#Python_nn10">Compilation of C++ extensions</a>
    945. 

  945. <li><a href="Python.html#Python_nn11">Compiling for 64-bit platforms</a>
    946. 

  946. <li><a href="Python.html#Python_nn12">Building Python Extensions under Windows</a>
    947. 

  947. </ul>
    948. 

  948. <li><a href="Python.html#Python_nn13">A tour of basic C/C++ wrapping</a>
    949. 

  949. <ul>
    950. 

  950. <li><a href="Python.html#Python_nn14">Modules</a>
    951. 

  951. <li><a href="Python.html#Python_nn15">Functions</a>
    952. 

  952. <li><a href="Python.html#Python_nn16">Global variables</a>
    953. 

  953. <li><a href="Python.html#Python_nn17">Constants and enums</a>
    954. 

  954. <li><a href="Python.html#Python_nn18">Pointers</a>
    955. 

  955. <li><a href="Python.html#Python_nn19">Structures</a>
    956. 

  956. <li><a href="Python.html#Python_nn20">C++ classes</a>
    957. 

  957. <li><a href="Python.html#Python_nn21">C++ inheritance</a>
    958. 

  958. <li><a href="Python.html#Python_nn22">Pointers, references, values, and arrays</a>
    959. 

  959. <li><a href="Python.html#Python_nn23">C++ overloaded functions</a>
    960. 

  960. <li><a href="Python.html#Python_nn24">C++ operators</a>
    961. 

  961. <li><a href="Python.html#Python_nn25">C++ namespaces</a>
    962. 

  962. <li><a href="Python.html#Python_nn26">C++ templates</a>
    963. 

  963. <li><a href="Python.html#Python_nn27">C++ Smart Pointers</a>
    964. 

  964. <li><a href="Python.html#Python_nn27a">C++ Reference Counted Objects (ref/unref)</a>
    965. 

  965. </ul>
    966. 

  966. <li><a href="Python.html#Python_nn28">Further details on the Python class interface</a>
    967. 

  967. <ul>
    968. 

  968. <li><a href="Python.html#Python_nn29">Proxy classes</a>
    969. 

  969. <li><a href="Python.html#Python_nn30">Memory management</a>
    970. 

  970. <li><a href="Python.html#Python_nn31">Python 2.2 and classic classes</a>
    971. 

  971. </ul>
    972. 

  972. <li><a href="Python.html#directors">Cross language polymorphism</a>
    973. 

  973. <ul>
    974. 

  974. <li><a href="Python.html#Python_nn33">Enabling directors</a>
    975. 

  975. <li><a href="Python.html#Python_nn34">Director classes</a>
    976. 

  976. <li><a href="Python.html#Python_nn35">Ownership and object destruction</a>
    977. 

  977. <li><a href="Python.html#Python_nn36">Exception unrolling</a>
    978. 

  978. <li><a href="Python.html#Python_nn37">Overhead and code bloat</a>
    979. 

  979. <li><a href="Python.html#Python_nn38">Typemaps</a>
    980. 

  980. <li><a href="Python.html#Python_nn39">Miscellaneous</a>
    981. 

  981. </ul>
    982. 

  982. <li><a href="Python.html#Python_nn40">Common customization features</a>
    983. 

  983. <ul>
    984. 

  984. <li><a href="Python.html#Python_nn41">C/C++ helper functions</a>
    985. 

  985. <li><a href="Python.html#Python_nn42">Adding additional Python code</a>
    986. 

  986. <li><a href="Python.html#Python_nn43">Class extension with %extend</a>
    987. 

  987. <li><a href="Python.html#Python_nn44">Exception handling with %exception</a>
    988. 

  988. </ul>
    989. 

  989. <li><a href="Python.html#Python_nn45">Tips and techniques</a>
    990. 

  990. <ul>
    991. 

  991. <li><a href="Python.html#Python_nn46">Input and output parameters</a>
    992. 

  992. <li><a href="Python.html#Python_nn47">Simple pointers</a>
    993. 

  993. <li><a href="Python.html#Python_nn48">Unbounded C Arrays</a>
    994. 

  994. <li><a href="Python.html#Python_nn49">String handling</a>
    995. 

  995. <li><a href="Python.html#Python_nn50">Arrays</a>
    996. 

  996. <li><a href="Python.html#Python_nn51">String arrays</a>
    997. 

  997. <li><a href="Python.html#Python_nn52">STL wrappers</a>
    998. 

  998. </ul>
    999. 

  999. <li><a href="Python.html#Python_nn53">Typemaps</a>
    1000. 

  1000. <ul>
    1001. 

  1001. <li><a href="Python.html#Python_nn54">What is a typemap?</a>
    1002. 

  1002. <li><a href="Python.html#Python_nn55">Python typemaps</a>
    1003. 

  1003. <li><a href="Python.html#Python_nn56">Typemap variables</a>
    1004. 

  1004. <li><a href="Python.html#Python_nn57">Useful Python Functions</a>
    1005. 

  1005. </ul>
    1006. 

  1006. <li><a href="Python.html#Python_nn58">Typemap Examples</a>
    1007. 

  1007. <ul>
    1008. 

  1008. <li><a href="Python.html#Python_nn59">Converting  Python list to a char ** </a>
    1009. 

  1009. <li><a href="Python.html#Python_nn60">Expanding a Python object into multiple arguments</a>
    1010. 

  1010. <li><a href="Python.html#Python_nn61">Using typemaps to return arguments</a>
    1011. 

  1011. <li><a href="Python.html#Python_nn62">Mapping Python tuples into small arrays</a>
    1012. 

  1012. <li><a href="Python.html#Python_nn63">Mapping sequences to C arrays</a>
    1013. 

  1013. <li><a href="Python.html#Python_nn64">Pointer handling</a>
    1014. 

  1014. </ul>
    1015. 

  1015. <li><a href="Python.html#Python_nn65">Docstring Features</a>
    1016. 

  1016. <ul>
    1017. 

  1017. <li><a href="Python.html#Python_nn66">Module docstring</a>
    1018. 

  1018. <li><a href="Python.html#Python_nn67">%feature("autodoc")</a>
    1019. 

  1019. <ul>
    1020. 

  1020. <li><a href="Python.html#Python_nn68">%feature("autodoc", "0")</a>
    1021. 

  1021. <li><a href="Python.html#Python_nn69">%feature("autodoc", "1")</a>
    1022. 

  1022. <li><a href="Python.html#Python_nn70">%feature("autodoc", "docstring")</a>
    1023. 

  1023. </ul>
    1024. 

  1024. <li><a href="Python.html#Python_nn71">%feature("docstring")</a>
    1025. 

  1025. </ul>
    1026. 

  1026. <li><a href="Python.html#Python_nn72">Python Packages</a>
    1027. 

  1027. </ul>
    1028. 

  1028. </div>
    1029. 

  1029. <!-- INDEX -->
    1030. 

  1030. 

  1031. <h3><a href="Ruby.html#Ruby">27 SWIG and Ruby</a></h3>
    1032. 

  1032. 

  1033. <!-- INDEX -->
    1034. 

  1034. <div class="sectiontoc">
    1035. 

  1035. <ul>
    1036. 

  1036. <li><a href="Ruby.html#Ruby_nn2">Preliminaries</a>
    1037. 

  1037. <ul>
    1038. 

  1038. <li><a href="Ruby.html#Ruby_nn3">Running SWIG</a>
    1039. 

  1039. <li><a href="Ruby.html#Ruby_nn4">Getting the right header files</a>
    1040. 

  1040. <li><a href="Ruby.html#Ruby_nn5">Compiling a dynamic module</a>
    1041. 

  1041. <li><a href="Ruby.html#Ruby_nn6">Using your module</a>
    1042. 

  1042. <li><a href="Ruby.html#Ruby_nn7">Static linking</a>
    1043. 

  1043. <li><a href="Ruby.html#Ruby_nn8">Compilation of C++ extensions</a>
    1044. 

  1044. </ul>
    1045. 

  1045. <li><a href="Ruby.html#Ruby_nn9">Building Ruby Extensions under Windows 95/NT</a>
    1046. 

  1046. <ul>
    1047. 

  1047. <li><a href="Ruby.html#Ruby_nn10">Running SWIG from Developer Studio</a>
    1048. 

  1048. </ul>
    1049. 

  1049. <li><a href="Ruby.html#Ruby_nn11">The Ruby-to-C/C++ Mapping</a>
    1050. 

  1050. <ul>
    1051. 

  1051. <li><a href="Ruby.html#Ruby_nn12">Modules</a>
    1052. 

  1052. <li><a href="Ruby.html#Ruby_nn13">Functions</a>
    1053. 

  1053. <li><a href="Ruby.html#Ruby_nn14">Variable Linking</a>
    1054. 

  1054. <li><a href="Ruby.html#Ruby_nn15">Constants</a>
    1055. 

  1055. <li><a href="Ruby.html#Ruby_nn16">Pointers</a>
    1056. 

  1056. <li><a href="Ruby.html#Ruby_nn17">Structures</a>
    1057. 

  1057. <li><a href="Ruby.html#Ruby_nn18">C++ classes</a>
    1058. 

  1058. <li><a href="Ruby.html#Ruby_nn19">C++ Inheritance</a>
    1059. 

  1059. <li><a href="Ruby.html#Ruby_nn20">C++ Overloaded Functions</a>
    1060. 

  1060. <li><a href="Ruby.html#Ruby_nn21">C++ Operators</a>
    1061. 

  1061. <li><a href="Ruby.html#Ruby_nn22">C++ namespaces</a>
    1062. 

  1062. <li><a href="Ruby.html#Ruby_nn23">C++ templates</a>
    1063. 

  1063. <li><a href="Ruby.html#ruby_cpp_smart_pointers">C++ Smart Pointers</a>
    1064. 

  1064. <li><a href="Ruby.html#Ruby_nn25">Cross-Language Polymorphism</a>
    1065. 

  1065. <ul>
    1066. 

  1066. <li><a href="Ruby.html#Ruby_nn26">Exception Unrolling</a>
    1067. 

  1067. </ul>
    1068. 

  1068. </ul>
    1069. 

  1069. <li><a href="Ruby.html#Ruby_nn27">Input and output parameters</a>
    1070. 

  1070. <li><a href="Ruby.html#Ruby_nn29">Typemaps</a>
    1071. 

  1071. <ul>
    1072. 

  1072. <li><a href="Ruby.html#Ruby_nn30">What is a typemap?</a>
    1073. 

  1073. <li><a href="Ruby.html#Ruby_nn31">Ruby typemaps</a>
    1074. 

  1074. <li><a href="Ruby.html#Ruby_nn32">Typemap variables</a>
    1075. 

  1075. <li><a href="Ruby.html#Ruby_nn33">Useful Functions</a>
    1076. 

  1076. <ul>
    1077. 

  1077. <li><a href="Ruby.html#Ruby_nn34">C Datatypes to Ruby Objects</a>
    1078. 

  1078. <li><a href="Ruby.html#Ruby_nn35">Ruby Objects to C Datatypes</a>
    1079. 

  1079. <li><a href="Ruby.html#Ruby_nn36">Macros for VALUE</a>
    1080. 

  1080. <li><a href="Ruby.html#Ruby_nn37">Exceptions</a>
    1081. 

  1081. <li><a href="Ruby.html#Ruby_nn38">Iterators</a>
    1082. 

  1082. </ul>
    1083. 

  1083. <li><a href="Ruby.html#ruby_typemap_examples">Typemap Examples</a>
    1084. 

  1084. <li><a href="Ruby.html#Ruby_nn40">Converting a Ruby array to a char **</a>
    1085. 

  1085. <li><a href="Ruby.html#Ruby_nn41">Collecting arguments in a hash</a>
    1086. 

  1086. <li><a href="Ruby.html#Ruby_nn42">Pointer handling</a>
    1087. 

  1087. <ul>
    1088. 

  1088. <li><a href="Ruby.html#Ruby_nn43">Ruby Datatype Wrapping</a>
    1089. 

  1089. </ul>
    1090. 

  1090. </ul>
    1091. 

  1091. <li><a href="Ruby.html#ruby_operator_overloading">Operator overloading</a>
    1092. 

  1092. <ul>
    1093. 

  1093. <li><a href="Ruby.html#Ruby_nn45">Example: STL Vector to Ruby Array</a>
    1094. 

  1094. </ul>
    1095. 

  1095. <li><a href="Ruby.html#Ruby_nn46">Advanced Topics</a>
    1096. 

  1096. <ul>
    1097. 

  1097. <li><a href="Ruby.html#Ruby_nn47">Creating Multi-Module Packages</a>
    1098. 

  1098. <li><a href="Ruby.html#Ruby_nn48">Defining Aliases</a>
    1099. 

  1099. <li><a href="Ruby.html#Ruby_nn49">Predicate Methods</a>
    1100. 

  1100. <li><a href="Ruby.html#Ruby_nn50">Specifying Mixin Modules</a>
    1101. 

  1101. </ul>
    1102. 

  1102. <li><a href="Ruby.html#Ruby_nn51">Memory Management</a>
    1103. 

  1103. <ul>
    1104. 

  1104. <li><a href="Ruby.html#Ruby_nn53">Object Ownership</a>
    1105. 

  1105. <li><a href="Ruby.html#Ruby_nn54">Object Tracking</a>
    1106. 

  1106. <li><a href="Ruby.html#Ruby_nn55">Mark Functions</a>
    1107. 

  1107. <li><a href="Ruby.html#Ruby_nn56">Free Functions</a>
    1108. 

  1108. </ul>
    1109. 

  1109. </ul>
    1110. 

  1110. </div>
    1111. 

  1111. <!-- INDEX -->
    1112. 

  1112. 

  1113. <h3><a href="Tcl.html#Tcl">28 SWIG and Tcl</a></h3>
    1114. 

  1114. 

  1115. <!-- INDEX -->
    1116. 

  1116. <div class="sectiontoc">
    1117. 

  1117. <ul>
    1118. 

  1118. <li><a href="Tcl.html#Tcl_nn2">Preliminaries</a>
    1119. 

  1119. <ul>
    1120. 

  1120. <li><a href="Tcl.html#Tcl_nn3">Getting the right header files</a>
    1121. 

  1121. <li><a href="Tcl.html#Tcl_nn4">Compiling a dynamic module</a>
    1122. 

  1122. <li><a href="Tcl.html#Tcl_nn5">Static linking</a>
    1123. 

  1123. <li><a href="Tcl.html#Tcl_nn6">Using your module</a>
    1124. 

  1124. <li><a href="Tcl.html#Tcl_nn7">Compilation of C++ extensions</a>
    1125. 

  1125. <li><a href="Tcl.html#Tcl_nn8">Compiling for 64-bit platforms</a>
    1126. 

  1126. <li><a href="Tcl.html#Tcl_nn9">Setting a package prefix</a>
    1127. 

  1127. <li><a href="Tcl.html#Tcl_nn10">Using namespaces</a>
    1128. 

  1128. </ul>
    1129. 

  1129. <li><a href="Tcl.html#Tcl_nn11">Building Tcl/Tk Extensions under Windows 95/NT</a>
    1130. 

  1130. <ul>
    1131. 

  1131. <li><a href="Tcl.html#Tcl_nn12">Running SWIG from Developer Studio</a>
    1132. 

  1132. <li><a href="Tcl.html#Tcl_nn13">Using NMAKE</a>
    1133. 

  1133. </ul>
    1134. 

  1134. <li><a href="Tcl.html#Tcl_nn14">A tour of basic C/C++ wrapping</a>
    1135. 

  1135. <ul>
    1136. 

  1136. <li><a href="Tcl.html#Tcl_nn15">Modules</a>
    1137. 

  1137. <li><a href="Tcl.html#Tcl_nn16">Functions</a>
    1138. 

  1138. <li><a href="Tcl.html#Tcl_nn17">Global variables</a>
    1139. 

  1139. <li><a href="Tcl.html#Tcl_nn18">Constants and enums</a>
    1140. 

  1140. <li><a href="Tcl.html#Tcl_nn19">Pointers</a>
    1141. 

  1141. <li><a href="Tcl.html#Tcl_nn20">Structures</a>
    1142. 

  1142. <li><a href="Tcl.html#Tcl_nn21">C++ classes</a>
    1143. 

  1143. <li><a href="Tcl.html#Tcl_nn22">C++ inheritance</a>
    1144. 

  1144. <li><a href="Tcl.html#Tcl_nn23">Pointers, references, values, and arrays</a>
    1145. 

  1145. <li><a href=…
    1146.