source: general/prog/swig.xml@ 6c3d8a47

10.0 10.1 11.0 11.1 11.2 9.1 lazarus plabs/python-mods qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since 6c3d8a47 was 6c3d8a47, checked in by Bruce Dubbs <bdubbs@…>, 3 years ago

Update to graphviz-2.42.1.
Update to swig-4.0.1.
Update to nspr-4.22.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@22083 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 7.4 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY swig-download-http "&sourceforge-dl;/swig/swig-&swig-version;.tar.gz">
8 <!ENTITY swig-download-ftp " ">
9 <!ENTITY swig-md5sum "54cc40b3804816f7d38ab510b6f13b04">
10 <!ENTITY swig-size "7.7 MB">
11 <!ENTITY swig-buildsize "181 MB (1.2 GB with tests)">
12 <!ENTITY swig-time "0.2 SBU (add 9.4 SBU for tests; both using parallelism=4)">
13]>
14
15<sect1 id="swig" xreflabel="SWIG-&swig-version;">
16 <?dbhtml filename="swig.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>SWIG-&swig-version;</title>
24
25 <indexterm zone="swig">
26 <primary sortas="a-swig">SWIG</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to SWIG</title>
31
32 <para>
33 <application>SWIG</application> (Simplified Wrapper and Interface
34 Generator) is a compiler that integrates <application>C</application>
35 and <application>C++</application> with languages including
36 <application>Perl</application>,
37 <application>Python</application>,
38 <application>Tcl</application>,
39 <application>Ruby</application>,
40 <application>PHP</application>,
41 <application>Java</application>,
42 <application>C#</application>,
43 <application>D</application>,
44 <application>Go</application>,
45 <application>Lua</application>,
46 <application>Octave</application>,
47 <application>R</application>,
48 <application>Scheme</application>, and
49 <application>Ocaml</application>.
50 <application>SWIG</application> can
51 also export its parse tree into <application>Lisp</application>
52 s-expressions and <application>XML</application>.
53 </para>
54 <para>
55 <application>SWIG</application> reads annotated
56 <application>C/C++</application> header files and creates wrapper
57 code (glue code) in order to make the corresponding
58 <application>C/C++</application> libraries available to the listed
59 languages, or to extend <application>C/C++</application> programs
60 with a scripting language.
61 </para>
62
63 &lfs90_checked;
64
65 <bridgehead renderas="sect3">Package Information</bridgehead>
66 <itemizedlist spacing="compact">
67 <listitem>
68 <para>
69 Download (HTTP): <ulink url="&swig-download-http;"/>
70 </para>
71 </listitem>
72 <listitem>
73 <para>
74 Download (FTP): <ulink url="&swig-download-ftp;"/>
75 </para>
76 </listitem>
77 <listitem>
78 <para>
79 Download MD5 sum: &swig-md5sum;
80 </para>
81 </listitem>
82 <listitem>
83 <para>
84 Download size: &swig-size;
85 </para>
86 </listitem>
87 <listitem>
88 <para>
89 Estimated disk space required: &swig-buildsize;
90 </para>
91 </listitem>
92 <listitem>
93 <para>
94 Estimated build time: &swig-time;
95 </para>
96 </listitem>
97 </itemizedlist>
98
99 <bridgehead renderas="sect3">SWIG Dependencies</bridgehead>
100
101 <bridgehead renderas="sect4">Required</bridgehead>
102 <para role="required">
103 <xref linkend="pcre"/>
104 </para>
105
106 <bridgehead renderas="sect4">Optional</bridgehead>
107 <para role="optional">
108 <xref linkend="boost"/> for tests, and any of the languages mentioned
109 in the introduction, as run-time dependencies
110 </para>
111
112 <para condition="html" role="usernotes">
113 User Notes: <ulink url="&blfs-wiki;/swig"/>
114 </para>
115 </sect2>
116
117 <sect2 role="installation">
118 <title>Installation of SWIG</title>
119
120 <para>
121 Install <application>SWIG</application> by running the following
122 commands:
123 </para>
124
125<screen><userinput>./configure --prefix=/usr \
126 --without-maximum-compile-warnings &amp;&amp;
127make</userinput></screen>
128
129 <para>
130 To test the results, issue: <command>make -k check TCL_INCLUDE=</command>.
131 The unsetting of the variable <envar>TCL_INCLUDE</envar> is
132 necessary since it is not correctly set by
133 <emphasis>configure</emphasis>. The tests are only executed for the
134 languages installed on your machine, so the disk space and SBU values
135 given for the tests may vary, and should be considered as mere orders of
136 magnitude. If you have <xref linkend="python2"/> installed, the Python-3
137 tests are not run. You can run tests for Python-3 by issuing
138 <command>PY3=1 make check-python-examples</command> followed by
139 <command>PY3=1 make check-python-test-suite</command>. According to
140 <application>SWIG</application>'s documentation, the failure of some
141 tests should not be considered harmful.
142 </para>
143
144 <para>
145 Now, as the <systemitem class="username">root</systemitem> user:
146 </para>
147
148<screen role="root"><userinput>make install &amp;&amp;
149install -v -m755 -d /usr/share/doc/swig-&swig-version; &amp;&amp;
150cp -v -R Doc/* /usr/share/doc/swig-&swig-version;</userinput></screen>
151 </sect2>
152
153 <sect2 role="commands">
154 <title>Command Explanations</title>
155
156 <para>
157 <parameter>--without-maximum-compile-warnings</parameter>: disables
158 compiler ansi conformance enforcement, which triggers errors in
159 the <application>Lua</application> headers (starting with Lua 5.3).
160 </para>
161
162 <para>
163 <option>--without-&lt;language&gt;</option>: allows disabling the
164 building of tests and examples for &lt;language&gt;, but all the
165 languages capabilities of <application>SWIG</application> are always
166 built. <!--We use it for <application>Clisp</application>, because the
167 SWIG implementation is very incomplete and a lot of tests fail. -->
168 </para>
169
170 </sect2>
171
172 <sect2 role="content">
173 <title>Contents</title>
174
175 <segmentedlist>
176 <segtitle>Installed Programs</segtitle>
177 <segtitle>Installed Library</segtitle>
178 <segtitle>Installed Directories</segtitle>
179
180 <seglistitem>
181 <seg>
182 swig and ccache-swig
183 </seg>
184 <seg>
185 None
186 </seg>
187 <seg>
188 /usr/share/doc/swig-&swig-version; and
189 /usr/share/swig
190 </seg>
191 </seglistitem>
192 </segmentedlist>
193
194 <variablelist>
195 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
196 <?dbfo list-presentation="list"?>
197 <?dbhtml list-presentation="table"?>
198
199 <varlistentry id="swig-prog">
200 <term><command>swig</command></term>
201 <listitem>
202 <para>
203 takes an interface file containing C/C++ declarations and
204 SWIG special instructions, and generates the corresponding
205 wrapper code needed to build extension modules.
206 </para>
207 <indexterm zone="swig swig-prog">
208 <primary sortas="b-swig">swig</primary>
209 </indexterm>
210 </listitem>
211 </varlistentry>
212
213 <varlistentry id="ccache-swig">
214 <term><command>ccache-swig</command></term>
215 <listitem>
216 <para>
217 is a compiler cache, which speeds up re-compilation of
218 C/C++/SWIG code.
219 </para>
220 <indexterm zone="swig ccache-swig">
221 <primary sortas="b-ccache-swig">ccache-swig</primary>
222 </indexterm>
223 </listitem>
224 </varlistentry>
225
226 </variablelist>
227 </sect2>
228</sect1>
Note: See TracBrowser for help on using the repository browser.