diff options
Diffstat (limited to 'trunk/Examples/perl5/variables')
| -rw-r--r-- | trunk/Examples/perl5/variables/Makefile | 18 | ||||
| -rw-r--r-- | trunk/Examples/perl5/variables/example.c | 91 | ||||
| -rw-r--r-- | trunk/Examples/perl5/variables/example.h | 6 | ||||
| -rw-r--r-- | trunk/Examples/perl5/variables/example.i | 51 | ||||
| -rw-r--r-- | trunk/Examples/perl5/variables/index.html | 63 | ||||
| -rw-r--r-- | trunk/Examples/perl5/variables/runme.pl | 73 |
6 files changed, 302 insertions, 0 deletions
diff --git a/trunk/Examples/perl5/variables/Makefile b/trunk/Examples/perl5/variables/Makefile new file mode 100644 index 000000000..ce2bbb5b9 --- /dev/null +++ b/trunk/Examples/perl5/variables/Makefile @@ -0,0 +1,18 @@ +TOP = ../.. +SWIG = $(TOP)/../preinst-swig +SRCS = example.c +TARGET = example +INTERFACE = example.i +SWIGOPT = +all:: + $(MAKE) -f $(TOP)/Makefile SRCS='$(SRCS)' SWIG='$(SWIG)' \ + SWIGOPT='$(SWIGOPT)' TARGET='$(TARGET)' INTERFACE='$(INTERFACE)' perl5 + +static:: + $(MAKE) -f $(TOP)/Makefile SRCS='$(SRCS)' SWIG='$(SWIG)' \ + SWIGOPT='$(SWIGOPT)' TARGET='myperl' INTERFACE='$(INTERFACE)' perl5_static + +clean:: + $(MAKE) -f $(TOP)/Makefile perl5_clean + +check: all diff --git a/trunk/Examples/perl5/variables/example.c b/trunk/Examples/perl5/variables/example.c new file mode 100644 index 000000000..aa4ffe9b3 --- /dev/null +++ b/trunk/Examples/perl5/variables/example.c @@ -0,0 +1,91 @@ +/* File : example.c */ + +/* I'm a file containing some C global variables */ + +/* Deal with Microsoft's attempt at deprecating C standard runtime functions */ +#if !defined(SWIG_NO_CRT_SECURE_NO_DEPRECATE) && defined(_MSC_VER) +# define _CRT_SECURE_NO_DEPRECATE +#endif + +#include <stdio.h> +#include <stdlib.h> +#include "example.h" + +int ivar = 0; +short svar = 0; +long lvar = 0; +unsigned int uivar = 0; +unsigned short usvar = 0; +unsigned long ulvar = 0; +signed char scvar = 0; +unsigned char ucvar = 0; +char cvar = 0; +float fvar = 0; +double dvar = 0; +char *strvar = 0; +const char cstrvar[] = "Goodbye"; +int *iptrvar = 0; +char name[256] = "Dave"; +char path[256] = "/home/beazley"; + + +/* Global variables involving a structure */ +Point *ptptr = 0; +Point pt = { 10, 20 }; + +/* A variable that we will make read-only in the interface */ +int status = 1; + +/* A debugging function to print out their values */ + +void print_vars() { + printf("ivar = %d\n", ivar); + printf("svar = %d\n", svar); + printf("lvar = %ld\n", lvar); + printf("uivar = %u\n", uivar); + printf("usvar = %u\n", usvar); + printf("ulvar = %lu\n", ulvar); + printf("scvar = %d\n", scvar); + printf("ucvar = %u\n", ucvar); + printf("fvar = %g\n", fvar); + printf("dvar = %g\n", dvar); + printf("cvar = %c\n", cvar); + printf("strvar = %s\n", strvar ? strvar : "(null)"); + printf("cstrvar = %s\n", cstrvar ? cstrvar : "(null)"); + printf("iptrvar = %p\n", iptrvar); + printf("name = %s\n", name); + printf("ptptr = %p (%d, %d)\n", ptptr, ptptr ? ptptr->x : 0, ptptr ? ptptr->y : 0); + printf("pt = (%d, %d)\n", pt.x, pt.y); + printf("status = %d\n", status); +} + +/* A function to create an integer (to test iptrvar) */ + +int *new_int(int value) { + int *ip = (int *) malloc(sizeof(int)); + *ip = value; + return ip; +} + +/* A function to create a point */ + +Point *new_Point(int x, int y) { + Point *p = (Point *) malloc(sizeof(Point)); + p->x = x; + p->y = y; + return p; +} + +char * Point_print(Point *p) { + static char buffer[256]; + if (p) { + sprintf(buffer,"(%d,%d)", p->x,p->y); + } else { + sprintf(buffer,"null"); + } + return buffer; +} + +void pt_print() { + printf("(%d, %d)\n", pt.x, pt.y); +} diff --git a/trunk/Examples/perl5/variables/example.h b/trunk/Examples/perl5/variables/example.h new file mode 100644 index 000000000..0f7e89594 --- /dev/null +++ b/trunk/Examples/perl5/variables/example.h @@ -0,0 +1,6 @@ +/* File: example.h */ + +typedef struct { + int x,y; +} Point; + diff --git a/trunk/Examples/perl5/variables/example.i b/trunk/Examples/perl5/variables/example.i new file mode 100644 index 000000000..9d0101cb7 --- /dev/null +++ b/trunk/Examples/perl5/variables/example.i @@ -0,0 +1,51 @@ +/* File : example.i */ +%module example +%{ +#include "example.h" +%} + +#pragma SWIG nowarn=SWIGWARN_TYPEMAP_SWIGTYPELEAK + +/* Some global variable declarations */ +%inline %{ +extern int ivar; +extern short svar; +extern long lvar; +extern unsigned int uivar; +extern unsigned short usvar; +extern unsigned long ulvar; +extern signed char scvar; +extern unsigned char ucvar; +extern char cvar; +extern float fvar; +extern double dvar; +extern char *strvar; +extern const char cstrvar[]; +extern int *iptrvar; +extern char name[256]; + +extern Point *ptptr; +extern Point pt; +%} + + +/* Some read-only variables */ + +%immutable; + +%inline %{ +extern int status; +extern char path[256]; +%} + +%mutable; + +/* Some helper functions to make it easier to test */ +%inline %{ +extern void print_vars(); +extern int *new_int(int value); +extern Point *new_Point(int x, int y); +extern char *Point_print(Point *p); +extern void pt_print(); +%} + diff --git a/trunk/Examples/perl5/variables/index.html b/trunk/Examples/perl5/variables/index.html new file mode 100644 index 000000000..e4d426e2d --- /dev/null +++ b/trunk/Examples/perl5/variables/index.html @@ -0,0 +1,63 @@ +<html> +<head> +<title>SWIG:Examples:perl5:variables</title> +</head> + +<body bgcolor="#ffffff"> + +<tt>SWIG/Examples/perl5/variables/</tt> +<hr> + +<H2>Wrapping C Global Variables</H2> + +<p> +When a C global variable appears in an interface file, SWIG tries to +wrap it using a technique known as "variable linking." The idea is +pretty simple---we try to create a Perl variable that magically +retrieves or updates the value of the underlying C variable when it is +accessed. Click <a href="example.i">here</a> to see a SWIG interface with some variable +declarations in it. + +<h2>Manipulating Variables from Perl</h2> + +Accessing a C global variable from Perl is easy---just reference it like a normal Perl variable. +Click <a href="runme.pl">here</a> to see a script that updates and prints some global variables. + +<h2>Creating read-only variables</h2> + +The <tt>%immutable</tt> and <tt>%mutable</tt> directives can be used to +specify a collection of read-only variables. For example: + +<blockquote> +<pre> +%immutable; +int status; +double blah; +... +%mutable; +</pre> +</blockquote> + +The <tt>%immutable</tt> directive remains in effect until it is explicitly disabled +using the <tt>%mutable</tt> directive. + + +<h2>Notes:</h2> + +<ul> +<li>When a global variable has the type "<tt>char *</tt>", SWIG manages it as a character +string. However, whenever the value of such a variable is set from Perl, the old +value is destroyed using <tt>free()</tt> or <tt>delete</tt> (the choice of which depends +on whether or not SWIG was run with the -c++ option). +<li><tt>signed char</tt> and <tt>unsigned char</tt> are handled as small 8-bit integers. +<li>String array variables such as '<tt>char name[256]</tt>' are managed as Perl strings, but +when setting the value, the result is truncated to the maximum length of the array. Furthermore, the string is assumed to be null-terminated. +<li>When structures and classes are used as global variables, they are mapped into pointers. +Getting the "value" returns a pointer to the global variable. Setting the value of a structure results in a memory copy from a pointer to the global. +<li>Variables are linked using Perl's magic mechanism. Take a look at the Advanced Perl Programming book to +find out more about this feature. +</ul> + +</body> +</html> +<hr> diff --git a/trunk/Examples/perl5/variables/runme.pl b/trunk/Examples/perl5/variables/runme.pl new file mode 100644 index 000000000..76e3dc8bc --- /dev/null +++ b/trunk/Examples/perl5/variables/runme.pl @@ -0,0 +1,73 @@ +# file: runme.pl + +use example; + +# Try to set the values of some global variables + +$example::ivar = 42; +$example::svar = -31000; +$example::lvar = 65537; +$example::uivar = 123456; +$example::usvar = 61000; +$example::ulvar = 654321; +$example::scvar = -13; +$example::ucvar = 251; +$example::cvar = "S"; +$example::fvar = 3.14159; +$example::dvar = 2.1828; +$example::strvar = "Hello World"; +$example::iptrvar= example::new_int(37); +$example::ptptr = example::new_Point(37,42); +$example::name = "Bill"; + +# Now print out the values of the variables + +print "Variables (values printed from Perl)\n"; + +print "ivar = $example::ivar\n"; +print "svar = $example::svar\n"; +print "lvar = $example::lvar\n"; +print "uivar = $example::uivar\n"; +print "usvar = $example::usvar\n"; +print "ulvar = $example::ulvar\n"; +print "scvar = $example::scvar\n"; +print "ucvar = $example::ucvar\n"; +print "fvar = $example::fvar\n"; +print "dvar = $example::dvar\n"; +print "cvar = $example::cvar\n"; +print "strvar = $example::strvar\n"; +print "cstrvar = $example::cstrvar\n"; +print "iptrvar = $example::iptrvar\n"; +print "name = $example::name\n"; +print "ptptr = $example::ptptr", example::Point_print($example::ptptr), "\n"; +print "pt = $example::pt", example::Point_print($example::pt), "\n"; + +print "\nVariables (values printed from C)\n"; + +example::print_vars(); + +print "\nI'm going to try and update a structure variable.\n"; + +$example::pt = $example::ptptr; + +print "The new value is "; +example::pt_print(); +print "You should see the value", example::Point_print($example::ptptr), "\n"; + + +print "\nNow I'm going to try and modify some read only variables\n"; + + +print " Trying to set 'status'\n"; +eval { $example::status = 0; }; +if (!$@) { + die("status"); +} +print " get error for 'status'\n"; + +print " Tring to set 'path'\n"; +eval { $example::path = "Whoa!";}; +if (!$@) { + die("path"); +} +print " get error for 'path'\n"; |