Cari di Perl 
     Perl User Manual
Daftar Isi ☛
(Sebelumnya) Perl calling conventions from CAutogenerated documentation of ... (Berikutnya)
Internals and C language interface

Autogenerated documentation for the perl public API

Daftar Isi

NAME

perlapi - autogenerated documentation for the perl public API

DESCRIPTION

This file contains the documentation of the perl public API generated byembed.pl, specifically a listing of functions, macros, flags, and variablesthat may be used by extension writers. At the endis a list of functions which have yet to be documented. The interfaces ofthose are subject to change without notice. Any functions not listed here arenot part of the public API, and should not be used by extension writers atall. For these reasons, blindly using functions listed in proto.h is to beavoided when writing extensions.

Note that all Perl API global variables must be referenced with the PL_prefix. Some macros are provided for compatibility with the older,unadorned names, but this support may be disabled in a future release.

Perl was originally written to handle US-ASCII only (that is characterswhose ordinal numbers are in the range 0 - 127).And documentation and comments may still use the term ASCII, whensometimes in fact the entire range from 0 - 255 is meant.

Note that Perl can be compiled and run under EBCDIC (See perlebcdic)or ASCII. Most of the documentation (and even comments in the code)ignore the EBCDIC possibility. For almost all purposes the differences are transparent.As an example, under EBCDIC,instead of UTF-8, UTF-EBCDIC is used to encode Unicode strings, and sowhenever this documentation refers to utf8(and variants of that name, including in function names),it also (essentially transparently) means UTF-EBCDIC.But the ordinals of characters differ between ASCII, EBCDIC, andthe UTF- encodings, and a string encoded in UTF-EBCDIC may occupy more bytesthan in UTF-8.

Also, on some EBCDIC machines, functions that are documented as operating onUS-ASCII (or Basic Latin in Unicode terminology) may in fact operate on all256 characters in the EBCDIC range, not just the subset corresponding toUS-ASCII.

The listing below is alphabetical, case insensitive.

"Gimme" Values

  • GIMME

    A backward-compatible version of GIMME_V which can only returnG_SCALAR or G_ARRAY; in a void context, it returns G_SCALAR.Deprecated. Use GIMME_V instead.

    1. U32GIMME
      2.
  • GIMME_V

    The XSUB-writer's equivalent to Perl's wantarray. Returns G_VOID,G_SCALAR or G_ARRAY for void, scalar or list context,respectively. See perlcall for a usage example.

    1. U32GIMME_V
      2.
  • G_ARRAY

    Used to indicate list context. See GIMME_V, GIMME andperlcall.

  • G_DISCARD

    Indicates that arguments returned from a callback should be discarded. Seeperlcall.

  • G_EVAL

    Used to force a Perl eval wrapper around a callback. Seeperlcall.

  • G_NOARGS

    Indicates that no arguments are being sent to a callback. Seeperlcall.

  • G_SCALAR

    Used to indicate scalar context. See GIMME_V, GIMME, andperlcall.

  • G_VOID

    Used to indicate void context. See GIMME_V and perlcall.

Array Manipulation Functions

  • AvFILL

    Same as av_len(). Deprecated, use av_len() instead.

    1. intAvFILL(AV* av)
      2.
  • av_clear

    Clears an array, making it empty. Does not free the memory the av uses tostore its list of scalars. If any destructors are triggered as a result,the av itself may be freed when this function returns.

    Perl equivalent: @myarray = ();.

    1. voidav_clear(AV *av)
      2.
  • av_create_and_push

    Push an SV onto the end of the array, creating the array if necessary.A small internal helper function to remove a commonly duplicated idiom.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. voidav_create_and_push(AV **const avp,
      2.  
    2.    SV *const val)
      3.
  • av_create_and_unshift_one

    Unshifts an SV onto the beginning of the array, creating the array ifnecessary.A small internal helper function to remove a commonly duplicated idiom.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. SV**av_create_and_unshift_one(AV **const avp,
      2.  
    2.   SV *const val)
      3.
  • av_delete

    Deletes the element indexed by key from the array, makes the element mortal,and returns it. If flags equals G_DISCARD, the element is freed and nullis returned. Perl equivalent: my $elem = delete($myarray[$idx]); for thenon-G_DISCARD version and a void-context delete($myarray[$idx]); for theG_DISCARD version.

    1. SV*av_delete(AV *av, I32 key, I32 flags)
      2.
  • av_exists

    Returns true if the element indexed by key has been initialized.

    This relies on the fact that uninitialized array elements are set to&PL_sv_undef.

    Perl equivalent: exists($myarray[$key]).

    1. boolav_exists(AV *av, I32 key)
      2.
  • av_extend

    Pre-extend an array. The key is the index to which the array should beextended.

    1. voidav_extend(AV *av, I32 key)
      2.
  • av_fetch

    Returns the SV at the specified index in the array. The key is theindex. If lval is true, you are guaranteed to get a real SV back (in caseit wasn't real before), which you can then modify. Check that the returnvalue is non-null before dereferencing it to a SV*.

    See Understanding the Magic of Tied Hashes and Arrays in perlguts formore information on how to use this function on tied arrays.

    The rough perl equivalent is $myarray[$idx].

    1. SV**av_fetch(AV *av, I32 key, I32 lval)
      2.
  • av_fill

    Set the highest index in the array to the given number, equivalent toPerl's $#array = $fill;.

    The number of elements in the an array will be fill + 1 afterav_fill() returns. If the array was previously shorter, then theadditional elements appended are set to PL_sv_undef. If the arraywas longer, then the excess elements are freed. av_fill(av, -1) isthe same as av_clear(av).

    1. voidav_fill(AV *av, I32 fill)
      2.
  • av_len

    Returns the highest index in the array. The number of elements in thearray is av_len(av) + 1. Returns -1 if the array is empty.

    The Perl equivalent for this is $#myarray.

    1. I32av_len(AV *av)
      2.
  • av_make

    Creates a new AV and populates it with a list of SVs. The SVs are copiedinto the array, so they may be freed after the call to av_make. The new AVwill have a reference count of 1.

    Perl equivalent: my @new_array = ($scalar1, $scalar2, $scalar3...);

    1. AV*av_make(I32 size, SV **strp)
      2.
  • av_pop

    Pops an SV off the end of the array. Returns &PL_sv_undef if the arrayis empty.

    Perl equivalent: pop(@myarray);

    1. SV*av_pop(AV *av)
      2.
  • av_push

    Pushes an SV onto the end of the array. The array will grow automaticallyto accommodate the addition. This takes ownership of one reference count.

    Perl equivalent: push @myarray, $elem;.

    1. voidav_push(AV *av, SV *val)
      2.
  • av_shift

    Shifts an SV off the beginning of thearray. Returns &PL_sv_undef if the array is empty.

    Perl equivalent: shift(@myarray);

    1. SV*av_shift(AV *av)
      2.
  • av_store

    Stores an SV in an array. The array index is specified as key. Thereturn value will be NULL if the operation failed or if the value did notneed to be actually stored within the array (as in the case of tiedarrays). Otherwise, it can be dereferencedto get the SV* that was storedthere (= val)).

    Note that the caller is responsible for suitably incrementing the referencecount of val before the call, and decrementing it if the functionreturned NULL.

    Approximate Perl equivalent: $myarray[$key] = $val;.

    See Understanding the Magic of Tied Hashes and Arrays in perlguts formore information on how to use this function on tied arrays.

    1. SV**av_store(AV *av, I32 key, SV *val)
      2.
  • av_undef

    Undefines the array. Frees the memory used by the av to store its list ofscalars. If any destructors are triggered as a result, the av itself maybe freed.

    1. voidav_undef(AV *av)
      2.
  • av_unshift

    Unshift the given number of undef values onto the beginning of thearray. The array will grow automatically to accommodate the addition. Youmust then use av_store to assign values to these new elements.

    Perl equivalent: unshift @myarray, ( (undef) x $n );

    1. voidav_unshift(AV *av, I32 num)
      2.
  • get_av

    Returns the AV of the specified Perl global or package array with the givenname (so it won't work on lexical variables). flags are passed to gv_fetchpv. If GV_ADD is set and thePerl variable does not exist then it will be created. If flags is zeroand the variable does not exist then NULL is returned.

    Perl equivalent: @{"$name"}.

    NOTE: the perl_ form of this function is deprecated.

    1. AV*get_av(const char *name, I32 flags)
      2.
  • newAV

    Creates a new AV. The reference count is set to 1.

    Perl equivalent: my @array;.

    1. AV*newAV()
      2.
  • sortsv

    Sort an array. Here is an example:

    1.  sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale);
      2.

    Currently this always uses mergesort. See sortsv_flags for a moreflexible routine.

    1. voidsortsv(SV** array, size_t num_elts,
      2.  
    2.    SVCOMPARE_t cmp)
      3.
  • sortsv_flags

    Sort an array, with various options.

    1. voidsortsv_flags(SV** array, size_t num_elts,
      2.  
    2.  SVCOMPARE_t cmp, U32 flags)
      3.

Callback Functions

  • call_argv

    Performs a callback to the specified named and package-scoped Perl subroutine with argv (a NULL-terminated array of strings) as arguments. See perlcall.

    Approximate Perl equivalent: &{"$sub_name"}(@$argv).

    NOTE: the perl_ form of this function is deprecated.

    1. I32call_argv(const char* sub_name, I32 flags,
      2.  
    2.   char** argv)
      3.
  • call_method

    Performs a callback to the specified Perl method. The blessed object mustbe on the stack. See perlcall.

    NOTE: the perl_ form of this function is deprecated.

    1. I32call_method(const char* methname, I32 flags)
      2.
  • call_pv

    Performs a callback to the specified Perl sub. See perlcall.

    NOTE: the perl_ form of this function is deprecated.

    1. I32call_pv(const char* sub_name, I32 flags)
      2.
  • call_sv

    Performs a callback to the Perl sub whose name is in the SV. Seeperlcall.

    NOTE: the perl_ form of this function is deprecated.

    1. I32call_sv(SV* sv, VOL I32 flags)
      2.
  • ENTER

    Opening bracket on a callback. See LEAVE and perlcall.

    1. ENTER;
      2.
  • eval_pv

    Tells Perl to eval the given string and return an SV* result.

    NOTE: the perl_ form of this function is deprecated.

    1. SV*eval_pv(const char* p, I32 croak_on_error)
      2.
  • eval_sv

    Tells Perl to eval the string in the SV. It supports the same flagsas call_sv, with the obvious exception of G_EVAL. See perlcall.

    NOTE: the perl_ form of this function is deprecated.

    1. I32eval_sv(SV* sv, I32 flags)
      2.
  • FREETMPS

    Closing bracket for temporaries on a callback. See SAVETMPS andperlcall.

    1. FREETMPS;
      2.
  • LEAVE

    Closing bracket on a callback. See ENTER and perlcall.

    1. LEAVE;
      2.
  • SAVETMPS

    Opening bracket for temporaries on a callback. See FREETMPS andperlcall.

    1. SAVETMPS;
      2.

Character case changing

  • toLOWER

    Converts the specified character to lowercase in the platform's nativecharacter set, if possible; otherwise returns the input character itself.

    1. chartoLOWER(char ch)
      2.
  • toUPPER

    Converts the specified character to uppercase in the platform's nativecharacter set, if possible; otherwise returns the input character itself.

    1. chartoUPPER(char ch)
      2.

Character classes

There are three variants for all the functions in this section. The base onesoperate using the character set of the platform Perl is running on. The oneswith an _A suffix operate on the ASCII character set, and the ones with an_L1 suffix operate on the full Latin1 character set. All are unaffected bylocale and by use bytes.

For ASCII platforms, the base function with no suffix and the one with the_A suffix are identical. The function with the _L1 suffix imposes theLatin-1 character set onto the platform. That is, the code points that areASCII are unaffected, since ASCII is a subset of Latin-1. But the non-ASCIIcode points are treated as if they are Latin-1 characters. For example,isSPACE_L1() will return true when called with the code point 0xA0, which isthe Latin-1 NO-BREAK SPACE.

For EBCDIC platforms, the base function with no suffix and the one with the_L1 suffix should be identical, since, as of this writing, the EBCDIC codepages that Perl knows about all are equivalent to Latin-1. The function thatends in an _A suffix will not return true unless the specified character alsohas an ASCII equivalent.

  • isALPHA

    Returns a boolean indicating whether the specified character is analphabetic character in the platform's native character set.See the top of this section for an explanation of variantsisALPHA_A and isALPHA_L1.

    1. boolisALPHA(char ch)
      2.
  • isASCII

    Returns a boolean indicating whether the specified character is one of the 128characters in the ASCII character set. On non-ASCII platforms, it is if thischaracter corresponds to an ASCII character. Variants isASCII_A() andisASCII_L1() are identical to isASCII().

    1. boolisASCII(char ch)
      2.
  • isDIGIT

    Returns a boolean indicating whether the specified character is adigit in the platform's native character set.Variants isDIGIT_A and isDIGIT_L1 are identical to isDIGIT.

    1. boolisDIGIT(char ch)
      2.
  • isLOWER

    Returns a boolean indicating whether the specified character is alowercase character in the platform's native character set.See the top of this section for an explanation of variantsisLOWER_A and isLOWER_L1.

    1. boolisLOWER(char ch)
      2.
  • isOCTAL

    Returns a boolean indicating whether the specified character is anoctal digit, [0-7] in the platform's native character set.Variants isOCTAL_A and isOCTAL_L1 are identical to isOCTAL.

    1. boolisOCTAL(char ch)
      2.
  • isSPACE

    Returns a boolean indicating whether the specified character is awhitespace character in the platform's native character set. This is the sameas what \s matches in a regular expression.See the top of this section for an explanation of variantsisSPACE_A and isSPACE_L1.

    1. boolisSPACE(char ch)
      2.
  • isUPPER

    Returns a boolean indicating whether the specified character is anuppercase character in the platform's native character set.See the top of this section for an explanation of variantsisUPPER_A and isUPPER_L1.

    1. boolisUPPER(char ch)
      2.
  • isWORDCHAR

    Returns a boolean indicating whether the specified character is acharacter that is any of: alphabetic, numeric, or an underscore. This is thesame as what \w matches in a regular expression.isALNUM() is a synonym provided for backward compatibility. Note that itdoes not have the standard C language meaning of alphanumeric, since it matchesan underscore and the standard meaning does not.See the top of this section for an explanation of variantsisWORDCHAR_A and isWORDCHAR_L1.

    1. boolisWORDCHAR(char ch)
      2.
  • isXDIGIT

    Returns a boolean indicating whether the specified character is a hexadecimaldigit, [0-9A-Fa-f]. Variants isXDIGIT_A() and isXDIGIT_L1() areidentical to isXDIGIT().

    1. boolisXDIGIT(char ch)
      2.

Cloning an interpreter

  • perl_clone

    Create and return a new interpreter by cloning the current one.

    perl_clone takes these flags as parameters:

    CLONEf_COPY_STACKS - is used to, well, copy the stacks also,without it we only clone the data and zero the stacks,with it we copy the stacks and the new perl interpreter isready to run at the exact same point as the previous one.The pseudo-fork code uses COPY_STACKS while thethreads->create doesn't.

    CLONEf_KEEP_PTR_TABLE -perl_clone keeps a ptr_table with the pointer of the oldvariable as a key and the new variable as a value,this allows it to check if something has been cloned and notclone it again but rather just use the value and increase therefcount. If KEEP_PTR_TABLE is not set then perl_clone will killthe ptr_table using the functionptr_table_free(PL_ptr_table); PL_ptr_table = NULL;,reason to keep it around is if you want to dup some of your ownvariable who are outside the graph perl scans, example of thiscode is in threads.xs create.

    CLONEf_CLONE_HOST -This is a win32 thing, it is ignored on unix, it tells perlswin32host code (which is c++) to clone itself, this is needed onwin32 if you want to run two threads at the same time,if you just want to do some stuff in a separate perl interpreterand then throw it away and return to the original one,you don't need to do anything.

    1. PerlInterpreter* perl_clone(
      2.  
    2.  PerlInterpreter *proto_perl,
      3.  
    3.  UV flags
      4.  
    4.  )
      5.

Compile-time scope hooks

  • BhkDISABLE

    Temporarily disable an entry in this BHK structure, by clearing theappropriate flag. which is a preprocessor token indicating whichentry to disable.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. voidBhkDISABLE(BHK *hk, which)
      2.
  • BhkENABLE

    Re-enable an entry in this BHK structure, by setting the appropriateflag. which is a preprocessor token indicating which entry to enable.This will assert (under -DDEBUGGING) if the entry doesn't contain a validpointer.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. voidBhkENABLE(BHK *hk, which)
      2.
  • BhkENTRY_set

    Set an entry in the BHK structure, and set the flags to indicate it isvalid. which is a preprocessing token indicating which entry to set.The type of ptr depends on the entry.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. voidBhkENTRY_set(BHK *hk, which, void *ptr)
      2.
  • blockhook_register

    Register a set of hooks to be called when the Perl lexical scope changesat compile time. See Compile-time scope hooks in perlguts.

    NOTE: this function is experimental and may change or beremoved without notice.

    NOTE: this function must be explicitly called as Perl_blockhook_register with an aTHX_ parameter.

    1. voidPerl_blockhook_register(pTHX_ BHK *hk)
      2.

COP Hint Hashes

  • cophh_2hv

    Generates and returns a standard Perl hash representing the full set ofkey/value pairs in the cop hints hash cophh. flags is currentlyunused and must be zero.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. HV *cophh_2hv(const COPHH *cophh, U32 flags)
      2.
  • cophh_copy

    Make and return a complete copy of the cop hints hash cophh.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. COPHH *cophh_copy(COPHH *cophh)
      2.
  • cophh_delete_pv

    Like cophh_delete_pvn, but takes a nul-terminated string instead ofa string/length pair.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. COPHH *cophh_delete_pv(const COPHH *cophh,
      2.  
    2.  const char *key, U32 hash,
      3.  
    3.  U32 flags)
      4.
  • cophh_delete_pvn

    Delete a key and its associated value from the cop hints hash cophh,and returns the modified hash. The returned hash pointer is in generalnot the same as the hash pointer that was passed in. The input hash isconsumed by the function, and the pointer to it must not be subsequentlyused. Use cophh_copy if you need both hashes.

    The key is specified by keypv and keylen. If flags has theCOPHH_KEY_UTF8 bit set, the key octets are interpreted as UTF-8,otherwise they are interpreted as Latin-1. hash is a precomputedhash of the key string, or zero if it has not been precomputed.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. COPHH *cophh_delete_pvn(COPHH *cophh,
      2.  
    2.  const char *keypv,
      3.  
    3.  STRLEN keylen, U32 hash,
      4.  
    4.  U32 flags)
      5.
  • cophh_delete_pvs

    Like cophh_delete_pvn, but takes a literal string instead of astring/length pair, and no precomputed hash.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. COPHH *cophh_delete_pvs(const COPHH *cophh,
      2.  
    2.  const char *key, U32 flags)
      3.
  • cophh_delete_sv

    Like cophh_delete_pvn, but takes a Perl scalar instead of astring/length pair.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. COPHH *cophh_delete_sv(const COPHH *cophh, SV *key,
      2.  
    2.  U32 hash, U32 flags)
      3.
  • cophh_fetch_pv

    Like cophh_fetch_pvn, but takes a nul-terminated string instead ofa string/length pair.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. SV *cophh_fetch_pv(const COPHH *cophh,
      2.  
    2.    const char *key, U32 hash,
      3.  
    3.    U32 flags)
      4.
  • cophh_fetch_pvn

    Look up the entry in the cop hints hash cophh with the key specified bykeypv and keylen. If flags has the COPHH_KEY_UTF8 bit set,the key octets are interpreted as UTF-8, otherwise they are interpretedas Latin-1. hash is a precomputed hash of the key string, or zero ifit has not been precomputed. Returns a mortal scalar copy of the valueassociated with the key, or &PL_sv_placeholder if there is no valueassociated with the key.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. SV *cophh_fetch_pvn(const COPHH *cophh,
      2.  
    2.  const char *keypv,
      3.  
    3.  STRLEN keylen, U32 hash,
      4.  
    4.  U32 flags)
      5.
  • cophh_fetch_pvs

    Like cophh_fetch_pvn, but takes a literal string instead of astring/length pair, and no precomputed hash.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. SV *cophh_fetch_pvs(const COPHH *cophh,
      2.  
    2.  const char *key, U32 flags)
      3.
  • cophh_fetch_sv

    Like cophh_fetch_pvn, but takes a Perl scalar instead of astring/length pair.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. SV *cophh_fetch_sv(const COPHH *cophh, SV *key,
      2.  
    2.    U32 hash, U32 flags)
      3.
  • cophh_free

    Discard the cop hints hash cophh, freeing all resources associatedwith it.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. voidcophh_free(COPHH *cophh)
      2.
  • cophh_new_empty

    Generate and return a fresh cop hints hash containing no entries.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. COPHH *cophh_new_empty()
      2.
  • cophh_store_pv

    Like cophh_store_pvn, but takes a nul-terminated string instead ofa string/length pair.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. COPHH *cophh_store_pv(const COPHH *cophh,
      2.  
    2.    const char *key, U32 hash,
      3.  
    3.    SV *value, U32 flags)
      4.
  • cophh_store_pvn

    Stores a value, associated with a key, in the cop hints hash cophh,and returns the modified hash. The returned hash pointer is in generalnot the same as the hash pointer that was passed in. The input hash isconsumed by the function, and the pointer to it must not be subsequentlyused. Use cophh_copy if you need both hashes.

    The key is specified by keypv and keylen. If flags has theCOPHH_KEY_UTF8 bit set, the key octets are interpreted as UTF-8,otherwise they are interpreted as Latin-1. hash is a precomputedhash of the key string, or zero if it has not been precomputed.

    value is the scalar value to store for this key. value is copiedby this function, which thus does not take ownership of any referenceto it, and later changes to the scalar will not be reflected in thevalue visible in the cop hints hash. Complex types of scalar will notbe stored with referential integrity, but will be coerced to strings.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. COPHH *cophh_store_pvn(COPHH *cophh, const char *keypv,
      2.  
    2.  STRLEN keylen, U32 hash,
      3.  
    3.  SV *value, U32 flags)
      4.
  • cophh_store_pvs

    Like cophh_store_pvn, but takes a literal string instead of astring/length pair, and no precomputed hash.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. COPHH *cophh_store_pvs(const COPHH *cophh,
      2.  
    2.  const char *key, SV *value,
      3.  
    3.  U32 flags)
      4.
  • cophh_store_sv

    Like cophh_store_pvn, but takes a Perl scalar instead of astring/length pair.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. COPHH *cophh_store_sv(const COPHH *cophh, SV *key,
      2.  
    2.    U32 hash, SV *value, U32 flags)
      3.

COP Hint Reading

  • cop_hints_2hv

    Generates and returns a standard Perl hash representing the full set ofhint entries in the cop cop. flags is currently unused and mustbe zero.

    1. HV *cop_hints_2hv(const COP *cop, U32 flags)
      2.
  • cop_hints_fetch_pv

    Like cop_hints_fetch_pvn, but takes a nul-terminated string insteadof a string/length pair.

    1. SV *cop_hints_fetch_pv(const COP *cop,
      2.  
    2.    const char *key, U32 hash,
      3.  
    3.    U32 flags)
      4.
  • cop_hints_fetch_pvn

    Look up the hint entry in the cop cop with the key specified bykeypv and keylen. If flags has the COPHH_KEY_UTF8 bit set,the key octets are interpreted as UTF-8, otherwise they are interpretedas Latin-1. hash is a precomputed hash of the key string, or zero ifit has not been precomputed. Returns a mortal scalar copy of the valueassociated with the key, or &PL_sv_placeholder if there is no valueassociated with the key.

    1. SV *cop_hints_fetch_pvn(const COP *cop,
      2.  
    2.  const char *keypv,
      3.  
    3.  STRLEN keylen, U32 hash,
      4.  
    4.  U32 flags)
      5.
  • cop_hints_fetch_pvs

    Like cop_hints_fetch_pvn, but takes a literal string instead of astring/length pair, and no precomputed hash.

    1. SV *cop_hints_fetch_pvs(const COP *cop,
      2.  
    2.  const char *key, U32 flags)
      3.
  • cop_hints_fetch_sv

    Like cop_hints_fetch_pvn, but takes a Perl scalar instead of astring/length pair.

    1. SV *cop_hints_fetch_sv(const COP *cop, SV *key,
      2.  
    2.    U32 hash, U32 flags)
      3.

Custom Operators

  • custom_op_register

    Register a custom op. See Custom Operators in perlguts.

    NOTE: this function must be explicitly called as Perl_custom_op_register with an aTHX_ parameter.

    1. voidPerl_custom_op_register(pTHX_ 
      2.  
    2.  Perl_ppaddr_t ppaddr,
      3.  
    3.  const XOP *xop)
      4.
  • custom_op_xop

    Return the XOP structure for a given custom op. This function should beconsidered internal to OP_NAME and the other access macros: use them instead.

    NOTE: this function must be explicitly called as Perl_custom_op_xop with an aTHX_ parameter.

    1. const XOP * Perl_custom_op_xop(pTHX_ const OP *o)
      2.
  • XopDISABLE

    Temporarily disable a member of the XOP, by clearing the appropriate flag.

    1. voidXopDISABLE(XOP *xop, which)
      2.
  • XopENABLE

    Reenable a member of the XOP which has been disabled.

    1. voidXopENABLE(XOP *xop, which)
      2.
  • XopENTRY

    Return a member of the XOP structure. which is a cpp token indicatingwhich entry to return. If the member is not set this will return adefault value. The return type depends on which.

    1. XopENTRY(XOP *xop, which)
      2.
  • XopENTRY_set

    Set a member of the XOP structure. which is a cpp token indicatingwhich entry to set. See Custom Operators in perlguts for details aboutthe available members and how they are used.

    1. voidXopENTRY_set(XOP *xop, which, value)
      2.
  • XopFLAGS

    Return the XOP's flags.

    1. U32XopFLAGS(XOP *xop)
      2.

CV Manipulation Functions

  • CvSTASH

    Returns the stash of the CV. A stash is the symbol table hash, containingthe package-scoped variables in the package where the subroutine was defined.For more information, see perlguts.

    This also has a special use with XS AUTOLOAD subs.See Autoloading with XSUBs in perlguts.

    1. HV*CvSTASH(CV* cv)
      2.
  • get_cv

    Uses strlen to get the length of name, then calls get_cvn_flags.

    NOTE: the perl_ form of this function is deprecated.

    1. CV*get_cv(const char* name, I32 flags)
      2.
  • get_cvn_flags

    Returns the CV of the specified Perl subroutine. flags are passed togv_fetchpvn_flags. If GV_ADD is set and the Perl subroutine does notexist then it will be declared (which has the same effect as sayingsub name;). If GV_ADD is not set and the subroutine does not existthen NULL is returned.

    NOTE: the perl_ form of this function is deprecated.

    1. CV*get_cvn_flags(const char* name, STRLEN len,
      2.  
    2.   I32 flags)
      3.

Embedding Functions

  • cv_clone

    Clone a CV, making a lexical closure. proto supplies the prototypeof the function: its code, pad structure, and other attributes.The prototype is combined with a capture of outer lexicals to which thecode refers, which are taken from the currently-executing instance ofthe immediately surrounding code.

    1. CV *cv_clone(CV *proto)
      2.
  • cv_undef

    Clear out all the active components of a CV. This can happen eitherby an explicit undef &foo, or by the reference count going to zero.In the former case, we keep the CvOUTSIDE pointer, so that any anonymouschildren can still follow the full lexical scope chain.

    1. voidcv_undef(CV* cv)
      2.
  • find_rundefsv

    Find and return the variable that is named $_ in the lexical scopeof the currently-executing function. This may be a lexical $_,or will otherwise be the global one.

    1. SV *find_rundefsv()
      2.
  • find_rundefsvoffset

    Find the position of the lexical $_ in the pad of thecurrently-executing function. Returns the offset in the current pad,or NOT_IN_PAD if there is no lexical $_ in scope (in which casethe global one should be used instead).find_rundefsv is likely to be more convenient.

    NOTE: the perl_ form of this function is deprecated.

    1. PADOFFSET find_rundefsvoffset()
      2.
  • load_module

    Loads the module whose name is pointed to by the string part of name.Note that the actual module name, not its filename, should be given.Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any ofPERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS(or 0 for no flags). ver, if specified and not NULL, provides version semanticssimilar to use Foo::Bar VERSION. The optional trailing SV*arguments can be used to specify arguments to the module's import()method, similar to use Foo::Bar VERSION LIST. They must beterminated with a final NULL pointer. Note that this list can onlybe omitted when the PERL_LOADMOD_NOIMPORT flag has been used.Otherwise at least a single NULL pointer to designate the defaultimport list is required.

    The reference count for each specified SV* parameter is decremented.

    1. voidload_module(U32 flags, SV* name, SV* ver, ...)
      2.
  • nothreadhook

    Stub that provides thread hook for perl_destruct when there areno threads.

    1. intnothreadhook()
      2.
  • pad_add_anon

    Allocates a place in the currently-compiling pad (via pad_alloc)for an anonymous function that is lexically scoped inside thecurrently-compiling function.The function func is linked into the pad, and its CvOUTSIDE linkto the outer scope is weakened to avoid a reference loop.

    optype should be an opcode indicating the type of operation that thepad entry is to support. This doesn't affect operational semantics,but is used for debugging.

    1. PADOFFSET pad_add_anon(CV *func, I32 optype)
      2.
  • pad_add_name_pv

    Exactly like pad_add_name_pvn, but takes a nul-terminated stringinstead of a string/length pair.

    1. PADOFFSET pad_add_name_pv(const char *name, U32 flags,
      2.  
    2.   HV *typestash, HV *ourstash)
      3.
  • pad_add_name_pvn

    Allocates a place in the currently-compiling pad for a named lexicalvariable. Stores the name and other metadata in the name part of thepad, and makes preparations to manage the variable's lexical scoping.Returns the offset of the allocated pad slot.

    namepv/namelen specify the variable's name, including leading sigil.If typestash is non-null, the name is for a typed lexical, and thisidentifies the type. If ourstash is non-null, it's a lexical referenceto a package variable, and this identifies the package. The followingflags can be OR'ed together:

    1.  padadd_OUR  redundantly specifies if it's a package var
      2.  
    2.  padadd_STATE variable will retain value persistently
      3.  
    3.  padadd_NO_DUP_CHECK skip check for lexical shadowing
      4.  
    4.  
    5. PADOFFSET pad_add_name_pvn(const char *namepv,
      6.  
    6.    STRLEN namelen, U32 flags,
      7.  
    7.    HV *typestash, HV *ourstash)
      8.
  • pad_add_name_sv

    Exactly like pad_add_name_pvn, but takes the name string in the formof an SV instead of a string/length pair.

    1. PADOFFSET pad_add_name_sv(SV *name, U32 flags,
      2.  
    2.   HV *typestash, HV *ourstash)
      3.
  • pad_alloc

    Allocates a place in the currently-compiling pad,returning the offset of the allocated pad slot.No name is initially attached to the pad slot.tmptype is a set of flags indicating the kind of pad entry required,which will be set in the value SV for the allocated pad entry:

    1.  SVs_PADMY named lexical variable ("my", "our", "state")
      2.  
    2.  SVs_PADTMP   unnamed temporary store
      3.

    optype should be an opcode indicating the type of operation that thepad entry is to support. This doesn't affect operational semantics,but is used for debugging.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. PADOFFSET pad_alloc(I32 optype, U32 tmptype)
      2.
  • pad_compname_type

    Looks up the type of the lexical variable at position po in thecurrently-compiling pad. If the variable is typed, the stash of theclass to which it is typed is returned. If not, NULL is returned.

    1. HV *pad_compname_type(PADOFFSET po)
      2.
  • pad_findmy_pv

    Exactly like pad_findmy_pvn, but takes a nul-terminated stringinstead of a string/length pair.

    1. PADOFFSET pad_findmy_pv(const char *name, U32 flags)
      2.
  • pad_findmy_pvn

    Given the name of a lexical variable, find its position in thecurrently-compiling pad.namepv/namelen specify the variable's name, including leading sigil.flags is reserved and must be zero.If it is not in the current pad but appears in the pad of any lexicallyenclosing scope, then a pseudo-entry for it is added in the current pad.Returns the offset in the current pad,or NOT_IN_PAD if no such lexical is in scope.

    1. PADOFFSET pad_findmy_pvn(const char *namepv,
      2.  
    2.  STRLEN namelen, U32 flags)
      3.
  • pad_findmy_sv

    Exactly like pad_findmy_pvn, but takes the name string in the formof an SV instead of a string/length pair.

    1. PADOFFSET pad_findmy_sv(SV *name, U32 flags)
      2.
  • pad_setsv

    Set the value at offset po in the current (compiling or executing) pad.Use the macro PAD_SETSV() rather than calling this function directly.

    1. voidpad_setsv(PADOFFSET po, SV *sv)
      2.
  • pad_sv

    Get the value at offset po in the current (compiling or executing) pad.Use macro PAD_SV instead of calling this function directly.

    1. SV *pad_sv(PADOFFSET po)
      2.
  • pad_tidy

    Tidy up a pad at the end of compilation of the code to which it belongs.Jobs performed here are: remove most stuff from the pads of anonsubprototypes; give it a @_; mark temporaries as such. type indicatesthe kind of subroutine:

    1.  padtidy_SUB ordinary subroutine
      2.  
    2.  padtidy_SUBCLONE   prototype for lexical closure
      3.  
    3.  padtidy_FORMAT format
      4.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. voidpad_tidy(padtidy_type type)
      2.
  • perl_alloc

    Allocates a new Perl interpreter. See perlembed.

    1. PerlInterpreter* perl_alloc()
      2.
  • perl_construct

    Initializes a new Perl interpreter. See perlembed.

    1. voidperl_construct(PerlInterpreter *my_perl)
      2.
  • perl_destruct

    Shuts down a Perl interpreter. See perlembed.

    1. intperl_destruct(PerlInterpreter *my_perl)
      2.
  • perl_free

    Releases a Perl interpreter. See perlembed.

    1. voidperl_free(PerlInterpreter *my_perl)
      2.
  • perl_parse

    Tells a Perl interpreter to parse a Perl script. See perlembed.

    1. intperl_parse(PerlInterpreter *my_perl,
      2.  
    2.    XSINIT_t xsinit, int argc,
      3.  
    3.    char** argv, char** env)
      4.
  • perl_run

    Tells a Perl interpreter to run. See perlembed.

    1. intperl_run(PerlInterpreter *my_perl)
      2.
  • require_pv

    Tells Perl to require the file named by the string argument. It isanalogous to the Perl code eval "require '$file'". It's evenimplemented that way; consider using load_module instead.

    NOTE: the perl_ form of this function is deprecated.

    1. voidrequire_pv(const char* pv)
      2.

Functions in file dump.c

  • pv_display

    Similar to

    1.   pv_escape(dsv,pv,cur,pvlim,PERL_PV_ESCAPE_QUOTE);
      2.

    except that an additional "\0" will be appended to the string whenlen > cur and pv[cur] is "\0".

    Note that the final string may be up to 7 chars longer than pvlim.

    1. char*pv_display(SV *dsv, const char *pv, STRLEN cur,
      2.  
    2.    STRLEN len, STRLEN pvlim)
      3.
  • pv_escape

    Escapes at most the first "count" chars of pv and puts the results intodsv such that the size of the escaped string will not exceed "max" charsand will not contain any incomplete escape sequences.

    If flags contains PERL_PV_ESCAPE_QUOTE then any double quotes in the stringwill also be escaped.

    Normally the SV will be cleared before the escaped string is prepared,but when PERL_PV_ESCAPE_NOCLEAR is set this will not occur.

    If PERL_PV_ESCAPE_UNI is set then the input string is treated as Unicode,if PERL_PV_ESCAPE_UNI_DETECT is set then the input string is scannedusing is_utf8_string() to determine if it is Unicode.

    If PERL_PV_ESCAPE_ALL is set then all input chars will be outputusing \x01F1 style escapes, otherwise if PERL_PV_ESCAPE_NONASCII is set, onlychars above 127 will be escaped using this style; otherwise, only chars above255 will be so escaped; other non printable chars will use octal orcommon escaped patterns like \n. Otherwise, if PERL_PV_ESCAPE_NOBACKSLASHthen all chars below 255 will be treated as printable andwill be output as literals.

    If PERL_PV_ESCAPE_FIRSTCHAR is set then only the first char of thestring will be escaped, regardless of max. If the output is to be in hex,then it will be returned as a plain hexsequence. Thus the output will either be a single char,an octal escape sequence, a special escape like \n or a hex value.

    If PERL_PV_ESCAPE_RE is set then the escape char used will be a '%' andnot a '\'. This is because regexes very often contain backslashedsequences, whereas '%' is not a particularly common character in patterns.

    Returns a pointer to the escaped text as held by dsv.

    1. char*pv_escape(SV *dsv, char const * const str,
      2.  
    2.   const STRLEN count, const STRLEN max,
      3.  
    3.   STRLEN * const escaped,
      4.  
    4.   const U32 flags)
      5.
  • pv_pretty

    Converts a string into something presentable, handling escaping viapv_escape() and supporting quoting and ellipses.

    If the PERL_PV_PRETTY_QUOTE flag is set then the result will be double quoted with any double quotes in the string escaped. Otherwiseif the PERL_PV_PRETTY_LTGT flag is set then the result be wrapped inangle brackets.

    If the PERL_PV_PRETTY_ELLIPSES flag is set and not all characters instring were output then an ellipsis ... will be appended to thestring. Note that this happens AFTER it has been quoted.

    If start_color is non-null then it will be inserted after the openingquote (if there is one) but before the escaped text. If end_coloris non-null then it will be inserted after the escaped text but beforeany quotes or ellipses.

    Returns a pointer to the prettified text as held by dsv.

    1. char*pv_pretty(SV *dsv, char const * const str,
      2.  
    2.   const STRLEN count, const STRLEN max,
      3.  
    3.   char const * const start_color,
      4.  
    4.   char const * const end_color,
      5.  
    5.   const U32 flags)
      6.

Functions in file mathoms.c

  • custom_op_desc

    Return the description of a given custom op. This was once used by theOP_DESC macro, but is no longer: it has only been kept forcompatibility, and should not be used.

    1. const char * custom_op_desc(const OP *o)
      2.
  • custom_op_name

    Return the name for a given custom op. This was once used by the OP_NAMEmacro, but is no longer: it has only been kept for compatibility, andshould not be used.

    1. const char * custom_op_name(const OP *o)
      2.
  • gv_fetchmethod

    See gv_fetchmethod_autoload.

    1. GV*gv_fetchmethod(HV* stash, const char* name)
      2.
  • pack_cat

    The engine implementing pack() Perl function. Note: parameters next_in_list andflags are not used. This call should not be used; use packlist instead.

    1. voidpack_cat(SV *cat, const char *pat,
      2.  
    2.  const char *patend, SV **beglist,
      3.  
    3.  SV **endlist, SV ***next_in_list,
      4.  
    4.  U32 flags)
      5.
  • sv_2pvbyte_nolen

    Return a pointer to the byte-encoded representation of the SV.May cause the SV to be downgraded from UTF-8 as a side-effect.

    Usually accessed via the SvPVbyte_nolen macro.

    1. char*sv_2pvbyte_nolen(SV* sv)
      2.
  • sv_2pvutf8_nolen

    Return a pointer to the UTF-8-encoded representation of the SV.May cause the SV to be upgraded to UTF-8 as a side-effect.

    Usually accessed via the SvPVutf8_nolen macro.

    1. char*sv_2pvutf8_nolen(SV* sv)
      2.
  • sv_2pv_nolen

    Like sv_2pv(), but doesn't return the length too. You should usuallyuse the macro wrapper SvPV_nolen(sv) instead.

    1. char*sv_2pv_nolen(SV* sv)
      2.
  • sv_catpvn_mg

    Like sv_catpvn, but also handles 'set' magic.

    1. voidsv_catpvn_mg(SV *sv, const char *ptr,
      2.  
    2.  STRLEN len)
      3.
  • sv_catsv_mg

    Like sv_catsv, but also handles 'set' magic.

    1. voidsv_catsv_mg(SV *dsv, SV *ssv)
      2.
  • sv_force_normal

    Undo various types of fakery on an SV: if the PV is a shared string, makea private copy; if we're a ref, stop refing; if we're a glob, downgrade toan xpvmg. See also sv_force_normal_flags.

    1. voidsv_force_normal(SV *sv)
      2.
  • sv_iv

    A private implementation of the SvIVx macro for compilers which can'tcope with complex macro expressions. Always use the macro instead.

    1. IVsv_iv(SV* sv)
      2.
  • sv_nolocking

    Dummy routine which "locks" an SV when there is no locking module present.Exists to avoid test for a NULL function pointer and because it couldpotentially warn under some level of strict-ness.

    "Superseded" by sv_nosharing().

    1. voidsv_nolocking(SV *sv)
      2.
  • sv_nounlocking

    Dummy routine which "unlocks" an SV when there is no locking module present.Exists to avoid test for a NULL function pointer and because it couldpotentially warn under some level of strict-ness.

    "Superseded" by sv_nosharing().

    1. voidsv_nounlocking(SV *sv)
      2.
  • sv_nv

    A private implementation of the SvNVx macro for compilers which can'tcope with complex macro expressions. Always use the macro instead.

    1. NVsv_nv(SV* sv)
      2.
  • sv_pv

    Use the SvPV_nolen macro instead

    1. char*sv_pv(SV *sv)
      2.
  • sv_pvbyte

    Use SvPVbyte_nolen instead.

    1. char*sv_pvbyte(SV *sv)
      2.
  • sv_pvbyten

    A private implementation of the SvPVbyte macro for compilerswhich can't cope with complex macro expressions. Always use the macroinstead.

    1. char*sv_pvbyten(SV *sv, STRLEN *lp)
      2.
  • sv_pvn

    A private implementation of the SvPV macro for compilers which can'tcope with complex macro expressions. Always use the macro instead.

    1. char*sv_pvn(SV *sv, STRLEN *lp)
      2.
  • sv_pvutf8

    Use the SvPVutf8_nolen macro instead

    1. char*sv_pvutf8(SV *sv)
      2.
  • sv_pvutf8n

    A private implementation of the SvPVutf8 macro for compilerswhich can't cope with complex macro expressions. Always use the macroinstead.

    1. char*sv_pvutf8n(SV *sv, STRLEN *lp)
      2.
  • sv_taint

    Taint an SV. Use SvTAINTED_on instead.

    1. voidsv_taint(SV* sv)
      2.
  • sv_unref

    Unsets the RV status of the SV, and decrements the reference count ofwhatever was being referenced by the RV. This can almost be thought ofas a reversal of newSVrv. This is sv_unref_flags with the flagbeing zero. See SvROK_off.

    1. voidsv_unref(SV* sv)
      2.
  • sv_usepvn

    Tells an SV to use ptr to find its string value. Implemented bycalling sv_usepvn_flags with flags of 0, hence does not handle 'set'magic. See sv_usepvn_flags.

    1. voidsv_usepvn(SV* sv, char* ptr, STRLEN len)
      2.
  • sv_usepvn_mg

    Like sv_usepvn, but also handles 'set' magic.

    1. voidsv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
      2.
  • sv_uv

    A private implementation of the SvUVx macro for compilers which can'tcope with complex macro expressions. Always use the macro instead.

    1. UVsv_uv(SV* sv)
      2.
  • unpack_str

    The engine implementing unpack() Perl function. Note: parameters strbeg, new_sand ocnt are not used. This call should not be used, use unpackstring instead.

    1. I32unpack_str(const char *pat, const char *patend,
      2.  
    2.    const char *s, const char *strbeg,
      3.  
    3.       const char *strend, char **new_s,
      4.  
    4.    I32 ocnt, U32 flags)
      5.

Functions in file op.c

  • op_contextualize

    Applies a syntactic context to an op tree representing an expression.o is the op tree, and context must be G_SCALAR, G_ARRAY,or G_VOID to specify the context to apply. The modified op treeis returned.

    1. OP *op_contextualize(OP *o, I32 context)
      2.

Functions in file perl.h

  • PERL_SYS_INIT

    Provides system-specific tune up of the C runtime environment necessary torun Perl interpreters. This should be called only once, before creatingany Perl interpreters.

    1. voidPERL_SYS_INIT(int argc, char** argv)
      2.
  • PERL_SYS_INIT3

    Provides system-specific tune up of the C runtime environment necessary torun Perl interpreters. This should be called only once, before creatingany Perl interpreters.

    1. voidPERL_SYS_INIT3(int argc, char** argv,
      2.  
    2.    char** env)
      3.
  • PERL_SYS_TERM

    Provides system-specific clean up of the C runtime environment afterrunning Perl interpreters. This should be called only once, afterfreeing any remaining Perl interpreters.

    1. voidPERL_SYS_TERM()
      2.

Functions in file pp_ctl.c

  • caller_cx

    The XSUB-writer's equivalent of caller. Thereturned PERL_CONTEXT structure can be interrogated to find all theinformation returned to Perl by caller. Note that XSUBs don't get astack frame, so caller_cx(0, NULL) will return information for theimmediately-surrounding Perl code.

    This function skips over the automatic calls to &DB::sub made on thebehalf of the debugger. If the stack frame requested was a sub called byDB::sub, the return value will be the frame for the call toDB::sub, since that has the correct line number/etc. for the callsite. If dbcxp is non-NULL, it will be set to a pointer to theframe for the sub call itself.

    1. const PERL_CONTEXT * caller_cx(
      2.  
    2.  I32 level,
      3.  
    3.  const PERL_CONTEXT **dbcxp
      4.  
    4.  )
      5.
  • find_runcv

    Locate the CV corresponding to the currently executing sub or eval.If db_seqp is non_null, skip CVs that are in the DB package and populate*db_seqp with the cop sequence number at the point that the DB:: code wasentered. (allows debuggers to eval in the scope of the breakpoint ratherthan in the scope of the debugger itself).

    1. CV*find_runcv(U32 *db_seqp)
      2.

Functions in file pp_pack.c

  • packlist

    The engine implementing pack() Perl function.

    1. voidpacklist(SV *cat, const char *pat,
      2.  
    2.  const char *patend, SV **beglist,
      3.  
    3.  SV **endlist)
      4.
  • unpackstring

    The engine implementing unpack() Perl function. unpackstring puts theextracted list items on the stack and returns the number of elements.Issue PUTBACK before and SPAGAIN after the call to this function.

    1. I32unpackstring(const char *pat,
      2.  
    2.  const char *patend, const char *s,
      3.  
    3.   const char *strend, U32 flags)
      4.

Functions in file pp_sys.c

  • setdefout

    Sets PL_defoutgv, the default file handle for output, to the passed intypeglob. As PL_defoutgv "owns" a reference on its typeglob, the referencecount of the passed in typeglob is increased by one, and the reference countof the typeglob that PL_defoutgv points to is decreased by one.

    1. voidsetdefout(GV* gv)
      2.

Functions in file utf8.h

  • ibcmp_utf8

    This is a synonym for (! foldEQ_utf8())

    1. I32ibcmp_utf8(const char *s1, char **pe1, UV l1,
      2.  
    2.    bool u1, const char *s2, char **pe2,
      3.  
    3.    UV l2, bool u2)
      4.

Functions in file util.h

  • ibcmp

    This is a synonym for (! foldEQ())

    1. I32ibcmp(const char* a, const char* b, I32 len)
      2.
  • ibcmp_locale

    This is a synonym for (! foldEQ_locale())

    1. I32ibcmp_locale(const char* a, const char* b,
      2.  
    2.  I32 len)
      3.

Global Variables

  • PL_check

    Array, indexed by opcode, of functions that will be called for the "check"phase of optree building during compilation of Perl code. For most (butnot all) types of op, once the op has been initially built and populatedwith child ops it will be filtered through the check function referencedby the appropriate element of this array. The new op is passed in as thesole argument to the check function, and the check function returns thecompleted op. The check function may (as the name suggests) check the opfor validity and signal errors. It may also initialise or modify parts ofthe ops, or perform more radical surgery such as adding or removing childops, or even throw the op away and return a different op in its place.

    This array of function pointers is a convenient place to hook into thecompilation process. An XS module can put its own custom check functionin place of any of the standard ones, to influence the compilation of aparticular type of op. However, a custom check function must never fullyreplace a standard check function (or even a custom check function fromanother module). A module modifying checking must instead wrap thepreexisting check function. A custom check function must be selectiveabout when to apply its custom behaviour. In the usual case whereit decides not to do anything special with an op, it must chain thepreexisting op function. Check functions are thus linked in a chain,with the core's base checker at the end.

    For thread safety, modules should not write directly to this array.Instead, use the function wrap_op_checker.

  • PL_keyword_plugin

    Function pointer, pointing at a function used to handle extended keywords.The function should be declared as

    1. int keyword_plugin_function(pTHX_
      2.  
    2. char *keyword_ptr, STRLEN keyword_len,
      3.  
    3. OP **op_ptr)
      4.

    The function is called from the tokeniser, whenever a possible keywordis seen. keyword_ptr points at the word in the parser's inputbuffer, and keyword_len gives its length; it is not null-terminated.The function is expected to examine the word, and possibly other statesuch as %^H, to decide whether it wants to handle itas an extended keyword. If it does not, the function should returnKEYWORD_PLUGIN_DECLINE, and the normal parser process will continue.

    If the function wants to handle the keyword, it first mustparse anything following the keyword that is part of the syntaxintroduced by the keyword. See Lexer interface for details.

    When a keyword is being handled, the plugin function must builda tree of OP structures, representing the code that was parsed.The root of the tree must be stored in *op_ptr. The function thenreturns a constant indicating the syntactic role of the construct thatit has parsed: KEYWORD_PLUGIN_STMT if it is a complete statement, orKEYWORD_PLUGIN_EXPR if it is an expression. Note that a statementconstruct cannot be used inside an expression (except via do BLOCKand similar), and an expression is not a complete statement (it requiresat least a terminating semicolon).

    When a keyword is handled, the plugin function may also have(compile-time) side effects. It may modify %^H, define functions, andso on. Typically, if side effects are the main purpose of a handler,it does not wish to generate any ops to be included in the normalcompilation. In this case it is still required to supply an op tree,but it suffices to generate a single null op.

    That's how the *PL_keyword_plugin function needs to behave overall.Conventionally, however, one does not completely replace the existinghandler function. Instead, take a copy of PL_keyword_plugin beforeassigning your own function pointer to it. Your handler function shouldlook for keywords that it is interested in and handle those. Where itis not interested, it should call the saved plugin function, passing onthe arguments it received. Thus PL_keyword_plugin actually pointsat a chain of handler functions, all of which have an opportunity tohandle keywords, and only the last function in the chain (built intothe Perl core) will normally return KEYWORD_PLUGIN_DECLINE.

    NOTE: this function is experimental and may change or beremoved without notice.

GV Functions

  • GvSV

    Return the SV from the GV.

    1. SV*GvSV(GV* gv)
      2.
  • gv_const_sv

    If gv is a typeglob whose subroutine entry is a constant sub eligible forinlining, or gv is a placeholder reference that would be promoted to sucha typeglob, then returns the value returned by the sub. Otherwise, returnsNULL.

    1. SV*gv_const_sv(GV* gv)
      2.
  • gv_fetchmeth

    Like gv_fetchmeth_pvn, but lacks a flags parameter.

    1. GV*gv_fetchmeth(HV* stash, const char* name,
      2.  
    2.  STRLEN len, I32 level)
      3.
  • gv_fetchmethod_autoload

    Returns the glob which contains the subroutine to call to invoke the methodon the stash. In fact in the presence of autoloading this may be theglob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD isalready setup.

    The third parameter of gv_fetchmethod_autoload determines whetherAUTOLOAD lookup is performed if the given method is not present: non-zeromeans yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.Calling gv_fetchmethod is equivalent to calling gv_fetchmethod_autoloadwith a non-zero autoload parameter.

    These functions grant "SUPER" token as a prefix of the method name. Notethat if you want to keep the returned glob for a long time, you need tocheck for it being "AUTOLOAD", since at the later time the call may load adifferent subroutine due to $AUTOLOAD changing its value. Use the globcreated via a side effect to do this.

    These functions have the same side-effects and as gv_fetchmeth withlevel==0. name should be writable if contains ':' or '''. The warning against passing the GV returned by gv_fetchmeth tocall_sv apply equally to these functions.

    1. GV*gv_fetchmethod_autoload(HV* stash,
      2.  
    2.  const char* name,
      3.  
    3.  I32 autoload)
      4.
  • gv_fetchmeth_autoload

    This is the old form of gv_fetchmeth_pvn_autoload, which has no flagsparameter.

    1. GV*gv_fetchmeth_autoload(HV* stash,
      2.  
    2.   const char* name,
      3.  
    3.   STRLEN len, I32 level)
      4.
  • gv_fetchmeth_pv

    Exactly like gv_fetchmeth_pvn, but takes a nul-terminated string instead of a string/length pair.

    1. GV*gv_fetchmeth_pv(HV* stash, const char* name,
      2.  
    2.  I32 level, U32 flags)
      3.
  • gv_fetchmeth_pvn

    Returns the glob with the given name and a defined subroutine orNULL. The glob lives in the given stash, or in the stashesaccessible via @ISA and UNIVERSAL::.

    The argument level should be either 0 or -1. If level==0, as aside-effect creates a glob with the given name in the given stashwhich in the case of success contains an alias for the subroutine, and setsup caching info for this glob.

    Currently, the only significant value for flags is SVf_UTF8.

    This function grants "SUPER" token as a postfix of the stash name. TheGV returned from gv_fetchmeth may be a method cache entry, which is notvisible to Perl code. So when calling call_sv, you should not usethe GV directly; instead, you should use the method's CV, which can beobtained from the GV with the GvCV macro.

    1. GV*gv_fetchmeth_pvn(HV* stash, const char* name,
      2.  
    2.  STRLEN len, I32 level,
      3.  
    3.  U32 flags)
      4.
  • gv_fetchmeth_pvn_autoload

    Same as gv_fetchmeth_pvn(), but looks for autoloaded subroutines too.Returns a glob for the subroutine.

    For an autoloaded subroutine without a GV, will create a GV evenif level < 0. For an autoloaded subroutine without a stub, GvCV()of the result may be zero.

    Currently, the only significant value for flags is SVf_UTF8.

    1. GV*gv_fetchmeth_pvn_autoload(HV* stash,
      2.  
    2.   const char* name,
      3.  
    3.   STRLEN len, I32 level,
      4.  
    4.   U32 flags)
      5.
  • gv_fetchmeth_pv_autoload

    Exactly like gv_fetchmeth_pvn_autoload, but takes a nul-terminated stringinstead of a string/length pair.

    1. GV*gv_fetchmeth_pv_autoload(HV* stash,
      2.  
    2.  const char* name,
      3.  
    3.  I32 level, U32 flags)
      4.
  • gv_fetchmeth_sv

    Exactly like gv_fetchmeth_pvn, but takes the name string in the formof an SV instead of a string/length pair.

    1. GV*gv_fetchmeth_sv(HV* stash, SV* namesv,
      2.  
    2.  I32 level, U32 flags)
      3.
  • gv_fetchmeth_sv_autoload

    Exactly like gv_fetchmeth_pvn_autoload, but takes the name string in the formof an SV instead of a string/length pair.

    1. GV*gv_fetchmeth_sv_autoload(HV* stash, SV* namesv,
      2.  
    2.  I32 level, U32 flags)
      3.
  • gv_init

    The old form of gv_init_pvn(). It does not work with UTF8 strings, as ithas no flags parameter. If the multi parameter is set, theGV_ADDMULTI flag will be passed to gv_init_pvn().

    1. voidgv_init(GV* gv, HV* stash, const char* name,
      2.  
    2.  STRLEN len, int multi)
      3.
  • gv_init_pv

    Same as gv_init_pvn(), but takes a nul-terminated string for the nameinstead of separate char * and length parameters.

    1. voidgv_init_pv(GV* gv, HV* stash, const char* name,
      2.  
    2.    U32 flags)
      3.
  • gv_init_pvn

    Converts a scalar into a typeglob. This is an incoercible typeglob;assigning a reference to it will assign to one of its slots, instead ofoverwriting it as happens with typeglobs created by SvSetSV. Convertingany scalar that is SvOK() may produce unpredictable results and is reservedfor perl's internal use.

    gv is the scalar to be converted.

    stash is the parent stash/package, if any.

    name and len give the name. The name must be unqualified;that is, it must not include the package name. If gv is astash element, it is the caller's responsibility to ensure that the namepassed to this function matches the name of the element. If it does notmatch, perl's internal bookkeeping will get out of sync.

    flags can be set to SVf_UTF8 if name is a UTF8 string, orthe return value of SvUTF8(sv). It can also take theGV_ADDMULTI flag, which means to pretend that the GV has beenseen before (i.e., suppress "Used once" warnings).

    1. voidgv_init_pvn(GV* gv, HV* stash, const char* name,
      2.  
    2.  STRLEN len, U32 flags)
      3.
  • gv_init_sv

    Same as gv_init_pvn(), but takes an SV * for the name instead of separatechar * and length parameters. flags is currently unused.

    1. voidgv_init_sv(GV* gv, HV* stash, SV* namesv,
      2.  
    2.    U32 flags)
      3.
  • gv_stashpv

    Returns a pointer to the stash for a specified package. Uses strlen todetermine the length of name, then calls gv_stashpvn().

    1. HV*gv_stashpv(const char* name, I32 flags)
      2.
  • gv_stashpvn

    Returns a pointer to the stash for a specified package. The namelenparameter indicates the length of the name, in bytes. flags is passedto gv_fetchpvn_flags(), so if set to GV_ADD then the package will becreated if it does not already exist. If the package does not exist andflags is 0 (or any other setting that does not create packages) then NULLis returned.

    1. HV*gv_stashpvn(const char* name, U32 namelen,
      2.  
    2.  I32 flags)
      3.
  • gv_stashpvs

    Like gv_stashpvn, but takes a literal string instead of a string/length pair.

    1. HV*gv_stashpvs(const char* name, I32 create)
      2.
  • gv_stashsv

    Returns a pointer to the stash for a specified package. See gv_stashpvn.

    1. HV*gv_stashsv(SV* sv, I32 flags)
      2.

Handy Values

  • Nullav

    Null AV pointer.

    (deprecated - use (AV *)NULL instead)

  • Nullch

    Null character pointer. (No longer available when PERL_CORE is defined.)

  • Nullcv

    Null CV pointer.

    (deprecated - use (CV *)NULL instead)

  • Nullhv

    Null HV pointer.

    (deprecated - use (HV *)NULL instead)

  • Nullsv

    Null SV pointer. (No longer available when PERL_CORE is defined.)

Hash Manipulation Functions

  • cop_fetch_label

    Returns the label attached to a cop.The flags pointer may be set to SVf_UTF8 or 0.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. const char * cop_fetch_label(COP *const cop,
      2.  
    2.  STRLEN *len, U32 *flags)
      3.
  • cop_store_label

    Save a label into a cop_hints_hash. You need to set flags to SVf_UTF8for a utf-8 label.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. voidcop_store_label(COP *const cop,
      2.  
    2.  const char *label, STRLEN len,
      3.  
    3.  U32 flags)
      4.
  • get_hv

    Returns the HV of the specified Perl hash. flags are passed togv_fetchpv. If GV_ADD is set and thePerl variable does not exist then it will be created. If flags is zeroand the variable does not exist then NULL is returned.

    NOTE: the perl_ form of this function is deprecated.

    1. HV*get_hv(const char *name, I32 flags)
      2.
  • HEf_SVKEY

    This flag, used in the length slot of hash entries and magic structures,specifies the structure contains an SV* pointer where a char* pointeris to be expected. (For information only--not to be used).

  • HeHASH

    Returns the computed hash stored in the hash entry.

    1. U32HeHASH(HE* he)
      2.
  • HeKEY

    Returns the actual pointer stored in the key slot of the hash entry. Thepointer may be either char* or SV*, depending on the value ofHeKLEN(). Can be assigned to. The HePV() or HeSVKEY() macros areusually preferable for finding the value of a key.

    1. void*HeKEY(HE* he)
      2.
  • HeKLEN

    If this is negative, and amounts to HEf_SVKEY, it indicates the entryholds an SV* key. Otherwise, holds the actual length of the key. Canbe assigned to. The HePV() macro is usually preferable for finding keylengths.

    1. STRLENHeKLEN(HE* he)
      2.
  • HePV

    Returns the key slot of the hash entry as a char* value, doing anynecessary dereferencing of possibly SV* keys. The length of the stringis placed in len (this is a macro, so do not use &len). If you donot care about what the length of the key is, you may use the globalvariable PL_na, though this is rather less efficient than using a localvariable. Remember though, that hash keys in perl are free to containembedded nulls, so using strlen() or similar is not a good way to findthe length of hash keys. This is very similar to the SvPV() macrodescribed elsewhere in this document. See also HeUTF8.

    If you are using HePV to get values to pass to newSVpvn() to create anew SV, you should consider using newSVhek(HeKEY_hek(he)) as it is moreefficient.

    1. char*HePV(HE* he, STRLEN len)
      2.
  • HeSVKEY

    Returns the key as an SV*, or NULL if the hash entry does notcontain an SV* key.

    1. SV*HeSVKEY(HE* he)
      2.
  • HeSVKEY_force

    Returns the key as an SV*. Will create and return a temporary mortalSV* if the hash entry contains only a char* key.

    1. SV*HeSVKEY_force(HE* he)
      2.
  • HeSVKEY_set

    Sets the key to a given SV*, taking care to set the appropriate flags toindicate the presence of an SV* key, and returns the sameSV*.

    1. SV*HeSVKEY_set(HE* he, SV* sv)
      2.
  • HeUTF8

    Returns whether the char * value returned by HePV is encoded in UTF-8,doing any necessary dereferencing of possibly SV* keys. The value returnedwill be 0 or non-0, not necessarily 1 (or even a value with any low bits set),so do not blindly assign this to a bool variable, as bool may be atypedef for char.

    1. char*HeUTF8(HE* he)
      2.
  • HeVAL

    Returns the value slot (type SV*) stored in the hash entry.

    1. SV*HeVAL(HE* he)
      2.
  • HvENAME

    Returns the effective name of a stash, or NULL if there is none. Theeffective name represents a location in the symbol table where this stashresides. It is updated automatically when packages are aliased or deleted.A stash that is no longer in the symbol table has no effective name. Thisname is preferable to HvNAME for use in MRO linearisations and isacaches.

    1. char*HvENAME(HV* stash)
      2.
  • HvENAMELEN

    Returns the length of the stash's effective name.

    1. STRLENHvENAMELEN(HV *stash)
      2.
  • HvENAMEUTF8

    Returns true if the effective name is in UTF8 encoding.

    1. unsigned char HvENAMEUTF8(HV *stash)
      2.
  • HvNAME

    Returns the package name of a stash, or NULL if stash isn't a stash.See SvSTASH, CvSTASH.

    1. char*HvNAME(HV* stash)
      2.
  • HvNAMELEN

    Returns the length of the stash's name.

    1. STRLENHvNAMELEN(HV *stash)
      2.
  • HvNAMEUTF8

    Returns true if the name is in UTF8 encoding.

    1. unsigned char HvNAMEUTF8(HV *stash)
      2.
  • hv_assert

    Check that a hash is in an internally consistent state.

    1. voidhv_assert(HV *hv)
      2.
  • hv_clear

    Frees the all the elements of a hash, leaving it empty.The XS equivalent of %hash = (). See also hv_undef.

    If any destructors are triggered as a result, the hv itself maybe freed.

    1. voidhv_clear(HV *hv)
      2.
  • hv_clear_placeholders

    Clears any placeholders from a hash. If a restricted hash has any of its keysmarked as readonly and the key is subsequently deleted, the key is not actuallydeleted but is marked by assigning it a value of &PL_sv_placeholder. This tagsit so it will be ignored by future operations such as iterating over the hash,but will still allow the hash to have a value reassigned to the key at somefuture point. This function clears any such placeholder keys from the hash.See Hash::Util::lock_keys() for an example of its use.

    1. voidhv_clear_placeholders(HV *hv)
      2.
  • hv_copy_hints_hv

    A specialised version of newHVhv for copying %^H. ohv must bea pointer to a hash (which may have %^H magic, but should be generallynon-magical), or NULL (interpreted as an empty hash). The contentof ohv is copied to a new hash, which has the %^H-specific magicadded to it. A pointer to the new hash is returned.

    1. HV *hv_copy_hints_hv(HV *ohv)
      2.
  • hv_delete

    Deletes a key/value pair in the hash. The value's SV is removed fromthe hash, made mortal, and returned to the caller. The absolutevalue of klen is the length of the key. If klen is negative thekey is assumed to be in UTF-8-encoded Unicode. The flags valuewill normally be zero; if set to G_DISCARD then NULL will be returned.NULL will also be returned if the key is not found.

    1. SV*hv_delete(HV *hv, const char *key, I32 klen,
      2.  
    2.   I32 flags)
      3.
  • hv_delete_ent

    Deletes a key/value pair in the hash. The value SV is removed from the hash,made mortal, and returned to the caller. The flags value will normally bezero; if set to G_DISCARD then NULL will be returned. NULL will also bereturned if the key is not found. hash can be a valid precomputed hashvalue, or 0 to ask for it to be computed.

    1. SV*hv_delete_ent(HV *hv, SV *keysv, I32 flags,
      2.  
    2.   U32 hash)
      3.
  • hv_exists

    Returns a boolean indicating whether the specified hash key exists. Theabsolute value of klen is the length of the key. If klen isnegative the key is assumed to be in UTF-8-encoded Unicode.

    1. boolhv_exists(HV *hv, const char *key, I32 klen)
      2.
  • hv_exists_ent

    Returns a boolean indicating whetherthe specified hash key exists. hashcan be a valid precomputed hash value, or 0 to ask for it to becomputed.

    1. boolhv_exists_ent(HV *hv, SV *keysv, U32 hash)
      2.
  • hv_fetch

    Returns the SV which corresponds to the specified key in the hash.The absolute value of klen is the length of the key. If klen isnegative the key is assumed to be in UTF-8-encoded Unicode. Iflval is set then the fetch will be part of a store. Check that thereturn value is non-null before dereferencing it to an SV*.

    See Understanding the Magic of Tied Hashes and Arrays in perlguts for moreinformation on how to use this function on tied hashes.

    1. SV**hv_fetch(HV *hv, const char *key, I32 klen,
      2.  
    2.  I32 lval)
      3.
  • hv_fetchs

    Like hv_fetch, but takes a literal string instead of a string/length pair.

    1. SV**hv_fetchs(HV* tb, const char* key, I32 lval)
      2.
  • hv_fetch_ent

    Returns the hash entry which corresponds to the specified key in the hash.hash must be a valid precomputed hash number for the given key, or 0if you want the function to compute it. IF lval is set then the fetchwill be part of a store. Make sure the return value is non-null beforeaccessing it. The return value when hv is a tied hash is a pointer to astatic location, so be sure to make a copy of the structure if you need tostore it somewhere.

    See Understanding the Magic of Tied Hashes and Arrays in perlguts for moreinformation on how to use this function on tied hashes.

    1. HE*hv_fetch_ent(HV *hv, SV *keysv, I32 lval,
      2.  
    2.  U32 hash)
      3.
  • hv_fill

    Returns the number of hash buckets that happen to be in use. This function iswrapped by the macro HvFILL.

    Previously this value was stored in the HV structure, rather than beingcalculated on demand.

    1. STRLENhv_fill(HV const *const hv)
      2.
  • hv_iterinit

    Prepares a starting point to traverse a hash table. Returns the number ofkeys in the hash (i.e. the same as HvUSEDKEYS(hv)). The return value iscurrently only meaningful for hashes without tie magic.

    NOTE: Before version 5.004_65, hv_iterinit used to return the number ofhash buckets that happen to be in use. If you still need that esotericvalue, you can get it through the macro HvFILL(hv).

    1. I32hv_iterinit(HV *hv)
      2.
  • hv_iterkey

    Returns the key from the current position of the hash iterator. Seehv_iterinit.

    1. char*hv_iterkey(HE* entry, I32* retlen)
      2.
  • hv_iterkeysv

    Returns the key as an SV* from the current position of the hashiterator. The return value will always be a mortal copy of the key. Alsosee hv_iterinit.

    1. SV*hv_iterkeysv(HE* entry)
      2.
  • hv_iternext

    Returns entries from a hash iterator. See hv_iterinit.

    You may call hv_delete or hv_delete_ent on the hash entry that theiterator currently points to, without losing your place or invalidating youriterator. Note that in this case the current entry is deleted from the hashwith your iterator holding the last reference to it. Your iterator is flaggedto free the entry on the next call to hv_iternext, so you must not discardyour iterator immediately else the entry will leak - call hv_iternext totrigger the resource deallocation.

    1. HE*hv_iternext(HV *hv)
      2.
  • hv_iternextsv

    Performs an hv_iternext, hv_iterkey, and hv_iterval in oneoperation.

    1. SV*hv_iternextsv(HV *hv, char **key, I32 *retlen)
      2.
  • hv_iternext_flags

    Returns entries from a hash iterator. See hv_iterinit and hv_iternext.The flags value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS isset the placeholders keys (for restricted hashes) will be returned in additionto normal keys. By default placeholders are automatically skipped over.Currently a placeholder is implemented with a value that is&PL_sv_placeholder. Note that the implementation of placeholders andrestricted hashes may change, and the implementation currently isinsufficiently abstracted for any change to be tidy.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. HE*hv_iternext_flags(HV *hv, I32 flags)
      2.
  • hv_iterval

    Returns the value from the current position of the hash iterator. Seehv_iterkey.

    1. SV*hv_iterval(HV *hv, HE *entry)
      2.
  • hv_magic

    Adds magic to a hash. See sv_magic.

    1. voidhv_magic(HV *hv, GV *gv, int how)
      2.
  • hv_scalar

    Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.

    1. SV*hv_scalar(HV *hv)
      2.
  • hv_store

    Stores an SV in a hash. The hash key is specified as key and theabsolute value of klen is the length of the key. If klen isnegative the key is assumed to be in UTF-8-encoded Unicode. Thehash parameter is the precomputed hash value; if it is zero thenPerl will compute it.

    The return value will beNULL if the operation failed or if the value did not need to be actuallystored within the hash (as in the case of tied hashes). Otherwise it canbe dereferenced to get the original SV*. Note that the caller isresponsible for suitably incrementing the reference count of val beforethe call, and decrementing it if the function returned NULL. Effectivelya successful hv_store takes ownership of one reference to val. This isusually what you want; a newly created SV has a reference count of one, soif all your code does is create SVs then store them in a hash, hv_storewill own the only reference to the new SV, and your code doesn't need to doanything further to tidy up. hv_store is not implemented as a call tohv_store_ent, and does not create a temporary SV for the key, so if yourkey data is not already in SV form then use hv_store in preference tohv_store_ent.

    See Understanding the Magic of Tied Hashes and Arrays in perlguts for moreinformation on how to use this function on tied hashes.

    1. SV**hv_store(HV *hv, const char *key, I32 klen,
      2.  
    2.  SV *val, U32 hash)
      3.
  • hv_stores

    Like hv_store, but takes a literal string instead of a string/length pairand omits the hash parameter.

    1. SV**hv_stores(HV* tb, const char* key,
      2.  
    2.   NULLOK SV* val)
      3.
  • hv_store_ent

    Stores val in a hash. The hash key is specified as key. The hashparameter is the precomputed hash value; if it is zero then Perl willcompute it. The return value is the new hash entry so created. It will beNULL if the operation failed or if the value did not need to be actuallystored within the hash (as in the case of tied hashes). Otherwise thecontents of the return value can be accessed using the He? macrosdescribed here. Note that the caller is responsible for suitablyincrementing the reference count of val before the call, anddecrementing it if the function returned NULL. Effectively a successfulhv_store_ent takes ownership of one reference to val. This isusually what you want; a newly created SV has a reference count of one, soif all your code does is create SVs then store them in a hash, hv_storewill own the only reference to the new SV, and your code doesn't need to doanything further to tidy up. Note that hv_store_ent only reads the key;unlike val it does not take ownership of it, so maintaining the correctreference count on key is entirely the caller's responsibility. hv_storeis not implemented as a call to hv_store_ent, and does not create a temporarySV for the key, so if your key data is not already in SV form then usehv_store in preference to hv_store_ent.

    See Understanding the Magic of Tied Hashes and Arrays in perlguts for moreinformation on how to use this function on tied hashes.

    1. HE*hv_store_ent(HV *hv, SV *key, SV *val, U32 hash)
      2.
  • hv_undef

    Undefines the hash. The XS equivalent of undef(%hash).

    As well as freeing all the elements of the hash (like hv_clear()), thisalso frees any auxiliary data and storage associated with the hash.

    If any destructors are triggered as a result, the hv itself maybe freed.

    See also hv_clear.

    1. voidhv_undef(HV *hv)
      2.
  • newHV

    Creates a new HV. The reference count is set to 1.

    1. HV*newHV()
      2.

Hook manipulation

  • wrap_op_checker

    Puts a C function into the chain of check functions for a specified optype. This is the preferred way to manipulate the PL_check array.opcode specifies which type of op is to be affected. new_checkeris a pointer to the C function that is to be added to that opcode'scheck chain, and old_checker_p points to the storage location where apointer to the next function in the chain will be stored. The value ofnew_pointer is written into the PL_check array, while the valuepreviously stored there is written to *old_checker_p.

    PL_check is global to an entire process, and a module wishing tohook op checking may find itself invoked more than once per process,typically in different threads. To handle that situation, this functionis idempotent. The location *old_checker_p must initially (onceper process) contain a null pointer. A C variable of static duration(declared at file scope, typically also marked static to giveit internal linkage) will be implicitly initialised appropriately,if it does not have an explicit initialiser. This function will onlyactually modify the check chain if it finds *old_checker_p to be null.This function is also thread safe on the small scale. It uses appropriatelocking to avoid race conditions in accessing PL_check.

    When this function is called, the function referenced by new_checkermust be ready to be called, except for *old_checker_p being unfilled.In a threading situation, new_checker may be called immediately,even before this function has returned. *old_checker_p will alwaysbe appropriately set before new_checker is called. If new_checkerdecides not to do anything special with an op that it is given (whichis the usual case for most uses of op check hooking), it must chain thecheck function referenced by *old_checker_p.

    If you want to influence compilation of calls to a specific subroutine,then use cv_set_call_checker rather than hooking checking of allentersub ops.

    1. voidwrap_op_checker(Optype opcode,
      2.  
    2.  Perl_check_t new_checker,
      3.  
    3.  Perl_check_t *old_checker_p)
      4.

Lexer interface

  • lex_bufutf8

    Indicates whether the octets in the lexer buffer(PL_parser->linestr) should be interpreted as the UTF-8 encodingof Unicode characters. If not, they should be interpreted as Latin-1characters. This is analogous to the SvUTF8 flag for scalars.

    In UTF-8 mode, it is not guaranteed that the lexer buffer actuallycontains valid UTF-8. Lexing code must be robust in the face of invalidencoding.

    The actual SvUTF8 flag of the PL_parser->linestr scalaris significant, but not the whole story regarding the input characterencoding. Normally, when a file is being read, the scalar contains octetsand its SvUTF8 flag is off, but the octets should be interpreted asUTF-8 if the use utf8 pragma is in effect. During a string eval,however, the scalar may have the SvUTF8 flag on, and in this case itsoctets should be interpreted as UTF-8 unless the use bytes pragmais in effect. This logic may change in the future; use this functioninstead of implementing the logic yourself.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. boollex_bufutf8()
      2.
  • lex_discard_to

    Discards the first part of the PL_parser->linestr buffer,up to ptr. The remaining content of the buffer will be moved, andall pointers into the buffer updated appropriately. ptr must notbe later in the buffer than the position of PL_parser->bufptr:it is not permitted to discard text that has yet to be lexed.

    Normally it is not necessarily to do this directly, because it suffices touse the implicit discarding behaviour of lex_next_chunk and thingsbased on it. However, if a token stretches across multiple lines,and the lexing code has kept multiple lines of text in the buffer forthat purpose, then after completion of the token it would be wise toexplicitly discard the now-unneeded earlier lines, to avoid futuremulti-line tokens growing the buffer without bound.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. voidlex_discard_to(char *ptr)
      2.
  • lex_grow_linestr

    Reallocates the lexer buffer (PL_parser->linestr) to accommodateat least len octets (including terminating NUL). Returns apointer to the reallocated buffer. This is necessary before makingany direct modification of the buffer that would increase its length.lex_stuff_pvn provides a more convenient way to insert text intothe buffer.

    Do not use SvGROW or sv_grow directly on PL_parser->linestr;this function updates all of the lexer's variables that point directlyinto the buffer.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. char *lex_grow_linestr(STRLEN len)
      2.
  • lex_next_chunk

    Reads in the next chunk of text to be lexed, appending it toPL_parser->linestr. This should be called when lexing code haslooked to the end of the current chunk and wants to know more. It isusual, but not necessary, for lexing to have consumed the entirety ofthe current chunk at this time.

    If PL_parser->bufptr is pointing to the very end of the currentchunk (i.e., the current chunk has been entirely consumed), normally thecurrent chunk will be discarded at the same time that the new chunk isread in. If flags includes LEX_KEEP_PREVIOUS, the current chunkwill not be discarded. If the current chunk has not been entirelyconsumed, then it will not be discarded regardless of the flag.

    Returns true if some new text was added to the buffer, or false if thebuffer has reached the end of the input text.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. boollex_next_chunk(U32 flags)
      2.
  • lex_peek_unichar

    Looks ahead one (Unicode) character in the text currently being lexed.Returns the codepoint (unsigned integer value) of the next character,or -1 if lexing has reached the end of the input text. To consume thepeeked character, use lex_read_unichar.

    If the next character is in (or extends into) the next chunk of inputtext, the next chunk will be read in. Normally the current chunk will bediscarded at the same time, but if flags includes LEX_KEEP_PREVIOUSthen the current chunk will not be discarded.

    If the input is being interpreted as UTF-8 and a UTF-8 encoding erroris encountered, an exception is generated.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. I32lex_peek_unichar(U32 flags)
      2.
  • lex_read_space

    Reads optional spaces, in Perl style, in the text currently beinglexed. The spaces may include ordinary whitespace characters andPerl-style comments. #line directives are processed if encountered.PL_parser->bufptr is moved past the spaces, so that it pointsat a non-space character (or the end of the input text).

    If spaces extend into the next chunk of input text, the next chunk willbe read in. Normally the current chunk will be discarded at the sametime, but if flags includes LEX_KEEP_PREVIOUS then the currentchunk will not be discarded.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. voidlex_read_space(U32 flags)
      2.
  • lex_read_to

    Consume text in the lexer buffer, from PL_parser->bufptr upto ptr. This advances PL_parser->bufptr to match ptr,performing the correct bookkeeping whenever a newline character is passed.This is the normal way to consume lexed text.

    Interpretation of the buffer's octets can be abstracted out byusing the slightly higher-level functions lex_peek_unichar andlex_read_unichar.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. voidlex_read_to(char *ptr)
      2.
  • lex_read_unichar

    Reads the next (Unicode) character in the text currently being lexed.Returns the codepoint (unsigned integer value) of the character read,and moves PL_parser->bufptr past the character, or returns -1if lexing has reached the end of the input text. To non-destructivelyexamine the next character, use lex_peek_unichar instead.

    If the next character is in (or extends into) the next chunk of inputtext, the next chunk will be read in. Normally the current chunk will bediscarded at the same time, but if flags includes LEX_KEEP_PREVIOUSthen the current chunk will not be discarded.

    If the input is being interpreted as UTF-8 and a UTF-8 encoding erroris encountered, an exception is generated.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. I32lex_read_unichar(U32 flags)
      2.
  • lex_start

    Creates and initialises a new lexer/parser state object, supplyinga context in which to lex and parse from a new source of Perl code.A pointer to the new state object is placed in PL_parser. An entryis made on the save stack so that upon unwinding the new state objectwill be destroyed and the former value of PL_parser will be restored.Nothing else need be done to clean up the parsing context.

    The code to be parsed comes from line and rsfp. line, ifnon-null, provides a string (in SV form) containing code to be parsed.A copy of the string is made, so subsequent modification of linedoes not affect parsing. rsfp, if non-null, provides an input streamfrom which code will be read to be parsed. If both are non-null, thecode in line comes first and must consist of complete lines of input,and rsfp supplies the remainder of the source.

    The flags parameter is reserved for future use. Currently it is onlyused by perl internally, so extensions should always pass zero.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. voidlex_start(SV *line, PerlIO *rsfp, U32 flags)
      2.
  • lex_stuff_pv

    Insert characters into the lexer buffer (PL_parser->linestr),immediately after the current lexing point (PL_parser->bufptr),reallocating the buffer if necessary. This means that lexing code thatruns later will see the characters as if they had appeared in the input.It is not recommended to do this as part of normal parsing, and mostuses of this facility run the risk of the inserted characters beinginterpreted in an unintended manner.

    The string to be inserted is represented by octets starting at pvand continuing to the first nul. These octets are interpreted as eitherUTF-8 or Latin-1, according to whether the LEX_STUFF_UTF8 flag is setin flags. The characters are recoded for the lexer buffer, accordingto how the buffer is currently being interpreted (lex_bufutf8).If it is not convenient to nul-terminate a string to be inserted, thelex_stuff_pvn function is more appropriate.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. voidlex_stuff_pv(const char *pv, U32 flags)
      2.
  • lex_stuff_pvn

    Insert characters into the lexer buffer (PL_parser->linestr),immediately after the current lexing point (PL_parser->bufptr),reallocating the buffer if necessary. This means that lexing code thatruns later will see the characters as if they had appeared in the input.It is not recommended to do this as part of normal parsing, and mostuses of this facility run the risk of the inserted characters beinginterpreted in an unintended manner.

    The string to be inserted is represented by len octets startingat pv. These octets are interpreted as either UTF-8 or Latin-1,according to whether the LEX_STUFF_UTF8 flag is set in flags.The characters are recoded for the lexer buffer, according to how thebuffer is currently being interpreted (lex_bufutf8). If a stringto be inserted is available as a Perl scalar, the lex_stuff_svfunction is more convenient.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. voidlex_stuff_pvn(const char *pv, STRLEN len,
      2.  
    2.   U32 flags)
      3.
  • lex_stuff_pvs

    Like lex_stuff_pvn, but takes a literal string instead of astring/length pair.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. voidlex_stuff_pvs(const char *pv, U32 flags)
      2.
  • lex_stuff_sv

    Insert characters into the lexer buffer (PL_parser->linestr),immediately after the current lexing point (PL_parser->bufptr),reallocating the buffer if necessary. This means that lexing code thatruns later will see the characters as if they had appeared in the input.It is not recommended to do this as part of normal parsing, and mostuses of this facility run the risk of the inserted characters beinginterpreted in an unintended manner.

    The string to be inserted is the string value of sv. The charactersare recoded for the lexer buffer, according to how the buffer is currentlybeing interpreted (lex_bufutf8). If a string to be inserted isnot already a Perl scalar, the lex_stuff_pvn function avoids theneed to construct a scalar.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. voidlex_stuff_sv(SV *sv, U32 flags)
      2.
  • lex_unstuff

    Discards text about to be lexed, from PL_parser->bufptr up toptr. Text following ptr will be moved, and the buffer shortened.This hides the discarded text from any lexing code that runs later,as if the text had never appeared.

    This is not the normal way to consume lexed text. For that, uselex_read_to.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. voidlex_unstuff(char *ptr)
      2.
  • parse_arithexpr

    Parse a Perl arithmetic expression. This may contain operators of precedencedown to the bit shift operators. The expression must be followed (and thusterminated) either by a comparison or lower-precedence operator or bysomething that would normally terminate an expression such as semicolon.If flags includes PARSE_OPTIONAL then the expression is optional,otherwise it is mandatory. It is up to the caller to ensure that thedynamic parser state (PL_parser et al) is correctly set to reflectthe source of the code to be parsed and the lexical context for theexpression.

    The op tree representing the expression is returned. If an optionalexpression is absent, a null pointer is returned, otherwise the pointerwill be non-null.

    If an error occurs in parsing or compilation, in most cases a valid optree is returned anyway. The error is reflected in the parser state,normally resulting in a single exception at the top level of parsingwhich covers all the compilation errors that occurred. Some compilationerrors, however, will throw an exception immediately.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. OP *parse_arithexpr(U32 flags)
      2.
  • parse_barestmt

    Parse a single unadorned Perl statement. This may be a normal imperativestatement or a declaration that has compile-time effect. It does notinclude any label or other affixture. It is up to the caller to ensurethat the dynamic parser state (PL_parser et al) is correctly set toreflect the source of the code to be parsed and the lexical context forthe statement.

    The op tree representing the statement is returned. This may be anull pointer if the statement is null, for example if it was actuallya subroutine definition (which has compile-time side effects). If notnull, it will be ops directly implementing the statement, suitable topass to newSTATEOP. It will not normally include a nextstate orequivalent op (except for those embedded in a scope contained entirelywithin the statement).

    If an error occurs in parsing or compilation, in most cases a valid optree (most likely null) is returned anyway. The error is reflected inthe parser state, normally resulting in a single exception at the toplevel of parsing which covers all the compilation errors that occurred.Some compilation errors, however, will throw an exception immediately.

    The flags parameter is reserved for future use, and must alwaysbe zero.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. OP *parse_barestmt(U32 flags)
      2.
  • parse_block

    Parse a single complete Perl code block. This consists of an openingbrace, a sequence of statements, and a closing brace. The blockconstitutes a lexical scope, so my variables and various compile-timeeffects can be contained within it. It is up to the caller to ensurethat the dynamic parser state (PL_parser et al) is correctly set toreflect the source of the code to be parsed and the lexical context forthe statement.

    The op tree representing the code block is returned. This is always areal op, never a null pointer. It will normally be a lineseq list,including nextstate or equivalent ops. No ops to construct any kindof runtime scope are included by virtue of it being a block.

    If an error occurs in parsing or compilation, in most cases a valid optree (most likely null) is returned anyway. The error is reflected inthe parser state, normally resulting in a single exception at the toplevel of parsing which covers all the compilation errors that occurred.Some compilation errors, however, will throw an exception immediately.

    The flags parameter is reserved for future use, and must alwaysbe zero.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. OP *parse_block(U32 flags)
      2.
  • parse_fullexpr

    Parse a single complete Perl expression. This allows the fullexpression grammar, including the lowest-precedence operators suchas or. The expression must be followed (and thus terminated) by atoken that an expression would normally be terminated by: end-of-file,closing bracketing punctuation, semicolon, or one of the keywords thatsignals a postfix expression-statement modifier. If flags includesPARSE_OPTIONAL then the expression is optional, otherwise it ismandatory. It is up to the caller to ensure that the dynamic parserstate (PL_parser et al) is correctly set to reflect the source ofthe code to be parsed and the lexical context for the expression.

    The op tree representing the expression is returned. If an optionalexpression is absent, a null pointer is returned, otherwise the pointerwill be non-null.

    If an error occurs in parsing or compilation, in most cases a valid optree is returned anyway. The error is reflected in the parser state,normally resulting in a single exception at the top level of parsingwhich covers all the compilation errors that occurred. Some compilationerrors, however, will throw an exception immediately.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. OP *parse_fullexpr(U32 flags)
      2.
  • parse_fullstmt

    Parse a single complete Perl statement. This may be a normal imperativestatement or a declaration that has compile-time effect, and may includeoptional labels. It is up to the caller to ensure that the dynamicparser state (PL_parser et al) is correctly set to reflect the sourceof the code to be parsed and the lexical context for the statement.

    The op tree representing the statement is returned. This may be anull pointer if the statement is null, for example if it was actuallya subroutine definition (which has compile-time side effects). If notnull, it will be the result of a newSTATEOP call, normally includinga nextstate or equivalent op.

    If an error occurs in parsing or compilation, in most cases a valid optree (most likely null) is returned anyway. The error is reflected inthe parser state, normally resulting in a single exception at the toplevel of parsing which covers all the compilation errors that occurred.Some compilation errors, however, will throw an exception immediately.

    The flags parameter is reserved for future use, and must alwaysbe zero.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. OP *parse_fullstmt(U32 flags)
      2.
  • parse_label

    Parse a single label, possibly optional, of the type that may prefix aPerl statement. It is up to the caller to ensure that the dynamic parserstate (PL_parser et al) is correctly set to reflect the source ofthe code to be parsed. If flags includes PARSE_OPTIONAL then thelabel is optional, otherwise it is mandatory.

    The name of the label is returned in the form of a fresh scalar. If anoptional label is absent, a null pointer is returned.

    If an error occurs in parsing, which can only occur if the label ismandatory, a valid label is returned anyway. The error is reflected inthe parser state, normally resulting in a single exception at the toplevel of parsing which covers all the compilation errors that occurred.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. SV *parse_label(U32 flags)
      2.
  • parse_listexpr

    Parse a Perl list expression. This may contain operators of precedencedown to the comma operator. The expression must be followed (and thusterminated) either by a low-precedence logic operator such as or or bysomething that would normally terminate an expression such as semicolon.If flags includes PARSE_OPTIONAL then the expression is optional,otherwise it is mandatory. It is up to the caller to ensure that thedynamic parser state (PL_parser et al) is correctly set to reflectthe source of the code to be parsed and the lexical context for theexpression.

    The op tree representing the expression is returned. If an optionalexpression is absent, a null pointer is returned, otherwise the pointerwill be non-null.

    If an error occurs in parsing or compilation, in most cases a valid optree is returned anyway. The error is reflected in the parser state,normally resulting in a single exception at the top level of parsingwhich covers all the compilation errors that occurred. Some compilationerrors, however, will throw an exception immediately.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. OP *parse_listexpr(U32 flags)
      2.
  • parse_stmtseq

    Parse a sequence of zero or more Perl statements. These may be normalimperative statements, including optional labels, or declarationsthat have compile-time effect, or any mixture thereof. The statementsequence ends when a closing brace or end-of-file is encountered in aplace where a new statement could have validly started. It is up tothe caller to ensure that the dynamic parser state (PL_parser et al)is correctly set to reflect the source of the code to be parsed and thelexical context for the statements.

    The op tree representing the statement sequence is returned. This maybe a null pointer if the statements were all null, for example if therewere no statements or if there were only subroutine definitions (whichhave compile-time side effects). If not null, it will be a lineseqlist, normally including nextstate or equivalent ops.

    If an error occurs in parsing or compilation, in most cases a valid optree is returned anyway. The error is reflected in the parser state,normally resulting in a single exception at the top level of parsingwhich covers all the compilation errors that occurred. Some compilationerrors, however, will throw an exception immediately.

    The flags parameter is reserved for future use, and must alwaysbe zero.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. OP *parse_stmtseq(U32 flags)
      2.
  • parse_termexpr

    Parse a Perl term expression. This may contain operators of precedencedown to the assignment operators. The expression must be followed (and thusterminated) either by a comma or lower-precedence operator or bysomething that would normally terminate an expression such as semicolon.If flags includes PARSE_OPTIONAL then the expression is optional,otherwise it is mandatory. It is up to the caller to ensure that thedynamic parser state (PL_parser et al) is correctly set to reflectthe source of the code to be parsed and the lexical context for theexpression.

    The op tree representing the expression is returned. If an optionalexpression is absent, a null pointer is returned, otherwise the pointerwill be non-null.

    If an error occurs in parsing or compilation, in most cases a valid optree is returned anyway. The error is reflected in the parser state,normally resulting in a single exception at the top level of parsingwhich covers all the compilation errors that occurred. Some compilationerrors, however, will throw an exception immediately.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. OP *parse_termexpr(U32 flags)
      2.
  • PL_parser

    Pointer to a structure encapsulating the state of the parsing operationcurrently in progress. The pointer can be locally changed to performa nested parse without interfering with the state of an outer parse.Individual members of PL_parser have their own documentation.

  • PL_parser->bufend

    Direct pointer to the end of the chunk of text currently being lexed, theend of the lexer buffer. This is equal to SvPVX(PL_parser->linestr)+ SvCUR(PL_parser->linestr). A NUL character (zero octet) isalways located at the end of the buffer, and does not count as part ofthe buffer's contents.

    NOTE: this function is experimental and may change or beremoved without notice.

  • PL_parser->bufptr

    Points to the current position of lexing inside the lexer buffer.Characters around this point may be freely examined, withinthe range delimited by SvPVX(PL_parser->linestr) andPL_parser->bufend. The octets of the buffer may be intended to beinterpreted as either UTF-8 or Latin-1, as indicated by lex_bufutf8.

    Lexing code (whether in the Perl core or not) moves this pointer pastthe characters that it consumes. It is also expected to perform somebookkeeping whenever a newline character is consumed. This movementcan be more conveniently performed by the function lex_read_to,which handles newlines appropriately.

    Interpretation of the buffer's octets can be abstracted out byusing the slightly higher-level functions lex_peek_unichar andlex_read_unichar.

    NOTE: this function is experimental and may change or beremoved without notice.

  • PL_parser->linestart

    Points to the start of the current line inside the lexer buffer.This is useful for indicating at which column an error occurred, andnot much else. This must be updated by any lexing code that consumesa newline; the function lex_read_to handles this detail.

    NOTE: this function is experimental and may change or beremoved without notice.

  • PL_parser->linestr

    Buffer scalar containing the chunk currently under consideration of thetext currently being lexed. This is always a plain string scalar (forwhich SvPOK is true). It is not intended to be used as a scalar bynormal scalar means; instead refer to the buffer directly by the pointervariables described below.

    The lexer maintains various char* pointers to things in thePL_parser->linestr buffer. If PL_parser->linestr is everreallocated, all of these pointers must be updated. Don't attempt todo this manually, but rather use lex_grow_linestr if you need toreallocate the buffer.

    The content of the text chunk in the buffer is commonly exactly onecomplete line of input, up to and including a newline terminator,but there are situations where it is otherwise. The octets of thebuffer may be intended to be interpreted as either UTF-8 or Latin-1.The function lex_bufutf8 tells you which. Do not use the SvUTF8flag on this scalar, which may disagree with it.

    For direct examination of the buffer, the variablePL_parser->bufend points to the end of the buffer. The currentlexing position is pointed to by PL_parser->bufptr. Direct useof these pointers is usually preferable to examination of the scalarthrough normal scalar means.

    NOTE: this function is experimental and may change or beremoved without notice.

Magical Functions

  • mg_clear

    Clear something magical that the SV represents. See sv_magic.

    1. intmg_clear(SV* sv)
      2.
  • mg_copy

    Copies the magic from one SV to another. See sv_magic.

    1. intmg_copy(SV *sv, SV *nsv, const char *key,
      2.  
    2.  I32 klen)
      3.
  • mg_find

    Finds the magic pointer for type matching the SV. See sv_magic.

    1. MAGIC*mg_find(const SV* sv, int type)
      2.
  • mg_findext

    Finds the magic pointer of type with the given vtbl for the SV. Seesv_magicext.

    1. MAGIC*mg_findext(const SV* sv, int type,
      2.  
    2.    const MGVTBL *vtbl)
      3.
  • mg_free

    Free any magic storage used by the SV. See sv_magic.

    1. intmg_free(SV* sv)
      2.
  • mg_free_type

    Remove any magic of type how from the SV sv. See sv_magic.

    1. voidmg_free_type(SV *sv, int how)
      2.
  • mg_get

    Do magic after a value is retrieved from the SV. See sv_magic.

    1. intmg_get(SV* sv)
      2.
  • mg_length

    Report on the SV's length. See sv_magic.

    1. U32mg_length(SV* sv)
      2.
  • mg_magical

    Turns on the magical status of an SV. See sv_magic.

    1. voidmg_magical(SV* sv)
      2.
  • mg_set

    Do magic after a value is assigned to the SV. See sv_magic.

    1. intmg_set(SV* sv)
      2.
  • SvGETMAGIC

    Invokes mg_get on an SV if it has 'get' magic. This macro evaluates itsargument more than once.

    1. voidSvGETMAGIC(SV* sv)
      2.
  • SvLOCK

    Arranges for a mutual exclusion lock to be obtained on sv if a suitable modulehas been loaded.

    1. voidSvLOCK(SV* sv)
      2.
  • SvSETMAGIC

    Invokes mg_set on an SV if it has 'set' magic. This macro evaluates itsargument more than once.

    1. voidSvSETMAGIC(SV* sv)
      2.
  • SvSetMagicSV

    Like SvSetSV, but does any set magic required afterwards.

    1. voidSvSetMagicSV(SV* dsb, SV* ssv)
      2.
  • SvSetMagicSV_nosteal

    Like SvSetSV_nosteal, but does any set magic required afterwards.

    1. voidSvSetMagicSV_nosteal(SV* dsv, SV* ssv)
      2.
  • SvSetSV

    Calls sv_setsv if dsv is not the same as ssv. May evaluate argumentsmore than once.

    1. voidSvSetSV(SV* dsb, SV* ssv)
      2.
  • SvSetSV_nosteal

    Calls a non-destructive version of sv_setsv if dsv is not the same asssv. May evaluate arguments more than once.

    1. voidSvSetSV_nosteal(SV* dsv, SV* ssv)
      2.
  • SvSHARE

    Arranges for sv to be shared between threads if a suitable modulehas been loaded.

    1. voidSvSHARE(SV* sv)
      2.
  • SvUNLOCK

    Releases a mutual exclusion lock on sv if a suitable modulehas been loaded.

    1. voidSvUNLOCK(SV* sv)
      2.

Memory Management

  • Copy

    The XSUB-writer's interface to the C memcpy function. The src is thesource, dest is the destination, nitems is the number of items, and type isthe type. May fail on overlapping copies. See also Move.

    1. voidCopy(void* src, void* dest, int nitems, type)
      2.
  • CopyD

    Like Copy but returns dest. Useful for encouraging compilers to tail-calloptimise.

    1. void *CopyD(void* src, void* dest, int nitems, type)
      2.
  • Move

    The XSUB-writer's interface to the C memmove function. The src is thesource, dest is the destination, nitems is the number of items, and type isthe type. Can do overlapping moves. See also Copy.

    1. voidMove(void* src, void* dest, int nitems, type)
      2.
  • MoveD

    Like Move but returns dest. Useful for encouraging compilers to tail-calloptimise.

    1. void *MoveD(void* src, void* dest, int nitems, type)
      2.
  • Newx

    The XSUB-writer's interface to the C malloc function.

    In 5.9.3, Newx() and friends replace the older New() API, and dropsthe first parameter, x, a debug aid which allowed callers to identifythemselves. This aid has been superseded by a new build option,PERL_MEM_LOG (see PERL_MEM_LOG in perlhacktips). The older API is stillthere for use in XS modules supporting older perls.

    1. voidNewx(void* ptr, int nitems, type)
      2.
  • Newxc

    The XSUB-writer's interface to the C malloc function, withcast. See also Newx.

    1. voidNewxc(void* ptr, int nitems, type, cast)
      2.
  • Newxz

    The XSUB-writer's interface to the C malloc function. The allocatedmemory is zeroed with memzero. See also Newx.

    1. voidNewxz(void* ptr, int nitems, type)
      2.
  • Poison

    PoisonWith(0xEF) for catching access to freed memory.

    1. voidPoison(void* dest, int nitems, type)
      2.
  • PoisonFree

    PoisonWith(0xEF) for catching access to freed memory.

    1. voidPoisonFree(void* dest, int nitems, type)
      2.
  • PoisonNew

    PoisonWith(0xAB) for catching access to allocated but uninitialized memory.

    1. voidPoisonNew(void* dest, int nitems, type)
      2.
  • PoisonWith

    Fill up memory with a byte pattern (a byte repeated over and overagain) that hopefully catches attempts to access uninitialized memory.

    1. voidPoisonWith(void* dest, int nitems, type,
      2.  
    2.    U8 byte)
      3.
  • Renew

    The XSUB-writer's interface to the C realloc function.

    1. voidRenew(void* ptr, int nitems, type)
      2.
  • Renewc

    The XSUB-writer's interface to the C realloc function, withcast.

    1. voidRenewc(void* ptr, int nitems, type, cast)
      2.
  • Safefree

    The XSUB-writer's interface to the C free function.

    1. voidSafefree(void* ptr)
      2.
  • savepv

    Perl's version of strdup(). Returns a pointer to a newly allocatedstring which is a duplicate of pv. The size of the string isdetermined by strlen(). The memory allocated for the new string canbe freed with the Safefree() function.

    1. char*savepv(const char* pv)
      2.
  • savepvn

    Perl's version of what strndup() would be if it existed. Returns apointer to a newly allocated string which is a duplicate of the firstlen bytes from pv, plus a trailing NUL byte. The memory allocated forthe new string can be freed with the Safefree() function.

    1. char*savepvn(const char* pv, I32 len)
      2.
  • savepvs

    Like savepvn, but takes a literal string instead of a string/length pair.

    1. char*savepvs(const char* s)
      2.
  • savesharedpv

    A version of savepv() which allocates the duplicate string in memorywhich is shared between threads.

    1. char*savesharedpv(const char* pv)
      2.
  • savesharedpvn

    A version of savepvn() which allocates the duplicate string in memorywhich is shared between threads. (With the specific difference that a NULLpointer is not acceptable)

    1. char*savesharedpvn(const char *const pv,
      2.  
    2.   const STRLEN len)
      3.
  • savesharedpvs

    A version of savepvs() which allocates the duplicate string in memorywhich is shared between threads.

    1. char*savesharedpvs(const char* s)
      2.
  • savesharedsvpv

    A version of savesharedpv() which allocates the duplicate string inmemory which is shared between threads.

    1. char*savesharedsvpv(SV *sv)
      2.
  • savesvpv

    A version of savepv()/savepvn() which gets the string to duplicate fromthe passed in SV using SvPV()

    1. char*savesvpv(SV* sv)
      2.
  • StructCopy

    This is an architecture-independent macro to copy one structure to another.

    1. voidStructCopy(type src, type dest, type)
      2.
  • Zero

    The XSUB-writer's interface to the C memzero function. The dest is thedestination, nitems is the number of items, and type is the type.

    1. voidZero(void* dest, int nitems, type)
      2.
  • ZeroD

    Like Zero but returns dest. Useful for encouraging compilers to tail-calloptimise.

    1. void *ZeroD(void* dest, int nitems, type)
      2.

Miscellaneous Functions

  • fbm_compile

    Analyses the string in order to make fast searches on it using fbm_instr()-- the Boyer-Moore algorithm.

    1. voidfbm_compile(SV* sv, U32 flags)
      2.
  • fbm_instr

    Returns the location of the SV in the string delimited by str andstrend. It returns NULL if the string can't be found. The svdoes not have to be fbm_compiled, but the search will not be as fastthen.

    1. char*fbm_instr(unsigned char* big,
      2.  
    2.   unsigned char* bigend, SV* littlestr,
      3.  
    3.   U32 flags)
      4.
  • foldEQ

    Returns true if the leading len bytes of the strings s1 and s2 are the samecase-insensitively; false otherwise. Uppercase and lowercase ASCII range bytesmatch themselves and their opposite case counterparts. Non-cased and non-ASCIIrange bytes match only themselves.

    1. I32foldEQ(const char* a, const char* b, I32 len)
      2.
  • foldEQ_locale

    Returns true if the leading len bytes of the strings s1 and s2 are the samecase-insensitively in the current locale; false otherwise.

    1. I32foldEQ_locale(const char* a, const char* b,
      2.  
    2.   I32 len)
      3.
  • form

    Takes a sprintf-style format pattern and conventional(non-SV) arguments and returns the formatted string.

    1.  (char *) Perl_form(pTHX_ const char* pat, ...)
      2.

    can be used any place a string (char *) is required:

    1.  char * s = Perl_form("%d.%d",major,minor);
      2.

    Uses a single private buffer so if you want to format several strings youmust explicitly copy the earlier strings away (and free the copies when youare done).

    1. char*form(const char* pat, ...)
      2.
  • getcwd_sv

    Fill the sv with current working directory

    1. intgetcwd_sv(SV* sv)
      2.
  • mess

    Take a sprintf-style format pattern and argument list. These are used togenerate a string message. If the message does not end with a newline,then it will be extended with some indication of the current locationin the code, as described for mess_sv.

    Normally, the resulting message is returned in a new mortal SV.During global destruction a single SV may be shared between uses ofthis function.

    1. SV *mess(const char *pat, ...)
      2.
  • mess_sv

    Expands a message, intended for the user, to include an indication ofthe current location in the code, if the message does not already appearto be complete.

    basemsg is the initial message or object. If it is a reference, itwill be used as-is and will be the result of this function. Otherwise itis used as a string, and if it already ends with a newline, it is takento be complete, and the result of this function will be the same string.If the message does not end with a newline, then a segment such as atfoo.pl line 37 will be appended, and possibly other clauses indicatingthe current state of execution. The resulting message will end with adot and a newline.

    Normally, the resulting message is returned in a new mortal SV.During global destruction a single SV may be shared between uses of thisfunction. If consume is true, then the function is permitted (but notrequired) to modify and return basemsg instead of allocating a new SV.

    1. SV *mess_sv(SV *basemsg, bool consume)
      2.
  • my_snprintf

    The C library snprintf functionality, if available andstandards-compliant (uses vsnprintf, actually). However, if thevsnprintf is not available, will unfortunately use the unsafevsprintf which can overrun the buffer (there is an overrun check,but that may be too late). Consider using sv_vcatpvf instead, orgetting vsnprintf.

    1. intmy_snprintf(char *buffer, const Size_t len,
      2.  
    2.  const char *format, ...)
      3.
  • my_sprintf

    The C library sprintf, wrapped if necessary, to ensure that it will returnthe length of the string written to the buffer. Only rare pre-ANSI systemsneed the wrapper function - usually this is a direct call to sprintf.

    1. intmy_sprintf(char *buffer, const char *pat, ...)
      2.
  • my_vsnprintf

    The C library vsnprintf if available and standards-compliant.However, if if the vsnprintf is not available, will unfortunatelyuse the unsafe vsprintf which can overrun the buffer (there is anoverrun check, but that may be too late). Consider usingsv_vcatpvf instead, or getting vsnprintf.

    1. intmy_vsnprintf(char *buffer, const Size_t len,
      2.  
    2.  const char *format, va_list ap)
      3.
  • new_version

    Returns a new version object based on the passed in SV:

    1.  SV *sv = new_version(SV *ver);
      2.

    Does not alter the passed in ver SV. See "upg_version" if youwant to upgrade the SV.

    1. SV*new_version(SV *ver)
      2.
  • prescan_version

    Validate that a given string can be parsed as a version object, but doesn'tactually perform the parsing. Can use either strict or lax validation rules.Can optionally set a number of hint variables to save the parsing codesome time when tokenizing.

    1. const char* prescan_version(const char *s, bool strict,
      2.  
    2.   const char** errstr,
      3.  
    3.  bool *sqv,
      4.  
    4.  int *ssaw_decimal,
      5.  
    5.  int *swidth, bool *salpha)
      6.
  • scan_version

    Returns a pointer to the next character after the parsedversion string, as well as upgrading the passed in SV toan RV.

    Function must be called with an already existing SV like

    1.  sv = newSV(0);
      2.  
    2.  s = scan_version(s, SV *sv, bool qv);
      3.

    Performs some preprocessing to the string to ensure thatit has the correct characteristics of a version. Flags theobject if it contains an underscore (which denotes thisis an alpha version). The boolean qv denotes that the versionshould be interpreted as if it had multiple decimals, even ifit doesn't.

    1. const char* scan_version(const char *s, SV *rv, bool qv)
      2.
  • strEQ

    Test two strings to see if they are equal. Returns true or false.

    1. boolstrEQ(char* s1, char* s2)
      2.
  • strGE

    Test two strings to see if the first, s1, is greater than or equal tothe second, s2. Returns true or false.

    1. boolstrGE(char* s1, char* s2)
      2.
  • strGT

    Test two strings to see if the first, s1, is greater than the second,s2. Returns true or false.

    1. boolstrGT(char* s1, char* s2)
      2.
  • strLE

    Test two strings to see if the first, s1, is less than or equal to thesecond, s2. Returns true or false.

    1. boolstrLE(char* s1, char* s2)
      2.
  • strLT

    Test two strings to see if the first, s1, is less than the second,s2. Returns true or false.

    1. boolstrLT(char* s1, char* s2)
      2.
  • strNE

    Test two strings to see if they are different. Returns true orfalse.

    1. boolstrNE(char* s1, char* s2)
      2.
  • strnEQ

    Test two strings to see if they are equal. The len parameter indicatesthe number of bytes to compare. Returns true or false. (A wrapper forstrncmp).

    1. boolstrnEQ(char* s1, char* s2, STRLEN len)
      2.
  • strnNE

    Test two strings to see if they are different. The len parameterindicates the number of bytes to compare. Returns true or false. (Awrapper for strncmp).

    1. boolstrnNE(char* s1, char* s2, STRLEN len)
      2.
  • sv_destroyable

    Dummy routine which reports that object can be destroyed when there is nosharing module present. It ignores its single SV argument, and returns'true'. Exists to avoid test for a NULL function pointer and because itcould potentially warn under some level of strict-ness.

    1. boolsv_destroyable(SV *sv)
      2.
  • sv_nosharing

    Dummy routine which "shares" an SV when there is no sharing module present.Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.Exists to avoid test for a NULL function pointer and because it couldpotentially warn under some level of strict-ness.

    1. voidsv_nosharing(SV *sv)
      2.
  • upg_version

    In-place upgrade of the supplied SV to a version object.

    1.  SV *sv = upg_version(SV *sv, bool qv);
      2.

    Returns a pointer to the upgraded SV. Set the boolean qv if you wantto force this SV to be interpreted as an "extended" version.

    1. SV*upg_version(SV *ver, bool qv)
      2.
  • vcmp

    Version object aware cmp. Both operands must already have been converted into version objects.

    1. intvcmp(SV *lhv, SV *rhv)
      2.
  • vmess

    pat and args are a sprintf-style format pattern and encapsulatedargument list. These are used to generate a string message. If themessage does not end with a newline, then it will be extended withsome indication of the current location in the code, as described formess_sv.

    Normally, the resulting message is returned in a new mortal SV.During global destruction a single SV may be shared between uses ofthis function.

    1. SV *vmess(const char *pat, va_list *args)
      2.
  • vnormal

    Accepts a version object and returns the normalized stringrepresentation. Call like:

    1.  sv = vnormal(rv);
      2.

    NOTE: you can pass either the object directly or the SVcontained within the RV.

    The SV returned has a refcount of 1.

    1. SV*vnormal(SV *vs)
      2.
  • vnumify

    Accepts a version object and returns the normalized floatingpoint representation. Call like:

    1.  sv = vnumify(rv);
      2.

    NOTE: you can pass either the object directly or the SVcontained within the RV.

    The SV returned has a refcount of 1.

    1. SV*vnumify(SV *vs)
      2.
  • vstringify

    In order to maintain maximum compatibility with earlier versionsof Perl, this function will return either the floating pointnotation or the multiple dotted notation, depending on whetherthe original version contained 1 or more dots, respectively.

    The SV returned has a refcount of 1.

    1. SV*vstringify(SV *vs)
      2.
  • vverify

    Validates that the SV contains valid internal structure for a version object.It may be passed either the version object (RV) or the hash itself (HV). Ifthe structure is valid, it returns the HV. If the structure is invalid,it returns NULL.

    1.  SV *hv = vverify(sv);
      2.

    Note that it only confirms the bare minimum structure (so as not to getconfused by derived classes which may contain additional hash entries):

    1. SV*vverify(SV *vs)
      2.

MRO Functions

  • mro_get_linear_isa

    Returns the mro linearisation for the given stash. By default, thiswill be whatever mro_get_linear_isa_dfs returns unless someother MRO is in effect for the stash. The return value is aread-only AV*.

    You are responsible for SvREFCNT_inc() on thereturn value if you plan to store it anywheresemi-permanently (otherwise it might be deletedout from under you the next time the cache isinvalidated).

    1. AV*mro_get_linear_isa(HV* stash)
      2.
  • mro_method_changed_in

    Invalidates method caching on any child classesof the given stash, so that they might noticethe changes in this one.

    Ideally, all instances of PL_sub_generation++ inperl source outside of mro.c should bereplaced by calls to this.

    Perl automatically handles most of the commonways a method might be redefined. However, thereare a few ways you could change a method in a stashwithout the cache code noticing, in which case youneed to call this method afterwards:

    1) Directly manipulating the stash HV entries fromXS code.

    2) Assigning a reference to a readonly scalarconstant into a stash entry in order to createa constant subroutine (like constant.pmdoes).

    This same method is available from pure perlvia, mro::method_changed_in(classname).

    1. voidmro_method_changed_in(HV* stash)
      2.
  • mro_register

    Registers a custom mro plugin. See perlmroapi for details.

    1. voidmro_register(const struct mro_alg *mro)
      2.

Multicall Functions

Numeric functions

  • grok_bin

    converts a string representing a binary number to numeric form.

    On entry start and *len give the string to scan, *flags givesconversion flags, and result should be NULL or a pointer to an NV.The scan stops at the end of the string, or the first invalid character.Unless PERL_SCAN_SILENT_ILLDIGIT is set in *flags, encountering aninvalid character will also trigger a warning.On return *len is set to the length of the scanned string,and *flags gives output flags.

    If the value is <= UV_MAX it is returned as a UV, the output flags are clear,and nothing is written to *result. If the value is > UV_MAX grok_binreturns UV_MAX, sets PERL_SCAN_GREATER_THAN_UV_MAX in the output flags,and writes the value to *result (or the value is discarded if resultis NULL).

    The binary number may optionally be prefixed with "0b" or "b" unlessPERL_SCAN_DISALLOW_PREFIX is set in *flags on entry. IfPERL_SCAN_ALLOW_UNDERSCORES is set in *flags then the binarynumber may use '_' characters to separate digits.

    1. UVgrok_bin(const char* start, STRLEN* len_p,
      2.  
    2.  I32* flags, NV *result)
      3.
  • grok_hex

    converts a string representing a hex number to numeric form.

    On entry start and *len give the string to scan, *flags givesconversion flags, and result should be NULL or a pointer to an NV.The scan stops at the end of the string, or the first invalid character.Unless PERL_SCAN_SILENT_ILLDIGIT is set in *flags, encountering aninvalid character will also trigger a warning.On return *len is set to the length of the scanned string,and *flags gives output flags.

    If the value is <= UV_MAX it is returned as a UV, the output flags are clear,and nothing is written to *result. If the value is > UV_MAX grok_hexreturns UV_MAX, sets PERL_SCAN_GREATER_THAN_UV_MAX in the output flags,and writes the value to *result (or the value is discarded if resultis NULL).

    The hex number may optionally be prefixed with "0x" or "x" unlessPERL_SCAN_DISALLOW_PREFIX is set in *flags on entry. IfPERL_SCAN_ALLOW_UNDERSCORES is set in *flags then the hexnumber may use '_' characters to separate digits.

    1. UVgrok_hex(const char* start, STRLEN* len_p,
      2.  
    2.  I32* flags, NV *result)
      3.
  • grok_number

    Recognise (or not) a number. The type of the number is returned(0 if unrecognised), otherwise it is a bit-ORed combination ofIS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).

    If the value of the number can fit an in UV, it is returned in the *valuepIS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UVwill never be set unless *valuep is valid, but *valuep may have been assignedto during processing even though IS_NUMBER_IN_UV is not set on return.If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as whenvaluep is non-NULL, but no actual assignment (or SEGV) will occur.

    IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals wereseen (in which case *valuep gives the true value truncated to an integer), andIS_NUMBER_NEG if the number is negative (in which case *valuep holds theabsolute value). IS_NUMBER_IN_UV is not set if e notation was used or thenumber is larger than a UV.

    1. intgrok_number(const char *pv, STRLEN len,
      2.  
    2.  UV *valuep)
      3.
  • grok_numeric_radix

    Scan and skip for a numeric decimal separator (radix).

    1. boolgrok_numeric_radix(const char **sp,
      2.  
    2.    const char *send)
      3.
  • grok_oct

    converts a string representing an octal number to numeric form.

    On entry start and *len give the string to scan, *flags givesconversion flags, and result should be NULL or a pointer to an NV.The scan stops at the end of the string, or the first invalid character.Unless PERL_SCAN_SILENT_ILLDIGIT is set in *flags, encountering an8 or 9 will also trigger a warning.On return *len is set to the length of the scanned string,and *flags gives output flags.

    If the value is <= UV_MAX it is returned as a UV, the output flags are clear,and nothing is written to *result. If the value is > UV_MAX grok_octreturns UV_MAX, sets PERL_SCAN_GREATER_THAN_UV_MAX in the output flags,and writes the value to *result (or the value is discarded if resultis NULL).

    If PERL_SCAN_ALLOW_UNDERSCORES is set in *flags then the octalnumber may use '_' characters to separate digits.

    1. UVgrok_oct(const char* start, STRLEN* len_p,
      2.  
    2.  I32* flags, NV *result)
      3.
  • Perl_signbit

    Return a non-zero integer if the sign bit on an NV is set, and 0 ifit is not.

    If Configure detects this system has a signbit() that will work withour NVs, then we just use it via the #define in perl.h. Otherwise,fall back on this implementation. As a first pass, this gets everythingright except -0.0. Alas, catching -0.0 is the main use for this function,so this is not too helpful yet. Still, at least we have the scaffoldingin place to support other systems, should that prove useful.

    Configure notes: This function is called 'Perl_signbit' instead of aplain 'signbit' because it is easy to imagine a system having a signbit()function or macro that doesn't happen to work with our particular choiceof NVs. We shouldn't just re-#define signbit as Perl_signbit and expectthe standard system headers to be happy. Also, this is a no-contextfunction (no pTHX_) because Perl_signbit() is usually re-#defined inperl.h as a simple macro call to the system's signbit().Users should just always call Perl_signbit().

    NOTE: this function is experimental and may change or beremoved without notice.

    1. intPerl_signbit(NV f)
      2.
  • scan_bin

    For backwards compatibility. Use grok_bin instead.

    1. NVscan_bin(const char* start, STRLEN len,
      2.  
    2.  STRLEN* retlen)
      3.
  • scan_hex

    For backwards compatibility. Use grok_hex instead.

    1. NVscan_hex(const char* start, STRLEN len,
      2.  
    2.  STRLEN* retlen)
      3.
  • scan_oct

    For backwards compatibility. Use grok_oct instead.

    1. NVscan_oct(const char* start, STRLEN len,
      2.  
    2.  STRLEN* retlen)
      3.

Optree construction

  • newASSIGNOP

    Constructs, checks, and returns an assignment op. left and rightsupply the parameters of the assignment; they are consumed by thisfunction and become part of the constructed op tree.

    If optype is OP_ANDASSIGN, OP_ORASSIGN, or OP_DORASSIGN, thena suitable conditional optree is constructed. If optype is the opcodeof a binary operator, such as OP_BIT_OR, then an op is constructed thatperforms the binary operation and assigns the result to the left argument.Either way, if optype is non-zero then flags has no effect.

    If optype is zero, then a plain scalar or list assignment isconstructed. Which type of assignment it is is automatically determined.flags gives the eight bits of op_flags, except that OPf_KIDSwill be set automatically, and, shifted up eight bits, the eight bitsof op_private, except that the bit with value 1 or 2 is automaticallyset as required.

    1. OP *newASSIGNOP(I32 flags, OP *left, I32 optype,
      2.  
    2.  OP *right)
      3.
  • newBINOP

    Constructs, checks, and returns an op of any binary type. typeis the opcode. flags gives the eight bits of op_flags, exceptthat OPf_KIDS will be set automatically, and, shifted up eight bits,the eight bits of op_private, except that the bit with value 1 or2 is automatically set as required. first and last supply up totwo ops to be the direct children of the binary op; they are consumedby this function and become part of the constructed op tree.

    1. OP *newBINOP(I32 type, I32 flags, OP *first,
      2.  
    2.  OP *last)
      3.
  • newCONDOP

    Constructs, checks, and returns a conditional-expression (cond_expr)op. flags gives the eight bits of op_flags, except that OPf_KIDSwill be set automatically, and, shifted up eight bits, the eight bits ofop_private, except that the bit with value 1 is automatically set.first supplies the expression selecting between the two branches,and trueop and falseop supply the branches; they are consumed bythis function and become part of the constructed op tree.

    1. OP *newCONDOP(I32 flags, OP *first, OP *trueop,
      2.  
    2.   OP *falseop)
      3.
  • newFOROP

    Constructs, checks, and returns an op tree expressing a foreachloop (iteration through a list of values). This is a heavyweight loop,with structure that allows exiting the loop by last and suchlike.

    sv optionally supplies the variable that will be aliased to eachitem in turn; if null, it defaults to $_ (either lexical or global).expr supplies the list of values to iterate over. block suppliesthe main body of the loop, and cont optionally supplies a continueblock that operates as a second half of the body. All of these optreeinputs are consumed by this function and become part of the constructedop tree.

    flags gives the eight bits of op_flags for the leaveloopop and, shifted up eight bits, the eight bits of op_private forthe leaveloop op, except that (in both cases) some bits will be setautomatically.

    1. OP *newFOROP(I32 flags, OP *sv, OP *expr, OP *block,
      2.  
    2.  OP *cont)
      3.
  • newGIVENOP

    Constructs, checks, and returns an op tree expressing a given block.cond supplies the expression that will be locally assigned to a lexicalvariable, and block supplies the body of the given construct; theyare consumed by this function and become part of the constructed op tree.defsv_off is the pad offset of the scalar lexical variable that willbe affected.

    1. OP *newGIVENOP(OP *cond, OP *block,
      2.  
    2.    PADOFFSET defsv_off)
      3.
  • newGVOP

    Constructs, checks, and returns an op of any type that involves anembedded reference to a GV. type is the opcode. flags gives theeight bits of op_flags. gv identifies the GV that the op shouldreference; calling this function does not transfer ownership of anyreference to it.

    1. OP *newGVOP(I32 type, I32 flags, GV *gv)
      2.
  • newLISTOP

    Constructs, checks, and returns an op of any list type. type isthe opcode. flags gives the eight bits of op_flags, except thatOPf_KIDS will be set automatically if required. first and lastsupply up to two ops to be direct children of the list op; they areconsumed by this function and become part of the constructed op tree.

    1. OP *newLISTOP(I32 type, I32 flags, OP *first,
      2.  
    2.   OP *last)
      3.
  • newLOGOP

    Constructs, checks, and returns a logical (flow control) op. typeis the opcode. flags gives the eight bits of op_flags, exceptthat OPf_KIDS will be set automatically, and, shifted up eight bits,the eight bits of op_private, except that the bit with value 1 isautomatically set. first supplies the expression controlling theflow, and other supplies the side (alternate) chain of ops; they areconsumed by this function and become part of the constructed op tree.

    1. OP *newLOGOP(I32 type, I32 flags, OP *first,
      2.  
    2.  OP *other)
      3.
  • newLOOPEX

    Constructs, checks, and returns a loop-exiting op (such as gotoor last). type is the opcode. label supplies the parameterdetermining the target of the op; it is consumed by this function andbecome part of the constructed op tree.

    1. OP *newLOOPEX(I32 type, OP *label)
      2.
  • newLOOPOP

    Constructs, checks, and returns an op tree expressing a loop. This isonly a loop in the control flow through the op tree; it does not havethe heavyweight loop structure that allows exiting the loop by lastand suchlike. flags gives the eight bits of op_flags for thetop-level op, except that some bits will be set automatically as required.expr supplies the expression controlling loop iteration, and blocksupplies the body of the loop; they are consumed by this function andbecome part of the constructed op tree. debuggable is currentlyunused and should always be 1.

    1. OP *newLOOPOP(I32 flags, I32 debuggable, OP *expr,
      2.  
    2.   OP *block)
      3.
  • newNULLLIST

    Constructs, checks, and returns a new stub op, which represents anempty list expression.

    1. OP *newNULLLIST()
      2.
  • newOP

    Constructs, checks, and returns an op of any base type (any type thathas no extra fields). type is the opcode. flags gives theeight bits of op_flags, and, shifted up eight bits, the eight bitsof op_private.

    1. OP *newOP(I32 type, I32 flags)
      2.
  • newPADOP

    Constructs, checks, and returns an op of any type that involves areference to a pad element. type is the opcode. flags gives theeight bits of op_flags. A pad slot is automatically allocated, andis populated with sv; this function takes ownership of one referenceto it.

    This function only exists if Perl has been compiled to use ithreads.

    1. OP *newPADOP(I32 type, I32 flags, SV *sv)
      2.
  • newPMOP

    Constructs, checks, and returns an op of any pattern matching type.type is the opcode. flags gives the eight bits of op_flagsand, shifted up eight bits, the eight bits of op_private.

    1. OP *newPMOP(I32 type, I32 flags)
      2.
  • newPVOP

    Constructs, checks, and returns an op of any type that involves anembedded C-level pointer (PV). type is the opcode. flags givesthe eight bits of op_flags. pv supplies the C-level pointer, whichmust have been allocated using PerlMemShared_malloc; the memory willbe freed when the op is destroyed.

    1. OP *newPVOP(I32 type, I32 flags, char *pv)
      2.
  • newRANGE

    Constructs and returns a range op, with subordinate flip andflop ops. flags gives the eight bits of op_flags for theflip op and, shifted up eight bits, the eight bits of op_privatefor both the flip and range ops, except that the bit with value1 is automatically set. left and right supply the expressionscontrolling the endpoints of the range; they are consumed by this functionand become part of the constructed op tree.

    1. OP *newRANGE(I32 flags, OP *left, OP *right)
      2.
  • newSLICEOP

    Constructs, checks, and returns an lslice (list slice) op. flagsgives the eight bits of op_flags, except that OPf_KIDS willbe set automatically, and, shifted up eight bits, the eight bits ofop_private, except that the bit with value 1 or 2 is automaticallyset as required. listval and subscript supply the parameters ofthe slice; they are consumed by this function and become part of theconstructed op tree.

    1. OP *newSLICEOP(I32 flags, OP *subscript,
      2.  
    2.    OP *listval)
      3.
  • newSTATEOP

    Constructs a state op (COP). The state op is normally a nextstate op,but will be a dbstate op if debugging is enabled for currently-compiledcode. The state op is populated from PL_curcop (or PL_compiling).If label is non-null, it supplies the name of a label to attach tothe state op; this function takes ownership of the memory pointed at bylabel, and will free it. flags gives the eight bits of op_flagsfor the state op.

    If o is null, the state op is returned. Otherwise the state op iscombined with o into a lineseq list op, which is returned. ois consumed by this function and becomes part of the returned op tree.

    1. OP *newSTATEOP(I32 flags, char *label, OP *o)
      2.
  • newSVOP

    Constructs, checks, and returns an op of any type that involves anembedded SV. type is the opcode. flags gives the eight bitsof op_flags. sv gives the SV to embed in the op; this functiontakes ownership of one reference to it.

    1. OP *newSVOP(I32 type, I32 flags, SV *sv)
      2.
  • newUNOP

    Constructs, checks, and returns an op of any unary type. type isthe opcode. flags gives the eight bits of op_flags, except thatOPf_KIDS will be set automatically if required, and, shifted up eightbits, the eight bits of op_private, except that the bit with value 1is automatically set. first supplies an optional op to be the directchild of the unary op; it is consumed by this function and become partof the constructed op tree.

    1. OP *newUNOP(I32 type, I32 flags, OP *first)
      2.
  • newWHENOP

    Constructs, checks, and returns an op tree expressing a when block.cond supplies the test expression, and block supplies the blockthat will be executed if the test evaluates to true; they are consumedby this function and become part of the constructed op tree. condwill be interpreted DWIMically, often as a comparison against $_,and may be null to generate a default block.

    1. OP *newWHENOP(OP *cond, OP *block)
      2.
  • newWHILEOP

    Constructs, checks, and returns an op tree expressing a while loop.This is a heavyweight loop, with structure that allows exiting the loopby last and suchlike.

    loop is an optional preconstructed enterloop op to use in theloop; if it is null then a suitable op will be constructed automatically.expr supplies the loop's controlling expression. block supplies themain body of the loop, and cont optionally supplies a continue blockthat operates as a second half of the body. All of these optree inputsare consumed by this function and become part of the constructed op tree.

    flags gives the eight bits of op_flags for the leaveloopop and, shifted up eight bits, the eight bits of op_private forthe leaveloop op, except that (in both cases) some bits will be setautomatically. debuggable is currently unused and should always be 1.has_my can be supplied as true to force theloop body to be enclosed in its own scope.

    1. OP *newWHILEOP(I32 flags, I32 debuggable,
      2.  
    2.    LOOP *loop, OP *expr, OP *block,
      3.  
    3.    OP *cont, I32 has_my)
      4.

Optree Manipulation Functions

  • ck_entersub_args_list

    Performs the default fixup of the arguments part of an entersubop tree. This consists of applying list context to each of theargument ops. This is the standard treatment used on a call markedwith &, or a method call, or a call through a subroutine reference,or any other call where the callee can't be identified at compile time,or a call where the callee has no prototype.

    1. OP *ck_entersub_args_list(OP *entersubop)
      2.
  • ck_entersub_args_proto

    Performs the fixup of the arguments part of an entersub op treebased on a subroutine prototype. This makes various modifications tothe argument ops, from applying context up to inserting refgen ops,and checking the number and syntactic types of arguments, as directed bythe prototype. This is the standard treatment used on a subroutine call,not marked with &, where the callee can be identified at compile timeand has a prototype.

    protosv supplies the subroutine prototype to be applied to the call.It may be a normal defined scalar, of which the string value will be used.Alternatively, for convenience, it may be a subroutine object (a CV*that has been cast to SV*) which has a prototype. The prototypesupplied, in whichever form, does not need to match the actual calleereferenced by the op tree.

    If the argument ops disagree with the prototype, for example by havingan unacceptable number of arguments, a valid op tree is returned anyway.The error is reflected in the parser state, normally resulting in a singleexception at the top level of parsing which covers all the compilationerrors that occurred. In the error message, the callee is referred toby the name defined by the namegv parameter.

    1. OP *ck_entersub_args_proto(OP *entersubop,
      2.  
    2.    GV *namegv, SV *protosv)
      3.
  • ck_entersub_args_proto_or_list

    Performs the fixup of the arguments part of an entersub op tree eitherbased on a subroutine prototype or using default list-context processing.This is the standard treatment used on a subroutine call, not markedwith &, where the callee can be identified at compile time.

    protosv supplies the subroutine prototype to be applied to the call,or indicates that there is no prototype. It may be a normal scalar,in which case if it is defined then the string value will be usedas a prototype, and if it is undefined then there is no prototype.Alternatively, for convenience, it may be a subroutine object (a CV*that has been cast to SV*), of which the prototype will be used if ithas one. The prototype (or lack thereof) supplied, in whichever form,does not need to match the actual callee referenced by the op tree.

    If the argument ops disagree with the prototype, for example by havingan unacceptable number of arguments, a valid op tree is returned anyway.The error is reflected in the parser state, normally resulting in a singleexception at the top level of parsing which covers all the compilationerrors that occurred. In the error message, the callee is referred toby the name defined by the namegv parameter.

    1. OP *ck_entersub_args_proto_or_list(OP *entersubop,
      2.  
    2.    GV *namegv,
      3.  
    3.    SV *protosv)
      4.
  • cv_const_sv

    If cv is a constant sub eligible for inlining. returns the constantvalue returned by the sub. Otherwise, returns NULL.

    Constant subs can be created with newCONSTSUB or as described inConstant Functions in perlsub.

    1. SV*cv_const_sv(const CV *const cv)
      2.
  • cv_get_call_checker

    Retrieves the function that will be used to fix up a call to cv.Specifically, the function is applied to an entersub op tree for asubroutine call, not marked with &, where the callee can be identifiedat compile time as cv.

    The C-level function pointer is returned in *ckfun_p, and an SVargument for it is returned in *ckobj_p. The function is intendedto be called in this manner:

    1.  entersubop = (*ckfun_p)(aTHX_ entersubop, namegv, (*ckobj_p));
      2.

    In this call, entersubop is a pointer to the entersub op,which may be replaced by the check function, and namegv is a GVsupplying the name that should be used by the check function to referto the callee of the entersub op if it needs to emit any diagnostics.It is permitted to apply the check function in non-standard situations,such as to a call to a different subroutine or to a method call.

    By default, the function isPerl_ck_entersub_args_proto_or_list,and the SV parameter is cv itself. This implements standardprototype processing. It can be changed, for a particular subroutine,by cv_set_call_checker.

    1. voidcv_get_call_checker(CV *cv,
      2.  
    2.  Perl_call_checker *ckfun_p,
      3.  
    3.  SV **ckobj_p)
      4.
  • cv_set_call_checker

    Sets the function that will be used to fix up a call to cv.Specifically, the function is applied to an entersub op tree for asubroutine call, not marked with &, where the callee can be identifiedat compile time as cv.

    The C-level function pointer is supplied in ckfun, and an SV argumentfor it is supplied in ckobj. The function is intended to be calledin this manner:

    1.  entersubop = ckfun(aTHX_ entersubop, namegv, ckobj);
      2.

    In this call, entersubop is a pointer to the entersub op,which may be replaced by the check function, and namegv is a GVsupplying the name that should be used by the check function to referto the callee of the entersub op if it needs to emit any diagnostics.It is permitted to apply the check function in non-standard situations,such as to a call to a different subroutine or to a method call.

    The current setting for a particular CV can be retrieved bycv_get_call_checker.

    1. voidcv_set_call_checker(CV *cv,
      2.  
    2.  Perl_call_checker ckfun,
      3.  
    3.  SV *ckobj)
      4.
  • LINKLIST

    Given the root of an optree, link the tree in execution order using theop_next pointers and return the first op executed. If this hasalready been done, it will not be redone, and o->op_next will bereturned. If o->op_next is not already set, o should be atleast an UNOP.

    1. OP*LINKLIST(OP *o)
      2.
  • newCONSTSUB

    See newCONSTSUB_flags.

    1. CV*newCONSTSUB(HV* stash, const char* name, SV* sv)
      2.
  • newCONSTSUB_flags

    Creates a constant sub equivalent to Perl sub FOO () { 123 } which iseligible for inlining at compile-time.

    Currently, the only useful value for flags is SVf_UTF8.

    Passing NULL for SV creates a constant sub equivalent to sub BAR () {},which won't be called if used as a destructor, but will suppress the overheadof a call to AUTOLOAD. (This form, however, isn't eligible for inlining atcompile time.)

    1. CV*newCONSTSUB_flags(HV* stash, const char* name,
      2.  
    2.   STRLEN len, U32 flags, SV* sv)
      3.
  • newXS

    Used by xsubpp to hook up XSUBs as Perl subs. filename needs to bestatic storage, as it is used directly as CvFILE(), without a copy being made.

  • op_append_elem

    Append an item to the list of ops contained directly within a list-typeop, returning the lengthened list. first is the list-type op,and last is the op to append to the list. optype specifies theintended opcode for the list. If first is not already a list of theright type, it will be upgraded into one. If either first or lastis null, the other is returned unchanged.

    1. OP *op_append_elem(I32 optype, OP *first, OP *last)
      2.
  • op_append_list

    Concatenate the lists of ops contained directly within two list-type ops,returning the combined list. first and last are the list-type opsto concatenate. optype specifies the intended opcode for the list.If either first or last is not already a list of the right type,it will be upgraded into one. If either first or last is null,the other is returned unchanged.

    1. OP *op_append_list(I32 optype, OP *first, OP *last)
      2.
  • OP_CLASS

    Return the class of the provided OP: that is, which of the *OPstructures it uses. For core ops this currently gets the information outof PL_opargs, which does not always accurately reflect the type used.For custom ops the type is returned from the registration, and it is upto the registree to ensure it is accurate. The value returned will beone of the OA_* constants from op.h.

    1. U32OP_CLASS(OP *o)
      2.
  • OP_DESC

    Return a short description of the provided OP.

    1. const char * OP_DESC(OP *o)
      2.
  • op_linklist

    This function is the implementation of the LINKLIST macro. It shouldnot be called directly.

    1. OP*op_linklist(OP *o)
      2.
  • op_lvalue

    Propagate lvalue ("modifiable") context to an op and its children.type represents the context type, roughly based on the type of op thatwould do the modifying, although local() is represented by OP_NULL,because it has no op type of its own (it is signalled by a flag onthe lvalue op).

    This function detects things that can't be modified, such as $x+1, andgenerates errors for them. For example, $x+1 = 2 would cause it to becalled with an op of type OP_ADD and a type argument of OP_SASSIGN.

    It also flags things that need to behave specially in an lvalue context,such as $$x = 5 which might have to vivify a reference in $x.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. OP *op_lvalue(OP *o, I32 type)
      2.
  • OP_NAME

    Return the name of the provided OP. For core ops this looks up the namefrom the op_type; for custom ops from the op_ppaddr.

    1. const char * OP_NAME(OP *o)
      2.
  • op_prepend_elem

    Prepend an item to the list of ops contained directly within a list-typeop, returning the lengthened list. first is the op to prepend to thelist, and last is the list-type op. optype specifies the intendedopcode for the list. If last is not already a list of the right type,it will be upgraded into one. If either first or last is null,the other is returned unchanged.

    1. OP *op_prepend_elem(I32 optype, OP *first, OP *last)
      2.
  • op_scope

    Wraps up an op tree with some additional ops so that at runtime a dynamicscope will be created. The original ops run in the new dynamic scope,and then, provided that they exit normally, the scope will be unwound.The additional ops used to create and unwind the dynamic scope willnormally be an enter/leave pair, but a scope op may be usedinstead if the ops are simple enough to not need the full dynamic scopestructure.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. OP *op_scope(OP *o)
      2.
  • rv2cv_op_cv

    Examines an op, which is expected to identify a subroutine at runtime,and attempts to determine at compile time which subroutine it identifies.This is normally used during Perl compilation to determine whethera prototype can be applied to a function call. cvop is the opbeing considered, normally an rv2cv op. A pointer to the identifiedsubroutine is returned, if it could be determined statically, and a nullpointer is returned if it was not possible to determine statically.

    Currently, the subroutine can be identified statically if the RV that therv2cv is to operate on is provided by a suitable gv or const op.A gv op is suitable if the GV's CV slot is populated. A const op issuitable if the constant value must be an RV pointing to a CV. Details ofthis process may change in future versions of Perl. If the rv2cv ophas the OPpENTERSUB_AMPER flag set then no attempt is made to identifythe subroutine statically: this flag is used to suppress compile-timemagic on a subroutine call, forcing it to use default runtime behaviour.

    If flags has the bit RV2CVOPCV_MARK_EARLY set, then the handlingof a GV reference is modified. If a GV was examined and its CV slot wasfound to be empty, then the gv op has the OPpEARLY_CV flag set.If the op is not optimised away, and the CV slot is later populated witha subroutine having a prototype, that flag eventually triggers the warning"called too early to check prototype".

    If flags has the bit RV2CVOPCV_RETURN_NAME_GV set, then insteadof returning a pointer to the subroutine it returns a pointer to theGV giving the most appropriate name for the subroutine in this context.Normally this is just the CvGV of the subroutine, but for an anonymous(CvANON) subroutine that is referenced through a GV it will be thereferencing GV. The resulting GV* is cast to CV* to be returned.A null pointer is returned as usual if there is no statically-determinablesubroutine.

    1. CV *rv2cv_op_cv(OP *cvop, U32 flags)
      2.

Pad Data Structures

  • CvPADLIST

    CV's can have CvPADLIST(cv) set to point to an AV. This is the CV'sscratchpad, which stores lexical variables and opcode temporary andper-thread values.

    For these purposes "forms" are a kind-of CV, eval""s are too (except they'renot callable at will and are always thrown away after the eval"" is doneexecuting). Require'd files are simply evals without any outer lexicalscope.

    XSUBs don't have CvPADLIST set - dXSTARG fetches values from PL_curpad,but that is really the callers pad (a slot of which is allocated byevery entersub).

    The CvPADLIST AV has the REFCNT of its component items managed "manually"(mostly in pad.c) rather than by normal av.c rules. So we turn off AvREALjust before freeing it, to let av.c know not to touch the entries.The items in the AV are not SVs as for a normal AV, but other AVs:

    0'th Entry of the CvPADLIST is an AV which represents the "names" or ratherthe "static type information" for lexicals.

    The CvDEPTH'th entry of CvPADLIST AV is an AV which is the stack frame at thatdepth of recursion into the CV.The 0'th slot of a frame AV is an AV which is @_.other entries are storage for variables and op targets.

    Iterating over the names AV iterates over all possible paditems. Pad slots that are SVs_PADTMP (targets/GVs/constants) end up having&PL_sv_undef "names" (see pad_alloc()).

    Only my/our variable (SVs_PADMY/SVs_PADOUR) slots get valid names.The rest are op targets/GVs/constants which are statically allocatedor resolved at compile time. These don't have names by which theycan be looked up from Perl code at run time through eval"" likemy/our variables can be. Since they can't be looked up by "name"but only by their index allocated at compile time (which is usuallyin PL_op->op_targ), wasting a name SV for them doesn't make sense.

    The SVs in the names AV have their PV being the name of the variable.xlow+1..xhigh inclusive in the NV union is a range of cop_seq numbers forwhich the name is valid (accessed through the macros COP_SEQ_RANGE_LOW and_HIGH). During compilation, these fields may hold the special valuePERL_PADSEQ_INTRO to indicate various stages:

    1.    COP_SEQ_RANGE_LOW _HIGH
      2.  
    2.    ----------------- -----
      3.  
    3.    PERL_PADSEQ_INTRO 0   variable not yet introduced:   { my ($x
      4.  
    4.    valid-seq#   PERL_PADSEQ_INTRO   variable in scope: { my ($x)
      5.  
    5.    valid-seq#  valid-seq#   compilation of scope complete: { my ($x) }
      6.

    For typed lexicals name SV is SVt_PVMG and SvSTASHpoints at the type. For our lexicals, the type is also SVt_PVMG, with theSvOURSTASH slot pointing at the stash of the associated global (so thatduplicate our declarations in the same package can be detected). SvUVX issometimes hijacked to store the generation number during compilation.

    If SvFAKE is set on the name SV, then that slot in the frame AV isa REFCNT'ed reference to a lexical from "outside". In this case,the name SV does not use xlow and xhigh to store a cop_seq range, since it isin scope throughout. Instead xhigh stores some flags containing info aboutthe real lexical (is it declared in an anon, and is it capable of beinginstantiated multiple times?), and for fake ANONs, xlow contains the indexwithin the parent's pad where the lexical's value is stored, to makecloning quicker.

    If the 'name' is '&' the corresponding entry in frame AVis a CV representing a possible closure.(SvFAKE and name of '&' is not a meaningful combination currently but couldbecome so if my sub foo {} is implemented.)

    Note that formats are treated as anon subs, and are cloned each timewrite is called (if necessary).

    The flag SVs_PADSTALE is cleared on lexicals each time the my() is executed,and set on scope exit. This allows the 'Variable $x is not available' warningto be generated in evals, such as

    1.  { my $x = 1; sub f { eval '$x'} } f();
      2.

    For state vars, SVs_PADSTALE is overloaded to mean 'not yet initialised'

    NOTE: this function is experimental and may change or beremoved without notice.

    1. PADLIST * CvPADLIST(CV *cv)
      2.
  • pad_add_name_pvs

    Exactly like pad_add_name_pvn, but takes a literal string insteadof a string/length pair.

    1. PADOFFSET pad_add_name_pvs(const char *name, U32 flags,
      2.  
    2.    HV *typestash, HV *ourstash)
      3.
  • pad_findmy_pvs

    Exactly like pad_findmy_pvn, but takes a literal string insteadof a string/length pair.

    1. PADOFFSET pad_findmy_pvs(const char *name, U32 flags)
      2.
  • pad_new

    Create a new padlist, updating the global variables for thecurrently-compiling padlist to point to the new padlist. The followingflags can be OR'ed together:

    1.  padnew_CLONEthis pad is for a cloned CV
      2.  
    2.  padnew_SAVEsave old globals on the save stack
      3.  
    3.  padnew_SAVESUBalso save extra stuff for start of sub
      4.  
    4.  
    5. PADLIST * pad_new(int flags)
      6.
  • PL_comppad

    During compilation, this points to the array containing the valuespart of the pad for the currently-compiling code. (At runtime a CV mayhave many such value arrays; at compile time just one is constructed.)At runtime, this points to the array containing the currently-relevantvalues for the pad for the currently-executing code.

    NOTE: this function is experimental and may change or beremoved without notice.

  • PL_comppad_name

    During compilation, this points to the array containing the names partof the pad for the currently-compiling code.

    NOTE: this function is experimental and may change or beremoved without notice.

  • PL_curpad

    Points directly to the body of the PL_comppad array.(I.e., this is AvARRAY(PL_comppad).)

    NOTE: this function is experimental and may change or beremoved without notice.

Per-Interpreter Variables

  • PL_modglobal

    PL_modglobal is a general purpose, interpreter global HV for use byextensions that need to keep information on a per-interpreter basis.In a pinch, it can also be used as a symbol table for extensionsto share data among each other. It is a good idea to use keysprefixed by the package name of the extension that owns the data.

    1. HV*PL_modglobal
      2.
  • PL_na

    A convenience variable which is typically used with SvPV when onedoesn't care about the length of the string. It is usually more efficientto either declare a local variable and use that instead or to use theSvPV_nolen macro.

    1. STRLENPL_na
      2.
  • PL_opfreehook

    When non-NULL, the function pointed by this variable will be called each time an OP is freed with the corresponding OP as the argument.This allows extensions to free any extra attribute they have locally attached to an OP.It is also assured to first fire for the parent OP and then for its kids.

    When you replace this variable, it is considered a good practice to store the possibly previously installed hook and that you recall it inside your own.

    1. Perl_ophook_tPL_opfreehook
      2.
  • PL_peepp

    Pointer to the per-subroutine peephole optimiser. This is a functionthat gets called at the end of compilation of a Perl subroutine (orequivalently independent piece of Perl code) to perform fixups ofsome ops and to perform small-scale optimisations. The function iscalled once for each subroutine that is compiled, and is passed, as soleparameter, a pointer to the op that is the entry point to the subroutine.It modifies the op tree in place.

    The peephole optimiser should never be completely replaced. Rather,add code to it by wrapping the existing optimiser. The basic way to dothis can be seen in Compile pass 3: peephole optimization in perlguts.If the new code wishes to operate on ops throughout the subroutine'sstructure, rather than just at the top level, it is likely to be moreconvenient to wrap the PL_rpeepp hook.

    1. peep_tPL_peepp
      2.
  • PL_rpeepp

    Pointer to the recursive peephole optimiser. This is a functionthat gets called at the end of compilation of a Perl subroutine (orequivalently independent piece of Perl code) to perform fixups of someops and to perform small-scale optimisations. The function is calledonce for each chain of ops linked through their op_next fields;it is recursively called to handle each side chain. It is passed, assole parameter, a pointer to the op that is at the head of the chain.It modifies the op tree in place.

    The peephole optimiser should never be completely replaced. Rather,add code to it by wrapping the existing optimiser. The basic way to dothis can be seen in Compile pass 3: peephole optimization in perlguts.If the new code wishes to operate only on ops at a subroutine's top level,rather than throughout the structure, it is likely to be more convenientto wrap the PL_peepp hook.

    1. peep_tPL_rpeepp
      2.
  • PL_sv_no

    This is the false SV. See PL_sv_yes. Always refer to this as&PL_sv_no.

    1. SVPL_sv_no
      2.
  • PL_sv_undef

    This is the undef SV. Always refer to this as &PL_sv_undef.

    1. SVPL_sv_undef
      2.
  • PL_sv_yes

    This is the true SV. See PL_sv_no. Always refer to this as&PL_sv_yes.

    1. SVPL_sv_yes
      2.

REGEXP Functions

  • SvRX

    Convenience macro to get the REGEXP from a SV. This is approximatelyequivalent to the following snippet:

    1.  if (SvMAGICAL(sv))
      2.  
    2.  mg_get(sv);
      3.  
    3.  if (SvROK(sv))
      4.  
    4.  sv = MUTABLE_SV(SvRV(sv));
      5.  
    5.  if (SvTYPE(sv) == SVt_REGEXP)
      6.  
    6.  return (REGEXP*) sv;
      7.

    NULL will be returned if a REGEXP* is not found.

    1. REGEXP * SvRX(SV *sv)
      2.
  • SvRXOK

    Returns a boolean indicating whether the SV (or the one it references)is a REGEXP.

    If you want to do something with the REGEXP* later use SvRX insteadand check for NULL.

    1. boolSvRXOK(SV* sv)
      2.

Simple Exception Handling Macros

Stack Manipulation Macros

  • dMARK

    Declare a stack marker variable, mark, for the XSUB. See MARK anddORIGMARK.

    1. dMARK;
      2.
  • dORIGMARK

    Saves the original stack mark for the XSUB. See ORIGMARK.

    1. dORIGMARK;
      2.
  • dSP

    Declares a local copy of perl's stack pointer for the XSUB, available viathe SP macro. See SP.

    1. dSP;
      2.
  • EXTEND

    Used to extend the argument stack for an XSUB's return values. Onceused, guarantees that there is room for at least nitems to be pushedonto the stack.

    1. voidEXTEND(SP, int nitems)
      2.
  • MARK

    Stack marker variable for the XSUB. See dMARK.

  • mPUSHi

    Push an integer onto the stack. The stack must have room for this element.Does not use TARG. See also PUSHi, mXPUSHi and XPUSHi.

    1. voidmPUSHi(IV iv)
      2.
  • mPUSHn

    Push a double onto the stack. The stack must have room for this element.Does not use TARG. See also PUSHn, mXPUSHn and XPUSHn.

    1. voidmPUSHn(NV nv)
      2.
  • mPUSHp

    Push a string onto the stack. The stack must have room for this element.The len indicates the length of the string. Does not use TARG.See also PUSHp, mXPUSHp and XPUSHp.

    1. voidmPUSHp(char* str, STRLEN len)
      2.
  • mPUSHs

    Push an SV onto the stack and mortalizes the SV. The stack must have roomfor this element. Does not use TARG. See also PUSHs and mXPUSHs.

    1. voidmPUSHs(SV* sv)
      2.
  • mPUSHu

    Push an unsigned integer onto the stack. The stack must have room for thiselement. Does not use TARG. See also PUSHu, mXPUSHu and XPUSHu.

    1. voidmPUSHu(UV uv)
      2.
  • mXPUSHi

    Push an integer onto the stack, extending the stack if necessary.Does not use TARG. See also XPUSHi, mPUSHi and PUSHi.

    1. voidmXPUSHi(IV iv)
      2.
  • mXPUSHn

    Push a double onto the stack, extending the stack if necessary.Does not use TARG. See also XPUSHn, mPUSHn and PUSHn.

    1. voidmXPUSHn(NV nv)
      2.
  • mXPUSHp

    Push a string onto the stack, extending the stack if necessary. The lenindicates the length of the string. Does not use TARG. See also XPUSHp,mPUSHp and PUSHp.

    1. voidmXPUSHp(char* str, STRLEN len)
      2.
  • mXPUSHs

    Push an SV onto the stack, extending the stack if necessary and mortalizesthe SV. Does not use TARG. See also XPUSHs and mPUSHs.

    1. voidmXPUSHs(SV* sv)
      2.
  • mXPUSHu

    Push an unsigned integer onto the stack, extending the stack if necessary.Does not use TARG. See also XPUSHu, mPUSHu and PUSHu.

    1. voidmXPUSHu(UV uv)
      2.
  • ORIGMARK

    The original stack mark for the XSUB. See dORIGMARK.

  • POPi

    Pops an integer off the stack.

    1. IVPOPi
      2.
  • POPl

    Pops a long off the stack.

    1. longPOPl
      2.
  • POPn

    Pops a double off the stack.

    1. NVPOPn
      2.
  • POPp

    Pops a string off the stack. Deprecated. New code should use POPpx.

    1. char*POPp
      2.
  • POPpbytex

    Pops a string off the stack which must consist of bytes i.e. characters < 256.

    1. char*POPpbytex
      2.
  • POPpx

    Pops a string off the stack.

    1. char*POPpx
      2.
  • POPs

    Pops an SV off the stack.

    1. SV*POPs
      2.
  • PUSHi

    Push an integer onto the stack. The stack must have room for this element.Handles 'set' magic. Uses TARG, so dTARGET or dXSTARG should becalled to declare it. Do not call multiple TARG-oriented macros to return lists from XSUB's - see mPUSHi instead. See also XPUSHi andmXPUSHi.

    1. voidPUSHi(IV iv)
      2.
  • PUSHMARK

    Opening bracket for arguments on a callback. See PUTBACK andperlcall.

    1. voidPUSHMARK(SP)
      2.
  • PUSHmortal

    Push a new mortal SV onto the stack. The stack must have room for thiselement. Does not use TARG. See also PUSHs, XPUSHmortal and XPUSHs.

    1. voidPUSHmortal()
      2.
  • PUSHn

    Push a double onto the stack. The stack must have room for this element.Handles 'set' magic. Uses TARG, so dTARGET or dXSTARG should becalled to declare it. Do not call multiple TARG-oriented macros toreturn lists from XSUB's - see mPUSHn instead. See also XPUSHn andmXPUSHn.

    1. voidPUSHn(NV nv)
      2.
  • PUSHp

    Push a string onto the stack. The stack must have room for this element.The len indicates the length of the string. Handles 'set' magic. UsesTARG, so dTARGET or dXSTARG should be called to declare it. Do notcall multiple TARG-oriented macros to return lists from XSUB's - seemPUSHp instead. See also XPUSHp and mXPUSHp.

    1. voidPUSHp(char* str, STRLEN len)
      2.
  • PUSHs

    Push an SV onto the stack. The stack must have room for this element.Does not handle 'set' magic. Does not use TARG. See also PUSHmortal,XPUSHs and XPUSHmortal.

    1. voidPUSHs(SV* sv)
      2.
  • PUSHu

    Push an unsigned integer onto the stack. The stack must have room for thiselement. Handles 'set' magic. Uses TARG, so dTARGET or dXSTARGshould be called to declare it. Do not call multiple TARG-orientedmacros to return lists from XSUB's - see mPUSHu instead. See alsoXPUSHu and mXPUSHu.

    1. voidPUSHu(UV uv)
      2.
  • PUTBACK

    Closing bracket for XSUB arguments. This is usually handled by xsubpp.See PUSHMARK and perlcall for other uses.

    1. PUTBACK;
      2.
  • SP

    Stack pointer. This is usually handled by xsubpp. See dSP andSPAGAIN.

  • SPAGAIN

    Refetch the stack pointer. Used after a callback. See perlcall.

    1. SPAGAIN;
      2.
  • XPUSHi

    Push an integer onto the stack, extending the stack if necessary. Handles'set' magic. Uses TARG, so dTARGET or dXSTARG should be called todeclare it. Do not call multiple TARG-oriented macros to return listsfrom XSUB's - see mXPUSHi instead. See also PUSHi and mPUSHi.

    1. voidXPUSHi(IV iv)
      2.
  • XPUSHmortal

    Push a new mortal SV onto the stack, extending the stack if necessary.Does not use TARG. See also XPUSHs, PUSHmortal and PUSHs.

    1. voidXPUSHmortal()
      2.
  • XPUSHn

    Push a double onto the stack, extending the stack if necessary. Handles'set' magic. Uses TARG, so dTARGET or dXSTARG should be called todeclare it. Do not call multiple TARG-oriented macros to return listsfrom XSUB's - see mXPUSHn instead. See also PUSHn and mPUSHn.

    1. voidXPUSHn(NV nv)
      2.
  • XPUSHp

    Push a string onto the stack, extending the stack if necessary. The lenindicates the length of the string. Handles 'set' magic. Uses TARG, sodTARGET or dXSTARG should be called to declare it. Do not callmultiple TARG-oriented macros to return lists from XSUB's - seemXPUSHp instead. See also PUSHp and mPUSHp.

    1. voidXPUSHp(char* str, STRLEN len)
      2.
  • XPUSHs

    Push an SV onto the stack, extending the stack if necessary. Does nothandle 'set' magic. Does not use TARG. See also XPUSHmortal,PUSHs and PUSHmortal.

    1. voidXPUSHs(SV* sv)
      2.
  • XPUSHu

    Push an unsigned integer onto the stack, extending the stack if necessary.Handles 'set' magic. Uses TARG, so dTARGET or dXSTARG should becalled to declare it. Do not call multiple TARG-oriented macros toreturn lists from XSUB's - see mXPUSHu instead. See also PUSHu andmPUSHu.

    1. voidXPUSHu(UV uv)
      2.
  • XSRETURN

    Return from XSUB, indicating number of items on the stack. This is usuallyhandled by xsubpp.

    1. voidXSRETURN(int nitems)
      2.
  • XSRETURN_EMPTY

    Return an empty list from an XSUB immediately.

    1. XSRETURN_EMPTY;
      2.
  • XSRETURN_IV

    Return an integer from an XSUB immediately. Uses XST_mIV.

    1. voidXSRETURN_IV(IV iv)
      2.
  • XSRETURN_NO

    Return &PL_sv_no from an XSUB immediately. Uses XST_mNO.

    1. XSRETURN_NO;
      2.
  • XSRETURN_NV

    Return a double from an XSUB immediately. Uses XST_mNV.

    1. voidXSRETURN_NV(NV nv)
      2.
  • XSRETURN_PV

    Return a copy of a string from an XSUB immediately. Uses XST_mPV.

    1. voidXSRETURN_PV(char* str)
      2.
  • XSRETURN_UNDEF

    Return &PL_sv_undef from an XSUB immediately. Uses XST_mUNDEF.

    1. XSRETURN_UNDEF;
      2.
  • XSRETURN_UV

    Return an integer from an XSUB immediately. Uses XST_mUV.

    1. voidXSRETURN_UV(IV uv)
      2.
  • XSRETURN_YES

    Return &PL_sv_yes from an XSUB immediately. Uses XST_mYES.

    1. XSRETURN_YES;
      2.
  • XST_mIV

    Place an integer into the specified position pos on the stack. Thevalue is stored in a new mortal SV.

    1. voidXST_mIV(int pos, IV iv)
      2.
  • XST_mNO

    Place &PL_sv_no into the specified position pos on thestack.

    1. voidXST_mNO(int pos)
      2.
  • XST_mNV

    Place a double into the specified position pos on the stack. The valueis stored in a new mortal SV.

    1. voidXST_mNV(int pos, NV nv)
      2.
  • XST_mPV

    Place a copy of a string into the specified position pos on the stack. The value is stored in a new mortal SV.

    1. voidXST_mPV(int pos, char* str)
      2.
  • XST_mUNDEF

    Place &PL_sv_undef into the specified position pos on thestack.

    1. voidXST_mUNDEF(int pos)
      2.
  • XST_mYES

    Place &PL_sv_yes into the specified position pos on thestack.

    1. voidXST_mYES(int pos)
      2.

SV Flags

  • svtype

    An enum of flags for Perl types. These are found in the file sv.hin the svtype enum. Test these flags with the SvTYPE macro.

  • SVt_IV

    Integer type flag for scalars. See svtype.

  • SVt_NV

    Double type flag for scalars. See svtype.

  • SVt_PV

    Pointer type flag for scalars. See svtype.

  • SVt_PVAV

    Type flag for arrays. See svtype.

  • SVt_PVCV

    Type flag for code refs. See svtype.

  • SVt_PVHV

    Type flag for hashes. See svtype.

  • SVt_PVMG

    Type flag for blessed scalars. See svtype.

SV Manipulation Functions

  • boolSV

    Returns a true SV if b is a true value, or a false SV if b is 0.

    See also PL_sv_yes and PL_sv_no.

    1. SV *boolSV(bool b)
      2.
  • croak_xs_usage

    A specialised variant of croak() for emitting the usage message for xsubs

    1.  croak_xs_usage(cv, "eee_yow");
      2.

    works out the package name and subroutine name from cv, and then callscroak(). Hence if cv is &ouch::awk, it would call croak as:

    1.  Perl_croak(aTHX_ "Usage: %"SVf"::%"SVf"(%s)", "ouch" "awk", "eee_yow");
      2.  
    2.  
    3. voidcroak_xs_usage(const CV *const cv,
      4.  
    4.    const char *const params)
      5.
  • get_sv

    Returns the SV of the specified Perl scalar. flags are passed togv_fetchpv. If GV_ADD is set and thePerl variable does not exist then it will be created. If flags is zeroand the variable does not exist then NULL is returned.

    NOTE: the perl_ form of this function is deprecated.

    1. SV*get_sv(const char *name, I32 flags)
      2.
  • newRV_inc

    Creates an RV wrapper for an SV. The reference count for the original SV isincremented.

    1. SV*newRV_inc(SV* sv)
      2.
  • newSVpvn_utf8

    Creates a new SV and copies a string into it. If utf8 is true, callsSvUTF8_on on the new SV. Implemented as a wrapper around newSVpvn_flags.

    1. SV*newSVpvn_utf8(NULLOK const char* s, STRLEN len,
      2.  
    2.     U32 utf8)
      3.
  • SvCUR

    Returns the length of the string which is in the SV. See SvLEN.

    1. STRLENSvCUR(SV* sv)
      2.
  • SvCUR_set

    Set the current length of the string which is in the SV. See SvCURand SvIV_set.

    1. voidSvCUR_set(SV* sv, STRLEN len)
      2.
  • SvEND

    Returns a pointer to the spot just after the last character inthe string which is in the SV, where there is usually a trailingnull (even though Perl scalars do not strictly require it).See SvCUR. Access the character as *(SvEND(sv)).

    Warning: If SvCUR is equal to SvLEN, then SvEND points tounallocated memory.

    1. char*SvEND(SV* sv)
      2.
  • SvGAMAGIC

    Returns true if the SV has get magic oroverloading. If either is true thenthe scalar is active data, and has the potential to return a new value everytime it is accessed. Hence you must be careful toonly read it once per user logical operation and workwith that returned value. If neither is true thenthe scalar's value cannot change unless written to.

    1. U32SvGAMAGIC(SV* sv)
      2.
  • SvGROW

    Expands the character buffer in the SV so that it has room for theindicated number of bytes (remember to reserve space for an extra trailingNUL character). Calls sv_grow to perform the expansion if necessary.Returns a pointer to the character buffer.

    1. char *SvGROW(SV* sv, STRLEN len)
      2.
  • SvIOK

    Returns a U32 value indicating whether the SV contains an integer.

    1. U32SvIOK(SV* sv)
      2.
  • SvIOKp

    Returns a U32 value indicating whether the SV contains an integer. Checksthe private setting. Use SvIOK instead.

    1. U32SvIOKp(SV* sv)
      2.
  • SvIOK_notUV

    Returns a boolean indicating whether the SV contains a signed integer.

    1. boolSvIOK_notUV(SV* sv)
      2.
  • SvIOK_off

    Unsets the IV status of an SV.

    1. voidSvIOK_off(SV* sv)
      2.
  • SvIOK_on

    Tells an SV that it is an integer.

    1. voidSvIOK_on(SV* sv)
      2.
  • SvIOK_only

    Tells an SV that it is an integer and disables all other OK bits.

    1. voidSvIOK_only(SV* sv)
      2.
  • SvIOK_only_UV

    Tells and SV that it is an unsigned integer and disables all other OK bits.

    1. voidSvIOK_only_UV(SV* sv)
      2.
  • SvIOK_UV

    Returns a boolean indicating whether the SV contains an unsigned integer.

    1. boolSvIOK_UV(SV* sv)
      2.
  • SvIsCOW

    Returns a boolean indicating whether the SV is Copy-On-Write (either sharedhash key scalars, or full Copy On Write scalars if 5.9.0 is configured forCOW).

    1. boolSvIsCOW(SV* sv)
      2.
  • SvIsCOW_shared_hash

    Returns a boolean indicating whether the SV is Copy-On-Write shared hash keyscalar.

    1. boolSvIsCOW_shared_hash(SV* sv)
      2.
  • SvIV

    Coerces the given SV to an integer and returns it. See SvIVx for aversion which guarantees to evaluate sv only once.

    1. IVSvIV(SV* sv)
      2.
  • SvIVX

    Returns the raw value in the SV's IV slot, without checks or conversions.Only use when you are sure SvIOK is true. See also SvIV().

    1. IVSvIVX(SV* sv)
      2.
  • SvIVx

    Coerces the given SV to an integer and returns it.Guarantees to evaluate sv only once. Only usethis if sv is an expression with side effects,otherwise use the more efficient SvIV.

    1. IVSvIVx(SV* sv)
      2.
  • SvIV_nomg

    Like SvIV but doesn't process magic.

    1. IVSvIV_nomg(SV* sv)
      2.
  • SvIV_set

    Set the value of the IV pointer in sv to val. It is possible to performthe same function of this macro with an lvalue assignment to SvIVX.With future Perls, however, it will be more efficient to use SvIV_set instead of the lvalue assignment to SvIVX.

    1. voidSvIV_set(SV* sv, IV val)
      2.
  • SvLEN

    Returns the size of the string buffer in the SV, not including any partattributable to SvOOK. See SvCUR.

    1. STRLENSvLEN(SV* sv)
      2.
  • SvLEN_set

    Set the actual length of the string which is in the SV. See SvIV_set.

    1. voidSvLEN_set(SV* sv, STRLEN len)
      2.
  • SvMAGIC_set

    Set the value of the MAGIC pointer in sv to val. See SvIV_set.

    1. voidSvMAGIC_set(SV* sv, MAGIC* val)
      2.
  • SvNIOK

    Returns a U32 value indicating whether the SV contains a number, integer ordouble.

    1. U32SvNIOK(SV* sv)
      2.
  • SvNIOKp

    Returns a U32 value indicating whether the SV contains a number, integer ordouble. Checks the private setting. Use SvNIOK instead.

    1. U32SvNIOKp(SV* sv)
      2.
  • SvNIOK_off

    Unsets the NV/IV status of an SV.

    1. voidSvNIOK_off(SV* sv)
      2.
  • SvNOK

    Returns a U32 value indicating whether the SV contains a double.

    1. U32SvNOK(SV* sv)
      2.
  • SvNOKp

    Returns a U32 value indicating whether the SV contains a double. Checks theprivate setting. Use SvNOK instead.

    1. U32SvNOKp(SV* sv)
      2.
  • SvNOK_off

    Unsets the NV status of an SV.

    1. voidSvNOK_off(SV* sv)
      2.
  • SvNOK_on

    Tells an SV that it is a double.

    1. voidSvNOK_on(SV* sv)
      2.
  • SvNOK_only

    Tells an SV that it is a double and disables all other OK bits.

    1. voidSvNOK_only(SV* sv)
      2.
  • SvNV

    Coerce the given SV to a double and return it. See SvNVx for a versionwhich guarantees to evaluate sv only once.

    1. NVSvNV(SV* sv)
      2.
  • SvNVX

    Returns the raw value in the SV's NV slot, without checks or conversions.Only use when you are sure SvNOK is true. See also SvNV().

    1. NVSvNVX(SV* sv)
      2.
  • SvNVx

    Coerces the given SV to a double and returns it.Guarantees to evaluate sv only once. Only usethis if sv is an expression with side effects,otherwise use the more efficient SvNV.

    1. NVSvNVx(SV* sv)
      2.
  • SvNV_nomg

    Like SvNV but doesn't process magic.

    1. NVSvNV_nomg(SV* sv)
      2.
  • SvNV_set

    Set the value of the NV pointer in sv to val. See SvIV_set.

    1. voidSvNV_set(SV* sv, NV val)
      2.
  • SvOK

    Returns a U32 value indicating whether the value is defined. This isonly meaningful for scalars.

    1. U32SvOK(SV* sv)
      2.
  • SvOOK

    Returns a U32 indicating whether the pointer to the string buffer is offset.This hack is used internally to speed up removal of characters from thebeginning of a SvPV. When SvOOK is true, then the start of theallocated string buffer is actually SvOOK_offset() bytes before SvPVX.This offset used to be stored in SvIVX, but is now stored within the sparepart of the buffer.

    1. U32SvOOK(SV* sv)
      2.
  • SvOOK_offset

    Reads into len the offset from SvPVX back to the true start of theallocated buffer, which will be non-zero if sv_chop has been used toefficiently remove characters from start of the buffer. Implemented as amacro, which takes the address of len, which must be of type STRLEN.Evaluates sv more than once. Sets len to 0 if SvOOK(sv) is false.

    1. voidSvOOK_offset(NN SV*sv, STRLEN len)
      2.
  • SvPOK

    Returns a U32 value indicating whether the SV contains a characterstring.

    1. U32SvPOK(SV* sv)
      2.
  • SvPOKp

    Returns a U32 value indicating whether the SV contains a character string.Checks the private setting. Use SvPOK instead.

    1. U32SvPOKp(SV* sv)
      2.
  • SvPOK_off

    Unsets the PV status of an SV.

    1. voidSvPOK_off(SV* sv)
      2.
  • SvPOK_on

    Tells an SV that it is a string.

    1. voidSvPOK_on(SV* sv)
      2.
  • SvPOK_only

    Tells an SV that it is a string and disables all other OK bits.Will also turn off the UTF-8 status.

    1. voidSvPOK_only(SV* sv)
      2.
  • SvPOK_only_UTF8

    Tells an SV that it is a string and disables all other OK bits,and leaves the UTF-8 status as it was.

    1. voidSvPOK_only_UTF8(SV* sv)
      2.
  • SvPV

    Returns a pointer to the string in the SV, or a stringified form ofthe SV if the SV does not contain a string. The SV may cache thestringified version becoming SvPOK. Handles 'get' magic. See alsoSvPVx for a version which guarantees to evaluate sv only once.

    1. char*SvPV(SV* sv, STRLEN len)
      2.
  • SvPVbyte

    Like SvPV, but converts sv to byte representation first if necessary.

    1. char*SvPVbyte(SV* sv, STRLEN len)
      2.
  • SvPVbytex

    Like SvPV, but converts sv to byte representation first if necessary.Guarantees to evaluate sv only once; use the more efficient SvPVbyteotherwise.

    1. char*SvPVbytex(SV* sv, STRLEN len)
      2.
  • SvPVbytex_force

    Like SvPV_force, but converts sv to byte representation first if necessary.Guarantees to evaluate sv only once; use the more efficient SvPVbyte_forceotherwise.

    1. char*SvPVbytex_force(SV* sv, STRLEN len)
      2.
  • SvPVbyte_force

    Like SvPV_force, but converts sv to byte representation first if necessary.

    1. char*SvPVbyte_force(SV* sv, STRLEN len)
      2.
  • SvPVbyte_nolen

    Like SvPV_nolen, but converts sv to byte representation first if necessary.

    1. char*SvPVbyte_nolen(SV* sv)
      2.
  • SvPVutf8

    Like SvPV, but converts sv to utf8 first if necessary.

    1. char*SvPVutf8(SV* sv, STRLEN len)
      2.
  • SvPVutf8x

    Like SvPV, but converts sv to utf8 first if necessary.Guarantees to evaluate sv only once; use the more efficient SvPVutf8otherwise.

    1. char*SvPVutf8x(SV* sv, STRLEN len)
      2.
  • SvPVutf8x_force

    Like SvPV_force, but converts sv to utf8 first if necessary.Guarantees to evaluate sv only once; use the more efficient SvPVutf8_forceotherwise.

    1. char*SvPVutf8x_force(SV* sv, STRLEN len)
      2.
  • SvPVutf8_force

    Like SvPV_force, but converts sv to utf8 first if necessary.

    1. char*SvPVutf8_force(SV* sv, STRLEN len)
      2.
  • SvPVutf8_nolen

    Like SvPV_nolen, but converts sv to utf8 first if necessary.

    1. char*SvPVutf8_nolen(SV* sv)
      2.
  • SvPVX

    Returns a pointer to the physical string in the SV. The SV must contain astring.

    This is also used to store the name of an autoloaded subroutine in an XSAUTOLOAD routine. See Autoloading with XSUBs in perlguts.

    1. char*SvPVX(SV* sv)
      2.
  • SvPVx

    A version of SvPV which guarantees to evaluate sv only once.Only use this if sv is an expression with side effects, otherwise use themore efficient SvPV.

    1. char*SvPVx(SV* sv, STRLEN len)
      2.
  • SvPV_force

    Like SvPV but will force the SV into containing just a string(SvPOK_only). You want force if you are going to update the SvPVXdirectly.

    1. char*SvPV_force(SV* sv, STRLEN len)
      2.
  • SvPV_force_nomg

    Like SvPV but will force the SV into containing just a string(SvPOK_only). You want force if you are going to update the SvPVXdirectly. Doesn't process magic.

    1. char*SvPV_force_nomg(SV* sv, STRLEN len)
      2.
  • SvPV_nolen

    Returns a pointer to the string in the SV, or a stringified form ofthe SV if the SV does not contain a string. The SV may cache thestringified form becoming SvPOK. Handles 'get' magic.

    1. char*SvPV_nolen(SV* sv)
      2.
  • SvPV_nomg

    Like SvPV but doesn't process magic.

    1. char*SvPV_nomg(SV* sv, STRLEN len)
      2.
  • SvPV_nomg_nolen

    Like SvPV_nolen but doesn't process magic.

    1. char*SvPV_nomg_nolen(SV* sv)
      2.
  • SvPV_set

    Set the value of the PV pointer in sv to val. See SvIV_set.

    1. voidSvPV_set(SV* sv, char* val)
      2.
  • SvREFCNT

    Returns the value of the object's reference count.

    1. U32SvREFCNT(SV* sv)
      2.
  • SvREFCNT_dec

    Decrements the reference count of the given SV.

    1. voidSvREFCNT_dec(SV* sv)
      2.
  • SvREFCNT_inc

    Increments the reference count of the given SV.

    All of the following SvREFCNT_inc* macros are optimized versions ofSvREFCNT_inc, and can be replaced with SvREFCNT_inc.

    1. SV*SvREFCNT_inc(SV* sv)
      2.
  • SvREFCNT_inc_NN

    Same as SvREFCNT_inc, but can only be used if you know svis not NULL. Since we don't have to check the NULLness, it's fasterand smaller.

    1. SV*SvREFCNT_inc_NN(SV* sv)
      2.
  • SvREFCNT_inc_simple

    Same as SvREFCNT_inc, but can only be used with expressions without sideeffects. Since we don't have to store a temporary value, it's faster.

    1. SV*SvREFCNT_inc_simple(SV* sv)
      2.
  • SvREFCNT_inc_simple_NN

    Same as SvREFCNT_inc_simple, but can only be used if you know svis not NULL. Since we don't have to check the NULLness, it's fasterand smaller.

    1. SV*SvREFCNT_inc_simple_NN(SV* sv)
      2.
  • SvREFCNT_inc_simple_void

    Same as SvREFCNT_inc_simple, but can only be used if you don't need thereturn value. The macro doesn't need to return a meaningful value.

    1. voidSvREFCNT_inc_simple_void(SV* sv)
      2.
  • SvREFCNT_inc_simple_void_NN

    Same as SvREFCNT_inc, but can only be used if you don't need the returnvalue, and you know that sv is not NULL. The macro doesn't needto return a meaningful value, or check for NULLness, so it's smallerand faster.

    1. voidSvREFCNT_inc_simple_void_NN(SV* sv)
      2.
  • SvREFCNT_inc_void

    Same as SvREFCNT_inc, but can only be used if you don't need thereturn value. The macro doesn't need to return a meaningful value.

    1. voidSvREFCNT_inc_void(SV* sv)
      2.
  • SvREFCNT_inc_void_NN

    Same as SvREFCNT_inc, but can only be used if you don't need the returnvalue, and you know that sv is not NULL. The macro doesn't needto return a meaningful value, or check for NULLness, so it's smallerand faster.

    1. voidSvREFCNT_inc_void_NN(SV* sv)
      2.
  • SvROK

    Tests if the SV is an RV.

    1. U32SvROK(SV* sv)
      2.
  • SvROK_off

    Unsets the RV status of an SV.

    1. voidSvROK_off(SV* sv)
      2.
  • SvROK_on

    Tells an SV that it is an RV.

    1. voidSvROK_on(SV* sv)
      2.
  • SvRV

    Dereferences an RV to return the SV.

    1. SV*SvRV(SV* sv)
      2.
  • SvRV_set

    Set the value of the RV pointer in sv to val. See SvIV_set.

    1. voidSvRV_set(SV* sv, SV* val)
      2.
  • SvSTASH

    Returns the stash of the SV.

    1. HV*SvSTASH(SV* sv)
      2.
  • SvSTASH_set

    Set the value of the STASH pointer in sv to val. See SvIV_set.

    1. voidSvSTASH_set(SV* sv, HV* val)
      2.
  • SvTAINT

    Taints an SV if tainting is enabled, and if some input to the currentexpression is tainted--usually a variable, but possibly also implicitinputs such as locale settings. SvTAINT propagates that taintedness tothe outputs of an expression in a pessimistic fashion; i.e., without payingattention to precisely which outputs are influenced by which inputs.

    1. voidSvTAINT(SV* sv)
      2.
  • SvTAINTED

    Checks to see if an SV is tainted. Returns TRUE if it is, FALSE ifnot.

    1. boolSvTAINTED(SV* sv)
      2.
  • SvTAINTED_off

    Untaints an SV. Be very careful with this routine, as it short-circuitssome of Perl's fundamental security features. XS module authors should notuse this function unless they fully understand all the implications ofunconditionally untainting the value. Untainting should be done in thestandard perl fashion, via a carefully crafted regexp, rather than directlyuntainting variables.

    1. voidSvTAINTED_off(SV* sv)
      2.
  • SvTAINTED_on

    Marks an SV as tainted if tainting is enabled.

    1. voidSvTAINTED_on(SV* sv)
      2.
  • SvTRUE

    Returns a boolean indicating whether Perl would evaluate the SV as true orfalse. See SvOK() for a defined/undefined test. Handles 'get' magicunless the scalar is already SvPOK, SvIOK or SvNOK (the public, not theprivate flags).

    1. boolSvTRUE(SV* sv)
      2.
  • SvTRUE_nomg

    Returns a boolean indicating whether Perl would evaluate the SV as true orfalse. See SvOK() for a defined/undefined test. Does not handle 'get' magic.

    1. boolSvTRUE_nomg(SV* sv)
      2.
  • SvTYPE

    Returns the type of the SV. See svtype.

    1. svtypeSvTYPE(SV* sv)
      2.
  • SvUOK

    Returns a boolean indicating whether the SV contains an unsigned integer.

    1. boolSvUOK(SV* sv)
      2.
  • SvUPGRADE

    Used to upgrade an SV to a more complex form. Uses sv_upgrade toperform the upgrade if necessary. See svtype.

    1. voidSvUPGRADE(SV* sv, svtype type)
      2.
  • SvUTF8

    Returns a U32 value indicating the UTF-8 status of an SV. If things are set-upproperly, this indicates whether or not the SV contains UTF-8 encoded data.Call this after SvPV() in case any call to string overloading updates theinternal flag.

    1. U32SvUTF8(SV* sv)
      2.
  • SvUTF8_off

    Unsets the UTF-8 status of an SV (the data is not changed, just the flag).Do not use frivolously.

    1. voidSvUTF8_off(SV *sv)
      2.
  • SvUTF8_on

    Turn on the UTF-8 status of an SV (the data is not changed, just the flag).Do not use frivolously.

    1. voidSvUTF8_on(SV *sv)
      2.
  • SvUV

    Coerces the given SV to an unsigned integer and returns it. See SvUVxfor a version which guarantees to evaluate sv only once.

    1. UVSvUV(SV* sv)
      2.
  • SvUVX

    Returns the raw value in the SV's UV slot, without checks or conversions.Only use when you are sure SvIOK is true. See also SvUV().

    1. UVSvUVX(SV* sv)
      2.
  • SvUVx

    Coerces the given SV to an unsigned integer andreturns it. Guarantees to sv only once. Onlyuse this if sv is an expression with side effects,otherwise use the more efficient SvUV.

    1. UVSvUVx(SV* sv)
      2.
  • SvUV_nomg

    Like SvUV but doesn't process magic.

    1. UVSvUV_nomg(SV* sv)
      2.
  • SvUV_set

    Set the value of the UV pointer in sv to val. See SvIV_set.

    1. voidSvUV_set(SV* sv, UV val)
      2.
  • SvVOK

    Returns a boolean indicating whether the SV contains a v-string.

    1. boolSvVOK(SV* sv)
      2.
  • sv_catpvn_nomg

    Like sv_catpvn but doesn't process magic.

    1. voidsv_catpvn_nomg(SV* sv, const char* ptr,
      2.  
    2.    STRLEN len)
      3.
  • sv_catpv_nomg

    Like sv_catpv but doesn't process magic.

    1. voidsv_catpv_nomg(SV* sv, const char* ptr)
      2.
  • sv_catsv_nomg

    Like sv_catsv but doesn't process magic.

    1. voidsv_catsv_nomg(SV* dsv, SV* ssv)
      2.
  • sv_derived_from

    Exactly like sv_derived_from_pv, but doesn't take a flags parameter.

    1. boolsv_derived_from(SV* sv, const char *const name)
      2.
  • sv_derived_from_pv

    Exactly like sv_derived_from_pvn, but takes a nul-terminated string instead of a string/length pair.

    1. boolsv_derived_from_pv(SV* sv,
      2.  
    2.    const char *const name,
      3.  
    3.    U32 flags)
      4.
  • sv_derived_from_pvn

    Returns a boolean indicating whether the SV is derived from the specified classat the C level. To check derivation at the Perl level, call isa() as anormal Perl method.

    Currently, the only significant value for flags is SVf_UTF8.

    1. boolsv_derived_from_pvn(SV* sv,
      2.  
    2.  const char *const name,
      3.  
    3.  const STRLEN len, U32 flags)
      4.
  • sv_derived_from_sv

    Exactly like sv_derived_from_pvn, but takes the name string in the formof an SV instead of a string/length pair.

    1. boolsv_derived_from_sv(SV* sv, SV *namesv,
      2.  
    2.    U32 flags)
      3.
  • sv_does

    Like sv_does_pv, but doesn't take a flags parameter.

    1. boolsv_does(SV* sv, const char *const name)
      2.
  • sv_does_pv

    Like sv_does_sv, but takes a nul-terminated string instead of an SV.

    1. boolsv_does_pv(SV* sv, const char *const name,
      2.  
    2.    U32 flags)
      3.
  • sv_does_pvn

    Like sv_does_sv, but takes a string/length pair instead of an SV.

    1. boolsv_does_pvn(SV* sv, const char *const name,
      2.  
    2.  const STRLEN len, U32 flags)
      3.
  • sv_does_sv

    Returns a boolean indicating whether the SV performs a specific, named role.The SV can be a Perl object or the name of a Perl class.

    1. boolsv_does_sv(SV* sv, SV* namesv, U32 flags)
      2.
  • sv_report_used

    Dump the contents of all SVs not yet freed (debugging aid).

    1. voidsv_report_used()
      2.
  • sv_setsv_nomg

    Like sv_setsv but doesn't process magic.

    1. voidsv_setsv_nomg(SV* dsv, SV* ssv)
      2.
  • sv_utf8_upgrade_nomg

    Like sv_utf8_upgrade, but doesn't do magic on sv.

    1. STRLENsv_utf8_upgrade_nomg(NN SV *sv)
      2.

SV-Body Allocation

  • looks_like_number

    Test if the content of an SV looks like a number (or is a number).Inf and Infinity are treated as numbers (so will not issue anon-numeric warning), even if your atof() doesn't grok them. Get-magic isignored.

    1. I32looks_like_number(SV *const sv)
      2.
  • newRV_noinc

    Creates an RV wrapper for an SV. The reference count for the originalSV is not incremented.

    1. SV*newRV_noinc(SV *const sv)
      2.
  • newSV

    Creates a new SV. A non-zero len parameter indicates the number ofbytes of preallocated string space the SV should have. An extra byte for atrailing NUL is also reserved. (SvPOK is not set for the SV even if stringspace is allocated.) The reference count for the new SV is set to 1.

    In 5.9.3, newSV() replaces the older NEWSV() API, and drops the firstparameter, x, a debug aid which allowed callers to identify themselves.This aid has been superseded by a new build option, PERL_MEM_LOG (seePERL_MEM_LOG in perlhacktips). The older API is still there for use in XSmodules supporting older perls.

    1. SV*newSV(const STRLEN len)
      2.
  • newSVhek

    Creates a new SV from the hash key structure. It will generate scalars thatpoint to the shared string table where possible. Returns a new (undefined)SV if the hek is NULL.

    1. SV*newSVhek(const HEK *const hek)
      2.
  • newSViv

    Creates a new SV and copies an integer into it. The reference count for theSV is set to 1.

    1. SV*newSViv(const IV i)
      2.
  • newSVnv

    Creates a new SV and copies a floating point value into it.The reference count for the SV is set to 1.

    1. SV*newSVnv(const NV n)
      2.
  • newSVpv

    Creates a new SV and copies a string into it. The reference count for theSV is set to 1. If len is zero, Perl will compute the length usingstrlen(). For efficiency, consider using newSVpvn instead.

    1. SV*newSVpv(const char *const s, const STRLEN len)
      2.
  • newSVpvf

    Creates a new SV and initializes it with the string formatted likesprintf.

    1. SV*newSVpvf(const char *const pat, ...)
      2.
  • newSVpvn

    Creates a new SV and copies a buffer into it, which may contain NUL characters(\0) and other binary data. The reference count for the SV is set to 1.Note that if len is zero, Perl will create a zero length (Perl) string. Youare responsible for ensuring that the source buffer is at leastlen bytes long. If the buffer argument is NULL the new SV will beundefined.

    1. SV*newSVpvn(const char *const s, const STRLEN len)
      2.
  • newSVpvn_flags

    Creates a new SV and copies a string into it. The reference count for theSV is set to 1. Note that if len is zero, Perl will create a zero lengthstring. You are responsible for ensuring that the source string is at leastlen bytes long. If the s argument is NULL the new SV will be undefined.Currently the only flag bits accepted are SVf_UTF8 and SVs_TEMP.If SVs_TEMP is set, then sv_2mortal() is called on the result beforereturning. If SVf_UTF8 is set, sis considered to be in UTF-8 and theSVf_UTF8 flag will be set on the new SV.newSVpvn_utf8() is a convenience wrapper for this function, defined as

    1.  #define newSVpvn_utf8(s, len, u)\
      2.  
    2. newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
      3.  
    3.  
    4. SV*newSVpvn_flags(const char *const s,
      5.  
    5.       const STRLEN len,
      6.  
    6.       const U32 flags)
      7.
  • newSVpvn_share

    Creates a new SV with its SvPVX_const pointing to a shared string in the stringtable. If the string does not already exist in the table, it iscreated first. Turns on READONLY and FAKE. If the hash parameteris non-zero, that value is used; otherwise the hash is computed.The string's hash can later be retrieved from the SVwith the SvSHARED_HASH() macro. The idea here isthat as the string table is used for shared hash keys these strings will haveSvPVX_const == HeKEY and hash lookup will avoid string compare.

    1. SV*newSVpvn_share(const char* s, I32 len, U32 hash)
      2.
  • newSVpvs

    Like newSVpvn, but takes a literal string instead of a string/length pair.

    1. SV*newSVpvs(const char* s)
      2.
  • newSVpvs_flags

    Like newSVpvn_flags, but takes a literal string instead of a string/lengthpair.

    1. SV*newSVpvs_flags(const char* s, U32 flags)
      2.
  • newSVpvs_share

    Like newSVpvn_share, but takes a literal string instead of a string/lengthpair and omits the hash parameter.

    1. SV*newSVpvs_share(const char* s)
      2.
  • newSVpv_share

    Like newSVpvn_share, but takes a nul-terminated string instead of astring/length pair.

    1. SV*newSVpv_share(const char* s, U32 hash)
      2.
  • newSVrv

    Creates a new SV for the RV, rv, to point to. If rv is not an RV thenit will be upgraded to one. If classname is non-null then the new SV willbe blessed in the specified package. The new SV is returned and itsreference count is 1.

    1. SV*newSVrv(SV *const rv,
      2.  
    2.  const char *const classname)
      3.
  • newSVsv

    Creates a new SV which is an exact duplicate of the original SV.(Uses sv_setsv.)

    1. SV*newSVsv(SV *const old)
      2.
  • newSVuv

    Creates a new SV and copies an unsigned integer into it.The reference count for the SV is set to 1.

    1. SV*newSVuv(const UV u)
      2.
  • newSV_type

    Creates a new SV, of the type specified. The reference count for the new SVis set to 1.

    1. SV*newSV_type(const svtype type)
      2.
  • sv_2bool

    This macro is only used by sv_true() or its macro equivalent, and only ifthe latter's argument is neither SvPOK, SvIOK nor SvNOK.It calls sv_2bool_flags with the SV_GMAGIC flag.

    1. boolsv_2bool(SV *const sv)
      2.
  • sv_2bool_flags

    This function is only used by sv_true() and friends, and only ifthe latter's argument is neither SvPOK, SvIOK nor SvNOK. If the flagscontain SV_GMAGIC, then it does an mg_get() first.

    1. boolsv_2bool_flags(SV *const sv, const I32 flags)
      2.
  • sv_2cv

    Using various gambits, try to get a CV from an SV; in addition, try ifpossible to set *st and *gvp to the stash and GV associated with it.The flags in lref are passed to gv_fetchsv.

    1. CV*sv_2cv(SV* sv, HV **const st, GV **const gvp,
      2.  
    2.    const I32 lref)
      3.
  • sv_2io

    Using various gambits, try to get an IO from an SV: the IO slot if its aGV; or the recursive result if we're an RV; or the IO slot of the symbolnamed after the PV if we're a string.

    'Get' magic is ignored on the sv passed in, but will be called onSvRV(sv) if sv is an RV.

    1. IO*sv_2io(SV *const sv)
      2.
  • sv_2iv_flags

    Return the integer value of an SV, doing any necessary stringconversion. If flags includes SV_GMAGIC, does an mg_get() first.Normally used via the SvIV(sv) and SvIVx(sv) macros.

    1. IVsv_2iv_flags(SV *const sv, const I32 flags)
      2.
  • sv_2mortal

    Marks an existing SV as mortal. The SV will be destroyed "soon", eitherby an explicit call to FREETMPS, or by an implicit call at places such asstatement boundaries. SvTEMP() is turned on which means that the SV'sstring buffer can be "stolen" if this SV is copied. See also sv_newmortaland sv_mortalcopy.

    1. SV*sv_2mortal(SV *const sv)
      2.
  • sv_2nv_flags

    Return the num value of an SV, doing any necessary string or integerconversion. If flags includes SV_GMAGIC, does an mg_get() first.Normally used via the SvNV(sv) and SvNVx(sv) macros.

    1. NVsv_2nv_flags(SV *const sv, const I32 flags)
      2.
  • sv_2pvbyte

    Return a pointer to the byte-encoded representation of the SV, and set *lpto its length. May cause the SV to be downgraded from UTF-8 as aside-effect.

    Usually accessed via the SvPVbyte macro.

    1. char*sv_2pvbyte(SV *sv, STRLEN *const lp)
      2.
  • sv_2pvutf8

    Return a pointer to the UTF-8-encoded representation of the SV, and set *lpto its length. May cause the SV to be upgraded to UTF-8 as a side-effect.

    Usually accessed via the SvPVutf8 macro.

    1. char*sv_2pvutf8(SV *sv, STRLEN *const lp)
      2.
  • sv_2pv_flags

    Returns a pointer to the string value of an SV, and sets *lp to its length.If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to astring if necessary. Normally invoked via the SvPV_flags macro.sv_2pv() and sv_2pv_nomg usually end up here too.

    1. char*sv_2pv_flags(SV *const sv, STRLEN *const lp,
      2.  
    2.  const I32 flags)
      3.
  • sv_2uv_flags

    Return the unsigned integer value of an SV, doing any necessary stringconversion. If flags includes SV_GMAGIC, does an mg_get() first.Normally used via the SvUV(sv) and SvUVx(sv) macros.

    1. UVsv_2uv_flags(SV *const sv, const I32 flags)
      2.
  • sv_backoff

    Remove any string offset. You should normally use the SvOOK_off macrowrapper instead.

    1. intsv_backoff(SV *const sv)
      2.
  • sv_bless

    Blesses an SV into a specified package. The SV must be an RV. The packagemust be designated by its stash (see gv_stashpv()). The reference countof the SV is unaffected.

    1. SV*sv_bless(SV *const sv, HV *const stash)
      2.
  • sv_catpv

    Concatenates the string onto the end of the string which is in the SV.If the SV has the UTF-8 status set, then the bytes appended should bevalid UTF-8. Handles 'get' magic, but not 'set' magic. See sv_catpv_mg.

    1. voidsv_catpv(SV *const sv, const char* ptr)
      2.
  • sv_catpvf

    Processes its arguments like sprintf and appends the formattedoutput to an SV. If the appended data contains "wide" characters(including, but not limited to, SVs with a UTF-8 PV formatted with %s,and characters >255 formatted with %c), the original SV might getupgraded to UTF-8. Handles 'get' magic, but not 'set' magic. Seesv_catpvf_mg. If the original SV was UTF-8, the pattern should bevalid UTF-8; if the original SV was bytes, the pattern should be too.

    1. voidsv_catpvf(SV *const sv, const char *const pat,
      2.  
    2.   ...)
      3.
  • sv_catpvf_mg

    Like sv_catpvf, but also handles 'set' magic.

    1. voidsv_catpvf_mg(SV *const sv,
      2.  
    2.  const char *const pat, ...)
      3.
  • sv_catpvn

    Concatenates the string onto the end of the string which is in the SV. Thelen indicates number of bytes to copy. If the SV has the UTF-8status set, then the bytes appended should be valid UTF-8.Handles 'get' magic, but not 'set' magic. See sv_catpvn_mg.

    1. voidsv_catpvn(SV *dsv, const char *sstr, STRLEN len)
      2.
  • sv_catpvn_flags

    Concatenates the string onto the end of the string which is in the SV. Thelen indicates number of bytes to copy. If the SV has the UTF-8status set, then the bytes appended should be valid UTF-8.If flags has the SV_SMAGIC bit set, willmg_set on dsv afterwards if appropriate.sv_catpvn and sv_catpvn_nomg are implementedin terms of this function.

    1. voidsv_catpvn_flags(SV *const dstr,
      2.  
    2.  const char *sstr,
      3.  
    3.  const STRLEN len,
      4.  
    4.  const I32 flags)
      5.
  • sv_catpvs

    Like sv_catpvn, but takes a literal string instead of a string/length pair.

    1. voidsv_catpvs(SV* sv, const char* s)
      2.
  • sv_catpvs_flags

    Like sv_catpvn_flags, but takes a literal string instead of astring/length pair.

    1. voidsv_catpvs_flags(SV* sv, const char* s,
      2.  
    2.   I32 flags)
      3.
  • sv_catpvs_mg

    Like sv_catpvn_mg, but takes a literal string instead of astring/length pair.

    1. voidsv_catpvs_mg(SV* sv, const char* s)
      2.
  • sv_catpvs_nomg

    Like sv_catpvn_nomg, but takes a literal string instead of astring/length pair.

    1. voidsv_catpvs_nomg(SV* sv, const char* s)
      2.
  • sv_catpv_flags

    Concatenates the string onto the end of the string which is in the SV.If the SV has the UTF-8 status set, then the bytes appended shouldbe valid UTF-8. If flags has the SV_SMAGIC bit set, will mg_seton the modified SV if appropriate.

    1. voidsv_catpv_flags(SV *dstr, const char *sstr,
      2.  
    2.    const I32 flags)
      3.
  • sv_catpv_mg

    Like sv_catpv, but also handles 'set' magic.

    1. voidsv_catpv_mg(SV *const sv, const char *const ptr)
      2.
  • sv_catsv

    Concatenates the string from SV ssv onto the end of the string inSV dsv. Modifies dsv but not ssv. Handles 'get' magic, butnot 'set' magic. See sv_catsv_mg.

    1. voidsv_catsv(SV *dstr, SV *sstr)
      2.
  • sv_catsv_flags

    Concatenates the string from SV ssv onto the end of the string inSV dsv. Modifies dsv but not ssv. If flags has SV_GMAGICbit set, will mg_get on the ssv, if appropriate, beforereading it. If the flags contain SV_SMAGIC, mg_set will becalled on the modified SV afterward, if appropriate. sv_catsvand sv_catsv_nomg are implemented in terms of this function.

    1. voidsv_catsv_flags(SV *const dsv, SV *const ssv,
      2.  
    2.    const I32 flags)
      3.
  • sv_chop

    Efficient removal of characters from the beginning of the string buffer.SvPOK(sv) must be true and the ptr must be a pointer to somewhere insidethe string buffer. The ptr becomes the first character of the adjustedstring. Uses the "OOK hack".

    Beware: after this function returns, ptr and SvPVX_const(sv) may no longerrefer to the same chunk of data.

    The unfortunate similarity of this function's name to that of Perl's chopoperator is strictly coincidental. This function works from the left;chop works from the right.

    1. voidsv_chop(SV *const sv, const char *const ptr)
      2.
  • sv_clear

    Clear an SV: call any destructors, free up any memory used by the body,and free the body itself. The SV's head is not freed, althoughits type is set to all 1's so that it won't inadvertently be assumedto be live during global destruction etc.This function should only be called when REFCNT is zero. Most of the timeyou'll want to call sv_free() (or its macro wrapper SvREFCNT_dec)instead.

    1. voidsv_clear(SV *const orig_sv)
      2.
  • sv_cmp

    Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether thestring in sv1 is less than, equal to, or greater than the string insv2. Is UTF-8 and 'use bytes' aware, handles get magic, and willcoerce its args to strings if necessary. See also sv_cmp_locale.

    1. I32sv_cmp(SV *const sv1, SV *const sv2)
      2.
  • sv_cmp_flags

    Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether thestring in sv1 is less than, equal to, or greater than the string insv2. Is UTF-8 and 'use bytes' aware and will coerce its args to stringsif necessary. If the flags include SV_GMAGIC, it handles get magic. Seealso sv_cmp_locale_flags.

    1. I32sv_cmp_flags(SV *const sv1, SV *const sv2,
      2.  
    2.  const U32 flags)
      3.
  • sv_cmp_locale

    Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and'use bytes' aware, handles get magic, and will coerce its args to stringsif necessary. See also sv_cmp.

    1. I32sv_cmp_locale(SV *const sv1, SV *const sv2)
      2.
  • sv_cmp_locale_flags

    Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and'use bytes' aware and will coerce its args to strings if necessary. If theflags contain SV_GMAGIC, it handles get magic. See also sv_cmp_flags.

    1. I32sv_cmp_locale_flags(SV *const sv1,
      2.  
    2.  SV *const sv2,
      3.  
    3.  const U32 flags)
      4.
  • sv_collxfrm

    This calls sv_collxfrm_flags with the SV_GMAGIC flag. Seesv_collxfrm_flags.

    1. char*sv_collxfrm(SV *const sv, STRLEN *const nxp)
      2.
  • sv_collxfrm_flags

    Add Collate Transform magic to an SV if it doesn't already have it. If theflags contain SV_GMAGIC, it handles get-magic.

    Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains thescalar data of the variable, but transformed to such a format that a normalmemory comparison can be used to compare the data according to the localesettings.

    1. char*sv_collxfrm_flags(SV *const sv,
      2.  
    2.   STRLEN *const nxp,
      3.  
    3.   I32 const flags)
      4.
  • sv_copypv

    Copies a stringified representation of the source SV into thedestination SV. Automatically performs any necessary mg_get andcoercion of numeric values into strings. Guaranteed to preserveUTF8 flag even from overloaded objects. Similar in nature tosv_2pv[_flags] but operates directly on an SV instead of just thestring. Mostly uses sv_2pv_flags to do its work, except when thatwould lose the UTF-8'ness of the PV.

    1. voidsv_copypv(SV *const dsv, SV *const ssv)
      2.
  • sv_dec

    Auto-decrement of the value in the SV, doing string to numeric conversionif necessary. Handles 'get' magic and operator overloading.

    1. voidsv_dec(SV *const sv)
      2.
  • sv_dec_nomg

    Auto-decrement of the value in the SV, doing string to numeric conversionif necessary. Handles operator overloading. Skips handling 'get' magic.

    1. voidsv_dec_nomg(SV *const sv)
      2.
  • sv_eq

    Returns a boolean indicating whether the strings in the two SVs areidentical. Is UTF-8 and 'use bytes' aware, handles get magic, and willcoerce its args to strings if necessary.

    1. I32sv_eq(SV* sv1, SV* sv2)
      2.
  • sv_eq_flags

    Returns a boolean indicating whether the strings in the two SVs areidentical. Is UTF-8 and 'use bytes' aware and coerces its args to stringsif necessary. If the flags include SV_GMAGIC, it handles get-magic, too.

    1. I32sv_eq_flags(SV* sv1, SV* sv2, const U32 flags)
      2.
  • sv_force_normal_flags

    Undo various types of fakery on an SV: if the PV is a shared string, makea private copy; if we're a ref, stop refing; if we're a glob, downgrade toan xpvmg; if we're a copy-on-write scalar, this is the on-write time whenwe do the copy, and is also used locally. If SV_COW_DROP_PV is setthen a copy-on-write scalar drops its PV buffer (if any) and becomesSvPOK_off rather than making a copy. (Used where thisscalar is about to be set to some other value.) In addition,the flags parameter gets passed to sv_unref_flags()when unreffing. sv_force_normal calls this functionwith flags set to 0.

    1. voidsv_force_normal_flags(SV *const sv,
      2.  
    2.   const U32 flags)
      3.
  • sv_free

    Decrement an SV's reference count, and if it drops to zero, callsv_clear to invoke destructors and free up any memory used bythe body; finally, deallocate the SV's head itself.Normally called via a wrapper macro SvREFCNT_dec.

    1. voidsv_free(SV *const sv)
      2.
  • sv_gets

    Get a line from the filehandle and store it into the SV, optionallyappending to the currently-stored string.

    1. char*sv_gets(SV *const sv, PerlIO *const fp,
      2.  
    2.  I32 append)
      3.
  • sv_grow

    Expands the character buffer in the SV. If necessary, uses sv_unref andupgrades the SV to SVt_PV. Returns a pointer to the character buffer.Use the SvGROW wrapper instead.

    1. char*sv_grow(SV *const sv, STRLEN newlen)
      2.
  • sv_inc

    Auto-increment of the value in the SV, doing string to numeric conversionif necessary. Handles 'get' magic and operator overloading.

    1. voidsv_inc(SV *const sv)
      2.
  • sv_inc_nomg

    Auto-increment of the value in the SV, doing string to numeric conversionif necessary. Handles operator overloading. Skips handling 'get' magic.

    1. voidsv_inc_nomg(SV *const sv)
      2.
  • sv_insert

    Inserts a string at the specified offset/length within the SV. Similar tothe Perl substr() function. Handles get magic.

    1. voidsv_insert(SV *const bigstr, const STRLEN offset,
      2.  
    2.   const STRLEN len,
      3.  
    3.   const char *const little,
      4.  
    4.   const STRLEN littlelen)
      5.
  • sv_insert_flags

    Same as sv_insert, but the extra flags are passed to theSvPV_force_flags that applies to bigstr.

    1. voidsv_insert_flags(SV *const bigstr,
      2.  
    2.  const STRLEN offset,
      3.  
    3.  const STRLEN len,
      4.  
    4.  const char *const little,
      5.  
    5.  const STRLEN littlelen,
      6.  
    6.  const U32 flags)
      7.
  • sv_isa

    Returns a boolean indicating whether the SV is blessed into the specifiedclass. This does not check for subtypes; use sv_derived_from to verifyan inheritance relationship.

    1. intsv_isa(SV* sv, const char *const name)
      2.
  • sv_isobject

    Returns a boolean indicating whether the SV is an RV pointing to a blessedobject. If the SV is not an RV, or if the object is not blessed, then thiswill return false.

    1. intsv_isobject(SV* sv)
      2.
  • sv_len

    Returns the length of the string in the SV. Handles magic and typecoercion. See also SvCUR, which gives raw access to the xpv_cur slot.

    1. STRLENsv_len(SV *const sv)
      2.
  • sv_len_utf8

    Returns the number of characters in the string in an SV, counting wideUTF-8 bytes as a single character. Handles magic and type coercion.

    1. STRLENsv_len_utf8(SV *const sv)
      2.
  • sv_magic

    Adds magic to an SV. First upgrades sv to type SVt_PVMG ifnecessary, then adds a new magic item of type how to the head of themagic list.

    See sv_magicext (which sv_magic now calls) for a description of thehandling of the name and namlen arguments.

    You need to use sv_magicext to add magic to SvREADONLY SVs and alsoto add more than one instance of the same 'how'.

    1. voidsv_magic(SV *const sv, SV *const obj,
      2.  
    2.  const int how, const char *const name,
      3.  
    3.  const I32 namlen)
      4.
  • sv_magicext

    Adds magic to an SV, upgrading it if necessary. Applies thesupplied vtable and returns a pointer to the magic added.

    Note that sv_magicext will allow things that sv_magic will not.In particular, you can add magic to SvREADONLY SVs, and add more thanone instance of the same 'how'.

    If namlen is greater than zero then a savepvn copy of name isstored, if namlen is zero then name is stored as-is and - as anotherspecial case - if (name && namlen == HEf_SVKEY) then name is assumedto contain an SV* and is stored as-is with its REFCNT incremented.

    (This is now used as a subroutine by sv_magic.)

    1. MAGIC *sv_magicext(SV *const sv, SV *const obj,
      2.  
    2.  const int how,
      3.  
    3.  const MGVTBL *const vtbl,
      4.  
    4.  const char *const name,
      5.  
    5.  const I32 namlen)
      6.
  • sv_mortalcopy

    Creates a new SV which is a copy of the original SV (using sv_setsv).The new SV is marked as mortal. It will be destroyed "soon", either by anexplicit call to FREETMPS, or by an implicit call at places such asstatement boundaries. See also sv_newmortal and sv_2mortal.

    1. SV*sv_mortalcopy(SV *const oldsv)
      2.
  • sv_newmortal

    Creates a new null SV which is mortal. The reference count of the SV isset to 1. It will be destroyed "soon", either by an explicit call toFREETMPS, or by an implicit call at places such as statement boundaries.See also sv_mortalcopy and sv_2mortal.

    1. SV*sv_newmortal()
      2.
  • sv_newref

    Increment an SV's reference count. Use the SvREFCNT_inc() wrapperinstead.

    1. SV*sv_newref(SV *const sv)
      2.
  • sv_pos_b2u

    Converts the value pointed to by offsetp from a count of bytes from thestart of the string, to a count of the equivalent number of UTF-8 chars.Handles magic and type coercion.

    1. voidsv_pos_b2u(SV *const sv, I32 *const offsetp)
      2.
  • sv_pos_u2b

    Converts the value pointed to by offsetp from a count of UTF-8 chars fromthe start of the string, to a count of the equivalent number of bytes; iflenp is non-zero, it does the same to lenp, but this time starting fromthe offset, rather than from the start of the string. Handles magic andtype coercion.

    Use sv_pos_u2b_flags in preference, which correctly handles strings longerthan 2Gb.

    1. voidsv_pos_u2b(SV *const sv, I32 *const offsetp,
      2.  
    2.    I32 *const lenp)
      3.
  • sv_pos_u2b_flags

    Converts the value pointed to by offsetp from a count of UTF-8 chars fromthe start of the string, to a count of the equivalent number of bytes; iflenp is non-zero, it does the same to lenp, but this time starting fromthe offset, rather than from the startof the string. Handles type coercion.flags is passed to SvPV_flags, and usually should beSV_GMAGIC|SV_CONST_RETURN to handle magic.

    1. STRLENsv_pos_u2b_flags(SV *const sv, STRLEN uoffset,
      2.  
    2.  STRLEN *const lenp, U32 flags)
      3.
  • sv_pvbyten_force

    The backend for the SvPVbytex_force macro. Always use the macroinstead.

    1. char*sv_pvbyten_force(SV *const sv, STRLEN *const lp)
      2.
  • sv_pvn_force

    Get a sensible string out of the SV somehow.A private implementation of the SvPV_force macro for compilers whichcan't cope with complex macro expressions. Always use the macro instead.

    1. char*sv_pvn_force(SV* sv, STRLEN* lp)
      2.
  • sv_pvn_force_flags

    Get a sensible string out of the SV somehow.If flags has SV_GMAGIC bit set, will mg_get on sv ifappropriate, else not. sv_pvn_force and sv_pvn_force_nomg areimplemented in terms of this function.You normally want to use the various wrapper macros instead: seeSvPV_force and SvPV_force_nomg

    1. char*sv_pvn_force_flags(SV *const sv,
      2.  
    2.    STRLEN *const lp,
      3.  
    3.    const I32 flags)
      4.
  • sv_pvutf8n_force

    The backend for the SvPVutf8x_force macro. Always use the macroinstead.

    1. char*sv_pvutf8n_force(SV *const sv, STRLEN *const lp)
      2.
  • sv_reftype

    Returns a string describing what the SV is a reference to.

    1. const char* sv_reftype(const SV *const sv, const int ob)
      2.
  • sv_replace

    Make the first argument a copy of the second, then delete the original.The target SV physically takes over ownership of the body of the source SVand inherits its flags; however, the target keeps any magic it owns,and any magic in the source is discarded.Note that this is a rather specialist SV copying operation; most of thetime you'll want to use sv_setsv or one of its many macro front-ends.

    1. voidsv_replace(SV *const sv, SV *const nsv)
      2.
  • sv_reset

    Underlying implementation for the reset Perl function.Note that the perl-level function is vaguely deprecated.

    1. voidsv_reset(const char* s, HV *const stash)
      2.
  • sv_rvweaken

    Weaken a reference: set the SvWEAKREF flag on this RV; give thereferred-to SV PERL_MAGIC_backref magic if it hasn't already; andpush a back-reference to this RV onto the array of backreferencesassociated with that magic. If the RV is magical, set magic will becalled after the RV is cleared.

    1. SV*sv_rvweaken(SV *const sv)
      2.
  • sv_setiv

    Copies an integer into the given SV, upgrading first if necessary.Does not handle 'set' magic. See also sv_setiv_mg.

    1. voidsv_setiv(SV *const sv, const IV num)
      2.
  • sv_setiv_mg

    Like sv_setiv, but also handles 'set' magic.

    1. voidsv_setiv_mg(SV *const sv, const IV i)
      2.
  • sv_setnv

    Copies a double into the given SV, upgrading first if necessary.Does not handle 'set' magic. See also sv_setnv_mg.

    1. voidsv_setnv(SV *const sv, const NV num)
      2.
  • sv_setnv_mg

    Like sv_setnv, but also handles 'set' magic.

    1. voidsv_setnv_mg(SV *const sv, const NV num)
      2.
  • sv_setpv

    Copies a string into an SV. The string must be null-terminated. Does nothandle 'set' magic. See sv_setpv_mg.

    1. voidsv_setpv(SV *const sv, const char *const ptr)
      2.
  • sv_setpvf

    Works like sv_catpvf but copies the text into the SV instead ofappending it. Does not handle 'set' magic. See sv_setpvf_mg.

    1. voidsv_setpvf(SV *const sv, const char *const pat,
      2.  
    2.   ...)
      3.
  • sv_setpvf_mg

    Like sv_setpvf, but also handles 'set' magic.

    1. voidsv_setpvf_mg(SV *const sv,
      2.  
    2.  const char *const pat, ...)
      3.
  • sv_setpviv

    Copies an integer into the given SV, also updating its string value.Does not handle 'set' magic. See sv_setpviv_mg.

    1. voidsv_setpviv(SV *const sv, const IV num)
      2.
  • sv_setpviv_mg

    Like sv_setpviv, but also handles 'set' magic.

    1. voidsv_setpviv_mg(SV *const sv, const IV iv)
      2.
  • sv_setpvn

    Copies a string into an SV. The len parameter indicates the number ofbytes to be copied. If the ptr argument is NULL the SV will becomeundefined. Does not handle 'set' magic. See sv_setpvn_mg.

    1. voidsv_setpvn(SV *const sv, const char *const ptr,
      2.  
    2.   const STRLEN len)
      3.
  • sv_setpvn_mg

    Like sv_setpvn, but also handles 'set' magic.

    1. voidsv_setpvn_mg(SV *const sv,
      2.  
    2.  const char *const ptr,
      3.  
    3.  const STRLEN len)
      4.
  • sv_setpvs

    Like sv_setpvn, but takes a literal string instead of a string/length pair.

    1. voidsv_setpvs(SV* sv, const char* s)
      2.
  • sv_setpvs_mg

    Like sv_setpvn_mg, but takes a literal string instead of astring/length pair.

    1. voidsv_setpvs_mg(SV* sv, const char* s)
      2.
  • sv_setpv_mg

    Like sv_setpv, but also handles 'set' magic.

    1. voidsv_setpv_mg(SV *const sv, const char *const ptr)
      2.
  • sv_setref_iv

    Copies an integer into a new SV, optionally blessing the SV. The rvargument will be upgraded to an RV. That RV will be modified to point tothe new SV. The classname argument indicates the package for theblessing. Set classname to NULL to avoid the blessing. The new SVwill have a reference count of 1, and the RV will be returned.

    1. SV*sv_setref_iv(SV *const rv,
      2.  
    2.  const char *const classname,
      3.  
    3.  const IV iv)
      4.
  • sv_setref_nv

    Copies a double into a new SV, optionally blessing the SV. The rvargument will be upgraded to an RV. That RV will be modified to point tothe new SV. The classname argument indicates the package for theblessing. Set classname to NULL to avoid the blessing. The new SVwill have a reference count of 1, and the RV will be returned.

    1. SV*sv_setref_nv(SV *const rv,
      2.  
    2.  const char *const classname,
      3.  
    3.  const NV nv)
      4.
  • sv_setref_pv

    Copies a pointer into a new SV, optionally blessing the SV. The rvargument will be upgraded to an RV. That RV will be modified to point tothe new SV. If the pv argument is NULL then PL_sv_undef will be placedinto the SV. The classname argument indicates the package for theblessing. Set classname to NULL to avoid the blessing. The new SVwill have a reference count of 1, and the RV will be returned.

    Do not use with other Perl types such as HV, AV, SV, CV, because thoseobjects will become corrupted by the pointer copy process.

    Note that sv_setref_pvn copies the string while this copies the pointer.

    1. SV*sv_setref_pv(SV *const rv,
      2.  
    2.  const char *const classname,
      3.  
    3.  void *const pv)
      4.
  • sv_setref_pvn

    Copies a string into a new SV, optionally blessing the SV. The length of thestring must be specified with n. The rv argument will be upgraded toan RV. That RV will be modified to point to the new SV. The classnameargument indicates the package for the blessing. Set classname toNULL to avoid the blessing. The new SV will have a reference countof 1, and the RV will be returned.

    Note that sv_setref_pv copies the pointer while this copies the string.

    1. SV*sv_setref_pvn(SV *const rv,
      2.  
    2.   const char *const classname,
      3.  
    3.   const char *const pv,
      4.  
    4.   const STRLEN n)
      5.
  • sv_setref_pvs

    Like sv_setref_pvn, but takes a literal string instead of astring/length pair.

    1. SV *sv_setref_pvs(const char* s)
      2.
  • sv_setref_uv

    Copies an unsigned integer into a new SV, optionally blessing the SV. The rvargument will be upgraded to an RV. That RV will be modified to point tothe new SV. The classname argument indicates the package for theblessing. Set classname to NULL to avoid the blessing. The new SVwill have a reference count of 1, and the RV will be returned.

    1. SV*sv_setref_uv(SV *const rv,
      2.  
    2.  const char *const classname,
      3.  
    3.  const UV uv)
      4.
  • sv_setsv

    Copies the contents of the source SV ssv into the destination SVdsv. The source SV may be destroyed if it is mortal, so don't use thisfunction if the source SV needs to be reused. Does not handle 'set' magic.Loosely speaking, it performs a copy-by-value, obliterating any previouscontent of the destination.

    You probably want to use one of the assortment of wrappers, such asSvSetSV, SvSetSV_nosteal, SvSetMagicSV andSvSetMagicSV_nosteal.

    1. voidsv_setsv(SV *dstr, SV *sstr)
      2.
  • sv_setsv_flags

    Copies the contents of the source SV ssv into the destination SVdsv. The source SV may be destroyed if it is mortal, so don't use thisfunction if the source SV needs to be reused. Does not handle 'set' magic.Loosely speaking, it performs a copy-by-value, obliterating any previouscontent of the destination.If the flags parameter has the SV_GMAGIC bit set, will mg_get onssv if appropriate, else not. If the flagsparameter has the NOSTEAL bit set then thebuffers of temps will not be stolen. <sv_setsv>and sv_setsv_nomg are implemented in terms of this function.

    You probably want to use one of the assortment of wrappers, such asSvSetSV, SvSetSV_nosteal, SvSetMagicSV andSvSetMagicSV_nosteal.

    This is the primary function for copying scalars, and most othercopy-ish functions and macros use this underneath.

    1. voidsv_setsv_flags(SV *dstr, SV *sstr,
      2.  
    2.    const I32 flags)
      3.
  • sv_setsv_mg

    Like sv_setsv, but also handles 'set' magic.

    1. voidsv_setsv_mg(SV *const dstr, SV *const sstr)
      2.
  • sv_setuv

    Copies an unsigned integer into the given SV, upgrading first if necessary.Does not handle 'set' magic. See also sv_setuv_mg.

    1. voidsv_setuv(SV *const sv, const UV num)
      2.
  • sv_setuv_mg

    Like sv_setuv, but also handles 'set' magic.

    1. voidsv_setuv_mg(SV *const sv, const UV u)
      2.
  • sv_tainted

    Test an SV for taintedness. Use SvTAINTED instead.

    1. boolsv_tainted(SV *const sv)
      2.
  • sv_true

    Returns true if the SV has a true value by Perl's rules.Use the SvTRUE macro instead, which may call sv_true() or mayinstead use an in-line version.

    1. I32sv_true(SV *const sv)
      2.
  • sv_unmagic

    Removes all magic of type type from an SV.

    1. intsv_unmagic(SV *const sv, const int type)
      2.
  • sv_unmagicext

    Removes all magic of type type with the specified vtbl from an SV.

    1. intsv_unmagicext(SV *const sv, const int type,
      2.  
    2.   MGVTBL *vtbl)
      3.
  • sv_unref_flags

    Unsets the RV status of the SV, and decrements the reference count ofwhatever was being referenced by the RV. This can almost be thought ofas a reversal of newSVrv. The cflags argument can containSV_IMMEDIATE_UNREF to force the reference count to be decremented(otherwise the decrementing is conditional on the reference count beingdifferent from one or the reference being a readonly SV).See SvROK_off.

    1. voidsv_unref_flags(SV *const ref, const U32 flags)
      2.
  • sv_untaint

    Untaint an SV. Use SvTAINTED_off instead.

    1. voidsv_untaint(SV *const sv)
      2.
  • sv_upgrade

    Upgrade an SV to a more complex form. Generally adds a new body type to theSV, then copies across as much information as possible from the old body.It croaks if the SV is already in a more complex form than requested. Yougenerally want to use the SvUPGRADE macro wrapper, which checks the typebefore calling sv_upgrade, and hence does not croak. See alsosvtype.

    1. voidsv_upgrade(SV *const sv, svtype new_type)
      2.
  • sv_usepvn_flags

    Tells an SV to use ptr to find its string value. Normally thestring is stored inside the SV but sv_usepvn allows the SV to use anoutside string. The ptr should point to memory that was allocatedby malloc. It must be the start of a mallocked blockof memory, and not a pointer to the middle of it. Thestring length, len, must be supplied. By defaultthis function will realloc (i.e. move) the memory pointed to by ptr,so that pointer should not be freed or used by the programmer aftergiving it to sv_usepvn, and neither should any pointers from "behind"that pointer (e.g. ptr + 1) be used.

    If flags & SV_SMAGIC is true, will call SvSETMAGIC. If flags &SV_HAS_TRAILING_NUL is true, then ptr[len] must be NUL, and the reallocwill be skipped (i.e. the buffer is actually at least 1 byte longer thanlen, and already meets the requirements for storing in SvPVX).

    1. voidsv_usepvn_flags(SV *const sv, char* ptr,
      2.  
    2.  const STRLEN len,
      3.  
    3.  const U32 flags)
      4.
  • sv_utf8_decode

    If the PV of the SV is an octet sequence in UTF-8and contains a multiple-byte character, the SvUTF8 flag is turned onso that it looks like a character. If the PV contains only single-bytecharacters, the SvUTF8 flag stays off.Scans PV for validity and returns false if the PV is invalid UTF-8.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. boolsv_utf8_decode(SV *const sv)
      2.
  • sv_utf8_downgrade

    Attempts to convert the PV of an SV from characters to bytes.If the PV contains a character that cannot fitin a byte, this conversion will fail;in this case, either returns false or, if fail_ok is nottrue, croaks.

    This is not as a general purpose Unicode to byte encoding interface:use the Encode extension for that.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. boolsv_utf8_downgrade(SV *const sv,
      2.  
    2.   const bool fail_ok)
      3.
  • sv_utf8_encode

    Converts the PV of an SV to UTF-8, but then turns the SvUTF8flag off so that it looks like octets again.

    1. voidsv_utf8_encode(SV *const sv)
      2.
  • sv_utf8_upgrade

    Converts the PV of an SV to its UTF-8-encoded form.Forces the SV to string form if it is not already.Will mg_get on sv if appropriate.Always sets the SvUTF8 flag to avoid future validity checks evenif the whole string is the same in UTF-8 as not.Returns the number of bytes in the converted string

    This is not as a general purpose byte encoding to Unicode interface:use the Encode extension for that.

    1. STRLENsv_utf8_upgrade(SV *sv)
      2.
  • sv_utf8_upgrade_flags

    Converts the PV of an SV to its UTF-8-encoded form.Forces the SV to string form if it is not already.Always sets the SvUTF8 flag to avoid future validity checks evenif all the bytes are invariant in UTF-8.If flags has SV_GMAGIC bit set,will mg_get on sv if appropriate, else not.Returns the number of bytes in the converted stringsv_utf8_upgrade andsv_utf8_upgrade_nomg are implemented in terms of this function.

    This is not as a general purpose byte encoding to Unicode interface:use the Encode extension for that.

    1. STRLENsv_utf8_upgrade_flags(SV *const sv,
      2.  
    2.   const I32 flags)
      3.
  • sv_utf8_upgrade_nomg

    Like sv_utf8_upgrade, but doesn't do magic on sv.

    1. STRLENsv_utf8_upgrade_nomg(SV *sv)
      2.
  • sv_vcatpvf

    Processes its arguments like vsprintf and appends the formatted outputto an SV. Does not handle 'set' magic. See sv_vcatpvf_mg.

    Usually used via its frontend sv_catpvf.

    1. voidsv_vcatpvf(SV *const sv, const char *const pat,
      2.  
    2.    va_list *const args)
      3.
  • sv_vcatpvfn

    Processes its arguments like vsprintf and appends the formatted outputto an SV. Uses an array of SVs if the C style variable argument list ismissing (NULL). When running with taint checks enabled, indicates viamaybe_tainted if results are untrustworthy (often due to the use oflocales).

    Usually used via one of its frontends sv_vcatpvf and sv_vcatpvf_mg.

    1. voidsv_vcatpvfn(SV *const sv, const char *const pat,
      2.  
    2.  const STRLEN patlen,
      3.  
    3.  va_list *const args,
      4.  
    4.  SV **const svargs, const I32 svmax,
      5.  
    5.  bool *const maybe_tainted)
      6.
  • sv_vcatpvf_mg

    Like sv_vcatpvf, but also handles 'set' magic.

    Usually used via its frontend sv_catpvf_mg.

    1. voidsv_vcatpvf_mg(SV *const sv,
      2.  
    2.   const char *const pat,
      3.  
    3.   va_list *const args)
      4.
  • sv_vsetpvf

    Works like sv_vcatpvf but copies the text into the SV instead ofappending it. Does not handle 'set' magic. See sv_vsetpvf_mg.

    Usually used via its frontend sv_setpvf.

    1. voidsv_vsetpvf(SV *const sv, const char *const pat,
      2.  
    2.    va_list *const args)
      3.
  • sv_vsetpvfn

    Works like sv_vcatpvfn but copies the text into the SV instead ofappending it.

    Usually used via one of its frontends sv_vsetpvf and sv_vsetpvf_mg.

    1. voidsv_vsetpvfn(SV *const sv, const char *const pat,
      2.  
    2.  const STRLEN patlen,
      3.  
    3.  va_list *const args,
      4.  
    4.  SV **const svargs, const I32 svmax,
      5.  
    5.  bool *const maybe_tainted)
      6.
  • sv_vsetpvf_mg

    Like sv_vsetpvf, but also handles 'set' magic.

    Usually used via its frontend sv_setpvf_mg.

    1. voidsv_vsetpvf_mg(SV *const sv,
      2.  
    2.   const char *const pat,
      3.  
    3.   va_list *const args)
      4.

Unicode Support

  • bytes_cmp_utf8

    Compares the sequence of characters (stored as octets) in b, blen with thesequence of characters (stored as UTF-8) in u, ulen. Returns 0 if they areequal, -1 or -2 if the first string is less than the second string, +1 or +2if the first string is greater than the second string.

    -1 or +1 is returned if the shorter string was identical to the start of thelonger string. -2 or +2 is returned if the was a difference between characterswithin the strings.

    1. intbytes_cmp_utf8(const U8 *b, STRLEN blen,
      2.  
    2.    const U8 *u, STRLEN ulen)
      3.
  • bytes_from_utf8

    Converts a string s of length len from UTF-8 into native byte encoding.Unlike utf8_to_bytes but like bytes_to_utf8, returns a pointer tothe newly-created string, and updates len to contain the newlength. Returns the original string if no conversion occurs, lenis unchanged. Do nothing if is_utf8 points to 0. Sets is_utf8 to0 if s is converted or consisted entirely of characters that are invariantin utf8 (i.e., US-ASCII on non-EBCDIC machines).

    NOTE: this function is experimental and may change or beremoved without notice.

    1. U8*bytes_from_utf8(const U8 *s, STRLEN *len,
      2.  
    2.   bool *is_utf8)
      3.
  • bytes_to_utf8

    Converts a string s of length len bytes from the native encoding intoUTF-8.Returns a pointer to the newly-created string, and sets len toreflect the new length in bytes.

    A NUL character will be written after the end of the string.

    If you want to convert to UTF-8 from encodings other thanthe native (Latin1 or EBCDIC),see sv_recode_to_utf8().

    NOTE: this function is experimental and may change or beremoved without notice.

    1. U8*bytes_to_utf8(const U8 *s, STRLEN *len)
      2.
  • foldEQ_utf8

    Returns true if the leading portions of the strings s1 and s2 (either or bothof which may be in UTF-8) are the same case-insensitively; false otherwise.How far into the strings to compare is determined by other input parameters.

    If u1 is true, the string s1 is assumed to be in UTF-8-encoded Unicode;otherwise it is assumed to be in native 8-bit encoding. Correspondingly for u2with respect to s2.

    If the byte length l1 is non-zero, it says how far into s1 to check for foldequality. In other words, s1+l1 will be used as a goal to reach. Thescan will not be considered to be a match unless the goal is reached, andscanning won't continue past that goal. Correspondingly for l2 with respect tos2.

    If pe1 is non-NULL and the pointer it points to is not NULL, that pointer isconsidered an end pointer beyond which scanning of s1 will not continue underany circumstances. This means that if both l1 and pe1 are specified, andpe1is less than s1+l1, the match will never be successful because it canneverget as far as its goal (and in fact is asserted against). Correspondingly forpe2 with respect to s2.

    At least one of s1 and s2 must have a goal (at least one of l1 andl2 must be non-zero), and if both do, both have to bereached for a successful match. Also, if the fold of a character is multiplecharacters, all of them must be matched (see tr21 reference below for'folding').

    Upon a successful match, if pe1 is non-NULL,it will be set to point to the beginning of the next character of s1beyond what was matched. Correspondingly for pe2 and s2.

    For case-insensitiveness, the "casefolding" of Unicode is usedinstead of upper/lowercasing both the characters, seehttp://www.unicode.org/unicode/reports/tr21/ (Case Mappings).

    1. I32foldEQ_utf8(const char *s1, char **pe1, UV l1,
      2.  
    2.  bool u1, const char *s2, char **pe2,
      3.  
    3.  UV l2, bool u2)
      4.
  • is_ascii_string

    Returns true if the first len bytes of the string s are the same whetheror not the string is encoded in UTF-8 (or UTF-EBCDIC on EBCDIC machines). Thatis, if they are invariant. On ASCII-ish machines, only ASCII charactersfit this definition, hence the function's name.

    If len is 0, it will be calculated using strlen(s).

    See also is_utf8_string(), is_utf8_string_loclen(), and is_utf8_string_loc().

    1. boolis_ascii_string(const U8 *s, STRLEN len)
      2.
  • is_utf8_char

    DEPRECATED!

    Tests if some arbitrary number of bytes begins in a valid UTF-8character. Note that an INVARIANT (i.e. ASCII on non-EBCDIC machines)character is a valid UTF-8 character. The actual number of bytes in the UTF-8character will be returned if it is valid, otherwise 0.

    This function is deprecated due to the possibility that malformed input couldcause reading beyond the end of the input buffer. Use is_utf8_char_bufinstead.

    1. STRLENis_utf8_char(const U8 *s)
      2.
  • is_utf8_char_buf

    Returns the number of bytes that comprise the first UTF-8 encoded character inbuffer buf. buf_end should point to one position beyond the end of thebuffer. 0 is returned if buf does not point to a complete, valid UTF-8encoded character.

    Note that an INVARIANT character (i.e. ASCII on non-EBCDICmachines) is a valid UTF-8 character.

    1. STRLENis_utf8_char_buf(const U8 *buf,
      2.  
    2.  const U8 *buf_end)
      3.
  • is_utf8_string

    Returns true if the first len bytes of string s form a validUTF-8 string, false otherwise. If len is 0, it will be calculatedusing strlen(s) (which means if you use this option, that s has to have aterminating NUL byte). Note that all characters being ASCII constitute 'avalid UTF-8 string'.

    See also is_ascii_string(), is_utf8_string_loclen(), and is_utf8_string_loc().

    1. boolis_utf8_string(const U8 *s, STRLEN len)
      2.
  • is_utf8_string_loc

    Like is_utf8_string but stores the location of the failure (in thecase of "utf8ness failure") or the location s+len (in the case of"utf8ness success") in the ep.

    See also is_utf8_string_loclen() and is_utf8_string().

    1. boolis_utf8_string_loc(const U8 *s, STRLEN len,
      2.  
    2.       const U8 **p)
      3.
  • is_utf8_string_loclen

    Like is_utf8_string() but stores the location of the failure (in thecase of "utf8ness failure") or the location s+len (in the case of"utf8ness success") in the ep, and the number of UTF-8encoded characters in the el.

    See also is_utf8_string_loc() and is_utf8_string().

    1. boolis_utf8_string_loclen(const U8 *s, STRLEN len,
      2.  
    2.     const U8 **ep, STRLEN *el)
      3.
  • pv_uni_display

    Build to the scalar dsv a displayable version of the string spv,length len, the displayable version being at most pvlim bytes long(if longer, the rest is truncated and "..." will be appended).

    The flags argument can have UNI_DISPLAY_ISPRINT set to displayisPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASHto display the \[nrfta\] as the backslashed versions (like '\n')(UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \).UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have bothUNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.

    The pointer to the PV of the dsv is returned.

    1. char*pv_uni_display(SV *dsv, const U8 *spv,
      2.  
    2.    STRLEN len, STRLEN pvlim,
      3.  
    3.    UV flags)
      4.
  • sv_cat_decode

    The encoding is assumed to be an Encode object, the PV of the ssv isassumed to be octets in that encoding and decoding the input startsfrom the position which (PV + *offset) pointed to. The dsv will beconcatenated the decoded UTF-8 string from ssv. Decoding will terminatewhen the string tstr appears in decoding output or the input ends onthe PV of the ssv. The value which the offset points will be modifiedto the last input position on the ssv.

    Returns TRUE if the terminator was found, else returns FALSE.

    1. boolsv_cat_decode(SV* dsv, SV *encoding, SV *ssv,
      2.  
    2.   int *offset, char* tstr, int tlen)
      3.
  • sv_recode_to_utf8

    The encoding is assumed to be an Encode object, on entry the PVof the sv is assumed to be octets in that encoding, and the svwill be converted into Unicode (and UTF-8).

    If the sv already is UTF-8 (or if it is not POK), or if the encodingis not a reference, nothing is done to the sv. If the encoding is notan Encode::XS Encoding object, bad things will happen.(See lib/encoding.pm and Encode.)

    The PV of the sv is returned.

    1. char*sv_recode_to_utf8(SV* sv, SV *encoding)
      2.
  • sv_uni_display

    Build to the scalar dsv a displayable version of the scalar sv,the displayable version being at most pvlim bytes long(if longer, the rest is truncated and "..." will be appended).

    The flags argument is as in pv_uni_display().

    The pointer to the PV of the dsv is returned.

    1. char*sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim,
      2.  
    2.    UV flags)
      3.
  • to_utf8_case

    The p contains the pointer to the UTF-8 string encodingthe character that is being converted. This routine assumes that the characterat p is well-formed.

    The ustrp is a pointer to the character buffer to put theconversion result to. The lenp is a pointer to the lengthof the result.

    The swashp is a pointer to the swash to use.

    Both the special and normal mappings are stored in lib/unicore/To/Foo.pl,and loaded by SWASHNEW, using lib/utf8_heavy.pl. The special (usually,but not always, a multicharacter mapping), is tried first.

    The special is a string like "utf8::ToSpecLower", which means thehash %utf8::ToSpecLower. The access to the hash is throughPerl_to_utf8_case().

    The normal is a string like "ToLower" which means the swash%utf8::ToLower.

    1. UVto_utf8_case(const U8 *p, U8* ustrp,
      2.  
    2.  STRLEN *lenp, SV **swashp,
      3.  
    3.  const char *normal,
      4.  
    4.  const char *special)
      5.
  • to_utf8_fold

    Convert the UTF-8 encoded character at p to its foldcase version andstore that in UTF-8 in ustrp and its length in bytes in lenp. Notethat the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since thefoldcase version may be longer than the original character (up tothree characters).

    The first character of the foldcased version is returned(but note, as explained above, that there may be more.)

    The character at p is assumed by this routine to be well-formed.

    1. UVto_utf8_fold(const U8 *p, U8* ustrp,
      2.  
    2.  STRLEN *lenp)
      3.
  • to_utf8_lower

    Convert the UTF-8 encoded character at p to its lowercase version andstore that in UTF-8 in ustrp and its length in bytes in lenp. Notethat the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since thelowercase version may be longer than the original character.

    The first character of the lowercased version is returned(but note, as explained above, that there may be more.)

    The character at p is assumed by this routine to be well-formed.

    1. UVto_utf8_lower(const U8 *p, U8* ustrp,
      2.  
    2.   STRLEN *lenp)
      3.
  • to_utf8_title

    Convert the UTF-8 encoded character at p to its titlecase version andstore that in UTF-8 in ustrp and its length in bytes in lenp. Notethat the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since thetitlecase version may be longer than the original character.

    The first character of the titlecased version is returned(but note, as explained above, that there may be more.)

    The character at p is assumed by this routine to be well-formed.

    1. UVto_utf8_title(const U8 *p, U8* ustrp,
      2.  
    2.   STRLEN *lenp)
      3.
  • to_utf8_upper

    Convert the UTF-8 encoded character at p to its uppercase version andstore that in UTF-8 in ustrp and its length in bytes in lenp. Notethat the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes sincethe uppercase version may be longer than the original character.

    The first character of the uppercased version is returned(but note, as explained above, that there may be more.)

    The character at p is assumed by this routine to be well-formed.

    1. UVto_utf8_upper(const U8 *p, U8* ustrp,
      2.  
    2.   STRLEN *lenp)
      3.
  • utf8n_to_uvchr

    Returns the native character value of the first character in the stringswhich is assumed to be in UTF-8 encoding; retlen will be set to thelength, in bytes, of that character.

    length and flags are the same as utf8n_to_uvuni().

    1. UVutf8n_to_uvchr(const U8 *s, STRLEN curlen,
      2.  
    2.       STRLEN *retlen, U32 flags)
      3.
  • utf8n_to_uvuni

    Bottom level UTF-8 decode routine.Returns the code point value of the first character in the string s,which is assumed to be in UTF-8 (or UTF-EBCDIC) encoding, and no longer thancurlen bytes; *retlen (if retlen isn't NULL) will be set tothe length, in bytes, of that character.

    The value of flags determines the behavior when s does not point to awell-formed UTF-8 character. If flags is 0, when a malformation is found,zero is returned and *retlen is set so that (s + *retlen) is thenext possible position in s that could begin a non-malformed character.Also, if UTF-8 warnings haven't been lexically disabled, a warning is raised.

    Various ALLOW flags can be set in flags to allow (and not warn on)individual types of malformations, such as the sequence being overlong (thatis, when there is a shorter sequence that can express the same code point;overlong sequences are expressly forbidden in the UTF-8 standard due topotential security issues). Another malformation example is the first byte ofa character not being a legal first byte. See utf8.h for the list of suchflags. For allowed 0 length strings, this function returns 0; for allowedoverlong sequences, the computed code point is returned; for all other allowedmalformations, the Unicode REPLACEMENT CHARACTER is returned, as these have nodeterminable reasonable value.

    The UTF8_CHECK_ONLY flag overrides the behavior when a non-allowed (by otherflags) malformation is found. If this flag is set, the routine assumes thatthe caller will raise a warning, and this function will silently just setretlen to -1 and return zero.

    Certain code points are considered problematic. These are Unicode surrogates,Unicode non-characters, and code points above the Unicode maximum of 0x10FFFF.By default these are considered regular code points, but certain situationswarrant special handling for them. If flags containsUTF8_DISALLOW_ILLEGAL_INTERCHANGE, all three classes are treated asmalformations and handled as such. The flags UTF8_DISALLOW_SURROGATE,UTF8_DISALLOW_NONCHAR, and UTF8_DISALLOW_SUPER (meaning above the legal Unicodemaximum) can be set to disallow these categories individually.

    The flags UTF8_WARN_ILLEGAL_INTERCHANGE, UTF8_WARN_SURROGATE,UTF8_WARN_NONCHAR, and UTF8_WARN_SUPER will cause warning messages to be raisedfor their respective categories, but otherwise the code points are consideredvalid (not malformations). To get a category to both be treated as amalformation and raise a warning, specify both the WARN and DISALLOW flags.(But note that warnings are not raised if lexically disabled nor ifUTF8_CHECK_ONLY is also specified.)

    Very large code points (above 0x7FFF_FFFF) are considered more problematic thanthe others that are above the Unicode legal maximum. There are severalreasons: they requre at least 32 bits to represent them on ASCII platforms, arenot representable at all on EBCDIC platforms, and the original UTF-8specification never went above this number (the current 0x10FFFF limit wasimposed later). (The smaller ones, those that fit into 32 bits, arerepresentable by a UV on ASCII platforms, but not by an IV, which means thatthe number of operations that can be performed on them is quite restricted.)The UTF-8 encoding on ASCII platforms for these large code points begins with abyte containing 0xFE or 0xFF. The UTF8_DISALLOW_FE_FF flag will cause them tobe treated as malformations, while allowing smaller above-Unicode code points.(Of course UTF8_DISALLOW_SUPER will treat all above-Unicode code points,including these, as malformations.) Similarly, UTF8_WARN_FE_FF acts just likethe other WARN flags, but applies just to these code points.

    All other code points corresponding to Unicode characters, including privateuse and those yet to be assigned, are never considered malformed and neverwarn.

    Most code should use utf8_to_uvchr_buf() rather than call this directly.

    1. UVutf8n_to_uvuni(const U8 *s, STRLEN curlen,
      2.  
    2.       STRLEN *retlen, U32 flags)
      3.
  • utf8_distance

    Returns the number of UTF-8 characters between the UTF-8 pointers aand b.

    WARNING: use only if you *know* that the pointers point inside thesame UTF-8 buffer.

    1. IVutf8_distance(const U8 *a, const U8 *b)
      2.
  • utf8_hop

    Return the UTF-8 pointer s displaced by off characters, eitherforward or backward.

    WARNING: do not use the following unless you *know* off is withinthe UTF-8 data pointed to by s *and* that on entry s is alignedon the first byte of character or just after the last byte of a character.

    1. U8*utf8_hop(const U8 *s, I32 off)
      2.
  • utf8_length

    Return the length of the UTF-8 char encoded string s in characters.Stops at e (inclusive). If e < s or if the scan would endup past e, croaks.

    1. STRLENutf8_length(const U8* s, const U8 *e)
      2.
  • utf8_to_bytes

    Converts a string s of length len from UTF-8 into native byte encoding.Unlike bytes_to_utf8, this over-writes the original string, andupdates len to contain the new length.Returns zero on failure, setting len to -1.

    If you need a copy of the string, see bytes_from_utf8.

    NOTE: this function is experimental and may change or beremoved without notice.

    1. U8*utf8_to_bytes(U8 *s, STRLEN *len)
      2.
  • utf8_to_uvchr

    DEPRECATED!

    Returns the native code point of the first character in the string swhich is assumed to be in UTF-8 encoding; retlen will be set to thelength, in bytes, of that character.

    Some, but not all, UTF-8 malformations are detected, and in fact, somemalformed input could cause reading beyond the end of the input buffer, whichis why this function is deprecated. Use utf8_to_uvchr_buf instead.

    If s points to one of the detected malformations, and UTF8 warnings areenabled, zero is returned and *retlen is set (if retlen isn'tNULL) to -1. If those warnings are off, the computed value if well-defined (orthe Unicode REPLACEMENT CHARACTER, if not) is silently returned, and *retlenis set (if retlen isn't NULL) so that (s + *retlen) is thenext possible position in s that could begin a non-malformed character.See utf8n_to_uvuni for details on when the REPLACEMENT CHARACTER is returned.

    1. UVutf8_to_uvchr(const U8 *s, STRLEN *retlen)
      2.
  • utf8_to_uvchr_buf

    Returns the native code point of the first character in the string s whichis assumed to be in UTF-8 encoding; send points to 1 beyond the end of s.*retlen will be set to the length, in bytes, of that character.

    If s does not point to a well-formed UTF-8 character and UTF8 warnings areenabled, zero is returned and *retlen is set (if retlen isn'tNULL) to -1. If those warnings are off, the computed value if well-defined (orthe Unicode REPLACEMENT CHARACTER, if not) is silently returned, and *retlenis set (if retlen isn't NULL) so that (s + *retlen) is thenext possible position in s that could begin a non-malformed character.See utf8n_to_uvuni for details on when the REPLACEMENT CHARACTER is returned.

    1. UVutf8_to_uvchr_buf(const U8 *s, const U8 *send,
      2.  
    2.     STRLEN *retlen)
      3.
  • utf8_to_uvuni

    DEPRECATED!

    Returns the Unicode code point of the first character in the string swhich is assumed to be in UTF-8 encoding; retlen will be set to thelength, in bytes, of that character.

    This function should only be used when the returned UV is consideredan index into the Unicode semantic tables (e.g. swashes).

    Some, but not all, UTF-8 malformations are detected, and in fact, somemalformed input could cause reading beyond the end of the input buffer, whichis why this function is deprecated. Use utf8_to_uvuni_buf instead.

    If s points to one of the detected malformations, and UTF8 warnings areenabled, zero is returned and *retlen is set (if retlen doesn't point toNULL) to -1. If those warnings are off, the computed value if well-defined (orthe Unicode REPLACEMENT CHARACTER, if not) is silently returned, and *retlenis set (if retlen isn't NULL) so that (s + *retlen) is thenext possible position in s that could begin a non-malformed character.See utf8n_to_uvuni for details on when the REPLACEMENT CHARACTER is returned.

    1. UVutf8_to_uvuni(const U8 *s, STRLEN *retlen)
      2.
  • utf8_to_uvuni_buf

    Returns the Unicode code point of the first character in the string s whichis assumed to be in UTF-8 encoding; send points to 1 beyond the end of s.retlen will be set to the length, in bytes, of that character.

    This function should only be used when the returned UV is consideredan index into the Unicode semantic tables (e.g. swashes).

    If s does not point to a well-formed UTF-8 character and UTF8 warnings areenabled, zero is returned and *retlen is set (if retlen isn'tNULL) to -1. If those warnings are off, the computed value if well-defined (orthe Unicode REPLACEMENT CHARACTER, if not) is silently returned, and *retlenis set (if retlen isn't NULL) so that (s + *retlen) is thenext possible position in s that could begin a non-malformed character.See utf8n_to_uvuni for details on when the REPLACEMENT CHARACTER is returned.

    1. UVutf8_to_uvuni_buf(const U8 *s, const U8 *send,
      2.  
    2.     STRLEN *retlen)
      3.
  • uvchr_to_utf8

    Adds the UTF-8 representation of the Native code point uv to the endof the string d; d should have at least UTF8_MAXBYTES+1 freebytes available. The return value is the pointer to the byte after theend of the new character. In other words,

    1.  d = uvchr_to_utf8(d, uv);
      2.

    is the recommended wide native character-aware way of saying

    1.  *(d++) = uv;
      2.  
    2.  
    3. U8*uvchr_to_utf8(U8 *d, UV uv)
      4.
  • uvuni_to_utf8_flags

    Adds the UTF-8 representation of the code point uv to the endof the string d; d should have at least UTF8_MAXBYTES+1 freebytes available. The return value is the pointer to the byte after theend of the new character. In other words,

    1.  d = uvuni_to_utf8_flags(d, uv, flags);
      2.

    or, in most cases,

    1.  d = uvuni_to_utf8(d, uv);
      2.

    (which is equivalent to)

    1.  d = uvuni_to_utf8_flags(d, uv, 0);
      2.

    This is the recommended Unicode-aware way of saying

    1.  *(d++) = uv;
      2.

    This function will convert to UTF-8 (and not warn) even code points that aren'tlegal Unicode or are problematic, unless flags contains one or more of thefollowing flags:

    If uv is a Unicode surrogate code point and UNICODE_WARN_SURROGATE is set,the function will raise a warning, provided UTF8 warnings are enabled. If insteadUNICODE_DISALLOW_SURROGATE is set, the function will fail and return NULL.If both flags are set, the function will both warn and return NULL.

    The UNICODE_WARN_NONCHAR and UNICODE_DISALLOW_NONCHAR flags correspondinglyaffect how the function handles a Unicode non-character. And, likewise for theUNICODE_WARN_SUPER and UNICODE_DISALLOW_SUPER flags, and code points that areabove the Unicode maximum of 0x10FFFF. Code points above 0x7FFF_FFFF (which areeven less portable) can be warned and/or disallowed even if other above-Unicodecode points are accepted by the UNICODE_WARN_FE_FF and UNICODE_DISALLOW_FE_FFflags.

    And finally, the flag UNICODE_WARN_ILLEGAL_INTERCHANGE selects all four of theabove WARN flags; and UNICODE_DISALLOW_ILLEGAL_INTERCHANGE selects all fourDISALLOW flags.

    1. U8*uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
      2.

Variables created by xsubpp and xsubpp internal functions

  • ax

    Variable which is setup by xsubpp to indicate the stack base offset,used by the ST, XSprePUSH and XSRETURN macros. The dMARK macromust be called prior to setup the MARK variable.

    1. I32ax
      2.
  • CLASS

    Variable which is setup by xsubpp to indicate the class name for a C++ XS constructor. This is always a char*. See THIS.

    1. char*CLASS
      2.
  • dAX

    Sets up the ax variable.This is usually handled automatically by xsubpp by calling dXSARGS.

    1. dAX;
      2.
  • dAXMARK

    Sets up the ax variable and stack marker variable mark.This is usually handled automatically by xsubpp by calling dXSARGS.

    1. dAXMARK;
      2.
  • dITEMS

    Sets up the items variable.This is usually handled automatically by xsubpp by calling dXSARGS.

    1. dITEMS;
      2.
  • dUNDERBAR

    Sets up any variable needed by the UNDERBAR macro. It used to definepadoff_du, but it is currently a noop. However, it is strongly advisedto still use it for ensuring past and future compatibility.

    1. dUNDERBAR;
      2.
  • dXSARGS

    Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.Sets up the ax and items variables by calling dAX and dITEMS.This is usually handled automatically by xsubpp.

    1. dXSARGS;
      2.
  • dXSI32

    Sets up the ix variable for an XSUB which has aliases. This is usuallyhandled automatically by xsubpp.

    1. dXSI32;
      2.
  • items

    Variable which is setup by xsubpp to indicate the number of items on the stack. See Variable-length Parameter Lists in perlxs.

    1. I32items
      2.
  • ix

    Variable which is setup by xsubpp to indicate which of an XSUB's aliases was used to invoke it. See The ALIAS: Keyword in perlxs.

    1. I32ix
      2.
  • newXSproto

    Used by xsubpp to hook up XSUBs as Perl subs. Adds Perl prototypes tothe subs.

  • RETVAL

    Variable which is setup by xsubpp to hold the return value for an XSUB. This is always the proper type for the XSUB. See The RETVAL Variable in perlxs.

    1. (whatever)RETVAL
      2.
  • ST

    Used to access elements on the XSUB's stack.

    1. SV*ST(int ix)
      2.
  • THIS

    Variable which is setup by xsubpp to designate the object in a C++ XSUB. This is always the proper type for the C++ object. See CLASS and Using XS With C++ in perlxs.

    1. (whatever)THIS
      2.
  • UNDERBAR

    The SV* corresponding to the $_ variable. Works even if thereis a lexical $_ in scope.

  • XS

    Macro to declare an XSUB and its C parameter list. This is handled byxsubpp. It is the same as using the more explicit XS_EXTERNAL macro.

  • XS_APIVERSION_BOOTCHECK

    Macro to verify that the perl api version an XS module has been compiled againstmatches the api version of the perl interpreter it's being loaded into.

    1. XS_APIVERSION_BOOTCHECK;
      2.
  • XS_EXTERNAL

    Macro to declare an XSUB and its C parameter list explicitly exporting the symbols.

  • XS_INTERNAL

    Macro to declare an XSUB and its C parameter list without exporting the symbols.This is handled by xsubpp and generally preferable over exporting the XSUBsymbols unnecessarily.

  • XS_VERSION

    The version identifier for an XS module. This is usuallyhandled automatically by ExtUtils::MakeMaker. See XS_VERSION_BOOTCHECK.

  • XS_VERSION_BOOTCHECK

    Macro to verify that a PM module's $VERSION variable matches the XSmodule's XS_VERSION variable. This is usually handled automatically byxsubpp. See The VERSIONCHECK: Keyword in perlxs.

    1. XS_VERSION_BOOTCHECK;
      2.

Warning and Dieing

  • croak

    This is an XS interface to Perl's die function.

    Take a sprintf-style format pattern and argument list. These are used togenerate a string message. If the message does not end with a newline,then it will be extended with some indication of the current locationin the code, as described for mess_sv.

    The error message will be used as an exception, by defaultreturning control to the nearest enclosing eval, but subject tomodification by a $SIG{__DIE__} handler. In any case, the croakfunction never returns normally.

    For historical reasons, if pat is null then the contents of ERRSV($@) will be used as an error message or object instead of building anerror message from arguments. If you want to throw a non-string object,or build an error message in an SV yourself, it is preferable to usethe croak_sv function, which does not involve clobbering ERRSV.

    1. voidcroak(const char *pat, ...)
      2.
  • croak_no_modify

    Exactly equivalent to Perl_croak(aTHX_ "%s", PL_no_modify), but generatesterser object code than using Perl_croak. Less code used on exception codepaths reduces CPU cache pressure.

    1. voidcroak_no_modify()
      2.
  • croak_sv

    This is an XS interface to Perl's die function.

    baseex is the error message or object. If it is a reference, itwill be used as-is. Otherwise it is used as a string, and if it doesnot end with a newline then it will be extended with some indication ofthe current location in the code, as described for mess_sv.

    The error message or object will be used as an exception, by defaultreturning control to the nearest enclosing eval, but subject tomodification by a $SIG{__DIE__} handler. In any case, the croak_svfunction never returns normally.

    To die with a simple string message, the croak function may bemore convenient.

    1. voidcroak_sv(SV *baseex)
      2.
  • die

    Behaves the same as croak, except for the return type.It should be used only where the OP * return type is required.The function never actually returns.

    1. OP *die(const char *pat, ...)
      2.
  • die_sv

    Behaves the same as croak_sv, except for the return type.It should be used only where the OP * return type is required.The function never actually returns.

    1. OP *die_sv(SV *baseex)
      2.
  • vcroak

    This is an XS interface to Perl's die function.

    pat and args are a sprintf-style format pattern and encapsulatedargument list. These are used to generate a string message. If themessage does not end with a newline, then it will be extended withsome indication of the current location in the code, as described formess_sv.

    The error message will be used as an exception, by defaultreturning control to the nearest enclosing eval, but subject tomodification by a $SIG{__DIE__} handler. In any case, the croakfunction never returns normally.

    For historical reasons, if pat is null then the contents of ERRSV($@) will be used as an error message or object instead of building anerror message from arguments. If you want to throw a non-string object,or build an error message in an SV yourself, it is preferable to usethe croak_sv function, which does not involve clobbering ERRSV.

    1. voidvcroak(const char *pat, va_list *args)
      2.
  • vwarn

    This is an XS interface to Perl's warn function.

    pat and args are a sprintf-style format pattern and encapsulatedargument list. These are used to generate a string message. If themessage does not end with a newline, then it will be extended withsome indication of the current location in the code, as described formess_sv.

    The error message or object will by default be written to standard error,but this is subject to modification by a $SIG{__WARN__} handler.

    Unlike with vcroak, pat is not permitted to be null.

    1. voidvwarn(const char *pat, va_list *args)
      2.
  • warn

    This is an XS interface to Perl's warn function.

    Take a sprintf-style format pattern and argument list. These are used togenerate a string message. If the message does not end with a newline,then it will be extended with some indication of the current locationin the code, as described for mess_sv.

    The error message or object will by default be written to standard error,but this is subject to modification by a $SIG{__WARN__} handler.

    Unlike with croak, pat is not permitted to be null.

    1. voidwarn(const char *pat, ...)
      2.
  • warn_sv

    This is an XS interface to Perl's warn function.

    baseex is the error message or object. If it is a reference, itwill be used as-is. Otherwise it is used as a string, and if it doesnot end with a newline then it will be extended with some indication ofthe current location in the code, as described for mess_sv.

    The error message or object will by default be written to standard error,but this is subject to modification by a $SIG{__WARN__} handler.

    To warn with a simple string message, the warn function may bemore convenient.

    1. voidwarn_sv(SV *baseex)
      2.

Undocumented functions

The following functions have been flagged as part of the public API,but are currently undocumented. Use them at your own risk, as theinterfaces are subject to change.

If you use one of them, you may wish to consider creating and submittingdocumentation for it. If your patch is accepted, this will indicate thatthe interface is stable (unless it is explicitly marked otherwise).

  • GetVars
  • Gv_AMupdate
  • PerlIO_clearerr
  • PerlIO_close
  • PerlIO_context_layers
  • PerlIO_eof
  • PerlIO_error
  • PerlIO_fileno
  • PerlIO_fill
  • PerlIO_flush
  • PerlIO_get_base
  • PerlIO_get_bufsiz
  • PerlIO_get_cnt
  • PerlIO_get_ptr
  • PerlIO_read
  • PerlIO_seek
  • PerlIO_set_cnt
  • PerlIO_set_ptrcnt
  • PerlIO_setlinebuf
  • PerlIO_stderr
  • PerlIO_stdin
  • PerlIO_stdout
  • PerlIO_tell
  • PerlIO_unread
  • PerlIO_write
  • Slab_Alloc
  • Slab_Free
  • _is_utf8_quotemeta
  • amagic_call
  • amagic_deref_call
  • any_dup
  • atfork_lock
  • atfork_unlock
  • av_arylen_p
  • av_iter_p
  • block_gimme
  • call_atexit
  • call_list
  • calloc
  • cast_i32
  • cast_iv
  • cast_ulong
  • cast_uv
  • ck_warner
  • ck_warner_d
  • ckwarn
  • ckwarn_d
  • clone_params_del
  • clone_params_new
  • croak_nocontext
  • csighandler
  • cx_dump
  • cx_dup
  • cxinc
  • deb
  • deb_nocontext
  • debop
  • debprofdump
  • debstack
  • debstackptrs
  • delimcpy
  • despatch_signals
  • die_nocontext
  • dirp_dup
  • do_aspawn
  • do_binmode
  • do_close
  • do_gv_dump
  • do_gvgv_dump
  • do_hv_dump
  • do_join
  • do_magic_dump
  • do_op_dump
  • do_open
  • do_open9
  • do_openn
  • do_pmop_dump
  • do_spawn
  • do_spawn_nowait
  • do_sprintf
  • do_sv_dump
  • doing_taint
  • doref
  • dounwind
  • dowantarray
  • dump_all
  • dump_eval
  • dump_fds
  • dump_form
  • dump_indent
  • dump_mstats
  • dump_packsubs
  • dump_sub
  • dump_vindent
  • filter_add
  • filter_del
  • filter_read
  • foldEQ_latin1
  • form_nocontext
  • fp_dup
  • fprintf_nocontext
  • free_global_struct
  • free_tmps
  • get_context
  • get_mstats
  • get_op_descs
  • get_op_names
  • get_ppaddr
  • get_vtbl
  • gp_dup
  • gp_free
  • gp_ref
  • gv_AVadd
  • gv_HVadd
  • gv_IOadd
  • gv_SVadd
  • gv_add_by_type
  • gv_autoload4
  • gv_autoload_pv
  • gv_autoload_pvn
  • gv_autoload_sv
  • gv_check
  • gv_dump
  • gv_efullname
  • gv_efullname3
  • gv_efullname4
  • gv_fetchfile
  • gv_fetchfile_flags
  • gv_fetchpv
  • gv_fetchpvn_flags
  • gv_fetchsv
  • gv_fullname
  • gv_fullname3
  • gv_fullname4
  • gv_handler
  • gv_name_set
  • he_dup
  • hek_dup
  • hv_common
  • hv_common_key_len
  • hv_delayfree_ent
  • hv_eiter_p
  • hv_eiter_set
  • hv_free_ent
  • hv_ksplit
  • hv_name_set
  • hv_placeholders_get
  • hv_placeholders_p
  • hv_placeholders_set
  • hv_riter_p
  • hv_riter_set
  • init_global_struct
  • init_i18nl10n
  • init_i18nl14n
  • init_stacks
  • init_tm
  • instr
  • is_lvalue_sub
  • is_uni_alnum
  • is_uni_alnum_lc
  • is_uni_alpha
  • is_uni_alpha_lc
  • is_uni_ascii
  • is_uni_ascii_lc
  • is_uni_cntrl
  • is_uni_cntrl_lc
  • is_uni_digit
  • is_uni_digit_lc
  • is_uni_graph
  • is_uni_graph_lc
  • is_uni_idfirst
  • is_uni_idfirst_lc
  • is_uni_lower
  • is_uni_lower_lc
  • is_uni_print
  • is_uni_print_lc
  • is_uni_punct
  • is_uni_punct_lc
  • is_uni_space
  • is_uni_space_lc
  • is_uni_upper
  • is_uni_upper_lc
  • is_uni_xdigit
  • is_uni_xdigit_lc
  • is_utf8_alnum
  • is_utf8_alpha
  • is_utf8_ascii
  • is_utf8_cntrl
  • is_utf8_digit
  • is_utf8_graph
  • is_utf8_idcont
  • is_utf8_idfirst
  • is_utf8_lower
  • is_utf8_mark
  • is_utf8_perl_space
  • is_utf8_perl_word
  • is_utf8_posix_digit
  • is_utf8_print
  • is_utf8_punct
  • is_utf8_space
  • is_utf8_upper
  • is_utf8_xdigit
  • is_utf8_xidcont
  • is_utf8_xidfirst
  • leave_scope
  • load_module_nocontext
  • magic_dump
  • malloc
  • markstack_grow
  • mess_nocontext
  • mfree
  • mg_dup
  • mg_size
  • mini_mktime
  • moreswitches
  • mro_get_from_name
  • mro_get_private_data
  • mro_set_mro
  • mro_set_private_data
  • my_atof
  • my_atof2
  • my_bcopy
  • my_bzero
  • my_chsize
  • my_cxt_index
  • my_cxt_init
  • my_dirfd
  • my_exit
  • my_failure_exit
  • my_fflush_all
  • my_fork
  • my_htonl
  • my_lstat
  • my_memcmp
  • my_memset
  • my_ntohl
  • my_pclose
  • my_popen
  • my_popen_list
  • my_setenv
  • my_socketpair
  • my_stat
  • my_strftime
  • my_strlcat
  • my_strlcpy
  • my_swap
  • newANONATTRSUB
  • newANONHASH
  • newANONLIST
  • newANONSUB
  • newATTRSUB
  • newAVREF
  • newCVREF
  • newFORM
  • newGVREF
  • newGVgen
  • newGVgen_flags
  • newHVREF
  • newHVhv
  • newIO
  • newMYSUB
  • newPROG
  • newRV
  • newSUB
  • newSVREF
  • newSVpvf_nocontext
  • new_collate
  • new_ctype
  • new_numeric
  • new_stackinfo
  • ninstr
  • op_dump
  • op_free
  • op_null
  • op_refcnt_lock
  • op_refcnt_unlock
  • parser_dup
  • perl_alloc_using
  • perl_clone_using
  • pmop_dump
  • pop_scope
  • pregcomp
  • pregexec
  • pregfree
  • pregfree2
  • printf_nocontext
  • ptr_table_clear
  • ptr_table_fetch
  • ptr_table_free
  • ptr_table_new
  • ptr_table_split
  • ptr_table_store
  • push_scope
  • re_compile
  • re_dup_guts
  • re_intuit_start
  • re_intuit_string
  • realloc
  • reentrant_free
  • reentrant_init
  • reentrant_retry
  • reentrant_size
  • ref
  • reg_named_buff_all
  • reg_named_buff_exists
  • reg_named_buff_fetch
  • reg_named_buff_firstkey
  • reg_named_buff_nextkey
  • reg_named_buff_scalar
  • regclass_swash
  • regdump
  • regdupe_internal
  • regexec_flags
  • regfree_internal
  • reginitcolors
  • regnext
  • repeatcpy
  • rninstr
  • rsignal
  • rsignal_state
  • runops_debug
  • runops_standard
  • rvpv_dup
  • safesyscalloc
  • safesysfree
  • safesysmalloc
  • safesysrealloc
  • save_I16
  • save_I32
  • save_I8
  • save_adelete
  • save_aelem
  • save_aelem_flags
  • save_alloc
  • save_aptr
  • save_ary
  • save_bool
  • save_clearsv
  • save_delete
  • save_destructor
  • save_destructor_x
  • save_freeop
  • save_freepv
  • save_freesv
  • save_generic_pvref
  • save_generic_svref
  • save_gp
  • save_hash
  • save_hdelete
  • save_helem
  • save_helem_flags
  • save_hints
  • save_hptr
  • save_int
  • save_item
  • save_iv
  • save_list
  • save_long
  • save_mortalizesv
  • save_nogv
  • save_op
  • save_padsv_and_mortalize
  • save_pptr
  • save_pushi32ptr
  • save_pushptr
  • save_pushptrptr
  • save_re_context
  • save_scalar
  • save_set_svflags
  • save_shared_pvref
  • save_sptr
  • save_svref
  • save_vptr
  • savestack_grow
  • savestack_grow_cnt
  • scan_num
  • scan_vstring
  • screaminstr
  • seed
  • set_context
  • set_numeric_local
  • set_numeric_radix
  • set_numeric_standard
  • share_hek
  • si_dup
  • ss_dup
  • stack_grow
  • start_subparse
  • stashpv_hvname_match
  • str_to_version
  • sv_2iv
  • sv_2pv
  • sv_2uv
  • sv_catpvf_mg_nocontext
  • sv_catpvf_nocontext
  • sv_compile_2op
  • sv_dump
  • sv_dup
  • sv_dup_inc
  • sv_peek
  • sv_pvn_nomg
  • sv_setpvf_mg_nocontext
  • sv_setpvf_nocontext
  • sv_utf8_upgrade_flags_grow
  • swash_fetch
  • swash_init
  • sys_init
  • sys_init3
  • sys_intern_clear
  • sys_intern_dup
  • sys_intern_init
  • sys_term
  • taint_env
  • taint_proper
  • tmps_grow
  • to_uni_fold
  • to_uni_lower
  • to_uni_lower_lc
  • to_uni_title
  • to_uni_title_lc
  • to_uni_upper
  • to_uni_upper_lc
  • unlnk
  • unsharepvn
  • utf16_to_utf8
  • utf16_to_utf8_reversed
  • uvchr_to_utf8_flags
  • uvuni_to_utf8
  • vdeb
  • vform
  • vload_module
  • vnewSVpvf
  • vwarner
  • warn_nocontext
  • warner
  • warner_nocontext
  • whichsig
  • whichsig_pv
  • whichsig_pvn
  • whichsig_sv

AUTHORS

Until May 1997, this document was maintained by Jeff Okamoto<[email protected]>. 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, NeilBowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,Stephen McCamant, and Gurusamy Sarathy.

API Listing originally by Dean Roehrich <[email protected]>.

Updated to be autogenerated from comments in the source by Benjamin Stuhl.

SEE ALSO

perlguts, perlxs, perlxstut, perlintern

Page index
 
Source : perldoc.perl.org - Official documentation for the Perl programming language
Site maintained by Jon Allen (JJ)     See the project page for more details
Documentation maintained by the Perl 5 Porters
(Sebelumnya) Perl calling conventions from CAutogenerated documentation of ... (Berikutnya)