summaryrefslogtreecommitdiffstats
path: root/src/engine/SCons/Tool/swig.xml
blob: 679d6832345e62f05269ef528df073fd6f3ee808 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
<!--
__COPYRIGHT__

This file is processed by the bin/SConsDoc.py module.
See its __doc__ string for a discussion of the format.
-->
<tool name="swig">
<summary>
Sets construction variables for the SWIG interface generator.
</summary>
<sets>
SWIG
SWIGFLAGS
SWIGCFILESUFFIX
SWIGCXXFILESUFFIX
SWIGCOM
</sets>
<uses>
SWIGCOMSTR
</uses>
</tool>

<cvar name="SWIG">
<summary>
The scripting language wrapper and interface generator.
</summary>
</cvar>

<cvar name="SWIGCFILESUFFIX">
<summary>
The suffix that will be used for intermediate C
source files generated by
the scripting language wrapper and interface generator.
The default value is
<filename>_wrap</filename>&cv-link-CFILESUFFIX;.
By default, this value is used whenever the
<option>-c++</option>
option is
<emphasis>not</emphasis>
specified as part of the
&cv-link-SWIGFLAGS;
construction variable.
</summary>
</cvar>

<cvar name="SWIGCOM">
<summary>
The command line used to call
the scripting language wrapper and interface generator.
</summary>
</cvar>

<cvar name="SWIGCOMSTR">
<summary>
The string displayed when calling
the scripting language wrapper and interface generator.
If this is not set, then &cv-link-SWIGCOM; (the command line) is displayed.
</summary>
</cvar>

<cvar name="SWIGCXXFILESUFFIX">
<summary>
The suffix that will be used for intermediate C++
source files generated by
the scripting language wrapper and interface generator.
The default value is
<filename>_wrap</filename>&cv-link-CFILESUFFIX;.
By default, this value is used whenever the
<filename>-c++</filename>
option is specified as part of the
&cv-link-SWIGFLAGS;
construction variable.
</summary>
</cvar>

<cvar name="SWIGFLAGS">
<summary>
General options passed to
the scripting language wrapper and interface generator.
This is where you should set
<option>-python</option>,
<option>-perl5</option>,
<option>-tcl</option>,
or whatever other options you want to specify to SWIG.
If you set the
<option>-c++</option>
option in this variable,
&scons;
will, by default,
generate a C++ intermediate source file
with the extension that is specified as the
&cv-link-CXXFILESUFFIX;
variable.
</summary>
</cvar>

<cvar name="SWIGOUTDIR">
<summary>
Specifies the output directory in which
the scripting language wrapper and interface generator
should place generated language-specific files.
This will be used by SCons to identify
the files that will be generated by the &swig; call,
and translated into the
<literal>swig -outdir</literal> option on the command line.
</summary>
</cvar>