Add Ruby support contributed by Masaki Fukushima.
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@518 626c5289-ae23-0410-ae9c-e8d60b6d4f22
This commit is contained in:
Thien-Thi Nguyen
parent
263818929b
commit
4d989f6796
39 changed files with 3754 additions and 10 deletions
18
SWIG/Examples/ruby/constants/Makefile
Normal file
18
SWIG/Examples/ruby/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)' ruby
|
||||
|
||||
static::
|
||||
$(MAKE) -f $(TOP)/Makefile SRCS='$(SRCS)' SWIG='$(SWIG)' \
|
||||
TARGET='myruby' INTERFACE='$(INTERFACE)' ruby_static
|
||||
|
||||
clean::
|
||||
rm -f *_wrap* *.o *~ *.so myruby .~* core
|
||||
|
||||
|
||||
24
SWIG/Examples/ruby/constants/example.i
Normal file
24
SWIG/Examples/ruby/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;
|
||||
|
||||
|
||||
66
SWIG/Examples/ruby/constants/index.html
Normal file
66
SWIG/Examples/ruby/constants/index.html
Normal file
|
|
@ -0,0 +1,66 @@
|
|||
<html>
|
||||
<head>
|
||||
<title>SWIG:Examples:ruby:constants</title>
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
<tt>SWIG/Examples/ruby/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 Ruby constants 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 Ruby</h2>
|
||||
|
||||
Click <a href="run.rb">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 Ruby 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 Ruby strings.
|
||||
<li>C string literals such as "Hello World" are converted into Ruby 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 Ruby constants.
|
||||
|
||||
<li>Constants that begin with lower case character are automatically capitalized.
|
||||
For example:
|
||||
<blockquote>
|
||||
<pre>
|
||||
const int iconst = 37;
|
||||
</pre>
|
||||
</blockquote>
|
||||
is capitalized as <tt>Example::Iconst</tt> because Ruby constants name must begin
|
||||
with upper case character.
|
||||
|
||||
<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>
|
||||
23
SWIG/Examples/ruby/constants/run.rb
Normal file
23
SWIG/Examples/ruby/constants/run.rb
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
# file: run.rb
|
||||
|
||||
require 'example'
|
||||
|
||||
print "ICONST = ", Example::ICONST, " (should be 42)\n"
|
||||
print "FCONST = ", Example::FCONST, " (should be 2.1828)\n"
|
||||
print "CCONST = ", Example::CCONST, " (should be 'x')\n"
|
||||
print "SCONST = ", Example::SCONST, " (should be 'Hello World')\n"
|
||||
print "EXPR = ", Example::EXPR, " (should be 48.5484)\n"
|
||||
print "iconst = ", Example::Iconst, " (should be 37)\n"
|
||||
print "fconst = ", Example::Fconst, " (should be 3.14)\n"
|
||||
|
||||
begin
|
||||
print "EXTERN = ", Example::EXTERN, " (Arg! This shouldn't print anything)\n"
|
||||
rescue NameError
|
||||
print "EXTERN isn't defined (good)\n"
|
||||
end
|
||||
|
||||
begin
|
||||
print "FOO = ", Example::FOO, " (Arg! This shouldn't print anything)\n"
|
||||
rescue NameError
|
||||
print "FOO isn't defined (good)\n"
|
||||
end
|
||||
85
SWIG/Examples/ruby/index.html
Normal file
85
SWIG/Examples/ruby/index.html
Normal file
|
|
@ -0,0 +1,85 @@
|
|||
|
||||
<head>
|
||||
<title>SWIG:Examples:ruby</title>
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
<H1>SWIG Ruby Examples</H1>
|
||||
|
||||
<tt>$Header$</tt><br>
|
||||
|
||||
<p>
|
||||
The following examples illustrate the use of SWIG with Ruby.
|
||||
|
||||
<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 Ruby extension, SWIG is run with the following options:
|
||||
|
||||
<blockquote>
|
||||
<pre>
|
||||
% swig -ruby 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 -ruby interface.i
|
||||
% gcc -fpic -c interface_wrap.c -I/usr/local/lib/ruby/1.4/i686-linux
|
||||
% gcc -shared interface_wrap.o $(OBJS) -o interface.so
|
||||
% ruby
|
||||
require 'interface'
|
||||
Interface.blah(...)
|
||||
...
|
||||
</pre>
|
||||
</blockquote>
|
||||
|
||||
<li>The politically "correct" way to compile a Ruby extension is to follow the steps
|
||||
described <tt>README.EXT</tt> in Ruby distribution:
|
||||
|
||||
<p>
|
||||
<ol>
|
||||
<li>Create a file called <tt>extconf.rb</tt> that looks like the following:
|
||||
|
||||
<blockquote>
|
||||
<pre>
|
||||
require 'mkmf'
|
||||
create_makefile('interface')
|
||||
</pre>
|
||||
</blockquote>
|
||||
<li>Type the following to build the extension:
|
||||
|
||||
<blockquote>
|
||||
<pre>
|
||||
% ruby extconf.rb
|
||||
% make
|
||||
</pre>
|
||||
</blockquote>
|
||||
</ol>
|
||||
</ul>
|
||||
|
||||
<h2>Compatibility</h2>
|
||||
|
||||
The examples have been extensively tested on the following platforms:
|
||||
|
||||
<ul>
|
||||
<li>Linux
|
||||
</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>
|
||||
|
||||
|
||||
18
SWIG/Examples/ruby/simple/Makefile
Normal file
18
SWIG/Examples/ruby/simple/Makefile
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
TOP = ../..
|
||||
SWIG = $(TOP)/../swig
|
||||
SRCS = example.c
|
||||
TARGET = example
|
||||
INTERFACE = example.i
|
||||
|
||||
all::
|
||||
$(MAKE) -f $(TOP)/Makefile SRCS='$(SRCS)' SWIG='$(SWIG)' \
|
||||
TARGET='$(TARGET)' INTERFACE='$(INTERFACE)' ruby
|
||||
|
||||
static::
|
||||
$(MAKE) -f $(TOP)/Makefile SRCS='$(SRCS)' SWIG='$(SWIG)' \
|
||||
TARGET='myruby' INTERFACE='$(INTERFACE)' ruby_static
|
||||
|
||||
clean::
|
||||
rm -f *_wrap* *.o *~ *.so myruby .~* core
|
||||
|
||||
|
||||
18
SWIG/Examples/ruby/simple/example.c
Normal file
18
SWIG/Examples/ruby/simple/example.c
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
/* 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;
|
||||
}
|
||||
|
||||
|
||||
5
SWIG/Examples/ruby/simple/example.i
Normal file
5
SWIG/Examples/ruby/simple/example.i
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
/* File : example.i */
|
||||
%module example
|
||||
|
||||
extern int gcd(int x, int y);
|
||||
extern double Foo;
|
||||
99
SWIG/Examples/ruby/simple/index.html
Normal file
99
SWIG/Examples/ruby/simple/index.html
Normal file
|
|
@ -0,0 +1,99 @@
|
|||
<html>
|
||||
<head>
|
||||
<title>SWIG:Examples:ruby:simple</title>
|
||||
</head>
|
||||
|
||||
<body bgcolor="#ffffff">
|
||||
|
||||
|
||||
<tt>SWIG/Examples/ruby/simple/</tt>
|
||||
<hr>
|
||||
|
||||
<H2>Simple Ruby Example</H2>
|
||||
|
||||
<tt>$Header$</tt><br>
|
||||
|
||||
<p>
|
||||
This example illustrates how you can hook Ruby 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 -ruby <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>example.so</tt>.
|
||||
</ol>
|
||||
|
||||
<h2>Using the extension</h2>
|
||||
|
||||
Click <a href="run.rb">here</a> to see a script that calls our C functions from Ruby.
|
||||
|
||||
<h2>Key points</h2>
|
||||
|
||||
<ul>
|
||||
<li>Use the <tt>require</tt> function to load your extension library from Ruby. For example:
|
||||
<blockquote>
|
||||
<pre>
|
||||
require 'example'
|
||||
</pre>
|
||||
</blockquote>
|
||||
|
||||
<li>C functions work just like Ruby functions. For example:
|
||||
<blockquote>
|
||||
<pre>
|
||||
g = Example.gcd(42,105)
|
||||
</pre>
|
||||
</blockquote>
|
||||
|
||||
<li>C global variables are accessed through module method. For example:
|
||||
<blockquote>
|
||||
<pre>
|
||||
a = Example.Foo
|
||||
</pre>
|
||||
</blockquote>
|
||||
</ul>
|
||||
|
||||
<hr>
|
||||
</body>
|
||||
</html>
|
||||
21
SWIG/Examples/ruby/simple/run.rb
Normal file
21
SWIG/Examples/ruby/simple/run.rb
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
# file: run.rb
|
||||
|
||||
require 'example'
|
||||
|
||||
# Call our gcd() function
|
||||
|
||||
x = 42
|
||||
y = 105
|
||||
g = Example.gcd(x,y)
|
||||
printf "The gcd of %d and %d is %d\n",x,y,g
|
||||
|
||||
# Manipulate the Foo global variable
|
||||
|
||||
# Output its current value
|
||||
print "Foo = ", Example.Foo, "\n"
|
||||
|
||||
# Change its value
|
||||
Example.Foo = 3.1415926
|
||||
|
||||
# See if the change took effect
|
||||
print "Foo = ", Example.Foo, "\n"
|
||||
Loading…
Add table
Add a link
Reference in a new issue