-*- buffer-read-only: t -*- !!!!!!! DO NOT EDIT THIS FILE !!!!!!! This file is built by autodoc.pl extracting documentation from the C source files. Any changes made here will be lost! =encoding UTF-8 =head1 NAME perlapi - autogenerated documentation for the perl public API =head1 DESCRIPTION X X X This file contains most of the documentation of the perl public API, as generated by F. Specifically, it is a listing of functions, macros, flags, and variables that may be used by extension writers. Besides L and F, some items are listed here as being actually documented in another pod. L 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. But if all have the same signature (arguments and return type) except for their names, only the usage for the base form is shown. If any one of the forms has a different signature (such as returning C or not) every function's signature is explicitly displayed. 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 F is to be avoided when writing extensions. In Perl, unlike C, a string of characters may generally contain embedded C 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 C prefix. Again, those not listed here are not to be used by extension writers, and can 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, L.) 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 L). 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 C (and variants of that name, including in function names), it also (essentially transparently) means C. 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 L. The sections in this document currently are =over =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =item L =back The listing below is alphabetical, case insensitive. =head1 AV Handling =over 4 =item C Described in L. =back =for hackers Found in file pod/perlguts.pod =over 4 =item C X Returns a pointer to the AV's internal SV* array. This is useful for doing pointer arithmetic on the array. If all you need is to look up an array element, then prefer C. =over 3 SV** AvARRAY(AV* av) =back =back =for hackers Found in file av.h =over 4 =item C X Frees all the elements of an array, leaving it empty. The XS equivalent of C<@array = ()>. See also L. 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. =over 3 void av_clear(AV *av) =back =back =for hackers Found in file av.c =over 4 =item C X Returns the number of elements in the array C. This is the true length of the array, including any undefined elements. It is always the same as S>. =over 3 Size_t av_count(AV *av) =back =back =for hackers Found in file inline.h =over 4 =item C X Push an SV onto the end of the array, creating the array if necessary. A small internal helper function to remove a commonly duplicated idiom. NOTE: C must be explicitly called as C with an C parameter. =over 3 void Perl_av_create_and_push(pTHX_ AV **const avp, SV *const val) =back =back =for hackers Found in file av.c =over 4 =item C X Unshifts an SV onto the beginning of the array, creating the array if necessary. A small internal helper function to remove a commonly duplicated idiom. NOTE: C must be explicitly called as C with an C parameter. =over 3 SV** Perl_av_create_and_unshift_one(pTHX_ AV **const avp, SV *const val) =back =back =for hackers Found in file av.c =over 4 =item C X Deletes the element indexed by C from the array, makes the element mortal, and returns it. If C equals C, the element is freed and NULL is returned. NULL is also returned if C is out of range. Perl equivalent: S> (with the C in void context if C is present). =over 3 SV* av_delete(AV *av, SSize_t key, I32 flags) =back =back =for hackers Found in file av.c =over 4 =item C X Returns true if the element indexed by C has been initialized. This relies on the fact that uninitialized array elements are set to C. Perl equivalent: C. =over 3 bool av_exists(AV *av, SSize_t key) =back =back =for hackers Found in file av.c =over 4 =item C X Pre-extend an array so that it is capable of storing values at indexes C<0..key>. Thus C guarantees that the array can store 100 elements, i.e. that C through C on a plain array will work without any further memory allocation. If the av argument is a tied array then will call the C tied array method with an argument of C<(key+1)>. =over 3 void av_extend(AV *av, SSize_t key) =back =back =for hackers Found in file av.c =over 4 =item C X Returns the SV at the specified index in the array. The C is the index. If lval is true, you are guaranteed to get a real SV back (in case it wasn't real before), which you can then modify. Check that the return value is non-null before dereferencing it to a C. See L for more information on how to use this function on tied arrays. The rough perl equivalent is C<$myarray[$key]>. =over 3 SV** av_fetch(AV *av, SSize_t key, I32 lval) =back =back =for hackers Found in file av.c =over 4 =item C X Same as C> or C>. =over 3 SSize_t AvFILL(AV* av) =back =back =for hackers Found in file av.h =over 4 =item C X Set the highest index in the array to the given number, equivalent to Perl's S>. The number of elements in the array will be S> after C 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. S> is the same as C. =over 3 void av_fill(AV *av, SSize_t fill) =back =back =for hackers Found in file av.c =over 4 =item C X Same as L. Note that, unlike what the name implies, it returns the maximum index in the array. This is unlike L, which returns what you would expect. B>>. =over 3 SSize_t av_len(AV *av) =back =back =for hackers Found in file av.c =over 4 =item C X Creates a new AV and populates it with a list of SVs. The SVs are copied into the array, so they may be freed after the call to C. The new AV will have a reference count of 1. Perl equivalent: C =over 3 AV* av_make(SSize_t size, SV **strp) =back =back =for hackers Found in file av.c =over 4 =item C X Creates a new AV and allocates its SV* array. This is similar to but more efficient than doing: AV *av = newAV(); av_extend(av, key); The size parameter is used to pre-allocate a SV* array large enough to hold at least elements 0..(size-1). size must be at least 1. The zeroflag parameter controls whether the array is NULL initialized. =over 3 AV* av_new_alloc(SSize_t size, bool zeroflag) =back =back =for hackers Found in file av.c =over 4 =item C X Removes one SV from the end of the array, reducing its size by one and returning the SV (transferring control of one reference count) to the caller. Returns C<&PL_sv_undef> if the array is empty. Perl equivalent: C =over 3 SV* av_pop(AV *av) =back =back =for hackers Found in file av.c =over 4 =item C X Pushes an SV (transferring control of one reference count) onto the end of the array. The array will grow automatically to accommodate the addition. Perl equivalent: C. =over 3 void av_push(AV *av, SV *val) =back =back =for hackers Found in file av.c =over 4 =item C X Removes one SV from the start of the array, reducing its size by one and returning the SV (transferring control of one reference count) to the caller. Returns C<&PL_sv_undef> if the array is empty. Perl equivalent: C =over 3 SV* av_shift(AV *av) =back =back =for hackers Found in file av.c =over 4 =item C X Stores an SV in an array. The array index is specified as C. The return value will be C if the operation failed or if the value did not need to be actually stored within the array (as in the case of tied arrays). Otherwise, it can be dereferenced to get the C that was stored there (= C)). Note that the caller is responsible for suitably incrementing the reference count of C before the call, and decrementing it if the function returned C. Approximate Perl equivalent: C. See L for more information on how to use this function on tied arrays. =over 3 SV** av_store(AV *av, SSize_t key, SV *val) =back =back =for hackers Found in file av.c =over 4 =item C =item C XX These behave identically. If the array C is empty, these return -1; otherwise they return the maximum value of the indices of all the array elements which are currently defined in C. They process 'get' magic. The Perl equivalent for these is C<$#av>. Use C> to get the number of elements in an array. =over 3 SSize_t av_tindex(AV *av) =back =back =for hackers Found in file av.c =over 4 =item C X Undefines the array. The XS equivalent of C. As well as freeing all the elements of the array (like C), this also frees the memory used by the av to store its list of scalars. See L for a note about the array possibly being invalid on return. =over 3 void av_undef(AV *av) =back =back =for hackers Found in file av.c =over 4 =item C X Unshift the given number of C values onto the beginning of the array. The array will grow automatically to accommodate the addition. Perl equivalent: S> =over 3 void av_unshift(AV *av, SSize_t num) =back =back =for hackers Found in file av.c =over 4 =item C X Returns the AV of the specified Perl global or package array with the given name (so it won't work on lexical variables). C are passed to C. If C is set and the Perl variable does not exist then it will be created. If C is zero and the variable does not exist then NULL is returned. Perl equivalent: C<@{"$name"}>. NOTE: the C form is B. =over 3 AV* get_av(const char *name, I32 flags) =back =back =for hackers Found in file perl.c =over 4 =item C =item C =item C XXX These all create a new AV, setting the reference count to 1. They differ in the allocation and population of the array of SV*s that always accompanies a non-empty AV. The Perl equivalent is approximately C. newAV does not allocate a SV* array. AV *av = newAV(); This is very useful when an AV is required, but populating it may be deferred, or even never actually take place. (Memory is not allocated unnecessarily.) Subsequent SV* array allocation would be performed via C>. This might be called directly: av_extend(av, key); Or it might be called implicitly when the first element is stored: (void)av_store(av, 0, sv); Unused array elements are typically initialized by C. (Only core maintainers should have need to concern themseleves with when that is not the case. Refer to F and F for the differences between real and fake AVs.) In contrast, when an AV is created for immediate population with a known (or likely) number of elements, it is more efficient to immediately allocate a SV* array of the necessary size. (This avoids inefficient use of C and the potential for the first allocation being too small and then having to resize it.) For that scenario, newAV_alloc_x and newAV_alloc_xz can be used to create an AV and allocate a SV* array to fit the specified number of elements. (As a result, these macros MUST NOT be called with a size less than 1.) newAV_alloc_x does not initialize the array elements - and so the expectation is that all will be initialized elsewhere prior to any potentials reads. newAV_alloc_xz does initialize the array elements. The following examples all result in an array that can fit four elements (indexes 0 .. 3): AV *av = newAV(); av_extend(av, 1); AV *av = newAV(); av_extend(av, 3); AV *av = newAV_alloc_xz(4); AV *av = newAV_alloc_x(4); In the newAV_alloc_x case, the array elements will not be initialized and their contents are therefore undefined. In the other cases, the array elements are all initialized. In contrast, the following examples allocate an SV* array that is only guaranteed to fit one element: AV *av = newAV_alloc_x(1); AV *av = newAV_alloc_xz(1); =over 3 AV* newAV () AV* newAV_alloc_x (SSize_t size) AV* newAV_alloc_xz(SSize_t size) =back =back =for hackers Found in file av.h =over 4 =item C X C> It is planned to remove C from a future release of Perl. Do not use it for new code; remove it from existing code. Null AV pointer. (deprecated - use C<(AV *)NULL> instead) =back =for hackers Found in file av.h =head1 Callback Functions =over 4 =item C X Performs a callback to the specified named and package-scoped Perl subroutine with C (a C-terminated array of strings) as arguments. See L. Approximate Perl equivalent: C<&{"$sub_name"}(@$argv)>. NOTE: the C form is B. =over 3 I32 call_argv(const char* sub_name, I32 flags, char** argv) =back =back =for hackers Found in file perl.c =over 4 =item C X Performs a callback to the specified Perl method. The blessed object must be on the stack. See L. NOTE: the C form is B. =over 3 I32 call_method(const char* methname, I32 flags) =back =back =for hackers Found in file perl.c =over 4 =item C X Performs a callback to the specified Perl sub. See L. NOTE: the C form is B. =over 3 I32 call_pv(const char* sub_name, I32 flags) =back =back =for hackers Found in file perl.c =over 4 =item C X Performs a callback to the Perl sub specified by the SV. If neither the C nor C flag is supplied, the SV may be any of a CV, a GV, a reference to a CV, a reference to a GV or C will be used as the name of the sub to call. If the C flag is supplied, the SV may be a reference to a CV or C will be used as the name of the method to call. If the C flag is supplied, C 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 L. NOTE: the C form is B. =over 3 I32 call_sv(SV* sv, volatile I32 flags) =back =back =for hackers Found in file perl.c =over 4 =item C X Opening bracket on a callback. See C> and L. =over 3 ENTER; =back =back =for hackers Found in file scope.h =over 4 =item C X Same as C>, but when debugging is enabled it also associates the given literal string with the new scope. =over 3 ENTER_with_name("name"); =back =back =for hackers Found in file scope.h =over 4 =item C X Tells Perl to C the given string in scalar context and return an SV* result. NOTE: the C form is B. =over 3 SV* eval_pv(const char* p, I32 croak_on_error) =back =back =for hackers Found in file perl.c =over 4 =item C X Tells Perl to C the string in the SV. It supports the same flags as C, with the obvious exception of C. See L. The C flag can be used if you only need eval_sv() to execute code specified by a string, but not catch any errors. NOTE: the C form is B. =over 3 I32 eval_sv(SV* sv, I32 flags) =back =back =for hackers Found in file perl.c =over 4 =item C X Closing bracket for temporaries on a callback. See C> and L. =over 3 FREETMPS; =back =back =for hackers Found in file scope.h =over 4 =item C Described in L. =back =for hackers Found in file pod/perlcall.pod =over 4 =item C Described in L. =back =for hackers Found in file pod/perlcall.pod =over 4 =item C X C> It is planned to remove C from a future release of Perl. Do not use it for new code; remove it from existing code. A backward-compatible version of C which can only return C or C; in a void context, it returns C. Deprecated. Use C instead. =over 3 U32 GIMME =back =back =for hackers Found in file op.h =over 4 =item C X The XSUB-writer's equivalent to Perl's C. Returns C, C or C for void, scalar or list context, respectively. See L for a usage example. =over 3 U32 GIMME_V =back =back =for hackers Found in file op.h =over 4 =item C Described in L. =back =for hackers Found in file pod/perlcall.pod =over 4 =item C Described in L. =back =for hackers Found in file pod/perlcall.pod =over 4 =item C Described in L. =back =for hackers Found in file pod/perlcall.pod =over 4 =item C Described in L. =back =for hackers Found in file pod/perlcall.pod =over 4 =item C Described in L. =back =for hackers Found in file pod/perlcall.pod =over 4 =item C X Closing bracket on a callback. See C> and L. =over 3 LEAVE; =back =back =for hackers Found in file scope.h =over 4 =item C X Same as C>, but when debugging is enabled it first checks that the scope has the given name. C must be a literal string. =over 3 LEAVE_with_name("name"); =back =back =for hackers Found in file scope.h =over 4 =item C Described in L. =back =for hackers Found in file pod/perlcall.pod =over 4 =item C X Opening bracket for temporaries on a callback. See C> and L. =over 3 SAVETMPS; =back =back =for hackers Found in file scope.h =head1 Casting =over 4 =item C X Cast-to-bool. When Perl was able to be compiled on pre-C99 compilers, a C<(bool)> cast didn't necessarily do the right thing, so this macro was created (and made somewhat complicated to work around bugs in old compilers). Now, many years later, and C99 is used, this is no longer required, but is kept for backwards compatibility. =over 3 bool cBOOL(bool expr) =back =back =for hackers Found in file handy.h =over 4 =item C X Cast an NV to I32 while avoiding undefined C behavior =over 3 I32 I_32(NV what) =back =back =for hackers Found in file perl.h =over 4 =item C Described in L. =over 3 type INT2PTR(type, int value) =back =back =for hackers Found in file pod/perlguts.pod =over 4 =item C X Cast an NV to IV while avoiding undefined C behavior =over 3 IV I_V(NV what) =back =back =for hackers Found in file perl.h =over 4 =item C Described in L. =back =for hackers Found in file pod/perlguts.pod =over 4 =item C Described in L. =over 3 IV PTR2IV(void * ptr) =back =back =for hackers Found in file pod/perlguts.pod =over 4 =item C Described in L. =over 3 IV PTR2nat(void *) =back =back =for hackers Found in file pod/perlguts.pod =over 4 =item C Described in L. =over 3 NV PTR2NV(void * ptr) =back =back =for hackers Found in file pod/perlguts.pod =over 4 =item C Described in L. =over 3 unsigned long PTR2ul(void *) =back =back =for hackers Found in file pod/perlguts.pod =over 4 =item C Described in L. =over 3 UV PTR2UV(void * ptr) =back =back =for hackers Found in file pod/perlguts.pod =over 4 =item C Described in L. =back =for hackers Found in file pod/perlguts.pod =over 4 =item C X Cast an NV to U32 while avoiding undefined C behavior =over 3 U32 U_32(NV what) =back =back =for hackers Found in file perl.h =over 4 =item C X Cast an NV to UV while avoiding undefined C behavior =over 3 UV U_V(NV what) =back =back =for hackers Found in file perl.h =over 4 =item C Described in L. =back =for hackers Found in file pod/perlguts.pod =head1 Character case changing 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 C> (LATIN SMALL LETTER SHARP S) is the two character sequence C. This presents some complications The lowercase of all characters in the range 0..255 is a single character, and thus C> is furnished. But, C can't exist, as it couldn't return a valid result for all legal inputs. Instead C> 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. =over 4 =item C =item C =item C =item C =item C XXXXX These all return the foldcase of a character. "foldcase" is an internal case for C pattern matching. If the foldcase of character A and the foldcase of character B are the same, they match caselessly; otherwise they don't. 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 C 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 S>. C and C 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 C nor C as the foldcase of some code points in the 0..255 range is above that range or consists of multiple characters. Instead use C. C returns the foldcase of any Unicode code point. The return value is identical to that of C 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 C, and its length in bytes into C<*lenp>. The caller must have made C large enough to contain at least C 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 C. 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 } C and C are synonyms of each other. The only difference between these and C 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 C

, with C pointing to one byte beyond its end. The C

buffer may certainly contain more than one code point; but only the first one (up through S>) 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. =over 3 UV toFOLD (UV cp) UV toFOLD_A (UV cp) UV toFOLD_uvchr (UV cp, U8* s, STRLEN* lenp) UV toFOLD_utf8 (U8* p, U8* e, U8* s, STRLEN* lenp) UV toFOLD_utf8_safe(U8* p, U8* e, U8* s, STRLEN* lenp) =back =back =for hackers Found in file handy.h =over 4 =item C =item C =item C =item C =item C =item C =item C =item C XXXXXXXX These all return the lowercase of a character. The differences are what domain they operate on, and whether the input is specified as a code point (those forms with a C 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 S>. C and C 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. C and C are synonyms of each other. They behave identically as C 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). C 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. C returns the lowercase of any Unicode code point. The return value is identical to that of C 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 C, and its length in bytes into C<*lenp>. The caller must have made C large enough to contain at least C 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 C. 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 } C and C are synonyms of each other. The only difference between these and C 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 C

, with C pointing to one byte beyond its end. The C

buffer may certainly contain more than one code point; but only the first one (up through S>) 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. =over 3 UV toLOWER (UV cp) UV toLOWER_A (UV cp) UV toLOWER_L1 (UV cp) UV toLOWER_LATIN1 (UV cp) UV toLOWER_LC (UV cp) UV toLOWER_uvchr (UV cp, U8* s, STRLEN* lenp) UV toLOWER_utf8 (U8* p, U8* e, U8* s, STRLEN* lenp) UV toLOWER_utf8_safe(U8* p, U8* e, U8* s, STRLEN* lenp) =back =back =for hackers Found in file handy.h =over 4 =item C =item C =item C =item C =item C XXXXX These all return the titlecase of a character. The differences are what domain they operate on, and whether the input is specified as a code point (those forms with a C 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 S>. C and C 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 C nor C as the titlecase of some code points in the 0..255 range is above that range or consists of multiple characters. Instead use C. C returns the titlecase of any Unicode code point. The return value is identical to that of C 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 C, and its length in bytes into C<*lenp>. The caller must have made C large enough to contain at least C 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 C. 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 } C and C are synonyms of each other. The only difference between these and C 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 C

, with C pointing to one byte beyond its end. The C

buffer may certainly contain more than one code point; but only the first one (up through S>) 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. =over 3 UV toTITLE (UV cp) UV toTITLE_A (UV cp) UV toTITLE_uvchr (UV cp, U8* s, STRLEN* lenp) UV toTITLE_utf8 (U8* p, U8* e, U8* s, STRLEN* lenp) UV toTITLE_utf8_safe(U8* p, U8* e, U8* s, STRLEN* lenp) =back =back =for hackers Found in file handy.h =over 4 =item C =item C =item C =item C =item C XXXXX These all return the uppercase of a character. The differences are what domain they operate on, and whether the input is specified as a code point (those forms with a C 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 S>. C and C 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 C nor C as the uppercase of some code points in the 0..255 range is above that range or consists of multiple characters. Instead use C. C returns the uppercase of any Unicode code point. The return value is identical to that of C 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 C, and its length in bytes into C<*lenp>. The caller must have made C large enough to contain at least C 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 C. 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 } C and C are synonyms of each other. The only difference between these and C 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 C

, with C pointing to one byte beyond its end. The C

buffer may certainly contain more than one code point; but only the first one (up through S>) 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. =over 3 UV toUPPER (UV cp) UV toUPPER_A (UV cp) UV toUPPER_uvchr (UV cp, U8* s, STRLEN* lenp) UV toUPPER_utf8 (U8* p, U8* e, U8* s, STRLEN* lenp) UV toUPPER_utf8_safe(U8* p, U8* e, U8* s, STRLEN* lenp) =back =back =for hackers Found in file handy.h =head1 Character classification 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 L.) 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 C, and only the ones with C in the name are affected by the current locale. The base function, e.g., C, 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 C_A> (e.g., C) is identical to the base function with no suffix C<"_A">. This variant is used to emphasize by its name that only ASCII-range characters can return TRUE. Variant C_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, C 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 C_uvchr> is exactly like the C_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, C returns TRUE, since 0x100 is LATIN CAPITAL LETTER A WITH MACRON in Unicode, and is a word character. Variants C_utf8> and C_utf8_safe> are like C_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 C

. The second parameter, C, 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 C<_safe> in one name emphasizes that it will not attempt to read beyond S>, provided that the constraint S e>> is true (this is asserted for in C<-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 C_LC> is like the C_A> and C_L1> variants, but the result is based on the current locale, which is what C 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, C when not in a UTF-8 locale returns the result of calling C. 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 C_LC_uvchr> acts exactly like C_LC> for inputs less than 256, but for larger ones it returns the Unicode classification of the code point. Variants C_LC_utf8> and C_LC_utf8_safe> are like C_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 C

. The second parameter, C, 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 C<_safe> in one name emphasizes that it will not attempt to read beyond S>, provided that the constraint S e>> is true (this is asserted for in C<-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. =over 4 =item C =item C =item C =item C =item C =item C =item C =item C =item C XXXXXXXXX Returns a boolean indicating whether the specified input is one of C<[A-Za-z]>, analogous to C. See the L for an explanation of the variants. =over 3 bool isALPHA (UV ch) bool isALPHA_A (UV ch) bool isALPHA_L1 (UV ch) bool isALPHA_uvchr (UV ch) bool isALPHA_utf8_safe (U8 * s, U8 * end) bool isALPHA_utf8 (U8 * s, U8 * end) bool isALPHA_LC (UV ch) bool isALPHA_LC_uvchr (UV ch) bool isALPHA_LC_utf8_safe(U8 * s, U8 *end) =back =back =for hackers Found in file handy.h =over 4 =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C XXXXXXXXXXXXXX Returns a boolean indicating whether the specified character is one of C<[A-Za-z0-9]>, analogous to C. See the L for an explanation of the variants. A (discouraged from use) synonym is C (where the C suffix means this corresponds to the C language alphanumeric definition). Also there are the variants C, C C, and C. =over 3 bool isALPHANUMERIC (UV ch) bool isALPHANUMERIC_A (UV ch) bool isALPHANUMERIC_L1 (UV ch) bool isALPHANUMERIC_uvchr (UV ch) bool isALPHANUMERIC_utf8_safe (U8 * s, U8 * end) bool isALPHANUMERIC_utf8 (U8 * s, U8 * end) bool isALPHANUMERIC_LC (UV ch) bool isALPHANUMERIC_LC_uvchr (UV ch) bool isALPHANUMERIC_LC_utf8_safe(U8 * s, U8 *end) bool isALNUMC (UV ch) bool isALNUMC_A (UV ch) bool isALNUMC_L1 (UV ch) bool isALNUMC_LC (UV ch) bool isALNUMC_LC_uvchr (UV ch) =back =back =for hackers Found in file handy.h =over 4 =item C =item C =item C =item C =item C =item C =item C =item C =item C XXXXXXXXX Returns a boolean indicating whether the specified character is one of the 128 characters in the ASCII character set, analogous to C. On non-ASCII platforms, it returns TRUE iff this character corresponds to an ASCII character. Variants C and C are identical to C. See the L for an explanation of the variants. Note, however, that some platforms do not have the C library routine C. In these cases, the variants whose names contain C are the same as the corresponding ones without. 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), C will give the correct results when called with any byte in any string encoded or not in UTF-8. And similarly C and C will work properly on any string encoded or not in UTF-8. =over 3 bool isASCII (UV ch) bool isASCII_A (UV ch) bool isASCII_L1 (UV ch) bool isASCII_uvchr (UV ch) bool isASCII_utf8_safe (U8 * s, U8 * end) bool isASCII_utf8 (U8 * s, U8 * end) bool isASCII_LC (UV ch) bool isASCII_LC_uvchr (UV ch) bool isASCII_LC_utf8_safe(U8 * s, U8 *end) =back =back =for hackers Found in file handy.h =over 4 =item C =item C =item C =item C =item C =item C =item C =item C =item C XXXXXXXXX Returns a boolean indicating whether the specified character is a character considered to be a blank, analogous to C. See the L for an explanation of the variants. Note, however, that some platforms do not have the C library routine C. In these cases, the variants whose names contain C are the same as the corresponding ones without. =over 3 bool isBLANK (UV ch) bool isBLANK_A (UV ch) bool isBLANK_L1 (UV ch) bool isBLANK_uvchr (UV ch) bool isBLANK_utf8_safe (U8 * s, U8 * end) bool isBLANK_utf8 (U8 * s, U8 * end) bool isBLANK_LC (UV ch) bool isBLANK_LC_uvchr (UV ch) bool isBLANK_LC_utf8_safe(U8 * s, U8 *end) =back =back =for hackers Found in file handy.h =over 4 =item C =item C =item C =item C =item C =item C =item C =item C =item C XXXXXXXXX Returns a boolean indicating whether the specified character is a control character, analogous to C. See the L for an explanation of the variants. On EBCDIC platforms, you almost always want to use the C variant. =over 3 bool isCNTRL (UV ch) bool isCNTRL_A (UV ch) bool isCNTRL_L1 (UV ch) bool isCNTRL_uvchr (UV ch) bool isCNTRL_utf8_safe (U8 * s, U8 * end) bool isCNTRL_utf8 (U8 * s, U8 * end) bool isCNTRL_LC (UV ch) bool isCNTRL_LC_uvchr (UV ch) bool isCNTRL_LC_utf8_safe(U8 * s, U8 *end) =back =back =for hackers Found in file handy.h =over 4 =item C =item C =item C =item C =item C =item C =item C =item C =item C XXXXXXXXX Returns a boolean indicating whether the specified character is a digit, analogous to C. Variants C and C are identical to C. See the L for an explanation of the variants. =over 3 bool isDIGIT (UV ch) bool isDIGIT_A (UV ch) bool isDIGIT_L1 (UV ch) bool isDIGIT_uvchr (UV ch) bool isDIGIT_utf8_safe (U8 * s, U8 * end) bool isDIGIT_utf8 (U8 * s, U8 * end) bool isDIGIT_LC (UV ch) bool isDIGIT_LC_uvchr (UV ch) bool isDIGIT_LC_utf8_safe(U8 * s, U8 *end) =back =back =for hackers Found in file handy.h =over 4 =item C =item C =item C =item C =item C =item C =item C =item C =item C XXXXXXXXX Returns a boolean indicating whether the specified character is a graphic character, analogous to C. See the L for an explanation of the variants. =over 3 bool isGRAPH (UV ch) bool isGRAPH_A (UV ch) bool isGRAPH_L1 (UV ch) bool isGRAPH_uvchr (UV ch) bool isGRAPH_utf8_safe (U8 * s, U8 * end) bool isGRAPH_utf8 (U8 * s, U8 * end) bool isGRAPH_LC (UV ch) bool isGRAPH_LC_uvchr (UV ch) bool isGRAPH_LC_utf8_safe(U8 * s, U8 *end) =back =back =for hackers Found in file handy.h =over 4 =item C =item C =item C =item C =item C =item C =item C =item C =item C XXXXXXXXX Returns a boolean indicating whether the specified character can be the second or succeeding character of an identifier. This is very close to, but not quite the same as the official Unicode property C. The difference is that this returns true only if the input character also matches L. See the L for an explanation of the variants. =over 3 bool isIDCONT (UV ch) bool isIDCONT_A (UV ch) bool isIDCONT_L1 (UV ch) bool isIDCONT_uvchr (UV ch) bool isIDCONT_utf8_safe (U8 * s, U8 * end) bool isIDCONT_utf8 (U8 * s, U8 * end) bool isIDCONT_LC (UV ch) bool isIDCONT_LC_uvchr (UV ch) bool isIDCONT_LC_utf8_safe(U8 * s, U8 *end) =back =back =for hackers Found in file handy.h =over 4 =item C =item C =item C =item C =item C =item C =item C =item C =item C XXXXXXXXX Returns a boolean indicating whether the specified character can be the first character of an identifier. This is very close to, but not quite the same as the official Unicode property C. The difference is that this returns true only if the input character also matches L. See the L for an explanation of the variants. =over 3 bool isIDFIRST (UV ch) bool isIDFIRST_A (UV ch) bool isIDFIRST_L1 (UV ch) bool isIDFIRST_uvchr (UV ch) bool isIDFIRST_utf8_safe (U8 * s, U8 * end) bool isIDFIRST_utf8 (U8 * s, U8 * end) bool isIDFIRST_LC (UV ch) bool isIDFIRST_LC_uvchr (UV ch) bool isIDFIRST_LC_utf8_safe(U8 * s, U8 *end) =back =back =for hackers Found in file handy.h =over 4 =item C =item C =item C =item C =item C =item C =item C =item C =item C XXXXXXXXX Returns a boolean indicating whether the specified character is a lowercase character, analogous to C. See the L for an explanation of the variants =over 3 bool isLOWER (UV ch) bool isLOWER_A (UV ch) bool isLOWER_L1 (UV ch) bool isLOWER_uvchr (UV ch) bool isLOWER_utf8_safe (U8 * s, U8 * end) bool isLOWER_utf8 (U8 * s, U8 * end) bool isLOWER_LC (UV ch) bool isLOWER_LC_uvchr (UV ch) bool isLOWER_LC_utf8_safe(U8 * s, U8 *end) =back =back =for hackers Found in file handy.h =over 4 =item C =item C =item C XXX Returns a boolean indicating whether the specified character is an octal digit, [0-7]. The only two variants are C and C; each is identical to C. =over 3 bool isOCTAL(UV ch) =back =back =for hackers Found in file handy.h =over 4 =item C =item C =item C =item C =item C =item C =item C =item C =item C XXXXXXXXX Returns a boolean indicating whether the specified character is a printable character, analogous to C. See the L for an explanation of the variants. =over 3 bool isPRINT (UV ch) bool isPRINT_A (UV ch) bool isPRINT_L1 (UV ch) bool isPRINT_uvchr (UV ch) bool isPRINT_utf8_safe (U8 * s, U8 * end) bool isPRINT_utf8 (U8 * s, U8 * end) bool isPRINT_LC (UV ch) bool isPRINT_LC_uvchr (UV ch) bool isPRINT_LC_utf8_safe(U8 * s, U8 *end) =back =back =for hackers Found in file handy.h =over 4 =item C =item C =item C =item C =item C =item C =item C =item C =item C XXXXXXXXX (short for Posix Space) Starting in 5.18, this is identical in all its forms to the corresponding C macros. The locale forms of this macro are identical to their corresponding C forms in all Perl releases. In releases prior to 5.18, the non-locale forms differ from their C forms only in that the C forms don't match a Vertical Tab, and the C forms do. Otherwise they are identical. Thus this macro is analogous to what C matches in a regular expression. See the L for an explanation of the variants. =over 3 bool isPSXSPC (UV ch) bool isPSXSPC_A (UV ch) bool isPSXSPC_L1 (UV ch) bool isPSXSPC_uvchr (UV ch) bool isPSXSPC_utf8_safe (U8 * s, U8 * end) bool isPSXSPC_utf8 (U8 * s, U8 * end) bool isPSXSPC_LC (UV ch) bool isPSXSPC_LC_uvchr (UV ch) bool isPSXSPC_LC_utf8_safe(U8 * s, U8 *end) =back =back =for hackers Found in file handy.h =over 4 =item C =item C =item C =item C =item C =item C =item C =item C =item C XXXXXXXXX Returns a boolean indicating whether the specified character is a punctuation character, analogous to C. Note that the definition of what is punctuation isn't as straightforward as one might desire. See L for details. See the L for an explanation of the variants. =over 3 bool isPUNCT (UV ch) bool isPUNCT_A (UV ch) bool isPUNCT_L1 (UV ch) bool isPUNCT_uvchr (UV ch) bool isPUNCT_utf8_safe (U8 * s, U8 * end) bool isPUNCT_utf8 (U8 * s, U8 * end) bool isPUNCT_LC (UV ch) bool isPUNCT_LC_uvchr (UV ch) bool isPUNCT_LC_utf8_safe(U8 * s, U8 *end) =back =back =for hackers Found in file handy.h =over 4 =item C =item C =item C =item C =item C =item C =item C =item C =item C XXXXXXXXX Returns a boolean indicating whether the specified character is a whitespace character. This is analogous to what C matches in a regular expression. Starting in Perl 5.18 this also matches what C does. Prior to 5.18, only the locale forms of this macro (the ones with C in their names) matched precisely what C does. In those releases, the only difference, in the non-locale variants, was that C did not match a vertical tab. (See L for a macro that matches a vertical tab in all releases.) See the L for an explanation of the variants. =over 3 bool isSPACE (UV ch) bool isSPACE_A (UV ch) bool isSPACE_L1 (UV ch) bool isSPACE_uvchr (UV ch) bool isSPACE_utf8_safe (U8 * s, U8 * end) bool isSPACE_utf8 (U8 * s, U8 * end) bool isSPACE_LC (UV ch) bool isSPACE_LC_uvchr (UV ch) bool isSPACE_LC_utf8_safe(U8 * s, U8 *end) =back =back =for hackers Found in file handy.h =over 4 =item C =item C =item C =item C =item C =item C =item C =item C =item C XXXXXXXXX Returns a boolean indicating whether the specified character is an uppercase character, analogous to C. See the L for an explanation of the variants. =over 3 bool isUPPER (UV ch) bool isUPPER_A (UV ch) bool isUPPER_L1 (UV ch) bool isUPPER_uvchr (UV ch) bool isUPPER_utf8_safe (U8 * s, U8 * end) bool isUPPER_utf8 (U8 * s, U8 * end) bool isUPPER_LC (UV ch) bool isUPPER_LC_uvchr (UV ch) bool isUPPER_LC_utf8_safe(U8 * s, U8 *end) =back =back =for hackers Found in file handy.h =over 4 =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C XXXXXXXXXXXXX Returns a boolean indicating whether the specified character is a character that is a word character, analogous to what C and C match in a regular expression. A word character is an alphabetic character, a decimal digit, a connecting punctuation character (such as an underscore), or a "mark" character that attaches to one of those (like some sort of accent). C is a synonym provided for backward compatibility, even though a word character includes more than the standard C language meaning of alphanumeric. See the L for an explanation of the variants. C, C, C, C, C, C, and C are also as described there, but additionally include the platform's native underscore. =over 3 bool isWORDCHAR (UV ch) bool isWORDCHAR_A (UV ch) bool isWORDCHAR_L1 (UV ch) bool isWORDCHAR_uvchr (UV ch) bool isWORDCHAR_utf8_safe (U8 * s, U8 * end) bool isWORDCHAR_utf8 (U8 * s, U8 * end) bool isWORDCHAR_LC (UV ch) bool isWORDCHAR_LC_uvchr (UV ch) bool isWORDCHAR_LC_utf8_safe(U8 * s, U8 *end) bool isALNUM (UV ch) bool isALNUM_A (UV ch) bool isALNUM_LC (UV ch) bool isALNUM_LC_uvchr (UV ch) =back =back =for hackers Found in file handy.h =over 4 =item C =item C =item C =item C =item C =item C =item C =item C =item C XXXXXXXXX Returns a boolean indicating whether the specified character is a hexadecimal digit. In the ASCII range these are C<[0-9A-Fa-f]>. Variants C and C are identical to C. See the L for an explanation of the variants. =over 3 bool isXDIGIT (UV ch) bool isXDIGIT_A (UV ch) bool isXDIGIT_L1 (UV ch) bool isXDIGIT_uvchr (UV ch) bool isXDIGIT_utf8_safe (U8 * s, U8 * end) bool isXDIGIT_utf8 (U8 * s, U8 * end) bool isXDIGIT_LC (UV ch) bool isXDIGIT_LC_uvchr (UV ch) bool isXDIGIT_LC_utf8_safe(U8 * s, U8 *end) =back =back =for hackers Found in file handy.h =head1 Compiler and Preprocessor information =over 4 =item C X This symbol is intended to be used along with C in the same manner symbol C is used with C. It contains either "-" or "". =back =for hackers Found in file config.h =over 4 =item C X This symbol contains the second part of the string which will invoke the C preprocessor on the standard input and produce to standard output. This symbol will have the value "-" if C needs a minus to specify standard input, otherwise the value is "". =back =for hackers Found in file config.h =over 4 =item C X This symbol contains the string which will invoke a C preprocessor on the standard input and produce to standard output. It needs to end with C, after all other preprocessor flags have been specified. The main difference with C is that this program will never be a pointer to a shell wrapper, i.e. it will be empty if no preprocessor is available directly to the user. Note that it may well be different from the preprocessor used to compile the C program. =back =for hackers Found in file config.h =over 4 =item C X This symbol contains the first part of the string which will invoke the C preprocessor on the standard input and produce to standard output. Typical value of "cc -E" or "F", but it can also call a wrapper. See C>. =back =for hackers Found in file config.h =over 4 =item C X Can we handle C attribute for functions that should always be inlined. =back =for hackers Found in file config.h =over 4 =item C X Can we handle C attribute for marking deprecated C =back =for hackers Found in file config.h =over 4 =item C X Can we handle C attribute for checking printf-style formats =back =for hackers Found in file config.h =over 4 =item C X Can we handle C attribute for nonnull function parms. =back =for hackers Found in file config.h =over 4 =item C X Can we handle C attribute for functions that do not return =back =for hackers Found in file config.h =over 4 =item C X Can we handle C attribute for pure functions =back =for hackers Found in file config.h =over 4 =item C X Can we handle C attribute for unused variables and arguments =back =for hackers Found in file config.h =over 4 =item C X Can we handle C attribute for warning on unused results =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the compiler supports C<__builtin_add_overflow> for adding integers with overflow checks. =back =for hackers Found in file config.h =over 4 =item C X Can we handle C builtin for compile-time ternary-like expressions =back =for hackers Found in file config.h =over 4 =item C X Can we handle C builtin for telling that certain values are more likely =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the compiler supports C<__builtin_mul_overflow> for multiplying integers with overflow checks. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the compiler supports C<__builtin_sub_overflow> for subtracting integers with overflow checks. =back =for hackers Found in file config.h =over 4 =item C X If defined, the compiler supports C99 variadic macros. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C compiler supports C99-style static inline. That is, the function can't be called from another translation unit. =back =for hackers Found in file config.h =over 4 =item C X This symbol contains the number of bytes required to align a double, or a long double when applicable. Usual values are 2, 4 and 8. The default is eight, for safety. For cross-compiling or multiarch support, Configure will set a minimum of 8. =back =for hackers Found in file config.h =over 4 =item C X This symbol gives the best-guess incantation to use for static inline functions. If C is defined, this will give C99-style inline. If C is not defined, this will give a plain 'static'. It will always be defined to something that gives static linkage. Possibilities include static inline (c99) static __inline__ (gcc -ansi) static __inline (MSVC) static _inline (older MSVC) static (c89 compilers) =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, gives a linkage specification for thread-local storage. For example, for a C11 compiler this will be C<_Thread_local>. Beware, some compilers are sensitive to the C language standard they are told to parse. For example, suncc defaults to C11, so our probe will report that C<_Thread_local> can be used. However, if the -std=c99 is later added to the compiler flags, then C<_Thread_local> will become a syntax error. Hence it is important for these flags to be consistent between probing and use. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that you must access character data through U32-aligned pointers. =back =for hackers Found in file config.h =head1 Compiler directives =over 4 =item C X C is like C, but it has a benefit in a release build. It is a hint to a compiler about a statement of fact in a function call free expression, which allows the compiler to generate better machine code. In a debug build, C is a synonym for C. C means the control path is unreachable. In a for loop, C can be used to hint that a loop will run at least X times. C is based off MSVC's C<__assume> intrinsic function, see its documents for more details. =over 3 ASSUME(bool expr) =back =back =for hackers Found in file perl.h =over 4 =item C X Declare nothing; typically used as a placeholder to replace something that used to declare something. Works on compilers that require declarations before any code. =over 3 dNOOP; =back =back =for hackers Found in file perl.h =over 4 =item C X When not compiling using C++, expands to nothing. Otherwise ends a section of code already begun by a C>. =over 3 END_EXTERN_C =back =back =for hackers Found in file perl.h =over 4 =item C X When not compiling using C++, expands to nothing. Otherwise is used in a declaration of a function to indicate the function should have external C linkage. This is required for things to work for just about all functions with external linkage compiled into perl. Often, you can use C> ... C> blocks surrounding all your code that you need to have this linkage. Example usage: EXTERN_C int flock(int fd, int op); =back =for hackers Found in file perl.h =over 4 =item C X Returns the input unchanged, but at the same time it gives a branch prediction hint to the compiler that this condition is likely to be true. =over 3 LIKELY(bool expr) =back =back =for hackers Found in file perl.h =over 4 =item C X Do nothing; typically used as a placeholder to replace something that used to do something. =over 3 NOOP; =back =back =for hackers Found in file perl.h =over 4 =item C X This is used to suppress compiler warnings that a parameter to a function is not used. This situation can arise, for example, when a parameter is needed under some configuration conditions, but not others, so that C preprocessor conditional compilation causes it be used just some times. =over 3 PERL_UNUSED_ARG(void x); =back =back =for hackers Found in file perl.h =over 4 =item C X This is used to suppress compiler warnings that the thread context parameter to a function is not used. This situation can arise, for example, when a C preprocessor conditional compilation causes it be used just some times. =over 3 PERL_UNUSED_CONTEXT; =back =back =for hackers Found in file perl.h =over 4 =item C X Tells the compiler that the parameter in the function prototype just before it is not necessarily expected to be used in the function. Not that many compilers understand this, so this should only be used in cases where C> can't conveniently be used. Example usage: =over Signal_t Perl_perly_sighandler(int sig, Siginfo_t *sip PERL_UNUSED_DECL, void *uap PERL_UNUSED_DECL, bool safe) =back =back =for hackers Found in file perl.h =over 4 =item C X This macro indicates to discard the return value of the function call inside it, I, PERL_UNUSED_RESULT(foo(a, b)) The main reason for this is that the combination of C (part of C<-Wall>) and the C<__attribute__((warn_unused_result))> cannot be silenced with casting to C. This causes trouble when the system header files use the attribute. Use C 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, I, 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 C might not be the most natural way: another possibility is that you can capture the return value and use C> on that. =over 3 PERL_UNUSED_RESULT(void x) =back =back =for hackers Found in file perl.h =over 4 =item C X This is used to suppress compiler warnings that the variable I is not used. This situation can arise, for example, when a C preprocessor conditional compilation causes it be used just some times. =over 3 PERL_UNUSED_VAR(void x); =back =back =for hackers Found in file perl.h =over 4 =item C X This C pre-processor value, if defined, indicates that it is permissible to use the GCC brace groups extension. This extension, of the form ({ statement ... }) turns the block consisting of I into an expression with a value, unlike plain C language blocks. This can present optimization possibilities, B you generally need to specify an alternative in case this ability doesn't exist or has otherwise been forbidden. Example usage: =over #ifdef PERL_USE_GCC_BRACE_GROUPS ... #else ... #endif =back =back =for hackers Found in file perl.h =over 4 =item C X When not compiling using C++, expands to nothing. Otherwise begins a section of code in which every function will effectively have C> applied to it, that is to have external C linkage. The section is ended by a C>. =over 3 START_EXTERN_C =back =back =for hackers Found in file perl.h =over 4 =item C Described in L. =back =for hackers Found in file pod/perlguts.pod =over 4 =item C =item C XX This allows a series of statements in a macro to be used as a single statement, as in if (x) STMT_START { ... } STMT_END else ... Note that you can't return a value out of them, which limits their utility. But see C>. =back =for hackers Found in file perl.h =over 4 =item C X Returns the input unchanged, but at the same time it gives a branch prediction hint to the compiler that this condition is likely to be false. =over 3 UNLIKELY(bool expr) =back =back =for hackers Found in file perl.h =over 4 =item C<__ASSERT_> X<__ASSERT_> This is a helper macro to avoid preprocessor issues, replaced by nothing unless under DEBUGGING, where it expands to an assert of its argument, followed by a comma (hence the comma operator). If we just used a straight assert(), we would get a comma with nothing before it when not DEBUGGING. =over 3 __ASSERT_(bool expr) =back =back =for hackers Found in file handy.h =head1 Compile-time scope hooks =over 4 =item C X NOTE: C is B and may change or be removed without notice. Temporarily disable an entry in this BHK structure, by clearing the appropriate flag. C is a preprocessor token indicating which entry to disable. =over 3 void BhkDISABLE(BHK *hk, which) =back =back =for hackers Found in file op.h =over 4 =item C X NOTE: C is B and may change or be removed without notice. Re-enable an entry in this BHK structure, by setting the appropriate flag. C is a preprocessor token indicating which entry to enable. This will assert (under -DDEBUGGING) if the entry doesn't contain a valid pointer. =over 3 void BhkENABLE(BHK *hk, which) =back =back =for hackers Found in file op.h =over 4 =item C X NOTE: C is B and may change or be removed without notice. Set an entry in the BHK structure, and set the flags to indicate it is valid. C is a preprocessing token indicating which entry to set. The type of C depends on the entry. =over 3 void BhkENTRY_set(BHK *hk, which, void *ptr) =back =back =for hackers Found in file op.h =over 4 =item C X NOTE: C is B and may change or be removed without notice. Register a set of hooks to be called when the Perl lexical scope changes at compile time. See L. NOTE: C must be explicitly called as C with an C parameter. =over 3 void Perl_blockhook_register(pTHX_ BHK *hk) =back =back =for hackers Found in file op.c =head1 Concurrency =over 4 =item C Described in L. =back =for hackers Found in file pod/perlguts.pod =over 4 =item C Described in L. =back =for hackers Found in file pod/perlguts.pod =over 4 =item C X C> It is planned to remove C from a future release of Perl. Do not use it for new code; remove it from existing code. Now a no-op. =over 3 void CPERLscope(void x) =back =back =for hackers Found in file perl.h =over 4 =item C Described in L. =back =for hackers Found in file pod/perlguts.pod =over 4 =item C Described in L. =back =for hackers Found in file pod/perlguts.pod =over 4 =item C X On threaded perls, set C to C; on unthreaded perls, do nothing =back =for hackers Found in file perl.h =over 4 =item C X Now a synonym for C>. =back =for hackers Found in file perl.h =over 4 =item C X This is now a synonym for dNOOP: declare nothing =back =for hackers Found in file perl.h =over 4 =item C X This symbol, if defined, indicates that the getenv system call doesn't zap the static buffer of C in a different thread. The typical C implementation will return a pointer to the proper position in **environ. But some may instead copy them to a static buffer in C. If there is a per-thread instance of that buffer, or the return points to **environ, then a many-reader/1-writer mutex will work; otherwise an exclusive locking mutex is required to prevent races. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to setup fork handlers. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C system call is available to set the contention scope attribute of a thread attribute object. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to yield the execution of the current thread. C is preferable to C. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to yield the execution of the current thread. C is preferable to C. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates to the C program that it should include F. =over 3 #ifdef I_MACH_CTHREADS #include #endif =back =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates to the C program that it should include F. =over 3 #ifdef I_PTHREAD #include #endif =back =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that Perl should be built to use multiplicity. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that Perl should be built to use the old draft C threads C. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates how to create pthread in joinable (aka undetached) state. C: not defined if F already has defined C (the new version of the constant). If defined, known values are C and C<__UNDETACHED>. =back =for hackers Found in file config.h =over 4 =item C Described in L. =back =for hackers Found in file pod/perlguts.pod =over 4 =item C Described in L. =back =for hackers Found in file pod/perlguts.pod =over 4 =item C X This symbol defines the way to yield the execution of the current thread. Known ways are C, C, and C with C. =back =for hackers Found in file config.h =over 4 =item C Described in L. =back =for hackers Found in file pod/perlguts.pod =over 4 =item C Described in L. =over 3 SVfARG(SV *sv) =back =back =for hackers Found in file pod/perlguts.pod =head1 COP Hint Hashes =over 4 =item C X NOTE: C is B and may change or be removed without notice. Returns the label attached to a cop, and stores its length in bytes into C<*len>. Upon return, C<*flags> will be set to either C or 0. Alternatively, use the macro C>; or if you don't need to know if the label is UTF-8 or not, the macro C>; or if you additionally dont need to know the length, C>. =over 3 const char * cop_fetch_label(COP *const cop, STRLEN *len, U32 *flags) =back =back =for hackers Found in file hv.c =over 4 =item C X Returns the name of the file associated with the C C =over 3 const char * CopFILE(const COP * c) =back =back =for hackers Found in file cop.h =over 4 =item C X Returns the AV associated with the C C, creating it if necessary. =over 3 AV * CopFILEAV(const COP * c) =back =back =for hackers Found in file cop.h =over 4 =item C X Returns the AV associated with the C C, returning NULL if it doesn't already exist. =over 3 AV * CopFILEAVn(const COP * c) =back =back =for hackers Found in file cop.h =over 4 =item C X Returns the GV associated with the C C =over 3 GV * CopFILEGV(const COP * c) =back =back =for hackers Found in file cop.h =over 4 =item C X Available only on unthreaded perls. Makes C the name of the file associated with the C C =over 3 void CopFILEGV_set(COP * c, GV * gv) =back =back =for hackers Found in file cop.h =over 4 =item C X Makes C the name of the file associated with the C C =over 3 void CopFILE_set(COP * c, const char * pv) =back =back =for hackers Found in file cop.h =over 4 =item C X Returns the SV associated with the C C =over 3 SV * CopFILESV(const COP * c) =back =back =for hackers Found in file cop.h =over 4 =item C X NOTE: C is B and may change or be removed without notice. Generates and returns a standard Perl hash representing the full set of key/value pairs in the cop hints hash C. C is currently unused and must be zero. =over 3 HV * cophh_2hv(const COPHH *cophh, U32 flags) =back =back =for hackers Found in file cop.h =over 4 =item C X NOTE: C is B and may change or be removed without notice. Make and return a complete copy of the cop hints hash C. =over 3 COPHH * cophh_copy(COPHH *cophh) =back =back =for hackers Found in file cop.h =over 4 =item C X NOTE: C is B and may change or be removed without notice. Like L, but takes a nul-terminated string instead of a string/length pair. =over 3 COPHH * cophh_delete_pv(COPHH *cophh, char *key, U32 hash, U32 flags) =back =back =for hackers Found in file cop.h =over 4 =item C X NOTE: C is B and may change or be removed without notice. Delete a key and its associated value from the cop hints hash C, and returns 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 L if you need both hashes. The key is specified by C and C. If C has the C bit set, the key octets are interpreted as UTF-8, otherwise they are interpreted as Latin-1. C is a precomputed hash of the key string, or zero if it has not been precomputed. =over 3 COPHH * cophh_delete_pvn(COPHH *cophh, const char *keypv, STRLEN keylen, U32 hash, U32 flags) =back =back =for hackers Found in file cop.h =over 4 =item C X NOTE: C is B and may change or be removed without notice. Like L, but takes a literal string instead of a string/length pair, and no precomputed hash. =over 3 COPHH * cophh_delete_pvs(COPHH *cophh, "key", U32 flags) =back =back =for hackers Found in file cop.h =over 4 =item C X NOTE: C is B and may change or be removed without notice. Like L, but takes a Perl scalar instead of a string/length pair. =over 3 COPHH * cophh_delete_sv(COPHH *cophh, SV *key, U32 hash, U32 flags) =back =back =for hackers Found in file cop.h =over 4 =item C X NOTE: C is B and may change or be removed without notice. Like L, but takes a nul-terminated string instead of a string/length pair. =over 3 bool cophh_exists_pv(const COPHH *cophh, const char *key, U32 hash, U32 flags) =back =back =for hackers Found in file cop.h =over 4 =item C X NOTE: C is B and may change or be removed without notice. Look up the entry in the cop hints hash C with the key specified by C and C. If C has the C bit set, the key octets are interpreted as UTF-8, otherwise they are interpreted as Latin-1. C is a precomputed hash of the key string, or zero if it has not been precomputed. Returns true if a value exists, and false otherwise. =over 3 bool cophh_exists_pvn(const COPHH *cophh, const char *keypv, STRLEN keylen, U32 hash, U32 flags) =back =back =for hackers Found in file cop.h =over 4 =item C X NOTE: C is B and may change or be removed without notice. Like L, but takes a literal string instead of a string/length pair, and no precomputed hash. =over 3 bool cophh_exists_pvs(const COPHH *cophh, "key", U32 flags) =back =back =for hackers Found in file cop.h =over 4 =item C X NOTE: C is B and may change or be removed without notice. Like L, but takes a Perl scalar instead of a string/length pair. =over 3 bool cophh_exists_sv(const COPHH *cophh, SV *key, U32 hash, U32 flags) =back =back =for hackers Found in file cop.h =over 4 =item C X NOTE: C is B and may change or be removed without notice. Like L, but takes a nul-terminated string instead of a string/length pair. =over 3 SV * cophh_fetch_pv(const COPHH *cophh, const char *key, U32 hash, U32 flags) =back =back =for hackers Found in file cop.h =over 4 =item C X NOTE: C is B and may change or be removed without notice. Look up the entry in the cop hints hash C with the key specified by C and C. If C has the C bit set, the key octets are interpreted as UTF-8, otherwise they are interpreted as Latin-1. C is a precomputed hash of the key string, or zero if it has not been precomputed. Returns a mortal scalar copy of the value associated with the key, or C<&PL_sv_placeholder> if there is no value associated with the key. =over 3 SV * cophh_fetch_pvn(const COPHH *cophh, const char *keypv, STRLEN keylen, U32 hash, U32 flags) =back =back =for hackers Found in file cop.h =over 4 =item C X NOTE: C is B and may change or be removed without notice. Like L, but takes a literal string instead of a string/length pair, and no precomputed hash. =over 3 SV * cophh_fetch_pvs(const COPHH *cophh, "key", U32 flags) =back =back =for hackers Found in file cop.h =over 4 =item C X NOTE: C is B and may change or be removed without notice. Like L, but takes a Perl scalar instead of a string/length pair. =over 3 SV * cophh_fetch_sv(const COPHH *cophh, SV *key, U32 hash, U32 flags) =back =back =for hackers Found in file cop.h =over 4 =item C X NOTE: C is B and may change or be removed without notice. Discard the cop hints hash C, freeing all resources associated with it. =over 3 void cophh_free(COPHH *cophh) =back =back =for hackers Found in file cop.h =over 4 =item C X NOTE: C is B and may change or be removed without notice. Generate and return a fresh cop hints hash containing no entries. =over 3 COPHH * cophh_new_empty() =back =back =for hackers Found in file cop.h =over 4 =item C X NOTE: C is B and may change or be removed without notice. Like L, but takes a nul-terminated string instead of a string/length pair. =over 3 COPHH * cophh_store_pv(COPHH *cophh, const char *key, U32 hash, SV *value, U32 flags) =back =back =for hackers Found in file cop.h =over 4 =item C X NOTE: C is B and may change or be removed without notice. Stores a value, associated with a key, in the cop hints hash C, and returns 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 L if you need both hashes. The key is specified by C and C. If C has the C bit set, the key octets are interpreted as UTF-8, otherwise they are interpreted as Latin-1. C is a precomputed hash of the key string, or zero if it has not been precomputed. C is the scalar value to store for this key. C is copied by this function, which thus does not take ownership of any reference to it, and 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. =over 3 COPHH * cophh_store_pvn(COPHH *cophh, const char *keypv, STRLEN keylen, U32 hash, SV *value, U32 flags) =back =back =for hackers Found in file cop.h =over 4 =item C X NOTE: C is B and may change or be removed without notice. Like L, but takes a literal string instead of a string/length pair, and no precomputed hash. =over 3 COPHH * cophh_store_pvs(COPHH *cophh, "key", SV *value, U32 flags) =back =back =for hackers Found in file cop.h =over 4 =item C X NOTE: C is B and may change or be removed without notice. Like L, but takes a Perl scalar instead of a string/length pair. =over 3 COPHH * cophh_store_sv(COPHH *cophh, SV *key, U32 hash, SV *value, U32 flags) =back =back =for hackers Found in file cop.h =over 4 =item C X Generates and returns a standard Perl hash representing the full set of hint entries in the cop C. C is currently unused and must be zero. =over 3 HV * cop_hints_2hv(const COP *cop, U32 flags) =back =back =for hackers Found in file cop.h =over 4 =item C X Like L, but takes a nul-terminated string instead of a string/length pair. =over 3 bool cop_hints_exists_pv(const COP *cop, const char *key, U32 hash, U32 flags) =back =back =for hackers Found in file cop.h =over 4 =item C X Look up the hint entry in the cop C with the key specified by C and C. If C has the C bit set, the key octets are interpreted as UTF-8, otherwise they are interpreted as Latin-1. C is a precomputed hash of the key string, or zero if it has not been precomputed. Returns true if a value exists, and false otherwise. =over 3 bool cop_hints_exists_pvn(const COP *cop, const char *keypv, STRLEN keylen, U32 hash, U32 flags) =back =back =for hackers Found in file cop.h =over 4 =item C X Like L, but takes a literal string instead of a string/length pair, and no precomputed hash. =over 3 bool cop_hints_exists_pvs(const COP *cop, "key", U32 flags) =back =back =for hackers Found in file cop.h =over 4 =item C X Like L, but takes a Perl scalar instead of a string/length pair. =over 3 bool cop_hints_exists_sv(const COP *cop, SV *key, U32 hash, U32 flags) =back =back =for hackers Found in file cop.h =over 4 =item C X Like L, but takes a nul-terminated string instead of a string/length pair. =over 3 SV * cop_hints_fetch_pv(const COP *cop, const char *key, U32 hash, U32 flags) =back =back =for hackers Found in file cop.h =over 4 =item C X Look up the hint entry in the cop C with the key specified by C and C. If C has the C bit set, the key octets are interpreted as UTF-8, otherwise they are interpreted as Latin-1. C is a precomputed hash of the key string, or zero if it has not been precomputed. Returns a mortal scalar copy of the value associated with the key, or C<&PL_sv_placeholder> if there is no value associated with the key. =over 3 SV * cop_hints_fetch_pvn(const COP *cop, const char *keypv, STRLEN keylen, U32 hash, U32 flags) =back =back =for hackers Found in file cop.h =over 4 =item C X Like L, but takes a literal string instead of a string/length pair, and no precomputed hash. =over 3 SV * cop_hints_fetch_pvs(const COP *cop, "key", U32 flags) =back =back =for hackers Found in file cop.h =over 4 =item C X Like L, but takes a Perl scalar instead of a string/length pair. =over 3 SV * cop_hints_fetch_sv(const COP *cop, SV *key, U32 hash, U32 flags) =back =back =for hackers Found in file cop.h =over 4 =item C X Returns the label attached to a cop. =over 3 const char * CopLABEL(COP *const cop) =back =back =for hackers Found in file cop.h =over 4 =item C X Returns the label attached to a cop, and stores its length in bytes into C<*len>. =over 3 const char * CopLABEL_len(COP *const cop, STRLEN *len) =back =back =for hackers Found in file cop.h =over 4 =item C X Returns the label attached to a cop, and stores its length in bytes into C<*len>. Upon return, C<*flags> will be set to either C or 0. =over 3 const char * CopLABEL_len_flags(COP *const cop, STRLEN *len, U32 *flags) =back =back =for hackers Found in file cop.h =over 4 =item C X Returns the line number in the source code associated with the C C =over 3 STRLEN CopLINE(const COP * c) =back =back =for hackers Found in file cop.h =over 4 =item C X Returns the stash associated with C. =over 3 HV * CopSTASH(const COP * c) =back =back =for hackers Found in file cop.h =over 4 =item C X Returns a boolean as to whether or not C is the stash associated with C. =over 3 bool CopSTASH_eq(const COP * c, const HV * hv) =back =back =for hackers Found in file cop.h =over 4 =item C X Returns the package name of the stash associated with C, or C if no associated stash =over 3 char * CopSTASHPV(const COP * c) =back =back =for hackers Found in file cop.h =over 4 =item C X Set the package name of the stash associated with C, to the NUL-terminated C string C

, creating the package if necessary. =over 3 void CopSTASHPV_set(COP * c, const char * pv) =back =back =for hackers Found in file cop.h =over 4 =item C X Set the stash associated with C to C. =over 3 bool CopSTASH_set(COP * c, HV * hv) =back =back =for hackers Found in file cop.h =over 4 =item C X NOTE: C is B and may change or be removed without notice. Save a label into a C. You need to set flags to C for a UTF-8 label. Any other flag is ignored. =over 3 void cop_store_label(COP *const cop, const char *label, STRLEN len, U32 flags) =back =back =for hackers Found in file hv.c =over 4 =item C X Use this typedef to declare variables that are to hold C. =back =for hackers Found in file cop.h =head1 Custom Operators =over 4 =item C X C> It is planned to remove C from a future release of Perl. Do not use it for new code; remove it from existing code. Return the description of a given custom op. This was once used by the C macro, but is no longer: it has only been kept for compatibility, and should not be used. =over 3 const char * custom_op_desc(const OP *o) =back =back =for hackers Found in file mathoms.c =over 4 =item C X C> It is planned to remove C from a future release of Perl. Do not use it for new code; remove it from existing code. Return the name for a given custom op. This was once used by the C macro, but is no longer: it has only been kept for compatibility, and should not be used. =over 3 const char * custom_op_name(const OP *o) =back =back =for hackers Found in file mathoms.c =over 4 =item C X Register a custom op. See L. NOTE: C must be explicitly called as C with an C parameter. =over 3 void Perl_custom_op_register(pTHX_ Perl_ppaddr_t ppaddr, const XOP *xop) =back =back =for hackers Found in file op.c =over 4 =item C X Return the XOP structure for a given custom op. This macro should be considered internal to C and the other access macros: use them instead. This macro does call a function. Prior to 5.19.6, this was implemented as a function. =over 3 const XOP * Perl_custom_op_xop(pTHX_ const OP *o) =back =back =for hackers Found in file op.c =over 4 =item C X Temporarily disable a member of the XOP, by clearing the appropriate flag. =over 3 void XopDISABLE(XOP *xop, which) =back =back =for hackers Found in file op.h =over 4 =item C X Reenable a member of the XOP which has been disabled. =over 3 void XopENABLE(XOP *xop, which) =back =back =for hackers Found in file op.h =over 4 =item C X Return a member of the XOP structure. C is a cpp token indicating which entry to return. If the member is not set this will return a default value. The return type depends on C. This macro evaluates its arguments more than once. If you are using C to retrieve a C from a C, use the more efficient L instead. =over 3 XopENTRY(XOP *xop, which) =back =back =for hackers Found in file op.h =over 4 =item C X Exactly like C but more efficient. The C parameter is identical to L. =over 3 XopENTRYCUSTOM(const OP *o, which) =back =back =for hackers Found in file op.h =over 4 =item C X Set a member of the XOP structure. C is a cpp token indicating which entry to set. See L for details about the available members and how they are used. This macro evaluates its argument more than once. =over 3 void XopENTRY_set(XOP *xop, which, value) =back =back =for hackers Found in file op.h =over 4 =item C X Return the XOP's flags. =over 3 U32 XopFLAGS(XOP *xop) =back =back =for hackers Found in file op.h =head1 CV Handling This section documents functions to manipulate CVs which are code-values, meaning subroutines. For more information, see L. =over 4 =item C X The XSUB-writer's equivalent of L. The returned C structure can be interrogated to find all the information returned to Perl by C. Note that XSUBs don't get a stack frame, so C will return information for the immediately-surrounding Perl code. This function skips over the automatic calls to C<&DB::sub> made on the behalf of the debugger. If the stack frame requested was a sub called by C, the return value will be the frame for the call to C, since that has the correct line number/etc. for the call site. If I is non-C, it will be set to a pointer to the frame for the sub call itself. =over 3 const PERL_CONTEXT * caller_cx(I32 level, const PERL_CONTEXT **dbcxp) =back =back =for hackers Found in file pp_ctl.c =over 4 =item C X Returns the GV associated with the CV C, reifying it if necessary. =over 3 GV * CvGV(CV *sv) =back =back =for hackers Found in file inline.h =over 4 =item C X Returns the stash of the CV. A stash is the symbol table hash, containing the package-scoped variables in the package where the subroutine was defined. For more information, see L. This also has a special use with XS AUTOLOAD subs. See L. =over 3 HV* CvSTASH(CV* cv) =back =back =for hackers Found in file cv.h =over 4 =item C X Locate the CV corresponding to the currently executing sub or eval. If C is non_null, skip CVs that are in the DB package and populate C<*db_seqp> with the cop sequence number at the point that the DB:: code was entered. (This allows debuggers to eval in the scope of the breakpoint rather than in the scope of the debugger itself.) =over 3 CV* find_runcv(U32 *db_seqp) =back =back =for hackers Found in file pp_ctl.c =over 4 =item C =item C =item C XXX These return the CV of the specified Perl subroutine. C are passed to C. If C is set and the Perl subroutine does not exist then it will be declared (which has the same effect as saying C). If C is not set and the subroutine does not exist, then NULL is returned. The forms differ only in how the subroutine is specified.. With C, the name is a literal C string, enclosed in double quotes. With C, the name is given by the C parameter, which must be a NUL-terminated C string. With C, the name is also given by the C parameter, but it is a Perl string (possibly containing embedded NUL bytes), and its length in bytes is contained in the C parameter. NOTE: the C form is B. NOTE: the C form is B. NOTE: the C form is B. =over 3 CV* get_cv (const char* name, I32 flags) CV * get_cvs ("string", I32 flags) CV* get_cvn_flags(const char* name, STRLEN len, I32 flags) =back =back =for hackers Found in file perl.c =over 4 =item C X C> It is planned to remove C from a future release of Perl. Do not use it for new code; remove it from existing code. Null CV pointer. (deprecated - use C<(CV *)NULL> instead) =back =for hackers Found in file cv.h =head1 Debugging =over 4 =item C X Dumps the entire optree of the current program starting at C to C. Also dumps the optrees for all visible subroutines in C. =over 3 void dump_all() =back =back =for hackers Found in file dump.c =over 4 =item C X Dumps the C backtrace to the given C. Returns true if a backtrace could be retrieved, false if not. =over 3 bool dump_c_backtrace(PerlIO* fp, int max_depth, int skip) =back =back =for hackers Found in file util.c =over 4 =item C X Dumps the optrees for all visible subroutines in C. =over 3 void dump_packsubs(const HV* stash) =back =back =for hackers Found in file dump.c =over 4 =item C X Returns a SV containing a dump of C frames of the call stack, skipping the C innermost ones. C of 20 is usually enough. 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 C, and the :offset (might be missing) tells how much inside the C the program counter was. The C is the source code file and line number. The F is obvious (hopefully). Unknowns are C<"-">. 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. =over 3 SV* get_c_backtrace_dump(int max_depth, int skip) =back =back =for hackers Found in file util.c =over 4 =item C X This symbol, if defined, indicates that the C routine is available to get a stack trace. The F header must be included to use this routine. =back =for hackers Found in file config.h =over 4 =item C X Given an op, determine what type of struct it has been allocated as. Returns one of the OPclass enums, such as OPclass_LISTOP. =over 3 OPclass op_class(const OP *o) =back =back =for hackers Found in file dump.c =over 4 =item C X Dumps the optree starting at OP C to C. =over 3 void op_dump(const OP *o) =back =back =for hackers Found in file dump.c =over 4 =item C X Dumps the contents of an SV to the C filehandle. For an example of its output, see L. =over 3 void sv_dump(SV* sv) =back =back =for hackers Found in file dump.c =head1 Display functions =over 4 =item C

=item C XX These take a sprintf-style format pattern and conventional (non-SV) arguments and return the formatted string. (char *) Perl_form(pTHX_ const char* pat, ...) can be used any place a string (char *) is required: char * s = Perl_form("%d.%d",major,minor); They use a single (per-thread) private buffer so if you want to format several strings you must explicitly copy the earlier strings away (and free the copies when you are done). The two forms differ only in that C does not take a thread context (C) parameter, so is used in situations where the caller doesn't already have the thread context. NOTE: C must be explicitly called as C with an C parameter. =over 3 char* Perl_form (pTHX_ const char* pat, ...) char* form_nocontext(const char* pat, ...) =back =back =for hackers Found in file util.c =over 4 =item C =item C XX These 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 C>. 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. The two forms differ only in that C does not take a thread context (C) parameter, so is used in situations where the caller doesn't already have the thread context. NOTE: C must be explicitly called as C with an C parameter. =over 3 SV* Perl_mess (pTHX_ const char* pat, ...) SV* mess_nocontext(const char* pat, ...) =back =back =for hackers Found in file util.c =over 4 =item C X Expands a message, intended for the user, to include an indication of the current location in the code, if the message does not already appear to be complete. C 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 C 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 C is true, then the function is permitted (but not required) to modify and return C instead of allocating a new SV. =over 3 SV* mess_sv(SV* basemsg, bool consume) =back =back =for hackers Found in file util.c =over 4 =item C X Similar to 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. =over 3 char* pv_display(SV *dsv, const char *pv, STRLEN cur, STRLEN len, STRLEN pvlim) =back =back =for hackers Found in file dump.c =over 4 =item C X Escapes at most the first C chars of C and puts the results into C such that the size of the escaped string will not exceed C chars and will not contain any incomplete escape sequences. The number of bytes escaped will be returned in the C parameter if it is not null. When the C parameter is null no escaping actually occurs, but the number of bytes that would be escaped were it not null will be calculated. If flags contains C 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 C is set this will not occur. If C is set then the input string is treated as UTF-8 if C is set then the input string is scanned using C to determine if it is UTF-8. If C is set then all input chars will be output using C<\x01F1> style escapes, otherwise if C 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 C<\n>. Otherwise, if C then all chars below 255 will be treated as printable and will be output as literals. If C 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 C<\n> or a hex value. If C is set then the escape char used will be a C<"%"> and not a C<"\\">. This is because regexes very often contain backslashed sequences, whereas C<"%"> is not a particularly common character in patterns. Returns a pointer to the escaped text as held by C. =over 3 char* pv_escape(SV *dsv, char const * const str, const STRLEN count, const STRLEN max, STRLEN * const escaped, const U32 flags) =back =back =for hackers Found in file dump.c =over 4 =item C X Converts a string into something presentable, handling escaping via C and supporting quoting and ellipses. If the C flag is set then the result will be double quoted with any double quotes in the string escaped. Otherwise if the C flag is set then the result be wrapped in angle brackets. If the C flag is set and not all characters in string were output then an ellipsis C<...> will be appended to the string. Note that this happens AFTER it has been quoted. If C is non-null then it will be inserted after the opening quote (if there is one) but before the escaped text. If C 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 C. =over 3 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) =back =back =for hackers Found in file dump.c =over 4 =item C X Like C> but but the arguments are an encapsulated argument list. =over 3 char* vform(const char* pat, va_list* args) =back =back =for hackers Found in file util.c =over 4 =item C X C and C are a sprintf-style format pattern and encapsulated argument list, respectively. 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 L. 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. =over 3 SV* vmess(const char* pat, va_list* args) =back =back =for hackers Found in file util.c =head1 Embedding and Interpreter Cloning =over 4 =item C X Clone a CV, making a lexical closure. C supplies the prototype of the function: its code, pad structure, and other attributes. The prototype is combined with a capture of outer lexicals to which the code refers, which are taken from the currently-executing instance of the immediately surrounding code. =over 3 CV* cv_clone(CV* proto) =back =back =for hackers Found in file pad.c =over 4 =item C X Returns an SV containing the name of the CV, mainly for use in error reporting. The CV may actually be a GV instead, in which case the returned SV holds the GV's name. Anything other than a GV or CV is treated as a string already holding the sub name, but this could change in the future. 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 C has the C 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). =over 3 SV * cv_name(CV *cv, SV *sv, U32 flags) =back =back =for hackers Found in file pad.c =over 4 =item C X Clear out all the active components of a CV. This can happen either by an explicit C, or by the reference count going to zero. In the former case, we keep the C pointer, so that any anonymous children can still follow the full lexical scope chain. =over 3 void cv_undef(CV* cv) =back =back =for hackers Found in file pad.c =over 4 =item C X Returns the global variable C<$_>. =over 3 SV* find_rundefsv() =back =back =for hackers Found in file pad.c =over 4 =item C X C> It is planned to remove C from a future release of Perl. Do not use it for new code; remove it from existing code. Until the lexical C<$_> feature was removed, this function would find the position of the lexical C<$_> in the pad of the currently-executing function and return the offset in the current pad, or C. Now it always returns C. =over 3 PADOFFSET find_rundefsvoffset() =back =back =for hackers Found in file pad.c =over 4 =item C X "Introduce" C variables to visible status. This is called during parsing at the end of each statement to make lexical variables visible to subsequent statements. =over 3 U32 intro_my() =back =back =for hackers Found in file pad.c =over 4 =item C X Loads the module whose name is pointed to by the string part of C. Note that the actual module name, not its filename, should be given. Eg, "Foo::Bar" instead of "Foo/Bar.pm". ver, if specified and not NULL, provides version semantics similar to C. The optional trailing arguments can be used to specify arguments to the module's C method, similar to C; their precise handling depends on the flags. The flags argument is a bitwise-ORed collection of any of C, C, or C (or 0 for no flags). If C is set, the module is loaded as if with an empty import list, as in C; this is the only circumstance in which the trailing optional arguments may be omitted entirely. Otherwise, if C is set, the trailing arguments must consist of exactly one C, containing the op tree that produces the relevant import arguments. Otherwise, the trailing arguments must all be C values that will be used as import arguments; and the list must be terminated with C<(SV*) NULL>. If neither C nor C is set, the trailing C pointer is needed even if no import arguments are desired. The reference count for each specified C argument is decremented. In addition, the C argument is modified. If C is set, the module is loaded as if with C rather than C. =over 3 void load_module(U32 flags, SV* name, SV* ver, ...) =back =back =for hackers Found in file op.c =over 4 =item C X Like C> but does not take a thread context (C) parameter, so is used in situations where the caller doesn't already have the thread context. =over 3 void load_module_nocontext(U32 flags, SV* name, SV* ver, ...) =back =back =for hackers Found in file op.c =over 4 =item C X A wrapper for the C library L, honoring what L say to do. =over 3 void my_exit(U32 status) =back =back =for hackers Found in file perl.c =over 4 =item C X NOTE: C is B and may change or be removed without notice. Creates a new pad name list. C is the highest index for which space is allocated. =over 3 PADNAMELIST * newPADNAMELIST(size_t max) =back =back =for hackers Found in file pad.c =over 4 =item C X NOTE: C is B and may change or be removed without notice. Constructs and returns a new pad name. Only use this function for names that refer to outer lexicals. (See also L.) C is the outer pad name that this one mirrors. The returned pad name has the C flag already set. =over 3 PADNAME * newPADNAMEouter(PADNAME *outer) =back =back =for hackers Found in file pad.c =over 4 =item C X NOTE: C is B and may change or be removed without notice. Constructs and returns a new pad name. C must be a UTF-8 string. Do not use this for pad names that point to outer lexicals. See C>. =over 3 PADNAME * newPADNAMEpvn(const char *s, STRLEN len) =back =back =for hackers Found in file pad.c =over 4 =item C X Stub that provides thread hook for perl_destruct when there are no threads. =over 3 int nothreadhook() =back =back =for hackers Found in file perl.c =over 4 =item C X Allocates a place in the currently-compiling pad (via L) for an anonymous function that is lexically scoped inside the currently-compiling function. The function C is linked into the pad, and its C link to the outer scope is weakened to avoid a reference loop. One reference count is stolen, so you may need to do C. C 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. =over 3 PADOFFSET pad_add_anon(CV* func, I32 optype) =back =back =for hackers Found in file pad.c =over 4 =item C X Exactly like L, but takes a nul-terminated string instead of a string/length pair. =over 3 PADOFFSET pad_add_name_pv(const char *name, const U32 flags, HV *typestash, HV *ourstash) =back =back =for hackers Found in file pad.c =over 4 =item C X Allocates a place in the currently-compiling pad for a named lexical variable. Stores the name and other metadata in the name part of the pad, and makes preparations to manage the variable's lexical scoping. Returns the offset of the allocated pad slot. C/C specify the variable's name, including leading sigil. If C is non-null, the name is for a typed lexical, and this identifies the type. If C 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 =over 3 PADOFFSET pad_add_name_pvn(const char *namepv, STRLEN namelen, U32 flags, HV *typestash, HV *ourstash) =back =back =for hackers Found in file pad.c =over 4 =item C X Exactly like L, but takes the name string in the form of an SV instead of a string/length pair. =over 3 PADOFFSET pad_add_name_sv(SV *name, U32 flags, HV *typestash, HV *ourstash) =back =back =for hackers Found in file pad.c =over 4 =item C X NOTE: C is B and may change or be removed without notice. 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. C 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 C has been supported here only since perl 5.20. To work with earlier versions as well, use C. C does not cause the SV in the pad slot to be marked read-only, but simply tells C that it I be made read-only (by the caller), or at least should be treated as such. C 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. =over 3 PADOFFSET pad_alloc(I32 optype, U32 tmptype) =back =back =for hackers Found in file pad.c =over 4 =item C X Exactly like L, but takes a nul-terminated string instead of a string/length pair. =over 3 PADOFFSET pad_findmy_pv(const char* name, U32 flags) =back =back =for hackers Found in file pad.c =over 4 =item C X Given the name of a lexical variable, find its position in the currently-compiling pad. C/C specify the variable's name, including leading sigil. C is reserved and must be zero. 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. Returns the offset in the current pad, or C if no such lexical is in scope. =over 3 PADOFFSET pad_findmy_pvn(const char* namepv, STRLEN namelen, U32 flags) =back =back =for hackers Found in file pad.c =over 4 =item C X Exactly like L, but takes the name string in the form of an SV instead of a string/length pair. =over 3 PADOFFSET pad_findmy_sv(SV* name, U32 flags) =back =back =for hackers Found in file pad.c =over 4 =item C X NOTE: C is B and may change or be removed without notice. Fetches the pad name from the given index. =over 3 PADNAME * padnamelist_fetch(PADNAMELIST *pnl, SSize_t key) =back =back =for hackers Found in file pad.c =over 4 =item C X NOTE: C is B and may change or be removed without notice. Stores the pad name (which may be null) at the given index, freeing any existing pad name in that slot. =over 3 PADNAME ** padnamelist_store(PADNAMELIST *pnl, SSize_t key, PADNAME *val) =back =back =for hackers Found in file pad.c =over 4 =item C X NOTE: C is B and may change or be removed without notice. 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 C<@_>; mark temporaries as such. C indicates the kind of subroutine: padtidy_SUB ordinary subroutine padtidy_SUBCLONE prototype for lexical closure padtidy_FORMAT format =over 3 void pad_tidy(padtidy_type type) =back =back =for hackers Found in file pad.c =over 4 =item C X Allocates a new Perl interpreter. See L. =over 3 PerlInterpreter* perl_alloc() =back =back =for hackers Found in file perl.c =over 4 =item C Described in L. =over 3 void PERL_ASYNC_CHECK() =back =back =for hackers Found in file pod/perlinterp.pod =over 4 =item C X Create and return a new interpreter by cloning the current one. C takes these flags as parameters: C - 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 C while the threads->create doesn't. C - C 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 C is not set then C will kill the ptr_table using the function S>. 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. C - 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. =over 3 PerlInterpreter* perl_clone(PerlInterpreter *proto_perl, UV flags) =back =back =for hackers Found in file sv.c =over 4 =item C X Initializes a new Perl interpreter. See L. =over 3 void perl_construct(PerlInterpreter *my_perl) =back =back =for hackers Found in file perl.c =over 4 =item C X Shuts down a Perl interpreter. See L for a tutorial. C points to the Perl interpreter. It must have been previously created through the use of L and L. It may have been initialised through L, and may have been used through L and other means. This function should be called for any Perl interpreter that has been constructed with L, even if subsequent operations on it failed, for example if L returned a non-zero value. If the interpreter's C word has the C flag set, then this function will execute code in C blocks before performing the rest of destruction. If it is desired to make any use of the interpreter between L and L other than just calling L, then this flag should be set early on. This matters if L will not be called, or if anything else will be done in addition to calling L. Returns a value be a suitable value to pass to the C library function C (or to return from C
), to serve as an exit code indicating the nature of the way the interpreter terminated. This takes into account any failure of L and any early exit from L. 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. =over 3 int perl_destruct(PerlInterpreter *my_perl) =back =back =for hackers Found in file perl.c =over 4 =item C X Releases a Perl interpreter. See L. =over 3 void perl_free(PerlInterpreter *my_perl) =back =back =for hackers Found in file perl.c =over 4 =item C X Tells a Perl interpreter to parse a Perl script. This performs most of the initialisation of a Perl interpreter. See L for a tutorial. C points to the Perl interpreter that is to parse the script. It must have been previously created through the use of L and L. C 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. C and C supply a set of command-line arguments to the Perl interpreter, as would normally be passed to the C
function of a C program. C 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 C<-e> option. If L|perlvar/$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. C 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 C global variable. This function initialises the interpreter, and parses and compiles the script specified by the command-line arguments. This includes executing code in C, C, and C blocks. It does not execute C 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 L 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 L and free it with L. For historical reasons, the non-zero return value also attempts to be a suitable value to pass to the C library function C (or to return from C
), 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. A historical bug is preserved for the time being: if the Perl built-in C is called during this function's execution, with a type of exit entailing a zero exit code under the host operating system's conventions, then this function returns zero rather than a non-zero value. This bug, [perl #2754], leads to C being called (and therefore C blocks and the main program running) despite a call to C. It has been preserved because a popular module-installing module has come to rely on it and needs time to be fixed. This issue is [perl #132577], and the original bug is due to be fixed in Perl 5.30. =over 3 int perl_parse(PerlInterpreter *my_perl, XSINIT_t xsinit, int argc, char** argv, char** env) =back =back =for hackers Found in file perl.c =over 4 =item C X Tells a Perl interpreter to run its main program. See L for a tutorial. C points to the Perl interpreter. It must have been previously created through the use of L and L, and initialised through L. This function should not be called if L returned a non-zero value, indicating a failure in initialisation or compilation. This function executes code in C blocks, and then executes the main program. The code to be executed is that established by the prior call to L. If the interpreter's C word does not have the C flag set, then this function will also execute code in C blocks. If it is desired to make any further use of the interpreter after calling this function, then C blocks should be postponed to L 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 C 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 L and free it with L. For historical reasons, the non-zero return value also attempts to be a suitable value to pass to the C library function C (or to return from C
), 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 L. =over 3 int perl_run(PerlInterpreter *my_perl) =back =back =for hackers Found in file perl.c =over 4 =item C X Provides system-specific tune up of the C runtime environment necessary to run Perl interpreters. This should be called only once, before creating any Perl interpreters. =over 3 void PERL_SYS_INIT(int *argc, char*** argv) =back =back =for hackers Found in file perl.h =over 4 =item C X Provides system-specific tune up of the C runtime environment necessary to run Perl interpreters. This should be called only once, before creating any Perl interpreters. =over 3 void PERL_SYS_INIT3(int *argc, char*** argv, char*** env) =back =back =for hackers Found in file perl.h =over 4 =item C X Provides system-specific clean up of the C runtime environment after running Perl interpreters. This should be called only once, after freeing any remaining Perl interpreters. =over 3 void PERL_SYS_TERM() =back =back =for hackers Found in file perl.h =over 4 =item C X Contains flags controlling perl's behaviour on exit(): =over =item * C If set, END blocks are executed when the interpreter is destroyed. This is normally set by perl itself after the interpreter is constructed. =item * C Call C on exit. This is used internally by perl itself to abort if exit is called while processing exit. =item * C Warn on exit. =item * C Set by the L operator. =back =over 3 U8 PL_exit_flags =back =back =for hackers Found in file intrpvar.h =over 4 =item C X This value may be set when embedding for full cleanup. Possible values: =over =item * 0 - none =item * 1 - full =item * 2 or greater - full with checks. =back If C<$ENV{PERL_DESTRUCT_LEVEL}> is set to an integer greater than the value of C 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. =over 3 signed char PL_perl_destruct_level =back =back =for hackers Found in file intrpvar.h =over 4 =item C X Tells Perl to C the file named by the string argument. It is analogous to the Perl code C. It's even implemented that way; consider using load_module instead. NOTE: the C form is B. =over 3 void require_pv(const char* pv) =back =back =for hackers Found in file perl.c =over 4 =item C X C> It is planned to remove C from a future release of Perl. Do not use it for new code; remove it from existing code. Obsolete form of C, which you should convert to instead use =over 3 const char * UVf =back =back =for hackers Found in file perl.h =over 4 =item C X Like C> but the arguments are an encapsulated argument list. =over 3 void vload_module(U32 flags, SV* name, SV* ver, va_list* args) =back =back =for hackers Found in file op.c =head1 Errno =over 4 =item C X Generates the message string describing an OS error and returns it as an SV. C must be a value that C could take, identifying the type of error. If C is non-null then the string will be written into that SV (overwriting existing content) and it will be returned. If C 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 C<$!>, and will be encoded in the SV in whatever manner would be used by C<$!>. 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 C 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 C<$!>, a message is even yielded for C zero (meaning success), and if no useful message is available then a useless string (currently empty) is returned. =over 3 SV* sv_string_from_errnum(int errnum, SV* tgtsv) =back =back =for hackers Found in file mg.c =head1 Exception Handling (simple) Macros =over 4 =item C X Set up necessary local variables for exception handling. See L. =over 3 dXCPT; =back =back =for hackers Found in file XSUB.h =over 4 =item C Described in L. =over 3 void JMPENV_JUMP(int v) =back =back =for hackers Found in file pod/perlinterp.pod =over 4 =item C Described in L. =over 3 void JMPENV_PUSH(int v) =back =back =for hackers Found in file pod/perlinterp.pod =over 4 =item C Described in L. =back =for hackers Found in file pod/perlinterp.pod =over 4 =item C X Introduces a catch block. See L. =back =for hackers Found in file XSUB.h =over 4 =item C X Rethrows a previously caught exception. See L. =over 3 XCPT_RETHROW; =back =back =for hackers Found in file XSUB.h =over 4 =item C X Ends a try block. See L. =back =for hackers Found in file XSUB.h =over 4 =item C X Starts a try block. See L. =back =for hackers Found in file XSUB.h =head1 Filesystem configuration values Also see L. =over 4 =item C X This symbol, if defined, indicates to the C program that the length of directory entry names is provided by a C field. Otherwise you need to do C on the C field. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C program should check the script that it is executing for setuid/setgid bits, and attempt to emulate setuid/setgid on systems that have disabled setuid #! scripts because the kernel can't do it securely. It is up to the package designer to make sure that this emulation is done securely. Among other things, it should do an fstat on the script it just opened to make sure it really is a setuid/setgid script, it should make sure the arguments passed correspond exactly to the argument on the #! line, and it should not trust any subprocesses to which it must pass the filename rather than the file descriptor of the script to be executed. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates to the C program that a C on a non-blocking file descriptor will return 0 on C, and not the value held in C (-1 usually, in that case!). =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that C can be used for file locking. Normally on Unix systems this is defined. It may be undefined on C. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, tells that to flush all pending stdio output one must loop through all the stdio file handles stored in an array and fflush them. Note that if C is defined, fflushall will not even be probed for and will be left undefined. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, tells that C correctly flushes all pending stdio output without side effects. In particular, on some platforms calling C *still* corrupts C if it is a pipe. =back =for hackers Found in file config.h =over 4 =item C X This macro is used to access the C<_base> field (or equivalent) of the C structure pointed to by its argument. This macro will always be defined if C is defined. =over 3 void * FILE_base(FILE * f) =back =back =for hackers Found in file handy.h =over 4 =item C X This macro is used to determine the number of bytes in the I/O buffer pointed to by C<_base> field (or equivalent) of the C structure pointed to its argument. This macro will always be defined if C is defined. =over 3 Size_t FILE_bufsiz(FILE *f) =back =back =for hackers Found in file handy.h =over 4 =item C X This macro is used to access the C<_cnt> field (or equivalent) of the C structure pointed to by its argument. This macro will always be defined if C is defined. =over 3 Size_t FILE_cnt(FILE * f) =back =back =for hackers Found in file handy.h =over 4 =item C X This macro is used to access the C<_ptr> field (or equivalent) of the C structure pointed to by its argument. This macro will always be defined if C is defined. =over 3 void * FILE_ptr(FILE * f) =back =back =for hackers Found in file handy.h =over 4 =item C X This symbol, if defined, indicates that the system supports filenames longer than 14 characters. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the the C* dirstream structure contains a member variable named C. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to duplicate file descriptors. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to duplicate file descriptors. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the "fast stdio" is available to manipulate the stdio buffers directly. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to change directory using a file descriptor. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates to the C program that the C function exists. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to free a C structure without closing the underlying file descriptor. This function appeared in C 10.2. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that C is available to determine file-system related limits and options associated with a given open file descriptor. =back =for hackers Found in file config.h =over 4 =item C X This symbol will be defined if the C compiler supports C. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to stat filesystems by file descriptors. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to stat filesystems by file descriptors. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to stat filesystems in bulk. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to get filesystem mount info by filename. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to iterate through mounted file systems to get their info. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to query the mount options of file systems. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the system provides a prototype for the C function. Otherwise, it is up to the program to supply one. A good guess is extern off_t lseek(int, off_t, int); =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to create directories. Otherwise you should fork off a new process to exec F. =back =for hackers Found in file config.h =over 4 =item C X This symbol will be defined if the C compiler supports C. =back =for hackers Found in file config.h =over 4 =item C X This manifest constant lets the C program know that the three argument form of C is available. =back =for hackers Found in file config.h =over 4 =item C X This symbol is defined if the C routine is available. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to C active file descriptors. Please check C and C to know which header should be included as well. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to read directory entries. You may have to include F. See C>. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to readdir64 re-entrantly. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available. You may have to include F. See C>. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to remove directories. Otherwise you should fork off a new process to exec F. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available. You may have to include F. See C>. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C active file descriptors. If the timeout field is used, F may need to be included. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to change buffering on an open stdio stream. to a line-buffered mode. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, tells that there is an array holding the stdio streams. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C to do C is supported. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C to do C is supported. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C does have the C member containing the mount flags of the filesystem containing the file. This kind of C is coming from F (C 4.3), not from F (C). Older C (like Ultrix) do not have C and C, they have C and C with C and C. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available. You may have to include F. See C>. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C system call is available to query file system statistics by C. =back =for hackers Found in file config.h =over 4 =item C X This manifest constant tells the C program to include F. =over 3 #ifdef I_FCNTL #include #endif =back =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates to the C program that it should include F. =over 3 #ifdef I_SYS_DIR #include #endif =back =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates to the C program that it should include F to get definition of C and friends. =over 3 #ifdef I_SYS_FILE #include #endif =back =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates to the C program that it should include F. =over 3 #ifdef I_SYS_NDIR #include #endif =back =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that F exists. =over 3 #ifdef I_SYS_STATFS #include #endif =back =back =for hackers Found in file config.h =over 4 =item C X This symbol holds the number of bytes used by the C. =back =for hackers Found in file config.h =over 4 =item C X This symbol holds the return code from C when no data is present on the non-blocking file descriptor. Be careful! If C is not defined, then you can't distinguish between no data and C by issuing a C. You'll have to find another way to tell for sure! =back =for hackers Found in file config.h =over 4 =item C X This symbol encodes the prototype of C. It is zero if C is undef, and one of the C macros of F if C is defined. =back =for hackers Found in file config.h =over 4 =item C X This symbol is defined to be the type of char used in F. It has the values "unsigned char" or "char". =back =for hackers Found in file config.h =over 4 =item C X This symbol is defined if the C macro can be used as an lvalue. =back =for hackers Found in file config.h =over 4 =item C X This symbol is defined if the C macro can be used as an lvalue. =back =for hackers Found in file config.h =over 4 =item C X This symbol is defined if using the C macro as an lvalue to increase the pointer by n leaves C unchanged. =back =for hackers Found in file config.h =over 4 =item C X This symbol is defined if using the C macro as an lvalue to increase the pointer by n has the side effect of decreasing the value of C by n. =back =for hackers Found in file config.h =over 4 =item C X This symbol tells the name of the array holding the stdio streams. Usual values include C<_iob>, C<__iob>, and C<__sF>. =back =for hackers Found in file config.h =over 4 =item C X This symbol holds the signedness of C's C. 1 for unsigned, -1 for signed. =back =for hackers Found in file config.h =over 4 =item C X This variable contains the size of C's C in bytes. =back =for hackers Found in file config.h =over 4 =item C X This symbol holds the errno error code set by C when no data was present on the non-blocking file descriptor. =back =for hackers Found in file config.h =over 4 =item C X This symbol is to be used during C or C to turn on non-blocking I/O for the file descriptor. Note that there is no way back, i.e. you cannot turn it blocking again this way. If you wish to alternatively switch between blocking and non-blocking, use the C call instead, but that is not supported by all devices. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine does not return a value. =back =for hackers Found in file config.h =head1 Floating point configuration values Also L lists capabilities that arent in this section. For example C, for the hyperbolic sine function. =over 4 =item C X This symbol contains flags that say what difficulties the compiler has casting odd floating values to unsigned long: 0 = ok 1 = couldn't cast < 0 2 = couldn't cast >= 0x80000000 4 = couldn't cast in argument expression list =back =for hackers Found in file config.h =over 4 =item C X This symbol is defined if the C compiler can cast negative numbers to unsigned longs, ints and shorts. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the double has the infinity. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the double has the not-a-number. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the double has the C. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the double has the subnormals (denormals). =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, is a comma-separated list of hexadecimal bytes for the double precision infinity. =back =for hackers Found in file config.h =over 4 =item C X C will be one of C C C C C C C C C C C C C C C =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, tells how many mantissa bits there are in double precision floating point format. Note that this is usually C minus one, since with the standard C 754 formats C includes the implicit bit, which doesn't really exist. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, is a comma-separated list of hexadecimal bytes (0xHH) for the double precision not-a-number. =back =for hackers Found in file config.h =over 4 =item C X This symbol contains the size of a double, so that the C preprocessor can make decisions based on it. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the double is the 64-bit C mainframe format. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the double is the 64-bit C mainframe format. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the double is the 64-bit C 754. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the double is the 64-bit C format D or G. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to convert strings into long doubles. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to classify doubles. Available for example in C. The returned values are defined in F and are: 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) =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to check whether a double is C (non-infinity non-NaN). =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to check whether a long double is finite (non-infinity non-NaN). =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to classify doubles. Available for example in Solaris/C. The returned values are defined in F and are: 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 =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to classify doubles. Available for example in HP-UX. The returned values are defined in F and are FP_NORMAL Normalized FP_ZERO Zero FP_INFINITE Infinity FP_SUBNORMAL Denormalized FP_NAN NaN =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to classify long doubles. Available for example in C. The returned values are defined in F and are: 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 =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to get the floating point rounding mode. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to classify doubles. Available for example in Digital C. The returned values are defined in F and are: 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) =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to classify doubles. The values are defined in F FP_NORMAL Normalized FP_ZERO Zero FP_INFINITE Infinity FP_SUBNORMAL Denormalized FP_NAN NaN =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to classify long doubles. Available for example in Digital C. See for possible values C. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to break a long double floating-point number into a normalized fraction and an integral power of 2. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to get integer exponent of a floating-point value. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to check whether a double is finite (non-infinity non-NaN). =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to check whether a long double is finite. (non-infinity non-NaN). =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to check whether a double is an infinity. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to check whether a long double is an infinity. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to check whether a double is a NaN. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to check whether a long double is a NaN. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to check whether a double is normal (non-zero normalized). =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates to the C program that the C function is available for Bessel functions of the first kind of the order zero, for doubles. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates to the C program that the C function is available for Bessel functions of the first kind of the order zero, for long doubles. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that this system's F or F defines the symbol C, which is the number of significant digits in a long double precision number. Unlike for C, there's no good guess for C if it is undefined. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to shift a long double floating-point number by an integral power of 2. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to return the long long value closest to a double (according to the current rounding mode). =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to return the long long value closest to a long double (according to the current rounding mode). =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to return the nearest long long value away from zero of the long double argument value. =back =for hackers Found in file config.h =over 4 =item C X This symbol will be defined if the C compiler supports long doubles. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to return the integral value closest to a double (according to the current rounding mode). =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to return the integral value closest to a long double (according to the current rounding mode). =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to return the nearest integral value away from zero of the long double argument value. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to split a long double x into a fractional part f and an integer part i such that |f| < 1.0 and (f + i) = x. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to generate NaN. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to return the next machine representable long double from x in direction y. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to return the floating-point C. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to multiply floating-point number by integral power of radix. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to check if the given number has the sign bit set. This should include correct testing of -0.0. This will only be set if the C routine is safe to use with the NV type used internally in perl. Users should call C, which will be #defined to the system's C function or macro if this symbol is defined. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to do long double square roots. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to convert strings to long doubles. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to convert strings to long doubles. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to convert strings to long doubles. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to round doubles towards zero. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to check whether two doubles are C (effectively: whether either of them is NaN) =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates to the C program that it should include F to get the floating point environment definitions. =over 3 #ifdef I_FENV #include #endif =back =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that F exists and should be included. =over 3 #ifdef I_QUADMATH #include #endif =back =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, is a comma-separated list of hexadecimal bytes for the long double precision infinity. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, tells how many mantissa bits there are in long double precision floating point format. Note that this can be C minus one, since C can include the C 754 implicit bit. The common x86-style 80-bit long double does not have an implicit bit. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, is a comma-separated list of hexadecimal bytes (0xHH) for the long double precision not-a-number. =back =for hackers Found in file config.h =over 4 =item C X C will be one of C C C C C C C C C C C C C It is only defined if the system supports long doubles. =back =for hackers Found in file config.h =over 4 =item C X This symbol contains the size of a long double, so that the C preprocessor can make decisions based on it. It is only defined if the system supports long doubles. Note that this is C, which may include unused bytes. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the long double is any of the C 754 style long doubles: C, C, C. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the long double is the 128-bit double-double. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the long double is the 80-bit C 754. Note that despite the 'extended' this is less than the 'std', since this is an extension of the double precision. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the long double is the 128-bit C 754. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the long double is the 128-bit C format H. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, tells how many mantissa bits (not including implicit bit) there are in a Perl NV. This depends on which floating point type was chosen. =back =for hackers Found in file config.h =over 4 =item C X This symbol gives the largest integer value that NVs can hold. This value + 1.0 cannot be stored accurately. It is expressed as constant floating point expression to reduce the chance of decimal/binary conversion issues. If it can not be determined, the value 0 is given. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that a variable of type C can preserve all the bits of a variable of type C. =back =for hackers Found in file config.h =over 4 =item C X This symbol contains the number of bits a variable of type C can preserve of a variable of type C. =back =for hackers Found in file config.h =over 4 =item C X This symbol contains the C. Note that some floating point formats have unused bytes. The most notable example is the x86* 80-bit extended precision which comes in byte sizes of 12 and 16 (for 32 and 64 bit platforms, respectively), but which only uses 10 bytes. Perl compiled with C<-Duselongdouble> on x86* is like this. =back =for hackers Found in file config.h =over 4 =item C X This symbol defines the C type used for Perl's NV. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that a variable of type C stores 0.0 in memory as all bits zero. =back =for hackers Found in file config.h =head1 Formats 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 C<%d>, C<%ld>, or something else. =over 4 =item C X This symbol defines the format string used for printing a Perl IV as a signed decimal integer. =back =for hackers Found in file config.h =over 4 =item C X This symbol defines the format string used for printing a Perl NV using %e-ish floating point format. =back =for hackers Found in file config.h =over 4 =item C X This symbol defines the format string used for printing a Perl NV using %f-ish floating point format. =back =for hackers Found in file config.h =over 4 =item C X This symbol defines the format string used for printing a Perl NV using %g-ish floating point format. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, contains the string used by stdio to format long doubles (format 'e') for output. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, contains the string used by stdio to format long doubles (format 'f') for output. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, contains the string used by stdio to format long doubles (format 'g') for output. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, contains the string used by stdio to format long doubles (format 'f') for input. =back =for hackers Found in file config.h =over 4 =item C X Allows C<__printf__> format to be null when checking printf-style =back =for hackers Found in file config.h =over 4 =item C Described in L. =back =for hackers Found in file pod/perlguts.pod =over 4 =item C Described in L. =over 3 UTF8fARG(bool is_utf8, Size_t byte_len, char *str) =back =back =for hackers Found in file pod/perlguts.pod =over 4 =item C X This symbol defines the format string used for printing a Perl UV as an unsigned octal integer. =back =for hackers Found in file config.h =over 4 =item C X This symbol defines the format string used for printing a Perl UV as an unsigned decimal integer. =back =for hackers Found in file config.h =over 4 =item C X This symbol defines the format string used for printing a Perl UV as an unsigned hexadecimal integer in uppercase C. =back =for hackers Found in file config.h =over 4 =item C X This symbol defines the format string used for printing a Perl UV as an unsigned hexadecimal integer in lowercase abcdef. =back =for hackers Found in file config.h =head1 General Configuration This section contains configuration information not otherwise found in the more specialized sections of this document. At the end is a list of C<#defines> whose name should be enough to tell you what they do, and a list of #defines which tell you if you need to C<#include> files to get the corresponding functionality. =over 4 =item C X This symbol holds the hexadecimal constant defined in byteorder, in a UV, i.e. 0x1234 or 0x4321 or 0x12345678, etc... If the compiler supports cross-compiling or multiple-architecture binaries, use compiler-defined macros to determine the byte order. =back =for hackers Found in file config.h =over 4 =item C X This symbol contains the size of a char, so that the C preprocessor can make decisions based on it. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, defines the major version number of Berkeley DB found in the F header when Perl was configured. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, defines the minor version number of Berkeley DB found in the F header when Perl was configured. For DB version 1 this is always 0. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, defines the patch version number of Berkeley DB found in the F header when Perl was configured. For DB version 1 this is always 0. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, removes the legacy default behavior of including '.' at the end of @C. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that we need to prepend an underscore to the symbol name before calling C. This only makes sense if you *have* dlsym, which we will presume is the case if you're using F. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that this system uses C encoding. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C-shell exists. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C program may use the C routine to derive the host name. See also C> and C>. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates to the C program that the C C library is being used. A better check is to use the C<__GLIBC__> and C<__GLIBC_MINOR__> symbols supplied with glibc. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to do the log gamma function. See also C> and C>. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to do the log gamma function without using the global signgam variable. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C compiler accepts, without error or warning, C that are declared with sizes other than plain 'int'; for example 'unsigned char' is accepted. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the prctl routine is available to set process title and supports C. =back =for hackers Found in file config.h =over 4 =item C X This symbol is defined if C is a symlink to the absolute pathname of the executing program. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that an emulation of the fork routine is available. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to do some regular pattern matching (usually on C.2 conforming systems). =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to set process group ID. =back =for hackers Found in file config.h =over 4 =item C X This variable indicates to the C program that the C routine is available to save the calling process's registers and stack environment for later use by C, and to optionally save the process's signal mask. See C>, C>, and C>. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C is supported. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C is supported. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to do the gamma function. See also C>. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C program may use the C routine to derive the host name. See also C> and C>. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C is defined by including F. If not, the user code probably needs to define it as: union semun { int val; struct semid_ds *buf; unsigned short *array; } =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates to the C program that it should include F. Using this symbol also triggers the definition of the C define which ends up being 'C' or 'C' depending on the availability of F. =over 3 #ifdef I_DIRENT #include #endif =back =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that F exists and should be included. (see also C>) =over 3 #ifdef I_POLL #include #endif =back =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates to the C program that it should include F. =over 3 #ifdef I_SYS_RESOURCE #include #endif =back =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that libm exports C<_LIB_VERSION> and that F defines the enum to manipulate it. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the system stores the variable argument list datatype, C, in a format that cannot be copied by simple assignment, so that some other means must be used when copying is required. As such systems vary in their provision (or non-provision) of copying mechanisms, F defines a platform- independent macro, C, to do the job. =back =for hackers Found in file config.h =over 4 =item C X This symbol contains the name of the operating system, as determined by Configure. You shouldn't rely on it too much; the specific feature tests from Configure are generally more reliable. =back =for hackers Found in file config.h =over 4 =item C X This symbol contains the version of the operating system, as determined by Configure. You shouldn't rely on it too much; the specific feature tests from Configure are generally more reliable. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates the command to feed to the C routine to derive the host name. See also C> and C>. Note that the command uses a fully qualified path, so that it is safe even if used by a process with super-user privileges. =back =for hackers Found in file config.h =over 4 =item C X If C is defined this symbol is the filename of the symbolic link pointing to the absolute pathname of the executing program. =back =for hackers Found in file config.h =over 4 =item C X This symbol contains the size of a pointer, so that the C preprocessor can make decisions based on it. It will be C if the compiler supports (void *); otherwise it will be C. =back =for hackers Found in file config.h =over 4 =item C X This symbol indicates how many bits are produced by the function used to generate normalized random numbers. Values include 15, 16, 31, and 48. =back =for hackers Found in file config.h =over 4 =item C X This symbol holds the minimum number of bits operated by select. That is, if you do C, how many bits at least will be cleared in the masks if some activity is detected. Usually this is either n or 32*C, especially many little-endians do the latter. This is only useful if you have C, naturally. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the bug that prevents setuid scripts from being secure is not present in this kernel. =back =for hackers Found in file config.h =over 4 =item C X This symbol holds the signedness of C's C. 1 for unsigned, -1 for signed. =back =for hackers Found in file config.h =over 4 =item C X This variable contains the size of C's C in bytes. =back =for hackers Found in file config.h =head2 List of capability C> symbols 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 C. 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 L. Each symbol here will be C<#define>d if and only if the platform has the capability. If you need more detail, see the corresponding entry in F. For convenience, the list is split so that the ones that indicate there is a reentrant version of a capability are listed separately C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C And, the reentrant capabilities: C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C Example usage: =over #ifdef HAS_STRNLEN use strnlen() #else use an alternative implementation #endif =back =head2 List of C<#include> needed symbols This list contains symbols that indicate if certain C<#include> files are present on the platform. If your code accesses the functionality that one of these is for, you will need to C<#include> it if the symbol on this list is C<#define>d. For more detail, see the corresponding entry in F. C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C,S< > C Example usage: =over #ifdef I_WCHAR #include #endif =back =head1 Global Variables 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 L. 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. =over 4 =item C X Array, indexed by opcode, of functions that will be called for the "check" phase of optree building during compilation of Perl code. For most (but not all) types of op, once the op has been initially built and populated with child ops it will be filtered through the check function referenced by the appropriate element of this array. The new op is passed in as the sole argument to the check function, and the check function returns the completed op. The check function may (as the name suggests) check the op for validity and signal errors. It may also initialise or modify parts of the ops, or perform more radical surgery such as adding or removing child ops, or even throw the op away and return a different op in its place. This array of function pointers is a convenient place to hook into 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 B 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 L. =back =for hackers Found in file perlvars.h =over 4 =item C X NOTE: C is B and may change or be removed without notice. 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. C points at the word in the parser's input buffer, and C gives its length; it is not null-terminated. The function is expected to examine the word, and possibly other state such as L<%^H|perlvar/%^H>, to decide whether it wants to handle it as an extended keyword. If it does not, the function should return C, 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 L for details. When a keyword is being handled, the plugin function must build a tree of C structures, representing the code that was parsed. The root of the tree must be stored in C<*op_ptr>. The function then returns a constant indicating the syntactic role of the construct that it has parsed: C if it is a complete statement, or C if it is an expression. Note that a statement construct cannot be used inside an expression (except via C 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 C<%^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 C<*PL_keyword_plugin> function needs to behave overall. Conventionally, however, one does not completely replace the existing handler function. Instead, take a copy of C 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 C 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 C. For thread safety, modules should not set this variable directly. Instead, use the function L. =back =for hackers Found in file perlvars.h =over 4 =item C X A value that indicates the current Perl interpreter's phase. Possible values include C, C, C, C, C, C, and C. For example, the following determines whether the interpreter is in global destruction: if (PL_phase == PERL_PHASE_DESTRUCT) { // we are in global destruction } C was introduced in Perl 5.14; in prior perls you can use C (boolean) to determine whether the interpreter is in global destruction. (Use of C is discouraged since 5.14.) =over 3 enum perl_phase PL_phase =back =back =for hackers Found in file perlvars.h =head1 GV Handling A GV is a structure which corresponds to to a Perl typeglob, ie *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. =over 4 =item C X Equivalent to C>. =over 3 GV* gv_autoload4(HV* stash, const char* name, STRLEN len, I32 method) =back =back =for hackers Found in file gv.h =over 4 =item C X Return the AV from the GV. =over 3 AV* GvAV(GV* gv) =back =back =for hackers Found in file gv.h =over 4 =item C X If C is a typeglob whose subroutine entry is a constant sub eligible for inlining, or C is a placeholder reference that would be promoted to such a typeglob, then returns the value returned by the sub. Otherwise, returns C. =over 3 SV* gv_const_sv(GV* gv) =back =back =for hackers Found in file gv.c =over 4 =item C X Return the CV from the GV. =over 3 CV* GvCV(GV* gv) =back =back =for hackers Found in file gv.h =over 4 =item C =item C XX These return the debugger glob for the file (compiled by Perl) whose name is given by the C parameter. There are currently exactly two differences between these functions. The C parameter to C is a C string, meaning it is C-terminated; whereas the C parameter to C is a Perl string, whose length (in bytes) is passed in via the C parameter This means the name may contain embedded C characters. C doesn't exist in plain C). The other difference is that C has an extra C parameter, which is currently completely ignored, but allows for possible future extensions. =over 3 GV* gv_fetchfile (const char* name) GV* gv_fetchfile_flags(const char *const name, const STRLEN len, const U32 flags) =back =back =for hackers Found in file gv.c =over 4 =item C X Like L, but lacks a flags parameter. =over 3 GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level) =back =back =for hackers Found in file gv.c =over 4 =item C X See L. =over 3 GV* gv_fetchmethod(HV* stash, const char* name) =back =back =for hackers Found in file mathoms.c =over 4 =item C X Returns the glob which contains the subroutine to call to invoke the method on the C. In fact in the presence of autoloading this may be the glob for "AUTOLOAD". In this case the corresponding variable C<$AUTOLOAD> is already setup. The third parameter of C 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 C is equivalent to calling C with a non-zero C parameter. These functions grant C<"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 C<$AUTOLOAD> changing its value. Use the glob created as a side effect to do this. These functions have the same side-effects as C with C. The warning against passing the GV returned by C to C applies equally to these functions. =over 3 GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload) =back =back =for hackers Found in file gv.c =over 4 =item C X This is the old form of L, which has no flags parameter. =over 3 GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level) =back =back =for hackers Found in file gv.c =over 4 =item C X Exactly like L, but takes a nul-terminated string instead of a string/length pair. =over 3 GV* gv_fetchmeth_pv(HV* stash, const char* name, I32 level, U32 flags) =back =back =for hackers Found in file gv.c =over 4 =item C X Returns the glob with the given C and a defined subroutine or C. The glob lives in the given C, or in the stashes accessible via C<@ISA> and C. The argument C should be either 0 or -1. If C, as a side-effect creates a glob with the given C in the given C which in the case of success contains an alias for the subroutine, and sets up caching info for this glob. The only significant values for C are C, C, and C. C indicates that we want to look up the method in the superclasses of the C. C indicates that we do not want to look up the method in the stash accessible by C. The GV returned from C may be a method cache entry, which is not visible to Perl code. So when calling C, you should not use the GV directly; instead, you should use the method's CV, which can be obtained from the GV with the C macro. =over 3 GV* gv_fetchmeth_pvn(HV* stash, const char* name, STRLEN len, I32 level, U32 flags) =back =back =for hackers Found in file gv.c =over 4 =item C X Same as C, but looks for autoloaded subroutines too. Returns a glob for the subroutine. For an autoloaded subroutine without a GV, will create a GV even if C. For an autoloaded subroutine without a stub, C of the result may be zero. Currently, the only significant value for C is C. =over 3 GV* gv_fetchmeth_pvn_autoload(HV* stash, const char* name, STRLEN len, I32 level, U32 flags) =back =back =for hackers Found in file gv.c =over 4 =item C X Exactly like L, but takes a nul-terminated string instead of a string/length pair. =over 3 GV* gv_fetchmeth_pv_autoload(HV* stash, const char* name, I32 level, U32 flags) =back =back =for hackers Found in file gv.c =over 4 =item C X Exactly like L, but takes the name string in the form of an SV instead of a string/length pair. =over 3 GV* gv_fetchmeth_sv(HV* stash, SV* namesv, I32 level, U32 flags) =back =back =for hackers Found in file gv.c =over 4 =item C X Exactly like L, but takes the name string in the form of an SV instead of a string/length pair. =over 3 GV* gv_fetchmeth_sv_autoload(HV* stash, SV* namesv, I32 level, U32 flags) =back =back =for hackers Found in file gv.c =over 4 =item C =item C =item C =item C =item C =item C XXXXXX These all return the GV of type C whose name is given by the inputs, or NULL if no GV of that name and type could be found. See L. 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 C in its name. They all have a C parameter in fact, and all the flag bits have the same meanings for all If any of the flags C, C, C, C, or C is set, a GV is created if none already exists for the input name and type. However, C will only do the creation for magical GV's. For all of these flags except C, C> is called after the addition. C 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 C flag means to pretend that the GV has been seen before (I, suppress "Used once" warnings). The flag C causes C> not be to called if the GV existed but isn't PVGV. If the C 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 C-named forms, and the UTF-8ness of the underlying SVs will be used in the C forms. If the flag C 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 C, C is a C string, NUL-terminated with no intermediate NULs. In C, C is a literal C string, hence is enclosed in double quotes. C and C are identical. In these, is a Perl string whose byte length is given by C, and may contain embedded NULs. In C and C, the name is extracted from the PV of the input C SV. The only difference between these two forms is that 'get' magic is normally done on C in C, and always skipped with C. Including C in the C parameter to C makes it behave identically to C. =over 3 GV* gv_fetchpv (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 * gv_fetchpvs ("name", I32 flags, const svtype sv_type) GV* gv_fetchsv (SV *name, I32 flags, const svtype sv_type) GV * gv_fetchsv_nomg (SV *name, I32 flags, const svtype sv_type) =back =back =for hackers Found in file gv.c =over 4 =item C X Return the HV from the GV. =over 3 HV* GvHV(GV* gv) =back =back =for hackers Found in file gv.h =over 4 =item C X The old form of C. It does not work with UTF-8 strings, as it has no flags parameter. If the C parameter is set, the C flag will be passed to C. =over 3 void gv_init(GV* gv, HV* stash, const char* name, STRLEN len, int multi) =back =back =for hackers Found in file gv.c =over 4 =item C X Same as C, but takes a nul-terminated string for the name instead of separate char * and length parameters. =over 3 void gv_init_pv(GV* gv, HV* stash, const char* name, U32 flags) =back =back =for hackers Found in file gv.c =over 4 =item C X Converts a scalar into a typeglob. This is an incoercible typeglob; assigning a reference to it will assign to one of its slots, instead of overwriting it as happens with typeglobs created by C. Converting any scalar that is C may produce unpredictable results and is reserved for perl's internal use. C is the scalar to be converted. C is the parent stash/package, if any. C and C give the name. The name must be unqualified; that is, it must not include the package name. If C 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. C can be set to C if C is a UTF-8 string, or the return value of SvUTF8(sv). It can also take the C flag, which means to pretend that the GV has been seen before (i.e., suppress "Used once" warnings). =over 3 void gv_init_pvn(GV* gv, HV* stash, const char* name, STRLEN len, U32 flags) =back =back =for hackers Found in file gv.c =over 4 =item C X Same as C, but takes an SV * for the name instead of separate char * and length parameters. C is currently unused. =over 3 void gv_init_sv(GV* gv, HV* stash, SV* namesv, U32 flags) =back =back =for hackers Found in file gv.c =over 4 =item C X Returns a pointer to the stash for a specified package. Uses C to determine the length of C, then calls C. =over 3 HV* gv_stashpv(const char* name, I32 flags) =back =back =for hackers Found in file gv.c =over 4 =item C X Returns a pointer to the stash for a specified package. The C parameter indicates the length of the C, in bytes. C is passed to C, so if set to C then the package will be created if it does not already exist. If the package does not exist and C is 0 (or any other setting that does not create packages) then C 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 C and C. Note, use of C instead of C where possible is strongly recommended for performance reasons. =over 3 HV* gv_stashpvn(const char* name, U32 namelen, I32 flags) =back =back =for hackers Found in file gv.c =over 4 =item C X Like C, but takes a literal string instead of a string/length pair. =over 3 HV* gv_stashpvs("name", I32 create) =back =back =for hackers Found in file handy.h =over 4 =item C X Returns a pointer to the stash for a specified package. See C>. Note this interface is strongly preferred over C for performance reasons. =over 3 HV* gv_stashsv(SV* sv, I32 flags) =back =back =for hackers Found in file gv.c =over 4 =item C X Return the SV from the GV. Prior to Perl v5.9.3, this would add a scalar if none existed. Nowadays, use C> for that, or compile perl with S>. See L. =over 3 SV* GvSV(GV* gv) =back =back =for hackers Found in file gv.h =over 4 =item C X Like C>, but creates an empty scalar if none already exists. =over 3 SV* GvSVn(GV* gv) =back =back =for hackers Found in file gv.h =over 4 =item C X Saves the current GP of gv on the save stack to be restored on scope exit. 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 C< local *foo = $someref; > works. =over 3 void save_gp(GV* gv, I32 empty) =back =back =for hackers Found in file scope.c =over 4 =item C X Sets C, the default file handle for output, to the passed in typeglob. As C "owns" a reference on its typeglob, the reference count of the passed in typeglob is increased by one, and the reference count of the typeglob that C points to is decreased by one. =over 3 void setdefout(GV* gv) =back =back =for hackers Found in file pp_sys.c =head1 Hook manipulation These functions provide convenient and thread-safe means of manipulating hook variables. =over 4 =item C X Puts a C function into the chain of check functions for a specified op type. This is the preferred way to manipulate the L array. C specifies which type of op is to be affected. C is a pointer to the C function that is to be added to that opcode's check chain, and C points to the storage location where a pointer to the next function in the chain will be stored. The value of C is written into the L array, while the value previously stored there is written to C<*old_checker_p>. L 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 C<*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 C 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 C<*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 L. When this function is called, the function referenced by C must be ready to be called, except for C<*old_checker_p> being unfilled. In a threading situation, C may be called immediately, even before this function has returned. C<*old_checker_p> will always be appropriately set before C is called. If C 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 C<*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 L rather than hooking checking of all C ops. =over 3 void wrap_op_checker(Optype opcode, Perl_check_t new_checker, Perl_check_t *old_checker_p) =back =back =for hackers Found in file op.c =head1 HV Handling 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. =over 4 =item C X Returns the HV of the specified Perl hash. C are passed to C. If C is set and the Perl variable does not exist then it will be created. If C is zero and the variable does not exist then C is returned. NOTE: the C form is B. =over 3 HV* get_hv(const char *name, I32 flags) =back =back =for hackers Found in file perl.c =over 4 =item C X This flag, used in the length slot of hash entries and magic structures, specifies the structure contains an C pointer where a C pointer is to be expected. (For information only--not to be used). =back =for hackers Found in file hv.h =over 4 =item C X Returns the computed hash stored in the hash entry. =over 3 U32 HeHASH(HE* he) =back =back =for hackers Found in file hv.h =over 4 =item C X Returns the actual pointer stored in the key slot of the hash entry. The pointer may be either C or C, depending on the value of C. Can be assigned to. The C or C macros are usually preferable for finding the value of a key. =over 3 void* HeKEY(HE* he) =back =back =for hackers Found in file hv.h =over 4 =item C X If this is negative, and amounts to C, it indicates the entry holds an C key. Otherwise, holds the actual length of the key. Can be assigned to. The C macro is usually preferable for finding key lengths. =over 3 STRLEN HeKLEN(HE* he) =back =back =for hackers Found in file hv.h =over 4 =item C X Returns the key slot of the hash entry as a C value, doing any necessary dereferencing of possibly C keys. The length of the string is placed in C (this is a macro, so do I use C<&len>). If you do not care about what the length of the key is, you may use the global variable C, though this is rather less efficient than using a local variable. Remember though, that hash keys in perl are free to contain embedded nulls, so using C or similar is not a good way to find the length of hash keys. This is very similar to the C macro described elsewhere in this document. See also C>. If you are using C to get values to pass to C to create a new SV, you should consider using C as it is more efficient. =over 3 char* HePV(HE* he, STRLEN len) =back =back =for hackers Found in file hv.h =over 4 =item C X Returns the key as an C, or C if the hash entry does not contain an C key. =over 3 SV* HeSVKEY(HE* he) =back =back =for hackers Found in file hv.h =over 4 =item C X Returns the key as an C. Will create and return a temporary mortal C if the hash entry contains only a C key. =over 3 SV* HeSVKEY_force(HE* he) =back =back =for hackers Found in file hv.h =over 4 =item C X Sets the key to a given C, taking care to set the appropriate flags to indicate the presence of an C key, and returns the same C. =over 3 SV* HeSVKEY_set(HE* he, SV* sv) =back =back =for hackers Found in file hv.h =over 4 =item C X Returns whether the C value returned by C is encoded in UTF-8, doing any necessary dereferencing of possibly C keys. The value returned will be 0 or non-0, not necessarily 1 (or even a value with any low bits set), so B blindly assign this to a C variable, as C may be a typedef for C. =over 3 U32 HeUTF8(HE* he) =back =back =for hackers Found in file hv.h =over 4 =item C X Returns the value slot (type C) stored in the hash entry. Can be assigned to. SV *foo= HeVAL(hv); HeVAL(hv)= sv; =over 3 SV* HeVAL(HE* he) =back =back =for hackers Found in file hv.h =over 4 =item C Described in L. =back =for hackers Found in file pod/perlguts.pod =over 4 =item C X Check that a hash is in an internally consistent state. NOTE: C must be explicitly called as C with an C parameter. =over 3 void Perl_hv_assert(pTHX_ HV *hv) =back =back =for hackers Found in file hv.c =over 4 =item C X NOTE: C is B and may change or be removed without notice. 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. =over 3 SV* hv_bucket_ratio(HV *hv) =back =back =for hackers Found in file hv.c =over 4 =item C X Frees all the elements of a hash, leaving it empty. The XS equivalent of C<%hash = ()>. See also L. See L for a note about the hash possibly being invalid on return. =over 3 void hv_clear(HV *hv) =back =back =for hackers Found in file hv.c =over 4 =item C X Clears any placeholders from a hash. If a restricted hash has any of its keys marked as readonly and the key is subsequently deleted, the key is not actually deleted but is marked by assigning it a value of C<&PL_sv_placeholder>. This tags it so it will be ignored by future operations such as iterating over the hash, but will still allow the hash to have a value reassigned to the key at some future point. This function clears any such placeholder keys from the hash. See C> for an example of its use. =over 3 void hv_clear_placeholders(HV *hv) =back =back =for hackers Found in file hv.c =over 4 =item C X A specialised version of L for copying C<%^H>. C must be a pointer to a hash (which may have C<%^H> magic, but should be generally non-magical), or C (interpreted as an empty hash). The content of C is copied to a new hash, which has the C<%^H>-specific magic added to it. A pointer to the new hash is returned. =over 3 HV * hv_copy_hints_hv(HV *const ohv) =back =back =for hackers Found in file hv.c =over 4 =item C X Deletes a key/value pair in the hash. The value's SV is removed from the hash, made mortal, and returned to the caller. The absolute value of C is the length of the key. If C is negative the key is assumed to be in UTF-8-encoded Unicode. The C value will normally be zero; if set to C then C will be returned. C will also be returned if the key is not found. =over 3 SV* hv_delete(HV *hv, const char *key, I32 klen, I32 flags) =back =back =for hackers Found in file hv.c =over 4 =item C X Deletes a key/value pair in the hash. The value SV is removed from the hash, made mortal, and returned to the caller. The C value will normally be zero; if set to C then C will be returned. C will also be returned if the key is not found. C can be a valid precomputed hash value, or 0 to ask for it to be computed. =over 3 SV* hv_delete_ent(HV *hv, SV *keysv, I32 flags, U32 hash) =back =back =for hackers Found in file hv.c =over 4 =item C X Returns the effective name of a stash, or NULL if there is none. The effective name represents a location in the symbol table where this stash resides. It is updated automatically when packages are aliased or deleted. A stash that is no longer in the symbol table has no effective name. This name is preferable to C for use in MRO linearisations and isa caches. =over 3 char* HvENAME(HV* stash) =back =back =for hackers Found in file hv.h =over 4 =item C X Returns the length of the stash's effective name. =over 3 STRLEN HvENAMELEN(HV *stash) =back =back =for hackers Found in file hv.h =over 4 =item C X Returns true if the effective name is in UTF-8 encoding. =over 3 unsigned char HvENAMEUTF8(HV *stash) =back =back =for hackers Found in file hv.h =over 4 =item C X Returns a boolean indicating whether the specified hash key exists. The absolute value of C is the length of the key. If C is negative the key is assumed to be in UTF-8-encoded Unicode. =over 3 bool hv_exists(HV *hv, const char *key, I32 klen) =back =back =for hackers Found in file hv.c =over 4 =item C X Returns a boolean indicating whether the specified hash key exists. C can be a valid precomputed hash value, or 0 to ask for it to be computed. =over 3 bool hv_exists_ent(HV *hv, SV *keysv, U32 hash) =back =back =for hackers Found in file hv.c =over 4 =item C X Returns the SV which corresponds to the specified key in the hash. The absolute value of C is the length of the key. If C is negative the key is assumed to be in UTF-8-encoded Unicode. If C 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 C it points to can be assigned to. But always check that the return value is non-null before dereferencing it to an C. See L for more information on how to use this function on tied hashes. =over 3 SV** hv_fetch(HV *hv, const char *key, I32 klen, I32 lval) =back =back =for hackers Found in file hv.c =over 4 =item C X Like C, but takes a literal string instead of a string/length pair. =over 3 SV** hv_fetchs(HV* tb, "key", I32 lval) =back =back =for hackers Found in file handy.h =over 4 =item C X Returns the hash entry which corresponds to the specified key in the hash. C must be a valid precomputed hash number for the given C, or 0 if you want the function to compute it. IF C is set then the fetch will be part of a store. Make sure the return value is non-null before accessing it. The return value when C is a tied hash is a pointer to a static location, so be sure to make a copy of the structure if you need to store it somewhere. See L for more information on how to use this function on tied hashes. =over 3 HE* hv_fetch_ent(HV *hv, SV *keysv, I32 lval, U32 hash) =back =back =for hackers Found in file hv.c =over 4 =item C X See L. =over 3 STRLEN HvFILL(HV *const hv) =back =back =for hackers Found in file hv.h =over 4 =item C X Returns the number of hash buckets that happen to be in use. This function is wrapped by the macro C. 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. NOTE: C must be explicitly called as C with an C parameter. =over 3 STRLEN Perl_hv_fill(pTHX_ HV *const hv) =back =back =for hackers Found in file hv.c =over 4 =item C X Prepares a starting point to traverse a hash table. Returns the number of keys in the hash, including placeholders (i.e. the same as C). The return value is currently only meaningful for hashes without tie magic. NOTE: Before version 5.004_65, C 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 C. =over 3 I32 hv_iterinit(HV *hv) =back =back =for hackers Found in file hv.c =over 4 =item C X Returns the key from the current position of the hash iterator. See C>. =over 3 char* hv_iterkey(HE* entry, I32* retlen) =back =back =for hackers Found in file hv.c =over 4 =item C X Returns the key as an C from the current position of the hash iterator. The return value will always be a mortal copy of the key. Also see C>. =over 3 SV* hv_iterkeysv(HE* entry) =back =back =for hackers Found in file hv.c =over 4 =item C X Returns entries from a hash iterator. See C>. You may call C or C 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 C, so you must not discard your iterator immediately else the entry will leak - call C to trigger the resource deallocation. =over 3 HE* hv_iternext(HV *hv) =back =back =for hackers Found in file hv.c =over 4 =item C X Performs an C, C, and C in one operation. =over 3 SV* hv_iternextsv(HV *hv, char **key, I32 *retlen) =back =back =for hackers Found in file hv.c =over 4 =item C X NOTE: C is B and may change or be removed without notice. Returns entries from a hash iterator. See C> and C>. The C value will normally be zero; if C 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 C<&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. =over 3 HE* hv_iternext_flags(HV *hv, I32 flags) =back =back =for hackers Found in file hv.c =over 4 =item C X Returns the value from the current position of the hash iterator. See C>. =over 3 SV* hv_iterval(HV *hv, HE *entry) =back =back =for hackers Found in file hv.c =over 4 =item C X Adds magic to a hash. See C>. =over 3 void hv_magic(HV *hv, GV *gv, int how) =back =back =for hackers Found in file hv.c =over 4 =item C X Returns the package name of a stash, or C if C isn't a stash. See C>, C>. =over 3 char* HvNAME(HV* stash) =back =back =for hackers Found in file hv.h =over 4 =item C X Returns the length of the stash's name. Disfavored forms of HvNAME and HvNAMELEN; suppress mention of them =over 3 STRLEN HvNAMELEN(HV *stash) =back =back =for hackers Found in file hv.h =over 4 =item C X Returns true if the name is in UTF-8 encoding. =over 3 unsigned char HvNAMEUTF8(HV *stash) =back =back =for hackers Found in file hv.h =over 4 =item C X Evaluates the hash in scalar context and returns the result. 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. =over 3 SV* hv_scalar(HV *hv) =back =back =for hackers Found in file hv.c =over 4 =item C X Stores an SV in a hash. The hash key is specified as C and the absolute value of C is the length of the key. If C is negative the key is assumed to be in UTF-8-encoded Unicode. The C parameter is the precomputed hash value; if it is zero then Perl will compute it. The return value will be C if the operation failed or if the value did not need to be actually stored within the hash (as in the case of tied hashes). Otherwise it can be dereferenced to get the original C. Note that the caller is responsible for suitably incrementing the reference count of C before the call, and decrementing it if the function returned C. Effectively a successful C takes ownership of one reference to C. 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 then store them in a hash, C will own the only reference to the new SV, and your code doesn't need to do anything further to tidy up. C is not implemented as a call to C, and does not create a temporary SV for the key, so if your key data is not already in SV form then use C in preference to C. See L for more information on how to use this function on tied hashes. =over 3 SV** hv_store(HV *hv, const char *key, I32 klen, SV *val, U32 hash) =back =back =for hackers Found in file hv.c =over 4 =item C X Like C, but takes a literal string instead of a string/length pair and omits the hash parameter. =over 3 SV** hv_stores(HV* tb, "key", SV* val) =back =back =for hackers Found in file handy.h =over 4 =item C X Stores C in a hash. The hash key is specified as C. The C parameter is the precomputed hash value; if it is zero then Perl will compute it. The return value is the new hash entry so created. It will be C if the operation failed or if the value did not need to be actually stored within the hash (as in the case of tied hashes). Otherwise the contents of the return value can be accessed using the C macros described here. Note that the caller is responsible for suitably incrementing the reference count of C before the call, and decrementing it if the function returned NULL. Effectively a successful C takes ownership of one reference to C. 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 then store them in a hash, C will own the only reference to the new SV, and your code doesn't need to do anything further to tidy up. Note that C only reads the C; unlike C it does not take ownership of it, so maintaining the correct reference count on C is entirely the caller's responsibility. The reason it does not take ownership, is that C is not used after this function returns, and so can be freed immediately. C is not implemented as a call to C, and does not create a temporary SV for the key, so if your key data is not already in SV form then use C in preference to C. See L for more information on how to use this function on tied hashes. =over 3 HE* hv_store_ent(HV *hv, SV *key, SV *val, U32 hash) =back =back =for hackers Found in file hv.c =over 4 =item C X Undefines the hash. The XS equivalent of C. As well as freeing all the elements of the hash (like C), this also frees any auxiliary data and storage associated with the hash. See L for a note about the hash possibly being invalid on return. =over 3 void hv_undef(HV *hv) =back =back =for hackers Found in file hv.c =over 4 =item C Described in L. =back =for hackers Found in file pod/perlguts.pod =over 4 =item C X Creates a new HV. The reference count is set to 1. =over 3 HV* newHV() =back =back =for hackers Found in file hv.h =over 4 =item C X C> It is planned to remove C from a future release of Perl. Do not use it for new code; remove it from existing code. Null HV pointer. (deprecated - use C<(HV *)NULL> instead) =back =for hackers Found in file hv.h =over 4 =item C Described in L. =over 3 void PERL_HASH(U32 hash, char *key, STRLEN klen) =back =back =for hackers Found in file pod/perlguts.pod =over 4 =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C Described in L. =back =for hackers Found in file pod/perlguts.pod =over 4 =item C X C is a general purpose, interpreter global HV for use by extensions that need to keep information on a per-interpreter basis. In a pinch, it can also be used as a symbol table for extensions to share data among each other. It is a good idea to use keys prefixed by the package name of the extension that owns the data. 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. =over 3 HV* PL_modglobal =back =back =for hackers Found in file intrpvar.h =head1 Input/Output =over 4 =item C Described in L. =over 3 int PerlIO_apply_layers(PerlIO *f, const char *mode, const char *layers) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 int PerlIO_binmode(PerlIO *f, int ptype, int imode, const char *layers) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 int PerlIO_canset_cnt(PerlIO *f) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 void PerlIO_clearerr(PerlIO *f) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 int PerlIO_close(PerlIO *f) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 void PerlIO_debug(const char *fmt, ...) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 int PerlIO_eof(PerlIO *f) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 int PerlIO_error(PerlIO *f) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 FILE * PerlIO_exportFILE(PerlIO *f, const char *mode) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 int PerlIO_fast_gets(PerlIO *f) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 PerlIO* PerlIO_fdopen(int fd, const char *mode) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 int PerlIO_fileno(PerlIO *f) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 FILE * PerlIO_findFILE(PerlIO *f) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 int PerlIO_flush(PerlIO *f) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C Described in L. =back =for hackers Found in file pod/perliol.pod =over 4 =item C Described in L. =over 3 int PerlIO_getc(PerlIO *d) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 int PerlIO_getpos(PerlIO *f, SV *save) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 STDCHAR * PerlIO_get_base(PerlIO *f) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 SSize_t PerlIO_get_bufsiz(PerlIO *f) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 SSize_t PerlIO_get_cnt(PerlIO *f) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 STDCHAR * PerlIO_get_ptr(PerlIO *f) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 int PerlIO_has_base(PerlIO *f) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 int PerlIO_has_cntptr(PerlIO *f) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 PerlIO* PerlIO_importFILE(FILE *stdio, const char *mode) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C =item C =item C =item C =item C Described in L. =back =for hackers Found in file pod/perliol.pod =over 4 =item C Described in L. =over 3 PerlIO* PerlIO_open(const char *path, const char *mode) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 int PerlIO_printf(PerlIO *f, const char *fmt, ...) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 int PerlIO_putc(PerlIO *f, int ch) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 int PerlIO_puts(PerlIO *f, const char *string) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 SSize_t PerlIO_read(PerlIO *f, void *vbuf, Size_t count) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 void PerlIO_releaseFILE(PerlIO *f, FILE *stdio) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 PerlIO * PerlIO_reopen(const char *path, const char *mode, PerlIO *old) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 void PerlIO_rewind(PerlIO *f) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 int PerlIO_seek(PerlIO *f, Off_t offset, int whence) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 void PerlIO_setlinebuf(PerlIO *f) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 int PerlIO_setpos(PerlIO *f, SV *saved) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 void PerlIO_set_cnt(PerlIO *f, SSize_t cnt) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 void PerlIO_set_ptrcnt(PerlIO *f, STDCHAR *ptr, SSize_t cnt) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 PerlIO * PerlIO_stderr() =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 PerlIO * PerlIO_stdin() =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 PerlIO * PerlIO_stdout() =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 int PerlIO_stdoutf(const char *fmt, ...) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 Off_t PerlIO_tell(PerlIO *f) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 int PerlIO_ungetc(PerlIO *f, int ch) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 int PerlIO_vprintf(PerlIO *f, const char *fmt, va_list args) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =over 3 SSize_t PerlIO_write(PerlIO *f, const void *vbuf, Size_t count) =back =back =for hackers Found in file pod/perlapio.pod =over 4 =item C Described in L. =back =for hackers Found in file pod/perliol.pod =head1 Integer configuration values =over 4 =item C X This symbol is defined if the C compiler can cast negative or large floating point numbers to 32-bit ints. =back =for hackers Found in file config.h =over 4 =item C X This symbol will defined if the C compiler supports C. Usually the F needs to be included, but sometimes F is enough. =back =for hackers Found in file config.h =over 4 =item C X This symbol will be defined if the C compiler supports long long. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, tells that there's a 64-bit integer type, C, and its unsigned counterpart, C. C will be one of C, C, C, C, or C. =back =for hackers Found in file config.h =over 4 =item C Described in L. =back =for hackers Found in file pod/perlguts.pod =over 4 =item C =item C =item C =item C =item C Described in L. =back =for hackers Found in file pod/perlguts.pod =over 4 =item C X This symbol contains the C. =back =for hackers Found in file config.h =over 4 =item C X This symbol defines the C type used for Perl's I32. =back =for hackers Found in file config.h =over 4 =item C X This symbol contains the C. =back =for hackers Found in file config.h =over 4 =item C X This symbol defines the C type used for Perl's I64. =back =for hackers Found in file config.h =over 4 =item C X This symbol contains the C. =back =for hackers Found in file config.h =over 4 =item C X This symbol defines the C type used for Perl's I16. =back =for hackers Found in file config.h =over 4 =item C =item C =item C XXX Returns a token the C compiler recognizes for the constant C of the corresponding integer type on the machine. If the machine does not have a 64-bit type, C is undefined. Use C> to get the largest type available on the platform. =over 3 I16 INT16_C(number) I32 INT32_C(number) I64 INT64_C(number) =back =back =for hackers Found in file perl.h =over 4 =item C X Returns a token the C compiler recognizes for the constant C of the widest integer type on the machine. For example, if the machine has Cs, C would yield -1LL See also, for example, C>. Use L to declare variables of the maximum usable size on this platform. =over 3 INTMAX_C(number) =back =back =for hackers Found in file perl.h =over 4 =item C X This symbol contains the value of C so that the C preprocessor can make decisions based on it. =back =for hackers Found in file config.h =over 4 =item C X This symbol contains the C. =back =for hackers Found in file config.h =over 4 =item C X This symbol defines the C type used for Perl's I8. =back =for hackers Found in file config.h =over 4 =item C X The largest signed integer that fits in an IV on this platform. =over 3 IV IV_MAX =back =back =for hackers Found in file perl.h =over 4 =item C X The negative signed integer furthest away from 0 that fits in an IV on this platform. =over 3 IV IV_MIN =back =back =for hackers Found in file perl.h =over 4 =item C X This symbol contains the C. =back =for hackers Found in file config.h =over 4 =item C X This symbol defines the C type used for Perl's IV. =back =for hackers Found in file config.h =over 4 =item C X The typedef to use to declare variables that are to hold line numbers. =back =for hackers Found in file handy.h =over 4 =item C X This symbol contains the size of a long long, so that the C preprocessor can make decisions based on it. It is only defined if the system supports long long. =back =for hackers Found in file config.h =over 4 =item C X This symbol contains the value of C so that the C preprocessor can make decisions based on it. =back =for hackers Found in file config.h =over 4 =item C X Set the C bytes starting at C<*d> to all zeroes. =over 3 void memzero(void * d, Size_t l) =back =back =for hackers Found in file perl.h =over 4 =item C Described in L. =back =for hackers Found in file pod/perlguts.pod =over 4 =item C =item C =item C =item C XXXX These are equivalent to the correspondingly-named C99 typedefs on platforms that have those; they evaluate to C and C on platforms that don't, so that you can portably take advantage of this C99 feature. =back =for hackers Found in file handy.h =over 4 =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C XXXXXXXXXXXXXXXXXX These give the largest and smallest number representable in the current platform in variables of the corresponding types. 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 C, 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. =back =for hackers Found in file perl.h =over 4 =item C X This symbol contains the value of C so that the C preprocessor can make decisions based on it. =back =for hackers Found in file config.h =over 4 =item C Described in L. =back =for hackers Found in file pod/perlguts.pod =over 4 =item C =item C =item C =item C =item C Described in L. =back =for hackers Found in file pod/perlguts.pod =over 4 =item C X This symbol contains the C. =back =for hackers Found in file config.h =over 4 =item C X This symbol defines the C type used for Perl's U32. =back =for hackers Found in file config.h =over 4 =item C X This symbol contains the C. =back =for hackers Found in file config.h =over 4 =item C X This symbol defines the C type used for Perl's U64. =back =for hackers Found in file config.h =over 4 =item C X This symbol contains the C. =back =for hackers Found in file config.h =over 4 =item C X This symbol defines the C type used for Perl's U16. =back =for hackers Found in file config.h =over 4 =item C =item C =item C XXX Returns a token the C compiler recognizes for the constant C of the corresponding unsigned integer type on the machine. If the machine does not have a 64-bit type, C is undefined. Use C> to get the largest type available on the platform. =over 3 U16 UINT16_C(number) U32 UINT32_C(number) U64 UINT64_C(number) =back =back =for hackers Found in file perl.h =over 4 =item C X Returns a token the C compiler recognizes for the constant C of the widest unsigned integer type on the machine. For example, if the machine has Cs, C would yield 1UL See also, for example, C>. Use L to declare variables of the maximum usable size on this platform. =over 3 UINTMAX_C(number) =back =back =for hackers Found in file perl.h =over 4 =item C X This symbol contains the C. =back =for hackers Found in file config.h =over 4 =item C X This symbol defines the C type used for Perl's U8. =back =for hackers Found in file config.h =over 4 =item C X The largest unsigned integer that fits in a UV on this platform. =over 3 UV UV_MAX =back =back =for hackers Found in file perl.h =over 4 =item C X The smallest unsigned integer that fits in a UV on this platform. It should equal zero. =over 3 UV UV_MIN =back =back =for hackers Found in file perl.h =over 4 =item C X This symbol contains the C. =back =for hackers Found in file config.h =over 4 =item C X This symbol defines the C type used for Perl's UV. =back =for hackers Found in file config.h =over 4 =item C X Yields the widest unsigned integer type on the platform, currently either C or C. This can be used in declarations such as WIDEST_UTYPE my_uv; or casts my_uv = (WIDEST_UTYPE) val; =back =for hackers Found in file handy.h =head1 Lexer interface This is the lower layer of the Perl parser, managing characters and tokens. =over 4 =item C X NOTE: C is B and may change or be removed without notice. Indicates whether the octets in the lexer buffer (Llinestr>) 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 C 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 C flag of the Llinestr> 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 C flag is off, but the octets should be interpreted as UTF-8 if the C pragma is in effect. During a string eval, however, the scalar may have the C flag on, and in this case its octets should be interpreted as UTF-8 unless the C pragma is in effect. This logic may change in the future; use this function instead of implementing the logic yourself. =over 3 bool lex_bufutf8() =back =back =for hackers Found in file toke.c =over 4 =item C X NOTE: C is B and may change or be removed without notice. Discards the first part of the Llinestr> buffer, up to C. The remaining content of the buffer will be moved, and all pointers into the buffer updated appropriately. C must not be later in the buffer than the position of Lbufptr>: 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 L 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. =over 3 void lex_discard_to(char* ptr) =back =back =for hackers Found in file toke.c =over 4 =item C X NOTE: C is B and may change or be removed without notice. Reallocates the lexer buffer (Llinestr>) to accommodate at least C octets (including terminating C). Returns a pointer to the reallocated buffer. This is necessary before making any direct modification of the buffer that would increase its length. L provides a more convenient way to insert text into the buffer. Do not use C or C directly on Clinestr>; this function updates all of the lexer's variables that point directly into the buffer. =over 3 char* lex_grow_linestr(STRLEN len) =back =back =for hackers Found in file toke.c =over 4 =item C X NOTE: C is B and may change or be removed without notice. Reads in the next chunk of text to be lexed, appending it to Llinestr>. 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 Lbufptr> 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 C has the C 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. =over 3 bool lex_next_chunk(U32 flags) =back =back =for hackers Found in file toke.c =over 4 =item C X NOTE: C is B and may change or be removed without notice. 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 L. 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 C has the C 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. =over 3 I32 lex_peek_unichar(U32 flags) =back =back =for hackers Found in file toke.c =over 4 =item C X NOTE: C is B and may change or be removed without notice. Reads optional spaces, in Perl style, in the text currently being lexed. The spaces may include ordinary whitespace characters and Perl-style comments. C<#line> directives are processed if encountered. Lbufptr> 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 C has the C bit set, then the current chunk will not be discarded. =over 3 void lex_read_space(U32 flags) =back =back =for hackers Found in file toke.c =over 4 =item C X NOTE: C is B and may change or be removed without notice. Consume text in the lexer buffer, from Lbufptr> up to C. This advances Lbufptr> to match C, 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 L and L. =over 3 void lex_read_to(char* ptr) =back =back =for hackers Found in file toke.c =over 4 =item C X NOTE: C is B and may change or be removed without notice. Reads the next (Unicode) character in the text currently being lexed. Returns the codepoint (unsigned integer value) of the character read, and moves Lbufptr> past the character, or returns -1 if lexing has reached the end of the input text. To non-destructively examine the next character, use L 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 C has the C 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. =over 3 I32 lex_read_unichar(U32 flags) =back =back =for hackers Found in file toke.c =over 4 =item C X NOTE: C is B and may change or be removed without notice. 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 L. An entry is made on the save stack so that upon unwinding, the new state object will be destroyed and the former value of L will be restored. Nothing else need be done to clean up the parsing context. The code to be parsed comes from C and C. C, 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 C does not affect parsing. C, if non-null, provides an input stream from which code will be read to be parsed. If both are non-null, the code in C comes first and must consist of complete lines of input, and C supplies the remainder of the source. The C parameter is reserved for future use. Currently it is only used by perl internally, so extensions should always pass zero. =over 3 void lex_start(SV* line, PerlIO *rsfp, U32 flags) =back =back =for hackers Found in file toke.c =over 4 =item C X NOTE: C is B and may change or be removed without notice. Insert characters into the lexer buffer (Llinestr>), immediately after the current lexing point (Lbufptr>), 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. The string to be inserted is represented by octets starting at C and continuing to the first nul. These octets are interpreted as either UTF-8 or Latin-1, according to whether the C flag is set in C. The characters are recoded for the lexer buffer, according to how the buffer is currently being interpreted (L). If it is not convenient to nul-terminate a string to be inserted, the L function is more appropriate. =over 3 void lex_stuff_pv(const char* pv, U32 flags) =back =back =for hackers Found in file toke.c =over 4 =item C X NOTE: C is B and may change or be removed without notice. Insert characters into the lexer buffer (Llinestr>), immediately after the current lexing point (Lbufptr>), 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. The string to be inserted is represented by C octets starting at C. These octets are interpreted as either UTF-8 or Latin-1, according to whether the C flag is set in C. The characters are recoded for the lexer buffer, according to how the buffer is currently being interpreted (L). If a string to be inserted is available as a Perl scalar, the L function is more convenient. =over 3 void lex_stuff_pvn(const char* pv, STRLEN len, U32 flags) =back =back =for hackers Found in file toke.c =over 4 =item C X NOTE: C is B and may change or be removed without notice. Like L, but takes a literal string instead of a string/length pair. =over 3 void lex_stuff_pvs("pv", U32 flags) =back =back =for hackers Found in file handy.h =over 4 =item C X NOTE: C is B and may change or be removed without notice. Insert characters into the lexer buffer (Llinestr>), immediately after the current lexing point (Lbufptr>), 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. The string to be inserted is the string value of C. The characters are recoded for the lexer buffer, according to how the buffer is currently being interpreted (L). If a string to be inserted is not already a Perl scalar, the L function avoids the need to construct a scalar. =over 3 void lex_stuff_sv(SV* sv, U32 flags) =back =back =for hackers Found in file toke.c =over 4 =item C X NOTE: C is B and may change or be removed without notice. Discards text about to be lexed, from Lbufptr> up to C. Text following C 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 L. =over 3 void lex_unstuff(char* ptr) =back =back =for hackers Found in file toke.c =over 4 =item C X NOTE: C is B and may change or be removed without notice. 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 C has the C bit set, then the expression is optional, otherwise it is mandatory. It is up to the caller to ensure that the dynamic parser state (L 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. =over 3 OP* parse_arithexpr(U32 flags) =back =back =for hackers Found in file toke.c =over 4 =item C X NOTE: C is B and may change or be removed without notice. 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 (L 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 L. It will not normally include a C 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 C parameter is reserved for future use, and must always be zero. =over 3 OP* parse_barestmt(U32 flags) =back =back =for hackers Found in file toke.c =over 4 =item C X NOTE: C is B and may change or be removed without notice. 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 C variables and various compile-time effects can be contained within it. It is up to the caller to ensure that the dynamic parser state (L 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 C list, including C 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 C parameter is reserved for future use, and must always be zero. =over 3 OP* parse_block(U32 flags) =back =back =for hackers Found in file toke.c =over 4 =item C X NOTE: C is B and may change or be removed without notice. Parse a single complete Perl expression. This allows the full expression grammar, including the lowest-precedence operators such as C. 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 C has the C bit set, then the expression is optional, otherwise it is mandatory. It is up to the caller to ensure that the dynamic parser state (L 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. =over 3 OP* parse_fullexpr(U32 flags) =back =back =for hackers Found in file toke.c =over 4 =item C X NOTE: C is B and may change or be removed without notice. 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 (L 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 L call, normally including a C 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 C parameter is reserved for future use, and must always be zero. =over 3 OP* parse_fullstmt(U32 flags) =back =back =for hackers Found in file toke.c =over 4 =item C X NOTE: C is B and may change or be removed without notice. 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 (L et al) is correctly set to reflect the source of the code to be parsed. If C has the C 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. =over 3 SV* parse_label(U32 flags) =back =back =for hackers Found in file toke.c =over 4 =item C X NOTE: C is B and may change or be removed without notice. 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 C or by something that would normally terminate an expression such as semicolon. If C has the C bit set, then the expression is optional, otherwise it is mandatory. It is up to the caller to ensure that the dynamic parser state (L 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. =over 3 OP* parse_listexpr(U32 flags) =back =back =for hackers Found in file toke.c =over 4 =item C X NOTE: C is B and may change or be removed without notice. 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 (L 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 C list, normally including C 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 C parameter is reserved for future use, and must always be zero. =over 3 OP* parse_stmtseq(U32 flags) =back =back =for hackers Found in file toke.c =over 4 =item C X NOTE: C is B and may change or be removed without notice. Parse a subroutine signature declaration. This is the contents of the parentheses following a named or anonymous subroutine declaration when the C 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 L 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 L to build their function body after it, or splice it together with the body before calling L. The C parameter is reserved for future use, and must always be zero. =over 3 OP* parse_subsignature(U32 flags) =back =back =for hackers Found in file toke.c =over 4 =item C X NOTE: C is B and may change or be removed without notice. 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 C has the C bit set, then the expression is optional, otherwise it is mandatory. It is up to the caller to ensure that the dynamic parser state (L 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. =over 3 OP* parse_termexpr(U32 flags) =back =back =for hackers Found in file toke.c =over 4 =item C X Pointer to a structure encapsulating the state of the parsing operation currently in progress. The pointer can be locally changed to perform a nested parse without interfering with the state of an outer parse. Individual members of C have their own documentation. =back =for hackers Found in file toke.c =over 4 =item Cbufend> Xbufend> NOTE: Cbufend> is B and may change or be removed without notice. Direct pointer to the end of the chunk of text currently being lexed, the end of the lexer buffer. This is equal to Clinestr) + SvCUR(PL_parser-Elinestr)>. A C character (zero octet) is always located at the end of the buffer, and does not count as part of the buffer's contents. =back =for hackers Found in file toke.c =over 4 =item Cbufptr> Xbufptr> NOTE: Cbufptr> is B and may change or be removed without notice. Points to the current position of lexing inside the lexer buffer. Characters around this point may be freely examined, within the range delimited by Clinestr>)> and Lbufend>. The octets of the buffer may be intended to be interpreted as either UTF-8 or Latin-1, as indicated by L. 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 L, which handles newlines appropriately. Interpretation of the buffer's octets can be abstracted out by using the slightly higher-level functions L and L. =back =for hackers Found in file toke.c =over 4 =item Clinestart> Xlinestart> NOTE: Clinestart> is B and may change or be removed without notice. 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 L handles this detail. =back =for hackers Found in file toke.c =over 4 =item Clinestr> Xlinestr> NOTE: Clinestr> is B and may change or be removed without notice. Buffer scalar containing the chunk currently under consideration of the text currently being lexed. This is always a plain string scalar (for which C 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 C pointers to things in the Clinestr> buffer. If Clinestr> is ever reallocated, all of these pointers must be updated. Don't attempt to do this manually, but rather use L 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 L tells you which. Do not use the C flag on this scalar, which may disagree with it. For direct examination of the buffer, the variable Lbufend> points to the end of the buffer. The current lexing position is pointed to by Lbufptr>. Direct use of these pointers is usually preferable to examination of the scalar through normal scalar means. =back =for hackers Found in file toke.c =over 4 =item C X NOTE: C is B and may change or be removed without notice. Puts a C function into the chain of keyword plugins. This is the preferred way to manipulate the L variable. C is a pointer to the C function that is to be added to the keyword plugin chain, and C points to the storage location where a pointer to the next function in the chain will be stored. The value of C is written into the L variable, while the value previously stored there is written to C<*old_plugin_p>. L 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 C<*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 C 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 C<*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 L. When this function is called, the function referenced by C must be ready to be called, except for C<*old_plugin_p> being unfilled. In a threading situation, C may be called immediately, even before this function has returned. C<*old_plugin_p> will always be appropriately set before C is called. If C 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 C<*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 L should be avoided. =over 3 void wrap_keyword_plugin(Perl_keyword_plugin_t new_plugin, Perl_keyword_plugin_t *old_plugin_p) =back =back =for hackers Found in file toke.c =head1 Locales =over 4 =item C X This macro should be used as a statement. It declares a private variable (whose name begins with an underscore) that is needed by the other macros in this section. Failing to include this correctly should lead to a syntax error. For compatibility with C89 C compilers it should be placed in a block before any executable statements. =over 3 void DECLARATION_FOR_LC_NUMERIC_MANIPULATION =back =back =for hackers Found in file perl.h =over 4 =item C X Returns true if the leading C bytes of the strings C and C are the same case-insensitively in the current locale; false otherwise. =over 3 I32 foldEQ_locale(const char* a, const char* b, I32 len) =back =back =for hackers Found in file inline.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to duplicate a locale object. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to deallocates the resources associated with a locale object. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the localeconv routine is available and has the additional members added in C 1003.1-2008. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available for numeric and monetary formatting conventions. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to query certain information about a locale. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to return a new locale object or modify an existing locale object. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to return local data. You will also need F and therefore C. =back =for hackers Found in file config.h =over 4 =item C X This symbol, when defined, indicates presence of the C function =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to return the name of the locale for a category mask. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to handle locale-specific ctype implementations. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to setlocale re-entrantly. =back =for hackers Found in file config.h =over 4 =item C X This symbol, when defined, indicates presence of the C function, and that it is thread-safe. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available to set the current locale for the calling thread. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that F exists and should be included. =over 3 #ifdef I_LANGINFO #include #endif =back =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates to the C program that it should include F. =over 3 #ifdef I_LOCALE #include #endif =back =back =for hackers Found in file config.h =over 4 =item C X Evaluates to TRUE if the plain locale pragma without a parameter (S>) is in effect. =over 3 bool IN_LOCALE =back =back =for hackers Found in file perl.h =over 4 =item C X Evaluates to TRUE if, when compiling a perl program (including an C) if the plain locale pragma without a parameter (S>) is in effect. =over 3 bool IN_LOCALE_COMPILETIME =back =back =for hackers Found in file perl.h =over 4 =item C X Evaluates to TRUE if, when executing a perl program (including an C) if the plain locale pragma without a parameter (S>) is in effect. =over 3 bool IN_LOCALE_RUNTIME =back =back =for hackers Found in file perl.h =over 4 =item C X This symbol, if defined, indicates to the C program that the header F is available. See also C> =over 3 #ifdef I_XLOCALE #include #endif =back =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C program should include F to get C and its friends. =back =for hackers Found in file config.h =over 4 =item C X This is an (almost) drop-in replacement for the system C>, taking the same C parameter values, and returning the same information. But it is more thread-safe than regular C, and hides the quirks of Perl's locale handling from your code, and can be used on systems that lack a native C. Expanding on these: =over =item * The reason it isn't quite a drop-in replacement is actually an advantage. The only difference is that it returns S>, whereas plain C returns S>, but you are (only by documentation) forbidden to write into the buffer. By declaring this C, the compiler enforces this restriction, so if it is violated, you know at compilation time, rather than getting segfaults at runtime. =item * It delivers the correct results for the C and C items, without you having to write extra code. The reason for the extra code would be because these are from the C locale category, which is normally kept set by Perl so that the radix is a dot, and the separator is the empty string, no matter what the underlying locale is supposed to be, and so to get the expected results, you have to temporarily toggle into the underlying locale, and later toggle back. (You could use plain C and C> for this but then you wouldn't get the other advantages of C; not keeping C in the C (or equivalent) locale would break a lot of CPAN, which is expecting the radix (decimal point) character to be a dot.) =item * The system function it replaces can have its static return buffer trashed, not only by a subsequent call to that function, but by a C, C, or other locale change. The returned buffer of this function is not changed until the next call to it, so the buffer is never in a trashed state. =item * Its return buffer is per-thread, so it also is never overwritten by a call to this function from another thread; unlike the function it replaces. =item * But most importantly, it works on systems that don't have C, such as Windows, hence makes your code more portable. Of the fifty-some possible items specified by the POSIX 2008 standard, L, only one is completely unimplemented, though on non-Windows platforms, another significant one is also not implemented). It uses various techniques to recover the other items, including calling C>, and C>, both of which are specified in C89, so should be always be available. Later C versions have additional capabilities; C<""> is returned for those not available on your system. It is important to note that when called with an item that is recovered by using C, the buffer from any previous explicit call to C will be overwritten. This means you must save that buffer's contents if you need to access them after a call to this function. (But note that you might not want to be using C directly anyway, because of issues like the ones listed in the second item of this list (above) for C and C. You can use the methods given in L to call L and avoid all the issues, but then you have a hash to unpack). The details for those items which may deviate from what this emulation returns and what a native C would return are specified in L. =back When using C on systems that don't have a native C, you must #include "perl_langinfo.h" before the C C<#include>. You can replace your C C<#include> with this one. (Doing it this way keeps out the symbols that plain C would try to import into the namespace for code that doesn't need it.) The original impetus for C was so that code that needs to find out the current currency symbol, floating point radix character, or digit grouping separator can use, on all systems, the simpler and more thread-friendly C API instead of C> which is a pain to make thread-friendly. For other fields returned by C, it is better to use the methods given in L to call L|POSIX/localeconv>, which is thread-friendly. =over 3 const char* Perl_langinfo(const nl_item item) =back =back =for hackers Found in file locale.c =over 4 =item C X This is an (almost) drop-in replacement for the system L>, taking the same parameters, and returning the same information, except that it returns the correct underlying C locale. Regular C will instead return C if the underlying locale has a non-dot decimal point character, or a non-empty thousands separator for displaying floating point numbers. This is because perl keeps that locale category such that it has a dot and empty separator, changing the locale briefly during the operations where the underlying one is required. C knows about this, and compensates; regular C doesn't. Another reason it isn't completely a drop-in replacement is that it is declared to return S>, whereas the system setlocale omits the C (presumably because its API was specified long ago, and can't be updated; it is illegal to change the information C returns; doing so leads to segfaults.) Finally, C works under all circumstances, whereas plain C can be completely ineffective on some platforms under some configurations. C should not be used to change the locale except on systems where the predefined variable C<${^SAFE_LOCALES}> is 1. On some such systems, the system C is ineffective, returning the wrong information, and failing to actually change the locale. C, however works properly in all circumstances. The return points to a per-thread static buffer, which is overwritten the next time C is called from the same thread. =over 3 const char* Perl_setlocale(const int category, const char* locale) =back =back =for hackers Found in file locale.c =over 4 =item C X This is used in conjunction with one of the macros L and L to properly restore the C state. A call to L must have been made to declare at compile time a private variable used by this macro and the two C 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(); ... } =over 3 void RESTORE_LC_NUMERIC() =back =back =for hackers Found in file perl.h =over 4 =item C X This symbol, if defined, indicates that the setlocale routine is available and it accepts any input locale name as valid. =back =for hackers Found in file config.h =over 4 =item C X This is used by XS code that is C locale-aware to force the locale for category C to be what perl thinks is the current underlying locale. (The perl interpreter could be wrong about what the underlying locale actually is if some C or XS code has called the C library function L behind its back; calling L before calling this macro will update perl's records.) A call to L 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 L 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. =over 3 void STORE_LC_NUMERIC_FORCE_TO_UNDERLYING() =back =back =for hackers Found in file perl.h =over 4 =item C X This is used to help wrap XS or C code that is C locale-aware. This locale category is generally kept set to a locale where the decimal radix character is a dot, and the separator between groups of digits is empty. This is because most XS code that reads floating point numbers is expecting them to have this syntax. This macro makes sure the current C 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 S>; 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 L macro after the operation. Otherwise the state can be changed that will adversely affect other XS code. A call to L 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 L for a more contained way to ensure that. =over 3 void STORE_LC_NUMERIC_SET_TO_NEEDED() =back =back =for hackers Found in file perl.h =over 4 =item C X Same as L with in_lc_numeric provided as the precalculated value of C. It is the caller's responsibility to ensure that the status of C and C cannot have changed since the precalculation. =over 3 void STORE_LC_NUMERIC_SET_TO_NEEDED_IN(bool in_lc_numeric) =back =back =for hackers Found in file perl.h =over 4 =item C X On systems without locale support, or on typical single-threaded builds, or on platforms that do not support per-thread locale operations, this function does nothing. On such systems that do have locale support, only a locale global to the whole program is available. On multi-threaded builds on systems that do have per-thread locale operations, this function converts the thread it is running in to use the global locale. This is for code that has not yet or cannot be updated to handle multi-threaded locale operation. As long as only a single thread is so-converted, everything works fine, as all the other threads continue to ignore the global one, so only this thread looks at it. However, on Windows systems this isn't quite true prior to Visual Studio 15, at which point Microsoft fixed a bug. A race can occur if you use the following operations on earlier Windows platforms: =over =item L =item L, items C and C =item L, items C and C =back 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 using the Windows API functions C and C; patches welcome. Without this function call, threads that use the L> system function will not work properly, as all the locale-sensitive functions will look at the per-thread locale, and C will have no effect on this thread. Perl code should convert to either call L|perlapi/Perl_setlocale> (which is a drop-in for the system C) or use the methods given in L to call L|POSIX/setlocale>. Either one will transparently properly handle all cases of single- vs multi-thread, POSIX 2008-supported or not. Non-Perl libraries, such as C, that call the system C can continue to work if this function is called before transferring control to the library. Upon return from the code that needs to use the global locale, L|perlapi/sync_locale> should be called to restore the safe multi-thread operation. =over 3 void switch_to_global_locale() =back =back =for hackers Found in file locale.c =over 4 =item C X L|perlapi/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 L). Using the system L> should be avoided. Nevertheless, certain non-Perl libraries called from XS, such as C do so, and this can't be changed. When the locale is changed by XS code that didn't use L|perlapi/Perl_setlocale>, Perl needs to be told that the locale has changed. Use this function to do so, before returning to Perl. The return value is a boolean: TRUE if the global locale at the time of call was in effect; and FALSE if a per-thread locale was in effect. This can be used by the caller that needs to restore things as-they-were to decide whether or not to call L|perlapi/switch_to_global_locale>. =over 3 bool sync_locale() =back =back =for hackers Found in file locale.c =over 4 =item C X This macro invokes the supplied statement or block within the context of a L .. L pair if required, so eg: 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 } =over 3 void WITH_LC_NUMERIC_SET_TO_NEEDED(block) =back =back =for hackers Found in file perl.h =over 4 =item C X Same as L with in_lc_numeric provided as the precalculated value of C. It is the caller's responsibility to ensure that the status of C and C cannot have changed since the precalculation. =over 3 void WITH_LC_NUMERIC_SET_TO_NEEDED_IN(bool in_lc_numeric, block) =back =back =for hackers Found in file perl.h =head1 Magic "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. =over 4 =item C X Clear something magical that the SV represents. See C>. =over 3 int mg_clear(SV* sv) =back =back =for hackers Found in file mg.c =over 4 =item C X Copies the magic from one SV to another. See C>. =over 3 int mg_copy(SV *sv, SV *nsv, const char *key, I32 klen) =back =back =for hackers Found in file mg.c =over 4 =item C X Finds the magic pointer for C matching the SV. See C>. =over 3 MAGIC* mg_find(const SV* sv, int type) =back =back =for hackers Found in file mg.c =over 4 =item C X Finds the magic pointer of C with the given C for the C. See C>. =over 3 MAGIC* mg_findext(const SV* sv, int type, const MGVTBL *vtbl) =back =back =for hackers Found in file mg.c =over 4 =item C X Free any magic storage used by the SV. See C>. =over 3 int mg_free(SV* sv) =back =back =for hackers Found in file mg.c =over 4 =item C X Remove any magic of type C using virtual table C from the SV C. See L. C is equivalent to C. =over 3 void mg_freeext(SV* sv, int how, const MGVTBL *vtbl) =back =back =for hackers Found in file mg.c =over 4 =item C X Remove any magic of type C from the SV C. See L. =over 3 void mg_free_type(SV* sv, int how) =back =back =for hackers Found in file mg.c =over 4 =item C X Do magic before a value is retrieved from the SV. The type of SV must be >= C. See C>. =over 3 int mg_get(SV* sv) =back =back =for hackers Found in file mg.c =over 4 =item C X C> It is planned to remove C from a future release of Perl. Do not use it for new code; remove it from existing code. Reports on the SV's length in bytes, calling length magic if available, but does not set the UTF8 flag on C. It will fall back to 'get' magic if there is no 'length' magic, but with no indication as to whether it called 'get' magic. It assumes C is a C or higher. Use C instead. =over 3 U32 mg_length(SV* sv) =back =back =for hackers Found in file mg.c =over 4 =item C X Turns on the magical status of an SV. See C>. =over 3 void mg_magical(SV* sv) =back =back =for hackers Found in file mg.c =over 4 =item C X Do magic after a value is assigned to the SV. See C>. =over 3 int mg_set(SV* sv) =back =back =for hackers Found in file mg.c =over 4 =item C Described in L. =over 3 SvTIED_obj(SV *sv, MAGIC *mg) =back =back =for hackers Found in file pod/perlinterp.pod =head1 Memory Management =over 4 =item C X Can we handle C attribute for malloc-style functions. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available for use. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that the C routine is available for use. =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates to the C program that it should include F. =over 3 #ifdef I_MALLOCMALLOC #include #endif =back =back =for hackers Found in file config.h =over 4 =item C X This symbol, if defined, indicates that we're using our own malloc. =back =for hackers Found in file config.h =over 4 =item C X The XSUB-writer's interface to the C C function. Memory obtained by this should B be freed with L. In 5.9.3, Newx() and friends replace the older New() API, and drops the first parameter, I, a debug aid which allowed callers to identify themselves. This aid has been superseded by a new build option, PERL_MEM_LOG (see L). The older API is still there for use in XS modules supporting older perls. =over 3 void Newx(void* ptr, int nitems, type) =back =back =for hackers Found in file handy.h =over 4 =item C X The XSUB-writer's interface to the C C function, with cast. See also C>. Memory obtained by this should B be freed with L. =over 3 void Newxc(void* ptr, int nitems, type, cast) =back =back =for hackers Found in file handy.h =over 4 =item C X The XSUB-writer's interface to the C C function. The allocated memory is zeroed with C. See also C>. Memory obtained by this should B be freed with L. =over 3 void Newxz(void* ptr, int nitems, type) =back =back =for hackers Found in file handy.h =over 4 =item C X This symbol, if defined, indicates that we'd like malloc wrap checks. =back =for hackers Found in file config.h =over 4 =item C X The XSUB-writer's interface to the C C function. Memory obtained by this should B be freed with L. =over 3 void Renew(void* ptr, int nitems, type) =back =back =for hackers Found in file handy.h =over 4 =item C X The XSUB-writer's interface to the C C function, with cast. Memory obtained by this should B be freed with L. =over 3 void Renewc(void* ptr, int nitems, type, cast) =back =back =for hackers Found in file handy.h =over 4 =item C X The XSUB-writer's interface to the C C function. This should B be used on memory obtained using L and friends. =over 3 void Safefree(void* ptr) =back =back =for hackers Found in file handy.h =over 4 =item C X Safe version of system's calloc() =over 3 Malloc_t safesyscalloc(MEM_SIZE elements, MEM_SIZE size) =back =back =for hackers Found in file util.c =over 4 =item C X Safe version of system's free() =over 3 Free_t safesysfree(Malloc_t where) =back =back =for hackers Found in file util.c =over 4 =item C X Paranoid version of system's malloc() =over 3 Malloc_t safesysmalloc(MEM_SIZE nbytes) =back =back =for hackers Found in file util.c =over 4 =item C X Paranoid version of system's realloc() =over 3 Malloc_t safesysrealloc(Malloc_t where, MEM_SIZE nbytes) =back =back =for hackers Found in file util.c =head1 MRO These functions are related to the method resolution order of perl classes Also see L. =over 4 =item C Described in L. =over 3 struct mro_meta * HvMROMETA(HV *hv) =back =back =for hackers Found in file pod/perlmroapi.pod =over 4 =item C X Returns the mro linearisation for the given stash. By default, this will be whatever C returns unless some other MRO is in effect for the stash. The return value is a read-only AV*. You are responsible for C 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). =over 3 AV* mro_get_linear_isa(HV* stash) =back =back =for hackers Found in file mro_core.c =over 4 =item C Described in L. =over 3 SV* MRO_GET_PRIVATE_DATA(struct mro_meta *const smeta, const struct mro_alg *const which) =back =back =for hackers Found in file pod/perlmroapi.pod =over 4 =item C X Invalidates method caching on any child classes of the given stash, so that they might notice the changes in this one. Ideally, all instances of C in perl source outside of F 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 F does). This same method is available from pure perl via, C. =over 3 void mro_method_changed_in(HV* stash) =back =back =for hackers Found in file mro_core.c =over 4 =item C X Registers a custom mro plugin. See L for details on this and other mro functions. NOTE: C must be explicitly called as C with an C parameter. =over 3 void Perl_mro_register(pTHX_ const struct mro_alg *mro) =back =back =for hackers Found in file mro_core.c =over 4 =item C Described in L. NOTE: C must be explicitly called as C with an C parameter. =over 3 SV* Perl_mro_set_private_data(pTHX_ struct mro_meta *const smeta, const struct mro_alg *const which, SV *const data) =back =back =for hackers Found in file pod/perlmroapi.pod =head1 Multicall Functions =over 4 =item C X Declare local variables for a multicall. See L. =over 3 dMULTICALL; =back =back =for hackers Found in file cop.h =over 4 =item C X Make a lightweight callback. See L. =over 3 MULTICALL; =back =back =for hackers Found in file cop.h =over 4 =item C X Closing bracket for a lightweight callback. See L. =over 3 POP_MULTICALL; =back =back =for hackers Found in file cop.h =over 4 =item C X Opening bracket for a lightweight callback. See L. =over 3 PUSH_MULTICALL(CV* the_cv); =back =back =for hackers Found in file cop.h =head1 Numeric Functions =over 4 =item C X This macro is to be used to generate uniformly distributed random numbers over the range [0., 1.[. You may have to supply an 'extern double C;' in your program since SunOS 4.1.3 doesn't provide you with anything relevant in its headers. See C>. =over 3 double Drand01() =back =back =for hackers Found in file handy.h =over 4 =item C X This preprocessor macro is defined to convert a floating point number to a string without a trailing decimal point. This emulates the behavior of C, but is sometimes much more efficient. If C is not available, but C drops the trailing decimal point, then C is used. If all else fails, a macro using C is used. Arguments for the Gconvert macro are: value, number of digits, whether trailing zeros should be retained, and the output buffer. The usual values are: 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. =over 3 char * Gconvert(double x, Size_t n, bool t, char * b) =back =back =for hackers Found in file handy.h =over 4 =item C X converts a string representing a binary number to numeric form. On entry C and C<*len_p> give the string to scan, C<*flags> gives conversion flags, and C should be C or a pointer to an NV. The scan stops at the end of the string, or at just before the first invalid character. Unless C is set in C<*flags>, encountering an invalid character (except NUL) will also trigger a warning. On return C<*len_p> is set to the length of the scanned string, and C<*flags> gives output flags. If the value is <= C it is returned as a UV, the output flags are clear, and nothing is written to C<*result>. If the value is > C, C returns C, sets C in the output flags, and writes an approximation of the correct value into C<*result> (which is an NV; or the approximation is discarded if C is NULL). The binary number may optionally be prefixed with C<"0b"> or C<"b"> unless C is set in C<*flags> on entry. If C is set in C<*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. =over 3 UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result) =back =back =for hackers Found in file numeric.c =over 4 =item C X converts a string representing a hex number to numeric form. On entry C and C<*len_p> give the string to scan, C<*flags> gives conversion flags, and C should be C or a pointer to an NV. The scan stops at the end of the string, or at just before the first invalid character. Unless C is set in C<*flags>, encountering an invalid character (except NUL) will also trigger a warning. On return C<*len_p> is set to the length of the scanned string, and C<*flags> gives output flags. If the value is <= C it is returned as a UV, the output flags are clear, and nothing is written to C<*result>. If the value is > C, C returns C, sets C in the output flags, and writes an approximation of the correct value into C<*result> (which is an NV; or the approximation is discarded if C is NULL). The hex number may optionally be prefixed with C<"0x"> or C<"x"> unless C is set in C<*flags> on entry. If C is set in C<*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. =over 3 UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result) =back =back =for hackers Found in file numeric.c =over 4 =item C X Helper for C, accepts various ways of spelling "infinity" or "not a number", and returns one of the following flag combinations: IS_NUMBER_INFINITY IS_NUMBER_NAN IS_NUMBER_INFINITY | IS_NUMBER_NEG IS_NUMBER_NAN | IS_NUMBER_NEG 0 possibly |-ed with C. If an infinity or a not-a-number is recognized, C<*sp> will point to one byte past the end of the recognized string. If the recognition fails, zero is returned, and C<*sp> will not move. =over 3 int grok_infnan(const char** sp, const char *send) =back =back =for hackers Found in file numeric.c =over 4 =item C X Identical to C with C set to zero. =over 3 int grok_number(const char *pv, STRLEN len, UV *valuep) =back =back =for hackers Found in file numeric.c =over 4 =item C X Recognise (or not) a number. The type of the number is returned (0 if unrecognised), otherwise it is a bit-ORed combination of C, C, C, C, C, C (defined in perl.h). If the value of the number can fit in a UV, it is returned in C<*valuep>. C will be set to indicate that C<*valuep> is valid, C will never be set unless C<*valuep> is valid, but C<*valuep> may have been assigned to during processing even though C is not set on return. If C is C, C will be set for the same cases as when C is non-C, but no actual assignment (or SEGV) will occur. C will be set with C if trailing decimals were seen (in which case C<*valuep> gives the true value truncated to an integer), and C if the number is negative (in which case C<*valuep> holds the absolute value). C is not set if C notation was used or the number is larger than a UV. C allows only C, which allows for trailing non-numeric text on an otherwise successful I, setting C on the result. =over 3 int grok_number_flags(const char *pv, STRLEN len, UV *valuep, U32 flags) =back =back =for hackers Found in file numeric.c =over 4 =item C X A synonym for L =over 3 bool GROK_NUMERIC_RADIX(NN const char **sp, NN const char *send) =back =back =for hackers Found in file perl.h =over 4 =item C X Scan and skip for a numeric decimal separator (radix). =over 3 bool grok_numeric_radix(const char **sp, const char *send) =back =back =for hackers Found in file numeric.c =over 4 =item C X converts a string representing an octal number to numeric form. On entry C and C<*len_p> give the string to scan, C<*flags> gives conversion flags, and C should be C or a pointer to an NV. The scan stops at the end of the string, or at just before the first invalid character. Unless C is set in C<*flags>, encountering an invalid character (except NUL) will also trigger a warning. On return C<*len_p> is set to the length of the scanned string, and C<*flags> gives output flags. If the value is <= C it is returned as a UV, the output flags are clear, and nothing is written to C<*result>. If the value is > C, C returns C, sets C in the output flags, and writes an approximation of the correct value into C<*result> (which is an NV; or the approximation is discarded if C is NULL). If C is set in C<*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 C flag is always treated as being set for this function. =over 3 UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result) =back =back =for hackers Found in file numeric.c =over 4 =item C X C is a utility function that returns true if the NV argument is either an infinity or a C, false otherwise. To test in more detail, use C and C. This is also the logical inverse of Perl_isfinite(). =over 3 bool isinfnan(NV nv) =back =back =for hackers Found in file numeric.c =over 4 =item C X L(3)>, but properly works with Perl locale handling, accepting a dot radix character always, but also the current locale's radix character if and only if called from within the lexical scope of a Perl C statement. N.B. C must be NUL terminated. =over 3 NV my_atof(const char *s) =back =back =for hackers Found in file numeric.c =over 4 =item C X This function is equivalent to the libc strtod() function, and is available even on platforms that lack plain strtod(). Its return value is the best available precision depending on platform capabilities and F options. It properly handles the locale radix character, meaning it expects a dot except when called from within the scope of S>, in which case the radix character should be that specified by the current locale. The synonym Strtod() may be used instead. =over 3 NV my_strtod(const char * const s, char ** e) =back =back =for hackers Found in file numeric.c =over 4 =item C X Typeless C or C, I. (The usage below indicates it is for integers, but it works for any type.) Use instead of these, since the C library ones force their argument to be what it is expecting, potentially leading to disaster. But also beware that this evaluates its argument twice, so no C. =over 3 int PERL_ABS(int x) =back =back =for hackers Found in file perl.h =over 4 =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C =item C XXXXXXXXXXXXXXXXXXXXXXXX These perform the corresponding mathematical operation on the operand(s), using the libc function designed for the task that has just enough precision for an NV on this platform. If no such function with sufficient precision exists, the highest precision one available is used. =over 3 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) =back =back =for hackers Found in file perl.h =over 4 =item C X NOTE: C is B and may change or be removed without notice. Return a non-zero integer if the sign bit on an NV is set, and 0 if it is not. If F detects this system has a C that will work with our NVs, then we just use it via the C<#define> in F. Otherwise, fall back on this implementation. The main use of this function is catching C<-0.0>. C notes: This function is called C<'Perl_signbit'> instead of a plain C<'signbit'> because it is easy to imagine a system having a C function or macro that doesn't happen to work with our particular choice of NVs. We shouldn't just re-C<#define> C as C and expect the standard system headers to be happy. Also, this is a no-context function (no C) because C is usually re-C<#defined> in F as a simple macro call to the system's C. Users should just always call C. =over 3 int Perl_signbit(NV f) =back =back =for hackers Found in file numeric.c =over 4 =item C X This array, indexed by an integer, converts that value into the character that represents it. For example, if the input is 8, the return will be a string whose first character is '8'. What is actually returned is a pointer into a string. All you are interested in is the first character of that string. To get uppercase letters (for the values 10..15), add 16 to the index. Hence, C is C<'b'>, and C is C<'B'>. Adding 16 to an index whose representation is '0'..'9' yields the same as not adding 16. Indices outside the range 0..31 result in (bad) undedefined behavior. =back =for hackers Found in file perl.h =over 4 =item C X Returns the value of an ASCII-range hex digit and advances the string pointer. Behaviour is only well defined when isXDIGIT(*str) is true. =over 3 U8 READ_XDIGIT(char str*) =back =back =for hackers Found in file handy.h =over 4 =item C X For backwards compatibility. Use C instead. =over 3 NV scan_bin(const char* start, STRLEN len, STRLEN* retlen) =back =back =for hackers Found in file numeric.c =over 4 =item C X For backwards compatibility. Use C instead. =over 3 NV scan_hex(const char* start, STRLEN len, STRLEN* retlen) =back =back =for hackers Found in file numeric.c =over 4 =item C X For backwards compatibility. Use C instead. =over 3 NV scan_oct(const char* start, STRLEN len, STRLEN* retlen) =back =back =for hackers Found in file numeric.c =over 4 =item C X This symbol defines the macro to be used in seeding the random number generator (see C>). =over 3 void seedDrand01(Rand_seed_t x) =back =back =for hackers Found in file handy.h =over 4 =item C X This is a synonym for L. =over 3 NV Strtod(NN const char * const s, NULLOK char ** e) =back =back =for hackers Found in file perl.h =over 4 =item C X Platform and configuration independent C. This expands to the appropriate C-like function based on the platform and F options>. For example it could expand to C or C instead of C. =over 3 NV Strtol(NN const char * const s, NULLOK char ** e, int base) =back =back =for hackers Found in file perl.h =over 4 =item C X Platform and configuration independent C. This expands to the appropriate C-like function based on the platform and F options>. For example it could expand to C or C instead of C. =over 3 NV Strtoul(NN const char * const s, NULLOK char ** e, int base) =back =back =for hackers Found in file perl.h =head1 Optree construction =over 4 =item C X Constructs, checks, and returns an assignment op. C and C supply the parameters of the assignment; they are consumed by this function and become part of the constructed op tree. If C is C, C, or C, then a suitable conditional optree is constructed. If C is the opcode of a binary operator, such as C, then an op is constructed that performs the binary operation and assigns the result to the left argument. Either way, if C is non-zero then C has no effect. If C is zero, then a plain scalar or list assignment is constructed. Which type of assignment it is is automatically determined. C gives the eight bits of C, except that C will be set automatically, and, shifted up eight bits, the eight bits of C, except that the bit with value 1 or 2 is automatically set as required. =over 3 OP* newASSIGNOP(I32 flags, OP* left, I32 optype, OP* right) =back =back =for hackers Found in file op.c =over 4 =item C X Constructs, checks, and returns an op of any binary type. C is the opcode. C gives the eight bits of C, except that C will be set automatically, and, shifted up eight bits, the eight bits of C, except that the bit with value 1 or 2 is automatically set as required. C and C supply up to two ops to be the direct children of the binary op; they are consumed by this function and become part of the constructed op tree. =over 3 OP* newBINOP(I32 type, I32 flags, OP* first, OP* last) =back =back =for hackers Found in file op.c =over 4 =item C X Constructs, checks, and returns a conditional-expression (C) op. C gives the eight bits of C, except that C will be set automatically, and, shifted up eight bits, the eight bits of C, except that the bit with value 1 is automatically set. C supplies the expression selecting between the two branches, and C and C supply the branches; they are consumed by this function and become part of the constructed op tree. =over 3 OP* newCONDOP(I32 flags, OP* first, OP* trueop, OP* falseop) =back =back =for hackers Found in file op.c =over 4 =item C X NOTE: C is B and may change or be removed without notice. Constructs and returns a deferred-block statement that implements the C semantics. The C optree is consumed by this function and becomes part of the returned optree. The C argument carries additional flags to set on the returned op, including the C field. =over 3 OP* newDEFEROP(I32 flags, OP *block) =back =back =for hackers Found in file op.c =over 4 =item C X Constructs and returns an op to access C<$_>. =over 3 OP* newDEFSVOP() =back =back =for hackers Found in file op.c =over 4 =item C X Constructs, checks, and returns an op tree expressing a C loop (iteration through a list of values). This is a heavyweight loop, with structure that allows exiting the loop by C and suchlike. C optionally supplies the variable(s) that will be aliased to each item in turn; if null, it defaults to C<$_>. C supplies the list of values to iterate over. C supplies the main body of the loop, and C optionally supplies a C 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. C gives the eight bits of C for the C op and, shifted up eight bits, the eight bits of C for the C op, except that (in both cases) some bits will be set automatically. =over 3 OP* newFOROP(I32 flags, OP* sv, OP* expr, OP* block, OP* cont) =back =back =for hackers Found in file op.c =over 4 =item C X Constructs, checks, and returns an op tree expressing a C block. C supplies the expression to whose value C<$_> will be locally aliased, and C supplies the body of the C construct; they are consumed by this function and become part of the constructed op tree. C must be zero (it used to identity the pad slot of lexical $_). =over 3 OP* newGIVENOP(OP* cond, OP* block, PADOFFSET defsv_off) =back =back =for hackers Found in file op.c =over 4 =item C X Constructs, checks, and returns an op of any type that involves an embedded reference to a GV. C is the opcode. C gives the eight bits of C. C identifies the GV that the op should reference; calling this function does not transfer ownership of any reference to it. =over 3 OP* newGVOP(I32 type, I32 flags, GV* gv) =back =back =for hackers Found in file op.c =over 4 =item C X Constructs, checks, and returns an op of any list type. C is the opcode. C gives the eight bits of C, except that C will be set automatically if required. C and C supply up to two ops to be direct children of the list op; they are consumed by this function and become part of the constructed op tree. For most list operators, the check function expects all the kid ops to be present already, so calling C (e.g.) is not appropriate. What you want to do in that case is create an op of type C, append more children to it, and then call L. See L for more information. =over 3 OP* newLISTOP(I32 type, I32 flags, OP* first, OP* last) =back =back =for hackers Found in file op.c =over 4 =item C X Constructs, checks, and returns a logical (flow control) op. C is the opcode. C gives the eight bits of C, except that C will be set automatically, and, shifted up eight bits, the eight bits of C, except that the bit with value 1 is automatically set. C supplies the expression controlling the flow, and C supplies the side (alternate) chain of ops; they are consumed by this function and become part of the constructed op tree. =over 3 OP* newLOGOP(I32 optype, I32 flags, OP *first, OP *other) =back =back =for hackers Found in file op.c =over 4 =item C X Constructs, checks, and returns a loop-exiting op (such as C or C). C is the opcode. C and C. WARNING: use only if you *know* that the pointers point inside the same UTF-8 buffer. =over 3 IV utf8_distance(const U8 *a, const U8 *b) =back =back =for hackers Found in file inline.h =over 4 =item C X Return the UTF-8 pointer C displaced by C characters, either forward or backward. WARNING: do not use the following unless you *know* C is within the UTF-8 data pointed to by C *and* that on entry C is aligned on the first byte of character or just after the last byte of a character. =over 3 U8* utf8_hop(const U8 *s, SSize_t off) =back =back =for hackers Found in file inline.h =over 4 =item C X Return the UTF-8 pointer C displaced by up to C characters, backward. C must be non-positive. C must be after or equal to C. When moving backward it will not move before C. Will not exceed this limit even if the string is not valid "UTF-8". =over 3 U8* utf8_hop_back(const U8 *s, SSize_t off, const U8 *start) =back =back =for hackers Found in file inline.h =over 4 =item C X Return the UTF-8 pointer C displaced by up to C characters, forward. C must be non-negative. C must be before or equal to C. When moving forward it will not move beyond C. Will not exceed this limit even if the string is not valid "UTF-8". =over 3 U8* utf8_hop_forward(const U8 *s, SSize_t off, const U8 *end) =back =back =for hackers Found in file inline.h =over 4 =item C X Return the UTF-8 pointer C displaced by up to C characters, either forward or backward. When moving backward it will not move before C. When moving forward it will not move beyond C. Will not exceed those limits even if the string is not valid "UTF-8". =over 3 U8* utf8_hop_safe(const U8 *s, SSize_t off, const U8 *start, const U8 *end) =back =back =for hackers Found in file inline.h =over 4 =item C X Evaluates to 1 if the byte C represents the same character when encoded in UTF-8 as when not; otherwise evaluates to 0. UTF-8 invariant characters can be copied as-is when converting to/from UTF-8, saving time. 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 C> for checking if a UV is invariant. =over 3 bool UTF8_IS_INVARIANT(char c) =back =back =for hackers Found in file utf8.h =over 4 =item C X Evaluates to non-zero if the first few bytes of the string starting at C and looking no further than S> are well-formed UTF-8 that represents one of the Unicode non-character code points; otherwise it evaluates to 0. If non-zero, the value gives how many bytes starting at C comprise the code point's representation. =over 3 bool UTF8_IS_NONCHAR(const U8 *s, const U8 *e) =back =back =for hackers Found in file utf8.h =over 4 =item C X Evaluates to non-zero if the first few bytes of the string starting at C and looking no further than S> are well-formed UTF-8 that represents the Unicode REPLACEMENT CHARACTER; otherwise it evaluates to 0. If non-zero, the value gives how many bytes starting at C comprise the code point's representation. =over 3 bool UTF8_IS_REPLACEMENT(const U8 *s, const U8 *e) =back =back =for hackers Found in file utf8.h =over 4 =item C X Recall that Perl recognizes an extension to UTF-8 that can encode code points larger than the ones defined by Unicode, which are 0..0x10FFFF. This macro evaluates to non-zero if the first few bytes of the string starting at C and looking no further than S> are from this UTF-8 extension; otherwise it evaluates to 0. If non-zero, the return is how many bytes starting at C 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 =over 3 bool UTF8_IS_SUPER(const U8 *s, const U8 *e) =back =back =for hackers Found in file utf8.h =over 4 =item C X Evaluates to non-zero if the first few bytes of the string starting at C and looking no further than S> are well-formed UTF-8 that represents one of the Unicode surrogate code points; otherwise it evaluates to 0. If non-zero, the value gives how many bytes starting at C comprise the code point's representation. =over 3 bool UTF8_IS_SURROGATE(const U8 *s, const U8 *e) =back =back =for hackers Found in file utf8.h =over 4 =item C X Returns the number of characters in the sequence of UTF-8-encoded bytes starting at C and ending at the byte just before C. If and point to the same place, it returns 0 with no warning raised. If C s> or if the scan would end up past C, it raises a UTF8 warning and returns the number of valid characters. =over 3 STRLEN utf8_length(const U8* s, const U8 *e) =back =back =for hackers Found in file utf8.c =over 4 =item C X The maximum width of a single UTF-8 encoded character, in bytes. 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. =back =for hackers Found in file utf8.h =over 4 =item C X The maximum number of UTF-8 bytes a single Unicode character can uppercase/lowercase/titlecase/fold into. =back =for hackers Found in file utf8.h =over 4 =item C X returns 0 if S= e>>; otherwise returns the number of bytes in the UTF-8 encoded character whose first byte is pointed to by C. But it never returns beyond C. On DEBUGGING builds, it asserts that S= e>>. =over 3 STRLEN UTF8_SAFE_SKIP(char* s, char* e) =back =back =for hackers Found in file utf8.h =over 4 =item C X This is a synonym for C> =over 3 STRLEN UTF8_SKIP(char* s) =back =back =for hackers Found in file utf8.h =over 4 =item C X NOTE: C is B and may change or be removed without notice. Converts a string C<"s"> of length C<*lenp> from UTF-8 into native byte encoding. Unlike L, this over-writes the original string, and updates C<*lenp> to contain the new length. Returns zero on failure (leaving C<"s"> unchanged) setting C<*lenp> to -1. Upon successful return, the number of variants in the string can be computed by having saved the value of C<*lenp> before the call, and subtracting the after-call value of C<*lenp> from it. If you need a copy of the string, see L. =over 3 U8* utf8_to_bytes(U8 *s, STRLEN *lenp) =back =back =for hackers Found in file utf8.c =over 4 =item C X C> It is planned to remove C from a future release of Perl. Do not use it for new code; remove it from existing code. Returns the native code point of the first character in the string C which is assumed to be in UTF-8 encoding; C will be set to the length, in bytes, of that character. Some, but not all, UTF-8 malformations are detected, and in fact, some malformed input could cause reading beyond the end of the input buffer, which is why this function is deprecated. Use L instead. If C points to one of the detected malformations, and UTF8 warnings are enabled, zero is returned and C<*retlen> is set (if C isn't C) to -1. If those warnings are off, the computed value if well-defined (or the Unicode REPLACEMENT CHARACTER, if not) is silently returned, and C<*retlen> is set (if C isn't NULL) so that (S + C<*retlen>>) is the next possible position in C that could begin a non-malformed character. See L for details on when the REPLACEMENT CHARACTER is returned. =over 3 UV utf8_to_uvchr(const U8 *s, STRLEN *retlen) =back =back =for hackers Found in file mathoms.c =over 4 =item C X Returns the native code point of the first character in the string C which is assumed to be in UTF-8 encoding; C points to 1 beyond the end of C. C<*retlen> will be set to the length, in bytes, of that character. If C does not point to a well-formed UTF-8 character and UTF8 warnings are enabled, zero is returned and C<*retlen> is set (if C isn't C) to -1. If those warnings are off, the computed value, if well-defined (or the Unicode REPLACEMENT CHARACTER if not), is silently returned, and C<*retlen> is set (if C isn't C) so that (S + C<*retlen>>) is the next possible position in C that could begin a non-malformed character. See L for details on when the REPLACEMENT CHARACTER is returned. =over 3 UV utf8_to_uvchr_buf(const U8 *s, const U8 *send, STRLEN *retlen) =back =back =for hackers Found in file utf8.c =over 4 =item C X Evaluates to 1 if the representation of code point C is the same whether or not it is encoded in UTF-8; otherwise evaluates to 0. UTF-8 invariant characters can be copied as-is when converting to/from UTF-8, saving time. C is Unicode if above 255; otherwise is platform-native. =over 3 bool UVCHR_IS_INVARIANT(UV cp) =back =back =for hackers Found in file utf8.h =over 4 =item C X returns the number of bytes required to represent the code point C when encoded as UTF-8. C is a native (ASCII or EBCDIC) code point if less than 255; a Unicode code point otherwise. =over 3 STRLEN UVCHR_SKIP(UV cp) =back =back =for hackers Found in file utf8.h =over 4 =item C X Adds the UTF-8 representation of the native code point C to the end of the string C; C should have at least C (up to C) free bytes available. The return value is the pointer to the byte after the end of the new character. In other words, d = uvchr_to_utf8(d, uv); is the recommended wide native character-aware way of saying *(d++) = uv; This function accepts any code point from 0..C as input. C is typically 0x7FFF_FFFF in a 32-bit word. It is possible to forbid or warn on non-Unicode code points, or those that may be problematic by using L. =over 3 U8* uvchr_to_utf8(U8 *d, UV uv) =back =back =for hackers Found in file utf8.c =over 4 =item C X Adds the UTF-8 representation of the native code point C to the end of the string C; C should have at least C (up to C) free bytes available. The return value is the pointer to the byte after the end of the new character. In other words, d = uvchr_to_utf8_flags(d, uv, flags); or, in most cases, d = uvchr_to_utf8_flags(d, uv, 0); This is the Unicode-aware way of saying *(d++) = uv; If C is 0, this function accepts any code point from 0..C as input. C is typically 0x7FFF_FFFF in a 32-bit word. Specifying C can further restrict what is allowed and not warned on, as follows: If C is a Unicode surrogate code point and C is set, the function will raise a warning, provided UTF8 warnings are enabled. If instead C is set, the function will fail and return NULL. If both flags are set, the function will both warn and return NULL. Similarly, the C and C flags affect how the function handles a Unicode non-character. And likewise, the C and C 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 C selects all three of the above WARN flags; and C selects all three DISALLOW flags. C restricts the allowed inputs to the strict UTF-8 traditionally defined by Unicode. Similarly, C and C are shortcuts to select the above-Unicode and surrogate flags, but not the non-character ones, as defined in L. See L. 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 C and C flags. For more information see C>. Of course C 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 C is retained for backward compatibility: C. Similarly, C is usable instead of the more accurately named C. 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. =over 3 U8* uvchr_to_utf8_flags(U8 *d, UV uv, UV flags) =back =back =for hackers Found in file utf8.c =over 4 =item C X THIS FUNCTION SHOULD BE USED IN ONLY VERY SPECIALIZED CIRCUMSTANCES. Most code should use C()> 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. All messages that would have been displayed if all lexical warnings are enabled will be returned. It is just like C> but it takes an extra parameter placed after all the others, C. If this parameter is 0, this function behaves identically to C>. Otherwise, C should be a pointer to an C variable, in which this function creates a new HV to contain any appropriate messages. The hash has three key-value pairs, as follows: =over 4 =item C The text of the message as a C. =item C The warning category (or categories) packed into a C. =item C A single flag bit associated with this message, in a C. The bit corresponds to some bit in the C<*errors> return value, such as C. =back It's important to note that specifying this parameter as non-null will cause any warnings this function would otherwise generate to be suppressed, and instead be placed in C<*msgs>. The caller 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 HV. =over 3 U8* uvchr_to_utf8_flags_msgs(U8 *d, UV uv, UV flags, HV ** msgs) =back =back =for hackers Found in file utf8.c =head1 Utility Functions =over 4 =item C X Returns a pointer to one element past the final element of the input C array. =over 3 void * C_ARRAY_END(void *a) =back =back =for hackers Found in file handy.h =over 4 =item C X Returns the number of elements in the input C array (so you want your zero-based indices to be less than but not equal to). =over 3 STRLEN C_ARRAY_LENGTH(void *a) =back =back =for hackers Found in file handy.h =over 4 =item C X Fill C with current working directory =over 3 int getcwd_sv(SV* sv) =back =back =for hackers Found in file util.c =over 4 =item C X Returns 1 if this macro is being called during the compilation phase of the program; otherwise 0; =over 3 bool IN_PERL_COMPILETIME =back =back =for hackers Found in file cop.h =over 4 =item C X Returns 1 if this macro is being called during the execution phase of the program; otherwise 0; =over 3 bool IN_PERL_RUNTIME =back =back =for hackers Found in file cop.h =over 4 =item C X Same as L. =over 3 bool IS_SAFE_SYSCALL(NN const char *pv, STRLEN len, NN const char *what, NN const char *op_name) =back =back =for hackers Found in file perl.h =over 4 =item C X Test that the given C (with length C) doesn't contain any internal C characters. If it does, set C to C, optionally warn using the C category, and return FALSE. Return TRUE if the name is safe. C and C are used in any warning. Used by the C macro. =over 3 bool is_safe_syscall(const char *pv, STRLEN len, const char *what, const char *op_name) =back =back =for hackers Found in file inline.h =over 4 =item C X A wrapper for the C library L. Don't use the latter, as the perl version has desirable safeguards =over 3 void my_setenv(const char* nam, const char* val) =back =back =for hackers Found in file util.c =over 4 =item C X Returns the given phase's name as a NUL-terminated string. 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); =over 3 const char *const phase_name(enum perl_phase) =back =back =for hackers Found in file perl.h =over 4 =item C X PoisonWith(0xEF) for catching access to freed memory. =over 3 void Poison(void* dest, int nitems, type) =back =back =for hackers Found in file handy.h =over 4 =item C X PoisonWith(0xEF) for catching access to freed memory. =over 3 void PoisonFree(void* dest, int nitems, type) =back =back =for hackers Found in file handy.h =over 4 =item C X PoisonWith(0xAB) for catching access to allocated but uninitialized memory. =over 3 void PoisonNew(void* dest, int nitems, type) =back =back =for hackers Found in file handy.h =over 4 =item C X Fill up memory with a byte pattern (a byte repeated over and over again) that hopefully catches attempts to access uninitialized memory. =over 3 void PoisonWith(void* dest, int nitems, type, U8 byte) =back =back =for hackers Found in file handy.h =over 4 =item C X This is an architecture-independent macro to copy one structure to another. =over 3 void StructCopy(type *src, type *dest, type) =back =back =for hackers Found in file handy.h =over 4 =item C X Dummy routine which reports that object can be destroyed when there is no sharing module present. It ignores its single SV argument, and returns 'true'. Exists to avoid test for a C function pointer and because it could potentially warn under some level of strict-ness. =over 3 bool sv_destroyable(SV *sv) =back =back =for hackers Found in file util.c =over 4 =item C X Dummy routine which "shares" an SV when there is no sharing module present. Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument. Exists to avoid test for a C function pointer and because it could potentially warn under some level of strict-ness. =over 3 void sv_nosharing(SV *sv) =back =back =for hackers Found in file util.c =head1 Versioning =over 4 =item C X Returns a new version object based on the passed in 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. =over 3 SV* new_version(SV *ver) =back =back =for hackers Found in file vutil.c =over 4 =item C X C> It is planned to remove C from a future release of Perl. Do not use it for new code; remove it from existing code. The major number component of the perl interpreter currently being compiled or executing. This has been C<5> from 1993 into 2020. Instead use one of the version comparison macros. See C>. =back =for hackers Found in file patchlevel.h =over 4 =item C X C> It is planned to remove C from a future release of Perl. Do not use it for new code; remove it from existing code. 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 C>. =back =for hackers Found in file patchlevel.h =over 4 =item C X C> It is planned to remove C from a future release of Perl. Do not use it for new code; remove it from existing code. 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 C>. =back =for hackers Found in file patchlevel.h =over 4 =item C =item C =item C =item C =item C =item C XXXXXX Returns whether or not the perl currently being compiled has the specified relationship to the perl given by the parameters. For example, #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 C to using this macro: #if PERL_VERSION <= 9 becomes #if PERL_VERSION_LE(5,9,'*') =over 3 bool PERL_VERSION_EQ(const U8 major, const U8 minor, const U8 patch) =back =back =for hackers Found in file handy.h =over 4 =item C X Validate that a given string can be parsed as a version object, but doesn't actually perform the parsing. Can use either strict or lax validation rules. Can optionally set a number of hint variables to save the parsing code some time when tokenizing. =over 3 const char* prescan_version(const char *s, bool strict, const char** errstr, bool *sqv, int *ssaw_decimal, int *swidth, bool *salpha) =back =back =for hackers Found in file vutil.c =over 4 =item C X Returns a pointer to the next character after the parsed version string, as well as upgrading the passed in SV to an RV. 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. =over 3 const char* scan_version(const char *s, SV *rv, bool qv) =back =back =for hackers Found in file vutil.c =over 4 =item C X In-place upgrade of the supplied SV to a version object. 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. =over 3 SV* upg_version(SV *ver, bool qv) =back =back =for hackers Found in file vutil.c =over 4 =item C X Version object aware cmp. Both operands must already have been converted into version objects. =over 3 int vcmp(SV *lhv, SV *rhv) =back =back =for hackers Found in file vutil.c =over 4 =item C X Accepts a version object and returns the normalized string representation. Call like: 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. =over 3 SV* vnormal(SV *vs) =back =back =for hackers Found in file vutil.c =over 4 =item C X Accepts a version object and returns the normalized floating point representation. Call like: 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. =over 3 SV* vnumify(SV *vs) =back =back =for hackers Found in file vutil.c =over 4 =item C X In order to maintain maximum compatibility with earlier versions of Perl, this function will return either the floating point notation or the multiple dotted notation, depending on whether the original version contained 1 or more dots, respectively. The SV returned has a refcount of 1. =over 3 SV* vstringify(SV *vs) =back =back =for hackers Found in file vutil.c =over 4 =item C X Validates that the SV contains valid internal structure for a version object. It may be passed either the version object (RV) or the hash itself (HV). If the structure is valid, it returns the HV. If the structure is invalid, it returns NULL. 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): =over 4 =item * The SV is an HV or a reference to an HV =item * The hash contains a "version" key =item * The "version" key has a reference to an AV as its value =back =over 3 SV* vverify(SV *vs) =back =back =for hackers Found in file vutil.c =head1 Warning and Dieing In all these calls, the C> parameters are warning category constants. You can see the ones currently available in L, just capitalize all letters in the names and prefix them by C. So, for example, the category C used in a perl program becomes C when used in XS code and passed to one of the calls below. =over 4 =item C =item C =item C =item C XXXX These return a boolean as to whether or not warnings are enabled for any of the warning category(ies) parameters: C, C, .... Should any of the categories by default be enabled even if not within the scope of S>, instead use the C> macros. The categories must be completely independent, one may not be subclassed from the other. =over 3 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) =back =back =for hackers Found in file warnings.h =over 4 =item C =item C =item C =item C XXXX Like C>, but for use if and only if the warning category(ies) is by default enabled even if not within the scope of S>. =over 3 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) =back =back =for hackers Found in file warnings.h =over 4 =item C =item C XX If none of the warning categories given by C are enabled, do nothing; otherwise call C> or C> with the passed-in parameters;. C must be one of the C>, C, C, C macros populated with the appropriate number of warning categories. The two forms differ only in that C should be used if warnings for any of the categories are by default enabled. NOTE: C must be explicitly called as C with an C parameter. NOTE: C must be explicitly called as C with an C parameter. =over 3 void Perl_ck_warner(pTHX_ U32 err, const char* pat, ...) =back =back =for hackers Found in file util.c =over 4 =item C X Clear the contents of C<$@>, setting it to the empty string. This replaces any read-only SV with a fresh SV and removes any magic. =over 3 void CLEAR_ERRSV() =back =back =for hackers Found in file perl.h =over 4 =item C =item C XX These are XS interfaces to Perl's C function. 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 C>. The error message will be used as an exception, by default returning control to the nearest enclosing C, but subject to modification by a C<$SIG{__DIE__}> handler. In any case, these croak functions never return normally. For historical reasons, if C is null then the contents of C (C<$@>) 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 C> function, which does not involve clobbering C. The two forms differ only in that C does not take a thread context (C) parameter. It is usually preferred as it takes up fewer bytes of code than plain C, and time is rarely a critical resource when you are about to throw an exception. NOTE: C must be explicitly called as C with an C parameter. =over 3 void Perl_croak (pTHX_ const char* pat, ...) void croak_nocontext(const char* pat, ...) =back =back =for hackers Found in file util.c =over 4 =item C X This encapsulates a common reason for dying, generating terser object code than using the generic C. It is exactly equivalent to C (which expands to something like "Modification of a read-only value attempted"). Less code used on exception code paths reduces CPU cache pressure. =over 3 void croak_no_modify() =back =back =for hackers Found in file util.c =over 4 =item C X This is an XS interface to Perl's C function. C 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 L. The error message or object will be used as an exception, by default returning control to the nearest enclosing C, but subject to modification by a C<$SIG{__DIE__}> handler. In any case, the C function never returns normally. To die with a simple string message, the L function may be more convenient. =over 3 void croak_sv(SV *baseex) =back =back =for hackers Found in file util.c =over 4 =item C X Behaves the same as L, except for the return type. It should be used only where the C return type is required. The function never actually returns. NOTE: C must be explicitly called as C with an C parameter. =over 3 OP* Perl_die(pTHX_ const char* pat, ...) =back =back =for hackers Found in file util.c =over 4 =item C =item C XX These ehave the same as L, except for the return type. It should be used only where the C return type is required. The functions never actually return. The two forms differ only in that C does not take a thread context (C) parameter, so is used in situations where the caller doesn't already have the thread context. =over 3 OP* die_sv (SV *baseex) OP* die_nocontext(const char* pat, ...) =back =back =for hackers Found in file util.c =over 4 =item C X Returns the SV for C<$@>, creating it if needed. =over 3 SV * ERRSV =back =back =for hackers Found in file perl.h =over 4 =item C =item C =item C =item C XXXX These macros are used to pack warning categories into a single U32 to pass to macros and functions that take a warning category parameter. The number of categories to pack is given by the name, with a corresponding number of category parameters passed. =over 3 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) =back =back =for hackers Found in file warnings.h =over 4 =item C X The currently active COP (control op) roughly representing the current statement in the source. 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. =over 3 COP* PL_curcop =back =back =for hackers Found in file intrpvar.h =over 4 =item C X The stash for the package code will be compiled into. 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. =over 3 HV* PL_curstash =back =back =for hackers Found in file intrpvar.h =over 4 =item C X The GV representing C<*_>. Useful for access to C<$_>. 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. =over 3 GV * PL_defgv =back =back =for hackers Found in file intrpvar.h =over 4 =item C X Clean up ERRSV so we can safely set it. This replaces any read-only SV with a fresh writable copy and removes any magic. =over 3 void SANE_ERRSV() =back =back =for hackers Found in file perl.h =over 4 =item C X This is an XS interface to Perl's C function. C and C 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 L. The error message will be used as an exception, by default returning control to the nearest enclosing C, but subject to modification by a C<$SIG{__DIE__}> handler. In any case, the C function never returns normally. For historical reasons, if C is null then the contents of C (C<$@>) 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 L function, which does not involve clobbering C. =over 3 void vcroak(const char* pat, va_list* args) =back =back =for hackers Found in file util.c =over 4 =item C X This is an XS interface to Perl's C function. This is like C>, but C are an encapsulated argument list. Unlike with L, C is not permitted to be null. =over 3 void vwarn(const char* pat, va_list* args) =back =back =for hackers Found in file util.c =over 4 =item C X This is like C>, but C are an encapsulated argument list. =over 3 void vwarner(U32 err, const char* pat, va_list* args) =back =back =for hackers Found in file util.c =over 4 =item C =item C XX These are XS interfaces to Perl's C function. 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 C>. The error message or object will by default be written to standard error, but this is subject to modification by a C<$SIG{__WARN__}> handler. Unlike with C>, C is not permitted to be null. The two forms differ only in that C does not take a thread context (C) parameter, so is used in situations where the caller doesn't already have the thread context. NOTE: C must be explicitly called as C with an C parameter. =over 3 void Perl_warn (pTHX_ const char* pat, ...) void warn_nocontext(const char* pat, ...) =back =back =for hackers Found in file util.c =over 4 =item C =item C XX These output a warning of the specified category (or categories) given by C, using the sprintf-style format pattern C, and argument list. C must be one of the C>, C, C, C 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 L. The error message or object will by default be written to standard error, but this is subject to modification by a C<$SIG{__WARN__}> handler. C is not permitted to be null. The two forms differ only in that C does not take a thread context (C) parameter, so is used in situations where the caller doesn't already have the thread context. These functions differ from the similarly named C> 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. NOTE: C must be explicitly called as C with an C parameter. =over 3 void Perl_warner (pTHX_ U32 err, const char* pat, ...) void warner_nocontext(U32 err, const char* pat, ...) =back =back =for hackers Found in file util.c =over 4 =item C X This is an XS interface to Perl's C function. C 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 L. The error message or object will by default be written to standard error, but this is subject to modification by a C<$SIG{__WARN__}> handler. To warn with a simple string message, the L function may be more convenient. =over 3 void warn_sv(SV *baseex) =back =back =for hackers Found in file util.c =head1 XS F compiles XS code into C. See L. =for comment Some variables below are flagged with 'u' because Devel::PPPort can't currently readily test them as they spring into existence by compiling with xsubpp. =over 4 =item C X Variable which is setup by C to indicate the stack base offset, used by the C, C and C macros. The C macro must be called prior to setup the C variable. =over 3 I32 ax =back =back =for hackers Found in file XSUB.h =over 4 =item C X Variable which is setup by C to indicate the class name for a C++ XS constructor. This is always a C. See C>. =over 3 char* CLASS =back =back =for hackers Found in file XSUB.h =over 4 =item C X Sets up the C variable. This is usually handled automatically by C by calling C. =over 3 dAX; =back =back =for hackers Found in file XSUB.h =over 4 =item C X Sets up the C variable and stack marker variable C. This is usually handled automatically by C by calling C. =over 3 dAXMARK; =back =back =for hackers Found in file XSUB.h =over 4 =item C X Sets up the C variable. This is usually handled automatically by C by calling C. =over 3 dITEMS; =back =back =for hackers Found in file XSUB.h =over 4 =item C X Now a placeholder that declares nothing =over 3 dMY_CXT_SV; =back =back =for hackers Found in file perl.h =over 4 =item C X Sets up any variable needed by the C macro. It used to define C, but it is currently a noop. However, it is strongly advised to still use it for ensuring past and future compatibility. =over 3 dUNDERBAR; =back =back =for hackers Found in file XSUB.h =over 4 =item C X Sets up stack and mark pointers for an XSUB, calling C and C. Sets up the C and C variables by calling C and C. This is usually handled automatically by C. =over 3 dXSARGS; =back =back =for hackers Found in file XSUB.h =over 4 =item C X Sets up the C variable for an XSUB which has aliases. This is usually handled automatically by C. =over 3 dXSI32; =back =back =for hackers Found in file XSUB.h =over 4 =item C X Variable which is setup by C to indicate the number of items on the stack. See L. =over 3 I32 items =back =back =for hackers Found in file XSUB.h =over 4 =item C X Variable which is setup by C to indicate which of an XSUB's aliases was used to invoke it. See L. =over 3 I32 ix =back =back =for hackers Found in file XSUB.h =over 4 =item C X Variable which is setup by C to hold the return value for an XSUB. This is always the proper type for the XSUB. See L. =over 3 type RETVAL =back =back =for hackers Found in file XSUB.h =over 4 =item C X Used to access elements on the XSUB's stack. =over 3 SV* ST(int ix) =back =back =for hackers Found in file XSUB.h =over 4 =item C X Variable which is setup by C to designate the object in a C++ XSUB. This is always the proper type for the C++ object. See C> and L. =over 3 type THIS =back =back =for hackers Found in file XSUB.h =over 4 =item C X The SV* corresponding to the C<$_> variable. Works even if there is a lexical C<$_> in scope. =back =for hackers Found in file XSUB.h =over 4 =item C X Macro to declare an XSUB and its C parameter list. This is handled by C. It is the same as using the more explicit C macro; the latter is preferred. =back =for hackers Found in file XSUB.h =over 4 =item C X Macro to declare an XSUB and its C parameter list explicitly exporting the symbols. =back =for hackers Found in file XSUB.h =over 4 =item C X Macro to declare an XSUB and its C parameter list without exporting the symbols. This is handled by C and generally preferable over exporting the XSUB symbols unnecessarily. =for comment XS_INTERNAL marked 'u' because declaring a function static within our test function doesn't work =back =for hackers Found in file XSUB.h =over 4 =item C X Macro used by C> and C> to declare a function prototype. You probably shouldn't be using this directly yourself. =back =for hackers Found in file XSUB.h =head1 Undocumented elements 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 L. 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. XXXXX XXXX XXXXX XXXXXX XXXXXX XXXXX XXXXXX XXXXX XXXXX XXXXX XXXX XXXXXX XXXXX XXXX XXXXX XXXXX XXXXX XXXXX XXXXX XXXXXX XXXXXX XXXXX XXXX XXXX XXXXX XXXXX XXXXX XXXX XXXXX XXX XXXX XXXXX XXXXX XXXXX XXXX XXXX =over 4 amagic_call gv_name_set PerlIO_fill amagic_deref_call gv_SVadd PerlIO_unread any_dup he_dup pmop_dump atfork_lock hek_dup pop_scope atfork_unlock hv_delayfree_ent pregfree block_gimme hv_eiter_p ptr_table_fetch call_atexit hv_eiter_set ptr_table_free call_list hv_free_ent ptr_table_new clear_defarray hv_ksplit ptr_table_split clone_params_del hv_name_set ptr_table_store clone_params_new hv_placeholders_get push_scope CvDEPTH hv_placeholders_set re_compile deb hv_rand_set regdump deb_nocontext hv_riter_p repeatcpy debop hv_riter_set rsignal_state debprofdump init_stacks rvpv_dup debstack init_tm save_adelete debstackptrs is_lvalue_sub save_aelem dirp_dup leave_scope save_aelem_flags do_aspawn magic_dump save_alloc do_close markstack_grow save_generic_pvref do_join mfree save_generic_svref do_open mg_dup save_hdelete do_openn mg_size save_helem doref mro_get_from_name save_helem_flags do_spawn mro_set_mro save_hints do_spawn_nowait my_chsize save_op do_sprintf my_cxt_init save_padsv_and_mortalize dounwind my_dirfd save_pushi32ptr dowantarray my_failure_exit save_pushptr dump_eval my_fflush_all save_pushptrptr dump_form my_fork save_set_svflags dump_mstats my_pclose save_shared_pvref dump_sub my_popen savestack_grow filter_del my_popen_list savestack_grow_cnt fp_dup my_socketpair save_vptr get_context newANONATTRSUB scan_vstring get_mstats newANONHASH seed get_op_descs newANONLIST set_context get_op_names newANONSUB share_hek get_ppaddr newAVREF si_dup get_vtbl newCVREF ss_dup gp_dup newFORM start_subparse gp_free newGVgen sv_2pvbyte_flags gp_ref newGVgen_flags sv_2pvutf8_flags gv_add_by_type newGVREF SvAMAGIC_off Gv_AMupdate newHVhv SvAMAGIC_on gv_autoload_pv newHVREF sv_dup gv_autoload_pvn newIO sv_dup_inc gv_autoload_sv newMYSUB sv_peek gv_AVadd newPROG sys_intern_clear gv_dump new_stackinfo sys_intern_dup gv_efullname3 newSVREF sys_intern_init gv_efullname4 op_refcnt_lock taint_env gv_fullname3 op_refcnt_unlock taint_proper gv_fullname4 parser_dup unsharepvn gv_handler perl_alloc_using vdeb gv_HVadd perl_clone_using gv_IOadd PerlIO_context_layers =back =head1 AUTHORS Until May 1997, this document was maintained by Jeff Okamoto . 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 . Updated to be autogenerated from comments in the source by Benjamin Stuhl. =head1 SEE ALSO F, L, L, L, L, L, L, L, L, L, L, L =cut ex: set ro: