From aac2b5d2e16bba3866b6643473f68a7a82d91594 Mon Sep 17 00:00:00 2001
From: William S Fulton <wsf@fultondesigns.co.uk>
Date: Sat, 14 May 2011 23:54:09 +0000
Subject: [PATCH] Remove VARARGS_SENTINEL typemaps further to revision 12666.
 Note that the idea of having a named typemap for sentinels is flawed unless
 the named typemap is provided for every single type in the typemap library.

git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@12668 626c5289-ae23-0410-ae9c-e8d60b6d4f22
---
 Doc/Manual/Varargs.html   | 20 ++++++++++++++++++++
 Lib/swig.swg              |  6 ------
 Lib/typemaps/swigtype.swg |  5 -----
 3 files changed, 20 insertions(+), 11 deletions(-)

diff --git a/Doc/Manual/Varargs.html b/Doc/Manual/Varargs.html
index ed52001e8..c27db603d 100644
--- a/Doc/Manual/Varargs.html
+++ b/Doc/Manual/Varargs.html
@@ -381,6 +381,26 @@ a call from the target language which does not provide the maximum number of arg
 will generate C code which includes the missing default values, that is, <tt>execlp("a", "b", "c", NULL, NULL)</tt>. 
 If <tt>compactdefaultargs</tt> is not used, then the generated code will be
 <tt>execlp("a", "b", "c")</tt>. The former is useful for helping providing a sentinel to terminate the argument list.
+However, this is not guaranteed, for example when a user passes a non-NULL value for all the parameters.
+When using <tt>compactdefaultargs</tt> it is possible to guarantee the NULL sentinel is passed through the, 
+<tt>numinputs=0</tt> <a href="Typemaps.html#Typemaps_nn26">'in' typemap attribute</a>, naming the <b>last parameter</b>.
+For example,
+</p>
+
+<div class="code">
+<pre>
+%feature("compactdefaultargs") execlp;
+%varargs(3, char *str = NULL) execlp;
+%typemap(in, numinputs=0) char *str3 ""
+...
+int execlp(const char *path, const char *arg, ...);
+</pre>
+</div>
+
+<p>
+Note that <tt>str3</tt> is the name of the last argument, as we have used <tt>%vargars</tt> with 3.
+Now <tt>execlp("a", "b", "c", "d", "e")</tt> will result in an error as one too many arguments has been passed,
+as now only 2 additional 'str' arguments can be passed with the 3rd one always using the specified default <tt>NULL</tt>.
 </p>
 
 <p>
diff --git a/Lib/swig.swg b/Lib/swig.swg
index e7c01823e..a6fef0257 100644
--- a/Lib/swig.swg
+++ b/Lib/swig.swg
@@ -500,12 +500,6 @@ namespace std {
   }
 }
 
-/* Typemap for variable length arguments sentinel value.  Used
-   by the %varargs directive. */
-
-%typemap(in,numinputs=0) SWIGTYPE *VARARGS_SENTINEL, SWIGTYPE VARARGS_SENTINEL "";
-
-
 /* -----------------------------------------------------------------------------
  * Overloading support
  * ----------------------------------------------------------------------------- */
diff --git a/Lib/typemaps/swigtype.swg b/Lib/typemaps/swigtype.swg
index bd113e278..47baabf52 100644
--- a/Lib/typemaps/swigtype.swg
+++ b/Lib/typemaps/swigtype.swg
@@ -559,11 +559,6 @@
  * --- Special typemaps ---
  * ------------------------------------------------------------ */
 
-/* VARARGS_SENTINEL typemap. Used by the %varargs directive. */
-
-%typemap(in,numinputs=0) SWIGTYPE *VARARGS_SENTINEL, SWIGTYPE VARARGS_SENTINEL "";
-
-
 /* DISOWN typemap */
 
 %typemap(in, noblock=1) SWIGTYPE *DISOWN (int res = 0) {