3 * Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
4 * 2003, 2004, 2005, 2006, 2007 by Larry Wall and others
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.
11 #ifndef _INC_PERL_XSUB_H
12 #define _INC_PERL_XSUB_H 1
14 /* first, some documentation for xsubpp-generated items */
17 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
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 C<THIS>.
23 =for apidoc Amn|(whatever)|RETVAL
24 Variable which is setup by C<xsubpp> to hold the return value for an
25 XSUB. This is always the proper type for the XSUB. See
26 L<perlxs/"The RETVAL Variable">.
28 =for apidoc Amn|(whatever)|THIS
29 Variable which is setup by C<xsubpp> to designate the object in a C++
30 XSUB. This is always the proper type for the C++ object. See C<CLASS> and
31 L<perlxs/"Using XS With C++">.
33 =for apidoc Amn|I32|ax
34 Variable which is setup by C<xsubpp> to indicate the stack base offset,
35 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros. The C<dMARK> macro
36 must be called prior to setup the C<MARK> variable.
38 =for apidoc Amn|I32|items
39 Variable which is setup by C<xsubpp> to indicate the number of
40 items on the stack. See L<perlxs/"Variable-length Parameter Lists">.
42 =for apidoc Amn|I32|ix
43 Variable which is setup by C<xsubpp> to indicate which of an
44 XSUB's aliases was used to invoke it. See L<perlxs/"The ALIAS: Keyword">.
46 =for apidoc Am|SV*|ST|int ix
47 Used to access elements on the XSUB's stack.
50 Macro to declare an XSUB and its C parameter list. This is handled by
54 Sets up the C<ax> variable.
55 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
57 =for apidoc Ams||dAXMARK
58 Sets up the C<ax> variable and stack marker variable C<mark>.
59 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
61 =for apidoc Ams||dITEMS
62 Sets up the C<items> variable.
63 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
65 =for apidoc Ams||dXSARGS
66 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
67 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
68 This is usually handled automatically by C<xsubpp>.
70 =for apidoc Ams||dXSI32
71 Sets up the C<ix> variable for an XSUB which has aliases. This is usually
72 handled automatically by C<xsubpp>.
74 =for apidoc Ams||dUNDERBAR
75 Sets up the C<padoff_du> variable for an XSUB that wishes to use
78 =for apidoc AmU||UNDERBAR
79 The SV* corresponding to the $_ variable. Works even if there
80 is a lexical $_ in scope.
85 #ifndef PERL_UNUSED_ARG
86 # if defined(lint) && defined(S_SPLINT_S) /* www.splint.org */
88 # define PERL_UNUSED_ARG(x) NOTE(ARGUNUSED(x))
90 # define PERL_UNUSED_ARG(x) ((void)x)
93 #ifndef PERL_UNUSED_VAR
94 # define PERL_UNUSED_VAR(x) ((void)x)
97 #define ST(off) PL_stack_base[ax + (off)]
100 #if defined(__CYGWIN__) && defined(USE_DYNAMIC_LOADING)
101 # define XS(name) __declspec(dllexport) void name(pTHX_ CV* cv)
103 #if defined(__SYMBIAN32__)
104 # define XS(name) EXPORT_C void name(pTHX_ CV* cv)
107 # if defined(HASATTRIBUTE_UNUSED) && !defined(__cplusplus)
108 # define XS(name) void name(pTHX_ CV* cv __attribute__unused__)
111 # define XS(name) extern "C" void name(pTHX_ CV* cv)
113 # define XS(name) void name(pTHX_ CV* cv)
118 #define dAX const I32 ax = (I32)(MARK - PL_stack_base + 1)
122 register SV **mark = PL_stack_base + ax++
124 #define dITEMS I32 items = (I32)(SP - MARK)
126 #if defined(lint) && defined(S_SPLINT_S) /* www.splint.org */
128 NOTE(ARGUNUSED(cv)) \
135 #define dXSTARG SV * const targ = ((PL_op->op_private & OPpENTERSUB_HASTARG) \
136 ? PAD_SV(PL_op->op_targ) : sv_newmortal())
138 /* Should be used before final PUSHi etc. if not in PPCODE section. */
139 #define XSprePUSH (sp = PL_stack_base + ax - 1)
141 #define XSANY CvXSUBANY(cv)
143 #define dXSI32 I32 ix = XSANY.any_i32
146 # define XSINTERFACE_CVT(ret,name) ret (*name)(...)
147 # define XSINTERFACE_CVT_ANON(ret) ret (*)(...)
149 # define XSINTERFACE_CVT(ret,name) ret (*name)()
150 # define XSINTERFACE_CVT_ANON(ret) ret (*)()
152 #define dXSFUNCTION(ret) XSINTERFACE_CVT(ret,XSFUNCTION)
153 #define XSINTERFACE_FUNC(ret,cv,f) ((XSINTERFACE_CVT_ANON(ret))(f))
154 #define XSINTERFACE_FUNC_SET(cv,f) \
155 CvXSUBANY(cv).any_dxptr = (void (*) (pTHX_ void*))(f)
157 #define dUNDERBAR PADOFFSET padoff_du = find_rundefsvoffset()
158 #define UNDERBAR ((padoff_du == NOT_IN_PAD \
159 || PAD_COMPNAME_FLAGS_isOUR(padoff_du)) \
160 ? DEFSV : PAD_SVl(padoff_du))
162 /* Simple macros to put new mortal values onto the stack. */
163 /* Typically used to return values from XS functions. */
166 =head1 Stack Manipulation Macros
168 =for apidoc Am|void|XST_mIV|int pos|IV iv
169 Place an integer into the specified position C<pos> on the stack. The
170 value is stored in a new mortal SV.
172 =for apidoc Am|void|XST_mNV|int pos|NV nv
173 Place a double into the specified position C<pos> on the stack. The value
174 is stored in a new mortal SV.
176 =for apidoc Am|void|XST_mPV|int pos|char* str
177 Place a copy of a string into the specified position C<pos> on the stack.
178 The value is stored in a new mortal SV.
180 =for apidoc Am|void|XST_mNO|int pos
181 Place C<&PL_sv_no> into the specified position C<pos> on the
184 =for apidoc Am|void|XST_mYES|int pos
185 Place C<&PL_sv_yes> into the specified position C<pos> on the
188 =for apidoc Am|void|XST_mUNDEF|int pos
189 Place C<&PL_sv_undef> into the specified position C<pos> on the
192 =for apidoc Am|void|XSRETURN|int nitems
193 Return from XSUB, indicating number of items on the stack. This is usually
194 handled by C<xsubpp>.
196 =for apidoc Am|void|XSRETURN_IV|IV iv
197 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
199 =for apidoc Am|void|XSRETURN_UV|IV uv
200 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
202 =for apidoc Am|void|XSRETURN_NV|NV nv
203 Return a double from an XSUB immediately. Uses C<XST_mNV>.
205 =for apidoc Am|void|XSRETURN_PV|char* str
206 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
208 =for apidoc Ams||XSRETURN_NO
209 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
211 =for apidoc Ams||XSRETURN_YES
212 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
214 =for apidoc Ams||XSRETURN_UNDEF
215 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
217 =for apidoc Ams||XSRETURN_EMPTY
218 Return an empty list from an XSUB immediately.
220 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
222 =for apidoc AmU||newXSproto|char* name|XSUBADDR_t f|char* filename|const char *proto
223 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
226 =for apidoc AmU||XS_VERSION
227 The version identifier for an XS module. This is usually
228 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
230 =for apidoc Ams||XS_VERSION_BOOTCHECK
231 Macro to verify that a PM module's $VERSION variable matches the XS
232 module's C<XS_VERSION> variable. This is usually handled automatically by
233 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
235 =head1 Simple Exception Handling Macros
237 =for apidoc Ams||dXCPT
238 Set up necessary local variables for exception handling.
239 See L<perlguts/"Exception Handling">.
241 =for apidoc AmU||XCPT_TRY_START
242 Starts a try block. See L<perlguts/"Exception Handling">.
244 =for apidoc AmU||XCPT_TRY_END
245 Ends a try block. See L<perlguts/"Exception Handling">.
247 =for apidoc AmU||XCPT_CATCH
248 Introduces a catch block. See L<perlguts/"Exception Handling">.
250 =for apidoc Ams||XCPT_RETHROW
251 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
256 #define XST_mIV(i,v) (ST(i) = sv_2mortal(newSViv(v)) )
257 #define XST_mUV(i,v) (ST(i) = sv_2mortal(newSVuv(v)) )
258 #define XST_mNV(i,v) (ST(i) = sv_2mortal(newSVnv(v)) )
259 #define XST_mPV(i,v) (ST(i) = sv_2mortal(newSVpv(v,0)))
260 #define XST_mPVN(i,v,n) (ST(i) = sv_2mortal(newSVpvn(v,n)))
261 #define XST_mNO(i) (ST(i) = &PL_sv_no )
262 #define XST_mYES(i) (ST(i) = &PL_sv_yes )
263 #define XST_mUNDEF(i) (ST(i) = &PL_sv_undef)
265 #define XSRETURN(off) \
267 const IV tmpXSoff = (off); \
268 PL_stack_sp = PL_stack_base + ax + (tmpXSoff - 1); \
272 #define XSRETURN_IV(v) STMT_START { XST_mIV(0,v); XSRETURN(1); } STMT_END
273 #define XSRETURN_UV(v) STMT_START { XST_mUV(0,v); XSRETURN(1); } STMT_END
274 #define XSRETURN_NV(v) STMT_START { XST_mNV(0,v); XSRETURN(1); } STMT_END
275 #define XSRETURN_PV(v) STMT_START { XST_mPV(0,v); XSRETURN(1); } STMT_END
276 #define XSRETURN_PVN(v,n) STMT_START { XST_mPVN(0,v,n); XSRETURN(1); } STMT_END
277 #define XSRETURN_NO STMT_START { XST_mNO(0); XSRETURN(1); } STMT_END
278 #define XSRETURN_YES STMT_START { XST_mYES(0); XSRETURN(1); } STMT_END
279 #define XSRETURN_UNDEF STMT_START { XST_mUNDEF(0); XSRETURN(1); } STMT_END
280 #define XSRETURN_EMPTY STMT_START { XSRETURN(0); } STMT_END
282 #define newXSproto(a,b,c,d) newXS_flags(a,b,c,d,0)
285 # define XS_VERSION_BOOTCHECK \
288 const char *vn = NULL, *module = SvPV_nolen_const(ST(0)); \
289 if (items >= 2) /* version supplied as bootstrap arg */ \
292 /* XXX GV_ADDWARN */ \
293 _sv = get_sv(Perl_form(aTHX_ "%s::%s", module, \
294 vn = "XS_VERSION"), FALSE); \
295 if (!_sv || !SvOK(_sv)) \
296 _sv = get_sv(Perl_form(aTHX_ "%s::%s", module, \
297 vn = "VERSION"), FALSE); \
300 SV *xssv = Perl_newSVpv(aTHX_ XS_VERSION, 0); \
301 xssv = new_version(xssv); \
302 if ( !sv_derived_from(_sv, "version") ) \
303 _sv = new_version(_sv); \
304 if ( vcmp(_sv,xssv) ) \
305 Perl_croak(aTHX_ "%s object version %"SVf" does not match %s%s%s%s %"SVf,\
306 module, SVfARG(vstringify(xssv)), \
307 vn ? "$" : "", vn ? module : "", vn ? "::" : "", \
308 vn ? vn : "bootstrap parameter", SVfARG(vstringify(_sv)));\
312 # define XS_VERSION_BOOTCHECK
316 # define dXCPT dJMPENV; int rEtV = 0
317 # define XCPT_TRY_START JMPENV_PUSH(rEtV); if (rEtV == 0)
318 # define XCPT_TRY_END JMPENV_POP;
319 # define XCPT_CATCH if (rEtV != 0)
320 # define XCPT_RETHROW JMPENV_JUMP(rEtV)
324 The DBM_setFilter & DBM_ckFilter macros are only used by
325 the *DB*_File modules
328 #define DBM_setFilter(db_type,code) \
331 RETVAL = sv_mortalcopy(db_type) ; \
333 if (db_type && (code == &PL_sv_undef)) { \
334 SvREFCNT_dec(db_type) ; \
339 sv_setsv(db_type, code) ; \
341 db_type = newSVsv(code) ; \
345 #define DBM_ckFilter(arg,type,name) \
348 if (db->filtering) { \
349 croak("recursion detected in %s", name) ; \
353 SAVEINT(db->filtering) ; \
354 db->filtering = TRUE ; \
356 if (name[7] == 's') \
357 arg = newSVsv(arg); \
362 (void) perl_call_sv(db->type, G_DISCARD); \
367 if (name[7] == 's'){ \
368 arg = sv_2mortal(arg); \
372 #if 1 /* for compatibility */
373 # define VTBL_sv &PL_vtbl_sv
374 # define VTBL_env &PL_vtbl_env
375 # define VTBL_envelem &PL_vtbl_envelem
376 # define VTBL_sig &PL_vtbl_sig
377 # define VTBL_sigelem &PL_vtbl_sigelem
378 # define VTBL_pack &PL_vtbl_pack
379 # define VTBL_packelem &PL_vtbl_packelem
380 # define VTBL_dbline &PL_vtbl_dbline
381 # define VTBL_isa &PL_vtbl_isa
382 # define VTBL_isaelem &PL_vtbl_isaelem
383 # define VTBL_arylen &PL_vtbl_arylen
384 # define VTBL_glob &PL_vtbl_glob
385 # define VTBL_mglob &PL_vtbl_mglob
386 # define VTBL_nkeys &PL_vtbl_nkeys
387 # define VTBL_taint &PL_vtbl_taint
388 # define VTBL_substr &PL_vtbl_substr
389 # define VTBL_vec &PL_vtbl_vec
390 # define VTBL_pos &PL_vtbl_pos
391 # define VTBL_bm &PL_vtbl_bm
392 # define VTBL_fm &PL_vtbl_fm
393 # define VTBL_uvar &PL_vtbl_uvar
394 # define VTBL_defelem &PL_vtbl_defelem
395 # define VTBL_regexp &PL_vtbl_regexp
396 # define VTBL_regdata &PL_vtbl_regdata
397 # define VTBL_regdatum &PL_vtbl_regdatum
398 # ifdef USE_LOCALE_COLLATE
399 # define VTBL_collxfrm &PL_vtbl_collxfrm
401 # define VTBL_amagic &PL_vtbl_amagic
402 # define VTBL_amagicelem &PL_vtbl_amagicelem
409 # define PL_madskills 0
413 #if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_NO_GET_CONTEXT) && !defined(PERL_CORE)
416 # define aTHX PERL_GET_THX
420 #if defined(PERL_IMPLICIT_SYS) && !defined(PERL_CORE)
422 # if defined (NETWARE) && defined (USE_STDIO)
423 # define times PerlProc_times
424 # define setuid PerlProc_setuid
425 # define setgid PerlProc_setgid
426 # define getpid PerlProc_getpid
427 # define pause PerlProc_pause
428 # define exit PerlProc_exit
429 # define _exit PerlProc__exit
446 /* Following symbols were giving redefinition errors while building extensions - sgp 17th Oct 2000 */
456 # undef gethostbyaddr
457 # undef gethostbyname
462 # undef getprotobyname
463 # undef getprotobynumber
465 # undef getservbyname
466 # undef getservbyport
477 # define mkdir PerlDir_mkdir
478 # define chdir PerlDir_chdir
479 # define rmdir PerlDir_rmdir
480 # define closedir PerlDir_close
481 # define opendir PerlDir_open
482 # define readdir PerlDir_read
483 # define rewinddir PerlDir_rewind
484 # define seekdir PerlDir_seek
485 # define telldir PerlDir_tell
486 # define putenv PerlEnv_putenv
487 # define getenv PerlEnv_getenv
488 # define uname PerlEnv_uname
489 # define stdin PerlSIO_stdin
490 # define stdout PerlSIO_stdout
491 # define stderr PerlSIO_stderr
492 # define fopen PerlSIO_fopen
493 # define fclose PerlSIO_fclose
494 # define feof PerlSIO_feof
495 # define ferror PerlSIO_ferror
496 # define clearerr PerlSIO_clearerr
497 # define getc PerlSIO_getc
498 # define fputc PerlSIO_fputc
499 # define fputs PerlSIO_fputs
500 # define fflush PerlSIO_fflush
501 # define ungetc PerlSIO_ungetc
502 # define fileno PerlSIO_fileno
503 # define fdopen PerlSIO_fdopen
504 # define freopen PerlSIO_freopen
505 # define fread PerlSIO_fread
506 # define fwrite PerlSIO_fwrite
507 # define setbuf PerlSIO_setbuf
508 # define setvbuf PerlSIO_setvbuf
509 # define setlinebuf PerlSIO_setlinebuf
510 # define stdoutf PerlSIO_stdoutf
511 # define vfprintf PerlSIO_vprintf
512 # define ftell PerlSIO_ftell
513 # define fseek PerlSIO_fseek
514 # define fgetpos PerlSIO_fgetpos
515 # define fsetpos PerlSIO_fsetpos
516 # define frewind PerlSIO_rewind
517 # define tmpfile PerlSIO_tmpfile
518 # define access PerlLIO_access
519 # define chmod PerlLIO_chmod
520 # define chsize PerlLIO_chsize
521 # define close PerlLIO_close
522 # define dup PerlLIO_dup
523 # define dup2 PerlLIO_dup2
524 # define flock PerlLIO_flock
525 # define fstat PerlLIO_fstat
526 # define ioctl PerlLIO_ioctl
527 # define isatty PerlLIO_isatty
528 # define link PerlLIO_link
529 # define lseek PerlLIO_lseek
530 # define lstat PerlLIO_lstat
531 # define mktemp PerlLIO_mktemp
532 # define open PerlLIO_open
533 # define read PerlLIO_read
534 # define rename PerlLIO_rename
535 # define setmode PerlLIO_setmode
536 # define stat(buf,sb) PerlLIO_stat(buf,sb)
537 # define tmpnam PerlLIO_tmpnam
538 # define umask PerlLIO_umask
539 # define unlink PerlLIO_unlink
540 # define utime PerlLIO_utime
541 # define write PerlLIO_write
542 # define malloc PerlMem_malloc
543 # define realloc PerlMem_realloc
544 # define free PerlMem_free
545 # define abort PerlProc_abort
546 # define exit PerlProc_exit
547 # define _exit PerlProc__exit
548 # define execl PerlProc_execl
549 # define execv PerlProc_execv
550 # define execvp PerlProc_execvp
551 # define getuid PerlProc_getuid
552 # define geteuid PerlProc_geteuid
553 # define getgid PerlProc_getgid
554 # define getegid PerlProc_getegid
555 # define getlogin PerlProc_getlogin
556 # define kill PerlProc_kill
557 # define killpg PerlProc_killpg
558 # define pause PerlProc_pause
559 # define popen PerlProc_popen
560 # define pclose PerlProc_pclose
561 # define pipe PerlProc_pipe
562 # define setuid PerlProc_setuid
563 # define setgid PerlProc_setgid
564 # define sleep PerlProc_sleep
565 # define times PerlProc_times
566 # define wait PerlProc_wait
567 # define setjmp PerlProc_setjmp
568 # define longjmp PerlProc_longjmp
569 # define signal PerlProc_signal
570 # define getpid PerlProc_getpid
571 # define gettimeofday PerlProc_gettimeofday
572 # define htonl PerlSock_htonl
573 # define htons PerlSock_htons
574 # define ntohl PerlSock_ntohl
575 # define ntohs PerlSock_ntohs
576 # define accept PerlSock_accept
577 # define bind PerlSock_bind
578 # define connect PerlSock_connect
579 # define endhostent PerlSock_endhostent
580 # define endnetent PerlSock_endnetent
581 # define endprotoent PerlSock_endprotoent
582 # define endservent PerlSock_endservent
583 # define gethostbyaddr PerlSock_gethostbyaddr
584 # define gethostbyname PerlSock_gethostbyname
585 # define gethostent PerlSock_gethostent
586 # define gethostname PerlSock_gethostname
587 # define getnetbyaddr PerlSock_getnetbyaddr
588 # define getnetbyname PerlSock_getnetbyname
589 # define getnetent PerlSock_getnetent
590 # define getpeername PerlSock_getpeername
591 # define getprotobyname PerlSock_getprotobyname
592 # define getprotobynumber PerlSock_getprotobynumber
593 # define getprotoent PerlSock_getprotoent
594 # define getservbyname PerlSock_getservbyname
595 # define getservbyport PerlSock_getservbyport
596 # define getservent PerlSock_getservent
597 # define getsockname PerlSock_getsockname
598 # define getsockopt PerlSock_getsockopt
599 # define inet_addr PerlSock_inet_addr
600 # define inet_ntoa PerlSock_inet_ntoa
601 # define listen PerlSock_listen
602 # define recv PerlSock_recv
603 # define recvfrom PerlSock_recvfrom
604 # define select PerlSock_select
605 # define send PerlSock_send
606 # define sendto PerlSock_sendto
607 # define sethostent PerlSock_sethostent
608 # define setnetent PerlSock_setnetent
609 # define setprotoent PerlSock_setprotoent
610 # define setservent PerlSock_setservent
611 # define setsockopt PerlSock_setsockopt
612 # define shutdown PerlSock_shutdown
613 # define socket PerlSock_socket
614 # define socketpair PerlSock_socketpair
615 # endif /* NETWARE && USE_STDIO */
617 # ifdef USE_SOCKETS_AS_HANDLES
623 # define fd_set Perl_fd_set
624 # define FD_SET(n,p) PERL_FD_SET(n,p)
625 # define FD_CLR(n,p) PERL_FD_CLR(n,p)
626 # define FD_ISSET(n,p) PERL_FD_ISSET(n,p)
627 # define FD_ZERO(p) PERL_FD_ZERO(p)
628 # endif /* USE_SOCKETS_AS_HANDLES */
630 # endif /* NO_XSLOCKS */
631 #endif /* PERL_IMPLICIT_SYS && !PERL_CORE */
633 #endif /* _INC_PERL_XSUB_H */ /* include guard */
637 * c-indentation-style: bsd
639 * indent-tabs-mode: t
642 * ex: set ts=8 sts=4 sw=4 noet: