XSUB.h

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