This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
flush all open output buffers before fork(), exec(), system, qx//
[perl5.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 dXSARGS                         \
14         dSP; dMARK;                     \
15         I32 ax = mark - PL_stack_base + 1;      \
16         I32 items = sp - mark
17
18 #define XSANY CvXSUBANY(cv)
19
20 #define dXSI32 I32 ix = XSANY.any_i32
21
22 #ifdef __cplusplus
23 #  define XSINTERFACE_CVT(ret,name) ret (*name)(...)
24 #else
25 #  define XSINTERFACE_CVT(ret,name) ret (*name)()
26 #endif
27 #define dXSFUNCTION(ret)                XSINTERFACE_CVT(ret,XSFUNCTION)
28 #define XSINTERFACE_FUNC(ret,cv,f)      ((XSINTERFACE_CVT(ret,))(f))
29 #define XSINTERFACE_FUNC_SET(cv,f)      \
30                 CvXSUBANY(cv).any_dptr = (void (*) _((void*)))(f)
31
32 #define XSRETURN(off)                                   \
33     STMT_START {                                        \
34         PL_stack_sp = PL_stack_base + ax + ((off) - 1); \
35         return;                                         \
36     } STMT_END
37
38 /* Simple macros to put new mortal values onto the stack.   */
39 /* Typically used to return values from XS functions.       */
40 #define XST_mIV(i,v)  (ST(i) = sv_2mortal(newSViv(v))  )
41 #define XST_mNV(i,v)  (ST(i) = sv_2mortal(newSVnv(v))  )
42 #define XST_mPV(i,v)  (ST(i) = sv_2mortal(newSVpv(v,0)))
43 #define XST_mPVN(i,v,n)  (ST(i) = sv_2mortal(newSVpvn(v,n)))
44 #define XST_mNO(i)    (ST(i) = &PL_sv_no   )
45 #define XST_mYES(i)   (ST(i) = &PL_sv_yes  )
46 #define XST_mUNDEF(i) (ST(i) = &PL_sv_undef)
47  
48 #define XSRETURN_IV(v) STMT_START { XST_mIV(0,v);  XSRETURN(1); } STMT_END
49 #define XSRETURN_NV(v) STMT_START { XST_mNV(0,v);  XSRETURN(1); } STMT_END
50 #define XSRETURN_PV(v) STMT_START { XST_mPV(0,v);  XSRETURN(1); } STMT_END
51 #define XSRETURN_PVN(v) STMT_START { XST_mPVN(0,v,n);  XSRETURN(1); } STMT_END
52 #define XSRETURN_NO    STMT_START { XST_mNO(0);    XSRETURN(1); } STMT_END
53 #define XSRETURN_YES   STMT_START { XST_mYES(0);   XSRETURN(1); } STMT_END
54 #define XSRETURN_UNDEF STMT_START { XST_mUNDEF(0); XSRETURN(1); } STMT_END
55 #define XSRETURN_EMPTY STMT_START {                XSRETURN(0); } STMT_END
56
57 #define newXSproto(a,b,c,d)     sv_setpv((SV*)newXS(a,b,c), d)
58
59 #ifdef XS_VERSION
60 #  define XS_VERSION_BOOTCHECK \
61     STMT_START {                                                        \
62         SV *tmpsv; STRLEN n_a;                                          \
63         char *vn = Nullch, *module = SvPV(ST(0),n_a);                   \
64         if (items >= 2)  /* version supplied as bootstrap arg */        \
65             tmpsv = ST(1);                                              \
66         else {                                                          \
67             /* XXX GV_ADDWARN */                                        \
68             tmpsv = perl_get_sv(form("%s::%s", module,                  \
69                                   vn = "XS_VERSION"), FALSE);           \
70             if (!tmpsv || !SvOK(tmpsv))                                 \
71                 tmpsv = perl_get_sv(form("%s::%s", module,              \
72                                       vn = "VERSION"), FALSE);          \
73         }                                                               \
74         if (tmpsv && (!SvOK(tmpsv) || strNE(XS_VERSION, SvPV(tmpsv, n_a))))     \
75             croak("%s object version %s does not match %s%s%s%s %_",    \
76                   module, XS_VERSION,                                   \
77                   vn ? "$" : "", vn ? module : "", vn ? "::" : "",      \
78                   vn ? vn : "bootstrap parameter", tmpsv);              \
79     } STMT_END
80 #else
81 #  define XS_VERSION_BOOTCHECK
82 #endif
83
84 #ifdef PERL_CAPI
85 #  define VTBL_sv               get_vtbl(want_vtbl_sv)
86 #  define VTBL_env              get_vtbl(want_vtbl_env)
87 #  define VTBL_envelem          get_vtbl(want_vtbl_envelem)
88 #  define VTBL_sig              get_vtbl(want_vtbl_sig)
89 #  define VTBL_sigelem          get_vtbl(want_vtbl_sigelem)
90 #  define VTBL_pack             get_vtbl(want_vtbl_pack)
91 #  define VTBL_packelem         get_vtbl(want_vtbl_packelem)
92 #  define VTBL_dbline           get_vtbl(want_vtbl_dbline)
93 #  define VTBL_isa              get_vtbl(want_vtbl_isa)
94 #  define VTBL_isaelem          get_vtbl(want_vtbl_isaelem)
95 #  define VTBL_arylen           get_vtbl(want_vtbl_arylen)
96 #  define VTBL_glob             get_vtbl(want_vtbl_glob)
97 #  define VTBL_mglob            get_vtbl(want_vtbl_mglob)
98 #  define VTBL_nkeys            get_vtbl(want_vtbl_nkeys)
99 #  define VTBL_taint            get_vtbl(want_vtbl_taint)
100 #  define VTBL_substr           get_vtbl(want_vtbl_substr)
101 #  define VTBL_vec              get_vtbl(want_vtbl_vec)
102 #  define VTBL_pos              get_vtbl(want_vtbl_pos)
103 #  define VTBL_bm               get_vtbl(want_vtbl_bm)
104 #  define VTBL_fm               get_vtbl(want_vtbl_fm)
105 #  define VTBL_uvar             get_vtbl(want_vtbl_uvar)
106 #  define VTBL_defelem          get_vtbl(want_vtbl_defelem)
107 #  define VTBL_regexp           get_vtbl(want_vtbl_regexp)
108 #  define VTBL_regdata          get_vtbl(want_vtbl_regdata)
109 #  define VTBL_regdatum         get_vtbl(want_vtbl_regdatum)
110 #  ifdef USE_LOCALE_COLLATE
111 #    define VTBL_collxfrm       get_vtbl(want_vtbl_collxfrm)
112 #  endif
113 #  define VTBL_amagic           get_vtbl(want_vtbl_amagic)
114 #  define VTBL_amagicelem       get_vtbl(want_vtbl_amagicelem)
115 #else
116 #  define VTBL_sv               &PL_vtbl_sv
117 #  define VTBL_env              &PL_vtbl_env
118 #  define VTBL_envelem          &PL_vtbl_envelem
119 #  define VTBL_sig              &PL_vtbl_sig
120 #  define VTBL_sigelem          &PL_vtbl_sigelem
121 #  define VTBL_pack             &PL_vtbl_pack
122 #  define VTBL_packelem         &PL_vtbl_packelem
123 #  define VTBL_dbline           &PL_vtbl_dbline
124 #  define VTBL_isa              &PL_vtbl_isa
125 #  define VTBL_isaelem          &PL_vtbl_isaelem
126 #  define VTBL_arylen           &PL_vtbl_arylen
127 #  define VTBL_glob             &PL_vtbl_glob
128 #  define VTBL_mglob            &PL_vtbl_mglob
129 #  define VTBL_nkeys            &PL_vtbl_nkeys
130 #  define VTBL_taint            &PL_vtbl_taint
131 #  define VTBL_substr           &PL_vtbl_substr
132 #  define VTBL_vec              &PL_vtbl_vec
133 #  define VTBL_pos              &PL_vtbl_pos
134 #  define VTBL_bm               &PL_vtbl_bm
135 #  define VTBL_fm               &PL_vtbl_fm
136 #  define VTBL_uvar             &PL_vtbl_uvar
137 #  define VTBL_defelem          &PL_vtbl_defelem
138 #  define VTBL_regexp           &PL_vtbl_regexp
139 #  define VTBL_regdata          &PL_vtbl_regdata
140 #  define VTBL_regdatum         &PL_vtbl_regdatum
141 #  ifdef USE_LOCALE_COLLATE
142 #    define VTBL_collxfrm       &PL_vtbl_collxfrm
143 #  endif
144 #  define VTBL_amagic           &PL_vtbl_amagic
145 #  define VTBL_amagicelem       &PL_vtbl_amagicelem
146 #endif
147
148 #ifdef PERL_OBJECT
149 #  include "objXSUB.h"
150
151 #  undef  PERL_OBJECT_THIS
152 #  define PERL_OBJECT_THIS pPerl
153 #  undef  PERL_OBJECT_THIS_
154 #  define PERL_OBJECT_THIS_ pPerl,
155
156 #  undef  SAVEDESTRUCTOR
157 #  define SAVEDESTRUCTOR(f,p) \
158         pPerl->Perl_save_destructor((FUNC_NAME_TO_PTR(f)),(p))
159
160 #  ifdef WIN32
161 #    ifndef WIN32IO_IS_STDIO
162 #      undef    errno
163 #      define   errno                   ErrorNo()
164 #    endif
165 #    undef  ErrorNo
166 #    define ErrorNo                     pPerl->ErrorNo
167 #    undef  NtCrypt
168 #    define NtCrypt                     pPerl->NtCrypt
169 #    undef  NtGetLib
170 #    define NtGetLib                    pPerl->NtGetLib
171 #    undef  NtGetArchLib
172 #    define NtGetArchLib                pPerl->NtGetArchLib
173 #    undef  NtGetSiteLib
174 #    define NtGetSiteLib                pPerl->NtGetSiteLib
175 #    undef  NtGetBin
176 #    define NtGetBin                    pPerl->NtGetBin
177 #    undef  NtGetDebugScriptStr
178 #    define NtGetDebugScriptStr         pPerl->NtGetDebugScriptStr
179 #  endif /* WIN32 */
180
181 #  ifndef NO_XSLOCKS
182 #    undef closedir
183 #    undef opendir
184 #    undef stdin
185 #    undef stdout
186 #    undef stderr
187 #    undef feof
188 #    undef ferror
189 #    undef fgetpos
190 #    undef ioctl
191 #    undef getlogin
192 #    undef setjmp
193 #    undef getc
194 #    undef ungetc
195 #    undef fileno
196
197 #    define mkdir               PerlDir_mkdir
198 #    define chdir               PerlDir_chdir
199 #    define rmdir               PerlDir_rmdir
200 #    define closedir            PerlDir_close
201 #    define opendir             PerlDir_open
202 #    define readdir             PerlDir_read
203 #    define rewinddir           PerlDir_rewind
204 #    define seekdir             PerlDir_seek
205 #    define telldir             PerlDir_tell
206 #    define putenv              PerlEnv_putenv
207 #    define getenv              PerlEnv_getenv
208 #    define uname               PerlEnv_uname
209 #    define stdin               PerlIO_stdin()
210 #    define stdout              PerlIO_stdout()
211 #    define stderr              PerlIO_stderr()
212 #    define fopen               PerlIO_open
213 #    define fclose              PerlIO_close
214 #    define feof                PerlIO_eof
215 #    define ferror              PerlIO_error
216 #    define fclearerr           PerlIO_clearerr
217 #    define getc                PerlIO_getc
218 #    define fputc(c, f)         PerlIO_putc(f,c)
219 #    define fputs(s, f)         PerlIO_puts(f,s)
220 #    define fflush              PerlIO_flush
221 #    define ungetc(c, f)        PerlIO_ungetc((f),(c))
222 #    define fileno              PerlIO_fileno
223 #    define fdopen              PerlIO_fdopen
224 #    define freopen             PerlIO_reopen
225 #    define fread(b,s,c,f)      PerlIO_read((f),(b),(s*c))
226 #    define fwrite(b,s,c,f)     PerlIO_write((f),(b),(s*c))
227 #    define setbuf              PerlIO_setbuf
228 #    define setvbuf             PerlIO_setvbuf
229 #    define setlinebuf          PerlIO_setlinebuf
230 #    define stdoutf             PerlIO_stdoutf
231 #    define vfprintf            PerlIO_vprintf
232 #    define ftell               PerlIO_tell
233 #    define fseek               PerlIO_seek
234 #    define fgetpos             PerlIO_getpos
235 #    define fsetpos             PerlIO_setpos
236 #    define frewind             PerlIO_rewind
237 #    define tmpfile             PerlIO_tmpfile
238 #    define access              PerlLIO_access
239 #    define chmod               PerlLIO_chmod
240 #    define chsize              PerlLIO_chsize
241 #    define close               PerlLIO_close
242 #    define dup                 PerlLIO_dup
243 #    define dup2                PerlLIO_dup2
244 #    define flock               PerlLIO_flock
245 #    define fstat               PerlLIO_fstat
246 #    define ioctl               PerlLIO_ioctl
247 #    define isatty              PerlLIO_isatty
248 #    define lseek               PerlLIO_lseek
249 #    define lstat               PerlLIO_lstat
250 #    define mktemp              PerlLIO_mktemp
251 #    define open                PerlLIO_open
252 #    define read                PerlLIO_read
253 #    define rename              PerlLIO_rename
254 #    define setmode             PerlLIO_setmode
255 #    define stat                PerlLIO_stat
256 #    define tmpnam              PerlLIO_tmpnam
257 #    define umask               PerlLIO_umask
258 #    define unlink              PerlLIO_unlink
259 #    define utime               PerlLIO_utime
260 #    define write               PerlLIO_write
261 #    define malloc              PerlMem_malloc
262 #    define realloc             PerlMem_realloc
263 #    define free                PerlMem_free
264 #    define abort               PerlProc_abort
265 #    define exit                PerlProc_exit
266 #    define _exit               PerlProc__exit
267 #    define execl               PerlProc_execl
268 #    define execv               PerlProc_execv
269 #    define execvp              PerlProc_execvp
270 #    define getuid              PerlProc_getuid
271 #    define geteuid             PerlProc_geteuid
272 #    define getgid              PerlProc_getgid
273 #    define getegid             PerlProc_getegid
274 #    define getlogin            PerlProc_getlogin
275 #    define kill                PerlProc_kill
276 #    define killpg              PerlProc_killpg
277 #    define pause               PerlProc_pause
278 #    define popen               PerlProc_popen
279 #    define pclose              PerlProc_pclose
280 #    define pipe                PerlProc_pipe
281 #    define setuid              PerlProc_setuid
282 #    define setgid              PerlProc_setgid
283 #    define sleep               PerlProc_sleep
284 #    define times               PerlProc_times
285 #    define wait                PerlProc_wait
286 #    define setjmp              PerlProc_setjmp
287 #    define longjmp             PerlProc_longjmp
288 #    define signal              PerlProc_signal
289 #    define htonl               PerlSock_htonl
290 #    define htons               PerlSock_htons
291 #    define ntohl               PerlSock_ntohl
292 #    define ntohs               PerlSock_ntohs
293 #    define accept              PerlSock_accept
294 #    define bind                PerlSock_bind
295 #    define connect             PerlSock_connect
296 #    define endhostent          PerlSock_endhostent
297 #    define endnetent           PerlSock_endnetent
298 #    define endprotoent         PerlSock_endprotoent
299 #    define endservent          PerlSock_endservent
300 #    define gethostbyaddr       PerlSock_gethostbyaddr
301 #    define gethostbyname       PerlSock_gethostbyname
302 #    define gethostent          PerlSock_gethostent
303 #    define gethostname         PerlSock_gethostname
304 #    define getnetbyaddr        PerlSock_getnetbyaddr
305 #    define getnetbyname        PerlSock_getnetbyname
306 #    define getnetent           PerlSock_getnetent
307 #    define getpeername         PerlSock_getpeername
308 #    define getprotobyname      PerlSock_getprotobyname
309 #    define getprotobynumber    PerlSock_getprotobynumber
310 #    define getprotoent         PerlSock_getprotoent
311 #    define getservbyname       PerlSock_getservbyname
312 #    define getservbyport       PerlSock_getservbyport
313 #    define getservent          PerlSock_getservent
314 #    define getsockname         PerlSock_getsockname
315 #    define getsockopt          PerlSock_getsockopt
316 #    define inet_addr           PerlSock_inet_addr
317 #    define inet_ntoa           PerlSock_inet_ntoa
318 #    define listen              PerlSock_listen
319 #    define recv                PerlSock_recv
320 #    define recvfrom            PerlSock_recvfrom
321 #    define select              PerlSock_select
322 #    define send                PerlSock_send
323 #    define sendto              PerlSock_sendto
324 #    define sethostent          PerlSock_sethostent
325 #    define setnetent           PerlSock_setnetent
326 #    define setprotoent         PerlSock_setprotoent
327 #    define setservent          PerlSock_setservent
328 #    define setsockopt          PerlSock_setsockopt
329 #    define shutdown            PerlSock_shutdown
330 #    define socket              PerlSock_socket
331 #    define socketpair          PerlSock_socketpair
332
333 #    ifdef WIN32
334 #      include "XSlock.h"
335 #    endif  /* WIN32 */
336 #  endif  /* NO_XSLOCKS */
337 #else
338 #  ifdef PERL_CAPI
339 #    include "perlCAPI.h"
340 #  endif
341 #endif  /* PERL_OBJECT */