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 = MARK - PL_stack_base + 1
122 register SV **mark = PL_stack_base + ax++
124 #define dITEMS I32 items = 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)(...)
148 # define XSINTERFACE_CVT(ret,name) ret (*name)()
150 #define dXSFUNCTION(ret) XSINTERFACE_CVT(ret,XSFUNCTION)
151 #define XSINTERFACE_FUNC(ret,cv,f) ((XSINTERFACE_CVT(ret,))(f))
152 #define XSINTERFACE_FUNC_SET(cv,f) \
153 CvXSUBANY(cv).any_dxptr = (void (*) (pTHX_ void*))(f)
155 #define dUNDERBAR PADOFFSET padoff_du = find_rundefsvoffset()
156 #define UNDERBAR ((padoff_du == NOT_IN_PAD \
157 || PAD_COMPNAME_FLAGS_isOUR(padoff_du)) \
158 ? DEFSV : PAD_SVl(padoff_du))
160 /* Simple macros to put new mortal values onto the stack. */
161 /* Typically used to return values from XS functions. */
164 =head1 Stack Manipulation Macros
166 =for apidoc Am|void|XST_mIV|int pos|IV iv
167 Place an integer into the specified position C<pos> on the stack. The
168 value is stored in a new mortal SV.
170 =for apidoc Am|void|XST_mNV|int pos|NV nv
171 Place a double into the specified position C<pos> on the stack. The value
172 is stored in a new mortal SV.
174 =for apidoc Am|void|XST_mPV|int pos|char* str
175 Place a copy of a string into the specified position C<pos> on the stack.
176 The value is stored in a new mortal SV.
178 =for apidoc Am|void|XST_mNO|int pos
179 Place C<&PL_sv_no> into the specified position C<pos> on the
182 =for apidoc Am|void|XST_mYES|int pos
183 Place C<&PL_sv_yes> into the specified position C<pos> on the
186 =for apidoc Am|void|XST_mUNDEF|int pos
187 Place C<&PL_sv_undef> into the specified position C<pos> on the
190 =for apidoc Am|void|XSRETURN|int nitems
191 Return from XSUB, indicating number of items on the stack. This is usually
192 handled by C<xsubpp>.
194 =for apidoc Am|void|XSRETURN_IV|IV iv
195 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
197 =for apidoc Am|void|XSRETURN_UV|IV uv
198 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
200 =for apidoc Am|void|XSRETURN_NV|NV nv
201 Return a double from an XSUB immediately. Uses C<XST_mNV>.
203 =for apidoc Am|void|XSRETURN_PV|char* str
204 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
206 =for apidoc Ams||XSRETURN_NO
207 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
209 =for apidoc Ams||XSRETURN_YES
210 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
212 =for apidoc Ams||XSRETURN_UNDEF
213 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
215 =for apidoc Ams||XSRETURN_EMPTY
216 Return an empty list from an XSUB immediately.
218 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
220 =for apidoc AmU||newXSproto|char* name|XSUBADDR_t f|char* filename|const char *proto
221 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
224 =for apidoc AmU||XS_VERSION
225 The version identifier for an XS module. This is usually
226 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
228 =for apidoc Ams||XS_VERSION_BOOTCHECK
229 Macro to verify that a PM module's $VERSION variable matches the XS
230 module's C<XS_VERSION> variable. This is usually handled automatically by
231 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
233 =head1 Simple Exception Handling Macros
235 =for apidoc Ams||dXCPT
236 Set up necessary local variables for exception handling.
237 See L<perlguts/"Exception Handling">.
239 =for apidoc AmU||XCPT_TRY_START
240 Starts a try block. See L<perlguts/"Exception Handling">.
242 =for apidoc AmU||XCPT_TRY_END
243 Ends a try block. See L<perlguts/"Exception Handling">.
245 =for apidoc AmU||XCPT_CATCH
246 Introduces a catch block. See L<perlguts/"Exception Handling">.
248 =for apidoc Ams||XCPT_RETHROW
249 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
254 #define XST_mIV(i,v) (ST(i) = sv_2mortal(newSViv(v)) )
255 #define XST_mUV(i,v) (ST(i) = sv_2mortal(newSVuv(v)) )
256 #define XST_mNV(i,v) (ST(i) = sv_2mortal(newSVnv(v)) )
257 #define XST_mPV(i,v) (ST(i) = sv_2mortal(newSVpv(v,0)))
258 #define XST_mPVN(i,v,n) (ST(i) = sv_2mortal(newSVpvn(v,n)))
259 #define XST_mNO(i) (ST(i) = &PL_sv_no )
260 #define XST_mYES(i) (ST(i) = &PL_sv_yes )
261 #define XST_mUNDEF(i) (ST(i) = &PL_sv_undef)
263 #define XSRETURN(off) \
265 IV tmpXSoff = (off); \
266 PL_stack_sp = PL_stack_base + ax + (tmpXSoff - 1); \
270 #define XSRETURN_IV(v) STMT_START { XST_mIV(0,v); XSRETURN(1); } STMT_END
271 #define XSRETURN_UV(v) STMT_START { XST_mUV(0,v); XSRETURN(1); } STMT_END
272 #define XSRETURN_NV(v) STMT_START { XST_mNV(0,v); XSRETURN(1); } STMT_END
273 #define XSRETURN_PV(v) STMT_START { XST_mPV(0,v); XSRETURN(1); } STMT_END
274 #define XSRETURN_PVN(v,n) STMT_START { XST_mPVN(0,v,n); XSRETURN(1); } STMT_END
275 #define XSRETURN_NO STMT_START { XST_mNO(0); XSRETURN(1); } STMT_END
276 #define XSRETURN_YES STMT_START { XST_mYES(0); XSRETURN(1); } STMT_END
277 #define XSRETURN_UNDEF STMT_START { XST_mUNDEF(0); XSRETURN(1); } STMT_END
278 #define XSRETURN_EMPTY STMT_START { XSRETURN(0); } STMT_END
280 #define newXSproto(a,b,c,d) newXS_flags(a,b,c,d,0)
283 # define XS_VERSION_BOOTCHECK \
286 const char *vn = NULL, *module = SvPV_nolen_const(ST(0)); \
287 if (items >= 2) /* version supplied as bootstrap arg */ \
290 /* XXX GV_ADDWARN */ \
291 _sv = get_sv(Perl_form(aTHX_ "%s::%s", module, \
292 vn = "XS_VERSION"), FALSE); \
293 if (!_sv || !SvOK(_sv)) \
294 _sv = get_sv(Perl_form(aTHX_ "%s::%s", module, \
295 vn = "VERSION"), FALSE); \
298 SV *xssv = Perl_newSVpv(aTHX_ XS_VERSION, 0); \
299 xssv = new_version(xssv); \
300 if ( !sv_derived_from(_sv, "version") ) \
301 _sv = new_version(_sv); \
302 if ( vcmp(_sv,xssv) ) \
303 Perl_croak(aTHX_ "%s object version %"SVf" does not match %s%s%s%s %"SVf,\
304 module, SVfARG(vstringify(xssv)), \
305 vn ? "$" : "", vn ? module : "", vn ? "::" : "", \
306 vn ? vn : "bootstrap parameter", SVfARG(vstringify(_sv)));\
310 # define XS_VERSION_BOOTCHECK
314 # define dXCPT dJMPENV; int rEtV = 0
315 # define XCPT_TRY_START JMPENV_PUSH(rEtV); if (rEtV == 0)
316 # define XCPT_TRY_END JMPENV_POP;
317 # define XCPT_CATCH if (rEtV != 0)
318 # define XCPT_RETHROW JMPENV_JUMP(rEtV)
322 The DBM_setFilter & DBM_ckFilter macros are only used by
323 the *DB*_File modules
326 #define DBM_setFilter(db_type,code) \
329 RETVAL = sv_mortalcopy(db_type) ; \
331 if (db_type && (code == &PL_sv_undef)) { \
332 SvREFCNT_dec(db_type) ; \
337 sv_setsv(db_type, code) ; \
339 db_type = newSVsv(code) ; \
343 #define DBM_ckFilter(arg,type,name) \
346 if (db->filtering) { \
347 croak("recursion detected in %s", name) ; \
351 SAVEINT(db->filtering) ; \
352 db->filtering = TRUE ; \
354 if (name[7] == 's') \
355 arg = newSVsv(arg); \
360 (void) perl_call_sv(db->type, G_DISCARD); \
365 if (name[7] == 's'){ \
366 arg = sv_2mortal(arg); \
370 #if 1 /* for compatibility */
371 # define VTBL_sv &PL_vtbl_sv
372 # define VTBL_env &PL_vtbl_env
373 # define VTBL_envelem &PL_vtbl_envelem
374 # define VTBL_sig &PL_vtbl_sig
375 # define VTBL_sigelem &PL_vtbl_sigelem
376 # define VTBL_pack &PL_vtbl_pack
377 # define VTBL_packelem &PL_vtbl_packelem
378 # define VTBL_dbline &PL_vtbl_dbline
379 # define VTBL_isa &PL_vtbl_isa
380 # define VTBL_isaelem &PL_vtbl_isaelem
381 # define VTBL_arylen &PL_vtbl_arylen
382 # define VTBL_glob &PL_vtbl_glob
383 # define VTBL_mglob &PL_vtbl_mglob
384 # define VTBL_nkeys &PL_vtbl_nkeys
385 # define VTBL_taint &PL_vtbl_taint
386 # define VTBL_substr &PL_vtbl_substr
387 # define VTBL_vec &PL_vtbl_vec
388 # define VTBL_pos &PL_vtbl_pos
389 # define VTBL_bm &PL_vtbl_bm
390 # define VTBL_fm &PL_vtbl_fm
391 # define VTBL_uvar &PL_vtbl_uvar
392 # define VTBL_defelem &PL_vtbl_defelem
393 # define VTBL_regexp &PL_vtbl_regexp
394 # define VTBL_regdata &PL_vtbl_regdata
395 # define VTBL_regdatum &PL_vtbl_regdatum
396 # ifdef USE_LOCALE_COLLATE
397 # define VTBL_collxfrm &PL_vtbl_collxfrm
399 # define VTBL_amagic &PL_vtbl_amagic
400 # define VTBL_amagicelem &PL_vtbl_amagicelem
407 # define PL_madskills 0
411 #if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_NO_GET_CONTEXT) && !defined(PERL_CORE)
414 # define aTHX PERL_GET_THX
418 #if defined(PERL_IMPLICIT_SYS) && !defined(PERL_CORE)
420 # if defined (NETWARE) && defined (USE_STDIO)
421 # define times PerlProc_times
422 # define setuid PerlProc_setuid
423 # define setgid PerlProc_setgid
424 # define getpid PerlProc_getpid
425 # define pause PerlProc_pause
426 # define exit PerlProc_exit
427 # define _exit PerlProc__exit
444 /* Following symbols were giving redefinition errors while building extensions - sgp 17th Oct 2000 */
454 # undef gethostbyaddr
455 # undef gethostbyname
460 # undef getprotobyname
461 # undef getprotobynumber
463 # undef getservbyname
464 # undef getservbyport
475 # define mkdir PerlDir_mkdir
476 # define chdir PerlDir_chdir
477 # define rmdir PerlDir_rmdir
478 # define closedir PerlDir_close
479 # define opendir PerlDir_open
480 # define readdir PerlDir_read
481 # define rewinddir PerlDir_rewind
482 # define seekdir PerlDir_seek
483 # define telldir PerlDir_tell
484 # define putenv PerlEnv_putenv
485 # define getenv PerlEnv_getenv
486 # define uname PerlEnv_uname
487 # define stdin PerlSIO_stdin
488 # define stdout PerlSIO_stdout
489 # define stderr PerlSIO_stderr
490 # define fopen PerlSIO_fopen
491 # define fclose PerlSIO_fclose
492 # define feof PerlSIO_feof
493 # define ferror PerlSIO_ferror
494 # define clearerr PerlSIO_clearerr
495 # define getc PerlSIO_getc
496 # define fputc PerlSIO_fputc
497 # define fputs PerlSIO_fputs
498 # define fflush PerlSIO_fflush
499 # define ungetc PerlSIO_ungetc
500 # define fileno PerlSIO_fileno
501 # define fdopen PerlSIO_fdopen
502 # define freopen PerlSIO_freopen
503 # define fread PerlSIO_fread
504 # define fwrite PerlSIO_fwrite
505 # define setbuf PerlSIO_setbuf
506 # define setvbuf PerlSIO_setvbuf
507 # define setlinebuf PerlSIO_setlinebuf
508 # define stdoutf PerlSIO_stdoutf
509 # define vfprintf PerlSIO_vprintf
510 # define ftell PerlSIO_ftell
511 # define fseek PerlSIO_fseek
512 # define fgetpos PerlSIO_fgetpos
513 # define fsetpos PerlSIO_fsetpos
514 # define frewind PerlSIO_rewind
515 # define tmpfile PerlSIO_tmpfile
516 # define access PerlLIO_access
517 # define chmod PerlLIO_chmod
518 # define chsize PerlLIO_chsize
519 # define close PerlLIO_close
520 # define dup PerlLIO_dup
521 # define dup2 PerlLIO_dup2
522 # define flock PerlLIO_flock
523 # define fstat PerlLIO_fstat
524 # define ioctl PerlLIO_ioctl
525 # define isatty PerlLIO_isatty
526 # define link PerlLIO_link
527 # define lseek PerlLIO_lseek
528 # define lstat PerlLIO_lstat
529 # define mktemp PerlLIO_mktemp
530 # define open PerlLIO_open
531 # define read PerlLIO_read
532 # define rename PerlLIO_rename
533 # define setmode PerlLIO_setmode
534 # define stat(buf,sb) PerlLIO_stat(buf,sb)
535 # define tmpnam PerlLIO_tmpnam
536 # define umask PerlLIO_umask
537 # define unlink PerlLIO_unlink
538 # define utime PerlLIO_utime
539 # define write PerlLIO_write
540 # define malloc PerlMem_malloc
541 # define realloc PerlMem_realloc
542 # define free PerlMem_free
543 # define abort PerlProc_abort
544 # define exit PerlProc_exit
545 # define _exit PerlProc__exit
546 # define execl PerlProc_execl
547 # define execv PerlProc_execv
548 # define execvp PerlProc_execvp
549 # define getuid PerlProc_getuid
550 # define geteuid PerlProc_geteuid
551 # define getgid PerlProc_getgid
552 # define getegid PerlProc_getegid
553 # define getlogin PerlProc_getlogin
554 # define kill PerlProc_kill
555 # define killpg PerlProc_killpg
556 # define pause PerlProc_pause
557 # define popen PerlProc_popen
558 # define pclose PerlProc_pclose
559 # define pipe PerlProc_pipe
560 # define setuid PerlProc_setuid
561 # define setgid PerlProc_setgid
562 # define sleep PerlProc_sleep
563 # define times PerlProc_times
564 # define wait PerlProc_wait
565 # define setjmp PerlProc_setjmp
566 # define longjmp PerlProc_longjmp
567 # define signal PerlProc_signal
568 # define getpid PerlProc_getpid
569 # define gettimeofday PerlProc_gettimeofday
570 # define htonl PerlSock_htonl
571 # define htons PerlSock_htons
572 # define ntohl PerlSock_ntohl
573 # define ntohs PerlSock_ntohs
574 # define accept PerlSock_accept
575 # define bind PerlSock_bind
576 # define connect PerlSock_connect
577 # define endhostent PerlSock_endhostent
578 # define endnetent PerlSock_endnetent
579 # define endprotoent PerlSock_endprotoent
580 # define endservent PerlSock_endservent
581 # define gethostbyaddr PerlSock_gethostbyaddr
582 # define gethostbyname PerlSock_gethostbyname
583 # define gethostent PerlSock_gethostent
584 # define gethostname PerlSock_gethostname
585 # define getnetbyaddr PerlSock_getnetbyaddr
586 # define getnetbyname PerlSock_getnetbyname
587 # define getnetent PerlSock_getnetent
588 # define getpeername PerlSock_getpeername
589 # define getprotobyname PerlSock_getprotobyname
590 # define getprotobynumber PerlSock_getprotobynumber
591 # define getprotoent PerlSock_getprotoent
592 # define getservbyname PerlSock_getservbyname
593 # define getservbyport PerlSock_getservbyport
594 # define getservent PerlSock_getservent
595 # define getsockname PerlSock_getsockname
596 # define getsockopt PerlSock_getsockopt
597 # define inet_addr PerlSock_inet_addr
598 # define inet_ntoa PerlSock_inet_ntoa
599 # define listen PerlSock_listen
600 # define recv PerlSock_recv
601 # define recvfrom PerlSock_recvfrom
602 # define select PerlSock_select
603 # define send PerlSock_send
604 # define sendto PerlSock_sendto
605 # define sethostent PerlSock_sethostent
606 # define setnetent PerlSock_setnetent
607 # define setprotoent PerlSock_setprotoent
608 # define setservent PerlSock_setservent
609 # define setsockopt PerlSock_setsockopt
610 # define shutdown PerlSock_shutdown
611 # define socket PerlSock_socket
612 # define socketpair PerlSock_socketpair
613 # endif /* NETWARE && USE_STDIO */
615 # ifdef USE_SOCKETS_AS_HANDLES
621 # define fd_set Perl_fd_set
622 # define FD_SET(n,p) PERL_FD_SET(n,p)
623 # define FD_CLR(n,p) PERL_FD_CLR(n,p)
624 # define FD_ISSET(n,p) PERL_FD_ISSET(n,p)
625 # define FD_ZERO(p) PERL_FD_ZERO(p)
626 # endif /* USE_SOCKETS_AS_HANDLES */
628 # endif /* NO_XSLOCKS */
629 #endif /* PERL_IMPLICIT_SYS && !PERL_CORE */
631 #endif /* _INC_PERL_XSUB_H */ /* include guard */
635 * c-indentation-style: bsd
637 * indent-tabs-mode: t
640 * ex: set ts=8 sts=4 sw=4 noet: