swig/Examples
William S Fulton bf36bf7d8a Movable and move-only types supported in "out" typemaps.
Enhance SWIGTYPE "out" typemaps to use std::move when copying
objects, thereby making use of move semantics when wrapping a function returning
by value if the returned type supports move semantics.

Wrapping functions that return move only types 'by value' now work out the box
without having to provide custom typemaps.

The implementation removed all casts in the "out" typemaps to allow the compiler to
appropriately choose calling a move constructor, where possible, otherwise a copy
constructor. The implementation alsoand required modifying SwigValueWrapper to
change a cast operator from:

  SwigValueWrapper::operator T&() const;

to

  #if __cplusplus >=201103L
    SwigValueWrapper::operator T&&() const;
  #else
    SwigValueWrapper::operator T&() const;
  #endif

This is not backwards compatible for C++11 and later when using the valuewrapper feature
if a cast is explicitly being made in user supplied "out" typemaps. Suggested change
in custom "out" typemaps for C++11 and later code:

1. Try remove the cast altogether to let the compiler use an appropriate implicit cast.
2. Change the cast, for example, from static_cast<X &> to static_cast<X &&>, using the
   __cplusplus macro if all versions of C++ need to be supported.

Issue #999
Closes #1044

More about the commit:
Added some missing "varout" typemaps for Ocaml which was falling back to
use "out" typemaps as they were missing.

Ruby std::set fix for SwigValueWrapper C++11 changes.
2022-06-30 17:26:48 +01:00
..
android
csharp
d
go [Go] Add an example for goin and godirectorin 2022-04-18 19:55:34 -05:00
guile Remove redundant NULL checks before free()/delete (#2184) 2022-01-29 22:03:48 +13:00
java
javascript Fix testcase -Wstringop-truncation warning in gcc11 2021-11-12 19:00:20 +00:00
lua Fix typos in docs and comments 2022-02-27 18:15:46 +13:00
mzscheme Remove use of std::bind2nd which is removed in C++17 2019-06-27 07:40:49 +01:00
ocaml [S-EXP] Remove code for Common Lisp S-Exp 2021-05-16 08:42:39 +12:00
octave Fix problem with recent commit 2022-02-06 16:50:30 +13:00
perl5
php [PHP] Remove useless shadowed variable in example 2022-02-03 23:04:58 +13:00
python Remove some usage of strdup 2022-05-07 07:09:44 +01:00
r
ruby Fix various typos 2022-04-11 07:59:36 +12:00
scilab Alphabetise testing of examples 2020-08-13 20:07:10 +01:00
tcl Remove use of std::bind2nd which is removed in C++17 2019-06-27 07:40:49 +01:00
test-suite Movable and move-only types supported in "out" typemaps. 2022-06-30 17:26:48 +01:00
xml Remove redundant NULL checks before free()/delete (#2184) 2022-01-29 22:03:48 +13:00
index.html
Makefile.in [php] Adjust #required params for subclass methods 2022-06-14 16:00:46 +12:00
README

SWIG Examples

The subdirectories of "Examples" named after SWIG's language backends
contain a number of simple examples that are primarily used for testing.

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.

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 concerning 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.