perlapi - autogenerated documentation for the perl public API
This file contains the documentation of the perl public API generated by embed.pl, specifically a listing of functions, macros, flags, and variables that may be used by extension writers. The interfaces of any functions that are not listed here are subject to change without notice. For this reason, blindly using functions listed in proto.h is to be avoided when writing extensions.
Note that all Perl API global variables must be referenced with thePL_ prefix. Some macros are provided for compatibility with the older, unadorned names, but this support may be disabled in a future release.
The listing is alphabetical, case insensitive.
Same asav_len(). Deprecated, useav_len() instead.
intAvFILL(AV* av)Clears an array, making it empty. Does not free the memory used by the array itself.
voidav_clear(AV* ar)Deletes the element indexed bykey from the array. Returns the deleted element.flags is currently ignored.
SV*av_delete(AV* ar, I32 key, I32 flags)Returns true if the element indexed bykey has been initialized.
This relies on the fact that uninitialized array elements are set to&PL_sv_undef.
boolav_exists(AV* ar, I32 key)Pre-extend an array. Thekey is the index to which the array should be extended.
voidav_extend(AV* ar, I32 key)Returns the SV at the specified index in the array. Thekey is the index. Iflval is set then the fetch will be part of a store. Check that the return value is non-null before dereferencing it to aSV*.
See"Understanding the Magic of Tied Hashes and Arrays" in perlguts for more information on how to use this function on tied arrays.
SV**av_fetch(AV* ar, I32 key, I32 lval)Ensure than an array has a given number of elements, equivalent to Perl's$#array = $fill;.
voidav_fill(AV* ar, I32 fill)Returns the highest index in the array. Returns -1 if the array is empty.
I32av_len(AV* ar)Creates a new AV and populates it with a list of SVs. The SVs are copied into the array, so they may be freed after the call to av_make. The new AV will have a reference count of 1.
AV*av_make(I32 size, SV** svp)Pops an SV off the end of the array. Returns&PL_sv_undef if the array is empty.
SV*av_pop(AV* ar)Pushes an SV onto the end of the array. The array will grow automatically to accommodate the addition.
voidav_push(AV* ar, SV* val)Shifts an SV off the beginning of the array.
SV*av_shift(AV* ar)Stores an SV in an array. The array index is specified askey. The return value will be NULL if the operation failed or if the value did not need to be actually stored within the array (as in the case of tied arrays). Otherwise it can be dereferenced to get the originalSV*. Note that the caller is responsible for suitably incrementing the reference count ofval before the call, and decrementing it if the function returned NULL.
See"Understanding the Magic of Tied Hashes and Arrays" in perlguts for more information on how to use this function on tied arrays.
SV**av_store(AV* ar, I32 key, SV* val)Undefines the array. Frees the memory used by the array itself.
voidav_undef(AV* ar)Unshift the given number ofundef values onto the beginning of the array. The array will grow automatically to accommodate the addition. You must then useav_store to assign values to these new elements.
voidav_unshift(AV* ar, I32 num)Converts a strings of lengthlen from UTF8 into byte encoding. Unlike <utf8_to_bytes> but likebytes_to_utf8, returns a pointer to the newly-created string, and updateslen to contain the new length. Returns the original string if no conversion occurs,len is unchanged. Do nothing ifis_utf8 points to 0. Setsis_utf8 to 0 ifs is converted or contains all 7bit characters.
NOTE: this function is experimental and may change or be removed without notice.
U8*bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8)Converts a strings of lengthlen from ASCII into UTF8 encoding. Returns a pointer to the newly-created string, and setslen to reflect the new length.
NOTE: this function is experimental and may change or be removed without notice.
U8*bytes_to_utf8(U8 *s, STRLEN *len)Performs a callback to the specified Perl sub. Seeperlcall.
NOTE: the perl_ form of this function is deprecated.
I32call_argv(const char* sub_name, I32 flags, char** argv)Performs a callback to the specified Perl method. The blessed object must be on the stack. Seeperlcall.
NOTE: the perl_ form of this function is deprecated.
I32call_method(const char* methname, I32 flags)Performs a callback to the specified Perl sub. Seeperlcall.
NOTE: the perl_ form of this function is deprecated.
I32call_pv(const char* sub_name, I32 flags)Performs a callback to the Perl sub whose name is in the SV. Seeperlcall.
NOTE: the perl_ form of this function is deprecated.
I32call_sv(SV* sv, I32 flags)Variable which is setup byxsubpp to indicate the class name for a C++ XS constructor. This is always achar*. SeeTHIS.
char*CLASSThe XSUB-writer's interface to the Cmemcpy function. Thesrc is the source,dest is the destination,nitems is the number of items, andtype is the type. May fail on overlapping copies. See alsoMove.
voidCopy(void* src, void* dest, int nitems, type)This is the XSUB-writer's interface to Perl'sdie function. Normally use this function the same way you use the Cprintf function. Seewarn.
If you want to throw an exception object, assign the object to$@ and then passNullch to croak():
errsv = get_sv("@", TRUE); sv_setsv(errsv, exception_object); croak(Nullch);voidcroak(const char* pat, ...)Returns the stash of the CV.
HV*CvSTASH(CV* cv)Declare a stack marker variable,mark, for the XSUB. SeeMARK anddORIGMARK.
dMARK;Saves the original stack mark for the XSUB. SeeORIGMARK.
dORIGMARK;Declares a local copy of perl's stack pointer for the XSUB, available via theSP macro. SeeSP.
dSP;Sets up stack and mark pointers for an XSUB, calling dSP and dMARK. This is usually handled automatically byxsubpp. Declares theitems variable to indicate the number of items on the stack.
dXSARGS;Sets up theix variable for an XSUB which has aliases. This is usually handled automatically byxsubpp.
dXSI32;Opening bracket on a callback. SeeLEAVE andperlcall.
ENTER;Tells Perl toeval the given string and return an SV* result.
NOTE: the perl_ form of this function is deprecated.
SV*eval_pv(const char* p, I32 croak_on_error)Tells Perl toeval the string in the SV.
NOTE: the perl_ form of this function is deprecated.
I32eval_sv(SV* sv, I32 flags)Used to extend the argument stack for an XSUB's return values. Once used, guarantees that there is room for at leastnitems to be pushed onto the stack.
voidEXTEND(SP, int nitems)Analyses the string in order to make fast searches on it using fbm_instr() -- the Boyer-Moore algorithm.
voidfbm_compile(SV* sv, U32 flags)Returns the location of the SV in the string delimited bystr andstrend. It returnsNullch if the string can't be found. Thesv does not have to be fbm_compiled, but the search will not be as fast then.
char*fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)Closing bracket for temporaries on a callback. SeeSAVETMPS andperlcall.
FREETMPS;Returns the AV of the specified Perl array. Ifcreate is set and the Perl variable does not exist then it will be created. Ifcreate is not set and the variable does not exist then NULL is returned.
NOTE: the perl_ form of this function is deprecated.
AV*get_av(const char* name, I32 create)Returns the CV of the specified Perl subroutine. Ifcreate is set and the Perl subroutine does not exist then it will be declared (which has the same effect as sayingsub name;). Ifcreate is not set and the subroutine does not exist then NULL is returned.
NOTE: the perl_ form of this function is deprecated.
CV*get_cv(const char* name, I32 create)Returns the HV of the specified Perl hash. Ifcreate is set and the Perl variable does not exist then it will be created. Ifcreate is not set and the variable does not exist then NULL is returned.
NOTE: the perl_ form of this function is deprecated.
HV*get_hv(const char* name, I32 create)Returns the SV of the specified Perl scalar. Ifcreate is set and the Perl variable does not exist then it will be created. Ifcreate is not set and the variable does not exist then NULL is returned.
NOTE: the perl_ form of this function is deprecated.
SV*get_sv(const char* name, I32 create)A backward-compatible version ofGIMME_V which can only returnG_SCALAR orG_ARRAY; in a void context, it returnsG_SCALAR. Deprecated. UseGIMME_V instead.
U32GIMMEThe XSUB-writer's equivalent to Perl'swantarray. ReturnsG_VOID,G_SCALAR orG_ARRAY for void, scalar or list context, respectively.
U32GIMME_VReturn the SV from the GV.
SV*GvSV(GV* gv)Returns the glob with the givenname and a defined subroutine orNULL. The glob lives in the givenstash, or in the stashes accessible via @ISA and @UNIVERSAL.
The argumentlevel should be either 0 or -1. Iflevel==0, as a side-effect creates a glob with the givenname in the givenstash which in the case of success contains an alias for the subroutine, and sets up caching info for this glob. Similarly for all the searched stashes.
This function grants"SUPER" token as a postfix of the stash name. The GV returned fromgv_fetchmeth may be a method cache entry, which is not visible to Perl code. So when callingcall_sv, you should not use the GV directly; instead, you should use the method's CV, which can be obtained from the GV with theGvCV macro.
GV*gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)GV*gv_fetchmethod(HV* stash, const char* name)Returns the glob which contains the subroutine to call to invoke the method on thestash. In fact in the presence of autoloading this may be the glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is already setup.
The third parameter ofgv_fetchmethod_autoload determines whether AUTOLOAD lookup is performed if the given method is not present: non-zero means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD. Callinggv_fetchmethod is equivalent to callinggv_fetchmethod_autoload with a non-zeroautoload parameter.
These functions grant"SUPER" token as a prefix of the method name. Note that if you want to keep the returned glob for a long time, you need to check for it being "AUTOLOAD", since at the later time the call may load a different subroutine due to $AUTOLOAD changing its value. Use the glob created via a side effect to do this.
These functions have the same side-effects and asgv_fetchmeth withlevel==0.name should be writable if contains':' or' ''. The warning against passing the GV returned bygv_fetchmeth tocall_sv apply equally to these functions.
GV*gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)Returns a pointer to the stash for a specified package.name should be a valid UTF-8 string. Ifcreate is set then the package will be created if it does not already exist. Ifcreate is not set and the package does not exist then NULL is returned.
HV*gv_stashpv(const char* name, I32 create)Returns a pointer to the stash for a specified package, which must be a valid UTF-8 string. Seegv_stashpv.
HV*gv_stashsv(SV* sv, I32 create)Used to indicate list context. SeeGIMME_V,GIMME andperlcall.
Indicates that arguments returned from a callback should be discarded. Seeperlcall.
Used to force a Perleval wrapper around a callback. Seeperlcall.
Indicates that no arguments are being sent to a callback. Seeperlcall.
Used to indicate scalar context. SeeGIMME_V,GIMME, andperlcall.
Used to indicate void context. SeeGIMME_V andperlcall.
This flag, used in the length slot of hash entries and magic structures, specifies the structure contains aSV* pointer where achar* pointer is to be expected. (For information only--not to be used).
Returns the computed hash stored in the hash entry.
U32HeHASH(HE* he)Returns the actual pointer stored in the key slot of the hash entry. The pointer may be eitherchar* orSV*, depending on the value ofHeKLEN(). Can be assigned to. TheHePV() orHeSVKEY() macros are usually preferable for finding the value of a key.
void*HeKEY(HE* he)If this is negative, and amounts toHEf_SVKEY, it indicates the entry holds anSV* key. Otherwise, holds the actual length of the key. Can be assigned to. TheHePV() macro is usually preferable for finding key lengths.
STRLENHeKLEN(HE* he)Returns the key slot of the hash entry as achar* value, doing any necessary dereferencing of possiblySV* keys. The length of the string is placed inlen (this is a macro, so donot use&len). If you do not care about what the length of the key is, you may use the global variablePL_na, though this is rather less efficient than using a local variable. Remember though, that hash keys in perl are free to contain embedded nulls, so usingstrlen() or similar is not a good way to find the length of hash keys. This is very similar to theSvPV() macro described elsewhere in this document.
char*HePV(HE* he, STRLEN len)Returns the key as anSV*, orNullsv if the hash entry does not contain anSV* key.
SV*HeSVKEY(HE* he)Returns the key as anSV*. Will create and return a temporary mortalSV* if the hash entry contains only achar* key.
SV*HeSVKEY_force(HE* he)Sets the key to a givenSV*, taking care to set the appropriate flags to indicate the presence of anSV* key, and returns the sameSV*.
SV*HeSVKEY_set(HE* he, SV* sv)Returns the value slot (typeSV*) stored in the hash entry.
SV*HeVAL(HE* he)Returns the package name of a stash. SeeSvSTASH,CvSTASH.
char*HvNAME(HV* stash)Clears a hash, making it empty.
voidhv_clear(HV* tb)Deletes a key/value pair in the hash. The value SV is removed from the hash and returned to the caller. Theklen is the length of the key. Theflags value will normally be zero; if set to G_DISCARD then NULL will be returned.
SV*hv_delete(HV* tb, const char* key, U32 klen, I32 flags)Deletes a key/value pair in the hash. The value SV is removed from the hash and returned to the caller. Theflags value will normally be zero; if set to G_DISCARD then NULL will be returned.hash can be a valid precomputed hash value, or 0 to ask for it to be computed.
SV*hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)Returns a boolean indicating whether the specified hash key exists. Theklen is the length of the key.
boolhv_exists(HV* tb, const char* key, U32 klen)Returns a boolean indicating whether the specified hash key exists.hash can be a valid precomputed hash value, or 0 to ask for it to be computed.
boolhv_exists_ent(HV* tb, SV* key, U32 hash)Returns the SV which corresponds to the specified key in the hash. Theklen is the length of the key. Iflval is set then the fetch will be part of a store. Check that the return value is non-null before dereferencing it to aSV*.
See"Understanding the Magic of Tied Hashes and Arrays" in perlguts for more information on how to use this function on tied hashes.
SV**hv_fetch(HV* tb, const char* key, U32 klen, I32 lval)Returns the hash entry which corresponds to the specified key in the hash.hash must be a valid precomputed hash number for the givenkey, or 0 if you want the function to compute it. IFlval is set then the fetch will be part of a store. Make sure the return value is non-null before accessing it. The return value whentb is a tied hash is a pointer to a static location, so be sure to make a copy of the structure if you need to store it somewhere.
See"Understanding the Magic of Tied Hashes and Arrays" in perlguts for more information on how to use this function on tied hashes.
HE*hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)Prepares a starting point to traverse a hash table. Returns the number of keys in the hash (i.e. the same asHvKEYS(tb)). The return value is currently only meaningful for hashes without tie magic.
NOTE: Before version 5.004_65,hv_iterinit used to return the number of hash buckets that happen to be in use. If you still need that esoteric value, you can get it through the macroHvFILL(tb).
I32hv_iterinit(HV* tb)Returns the key from the current position of the hash iterator. Seehv_iterinit.
char*hv_iterkey(HE* entry, I32* retlen)Returns the key as anSV* from the current position of the hash iterator. The return value will always be a mortal copy of the key. Also seehv_iterinit.
SV*hv_iterkeysv(HE* entry)Returns entries from a hash iterator. Seehv_iterinit.
HE*hv_iternext(HV* tb)Performs anhv_iternext,hv_iterkey, andhv_iterval in one operation.
SV*hv_iternextsv(HV* hv, char** key, I32* retlen)Returns the value from the current position of the hash iterator. Seehv_iterkey.
SV*hv_iterval(HV* tb, HE* entry)Adds magic to a hash. Seesv_magic.
voidhv_magic(HV* hv, GV* gv, int how)Stores an SV in a hash. The hash key is specified askey andklen is the length of the key. Thehash parameter is the precomputed hash value; if it is zero then Perl will compute it. The return value will be NULL if the operation failed or if the value did not need to be actually stored within the hash (as in the case of tied hashes). Otherwise it can be dereferenced to get the originalSV*. Note that the caller is responsible for suitably incrementing the reference count ofval before the call, and decrementing it if the function returned NULL.
See"Understanding the Magic of Tied Hashes and Arrays" in perlguts for more information on how to use this function on tied hashes.
SV**hv_store(HV* tb, const char* key, U32 klen, SV* val, U32 hash)Storesval in a hash. The hash key is specified askey. Thehash parameter is the precomputed hash value; if it is zero then Perl will compute it. The return value is the new hash entry so created. It will be NULL if the operation failed or if the value did not need to be actually stored within the hash (as in the case of tied hashes). Otherwise the contents of the return value can be accessed using theHe??? macros described here. Note that the caller is responsible for suitably incrementing the reference count ofval before the call, and decrementing it if the function returned NULL.
See"Understanding the Magic of Tied Hashes and Arrays" in perlguts for more information on how to use this function on tied hashes.
HE*hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)Undefines the hash.
voidhv_undef(HV* tb)Returns a boolean indicating whether the Cchar is an ASCII alphanumeric character (including underscore) or digit.
boolisALNUM(char ch)Returns a boolean indicating whether the Cchar is an ASCII alphabetic character.
boolisALPHA(char ch)Returns a boolean indicating whether the Cchar is an ASCII digit.
boolisDIGIT(char ch)Returns a boolean indicating whether the Cchar is a lowercase character.
boolisLOWER(char ch)Returns a boolean indicating whether the Cchar is whitespace.
boolisSPACE(char ch)Returns a boolean indicating whether the Cchar is an uppercase character.
boolisUPPER(char ch)Tests if some arbitrary number of bytes begins in a valid UTF-8 character. The actual number of bytes in the UTF-8 character will be returned if it is valid, otherwise 0.
STRLENis_utf8_char(U8 *p)Returns true if firstlen bytes of the given string form valid a UTF8 string, false otherwise.
boolis_utf8_string(U8 *s, STRLEN len)Variable which is setup byxsubpp to indicate the number of items on the stack. See"Variable-length Parameter Lists" in perlxs.
I32itemsVariable which is setup byxsubpp to indicate which of an XSUB's aliases was used to invoke it. See"The ALIAS: Keyword" in perlxs.
I32ixClosing bracket on a callback. SeeENTER andperlcall.
LEAVE;Test if an the content of an SV looks like a number (or is a number).
I32looks_like_number(SV* sv)Stack marker variable for the XSUB. SeedMARK.
Clear something magical that the SV represents. Seesv_magic.
intmg_clear(SV* sv)Copies the magic from one SV to another. Seesv_magic.
intmg_copy(SV* sv, SV* nsv, const char* key, I32 klen)Finds the magic pointer for type matching the SV. Seesv_magic.
MAGIC*mg_find(SV* sv, int type)Free any magic storage used by the SV. Seesv_magic.
intmg_free(SV* sv)Do magic after a value is retrieved from the SV. Seesv_magic.
intmg_get(SV* sv)Report on the SV's length. Seesv_magic.
U32mg_length(SV* sv)Turns on the magical status of an SV. Seesv_magic.
voidmg_magical(SV* sv)Do magic after a value is assigned to the SV. Seesv_magic.
intmg_set(SV* sv)The XSUB-writer's interface to the Cmemmove function. Thesrc is the source,dest is the destination,nitems is the number of items, andtype is the type. Can do overlapping moves. See alsoCopy.
voidMove(void* src, void* dest, int nitems, type)The XSUB-writer's interface to the Cmalloc function.
voidNew(int id, void* ptr, int nitems, type)Creates a new AV. The reference count is set to 1.
AV*newAV()The XSUB-writer's interface to the Cmalloc function, with cast.
voidNewc(int id, void* ptr, int nitems, type, cast)Creates a constant sub equivalent to Perlsub FOO () { 123 } which is eligible for inlining at compile-time.
voidnewCONSTSUB(HV* stash, char* name, SV* sv)Creates a new HV. The reference count is set to 1.
HV*newHV()Creates an RV wrapper for an SV. The reference count for the original SV is incremented.
SV*newRV_inc(SV* sv)Creates an RV wrapper for an SV. The reference count for the original SV isnot incremented.
SV*newRV_noinc(SV *sv)Creates a new SV. A non-zerolen parameter indicates the number of bytes of preallocated string space the SV should have. An extra byte for a tailing NUL is also reserved. (SvPOK is not set for the SV even if string space is allocated.) The reference count for the new SV is set to 1.id is an integer id between 0 and 1299 (used to identify leaks).
SV*NEWSV(int id, STRLEN len)Creates a new SV and copies an integer into it. The reference count for the SV is set to 1.
SV*newSViv(IV i)Creates a new SV and copies a floating point value into it. The reference count for the SV is set to 1.
SV*newSVnv(NV n)Creates a new SV and copies a string into it. The reference count for the SV is set to 1. Iflen is zero, Perl will compute the length using strlen(). For efficiency, consider usingnewSVpvn instead.
SV*newSVpv(const char* s, STRLEN len)Creates a new SV an initialize it with the string formatted likesprintf.
SV*newSVpvf(const char* pat, ...)Creates a new SV and copies a string into it. The reference count for the SV is set to 1. Note that iflen is zero, Perl will create a zero length string. You are responsible for ensuring that the source string is at leastlen bytes long.
SV*newSVpvn(const char* s, STRLEN len)Creates a new SV for the RV,rv, to point to. Ifrv is not an RV then it will be upgraded to one. Ifclassname is non-null then the new SV will be blessed in the specified package. The new SV is returned and its reference count is 1.
SV*newSVrv(SV* rv, const char* classname)Creates a new SV which is an exact duplicate of the original SV.
SV*newSVsv(SV* old)Creates a new SV and copies an unsigned integer into it. The reference count for the SV is set to 1.
SV*newSVuv(UV u)Used byxsubpp to hook up XSUBs as Perl subs.
Used byxsubpp to hook up XSUBs as Perl subs. Adds Perl prototypes to the subs.
The XSUB-writer's interface to the Cmalloc function. The allocated memory is zeroed withmemzero.
voidNewz(int id, void* ptr, int nitems, type)Null AV pointer.
Null character pointer.
Null CV pointer.
Null HV pointer.
Null SV pointer.
The original stack mark for the XSUB. SeedORIGMARK.
Allocates a new Perl interpreter. Seeperlembed.
PerlInterpreter*perl_alloc()Initializes a new Perl interpreter. Seeperlembed.
voidperl_construct(PerlInterpreter* interp)Shuts down a Perl interpreter. Seeperlembed.
voidperl_destruct(PerlInterpreter* interp)Releases a Perl interpreter. Seeperlembed.
voidperl_free(PerlInterpreter* interp)Tells a Perl interpreter to parse a Perl script. Seeperlembed.
intperl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)Tells a Perl interpreter to run. Seeperlembed.
intperl_run(PerlInterpreter* interp)PL_modglobal is a general purpose, interpreter global HV for use by extensions that need to keep information on a per-interpreter basis. In a pinch, it can also be used as a symbol table for extensions to share data among each other. It is a good idea to use keys prefixed by the package name of the extension that owns the data.
HV*PL_modglobalA convenience variable which is typically used withSvPV when one doesn't care about the length of the string. It is usually more efficient to either declare a local variable and use that instead or to use theSvPV_nolen macro.
STRLENPL_naThis is thefalse SV. SeePL_sv_yes. Always refer to this as&PL_sv_no.
SVPL_sv_noThis is theundef SV. Always refer to this as&PL_sv_undef.
SVPL_sv_undefThis is thetrue SV. SeePL_sv_no. Always refer to this as&PL_sv_yes.
SVPL_sv_yesPops an integer off the stack.
IVPOPiPops a long off the stack.
longPOPlPops a double off the stack.
NVPOPnPops a string off the stack.
char*POPpPops an SV off the stack.
SV*POPsPush an integer onto the stack. The stack must have room for this element. Handles 'set' magic. SeeXPUSHi.
voidPUSHi(IV iv)Opening bracket for arguments on a callback. SeePUTBACK andperlcall.
PUSHMARK;Push a double onto the stack. The stack must have room for this element. Handles 'set' magic. SeeXPUSHn.
voidPUSHn(NV nv)Push a string onto the stack. The stack must have room for this element. Thelen indicates the length of the string. Handles 'set' magic. SeeXPUSHp.
voidPUSHp(char* str, STRLEN len)Push an SV onto the stack. The stack must have room for this element. Does not handle 'set' magic. SeeXPUSHs.
voidPUSHs(SV* sv)Push an unsigned integer onto the stack. The stack must have room for this element. SeeXPUSHu.
voidPUSHu(UV uv)Closing bracket for XSUB arguments. This is usually handled byxsubpp. SeePUSHMARK andperlcall for other uses.
PUTBACK;The XSUB-writer's interface to the Crealloc function.
voidRenew(void* ptr, int nitems, type)The XSUB-writer's interface to the Crealloc function, with cast.
voidRenewc(void* ptr, int nitems, type, cast)Tells Perl torequire a module.
NOTE: the perl_ form of this function is deprecated.
voidrequire_pv(const char* pv)Variable which is setup byxsubpp to hold the return value for an XSUB. This is always the proper type for the XSUB. See"The RETVAL Variable" in perlxs.
(whatever)RETVALThe XSUB-writer's interface to the Cfree function.
voidSafefree(void* ptr)Copy a string to a safe spot. This does not use an SV.
char*savepv(const char* sv)Copy a string to a safe spot. Thelen indicates number of bytes to copy. This does not use an SV.
char*savepvn(const char* sv, I32 len)Opening bracket for temporaries on a callback. SeeFREETMPS andperlcall.
SAVETMPS;Stack pointer. This is usually handled byxsubpp. SeedSP andSPAGAIN.
Refetch the stack pointer. Used after a callback. Seeperlcall.
SPAGAIN;Used to access elements on the XSUB's stack.
SV*ST(int ix)Test two strings to see if they are equal. Returns true or false.
boolstrEQ(char* s1, char* s2)Test two strings to see if the first,s1, is greater than or equal to the second,s2. Returns true or false.
boolstrGE(char* s1, char* s2)Test two strings to see if the first,s1, is greater than the second,s2. Returns true or false.
boolstrGT(char* s1, char* s2)Test two strings to see if the first,s1, is less than or equal to the second,s2. Returns true or false.
boolstrLE(char* s1, char* s2)Test two strings to see if the first,s1, is less than the second,s2. Returns true or false.
boolstrLT(char* s1, char* s2)Test two strings to see if they are different. Returns true or false.
boolstrNE(char* s1, char* s2)Test two strings to see if they are equal. Thelen parameter indicates the number of bytes to compare. Returns true or false. (A wrapper forstrncmp).
boolstrnEQ(char* s1, char* s2, STRLEN len)Test two strings to see if they are different. Thelen parameter indicates the number of bytes to compare. Returns true or false. (A wrapper forstrncmp).
boolstrnNE(char* s1, char* s2, STRLEN len)This is an architecture-independent macro to copy one structure to another.
voidStructCopy(type src, type dest, type)Returns the length of the string which is in the SV. SeeSvLEN.
STRLENSvCUR(SV* sv)Set the length of the string which is in the SV. SeeSvCUR.
voidSvCUR_set(SV* sv, STRLEN len)Returns a pointer to the last character in the string which is in the SV. SeeSvCUR. Access the character as *(SvEND(sv)).
char*SvEND(SV* sv)Invokesmg_get on an SV if it has 'get' magic. This macro evaluates its argument more than once.
voidSvGETMAGIC(SV* sv)Expands the character buffer in the SV so that it has room for the indicated number of bytes (remember to reserve space for an extra trailing NUL character). Callssv_grow to perform the expansion if necessary. Returns a pointer to the character buffer.
voidSvGROW(SV* sv, STRLEN len)Returns a boolean indicating whether the SV contains an integer.
boolSvIOK(SV* sv)Returns a boolean indicating whether the SV contains an integer. Checks theprivate setting. UseSvIOK.
boolSvIOKp(SV* sv)Returns a boolean indicating whether the SV contains an signed integer.
voidSvIOK_notUV(SV* sv)Unsets the IV status of an SV.
voidSvIOK_off(SV* sv)Tells an SV that it is an integer.
voidSvIOK_on(SV* sv)Tells an SV that it is an integer and disables all other OK bits.
voidSvIOK_only(SV* sv)Tells and SV that it is an unsigned integer and disables all other OK bits.
voidSvIOK_only_UV(SV* sv)Returns a boolean indicating whether the SV contains an unsigned integer.
voidSvIOK_UV(SV* sv)Coerces the given SV to an integer and returns it.
IVSvIV(SV* sv)Returns the integer which is stored in the SV, assuming SvIOK is true.
IVSvIVX(SV* sv)Returns the size of the string buffer in the SV, not including any part attributable toSvOOK. SeeSvCUR.
STRLENSvLEN(SV* sv)Returns a boolean indicating whether the SV contains a number, integer or double.
boolSvNIOK(SV* sv)Returns a boolean indicating whether the SV contains a number, integer or double. Checks theprivate setting. UseSvNIOK.
boolSvNIOKp(SV* sv)Unsets the NV/IV status of an SV.
voidSvNIOK_off(SV* sv)Returns a boolean indicating whether the SV contains a double.
boolSvNOK(SV* sv)Returns a boolean indicating whether the SV contains a double. Checks theprivate setting. UseSvNOK.
boolSvNOKp(SV* sv)Unsets the NV status of an SV.
voidSvNOK_off(SV* sv)Tells an SV that it is a double.
voidSvNOK_on(SV* sv)Tells an SV that it is a double and disables all other OK bits.
voidSvNOK_only(SV* sv)Coerce the given SV to a double and return it.
NVSvNV(SV* sv)Returns the double which is stored in the SV, assuming SvNOK is true.
NVSvNVX(SV* sv)Returns a boolean indicating whether the value is an SV.
boolSvOK(SV* sv)Returns a boolean indicating whether the SvIVX is a valid offset value for the SvPVX. This hack is used internally to speed up removal of characters from the beginning of a SvPV. When SvOOK is true, then the start of the allocated string buffer is really (SvPVX - SvIVX).
boolSvOOK(SV* sv)Returns a boolean indicating whether the SV contains a character string.
boolSvPOK(SV* sv)Returns a boolean indicating whether the SV contains a character string. Checks theprivate setting. UseSvPOK.
boolSvPOKp(SV* sv)Unsets the PV status of an SV.
voidSvPOK_off(SV* sv)Tells an SV that it is a string.
voidSvPOK_on(SV* sv)Tells an SV that it is a string and disables all other OK bits.
voidSvPOK_only(SV* sv)Tells an SV that it is a UTF8 string (do not use frivolously) and disables all other OK bits.
voidSvPOK_only_UTF8(SV* sv)Returns a pointer to the string in the SV, or a stringified form of the SV if the SV does not contain a string. Handles 'get' magic.
char*SvPV(SV* sv, STRLEN len)Returns a pointer to the string in the SV. The SV must contain a string.
char*SvPVX(SV* sv)Like <SvPV> but will force the SV into becoming a string (SvPOK). You want force if you are going to update the SvPVX directly.
char*SvPV_force(SV* sv, STRLEN len)Returns a pointer to the string in the SV, or a stringified form of the SV if the SV does not contain a string. Handles 'get' magic.
char*SvPV_nolen(SV* sv)Returns the value of the object's reference count.
U32SvREFCNT(SV* sv)Decrements the reference count of the given SV.
voidSvREFCNT_dec(SV* sv)Increments the reference count of the given SV.
SV*SvREFCNT_inc(SV* sv)Tests if the SV is an RV.
boolSvROK(SV* sv)Unsets the RV status of an SV.
voidSvROK_off(SV* sv)Tells an SV that it is an RV.
voidSvROK_on(SV* sv)Dereferences an RV to return the SV.
SV*SvRV(SV* sv)Invokesmg_set on an SV if it has 'set' magic. This macro evaluates its argument more than once.
voidSvSETMAGIC(SV* sv)Callssv_setsv if dsv is not the same as ssv. May evaluate arguments more than once.
voidSvSetSV(SV* dsb, SV* ssv)Calls a non-destructive version ofsv_setsv if dsv is not the same as ssv. May evaluate arguments more than once.
voidSvSetSV_nosteal(SV* dsv, SV* ssv)Returns the stash of the SV.
HV*SvSTASH(SV* sv)Taints an SV if tainting is enabled
voidSvTAINT(SV* sv)Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if not.
boolSvTAINTED(SV* sv)Untaints an SV. Bevery careful with this routine, as it short-circuits some of Perl's fundamental security features. XS module authors should not use this function unless they fully understand all the implications of unconditionally untainting the value. Untainting should be done in the standard perl fashion, via a carefully crafted regexp, rather than directly untainting variables.
voidSvTAINTED_off(SV* sv)Marks an SV as tainted.
voidSvTAINTED_on(SV* sv)Returns a boolean indicating whether Perl would evaluate the SV as true or false, defined or undefined. Does not handle 'get' magic.
boolSvTRUE(SV* sv)An enum of flags for Perl types. These are found in the filesv.h in thesvtype enum. Test these flags with theSvTYPE macro.
Returns the type of the SV. Seesvtype.
svtypeSvTYPE(SV* sv)Integer type flag for scalars. Seesvtype.
Double type flag for scalars. Seesvtype.
Pointer type flag for scalars. Seesvtype.
Type flag for arrays. Seesvtype.
Type flag for code refs. Seesvtype.
Type flag for hashes. Seesvtype.
Type flag for blessed scalars. Seesvtype.
Used to upgrade an SV to a more complex form. Usessv_upgrade to perform the upgrade if necessary. Seesvtype.
voidSvUPGRADE(SV* sv, svtype type)Returns a boolean indicating whether the SV contains UTF-8 encoded data.
voidSvUTF8(SV* sv)Unsets the UTF8 status of an SV.
voidSvUTF8_off(SV *sv)Tells an SV that it is a string and encoded in UTF8. Do not use frivolously.
voidSvUTF8_on(SV *sv)Coerces the given SV to an unsigned integer and returns it.
UVSvUV(SV* sv)Returns the unsigned integer which is stored in the SV, assuming SvIOK is true.
UVSvUVX(SV* sv)Marks an SV as mortal. The SV will be destroyed when the current context ends.
SV*sv_2mortal(SV* sv)Blesses an SV into a specified package. The SV must be an RV. The package must be designated by its stash (seegv_stashpv()). The reference count of the SV is unaffected.
SV*sv_bless(SV* sv, HV* stash)Concatenates the string onto the end of the string which is in the SV. Handles 'get' magic, but not 'set' magic. Seesv_catpv_mg.
voidsv_catpv(SV* sv, const char* ptr)Processes its arguments likesprintf and appends the formatted output to an SV. Handles 'get' magic, but not 'set' magic.SvSETMAGIC() must typically be called after calling this function to handle 'set' magic.
voidsv_catpvf(SV* sv, const char* pat, ...)Likesv_catpvf, but also handles 'set' magic.
voidsv_catpvf_mg(SV *sv, const char* pat, ...)Concatenates the string onto the end of the string which is in the SV. Thelen indicates number of bytes to copy. Handles 'get' magic, but not 'set' magic. Seesv_catpvn_mg.
voidsv_catpvn(SV* sv, const char* ptr, STRLEN len)Likesv_catpvn, but also handles 'set' magic.
voidsv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)Likesv_catpv, but also handles 'set' magic.
voidsv_catpv_mg(SV *sv, const char *ptr)Concatenates the string from SVssv onto the end of the string in SVdsv. Modifiesdsv but notssv. Handles 'get' magic, but not 'set' magic. Seesv_catsv_mg.
voidsv_catsv(SV* dsv, SV* ssv)Likesv_catsv, but also handles 'set' magic.
voidsv_catsv_mg(SV *dstr, SV *sstr)Efficient removal of characters from the beginning of the string buffer. SvPOK(sv) must be true and theptr must be a pointer to somewhere inside the string buffer. Theptr becomes the first character of the adjusted string.
voidsv_chop(SV* sv, char* ptr)Clear an SV, making it empty. Does not free the memory used by the SV itself.
voidsv_clear(SV* sv)Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the string insv1 is less than, equal to, or greater than the string insv2.
I32sv_cmp(SV* sv1, SV* sv2)Compares the strings in two SVs in a locale-aware manner. See"sv_cmp_locale"
I32sv_cmp_locale(SV* sv1, SV* sv2)Auto-decrement of the value in the SV.
voidsv_dec(SV* sv)Returns a boolean indicating whether the SV is derived from the specified class. This is the function that implementsUNIVERSAL::isa. It works for class names as well as for objects.
boolsv_derived_from(SV* sv, const char* name)Returns a boolean indicating whether the strings in the two SVs are identical.
I32sv_eq(SV* sv1, SV* sv2)Free the memory used by an SV.
voidsv_free(SV* sv)Get a line from the filehandle and store it into the SV, optionally appending to the currently-stored string.
char*sv_gets(SV* sv, PerlIO* fp, I32 append)Expands the character buffer in the SV. This will usesv_unref and will upgrade the SV toSVt_PV. Returns a pointer to the character buffer. UseSvGROW.
char*sv_grow(SV* sv, STRLEN newlen)Auto-increment of the value in the SV.
voidsv_inc(SV* sv)Inserts a string at the specified offset/length within the SV. Similar to the Perl substr() function.
voidsv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)Returns a boolean indicating whether the SV is blessed into the specified class. This does not check for subtypes; usesv_derived_from to verify an inheritance relationship.
intsv_isa(SV* sv, const char* name)Returns a boolean indicating whether the SV is an RV pointing to a blessed object. If the SV is not an RV, or if the object is not blessed, then this will return false.
intsv_isobject(SV* sv)Returns the length of the string in the SV. See alsoSvCUR.
STRLENsv_len(SV* sv)Returns the number of characters in the string in an SV, counting wide UTF8 bytes as a single character.
STRLENsv_len_utf8(SV* sv)Adds magic to an SV.
voidsv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)Creates a new SV which is a copy of the original SV. The new SV is marked as mortal.
SV*sv_mortalcopy(SV* oldsv)Creates a new SV which is mortal. The reference count of the SV is set to 1.
SV*sv_newmortal()Get a sensible string out of the SV somehow.
char*sv_pvn_force(SV* sv, STRLEN* lp)Get a sensible UTF8-encoded string out of the SV somehow. See"sv_pvn_force".
char*sv_pvutf8n_force(SV* sv, STRLEN* lp)Returns a string describing what the SV is a reference to.
char*sv_reftype(SV* sv, int ob)Make the first argument a copy of the second, then delete the original.
voidsv_replace(SV* sv, SV* nsv)Weaken a reference.
SV*sv_rvweaken(SV *sv)Copies an integer into the given SV. Does not handle 'set' magic. Seesv_setiv_mg.
voidsv_setiv(SV* sv, IV num)Likesv_setiv, but also handles 'set' magic.
voidsv_setiv_mg(SV *sv, IV i)Copies a double into the given SV. Does not handle 'set' magic. Seesv_setnv_mg.
voidsv_setnv(SV* sv, NV num)Likesv_setnv, but also handles 'set' magic.
voidsv_setnv_mg(SV *sv, NV num)Copies a string into an SV. The string must be null-terminated. Does not handle 'set' magic. Seesv_setpv_mg.
voidsv_setpv(SV* sv, const char* ptr)Processes its arguments likesprintf and sets an SV to the formatted output. Does not handle 'set' magic. Seesv_setpvf_mg.
voidsv_setpvf(SV* sv, const char* pat, ...)Likesv_setpvf, but also handles 'set' magic.
voidsv_setpvf_mg(SV *sv, const char* pat, ...)Copies an integer into the given SV, also updating its string value. Does not handle 'set' magic. Seesv_setpviv_mg.
voidsv_setpviv(SV* sv, IV num)Likesv_setpviv, but also handles 'set' magic.
voidsv_setpviv_mg(SV *sv, IV iv)Copies a string into an SV. Thelen parameter indicates the number of bytes to be copied. Does not handle 'set' magic. Seesv_setpvn_mg.
voidsv_setpvn(SV* sv, const char* ptr, STRLEN len)Likesv_setpvn, but also handles 'set' magic.
voidsv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)Likesv_setpv, but also handles 'set' magic.
voidsv_setpv_mg(SV *sv, const char *ptr)Copies an integer into a new SV, optionally blessing the SV. Therv argument will be upgraded to an RV. That RV will be modified to point to the new SV. Theclassname argument indicates the package for the blessing. Setclassname toNullch to avoid the blessing. The new SV will be returned and will have a reference count of 1.
SV*sv_setref_iv(SV* rv, const char* classname, IV iv)Copies a double into a new SV, optionally blessing the SV. Therv argument will be upgraded to an RV. That RV will be modified to point to the new SV. Theclassname argument indicates the package for the blessing. Setclassname toNullch to avoid the blessing. The new SV will be returned and will have a reference count of 1.
SV*sv_setref_nv(SV* rv, const char* classname, NV nv)Copies a pointer into a new SV, optionally blessing the SV. Therv argument will be upgraded to an RV. That RV will be modified to point to the new SV. If thepv argument is NULL thenPL_sv_undef will be placed into the SV. Theclassname argument indicates the package for the blessing. Setclassname toNullch to avoid the blessing. The new SV will be returned and will have a reference count of 1.
Do not use with other Perl types such as HV, AV, SV, CV, because those objects will become corrupted by the pointer copy process.
Note thatsv_setref_pvn copies the string while this copies the pointer.
SV*sv_setref_pv(SV* rv, const char* classname, void* pv)Copies a string into a new SV, optionally blessing the SV. The length of the string must be specified withn. Therv argument will be upgraded to an RV. That RV will be modified to point to the new SV. Theclassname argument indicates the package for the blessing. Setclassname toNullch to avoid the blessing. The new SV will be returned and will have a reference count of 1.
Note thatsv_setref_pv copies the pointer while this copies the string.
SV*sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)Copies the contents of the source SVssv into the destination SVdsv. The source SV may be destroyed if it is mortal. Does not handle 'set' magic. See the macro formsSvSetSV,SvSetSV_nosteal andsv_setsv_mg.
voidsv_setsv(SV* dsv, SV* ssv)Likesv_setsv, but also handles 'set' magic.
voidsv_setsv_mg(SV *dstr, SV *sstr)Copies an unsigned integer into the given SV. Does not handle 'set' magic. Seesv_setuv_mg.
voidsv_setuv(SV* sv, UV num)Likesv_setuv, but also handles 'set' magic.
voidsv_setuv_mg(SV *sv, UV u)Returns true if the SV has a true value by Perl's rules.
I32sv_true(SV *sv)Removes magic from an SV.
intsv_unmagic(SV* sv, int type)Unsets the RV status of the SV, and decrements the reference count of whatever was being referenced by the RV. This can almost be thought of as a reversal ofnewSVrv. SeeSvROK_off.
voidsv_unref(SV* sv)Upgrade an SV to a more complex form. UseSvUPGRADE. Seesvtype.
boolsv_upgrade(SV* sv, U32 mt)Tells an SV to useptr to find its string value. Normally the string is stored inside the SV but sv_usepvn allows the SV to use an outside string. Theptr should point to memory that was allocated bymalloc. The string length,len, must be supplied. This function will realloc the memory pointed to byptr, so that pointer should not be freed or used by the programmer after giving it to sv_usepvn. Does not handle 'set' magic. Seesv_usepvn_mg.
voidsv_usepvn(SV* sv, char* ptr, STRLEN len)Likesv_usepvn, but also handles 'set' magic.
voidsv_usepvn_mg(SV *sv, char *ptr, STRLEN len)Attempt to convert the PV of an SV from UTF8-encoded to byte encoding. This may not be possible if the PV contains non-byte encoding characters; if this is the case, either returns false or, iffail_ok is not true, croaks.
NOTE: this function is experimental and may change or be removed without notice.
boolsv_utf8_downgrade(SV *sv, bool fail_ok)Convert the PV of an SV to UTF8-encoded, but then turn off theSvUTF8 flag so that it looks like bytes again. Nothing calls this.
NOTE: this function is experimental and may change or be removed without notice.
voidsv_utf8_encode(SV *sv)Convert the PV of an SV to its UTF8-encoded form.
NOTE: this function is experimental and may change or be removed without notice.
voidsv_utf8_upgrade(SV *sv)Processes its arguments likevsprintf and appends the formatted output to an SV. Uses an array of SVs if the C style variable argument list is missing (NULL). When running with taint checks enabled, indicates viamaybe_tainted if results are untrustworthy (often due to the use of locales).
voidsv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)Works likevcatpvfn but copies the text into the SV instead of appending it.
voidsv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)Variable which is setup byxsubpp to designate the object in a C++ XSUB. This is always the proper type for the C++ object. SeeCLASS and"Using XS With C++" in perlxs.
(whatever)THISConverts the specified character to lowercase.
chartoLOWER(char ch)Converts the specified character to uppercase.
chartoUPPER(char ch)Returns the number of UTF8 characters between the UTF-8 pointersa andb.
WARNING: use only if you *know* that the pointers point inside the same UTF-8 buffer.
NOTE: this function is experimental and may change or be removed without notice.
IVutf8_distance(U8 *a, U8 *b)Return the UTF-8 pointers displaced byoff characters, either forward or backward.
WARNING: do not use the following unless you *know*off is within the UTF-8 data pointed to bys *and* that on entrys is aligned on the first byte of character or just after the last byte of a character.
NOTE: this function is experimental and may change or be removed without notice.
U8*utf8_hop(U8 *s, I32 off)Return the length of the UTF-8 char encoded strings in characters. Stops ate (inclusive). Ife < s or if the scan would end up paste, croaks.
NOTE: this function is experimental and may change or be removed without notice.
STRLENutf8_length(U8* s, U8 *e)Converts a strings of lengthlen from UTF8 into byte encoding. Unlikebytes_to_utf8, this over-writes the original string, and updates len to contain the new length. Returns zero on failure, settinglen to -1.
NOTE: this function is experimental and may change or be removed without notice.
U8*utf8_to_bytes(U8 *s, STRLEN *len)Returns the character value of the first character in the strings which is assumed to be in UTF8 encoding and no longer thancurlen;retlen will be set to the length, in bytes, of that character.
Ifs does not point to a well-formed UTF8 character, the behaviour is dependent on the value offlags: if it contains UTF8_CHECK_ONLY, it is assumed that the caller will raise a warning, and this function will silently just setretlen to-1 and return zero. If theflags does not contain UTF8_CHECK_ONLY, warnings about malformations will be given,retlen will be set to the expected length of the UTF-8 character in bytes, and zero will be returned.
Theflags can also contain various flags to allow deviations from the strict UTF-8 encoding (seeutf8.h).
NOTE: this function is experimental and may change or be removed without notice.
UVutf8_to_uv(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)Returns the character value of the first character in the strings which is assumed to be in UTF8 encoding;retlen will be set to the length, in bytes, of that character.
Ifs does not point to a well-formed UTF8 character, zero is returned and retlen is set, if possible, to -1.
NOTE: this function is experimental and may change or be removed without notice.
UVutf8_to_uv_simple(U8 *s, STRLEN* retlen)Adds the UTF8 representation of the Unicode codepointuv to the end of the stringd;d should be have at leastUTF8_MAXLEN+1 free bytes available. The return value is the pointer to the byte after the end of the new character. In other words,
d = uv_to_utf8(d, uv);is the recommended Unicode-aware way of saying
*(d++) = uv;NOTE: this function is experimental and may change or be removed without notice.
U8*uv_to_utf8(U8 *d, UV uv)This is the XSUB-writer's interface to Perl'swarn function. Use this function the same way you use the Cprintf function. Seecroak.
voidwarn(const char* pat, ...)Push an integer onto the stack, extending the stack if necessary. Handles 'set' magic. SeePUSHi.
voidXPUSHi(IV iv)Push a double onto the stack, extending the stack if necessary. Handles 'set' magic. SeePUSHn.
voidXPUSHn(NV nv)Push a string onto the stack, extending the stack if necessary. Thelen indicates the length of the string. Handles 'set' magic. SeePUSHp.
voidXPUSHp(char* str, STRLEN len)Push an SV onto the stack, extending the stack if necessary. Does not handle 'set' magic. SeePUSHs.
voidXPUSHs(SV* sv)Push an unsigned integer onto the stack, extending the stack if necessary. SeePUSHu.
voidXPUSHu(UV uv)Macro to declare an XSUB and its C parameter list. This is handled byxsubpp.
Return from XSUB, indicating number of items on the stack. This is usually handled byxsubpp.
voidXSRETURN(int nitems)Return an empty list from an XSUB immediately.
XSRETURN_EMPTY;Return an integer from an XSUB immediately. UsesXST_mIV.
voidXSRETURN_IV(IV iv)Return&PL_sv_no from an XSUB immediately. UsesXST_mNO.
XSRETURN_NO;Return an double from an XSUB immediately. UsesXST_mNV.
voidXSRETURN_NV(NV nv)Return a copy of a string from an XSUB immediately. UsesXST_mPV.
voidXSRETURN_PV(char* str)Return&PL_sv_undef from an XSUB immediately. UsesXST_mUNDEF.
XSRETURN_UNDEF;Return&PL_sv_yes from an XSUB immediately. UsesXST_mYES.
XSRETURN_YES;Place an integer into the specified positionpos on the stack. The value is stored in a new mortal SV.
voidXST_mIV(int pos, IV iv)Place&PL_sv_no into the specified positionpos on the stack.
voidXST_mNO(int pos)Place a double into the specified positionpos on the stack. The value is stored in a new mortal SV.
voidXST_mNV(int pos, NV nv)Place a copy of a string into the specified positionpos on the stack. The value is stored in a new mortal SV.
voidXST_mPV(int pos, char* str)Place&PL_sv_undef into the specified positionpos on the stack.
voidXST_mUNDEF(int pos)Place&PL_sv_yes into the specified positionpos on the stack.
voidXST_mYES(int pos)The version identifier for an XS module. This is usually handled automatically byExtUtils::MakeMaker. SeeXS_VERSION_BOOTCHECK.
Macro to verify that a PM module's $VERSION variable matches the XS module'sXS_VERSION variable. This is usually handled automatically byxsubpp. See"The VERSIONCHECK: Keyword" in perlxs.
XS_VERSION_BOOTCHECK;The XSUB-writer's interface to the Cmemzero function. Thedest is the destination,nitems is the number of items, andtype is the type.
voidZero(void* dest, int nitems, type)Until May 1997, this document was maintained by Jeff Okamoto <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
With lots of help and suggestions from Dean Roehrich, Malcolm Beattie, Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer, Stephen McCamant, and Gurusamy Sarathy.
API Listing originally by Dean Roehrich <roehrich@cray.com>.
Updated to be autogenerated from comments in the source by Benjamin Stuhl.
perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
Perldoc Browser is maintained by Dan Book (DBOOK). Please contact him via theGitHub issue tracker oremail regarding any issues with the site itself, search, or rendering of documentation.
The Perl documentation is maintained by the Perl 5 Porters in the development of Perl. Please contact them via thePerl issue tracker, themailing list, orIRC to report any issues with the contents or format of the documentation.