diff options
Diffstat (limited to 'Doc/Manual/Python.html')
| -rw-r--r-- | Doc/Manual/Python.html | 150 |
1 files changed, 75 insertions, 75 deletions
diff --git a/Doc/Manual/Python.html b/Doc/Manual/Python.html index 23271e649..1b8a3f671 100644 --- a/Doc/Manual/Python.html +++ b/Doc/Manual/Python.html @@ -6,7 +6,7 @@ </head> <body bgcolor="#ffffff"> -<H1><a name="Python"></a>32 SWIG and Python</H1> +<H1><a name="Python"></a>33 SWIG and Python</H1> <!-- INDEX --> <div class="sectiontoc"> <ul> @@ -128,7 +128,7 @@ very least, make sure you read the "<a href="SWIG.html#SWIG">SWIG Basics</a>" chapter. </p> -<H2><a name="Python_nn2"></a>32.1 Overview</H2> +<H2><a name="Python_nn2"></a>33.1 Overview</H2> <p> @@ -155,10 +155,10 @@ described followed by a discussion of low-level implementation details. </p> -<H2><a name="Python_nn3"></a>32.2 Preliminaries</H2> +<H2><a name="Python_nn3"></a>33.2 Preliminaries</H2> -<H3><a name="Python_nn4"></a>32.2.1 Running SWIG</H3> +<H3><a name="Python_nn4"></a>33.2.1 Running SWIG</H3> <p> @@ -256,13 +256,13 @@ The following sections have further practical examples and details on how you might go about compiling and using the generated files. </p> -<H3><a name="Python_nn6"></a>32.2.2 Using distutils</H3> +<H3><a name="Python_nn6"></a>33.2.2 Using distutils</H3> <p> The preferred approach to building an extension module for python is to compile it with distutils, which comes with all recent versions of python -(<a href="http://docs.python.org/dist/dist.html">Distutils Docs</a>). +(<a href="http://docs.python.org/distutils/index.html">Distutils Docs</a>). </p> <p> @@ -348,7 +348,7 @@ This same approach works on all platforms if the appropriate compiler is install can even build extensions to the standard Windows Python using MingGW) </p> -<H3><a name="Python_nn7"></a>32.2.3 Hand compiling a dynamic module</H3> +<H3><a name="Python_nn7"></a>33.2.3 Hand compiling a dynamic module</H3> <p> @@ -396,7 +396,7 @@ module actually consists of two files; <tt>socket.py</tt> and </p> -<H3><a name="Python_nn8"></a>32.2.4 Static linking</H3> +<H3><a name="Python_nn8"></a>33.2.4 Static linking</H3> <p> @@ -475,7 +475,7 @@ If using static linking, you might want to rely on a different approach (perhaps using distutils). </p> -<H3><a name="Python_nn9"></a>32.2.5 Using your module</H3> +<H3><a name="Python_nn9"></a>33.2.5 Using your module</H3> <p> @@ -632,7 +632,7 @@ system configuration (this requires root access and you will need to read the man pages). </p> -<H3><a name="Python_nn10"></a>32.2.6 Compilation of C++ extensions</H3> +<H3><a name="Python_nn10"></a>33.2.6 Compilation of C++ extensions</H3> <p> @@ -724,7 +724,7 @@ erratic program behavior. If working with lots of software components, you might want to investigate using a more formal standard such as COM. </p> -<H3><a name="Python_nn11"></a>32.2.7 Compiling for 64-bit platforms</H3> +<H3><a name="Python_nn11"></a>33.2.7 Compiling for 64-bit platforms</H3> <p> @@ -761,7 +761,7 @@ and -m64 allow you to choose the desired binary format for your python extension. </p> -<H3><a name="Python_nn12"></a>32.2.8 Building Python Extensions under Windows</H3> +<H3><a name="Python_nn12"></a>33.2.8 Building Python Extensions under Windows</H3> <p> @@ -870,7 +870,7 @@ SWIG Wiki</a>. </p> -<H2><a name="Python_nn13"></a>32.3 A tour of basic C/C++ wrapping</H2> +<H2><a name="Python_nn13"></a>33.3 A tour of basic C/C++ wrapping</H2> <p> @@ -879,7 +879,7 @@ to your C/C++ code. Functions are wrapped as functions, classes are wrapped as This section briefly covers the essential aspects of this wrapping. </p> -<H3><a name="Python_nn14"></a>32.3.1 Modules</H3> +<H3><a name="Python_nn14"></a>33.3.1 Modules</H3> <p> @@ -892,7 +892,7 @@ module name, make sure you don't use the same name as a built-in Python command or standard module name. </p> -<H3><a name="Python_nn15"></a>32.3.2 Functions</H3> +<H3><a name="Python_nn15"></a>33.3.2 Functions</H3> <p> @@ -916,7 +916,7 @@ like you think it does: >>> </pre></div> -<H3><a name="Python_nn16"></a>32.3.3 Global variables</H3> +<H3><a name="Python_nn16"></a>33.3.3 Global variables</H3> <p> @@ -1054,7 +1054,7 @@ that starts with a leading underscore. SWIG does not create <tt>cvar</tt> if there are no global variables in a module. </p> -<H3><a name="Python_nn17"></a>32.3.4 Constants and enums</H3> +<H3><a name="Python_nn17"></a>33.3.4 Constants and enums</H3> <p> @@ -1094,7 +1094,7 @@ other object. Unfortunately, there is no easy way for SWIG to generate code that prevents this. You will just have to be careful. </p> -<H3><a name="Python_nn18"></a>32.3.5 Pointers</H3> +<H3><a name="Python_nn18"></a>33.3.5 Pointers</H3> <p> @@ -1235,7 +1235,7 @@ C-style cast may return a bogus result whereas as the C++-style cast will return <tt>None</tt> if the conversion can't be performed. </p> -<H3><a name="Python_nn19"></a>32.3.6 Structures</H3> +<H3><a name="Python_nn19"></a>33.3.6 Structures</H3> <p> @@ -1424,7 +1424,7 @@ everything works just like you would expect. For example: </pre> </div> -<H3><a name="Python_nn20"></a>32.3.7 C++ classes</H3> +<H3><a name="Python_nn20"></a>33.3.7 C++ classes</H3> <p> @@ -1513,7 +1513,7 @@ they are accessed through <tt>cvar</tt> like this: </pre> </div> -<H3><a name="Python_nn21"></a>32.3.8 C++ inheritance</H3> +<H3><a name="Python_nn21"></a>33.3.8 C++ inheritance</H3> <p> @@ -1568,7 +1568,7 @@ then the function <tt>spam()</tt> accepts <tt>Foo *</tt> or a pointer to any cla It is safe to use multiple inheritance with SWIG. </p> -<H3><a name="Python_nn22"></a>32.3.9 Pointers, references, values, and arrays</H3> +<H3><a name="Python_nn22"></a>33.3.9 Pointers, references, values, and arrays</H3> <p> @@ -1629,7 +1629,7 @@ treated as a returning value, and it will follow the same allocation/deallocation process. </p> -<H3><a name="Python_nn23"></a>32.3.10 C++ overloaded functions</H3> +<H3><a name="Python_nn23"></a>33.3.10 C++ overloaded functions</H3> <p> @@ -1752,7 +1752,7 @@ first declaration takes precedence. Please refer to the "SWIG and C++" chapter for more information about overloading. </p> -<H3><a name="Python_nn24"></a>32.3.11 C++ operators</H3> +<H3><a name="Python_nn24"></a>33.3.11 C++ operators</H3> <p> @@ -1841,7 +1841,7 @@ Also, be aware that certain operators don't map cleanly to Python. For instance overloaded assignment operators don't map to Python semantics and will be ignored. </p> -<H3><a name="Python_nn25"></a>32.3.12 C++ namespaces</H3> +<H3><a name="Python_nn25"></a>33.3.12 C++ namespaces</H3> <p> @@ -1908,7 +1908,7 @@ utilizes thousands of small deeply nested namespaces each with identical symbol names, well, then you get what you deserve. </p> -<H3><a name="Python_nn26"></a>32.3.13 C++ templates</H3> +<H3><a name="Python_nn26"></a>33.3.13 C++ templates</H3> <p> @@ -1962,7 +1962,7 @@ Some more complicated examples will appear later. </p> -<H3><a name="Python_nn27"></a>32.3.14 C++ Smart Pointers</H3> +<H3><a name="Python_nn27"></a>33.3.14 C++ Smart Pointers</H3> <p> @@ -2047,7 +2047,7 @@ simply use the <tt>__deref__()</tt> method. For example: </div> -<H3><a name="Python_nn27a"></a>32.3.15 C++ Reference Counted Objects (ref/unref)</H3> +<H3><a name="Python_nn27a"></a>33.3.15 C++ Reference Counted Objects (ref/unref)</H3> <p> @@ -2190,7 +2190,7 @@ python releases the proxy instance. </p> -<H2><a name="Python_nn28"></a>32.4 Further details on the Python class interface</H2> +<H2><a name="Python_nn28"></a>33.4 Further details on the Python class interface</H2> <p> @@ -2203,7 +2203,7 @@ of low-level details were omitted. This section provides a brief overview of how the proxy classes work. </p> -<H3><a name="Python_nn29"></a>32.4.1 Proxy classes</H3> +<H3><a name="Python_nn29"></a>33.4.1 Proxy classes</H3> <p> @@ -2292,7 +2292,7 @@ you can attach new Python methods to the class and you can even inherit from it by Python built-in types until Python 2.2). </p> -<H3><a name="Python_nn30"></a>32.4.2 Memory management</H3> +<H3><a name="Python_nn30"></a>33.4.2 Memory management</H3> <p> @@ -2484,7 +2484,7 @@ It is also possible to deal with situations like this using typemaps--an advanced topic discussed later. </p> -<H3><a name="Python_nn31"></a>32.4.3 Python 2.2 and classic classes</H3> +<H3><a name="Python_nn31"></a>33.4.3 Python 2.2 and classic classes</H3> <p> @@ -2521,7 +2521,7 @@ class itself. In Python-2.1 and earlier, they have to be accessed as a global function or through an instance (see the earlier section). </p> -<H2><a name="Python_directors"></a>32.5 Cross language polymorphism</H2> +<H2><a name="Python_directors"></a>33.5 Cross language polymorphism</H2> <p> @@ -2555,7 +2555,7 @@ proxy classes, director classes, and C wrapper functions takes care of all the cross-language method routing transparently. </p> -<H3><a name="Python_nn33"></a>32.5.1 Enabling directors</H3> +<H3><a name="Python_nn33"></a>33.5.1 Enabling directors</H3> <p> @@ -2648,7 +2648,7 @@ class MyFoo(mymodule.Foo): </div> -<H3><a name="Python_nn34"></a>32.5.2 Director classes</H3> +<H3><a name="Python_nn34"></a>33.5.2 Director classes</H3> @@ -2730,7 +2730,7 @@ so there is no need for the extra overhead involved with routing the calls through Python. </p> -<H3><a name="Python_nn35"></a>32.5.3 Ownership and object destruction</H3> +<H3><a name="Python_nn35"></a>33.5.3 Ownership and object destruction</H3> <p> @@ -2797,7 +2797,7 @@ deleting all the Foo pointers it contains at some point. Note that no hard references to the Foo objects remain in Python. </p> -<H3><a name="Python_nn36"></a>32.5.4 Exception unrolling</H3> +<H3><a name="Python_nn36"></a>33.5.4 Exception unrolling</H3> <p> @@ -2856,7 +2856,7 @@ Swig::DirectorMethodException is thrown, Python will register the exception as soon as the C wrapper function returns. </p> -<H3><a name="Python_nn37"></a>32.5.5 Overhead and code bloat</H3> +<H3><a name="Python_nn37"></a>33.5.5 Overhead and code bloat</H3> <p> @@ -2890,7 +2890,7 @@ directive) for only those methods that are likely to be extended in Python. </p> -<H3><a name="Python_nn38"></a>32.5.6 Typemaps</H3> +<H3><a name="Python_nn38"></a>33.5.6 Typemaps</H3> <p> @@ -2904,7 +2904,7 @@ need to be supported. </p> -<H3><a name="Python_nn39"></a>32.5.7 Miscellaneous</H3> +<H3><a name="Python_nn39"></a>33.5.7 Miscellaneous</H3> <p> @@ -2951,7 +2951,7 @@ methods that return const references. </p> -<H2><a name="Python_nn40"></a>32.6 Common customization features</H2> +<H2><a name="Python_nn40"></a>33.6 Common customization features</H2> <p> @@ -2964,7 +2964,7 @@ This section describes some common SWIG features that are used to improve your the interface to an extension module. </p> -<H3><a name="Python_nn41"></a>32.6.1 C/C++ helper functions</H3> +<H3><a name="Python_nn41"></a>33.6.1 C/C++ helper functions</H3> <p> @@ -3045,7 +3045,7 @@ hard to implement. It is possible to clean this up using Python code, typemaps, customization features as covered in later sections. </p> -<H3><a name="Python_nn42"></a>32.6.2 Adding additional Python code</H3> +<H3><a name="Python_nn42"></a>33.6.2 Adding additional Python code</H3> <p> @@ -3194,7 +3194,7 @@ public: -<H3><a name="Python_nn43"></a>32.6.3 Class extension with %extend</H3> +<H3><a name="Python_nn43"></a>33.6.3 Class extension with %extend</H3> <p> @@ -3283,7 +3283,7 @@ Vector(12,14,16) in any way---the extensions only show up in the Python interface. </p> -<H3><a name="Python_nn44"></a>32.6.4 Exception handling with %exception</H3> +<H3><a name="Python_nn44"></a>33.6.4 Exception handling with %exception</H3> <p> @@ -3409,7 +3409,7 @@ The language-independent <tt>exception.i</tt> library file can also be used to raise exceptions. See the <a href="Library.html#Library">SWIG Library</a> chapter. </p> -<H2><a name="Python_nn45"></a>32.7 Tips and techniques</H2> +<H2><a name="Python_nn45"></a>33.7 Tips and techniques</H2> <p> @@ -3419,7 +3419,7 @@ strings, binary data, and arrays. This chapter discusses the common techniques solving these problems. </p> -<H3><a name="Python_nn46"></a>32.7.1 Input and output parameters</H3> +<H3><a name="Python_nn46"></a>33.7.1 Input and output parameters</H3> <p> @@ -3632,7 +3632,7 @@ void foo(Bar *OUTPUT); may not have the intended effect since <tt>typemaps.i</tt> does not define an OUTPUT rule for <tt>Bar</tt>. </p> -<H3><a name="Python_nn47"></a>32.7.2 Simple pointers</H3> +<H3><a name="Python_nn47"></a>33.7.2 Simple pointers</H3> <p> @@ -3701,7 +3701,7 @@ If you replace <tt>%pointer_functions()</tt> by <tt>%pointer_class(type,name)</t See the <a href="Library.html#Library">SWIG Library</a> chapter for further details. </p> -<H3><a name="Python_nn48"></a>32.7.3 Unbounded C Arrays</H3> +<H3><a name="Python_nn48"></a>33.7.3 Unbounded C Arrays</H3> <p> @@ -3763,7 +3763,7 @@ well suited for applications in which you need to create buffers, package binary data, etc. </p> -<H3><a name="Python_nn49"></a>32.7.4 String handling</H3> +<H3><a name="Python_nn49"></a>33.7.4 String handling</H3> <p> @@ -3832,7 +3832,7 @@ If you need to return binary data, you might use the also be used to extra binary data from arbitrary pointers. </p> -<H2><a name="Python_nn53"></a>32.8 Typemaps</H2> +<H2><a name="Python_nn53"></a>33.8 Typemaps</H2> <p> @@ -3849,7 +3849,7 @@ Typemaps are only used if you want to change some aspect of the primitive C-Python interface or if you want to elevate your guru status. </p> -<H3><a name="Python_nn54"></a>32.8.1 What is a typemap?</H3> +<H3><a name="Python_nn54"></a>33.8.1 What is a typemap?</H3> <p> @@ -3965,7 +3965,7 @@ parameter is omitted): </pre> </div> -<H3><a name="Python_nn55"></a>32.8.2 Python typemaps</H3> +<H3><a name="Python_nn55"></a>33.8.2 Python typemaps</H3> <p> @@ -4006,7 +4006,7 @@ a look at the SWIG library version 1.3.20 or so. </p> -<H3><a name="Python_nn56"></a>32.8.3 Typemap variables</H3> +<H3><a name="Python_nn56"></a>33.8.3 Typemap variables</H3> <p> @@ -4077,7 +4077,7 @@ properly assigned. The Python name of the wrapper function being created. </div> -<H3><a name="Python_nn57"></a>32.8.4 Useful Python Functions</H3> +<H3><a name="Python_nn57"></a>33.8.4 Useful Python Functions</H3> <p> @@ -4205,7 +4205,7 @@ write me </pre> </div> -<H2><a name="Python_nn58"></a>32.9 Typemap Examples</H2> +<H2><a name="Python_nn58"></a>33.9 Typemap Examples</H2> <p> @@ -4214,7 +4214,7 @@ might look at the files "<tt>python.swg</tt>" and "<tt>typemaps.i</tt>" in the SWIG library. </p> -<H3><a name="Python_nn59"></a>32.9.1 Converting Python list to a char ** </H3> +<H3><a name="Python_nn59"></a>33.9.1 Converting Python list to a char ** </H3> <p> @@ -4294,7 +4294,7 @@ memory allocation is used to allocate memory for the array, the the C function. </p> -<H3><a name="Python_nn60"></a>32.9.2 Expanding a Python object into multiple arguments</H3> +<H3><a name="Python_nn60"></a>33.9.2 Expanding a Python object into multiple arguments</H3> <p> @@ -4373,7 +4373,7 @@ to supply the argument count. This is automatically set by the typemap code. F </pre> </div> -<H3><a name="Python_nn61"></a>32.9.3 Using typemaps to return arguments</H3> +<H3><a name="Python_nn61"></a>33.9.3 Using typemaps to return arguments</H3> <p> @@ -4462,7 +4462,7 @@ function can now be used as follows: >>> </pre></div> -<H3><a name="Python_nn62"></a>32.9.4 Mapping Python tuples into small arrays</H3> +<H3><a name="Python_nn62"></a>33.9.4 Mapping Python tuples into small arrays</H3> <p> @@ -4511,7 +4511,7 @@ array, such an approach would not be recommended for huge arrays, but for small structures, this approach works fine. </p> -<H3><a name="Python_nn63"></a>32.9.5 Mapping sequences to C arrays</H3> +<H3><a name="Python_nn63"></a>33.9.5 Mapping sequences to C arrays</H3> <p> @@ -4592,7 +4592,7 @@ static int convert_darray(PyObject *input, double *ptr, int size) { %} %typemap(in) double [ANY](double temp[$1_dim0]) { - if (!convert_darray($input,temp,$1_dim0))) { + if (!convert_darray($input,temp,$1_dim0)) { return NULL; } $1 = &temp[0]; @@ -4600,7 +4600,7 @@ static int convert_darray(PyObject *input, double *ptr, int size) { </pre> </div> -<H3><a name="Python_nn64"></a>32.9.6 Pointer handling</H3> +<H3><a name="Python_nn64"></a>33.9.6 Pointer handling</H3> <p> @@ -4697,7 +4697,7 @@ class object (if applicable). -<H2><a name="Python_nn65"></a>32.10 Docstring Features</H2> +<H2><a name="Python_nn65"></a>33.10 Docstring Features</H2> <p> @@ -4725,7 +4725,7 @@ of your users much simpler. </p> -<H3><a name="Python_nn66"></a>32.10.1 Module docstring</H3> +<H3><a name="Python_nn66"></a>33.10.1 Module docstring</H3> <p> @@ -4759,7 +4759,7 @@ layout of controls on a panel, etc. to be loaded from an XML file." </div> -<H3><a name="Python_nn67"></a>32.10.2 %feature("autodoc")</H3> +<H3><a name="Python_nn67"></a>33.10.2 %feature("autodoc")</H3> <p> @@ -4786,7 +4786,7 @@ names, default values if any, and return type if any. There are also three options for autodoc controlled by the value given to the feature, described below. -<H4><a name="Python_nn68"></a>32.10.2.1 %feature("autodoc", "0")</H4> +<H4><a name="Python_nn68"></a>33.10.2.1 %feature("autodoc", "0")</H4> <p> @@ -4815,7 +4815,7 @@ def function_name(*args, **kwargs): </div> -<H4><a name="Python_nn69"></a>32.10.2.2 %feature("autodoc", "1")</H4> +<H4><a name="Python_nn69"></a>33.10.2.2 %feature("autodoc", "1")</H4> <p> @@ -4840,7 +4840,7 @@ def function_name(*args, **kwargs): -<H4><a name="Python_nn70"></a>32.10.2.3 %feature("autodoc", "docstring")</H4> +<H4><a name="Python_nn70"></a>33.10.2.3 %feature("autodoc", "docstring")</H4> <p> @@ -4859,7 +4859,7 @@ void GetPosition(int* OUTPUT, int* OUTPUT); </div> -<H3><a name="Python_nn71"></a>32.10.3 %feature("docstring")</H3> +<H3><a name="Python_nn71"></a>33.10.3 %feature("docstring")</H3> <p> @@ -4891,7 +4891,7 @@ with more than one line. </pre> </div> -<H2><a name="Python_nn72"></a>32.11 Python Packages</H2> +<H2><a name="Python_nn72"></a>33.11 Python Packages</H2> <p> @@ -4918,7 +4918,7 @@ and also in base class declarations, etc. if the package name is different than its own. </p> -<H2><a name="Python_python3support"></a>32.12 Python 3 Support</H2> +<H2><a name="Python_python3support"></a>33.12 Python 3 Support</H2> <p> @@ -4945,7 +4945,7 @@ The following are Python 3.0 new features that are currently supported by SWIG. </p> -<H3><a name="Python_nn74"></a>32.12.1 Function annotation</H3> +<H3><a name="Python_nn74"></a>33.12.1 Function annotation</H3> <p> @@ -4977,7 +4977,7 @@ all overloaded functions share the same function in SWIG generated proxy class. For detailed usage of function annotation, see PEP 3107. </p> -<H3><a name="Python_nn75"></a>32.12.2 Buffer interface</H3> +<H3><a name="Python_nn75"></a>33.12.2 Buffer interface</H3> <p> @@ -5129,7 +5129,7 @@ modify the buffer. </div> -<H3><a name="Python_nn76"></a>32.12.3 Abstract base classes</H3> +<H3><a name="Python_nn76"></a>33.12.3 Abstract base classes</H3> <p> |