swig/Examples
Marcelo Matus 0881d3c861 Add simple PySwigObject to handle the C/C++ instance pointers,
instead of using PyCObject or plain strings.

The new PySwigObject is even safer than PyCObject, and
more friendly than plain strings:

now you can do

  print a.this
  <Swig Object at _00691608_p_A>

  print str(a.this)
  _00691608_p_A

  print long(a.this)
  135686400

  print "%s 0x%x" % (a.this, a.this)
  _00691608_p_A 0x8166900


the last one is very useful when debugging the C/C++ side, since
is the pointer value you will usually get from the debugger.

Also, if you have some old code that uses the string representation
"_00691608_p_A", you can use it now again by calling str(ptr), or
maybe nothing special by just calling PyString_AsString(..).

This change is mainly for nostalgic swig users that miss the
string representation, but also allows to say again

  if a.this == b.this:
    return "a is b"

and well, since the change were really simple, maybe in the future
we will be able to do

    next = a.this + 1

or add native python iteration over native C/C++ arrays, ie, no
need to create/copy new tuples when returning and array or vector.


git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk/SWIG@6759 626c5289-ae23-0410-ae9c-e8d60b6d4f22
2004-11-19 20:40:20 +00:00
..
chicken More work on the chicken module. The test suite, zlib, and overload examples are still broken. 2004-11-02 02:50:30 +00:00
contract Contract simple examples 2003-09-05 19:07:01 +00:00
csharp update for change to proper enums instead of simple integers for enums 2004-11-11 21:43:17 +00:00
GIFPlot minor errors/warings fixes 2004-11-15 20:58:00 +00:00
guile Update Guile makefiles to work with default -scm mode. 2004-11-04 01:28:37 +00:00
java html fixes 2004-11-02 22:13:39 +00:00
modula3 added basic Modula-3 support 2004-03-19 11:45:29 +00:00
mzscheme Warning fixes 2004-01-07 21:27:23 +00:00
ocaml Removed unneeded constructor for shape class. 2004-11-03 17:11:20 +00:00
perl5 add back multiple_inheritance, now works 2004-11-18 18:24:30 +00:00
php4 Test const char [] instead of const char * 2004-06-15 20:12:22 +00:00
pike Various and sundry updates for the Pike module. 2003-04-30 22:22:11 +00:00
python add example of how to include the swig runtime code into external user code 2004-11-18 00:42:25 +00:00
ruby minor errors/warings fixes 2004-11-15 20:58:00 +00:00
s-exp Minor fix to the example. 2004-10-30 17:58:16 +00:00
tcl html fixes 2004-11-02 22:13:39 +00:00
test-suite Add simple PySwigObject to handle the C/C++ instance pointers, 2004-11-19 20:40:20 +00:00
xml Initial revision, contributed by Klaus Wiederaenders. 2001-01-17 02:19:04 +00:00
.cvsignore Removed soft link naming kludge 2003-09-01 14:40:21 +00:00
index.html The great merge 2002-11-30 22:01:28 +00:00
Makefile.in Update Guile makefiles to work with default -scm mode. 2004-11-04 01:28:37 +00:00
README Added chicken to list of example directories. 2003-02-15 01:58:36 +00:00

SWIG Examples

The "perl5", "python", "tcl", "guile", "java", "mzscheme", "ruby", and
"chicken" directories contain a number of simple examples that are
primarily used for testing. The "GIFPlot" directory contains a more
complicated example that illustrates some of SWIG's more advanced
capabilities.

The file 'index.html' is the top of a hyperlinked document that
contains information about all of the examples along with various
notes related to each example.

The Examples directory is currently quite incomplete because it
is being reorganized.  A more complete set of examples can be found
in the SWIG1.1p5 distribution (most of which should still work with
SWIG1.3).

Note: All of the examples rely upon the Makefile in this directory.
You may need to edit it to reflect the configuration of your machine
in case the configure script guesses incorrect settings.


*** Special note concering C++ ***

The configure script is currently unable to handle all of the possible
options for producing dynamically loadable C++ extensions.  Here are
the rules of thumb for making C++ work:

 -  Try using the C++ as the linker for the shared library.  For example:

         g++ -shared $(OBJS) -o module.so

 -  If that doesn't work, you may need to explicitly link against some
    kind of C++ runtime library.  For example:

         ld -G $(OBJS) -L/opt/SUNWspro/lib -lCrun -o module.so

    This can be set by modifying the setting of CPP_DLLIBS in the
    Makefile.


*** Special note for SWIG Maintainers ***

When you add an example, consider arranging for the example to be also
useful as part of the SWIG testing framework.  To do this, include in
the example makefile a target "check" ("check: all" is sufficient for a
first pass), and add an invocation to ../Makefile.in under target
"check-examples" (or whatever is appropriate).  Later, we can add or
expand the actions under target "check" to do more in-depth testing.