aboutsummaryrefslogtreecommitdiff
path: root/Examples/tcl/constants/index.html
blob: fa332c64c953a34bcd8143de5b98780c8a32b937 (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
<html>
<head>
<title>SWIG:Examples:tcl:constants</title>
</head>

<body bgcolor="#ffffff">

<tt>SWIG/Examples/tcl/constants/</tt>
<hr>

<H2>Wrapping C Constants</H2>

<p>
When SWIG encounters C preprocessor macros and C declarations that look like constants,
it creates Tcl variables with an identical value.  Click <a href="example.i">here</a>
to see a SWIG interface with some constant declarations in it.

<h2>Accessing Constants from Tcl</h2>

Click <a href="runme.tcl">here</a> to see a script that prints out the values
of the constants contained in the above file.

<h2>Key points</h2>

<ul>
<li>The values of preprocessor macros are converted into Tcl read-only variables.
<li>Types are inferred by syntax (e.g., "3" is an integer and "3.5" is a float).
<li>Character constants such as 'x' are converted into strings.
<li>C string literals such as "Hello World" are converted into strings.
<li>Macros that are not fully defined are simply ignored.  For example:
<blockquote>
<pre>
#define EXTERN extern
</pre>
</blockquote>
is ignored because SWIG has no idea what type of variable this would be.

<p>
<li>Expressions are allowed provided that all of their components are defined. Otherwise, the constant is ignored.

<li>Certain C declarations involving 'const' are also turned into Tcl constants. 
<li>The constants that appear in a SWIG interface file do not have to appear in any sort
of matching C source file since the creation of a constant does not require linkage
to a stored value (i.e., a value held in a C global variable or memory location).
<li>Since constants are turned into Tcl variables, you have to use the global
statement when accessing from a procedure. For example:

<blockquote>
<pre>
proc foo {} {
    global ICONST          # Some C constant
    puts $ICONST
}
</pre>
</blockquote>
</ul>

<hr>

</body>
</html>