Improve the class example for several languages.
Fix numerous inaccuracies in index.html (where it exists) and eliminate unnecessary differences between the example code being wrapped.
This commit is contained in:
parent
2f3bf144c6
commit
34c97ffdbd
23 changed files with 154 additions and 412 deletions
|
|
@ -1,4 +1,4 @@
|
|||
/* File : example.c */
|
||||
/* File : example.cxx */
|
||||
|
||||
#include "example.h"
|
||||
#define M_PI 3.14159265358979323846
|
||||
|
|
@ -11,18 +11,18 @@ void Shape::move(double dx, double dy) {
|
|||
|
||||
int Shape::nshapes = 0;
|
||||
|
||||
double Circle::area(void) {
|
||||
double Circle::area() {
|
||||
return M_PI*radius*radius;
|
||||
}
|
||||
|
||||
double Circle::perimeter(void) {
|
||||
double Circle::perimeter() {
|
||||
return 2*M_PI*radius;
|
||||
}
|
||||
|
||||
double Square::area(void) {
|
||||
double Square::area() {
|
||||
return width*width;
|
||||
}
|
||||
|
||||
double Square::perimeter(void) {
|
||||
double Square::perimeter() {
|
||||
return 4*width;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -7,11 +7,11 @@ public:
|
|||
}
|
||||
virtual ~Shape() {
|
||||
nshapes--;
|
||||
};
|
||||
double x, y;
|
||||
}
|
||||
double x, y;
|
||||
void move(double dx, double dy);
|
||||
virtual double area(void) = 0;
|
||||
virtual double perimeter(void) = 0;
|
||||
virtual double area() = 0;
|
||||
virtual double perimeter() = 0;
|
||||
static int nshapes;
|
||||
};
|
||||
|
||||
|
|
@ -19,29 +19,24 @@ class Circle : public Shape {
|
|||
private:
|
||||
double radius;
|
||||
public:
|
||||
Circle(double r) : radius(r) { };
|
||||
virtual double area(void);
|
||||
virtual double perimeter(void);
|
||||
Circle(double r) : radius(r) { }
|
||||
virtual double area();
|
||||
virtual double perimeter();
|
||||
};
|
||||
|
||||
class Square : public Shape {
|
||||
private:
|
||||
double width;
|
||||
public:
|
||||
Square(double w) : width(w) { };
|
||||
virtual double area(void);
|
||||
virtual double perimeter(void);
|
||||
Square(double w) : width(w) { }
|
||||
virtual double area();
|
||||
virtual double perimeter();
|
||||
};
|
||||
|
||||
typedef Square TSquare;
|
||||
class CFoo
|
||||
{
|
||||
public:
|
||||
static Square MakeSquare(void) {return Square(4.0);};
|
||||
static TSquare MakeTSquare(void) {return Square(4.0);};
|
||||
static Square MakeSquare(void) {return Square(4.0);}
|
||||
static TSquare MakeTSquare(void) {return Square(4.0);}
|
||||
};
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -6,6 +6,5 @@
|
|||
%}
|
||||
|
||||
/* Let's just grab the original header file here */
|
||||
|
||||
%include "example.h"
|
||||
|
||||
|
|
|
|||
|
|
@ -32,8 +32,8 @@ public:
|
|||
}
|
||||
virtual ~Shape() {
|
||||
nshapes--;
|
||||
};
|
||||
double x, y;
|
||||
}
|
||||
double x, y;
|
||||
void move(double dx, double dy);
|
||||
virtual double area() = 0;
|
||||
virtual double perimeter() = 0;
|
||||
|
|
@ -44,7 +44,7 @@ class Circle : public Shape {
|
|||
private:
|
||||
double radius;
|
||||
public:
|
||||
Circle(double r) : radius(r) { };
|
||||
Circle(double r) : radius(r) { }
|
||||
virtual double area();
|
||||
virtual double perimeter();
|
||||
};
|
||||
|
|
@ -53,7 +53,7 @@ class Square : public Shape {
|
|||
private:
|
||||
double width;
|
||||
public:
|
||||
Square(double w) : width(w) { };
|
||||
Square(double w) : width(w) { }
|
||||
virtual double area();
|
||||
virtual double perimeter();
|
||||
};
|
||||
|
|
@ -82,7 +82,7 @@ like this:
|
|||
Note: when creating a C++ extension, you must run SWIG with the <tt>-c++</tt> option like this:
|
||||
<blockquote>
|
||||
<pre>
|
||||
% swig -c++ -python example.i
|
||||
% swig -c++ -perl example.i
|
||||
</pre>
|
||||
</blockquote>
|
||||
|
||||
|
|
@ -97,60 +97,45 @@ Click <a href="runme.pl">here</a> to see a script that calls the C++ functions f
|
|||
|
||||
<blockquote>
|
||||
<pre>
|
||||
$c = example::new_Circle(10.0);
|
||||
$c = new example::Circle(10.0);
|
||||
</pre>
|
||||
</blockquote>
|
||||
|
||||
<p>
|
||||
<li>To access member data, a pair of accessor functions are used.
|
||||
For example:
|
||||
<li>You can access member data like so:
|
||||
|
||||
<blockquote>
|
||||
<pre>
|
||||
example::Shape_x_set($c,15); # Set member data
|
||||
$x = example::Shape_x_get($c); # Get member data
|
||||
</pre>
|
||||
</blockquote>
|
||||
|
||||
Note: when accessing member data, the name of the class in which
|
||||
the data member is defined is used. For example <tt>Shape_x_get()</tt>.
|
||||
|
||||
<p>
|
||||
<li>To invoke a member function, you simply do this
|
||||
|
||||
<blockquote>
|
||||
<pre>
|
||||
print "The area is ", example::Shape_area($c);
|
||||
$c->{x} = 15; # Set member data
|
||||
$x = $c->{x}; # Get member data
|
||||
</pre>
|
||||
</blockquote>
|
||||
|
||||
<p>
|
||||
<li>Type checking knows about the inheritance structure of C++. For example:
|
||||
<li>To invoke a member function, you simply do this:
|
||||
|
||||
<blockquote>
|
||||
<pre>
|
||||
example::Shape_area($c); # Works (c is a Shape)
|
||||
example::Circle_area($c); # Works (c is a Circle)
|
||||
example::Square_area($c); # Fails (c is definitely not a Square)
|
||||
print "The area is ", $c->area();
|
||||
</pre>
|
||||
</blockquote>
|
||||
|
||||
<p>
|
||||
<li>To invoke a destructor, simply do this
|
||||
<li>To invoke a destructor, simply do this:
|
||||
|
||||
<blockquote>
|
||||
<pre>
|
||||
example::delete_Shape($c); # Deletes a shape
|
||||
$c->DESTROY(); # Deletes a shape
|
||||
</pre>
|
||||
</blockquote>
|
||||
|
||||
<p>
|
||||
<li>Static member variables are wrapped as C global variables. For example:
|
||||
<li>Static member variables are wrapped like so:
|
||||
|
||||
<blockquote>
|
||||
<pre>
|
||||
$n = $example::Shape_nshapes; # Get a static data member
|
||||
$example::Shapes_nshapes = 13; # Set a static data member
|
||||
$n = $example::Shape::nshapes; # Get a static data member
|
||||
$example::Shapes::nshapes = 13; # Set a static data member
|
||||
</pre>
|
||||
</blockquote>
|
||||
|
||||
|
|
@ -159,47 +144,11 @@ $example::Shapes_nshapes = 13; # Set a static data member
|
|||
<h2>General Comments</h2>
|
||||
|
||||
<ul>
|
||||
<li>This low-level interface is not the only way to handle C++ code. Proxy classes
|
||||
provide a much higher-level interface.
|
||||
|
||||
<p>
|
||||
<li>SWIG *does* know how to properly perform upcasting of objects in an inheritance
|
||||
<li>SWIG <b>does</b> know how to properly perform upcasting of objects in an inheritance
|
||||
hierarchy (including multiple inheritance). Therefore it is perfectly safe to pass
|
||||
an object of a derived class to any function involving a base class.
|
||||
|
||||
<p>
|
||||
<li>A wide variety of C++ features are not currently supported by SWIG. Here is the
|
||||
short and incomplete list:
|
||||
|
||||
<p>
|
||||
<ul>
|
||||
<li>Overloaded methods and functions. SWIG wrappers don't know how to resolve name
|
||||
conflicts so you must give an alternative name to any overloaded method name using the
|
||||
%name directive like this:
|
||||
|
||||
<blockquote>
|
||||
<pre>
|
||||
void foo(int a);
|
||||
%name(foo2) void foo(double a, double b);
|
||||
</pre>
|
||||
</blockquote>
|
||||
|
||||
<p>
|
||||
<li>Overloaded operators. Not supported at all. The only workaround for this is
|
||||
to write a helper function. For example:
|
||||
|
||||
<blockquote>
|
||||
<pre>
|
||||
%inline %{
|
||||
Vector *vector_add(Vector *a, Vector *b) {
|
||||
... whatever ...
|
||||
}
|
||||
%}
|
||||
</pre>
|
||||
</blockquote>
|
||||
|
||||
<p>
|
||||
<li>Namespaces. Not supported at all. Won't be supported until SWIG2.0 (if at all).
|
||||
<li>C++ Namespaces - %nspace isn't yet supported for Perl.
|
||||
|
||||
</ul>
|
||||
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ foreach $o ($c,$s) {
|
|||
print " $o\n";
|
||||
print " area = ", $o->area(), "\n";
|
||||
print " perimeter = ", $o->perimeter(), "\n";
|
||||
}
|
||||
}
|
||||
|
||||
# ----- Delete everything -----
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue