PL_ prefix to all perlvars, part1
[p5sagit/p5-mst-13.2.git] / XSUB.h
1 #define ST(off) PL_stack_base[ax + (off)]
2
3 #ifdef CAN_PROTOTYPE
4 #ifdef PERL_OBJECT
5 #define XS(name) void name(CV* cv, CPerlObj* pPerl)
6 #else
7 #define XS(name) void name(CV* cv)
8 #endif
9 #else
10 #define XS(name) void name(cv) CV* cv;
11 #endif
12
13 #define na              PL_na
14 #define sv_undef        PL_sv_undef
15 #define sv_yes          PL_sv_yes
16 #define sv_no           PL_sv_no
17
18 #define dXSARGS                         \
19         dSP; dMARK;                     \
20         I32 ax = mark - PL_stack_base + 1;      \
21         I32 items = sp - mark
22
23 #define XSANY CvXSUBANY(cv)
24
25 #define dXSI32 I32 ix = XSANY.any_i32
26
27 #ifdef __cplusplus
28 #  define XSINTERFACE_CVT(ret,name) ret (*name)(...)
29 #else
30 #  define XSINTERFACE_CVT(ret,name) ret (*name)()
31 #endif
32 #define dXSFUNCTION(ret)                XSINTERFACE_CVT(ret,XSFUNCTION)
33 #define XSINTERFACE_FUNC(ret,cv,f)      ((XSINTERFACE_CVT(ret,))(f))
34 #define XSINTERFACE_FUNC_SET(cv,f)      \
35                 CvXSUBANY(cv).any_dptr = (void (*) _((void*)))(f)
36
37 #define XSRETURN(off)                                   \
38     STMT_START {                                        \
39         PL_stack_sp = PL_stack_base + ax + ((off) - 1); \
40         return;                                         \
41     } STMT_END
42
43 /* Simple macros to put new mortal values onto the stack.   */
44 /* Typically used to return values from XS functions.       */
45 #define XST_mIV(i,v)  (ST(i) = sv_2mortal(newSViv(v))  )
46 #define XST_mNV(i,v)  (ST(i) = sv_2mortal(newSVnv(v))  )
47 #define XST_mPV(i,v)  (ST(i) = sv_2mortal(newSVpv(v,0)))
48 #define XST_mNO(i)    (ST(i) = &PL_sv_no   )
49 #define XST_mYES(i)   (ST(i) = &PL_sv_yes  )
50 #define XST_mUNDEF(i) (ST(i) = &PL_sv_undef)
51  
52 #define XSRETURN_IV(v) STMT_START { XST_mIV(0,v);  XSRETURN(1); } STMT_END
53 #define XSRETURN_NV(v) STMT_START { XST_mNV(0,v);  XSRETURN(1); } STMT_END
54 #define XSRETURN_PV(v) STMT_START { XST_mPV(0,v);  XSRETURN(1); } STMT_END
55 #define XSRETURN_NO    STMT_START { XST_mNO(0);    XSRETURN(1); } STMT_END
56 #define XSRETURN_YES   STMT_START { XST_mYES(0);   XSRETURN(1); } STMT_END
57 #define XSRETURN_UNDEF STMT_START { XST_mUNDEF(0); XSRETURN(1); } STMT_END
58 #define XSRETURN_EMPTY STMT_START {                XSRETURN(0); } STMT_END
59
60 #define newXSproto(a,b,c,d)     sv_setpv((SV*)newXS(a,b,c), d)
61
62 #ifdef XS_VERSION
63 # define XS_VERSION_BOOTCHECK \
64     STMT_START {                                                        \
65         SV *Sv;                                                         \
66         char *vn = Nullch, *module = SvPV(ST(0),na);                    \
67         if (items >= 2)  /* version supplied as bootstrap arg */        \
68             Sv = ST(1);                                                 \
69         else {                                                          \
70             /* XXX GV_ADDWARN */                                        \
71             Sv = perl_get_sv(form("%s::%s", module,                     \
72                                   vn = "XS_VERSION"), FALSE);           \
73             if (!Sv || !SvOK(Sv))                                       \
74                 Sv = perl_get_sv(form("%s::%s", module,                 \
75                                       vn = "VERSION"), FALSE);          \
76         }                                                               \
77         if (Sv && (!SvOK(Sv) || strNE(XS_VERSION, SvPV(Sv, na))))       \
78             croak("%s object version %s does not match %s%s%s%s %_",    \
79                   module, XS_VERSION,                                   \
80                   vn ? "$" : "", vn ? module : "", vn ? "::" : "",      \
81                   vn ? vn : "bootstrap parameter", Sv);                 \
82     } STMT_END
83 #else
84 # define XS_VERSION_BOOTCHECK
85 #endif
86
87 #ifdef PERL_OBJECT
88 #include "ObjXSub.h"
89 #ifndef NO_XSLOCKS
90 #ifdef WIN32
91 #include "XSLock.h"
92 #endif  /* WIN32 */
93 #endif  /* NO_XSLOCKS */
94 #else
95 #ifdef PERL_CAPI
96 #include "PerlCAPI.h"
97 #endif
98 #endif  /* PERL_OBJECT */