3 * Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999,
4 * 2000, 2001, 2002, 2003, 2004, 2005, 2006 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. (Lexical $_ is available in perl 5.9.2 and later)
85 #ifndef PERL_UNUSED_ARG
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)]
99 #if defined(__CYGWIN__) && defined(USE_DYNAMIC_LOADING)
100 # define XS(name) __declspec(dllexport) void name(pTHX_ CV* cv)
102 # ifdef HASATTRIBUTE_UNUSED
103 # define XS(name) void name(pTHX_ CV* cv __attribute__unused__)
105 # define XS(name) void name(pTHX_ CV* cv)
109 #define dAX const I32 ax = MARK - PL_stack_base + 1
113 register SV **mark = PL_stack_base + ax++
115 #define dITEMS I32 items = SP - MARK
119 NOTE(ARGUNUSED(cv)) \
126 #define dXSTARG SV * const targ = ((PL_op->op_private & OPpENTERSUB_HASTARG) \
127 ? PAD_SV(PL_op->op_targ) : sv_newmortal())
129 /* Should be used before final PUSHi etc. if not in PPCODE section. */
130 #define XSprePUSH (sp = PL_stack_base + ax - 1)
132 #define XSANY CvXSUBANY(cv)
134 #define dXSI32 I32 ix = XSANY.any_i32
137 # define XSINTERFACE_CVT(ret,name) ret (*name)(...)
139 # define XSINTERFACE_CVT(ret,name) ret (*name)()
141 #define dXSFUNCTION(ret) XSINTERFACE_CVT(ret,XSFUNCTION)
142 #define XSINTERFACE_FUNC(ret,cv,f) ((XSINTERFACE_CVT(ret,))(f))
143 #define XSINTERFACE_FUNC_SET(cv,f) \
144 CvXSUBANY(cv).any_dxptr = (void (*) (pTHX_ void*))(f)
146 #define dUNDERBAR dNOOP
147 #define UNDERBAR DEFSV
149 /* Simple macros to put new mortal values onto the stack. */
150 /* Typically used to return values from XS functions. */
153 =head1 Stack Manipulation Macros
155 =for apidoc Am|void|XST_mIV|int pos|IV iv
156 Place an integer into the specified position C<pos> on the stack. The
157 value is stored in a new mortal SV.
159 =for apidoc Am|void|XST_mNV|int pos|NV nv
160 Place a double into the specified position C<pos> on the stack. The value
161 is stored in a new mortal SV.
163 =for apidoc Am|void|XST_mPV|int pos|char* str
164 Place a copy of a string into the specified position C<pos> on the stack.
165 The value is stored in a new mortal SV.
167 =for apidoc Am|void|XST_mNO|int pos
168 Place C<&PL_sv_no> into the specified position C<pos> on the
171 =for apidoc Am|void|XST_mYES|int pos
172 Place C<&PL_sv_yes> into the specified position C<pos> on the
175 =for apidoc Am|void|XST_mUNDEF|int pos
176 Place C<&PL_sv_undef> into the specified position C<pos> on the
179 =for apidoc Am|void|XSRETURN|int nitems
180 Return from XSUB, indicating number of items on the stack. This is usually
181 handled by C<xsubpp>.
183 =for apidoc Am|void|XSRETURN_IV|IV iv
184 Return an integer from an XSUB immediately. Uses C<XST_mIV>.
186 =for apidoc Am|void|XSRETURN_UV|IV uv
187 Return an integer from an XSUB immediately. Uses C<XST_mUV>.
189 =for apidoc Am|void|XSRETURN_NV|NV nv
190 Return a double from an XSUB immediately. Uses C<XST_mNV>.
192 =for apidoc Am|void|XSRETURN_PV|char* str
193 Return a copy of a string from an XSUB immediately. Uses C<XST_mPV>.
195 =for apidoc Ams||XSRETURN_NO
196 Return C<&PL_sv_no> from an XSUB immediately. Uses C<XST_mNO>.
198 =for apidoc Ams||XSRETURN_YES
199 Return C<&PL_sv_yes> from an XSUB immediately. Uses C<XST_mYES>.
201 =for apidoc Ams||XSRETURN_UNDEF
202 Return C<&PL_sv_undef> from an XSUB immediately. Uses C<XST_mUNDEF>.
204 =for apidoc Ams||XSRETURN_EMPTY
205 Return an empty list from an XSUB immediately.
207 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
209 =for apidoc AmU||newXSproto|char* name|XSUBADDR_t f|char* filename|const char *proto
210 Used by C<xsubpp> to hook up XSUBs as Perl subs. Adds Perl prototypes to
213 =for apidoc AmU||XS_VERSION
214 The version identifier for an XS module. This is usually
215 handled automatically by C<ExtUtils::MakeMaker>. See C<XS_VERSION_BOOTCHECK>.
217 =for apidoc Ams||XS_VERSION_BOOTCHECK
218 Macro to verify that a PM module's $VERSION variable matches the XS
219 module's C<XS_VERSION> variable. This is usually handled automatically by
220 C<xsubpp>. See L<perlxs/"The VERSIONCHECK: Keyword">.
222 =head1 Simple Exception Handling Macros
224 =for apidoc Ams||dXCPT
225 Set up necessary local variables for exception handling.
226 See L<perlguts/"Exception Handling">.
228 =for apidoc AmU||XCPT_TRY_START
229 Starts a try block. See L<perlguts/"Exception Handling">.
231 =for apidoc AmU||XCPT_TRY_END
232 Ends a try block. See L<perlguts/"Exception Handling">.
234 =for apidoc AmU||XCPT_CATCH
235 Introduces a catch block. See L<perlguts/"Exception Handling">.
237 =for apidoc Ams||XCPT_RETHROW
238 Rethrows a previously caught exception. See L<perlguts/"Exception Handling">.
243 #define XST_mIV(i,v) (ST(i) = sv_2mortal(newSViv(v)) )
244 #define XST_mUV(i,v) (ST(i) = sv_2mortal(newSVuv(v)) )
245 #define XST_mNV(i,v) (ST(i) = sv_2mortal(newSVnv(v)) )
246 #define XST_mPV(i,v) (ST(i) = sv_2mortal(newSVpv(v,0)))
247 #define XST_mPVN(i,v,n) (ST(i) = sv_2mortal(newSVpvn(v,n)))
248 #define XST_mNO(i) (ST(i) = &PL_sv_no )
249 #define XST_mYES(i) (ST(i) = &PL_sv_yes )
250 #define XST_mUNDEF(i) (ST(i) = &PL_sv_undef)
252 #define XSRETURN(off) \
254 IV tmpXSoff = (off); \
255 PL_stack_sp = PL_stack_base + ax + (tmpXSoff - 1); \
259 #define XSRETURN_IV(v) STMT_START { XST_mIV(0,v); XSRETURN(1); } STMT_END
260 #define XSRETURN_UV(v) STMT_START { XST_mUV(0,v); XSRETURN(1); } STMT_END
261 #define XSRETURN_NV(v) STMT_START { XST_mNV(0,v); XSRETURN(1); } STMT_END
262 #define XSRETURN_PV(v) STMT_START { XST_mPV(0,v); XSRETURN(1); } STMT_END
263 #define XSRETURN_PVN(v,n) STMT_START { XST_mPVN(0,v,n); XSRETURN(1); } STMT_END
264 #define XSRETURN_NO STMT_START { XST_mNO(0); XSRETURN(1); } STMT_END
265 #define XSRETURN_YES STMT_START { XST_mYES(0); XSRETURN(1); } STMT_END
266 #define XSRETURN_UNDEF STMT_START { XST_mUNDEF(0); XSRETURN(1); } STMT_END
267 #define XSRETURN_EMPTY STMT_START { XSRETURN(0); } STMT_END
269 #define newXSproto(a,b,c,d) sv_setpv((SV*)newXS(a,b,c), d)
272 # define XS_VERSION_BOOTCHECK \
275 const char *vn = NULL, *module = SvPV_nolen_const(ST(0)); \
276 if (items >= 2) /* version supplied as bootstrap arg */ \
279 /* XXX GV_ADDWARN */ \
280 _sv = get_sv(Perl_form(aTHX_ "%s::%s", module, \
281 vn = "XS_VERSION"), FALSE); \
282 if (!_sv || !SvOK(_sv)) \
283 _sv = get_sv(Perl_form(aTHX_ "%s::%s", module, \
284 vn = "VERSION"), FALSE); \
286 if (_sv && (!SvOK(_sv) || strNE(XS_VERSION, SvPV_nolen_const(_sv)))) \
287 Perl_croak(aTHX_ "%s object version %s does not match %s%s%s%s %"SVf,\
288 module, XS_VERSION, \
289 vn ? "$" : "", vn ? module : "", vn ? "::" : "", \
290 vn ? vn : "bootstrap parameter", _sv); \
293 # define XS_VERSION_BOOTCHECK
297 # define dXCPT dJMPENV; int rEtV = 0
298 # define XCPT_TRY_START JMPENV_PUSH(rEtV); if (rEtV == 0)
299 # define XCPT_TRY_END JMPENV_POP;
300 # define XCPT_CATCH if (rEtV != 0)
301 # define XCPT_RETHROW JMPENV_JUMP(rEtV)
305 The DBM_setFilter & DBM_ckFilter macros are only used by
306 the *DB*_File modules
309 #define DBM_setFilter(db_type,code) \
312 RETVAL = sv_mortalcopy(db_type) ; \
314 if (db_type && (code == &PL_sv_undef)) { \
315 SvREFCNT_dec(db_type) ; \
320 sv_setsv(db_type, code) ; \
322 db_type = newSVsv(code) ; \
326 #define DBM_ckFilter(arg,type,name) \
329 if (db->filtering) { \
330 croak("recursion detected in %s", name) ; \
334 SAVEINT(db->filtering) ; \
335 db->filtering = TRUE ; \
337 if (name[7] == 's') \
338 arg = newSVsv(arg); \
343 (void) perl_call_sv(db->type, G_DISCARD); \
348 if (name[7] == 's'){ \
349 arg = sv_2mortal(arg); \
354 #if 1 /* for compatibility */
355 # define VTBL_sv &PL_vtbl_sv
356 # define VTBL_env &PL_vtbl_env
357 # define VTBL_envelem &PL_vtbl_envelem
358 # define VTBL_sig &PL_vtbl_sig
359 # define VTBL_sigelem &PL_vtbl_sigelem
360 # define VTBL_pack &PL_vtbl_pack
361 # define VTBL_packelem &PL_vtbl_packelem
362 # define VTBL_dbline &PL_vtbl_dbline
363 # define VTBL_isa &PL_vtbl_isa
364 # define VTBL_isaelem &PL_vtbl_isaelem
365 # define VTBL_arylen &PL_vtbl_arylen
366 # define VTBL_glob &PL_vtbl_glob
367 # define VTBL_mglob &PL_vtbl_mglob
368 # define VTBL_nkeys &PL_vtbl_nkeys
369 # define VTBL_taint &PL_vtbl_taint
370 # define VTBL_substr &PL_vtbl_substr
371 # define VTBL_vec &PL_vtbl_vec
372 # define VTBL_pos &PL_vtbl_pos
373 # define VTBL_bm &PL_vtbl_bm
374 # define VTBL_fm &PL_vtbl_fm
375 # define VTBL_uvar &PL_vtbl_uvar
376 # define VTBL_defelem &PL_vtbl_defelem
377 # define VTBL_regexp &PL_vtbl_regexp
378 # define VTBL_regdata &PL_vtbl_regdata
379 # define VTBL_regdatum &PL_vtbl_regdatum
380 # ifdef USE_LOCALE_COLLATE
381 # define VTBL_collxfrm &PL_vtbl_collxfrm
383 # define VTBL_amagic &PL_vtbl_amagic
384 # define VTBL_amagicelem &PL_vtbl_amagicelem
389 #if defined(PERL_IMPLICIT_CONTEXT) && !defined(PERL_NO_GET_CONTEXT) && !defined(PERL_CORE)
392 # define aTHX PERL_GET_THX
396 #if defined(PERL_IMPLICIT_SYS) && !defined(PERL_CORE)
398 # if defined (NETWARE) && defined (USE_STDIO)
399 # define times PerlProc_times
400 # define setuid PerlProc_setuid
401 # define setgid PerlProc_setgid
402 # define getpid PerlProc_getpid
403 # define pause PerlProc_pause
404 # define exit PerlProc_exit
405 # define _exit PerlProc__exit
422 /* Following symbols were giving redefinition errors while building extensions - sgp 17th Oct 2000 */
432 # undef gethostbyaddr
433 # undef gethostbyname
438 # undef getprotobyname
439 # undef getprotobynumber
441 # undef getservbyname
442 # undef getservbyport
453 # define mkdir PerlDir_mkdir
454 # define chdir PerlDir_chdir
455 # define rmdir PerlDir_rmdir
456 # define closedir PerlDir_close
457 # define opendir PerlDir_open
458 # define readdir PerlDir_read
459 # define rewinddir PerlDir_rewind
460 # define seekdir PerlDir_seek
461 # define telldir PerlDir_tell
462 # define putenv PerlEnv_putenv
463 # define getenv PerlEnv_getenv
464 # define uname PerlEnv_uname
465 # define stdin PerlSIO_stdin
466 # define stdout PerlSIO_stdout
467 # define stderr PerlSIO_stderr
468 # define fopen PerlSIO_fopen
469 # define fclose PerlSIO_fclose
470 # define feof PerlSIO_feof
471 # define ferror PerlSIO_ferror
472 # define clearerr PerlSIO_clearerr
473 # define getc PerlSIO_getc
474 # define fputc PerlSIO_fputc
475 # define fputs PerlSIO_fputs
476 # define fflush PerlSIO_fflush
477 # define ungetc PerlSIO_ungetc
478 # define fileno PerlSIO_fileno
479 # define fdopen PerlSIO_fdopen
480 # define freopen PerlSIO_freopen
481 # define fread PerlSIO_fread
482 # define fwrite PerlSIO_fwrite
483 # define setbuf PerlSIO_setbuf
484 # define setvbuf PerlSIO_setvbuf
485 # define setlinebuf PerlSIO_setlinebuf
486 # define stdoutf PerlSIO_stdoutf
487 # define vfprintf PerlSIO_vprintf
488 # define ftell PerlSIO_ftell
489 # define fseek PerlSIO_fseek
490 # define fgetpos PerlSIO_fgetpos
491 # define fsetpos PerlSIO_fsetpos
492 # define frewind PerlSIO_rewind
493 # define tmpfile PerlSIO_tmpfile
494 # define access PerlLIO_access
495 # define chmod PerlLIO_chmod
496 # define chsize PerlLIO_chsize
497 # define close PerlLIO_close
498 # define dup PerlLIO_dup
499 # define dup2 PerlLIO_dup2
500 # define flock PerlLIO_flock
501 # define fstat PerlLIO_fstat
502 # define ioctl PerlLIO_ioctl
503 # define isatty PerlLIO_isatty
504 # define link PerlLIO_link
505 # define lseek PerlLIO_lseek
506 # define lstat PerlLIO_lstat
507 # define mktemp PerlLIO_mktemp
508 # define open PerlLIO_open
509 # define read PerlLIO_read
510 # define rename PerlLIO_rename
511 # define setmode PerlLIO_setmode
512 # define stat(buf,sb) PerlLIO_stat(buf,sb)
513 # define tmpnam PerlLIO_tmpnam
514 # define umask PerlLIO_umask
515 # define unlink PerlLIO_unlink
516 # define utime PerlLIO_utime
517 # define write PerlLIO_write
518 # define malloc PerlMem_malloc
519 # define realloc PerlMem_realloc
520 # define free PerlMem_free
521 # define abort PerlProc_abort
522 # define exit PerlProc_exit
523 # define _exit PerlProc__exit
524 # define execl PerlProc_execl
525 # define execv PerlProc_execv
526 # define execvp PerlProc_execvp
527 # define getuid PerlProc_getuid
528 # define geteuid PerlProc_geteuid
529 # define getgid PerlProc_getgid
530 # define getegid PerlProc_getegid
531 # define getlogin PerlProc_getlogin
532 # define kill PerlProc_kill
533 # define killpg PerlProc_killpg
534 # define pause PerlProc_pause
535 # define popen PerlProc_popen
536 # define pclose PerlProc_pclose
537 # define pipe PerlProc_pipe
538 # define setuid PerlProc_setuid
539 # define setgid PerlProc_setgid
540 # define sleep PerlProc_sleep
541 # define times PerlProc_times
542 # define wait PerlProc_wait
543 # define setjmp PerlProc_setjmp
544 # define longjmp PerlProc_longjmp
545 # define signal PerlProc_signal
546 # define getpid PerlProc_getpid
547 # define gettimeofday PerlProc_gettimeofday
548 # define htonl PerlSock_htonl
549 # define htons PerlSock_htons
550 # define ntohl PerlSock_ntohl
551 # define ntohs PerlSock_ntohs
552 # define accept PerlSock_accept
553 # define bind PerlSock_bind
554 # define connect PerlSock_connect
555 # define endhostent PerlSock_endhostent
556 # define endnetent PerlSock_endnetent
557 # define endprotoent PerlSock_endprotoent
558 # define endservent PerlSock_endservent
559 # define gethostbyaddr PerlSock_gethostbyaddr
560 # define gethostbyname PerlSock_gethostbyname
561 # define gethostent PerlSock_gethostent
562 # define gethostname PerlSock_gethostname
563 # define getnetbyaddr PerlSock_getnetbyaddr
564 # define getnetbyname PerlSock_getnetbyname
565 # define getnetent PerlSock_getnetent
566 # define getpeername PerlSock_getpeername
567 # define getprotobyname PerlSock_getprotobyname
568 # define getprotobynumber PerlSock_getprotobynumber
569 # define getprotoent PerlSock_getprotoent
570 # define getservbyname PerlSock_getservbyname
571 # define getservbyport PerlSock_getservbyport
572 # define getservent PerlSock_getservent
573 # define getsockname PerlSock_getsockname
574 # define getsockopt PerlSock_getsockopt
575 # define inet_addr PerlSock_inet_addr
576 # define inet_ntoa PerlSock_inet_ntoa
577 # define listen PerlSock_listen
578 # define recv PerlSock_recv
579 # define recvfrom PerlSock_recvfrom
580 # define select PerlSock_select
581 # define send PerlSock_send
582 # define sendto PerlSock_sendto
583 # define sethostent PerlSock_sethostent
584 # define setnetent PerlSock_setnetent
585 # define setprotoent PerlSock_setprotoent
586 # define setservent PerlSock_setservent
587 # define setsockopt PerlSock_setsockopt
588 # define shutdown PerlSock_shutdown
589 # define socket PerlSock_socket
590 # define socketpair PerlSock_socketpair
591 # endif /* NETWARE && USE_STDIO */
593 # ifdef USE_SOCKETS_AS_HANDLES
599 # define fd_set Perl_fd_set
600 # define FD_SET(n,p) PERL_FD_SET(n,p)
601 # define FD_CLR(n,p) PERL_FD_CLR(n,p)
602 # define FD_ISSET(n,p) PERL_FD_ISSET(n,p)
603 # define FD_ZERO(p) PERL_FD_ZERO(p)
604 # endif /* USE_SOCKETS_AS_HANDLES */
606 # endif /* NO_XSLOCKS */
607 #endif /* PERL_IMPLICIT_SYS && !PERL_CORE */
609 #endif /* _INC_PERL_XSUB_H */ /* include guard */
613 * c-indentation-style: bsd
615 * indent-tabs-mode: t
618 * ex: set ts=8 sts=4 sw=4 noet: