Doc/Manual/Contents.html

   1
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   3 <HTML>
   4 <HEAD>
   5 <TITLE>SWIG Users Manual</TITLE>
   6 </HEAD>
   7 <BODY BGCOLOR="#ffffff">
   8 <H1>SWIG Users Manual</H1>
   9
  10 <p>
  11
  12 <h3><a href="Preface.html#Preface">1 Preface</a></h3>
  13
  14 <!-- INDEX -->
  15 <div class="sectiontoc">
  16 <ul>
  17 <li><a href="Preface.html#Preface_nn2">Introduction</a>
  18 <li><a href="Preface.html#Preface_nn3">Special Introduction for Version 1.3</a>
  19 <li><a href="Preface.html#Preface_nn4">SWIG Versions</a>
  20 <li><a href="Preface.html#Preface_nn5">SWIG resources</a>
  21 <li><a href="Preface.html#Preface_nn6">Prerequisites</a>
  22 <li><a href="Preface.html#Preface_nn7">Organization of this manual</a>
  23 <li><a href="Preface.html#Preface_nn8">How to avoid reading the manual</a>
  24 <li><a href="Preface.html#Preface_nn9">Backwards Compatibility</a>
  25 <li><a href="Preface.html#Preface_nn10">Credits</a>
  26 <li><a href="Preface.html#Preface_nn11">Bug reports</a>
  27 </ul>
  28 </div>
  29 <!-- INDEX -->
  30
  31 <h3><a href="Introduction.html#Introduction">2 Introduction</a></h3>
  32
  33 <!-- INDEX -->
  34 <div class="sectiontoc">
  35 <ul>
  36 <li><a href="Introduction.html#Introduction_nn2">What is SWIG?</a>
  37 <li><a href="Introduction.html#Introduction_nn3">Why use SWIG?</a>
  38 <li><a href="Introduction.html#Introduction_nn4">A SWIG example</a>
  39 <ul>
  40 <li><a href="Introduction.html#Introduction_nn5">SWIG interface file</a>
  41 <li><a href="Introduction.html#Introduction_nn6">The swig command</a>
  42 <li><a href="Introduction.html#Introduction_nn7">Building a Perl5 module</a>
  43 <li><a href="Introduction.html#Introduction_nn8">Building a Python module</a>
  44 <li><a href="Introduction.html#Introduction_nn9">Shortcuts</a>
  45 </ul>
  46 <li><a href="Introduction.html#Introduction_nn10">Supported C/C++ language features</a>
  47 <li><a href="Introduction.html#Introduction_nn11">Non-intrusive interface building</a>
  48 <li><a href="Introduction.html#Introduction_build_system">Incorporating SWIG into a build system</a>
  49 <li><a href="Introduction.html#Introduction_nn12">Hands off code generation</a>
  50 <li><a href="Introduction.html#Introduction_nn13">SWIG and freedom</a>
  51 </ul>
  52 </div>
  53 <!-- INDEX -->
  54
  55 <h3><a href="Windows.html#Windows">3 Getting started on Windows </a></h3>
  56
  57 <!-- INDEX -->
  58 <div class="sectiontoc">
  59 <ul>
  60 <li><a href="Windows.html#Windows_installation">Installation on Windows</a>
  61 <ul>
  62 <li><a href="Windows.html#Windows_executable">Windows Executable</a>
  63 </ul>
  64 <li><a href="Windows.html#Windows_examples">SWIG Windows Examples</a>
  65 <ul>
  66 <li><a href="Windows.html#Windows_visual_studio">Instructions for using the Examples with Visual Studio</a>
  67 <ul>
  68 <li><a href="Windows.html#Windows_csharp">C#</a>
  69 <li><a href="Windows.html#Windows_java">Java</a>
  70 <li><a href="Windows.html#Windows_perl">Perl</a>
  71 <li><a href="Windows.html#Windows_python">Python</a>
  72 <li><a href="Windows.html#Windows_tcl">TCL</a>
  73 <li><a href="Windows.html#Windows_r">R</a>
  74 <li><a href="Windows.html#Windows_ruby">Ruby</a>
  75 </ul>
  76 <li><a href="Windows.html#Windows_other_compilers">Instructions for using the Examples with other compilers</a>
  77 </ul>
  78 <li><a href="Windows.html#Windows_cygwin_mingw">SWIG on Cygwin and MinGW</a>
  79 <ul>
  80 <li><a href="Windows.html#Windows_swig_exe">Building swig.exe on Windows</a>
  81 <ul>
  82 <li><a href="Windows.html#Windows_mingw_msys">Building swig.exe using MinGW and MSYS</a>
  83 <li><a href="Windows.html#Windows_cygwin">Building swig.exe using Cygwin</a>
  84 <li><a href="Windows.html#Windows_building_alternatives">Building swig.exe alternatives</a>
  85 </ul>
  86 <li><a href="Windows.html#Windows_examples_cygwin">Running the examples on Windows using Cygwin</a>
  87 </ul>
  88 <li><a href="Windows.html#Windows_interface_file">Microsoft extensions and other Windows quirks</a>
  89 </ul>
  90 </div>
  91 <!-- INDEX -->
  92
  93 <h3><a href="Scripting.html#Scripting">4 Scripting Languages</a></h3>
  94
  95 <!-- INDEX -->
  96 <div class="sectiontoc">
  97 <ul>
  98 <li><a href="Scripting.html#Scripting_nn2">The two language view of the world</a>
  99 <li><a href="Scripting.html#Scripting_nn3">How does a scripting language talk to C?</a>
 100 <ul>
 101 <li><a href="Scripting.html#Scripting_nn4">Wrapper functions</a>
 102 <li><a href="Scripting.html#Scripting_nn5">Variable linking</a>
 103 <li><a href="Scripting.html#Scripting_nn6">Constants</a>
 104 <li><a href="Scripting.html#Scripting_nn7">Structures and classes</a>
 105 <li><a href="Scripting.html#Scripting_nn8">Proxy classes</a>
 106 </ul>
 107 <li><a href="Scripting.html#Scripting_nn9">Building scripting language extensions</a>
 108 <ul>
 109 <li><a href="Scripting.html#Scripting_nn10">Shared libraries and dynamic loading</a>
 110 <li><a href="Scripting.html#Scripting_nn11">Linking with shared libraries</a>
 111 <li><a href="Scripting.html#Scripting_nn12">Static linking</a>
 112 </ul>
 113 </ul>
 114 </div>
 115 <!-- INDEX -->
 116
 117 <h3><a href="SWIG.html#SWIG">5 SWIG Basics</a></h3>
 118
 119 <!-- INDEX -->
 120 <div class="sectiontoc">
 121 <ul>
 122 <li><a href="SWIG.html#SWIG_nn2">Running SWIG</a>
 123 <ul>
 124 <li><a href="SWIG.html#SWIG_nn3">Input format</a>
 125 <li><a href="SWIG.html#output">SWIG Output</a>
 126 <li><a href="SWIG.html#SWIG_nn5">Comments</a>
 127 <li><a href="SWIG.html#SWIG_nn6">C Preprocessor</a>
 128 <li><a href="SWIG.html#SWIG_nn7">SWIG Directives</a>
 129 <li><a href="SWIG.html#SWIG_nn8">Parser Limitations</a>
 130 </ul>
 131 <li><a href="SWIG.html#SWIG_nn9">Wrapping Simple C Declarations</a>
 132 <ul>
 133 <li><a href="SWIG.html#SWIG_nn10">Basic Type Handling</a>
 134 <li><a href="SWIG.html#SWIG_nn11">Global Variables</a>
 135 <li><a href="SWIG.html#SWIG_nn12">Constants</a>
 136 <li><a href="SWIG.html#SWIG_nn13">A brief word about <tt>const</tt></a>
 137 <li><a href="SWIG.html#SWIG_nn14">A cautionary tale of <tt>char *</tt></a>
 138 </ul>
 139 <li><a href="SWIG.html#SWIG_nn15">Pointers and complex objects</a>
 140 <ul>
 141 <li><a href="SWIG.html#SWIG_nn16">Simple pointers</a>
 142 <li><a href="SWIG.html#SWIG_nn17">Run time pointer type checking</a>
 143 <li><a href="SWIG.html#SWIG_nn18">Derived types, structs, and classes</a>
 144 <li><a href="SWIG.html#SWIG_nn19">Undefined datatypes</a>
 145 <li><a href="SWIG.html#SWIG_nn20">Typedef</a>
 146 </ul>
 147 <li><a href="SWIG.html#SWIG_nn21">Other Practicalities</a>
 148 <ul>
 149 <li><a href="SWIG.html#SWIG_nn22">Passing structures by value</a>
 150 <li><a href="SWIG.html#SWIG_nn23">Return by value</a>
 151 <li><a href="SWIG.html#SWIG_nn24">Linking to structure variables</a>
 152 <li><a href="SWIG.html#SWIG_nn25">Linking to <tt>char *</tt></a>
 153 <li><a href="SWIG.html#SWIG_nn26">Arrays</a>
 154 <li><a href="SWIG.html#SWIG_readonly_variables">Creating read-only variables</a>
 155 <li><a href="SWIG.html#SWIG_rename_ignore">Renaming and ignoring declarations</a>
 156 <li><a href="SWIG.html#SWIG_default_args">Default/optional arguments</a>
 157 <li><a href="SWIG.html#SWIG_nn30">Pointers to functions and callbacks</a>
 158 </ul>
 159 <li><a href="SWIG.html#SWIG_nn31">Structures and unions</a>
 160 <ul>
 161 <li><a href="SWIG.html#SWIG_nn32">Typedef and structures</a>
 162 <li><a href="SWIG.html#SWIG_nn33">Character strings and structures</a>
 163 <li><a href="SWIG.html#SWIG_nn34">Array members</a>
 164 <li><a href="SWIG.html#SWIG_structure_data_members">Structure data members</a>
 165 <li><a href="SWIG.html#SWIG_nn36">C constructors and destructors</a>
 166 <li><a href="SWIG.html#SWIG_adding_member_functions">Adding member functions to C structures</a>
 167 <li><a href="SWIG.html#SWIG_nested_structs">Nested structures</a>
 168 <li><a href="SWIG.html#SWIG_nn39">Other things to note about structure wrapping</a>
 169 </ul>
 170 <li><a href="SWIG.html#SWIG_nn40">Code Insertion</a>
 171 <ul>
 172 <li><a href="SWIG.html#SWIG_nn41">The output of SWIG</a>
 173 <li><a href="SWIG.html#SWIG_nn42">Code insertion blocks</a>
 174 <li><a href="SWIG.html#SWIG_nn43">Inlined code blocks</a>
 175 <li><a href="SWIG.html#SWIG_nn44">Initialization blocks</a>
 176 </ul>
 177 <li><a href="SWIG.html#SWIG_nn45">An Interface Building Strategy</a>
 178 <ul>
 179 <li><a href="SWIG.html#SWIG_nn46">Preparing a C program for SWIG</a>
 180 <li><a href="SWIG.html#SWIG_nn47">The SWIG interface file</a>
 181 <li><a href="SWIG.html#SWIG_nn48">Why use separate interface files?</a>
 182 <li><a href="SWIG.html#SWIG_nn49">Getting the right header files</a>
 183 <li><a href="SWIG.html#SWIG_nn50">What to do with main()</a>
 184 </ul>
 185 </ul>
 186 </div>
 187 <!-- INDEX -->
 188
 189 <h3><a href="SWIGPlus.html#SWIGPlus">6 SWIG and C++</a></h3>
 190
 191 <!-- INDEX -->
 192 <div class="sectiontoc">
 193 <ul>
 194 <li><a href="SWIGPlus.html#SWIGPlus_nn2">Comments on C++ Wrapping</a>
 195 <li><a href="SWIGPlus.html#SWIGPlus_nn3">Approach</a>
 196 <li><a href="SWIGPlus.html#SWIGPlus_nn4">Supported C++ features</a>
 197 <li><a href="SWIGPlus.html#SWIGPlus_nn5">Command line options and compilation</a>
 198 <li><a href="SWIGPlus.html#SWIGPlus_nn38">Proxy classes</a>
 199 <ul>
 200 <li><a href="SWIGPlus.html#SWIGPlus_nn39">Construction of proxy classes</a>
 201 <li><a href="SWIGPlus.html#SWIGPlus_nn40">Resource management in proxies</a>
 202 <li><a href="SWIGPlus.html#SWIGPlus_nn41">Language specific details</a>
 203 </ul>
 204 <li><a href="SWIGPlus.html#SWIGPlus_nn6">Simple C++ wrapping</a>
 205 <ul>
 206 <li><a href="SWIGPlus.html#SWIGPlus_nn7">Constructors and destructors</a>
 207 <li><a href="SWIGPlus.html#SWIGPlus_nn8">Default constructors, copy constructors and implicit destructors</a>
 208 <li><a href="SWIGPlus.html#SWIGPlus_nn9">When constructor wrappers aren't created</a>
 209 <li><a href="SWIGPlus.html#SWIGPlus_nn10">Copy constructors</a>
 210 <li><a href="SWIGPlus.html#SWIGPlus_nn11">Member functions</a>
 211 <li><a href="SWIGPlus.html#SWIGPlus_nn12">Static members</a>
 212 <li><a href="SWIGPlus.html#SWIGPlus_member_data">Member data</a>
 213 </ul>
 214 <li><a href="SWIGPlus.html#SWIGPlus_default_args">Default arguments</a>
 215 <li><a href="SWIGPlus.html#SWIGPlus_nn15">Protection</a>
 216 <li><a href="SWIGPlus.html#SWIGPlus_nn16">Enums and constants</a>
 217 <li><a href="SWIGPlus.html#SWIGPlus_nn17">Friends</a>
 218 <li><a href="SWIGPlus.html#SWIGPlus_nn18">References and pointers</a>
 219 <li><a href="SWIGPlus.html#SWIGPlus_nn19">Pass and return by value</a>
 220 <li><a href="SWIGPlus.html#SWIGPlus_nn20">Inheritance</a>
 221 <li><a href="SWIGPlus.html#SWIGPlus_nn21">A brief discussion of multiple inheritance, pointers,  and type checking</a>
 222 <li><a href="SWIGPlus.html#SWIGPlus_overloaded_methods">Wrapping Overloaded Functions and Methods</a>
 223 <ul>
 224 <li><a href="SWIGPlus.html#SWIGPlus_nn24">Dispatch function generation</a>
 225 <li><a href="SWIGPlus.html#SWIGPlus_nn25">Ambiguity in Overloading</a>
 226 <li><a href="SWIGPlus.html#ambiguity_resolution_renaming">Ambiguity resolution and renaming</a>
 227 <li><a href="SWIGPlus.html#SWIGPlus_nn27">Comments on overloading</a>
 228 </ul>
 229 <li><a href="SWIGPlus.html#SWIGPlus_nn28">Wrapping overloaded operators</a>
 230 <li><a href="SWIGPlus.html#SWIGPlus_class_extension">Class extension</a>
 231 <li><a href="SWIGPlus.html#SWIGPlus_nn30">Templates</a>
 232 <li><a href="SWIGPlus.html#SWIGPlus_nn31">Namespaces</a>
 233 <li><a href="SWIGPlus.html#SWIGPlus_renaming_templated_types_namespaces">Renaming templated types in namespaces</a>
 234 <li><a href="SWIGPlus.html#SWIGPlus_exception_specifications">Exception specifications</a>
 235 <li><a href="SWIGPlus.html#SWIGPlus_catches">Exception handling with %catches</a>
 236 <li><a href="SWIGPlus.html#SWIGPlus_nn33">Pointers to Members</a>
 237 <li><a href="SWIGPlus.html#SWIGPlus_nn34">Smart pointers and operator-&gt;()</a>
 238 <li><a href="SWIGPlus.html#SWIGPlus_nn35">Using declarations and inheritance</a>
 239 <li><a href="SWIGPlus.html#SWIGPlus_nested_classes">Nested classes</a>
 240 <li><a href="SWIGPlus.html#SWIGPlus_nn37">A brief rant about const-correctness</a>
 241 <li><a href="SWIGPlus.html#SWIGPlus_nn42">Where to go for more information</a>
 242 </ul>
 243 </div>
 244 <!-- INDEX -->
 245
 246 <h3><a href="Preprocessor.html#Preprocessor">7 Preprocessing</a></h3>
 247
 248 <!-- INDEX -->
 249 <div class="sectiontoc">
 250 <ul>
 251 <li><a href="Preprocessor.html#Preprocessor_nn2">File inclusion</a>
 252 <li><a href="Preprocessor.html#Preprocessor_nn3">File imports</a>
 253 <li><a href="Preprocessor.html#Preprocessor_condition_compilation">Conditional Compilation</a>
 254 <li><a href="Preprocessor.html#Preprocessor_nn5">Macro Expansion</a>
 255 <li><a href="Preprocessor.html#Preprocessor_nn6">SWIG Macros</a>
 256 <li><a href="Preprocessor.html#Preprocessor_nn7">C99 and GNU Extensions</a>
 257 <li><a href="Preprocessor.html#Preprocessor_nn8">Preprocessing and %{ ... %} &amp; " ... " delimiters</a>
 258 <li><a href="Preprocessor.html#Preprocessor_nn9">Preprocessing and { ... } delimiters</a>
 259 <li><a href="Preprocessor.html#Preprocessor_typemap_delimiters">Preprocessor and Typemaps</a>
 260 <li><a href="Preprocessor.html#Preprocessor_nn10">Viewing preprocessor output</a>
 261 <li><a href="Preprocessor.html#Preprocessor_warning_error">The #error and #warning directives</a>
 262 </ul>
 263 </div>
 264 <!-- INDEX -->
 265
 266 <h3><a href="Library.html#Library">8 SWIG library</a></h3>
 267
 268 <!-- INDEX -->
 269 <div class="sectiontoc">
 270 <ul>
 271 <li><a href="Library.html#Library_nn2">The %include directive and library search path</a>
 272 <li><a href="Library.html#Library_nn3">C Arrays and Pointers</a>
 273 <ul>
 274 <li><a href="Library.html#Library_nn4">cpointer.i</a>
 275 <li><a href="Library.html#Library_carrays">carrays.i</a>
 276 <li><a href="Library.html#Library_nn6">cmalloc.i</a>
 277 <li><a href="Library.html#Library_nn7">cdata.i</a>
 278 </ul>
 279 <li><a href="Library.html#Library_nn8">C String Handling</a>
 280 <ul>
 281 <li><a href="Library.html#Library_nn9">Default string handling</a>
 282 <li><a href="Library.html#Library_nn10">Passing binary data</a>
 283 <li><a href="Library.html#Library_nn11">Using %newobject to release memory</a>
 284 <li><a href="Library.html#Library_nn12">cstring.i</a>
 285 </ul>
 286 <li><a href="Library.html#Library_stl_cpp_library">STL/C++ Library</a>
 287 <ul>
 288 <li><a href="Library.html#Library_nn14">std_string.i</a>
 289 <li><a href="Library.html#Library_nn15">std_vector.i</a>
 290 <li><a href="Library.html#Library_stl_exceptions">STL exceptions</a>
 291 </ul>
 292 <li><a href="Library.html#Library_nn16">Utility Libraries</a>
 293 <ul>
 294 <li><a href="Library.html#Library_nn17">exception.i</a>
 295 </ul>
 296 </ul>
 297 </div>
 298 <!-- INDEX -->
 299
 300 <h3><a href="Arguments.html#Arguments">9 Argument Handling</a></h3>
 301
 302 <!-- INDEX -->
 303 <div class="sectiontoc">
 304 <ul>
 305 <li><a href="Arguments.html#Arguments_nn2">The typemaps.i library</a>
 306 <ul>
 307 <li><a href="Arguments.html#Arguments_nn3">Introduction</a>
 308 <li><a href="Arguments.html#Arguments_nn4">Input parameters</a>
 309 <li><a href="Arguments.html#Arguments_nn5">Output parameters</a>
 310 <li><a href="Arguments.html#Arguments_nn6">Input/Output parameters</a>
 311 <li><a href="Arguments.html#Arguments_nn7">Using different names</a>
 312 </ul>
 313 <li><a href="Arguments.html#Arguments_nn8">Applying constraints to input values</a>
 314 <ul>
 315 <li><a href="Arguments.html#Arguments_nn9">Simple constraint example</a>
 316 <li><a href="Arguments.html#Arguments_nn10">Constraint methods</a>
 317 <li><a href="Arguments.html#Arguments_nn11">Applying constraints to new datatypes</a>
 318 </ul>
 319 </ul>
 320 </div>
 321 <!-- INDEX -->
 322
 323 <h3><a href="Typemaps.html#Typemaps">10 Typemaps</a></h3>
 324
 325 <!-- INDEX -->
 326 <div class="sectiontoc">
 327 <ul>
 328 <li><a href="Typemaps.html#Typemaps_nn2">Introduction</a>
 329 <ul>
 330 <li><a href="Typemaps.html#Typemaps_nn3">Type conversion</a>
 331 <li><a href="Typemaps.html#Typemaps_nn4">Typemaps</a>
 332 <li><a href="Typemaps.html#Typemaps_nn5">Pattern matching</a>
 333 <li><a href="Typemaps.html#Typemaps_nn6">Reusing typemaps</a>
 334 <li><a href="Typemaps.html#Typemaps_nn7">What can be done with typemaps?</a>
 335 <li><a href="Typemaps.html#Typemaps_nn8">What can't be done with typemaps?</a>
 336 <li><a href="Typemaps.html#Typemaps_nn9">The rest of this chapter</a>
 337 </ul>
 338 <li><a href="Typemaps.html#Typemaps_nn10">Typemap specifications</a>
 339 <ul>
 340 <li><a href="Typemaps.html#Typemaps_defining">Defining a typemap</a>
 341 <li><a href="Typemaps.html#Typemaps_nn12">Typemap scope</a>
 342 <li><a href="Typemaps.html#Typemaps_nn13">Copying a typemap</a>
 343 <li><a href="Typemaps.html#Typemaps_nn14">Deleting a typemap</a>
 344 <li><a href="Typemaps.html#Typemaps_nn15">Placement of typemaps</a>
 345 </ul>
 346 <li><a href="Typemaps.html#Typemaps_pattern_matching">Pattern matching rules</a>
 347 <ul>
 348 <li><a href="Typemaps.html#Typemaps_nn17">Basic matching rules</a>
 349 <li><a href="Typemaps.html#Typemaps_nn18">Typedef reductions</a>
 350 <li><a href="Typemaps.html#Typemaps_nn19">Default typemaps</a>
 351 <li><a href="Typemaps.html#Typemaps_mixed_default">Mixed default typemaps</a>
 352 <li><a href="Typemaps.html#Typemaps_nn20">Multi-arguments typemaps</a>
 353 </ul>
 354 <li><a href="Typemaps.html#Typemaps_nn21">Code generation rules</a>
 355 <ul>
 356 <li><a href="Typemaps.html#Typemaps_nn22">Scope</a>
 357 <li><a href="Typemaps.html#Typemaps_nn23">Declaring new local variables</a>
 358 <li><a href="Typemaps.html#Typemaps_special_variables">Special variables</a>
 359 <li><a href="Typemaps.html#Typemaps_special_variable_macros">Special variable macros</a>
 360 <ul>
 361 <li><a href="Typemaps.html#Typemaps_special_macro_descriptor">$descriptor(type)</a>
 362 <li><a href="Typemaps.html#Typemaps_special_macro_typemap">$typemap(method, typepattern)</a>
 363 </ul>
 364 </ul>
 365 <li><a href="Typemaps.html#Typemaps_nn25">Common typemap methods</a>
 366 <ul>
 367 <li><a href="Typemaps.html#Typemaps_nn26">"in" typemap</a>
 368 <li><a href="Typemaps.html#Typemaps_nn27">"typecheck" typemap</a>
 369 <li><a href="Typemaps.html#Typemaps_nn28">"out" typemap</a>
 370 <li><a href="Typemaps.html#Typemaps_nn29">"arginit" typemap</a>
 371 <li><a href="Typemaps.html#Typemaps_nn30">"default" typemap</a>
 372 <li><a href="Typemaps.html#Typemaps_nn31">"check" typemap</a>
 373 <li><a href="Typemaps.html#Typemaps_nn32">"argout" typemap</a>
 374 <li><a href="Typemaps.html#Typemaps_nn33">"freearg" typemap</a>
 375 <li><a href="Typemaps.html#Typemaps_nn34">"newfree" typemap</a>
 376 <li><a href="Typemaps.html#Typemaps_nn35">"memberin" typemap</a>
 377 <li><a href="Typemaps.html#Typemaps_nn36">"varin" typemap</a>
 378 <li><a href="Typemaps.html#Typemaps_nn37">"varout" typemap</a>
 379 <li><a href="Typemaps.html#throws_typemap">"throws" typemap</a>
 380 </ul>
 381 <li><a href="Typemaps.html#Typemaps_nn39">Some typemap examples</a>
 382 <ul>
 383 <li><a href="Typemaps.html#Typemaps_nn40">Typemaps for arrays</a>
 384 <li><a href="Typemaps.html#Typemaps_nn41">Implementing constraints with typemaps</a>
 385 </ul>
 386 <li><a href="Typemaps.html#Typemaps_nn43">Typemaps for multiple languages</a>
 387 <li><a href="Typemaps.html#Typemaps_optimal">Optimal code generation when returning by value</a>
 388 <li><a href="Typemaps.html#Typemaps_multi_argument_typemaps">Multi-argument typemaps</a>
 389 <li><a href="Typemaps.html#runtime_type_checker">The run-time type checker</a>
 390 <ul>
 391 <li><a href="Typemaps.html#Typemaps_nn45">Implementation</a>
 392 <li><a href="Typemaps.html#Typemaps_runtime_type_checker_usage">Usage</a>
 393 </ul>
 394 <li><a href="Typemaps.html#Typemaps_overloading">Typemaps and overloading</a>
 395 <li><a href="Typemaps.html#Typemaps_nn48">More about <tt>%apply</tt> and <tt>%clear</tt></a>
 396 <li><a href="Typemaps.html#Typemaps_nn49">Reducing wrapper code size</a>
 397 <li><a href="Typemaps.html#Typemaps_nn47">Passing data between typemaps</a>
 398 <li><a href="Typemaps.html#Typemaps_nn52">C++ "this" pointer</a>
 399 <li><a href="Typemaps.html#Typemaps_nn51">Where to go for more information?</a>
 400 </ul>
 401 </div>
 402 <!-- INDEX -->
 403
 404 <h3><a href="Customization.html#Customization">11 Customization Features</a></h3>
 405
 406 <!-- INDEX -->
 407 <div class="sectiontoc">
 408 <ul>
 409 <li><a href="Customization.html#exception">Exception handling with %exception</a>
 410 <ul>
 411 <li><a href="Customization.html#Customization_nn3">Handling exceptions in C code</a>
 412 <li><a href="Customization.html#Customization_nn4">Exception handling with longjmp()</a>
 413 <li><a href="Customization.html#Customization_nn5">Handling C++ exceptions</a>
 414 <li><a href="Customization.html#Customization_allowexcept">Exception handlers for variables</a>
 415 <li><a href="Customization.html#Customization_nn6">Defining different exception handlers</a>
 416 <li><a href="Customization.html#Customization_exception_special_variables">Special variables for %exception</a>
 417 <li><a href="Customization.html#Customization_nn7">Using The SWIG exception library</a>
 418 </ul>
 419 <li><a href="Customization.html#ownership">Object ownership and %newobject</a>
 420 <li><a href="Customization.html#features">Features and the %feature directive</a>
 421 <ul>
 422 <li><a href="Customization.html#Customization_feature_attributes">Feature attributes</a>
 423 <li><a href="Customization.html#Customization_feature_flags">Feature flags</a>
 424 <li><a href="Customization.html#Customization_clearing_features">Clearing features</a>
 425 <li><a href="Customization.html#Customization_features_default_args">Features and default arguments</a>
 426 <li><a href="Customization.html#features_example">Feature example</a>
 427 </ul>
 428 </ul>
 429 </div>
 430 <!-- INDEX -->
 431
 432 <h3><a href="Contract.html#Contract">12 Contracts</a></h3>
 433
 434 <!-- INDEX -->
 435 <div class="sectiontoc">
 436 <ul>
 437 <li><a href="Contract.html#Contract_nn2">The %contract directive</a>
 438 <li><a href="Contract.html#Contract_nn3">%contract and classes</a>
 439 <li><a href="Contract.html#Contract_nn4">Constant aggregation and %aggregate_check</a>
 440 <li><a href="Contract.html#Contract_nn5">Notes</a>
 441 </ul>
 442 </div>
 443 <!-- INDEX -->
 444
 445 <h3><a href="Varargs.html#Varargs">13 Variable Length Arguments</a></h3>
 446
 447 <!-- INDEX -->
 448 <div class="sectiontoc">
 449 <ul>
 450 <li><a href="Varargs.html#Varargs_nn2">Introduction</a>
 451 <li><a href="Varargs.html#Varargs_nn3">The Problem</a>
 452 <li><a href="Varargs.html#Varargs_nn4">Default varargs support</a>
 453 <li><a href="Varargs.html#Varargs_nn5">Argument replacement using %varargs</a>
 454 <li><a href="Varargs.html#Varargs_nn6">Varargs and typemaps</a>
 455 <li><a href="Varargs.html#Varargs_nn7">Varargs wrapping with libffi</a>
 456 <li><a href="Varargs.html#Varargs_nn8">Wrapping of va_list</a>
 457 <li><a href="Varargs.html#Varargs_nn9">C++ Issues</a>
 458 <li><a href="Varargs.html#Varargs_nn10">Discussion</a>
 459 </ul>
 460 </div>
 461 <!-- INDEX -->
 462
 463 <h3><a href="Warnings.html#Warnings">14 Warning Messages</a></h3>
 464
 465 <!-- INDEX -->
 466 <div class="sectiontoc">
 467 <ul>
 468 <li><a href="Warnings.html#Warnings_nn2">Introduction</a>
 469 <li><a href="Warnings.html#Warnings_suppression">Warning message suppression</a>
 470 <li><a href="Warnings.html#Warnings_nn4">Enabling extra warnings</a>
 471 <li><a href="Warnings.html#Warnings_nn5">Issuing a warning message</a>
 472 <li><a href="Warnings.html#Warnings_symbolic_symbols">Symbolic symbols</a>
 473 <li><a href="Warnings.html#Warnings_nn6">Commentary</a>
 474 <li><a href="Warnings.html#Warnings_nn7">Warnings as errors</a>
 475 <li><a href="Warnings.html#Warnings_nn8">Message output format</a>
 476 <li><a href="Warnings.html#Warnings_nn9">Warning number reference</a>
 477 <ul>
 478 <li><a href="Warnings.html#Warnings_nn10">Deprecated features (100-199)</a>
 479 <li><a href="Warnings.html#Warnings_nn11">Preprocessor (200-299)</a>
 480 <li><a href="Warnings.html#Warnings_nn12">C/C++ Parser (300-399)</a>
 481 <li><a href="Warnings.html#Warnings_nn13">Types and typemaps (400-499) </a>
 482 <li><a href="Warnings.html#Warnings_nn14">Code generation (500-599)</a>
 483 <li><a href="Warnings.html#Warnings_nn15">Language module specific (800-899) </a>
 484 <li><a href="Warnings.html#Warnings_nn16">User defined (900-999)</a>
 485 </ul>
 486 <li><a href="Warnings.html#Warnings_nn17">History</a>
 487 </ul>
 488 </div>
 489 <!-- INDEX -->
 490
 491 <h3><a href="Modules.html#Modules">15 Working with Modules</a></h3>
 492
 493 <!-- INDEX -->
 494 <div class="sectiontoc">
 495 <ul>
 496 <li><a href="Modules.html#Modules_introduction">Modules Introduction</a>
 497 <li><a href="Modules.html#Modules_nn1">Basics</a>
 498 <li><a href="Modules.html#Modules_nn2">The SWIG runtime code</a>
 499 <li><a href="Modules.html#external_run_time">External access to the runtime</a>
 500 <li><a href="Modules.html#Modules_nn4">A word of caution about static libraries</a>
 501 <li><a href="Modules.html#Modules_nn5">References</a>
 502 <li><a href="Modules.html#Modules_nn6">Reducing the wrapper file size</a>
 503 </ul>
 504 </div>
 505 <!-- INDEX -->
 506
 507 <h3><a href="CCache.html#CCache">16 Using SWIG with ccache - ccache-swig(1) manpage</a></h3>
 508
 509 <!-- INDEX -->
 510 <div class="sectiontoc">
 511 <ul>
 512 <li><a href="CCache.html#CCache_nn2">NAME</a>
 513 <li><a href="CCache.html#CCache_nn3">SYNOPSIS</a>
 514 <li><a href="CCache.html#CCache_nn4">DESCRIPTION</a>
 515 <li><a href="CCache.html#CCache_nn5">OPTIONS SUMMARY</a>
 516 <li><a href="CCache.html#CCache_nn6">OPTIONS</a>
 517 <li><a href="CCache.html#CCache_nn7">INSTALLATION</a>
 518 <li><a href="CCache.html#CCache_nn8">EXTRA OPTIONS</a>
 519 <li><a href="CCache.html#CCache_nn9">ENVIRONMENT VARIABLES</a>
 520 <li><a href="CCache.html#CCache_nn10">CACHE SIZE MANAGEMENT</a>
 521 <li><a href="CCache.html#CCache_nn11">CACHE COMPRESSION</a>
 522 <li><a href="CCache.html#CCache_nn12">HOW IT WORKS</a>
 523 <li><a href="CCache.html#CCache_nn13">USING CCACHE WITH DISTCC</a>
 524 <li><a href="CCache.html#CCache_nn14">SHARING A CACHE</a>
 525 <li><a href="CCache.html#CCache_nn15">HISTORY</a>
 526 <li><a href="CCache.html#CCache_nn16">DIFFERENCES FROM COMPILERCACHE</a>
 527 <li><a href="CCache.html#CCache_nn17">CREDITS</a>
 528 <li><a href="CCache.html#CCache_nn18">AUTHOR</a>
 529 </ul>
 530 </div>
 531 <!-- INDEX -->
 532
 533 <h3><a href="Allegrocl.html#Allegrocl">17 SWIG and Allegro Common Lisp</a></h3>
 534
 535 <!-- INDEX -->
 536 <div class="sectiontoc">
 537 <ul>
 538 <li><a href="Allegrocl.html#Allegrocl_nn2">Basics</a>
 539 <ul>
 540 <li><a href="Allegrocl.html#Allegrocl_nn3">Running Swig</a>
 541 <li><a href="Allegrocl.html#Allegrocl_nn4">Command Line Options</a>
 542 <li><a href="Allegrocl.html#Allegrocl_nn5">Inserting user code into generated files</a>
 543 </ul>
 544 <li><a href="Allegrocl.html#Allegrocl_nn6">Wrapping Overview</a>
 545 <ul>
 546 <li><a href="Allegrocl.html#Allegrocl_nn7">Function Wrapping</a>
 547 <li><a href="Allegrocl.html#Allegrocl_nn8">Foreign Wrappers</a>
 548 <li><a href="Allegrocl.html#Allegrocl_nn9">FFI Wrappers</a>
 549 <li><a href="Allegrocl.html#Allegrocl_nn10">Non-overloaded Defuns</a>
 550 <li><a href="Allegrocl.html#Allegrocl_nn11">Overloaded Defuns</a>
 551 <li><a href="Allegrocl.html#Allegrocl_nn12">What about constant and variable access?</a>
 552 <li><a href="Allegrocl.html#Allegrocl_nn13">Object Wrapping</a>
 553 </ul>
 554 <li><a href="Allegrocl.html#Allegrocl_nn14">Wrapping Details</a>
 555 <ul>
 556 <li><a href="Allegrocl.html#Allegrocl_nn15">Namespaces</a>
 557 <li><a href="Allegrocl.html#Allegrocl_nn16">Constants</a>
 558 <li><a href="Allegrocl.html#Allegrocl_nn17">Variables</a>
 559 <li><a href="Allegrocl.html#Allegrocl_nn18">Enumerations</a>
 560 <li><a href="Allegrocl.html#Allegrocl_nn19">Arrays</a>
 561 <li><a href="Allegrocl.html#Allegrocl_nn20">Classes and Structs and Unions (oh my!)</a>
 562 <ul>
 563 <li><a href="Allegrocl.html#Allegrocl_nn21">CLOS wrapping of</a>
 564 <li><a href="Allegrocl.html#Allegrocl_nn22">CLOS Inheritance</a>
 565 <li><a href="Allegrocl.html#Allegrocl_nn23">Member fields and functions</a>
 566 <li><a href="Allegrocl.html#Allegrocl_nn24">Why not directly access C++ classes using foreign types?</a>
 567 </ul>
 568 <li><a href="Allegrocl.html#Allegrocl_nn25">Templates</a>
 569 <ul>
 570 <li><a href="Allegrocl.html#Allegrocl_nn26">Generating wrapper code for templates</a>
 571 <li><a href="Allegrocl.html#Allegrocl_nn27">Implicit Template instantiation</a>
 572 </ul>
 573 <li><a href="Allegrocl.html#Allegrocl_nn28">Typedef, Templates, and Synonym Types</a>
 574 <ul>
 575 <li><a href="Allegrocl.html#Allegrocl_nn29">Choosing a primary type</a>
 576 </ul>
 577 <li><a href="Allegrocl.html#Allegrocl_nn30">Function overloading/Parameter defaulting</a>
 578 <li><a href="Allegrocl.html#Allegrocl_nn31">Operator wrapping and Operator overloading</a>
 579 <li><a href="Allegrocl.html#Allegrocl_nn32">Varargs</a>
 580 <li><a href="Allegrocl.html#Allegrocl_nn33">C++ Exceptions</a>
 581 <li><a href="Allegrocl.html#Allegrocl_nn34">Pass by value, pass by reference</a>
 582 </ul>
 583 <li><a href="Allegrocl.html#Allegrocl_nn35">Typemaps</a>
 584 <ul>
 585 <li><a href="Allegrocl.html#Allegrocl_nn36">Code Generation in the C++ Wrapper</a>
 586 <ul>
 587 <li><a href="Allegrocl.html#Allegrocl_nn37">IN Typemap</a>
 588 <li><a href="Allegrocl.html#Allegrocl_nn38">OUT Typemap</a>
 589 <li><a href="Allegrocl.html#Allegrocl_nn39">CTYPE Typemap</a>
 590 </ul>
 591 <li><a href="Allegrocl.html#Allegrocl_nn40">Code generation in Lisp wrappers</a>
 592 <ul>
 593 <li><a href="Allegrocl.html#Allegrocl_nn41">LIN Typemap</a>
 594 <li><a href="Allegrocl.html#Allegrocl_nn42">LOUT Typemap</a>
 595 <li><a href="Allegrocl.html#Allegrocl_nn43">FFITYPE Typemap</a>
 596 <li><a href="Allegrocl.html#Allegrocl_nn44">LISPTYPE Typemap</a>
 597 <li><a href="Allegrocl.html#Allegrocl_nn45">LISPCLASS Typemap</a>
 598 </ul>
 599 <li><a href="Allegrocl.html#Allegrocl_nn46">Modifying SWIG behavior using typemaps</a>
 600 </ul>
 601 <li><a href="Allegrocl.html#Allegrocl_nn47">Identifier Converter functions</a>
 602 <ul>
 603 <li><a href="Allegrocl.html#Allegrocl_nn48">Creating symbols in the lisp environment</a>
 604 <li><a href="Allegrocl.html#Allegrocl_nn49">Existing identifier-converter functions</a>
 605 <ul>
 606 <li><a href="Allegrocl.html#Allegrocl_nn50">identifier-convert-null</a>
 607 <li><a href="Allegrocl.html#Allegrocl_nn51">identifier-convert-lispify</a>
 608 <li><a href="Allegrocl.html#Allegrocl_nn52">Default identifier to symbol conversions</a>
 609 </ul>
 610 <li><a href="Allegrocl.html#Allegrocl_nn53">Defining your own identifier-converter</a>
 611 <li><a href="Allegrocl.html#Allegrocl_nn54">Instructing SWIG to use a particular identifier-converter</a>
 612 </ul>
 613 </ul>
 614 </div>
 615 <!-- INDEX -->
 616
 617 <h3><a href="CSharp.html#CSharp">18 SWIG and C#</a></h3>
 618
 619 <!-- INDEX -->
 620 <div class="sectiontoc">
 621 <ul>
 622 <li><a href="CSharp.html#csharp_introduction">Introduction</a>
 623 <li><a href="CSharp.html#csharp_differences_java">Differences to the Java module</a>
 624 <li><a href="CSharp.html#CSharp_arrays">C# Arrays</a>
 625 <ul>
 626 <li><a href="CSharp.html#CSharp_arrays_swig_library">The SWIG C arrays library</a>
 627 <li><a href="CSharp.html#CSharp_arrays_pinvoke_default_array_marshalling">Managed arrays using P/Invoke default array marshalling</a>
 628 <li><a href="CSharp.html#CSharp_arrays_pinning">Managed arrays using pinning</a>
 629 </ul>
 630 <li><a href="CSharp.html#csharp_exceptions">C# Exceptions</a>
 631 <ul>
 632 <li><a href="CSharp.html#csharp_exception_example_check_typemap">C# exception example using "check" typemap</a>
 633 <li><a href="CSharp.html#csharp_exception_example_percent_exception">C# exception example using %exception</a>
 634 <li><a href="CSharp.html#csharp_exception_example_exception_specifications">C# exception example using exception specifications</a>
 635 <li><a href="CSharp.html#csharp_custom_application_exception">Custom C# ApplicationException example</a>
 636 </ul>
 637 <li><a href="CSharp.html#csharp_directors">C# Directors</a>
 638 <ul>
 639 <li><a href="CSharp.html#csharp_directors_example">Directors example</a>
 640 <li><a href="CSharp.html#csharp_directors_implementation">Directors implementation</a>
 641 <li><a href="CSharp.html#csharp_director_caveats">Director caveats</a>
 642 </ul>
 643 <li><a href="CSharp.html#csharp_typemap_examples">C# Typemap examples</a>
 644 <ul>
 645 <li><a href="CSharp.html#csharp_memory_management_member_variables">Memory management when returning references to member variables</a>
 646 <li><a href="CSharp.html#csharp_memory_management_objects">Memory management for objects passed to the C++ layer</a>
 647 <li><a href="CSharp.html#csharp_date_marshalling">Date marshalling using the csin typemap and associated attributes</a>
 648 <li><a href="CSharp.html#csharp_date_properties">A date example demonstrating marshalling of C# properties</a>
 649 <li><a href="CSharp.html#csharp_partial_classes">Turning wrapped classes into partial classes</a>
 650 <li><a href="CSharp.html#csharp_extending_proxy_class">Extending proxy classes with additional C# code</a>
 651 </ul>
 652 </ul>
 653 </div>
 654 <!-- INDEX -->
 655
 656 <h3><a href="Chicken.html#Chicken">19 SWIG and Chicken</a></h3>
 657
 658 <!-- INDEX -->
 659 <div class="sectiontoc">
 660 <ul>
 661 <li><a href="Chicken.html#Chicken_nn2">Preliminaries</a>
 662 <ul>
 663 <li><a href="Chicken.html#Chicken_nn3">Running SWIG in C mode</a>
 664 <li><a href="Chicken.html#Chicken_nn4">Running SWIG in C++ mode</a>
 665 </ul>
 666 <li><a href="Chicken.html#Chicken_nn5">Code Generation</a>
 667 <ul>
 668 <li><a href="Chicken.html#Chicken_nn6">Naming Conventions</a>
 669 <li><a href="Chicken.html#Chicken_nn7">Modules</a>
 670 <li><a href="Chicken.html#Chicken_nn8">Constants and Variables</a>
 671 <li><a href="Chicken.html#Chicken_nn9">Functions</a>
 672 <li><a href="Chicken.html#Chicken_nn10">Exceptions</a>
 673 </ul>
 674 <li><a href="Chicken.html#Chicken_nn11">TinyCLOS</a>
 675 <li><a href="Chicken.html#Chicken_nn12">Linkage</a>
 676 <ul>
 677 <li><a href="Chicken.html#Chicken_nn13">Static binary or shared library linked at compile time</a>
 678 <li><a href="Chicken.html#Chicken_nn14">Building chicken extension libraries</a>
 679 <li><a href="Chicken.html#Chicken_nn15">Linking multiple SWIG modules with TinyCLOS</a>
 680 </ul>
 681 <li><a href="Chicken.html#Chicken_nn16">Typemaps</a>
 682 <li><a href="Chicken.html#Chicken_nn17">Pointers</a>
 683 <ul>
 684 <li><a href="Chicken.html#collection">Garbage collection</a>
 685 </ul>
 686 <li><a href="Chicken.html#Chicken_nn18">Unsupported features and known problems</a>
 687 <ul>
 688 <li><a href="Chicken.html#Chicken_nn19">TinyCLOS problems with Chicken version &lt;= 1.92</a>
 689 </ul>
 690 </ul>
 691 </div>
 692 <!-- INDEX -->
 693
 694 <h3><a href="Guile.html#Guile">20 SWIG and Guile</a></h3>
 695
 696 <!-- INDEX -->
 697 <div class="sectiontoc">
 698 <ul>
 699 <li><a href="Guile.html#Guile_nn2">Meaning of "Module"</a>
 700 <li><a href="Guile.html#Guile_nn3">Using the SCM or GH Guile API</a>
 701 <li><a href="Guile.html#Guile_nn4">Linkage</a>
 702 <ul>
 703 <li><a href="Guile.html#Guile_nn5">Simple Linkage</a>
 704 <li><a href="Guile.html#Guile_nn6">Passive Linkage</a>
 705 <li><a href="Guile.html#Guile_nn7">Native Guile Module Linkage</a>
 706 <li><a href="Guile.html#Guile_nn8">Old Auto-Loading Guile Module Linkage</a>
 707 <li><a href="Guile.html#Guile_nn9">Hobbit4D Linkage</a>
 708 </ul>
 709 <li><a href="Guile.html#Guile_nn10">Underscore Folding</a>
 710 <li><a href="Guile.html#Guile_nn11">Typemaps</a>
 711 <li><a href="Guile.html#Guile_nn12">Representation of pointers as smobs</a>
 712 <ul>
 713 <li><a href="Guile.html#Guile_nn13">GH Smobs</a>
 714 <li><a href="Guile.html#Guile_nn14">SCM Smobs</a>
 715 <li><a href="Guile.html#Guile_nn15">Garbage Collection</a>
 716 </ul>
 717 <li><a href="Guile.html#Guile_nn16">Exception Handling</a>
 718 <li><a href="Guile.html#Guile_nn17">Procedure documentation</a>
 719 <li><a href="Guile.html#Guile_nn18">Procedures with setters</a>
 720 <li><a href="Guile.html#Guile_nn19">GOOPS Proxy Classes</a>
 721 <ul>
 722 <li><a href="Guile.html#Guile_nn20">Naming Issues</a>
 723 <li><a href="Guile.html#Guile_nn21">Linking</a>
 724 </ul>
 725 </ul>
 726 </div>
 727 <!-- INDEX -->
 728
 729 <h3><a href="Java.html#Java">21 SWIG and Java</a></h3>
 730
 731 <!-- INDEX -->
 732 <div class="sectiontoc">
 733 <ul>
 734 <li><a href="Java.html#java_overview">Overview</a>
 735 <li><a href="Java.html#java_preliminaries">Preliminaries</a>
 736 <ul>
 737 <li><a href="Java.html#running_swig">Running SWIG</a>
 738 <li><a href="Java.html#java_commandline">Additional Commandline Options</a>
 739 <li><a href="Java.html#getting_right_headers">Getting the right header files</a>
 740 <li><a href="Java.html#compiling_dynamic">Compiling a dynamic module</a>
 741 <li><a href="Java.html#using_module">Using your module</a>
 742 <li><a href="Java.html#dynamic_linking_problems">Dynamic linking problems</a>
 743 <li><a href="Java.html#compilation_problems_cpp">Compilation problems and compiling with C++</a>
 744 <li><a href="Java.html#building_windows">Building on Windows</a>
 745 <ul>
 746 <li><a href="Java.html#visual_studio">Running SWIG from Visual Studio</a>
 747 <li><a href="Java.html#nmake">Using NMAKE</a>
 748 </ul>
 749 </ul>
 750 <li><a href="Java.html#java_basic_tour">A tour of basic C/C++ wrapping</a>
 751 <ul>
 752 <li><a href="Java.html#module_packages_classes">Modules, packages and generated Java classes</a>
 753 <li><a href="Java.html#functions">Functions</a>
 754 <li><a href="Java.html#global_variables">Global variables</a>
 755 <li><a href="Java.html#constants">Constants</a>
 756 <li><a href="Java.html#enumerations">Enumerations</a>
 757 <ul>
 758 <li><a href="Java.html#anonymous_enums">Anonymous enums</a>
 759 <li><a href="Java.html#typesafe_enums">Typesafe enums</a>
 760 <li><a href="Java.html#proper_enums">Proper Java enums</a>
 761 <li><a href="Java.html#typeunsafe_enums">Type unsafe enums</a>
 762 <li><a href="Java.html#simple_enums">Simple enums</a>
 763 </ul>
 764 <li><a href="Java.html#pointers">Pointers</a>
 765 <li><a href="Java.html#structures">Structures</a>
 766 <li><a href="Java.html#classes">C++ classes</a>
 767 <li><a href="Java.html#inheritance">C++ inheritance</a>
 768 <li><a href="Java.html#pointers_refs_arrays">Pointers, references, arrays and pass by value</a>
 769 <ul>
 770 <li><a href="Java.html#null_pointers">Null pointers</a>
 771 </ul>
 772 <li><a href="Java.html#overloaded_functions">C++ overloaded functions</a>
 773 <li><a href="Java.html#java_default_arguments">C++ default arguments</a>
 774 <li><a href="Java.html#namespaces">C++ namespaces</a>
 775 <li><a href="Java.html#templates">C++ templates</a>
 776 <li><a href="Java.html#smart_pointers">C++ Smart Pointers</a>
 777 </ul>
 778 <li><a href="Java.html#further_details">Further details on the generated Java classes</a>
 779 <ul>
 780 <li><a href="Java.html#imclass">The intermediary JNI class</a>
 781 <ul>
 782 <li><a href="Java.html#imclass_pragmas">The intermediary JNI class pragmas</a>
 783 </ul>
 784 <li><a href="Java.html#java_module_class">The Java module class</a>
 785 <ul>
 786 <li><a href="Java.html#module_class_pragmas">The Java module class pragmas</a>
 787 </ul>
 788 <li><a href="Java.html#java_proxy_classes">Java proxy classes</a>
 789 <ul>
 790 <li><a href="Java.html#memory_management">Memory management</a>
 791 <li><a href="Java.html#inheritance_mirroring">Inheritance</a>
 792 <li><a href="Java.html#proxy_classes_gc">Proxy classes and garbage collection</a>
 793 <li><a href="Java.html#java_pgcpp">The premature garbage collection prevention parameter for proxy class marshalling</a>
 794 <li><a href="Java.html#java_multithread_libraries">Single threaded applications and thread safety</a>
 795 </ul>
 796 <li><a href="Java.html#type_wrapper_classes">Type wrapper classes</a>
 797 <li><a href="Java.html#enum_classes">Enum classes</a>
 798 <ul>
 799 <li><a href="Java.html#typesafe_enums_classes">Typesafe enum classes</a>
 800 <li><a href="Java.html#proper_enums_classes">Proper Java enum classes</a>
 801 <li><a href="Java.html#typeunsafe_enums_classes">Type unsafe enum classes</a>
 802 </ul>
 803 </ul>
 804 <li><a href="Java.html#java_directors">Cross language polymorphism using directors</a>
 805 <ul>
 806 <li><a href="Java.html#java_enabling_directors">Enabling directors</a>
 807 <li><a href="Java.html#java_directors_classes">Director classes</a>
 808 <li><a href="Java.html#java_directors_overhead">Overhead and code bloat</a>
 809 <li><a href="Java.html#java_directors_example">Simple directors example</a>
 810 <li><a href="Java.html#java_directors_threading">Director threading issues</a>
 811 </ul>
 812 <li><a href="Java.html#java_allprotected">Accessing protected members</a>
 813 <li><a href="Java.html#common_customization">Common customization features</a>
 814 <ul>
 815 <li><a href="Java.html#helper_functions">C/C++ helper functions</a>
 816 <li><a href="Java.html#class_extension">Class extension with %extend</a>
 817 <li><a href="Java.html#exception_handling">Exception handling with %exception and %javaexception</a>
 818 <li><a href="Java.html#method_access">Method access with %javamethodmodifiers</a>
 819 </ul>
 820 <li><a href="Java.html#tips_techniques">Tips and techniques</a>
 821 <ul>
 822 <li><a href="Java.html#input_output_parameters">Input and output parameters using primitive pointers and references</a>
 823 <li><a href="Java.html#simple_pointers">Simple pointers</a>
 824 <li><a href="Java.html#c_arrays">Wrapping C arrays with Java arrays</a>
 825 <li><a href="Java.html#unbounded_c_arrays">Unbounded C Arrays</a>
 826 <li><a href="Java.html#java_heap_allocations">Overriding new and delete to allocate from Java heap</a>
 827 </ul>
 828 <li><a href="Java.html#java_typemaps">Java typemaps</a>
 829 <ul>
 830 <li><a href="Java.html#default_primitive_type_mappings">Default primitive type mappings</a>
 831 <li><a href="Java.html#Java_default_non_primitive_typemaps">Default typemaps for non-primitive types</a>
 832 <li><a href="Java.html#jvm64">Sixty four bit JVMs</a>
 833 <li><a href="Java.html#what_is_typemap">What is a typemap?</a>
 834 <li><a href="Java.html#typemaps_c_to_java_types">Typemaps for mapping C/C++ types to Java types</a>
 835 <li><a href="Java.html#typemap_attributes">Java typemap attributes</a>
 836 <li><a href="Java.html#special_variables">Java special variables</a>
 837 <li><a href="Java.html#typemaps_for_c_and_cpp">Typemaps for both C and C++ compilation</a>
 838 <li><a href="Java.html#java_code_typemaps">Java code typemaps</a>
 839 <li><a href="Java.html#java_directors_typemaps">Director specific typemaps</a>
 840 </ul>
 841 <li><a href="Java.html#typemap_examples">Typemap Examples</a>
 842 <ul>
 843 <li><a href="Java.html#simpler_enum_classes">Simpler Java enums for enums without initializers</a>
 844 <li><a href="Java.html#exception_typemap">Handling C++ exception specifications as Java exceptions</a>
 845 <li><a href="Java.html#nan_exception_typemap">NaN Exception - exception handling for a particular type</a>
 846 <li><a href="Java.html#converting_java_string_arrays">Converting Java String arrays to char ** </a>
 847 <li><a href="Java.html#expanding_java_object">Expanding a Java object to multiple arguments</a>
 848 <li><a href="Java.html#using_typemaps_return_arguments">Using typemaps to return arguments</a>
 849 <li><a href="Java.html#adding_downcasts">Adding Java downcasts to polymorphic return types</a>
 850 <li><a href="Java.html#adding_equals_method">Adding an equals method to the Java classes</a>
 851 <li><a href="Java.html#void_pointers">Void pointers and a common Java base class</a>
 852 <li><a href="Java.html#struct_pointer_pointer">Struct pointer to pointer</a>
 853 <li><a href="Java.html#java_memory_management_member_variables">Memory management when returning references to member variables</a>
 854 <li><a href="Java.html#java_memory_management_objects">Memory management for objects passed to the C++ layer</a>
 855 <li><a href="Java.html#java_date_marshalling">Date marshalling using the javain typemap and associated attributes</a>
 856 </ul>
 857 <li><a href="Java.html#java_directors_faq">Living with Java Directors</a>
 858 <li><a href="Java.html#odds_ends">Odds and ends</a>
 859 <ul>
 860 <li><a href="Java.html#javadoc_comments">JavaDoc comments</a>
 861 <li><a href="Java.html#functional_interface">Functional interface without proxy classes</a>
 862 <li><a href="Java.html#using_own_jni_functions">Using your own JNI functions</a>
 863 <li><a href="Java.html#performance">Performance concerns and hints</a>
 864 <li><a href="Java.html#java_debugging">Debugging</a>
 865 </ul>
 866 <li><a href="Java.html#java_examples">Examples</a>
 867 </ul>
 868 </div>
 869 <!-- INDEX -->
 870
 871 <h3><a href="Lisp.html#Lisp">22 SWIG and Common Lisp</a></h3>
 872
 873 <!-- INDEX -->
 874 <div class="sectiontoc">
 875 <ul>
 876 <li><a href="Lisp.html#Lisp_nn2">Allegro Common Lisp</a>
 877 <li><a href="Lisp.html#Lisp_nn3">Common Foreign Function Interface(CFFI)</a>
 878 <ul>
 879 <li><a href="Lisp.html#Lisp_nn4">Additional Commandline Options </a>
 880 <li><a href="Lisp.html#Lisp_nn5">Generating CFFI bindings</a>
 881 <li><a href="Lisp.html#Lisp_nn6">Generating CFFI bindings for C++ code</a>
 882 <li><a href="Lisp.html#Lisp_nn7">Inserting user code into generated files</a>
 883 </ul>
 884 <li><a href="Lisp.html#Lisp_nn8">CLISP</a>
 885 <ul>
 886 <li><a href="Lisp.html#Lisp_nn9">Additional Commandline Options </a>
 887 <li><a href="Lisp.html#Lisp_nn10">Details on CLISP bindings</a>
 888 </ul>
 889 <li><a href="Lisp.html#Lisp_nn11">UFFI </a>
 890 </ul>
 891 </div>
 892 <!-- INDEX -->
 893
 894 <h3><a href="Lua.html#Lua">23 SWIG and Lua</a></h3>
 895
 896 <!-- INDEX -->
 897 <div class="sectiontoc">
 898 <ul>
 899 <li><a href="Lua.html#Lua_nn2">Preliminaries</a>
 900 <li><a href="Lua.html#Lua_nn3">Running SWIG</a>
 901 <ul>
 902 <li><a href="Lua.html#Lua_nn4">Compiling and Linking and Interpreter</a>
 903 <li><a href="Lua.html#Lua_nn5">Compiling a dynamic module</a>
 904 <li><a href="Lua.html#Lua_nn6">Using your module</a>
 905 </ul>
 906 <li><a href="Lua.html#Lua_nn7">A tour of basic C/C++ wrapping</a>
 907 <ul>
 908 <li><a href="Lua.html#Lua_nn8">Modules</a>
 909 <li><a href="Lua.html#Lua_nn9">Functions</a>
 910 <li><a href="Lua.html#Lua_nn10">Global variables</a>
 911 <li><a href="Lua.html#Lua_nn11">Constants and enums</a>
 912 <li><a href="Lua.html#Lua_nn12">Pointers</a>
 913 <li><a href="Lua.html#Lua_nn13">Structures</a>
 914 <li><a href="Lua.html#Lua_nn14">C++ classes</a>
 915 <li><a href="Lua.html#Lua_nn15">C++ inheritance</a>
 916 <li><a href="Lua.html#Lua_nn16">Pointers, references, values, and arrays</a>
 917 <li><a href="Lua.html#Lua_nn17">C++ overloaded functions</a>
 918 <li><a href="Lua.html#Lua_nn18">C++ operators</a>
 919 <li><a href="Lua.html#Lua_nn19">Class extension with %extend</a>
 920 <li><a href="Lua.html#Lua_nn20">C++ templates</a>
 921 <li><a href="Lua.html#Lua_nn21">C++ Smart Pointers</a>
 922 <li><a href="Lua.html#Lua_nn22">C++ Exceptions</a>
 923 </ul>
 924 <li><a href="Lua.html#Lua_nn23">Typemaps</a>
 925 <ul>
 926 <li><a href="Lua.html#Lua_nn24">What is a typemap?</a>
 927 <li><a href="Lua.html#Lua_nn25">Using typemaps</a>
 928 <li><a href="Lua.html#Lua_nn26">Typemaps and arrays</a>
 929 <li><a href="Lua.html#Lua_nn27">Typemaps and pointer-pointer functions</a>
 930 </ul>
 931 <li><a href="Lua.html#Lua_nn28">Writing typemaps</a>
 932 <ul>
 933 <li><a href="Lua.html#Lua_nn29">Typemaps you can write</a>
 934 <li><a href="Lua.html#Lua_nn30">SWIG's Lua-C API</a>
 935 </ul>
 936 <li><a href="Lua.html#Lua_nn31">Customization of your Bindings</a>
 937 <ul>
 938 <li><a href="Lua.html#Lua_nn32">Writing your own custom wrappers</a>
 939 <li><a href="Lua.html#Lua_nn33">Adding additional Lua code</a>
 940 </ul>
 941 <li><a href="Lua.html#Lua_nn34">Details on the Lua binding</a>
 942 <ul>
 943 <li><a href="Lua.html#Lua_nn35">Binding global data into the module.</a>
 944 <li><a href="Lua.html#Lua_nn36">Userdata and Metatables</a>
 945 <li><a href="Lua.html#Lua_nn37">Memory management</a>
 946 </ul>
 947 </ul>
 948 </div>
 949 <!-- INDEX -->
 950
 951 <h3><a href="Modula3.html#Modula3">24 SWIG and Modula-3</a></h3>
 952
 953 <!-- INDEX -->
 954 <div class="sectiontoc">
 955 <ul>
 956 <li><a href="Modula3.html#modula3_overview">Overview</a>
 957 <ul>
 958 <li><a href="Modula3.html#whyscripting">Why not scripting ?</a>
 959 <li><a href="Modula3.html#whymodula3">Why Modula-3 ?</a>
 960 <li><a href="Modula3.html#whycpp">Why C / C++ ?</a>
 961 <li><a href="Modula3.html#whyswig">Why SWIG ?</a>
 962 </ul>
 963 <li><a href="Modula3.html#conception">Conception</a>
 964 <ul>
 965 <li><a href="Modula3.html#cinterface">Interfaces to C libraries</a>
 966 <li><a href="Modula3.html#cppinterface">Interfaces to C++ libraries</a>
 967 </ul>
 968 <li><a href="Modula3.html#preliminaries">Preliminaries</a>
 969 <ul>
 970 <li><a href="Modula3.html#compilers">Compilers</a>
 971 <li><a href="Modula3.html#commandline">Additional Commandline Options</a>
 972 </ul>
 973 <li><a href="Modula3.html#modula3_typemaps">Modula-3 typemaps</a>
 974 <ul>
 975 <li><a href="Modula3.html#inoutparam">Inputs and outputs</a>
 976 <li><a href="Modula3.html#ordinals">Subranges, Enumerations, Sets</a>
 977 <li><a href="Modula3.html#class">Objects</a>
 978 <li><a href="Modula3.html#imports">Imports</a>
 979 <li><a href="Modula3.html#exceptions">Exceptions</a>
 980 <li><a href="Modula3.html#typemap_example">Example</a>
 981 </ul>
 982 <li><a href="Modula3.html#hints">More hints to the generator</a>
 983 <ul>
 984 <li><a href="Modula3.html#features">Features</a>
 985 <li><a href="Modula3.html#pragmas">Pragmas</a>
 986 </ul>
 987 <li><a href="Modula3.html#remarks">Remarks</a>
 988 </ul>
 989 </div>
 990 <!-- INDEX -->
 991
 992 <h3><a href="Mzscheme.html#Mzscheme">25 SWIG and MzScheme</a></h3>
 993
 994 <!-- INDEX -->
 995 <div class="sectiontoc">
 996 <ul>
 997 <li><a href="Mzscheme.html#MzScheme_nn2">Creating native MzScheme structures</a>
 998 </ul>
 999 </div>
1000 <!-- INDEX -->
1001
1002 <h3><a href="Ocaml.html#Ocaml">26 SWIG and Ocaml</a></h3>
1003
1004 <!-- INDEX -->
1005 <div class="sectiontoc">
1006 <ul>
1007 <li><a href="Ocaml.html#Ocaml_nn2">Preliminaries</a>
1008 <ul>
1009 <li><a href="Ocaml.html#Ocaml_nn3">Running SWIG</a>
1010 <li><a href="Ocaml.html#Ocaml_nn4">Compiling the code</a>
1011 <li><a href="Ocaml.html#Ocaml_nn5">The camlp4 module</a>
1012 <li><a href="Ocaml.html#Ocaml_nn6">Using your module</a>
1013 <li><a href="Ocaml.html#Ocaml_nn7">Compilation problems and compiling with C++</a>
1014 </ul>
1015 <li><a href="Ocaml.html#Ocaml_nn8">The low-level Ocaml/C interface</a>
1016 <ul>
1017 <li><a href="Ocaml.html#Ocaml_nn9">The generated module</a>
1018 <li><a href="Ocaml.html#Ocaml_nn10">Enums</a>
1019 <ul>
1020 <li><a href="Ocaml.html#Ocaml_nn11">Enum typing in Ocaml</a>
1021 </ul>
1022 <li><a href="Ocaml.html#Ocaml_nn12">Arrays</a>
1023 <ul>
1024 <li><a href="Ocaml.html#Ocaml_nn13">Simple types of bounded arrays</a>
1025 <li><a href="Ocaml.html#Ocaml_nn14">Complex and unbounded arrays</a>
1026 <li><a href="Ocaml.html#Ocaml_nn15">Using an object</a>
1027 <li><a href="Ocaml.html#Ocaml_nn16">Example typemap for a function taking float * and int</a>
1028 </ul>
1029 <li><a href="Ocaml.html#Ocaml_nn17">C++ Classes</a>
1030 <ul>
1031 <li><a href="Ocaml.html#Ocaml_nn18">STL vector and string Example</a>
1032 <li><a href="Ocaml.html#Ocaml_nn19">C++ Class Example</a>
1033 <li><a href="Ocaml.html#Ocaml_nn20">Compiling the example</a>
1034 <li><a href="Ocaml.html#Ocaml_nn21">Sample Session</a>
1035 </ul>
1036 <li><a href="Ocaml.html#Ocaml_nn22">Director Classes</a>
1037 <ul>
1038 <li><a href="Ocaml.html#Ocaml_nn23">Director Introduction</a>
1039 <li><a href="Ocaml.html#Ocaml_nn24">Overriding Methods in Ocaml</a>
1040 <li><a href="Ocaml.html#Ocaml_nn25">Director Usage Example</a>
1041 <li><a href="Ocaml.html#Ocaml_nn26">Creating director objects</a>
1042 <li><a href="Ocaml.html#Ocaml_nn27">Typemaps for directors, <tt>directorin, directorout, directorargout</tt></a>
1043 <li><a href="Ocaml.html#Ocaml_nn28"><tt>directorin</tt> typemap</a>
1044 <li><a href="Ocaml.html#Ocaml_nn29"><tt>directorout</tt> typemap</a>
1045 <li><a href="Ocaml.html#Ocaml_nn30"><tt>directorargout</tt> typemap</a>
1046 </ul>
1047 <li><a href="Ocaml.html#Ocaml_nn31">Exceptions</a>
1048 </ul>
1049 </ul>
1050 </div>
1051 <!-- INDEX -->
1052
1053 <h3><a href="Octave.html#Octave">27 SWIG and Octave</a></h3>
1054
1055 <!-- INDEX -->
1056 <div class="sectiontoc">
1057 <ul>
1058 <li><a href="Octave.html#Octave_nn2">Preliminaries</a>
1059 <li><a href="Octave.html#Octave_nn3">Running SWIG</a>
1060 <ul>
1061 <li><a href="Octave.html#Octave_nn5">Compiling a dynamic module</a>
1062 <li><a href="Octave.html#Octave_nn6">Using your module</a>
1063 </ul>
1064 <li><a href="Octave.html#Octave_nn7">A tour of basic C/C++ wrapping</a>
1065 <ul>
1066 <li><a href="Octave.html#Octave_nn8">Modules</a>
1067 <li><a href="Octave.html#Octave_nn9">Functions</a>
1068 <li><a href="Octave.html#Octave_nn10">Global variables</a>
1069 <li><a href="Octave.html#Octave_nn11">Constants and enums</a>
1070 <li><a href="Octave.html#Octave_nn12">Pointers</a>
1071 <li><a href="Octave.html#Octave_nn13">Structures and C++ classes</a>
1072 <li><a href="Octave.html#Octave_nn15">C++ inheritance</a>
1073 <li><a href="Octave.html#Octave_nn17">C++ overloaded functions</a>
1074 <li><a href="Octave.html#Octave_nn18">C++ operators</a>
1075 <li><a href="Octave.html#Octave_nn19">Class extension with %extend</a>
1076 <li><a href="Octave.html#Octave_nn20">C++ templates</a>
1077 <li><a href="Octave.html#Octave_nn21">C++ Smart Pointers</a>
1078 <li><a href="Octave.html#Octave_nn22">Directors (calling Octave from C++ code)</a>
1079 <li><a href="Octave.html#Octave_nn23">Threads</a>
1080 <li><a href="Octave.html#Octave_nn24">Memory management</a>
1081 <li><a href="Octave.html#Octave_nn25">STL support</a>
1082 <li><a href="Octave.html#Octave_nn26">Matrix typemaps</a>
1083 </ul>
1084 </ul>
1085 </div>
1086 <!-- INDEX -->
1087
1088 <h3><a href="Perl5.html#Perl5">28 SWIG and Perl5</a></h3>
1089
1090 <!-- INDEX -->
1091 <div class="sectiontoc">
1092 <ul>
1093 <li><a href="Perl5.html#Perl5_nn2">Overview</a>
1094 <li><a href="Perl5.html#Perl5_nn3">Preliminaries</a>
1095 <ul>
1096 <li><a href="Perl5.html#Perl5_nn4">Getting the right header files</a>
1097 <li><a href="Perl5.html#Perl5_nn5">Compiling a dynamic module</a>
1098 <li><a href="Perl5.html#Perl5_nn6">Building a dynamic module with MakeMaker</a>
1099 <li><a href="Perl5.html#Perl5_nn7">Building a static version of Perl</a>
1100 <li><a href="Perl5.html#Perl5_nn8">Using the module</a>
1101 <li><a href="Perl5.html#Perl5_nn9">Compilation problems and compiling with C++</a>
1102 <li><a href="Perl5.html#Perl5_nn10">Compiling for 64-bit platforms</a>
1103 </ul>
1104 <li><a href="Perl5.html#Perl5_nn11">Building Perl Extensions under Windows</a>
1105 <ul>
1106 <li><a href="Perl5.html#Perl5_nn12">Running SWIG from Developer Studio</a>
1107 <li><a href="Perl5.html#Perl5_nn13">Using other compilers</a>
1108 </ul>
1109 <li><a href="Perl5.html#Perl5_nn14">The low-level interface</a>
1110 <ul>
1111 <li><a href="Perl5.html#Perl5_nn15">Functions</a>
1112 <li><a href="Perl5.html#Perl5_nn16">Global variables</a>
1113 <li><a href="Perl5.html#Perl5_nn17">Constants</a>
1114 <li><a href="Perl5.html#Perl5_nn18">Pointers</a>
1115 <li><a href="Perl5.html#Perl5_nn19">Structures</a>
1116 <li><a href="Perl5.html#Perl5_nn20">C++ classes</a>
1117 <li><a href="Perl5.html#Perl5_nn21">C++ classes and type-checking</a>
1118 <li><a href="Perl5.html#Perl5_nn22">C++ overloaded functions</a>
1119 <li><a href="Perl5.html#Perl5_nn23">Operators</a>
1120 <li><a href="Perl5.html#Perl5_nn24">Modules and packages</a>
1121 </ul>
1122 <li><a href="Perl5.html#Perl5_nn25">Input and output parameters</a>
1123 <li><a href="Perl5.html#Perl5_nn26">Exception handling</a>
1124 <li><a href="Perl5.html#Perl5_nn27">Remapping datatypes with typemaps</a>
1125 <ul>
1126 <li><a href="Perl5.html#Perl5_nn28">A simple typemap example</a>
1127 <li><a href="Perl5.html#Perl5_nn29">Perl5 typemaps</a>
1128 <li><a href="Perl5.html#Perl5_nn30">Typemap variables</a>
1129 <li><a href="Perl5.html#Perl5_nn31">Useful functions</a>
1130 </ul>
1131 <li><a href="Perl5.html#Perl5_nn32">Typemap Examples</a>
1132 <ul>
1133 <li><a href="Perl5.html#Perl5_nn33">Converting a Perl5 array to a char **</a>
1134 <li><a href="Perl5.html#Perl5_nn34">Return values</a>
1135 <li><a href="Perl5.html#Perl5_nn35">Returning values from arguments</a>
1136 <li><a href="Perl5.html#Perl5_nn36">Accessing array structure members</a>
1137 <li><a href="Perl5.html#Perl5_nn37">Turning Perl references into C pointers</a>
1138 <li><a href="Perl5.html#Perl5_nn38">Pointer handling</a>
1139 </ul>
1140 <li><a href="Perl5.html#Perl5_nn39">Proxy classes</a>
1141 <ul>
1142 <li><a href="Perl5.html#Perl5_nn40">Preliminaries</a>
1143 <li><a href="Perl5.html#Perl5_nn41">Structure and class wrappers</a>
1144 <li><a href="Perl5.html#Perl5_nn42">Object Ownership</a>
1145 <li><a href="Perl5.html#Perl5_nn43">Nested Objects</a>
1146 <li><a href="Perl5.html#Perl5_nn44">Proxy Functions</a>
1147 <li><a href="Perl5.html#Perl5_nn45">Inheritance</a>
1148 <li><a href="Perl5.html#Perl5_nn46">Modifying the proxy methods</a>
1149 </ul>
1150 <li><a href="Perl5.html#Perl5_nn47">Adding additional Perl code</a>
1151 </ul>
1152 </div>
1153 <!-- INDEX -->
1154
1155 <h3><a href="Php.html#Php">29 SWIG and PHP</a></h3>
1156
1157 <!-- INDEX -->
1158 <div class="sectiontoc">
1159 <ul>
1160 <li><a href="Php.html#Php_nn1">Generating PHP Extensions</a>
1161 <ul>
1162 <li><a href="Php.html#Php_nn1_1">Building a loadable extension</a>
1163 <li><a href="Php.html#Php_nn1_3">Using PHP Extensions</a>
1164 </ul>
1165 <li><a href="Php.html#Php_nn2">Basic PHP interface</a>
1166 <ul>
1167 <li><a href="Php.html#Php_nn2_1">Constants</a>
1168 <li><a href="Php.html#Php_nn2_2">Global Variables</a>
1169 <li><a href="Php.html#Php_nn2_3">Functions</a>
1170 <li><a href="Php.html#Php_nn2_4">Overloading</a>
1171 <li><a href="Php.html#Php_nn2_5">Pointers and References</a>
1172 <li><a href="Php.html#Php_nn2_6">Structures and C++ classes</a>
1173 <ul>
1174 <li><a href="Php.html#Php_nn2_6_1">Using <tt>-noproxy</tt></a>
1175 <li><a href="Php.html#Php_nn2_6_2">Constructors and Destructors</a>
1176 <li><a href="Php.html#Php_nn2_6_3">Static Member Variables</a>
1177 <li><a href="Php.html#Php_nn2_6_4">Static Member Functions</a>
1178 </ul>
1179 <li><a href="Php.html#Php_nn2_7">PHP Pragmas, Startup and Shutdown code</a>
1180 </ul>
1181 <li><a href="Php.html#Php_nn3">Cross language polymorphism</a>
1182 <ul>
1183 <li><a href="Php.html#Php_nn3_1">Enabling directors</a>
1184 <li><a href="Php.html#Php_nn3_2">Director classes</a>
1185 <li><a href="Php.html#Php_nn3_3">Ownership and object destruction</a>
1186 <li><a href="Php.html#Php_nn3_4">Exception unrolling</a>
1187 <li><a href="Php.html#Php_nn3_5">Overhead and code bloat</a>
1188 <li><a href="Php.html#Php_nn3_6">Typemaps</a>
1189 <li><a href="Php.html#Php_nn3_7">Miscellaneous</a>
1190 </ul>
1191 </ul>
1192 </div>
1193 <!-- INDEX -->
1194
1195 <h3><a href="Pike.html#Pike">30 SWIG and Pike</a></h3>
1196
1197 <!-- INDEX -->
1198 <div class="sectiontoc">
1199 <ul>
1200 <li><a href="Pike.html#Pike_nn2">Preliminaries</a>
1201 <ul>
1202 <li><a href="Pike.html#Pike_nn3">Running SWIG</a>
1203 <li><a href="Pike.html#Pike_nn4">Getting the right header files</a>
1204 <li><a href="Pike.html#Pike_nn5">Using your module</a>
1205 </ul>
1206 <li><a href="Pike.html#Pike_nn6">Basic C/C++ Mapping</a>
1207 <ul>
1208 <li><a href="Pike.html#Pike_nn7">Modules</a>
1209 <li><a href="Pike.html#Pike_nn8">Functions</a>
1210 <li><a href="Pike.html#Pike_nn9">Global variables</a>
1211 <li><a href="Pike.html#Pike_nn10">Constants and enumerated types</a>
1212 <li><a href="Pike.html#Pike_nn11">Constructors and Destructors</a>
1213 <li><a href="Pike.html#Pike_nn12">Static Members</a>
1214 </ul>
1215 </ul>
1216 </div>
1217 <!-- INDEX -->
1218
1219 <h3><a href="Python.html#Python">31 SWIG and Python</a></h3>
1220
1221 <!-- INDEX -->
1222 <div class="sectiontoc">
1223 <ul>
1224 <li><a href="Python.html#Python_nn2">Overview</a>
1225 <li><a href="Python.html#Python_nn3">Preliminaries</a>
1226 <ul>
1227 <li><a href="Python.html#Python_nn4">Running SWIG</a>
1228 <li><a href="Python.html#Python_nn6">Using distutils</a>
1229 <li><a href="Python.html#Python_nn7">Hand compiling a dynamic module</a>
1230 <li><a href="Python.html#Python_nn8">Static linking</a>
1231 <li><a href="Python.html#Python_nn9">Using your module</a>
1232 <li><a href="Python.html#Python_nn10">Compilation of C++ extensions</a>
1233 <li><a href="Python.html#Python_nn11">Compiling for 64-bit platforms</a>
1234 <li><a href="Python.html#Python_nn12">Building Python Extensions under Windows</a>
1235 </ul>
1236 <li><a href="Python.html#Python_nn13">A tour of basic C/C++ wrapping</a>
1237 <ul>
1238 <li><a href="Python.html#Python_nn14">Modules</a>
1239 <li><a href="Python.html#Python_nn15">Functions</a>
1240 <li><a href="Python.html#Python_nn16">Global variables</a>
1241 <li><a href="Python.html#Python_nn17">Constants and enums</a>
1242 <li><a href="Python.html#Python_nn18">Pointers</a>
1243 <li><a href="Python.html#Python_nn19">Structures</a>
1244 <li><a href="Python.html#Python_nn20">C++ classes</a>
1245 <li><a href="Python.html#Python_nn21">C++ inheritance</a>
1246 <li><a href="Python.html#Python_nn22">Pointers, references, values, and arrays</a>
1247 <li><a href="Python.html#Python_nn23">C++ overloaded functions</a>
1248 <li><a href="Python.html#Python_nn24">C++ operators</a>
1249 <li><a href="Python.html#Python_nn25">C++ namespaces</a>
1250 <li><a href="Python.html#Python_nn26">C++ templates</a>
1251 <li><a href="Python.html#Python_nn27">C++ Smart Pointers</a>
1252 <li><a href="Python.html#Python_nn27a">C++ Reference Counted Objects (ref/unref)</a>
1253 </ul>
1254 <li><a href="Python.html#Python_nn28">Further details on the Python class interface</a>
1255 <ul>
1256 <li><a href="Python.html#Python_nn29">Proxy classes</a>
1257 <li><a href="Python.html#Python_nn30">Memory management</a>
1258 <li><a href="Python.html#Python_nn31">Python 2.2 and classic classes</a>
1259 </ul>
1260 <li><a href="Python.html#Python_directors">Cross language polymorphism</a>
1261 <ul>
1262 <li><a href="Python.html#Python_nn33">Enabling directors</a>
1263 <li><a href="Python.html#Python_nn34">Director classes</a>
1264 <li><a href="Python.html#Python_nn35">Ownership and object destruction</a>
1265 <li><a href="Python.html#Python_nn36">Exception unrolling</a>
1266 <li><a href="Python.html#Python_nn37">Overhead and code bloat</a>
1267 <li><a href="Python.html#Python_nn38">Typemaps</a>
1268 <li><a href="Python.html#Python_nn39">Miscellaneous</a>
1269 </ul>
1270 <li><a href="Python.html#Python_nn40">Common customization features</a>
1271 <ul>
1272 <li><a href="Python.html#Python_nn41">C/C++ helper functions</a>
1273 <li><a href="Python.html#Python_nn42">Adding additional Python code</a>
1274 <li><a href="Python.html#Python_nn43">Class extension with %extend</a>
1275 <li><a href="Python.html#Python_nn44">Exception handling with %exception</a>
1276 </ul>
1277 <li><a href="Python.html#Python_nn45">Tips and techniques</a>
1278 <ul>
1279 <li><a href="Python.html#Python_nn46">Input and output parameters</a>
1280 <li><a href="Python.html#Python_nn47">Simple pointers</a>
1281 <li><a href="Python.html#Python_nn48">Unbounded C Arrays</a>
1282 <li><a href="Python.html#Python_nn49">String handling</a>
1283 <li><a href="Python.html#Python_nn50">Arrays</a>
1284 <li><a href="Python.html#Python_nn51">String arrays</a>
1285 <li><a href="Python.html#Python_nn52">STL wrappers</a>
1286 </ul>
1287 <li><a href="Python.html#Python_nn53">Typemaps</a>
1288 <ul>
1289 <li><a href="Python.html#Python_nn54">What is a typemap?</a>
1290 <li><a href="Python.html#Python_nn55">Python typemaps</a>
1291 <li><a href="Python.html#Python_nn56">Typemap variables</a>
1292 <li><a href="Python.html#Python_nn57">Useful Python Functions</a>
1293 </ul>
1294 <li><a href="Python.html#Python_nn58">Typemap Examples</a>
1295 <ul>
1296 <li><a href="Python.html#Python_nn59">Converting  Python list to a char ** </a>
1297 <li><a href="Python.html#Python_nn60">Expanding a Python object into multiple arguments</a>
1298 <li><a href="Python.html#Python_nn61">Using typemaps to return arguments</a>
1299 <li><a href="Python.html#Python_nn62">Mapping Python tuples into small arrays</a>
1300 <li><a href="Python.html#Python_nn63">Mapping sequences to C arrays</a>
1301 <li><a href="Python.html#Python_nn64">Pointer handling</a>
1302 </ul>
1303 <li><a href="Python.html#Python_nn65">Docstring Features</a>
1304 <ul>
1305 <li><a href="Python.html#Python_nn66">Module docstring</a>
1306 <li><a href="Python.html#Python_nn67">%feature("autodoc")</a>
1307 <ul>
1308 <li><a href="Python.html#Python_nn68">%feature("autodoc", "0")</a>
1309 <li><a href="Python.html#Python_nn69">%feature("autodoc", "1")</a>
1310 <li><a href="Python.html#Python_nn70">%feature("autodoc", "docstring")</a>
1311 </ul>
1312 <li><a href="Python.html#Python_nn71">%feature("docstring")</a>
1313 </ul>
1314 <li><a href="Python.html#Python_nn72">Python Packages</a>
1315 <li><a href="Python.html#Python_python3support">Python 3 Support</a>
1316 <ul>
1317 <li><a href="Python.html#Python_nn74">Function annotation</a>
1318 <li><a href="Python.html#Python_nn75">Buffer interface</a>
1319 <li><a href="Python.html#Python_nn76">Abstract base classes</a>
1320 </ul>
1321 </ul>
1322 </div>
1323 <!-- INDEX -->
1324
1325 <h3><a href="Ruby.html#Ruby">32 SWIG and Ruby</a></h3>
1326
1327 <!-- INDEX -->
1328 <div class="sectiontoc">
1329 <ul>
1330 <li><a href="Ruby.html#Ruby_nn2">Preliminaries</a>
1331 <ul>
1332 <li><a href="Ruby.html#Ruby_nn3">Running SWIG</a>
1333 <li><a href="Ruby.html#Ruby_nn4">Getting the right header files</a>
1334 <li><a href="Ruby.html#Ruby_nn5">Compiling a dynamic module</a>
1335 <li><a href="Ruby.html#Ruby_nn6">Using your module</a>
1336 <li><a href="Ruby.html#Ruby_nn7">Static linking</a>
1337 <li><a href="Ruby.html#Ruby_nn8">Compilation of C++ extensions</a>
1338 </ul>
1339 <li><a href="Ruby.html#Ruby_nn9">Building Ruby Extensions under Windows 95/NT</a>
1340 <ul>
1341 <li><a href="Ruby.html#Ruby_nn10">Running SWIG from Developer Studio</a>
1342 </ul>
1343 <li><a href="Ruby.html#Ruby_nn11">The Ruby-to-C/C++ Mapping</a>
1344 <ul>
1345 <li><a href="Ruby.html#Ruby_nn12">Modules</a>
1346 <li><a href="Ruby.html#Ruby_nn13">Functions</a>
1347 <li><a href="Ruby.html#Ruby_nn14">Variable Linking</a>
1348 <li><a href="Ruby.html#Ruby_nn15">Constants</a>
1349 <li><a href="Ruby.html#Ruby_nn16">Pointers</a>
1350 <li><a href="Ruby.html#Ruby_nn17">Structures</a>
1351 <li><a href="Ruby.html#Ruby_nn18">C++ classes</a>
1352 <li><a href="Ruby.html#Ruby_nn19">C++ Inheritance</a>
1353 <li><a href="Ruby.html#Ruby_nn20">C++ Overloaded Functions</a>
1354 <li><a href="Ruby.html#Ruby_nn21">C++ Operators</a>
1355 <li><a href="Ruby.html#Ruby_nn22">C++ namespaces</a>
1356 <li><a href="Ruby.html#Ruby_nn23">C++ templates</a>
1357 <li><a href="Ruby.html#Ruby_nn23_1">C++ Standard Template Library (STL)</a>
1358 <li><a href="Ruby.html#C_STL_Functors">C++ STL Functors</a>
1359 <li><a href="Ruby.html#Ruby_C_Iterators">C++ STL Iterators</a>
1360 <li><a href="Ruby.html#Ruby_nn24">C++ Smart Pointers</a>
1361 <li><a href="Ruby.html#Ruby_nn25">Cross-Language Polymorphism</a>
1362 <ul>
1363 <li><a href="Ruby.html#Ruby_nn26">Exception Unrolling</a>
1364 </ul>
1365 </ul>
1366 <li><a href="Ruby.html#Ruby_nn27">Naming</a>
1367 <ul>
1368 <li><a href="Ruby.html#Ruby_nn28">Defining Aliases</a>
1369 <li><a href="Ruby.html#Ruby_nn29">Predicate Methods</a>
1370 <li><a href="Ruby.html#Ruby_nn30">Bang Methods</a>
1371 <li><a href="Ruby.html#Ruby_nn31">Getters and Setters</a>
1372 </ul>
1373 <li><a href="Ruby.html#Ruby_nn32">Input and output parameters</a>
1374 <li><a href="Ruby.html#Ruby_nn33">Exception handling </a>
1375 <ul>
1376 <li><a href="Ruby.html#Ruby_nn34">Using the %exception directive </a>
1377 <li><a href="Ruby.html#Ruby_nn34_2">Handling Ruby Blocks </a>
1378 <li><a href="Ruby.html#Ruby_nn35">Raising exceptions </a>
1379 <li><a href="Ruby.html#Ruby_nn36">Exception classes </a>
1380 </ul>
1381 <li><a href="Ruby.html#Ruby_nn37">Typemaps</a>
1382 <ul>
1383 <li><a href="Ruby.html#Ruby_nn38">What is a typemap?</a>
1384 <li><a href="Ruby.html#Ruby_Typemap_scope">Typemap scope</a>
1385 <li><a href="Ruby.html#Ruby_Copying_a_typemap">Copying a typemap</a>
1386 <li><a href="Ruby.html#Ruby_Deleting_a_typemap">Deleting a typemap</a>
1387 <li><a href="Ruby.html#Ruby_Placement_of_typemaps">Placement of typemaps</a>
1388 <li><a href="Ruby.html#Ruby_nn39">Ruby typemaps</a>
1389 <ul>
1390 <li><a href="Ruby.html#Ruby_in_typemap">&nbsp;"in" typemap</a>
1391 <li><a href="Ruby.html#Ruby_typecheck_typemap">"typecheck" typemap</a>
1392 <li><a href="Ruby.html#Ruby_out_typemap">&nbsp;"out" typemap</a>
1393 <li><a href="Ruby.html#Ruby_arginit_typemap">"arginit" typemap</a>
1394 <li><a href="Ruby.html#Ruby_default_typemap">"default" typemap</a>
1395 <li><a href="Ruby.html#Ruby_check_typemap">"check" typemap</a>
1396 <li><a href="Ruby.html#Ruby_argout_typemap_">"argout" typemap</a>
1397 <li><a href="Ruby.html#Ruby_freearg_typemap_">"freearg" typemap</a>
1398 <li><a href="Ruby.html#Ruby_newfree_typemap">"newfree" typemap</a>
1399 <li><a href="Ruby.html#Ruby_memberin_typemap">"memberin" typemap</a>
1400 <li><a href="Ruby.html#Ruby_varin_typemap">"varin" typemap</a>
1401 <li><a href="Ruby.html#Ruby_varout_typemap_">"varout" typemap</a>
1402 <li><a href="Ruby.html#Ruby_throws_typemap">"throws" typemap</a>
1403 <li><a href="Ruby.html#Ruby_directorin_typemap">directorin typemap</a>
1404 <li><a href="Ruby.html#Ruby_directorout_typemap">directorout typemap</a>
1405 <li><a href="Ruby.html#Ruby_directorargout_typemap">directorargout typemap</a>
1406 <li><a href="Ruby.html#Ruby_ret_typemap">ret typemap</a>
1407 <li><a href="Ruby.html#Ruby_globalin_typemap">globalin typemap</a>
1408 </ul>
1409 <li><a href="Ruby.html#Ruby_nn40">Typemap variables</a>
1410 <li><a href="Ruby.html#Ruby_nn41">Useful Functions</a>
1411 <ul>
1412 <li><a href="Ruby.html#Ruby_nn42">C Datatypes to Ruby Objects</a>
1413 <li><a href="Ruby.html#Ruby_nn43">Ruby Objects to C Datatypes</a>
1414 <li><a href="Ruby.html#Ruby_nn44">Macros for VALUE</a>
1415 <li><a href="Ruby.html#Ruby_nn45">Exceptions</a>
1416 <li><a href="Ruby.html#Ruby_nn46">Iterators</a>
1417 </ul>
1418 <li><a href="Ruby.html#Ruby_nn47">Typemap Examples</a>
1419 <li><a href="Ruby.html#Ruby_nn48">Converting a Ruby array to a char **</a>
1420 <li><a href="Ruby.html#Ruby_nn49">Collecting arguments in a hash</a>
1421 <li><a href="Ruby.html#Ruby_nn50">Pointer handling</a>
1422 <ul>
1423 <li><a href="Ruby.html#Ruby_nn51">Ruby Datatype Wrapping</a>
1424 </ul>
1425 <li><a href="Ruby.html#Ruby_nn52">Example: STL Vector to Ruby Array</a>
1426 </ul>
1427 <li><a href="Ruby.html#Ruby_nn65">Docstring Features</a>
1428 <ul>
1429 <li><a href="Ruby.html#Ruby_nn66">Module docstring</a>
1430 <li><a href="Ruby.html#Ruby_nn67">%feature("autodoc")</a>
1431 <ul>
1432 <li><a href="Ruby.html#Ruby_nn68">%feature("autodoc", "0")</a>
1433 <li><a href="Ruby.html#Ruby_autodoc1">%feature("autodoc", "1")</a>
1434 <li><a href="Ruby.html#Ruby_autodoc2">%feature("autodoc", "2")</a>
1435 <li><a href="Ruby.html#Ruby_feature_autodoc3">%feature("autodoc", "3")</a>
1436 <li><a href="Ruby.html#Ruby_nn70">%feature("autodoc", "docstring")</a>
1437 </ul>
1438 <li><a href="Ruby.html#Ruby_nn71">%feature("docstring")</a>
1439 </ul>
1440 <li><a href="Ruby.html#Ruby_nn53">Advanced Topics</a>
1441 <ul>
1442 <li><a href="Ruby.html#Ruby_nn54">Operator overloading</a>
1443 <li><a href="Ruby.html#Ruby_nn55">Creating Multi-Module Packages</a>
1444 <li><a href="Ruby.html#Ruby_nn56">Specifying Mixin Modules</a>
1445 </ul>
1446 <li><a href="Ruby.html#Ruby_nn57">Memory Management</a>
1447 <ul>
1448 <li><a href="Ruby.html#Ruby_nn58">Mark and Sweep Garbage Collector </a>
1449 <li><a href="Ruby.html#Ruby_nn59">Object Ownership</a>
1450 <li><a href="Ruby.html#Ruby_nn60">Object Tracking</a>
1451 <li><a href="Ruby.html#Ruby_nn61">Mark Functions</a>
1452 <li><a href="Ruby.html#Ruby_nn62">Free Functions</a>
1453 <li><a href="Ruby.html#Ruby_nn63">Embedded Ruby and the C++ Stack</a>
1454 </ul>
1455 </ul>
1456 </div>
1457 <!-- INDEX -->
1458
1459 <h3><a href="Tcl.html#Tcl">33 SWIG and Tcl</a></h3>
1460
1461 <!-- INDEX -->
1462 <div class="sectiontoc">
1463 <ul>
1464 <li><a href="Tcl.html#Tcl_nn2">Preliminaries</a>
1465 <ul>
1466 <li><a href="Tcl.html#Tcl_nn3">Getting the right header files</a>
1467 <li><a href="Tcl.html#Tcl_nn4">Compiling a dynamic module</a>
1468 <li><a href="Tcl.html#Tcl_nn5">Static linking</a>
1469 <li><a href="Tcl.html#Tcl_nn6">Using your module</a>
1470 <li><a href="Tcl.html#Tcl_nn7">Compilation of C++ extensions</a>
1471 <li><a href="Tcl.html#Tcl_nn8">Compiling for 64-bit platforms</a>
1472 <li><a href="Tcl.html#Tcl_nn9">Setting a package prefix</a>
1473 <li><a href="Tcl.html#Tcl_nn10">Using namespaces</a>
1474 </ul>
1475 <li><a href="Tcl.html#Tcl_nn11">Building Tcl/Tk Extensions under Windows 95/NT</a>
1476 <ul>
1477 <li><a href="Tcl.html#Tcl_nn12">Running SWIG from Developer Studio</a>
1478 <li><a href="Tcl.html#Tcl_nn13">Using NMAKE</a>
1479 </ul>
1480 <li><a href="Tcl.html#Tcl_nn14">A tour of basic C/C++ wrapping</a>
1481 <ul>
1482 <li><a href="Tcl.html#Tcl_nn15">Modules</a>
1483 <li><a href="Tcl.html#Tcl_nn16">Functions</a>
1484 <li><a href="Tcl.html#Tcl_nn17">Global variables</a>
1485 <li><a href="Tcl.html#Tcl_nn18">Constants and enums</a>
1486 <li><a href="Tcl.html#Tcl_nn19">Pointers</a>
1487 <li><a href="Tcl.html#Tcl_nn20">Structures</a>
1488 <li><a href="Tcl.html#Tcl_nn21">C++ classes</a>
1489 <li><a href="Tcl.html#Tcl_nn22">C++ inheritance</a>
1490 <li><a href="Tcl.html#Tcl_nn23">Pointers, references, values, and arrays</a>
1491 <li><a href="Tcl.html#Tcl_nn24">C++ overloaded functions</a>
1492 <li><a href="Tcl.html#Tcl_nn25">C++ operators</a>
1493 <li><a href="Tcl.html#Tcl_nn26">C++ namespaces</a>
1494 <li><a href="Tcl.html#Tcl_nn27">C++ templates</a>
1495 <li><a href="Tcl.html#Tcl_nn28">C++ Smart Pointers</a>
1496 </ul>
1497 <li><a href="Tcl.html#Tcl_nn29">Further details on the Tcl class interface</a>
1498 <ul>
1499 <li><a href="Tcl.html#Tcl_nn30">Proxy classes</a>
1500 <li><a href="Tcl.html#Tcl_nn31">Memory management</a>
1501 </ul>
1502 <li><a href="Tcl.html#Tcl_nn32">Input and output parameters</a>
1503 <li><a href="Tcl.html#Tcl_nn33">Exception handling </a>
1504 <li><a href="Tcl.html#Tcl_nn34">Typemaps</a>
1505 <ul>
1506 <li><a href="Tcl.html#Tcl_nn35">What is a typemap?</a>
1507 <li><a href="Tcl.html#Tcl_nn36">Tcl typemaps</a>
1508 <li><a href="Tcl.html#Tcl_nn37">Typemap variables</a>
1509 <li><a href="Tcl.html#Tcl_nn38">Converting  a Tcl list to a char ** </a>
1510 <li><a href="Tcl.html#Tcl_nn39">Returning values in arguments</a>
1511 <li><a href="Tcl.html#Tcl_nn40">Useful functions</a>
1512 <li><a href="Tcl.html#Tcl_nn41">Standard  typemaps</a>
1513 <li><a href="Tcl.html#Tcl_nn42">Pointer handling</a>
1514 </ul>
1515 <li><a href="Tcl.html#Tcl_nn43">Turning a SWIG module into a Tcl Package.</a>
1516 <li><a href="Tcl.html#Tcl_nn44">Building new kinds of Tcl interfaces (in Tcl)</a>
1517 <ul>
1518 <li><a href="Tcl.html#Tcl_nn45">Proxy classes</a>
1519 </ul>
1520 <li><a href="Tcl.html#Tcl_nn46">Tcl/Tk Stubs</a>
1521 </ul>
1522 </div>
1523 <!-- INDEX -->
1524
1525 <h3><a href="R.html#R">34 SWIG and R</a></h3>
1526
1527 <!-- INDEX -->
1528 <div class="sectiontoc">
1529 <ul>
1530 <li><a href="R.html#R_nn2">Bugs</a>
1531 <li><a href="R.html#R_nn3">Using R and SWIG</a>
1532 <li><a href="R.html#R_nn4">Precompiling large R files</a>
1533 <li><a href="R.html#R_nn5">General policy</a>
1534 <li><a href="R.html#R_language_conventions">Language conventions</a>
1535 <li><a href="R.html#R_nn6">C++ classes</a>
1536 <li><a href="R.html#R_nn7">Enumerations</a>
1537 </ul>
1538 </div>
1539 <!-- INDEX -->
1540
1541 <h3><a href="Extending.html#Extending">35 Extending SWIG to support new languages</a></h3>
1542
1543 <!-- INDEX -->
1544 <div class="sectiontoc">
1545 <ul>
1546 <li><a href="Extending.html#Extending_nn2">Introduction</a>
1547 <li><a href="Extending.html#Extending_nn3">Prerequisites</a>
1548 <li><a href="Extending.html#Extending_nn4">The Big Picture</a>
1549 <li><a href="Extending.html#Extending_nn5">Execution Model</a>
1550 <ul>
1551 <li><a href="Extending.html#Extending_nn6">Preprocessing</a>
1552 <li><a href="Extending.html#Extending_nn7">Parsing</a>
1553 <li><a href="Extending.html#Extending_nn8">Parse Trees</a>
1554 <li><a href="Extending.html#Extending_nn9">Attribute namespaces</a>
1555 <li><a href="Extending.html#Extending_nn10">Symbol Tables</a>
1556 <li><a href="Extending.html#Extending_nn11">The %feature directive</a>
1557 <li><a href="Extending.html#Extending_nn12">Code Generation</a>
1558 <li><a href="Extending.html#Extending_nn13">SWIG and XML</a>
1559 </ul>
1560 <li><a href="Extending.html#Extending_nn14">Primitive Data Structures</a>
1561 <ul>
1562 <li><a href="Extending.html#Extending_nn15">Strings</a>
1563 <li><a href="Extending.html#Extending_nn16">Hashes</a>
1564 <li><a href="Extending.html#Extending_nn17">Lists</a>
1565 <li><a href="Extending.html#Extending_nn18">Common operations</a>
1566 <li><a href="Extending.html#Extending_nn19">Iterating over Lists and Hashes</a>
1567 <li><a href="Extending.html#Extending_nn20">I/O</a>
1568 </ul>
1569 <li><a href="Extending.html#Extending_nn21">Navigating and manipulating parse trees</a>
1570 <li><a href="Extending.html#Extending_nn22">Working with attributes</a>
1571 <li><a href="Extending.html#Extending_nn23">Type system</a>
1572 <ul>
1573 <li><a href="Extending.html#Extending_nn24">String encoding of types</a>
1574 <li><a href="Extending.html#Extending_nn25">Type construction</a>
1575 <li><a href="Extending.html#Extending_nn26">Type tests</a>
1576 <li><a href="Extending.html#Extending_nn27">Typedef and inheritance</a>
1577 <li><a href="Extending.html#Extending_nn28">Lvalues</a>
1578 <li><a href="Extending.html#Extending_nn29">Output functions</a>
1579 </ul>
1580 <li><a href="Extending.html#Extending_nn30">Parameters</a>
1581 <li><a href="Extending.html#Extending_nn31">Writing a Language Module</a>
1582 <ul>
1583 <li><a href="Extending.html#Extending_nn32">Execution model</a>
1584 <li><a href="Extending.html#Extending_nn33">Starting out</a>
1585 <li><a href="Extending.html#Extending_nn34">Command line options</a>
1586 <li><a href="Extending.html#Extending_nn35">Configuration and preprocessing</a>
1587 <li><a href="Extending.html#Extending_nn36">Entry point to code generation</a>
1588 <li><a href="Extending.html#Extending_nn37">Module I/O and wrapper skeleton</a>
1589 <li><a href="Extending.html#Extending_nn38">Low-level code generators</a>
1590 <li><a href="Extending.html#Extending_nn39">Configuration files</a>
1591 <li><a href="Extending.html#Extending_nn40">Runtime support</a>
1592 <li><a href="Extending.html#Extending_nn41">Standard library files</a>
1593 <li><a href="Extending.html#Extending_nn42">Examples and test cases</a>
1594 <li><a href="Extending.html#Extending_nn43">Documentation</a>
1595 <li><a href="Extending.html#Extending_prerequisites">Prerequisites for adding a new language module to the SWIG distribution</a>
1596 <li><a href="Extending.html#Extending_coding_style_guidelines">Coding style guidelines</a>
1597 </ul>
1598 <li><a href="Extending.html#Extending_nn44">Typemaps</a>
1599 <ul>
1600 <li><a href="Extending.html#Extending_nn45">Proxy classes</a>
1601 </ul>
1602 <li><a href="Extending.html#Extending_nn46">Guide to parse tree nodes</a>
1603 </ul>
1604 </div>
1605 <!-- INDEX -->
1606
1607
1608 </BODY>
1609 </HTML>
1610