diff options
author | William S Fulton <wsf@fultondesigns.co.uk> | 2008-03-02 22:41:58 +0000 |
---|---|---|
committer | William S Fulton <wsf@fultondesigns.co.uk> | 2008-03-02 22:41:58 +0000 |
commit | c99fe90574e5331d3e9e4dbd97d8ad2ffe157768 (patch) | |
tree | 43392838c3726ce975963df4784a06ca0bbe8da0 /Doc/Manual/Contents.html | |
parent | 9d4fe6576d298f3e04714e9e34d37c1a5ac02654 (diff) | |
download | swig-c99fe90574e5331d3e9e4dbd97d8ad2ffe157768.tar.gz |
Put the chapters back in order after erroneously incorrectly reordering them in last checkin
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@10294 626c5289-ae23-0410-ae9c-e8d60b6d4f22
Diffstat (limited to 'Doc/Manual/Contents.html')
-rw-r--r-- | Doc/Manual/Contents.html | 1160 |
1 files changed, 580 insertions, 580 deletions
diff --git a/Doc/Manual/Contents.html b/Doc/Manual/Contents.html index 23f9ee6e7..d6be3b453 100644 --- a/Doc/Manual/Contents.html +++ b/Doc/Manual/Contents.html @@ -9,7 +9,494 @@ <p> -<h3><a href="Allegrocl.html#Allegrocl">1 SWIG and Allegro Common Lisp</a></h3> +<h3><a href="Preface.html#Preface">1 Preface</a></h3> + +<!-- INDEX --> +<div class="sectiontoc"> +<ul> +<li><a href="Preface.html#Preface_nn2">Introduction</a> +<li><a href="Preface.html#Preface_nn3">Special Introduction for Version 1.3</a> +<li><a href="Preface.html#Preface_nn4">SWIG Versions</a> +<li><a href="Preface.html#Preface_nn5">SWIG resources</a> +<li><a href="Preface.html#Preface_nn6">Prerequisites</a> +<li><a href="Preface.html#Preface_nn7">Organization of this manual</a> +<li><a href="Preface.html#Preface_nn8">How to avoid reading the manual</a> +<li><a href="Preface.html#Preface_nn9">Backwards Compatibility</a> +<li><a href="Preface.html#Preface_nn10">Credits</a> +<li><a href="Preface.html#Preface_nn11">Bug reports</a> +</ul> +</div> +<!-- INDEX --> + +<h3><a href="Introduction.html#Introduction">2 Introduction</a></h3> + +<!-- INDEX --> +<div class="sectiontoc"> +<ul> +<li><a href="Introduction.html#Introduction_nn2">What is SWIG?</a> +<li><a href="Introduction.html#Introduction_nn3">Why use SWIG?</a> +<li><a href="Introduction.html#Introduction_nn4">A SWIG example</a> +<ul> +<li><a href="Introduction.html#Introduction_nn5">SWIG interface file</a> +<li><a href="Introduction.html#Introduction_nn6">The swig command</a> +<li><a href="Introduction.html#Introduction_nn7">Building a Perl5 module</a> +<li><a href="Introduction.html#Introduction_nn8">Building a Python module</a> +<li><a href="Introduction.html#Introduction_nn9">Shortcuts</a> +</ul> +<li><a href="Introduction.html#Introduction_nn10">Supported C/C++ language features</a> +<li><a href="Introduction.html#Introduction_nn11">Non-intrusive interface building</a> +<li><a href="Introduction.html#Introduction_build_system">Incorporating SWIG into a build system</a> +<li><a href="Introduction.html#Introduction_nn12">Hands off code generation</a> +<li><a href="Introduction.html#Introduction_nn13">SWIG and freedom</a> +</ul> +</div> +<!-- INDEX --> + +<h3><a href="Windows.html#Windows">3 Getting started on Windows </a></h3> + +<!-- INDEX --> +<div class="sectiontoc"> +<ul> +<li><a href="Windows.html#Windows_installation">Installation on Windows</a> +<ul> +<li><a href="Windows.html#Windows_executable">Windows Executable</a> +</ul> +<li><a href="Windows.html#Windows_examples">SWIG Windows Examples</a> +<ul> +<li><a href="Windows.html#Windows_visual_studio">Instructions for using the Examples with Visual Studio</a> +<ul> +<li><a href="Windows.html#Windows_csharp">C#</a> +<li><a href="Windows.html#Windows_java">Java</a> +<li><a href="Windows.html#Windows_perl">Perl</a> +<li><a href="Windows.html#Windows_python">Python</a> +<li><a href="Windows.html#Windows_tcl">TCL</a> +<li><a href="Windows.html#Windows_r">R</a> +<li><a href="Windows.html#Windows_ruby">Ruby</a> +</ul> +<li><a href="Windows.html#Windows_other_compilers">Instructions for using the Examples with other compilers</a> +</ul> +<li><a href="Windows.html#Windows_cygwin_mingw">SWIG on Cygwin and MinGW</a> +<ul> +<li><a href="Windows.html#Windows_swig_exe">Building swig.exe on Windows</a> +<ul> +<li><a href="Windows.html#Windows_mingw_msys">Building swig.exe using MinGW and MSYS</a> +<li><a href="Windows.html#Windows_cygwin">Building swig.exe using Cygwin</a> +<li><a href="Windows.html#Windows_building_alternatives">Building swig.exe alternatives</a> +</ul> +<li><a href="Windows.html#Windows_examples_cygwin">Running the examples on Windows using Cygwin</a> +</ul> +<li><a href="Windows.html#Windows_interface_file">Microsoft extensions and other Windows quirks</a> +</ul> +</div> +<!-- INDEX --> + +<h3><a href="Scripting.html#Scripting">4 Scripting Languages</a></h3> + +<!-- INDEX --> +<div class="sectiontoc"> +<ul> +<li><a href="Scripting.html#Scripting_nn2">The two language view of the world</a> +<li><a href="Scripting.html#Scripting_nn3">How does a scripting language talk to C?</a> +<ul> +<li><a href="Scripting.html#Scripting_nn4">Wrapper functions</a> +<li><a href="Scripting.html#Scripting_nn5">Variable linking</a> +<li><a href="Scripting.html#Scripting_nn6">Constants</a> +<li><a href="Scripting.html#Scripting_nn7">Structures and classes</a> +<li><a href="Scripting.html#Scripting_nn8">Proxy classes</a> +</ul> +<li><a href="Scripting.html#Scripting_nn9">Building scripting language extensions</a> +<ul> +<li><a href="Scripting.html#Scripting_nn10">Shared libraries and dynamic loading</a> +<li><a href="Scripting.html#Scripting_nn11">Linking with shared libraries</a> +<li><a href="Scripting.html#Scripting_nn12">Static linking</a> +</ul> +</ul> +</div> +<!-- INDEX --> + +<h3><a href="SWIG.html#SWIG">5 SWIG Basics</a></h3> + +<!-- INDEX --> +<div class="sectiontoc"> +<ul> +<li><a href="SWIG.html#SWIG_nn2">Running SWIG</a> +<ul> +<li><a href="SWIG.html#SWIG_nn3">Input format</a> +<li><a href="SWIG.html#output">SWIG Output</a> +<li><a href="SWIG.html#SWIG_nn5">Comments</a> +<li><a href="SWIG.html#SWIG_nn6">C Preprocessor</a> +<li><a href="SWIG.html#SWIG_nn7">SWIG Directives</a> +<li><a href="SWIG.html#SWIG_nn8">Parser Limitations</a> +</ul> +<li><a href="SWIG.html#SWIG_nn9">Wrapping Simple C Declarations</a> +<ul> +<li><a href="SWIG.html#SWIG_nn10">Basic Type Handling</a> +<li><a href="SWIG.html#SWIG_nn11">Global Variables</a> +<li><a href="SWIG.html#SWIG_nn12">Constants</a> +<li><a href="SWIG.html#SWIG_nn13">A brief word about <tt>const</tt></a> +<li><a href="SWIG.html#SWIG_nn14">A cautionary tale of <tt>char *</tt></a> +</ul> +<li><a href="SWIG.html#SWIG_nn15">Pointers and complex objects</a> +<ul> +<li><a href="SWIG.html#SWIG_nn16">Simple pointers</a> +<li><a href="SWIG.html#SWIG_nn17">Run time pointer type checking</a> +<li><a href="SWIG.html#SWIG_nn18">Derived types, structs, and classes</a> +<li><a href="SWIG.html#SWIG_nn19">Undefined datatypes</a> +<li><a href="SWIG.html#SWIG_nn20">Typedef</a> +</ul> +<li><a href="SWIG.html#SWIG_nn21">Other Practicalities</a> +<ul> +<li><a href="SWIG.html#SWIG_nn22">Passing structures by value</a> +<li><a href="SWIG.html#SWIG_nn23">Return by value</a> +<li><a href="SWIG.html#SWIG_nn24">Linking to structure variables</a> +<li><a href="SWIG.html#SWIG_nn25">Linking to <tt>char *</tt></a> +<li><a href="SWIG.html#SWIG_nn26">Arrays</a> +<li><a href="SWIG.html#SWIG_readonly_variables">Creating read-only variables</a> +<li><a href="SWIG.html#SWIG_rename_ignore">Renaming and ignoring declarations</a> +<li><a href="SWIG.html#SWIG_default_args">Default/optional arguments</a> +<li><a href="SWIG.html#SWIG_nn30">Pointers to functions and callbacks</a> +</ul> +<li><a href="SWIG.html#SWIG_nn31">Structures and unions</a> +<ul> +<li><a href="SWIG.html#SWIG_nn32">Typedef and structures</a> +<li><a href="SWIG.html#SWIG_nn33">Character strings and structures</a> +<li><a href="SWIG.html#SWIG_nn34">Array members</a> +<li><a href="SWIG.html#SWIG_structure_data_members">Structure data members</a> +<li><a href="SWIG.html#SWIG_nn36">C constructors and destructors </a> +<li><a href="SWIG.html#SWIG_adding_member_functions">Adding member functions to C structures</a> +<li><a href="SWIG.html#SWIG_nested_structs">Nested structures</a> +<li><a href="SWIG.html#SWIG_nn39">Other things to note about structure wrapping</a> +</ul> +<li><a href="SWIG.html#SWIG_nn40">Code Insertion</a> +<ul> +<li><a href="SWIG.html#SWIG_nn41">The output of SWIG</a> +<li><a href="SWIG.html#SWIG_nn42">Code insertion blocks</a> +<li><a href="SWIG.html#SWIG_nn43">Inlined code blocks</a> +<li><a href="SWIG.html#SWIG_nn44">Initialization blocks</a> +</ul> +<li><a href="SWIG.html#SWIG_nn45">An Interface Building Strategy</a> +<ul> +<li><a href="SWIG.html#SWIG_nn46">Preparing a C program for SWIG</a> +<li><a href="SWIG.html#SWIG_nn47">The SWIG interface file</a> +<li><a href="SWIG.html#SWIG_nn48">Why use separate interface files?</a> +<li><a href="SWIG.html#SWIG_nn49">Getting the right header files</a> +<li><a href="SWIG.html#SWIG_nn50">What to do with main()</a> +</ul> +</ul> +</div> +<!-- INDEX --> + +<h3><a href="SWIGPlus.html#SWIGPlus">6 SWIG and C++</a></h3> + +<!-- INDEX --> +<div class="sectiontoc"> +<ul> +<li><a href="SWIGPlus.html#SWIGPlus_nn2">Comments on C++ Wrapping</a> +<li><a href="SWIGPlus.html#SWIGPlus_nn3">Approach</a> +<li><a href="SWIGPlus.html#SWIGPlus_nn4">Supported C++ features</a> +<li><a href="SWIGPlus.html#SWIGPlus_nn5">Command line options and compilation</a> +<li><a href="SWIGPlus.html#SWIGPlus_nn38">Proxy classes</a> +<ul> +<li><a href="SWIGPlus.html#SWIGPlus_nn39">Construction of proxy classes</a> +<li><a href="SWIGPlus.html#SWIGPlus_nn40">Resource management in proxies</a> +<li><a href="SWIGPlus.html#SWIGPlus_nn41">Language specific details</a> +</ul> +<li><a href="SWIGPlus.html#SWIGPlus_nn6">Simple C++ wrapping</a> +<ul> +<li><a href="SWIGPlus.html#SWIGPlus_nn7">Constructors and destructors</a> +<li><a href="SWIGPlus.html#SWIGPlus_nn8">Default constructors, copy constructors and implicit destructors</a> +<li><a href="SWIGPlus.html#SWIGPlus_nn9">When constructor wrappers aren't created</a> +<li><a href="SWIGPlus.html#SWIGPlus_nn10">Copy constructors</a> +<li><a href="SWIGPlus.html#SWIGPlus_nn11">Member functions</a> +<li><a href="SWIGPlus.html#SWIGPlus_nn12">Static members</a> +<li><a href="SWIGPlus.html#SWIGPlus_member_data">Member data</a> +</ul> +<li><a href="SWIGPlus.html#SWIGPlus_default_args">Default arguments</a> +<li><a href="SWIGPlus.html#SWIGPlus_nn15">Protection</a> +<li><a href="SWIGPlus.html#SWIGPlus_nn16">Enums and constants</a> +<li><a href="SWIGPlus.html#SWIGPlus_nn17">Friends</a> +<li><a href="SWIGPlus.html#SWIGPlus_nn18">References and pointers</a> +<li><a href="SWIGPlus.html#SWIGPlus_nn19">Pass and return by value</a> +<li><a href="SWIGPlus.html#SWIGPlus_nn20">Inheritance</a> +<li><a href="SWIGPlus.html#SWIGPlus_nn21">A brief discussion of multiple inheritance, pointers, and type checking</a> +<li><a href="SWIGPlus.html#SWIGPlus_overloaded_methods">Wrapping Overloaded Functions and Methods</a> +<ul> +<li><a href="SWIGPlus.html#SWIGPlus_nn24">Dispatch function generation</a> +<li><a href="SWIGPlus.html#SWIGPlus_nn25">Ambiguity in Overloading</a> +<li><a href="SWIGPlus.html#ambiguity_resolution_renaming">Ambiguity resolution and renaming</a> +<li><a href="SWIGPlus.html#SWIGPlus_nn27">Comments on overloading</a> +</ul> +<li><a href="SWIGPlus.html#SWIGPlus_nn28">Wrapping overloaded operators</a> +<li><a href="SWIGPlus.html#SWIGPlus_class_extension">Class extension</a> +<li><a href="SWIGPlus.html#SWIGPlus_nn30">Templates</a> +<li><a href="SWIGPlus.html#SWIGPlus_nn31">Namespaces</a> +<li><a href="SWIGPlus.html#SWIGPlus_renaming_templated_types_namespaces">Renaming templated types in namespaces</a> +<li><a href="SWIGPlus.html#SWIGPlus_exception_specifications">Exception specifications</a> +<li><a href="SWIGPlus.html#SWIGPlus_catches">Exception handling with %catches</a> +<li><a href="SWIGPlus.html#SWIGPlus_nn33">Pointers to Members</a> +<li><a href="SWIGPlus.html#SWIGPlus_nn34">Smart pointers and operator->()</a> +<li><a href="SWIGPlus.html#SWIGPlus_nn35">Using declarations and inheritance</a> +<li><a href="SWIGPlus.html#SWIGPlus_nested_classes">Nested classes</a> +<li><a href="SWIGPlus.html#SWIGPlus_nn37">A brief rant about const-correctness</a> +<li><a href="SWIGPlus.html#SWIGPlus_nn42">Where to go for more information</a> +</ul> +</div> +<!-- INDEX --> + +<h3><a href="Preprocessor.html#Preprocessor">7 Preprocessing</a></h3> + +<!-- INDEX --> +<div class="sectiontoc"> +<ul> +<li><a href="Preprocessor.html#Preprocessor_nn2">File inclusion</a> +<li><a href="Preprocessor.html#Preprocessor_nn3">File imports</a> +<li><a href="Preprocessor.html#Preprocessor_condition_compilation">Conditional Compilation</a> +<li><a href="Preprocessor.html#Preprocessor_nn5">Macro Expansion</a> +<li><a href="Preprocessor.html#Preprocessor_nn6">SWIG Macros</a> +<li><a href="Preprocessor.html#Preprocessor_nn7">C99 and GNU Extensions</a> +<li><a href="Preprocessor.html#Preprocessor_nn8">Preprocessing and %{ ... %} & " ... " delimiters</a> +<li><a href="Preprocessor.html#Preprocessor_nn9">Preprocessing and { ... } delimiters</a> +<li><a href="Preprocessor.html#Preprocessor_typemap_delimiters">Preprocessor and Typemaps</a> +<li><a href="Preprocessor.html#Preprocessor_nn10">Viewing preprocessor output</a> +<li><a href="Preprocessor.html#Preprocessor_warning_error">The #error and #warning directives</a> +</ul> +</div> +<!-- INDEX --> + +<h3><a href="Library.html#Library">8 SWIG library</a></h3> + +<!-- INDEX --> +<div class="sectiontoc"> +<ul> +<li><a href="Library.html#Library_nn2">The %include directive and library search path</a> +<li><a href="Library.html#Library_nn3">C Arrays and Pointers</a> +<ul> +<li><a href="Library.html#Library_nn4">cpointer.i</a> +<li><a href="Library.html#Library_nn5">carrays.i</a> +<li><a href="Library.html#Library_nn6">cmalloc.i</a> +<li><a href="Library.html#Library_nn7">cdata.i</a> +</ul> +<li><a href="Library.html#Library_nn8">C String Handling</a> +<ul> +<li><a href="Library.html#Library_nn9">Default string handling</a> +<li><a href="Library.html#Library_nn10">Passing binary data</a> +<li><a href="Library.html#Library_nn11">Using %newobject to release memory</a> +<li><a href="Library.html#Library_nn12">cstring.i</a> +</ul> +<li><a href="Library.html#Library_stl_cpp_library">STL/C++ Library</a> +<ul> +<li><a href="Library.html#Library_nn14">std_string.i</a> +<li><a href="Library.html#Library_nn15">std_vector.i</a> +<li><a href="Library.html#Library_stl_exceptions">STL exceptions</a> +</ul> +<li><a href="Library.html#Library_nn16">Utility Libraries</a> +<ul> +<li><a href="Library.html#Library_nn17">exception.i</a> +</ul> +</ul> +</div> +<!-- INDEX --> + +<h3><a href="Arguments.html#Arguments">9 Argument Handling</a></h3> + +<!-- INDEX --> +<div class="sectiontoc"> +<ul> +<li><a href="Arguments.html#Arguments_nn2">The typemaps.i library</a> +<ul> +<li><a href="Arguments.html#Arguments_nn3">Introduction</a> +<li><a href="Arguments.html#Arguments_nn4">Input parameters</a> +<li><a href="Arguments.html#Arguments_nn5">Output parameters</a> +<li><a href="Arguments.html#Arguments_nn6">Input/Output parameters</a> +<li><a href="Arguments.html#Arguments_nn7">Using different names</a> +</ul> +<li><a href="Arguments.html#Arguments_nn8">Applying constraints to input values</a> +<ul> +<li><a href="Arguments.html#Arguments_nn9">Simple constraint example</a> +<li><a href="Arguments.html#Arguments_nn10">Constraint methods</a> +<li><a href="Arguments.html#Arguments_nn11">Applying constraints to new datatypes</a> +</ul> +</ul> +</div> +<!-- INDEX --> + +<h3><a href="Typemaps.html#Typemaps">10 Typemaps</a></h3> + +<!-- INDEX --> +<div class="sectiontoc"> +<ul> +<li><a href="Typemaps.html#Typemaps_nn2">Introduction</a> +<ul> +<li><a href="Typemaps.html#Typemaps_nn3">Type conversion</a> +<li><a href="Typemaps.html#Typemaps_nn4">Typemaps</a> +<li><a href="Typemaps.html#Typemaps_nn5">Pattern matching</a> +<li><a href="Typemaps.html#Typemaps_nn6">Reusing typemaps</a> +<li><a href="Typemaps.html#Typemaps_nn7">What can be done with typemaps?</a> +<li><a href="Typemaps.html#Typemaps_nn8">What can't be done with typemaps?</a> +<li><a href="Typemaps.html#Typemaps_nn9">The rest of this chapter</a> +</ul> +<li><a href="Typemaps.html#Typemaps_nn10">Typemap specifications</a> +<ul> +<li><a href="Typemaps.html#Typemaps_nn11">Defining a typemap</a> +<li><a href="Typemaps.html#Typemaps_nn12">Typemap scope</a> +<li><a href="Typemaps.html#Typemaps_nn13">Copying a typemap</a> +<li><a href="Typemaps.html#Typemaps_nn14">Deleting a typemap</a> +<li><a href="Typemaps.html#Typemaps_nn15">Placement of typemaps</a> +</ul> +<li><a href="Typemaps.html#Typemaps_nn16">Pattern matching rules</a> +<ul> +<li><a href="Typemaps.html#Typemaps_nn17">Basic matching rules</a> +<li><a href="Typemaps.html#Typemaps_nn18">Typedef reductions</a> +<li><a href="Typemaps.html#Typemaps_nn19">Default typemaps</a> +<li><a href="Typemaps.html#Typemaps_mixed_default">Mixed default typemaps</a> +<li><a href="Typemaps.html#Typemaps_nn20">Multi-arguments typemaps</a> +</ul> +<li><a href="Typemaps.html#Typemaps_nn21">Code generation rules</a> +<ul> +<li><a href="Typemaps.html#Typemaps_nn22">Scope</a> +<li><a href="Typemaps.html#Typemaps_nn23">Declaring new local variables</a> +<li><a href="Typemaps.html#Typemaps_special_variables">Special variables</a> +</ul> +<li><a href="Typemaps.html#Typemaps_nn25">Common typemap methods</a> +<ul> +<li><a href="Typemaps.html#Typemaps_nn26">"in" typemap</a> +<li><a href="Typemaps.html#Typemaps_nn27">"typecheck" typemap</a> +<li><a href="Typemaps.html#Typemaps_nn28">"out" typemap</a> +<li><a href="Typemaps.html#Typemaps_nn29">"arginit" typemap</a> +<li><a href="Typemaps.html#Typemaps_nn30">"default" typemap</a> +<li><a href="Typemaps.html#Typemaps_nn31">"check" typemap</a> +<li><a href="Typemaps.html#Typemaps_nn32">"argout" typemap</a> +<li><a href="Typemaps.html#Typemaps_nn33">"freearg" typemap</a> +<li><a href="Typemaps.html#Typemaps_nn34">"newfree" typemap</a> +<li><a href="Typemaps.html#Typemaps_nn35">"memberin" typemap</a> +<li><a href="Typemaps.html#Typemaps_nn36">"varin" typemap</a> +<li><a href="Typemaps.html#Typemaps_nn37">"varout" typemap</a> +<li><a href="Typemaps.html#throws_typemap">"throws" typemap</a> +</ul> +<li><a href="Typemaps.html#Typemaps_nn39">Some typemap examples</a> +<ul> +<li><a href="Typemaps.html#Typemaps_nn40">Typemaps for arrays</a> +<li><a href="Typemaps.html#Typemaps_nn41">Implementing constraints with typemaps</a> +</ul> +<li><a href="Typemaps.html#Typemaps_nn43">Typemaps for multiple languages</a> +<li><a href="Typemaps.html#Typemaps_nn42">Multi-argument typemaps</a> +<li><a href="Typemaps.html#runtime_type_checker">The run-time type checker</a> +<ul> +<li><a href="Typemaps.html#Typemaps_nn45">Implementation</a> +<li><a href="Typemaps.html#Typemaps_nn46">Usage</a> +</ul> +<li><a href="Typemaps.html#Typemaps_overloading">Typemaps and overloading</a> +<li><a href="Typemaps.html#Typemaps_nn48">More about <tt>%apply</tt> and <tt>%clear</tt></a> +<li><a href="Typemaps.html#Typemaps_nn49">Reducing wrapper code size</a> +<li><a href="Typemaps.html#Typemaps_nn47">Passing data between typemaps</a> +<li><a href="Typemaps.html#Typemaps_nn51">Where to go for more information?</a> +</ul> +</div> +<!-- INDEX --> + +<h3><a href="Customization.html#Customization">11 Customization Features</a></h3> + +<!-- INDEX --> +<div class="sectiontoc"> +<ul> +<li><a href="Customization.html#exception">Exception handling with %exception</a> +<ul> +<li><a href="Customization.html#Customization_nn3">Handling exceptions in C code</a> +<li><a href="Customization.html#Customization_nn4">Exception handling with longjmp()</a> +<li><a href="Customization.html#Customization_nn5">Handling C++ exceptions</a> +<li><a href="Customization.html#Customization_allowexcept">Exception handlers for variables</a> +<li><a href="Customization.html#Customization_nn6">Defining different exception handlers</a> +<li><a href="Customization.html#Customization_exception_special_variables">Special variables for %exception</a> +<li><a href="Customization.html#Customization_nn7">Using The SWIG exception library</a> +</ul> +<li><a href="Customization.html#ownership">Object ownership and %newobject</a> +<li><a href="Customization.html#features">Features and the %feature directive</a> +<ul> +<li><a href="Customization.html#Customization_feature_attributes">Feature attributes</a> +<li><a href="Customization.html#Customization_feature_flags">Feature flags</a> +<li><a href="Customization.html#Customization_clearing_features">Clearing features</a> +<li><a href="Customization.html#Customization_features_default_args">Features and default arguments</a> +<li><a href="Customization.html#features_example">Feature example</a> +</ul> +</ul> +</div> +<!-- INDEX --> + +<h3><a href="Contract.html#Contract">12 Contracts</a></h3> + +<!-- INDEX --> +<div class="sectiontoc"> +<ul> +<li><a href="Contract.html#Contract_nn2">The %contract directive</a> +<li><a href="Contract.html#Contract_nn3">%contract and classes</a> +<li><a href="Contract.html#Contract_nn4">Constant aggregation and %aggregate_check</a> +<li><a href="Contract.html#Contract_nn5">Notes</a> +</ul> +</div> +<!-- INDEX --> + +<h3><a href="Varargs.html#Varargs">13 Variable Length Arguments</a></h3> + +<!-- INDEX --> +<div class="sectiontoc"> +<ul> +<li><a href="Varargs.html#Varargs_nn2">Introduction</a> +<li><a href="Varargs.html#Varargs_nn3">The Problem</a> +<li><a href="Varargs.html#Varargs_nn4">Default varargs support</a> +<li><a href="Varargs.html#Varargs_nn5">Argument replacement using %varargs</a> +<li><a href="Varargs.html#Varargs_nn6">Varargs and typemaps</a> +<li><a href="Varargs.html#Varargs_nn7">Varargs wrapping with libffi</a> +<li><a href="Varargs.html#Varargs_nn8">Wrapping of va_list</a> +<li><a href="Varargs.html#Varargs_nn9">C++ Issues</a> +<li><a href="Varargs.html#Varargs_nn10">Discussion</a> +</ul> +</div> +<!-- INDEX --> + +<h3><a href="Warnings.html#Warnings">14 Warning Messages</a></h3> + +<!-- INDEX --> +<div class="sectiontoc"> +<ul> +<li><a href="Warnings.html#Warnings_nn2">Introduction</a> +<li><a href="Warnings.html#Warnings_suppression">Warning message suppression</a> +<li><a href="Warnings.html#Warnings_nn4">Enabling extra warnings</a> +<li><a href="Warnings.html#Warnings_nn5">Issuing a warning message</a> +<li><a href="Warnings.html#Warnings_symbolic_symbols">Symbolic symbols</a> +<li><a href="Warnings.html#Warnings_nn6">Commentary</a> +<li><a href="Warnings.html#Warnings_nn7">Warnings as errors</a> +<li><a href="Warnings.html#Warnings_nn8">Message output format</a> +<li><a href="Warnings.html#Warnings_nn9">Warning number reference</a> +<ul> +<li><a href="Warnings.html#Warnings_nn10">Deprecated features (100-199)</a> +<li><a href="Warnings.html#Warnings_nn11">Preprocessor (200-299)</a> +<li><a href="Warnings.html#Warnings_nn12">C/C++ Parser (300-399)</a> +<li><a href="Warnings.html#Warnings_nn13">Types and typemaps (400-499) </a> +<li><a href="Warnings.html#Warnings_nn14">Code generation (500-599)</a> +<li><a href="Warnings.html#Warnings_nn15">Language module specific (800-899) </a> +<li><a href="Warnings.html#Warnings_nn16">User defined (900-999)</a> +</ul> +<li><a href="Warnings.html#Warnings_nn17">History</a> +</ul> +</div> +<!-- INDEX --> + +<h3><a href="Modules.html#Modules">15 Working with Modules</a></h3> + +<!-- INDEX --> +<div class="sectiontoc"> +<ul> +<li><a href="Modules.html#Modules_nn1">Basics</a> +<li><a href="Modules.html#Modules_nn2">The SWIG runtime code</a> +<li><a href="Modules.html#external_run_time">External access to the runtime</a> +<li><a href="Modules.html#Modules_nn4">A word of caution about static libraries</a> +<li><a href="Modules.html#Modules_nn5">References</a> +<li><a href="Modules.html#Modules_nn6">Reducing the wrapper file size</a> +</ul> +</div> +<!-- INDEX --> + +<h3><a href="Allegrocl.html#Allegrocl">16 SWIG and Allegro Common Lisp</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -93,81 +580,7 @@ </div> <!-- INDEX --> -<h3><a href="Arguments.html#Arguments">2 Argument Handling</a></h3> - -<!-- INDEX --> -<div class="sectiontoc"> -<ul> -<li><a href="Arguments.html#Arguments_nn2">The typemaps.i library</a> -<ul> -<li><a href="Arguments.html#Arguments_nn3">Introduction</a> -<li><a href="Arguments.html#Arguments_nn4">Input parameters</a> -<li><a href="Arguments.html#Arguments_nn5">Output parameters</a> -<li><a href="Arguments.html#Arguments_nn6">Input/Output parameters</a> -<li><a href="Arguments.html#Arguments_nn7">Using different names</a> -</ul> -<li><a href="Arguments.html#Arguments_nn8">Applying constraints to input values</a> -<ul> -<li><a href="Arguments.html#Arguments_nn9">Simple constraint example</a> -<li><a href="Arguments.html#Arguments_nn10">Constraint methods</a> -<li><a href="Arguments.html#Arguments_nn11">Applying constraints to new datatypes</a> -</ul> -</ul> -</div> -<!-- INDEX --> - -<h3><a href="Chicken.html#Chicken">3 SWIG and Chicken</a></h3> - -<!-- INDEX --> -<div class="sectiontoc"> -<ul> -<li><a href="Chicken.html#Chicken_nn2">Preliminaries</a> -<ul> -<li><a href="Chicken.html#Chicken_nn3">Running SWIG in C mode</a> -<li><a href="Chicken.html#Chicken_nn4">Running SWIG in C++ mode</a> -</ul> -<li><a href="Chicken.html#Chicken_nn5">Code Generation</a> -<ul> -<li><a href="Chicken.html#Chicken_nn6">Naming Conventions</a> -<li><a href="Chicken.html#Chicken_nn7">Modules</a> -<li><a href="Chicken.html#Chicken_nn8">Constants and Variables</a> -<li><a href="Chicken.html#Chicken_nn9">Functions</a> -<li><a href="Chicken.html#Chicken_nn10">Exceptions</a> -</ul> -<li><a href="Chicken.html#Chicken_nn11">TinyCLOS</a> -<li><a href="Chicken.html#Chicken_nn12">Linkage</a> -<ul> -<li><a href="Chicken.html#Chicken_nn13">Static binary or shared library linked at compile time</a> -<li><a href="Chicken.html#Chicken_nn14">Building chicken extension libraries</a> -<li><a href="Chicken.html#Chicken_nn15">Linking multiple SWIG modules with TinyCLOS</a> -</ul> -<li><a href="Chicken.html#Chicken_nn16">Typemaps</a> -<li><a href="Chicken.html#Chicken_nn17">Pointers</a> -<ul> -<li><a href="Chicken.html#collection">Garbage collection</a> -</ul> -<li><a href="Chicken.html#Chicken_nn18">Unsupported features and known problems</a> -<ul> -<li><a href="Chicken.html#Chicken_nn19">TinyCLOS problems with Chicken version <= 1.92</a> -</ul> -</ul> -</div> -<!-- INDEX --> - -<h3><a href="Contract.html#Contract">4 Contracts</a></h3> - -<!-- INDEX --> -<div class="sectiontoc"> -<ul> -<li><a href="Contract.html#Contract_nn2">The %contract directive</a> -<li><a href="Contract.html#Contract_nn3">%contract and classes</a> -<li><a href="Contract.html#Contract_nn4">Constant aggregation and %aggregate_check</a> -<li><a href="Contract.html#Contract_nn5">Notes</a> -</ul> -</div> -<!-- INDEX --> - -<h3><a href="CSharp.html#CSharp">5 SWIG and C#</a></h3> +<h3><a href="CSharp.html#CSharp">17 SWIG and C#</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -200,101 +613,45 @@ </div> <!-- INDEX --> -<h3><a href="Customization.html#Customization">6 Customization Features</a></h3> - -<!-- INDEX --> -<div class="sectiontoc"> -<ul> -<li><a href="Customization.html#exception">Exception handling with %exception</a> -<ul> -<li><a href="Customization.html#Customization_nn3">Handling exceptions in C code</a> -<li><a href="Customization.html#Customization_nn4">Exception handling with longjmp()</a> -<li><a href="Customization.html#Customization_nn5">Handling C++ exceptions</a> -<li><a href="Customization.html#Customization_allowexcept">Exception handlers for variables</a> -<li><a href="Customization.html#Customization_nn6">Defining different exception handlers</a> -<li><a href="Customization.html#Customization_exception_special_variables">Special variables for %exception</a> -<li><a href="Customization.html#Customization_nn7">Using The SWIG exception library</a> -</ul> -<li><a href="Customization.html#ownership">Object ownership and %newobject</a> -<li><a href="Customization.html#features">Features and the %feature directive</a> -<ul> -<li><a href="Customization.html#Customization_feature_attributes">Feature attributes</a> -<li><a href="Customization.html#Customization_feature_flags">Feature flags</a> -<li><a href="Customization.html#Customization_clearing_features">Clearing features</a> -<li><a href="Customization.html#Customization_features_default_args">Features and default arguments</a> -<li><a href="Customization.html#features_example">Feature example</a> -</ul> -</ul> -</div> -<!-- INDEX --> - -<h3><a href="Extending.html#Extending">7 Extending SWIG to support new languages</a></h3> +<h3><a href="Chicken.html#Chicken">18 SWIG and Chicken</a></h3> <!-- INDEX --> <div class="sectiontoc"> <ul> -<li><a href="Extending.html#Extending_nn2">Introduction</a> -<li><a href="Extending.html#Extending_nn3">Prerequisites</a> -<li><a href="Extending.html#Extending_nn4">The Big Picture</a> -<li><a href="Extending.html#Extending_nn5">Execution Model</a> +<li><a href="Chicken.html#Chicken_nn2">Preliminaries</a> <ul> -<li><a href="Extending.html#Extending_nn6">Preprocessing</a> -<li><a href="Extending.html#Extending_nn7">Parsing</a> -<li><a href="Extending.html#Extending_nn8">Parse Trees</a> -<li><a href="Extending.html#Extending_nn9">Attribute namespaces</a> -<li><a href="Extending.html#Extending_nn10">Symbol Tables</a> -<li><a href="Extending.html#Extending_nn11">The %feature directive</a> -<li><a href="Extending.html#Extending_nn12">Code Generation</a> -<li><a href="Extending.html#Extending_nn13">SWIG and XML</a> +<li><a href="Chicken.html#Chicken_nn3">Running SWIG in C mode</a> +<li><a href="Chicken.html#Chicken_nn4">Running SWIG in C++ mode</a> </ul> -<li><a href="Extending.html#Extending_nn14">Primitive Data Structures</a> +<li><a href="Chicken.html#Chicken_nn5">Code Generation</a> <ul> -<li><a href="Extending.html#Extending_nn15">Strings</a> -<li><a href="Extending.html#Extending_nn16">Hashes</a> -<li><a href="Extending.html#Extending_nn17">Lists</a> -<li><a href="Extending.html#Extending_nn18">Common operations</a> -<li><a href="Extending.html#Extending_nn19">Iterating over Lists and Hashes</a> -<li><a href="Extending.html#Extending_nn20">I/O</a> +<li><a href="Chicken.html#Chicken_nn6">Naming Conventions</a> +<li><a href="Chicken.html#Chicken_nn7">Modules</a> +<li><a href="Chicken.html#Chicken_nn8">Constants and Variables</a> +<li><a href="Chicken.html#Chicken_nn9">Functions</a> +<li><a href="Chicken.html#Chicken_nn10">Exceptions</a> </ul> -<li><a href="Extending.html#Extending_nn21">Navigating and manipulating parse trees</a> -<li><a href="Extending.html#Extending_nn22">Working with attributes</a> -<li><a href="Extending.html#Extending_nn23">Type system</a> +<li><a href="Chicken.html#Chicken_nn11">TinyCLOS</a> +<li><a href="Chicken.html#Chicken_nn12">Linkage</a> <ul> -<li><a href="Extending.html#Extending_nn24">String encoding of types</a> -<li><a href="Extending.html#Extending_nn25">Type construction</a> -<li><a href="Extending.html#Extending_nn26">Type tests</a> -<li><a href="Extending.html#Extending_nn27">Typedef and inheritance</a> -<li><a href="Extending.html#Extending_nn28">Lvalues</a> -<li><a href="Extending.html#Extending_nn29">Output functions</a> +<li><a href="Chicken.html#Chicken_nn13">Static binary or shared library linked at compile time</a> +<li><a href="Chicken.html#Chicken_nn14">Building chicken extension libraries</a> +<li><a href="Chicken.html#Chicken_nn15">Linking multiple SWIG modules with TinyCLOS</a> </ul> -<li><a href="Extending.html#Extending_nn30">Parameters</a> -<li><a href="Extending.html#Extending_nn31">Writing a Language Module</a> +<li><a href="Chicken.html#Chicken_nn16">Typemaps</a> +<li><a href="Chicken.html#Chicken_nn17">Pointers</a> <ul> -<li><a href="Extending.html#Extending_nn32">Execution model</a> -<li><a href="Extending.html#Extending_nn33">Starting out</a> -<li><a href="Extending.html#Extending_nn34">Command line options</a> -<li><a href="Extending.html#Extending_nn35">Configuration and preprocessing</a> -<li><a href="Extending.html#Extending_nn36">Entry point to code generation</a> -<li><a href="Extending.html#Extending_nn37">Module I/O and wrapper skeleton</a> -<li><a href="Extending.html#Extending_nn38">Low-level code generators</a> -<li><a href="Extending.html#Extending_nn39">Configuration files</a> -<li><a href="Extending.html#Extending_nn40">Runtime support</a> -<li><a href="Extending.html#Extending_nn41">Standard library files</a> -<li><a href="Extending.html#Extending_nn42">Examples and test cases</a> -<li><a href="Extending.html#Extending_nn43">Documentation</a> -<li><a href="Extending.html#Extending_prerequisites">Prerequisites for adding a new language module to the SWIG distribution</a> -<li><a href="Extending.html#Extending_coding_style_guidelines">Coding style guidelines</a> +<li><a href="Chicken.html#collection">Garbage collection</a> </ul> -<li><a href="Extending.html#Extending_nn44">Typemaps</a> +<li><a href="Chicken.html#Chicken_nn18">Unsupported features and known problems</a> <ul> -<li><a href="Extending.html#Extending_nn45">Proxy classes</a> +<li><a href="Chicken.html#Chicken_nn19">TinyCLOS problems with Chicken version <= 1.92</a> </ul> -<li><a href="Extending.html#Extending_nn46">Guide to parse tree nodes</a> </ul> </div> <!-- INDEX --> -<h3><a href="Guile.html#Guile">8 SWIG and Guile</a></h3> +<h3><a href="Guile.html#Guile">19 SWIG and Guile</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -329,31 +686,7 @@ </div> <!-- INDEX --> -<h3><a href="Introduction.html#Introduction">9 Introduction</a></h3> - -<!-- INDEX --> -<div class="sectiontoc"> -<ul> -<li><a href="Introduction.html#Introduction_nn2">What is SWIG?</a> -<li><a href="Introduction.html#Introduction_nn3">Why use SWIG?</a> -<li><a href="Introduction.html#Introduction_nn4">A SWIG example</a> -<ul> -<li><a href="Introduction.html#Introduction_nn5">SWIG interface file</a> -<li><a href="Introduction.html#Introduction_nn6">The swig command</a> -<li><a href="Introduction.html#Introduction_nn7">Building a Perl5 module</a> -<li><a href="Introduction.html#Introduction_nn8">Building a Python module</a> -<li><a href="Introduction.html#Introduction_nn9">Shortcuts</a> -</ul> -<li><a href="Introduction.html#Introduction_nn10">Supported C/C++ language features</a> -<li><a href="Introduction.html#Introduction_nn11">Non-intrusive interface building</a> -<li><a href="Introduction.html#Introduction_build_system">Incorporating SWIG into a build system</a> -<li><a href="Introduction.html#Introduction_nn12">Hands off code generation</a> -<li><a href="Introduction.html#Introduction_nn13">SWIG and freedom</a> -</ul> -</div> -<!-- INDEX --> - -<h3><a href="Java.html#Java">10 SWIG and Java</a></h3> +<h3><a href="Java.html#Java">20 SWIG and Java</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -492,41 +825,7 @@ </div> <!-- INDEX --> -<h3><a href="Library.html#Library">11 SWIG library</a></h3> - -<!-- INDEX --> -<div class="sectiontoc"> -<ul> -<li><a href="Library.html#Library_nn2">The %include directive and library search path</a> -<li><a href="Library.html#Library_nn3">C Arrays and Pointers</a> -<ul> -<li><a href="Library.html#Library_nn4">cpointer.i</a> -<li><a href="Library.html#Library_nn5">carrays.i</a> -<li><a href="Library.html#Library_nn6">cmalloc.i</a> -<li><a href="Library.html#Library_nn7">cdata.i</a> -</ul> -<li><a href="Library.html#Library_nn8">C String Handling</a> -<ul> -<li><a href="Library.html#Library_nn9">Default string handling</a> -<li><a href="Library.html#Library_nn10">Passing binary data</a> -<li><a href="Library.html#Library_nn11">Using %newobject to release memory</a> -<li><a href="Library.html#Library_nn12">cstring.i</a> -</ul> -<li><a href="Library.html#Library_stl_cpp_library">STL/C++ Library</a> -<ul> -<li><a href="Library.html#Library_nn14">std_string.i</a> -<li><a href="Library.html#Library_nn15">std_vector.i</a> -<li><a href="Library.html#Library_stl_exceptions">STL exceptions</a> -</ul> -<li><a href="Library.html#Library_nn16">Utility Libraries</a> -<ul> -<li><a href="Library.html#Library_nn17">exception.i</a> -</ul> -</ul> -</div> -<!-- INDEX --> - -<h3><a href="Lisp.html#Lisp">12 SWIG and Common Lisp</a></h3> +<h3><a href="Lisp.html#Lisp">21 SWIG and Common Lisp</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -549,7 +848,7 @@ </div> <!-- INDEX --> -<h3><a href="Lua.html#Lua">13 SWIG and Lua</a></h3> +<h3><a href="Lua.html#Lua">22 SWIG and Lua</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -589,7 +888,7 @@ </div> <!-- INDEX --> -<h3><a href="Modula3.html#Modula3">14 SWIG and Modula-3</a></h3> +<h3><a href="Modula3.html#Modula3">23 SWIG and Modula-3</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -630,22 +929,7 @@ </div> <!-- INDEX --> -<h3><a href="Modules.html#Modules">15 Working with Modules</a></h3> - -<!-- INDEX --> -<div class="sectiontoc"> -<ul> -<li><a href="Modules.html#Modules_nn1">Basics</a> -<li><a href="Modules.html#Modules_nn2">The SWIG runtime code</a> -<li><a href="Modules.html#external_run_time">External access to the runtime</a> -<li><a href="Modules.html#Modules_nn4">A word of caution about static libraries</a> -<li><a href="Modules.html#Modules_nn5">References</a> -<li><a href="Modules.html#Modules_nn6">Reducing the wrapper file size</a> -</ul> -</div> -<!-- INDEX --> - -<h3><a href="Mzscheme.html#Mzscheme">16 SWIG and MzScheme</a></h3> +<h3><a href="Mzscheme.html#Mzscheme">24 SWIG and MzScheme</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -655,7 +939,7 @@ </div> <!-- INDEX --> -<h3><a href="Ocaml.html#Ocaml">17 SWIG and Ocaml</a></h3> +<h3><a href="Ocaml.html#Ocaml">25 SWIG and Ocaml</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -706,7 +990,7 @@ </div> <!-- INDEX --> -<h3><a href="Octave.html#Octave">18 SWIG and Octave</a></h3> +<h3><a href="Octave.html#Octave">26 SWIG and Octave</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -743,7 +1027,7 @@ </div> <!-- INDEX --> -<h3><a href="Perl5.html#Perl5">19 SWIG and Perl5</a></h3> +<h3><a href="Perl5.html#Perl5">27 SWIG and Perl5</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -810,7 +1094,7 @@ </div> <!-- INDEX --> -<h3><a href="Php.html#Php">20 SWIG and PHP</a></h3> +<h3><a href="Php.html#Php">28 SWIG and PHP</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -841,7 +1125,7 @@ </div> <!-- INDEX --> -<h3><a href="Pike.html#Pike">21 SWIG and Pike</a></h3> +<h3><a href="Pike.html#Pike">29 SWIG and Pike</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -865,46 +1149,7 @@ </div> <!-- INDEX --> -<h3><a href="Preface.html#Preface">22 Preface</a></h3> - -<!-- INDEX --> -<div class="sectiontoc"> -<ul> -<li><a href="Preface.html#Preface_nn2">Introduction</a> -<li><a href="Preface.html#Preface_nn3">Special Introduction for Version 1.3</a> -<li><a href="Preface.html#Preface_nn4">SWIG Versions</a> -<li><a href="Preface.html#Preface_nn5">SWIG resources</a> -<li><a href="Preface.html#Preface_nn6">Prerequisites</a> -<li><a href="Preface.html#Preface_nn7">Organization of this manual</a> -<li><a href="Preface.html#Preface_nn8">How to avoid reading the manual</a> -<li><a href="Preface.html#Preface_nn9">Backwards Compatibility</a> -<li><a href="Preface.html#Preface_nn10">Credits</a> -<li><a href="Preface.html#Preface_nn11">Bug reports</a> -</ul> -</div> -<!-- INDEX --> - -<h3><a href="Preprocessor.html#Preprocessor">23 Preprocessing</a></h3> - -<!-- INDEX --> -<div class="sectiontoc"> -<ul> -<li><a href="Preprocessor.html#Preprocessor_nn2">File inclusion</a> -<li><a href="Preprocessor.html#Preprocessor_nn3">File imports</a> -<li><a href="Preprocessor.html#Preprocessor_condition_compilation">Conditional Compilation</a> -<li><a href="Preprocessor.html#Preprocessor_nn5">Macro Expansion</a> -<li><a href="Preprocessor.html#Preprocessor_nn6">SWIG Macros</a> -<li><a href="Preprocessor.html#Preprocessor_nn7">C99 and GNU Extensions</a> -<li><a href="Preprocessor.html#Preprocessor_nn8">Preprocessing and %{ ... %} & " ... " delimiters</a> -<li><a href="Preprocessor.html#Preprocessor_nn9">Preprocessing and { ... } delimiters</a> -<li><a href="Preprocessor.html#Preprocessor_typemap_delimiters">Preprocessor and Typemaps</a> -<li><a href="Preprocessor.html#Preprocessor_nn10">Viewing preprocessor output</a> -<li><a href="Preprocessor.html#Preprocessor_warning_error">The #error and #warning directives</a> -</ul> -</div> -<!-- INDEX --> - -<h3><a href="Python.html#Python">24 SWIG and Python</a></h3> +<h3><a href="Python.html#Python">30 SWIG and Python</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -1004,23 +1249,7 @@ </div> <!-- INDEX --> -<h3><a href="R.html#R">25 SWIG and R</a></h3> - -<!-- INDEX --> -<div class="sectiontoc"> -<ul> -<li><a href="R.html#R_nn2">Bugs</a> -<li><a href="R.html#R_nn3">Using R and SWIG</a> -<li><a href="R.html#R_nn4">Precompiling large R files</a> -<li><a href="R.html#R_nn5">General policy</a> -<li><a href="R.html#R_language_conventions">Language conventions</a> -<li><a href="R.html#R_nn6">C++ classes</a> -<li><a href="R.html#R_nn7">Enumerations</a> -</ul> -</div> -<!-- INDEX --> - -<h3><a href="Ruby.html#Ruby">26 SWIG and Ruby</a></h3> +<h3><a href="Ruby.html#Ruby">31 SWIG and Ruby</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -1154,160 +1383,7 @@ </div> <!-- INDEX --> -<h3><a href="Scripting.html#Scripting">27 Scripting Languages</a></h3> - -<!-- INDEX --> -<div class="sectiontoc"> -<ul> -<li><a href="Scripting.html#Scripting_nn2">The two language view of the world</a> -<li><a href="Scripting.html#Scripting_nn3">How does a scripting language talk to C?</a> -<ul> -<li><a href="Scripting.html#Scripting_nn4">Wrapper functions</a> -<li><a href="Scripting.html#Scripting_nn5">Variable linking</a> -<li><a href="Scripting.html#Scripting_nn6">Constants</a> -<li><a href="Scripting.html#Scripting_nn7">Structures and classes</a> -<li><a href="Scripting.html#Scripting_nn8">Proxy classes</a> -</ul> -<li><a href="Scripting.html#Scripting_nn9">Building scripting language extensions</a> -<ul> -<li><a href="Scripting.html#Scripting_nn10">Shared libraries and dynamic loading</a> -<li><a href="Scripting.html#Scripting_nn11">Linking with shared libraries</a> -<li><a href="Scripting.html#Scripting_nn12">Static linking</a> -</ul> -</ul> -</div> -<!-- INDEX --> - -<h3><a href="SWIG.html#SWIG">28 SWIG Basics</a></h3> - -<!-- INDEX --> -<div class="sectiontoc"> -<ul> -<li><a href="SWIG.html#SWIG_nn2">Running SWIG</a> -<ul> -<li><a href="SWIG.html#SWIG_nn3">Input format</a> -<li><a href="SWIG.html#output">SWIG Output</a> -<li><a href="SWIG.html#SWIG_nn5">Comments</a> -<li><a href="SWIG.html#SWIG_nn6">C Preprocessor</a> -<li><a href="SWIG.html#SWIG_nn7">SWIG Directives</a> -<li><a href="SWIG.html#SWIG_nn8">Parser Limitations</a> -</ul> -<li><a href="SWIG.html#SWIG_nn9">Wrapping Simple C Declarations</a> -<ul> -<li><a href="SWIG.html#SWIG_nn10">Basic Type Handling</a> -<li><a href="SWIG.html#SWIG_nn11">Global Variables</a> -<li><a href="SWIG.html#SWIG_nn12">Constants</a> -<li><a href="SWIG.html#SWIG_nn13">A brief word about <tt>const</tt></a> -<li><a href="SWIG.html#SWIG_nn14">A cautionary tale of <tt>char *</tt></a> -</ul> -<li><a href="SWIG.html#SWIG_nn15">Pointers and complex objects</a> -<ul> -<li><a href="SWIG.html#SWIG_nn16">Simple pointers</a> -<li><a href="SWIG.html#SWIG_nn17">Run time pointer type checking</a> -<li><a href="SWIG.html#SWIG_nn18">Derived types, structs, and classes</a> -<li><a href="SWIG.html#SWIG_nn19">Undefined datatypes</a> -<li><a href="SWIG.html#SWIG_nn20">Typedef</a> -</ul> -<li><a href="SWIG.html#SWIG_nn21">Other Practicalities</a> -<ul> -<li><a href="SWIG.html#SWIG_nn22">Passing structures by value</a> -<li><a href="SWIG.html#SWIG_nn23">Return by value</a> -<li><a href="SWIG.html#SWIG_nn24">Linking to structure variables</a> -<li><a href="SWIG.html#SWIG_nn25">Linking to <tt>char *</tt></a> -<li><a href="SWIG.html#SWIG_nn26">Arrays</a> -<li><a href="SWIG.html#SWIG_readonly_variables">Creating read-only variables</a> -<li><a href="SWIG.html#SWIG_rename_ignore">Renaming and ignoring declarations</a> -<li><a href="SWIG.html#SWIG_default_args">Default/optional arguments</a> -<li><a href="SWIG.html#SWIG_nn30">Pointers to functions and callbacks</a> -</ul> -<li><a href="SWIG.html#SWIG_nn31">Structures and unions</a> -<ul> -<li><a href="SWIG.html#SWIG_nn32">Typedef and structures</a> -<li><a href="SWIG.html#SWIG_nn33">Character strings and structures</a> -<li><a href="SWIG.html#SWIG_nn34">Array members</a> -<li><a href="SWIG.html#SWIG_structure_data_members">Structure data members</a> -<li><a href="SWIG.html#SWIG_nn36">C constructors and destructors </a> -<li><a href="SWIG.html#SWIG_adding_member_functions">Adding member functions to C structures</a> -<li><a href="SWIG.html#SWIG_nested_structs">Nested structures</a> -<li><a href="SWIG.html#SWIG_nn39">Other things to note about structure wrapping</a> -</ul> -<li><a href="SWIG.html#SWIG_nn40">Code Insertion</a> -<ul> -<li><a href="SWIG.html#SWIG_nn41">The output of SWIG</a> -<li><a href="SWIG.html#SWIG_nn42">Code insertion blocks</a> -<li><a href="SWIG.html#SWIG_nn43">Inlined code blocks</a> -<li><a href="SWIG.html#SWIG_nn44">Initialization blocks</a> -</ul> -<li><a href="SWIG.html#SWIG_nn45">An Interface Building Strategy</a> -<ul> -<li><a href="SWIG.html#SWIG_nn46">Preparing a C program for SWIG</a> -<li><a href="SWIG.html#SWIG_nn47">The SWIG interface file</a> -<li><a href="SWIG.html#SWIG_nn48">Why use separate interface files?</a> -<li><a href="SWIG.html#SWIG_nn49">Getting the right header files</a> -<li><a href="SWIG.html#SWIG_nn50">What to do with main()</a> -</ul> -</ul> -</div> -<!-- INDEX --> - -<h3><a href="SWIGPlus.html#SWIGPlus">29 SWIG and C++</a></h3> - -<!-- INDEX --> -<div class="sectiontoc"> -<ul> -<li><a href="SWIGPlus.html#SWIGPlus_nn2">Comments on C++ Wrapping</a> -<li><a href="SWIGPlus.html#SWIGPlus_nn3">Approach</a> -<li><a href="SWIGPlus.html#SWIGPlus_nn4">Supported C++ features</a> -<li><a href="SWIGPlus.html#SWIGPlus_nn5">Command line options and compilation</a> -<li><a href="SWIGPlus.html#SWIGPlus_nn38">Proxy classes</a> -<ul> -<li><a href="SWIGPlus.html#SWIGPlus_nn39">Construction of proxy classes</a> -<li><a href="SWIGPlus.html#SWIGPlus_nn40">Resource management in proxies</a> -<li><a href="SWIGPlus.html#SWIGPlus_nn41">Language specific details</a> -</ul> -<li><a href="SWIGPlus.html#SWIGPlus_nn6">Simple C++ wrapping</a> -<ul> -<li><a href="SWIGPlus.html#SWIGPlus_nn7">Constructors and destructors</a> -<li><a href="SWIGPlus.html#SWIGPlus_nn8">Default constructors, copy constructors and implicit destructors</a> -<li><a href="SWIGPlus.html#SWIGPlus_nn9">When constructor wrappers aren't created</a> -<li><a href="SWIGPlus.html#SWIGPlus_nn10">Copy constructors</a> -<li><a href="SWIGPlus.html#SWIGPlus_nn11">Member functions</a> -<li><a href="SWIGPlus.html#SWIGPlus_nn12">Static members</a> -<li><a href="SWIGPlus.html#SWIGPlus_member_data">Member data</a> -</ul> -<li><a href="SWIGPlus.html#SWIGPlus_default_args">Default arguments</a> -<li><a href="SWIGPlus.html#SWIGPlus_nn15">Protection</a> -<li><a href="SWIGPlus.html#SWIGPlus_nn16">Enums and constants</a> -<li><a href="SWIGPlus.html#SWIGPlus_nn17">Friends</a> -<li><a href="SWIGPlus.html#SWIGPlus_nn18">References and pointers</a> -<li><a href="SWIGPlus.html#SWIGPlus_nn19">Pass and return by value</a> -<li><a href="SWIGPlus.html#SWIGPlus_nn20">Inheritance</a> -<li><a href="SWIGPlus.html#SWIGPlus_nn21">A brief discussion of multiple inheritance, pointers, and type checking</a> -<li><a href="SWIGPlus.html#SWIGPlus_overloaded_methods">Wrapping Overloaded Functions and Methods</a> -<ul> -<li><a href="SWIGPlus.html#SWIGPlus_nn24">Dispatch function generation</a> -<li><a href="SWIGPlus.html#SWIGPlus_nn25">Ambiguity in Overloading</a> -<li><a href="SWIGPlus.html#ambiguity_resolution_renaming">Ambiguity resolution and renaming</a> -<li><a href="SWIGPlus.html#SWIGPlus_nn27">Comments on overloading</a> -</ul> -<li><a href="SWIGPlus.html#SWIGPlus_nn28">Wrapping overloaded operators</a> -<li><a href="SWIGPlus.html#SWIGPlus_class_extension">Class extension</a> -<li><a href="SWIGPlus.html#SWIGPlus_nn30">Templates</a> -<li><a href="SWIGPlus.html#SWIGPlus_nn31">Namespaces</a> -<li><a href="SWIGPlus.html#SWIGPlus_renaming_templated_types_namespaces">Renaming templated types in namespaces</a> -<li><a href="SWIGPlus.html#SWIGPlus_exception_specifications">Exception specifications</a> -<li><a href="SWIGPlus.html#SWIGPlus_catches">Exception handling with %catches</a> -<li><a href="SWIGPlus.html#SWIGPlus_nn33">Pointers to Members</a> -<li><a href="SWIGPlus.html#SWIGPlus_nn34">Smart pointers and operator->()</a> -<li><a href="SWIGPlus.html#SWIGPlus_nn35">Using declarations and inheritance</a> -<li><a href="SWIGPlus.html#SWIGPlus_nested_classes">Nested classes</a> -<li><a href="SWIGPlus.html#SWIGPlus_nn37">A brief rant about const-correctness</a> -<li><a href="SWIGPlus.html#SWIGPlus_nn42">Where to go for more information</a> -</ul> -</div> -<!-- INDEX --> - -<h3><a href="Tcl.html#Tcl">30 SWIG and Tcl</a></h3> +<h3><a href="Tcl.html#Tcl">32 SWIG and Tcl</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -1372,160 +1448,84 @@ </div> <!-- INDEX --> -<h3><a href="Typemaps.html#Typemaps">31 Typemaps</a></h3> +<h3><a href="R.html#R">33 SWIG and R</a></h3> <!-- INDEX --> <div class="sectiontoc"> <ul> -<li><a href="Typemaps.html#Typemaps_nn2">Introduction</a> -<ul> -<li><a href="Typemaps.html#Typemaps_nn3">Type conversion</a> -<li><a href="Typemaps.html#Typemaps_nn4">Typemaps</a> -<li><a href="Typemaps.html#Typemaps_nn5">Pattern matching</a> -<li><a href="Typemaps.html#Typemaps_nn6">Reusing typemaps</a> -<li><a href="Typemaps.html#Typemaps_nn7">What can be done with typemaps?</a> -<li><a href="Typemaps.html#Typemaps_nn8">What can't be done with typemaps?</a> -<li><a href="Typemaps.html#Typemaps_nn9">The rest of this chapter</a> -</ul> -<li><a href="Typemaps.html#Typemaps_nn10">Typemap specifications</a> -<ul> -<li><a href="Typemaps.html#Typemaps_nn11">Defining a typemap</a> -<li><a href="Typemaps.html#Typemaps_nn12">Typemap scope</a> -<li><a href="Typemaps.html#Typemaps_nn13">Copying a typemap</a> -<li><a href="Typemaps.html#Typemaps_nn14">Deleting a typemap</a> -<li><a href="Typemaps.html#Typemaps_nn15">Placement of typemaps</a> -</ul> -<li><a href="Typemaps.html#Typemaps_nn16">Pattern matching rules</a> -<ul> -<li><a href="Typemaps.html#Typemaps_nn17">Basic matching rules</a> -<li><a href="Typemaps.html#Typemaps_nn18">Typedef reductions</a> -<li><a href="Typemaps.html#Typemaps_nn19">Default typemaps</a> -<li><a href="Typemaps.html#Typemaps_mixed_default">Mixed default typemaps</a> -<li><a href="Typemaps.html#Typemaps_nn20">Multi-arguments typemaps</a> -</ul> -<li><a href="Typemaps.html#Typemaps_nn21">Code generation rules</a> -<ul> -<li><a href="Typemaps.html#Typemaps_nn22">Scope</a> -<li><a href="Typemaps.html#Typemaps_nn23">Declaring new local variables</a> -<li><a href="Typemaps.html#Typemaps_special_variables">Special variables</a> -</ul> -<li><a href="Typemaps.html#Typemaps_nn25">Common typemap methods</a> -<ul> -<li><a href="Typemaps.html#Typemaps_nn26">"in" typemap</a> -<li><a href="Typemaps.html#Typemaps_nn27">"typecheck" typemap</a> -<li><a href="Typemaps.html#Typemaps_nn28">"out" typemap</a> -<li><a href="Typemaps.html#Typemaps_nn29">"arginit" typemap</a> -<li><a href="Typemaps.html#Typemaps_nn30">"default" typemap</a> -<li><a href="Typemaps.html#Typemaps_nn31">"check" typemap</a> -<li><a href="Typemaps.html#Typemaps_nn32">"argout" typemap</a> -<li><a href="Typemaps.html#Typemaps_nn33">"freearg" typemap</a> -<li><a href="Typemaps.html#Typemaps_nn34">"newfree" typemap</a> -<li><a href="Typemaps.html#Typemaps_nn35">"memberin" typemap</a> -<li><a href="Typemaps.html#Typemaps_nn36">"varin" typemap</a> -<li><a href="Typemaps.html#Typemaps_nn37">"varout" typemap</a> -<li><a href="Typemaps.html#throws_typemap">"throws" typemap</a> -</ul> -<li><a href="Typemaps.html#Typemaps_nn39">Some typemap examples</a> -<ul> -<li><a href="Typemaps.html#Typemaps_nn40">Typemaps for arrays</a> -<li><a href="Typemaps.html#Typemaps_nn41">Implementing constraints with typemaps</a> -</ul> -<li><a href="Typemaps.html#Typemaps_nn43">Typemaps for multiple languages</a> -<li><a href="Typemaps.html#Typemaps_nn42">Multi-argument typemaps</a> -<li><a href="Typemaps.html#runtime_type_checker">The run-time type checker</a> -<ul> -<li><a href="Typemaps.html#Typemaps_nn45">Implementation</a> -<li><a href="Typemaps.html#Typemaps_nn46">Usage</a> -</ul> -<li><a href="Typemaps.html#Typemaps_overloading">Typemaps and overloading</a> -<li><a href="Typemaps.html#Typemaps_nn48">More about <tt>%apply</tt> and <tt>%clear</tt></a> -<li><a href="Typemaps.html#Typemaps_nn49">Reducing wrapper code size</a> -<li><a href="Typemaps.html#Typemaps_nn47">Passing data between typemaps</a> -<li><a href="Typemaps.html#Typemaps_nn51">Where to go for more information?</a> -</ul> -</div> -<!-- INDEX --> - -<h3><a href="Varargs.html#Varargs">32 Variable Length Arguments</a></h3> - -<!-- INDEX --> -<div class="sectiontoc"> -<ul> -<li><a href="Varargs.html#Varargs_nn2">Introduction</a> -<li><a href="Varargs.html#Varargs_nn3">The Problem</a> -<li><a href="Varargs.html#Varargs_nn4">Default varargs support</a> -<li><a href="Varargs.html#Varargs_nn5">Argument replacement using %varargs</a> -<li><a href="Varargs.html#Varargs_nn6">Varargs and typemaps</a> -<li><a href="Varargs.html#Varargs_nn7">Varargs wrapping with libffi</a> -<li><a href="Varargs.html#Varargs_nn8">Wrapping of va_list</a> -<li><a href="Varargs.html#Varargs_nn9">C++ Issues</a> -<li><a href="Varargs.html#Varargs_nn10">Discussion</a> +<li><a href="R.html#R_nn2">Bugs</a> +<li><a href="R.html#R_nn3">Using R and SWIG</a> +<li><a href="R.html#R_nn4">Precompiling large R files</a> +<li><a href="R.html#R_nn5">General policy</a> +<li><a href="R.html#R_language_conventions">Language conventions</a> +<li><a href="R.html#R_nn6">C++ classes</a> +<li><a href="R.html#R_nn7">Enumerations</a> </ul> </div> <!-- INDEX --> -<h3><a href="Warnings.html#Warnings">33 Warning Messages</a></h3> +<h3><a href="Extending.html#Extending">34 Extending SWIG to support new languages</a></h3> <!-- INDEX --> <div class="sectiontoc"> <ul> -<li><a href="Warnings.html#Warnings_nn2">Introduction</a> -<li><a href="Warnings.html#Warnings_suppression">Warning message suppression</a> -<li><a href="Warnings.html#Warnings_nn4">Enabling extra warnings</a> -<li><a href="Warnings.html#Warnings_nn5">Issuing a warning message</a> -<li><a href="Warnings.html#Warnings_symbolic_symbols">Symbolic symbols</a> -<li><a href="Warnings.html#Warnings_nn6">Commentary</a> -<li><a href="Warnings.html#Warnings_nn7">Warnings as errors</a> -<li><a href="Warnings.html#Warnings_nn8">Message output format</a> -<li><a href="Warnings.html#Warnings_nn9">Warning number reference</a> +<li><a href="Extending.html#Extending_nn2">Introduction</a> +<li><a href="Extending.html#Extending_nn3">Prerequisites</a> +<li><a href="Extending.html#Extending_nn4">The Big Picture</a> +<li><a href="Extending.html#Extending_nn5">Execution Model</a> <ul> -<li><a href="Warnings.html#Warnings_nn10">Deprecated features (100-199)</a> -<li><a href="Warnings.html#Warnings_nn11">Preprocessor (200-299)</a> -<li><a href="Warnings.html#Warnings_nn12">C/C++ Parser (300-399)</a> -<li><a href="Warnings.html#Warnings_nn13">Types and typemaps (400-499) </a> -<li><a href="Warnings.html#Warnings_nn14">Code generation (500-599)</a> -<li><a href="Warnings.html#Warnings_nn15">Language module specific (800-899) </a> -<li><a href="Warnings.html#Warnings_nn16">User defined (900-999)</a> -</ul> -<li><a href="Warnings.html#Warnings_nn17">History</a> +<li><a href="Extending.html#Extending_nn6">Preprocessing</a> +<li><a href="Extending.html#Extending_nn7">Parsing</a> +<li><a href="Extending.html#Extending_nn8">Parse Trees</a> +<li><a href="Extending.html#Extending_nn9">Attribute namespaces</a> +<li><a href="Extending.html#Extending_nn10">Symbol Tables</a> +<li><a href="Extending.html#Extending_nn11">The %feature directive</a> +<li><a href="Extending.html#Extending_nn12">Code Generation</a> +<li><a href="Extending.html#Extending_nn13">SWIG and XML</a> </ul> -</div> -<!-- INDEX --> - -<h3><a href="Windows.html#Windows">34 Getting started on Windows </a></h3> - -<!-- INDEX --> -<div class="sectiontoc"> -<ul> -<li><a href="Windows.html#Windows_installation">Installation on Windows</a> +<li><a href="Extending.html#Extending_nn14">Primitive Data Structures</a> <ul> -<li><a href="Windows.html#Windows_executable">Windows Executable</a> +<li><a href="Extending.html#Extending_nn15">Strings</a> +<li><a href="Extending.html#Extending_nn16">Hashes</a> +<li><a href="Extending.html#Extending_nn17">Lists</a> +<li><a href="Extending.html#Extending_nn18">Common operations</a> +<li><a href="Extending.html#Extending_nn19">Iterating over Lists and Hashes</a> +<li><a href="Extending.html#Extending_nn20">I/O</a> </ul> -<li><a href="Windows.html#Windows_examples">SWIG Windows Examples</a> -<ul> -<li><a href="Windows.html#Windows_visual_studio">Instructions for using the Examples with Visual Studio</a> +<li><a href="Extending.html#Extending_nn21">Navigating and manipulating parse trees</a> +<li><a href="Extending.html#Extending_nn22">Working with attributes</a> +<li><a href="Extending.html#Extending_nn23">Type system</a> <ul> -<li><a href="Windows.html#Windows_csharp">C#</a> -<li><a href="Windows.html#Windows_java">Java</a> -<li><a href="Windows.html#Windows_perl">Perl</a> -<li><a href="Windows.html#Windows_python">Python</a> -<li><a href="Windows.html#Windows_tcl">TCL</a> -<li><a href="Windows.html#Windows_r">R</a> -<li><a href="Windows.html#Windows_ruby">Ruby</a> -</ul> -<li><a href="Windows.html#Windows_other_compilers">Instructions for using the Examples with other compilers</a> +<li><a href="Extending.html#Extending_nn24">String encoding of types</a> +<li><a href="Extending.html#Extending_nn25">Type construction</a> +<li><a href="Extending.html#Extending_nn26">Type tests</a> +<li><a href="Extending.html#Extending_nn27">Typedef and inheritance</a> +<li><a href="Extending.html#Extending_nn28">Lvalues</a> +<li><a href="Extending.html#Extending_nn29">Output functions</a> </ul> -<li><a href="Windows.html#Windows_cygwin_mingw">SWIG on Cygwin and MinGW</a> -<ul> -<li><a href="Windows.html#Windows_swig_exe">Building swig.exe on Windows</a> +<li><a href="Extending.html#Extending_nn30">Parameters</a> +<li><a href="Extending.html#Extending_nn31">Writing a Language Module</a> <ul> -<li><a href="Windows.html#Windows_mingw_msys">Building swig.exe using MinGW and MSYS</a> -<li><a href="Windows.html#Windows_cygwin">Building swig.exe using Cygwin</a> -<li><a href="Windows.html#Windows_building_alternatives">Building swig.exe alternatives</a> +<li><a href="Extending.html#Extending_nn32">Execution model</a> +<li><a href="Extending.html#Extending_nn33">Starting out</a> +<li><a href="Extending.html#Extending_nn34">Command line options</a> +<li><a href="Extending.html#Extending_nn35">Configuration and preprocessing</a> +<li><a href="Extending.html#Extending_nn36">Entry point to code generation</a> +<li><a href="Extending.html#Extending_nn37">Module I/O and wrapper skeleton</a> +<li><a href="Extending.html#Extending_nn38">Low-level code generators</a> +<li><a href="Extending.html#Extending_nn39">Configuration files</a> +<li><a href="Extending.html#Extending_nn40">Runtime support</a> +<li><a href="Extending.html#Extending_nn41">Standard library files</a> +<li><a href="Extending.html#Extending_nn42">Examples and test cases</a> +<li><a href="Extending.html#Extending_nn43">Documentation</a> +<li><a href="Extending.html#Extending_prerequisites">Prerequisites for adding a new language module to the SWIG distribution</a> +<li><a href="Extending.html#Extending_coding_style_guidelines">Coding style guidelines</a> </ul> -<li><a href="Windows.html#Windows_examples_cygwin">Running the examples on Windows using Cygwin</a> +<li><a href="Extending.html#Extending_nn44">Typemaps</a> +<ul> +<li><a href="Extending.html#Extending_nn45">Proxy classes</a> </ul> -<li><a href="Windows.html#Windows_interface_file">Microsoft extensions and other Windows quirks</a> +<li><a href="Extending.html#Extending_nn46">Guide to parse tree nodes</a> </ul> </div> <!-- INDEX --> |