SWIG:Examples:perl5

# SWIG Perl Examples

`$Header: /cvs/projects/SWIG/Examples/perl5/index.html,v 1.8.4.2 2001/12/08 23:33:09 cheetah Exp $`

The following examples illustrate the use of SWIG with Perl.

- simple. A minimal example showing how SWIG can be used to wrap a C function and a global variable.
- constants. This shows how preprocessor macros and certain C declarations are turned into constants.
- variables. This example shows how to access C global variables from Perl.
- value. How to pass and return structures by value.
- class. How to wrap a simple C++ class.
- reference. C++ references.
- pointer. Simple pointer handling.
- funcptr. Pointers to functions.

## Compilation Issues

- To create a Perl extension, SWIG is run with the following options:

  >     % swig -perl5 interface.i

- The compilation of examples is done using the file `Example/Makefile`. This makefile performs a manual module compilation which is platform specific. Typically, the steps look like this (Linux):

  >     % swig -perl5 interface.i
  >     % gcc -fpic -c -Dbool=char -I/usr/lib/perl5/5.00503/i386-linux/CORE interface_wrap.c
  >     % gcc -shared interface_wrap.o $(OBJS) -o interface.so
  >     % perl
  >     use interface;
  >     ...

- The politically "correct" way to compile a Perl extension module is to use MakeMaker and related tools (especially if you are considering third-party distribution). Consult a book such as Advanced Perl Programming for details.

## Compatibility

The examples have been extensively tested on the following platforms:

- Linux
- Solaris

Please see the Windows page in the main manual for information on using the examples on Windows.

The most recent version of Perl used for testing is as follows:

>     % perl -version
>     This is perl, v5.6.0 built for sun4-solaris

>     Copyright 1987-2000, Larry Wall

>     Perl may be copied only under the terms of either the Artistic License or the
>     GNU General Public License, which may be found in the Perl 5.0 source kit.

>     Complete documentation for Perl, including FAQ lists, should be found on
>     this system using `man perl' or `perldoc perl'.  If you have access to the
>     Internet, point your browser at http://www.perl.com/, the Perl Home Page.

Due to wide variations in the Perl C API and differences between versions such as the ActivePerl release for Windows, the code generated by SWIG is extremely messy. We have made every attempt to maintain compatibility with many Perl releases going as far back as 5.003 and as recent as 5.6. However, your mileage may vary. If you experience a problem, please let us know by sending a message to swig-dev@cs.uchicago.edu. Better yet, send us a patch.