jyapayne/swig
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Put the chapters back in order after erroneously incorrectly reordering them in last checkin

Browse source 
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@10294 626c5289-ae23-0410-ae9c-e8d60b6d4f22
This commit is contained in:
William S Fulton 2008-03-02 22:41:58 +00:00
commit c99fe90574
35 changed files with 1572 additions and 1571 deletions
Download patch file Download diff file Expand all files Collapse all files

94
Doc/Manual/Perl5.html
View file

@ -6,7 +6,7 @@
</head>
<body bgcolor="#ffffff">
<H1><a name="Perl5"></a>19 SWIG and Perl5</H1>
<H1><a name="Perl5"></a>27 SWIG and Perl5</H1>
<!-- INDEX -->
<div class="sectiontoc">
<ul>
@ -87,7 +87,7 @@ later. Earlier versions are problematic and SWIG generated extensions
may not compile or run correctly.
</p>
<H2><a name="Perl5_nn2"></a>19.1 Overview</H2>
<H2><a name="Perl5_nn2"></a>27.1 Overview</H2>
<p>
@ -108,7 +108,7 @@ described. Advanced customization features, typemaps, and other
options are found near the end of the chapter.
</p>
<H2><a name="Perl5_nn3"></a>19.2 Preliminaries</H2>
<H2><a name="Perl5_nn3"></a>27.2 Preliminaries</H2>
<p>
@ -133,7 +133,7 @@ To build the module, you will need to compile the file
<tt>example_wrap.c</tt> and link it with the rest of your program.
</p>
<H3><a name="Perl5_nn4"></a>19.2.1 Getting the right header files</H3>
<H3><a name="Perl5_nn4"></a>27.2.1 Getting the right header files</H3>
<p>
@ -165,7 +165,7 @@ loaded, an easy way to find out is to run Perl itself.
</pre>
</div>
<H3><a name="Perl5_nn5"></a>19.2.2 Compiling a dynamic module</H3>
<H3><a name="Perl5_nn5"></a>27.2.2 Compiling a dynamic module</H3>
<p>
@ -198,7 +198,7 @@ the target should be named `<tt>example.so</tt>',
`<tt>example.sl</tt>', or the appropriate dynamic module name on your system.
</p>
<H3><a name="Perl5_nn6"></a>19.2.3 Building a dynamic module with MakeMaker</H3>
<H3><a name="Perl5_nn6"></a>27.2.3 Building a dynamic module with MakeMaker</H3>
<p>
@ -232,7 +232,7 @@ the preferred approach to compilation. More information about MakeMaker can be
found in "Programming Perl, 2nd ed." by Larry Wall, Tom Christiansen,
and Randal Schwartz.</p>
<H3><a name="Perl5_nn7"></a>19.2.4 Building a static version of Perl</H3>
<H3><a name="Perl5_nn7"></a>27.2.4 Building a static version of Perl</H3>
<p>
@ -301,7 +301,7 @@ added to it. Depending on your machine, you may need to link with
additional libraries such as <tt>-lsocket, -lnsl, -ldl</tt>, etc.
</p>
<H3><a name="Perl5_nn8"></a>19.2.5 Using the module</H3>
<H3><a name="Perl5_nn8"></a>27.2.5 Using the module</H3>
<p>
@ -456,7 +456,7 @@ system configuration (this requires root access and you will need to
read the man pages).
</p>
<H3><a name="Perl5_nn9"></a>19.2.6 Compilation problems and compiling with C++</H3>
<H3><a name="Perl5_nn9"></a>27.2.6 Compilation problems and compiling with C++</H3>
<p>
@ -599,7 +599,7 @@ have to find the macro that conflicts and add an #undef into the .i file. Pleas
any conflicting macros you find to <a href="http://www.swig.org/mail.html">swig-user mailing list</a>.
</p>
<H3><a name="Perl5_nn10"></a>19.2.7 Compiling for 64-bit platforms</H3>
<H3><a name="Perl5_nn10"></a>27.2.7 Compiling for 64-bit platforms</H3>
<p>
@ -626,7 +626,7 @@ also introduce problems on platforms that support more than one
linking standard (e.g., -o32 and -n32 on Irix).
</p>
<H2><a name="Perl5_nn11"></a>19.3 Building Perl Extensions under Windows</H2>
<H2><a name="Perl5_nn11"></a>27.3 Building Perl Extensions under Windows</H2>
<p>
@ -637,7 +637,7 @@ section assumes you are using SWIG with Microsoft Visual C++
although the procedure may be similar with other compilers.
</p>
<H3><a name="Perl5_nn12"></a>19.3.1 Running SWIG from Developer Studio</H3>
<H3><a name="Perl5_nn12"></a>27.3.1 Running SWIG from Developer Studio</H3>
<p>
@ -700,7 +700,7 @@ print "$a\n";
</pre></div>
<H3><a name="Perl5_nn13"></a>19.3.2 Using other compilers</H3>
<H3><a name="Perl5_nn13"></a>27.3.2 Using other compilers</H3>
<p>
@ -708,7 +708,7 @@ SWIG is known to work with Cygwin and may work with other compilers on Windows.
For general hints and suggestions refer to the <a href="Windows.html#Windows">Windows</a> chapter.
</p>
<H2><a name="Perl5_nn14"></a>19.4 The low-level interface</H2>
<H2><a name="Perl5_nn14"></a>27.4 The low-level interface</H2>
<p>
@ -718,7 +718,7 @@ can be used to control your application. However, it is also used to
construct more user-friendly proxy classes as described in the next section.
</p>
<H3><a name="Perl5_nn15"></a>19.4.1 Functions</H3>
<H3><a name="Perl5_nn15"></a>27.4.1 Functions</H3>
<p>
@ -741,7 +741,7 @@ use example;
$a = &amp;example::fact(2);
</pre></div>
<H3><a name="Perl5_nn16"></a>19.4.2 Global variables</H3>
<H3><a name="Perl5_nn16"></a>27.4.2 Global variables</H3>
<p>
@ -811,7 +811,7 @@ extern char *path; // Declared later in the input
</pre>
</div>
<H3><a name="Perl5_nn17"></a>19.4.3 Constants</H3>
<H3><a name="Perl5_nn17"></a>27.4.3 Constants</H3>
<p>
@ -838,7 +838,7 @@ $example::FOO = 2; # Error
</pre>
</div>
<H3><a name="Perl5_nn18"></a>19.4.4 Pointers</H3>
<H3><a name="Perl5_nn18"></a>27.4.4 Pointers</H3>
<p>
@ -947,7 +947,7 @@ as XS and <tt>xsubpp</tt>. Given the advancement of the SWIG typesystem and the
SWIG and XS, this is no longer supported.
</p>
<H3><a name="Perl5_nn19"></a>19.4.5 Structures</H3>
<H3><a name="Perl5_nn19"></a>27.4.5 Structures</H3>
<p>
@ -1081,7 +1081,7 @@ void Bar_f_set(Bar *b, Foo *val) {
</div>
<H3><a name="Perl5_nn20"></a>19.4.6 C++ classes</H3>
<H3><a name="Perl5_nn20"></a>27.4.6 C++ classes</H3>
<p>
@ -1146,7 +1146,7 @@ provides direct access to C++ objects. A higher level interface using Perl prox
can be built using these low-level accessors. This is described shortly.
</p>
<H3><a name="Perl5_nn21"></a>19.4.7 C++ classes and type-checking</H3>
<H3><a name="Perl5_nn21"></a>27.4.7 C++ classes and type-checking</H3>
<p>
@ -1182,7 +1182,7 @@ If necessary, the type-checker also adjusts the value of the pointer (as is nece
multiple inheritance is used).
</p>
<H3><a name="Perl5_nn22"></a>19.4.8 C++ overloaded functions</H3>
<H3><a name="Perl5_nn22"></a>27.4.8 C++ overloaded functions</H3>
<p>
@ -1226,7 +1226,7 @@ example::Spam_foo_d($s,3.14);
Please refer to the "SWIG Basics" chapter for more information.
</p>
<H3><a name="Perl5_nn23"></a>19.4.9 Operators</H3>
<H3><a name="Perl5_nn23"></a>27.4.9 Operators</H3>
<p>
@ -1253,7 +1253,7 @@ The following C++ operators are currently supported by the Perl module:
<li>operator or </li>
</ul>
<H3><a name="Perl5_nn24"></a>19.4.10 Modules and packages</H3>
<H3><a name="Perl5_nn24"></a>27.4.10 Modules and packages</H3>
<p>
@ -1320,7 +1320,7 @@ print Foo::fact(4),"\n"; # Call a function in package FooBar
</pre></div>
-->
<H2><a name="Perl5_nn25"></a>19.5 Input and output parameters</H2>
<H2><a name="Perl5_nn25"></a>27.5 Input and output parameters</H2>
<p>
@ -1539,7 +1539,7 @@ print "$c\n";
<b>Note:</b> The <tt>REFERENCE</tt> feature is only currently supported for numeric types (integers and floating point).
</p>
<H2><a name="Perl5_nn26"></a>19.6 Exception handling </H2>
<H2><a name="Perl5_nn26"></a>27.6 Exception handling </H2>
<p>
@ -1704,7 +1704,7 @@ This is still supported, but it is deprecated. The newer <tt>%exception</tt> di
functionality, but it has additional capabilities that make it more powerful.
</p>
<H2><a name="Perl5_nn27"></a>19.7 Remapping datatypes with typemaps</H2>
<H2><a name="Perl5_nn27"></a>27.7 Remapping datatypes with typemaps</H2>
<p>
@ -1721,7 +1721,7 @@ Typemaps are only used if you want to change some aspect of the primitive
C-Perl interface.
</p>
<H3><a name="Perl5_nn28"></a>19.7.1 A simple typemap example</H3>
<H3><a name="Perl5_nn28"></a>27.7.1 A simple typemap example</H3>
<p>
@ -1825,7 +1825,7 @@ example::count("e","Hello World");
</div>
<H3><a name="Perl5_nn29"></a>19.7.2 Perl5 typemaps</H3>
<H3><a name="Perl5_nn29"></a>27.7.2 Perl5 typemaps</H3>
<p>
@ -1930,7 +1930,7 @@ Return of C++ member data (all languages).
Check value of input parameter.
</div>
<H3><a name="Perl5_nn30"></a>19.7.3 Typemap variables</H3>
<H3><a name="Perl5_nn30"></a>27.7.3 Typemap variables</H3>
<p>
@ -2001,7 +2001,7 @@ properly assigned.
The Perl name of the wrapper function being created.
</div>
<H3><a name="Perl5_nn31"></a>19.7.4 Useful functions</H3>
<H3><a name="Perl5_nn31"></a>27.7.4 Useful functions</H3>
<p>
@ -2070,7 +2070,7 @@ int sv_isa(SV *, char *0;
</div>
<H2><a name="Perl5_nn32"></a>19.8 Typemap Examples</H2>
<H2><a name="Perl5_nn32"></a>27.8 Typemap Examples</H2>
<p>
@ -2079,7 +2079,7 @@ might look at the files "<tt>perl5.swg</tt>" and "<tt>typemaps.i</tt>" in
the SWIG library.
</p>
<H3><a name="Perl5_nn33"></a>19.8.1 Converting a Perl5 array to a char ** </H3>
<H3><a name="Perl5_nn33"></a>27.8.1 Converting a Perl5 array to a char ** </H3>
<p>
@ -2171,7 +2171,7 @@ print @$b,"\n"; # Print it out
</pre></div>
<H3><a name="Perl5_nn34"></a>19.8.2 Return values </H3>
<H3><a name="Perl5_nn34"></a>27.8.2 Return values </H3>
<p>
@ -2200,7 +2200,7 @@ can be done using the <tt>EXTEND()</tt> macro as in :
}
</pre></div>
<H3><a name="Perl5_nn35"></a>19.8.3 Returning values from arguments</H3>
<H3><a name="Perl5_nn35"></a>27.8.3 Returning values from arguments</H3>
<p>
@ -2254,7 +2254,7 @@ print "multout(7,13) = @r\n";
($x,$y) = multout(7,13);
</pre></div>
<H3><a name="Perl5_nn36"></a>19.8.4 Accessing array structure members</H3>
<H3><a name="Perl5_nn36"></a>27.8.4 Accessing array structure members</H3>
<p>
@ -2317,7 +2317,7 @@ the "in" typemap in the previous section would be used to convert an
to copy the converted array into a C data structure.
</p>
<H3><a name="Perl5_nn37"></a>19.8.5 Turning Perl references into C pointers</H3>
<H3><a name="Perl5_nn37"></a>27.8.5 Turning Perl references into C pointers</H3>
<p>
@ -2382,7 +2382,7 @@ print "$c\n";
</pre></div>
<H3><a name="Perl5_nn38"></a>19.8.6 Pointer handling</H3>
<H3><a name="Perl5_nn38"></a>27.8.6 Pointer handling</H3>
<p>
@ -2461,7 +2461,7 @@ For example:
</pre>
</div>
<H2><a name="Perl5_nn39"></a>19.9 Proxy classes</H2>
<H2><a name="Perl5_nn39"></a>27.9 Proxy classes</H2>
<p>
@ -2477,7 +2477,7 @@ to the underlying code. This section describes the implementation
details of the proxy interface.
</p>
<H3><a name="Perl5_nn40"></a>19.9.1 Preliminaries</H3>
<H3><a name="Perl5_nn40"></a>27.9.1 Preliminaries</H3>
<p>
@ -2499,7 +2499,7 @@ SWIG creates a collection of high-level Perl wrappers. In your scripts, you wil
high level wrappers. The wrappers, in turn, interact with the low-level procedural module.
</p>
<H3><a name="Perl5_nn41"></a>19.9.2 Structure and class wrappers</H3>
<H3><a name="Perl5_nn41"></a>27.9.2 Structure and class wrappers</H3>
<p>
@ -2625,7 +2625,7 @@ $v-&gt;DESTROY();
</pre></div>
<H3><a name="Perl5_nn42"></a>19.9.3 Object Ownership</H3>
<H3><a name="Perl5_nn42"></a>27.9.3 Object Ownership</H3>
<p>
@ -2712,7 +2712,7 @@ counting, garbage collection, or advanced features one might find in
sophisticated languages.
</p>
<H3><a name="Perl5_nn43"></a>19.9.4 Nested Objects</H3>
<H3><a name="Perl5_nn43"></a>27.9.4 Nested Objects</H3>
<p>
@ -2765,7 +2765,7 @@ $p-&gt;{f}-&gt;{x} = 0.0;
%${$p-&gt;{v}} = ( x=&gt;0, y=&gt;0, z=&gt;0);
</pre></div>
<H3><a name="Perl5_nn44"></a>19.9.5 Proxy Functions</H3>
<H3><a name="Perl5_nn44"></a>27.9.5 Proxy Functions</H3>
<p>
@ -2799,7 +2799,7 @@ This function replaces the original function, but operates in an
identical manner.
</p>
<H3><a name="Perl5_nn45"></a>19.9.6 Inheritance</H3>
<H3><a name="Perl5_nn45"></a>27.9.6 Inheritance</H3>
<p>
@ -2875,7 +2875,7 @@ particular, inheritance of data members is extremely tricky (and I'm
not even sure if it really works).
</p>
<H3><a name="Perl5_nn46"></a>19.9.7 Modifying the proxy methods</H3>
<H3><a name="Perl5_nn46"></a>27.9.7 Modifying the proxy methods</H3>
<p>
@ -2903,7 +2903,7 @@ public:
};
</pre></div>
<H2><a name="Perl5_nn47"></a>19.10 Adding additional Perl code</H2>
<H2><a name="Perl5_nn47"></a>27.10 Adding additional Perl code</H2>
<p>