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

new section numbering since adding in ccache chapter

Browse source 
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@10991 626c5289-ae23-0410-ae9c-e8d60b6d4f22
This commit is contained in:
William S Fulton 2008-12-20 01:49:58 +00:00
commit 9ed9e006bc
23 changed files with 743 additions and 715 deletions
Download patch file Download diff file Expand all files Collapse all files

90
Doc/Manual/Tcl.html
View file

@ -6,7 +6,7 @@
</head>
<body bgcolor="#ffffff">
<H1><a name="Tcl"></a>32 SWIG and Tcl</H1>
<H1><a name="Tcl"></a>33 SWIG and Tcl</H1>
<!-- INDEX -->
<div class="sectiontoc">
<ul>
@ -82,7 +82,7 @@ Tcl 8.0 or a later release. Earlier releases of SWIG supported Tcl 7.x, but
this is no longer supported.
</p>
<H2><a name="Tcl_nn2"></a>32.1 Preliminaries</H2>
<H2><a name="Tcl_nn2"></a>33.1 Preliminaries</H2>
<p>
@ -108,7 +108,7 @@ build a Tcl extension module. To finish building the module, you
need to compile this file and link it with the rest of your program.
</p>
<H3><a name="Tcl_nn3"></a>32.1.1 Getting the right header files</H3>
<H3><a name="Tcl_nn3"></a>33.1.1 Getting the right header files</H3>
<p>
@ -126,7 +126,7 @@ this is the case, you should probably make a symbolic link so that <tt>tcl.h</tt
header file.
</p>
<H3><a name="Tcl_nn4"></a>32.1.2 Compiling a dynamic module</H3>
<H3><a name="Tcl_nn4"></a>33.1.2 Compiling a dynamic module</H3>
<p>
@ -161,7 +161,7 @@ The name of the module is specified using the <tt>%module</tt> directive or the
<tt> -module</tt> command line option.
</p>
<H3><a name="Tcl_nn5"></a>32.1.3 Static linking</H3>
<H3><a name="Tcl_nn5"></a>33.1.3 Static linking</H3>
<p>
@ -227,7 +227,7 @@ minimal in most situations (and quite frankly not worth the extra
hassle in the opinion of this author).
</p>
<H3><a name="Tcl_nn6"></a>32.1.4 Using your module</H3>
<H3><a name="Tcl_nn6"></a>33.1.4 Using your module</H3>
<p>
@ -355,7 +355,7 @@ to the default system configuration (this requires root access and you will need
the man pages).
</p>
<H3><a name="Tcl_nn7"></a>32.1.5 Compilation of C++ extensions</H3>
<H3><a name="Tcl_nn7"></a>33.1.5 Compilation of C++ extensions</H3>
<p>
@ -438,7 +438,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="Tcl_nn8"></a>32.1.6 Compiling for 64-bit platforms</H3>
<H3><a name="Tcl_nn8"></a>33.1.6 Compiling for 64-bit platforms</H3>
<p>
@ -465,7 +465,7 @@ also introduce problems on platforms that support more than one
linking standard (e.g., -o32 and -n32 on Irix).
</p>
<H3><a name="Tcl_nn9"></a>32.1.7 Setting a package prefix</H3>
<H3><a name="Tcl_nn9"></a>33.1.7 Setting a package prefix</H3>
<p>
@ -484,7 +484,7 @@ option will append the prefix to the name when creating a command and
call it "<tt>Foo_bar</tt>".
</p>
<H3><a name="Tcl_nn10"></a>32.1.8 Using namespaces</H3>
<H3><a name="Tcl_nn10"></a>33.1.8 Using namespaces</H3>
<p>
@ -506,7 +506,7 @@ When the<tt> -namespace</tt> option is used, objects in the module
are always accessed with the namespace name such as <tt>Foo::bar</tt>.
</p>
<H2><a name="Tcl_nn11"></a>32.2 Building Tcl/Tk Extensions under Windows 95/NT</H2>
<H2><a name="Tcl_nn11"></a>33.2 Building Tcl/Tk Extensions under Windows 95/NT</H2>
<p>
@ -517,7 +517,7 @@ covers the process of using SWIG with Microsoft Visual C++.
although the procedure may be similar with other compilers.
</p>
<H3><a name="Tcl_nn12"></a>32.2.1 Running SWIG from Developer Studio</H3>
<H3><a name="Tcl_nn12"></a>33.2.1 Running SWIG from Developer Studio</H3>
<p>
@ -575,7 +575,7 @@ MSDOS &gt; tclsh80
%
</pre></div>
<H3><a name="Tcl_nn13"></a>32.2.2 Using NMAKE</H3>
<H3><a name="Tcl_nn13"></a>33.2.2 Using NMAKE</H3>
<p>
@ -638,7 +638,7 @@ to get you started. With a little practice, you'll be making lots of
Tcl extensions.
</p>
<H2><a name="Tcl_nn14"></a>32.3 A tour of basic C/C++ wrapping</H2>
<H2><a name="Tcl_nn14"></a>33.3 A tour of basic C/C++ wrapping</H2>
<p>
@ -649,7 +649,7 @@ classes. This section briefly covers the essential aspects of this
wrapping.
</p>
<H3><a name="Tcl_nn15"></a>32.3.1 Modules</H3>
<H3><a name="Tcl_nn15"></a>33.3.1 Modules</H3>
<p>
@ -683,7 +683,7 @@ To fix this, supply an extra argument to <tt>load</tt> like this:
</pre>
</div>
<H3><a name="Tcl_nn16"></a>32.3.2 Functions</H3>
<H3><a name="Tcl_nn16"></a>33.3.2 Functions</H3>
<p>
@ -708,7 +708,7 @@ like you think it does:
%
</pre></div>
<H3><a name="Tcl_nn17"></a>32.3.3 Global variables</H3>
<H3><a name="Tcl_nn17"></a>33.3.3 Global variables</H3>
<p>
@ -788,7 +788,7 @@ extern char *path; // Read-only (due to %immutable)
</pre>
</div>
<H3><a name="Tcl_nn18"></a>32.3.4 Constants and enums</H3>
<H3><a name="Tcl_nn18"></a>33.3.4 Constants and enums</H3>
<p>
@ -872,7 +872,7 @@ When an identifier name is given, it is used to perform an implicit hash-table l
conversion. This allows the <tt>global</tt> statement to be omitted.
</p>
<H3><a name="Tcl_nn19"></a>32.3.5 Pointers</H3>
<H3><a name="Tcl_nn19"></a>33.3.5 Pointers</H3>
<p>
@ -968,7 +968,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="Tcl_nn20"></a>32.3.6 Structures</H3>
<H3><a name="Tcl_nn20"></a>33.3.6 Structures</H3>
<p>
@ -1250,7 +1250,7 @@ Note: Tcl only destroys the underlying object if it has ownership. See the
memory management section that appears shortly.
</p>
<H3><a name="Tcl_nn21"></a>32.3.7 C++ classes</H3>
<H3><a name="Tcl_nn21"></a>33.3.7 C++ classes</H3>
<p>
@ -1317,7 +1317,7 @@ In Tcl, the static member is accessed as follows:
</pre>
</div>
<H3><a name="Tcl_nn22"></a>32.3.8 C++ inheritance</H3>
<H3><a name="Tcl_nn22"></a>33.3.8 C++ inheritance</H3>
<p>
@ -1366,7 +1366,7 @@ For instance:
It is safe to use multiple inheritance with SWIG.
</p>
<H3><a name="Tcl_nn23"></a>32.3.9 Pointers, references, values, and arrays</H3>
<H3><a name="Tcl_nn23"></a>33.3.9 Pointers, references, values, and arrays</H3>
<p>
@ -1420,7 +1420,7 @@ to hold the result and a pointer is returned (Tcl will release this memory
when the return value is garbage collected).
</p>
<H3><a name="Tcl_nn24"></a>32.3.10 C++ overloaded functions</H3>
<H3><a name="Tcl_nn24"></a>33.3.10 C++ overloaded functions</H3>
<p>
@ -1543,7 +1543,7 @@ first declaration takes precedence.
Please refer to the "SWIG and C++" chapter for more information about overloading.
</p>
<H3><a name="Tcl_nn25"></a>32.3.11 C++ operators</H3>
<H3><a name="Tcl_nn25"></a>33.3.11 C++ operators</H3>
<p>
@ -1645,7 +1645,7 @@ There are ways to make this operator appear as part of the class using the <tt>%
Keep reading.
</p>
<H3><a name="Tcl_nn26"></a>32.3.12 C++ namespaces</H3>
<H3><a name="Tcl_nn26"></a>33.3.12 C++ namespaces</H3>
<p>
@ -1709,7 +1709,7 @@ utilizes thousands of small deeply nested namespaces each with
identical symbol names, well, then you get what you deserve.
</p>
<H3><a name="Tcl_nn27"></a>32.3.13 C++ templates</H3>
<H3><a name="Tcl_nn27"></a>33.3.13 C++ templates</H3>
<p>
@ -1761,7 +1761,7 @@ More details can be found in the <a href="SWIGPlus.html#SWIGPlus">SWIG and C++</
examples will appear later.
</p>
<H3><a name="Tcl_nn28"></a>32.3.14 C++ Smart Pointers</H3>
<H3><a name="Tcl_nn28"></a>33.3.14 C++ Smart Pointers</H3>
<p>
@ -1845,7 +1845,7 @@ simply use the <tt>__deref__()</tt> method. For example:
</pre>
</div>
<H2><a name="Tcl_nn29"></a>32.4 Further details on the Tcl class interface</H2>
<H2><a name="Tcl_nn29"></a>33.4 Further details on the Tcl class interface</H2>
<p>
@ -1858,7 +1858,7 @@ of low-level details were omitted. This section provides a brief overview
of how the proxy classes work.
</p>
<H3><a name="Tcl_nn30"></a>32.4.1 Proxy classes</H3>
<H3><a name="Tcl_nn30"></a>33.4.1 Proxy classes</H3>
<p>
@ -1923,7 +1923,7 @@ function. This allows objects to be encapsulated objects that look a lot like
as shown in the last section.
</p>
<H3><a name="Tcl_nn31"></a>32.4.2 Memory management</H3>
<H3><a name="Tcl_nn31"></a>33.4.2 Memory management</H3>
<p>
@ -2111,7 +2111,7 @@ typemaps--an advanced topic discussed later.
</p>
<H2><a name="Tcl_nn32"></a>32.5 Input and output parameters</H2>
<H2><a name="Tcl_nn32"></a>33.5 Input and output parameters</H2>
<p>
@ -2299,7 +2299,7 @@ set c [lindex $dim 1]
</pre>
</div>
<H2><a name="Tcl_nn33"></a>32.6 Exception handling </H2>
<H2><a name="Tcl_nn33"></a>33.6 Exception handling </H2>
<p>
@ -2433,7 +2433,7 @@ Since SWIG's exception handling is user-definable, you are not limited to C++ ex
See the chapter on "<a href="Customization.html#Customization">Customization Features</a>" for more examples.
</p>
<H2><a name="Tcl_nn34"></a>32.7 Typemaps</H2>
<H2><a name="Tcl_nn34"></a>33.7 Typemaps</H2>
<p>
@ -2450,7 +2450,7 @@ Typemaps are only used if you want to change some aspect of the primitive
C-Tcl interface.
</p>
<H3><a name="Tcl_nn35"></a>32.7.1 What is a typemap?</H3>
<H3><a name="Tcl_nn35"></a>33.7.1 What is a typemap?</H3>
<p>
@ -2567,7 +2567,7 @@ parameter is omitted):
</pre>
</div>
<H3><a name="Tcl_nn36"></a>32.7.2 Tcl typemaps</H3>
<H3><a name="Tcl_nn36"></a>33.7.2 Tcl typemaps</H3>
<p>
@ -2705,7 +2705,7 @@ Initialize an argument to a value before any conversions occur.
Examples of these methods will appear shortly.
</p>
<H3><a name="Tcl_nn37"></a>32.7.3 Typemap variables</H3>
<H3><a name="Tcl_nn37"></a>33.7.3 Typemap variables</H3>
<p>
@ -2776,7 +2776,7 @@ properly assigned.
The Tcl name of the wrapper function being created.
</div>
<H3><a name="Tcl_nn38"></a>32.7.4 Converting a Tcl list to a char ** </H3>
<H3><a name="Tcl_nn38"></a>33.7.4 Converting a Tcl list to a char ** </H3>
<p>
@ -2838,7 +2838,7 @@ argv[2] = Larry
3
</pre></div>
<H3><a name="Tcl_nn39"></a>32.7.5 Returning values in arguments</H3>
<H3><a name="Tcl_nn39"></a>33.7.5 Returning values in arguments</H3>
<p>
@ -2880,7 +2880,7 @@ result, a Tcl function using these typemaps will work like this :
%
</pre></div>
<H3><a name="Tcl_nn40"></a>32.7.6 Useful functions</H3>
<H3><a name="Tcl_nn40"></a>33.7.6 Useful functions</H3>
<p>
@ -2957,7 +2957,7 @@ int Tcl_IsShared(Tcl_Obj *obj);
</pre>
</div>
<H3><a name="Tcl_nn41"></a>32.7.7 Standard typemaps</H3>
<H3><a name="Tcl_nn41"></a>33.7.7 Standard typemaps</H3>
<p>
@ -3041,7 +3041,7 @@ work)
</pre>
</div>
<H3><a name="Tcl_nn42"></a>32.7.8 Pointer handling</H3>
<H3><a name="Tcl_nn42"></a>33.7.8 Pointer handling</H3>
<p>
@ -3117,7 +3117,7 @@ For example:
</pre>
</div>
<H2><a name="Tcl_nn43"></a>32.8 Turning a SWIG module into a Tcl Package.</H2>
<H2><a name="Tcl_nn43"></a>33.8 Turning a SWIG module into a Tcl Package.</H2>
<p>
@ -3189,7 +3189,7 @@ As a final note, most SWIG examples do not yet use the
to use the <tt>load</tt> command instead.
</p>
<H2><a name="Tcl_nn44"></a>32.9 Building new kinds of Tcl interfaces (in Tcl)</H2>
<H2><a name="Tcl_nn44"></a>33.9 Building new kinds of Tcl interfaces (in Tcl)</H2>
<p>
@ -3288,7 +3288,7 @@ danger of blowing something up (although it is easily accomplished
with an out of bounds array access).
</p>
<H3><a name="Tcl_nn45"></a>32.9.1 Proxy classes</H3>
<H3><a name="Tcl_nn45"></a>33.9.1 Proxy classes</H3>
<p>