diff options
Diffstat (limited to 'Doc/Manual/Contents.html')
| -rw-r--r-- | Doc/Manual/Contents.html | 558 |
1 files changed, 244 insertions, 314 deletions
diff --git a/Doc/Manual/Contents.html b/Doc/Manual/Contents.html index f196da53c..57aef5b8a 100644 --- a/Doc/Manual/Contents.html +++ b/Doc/Manual/Contents.html @@ -46,6 +46,11 @@ <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_target_languages">Target languages</a> +<ul> +<li><a href="Introduction.html#Introduction_supported_status">Supported status</a> +<li><a href="Introduction.html#Introduction_experimental_status">Experimental status</a> +</ul> <li><a href="Introduction.html#Introduction_nn4">A SWIG example</a> <ul> <li><a href="Introduction.html#Introduction_nn5">SWIG interface file</a> @@ -228,7 +233,6 @@ <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> @@ -236,16 +240,27 @@ <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> +<li><a href="SWIGPlus.html#SWIGPlus_default_args">Default arguments</a> +<li><a href="SWIGPlus.html#SWIGPlus_overloaded_methods">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#SWIGPlus_ambiguity_resolution_renaming">Ambiguity resolution and renaming</a> +<li><a href="SWIGPlus.html#SWIGPlus_nn25">Ambiguity in overloading</a> +<li><a href="SWIGPlus.html#SWIGPlus_ambiguity_resolution_renaming">Renaming and ambiguity resolution</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_nn28">Overloaded operators</a> <li><a href="SWIGPlus.html#SWIGPlus_class_extension">Class extension</a> <li><a href="SWIGPlus.html#SWIGPlus_nn30">Templates</a> +<ul> +<li><a href="SWIGPlus.html#SWIGPlus_template_directive">The %template directive</a> +<li><a href="SWIGPlus.html#SWIGPlus_template_functions">Function templates</a> +<li><a href="SWIGPlus.html#SWIGPlus_template_classes">Default template arguments</a> +<li><a href="SWIGPlus.html#SWIGPlus_template_class_inheritance">Template base classes</a> +<li><a href="SWIGPlus.html#SWIGPlus_template_specialization">Template specialization</a> +<li><a href="SWIGPlus.html#SWIGPlus_template_member">Member templates</a> +<li><a href="SWIGPlus.html#SWIGPlus_template_scoping">Scoping and templates</a> +<li><a href="SWIGPlus.html#SWIGPlus_template_more">More on templates</a> +</ul> <li><a href="SWIGPlus.html#SWIGPlus_namespaces">Namespaces</a> <ul> <li><a href="SWIGPlus.html#SWIGPlus_nspace">The nspace feature for namespaces</a> @@ -259,6 +274,11 @@ <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_const">A brief rant about const-correctness</a> +<li><a href="SWIGPlus.html#SWIGPlus_target_language_callbacks">Callbacks to the target language</a> +<ul> +<li><a href="SWIGPlus.html#SWIGPlus_director_classes_introduction">Introduction to director classes</a> +<li><a href="SWIGPlus.html#SWIGPlus_directors_for_function_pointers">Using directors and target language callbacks</a> +</ul> <li><a href="SWIGPlus.html#SWIGPlus_nn42">Where to go for more information</a> </ul> </div> @@ -290,6 +310,7 @@ <li><a href="CPlusPlus11.html#CPlusPlus11_alias_templates">Type alias and alias templates</a> <li><a href="CPlusPlus11.html#CPlusPlus11_unrestricted_unions">Unrestricted unions</a> <li><a href="CPlusPlus11.html#CPlusPlus11_variadic_templates">Variadic templates</a> +<li><a href="CPlusPlus11.html#CPlusPlus11_new_char_literals">New character literals</a> <li><a href="CPlusPlus11.html#CPlusPlus11_new_string_literals">New string literals</a> <li><a href="CPlusPlus11.html#CPlusPlus11_user_defined_literals">User-defined literals</a> <li><a href="CPlusPlus11.html#CPlusPlus11_thread_local_storage">Thread-local storage</a> @@ -300,6 +321,7 @@ <li><a href="CPlusPlus11.html#CPlusPlus11_noexcept">Exception specifications and noexcept</a> <li><a href="CPlusPlus11.html#CPlusPlus11_alignment">Control and query object alignment</a> <li><a href="CPlusPlus11.html#CPlusPlus11_attributes">Attributes</a> +<li><a href="CPlusPlus11.html#CPlusPlus11_ref_qualifiers">Methods with ref-qualifiers</a> </ul> <li><a href="CPlusPlus11.html#CPlusPlus11_standard_library_changes">Standard library changes</a> <ul> @@ -318,7 +340,39 @@ </div> <!-- INDEX --> -<h3><a href="Preprocessor.html#Preprocessor">8 Preprocessing</a></h3> +<h3><a href="CPlusPlus14.html#CPlusPlus14">8 SWIG and C++14</a></h3> + +<!-- INDEX --> +<div class="sectiontoc"> +<ul> +<li><a href="CPlusPlus14.html#CPlusPlus14_introduction">Introduction</a> +<li><a href="CPlusPlus14.html#CPlusPlus14_core_language_changes">Core language changes</a> +<ul> +<li><a href="CPlusPlus14.html#CPlusPlus14_binary_literals">Binary integer literals</a> +</ul> +<li><a href="CPlusPlus14.html#CPlusPlus14_standard_library_changes">Standard library changes</a> +</ul> +</div> +<!-- INDEX --> + +<h3><a href="CPlusPlus17.html#CPlusPlus17">9 SWIG and C++17</a></h3> + +<!-- INDEX --> +<div class="sectiontoc"> +<ul> +<li><a href="CPlusPlus17.html#CPlusPlus17_introduction">Introduction</a> +<li><a href="CPlusPlus17.html#CPlusPlus17_core_language_changes">Core language changes</a> +<ul> +<li><a href="CPlusPlus17.html#CPlusPlus17_nested_namespaces">Nested namespace definitions</a> +<li><a href="CPlusPlus17.html#CPlusPlus17_u8_char_literals">UTF-8 character literals</a> +<li><a href="CPlusPlus17.html#CPlusPlus17_hexadecimal_floating_literals">Hexadecimal floating literals</a> +</ul> +<li><a href="CPlusPlus17.html#CPlusPlus17_standard_library_changes">Standard library changes</a> +</ul> +</div> +<!-- INDEX --> + +<h3><a href="Preprocessor.html#Preprocessor">10 Preprocessing</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -341,32 +395,39 @@ </div> <!-- INDEX --> -<h3><a href="Library.html#Library">9 SWIG library</a></h3> +<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> +<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_carrays">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> +<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> +<li><a href="Library.html#Library_stl_cpp_library">STL/C++ library</a> <ul> <li><a href="Library.html#Library_std_string">std::string</a> <li><a href="Library.html#Library_std_vector">std::vector</a> <li><a href="Library.html#Library_stl_exceptions">STL exceptions</a> <li><a href="Library.html#Library_std_shared_ptr">shared_ptr smart pointer</a> +<ul> +<li><a href="Library.html#Library_shared_ptr_basics">shared_ptr basics</a> +<li><a href="Library.html#Library_shared_ptr_inheritance">shared_ptr and inheritance</a> +<li><a href="Library.html#Library_shared_ptr_overloading">shared_ptr and method overloading</a> +<li><a href="Library.html#Library_shared_ptr_templates">shared_ptr and templates</a> +<li><a href="Library.html#Library_shared_ptr_directors">shared_ptr and directors</a> +</ul> <li><a href="Library.html#Library_std_auto_ptr">auto_ptr smart pointer</a> </ul> <li><a href="Library.html#Library_nn16">Utility Libraries</a> @@ -377,7 +438,7 @@ </div> <!-- INDEX --> -<h3><a href="Arguments.html#Arguments">10 Argument Handling</a></h3> +<h3><a href="Arguments.html#Arguments">12 Argument Handling</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -400,7 +461,7 @@ </div> <!-- INDEX --> -<h3><a href="Typemaps.html#Typemaps">11 Typemaps</a></h3> +<h3><a href="Typemaps.html#Typemaps">13 Typemaps</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -461,7 +522,7 @@ <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> +<li><a href="Typemaps.html#Typemaps_throws_typemap">"throws" typemap</a> </ul> <li><a href="Typemaps.html#Typemaps_nn39">Some typemap examples</a> <ul> @@ -483,6 +544,9 @@ <li><a href="Typemaps.html#Typemaps_runtime_type_checker_usage">Usage</a> </ul> <li><a href="Typemaps.html#Typemaps_overloading">Typemaps and overloading</a> +<ul> +<li><a href="Typemaps.html#Typemaps_typecheck_pointer">SWIG_TYPECHECK_POINTER precedence level and the typecheck typemap</a> +</ul> <li><a href="Typemaps.html#Typemaps_nn48">More about %apply and %clear</a> <li><a href="Typemaps.html#Typemaps_nn47">Passing data between typemaps</a> <li><a href="Typemaps.html#Typemaps_nn52">C++ "this" pointer</a> @@ -491,7 +555,7 @@ </div> <!-- INDEX --> -<h3><a href="Customization.html#Customization">12 Customization Features</a></h3> +<h3><a href="Customization.html#Customization">14 Customization Features</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -519,7 +583,7 @@ </div> <!-- INDEX --> -<h3><a href="Contract.html#Contract">13 Contracts</a></h3> +<h3><a href="Contract.html#Contract">15 Contracts</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -532,7 +596,7 @@ </div> <!-- INDEX --> -<h3><a href="Varargs.html#Varargs">14 Variable Length Arguments</a></h3> +<h3><a href="Varargs.html#Varargs">16 Variable Length Arguments</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -550,7 +614,55 @@ </div> <!-- INDEX --> -<h3><a href="Warnings.html#Warnings">15 Warning Messages</a></h3> +<h3><a href="Doxygen.html#Doxygen">17 SWIG and Doxygen Translation</a></h3> + +<!-- INDEX --> +<div class="sectiontoc"> +<ul> +<li><a href="Doxygen.html#Doxygen_translation_overview">Doxygen translation overview</a> +<li><a href="Doxygen.html#Doxygen_file_preparation">Preparations</a> +<ul> +<li><a href="Doxygen.html#Doxygen_running_swig">Enabling Doxygen translation</a> +<li><a href="Doxygen.html#Doxygen_features">Doxygen-specific %feature directives</a> +<ul> +<li><a href="Doxygen.html#Doxygen_notranslate">doxygen:notranslate</a> +<li><a href="Doxygen.html#Doxygen_alias">doxygen:alias:<command-name></a> +<li><a href="Doxygen.html#Doxygen_ignore">doxygen:ignore:<command-name></a> +<li><a href="Doxygen.html#Doxygen_nolinktranslate">doxygen:nolinktranslate</a> +<li><a href="Doxygen.html#Doxygen_nostripparams">doxygen:nostripparams</a> +</ul> +<li><a href="Doxygen.html#Doxygen_additional_options">Additional command line options</a> +</ul> +<li><a href="Doxygen.html#Doxygen_to_javadoc">Doxygen to Javadoc</a> +<ul> +<li><a href="Doxygen.html#Doxygen_basic_example">Basic example</a> +<li><a href="Doxygen.html#Doxygen_javadoc_tags">Javadoc tags</a> +<li><a href="Doxygen.html#Doxygen_unsupported_tags">Unsupported tags</a> +<li><a href="Doxygen.html#Doxygen_further_details">Further details</a> +</ul> +<li><a href="Doxygen.html#Doxygen_to_pydoc">Doxygen to Pydoc</a> +<ul> +<li><a href="Doxygen.html#Doxygen_python_basic_example">Basic example</a> +<li><a href="Doxygen.html#Doxygen_pydoc_tags">Pydoc translator</a> +<li><a href="Doxygen.html#Doxygen_python_unsupported_tags">Unsupported tags</a> +<li><a href="Doxygen.html#Doxygen_python_further_details">Further details</a> +</ul> +<li><a href="Doxygen.html#Doxygen_troubleshooting">Troubleshooting</a> +<ul> +<li><a href="Doxygen.html#troubleshooting_ifndef">Problem with conditional compilation</a> +</ul> +<li><a href="Doxygen.html#Doxygen_developer_details">Developer information</a> +<ul> +<li><a href="Doxygen.html#Doxygen_translator_design">Doxygen translator design</a> +<li><a href="Doxygen.html#Doxygen_debugging_commands">Debugging the Doxygen parser and translator</a> +<li><a href="Doxygen.html#Doxygen_tests">Tests</a> +</ul> +<li><a href="Doxygen.html#Doxygen_language_extension">Extending to other languages</a> +</ul> +</div> +<!-- INDEX --> + +<h3><a href="Warnings.html#Warnings">18 Warning Messages</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -569,7 +681,8 @@ <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_nn14">Code generation (500-559)</a> +<li><a href="Warnings.html#Warnings_doxygen">Doxygen comments (560-599)</a> <li><a href="Warnings.html#Warnings_nn15">Language module specific (700-899) </a> <li><a href="Warnings.html#Warnings_nn16">User defined (900-999)</a> </ul> @@ -578,7 +691,7 @@ </div> <!-- INDEX --> -<h3><a href="Modules.html#Modules">16 Working with Modules</a></h3> +<h3><a href="Modules.html#Modules">19 Working with Modules</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -594,7 +707,7 @@ </div> <!-- INDEX --> -<h3><a href="CCache.html#CCache">17 Using SWIG with ccache - ccache-swig(1) manpage</a></h3> +<h3><a href="CCache.html#CCache">20 Using SWIG with ccache - ccache-swig(1) manpage</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -620,91 +733,7 @@ </div> <!-- INDEX --> -<h3><a href="Allegrocl.html#Allegrocl">18 SWIG and Allegro Common Lisp</a></h3> - -<!-- INDEX --> -<div class="sectiontoc"> -<ul> -<li><a href="Allegrocl.html#Allegrocl_nn2">Basics</a> -<ul> -<li><a href="Allegrocl.html#Allegrocl_nn3">Running SWIG</a> -<li><a href="Allegrocl.html#Allegrocl_nn4">Command Line Options</a> -<li><a href="Allegrocl.html#Allegrocl_nn5">Inserting user code into generated files</a> -</ul> -<li><a href="Allegrocl.html#Allegrocl_nn6">Wrapping Overview</a> -<ul> -<li><a href="Allegrocl.html#Allegrocl_nn7">Function Wrapping</a> -<li><a href="Allegrocl.html#Allegrocl_nn8">Foreign Wrappers</a> -<li><a href="Allegrocl.html#Allegrocl_nn9">FFI Wrappers</a> -<li><a href="Allegrocl.html#Allegrocl_nn10">Non-overloaded Defuns</a> -<li><a href="Allegrocl.html#Allegrocl_nn11">Overloaded Defuns</a> -<li><a href="Allegrocl.html#Allegrocl_nn12">What about constant and variable access?</a> -<li><a href="Allegrocl.html#Allegrocl_nn13">Object Wrapping</a> -</ul> -<li><a href="Allegrocl.html#Allegrocl_nn14">Wrapping Details</a> -<ul> -<li><a href="Allegrocl.html#Allegrocl_nn15">Namespaces</a> -<li><a href="Allegrocl.html#Allegrocl_nn16">Constants</a> -<li><a href="Allegrocl.html#Allegrocl_nn17">Variables</a> -<li><a href="Allegrocl.html#Allegrocl_nn18">Enumerations</a> -<li><a href="Allegrocl.html#Allegrocl_nn19">Arrays</a> -<li><a href="Allegrocl.html#Allegrocl_nn20">Classes and Structs and Unions (oh my!)</a> -<ul> -<li><a href="Allegrocl.html#Allegrocl_nn21">CLOS wrapping of</a> -<li><a href="Allegrocl.html#Allegrocl_nn22">CLOS Inheritance</a> -<li><a href="Allegrocl.html#Allegrocl_nn23">Member fields and functions</a> -<li><a href="Allegrocl.html#Allegrocl_nn24">Why not directly access C++ classes using foreign types?</a> -</ul> -<li><a href="Allegrocl.html#Allegrocl_nn25">Templates</a> -<ul> -<li><a href="Allegrocl.html#Allegrocl_nn26">Generating wrapper code for templates</a> -<li><a href="Allegrocl.html#Allegrocl_nn27">Implicit Template instantiation</a> -</ul> -<li><a href="Allegrocl.html#Allegrocl_nn28">Typedef, Templates, and Synonym Types</a> -<ul> -<li><a href="Allegrocl.html#Allegrocl_nn29">Choosing a primary type</a> -</ul> -<li><a href="Allegrocl.html#Allegrocl_nn30">Function overloading/Parameter defaulting</a> -<li><a href="Allegrocl.html#Allegrocl_nn31">Operator wrapping and Operator overloading</a> -<li><a href="Allegrocl.html#Allegrocl_nn32">Varargs</a> -<li><a href="Allegrocl.html#Allegrocl_nn33">C++ Exceptions</a> -<li><a href="Allegrocl.html#Allegrocl_nn34">Pass by value, pass by reference</a> -</ul> -<li><a href="Allegrocl.html#Allegrocl_nn35">Typemaps</a> -<ul> -<li><a href="Allegrocl.html#Allegrocl_nn36">Code Generation in the C++ Wrapper</a> -<ul> -<li><a href="Allegrocl.html#Allegrocl_nn37">IN Typemap</a> -<li><a href="Allegrocl.html#Allegrocl_nn38">OUT Typemap</a> -<li><a href="Allegrocl.html#Allegrocl_nn39">CTYPE Typemap</a> -</ul> -<li><a href="Allegrocl.html#Allegrocl_nn40">Code generation in Lisp wrappers</a> -<ul> -<li><a href="Allegrocl.html#Allegrocl_nn41">LIN Typemap</a> -<li><a href="Allegrocl.html#Allegrocl_nn42">LOUT Typemap</a> -<li><a href="Allegrocl.html#Allegrocl_nn43">FFITYPE Typemap</a> -<li><a href="Allegrocl.html#Allegrocl_nn44">LISPTYPE Typemap</a> -<li><a href="Allegrocl.html#Allegrocl_nn45">LISPCLASS Typemap</a> -</ul> -<li><a href="Allegrocl.html#Allegrocl_nn46">Modifying SWIG behavior using typemaps</a> -</ul> -<li><a href="Allegrocl.html#Allegrocl_nn47">Identifier Converter functions</a> -<ul> -<li><a href="Allegrocl.html#Allegrocl_nn48">Creating symbols in the lisp environment</a> -<li><a href="Allegrocl.html#Allegrocl_nn49">Existing identifier-converter functions</a> -<ul> -<li><a href="Allegrocl.html#Allegrocl_nn50">identifier-convert-null</a> -<li><a href="Allegrocl.html#Allegrocl_nn51">identifier-convert-lispify</a> -<li><a href="Allegrocl.html#Allegrocl_nn52">Default identifier to symbol conversions</a> -</ul> -<li><a href="Allegrocl.html#Allegrocl_nn53">Defining your own identifier-converter</a> -<li><a href="Allegrocl.html#Allegrocl_nn54">Instructing SWIG to use a particular identifier-converter</a> -</ul> -</ul> -</div> -<!-- INDEX --> - -<h3><a href="Android.html#Android">19 SWIG and Android</a></h3> +<h3><a href="Android.html#Android">21 SWIG and Android</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -722,7 +751,7 @@ </div> <!-- INDEX --> -<h3><a href="CSharp.html#CSharp">20 SWIG and C#</a></h3> +<h3><a href="CSharp.html#CSharp">22 SWIG and C#</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -761,7 +790,8 @@ <li><a href="CSharp.html#CSharp_date_marshalling">Date marshalling using the csin typemap and associated attributes</a> <li><a href="CSharp.html#CSharp_date_properties">A date example demonstrating marshalling of C# properties</a> <li><a href="CSharp.html#CSharp_date_pre_post_directors">Date example demonstrating the 'pre' and 'post' typemap attributes for directors</a> -<li><a href="CSharp.html#CSharp_partial_classes">Turning wrapped classes into partial classes</a> +<li><a href="CSharp.html#CSharp_partial_classes">Turning proxy classes into partial classes</a> +<li><a href="CSharp.html#CSharp_sealed_proxy_class">Turning proxy classes into sealed classes</a> <li><a href="CSharp.html#CSharp_extending_proxy_class">Extending proxy classes with additional C# code</a> <li><a href="CSharp.html#CSharp_enum_underlying_type">Underlying type for enums</a> </ul> @@ -769,45 +799,7 @@ </div> <!-- INDEX --> -<h3><a href="Chicken.html#Chicken">21 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#Chicken_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="D.html#D">22 SWIG and D</a></h3> +<h3><a href="D.html#D">23 SWIG and D</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -841,7 +833,7 @@ </div> <!-- INDEX --> -<h3><a href="Go.html#Go">23 SWIG and Go</a></h3> +<h3><a href="Go.html#Go">24 SWIG and Go</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -885,7 +877,7 @@ </div> <!-- INDEX --> -<h3><a href="Guile.html#Guile">24 SWIG and Guile</a></h3> +<h3><a href="Guile.html#Guile">25 SWIG and Guile</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -921,7 +913,7 @@ </div> <!-- INDEX --> -<h3><a href="Java.html#Java">25 SWIG and Java</a></h3> +<h3><a href="Java.html#Java">26 SWIG and Java</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -1010,6 +1002,9 @@ <li><a href="Java.html#Java_directors_threading">Director threading issues</a> <li><a href="Java.html#Java_directors_performance">Director performance tuning</a> <li><a href="Java.html#Java_exceptions_from_directors">Java exceptions from directors</a> +<ul> +<li><a href="Java.html#Java_customizing_director_exceptions">Customizing director exceptions</a> +</ul> </ul> <li><a href="Java.html#Java_allprotected">Accessing protected members</a> <li><a href="Java.html#Java_common_customization">Common customization features</a> @@ -1072,7 +1067,7 @@ </div> <!-- INDEX --> -<h3><a href="Javascript.html#Javascript">26 SWIG and Javascript</a></h3> +<h3><a href="Javascript.html#Javascript">27 SWIG and Javascript</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -1114,29 +1109,6 @@ </div> <!-- INDEX --> -<h3><a href="Lisp.html#Lisp">27 SWIG and Common Lisp</a></h3> - -<!-- INDEX --> -<div class="sectiontoc"> -<ul> -<li><a href="Lisp.html#Lisp_nn2">Allegro Common Lisp</a> -<li><a href="Lisp.html#Lisp_nn3">Common Foreign Function Interface(CFFI)</a> -<ul> -<li><a href="Lisp.html#Lisp_nn4">Additional Commandline Options </a> -<li><a href="Lisp.html#Lisp_nn5">Generating CFFI bindings</a> -<li><a href="Lisp.html#Lisp_nn6">Generating CFFI bindings for C++ code</a> -<li><a href="Lisp.html#Lisp_nn7">Inserting user code into generated files</a> -</ul> -<li><a href="Lisp.html#Lisp_nn8">CLISP</a> -<ul> -<li><a href="Lisp.html#Lisp_nn9">Additional Commandline Options </a> -<li><a href="Lisp.html#Lisp_nn10">Details on CLISP bindings</a> -</ul> -<li><a href="Lisp.html#Lisp_nn11">UFFI </a> -</ul> -</div> -<!-- INDEX --> - <h3><a href="Lua.html#Lua">28 SWIG and Lua</a></h3> <!-- INDEX --> @@ -1205,108 +1177,7 @@ </div> <!-- INDEX --> -<h3><a href="Modula3.html#Modula3">29 SWIG and Modula-3</a></h3> - -<!-- INDEX --> -<div class="sectiontoc"> -<ul> -<li><a href="Modula3.html#Modula3_modula3_overview">Overview</a> -<ul> -<li><a href="Modula3.html#Modula3_motivation">Motivation</a> -</ul> -<li><a href="Modula3.html#Modula3_conception">Conception</a> -<ul> -<li><a href="Modula3.html#Modula3_cinterface">Interfaces to C libraries</a> -<li><a href="Modula3.html#Modula3_cppinterface">Interfaces to C++ libraries</a> -</ul> -<li><a href="Modula3.html#Modula3_preliminaries">Preliminaries</a> -<ul> -<li><a href="Modula3.html#Modula3_compilers">Compilers</a> -<li><a href="Modula3.html#Modula3_commandline">Additional Commandline Options</a> -</ul> -<li><a href="Modula3.html#Modula3_typemaps">Modula-3 typemaps</a> -<ul> -<li><a href="Modula3.html#Modula3_inoutparam">Inputs and outputs</a> -<li><a href="Modula3.html#Modula3_ordinals">Subranges, Enumerations, Sets</a> -<li><a href="Modula3.html#Modula3_class">Objects</a> -<li><a href="Modula3.html#Modula3_imports">Imports</a> -<li><a href="Modula3.html#Modula3_exceptions">Exceptions</a> -<li><a href="Modula3.html#Modula3_typemap_example">Example</a> -</ul> -<li><a href="Modula3.html#Modula3_hints">More hints to the generator</a> -<ul> -<li><a href="Modula3.html#Modula3_features">Features</a> -<li><a href="Modula3.html#Modula3_pragmas">Pragmas</a> -</ul> -<li><a href="Modula3.html#Modula3_remarks">Remarks</a> -</ul> -</div> -<!-- INDEX --> - -<h3><a href="Mzscheme.html#Mzscheme">30 SWIG and MzScheme/Racket</a></h3> - -<!-- INDEX --> -<div class="sectiontoc"> -<ul> -<li><a href="Mzscheme.html#MzScheme_nn2">Creating native structures</a> -<li><a href="Mzscheme.html#MzScheme_simple">Simple example</a> -<li><a href="Mzscheme.html#MzScheme_external_docs">External documentation</a> -</ul> -</div> -<!-- INDEX --> - -<h3><a href="Ocaml.html#Ocaml">31 SWIG and Ocaml</a></h3> - -<!-- INDEX --> -<div class="sectiontoc"> -<ul> -<li><a href="Ocaml.html#Ocaml_nn2">Preliminaries</a> -<ul> -<li><a href="Ocaml.html#Ocaml_nn3">Running SWIG</a> -<li><a href="Ocaml.html#Ocaml_nn4">Compiling the code</a> -<li><a href="Ocaml.html#Ocaml_nn5">The camlp4 module</a> -<li><a href="Ocaml.html#Ocaml_nn6">Using your module</a> -<li><a href="Ocaml.html#Ocaml_nn7">Compilation problems and compiling with C++</a> -</ul> -<li><a href="Ocaml.html#Ocaml_nn8">The low-level Ocaml/C interface</a> -<ul> -<li><a href="Ocaml.html#Ocaml_nn9">The generated module</a> -<li><a href="Ocaml.html#Ocaml_nn10">Enums</a> -<ul> -<li><a href="Ocaml.html#Ocaml_nn11">Enum typing in Ocaml</a> -</ul> -<li><a href="Ocaml.html#Ocaml_nn12">Arrays</a> -<ul> -<li><a href="Ocaml.html#Ocaml_nn13">Simple types of bounded arrays</a> -<li><a href="Ocaml.html#Ocaml_nn14">Complex and unbounded arrays</a> -<li><a href="Ocaml.html#Ocaml_nn15">Using an object</a> -<li><a href="Ocaml.html#Ocaml_nn16">Example typemap for a function taking float * and int</a> -</ul> -<li><a href="Ocaml.html#Ocaml_nn17">C++ Classes</a> -<ul> -<li><a href="Ocaml.html#Ocaml_nn18">STL vector and string Example</a> -<li><a href="Ocaml.html#Ocaml_nn19">C++ Class Example</a> -<li><a href="Ocaml.html#Ocaml_nn20">Compiling the example</a> -<li><a href="Ocaml.html#Ocaml_nn21">Sample Session</a> -</ul> -<li><a href="Ocaml.html#Ocaml_nn22">Director Classes</a> -<ul> -<li><a href="Ocaml.html#Ocaml_nn23">Director Introduction</a> -<li><a href="Ocaml.html#Ocaml_nn24">Overriding Methods in Ocaml</a> -<li><a href="Ocaml.html#Ocaml_nn25">Director Usage Example</a> -<li><a href="Ocaml.html#Ocaml_nn26">Creating director objects</a> -<li><a href="Ocaml.html#Ocaml_nn27">Typemaps for directors, directorin, directorout, directorargout</a> -<li><a href="Ocaml.html#Ocaml_nn28">typemap</a> -<li><a href="Ocaml.html#Ocaml_nn29">directorout typemap</a> -<li><a href="Ocaml.html#Ocaml_nn30">directorargout typemap</a> -</ul> -<li><a href="Ocaml.html#Ocaml_nn31">Exceptions</a> -</ul> -</ul> -</div> -<!-- INDEX --> - -<h3><a href="Octave.html#Octave">32 SWIG and Octave</a></h3> +<h3><a href="Octave.html#Octave">29 SWIG and Octave</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -1346,7 +1217,7 @@ </div> <!-- INDEX --> -<h3><a href="Perl5.html#Perl5">33 SWIG and Perl5</a></h3> +<h3><a href="Perl5.html#Perl5">30 SWIG and Perl5</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -1422,7 +1293,7 @@ </div> <!-- INDEX --> -<h3><a href="Php.html#Php">34 SWIG and PHP</a></h3> +<h3><a href="Php.html#Php">31 SWIG and PHP</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -1463,31 +1334,7 @@ </div> <!-- INDEX --> -<h3><a href="Pike.html#Pike">35 SWIG and Pike</a></h3> - -<!-- INDEX --> -<div class="sectiontoc"> -<ul> -<li><a href="Pike.html#Pike_nn2">Preliminaries</a> -<ul> -<li><a href="Pike.html#Pike_nn3">Running SWIG</a> -<li><a href="Pike.html#Pike_nn4">Getting the right header files</a> -<li><a href="Pike.html#Pike_nn5">Using your module</a> -</ul> -<li><a href="Pike.html#Pike_nn6">Basic C/C++ Mapping</a> -<ul> -<li><a href="Pike.html#Pike_nn7">Modules</a> -<li><a href="Pike.html#Pike_nn8">Functions</a> -<li><a href="Pike.html#Pike_nn9">Global variables</a> -<li><a href="Pike.html#Pike_nn10">Constants and enumerated types</a> -<li><a href="Pike.html#Pike_nn11">Constructors and Destructors</a> -<li><a href="Pike.html#Pike_nn12">Static Members</a> -</ul> -</ul> -</div> -<!-- INDEX --> - -<h3><a href="Python.html#Python">36 SWIG and Python</a></h3> +<h3><a href="Python.html#Python">32 SWIG and Python</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -1502,7 +1349,8 @@ <li><a href="Python.html#Python_nn9">Using your module</a> <li><a href="Python.html#Python_nn10">Compilation of C++ extensions</a> <li><a href="Python.html#Python_nn11">Compiling for 64-bit platforms</a> -<li><a href="Python.html#Python_nn12">Building Python Extensions under Windows</a> +<li><a href="Python.html#Python_nn12">Building Python extensions under Windows</a> +<li><a href="Python.html#Python_commandline">Additional Python commandline options</a> </ul> <li><a href="Python.html#Python_nn13">A tour of basic C/C++ wrapping</a> <ul> @@ -1535,7 +1383,6 @@ <li><a href="Python.html#Python_builtin_overloads">Operator overloads and slots -- use them!</a> </ul> <li><a href="Python.html#Python_nn30">Memory management</a> -<li><a href="Python.html#Python_nn31">Python 2.2 and classic classes</a> </ul> <li><a href="Python.html#Python_directors">Cross language polymorphism</a> <ul> @@ -1553,6 +1400,10 @@ <li><a href="Python.html#Python_nn42">Adding additional Python code</a> <li><a href="Python.html#Python_nn43">Class extension with %extend</a> <li><a href="Python.html#Python_nn44">Exception handling with %exception</a> +<li><a href="Python.html#Python_optimization">Optimization options</a> +<ul> +<li><a href="Python.html#Python_fastproxy">-fastproxy</a> +</ul> </ul> <li><a href="Python.html#Python_nn45">Tips and techniques</a> <ul> @@ -1577,6 +1428,7 @@ <li><a href="Python.html#Python_nn62">Mapping Python tuples into small arrays</a> <li><a href="Python.html#Python_nn63">Mapping sequences to C arrays</a> <li><a href="Python.html#Python_nn64">Pointer handling</a> +<li><a href="Python.html#Python_memory_management_member_variables">Memory management when returning references to member variables</a> </ul> <li><a href="Python.html#Python_nn65">Docstring Features</a> <ul> @@ -1597,12 +1449,13 @@ <li><a href="Python.html#Python_absrelimports">Absolute and relative imports</a> <li><a href="Python.html#Python_absimport">Enforcing absolute import semantics</a> <li><a href="Python.html#Python_importfrominit">Importing from __init__.py</a> -<li><a href="Python.html#Python_implicit_namespace_packages">Implicit Namespace Packages</a> -<li><a href="Python.html#Python_package_search">Searching for the wrapper module</a> +<li><a href="Python.html#Python_implicit_namespace_packages">Implicit namespace packages</a> +<li><a href="Python.html#Python_package_search">Location of modules</a> <ul> <li><a href="Python.html#Python_package_search_both_package_modules">Both modules in the same package</a> -<li><a href="Python.html#Python_package_search_wrapper_split">Split modules</a> <li><a href="Python.html#Python_package_search_both_global_modules">Both modules are global</a> +<li><a href="Python.html#Python_package_search_wrapper_split">Split modules custom configuration</a> +<li><a href="Python.html#Python_custom_module_import">More on customizing the module import code</a> <li><a href="Python.html#Python_package_search_static">Statically linked C modules</a> </ul> </ul> @@ -1614,11 +1467,16 @@ <li><a href="Python.html#Python_nn77">Byte string output conversion</a> <li><a href="Python.html#Python_2_unicode">Python 2 Unicode</a> </ul> +<li><a href="Python.html#Python_multithreaded">Support for Multithreaded Applications</a> +<ul> +<li><a href="Python.html#Python_thread_UI">UI for Enabling Multithreading Support</a> +<li><a href="Python.html#Python_thread_performance">Multithread Performance</a> +</ul> </ul> </div> <!-- INDEX --> -<h3><a href="R.html#R">37 SWIG and R</a></h3> +<h3><a href="R.html#R">33 SWIG and R</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -1634,7 +1492,7 @@ </div> <!-- INDEX --> -<h3><a href="Ruby.html#Ruby">38 SWIG and Ruby</a></h3> +<h3><a href="Ruby.html#Ruby">34 SWIG and Ruby</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -1772,7 +1630,7 @@ </div> <!-- INDEX --> -<h3><a href="Scilab.html#Scilab">39 SWIG and Scilab</a></h3> +<h3><a href="Scilab.html#Scilab">35 SWIG and Scilab</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -1803,7 +1661,7 @@ </ul> <li><a href="Scilab.html#Scilab_wrapping_pointers">Pointers</a> <ul> -<li><a href="Scilab.html#Scilab_wrapping_pointers_pointer_adresses">Utility functions</a> +<li><a href="Scilab.html#Scilab_wrapping_pointers_utility_functions">Utility functions</a> <li><a href="Scilab.html#Scilab_wrapping_pointers_null_pointers">Null pointers:</a> </ul> <li><a href="Scilab.html#Scilab_wrapping_structs">Structures</a> @@ -1841,7 +1699,7 @@ </div> <!-- INDEX --> -<h3><a href="Tcl.html#Tcl">40 SWIG and Tcl</a></h3> +<h3><a href="Tcl.html#Tcl">36 SWIG and Tcl</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -1907,7 +1765,74 @@ </div> <!-- INDEX --> -<h3><a href="Extending.html#Extending">41 Extending SWIG to support new languages</a></h3> +<h3><a href="Mzscheme.html#Mzscheme">37 SWIG and MzScheme/Racket</a></h3> + +<!-- INDEX --> +<div class="sectiontoc"> +<ul> +<li><a href="Mzscheme.html#MzScheme_nn2">Creating native structures</a> +<li><a href="Mzscheme.html#MzScheme_simple">Simple example</a> +<li><a href="Mzscheme.html#MzScheme_external_docs">External documentation</a> +</ul> +</div> +<!-- INDEX --> + +<h3><a href="Ocaml.html#Ocaml">38 SWIG and OCaml</a></h3> + +<!-- INDEX --> +<div class="sectiontoc"> +<ul> +<li><a href="Ocaml.html#Ocaml_nn2">Preliminaries</a> +<ul> +<li><a href="Ocaml.html#Ocaml_nn3">Running SWIG</a> +<li><a href="Ocaml.html#Ocaml_nn4">Compiling the code</a> +<li><a href="Ocaml.html#Ocaml_nn5">The camlp4 module</a> +<li><a href="Ocaml.html#Ocaml_nn6">Using your module</a> +<li><a href="Ocaml.html#Ocaml_nn7">Compilation problems and compiling with C++</a> +</ul> +<li><a href="Ocaml.html#Ocaml_nn8">The low-level Ocaml/C interface</a> +<ul> +<li><a href="Ocaml.html#Ocaml_nn9">The generated module</a> +<li><a href="Ocaml.html#Ocaml_nn10">Enums</a> +<ul> +<li><a href="Ocaml.html#Ocaml_nn11">Enum typing in Ocaml</a> +</ul> +<li><a href="Ocaml.html#Ocaml_nn12">Arrays</a> +<ul> +<li><a href="Ocaml.html#Ocaml_nn13">Simple types of bounded arrays</a> +<li><a href="Ocaml.html#Ocaml_nn14">Complex and unbounded arrays</a> +<li><a href="Ocaml.html#Ocaml_nn15">Using an object</a> +<li><a href="Ocaml.html#Ocaml_nn16">Example typemap for a function taking float * and int</a> +</ul> +<li><a href="Ocaml.html#Ocaml_nn17">C++ Classes</a> +<ul> +<li><a href="Ocaml.html#Ocaml_nn18">STL vector and string Example</a> +<li><a href="Ocaml.html#Ocaml_nn19">C++ Class Example</a> +<li><a href="Ocaml.html#Ocaml_nn20">Compiling the example</a> +<li><a href="Ocaml.html#Ocaml_nn21">Sample Session</a> +</ul> +<li><a href="Ocaml.html#Ocaml_nn22">Director Classes</a> +<ul> +<li><a href="Ocaml.html#Ocaml_nn23">Director Introduction</a> +<li><a href="Ocaml.html#Ocaml_nn24">Overriding Methods in Ocaml</a> +<li><a href="Ocaml.html#Ocaml_nn25">Director Usage Example</a> +<li><a href="Ocaml.html#Ocaml_nn26">Creating director objects</a> +<li><a href="Ocaml.html#Ocaml_nn27">Typemaps for directors, directorin, directorout, directorargout</a> +<li><a href="Ocaml.html#Ocaml_nn28">directorin typemap</a> +<li><a href="Ocaml.html#Ocaml_nn29">directorout typemap</a> +<li><a href="Ocaml.html#Ocaml_nn30">directorargout typemap</a> +</ul> +<li><a href="Ocaml.html#Ocaml_nn31">Exceptions</a> +</ul> +<li><a href="Ocaml.html#Ocaml_nn32">Documentation Features</a> +<ul> +<li><a href="Ocaml.html#Ocaml_nn33">Module docstring</a> +</ul> +</ul> +</div> +<!-- INDEX --> + +<h3><a href="Extending.html#Extending">39 Extending SWIG to support new languages</a></h3> <!-- INDEX --> <div class="sectiontoc"> @@ -1965,8 +1890,13 @@ <li><a href="Extending.html#Extending_running_test_suite">Running the test-suite</a> </ul> <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="Extending.html#Extending_language_status">Target language status</a> +<ul> +<li><a href="Extending.html#Extending_supported_status">Supported status</a> +<li><a href="Extending.html#Extending_experimental_status">Experimental status</a> +</ul> +<li><a href="Extending.html#Extending_prerequisites">Prerequisites for adding a new language module to the SWIG distribution</a> </ul> <li><a href="Extending.html#Extending_debugging_options">Debugging Options</a> <li><a href="Extending.html#Extending_nn46">Guide to parse tree nodes</a> |