← Back to branch summary

~ubuntu-branches/ubuntu/edgy/swig1.3/edgy

« back to all changes in this revision

Viewing changes to Doc/Manual/Preface.html

  • Committer: Bazaar Package Importer
  • Author(s): Adam Conrad
  • Date: 2005-12-05 01:16:04 UTC
  • mfrom: (1.2.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20051205011604-ygx904it6413k3go
Tags: 1.3.27-1ubuntu1
Resynchronise with Debian again, for the new subversion packages.

Show diffs side-by-side

added added

removed removed

Lines of Context:
Doc/Manual/Preface.html
2
2
<html>
3
3
<head>
4
4
<title>Preface</title>
 
5
<link rel="stylesheet" type="text/css" href="style.css">
5
6
</head>
6
7
 
7
8
<body bgcolor="#ffffff">
8
9
<H1><a name="Preface"></a>1 Preface</H1>
9
10
<!-- INDEX -->
 
11
<div class="sectiontoc">
10
12
<ul>
11
13
<li><a href="#Preface_nn2">Introduction</a>
12
14
<li><a href="#Preface_nn3">Special Introduction for Version 1.3</a>
19
21
<li><a href="#Preface_nn10">Credits</a>
20
22
<li><a href="#Preface_nn11">Bug reports</a>
21
23
</ul>
 
24
</div>
22
25
<!-- INDEX -->
23
26
 
24
27
 
26
29
<H2><a name="Preface_nn2"></a>1.1 Introduction</H2>
27
30
 
28
31
 
 
32
<p>
29
33
SWIG (Simplified Wrapper and Interface Generator) is a software development tool for building scripting language
30
34
interfaces to C and C++ programs.  Originally developed in 1995, SWIG was
31
35
first used by scientists in the Theoretical Physics Division at Los Alamos National Laboratory for
37
41
types of problems.  SWIG simplifies development by largely automating
38
42
the task of scripting language integration--allowing developers and users
39
43
to focus on more important problems.
 
44
</p>
40
45
 
41
46
<p>
42
47
Although SWIG was originally developed for scientific applications, it
47
52
<H2><a name="Preface_nn3"></a>1.2 Special Introduction for Version 1.3</H2>
48
53
 
49
54
 
 
55
<p>
50
56
Since SWIG was released in 1996, its user base and applicability has
51
57
continued to grow. Although its rate of development has varied, an
52
58
active development effort has continued to make improvements to the
55
61
all of the ANSI C++ standard and approximately ten target languages
56
62
including Guile, Java, Mzscheme, Ocaml, Perl, Pike, PHP, Python, Ruby,
57
63
and Tcl.
 
64
</p>
58
65
 
59
66
<H2><a name="Preface_nn4"></a>1.3 SWIG Versions</H2>
60
67
 
61
68
 
 
69
<p>
62
70
For several years, the most stable version of SWIG has been release
63
71
1.1p5. Starting with version 1.3, a new version numbering scheme has
64
72
been adopted.  Odd version numbers (1.3, 1.5, etc.) represent
66
74
represent stable releases.  Currently, developers are working to
67
75
create a stable SWIG-2.0 release.  Don't let the development status 
68
76
of SWIG-1.3 scare you---it is much more stable (and capable) than SWIG-1.1p5.
 
77
</p>
69
78
 
70
79
<H2><a name="Preface_nn5"></a>1.4 SWIG resources</H2>
71
80
 
72
81
 
 
82
<p>
73
83
The official location of SWIG related material is
 
84
</p>
74
85
 
75
 
<blockquote><pre>
 
86
<div class="shell"><pre>
76
87
<a href="http://www.swig.org">http://www.swig.org</a>
77
 
</pre></blockquote>
 
88
</pre></div>
78
89
 
79
90
<p>
80
91
This site contains the latest version of the software, users guide,
85
96
You can also subscribe to the SWIG mailing list by visiting the page
86
97
</p>
87
98
 
88
 
<blockquote><pre>
 
99
<div class="shell"><pre>
89
100
<a href="http://www.swig.org/mail.html">http://www.swig.org/mail.html</a>
90
 
</pre></blockquote>
 
101
</pre></div>
91
102
 
92
103
<p>
93
104
The mailing list often discusses some of the more technical aspects of
99
110
about this can be obtained at:
100
111
</p>
101
112
 
102
 
<blockquote><pre>
 
113
<div class="shell"><pre>
103
114
<a href="http://www.swig.org/cvs.html">http://www.swig.org/cvs.html</a>
104
 
</pre></blockquote>
 
115
</pre></div>
105
116
 
106
117
 
107
118
<H2><a name="Preface_nn6"></a>1.5 Prerequisites</H2>
132
143
<H2><a name="Preface_nn7"></a>1.6 Organization of this manual</H2>
133
144
 
134
145
 
 
146
<p>
135
147
The first few chapters of this manual describe SWIG in general and
136
148
provide an overview of its capabilities. The remaining chapters are
137
149
devoted to specific SWIG language modules and are self
139
151
can probably skip to that chapter and find almost everything you need
140
152
to know.   Caveat: we are currently working on a documentation rewrite and many
141
153
of the older language module chapters are still somewhat out of date.
 
154
</p>
142
155
 
143
156
<H2><a name="Preface_nn8"></a>1.7 How to avoid reading the manual</H2>
144
157
 
145
158
 
 
159
<p>
146
160
If you hate reading manuals, glance at the "Introduction" which
147
161
contains a few simple examples. These
148
162
examples contain about 95% of everything you need to know to use
149
163
SWIG. After that, simply use the language-specific chapters as a reference.
150
164
The SWIG distribution also comes with a large directory of
151
165
examples that illustrate different topics.
 
166
</p>
152
167
 
153
168
<H2><a name="Preface_nn9"></a>1.8 Backwards Compatibility</H2>
154
169
 
180
195
advantage of different features etc:
181
196
</p>
182
197
 
183
 
<blockquote><pre>
 
198
<div class="code"><pre>
184
199
#if SWIG_VERSION &gt;= 0x010311
185
200
/* Use some fancy new feature */
186
201
#endif
187
 
</pre></blockquote>
 
202
</pre></div>
188
203
 
189
204
<p>
190
205
Note: The version symbol is not defined in the generated SWIG
194
209
<H2><a name="Preface_nn10"></a>1.9 Credits</H2>
195
210
 
196
211
 
 
212
<p>
197
213
SWIG is an unfunded project that would not be possible without the
198
214
contributions of many people.  Most recent SWIG development has been
199
215
supported by Matthias K&ouml;ppe, William Fulton, Lyle Johnson,
200
216
Richard Palmer, Thien-Thi Nguyen, Jason Stewart, Loic Dachary, Masaki
201
217
Fukushima, Luigi Ballabio, Sam Liddicott, Art Yerkes, Marcelo Matus, 
202
 
Harco de Hilster, and John Lenz.
 
218
Harco de Hilster, John Lenz, and Surendra Singhi.
 
219
</p>
203
220
 
204
221
<p>
205
222
Historically, the following people contributed to early versions of SWIG.
218
235
<H2><a name="Preface_nn11"></a>1.10 Bug reports</H2>
219
236
 
220
237
 
 
238
<p>
221
239
Although every attempt has been made to make SWIG bug-free, we are also trying
222
240
to make feature improvements that may introduce bugs.
223
241
To report a bug, either send mail to the SWIG developer
227
245
core dump occurred), corresponding portions of the SWIG interface file
228
246
used, and any important pieces of the SWIG generated wrapper code.  We
229
247
can only fix bugs if we know about them.
 
248
</p>
230
249
 
231
250
</body>
232
251
</html>