Updated some examples
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk/SWIG@490 626c5289-ae23-0410-ae9c-e8d60b6d4f22
This commit is contained in:
Dave Beazley
parent
905fb9b3b6
commit
b3e124ac21
22 changed files with 745 additions and 96 deletions
18
Examples/python/constants/Makefile
Normal file
18
Examples/python/constants/Makefile
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
TOP = ../..
|
||||
SWIG = $(TOP)/../swig
|
||||
SRCS =
|
||||
TARGET = example
|
||||
INTERFACE = example.i
|
||||
|
||||
all::
|
||||
$(MAKE) -f $(TOP)/Makefile SRCS='$(SRCS)' SWIG='$(SWIG)' \
|
||||
TARGET='$(TARGET)' INTERFACE='$(INTERFACE)' python
|
||||
|
||||
static::
|
||||
$(MAKE) -f $(TOP)/Makefile SRCS='$(SRCS)' SWIG='$(SWIG)' \
|
||||
TARGET='mypython' INTERFACE='$(INTERFACE)' python_static
|
||||
|
||||
clean::
|
||||
rm -f *_wrap* *.o *~ *.so mypython *.pyc .~* core
|
||||
|
||||
|
||||
24
Examples/python/constants/example.i
Normal file
24
Examples/python/constants/example.i
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
/* File : example.i */
|
||||
%module example
|
||||
|
||||
/* A few preprocessor macros */
|
||||
|
||||
#define ICONST 42
|
||||
#define FCONST 2.1828
|
||||
#define CCONST 'x'
|
||||
#define SCONST "Hello World"
|
||||
|
||||
/* This should work just fine */
|
||||
#define EXPR ICONST + 3*(FCONST)
|
||||
|
||||
/* This shouldn't do anything */
|
||||
#define EXTERN extern
|
||||
|
||||
/* Neither should this (BAR isn't defined) */
|
||||
#define FOO (ICONST + BAR)
|
||||
|
||||
/* The following statements also produce constants */
|
||||
const int iconst = 37;
|
||||
const double fconst = 3.14;
|
||||
|
||||
|
||||
25
Examples/python/constants/example.py
Normal file
25
Examples/python/constants/example.py
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
# file: example.py
|
||||
|
||||
import example
|
||||
|
||||
print "ICONST =", example.ICONST, "(should be 42)"
|
||||
print "FCONST =", example.FCONST, "(should be 2.1828)"
|
||||
print "CCONST =", example.CCONST, "(should be 'x')"
|
||||
print "SCONST =", example.SCONST, "(should be 'Hello World')"
|
||||
print "EXPR =", example.EXPR, "(should be 48.5484)"
|
||||
print "iconst =", example.iconst, "(should be 37)"
|
||||
print "fconst =", example.fconst, "(should be 3.14)"
|
||||
|
||||
try:
|
||||
print "EXTERN = ", example.EXTERN, "(Arg! This shouldn't print anything)"
|
||||
except AttributeError:
|
||||
print "EXTERN isn't defined (good)"
|
||||
|
||||
try:
|
||||
print "FOO = ", example.FOO, "(Arg! This shouldn't print anything)"
|
||||
except AttributeError:
|
||||
print "FOO isn't defined (good)"
|
||||
|
||||
|
||||
|
||||
|
||||
69
Examples/python/constants/index.html
Normal file
69
Examples/python/constants/index.html
Normal file
|
|
@ -0,0 +1,69 @@
|
|||
<html>
|
||||
<head>
|
||||
<title>SWIG:Examples:python:constants</title>
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<tt>SWIG/Examples/python/constants/</tt>
|
||||
<hr>
|
||||
|
||||
<H2>Wrapping C Constants</H2>
|
||||
|
||||
<tt>$Header$</tt><br>
|
||||
|
||||
<p>
|
||||
When SWIG encounters C preprocessor macros and C declarations that look like constants,
|
||||
it creates Python 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 Python</h2>
|
||||
|
||||
Click <a href="example.py">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 Python constants.
|
||||
<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 Python strings.
|
||||
<li>C string literals such as "Hello World" are converted into Python 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 Python constants.
|
||||
<li>The Python variables that SWIG creates are not protected from modification. For example,
|
||||
even if you had this:
|
||||
<blockquote>
|
||||
<pre>
|
||||
#define FOO 73
|
||||
</pre>
|
||||
</blockquote>
|
||||
a user could come along in a script and type
|
||||
<blockquote>
|
||||
<pre>
|
||||
example.FOO = 13
|
||||
</pre>
|
||||
</blockquote>
|
||||
Unfortunately, there's no easy way to prevent this.
|
||||
|
||||
<p>
|
||||
<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).
|
||||
</ul>
|
||||
|
||||
<hr>
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
96
Examples/python/index.html
Normal file
96
Examples/python/index.html
Normal file
|
|
@ -0,0 +1,96 @@
|
|||
<html>
|
||||
<head>
|
||||
<title>SWIG:Examples:python</title>
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
<H1>SWIG Python Examples</H1>
|
||||
|
||||
<tt>$Header$</tt><br>
|
||||
|
||||
<p>
|
||||
The following examples illustrate the use of SWIG with Python.
|
||||
|
||||
<ul>
|
||||
<li><a href="simple/index.html">simple</a>. A minimal example showing how SWIG can
|
||||
be used to wrap a C function, a global variable, and a constant.
|
||||
<li><a href="constants/index.html">constants</a>. This shows how preprocessor macros and
|
||||
certain C declarations are turned into constants.
|
||||
</ul>
|
||||
|
||||
<h2>Compilation Issues</h2>
|
||||
|
||||
<ul>
|
||||
<li>To create a Python extension, SWIG is run with the following options:
|
||||
|
||||
<blockquote>
|
||||
<pre>
|
||||
% swig -python interface.i
|
||||
</pre>
|
||||
</blockquote>
|
||||
|
||||
<li>The compilation of examples is done using the file <tt>Example/Makefile</tt>. This
|
||||
makefile performs a manual module compilation which is platform specific. Typically,
|
||||
the steps look like this (Linux):
|
||||
|
||||
<blockquote>
|
||||
<pre>
|
||||
% swig -python interface.i
|
||||
% gcc -fpic -c interface_wrap.c -I/usr/local/include/python1.5
|
||||
% gcc -shared interface_wrap.o $(OBJS) -o interfacemodule.so
|
||||
% python
|
||||
Python 1.5.2 (#3, Oct 9 1999, 22:09:34) [GCC 2.95.1 19990816 (release)] on linux2
|
||||
Copyright 1991-1995 Stichting Mathematisch Centrum, Amsterdam
|
||||
>>> import interface
|
||||
>>> interface.blah(...)
|
||||
...
|
||||
</pre>
|
||||
</blockquote>
|
||||
|
||||
<li>The politically "correct" way to compile a Python extension is to follow the steps
|
||||
described at <a href="http://www.python.org/doc/current/ext/building-on-unix.html">www.python.org</a>
|
||||
or in the most excellent (and shamelessly plugged) <a href="http://islab.cs.uchicago.edu/python">Python Essential Reference</a>:
|
||||
|
||||
<p>
|
||||
<ol>
|
||||
<li>Create a file called <tt>Setup</tt> that looks like the following where $(SRCS) is filled
|
||||
in with any other source files you need to build the extension:
|
||||
|
||||
<blockquote>
|
||||
<pre>
|
||||
*shared*
|
||||
interface interface_wrap.c $(SRCS)
|
||||
</pre>
|
||||
</blockquote>
|
||||
<li>Copy the file <tt>Makefile.pre.in</tt> from the Python distribution. Usually it's located
|
||||
in the directory <tt>/usr/local/lib/python1.5/config</tt> on a Unix machine.
|
||||
|
||||
<p>
|
||||
<li>Type the following to build the extension:
|
||||
|
||||
<blockquote>
|
||||
<pre>
|
||||
% make -f Makefile.pre.in boot
|
||||
% make
|
||||
</pre>
|
||||
</blockquote>
|
||||
<li> And that's it. If you are preparing an extension for distribution, you may want
|
||||
to look at the <a href="http://www.python.org/sigs/distutils-sig/">distutils</a>.
|
||||
</ol>
|
||||
</ul>
|
||||
|
||||
<h2>Compatibility</h2>
|
||||
|
||||
The examples have been extensively tested on the following platforms:
|
||||
|
||||
<ul>
|
||||
<li>Linux
|
||||
<li>Solaris
|
||||
</ul>
|
||||
|
||||
Your mileage may vary. If you experience a problem, please let us know by
|
||||
sending a message to <a href="mailto:swig-dev@cs.uchicago.edu">swig-dev@cs.uchicago.edu</a>.
|
||||
</body>
|
||||
</html>
|
||||
|
||||
|
||||
|
|
@ -1 +0,0 @@
|
|||
Simple example from the users manual
|
||||
|
|
@ -1,21 +1,18 @@
|
|||
/* Simple example from documentation */
|
||||
/* File : example.c */
|
||||
|
||||
#include <time.h>
|
||||
/* A global variable */
|
||||
double Foo = 3.0;
|
||||
|
||||
double My_variable = 3.0;
|
||||
|
||||
int fact(int n) {
|
||||
if (n <= 1) return 1;
|
||||
else return n*fact(n-1);
|
||||
/* Compute the greatest common divisor of positive integers */
|
||||
int gcd(int x, int y) {
|
||||
int g;
|
||||
g = y;
|
||||
while (x > 0) {
|
||||
g = x;
|
||||
x = y % x;
|
||||
y = g;
|
||||
}
|
||||
return g;
|
||||
}
|
||||
|
||||
int mod(int n, int m) {
|
||||
return (n % m);
|
||||
}
|
||||
|
||||
char *get_time() {
|
||||
long ltime;
|
||||
time(<ime);
|
||||
return ctime(<ime);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,8 +1,5 @@
|
|||
/* File : example.i */
|
||||
%module example
|
||||
|
||||
extern double My_variable;
|
||||
extern int fact(int);
|
||||
extern int mod(int n, int m);
|
||||
extern char *get_time();
|
||||
|
||||
extern int gcd(int x, int y);
|
||||
extern double Foo;
|
||||
|
|
|
|||
|
|
@ -1,24 +1,24 @@
|
|||
#!/home/sci/local/bin/python
|
||||
#
|
||||
# Python test script. This also illustrates the use of get/set
|
||||
# for C variables.
|
||||
|
||||
from example import *
|
||||
print get_time()
|
||||
print "My Variable = ", cvar.My_variable
|
||||
for i in range(0,14):
|
||||
n = fact(i)
|
||||
print i, "factorial is ", n
|
||||
|
||||
for i in range(1,250):
|
||||
for j in range(1,250):
|
||||
n = mod(i,j)
|
||||
cvar.My_variable = cvar.My_variable + n
|
||||
|
||||
print "My_variable = ", cvar.My_variable
|
||||
# file: example.py
|
||||
|
||||
import example
|
||||
|
||||
# Call our gcd() function
|
||||
|
||||
x = 42
|
||||
y = 105
|
||||
g = example.gcd(x,y)
|
||||
print "The gcd of %d and %d is %d" % (x,y,g)
|
||||
|
||||
# Manipulate the Foo global variable
|
||||
|
||||
# Output its current value
|
||||
print "Foo = ", example.cvar.Foo
|
||||
|
||||
# Change its value
|
||||
example.cvar.Foo = 3.1415926
|
||||
|
||||
# See if the change took effect
|
||||
print "Foo = ", example.cvar.Foo
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
99
Examples/python/simple/index.html
Normal file
99
Examples/python/simple/index.html
Normal file
|
|
@ -0,0 +1,99 @@
|
|||
<html>
|
||||
<head>
|
||||
<title>SWIG:Examples:python:simple</title>
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
|
||||
<tt>SWIG/Examples/python/simple/</tt>
|
||||
<hr>
|
||||
|
||||
<H2>Simple Python Example</H2>
|
||||
|
||||
<tt>$Header$</tt><br>
|
||||
|
||||
<p>
|
||||
This example illustrates how you can hook Python to a very simple C program containing
|
||||
a function and a global variable.
|
||||
|
||||
<h2>The C Code</h2>
|
||||
|
||||
Suppose you have the following C code:
|
||||
|
||||
<blockquote>
|
||||
<pre>
|
||||
/* File : example.c */
|
||||
|
||||
/* A global variable */
|
||||
double Foo = 3.0;
|
||||
|
||||
/* Compute the greatest common divisor of positive integers */
|
||||
int gcd(int x, int y) {
|
||||
int g;
|
||||
g = y;
|
||||
while (x > 0) {
|
||||
g = x;
|
||||
x = y % x;
|
||||
y = g;
|
||||
}
|
||||
return g;
|
||||
}
|
||||
</pre>
|
||||
</blockquote>
|
||||
|
||||
<h2>The SWIG interface</h2>
|
||||
|
||||
Here is a simple SWIG interface file:
|
||||
|
||||
<blockquote>
|
||||
<pre>
|
||||
/* File: example.i */
|
||||
%module example
|
||||
|
||||
extern int gcd(int x, int y);
|
||||
extern double Foo;
|
||||
</pre>
|
||||
</blockquote>
|
||||
|
||||
<h2>Compilation</h2>
|
||||
|
||||
<ol>
|
||||
<li><tt>swig -python <a href="example.i">example.i</a></tt>
|
||||
<p>
|
||||
<li>Compile <tt><a href="example_wrap.c">example_wrap.c</a></tt> and <tt><a href="example.c">example.c</a></tt>
|
||||
to create the extension <tt>examplemodule.so</tt>.
|
||||
</ol>
|
||||
|
||||
<h2>Using the extension</h2>
|
||||
|
||||
Click <a href="example.py">here</a> to see a script that calls our C functions from Python.
|
||||
|
||||
<h2>Key points</h2>
|
||||
|
||||
<ul>
|
||||
<li>Use the <tt>import</tt> statement to load your extension module from Python. For example:
|
||||
<blockquote>
|
||||
<pre>
|
||||
import example
|
||||
</pre>
|
||||
</blockquote>
|
||||
|
||||
<li>C functions work just like Python functions. For example:
|
||||
<blockquote>
|
||||
<pre>
|
||||
g = example.gcd(42,105)
|
||||
</pre>
|
||||
</blockquote>
|
||||
|
||||
<li>C global variables are accessed through a special variable called 'cvar'. For example:
|
||||
<blockquote>
|
||||
<pre>
|
||||
a = example.cvar.Foo
|
||||
</pre>
|
||||
</blockquote>
|
||||
</ul>
|
||||
|
||||
<hr>
|
||||
</body>
|
||||
</html>
|
||||
Loading…
Add table
Add a link
Reference in a new issue