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