This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perlapi: XS, XS_EXTERNAL do take a parameter
[perl5.git] / XSUB.h
CommitLineData
eb1102fc
NIS
1/* XSUB.h
2 *
699a97de 3 * Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
1129b882 4 * 2003, 2004, 2005, 2006, 2007, 2008 by Larry Wall and others
eb1102fc
NIS
5 *
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
8 *
9 */
10
6a5bc5ac
KW
11#ifndef PERL_XSUB_H_
12#define PERL_XSUB_H_ 1
b4ba0ab9 13
954c1994
GS
14/* first, some documentation for xsubpp-generated items */
15
16/*
51b56f5c 17=for apidoc_section XS
ccfc67b7 18
954c1994
GS
19=for apidoc Amn|char*|CLASS
20Variable which is setup by C<xsubpp> to indicate the
fbe13c60
KW
21class name for a C++ XS constructor. This is always a C<char*>. See
22C<L</THIS>>.
954c1994
GS
23
24=for apidoc Amn|(whatever)|RETVAL
25Variable which is setup by C<xsubpp> to hold the return value for an
72d33970 26XSUB. This is always the proper type for the XSUB. See
954c1994
GS
27L<perlxs/"The RETVAL Variable">.
28
29=for apidoc Amn|(whatever)|THIS
30Variable which is setup by C<xsubpp> to designate the object in a C++
fbe13c60 31XSUB. This is always the proper type for the C++ object. See C<L</CLASS>> and
954c1994
GS
32L<perlxs/"Using XS With C++">.
33
9f2ea798
DM
34=for apidoc Amn|I32|ax
35Variable which is setup by C<xsubpp> to indicate the stack base offset,
36used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
37must be called prior to setup the C<MARK> variable.
38
954c1994
GS
39=for apidoc Amn|I32|items
40Variable which is setup by C<xsubpp> to indicate the number of
41items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
42
43=for apidoc Amn|I32|ix
44Variable which is setup by C<xsubpp> to indicate which of an
45XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
46
47=for apidoc Am|SV*|ST|int ix
48Used to access elements on the XSUB's stack.
49
eeac5808 50=for apidoc AmU||XS
954c1994 51Macro to declare an XSUB and its C parameter list. This is handled by
796b6530 52C<xsubpp>. It is the same as using the more explicit C<XS_EXTERNAL> macro.
954c1994 53
e64345f8
SM
54=for apidoc AmU||XS_INTERNAL
55Macro to declare an XSUB and its C parameter list without exporting the symbols.
56This is handled by C<xsubpp> and generally preferable over exporting the XSUB
0cb93b3a 57symbols unnecessarily.
e64345f8 58
eeac5808 59=for apidoc AmU||XS_EXTERNAL
e64345f8 60Macro to declare an XSUB and its C parameter list explicitly exporting the symbols.
e64345f8 61
4e5171e9 62=for apidoc Amns||dAX
9f2ea798
DM
63Sets up the C<ax> variable.
64This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
65
4e5171e9 66=for apidoc Amns||dAXMARK
557b887a
SS
67Sets up the C<ax> variable and stack marker variable C<mark>.
68This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
69
4e5171e9 70=for apidoc Amns||dITEMS
9f2ea798
DM
71Sets up the C<items> variable.
72This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
73
4e5171e9 74=for apidoc Amns||dXSARGS
796b6530 75Sets up stack and mark pointers for an XSUB, calling C<dSP> and C<dMARK>.
9f2ea798
DM
76Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
77This is usually handled automatically by C<xsubpp>.
954c1994 78
4e5171e9 79=for apidoc Amns||dXSI32
954c1994
GS
80Sets up the C<ix> variable for an XSUB which has aliases. This is usually
81handled automatically by C<xsubpp>.
82
4e5171e9 83=for apidoc Amns||dUNDERBAR
72d33970
FC
84Sets up any variable needed by the C<UNDERBAR> macro. It used to define
85C<padoff_du>, but it is currently a noop. However, it is strongly advised
483ce06a 86to still use it for ensuring past and future compatibility.
88037a85 87
78342678 88=for apidoc AmnU||UNDERBAR
796b6530
KW
89The SV* corresponding to the C<$_> variable. Works even if there
90is a lexical C<$_> in scope.
88037a85 91
954c1994
GS
92=cut
93*/
94
53c1dcc0 95#ifndef PERL_UNUSED_ARG
c707756e 96# define PERL_UNUSED_ARG(x) ((void)x)
ad73156c 97#endif
53c1dcc0
AL
98#ifndef PERL_UNUSED_VAR
99# define PERL_UNUSED_VAR(x) ((void)x)
100#endif
ad73156c 101
3280af22 102#define ST(off) PL_stack_base[ax + (off)]
a0d0e21e 103
081304ca
AMS
104/* XSPROTO() is also used by SWIG like this:
105 *
106 * typedef XSPROTO(SwigPerlWrapper);
107 * typedef SwigPerlWrapper *SwigPerlWrapperPtr;
108 *
109 * This code needs to be compilable under both C and C++.
110 *
111 * Don't forget to change the __attribute__unused__ version of XS()
112 * below too if you change XSPROTO() here.
113 */
e64345f8 114
ab1478f7
SM
115/* XS_INTERNAL is the explicit static-linkage variant of the default
116 * XS macro.
e64345f8 117 *
ab1478f7
SM
118 * XS_EXTERNAL is the same as XS_INTERNAL except it does not include
119 * "STATIC", ie. it exports XSUB symbols. You probably don't want that.
e64345f8
SM
120 */
121
53dfb2b7 122#define XSPROTO(name) void name(pTHX_ CV* cv __attribute__unused__)
081304ca 123
27da23d5 124#undef XS
e64345f8
SM
125#undef XS_EXTERNAL
126#undef XS_INTERNAL
d308986b 127#if defined(__CYGWIN__) && defined(USE_DYNAMIC_LOADING)
ab1478f7 128# define XS_EXTERNAL(name) __declspec(dllexport) XSPROTO(name)
fe6ca737 129# define XS_INTERNAL(name) STATIC XSPROTO(name)
f12ee906
AC
130#elif defined(__cplusplus)
131# define XS_EXTERNAL(name) extern "C" XSPROTO(name)
132# define XS_INTERNAL(name) static XSPROTO(name)
133#elif defined(HASATTRIBUTE_UNUSED)
134# define XS_EXTERNAL(name) void name(pTHX_ CV* cv __attribute__unused__)
135# define XS_INTERNAL(name) STATIC void name(pTHX_ CV* cv __attribute__unused__)
136#else
137# define XS_EXTERNAL(name) XSPROTO(name)
138# define XS_INTERNAL(name) STATIC XSPROTO(name)
a0d0e21e
LW
139#endif
140
0cb93b3a
SM
141/* We do export xsub symbols by default for the public XS macro.
142 * Try explicitly using XS_INTERNAL/XS_EXTERNAL instead, please. */
143#define XS(name) XS_EXTERNAL(name)
e64345f8 144
514696af 145#define dAX const I32 ax = (I32)(MARK - PL_stack_base + 1)
9f2ea798 146
557b887a 147#define dAXMARK \
a3b680e6 148 I32 ax = POPMARK; \
eb578fdb 149 SV **mark = PL_stack_base + ax++
557b887a 150
514696af 151#define dITEMS I32 items = (I32)(SP - MARK)
9f2ea798 152
c707756e 153#define dXSARGS \
557b887a 154 dSP; dAXMARK; dITEMS
9a189793
DD
155/* These 3 macros are replacements for dXSARGS macro only in bootstrap.
156 They factor out common code in every BOOT XSUB. Computation of vars mark
157 and items will optimize away in most BOOT functions. Var ax can never be
158 optimized away since BOOT must return &PL_sv_yes by default from xsubpp.
159 Note these macros are not drop in replacements for dXSARGS since they set
160 PL_xsubfilename. */
c707756e 161#define dXSBOOTARGSXSAPIVERCHK \
9a189793 162 I32 ax = XS_BOTHVERSION_SETXSUBFN_POPMARK_BOOTCHECK; \
31346494 163 SV **mark = PL_stack_base + ax - 1; dSP; dITEMS
c707756e 164#define dXSBOOTARGSAPIVERCHK \
9a189793 165 I32 ax = XS_APIVERSION_SETXSUBFN_POPMARK_BOOTCHECK; \
31346494 166 SV **mark = PL_stack_base + ax - 1; dSP; dITEMS
9a189793
DD
167/* dXSBOOTARGSNOVERCHK has no API in xsubpp to choose it so do
168#undef dXSBOOTARGSXSAPIVERCHK
169#define dXSBOOTARGSXSAPIVERCHK dXSBOOTARGSNOVERCHK */
c707756e 170#define dXSBOOTARGSNOVERCHK \
9a189793 171 I32 ax = XS_SETXSUBFN_POPMARK; \
31346494 172 SV **mark = PL_stack_base + ax - 1; dSP; dITEMS
a0d0e21e 173
a3b680e6 174#define dXSTARG SV * const targ = ((PL_op->op_private & OPpENTERSUB_HASTARG) \
8a7fc0dc
GS
175 ? PAD_SV(PL_op->op_targ) : sv_newmortal())
176
b26a54d0
GS
177/* Should be used before final PUSHi etc. if not in PPCODE section. */
178#define XSprePUSH (sp = PL_stack_base + ax - 1)
179
a0d0e21e
LW
180#define XSANY CvXSUBANY(cv)
181
182#define dXSI32 I32 ix = XSANY.any_i32
183
cfc02341
IZ
184#ifdef __cplusplus
185# define XSINTERFACE_CVT(ret,name) ret (*name)(...)
4ef0c66e 186# define XSINTERFACE_CVT_ANON(ret) ret (*)(...)
cfc02341
IZ
187#else
188# define XSINTERFACE_CVT(ret,name) ret (*name)()
4ef0c66e 189# define XSINTERFACE_CVT_ANON(ret) ret (*)()
cfc02341
IZ
190#endif
191#define dXSFUNCTION(ret) XSINTERFACE_CVT(ret,XSFUNCTION)
4ef0c66e 192#define XSINTERFACE_FUNC(ret,cv,f) ((XSINTERFACE_CVT_ANON(ret))(f))
cfc02341 193#define XSINTERFACE_FUNC_SET(cv,f) \
a12c3db7 194 CvXSUBANY(cv).any_dxptr = (void (*) (pTHX_ void*))(f)
cfc02341 195
483ce06a
VP
196#define dUNDERBAR dNOOP
197#define UNDERBAR find_rundefsv()
88037a85 198
748a9306
LW
199/* Simple macros to put new mortal values onto the stack. */
200/* Typically used to return values from XS functions. */
954c1994
GS
201
202/*
70b05c7c 203=for apidoc_section Stack Manipulation Macros
ccfc67b7 204
954c1994
GS
205=for apidoc Am|void|XST_mIV|int pos|IV iv
206Place an integer into the specified position C<pos> on the stack. The
207value is stored in a new mortal SV.
208
209=for apidoc Am|void|XST_mNV|int pos|NV nv
210Place a double into the specified position C<pos> on the stack. The value
211is stored in a new mortal SV.
212
213=for apidoc Am|void|XST_mPV|int pos|char* str
214Place a copy of a string into the specified position C<pos> on the stack.
215The value is stored in a new mortal SV.
216
022f6832
KW
217=for apidoc Am|void|XST_mUV|int pos|UV uv
218Place an unsigned integer into the specified position C<pos> on the stack. The
219value is stored in a new mortal SV.
220
954c1994
GS
221=for apidoc Am|void|XST_mNO|int pos
222Place C<&PL_sv_no> into the specified position C<pos> on the
223stack.
224
225=for apidoc Am|void|XST_mYES|int pos
226Place C<&PL_sv_yes> into the specified position C<pos> on the
227stack.
228
229=for apidoc Am|void|XST_mUNDEF|int pos
230Place C<&PL_sv_undef> into the specified position C<pos> on the
231stack.
232
233=for apidoc Am|void|XSRETURN|int nitems
234Return from XSUB, indicating number of items on the stack. This is usually
235handled by C<xsubpp>.
236
237=for apidoc Am|void|XSRETURN_IV|IV iv
238Return an integer from an XSUB immediately. Uses C<XST_mIV>.
239
108ccc45
JH
240=for apidoc Am|void|XSRETURN_UV|IV uv
241Return an integer from an XSUB immediately. Uses C<XST_mUV>.
242
954c1994 243=for apidoc Am|void|XSRETURN_NV|NV nv
d1be9408 244Return a double from an XSUB immediately. Uses C<XST_mNV>.
954c1994
GS
245
246=for apidoc Am|void|XSRETURN_PV|char* str
247Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
248
4e5171e9 249=for apidoc Amns||XSRETURN_NO
954c1994
GS
250Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
251
4e5171e9 252=for apidoc Amns||XSRETURN_YES
954c1994
GS
253Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
254
4e5171e9 255=for apidoc Amns||XSRETURN_UNDEF
954c1994
GS
256Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
257
4e5171e9 258=for apidoc Amns||XSRETURN_EMPTY
954c1994
GS
259Return an empty list from an XSUB immediately.
260
c578083c 261=for apidoc AmU||newXSproto|char* name|XSUBADDR_t f|char* filename|const char *proto
954c1994
GS
262Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
263the subs.
264
78342678 265=for apidoc AmnU||XS_VERSION
954c1994 266The version identifier for an XS module. This is usually
fbe13c60
KW
267handled automatically by C<ExtUtils::MakeMaker>. See
268C<L</XS_VERSION_BOOTCHECK>>.
954c1994 269
4e5171e9 270=for apidoc Amns||XS_VERSION_BOOTCHECK
796b6530 271Macro to verify that a PM module's C<$VERSION> variable matches the XS
954c1994
GS
272module's C<XS_VERSION> variable. This is usually handled automatically by
273C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
274
4e5171e9 275=for apidoc Amns||XS_APIVERSION_BOOTCHECK
1e8125c6
FR
276Macro to verify that the perl api version an XS module has been compiled against
277matches the api version of the perl interpreter it's being loaded into.
278
70b05c7c 279=for apidoc_section Exception Handling (simple) Macros
0ca3a874 280
4e5171e9 281=for apidoc Amns||dXCPT
2dfe1b17 282Set up necessary local variables for exception handling.
0ca3a874
MHM
283See L<perlguts/"Exception Handling">.
284
78342678 285=for apidoc AmnU||XCPT_TRY_START
0ca3a874
MHM
286Starts a try block. See L<perlguts/"Exception Handling">.
287
78342678 288=for apidoc AmnU||XCPT_TRY_END
0ca3a874
MHM
289Ends a try block. See L<perlguts/"Exception Handling">.
290
78342678 291=for apidoc AmnU||XCPT_CATCH
0ca3a874
MHM
292Introduces a catch block. See L<perlguts/"Exception Handling">.
293
4e5171e9 294=for apidoc Amns||XCPT_RETHROW
0ca3a874
MHM
295Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
296
954c1994
GS
297=cut
298*/
299
4633a7c4 300#define XST_mIV(i,v) (ST(i) = sv_2mortal(newSViv(v)) )
108ccc45 301#define XST_mUV(i,v) (ST(i) = sv_2mortal(newSVuv(v)) )
4633a7c4
LW
302#define XST_mNV(i,v) (ST(i) = sv_2mortal(newSVnv(v)) )
303#define XST_mPV(i,v) (ST(i) = sv_2mortal(newSVpv(v,0)))
ad25789c 304#define XST_mPVN(i,v,n) (ST(i) = newSVpvn_flags(v,n, SVs_TEMP))
3280af22
NIS
305#define XST_mNO(i) (ST(i) = &PL_sv_no )
306#define XST_mYES(i) (ST(i) = &PL_sv_yes )
307#define XST_mUNDEF(i) (ST(i) = &PL_sv_undef)
954c1994
GS
308
309#define XSRETURN(off) \
310 STMT_START { \
61f9802b 311 const IV tmpXSoff = (off); \
9e77582c 312 assert(tmpXSoff >= 0);\
a02b2239 313 PL_stack_sp = PL_stack_base + ax + (tmpXSoff - 1); \
954c1994
GS
314 return; \
315 } STMT_END
316
80b92232 317#define XSRETURN_IV(v) STMT_START { XST_mIV(0,v); XSRETURN(1); } STMT_END
108ccc45 318#define XSRETURN_UV(v) STMT_START { XST_mUV(0,v); XSRETURN(1); } STMT_END
80b92232
PP
319#define XSRETURN_NV(v) STMT_START { XST_mNV(0,v); XSRETURN(1); } STMT_END
320#define XSRETURN_PV(v) STMT_START { XST_mPV(0,v); XSRETURN(1); } STMT_END
954c1994 321#define XSRETURN_PVN(v,n) STMT_START { XST_mPVN(0,v,n); XSRETURN(1); } STMT_END
80b92232
PP
322#define XSRETURN_NO STMT_START { XST_mNO(0); XSRETURN(1); } STMT_END
323#define XSRETURN_YES STMT_START { XST_mYES(0); XSRETURN(1); } STMT_END
324#define XSRETURN_UNDEF STMT_START { XST_mUNDEF(0); XSRETURN(1); } STMT_END
325#define XSRETURN_EMPTY STMT_START { XSRETURN(0); } STMT_END
382b8d97 326
77004dee 327#define newXSproto(a,b,c,d) newXS_flags(a,b,c,d,0)
720fb644
PP
328
329#ifdef XS_VERSION
ddb5125f 330# define XS_VERSION_BOOTCHECK \
9a189793
DD
331 Perl_xs_handshake(HS_KEY(FALSE, FALSE, "", XS_VERSION), HS_CXT, __FILE__, \
332 items, ax, XS_VERSION)
720fb644 333#else
c6af7a1a 334# define XS_VERSION_BOOTCHECK
720fb644 335#endif
76e3520e 336
1e8125c6 337#define XS_APIVERSION_BOOTCHECK \
9a189793
DD
338 Perl_xs_handshake(HS_KEY(FALSE, FALSE, "v" PERL_API_VERSION_STRING, ""), \
339 HS_CXT, __FILE__, items, ax, "v" PERL_API_VERSION_STRING)
db6e00bd
DD
340/* public API, this is a combination of XS_VERSION_BOOTCHECK and
341 XS_APIVERSION_BOOTCHECK in 1, and is backportable */
342#ifdef XS_VERSION
343# define XS_BOTHVERSION_BOOTCHECK \
9a189793
DD
344 Perl_xs_handshake(HS_KEY(FALSE, FALSE, "v" PERL_API_VERSION_STRING, XS_VERSION), \
345 HS_CXT, __FILE__, items, ax, "v" PERL_API_VERSION_STRING, XS_VERSION)
db6e00bd
DD
346#else
347/* should this be a #error? if you want both checked, you better supply XS_VERSION right? */
348# define XS_BOTHVERSION_BOOTCHECK XS_APIVERSION_BOOTCHECK
349#endif
350
351/* private API */
9a189793
DD
352#define XS_APIVERSION_POPMARK_BOOTCHECK \
353 Perl_xs_handshake(HS_KEY(FALSE, TRUE, "v" PERL_API_VERSION_STRING, ""), \
354 HS_CXT, __FILE__, "v" PERL_API_VERSION_STRING)
db6e00bd
DD
355#ifdef XS_VERSION
356# define XS_BOTHVERSION_POPMARK_BOOTCHECK \
9a189793
DD
357 Perl_xs_handshake(HS_KEY(FALSE, TRUE, "v" PERL_API_VERSION_STRING, XS_VERSION), \
358 HS_CXT, __FILE__, "v" PERL_API_VERSION_STRING, XS_VERSION)
db6e00bd
DD
359#else
360/* should this be a #error? if you want both checked, you better supply XS_VERSION right? */
361# define XS_BOTHVERSION_POPMARK_BOOTCHECK XS_APIVERSION_POPMARK_BOOTCHECK
362#endif
1e8125c6 363
9a189793
DD
364#define XS_APIVERSION_SETXSUBFN_POPMARK_BOOTCHECK \
365 Perl_xs_handshake(HS_KEY(TRUE, TRUE, "v" PERL_API_VERSION_STRING, ""), \
366 HS_CXT, __FILE__, "v" PERL_API_VERSION_STRING)
367#ifdef XS_VERSION
368# define XS_BOTHVERSION_SETXSUBFN_POPMARK_BOOTCHECK \
369 Perl_xs_handshake(HS_KEY(TRUE, TRUE, "v" PERL_API_VERSION_STRING, XS_VERSION),\
370 HS_CXT, __FILE__, "v" PERL_API_VERSION_STRING, XS_VERSION)
371#else
372/* should this be a #error? if you want both checked, you better supply XS_VERSION right? */
373# define XS_BOTHVERSION_SETXSUBFN_POPMARK_BOOTCHECK XS_APIVERSION_SETXSUBFN_POPMARK_BOOTCHECK
374#endif
375
376/* For a normal bootstrap without API or XS version checking.
377 Useful for static XS modules or debugging/testing scenarios.
378 If this macro gets heavily used in the future, it should separated into
379 a separate function independent of Perl_xs_handshake for efficiency */
380#define XS_SETXSUBFN_POPMARK \
381 Perl_xs_handshake(HS_KEY(TRUE, TRUE, "", "") | HSf_NOCHK, HS_CXT, __FILE__)
382
9b5c3821
MHM
383#ifdef NO_XSLOCKS
384# define dXCPT dJMPENV; int rEtV = 0
385# define XCPT_TRY_START JMPENV_PUSH(rEtV); if (rEtV == 0)
386# define XCPT_TRY_END JMPENV_POP;
387# define XCPT_CATCH if (rEtV != 0)
388# define XCPT_RETHROW JMPENV_JUMP(rEtV)
389#endif
0ca3a874 390
1e8125c6
FR
391/*
392 The DBM_setFilter & DBM_ckFilter macros are only used by
393 the *DB*_File modules
6a31061a
PM
394*/
395
396#define DBM_setFilter(db_type,code) \
891c2e08 397 STMT_START { \
6a31061a
PM
398 if (db_type) \
399 RETVAL = sv_mortalcopy(db_type) ; \
400 ST(0) = RETVAL ; \
401 if (db_type && (code == &PL_sv_undef)) { \
1cbe4e6f 402 SvREFCNT_dec_NN(db_type) ; \
6a31061a
PM
403 db_type = NULL ; \
404 } \
405 else if (code) { \
406 if (db_type) \
407 sv_setsv(db_type, code) ; \
408 else \
409 db_type = newSVsv(code) ; \
410 } \
891c2e08 411 } STMT_END
6a31061a
PM
412
413#define DBM_ckFilter(arg,type,name) \
891c2e08 414 STMT_START { \
6a31061a
PM
415 if (db->type) { \
416 if (db->filtering) { \
417 croak("recursion detected in %s", name) ; \
418 } \
419 ENTER ; \
420 SAVETMPS ; \
421 SAVEINT(db->filtering) ; \
422 db->filtering = TRUE ; \
414bf5ae 423 SAVE_DEFSV ; \
5bbd4290
PM
424 if (name[7] == 's') \
425 arg = newSVsv(arg); \
414bf5ae 426 DEFSV_set(arg) ; \
6a31061a
PM
427 SvTEMP_off(arg) ; \
428 PUSHMARK(SP) ; \
429 PUTBACK ; \
430 (void) perl_call_sv(db->type, G_DISCARD); \
431 SPAGAIN ; \
432 PUTBACK ; \
433 FREETMPS ; \
434 LEAVE ; \
5bbd4290
PM
435 if (name[7] == 's'){ \
436 arg = sv_2mortal(arg); \
437 } \
891c2e08 438 } } STMT_END
6a31061a 439
51371543 440#if 1 /* for compatibility */
dc9e4912
GS
441# define VTBL_sv &PL_vtbl_sv
442# define VTBL_env &PL_vtbl_env
443# define VTBL_envelem &PL_vtbl_envelem
dc9e4912
GS
444# define VTBL_sigelem &PL_vtbl_sigelem
445# define VTBL_pack &PL_vtbl_pack
446# define VTBL_packelem &PL_vtbl_packelem
447# define VTBL_dbline &PL_vtbl_dbline
448# define VTBL_isa &PL_vtbl_isa
449# define VTBL_isaelem &PL_vtbl_isaelem
450# define VTBL_arylen &PL_vtbl_arylen
c696a6a4 451# define VTBL_glob &PL_vtbl_glob
dc9e4912
GS
452# define VTBL_mglob &PL_vtbl_mglob
453# define VTBL_nkeys &PL_vtbl_nkeys
454# define VTBL_taint &PL_vtbl_taint
455# define VTBL_substr &PL_vtbl_substr
456# define VTBL_vec &PL_vtbl_vec
457# define VTBL_pos &PL_vtbl_pos
458# define VTBL_bm &PL_vtbl_bm
459# define VTBL_fm &PL_vtbl_fm
460# define VTBL_uvar &PL_vtbl_uvar
461# define VTBL_defelem &PL_vtbl_defelem
462# define VTBL_regexp &PL_vtbl_regexp
463# define VTBL_regdata &PL_vtbl_regdata
464# define VTBL_regdatum &PL_vtbl_regdatum
465# ifdef USE_LOCALE_COLLATE
466# define VTBL_collxfrm &PL_vtbl_collxfrm
467# endif
9e7bc3e8
JD
468# define VTBL_amagic &PL_vtbl_amagic
469# define VTBL_amagicelem &PL_vtbl_amagicelem
dc9e4912
GS
470#endif
471
e8ee3774 472#if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_NO_GET_CONTEXT) && !defined(PERL_CORE)
c5be433b
GS
473# undef aTHX
474# undef aTHX_
54aff467
GS
475# define aTHX PERL_GET_THX
476# define aTHX_ aTHX,
54aff467
GS
477#endif
478
acfe0abc 479#if defined(PERL_IMPLICIT_SYS) && !defined(PERL_CORE)
c6af7a1a 480# ifndef NO_XSLOCKS
2986a63f
JH
481# if defined (NETWARE) && defined (USE_STDIO)
482# define times PerlProc_times
483# define setuid PerlProc_setuid
484# define setgid PerlProc_setgid
485# define getpid PerlProc_getpid
486# define pause PerlProc_pause
487# define exit PerlProc_exit
488# define _exit PerlProc__exit
489# else
c6af7a1a
GS
490# undef closedir
491# undef opendir
492# undef stdin
493# undef stdout
494# undef stderr
495# undef feof
496# undef ferror
497# undef fgetpos
498# undef ioctl
499# undef getlogin
500# undef setjmp
501# undef getc
502# undef ungetc
503# undef fileno
504
cb69f87a 505/* Following symbols were giving redefinition errors while building extensions - sgp 17th Oct 2000 */
2986a63f
JH
506#ifdef NETWARE
507# undef readdir
508# undef fstat
509# undef stat
510# undef longjmp
511# undef endhostent
512# undef endnetent
513# undef endprotoent
514# undef endservent
515# undef gethostbyaddr
516# undef gethostbyname
517# undef gethostent
518# undef getnetbyaddr
519# undef getnetbyname
520# undef getnetent
521# undef getprotobyname
522# undef getprotobynumber
523# undef getprotoent
524# undef getservbyname
525# undef getservbyport
526# undef getservent
527# undef inet_ntoa
528# undef sethostent
529# undef setnetent
530# undef setprotoent
531# undef setservent
532#endif /* NETWARE */
533
fa58a56f
S
534/* to avoid warnings: "xyz" redefined */
535#ifdef WIN32
536# undef popen
537# undef pclose
538#endif /* WIN32 */
539
1018e26f
NIS
540# undef socketpair
541
c6af7a1a
GS
542# define mkdir PerlDir_mkdir
543# define chdir PerlDir_chdir
544# define rmdir PerlDir_rmdir
545# define closedir PerlDir_close
546# define opendir PerlDir_open
547# define readdir PerlDir_read
548# define rewinddir PerlDir_rewind
549# define seekdir PerlDir_seek
550# define telldir PerlDir_tell
551# define putenv PerlEnv_putenv
552# define getenv PerlEnv_getenv
b2af26b1 553# define uname PerlEnv_uname
197357d0
GS
554# define stdin PerlSIO_stdin
555# define stdout PerlSIO_stdout
556# define stderr PerlSIO_stderr
f9415d23
NIS
557# define fopen PerlSIO_fopen
558# define fclose PerlSIO_fclose
559# define feof PerlSIO_feof
560# define ferror PerlSIO_ferror
b6d726d6 561# define clearerr PerlSIO_clearerr
f9415d23 562# define getc PerlSIO_getc
20c8f8f9 563# define fgets PerlSIO_fgets
f9415d23
NIS
564# define fputc PerlSIO_fputc
565# define fputs PerlSIO_fputs
566# define fflush PerlSIO_fflush
567# define ungetc PerlSIO_ungetc
568# define fileno PerlSIO_fileno
569# define fdopen PerlSIO_fdopen
570# define freopen PerlSIO_freopen
571# define fread PerlSIO_fread
572# define fwrite PerlSIO_fwrite
22a46b6e
NIS
573# define setbuf PerlSIO_setbuf
574# define setvbuf PerlSIO_setvbuf
575# define setlinebuf PerlSIO_setlinebuf
1f59ddd9
GS
576# define stdoutf PerlSIO_stdoutf
577# define vfprintf PerlSIO_vprintf
f9415d23
NIS
578# define ftell PerlSIO_ftell
579# define fseek PerlSIO_fseek
580# define fgetpos PerlSIO_fgetpos
581# define fsetpos PerlSIO_fsetpos
582# define frewind PerlSIO_rewind
583# define tmpfile PerlSIO_tmpfile
c6af7a1a
GS
584# define access PerlLIO_access
585# define chmod PerlLIO_chmod
586# define chsize PerlLIO_chsize
587# define close PerlLIO_close
588# define dup PerlLIO_dup
589# define dup2 PerlLIO_dup2
590# define flock PerlLIO_flock
591# define fstat PerlLIO_fstat
592# define ioctl PerlLIO_ioctl
593# define isatty PerlLIO_isatty
6b980173 594# define link PerlLIO_link
c6af7a1a
GS
595# define lseek PerlLIO_lseek
596# define lstat PerlLIO_lstat
597# define mktemp PerlLIO_mktemp
598# define open PerlLIO_open
599# define read PerlLIO_read
600# define rename PerlLIO_rename
601# define setmode PerlLIO_setmode
4f49e16e 602# define stat(buf,sb) PerlLIO_stat(buf,sb)
c6af7a1a
GS
603# define tmpnam PerlLIO_tmpnam
604# define umask PerlLIO_umask
605# define unlink PerlLIO_unlink
606# define utime PerlLIO_utime
607# define write PerlLIO_write
608# define malloc PerlMem_malloc
5ace197f 609# define calloc PerlMem_calloc
c6af7a1a
GS
610# define realloc PerlMem_realloc
611# define free PerlMem_free
612# define abort PerlProc_abort
613# define exit PerlProc_exit
614# define _exit PerlProc__exit
615# define execl PerlProc_execl
616# define execv PerlProc_execv
617# define execvp PerlProc_execvp
618# define getuid PerlProc_getuid
619# define geteuid PerlProc_geteuid
620# define getgid PerlProc_getgid
621# define getegid PerlProc_getegid
622# define getlogin PerlProc_getlogin
623# define kill PerlProc_kill
624# define killpg PerlProc_killpg
625# define pause PerlProc_pause
626# define popen PerlProc_popen
627# define pclose PerlProc_pclose
628# define pipe PerlProc_pipe
629# define setuid PerlProc_setuid
630# define setgid PerlProc_setgid
631# define sleep PerlProc_sleep
632# define times PerlProc_times
633# define wait PerlProc_wait
634# define setjmp PerlProc_setjmp
635# define longjmp PerlProc_longjmp
636# define signal PerlProc_signal
7766f137 637# define getpid PerlProc_getpid
57ab3dfe 638# define gettimeofday PerlProc_gettimeofday
c6af7a1a
GS
639# define htonl PerlSock_htonl
640# define htons PerlSock_htons
641# define ntohl PerlSock_ntohl
642# define ntohs PerlSock_ntohs
643# define accept PerlSock_accept
644# define bind PerlSock_bind
645# define connect PerlSock_connect
646# define endhostent PerlSock_endhostent
647# define endnetent PerlSock_endnetent
648# define endprotoent PerlSock_endprotoent
649# define endservent PerlSock_endservent
650# define gethostbyaddr PerlSock_gethostbyaddr
651# define gethostbyname PerlSock_gethostbyname
652# define gethostent PerlSock_gethostent
653# define gethostname PerlSock_gethostname
654# define getnetbyaddr PerlSock_getnetbyaddr
655# define getnetbyname PerlSock_getnetbyname
656# define getnetent PerlSock_getnetent
657# define getpeername PerlSock_getpeername
658# define getprotobyname PerlSock_getprotobyname
659# define getprotobynumber PerlSock_getprotobynumber
660# define getprotoent PerlSock_getprotoent
661# define getservbyname PerlSock_getservbyname
662# define getservbyport PerlSock_getservbyport
663# define getservent PerlSock_getservent
664# define getsockname PerlSock_getsockname
665# define getsockopt PerlSock_getsockopt
666# define inet_addr PerlSock_inet_addr
667# define inet_ntoa PerlSock_inet_ntoa
668# define listen PerlSock_listen
669# define recv PerlSock_recv
670# define recvfrom PerlSock_recvfrom
671# define select PerlSock_select
672# define send PerlSock_send
673# define sendto PerlSock_sendto
674# define sethostent PerlSock_sethostent
675# define setnetent PerlSock_setnetent
676# define setprotoent PerlSock_setprotoent
677# define setservent PerlSock_setservent
678# define setsockopt PerlSock_setsockopt
679# define shutdown PerlSock_shutdown
680# define socket PerlSock_socket
681# define socketpair PerlSock_socketpair
2986a63f 682# endif /* NETWARE && USE_STDIO */
21c5e947 683
72e6b643
SH
684# undef fd_set
685# undef FD_SET
686# undef FD_CLR
687# undef FD_ISSET
688# undef FD_ZERO
689# define fd_set Perl_fd_set
690# define FD_SET(n,p) PERL_FD_SET(n,p)
691# define FD_CLR(n,p) PERL_FD_CLR(n,p)
692# define FD_ISSET(n,p) PERL_FD_ISSET(n,p)
693# define FD_ZERO(p) PERL_FD_ZERO(p)
21c5e947 694
c6af7a1a 695# endif /* NO_XSLOCKS */
acfe0abc 696#endif /* PERL_IMPLICIT_SYS && !PERL_CORE */
b4ba0ab9 697
6a5bc5ac 698#endif /* PERL_XSUB_H_ */ /* include guard */
ad73156c
AL
699
700/*
14d04a33 701 * ex: set ts=8 sts=4 sw=4 et:
ad73156c 702 */