-*- 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!
=head1 NAME
perlintern - autogenerated documentation of purely B
Perl functions
=head1 DESCRIPTION
X X
This file is the autogenerated documentation of functions in the
Perl interpreter that are documented using Perl's internal documentation
format but are not marked as part of the Perl API. In other words,
B!
=head1 Array Manipulation Functions
=over 8
=item AvFILLp
X
int AvFILLp(AV* av)
=for hackers
Found in file av.h
=back
=head1 Compile-time scope hooks
=over 8
=item BhkENTRY
X
NOTE: this function is experimental and may change or be
removed without notice.
Return an entry from the BHK structure. C is a preprocessor token
indicating which entry to return. If the appropriate flag is not set
this will return C. The type of the return value depends on which
entry you ask for.
void * BhkENTRY(BHK *hk, which)
=for hackers
Found in file op.h
=item BhkFLAGS
X
NOTE: this function is experimental and may change or be
removed without notice.
Return the BHK's flags.
U32 BhkFLAGS(BHK *hk)
=for hackers
Found in file op.h
=item CALL_BLOCK_HOOKS
X
NOTE: this function is experimental and may change or be
removed without notice.
Call all the registered block hooks for type C. C is a
preprocessing token; the type of C depends on C.
void CALL_BLOCK_HOOKS(which, arg)
=for hackers
Found in file op.h
=back
=head1 Custom Operators
=over 8
=item core_prototype
X
This function assigns the prototype of the named core function to C, or
to a new mortal SV if C is C. It returns the modified C, or
C if the core function has no prototype. C is a code as returned
by C. It must not be equal to 0.
SV * core_prototype(SV *sv, const char *name,
const int code,
int * const opnum)
=for hackers
Found in file op.c
=back
=head1 CV Manipulation Functions
=over 8
=item docatch
X
Check for the cases 0 or 3 of cur_env.je_ret, only used inside an eval context.
0 is used as continue inside eval,
3 is used for a die caught by an inner eval - continue inner loop
See F: je_mustcatch, when set at any runlevel to TRUE, means eval ops must
establish a local jmpenv to handle exception traps.
OP* docatch(Perl_ppaddr_t firstpp)
=for hackers
Found in file pp_ctl.c
=back
=head1 CV reference counts and CvOUTSIDE
=over 8
=item CvWEAKOUTSIDE
X
Each CV has a pointer, C, to its lexically enclosing
CV (if any). Because pointers to anonymous sub prototypes are
stored in C<&> pad slots, it is a possible to get a circular reference,
with the parent pointing to the child and vice-versa. To avoid the
ensuing memory leak, we do not increment the reference count of the CV
pointed to by C in the I that the parent
has a C<&> pad slot pointing back to us. In this case, we set the
C flag in the child. This allows us to determine under what
circumstances we should decrement the refcount of the parent when freeing
the child.
There is a further complication with non-closure anonymous subs (i.e. those
that do not refer to any lexicals outside that sub). In this case, the
anonymous prototype is shared rather than being cloned. This has the
consequence that the parent may be freed while there are still active
children, I,
BEGIN { $a = sub { eval '$x' } }
In this case, the BEGIN is freed immediately after execution since there
are no active references to it: the anon sub prototype has
C set since it's not a closure, and $a points to the same
CV, so it doesn't contribute to BEGIN's refcount either. When $a is
executed, the C causes the chain of Cs to be followed,
and the freed BEGIN is accessed.
To avoid this, whenever a CV and its associated pad is freed, any
C<&> entries in the pad are explicitly removed from the pad, and if the
refcount of the pointed-to anon sub is still positive, then that
child's C is set to point to its grandparent. This will only
occur in the single specific case of a non-closure anon prototype
having one or more active references (such as C<$a> above).
One other thing to consider is that a CV may be merely undefined
rather than freed, eg C. In this case, its refcount may
not have reached zero, but we still delete its pad and its C etc.
Since various children may still have their C pointing at this
undefined CV, we keep its own C for the time being, so that
the chain of lexical scopes is unbroken. For example, the following
should print 123:
my $x = 123;
sub tmp { sub { eval '$x' } }
my $a = tmp();
undef &tmp;
print $a->();
bool CvWEAKOUTSIDE(CV *cv)
=for hackers
Found in file cv.h
=back
=head1 Embedding Functions
=over 8
=item cv_dump
X
dump the contents of a CV
void cv_dump(const CV *cv, const char *title)
=for hackers
Found in file pad.c
=item cv_forget_slab
X
When a CV has a reference count on its slab (C), it is responsible
for making sure it is freed. (Hence, no two CVs should ever have a
reference count on the same slab.) The CV only needs to reference the slab
during compilation. Once it is compiled and C attached, it has
finished its job, so it can forget the slab.
void cv_forget_slab(CV *cv)
=for hackers
Found in file pad.c
=item do_dump_pad
X
Dump the contents of a padlist
void do_dump_pad(I32 level, PerlIO *file,
PADLIST *padlist, int full)
=for hackers
Found in file pad.c
=item pad_alloc_name
X
Allocates a place in the currently-compiling
pad (via L) and
then stores a name for that entry. C is adopted and
becomes the name entry; it must already contain the name
string. C and C and the C
flag get added to C. None of the other
processing of L
is done. Returns the offset of the allocated pad slot.
PADOFFSET pad_alloc_name(PADNAME *name, U32 flags,
HV *typestash, HV *ourstash)
=for hackers
Found in file pad.c
=item pad_block_start
X
Update the pad compilation state variables on entry to a new block.
void pad_block_start(int full)
=for hackers
Found in file pad.c
=item pad_check_dup
X
Check for duplicate declarations: report any of:
* a 'my' in the current scope with the same name;
* an 'our' (anywhere in the pad) with the same name and the
same stash as 'ourstash'
C indicates that the name to check is an C<"our"> declaration.
void pad_check_dup(PADNAME *name, U32 flags,
const HV *ourstash)
=for hackers
Found in file pad.c
=item pad_findlex
X
Find a named lexical anywhere in a chain of nested pads. Add fake entries
in the inner pads if it's found in an outer one.
Returns the offset in the bottom pad of the lex or the fake lex.
C is the CV in which to start the search, and seq is the current C
to match against. If C is true, print appropriate warnings. The C*
vars return values, and so are pointers to where the returned values
should be stored. C, if non-null, requests that the innermost
instance of the lexical is captured; C is set to the innermost
matched pad name or fake pad name; C returns the flags normally
associated with the C field of a fake pad name.
Note that C is recursive; it recurses up the chain of CVs,
then comes back down, adding fake entries
as it goes. It has to be this way
because fake names in anon protoypes have to store in C the
index into the parent pad.
PADOFFSET pad_findlex(const char *namepv,
STRLEN namelen, U32 flags,
const CV* cv, U32 seq, int warn,
SV** out_capture,
PADNAME** out_name,
int *out_flags)
=for hackers
Found in file pad.c
=item pad_fixup_inner_anons
X
For any anon CVs in the pad, change C of that CV from
C to C if necessary. Needed when a newly-compiled CV has to be
moved to a pre-existing CV struct.
void pad_fixup_inner_anons(PADLIST *padlist,
CV *old_cv, CV *new_cv)
=for hackers
Found in file pad.c
=item pad_free
X
Free the SV at offset po in the current pad.
void pad_free(PADOFFSET po)
=for hackers
Found in file pad.c
=item pad_leavemy
X
Cleanup at end of scope during compilation: set the max seq number for
lexicals in this scope and warn of any lexicals that never got introduced.
OP * pad_leavemy()
=for hackers
Found in file pad.c
=item padlist_dup
X
Duplicates a pad.
PADLIST * padlist_dup(PADLIST *srcpad,
CLONE_PARAMS *param)
=for hackers
Found in file pad.c
=item padname_dup
X
Duplicates a pad name.
PADNAME * padname_dup(PADNAME *src, CLONE_PARAMS *param)
=for hackers
Found in file pad.c
=item padnamelist_dup
X
Duplicates a pad name list.
PADNAMELIST * padnamelist_dup(PADNAMELIST *srcpad,
CLONE_PARAMS *param)
=for hackers
Found in file pad.c
=item pad_push
X
Push a new pad frame onto the padlist, unless there's already a pad at
this depth, in which case don't bother creating a new one. Then give
the new pad an C<@_> in slot zero.
void pad_push(PADLIST *padlist, int depth)
=for hackers
Found in file pad.c
=item pad_reset
X
Mark all the current temporaries for reuse
void pad_reset()
=for hackers
Found in file pad.c
=item pad_swipe
X
Abandon the tmp in the current pad at offset C and replace with a
new one.
void pad_swipe(PADOFFSET po, bool refadjust)
=for hackers
Found in file pad.c
=back
=head1 Errno
=over 8
=item dSAVEDERRNO
X
Declare variables needed to save C and any operating system
specific error number.
void dSAVEDERRNO
=for hackers
Found in file perl.h
=item dSAVE_ERRNO
X
Declare variables needed to save C and any operating system
specific error number, and save them for optional later restoration
by C.
void dSAVE_ERRNO
=for hackers
Found in file perl.h
=item RESTORE_ERRNO
X
Restore C and any operating system specific error number that
was saved by C or C.
void RESTORE_ERRNO
=for hackers
Found in file perl.h
=item SAVE_ERRNO
X
Save C and any operating system specific error number for
optional later restoration by C. Requires
C or C in scope.
void SAVE_ERRNO
=for hackers
Found in file perl.h
=item SETERRNO
X
Set C, and on VMS set C.
void SETERRNO(int errcode, int vmserrcode)
=for hackers
Found in file perl.h
=back
=head1 GV Functions
=over 8
=item gv_try_downgrade
X
NOTE: this function is experimental and may change or be
removed without notice.
If the typeglob C can be expressed more succinctly, by having
something other than a real GV in its place in the stash, replace it
with the optimised form. Basic requirements for this are that C
is a real typeglob, is sufficiently ordinary, and is only referenced
from its package. This function is meant to be used when a GV has been
looked up in part to see what was there, causing upgrading, but based
on what was found it turns out that the real GV isn't required after all.
If C is a completely empty typeglob, it is deleted from the stash.
If C is a typeglob containing only a sufficiently-ordinary constant
sub, the typeglob is replaced with a scalar-reference placeholder that
more compactly represents the same thing.
void gv_try_downgrade(GV* gv)
=for hackers
Found in file gv.c
=back
=head1 Hash Manipulation Functions
=over 8
=item hv_ename_add
X
Adds a name to a stash's internal list of effective names. See
C>.
This is called when a stash is assigned to a new location in the symbol
table.
void hv_ename_add(HV *hv, const char *name, U32 len,
U32 flags)
=for hackers
Found in file hv.c
=item hv_ename_delete
X
Removes a name from a stash's internal list of effective names. If this is
the name returned by C, then another name in the list will take
its place (C will use it).
This is called when a stash is deleted from the symbol table.
void hv_ename_delete(HV *hv, const char *name,
U32 len, U32 flags)
=for hackers
Found in file hv.c
=item refcounted_he_chain_2hv
X
Generates and returns a C representing the content of a
C chain.
C is currently unused and must be zero.
HV * refcounted_he_chain_2hv(
const struct refcounted_he *c, U32 flags
)
=for hackers
Found in file hv.c
=item refcounted_he_fetch_pv
X
Like L, but takes a nul-terminated string
instead of a string/length pair.
SV * refcounted_he_fetch_pv(
const struct refcounted_he *chain,
const char *key, U32 hash, U32 flags
)
=for hackers
Found in file hv.c
=item refcounted_he_fetch_pvn
X
Search along a C chain for an entry 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
representing the value associated with the key, or C<&PL_sv_placeholder>
if there is no value associated with the key.
SV * refcounted_he_fetch_pvn(
const struct refcounted_he *chain,
const char *keypv, STRLEN keylen, U32 hash,
U32 flags
)
=for hackers
Found in file hv.c
=item refcounted_he_fetch_pvs
X
Like L, but takes a literal string
instead of a string/length pair, and no precomputed hash.
SV * refcounted_he_fetch_pvs(
const struct refcounted_he *chain, "key",
U32 flags
)
=for hackers
Found in file hv.h
=item refcounted_he_fetch_sv
X
Like L, but takes a Perl scalar instead of a
string/length pair.
SV * refcounted_he_fetch_sv(
const struct refcounted_he *chain, SV *key,
U32 hash, U32 flags
)
=for hackers
Found in file hv.c
=item refcounted_he_free
X
Decrements the reference count of a C by one. If the
reference count reaches zero the structure's memory is freed, which
(recursively) causes a reduction of its parent C's
reference count. It is safe to pass a null pointer to this function:
no action occurs in this case.
void refcounted_he_free(struct refcounted_he *he)
=for hackers
Found in file hv.c
=item refcounted_he_inc
X
Increment the reference count of a C. The pointer to the
C is also returned. It is safe to pass a null pointer
to this function: no action occurs and a null pointer is returned.
struct refcounted_he * refcounted_he_inc(
struct refcounted_he *he
)
=for hackers
Found in file hv.c
=item refcounted_he_new_pv
X
Like L, but takes a nul-terminated string instead
of a string/length pair.
struct refcounted_he * refcounted_he_new_pv(
struct refcounted_he *parent,
const char *key, U32 hash,
SV *value, U32 flags
)
=for hackers
Found in file hv.c
=item refcounted_he_new_pvn
X
Creates a new C. This consists of a single key/value
pair and a reference to an existing C chain (which may
be empty), and thus forms a longer chain. When using the longer chain,
the new key/value pair takes precedence over any entry for the same key
further along the chain.
The new 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 C. Complex types of scalar will not
be stored with referential integrity, but will be coerced to strings.
C may be either null or C<&PL_sv_placeholder> to indicate that no
value is to be associated with the key; this, as with any non-null value,
takes precedence over the existence of a value for the key further along
the chain.
C points to the rest of the C chain to be
attached to the new C. This function takes ownership
of one reference to C, and returns one reference to the new
C.
struct refcounted_he * refcounted_he_new_pvn(
struct refcounted_he *parent,
const char *keypv,
STRLEN keylen, U32 hash,
SV *value, U32 flags
)
=for hackers
Found in file hv.c
=item refcounted_he_new_pvs
X
Like L, but takes a literal string
instead of a string/length pair, and no precomputed hash.
struct refcounted_he * refcounted_he_new_pvs(
struct refcounted_he *parent,
"key", SV *value, U32 flags
)
=for hackers
Found in file hv.h
=item refcounted_he_new_sv
X
Like L, but takes a Perl scalar instead of a
string/length pair.
struct refcounted_he * refcounted_he_new_sv(
struct refcounted_he *parent,
SV *key, U32 hash, SV *value,
U32 flags
)
=for hackers
Found in file hv.c
=back
=head1 IO Functions
=over 8
=item start_glob
X
NOTE: this function is experimental and may change or be
removed without notice.
Function called by C to spawn a glob (or do the glob inside
perl on VMS). This code used to be inline, but now perl uses C
this glob starter is only used by miniperl during the build process,
or when PERL_EXTERNAL_GLOB is defined.
Moving it away shrinks F; shrinking F helps speed perl up.
NOTE: this function must be explicitly called as Perl_start_glob with an aTHX_ parameter.
PerlIO* Perl_start_glob(pTHX_ SV *tmpglob, IO *io)
=for hackers
Found in file doio.c
=back
=head1 Lexer interface
=over 8
=item validate_proto
X
NOTE: this function is experimental and may change or be
removed without notice.
This function performs syntax checking on a prototype, C.
If C is true, any illegal characters or mismatched brackets
will trigger illegalproto warnings, declaring that they were
detected in the prototype for C.
The return value is C if this is a valid prototype, and
C if it is not, regardless of whether C was C or
C.
Note that C is a valid C and will always return C.
bool validate_proto(SV *name, SV *proto, bool warn,
bool curstash)
=for hackers
Found in file toke.c
=back
=head1 Magical Functions
=over 8
=item magic_clearhint
X
Triggered by a delete from C<%^H>, records the key to
C.
int magic_clearhint(SV* sv, MAGIC* mg)
=for hackers
Found in file mg.c
=item magic_clearhints
X
Triggered by clearing C<%^H>, resets C.
int magic_clearhints(SV* sv, MAGIC* mg)
=for hackers
Found in file mg.c
=item magic_methcall
X
Invoke a magic method (like FETCH).
C and C are the tied thingy and the tie magic.
C is the name of the method to call.
C is the number of args (in addition to $self) to pass to the method.
The C can be:
G_DISCARD invoke method with G_DISCARD flag and don't
return a value
G_UNDEF_FILL fill the stack with argc pointers to
PL_sv_undef
The arguments themselves are any values following the C argument.
Returns the SV (if any) returned by the method, or C on failure.
NOTE: this function must be explicitly called as Perl_magic_methcall with an aTHX_ parameter.
SV* Perl_magic_methcall(pTHX_ SV *sv,
const MAGIC *mg, SV *meth,
U32 flags, U32 argc, ...)
=for hackers
Found in file mg.c
=item magic_sethint
X
Triggered by a store to C<%^H>, records the key/value pair to
C. It is assumed that hints aren't storing
anything that would need a deep copy. Maybe we should warn if we find a
reference.
int magic_sethint(SV* sv, MAGIC* mg)
=for hackers
Found in file mg.c
=item mg_localize
X
Copy some of the magic from an existing SV to new localized version of that
SV. Container magic (I, C<%ENV>, C<$1>, C)
gets copied, value magic doesn't (I,
C, C).
If C is false then no set magic will be called on the new (empty) SV.
This typically means that assignment will soon follow (e.g. S>),
and that will handle the magic.
void mg_localize(SV* sv, SV* nsv, bool setmagic)
=for hackers
Found in file mg.c
=back
=head1 Miscellaneous Functions
=over 8
=item free_c_backtrace
X
Deallocates a backtrace received from get_c_bracktrace.
void free_c_backtrace(Perl_c_backtrace* bt)
=for hackers
Found in file util.c
=item get_c_backtrace
X
Collects the backtrace (aka "stacktrace") into a single linear
malloced buffer, which the caller B C.
Scans the frames back by S>, then drops the C innermost,
returning at most C frames.
Perl_c_backtrace* get_c_backtrace(int max_depth,
int skip)
=for hackers
Found in file util.c
=item quadmath_format_needed
X
C returns true if the C string seems to
contain at least one non-Q-prefixed C<%[efgaEFGA]> format specifier,
or returns false otherwise.
The format specifier detection is not complete printf-syntax detection,
but it should catch most common cases.
If true is returned, those arguments B in theory be processed
with C, but in case there is more than one such
format specifier (see L), and if there is
anything else beyond that one (even just a single byte), they
B be processed because C is very strict,
accepting only one format spec, and nothing else.
In this case, the code should probably fail.
bool quadmath_format_needed(const char* format)
=for hackers
Found in file util.c
=item quadmath_format_valid
X
C is very strict about its C string and will
fail, returning -1, if the format is invalid. It accepts exactly
one format spec.
C checks that the intended single spec looks
sane: begins with C<%>, has only one C<%>, ends with C<[efgaEFGA]>,
and has C before it. This is not a full "printf syntax check",
just the basics.
Returns true if it is valid, false if not.
See also L
.
bool quadmath_format_valid(const char* format)
=for hackers
Found in file util.c
=back
=head1 MRO Functions
=over 8
=item mro_get_linear_isa_dfs
X
Returns the Depth-First Search linearization of C<@ISA>
the given stash. The return value is a read-only AV*.
C should be 0 (it is used internally in this
function's recursion).
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).
AV* mro_get_linear_isa_dfs(HV* stash, U32 level)
=for hackers
Found in file mro_core.c
=item mro_isa_changed_in
X
Takes the necessary steps (cache invalidations, mostly)
when the C<@ISA> of the given package has changed. Invoked
by the C magic, should not need to invoke directly.
void mro_isa_changed_in(HV* stash)
=for hackers
Found in file mro_core.c
=item mro_package_moved
X
Call this function to signal to a stash that it has been assigned to
another spot in the stash hierarchy. C is the stash that has been
assigned. C is the stash it replaces, if any. C is the glob
that is actually being assigned to.
This can also be called with a null first argument to
indicate that C has been deleted.
This function invalidates isa caches on the old stash, on all subpackages
nested inside it, and on the subclasses of all those, including
non-existent packages that have corresponding entries in C.
It also sets the effective names (C) on all the stashes as
appropriate.
If the C is present and is not in the symbol table, then this function
simply returns. This checked will be skipped if C.
void mro_package_moved(HV * const stash,
HV * const oldstash,
const GV * const gv,
U32 flags)
=for hackers
Found in file mro_core.c
=back
=head1 Numeric functions
=over 8
=item grok_atoUV
X
parse a string, looking for a decimal unsigned integer.
On entry, C points to the beginning of the string;
C points to a UV that will receive the converted value, if found;
C is either NULL or points to a variable that points to one byte
beyond the point in C that this routine should examine.
If C is NULL, C is assumed to be NUL-terminated.
Returns FALSE if C doesn't represent a valid unsigned integer value (with
no leading zeros). Otherwise it returns TRUE, and sets C<*valptr> to that
value.
If you constrain the portion of C that is looked at by this function (by
passing a non-NULL C), and if the intial bytes of that portion form a
valid value, it will return TRUE, setting C<*endptr> to the byte following the
final digit of the value. But if there is no constraint at what's looked at,
all of C must be valid in order for TRUE to be returned. C<*endptr> is
unchanged from its value on input if FALSE is returned;
The only characters this accepts are the decimal digits '0'..'9'.
As opposed to L or L, C does NOT allow optional
leading whitespace, nor negative inputs. If such features are required, the
calling code needs to explicitly implement those.
Note that this function returns FALSE for inputs that would overflow a UV,
or have leading zeros. Thus a single C<0> is accepted, but not C<00> nor
C<01>, C<002>, I.
Background: C has severe problems with illegal inputs, it cannot be
used for incremental parsing, and therefore should be avoided
C and C are also affected by locale settings, which can also be
seen as a bug (global state controlled by user environment).
bool grok_atoUV(const char* pv, UV* valptr,
const char** endptr)
=for hackers
Found in file numeric.c
=item isinfnansv
X
Checks whether the argument would be either an infinity or C when used
as a number, but is careful not to trigger non-numeric or uninitialized
warnings. it assumes the caller has done C already.
bool isinfnansv(SV *sv)
=for hackers
Found in file numeric.c
=back
=head1 Obsolete backwards compatibility functions
=over 8
=item utf8n_to_uvuni
X
DEPRECATED! It is planned to remove this function from a
future release of Perl. Do not use it for new code; remove it from
existing code.
Instead use L, or rarely, L.
This function was useful for code that wanted to handle both EBCDIC and
ASCII platforms with Unicode properties, but starting in Perl v5.20, the
distinctions between the platforms have mostly been made invisible to most
code, so this function is quite unlikely to be what you want. If you do need
this precise functionality, use instead
C>
or C>.
UV utf8n_to_uvuni(const U8 *s, STRLEN curlen,
STRLEN *retlen, U32 flags)
=for hackers
Found in file mathoms.c
=item utf8_to_uvuni
X
DEPRECATED! It is planned to remove this function from a
future release of Perl. Do not use it for new code; remove it from
existing code.
Returns the Unicode 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 one reason why this function is deprecated. The other is that only in
extremely limited circumstances should the Unicode versus native code point be
of any interest to you. See L for alternatives.
If C points to one of the detected malformations, and UTF8 warnings are
enabled, zero is returned and C<*retlen> is set (if C doesn't point to
NULL) 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.
UV utf8_to_uvuni(const U8 *s, STRLEN *retlen)
=for hackers
Found in file mathoms.c
=item uvuni_to_utf8_flags
X
DEPRECATED! It is planned to remove this function from a
future release of Perl. Do not use it for new code; remove it from
existing code.
Instead you almost certainly want to use L or
L.
This function is a deprecated synonym for L,
which itself, while not deprecated, should be used only in isolated
circumstances. These functions were useful for code that wanted to handle
both EBCDIC and ASCII platforms with Unicode properties, but starting in Perl
v5.20, the distinctions between the platforms have mostly been made invisible
to most code, so this function is quite unlikely to be what you want.
U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
=for hackers
Found in file mathoms.c
=back
=head1 Optree Manipulation Functions
=over 8
=item finalize_optree
X
This function finalizes the optree. Should be called directly after
the complete optree is built. It does some additional
checking which can't be done in the normal Cxxx functions and makes
the tree thread-safe.
void finalize_optree(OP* o)
=for hackers
Found in file op.c
=item newATTRSUB_x
X
Construct a Perl subroutine, also performing some surrounding jobs.
This function is expected to be called in a Perl compilation context,
and some aspects of the subroutine are taken from global variables
associated with compilation. In particular, C represents
the subroutine that is currently being compiled. It must be non-null
when this function is called, and some aspects of the subroutine being
constructed are taken from it. The constructed subroutine may actually
be a reuse of the C object, but will not necessarily be so.
If C is null then the subroutine will have no body, and for the
time being it will be an error to call it. This represents a forward
subroutine declaration such as S>. If C is
non-null then it provides the Perl code of the subroutine body, which
will be executed when the subroutine is called. This body includes
any argument unwrapping code resulting from a subroutine signature or
similar. The pad use of the code must correspond to the pad attached
to C. The code is not expected to include a C or
C op; this function will add such an op. C is consumed
by this function and will become part of the constructed subroutine.
C specifies the subroutine's prototype, unless one is supplied
as an attribute (see below). If C is null, then the subroutine
will not have a prototype. If C is non-null, it must point to a
C op whose value is a string, and the subroutine will have that
string as its prototype. If a prototype is supplied as an attribute, the
attribute takes precedence over C, but in that case C should
preferably be null. In any case, C is consumed by this function.
C supplies attributes to be applied the subroutine. A handful of
attributes take effect by built-in means, being applied to C
immediately when seen. Other attributes are collected up and attached
to the subroutine by this route. C may be null to supply no
attributes, or point to a C op for a single attribute, or point
to a C op whose children apart from the C are C
ops for one or more attributes. Each C op must be a string,
giving the attribute name optionally followed by parenthesised arguments,
in the manner in which attributes appear in Perl source. The attributes
will be applied to the sub by this function. C is consumed by
this function.
If C is false and C is null, then the subroutine will
be anonymous. If C is false and C is non-null, then C
must point to a C op, which will be consumed by this function,
and its string value supplies a name for the subroutine. The name may
be qualified or unqualified, and if it is unqualified then a default
stash will be selected in some manner. If C is true, then C
doesn't point to an C at all, but is instead a cast pointer to a C