| PERLAPI(1) | Perl Programmers Reference Guide | PERLAPI(1) |
perlapi - autogenerated documentation for the perl public API
This file contains most of the documentation of the perl public API, as generated by embed.pl. Specifically, it is a listing of functions, macros, flags, and variables that may be used by extension writers. Besides perlintern and config.h, some items are listed here as being actually documented in another pod.
At the end is a list of functions which have yet to be documented. Patches welcome! The interfaces of these are subject to change without notice.
Some of the functions documented here are consolidated so that a single entry serves for multiple functions which all do basically the same thing, but have some slight differences. For example, one form might process magic, while another doesn't. The name of each variation is listed at the top of the single entry.
The names of all API functions begin with the prefix "Perl_" so as to prevent any name collisions with your code. But, unless "-Accflags=-DPERL_NO_SHORT_NAMES" has been specified in compiling your code (see "Hiding Perl_" in perlembed), synonymous macros are also available to you that don't have this prefix, and also hide from you the need (or not) to have a thread context parameter passed to the function. Generally, code is easier to write and to read when the short form is used, so in practice that compilation flag is not used. Not all functions have the short form; both are listed here when available.
Anything not listed here or in the other mentioned pods is not part of the public API, and should not be used by extension writers at all. For these reasons, blindly using functions listed in proto.h is to be avoided when writing extensions.
In Perl, unlike C, a string of characters may generally contain embedded "NUL" characters. Sometimes in the documentation a Perl string is referred to as a "buffer" to distinguish it from a C string, but sometimes they are both just referred to as strings.
Note that all Perl API global variables must be referenced with the "PL_" prefix. Again, those not listed here are not to be used by extension writers, and may be changed or removed without notice; same with macros. 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 characters whose ordinal numbers are in the range 0 - 127). And documentation and comments may still use the term ASCII, when sometimes in fact the entire range from 0 - 255 is meant.
The non-ASCII characters below 256 can have various meanings, depending on various things. (See, most notably, perllocale.) But usually the whole range can be referred to as ISO-8859-1. Often, the term "Latin-1" (or "Latin1") is used as an equivalent for ISO-8859-1. But some people treat "Latin1" as referring just to the characters in the range 128 through 255, or sometimes from 160 through 255. This documentation uses "Latin1" and "Latin-1" to refer to all 256 characters.
Note that Perl can be compiled and run under either ASCII or EBCDIC (See perlebcdic). 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 so whenever 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, and the UTF- encodings, and a string encoded in UTF-EBCDIC may occupy a different number of bytes than in UTF-8.
The organization of this document is tentative and subject to change. Suggestions and patches welcome perl5-porters@perl.org <mailto:perl5-porters@perl.org>.
The API elements are grouped by functionality into sections, as follows. Within sections the elements are ordered alphabetically, ignoring case, with non-leading underscores sorted first, and leading underscores and digits sorted last.
The listing below is alphabetical, case insensitive.
Note that it is possible that the actions of a destructor called directly or indirectly by freeing an element of the array could cause the reference count of the array itself to be reduced (e.g. by deleting an entry in the symbol table). So it is a possibility that the AV could have been freed (or even reallocated) on return from the call unless you hold a reference to it.
void av_clear( AV *av) void Perl_av_clear(pTHX_ AV *av)
Size_t av_count( AV *av) Size_t Perl_av_count(pTHX_ AV *av)
void Perl_av_create_and_push(pTHX_ AV ** const avp,
SV * const val)
SV ** Perl_av_create_and_unshift_one(pTHX_ AV ** const avp,
SV * const val)
Perl equivalent: "splice(@myarray, $key, 1, undef)" (with the "splice" in void context if "G_DISCARD" is present).
SV * av_delete( AV *av, SSize_t key, I32 flags) SV * Perl_av_delete(pTHX_ AV *av, SSize_t key, I32 flags)
This relies on the fact that uninitialized array elements are set to "NULL".
Perl equivalent: exists($myarray[$key]).
bool av_exists( AV *av, SSize_t key) bool Perl_av_exists(pTHX_ AV *av, SSize_t key)
If the av argument is a tied array then will call the "EXTEND" tied array method with an argument of "(key+1)".
void av_extend( AV *av, SSize_t key) void Perl_av_extend(pTHX_ AV *av, SSize_t key)
See "Understanding the Magic of Tied Hashes and Arrays" in perlguts for more information on how to use this function on tied arrays.
The rough perl equivalent is $myarray[$key].
SV ** av_fetch( AV *av, SSize_t key, I32 lval) SV ** Perl_av_fetch(pTHX_ AV *av, SSize_t key, I32 lval)
The number of elements in the array will be "fill + 1" after av_fill() returns. If the array was previously shorter, then the additional elements appended are set to NULL. If the array was longer, then the excess elements are freed. "av_fill(av, -1)" is the same as av_clear(av).
void av_fill( AV *av, SSize_t fill) void Perl_av_fill(pTHX_ AV *av, SSize_t fill)
Perl equivalent: "my @new_array = ($scalar1, $scalar2, $scalar3...);"
AV * av_make( SSize_t size, SV **strp) AV * Perl_av_make(pTHX_ SSize_t size, SV **strp)
Perl equivalent: "pop(@myarray);"
SV * av_pop( AV *av) SV * Perl_av_pop(pTHX_ AV *av)
Perl equivalent: "push @myarray, $val;".
"av_push" is the general purpose form, suitable for all situations.
"av_push_simple" is a cut-down version of "av_push" that assumes that the array is very straightforward, with no magic, not readonly, and is AvREAL (see "Real AVs - and those that are not" in perlguts), and that "key" is not less than -1. This function MUST NOT be used in situations where any of those assumptions may not hold.
void av_push ( AV *av, SV *val) void Perl_av_push (pTHX_ AV *av, SV *val) void av_push_simple( AV *av, SV *val) void Perl_av_push_simple(pTHX_ AV *av, SV *val)
Perl equivalent: "shift(@myarray);"
SV * av_shift( AV *av) SV * Perl_av_shift(pTHX_ AV *av)
Note that the caller is responsible for suitably incrementing the reference count of "val" before the call, and decrementing it if the function returned "NULL".
Approximate Perl equivalent: "splice(@myarray, $key, 1, $val)".
See "Understanding the Magic of Tied Hashes and Arrays" in perlguts for more information on how to use this function on tied arrays.
SV ** av_store( AV *av, SSize_t key, SV *val) SV ** Perl_av_store(pTHX_ AV *av, SSize_t key, SV *val)
They process 'get' magic.
The Perl equivalent for these is $#av.
Note that, unlike what the name "av_len" implies, it returns the maximum index in the array. This is unlike "sv_len", which returns what you would expect. To get the actual number of elements in an array, use "av_count".
SSize_t av_top_index( AV *av) SSize_t av_tindex ( AV *av) SSize_t AvFILL ( AV* av) SSize_t av_len ( AV *av) SSize_t Perl_av_len (pTHX_ AV *av)
As well as freeing all the elements of the array (like av_clear()), this also frees the memory used by the av to store its list of scalars.
See "av_clear" for a note about the array possibly being invalid on return.
void av_undef( AV *av) void Perl_av_undef(pTHX_ AV *av)
Perl equivalent: "unshift @myarray, ((undef) x $num);"
void av_unshift( AV *av, SSize_t num) void Perl_av_unshift(pTHX_ AV *av, SSize_t num)
AvALLOC(AV* av)
This is useful for doing pointer arithmetic on the array. If all you need is to look up an array element, then prefer "av_fetch".
SV** AvARRAY(AV* av)
AV * AvREFCNT_inc (AV *av) AV * AvREFCNT_inc_simple (AV *av) AV * AvREFCNT_inc_simple_NN(AV *av)
Perl equivalent: "@{"$name"}".
NOTE: the perl_get_av() form is deprecated.
AV * get_av( const char *name, I32 flags) AV * Perl_get_av(pTHX_ const char *name, I32 flags)
As background, an array consists of three things:
An empty array need only have the first data structure, and all these functions create that. They differ in what else they do, as follows:
This is useful when the minimum size of the array could be zero (perhaps there are likely code paths that will entirely skip using it).
If the array does get used, the pointers data structure will need to be allocated at that time. This will end up being done by "av_extend">, either explicitly:
av_extend(av, len);
or implicitly when the first element is stored:
(void)av_store(av, 0, sv);
Unused array elements are typically initialized by "av_extend".
Of course the array can be extended later should it become necessary.
"size" must be at least 1.
"size" must be at least 1.
The following examples all result in an array that can fit four elements (indexes 0 .. 3):
AV *av = newAV();
av_extend(av, 3);
AV *av = newAV_alloc_x(4);
AV *av = newAV_alloc_xz(4);
In contrast, the following examples allocate an array that is only guaranteed to fit one element without extending:
AV *av = newAV_alloc_x(1);
AV *av = newAV_alloc_xz(1);
AV * newAV () AV * Perl_newAV (pTHX) AV * newAV_mortal () AV * newAV_alloc_x (SSize_t size) AV * newAV_alloc_xz(SSize_t size)
Perl equivalent: "my @new_array = @existing_array;"
AV * newAVav( AV *oav) AV * Perl_newAVav(pTHX_ AV *oav)
Perl equivalent: "my @new_array = %existing_hash;"
AV * newAVhv( HV *ohv) AV * Perl_newAVhv(pTHX_ HV *ohv)
Null AV pointer.
(deprecated - use "(AV *)NULL" instead)
Approximate Perl equivalent: "&{"$sub_name"}(@$argv)".
NOTE: the perl_call_argv() form is deprecated.
SSize_t call_argv( const char *sub_name, I32 flags,
char **argv)
SSize_t Perl_call_argv(pTHX_ const char *sub_name, I32 flags,
char **argv)
NOTE: the perl_call_method() form is deprecated.
SSize_t call_method( const char *methname, I32 flags) SSize_t Perl_call_method(pTHX_ const char *methname, I32 flags)
NOTE: the perl_call_pv() form is deprecated.
SSize_t call_pv( const char *sub_name, I32 flags) SSize_t Perl_call_pv(pTHX_ const char *sub_name, I32 flags)
If neither the "G_METHOD" nor "G_METHOD_NAMED" flag is supplied, the SV may be any of a CV, a GV, a reference to a CV, a reference to a GV or SvPV(sv) will be used as the name of the sub to call.
If the "G_METHOD" flag is supplied, the SV may be a reference to a CV or SvPV(sv) will be used as the name of the method to call.
If the "G_METHOD_NAMED" flag is supplied, SvPV(sv) will be used as the name of the method to call.
Some other values are treated specially for internal use and should not be depended on.
See perlcall.
NOTE: the perl_call_sv() form is deprecated.
SSize_t call_sv( SV *sv, I32 flags) SSize_t Perl_call_sv(pTHX_ SV *sv, I32 flags)
ENTER;
ENTER_with_name("name");
NOTE: the perl_eval_pv() form is deprecated.
SV * eval_pv( const char *p, I32 croak_on_error) SV * Perl_eval_pv(pTHX_ const char *p, I32 croak_on_error)
The "G_RETHROW" flag can be used if you only need eval_sv() to execute code specified by a string, but not catch any errors.
By default the code is compiled and executed with the default hints, such as strict and features. Set "G_USEHINTS" in flags to use the current hints from "PL_curcop".
NOTE: the perl_eval_sv() form is deprecated.
SSize_t eval_sv( SV *sv, I32 flags) SSize_t Perl_eval_sv(pTHX_ SV *sv, I32 flags)
FREETMPS;
A backward-compatible version of "GIMME_V" which can only return "G_SCALAR" or "G_LIST"; in a void context, it returns "G_SCALAR". Deprecated. Use "GIMME_V" instead.
U32 GIMME
U32 GIMME_V
I32 is_lvalue_sub() I32 Perl_is_lvalue_sub(pTHX)
LEAVE;
LEAVE_with_name("name");
The "coderef" argument determines the type of function that will be called. If it is SvROK() it is assumed to be a reference to a CV and will arrange for the coderef to be called. If it is not SvROK() then it is assumed to be a SvIV() which is SvIOK() whose value is a pointer to a C function of type "DESTRUCTORFUNC_t" created using PTR2INT(). Either way the "args" parameter will be provided to the callback as a parameter, although the rules for doing so differ between the Perl and C mode. Normally this function is only used directly for the Perl case and the wrapper mortal_destructor_x() is used for the C function case.
When operating in Perl callback mode the "args" parameter may be NULL in which case the code reference is called with no arguments, otherwise if it is an AV (SvTYPE(args) == SVt_PVAV) then the contents of the AV will be used as the arguments to the code reference, and if it is any other type then the "args" SV will be provided as a single argument to the code reference.
When operating in a C callback mode the "args" parameter will be passed directly to the C function as a "void *" pointer. No additional processing of the argument will be performed, and it is the callers responsibility to free the "args" parameter if necessary.
Be aware that there is a significant difference in timing between the end of the current statement and the end of the current pseudo block. If you are looking for a mechanism to trigger a function at the end of the current pseudo block you should look at ""SAVEDESTRUCTOR_X"" in perlapi instead of this function.
void mortal_destructor_sv( SV *coderef, SV *args) void Perl_mortal_destructor_sv(pTHX_ SV *coderef, SV *args)
MORTALDESTRUCTOR_SV(SV *coderef, SV *args) MORTALSVFUNC_X (SVFUNC_t f, SV *sv)
In "save_aelem", the SV at C**sptr> will be replaced by a new "undef" scalar. That scalar will inherit any magic from the original **sptr, and any 'set' magic will be processed.
In "save_aelem_flags", "SAVEf_KEEPOLDELEM" being set in "flags" causes the function to forgo all that: the scalar at **sptr is untouched. If "SAVEf_KEEPOLDELEM" is not set, the SV at C**sptr> will be replaced by a new "undef" scalar. That scalar will inherit any magic from the original **sptr. Any 'set' magic will be processed if and only if "SAVEf_SETMAGIC" is set in in "flags".
void save_aelem ( AV *av, SSize_t idx, SV **sptr)
void save_aelem_flags( AV *av, SSize_t idx, SV **sptr,
const U32 flags)
void Perl_save_aelem_flags(pTHX_ AV *av, SSize_t idx, SV **sptr,
const U32 flags)
void save_aptr( AV **aptr) void Perl_save_aptr(pTHX_ AV **aptr) AV * save_ary ( GV *gv) AV * Perl_save_ary (pTHX_ GV *gv) HV * save_hash( GV *gv) HV * Perl_save_hash(pTHX_ GV *gv)
In "save_helem", the SV at C**sptr> will be replaced by a new "undef" scalar. That scalar will inherit any magic from the original **sptr, and any 'set' magic will be processed.
In "save_helem_flags", "SAVEf_KEEPOLDELEM" being set in "flags" causes the function to forgo all that: the scalar at **sptr is untouched. If "SAVEf_KEEPOLDELEM" is not set, the SV at C**sptr> will be replaced by a new "undef" scalar. That scalar will inherit any magic from the original **sptr. Any 'set' magic will be processed if and only if "SAVEf_SETMAGIC" is set in in "flags".
void save_helem ( HV *hv, SV *key, SV **sptr)
void save_helem_flags( HV *hv, SV *key, SV **sptr,
const U32 flags)
void Perl_save_helem_flags(pTHX_ HV *hv, SV *key, SV **sptr,
const U32 flags)
void save_hptr ( HV **hptr)
void Perl_save_hptr (pTHX_ HV **hptr)
void save_item ( SV *item)
void Perl_save_item (pTHX_ SV *item)
SV * save_scalar ( GV *gv)
SV * Perl_save_scalar (pTHX_ GV *gv)
SV * save_svref ( SV **sptr)
SV * Perl_save_svref (pTHX_ SV **sptr)
SAVEBOOL ( bool i)
SAVEDELETE ( HV * hv, char * key,
I32 length)
SAVEDESTRUCTOR ( DESTRUCTORFUNC_NOCONTEXT_t f,
void *p)
SAVEDESTRUCTOR_X( DESTRUCTORFUNC_t f, void *p)
SAVEFREEOP ( OP *op)
SAVEFREEPV ( char *pv)
SAVEFREERCPV ( char *pv)
SAVEFREESV ( SV* sv)
SAVEGENERICSV ( char **psv)
SAVEINT ( int i)
SAVEIV ( IV i)
SAVEI8 ( I8 i)
SAVEI16 ( I16 i)
SAVEI32 ( I32 i)
SAVEMORTALIZESV ( SV* sv)
SAVEPPTR ( char * p)
SAVERCPV ( char *pv)
SAVESPTR ( SV * s)
SAVESTACK_POS ()
SAVESTRLEN ( STRLEN i)
SAVETMPS;
bool cBOOL(bool expr)
IV I_V(NV what)
I32 I_32(NV what)
type INT2PTR(type, int value) IV PTR2IV (void * ptr) IV PTR2nat(void *) NV PTR2NV (void * ptr) unsigned long PTR2ul (void *) UV PTR2UV (void * ptr)
UV U_V(NV what)
U32 U_32(NV what)
Perl uses "full" Unicode case mappings. This means that converting a single character to another case may result in a sequence of more than one character. For example, the uppercase of "ß" (LATIN SMALL LETTER SHARP S) is the two character sequence "SS". This presents some complications The lowercase of all characters in the range 0..255 is a single character, and thus "toLOWER_L1" is furnished. But, "toUPPER_L1" can't exist, as it couldn't return a valid result for all legal inputs. Instead "toUPPER_uvchr" has an API that does allow every possible legal result to be returned.) Likewise no other function that is crippled by not being able to give the correct results for the full range of possible inputs has been implemented here.
The differences in the forms are what domain they operate on, and whether the input is specified as a code point (those forms with a "cp" parameter) or as a UTF-8 string (the others). In the latter case, the code point to use is the first one in the buffer of UTF-8 encoded code points, delineated by the arguments "p .. e - 1".
"toFOLD" and "toFOLD_A" are synonyms of each other. They return the foldcase of any ASCII-range code point. In this range, the foldcase is identical to the lowercase. All other inputs are returned unchanged. Since these are macros, the input type may be any integral one, and the output will occupy the same number of bits as the input.
There is no "toFOLD_L1" nor "toFOLD_LATIN1" as the foldcase of some code points in the 0..255 range is above that range or consists of multiple characters. Instead use "toFOLD_uvchr".
"toFOLD_uvchr" returns the foldcase of any Unicode code point. The return value is identical to that of "toFOLD_A" for input code points in the ASCII range. The foldcase of the vast majority of Unicode code points is the same as the code point itself. For these, and for code points above the legal Unicode maximum, this returns the input code point unchanged. It additionally stores the UTF-8 of the result into the buffer beginning at "s", and its length in bytes into *lenp. The caller must have made "s" large enough to contain at least "UTF8_MAXBYTES_CASE+1" bytes to avoid possible overflow.
NOTE: the foldcase of a code point may be more than one code point. The return value of this function is only the first of these. The entire foldcase is returned in "s". To determine if the result is more than a single code point, you can do something like this:
uc = toFOLD_uvchr(cp, s, &len);
if (len > UTF8SKIP(s)) { is multiple code points }
else { is a single code point }
"toFOLD_utf8" and "toFOLD_utf8_safe" are synonyms of each other. The only difference between these and "toFOLD_uvchr" is that the source for these is encoded in UTF-8, instead of being a code point. It is passed as a buffer starting at "p", with "e" pointing to one byte beyond its end. The "p" buffer may certainly contain more than one code point; but only the first one (up through "e - 1") is examined. If the UTF-8 for the input character is malformed in some way, the program may croak, or the function may return the REPLACEMENT CHARACTER, at the discretion of the implementation, and subject to change in future releases.
UV toFOLD (UV cp) UV toFOLD_A (UV cp) UV toFOLD_utf8 (U8* p, U8* e, U8* s, STRLEN* lenp) UV toFOLD_utf8_safe(U8* p, U8* e, U8* s, STRLEN* lenp) UV toFOLD_uvchr (UV cp, U8* s, STRLEN* lenp)
"toLOWER" and "toLOWER_A" are synonyms of each other. They return the lowercase of any uppercase ASCII-range code point. All other inputs are returned unchanged. Since these are macros, the input type may be any integral one, and the output will occupy the same number of bits as the input.
"toLOWER_L1" and "toLOWER_LATIN1" are synonyms of each other. They behave identically as "toLOWER" for ASCII-range input. But additionally will return the lowercase of any uppercase code point in the entire 0..255 range, assuming a Latin-1 encoding (or the EBCDIC equivalent on such platforms).
"toLOWER_LC" returns the lowercase of the input code point according to the rules of the current POSIX locale. Input code points outside the range 0..255 are returned unchanged.
"toLOWER_uvchr" returns the lowercase of any Unicode code point. The return value is identical to that of "toLOWER_L1" for input code points in the 0..255 range. The lowercase of the vast majority of Unicode code points is the same as the code point itself. For these, and for code points above the legal Unicode maximum, this returns the input code point unchanged. It additionally stores the UTF-8 of the result into the buffer beginning at "s", and its length in bytes into *lenp. The caller must have made "s" large enough to contain at least "UTF8_MAXBYTES_CASE+1" bytes to avoid possible overflow.
NOTE: the lowercase of a code point may be more than one code point. The return value of this function is only the first of these. The entire lowercase is returned in "s". To determine if the result is more than a single code point, you can do something like this:
uc = toLOWER_uvchr(cp, s, &len);
if (len > UTF8SKIP(s)) { is multiple code points }
else { is a single code point }
"toLOWER_utf8" and "toLOWER_utf8_safe" are synonyms of each other. The only difference between these and "toLOWER_uvchr" is that the source for these is encoded in UTF-8, instead of being a code point. It is passed as a buffer starting at "p", with "e" pointing to one byte beyond its end. The "p" buffer may certainly contain more than one code point; but only the first one (up through "e - 1") is examined. If the UTF-8 for the input character is malformed in some way, the program may croak, or the function may return the REPLACEMENT CHARACTER, at the discretion of the implementation, and subject to change in future releases.
UV toLOWER (UV cp) UV toLOWER_A (UV cp) UV toLOWER_LATIN1 (UV cp) UV toLOWER_LC (UV cp) UV toLOWER_L1 (UV cp) UV toLOWER_utf8 (U8* p, U8* e, U8* s, STRLEN* lenp) UV toLOWER_utf8_safe(U8* p, U8* e, U8* s, STRLEN* lenp) UV toLOWER_uvchr (UV cp, U8* s, STRLEN* lenp)
"toTITLE" and "toTITLE_A" are synonyms of each other. They return the titlecase of any lowercase ASCII-range code point. In this range, the titlecase is identical to the uppercase. All other inputs are returned unchanged. Since these are macros, the input type may be any integral one, and the output will occupy the same number of bits as the input.
There is no "toTITLE_L1" nor "toTITLE_LATIN1" as the titlecase of some code points in the 0..255 range is above that range or consists of multiple characters. Instead use "toTITLE_uvchr".
"toTITLE_uvchr" returns the titlecase of any Unicode code point. The return value is identical to that of "toTITLE_A" for input code points in the ASCII range. The titlecase of the vast majority of Unicode code points is the same as the code point itself. For these, and for code points above the legal Unicode maximum, this returns the input code point unchanged. It additionally stores the UTF-8 of the result into the buffer beginning at "s", and its length in bytes into *lenp. The caller must have made "s" large enough to contain at least "UTF8_MAXBYTES_CASE+1" bytes to avoid possible overflow.
NOTE: the titlecase of a code point may be more than one code point. The return value of this function is only the first of these. The entire titlecase is returned in "s". To determine if the result is more than a single code point, you can do something like this:
uc = toTITLE_uvchr(cp, s, &len);
if (len > UTF8SKIP(s)) { is multiple code points }
else { is a single code point }
"toTITLE_utf8" and "toTITLE_utf8_safe" are synonyms of each other. The only difference between these and "toTITLE_uvchr" is that the source for these is encoded in UTF-8, instead of being a code point. It is passed as a buffer starting at "p", with "e" pointing to one byte beyond its end. The "p" buffer may certainly contain more than one code point; but only the first one (up through "e - 1") is examined. If the UTF-8 for the input character is malformed in some way, the program may croak, or the function may return the REPLACEMENT CHARACTER, at the discretion of the implementation, and subject to change in future releases.
UV toTITLE (UV cp) UV toTITLE_A (UV cp) UV toTITLE_utf8 (U8* p, U8* e, U8* s, STRLEN* lenp) UV toTITLE_utf8_safe(U8* p, U8* e, U8* s, STRLEN* lenp) UV toTITLE_uvchr (UV cp, U8* s, STRLEN* lenp)
"toUPPER" and "toUPPER_A" are synonyms of each other. They return the uppercase of any lowercase ASCII-range code point. All other inputs are returned unchanged. Since these are macros, the input type may be any integral one, and the output will occupy the same number of bits as the input.
There is no "toUPPER_L1" nor "toUPPER_LATIN1" as the uppercase of some code points in the 0..255 range is above that range or consists of multiple characters. Instead use "toUPPER_uvchr".
"toUPPER_uvchr" returns the uppercase of any Unicode code point. The return value is identical to that of "toUPPER_A" for input code points in the ASCII range. The uppercase of the vast majority of Unicode code points is the same as the code point itself. For these, and for code points above the legal Unicode maximum, this returns the input code point unchanged. It additionally stores the UTF-8 of the result into the buffer beginning at "s", and its length in bytes into *lenp. The caller must have made "s" large enough to contain at least "UTF8_MAXBYTES_CASE+1" bytes to avoid possible overflow.
NOTE: the uppercase of a code point may be more than one code point. The return value of this function is only the first of these. The entire uppercase is returned in "s". To determine if the result is more than a single code point, you can do something like this:
uc = toUPPER_uvchr(cp, s, &len);
if (len > UTF8SKIP(s)) { is multiple code points }
else { is a single code point }
"toUPPER_utf8" and "toUPPER_utf8_safe" are synonyms of each other. The only difference between these and "toUPPER_uvchr" is that the source for these is encoded in UTF-8, instead of being a code point. It is passed as a buffer starting at "p", with "e" pointing to one byte beyond its end. The "p" buffer may certainly contain more than one code point; but only the first one (up through "e - 1") is examined. If the UTF-8 for the input character is malformed in some way, the program may croak, or the function may return the REPLACEMENT CHARACTER, at the discretion of the implementation, and subject to change in future releases.
UV toUPPER (UV cp) UV toUPPER_A (UV cp) UV toUPPER_utf8 (U8* p, U8* e, U8* s, STRLEN* lenp) UV toUPPER_utf8_safe(U8* p, U8* e, U8* s, STRLEN* lenp) UV toUPPER_uvchr (UV cp, U8* s, STRLEN* lenp)
This section is about functions (really macros) that classify characters into types, such as punctuation versus alphabetic, etc. Most of these are analogous to regular expression character classes. (See "POSIX Character Classes" in perlrecharclass.) There are several variants for each class. (Not all macros have all variants; each item below lists the ones valid for it.) None are affected by "use bytes", and only the ones with "LC" in the name are affected by the current locale.
The base function, e.g., isALPHA(), takes any signed or unsigned value, treating it as a code point, and returns a boolean as to whether or not the character represented by it is (or on non-ASCII platforms, corresponds to) an ASCII character in the named class based on platform, Unicode, and Perl rules. If the input is a number that doesn't fit in an octet, FALSE is returned.
Variant "isFOO_A" (e.g., isALPHA_A()) is identical to the base function with no suffix "_A". This variant is used to emphasize by its name that only ASCII-range characters can return TRUE.
Variant "isFOO_L1" imposes the Latin-1 (or EBCDIC equivalent) character set onto the platform. That is, the code points that are ASCII are unaffected, since ASCII is a subset of Latin-1. But the non-ASCII code points are treated as if they are Latin-1 characters. For example, isWORDCHAR_L1() will return true when called with the code point 0xDF, which is a word character in both ASCII and EBCDIC (though it represents different characters in each). If the input is a number that doesn't fit in an octet, FALSE is returned. (Perl's documentation uses a colloquial definition of Latin-1, to include all code points below 256.)
Variant "isFOO_uvchr" is exactly like the "isFOO_L1" variant, for inputs below 256, but if the code point is larger than 255, Unicode rules are used to determine if it is in the character class. For example, isWORDCHAR_uvchr(0x100) returns TRUE, since 0x100 is LATIN CAPITAL LETTER A WITH MACRON in Unicode, and is a word character.
Variants "isFOO_utf8" and "isFOO_utf8_safe" are like "isFOO_uvchr", but are used for UTF-8 encoded strings. The two forms are different names for the same thing. Each call to one of these classifies the first character of the string starting at "p". The second parameter, "e", points to anywhere in the string beyond the first character, up to one byte past the end of the entire string. Although both variants are identical, the suffix "_safe" in one name emphasizes that it will not attempt to read beyond "e - 1", provided that the constraint "s < e" is true (this is asserted for in "-DDEBUGGING" builds). If the UTF-8 for the input character is malformed in some way, the program may croak, or the function may return FALSE, at the discretion of the implementation, and subject to change in future releases.
Variant "isFOO_LC" is like the "isFOO_A" and "isFOO_L1" variants, but the result is based on the current locale, which is what "LC" in the name stands for. If Perl can determine that the current locale is a UTF-8 locale, it uses the published Unicode rules; otherwise, it uses the C library function that gives the named classification. For example, isDIGIT_LC() when not in a UTF-8 locale returns the result of calling isdigit(). FALSE is always returned if the input won't fit into an octet. On some platforms where the C library function is known to be defective, Perl changes its result to follow the POSIX standard's rules.
Variant "isFOO_LC_uvchr" acts exactly like "isFOO_LC" for inputs less than 256, but for larger ones it returns the Unicode classification of the code point.
Variants "isFOO_LC_utf8" and "isFOO_LC_utf8_safe" are like "isFOO_LC_uvchr", but are used for UTF-8 encoded strings. The two forms are different names for the same thing. Each call to one of these classifies the first character of the string starting at "p". The second parameter, "e", points to anywhere in the string beyond the first character, up to one byte past the end of the entire string. Although both variants are identical, the suffix "_safe" in one name emphasizes that it will not attempt to read beyond "e - 1", provided that the constraint "s < e" is true (this is asserted for in "-DDEBUGGING" builds). If the UTF-8 for the input character is malformed in some way, the program may croak, or the function may return FALSE, at the discretion of the implementation, and subject to change in future releases.
They are provided for backward compatibility, even though a word character includes more than the standard C language meaning of alphanumeric. To get the C language definition, use the corresponding ""isALPHANUMERIC"" variant.
bool isALNUM (UV ch) bool isALNUM_A (UV ch) bool isALNUM_LC (UV ch) bool isALNUM_LC_uvchr(UV ch)
The "C" suffix in the names was meant to indicate that they correspond to the C language "isalnum(3)".
bool isALNUMC (UV ch) bool isALNUMC_A (UV ch) bool isALNUMC_LC (UV ch) bool isALNUMC_LC_uvchr(UV ch) bool isALNUMC_L1 (UV ch)
bool isALPHA (UV ch) bool isALPHA_A (UV ch) bool isALPHA_LC (UV ch) bool isALPHA_LC_utf8_safe(U8 * s, U8 *end) bool isALPHA_LC_uvchr (UV ch) bool isALPHA_L1 (UV ch) bool isALPHA_utf8 (U8 * s, U8 * end) bool isALPHA_utf8_safe (U8 * s, U8 * end) bool isALPHA_uvchr (UV ch)
bool isALPHANUMERIC (UV ch) bool isALPHANUMERIC_A (UV ch) bool isALPHANUMERIC_LC (UV ch) bool isALPHANUMERIC_LC_utf8_safe(U8 * s, U8 *end) bool isALPHANUMERIC_LC_uvchr (UV ch) bool isALPHANUMERIC_L1 (UV ch) bool isALPHANUMERIC_utf8 (U8 * s, U8 * end) bool isALPHANUMERIC_utf8_safe (U8 * s, U8 * end) bool isALPHANUMERIC_uvchr (UV ch)
Also note, that because all ASCII characters are UTF-8 invariant (meaning they have the exact same representation (always a single byte) whether encoded in UTF-8 or not), "isASCII" will give the correct results when called with any byte in any string encoded or not in UTF-8. And similarly "isASCII_utf8" and "isASCII_utf8_safe" will work properly on any string encoded or not in UTF-8.
bool isASCII (UV ch) bool isASCII_A (UV ch) bool isASCII_LC (UV ch) bool isASCII_LC_utf8_safe(U8 * s, U8 *end) bool isASCII_LC_uvchr (UV ch) bool isASCII_L1 (UV ch) bool isASCII_utf8 (U8 * s, U8 * end) bool isASCII_utf8_safe (U8 * s, U8 * end) bool isASCII_uvchr (UV ch)
bool isBLANK (UV ch) bool isBLANK_A (UV ch) bool isBLANK_LC (UV ch) bool isBLANK_LC_utf8_safe(U8 * s, U8 *end) bool isBLANK_LC_uvchr (UV ch) bool isBLANK_L1 (UV ch) bool isBLANK_utf8 (U8 * s, U8 * end) bool isBLANK_utf8_safe (U8 * s, U8 * end) bool isBLANK_uvchr (UV ch)
bool isCNTRL (UV ch) bool isCNTRL_A (UV ch) bool isCNTRL_LC (UV ch) bool isCNTRL_LC_utf8_safe(U8 * s, U8 *end) bool isCNTRL_LC_uvchr (UV ch) bool isCNTRL_L1 (UV ch) bool isCNTRL_utf8 (U8 * s, U8 * end) bool isCNTRL_utf8_safe (U8 * s, U8 * end) bool isCNTRL_uvchr (UV ch)
bool isDIGIT (UV ch) bool isDIGIT_A (UV ch) bool isDIGIT_LC (UV ch) bool isDIGIT_LC_utf8_safe(U8 * s, U8 *end) bool isDIGIT_LC_uvchr (UV ch) bool isDIGIT_L1 (UV ch) bool isDIGIT_utf8 (U8 * s, U8 * end) bool isDIGIT_utf8_safe (U8 * s, U8 * end) bool isDIGIT_uvchr (UV ch)
bool isGRAPH (UV ch) bool isGRAPH_A (UV ch) bool isGRAPH_LC (UV ch) bool isGRAPH_LC_utf8_safe(U8 * s, U8 *end) bool isGRAPH_LC_uvchr (UV ch) bool isGRAPH_L1 (UV ch) bool isGRAPH_utf8 (U8 * s, U8 * end) bool isGRAPH_utf8_safe (U8 * s, U8 * end) bool isGRAPH_uvchr (UV ch)
bool isIDCONT (UV ch) bool isIDCONT_A (UV ch) bool isIDCONT_LC (UV ch) bool isIDCONT_LC_utf8_safe(U8 * s, U8 *end) bool isIDCONT_LC_uvchr (UV ch) bool isIDCONT_L1 (UV ch) bool isIDCONT_utf8 (U8 * s, U8 * end) bool isIDCONT_utf8_safe (U8 * s, U8 * end) bool isIDCONT_uvchr (UV ch)
bool isIDFIRST (UV ch) bool isIDFIRST_A (UV ch) bool isIDFIRST_LC (UV ch) bool isIDFIRST_LC_utf8_safe(U8 * s, U8 *end) bool isIDFIRST_LC_uvchr (UV ch) bool isIDFIRST_L1 (UV ch) bool isIDFIRST_utf8 (U8 * s, U8 * end) bool isIDFIRST_utf8_safe (U8 * s, U8 * end) bool isIDFIRST_uvchr (UV ch)
bool isLOWER (UV ch) bool isLOWER_A (UV ch) bool isLOWER_LC (UV ch) bool isLOWER_LC_utf8_safe(U8 * s, U8 *end) bool isLOWER_LC_uvchr (UV ch) bool isLOWER_L1 (UV ch) bool isLOWER_utf8 (U8 * s, U8 * end) bool isLOWER_utf8_safe (U8 * s, U8 * end) bool isLOWER_uvchr (UV ch)
bool isOCTAL (UV ch) bool isOCTAL_A (UV ch) bool isOCTAL_L1(UV ch)
bool isPRINT (UV ch) bool isPRINT_A (UV ch) bool isPRINT_LC (UV ch) bool isPRINT_LC_utf8_safe(U8 * s, U8 *end) bool isPRINT_LC_uvchr (UV ch) bool isPRINT_L1 (UV ch) bool isPRINT_utf8 (U8 * s, U8 * end) bool isPRINT_utf8_safe (U8 * s, U8 * end) bool isPRINT_uvchr (UV ch)
bool isPSXSPC (UV ch) bool isPSXSPC_A (UV ch) bool isPSXSPC_LC (UV ch) bool isPSXSPC_LC_utf8_safe(U8 * s, U8 *end) bool isPSXSPC_LC_uvchr (UV ch) bool isPSXSPC_L1 (UV ch) bool isPSXSPC_utf8 (U8 * s, U8 * end) bool isPSXSPC_utf8_safe (U8 * s, U8 * end) bool isPSXSPC_uvchr (UV ch)
bool isPUNCT (UV ch) bool isPUNCT_A (UV ch) bool isPUNCT_LC (UV ch) bool isPUNCT_LC_utf8_safe(U8 * s, U8 *end) bool isPUNCT_LC_uvchr (UV ch) bool isPUNCT_L1 (UV ch) bool isPUNCT_utf8 (U8 * s, U8 * end) bool isPUNCT_utf8_safe (U8 * s, U8 * end) bool isPUNCT_uvchr (UV ch)
bool isSPACE (UV ch) bool isSPACE_A (UV ch) bool isSPACE_LC (UV ch) bool isSPACE_LC_utf8_safe(U8 * s, U8 *end) bool isSPACE_LC_uvchr (UV ch) bool isSPACE_L1 (UV ch) bool isSPACE_utf8 (U8 * s, U8 * end) bool isSPACE_utf8_safe (U8 * s, U8 * end) bool isSPACE_uvchr (UV ch)
bool isUPPER (UV ch) bool isUPPER_A (UV ch) bool isUPPER_LC (UV ch) bool isUPPER_LC_utf8_safe(U8 * s, U8 *end) bool isUPPER_LC_uvchr (UV ch) bool isUPPER_L1 (UV ch) bool isUPPER_utf8 (U8 * s, U8 * end) bool isUPPER_utf8_safe (U8 * s, U8 * end) bool isUPPER_uvchr (UV ch)
See the top of this section for an explanation of the variants.
"isWORDCHAR_A", "isWORDCHAR_L1", "isWORDCHAR_uvchr", "isWORDCHAR_LC", "isWORDCHAR_LC_uvchr", "isWORDCHAR_LC_utf8", and "isWORDCHAR_LC_utf8_safe" are also as described there, but additionally include the platform's native underscore.
bool isWORDCHAR (UV ch) bool isWORDCHAR_A (UV ch) bool isWORDCHAR_LC (UV ch) bool isWORDCHAR_LC_utf8_safe(U8 * s, U8 *end) bool isWORDCHAR_LC_uvchr (UV ch) bool isWORDCHAR_L1 (UV ch) bool isWORDCHAR_utf8 (U8 * s, U8 * end) bool isWORDCHAR_utf8_safe (U8 * s, U8 * end) bool isWORDCHAR_uvchr (UV ch)
bool isXDIGIT (UV ch) bool isXDIGIT_A (UV ch) bool isXDIGIT_LC (UV ch) bool isXDIGIT_LC_utf8_safe(U8 * s, U8 *end) bool isXDIGIT_LC_uvchr (UV ch) bool isXDIGIT_L1 (UV ch) bool isXDIGIT_utf8 (U8 * s, U8 * end) bool isXDIGIT_utf8_safe (U8 * s, U8 * end) bool isXDIGIT_uvchr (UV ch)
static inline (c99)
static __inline__ (gcc -ansi)
static __inline (MSVC)
static _inline (older MSVC)
static (c89 compilers)
__ASSERT_(bool expr)
ASSUME(bool expr)
dNOOP;
Example usage:
EXTERN_C int flock(int fd, int op);
LIKELY(bool expr)
NOOP;
PERL_UNUSED_ARG(void x);
PERL_UNUSED_CONTEXT;
Example usage:
Signal_t
Perl_perly_sighandler(int sig, Siginfo_t *sip PERL_UNUSED_DECL,
void *uap PERL_UNUSED_DECL, bool safe)
PERL_UNUSED_RESULT(foo(a, b))
The main reason for this is that the combination of "gcc -Wunused-result" (part of "-Wall") and the "__attribute__((warn_unused_result))" cannot be silenced with casting to "void". This causes trouble when the system header files use the attribute.
Use "PERL_UNUSED_RESULT" sparingly, though, since usually the warning is there for a good reason: you might lose success/failure information, or leak resources, or changes in resources.
But sometimes you just want to ignore the return value, e.g., on codepaths soon ending up in abort, or in "best effort" attempts, or in situations where there is no good way to handle failures.
Sometimes "PERL_UNUSED_RESULT" might not be the most natural way: another possibility is that you can capture the return value and use "PERL_UNUSED_VAR" on that.
PERL_UNUSED_RESULT(void x)
PERL_UNUSED_VAR(void x);
if (x) STMT_START { ... } STMT_END else ...
Note that you can't return a value out of this construct and cannot use it as an operand to the comma operator. These limit its utility.
But, a value could be returned by constructing the API so that a pointer is passed and the macro dereferences this to set the return. If the value can be any of various types, depending on context, you can handle that situation in some situations by adding the type of the return as an extra accompanying parameter:
#define foo(param, type) STMT_START {
type * param; *param = do_calc; ...
} STMT_END
This could be awkward, so consider instead using a C language "static inline" function.
If you do use this construct, it is easy to forget that it is a macro and not a function, and hence fall into traps that might not show up until someone someday writes code which contains names that clash with the ones you chose here, or calls it with a parameter which is an expression with side effects, the consequences of which you didn't think about. See "Writing safer macros" in perlhacktips for how to avoid these.
UNLIKELY(bool expr)
Temporarily disable an entry in this BHK structure, by clearing the appropriate flag. "which" is a preprocessor token indicating which entry to disable.
void BhkDISABLE(BHK *hk, token which)
Re-enable an entry in this BHK structure, by setting the appropriate flag. "which" is a preprocessor token indicating which entry to enable. This will assert (under -DDEBUGGING) if the entry doesn't contain a valid pointer.
void BhkENABLE(BHK *hk, token which)
Set an entry in the BHK structure, and set the flags to indicate it is valid. "which" is a preprocessing token indicating which entry to set. The type of "ptr" depends on the entry.
void BhkENTRY_set(BHK *hk, token which, void *ptr)
Register a set of hooks to be called when the Perl lexical scope changes at compile time. See "Compile-time scope hooks" in perlguts.
void Perl_blockhook_register(pTHX_ BHK *hk)
Now a no-op.
void CPERLscope(void x)
#ifdef I_MACH_CTHREADS
#include <mach_cthreads.h>
#endif
#ifdef I_PTHREAD
#include <pthread.h>
#endif
Returns the label attached to a cop, and stores its length in bytes into *len. Upon return, *flags will be set to either "SVf_UTF8" or 0.
Alternatively, use the macro "CopLABEL_len_flags"; or if you don't need to know if the label is UTF-8 or not, the macro "CopLABEL_len"; or if you additionally don't need to know the length, "CopLABEL".
const char * cop_fetch_label( COP * const cop,
STRLEN *len, U32 *flags)
const char * Perl_cop_fetch_label(pTHX_ COP * const cop,
STRLEN *len, U32 *flags)
The forms differ in how the key is specified. In all forms, the key is pointed to by "key". In the plain "pv" form, the key is a C language NUL-terminated string. In the "pvs" form, the key is a C language string literal. In the "pvn" form, an additional parameter, "keylen", specifies the length of the string, which hence, may contain embedded-NUL characters. In the "sv" form, *key is an SV, and the key is the PV extracted from that. using "SvPV_const".
"hash" is a precomputed hash of the key string, or zero if it has not been precomputed. This parameter is omitted from the "pvs" form, as it is computed automatically at compile time.
The only flag currently used from the "flags" parameter is "COPHH_KEY_UTF8". It is illegal to set this in the "sv" form. In the "pv*" forms, it specifies whether the key octets are interpreted as UTF-8 (if set) or as Latin-1 (if cleared). The "sv" form uses the underlying SV to determine the UTF-8ness of the octets.
bool cop_hints_exists_pv (const COP *cop, const char *key,
U32 hash, U32 flags)
bool cop_hints_exists_pvn(const COP *cop, const char *key,
STRLEN keylen, U32 hash, U32 flags)
bool cop_hints_exists_pvs(const COP *cop, "key", U32 flags)
bool cop_hints_exists_sv (const COP *cop, SV *key, U32 hash,
U32 flags)
The forms differ in how the key is specified. In the plain "pv" form, the key is a C language NUL-terminated string. In the "pvs" form, the key is a C language string literal. In the "pvn" form, an additional parameter, "keylen", specifies the length of the string, which hence, may contain embedded-NUL characters. In the "sv" form, *key is an SV, and the key is the PV extracted from that. using "SvPV_const".
"hash" is a precomputed hash of the key string, or zero if it has not been precomputed. This parameter is omitted from the "pvs" form, as it is computed automatically at compile time.
The only flag currently used from the "flags" parameter is "COPHH_KEY_UTF8". It is illegal to set this in the "sv" form. In the "pv*" forms, it specifies whether the key octets are interpreted as UTF-8 (if set) or as Latin-1 (if cleared). The "sv" form uses the underlying SV to determine the UTF-8ness of the octets.
SV * cop_hints_fetch_pv (const COP *cop, const char *key,
U32 hash, U32 flags)
SV * cop_hints_fetch_pvn(const COP *cop, const char *key,
STRLEN keylen, U32 hash, U32 flags)
SV * cop_hints_fetch_pvs(const COP *cop, "key", U32 flags)
SV * cop_hints_fetch_sv (const COP *cop, SV *key, U32 hash,
U32 flags)
HV * cop_hints_2hv(const COP *cop, U32 flags)
Save a label into a "cop_hints_hash". You need to set flags to "SVf_UTF8" for a UTF-8 label. Any other flag is ignored.
void cop_store_label( COP * const cop,
const char *label, STRLEN len,
U32 flags)
void Perl_cop_store_label(pTHX_ COP * const cop,
const char *label, STRLEN len,
U32 flags)
const char * CopFILE(const COP * c)
void CopFILE_copy(COP * dst, COP * src)
void CopFILE_free(COP * c)
const char * CopFILE_LEN(const COP * c)
void CopFILE_set (COP * c, const char * pv) void CopFILE_setn(COP * c, const char * pv, STRLEN len)
AV * CopFILEAV(const COP * c)
AV * CopFILEAVn(const COP * c)
GV * CopFILEGV(const COP * c)
void CopFILEGV_set(COP *c, GV *gv)
SV * CopFILESV(const COP * c)
Make and return a complete copy of the cop hints hash "cophh".
COPHH * cophh_copy(COPHH *cophh)
These delete a key and its associated value from the cop hints hash "cophh", and return the modified hash. The returned hash pointer is in general not the same as the hash pointer that was passed in. The input hash is consumed by the function, and the pointer to it must not be subsequently used. Use "cophh_copy" if you need both hashes.
The forms differ in how the key is specified. In all forms, the key is pointed to by "key". In the plain "pv" form, the key is a C language NUL-terminated string. In the "pvs" form, the key is a C language string literal. In the "pvn" form, an additional parameter, "keylen", specifies the length of the string, which hence, may contain embedded-NUL characters. In the "sv" form, *key is an SV, and the key is the PV extracted from that. using "SvPV_const".
"hash" is a precomputed hash of the key string, or zero if it has not been precomputed. This parameter is omitted from the "pvs" form, as it is computed automatically at compile time.
The only flag currently used from the "flags" parameter is "COPHH_KEY_UTF8". It is illegal to set this in the "sv" form. In the "pv*" forms, it specifies whether the key octets are interpreted as UTF-8 (if set) or as Latin-1 (if cleared). The "sv" form uses the underlying SV to determine the UTF-8ness of the octets.
COPHH * cophh_delete_pv (COPHH *cophh, const char *key,
U32 hash, U32 flags)
COPHH * cophh_delete_pvn(COPHH *cophh, const char *key,
STRLEN keylen, U32 hash, U32 flags)
COPHH * cophh_delete_pvs(COPHH *cophh, "key", U32 flags)
COPHH * cophh_delete_sv (COPHH *cophh, SV *key, U32 hash,
U32 flags)
These look up the hint entry in the cop "cop" with the key specified by "key" (and "keylen" in the "pvn" form), returning true if a value exists, and false otherwise.
The forms differ in how the key is specified. In the plain "pv" form, the key is a C language NUL-terminated string. In the "pvs" form, the key is a C language string literal. In the "pvn" form, an additional parameter, "keylen", specifies the length of the string, which hence, may contain embedded-NUL characters. In the "sv" form, *key is an SV, and the key is the PV extracted from that. using "SvPV_const".
"hash" is a precomputed hash of the key string, or zero if it has not been precomputed. This parameter is omitted from the "pvs" form, as it is computed automatically at compile time.
The only flag currently used from the "flags" parameter is "COPHH_KEY_UTF8". It is illegal to set this in the "sv" form. In the "pv*" forms, it specifies whether the key octets are interpreted as UTF-8 (if set) or as Latin-1 (if cleared). The "sv" form uses the underlying SV to determine the UTF-8ness of the octets.
bool cophh_exists_pvn(const COPHH *cophh, const char *key,
STRLEN keylen, U32 hash, U32 flags)
These look up the entry in the cop hints hash "cophh" with the key specified by "key" (and "keylen" in the "pvn" form), returning that value as a mortal scalar copy, or &PL_sv_placeholder if there is no value associated with the key.
The forms differ in how the key is specified. In the plain "pv" form, the key is a C language NUL-terminated string. In the "pvs" form, the key is a C language string literal. In the "pvn" form, an additional parameter, "keylen", specifies the length of the string, which hence, may contain embedded-NUL characters. In the "sv" form, *key is an SV, and the key is the PV extracted from that. using "SvPV_const".
"hash" is a precomputed hash of the key string, or zero if it has not been precomputed. This parameter is omitted from the "pvs" form, as it is computed automatically at compile time.
The only flag currently used from the "flags" parameter is "COPHH_KEY_UTF8". It is illegal to set this in the "sv" form. In the "pv*" forms, it specifies whether the key octets are interpreted as UTF-8 (if set) or as Latin-1 (if cleared). The "sv" form uses the underlying SV to determine the UTF-8ness of the octets.
SV * cophh_fetch_pv (const COPHH *cophh, const char *key,
U32 hash, U32 flags)
SV * cophh_fetch_pvn(const COPHH *cophh, const char *key,
STRLEN keylen, U32 hash, U32 flags)
SV * cophh_fetch_pvs(const COPHH *cophh, "key", U32 flags)
SV * cophh_fetch_sv (const COPHH *cophh, SV *key, U32 hash,
U32 flags)
Discard the cop hints hash "cophh", freeing all resources associated with it.
void cophh_free(COPHH *cophh)
Generate and return a fresh cop hints hash containing no entries.
COPHH * cophh_new_empty()
These store a value, associated with a key, in the cop hints hash "cophh", and return the modified hash. The returned hash pointer is in general not the same as the hash pointer that was passed in. The input hash is consumed by the function, and the pointer to it must not be subsequently used. Use "cophh_copy" if you need both hashes.
"value" is the scalar value to store for this key. "value" is copied by these functions, which thus do not take ownership of any reference to it, and hence later changes to the scalar will not be reflected in the value visible in the cop hints hash. Complex types of scalar will not be stored with referential integrity, but will be coerced to strings.
The forms differ in how the key is specified. In all forms, the key is pointed to by "key". In the plain "pv" form, the key is a C language NUL-terminated string. In the "pvs" form, the key is a C language string literal. In the "pvn" form, an additional parameter, "keylen", specifies the length of the string, which hence, may contain embedded-NUL characters. In the "sv" form, *key is an SV, and the key is the PV extracted from that. using "SvPV_const".
"hash" is a precomputed hash of the key string, or zero if it has not been precomputed. This parameter is omitted from the "pvs" form, as it is computed automatically at compile time.
The only flag currently used from the "flags" parameter is "COPHH_KEY_UTF8". It is illegal to set this in the "sv" form. In the "pv*" forms, it specifies whether the key octets are interpreted as UTF-8 (if set) or as Latin-1 (if cleared). The "sv" form uses the underlying SV to determine the UTF-8ness of the octets.
COPHH * cophh_store_pv (COPHH *cophh, const char *key, U32 hash,
SV *value, U32 flags)
COPHH * cophh_store_pvn(COPHH *cophh, const char *key,
STRLEN keylen, U32 hash, SV *value,
U32 flags)
COPHH * cophh_store_pvs(COPHH *cophh, "key", SV *value,
U32 flags)
COPHH * cophh_store_sv (COPHH *cophh, SV *key, U32 hash,
SV *value, U32 flags)
Generates and returns a standard Perl hash representing the full set of key/value pairs in the cop hints hash "cophh". "flags" is currently unused and must be zero.
HV * cophh_2hv(const COPHH *cophh, U32 flags)
"CopLABEL_len" and "CopLABEL_len_flags" additionally store the number of bytes comprising the returned label into *len.
"CopLABEL_len_flags" additionally returns the UTF-8ness of the returned label, by setting *flags to 0 or "SVf_UTF8".
const char * CopLABEL (COP *const cop)
const char * CopLABEL_len (COP *const cop, STRLEN *len)
const char * CopLABEL_len_flags(COP *const cop, STRLEN *len,
U32 *flags)
line_t CopLINE(const COP * c)
HV * CopSTASH(const COP * c)
bool CopSTASH_eq(const COP * c, const HV * hv)
bool CopSTASH_set(COP * c, HV * hv)
char * CopSTASHPV(const COP * c)
void CopSTASHPV_set(COP * c, const char * pv)
On threaded perls, each thread has an independent copy of this variable; each initialized at creation time with the current value of the creating thread's copy.
COP* PL_curcop
RCPV * RCPV_LEN(char *pv)
RCPV * RCPV_REFCNT_dec(char *pv)
RCPV * RCPV_REFCNT_inc(char *pv)
RCPV * RCPV_REFCOUNT(char *pv)
RCPV * RCPVx(char *pv)
void Perl_custom_op_register(pTHX_ Perl_ppaddr_t ppaddr,
const XOP *xop)
const XOP * Perl_custom_op_xop(const OP *o)
void XopDISABLE(XOP *xop, token which)
void XopENABLE(XOP *xop, token which)
XopENTRY(XOP *xop, token which)
void XopENTRY_set(XOP *xop, token which, value)
XopENTRYCUSTOM(const OP *o, token which)
U32 XopFLAGS(XOP *xop)
This section documents functions to manipulate CVs which are code-values, meaning subroutines. For more information, see perlguts.
This function skips over the automatic calls to &DB::sub made on the behalf of the debugger. If the stack frame requested was a sub called by "DB::sub", the return value will be the frame for the call to "DB::sub", since that has the correct line number/etc. for the call site. If dbcxp is non-"NULL", it will be set to a pointer to the frame for the sub call itself.
const PERL_CONTEXT * caller_cx(I32 level,
const PERL_CONTEXT **dbcxp)
const PERL_CONTEXT * Perl_caller_cx(pTHX_ I32 level,
const PERL_CONTEXT **dbcxp)
I32 * CvDEPTH(const CV * const sv) I32 * Perl_CvDEPTH(const CV * const sv)
GV * CvGV( CV *sv) GV * Perl_CvGV(pTHX_ CV *sv)
CV * CvREFCNT_inc (CV *cv) CV * CvREFCNT_inc_simple (CV *cv) CV * CvREFCNT_inc_simple_NN(CV *cv)
This also has a special use with XS AUTOLOAD subs. See "Autoloading with XSUBs" in perlguts.
HV* CvSTASH(CV* cv)
CV * find_runcv( U32 *db_seqp) CV * Perl_find_runcv(pTHX_ U32 *db_seqp)
The forms differ only in how the subroutine is specified.. With "get_cvs", the name is a literal C string, enclosed in double quotes. With "get_cv", the name is given by the "name" parameter, which must be a NUL-terminated C string. With "get_cvn_flags", the name is also given by the "name" parameter, but it is a Perl string (possibly containing embedded NUL bytes), and its length in bytes is contained in the "len" parameter.
NOTE: the perl_get_cv() form is deprecated.
CV * get_cv ( const char *name, I32 flags)
CV * Perl_get_cv (pTHX_ const char *name, I32 flags)
CV * get_cvn_flags( const char *name, STRLEN len,
I32 flags)
CV * Perl_get_cvn_flags(pTHX_ const char *name, STRLEN len,
I32 flags)
CV * get_cvs ( "name", I32 flags)
Null CV pointer.
(deprecated - use "(CV *)NULL" instead)
void av_dump( AV *av) void Perl_av_dump(pTHX_ AV *av)
If the "v" (verbose) debugging option is in effect, the process id is also printed.
"deb" and "deb_nocontext" differ only in that "deb_nocontext" does not take a thread context ("aTHX") parameter, so is used in situations where the caller doesn't already have the thread context.
"vdeb" is the same as "deb" except "args" are an encapsulated argument list.
void Perl_deb (pTHX_ const char *pat, ...) void deb_nocontext( const char *pat, ...) void Perl_deb_nocontext( const char *pat, ...) void vdeb ( const char *pat, va_list *args) void Perl_vdeb (pTHX_ const char *pat, va_list *args)
I32 debstack() I32 Perl_debstack(pTHX)
void dump_all() void Perl_dump_all(pTHX)
Returns true if a backtrace could be retrieved, false if not.
bool dump_c_backtrace( PerlIO *fp, int max_depth,
int skip)
bool Perl_dump_c_backtrace(pTHX_ PerlIO *fp, int max_depth,
int skip)
void dump_eval() void Perl_dump_eval(pTHX)
void dump_form( const GV *gv) void Perl_dump_form(pTHX_ const GV *gv)
void dump_packsubs( const HV *stash) void Perl_dump_packsubs(pTHX_ const HV *stash)
void dump_sub( const GV *gv) void Perl_dump_sub(pTHX_ const GV *gv)
The appended output looks like:
...
1 10e004812:0082 Perl_croak util.c:1716 /usr/bin/perl
2 10df8d6d2:1d72 perl_parse perl.c:3975 /usr/bin/perl
...
The fields are tab-separated. The first column is the depth (zero being the innermost non-skipped frame). In the hex:offset, the hex is where the program counter was in "S_parse_body", and the :offset (might be missing) tells how much inside the "S_parse_body" the program counter was.
The "util.c:1716" is the source code file and line number.
The /usr/bin/perl is obvious (hopefully).
Unknowns are "-". Unknowns can happen unfortunately quite easily: if the platform doesn't support retrieving the information; if the binary is missing the debug information; if the optimizer has transformed the code by for example inlining.
SV * get_c_backtrace_dump( int max_depth, int skip) SV * Perl_get_c_backtrace_dump(pTHX_ int max_depth, int skip)
void gv_dump( GV *gv) void Perl_gv_dump(pTHX_ GV *gv)
void hv_dump( HV *hv) void Perl_hv_dump(pTHX_ HV *hv)
void magic_dump( const MAGIC *mg) void Perl_magic_dump(pTHX_ const MAGIC *mg)
OPclass op_class( const OP *o) OPclass Perl_op_class(pTHX_ const OP *o)
void op_dump( const OP *o) void Perl_op_dump(pTHX_ const OP *o)
This function handles indentation after linefeeds, so message strings passed in should not account for it themselves. Multiple lines may be passed to this function at once, or a single line may be split across multiple calls.
void Perl_opdump_printf(pTHX_ struct Perl_OpDumpContext *ctx,
const char *pat, ...)
runops_proc_t PL_runops
void pmop_dump( PMOP *pm) void Perl_pmop_dump(pTHX_ PMOP *pm)
"sv_dump_depth" is a more flexible variant of "sv_dump", taking an extra parameter giving the maximum depth to dump.
"sv_dump" is limited to dumping items to a depth of 4 if the item is an SvROK, and dumping only the top level item otherwise. This means that it will not dump the contents of an "AV *" or "HV *". For that use "av_dump" or "hv_dump".
For an example of its output, see Devel::Peek.
In contrast, "sv_dump_depth" can be used on any SV derived type (GV, HV, AV) with an appropriate cast:
HV *hv = ...;
sv_dump_depth((SV*)hv, 2);
would dump the hv, its keys and values, but would not recurse into any RV values.
void sv_dump ( SV *sv) void Perl_sv_dump (pTHX_ SV *sv) void sv_dump_depth( SV *sv, I32 depth) void Perl_sv_dump_depth(pTHX_ SV *sv, I32 depth)
(char *) form(const char* pat, ...)
They can be used any place a string (char *) is required:
char * s = form_nocontext("%d.%d", major, minor);
They each return a temporary that will be freed "soon", automatically by the system, at the same time that SVs operated on by "sv_2mortal" are freed.
Use the result immediately, or copy to a stable place for longer retention. This is contrary to the incorrect previous documentation of these that claimed that the return was a single per-thread buffer. That was (and is) actually true only when these are called during global destruction.
"form" and "form_nocontext" differ only in that "form_nocontext" does not take a thread context ("aTHX") parameter, so is used in situations where the caller doesn't already have the thread context (and can be called without the "Perl_" prefix.
"vform" is the same as "form" except the arguments are an encapsulated argument list. It does need a thread context parameter, but that is supplied automatically when called without the "Perl_" prefix.
char * Perl_form (pTHX_ const char *pat, ...) char * form_nocontext( const char *pat, ...) char * Perl_form_nocontext( const char *pat, ...) char * vform ( const char *pat, va_list *args) char * Perl_vform (pTHX_ const char *pat, va_list *args)
"mess" and "mess_nocontext" differ only in that "mess_nocontext" does not take a thread context ("aTHX") parameter, so is used in situations where the caller doesn't already have the thread context.
"vmess" is the same as "mess" except the arguments are an encapsulated argument list. It needs a thread context parameter only when called with the "Perl_" prefix.
Normally, the resulting message is returned in a new mortal SV. But during global destruction a single SV may be shared between uses of this function.
SV * Perl_mess (pTHX_ const char *pat, ...) SV * mess_nocontext( const char *pat, ...) SV * Perl_mess_nocontext( const char *pat, ...) SV * vmess ( const char *pat, va_list *args) SV * Perl_vmess (pTHX_ const char *pat, va_list *args)
"basemsg" is the initial message or object. If it is a reference, it will be used as-is and will be the result of this function. Otherwise it is used as a string, and if it already ends with a newline, it is taken to 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 "at foo.pl line 37" will be appended, and possibly other clauses indicating the current state of execution. The resulting message will end with a dot 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 this function. If "consume" is true, then the function is permitted (but not required) to modify and return "basemsg" instead of allocating a new SV.
SV * mess_sv( SV *basemsg, bool consume) SV * Perl_mess_sv(pTHX_ SV *basemsg, bool consume)
pv_escape(dsv,pv,cur,pvlim,PERL_PV_ESCAPE_QUOTE);
except that an additional "\0" will be appended to the string when len > cur and pv[cur] is "\0".
Note that the final string may be up to 7 chars longer than pvlim.
char * pv_display( SV *dsv, const char *pv,
STRLEN cur, STRLEN len,
STRLEN pvlim)
char * Perl_pv_display(pTHX_ SV *dsv, const char *pv,
STRLEN cur, STRLEN len,
STRLEN pvlim)
If flags contains "PERL_PV_ESCAPE_QUOTE" then any double quotes in the string will 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 UTF-8. If "PERL_PV_ESCAPE_UNI_DETECT" is set then the input string is scanned using is_utf8_string() to determine if it is UTF-8.
If "PERL_PV_ESCAPE_ALL" is set then all input chars will be output using "\x01F1" style escapes, otherwise if "PERL_PV_ESCAPE_NONASCII" is set, only non-ASCII chars will be escaped using this style; otherwise, only chars above 255 will be so escaped; other non printable chars will use octal or common escaped patterns like "\n". Otherwise, if "PERL_PV_ESCAPE_NOBACKSLASH" then all chars below 255 will be treated as printable and will be output as literals. The "PERL_PV_ESCAPE_NON_WC" modifies the previous rules to cause word chars, unicode or otherwise, to be output as literals, note this uses the *unicode* rules for deciding on word characters.
If "PERL_PV_ESCAPE_FIRSTCHAR" is set then only the first char of the string will be escaped, regardless of max. If the output is to be in hex, then it will be returned as a plain hex sequence. 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 "%" and not a "\\". This is because regexes very often contain backslashed sequences, whereas "%" is not a particularly common character in patterns.
Returns a pointer to the escaped text as held by "dsv".
char * pv_escape( SV *dsv, char const * const str,
const STRLEN count, STRLEN max,
STRLEN * const escaped, U32 flags)
char * Perl_pv_escape(pTHX_ SV *dsv, char const * const str,
const STRLEN count, STRLEN max,
STRLEN * const escaped, U32 flags)
If the "PERL_PV_PRETTY_QUOTE" flag is set then the result will be double quoted with any double quotes in the string escaped. Otherwise if the "PERL_PV_PRETTY_LTGT" flag is set then the result be wrapped in angle brackets.
If the "PERL_PV_PRETTY_ELLIPSES" flag is set and not all characters in string were output then an ellipsis "..." will be appended to the string. Note that this happens AFTER it has been quoted.
If "start_color" is non-null then it will be inserted after the opening quote (if there is one) but before the escaped text. If "end_color" is non-null then it will be inserted after the escaped text but before any quotes or ellipses.
Returns a pointer to the prettified text as held by "dsv".
char * pv_pretty( SV *dsv, char const * const str,
const STRLEN count,
const STRLEN max,
char const * const start_color,
char const * const end_color,
const U32 flags)
char * Perl_pv_pretty(pTHX_ SV *dsv, char const * const str,
const STRLEN count,
const STRLEN max,
char const * const start_color,
char const * const end_color,
const U32 flags)
Note that under threads, "fn" may run multiple times. This is because the list is executed each time the current or any descendent thread terminates.
void call_atexit( ATEXIT_t fn, void *ptr) void Perl_call_atexit(pTHX_ ATEXIT_t fn, void *ptr)
CV * cv_clone( CV *proto) CV * Perl_cv_clone(pTHX_ CV *proto)
An SV may be passed as a second argument. If so, the name will be assigned to it and it will be returned. Otherwise the returned SV will be a new mortal.
If "flags" has the "CV_NAME_NOTQUAL" bit set, then the package name will not be included. If the first argument is neither a CV nor a GV, this flag is ignored (subject to change).
SV * cv_name( NOCHECK CV *cv, SV *sv, U32 flags) SV * Perl_cv_name(pTHX_ NOCHECK CV *cv, SV *sv, U32 flags)
void cv_undef( CV *cv) void Perl_cv_undef(pTHX_ CV *cv)
SV * find_rundefsv() SV * Perl_find_rundefsv(pTHX)
Return a pointer to the array of all the descriptions of the various OPs Given an opcode from the enum in opcodes.h, "PL_op_desc[opcode]" returns a pointer to a C language string giving its description.
char ** get_op_descs() char ** Perl_get_op_descs(pTHX)
Return a pointer to the array of all the names of the various OPs Given an opcode from the enum in opcodes.h, "PL_op_name[opcode]" returns a pointer to a C language string giving its name.
char ** get_op_names() char ** Perl_get_op_names(pTHX)
U32 intro_my() U32 Perl_intro_my(pTHX)
If "PERL_LOADMOD_NOIMPORT" is set, the module is loaded as if with an empty import list, as in "use Foo::Bar ()"; this is the only circumstance in which the trailing optional arguments may be omitted entirely. Otherwise, if "PERL_LOADMOD_IMPORT_OPS" is set, the trailing arguments must consist of exactly one "OP*", containing the op tree that produces the relevant import arguments. Otherwise, the trailing arguments must all be "SV*" values that will be used as import arguments; and the list must be terminated with "(SV*) NULL". If neither "PERL_LOADMOD_NOIMPORT" nor "PERL_LOADMOD_IMPORT_OPS" is set, the trailing "NULL" pointer is needed even if no import arguments are desired. The reference count for each specified "SV*" argument is decremented. In addition, the "name" argument is modified.
If "PERL_LOADMOD_DENY" is set, the module is loaded as if with "no" rather than "use".
"load_module" and "load_module_nocontext" have the same apparent signature, but the former hides the fact that it is accessing a thread context parameter. So use the latter when you get a compilation error about "pTHX".
void load_module ( U32 flags, SV *name,
SV *ver, ...)
void Perl_load_module (pTHX_ U32 flags, SV *name,
SV *ver, ...)
void load_module_nocontext( U32 flags, SV *name,
SV *ver, ...)
void Perl_load_module_nocontext( U32 flags, SV *name,
SV *ver, ...)
void my_exit( U32 status) void Perl_my_exit(pTHX_ U32 status)
On non-VMS platforms, this is essentially equivalent to ""my_exit"", using "errno", but forces an en error code of 255 if "errno" is 0.
On VMS, it takes care to set the appropriate severity bits in the exit status.
void my_failure_exit() void Perl_my_failure_exit(pTHX)
Creates a new pad name list. "max" is the highest index for which space is allocated.
PADNAMELIST * newPADNAMELIST(size_t max) PADNAMELIST * Perl_newPADNAMELIST(size_t max)
Constructs and returns a new pad name. Only use this function for names that refer to outer lexicals. (See also "newPADNAMEpvn".) "outer" is the outer pad name that this one mirrors. The returned pad name has the "PADNAMEf_OUTER" flag already set.
PADNAME * newPADNAMEouter(PADNAME *outer) PADNAME * Perl_newPADNAMEouter(PADNAME *outer)
Constructs and returns a new pad name. "s" must be a UTF-8 string. Do not use this for pad names that point to outer lexicals. See "newPADNAMEouter".
PADNAME * newPADNAMEpvn(const char *s, STRLEN len) PADNAME * Perl_newPADNAMEpvn(const char *s, STRLEN len)
int nothreadhook() int Perl_nothreadhook(pTHX)
One reference count is stolen, so you may need to do SvREFCNT_inc(func).
"optype" should be an opcode indicating the type of operation that the pad entry is to support. This doesn't affect operational semantics, but is used for debugging.
PADOFFSET pad_add_anon( CV *func, I32 optype) PADOFFSET Perl_pad_add_anon(pTHX_ CV *func, I32 optype)
They differ only in how the input variable's name is specified.
If "typestash" is non-null, the name is for a typed lexical, and this identifies the type. If "ourstash" is non-null, it's a lexical reference to a package variable, and this identifies the package. The following flags can be OR'ed together:
padadd_OUR redundantly specifies if it's a package var
padadd_STATE variable will retain value persistently
padadd_NO_DUP_CHECK skip check for lexical shadowing
padadd_FIELD specifies that the lexical is a field for a class
In all forms, the variable name must include the leading sigil.
In "pad_add_name_sv", the input name is taken from the SV parameter using ""SvPVutf8"()".
In "pad_add_name_pv", the input name is a NUL-terminated string, which must be encoded in UTF-8.
In "pad_add_name_pvn", "namelen" gives the length of the input name in bytes, which means it may contain embedded NUL characters. Again, it must be encoded in UTF-8.
PADOFFSET pad_add_name_pv ( const char *name,
const U32 flags,
HV *typestash,
HV *ourstash)
PADOFFSET Perl_pad_add_name_pv (pTHX_ const char *name,
const U32 flags,
HV *typestash,
HV *ourstash)
PADOFFSET pad_add_name_pvn( const char *namepv,
STRLEN namelen, U32 flags,
HV *typestash,
HV *ourstash)
PADOFFSET Perl_pad_add_name_pvn(pTHX_ const char *namepv,
STRLEN namelen, U32 flags,
HV *typestash,
HV *ourstash)
PADOFFSET pad_add_name_sv ( SV *name, U32 flags,
HV *typestash,
HV *ourstash)
PADOFFSET Perl_pad_add_name_sv (pTHX_ SV *name, U32 flags,
HV *typestash,
HV *ourstash)
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:
SVs_PADMY named lexical variable ("my", "our", "state")
SVs_PADTMP unnamed temporary store
SVf_READONLY constant shared between recursion levels
"SVf_READONLY" has been supported here only since perl 5.20. To work with earlier versions as well, use "SVf_READONLY|SVs_PADTMP". "SVf_READONLY" does not cause the SV in the pad slot to be marked read-only, but simply tells "pad_alloc" that it will be made read-only (by the caller), or at least should be treated as such.
"optype" should be an opcode indicating the type of operation that the pad entry is to support. This doesn't affect operational semantics, but is used for debugging.
PADOFFSET pad_alloc( I32 optype, U32 tmptype) PADOFFSET Perl_pad_alloc(pTHX_ I32 optype, U32 tmptype)
If it is not in the current pad but appears in the pad of any lexically enclosing scope, then a pseudo-entry for it is added in the current pad.
These each return the offset in the current pad, or "NOT_IN_PAD" if no such lexical is in scope.
The forms differ only in how the variable's name is specified.
In "pad_findmy_pvs", the variable name is a C language string literal, enclosed in double quotes.
In plain "pad_findmy_pv", the variable name is a C language NUL-terminated string.
In "pad_findmy_pvn", "len" gives the length of the variable name in bytes, so it may contain embedded-NUL characters. The caller must make sure "namepv" contains at least "len" bytes.
In "pad_findmy_sv", the variable name is taken from the SV parameter using ""SvPVutf8"()".
"flags" is reserved and must be zero.
PADOFFSET pad_findmy_pv ( const char *name, U32 flags)
PADOFFSET Perl_pad_findmy_pv (pTHX_ const char *name, U32 flags)
PADOFFSET pad_findmy_pvn( const char *namepv,
STRLEN namelen, U32 flags)
PADOFFSET Perl_pad_findmy_pvn(pTHX_ const char *namepv,
STRLEN namelen, U32 flags)
PADOFFSET pad_findmy_pvs( "name", U32 flags)
PADOFFSET pad_findmy_sv ( SV *name, U32 flags)
PADOFFSET Perl_pad_findmy_sv (pTHX_ SV *name, U32 flags)
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 anonsub prototypes; give it a @_; mark temporaries as such. "type" indicates the kind of subroutine:
padtidy_SUB ordinary subroutine
padtidy_SUBCLONE prototype for lexical closure
padtidy_FORMAT format
void pad_tidy( padtidy_type type) void Perl_pad_tidy(pTHX_ padtidy_type type)
Fetches the pad name from the given index.
PADNAME * padnamelist_fetch(PADNAMELIST *pnl, SSize_t key) PADNAME * Perl_padnamelist_fetch(PADNAMELIST *pnl, SSize_t key)
Stores the pad name (which may be null) at the given index, freeing any existing pad name in that slot.
PADNAME ** padnamelist_store( PADNAMELIST *pnl,
SSize_t key,
PADNAME *val)
PADNAME ** Perl_padnamelist_store(pTHX_ PADNAMELIST *pnl,
SSize_t key,
PADNAME *val)
PerlInterpreter * perl_alloc()
void PERL_ASYNC_CHECK()
"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 is ready to run at the exact same point as the previous one. The pseudo-fork code uses "COPY_STACKS" while the threads->create doesn't.
"CLONEf_KEEP_PTR_TABLE" - "perl_clone" keeps a ptr_table with the pointer of the old variable as a key and the new variable as a value, this allows it to check if something has been cloned and not clone it again, but rather just use the value and increase the refcount. If "KEEP_PTR_TABLE" is not set then "perl_clone" will kill the ptr_table using the function "ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;". A reason to keep it around is if you want to dup some of your own variables which are outside the graph that perl scans.
"CLONEf_CLONE_HOST" - This is a win32 thing, it is ignored on unix, it tells perl's win32host code (which is c++) to clone itself, this is needed on win32 if you want to run two threads at the same time, if you just want to do some stuff in a separate perl interpreter and then throw it away and return to the original one, you don't need to do anything.
PerlInterpreter * perl_clone(PerlInterpreter *proto_perl,
UV flags)
void perl_construct(PerlInterpreter *my_perl)
"my_perl" points to the Perl interpreter. It must have been previously created through the use of "perl_alloc" and "perl_construct". It may have been initialised through "perl_parse", and may have been used through "perl_run" and other means. This function should be called for any Perl interpreter that has been constructed with "perl_construct", even if subsequent operations on it failed, for example if "perl_parse" returned a non-zero value.
If the interpreter's "PL_exit_flags" word has the "PERL_EXIT_DESTRUCT_END" flag set, then this function will execute code in "END" blocks before performing the rest of destruction. If it is desired to make any use of the interpreter between "perl_parse" and "perl_destruct" other than just calling "perl_run", then this flag should be set early on. This matters if "perl_run" will not be called, or if anything else will be done in addition to calling "perl_run".
Returns a value be a suitable value to pass to the C library function "exit" (or to return from "main"), to serve as an exit code indicating the nature of the way the interpreter terminated. This takes into account any failure of "perl_parse" and any early exit from "perl_run". The exit code is of the type required by the host operating system, so because of differing exit code conventions it is not portable to interpret specific numeric values as having specific meanings.
int perl_destruct(PerlInterpreter *my_perl)
void perl_free(PerlInterpreter *my_perl)
PerlInterpreter* PERL_GET_CONTEXT
"my_perl" points to the Perl interpreter that is to parse the script. It must have been previously created through the use of "perl_alloc" and "perl_construct". "xsinit" points to a callback function that will be called to set up the ability for this Perl interpreter to load XS extensions, or may be null to perform no such setup.
"argc" and "argv" supply a set of command-line arguments to the Perl interpreter, as would normally be passed to the "main" function of a C program. "argv[argc]" must be null. These arguments are where the script to parse is specified, either by naming a script file or by providing a script in a "-e" option. If $0 will be written to in the Perl interpreter, then the argument strings must be in writable memory, and so mustn't just be string constants.
"env" specifies a set of environment variables that will be used by this Perl interpreter. If non-null, it must point to a null-terminated array of environment strings. If null, the Perl interpreter will use the environment supplied by the "environ" global variable.
This function initialises the interpreter, and parses and compiles the script specified by the command-line arguments. This includes executing code in "BEGIN", "UNITCHECK", and "CHECK" blocks. It does not execute "INIT" blocks or the main program.
Returns an integer of slightly tricky interpretation. The correct use of the return value is as a truth value indicating whether there was a failure in initialisation. If zero is returned, this indicates that initialisation was successful, and it is safe to proceed to call "perl_run" and make other use of it. If a non-zero value is returned, this indicates some problem that means the interpreter wants to terminate. The interpreter should not be just abandoned upon such failure; the caller should proceed to shut the interpreter down cleanly with "perl_destruct" and free it with "perl_free".
For historical reasons, the non-zero return value also attempts to be a suitable value to pass to the C library function "exit" (or to return from "main"), to serve as an exit code indicating the nature of the way initialisation terminated. However, this isn't portable, due to differing exit code conventions. An attempt is made to return an exit code of the type required by the host operating system, but because it is constrained to be non-zero, it is not necessarily possible to indicate every type of exit. It is only reliable on Unix, where a zero exit code can be augmented with a set bit that will be ignored. In any case, this function is not the correct place to acquire an exit code: one should get that from "perl_destruct".
int perl_parse(PerlInterpreter *my_perl, XSINIT_t xsinit,
int argc, char **argv, char **env)
"my_perl" points to the Perl interpreter. It must have been previously created through the use of "perl_alloc" and "perl_construct", and initialised through "perl_parse". This function should not be called if "perl_parse" returned a non-zero value, indicating a failure in initialisation or compilation.
This function executes code in "INIT" blocks, and then executes the main program. The code to be executed is that established by the prior call to "perl_parse". If the interpreter's "PL_exit_flags" word does not have the "PERL_EXIT_DESTRUCT_END" flag set, then this function will also execute code in "END" blocks. If it is desired to make any further use of the interpreter after calling this function, then "END" blocks should be postponed to "perl_destruct" time by setting that flag.
Returns an integer of slightly tricky interpretation. The correct use of the return value is as a truth value indicating whether the program terminated non-locally. If zero is returned, this indicates that the program ran to completion, and it is safe to make other use of the interpreter (provided that the "PERL_EXIT_DESTRUCT_END" flag was set as described above). If a non-zero value is returned, this indicates that the interpreter wants to terminate early. The interpreter should not be just abandoned because of this desire to terminate; the caller should proceed to shut the interpreter down cleanly with "perl_destruct" and free it with "perl_free".
For historical reasons, the non-zero return value also attempts to be a suitable value to pass to the C library function "exit" (or to return from "main"), to serve as an exit code indicating the nature of the way the program terminated. However, this isn't portable, due to differing exit code conventions. An attempt is made to return an exit code of the type required by the host operating system, but because it is constrained to be non-zero, it is not necessarily possible to indicate every type of exit. It is only reliable on Unix, where a zero exit code can be augmented with a set bit that will be ignored. In any case, this function is not the correct place to acquire an exit code: one should get that from "perl_destruct".
int perl_run(PerlInterpreter *my_perl)
void PERL_SET_CONTEXT(PerlInterpreter* i)
They differ in that "PERL_SYS_INIT3" also initializes "env".
void PERL_SYS_INIT (int *argc, char*** argv) void PERL_SYS_INIT3(int *argc, char*** argv, char*** env)
void PERL_SYS_TERM()
If set, END blocks are executed when the interpreter is destroyed. This is normally set by perl itself after the interpreter is constructed.
Call abort() on exit. This is used internally by perl itself to abort if exit is called while processing exit.
Warn on exit.
Set by the "exit" in perlfunc operator.
U8 PL_exit_flags
Possible values:
If $ENV{PERL_DESTRUCT_LEVEL} is set to an integer greater than the value of "PL_perl_destruct_level" its value is used instead.
On threaded perls, each thread has an independent copy of this variable; each initialized at creation time with the current value of the creating thread's copy.
signed char PL_perl_destruct_level
void * ptr_table_fetch( PTR_TBL_t * const tbl,
const void * const sv)
void * Perl_ptr_table_fetch(pTHX_ PTR_TBL_t * const tbl,
const void * const sv)
void ptr_table_free( PTR_TBL_t * const tbl) void Perl_ptr_table_free(pTHX_ PTR_TBL_t * const tbl)
PTR_TBL_t * ptr_table_new() PTR_TBL_t * Perl_ptr_table_new(pTHX)
void ptr_table_split( PTR_TBL_t * const tbl) void Perl_ptr_table_split(pTHX_ PTR_TBL_t * const tbl)
The names "old" and "new" are specific to the core's typical use of ptr_tables in thread cloning.
void ptr_table_store( PTR_TBL_t * const tbl,
const void * const oldsv,
void * const newsv)
void Perl_ptr_table_store(pTHX_ PTR_TBL_t * const tbl,
const void * const oldsv,
void * const newsv)
NOTE: the perl_require_pv() form is deprecated.
void require_pv( const char *pv) void Perl_require_pv(pTHX_ const char *pv)
void vload_module( U32 flags, SV *name, SV *ver,
va_list *args)
void Perl_vload_module(pTHX_ U32 flags, SV *name, SV *ver,
va_list *args)
If "tgtsv" is non-null then the string will be written into that SV (overwriting existing content) and it will be returned. If "tgtsv" is a null pointer then the string will be written into a new mortal SV which will be returned.
The message will be taken from whatever locale would be used by $!, and will be encoded in the SV in whatever manner would be used by $!. The details of this process are subject to future change. Currently, the message is taken from the C locale by default (usually producing an English message), and from the currently selected locale when in the scope of the "use locale" pragma. A heuristic attempt is made to decode the message from the locale's character encoding, but it will only be decoded as either UTF-8 or ISO-8859-1. It is always correctly decoded in a UTF-8 locale, usually in an ISO-8859-1 locale, and never in any other locale.
The SV is always returned containing an actual string, and with no other OK bits set. Unlike $!, a message is even yielded for "errnum" zero (meaning success), and if no useful message is available then a useless string (currently empty) is returned.
SV * sv_string_from_errnum( int errnum, SV *tgtsv) SV * Perl_sv_string_from_errnum(pTHX_ int errnum, SV *tgtsv)
dXCPT;
void JMPENV_JUMP (int v) void JMPENV_PUSH (int v) OP * PL_restartop
XCPT_RETHROW;
Also see "List of capability HAS_foo symbols".
void * FILE_base(FILE * f)
Size_t FILE_bufsiz(FILE *f)
Size_t FILE_cnt(FILE * f)
void * FILE_ptr(FILE * f)
extern off_t lseek(int, off_t, int);
#ifdef I_FCNTL
#include <fcntl.h>
#endif
#ifdef I_SYS_DIR
#include <sys_dir.h>
#endif
#ifdef I_SYS_FILE
#include <sys_file.h>
#endif
#ifdef I_SYS_NDIR
#include <sys_ndir.h>
#endif
#ifdef I_SYS_STATFS
#include <sys_statfs.h>
#endif
Also "List of capability HAS_foo symbols" lists capabilities that arent in this section. For example "HAS_ASINH", for the hyperbolic sine function.
0 = ok
1 = couldn't cast < 0
2 = couldn't cast >= 0x80000000
4 = couldn't cast in argument expression list
d_Gconvert='gconvert((x),(n),(t),(b))'
d_Gconvert='gcvt((x),(n),(b))'
d_Gconvert='sprintf((b),"%.*g",(n),(x))'
The last two assume trailing zeros should not be kept.
char * Gconvert(double x, Size_t n, bool t, char * b)
FP_PLUS_NORM Positive normalized, nonzero
FP_MINUS_NORM Negative normalized, nonzero
FP_PLUS_DENORM Positive denormalized, nonzero
FP_MINUS_DENORM Negative denormalized, nonzero
FP_PLUS_ZERO +0.0
FP_MINUS_ZERO -0.0
FP_PLUS_INF +INF
FP_MINUS_INF -INF
FP_NANS Signaling Not a Number (NaNS)
FP_NANQ Quiet Not a Number (NaNQ)
FP_SNAN Signaling NaN (Not-a-Number)
FP_QNAN Quiet NaN (Not-a-Number)
FP_POS_INF +infinity
FP_NEG_INF -infinity
FP_POS_NORM Positive normalized
FP_NEG_NORM Negative normalized
FP_POS_DENORM Positive denormalized
FP_NEG_DENORM Negative denormalized
FP_POS_ZERO +0.0 (positive zero)
FP_NEG_ZERO -0.0 (negative zero)
FP_NORMAL Normalized
FP_ZERO Zero
FP_INFINITE Infinity
FP_SUBNORMAL Denormalized
FP_NAN NaN
FP_SNAN signaling NaN
FP_QNAN quiet NaN
FP_NINF negative infinity
FP_PINF positive infinity
FP_NDENORM negative denormalized non-zero
FP_PDENORM positive denormalized non-zero
FP_NZERO negative zero
FP_PZERO positive zero
FP_NNORM negative normalized non-zero
FP_PNORM positive normalized non-zero
FP_NORMAL Normalized
FP_ZERO Zero
FP_INFINITE Infinity
FP_SUBNORMAL Denormalized
FP_NAN NaN
FP_SNAN signaling NaN
FP_QNAN quiet NaN
FP_NINF negative infinity
FP_PINF positive infinity
FP_NDENORM negative denormalized non-zero
FP_PDENORM positive denormalized non-zero
FP_NZERO negative zero
FP_PZERO positive zero
FP_NNORM negative normalized non-zero
FP_PNORM positive normalized non-zero
#ifdef I_FENV
#include <fenv.h>
#endif
#ifdef I_QUADMATH
#include <quadmath.h>
#endif
This section contains configuration information not otherwise found in the more specialized sections of this document. At the end is a list of "#defines" whose name should be enough to tell you what they do, and a list of #defines which tell you if you need to "#include" files to get the corresponding functionality.
#ifdef ASCIIish
token CAT2(token x, token y)
double Drand01()
union semun {
int val;
struct semid_ds *buf;
unsigned short *array;
}
#ifdef I_DIRENT
#include <dirent.h>
#endif
#ifdef I_POLL
#include <poll.h>
#endif
#ifdef I_SYS_RESOURCE
#include <sys_resource.h>
#endif
The extension, of the form
({ statement ... })
turns the block consisting of statement ... into an expression with a value, unlike plain C language blocks. This can present optimization possibilities, BUT, unless you know for sure that this will never be compiled without this extension being available and not forbidden, you need to specify an alternative. Thus two code paths have to be maintained, which can get out-of-sync. All these issues are solved by using a "static inline" function instead.
Perl can be configured to not use this feature by passing the parameter "-Accflags=-DPERL_GCC_BRACE_GROUPS_FORBIDDEN" to Configure.
#ifdef PERL_USE_GCC_BRACE_GROUPS
void seedDrand01(Rand_seed_t x)
string STRINGIFY(token x)
This is a list of those symbols that dont appear elsewhere in ths document that indicate if the current platform has a certain capability. Their names all begin with "HAS_". Only those symbols whose capability is directly derived from the name are listed here. All others have their meaning expanded out elsewhere in this document. This (relatively) compact list is because we think that the expansion would add little or no value and take up a lot of space (because there are so many). If you think certain ones should be expanded, send email to perl5-porters@perl.org <mailto:perl5-porters@perl.org>.
Each symbol here will be "#define"d if and only if the platform has the capability. If you need more detail, see the corresponding entry in config.h. For convenience, the list is split so that the ones that indicate there is a reentrant version of a capability are listed separately
"HAS__FWALK", "HAS_ACCEPT4", "HAS_ACCESS", "HAS_ACCESSX", "HAS_ACOSH", "HAS_AINTL", "HAS_ALARM", "HAS_ASINH", "HAS_ATANH", "HAS_ATOLL", "HAS_CBRT", "HAS_CHOWN", "HAS_CHROOT", "HAS_CHSIZE", "HAS_CLEARENV", "HAS_COPYSIGN", "HAS_COPYSIGNL", "HAS_CRYPT", "HAS_CTERMID", "HAS_CUSERID", "HAS_DIRFD", "HAS_DLADDR", "HAS_DLERROR", "HAS_EACCESS", "HAS_ENDHOSTENT", "HAS_ENDNETENT", "HAS_ENDPROTOENT", "HAS_ENDSERVENT", "HAS_ERF", "HAS_ERFC", "HAS_EXPM1", "HAS_EXP2", "HAS_FCHMOD", "HAS_FCHMODAT", "HAS_FCHOWN", "HAS_FD_SET", "HAS_FDIM", "HAS_FEGETROUND", "HAS_FFS", "HAS_FFSL", "HAS_FGETPOS", "HAS_FLOCK", "HAS_FMA", "HAS_FMAX", "HAS_FMIN", "HAS_FORK", "HAS_FSEEKO", "HAS_FSETPOS", "HAS_FSYNC", "HAS_FTELLO", "HAS_GAI_STRERROR", "HAS_GETADDRINFO", "HAS_GETCWD", "HAS_GETESPWNAM", "HAS_GETGROUPS", "HAS_GETHOSTBYADDR", "HAS_GETHOSTBYNAME", "HAS_GETHOSTENT", "HAS_GETLOGIN", "HAS_GETNAMEINFO", "HAS_GETNETBYADDR", "HAS_GETNETBYNAME", "HAS_GETNETENT", "HAS_GETPAGESIZE", "HAS_GETPGID", "HAS_GETPGRP", "HAS_GETPGRP2", "HAS_GETPPID", "HAS_GETPRIORITY", "HAS_GETPROTOBYNAME", "HAS_GETPROTOBYNUMBER", "HAS_GETPROTOENT", "HAS_GETPRPWNAM", "HAS_GETSERVBYNAME", "HAS_GETSERVBYPORT", "HAS_GETSERVENT", "HAS_GETSPNAM", "HAS_HTONL", "HAS_HTONS", "HAS_HYPOT", "HAS_ILOGBL", "HAS_INET_ATON", "HAS_INETNTOP", "HAS_INETPTON", "HAS_IP_MREQ", "HAS_IP_MREQ_SOURCE", "HAS_IPV6_MREQ", "HAS_IPV6_MREQ_SOURCE", "HAS_ISASCII", "HAS_ISBLANK", "HAS_ISLESS", "HAS_KILLPG", "HAS_LCHOWN", "HAS_LINK", "HAS_LINKAT", "HAS_LLROUND", "HAS_LOCKF", "HAS_LOGB", "HAS_LOG1P", "HAS_LOG2", "HAS_LROUND", "HAS_LSTAT", "HAS_MADVISE", "HAS_MBLEN", "HAS_MBRLEN", "HAS_MBRTOWC", "HAS_MBSTOWCS", "HAS_MBTOWC", "HAS_MEMMEM", "HAS_MEMRCHR", "HAS_MKDTEMP", "HAS_MKFIFO", "HAS_MKOSTEMP", "HAS_MKSTEMP", "HAS_MKSTEMPS", "HAS_MMAP", "HAS_MPROTECT", "HAS_MSG", "HAS_MSYNC", "HAS_MUNMAP", "HAS_NEARBYINT", "HAS_NEXTAFTER", "HAS_NICE", "HAS_NTOHL", "HAS_NTOHS", "HAS_PATHCONF", "HAS_PAUSE", "HAS_PHOSTNAME", "HAS_PIPE", "HAS_PIPE2", "HAS_PRCTL", "HAS_PTRDIFF_T", "HAS_READLINK", "HAS_READV", "HAS_RECVMSG", "HAS_REMQUO", "HAS_RENAME", "HAS_RENAMEAT", "HAS_RINT", "HAS_ROUND", "HAS_SCALBNL", "HAS_SEM", "HAS_SENDMSG", "HAS_SETEGID", "HAS_SETENV", "HAS_SETEUID", "HAS_SETGROUPS", "HAS_SETHOSTENT", "HAS_SETLINEBUF", "HAS_SETNETENT", "HAS_SETPGRP", "HAS_SETPGRP2", "HAS_SETPRIORITY", "HAS_SETPROCTITLE", "HAS_SETPROTOENT", "HAS_SETREGID", "HAS_SETRESGID", "HAS_SETRESUID", "HAS_SETREUID", "HAS_SETRGID", "HAS_SETRUID", "HAS_SETSERVENT", "HAS_SETSID", "HAS_SHM", "HAS_SIGACTION", "HAS_SIGPROCMASK", "HAS_SIN6_SCOPE_ID", "HAS_SNPRINTF", "HAS_STAT", "HAS_STRCOLL", "HAS_STRERROR_L", "HAS_STRLCAT", "HAS_STRLCPY", "HAS_STRNLEN", "HAS_STRTOD", "HAS_STRTOL", "HAS_STRTOLL", "HAS_STRTOQ", "HAS_STRTOUL", "HAS_STRTOULL", "HAS_STRTOUQ", "HAS_STRXFRM", "HAS_STRXFRM_L", "HAS_SYMLINK", "HAS_SYS_ERRLIST", "HAS_SYSCALL", "HAS_SYSCONF", "HAS_SYSTEM", "HAS_TCGETPGRP", "HAS_TCSETPGRP", "HAS_TOWLOWER", "HAS_TOWUPPER", "HAS_TRUNCATE", "HAS_TRUNCL", "HAS_UALARM", "HAS_UMASK", "HAS_UNLINKAT", "HAS_UNSETENV", "HAS_VFORK", "HAS_VSNPRINTF", "HAS_WAITPID", "HAS_WAIT4", "HAS_WCRTOMB", "HAS_WCSCMP", "HAS_WCSTOMBS", "HAS_WCSXFRM", "HAS_WCTOMB", "HAS_WRITEV"
And, the reentrant capabilities:
"HAS_CRYPT_R", "HAS_CTERMID_R", "HAS_DRAND48_R", "HAS_ENDHOSTENT_R", "HAS_ENDNETENT_R", "HAS_ENDPROTOENT_R", "HAS_ENDSERVENT_R", "HAS_GETGRGID_R", "HAS_GETGRNAM_R", "HAS_GETHOSTBYADDR_R", "HAS_GETHOSTBYNAME_R", "HAS_GETHOSTENT_R", "HAS_GETLOGIN_R", "HAS_GETNETBYADDR_R", "HAS_GETNETBYNAME_R", "HAS_GETNETENT_R", "HAS_GETPROTOBYNAME_R", "HAS_GETPROTOBYNUMBER_R", "HAS_GETPROTOENT_R", "HAS_GETPWNAM_R", "HAS_GETPWUID_R", "HAS_GETSERVBYNAME_R", "HAS_GETSERVBYPORT_R", "HAS_GETSERVENT_R", "HAS_GETSPNAM_R", "HAS_RANDOM_R", "HAS_READDIR_R", "HAS_SETHOSTENT_R", "HAS_SETNETENT_R", "HAS_SETPROTOENT_R", "HAS_SETSERVENT_R", "HAS_SRANDOM_R", "HAS_SRAND48_R", "HAS_STRERROR_R", "HAS_TMPNAM_R", "HAS_TTYNAME_R"
Example usage:
#ifdef HAS_STRNLEN use strnlen() #else use an alternative implementation #endif
This list contains symbols that indicate if certain "#include" files are present on the platform. If your code accesses the functionality that one of these is for, you will need to "#include" it if the symbol on this list is "#define"d. For more detail, see the corresponding entry in config.h.
"I_ARPA_INET", "I_BFD", "I_CRYPT", "I_DBM", "I_DLFCN", "I_EXECINFO", "I_FP", "I_FP_CLASS", "I_GDBM", "I_GDBM_NDBM", "I_GDBMNDBM", "I_GRP", "I_IEEEFP", "I_INTTYPES", "I_LIBUTIL", "I_MNTENT", "I_NDBM", "I_NET_ERRNO", "I_NETDB", "I_NETINET_IN", "I_NETINET_TCP", "I_PROT", "I_PWD", "I_RPCSVC_DBM", "I_SGTTY", "I_SHADOW", "I_STDBOOL", "I_STDINT", "I_SUNMATH", "I_SYS_ACCESS", "I_SYS_IOCTL", "I_SYS_MOUNT", "I_SYS_PARAM", "I_SYS_POLL", "I_SYS_SECURITY", "I_SYS_SELECT", "I_SYS_STAT", "I_SYS_STATVFS", "I_SYS_SYSCALL", "I_SYS_TIME", "I_SYS_TIME_KERNEL", "I_SYS_TIMES", "I_SYS_TYPES", "I_SYS_UN", "I_SYS_VFS", "I_SYS_WAIT", "I_SYSLOG", "I_SYSMODE", "I_SYSUIO", "I_SYSUTSNAME", "I_TERMIO", "I_TERMIOS", "I_UNISTD", "I_USTAT", "I_VFORK", "I_WCHAR", "I_WCTYPE"
Example usage:
#ifdef I_WCHAR #include <wchar.h> #endif
These variables are global to an entire process. They are shared between all interpreters and all threads in a process. Any variables not documented here may be changed or removed without notice, so don't use them! If you feel you really do need to use an unlisted variable, first send email to perl5-porters@perl.org <mailto:perl5-porters@perl.org>. It may be that someone there will point out a way to accomplish what you need without using an internal variable. But if not, you should get a go-ahead to document and then use the variable.
This array of function pointers is a convenient place to hook into the compilation process. An XS module can put its own custom check function in place of any of the standard ones, to influence the compilation of a particular type of op. However, a custom check function must never fully replace a standard check function (or even a custom check function from another module). A module modifying checking must instead wrap the preexisting check function. A custom check function must be selective about when to apply its custom behaviour. In the usual case where it decides not to do anything special with an op, it must chain the preexisting 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".
NOTE: This API exists entirely for the purpose of making the CPAN module "XS::Parse::Infix" work. It is not expected that additional modules will make use of it; rather, that they should use "XS::Parse::Infix" to provide parsing of new infix operators.
Function pointer, pointing at a function used to handle extended infix operators. The function should be declared as
int infix_plugin_function(pTHX_
char *opname, STRLEN oplen,
struct Perl_custom_infix **infix_ptr)
The function is called from the tokenizer whenever a possible infix operator is seen. "opname" points to the operator name in the parser's input buffer, and "oplen" gives the maximum number of bytes of it that should be consumed; it is not null-terminated. The function is expected to examine the operator name and possibly other state such as %^H, to determine whether it wants to handle the operator name.
As compared to the single stage of "PL_keyword_plugin", parsing of additional infix operators occurs in three separate stages. This is because of the more complex interactions it has with the parser, to ensure that operator precedence rules work correctly. These stages are co-ordinated by the use of an additional information structure.
If the function wants to handle the infix operator, it must set the variable pointed to by "infix_ptr" to the address of a structure that provides this additional information about the subsequent parsing stages. If it does not, it should make a call to the next function in the chain.
This structure has the following definition:
struct Perl_custom_infix {
enum Perl_custom_infix_precedence prec;
void (*parse)(pTHX_ SV **opdata,
struct Perl_custom_infix *);
OP *(*build_op)(pTHX_ SV **opdata, OP *lhs, OP *rhs,
struct Perl_custom_infix *);
};
The function must then return an integer giving the number of bytes consumed by the name of this operator. In the case of an operator whose name is composed of identifier characters, this must be equal to "oplen". In the case of an operator named by non-identifier characters, this is permitted to be shorter than "oplen", and any additional characters after it will not be claimed by the infix operator but instead will be consumed by the tokenizer and parser as normal.
If the optional "parse" function is provided, it is called immediately by the parser to let the operator's definition consume any additional syntax from the source code. This should not be used for normal operand parsing, but it may be useful when implementing things like parametric operators or meta-operators that consume more syntax themselves. This function may use the variable pointed to by "opdata" to provide an SV containing additional data to be passed into the "build_op" function later on.
The information structure gives the operator precedence level in the "prec" field. This is used to tell the parser how much of the surrounding syntax before and after should be considered as operands to the operator.
The tokenizer and parser will then continue to operate as normal until enough additional input has been parsed to form both the left- and right-hand side operands to the operator, according to the precedence level. At this point the "build_op" function is called, being passed the left- and right-hand operands as optree fragments. It is expected to combine them into the resulting optree fragment, which it should return.
After the "build_op" function has returned, if the variable pointed to by "opdata" was set to a non-"NULL" value, it will then be destroyed by calling SvREFCNT_dec().
For thread safety, modules should not set this variable directly. Instead, use the function "wrap_infix_plugin".
However, that all said, the introductory note above still applies. This variable is provided in core perl only for the benefit of the "XS::Parse::Infix" module. That module acts as a central registry for infix operators, automatically handling things like deparse support and discovery/reflection, and these abilities only work because it knows all the registered operators. Other modules should not use this interpreter variable directly to implement them because then those central features would no longer work properly.
Furthermore, it is likely that this (experimental) API will be replaced in a future Perl version by a more complete API that fully implements the central registry and other semantics currently provided by "XS::Parse::Infix", once the module has had sufficient experimental testing time. This current mechanism exists only as an interim measure to get to that stage.
Function pointer, pointing at a function used to handle extended keywords. The function should be declared as
int keyword_plugin_function(pTHX_
char *keyword_ptr, STRLEN keyword_len,
OP **op_ptr)
The function is called from the tokeniser, whenever a possible keyword is seen. "keyword_ptr" points at the word in the parser's input buffer, and "keyword_len" gives its length; it is not null-terminated. The function is expected to examine the word, and possibly other state such as %^H, to decide whether it wants to handle it as an extended keyword. If it does not, the function should return "KEYWORD_PLUGIN_DECLINE", and the normal parser process will continue.
If the function wants to handle the keyword, it first must parse anything following the keyword that is part of the syntax introduced by the keyword. See "Lexer interface" for details.
When a keyword is being handled, the plugin function must build a tree of "OP" structures, representing the code that was parsed. The root of the tree must be stored in *op_ptr. The function then returns a constant indicating the syntactic role of the construct that it has parsed: "KEYWORD_PLUGIN_STMT" if it is a complete statement, or "KEYWORD_PLUGIN_EXPR" if it is an expression. Note that a statement construct cannot be used inside an expression (except via "do BLOCK" and similar), and an expression is not a complete statement (it requires at 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, and so 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 normal compilation. 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 existing handler function. Instead, take a copy of "PL_keyword_plugin" before assigning your own function pointer to it. Your handler function should look for keywords that it is interested in and handle those. Where it is not interested, it should call the saved plugin function, passing on the arguments it received. Thus "PL_keyword_plugin" actually points at a chain of handler functions, all of which have an opportunity to handle keywords, and only the last function in the chain (built into the Perl core) will normally return "KEYWORD_PLUGIN_DECLINE".
For thread safety, modules should not set this variable directly. Instead, use the function "wrap_keyword_plugin".
For example, the following determines whether the interpreter is in global destruction:
if (PL_phase == PERL_PHASE_DESTRUCT) {
// we are in global destruction
}
"PL_phase" was introduced in Perl 5.14; in prior perls you can use "PL_dirty" (boolean) to determine whether the interpreter is in global destruction. (Use of "PL_dirty" is discouraged since 5.14.)
enum perl_phase PL_phase
A GV is a structure which corresponds to a Perl typeglob, i.e., *foo. It is a structure that holds a pointer to a scalar, an array, a hash etc, corresponding to $foo, @foo, %foo.
GVs are usually found as values in stashes (symbol table hashes) where Perl stores its global variables.
A stash is a hash that contains all variables that are defined within a package. See "Stashes and Globs" in perlguts
"flags" affects how the operation is performed, as follows:
SV * amagic_call( SV *left, SV *right, int method,
int dir)
SV * Perl_amagic_call(pTHX_ SV *left, SV *right, int method,
int dir)
If overloading is inactive on "ref", returns "ref" itself.
SV * amagic_deref_call( SV *ref, int method) SV * Perl_amagic_deref_call(pTHX_ SV *ref, int method)
GV * gv_add_by_type( GV *gv, svtype type) GV * Perl_gv_add_by_type(pTHX_ GV *gv, svtype type)
Returns:
int Gv_AMupdate( HV *stash, bool destructing) int Perl_Gv_AMupdate(pTHX_ HV *stash, bool destructing)
Searching is done in "MRO" order, as specified in ""gv_fetchmeth"", beginning with "stash" if it isn't NULL.
"gv_autoload4") has a "method" parameter; the others a "flags" one (both types explained below). Otherwise, the forms differ only in how the name is specified.
In "gv_autoload_pv", "namepv" is a C language NUL-terminated string.
In "gv_autoload_pvn" and "gv_autoload4"), "name" points to the first byte of the name, and an additional parameter, "len", specifies its length in bytes. Hence, *name may contain embedded-NUL characters.
In "gv_autoload_sv", *namesv is an SV, and the name is the PV extracted from that using ""SvPV"". If the SV is marked as being in UTF-8, the extracted PV will also be.
The other way to indicate that the name is encoded as UTF-8 is to set the "SVf_UTF8" bit in "flags" for the forms that have that parameter. The name is never considered to be UTF-8 in "gv_autoload4".
The "method" parameter in "gv_autoload4" is used only to indicate that the name is for a method (non-zero), or not (zero). The other forms use the "GV_AUTOLOAD_ISMETHOD" bit in "flags" to indicate this.
The only other significant value in "flags" currently is "GV_SUPER" to indicate, if set, to skip searching for the name in "stash".
GV * gv_autoload_pv ( NOCHECK HV *stash,
const char *namepv, U32 flags)
GV * Perl_gv_autoload_pv (pTHX_ NOCHECK HV *stash,
const char *namepv, U32 flags)
GV * gv_autoload_pvn( NOCHECK HV *stash,
const char *name, STRLEN len,
U32 flags)
GV * Perl_gv_autoload_pvn(pTHX_ NOCHECK HV *stash,
const char *name, STRLEN len,
U32 flags)
GV * gv_autoload_sv ( NOCHECK HV *stash, SV *namesv,
U32 flags)
GV * Perl_gv_autoload_sv (pTHX_ NOCHECK HV *stash, SV *namesv,
U32 flags)
GV * gv_autoload4 ( HV *stash, const char *name,
STRLEN len, I32 method
)
GV * gv_AVadd( GV *gv) GV * Perl_gv_AVadd(pTHX_ GV *gv) GV * gv_HVadd( GV *gv) GV * Perl_gv_HVadd(pTHX_ GV *gv) GV * gv_IOadd( GV *gv) GV * Perl_gv_IOadd(pTHX_ GV *gv) GV * gv_SVadd( GV *gv) GV * Perl_gv_SVadd(pTHX_ GV *gv)
SV * gv_const_sv( GV *gv) SV * Perl_gv_const_sv(pTHX_ GV *gv)
If "prefix" is non-NULL, it is considered to be a C language NUL-terminated string, and the stored name will be prefaced with it.
The other difference between the functions is that the *4 forms have an extra parameter, "keepmain". If "true" an initial "main::" in the name is kept; if "false" it is stripped. With the *3 forms, it is always kept.
void gv_efullname3( SV *sv, const GV *gv,
const char *prefix)
void Perl_gv_efullname3(pTHX_ SV *sv, const GV *gv,
const char *prefix)
void gv_efullname4( SV *sv, const GV *gv,
const char *prefix, bool keepmain)
void Perl_gv_efullname4(pTHX_ SV *sv, const GV *gv,
const char *prefix, bool keepmain)
void gv_fullname3 ( SV *sv, const GV *gv,
const char *prefix)
void Perl_gv_fullname3 (pTHX_ SV *sv, const GV *gv,
const char *prefix)
void gv_fullname4 ( SV *sv, const GV *gv,
const char *prefix, bool keepmain)
void Perl_gv_fullname4 (pTHX_ SV *sv, const GV *gv,
const char *prefix, bool keepmain)
There are currently exactly two differences between these functions.
The "name" parameter to "gv_fetchfile" is a C string, meaning it is "NUL"-terminated; whereas the "name" parameter to "gv_fetchfile_flags" is a Perl string, whose length (in bytes) is passed in via the "namelen" parameter This means the name may contain embedded "NUL" characters. "namelen" doesn't exist in plain "gv_fetchfile").
The other difference is that "gv_fetchfile_flags" has an extra "flags" parameter, which is currently completely ignored, but allows for possible future extensions.
GV * gv_fetchfile ( const char *name)
GV * Perl_gv_fetchfile (pTHX_ const char *name)
GV * gv_fetchfile_flags( const char * const name,
const STRLEN len,
const U32 flags)
GV * Perl_gv_fetchfile_flags(pTHX_ const char * const name,
const STRLEN len,
const U32 flags)
You probably want to use the "gv_fetchmethod" family of functions instead.
Searching is always done in the following order, with some steps skipped depending on various criteria. The first match found is used, ending the search. "gv_fetchmeth_pv" and "gv_fetchmeth_pv_autoload" lack a flags parameter, so in the following, consider "flags" to be zero for those two functions.
Searching is conducted according to "MRO" order.
The argument "level" should be either 0 or -1.
If "GV_SUPER" is set in "flags", the method is cached in the super cache for "stash".
If the method is not found a negative cache entry is added.
Note that subroutines found in "UNIVERSAL::" are not cached, though this may change.
The GV returned from these may be a method cache entry, which is not visible to Perl code. So when calling "call_sv", you should not use the GV directly; instead, you should use the method's CV, which can be obtained from the GV with the "GvCV" macro. For an autoloaded subroutine without a stub, GvCV() of the result may be zero.
The only other significant value for "flags" is "SVf_UTF8", indicating that "name" is to be treated as being encoded in UTF-8. Since plain "gv_fetchmeth" and "gv_fetchmeth_autoload" lack a "flags" parameter, "name" is never UTF-8.
Otherwise, the functions behave identically, except as noted below.
In "gv_fetchmeth_pv" and "gv_fetchmeth_pv_autoload", "name" is a C language NUL-terminated string.
In "gv_fetchmeth", "gv_fetchmeth_pvn", "gv_fetchmeth_autoload", and "gv_fetchmeth_pvn_autoload", "name" points to the first byte of the name, and an additional parameter, "len", specifies its length in bytes. Hence, the name may contain embedded-NUL characters.
In "gv_fetchmeth_sv" and "gv_fetchmeth_sv_autoload", *name is an SV, and the name is the PV extracted from that, using "SvPV". If the SV is marked as being in UTF-8, the extracted PV will also be. Including "SVf_UTF8" in "flags" will force the name to be considered to be UTF-8 even if the SV is not so marked.
GV * gv_fetchmeth ( NOCHECK HV *stash,
const char *name,
STRLEN len, I32 level)
GV * gv_fetchmeth_autoload ( NOCHECK HV *stash,
const char *name,
STRLEN len, I32 level)
GV * gv_fetchmeth_pv ( NOCHECK HV *stash,
const char *name,
I32 level, U32 flags)
GV * Perl_gv_fetchmeth_pv (pTHX_ NOCHECK HV *stash,
const char *name,
I32 level, U32 flags)
GV * gv_fetchmeth_pv_autoload ( NOCHECK HV *stash,
const char *name,
I32 level, U32 flags)
GV * Perl_gv_fetchmeth_pv_autoload (pTHX_ NOCHECK HV *stash,
const char *name,
I32 level, U32 flags)
GV * gv_fetchmeth_pvn ( NOCHECK HV *stash,
const char *name,
STRLEN len, I32 level,
U32 flags)
GV * Perl_gv_fetchmeth_pvn (pTHX_ NOCHECK HV *stash,
const char *name,
STRLEN len, I32 level,
U32 flags)
GV * gv_fetchmeth_pvn_autoload( NOCHECK HV *stash,
const char *name,
STRLEN len, I32 level,
U32 flags)
GV * Perl_gv_fetchmeth_pvn_autoload(pTHX_ NOCHECK HV *stash,
const char *name,
STRLEN len, I32 level,
U32 flags)
GV * gv_fetchmeth_sv ( NOCHECK HV *stash,
SV *namesv, I32 level,
U32 flags)
GV * Perl_gv_fetchmeth_sv (pTHX_ NOCHECK HV *stash,
SV *namesv, I32 level,
U32 flags)
GV * gv_fetchmeth_sv_autoload ( NOCHECK HV *stash,
SV *namesv, I32 level,
U32 flags)
GV * Perl_gv_fetchmeth_sv_autoload (pTHX_ NOCHECK HV *stash,
SV *namesv, I32 level,
U32 flags)
The third parameter of "gv_fetchmethod_autoload" determines whether AUTOLOAD lookup is performed if the given method is not present: non-zero means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD. Calling "gv_fetchmethod" is equivalent to calling "gv_fetchmethod_autoload" with a non-zero "autoload" parameter.
These functions grant "SUPER" token as a prefix of the method name. Note that if you want to keep the returned glob for a long time, you need to check for it being "AUTOLOAD", since at the later time the call may load a different subroutine due to $AUTOLOAD changing its value. Use the glob created as a side effect to do this.
These functions have the same side-effects as "gv_fetchmeth" with "level==0". The warning against passing the GV returned by "gv_fetchmeth" to "call_sv" applies equally to these functions.
GV * gv_fetchmethod ( NOCHECK HV *stash,
const char *name)
GV * Perl_gv_fetchmethod (pTHX_ NOCHECK HV *stash,
const char *name)
GV * gv_fetchmethod_autoload( NOCHECK HV *stash,
const char *name,
I32 autoload)
GV * Perl_gv_fetchmethod_autoload(pTHX_ NOCHECK HV *stash,
const char *name,
I32 autoload)
The only differences are how the input name is specified, and if 'get' magic is normally used in getting that name.
Don't be fooled by the fact that only one form has "flags" in its name. They all have a "flags" parameter in fact, and all the flag bits have the same meanings for all
If any of the flags "GV_ADD", "GV_ADDMG", "GV_ADDWARN", "GV_ADDMULTI", or "GV_NOINIT" is set, a GV is created if none already exists for the input name and type. However, "GV_ADDMG" will only do the creation for magical GV's. For all of these flags except "GV_NOINIT", "gv_init_pvn" is called after the addition. "GV_ADDWARN" is used when the caller expects that adding won't be necessary because the symbol should already exist; but if not, add it anyway, with a warning that it was unexpectedly absent. The "GV_ADDMULTI" flag means to pretend that the GV has been seen before (i.e., suppress "Used once" warnings).
The flag "GV_NOADD_NOINIT" causes "gv_init_pvn" not be to called if the GV existed but isn't PVGV.
If the "SVf_UTF8" bit is set, the name is treated as being encoded in UTF-8; otherwise the name won't be considered to be UTF-8 in the "pv"-named forms, and the UTF-8ness of the underlying SVs will be used in the "sv" forms.
If the flag "GV_NOTQUAL" is set, the caller warrants that the input name is a plain symbol name, not qualified with a package, otherwise the name is checked for being a qualified one.
In "gv_fetchpv", "nambeg" is a C string, NUL-terminated with no intermediate NULs.
In "gv_fetchpvs", "name" is a literal C string, hence is enclosed in double quotes.
"gv_fetchpvn" and "gv_fetchpvn_flags" are identical. In these, <nambeg> is a Perl string whose byte length is given by "full_len", and may contain embedded NULs.
In "gv_fetchsv" and "gv_fetchsv_nomg", the name is extracted from the PV of the input "name" SV. The only difference between these two forms is that 'get' magic is normally done on "name" in "gv_fetchsv", and always skipped with "gv_fetchsv_nomg". Including "GV_NO_SVGMAGIC" in the "flags" parameter to "gv_fetchsv" makes it behave identically to "gv_fetchsv_nomg".
GV * gv_fetchpv ( const char *nambeg, I32 flags,
const svtype sv_type)
GV * Perl_gv_fetchpv (pTHX_ const char *nambeg, I32 flags,
const svtype sv_type)
GV * gv_fetchpvn ( const char * nambeg,
STRLEN full_len, I32 flags,
const svtype sv_type)
GV * gv_fetchpvn_flags( const char *name, STRLEN len,
I32 flags,
const svtype sv_type)
GV * Perl_gv_fetchpvn_flags(pTHX_ const char *name, STRLEN len,
I32 flags,
const svtype sv_type)
GV * gv_fetchpvs ( "name", I32 flags,
const svtype sv_type)
GV * gv_fetchsv ( SV *name, I32 flags,
const svtype sv_type)
GV * Perl_gv_fetchsv (pTHX_ SV *name, I32 flags,
const svtype sv_type)
GV * gv_fetchsv_nomg ( SV *name, I32 flags,
const svtype sv_type)
"gv" is the scalar to be converted.
"stash" is the parent stash/package, if any.
In "gv_init" and "gv_init_pvn", "name" and "len" give the name. The name must be unqualified; that is, it must not include the package name. If "gv" is a stash element, it is the caller's responsibility to ensure that the name passed to this function matches the name of the element. If it does not match, perl's internal bookkeeping will get out of sync. "name" may contain embedded NUL characters.
"gv_init_pv" is identical to "gv_init_pvn", but takes a NUL-terminated string for the name instead of separate char * and length parameters.
In "gv_init_sv", the name is given by "sv".
All but "gv_init" take a "flags" parameter. Set "flags" to include "SVf_UTF8" if "name" is a UTF-8 string. In "gv_init_sv", if SvUTF8(sv) is non-zero, name will be also be considered to be a UTF-8 string. It's unlikely to be a good idea to pass this particular flag to "gv_init_sv", as that would potentially override the (presumaby known) state of "sv".
"flags" can also take the "GV_ADDMULTI" flag, which means to pretend that the GV has been seen before (i.e., suppress "Used once" warnings).
"gv_init" is the old form of "gv_init_pvn". It does not work with UTF-8 strings, as it has no flags parameter. Setting the "multi" parameter to non-zero has the same effect as setting the "GV_ADDMULTI" flag in the other forms.
void gv_init ( GV *gv, HV *stash, const char *name,
STRLEN len, int multi)
void gv_init_pv ( GV *gv, HV *stash, const char *name,
U32 flags)
void Perl_gv_init_pv (pTHX_ GV *gv, HV *stash, const char *name,
U32 flags)
void gv_init_pvn( GV *gv, HV *stash, const char *name,
STRLEN len, U32 flags)
void Perl_gv_init_pvn(pTHX_ GV *gv, HV *stash, const char *name,
STRLEN len, U32 flags)
void gv_init_sv ( GV *gv, HV *stash, SV *namesv,
U32 flags)
void Perl_gv_init_sv (pTHX_ GV *gv, HV *stash, SV *namesv,
U32 flags)
If "flags" contains "SVf_UTF8", the name is treated as being encoded in UTF-8; otherwise not.
void gv_name_set( GV *gv, const char *name, U32 len,
U32 flags)
void Perl_gv_name_set(pTHX_ GV *gv, const char *name, U32 len,
U32 flags)
These each return a pointer to the stash for a specified package.
In "gv_stashsv", the package is specified by "sv".
In "gv_stashpvs", the package is specified by the literal C string enclosed in double quotes.
In the other forms, "name" specifies the package. In "gv_stashpvn", "namelen" gives the length of the name in bytes, so it may include embedded NUL characters. In "gv_stashpv", "name" ends at the first NUL character.
"flags" is passed to gv_fetchpvn_flags(), so if set to "GV_ADD" then the package will be created if it does not already exist. If the package does not exist and "flags" is 0 (or any other setting that does not create packages) then "NULL" is returned.
Flags may be one of:
GV_ADD Create and initialize the package if doesn't
already exist
GV_NOADD_NOINIT Don't create the package,
GV_ADDMG GV_ADD iff the GV is magical
GV_NOINIT GV_ADD, but don't initialize
GV_NOEXPAND Don't expand SvOK() entries to PVGV
SVf_UTF8 The name is in UTF-8
The most important of which are probably "GV_ADD" and "SVf_UTF8".
HV * gv_stashpv ( const char *name, I32 flags)
HV * Perl_gv_stashpv (pTHX_ const char *name, I32 flags)
HV * gv_stashpvn( const char *name, U32 namelen,
I32 flags)
HV * Perl_gv_stashpvn(pTHX_ const char *name, U32 namelen,
I32 flags)
HV* gv_stashpvs( "name", I32 create)
HV * gv_stashsv ( SV *sv, I32 flags)
HV * Perl_gv_stashsv (pTHX_ SV *sv, I32 flags)
AV* GvAV(GV* gv)
CV* GvCV(GV* gv)
HV* GvHV(GV* gv)
GV * GvREFCNT_inc (GV *gv) GV * GvREFCNT_inc_simple (GV *gv) GV * GvREFCNT_inc_simple_NN(GV *gv)
Prior to Perl v5.9.3, this would add a scalar if none existed. Nowadays, use "GvSVn" for that, or compile perl with "-DPERL_CREATE_GVSV". See perl5100delta.
SV* GvSV(GV* gv)
SV* GvSVn(GV* gv)
For "newGVgen" or if "flags" in "newGVgen_flags" is 0, "pack" is to be considered to be encoded in Latin-1. The only other legal "flags" value is "SVf_UTF8", which indicates "pack" is to be considered to be encoded in UTF-8.
GV * newGVgen ( const char *pack) GV * newGVgen_flags( const char *pack, U32 flags) GV * Perl_newGVgen_flags(pTHX_ const char *pack, U32 flags)
On threaded perls, each thread has an independent copy of this variable; each initialized at creation time with the current value of the creating thread's copy.
HV* PL_curstash
On threaded perls, each thread has an independent copy of this variable; each initialized at creation time with the current value of the creating thread's copy.
GV * PL_defgv
If "empty" is true, replace the GP with a new GP.
If "empty" is false, mark "gv" with "GVf_INTRO" so the next reference assigned is localized, which is how " local *foo = $someref; " works.
void save_gp( GV *gv, I32 empty) void Perl_save_gp(pTHX_ GV *gv, I32 empty)
void setdefout( GV *gv) void Perl_setdefout(pTHX_ GV *gv)
These functions provide convenient and thread-safe means of manipulating hook variables.
It is the callers responsibility to ensure that the pv is the result of a rcpv_new() call.
Returns the same pointer that was passed in.
new = rcpv_copy(pv);
char * rcpv_copy( char * const pv) char * Perl_rcpv_copy(pTHX_ char * const pv)
it is the callers responsibility to ensure that the pv is the result of a rcpv_new() call.
Always returns NULL so it can be used like this:
thing = rcpv_free(thing);
char * rcpv_free( char * const pv) char * Perl_rcpv_free(pTHX_ char * const pv)
If the RCPVf_NO_COPY flag is set then the pv argument will be ignored, otherwise the contents of the pv pointer will be copied into the new buffer or if it is NULL the function will do nothing and return NULL.
If the RCPVf_USE_STRLEN flag is set then the len argument is ignored and recomputed using strlen(pv). It is an error to combine RCPVf_USE_STRLEN and RCPVf_NO_COPY at the same time.
Under DEBUGGING rcpv_new() will assert() if it is asked to create a 0 length shared string unless the RCPVf_ALLOW_EMPTY flag is set.
The return value from the function is suitable for passing into rcpv_copy() and rcpv_free(). To access the RCPV * from the returned value use the RCPVx() macro. The 'len' member of the RCPV struct stores the allocated length (including the extra byte), but the RCPV_LEN() macro returns the requested length (not including the extra byte).
Note that rcpv_new() does NOT use a hash table or anything like that to dedupe inputs given the same text content. Each call with a non-null pv parameter will produce a distinct pointer with its own refcount regardless of the input content.
char * rcpv_new( const char * const pv, STRLEN len,
U32 flags)
char * Perl_rcpv_new(pTHX_ const char * const pv, STRLEN len,
U32 flags)
"PL_check" is global to an entire process, and a module wishing to hook op checking may find itself invoked more than once per process, typically in different threads. To handle that situation, this function is idempotent. The location *old_checker_p must initially (once per process) contain a null pointer. A C variable of static duration (declared at file scope, typically also marked "static" to give it internal linkage) will be implicitly initialised appropriately, if it does not have an explicit initialiser. This function will only actually 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 appropriate locking to avoid race conditions in accessing "PL_check".
When this function is called, the function referenced by "new_checker" must 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 always be appropriately set before "new_checker" is called. If "new_checker" decides not to do anything special with an op that it is given (which is the usual case for most uses of op check hooking), it must chain the check function referenced by *old_checker_p.
Taken all together, XS code to hook an op checker should typically look something like this:
static Perl_check_t nxck_frob;
static OP *myck_frob(pTHX_ OP *op) {
...
op = nxck_frob(aTHX_ op);
...
return op;
}
BOOT:
wrap_op_checker(OP_FROB, myck_frob, &nxck_frob);
If you want to influence compilation of calls to a specific subroutine, then use "cv_set_call_checker_flags" rather than hooking checking of all "entersub" ops.
void wrap_op_checker( Optype opcode,
Perl_check_t new_checker,
Perl_check_t *old_checker_p)
void Perl_wrap_op_checker(pTHX_ Optype opcode,
Perl_check_t new_checker,
Perl_check_t *old_checker_p)
A HV structure represents a Perl hash. It consists mainly of an array of pointers, each of which points to a linked list of HE structures. The array is indexed by the hash function of the key, so each linked list represents all the hash entries with the same hash value. Each HE contains a pointer to the actual value, plus a pointer to a HEK structure which holds the key and hash value.
NOTE: the perl_get_hv() form is deprecated.
HV * get_hv( const char *name, I32 flags) HV * Perl_get_hv(pTHX_ const char *name, I32 flags)
U32 HeHASH(HE* he)
void* HeKEY(HE* he)
STRLEN HeKLEN(HE* he)
If you are using "HePV" to get values to pass to newSVpvn() to create a new SV, you should consider using "newSVhek(HeKEY_hek(he))" as it is more efficient.
char* HePV(HE* he, STRLEN len)
SV* HeSVKEY(HE* he)
SV* HeSVKEY_force(HE* he)
SV* HeSVKEY_set(HE* he, SV* sv)
U32 HeUTF8(HE* he)
SV *foo= HeVAL(hv);
HeVAL(hv)= sv;
SV* HeVAL(HE* he)
void Perl_hv_assert(pTHX_ HV *hv)
If the hash is tied dispatches through to the SCALAR tied method, otherwise if the hash contains no keys returns 0, otherwise returns a mortal sv containing a string specifying the number of used buckets, followed by a slash, followed by the number of available buckets.
This function is expensive, it must scan all of the buckets to determine which are used, and the count is NOT cached. In a large hash this could be a lot of buckets.
SV * hv_bucket_ratio( HV *hv) SV * Perl_hv_bucket_ratio(pTHX_ HV *hv)
See "av_clear" for a note about the hash possibly being invalid on return.
void hv_clear( HV *hv) void Perl_hv_clear(pTHX_ HV *hv)
void hv_clear_placeholders( HV *hv) void Perl_hv_clear_placeholders(pTHX_ HV *hv)
HV * hv_copy_hints_hv( HV * const ohv) HV * Perl_hv_copy_hints_hv(pTHX_ HV * const ohv)
In "hv_deletes", the key must be a C language string literal, enclosed in double quotes. It is never treated as being in UTF-8. There is no length_parameter.
In "hv_delete", the absolute value of "klen" is the length of the key; hence the key may contain embedded NUL characters. If "klen" is negative the key is assumed to be in UTF-8-encoded Unicode.
In "hv_delete_ent", the key is the PV in "keysv", including its length and UTF8ness. "hash" can be a valid precomputed hash value, or 0 to ask for it to be computed.
In all three, the "flags" value will normally be zero; if set to "G_DISCARD" then "NULL" will be returned. "NULL" will also be returned if the key is not found.
SV * hv_delete ( HV *hv, const char *key, I32 klen,
I32 flags)
SV * Perl_hv_delete (pTHX_ HV *hv, const char *key, I32 klen,
I32 flags)
SV * hv_deletes ( HV *hv, "key", U32 flags)
SV * hv_delete_ent( HV *hv, SV *keysv, I32 flags,
U32 hash)
SV * Perl_hv_delete_ent(pTHX_ HV *hv, SV *keysv, I32 flags,
U32 hash)
In "hv_existss", the key must be a C language string literal, enclosed in double quotes. It is never treated as being in UTF-8. There is no length_parameter.
In "hv_exists", the absolute value of "klen" is the length of the key. If "klen" is negative the key is assumed to be in UTF-8-encoded Unicode. "key" may contain embedded NUL characters.
In "hv_exists_ent", the key is specified by the SV "keysv"; its UTF8ness is the same as that SV. There is an additional parameter, "hash", which can be a valid precomputed hash value, or 0 to ask for it to be computed.
bool hv_exists ( HV *hv, const char *key, I32 klen) bool Perl_hv_exists (pTHX_ HV *hv, const char *key, I32 klen) bool hv_existss ( HV *hv, "key") bool hv_exists_ent( HV *hv, SV *keysv, U32 hash) bool Perl_hv_exists_ent(pTHX_ HV *hv, SV *keysv, U32 hash)
In "hv_fetchs", the key must be a C language string literal, enclosed in double quotes. It is never treated as being in UTF-8. There is no length_parameter.
In "hv_fetch", the absolute value of "klen" is the length of the key. If "klen" is negative the key is assumed to be in UTF-8-encoded Unicode. "key" may contain embedded NUL characters.
In both, if "lval" is set, then the fetch will be part of a store. This means that if there is no value in the hash associated with the given key, then one is created and a pointer to it is returned. The "SV*" it points to can be assigned to. But always check that the return value is non-null before dereferencing it to an "SV*".
See "Understanding the Magic of Tied Hashes and Arrays" in perlguts for more information on how to use this function on tied hashes.
SV ** hv_fetch ( HV *hv, const char *key, I32 klen,
I32 lval)
SV ** Perl_hv_fetch (pTHX_ HV *hv, const char *key, I32 klen,
I32 lval)
SV** hv_fetchs( HV* hv, "key", I32 lval)
See "Understanding the Magic of Tied Hashes and Arrays" in perlguts for more information on how to use this function on tied hashes.
HE * hv_fetch_ent( HV *hv, SV *keysv, I32 lval,
U32 hash)
HE * Perl_hv_fetch_ent(pTHX_ HV *hv, SV *keysv, I32 lval,
U32 hash)
NOTE: Before version 5.004_65, "hv_iterinit" used to return the number of hash buckets that happen to be in use. If you still need that esoteric value, you can get it through the macro HvFILL(hv).
I32 hv_iterinit( HV *hv) I32 Perl_hv_iterinit(pTHX_ HV *hv)
char * hv_iterkey( HE *entry, I32 *retlen) char * Perl_hv_iterkey(pTHX_ HE *entry, I32 *retlen)
SV * hv_iterkeysv( HE *entry) SV * Perl_hv_iterkeysv(pTHX_ HE *entry)
You may call "hv_delete" or "hv_delete_ent" on the hash entry that the iterator currently points to, without losing your place or invalidating your iterator. Note that in this case the current entry is deleted from the hash with your iterator holding the last reference to it. Your iterator is flagged to free the entry on the next call to "hv_iternext", so you must not discard your iterator immediately else the entry will leak - call "hv_iternext" to trigger the resource deallocation.
HE * hv_iternext( HV *hv) HE * Perl_hv_iternext(pTHX_ HV *hv)
Returns entries from a hash iterator. See "hv_iterinit" and "hv_iternext". The "flags" value will normally be zero; if "HV_ITERNEXT_WANTPLACEHOLDERS" is set the placeholders keys (for restricted hashes) will be returned in addition to 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 and restricted hashes may change, and the implementation currently is insufficiently abstracted for any change to be tidy.
HE * hv_iternext_flags( HV *hv, I32 flags) HE * Perl_hv_iternext_flags(pTHX_ HV *hv, I32 flags)
SV * hv_iternextsv( HV *hv, char **key, I32 *retlen) SV * Perl_hv_iternextsv(pTHX_ HV *hv, char **key, I32 *retlen)
SV * hv_iterval( HV *hv, HE *entry) SV * Perl_hv_iterval(pTHX_ HV *hv, HE *entry)
This is the same as doing the following in Perl code:
keys %hv = newmax;
void hv_ksplit( HV *hv, IV newmax) void Perl_hv_ksplit(pTHX_ HV *hv, IV newmax)
void hv_magic( HV *hv, GV *gv, int how) void Perl_hv_magic(pTHX_ HV *hv, GV *gv, int how)
They differ only in how the name is specified.
In "hv_name_sets", the name is a literal C string, enclosed in double quotes.
In "hv_name_set", "name" points to the first byte of the name, and an additional parameter, "len", specifies its length in bytes. Hence, the name may contain embedded-NUL characters.
If "SVf_UTF8" is set in "flags", the name is treated as being in UTF-8; otherwise not.
If "HV_NAME_SETALL" is set in "flags", both the name and the effective name are set.
void hv_name_set ( HV *hv, const char *name, U32 len,
U32 flags)
void Perl_hv_name_set (pTHX_ HV *hv, const char *name, U32 len,
U32 flags)
void hv_name_sets( HV *hv, "name", U32 flags)
When the hash is tied dispatches through to the SCALAR method, otherwise returns a mortal SV containing the number of keys in the hash.
Note, prior to 5.25 this function returned what is now returned by the hv_bucket_ratio() function.
SV * hv_scalar( HV *hv) SV * Perl_hv_scalar(pTHX_ HV *hv)
They differ only in how the hash key is specified.
In "hv_stores", the key must be a C language string literal, enclosed in double quotes. It is never treated as being in UTF-8. There is no length_parameter.
In "hv_store", "key" is either NULL or points to the first byte of the string specifying the key, and its length in bytes is given by the absolute value of an additional parameter, "klen". A NULL key indicates the key is to be treated as "undef", and "klen" is ignored; otherwise the key string may contain embedded-NUL bytes. If "klen" is negative, the string is treated as being encoded in UTF-8; otherwise not.
"hv_store" has another extra parameter, "hash", a precomputed hash of the key string, or zero if it has not been precomputed. This parameter is omitted from "hv_stores", as it is computed automatically at compile time.
If "hv" is NULL, NULL is returned and no action is taken.
If "val" is NULL, it is treated as being "undef"; otherwise the caller is responsible for suitably incrementing the reference count of "val" before the call, and decrementing it if the function returned "NULL". Effectively a successful "hv_store" takes ownership of one reference to "val". This is usually what you want; a newly created SV has a reference count of one, so if all your code does is create SVs and store them in a hash, "hv_store" will own the only reference to the new SV, and your code doesn't need to do anything further to tidy up.
"hv_store" is not implemented as a call to ""hv_store_ent"", and does not create a temporary SV for the key, so if your key data is not already in SV form, then use "hv_store" in preference to "hv_store_ent".
See "Understanding the Magic of Tied Hashes and Arrays" in perlguts for more information on how to use this function on tied hashes.
SV ** hv_store ( HV *hv, const char *key, I32 klen,
SV *val, U32 hash)
SV ** Perl_hv_store (pTHX_ HV *hv, const char *key, I32 klen,
SV *val, U32 hash)
SV ** hv_stores( HV *hv, "key", SV *val)
See "Understanding the Magic of Tied Hashes and Arrays" in perlguts for more information on how to use this function on tied hashes.
HE * hv_store_ent( HV *hv, SV *key, SV *val, U32 hash) HE * Perl_hv_store_ent(pTHX_ HV *hv, SV *key, SV *val, U32 hash)
As well as freeing all the elements of the hash (like hv_clear()), this also frees any auxiliary data and storage associated with the hash.
See "av_clear" for a note about the hash possibly being invalid on return.
void hv_undef(HV *hv)
char* HvENAME(HV* stash)
STRLEN HvENAMELEN(HV *stash)
unsigned char HvENAMEUTF8(HV *stash)
As of perl 5.25 this function is used only for debugging purposes, and the number of used hash buckets is not in any way cached, thus this function can be costly to execute as it must iterate over all the buckets in the hash.
STRLEN HvFILL(HV *const hv)
bool HvHasAUX(HV *const hv)
char* HvNAME(HV* stash)
Disfavored forms of HvNAME and HvNAMELEN; suppress mention of them
STRLEN HvNAMELEN(HV *stash)
unsigned char HvNAMEUTF8(HV *stash)
HV * HvREFCNT_inc (HV *hv) HV * HvREFCNT_inc_simple (HV *hv) HV * HvREFCNT_inc_simple_NN(HV *hv)
HV * newHV() HV * Perl_newHV(pTHX)
HV * newHVhv( HV *hv) HV * Perl_newHVhv(pTHX_ HV *hv)
Null HV pointer.
(deprecated - use "(HV *)NULL" instead)
void PERL_HASH(U32 hash, char *key, STRLEN klen)
On threaded perls, each thread has an independent copy of this variable; each initialized at creation time with the current value of the creating thread's copy.
HV* PL_modglobal
"gv" is the glob associated with the stream.
"is_explict" is "true" if this is an explicit close of the stream; "false" if it is part of another operation, such as closing a pipe (which involves implicitly closing both ends).
Returns "true" if successful; otherwise returns "false" and sets "errno" to indicate the cause.
bool do_close( GV *gv, bool is_explicit) bool Perl_do_close(pTHX_ GV *gv, bool is_explicit)
DIR * IoDIRP (IO *io) U8 IoFLAGS(IO *io) PerlIO * IoIFP (IO *io) PerlIO * IoOFP (IO *io) char IoTYPE (IO *io)
I32 my_chsize( int fd, Off_t length) I32 Perl_my_chsize(pTHX_ int fd, Off_t length)
int my_dirfd(DIR *dir) int Perl_my_dirfd(DIR *dir)
I32 my_pclose( PerlIO *ptr) I32 Perl_my_pclose(pTHX_ PerlIO *ptr)
PerlIO * my_popen( const char *cmd, const char *mode) PerlIO * Perl_my_popen(pTHX_ const char *cmd, const char *mode)
IO * newIO() IO * Perl_newIO(pTHX)
void PERL_FLUSHALL_FOR_CHILD
int PerlIO_apply_layers(pTHX_ PerlIO *f,
const char *mode,
const char *layers)
int PerlIO_binmode (pTHX_ PerlIO *f, int ptype,
int imode,
const char *layers)
int PerlIO_canset_cnt ( PerlIO *f)
void PerlIO_clearerr ( PerlIO *f)
void Perl_PerlIO_clearerr (pTHX_ PerlIO *f)
int PerlIO_close ( PerlIO *f)
int Perl_PerlIO_close (pTHX_ PerlIO *f)
void PerlIO_debug ( const char *fmt, ...)
int PerlIO_eof ( PerlIO *f)
int Perl_PerlIO_eof (pTHX_ PerlIO *f)
int PerlIO_error ( PerlIO *f)
int Perl_PerlIO_error (pTHX_ PerlIO *f)
FILE * PerlIO_exportFILE ( PerlIO *f,
const char *mode)
int PerlIO_fast_gets ( PerlIO *f)
PerlIO * PerlIO_fdopen ( int fd,
const char *mode)
int PerlIO_fileno ( PerlIO *f)
int Perl_PerlIO_fileno (pTHX_ PerlIO *f)
int PerlIO_fill ( PerlIO *f)
int Perl_PerlIO_fill (pTHX_ PerlIO *f)
FILE * PerlIO_findFILE ( PerlIO *f)
int PerlIO_flush ( PerlIO *f)
int Perl_PerlIO_flush (pTHX_ PerlIO *f)
STDCHAR * PerlIO_get_base ( PerlIO *f)
STDCHAR * Perl_PerlIO_get_base (pTHX_ PerlIO *f)
SSize_t PerlIO_get_bufsiz ( PerlIO *f)
SSize_t Perl_PerlIO_get_bufsiz (pTHX_ PerlIO *f)
SSize_t PerlIO_get_cnt ( PerlIO *f)
SSize_t Perl_PerlIO_get_cnt (pTHX_ PerlIO *f)
STDCHAR * PerlIO_get_ptr ( PerlIO *f)
STDCHAR * Perl_PerlIO_get_ptr (pTHX_ PerlIO *f)
int PerlIO_getc ( PerlIO *d)
int PerlIO_getpos ( PerlIO *f, SV *save)
int PerlIO_has_base ( PerlIO *f)
int PerlIO_has_cntptr ( PerlIO *f)
PerlIO * PerlIO_importFILE ( FILE *stdio,
const char *mode)
PerlIO * PerlIO_open ( const char *path,
const char *mode)
int PerlIO_printf ( PerlIO *f,
const char *fmt, ...)
int PerlIO_putc ( PerlIO *f, int ch)
int PerlIO_puts ( PerlIO *f,
const char *string)
SSize_t PerlIO_read ( PerlIO *f, void *vbuf,
Size_t count)
SSize_t Perl_PerlIO_read (pTHX_ PerlIO *f, void *vbuf,
Size_t count)
void PerlIO_releaseFILE ( PerlIO *f, FILE *stdio)
PerlIO * PerlIO_reopen ( const char *path,
const char *mode,
PerlIO *old)
void PerlIO_rewind ( PerlIO *f)
int PerlIO_seek ( PerlIO *f,
Off_t offset,
int whence)
int Perl_PerlIO_seek (pTHX_ PerlIO *f,
Off_t offset,
int whence)
void PerlIO_set_cnt ( PerlIO *f, SSize_t cnt)
void Perl_PerlIO_set_cnt (pTHX_ PerlIO *f, SSize_t cnt)
void PerlIO_set_ptrcnt ( PerlIO *f,
STDCHAR *ptr,
SSize_t cnt)
void Perl_PerlIO_set_ptrcnt (pTHX_ PerlIO *f,
STDCHAR *ptr,
SSize_t cnt)
void PerlIO_setlinebuf ( PerlIO *f)
void Perl_PerlIO_setlinebuf (pTHX_ PerlIO *f)
int PerlIO_setpos ( PerlIO *f, SV *saved)
PerlIO * PerlIO_stderr ()
PerlIO * Perl_PerlIO_stderr (pTHX)
PerlIO * PerlIO_stdin ()
PerlIO * Perl_PerlIO_stdin (pTHX)
PerlIO * PerlIO_stdout ()
PerlIO * Perl_PerlIO_stdout (pTHX)
int PerlIO_stdoutf ( const char *fmt, ...)
Off_t PerlIO_tell ( PerlIO *f)
Off_t Perl_PerlIO_tell (pTHX_ PerlIO *f)
int PerlIO_ungetc ( PerlIO *f, int ch)
SSize_t PerlIO_unread ( PerlIO *f,
const void *vbuf,
Size_t count)
SSize_t Perl_PerlIO_unread (pTHX_ PerlIO *f,
const void *vbuf,
Size_t count)
int PerlIO_vprintf ( PerlIO *f,
const char *fmt,
va_list args)
SSize_t PerlIO_write ( PerlIO *f,
const void *vbuf,
Size_t count)
SSize_t Perl_PerlIO_write (pTHX_ PerlIO *f,
const void *vbuf,
Size_t count)
PerlIO_funcs * PERLIO_FUNCS_CAST(PerlIO * func)
PERLIO_FUNCS_DECL(PerlIO * ftab)
void repeatcpy(char *to, const char *from, SSize_t len,
IV count)
void Perl_repeatcpy(char *to, const char *from, SSize_t len,
IV count)
This is a wrapper around the "sv_vstring_get" function that conveniently takes the address of the "len" variable, in a form similar to the "SvPV" macro family.
const char * SvVSTRING(SV* sv, STRLEN len)
#ifdef USE_STDIO
-1LL
See also, for example, "INT32_C".
Use "IV" to declare variables of the maximum usable size on this platform.
INTMAX_C(number)
If the machine does not have a 64-bit type, "INT64_C" is undefined. Use "INTMAX_C" to get the largest type available on the platform.
I16 INT16_C(number) I32 INT32_C(number) I64 INT64_C(number)
IV IV_MAX
It is easy to get undefined C behavior with this value. The macros (currently only available for internal use) ""NEGATE_2UV"" in perlintern, ""ABS_IV_MIN"" in perlintern, and ""NEGATE_2IV"" in perlintern avoid undefined behavior when finding the opposite signed equivalent value.
IV IV_MIN
void memzero(void * d, Size_t l)
For signed types, the smallest representable number is the most negative number, the one furthest away from zero.
For C99 and later compilers, these correspond to things like "INT_MAX", which are available to the C code. But these constants, furnished by Perl, allow code compiled on earlier compilers to portably have access to the same constants.
int PERL_INT_MAX int PERL_INT_MIN long PERL_LONG_MAX long PERL_LONG_MIN IV PERL_QUAD_MAX IV PERL_QUAD_MIN short PERL_SHORT_MAX short PERL_SHORT_MIN U8 PERL_UCHAR_MAX U8 PERL_UCHAR_MIN unsigned int PERL_UINT_MAX unsigned int PERL_UINT_MIN unsigned long PERL_ULONG_MAX unsigned long PERL_ULONG_MIN UV PERL_UQUAD_MAX UV PERL_UQUAD_MIN unsigned short PERL_USHORT_MAX unsigned short PERL_USHORT_MIN
1UL
See also, for example, "UINT32_C".
Use "UV" to declare variables of the maximum usable size on this platform.
UINTMAX_C(number)
If the machine does not have a 64-bit type, "UINT64_C" is undefined. Use "UINTMAX_C" to get the largest type available on the platform.
U16 UINT16_C(number) U32 UINT32_C(number) U64 UINT64_C(number)
UV UV_MAX
UV UV_MIN
WIDEST_UTYPE my_uv;
or casts
my_uv = (WIDEST_UTYPE) val;
These are used for formatting the corresponding type For example, instead of saying
Perl_newSVpvf(pTHX_ "Create an SV with a %d in it\n", iv);
use
Perl_newSVpvf(pTHX_ "Create an SV with a " IVdf " in it\n", iv);
This keeps you from having to know if, say an IV, needs to be printed as %d, %ld, or something else.
SVfARG (SV *sv) UTF8fARG(bool is_utf8, Size_t byte_len, char *str)
Obsolete form of "UVuf", which you should convert to instead use
const char * UVf
This is the lower layer of the Perl parser, managing characters and tokens.
Indicates whether the octets in the lexer buffer ("PL_parser->linestr") should be interpreted as the UTF-8 encoding of Unicode characters. If not, they should be interpreted as Latin-1 characters. This is analogous to the "SvUTF8" flag for scalars.
In UTF-8 mode, it is not guaranteed that the lexer buffer actually contains valid UTF-8. Lexing code must be robust in the face of invalid encoding.
The actual "SvUTF8" flag of the "PL_parser->linestr" scalar is significant, but not the whole story regarding the input character encoding. Normally, when a file is being read, the scalar contains octets and its "SvUTF8" flag is off, but the octets should be interpreted as UTF-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 its octets should be interpreted as UTF-8 unless the "use bytes" pragma is in effect. This logic may change in the future; use this function instead of implementing the logic yourself.
bool lex_bufutf8() bool Perl_lex_bufutf8(pTHX)
Discards the first part of the "PL_parser->linestr" buffer, up to "ptr". The remaining content of the buffer will be moved, and all pointers into the buffer updated appropriately. "ptr" must not be 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 to use the implicit discarding behaviour of "lex_next_chunk" and things based on it. However, if a token stretches across multiple lines, and the lexing code has kept multiple lines of text in the buffer for that purpose, then after completion of the token it would be wise to explicitly discard the now-unneeded earlier lines, to avoid future multi-line tokens growing the buffer without bound.
void lex_discard_to( char *ptr) void Perl_lex_discard_to(pTHX_ char *ptr)
Reallocates the lexer buffer ("PL_parser->linestr") to accommodate at least "len" octets (including terminating "NUL"). Returns a pointer to the reallocated buffer. This is necessary before making any direct modification of the buffer that would increase its length. "lex_stuff_pvn" provides a more convenient way to insert text into the buffer.
Do not use "SvGROW" or "sv_grow" directly on "PL_parser->linestr"; this function updates all of the lexer's variables that point directly into the buffer.
char * lex_grow_linestr( STRLEN len) char * Perl_lex_grow_linestr(pTHX_ STRLEN len)
Reads in the next chunk of text to be lexed, appending it to "PL_parser->linestr". This should be called when lexing code has looked to the end of the current chunk and wants to know more. It is usual, but not necessary, for lexing to have consumed the entirety of the current chunk at this time.
If "PL_parser->bufptr" is pointing to the very end of the current chunk (i.e., the current chunk has been entirely consumed), normally the current chunk will be discarded at the same time that the new chunk is read in. If "flags" has the "LEX_KEEP_PREVIOUS" bit set, the current chunk will not be discarded. If the current chunk has not been entirely consumed, then it will not be discarded regardless of the flag.
Returns true if some new text was added to the buffer, or false if the buffer has reached the end of the input text.
bool lex_next_chunk( U32 flags) bool Perl_lex_next_chunk(pTHX_ U32 flags)
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 the peeked character, use "lex_read_unichar".
If the next character is in (or extends into) the next chunk of input text, the next chunk will be read in. Normally the current chunk will be discarded at the same time, but if "flags" has the "LEX_KEEP_PREVIOUS" bit set, then the current chunk will not be discarded.
If the input is being interpreted as UTF-8 and a UTF-8 encoding error is encountered, an exception is generated.
I32 lex_peek_unichar( U32 flags) I32 Perl_lex_peek_unichar(pTHX_ U32 flags)
Reads optional spaces, in Perl style, in the text currently being lexed. The spaces may include ordinary whitespace characters and Perl-style comments. "#line" directives are processed if encountered. "PL_parser->bufptr" is moved past the spaces, so that it points at a non-space character (or the end of the input text).
If spaces extend into the next chunk of input text, the next chunk will be read in. Normally the current chunk will be discarded at the same time, but if "flags" has the "LEX_KEEP_PREVIOUS" bit set, then the current chunk will not be discarded.
void lex_read_space( U32 flags) void Perl_lex_read_space(pTHX_ U32 flags)
Consume text in the lexer buffer, from "PL_parser->bufptr" up to "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 by using the slightly higher-level functions "lex_peek_unichar" and "lex_read_unichar".
void lex_read_to( char *ptr) void Perl_lex_read_to(pTHX_ char *ptr)
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 -1 if lexing has reached the end of the input text. To non-destructively examine the next character, use "lex_peek_unichar" instead.
If the next character is in (or extends into) the next chunk of input text, the next chunk will be read in. Normally the current chunk will be discarded at the same time, but if "flags" has the "LEX_KEEP_PREVIOUS" bit set, then the current chunk will not be discarded.
If the input is being interpreted as UTF-8 and a UTF-8 encoding error is encountered, an exception is generated.
I32 lex_read_unichar( U32 flags) I32 Perl_lex_read_unichar(pTHX_ U32 flags)
Creates and initialises a new lexer/parser state object, supplying a 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 entry is made on the save stack so that upon unwinding, the new state object will 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", if non-null, provides a string (in SV form) containing code to be parsed. A copy of the string is made, so subsequent modification of "line" does not affect parsing. "rsfp", if non-null, provides an input stream from which code will be read to be parsed. If both are non-null, the code 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 only used by perl internally, so extensions should always pass zero.
void lex_start( SV *line, PerlIO *rsfp, U32 flags) void Perl_lex_start(pTHX_ SV *line, PerlIO *rsfp, U32 flags)
These each 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 that runs 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 most uses of this facility run the risk of the inserted characters being interpreted in an unintended manner.
In "lex_stuff_pvs", the string to be inserted is a literal C string, enclosed in double quotes.
In "lex_stuff_pv" and "lex_stuff_pvn", the string to be inserted is represented by the octets starting at "pv". In "lex_stuff_pv", the first NUL octet terminates the string. In "lex_stuff_pvn", "len" octets will be used, hence the string may contain embedded NUL characters.
In all three cases, these octets are interpreted as either UTF-8 or Latin-1, according to whether or not the "LEX_STUFF_UTF8" flag is set in "flags".
In "lex_stuff_sv", the string to be inserted is the string value of "sv". "flags" must be 0. The string is interpreted as either UTF-8 or Latin-1, according to whether or not "sv" has its UTF-8 flag set.
In all three forms, the characters are recoded for the lexer buffer, according to how the buffer is currently being interpreted ("lex_bufutf8").
void lex_stuff_pv ( const char *pv, U32 flags)
void Perl_lex_stuff_pv (pTHX_ const char *pv, U32 flags)
void lex_stuff_pvn( const char *pv, STRLEN len,
U32 flags)
void Perl_lex_stuff_pvn(pTHX_ const char *pv, STRLEN len,
U32 flags)
void lex_stuff_pvs( "pv", U32 flags)
void lex_stuff_sv ( SV *sv, U32 flags)
void Perl_lex_stuff_sv (pTHX_ SV *sv, U32 flags)
Discards text about to be lexed, from "PL_parser->bufptr" up to "ptr". 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, use "lex_read_to".
void lex_unstuff( char *ptr) void Perl_lex_unstuff(pTHX_ char *ptr)
Parse a Perl arithmetic expression. This may contain operators of precedence down to the bit shift operators. The expression must be followed (and thus terminated) either by a comparison or lower-precedence operator or by something that would normally terminate an expression such as semicolon. If "flags" has the "PARSE_OPTIONAL" bit set, then the expression is optional, otherwise it is mandatory. It is up to the 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 the lexical context for the expression.
The op tree representing the expression is returned. If an optional expression is absent, a null pointer is returned, otherwise the pointer will be non-null.
If an error occurs in parsing or compilation, in most cases a valid op tree is returned anyway. The error is reflected in the parser state, normally resulting in a single exception at the top level of parsing which covers all the compilation errors that occurred. Some compilation errors, however, will throw an exception immediately.
OP * parse_arithexpr( U32 flags) OP * Perl_parse_arithexpr(pTHX_ U32 flags)
Parse a single unadorned Perl statement. This may be a normal imperative statement or a declaration that has compile-time effect. It does not include any label or other affixture. It is up to the 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 the lexical context for the statement.
The op tree representing the statement is returned. This may be a null pointer if the statement is null, for example if it was actually a subroutine definition (which has compile-time side effects). If not null, it will be ops directly implementing the statement, suitable to pass to "newSTATEOP". It will not normally include a "nextstate" or equivalent op (except for those embedded in a scope contained entirely within the statement).
If an error occurs in parsing or compilation, in most cases a valid op tree (most likely null) is returned anyway. The error is reflected in the parser state, normally resulting in a single exception at the top level 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 always be zero.
OP * parse_barestmt( U32 flags) OP * Perl_parse_barestmt(pTHX_ U32 flags)
Parse a single complete Perl code block. This consists of an opening brace, a sequence of statements, and a closing brace. The block constitutes a lexical scope, so "my" variables and various compile-time effects can be contained within it. It is up to the 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 the lexical context for the statement.
The op tree representing the code block is returned. This is always a real op, never a null pointer. It will normally be a "lineseq" list, including "nextstate" or equivalent ops. No ops to construct any kind of runtime scope are included by virtue of it being a block.
If an error occurs in parsing or compilation, in most cases a valid op tree (most likely null) is returned anyway. The error is reflected in the parser state, normally resulting in a single exception at the top level 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 always be zero.
OP * parse_block( U32 flags) OP * Perl_parse_block(pTHX_ U32 flags)
Parse a single complete Perl expression. This allows the full expression grammar, including the lowest-precedence operators such as "or". The expression must be followed (and thus terminated) by a token that an expression would normally be terminated by: end-of-file, closing bracketing punctuation, semicolon, or one of the keywords that signals a postfix expression-statement modifier. If "flags" has the "PARSE_OPTIONAL" bit set, then the expression is optional, otherwise it is mandatory. It is up to the 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 the lexical context for the expression.
The op tree representing the expression is returned. If an optional expression is absent, a null pointer is returned, otherwise the pointer will be non-null.
If an error occurs in parsing or compilation, in most cases a valid op tree is returned anyway. The error is reflected in the parser state, normally resulting in a single exception at the top level of parsing which covers all the compilation errors that occurred. Some compilation errors, however, will throw an exception immediately.
OP * parse_fullexpr( U32 flags) OP * Perl_parse_fullexpr(pTHX_ U32 flags)
Parse a single complete Perl statement. This may be a normal imperative statement or a declaration that has compile-time effect, and may include optional labels. It is up to the 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 the lexical context for the statement.
The op tree representing the statement is returned. This may be a null pointer if the statement is null, for example if it was actually a subroutine definition (which has compile-time side effects). If not null, it will be the result of a "newSTATEOP" call, normally including a "nextstate" or equivalent op.
If an error occurs in parsing or compilation, in most cases a valid op tree (most likely null) is returned anyway. The error is reflected in the parser state, normally resulting in a single exception at the top level 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 always be zero.
OP * parse_fullstmt( U32 flags) OP * Perl_parse_fullstmt(pTHX_ U32 flags)
Parse a single label, possibly optional, of the type that may prefix a Perl statement. It is up to the 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. If "flags" has the "PARSE_OPTIONAL" bit set, then the label is optional, otherwise it is mandatory.
The name of the label is returned in the form of a fresh scalar. If an optional label is absent, a null pointer is returned.
If an error occurs in parsing, which can only occur if the label is mandatory, a valid label is returned anyway. The error is reflected in the parser state, normally resulting in a single exception at the top level of parsing which covers all the compilation errors that occurred.
SV * parse_label( U32 flags) SV * Perl_parse_label(pTHX_ U32 flags)
Parse a Perl list expression. This may contain operators of precedence down to the comma operator. The expression must be followed (and thus terminated) either by a low-precedence logic operator such as "or" or by something that would normally terminate an expression such as semicolon. If "flags" has the "PARSE_OPTIONAL" bit set, then the expression is optional, otherwise it is mandatory. It is up to the 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 the lexical context for the expression.
The op tree representing the expression is returned. If an optional expression is absent, a null pointer is returned, otherwise the pointer will be non-null.
If an error occurs in parsing or compilation, in most cases a valid op tree is returned anyway. The error is reflected in the parser state, normally resulting in a single exception at the top level of parsing which covers all the compilation errors that occurred. Some compilation errors, however, will throw an exception immediately.
OP * parse_listexpr( U32 flags) OP * Perl_parse_listexpr(pTHX_ U32 flags)
Parse a sequence of zero or more Perl statements. These may be normal imperative statements, including optional labels, or declarations that have compile-time effect, or any mixture thereof. The statement sequence ends when a closing brace or end-of-file is encountered in a place where a new statement could have validly started. It is up to the 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 the lexical context for the statements.
The op tree representing the statement sequence is returned. This may be a null pointer if the statements were all null, for example if there were no statements or if there were only subroutine definitions (which have compile-time side effects). If not null, it will be a "lineseq" list, normally including "nextstate" or equivalent ops.
If an error occurs in parsing or compilation, in most cases a valid op tree is returned anyway. The error is reflected in the parser state, normally resulting in a single exception at the top level 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 always be zero.
OP * parse_stmtseq( U32 flags) OP * Perl_parse_stmtseq(pTHX_ U32 flags)
Parse a subroutine signature declaration. This is the contents of the parentheses following a named or anonymous subroutine declaration when the "signatures" feature is enabled. Note that this function neither expects nor consumes the opening and closing parentheses around the signature; it is the caller's job to handle these.
This function must only be called during parsing of a subroutine; after "start_subparse" has been called. It might allocate lexical variables on the pad for the current subroutine.
The op tree to unpack the arguments from the stack at runtime is returned. This op tree should appear at the beginning of the compiled function. The caller may wish to use "op_append_list" to build their function body after it, or splice it together with the body before calling "newATTRSUB".
The "flags" parameter is reserved for future use, and must always be zero.
OP * parse_subsignature( U32 flags) OP * Perl_parse_subsignature(pTHX_ U32 flags)
Parse a Perl term expression. This may contain operators of precedence down to the assignment operators. The expression must be followed (and thus terminated) either by a comma or lower-precedence operator or by something that would normally terminate an expression such as semicolon. If "flags" has the "PARSE_OPTIONAL" bit set, then the expression is optional, otherwise it is mandatory. It is up to the 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 the lexical context for the expression.
The op tree representing the expression is returned. If an optional expression is absent, a null pointer is returned, otherwise the pointer will be non-null.
If an error occurs in parsing or compilation, in most cases a valid op tree is returned anyway. The error is reflected in the parser state, normally resulting in a single exception at the top level of parsing which covers all the compilation errors that occurred. Some compilation errors, however, will throw an exception immediately.
OP * parse_termexpr( U32 flags) OP * Perl_parse_termexpr(pTHX_ U32 flags)
Direct pointer to the end of the chunk of text currently being lexed, the end of the lexer buffer. This is equal to "SvPVX(PL_parser->linestr) + SvCUR(PL_parser->linestr)". A "NUL" character (zero octet) is always located at the end of the buffer, and does not count as part of the buffer's contents.
Points to the current position of lexing inside the lexer buffer. Characters around this point may be freely examined, within the range delimited by SvPVX("PL_parser->linestr") and "PL_parser->bufend". The octets of the buffer may be intended to be interpreted as either UTF-8 or Latin-1, as indicated by "lex_bufutf8".
Lexing code (whether in the Perl core or not) moves this pointer past the characters that it consumes. It is also expected to perform some bookkeeping whenever a newline character is consumed. This movement can be more conveniently performed by the function "lex_read_to", which handles newlines appropriately.
Interpretation of the buffer's octets can be abstracted out by using the slightly higher-level functions "lex_peek_unichar" and "lex_read_unichar".
Points to the start of the current line inside the lexer buffer. This is useful for indicating at which column an error occurred, and not much else. This must be updated by any lexing code that consumes a newline; the function "lex_read_to" handles this detail.
Buffer scalar containing the chunk currently under consideration of the text currently being lexed. This is always a plain string scalar (for which "SvPOK" is true). It is not intended to be used as a scalar by normal scalar means; instead refer to the buffer directly by the pointer variables described below.
The lexer maintains various "char*" pointers to things in the "PL_parser->linestr" buffer. If "PL_parser->linestr" is ever reallocated, all of these pointers must be updated. Don't attempt to do this manually, but rather use "lex_grow_linestr" if you need to reallocate the buffer.
The content of the text chunk in the buffer is commonly exactly one complete line of input, up to and including a newline terminator, but there are situations where it is otherwise. The octets of the buffer may be intended to be interpreted as either UTF-8 or Latin-1. The function "lex_bufutf8" tells you which. Do not use the "SvUTF8" flag on this scalar, which may disagree with it.
For direct examination of the buffer, the variable "PL_parser->bufend" points to the end of the buffer. The current lexing position is pointed to by "PL_parser->bufptr". Direct use of these pointers is usually preferable to examination of the scalar through normal scalar means.
void resume_compcv_and_save(struct suspended_compcv *buffer)
void resume_compcv_final(struct suspended_compcv *buffer)
This function saves the current state of the subroutine under compilation ("PL_compcv") into the supplied buffer. This should be used initially to create the state in the buffer, as the final thing before a "LEAVE" within a block.
ENTER;
start_subparse(0);
...
suspend_compcv(&buffer);
LEAVE;
Once suspended, the "resume_compcv_final" or "resume_compcv_and_save" function can later be used to continue the parsing from the point this stopped.
void suspend_compcv( struct suspended_compcv *buffer) void Perl_suspend_compcv(pTHX_ struct suspended_compcv *buffer)
If "flags" contains the "SVf_UTF8" bit, then the string is presumed to be encoded in UTF-8, and suitable Unicode character test functions will be used.
bool valid_identifier_pve( const char *s,
const char *end, U32 flags)
bool Perl_valid_identifier_pve(pTHX_ const char *s,
const char *end, U32 flags)
If "flags" contains the "SVf_UTF8" bit, then the string is presumed to be encoded in UTF-8, and suitable Unicode character test functions will be used.
bool valid_identifier_pvn( const char *s, STRLEN len,
U32 flags)
bool Perl_valid_identifier_pvn(pTHX_ const char *s, STRLEN len,
U32 flags)
Does not invoke "get" magic on the SV beforehand.
bool valid_identifier_sv( SV *sv) bool Perl_valid_identifier_sv(pTHX_ SV *sv)
NOTE: This API exists entirely for the purpose of making the CPAN module "XS::Parse::Infix" work. It is not expected that additional modules will make use of it; rather, that they should use "XS::Parse::Infix" to provide parsing of new infix operators.
Puts a C function into the chain of infix plugins. This is the preferred way to manipulate the "PL_infix_plugin" variable. "new_plugin" is a pointer to the C function that is to be added to the infix plugin chain, and "old_plugin_p" points to a storage location where a pointer to the next function in the chain will be stored. The value of "new_plugin" is written into the "PL_infix_plugin" variable, while the value previously stored there is written to *old_plugin_p.
Direct access to "PL_infix_plugin" should be avoided.
void wrap_infix_plugin( Perl_infix_plugin_t new_plugin,
Perl_infix_plugin_t *old_plugin_p)
void Perl_wrap_infix_plugin(pTHX_
Perl_infix_plugin_t new_plugin,
Perl_infix_plugin_t *old_plugin_p)
Puts a C function into the chain of keyword plugins. This is the preferred way to manipulate the "PL_keyword_plugin" variable. "new_plugin" is a pointer to the C function that is to be added to the keyword plugin chain, and "old_plugin_p" points to the storage location where a pointer to the next function in the chain will be stored. The value of "new_plugin" is written into the "PL_keyword_plugin" variable, while the value previously stored there is written to *old_plugin_p.
"PL_keyword_plugin" is global to an entire process, and a module wishing to hook keyword parsing may find itself invoked more than once per process, typically in different threads. To handle that situation, this function is idempotent. The location *old_plugin_p must initially (once per process) contain a null pointer. A C variable of static duration (declared at file scope, typically also marked "static" to give it internal linkage) will be implicitly initialised appropriately, if it does not have an explicit initialiser. This function will only actually modify the plugin chain if it finds *old_plugin_p to be null. This function is also thread safe on the small scale. It uses appropriate locking to avoid race conditions in accessing "PL_keyword_plugin".
When this function is called, the function referenced by "new_plugin" must be ready to be called, except for *old_plugin_p being unfilled. In a threading situation, "new_plugin" may be called immediately, even before this function has returned. *old_plugin_p will always be appropriately set before "new_plugin" is called. If "new_plugin" decides not to do anything special with the identifier that it is given (which is the usual case for most calls to a keyword plugin), it must chain the plugin function referenced by *old_plugin_p.
Taken all together, XS code to install a keyword plugin should typically look something like this:
static Perl_keyword_plugin_t next_keyword_plugin;
static OP *my_keyword_plugin(pTHX_
char *keyword_ptr, STRLEN keyword_len, OP **op_ptr)
{
if (memEQs(keyword_ptr, keyword_len,
"my_new_keyword")) {
...
} else {
return next_keyword_plugin(aTHX_
keyword_ptr, keyword_len, op_ptr);
}
}
BOOT:
wrap_keyword_plugin(my_keyword_plugin,
&next_keyword_plugin);
Direct access to "PL_keyword_plugin" should be avoided.
void wrap_keyword_plugin(Perl_keyword_plugin_t new_plugin,
Perl_keyword_plugin_t *old_plugin_p)
void Perl_wrap_keyword_plugin(pTHX_
Perl_keyword_plugin_t new_plugin,
Perl_keyword_plugin_t *old_plugin_p)
void DECLARATION_FOR_LC_NUMERIC_MANIPULATION
#ifdef I_LANGINFO
#include <langinfo.h>
#endif
#ifdef I_LOCALE
#include <locale.h>
#endif
#ifdef I_XLOCALE
#include <xlocale.h>
#endif
bool IN_LOCALE
bool IN_LOCALE_COMPILETIME
bool IN_LOCALE_RUNTIME
HV * Perl_localeconv(pTHX)
Another reason it isn't completely a drop-in replacement is that it is declared to return "const char *", whereas the system setlocale omits the "const" (presumably because its API was specified long ago, and can't be updated; it is illegal to change the information "setlocale" returns; doing so leads to segfaults.)
Finally, "Perl_setlocale" works under all circumstances, whereas plain "setlocale" can be completely ineffective on some platforms under some configurations.
Changing the locale is not a good idea when more than one thread is running, except on systems where the predefined variable "${^SAFE_LOCALES}" is non-zero. This is because on such systems the locale is global to the whole process and not local to just the thread calling the function. So changing it in one thread instantaneously changes it in all. On some such systems, the system setlocale() is ineffective, returning the wrong information, and failing to actually change the locale. z/OS refuses to try to change the locale once a second thread is created. "Perl_setlocale", should give you accurate results of what actually happened on these problematic platforms, returning NULL if the system forbade the locale change.
The return points to a per-thread static buffer, which is overwritten the next time "Perl_setlocale" is called from the same thread.
const char * Perl_setlocale(const int category,
const char *locale)
A call to "DECLARATION_FOR_LC_NUMERIC_MANIPULATION" must have been made to declare at compile time a private variable used by this macro and the two "STORE" ones. This macro should be called as a single statement, not an expression, but with an empty argument list, like this:
{
DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
...
RESTORE_LC_NUMERIC();
...
}
void RESTORE_LC_NUMERIC()
A call to "DECLARATION_FOR_LC_NUMERIC_MANIPULATION" must have been made to declare at compile time a private variable used by this macro. This macro should be called as a single statement, not an expression, but with an empty argument list, like this:
{
DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
...
STORE_LC_NUMERIC_FORCE_TO_UNDERLYING();
...
RESTORE_LC_NUMERIC();
...
}
The private variable is used to save the current locale state, so that the requisite matching call to "RESTORE_LC_NUMERIC" can restore it.
On threaded perls not operating with thread-safe functionality, this macro uses a mutex to force a critical section. Therefore the matching RESTORE should be close by, and guaranteed to be called.
void STORE_LC_NUMERIC_FORCE_TO_UNDERLYING()
This macro makes sure the current "LC_NUMERIC" state is set properly, to be aware of locale if the call to the XS or C code from the Perl program is from within the scope of a "use locale"; or to ignore locale if the call is instead from outside such scope.
This macro is the start of wrapping the C or XS code; the wrap ending is done by calling the "RESTORE_LC_NUMERIC" macro after the operation. Otherwise the state can be changed that will adversely affect other XS code.
A call to "DECLARATION_FOR_LC_NUMERIC_MANIPULATION" must have been made to declare at compile time a private variable used by this macro. This macro should be called as a single statement, not an expression, but with an empty argument list, like this:
{
DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
...
STORE_LC_NUMERIC_SET_TO_NEEDED();
...
RESTORE_LC_NUMERIC();
...
}
On threaded perls not operating with thread-safe functionality, this macro uses a mutex to force a critical section. Therefore the matching RESTORE should be close by, and guaranteed to be called; see "WITH_LC_NUMERIC_SET_TO_NEEDED" for a more contained way to ensure that.
void STORE_LC_NUMERIC_SET_TO_NEEDED()
void STORE_LC_NUMERIC_SET_TO_NEEDED_IN(bool in_lc_numeric)
The simplest to use is "sv_langinfo". It returns an SV containing the correct PV and UTF8ness, requiring no extra muss or fuss from you. New code should use this form.
"Perl_langinfo" and "Perl_langinfo8" are retained for backwards compatibility. "Perl_langinfo" is an (almost) drop-in replacement for the system "nl_langinfo(3)", but exists on systems that lack a native "nl_langinfo".
"Perl_langinfo8" is identical to "Perl_langinfo" except for an additional parameter, a pointer to a variable declared as "utf8ness_t", into which it returns to you how you should treat the returned string with regards to it being encoded in UTF-8 or not.
"Perl_langinfo" and "Perl_langinfo8" share private per-thread memory that will be changed the next time either one of them is called with any input, but not before.
Concerning the differences between these functions and plain nl_langinfo():
It is important to note that, when called with an item that is recovered by using "localeconv", the buffer from any previous explicit call to "localeconv(3)" will be overwritten. But you shouldn't be using "localeconv" anyway because it is is very much not thread-safe, and suffers from the same problems outlined in item 'b.' above for the fields it returns that are controlled by the LC_NUMERIC locale category. Instead, avoid all of those problems by calling "Perl_localeconv", which is thread-safe; or by using the methods given in perlcall to call POSIX::localeconv(), which is also thread-safe.
The details for those items which may deviate from what this emulation returns and what a native nl_langinfo() would return are specified in I18N::Langinfo.
SV * sv_langinfo ( const nl_item item)
SV * Perl_sv_langinfo (pTHX_ const nl_item item)
const char * Perl_langinfo ( const nl_item item)
const char * Perl_langinfo8( const nl_item item,
utf8ness_t *utf8ness)
It is intended so that Perl can safely be used with C libraries that access the global locale and which can't be converted to not access it. Effectively, this means libraries that call "setlocale(3)" on non-Windows systems. (For portability, it is a good idea to use it on Windows as well.)
A downside of using it is that it disables the services that Perl provides to hide locale gotchas from your code. The service you most likely will miss regards the radix character (decimal point) in floating point numbers. Code executed after this function is called can no longer just assume that this character is correct for the current circumstances.
To return to Perl control, and restart the gotcha prevention services, call "sync_locale". Behavior is undefined for any pure Perl code that executes while the switch is in effect.
The global locale and the per-thread locales are independent. As long as just one thread converts to the global locale, everything works smoothly. But if more than one does, they can easily interfere with each other, and races are likely. On Windows systems prior to Visual Studio 15 (at which point Microsoft fixed a bug), races can occur (even if only one thread has been converted to the global locale), but only if you use the following operations:
The first item is not fixable (except by upgrading to a later Visual Studio release), but it would be possible to work around the latter two items by having Perl change its algorithm for calculating these to use Windows API functions (likely "GetNumberFormat" and "GetCurrencyFormat"); patches welcome.
XS code should never call plain "setlocale", but should instead be converted to either call "Perl_setlocale" (which is a drop-in for the system "setlocale") or use the methods given in perlcall to call "POSIX::setlocale". Either one will transparently properly handle all cases of single- vs multi-thread, POSIX 2008-supported or not.
void switch_to_global_locale() void Perl_switch_to_global_locale(pTHX)
Perl will now consider itself to have control of the locale.
Since unthreaded perls have only a global locale, this function is a no-op without threads.
This function is intended for use with C libraries that do locale manipulation. It allows Perl to accommodate the use of them. Call this function before transferring back to Perl space so that it knows what state the C code has left things in.
XS code should not manipulate the locale on its own. Instead, "Perl_setlocale" can be used at any time to query or change the locale (though changing the locale is antisocial and dangerous on multi-threaded systems that don't have multi-thread safe locale operations. (See "Multi-threaded operation" in perllocale).
Using the libc "setlocale(3)" function should be avoided. Nevertheless, certain non-Perl libraries called from XS, do call it, and their behavior may not be able to be changed. This function, along with "switch_to_global_locale", can be used to get seamless behavior in these circumstances, as long as only one thread is involved.
If the library has an option to turn off its locale manipulation, doing that is preferable to using this mechanism. "Gtk" is such a library.
The return value is a boolean: TRUE if the global locale at the time of call was in effect for the caller; and FALSE if a per-thread locale was in effect.
bool sync_locale() bool Perl_sync_locale(pTHX)
WITH_LC_NUMERIC_SET_TO_NEEDED(
SNPRINTF_G(fv, ebuf, sizeof(ebuf), precis)
);
is equivalent to:
{
#ifdef USE_LOCALE_NUMERIC
DECLARATION_FOR_LC_NUMERIC_MANIPULATION;
STORE_LC_NUMERIC_SET_TO_NEEDED();
#endif
SNPRINTF_G(fv, ebuf, sizeof(ebuf), precis);
#ifdef USE_LOCALE_NUMERIC
RESTORE_LC_NUMERIC();
#endif
}
void WITH_LC_NUMERIC_SET_TO_NEEDED(block)
void WITH_LC_NUMERIC_SET_TO_NEEDED_IN(bool in_lc_numeric, block)
"Magic" is special data attached to SV structures in order to give them "magical" properties. When any Perl code tries to read from, or assign to, an SV marked as magical, it calls the 'get' or 'set' function associated with that SV's magic. A get is called prior to reading an SV, in order to give it a chance to update its internal value (get on $. writes the line number of the last read filehandle into the SV's IV slot), while set is called after an SV has been written to, in order to allow it to make use of its changed value (set on $/ copies the SV's new value to the PL_rs global variable).
Magic is implemented as a linked list of MAGIC structures attached to the SV. Each MAGIC struct holds the type of the magic, a pointer to an array of functions that implement the get(), set(), length() etc functions, plus space for some flags and pointers. For example, a tied variable has a MAGIC structure that contains a pointer to the object associated with the tie.
int mg_clear( SV *sv) int Perl_mg_clear(pTHX_ SV *sv)
int mg_copy( SV *sv, SV *nsv, const char *key,
I32 klen)
int Perl_mg_copy(pTHX_ SV *sv, SV *nsv, const char *key,
I32 klen)
MAGIC * mg_find(const SV *sv, int type) MAGIC * Perl_mg_find(const SV *sv, int type)
MAGIC * mg_findext(const SV *sv, int type,
const MGVTBL *vtbl)
MAGIC * Perl_mg_findext(const SV *sv, int type,
const MGVTBL *vtbl)
int mg_free( SV *sv) int Perl_mg_free(pTHX_ SV *sv)
void mg_free_type( SV *sv, int how) void Perl_mg_free_type(pTHX_ SV *sv, int how)
"mg_freeext(sv, how, NULL)" is equivalent to "mg_free_type(sv, how)".
void mg_freeext( SV *sv, int how, const MGVTBL *vtbl) void Perl_mg_freeext(pTHX_ SV *sv, int how, const MGVTBL *vtbl)
int mg_get( SV *sv) int Perl_mg_get(pTHX_ SV *sv)
void mg_magical(SV *sv) void Perl_mg_magical(SV *sv)
int mg_set( SV *sv) int Perl_mg_set(pTHX_ SV *sv)
SvTIED_obj(SV *sv, MAGIC *mg)
"s", if not NULL, is used as a phrase to include in the output, such as "after compilation".
void dump_mstats( const char *s) void Perl_dump_mstats(pTHX_ const char *s)
#ifdef I_MALLOCMALLOC
#include <mallocmalloc.h>
#endif
Memory obtained by this should ONLY be freed with "Safefree".
In 5.9.3, Newx() and friends replace the older New() API, and drops the first parameter, x, a debug aid which allowed callers to identify themselves. This aid has been superseded by a new build option, PERL_MEM_LOG (see "PERL_MEM_LOG" in perlhacktips). The older API is still there for use in XS modules supporting older perls.
void Newx (void* ptr, int nitems, type) void* safemalloc(size_t size)
Memory obtained by this should ONLY be freed with "Safefree".
void Newxc(void* ptr, int nitems, type, cast)
Memory obtained by this should ONLY be freed with "Safefree".
void Newxz (void* ptr, int nitems, type) void* safecalloc(size_t nitems, size_t item_size)
Memory obtained by this should ONLY be freed with "Safefree".
void Renew (void* ptr, int nitems, type) void* saferealloc(void *ptr, size_t size)
Memory obtained by this should ONLY be freed with "Safefree".
void Renewc(void* ptr, int nitems, type, cast)
This should ONLY be used on memory obtained using "Newx" and friends.
void Safefree(void* ptr)
Malloc_t safesyscalloc(MEM_SIZE elements, MEM_SIZE size) Malloc_t Perl_safesyscalloc(MEM_SIZE elements, MEM_SIZE size)
Free_t safesysfree(Malloc_t where) Free_t Perl_safesysfree(Malloc_t where)
Malloc_t safesysmalloc(MEM_SIZE nbytes) Malloc_t Perl_safesysmalloc(MEM_SIZE nbytes)
Malloc_t safesysrealloc(Malloc_t where, MEM_SIZE nbytes) Malloc_t Perl_safesysrealloc(Malloc_t where, MEM_SIZE nbytes)
These functions are related to the method resolution order of perl classes Also see perlmroapi.
struct mro_meta * HvMROMETA(HV *hv)
const struct mro_alg * Perl_mro_get_from_name(pTHX_ SV *name)
You are responsible for SvREFCNT_inc() on the return value if you plan to store it anywhere semi-permanently (otherwise it might be deleted out from under you the next time the cache is invalidated).
AV * mro_get_linear_isa( HV *stash) AV * Perl_mro_get_linear_isa(pTHX_ HV *stash)
SV* MRO_GET_PRIVATE_DATA(struct mro_meta *const smeta,
const struct mro_alg *const which)
Ideally, all instances of "PL_sub_generation++" in perl source outside of mro.c should be replaced by calls to this.
Perl automatically handles most of the common ways a method might be redefined. However, there are a few ways you could change a method in a stash without the cache code noticing, in which case you need to call this method afterwards:
1) Directly manipulating the stash HV entries from XS code.
2) Assigning a reference to a readonly scalar constant into a stash entry in order to create a constant subroutine (like constant.pm does).
This same method is available from pure perl via, mro::method_changed_in(classname).
void mro_method_changed_in( HV *stash) void Perl_mro_method_changed_in(pTHX_ HV *stash)
void Perl_mro_register(pTHX_ const struct mro_alg *mro)
Croaks if "name" hasn't been registered
void Perl_mro_set_mro(pTHX_ struct mro_meta * const meta,
SV * const name)
SV * Perl_mro_set_private_data(pTHX_
struct mro_meta * const smeta,
const struct mro_alg * const which,
SV * const data)
dMULTICALL;
MULTICALL;
POP_MULTICALL;
PUSH_MULTICALL(CV* the_cv);
On entry, "pv" points to the beginning of the string; "valptr" points to a UV that will receive the converted value, if found; "endptr" is either NULL or points to a variable that points to one byte beyond the point in "pv" that this routine should examine. If "endptr" is NULL, "pv" is assumed to be NUL-terminated.
Returns FALSE if "pv" doesn't represent a valid unsigned integer value (with no leading zeros). Otherwise it returns TRUE, and sets *valptr to that value.
If you constrain the portion of "pv" that is looked at by this function (by passing a non-NULL "endptr"), and if the initial bytes of that portion form a valid value, it will return TRUE, setting *endptr to the byte following the final digit of the value. But if there is no constraint at what's looked at, all of "pv" must be valid in order for TRUE to be returned. *endptr is unchanged from its value on input if FALSE is returned;
The only characters this accepts are the decimal digits '0'..'9'.
As opposed to atoi(3) or strtol(3), "grok_atoUV" does NOT allow optional leading whitespace, nor negative inputs. If such features are required, the calling code needs to explicitly implement those.
Note that this function returns FALSE for inputs that would overflow a UV, or have leading zeros. Thus a single 0 is accepted, but not 00 nor 01, 002, etc.
Background: "atoi" has severe problems with illegal inputs, it cannot be used for incremental parsing, and therefore should be avoided "atoi" and "strtol" are also affected by locale settings, which can also be seen as a bug (global state controlled by user environment).
bool grok_atoUV(const char *pv, UV *valptr,
const char **endptr)
bool Perl_grok_atoUV(const char *pv, UV *valptr,
const char **endptr)
On entry "start" and *len_p give the string to scan, *flags gives conversion flags, and "result" should be "NULL" or a pointer to an NV. The scan stops at the end of the string, or at just before the first invalid character. Unless "PERL_SCAN_SILENT_ILLDIGIT" is set in *flags, encountering an invalid character (except NUL) will also trigger a warning. On return *len_p 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_bin" returns "UV_MAX", sets "PERL_SCAN_GREATER_THAN_UV_MAX" in the output flags, and writes an approximation of the correct value into *result (which is an NV; or the approximation is discarded if "result" is NULL).
The binary number may optionally be prefixed with "0b" or "b" unless "PERL_SCAN_DISALLOW_PREFIX" is set in *flags on entry.
If "PERL_SCAN_ALLOW_UNDERSCORES" is set in *flags then any or all pairs of digits may be separated from each other by a single underscore; also a single leading underscore is accepted.
UV grok_bin( const char *start, STRLEN *len_p,
I32 *flags, NV *result)
UV Perl_grok_bin(pTHX_ const char *start, STRLEN *len_p,
I32 *flags, NV *result)
On entry "start" and *len_p give the string to scan, *flags gives conversion flags, and "result" should be "NULL" or a pointer to an NV. The scan stops at the end of the string, or at just before the first invalid character. Unless "PERL_SCAN_SILENT_ILLDIGIT" is set in *flags, encountering an invalid character (except NUL) will also trigger a warning. On return *len_p 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_hex" returns "UV_MAX", sets "PERL_SCAN_GREATER_THAN_UV_MAX" in the output flags, and writes an approximation of the correct value into *result (which is an NV; or the approximation is discarded if "result" is NULL).
The hex number may optionally be prefixed with "0x" or "x" unless "PERL_SCAN_DISALLOW_PREFIX" is set in *flags on entry.
If "PERL_SCAN_ALLOW_UNDERSCORES" is set in *flags then any or all pairs of digits may be separated from each other by a single underscore; also a single leading underscore is accepted.
UV grok_hex( const char *start, STRLEN *len_p,
I32 *flags, NV *result)
UV Perl_grok_hex(pTHX_ const char *start, STRLEN *len_p,
I32 *flags, NV *result)
IS_NUMBER_INFINITY
IS_NUMBER_NAN
IS_NUMBER_INFINITY | IS_NUMBER_NEG
IS_NUMBER_NAN | IS_NUMBER_NEG
0
possibly |-ed with "IS_NUMBER_TRAILING".
If an infinity or a not-a-number is recognized, *sp will point to one byte past the end of the recognized string. If the recognition fails, zero is returned, and *sp will not move.
int grok_infnan( const char **sp, const char *send) int Perl_grok_infnan(pTHX_ const char **sp, const char *send)
The returned type is the ORing of various bits (#defined in perl.h) as described below:
If the number is negative, the returned type will include the "IS_NUMBER_NEG" bit.
If the absolute value of the integral portion of the found number fits in a UV, the returned type will include the "IS_NUMBER_IN_UV" bit. If it won't fit, instead the "IS_NUMBER_GREATER_THAN_UV_MAX" bit will be included.
If the found number is not an integer, the returned type will include the "IS_NUMBER_NOT_INT" bit. This happens either if the number is expressed in exponential "e" notation, or if it includes a decimal point (radix) character. If exponential notation is used, then neither IS_NUMBER_IN_UV nor IS_NUMBER_GREATER_THAN_UV_MAX bits are set. Otherwise, the integer part of the number is used to determine the "IS_NUMBER_IN_UV" and "IS_NUMBER_GREATER_THAN_UV_MAX" bits.
If the found number is a string indicating it is infinity, the "IS_NUMBER_INFINITY" and "IS_NUMBER_NOT_INT" bits are included in the returned type.
If the found number is a string indicating it is not a number, the "IS_NUMBER_NAN" and "IS_NUMBER_NOT_INT" bits are included in the returned type.
You can get the number's absolute integral value returned to you by calling these functions with a non-NULL "valuep" argument. If the returned type includes the "IS_NUMBER_IN_UV" bit, *valuep will be set to the correct value. Otherwise, it could well have been zapped with garbage.
In "grok_number_flags" when "flags" contains the "PERL_SCAN_TRAILING" bit, and trailing non-numeric text was found, the returned type will include the "IS_NUMBER_TRAILING" bit.
int grok_number ( const char *pv, STRLEN len,
UV *valuep)
int Perl_grok_number (pTHX_ const char *pv, STRLEN len,
UV *valuep)
int grok_number_flags( const char *pv, STRLEN len,
UV *valuep, U32 flags)
int Perl_grok_number_flags(pTHX_ const char *pv, STRLEN len,
UV *valuep, U32 flags)
Scan and skip for a numeric decimal separator (radix).
bool grok_numeric_radix( const char **sp,
const char *send)
bool Perl_grok_numeric_radix(pTHX_ const char **sp,
const char *send)
bool GROK_NUMERIC_RADIX( const char **sp,
const char *send)
On entry "start" and *len_p give the string to scan, *flags gives conversion flags, and "result" should be "NULL" or a pointer to an NV. The scan stops at the end of the string, or at just before the first invalid character. Unless "PERL_SCAN_SILENT_ILLDIGIT" is set in *flags, encountering an invalid character (except NUL) will also trigger a warning. On return *len_p 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_oct" returns "UV_MAX", sets "PERL_SCAN_GREATER_THAN_UV_MAX" in the output flags, and writes an approximation of the correct value into *result (which is an NV; or the approximation is discarded if "result" is NULL).
If "PERL_SCAN_ALLOW_UNDERSCORES" is set in *flags then any or all pairs of digits may be separated from each other by a single underscore; also a single leading underscore is accepted.
The "PERL_SCAN_DISALLOW_PREFIX" flag is always treated as being set for this function.
UV grok_oct( const char *start, STRLEN *len_p,
I32 *flags, NV *result)
UV Perl_grok_oct(pTHX_ const char *start, STRLEN *len_p,
I32 *flags, NV *result)
This is also the logical inverse of Perl_isfinite().
bool isinfnan(NV nv) bool Perl_isinfnan(NV nv)
N.B. "s" must be NUL terminated.
NV my_atof( const char *s) NV Perl_my_atof(pTHX_ const char *s) NV Atof ( const char * const s)
They act like the libc "strtod(3)" function, with three exceptions:
In contrast, these expect the radix to be a dot, except when called from within the scope of "use locale", in which case they act like plain "strtod", expecting the radix to be that specified by the current locale.
NV my_strtod(const char * const s, char **e) NV Perl_my_strtod(const char * const s, char **e) NV Strtod (const char * const s, char **e)
int PERL_ABS(int x)
NV Perl_acos (NV x) NV Perl_asin (NV x) NV Perl_atan (NV x) NV Perl_atan2 (NV x, NV y) NV Perl_ceil (NV x) NV Perl_cos (NV x) NV Perl_cosh (NV x) NV Perl_exp (NV x) NV Perl_floor (NV x) NV Perl_fmod (NV x, NV y) NV Perl_frexp (NV x, int *exp) IV Perl_isfinite(NV x) IV Perl_isinf (NV x) IV Perl_isnan (NV x) NV Perl_ldexp (NV x, int exp) NV Perl_log (NV x) NV Perl_log10 (NV x) NV Perl_modf (NV x, NV *iptr) NV Perl_pow (NV x, NV y) NV Perl_sin (NV x) NV Perl_sinh (NV x) NV Perl_sqrt (NV x) NV Perl_tan (NV x) NV Perl_tanh (NV x)
Return a non-zero integer if the sign bit on an NV is set, and 0 if it is not.
If Configure detects this system has a signbit() that will work with our NVs, then we just use it via the "#define" in perl.h. Otherwise, fall back on this implementation. The main use of this function is catching -0.0.
"Configure" notes: This function is called 'Perl_signbit' instead of a plain 'signbit' because it is easy to imagine a system having a signbit() function or macro that doesn't happen to work with our particular choice of NVs. We shouldn't just re-"#define" "signbit" as "Perl_signbit" and expect the standard system headers to be happy. Also, this is a no-context function (no "pTHX_") because Perl_signbit() is usually re-"#defined" in perl.h as a simple macro call to the system's signbit(). Users should just always call Perl_signbit().
int Perl_signbit(NV f)
U8 READ_XDIGIT(char str*)
NV scan_bin( const char *start, STRLEN len,
STRLEN *retlen)
NV Perl_scan_bin(pTHX_ const char *start, STRLEN len,
STRLEN *retlen)
NV scan_hex( const char *start, STRLEN len,
STRLEN *retlen)
NV Perl_scan_hex(pTHX_ const char *start, STRLEN len,
STRLEN *retlen)
NV scan_oct( const char *start, STRLEN len,
STRLEN *retlen)
NV Perl_scan_oct(pTHX_ const char *start, STRLEN len,
STRLEN *retlen)
NV Strtol(const char * const s, char ** e, int base)
NV Strtoul(const char * const s, char ** e, int base)
Available only under threaded builds, this function allocates an entry in "PL_stashpad" for the stash passed to it.
PADOFFSET alloccopstash( HV *hv) PADOFFSET Perl_alloccopstash(pTHX_ HV *hv)
OP * block_end( I32 floor, OP *seq) OP * Perl_block_end(pTHX_ I32 floor, OP *seq)
int block_start( int full) int Perl_block_start(pTHX_ int full)
OP * ck_entersub_args_list( OP *entersubop) OP * Perl_ck_entersub_args_list(pTHX_ OP *entersubop)
"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 prototype 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 having an unacceptable number of arguments, a valid op tree is returned anyway. The error is reflected in the parser state, normally resulting in a single exception at the top level of parsing which covers all the compilation errors that occurred. In the error message, the callee is referred to by the name defined by the "namegv" parameter.
OP * ck_entersub_args_proto( OP *entersubop,
GV *namegv, SV *protosv)
OP * Perl_ck_entersub_args_proto(pTHX_ OP *entersubop,
GV *namegv, SV *protosv)
"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 used as 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 it has 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 having an unacceptable number of arguments, a valid op tree is returned anyway. The error is reflected in the parser state, normally resulting in a single exception at the top level of parsing which covers all the compilation errors that occurred. In the error message, the callee is referred to by the name defined by the "namegv" parameter.
OP * ck_entersub_args_proto_or_list( OP *entersubop,
GV *namegv,
SV *protosv)
OP * Perl_ck_entersub_args_proto_or_list(pTHX_ OP *entersubop,
GV *namegv,
SV *protosv)
Constant subs can be created with "newCONSTSUB" or as described in "Constant Functions" in perlsub.
SV * cv_const_sv(const CV * const cv) SV * Perl_cv_const_sv(const CV * const cv)
void cv_get_call_checker( CV *cv,
Perl_call_checker *ckfun_p,
SV **ckobj_p)
void Perl_cv_get_call_checker(pTHX_ CV *cv,
Perl_call_checker *ckfun_p,
SV **ckobj_p)
The C-level function pointer is returned in *ckfun_p, an SV argument for it is returned in *ckobj_p, and control flags are returned in *ckflags_p. The function is intended to be called in this manner:
entersubop = (*ckfun_p)(aTHX_ entersubop, namegv, (*ckobj_p));
In this call, "entersubop" is a pointer to the "entersub" op, which may be replaced by the check function, and "namegv" supplies the name that should be used by the check function to refer to 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.
"namegv" may not actually be a GV. If the "CALL_CHECKER_REQUIRE_GV" bit is clear in *ckflags_p, it is permitted to pass a CV or other SV instead, anything that can be used as the first argument to "cv_name". If the "CALL_CHECKER_REQUIRE_GV" bit is set in *ckflags_p then the check function requires "namegv" to be a genuine GV.
By default, the check function is Perl_ck_entersub_args_proto_or_list, the SV parameter is "cv" itself, and the "CALL_CHECKER_REQUIRE_GV" flag is clear. This implements standard prototype processing. It can be changed, for a particular subroutine, by "cv_set_call_checker_flags".
If the "CALL_CHECKER_REQUIRE_GV" bit is set in "gflags" then it indicates that the caller only knows about the genuine GV version of "namegv", and accordingly the corresponding bit will always be set in *ckflags_p, regardless of the check function's recorded requirements. If the "CALL_CHECKER_REQUIRE_GV" bit is clear in "gflags" then it indicates the caller knows about the possibility of passing something other than a GV as "namegv", and accordingly the corresponding bit may be either set or clear in *ckflags_p, indicating the check function's recorded requirements.
"gflags" is a bitset passed into "cv_get_call_checker_flags", in which only the "CALL_CHECKER_REQUIRE_GV" bit currently has a defined meaning (for which see above). All other bits should be clear.
void cv_get_call_checker_flags(CV *cv, U32 gflags,
Perl_call_checker *ckfun_p,
SV **ckobj_p,
U32 *ckflags_p)
void Perl_cv_get_call_checker_flags(pTHX_ CV *cv, U32 gflags,
Perl_call_checker *ckfun_p,
SV **ckobj_p,
U32 *ckflags_p)
void cv_set_call_checker( CV *cv,
Perl_call_checker ckfun,
SV *ckobj)
void Perl_cv_set_call_checker(pTHX_ CV *cv,
Perl_call_checker ckfun,
SV *ckobj)
The C-level function pointer is supplied in "ckfun", an SV argument for it is supplied in "ckobj", and control flags are supplied in "ckflags". The function should be defined like this:
STATIC OP * ckfun(pTHX_ OP *op, GV *namegv, SV *ckobj)
It is intended to be called in this manner:
entersubop = ckfun(aTHX_ entersubop, namegv, ckobj);
In this call, "entersubop" is a pointer to the "entersub" op, which may be replaced by the check function, and "namegv" supplies the name that should be used by the check function to refer to 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.
"namegv" may not actually be a GV. For efficiency, perl may pass a CV or other SV instead. Whatever is passed can be used as the first argument to "cv_name". You can force perl to pass a GV by including "CALL_CHECKER_REQUIRE_GV" in the "ckflags".
"ckflags" is a bitset, in which only the "CALL_CHECKER_REQUIRE_GV" bit currently has a defined meaning (for which see above). All other bits should be clear.
The current setting for a particular CV can be retrieved by "cv_get_call_checker_flags".
void cv_set_call_checker_flags( CV *cv,
Perl_call_checker ckfun,
SV *ckobj, U32 ckflags)
void Perl_cv_set_call_checker_flags(pTHX_ CV *cv,
Perl_call_checker ckfun,
SV *ckobj, U32 ckflags)
void finalize_optree( OP *o) void Perl_finalize_optree(pTHX_ OP *o)
Checks an optree that implements a block, to ensure there are no control-flow ops that attempt to leave the block. Any "OP_RETURN" is forbidden, as is any "OP_GOTO". Loops are analysed, so any LOOPEX op ("OP_NEXT", "OP_LAST" or "OP_REDO") that affects a loop that contains it within the block are permitted, but those that do not are forbidden.
If any of these forbidden constructions are detected, an exception is thrown by using the op name and the blockname argument to construct a suitable message.
This function alone is not sufficient to ensure the optree does not perform any of these forbidden activities during runtime, as it might call a different function that performs a non-local LOOPEX, or a string-eval() that performs a "goto", or various other things. It is intended purely as a compile-time check for those that could be detected statically. Additional runtime checks may be required depending on the circumstance it is used for.
Note currently that all "OP_GOTO" ops are forbidden, even in cases where they might otherwise be safe to execute. This may be permitted in a later version.
void forbid_outofblock_ops( OP *o,
const char *blockname)
void Perl_forbid_outofblock_ops(pTHX_ OP *o,
const char *blockname)
OP* LINKLIST(OP *o)
This is the same as ""newATTRSUB_x"" in perlintern with its "o_is_gv" parameter set to FALSE, and its "o" parameter to NULL. For more details, see ""newATTRSUB_x"" in perlintern.
OP * newANONATTRSUB( I32 floor, OP *proto, OP *attrs,
OP *block)
OP * Perl_newANONATTRSUB(pTHX_ I32 floor, OP *proto, OP *attrs,
OP *block)
OP * newANONHASH( OP *o) OP * Perl_newANONHASH(pTHX_ OP *o)
OP * newANONLIST( OP *o) OP * Perl_newANONLIST(pTHX_ OP *o)
This is the same as ""newATTRSUB_x"" in perlintern with its "o_is_gv" parameter set to FALSE, and its "o" and "attrs" parameters to NULL. For more details, see ""newATTRSUB_x"" in perlintern.
OP * newANONSUB( I32 floor, OP *proto, OP *block) OP * Perl_newANONSUB(pTHX_ I32 floor, OP *proto, OP *block)
OP * newARGDEFELEMOP( I32 flags, OP *expr,
I32 argindex)
OP * Perl_newARGDEFELEMOP(pTHX_ I32 flags, OP *expr,
I32 argindex)
If "optype" is "OP_ANDASSIGN", "OP_ORASSIGN", or "OP_DORASSIGN", then a suitable conditional optree is constructed. If "optype" is the opcode of a binary operator, such as "OP_BIT_OR", then an op is constructed that performs 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 is constructed. Which type of assignment it is is automatically determined. "flags" gives the eight bits of "op_flags", except that "OPf_KIDS" will be set automatically, and, shifted up eight bits, the eight bits of "op_private", except that the bit with value 1 or 2 is automatically set as required.
OP * newASSIGNOP( I32 flags, OP *left, I32 optype,
OP *right)
OP * Perl_newASSIGNOP(pTHX_ I32 flags, OP *left, I32 optype,
OP *right)
This is the same as ""newATTRSUB_x"" in perlintern with its "o_is_gv" parameter set to FALSE. This means that if "o" is null, the new sub will be anonymous; otherwise the name will be derived from "o" in the way described (as with all other details) in ""newATTRSUB_x"" in perlintern.
CV * newATTRSUB(I32 floor, OP *o, OP *proto, OP *attrs,
OP *block)
OP * newAVREF( OP *o) OP * Perl_newAVREF(pTHX_ OP *o)
OP * newBINOP( I32 type, I32 flags, OP *first,
OP *last)
OP * Perl_newBINOP(pTHX_ I32 type, I32 flags, OP *first,
OP *last)
OP * newCONDOP( I32 flags, OP *first, OP *trueop,
OP *falseop)
OP * Perl_newCONDOP(pTHX_ I32 flags, OP *first, OP *trueop,
OP *falseop)
The subroutine will have an empty prototype and will ignore any arguments when called. Its constant behaviour is determined by "sv". If "sv" is null, the subroutine will yield an empty list. If "sv" points to a scalar, the subroutine will always yield that scalar. If "sv" points to an array, the subroutine will always yield a list of the elements of that array in list context, or the number of elements in the array in scalar context. This function takes ownership of one counted reference to the scalar or array, and will arrange for the object to live as long as the subroutine does. If "sv" points to a scalar then the inlining assumes that the value of the scalar will never change, so the caller must ensure that the scalar is not subsequently written to. If "sv" points to an array then no such assumption is made, so it is ostensibly safe to mutate the array or its elements, but whether this is really supported has not been determined.
The subroutine will have "CvFILE" set according to "PL_curcop". Other aspects of the subroutine will be left in their default state. The caller is free to mutate the subroutine beyond its initial state after this function has returned.
If "name" is null then the subroutine will be anonymous, with its "CvGV" referring to an "__ANON__" glob. If "name" is non-null then the subroutine will be named accordingly, referenced by the appropriate glob.
"name" is a string, giving a sigilless symbol name. For "/newCONSTSUB", "name" is NUL-terminated, interpreted as Latin-1.
For "/newCONSTSUB_flags", "name" has length "len" bytes, hence may contain embedded NULs. It is interpreted as UTF-8 if "flags" has the "SVf_UTF8" bit set, and Latin-1 otherwise. "flags" should not have bits set other than "SVf_UTF8".
The name may be either qualified or unqualified. If the name is unqualified then it defaults to being in the stash specified by "stash" if that is non-null, or to "PL_curstash" if "stash" is null. The symbol is always added to the stash if necessary, with "GV_ADDMULTI" semantics.
If there is already a subroutine of the specified name, then the new sub will replace the existing one in the glob. A warning may be generated about the redefinition.
If the subroutine has one of a few special names, such as "BEGIN" or "END", then it will be claimed by the appropriate queue for automatic running of phase-related subroutines. In this case the relevant glob will be left not containing any subroutine, even if it did contain one before. Execution of the subroutine will likely be a no-op, unless "sv" was a tied array or the caller modified the subroutine in some interesting way before it was executed. In the case of "BEGIN", the treatment is buggy: the sub will be executed when only half built, and may be deleted prematurely, possibly causing a crash.
The function returns a pointer to the constructed subroutine. If the sub is anonymous then ownership of one counted reference to the subroutine is transferred to the caller. If the sub is named then the caller does not get ownership of a reference. In most such cases, where the sub has a non-phase name, the sub will be alive at the point it is returned by virtue of being contained in the glob that names it. A phase-named subroutine will usually be alive by virtue of the reference owned by the phase's automatic run queue. A "BEGIN" subroutine may have been destroyed already by the time this function returns, but currently bugs occur in that case before the caller gets control. It is the caller's responsibility to ensure that it knows which of these situations applies.
CV * newCONSTSUB ( HV *stash, const char *name,
SV *sv)
CV * Perl_newCONSTSUB (pTHX_ HV *stash, const char *name,
SV *sv)
CV * newCONSTSUB_flags( HV *stash, const char *name,
STRLEN len, U32 flags, SV *sv)
CV * Perl_newCONSTSUB_flags(pTHX_ HV *stash, const char *name,
STRLEN len, U32 flags, SV *sv)
OP * newCVREF( I32 flags, OP *o) OP * Perl_newCVREF(pTHX_ I32 flags, OP *o)
Constructs and returns a deferred-block statement that implements the "defer" semantics. The "block" optree is consumed by this function and becomes part of the returned optree.
The "flags" argument carries additional flags to set on the returned op, including the "op_private" field.
OP * newDEFEROP( I32 flags, OP *block) OP * Perl_newDEFEROP(pTHX_ I32 flags, OP *block)
OP * newDEFSVOP() OP * Perl_newDEFSVOP(pTHX)
"sv" optionally supplies the variable(s) that will be aliased to each item in turn; if null, it defaults to $_. "expr" supplies the list of values to iterate over. "block" supplies the main body of the loop, and "cont" optionally supplies a "continue" block that operates as a second half of the body. All of these optree inputs are consumed by this function and become part of the constructed op tree.
"flags" gives the eight bits of "op_flags" for the "leaveloop" op and, shifted up eight bits, the eight bits of "op_private" for the "leaveloop" op, except that (in both cases) some bits will be set automatically.
OP * newFOROP( I32 flags, OP *sv, OP *expr, OP *block,
OP *cont)
OP * Perl_newFOROP(pTHX_ I32 flags, OP *sv, OP *expr, OP *block,
OP *cont)
OP * newGIVENOP( OP *cond, OP *block,
PADOFFSET defsv_off)
OP * Perl_newGIVENOP(pTHX_ OP *cond, OP *block,
PADOFFSET defsv_off)
OP * newGVOP( I32 type, I32 flags, GV *gv) OP * Perl_newGVOP(pTHX_ I32 type, I32 flags, GV *gv)
OP * newGVREF( I32 type, OP *o) OP * Perl_newGVREF(pTHX_ I32 type, OP *o)
OP * newHVREF( OP *o) OP * Perl_newHVREF(pTHX_ OP *o)
For most list operators, the check function expects all the kid ops to be present already, so calling "newLISTOP(OP_JOIN, ...)" (e.g.) is not appropriate. What you want to do in that case is create an op of type "OP_LIST", append more children to it, and then call "op_convert_list". See "op_convert_list" for more information.
If a compiletime-known fixed list of child ops is required, the "newLISTOPn" function can be used as a convenient shortcut, avoiding the need to create a temporary plain "OP_LIST" in a new variable.
OP * newLISTOP( I32 type, I32 flags, OP *first,
OP *last)
OP * Perl_newLISTOP(pTHX_ I32 type, I32 flags, OP *first,
OP *last)
Do not forget to end the arguments list with a "NULL" pointer.
This function is useful as a shortcut to performing the sequence of newLISTOP(), op_append_elem() on each element and final op_convert_list() in the case where a compiletime-known fixed sequence of child ops is required. If a variable number of elements are required, or for splicing in an entire sub-list of child ops, see instead "newLISTOP" and "op_convert_list".
OP * newLISTOPn( I32 type, I32 flags, ...) OP * Perl_newLISTOPn(pTHX_ I32 type, I32 flags, ...)
OP * newLOGOP( I32 optype, I32 flags, OP *first,
OP *other)
OP * Perl_newLOGOP(pTHX_ I32 optype, I32 flags, OP *first,
OP *other)
OP * newLOOPEX( I32 type, OP *label) OP * Perl_newLOOPEX(pTHX_ I32 type, OP *label)
OP * newLOOPOP( I32 flags, I32 debuggable, OP *expr,
OP *block)
OP * Perl_newLOOPOP(pTHX_ I32 flags, I32 debuggable, OP *expr,
OP *block)
OP * newMETHOP( I32 type, I32 flags, OP *dynamic_meth) OP * Perl_newMETHOP(pTHX_ I32 type, I32 flags, OP *dynamic_meth)
OP * newMETHOP_named( I32 type, I32 flags,
SV * const_meth)
OP * Perl_newMETHOP_named(pTHX_ I32 type, I32 flags,
SV * const_meth)
OP * newNULLLIST() OP * Perl_newNULLLIST(pTHX)
OP * newOP( I32 optype, I32 flags) OP * Perl_newOP(pTHX_ I32 optype, I32 flags)
This function only exists if Perl has been compiled to use ithreads.
OP * newPADOP( I32 type, I32 flags, SV *sv) OP * Perl_newPADOP(pTHX_ I32 type, I32 flags, SV *sv)
OP * newPMOP( I32 type, I32 flags) OP * Perl_newPMOP(pTHX_ I32 type, I32 flags)
OP * newPVOP( I32 type, I32 flags, char *pv) OP * Perl_newPVOP(pTHX_ I32 type, I32 flags, char *pv)
OP * newRANGE( I32 flags, OP *left, OP *right) OP * Perl_newRANGE(pTHX_ I32 flags, OP *left, OP *right)
OP * newSLICEOP( I32 flags, OP *subscript, OP *listop) OP * Perl_newSLICEOP(pTHX_ I32 flags, OP *subscript, OP *listop)
If "o" is null, the state op is returned. Otherwise the state op is combined with "o" into a "lineseq" list op, which is returned. "o" is consumed by this function and becomes part of the returned op tree.
OP * newSTATEOP( I32 flags, char *label, OP *o) OP * Perl_newSTATEOP(pTHX_ I32 flags, char *label, OP *o)
This is the same as ""newATTRSUB_x"" in perlintern with its "o_is_gv" parameter set to FALSE, and its "attrs" parameter to NULL. This means that if "o" is null, the new sub will be anonymous; otherwise the name will be derived from "o" in the way described (as with all other details) in ""newATTRSUB_x"" in perlintern.
CV * newSUB( I32 floor, OP *o, OP *proto, OP *block) CV * Perl_newSUB(pTHX_ I32 floor, OP *o, OP *proto, OP *block)
OP * newSVOP( I32 type, I32 flags, SV *sv) OP * Perl_newSVOP(pTHX_ I32 type, I32 flags, SV *sv)
OP * newSVREF( OP *o) OP * Perl_newSVREF(pTHX_ OP *o)
Constructs and returns a conditional execution statement that implements the "try"/"catch" semantics. First the op tree in "tryblock" is executed, inside a context that traps exceptions. If an exception occurs then the optree in "catchblock" is executed, with the trapped exception set into the lexical variable given by "catchvar" (which must be an op of type "OP_PADSV"). All the optrees are consumed by this function and become part of the returned op tree.
The "flags" argument is currently ignored.
OP * newTRYCATCHOP( I32 flags, OP *tryblock,
OP *catchvar, OP *catchblock)
OP * Perl_newTRYCATCHOP(pTHX_ I32 flags, OP *tryblock,
OP *catchvar, OP *catchblock)
OP * newUNOP( I32 type, I32 flags, OP *first) OP * Perl_newUNOP(pTHX_ I32 type, I32 flags, OP *first)
OP * newUNOP_AUX( I32 type, I32 flags, OP *first,
UNOP_AUX_item *aux)
OP * Perl_newUNOP_AUX(pTHX_ I32 type, I32 flags, OP *first,
UNOP_AUX_item *aux)
OP * newWHENOP( OP *cond, OP *block) OP * Perl_newWHENOP(pTHX_ OP *cond, OP *block)
"loop" is an optional preconstructed "enterloop" op to use in the loop; if it is null then a suitable op will be constructed automatically. "expr" supplies the loop's controlling expression. "block" supplies the main body of the loop, and "cont" optionally supplies a "continue" block that operates as a second half of the body. All of these optree inputs are consumed by this function and become part of the constructed op tree.
"flags" gives the eight bits of "op_flags" for the "leaveloop" op and, shifted up eight bits, the eight bits of "op_private" for the "leaveloop" op, except that (in both cases) some bits will be set automatically. "debuggable" is currently unused and should always be 1. "has_my" can be supplied as true to force the loop body to be enclosed in its own scope.
OP * newWHILEOP( I32 flags, I32 debuggable,
LOOP *loop, OP *expr, OP *block,
OP *cont, I32 has_my)
OP * Perl_newWHILEOP(pTHX_ I32 flags, I32 debuggable,
LOOP *loop, OP *expr, OP *block,
OP *cont, I32 has_my)
OP * op_append_elem( I32 optype, OP *first, OP *last) OP * Perl_op_append_elem(pTHX_ I32 optype, OP *first, OP *last)
OP * op_append_list( I32 optype, OP *first, OP *last) OP * Perl_op_append_list(pTHX_ I32 optype, OP *first, OP *last)
For custom ops the type is returned from the registration, and it is up to the registree to ensure it is accurate. The value returned will be one of the "OA_"* constants from op.h.
U32 OP_CLASS(OP *o)
OP * op_contextualize( OP *o, I32 context) OP * Perl_op_contextualize(pTHX_ OP *o, I32 context)
A list-type op is usually constructed one kid at a time via "newLISTOP", "op_prepend_elem" and "op_append_elem". Then finally it is passed to "op_convert_list" to make it the right type.
OP * op_convert_list( I32 optype, I32 flags, OP *o) OP * Perl_op_convert_list(pTHX_ I32 optype, I32 flags, OP *o)
const char * OP_DESC(OP *o)
This is often what you want to do before putting the optree into list context; as
o = op_contextualize(op_force_list(o), G_LIST);
OP * op_force_list( OP *o) OP * Perl_op_force_list(pTHX_ OP *o)
Remember that any op with "OPf_KIDS" set is expected to have a valid "op_first" pointer. If you are attempting to free an op but preserve its child op, make sure to clear that flag before calling op_free(). For example:
OP *kid = o->op_first; o->op_first = NULL;
o->op_flags &= ~OPf_KIDS;
op_free(o);
void op_free( OP *arg) void Perl_op_free(pTHX_ OP *arg)
OP * op_linklist( OP *o) OP * Perl_op_linklist(pTHX_ OP *o)
Propagate lvalue ("modifiable") context to an op and its children. "type" represents the context type, roughly based on the type of op that would 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 on the lvalue op).
This function detects things that can't be modified, such as "$x+1", and generates errors for them. For example, "$x+1 = 2" would cause it to be called 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.
OP * op_lvalue(OP *o, I32 type)
const char * OP_NAME(OP *o)
void op_null( OP *o) void Perl_op_null(pTHX_ OP *o)
OP * op_parent(OP *o) OP * Perl_op_parent(OP *o)
OP * op_prepend_elem( I32 optype, OP *first, OP *last) OP * Perl_op_prepend_elem(pTHX_ I32 optype, OP *first, OP *last)
Wraps up an op tree with some additional ops so that at runtime a dynamic scope 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 will normally be an "enter"/"leave" pair, but a "scope" op may be used instead if the ops are simple enough to not need the full dynamic scope structure.
OP * op_scope( OP *o) OP * Perl_op_scope(pTHX_ OP *o)
Note that op_next is not manipulated, and nodes are not freed; that is the responsibility of the caller. It also won't create a new list op for an empty list etc; use higher-level functions like op_append_elem() for that.
"parent" is the parent node of the sibling chain. It may passed as "NULL" if the splicing doesn't affect the first or last op in the chain.
"start" is the node preceding the first node to be spliced. Node(s) following it will be deleted, and ops will be inserted after it. If it is "NULL", the first node onwards is deleted, and nodes are inserted at the beginning.
"del_count" is the number of nodes to delete. If zero, no nodes are deleted. If -1 or greater than or equal to the number of remaining kids, all remaining kids are deleted.
"insert" is the first of a chain of nodes to be inserted in place of the nodes. If "NULL", no nodes are inserted.
The head of the chain of deleted ops is returned, or "NULL" if no ops were deleted.
For example:
action before after returns
------ ----- ----- -------
P P
splice(P, A, 2, X-Y-Z) | | B-C
A-B-C-D A-X-Y-Z-D
P P
splice(P, NULL, 1, X-Y) | | A
A-B-C-D X-Y-B-C-D
P P
splice(P, NULL, 3, NULL) | | A-B-C
A-B-C-D D
P P
splice(P, B, 0, X-Y) | | NULL
A-B-C-D A-B-X-Y-C-D
For lower-level direct manipulation of "op_sibparent" and "op_moresib", see "OpMORESIB_set", "OpLASTSIB_set", "OpMAYBESIB_set".
OP * op_sibling_splice( OP *parent, OP *start,
int del_count, OP *insert)
OP * Perl_op_sibling_splice(pTHX_ OP *parent, OP *start,
int del_count, OP *insert)
The negation of this macro, "OP_TYPE_ISNT" is also available as well as "OP_TYPE_IS_NN" and "OP_TYPE_ISNT_NN" which elide the NULL pointer check.
bool OP_TYPE_IS(OP *o, Optype type)
The negation of this macro, "OP_TYPE_ISNT_AND_WASNT" is also available as well as "OP_TYPE_IS_OR_WAS_NN" and "OP_TYPE_ISNT_AND_WASNT_NN" which elide the "NULL" pointer check.
bool OP_TYPE_IS_OR_WAS(OP *o, Optype type)
Wraps the given "block" optree fragment in its own scoped block, arranging for the "finally" optree fragment to be invoked when leaving that block for any reason. Both optree fragments are consumed and the combined result is returned.
OP * op_wrap_finally( OP *block, OP *finally) OP * Perl_op_wrap_finally(pTHX_ OP *block, OP *finally)
bool OpHAS_SIBLING(OP *o)
void OpLASTSIB_set(OP *o, OP *parent)
void OpMAYBESIB_set(OP *o, OP *sib, OP *parent)
void OpMORESIB_set(OP *o, OP *sib)
OP* OpSIBLING(OP *o)
void optimize_optree( OP *o) void Perl_optimize_optree(pTHX_ OP *o)
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.
On threaded perls, each thread has an independent copy of this variable; each initialized at creation time with the current value of the creating thread's copy.
Perl_ophook_t PL_opfreehook
The peephole optimiser should never be completely replaced. Rather, add code to it by wrapping the existing optimiser. The basic way to do this can be seen in "Compile pass 3: peephole optimization" in perlguts. If the new code wishes to operate on ops throughout the subroutine's structure, rather than just at the top level, it is likely to be more convenient to wrap the "PL_rpeepp" hook.
On threaded perls, each thread has an independent copy of this variable; each initialized at creation time with the current value of the creating thread's copy.
peep_t PL_peepp
The peephole optimiser should never be completely replaced. Rather, add code to it by wrapping the existing optimiser. The basic way to do this 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 convenient to wrap the "PL_peepp" hook.
On threaded perls, each thread has an independent copy of this variable; each initialized at creation time with the current value of the creating thread's copy.
peep_t PL_rpeepp
Currently, the subroutine can be identified statically if the RV that the "rv2cv" 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 is suitable if the constant value must be an RV pointing to a CV. Details of this process may change in future versions of Perl. If the "rv2cv" op has the "OPpENTERSUB_AMPER" flag set then no attempt is made to identify the subroutine statically: this flag is used to suppress compile-time magic on a subroutine call, forcing it to use default runtime behaviour.
If "flags" has the bit "RV2CVOPCV_MARK_EARLY" set, then the handling of a GV reference is modified. If a GV was examined and its CV slot was found 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 with a 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 instead of returning a pointer to the subroutine it returns a pointer to the GV 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 the referencing GV. The resulting "GV*" is cast to "CV*" to be returned. A null pointer is returned as usual if there is no statically-determinable subroutine.
CV * rv2cv_op_cv( OP *cvop, U32 flags) CV * Perl_rv2cv_op_cv(pTHX_ OP *cvop, U32 flags)
void packlist( SV *cat, const char *pat,
const char *patend, SV **beglist,
SV **endlist)
void Perl_packlist(pTHX_ SV *cat, const char *pat,
const char *patend, SV **beglist,
SV **endlist)
Using the template "pat..patend", this function unpacks the string "s..strend" into a number of mortal SVs, which it pushes onto the perl argument (@_) stack (so you will need to issue a "PUTBACK" before and "SPAGAIN" after the call to this function). It returns the number of pushed elements.
The "strend" and "patend" pointers should point to the byte following the last character of each string.
Although this function returns its values on the perl argument stack, it doesn't take any parameters from that stack (and thus in particular there's no need to do a "PUSHMARK" before calling it, unlike "call_pv" for example).
SSize_t unpackstring( const char *pat,
const char *patend,
const char *s,
const char *strend, U32 flags)
SSize_t Perl_unpackstring(pTHX_ const char *pat,
const char *patend,
const char *s,
const char *strend, U32 flags)
CV's can have CvPADLIST(cv) set to point to a PADLIST. This is the CV's scratchpad, which stores lexical variables and opcode temporary and per-thread values.
For these purposes "formats" are a kind-of CV; eval""s are too (except they're not callable at will and are always thrown away after the eval"" is done executing). Require'd files are simply evals without any outer lexical scope.
XSUBs do not have a "CvPADLIST". "dXSTARG" fetches values from "PL_curpad", but that is really the callers pad (a slot of which is allocated by every entersub). Do not get or set "CvPADLIST" if a CV is an XSUB (as determined by CvISXSUB()), "CvPADLIST" slot is reused for a different internal purpose in XSUBs.
The PADLIST has a C array where pads are stored.
The 0th entry of the PADLIST is a PADNAMELIST which represents the "names" or rather the "static type information" for lexicals. The individual elements of a PADNAMELIST are PADNAMEs. Future refactorings might stop the PADNAMELIST from being stored in the PADLIST's array, so don't rely on it. See "PadlistNAMES".
The CvDEPTH'th entry of a PADLIST is a PAD (an AV) which is the stack frame at that depth of recursion into the CV. The 0th slot of a frame AV is an AV which is @_. Other entries are storage for variables and op targets.
Iterating over the PADNAMELIST iterates over all possible pad items. Pad slots for targets ("SVs_PADTMP") and GVs end up having &PL_padname_undef "names", while slots for constants have &PL_padname_const "names" (see "pad_alloc"). That &PL_padname_undef and &PL_padname_const are used is an implementation detail subject to change. To test for them, use "!PadnamePV(name)" and "PadnamePV(name) && !PadnameLEN(name)", respectively.
Only "my"/"our" variable slots get valid names. The rest are op targets/GVs/constants which are statically allocated or resolved at compile time. These don't have names by which they can be looked up from Perl code at run time through eval"" the way "my"/"our" variables can be. Since they can't be looked up by "name" but only by their index allocated at compile time (which is usually in "PL_op->op_targ"), wasting a name SV for them doesn't make sense.
The pad names in the PADNAMELIST have their PV holding the name of the variable. The "COP_SEQ_RANGE_LOW" and "_HIGH" fields form a range (low+1..high inclusive) of cop_seq numbers for which the name is valid. During compilation, these fields may hold the special value PERL_PADSEQ_INTRO to indicate various stages:
COP_SEQ_RANGE_LOW _HIGH
----------------- -----
PERL_PADSEQ_INTRO 0 variable not yet introduced:
{ my ($x
valid-seq# PERL_PADSEQ_INTRO variable in scope:
{ my ($x);
valid-seq# valid-seq# compilation of scope complete:
{ my ($x); .... }
When a lexical var hasn't yet been introduced, it already exists from the perspective of duplicate declarations, but not for variable lookups, e.g.
my ($x, $x); # '"my" variable $x masks earlier declaration'
my $x = $x; # equal to my $x = $::x;
For typed lexicals "PadnameTYPE" points at the type stash. For "our" lexicals, "PadnameOURSTASH" points at the stash of the associated global (so that duplicate "our" declarations in the same package can be detected). "PadnameGEN" is sometimes used to store the generation number during compilation.
If "PadnameOUTER" is set on the pad name, then that slot in the frame AV is a REFCNT'ed reference to a lexical from "outside". Such entries are sometimes referred to as 'fake'. In this case, the name does not use 'low' and 'high' to store a cop_seq range, since it is in scope throughout. Instead 'high' stores some flags containing info about the real lexical (is it declared in an anon, and is it capable of being instantiated multiple times?), and for fake ANONs, 'low' contains the index within the parent's pad where the lexical's value is stored, to make cloning quicker.
If the 'name' is "&" the corresponding entry in the PAD is a CV representing a possible closure.
Note that formats are treated as anon subs, and are cloned each time write 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" warning to be generated in evals, such as
{ my $x = 1; sub f { eval '$x'} } f();
For state vars, "SVs_PADSTALE" is overloaded to mean 'not yet initialised', but this internal state is stored in a separate pad entry.
PADLIST * CvPADLIST(CV *cv)
PADOFFSET pad_add_name_pvs("name", U32 flags, HV *typestash,
HV *ourstash)
padnew_CLONE this pad is for a cloned CV
padnew_SAVE save old globals on the save stack
padnew_SAVESUB also save extra stuff for start of sub
PADLIST * pad_new( int flags) PADLIST * Perl_pad_new(pTHX_ int flags)
The C array of pad entries.
SV ** PadARRAY(PAD * pad)
The C array of a padlist, containing the pads. Only subscript it with numbers >= 1, as the 0th entry is not guaranteed to remain usable.
PAD ** PadlistARRAY(PADLIST * padlist)
The index of the last allocated space in the padlist. Note that the last pad may be in an earlier slot. Any entries following it will be "NULL" in that case.
SSize_t PadlistMAX(PADLIST * padlist)
The names associated with pad entries.
PADNAMELIST * PadlistNAMES(PADLIST * padlist)
The C array of pad names.
PADNAME ** PadlistNAMESARRAY(PADLIST * padlist)
The index of the last pad name.
SSize_t PadlistNAMESMAX(PADLIST * padlist)
The reference count of the padlist. Currently this is always 1.
U32 PadlistREFCNT(PADLIST * padlist)
The index of the last pad entry.
SSize_t PadMAX(PAD * pad)
The length of the name.
STRLEN PadnameLEN(PADNAME * pn)
The C array of pad names.
PADNAME ** PadnamelistARRAY(PADNAMELIST * pnl)
The index of the last pad name.
SSize_t PadnamelistMAX(PADNAMELIST * pnl)
The reference count of the pad name list.
SSize_t PadnamelistREFCNT(PADNAMELIST * pnl)
Lowers the reference count of the pad name list.
void PadnamelistREFCNT_dec(PADNAMELIST * pnl)
The name stored in the pad name struct. This returns "NULL" for a target slot.
char * PadnamePV(PADNAME * pn)
The reference count of the pad name.
SSize_t PadnameREFCNT(PADNAME * pn)
Lowers the reference count of the pad name.
void PadnameREFCNT_dec(PADNAME * pn)
Increases the reference count of the pad name. Returns the pad name itself.
PADNAME * PadnameREFCNT_inc(PADNAME * pn)
Returns the pad name as a mortal SV.
SV * PadnameSV(PADNAME * pn)
Whether PadnamePV is in UTF-8. Currently, this is always true.
bool PadnameUTF8(PADNAME * pn)
During compilation, this points to the array containing the values part of the pad for the currently-compiling code. (At runtime a CV may have many such value arrays; at compile time just one is constructed.) At runtime, this points to the array containing the currently-relevant values for the pad for the currently-executing code.
During compilation, this points to the array containing the names part of the pad for the currently-compiling code.
Points directly to the body of the "PL_comppad" array. (I.e., this is PadARRAY(PL_comppad).)
Described in perlguts.
extern int dbminit(char *);
extern double drand48(void);
extern int flock(int, int);
extern void* sbrk(int);
extern void* sbrk(size_t);
extern int setresgid(uid_t ruid, uid_t euid, uid_t suid);
extern int setresuid(uid_t ruid, uid_t euid, uid_t suid);
extern int sockatmark(int);
extern int syscall(int, ...);
extern int syscall(long, ...);
extern long telldir(DIR*);
Functions for pushing and pulling items on the stack when the stack is reference counted. They are intended as replacements for the old PUSHs, POPi, EXTEND etc pp macros within pp functions.
Impose void, scalar or list context on the stack. First, pop "extra" items off the stack, then when "gimme" is: "G_LIST": return as-is. "G_VOID": pop everything back to "mark" "G_SCALAR": move the top stack item (or &PL_sv_undef if none) to "mark+1" and free everything above it.
void rpp_context( SV **mark, U8 gimme, SSize_t extra) void Perl_rpp_context(pTHX_ SV **mark, U8 gimme, SSize_t extra)
Ensures that there is space on the stack to push "n" items, extending it if necessary.
void rpp_extend( SSize_t n) void Perl_rpp_extend(pTHX_ SSize_t n)
Call the XS function associated with "cv". Wraps the call if necessary to handle XS functions which are not aware of reference-counted stacks.
void rpp_invoke_xs( CV *cv) void Perl_rpp_invoke_xs(pTHX_ CV *cv)
Indicates whether the stacked SV "sv" (assumed to be not yet popped off the stack) is only kept alive due to a single reference from the argument stack and/or and the temps stack.
This can used for example to decide whether the copying of return values in rvalue context can be skipped, or whether it shouldn't be assigned to in lvalue context.
bool rpp_is_lone( SV *sv) bool Perl_rpp_is_lone(pTHX_ SV *sv)
Pop and return the top item off the argument stack and update "PL_stack_sp". It's similar to rpp_popfree_1(), except that it actually returns a value, and it doesn't decrement the SV's reference count. On non-"PERL_RC_STACK" builds it actually increments the SV's reference count.
This is useful in cases where the popped value is immediately embedded somewhere e.g. via av_store(), allowing you skip decrementing and then immediately incrementing the reference count again (and risk prematurely freeing the SV if it had a RC of 1). On non-RC builds, the reference count bookkeeping still works too, which is why it should be used rather than a simple "*PL_stack_sp--".
SV * rpp_pop_1_norc() SV * Perl_rpp_pop_1_norc(pTHX)
Pop and free all items on the argument stack above "sp". On return, "PL_stack_sp" will be equal to "sp".
void rpp_popfree_to( SV **sp) void Perl_rpp_popfree_to(pTHX_ SV **sp)
A variant of rpp_popfree_to() which assumes that all the pointers being popped off the stack are non-NULL.
void rpp_popfree_to_NN( SV **sp) void Perl_rpp_popfree_to_NN(pTHX_ SV **sp)
Pop and free the top item on the argument stack and update "PL_stack_sp".
void rpp_popfree_1() void Perl_rpp_popfree_1(pTHX)
A variant of rpp_popfree_1() which assumes that the pointer being popped off the stack is non-NULL.
void rpp_popfree_1_NN() void Perl_rpp_popfree_1_NN(pTHX)
Pop and free the top two items on the argument stack and update "PL_stack_sp".
void rpp_popfree_2() void Perl_rpp_popfree_2(pTHX)
A variant of rpp_popfree_2() which assumes that the two pointers being popped off the stack are non-NULL.
void rpp_popfree_2_NN() void Perl_rpp_popfree_2_NN(pTHX)
Push one or two SVs onto the stack, incrementing their reference counts and updating "PL_stack_sp". With the "x" variants, it extends the stack first. The "IMM" variants assume that the single argument is an immortal such as <&PL_sv_undef> and, for efficiency, will skip incrementing its reference count.
void rpp_push_1 ( SV *sv) void Perl_rpp_push_1 (pTHX_ SV *sv) void rpp_push_IMM ( SV *sv) void Perl_rpp_push_IMM (pTHX_ SV *sv) void rpp_push_2 ( SV *sv1, SV *sv2) void Perl_rpp_push_2 (pTHX_ SV *sv1, SV *sv2) void rpp_xpush_1 ( SV *sv) void Perl_rpp_xpush_1 (pTHX_ SV *sv) void rpp_xpush_IMM( SV *sv) void Perl_rpp_xpush_IMM(pTHX_ SV *sv) void rpp_xpush_2 ( SV *sv1, SV *sv2) void Perl_rpp_xpush_2 (pTHX_ SV *sv1, SV *sv2)
Push "sv" onto the stack without incrementing its reference count, and update "PL_stack_sp". On non-PERL_RC_STACK builds, mortalise too.
This is most useful where an SV has just been created and already has a reference count of 1, but has not yet been anchored anywhere.
void rpp_push_1_norc( SV *sv) void Perl_rpp_push_1_norc(pTHX_ SV *sv)
Replace the SV at address sp within the stack with "sv", while suitably adjusting reference counts. Equivalent to "*sp = sv", except with proper reference count handling.
void rpp_replace_at( SV **sp, SV *sv) void Perl_rpp_replace_at(pTHX_ SV **sp, SV *sv)
A variant of rpp_replace_at() which assumes that the SV pointer on the stack is non-NULL.
void rpp_replace_at_NN( SV **sp, SV *sv) void Perl_rpp_replace_at_NN(pTHX_ SV **sp, SV *sv)
Replace the SV at address sp within the stack with "sv", while suitably adjusting the reference count of the old SV. Equivalent to "*sp = sv", except with proper reference count handling.
"sv"'s reference count doesn't get incremented. On non-"PERL_RC_STACK" builds, it gets mortalised too.
This is most useful where an SV has just been created and already has a reference count of 1, but has not yet been anchored anywhere.
void rpp_replace_at_norc( SV **sp, SV *sv) void Perl_rpp_replace_at_norc(pTHX_ SV **sp, SV *sv)
A variant of rpp_replace_at_norc() which assumes that the SV pointer on the stack is non-NULL.
void rpp_replace_at_norc_NN( SV **sp, SV *sv) void Perl_rpp_replace_at_norc_NN(pTHX_ SV **sp, SV *sv)
Replace the current top stack item with "sv", while suitably adjusting reference counts. Equivalent to rpp_popfree_1(); rpp_push_1(sv), but is more efficient and handles both SVs being the same.
The "_NN" variant assumes that the pointer on the stack to the SV being freed is non-NULL.
The "IMM_NN" variant is like the "_NN" variant, but in addition, assumes that the single argument is an immortal such as <&PL_sv_undef> and, for efficiency, will skip incrementing its reference count.
void rpp_replace_1_1 ( SV *sv) void Perl_rpp_replace_1_1 (pTHX_ SV *sv) void rpp_replace_1_1_NN ( SV *sv) void Perl_rpp_replace_1_1_NN (pTHX_ SV *sv) void rpp_replace_1_IMM_NN( SV *sv) void Perl_rpp_replace_1_IMM_NN(pTHX_ SV *sv)
Replace the current top to stacks item with "sv", while suitably adjusting reference counts. Equivalent to rpp_popfree_2(); rpp_push_1(sv), but is more efficient and handles SVs being the same.
The "_NN" variant assumes that the pointers on the stack to the SVs being freed are non-NULL.
The "IMM_NN" variant is like the "_NN" variant, but in addition, assumes that the single argument is an immortal such as <&PL_sv_undef> and, for efficiency, will skip incrementing its reference count.
void rpp_replace_2_1 ( SV *sv) void Perl_rpp_replace_2_1 (pTHX_ SV *sv) void rpp_replace_2_1_NN ( SV *sv) void Perl_rpp_replace_2_1_NN (pTHX_ SV *sv) void rpp_replace_2_IMM_NN( SV *sv) void Perl_rpp_replace_2_IMM_NN(pTHX_ SV *sv)
Returns a boolean value indicating whether the stack is currently reference-counted. Note that if the stack is split (bottom half RC, top half non-RC), this function returns false, even if the top half currently contains zero items.
bool rpp_stack_is_rc() bool Perl_rpp_stack_is_rc(pTHX)
Check whether either of the one or two SVs at the top of the stack is magical or a ref, and in either case handle it specially: invoke get magic, call an overload method, or replace a ref with a temporary numeric value, as appropriate. If this function returns true, it indicates that the correct return value is already on the stack. Intended to be used at the beginning of the PP function for unary or binary ops.
bool rpp_try_AMAGIC_1( int method, int flags) bool Perl_rpp_try_AMAGIC_1(pTHX_ int method, int flags) bool rpp_try_AMAGIC_2( int method, int flags) bool Perl_rpp_try_AMAGIC_2(pTHX_ int method, int flags)
Declare and wrap a non-reference-counted PP-style function. On traditional perl builds where the stack isn't reference-counted, this just produces a function declaration like
OP * xsppw_name(pTHX)
Conversely, in ref-counted builds it creates xsppw_name() as a small wrapper function which calls the real function via a wrapper which processes the args and return values to ensure that reference counts are properly handled for code which uses old-style dSP, PUSHs(), POPs() etc, which don't adjust the reference counts of the items they manipulate.
xsppw_nargs indicates how many arguments the function consumes off the stack. It can be a constant value or an expression, such as
((PL_op->op_flags & OPf_STACKED) ? 2 : 1)
Alternatively if xsppw_nlists is 1, it indicates that the PP function consumes a list (or - rarely - if 2, consumes two lists, like pp_aassign()), as indicated by the top markstack position.
This is intended as a temporary fix when converting XS code to run under PERL_RC_STACK builds. In the longer term, the PP function should be rewritten to replace PUSHs() etc with rpp_push_1() etc.
XSPP_wrapped(xsppw_name, I32 xsppw_nargs, I32 xsppw_nlists)
REGEXP * pregcomp( SV * const pattern,
const U32 flags)
REGEXP * Perl_pregcomp(pTHX_ SV * const pattern,
const U32 flags)
I32 pregexec( REGEXP * const prog,
char *stringarg, char *strend,
char *strbeg, SSize_t minend,
SV *screamer, U32 nosave)
I32 Perl_pregexec(pTHX_ REGEXP * const prog,
char *stringarg, char *strend,
char *strbeg, SSize_t minend,
SV *screamer, U32 nosave)
This function is typically used by a custom regexp engine ".comp()" function to hand off to the core regexp engine those patterns it doesn't want to handle itself (typically passing through the same flags it was called with). In almost all other cases, a regexp should be compiled by calling ""pregcomp"" to compile using the currently active regexp engine.
If "pattern" is already a "REGEXP", this function does nothing but return a pointer to the input. Otherwise the PV is extracted and treated like a string representing a pattern. See perlre.
The possible flags for "rx_flags" are documented in perlreapi. Their names all begin with "RXf_".
REGEXP * re_compile( SV * const pattern,
U32 orig_rx_flags)
REGEXP * Perl_re_compile(pTHX_ SV * const pattern,
U32 orig_rx_flags)
This routine is expected to clone a given regexp structure. It is only compiled under USE_ITHREADS.
After all of the core data stored in struct regexp is duplicated the "regexp_engine.dupe" method is used to copy any private data stored in the *pprivate pointer. This allows extensions to handle any duplication they need to do.
void re_dup_guts( const REGEXP *sstr, REGEXP *dstr,
CLONE_PARAMS *param)
void Perl_re_dup_guts(pTHX_ const REGEXP *sstr, REGEXP *dstr,
CLONE_PARAMS *param)
Any patch that adds items to this struct will need to include changes to sv.c (Perl_re_dup()) and regcomp.c (pregfree()). This involves freeing or cloning items in the regexp's data array based on the data item's type.
In order to install a new regexp handler, $^H{regcomp} is set to an integer which (when casted appropriately) resolves to one of these structures. When compiling, the "comp" method is executed, and the resulting "regexp" structure's engine field is expected to point back at the same structure.
The pTHX_ symbol in the definition is a macro used by Perl under threading to provide an extra argument to the routine holding a pointer back to the interpreter that is executing the regexp. So under threading all routines get an extra argument.
RX_MATCH_COPIED(const REGEXP * rx_sv)
if (SvMAGICAL(sv))
mg_get(sv);
if (SvROK(sv))
sv = MUTABLE_SV(SvRV(sv));
if (SvTYPE(sv) == SVt_REGEXP)
return (REGEXP*) sv;
"NULL" will be returned if a REGEXP* is not found.
REGEXP * SvRX(SV *sv)
If you want to do something with the REGEXP* later use SvRX instead and check for NULL.
bool SvRXOK(SV* sv)
These are used in the simple report generation feature of Perl. See perlform.
GV * IoBOTTOM_GV (IO *io) char * IoBOTTOM_NAME(IO *io) GV * IoFMT_GV (IO *io) char * IoFMT_NAME (IO *io) IV IoLINES (IO *io) IV IoLINES_LEFT (IO *io) IV IoPAGE (IO *io) IV IoPAGE_LEN (IO *io) GV * IoTOP_GV (IO *io) char * IoTOP_NAME (IO *io)
U32 PERL_SIGNALS_UNSAFE_FLAG
Sighandler_t rsignal( int i, Sighandler_t t) Sighandler_t Perl_rsignal(pTHX_ int i, Sighandler_t t)
Sighandler_t rsignal_state( int i) Sighandler_t Perl_rsignal_state(pTHX_ int i)
char *sig_name[] = { SIG_NAME };
The signals in the list are separated with commas, and each signal is surrounded by double quotes. There is no leading "SIG" in the signal name, i.e. "SIGQUIT" is known as ""QUIT"". Gaps in the signal numbers (up to "NSIG") are filled in with "NUMnn", etc., where nn is the actual signal number (e.g. "NUM37"). The signal number for "sig_name[i]" is stored in "sig_num[i]". The last element is 0 to terminate the list with a "NULL". This corresponds to the 0 at the end of the "sig_name_init" list. Note that this variable is initialized from the "sig_name_init", not from "sig_name" (which is unused).
int sig_num[] = { SIG_NUM };
The signals in the list are separated with commas, and the indices within that list and the "SIG_NAME" list match, so it's easy to compute the signal name from a number or vice versa at the price of a small dynamic linear lookup. Duplicates are allowed, but are moved to the end of the list. The signal number corresponding to "sig_name[i]" is "sig_number[i]". if (i < "NSIG") then "sig_number[i]" == i. The last element is 0, corresponding to the 0 at the end of the "sig_name_init" list. Note that this variable is initialized from the "sig_num_init", not from "sig_num" (which is unused).
void Siglongjmp(jmp_buf env, int val)
int Sigsetjmp(jmp_buf env, int savesigs)
They differ only in the source of the signal name:
"whichsig_pv" takes the name from the "NUL"-terminated string starting at "sig".
"whichsig" is merely a different spelling, a synonym, of "whichsig_pv".
"whichsig_pvn" takes the name from the string starting at "sig", with length "len" bytes.
"whichsig_sv" takes the name from the PV stored in the SV "sigsv".
I32 whichsig ( const char *sig) I32 whichsig_pv ( const char *sig) I32 Perl_whichsig_pv (pTHX_ const char *sig) I32 whichsig_pvn( const char *sig, STRLEN len) I32 Perl_whichsig_pvn(pTHX_ const char *sig, STRLEN len) I32 whichsig_sv ( SV *sigsv) I32 Perl_whichsig_sv (pTHX_ SV *sigsv)
These variables give details as to where various libraries, installation destinations, etc., go, as well as what various installation options were selected
MakeMaker Makefile.PL INSTALLDIRS=vendor
or equivalent. See INSTALL for details.
MakeMaker Makefile.PL
or equivalent. See INSTALL for details.
MakeMaker Makefile.PL
or equivalent. See INSTALL for details.
#ifdef I_SOCKS
#include <socks.h>
#endif
#ifdef I_SYS_SOCKIO
#include <sys_sockio.h>
#endif
OP * apply_builtin_cv_attributes( CV *cv,
OP *attrlist)
OP * Perl_apply_builtin_cv_attributes(pTHX_ CV *cv,
OP *attrlist)
SV * filter_add( filter_t funcp, SV *datasv) SV * Perl_filter_add(pTHX_ filter_t funcp, SV *datasv)
void filter_del( filter_t funcp) void Perl_filter_del(pTHX_ filter_t funcp)
I32 filter_read( int idx, SV *buf_sv, int maxlen) I32 Perl_filter_read(pTHX_ int idx, SV *buf_sv, int maxlen)
Function must be called like
sv = sv_2mortal(newSV(5));
s = scan_vstring(s,e,sv);
where s and e are the start and end of the string. The sv should already be large enough to store the vstring passed in, for performance reasons.
This function may croak if fatal warnings are enabled in the calling scope, hence the sv_2mortal in the example (to prevent a leak). Make sure to do SvREFCNT_inc afterwards if you use sv_2mortal.
char * scan_vstring( const char *s,
const char * const e, SV *sv)
char * Perl_scan_vstring(pTHX_ const char *s,
const char * const e, SV *sv)
If "is_format" is non-zero, the input is to be considered a format sub (a specialised sub used to implement perl's "format" feature); else a normal "sub".
"flags" are added to the flags for "PL_compcv". "flags" may include the "CVf_IsMETHOD" bit, which causes the new subroutine to be a method.
This returns the value of "PL_savestack_ix" that was in effect upon entry to the function;
I32 start_subparse( I32 is_format, U32 flags) I32 Perl_start_subparse(pTHX_ I32 is_format, U32 flags)
dMARK;
dORIGMARK;
dSP;
dTARGET;
void EXTEND(SP, SSize_t nitems)
void mPUSHi(IV iv)
void mPUSHn(NV nv)
void mPUSHp(char* str, STRLEN len)
void mPUSHpvs("literal string")
void mPUSHs(SV* sv)
void mPUSHu(UV uv)
void mXPUSHi(IV iv)
void mXPUSHn(NV nv)
void mXPUSHp(char* str, STRLEN len)
void mXPUSHpvs("literal string")
void mXPUSHs(SV* sv)
void mXPUSHu(UV uv)
IV POPi
long POPl
NV POPn
char* POPp char* POPpx
char* POPpbytex
SV* POPs
UV POPu
long POPul
void PUSHi(IV iv)
void PUSHMARK(SP)
void PUSHmortal
void PUSHn(NV nv)
void PUSHp(char* str, STRLEN len)
void PUSHpvs("literal string")
void PUSHs(SV* sv)
void PUSHu(UV uv)
PUTBACK;
SPAGAIN;
The forms differ in that plain "SSNEW" allocates "size" bytes; "SSNEWt" and "SSNEWat" allocate "size" objects, each of which is type "type"; and <SSNEWa> and "SSNEWat" make sure to align the new data to an "align" boundary. The most useful value for the alignment is likely to be ""MEM_ALIGNBYTES"". The alignment will be preserved through savestack reallocation only if realloc returns data aligned to a size divisible by "align"!
SSize_t SSNEW (Size_t size) SSize_t SSNEWa (Size_t size, Size_t align) SSize_t SSNEWat(Size_t size, type, Size_t align) SSize_t SSNEWt (Size_t size, type)
The difference is that "SSPTR" casts the result to "type", and "SSPTRt" casts it to a pointer of that "type".
type SSPTR (SSize_t index, type) type * SSPTRt(SSize_t index, type)
TARG;
void XPUSHi(IV iv)
void XPUSHmortal
void XPUSHn(NV nv)
void XPUSHp(char* str, STRLEN len)
void XPUSHpvs("literal string")
void XPUSHs(SV* sv)
void XPUSHu(UV uv)
XS_APIVERSION_BOOTCHECK;
XS_VERSION_BOOTCHECK;
void XSRETURN(int nitems)
XSRETURN_EMPTY;
void XSRETURN_IV(IV iv)
XSRETURN_NO;
void XSRETURN_NV(NV nv)
void XSRETURN_PV(char* str)
XSRETURN_UNDEF;
void XSRETURN_UV(IV uv)
XSRETURN_YES;
void XST_mIV(int pos, IV iv)
void XST_mNO(int pos)
void XST_mNV(int pos, NV nv)
void XST_mPV(int pos, char* str)
void XST_mUNDEF(int pos)
void XST_mUV(int pos, UV uv)
void XST_mYES(int pos)
See also "Unicode Support".
"CopyD" is like "Copy" but returns "dest". Useful for encouraging compilers to tail-call optimise.
void Copy (void* src, void* dest, int nitems, type) void * CopyD(void* src, void* dest, int nitems, type)
The number of bytes copied is written to *retlen.
Returns the position of the first uncopied "delim" in the "from" buffer, but if there is no such occurrence before "from_end", then "from_end" is returned, and the entire buffer "from" .. "from_end" - 1 is copied.
If there is room in the destination available after the copy, an extra terminating safety "NUL" byte is appended (not included in the returned length).
The error case is if the destination buffer is not large enough to accommodate everything that should be copied. In this situation, a value larger than "to_end" - "to" is written to *retlen, and as much of the source as fits will be written to the destination. Not having room for the safety "NUL" is not considered an error.
In the following examples, let "x" be the delimiter, and 0 represent a "NUL" byte (NOT the digit 0). Then we would have
Source Destination
abcxdef abc0
provided the destination buffer is at least 4 bytes long.
An escaped delimiter is one which is immediately preceded by a single backslash. Escaped delimiters are copied, and the copy continues past the delimiter; the backslash is not copied:
Source Destination
abc\xdef abcxdef0
(provided the destination buffer is at least 8 bytes long).
It's actually somewhat more complicated than that. A sequence of any odd number of backslashes escapes the following delimiter, and the copy continues with exactly one of the backslashes stripped.
Source Destination
abc\xdef abcxdef0
abc\\\xdef abc\\xdef0
abc\\\\\xdef abc\\\\xdef0
(as always, if the destination is large enough)
An even number of preceding backslashes does not escape the delimiter, so that the copy stops just before it, and includes all the backslashes (no stripping; zero is considered even):
Source Destination
abcxdef abc0
abc\\xdef abc\\0
abc\\\\xdef abc\\\\0
char * delimcpy(char *to, const char *to_end,
const char *from, const char *from_end,
const int delim, I32 *retlen)
char * Perl_delimcpy(char *to, const char *to_end,
const char *from, const char *from_end,
const int delim, I32 *retlen)
The elements to join are in SVs, stored in a C array of pointers to SVs, from **mark to "**sp - 1". Hence *mark is a reference to the first SV. Each SV will be coerced into a PV if not one already.
"delim" contains the string (or coerced into a string) that is to separate each of the joined elements.
If any component is in UTF-8, the result will be as well, and all non-UTF-8 components will be converted to UTF-8 as necessary.
Magic and tainting are handled.
void do_join( SV *sv, SV *delim, SV **mark, SV **sp) void Perl_do_join(pTHX_ SV *sv, SV *delim, SV **mark, SV **sp)
The elements to format are in SVs, stored in a C array of pointers to SVs of length "len"> and beginning at **sarg. The element referenced by *sarg is the format.
Magic and tainting are handled.
void do_sprintf( SV *sv, SSize_t len, SV **sarg) void Perl_do_sprintf(pTHX_ SV *sv, SSize_t len, SV **sarg)
void fbm_compile( SV *sv, U32 flags) void Perl_fbm_compile(pTHX_ SV *sv, U32 flags)
char * fbm_instr( unsigned char *big,
unsigned char *bigend,
SV *littlestr, U32 flags)
char * Perl_fbm_instr(pTHX_ unsigned char *big,
unsigned char *bigend,
SV *littlestr, U32 flags)
In "foldEQ", uppercase and lowercase ASCII range bytes match themselves and their opposite case counterparts. Non-cased and non-ASCII range bytes match only themselves.
In "foldEQ_locale", the comparison is based on the current locale. If that locale is UTF-8, the results are the same as "foldEQ", leading to incorrect values for non-ASCII range code points. Use "foldEQ_utf8" instead.
I32 foldEQ ( const char *a, const char *b,
I32 len)
I32 Perl_foldEQ (pTHX_ const char *a, const char *b,
I32 len)
I32 foldEQ_locale( const char *a, const char *b,
I32 len)
I32 Perl_foldEQ_locale(pTHX_ const char *a, const char *b,
I32 len)
Hence, for example, ibcmp() is "(! foldEQ())"
I32 ibcmp (const char *a, const char *b, I32 len)
I32 ibcmp_locale(const char *a, const char *b, I32 len)
I32 ibcmp_utf8 (const char *s1, char **pe1, UV l1, bool u1,
const char *s2, char **pe2, UV l2, bool u2)
char * instr(const char *big, const char *little) char * Perl_instr(const char *big, const char *little)
bool memCHRs("list", char c)
bool memEQ(char* s1, char* s2, STRLEN len)
bool memEQs(char* s1, STRLEN l1, "s2")
bool memNE(char* s1, char* s2, STRLEN len)
bool memNEs(char* s1, STRLEN l1, "s2")
"MoveD" is like "Move" but returns "dest". Useful for encouraging compilers to tail-call optimise.
void Move (void* src, void* dest, int nitems, type) void * MoveD(void* src, void* dest, int nitems, type)
int my_snprintf(char *buffer, const Size_t len,
const char *format, ...)
int Perl_my_snprintf(char *buffer, const Size_t len,
const char *format, ...)
Do NOT use this due to the possibility of overflowing "buffer". Instead use my_snprintf()
int my_sprintf(char *buffer, const char *pat, ...)
my_strlcat() appends string "src" to the end of "dst". It will append at most "size - strlen(dst) - 1" bytes. It will then "NUL"-terminate, unless "size" is 0 or the original "dst" string was longer than "size" (in practice this should not happen as it means that either "size" is incorrect or that "dst" is not a proper "NUL"-terminated string).
Note that "size" is the full size of the destination buffer and the result is guaranteed to be "NUL"-terminated if there is room. Note that room for the "NUL" should be included in "size".
The return value is the total length that "dst" would have if "size" is sufficiently large. Thus it is the initial length of "dst" plus the length of "src". If "size" is smaller than the return, the excess was not appended.
Size_t my_strlcat(char *dst, const char *src, Size_t size) Size_t Perl_my_strlcat(char *dst, const char *src, Size_t size)
my_strlcpy() copies up to "size - 1" bytes from the string "src" to "dst", "NUL"-terminating the result if "size" is not 0.
The return value is the total length "src" would be if the copy completely succeeded. If it is larger than "size", the excess was not copied.
Size_t my_strlcpy(char *dst, const char *src, Size_t size)
my_strnlen() computes the length of the string, up to "maxlen" bytes. It will never attempt to address more than "maxlen" bytes, making it suitable for use with strings that are not guaranteed to be NUL-terminated.
Size_t my_strnlen(const char *str, Size_t maxlen) Size_t Perl_my_strnlen(const char *str, Size_t maxlen)
int my_vsnprintf(char *buffer, const Size_t len,
const char *format, va_list ap)
int Perl_my_vsnprintf(char *buffer, const Size_t len,
const char *format, va_list ap)
void NewCopy(void* src, void* dest, int nitems, type)
Another way of thinking about this function is finding a needle in a haystack. "big" points to the first byte in the haystack. "big_end" points to one byte beyond the final byte in the haystack. "little" points to the first byte in the needle. "little_end" points to one byte beyond the final byte in the needle. All the parameters must be non-"NULL".
The function returns "NULL" if there is no occurrence of "little" within "big". If "little" is the empty string, "big" is returned.
Because this function operates at the byte level, and because of the inherent characteristics of UTF-8 (or UTF-EBCDIC), it will work properly if both the needle and the haystack are strings with the same UTF-8ness, but not if the UTF-8ness differs.
char * ninstr(const char *big, const char *bigend,
const char *little, const char *lend)
char * Perl_ninstr(const char *big, const char *bigend,
const char *little, const char *lend)
It is is typically used with "SvPV" when one is actually planning to discard the returned length, (hence the length is "Not Applicable", which is how this variable got its name).
BUT BEWARE, if this is used in a situation where something that is using it is in a call stack with something else that is using it, this variable would get zapped, leading to hard-to-diagnose errors.
It is usually more efficient to either declare a local variable and use that instead, or to use the "SvPV_nolen" macro.
STRLEN PL_na
char * rninstr(const char *big, const char *bigend,
const char *little, const char *lend)
char * Perl_rninstr(const char *big, const char *bigend,
const char *little, const char *lend)
These each return a pointer to a newly allocated string which is a duplicate of the input string.
The forms differ in how the string to be copied is specified, and where the new memory is allocated from.
To prevent memory leaks, the memory allocated for the new string needs to be freed when no longer needed. This can be done with the "Safefree" function, or "SAVEFREEPV".
The forms whose names contain "shared" differ from the corresponding form without that in its name, only in that the memory in the former comes from memory shared between threads. This is needed, because on some platforms, Windows for example, all allocated memory owned by a thread is deallocated when that thread ends. So if you need that not to happen, you need to use the shared memory forms.
The string to copy in "savepvs" is a C language string literal surrounded by double quotes.
The string to copy in the forms whose name contains "svpv" comes from the PV in the SV argument "sv", using SvPV()
The string to copy in the remaining forms comes from the "pv" argument.
In the case of "savepv", the size of the string is determined by strlen(), which means it may not contain embedded "NUL" characters, and must have a trailing "NUL".
In the case of "savepvn", "len" gives the length of "pv", hence it may contain embedded "NUL" characters. The copy will be guaranteed to have a trailing NUL added if not already present.
char * savepv ( const char *pv)
char * Perl_savepv (pTHX_ const char *pv)
char * savepvn ( const char *pv, Size_t len)
char * Perl_savepvn (pTHX_ const char *pv, Size_t len)
char* savepvs ( "literal string")
char * savesvpv ( SV *sv)
char * Perl_savesvpv (pTHX_ SV *sv)
char * savesharedpv ( const char *pv)
char * Perl_savesharedpv (pTHX_ const char *pv)
char * savesharedpvn ( const char * const pv,
const STRLEN len)
char * Perl_savesharedpvn (pTHX_ const char * const pv,
const STRLEN len)
char* savesharedpvs ( "literal string")
char * savesharedsvpv( SV *sv)
char * Perl_savesharedsvpv(pTHX_ SV *sv)
pair STR_WITH_LEN("literal string")
bool strEQ(char* s1, char* s2)
bool strGE(char* s1, char* s2)
bool strGT(char* s1, char* s2)
bool strLE(char* s1, char* s2)
bool strLT(char* s1, char* s2)
bool strNE(char* s1, char* s2)
bool strnEQ(char* s1, char* s2, STRLEN len)
bool strnNE(char* s1, char* s2, STRLEN len)
"ZeroD" is like "Zero" but returns "dest". Useful for encouraging compilers to tail-call optimise.
void Zero (void* dest, int nitems, type) void * ZeroD(void* dest, int nitems, type)
Type flag for object instances. See "svtype".
The types are:
SVt_NULL
SVt_IV
SVt_NV
SVt_RV
SVt_PV
SVt_PVIV
SVt_PVNV
SVt_PVMG
SVt_INVLIST
SVt_REGEXP
SVt_PVGV
SVt_PVLV
SVt_PVAV
SVt_PVHV
SVt_PVCV
SVt_PVFM
SVt_PVIO
SVt_PVOBJ
These are most easily explained from the bottom up.
"SVt_PVOBJ" is for object instances of the new `use feature 'class'` kind. "SVt_PVIO" is for I/O objects, "SVt_PVFM" for formats, "SVt_PVCV" for subroutines, "SVt_PVHV" for hashes and "SVt_PVAV" for arrays.
All the others are scalar types, that is, things that can be bound to a "$" variable. For these, the internal types are mostly orthogonal to types in the Perl language.
Hence, checking "SvTYPE(sv) < SVt_PVAV" is the best way to see whether something is a scalar.
"SVt_PVGV" represents a typeglob. If "!SvFAKE(sv)", then it is a real, incoercible typeglob. If SvFAKE(sv), then it is a scalar to which a typeglob has been assigned. Assigning to it again will stop it from being a typeglob. "SVt_PVLV" represents a scalar that delegates to another scalar behind the scenes. It is used, e.g., for the return value of "substr" and for tied hash and array elements. It can hold any scalar value, including a typeglob. "SVt_REGEXP" is for regular expressions. "SVt_INVLIST" is for Perl core internal use only.
"SVt_PVMG" represents a "normal" scalar (not a typeglob, regular expression, or delegate). Since most scalars do not need all the internal fields of a PVMG, we save memory by allocating smaller structs when possible. All the other types are just simpler forms of "SVt_PVMG", with fewer internal fields. "SVt_NULL" can only hold undef. "SVt_IV" can hold undef, an integer, or a reference. ("SVt_RV" is an alias for "SVt_IV", which exists for backward compatibility.) "SVt_NV" can hold undef or a double. (In builds that support headless NVs, these could also hold a reference via a suitable offset, in the same way that SVt_IV does, but this is not currently supported and seems to be a rare use case.) "SVt_PV" can hold "undef", a string, or a reference. "SVt_PVIV" is a superset of "SVt_PV" and "SVt_IV". "SVt_PVNV" is a superset of "SVt_PV" and "SVt_NV". "SVt_PVMG" can hold anything "SVt_PVNV" can hold, but it may also be blessed or magical.
AV * AV_FROM_REF(SV * ref) CV * CV_FROM_REF(SV * ref) GV * GV_FROM_REF(SV * ref) HV * HV_FROM_REF(SV * ref)
bool BOOL_INTERNALS_sv_isbool(SV* sv)
bool BOOL_INTERNALS_sv_isbool_false(SV* sv)
bool BOOL_INTERNALS_sv_isbool_true(SV* sv)
See also "PL_sv_yes" and "PL_sv_no".
SV * boolSV(bool b)
croak_xs_usage(cv, "eee_yow");
works out the package name and subroutine name from "cv", and then calls croak(). Hence if "cv" is &ouch::awk, it would call "croak" as:
diag_listed_as: SKIPME
croak("Usage: %" SVf "::%" SVf "(%s)", "ouch" "awk",
"eee_yow");
void croak_xs_usage(const CV * const cv,
const char * const params)
void Perl_croak_xs_usage(const CV * const cv,
const char * const params)
SV * DEFSV
void DEFSV_set(SV * sv)
NOTE: the perl_get_sv() form is deprecated.
SV * get_sv( const char *name, I32 flags) SV * Perl_get_sv(pTHX_ const char *name, I32 flags)
bool isGV_with_GP(SV * sv)
I32 looks_like_number( SV * const sv) I32 Perl_looks_like_number(pTHX_ SV * const sv)
const SV *sv = ...;
AV *av1 = (AV*)sv; <== BAD: the const has been silently
cast away
AV *av2 = MUTABLE_AV(sv); <== GOOD: it may warn
"MUTABLE_PTR" is the base macro used to derive new casts. The other already-built-in ones return pointers to what their names indicate.
AV * MUTABLE_AV (AV * p) CV * MUTABLE_CV (CV * p) GV * MUTABLE_GV (GV * p) HV * MUTABLE_HV (HV * p) IO * MUTABLE_IO (IO * p) void * MUTABLE_PTR(void * p) SV * MUTABLE_SV (SV * p)
SV * newRV ( SV * const sv) SV * Perl_newRV (pTHX_ SV * const sv) SV * newRV_inc( SV * const sv)
SV * newRV_noinc( SV * const tmpRef) SV * Perl_newRV_noinc(pTHX_ SV * const tmpRef)
In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first parameter, x, a debug aid which allowed callers to identify themselves. This aid has been superseded by a new build option, "PERL_MEM_LOG" (see "PERL_MEM_LOG" in perlhacktips). The older API is still there for use in XS modules supporting older perls.
SV * newSV( const STRLEN len) SV * Perl_newSV(pTHX_ const STRLEN len)
SV * newSV_false() SV * Perl_newSV_false(pTHX)
SV * newSV_true() SV * Perl_newSV_true(pTHX)
SV * newSV_type( const svtype type) SV * Perl_newSV_type(pTHX_ const svtype type)
This is equivalent to
SV* sv = sv_2mortal(newSV_type(<some type>)) and
SV* sv = sv_newmortal();
sv_upgrade(sv, <some_type>) but should be more efficient than both
of them. (Unless sv_2mortal is inlined at some point in the future.)
SV * newSV_type_mortal( const svtype type) SV * Perl_newSV_type_mortal(pTHX_ const svtype type)
SV * newSVbool( const bool bool_val) SV * Perl_newSVbool(pTHX_ const bool bool_val)
SV * newSVhek( const HEK * const hek) SV * Perl_newSVhek(pTHX_ const HEK * const hek)
This is more efficient than using sv_2mortal(newSVhek( ... ))
SV * newSVhek_mortal( const HEK * const hek) SV * Perl_newSVhek_mortal(pTHX_ const HEK * const hek)
SV * newSViv( const IV i) SV * Perl_newSViv(pTHX_ const IV i)
SV * newSVnv( const NV n) SV * Perl_newSVnv(pTHX_ const NV n)
Creates a new SV containing the pad name.
SV* newSVpadname(PADNAME *pn)
This function can cause reliability issues if you are likely to pass in empty strings that are not null terminated, because it will run strlen on the string and potentially run past valid memory.
Using "newSVpvn" is a safer alternative for non "NUL" terminated strings. For string literals use "newSVpvs" instead. This function will work fine for "NUL" terminated strings, but if you want to avoid the if statement on whether to call "strlen" use "newSVpvn" instead (calling "strlen" yourself).
SV * newSVpv( const char * const s, const STRLEN len) SV * Perl_newSVpv(pTHX_ const char * const s, const STRLEN len)
SV * newSVpv_share( const char *s, U32 hash) SV * Perl_newSVpv_share(pTHX_ const char *s, U32 hash)
SV * Perl_newSVpvf(pTHX_ const char * const pat, ...)
SV * newSVpvf_nocontext(const char * const pat, ...) SV * Perl_newSVpvf_nocontext(const char * const pat, ...)
SV * newSVpvn( const char * const s, const STRLEN len) SV * Perl_newSVpvn(pTHX_ const char * const s, const STRLEN len)
#define newSVpvn_utf8(s, len, u) \
newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
SV * newSVpvn_flags( const char * const s,
const STRLEN len,
const U32 flags)
SV * Perl_newSVpvn_flags(pTHX_ const char * const s,
const STRLEN len,
const U32 flags)
SV * newSVpvn_share( const char *s, I32 len, U32 hash) SV * Perl_newSVpvn_share(pTHX_ const char *s, I32 len, U32 hash)
SV* newSVpvn_utf8(const char* s, STRLEN len, U32 utf8)
SV* newSVpvs("literal string")
SV* newSVpvs_flags("literal string", U32 flags)
SV* newSVpvs_share("literal string")
The reference count for the new SV is set to 1.
SV * newSVpvz( const STRLEN len) SV * Perl_newSVpvz(pTHX_ const STRLEN len)
SV * newSVrv( SV * const rv,
const char * const classname)
SV * Perl_newSVrv(pTHX_ SV * const rv,
const char * const classname)
They differ only in that "newSVsv" performs 'get' magic; "newSVsv_nomg" skips any magic; and "newSVsv_flags" allows you to explicitly set a "flags" parameter.
SV * newSVsv ( SV * const old) SV * Perl_newSVsv (pTHX_ SV * const old) SV * newSVsv_flags( SV * const old, I32 flags) SV * Perl_newSVsv_flags(pTHX_ SV * const old, I32 flags) SV * newSVsv_nomg ( SV * const old)
SV * newSVuv( const UV u) SV * Perl_newSVuv(pTHX_ const UV u)
SV PL_sv_no
SV PL_sv_undef
SV PL_sv_yes
SV PL_sv_zero
void SAVE_DEFSV
Currently this always uses mergesort. See "sortsv_flags" for a more flexible routine.
void sortsv( SV **array, size_t num_elts,
SVCOMPARE_t cmp)
void Perl_sortsv(pTHX_ SV **array, size_t num_elts,
SVCOMPARE_t cmp)
void sortsv_flags( SV **array, size_t num_elts,
SVCOMPARE_t cmp, U32 flags)
void Perl_sortsv_flags(pTHX_ SV **array, size_t num_elts,
SVCOMPARE_t cmp, U32 flags)
void sv_backoff(SV * const sv) void Perl_sv_backoff(SV * const sv)
SV * sv_bless( SV * const sv,
NOCHECK HV * const stash)
SV * Perl_sv_bless(pTHX_ SV * const sv,
NOCHECK HV * const stash)
In the "pvs" forms, the catenated string is a C language string literal, enclosed in double quotes.
In the "pvn" forms, "sstr" points to the first byte of the string to concatenate, and an additional parameter, "len", specifies the number of bytes to copy. Hence, "sstr" may contain embedded-NUL characters. The caller must make sure "sstr" contains at least "len" bytes.
In the plain "pv" forms, the catenated string is a C language NUL-terminated string.
The "_mg" forms perform both 'get' and 'set' magic on "dsv".
The "_nomg" forms skip all magic.
The other forms perform only 'get' magic.
The "_flags" forms have an extra parameter, "flags", which allows you to also override the UTF-8 handling. By supplying the "SV_CATBYTES" flag, the appended string is interpreted as plain bytes; by supplying instead the "SV_CATUTF8" flag, it will be interpreted as UTF-8, and "dsv" will be upgraded to UTF-8 if necessary.
"sv_catpvn_nomg_maybeutf8" has an extra boolean parameter, "is_utf8", which if "true" indicates that "sstr" is encoded in UTF-8; otherwise not.
For all other forms, the string appended is assumed to be valid UTF-8 if and only if the "dsv" has the UTF-8 status set.
void sv_catpv ( SV * const dsv,
const char *sstr)
void Perl_sv_catpv (pTHX_ SV * const dsv,
const char *sstr)
void sv_catpv_flags ( SV * const dsv,
const char *sstr,
const I32 flags)
void Perl_sv_catpv_flags (pTHX_ SV * const dsv,
const char *sstr,
const I32 flags)
void sv_catpv_mg ( SV * const dsv,
const char * const sstr)
void Perl_sv_catpv_mg (pTHX_ SV * const dsv,
const char * const sstr)
void sv_catpv_nomg ( SV * const dsv,
const char * sstr
)
void sv_catpvn ( SV * const dsv,
const char *sstr,
STRLEN len)
void Perl_sv_catpvn (pTHX_ SV * const dsv,
const char *sstr,
STRLEN len)
void sv_catpvn_flags ( SV * const dsv,
const char *sstr,
const STRLEN len,
const I32 flags)
void Perl_sv_catpvn_flags (pTHX_ SV * const dsv,
const char *sstr,
const STRLEN len,
const I32 flags)
void sv_catpvn_mg ( SV * const dsv,
const char *sstr,
STRLEN len)
void Perl_sv_catpvn_mg (pTHX_ SV * const dsv,
const char *sstr,
STRLEN len)
void sv_catpvn_nomg ( SV * const dsv,
const char * sstr,
const STRLEN len
)
void sv_catpvn_nomg_maybeutf8( SV * const dsv,
const char *sstr,
const STRLEN len,
const I32 flags
)
void sv_catpvs ( SV * const dsv,
"literal string")
void sv_catpvs_flags ( SV * const dsv,
"literal string",
I32 flags)
void sv_catpvs_mg ( SV * const dsv,
"literal string")
void sv_catpvs_nomg ( SV * const dsv,
"literal string")
If the destination "sv" isn't already in UTF-8, but the appended data contains "wide" characters, "sv" will be converted to be UTF-8. An example is the %c format with the code point > 255. (This is an enhancement to what libc "sprintf" would do in this situation.) Other examples are given below.
The forms differ in how their arguments are specified and in the handling of magic.
"sv_vcatpvfn_flags" is the most general, and all the other forms are implemented by eventually calling it.
It has two sets of argument lists, only one of which is used in any given call. The first set, "args", is an encapsulated argument list of pointers to C strings. If it is NULL, the other list, "svargs", is used; it is an array of pointers to SV's. "sv_count" gives how many there are in the list.
See sprintf(3) for details on how the formatting is done. Some platforms support extensions to the standard C99 definition of this function. None of those are supported by Perl. For example, neither "'" (to get digit grouping), nor "I" (to get alternate digits) are supported.
Also, argument reordering (using format specifiers like "%2$d" or "%*2$d") is supported only when using the "svargs" array of SVs; an exception is raised if "arg" is not NULL and "pat" contains the "$" reordering specifier.
"* maybe_tainted" is supposed to be set when running with taint checks enabled if the results are untrustworthy (often due to the use of locales). However, this is not currently implemented. This argument is not used.
"patlen" gives the length in bytes of "pat". Currently, the pattern must be NUL-terminated anyway.
"flags" is used to specify which magic to handle or to skip, by setting or clearing the "SV_GMAGIC" and/or SV_SMAGIC flags.
Plain "sv_vcatpvfn" just calls "sv_vcatpvfn_flags" setting both the "SV_GMAGIC" and SV_SMAGIC flags, so it always handles both set and get magic.
All the remaining forms handle 'get' magic; the forms whose name contains "_mg" additionally handle 'set' magic.
When using the "svargs" array, if any of the SVs in it have their UTF-8 flag set, "sv" will be converted to be so too, as necessary.
None of the remaining forms use the "svargs" array, meaning argument reordering is not possible with them. The arguments are generally considered to be the same UTF8ness as the destination "sv", though certain Perl extensions to the standard set of %formats can override this (see "Formatted Printing of Strings" in perlguts and adjacent sections).
The forms whose name contains "_no_context" do not take a thread context ("aTHX") parameter, so are used in situations where the caller doesn't already have the thread context.
The forms whose name contains "vcat" use an encapsulated argument list, the other forms use "sprintf"-style arguments.
There are no other differences between the forms.
void Perl_sv_catpvf (pTHX_ SV * const sv,
const char * const pat,
...)
void sv_catpvf_nocontext ( SV * const sv,
const char * const pat,
...)
void Perl_sv_catpvf_nocontext ( SV * const sv,
const char * const pat,
...)
void Perl_sv_catpvf_mg (pTHX_ SV * const sv,
const char * const pat,
...)
void sv_catpvf_mg_nocontext( SV * const sv,
const char * const pat,
...)
void Perl_sv_catpvf_mg_nocontext( SV * const sv,
const char * const pat,
...)
void sv_vcatpvf ( SV * const sv,
const char * const pat,
va_list * const args)
void Perl_sv_vcatpvf (pTHX_ SV * const sv,
const char * const pat,
va_list * const args)
void sv_vcatpvf_mg ( SV * const sv,
const char * const pat,
va_list * const args)
void Perl_sv_vcatpvf_mg (pTHX_ SV * const sv,
const char * const pat,
va_list * const args)
void sv_vcatpvfn ( SV * const sv,
const char * const pat,
const STRLEN patlen,
va_list * const args,
SV ** const svargs,
const Size_t sv_count,
bool * const maybe_tainted)
void Perl_sv_vcatpvfn (pTHX_ SV * const sv,
const char * const pat,
const STRLEN patlen,
va_list * const args,
SV ** const svargs,
const Size_t sv_count,
bool * const maybe_tainted)
void sv_vcatpvfn_flags ( SV * const sv,
const char * const pat,
const STRLEN patlen,
va_list * const args,
SV ** const svargs,
const Size_t sv_count,
bool * const maybe_tainted,
const U32 flags)
void Perl_sv_vcatpvfn_flags (pTHX_ SV * const sv,
const char * const pat,
const STRLEN patlen,
va_list * const args,
SV ** const svargs,
const Size_t sv_count,
bool * const maybe_tainted,
const U32 flags)
They differ only in what magic they perform:
"sv_catsv_mg" performs 'get' magic on both SVs before the copy, and 'set' magic on "dsv" afterwards.
"sv_catsv" performs just 'get' magic, on both SVs.
"sv_catsv_nomg" skips all magic.
"sv_catsv_flags" has an extra "flags" parameter which allows you to use "SV_GMAGIC" and/or "SV_SMAGIC" to specify any combination of magic handling (although either both or neither SV will have 'get' magic applied to it.)
"sv_catsv", "sv_catsv_mg", and "sv_catsv_nomg" are implemented in terms of "sv_catsv_flags".
void sv_catsv ( SV * const dsv, SV * const sstr)
void Perl_sv_catsv (pTHX_ SV * const dsv, SV * const sstr)
void sv_catsv_flags( SV * const dsv, SV * const sstr,
const I32 flags)
void Perl_sv_catsv_flags(pTHX_ SV * const dsv, SV * const sstr,
const I32 flags)
void sv_catsv_mg ( SV * const dsv, SV * const sstr)
void Perl_sv_catsv_mg (pTHX_ SV * const dsv, SV * const sstr)
void sv_catsv_nomg ( SV * const dsv, SV * const sstr)
If you know that you are about to change the PV value of "sv", instead use ""SV_CHECK_THINKFIRST_COW_DROP"" to avoid the write that would be immediately written again.
void SV_CHECK_THINKFIRST(SV * sv)
void SV_CHECK_THINKFIRST_COW_DROP(SV * sv)
Beware: after this function returns, "ptr" and SvPVX_const(sv) may no longer refer to the same chunk of data.
The unfortunate similarity of this function's name to that of Perl's "chop" operator is strictly coincidental. This function works from the left; "chop" works from the right.
void sv_chop( SV * const sv, const char * const ptr) void Perl_sv_chop(pTHX_ SV * const sv, const char * const ptr)
void sv_clear( SV * const orig_sv) void Perl_sv_clear(pTHX_ SV * const orig_sv)
"sv_cmp" always handles 'get' magic. "sv_cmp_flags" only does so if "flags" contains "SV_GMAGIC". Otherwise, the two forms behave identically.
See also "sv_cmp_locale".
I32 sv_cmp ( SV * const sv1, SV * const sv2)
I32 Perl_sv_cmp (pTHX_ SV * const sv1, SV * const sv2)
I32 sv_cmp_flags( SV * const sv1, SV * const sv2,
const U32 flags)
I32 Perl_sv_cmp_flags(pTHX_ SV * const sv1, SV * const sv2,
const U32 flags)
They are UTF-8 and 'use bytes' aware, and will coerce their args to strings if necessary.
"sv_cmp_locale" always handles 'get' magic. "sv_cmp_locale_flags" only does so if "flags" contains "SV_GMAGIC". Otherwise, the two forms behave identically.
See also "sv_cmp".
I32 sv_cmp_locale ( SV * const sv1,
SV * const sv2)
I32 Perl_sv_cmp_locale (pTHX_ SV * const sv1,
SV * const sv2)
I32 sv_cmp_locale_flags( SV * const sv1,
SV * const sv2,
const U32 flags)
I32 Perl_sv_cmp_locale_flags(pTHX_ SV * const sv1,
SV * const sv2,
const U32 flags)
Any scalar variable may carry "PERL_MAGIC_collxfrm" magic that contains the scalar data of the variable, but transformed to such a format that a normal memory comparison can be used to compare the data according to the locale settings.
"sv_collxfrm" always handles 'get' magic. "sv_collxfrm_flags" only does so if "flags" contains "SV_GMAGIC". Otherwise, the two forms behave identically.
char * sv_collxfrm ( SV * const sv,
STRLEN * const nxp)
char * Perl_sv_collxfrm (pTHX_ SV * const sv,
STRLEN * const nxp)
char * sv_collxfrm_flags( SV * const sv,
STRLEN * const nxp,
I32 const flags)
char * Perl_sv_collxfrm_flags(pTHX_ SV * const sv,
STRLEN * const nxp,
I32 const flags)
The three forms differ only in whether or not they perform 'get magic' on "sv". "sv_copypv_nomg" skips 'get magic'; "sv_copypv" performs it; and "sv_copypv_flags" either performs it (if the "SV_GMAGIC" bit is set in "flags") or doesn't (if that bit is cleared).
void sv_copypv ( SV * const dsv, SV * const ssv)
void Perl_sv_copypv (pTHX_ SV * const dsv, SV * const ssv)
void sv_copypv_flags( SV * const dsv, SV * const ssv,
const I32 flags)
void Perl_sv_copypv_flags(pTHX_ SV * const dsv, SV * const ssv,
const I32 flags)
void sv_copypv_nomg ( SV * const dsv, SV * const ssv)
They differ only in that:
"sv_dec" handles 'get' magic; "sv_dec_nomg" skips 'get' magic.
void sv_dec ( SV * const sv) void Perl_sv_dec (pTHX_ SV * const sv) void sv_dec_nomg( SV * const sv) void Perl_sv_dec_nomg(pTHX_ SV * const sv)
In "sv_derived_from_hv", the class name is HvNAME(hv) (which would presumably represent a stash). Its UTF8ness is HvNAMEUTF8(hv).
In "sv_derived_from" and "sv_derived_from_pv", the class name is given by "name", which is a NUL-terminated C string. In "sv_derived_from", the name is never considered to be encoded as UTF-8.
The remaining forms differ only in how the class name is specified; they all have a "flags" parameter. Currently, the only significant value for which is "SVf_UTF8" to indicate that the class name is encoded as such.
In "sv_derived_from_sv", the class name is extracted from "namesv". This is the preferred form. The class name is considered to be in UTF-8 if "namesv" is marked as such.
In "sv_derived_from_pvn", "len" gives the length of "name", so the latter may contain embedded NUL characters.
bool sv_derived_from ( SV *sv,
const char * const name)
bool Perl_sv_derived_from (pTHX_ SV *sv,
const char * const name)
bool sv_derived_from_hv ( SV *sv, HV *hv)
bool Perl_sv_derived_from_hv (pTHX_ SV *sv, HV *hv)
bool sv_derived_from_pv ( SV *sv,
const char * const name,
U32 flags)
bool Perl_sv_derived_from_pv (pTHX_ SV *sv,
const char * const name,
U32 flags)
bool sv_derived_from_pvn( SV *sv,
const char * const name,
const STRLEN len, U32 flags)
bool Perl_sv_derived_from_pvn(pTHX_ SV *sv,
const char * const name,
const STRLEN len, U32 flags)
bool sv_derived_from_sv ( SV *sv, SV *namesv,
U32 flags)
bool Perl_sv_derived_from_sv (pTHX_ SV *sv, SV *namesv,
U32 flags)
bool sv_does( SV *sv, const char * const name) bool Perl_sv_does(pTHX_ SV *sv, const char * const name)
bool sv_does_pv( SV *sv, const char * const name,
U32 flags)
bool Perl_sv_does_pv(pTHX_ SV *sv, const char * const name,
U32 flags)
bool sv_does_pvn( SV *sv, const char * const name,
const STRLEN len, U32 flags)
bool Perl_sv_does_pvn(pTHX_ SV *sv, const char * const name,
const STRLEN len, U32 flags)
bool sv_does_sv( SV *sv, SV *namesv, U32 flags) bool Perl_sv_does_sv(pTHX_ SV *sv, SV *namesv, U32 flags)
They differ only in that "sv_eq" always processes get magic, while "sv_eq_flags" processes get magic only when the "flags" parameter has the "SV_GMAGIC" bit set.
These functions do not handle operator overloading. For versions that do, see instead "sv_streq" or "sv_streq_flags".
I32 sv_eq ( SV *sv1, SV *sv2) I32 Perl_sv_eq (pTHX_ SV *sv1, SV *sv2) I32 sv_eq_flags( SV *sv1, SV *sv2, const U32 flags) I32 Perl_sv_eq_flags(pTHX_ SV *sv1, SV *sv2, const U32 flags)
Other than what was mentioned above, the two forms behave identically. This is because "sv_force_normal" merely calls "sv_force_normal_flags" with "flags" set to 0.
void sv_force_normal ( SV *sv)
void Perl_sv_force_normal (pTHX_ SV *sv)
void sv_force_normal_flags( SV * const sv,
const U32 flags)
void Perl_sv_force_normal_flags(pTHX_ SV * const sv,
const U32 flags)
void sv_free( SV * const sv) void Perl_sv_free(pTHX_ SV * const sv)
If "sv" is the target of a weak reference then it returns the back references structure associated with the sv; otherwise return "NULL".
When returning a non-null result the type of the return is relevant. If it is an AV then the elements of the AV are the weak reference RVs which point at this item. If it is any other type then the item itself is the weak reference.
See also Perl_sv_add_backref(), Perl_sv_del_backref(), Perl_sv_kill_backrefs()
SV * sv_get_backrefs(SV * const sv) SV * Perl_sv_get_backrefs(SV * const sv)
char * sv_gets( SV * const sv, PerlIO * const fp,
SSize_t append)
char * Perl_sv_gets(pTHX_ SV * const sv, PerlIO * const fp,
SSize_t append)
They differ only in that "sv_inc" performs 'get' magic; "sv_inc_nomg" skips any magic.
void sv_inc ( SV * const sv) void Perl_sv_inc (pTHX_ SV * const sv) void sv_inc_nomg( SV * const sv) void Perl_sv_inc_nomg(pTHX_ SV * const sv)
"sv_insert_flags" is identical to plain "sv_insert", but the extra "flags" are passed to the "SvPV_force_flags" operation that is internally applied to "bigstr".
void sv_insert ( SV * const bigstr,
const STRLEN offset,
const STRLEN len,
const char * const little,
const STRLEN littlelen)
void Perl_sv_insert (pTHX_ SV * const bigstr,
const STRLEN offset,
const STRLEN len,
const char * const little,
const STRLEN littlelen)
void sv_insert_flags( SV * const bigstr,
const STRLEN offset,
const STRLEN len,
const char *little,
const STRLEN littlelen,
const U32 flags)
void Perl_sv_insert_flags(pTHX_ SV * const bigstr,
const STRLEN offset,
const STRLEN len,
const char *little,
const STRLEN littlelen,
const U32 flags)
This does not check for subtypes or method overloading. Use "sv_isa_sv" to verify an inheritance relationship in the same way as the "isa" operator by respecting any isa() method overloading; or "sv_derived_from_sv" to test directly on the actual object type.
int sv_isa( SV *sv, const char * const name) int Perl_sv_isa(pTHX_ SV *sv, const char * const name)
This is the function used to implement the behaviour of the "isa" operator.
Does not invoke magic on "sv".
Not to be confused with the older "sv_isa" function, which does not use an overloaded isa() method, nor will check subclassing.
bool sv_isa_sv( SV *sv, SV *namesv) bool Perl_sv_isa_sv(pTHX_ SV *sv, SV *namesv)
int sv_isobject( SV *sv) int Perl_sv_isobject(pTHX_ SV *sv)
STRLEN sv_len( SV * const sv) STRLEN Perl_sv_len(pTHX_ SV * const sv)
STRLEN sv_len_utf8 ( SV * const sv) STRLEN Perl_sv_len_utf8 (pTHX_ SV * const sv) STRLEN sv_len_utf8_nomg( SV * const sv) STRLEN Perl_sv_len_utf8_nomg(pTHX_ SV * const sv)
See "sv_magicext" (which "sv_magic" now calls) for a description of the handling of the "name" and "namlen" arguments.
You need to use "sv_magicext" to add magic to "SvREADONLY" SVs and also to add more than one instance of the same "how".
void sv_magic( SV * const sv, SV * const obj,
const int how, const char * const name,
const I32 namlen)
void Perl_sv_magic(pTHX_ SV * const sv, SV * const obj,
const int how, const char * const name,
const I32 namlen)
Note that "sv_magicext" will allow things that "sv_magic" will not. In particular, you can add magic to "SvREADONLY" SVs, and add more than one instance of the same "how".
If "namlen" is greater than zero then a "savepvn" copy of "name" is stored, if "namlen" is zero then "name" is stored as-is and - as another special case - if "(name && namlen == HEf_SVKEY)" then "name" is assumed to contain an SV* and is stored as-is with its "REFCNT" incremented.
(This is now used as a subroutine by "sv_magic".)
MAGIC * sv_magicext( SV * const sv, SV * const obj,
const int how,
const MGVTBL * const vtbl,
const char * const name,
const I32 namlen)
MAGIC * Perl_sv_magicext(pTHX_ SV * const sv, SV * const obj,
const int how,
const MGVTBL * const vtbl,
const char * const name,
const I32 namlen)
The two forms are identical, except "sv_mortalcopy_flags" has an extra "flags" parameter, the contents of which are passed along to "sv_setsv_flags".
SV * sv_mortalcopy ( SV * const oldsv) SV * Perl_sv_mortalcopy (pTHX_ SV * const oldsv) SV * sv_mortalcopy_flags( SV * const oldsv, U32 flags) SV * Perl_sv_mortalcopy_flags(pTHX_ SV * const oldsv, U32 flags)
SV * sv_newmortal() SV * Perl_sv_newmortal(pTHX)
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 could potentially warn under some level of strict-ness.
"Superseded" by sv_nosharing().
void sv_nolocking( SV *sv) void Perl_sv_nolocking(pTHX_ SV *sv)
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 could potentially warn under some level of strict-ness.
"Superseded" by sv_nosharing().
void sv_nounlocking( SV *sv) void Perl_sv_nounlocking(pTHX_ SV *sv)
In "sv_numeq_flags", if "flags" has the "SV_GMAGIC" bit set, 'get' magic is handled.
And unless "flags" has the "SV_SKIP_OVERLOAD" bit set, an attempt to use "==" overloading will be made. If such overloading does not exist or the flag is set, then regular numerical comparison will be used instead.
"sv_numeq" merely calls "sv_numeq_flags" with just the "SV_GMAGIC" bit set. This function basically behaves like the Perl code "$sv1 == $sv2".
bool sv_numeq ( SV *sv1, SV *sv2)
bool sv_numeq_flags( SV *sv1, SV *sv2,
const U32 flags)
bool Perl_sv_numeq_flags(pTHX_ SV *sv1, SV *sv2,
const U32 flags)
The caller must ensure that the PV contains at least as many bytes as the count passed in.
"sv_pos_b2u" returns "void", instead updating *offsetp to the character count. "sv_pos_b2u_flags" returns the character count.
"sv_pos_b2u_flags" is preferred as "offsetp" is a *I32, which limits the size it can handle to 2Gb.
Both handle type coercion.
"sv_pos_b2u" always handles 'get' magic. "sv_pos_b2u_flags" only handles 'get' magic when "flags" contains "SV_GMAGIC".
In fact, "sv_pos_b2u_flags" passes "flags" to "SvPV_flags", and "flags" usually should be "SV_GMAGIC|SV_CONST_RETURN". "sv_pos_b2u" automatically causes "SV_CONST_RETURN" to be passed to "SvPV_flags".
Both functions use and update "PERL_MAGIC_utf8".
void sv_pos_b2u ( SV * const sv,
I32 * const offsetp)
void Perl_sv_pos_b2u (pTHX_ SV * const sv,
I32 * const offsetp)
STRLEN sv_pos_b2u_flags( SV * const sv,
STRLEN const offset,
U32 flags)
STRLEN Perl_sv_pos_b2u_flags(pTHX_ SV * const sv,
STRLEN const offset,
U32 flags)
Optionally, they also count how many bytes are in the next so-many UTF-8-encoded characters. This option is chosen in both functions by passing a non-NULL "lenp" to them, and setting *lenp to the desired character count. The functions update *lenp with the byte count.
"sv_pos_u2b" returns "void", instead updating *offsetp to the byte count. "sv_pos_u2b_flags" returns the byte count.
"sv_pos_u2b_flags" is preferred as "offsetp" is a *I32, which limits the size it can handle to 2Gb.
Both handle type coercion.
"sv_pos_u2b" always handles 'get' magic. "sv_pos_u2b_flags" only handles 'get' magic when "flags" contains "SV_GMAGIC".
In fact, "sv_pos_u2b_flags" passes "flags" to "SvPV_flags", and "flags" usually should be "SV_GMAGIC|SV_CONST_RETURN". "sv_pos_u2b" automatically causes "SV_CONST_RETURN" to be passed to "SvPV_flags".
Both functions use and update "PERL_MAGIC_utf8".
void sv_pos_u2b ( SV * const sv,
I32 * const offsetp,
I32 * const lenp)
void Perl_sv_pos_u2b (pTHX_ SV * const sv,
I32 * const offsetp,
I32 * const lenp)
STRLEN sv_pos_u2b_flags( SV * const sv,
STRLEN uoffset,
STRLEN * const lenp,
U32 flags)
STRLEN Perl_sv_pos_u2b_flags(pTHX_ SV * const sv,
STRLEN uoffset,
STRLEN * const lenp,
U32 flags)
char * sv_pvn_force_flags( SV * const sv,
STRLEN * const lp,
const U32 flags)
char * Perl_sv_pvn_force_flags(pTHX_ SV * const sv,
STRLEN * const lp,
const U32 flags)
dst can be a SV to be set to the description or NULL, in which case a mortal SV is returned.
If ob is true and the SV is blessed, the description is the class name, otherwise it is the type of the SV, "SCALAR", "ARRAY" etc.
SV * sv_ref( SV *dst, const SV * const sv,
const int ob)
SV * Perl_sv_ref(pTHX_ SV *dst, const SV * const sv,
const int ob)
If ob is true and the SV is blessed, the string is the class name, otherwise it is the type of the SV, "SCALAR", "ARRAY" etc.
const char * sv_reftype( const SV * const sv,
const int ob)
const char * Perl_sv_reftype(pTHX_ const SV * const sv,
const int ob)
void sv_replace( SV * const sv, SV * const nsv) void Perl_sv_replace(pTHX_ SV * const sv, SV * const nsv)
void sv_report_used() void Perl_sv_report_used(pTHX)
void sv_reset( const char *s, HV * const stash) void Perl_sv_reset(pTHX_ const char *s, HV * const stash)
SV * sv_rvunweaken( SV * const sv) SV * Perl_sv_rvunweaken(pTHX_ SV * const sv)
SV * sv_rvweaken( SV * const sv) SV * Perl_sv_rvweaken(pTHX_ SV * const sv)
The perl equivalent is "$sv = !!$expr;".
Introduced in perl 5.35.11.
void sv_set_bool( SV *sv, const bool bool_val) void Perl_sv_set_bool(pTHX_ SV *sv, const bool bool_val)
The perl equivalent is "$sv = !1;".
Introduced in perl 5.35.11.
void sv_set_false( SV *sv) void Perl_sv_set_false(pTHX_ SV *sv)
The perl equivalent is "$sv = !0;".
Introduced in perl 5.35.11.
void sv_set_true( SV *sv) void Perl_sv_set_true(pTHX_ SV *sv)
The perl equivalent is "$sv = undef;". Note that it doesn't free any string buffer, unlike "undef $sv".
Introduced in perl 5.25.12.
void sv_set_undef( SV *sv) void Perl_sv_set_undef(pTHX_ SV *sv)
They differ only in that "sv_setbool_mg" handles 'set' magic; "sv_setbool" does not.
void sv_setbool (SV *sv, bool b) void sv_setbool_mg(SV *sv, bool b)
They differ only in that "sv_setiv_mg" handles 'set' magic; "sv_setiv" does not.
void sv_setiv ( SV * const sv, const IV num) void Perl_sv_setiv (pTHX_ SV * const sv, const IV num) void sv_setiv_mg( SV * const sv, const IV i) void Perl_sv_setiv_mg(pTHX_ SV * const sv, const IV i)
They differ only in that "sv_setnv_mg" handles 'set' magic; "sv_setnv" does not.
void sv_setnv ( SV * const sv, const NV num) void Perl_sv_setnv (pTHX_ SV * const sv, const NV num) void sv_setnv_mg( SV * const sv, const NV num) void Perl_sv_setnv_mg(pTHX_ SV * const sv, const NV num)
In the "pvs" forms, the string must be a C literal string, enclosed in double quotes.
In the "pvn" forms, the first byte of the string is pointed to by "ptr", and "len" indicates the number of bytes to be copied, potentially including embedded "NUL" characters.
In the plain "pv" forms, "ptr" points to a NUL-terminated C string. That is, it points to the first byte of the string, and the copy proceeds up through the first encountered "NUL" byte.
In the forms that take a "ptr" argument, if it is NULL, the SV will become undefined.
The UTF-8 flag is not changed by these functions.
A terminating NUL byte is guaranteed in the result.
The "_mg" forms handle 'set' magic; the other forms skip all magic.
"sv_setpvn_fresh" is a cut-down alternative to "sv_setpvn", intended ONLY to be used with a fresh sv that has been upgraded to a SVt_PV, SVt_PVIV, SVt_PVNV, or SVt_PVMG.
void sv_setpv ( SV * const sv,
const char * const ptr)
void Perl_sv_setpv (pTHX_ SV * const sv,
const char * const ptr)
void sv_setpv_mg ( SV * const sv,
const char * const ptr)
void Perl_sv_setpv_mg (pTHX_ SV * const sv,
const char * const ptr)
void sv_setpvn ( SV * const sv,
const char * const ptr,
const STRLEN len)
void Perl_sv_setpvn (pTHX_ SV * const sv,
const char * const ptr,
const STRLEN len)
void sv_setpvn_fresh( SV * const sv,
const char * const ptr,
const STRLEN len)
void Perl_sv_setpvn_fresh(pTHX_ SV * const sv,
const char * const ptr,
const STRLEN len)
void sv_setpvn_mg ( SV * const sv,
const char * const ptr,
const STRLEN len)
void Perl_sv_setpvn_mg (pTHX_ SV * const sv,
const char * const ptr,
const STRLEN len)
void sv_setpvs ( SV *const sv, "literal string")
void sv_setpvs_mg ( SV *const sv, "literal string")
Returns a char * pointer to the SvPV buffer.
The caller must set the first "cur" bytes of "sv" before the first use of its contents. This means that if "cur" is zero, the SV is immediately fully formed and ready to use, just like any other SV containing an empty string.
char * sv_setpv_bufsize( SV * const sv,
const STRLEN cur,
const STRLEN len)
char * Perl_sv_setpv_bufsize(pTHX_ SV * const sv,
const STRLEN cur,
const STRLEN len)
The differences between these are:
"sv_setpvf_mg" and "sv_setpvf_mg_nocontext" perform 'set' magic; "sv_setpvf" and "sv_setpvf_nocontext" skip all magic.
"sv_setpvf_nocontext" and "sv_setpvf_mg_nocontext" do not take a thread context ("aTHX") parameter, so are used in situations where the caller doesn't already have the thread context.
The UTF-8 flag is not changed by these functions.
void Perl_sv_setpvf (pTHX_ SV * const sv,
const char * const pat,
...)
void Perl_sv_setpvf_mg (pTHX_ SV * const sv,
const char * const pat,
...)
void sv_setpvf_mg_nocontext( SV * const sv,
const char * const pat,
...)
void Perl_sv_setpvf_mg_nocontext( SV * const sv,
const char * const pat,
...)
void sv_setpvf_nocontext ( SV * const sv,
const char * const pat,
...)
void Perl_sv_setpvf_nocontext ( SV * const sv,
const char * const pat,
...)
SV * sv_setref_iv( SV * const rv,
const char * const classname,
const IV iv)
SV * Perl_sv_setref_iv(pTHX_ SV * const rv,
const char * const classname,
const IV iv)
SV * sv_setref_nv( SV * const rv,
const char * const classname,
const NV nv)
SV * Perl_sv_setref_nv(pTHX_ SV * const rv,
const char * const classname,
const NV nv)
Do not use with other Perl types such as HV, AV, SV, CV, because those objects will become corrupted by the pointer copy process.
Note that "sv_setref_pvn" copies the string while this copies the pointer.
SV * sv_setref_pv( SV * const rv,
const char * const classname,
void * const pv)
SV * Perl_sv_setref_pv(pTHX_ SV * const rv,
const char * const classname,
void * const pv)
Note that "sv_setref_pv" copies the pointer while this copies the string.
SV * sv_setref_pvn( SV * const rv,
const char * const classname,
const char * const pv,
const STRLEN n)
SV * Perl_sv_setref_pvn(pTHX_ SV * const rv,
const char * const classname,
const char * const pv,
const STRLEN n)
SV * sv_setref_pvs(SV *const rv, const char *const classname,
"literal string")
SV * sv_setref_uv( SV * const rv,
const char * const classname,
const UV uv)
SV * Perl_sv_setref_uv(pTHX_ SV * const rv,
const char * const classname,
const UV uv)
"sv_setrv_inc_mg" will invoke 'set' magic on the SV; "sv_setrv_inc" will not.
void sv_setrv_inc ( SV * const sv, SV * const ref) void Perl_sv_setrv_inc (pTHX_ SV * const sv, SV * const ref) void sv_setrv_inc_mg( SV * const sv, SV * const ref) void Perl_sv_setrv_inc_mg(pTHX_ SV * const sv, SV * const ref)
"sv_setrv_noinc_mg" will invoke 'set' magic on the SV; "sv_setrv_noinc" will not.
void sv_setrv_noinc ( SV * const sv, SV * const ref) void Perl_sv_setrv_noinc (pTHX_ SV * const sv, SV * const ref) void sv_setrv_noinc_mg( SV * const sv, SV * const ref) void Perl_sv_setrv_noinc_mg(pTHX_ SV * const sv, SV * const ref)
They differ only in that:
"sv_setsv" calls 'get' magic on "ssv", but skips 'set' magic on "dsv".
"sv_setsv_mg" calls both 'get' magic on "ssv" and 'set' magic on "dsv".
"sv_setsv_nomg" skips all magic.
"sv_setsv_flags" has a "flags" parameter which you can use to specify any combination of magic handling, and also you can specify "SV_NOSTEAL" so that the buffers of temps will not be stolen.
You probably want to instead use one of the assortment of wrappers, such as "SvSetSV", "SvSetSV_nosteal", "SvSetMagicSV" and "SvSetMagicSV_nosteal".
"sv_setsv_flags" is the primary function for copying scalars, and most other copy-ish functions and macros use it underneath.
void sv_setsv ( SV *dsv, SV *ssv)
void Perl_sv_setsv (pTHX_ SV *dsv, SV *ssv)
void sv_setsv_flags( SV *dsv, SV *ssv,
const I32 flags)
void Perl_sv_setsv_flags(pTHX_ SV *dsv, SV *ssv,
const I32 flags)
void sv_setsv_mg ( SV * const dsv, SV * const ssv)
void Perl_sv_setsv_mg (pTHX_ SV * const dsv, SV * const ssv)
void sv_setsv_nomg ( SV *dsv, SV *ssv)
They differ only in that "sv_setuv_mg" handles 'set' magic; "sv_setuv" does not.
void sv_setuv ( SV * const sv, const UV num) void Perl_sv_setuv (pTHX_ SV * const sv, const UV num) void sv_setuv_mg( SV * const sv, const UV u) void Perl_sv_setuv_mg(pTHX_ SV * const sv, const UV u)
"sv_streq_flags" is the more general form, having a "flags" argument that affects its behavior in two ways. It coerces its args to strings if necessary, treating a "NULL" argument as "undef". It correctly handles the UTF8 flag.
If "flags" has the "SV_GMAGIC" bit set, 'get' magic will be handled.
If flags does not have the "SV_SKIP_OVERLOAD" bit set, an attempt to use "eq" overloading will be made. If such overloading does not exist or the flag is set, then regular string comparison will be used instead.
"sv_streq" merely calls "sv_streq_flags" with "flags" set to just "SV_GMAGIC". This function basically behaves like the Perl code "$sv1 eq $sv2".
bool sv_streq ( SV *sv1, SV *sv2)
bool sv_streq_flags( SV *sv1, SV *sv2,
const U32 flags)
bool Perl_sv_streq_flags(pTHX_ SV *sv1, SV *sv2,
const U32 flags)
int sv_unmagic( SV * const sv, const int type) int Perl_sv_unmagic(pTHX_ SV * const sv, const int type)
int sv_unmagicext( SV * const sv, const int type,
const MGVTBL *vtbl)
int Perl_sv_unmagicext(pTHX_ SV * const sv, const int type,
const MGVTBL *vtbl)
"sv_unref_flags" has an extra parameter, "flags", which can contain the "SV_IMMEDIATE_UNREF" bit to force the reference count to be decremented no matter what.
When that bit isn't set, or with plain "sv_unref" always, the reference count will not be immediately decremented if the count is 1. Instead, it will be scheduled to be freed at a time of perl's choosing.
Other than the ability to force immediate action, the two forms behave identically.
See "SvROK_off".
void sv_unref ( SV *sv) void Perl_sv_unref (pTHX_ SV *sv) void sv_unref_flags( SV * const ref, const U32 flags) void Perl_sv_unref_flags(pTHX_ SV * const ref, const U32 flags)
void sv_upgrade( SV * const sv, svtype new_type) void Perl_sv_upgrade(pTHX_ SV * const sv, svtype new_type)
"ptr" should point to memory that was allocated by ""Newx"". It must be the start of a "Newx"-ed block of memory, and not a pointer to the middle of it (beware of "OOK" and copy-on-write), and not be from a non-"Newx" memory allocator like "malloc". The string length, "len", must be supplied. By default this function will ""Renew"" (i.e. realloc, move) the memory pointed to by "ptr", so that the pointer should not be freed or used by the programmer after giving it to "sv_usepvn", and neither should any pointers from "behind" that pointer (e.g., "ptr" + 1) be used.
In the "sv_usepvn_flags" form, if "flags & SV_SMAGIC" is true, "SvSETMAGIC" is called before returning. And if "flags & SV_HAS_TRAILING_NUL" is true, then "ptr[len]" must be "NUL", and the realloc will be skipped (i.e., the buffer is actually at least 1 byte longer than "len", and already meets the requirements for storing in "SvPVX").
"sv_usepvn" is merely "sv_usepvn_flags" with "flags" set to 0, so 'set' magic is skipped.
"sv_usepvn_mg" is merely "sv_usepvn_flags" with "flags" set to "SV_SMAGIC", so 'set' magic is performed.
void sv_usepvn ( SV *sv, char *ptr, STRLEN len)
void Perl_sv_usepvn (pTHX_ SV *sv, char *ptr, STRLEN len)
void sv_usepvn_flags( SV * const sv, char *ptr,
const STRLEN len,
const U32 flags)
void Perl_sv_usepvn_flags(pTHX_ SV * const sv, char *ptr,
const STRLEN len,
const U32 flags)
void sv_usepvn_mg ( SV *sv, char *ptr, STRLEN len)
void Perl_sv_usepvn_mg (pTHX_ SV *sv, char *ptr, STRLEN len)
bool sv_utf8_decode( SV * const sv) bool Perl_sv_utf8_decode(pTHX_ SV * const sv)
They are not a general purpose Unicode to byte encoding interface: use the "Encode" extension for that.
They differ only in that:
"sv_utf8_downgrade" processes 'get' magic on "sv".
"sv_utf8_downgrade_nomg" does not.
"sv_utf8_downgrade_flags" has an additional "flags" parameter in which you can specify "SV_GMAGIC" to process 'get' magic, or leave it cleared to not process 'get' magic.
bool sv_utf8_downgrade ( SV * const sv,
const bool fail_ok)
bool Perl_sv_utf8_downgrade (pTHX_ SV * const sv,
const bool fail_ok)
bool sv_utf8_downgrade_flags( SV * const sv,
const bool fail_ok,
const U32 flags)
bool Perl_sv_utf8_downgrade_flags(pTHX_ SV * const sv,
const bool fail_ok,
const U32 flags)
bool sv_utf8_downgrade_nomg ( SV * const sv,
const bool fail_ok)
void sv_utf8_encode( SV * const sv) void Perl_sv_utf8_encode(pTHX_ SV * const sv)
The forms differ in just two ways. The main difference is whether or not they perform 'get magic' on "sv". "sv_utf8_upgrade_nomg" skips 'get magic'; "sv_utf8_upgrade" performs it; and "sv_utf8_upgrade_flags" and "sv_utf8_upgrade_flags_grow" either perform it (if the "SV_GMAGIC" bit is set in "flags") or don't (if that bit is cleared).
The other difference is that "sv_utf8_upgrade_flags_grow" has an additional parameter, "extra", which allows the caller to specify an amount of space to be reserved as spare beyond what is needed for the actual conversion. This is used when the caller knows it will soon be needing yet more space, and it is more efficient to request space from the system in a single call. This form is otherwise identical to "sv_utf8_upgrade_flags".
These are not a general purpose byte encoding to Unicode interface: use the Encode extension for that.
The "SV_FORCE_UTF8_UPGRADE" flag is now ignored.
STRLEN sv_utf8_upgrade ( SV *sv)
STRLEN Perl_sv_utf8_upgrade (pTHX_ SV *sv)
STRLEN sv_utf8_upgrade_flags ( SV * const sv,
const I32 flags)
STRLEN sv_utf8_upgrade_flags_grow( SV * const sv,
const I32 flags,
STRLEN extra)
STRLEN Perl_sv_utf8_upgrade_flags_grow(pTHX_ SV * const sv,
const I32 flags,
STRLEN extra)
STRLEN sv_utf8_upgrade_nomg ( SV *sv)
They differ only in that "sv_vsetpvf_mg" performs 'set' magic; "sv_vsetpvf" skips all magic.
They are usually used via their frontends, "sv_setpvf" and "sv_setpvf_mg".
The UTF-8 flag is not changed by these functions.
void sv_vsetpvf ( SV * const sv,
const char * const pat,
va_list * const args)
void Perl_sv_vsetpvf (pTHX_ SV * const sv,
const char * const pat,
va_list * const args)
void sv_vsetpvf_mg( SV * const sv,
const char * const pat,
va_list * const args)
void Perl_sv_vsetpvf_mg(pTHX_ SV * const sv,
const char * const pat,
va_list * const args)
The UTF-8 flag is not changed by this function.
Usually used via one of its frontends ""sv_vsetpvf"" and ""sv_vsetpvf_mg"".
void sv_vsetpvfn( SV * const sv,
const char * const pat,
const STRLEN patlen,
va_list * const args,
SV ** const svargs,
const Size_t sv_count,
bool * const maybe_tainted)
void Perl_sv_vsetpvfn(pTHX_ SV * const sv,
const char * const pat,
const STRLEN patlen,
va_list * const args,
SV ** const svargs,
const Size_t sv_count,
bool * const maybe_tainted)
CV * sv_2cv( SV *sv, HV ** const st, GV ** const gvp,
const I32 lref)
CV * Perl_sv_2cv(pTHX_ SV *sv, HV ** const st, GV ** const gvp,
const I32 lref)
'Get' magic is ignored on the "sv" passed in, but will be called on SvRV(sv) if "sv" is an RV.
IO * sv_2io( SV * const sv) IO * Perl_sv_2io(pTHX_ SV * const sv)
IV sv_2iv_flags( SV * const sv, const I32 flags) IV Perl_sv_2iv_flags(pTHX_ SV * const sv, const I32 flags)
SV * sv_2mortal( SV * const sv) SV * Perl_sv_2mortal(pTHX_ SV * const sv)
NV sv_2nv_flags( SV * const sv, const I32 flags) NV Perl_sv_2nv_flags(pTHX_ SV * const sv, const I32 flags)
These return a pointer to the string value of an SV (coercing it to a string if necessary), and set *lp to its length in bytes.
The forms differ in that plain "sv_2pvbyte" always processes 'get' magic; and "sv_2pvbyte_flags" processes 'get' magic if and only if "flags" contains "SV_GMAGIC".
char * sv_2pv ( SV *sv, STRLEN *lp)
char * Perl_sv_2pv (pTHX_ SV *sv, STRLEN *lp)
char * sv_2pv_flags( SV * const sv, STRLEN * const lp,
const U32 flags)
char * Perl_sv_2pv_flags(pTHX_ SV * const sv, STRLEN * const lp,
const U32 flags)
These return a pointer to the byte-encoded representation of the SV, and set *lp to its length. If the SV is marked as being encoded as UTF-8, it will be downgraded, if possible, to a byte string. If the SV cannot be downgraded, they croak.
The forms differ in that plain "sv_2pvbyte" always processes 'get' magic; and "sv_2pvbyte_flags" processes 'get' magic if and only if "flags" contains "SV_GMAGIC".
char * sv_2pvbyte ( SV *sv, STRLEN * const lp)
char * Perl_sv_2pvbyte (pTHX_ SV *sv, STRLEN * const lp)
char * sv_2pvbyte_flags( SV *sv, STRLEN * const lp,
const U32 flags)
char * Perl_sv_2pvbyte_flags(pTHX_ SV *sv, STRLEN * const lp,
const U32 flags)
These return a pointer to the UTF-8-encoded representation of the SV, and set *lp to its length in bytes. They may cause the SV to be upgraded to UTF-8 as a side-effect.
The forms differ in that plain "sv_2pvutf8" always processes 'get' magic; and "sv_2pvutf8_flags" processes 'get' magic if and only if "flags" contains "SV_GMAGIC".
char * sv_2pvutf8 ( SV *sv, STRLEN * const lp)
char * Perl_sv_2pvutf8 (pTHX_ SV *sv, STRLEN * const lp)
char * sv_2pvutf8_flags( SV *sv, STRLEN * const lp,
const U32 flags)
char * Perl_sv_2pvutf8_flags(pTHX_ SV *sv, STRLEN * const lp,
const U32 flags)
UV sv_2uv_flags( SV * const sv, const I32 flags) UV Perl_sv_2uv_flags(pTHX_ SV * const sv, const I32 flags)
bool SvAMAGIC(SV * sv)
void SvAMAGIC_off(SV *sv) void Perl_SvAMAGIC_off(SV *sv)
void SvAMAGIC_on(SV *sv) void Perl_SvAMAGIC_on(SV *sv)
U32 SvBoolFlagsOK(SV* sv)
STRLEN SvCUR(SV* sv)
void SvCUR_set(SV* sv, STRLEN len)
Warning: If "SvCUR" is equal to "SvLEN", then "SvEND" points to unallocated memory.
char* SvEND(SV* sv)
U32 SvGAMAGIC(SV* sv)
void SvGETMAGIC( SV *sv) void Perl_SvGETMAGIC(pTHX_ SV *sv)
You might mistakenly think that "len" is the number of bytes to add to the existing size, but instead it is the total size "sv" should be.
char * SvGROW(SV* sv, STRLEN len)
U32 SvIandPOK(SV* sv)
void SvIandPOK_off(SV* sv)
void SvIandPOK_on(SV* sv)
U32 SvIOK(SV* sv)
bool SvIOK_notUV(SV* sv)
void SvIOK_off(SV* sv)
void SvIOK_on(SV* sv)
void SvIOK_only(SV* sv)
void SvIOK_only_UV(SV* sv)
bool SvIOK_UV(SV* sv)
U32 SvIOKp(SV* sv)
bool SvIsBOOL(SV* sv)
U32 SvIsCOW(SV* sv)
bool SvIsCOW_shared_hash(SV* sv)
As of 5.37.1, all are guaranteed to evaluate "sv" only once.
"SvIVx" is now identical to "SvIV", but prior to 5.37.1, it was the only form guaranteed to evaluate "sv" only once.
"SvIV_nomg" is the same as "SvIV", but does not perform 'get' magic.
IV SvIV ( SV *sv) IV Perl_SvIV (pTHX_ SV *sv) IV SvIV_nomg( SV *sv) IV Perl_SvIV_nomg(pTHX_ SV *sv) IV SvIVx ( SV *sv)
void SvIV_set(SV* sv, IV val)
IV SvIVX(SV* sv)
STRLEN SvLEN(SV* sv)
void SvLEN_set(SV* sv, STRLEN len)
void SvLOCK(SV* sv)
void SvMAGIC_set(SV* sv, MAGIC* val)
U32 SvNIOK(SV* sv)
void SvNIOK_off(SV* sv)
U32 SvNIOKp(SV* sv)
U32 SvNOK(SV* sv)
void SvNOK_off(SV* sv)
void SvNOK_on(SV* sv)
void SvNOK_only(SV* sv)
U32 SvNOKp(SV* sv)
As of 5.37.1, all are guaranteed to evaluate "sv" only once.
"SvNVx" is now identical to "SvNV", but prior to 5.37.1, it was the only form guaranteed to evaluate "sv" only once.
"SvNV_nomg" is the same as "SvNV", but does not perform 'get' magic.
NV SvNV ( SV *sv) NV Perl_SvNV (pTHX_ SV *sv) NV SvNV_nomg( SV *sv) NV Perl_SvNV_nomg(pTHX_ SV *sv) NV SvNVx ( SV *sv)
void SvNV_set(SV* sv, NV val)
NV SvNVX(SV* sv)
U32 SvOK(SV* sv)
U32 SvOOK(SV* sv)
void SvOOK_off(SV * sv)
void SvOOK_offset(SV*sv, STRLEN len)
U32 SvPOK(SV* sv)
void SvPOK_off(SV* sv)
void SvPOK_on(SV* sv)
void SvPOK_only(SV* sv)
void SvPOK_only_UTF8(SV* sv)
U32 SvPOKp(SV* sv)
This is a very basic and common operation, so there are lots of slightly different versions of it.
Note that there is no guarantee that the return value of SvPV(sv), for example, is equal to SvPVX(sv), or that SvPVX(sv) contains valid data, or that successive calls to SvPV(sv) (or another of these forms) will return the same pointer value each time. This is due to the way that things like overloading and Copy-On-Write are handled. In these cases, the return value may point to a temporary buffer or similar. If you absolutely need the "SvPVX" field to be valid (for example, if you intend to write to it), then see "SvPV_force".
The differences between the forms are:
The forms with neither "byte" nor "utf8" in their names (e.g., "SvPV" or "SvPV_nolen") can expose the SV's internal string buffer. If that buffer consists entirely of bytes 0-255 and includes any bytes above 127, then you MUST consult "SvUTF8" to determine the actual code points the string is meant to contain. Generally speaking, it is probably safer to prefer "SvPVbyte", "SvPVutf8", and the like. See "How do I pass a Perl string to a C library?" in perlguts for more details.
The forms with "flags" in their names allow you to use the "flags" parameter to specify to process 'get' magic (by setting the "SV_GMAGIC" flag) or to skip 'get' magic (by clearing it). The other forms process 'get' magic, except for the ones with "nomg" in their names, which skip 'get' magic.
The forms that take a "len" parameter will set that variable to the byte length of the resultant string (these are macros, so don't use &len).
The forms with "nolen" in their names indicate they don't have a "len" parameter. They should be used only when it is known that the PV is a C string, terminated by a NUL byte, and without intermediate NUL characters; or when you don't care about its length.
The forms with "const" in their names return "const char *" so that the compiler will hopefully complain if you were to try to modify the contents of the string (unless you cast away const yourself).
The other forms return a mutable pointer so that the string is modifiable by the caller; this is emphasized for the ones with "mutable" in their names.
As of 5.38, all forms are guaranteed to evaluate "sv" exactly once. For earlier Perls, use a form whose name ends with "x" for single evaluation.
"SvPVutf8" is like "SvPV", but converts "sv" to UTF-8 first if not already UTF-8. Similarly, the other forms with "utf8" in their names correspond to their respective forms without.
"SvPVutf8_or_null" and "SvPVutf8_or_null_nomg" don't have corresponding non-"utf8" forms. Instead they are like "SvPVutf8_nomg", but when "sv" is undef, they return "NULL".
"SvPVbyte" is like "SvPV", but converts "sv" to byte representation first if currently encoded as UTF-8. If "sv" cannot be downgraded from UTF-8, it croaks. Similarly, the other forms with "byte" in their names correspond to their respective forms without.
"SvPVbyte_or_null" doesn't have a corresponding non-"byte" form. Instead it is like "SvPVbyte", but when "sv" is undef, it returns "NULL".
char* SvPV (SV* sv, STRLEN len) const char* SvPV_const (SV* sv, STRLEN len) char* SvPV_flags (SV* sv, STRLEN len, U32 flags) const char* SvPV_flags_const (SV* sv, STRLEN len, U32 flags) char* SvPV_flags_mutable (SV* sv, STRLEN len, U32 flags) char* SvPV_mutable (SV* sv, STRLEN len) char* SvPV_nolen (SV* sv) const char* SvPV_nolen_const (SV* sv) char* SvPV_nomg (SV* sv, STRLEN len) const char* SvPV_nomg_const (SV* sv, STRLEN len) const char* SvPV_nomg_const_nolen(SV* sv) char* SvPV_nomg_nolen (SV* sv) char* SvPVbyte (SV* sv, STRLEN len) char* SvPVbyte_nolen (SV* sv) char* SvPVbyte_nomg (SV* sv, STRLEN len) char* SvPVbyte_or_null (SV* sv, STRLEN len) char* SvPVbyte_or_null_nomg(SV* sv, STRLEN len) char* SvPVbytex (SV* sv, STRLEN len) char* SvPVbytex_nolen (SV* sv) char* SvPVutf8 (SV* sv, STRLEN len) char* SvPVutf8_nolen (SV* sv) char* SvPVutf8_nomg (SV* sv, STRLEN len) char* SvPVutf8_or_null (SV* sv, STRLEN len) char* SvPVutf8_or_null_nomg(SV* sv, STRLEN len) char* SvPVutf8x (SV* sv, STRLEN len) char* SvPVx (SV* sv, STRLEN len) const char* SvPVx_const (SV* sv, STRLEN len) char* SvPVx_nolen (SV* sv) const char* SvPVx_nolen_const (SV* sv)
Note that coercing an arbitrary scalar into a plain PV will potentially strip useful data from it. For example if the SV was "SvROK", then the referent will have its reference count decremented, and the SV itself may be converted to an "SvPOK" scalar with a string buffer containing a value such as "ARRAY(0x1234)".
The differences between the forms are:
The forms with "flags" in their names allow you to use the "flags" parameter to specify to perform 'get' magic (by setting the "SV_GMAGIC" flag) or to skip 'get' magic (by clearing it). The other forms do perform 'get' magic, except for the ones with "nomg" in their names, which skip 'get' magic.
The forms that take a "len" parameter will set that variable to the byte length of the resultant string (these are macros, so don't use &len).
The forms with "nolen" in their names indicate they don't have a "len" parameter. They should be used only when it is known that the PV is a C string, terminated by a NUL byte, and without intermediate NUL characters; or when you don't care about its length.
The forms with "mutable" in their names are effectively the same as those without, but the name emphasizes that the string is modifiable by the caller, which it is in all the forms.
"SvPVutf8_force" is like "SvPV_force", but converts "sv" to UTF-8 first if not already UTF-8.
"SvPVutf8x_force" is like "SvPVutf8_force", but guarantees to evaluate "sv" only once; use the more efficient "SvPVutf8_force" otherwise.
"SvPVbyte_force" is like "SvPV_force", but converts "sv" to byte representation first if currently encoded as UTF-8. If the SV cannot be downgraded from UTF-8, this croaks.
"SvPVbytex_force" is like "SvPVbyte_force", but guarantees to evaluate "sv" only once; use the more efficient "SvPVbyte_force" otherwise.
char* SvPV_force (SV* sv, STRLEN len) char* SvPV_force_flags (SV * sv, STRLEN len, U32 flags) char* SvPV_force_flags_mutable(SV * sv, STRLEN len, U32 flags) char* SvPV_force_flags_nolen (SV * sv, U32 flags) char* SvPV_force_mutable (SV * sv, STRLEN len) char* SvPV_force_nolen (SV* sv) char* SvPV_force_nomg (SV* sv, STRLEN len) char* SvPV_force_nomg_nolen (SV * sv) char* SvPVbyte_force (SV * sv, STRLEN len) char* SvPVbytex_force (SV * sv, STRLEN len) char* SvPVutf8_force (SV * sv, STRLEN len) char* SvPVutf8x_force (SV * sv, STRLEN len) char* SvPVx_force (SV* sv, STRLEN len)
void SvPV_free(SV * sv)
void SvPV_renew(SV* sv, STRLEN len)
Set the value of the PV pointer in "sv" to the Perl allocated "NUL"-terminated string "val". See also "SvIV_set".
Remember to free the previous PV buffer. There are many things to check. Beware that the existing pointer may be involved in copy-on-write or other mischief, so do SvOOK_off(sv) and use "sv_force_normal" or "SvPV_force" (or check the "SvIsCOW" flag) first to make sure this modification is safe. Then finally, if it is not a COW, call "SvPV_free" to free the previous PV buffer.
void SvPV_set(SV* sv, char* val)
If the answers are both yes, then use ""SV_CHECK_THINKFIRST"" or ""SV_CHECK_THINKFIRST_COW_DROP"" before calling this.
void SvPV_shrink_to_cur(SV* sv)
char * SvPVCLEAR(SV* sv)
char * SvPVCLEAR_FRESH(SV* sv)
These are also used to store the name of an autoloaded subroutine in an XS AUTOLOAD routine. See "Autoloading with XSUBs" in perlguts.
"SvPVXx" is identical to "SvPVX".
"SvPVX_mutable" is merely a synonym for "SvPVX", but its name emphasizes that the string is modifiable by the caller.
"SvPVX_const" differs in that the return value has been cast so that the compiler will complain if you were to try to modify the contents of the string, (unless you cast away const yourself).
char* SvPVX (SV* sv) const char* SvPVX_const (SV* sv) char* SvPVX_mutable(SV* sv) char* SvPVXx (SV* sv)
As of Perl v5.37.1, "sv" is evaluated exactly once; in earlier releases, it could be evaluated more than once.
bool SvPVXtrue( SV *sv) bool Perl_SvPVXtrue(pTHX_ SV *sv)
U32 SvREADONLY(SV* sv)
U32 SvREADONLY_off(SV* sv)
U32 SvREADONLY_on(SV* sv)
U32 SvREFCNT(SV* sv)
"SvREFCNT_dec_NN" may only be used when "sv" is known to not be "NULL".
The function SvREFCNT_dec_ret_NULL() is identical to the SvREFCNT_dec() except it returns a NULL "SV *". It is used by SvREFCNT_dec_set_NULL() which is a macro which will, when passed a non-NULL argument, decrement the reference count of its argument and then set it to NULL. You can replace code of the following form:
if (sv) {
SvREFCNT_dec_NN(sv);
sv = NULL;
}
with
SvREFCNT_dec_set_NULL(sv);
void SvREFCNT_dec ( SV *sv) void Perl_SvREFCNT_dec (pTHX_ SV *sv) void SvREFCNT_dec_set_NULL( SV *sv) SV * SvREFCNT_dec_ret_NULL( SV *sv) SV * Perl_SvREFCNT_dec_ret_NULL(pTHX_ SV *sv) void SvREFCNT_dec_NN ( SV *sv) void Perl_SvREFCNT_dec_NN (pTHX_ SV *sv)
"SvREFCNT_inc" is the base operation; the rest are optimizations if various input constraints are known to be true; hence, all can be replaced with "SvREFCNT_inc".
"SvREFCNT_inc_NN" can only be used if you know "sv" is not "NULL". Since we don't have to check the NULLness, it's faster and smaller.
"SvREFCNT_inc_void" can only be used if you don't need the return value. The macro doesn't need to return a meaningful value.
"SvREFCNT_inc_void_NN" can only be used if you both don't need the return value, and you know that "sv" is not "NULL". The macro doesn't need to return a meaningful value, or check for NULLness, so it's smaller and faster.
"SvREFCNT_inc_simple" can only be used with expressions without side effects. Since we don't have to store a temporary value, it's faster.
"SvREFCNT_inc_simple_NN" can only be used with expressions without side effects and you know "sv" is not "NULL". Since we don't have to store a temporary value, nor check for NULLness, it's faster and smaller.
"SvREFCNT_inc_simple_void" can only be used with expressions without side effects and you don't need the return value.
"SvREFCNT_inc_simple_void_NN" can only be used with expressions without side effects, you don't need the return value, and you know "sv" is not "NULL".
SV * SvREFCNT_inc (SV *sv) SV * Perl_SvREFCNT_inc (SV *sv) SV * SvREFCNT_inc_NN (SV *sv) SV * Perl_SvREFCNT_inc_NN (SV *sv) SV * SvREFCNT_inc_simple (SV *sv) SV * SvREFCNT_inc_simple_NN (SV *sv) void SvREFCNT_inc_simple_void (SV *sv) void SvREFCNT_inc_simple_void_NN(SV *sv) void SvREFCNT_inc_void (SV *sv) void Perl_SvREFCNT_inc_void (SV *sv) void SvREFCNT_inc_void_NN (SV *sv)
U32 SvROK(SV* sv)
void SvROK_off(SV* sv)
void SvROK_on(SV* sv)
SV* SvRV(SV* sv)
void SvRV_set(SV* sv, SV* val)
void SvSETMAGIC(SV* sv)
The only differences are:
"SvSetMagicSV" and "SvSetMagicSV_nosteal" perform any required 'set' magic afterwards on the destination SV; "SvSetSV" and "SvSetSV_nosteal" do not.
"SvSetSV_nosteal" "SvSetMagicSV_nosteal" call a non-destructive version of "sv_setsv".
void SvSetMagicSV (SV* dsv, SV* ssv) void SvSetMagicSV_nosteal(SV* dsv, SV* ssv) void SvSetSV (SV* dsv, SV* ssv) void SvSetSV_nosteal (SV* dsv, SV* ssv)
void SvSHARE(SV* sv)
struct hek* SvSHARED_HASH(SV * sv)
HV* SvSTASH(SV* sv)
void SvSTASH_set(SV* sv, HV* val)
As of Perl 5.32, all are guaranteed to evaluate "sv" only once. Prior to that release, only "SvTRUEx" guaranteed single evaluation; now "SvTRUEx" is identical to "SvTRUE".
"SvTRUE_nomg" and "TRUE_nomg_NN" do not perform 'get' magic; the others do unless the scalar is already "SvPOK", "SvIOK", or "SvNOK" (the public, not the private flags).
"SvTRUE_NN" is like "SvTRUE", but "sv" is assumed to be non-null (NN). If there is a possibility that it is NULL, use plain "SvTRUE".
"SvTRUE_nomg_NN" is like "SvTRUE_nomg", but "sv" is assumed to be non-null (NN). If there is a possibility that it is NULL, use plain "SvTRUE_nomg".
bool SvTRUE ( SV *sv) bool Perl_SvTRUE (pTHX_ SV *sv) bool SvTRUE_NN ( SV *sv) bool Perl_SvTRUE_NN (pTHX_ SV *sv) bool SvTRUE_nomg ( SV *sv) bool Perl_SvTRUE_nomg (pTHX_ SV *sv) bool SvTRUE_nomg_NN( SV *sv) bool SvTRUEx ( SV *sv)
svtype SvTYPE(SV* sv)
void SvUNLOCK(SV* sv)
bool SvUOK(SV* sv)
void SvUPGRADE(SV* sv, svtype type)
If you want to take into account the bytes pragma, use "DO_UTF8" instead.
U32 SvUTF8(SV* sv)
void SvUTF8_off(SV *sv)
void SvUTF8_on(SV *sv)
As of 5.37.1, all are guaranteed to evaluate "sv" only once.
"SvUVx" is now identical to "SvUV", but prior to 5.37.1, it was the only form guaranteed to evaluate "sv" only once.
UV SvUV ( SV *sv) UV Perl_SvUV (pTHX_ SV *sv) UV SvUV_nomg( SV *sv) UV Perl_SvUV_nomg(pTHX_ SV *sv) UV SvUVx ( SV *sv)
void SvUV_set(SV* sv, UV val)
UV SvUVX(SV* sv)
This is an unnecessary synonym for "SvUVX"
UV SvUVXx(SV* sv)
bool SvVOK(SV* sv)
MAGIC* SvVSTRING_mg(SV * sv)
It is used internally by sv_2pv_flags() and do_print().
char * uiv_2buf(char * const buf, const IV iv, UV uv,
const int is_uv, char ** const peob)
char * Perl_uiv_2buf(char * const buf, const IV iv, UV uv,
const int is_uv, char ** const peob)
SV * vnewSVpvf( const char * const pat,
va_list * const args)
SV * Perl_vnewSVpvf(pTHX_ const char * const pat,
va_list * const args)
void SvTAINT(SV* sv)
bool SvTAINTED(SV* sv)
void SvTAINTED_off(SV* sv)
void SvTAINTED_on(SV* sv)
extern int usleep(useconds_t);
#ifdef I_TIME
#include <time.h>
#endif
#ifdef I_UTIME
#include <utime.h>
#endif
void mini_mktime(struct tm *ptm) void Perl_mini_mktime(struct tm *ptm)
On failure, they return NULL, and set "errno" to "EINVAL".
"sv_strftime_tm" and "sv_strftime_ints" are preferred, as they transparently handle the UTF-8ness of the current locale, the input "fmt", and the returned result. Only if the current "LC_TIME" locale is a UTF-8 one (and "use bytes" is not in effect) will the result be marked as UTF-8.
For these, the caller assumes ownership of the returned SV with a reference count of 1.
"my_strftime" is kept for backwards compatibility. Knowing if its result should be considered UTF-8 or not requires significant extra logic.
Note that all three functions are always executed in the underlying "LC_TIME" locale of the program, giving results based on that locale.
The stringified "fmt" parameter in all is the same as the system libc "strftime". The available conversion specifications vary by platform. These days, every specification listed in the ANSI C99 standard should be usable everywhere. These are "a A b B c d H I j m M p S U w W x X y Y Z %".
But note that the results of some of the conversion specifiers are non-portable. For example, the specifiers "a A b B c p Z" change according to the locale settings of the user, and both how to set locales (the locale names) and what output to expect are not standardized. The specifier "c" changes according to the timezone settings of the user and the timezone computation rules of the operating system. The "Z" specifier is notoriously unportable since the names of timezones are not standardized. Sticking to the numeric specifiers is the safest route.
At the time of this writing, for example, %s is not available on Windows-like systems.
The functions differ as follows:
"sv_strftime_tm" takes a pointer to an already filled-in "struct tm" parameter, so avoids that calculation.
The C99 Standard calls for "struct tm" to contain at least these fields:
int tm_sec; // seconds after the minute — [0, 60] int tm_min; // minutes after the hour — [0, 59] int tm_hour; // hours since midnight — [0, 23] int tm_mday; // day of the month — [1, 31] int tm_mon; // months since January — [0, 11] int tm_year; // years since 1900 int tm_wday; // days since Sunday — [0, 6] int tm_yday; // days since January 1 — [0, 365] int tm_isdst; // Daylight Saving Time flag
"tm_wday" and "tm_yday" are output only; the other fields give enough information to accurately calculate these, and are internally used for that purpose.
The numbers enclosed in the square brackets above give the maximum legal ranges for values in the corresponding field. Those ranges are restricted for some inputs. For example, not all months have 31 days, but all hours have 60 minutes. If you set a number that is outside the corresponding range, perl and the libc functions will automatically normalize it to be inside the range, adjusting other values as necessary. For example, specifying February 29, is the same as saying March 1 for non-leap years; and using a minute value of 60 will instead change that to a 0, and increment the hour, which in turn, if the hour was 23, will roll it over to 0 it and increment the day, and so on.
Each parameter to "sv_strftime_ints" and "my_strftime" populates the similarly-named field in this structure.
A value of 60 is legal for "tm_sec", but only for those moments when an official leap second has been declared. It is undefined behavior to use them otherwise, and the behavior does vary depending on the implementation. Some implementations take your word for it that this is a leap second, leaving it as the 61st second of the given minute; some roll it over to be the 0th second of the following minute; some treat it as 0. Some non-conforming implementations always roll it over to the next minute, regardless of whether an actual leap second is occurring or not. (And yes, it is a real problem that different computers have a different conception of what the current time is; you can search the internet for details.)
There is no limit (outside the size of "int") for the value of "tm_year", but sufficiently negative values (for earlier than 1900) may have different results on different systems and locales. Some libc implementations may know when a given locale adopted the Greorian calendar, and adjust for that. Others will not. (And some countries didn't adopt the Gregorian calendar until after 1900.) Probably all implementations assume modern time zones go back forever, before they were actually invented, starting in the last half of the 19th century.
The treatment of the "isdst" field has varied over previous Perl versions, and has been buggy (both by perl and by some libc implementations), but is now aligned, as best we can, with the POSIX Standard, as follows:
Some libc implementations have extra fields in "struct tm". The two that perl handles are:
int tm_gmtoff; // Seconds East of UTC [%z] const char * tm_zone; // Timezone abbreviation [%Z]
These are both output only. Using the respective conversion specifications (enclosed in the square brackets) in the "fmt" parameter is a portable way to gain access to these values, working both on systems that have and don't have these fields.
Example, in the "C" locale:
my_strftime( "%A, %B %d, %Y", 0, 0, 0, 12, 11, 95, 0, 0, -1 );
returns
"Tuesday, December 12, 1995"
SV * sv_strftime_ints( SV *fmt, int sec, int min,
int hour, int mday, int mon,
int year, int isdst)
SV * Perl_sv_strftime_ints(pTHX_ SV *fmt, int sec, int min,
int hour, int mday, int mon,
int year, int isdst)
SV * sv_strftime_tm ( SV *fmt,
const struct tm *mytm)
SV * Perl_sv_strftime_tm (pTHX_ SV *fmt,
const struct tm *mytm)
char * my_strftime ( const char *fmt, int sec,
int min, int hour, int mday,
int mon, int year, int wday,
int yday, int isdst)
char * Perl_my_strftime (pTHX_ const char *fmt, int sec,
int min, int hour, int mday,
int mon, int year, int wday,
int yday, int isdst)
"Unicode Support" in perlguts has an introduction to this API.
See also "Character classification", "Character case changing", and "String Handling". Various functions outside this section also work specially with Unicode. Search for the string "utf8" in this document.
-1 or +1 is returned if the shorter string was identical to the start of the longer string. -2 or +2 is returned if there was a difference between characters within the strings.
int bytes_cmp_utf8( const U8 *b, STRLEN blen,
const U8 *u, STRLEN ulen)
int Perl_bytes_cmp_utf8(pTHX_ const U8 *b, STRLEN blen,
const U8 *u, STRLEN ulen)
"bytes_to_utf8" always allocates new memory for the result, making sure it is NUL-terminated.
"bytes_to_utf8_free_me" simply returns a pointer to the input string if the string's UTF-8 representation is the same as its native representation. Otherwise, it behaves like "bytes_to_utf8", returning a pointer to new memory containing the conversion of the input. In other words, it returns the input string if converting the string would be a no-op. Note that when no new string is allocated, the function can't add a NUL to the original string if one wasn't already there.
In both cases, the caller is responsible for arranging for any new memory to get freed.
"bytes_to_utf8_temp_pv" simply returns a pointer to the input string if the string's UTF-8 representation is the same as its native representation, thus behaving like "bytes_to_utf8_free_me" in this situation. Otherwise, it behaves like "bytes_to_utf8", returning a pointer to new memory containing the conversion of the input. The difference is that it also arranges for the new memory to automatically be freed by calling "SAVEFREEPV" on it.
"bytes_to_utf8_free_me" takes an extra parameter, "free_me" to communicate. to the caller that memory was allocated or not. If that parameter is NULL, "bytes_to_utf8_free_me" acts identically to "bytes_to_utf8", always allocating new memory.
But when it is a non-NULL pointer, "bytes_to_utf8_free_me" stores into it either NULL if no memory was allocated; or a pointer to that new memory. This allows the following convenient paradigm:
void * free_me;
U8 converted = bytes_to_utf8_free_me(string, &len, &free_me);
...
Safefree(free_me);
You don't have to know if memory was allocated or not. Just call "Safefree" unconditionally. "free_me" will contain a suitable value to pass to "Safefree" for it to do the right thing, regardless. Your design is likely flawed if you find yourself using "free_me" for anything other than passing to "Safefree".
Upon return, the number of variants in the string can be computed by having saved the value of *lenp before the call, and subtracting the after-call value of *lenp from it.
If you want to convert to UTF-8 from encodings other than the native (Latin1 or EBCDIC), see "sv_recode_to_utf8"().
U8 * bytes_to_utf8 ( const U8 *s, STRLEN *lenp)
U8 * Perl_bytes_to_utf8 (pTHX_ const U8 *s, STRLEN *lenp)
U8 * bytes_to_utf8_free_me( const U8 *s, STRLEN *lenp,
void **free_me)
U8 * Perl_bytes_to_utf8_free_me(pTHX_ const U8 *s, STRLEN *lenp,
void **free_me)
U8 * bytes_to_utf8_temp_pv( const U8 *s, STRLEN *lenp)
U8 * Perl_bytes_to_utf8_temp_pv(pTHX_ const U8 *s, STRLEN *lenp)
You should use this after a call to SvPV() or one of its variants, in case any call to string overloading updates the internal UTF-8 encoding flag.
bool DO_UTF8(SV* sv)
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 "u2" with respect to "s2".
If the byte length "l1" is non-zero, it says how far into "s1" to check for fold equality. In other words, "s1"+"l1" will be used as a goal to reach. The scan will not be considered to be a match unless the goal is reached, and scanning won't continue past that goal. Correspondingly for "l2" with respect to "s2".
If "pe1" is non-"NULL" and the pointer it points to is not "NULL", that pointer is considered an end pointer to the position 1 byte past the maximum point in "s1" beyond which scanning will not continue under any circumstances. (This routine assumes that UTF-8 encoded input strings are not malformed; malformed input can cause it to read past "pe1"). This means that if both "l1" and "pe1" are specified, and "pe1" is less than "s1"+"l1", the match will never be successful because it can never get as far as its goal (and in fact is asserted against). Correspondingly for "pe2" with respect to "s2".
At least one of "s1" and "s2" must have a goal (at least one of "l1" and "l2" must be non-zero), and if both do, both have to be reached for a successful match. Also, if the fold of a character is multiple characters, 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 "s1" beyond what was matched. Correspondingly for "pe2" and "s2".
For case-insensitiveness, the "casefolding" of Unicode is used instead of upper/lowercasing both the characters, see <https://www.unicode.org/reports/tr21/> (Case Mappings).
I32 foldEQ_utf8(const char *s1, char **pe1, UV l1, bool u1,
const char *s2, char **pe2, UV l2, bool u2)
If "flags" is 0, any well-formed UTF-8, as extended by Perl, is accepted without restriction. If the final few bytes of the buffer do not form a complete code point, this will return TRUE anyway, provided that "is_utf8_valid_partial_char_flags" returns TRUE for them.
"flags" can be zero or any combination of the "UTF8_DISALLOW_foo" flags accepted by "utf8_to_uv", and with the same meanings.
The functions differ from "is_utf8_string_flags" only in that the latter returns FALSE if the final few bytes of the string don't form a complete code point.
"is_utf8_fixed_width_buf_loc_flags"> does all the preceding, but takes an extra parameter, "ep" into which it stores the location of the failure, if "ep" is not NULL. If instead the function returns TRUE, *ep will point to the beginning of any partial character at the end of the buffer; if there is no partial character *ep will contain "s"+"len".
"is_utf8_fixed_width_buf_loclen_flags"> does all the preceding, but takes another extra parameter, "el" into which it stores the number of complete, valid characters found, if "el" is not NULL.
bool is_utf8_fixed_width_buf_flags (
const U8 * const s,
STRLEN len,
const U32 flags)
bool is_utf8_fixed_width_buf_loc_flags (
const U8 * const s,
STRLEN len,
const U8 **ep,
const U32 flags)
bool is_utf8_fixed_width_buf_loclen_flags(
const U8 * const s,
STRLEN len,
const U8 **ep,
STRLEN *el,
const U32 flags)
bool Perl_is_utf8_fixed_width_buf_loclen_flags(
const U8 * const s,
STRLEN len,
const U8 **ep,
STRLEN *el,
const U32 flags)
If "len" is 0, it will be calculated using strlen(s), (which means if you use this option, that "s" can't have embedded "NUL" characters and has to have a terminating "NUL" byte).
All forms except "is_utf8_invariant_string_loc" have identical behavior. The only difference with it is that it has an extra pointer parameter, "ep", into which, if it isn't NULL, the location of the first UTF-8 variant character in the "ep" pointer will be stored upon failure. If all characters are UTF-8 invariant, this function does not change the contents of *ep.
"is_invariant_string" is somewhat misleadingly named. "is_utf8_invariant_string" is preferred, as it indicates under what conditions the string is invariant.
"is_ascii_string" is misleadingly-named. On ASCII-ish platforms, the name isn't misleading: the ASCII-range characters are exactly the UTF-8 invariants. But EBCDIC machines have more UTF-8 invariants than just the ASCII characters, so the name "is_utf8_invariant_string" is preferred.
See also "is_utf8_string" and "is_utf8_fixed_width_buf_flags".
bool is_utf8_invariant_string (const U8 * const s,
STRLEN len)
bool is_utf8_invariant_string_loc(const U8 * const s,
STRLEN len,
const U8 **ep)
bool Perl_is_utf8_invariant_string_loc(const U8 * const s,
STRLEN len,
const U8 **ep)
bool is_ascii_string (const U8 * const s,
STRLEN len)
bool is_invariant_string (const U8 * const s,
STRLEN len)
Some of the functions also return information about the string. Those that have the suffix "_loc" in their names have an extra parameter, "ep". If that is not NULL, the function stores into it the location of how far it got in parsing "s". If the function is returning TRUE, this will be a pointer to the byte immediately after the end of "s". If FALSE, it will be the location of the first byte that fails the criteria.
The functions that instead have the suffix "_loclen" have a second extra parameter, "el". They act as the plain "_loc" functions do with their "ep" parameter, but if "el" is not null, the functions store into it the number of UTF-8 encoded characters found at the point where parsing stopped. If the function is returning TRUE, this will be the full count of the UTF-8 characters in "s"; if FALSE, it will be the count before the first invalid one.
"is_utf8_string" (and "is_utf8_string_loc" and "is_utf8_string_loclen") consider Perl's extended UTF-8 to be valid. That means that code points above Unicode, surrogates, and non-character code points are all considered valid by this function. Problems may arise in interchange with non-Perl applications, or (unlikely) between machines with different word sizes.
"is_strict_utf8_string" (and "is_strict_utf8_string_loc" and "is_strict_utf8_string_loclen") consider only Unicode-range (0 to 0x10FFFF) code points to be valid, with the surrogates and non-character code points invalid. This level of strictness is what is safe to accept from outside sources that use Unicode rules.
The forms whose names contain "c9strict" conform to the level of strictness given in Unicode Corrigendum #9 <http://www.unicode.org/versions/corrigendum9.html>. This means Unicode-range code points including non-character ones are considered valid, but not the surrogates. This level of strictness is considered safe for cooperating components that know how the other components handle non-character code points.
The forms whose names contain "_flags" allow you to customize the acceptable level of strictness. They have an extra parameter, "flags" to indicate the types of code points that are acceptable. If "flags" is 0, they give the same results as "is_utf8_string" (and kin); if "flags" is "UTF8_DISALLOW_ILLEGAL_INTERCHANGE", they give the same results as "is_strict_utf8_string" (and kin); and if "flags" is "UTF8_DISALLOW_ILLEGAL_C9_INTERCHANGE", they give the same results as "is_c9strict_utf8_string" (and kin). Otherwise "flags" may be any combination of the "UTF8_DISALLOW_foo" flags understood by "utf8_to_uv", with the same meanings.
It's better to use one of the non-"_flags" functions if they give you the desired strictness, as those have a better chance of being inlined by the C compiler.
See also "is_utf8_invariant_string", "is_utf8_fixed_width_buf_flags",
bool is_utf8_string (const U8 *s,
STRLEN len)
bool is_utf8_string_loc (const U8 *s,
const STRLEN len,
const U8 **ep)
bool Perl_is_utf8_string_loc (const U8 *s,
const STRLEN len,
const U8 **ep)
bool is_utf8_string_loclen (const U8 *s,
STRLEN len,
const U8 **ep,
STRLEN *el)
bool Perl_is_utf8_string_loclen (const U8 *s,
STRLEN len,
const U8 **ep,
STRLEN *el)
bool is_strict_utf8_string (const U8 *s,
STRLEN len)
bool is_strict_utf8_string_loc (const U8 *s,
STRLEN len,
const U8 **ep)
bool is_strict_utf8_string_loclen (const U8 *s,
STRLEN len,
const U8 **ep,
STRLEN *el)
bool Perl_is_strict_utf8_string_loclen (const U8 *s,
STRLEN len,
const U8 **ep,
STRLEN *el)
bool is_c9strict_utf8_string (const U8 *s,
STRLEN len)
bool is_c9strict_utf8_string_loc (const U8 *s,
STRLEN len,
const U8 **ep)
bool is_c9strict_utf8_string_loclen(const U8 *s,
STRLEN len,
const U8 **ep,
STRLEN *el)
bool Perl_is_c9strict_utf8_string_loclen(const U8 *s,
STRLEN len,
const U8 **ep,
STRLEN *el)
bool is_utf8_string_flags (const U8 *s,
STRLEN len,
const U32 flags)
bool Perl_is_utf8_string_flags (const U8 *s,
STRLEN len,
const U32 flags)
bool is_utf8_string_loc_flags (const U8 *s,
STRLEN len,
const U8 **ep,
const U32 flags)
bool is_utf8_string_loclen_flags (const U8 *s,
STRLEN len,
const U8 **ep,
STRLEN *el,
const U32 flags)
bool Perl_is_utf8_string_loclen_flags (const U8 *s,
STRLEN len,
const U8 **ep,
STRLEN *el,
const U32 flags)
Otherwise, they return TRUE if there exists at least one non-empty sequence of bytes that when appended to sequence "s", starting at position "e" causes the entire sequence to be the well-formed UTF-8 of some code point
In other words they return TRUE if "s" points to an incomplete UTF-8-encoded code point; FALSE otherwise.
This is useful when a fixed-length buffer is being tested for being well-formed UTF-8, but the final few bytes in it don't comprise a full character; that is, it is split somewhere in the middle of the final code point's UTF-8 representation. (Presumably when the buffer is refreshed with the next chunk of data, the new first bytes will complete the partial code point.) This function is used to verify that the final bytes in the current buffer are in fact the legal beginning of some code point, so that if they aren't, the failure can be signalled without having to wait for the next read.
"is_utf8_valid_partial_char" behaves identically to "is_utf8_valid_partial_char_flags" when the latter is called with a zero "flags" parameter. This parameter is used to restrict the classes of code points that are considered to be valid. When zero, Perl's extended UTF-8 is used. Otherwise "flags" can be any combination of the "UTF8_DISALLOW_foo" flags accepted by "utf8_to_uv". If there is any sequence of bytes that can complete the input partial character in such a way that a non-prohibited character is formed, the function returns TRUE; otherwise FALSE. Non-character code points cannot be determined based on partial character input, so TRUE is always returned if "s" looks like it could be the beginning on one of those. But many of the other possible excluded types can be determined from just the first one or two bytes.
bool is_utf8_valid_partial_char (const U8 * const s0,
const U8 * const e)
bool is_utf8_valid_partial_char_flags(const U8 * const s0,
const U8 * const e,
const U32 flags)
bool Perl_is_utf8_valid_partial_char_flags(const U8 * const s0,
const U8 * const e,
const U32 flags)
These are used to efficiently decide if the next few bytes in "s" are legal UTF-8 for a single character.
With "isUTF8_CHAR", the code point can be any that will fit in an IV on this machine, using Perl's extension to official UTF-8 to represent those higher than the Unicode maximum of 0x10FFFF. That means that this will consider byte sequences to be valid that are unrecognized or considered illegal by non-Perl applications.
With "isSTRICT_UTF8_CHAR", acceptable code points are restricted to those defined by Unicode to be fully interchangeable across applications. This means code points above the Unicode range (max legal is 0x10FFFF), surrogates, and non-character code points are rejected.
With "isC9_STRICT_UTF8_CHAR", acceptable code points are restricted to those defined by Unicode to be fully interchangeable within an application. This means code points above the Unicode range and surrogates are rejected, but non-character code points are accepted. See Unicode Corrigendum #9 <http://www.unicode.org/versions/corrigendum9.html>.
Use "isUTF8_CHAR_flags" to customize what code points are acceptable. If "flags" is 0, this gives the same results as "isUTF8_CHAR"; if "flags" is "UTF8_DISALLOW_ILLEGAL_INTERCHANGE", this gives the same results as "isSTRICT_UTF8_CHAR"; and if "flags" is "UTF8_DISALLOW_ILLEGAL_C9_INTERCHANGE", this gives the same results as "isC9_STRICT_UTF8_CHAR". Otherwise "flags" may be any combination of the "UTF8_DISALLOW_foo" flags understood by "utf8_to_uv", with the same meanings.
The three alternative macros are for the most commonly needed validations; they are likely to run somewhat faster than this more general one, as they can be inlined into your code.
Use one of the "is_utf8_string" forms to check entire strings.
Note also that a UTF-8 "invariant" character (i.e. ASCII on non-EBCDIC machines) is a valid UTF-8 character.
"is_utf8_char_buf" is the old name for "isUTF8_CHAR". Do not use it in new code.
Size_t isUTF8_CHAR (const U8 * const s0,
const U8 * const e)
Size_t Perl_isUTF8_CHAR (const U8 * const s0,
const U8 * const e)
Size_t isSTRICT_UTF8_CHAR (const U8 * const s0,
const U8 * const e)
Size_t Perl_isSTRICT_UTF8_CHAR (const U8 * const s0,
const U8 * const e)
Size_t isC9_STRICT_UTF8_CHAR(const U8 * const s0,
const U8 * const e)
Size_t Perl_isC9_STRICT_UTF8_CHAR(const U8 * const s0,
const U8 * const e)
Size_t isUTF8_CHAR_flags (const U8 * const s0,
const U8 * const e,
const U32 flags)
Size_t Perl_isUTF8_CHAR_flags (const U8 * const s0,
const U8 * const e,
const U32 flags)
STRLEN is_utf8_char_buf (const U8 *buf,
const U8 *buf_end)
STRLEN Perl_is_utf8_char_buf (const U8 *buf,
const U8 *buf_end)
For conversion of code points potentially larger than will fit in a character, use "UNI_TO_NATIVE".
U8 LATIN1_TO_NATIVE(U8 ch)
For conversion of code points potentially larger than will fit in a character, use "NATIVE_TO_UNI".
U8 NATIVE_TO_LATIN1(U8 ch)
UV NATIVE_TO_UNI(UV ch)
The "flags" argument can have any combination of these flag bits
("UNI_DISPLAY_BACKSLASH" is preferred over "UNI_DISPLAY_ISPRINT" for "\\").
The pointer to the PV of the "dsv" is returned.
See also "sv_uni_display".
char * pv_uni_display( SV *dsv, const U8 *spv,
STRLEN len, STRLEN pvlim,
UV flags)
char * Perl_pv_uni_display(pTHX_ SV *dsv, const U8 *spv,
STRLEN len, STRLEN pvlim,
UV flags)
Returns TRUE if the terminator was found, else returns FALSE.
bool sv_cat_decode( SV *dsv, SV *encoding, SV *ssv,
int *offset, char *tstr, int tlen)
bool Perl_sv_cat_decode(pTHX_ SV *dsv, SV *encoding, SV *ssv,
int *offset, char *tstr, int tlen)
If "sv" already is UTF-8 (or if it is not "POK"), or if "encoding" is not a reference, nothing is done to "sv". If "encoding" is not an "Encode::XS" Encoding object, bad things will happen. (See encoding and Encode.)
The PV of "sv" is returned.
char * sv_recode_to_utf8( SV *sv, SV *encoding) char * Perl_sv_recode_to_utf8(pTHX_ SV *sv, SV *encoding)
The "flags" argument is as in "pv_uni_display"().
The pointer to the PV of the "dsv" is returned.
char * sv_uni_display( SV *dsv, SV *ssv, STRLEN pvlim,
UV flags)
char * Perl_sv_uni_display(pTHX_ SV *dsv, SV *ssv, STRLEN pvlim,
UV flags)
UV UNI_TO_NATIVE(UV ch)
bool UNICODE_IS_NONCHAR(const UV uv)
bool UNICODE_IS_REPLACEMENT(const UV uv)
bool UNICODE_IS_SUPER(const UV uv)
bool UNICODE_IS_SURROGATE(const UV uv)
WARNING: use only if you *know* that the pointers point inside the same UTF-8 buffer.
IV utf8_distance( const U8 *a, const U8 *b) IV Perl_utf8_distance(pTHX_ const U8 *a, const U8 *b)
WARNING: Prefer "utf8_hop_safe" to this one.
Do NOT use this function unless you know "off" is within the UTF-8 data pointed to by "s" and that on entry "s" is aligned on the first byte of a character or just after the last byte of a character.
U8 * utf8_hop(const U8 *s, SSize_t off) U8 * Perl_utf8_hop(const U8 *s, SSize_t off)
If there are fewer than "off" characters between "start" and "s", the functions return "start".
The functions differ in that "utf8_hop_back_overshoot" can return how many characters "off" beyond the edge the request was for. When its parameter, &remaining, is not NULL, the function stores into it the count of the excess; zero if the request was completely fulfilled. The actual number of characters that were displaced can then be calculated as "off - remaining". This function acts identically to plain "utf8_hop_back" when this parameter is NULL.
"s" does not need to be pointing to the starting byte of a character. If it isn't, one count of "off" will be used up to get to that start.
"off" must be non-positive, and if zero, no action is taken; "s" is returned unchanged. That it otherwise must be negative means that the earlier description is a lie, to avoid burdening you with this detail too soon. An "off" of -2 means to displace two characters backwards, so the displacement is actually the absolute value of "off". "remaining" will also be non-positive. If there was only one character between "start" and "s", and a displacement of -2 was requested, "remaining" would be set to -1. The subtraction formula works, yielding the result that only -1 character was displaced.
U8 * utf8_hop_back (const U8 *s, SSize_t off,
const U8 * const start)
U8 * Perl_utf8_hop_back (const U8 *s, SSize_t off,
const U8 * const start)
U8 * utf8_hop_back_overshoot(const U8 *s, SSize_t off,
const U8 * const start,
SSize_t *remaining)
U8 * Perl_utf8_hop_back_overshoot(const U8 *s, SSize_t off,
const U8 * const start,
SSize_t *remaining)
If there are fewer than "off" characters between "s0" and "end", the functions return "end".
The functions differ in two ways
(The above contains a slight lie. When "remaining" is NULL, the two functions act identically.)
"s0" does not need to be pointing to the starting byte of a character. If it isn't, one count of "off" will be used up to get to that start.
"off" must be non-negative, and if zero, no action is taken; "s0" is returned unchanged.
U8 * utf8_hop_forward (const U8 *s, SSize_t off,
const U8 * const end)
U8 * Perl_utf8_hop_forward (const U8 *s, SSize_t off,
const U8 * const end)
U8 * utf8_hop_forward_overshoot(const U8 *s, SSize_t off,
const U8 * const end,
SSize_t *remaining)
U8 * Perl_utf8_hop_forward_overshoot(const U8 *s, SSize_t off,
const U8 * const end,
SSize_t *remaining)
If there are fewer than "off" characters between "s" and the respective edge, the functions return that edge.
The functions differ in that "utf8_hop_overshoot" can return how many characters beyond the edge the request was for. When its parameter, &remaining, is not NULL, the function stores into it the count of the excess; zero if the request was completely fulfilled. The actual number of characters that were displaced can then be calculated as "off - remaining". This function acts identically to plain "utf8_hop_safe" when this parameter is NULL.
"s" does not need to be pointing to the starting byte of a character. If it isn't, one count of "off" will be used up to get to that start.
To be more precise, the displacement is by the absolute value of "off", and the excess count is the absolute value of "remaining".
U8 * utf8_hop_safe (const U8 *s, SSize_t off,
const U8 * const start,
const U8 * const end)
U8 * Perl_utf8_hop_safe (const U8 *s, SSize_t off,
const U8 * const start,
const U8 * const end)
U8 * utf8_hop_overshoot(const U8 *s, SSize_t off,
const U8 * const start,
const U8 * const end,
SSize_t *remaining)
U8 * Perl_utf8_hop_overshoot(const U8 *s, SSize_t off,
const U8 * const start,
const U8 * const end,
SSize_t *remaining)
In spite of the name, this macro gives the correct result if the input string from which "c" comes is not encoded in UTF-8.
See "UVCHR_IS_INVARIANT" for checking if a UV is invariant.
bool UTF8_IS_INVARIANT(char c)
bool UTF8_IS_NONCHAR(const U8 *s, const U8 *e)
bool UTF8_IS_REPLACEMENT(const U8 *s, const U8 *e)
This macro evaluates to non-zero if the first few bytes of the string starting at "s" and looking no further than "e - 1" are from this UTF-8 extension; otherwise it evaluates to 0. If non-zero, the return is how many bytes starting at "s" comprise the code point's representation.
0 is returned if the bytes are not well-formed extended UTF-8, or if they represent a code point that cannot fit in a UV on the current platform. Hence this macro can give different results when run on a 64-bit word machine than on one with a 32-bit word size.
Note that it is illegal in Perl to have code points that are larger than what can fit in an IV on the current machine; and illegal in Unicode to have any that this macro matches
bool UTF8_IS_SUPER(const U8 *s, const U8 *e)
bool UTF8_IS_SURROGATE(const U8 *s, const U8 *e)
If "e < s" or if the scan would end up past "e", it raises a UTF8 warning and returns the number of valid characters.
STRLEN utf8_length( const U8 *s0, const U8 *e) STRLEN Perl_utf8_length(pTHX_ const U8 *s0, const U8 *e)
NOTE: Strictly speaking Perl's UTF-8 should not be called UTF-8 since UTF-8 is an encoding of Unicode, and Unicode's upper limit, 0x10FFFF, can be expressed with 4 bytes. However, Perl thinks of UTF-8 as a way to encode non-negative integers in a binary format, even those above Unicode.
These each convert a string encoded as UTF-8 into the equivalent native byte representation, if possible. The first three forms are preferred; their API is more convenient to use, and each return "true" if the result is in bytes; "false" if the conversion failed.
These differ primarily in the form of the returned string and the allowed constness of the input string. In each, if the input string was already in native bytes or was not convertible, the input isn't changed.
In each of these three functions, the input "s_ptr" is a pointer to the string to be converted and *lenp is its length (so that the first byte will be at *sptr[0]).
"utf8_to_bytes_overwrite" overwrites the input string with the bytes conversion. Hence, the input string should not be "const". (Converting the multi-byte UTF-8 encoding to single bytes never expands the result, so overwriting is always feasible.)
Both "utf8_to_bytes_new_pv" and "utf8_to_bytes_temp_pv" allocate new memory to hold the converted string, never changing the input. Hence the input string may be "const". They differ in that "utf8_to_bytes_temp_pv" arranges for the new memory to automatically be freed. With "utf8_to_bytes_new_pv", the caller is responsible for freeing the memory. As explained below, not all successful calls result in new memory being allocated. Hence this function also returns to the caller (via an extra parameter, *free_me) a pointer to any new memory, or "NULL" if none was allocated.
The functions return "false" when the input is not well-formed UTF-8 or contains at least one UTF-8 sequence that represents a code point that can't be expressed as a byte. The contents of *s_ptr and *lenp are not changed. "utf8_to_bytes_new_pv" sets *free_me to "NULL".
They all return "true" when either:
For "utf8_to_bytes_temp_pv", the new memory has been arranged to be automatically freed, via a call to "SAVEFREEPV".
For "utf8_to_bytes_new_pv", *free_me has been set to *s_ptr, and it is the caller's responsibility to free the new memory when done using it. The following paradigm is convenient to use for this:
void * free_me;
if (utf8_to_bytes_new_pv(&s, &len, &free_me) {
...
}
else {
...
}
...
Safefree(free_me);
"free_me" can be used as a boolean (non-NULL meaning "true") to indicate that the input was indeed changed if you need to revisit that later in the code. Your design is likely flawed if you find yourself using "free_me" for any other purpose.
Note that in all cases, *s_ptr and *lenp will have correct and consistent values, updated as was necessary.
Also note that upon successful conversion, the number of variants in the string can be computed by having saved the value of *lenp before the call, and subtracting the after-call value of *lenp from it. This is also true for the other two functions described below.
Plain "utf8_to_bytes" (which has never lost its experimental status) also converts a UTF-8 encoded string to bytes, but there are more glitches that the caller has to be prepared to handle.
The input string is passed with one less indirection level, "s".
The function returns NULL and sets *lenp to -1, cast to "STRLEN". This means that you will have to use a temporary containing the string length to pass to the function if you will need the value afterwards.
"bytes_from_utf8" also converts a potentially UTF-8 encoded string "s" to bytes. It preserves "s", allocating new memory for the converted string.
In contrast to the other functions, the input string to this one need not be UTF-8. If not, the caller has set *is_utf8p to be "false", and the function does nothing, returning the original "s".
Also do nothing if there are code points in the string not expressible in native byte encoding, returning the original "s".
Otherwise, *is_utf8p is set to 0, and the return value is a pointer to a newly created string containing the native byte equivalent of "s", and whose length is returned in *lenp, updated. The new string is "NUL"-terminated. The caller is responsible for arranging for the memory used by this string to get freed.
The major problem with this function is that memory is allocated and filled even when the input string was already in bytes form.
New code should use the first three functions listed above.
bool utf8_to_bytes_overwrite( U8 **s_ptr,
STRLEN *lenp)
bool Perl_utf8_to_bytes_overwrite(pTHX_ U8 **s_ptr,
STRLEN *lenp)
bool utf8_to_bytes_new_pv ( U8 const **s_ptr,
STRLEN *lenp,
void **free_me)
bool Perl_utf8_to_bytes_new_pv (pTHX_ U8 const **s_ptr,
STRLEN *lenp,
void **free_me)
bool utf8_to_bytes_temp_pv ( U8 const **s_ptr,
STRLEN *lenp)
bool Perl_utf8_to_bytes_temp_pv (pTHX_ U8 const **s_ptr,
STRLEN *lenp)
U8 * utf8_to_bytes ( U8 *s, STRLEN *lenp)
U8 * Perl_utf8_to_bytes (pTHX_ U8 *s, STRLEN *lenp)
U8 * bytes_from_utf8 ( const U8 *s,
STRLEN *lenp,
bool *is_utf8p)
U8 * Perl_bytes_from_utf8 (pTHX_ const U8 *s,
STRLEN *lenp,
bool *is_utf8p)
These functions each translate from UTF-8 to UTF-32 (or UTF-64 on 64 bit platforms). In other words, to a code point ordinal value. (On EBCDIC platforms, the initial encoding is UTF-EBCDIC, and the output is a native code point).
For example, the string "A" would be converted to the number 65 on an ASCII platform, and to 193 on an EBCDIC one. Converting the string "ABC" would yield the same results, as the functions stop after the first character converted. Converting the string "\N{LATIN CAPITAL LETTER A WITH MACRON} plus anything more in the string" would yield the number 0x100 on both types of platforms, since the first character is U+0100.
The functions whose names contain "to_uvchr" are older than the functions whose names don't have "chr" in them. The API in the older functions is harder to use correctly, and so they are kept only for backwards compatibility, and may eventually become deprecated. If you are writing a module and use Devel::PPPort, your code can use the new functions back to at least Perl v5.7.1.
All the functions accept, without complaint, well-formed UTF-8 for any non-problematic Unicode code point 0 .. 0x10FFFF. There are two types of Unicode problematic code points: surrogate characters and non-character code points. (See perlunicode.) Some of the functions reject one or both of these. Private use characters and those code points yet to be assigned to a particular character are never considered problematic. Additionally, most of the functions accept non-Unicode code points, those starting at 0x110000.
There are two sets of these functions:
"utf8_to_uv_or_die" has a simpler interface than the other four, for use when any errors encountered should be fatal. It throws an exception with any errors found, otherwise it returns the code point the input sequence represents.
The other four functions each return "true" if the sequence of bytes starting at "s" form a complete, legal UTF-8 (or UTF-EBCDIC) sequence for a code point; or false otherwise. They take an extra parameter, the address of an IV, &cp. *cp will be set to the native code point value the sequence represents, and *advance will be set to its length, in bytes.
If the functions returns "false", *cp is set to the Unicode REPLACEMENT CHARACTER, and *advance to the next position along "s", where the next possible UTF-8 character could begin. Failing to use this position as the next starting point during parsing of strings has led to successful attacks by crafted inputs.
The functions only examine as many bytes along "s" as are needed to form a complete UTF-8 representation of a single code point; they never examine the byte at "e", or beyond. They return false (or die in the case of "utf8_to_uv_or_die") if the code point requires more than "e - s" bytes to represent.
The functions differ only in what flavor of UTF-8 they accept. All reject syntactically invalid UTF-8.
additionally rejects any UTF-8 that translates into a code point that isn't specified by Unicode to be freely exchangeable, namely the surrogate characters and non-character code points (besides non-Unicode code points, any above 0x10FFFF). It does not raise a warning when rejecting these.
instead uses the exchangeable definition given by Unicode's Corregendum #9, which accepts non-character code points while still rejecting surrogates. It does not raise a warning when rejecting these.
accept all syntactically valid UTF-8, as extended by Perl to allow 64-bit code points to be encoded.
"extended_utf8_to_uv" is merely a synonym for "utf8_to_uv". Use this form to draw attention to the fact that it accepts any code point. But since Perl programs traditionally do this by default, plain "utf8_to_uv" is the form most often used.
Whenever syntactically invalid input is rejected, an explanatory warning message is raised, unless "utf8" warnings (or the appropriate subcategory) are turned off. A given input sequence may contain multiple malformations, giving rise to multiple warnings, as the functions attempt to find and report on all malformations in a sequence. All the possible malformations are listed in "utf8_to_uv_msgs", with some examples of multiple ones for the same sequence. You can use that function or "utf8_to_uv_flags" to exert more control over the input that is considered acceptable, and the warnings that are raised.
Often, "s" is an arbitrarily long string containing the UTF-8 representations of many code points in a row, and these functions are called in the course of parsing "s" to find all those code points.
If your code doesn't know how to deal with illegal input, as would be typical of a low level routine, the loop could look like:
while (s < e) {
Size_t advance;
UV cp;
(void) utf8_to_uv(s, e, &cp, &advance);
<handle 'cp'>
s += advance;
}
A REPLACEMENT CHARACTER will be inserted everywhere that malformed input occurs. Obviously, we aren't expecting such outcomes, but your code will be protected from attacks and many harmful effects that could otherwise occur.
If the situation is such that it would be a bug for the input to be invalid, a somewhat simpler loop suffices:
while (s < e) {
Size_t advance;
UV cp = utf8_to_uv_or_die(s, e, &advance);
<handle 'cp'>
s += advance;
}
This will throw an exception on invalid input, so your code doesn't have to concern itself with that possibility.
If you do have a plan for handling malformed input, you could instead write:
while (s < e) {
Size_t advance;
UV cp;
if (UNLIKELY(! utf8_to_uv(s, e, &cp, &advance)) {
<bail out or convert to handleable>
}
<handle 'cp'>
s += advance;
}
You may pass NULL to these functions instead of a pointer to your "advance" variable. But the only legitimate case to do this is if you are only examining the first character in "s", and have no plans to ever look further. You could also advance by using "UTF8SKIP", but this gives the correct result if and only if the input is well-formed; and this practice has led to successful attacks against such code; and it is extra work always, as the functions have already done the equivalent work and return the correct value in "advance", regardless of whether the input is well-formed or not.
Except with "utf8_to_uv_or_die", you must always pass a non-NULL pointer into which to store the (first) code point "s" represents. If you don't care about this value, you should be using one of the "isUTF8_CHAR" functions instead.
"utf8_to_uvchr" is DEPRECATED. Do NOT use it; it is a security hole ready to bring destruction onto you and yours.
"utf8_to_uvchr_buf" is discouraged and may eventually become deprecated. It checks if the sequence of bytes starting at "s" form a complete, legal UTF-8 (or UTF-EBCDIC) sequence for a code point. If so, it returns the code point value the sequence represents, and *retlen will be set to its length, in bytes. Thus, the next possible character in "s" begins at "s + *retlen".
The function only examines as many bytes along "s" as are needed to form a complete UTF-8 representation of a single code point, but it never examines the byte at "e", or beyond.
If the sequence examined starting at "s" is not legal Perl extended UTF-8, the translation fails, and the resultant behavior unfortunately depends on if the warnings category "utf8" is enabled or not.
But note that it is ambiguous whether a REPLACEMENT CHARACTER was actually in the input, or if this function synthetically generated one. In the unlikely event that you care, you'd have to examine the input to disambiguate.
But note that 0 may also be returned if *s is a legal NUL character. This means that you have to disambiguate a 0 return. You can do this by checking that the first byte of "s" is indeed a NUL; or by making sure to always pass a non-NULL "retlen" pointer, and by examining it.
Also note that should you wish to proceed with parsing "s", you have no easy way of knowing where to start looking in it for the next possible character. It is important to look in the right place to prevent attacks on your code. It would be better to have instead called an equivalent function that provides this information; any of the "utf8_to_uv" series, or "utf8n_to_uvchr".
Because of these quirks, "utf8_to_uvchr_buf" is very difficult to use correctly and handle all cases. Generally, you need to bail out at the first failure it finds.
The deprecated "utf8_to_uvchr" behaves the same way as "utf8_to_uvchr_buf" for well-formed input, and for the malformations it is capable of finding, but doesn't find all of them, and it can read beyond the end of the input buffer, which is why it is deprecated.
The utf8_to_uv() family of functions is preferred because they make it easier to write code safe from attacks. You should be converting to them; this will result in simpler, more robust code.
bool utf8_to_uv ( const U8 * const s,
const U8 * const e,
UV *cp_p, Size_t *advance_p)
bool Perl_utf8_to_uv ( const U8 * const s,
const U8 * const e,
UV *cp_p, Size_t *advance_p)
bool extended_utf8_to_uv( const U8 * const s,
const U8 * const e,
UV *cp_p, Size_t *advance_p)
bool Perl_extended_utf8_to_uv( const U8 * const s,
const U8 * const e,
UV *cp_p, Size_t *advance_p)
bool strict_utf8_to_uv ( const U8 * const s,
const U8 * const e,
UV *cp_p, Size_t *advance_p)
bool Perl_strict_utf8_to_uv ( const U8 * const s,
const U8 * const e,
UV *cp_p, Size_t *advance_p)
bool c9strict_utf8_to_uv( const U8 * const s,
const U8 * const e,
UV *cp_p, Size_t *advance_p)
bool Perl_c9strict_utf8_to_uv( const U8 * const s,
const U8 * const e,
UV *cp_p, Size_t *advance_p)
UV utf8_to_uv_or_die ( const U8 * const s,
const U8 *e,
Size_t *advance_p)
UV Perl_utf8_to_uv_or_die ( const U8 * const s,
const U8 *e,
Size_t *advance_p)
UV utf8_to_uvchr_buf ( const U8 *s, const U8 *send,
STRLEN *retlen)
UV Perl_utf8_to_uvchr_buf (pTHX_ const U8 *s, const U8 *send,
STRLEN *retlen)
UV utf8_to_uvchr ( const U8 *s, STRLEN *retlen)
UV Perl_utf8_to_uvchr (pTHX_ const U8 *s, STRLEN *retlen)
"utf8n_to_uvchr" is more like an extension of "utf8_to_uvchr_buf", but with fewer quirks, and a different method of specifying the bytes in "s" it is allowed to examine. It has a "curlen" parameter instead of an "e" parameter, so the furthest byte in "s" it can look at is "s + curlen - 1". Its return value is, like "utf8_to_uvchr_buf", ambiguous with respect to the NUL and REPLACEMENT characters, but the value of *retlen can be relied on (except with the "UTF8_CHECK_ONLY" flag described below) to know where the next possible character along "s" starts, removing that quirk. Hence, you always should use *retlen to determine where the next character in "s" starts.
These functions have an additional parameter, "flags", besides the ones in "utf8_to_uv" and "utf8_to_uvchr_buf", which can be used to broaden or restrict what is acceptable UTF-8. "flags" has the same meaning and behavior in both functions. When "flags" is 0, these functions accept any syntactically valid Perl-extended-UTF-8 sequence that doesn't overflow the platform's word size.
There are flags that apply to accepting particular sequences, and flags that apply to raising warnings about encountering sequences. Each type is independent of the other. You can reject and not warn; warn and still accept; or both reject and warn. Rejecting means that the sequence gets translated into the Unicode REPLACEMENT CHARACTER instead of what it was meant to represent.
Unless otherwise stated below, warnings are subject to the "utf8" warnings category being on.
This flag is ignored if "UTF8_DIE_IF_MALFORMED" is also set.
Do not use it lightly.
This flag is ignored if "UTF8_CHECK_ONLY" is also set.
All such code points are not considered to be safely freely exchangeable between processes.
Unicode issued Unicode Corrigendum #9 <https://www.unicode.org/versions/corrigendum9.html> to allow non-character code points to be exchanged by processes aware of the possibility. (They are still discouraged, however.) For more discussion see "Noncharacter code points" in perlunicode.
Perl predates Unicode, and earlier standards allowed for code points up through 0x7FFF_FFFF (2**31 - 1). Perl, of course, would like you to be able to represent in UTF-8 any code point available on the platform. To do so, some extension must be used to express them. Perl uses a natural extension to UTF-8 to represent the ones up to 2**36-1, and invented a further extension to represent even higher ones, so that any code point that fits in a 64-bit word can be represented. We lump both of these extensions together and refer to them as Perl extended UTF-8. There exist other extensions that people have invented, incompatible with Perl's.
On EBCDIC platforms starting in Perl v5.24, the Perl extension for representing extremely high code points kicks in at 0x3FFF_FFFF (2**30 -1), which is lower than on ASCII. Prior to that, code points 2**31 and higher were simply unrepresentable, and a different, incompatible method was used to represent code points between 2**30 and 2**31 - 1.
It is likely that programs written in something other than Perl would not be able to read files that contain these; nor would Perl understand files written by something that uses a different extension. Hence, you can specify that above-Unicode code points are generally accepted and/or warned about, but still exclude the ones that require this extension to represent.
However, all such malformations translate to the REPLACEMENT CHARACTER, regardless of any of the flags.
The only such flag that you would ever have any reason to use is "UTF8_ALLOW_ANY" which applies to any of the syntactic malformations and overflow, except for empty input. The other flags are analogous to ones in the "_GOT_" bits list in "utf8_to_uv_msgs".
bool utf8_to_uv_flags(const U8 * const s,
const U8 * const e, UV *cp_p,
Size_t *advance_p, U32 flags)
bool Perl_utf8_to_uv_flags(const U8 * const s,
const U8 * const e, UV *cp_p,
Size_t *advance_p, U32 flags)
UV utf8n_to_uvchr (const U8 *s, STRLEN curlen,
STRLEN *retlen, const U32 flags)
UV Perl_utf8n_to_uvchr (const U8 *s, STRLEN curlen,
STRLEN *retlen, const U32 flags)
They each take one or two extra parameters, pointers to where to store this information. The functions with "_msgs" in their names return both types, so take two extra parameters; those with "_error" return just the malformations, so take just one extra parameter. When the extra parameters are both 0, the functions behave identically to the function they extend.
When the "errors" parameter is not NULL, it should be the address of a U32 variable, into which the functions store a bitmap, described just below, with a bit set for each malformation the function found; 0 if none. The "ALLOW"-type flags are ignored when determining the content of this variable. That is, even if you "allow" a particular malformation, if it is encountered, the corresponding bit will be set to notify you that one was encountered. However, the bits for conditions that are accepted by default aren't set unless the flags passed to the function indicate that they should be rejected or warned about when encountering them. These are explicitly noted in the list below along with the controlling flags.
The bits returned in "errors" and their meanings are:
Until Unicode 3.1, it was legal for programs to accept this malformation, but it was discovered that this created security issues.
"UTF8_GOT_SHORT" and "UTF8_GOT_NON_CONTINUATION" both indicate a too short sequence. The difference is that "UTF8_GOT_NON_CONTINUATION" indicates always that there is an error, while "UTF8_GOT_SHORT" means that an incomplete sequence was looked at. If no other flags are present, it means that the sequence was valid as far as it went. Depending on the application, this could mean one of three things:
Note that more than one bit may have been set by these functions. This is because it is possible for multiple malformations to be present in the same sequence. An example would be an overlong sequence evaluating to a surrogate when surrogates are forbidden. Another example is overflow; standard UTF-8 never overflows, so something that does must have been expressed using Perl's extended UTF-8. It also is above all legal Unicode code points. So there will be a bit set for up to all three of these things. 1) Overflow always; 2) perl-extended if the calling flags indicate those should be rejected or warned about; and 3) above-Unicode, provided the calling flags indicate those should be rejected or warned about.
If you don't care about the system's messages text nor warning categories, you can customize error handling by calling one of the "_error" functions, using either of the flags "UTF8_ALLOW_ANY" or "UTF8_CHECK_ONLY" to suppress any warnings, and then examine the *errors return. If you don't use those flags, warnings will be raised as usual.
But if you do care, instead use one of the functions with "_msgs" in their names. These allow you to completely customize error handling by suppressing any warnings that would otherwise be raised; instead returning all relevant information in a structure specified by an extra parameter, "msgs", a pointer to a variable which has been declared to be an "AV*", and into which the function creates a new AV to store information, described below, about all the malformations that were encountered.
When this parameter is non-NULL, the "UTF8_DIE_IF_MALFORMED" and "UTF8_FORCE_WARN_IF_MALFORMED" flags are asserted against in DEBUGGING builds, and are ignored in non-DEBUGGING ones. The "UTF8_CHECK_ONLY" flag is always ignored.
What is considered a malformation is affected by "flags", the same as described in "utf8_to_uv_flags". No array element is generated for malformations that are "allowed" by the input flags, in contrast to the bitmap returned in a non-NULL *errors.
Each element of the "msgs" AV array is an anonymous hash with the following three key-value pairs:
The array is sorted so that element "[0]" contains the first message that would have otherwise been raised; "[1]", the second; and so on.
You thus can completely override the normal error handling; you can check the lexical warnings state (or not) when choosing what to do with the returned messages.
The caller, of course, is responsible for freeing any returned AV.
bool utf8_to_uv_msgs (const U8 * const s0, const U8 *e,
UV *cp_p, Size_t *advance_p,
U32 flags, U32 *errors,
AV **msgs)
bool Perl_utf8_to_uv_msgs (const U8 * const s0, const U8 *e,
UV *cp_p, Size_t *advance_p,
U32 flags, U32 *errors,
AV **msgs)
UV utf8n_to_uvchr_msgs (const U8 * const s0,
STRLEN curlen, STRLEN *retlen,
const U32 flags, U32 *errors,
AV **msgs)
UV Perl_utf8n_to_uvchr_msgs (const U8 * const s0,
STRLEN curlen, STRLEN *retlen,
const U32 flags, U32 *errors,
AV **msgs)
bool utf8_to_uv_errors (const U8 * const s,
const U8 * const e, UV *cp_p,
Size_t *advance_p, U32 flags,
U32 *errors)
bool Perl_utf8_to_uv_errors (const U8 * const s,
const U8 * const e, UV *cp_p,
Size_t *advance_p, U32 flags,
U32 *errors)
UV utf8n_to_uvchr_error(const U8 *s, STRLEN curlen,
STRLEN *retlen, const U32 flags,
U32 *errors)
UV Perl_utf8n_to_uvchr_error(const U8 *s, STRLEN curlen,
STRLEN *retlen, const U32 flags,
U32 *errors)
(If you write a new function, you probably should instead return the PV in an SV with the UTF-8 flag of the SV properly set, rather than use this mechanism.)
The possible values this can be are:
Most code that needs to handle this typedef should be of the form:
if (utf8ness_flag == UTF8NESS_YES) {
treat as utf8; // like turning on an SV UTF-8 flag
}
utf8ness_t string_is_utf8 = UTF8NESS_UNKNOWN
const char * string = foo(arg1, arg2, ..., &string_is_utf8);
if (string_is_utf8 == UTF8NESS_YES) {
do something for UTF-8;
}
The following relationships hold between the enum values:
"UTF8SKIP" and "UTF8_SKIP" are synonyms. Use them when there is no possibility that the character pointed to by "s" is malformed.
If there is a possibility of malformed input, use instead:
Perl tends to add NULs, as an insurance policy, after the end of strings in SV's, so it is likely that using this macro on an SV string will prevent inadvertent reading beyond the end of the input buffer, even if it is malformed UTF-8.
This macro is intended to be used by XS modules where the inputs could be malformed, and it isn't feasible to restructure to use the safer "UTF8_SAFE_SKIP", for example when interfacing with a C library.
STRLEN UTF8SKIP (const char* s) STRLEN UTF8_SKIP (const char* s) STRLEN UTF8_CHK_SKIP (const char* s) STRLEN UTF8_SAFE_SKIP(const char* s, const char* e)
d = uv_to_utf8(d, uv);
This is the Unicode-aware way of saying
*(d++) = uv;
("uvchr_to_utf8" is a synonym for "uv_to_utf8".)
"uv_to_utf8_flags" is used to make some classes of code points problematic in some way. "uv_to_utf8" is effectively the same as calling "uv_to_utf8_flags" with "flags" set to 0, meaning no class of code point is considered problematic. That means any input code point from 0.."IV_MAX" is considered to be fine. "IV_MAX" is typically 0x7FFF_FFFF in a 32-bit word.
("uvchr_to_utf8_flags" is a synonym for "uv_to_utf8_flags").
A code point can be problematic in one of two ways. Its use could just raise a warning, and/or it could be forbidden with the function failing, and returning NULL.
The potential classes of problematic code points and the flags that make them so are:
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 instead "UNICODE_DISALLOW_SURROGATE" is set, the function will fail and return NULL. If both flags are set, the function will both warn and return NULL.
Similarly, the "UNICODE_WARN_NONCHAR" and "UNICODE_DISALLOW_NONCHAR" flags affect how the function handles a Unicode non-character.
And likewise, the "UNICODE_WARN_SUPER" and "UNICODE_DISALLOW_SUPER" flags affect the handling of code points that are above the Unicode maximum of 0x10FFFF. Languages other than Perl may not be able to accept files that contain these.
The flag "UNICODE_WARN_ILLEGAL_INTERCHANGE" selects all three of the above WARN flags; and "UNICODE_DISALLOW_ILLEGAL_INTERCHANGE" selects all three DISALLOW flags. "UNICODE_DISALLOW_ILLEGAL_INTERCHANGE" restricts the allowed inputs to the strict UTF-8 traditionally defined by Unicode. Similarly, "UNICODE_WARN_ILLEGAL_C9_INTERCHANGE" and "UNICODE_DISALLOW_ILLEGAL_C9_INTERCHANGE" are shortcuts to select the above-Unicode and surrogate flags, but not the non-character ones, as defined in Unicode Corrigendum #9 <https://www.unicode.org/versions/corrigendum9.html>. See "Noncharacter code points" in perlunicode.
Extremely high code points were never specified in any standard, and require an extension to UTF-8 to express, which Perl does. It is likely that programs written in something other than Perl would not be able to read files that contain these; nor would Perl understand files written by something that uses a different extension. For these reasons, there is a separate set of flags that can warn and/or disallow these extremely high code points, even if other above-Unicode ones are accepted. They are the "UNICODE_WARN_PERL_EXTENDED" and "UNICODE_DISALLOW_PERL_EXTENDED" flags. For more information see "UTF8_GOT_PERL_EXTENDED". Of course "UNICODE_DISALLOW_SUPER" will treat all above-Unicode code points, including these, as malformations. (Note that the Unicode standard considers anything above 0x10FFFF to be illegal, but there are standards predating it that allow up to 0x7FFF_FFFF (2**31 -1))
A somewhat misleadingly named synonym for "UNICODE_WARN_PERL_EXTENDED" is retained for backward compatibility: "UNICODE_WARN_ABOVE_31_BIT". Similarly, "UNICODE_DISALLOW_ABOVE_31_BIT" is usable instead of the more accurately named "UNICODE_DISALLOW_PERL_EXTENDED". The names are misleading because on EBCDIC platforms,these flags can apply to code points that actually do fit in 31 bits. The new names accurately describe the situation in all cases.
U8 * uv_to_utf8 ( U8 *d, UV uv) U8 * Perl_uv_to_utf8 (pTHX_ U8 *d, UV uv) U8 * uv_to_utf8_flags ( U8 *d, UV uv, UV flags) U8 * Perl_uv_to_utf8_flags (pTHX_ U8 *d, UV uv, UV flags) U8 * uvchr_to_utf8 ( U8 *d, UV uv) U8 * uvchr_to_utf8_flags( U8 *d, UV uv, UV flags)
Most code should use ""uv_to_utf8_flags"()" rather than call this directly.
This function is for code that wants any warning and/or error messages to be returned to the caller rather than be displayed. Any message that would have been displayed if all lexical warnings are enabled will instead be returned.
It is just like "uvchr_to_utf8_flags" but it takes an extra parameter placed after all the others, "msgs". If this parameter is 0, this function behaves identically to "uvchr_to_utf8_flags". Otherwise, "msgs" should be a pointer to an "HV *" variable, in which this function creates a new HV to contain any appropriate message. The hash has three key-value pairs, as follows:
It's important to note that specifying this parameter as non-null will cause any warning this function would otherwise generate to be suppressed, and instead be placed in *msgs. The caller can check the lexical warnings state (or not) when choosing what to do with the returned message.
Only a single message is returned; if a code point requires Perl extended UTF-8 to represent, it is also above-Unicode. If either the "UNICODE_WARN_PERL_EXTENDED" or "UNICODE_DISALLOW_PERL_EXTENDED" flags are set, the return is controlled by them; if neither is set, the return is controlled by the "UNICODE_WARN_SUPER" and "UNICODE_DISALLOW_SUPER" flags.
The caller, of course, is responsible for freeing any returned HV.
U8 * uv_to_utf8_msgs ( U8 *d, UV uv, UV flags,
HV **msgs)
U8 * Perl_uv_to_utf8_msgs (pTHX_ U8 *d, UV uv, UV flags,
HV **msgs)
U8 * uvchr_to_utf8_flags_msgs( U8 *d, UV uv, UV flags,
HV **msgs)
bool UVCHR_IS_INVARIANT(UV cp)
STRLEN UVCHR_SKIP(UV cp)
void * C_ARRAY_END(void *a)
STRLEN C_ARRAY_LENGTH(void *a)
int getcwd_sv( SV *sv) int Perl_getcwd_sv(pTHX_ SV *sv)
bool IN_PERL_COMPILETIME
bool IN_PERL_RUNTIME
bool IS_SAFE_SYSCALL(const char *pv, STRLEN len,
const char *what, const char *op_name)
Return TRUE if the name is safe.
"what" and "op_name" are used in any warning.
Used by the IS_SAFE_SYSCALL() macro.
bool is_safe_syscall( const char *pv, STRLEN len,
const char *what,
const char *op_name)
bool Perl_is_safe_syscall(pTHX_ const char *pv, STRLEN len,
const char *what,
const char *op_name)
void my_setenv( const char *nam, const char *val) void Perl_my_setenv(pTHX_ const char *nam, const char *val)
This is convenient when constructing a large optree in nested function calls, as it avoids needing to store the pad op directly to set the "op_targ" field as a side-effect. For example
o = op_append_elem(OP_LINESEQ, o,
newPADxVOP(OP_PADSV, 0, padix));
OP * newPADxVOP( I32 type, I32 flags, PADOFFSET padix) OP * Perl_newPADxVOP(pTHX_ I32 type, I32 flags, PADOFFSET padix)
For example, to print a stack trace that includes the current interpreter phase you might do:
const char* phase_name = phase_name(PL_phase);
mess("This is weird. (Perl phase: %s)", phase_name);
const char * const phase_name(enum perl_phase)
void PoisonFree(void* dest, int nitems, type) void Poison (void* dest, int nitems, type)
void PoisonNew(void* dest, int nitems, type)
void PoisonWith(void* dest, int nitems, type, U8 byte)
void StructCopy(type *src, type *dest, type)
bool sv_destroyable( SV *sv) bool Perl_sv_destroyable(pTHX_ SV *sv)
void sv_nosharing( SV *sv) void Perl_sv_nosharing(pTHX_ SV *sv)
SV *sv = new_version(SV *ver);
Does not alter the passed in ver SV. See "upg_version" if you want to upgrade the SV.
SV * new_version( SV *ver) SV * Perl_new_version(pTHX_ SV *ver)
The major number component of the perl interpreter currently being compiled or executing. This has been 5 from 1993 into 2020.
Instead use one of the version comparison macros. See "PERL_VERSION_EQ".
The micro number component of the perl interpreter currently being compiled or executing. In stable releases this gives the dot release number for maintenance updates. In development releases this gives a tag for a snapshot of the status at various points in the development cycle.
Instead use one of the version comparison macros. See "PERL_VERSION_EQ".
The minor number component of the perl interpreter currently being compiled or executing. Between 1993 into 2020, this has ranged from 0 to 33.
Instead use one of the version comparison macros. See "PERL_VERSION_EQ".
#if PERL_VERSION_GT(5,24,2)
code that will only be compiled on perls after v5.24.2
#else
fallback code
#endif
Note that this is usable in making compile-time decisions
You may use the special value '*' for the final number to mean ALL possible values for it. Thus,
#if PERL_VERSION_EQ(5,31,'*')
means all perls in the 5.31 series. And
#if PERL_VERSION_NE(5,24,'*')
means all perls EXCEPT 5.24 ones. And
#if PERL_VERSION_LE(5,9,'*')
is effectively
#if PERL_VERSION_LT(5,10,0)
This means you don't have to think so much when converting from the existing deprecated "PERL_VERSION" to using this macro:
#if PERL_VERSION <= 9
becomes
#if PERL_VERSION_LE(5,9,'*')
bool PERL_VERSION_EQ(const U8 major, const U8 minor,
const U8 patch)
bool PERL_VERSION_GE(const U8 major, const U8 minor,
const U8 patch)
bool PERL_VERSION_GT(const U8 major, const U8 minor,
const U8 patch)
bool PERL_VERSION_LE(const U8 major, const U8 minor,
const U8 patch)
bool PERL_VERSION_LT(const U8 major, const U8 minor,
const U8 patch)
bool PERL_VERSION_NE(const U8 major, const U8 minor,
const U8 patch)
const char * prescan_version( const char *s,
bool strict,
const char **errstr,
bool *sqv,
int *ssaw_decimal,
int *swidth,
bool *salpha)
const char * Perl_prescan_version(pTHX_ const char *s,
bool strict,
const char **errstr,
bool *sqv,
int *ssaw_decimal,
int *swidth,
bool *salpha)
Function must be called with an already existing SV like
sv = newSV(0);
s = scan_version(s, SV *sv, bool qv);
Performs some preprocessing to the string to ensure that it has the correct characteristics of a version. Flags the object if it contains an underscore (which denotes this is an alpha version). The boolean qv denotes that the version should be interpreted as if it had multiple decimals, even if it doesn't.
const char * scan_version( const char *s, SV *rv,
bool qv)
const char * Perl_scan_version(pTHX_ const char *s, SV *rv,
bool qv)
SV *sv = upg_version(SV *sv, bool qv);
Returns a pointer to the upgraded SV. Set the boolean qv if you want to force this SV to be interpreted as an "extended" version.
SV * upg_version( SV *ver, bool qv) SV * Perl_upg_version(pTHX_ SV *ver, bool qv)
int vcmp( SV *lhv, SV *rhv) int Perl_vcmp(pTHX_ SV *lhv, SV *rhv)
sv = vnormal(rv);
NOTE: you can pass either the object directly or the SV contained within the RV.
The SV returned has a refcount of 1.
SV * vnormal( SV *vs) SV * Perl_vnormal(pTHX_ SV *vs)
sv = vnumify(rv);
NOTE: you can pass either the object directly or the SV contained within the RV.
The SV returned has a refcount of 1.
SV * vnumify( SV *vs) SV * Perl_vnumify(pTHX_ SV *vs)
The SV returned has a refcount of 1.
SV * vstringify( SV *vs) SV * Perl_vstringify(pTHX_ SV *vs)
SV *hv = vverify(sv);
Note that it only confirms the bare minimum structure (so as not to get confused by derived classes which may contain additional hash entries):
SV * vverify( SV *vs) SV * Perl_vverify(pTHX_ SV *vs)
In all these calls, the "U32 wn" parameters are warning category constants. You can see the ones currently available in "Category Hierarchy" in warnings, just capitalize all letters in the names and prefix them by "WARN_". So, for example, the category "void" used in a perl program becomes "WARN_VOID" when used in XS code and passed to one of the calls below.
"err" must be one of the "packWARN", "packWARN2", "packWARN3", "packWARN4" macros populated with the appropriate number of warning categories.
The two forms differ only in that "ck_warner_d" should be used if warnings for any of the categories are by default enabled.
void Perl_ck_warner (pTHX_ U32 err, const char *pat, ...) void Perl_ck_warner_d(pTHX_ U32 err, const char *pat, ...)
Should any of the categories by default be enabled even if not within the scope of "use warnings", instead use the "ckWARN_d" macros.
The categories must be completely independent, one may not be subclassed from the other.
bool ckWARN (U32 w) bool ckWARN2(U32 w1, U32 w2) bool ckWARN3(U32 w1, U32 w2, U32 w3) bool ckWARN4(U32 w1, U32 w2, U32 w3, U32 w4)
bool ckWARN_d (U32 w) bool ckWARN2_d(U32 w1, U32 w2) bool ckWARN3_d(U32 w1, U32 w2, U32 w3) bool ckWARN4_d(U32 w1, U32 w2, U32 w3, U32 w4)
This replaces any read-only SV with a fresh SV and removes any magic.
void CLEAR_ERRSV()
They take a sprintf-style format pattern and argument list, which are used to generate a string message. If the message does not end with a newline, then it will be extended with some indication of the current location in the code, as described for "mess_sv".
The error message will be used as an exception, by default returning control to the nearest enclosing "eval", but subject to modification by a $SIG{__DIE__} handler. In any case, these croak functions never return 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 an error 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 use the "croak_sv" function, which does not involve clobbering "ERRSV".
The two forms differ only in that "croak_nocontext" does not take a thread context ("aTHX") parameter. It is usually preferred as it takes up fewer bytes of code than plain "Perl_croak", and time is rarely a critical resource when you are about to throw an exception.
void Perl_croak (pTHX_ const char *pat, ...) void croak_nocontext( const char *pat, ...) void Perl_croak_nocontext( const char *pat, ...)
Less code used on exception code paths reduces CPU cache pressure.
void croak_no_modify() void Perl_croak_no_modify()
"baseex" is the error message or object. If it is a reference, it will be used as-is. Otherwise it is used as a string, and if it does not end with a newline then it will be extended with some indication of the current location in the code, as described for "mess_sv".
The error message or object will be used as an exception, by default returning control to the nearest enclosing "eval", but subject to modification by a $SIG{__DIE__} handler. In any case, the "croak_sv" function never returns normally.
To die with a simple string message, the "croak" function may be more convenient.
void croak_sv( SV *baseex) void Perl_croak_sv(pTHX_ SV *baseex)
The two forms differ only in that "die_nocontext" does not take a thread context ("aTHX") parameter, so is used in situations where the caller doesn't already have the thread context.
OP * Perl_die (pTHX_ const char *pat, ...) OP * die_nocontext( const char *pat, ...) OP * Perl_die_nocontext( const char *pat, ...)
OP * die_sv( SV *baseex) OP * Perl_die_sv(pTHX_ SV *baseex)
SV * ERRSV
If called when there are pending compilation errors this function may return.
This is currently used to generate "used only once" fatal warnings since the COP where the name being reported is no longer the current COP when the warning is generated and may be useful for similar cases.
"err" must be one of the "packWARN", "packWARN2", "packWARN3", "packWARN4" macros populated with the appropriate number of warning categories.
void Perl_fatal_warner(pTHX_ U32 err, const char *pat, ...)
U32 packWARN (U32 w1) U32 packWARN2(U32 w1, U32 w2) U32 packWARN3(U32 w1, U32 w2, U32 w3) U32 packWARN4(U32 w1, U32 w2, U32 w3, U32 w4)
This replaces any read-only SV with a fresh writable copy and removes any magic.
void SANE_ERRSV()
void sv_regex_global_pos_clear( SV *sv) void Perl_sv_regex_global_pos_clear(pTHX_ SV *sv)
If flags is zero, the return value will count in units of characters. If the "SV_POSBYTES" flag is present, this will count instead in units of bytes, which may be different if the SV has the "SvUTF8" flag set.
bool sv_regex_global_pos_get( SV *sv, STRLEN *posp,
U32 flags)
bool Perl_sv_regex_global_pos_get(pTHX_ SV *sv, STRLEN *posp,
U32 flags)
If flags is zero, "pos" will count in units of characters. If the "SV_POSBYTES" flag is present, this will count instead in units of bytes, which may be different if the SV has the "SvUTF8" flag set. In that case, it will be the caller's responsibility to ensure that "pos" only lands on the boundary between characters, and not in the middle of a multi-byte character.
void sv_regex_global_pos_set( SV *sv, STRLEN pos,
U32 flags)
void Perl_sv_regex_global_pos_set(pTHX_ SV *sv, STRLEN pos,
U32 flags)
If a pointer is returned to the caller, it will point to memory owned by the SV itself. The caller is not responsible for freeing it after this call, though it will not remain valid for longer than the lifetime of the SV itself. The caller should take a copy of it if it needs to be accessed after this time.
const char * sv_vstring_get( SV * const sv,
STRLEN *lenp)
const char * Perl_sv_vstring_get(pTHX_ SV * const sv,
STRLEN *lenp)
"pat" and "args" are a sprintf-style format pattern and encapsulated argument list. These are used to generate a string message. If the message does not end with a newline, then it will be extended with some indication of the current location in the code, as described for "mess_sv".
The error message will be used as an exception, by default returning control to the nearest enclosing "eval", but subject to modification by a $SIG{__DIE__} handler. In any case, the "croak" function 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 an error 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 use the "croak_sv" function, which does not involve clobbering "ERRSV".
void vcroak( const char *pat, va_list *args) void Perl_vcroak(pTHX_ const char *pat, va_list *args)
void vfatal_warner( U32 err, const char *pat,
va_list *args)
void Perl_vfatal_warner(pTHX_ U32 err, const char *pat,
va_list *args)
This is like "warn", but "args" are an encapsulated argument list.
Unlike with "vcroak", "pat" is not permitted to be null.
void vwarn( const char *pat, va_list *args) void Perl_vwarn(pTHX_ const char *pat, va_list *args)
void vwarner( U32 err, const char *pat, va_list *args) void Perl_vwarner(pTHX_ U32 err, const char *pat, va_list *args)
They take a sprintf-style format pattern and argument list, which are used to generate a string message. If the message does not end with a newline, then it will be extended with some indication of the 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.
Unlike with "croak", "pat" is not permitted to be null.
The two forms differ only in that "warn_nocontext" does not take a thread context ("aTHX") parameter, so is used in situations where the caller doesn't already have the thread context.
void Perl_warn (pTHX_ const char *pat, ...) void warn_nocontext( const char *pat, ...) void Perl_warn_nocontext( const char *pat, ...)
"baseex" is the error message or object. If it is a reference, it will be used as-is. Otherwise it is used as a string, and if it does not end with a newline then it will be extended with some indication of the 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 be more convenient.
void warn_sv( SV *baseex) void Perl_warn_sv(pTHX_ SV *baseex)
"err" must be one of the "packWARN", "packWARN2", "packWARN3", "packWARN4" macros populated with the appropriate number of warning categories. If any of the warning categories they specify is fatal, a fatal exception is thrown.
In any event a message is generated by the pattern and arguments. If the message does not end with a newline, then it will be extended with some indication of the 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.
"pat" is not permitted to be null.
The two forms differ only in that "warner_nocontext" does not take a thread context ("aTHX") parameter, so is used in situations where the caller doesn't already have the thread context.
These functions differ from the similarly named "warn" functions, in that the latter are for XS code to unconditionally display a warning, whereas these are for code that may be compiling a perl program, and does extra checking to see if the warning should be fatal.
void Perl_warner (pTHX_ U32 err, const char *pat, ...) void warner_nocontext( U32 err, const char *pat, ...) void Perl_warner_nocontext( U32 err, const char *pat, ...)
xsubpp compiles XS code into C. See "xsubpp" in perlutil.
Stack_off_t ax
char* CLASS
dAX;
dAXMARK;
dITEMS;
dMY_CXT_SV;
dUNDERBAR;
dXSARGS;
dXSI32;
Stack_off_t items
I32 ix
type RETVAL
SV* ST(int ix)
type THIS
The following functions have been flagged as part of the public API, but are currently undocumented. Use them at your own risk, as the interfaces are subject to change. Functions that are not listed in this document are not intended for public use, and should NOT be used under any circumstances.
If you feel you need to use one of these functions, first send email to perl5-porters@perl.org <mailto:perl5-porters@perl.org>. It may be that there is a good reason for the function not being documented, and it should be removed from this list; or it may just be that no one has gotten around to documenting it. In the latter case, you will be asked to submit a patch to document the function. Once your patch is accepted, it will indicate that the interface is stable (unless it is explicitly marked otherwise) and usable by you.
clone_params_del clone_params_new do_open do_openn sv_dup sv_dup_inc
Next are the API-flagged elements that are considered experimental. Using one of these is even more risky than plain undocumented ones. They are listed here because they should be listed somewhere (so their existence doesn't get lost) and this is the best place for them.
apply_attrs_string hv_store_flags thread_locale_init gv_fetchmethod_pv_flags leave_adjust_stacks thread_locale_term gv_fetchmethod_pvn_flags newXS_flags gv_fetchmethod_sv_flags savetmps
Finally are deprecated undocumented API elements. Do not use any for new code; remove all occurrences of all of these from existing code.
There are currently no items of this type
Until May 1997, this document was maintained by Jeff Okamoto <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.
With lots of help and suggestions from Dean Roehrich, Malcolm Beattie, Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer, Stephen McCamant, and Gurusamy Sarathy.
API Listing originally by Dean Roehrich <roehrich@cray.com>.
Updated to be autogenerated from comments in the source by Benjamin Stuhl.
config.h, perlapio, perlcall, perlclib, perlembed, perlfilter, perlguts, perlhacktips, perlintern, perlinterp, perliol, perlmroapi, perlreapi, perlreguts, perlxs
| 2026-04-17 | perl v5.42.2 |