Add a test for #16431, and document Dave's campaign

[perl5.git] / XSUB.h

diff --git a/XSUB.h b/XSUB.h
index 23f292b..2bd681c 100644 (file)
--- a/XSUB.h
+++ b/XSUB.h
@@ -1,9 +1,20 @@
+/*    XSUB.h
+ *
+ *    Copyright (c) 1997-2002, Larry Wall
+ *
+ *    You may distribute under the terms of either the GNU General Public
+ *    License or the Artistic License, as specified in the README file.
+ *
+ */
+
 #ifndef _INC_PERL_XSUB_H
 #define _INC_PERL_XSUB_H 1
 
 /* first, some documentation for xsubpp-generated items */
 
 /*
+=head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
+
 =for apidoc Amn|char*|CLASS
 Variable which is setup by C<xsubpp> to indicate the 
 class name for a C++ XS constructor.  This is always a C<char*>.  See C<THIS>.
@@ -61,9 +72,9 @@ handled automatically by C<xsubpp>.
 #define ST(off) PL_stack_base[ax + (off)]
 
 #if defined(__CYGWIN__) && defined(USE_DYNAMIC_LOADING)
-#  define XS(name) __declspec(dllexport) void name(pTHXo_ CV* cv)
+#  define XS(name) __declspec(dllexport) void name(pTHX_ CV* cv)
 #else
-#  define XS(name) void name(pTHXo_ CV* cv)
+#  define XS(name) void name(pTHX_ CV* cv)
 #endif
 
 #define dAX I32 ax = MARK - PL_stack_base + 1
@@ -92,12 +103,14 @@ handled automatically by C<xsubpp>.
 #define dXSFUNCTION(ret)               XSINTERFACE_CVT(ret,XSFUNCTION)
 #define XSINTERFACE_FUNC(ret,cv,f)     ((XSINTERFACE_CVT(ret,))(f))
 #define XSINTERFACE_FUNC_SET(cv,f)     \
-               CvXSUBANY(cv).any_dptr = (void (*) (pTHXo_ void*))(f)
+               CvXSUBANY(cv).any_dptr = (void (*) (pTHX_ void*))(f)
 
 /* Simple macros to put new mortal values onto the stack.   */
 /* Typically used to return values from XS functions.       */
 
 /*
+=head1 Stack Manipulation Macros
+
 =for apidoc Am|void|XST_mIV|int pos|IV iv
 Place an integer into the specified position C<pos> on the stack.  The
 value is stored in a new mortal SV.
@@ -130,7 +143,7 @@ handled by C<xsubpp>.
 Return an integer from an XSUB immediately.  Uses C<XST_mIV>.
 
 =for apidoc Am|void|XSRETURN_NV|NV nv
-Return an double from an XSUB immediately.  Uses C<XST_mNV>.
+Return a double from an XSUB immediately.  Uses C<XST_mNV>.
 
 =for apidoc Am|void|XSRETURN_PV|char* str
 Return a copy of a string from an XSUB immediately.  Uses C<XST_mPV>.
@@ -147,6 +160,8 @@ Return C<&PL_sv_undef> from an XSUB immediately.  Uses C<XST_mUNDEF>.
 =for apidoc Ams||XSRETURN_EMPTY
 Return an empty list from an XSUB immediately.
 
+=head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
+
 =for apidoc AmU||newXSproto
 Used by C<xsubpp> to hook up XSUBs as Perl subs.  Adds Perl prototypes to
 the subs.
@@ -247,7 +262,6 @@ C<xsubpp>.  See L<perlxs/"The VERSIONCHECK: Keyword">.
 #endif
 
 #include "perlapi.h"
-#include "objXSUB.h"
 
 #if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_NO_GET_CONTEXT) && !defined(PERL_CORE)
 #  undef aTHX
@@ -256,7 +270,7 @@ C<xsubpp>.  See L<perlxs/"The VERSIONCHECK: Keyword">.
 #  define aTHX_                aTHX,
 #endif
 
-#if (defined(PERL_CAPI) || defined(PERL_IMPLICIT_SYS)) && !defined(PERL_CORE)
+#if defined(PERL_IMPLICIT_SYS) && !defined(PERL_CORE)
 #  ifndef NO_XSLOCKS
 # if defined (NETWARE) && defined (USE_STDIO)
 #    define times              PerlProc_times
@@ -282,7 +296,7 @@ C<xsubpp>.  See L<perlxs/"The VERSIONCHECK: Keyword">.
 #    undef ungetc
 #    undef fileno
 
-//Following symbols were giving redefinition errors while building extensions - sgp 17th Oct 2000
+/* Following symbols were giving redefinition errors while building extensions - sgp 17th Oct 2000 */
 #ifdef NETWARE
 #      undef readdir
 #      undef fstat
@@ -311,6 +325,8 @@ C<xsubpp>.  See L<perlxs/"The VERSIONCHECK: Keyword">.
 #      undef setservent
 #endif /* NETWARE */
 
+#    undef  socketpair
+
 #    define mkdir              PerlDir_mkdir
 #    define chdir              PerlDir_chdir
 #    define rmdir              PerlDir_rmdir
@@ -323,9 +339,9 @@ C<xsubpp>.  See L<perlxs/"The VERSIONCHECK: Keyword">.
 #    define putenv             PerlEnv_putenv
 #    define getenv             PerlEnv_getenv
 #    define uname              PerlEnv_uname
-#    define stdin              PerlIO_stdin()
-#    define stdout             PerlIO_stdout()
-#    define stderr             PerlIO_stderr()
+#    define stdin              PerlSIO_stdin()
+#    define stdout             PerlSIO_stdout()
+#    define stderr             PerlSIO_stderr()
 #    define fopen              PerlIO_open
 #    define fclose             PerlIO_close
 #    define feof               PerlIO_eof
@@ -341,9 +357,9 @@ C<xsubpp>.  See L<perlxs/"The VERSIONCHECK: Keyword">.
 #    define freopen            PerlIO_reopen
 #    define fread(b,s,c,f)     PerlIO_read((f),(b),(s*c))
 #    define fwrite(b,s,c,f)    PerlIO_write((f),(b),(s*c))
-#    define setbuf             PerlIO_setbuf
-#    define setvbuf            PerlIO_setvbuf
-#    define setlinebuf         PerlIO_setlinebuf
+#    define setbuf             PerlSIO_setbuf
+#    define setvbuf            PerlSIO_setvbuf
+#    define setlinebuf         PerlSIO_setlinebuf
 #    define stdoutf            PerlIO_stdoutf
 #    define vfprintf           PerlIO_vprintf
 #    define ftell              PerlIO_tell
@@ -450,6 +466,6 @@ C<xsubpp>.  See L<perlxs/"The VERSIONCHECK: Keyword">.
 #    define socketpair         PerlSock_socketpair
 #      endif   /* NETWARE && USE_STDIO */
 #  endif  /* NO_XSLOCKS */
-#endif  /* PERL_CAPI */
+#endif  /* PERL_IMPLICIT_SYS && !PERL_CORE */
 
 #endif /* _INC_PERL_XSUB_H */          /* include guard */