File Coverage

blib/lib/Perl/APIReference/V5_020_001.pm
Criterion Covered Total %
statement 15 15 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod 1 1 100.0
total 20 20 100.0


line stmt bran cond sub pod time code
1             package Perl::APIReference::V5_020_001;
2 1     1   8 use strict;
  1         1  
  1         49  
3 1     1   4 use warnings;
  1         2  
  1         29  
4 1     1   4 use parent 'Perl::APIReference';
  1         1  
  1         7  
5              
6             sub new {
7 1     1 1 3 my $class = shift;
8 1         1 my $VAR1;
9              
10 1         3 do{$VAR1 = {'newBINOP' => {'text' => 'Constructs, checks, and returns an op of any binary type. I
  1         1945  
11             is the opcode. I gives the eight bits of C, except
12             that C will be set automatically, and, shifted up eight bits,
13             the eight bits of C, except that the bit with value 1 or
14             2 is automatically set as required. I and I supply up to
15             two ops to be the direct children of the binary op; they are consumed
16             by this function and become part of the constructed op tree.
17              
18             OP * newBINOP(I32 type, I32 flags, OP *first,
19             OP *last)','name' => 'newBINOP'},'strGE' => {'text' => 'Test two strings to see if the first, C, is greater than or equal to
20             the second, C. Returns true or false.
21              
22             bool strGE(char* s1, char* s2)','name' => 'strGE'},'SvPV' => {'text' => 'Returns a pointer to the string in the SV, or a stringified form of
23             the SV if the SV does not contain a string. The SV may cache the
24             stringified version becoming C. Handles \'get\' magic. The
25             C variable will be set to the length of the string (this is a macro, so
26             don\'t use C<&len>). See also C for a version which guarantees to
27             evaluate sv only once.
28              
29             Note that there is no guarantee that the return value of C is
30             equal to C, or that C contains valid data, or that
31             successive calls to C will return the same pointer value each
32             time. This is due to the way that things like overloading and
33             Copy-On-Write are handled. In these cases, the return value may point to
34             a temporary buffer or similar. If you absolutely need the SvPVX field to
35             be valid (for example, if you intend to write to it), then see
36             L.
37              
38             char* SvPV(SV* sv, STRLEN len)','name' => 'SvPV'},'sv_vsetpvf_mg' => {'text' => 'Like C, but also handles \'set\' magic.
39              
40             Usually used via its frontend C.
41              
42             void sv_vsetpvf_mg(SV *const sv,
43             const char *const pat,
44             va_list *const args)','name' => 'sv_vsetpvf_mg'},'toUPPER_uni' => {'text' => 'Converts the Unicode code point C to its uppercase version, and
45             stores that in UTF-8 in C, and its length in bytes in C. Note
46             that the buffer pointed to by C needs to be at least C
47             bytes since the uppercase version may be longer than the original character.
48              
49             The first code point of the uppercased version is returned
50             (but note, as explained just above, that there may be more.)
51              
52             UV toUPPER_uni(UV cp, U8* s, STRLEN* lenp)','name' => 'toUPPER_uni'},'SvPVutf8' => {'text' => 'Like C, but converts sv to utf8 first if necessary.
53              
54             char* SvPVutf8(SV* sv, STRLEN len)','name' => 'SvPVutf8'},'sortsv_flags' => {'text' => 'Sort an array, with various options.
55              
56             void sortsv_flags(SV** array, size_t num_elts,
57             SVCOMPARE_t cmp, U32 flags)','name' => 'sortsv_flags'},'vwarn' => {'text' => 'This is an XS interface to Perl\'s C function.
58              
59             C and C are a sprintf-style format pattern and encapsulated
60             argument list. These are used to generate a string message. If the
61             message does not end with a newline, then it will be extended with
62             some indication of the current location in the code, as described for
63             L.
64              
65             The error message or object will by default be written to standard error,
66             but this is subject to modification by a C<$SIG{__WARN__}> handler.
67              
68             Unlike with L, C is not permitted to be null.
69              
70             void vwarn(const char *pat, va_list *args)','name' => 'vwarn'},'scan_oct' => {'text' => 'For backwards compatibility. Use C instead.
71              
72             NV scan_oct(const char* start, STRLEN len,
73             STRLEN* retlen)','name' => 'scan_oct'},'av_arylen_p' => {'text' => '','name' => 'av_arylen_p'},'my_strlcat' => {'text' => 'The C library C if available, or a Perl implementation of it.
74             This operates on C C-terminated strings.
75              
76             C appends string C to the end of C. It will append at
77             most S> characters. It will then C-terminate,
78             unless C is 0 or the original C string was longer than C (in
79             practice this should not happen as it means that either C is incorrect or
80             that C is not a proper C-terminated string).
81              
82             Note that C is the full size of the destination buffer and
83             the result is guaranteed to be C-terminated if there is room. Note that
84             room for the C should be included in C.
85              
86             Size_t my_strlcat(char *dst, const char *src,
87             Size_t size)','name' => 'my_strlcat'},'gv_add_by_type' => {'text' => '','name' => 'gv_add_by_type'},'newGVOP' => {'text' => 'Constructs, checks, and returns an op of any type that involves an
88             embedded reference to a GV. I is the opcode. I gives the
89             eight bits of C. I identifies the GV that the op should
90             reference; calling this function does not transfer ownership of any
91             reference to it.
92              
93             OP * newGVOP(I32 type, I32 flags, GV *gv)','name' => 'newGVOP'},'XopDISABLE' => {'text' => 'Temporarily disable a member of the XOP, by clearing the appropriate flag.
94              
95             void XopDISABLE(XOP *xop, which)','name' => 'XopDISABLE'},'hv_rand_set' => {'text' => '','name' => 'hv_rand_set'},'find_runcv' => {'text' => 'Locate the CV corresponding to the currently executing sub or eval.
96             If db_seqp is non_null, skip CVs that are in the DB package and populate
97             *db_seqp with the cop sequence number at the point that the DB:: code was
98             entered. (This allows debuggers to eval in the scope of the breakpoint
99             rather than in the scope of the debugger itself.)
100              
101             CV* find_runcv(U32 *db_seqp)','name' => 'find_runcv'},'utf8n_to_uvuni' => {'text' => 'Instead use L, or rarely, L.
102              
103             This function was useful for code that wanted to handle both EBCDIC and
104             ASCII platforms with Unicode properties, but starting in Perl v5.20, the
105             distinctions between the platforms have mostly been made invisible to most
106             code, so this function is quite unlikely to be what you want. If you do need
107             this precise functionality, use instead
108             C>
109             or C>.
110              
111             UV utf8n_to_uvuni(const U8 *s, STRLEN curlen,
112             STRLEN *retlen, U32 flags)','name' => 'utf8n_to_uvuni'},'newSVpvn_utf8' => {'text' => 'Creates a new SV and copies a string (which may contain C (C<\\0>)
113             characters) into it. If utf8 is true, calls
114             C on the new SV. Implemented as a wrapper around C.
115              
116             SV* newSVpvn_utf8(NULLOK const char* s, STRLEN len,
117             U32 utf8)','name' => 'newSVpvn_utf8'},'dMARK' => {'text' => 'Declare a stack marker variable, C, for the XSUB. See C and
118             C.
119              
120             dMARK;','name' => 'dMARK'},'whichsig_pv' => {'text' => '','name' => 'whichsig_pv'},'gv_fetchmeth_sv_autoload' => {'text' => 'Exactly like L, but takes the name string in the form
121             of an SV instead of a string/length pair.
122              
123             GV* gv_fetchmeth_sv_autoload(HV* stash, SV* namesv,
124             I32 level, U32 flags)','name' => 'gv_fetchmeth_sv_autoload'},'pregcomp' => {'text' => '','name' => 'pregcomp'},'my_cxt_index' => {'text' => '','name' => 'my_cxt_index'},'lex_discard_to' => {'text' => 'NOTE: this function is experimental and may change or be
125             removed without notice.
126              
127              
128             Discards the first part of the Llinestr> buffer,
129             up to I. The remaining content of the buffer will be moved, and
130             all pointers into the buffer updated appropriately. I must not
131             be later in the buffer than the position of Lbufptr>:
132             it is not permitted to discard text that has yet to be lexed.
133              
134             Normally it is not necessarily to do this directly, because it suffices to
135             use the implicit discarding behaviour of L and things
136             based on it. However, if a token stretches across multiple lines,
137             and the lexing code has kept multiple lines of text in the buffer for
138             that purpose, then after completion of the token it would be wise to
139             explicitly discard the now-unneeded earlier lines, to avoid future
140             multi-line tokens growing the buffer without bound.
141              
142             void lex_discard_to(char *ptr)','name' => 'lex_discard_to'},'markstack_grow' => {'text' => '','name' => 'markstack_grow'},'cv_get_call_checker' => {'text' => 'Retrieves the function that will be used to fix up a call to I.
143             Specifically, the function is applied to an C op tree for a
144             subroutine call, not marked with C<&>, where the callee can be identified
145             at compile time as I.
146              
147             The C-level function pointer is returned in I<*ckfun_p>, and an SV
148             argument for it is returned in I<*ckobj_p>. The function is intended
149             to be called in this manner:
150              
151             entersubop = (*ckfun_p)(aTHX_ entersubop, namegv, (*ckobj_p));
152              
153             In this call, I is a pointer to the C op,
154             which may be replaced by the check function, and I is a GV
155             supplying the name that should be used by the check function to refer
156             to the callee of the C op if it needs to emit any diagnostics.
157             It is permitted to apply the check function in non-standard situations,
158             such as to a call to a different subroutine or to a method call.
159              
160             By default, the function is
161             L,
162             and the SV parameter is I itself. This implements standard
163             prototype processing. It can be changed, for a particular subroutine,
164             by L.
165              
166             void cv_get_call_checker(CV *cv,
167             Perl_call_checker *ckfun_p,
168             SV **ckobj_p)','name' => 'cv_get_call_checker'},'mXPUSHp' => {'text' => 'Push a string onto the stack, extending the stack if necessary. The C
169             indicates the length of the string. Does not use C. See also C,
170             C and C.
171              
172             void mXPUSHp(char* str, STRLEN len)','name' => 'mXPUSHp'},'lex_stuff_sv' => {'text' => 'NOTE: this function is experimental and may change or be
173             removed without notice.
174              
175              
176             Insert characters into the lexer buffer (Llinestr>),
177             immediately after the current lexing point (Lbufptr>),
178             reallocating the buffer if necessary. This means that lexing code that
179             runs later will see the characters as if they had appeared in the input.
180             It is not recommended to do this as part of normal parsing, and most
181             uses of this facility run the risk of the inserted characters being
182             interpreted in an unintended manner.
183              
184             The string to be inserted is the string value of I. The characters
185             are recoded for the lexer buffer, according to how the buffer is currently
186             being interpreted (L). If a string to be inserted is
187             not already a Perl scalar, the L function avoids the
188             need to construct a scalar.
189              
190             void lex_stuff_sv(SV *sv, U32 flags)','name' => 'lex_stuff_sv'},'ibcmp_utf8' => {'text' => 'This is a synonym for (! foldEQ_utf8())
191              
192             I32 ibcmp_utf8(const char *s1, char **pe1, UV l1,
193             bool u1, const char *s2, char **pe2,
194             UV l2, bool u2)','name' => 'ibcmp_utf8'},'CvSTASH' => {'text' => 'Returns the stash of the CV. A stash is the symbol table hash, containing
195             the package-scoped variables in the package where the subroutine was defined.
196             For more information, see L.
197              
198             This also has a special use with XS AUTOLOAD subs.
199             See L.
200              
201             HV* CvSTASH(CV* cv)','name' => 'CvSTASH'},'gv_const_sv' => {'text' => 'If C is a typeglob whose subroutine entry is a constant sub eligible for
202             inlining, or C is a placeholder reference that would be promoted to such
203             a typeglob, then returns the value returned by the sub. Otherwise, returns
204             NULL.
205              
206             SV* gv_const_sv(GV* gv)','name' => 'gv_const_sv'},'sv_replace' => {'text' => 'Make the first argument a copy of the second, then delete the original.
207             The target SV physically takes over ownership of the body of the source SV
208             and inherits its flags; however, the target keeps any magic it owns,
209             and any magic in the source is discarded.
210             Note that this is a rather specialist SV copying operation; most of the
211             time you\'ll want to use C or one of its many macro front-ends.
212              
213             void sv_replace(SV *const sv, SV *const nsv)','name' => 'sv_replace'},'utf8n_to_uvchr' => {'text' => 'THIS FUNCTION SHOULD BE USED IN ONLY VERY SPECIALIZED CIRCUMSTANCES.
214             Most code should use L() rather than call this directly.
215              
216             Bottom level UTF-8 decode routine.
217             Returns the native code point value of the first character in the string C,
218             which is assumed to be in UTF-8 (or UTF-EBCDIC) encoding, and no longer than
219             C bytes; C<*retlen> (if C isn\'t NULL) will be set to
220             the length, in bytes, of that character.
221              
222             The value of C determines the behavior when C does not point to a
223             well-formed UTF-8 character. If C is 0, when a malformation is found,
224             zero is returned and C<*retlen> is set so that (S + C<*retlen>>) is the
225             next possible position in C that could begin a non-malformed character.
226             Also, if UTF-8 warnings haven\'t been lexically disabled, a warning is raised.
227              
228             Various ALLOW flags can be set in C to allow (and not warn on)
229             individual types of malformations, such as the sequence being overlong (that
230             is, when there is a shorter sequence that can express the same code point;
231             overlong sequences are expressly forbidden in the UTF-8 standard due to
232             potential security issues). Another malformation example is the first byte of
233             a character not being a legal first byte. See F for the list of such
234             flags. For allowed 0 length strings, this function returns 0; for allowed
235             overlong sequences, the computed code point is returned; for all other allowed
236             malformations, the Unicode REPLACEMENT CHARACTER is returned, as these have no
237             determinable reasonable value.
238              
239             The UTF8_CHECK_ONLY flag overrides the behavior when a non-allowed (by other
240             flags) malformation is found. If this flag is set, the routine assumes that
241             the caller will raise a warning, and this function will silently just set
242             C to C<-1> (cast to C) and return zero.
243              
244             Note that this API requires disambiguation between successful decoding a C
245             character, and an error return (unless the UTF8_CHECK_ONLY flag is set), as
246             in both cases, 0 is returned. To disambiguate, upon a zero return, see if the
247             first byte of C is 0 as well. If so, the input was a C; if not, the
248             input had an error.
249              
250             Certain code points are considered problematic. These are Unicode surrogates,
251             Unicode non-characters, and code points above the Unicode maximum of 0x10FFFF.
252             By default these are considered regular code points, but certain situations
253             warrant special handling for them. If C contains
254             UTF8_DISALLOW_ILLEGAL_INTERCHANGE, all three classes are treated as
255             malformations and handled as such. The flags UTF8_DISALLOW_SURROGATE,
256             UTF8_DISALLOW_NONCHAR, and UTF8_DISALLOW_SUPER (meaning above the legal Unicode
257             maximum) can be set to disallow these categories individually.
258              
259             The flags UTF8_WARN_ILLEGAL_INTERCHANGE, UTF8_WARN_SURROGATE,
260             UTF8_WARN_NONCHAR, and UTF8_WARN_SUPER will cause warning messages to be raised
261             for their respective categories, but otherwise the code points are considered
262             valid (not malformations). To get a category to both be treated as a
263             malformation and raise a warning, specify both the WARN and DISALLOW flags.
264             (But note that warnings are not raised if lexically disabled nor if
265             UTF8_CHECK_ONLY is also specified.)
266              
267             Very large code points (above 0x7FFF_FFFF) are considered more problematic than
268             the others that are above the Unicode legal maximum. There are several
269             reasons: they requre at least 32 bits to represent them on ASCII platforms, are
270             not representable at all on EBCDIC platforms, and the original UTF-8
271             specification never went above this number (the current 0x10FFFF limit was
272             imposed later). (The smaller ones, those that fit into 32 bits, are
273             representable by a UV on ASCII platforms, but not by an IV, which means that
274             the number of operations that can be performed on them is quite restricted.)
275             The UTF-8 encoding on ASCII platforms for these large code points begins with a
276             byte containing 0xFE or 0xFF. The UTF8_DISALLOW_FE_FF flag will cause them to
277             be treated as malformations, while allowing smaller above-Unicode code points.
278             (Of course UTF8_DISALLOW_SUPER will treat all above-Unicode code points,
279             including these, as malformations.)
280             Similarly, UTF8_WARN_FE_FF acts just like
281             the other WARN flags, but applies just to these code points.
282              
283             All other code points corresponding to Unicode characters, including private
284             use and those yet to be assigned, are never considered malformed and never
285             warn.
286              
287             UV utf8n_to_uvchr(const U8 *s, STRLEN curlen,
288             STRLEN *retlen, U32 flags)','name' => 'utf8n_to_uvchr'},'G_ARRAY' => {'text' => 'Used to indicate list context. See C, C and
289             L.','name' => 'G_ARRAY'},'sv_2iv' => {'text' => '','name' => 'sv_2iv'},'ck_warner_d' => {'text' => '','name' => 'ck_warner_d'},'XS_VERSION_BOOTCHECK' => {'text' => 'Macro to verify that a PM module\'s $VERSION variable matches the XS
290             module\'s C variable. This is usually handled automatically by
291             C. See L.
292              
293             XS_VERSION_BOOTCHECK;','name' => 'XS_VERSION_BOOTCHECK'},'pad_compname_type' => {'text' => 'Looks up the type of the lexical variable at position I in the
294             currently-compiling pad. If the variable is typed, the stash of the
295             class to which it is typed is returned. If not, C is returned.
296              
297             HV * pad_compname_type(PADOFFSET po)','name' => 'pad_compname_type'},'mXPUSHn' => {'text' => 'Push a double onto the stack, extending the stack if necessary.
298             Does not use C. See also C, C and C.
299              
300             void mXPUSHn(NV nv)','name' => 'mXPUSHn'},'SvSETMAGIC' => {'text' => 'Invokes C on an SV if it has \'set\' magic. This is necessary
301             after modifying a scalar, in case it is a magical variable like C<$|>
302             or a tied variable (it calls C). This macro evaluates its
303             argument more than once.
304              
305             void SvSETMAGIC(SV* sv)','name' => 'SvSETMAGIC'},'G_EVAL' => {'text' => 'Used to force a Perl C wrapper around a callback. See
306             L.','name' => 'G_EVAL'},'sv_catsv_mg' => {'text' => 'Like C, but also handles \'set\' magic.
307              
308             void sv_catsv_mg(SV *dsv, SV *ssv)','name' => 'sv_catsv_mg'},'call_argv' => {'text' => 'Performs a callback to the specified named and package-scoped Perl subroutine
309             with C (a NULL-terminated array of strings) as arguments. See
310             L.
311              
312             Approximate Perl equivalent: C<&{"$sub_name"}(@$argv)>.
313              
314             NOTE: the perl_ form of this function is deprecated.
315              
316             I32 call_argv(const char* sub_name, I32 flags,
317             char** argv)','name' => 'call_argv'},'save_freeop' => {'text' => '','name' => 'save_freeop'},'SvPV_nolen' => {'text' => 'Like C but doesn\'t set a length variable.
318              
319             char* SvPV_nolen(SV* sv)','name' => 'SvPV_nolen'},'alloccopstash' => {'text' => 'NOTE: this function is experimental and may change or be
320             removed without notice.
321              
322              
323             Available only under threaded builds, this function allocates an entry in
324             C for the stash passed to it.
325              
326             PADOFFSET alloccopstash(HV *hv)','name' => 'alloccopstash'},'perl_clone' => {'text' => 'Create and return a new interpreter by cloning the current one.
327              
328             perl_clone takes these flags as parameters:
329              
330             CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
331             without it we only clone the data and zero the stacks,
332             with it we copy the stacks and the new perl interpreter is
333             ready to run at the exact same point as the previous one.
334             The pseudo-fork code uses COPY_STACKS while the
335             threads->create doesn\'t.
336              
337             CLONEf_KEEP_PTR_TABLE -
338             perl_clone keeps a ptr_table with the pointer of the old
339             variable as a key and the new variable as a value,
340             this allows it to check if something has been cloned and not
341             clone it again but rather just use the value and increase the
342             refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
343             the ptr_table using the function
344             C,
345             reason to keep it around is if you want to dup some of your own
346             variable who are outside the graph perl scans, example of this
347             code is in threads.xs create.
348              
349             CLONEf_CLONE_HOST -
350             This is a win32 thing, it is ignored on unix, it tells perls
351             win32host code (which is c++) to clone itself, this is needed on
352             win32 if you want to run two threads at the same time,
353             if you just want to do some stuff in a separate perl interpreter
354             and then throw it away and return to the original one,
355             you don\'t need to do anything.
356              
357             PerlInterpreter* perl_clone(
358             PerlInterpreter *proto_perl,
359             UV flags
360             )','name' => 'perl_clone'},'save_alloc' => {'text' => '','name' => 'save_alloc'},'SvSetSV' => {'text' => 'Calls C if dsv is not the same as ssv. May evaluate arguments
361             more than once. Does not handle \'set\' magic on the destination SV.
362              
363             void SvSetSV(SV* dsv, SV* ssv)','name' => 'SvSetSV'},'rninstr' => {'text' => '','name' => 'rninstr'},'pad_findmy_pvn' => {'text' => 'Given the name of a lexical variable, find its position in the
364             currently-compiling pad.
365             I/I specify the variable\'s name, including leading sigil.
366             I is reserved and must be zero.
367             If it is not in the current pad but appears in the pad of any lexically
368             enclosing scope, then a pseudo-entry for it is added in the current pad.
369             Returns the offset in the current pad,
370             or C if no such lexical is in scope.
371              
372             PADOFFSET pad_findmy_pvn(const char *namepv,
373             STRLEN namelen, U32 flags)','name' => 'pad_findmy_pvn'},'hv_fetchs' => {'text' => 'Like C, but takes a literal string instead of a string/length pair.
374              
375             SV** hv_fetchs(HV* tb, const char* key, I32 lval)','name' => 'hv_fetchs'},'strnNE' => {'text' => 'Test two strings to see if they are different. The C parameter
376             indicates the number of bytes to compare. Returns true or false. (A
377             wrapper for C).
378              
379             bool strnNE(char* s1, char* s2, STRLEN len)','name' => 'strnNE'},'cophh_store_pv' => {'text' => 'NOTE: this function is experimental and may change or be
380             removed without notice.
381              
382              
383             Like L, but takes a nul-terminated string instead of
384             a string/length pair.
385              
386             COPHH * cophh_store_pv(const COPHH *cophh,
387             const char *key, U32 hash,
388             SV *value, U32 flags)','name' => 'cophh_store_pv'},'savepv' => {'text' => 'Perl\'s version of C. Returns a pointer to a newly allocated
389             string which is a duplicate of C. The size of the string is
390             determined by C, which means it may not contain embedded C
391             characters and must have a trailing C. The memory allocated for the new
392             string can be freed with the C function.
393              
394             On some platforms, Windows for example, all allocated memory owned by a thread
395             is deallocated when that thread ends. So if you need that not to happen, you
396             need to use the shared memory functions, such as C>.
397              
398             char* savepv(const char* pv)','name' => 'savepv'},'save_iv' => {'text' => '','name' => 'save_iv'},'HvNAME' => {'text' => 'Returns the package name of a stash, or NULL if C isn\'t a stash.
399             See C, C.
400              
401             char* HvNAME(HV* stash)','name' => 'HvNAME'},'sv_recode_to_utf8' => {'text' => 'The encoding is assumed to be an Encode object, on entry the PV
402             of the sv is assumed to be octets in that encoding, and the sv
403             will be converted into Unicode (and UTF-8).
404              
405             If the sv already is UTF-8 (or if it is not POK), or if the encoding
406             is not a reference, nothing is done to the sv. If the encoding is not
407             an C Encoding object, bad things will happen.
408             (See F and L.)
409              
410             The PV of the sv is returned.
411              
412             char* sv_recode_to_utf8(SV* sv, SV *encoding)','name' => 'sv_recode_to_utf8'},'save_hptr' => {'text' => '','name' => 'save_hptr'},'runops_debug' => {'text' => '','name' => 'runops_debug'},'do_gvgv_dump' => {'text' => '','name' => 'do_gvgv_dump'},'PERL_SYS_INIT' => {'text' => 'Provides system-specific tune up of the C runtime environment necessary to
413             run Perl interpreters. This should be called only once, before creating
414             any Perl interpreters.
415              
416             void PERL_SYS_INIT(int *argc, char*** argv)','name' => 'PERL_SYS_INIT'},'vstringify' => {'text' => 'In order to maintain maximum compatibility with earlier versions
417             of Perl, this function will return either the floating point
418             notation or the multiple dotted notation, depending on whether
419             the original version contained 1 or more dots, respectively.
420              
421             The SV returned has a refcount of 1.
422              
423             SV* vstringify(SV *vs)','name' => 'vstringify'},'sv_catsv_flags' => {'text' => 'Concatenates the string from SV C onto the end of the string in SV
424             C. If C is null, does nothing; otherwise modifies only C.
425             If C include C bit set, will call C on both SVs if
426             appropriate. If C include C, C will be called on
427             the modified SV afterward, if appropriate. C, C,
428             and C are implemented in terms of this function.
429              
430             void sv_catsv_flags(SV *const dsv, SV *const ssv,
431             const I32 flags)','name' => 'sv_catsv_flags'},'str_to_version' => {'text' => '','name' => 'str_to_version'},'sv_derived_from' => {'text' => 'Exactly like L, but doesn\'t take a C parameter.
432              
433             bool sv_derived_from(SV* sv, const char *const name)','name' => 'sv_derived_from'},'SvIOK_on' => {'text' => 'Tells an SV that it is an integer.
434              
435             void SvIOK_on(SV* sv)','name' => 'SvIOK_on'},'sv_cmp_locale' => {'text' => 'Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
436             \'use bytes\' aware, handles get magic, and will coerce its args to strings
437             if necessary. See also C.
438              
439             I32 sv_cmp_locale(SV *const sv1, SV *const sv2)','name' => 'sv_cmp_locale'},'sv_catpvs' => {'text' => 'Like C, but takes a literal string instead of a string/length pair.
440              
441             void sv_catpvs(SV* sv, const char* s)','name' => 'sv_catpvs'},'set_numeric_standard' => {'text' => '','name' => 'set_numeric_standard'},'dSP' => {'text' => 'Declares a local copy of perl\'s stack pointer for the XSUB, available via
442             the C macro. See C.
443              
444             dSP;','name' => 'dSP'},'Nullsv' => {'text' => 'Null SV pointer. (No longer available when C is defined.)','name' => 'Nullsv'},'scan_vstring' => {'text' => '','name' => 'scan_vstring'},'ptr_table_new' => {'text' => '','name' => 'ptr_table_new'},'do_op_dump' => {'text' => '','name' => 'do_op_dump'},'foldEQ' => {'text' => 'Returns true if the leading len bytes of the strings s1 and s2 are the same
445             case-insensitively; false otherwise. Uppercase and lowercase ASCII range bytes
446             match themselves and their opposite case counterparts. Non-cased and non-ASCII
447             range bytes match only themselves.
448              
449             I32 foldEQ(const char* a, const char* b, I32 len)','name' => 'foldEQ'},'PerlIO_get_base' => {'text' => '','name' => 'PerlIO_get_base'},'SvPVX' => {'text' => 'Returns a pointer to the physical string in the SV. The SV must contain a
450             string. Prior to 5.9.3 it is not safe
451             to execute this macro unless the SV\'s
452             type >= SVt_PV.
453              
454             This is also used to store the name of an autoloaded subroutine in an XS
455             AUTOLOAD routine. See L.
456              
457             char* SvPVX(SV* sv)','name' => 'SvPVX'},'av_top_index' => {'text' => 'Returns the highest index in the array. The number of elements in the
458             array is C. Returns -1 if the array is empty.
459              
460             The Perl equivalent for this is C<$#myarray>.
461              
462             (A slightly shorter form is C.)
463              
464             SSize_t av_top_index(AV *av)','name' => 'av_top_index'},'XPUSHi' => {'text' => 'Push an integer onto the stack, extending the stack if necessary. Handles
465             \'set\' magic. Uses C, so C or C should be called to
466             declare it. Do not call multiple C-oriented macros to return lists
467             from XSUB\'s - see C instead. See also C and C.
468              
469             void XPUSHi(IV iv)','name' => 'XPUSHi'},'debop' => {'text' => '','name' => 'debop'},'ref' => {'text' => '','name' => 'ref'},'sv_does_sv' => {'text' => 'Returns a boolean indicating whether the SV performs a specific, named role.
470             The SV can be a Perl object or the name of a Perl class.
471              
472             bool sv_does_sv(SV* sv, SV* namesv, U32 flags)','name' => 'sv_does_sv'},'SvOOK_offset' => {'text' => 'Reads into I the offset from SvPVX back to the true start of the
473             allocated buffer, which will be non-zero if C has been used to
474             efficiently remove characters from start of the buffer. Implemented as a
475             macro, which takes the address of I, which must be of type C.
476             Evaluates I more than once. Sets I to 0 if C is false.
477              
478             void SvOOK_offset(NN SV*sv, STRLEN len)','name' => 'SvOOK_offset'},'save_list' => {'text' => '','name' => 'save_list'},'SvTAINTED_on' => {'text' => 'Marks an SV as tainted if tainting is enabled.
479              
480             void SvTAINTED_on(SV* sv)','name' => 'SvTAINTED_on'},'newGIVENOP' => {'text' => 'Constructs, checks, and returns an op tree expressing a C block.
481             I supplies the expression that will be locally assigned to a lexical
482             variable, and I supplies the body of the C construct; they
483             are consumed by this function and become part of the constructed op tree.
484             I is the pad offset of the scalar lexical variable that will
485             be affected. If it is 0, the global $_ will be used.
486              
487             OP * newGIVENOP(OP *cond, OP *block,
488             PADOFFSET defsv_off)','name' => 'newGIVENOP'},'sv_nolocking' => {'text' => 'Dummy routine which "locks" an SV when there is no locking module present.
489             Exists to avoid test for a NULL function pointer and because it could
490             potentially warn under some level of strict-ness.
491              
492             "Superseded" by sv_nosharing().
493              
494             void sv_nolocking(SV *sv)','name' => 'sv_nolocking'},'parse_listexpr' => {'text' => 'NOTE: this function is experimental and may change or be
495             removed without notice.
496              
497              
498             Parse a Perl list expression. This may contain operators of precedence
499             down to the comma operator. The expression must be followed (and thus
500             terminated) either by a low-precedence logic operator such as C or by
501             something that would normally terminate an expression such as semicolon.
502             If I includes C then the expression is optional,
503             otherwise it is mandatory. It is up to the caller to ensure that the
504             dynamic parser state (L et al) is correctly set to reflect
505             the source of the code to be parsed and the lexical context for the
506             expression.
507              
508             The op tree representing the expression is returned. If an optional
509             expression is absent, a null pointer is returned, otherwise the pointer
510             will be non-null.
511              
512             If an error occurs in parsing or compilation, in most cases a valid op
513             tree is returned anyway. The error is reflected in the parser state,
514             normally resulting in a single exception at the top level of parsing
515             which covers all the compilation errors that occurred. Some compilation
516             errors, however, will throw an exception immediately.
517              
518             OP * parse_listexpr(U32 flags)','name' => 'parse_listexpr'},'ibcmp' => {'text' => 'This is a synonym for (! foldEQ())
519              
520             I32 ibcmp(const char* a, const char* b, I32 len)','name' => 'ibcmp'},'isWORDCHAR' => {'text' => 'Returns a boolean indicating whether the specified character is a character
521             that is a word character, analogous to what C and C match
522             in a regular expression. A word character is an alphabetic character, a
523             decimal digit, a connecting punctuation character (such as an underscore), or
524             a "mark" character that attaches to one of those (like some sort of accent).
525             C is a synonym provided for backward compatibility, even though a
526             word character includes more than the standard C language meaning of
527             alphanumeric.
528             See the L for an explanation of variants
529             C, C, C, C,
530             C, C, and C.
531              
532             bool isWORDCHAR(char ch)','name' => 'isWORDCHAR'},'strLT' => {'text' => 'Test two strings to see if the first, C, is less than the second,
533             C. Returns true or false.
534              
535             bool strLT(char* s1, char* s2)','name' => 'strLT'},'save_pushptr' => {'text' => '','name' => 'save_pushptr'},'save_clearsv' => {'text' => '','name' => 'save_clearsv'},'av_shift' => {'text' => 'Removes one SV from the start of the array, reducing its size by one and
536             returning the SV (transferring control of one reference count) to the
537             caller. Returns C<&PL_sv_undef> if the array is empty.
538              
539             Perl equivalent: C
540              
541             SV* av_shift(AV *av)','name' => 'av_shift'},'sv_setpvf_nocontext' => {'text' => '','name' => 'sv_setpvf_nocontext'},'HvENAMEUTF8' => {'text' => 'Returns true if the effective name is in UTF8 encoding.
542              
543             unsigned char HvENAMEUTF8(HV *stash)','name' => 'HvENAMEUTF8'},'sv_nounlocking' => {'text' => 'Dummy routine which "unlocks" an SV when there is no locking module present.
544             Exists to avoid test for a NULL function pointer and because it could
545             potentially warn under some level of strict-ness.
546              
547             "Superseded" by sv_nosharing().
548              
549             void sv_nounlocking(SV *sv)','name' => 'sv_nounlocking'},'perl_clone_using' => {'text' => '','name' => 'perl_clone_using'},'PerlIO_context_layers' => {'text' => '','name' => 'PerlIO_context_layers'},'lex_unstuff' => {'text' => 'NOTE: this function is experimental and may change or be
550             removed without notice.
551              
552              
553             Discards text about to be lexed, from Lbufptr> up to
554             I. Text following I will be moved, and the buffer shortened.
555             This hides the discarded text from any lexing code that runs later,
556             as if the text had never appeared.
557              
558             This is not the normal way to consume lexed text. For that, use
559             L.
560              
561             void lex_unstuff(char *ptr)','name' => 'lex_unstuff'},'newSVpvf_nocontext' => {'text' => '','name' => 'newSVpvf_nocontext'},'SvUV_set' => {'text' => 'Set the value of the UV pointer in sv to val. See C.
562              
563             void SvUV_set(SV* sv, UV val)','name' => 'SvUV_set'},'rvpv_dup' => {'text' => '','name' => 'rvpv_dup'},'filter_read' => {'text' => '','name' => 'filter_read'},'ckwarn' => {'text' => '','name' => 'ckwarn'},'warner' => {'text' => '','name' => 'warner'},'savesharedsvpv' => {'text' => 'A version of C which allocates the duplicate string in
564             memory which is shared between threads.
565              
566             char* savesharedsvpv(SV *sv)','name' => 'savesharedsvpv'},'CopyD' => {'text' => 'Like C but returns dest. Useful
567             for encouraging compilers to tail-call
568             optimise.
569              
570             void * CopyD(void* src, void* dest, int nitems, type)','name' => 'CopyD'},'sv_setiv_mg' => {'text' => 'Like C, but also handles \'set\' magic.
571              
572             void sv_setiv_mg(SV *const sv, const IV i)','name' => 'sv_setiv_mg'},'sv_does_pvn' => {'text' => 'Like L, but takes a string/length pair instead of an SV.
573              
574             bool sv_does_pvn(SV* sv, const char *const name,
575             const STRLEN len, U32 flags)','name' => 'sv_does_pvn'},'newFOROP' => {'text' => 'Constructs, checks, and returns an op tree expressing a C
576             loop (iteration through a list of values). This is a heavyweight loop,
577             with structure that allows exiting the loop by C and suchlike.
578              
579             I optionally supplies the variable that will be aliased to each
580             item in turn; if null, it defaults to C<$_> (either lexical or global).
581             I supplies the list of values to iterate over. I supplies
582             the main body of the loop, and I optionally supplies a C
583             block that operates as a second half of the body. All of these optree
584             inputs are consumed by this function and become part of the constructed
585             op tree.
586              
587             I gives the eight bits of C for the C
588             op and, shifted up eight bits, the eight bits of C for
589             the C op, except that (in both cases) some bits will be set
590             automatically.
591              
592             OP * newFOROP(I32 flags, OP *sv, OP *expr, OP *block,
593             OP *cont)','name' => 'newFOROP'},'HvENAME' => {'text' => 'Returns the effective name of a stash, or NULL if there is none. The
594             effective name represents a location in the symbol table where this stash
595             resides. It is updated automatically when packages are aliased or deleted.
596             A stash that is no longer in the symbol table has no effective name. This
597             name is preferable to C for use in MRO linearisations and isa
598             caches.
599              
600             char* HvENAME(HV* stash)','name' => 'HvENAME'},'save_generic_svref' => {'text' => '','name' => 'save_generic_svref'},'savesharedpvn' => {'text' => 'A version of C which allocates the duplicate string in memory
601             which is shared between threads. (With the specific difference that a NULL
602             pointer is not acceptable)
603              
604             char* savesharedpvn(const char *const pv,
605             const STRLEN len)','name' => 'savesharedpvn'},'utf8_to_uvchr_buf' => {'text' => 'Returns the native code point of the first character in the string C which
606             is assumed to be in UTF-8 encoding; C points to 1 beyond the end of C.
607             C<*retlen> will be set to the length, in bytes, of that character.
608              
609             If C does not point to a well-formed UTF-8 character and UTF8 warnings are
610             enabled, zero is returned and C<*retlen> is set (if C isn\'t
611             NULL) to -1. If those warnings are off, the computed value, if well-defined
612             (or the Unicode REPLACEMENT CHARACTER if not), is silently returned, and
613             C<*retlen> is set (if C isn\'t NULL) so that (S + C<*retlen>>) is
614             the next possible position in C that could begin a non-malformed character.
615             See L for details on when the REPLACEMENT CHARACTER is
616             returned.
617              
618             UV utf8_to_uvchr_buf(const U8 *s, const U8 *send,
619             STRLEN *retlen)','name' => 'utf8_to_uvchr_buf'},'SvCUR_set' => {'text' => 'Set the current length of the string which is in the SV. See C
620             and C.
621              
622             void SvCUR_set(SV* sv, STRLEN len)','name' => 'SvCUR_set'},'SVt_NULL' => {'text' => 'Type flag for scalars. See L.','name' => 'SVt_NULL'},'sv_2pv' => {'text' => '','name' => 'sv_2pv'},'SvNOK' => {'text' => 'Returns a U32 value indicating whether the SV contains a double.
623              
624             U32 SvNOK(SV* sv)','name' => 'SvNOK'},'mPUSHn' => {'text' => 'Push a double onto the stack. The stack must have room for this element.
625             Does not use C. See also C, C and C.
626              
627             void mPUSHn(NV nv)','name' => 'mPUSHn'},'pad_setsv' => {'text' => 'Set the value at offset I in the current (compiling or executing) pad.
628             Use the macro PAD_SETSV() rather than calling this function directly.
629              
630             void pad_setsv(PADOFFSET po, SV *sv)','name' => 'pad_setsv'},'sv_reset' => {'text' => 'Underlying implementation for the C Perl function.
631             Note that the perl-level function is vaguely deprecated.
632              
633             void sv_reset(const char* s, HV *const stash)','name' => 'sv_reset'},'cophh_delete_pv' => {'text' => 'NOTE: this function is experimental and may change or be
634             removed without notice.
635              
636              
637             Like L, but takes a nul-terminated string instead of
638             a string/length pair.
639              
640             COPHH * cophh_delete_pv(const COPHH *cophh,
641             const char *key, U32 hash,
642             U32 flags)','name' => 'cophh_delete_pv'},'sv_2pv_flags' => {'text' => 'Returns a pointer to the string value of an SV, and sets *lp to its length.
643             If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a
644             string if necessary. Normally invoked via the C macro.
645             C and C usually end up here too.
646              
647             char* sv_2pv_flags(SV *const sv, STRLEN *const lp,
648             const I32 flags)','name' => 'sv_2pv_flags'},'push_scope' => {'text' => '','name' => 'push_scope'},'SvNVx' => {'text' => 'Coerces the given SV to a double and returns it.
649             Guarantees to evaluate C only once. Only use
650             this if C is an expression with side effects,
651             otherwise use the more efficient C.
652              
653             NV SvNVx(SV* sv)','name' => 'SvNVx'},'setdefout' => {'text' => 'Sets PL_defoutgv, the default file handle for output, to the passed in
654             typeglob. As PL_defoutgv "owns" a reference on its typeglob, the reference
655             count of the passed in typeglob is increased by one, and the reference count
656             of the typeglob that PL_defoutgv points to is decreased by one.
657              
658             void setdefout(GV* gv)','name' => 'setdefout'},'form_nocontext' => {'text' => '','name' => 'form_nocontext'},'hv_store' => {'text' => 'Stores an SV in a hash. The hash key is specified as C and the
659             absolute value of C is the length of the key. If C is
660             negative the key is assumed to be in UTF-8-encoded Unicode. The
661             C parameter is the precomputed hash value; if it is zero then
662             Perl will compute it.
663              
664             The return value will be
665             NULL if the operation failed or if the value did not need to be actually
666             stored within the hash (as in the case of tied hashes). Otherwise it can
667             be dereferenced to get the original C. Note that the caller is
668             responsible for suitably incrementing the reference count of C before
669             the call, and decrementing it if the function returned NULL. Effectively
670             a successful hv_store takes ownership of one reference to C. This is
671             usually what you want; a newly created SV has a reference count of one, so
672             if all your code does is create SVs then store them in a hash, hv_store
673             will own the only reference to the new SV, and your code doesn\'t need to do
674             anything further to tidy up. hv_store is not implemented as a call to
675             hv_store_ent, and does not create a temporary SV for the key, so if your
676             key data is not already in SV form then use hv_store in preference to
677             hv_store_ent.
678              
679             See L for more
680             information on how to use this function on tied hashes.
681              
682             SV** hv_store(HV *hv, const char *key, I32 klen,
683             SV *val, U32 hash)','name' => 'hv_store'},'sys_intern_dup' => {'text' => '','name' => 'sys_intern_dup'},'do_binmode' => {'text' => '','name' => 'do_binmode'},'get_op_names' => {'text' => '','name' => 'get_op_names'},'cop_hints_fetch_sv' => {'text' => 'Like L, but takes a Perl scalar instead of a
684             string/length pair.
685              
686             SV * cop_hints_fetch_sv(const COP *cop, SV *key,
687             U32 hash, U32 flags)','name' => 'cop_hints_fetch_sv'},'ck_entersub_args_proto_or_list' => {'text' => 'Performs the fixup of the arguments part of an C op tree either
688             based on a subroutine prototype or using default list-context processing.
689             This is the standard treatment used on a subroutine call, not marked
690             with C<&>, where the callee can be identified at compile time.
691              
692             I supplies the subroutine prototype to be applied to the call,
693             or indicates that there is no prototype. It may be a normal scalar,
694             in which case if it is defined then the string value will be used
695             as a prototype, and if it is undefined then there is no prototype.
696             Alternatively, for convenience, it may be a subroutine object (a C
697             that has been cast to C), of which the prototype will be used if it
698             has one. The prototype (or lack thereof) supplied, in whichever form,
699             does not need to match the actual callee referenced by the op tree.
700              
701             If the argument ops disagree with the prototype, for example by having
702             an unacceptable number of arguments, a valid op tree is returned anyway.
703             The error is reflected in the parser state, normally resulting in a single
704             exception at the top level of parsing which covers all the compilation
705             errors that occurred. In the error message, the callee is referred to
706             by the name defined by the I parameter.
707              
708             OP * ck_entersub_args_proto_or_list(OP *entersubop,
709             GV *namegv,
710             SV *protosv)','name' => 'ck_entersub_args_proto_or_list'},'hv_fetch_ent' => {'text' => 'Returns the hash entry which corresponds to the specified key in the hash.
711             C must be a valid precomputed hash number for the given C, or 0
712             if you want the function to compute it. IF C is set then the fetch
713             will be part of a store. Make sure the return value is non-null before
714             accessing it. The return value when C is a tied hash is a pointer to a
715             static location, so be sure to make a copy of the structure if you need to
716             store it somewhere.
717              
718             See L for more
719             information on how to use this function on tied hashes.
720              
721             HE* hv_fetch_ent(HV *hv, SV *keysv, I32 lval,
722             U32 hash)','name' => 'hv_fetch_ent'},'op_null' => {'text' => 'Neutralizes an op when it is no longer needed, but is still linked to from
723             other ops.
724              
725             void op_null(OP *o)','name' => 'op_null'},'gv_fetchpvn_flags' => {'text' => '','name' => 'gv_fetchpvn_flags'},'ENTER' => {'text' => 'Opening bracket on a callback. See C and L.
726              
727             ENTER;','name' => 'ENTER'},'PL_sv_no' => {'text' => 'This is the C SV. See C. Always refer to this as
728             C<&PL_sv_no>.
729              
730             SV PL_sv_no','name' => 'PL_sv_no'},'Newx' => {'text' => 'The XSUB-writer\'s interface to the C C function.
731              
732             Memory obtained by this should B be freed with L<"Safefree">.
733              
734             In 5.9.3, Newx() and friends replace the older New() API, and drops
735             the first parameter, I, a debug aid which allowed callers to identify
736             themselves. This aid has been superseded by a new build option,
737             PERL_MEM_LOG (see L). The older API is still
738             there for use in XS modules supporting older perls.
739              
740             void Newx(void* ptr, int nitems, type)','name' => 'Newx'},'newFORM' => {'text' => '','name' => 'newFORM'},'PUSHs' => {'text' => 'Push an SV onto the stack. The stack must have room for this element.
741             Does not handle \'set\' magic. Does not use C. See also C,
742             C and C.
743              
744             void PUSHs(SV* sv)','name' => 'PUSHs'},'sv_setuv' => {'text' => 'Copies an unsigned integer into the given SV, upgrading first if necessary.
745             Does not handle \'set\' magic. See also C.
746              
747             void sv_setuv(SV *const sv, const UV num)','name' => 'sv_setuv'},'SvUPGRADE' => {'text' => 'Used to upgrade an SV to a more complex form. Uses C to
748             perform the upgrade if necessary. See C.
749              
750             void SvUPGRADE(SV* sv, svtype type)','name' => 'SvUPGRADE'},'cv_clone' => {'text' => 'Clone a CV, making a lexical closure. I supplies the prototype
751             of the function: its code, pad structure, and other attributes.
752             The prototype is combined with a capture of outer lexicals to which the
753             code refers, which are taken from the currently-executing instance of
754             the immediately surrounding code.
755              
756             CV * cv_clone(CV *proto)','name' => 'cv_clone'},'do_aspawn' => {'text' => '','name' => 'do_aspawn'},'sv_pvn' => {'text' => 'A private implementation of the C macro for compilers which can\'t
757             cope with complex macro expressions. Always use the macro instead.
758              
759             char* sv_pvn(SV *sv, STRLEN *lp)','name' => 'sv_pvn'},'do_openn' => {'text' => '','name' => 'do_openn'},'wrap_op_checker' => {'text' => 'Puts a C function into the chain of check functions for a specified op
760             type. This is the preferred way to manipulate the L array.
761             I specifies which type of op is to be affected. I
762             is a pointer to the C function that is to be added to that opcode\'s
763             check chain, and I points to the storage location where a
764             pointer to the next function in the chain will be stored. The value of
765             I is written into the L array, while the value
766             previously stored there is written to I<*old_checker_p>.
767              
768             The function should be defined like this:
769              
770             static OP *new_checker(pTHX_ OP *op) { ... }
771              
772             It is intended to be called in this manner:
773              
774             new_checker(aTHX_ op)
775              
776             I should be defined like this:
777              
778             static Perl_check_t old_checker_p;
779              
780             L is global to an entire process, and a module wishing to
781             hook op checking may find itself invoked more than once per process,
782             typically in different threads. To handle that situation, this function
783             is idempotent. The location I<*old_checker_p> must initially (once
784             per process) contain a null pointer. A C variable of static duration
785             (declared at file scope, typically also marked C to give
786             it internal linkage) will be implicitly initialised appropriately,
787             if it does not have an explicit initialiser. This function will only
788             actually modify the check chain if it finds I<*old_checker_p> to be null.
789             This function is also thread safe on the small scale. It uses appropriate
790             locking to avoid race conditions in accessing L.
791              
792             When this function is called, the function referenced by I
793             must be ready to be called, except for I<*old_checker_p> being unfilled.
794             In a threading situation, I may be called immediately,
795             even before this function has returned. I<*old_checker_p> will always
796             be appropriately set before I is called. If I
797             decides not to do anything special with an op that it is given (which
798             is the usual case for most uses of op check hooking), it must chain the
799             check function referenced by I<*old_checker_p>.
800              
801             If you want to influence compilation of calls to a specific subroutine,
802             then use L rather than hooking checking of all
803             C ops.
804              
805             void wrap_op_checker(Optype opcode,
806             Perl_check_t new_checker,
807             Perl_check_t *old_checker_p)','name' => 'wrap_op_checker'},'mro_get_from_name' => {'text' => '','name' => 'mro_get_from_name'},'sv_setref_iv' => {'text' => 'Copies an integer into a new SV, optionally blessing the SV. The C
808             argument will be upgraded to an RV. That RV will be modified to point to
809             the new SV. The C argument indicates the package for the
810             blessing. Set C to C to avoid the blessing. The new SV
811             will have a reference count of 1, and the RV will be returned.
812              
813             SV* sv_setref_iv(SV *const rv,
814             const char *const classname,
815             const IV iv)','name' => 'sv_setref_iv'},'sv_chop' => {'text' => 'Efficient removal of characters from the beginning of the string buffer.
816             SvPOK(sv), or at least SvPOKp(sv), must be true and the C must be a
817             pointer to somewhere inside the string buffer. The C becomes the first
818             character of the adjusted string. Uses the "OOK hack". On return, only
819             SvPOK(sv) and SvPOKp(sv) among the OK flags will be true.
820              
821             Beware: after this function returns, C and SvPVX_const(sv) may no longer
822             refer to the same chunk of data.
823              
824             The unfortunate similarity of this function\'s name to that of Perl\'s C
825             operator is strictly coincidental. This function works from the left;
826             C works from the right.
827              
828             void sv_chop(SV *const sv, const char *const ptr)','name' => 'sv_chop'},'sv_backoff' => {'text' => 'Remove any string offset. You should normally use the C macro
829             wrapper instead.
830              
831             int sv_backoff(SV *const sv)','name' => 'sv_backoff'},'reentrant_retry' => {'text' => '','name' => 'reentrant_retry'},'XPUSHu' => {'text' => 'Push an unsigned integer onto the stack, extending the stack if necessary.
832             Handles \'set\' magic. Uses C, so C or C should be
833             called to declare it. Do not call multiple C-oriented macros to
834             return lists from XSUB\'s - see C instead. See also C and
835             C.
836              
837             void XPUSHu(UV uv)','name' => 'XPUSHu'},'sv_pvn_nomg' => {'text' => '','name' => 'sv_pvn_nomg'},'GvHV' => {'text' => 'Return the HV from the GV.
838              
839             HV* GvHV(GV* gv)','name' => 'GvHV'},'stack_grow' => {'text' => '','name' => 'stack_grow'},'dump_mstats' => {'text' => '','name' => 'dump_mstats'},'newLOOPEX' => {'text' => 'Constructs, checks, and returns a loop-exiting op (such as C
840             or C). I is the opcode. I
841             determining the target of the op; it is consumed by this function and
842             becomes part of the constructed op tree.
843              
844             OP * newLOOPEX(I32 type, OP *label)','name' => 'newLOOPEX'},'save_shared_pvref' => {'text' => '','name' => 'save_shared_pvref'},'PL_na' => {'text' => 'A convenience variable which is typically used with C when one
845             doesn\'t care about the length of the string. It is usually more efficient
846             to either declare a local variable and use that instead or to use the
847             C macro.
848              
849             STRLEN PL_na','name' => 'PL_na'},'newSViv' => {'text' => 'Creates a new SV and copies an integer into it. The reference count for the
850             SV is set to 1.
851              
852             SV* newSViv(const IV i)','name' => 'newSViv'},'gv_name_set' => {'text' => '','name' => 'gv_name_set'},'sv_untaint' => {'text' => 'Untaint an SV. Use C instead.
853              
854             void sv_untaint(SV *const sv)','name' => 'sv_untaint'},'Newxz' => {'text' => 'The XSUB-writer\'s interface to the C C function. The allocated
855             memory is zeroed with C. See also C.
856              
857             Memory obtained by this should B be freed with L<"Safefree">.
858              
859             void Newxz(void* ptr, int nitems, type)','name' => 'Newxz'},'SVt_PVHV' => {'text' => 'Type flag for hashes. See L.','name' => 'SVt_PVHV'},'reentrant_init' => {'text' => '','name' => 'reentrant_init'},'save_pushptrptr' => {'text' => '','name' => 'save_pushptrptr'},'save_gp' => {'text' => '','name' => 'save_gp'},'parse_block' => {'text' => 'NOTE: this function is experimental and may change or be
860             removed without notice.
861              
862              
863             Parse a single complete Perl code block. This consists of an opening
864             brace, a sequence of statements, and a closing brace. The block
865             constitutes a lexical scope, so C variables and various compile-time
866             effects can be contained within it. It is up to the caller to ensure
867             that the dynamic parser state (L et al) is correctly set to
868             reflect the source of the code to be parsed and the lexical context for
869             the statement.
870              
871             The op tree representing the code block is returned. This is always a
872             real op, never a null pointer. It will normally be a C list,
873             including C or equivalent ops. No ops to construct any kind
874             of runtime scope are included by virtue of it being a block.
875              
876             If an error occurs in parsing or compilation, in most cases a valid op
877             tree (most likely null) is returned anyway. The error is reflected in
878             the parser state, normally resulting in a single exception at the top
879             level of parsing which covers all the compilation errors that occurred.
880             Some compilation errors, however, will throw an exception immediately.
881              
882             The I parameter is reserved for future use, and must always
883             be zero.
884              
885             OP * parse_block(U32 flags)','name' => 'parse_block'},'toLOWER_uni' => {'text' => 'Converts the Unicode code point C to its lowercase version, and
886             stores that in UTF-8 in C, and its length in bytes in C. Note
887             that the buffer pointed to by C needs to be at least C
888             bytes since the lowercase version may be longer than the original character.
889              
890             The first code point of the lowercased version is returned
891             (but note, as explained just above, that there may be more.)
892              
893             UV toLOWER_uni(UV cp, U8* s, STRLEN* lenp)','name' => 'toLOWER_uni'},'SvRX' => {'text' => 'Convenience macro to get the REGEXP from a SV. This is approximately
894             equivalent to the following snippet:
895              
896             if (SvMAGICAL(sv))
897             mg_get(sv);
898             if (SvROK(sv))
899             sv = MUTABLE_SV(SvRV(sv));
900             if (SvTYPE(sv) == SVt_REGEXP)
901             return (REGEXP*) sv;
902              
903             NULL will be returned if a REGEXP* is not found.
904              
905             REGEXP * SvRX(SV *sv)','name' => 'SvRX'},'newASSIGNOP' => {'text' => 'Constructs, checks, and returns an assignment op. I and I
906             supply the parameters of the assignment; they are consumed by this
907             function and become part of the constructed op tree.
908              
909             If I is C, C, or C, then
910             a suitable conditional optree is constructed. If I is the opcode
911             of a binary operator, such as C, then an op is constructed that
912             performs the binary operation and assigns the result to the left argument.
913             Either way, if I is non-zero then I has no effect.
914              
915             If I is zero, then a plain scalar or list assignment is
916             constructed. Which type of assignment it is is automatically determined.
917             I gives the eight bits of C, except that C
918             will be set automatically, and, shifted up eight bits, the eight bits
919             of C, except that the bit with value 1 or 2 is automatically
920             set as required.
921              
922             OP * newASSIGNOP(I32 flags, OP *left, I32 optype,
923             OP *right)','name' => 'newASSIGNOP'},'toFOLD' => {'text' => 'Converts the specified character to foldcase. If the input is anything but an
924             ASCII uppercase character, that input character itself is returned. Variant
925             C is equivalent. (There is no equivalent C for the full
926             Latin1 range, as the full generality of L is needed there.)
927              
928             U8 toFOLD(U8 ch)','name' => 'toFOLD'},'SvSetMagicSV_nosteal' => {'text' => 'Like C, but does any set magic required afterwards.
929              
930             void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)','name' => 'SvSetMagicSV_nosteal'},'hv_undef' => {'text' => 'Undefines the hash. The XS equivalent of C.
931              
932             As well as freeing all the elements of the hash (like hv_clear()), this
933             also frees any auxiliary data and storage associated with the hash.
934              
935             If any destructors are triggered as a result, the hv itself may
936             be freed.
937              
938             See also L.
939              
940             void hv_undef(HV *hv)','name' => 'hv_undef'},'clone_params_del' => {'text' => '','name' => 'clone_params_del'},'sv_isobject' => {'text' => 'Returns a boolean indicating whether the SV is an RV pointing to a blessed
941             object. If the SV is not an RV, or if the object is not blessed, then this
942             will return false.
943              
944             int sv_isobject(SV* sv)','name' => 'sv_isobject'},'cop_hints_fetch_pvn' => {'text' => 'Look up the hint entry in the cop I with the key specified by
945             I and I. If I has the C bit set,
946             the key octets are interpreted as UTF-8, otherwise they are interpreted
947             as Latin-1. I is a precomputed hash of the key string, or zero if
948             it has not been precomputed. Returns a mortal scalar copy of the value
949             associated with the key, or C<&PL_sv_placeholder> if there is no value
950             associated with the key.
951              
952             SV * cop_hints_fetch_pvn(const COP *cop,
953             const char *keypv,
954             STRLEN keylen, U32 hash,
955             U32 flags)','name' => 'cop_hints_fetch_pvn'},'gv_efullname4' => {'text' => '','name' => 'gv_efullname4'},'SvIV' => {'text' => 'Coerces the given SV to an integer and returns it. See C for a
956             version which guarantees to evaluate sv only once.
957              
958             IV SvIV(SV* sv)','name' => 'SvIV'},'isASCII' => {'text' => 'Returns a boolean indicating whether the specified character is one of the 128
959             characters in the ASCII character set, analogous to C.
960             On non-ASCII platforms, it returns TRUE iff this
961             character corresponds to an ASCII character. Variants C and
962             C are identical to C.
963             See the L for an explanation of variants
964             C, C, C, C, and
965             C. Note, however, that some platforms do not have the C
966             library routine C. In these cases, the variants whose names contain
967             C are the same as the corresponding ones without.
968              
969             Also note, that because all ASCII characters are UTF-8 invariant (meaning they
970             have the exact same representation (always a single byte) whether encoded in
971             UTF-8 or not), C will give the correct results when called with any
972             byte in any string encoded or not in UTF-8. And similarly C will
973             work properly on any string encoded or not in UTF-8.
974              
975             bool isASCII(char ch)','name' => 'isASCII'},'PerlIO_eof' => {'text' => '','name' => 'PerlIO_eof'},'cop_hints_2hv' => {'text' => 'Generates and returns a standard Perl hash representing the full set of
976             hint entries in the cop I. I is currently unused and must
977             be zero.
978              
979             HV * cop_hints_2hv(const COP *cop, U32 flags)','name' => 'cop_hints_2hv'},'sv_collxfrm_flags' => {'text' => 'Add Collate Transform magic to an SV if it doesn\'t already have it. If the
980             flags contain SV_GMAGIC, it handles get-magic.
981              
982             Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
983             scalar data of the variable, but transformed to such a format that a normal
984             memory comparison can be used to compare the data according to the locale
985             settings.
986              
987             char* sv_collxfrm_flags(SV *const sv,
988             STRLEN *const nxp,
989             I32 const flags)','name' => 'sv_collxfrm_flags'},'sv_copypv_flags' => {'text' => 'Implementation of sv_copypv and sv_copypv_nomg. Calls get magic iff flags
990             include SV_GMAGIC.
991              
992             void sv_copypv_flags(SV *const dsv, SV *const ssv,
993             const I32 flags)','name' => 'sv_copypv_flags'},'sv_setref_uv' => {'text' => 'Copies an unsigned integer into a new SV, optionally blessing the SV. The C
994             argument will be upgraded to an RV. That RV will be modified to point to
995             the new SV. The C argument indicates the package for the
996             blessing. Set C to C to avoid the blessing. The new SV
997             will have a reference count of 1, and the RV will be returned.
998              
999             SV* sv_setref_uv(SV *const rv,
1000             const char *const classname,
1001             const UV uv)','name' => 'sv_setref_uv'},'get_ppaddr' => {'text' => '','name' => 'get_ppaddr'},'ck_entersub_args_proto' => {'text' => 'Performs the fixup of the arguments part of an C op tree
1002             based on a subroutine prototype. This makes various modifications to
1003             the argument ops, from applying context up to inserting C ops,
1004             and checking the number and syntactic types of arguments, as directed by
1005             the prototype. This is the standard treatment used on a subroutine call,
1006             not marked with C<&>, where the callee can be identified at compile time
1007             and has a prototype.
1008              
1009             I supplies the subroutine prototype to be applied to the call.
1010             It may be a normal defined scalar, of which the string value will be used.
1011             Alternatively, for convenience, it may be a subroutine object (a C
1012             that has been cast to C) which has a prototype. The prototype
1013             supplied, in whichever form, does not need to match the actual callee
1014             referenced by the op tree.
1015              
1016             If the argument ops disagree with the prototype, for example by having
1017             an unacceptable number of arguments, a valid op tree is returned anyway.
1018             The error is reflected in the parser state, normally resulting in a single
1019             exception at the top level of parsing which covers all the compilation
1020             errors that occurred. In the error message, the callee is referred to
1021             by the name defined by the I parameter.
1022              
1023             OP * ck_entersub_args_proto(OP *entersubop,
1024             GV *namegv, SV *protosv)','name' => 'ck_entersub_args_proto'},'getcwd_sv' => {'text' => 'Fill the sv with current working directory
1025              
1026             int getcwd_sv(SV* sv)','name' => 'getcwd_sv'},'newSVpvs_share' => {'text' => 'Like C, but takes a literal C-terminated string instead of
1027             a string/length pair and omits the hash parameter.
1028              
1029             SV* newSVpvs_share(const char* s)','name' => 'newSVpvs_share'},'newSVpv' => {'text' => 'Creates a new SV and copies a string (which may contain C (C<\\0>)
1030             characters) into it. The reference count for the
1031             SV is set to 1. If C is zero, Perl will compute the length using
1032             strlen(), (which means if you use this option, that C can\'t have embedded
1033             C characters and has to have a terminating C byte).
1034              
1035             For efficiency, consider using C instead.
1036              
1037             SV* newSVpv(const char *const s, const STRLEN len)','name' => 'newSVpv'},'sv_2pvbyte' => {'text' => 'Return a pointer to the byte-encoded representation of the SV, and set *lp
1038             to its length. May cause the SV to be downgraded from UTF-8 as a
1039             side-effect.
1040              
1041             Usually accessed via the C macro.
1042              
1043             char* sv_2pvbyte(SV *sv, STRLEN *const lp)','name' => 'sv_2pvbyte'},'fbm_instr' => {'text' => 'Returns the location of the SV in the string delimited by C and
1044             C. It returns C if the string can\'t be found. The C
1045             does not have to be fbm_compiled, but the search will not be as fast
1046             then.
1047              
1048             char* fbm_instr(unsigned char* big,
1049             unsigned char* bigend, SV* littlestr,
1050             U32 flags)','name' => 'fbm_instr'},'toFOLD_uni' => {'text' => 'Converts the Unicode code point C to its foldcase version, and
1051             stores that in UTF-8 in C, and its length in bytes in C. Note
1052             that the buffer pointed to by C needs to be at least C
1053             bytes since the foldcase version may be longer than the original character.
1054              
1055             The first code point of the foldcased version is returned
1056             (but note, as explained just above, that there may be more.)
1057              
1058             UV toFOLD_uni(UV cp, U8* s, STRLEN* lenp)','name' => 'toFOLD_uni'},'XPUSHn' => {'text' => 'Push a double onto the stack, extending the stack if necessary. Handles
1059             \'set\' magic. Uses C, so C or C should be called to
1060             declare it. Do not call multiple C-oriented macros to return lists
1061             from XSUB\'s - see C instead. See also C and C.
1062              
1063             void XPUSHn(NV nv)','name' => 'XPUSHn'},'PL_opfreehook' => {'text' => 'When non-C, the function pointed by this variable will be called each time an OP is freed with the corresponding OP as the argument.
1064             This allows extensions to free any extra attribute they have locally attached to an OP.
1065             It is also assured to first fire for the parent OP and then for its kids.
1066              
1067             When you replace this variable, it is considered a good practice to store the possibly previously installed hook and that you recall it inside your own.
1068              
1069             Perl_ophook_t PL_opfreehook','name' => 'PL_opfreehook'},'PadlistARRAY' => {'text' => 'NOTE: this function is experimental and may change or be
1070             removed without notice.
1071              
1072              
1073             The C array of a padlist, containing the pads. Only subscript it with
1074             numbers >= 1, as the 0th entry is not guaranteed to remain usable.
1075              
1076             PAD ** PadlistARRAY(PADLIST padlist)','name' => 'PadlistARRAY'},'dump_all' => {'text' => 'Dumps the entire optree of the current program starting at C to
1077             C. Also dumps the optrees for all visible subroutines in
1078             C.
1079              
1080             void dump_all()','name' => 'dump_all'},'ninstr' => {'text' => '','name' => 'ninstr'},'sv_vcatpvf' => {'text' => 'Processes its arguments like C and appends the formatted output
1081             to an SV. Does not handle \'set\' magic. See C.
1082              
1083             Usually used via its frontend C.
1084              
1085             void sv_vcatpvf(SV *const sv, const char *const pat,
1086             va_list *const args)','name' => 'sv_vcatpvf'},'sv_pos_u2b' => {'text' => 'Converts the value pointed to by offsetp from a count of UTF-8 chars from
1087             the start of the string, to a count of the equivalent number of bytes; if
1088             lenp is non-zero, it does the same to lenp, but this time starting from
1089             the offset, rather than from the start of the string. Handles magic and
1090             type coercion.
1091              
1092             Use C in preference, which correctly handles strings longer
1093             than 2Gb.
1094              
1095             void sv_pos_u2b(SV *const sv, I32 *const offsetp,
1096             I32 *const lenp)','name' => 'sv_pos_u2b'},'boolSV' => {'text' => 'Returns a true SV if C is a true value, or a false SV if C is 0.
1097              
1098             See also C and C.
1099              
1100             SV * boolSV(bool b)','name' => 'boolSV'},'PERL_SYS_INIT3' => {'text' => 'Provides system-specific tune up of the C runtime environment necessary to
1101             run Perl interpreters. This should be called only once, before creating
1102             any Perl interpreters.
1103              
1104             void PERL_SYS_INIT3(int *argc, char*** argv,
1105             char*** env)','name' => 'PERL_SYS_INIT3'},'upg_version' => {'text' => 'In-place upgrade of the supplied SV to a version object.
1106              
1107             SV *sv = upg_version(SV *sv, bool qv);
1108              
1109             Returns a pointer to the upgraded SV. Set the boolean qv if you want
1110             to force this SV to be interpreted as an "extended" version.
1111              
1112             SV* upg_version(SV *ver, bool qv)','name' => 'upg_version'},'HeSVKEY_set' => {'text' => 'Sets the key to a given C, taking care to set the appropriate flags to
1113             indicate the presence of an C key, and returns the same
1114             C.
1115              
1116             SV* HeSVKEY_set(HE* he, SV* sv)','name' => 'HeSVKEY_set'},'sv_derived_from_sv' => {'text' => 'Exactly like L, but takes the name string in the form
1117             of an SV instead of a string/length pair.
1118              
1119             bool sv_derived_from_sv(SV* sv, SV *namesv,
1120             U32 flags)','name' => 'sv_derived_from_sv'},'SPAGAIN' => {'text' => 'Refetch the stack pointer. Used after a callback. See L.
1121              
1122             SPAGAIN;','name' => 'SPAGAIN'},'newCVREF' => {'text' => '','name' => 'newCVREF'},'gv_init_sv' => {'text' => 'Same as gv_init_pvn(), but takes an SV * for the name instead of separate
1123             char * and length parameters. C is currently unused.
1124              
1125             void gv_init_sv(GV* gv, HV* stash, SV* namesv,
1126             U32 flags)','name' => 'gv_init_sv'},'my_bcopy' => {'text' => '','name' => 'my_bcopy'},'PL_parser-Ebufptr' => {'text' => 'NOTE: this function is experimental and may change or be
1127             removed without notice.
1128              
1129              
1130             Points to the current position of lexing inside the lexer buffer.
1131             Characters around this point may be freely examined, within
1132             the range delimited by Clinestr>)> and
1133             Lbufend>. The octets of the buffer may be intended to be
1134             interpreted as either UTF-8 or Latin-1, as indicated by L.
1135              
1136             Lexing code (whether in the Perl core or not) moves this pointer past
1137             the characters that it consumes. It is also expected to perform some
1138             bookkeeping whenever a newline character is consumed. This movement
1139             can be more conveniently performed by the function L,
1140             which handles newlines appropriately.
1141              
1142             Interpretation of the buffer\'s octets can be abstracted out by
1143             using the slightly higher-level functions L and
1144             L.','name' => 'PL_parser-Ebufptr'},'G_NOARGS' => {'text' => 'Indicates that no arguments are being sent to a callback. See
1145             L.','name' => 'G_NOARGS'},'amagic_deref_call' => {'text' => '','name' => 'amagic_deref_call'},'lex_start' => {'text' => 'NOTE: this function is experimental and may change or be
1146             removed without notice.
1147              
1148              
1149             Creates and initialises a new lexer/parser state object, supplying
1150             a context in which to lex and parse from a new source of Perl code.
1151             A pointer to the new state object is placed in L. An entry
1152             is made on the save stack so that upon unwinding the new state object
1153             will be destroyed and the former value of L will be restored.
1154             Nothing else need be done to clean up the parsing context.
1155              
1156             The code to be parsed comes from I and I. I, if
1157             non-null, provides a string (in SV form) containing code to be parsed.
1158             A copy of the string is made, so subsequent modification of I
1159             does not affect parsing. I, if non-null, provides an input stream
1160             from which code will be read to be parsed. If both are non-null, the
1161             code in I comes first and must consist of complete lines of input,
1162             and I supplies the remainder of the source.
1163              
1164             The I parameter is reserved for future use. Currently it is only
1165             used by perl internally, so extensions should always pass zero.
1166              
1167             void lex_start(SV *line, PerlIO *rsfp, U32 flags)','name' => 'lex_start'},'hv_riter_set' => {'text' => '','name' => 'hv_riter_set'},'gv_autoload_pvn' => {'text' => '','name' => 'gv_autoload_pvn'},'gv_autoload_pv' => {'text' => '','name' => 'gv_autoload_pv'},'dounwind' => {'text' => '','name' => 'dounwind'},'uvchr_to_utf8_flags' => {'text' => 'Adds the UTF-8 representation of the native code point C to the end
1168             of the string C; C should have at least C (up to
1169             C) free bytes available. The return value is the pointer to
1170             the byte after the end of the new character. In other words,
1171              
1172             d = uvchr_to_utf8_flags(d, uv, flags);
1173              
1174             or, in most cases,
1175              
1176             d = uvchr_to_utf8_flags(d, uv, 0);
1177              
1178             This is the Unicode-aware way of saying
1179              
1180             *(d++) = uv;
1181              
1182             This function will convert to UTF-8 (and not warn) even code points that aren\'t
1183             legal Unicode or are problematic, unless C contains one or more of the
1184             following flags:
1185              
1186             If C is a Unicode surrogate code point and UNICODE_WARN_SURROGATE is set,
1187             the function will raise a warning, provided UTF8 warnings are enabled. If instead
1188             UNICODE_DISALLOW_SURROGATE is set, the function will fail and return NULL.
1189             If both flags are set, the function will both warn and return NULL.
1190              
1191             The UNICODE_WARN_NONCHAR and UNICODE_DISALLOW_NONCHAR flags
1192             affect how the function handles a Unicode non-character. And likewise, the
1193             UNICODE_WARN_SUPER and UNICODE_DISALLOW_SUPER flags affect the handling of
1194             code points that are
1195             above the Unicode maximum of 0x10FFFF. Code points above 0x7FFF_FFFF (which are
1196             even less portable) can be warned and/or disallowed even if other above-Unicode
1197             code points are accepted, by the UNICODE_WARN_FE_FF and UNICODE_DISALLOW_FE_FF
1198             flags.
1199              
1200             And finally, the flag UNICODE_WARN_ILLEGAL_INTERCHANGE selects all four of the
1201             above WARN flags; and UNICODE_DISALLOW_ILLEGAL_INTERCHANGE selects all four
1202             DISALLOW flags.
1203              
1204             U8* uvchr_to_utf8_flags(U8 *d, UV uv, UV flags)','name' => 'uvchr_to_utf8_flags'},'save_hash' => {'text' => '','name' => 'save_hash'},'sv_isa' => {'text' => 'Returns a boolean indicating whether the SV is blessed into the specified
1205             class. This does not check for subtypes; use C to verify
1206             an inheritance relationship.
1207              
1208             int sv_isa(SV* sv, const char *const name)','name' => 'sv_isa'},'cophh_free' => {'text' => 'NOTE: this function is experimental and may change or be
1209             removed without notice.
1210              
1211              
1212             Discard the cop hints hash I, freeing all resources associated
1213             with it.
1214              
1215             void cophh_free(COPHH *cophh)','name' => 'cophh_free'},'isXDIGIT' => {'text' => 'Returns a boolean indicating whether the specified character is a hexadecimal
1216             digit. In the ASCII range these are C<[0-9A-Fa-f]>. Variants C
1217             and C are identical to C.
1218             See the L for an explanation of variants
1219             C, C, C, C, and
1220             C.
1221              
1222             bool isXDIGIT(char ch)','name' => 'isXDIGIT'},'sv_catpvf' => {'text' => 'Processes its arguments like C and appends the formatted
1223             output to an SV. If the appended data contains "wide" characters
1224             (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
1225             and characters >255 formatted with %c), the original SV might get
1226             upgraded to UTF-8. Handles \'get\' magic, but not \'set\' magic. See
1227             C. If the original SV was UTF-8, the pattern should be
1228             valid UTF-8; if the original SV was bytes, the pattern should be too.
1229              
1230             void sv_catpvf(SV *const sv, const char *const pat,
1231             ...)','name' => 'sv_catpvf'},'cop_fetch_label' => {'text' => 'NOTE: this function is experimental and may change or be
1232             removed without notice.
1233              
1234              
1235             Returns the label attached to a cop.
1236             The flags pointer may be set to C or 0.
1237              
1238             const char * cop_fetch_label(COP *const cop,
1239             STRLEN *len, U32 *flags)','name' => 'cop_fetch_label'},'XSRETURN_PV' => {'text' => 'Return a copy of a string from an XSUB immediately. Uses C.
1240              
1241             void XSRETURN_PV(char* str)','name' => 'XSRETURN_PV'},'utf8_to_uvuni' => {'text' => 'DEPRECATED! It is planned to remove this function from a
1242             future release of Perl. Do not use it for new code; remove it from
1243             existing code.
1244              
1245              
1246             Returns the Unicode code point of the first character in the string C
1247             which is assumed to be in UTF-8 encoding; C will be set to the
1248             length, in bytes, of that character.
1249              
1250             Some, but not all, UTF-8 malformations are detected, and in fact, some
1251             malformed input could cause reading beyond the end of the input buffer, which
1252             is one reason why this function is deprecated. The other is that only in
1253             extremely limited circumstances should the Unicode versus native code point be
1254             of any interest to you. See L for alternatives.
1255              
1256             If C points to one of the detected malformations, and UTF8 warnings are
1257             enabled, zero is returned and C<*retlen> is set (if C doesn\'t point to
1258             NULL) to -1. If those warnings are off, the computed value if well-defined (or
1259             the Unicode REPLACEMENT CHARACTER, if not) is silently returned, and C<*retlen>
1260             is set (if C isn\'t NULL) so that (S + C<*retlen>>) is the
1261             next possible position in C that could begin a non-malformed character.
1262             See L for details on when the REPLACEMENT CHARACTER is returned.
1263              
1264             UV utf8_to_uvuni(const U8 *s, STRLEN *retlen)','name' => 'utf8_to_uvuni'},'pad_alloc' => {'text' => 'NOTE: this function is experimental and may change or be
1265             removed without notice.
1266              
1267              
1268             Allocates a place in the currently-compiling pad,
1269             returning the offset of the allocated pad slot.
1270             No name is initially attached to the pad slot.
1271             I is a set of flags indicating the kind of pad entry required,
1272             which will be set in the value SV for the allocated pad entry:
1273              
1274             SVs_PADMY named lexical variable ("my", "our", "state")
1275             SVs_PADTMP unnamed temporary store
1276             SVf_READONLY constant shared between recursion levels
1277              
1278             C has been supported here only since perl 5.20. To work with
1279             earlier versions as well, use C. C
1280             does not cause the SV in the pad slot to be marked read-only, but simply
1281             tells C that it I be made read-only (by the caller), or at
1282             least should be treated as such.
1283              
1284             I should be an opcode indicating the type of operation that the
1285             pad entry is to support. This doesn\'t affect operational semantics,
1286             but is used for debugging.
1287              
1288             PADOFFSET pad_alloc(I32 optype, U32 tmptype)','name' => 'pad_alloc'},'av_fill' => {'text' => 'Set the highest index in the array to the given number, equivalent to
1289             Perl\'s C<$#array = $fill;>.
1290              
1291             The number of elements in the array will be C after
1292             av_fill() returns. If the array was previously shorter, then the
1293             additional elements appended are set to NULL. If the array
1294             was longer, then the excess elements are freed. C is
1295             the same as C.
1296              
1297             void av_fill(AV *av, SSize_t fill)','name' => 'av_fill'},'croak_sv' => {'text' => 'This is an XS interface to Perl\'s C function.
1298              
1299             C is the error message or object. If it is a reference, it
1300             will be used as-is. Otherwise it is used as a string, and if it does
1301             not end with a newline then it will be extended with some indication of
1302             the current location in the code, as described for L.
1303              
1304             The error message or object will be used as an exception, by default
1305             returning control to the nearest enclosing C, but subject to
1306             modification by a C<$SIG{__DIE__}> handler. In any case, the C
1307             function never returns normally.
1308              
1309             To die with a simple string message, the L function may be
1310             more convenient.
1311              
1312             void croak_sv(SV *baseex)','name' => 'croak_sv'},'warn_nocontext' => {'text' => '','name' => 'warn_nocontext'},'SvIOK_only' => {'text' => 'Tells an SV that it is an integer and disables all other OK bits.
1313              
1314             void SvIOK_only(SV* sv)','name' => 'SvIOK_only'},'MoveD' => {'text' => 'Like C but returns dest. Useful
1315             for encouraging compilers to tail-call
1316             optimise.
1317              
1318             void * MoveD(void* src, void* dest, int nitems, type)','name' => 'MoveD'},'gv_IOadd' => {'text' => '','name' => 'gv_IOadd'},'grok_bin' => {'text' => 'converts a string representing a binary number to numeric form.
1319              
1320             On entry I and I<*len> give the string to scan, I<*flags> gives
1321             conversion flags, and I should be NULL or a pointer to an NV.
1322             The scan stops at the end of the string, or the first invalid character.
1323             Unless C is set in I<*flags>, encountering an
1324             invalid character will also trigger a warning.
1325             On return I<*len> is set to the length of the scanned string,
1326             and I<*flags> gives output flags.
1327              
1328             If the value is <= C it is returned as a UV, the output flags are clear,
1329             and nothing is written to I<*result>. If the value is > UV_MAX C
1330             returns UV_MAX, sets C in the output flags,
1331             and writes the value to I<*result> (or the value is discarded if I
1332             is NULL).
1333              
1334             The binary number may optionally be prefixed with "0b" or "b" unless
1335             C is set in I<*flags> on entry. If
1336             C is set in I<*flags> then the binary
1337             number may use \'_\' characters to separate digits.
1338              
1339             UV grok_bin(const char* start, STRLEN* len_p,
1340             I32* flags, NV *result)','name' => 'grok_bin'},'parse_barestmt' => {'text' => 'NOTE: this function is experimental and may change or be
1341             removed without notice.
1342              
1343              
1344             Parse a single unadorned Perl statement. This may be a normal imperative
1345             statement or a declaration that has compile-time effect. It does not
1346             include any label or other affixture. It is up to the caller to ensure
1347             that the dynamic parser state (L et al) is correctly set to
1348             reflect the source of the code to be parsed and the lexical context for
1349             the statement.
1350              
1351             The op tree representing the statement is returned. This may be a
1352             null pointer if the statement is null, for example if it was actually
1353             a subroutine definition (which has compile-time side effects). If not
1354             null, it will be ops directly implementing the statement, suitable to
1355             pass to L. It will not normally include a C or
1356             equivalent op (except for those embedded in a scope contained entirely
1357             within the statement).
1358              
1359             If an error occurs in parsing or compilation, in most cases a valid op
1360             tree (most likely null) is returned anyway. The error is reflected in
1361             the parser state, normally resulting in a single exception at the top
1362             level of parsing which covers all the compilation errors that occurred.
1363             Some compilation errors, however, will throw an exception immediately.
1364              
1365             The I parameter is reserved for future use, and must always
1366             be zero.
1367              
1368             OP * parse_barestmt(U32 flags)','name' => 'parse_barestmt'},'cast_uv' => {'text' => '','name' => 'cast_uv'},'perl_free' => {'text' => 'Releases a Perl interpreter. See L.
1369              
1370             void perl_free(PerlInterpreter *my_perl)','name' => 'perl_free'},'mg_find' => {'text' => 'Finds the magic pointer for type matching the SV. See C.
1371              
1372             MAGIC* mg_find(const SV* sv, int type)','name' => 'mg_find'},'safesysfree' => {'text' => '','name' => 'safesysfree'},'PL_parser-Elinestr' => {'text' => 'NOTE: this function is experimental and may change or be
1373             removed without notice.
1374              
1375              
1376             Buffer scalar containing the chunk currently under consideration of the
1377             text currently being lexed. This is always a plain string scalar (for
1378             which C is true). It is not intended to be used as a scalar by
1379             normal scalar means; instead refer to the buffer directly by the pointer
1380             variables described below.
1381              
1382             The lexer maintains various C pointers to things in the
1383             Clinestr> buffer. If Clinestr> is ever
1384             reallocated, all of these pointers must be updated. Don\'t attempt to
1385             do this manually, but rather use L if you need to
1386             reallocate the buffer.
1387              
1388             The content of the text chunk in the buffer is commonly exactly one
1389             complete line of input, up to and including a newline terminator,
1390             but there are situations where it is otherwise. The octets of the
1391             buffer may be intended to be interpreted as either UTF-8 or Latin-1.
1392             The function L tells you which. Do not use the C
1393             flag on this scalar, which may disagree with it.
1394              
1395             For direct examination of the buffer, the variable
1396             Lbufend> points to the end of the buffer. The current
1397             lexing position is pointed to by Lbufptr>. Direct use
1398             of these pointers is usually preferable to examination of the scalar
1399             through normal scalar means.','name' => 'PL_parser-Elinestr'},'BhkENTRY_set' => {'text' => 'NOTE: this function is experimental and may change or be
1400             removed without notice.
1401              
1402              
1403             Set an entry in the BHK structure, and set the flags to indicate it is
1404             valid. I is a preprocessing token indicating which entry to set.
1405             The type of I depends on the entry.
1406              
1407             void BhkENTRY_set(BHK *hk, which, void *ptr)','name' => 'BhkENTRY_set'},'hv_riter_p' => {'text' => '','name' => 'hv_riter_p'},'newSVpvn_share' => {'text' => 'Creates a new SV with its SvPVX_const pointing to a shared string in the string
1408             table. If the string does not already exist in the table, it is
1409             created first. Turns on the SvIsCOW flag (or READONLY
1410             and FAKE in 5.16 and earlier). If the C parameter
1411             is non-zero, that value is used; otherwise the hash is computed.
1412             The string\'s hash can later be retrieved from the SV
1413             with the C macro. The idea here is
1414             that as the string table is used for shared hash keys these strings will have
1415             SvPVX_const == HeKEY and hash lookup will avoid string compare.
1416              
1417             SV* newSVpvn_share(const char* s, I32 len, U32 hash)','name' => 'newSVpvn_share'},'mro_set_mro' => {'text' => '','name' => 'mro_set_mro'},'SvPOKp' => {'text' => 'Returns a U32 value indicating whether the SV contains a character string.
1418             Checks the B setting. Use C instead.
1419              
1420             U32 SvPOKp(SV* sv)','name' => 'SvPOKp'},'pregfree2' => {'text' => '','name' => 'pregfree2'},'sv_catpvn' => {'text' => 'Concatenates the string onto the end of the string which is in the SV. The
1421             C indicates number of bytes to copy. If the SV has the UTF-8
1422             status set, then the bytes appended should be valid UTF-8.
1423             Handles \'get\' magic, but not \'set\' magic. See C.
1424              
1425             void sv_catpvn(SV *dsv, const char *sstr, STRLEN len)','name' => 'sv_catpvn'},'my_socketpair' => {'text' => '','name' => 'my_socketpair'},'blockhook_register' => {'text' => 'NOTE: this function is experimental and may change or be
1426             removed without notice.
1427              
1428              
1429             Register a set of hooks to be called when the Perl lexical scope changes
1430             at compile time. See L.
1431              
1432             NOTE: this function must be explicitly called as Perl_blockhook_register with an aTHX_ parameter.
1433              
1434             void Perl_blockhook_register(pTHX_ BHK *hk)','name' => 'blockhook_register'},'init_global_struct' => {'text' => '','name' => 'init_global_struct'},'find_rundefsv' => {'text' => 'Find and return the variable that is named C<$_> in the lexical scope
1435             of the currently-executing function. This may be a lexical C<$_>,
1436             or will otherwise be the global one.
1437              
1438             SV * find_rundefsv()','name' => 'find_rundefsv'},'sv_utf8_downgrade' => {'text' => 'NOTE: this function is experimental and may change or be
1439             removed without notice.
1440              
1441              
1442             Attempts to convert the PV of an SV from characters to bytes.
1443             If the PV contains a character that cannot fit
1444             in a byte, this conversion will fail;
1445             in this case, either returns false or, if C is not
1446             true, croaks.
1447              
1448             This is not a general purpose Unicode to byte encoding interface:
1449             use the Encode extension for that.
1450              
1451             bool sv_utf8_downgrade(SV *const sv,
1452             const bool fail_ok)','name' => 'sv_utf8_downgrade'},'utf8_hop' => {'text' => 'Return the UTF-8 pointer C displaced by C characters, either
1453             forward or backward.
1454              
1455             WARNING: do not use the following unless you *know* C is within
1456             the UTF-8 data pointed to by C *and* that on entry C is aligned
1457             on the first byte of character or just after the last byte of a character.
1458              
1459             U8* utf8_hop(const U8 *s, I32 off)','name' => 'utf8_hop'},'newPROG' => {'text' => '','name' => 'newPROG'},'sv_setref_pvn' => {'text' => 'Copies a string into a new SV, optionally blessing the SV. The length of the
1460             string must be specified with C. The C argument will be upgraded to
1461             an RV. That RV will be modified to point to the new SV. The C
1462             argument indicates the package for the blessing. Set C to
1463             C to avoid the blessing. The new SV will have a reference count
1464             of 1, and the RV will be returned.
1465              
1466             Note that C copies the pointer while this copies the string.
1467              
1468             SV* sv_setref_pvn(SV *const rv,
1469             const char *const classname,
1470             const char *const pv,
1471             const STRLEN n)','name' => 'sv_setref_pvn'},'SVt_PVMG' => {'text' => 'Type flag for scalars. See L.','name' => 'SVt_PVMG'},'gv_fetchsv' => {'text' => '','name' => 'gv_fetchsv'},'PUSHp' => {'text' => 'Push a string onto the stack. The stack must have room for this element.
1472             The C indicates the length of the string. Handles \'set\' magic. Uses
1473             C, so C or C should be called to declare it. Do not
1474             call multiple C-oriented macros to return lists from XSUB\'s - see
1475             C instead. See also C and C.
1476              
1477             void PUSHp(char* str, STRLEN len)','name' => 'PUSHp'},'my_strftime' => {'text' => '','name' => 'my_strftime'},'mXPUSHi' => {'text' => 'Push an integer onto the stack, extending the stack if necessary.
1478             Does not use C. See also C, C and C.
1479              
1480             void mXPUSHi(IV iv)','name' => 'mXPUSHi'},'PL_sv_undef' => {'text' => 'This is the C SV. Always refer to this as C<&PL_sv_undef>.
1481              
1482             SV PL_sv_undef','name' => 'PL_sv_undef'},'hv_iterkeysv' => {'text' => 'Returns the key as an C from the current position of the hash
1483             iterator. The return value will always be a mortal copy of the key. Also
1484             see C.
1485              
1486             SV* hv_iterkeysv(HE* entry)','name' => 'hv_iterkeysv'},'sv_catpv_flags' => {'text' => 'Concatenates the C-terminated string onto the end of the string which is
1487             in the SV.
1488             If the SV has the UTF-8 status set, then the bytes appended should
1489             be valid UTF-8. If C has the C bit set, will C
1490             on the modified SV if appropriate.
1491              
1492             void sv_catpv_flags(SV *dstr, const char *sstr,
1493             const I32 flags)','name' => 'sv_catpv_flags'},'mPUSHp' => {'text' => 'Push a string onto the stack. The stack must have room for this element.
1494             The C indicates the length of the string. Does not use C.
1495             See also C, C and C.
1496              
1497             void mPUSHp(char* str, STRLEN len)','name' => 'mPUSHp'},'lex_stuff_pv' => {'text' => 'NOTE: this function is experimental and may change or be
1498             removed without notice.
1499              
1500              
1501             Insert characters into the lexer buffer (Llinestr>),
1502             immediately after the current lexing point (Lbufptr>),
1503             reallocating the buffer if necessary. This means that lexing code that
1504             runs later will see the characters as if they had appeared in the input.
1505             It is not recommended to do this as part of normal parsing, and most
1506             uses of this facility run the risk of the inserted characters being
1507             interpreted in an unintended manner.
1508              
1509             The string to be inserted is represented by octets starting at I
1510             and continuing to the first nul. These octets are interpreted as either
1511             UTF-8 or Latin-1, according to whether the C flag is set
1512             in I. The characters are recoded for the lexer buffer, according
1513             to how the buffer is currently being interpreted (L).
1514             If it is not convenient to nul-terminate a string to be inserted, the
1515             L function is more appropriate.
1516              
1517             void lex_stuff_pv(const char *pv, U32 flags)','name' => 'lex_stuff_pv'},'av_delete' => {'text' => 'Deletes the element indexed by C from the array, makes the element mortal,
1518             and returns it. If C equals C, the element is freed and null
1519             is returned. Perl equivalent: C for the
1520             non-C version and a void-context C for the
1521             C version.
1522              
1523             SV* av_delete(AV *av, SSize_t key, I32 flags)','name' => 'av_delete'},'utf8_distance' => {'text' => 'Returns the number of UTF-8 characters between the UTF-8 pointers C
1524             and C.
1525              
1526             WARNING: use only if you *know* that the pointers point inside the
1527             same UTF-8 buffer.
1528              
1529             IV utf8_distance(const U8 *a, const U8 *b)','name' => 'utf8_distance'},'SvPV_nomg' => {'text' => 'Like C but doesn\'t process magic.
1530              
1531             char* SvPV_nomg(SV* sv, STRLEN len)','name' => 'SvPV_nomg'},'parser_dup' => {'text' => '','name' => 'parser_dup'},'SVt_PVLV' => {'text' => 'Type flag for scalars. See L.','name' => 'SVt_PVLV'},'do_sprintf' => {'text' => '','name' => 'do_sprintf'},'SvUV_nomg' => {'text' => 'Like C but doesn\'t process magic.
1532              
1533             UV SvUV_nomg(SV* sv)','name' => 'SvUV_nomg'},'save_I32' => {'text' => '','name' => 'save_I32'},'gv_autoload4' => {'text' => '','name' => 'gv_autoload4'},'POPpx' => {'text' => 'Pops a string off the stack. Identical to POPp. There are two names for
1534             historical reasons.
1535              
1536             char* POPpx','name' => 'POPpx'},'PL_modglobal' => {'text' => 'C is a general purpose, interpreter global HV for use by
1537             extensions that need to keep information on a per-interpreter basis.
1538             In a pinch, it can also be used as a symbol table for extensions
1539             to share data among each other. It is a good idea to use keys
1540             prefixed by the package name of the extension that owns the data.
1541              
1542             HV* PL_modglobal','name' => 'PL_modglobal'},'newCONDOP' => {'text' => 'Constructs, checks, and returns a conditional-expression (C)
1543             op. I gives the eight bits of C, except that C
1544             will be set automatically, and, shifted up eight bits, the eight bits of
1545             C, except that the bit with value 1 is automatically set.
1546             I supplies the expression selecting between the two branches,
1547             and I and I supply the branches; they are consumed by
1548             this function and become part of the constructed op tree.
1549              
1550             OP * newCONDOP(I32 flags, OP *first, OP *trueop,
1551             OP *falseop)','name' => 'newCONDOP'},'save_pushi32ptr' => {'text' => '','name' => 'save_pushi32ptr'},'sv_setpvs' => {'text' => 'Like C, but takes a literal string instead of a string/length pair.
1552              
1553             void sv_setpvs(SV* sv, const char* s)','name' => 'sv_setpvs'},'uvoffuni_to_utf8_flags' => {'text' => 'THIS FUNCTION SHOULD BE USED IN ONLY VERY SPECIALIZED CIRCUMSTANCES.
1554             Instead, B or
1555             L>.
1556              
1557             This function is like them, but the input is a strict Unicode
1558             (as opposed to native) code point. Only in very rare circumstances should code
1559             not be using the native code point.
1560              
1561             For details, see the description for L>.
1562              
1563             U8* uvoffuni_to_utf8_flags(U8 *d, UV uv, UV flags)','name' => 'uvoffuni_to_utf8_flags'},'cxinc' => {'text' => '','name' => 'cxinc'},'SvUVx' => {'text' => 'Coerces the given SV to an unsigned integer and
1564             returns it. Guarantees to evaluate C only once. Only
1565             use this if C is an expression with side effects,
1566             otherwise use the more efficient C.
1567              
1568             UV SvUVx(SV* sv)','name' => 'SvUVx'},'SvROK_on' => {'text' => 'Tells an SV that it is an RV.
1569              
1570             void SvROK_on(SV* sv)','name' => 'SvROK_on'},'G_VOID' => {'text' => 'Used to indicate void context. See C and L.','name' => 'G_VOID'},'sv_clear' => {'text' => 'Clear an SV: call any destructors, free up any memory used by the body,
1571             and free the body itself. The SV\'s head is I freed, although
1572             its type is set to all 1\'s so that it won\'t inadvertently be assumed
1573             to be live during global destruction etc.
1574             This function should only be called when REFCNT is zero. Most of the time
1575             you\'ll want to call C (or its macro wrapper C)
1576             instead.
1577              
1578             void sv_clear(SV *const orig_sv)','name' => 'sv_clear'},'lex_read_space' => {'text' => 'NOTE: this function is experimental and may change or be
1579             removed without notice.
1580              
1581              
1582             Reads optional spaces, in Perl style, in the text currently being
1583             lexed. The spaces may include ordinary whitespace characters and
1584             Perl-style comments. C<#line> directives are processed if encountered.
1585             Lbufptr> is moved past the spaces, so that it points
1586             at a non-space character (or the end of the input text).
1587              
1588             If spaces extend into the next chunk of input text, the next chunk will
1589             be read in. Normally the current chunk will be discarded at the same
1590             time, but if I includes C then the current
1591             chunk will not be discarded.
1592              
1593             void lex_read_space(U32 flags)','name' => 'lex_read_space'},'SvGAMAGIC' => {'text' => 'Returns true if the SV has get magic or
1594             overloading. If either is true then
1595             the scalar is active data, and has the potential to return a new value every
1596             time it is accessed. Hence you must be careful to
1597             only read it once per user logical operation and work
1598             with that returned value. If neither is true then
1599             the scalar\'s value cannot change unless written to.
1600              
1601             U32 SvGAMAGIC(SV* sv)','name' => 'SvGAMAGIC'},'XSRETURN_NV' => {'text' => 'Return a double from an XSUB immediately. Uses C.
1602              
1603             void XSRETURN_NV(NV nv)','name' => 'XSRETURN_NV'},'svtype' => {'text' => 'An enum of flags for Perl types. These are found in the file B
1604             in the C enum. Test these flags with the C macro.
1605              
1606             The types are:
1607              
1608             SVt_NULL
1609             SVt_IV
1610             SVt_NV
1611             SVt_RV
1612             SVt_PV
1613             SVt_PVIV
1614             SVt_PVNV
1615             SVt_PVMG
1616             SVt_INVLIST
1617             SVt_REGEXP
1618             SVt_PVGV
1619             SVt_PVLV
1620             SVt_PVAV
1621             SVt_PVHV
1622             SVt_PVCV
1623             SVt_PVFM
1624             SVt_PVIO
1625              
1626             These are most easily explained from the bottom up.
1627              
1628             SVt_PVIO is for I/O objects, SVt_PVFM for formats, SVt_PVCV for
1629             subroutines, SVt_PVHV for hashes and SVt_PVAV for arrays.
1630              
1631             All the others are scalar types, that is, things that can be bound to a
1632             C<$> variable. For these, the internal types are mostly orthogonal to
1633             types in the Perl language.
1634              
1635             Hence, checking C<< SvTYPE(sv) < SVt_PVAV >> is the best way to see whether
1636             something is a scalar.
1637              
1638             SVt_PVGV represents a typeglob. If !SvFAKE(sv), then it is a real,
1639             incoercible typeglob. If SvFAKE(sv), then it is a scalar to which a
1640             typeglob has been assigned. Assigning to it again will stop it from being
1641             a typeglob. SVt_PVLV represents a scalar that delegates to another scalar
1642             behind the scenes. It is used, e.g., for the return value of C and
1643             for tied hash and array elements. It can hold any scalar value, including
1644             a typeglob. SVt_REGEXP is for regular
1645             expressions. SVt_INVLIST is for Perl
1646             core internal use only.
1647              
1648             SVt_PVMG represents a "normal" scalar (not a typeglob, regular expression,
1649             or delegate). Since most scalars do not need all the internal fields of a
1650             PVMG, we save memory by allocating smaller structs when possible. All the
1651             other types are just simpler forms of SVt_PVMG, with fewer internal fields.
1652             SVt_NULL can only hold undef. SVt_IV can hold undef, an integer, or a
1653             reference. (SVt_RV is an alias for SVt_IV, which exists for backward
1654             compatibility.) SVt_NV can hold any of those or a double. SVt_PV can only
1655             hold undef or a string. SVt_PVIV is a superset of SVt_PV and SVt_IV.
1656             SVt_PVNV is similar. SVt_PVMG can hold anything SVt_PVNV can hold, but it
1657             can, but does not have to, be blessed or magical.','name' => 'svtype'},'hv_placeholders_get' => {'text' => '','name' => 'hv_placeholders_get'},'load_module' => {'text' => 'Loads the module whose name is pointed to by the string part of name.
1658             Note that the actual module name, not its filename, should be given.
1659             Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
1660             PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
1661             (or 0 for no flags). ver, if specified
1662             and not NULL, provides version semantics
1663             similar to C. The optional trailing SV*
1664             arguments can be used to specify arguments to the module\'s import()
1665             method, similar to C. They must be
1666             terminated with a final NULL pointer. Note that this list can only
1667             be omitted when the PERL_LOADMOD_NOIMPORT flag has been used.
1668             Otherwise at least a single NULL pointer to designate the default
1669             import list is required.
1670              
1671             The reference count for each specified C parameter is decremented.
1672              
1673             void load_module(U32 flags, SV* name, SV* ver, ...)','name' => 'load_module'},'dump_eval' => {'text' => '','name' => 'dump_eval'},'Poison' => {'text' => 'PoisonWith(0xEF) for catching access to freed memory.
1674              
1675             void Poison(void* dest, int nitems, type)','name' => 'Poison'},'sv_catpvf_mg' => {'text' => 'Like C, but also handles \'set\' magic.
1676              
1677             void sv_catpvf_mg(SV *const sv,
1678             const char *const pat, ...)','name' => 'sv_catpvf_mg'},'get_sv' => {'text' => 'Returns the SV of the specified Perl scalar. C are passed to
1679             C. If C is set and the
1680             Perl variable does not exist then it will be created. If C is zero
1681             and the variable does not exist then NULL is returned.
1682              
1683             NOTE: the perl_ form of this function is deprecated.
1684              
1685             SV* get_sv(const char *name, I32 flags)','name' => 'get_sv'},'warn_sv' => {'text' => 'This is an XS interface to Perl\'s C function.
1686              
1687             C is the error message or object. If it is a reference, it
1688             will be used as-is. Otherwise it is used as a string, and if it does
1689             not end with a newline then it will be extended with some indication of
1690             the current location in the code, as described for L.
1691              
1692             The error message or object will by default be written to standard error,
1693             but this is subject to modification by a C<$SIG{__WARN__}> handler.
1694              
1695             To warn with a simple string message, the L function may be
1696             more convenient.
1697              
1698             void warn_sv(SV *baseex)','name' => 'warn_sv'},'GetVars' => {'text' => '','name' => 'GetVars'},'do_hv_dump' => {'text' => '','name' => 'do_hv_dump'},'sv_setpv_mg' => {'text' => 'Like C, but also handles \'set\' magic.
1699              
1700             void sv_setpv_mg(SV *const sv, const char *const ptr)','name' => 'sv_setpv_mg'},'whichsig' => {'text' => '','name' => 'whichsig'},'lex_next_chunk' => {'text' => 'NOTE: this function is experimental and may change or be
1701             removed without notice.
1702              
1703              
1704             Reads in the next chunk of text to be lexed, appending it to
1705             Llinestr>. This should be called when lexing code has
1706             looked to the end of the current chunk and wants to know more. It is
1707             usual, but not necessary, for lexing to have consumed the entirety of
1708             the current chunk at this time.
1709              
1710             If Lbufptr> is pointing to the very end of the current
1711             chunk (i.e., the current chunk has been entirely consumed), normally the
1712             current chunk will be discarded at the same time that the new chunk is
1713             read in. If I includes C, the current chunk
1714             will not be discarded. If the current chunk has not been entirely
1715             consumed, then it will not be discarded regardless of the flag.
1716              
1717             Returns true if some new text was added to the buffer, or false if the
1718             buffer has reached the end of the input text.
1719              
1720             bool lex_next_chunk(U32 flags)','name' => 'lex_next_chunk'},'sv_2mortal' => {'text' => 'Marks an existing SV as mortal. The SV will be destroyed "soon", either
1721             by an explicit call to FREETMPS, or by an implicit call at places such as
1722             statement boundaries. SvTEMP() is turned on which means that the SV\'s
1723             string buffer can be "stolen" if this SV is copied. See also C
1724             and C.
1725              
1726             SV* sv_2mortal(SV *const sv)','name' => 'sv_2mortal'},'sv_2bool_flags' => {'text' => 'This function is only used by sv_true() and friends, and only if
1727             the latter\'s argument is neither SvPOK, SvIOK nor SvNOK. If the flags
1728             contain SV_GMAGIC, then it does an mg_get() first.
1729              
1730              
1731             bool sv_2bool_flags(SV *sv, I32 flags)','name' => 'sv_2bool_flags'},'sync_locale' => {'text' => 'Changing the program\'s locale should be avoided by XS code. Nevertheless,
1732             certain non-Perl libraries called from XS, such as C do so. When this
1733             happens, Perl needs to be told that the locale has changed. Use this macro
1734             to do so, before returning to Perl code.
1735              
1736             void sync_locale()','name' => 'sync_locale'},'malloc' => {'text' => '','name' => 'malloc'},'av_undef' => {'text' => 'Undefines the array. Frees the memory used by the av to store its list of
1737             scalars. If any destructors are triggered as a result, the av itself may
1738             be freed.
1739              
1740             void av_undef(AV *av)','name' => 'av_undef'},'parse_label' => {'text' => 'NOTE: this function is experimental and may change or be
1741             removed without notice.
1742              
1743              
1744             Parse a single label, possibly optional, of the type that may prefix a
1745             Perl statement. It is up to the caller to ensure that the dynamic parser
1746             state (L et al) is correctly set to reflect the source of
1747             the code to be parsed. If I includes C then the
1748             label is optional, otherwise it is mandatory.
1749              
1750             The name of the label is returned in the form of a fresh scalar. If an
1751             optional label is absent, a null pointer is returned.
1752              
1753             If an error occurs in parsing, which can only occur if the label is
1754             mandatory, a valid label is returned anyway. The error is reflected in
1755             the parser state, normally resulting in a single exception at the top
1756             level of parsing which covers all the compilation errors that occurred.
1757              
1758             SV * parse_label(U32 flags)','name' => 'parse_label'},'PL_check' => {'text' => 'Array, indexed by opcode, of functions that will be called for the "check"
1759             phase of optree building during compilation of Perl code. For most (but
1760             not all) types of op, once the op has been initially built and populated
1761             with child ops it will be filtered through the check function referenced
1762             by the appropriate element of this array. The new op is passed in as the
1763             sole argument to the check function, and the check function returns the
1764             completed op. The check function may (as the name suggests) check the op
1765             for validity and signal errors. It may also initialise or modify parts of
1766             the ops, or perform more radical surgery such as adding or removing child
1767             ops, or even throw the op away and return a different op in its place.
1768              
1769             This array of function pointers is a convenient place to hook into the
1770             compilation process. An XS module can put its own custom check function
1771             in place of any of the standard ones, to influence the compilation of a
1772             particular type of op. However, a custom check function must never fully
1773             replace a standard check function (or even a custom check function from
1774             another module). A module modifying checking must instead B the
1775             preexisting check function. A custom check function must be selective
1776             about when to apply its custom behaviour. In the usual case where
1777             it decides not to do anything special with an op, it must chain the
1778             preexisting op function. Check functions are thus linked in a chain,
1779             with the core\'s base checker at the end.
1780              
1781             For thread safety, modules should not write directly to this array.
1782             Instead, use the function L.','name' => 'PL_check'},'pack_cat' => {'text' => 'The engine implementing pack() Perl function. Note: parameters
1783             next_in_list and flags are not used. This call should not be used; use
1784             packlist instead.
1785              
1786             void pack_cat(SV *cat, const char *pat,
1787             const char *patend, SV **beglist,
1788             SV **endlist, SV ***next_in_list,
1789             U32 flags)','name' => 'pack_cat'},'PerlIO_read' => {'text' => '','name' => 'PerlIO_read'},'sv_cmp' => {'text' => 'Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
1790             string in C is less than, equal to, or greater than the string in
1791             C. Is UTF-8 and \'use bytes\' aware, handles get magic, and will
1792             coerce its args to strings if necessary. See also C.
1793              
1794             I32 sv_cmp(SV *const sv1, SV *const sv2)','name' => 'sv_cmp'},'mg_free' => {'text' => 'Free any magic storage used by the SV. See C.
1795              
1796             int mg_free(SV* sv)','name' => 'mg_free'},'sv_force_normal_flags' => {'text' => 'Undo various types of fakery on an SV, where fakery means
1797             "more than" a string: if the PV is a shared string, make
1798             a private copy; if we\'re a ref, stop refing; if we\'re a glob, downgrade to
1799             an xpvmg; if we\'re a copy-on-write scalar, this is the on-write time when
1800             we do the copy, and is also used locally; if this is a
1801             vstring, drop the vstring magic. If C is set
1802             then a copy-on-write scalar drops its PV buffer (if any) and becomes
1803             SvPOK_off rather than making a copy. (Used where this
1804             scalar is about to be set to some other value.) In addition,
1805             the C parameter gets passed to C
1806             when unreffing. C calls this function
1807             with flags set to 0.
1808              
1809             This function is expected to be used to signal to perl that this SV is
1810             about to be written to, and any extra book-keeping needs to be taken care
1811             of. Hence, it croaks on read-only values.
1812              
1813             void sv_force_normal_flags(SV *const sv,
1814             const U32 flags)','name' => 'sv_force_normal_flags'},'cophh_fetch_pv' => {'text' => 'NOTE: this function is experimental and may change or be
1815             removed without notice.
1816              
1817              
1818             Like L, but takes a nul-terminated string instead of
1819             a string/length pair.
1820              
1821             SV * cophh_fetch_pv(const COPHH *cophh,
1822             const char *key, U32 hash,
1823             U32 flags)','name' => 'cophh_fetch_pv'},'tmps_grow' => {'text' => '','name' => 'tmps_grow'},'is_utf8_char' => {'text' => 'DEPRECATED! It is planned to remove this function from a
1824             future release of Perl. Do not use it for new code; remove it from
1825             existing code.
1826              
1827              
1828             Tests if some arbitrary number of bytes begins in a valid UTF-8
1829             character. Note that an INVARIANT (i.e. ASCII on non-EBCDIC machines)
1830             character is a valid UTF-8 character. The actual number of bytes in the UTF-8
1831             character will be returned if it is valid, otherwise 0.
1832              
1833             This function is deprecated due to the possibility that malformed input could
1834             cause reading beyond the end of the input buffer. Use L
1835             instead.
1836              
1837             STRLEN is_utf8_char(const U8 *s)','name' => 'is_utf8_char'},'get_vtbl' => {'text' => '','name' => 'get_vtbl'},'save_hints' => {'text' => '','name' => 'save_hints'},'SvNOK_off' => {'text' => 'Unsets the NV status of an SV.
1838              
1839             void SvNOK_off(SV* sv)','name' => 'SvNOK_off'},'gv_fetchmeth_pv_autoload' => {'text' => 'Exactly like L, but takes a nul-terminated string
1840             instead of a string/length pair.
1841              
1842             GV* gv_fetchmeth_pv_autoload(HV* stash,
1843             const char* name,
1844             I32 level, U32 flags)','name' => 'gv_fetchmeth_pv_autoload'},'sv_utf8_upgrade' => {'text' => 'Converts the PV of an SV to its UTF-8-encoded form.
1845             Forces the SV to string form if it is not already.
1846             Will C on C if appropriate.
1847             Always sets the SvUTF8 flag to avoid future validity checks even
1848             if the whole string is the same in UTF-8 as not.
1849             Returns the number of bytes in the converted string
1850              
1851             This is not a general purpose byte encoding to Unicode interface:
1852             use the Encode extension for that.
1853              
1854             STRLEN sv_utf8_upgrade(SV *sv)','name' => 'sv_utf8_upgrade'},'dXSARGS' => {'text' => 'Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
1855             Sets up the C and C variables by calling C and C.
1856             This is usually handled automatically by C.
1857              
1858             dXSARGS;','name' => 'dXSARGS'},'savesharedpv' => {'text' => 'A version of C which allocates the duplicate string in memory
1859             which is shared between threads.
1860              
1861             char* savesharedpv(const char* pv)','name' => 'savesharedpv'},'isSPACE' => {'text' => 'Returns a boolean indicating whether the specified character is a
1862             whitespace character. This is analogous
1863             to what C matches in a regular expression. Starting in Perl 5.18
1864             (experimentally), this also matches what C does.
1865             ("Experimentally" means that this change may be backed out in 5.22 if
1866             field experience indicates that it was unwise.) Prior to 5.18, only the
1867             locale forms of this macro (the ones with C in their names) matched
1868             precisely what C does. In those releases, the only difference,
1869             in the non-locale variants, was that C did not match a vertical tab.
1870             (See L for a macro that matches a vertical tab in all releases.)
1871             See the L for an explanation of variants
1872             C, C, C, C, C,
1873             C, and C.
1874              
1875             bool isSPACE(char ch)','name' => 'isSPACE'},'Safefree' => {'text' => 'The XSUB-writer\'s interface to the C C function.
1876              
1877             This should B be used on memory obtained using L<"Newx"> and friends.
1878              
1879             void Safefree(void* ptr)','name' => 'Safefree'},'custom_op_desc' => {'text' => 'Return the description of a given custom op. This was once used by the
1880             OP_DESC macro, but is no longer: it has only been kept for
1881             compatibility, and should not be used.
1882              
1883             const char * custom_op_desc(const OP *o)','name' => 'custom_op_desc'},'regdupe_internal' => {'text' => '','name' => 'regdupe_internal'},'gv_stashpvn' => {'text' => 'Returns a pointer to the stash for a specified package. The C
1884             parameter indicates the length of the C, in bytes. C is passed
1885             to C, so if set to C then the package will be
1886             created if it does not already exist. If the package does not exist and
1887             C is 0 (or any other setting that does not create packages) then NULL
1888             is returned.
1889              
1890             Flags may be one of:
1891              
1892             GV_ADD
1893             SVf_UTF8
1894             GV_NOADD_NOINIT
1895             GV_NOINIT
1896             GV_NOEXPAND
1897             GV_ADDMG
1898              
1899             The most important of which are probably GV_ADD and SVf_UTF8.
1900              
1901             HV* gv_stashpvn(const char* name, U32 namelen,
1902             I32 flags)','name' => 'gv_stashpvn'},'vmess' => {'text' => 'C and C are a sprintf-style format pattern and encapsulated
1903             argument list. These are used to generate a string message. If the
1904             message does not end with a newline, then it will be extended with
1905             some indication of the current location in the code, as described for
1906             L.
1907              
1908             Normally, the resulting message is returned in a new mortal SV.
1909             During global destruction a single SV may be shared between uses of
1910             this function.
1911              
1912             SV * vmess(const char *pat, va_list *args)','name' => 'vmess'},'my_stat' => {'text' => '','name' => 'my_stat'},'my_setenv' => {'text' => '','name' => 'my_setenv'},'newSV_type' => {'text' => 'Creates a new SV, of the type specified. The reference count for the new SV
1913             is set to 1.
1914              
1915             SV* newSV_type(const svtype type)','name' => 'newSV_type'},'SvREFCNT_inc_void_NN' => {'text' => 'Same as SvREFCNT_inc, but can only be used if you don\'t need the return
1916             value, and you know that I is not NULL. The macro doesn\'t need
1917             to return a meaningful value, or check for NULLness, so it\'s smaller
1918             and faster.
1919              
1920             void SvREFCNT_inc_void_NN(SV* sv)','name' => 'SvREFCNT_inc_void_NN'},'Perl_signbit' => {'text' => 'NOTE: this function is experimental and may change or be
1921             removed without notice.
1922              
1923              
1924             Return a non-zero integer if the sign bit on an NV is set, and 0 if
1925             it is not.
1926              
1927             If Configure detects this system has a signbit() that will work with
1928             our NVs, then we just use it via the #define in perl.h. Otherwise,
1929             fall back on this implementation. As a first pass, this gets everything
1930             right except -0.0. Alas, catching -0.0 is the main use for this function,
1931             so this is not too helpful yet. Still, at least we have the scaffolding
1932             in place to support other systems, should that prove useful.
1933              
1934              
1935             Configure notes: This function is called \'Perl_signbit\' instead of a
1936             plain \'signbit\' because it is easy to imagine a system having a signbit()
1937             function or macro that doesn\'t happen to work with our particular choice
1938             of NVs. We shouldn\'t just re-#define signbit as Perl_signbit and expect
1939             the standard system headers to be happy. Also, this is a no-context
1940             function (no pTHX_) because Perl_signbit() is usually re-#defined in
1941             perl.h as a simple macro call to the system\'s signbit().
1942             Users should just always call Perl_signbit().
1943              
1944             int Perl_signbit(NV f)','name' => 'Perl_signbit'},'PUSH_MULTICALL' => {'text' => 'Opening bracket for a lightweight callback.
1945             See L.
1946              
1947             PUSH_MULTICALL;','name' => 'PUSH_MULTICALL'},'save_svref' => {'text' => '','name' => 'save_svref'},'newNULLLIST' => {'text' => 'Constructs, checks, and returns a new C op, which represents an
1948             empty list expression.
1949              
1950             OP * newNULLLIST()','name' => 'newNULLLIST'},'sv_pos_b2u_flags' => {'text' => 'Converts the offset from a count of bytes from the start of the string, to
1951             a count of the equivalent number of UTF-8 chars. Handles type coercion.
1952             I is passed to C, and usually should be
1953             C to handle magic.
1954              
1955             STRLEN sv_pos_b2u_flags(SV *const sv,
1956             STRLEN const offset, U32 flags)','name' => 'sv_pos_b2u_flags'},'sv_pos_u2b_flags' => {'text' => 'Converts the offset from a count of UTF-8 chars from
1957             the start of the string, to a count of the equivalent number of bytes; if
1958             lenp is non-zero, it does the same to lenp, but this time starting from
1959             the offset, rather than from the start
1960             of the string. Handles type coercion.
1961             I is passed to C, and usually should be
1962             C to handle magic.
1963              
1964             STRLEN sv_pos_u2b_flags(SV *const sv, STRLEN uoffset,
1965             STRLEN *const lenp, U32 flags)','name' => 'sv_pos_u2b_flags'},'init_tm' => {'text' => '','name' => 'init_tm'},'newWHILEOP' => {'text' => 'Constructs, checks, and returns an op tree expressing a C loop.
1966             This is a heavyweight loop, with structure that allows exiting the loop
1967             by C and suchlike.
1968              
1969             I is an optional preconstructed C op to use in the
1970             loop; if it is null then a suitable op will be constructed automatically.
1971             I supplies the loop\'s controlling expression. I supplies the
1972             main body of the loop, and I optionally supplies a C block
1973             that operates as a second half of the body. All of these optree inputs
1974             are consumed by this function and become part of the constructed op tree.
1975              
1976             I gives the eight bits of C for the C
1977             op and, shifted up eight bits, the eight bits of C for
1978             the C op, except that (in both cases) some bits will be set
1979             automatically. I is currently unused and should always be 1.
1980             I can be supplied as true to force the
1981             loop body to be enclosed in its own scope.
1982              
1983             OP * newWHILEOP(I32 flags, I32 debuggable,
1984             LOOP *loop, OP *expr, OP *block,
1985             OP *cont, I32 has_my)','name' => 'newWHILEOP'},'Gv_AMupdate' => {'text' => '','name' => 'Gv_AMupdate'},'filter_del' => {'text' => '','name' => 'filter_del'},'SvIV_nomg' => {'text' => 'Like C but doesn\'t process magic.
1986              
1987             IV SvIV_nomg(SV* sv)','name' => 'SvIV_nomg'},'POPp' => {'text' => 'Pops a string off the stack.
1988              
1989             char* POPp','name' => 'POPp'},'RETVAL' => {'text' => 'Variable which is setup by C to hold the return value for an
1990             XSUB. This is always the proper type for the XSUB. See
1991             L.
1992              
1993             (whatever) RETVAL','name' => 'RETVAL'},'HeSVKEY' => {'text' => 'Returns the key as an C, or C if the hash entry does not
1994             contain an C key.
1995              
1996             SV* HeSVKEY(HE* he)','name' => 'HeSVKEY'},'newANONLIST' => {'text' => '','name' => 'newANONLIST'},'mg_findext' => {'text' => 'Finds the magic pointer of C with the given C for the C. See
1997             C.
1998              
1999             MAGIC* mg_findext(const SV* sv, int type,
2000             const MGVTBL *vtbl)','name' => 'mg_findext'},'my_memset' => {'text' => '','name' => 'my_memset'},'my_atof2' => {'text' => '','name' => 'my_atof2'},'PerlIO_get_ptr' => {'text' => '','name' => 'PerlIO_get_ptr'},'save_destructor' => {'text' => '','name' => 'save_destructor'},'sv_cmp_flags' => {'text' => 'Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
2001             string in C is less than, equal to, or greater than the string in
2002             C. Is UTF-8 and \'use bytes\' aware and will coerce its args to strings
2003             if necessary. If the flags include SV_GMAGIC, it handles get magic. See
2004             also C.
2005              
2006             I32 sv_cmp_flags(SV *const sv1, SV *const sv2,
2007             const U32 flags)','name' => 'sv_cmp_flags'},'hv_iternextsv' => {'text' => 'Performs an C, C, and C in one
2008             operation.
2009              
2010             SV* hv_iternextsv(HV *hv, char **key, I32 *retlen)','name' => 'hv_iternextsv'},'lex_read_to' => {'text' => 'NOTE: this function is experimental and may change or be
2011             removed without notice.
2012              
2013              
2014             Consume text in the lexer buffer, from Lbufptr> up
2015             to I. This advances Lbufptr> to match I,
2016             performing the correct bookkeeping whenever a newline character is passed.
2017             This is the normal way to consume lexed text.
2018              
2019             Interpretation of the buffer\'s octets can be abstracted out by
2020             using the slightly higher-level functions L and
2021             L.
2022              
2023             void lex_read_to(char *ptr)','name' => 'lex_read_to'},'sv_pvbyten_force' => {'text' => 'The backend for the C macro. Always use the macro
2024             instead.
2025              
2026             char* sv_pvbyten_force(SV *const sv, STRLEN *const lp)','name' => 'sv_pvbyten_force'},'reg_named_buff_fetch' => {'text' => '','name' => 'reg_named_buff_fetch'},'ibcmp_locale' => {'text' => 'This is a synonym for (! foldEQ_locale())
2027              
2028             I32 ibcmp_locale(const char* a, const char* b,
2029             I32 len)','name' => 'ibcmp_locale'},'XST_mIV' => {'text' => 'Place an integer into the specified position C on the stack. The
2030             value is stored in a new mortal SV.
2031              
2032             void XST_mIV(int pos, IV iv)','name' => 'XST_mIV'},'save_pptr' => {'text' => '','name' => 'save_pptr'},'PerlIO_set_ptrcnt' => {'text' => '','name' => 'PerlIO_set_ptrcnt'},'mPUSHs' => {'text' => 'Push an SV onto the stack and mortalizes the SV. The stack must have room
2033             for this element. Does not use C. See also C and C.
2034              
2035             void mPUSHs(SV* sv)','name' => 'mPUSHs'},'dump_packsubs' => {'text' => 'Dumps the optrees for all visible subroutines in C.
2036              
2037             void dump_packsubs(const HV* stash)','name' => 'dump_packsubs'},'GvSV' => {'text' => 'Return the SV from the GV.
2038              
2039             SV* GvSV(GV* gv)','name' => 'GvSV'},'isPRINT' => {'text' => 'Returns a boolean indicating whether the specified character is a
2040             printable character, analogous to C.
2041             See the L for an explanation of variants
2042             C, C, C, C, C,
2043             C, and C.
2044              
2045             bool isPRINT(char ch)','name' => 'isPRINT'},'vform' => {'text' => '','name' => 'vform'},'get_op_descs' => {'text' => '','name' => 'get_op_descs'},'safesyscalloc' => {'text' => '','name' => 'safesyscalloc'},'PL_curpad' => {'text' => 'NOTE: this function is experimental and may change or be
2046             removed without notice.
2047              
2048              
2049             Points directly to the body of the L array.
2050             (I.e., this is C.)','name' => 'PL_curpad'},'POPi' => {'text' => 'Pops an integer off the stack.
2051              
2052             IV POPi','name' => 'POPi'},'parse_stmtseq' => {'text' => 'NOTE: this function is experimental and may change or be
2053             removed without notice.
2054              
2055              
2056             Parse a sequence of zero or more Perl statements. These may be normal
2057             imperative statements, including optional labels, or declarations
2058             that have compile-time effect, or any mixture thereof. The statement
2059             sequence ends when a closing brace or end-of-file is encountered in a
2060             place where a new statement could have validly started. It is up to
2061             the caller to ensure that the dynamic parser state (L et al)
2062             is correctly set to reflect the source of the code to be parsed and the
2063             lexical context for the statements.
2064              
2065             The op tree representing the statement sequence is returned. This may
2066             be a null pointer if the statements were all null, for example if there
2067             were no statements or if there were only subroutine definitions (which
2068             have compile-time side effects). If not null, it will be a C
2069             list, normally including C or equivalent ops.
2070              
2071             If an error occurs in parsing or compilation, in most cases a valid op
2072             tree is returned anyway. The error is reflected in the parser state,
2073             normally resulting in a single exception at the top level of parsing
2074             which covers all the compilation errors that occurred. Some compilation
2075             errors, however, will throw an exception immediately.
2076              
2077             The I parameter is reserved for future use, and must always
2078             be zero.
2079              
2080             OP * parse_stmtseq(U32 flags)','name' => 'parse_stmtseq'},'sv_2pvutf8_nolen' => {'text' => 'Return a pointer to the UTF-8-encoded representation of the SV.
2081             May cause the SV to be upgraded to UTF-8 as a side-effect.
2082              
2083             Usually accessed via the C macro.
2084              
2085             char* sv_2pvutf8_nolen(SV* sv)','name' => 'sv_2pvutf8_nolen'},'gv_HVadd' => {'text' => '','name' => 'gv_HVadd'},'custom_op_xop' => {'text' => 'Return the XOP structure for a given custom op. This macro should be
2086             considered internal to OP_NAME and the other access macros: use them instead.
2087             This macro does call a function. Prior
2088             to 5.19.6, this was implemented as a
2089             function.
2090              
2091             NOTE: this function must be explicitly called as Perl_custom_op_xop with an aTHX_ parameter.
2092              
2093             const XOP * Perl_custom_op_xop(pTHX_ const OP *o)','name' => 'custom_op_xop'},'mro_get_linear_isa' => {'text' => 'Returns the mro linearisation for the given stash. By default, this
2094             will be whatever C returns unless some
2095             other MRO is in effect for the stash. The return value is a
2096             read-only AV*.
2097              
2098             You are responsible for C on the
2099             return value if you plan to store it anywhere
2100             semi-permanently (otherwise it might be deleted
2101             out from under you the next time the cache is
2102             invalidated).
2103              
2104             AV* mro_get_linear_isa(HV* stash)','name' => 'mro_get_linear_isa'},'SvPVbytex' => {'text' => 'Like C, but converts sv to byte representation first if necessary.
2105             Guarantees to evaluate sv only once; use the more efficient C
2106             otherwise.
2107              
2108             char* SvPVbytex(SV* sv, STRLEN len)','name' => 'SvPVbytex'},'av_store' => {'text' => 'Stores an SV in an array. The array index is specified as C. The
2109             return value will be NULL if the operation failed or if the value did not
2110             need to be actually stored within the array (as in the case of tied
2111             arrays). Otherwise, it can be dereferenced
2112             to get the C that was stored
2113             there (= C)).
2114              
2115             Note that the caller is responsible for suitably incrementing the reference
2116             count of C before the call, and decrementing it if the function
2117             returned NULL.
2118              
2119             Approximate Perl equivalent: C<$myarray[$key] = $val;>.
2120              
2121             See L for
2122             more information on how to use this function on tied arrays.
2123              
2124             SV** av_store(AV *av, SSize_t key, SV *val)','name' => 'av_store'},'reg_named_buff_scalar' => {'text' => '','name' => 'reg_named_buff_scalar'},'unlnk' => {'text' => '','name' => 'unlnk'},'toUPPER_utf8' => {'text' => 'Converts the UTF-8 encoded character at C

to its uppercase version, and

2125             stores that in UTF-8 in C, and its length in bytes in C. Note
2126             that the buffer pointed to by C needs to be at least C
2127             bytes since the uppercase version may be longer than the original character.
2128              
2129             The first code point of the uppercased version is returned
2130             (but note, as explained just above, that there may be more.)
2131              
2132             The input character at C

is assumed to be well-formed.

2133              
2134             UV toUPPER_utf8(U8* p, U8* s, STRLEN* lenp)','name' => 'toUPPER_utf8'},'av_fetch' => {'text' => 'Returns the SV at the specified index in the array. The C is the
2135             index. If lval is true, you are guaranteed to get a real SV back (in case
2136             it wasn\'t real before), which you can then modify. Check that the return
2137             value is non-null before dereferencing it to a C.
2138              
2139             See L for
2140             more information on how to use this function on tied arrays.
2141              
2142             The rough perl equivalent is C<$myarray[$idx]>.
2143              
2144             SV** av_fetch(AV *av, SSize_t key, I32 lval)','name' => 'av_fetch'},'SvNOK_only' => {'text' => 'Tells an SV that it is a double and disables all other OK bits.
2145              
2146             void SvNOK_only(SV* sv)','name' => 'SvNOK_only'},'hv_iterval' => {'text' => 'Returns the value from the current position of the hash iterator. See
2147             C.
2148              
2149             SV* hv_iterval(HV *hv, HE *entry)','name' => 'hv_iterval'},'sv_reftype' => {'text' => 'Returns a string describing what the SV is a reference to.
2150              
2151             const char* sv_reftype(const SV *const sv, const int ob)','name' => 'sv_reftype'},'foldEQ_locale' => {'text' => 'Returns true if the leading len bytes of the strings s1 and s2 are the same
2152             case-insensitively in the current locale; false otherwise.
2153              
2154             I32 foldEQ_locale(const char* a, const char* b,
2155             I32 len)','name' => 'foldEQ_locale'},'cophh_2hv' => {'text' => 'NOTE: this function is experimental and may change or be
2156             removed without notice.
2157              
2158              
2159             Generates and returns a standard Perl hash representing the full set of
2160             key/value pairs in the cop hints hash I. I is currently
2161             unused and must be zero.
2162              
2163             HV * cophh_2hv(const COPHH *cophh, U32 flags)','name' => 'cophh_2hv'},'SvREFCNT_inc_simple_void_NN' => {'text' => 'Same as SvREFCNT_inc, but can only be used if you don\'t need the return
2164             value, and you know that I is not NULL. The macro doesn\'t need
2165             to return a meaningful value, or check for NULLness, so it\'s smaller
2166             and faster.
2167              
2168             void SvREFCNT_inc_simple_void_NN(SV* sv)','name' => 'SvREFCNT_inc_simple_void_NN'},'rsignal_state' => {'text' => '','name' => 'rsignal_state'},'av_len' => {'text' => 'Same as L. Note that, unlike what the name implies, it returns
2169             the highest index in the array, so to get the size of the array you need to use
2170             S>. This is unlike L, which returns what you would
2171             expect.
2172              
2173             SSize_t av_len(AV *av)','name' => 'av_len'},'sv_unmagic' => {'text' => 'Removes all magic of type C from an SV.
2174              
2175             int sv_unmagic(SV *const sv, const int type)','name' => 'sv_unmagic'},'SvTAINT' => {'text' => 'Taints an SV if tainting is enabled, and if some input to the current
2176             expression is tainted--usually a variable, but possibly also implicit
2177             inputs such as locale settings. C propagates that taintedness to
2178             the outputs of an expression in a pessimistic fashion; i.e., without paying
2179             attention to precisely which outputs are influenced by which inputs.
2180              
2181             void SvTAINT(SV* sv)','name' => 'SvTAINT'},'mg_clear' => {'text' => 'Clear something magical that the SV represents. See C.
2182              
2183             int mg_clear(SV* sv)','name' => 'mg_clear'},'my_sprintf' => {'text' => 'The C library C, wrapped if necessary, to ensure that it will return
2184             the length of the string written to the buffer. Only rare pre-ANSI systems
2185             need the wrapper function - usually this is a direct call to C.
2186              
2187             int my_sprintf(char *buffer, const char *pat, ...)','name' => 'my_sprintf'},'to_utf8_fold' => {'text' => 'Instead use L.
2188              
2189             UV to_utf8_fold(const U8 *p, U8* ustrp,
2190             STRLEN *lenp)','name' => 'to_utf8_fold'},'regfree_internal' => {'text' => '','name' => 'regfree_internal'},'gv_stashpv' => {'text' => 'Returns a pointer to the stash for a specified package. Uses C to
2191             determine the length of C, then calls C.
2192              
2193             HV* gv_stashpv(const char* name, I32 flags)','name' => 'gv_stashpv'},'sv_cmp_locale_flags' => {'text' => 'Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
2194             \'use bytes\' aware and will coerce its args to strings if necessary. If the
2195             flags contain SV_GMAGIC, it handles get magic. See also C.
2196              
2197             I32 sv_cmp_locale_flags(SV *const sv1,
2198             SV *const sv2,
2199             const U32 flags)','name' => 'sv_cmp_locale_flags'},'sv_vcatpvf_mg' => {'text' => 'Like C, but also handles \'set\' magic.
2200              
2201             Usually used via its frontend C.
2202              
2203             void sv_vcatpvf_mg(SV *const sv,
2204             const char *const pat,
2205             va_list *const args)','name' => 'sv_vcatpvf_mg'},'mXPUSHu' => {'text' => 'Push an unsigned integer onto the stack, extending the stack if necessary.
2206             Does not use C. See also C, C and C.
2207              
2208             void mXPUSHu(UV uv)','name' => 'mXPUSHu'},'hv_exists_ent' => {'text' => 'Returns a boolean indicating whether
2209             the specified hash key exists. C
2210             can be a valid precomputed hash value, or 0 to ask for it to be
2211             computed.
2212              
2213             bool hv_exists_ent(HV *hv, SV *keysv, U32 hash)','name' => 'hv_exists_ent'},'PL_comppad' => {'text' => 'NOTE: this function is experimental and may change or be
2214             removed without notice.
2215              
2216              
2217             During compilation, this points to the array containing the values
2218             part of the pad for the currently-compiling code. (At runtime a CV may
2219             have many such value arrays; at compile time just one is constructed.)
2220             At runtime, this points to the array containing the currently-relevant
2221             values for the pad for the currently-executing code.','name' => 'PL_comppad'},'atfork_unlock' => {'text' => '','name' => 'atfork_unlock'},'SvNIOK' => {'text' => 'Returns a U32 value indicating whether the SV contains a number, integer or
2222             double.
2223              
2224             U32 SvNIOK(SV* sv)','name' => 'SvNIOK'},'save_long' => {'text' => '','name' => 'save_long'},'mro_method_changed_in' => {'text' => 'Invalidates method caching on any child classes
2225             of the given stash, so that they might notice
2226             the changes in this one.
2227              
2228             Ideally, all instances of C in
2229             perl source outside of F should be
2230             replaced by calls to this.
2231              
2232             Perl automatically handles most of the common
2233             ways a method might be redefined. However, there
2234             are a few ways you could change a method in a stash
2235             without the cache code noticing, in which case you
2236             need to call this method afterwards:
2237              
2238             1) Directly manipulating the stash HV entries from
2239             XS code.
2240              
2241             2) Assigning a reference to a readonly scalar
2242             constant into a stash entry in order to create
2243             a constant subroutine (like constant.pm
2244             does).
2245              
2246             This same method is available from pure perl
2247             via, C.
2248              
2249             void mro_method_changed_in(HV* stash)','name' => 'mro_method_changed_in'},'toTITLE_uni' => {'text' => 'Converts the Unicode code point C to its titlecase version, and
2250             stores that in UTF-8 in C, and its length in bytes in C. Note
2251             that the buffer pointed to by C needs to be at least C
2252             bytes since the titlecase version may be longer than the original character.
2253              
2254             The first code point of the titlecased version is returned
2255             (but note, as explained just above, that there may be more.)
2256              
2257             UV toTITLE_uni(UV cp, U8* s, STRLEN* lenp)','name' => 'toTITLE_uni'},'unpack_str' => {'text' => 'The engine implementing unpack() Perl function. Note: parameters strbeg,
2258             new_s and ocnt are not used. This call should not be used, use
2259             unpackstring instead.
2260              
2261             I32 unpack_str(const char *pat, const char *patend,
2262             const char *s, const char *strbeg,
2263             const char *strend, char **new_s,
2264             I32 ocnt, U32 flags)','name' => 'unpack_str'},'my_fflush_all' => {'text' => '','name' => 'my_fflush_all'},'sv_newref' => {'text' => 'Increment an SV\'s reference count. Use the C wrapper
2265             instead.
2266              
2267             SV* sv_newref(SV *const sv)','name' => 'sv_newref'},'cop_hints_fetch_pv' => {'text' => 'Like L, but takes a nul-terminated string instead
2268             of a string/length pair.
2269              
2270             SV * cop_hints_fetch_pv(const COP *cop,
2271             const char *key, U32 hash,
2272             U32 flags)','name' => 'cop_hints_fetch_pv'},'XSRETURN_IV' => {'text' => 'Return an integer from an XSUB immediately. Uses C.
2273              
2274             void XSRETURN_IV(IV iv)','name' => 'XSRETURN_IV'},'sv_uni_display' => {'text' => 'Build to the scalar C a displayable version of the scalar C,
2275             the displayable version being at most C bytes long
2276             (if longer, the rest is truncated and "..." will be appended).
2277              
2278             The C argument is as in L().
2279              
2280             The pointer to the PV of the C is returned.
2281              
2282             char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim,
2283             UV flags)','name' => 'sv_uni_display'},'sv_unmagicext' => {'text' => 'Removes all magic of type C with the specified C from an SV.
2284              
2285             int sv_unmagicext(SV *const sv, const int type,
2286             MGVTBL *vtbl)','name' => 'sv_unmagicext'},'newSVpvs' => {'text' => 'Like C, but takes a literal C-terminated string instead of a
2287             string/length pair.
2288              
2289             SV* newSVpvs(const char* s)','name' => 'newSVpvs'},'SvREFCNT_dec' => {'text' => 'Decrements the reference count of the given SV. I may be NULL.
2290              
2291             void SvREFCNT_dec(SV* sv)','name' => 'SvREFCNT_dec'},'realloc' => {'text' => '','name' => 'realloc'},'toLOWER_utf8' => {'text' => 'Converts the UTF-8 encoded character at C

to its lowercase version, and

2292             stores that in UTF-8 in C, and its length in bytes in C. Note
2293             that the buffer pointed to by C needs to be at least C
2294             bytes since the lowercase version may be longer than the original character.
2295              
2296             The first code point of the lowercased version is returned
2297             (but note, as explained just above, that there may be more.)
2298              
2299             The input character at C

is assumed to be well-formed.

2300              
2301             UV toLOWER_utf8(U8* p, U8* s, STRLEN* lenp)','name' => 'toLOWER_utf8'},'POPs' => {'text' => 'Pops an SV off the stack.
2302              
2303             SV* POPs','name' => 'POPs'},'SvNV' => {'text' => 'Coerce the given SV to a double and return it. See C for a version
2304             which guarantees to evaluate sv only once.
2305              
2306             NV SvNV(SV* sv)','name' => 'SvNV'},'packlist' => {'text' => 'The engine implementing pack() Perl function.
2307              
2308             void packlist(SV *cat, const char *pat,
2309             const char *patend, SV **beglist,
2310             SV **endlist)','name' => 'packlist'},'SvUTF8' => {'text' => 'Returns a U32 value indicating the UTF-8 status of an SV. If things are set-up
2311             properly, this indicates whether or not the SV contains UTF-8 encoded data.
2312             You should use this I a call to SvPV() or one of its variants, in
2313             case any call to string overloading updates the internal flag.
2314              
2315             U32 SvUTF8(SV* sv)','name' => 'SvUTF8'},'gv_fetchmethod_autoload' => {'text' => 'Returns the glob which contains the subroutine to call to invoke the method
2316             on the C. In fact in the presence of autoloading this may be the
2317             glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
2318             already setup.
2319              
2320             The third parameter of C determines whether
2321             AUTOLOAD lookup is performed if the given method is not present: non-zero
2322             means yes, look for AUTOLOAD; zero means no, don\'t look for AUTOLOAD.
2323             Calling C is equivalent to calling C
2324             with a non-zero C parameter.
2325              
2326             These functions grant C<"SUPER"> token
2327             as a prefix of the method name. Note
2328             that if you want to keep the returned glob for a long time, you need to
2329             check for it being "AUTOLOAD", since at the later time the call may load a
2330             different subroutine due to $AUTOLOAD changing its value. Use the glob
2331             created as a side effect to do this.
2332              
2333             These functions have the same side-effects as C with
2334             C. The warning against passing the GV returned by
2335             C to C applies equally to these functions.
2336              
2337             GV* gv_fetchmethod_autoload(HV* stash,
2338             const char* name,
2339             I32 autoload)','name' => 'gv_fetchmethod_autoload'},'get_mstats' => {'text' => '','name' => 'get_mstats'},'op_dump' => {'text' => 'Dumps the optree starting at OP C to C.
2340              
2341             void op_dump(const OP *o)','name' => 'op_dump'},'savestack_grow' => {'text' => '','name' => 'savestack_grow'},'debstackptrs' => {'text' => '','name' => 'debstackptrs'},'sv_eq' => {'text' => 'Returns a boolean indicating whether the strings in the two SVs are
2342             identical. Is UTF-8 and \'use bytes\' aware, handles get magic, and will
2343             coerce its args to strings if necessary.
2344              
2345             I32 sv_eq(SV* sv1, SV* sv2)','name' => 'sv_eq'},'SvTAINTED' => {'text' => 'Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
2346             not.
2347              
2348             bool SvTAINTED(SV* sv)','name' => 'SvTAINTED'},'ptr_table_store' => {'text' => '','name' => 'ptr_table_store'},'cv_undef' => {'text' => 'Clear out all the active components of a CV. This can happen either
2349             by an explicit C, or by the reference count going to zero.
2350             In the former case, we keep the CvOUTSIDE pointer, so that any anonymous
2351             children can still follow the full lexical scope chain.
2352              
2353             void cv_undef(CV* cv)','name' => 'cv_undef'},'StructCopy' => {'text' => 'This is an architecture-independent macro to copy one structure to another.
2354              
2355             void StructCopy(type *src, type *dest, type)','name' => 'StructCopy'},'sv_catpvf_nocontext' => {'text' => '','name' => 'sv_catpvf_nocontext'},'save_padsv_and_mortalize' => {'text' => '','name' => 'save_padsv_and_mortalize'},'gv_autoload_sv' => {'text' => '','name' => 'gv_autoload_sv'},'cophh_delete_pvs' => {'text' => 'NOTE: this function is experimental and may change or be
2356             removed without notice.
2357              
2358              
2359             Like L, but takes a literal string instead of a
2360             string/length pair, and no precomputed hash.
2361              
2362             COPHH * cophh_delete_pvs(const COPHH *cophh,
2363             const char *key, U32 flags)','name' => 'cophh_delete_pvs'},'GvCV' => {'text' => 'Return the CV from the GV.
2364              
2365             CV* GvCV(GV* gv)','name' => 'GvCV'},'get_cvn_flags' => {'text' => 'Returns the CV of the specified Perl subroutine. C are passed to
2366             C. If C is set and the Perl subroutine does not
2367             exist then it will be declared (which has the same effect as saying
2368             C). If C is not set and the subroutine does not exist
2369             then NULL is returned.
2370              
2371             NOTE: the perl_ form of this function is deprecated.
2372              
2373             CV* get_cvn_flags(const char* name, STRLEN len,
2374             I32 flags)','name' => 'get_cvn_flags'},'XopENTRY_set' => {'text' => 'Set a member of the XOP structure. I is a cpp token
2375             indicating which entry to set. See L
2376             for details about the available members and how
2377             they are used. This macro evaluates its argument
2378             more than once.
2379              
2380             void XopENTRY_set(XOP *xop, which, value)','name' => 'XopENTRY_set'},'reentrant_free' => {'text' => '','name' => 'reentrant_free'},'items' => {'text' => 'Variable which is setup by C to indicate the number of
2381             items on the stack. See L.
2382              
2383             I32 items','name' => 'items'},'XST_mPV' => {'text' => 'Place a copy of a string into the specified position C on the stack.
2384             The value is stored in a new mortal SV.
2385              
2386             void XST_mPV(int pos, char* str)','name' => 'XST_mPV'},'dump_vindent' => {'text' => '','name' => 'dump_vindent'},'SvPVx' => {'text' => 'A version of C which guarantees to evaluate C only once.
2387             Only use this if C is an expression with side effects, otherwise use the
2388             more efficient C.
2389              
2390             char* SvPVx(SV* sv, STRLEN len)','name' => 'SvPVx'},'dump_form' => {'text' => '','name' => 'dump_form'},'sv_grow' => {'text' => 'Expands the character buffer in the SV. If necessary, uses C and
2391             upgrades the SV to C. Returns a pointer to the character buffer.
2392             Use the C wrapper instead.
2393              
2394             char* sv_grow(SV *const sv, STRLEN newlen)','name' => 'sv_grow'},'vnormal' => {'text' => 'Accepts a version object and returns the normalized string
2395             representation. Call like:
2396              
2397             sv = vnormal(rv);
2398              
2399             NOTE: you can pass either the object directly or the SV
2400             contained within the RV.
2401              
2402             The SV returned has a refcount of 1.
2403              
2404             SV* vnormal(SV *vs)','name' => 'vnormal'},'filter_add' => {'text' => '','name' => 'filter_add'},'newPVOP' => {'text' => 'Constructs, checks, and returns an op of any type that involves an
2405             embedded C-level pointer (PV). I is the opcode. I gives
2406             the eight bits of C. I supplies the C-level pointer, which
2407             must have been allocated using C; the memory will
2408             be freed when the op is destroyed.
2409              
2410             OP * newPVOP(I32 type, I32 flags, char *pv)','name' => 'newPVOP'},'XPUSHs' => {'text' => 'Push an SV onto the stack, extending the stack if necessary. Does not
2411             handle \'set\' magic. Does not use C. See also C,
2412             C and C.
2413              
2414             void XPUSHs(SV* sv)','name' => 'XPUSHs'},'set_numeric_radix' => {'text' => '','name' => 'set_numeric_radix'},'newIO' => {'text' => '','name' => 'newIO'},'toFOLD_utf8' => {'text' => 'Converts the UTF-8 encoded character at C

to its foldcase version, and

2415             stores that in UTF-8 in C, and its length in bytes in C. Note
2416             that the buffer pointed to by C needs to be at least C
2417             bytes since the foldcase version may be longer than the original character.
2418              
2419             The first code point of the foldcased version is returned
2420             (but note, as explained just above, that there may be more.)
2421              
2422             The input character at C

is assumed to be well-formed.

2423              
2424             UV toFOLD_utf8(U8* p, U8* s, STRLEN* lenp)','name' => 'toFOLD_utf8'},'PadnameUTF8' => {'text' => 'NOTE: this function is experimental and may change or be
2425             removed without notice.
2426              
2427              
2428             Whether PadnamePV is in UTF8.
2429              
2430             bool PadnameUTF8(PADNAME pn)','name' => 'PadnameUTF8'},'do_join' => {'text' => '','name' => 'do_join'},'save_helem' => {'text' => '','name' => 'save_helem'},'die' => {'text' => 'Behaves the same as L, except for the return type.
2431             It should be used only where the C return type is required.
2432             The function never actually returns.
2433              
2434             OP * die(const char *pat, ...)','name' => 'die'},'sv_usepvn' => {'text' => 'Tells an SV to use C to find its string value. Implemented by
2435             calling C with C of 0, hence does not handle \'set\'
2436             magic. See C.
2437              
2438             void sv_usepvn(SV* sv, char* ptr, STRLEN len)','name' => 'sv_usepvn'},'SvREFCNT' => {'text' => 'Returns the value of the object\'s reference count.
2439              
2440             U32 SvREFCNT(SV* sv)','name' => 'SvREFCNT'},'newCONSTSUB_flags' => {'text' => 'Creates a constant sub equivalent to Perl C which is
2441             eligible for inlining at compile-time.
2442              
2443             Currently, the only useful value for C is SVf_UTF8.
2444              
2445             The newly created subroutine takes ownership of a reference to the passed in
2446             SV.
2447              
2448             Passing NULL for SV creates a constant sub equivalent to C,
2449             which won\'t be called if used as a destructor, but will suppress the overhead
2450             of a call to C. (This form, however, isn\'t eligible for inlining at
2451             compile time.)
2452              
2453             CV* newCONSTSUB_flags(HV* stash, const char* name,
2454             STRLEN len, U32 flags, SV* sv)','name' => 'newCONSTSUB_flags'},'swash_init' => {'text' => '','name' => 'swash_init'},'newANONSUB' => {'text' => '','name' => 'newANONSUB'},'warn' => {'text' => 'This is an XS interface to Perl\'s C function.
2455              
2456             Take a sprintf-style format pattern and argument list. These are used to
2457             generate a string message. If the message does not end with a newline,
2458             then it will be extended with some indication of the current location
2459             in the code, as described for L.
2460              
2461             The error message or object will by default be written to standard error,
2462             but this is subject to modification by a C<$SIG{__WARN__}> handler.
2463              
2464             Unlike with L, C is not permitted to be null.
2465              
2466             void warn(const char *pat, ...)','name' => 'warn'},'PerlIO_get_bufsiz' => {'text' => '','name' => 'PerlIO_get_bufsiz'},'fp_dup' => {'text' => '','name' => 'fp_dup'},'hek_dup' => {'text' => '','name' => 'hek_dup'},'pmop_dump' => {'text' => '','name' => 'pmop_dump'},'newANONATTRSUB' => {'text' => '','name' => 'newANONATTRSUB'},'CvPADLIST' => {'text' => 'NOTE: this function is experimental and may change or be
2467             removed without notice.
2468              
2469              
2470             CV\'s can have CvPADLIST(cv) set to point to a PADLIST. This is the CV\'s
2471             scratchpad, which stores lexical variables and opcode temporary and
2472             per-thread values.
2473              
2474             For these purposes "formats" are a kind-of CV; eval""s are too (except they\'re
2475             not callable at will and are always thrown away after the eval"" is done
2476             executing). Require\'d files are simply evals without any outer lexical
2477             scope.
2478              
2479             XSUBs don\'t have CvPADLIST set - dXSTARG fetches values from PL_curpad,
2480             but that is really the callers pad (a slot of which is allocated by
2481             every entersub).
2482              
2483             The PADLIST has a C array where pads are stored.
2484              
2485             The 0th entry of the PADLIST is a PADNAMELIST (which is actually just an
2486             AV, but that may change) which represents the "names" or rather
2487             the "static type information" for lexicals. The individual elements of a
2488             PADNAMELIST are PADNAMEs (just SVs; but, again, that may change). Future
2489             refactorings might stop the PADNAMELIST from being stored in the PADLIST\'s
2490             array, so don\'t rely on it. See L.
2491              
2492             The CvDEPTH\'th entry of a PADLIST is a PAD (an AV) which is the stack frame
2493             at that depth of recursion into the CV. The 0th slot of a frame AV is an
2494             AV which is @_. Other entries are storage for variables and op targets.
2495              
2496             Iterating over the PADNAMELIST iterates over all possible pad
2497             items. Pad slots for targets (SVs_PADTMP) and GVs end up having &PL_sv_no
2498             "names", while slots for constants have &PL_sv_no "names" (see
2499             pad_alloc()). That &PL_sv_no is used is an implementation detail subject
2500             to change. To test for it, use C.
2501              
2502             Only my/our variable (SvPADMY/PADNAME_isOUR) slots get valid names.
2503             The rest are op targets/GVs/constants which are statically allocated
2504             or resolved at compile time. These don\'t have names by which they
2505             can be looked up from Perl code at run time through eval"" the way
2506             my/our variables can be. Since they can\'t be looked up by "name"
2507             but only by their index allocated at compile time (which is usually
2508             in PL_op->op_targ), wasting a name SV for them doesn\'t make sense.
2509              
2510             The SVs in the names AV have their PV being the name of the variable.
2511             xlow+1..xhigh inclusive in the NV union is a range of cop_seq numbers for
2512             which the name is valid (accessed through the macros COP_SEQ_RANGE_LOW and
2513             _HIGH). During compilation, these fields may hold the special value
2514             PERL_PADSEQ_INTRO to indicate various stages:
2515              
2516             COP_SEQ_RANGE_LOW _HIGH
2517             ----------------- -----
2518             PERL_PADSEQ_INTRO 0 variable not yet introduced: { my ($x
2519             valid-seq# PERL_PADSEQ_INTRO variable in scope: { my ($x)
2520             valid-seq# valid-seq# compilation of scope complete: { my ($x) }
2521              
2522             For typed lexicals name SV is SVt_PVMG and SvSTASH
2523             points at the type. For C lexicals, the type is also SVt_PVMG, with the
2524             SvOURSTASH slot pointing at the stash of the associated global (so that
2525             duplicate C declarations in the same package can be detected). SvUVX is
2526             sometimes hijacked to store the generation number during compilation.
2527              
2528             If PADNAME_OUTER (SvFAKE) is set on the
2529             name SV, then that slot in the frame AV is
2530             a REFCNT\'ed reference to a lexical from "outside". In this case,
2531             the name SV does not use xlow and xhigh to store a cop_seq range, since it is
2532             in scope throughout. Instead xhigh stores some flags containing info about
2533             the real lexical (is it declared in an anon, and is it capable of being
2534             instantiated multiple times?), and for fake ANONs, xlow contains the index
2535             within the parent\'s pad where the lexical\'s value is stored, to make
2536             cloning quicker.
2537              
2538             If the \'name\' is \'&\' the corresponding entry in the PAD
2539             is a CV representing a possible closure.
2540             (PADNAME_OUTER and name of \'&\' is not a
2541             meaningful combination currently but could
2542             become so if C is implemented.)
2543              
2544             Note that formats are treated as anon subs, and are cloned each time
2545             write is called (if necessary).
2546              
2547             The flag SVs_PADSTALE is cleared on lexicals each time the my() is executed,
2548             and set on scope exit. This allows the
2549             \'Variable $x is not available\' warning
2550             to be generated in evals, such as
2551              
2552             { my $x = 1; sub f { eval \'$x\'} } f();
2553              
2554             For state vars, SVs_PADSTALE is overloaded to mean \'not yet initialised\'.
2555              
2556             PADLIST * CvPADLIST(CV *cv)','name' => 'CvPADLIST'},'SVt_PVGV' => {'text' => 'Type flag for typeglobs. See L.','name' => 'SVt_PVGV'},'HvNAMEUTF8' => {'text' => 'Returns true if the name is in UTF8 encoding.
2557              
2558             unsigned char HvNAMEUTF8(HV *stash)','name' => 'HvNAMEUTF8'},'sv_catpvf_mg_nocontext' => {'text' => '','name' => 'sv_catpvf_mg_nocontext'},'reg_named_buff_all' => {'text' => '','name' => 'reg_named_buff_all'},'PerlIO_close' => {'text' => '','name' => 'PerlIO_close'},'EXTEND' => {'text' => 'Used to extend the argument stack for an XSUB\'s return values. Once
2559             used, guarantees that there is room for at least C to be pushed
2560             onto the stack.
2561              
2562             void EXTEND(SP, SSize_t nitems)','name' => 'EXTEND'},'newOP' => {'text' => 'Constructs, checks, and returns an op of any base type (any type that
2563             has no extra fields). I is the opcode. I gives the
2564             eight bits of C, and, shifted up eight bits, the eight bits
2565             of C.
2566              
2567             OP * newOP(I32 type, I32 flags)','name' => 'newOP'},'newSVuv' => {'text' => 'Creates a new SV and copies an unsigned integer into it.
2568             The reference count for the SV is set to 1.
2569              
2570             SV* newSVuv(const UV u)','name' => 'newSVuv'},'gv_fetchmeth' => {'text' => 'Like L, but lacks a flags parameter.
2571              
2572             GV* gv_fetchmeth(HV* stash, const char* name,
2573             STRLEN len, I32 level)','name' => 'gv_fetchmeth'},'op_refcnt_lock' => {'text' => '','name' => 'op_refcnt_lock'},'gv_fetchmeth_pvn_autoload' => {'text' => 'Same as gv_fetchmeth_pvn(), but looks for autoloaded subroutines too.
2574             Returns a glob for the subroutine.
2575              
2576             For an autoloaded subroutine without a GV, will create a GV even
2577             if C. For an autoloaded subroutine without a stub, GvCV()
2578             of the result may be zero.
2579              
2580             Currently, the only significant value for C is SVf_UTF8.
2581              
2582             GV* gv_fetchmeth_pvn_autoload(HV* stash,
2583             const char* name,
2584             STRLEN len, I32 level,
2585             U32 flags)','name' => 'gv_fetchmeth_pvn_autoload'},'newGVgen' => {'text' => '','name' => 'newGVgen'},'sv_does' => {'text' => 'Like L, but doesn\'t take a C parameter.
2586              
2587             bool sv_does(SV* sv, const char *const name)','name' => 'sv_does'},'delimcpy' => {'text' => '','name' => 'delimcpy'},'newLOOPOP' => {'text' => 'Constructs, checks, and returns an op tree expressing a loop. This is
2588             only a loop in the control flow through the op tree; it does not have
2589             the heavyweight loop structure that allows exiting the loop by C
2590             and suchlike. I gives the eight bits of C for the
2591             top-level op, except that some bits will be set automatically as required.
2592             I supplies the expression controlling loop iteration, and I
2593             supplies the body of the loop; they are consumed by this function and
2594             become part of the constructed op tree. I is currently
2595             unused and should always be 1.
2596              
2597             OP * newLOOPOP(I32 flags, I32 debuggable, OP *expr,
2598             OP *block)','name' => 'newLOOPOP'},'reg_named_buff_firstkey' => {'text' => '','name' => 'reg_named_buff_firstkey'},'free_global_struct' => {'text' => '','name' => 'free_global_struct'},'uvuni_to_utf8' => {'text' => '','name' => 'uvuni_to_utf8'},'SvLEN' => {'text' => 'Returns the size of the string buffer in the SV, not including any part
2599             attributable to C. See C.
2600              
2601             STRLEN SvLEN(SV* sv)','name' => 'SvLEN'},'PerlIO_tell' => {'text' => '','name' => 'PerlIO_tell'},'SvPOK_only_UTF8' => {'text' => 'Tells an SV that it is a string and disables all other OK bits,
2602             and leaves the UTF-8 status as it was.
2603              
2604             void SvPOK_only_UTF8(SV* sv)','name' => 'SvPOK_only_UTF8'},'mg_get' => {'text' => 'Do magic before a value is retrieved from the SV. The type of SV must
2605             be >= SVt_PVMG. See C.
2606              
2607             int mg_get(SV* sv)','name' => 'mg_get'},'SvTRUE' => {'text' => 'Returns a boolean indicating whether Perl would evaluate the SV as true or
2608             false. See SvOK() for a defined/undefined test. Handles \'get\' magic
2609             unless the scalar is already SvPOK, SvIOK or SvNOK (the public, not the
2610             private flags).
2611              
2612             bool SvTRUE(SV* sv)','name' => 'SvTRUE'},'regdump' => {'text' => '','name' => 'regdump'},'my_pclose' => {'text' => '','name' => 'my_pclose'},'hv_iternext_flags' => {'text' => 'NOTE: this function is experimental and may change or be
2613             removed without notice.
2614              
2615              
2616             Returns entries from a hash iterator. See C and C.
2617             The C value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
2618             set the placeholders keys (for restricted hashes) will be returned in addition
2619             to normal keys. By default placeholders are automatically skipped over.
2620             Currently a placeholder is implemented with a value that is
2621             C<&PL_sv_placeholder>. Note that the implementation of placeholders and
2622             restricted hashes may change, and the implementation currently is
2623             insufficiently abstracted for any change to be tidy.
2624              
2625             HE* hv_iternext_flags(HV *hv, I32 flags)','name' => 'hv_iternext_flags'},'is_utf8_string_loclen' => {'text' => 'Like L() but stores the location of the failure (in the
2626             case of "utf8ness failure") or the location C+C (in the case of
2627             "utf8ness success") in the C, and the number of UTF-8
2628             encoded characters in the C.
2629              
2630             See also L() and L().
2631              
2632             bool is_utf8_string_loclen(const U8 *s, STRLEN len,
2633             const U8 **ep, STRLEN *el)','name' => 'is_utf8_string_loclen'},'BhkENABLE' => {'text' => 'NOTE: this function is experimental and may change or be
2634             removed without notice.
2635              
2636              
2637             Re-enable an entry in this BHK structure, by setting the appropriate
2638             flag. I is a preprocessor token indicating which entry to enable.
2639             This will assert (under -DDEBUGGING) if the entry doesn\'t contain a valid
2640             pointer.
2641              
2642             void BhkENABLE(BHK *hk, which)','name' => 'BhkENABLE'},'call_method' => {'text' => 'Performs a callback to the specified Perl method. The blessed object must
2643             be on the stack. See L.
2644              
2645             NOTE: the perl_ form of this function is deprecated.
2646              
2647             I32 call_method(const char* methname, I32 flags)','name' => 'call_method'},'sys_init' => {'text' => '','name' => 'sys_init'},'perl_parse' => {'text' => 'Tells a Perl interpreter to parse a Perl script. See L.
2648              
2649             int perl_parse(PerlInterpreter *my_perl,
2650             XSINIT_t xsinit, int argc,
2651             char** argv, char** env)','name' => 'perl_parse'},'av_clear' => {'text' => 'Clears an array, making it empty. Does not free the memory the av uses to
2652             store its list of scalars. If any destructors are triggered as a result,
2653             the av itself may be freed when this function returns.
2654              
2655             Perl equivalent: C<@myarray = ();>.
2656              
2657             void av_clear(AV *av)','name' => 'av_clear'},'sv_force_normal' => {'text' => 'Undo various types of fakery on an SV: if the PV is a shared string, make
2658             a private copy; if we\'re a ref, stop refing; if we\'re a glob, downgrade to
2659             an xpvmg. See also C.
2660              
2661             void sv_force_normal(SV *sv)','name' => 'sv_force_normal'},'av_unshift' => {'text' => 'Unshift the given number of C values onto the beginning of the
2662             array. The array will grow automatically to accommodate the addition. You
2663             must then use C to assign values to these new elements.
2664              
2665             Perl equivalent: C
2666              
2667             void av_unshift(AV *av, SSize_t num)','name' => 'av_unshift'},'save_set_svflags' => {'text' => '','name' => 'save_set_svflags'},'SvREFCNT_inc_NN' => {'text' => 'Same as SvREFCNT_inc, but can only be used if you know I
2668             is not NULL. Since we don\'t have to check the NULLness, it\'s faster
2669             and smaller.
2670              
2671             SV* SvREFCNT_inc_NN(SV* sv)','name' => 'SvREFCNT_inc_NN'},'sys_term' => {'text' => '','name' => 'sys_term'},'re_intuit_start' => {'text' => '','name' => 're_intuit_start'},'SvUVX' => {'text' => 'Returns the raw value in the SV\'s UV slot, without checks or conversions.
2672             Only use when you are sure SvIOK is true. See also C.
2673              
2674             UV SvUVX(SV* sv)','name' => 'SvUVX'},'hv_copy_hints_hv' => {'text' => 'A specialised version of L for copying C<%^H>. I must be
2675             a pointer to a hash (which may have C<%^H> magic, but should be generally
2676             non-magical), or C (interpreted as an empty hash). The content
2677             of I is copied to a new hash, which has the C<%^H>-specific magic
2678             added to it. A pointer to the new hash is returned.
2679              
2680             HV * hv_copy_hints_hv(HV *ohv)','name' => 'hv_copy_hints_hv'},'do_pmop_dump' => {'text' => '','name' => 'do_pmop_dump'},'sv_utf8_decode' => {'text' => 'NOTE: this function is experimental and may change or be
2681             removed without notice.
2682              
2683              
2684             If the PV of the SV is an octet sequence in UTF-8
2685             and contains a multiple-byte character, the C flag is turned on
2686             so that it looks like a character. If the PV contains only single-byte
2687             characters, the C flag stays off.
2688             Scans PV for validity and returns false if the PV is invalid UTF-8.
2689              
2690             bool sv_utf8_decode(SV *const sv)','name' => 'sv_utf8_decode'},'op_refcnt_unlock' => {'text' => '','name' => 'op_refcnt_unlock'},'hv_stores' => {'text' => 'Like C, but takes a literal string instead of a string/length pair
2691             and omits the hash parameter.
2692              
2693             SV** hv_stores(HV* tb, const char* key,
2694             NULLOK SV* val)','name' => 'hv_stores'},'SvNV_nomg' => {'text' => 'Like C but doesn\'t process magic.
2695              
2696             NV SvNV_nomg(SV* sv)','name' => 'SvNV_nomg'},'eval_sv' => {'text' => 'Tells Perl to C the string in the SV. It supports the same flags
2697             as C, with the obvious exception of G_EVAL. See L.
2698              
2699             NOTE: the perl_ form of this function is deprecated.
2700              
2701             I32 eval_sv(SV* sv, I32 flags)','name' => 'eval_sv'},'FREETMPS' => {'text' => 'Closing bracket for temporaries on a callback. See C and
2702             L.
2703              
2704             FREETMPS;','name' => 'FREETMPS'},'sv_utf8_upgrade_nomg' => {'text' => 'Like sv_utf8_upgrade, but doesn\'t do magic on C.
2705              
2706             STRLEN sv_utf8_upgrade_nomg(SV *sv)','name' => 'sv_utf8_upgrade_nomg'},'sv_pvn_force' => {'text' => 'Get a sensible string out of the SV somehow.
2707             A private implementation of the C macro for compilers which
2708             can\'t cope with complex macro expressions. Always use the macro instead.
2709              
2710             char* sv_pvn_force(SV* sv, STRLEN* lp)','name' => 'sv_pvn_force'},'GIMME' => {'text' => 'A backward-compatible version of C which can only return
2711             C or C; in a void context, it returns C.
2712             Deprecated. Use C instead.
2713              
2714             U32 GIMME','name' => 'GIMME'},'SvIOK_UV' => {'text' => 'Returns a boolean indicating whether the SV contains an integer that must be
2715             interpreted as unsigned. A non-negative integer whose value is within the
2716             range of both an IV and a UV may be be flagged as either SvUOK or SVIOK.
2717              
2718             bool SvIOK_UV(SV* sv)','name' => 'SvIOK_UV'},'my_snprintf' => {'text' => 'The C library C functionality, if available and
2719             standards-compliant (uses C, actually). However, if the
2720             C is not available, will unfortunately use the unsafe
2721             C which can overrun the buffer (there is an overrun check,
2722             but that may be too late). Consider using C instead, or
2723             getting C.
2724              
2725             int my_snprintf(char *buffer, const Size_t len,
2726             const char *format, ...)','name' => 'my_snprintf'},'newLOGOP' => {'text' => 'Constructs, checks, and returns a logical (flow control) op. I
2727             is the opcode. I gives the eight bits of C, except
2728             that C will be set automatically, and, shifted up eight bits,
2729             the eight bits of C, except that the bit with value 1 is
2730             automatically set. I supplies the expression controlling the
2731             flow, and I supplies the side (alternate) chain of ops; they are
2732             consumed by this function and become part of the constructed op tree.
2733              
2734             OP * newLOGOP(I32 type, I32 flags, OP *first,
2735             OP *other)','name' => 'newLOGOP'},'gp_ref' => {'text' => '','name' => 'gp_ref'},'save_op' => {'text' => '','name' => 'save_op'},'perl_construct' => {'text' => 'Initializes a new Perl interpreter. See L.
2736              
2737             void perl_construct(PerlInterpreter *my_perl)','name' => 'perl_construct'},'SvUOK' => {'text' => 'Returns a boolean indicating whether the SV contains an integer that must be
2738             interpreted as unsigned. A non-negative integer whose value is within the
2739             range of both an IV and a UV may be be flagged as either SvUOK or SVIOK.
2740              
2741             bool SvUOK(SV* sv)','name' => 'SvUOK'},'newWHENOP' => {'text' => 'Constructs, checks, and returns an op tree expressing a C block.
2742             I supplies the test expression, and I supplies the block
2743             that will be executed if the test evaluates to true; they are consumed
2744             by this function and become part of the constructed op tree. I
2745             will be interpreted DWIMically, often as a comparison against C<$_>,
2746             and may be null to generate a C block.
2747              
2748             OP * newWHENOP(OP *cond, OP *block)','name' => 'newWHENOP'},'sv_dec' => {'text' => 'Auto-decrement of the value in the SV, doing string to numeric conversion
2749             if necessary. Handles \'get\' magic and operator overloading.
2750              
2751             void sv_dec(SV *const sv)','name' => 'sv_dec'},'pv_display' => {'text' => 'Similar to
2752              
2753             pv_escape(dsv,pv,cur,pvlim,PERL_PV_ESCAPE_QUOTE);
2754              
2755             except that an additional "\\0" will be appended to the string when
2756             len > cur and pv[cur] is "\\0".
2757              
2758             Note that the final string may be up to 7 chars longer than pvlim.
2759              
2760             char* pv_display(SV *dsv, const char *pv, STRLEN cur,
2761             STRLEN len, STRLEN pvlim)','name' => 'pv_display'},'newHVREF' => {'text' => '','name' => 'newHVREF'},'sv_2pvbyte_nolen' => {'text' => 'Return a pointer to the byte-encoded representation of the SV.
2762             May cause the SV to be downgraded from UTF-8 as a side-effect.
2763              
2764             Usually accessed via the C macro.
2765              
2766             char* sv_2pvbyte_nolen(SV* sv)','name' => 'sv_2pvbyte_nolen'},'PadlistMAX' => {'text' => 'NOTE: this function is experimental and may change or be
2767             removed without notice.
2768              
2769              
2770             The index of the last allocated space in the padlist. Note that the last
2771             pad may be in an earlier slot. Any entries following it will be NULL in
2772             that case.
2773              
2774             SSize_t PadlistMAX(PADLIST padlist)','name' => 'PadlistMAX'},'PerlIO_fileno' => {'text' => '','name' => 'PerlIO_fileno'},'uvchr_to_utf8' => {'text' => 'Adds the UTF-8 representation of the native code point C to the end
2775             of the string C; C should have at least C (up to
2776             C) free bytes available. The return value is the pointer to
2777             the byte after the end of the new character. In other words,
2778              
2779             d = uvchr_to_utf8(d, uv);
2780              
2781             is the recommended wide native character-aware way of saying
2782              
2783             *(d++) = uv;
2784              
2785             This function accepts any UV as input. To forbid or warn on non-Unicode code
2786             points, or those that may be problematic, see L.
2787              
2788             U8* uvchr_to_utf8(U8 *d, UV uv)','name' => 'uvchr_to_utf8'},'isDIGIT' => {'text' => 'Returns a boolean indicating whether the specified character is a
2789             digit, analogous to C.
2790             Variants C and C are identical to C.
2791             See the L for an explanation of variants
2792             C, C, C, C, and
2793             C.
2794              
2795             bool isDIGIT(char ch)','name' => 'isDIGIT'},'call_atexit' => {'text' => '','name' => 'call_atexit'},'my_bzero' => {'text' => '','name' => 'my_bzero'},'newCONSTSUB' => {'text' => 'See L.
2796              
2797             CV* newCONSTSUB(HV* stash, const char* name, SV* sv)','name' => 'newCONSTSUB'},'SvSHARE' => {'text' => 'Arranges for sv to be shared between threads if a suitable module
2798             has been loaded.
2799              
2800             void SvSHARE(SV* sv)','name' => 'SvSHARE'},'vwarner' => {'text' => '','name' => 'vwarner'},'sortsv' => {'text' => 'Sort an array. Here is an example:
2801              
2802             sortsv(AvARRAY(av), av_top_index(av)+1, Perl_sv_cmp_locale);
2803              
2804             Currently this always uses mergesort. See sortsv_flags for a more
2805             flexible routine.
2806              
2807             void sortsv(SV** array, size_t num_elts,
2808             SVCOMPARE_t cmp)','name' => 'sortsv'},'av_tindex' => {'text' => 'Same as C.
2809              
2810             int av_tindex(AV* av)','name' => 'av_tindex'},'cophh_store_pvs' => {'text' => 'NOTE: this function is experimental and may change or be
2811             removed without notice.
2812              
2813              
2814             Like L, but takes a literal string instead of a
2815             string/length pair, and no precomputed hash.
2816              
2817             COPHH * cophh_store_pvs(const COPHH *cophh,
2818             const char *key, SV *value,
2819             U32 flags)','name' => 'cophh_store_pvs'},'sys_intern_clear' => {'text' => '','name' => 'sys_intern_clear'},'doref' => {'text' => '','name' => 'doref'},'scan_bin' => {'text' => 'For backwards compatibility. Use C instead.
2820              
2821             NV scan_bin(const char* start, STRLEN len,
2822             STRLEN* retlen)','name' => 'scan_bin'},'Nullcv' => {'text' => 'Null CV pointer.
2823              
2824             (deprecated - use C<(CV *)NULL> instead)','name' => 'Nullcv'},'PadlistREFCNT' => {'text' => 'NOTE: this function is experimental and may change or be
2825             removed without notice.
2826              
2827              
2828             The reference count of the padlist. Currently this is always 1.
2829              
2830             U32 PadlistREFCNT(PADLIST padlist)','name' => 'PadlistREFCNT'},'sv_catpvs_nomg' => {'text' => 'Like C, but takes a literal string instead of a
2831             string/length pair.
2832              
2833             void sv_catpvs_nomg(SV* sv, const char* s)','name' => 'sv_catpvs_nomg'},'lex_bufutf8' => {'text' => 'NOTE: this function is experimental and may change or be
2834             removed without notice.
2835              
2836              
2837             Indicates whether the octets in the lexer buffer
2838             (Llinestr>) should be interpreted as the UTF-8 encoding
2839             of Unicode characters. If not, they should be interpreted as Latin-1
2840             characters. This is analogous to the C flag for scalars.
2841              
2842             In UTF-8 mode, it is not guaranteed that the lexer buffer actually
2843             contains valid UTF-8. Lexing code must be robust in the face of invalid
2844             encoding.
2845              
2846             The actual C flag of the Llinestr> scalar
2847             is significant, but not the whole story regarding the input character
2848             encoding. Normally, when a file is being read, the scalar contains octets
2849             and its C flag is off, but the octets should be interpreted as
2850             UTF-8 if the C pragma is in effect. During a string eval,
2851             however, the scalar may have the C flag on, and in this case its
2852             octets should be interpreted as UTF-8 unless the C pragma
2853             is in effect. This logic may change in the future; use this function
2854             instead of implementing the logic yourself.
2855              
2856             bool lex_bufutf8()','name' => 'lex_bufutf8'},'MULTICALL' => {'text' => 'Make a lightweight callback. See L.
2857              
2858             MULTICALL;','name' => 'MULTICALL'},'debprofdump' => {'text' => '','name' => 'debprofdump'},'SvPVbyte' => {'text' => 'Like C, but converts sv to byte representation first if necessary.
2859              
2860             char* SvPVbyte(SV* sv, STRLEN len)','name' => 'SvPVbyte'},'savesharedpvs' => {'text' => 'A version of C which allocates the duplicate string in memory
2861             which is shared between threads.
2862              
2863             char* savesharedpvs(const char* s)','name' => 'savesharedpvs'},'sys_init3' => {'text' => '','name' => 'sys_init3'},'gv_fetchmeth_pv' => {'text' => 'Exactly like L, but takes a nul-terminated string
2864             instead of a string/length pair.
2865              
2866             GV* gv_fetchmeth_pv(HV* stash, const char* name,
2867             I32 level, U32 flags)','name' => 'gv_fetchmeth_pv'},'PerlIO_stdout' => {'text' => '','name' => 'PerlIO_stdout'},'XS_INTERNAL' => {'text' => 'Macro to declare an XSUB and its C parameter list without exporting the symbols.
2868             This is handled by C and generally preferable over exporting the XSUB
2869             symbols unnecessarily.','name' => 'XS_INTERNAL'},'SAVETMPS' => {'text' => 'Opening bracket for temporaries on a callback. See C and
2870             L.
2871              
2872             SAVETMPS;','name' => 'SAVETMPS'},'AvFILL' => {'text' => 'Same as C. Deprecated, use C instead.
2873              
2874             int AvFILL(AV* av)','name' => 'AvFILL'},'SvPVutf8x' => {'text' => 'Like C, but converts sv to utf8 first if necessary.
2875             Guarantees to evaluate sv only once; use the more efficient C
2876             otherwise.
2877              
2878             char* SvPVutf8x(SV* sv, STRLEN len)','name' => 'SvPVutf8x'},'ORIGMARK' => {'text' => 'The original stack mark for the XSUB. See C.','name' => 'ORIGMARK'},'sv_2cv' => {'text' => 'Using various gambits, try to get a CV from an SV; in addition, try if
2879             possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
2880             The flags in C are passed to gv_fetchsv.
2881              
2882             CV* sv_2cv(SV* sv, HV **const st, GV **const gvp,
2883             const I32 lref)','name' => 'sv_2cv'},'gp_free' => {'text' => '','name' => 'gp_free'},'SvPV_force_nomg' => {'text' => 'Like C, but doesn\'t process get magic.
2884              
2885             char* SvPV_force_nomg(SV* sv, STRLEN len)','name' => 'SvPV_force_nomg'},'SvPOK_only' => {'text' => 'Tells an SV that it is a string and disables all other OK bits.
2886             Will also turn off the UTF-8 status.
2887              
2888             void SvPOK_only(SV* sv)','name' => 'SvPOK_only'},'save_destructor_x' => {'text' => '','name' => 'save_destructor_x'},'sv_usepvn_mg' => {'text' => 'Like C, but also handles \'set\' magic.
2889              
2890             void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)','name' => 'sv_usepvn_mg'},'hv_fetch' => {'text' => 'Returns the SV which corresponds to the specified key in the hash.
2891             The absolute value of C is the length of the key. If C is
2892             negative the key is assumed to be in UTF-8-encoded Unicode. If
2893             C is set then the fetch will be part of a store. This means that if
2894             there is no value in the hash associated with the given key, then one is
2895             created and a pointer to it is returned. The C it points to can be
2896             assigned to. But always check that the
2897             return value is non-null before dereferencing it to an C.
2898              
2899             See L for more
2900             information on how to use this function on tied hashes.
2901              
2902             SV** hv_fetch(HV *hv, const char *key, I32 klen,
2903             I32 lval)','name' => 'hv_fetch'},'sv_pvbyte' => {'text' => 'Use C instead.
2904              
2905             char* sv_pvbyte(SV *sv)','name' => 'sv_pvbyte'},'XCPT_TRY_START' => {'text' => 'Starts a try block. See L.','name' => 'XCPT_TRY_START'},'sv_unref_flags' => {'text' => 'Unsets the RV status of the SV, and decrements the reference count of
2906             whatever was being referenced by the RV. This can almost be thought of
2907             as a reversal of C. The C argument can contain
2908             C to force the reference count to be decremented
2909             (otherwise the decrementing is conditional on the reference count being
2910             different from one or the reference being a readonly SV).
2911             See C.
2912              
2913             void sv_unref_flags(SV *const ref, const U32 flags)','name' => 'sv_unref_flags'},'isPSXSPC' => {'text' => '(short for Posix Space)
2914             Starting in 5.18, this is identical (experimentally) in all its forms to the
2915             corresponding C macros. ("Experimentally" means that this change
2916             may be backed out in 5.22 if field experience indicates that it
2917             was unwise.)
2918             The locale forms of this macro are identical to their corresponding
2919             C forms in all Perl releases. In releases prior to 5.18, the
2920             non-locale forms differ from their C forms only in that the
2921             C forms don\'t match a Vertical Tab, and the C forms do.
2922             Otherwise they are identical. Thus this macro is analogous to what
2923             C matches in a regular expression.
2924             See the L for an explanation of variants
2925             C, C, C, C, C,
2926             C, and C.
2927              
2928             bool isPSXSPC(char ch)','name' => 'isPSXSPC'},'SvRV' => {'text' => 'Dereferences an RV to return the SV.
2929              
2930             SV* SvRV(SV* sv)','name' => 'SvRV'},'hv_scalar' => {'text' => 'Evaluates the hash in scalar context and returns the result. Handles magic
2931             when the hash is tied.
2932              
2933             SV* hv_scalar(HV *hv)','name' => 'hv_scalar'},'mg_copy' => {'text' => 'Copies the magic from one SV to another. See C.
2934              
2935             int mg_copy(SV *sv, SV *nsv, const char *key,
2936             I32 klen)','name' => 'mg_copy'},'save_I16' => {'text' => '','name' => 'save_I16'},'sv_rvweaken' => {'text' => 'Weaken a reference: set the C flag on this RV; give the
2937             referred-to SV C magic if it hasn\'t already; and
2938             push a back-reference to this RV onto the array of backreferences
2939             associated with that magic. If the RV is magical, set magic will be
2940             called after the RV is cleared.
2941              
2942             SV* sv_rvweaken(SV *const sv)','name' => 'sv_rvweaken'},'grok_oct' => {'text' => 'converts a string representing an octal number to numeric form.
2943              
2944             On entry I and I<*len> give the string to scan, I<*flags> gives
2945             conversion flags, and I should be NULL or a pointer to an NV.
2946             The scan stops at the end of the string, or the first invalid character.
2947             Unless C is set in I<*flags>, encountering an
2948             8 or 9 will also trigger a warning.
2949             On return I<*len> is set to the length of the scanned string,
2950             and I<*flags> gives output flags.
2951              
2952             If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2953             and nothing is written to I<*result>. If the value is > UV_MAX C
2954             returns UV_MAX, sets C in the output flags,
2955             and writes the value to I<*result> (or the value is discarded if I
2956             is NULL).
2957              
2958             If C is set in I<*flags> then the octal
2959             number may use \'_\' characters to separate digits.
2960              
2961             UV grok_oct(const char* start, STRLEN* len_p,
2962             I32* flags, NV *result)','name' => 'grok_oct'},'MARK' => {'text' => 'Stack marker variable for the XSUB. See C.','name' => 'MARK'},'newSVpvn' => {'text' => 'Creates a new SV and copies a string into it, which may contain C characters
2963             (C<\\0>) and other binary data. The reference count for the SV is set to 1.
2964             Note that if C is zero, Perl will create a zero length (Perl) string. You
2965             are responsible for ensuring that the source buffer is at least
2966             C bytes long. If the C argument is NULL the new SV will be
2967             undefined.
2968              
2969             SV* newSVpvn(const char *const s, const STRLEN len)','name' => 'newSVpvn'},'scan_hex' => {'text' => 'For backwards compatibility. Use C instead.
2970              
2971             NV scan_hex(const char* start, STRLEN len,
2972             STRLEN* retlen)','name' => 'scan_hex'},'unpackstring' => {'text' => 'The engine implementing the unpack() Perl function.
2973              
2974             Using the template pat..patend, this function unpacks the string
2975             s..strend into a number of mortal SVs, which it pushes onto the perl
2976             argument (@_) stack (so you will need to issue a C before and
2977             C after the call to this function). It returns the number of
2978             pushed elements.
2979              
2980             The strend and patend pointers should point to the byte following the last
2981             character of each string.
2982              
2983             Although this function returns its values on the perl argument stack, it
2984             doesn\'t take any parameters from that stack (and thus in particular
2985             there\'s no need to do a PUSHMARK before calling it, unlike L for
2986             example).
2987              
2988             I32 unpackstring(const char *pat,
2989             const char *patend, const char *s,
2990             const char *strend, U32 flags)','name' => 'unpackstring'},'av_extend' => {'text' => 'Pre-extend an array. The C is the index to which the array should be
2991             extended.
2992              
2993             void av_extend(AV *av, SSize_t key)','name' => 'av_extend'},'sv_peek' => {'text' => '','name' => 'sv_peek'},'SVt_REGEXP' => {'text' => 'Type flag for regular expressions. See L.','name' => 'SVt_REGEXP'},'hv_iternext' => {'text' => 'Returns entries from a hash iterator. See C.
2994              
2995             You may call C or C on the hash entry that the
2996             iterator currently points to, without losing your place or invalidating your
2997             iterator. Note that in this case the current entry is deleted from the hash
2998             with your iterator holding the last reference to it. Your iterator is flagged
2999             to free the entry on the next call to C, so you must not discard
3000             your iterator immediately else the entry will leak - call C to
3001             trigger the resource deallocation.
3002              
3003             HE* hv_iternext(HV *hv)','name' => 'hv_iternext'},'hv_store_ent' => {'text' => 'Stores C in a hash. The hash key is specified as C. The C
3004             parameter is the precomputed hash value; if it is zero then Perl will
3005             compute it. The return value is the new hash entry so created. It will be
3006             NULL if the operation failed or if the value did not need to be actually
3007             stored within the hash (as in the case of tied hashes). Otherwise the
3008             contents of the return value can be accessed using the C macros
3009             described here. Note that the caller is responsible for suitably
3010             incrementing the reference count of C before the call, and
3011             decrementing it if the function returned NULL. Effectively a successful
3012             hv_store_ent takes ownership of one reference to C. This is
3013             usually what you want; a newly created SV has a reference count of one, so
3014             if all your code does is create SVs then store them in a hash, hv_store
3015             will own the only reference to the new SV, and your code doesn\'t need to do
3016             anything further to tidy up. Note that hv_store_ent only reads the C;
3017             unlike C it does not take ownership of it, so maintaining the correct
3018             reference count on C is entirely the caller\'s responsibility. hv_store
3019             is not implemented as a call to hv_store_ent, and does not create a temporary
3020             SV for the key, so if your key data is not already in SV form then use
3021             hv_store in preference to hv_store_ent.
3022              
3023             See L for more
3024             information on how to use this function on tied hashes.
3025              
3026             HE* hv_store_ent(HV *hv, SV *key, SV *val, U32 hash)','name' => 'hv_store_ent'},'hv_eiter_set' => {'text' => '','name' => 'hv_eiter_set'},'gv_stashsv' => {'text' => 'Returns a pointer to the stash for a specified package. See C.
3027              
3028             HV* gv_stashsv(SV* sv, I32 flags)','name' => 'gv_stashsv'},'newXSproto' => {'text' => 'Used by C to hook up XSUBs as Perl subs. Adds Perl prototypes to
3029             the subs.','name' => 'newXSproto'},'form' => {'text' => 'Takes a sprintf-style format pattern and conventional
3030             (non-SV) arguments and returns the formatted string.
3031              
3032             (char *) Perl_form(pTHX_ const char* pat, ...)
3033              
3034             can be used any place a string (char *) is required:
3035              
3036             char * s = Perl_form("%d.%d",major,minor);
3037              
3038             Uses a single private buffer so if you want to format several strings you
3039             must explicitly copy the earlier strings away (and free the copies when you
3040             are done).
3041              
3042             char* form(const char* pat, ...)','name' => 'form'},'instr' => {'text' => '','name' => 'instr'},'pregexec' => {'text' => '','name' => 'pregexec'},'is_utf8_string' => {'text' => 'Returns true if the first C bytes of string C form a valid
3043             UTF-8 string, false otherwise. If C is 0, it will be calculated
3044             using C (which means if you use this option, that C can\'t have
3045             embedded C characters and has to have a terminating C byte). Note
3046             that all characters being ASCII constitute \'a valid UTF-8 string\'.
3047              
3048             See also L(), L(), and L().
3049              
3050             bool is_utf8_string(const U8 *s, STRLEN len)','name' => 'is_utf8_string'},'PadnamelistARRAY' => {'text' => 'NOTE: this function is experimental and may change or be
3051             removed without notice.
3052              
3053              
3054             The C array of pad names.
3055              
3056             PADNAME ** PadnamelistARRAY(PADNAMELIST pnl)','name' => 'PadnamelistARRAY'},'croak_xs_usage' => {'text' => 'A specialised variant of C for emitting the usage message for xsubs
3057              
3058             croak_xs_usage(cv, "eee_yow");
3059              
3060             works out the package name and subroutine name from C, and then calls
3061             C. Hence if C is C<&ouch::awk>, it would call C as:
3062              
3063             Perl_croak(aTHX_ "Usage: %"SVf"::%"SVf"(%s)", "ouch" "awk", "eee_yow");
3064              
3065             void croak_xs_usage(const CV *const cv,
3066             const char *const params)','name' => 'croak_xs_usage'},'sv_insert' => {'text' => 'Inserts a string at the specified offset/length within the SV. Similar to
3067             the Perl substr() function. Handles get magic.
3068              
3069             void sv_insert(SV *const bigstr, const STRLEN offset,
3070             const STRLEN len,
3071             const char *const little,
3072             const STRLEN littlelen)','name' => 'sv_insert'},'SvPOK' => {'text' => 'Returns a U32 value indicating whether the SV contains a character
3073             string.
3074              
3075             U32 SvPOK(SV* sv)','name' => 'SvPOK'},'sv_destroyable' => {'text' => 'Dummy routine which reports that object can be destroyed when there is no
3076             sharing module present. It ignores its single SV argument, and returns
3077             \'true\'. Exists to avoid test for a NULL function pointer and because it
3078             could potentially warn under some level of strict-ness.
3079              
3080             bool sv_destroyable(SV *sv)','name' => 'sv_destroyable'},'save_aelem_flags' => {'text' => '','name' => 'save_aelem_flags'},'PadlistNAMES' => {'text' => 'NOTE: this function is experimental and may change or be
3081             removed without notice.
3082              
3083              
3084             The names associated with pad entries.
3085              
3086             PADNAMELIST * PadlistNAMES(PADLIST padlist)','name' => 'PadlistNAMES'},'XS' => {'text' => 'Macro to declare an XSUB and its C parameter list. This is handled by
3087             C. It is the same as using the more explicit XS_EXTERNAL macro.','name' => 'XS'},'gv_check' => {'text' => '','name' => 'gv_check'},'sv_setpvn' => {'text' => 'Copies a string (possibly containing embedded C characters) into an SV.
3088             The C parameter indicates the number of
3089             bytes to be copied. If the C argument is NULL the SV will become
3090             undefined. Does not handle \'set\' magic. See C.
3091              
3092             void sv_setpvn(SV *const sv, const char *const ptr,
3093             const STRLEN len)','name' => 'sv_setpvn'},'mg_magical' => {'text' => 'Turns on the magical status of an SV. See C.
3094              
3095             void mg_magical(SV* sv)','name' => 'mg_magical'},'op_linklist' => {'text' => 'This function is the implementation of the L macro. It should
3096             not be called directly.
3097              
3098             OP* op_linklist(OP *o)','name' => 'op_linklist'},'newSVrv' => {'text' => 'Creates a new SV for the existing RV, C, to point to. If C is not an
3099             RV then it will be upgraded to one. If C is non-null then the new
3100             SV will be blessed in the specified package. The new SV is returned and its
3101             reference count is 1. The reference count 1 is owned by C.
3102              
3103             SV* newSVrv(SV *const rv,
3104             const char *const classname)','name' => 'newSVrv'},'cast_i32' => {'text' => '','name' => 'cast_i32'},'strnEQ' => {'text' => 'Test two strings to see if they are equal. The C parameter indicates
3105             the number of bytes to compare. Returns true or false. (A wrapper for
3106             C).
3107              
3108             bool strnEQ(char* s1, char* s2, STRLEN len)','name' => 'strnEQ'},'sv_dup_inc' => {'text' => '','name' => 'sv_dup_inc'},'newMYSUB' => {'text' => '','name' => 'newMYSUB'},'PoisonWith' => {'text' => 'Fill up memory with a byte pattern (a byte repeated over and over
3109             again) that hopefully catches attempts to access uninitialized memory.
3110              
3111             void PoisonWith(void* dest, int nitems, type,
3112             U8 byte)','name' => 'PoisonWith'},'av_create_and_unshift_one' => {'text' => 'NOTE: this function is experimental and may change or be
3113             removed without notice.
3114              
3115              
3116             Unshifts an SV onto the beginning of the array, creating the array if
3117             necessary.
3118             A small internal helper function to remove a commonly duplicated idiom.
3119              
3120             SV** av_create_and_unshift_one(AV **const avp,
3121             SV *const val)','name' => 'av_create_and_unshift_one'},'SvNIOK_off' => {'text' => 'Unsets the NV/IV status of an SV.
3122              
3123             void SvNIOK_off(SV* sv)','name' => 'SvNIOK_off'},'bytes_cmp_utf8' => {'text' => 'Compares the sequence of characters (stored as octets) in C, C with the
3124             sequence of characters (stored as UTF-8)
3125             in C, C. Returns 0 if they are
3126             equal, -1 or -2 if the first string is less than the second string, +1 or +2
3127             if the first string is greater than the second string.
3128              
3129             -1 or +1 is returned if the shorter string was identical to the start of the
3130             longer string. -2 or +2 is returned if
3131             there was a difference between characters
3132             within the strings.
3133              
3134             int bytes_cmp_utf8(const U8 *b, STRLEN blen,
3135             const U8 *u, STRLEN ulen)','name' => 'bytes_cmp_utf8'},'seed' => {'text' => '','name' => 'seed'},'pad_findmy_pvs' => {'text' => 'Exactly like L, but takes a literal string instead
3136             of a string/length pair.
3137              
3138             PADOFFSET pad_findmy_pvs(const char *name, U32 flags)','name' => 'pad_findmy_pvs'},'sv_magic' => {'text' => 'Adds magic to an SV. First upgrades C to type C if
3139             necessary, then adds a new magic item of type C to the head of the
3140             magic list.
3141              
3142             See C (which C now calls) for a description of the
3143             handling of the C and C arguments.
3144              
3145             You need to use C to add magic to SvREADONLY SVs and also
3146             to add more than one instance of the same \'how\'.
3147              
3148             void sv_magic(SV *const sv, SV *const obj,
3149             const int how, const char *const name,
3150             const I32 namlen)','name' => 'sv_magic'},'sv_utf8_upgrade_flags' => {'text' => 'Converts the PV of an SV to its UTF-8-encoded form.
3151             Forces the SV to string form if it is not already.
3152             Always sets the SvUTF8 flag to avoid future validity checks even
3153             if all the bytes are invariant in UTF-8.
3154             If C has C bit set,
3155             will C on C if appropriate, else not.
3156              
3157             If C has SV_FORCE_UTF8_UPGRADE set, this function assumes that the PV
3158             will expand when converted to UTF-8, and skips the extra work of checking for
3159             that. Typically this flag is used by a routine that has already parsed the
3160             string and found such characters, and passes this information on so that the
3161             work doesn\'t have to be repeated.
3162              
3163             Returns the number of bytes in the converted string.
3164              
3165             This is not a general purpose byte encoding to Unicode interface:
3166             use the Encode extension for that.
3167              
3168             STRLEN sv_utf8_upgrade_flags(SV *const sv,
3169             const I32 flags)','name' => 'sv_utf8_upgrade_flags'},'do_open9' => {'text' => '','name' => 'do_open9'},'magic_dump' => {'text' => '','name' => 'magic_dump'},'sv_catpvs_mg' => {'text' => 'Like C, but takes a literal string instead of a
3170             string/length pair.
3171              
3172             void sv_catpvs_mg(SV* sv, const char* s)','name' => 'sv_catpvs_mg'},'sv_setpvs_mg' => {'text' => 'Like C, but takes a literal string instead of a
3173             string/length pair.
3174              
3175             void sv_setpvs_mg(SV* sv, const char* s)','name' => 'sv_setpvs_mg'},'gv_fetchfile_flags' => {'text' => '','name' => 'gv_fetchfile_flags'},'SvREFCNT_inc_void' => {'text' => 'Same as SvREFCNT_inc, but can only be used if you don\'t need the
3176             return value. The macro doesn\'t need to return a meaningful value.
3177              
3178             void SvREFCNT_inc_void(SV* sv)','name' => 'SvREFCNT_inc_void'},'leave_scope' => {'text' => '','name' => 'leave_scope'},'newSTATEOP' => {'text' => 'Constructs a state op (COP). The state op is normally a C op,
3179             but will be a C op if debugging is enabled for currently-compiled
3180             code. The state op is populated from C (or C).
3181             If I
3182             the state op; this function takes ownership of the memory pointed at by
3183             I
3184             for the state op.
3185              
3186             If I is null, the state op is returned. Otherwise the state op is
3187             combined with I into a C list op, which is returned. I
3188             is consumed by this function and becomes part of the returned op tree.
3189              
3190             OP * newSTATEOP(I32 flags, char *label, OP *o)','name' => 'newSTATEOP'},'my_fork' => {'text' => '','name' => 'my_fork'},'isBLANK' => {'text' => 'Returns a boolean indicating whether the specified character is a
3191             character considered to be a blank, analogous to C.
3192             See the L for an explanation of variants
3193             C, C, C, C, C,
3194             C, and C. Note, however, that some
3195             platforms do not have the C library routine C. In these cases, the
3196             variants whose names contain C are the same as the corresponding ones
3197             without.
3198              
3199             bool isBLANK(char ch)','name' => 'isBLANK'},'SvROK' => {'text' => 'Tests if the SV is an RV.
3200              
3201             U32 SvROK(SV* sv)','name' => 'SvROK'},'sv_unref' => {'text' => 'Unsets the RV status of the SV, and decrements the reference count of
3202             whatever was being referenced by the RV. This can almost be thought of
3203             as a reversal of C. This is C with the C
3204             being zero. See C.
3205              
3206             void sv_unref(SV* sv)','name' => 'sv_unref'},'moreswitches' => {'text' => '','name' => 'moreswitches'},'cophh_fetch_pvs' => {'text' => 'NOTE: this function is experimental and may change or be
3207             removed without notice.
3208              
3209              
3210             Like L, but takes a literal string instead of a
3211             string/length pair, and no precomputed hash.
3212              
3213             SV * cophh_fetch_pvs(const COPHH *cophh,
3214             const char *key, U32 flags)','name' => 'cophh_fetch_pvs'},'ptr_table_fetch' => {'text' => '','name' => 'ptr_table_fetch'},'save_nogv' => {'text' => '','name' => 'save_nogv'},'sv_setnv' => {'text' => 'Copies a double into the given SV, upgrading first if necessary.
3215             Does not handle \'set\' magic. See also C.
3216              
3217             void sv_setnv(SV *const sv, const NV num)','name' => 'sv_setnv'},'SvREFCNT_inc_simple_NN' => {'text' => 'Same as SvREFCNT_inc_simple, but can only be used if you know I
3218             is not NULL. Since we don\'t have to check the NULLness, it\'s faster
3219             and smaller.
3220              
3221             SV* SvREFCNT_inc_simple_NN(SV* sv)','name' => 'SvREFCNT_inc_simple_NN'},'toTITLE_utf8' => {'text' => 'Converts the UTF-8 encoded character at C

to its titlecase version, and

3222             stores that in UTF-8 in C, and its length in bytes in C. Note
3223             that the buffer pointed to by C needs to be at least C
3224             bytes since the titlecase version may be longer than the original character.
3225              
3226             The first code point of the titlecased version is returned
3227             (but note, as explained just above, that there may be more.)
3228              
3229             The input character at C

is assumed to be well-formed.

3230              
3231             UV toTITLE_utf8(U8* p, U8* s, STRLEN* lenp)','name' => 'toTITLE_utf8'},'newHV' => {'text' => 'Creates a new HV. The reference count is set to 1.
3232              
3233             HV* newHV()','name' => 'newHV'},'SVt_PVFM' => {'text' => 'Type flag for formats. See L.','name' => 'SVt_PVFM'},'gv_dump' => {'text' => '','name' => 'gv_dump'},'my_strlcpy' => {'text' => 'The C library C if available, or a Perl implementation of it.
3234             This operates on C C-terminated strings.
3235              
3236             C copies up to S> characters from the string C
3237             to C, C-terminating the result if C is not 0.
3238              
3239             Size_t my_strlcpy(char *dst, const char *src,
3240             Size_t size)','name' => 'my_strlcpy'},'strNE' => {'text' => 'Test two strings to see if they are different. Returns true or
3241             false.
3242              
3243             bool strNE(char* s1, char* s2)','name' => 'strNE'},'PerlIO_fill' => {'text' => '','name' => 'PerlIO_fill'},'my_failure_exit' => {'text' => '','name' => 'my_failure_exit'},'caller_cx' => {'text' => 'The XSUB-writer\'s equivalent of L. The
3244             returned C structure can be interrogated to find all the
3245             information returned to Perl by C. Note that XSUBs don\'t get a
3246             stack frame, so C will return information for the
3247             immediately-surrounding Perl code.
3248              
3249             This function skips over the automatic calls to C<&DB::sub> made on the
3250             behalf of the debugger. If the stack frame requested was a sub called by
3251             C, the return value will be the frame for the call to
3252             C, since that has the correct line number/etc. for the call
3253             site. If I is non-C, it will be set to a pointer to the
3254             frame for the sub call itself.
3255              
3256             const PERL_CONTEXT * caller_cx(
3257             I32 level,
3258             const PERL_CONTEXT **dbcxp
3259             )','name' => 'caller_cx'},'cophh_copy' => {'text' => 'NOTE: this function is experimental and may change or be
3260             removed without notice.
3261              
3262              
3263             Make and return a complete copy of the cop hints hash I.
3264              
3265             COPHH * cophh_copy(COPHH *cophh)','name' => 'cophh_copy'},'sv_pvutf8n_force' => {'text' => 'The backend for the C macro. Always use the macro
3266             instead.
3267              
3268             char* sv_pvutf8n_force(SV *const sv, STRLEN *const lp)','name' => 'sv_pvutf8n_force'},'do_sv_dump' => {'text' => '','name' => 'do_sv_dump'},'SvNV_set' => {'text' => 'Set the value of the NV pointer in sv to val. See C.
3269              
3270             void SvNV_set(SV* sv, NV val)','name' => 'SvNV_set'},'die_sv' => {'text' => 'Behaves the same as L, except for the return type.
3271             It should be used only where the C return type is required.
3272             The function never actually returns.
3273              
3274             OP * die_sv(SV *baseex)','name' => 'die_sv'},'newAV' => {'text' => 'Creates a new AV. The reference count is set to 1.
3275              
3276             Perl equivalent: C.
3277              
3278             AV* newAV()','name' => 'newAV'},'bytes_from_utf8' => {'text' => 'NOTE: this function is experimental and may change or be
3279             removed without notice.
3280              
3281              
3282             Converts a string C of length C from UTF-8 into native byte encoding.
3283             Unlike L but like L, returns a pointer to
3284             the newly-created string, and updates C to contain the new
3285             length. Returns the original string if no conversion occurs, C
3286             is unchanged. Do nothing if C points to 0. Sets C to
3287             0 if C is converted or consisted entirely of characters that are invariant
3288             in utf8 (i.e., US-ASCII on non-EBCDIC machines).
3289              
3290             U8* bytes_from_utf8(const U8 *s, STRLEN *len,
3291             bool *is_utf8)','name' => 'bytes_from_utf8'},'croak_memory_wrap' => {'text' => '','name' => 'croak_memory_wrap'},'SvPV_nomg_nolen' => {'text' => 'Like C but doesn\'t process magic.
3292              
3293             char* SvPV_nomg_nolen(SV* sv)','name' => 'SvPV_nomg_nolen'},'dump_sub' => {'text' => '','name' => 'dump_sub'},'vload_module' => {'text' => '','name' => 'vload_module'},'save_adelete' => {'text' => '','name' => 'save_adelete'},'av_make' => {'text' => 'Creates a new AV and populates it with a list of SVs. The SVs are copied
3294             into the array, so they may be freed after the call to av_make. The new AV
3295             will have a reference count of 1.
3296              
3297             Perl equivalent: C
3298              
3299             AV* av_make(SSize_t size, SV **strp)','name' => 'av_make'},'SvUV' => {'text' => 'Coerces the given SV to an unsigned integer and returns it. See C
3300             for a version which guarantees to evaluate sv only once.
3301              
3302             UV SvUV(SV* sv)','name' => 'SvUV'},'hv_name_set' => {'text' => '','name' => 'hv_name_set'},'cophh_store_pvn' => {'text' => 'NOTE: this function is experimental and may change or be
3303             removed without notice.
3304              
3305              
3306             Stores a value, associated with a key, in the cop hints hash I,
3307             and returns the modified hash. The returned hash pointer is in general
3308             not the same as the hash pointer that was passed in. The input hash is
3309             consumed by the function, and the pointer to it must not be subsequently
3310             used. Use L if you need both hashes.
3311              
3312             The key is specified by I and I. If I has the
3313             C bit set, the key octets are interpreted as UTF-8,
3314             otherwise they are interpreted as Latin-1. I is a precomputed
3315             hash of the key string, or zero if it has not been precomputed.
3316              
3317             I is the scalar value to store for this key. I is copied
3318             by this function, which thus does not take ownership of any reference
3319             to it, and later changes to the scalar will not be reflected in the
3320             value visible in the cop hints hash. Complex types of scalar will not
3321             be stored with referential integrity, but will be coerced to strings.
3322              
3323             COPHH * cophh_store_pvn(COPHH *cophh, const char *keypv,
3324             STRLEN keylen, U32 hash,
3325             SV *value, U32 flags)','name' => 'cophh_store_pvn'},'perl_run' => {'text' => 'Tells a Perl interpreter to run. See L.
3326              
3327             int perl_run(PerlInterpreter *my_perl)','name' => 'perl_run'},'mess_nocontext' => {'text' => '','name' => 'mess_nocontext'},'sv_insert_flags' => {'text' => 'Same as C, but the extra C are passed to the
3328             C that applies to C.
3329              
3330             void sv_insert_flags(SV *const bigstr,
3331             const STRLEN offset,
3332             const STRLEN len,
3333             const char *const little,
3334             const STRLEN littlelen,
3335             const U32 flags)','name' => 'sv_insert_flags'},'OP_CLASS' => {'text' => 'Return the class of the provided OP: that is, which of the *OP
3336             structures it uses. For core ops this currently gets the information out
3337             of PL_opargs, which does not always accurately reflect the type used.
3338             For custom ops the type is returned from the registration, and it is up
3339             to the registree to ensure it is accurate. The value returned will be
3340             one of the OA_* constants from op.h.
3341              
3342             U32 OP_CLASS(OP *o)','name' => 'OP_CLASS'},'SvPVutf8_nolen' => {'text' => 'Like C, but converts sv to utf8 first if necessary.
3343              
3344             char* SvPVutf8_nolen(SV* sv)','name' => 'SvPVutf8_nolen'},'SvRXOK' => {'text' => 'Returns a boolean indicating whether the SV (or the one it references)
3345             is a REGEXP.
3346              
3347             If you want to do something with the REGEXP* later use SvRX instead
3348             and check for NULL.
3349              
3350             bool SvRXOK(SV* sv)','name' => 'SvRXOK'},'sv_dup' => {'text' => '','name' => 'sv_dup'},'sv_setpviv' => {'text' => 'Copies an integer into the given SV, also updating its string value.
3351             Does not handle \'set\' magic. See C.
3352              
3353             void sv_setpviv(SV *const sv, const IV num)','name' => 'sv_setpviv'},'sv_true' => {'text' => 'Returns true if the SV has a true value by Perl\'s rules.
3354             Use the C macro instead, which may call C or may
3355             instead use an in-line version.
3356              
3357             I32 sv_true(SV *const sv)','name' => 'sv_true'},'save_aptr' => {'text' => '','name' => 'save_aptr'},'hv_exists' => {'text' => 'Returns a boolean indicating whether the specified hash key exists. The
3358             absolute value of C is the length of the key. If C is
3359             negative the key is assumed to be in UTF-8-encoded Unicode.
3360              
3361             bool hv_exists(HV *hv, const char *key, I32 klen)','name' => 'hv_exists'},'my_popen' => {'text' => '','name' => 'my_popen'},'mg_length' => {'text' => 'DEPRECATED! It is planned to remove this function from a
3362             future release of Perl. Do not use it for new code; remove it from
3363             existing code.
3364              
3365              
3366             Reports on the SV\'s length in bytes, calling length magic if available,
3367             but does not set the UTF8 flag on the sv. It will fall back to \'get\'
3368             magic if there is no \'length\' magic, but with no indication as to
3369             whether it called \'get\' magic. It assumes the sv is a PVMG or
3370             higher. Use sv_len() instead.
3371              
3372             U32 mg_length(SV* sv)','name' => 'mg_length'},'vdeb' => {'text' => '','name' => 'vdeb'},'do_close' => {'text' => '','name' => 'do_close'},'newUNOP' => {'text' => 'Constructs, checks, and returns an op of any unary type. I is
3373             the opcode. I gives the eight bits of C, except that
3374             C will be set automatically if required, and, shifted up eight
3375             bits, the eight bits of C, except that the bit with value 1
3376             is automatically set. I supplies an optional op to be the direct
3377             child of the unary op; it is consumed by this function and become part
3378             of the constructed op tree.
3379              
3380             OP * newUNOP(I32 type, I32 flags, OP *first)','name' => 'newUNOP'},'mini_mktime' => {'text' => '','name' => 'mini_mktime'},'HEf_SVKEY' => {'text' => 'This flag, used in the length slot of hash entries and magic structures,
3381             specifies the structure contains an C pointer where a C pointer
3382             is to be expected. (For information only--not to be used).','name' => 'HEf_SVKEY'},'save_helem_flags' => {'text' => '','name' => 'save_helem_flags'},'newPADOP' => {'text' => 'Constructs, checks, and returns an op of any type that involves a
3383             reference to a pad element. I is the opcode. I gives the
3384             eight bits of C. A pad slot is automatically allocated, and
3385             is populated with I; this function takes ownership of one reference
3386             to it.
3387              
3388             This function only exists if Perl has been compiled to use ithreads.
3389              
3390             OP * newPADOP(I32 type, I32 flags, SV *sv)','name' => 'newPADOP'},'utf8_length' => {'text' => 'Return the length of the UTF-8 char encoded string C in characters.
3391             Stops at C (inclusive). If C s> or if the scan would end
3392             up past C, croaks.
3393              
3394             STRLEN utf8_length(const U8* s, const U8 *e)','name' => 'utf8_length'},'dowantarray' => {'text' => '','name' => 'dowantarray'},'my_cxt_init' => {'text' => '','name' => 'my_cxt_init'},'SvIOK_only_UV' => {'text' => 'Tells an SV that it is an unsigned integer and disables all other OK bits.
3395              
3396             void SvIOK_only_UV(SV* sv)','name' => 'SvIOK_only_UV'},'clone_params_new' => {'text' => '','name' => 'clone_params_new'},'sv_vcatpvfn' => {'text' => 'void sv_vcatpvfn(SV *const sv, const char *const pat,
3397             const STRLEN patlen,
3398             va_list *const args,
3399             SV **const svargs, const I32 svmax,
3400             bool *const maybe_tainted)','name' => 'sv_vcatpvfn'},'BhkDISABLE' => {'text' => 'NOTE: this function is experimental and may change or be
3401             removed without notice.
3402              
3403              
3404             Temporarily disable an entry in this BHK structure, by clearing the
3405             appropriate flag. I is a preprocessor token indicating which
3406             entry to disable.
3407              
3408             void BhkDISABLE(BHK *hk, which)','name' => 'BhkDISABLE'},'croak_no_modify' => {'text' => 'Exactly equivalent to C, but generates
3409             terser object code than using C. Less code used on exception code
3410             paths reduces CPU cache pressure.
3411              
3412             void croak_no_modify()','name' => 'croak_no_modify'},'do_spawn' => {'text' => '','name' => 'do_spawn'},'share_hek' => {'text' => '','name' => 'share_hek'},'sv_pvutf8n' => {'text' => 'A private implementation of the C macro for compilers
3413             which can\'t cope with complex macro expressions. Always use the macro
3414             instead.
3415              
3416             char* sv_pvutf8n(SV *sv, STRLEN *lp)','name' => 'sv_pvutf8n'},'gv_fetchpv' => {'text' => '','name' => 'gv_fetchpv'},'newSV' => {'text' => 'Creates a new SV. A non-zero C parameter indicates the number of
3417             bytes of preallocated string space the SV should have. An extra byte for a
3418             trailing C is also reserved. (SvPOK is not set for the SV even if string
3419             space is allocated.) The reference count for the new SV is set to 1.
3420              
3421             In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
3422             parameter, I, a debug aid which allowed callers to identify themselves.
3423             This aid has been superseded by a new build option, PERL_MEM_LOG (see
3424             L). The older API is still there for use in XS
3425             modules supporting older perls.
3426              
3427             SV* newSV(const STRLEN len)','name' => 'newSV'},'sv_2pvutf8' => {'text' => 'Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
3428             to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
3429              
3430             Usually accessed via the C macro.
3431              
3432             char* sv_2pvutf8(SV *sv, STRLEN *const lp)','name' => 'sv_2pvutf8'},'dITEMS' => {'text' => 'Sets up the C variable.
3433             This is usually handled automatically by C by calling C.
3434              
3435             dITEMS;','name' => 'dITEMS'},'save_scalar' => {'text' => '','name' => 'save_scalar'},'newSUB' => {'text' => '','name' => 'newSUB'},'isGRAPH' => {'text' => 'Returns a boolean indicating whether the specified character is a
3436             graphic character, analogous to C.
3437             See the L for an explanation of variants
3438             C, C, C, C, C,
3439             C, and C.
3440              
3441             bool isGRAPH(char ch)','name' => 'isGRAPH'},'pad_findmy_pv' => {'text' => 'Exactly like L, but takes a nul-terminated string
3442             instead of a string/length pair.
3443              
3444             PADOFFSET pad_findmy_pv(const char *name, U32 flags)','name' => 'pad_findmy_pv'},'whichsig_sv' => {'text' => '','name' => 'whichsig_sv'},'despatch_signals' => {'text' => '','name' => 'despatch_signals'},'PUTBACK' => {'text' => 'Closing bracket for XSUB arguments. This is usually handled by C.
3445             See C and L for other uses.
3446              
3447             PUTBACK;','name' => 'PUTBACK'},'dAXMARK' => {'text' => 'Sets up the C variable and stack marker variable C.
3448             This is usually handled automatically by C by calling C.
3449              
3450             dAXMARK;','name' => 'dAXMARK'},'sv_2uv_flags' => {'text' => 'Return the unsigned integer value of an SV, doing any necessary string
3451             conversion. If flags includes SV_GMAGIC, does an mg_get() first.
3452             Normally used via the C and C macros.
3453              
3454             UV sv_2uv_flags(SV *const sv, const I32 flags)','name' => 'sv_2uv_flags'},'G_SCALAR' => {'text' => 'Used to indicate scalar context. See C, C, and
3455             L.','name' => 'G_SCALAR'},'pad_new' => {'text' => 'Create a new padlist, updating the global variables for the
3456             currently-compiling padlist to point to the new padlist. The following
3457             flags can be OR\'ed together:
3458              
3459             padnew_CLONE this pad is for a cloned CV
3460             padnew_SAVE save old globals on the save stack
3461             padnew_SAVESUB also save extra stuff for start of sub
3462              
3463             PADLIST * pad_new(int flags)','name' => 'pad_new'},'SvTAINTED_off' => {'text' => 'Untaints an SV. Be I careful with this routine, as it short-circuits
3464             some of Perl\'s fundamental security features. XS module authors should not
3465             use this function unless they fully understand all the implications of
3466             unconditionally untainting the value. Untainting should be done in the
3467             standard perl fashion, via a carefully crafted regexp, rather than directly
3468             untainting variables.
3469              
3470             void SvTAINTED_off(SV* sv)','name' => 'SvTAINTED_off'},'require_pv' => {'text' => 'Tells Perl to C the file named by the string argument. It is
3471             analogous to the Perl code C. It\'s even
3472             implemented that way; consider using load_module instead.
3473              
3474             NOTE: the perl_ form of this function is deprecated.
3475              
3476             void require_pv(const char* pv)','name' => 'require_pv'},'save_hdelete' => {'text' => '','name' => 'save_hdelete'},'strEQ' => {'text' => 'Test two strings to see if they are equal. Returns true or false.
3477              
3478             bool strEQ(char* s1, char* s2)','name' => 'strEQ'},'sv_upgrade' => {'text' => 'Upgrade an SV to a more complex form. Generally adds a new body type to the
3479             SV, then copies across as much information as possible from the old body.
3480             It croaks if the SV is already in a more complex form than requested. You
3481             generally want to use the C macro wrapper, which checks the type
3482             before calling C, and hence does not croak. See also
3483             C.
3484              
3485             void sv_upgrade(SV *const sv, svtype new_type)','name' => 'sv_upgrade'},'safesysmalloc' => {'text' => '','name' => 'safesysmalloc'},'save_item' => {'text' => '','name' => 'save_item'},'isUPPER' => {'text' => 'Returns a boolean indicating whether the specified character is an
3486             uppercase character, analogous to C.
3487             See the L for an explanation of variants
3488             C, C, C, C, C,
3489             C, and C.
3490              
3491             bool isUPPER(char ch)','name' => 'isUPPER'},'XopENABLE' => {'text' => 'Reenable a member of the XOP which has been disabled.
3492              
3493             void XopENABLE(XOP *xop, which)','name' => 'XopENABLE'},'lex_peek_unichar' => {'text' => 'NOTE: this function is experimental and may change or be
3494             removed without notice.
3495              
3496              
3497             Looks ahead one (Unicode) character in the text currently being lexed.
3498             Returns the codepoint (unsigned integer value) of the next character,
3499             or -1 if lexing has reached the end of the input text. To consume the
3500             peeked character, use L.
3501              
3502             If the next character is in (or extends into) the next chunk of input
3503             text, the next chunk will be read in. Normally the current chunk will be
3504             discarded at the same time, but if I includes C
3505             then the current chunk will not be discarded.
3506              
3507             If the input is being interpreted as UTF-8 and a UTF-8 encoding error
3508             is encountered, an exception is generated.
3509              
3510             I32 lex_peek_unichar(U32 flags)','name' => 'lex_peek_unichar'},'sv_setsv_mg' => {'text' => 'Like C, but also handles \'set\' magic.
3511              
3512             void sv_setsv_mg(SV *const dstr, SV *const sstr)','name' => 'sv_setsv_mg'},'call_list' => {'text' => '','name' => 'call_list'},'croak_nocontext' => {'text' => '','name' => 'croak_nocontext'},'isLOWER' => {'text' => 'Returns a boolean indicating whether the specified character is a
3513             lowercase character, analogous to C.
3514             See the L for an explanation of variants
3515             C, C, C, C, C,
3516             C, and C.
3517              
3518             bool isLOWER(char ch)','name' => 'isLOWER'},'hv_iterkey' => {'text' => 'Returns the key from the current position of the hash iterator. See
3519             C.
3520              
3521             char* hv_iterkey(HE* entry, I32* retlen)','name' => 'hv_iterkey'},'SvNOKp' => {'text' => 'Returns a U32 value indicating whether the SV contains a double. Checks the
3522             B setting. Use C instead.
3523              
3524             U32 SvNOKp(SV* sv)','name' => 'SvNOKp'},'PadnamePV' => {'text' => 'NOTE: this function is experimental and may change or be
3525             removed without notice.
3526              
3527              
3528             The name stored in the pad name struct. This returns NULL for a target or
3529             GV slot.
3530              
3531             char * PadnamePV(PADNAME pn)','name' => 'PadnamePV'},'nothreadhook' => {'text' => 'Stub that provides thread hook for perl_destruct when there are
3532             no threads.
3533              
3534             int nothreadhook()','name' => 'nothreadhook'},'utf8_to_uvchr' => {'text' => 'DEPRECATED! It is planned to remove this function from a
3535             future release of Perl. Do not use it for new code; remove it from
3536             existing code.
3537              
3538              
3539             Returns the native code point of the first character in the string C
3540             which is assumed to be in UTF-8 encoding; C will be set to the
3541             length, in bytes, of that character.
3542              
3543             Some, but not all, UTF-8 malformations are detected, and in fact, some
3544             malformed input could cause reading beyond the end of the input buffer, which
3545             is why this function is deprecated. Use L instead.
3546              
3547             If C points to one of the detected malformations, and UTF8 warnings are
3548             enabled, zero is returned and C<*retlen> is set (if C isn\'t
3549             NULL) to -1. If those warnings are off, the computed value if well-defined (or
3550             the Unicode REPLACEMENT CHARACTER, if not) is silently returned, and C<*retlen>
3551             is set (if C isn\'t NULL) so that (S + C<*retlen>>) is the
3552             next possible position in C that could begin a non-malformed character.
3553             See L for details on when the REPLACEMENT CHARACTER is returned.
3554              
3555             UV utf8_to_uvchr(const U8 *s, STRLEN *retlen)','name' => 'utf8_to_uvchr'},'bytes_to_utf8' => {'text' => 'NOTE: this function is experimental and may change or be
3556             removed without notice.
3557              
3558              
3559             Converts a string C of length C bytes from the native encoding into
3560             UTF-8.
3561             Returns a pointer to the newly-created string, and sets C to
3562             reflect the new length in bytes.
3563              
3564             A C character will be written after the end of the string.
3565              
3566             If you want to convert to UTF-8 from encodings other than
3567             the native (Latin1 or EBCDIC),
3568             see L().
3569              
3570             U8* bytes_to_utf8(const U8 *s, STRLEN *len)','name' => 'bytes_to_utf8'},'HvENAMELEN' => {'text' => 'Returns the length of the stash\'s effective name.
3571              
3572             STRLEN HvENAMELEN(HV *stash)','name' => 'HvENAMELEN'},'SvIsCOW_shared_hash' => {'text' => 'Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
3573             scalar.
3574              
3575             bool SvIsCOW_shared_hash(SV* sv)','name' => 'SvIsCOW_shared_hash'},'start_subparse' => {'text' => '','name' => 'start_subparse'},'mg_size' => {'text' => '','name' => 'mg_size'},'PadnamelistMAX' => {'text' => 'NOTE: this function is experimental and may change or be
3576             removed without notice.
3577              
3578              
3579             The index of the last pad name.
3580              
3581             SSize_t PadnamelistMAX(PADNAMELIST pnl)','name' => 'PadnamelistMAX'},'mg_free_type' => {'text' => 'Remove any magic of type I from the SV I. See L.
3582              
3583             void mg_free_type(SV *sv, int how)','name' => 'mg_free_type'},'sv_catsv_nomg' => {'text' => 'Like C but doesn\'t process magic.
3584              
3585             void sv_catsv_nomg(SV* dsv, SV* ssv)','name' => 'sv_catsv_nomg'},'sv_setuv_mg' => {'text' => 'Like C, but also handles \'set\' magic.
3586              
3587             void sv_setuv_mg(SV *const sv, const UV u)','name' => 'sv_setuv_mg'},'sys_intern_init' => {'text' => '','name' => 'sys_intern_init'},'SVt_INVLIST' => {'text' => 'Type flag for scalars. See L.','name' => 'SVt_INVLIST'},'XS_VERSION' => {'text' => 'The version identifier for an XS module. This is usually
3588             handled automatically by C. See C.','name' => 'XS_VERSION'},'find_rundefsvoffset' => {'text' => 'DEPRECATED! It is planned to remove this function from a
3589             future release of Perl. Do not use it for new code; remove it from
3590             existing code.
3591              
3592              
3593             Find the position of the lexical C<$_> in the pad of the
3594             currently-executing function. Returns the offset in the current pad,
3595             or C if there is no lexical C<$_> in scope (in which case
3596             the global one should be used instead).
3597             L is likely to be more convenient.
3598              
3599             NOTE: the perl_ form of this function is deprecated.
3600              
3601             PADOFFSET find_rundefsvoffset()','name' => 'find_rundefsvoffset'},'sv_setpv' => {'text' => 'Copies a string into an SV. The string must be terminated with a C
3602             character.
3603             Does not handle \'set\' magic. See C.
3604              
3605             void sv_setpv(SV *const sv, const char *const ptr)','name' => 'sv_setpv'},'hv_placeholders_set' => {'text' => '','name' => 'hv_placeholders_set'},'parse_fullstmt' => {'text' => 'NOTE: this function is experimental and may change or be
3606             removed without notice.
3607              
3608              
3609             Parse a single complete Perl statement. This may be a normal imperative
3610             statement or a declaration that has compile-time effect, and may include
3611             optional labels. It is up to the caller to ensure that the dynamic
3612             parser state (L et al) is correctly set to reflect the source
3613             of the code to be parsed and the lexical context for the statement.
3614              
3615             The op tree representing the statement is returned. This may be a
3616             null pointer if the statement is null, for example if it was actually
3617             a subroutine definition (which has compile-time side effects). If not
3618             null, it will be the result of a L call, normally including
3619             a C or equivalent op.
3620              
3621             If an error occurs in parsing or compilation, in most cases a valid op
3622             tree (most likely null) is returned anyway. The error is reflected in
3623             the parser state, normally resulting in a single exception at the top
3624             level of parsing which covers all the compilation errors that occurred.
3625             Some compilation errors, however, will throw an exception immediately.
3626              
3627             The I parameter is reserved for future use, and must always
3628             be zero.
3629              
3630             OP * parse_fullstmt(U32 flags)','name' => 'parse_fullstmt'},'atfork_lock' => {'text' => '','name' => 'atfork_lock'},'gv_fetchmethod' => {'text' => 'See L.
3631              
3632             GV* gv_fetchmethod(HV* stash, const char* name)','name' => 'gv_fetchmethod'},'SvGROW' => {'text' => 'Expands the character buffer in the SV so that it has room for the
3633             indicated number of bytes (remember to reserve space for an extra trailing
3634             C character). Calls C to perform the expansion if necessary.
3635             Returns a pointer to the character
3636             buffer. SV must be of type >= SVt_PV. One
3637             alternative is to call C if you are not sure of the type of SV.
3638              
3639             char * SvGROW(SV* sv, STRLEN len)','name' => 'SvGROW'},'dMULTICALL' => {'text' => 'Declare local variables for a multicall. See L.
3640              
3641             dMULTICALL;','name' => 'dMULTICALL'},'isIDFIRST' => {'text' => 'Returns a boolean indicating whether the specified character can be the first
3642             character of an identifier. This is very close to, but not quite the same as
3643             the official Unicode property C. The difference is that this
3644             returns true only if the input character also matches L.
3645             See the L for an explanation of variants
3646             C, C, C, C,
3647             C, C, and C.
3648              
3649             bool isIDFIRST(char ch)','name' => 'isIDFIRST'},'sv_catpv' => {'text' => 'Concatenates the C-terminated string onto the end of the string which is
3650             in the SV.
3651             If the SV has the UTF-8 status set, then the bytes appended should be
3652             valid UTF-8. Handles \'get\' magic, but not \'set\' magic. See C.
3653              
3654             void sv_catpv(SV *const sv, const char* ptr)','name' => 'sv_catpv'},'fprintf_nocontext' => {'text' => '','name' => 'fprintf_nocontext'},'sv_len' => {'text' => 'Returns the length of the string in the SV. Handles magic and type
3655             coercion and sets the UTF8 flag appropriately. See also C, which
3656             gives raw access to the xpv_cur slot.
3657              
3658             STRLEN sv_len(SV *const sv)','name' => 'sv_len'},'PerlIO_stderr' => {'text' => '','name' => 'PerlIO_stderr'},'sv_pvutf8' => {'text' => 'Use the C macro instead
3659              
3660             char* sv_pvutf8(SV *sv)','name' => 'sv_pvutf8'},'SvPVbyte_nolen' => {'text' => 'Like C, but converts sv to byte representation first if necessary.
3661              
3662             char* SvPVbyte_nolen(SV* sv)','name' => 'SvPVbyte_nolen'},'LEAVE' => {'text' => 'Closing bracket on a callback. See C and L.
3663              
3664             LEAVE;','name' => 'LEAVE'},'mess' => {'text' => 'Take a sprintf-style format pattern and argument list. These are used to
3665             generate a string message. If the message does not end with a newline,
3666             then it will be extended with some indication of the current location
3667             in the code, as described for L.
3668              
3669             Normally, the resulting message is returned in a new mortal SV.
3670             During global destruction a single SV may be shared between uses of
3671             this function.
3672              
3673             SV * mess(const char *pat, ...)','name' => 'mess'},'SVt_PVAV' => {'text' => 'Type flag for arrays. See L.','name' => 'SVt_PVAV'},'hv_delete_ent' => {'text' => 'Deletes a key/value pair in the hash. The value SV is removed from the hash,
3674             made mortal, and returned to the caller. The C value will normally be
3675             zero; if set to G_DISCARD then NULL will be returned. NULL will also be
3676             returned if the key is not found. C can be a valid precomputed hash
3677             value, or 0 to ask for it to be computed.
3678              
3679             SV* hv_delete_ent(HV *hv, SV *keysv, I32 flags,
3680             U32 hash)','name' => 'hv_delete_ent'},'PL_keyword_plugin' => {'text' => 'NOTE: this function is experimental and may change or be
3681             removed without notice.
3682              
3683              
3684             Function pointer, pointing at a function used to handle extended keywords.
3685             The function should be declared as
3686              
3687             int keyword_plugin_function(pTHX_
3688             char *keyword_ptr, STRLEN keyword_len,
3689             OP **op_ptr)
3690              
3691             The function is called from the tokeniser, whenever a possible keyword
3692             is seen. C points at the word in the parser\'s input
3693             buffer, and C gives its length; it is not null-terminated.
3694             The function is expected to examine the word, and possibly other state
3695             such as L<%^H|perlvar/%^H>, to decide whether it wants to handle it
3696             as an extended keyword. If it does not, the function should return
3697             C, and the normal parser process will continue.
3698              
3699             If the function wants to handle the keyword, it first must
3700             parse anything following the keyword that is part of the syntax
3701             introduced by the keyword. See L for details.
3702              
3703             When a keyword is being handled, the plugin function must build
3704             a tree of C structures, representing the code that was parsed.
3705             The root of the tree must be stored in C<*op_ptr>. The function then
3706             returns a constant indicating the syntactic role of the construct that
3707             it has parsed: C if it is a complete statement, or
3708             C if it is an expression. Note that a statement
3709             construct cannot be used inside an expression (except via C
3710             and similar), and an expression is not a complete statement (it requires
3711             at least a terminating semicolon).
3712              
3713             When a keyword is handled, the plugin function may also have
3714             (compile-time) side effects. It may modify C<%^H>, define functions, and
3715             so on. Typically, if side effects are the main purpose of a handler,
3716             it does not wish to generate any ops to be included in the normal
3717             compilation. In this case it is still required to supply an op tree,
3718             but it suffices to generate a single null op.
3719              
3720             That\'s how the C<*PL_keyword_plugin> function needs to behave overall.
3721             Conventionally, however, one does not completely replace the existing
3722             handler function. Instead, take a copy of C before
3723             assigning your own function pointer to it. Your handler function should
3724             look for keywords that it is interested in and handle those. Where it
3725             is not interested, it should call the saved plugin function, passing on
3726             the arguments it received. Thus C actually points
3727             at a chain of handler functions, all of which have an opportunity to
3728             handle keywords, and only the last function in the chain (built into
3729             the Perl core) will normally return C.','name' => 'PL_keyword_plugin'},'LINKLIST' => {'text' => 'Given the root of an optree, link the tree in execution order using the
3730             C pointers and return the first op executed. If this has
3731             already been done, it will not be redone, and C<< o->op_next >> will be
3732             returned. If C<< o->op_next >> is not already set, I should be at
3733             least an C.
3734              
3735             OP* LINKLIST(OP *o)','name' => 'LINKLIST'},'utf8_to_uvuni_buf' => {'text' => 'DEPRECATED! It is planned to remove this function from a
3736             future release of Perl. Do not use it for new code; remove it from
3737             existing code.
3738              
3739              
3740             Only in very rare circumstances should code need to be dealing in Unicode
3741             (as opposed to native) code points. In those few cases, use
3742             C> instead.
3743              
3744             Returns the Unicode (not-native) code point of the first character in the
3745             string C which
3746             is assumed to be in UTF-8 encoding; C points to 1 beyond the end of C.
3747             C will be set to the length, in bytes, of that character.
3748              
3749             If C does not point to a well-formed UTF-8 character and UTF8 warnings are
3750             enabled, zero is returned and C<*retlen> is set (if C isn\'t
3751             NULL) to -1. If those warnings are off, the computed value if well-defined (or
3752             the Unicode REPLACEMENT CHARACTER, if not) is silently returned, and C<*retlen>
3753             is set (if C isn\'t NULL) so that (S + C<*retlen>>) is the
3754             next possible position in C that could begin a non-malformed character.
3755             See L for details on when the REPLACEMENT CHARACTER is returned.
3756              
3757             UV utf8_to_uvuni_buf(const U8 *s, const U8 *send,
3758             STRLEN *retlen)','name' => 'utf8_to_uvuni_buf'},'cast_iv' => {'text' => '','name' => 'cast_iv'},'savesvpv' => {'text' => 'A version of C/C which gets the string to duplicate from
3759             the passed in SV using C
3760              
3761             On some platforms, Windows for example, all allocated memory owned by a thread
3762             is deallocated when that thread ends. So if you need that not to happen, you
3763             need to use the shared memory functions, such as C>.
3764              
3765             char* savesvpv(SV* sv)','name' => 'savesvpv'},'CLASS' => {'text' => 'Variable which is setup by C to indicate the
3766             class name for a C++ XS constructor. This is always a C. See C.
3767              
3768             char* CLASS','name' => 'CLASS'},'newAVREF' => {'text' => '','name' => 'newAVREF'},'foldEQ_latin1' => {'text' => '','name' => 'foldEQ_latin1'},'HeKLEN' => {'text' => 'If this is negative, and amounts to C, it indicates the entry
3769             holds an C key. Otherwise, holds the actual length of the key. Can
3770             be assigned to. The C macro is usually preferable for finding key
3771             lengths.
3772              
3773             STRLEN HeKLEN(HE* he)','name' => 'HeKLEN'},'sv_pvn_force_flags' => {'text' => 'Get a sensible string out of the SV somehow.
3774             If C has C bit set, will C on C if
3775             appropriate, else not. C and C are
3776             implemented in terms of this function.
3777             You normally want to use the various wrapper macros instead: see
3778             C and C
3779              
3780             char* sv_pvn_force_flags(SV *const sv,
3781             STRLEN *const lp,
3782             const I32 flags)','name' => 'sv_pvn_force_flags'},'sv_setpvf_mg_nocontext' => {'text' => '','name' => 'sv_setpvf_mg_nocontext'},'parse_termexpr' => {'text' => 'NOTE: this function is experimental and may change or be
3783             removed without notice.
3784              
3785              
3786             Parse a Perl term expression. This may contain operators of precedence
3787             down to the assignment operators. The expression must be followed (and thus
3788             terminated) either by a comma or lower-precedence operator or by
3789             something that would normally terminate an expression such as semicolon.
3790             If I includes C then the expression is optional,
3791             otherwise it is mandatory. It is up to the caller to ensure that the
3792             dynamic parser state (L et al) is correctly set to reflect
3793             the source of the code to be parsed and the lexical context for the
3794             expression.
3795              
3796             The op tree representing the expression is returned. If an optional
3797             expression is absent, a null pointer is returned, otherwise the pointer
3798             will be non-null.
3799              
3800             If an error occurs in parsing or compilation, in most cases a valid op
3801             tree is returned anyway. The error is reflected in the parser state,
3802             normally resulting in a single exception at the top level of parsing
3803             which covers all the compilation errors that occurred. Some compilation
3804             errors, however, will throw an exception immediately.
3805              
3806             OP * parse_termexpr(U32 flags)','name' => 'parse_termexpr'},'mPUSHi' => {'text' => 'Push an integer onto the stack. The stack must have room for this element.
3807             Does not use C. See also C, C and C.
3808              
3809             void mPUSHi(IV iv)','name' => 'mPUSHi'},'PUSHn' => {'text' => 'Push a double onto the stack. The stack must have room for this element.
3810             Handles \'set\' magic. Uses C, so C or C should be
3811             called to declare it. Do not call multiple C-oriented macros to
3812             return lists from XSUB\'s - see C instead. See also C and
3813             C.
3814              
3815             void PUSHn(NV nv)','name' => 'PUSHn'},'to_utf8_title' => {'text' => 'Instead use L.
3816              
3817             UV to_utf8_title(const U8 *p, U8* ustrp,
3818             STRLEN *lenp)','name' => 'to_utf8_title'},'PerlIO_unread' => {'text' => '','name' => 'PerlIO_unread'},'PadMAX' => {'text' => 'NOTE: this function is experimental and may change or be
3819             removed without notice.
3820              
3821              
3822             The index of the last pad entry.
3823              
3824             SSize_t PadMAX(PAD pad)','name' => 'PadMAX'},'gv_fullname' => {'text' => '','name' => 'gv_fullname'},'PL_sv_yes' => {'text' => 'This is the C SV. See C. Always refer to this as
3825             C<&PL_sv_yes>.
3826              
3827             SV PL_sv_yes','name' => 'PL_sv_yes'},'pregfree' => {'text' => '','name' => 'pregfree'},'sv_nosharing' => {'text' => 'Dummy routine which "shares" an SV when there is no sharing module present.
3828             Or "locks" it. Or "unlocks" it. In other
3829             words, ignores its single SV argument.
3830             Exists to avoid test for a NULL function pointer and because it could
3831             potentially warn under some level of strict-ness.
3832              
3833             void sv_nosharing(SV *sv)','name' => 'sv_nosharing'},'ck_entersub_args_list' => {'text' => 'Performs the default fixup of the arguments part of an C
3834             op tree. This consists of applying list context to each of the
3835             argument ops. This is the standard treatment used on a call marked
3836             with C<&>, or a method call, or a call through a subroutine reference,
3837             or any other call where the callee can\'t be identified at compile time,
3838             or a call where the callee has no prototype.
3839              
3840             OP * ck_entersub_args_list(OP *entersubop)','name' => 'ck_entersub_args_list'},'ck_warner' => {'text' => '','name' => 'ck_warner'},'is_ascii_string' => {'text' => 'Returns true if the first C bytes of the string C are the same whether
3841             or not the string is encoded in UTF-8 (or UTF-EBCDIC on EBCDIC machines). That
3842             is, if they are invariant. On ASCII-ish machines, only ASCII characters
3843             fit this definition, hence the function\'s name.
3844              
3845             If C is 0, it will be calculated using C, (which means if you
3846             use this option, that C can\'t have embedded C characters and has to
3847             have a terminating C byte).
3848              
3849             See also L(), L(), and L().
3850              
3851             bool is_ascii_string(const U8 *s, STRLEN len)','name' => 'is_ascii_string'},'SvUTF8_off' => {'text' => 'Unsets the UTF-8 status of an SV (the data is not changed, just the flag).
3852             Do not use frivolously.
3853              
3854             void SvUTF8_off(SV *sv)','name' => 'SvUTF8_off'},'sv_dec_nomg' => {'text' => 'Auto-decrement of the value in the SV, doing string to numeric conversion
3855             if necessary. Handles operator overloading. Skips handling \'get\' magic.
3856              
3857             void sv_dec_nomg(SV *const sv)','name' => 'sv_dec_nomg'},'looks_like_number' => {'text' => 'Test if the content of an SV looks like a number (or is a number).
3858             C and C are treated as numbers (so will not issue a
3859             non-numeric warning), even if your atof() doesn\'t grok them. Get-magic is
3860             ignored.
3861              
3862             I32 looks_like_number(SV *const sv)','name' => 'looks_like_number'},'sv_catpv_mg' => {'text' => 'Like C, but also handles \'set\' magic.
3863              
3864             void sv_catpv_mg(SV *const sv, const char *const ptr)','name' => 'sv_catpv_mg'},'save_vptr' => {'text' => '','name' => 'save_vptr'},'OP_NAME' => {'text' => 'Return the name of the provided OP. For core ops this looks up the name
3865             from the op_type; for custom ops from the op_ppaddr.
3866              
3867             const char * OP_NAME(OP *o)','name' => 'OP_NAME'},'XSRETURN_EMPTY' => {'text' => 'Return an empty list from an XSUB immediately.
3868              
3869             XSRETURN_EMPTY;','name' => 'XSRETURN_EMPTY'},'SvREFCNT_dec_NN' => {'text' => 'Same as SvREFCNT_dec, but can only be used if you know I
3870             is not NULL. Since we don\'t have to check the NULLness, it\'s faster
3871             and smaller.
3872              
3873             void SvREFCNT_dec_NN(SV* sv)','name' => 'SvREFCNT_dec_NN'},'mro_get_private_data' => {'text' => '','name' => 'mro_get_private_data'},'XS_APIVERSION_BOOTCHECK' => {'text' => 'Macro to verify that the perl api version an XS module has been compiled against
3874             matches the api version of the perl interpreter it\'s being loaded into.
3875              
3876             XS_APIVERSION_BOOTCHECK;','name' => 'XS_APIVERSION_BOOTCHECK'},'hv_delayfree_ent' => {'text' => '','name' => 'hv_delayfree_ent'},'sv_setpvf' => {'text' => 'Works like C but copies the text into the SV instead of
3877             appending it. Does not handle \'set\' magic. See C.
3878              
3879             void sv_setpvf(SV *const sv, const char *const pat,
3880             ...)','name' => 'sv_setpvf'},'custom_op_register' => {'text' => 'Register a custom op. See L.
3881              
3882             NOTE: this function must be explicitly called as Perl_custom_op_register with an aTHX_ parameter.
3883              
3884             void Perl_custom_op_register(pTHX_
3885             Perl_ppaddr_t ppaddr,
3886             const XOP *xop)','name' => 'custom_op_register'},'scan_num' => {'text' => '','name' => 'scan_num'},'save_int' => {'text' => '','name' => 'save_int'},'call_sv' => {'text' => 'Performs a callback to the Perl sub whose name is in the SV. See
3887             L.
3888              
3889             NOTE: the perl_ form of this function is deprecated.
3890              
3891             I32 call_sv(SV* sv, VOL I32 flags)','name' => 'call_sv'},'SVt_PV' => {'text' => 'Type flag for scalars. See L.','name' => 'SVt_PV'},'strGT' => {'text' => 'Test two strings to see if the first, C, is greater than the second,
3892             C. Returns true or false.
3893              
3894             bool strGT(char* s1, char* s2)','name' => 'strGT'},'mXPUSHs' => {'text' => 'Push an SV onto the stack, extending the stack if necessary and mortalizes
3895             the SV. Does not use C. See also C and C.
3896              
3897             void mXPUSHs(SV* sv)','name' => 'mXPUSHs'},'POPl' => {'text' => 'Pops a long off the stack.
3898              
3899             long POPl','name' => 'POPl'},'scan_version' => {'text' => 'Returns a pointer to the next character after the parsed
3900             version string, as well as upgrading the passed in SV to
3901             an RV.
3902              
3903             Function must be called with an already existing SV like
3904              
3905             sv = newSV(0);
3906             s = scan_version(s, SV *sv, bool qv);
3907              
3908             Performs some preprocessing to the string to ensure that
3909             it has the correct characteristics of a version. Flags the
3910             object if it contains an underscore (which denotes this
3911             is an alpha version). The boolean qv denotes that the version
3912             should be interpreted as if it had multiple decimals, even if
3913             it doesn\'t.
3914              
3915             const char* scan_version(const char *s, SV *rv, bool qv)','name' => 'scan_version'},'toLOWER_LC' => {'text' => 'Converts the specified character to lowercase using the current locale\'s rules,
3916             if possible; otherwise returns the input character itself.
3917              
3918             U8 toLOWER_LC(U8 ch)','name' => 'toLOWER_LC'},'hv_common_key_len' => {'text' => '','name' => 'hv_common_key_len'},'vnumify' => {'text' => 'Accepts a version object and returns the normalized floating
3919             point representation. Call like:
3920              
3921             sv = vnumify(rv);
3922              
3923             NOTE: you can pass either the object directly or the SV
3924             contained within the RV.
3925              
3926             The SV returned has a refcount of 1.
3927              
3928             SV* vnumify(SV *vs)','name' => 'vnumify'},'get_cv' => {'text' => 'Uses C to get the length of C, then calls C.
3929              
3930             NOTE: the perl_ form of this function is deprecated.
3931              
3932             CV* get_cv(const char* name, I32 flags)','name' => 'get_cv'},'SvIOKp' => {'text' => 'Returns a U32 value indicating whether the SV contains an integer. Checks
3933             the B setting. Use C instead.
3934              
3935             U32 SvIOKp(SV* sv)','name' => 'SvIOKp'},'XST_mUNDEF' => {'text' => 'Place C<&PL_sv_undef> into the specified position C on the
3936             stack.
3937              
3938             void XST_mUNDEF(int pos)','name' => 'XST_mUNDEF'},'ptr_table_free' => {'text' => '','name' => 'ptr_table_free'},'SVt_PVIV' => {'text' => 'Type flag for scalars. See L.','name' => 'SVt_PVIV'},'SvUNLOCK' => {'text' => 'Releases a mutual exclusion lock on sv if a suitable module
3939             has been loaded.
3940              
3941             void SvUNLOCK(SV* sv)','name' => 'SvUNLOCK'},'mg_set' => {'text' => 'Do magic after a value is assigned to the SV. See C.
3942              
3943             int mg_set(SV* sv)','name' => 'mg_set'},'sv_mortalcopy' => {'text' => 'Creates a new SV which is a copy of the original SV (using C).
3944             The new SV is marked as mortal. It will be destroyed "soon", either by an
3945             explicit call to FREETMPS, or by an implicit call at places such as
3946             statement boundaries. See also C and C.
3947              
3948             SV* sv_mortalcopy(SV *const oldsv)','name' => 'sv_mortalcopy'},'cophh_fetch_sv' => {'text' => 'NOTE: this function is experimental and may change or be
3949             removed without notice.
3950              
3951              
3952             Like L, but takes a Perl scalar instead of a
3953             string/length pair.
3954              
3955             SV * cophh_fetch_sv(const COPHH *cophh, SV *key,
3956             U32 hash, U32 flags)','name' => 'cophh_fetch_sv'},'PadARRAY' => {'text' => 'NOTE: this function is experimental and may change or be
3957             removed without notice.
3958              
3959              
3960             The C array of pad entries.
3961              
3962             SV ** PadARRAY(PAD pad)','name' => 'PadARRAY'},'sv_catpvn_nomg' => {'text' => 'Like C but doesn\'t process magic.
3963              
3964             void sv_catpvn_nomg(SV* sv, const char* ptr,
3965             STRLEN len)','name' => 'sv_catpvn_nomg'},'newHVhv' => {'text' => '','name' => 'newHVhv'},'newSVpvs_flags' => {'text' => 'Like C, but takes a literal C-terminated string instead of
3966             a string/length pair.
3967              
3968             SV* newSVpvs_flags(const char* s, U32 flags)','name' => 'newSVpvs_flags'},'savepvn' => {'text' => 'Perl\'s version of what C would be if it existed. Returns a
3969             pointer to a newly allocated string which is a duplicate of the first
3970             C bytes from C, plus a trailing
3971             C byte. The memory allocated for
3972             the new string can be freed with the C function.
3973              
3974             On some platforms, Windows for example, all allocated memory owned by a thread
3975             is deallocated when that thread ends. So if you need that not to happen, you
3976             need to use the shared memory functions, such as C>.
3977              
3978             char* savepvn(const char* pv, I32 len)','name' => 'savepvn'},'pad_findmy_sv' => {'text' => 'Exactly like L, but takes the name string in the form
3979             of an SV instead of a string/length pair.
3980              
3981             PADOFFSET pad_findmy_sv(SV *name, U32 flags)','name' => 'pad_findmy_sv'},'cophh_delete_sv' => {'text' => 'NOTE: this function is experimental and may change or be
3982             removed without notice.
3983              
3984              
3985             Like L, but takes a Perl scalar instead of a
3986             string/length pair.
3987              
3988             COPHH * cophh_delete_sv(const COPHH *cophh, SV *key,
3989             U32 hash, U32 flags)','name' => 'cophh_delete_sv'},'av_exists' => {'text' => 'Returns true if the element indexed by C has been initialized.
3990              
3991             This relies on the fact that uninitialized array elements are set to
3992             NULL.
3993              
3994             Perl equivalent: C.
3995              
3996             bool av_exists(AV *av, SSize_t key)','name' => 'av_exists'},'SvCUR' => {'text' => 'Returns the length of the string which is in the SV. See C.
3997              
3998             STRLEN SvCUR(SV* sv)','name' => 'SvCUR'},'sv_2nv_flags' => {'text' => 'Return the num value of an SV, doing any necessary string or integer
3999             conversion. If flags includes SV_GMAGIC, does an mg_get() first.
4000             Normally used via the C and C macros.
4001              
4002             NV sv_2nv_flags(SV *const sv, const I32 flags)','name' => 'sv_2nv_flags'},'gv_init' => {'text' => 'The old form of gv_init_pvn(). It does not work with UTF8 strings, as it
4003             has no flags parameter. If the C parameter is set, the
4004             GV_ADDMULTI flag will be passed to gv_init_pvn().
4005              
4006             void gv_init(GV* gv, HV* stash, const char* name,
4007             STRLEN len, int multi)','name' => 'gv_init'},'sv_bless' => {'text' => 'Blesses an SV into a specified package. The SV must be an RV. The package
4008             must be designated by its stash (see C). The reference count
4009             of the SV is unaffected.
4010              
4011             SV* sv_bless(SV *const sv, HV *const stash)','name' => 'sv_bless'},'cv_set_call_checker' => {'text' => 'Sets the function that will be used to fix up a call to I.
4012             Specifically, the function is applied to an C op tree for a
4013             subroutine call, not marked with C<&>, where the callee can be identified
4014             at compile time as I.
4015              
4016             The C-level function pointer is supplied in I, and an SV argument
4017             for it is supplied in I. The function should be defined like this:
4018              
4019             STATIC OP * ckfun(pTHX_ OP *op, GV *namegv, SV *ckobj)
4020              
4021             It is intended to be called in this manner:
4022              
4023             entersubop = ckfun(aTHX_ entersubop, namegv, ckobj);
4024              
4025             In this call, I is a pointer to the C op,
4026             which may be replaced by the check function, and I is a GV
4027             supplying the name that should be used by the check function to refer
4028             to the callee of the C op if it needs to emit any diagnostics.
4029             It is permitted to apply the check function in non-standard situations,
4030             such as to a call to a different subroutine or to a method call.
4031              
4032             The current setting for a particular CV can be retrieved by
4033             L.
4034              
4035             void cv_set_call_checker(CV *cv,
4036             Perl_call_checker ckfun,
4037             SV *ckobj)','name' => 'cv_set_call_checker'},'save_ary' => {'text' => '','name' => 'save_ary'},'sv_2io' => {'text' => 'Using various gambits, try to get an IO from an SV: the IO slot if its a
4038             GV; or the recursive result if we\'re an RV; or the IO slot of the symbol
4039             named after the PV if we\'re a string.
4040              
4041             \'Get\' magic is ignored on the sv passed in, but will be called on
4042             C if sv is an RV.
4043              
4044             IO* sv_2io(SV *const sv)','name' => 'sv_2io'},'SvMAGIC_set' => {'text' => 'Set the value of the MAGIC pointer in sv to val. See C.
4045              
4046             void SvMAGIC_set(SV* sv, MAGIC* val)','name' => 'SvMAGIC_set'},'isALPHA' => {'text' => 'Returns a boolean indicating whether the specified character is an
4047             alphabetic character, analogous to C.
4048             See the L for an explanation of variants
4049             C, C, C, C, C,
4050             C, and C.
4051              
4052             bool isALPHA(char ch)','name' => 'isALPHA'},'newSVhek' => {'text' => 'Creates a new SV from the hash key structure. It will generate scalars that
4053             point to the shared string table where possible. Returns a new (undefined)
4054             SV if the hek is NULL.
4055              
4056             SV* newSVhek(const HEK *const hek)','name' => 'newSVhek'},'taint_env' => {'text' => '','name' => 'taint_env'},'Nullhv' => {'text' => 'Null HV pointer.
4057              
4058             (deprecated - use C<(HV *)NULL> instead)','name' => 'Nullhv'},'SvREFCNT_inc' => {'text' => 'Increments the reference count of the given SV, returning the SV.
4059              
4060             All of the following SvREFCNT_inc* macros are optimized versions of
4061             SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
4062              
4063             SV* SvREFCNT_inc(SV* sv)','name' => 'SvREFCNT_inc'},'newGVgen_flags' => {'text' => '','name' => 'newGVgen_flags'},'SvTYPE' => {'text' => 'Returns the type of the SV. See C.
4064              
4065             svtype SvTYPE(SV* sv)','name' => 'SvTYPE'},'block_gimme' => {'text' => '','name' => 'block_gimme'},'SvROK_off' => {'text' => 'Unsets the RV status of an SV.
4066              
4067             void SvROK_off(SV* sv)','name' => 'SvROK_off'},'Renew' => {'text' => 'The XSUB-writer\'s interface to the C C function.
4068              
4069             Memory obtained by this should B be freed with L<"Safefree">.
4070              
4071             void Renew(void* ptr, int nitems, type)','name' => 'Renew'},'XPUSHmortal' => {'text' => 'Push a new mortal SV onto the stack, extending the stack if necessary.
4072             Does not use C. See also C, C and C.
4073              
4074             void XPUSHmortal()','name' => 'XPUSHmortal'},'SvNOK_on' => {'text' => 'Tells an SV that it is a double.
4075              
4076             void SvNOK_on(SV* sv)','name' => 'SvNOK_on'},'SvVOK' => {'text' => 'Returns a boolean indicating whether the SV contains a v-string.
4077              
4078             bool SvVOK(SV* sv)','name' => 'SvVOK'},'whichsig_pvn' => {'text' => '','name' => 'whichsig_pvn'},'sv_setpvf_mg' => {'text' => 'Like C, but also handles \'set\' magic.
4079              
4080             void sv_setpvf_mg(SV *const sv,
4081             const char *const pat, ...)','name' => 'sv_setpvf_mg'},'my_chsize' => {'text' => '','name' => 'my_chsize'},'newLISTOP' => {'text' => 'Constructs, checks, and returns an op of any list type. I is
4082             the opcode. I gives the eight bits of C, except that
4083             C will be set automatically if required. I and I
4084             supply up to two ops to be direct children of the list op; they are
4085             consumed by this function and become part of the constructed op tree.
4086              
4087             OP * newLISTOP(I32 type, I32 flags, OP *first,
4088             OP *last)','name' => 'newLISTOP'},'sv_setref_pv' => {'text' => 'Copies a pointer into a new SV, optionally blessing the SV. The C
4089             argument will be upgraded to an RV. That RV will be modified to point to
4090             the new SV. If the C argument is NULL then C will be placed
4091             into the SV. The C argument indicates the package for the
4092             blessing. Set C to C to avoid the blessing. The new SV
4093             will have a reference count of 1, and the RV will be returned.
4094              
4095             Do not use with other Perl types such as HV, AV, SV, CV, because those
4096             objects will become corrupted by the pointer copy process.
4097              
4098             Note that C copies the string while this copies the pointer.
4099              
4100             SV* sv_setref_pv(SV *const rv,
4101             const char *const classname,
4102             void *const pv)','name' => 'sv_setref_pv'},'fbm_compile' => {'text' => 'Analyses the string in order to make fast searches on it using fbm_instr()
4103             -- the Boyer-Moore algorithm.
4104              
4105             void fbm_compile(SV* sv, U32 flags)','name' => 'fbm_compile'},'SvNIOKp' => {'text' => 'Returns a U32 value indicating whether the SV contains a number, integer or
4106             double. Checks the B setting. Use C instead.
4107              
4108             U32 SvNIOKp(SV* sv)','name' => 'SvNIOKp'},'PERL_SYS_TERM' => {'text' => 'Provides system-specific clean up of the C runtime environment after
4109             running Perl interpreters. This should be called only once, after
4110             freeing any remaining Perl interpreters.
4111              
4112             void PERL_SYS_TERM()','name' => 'PERL_SYS_TERM'},'mro_register' => {'text' => 'Registers a custom mro plugin. See L for details.
4113              
4114             void mro_register(const struct mro_alg *mro)','name' => 'mro_register'},'vnewSVpvf' => {'text' => '','name' => 'vnewSVpvf'},'rv2cv_op_cv' => {'text' => 'Examines an op, which is expected to identify a subroutine at runtime,
4115             and attempts to determine at compile time which subroutine it identifies.
4116             This is normally used during Perl compilation to determine whether
4117             a prototype can be applied to a function call. I is the op
4118             being considered, normally an C op. A pointer to the identified
4119             subroutine is returned, if it could be determined statically, and a null
4120             pointer is returned if it was not possible to determine statically.
4121              
4122             Currently, the subroutine can be identified statically if the RV that the
4123             C is to operate on is provided by a suitable C or C op.
4124             A C op is suitable if the GV\'s CV slot is populated. A C op is
4125             suitable if the constant value must be an RV pointing to a CV. Details of
4126             this process may change in future versions of Perl. If the C op
4127             has the C flag set then no attempt is made to identify
4128             the subroutine statically: this flag is used to suppress compile-time
4129             magic on a subroutine call, forcing it to use default runtime behaviour.
4130              
4131             If I has the bit C set, then the handling
4132             of a GV reference is modified. If a GV was examined and its CV slot was
4133             found to be empty, then the C op has the C flag set.
4134             If the op is not optimised away, and the CV slot is later populated with
4135             a subroutine having a prototype, that flag eventually triggers the warning
4136             "called too early to check prototype".
4137              
4138             If I has the bit C set, then instead
4139             of returning a pointer to the subroutine it returns a pointer to the
4140             GV giving the most appropriate name for the subroutine in this context.
4141             Normally this is just the C of the subroutine, but for an anonymous
4142             (C) subroutine that is referenced through a GV it will be the
4143             referencing GV. The resulting C is cast to C to be returned.
4144             A null pointer is returned as usual if there is no statically-determinable
4145             subroutine.
4146              
4147             CV * rv2cv_op_cv(OP *cvop, U32 flags)','name' => 'rv2cv_op_cv'},'sv_len_utf8' => {'text' => 'Returns the number of characters in the string in an SV, counting wide
4148             UTF-8 bytes as a single character. Handles magic and type coercion.
4149              
4150             STRLEN sv_len_utf8(SV *const sv)','name' => 'sv_len_utf8'},'PerlIO_set_cnt' => {'text' => '','name' => 'PerlIO_set_cnt'},'SvREFCNT_inc_simple_void' => {'text' => 'Same as SvREFCNT_inc_simple, but can only be used if you don\'t need the
4151             return value. The macro doesn\'t need to return a meaningful value.
4152              
4153             void SvREFCNT_inc_simple_void(SV* sv)','name' => 'SvREFCNT_inc_simple_void'},'cx_dup' => {'text' => '','name' => 'cx_dup'},'hv_clear_placeholders' => {'text' => 'Clears any placeholders from a hash. If a restricted hash has any of its keys
4154             marked as readonly and the key is subsequently deleted, the key is not actually
4155             deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
4156             it so it will be ignored by future operations such as iterating over the hash,
4157             but will still allow the hash to have a value reassigned to the key at some
4158             future point. This function clears any such placeholder keys from the hash.
4159             See Hash::Util::lock_keys() for an example of its use.
4160              
4161             void hv_clear_placeholders(HV *hv)','name' => 'hv_clear_placeholders'},'dAX' => {'text' => 'Sets up the C variable.
4162             This is usually handled automatically by C by calling C.
4163              
4164             dAX;','name' => 'dAX'},'SvRV_set' => {'text' => 'Set the value of the RV pointer in sv to val. See C.
4165              
4166             void SvRV_set(SV* sv, SV* val)','name' => 'SvRV_set'},'grok_number' => {'text' => 'Recognise (or not) a number. The type of the number is returned
4167             (0 if unrecognised), otherwise it is a bit-ORed combination of
4168             IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
4169             IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
4170              
4171             If the value of the number can fit in a UV, it is returned in the *valuep
4172             IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
4173             will never be set unless *valuep is valid, but *valuep may have been assigned
4174             to during processing even though IS_NUMBER_IN_UV is not set on return.
4175             If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
4176             valuep is non-NULL, but no actual assignment (or SEGV) will occur.
4177              
4178             IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
4179             seen (in which case *valuep gives the true value truncated to an integer), and
4180             IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
4181             absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
4182             number is larger than a UV.
4183              
4184             int grok_number(const char *pv, STRLEN len,
4185             UV *valuep)','name' => 'grok_number'},'csighandler' => {'text' => '','name' => 'csighandler'},'SvIVx' => {'text' => 'Coerces the given SV to an integer and returns it.
4186             Guarantees to evaluate C only once. Only use
4187             this if C is an expression with side effects,
4188             otherwise use the more efficient C.
4189              
4190             IV SvIVx(SV* sv)','name' => 'SvIVx'},'grok_numeric_radix' => {'text' => 'Scan and skip for a numeric decimal separator (radix).
4191              
4192             bool grok_numeric_radix(const char **sp,
4193             const char *send)','name' => 'grok_numeric_radix'},'XST_mNO' => {'text' => 'Place C<&PL_sv_no> into the specified position C on the
4194             stack.
4195              
4196             void XST_mNO(int pos)','name' => 'XST_mNO'},'gp_dup' => {'text' => '','name' => 'gp_dup'},'sv_derived_from_pv' => {'text' => 'Exactly like L, but takes a nul-terminated string
4197             instead of a string/length pair.
4198              
4199             bool sv_derived_from_pv(SV* sv,
4200             const char *const name,
4201             U32 flags)','name' => 'sv_derived_from_pv'},'savepvs' => {'text' => 'Like C, but takes a literal C-terminated string instead of a
4202             string/length pair.
4203              
4204             char* savepvs(const char* s)','name' => 'savepvs'},'SvSTASH_set' => {'text' => 'Set the value of the STASH pointer in sv to val. See C.
4205              
4206             void SvSTASH_set(SV* sv, HV* val)','name' => 'SvSTASH_set'},'sv_catpv_nomg' => {'text' => 'Like C but doesn\'t process magic.
4207              
4208             void sv_catpv_nomg(SV* sv, const char* ptr)','name' => 'sv_catpv_nomg'},'ZeroD' => {'text' => 'Like C but returns dest. Useful
4209             for encouraging compilers to tail-call
4210             optimise.
4211              
4212             void * ZeroD(void* dest, int nitems, type)','name' => 'ZeroD'},'sv_collxfrm' => {'text' => 'This calls C with the SV_GMAGIC flag. See
4213             C.
4214              
4215             char* sv_collxfrm(SV *const sv, STRLEN *const nxp)','name' => 'sv_collxfrm'},'swash_fetch' => {'text' => '','name' => 'swash_fetch'},'SP' => {'text' => 'Stack pointer. This is usually handled by C. See C and
4216             C.','name' => 'SP'},'sv_catpvn_mg' => {'text' => 'Like C, but also handles \'set\' magic.
4217              
4218             void sv_catpvn_mg(SV *sv, const char *ptr,
4219             STRLEN len)','name' => 'sv_catpvn_mg'},'op_lvalue' => {'text' => 'NOTE: this function is experimental and may change or be
4220             removed without notice.
4221              
4222              
4223             Propagate lvalue ("modifiable") context to an op and its children.
4224             I represents the context type, roughly based on the type of op that
4225             would do the modifying, although C is represented by OP_NULL,
4226             because it has no op type of its own (it is signalled by a flag on
4227             the lvalue op).
4228              
4229             This function detects things that can\'t be modified, such as C<$x+1>, and
4230             generates errors for them. For example, C<$x+1 = 2> would cause it to be
4231             called with an op of type OP_ADD and a C argument of OP_SASSIGN.
4232              
4233             It also flags things that need to behave specially in an lvalue context,
4234             such as C<$$x = 5> which might have to vivify a reference in C<$x>.
4235              
4236             OP * op_lvalue(OP *o, I32 type)','name' => 'op_lvalue'},'dirp_dup' => {'text' => '','name' => 'dirp_dup'},'gv_stashpvs' => {'text' => 'Like C, but takes a literal string instead of a string/length pair.
4237              
4238             HV* gv_stashpvs(const char* name, I32 create)','name' => 'gv_stashpvs'},'vcmp' => {'text' => 'Version object aware cmp. Both operands must already have been
4239             converted into version objects.
4240              
4241             int vcmp(SV *lhv, SV *rhv)','name' => 'vcmp'},'Zero' => {'text' => 'The XSUB-writer\'s interface to the C C function. The C is the
4242             destination, C is the number of items, and C is the type.
4243              
4244             void Zero(void* dest, int nitems, type)','name' => 'Zero'},'SvSTASH' => {'text' => 'Returns the stash of the SV.
4245              
4246             HV* SvSTASH(SV* sv)','name' => 'SvSTASH'},'XSRETURN_UNDEF' => {'text' => 'Return C<&PL_sv_undef> from an XSUB immediately. Uses C.
4247              
4248             XSRETURN_UNDEF;','name' => 'XSRETURN_UNDEF'},'sv_iv' => {'text' => 'A private implementation of the C macro for compilers which can\'t
4249             cope with complex macro expressions. Always use the macro instead.
4250              
4251             IV sv_iv(SV* sv)','name' => 'sv_iv'},'PL_parser-Ebufend' => {'text' => 'NOTE: this function is experimental and may change or be
4252             removed without notice.
4253              
4254              
4255             Direct pointer to the end of the chunk of text currently being lexed, the
4256             end of the lexer buffer. This is equal to Clinestr)
4257             + SvCUR(PL_parser-Elinestr)>. A C character (zero octet) is
4258             always located at the end of the buffer, and does not count as part of
4259             the buffer\'s contents.','name' => 'PL_parser-Ebufend'},'PerlIO_error' => {'text' => '','name' => 'PerlIO_error'},'pv_escape' => {'text' => 'Escapes at most the first "count" chars of pv and puts the results into
4260             dsv such that the size of the escaped string will not exceed "max" chars
4261             and will not contain any incomplete escape sequences.
4262              
4263             If flags contains PERL_PV_ESCAPE_QUOTE then any double quotes in the string
4264             will also be escaped.
4265              
4266             Normally the SV will be cleared before the escaped string is prepared,
4267             but when PERL_PV_ESCAPE_NOCLEAR is set this will not occur.
4268              
4269             If PERL_PV_ESCAPE_UNI is set then the input string is treated as Unicode,
4270             if PERL_PV_ESCAPE_UNI_DETECT is set then the input string is scanned
4271             using C to determine if it is Unicode.
4272              
4273             If PERL_PV_ESCAPE_ALL is set then all input chars will be output
4274             using C<\\x01F1> style escapes, otherwise if PERL_PV_ESCAPE_NONASCII is set, only
4275             non-ASCII chars will be escaped using this style; otherwise, only chars above
4276             255 will be so escaped; other non printable chars will use octal or
4277             common escaped patterns like C<\\n>.
4278             Otherwise, if PERL_PV_ESCAPE_NOBACKSLASH
4279             then all chars below 255 will be treated as printable and
4280             will be output as literals.
4281              
4282             If PERL_PV_ESCAPE_FIRSTCHAR is set then only the first char of the
4283             string will be escaped, regardless of max. If the output is to be in hex,
4284             then it will be returned as a plain hex
4285             sequence. Thus the output will either be a single char,
4286             an octal escape sequence, a special escape like C<\\n> or a hex value.
4287              
4288             If PERL_PV_ESCAPE_RE is set then the escape char used will be a \'%\' and
4289             not a \'\\\\\'. This is because regexes very often contain backslashed
4290             sequences, whereas \'%\' is not a particularly common character in patterns.
4291              
4292             Returns a pointer to the escaped text as held by dsv.
4293              
4294             char* pv_escape(SV *dsv, char const * const str,
4295             const STRLEN count, const STRLEN max,
4296             STRLEN * const escaped,
4297             const U32 flags)','name' => 'pv_escape'},'HeSVKEY_force' => {'text' => 'Returns the key as an C. Will create and return a temporary mortal
4298             C if the hash entry contains only a C key.
4299              
4300             SV* HeSVKEY_force(HE* he)','name' => 'HeSVKEY_force'},'my_exit' => {'text' => '','name' => 'my_exit'},'newRV_inc' => {'text' => 'Creates an RV wrapper for an SV. The reference count for the original SV is
4301             incremented.
4302              
4303             SV* newRV_inc(SV* sv)','name' => 'newRV_inc'},'isPUNCT' => {'text' => 'Returns a boolean indicating whether the specified character is a
4304             punctuation character, analogous to C.
4305             Note that the definition of what is punctuation isn\'t as
4306             straightforward as one might desire. See L
4307             Classes> for details.
4308             See the L for an explanation of variants
4309             C, C, C, C, C,
4310             C, and C.
4311              
4312             bool isPUNCT(char ch)','name' => 'isPUNCT'},'SVt_PVCV' => {'text' => 'Type flag for subroutines. See L.','name' => 'SVt_PVCV'},'ss_dup' => {'text' => '','name' => 'ss_dup'},'gv_handler' => {'text' => '','name' => 'gv_handler'},'sv_setpviv_mg' => {'text' => 'Like C, but also handles \'set\' magic.
4313              
4314             void sv_setpviv_mg(SV *const sv, const IV iv)','name' => 'sv_setpviv_mg'},'debstack' => {'text' => '','name' => 'debstack'},'sv_2bool' => {'text' => 'This macro is only used by sv_true() or its macro equivalent, and only if
4315             the latter\'s argument is neither SvPOK, SvIOK nor SvNOK.
4316             It calls sv_2bool_flags with the SV_GMAGIC flag.
4317              
4318             bool sv_2bool(SV *const sv)','name' => 'sv_2bool'},'lex_grow_linestr' => {'text' => 'NOTE: this function is experimental and may change or be
4319             removed without notice.
4320              
4321              
4322             Reallocates the lexer buffer (Llinestr>) to accommodate
4323             at least I octets (including terminating C). Returns a
4324             pointer to the reallocated buffer. This is necessary before making
4325             any direct modification of the buffer that would increase its length.
4326             L provides a more convenient way to insert text into
4327             the buffer.
4328              
4329             Do not use C or C directly on Clinestr>;
4330             this function updates all of the lexer\'s variables that point directly
4331             into the buffer.
4332              
4333             char * lex_grow_linestr(STRLEN len)','name' => 'lex_grow_linestr'},'dORIGMARK' => {'text' => 'Saves the original stack mark for the XSUB. See C.
4334              
4335             dORIGMARK;','name' => 'dORIGMARK'},'sv_inc_nomg' => {'text' => 'Auto-increment of the value in the SV, doing string to numeric conversion
4336             if necessary. Handles operator overloading. Skips handling \'get\' magic.
4337              
4338             void sv_inc_nomg(SV *const sv)','name' => 'sv_inc_nomg'},'sv_newmortal' => {'text' => 'Creates a new null SV which is mortal. The reference count of the SV is
4339             set to 1. It will be destroyed "soon", either by an explicit call to
4340             FREETMPS, or by an implicit call at places such as statement boundaries.
4341             See also C and C.
4342              
4343             SV* sv_newmortal()','name' => 'sv_newmortal'},'SvOOK' => {'text' => 'Returns a U32 indicating whether the pointer to the string buffer is offset.
4344             This hack is used internally to speed up removal of characters from the
4345             beginning of a SvPV. When SvOOK is true, then the start of the
4346             allocated string buffer is actually C bytes before SvPVX.
4347             This offset used to be stored in SvIVX, but is now stored within the spare
4348             part of the buffer.
4349              
4350             U32 SvOOK(SV* sv)','name' => 'SvOOK'},'SvPV_set' => {'text' => 'Set the value of the PV pointer in C to the C-terminated string
4351             C. See also C.
4352              
4353             Beware that the existing pointer may be involved in copy-on-write or other
4354             mischief, so do C and use C or
4355             C (or check the SvIsCOW flag) first to make sure this
4356             modification is safe.
4357              
4358             void SvPV_set(SV* sv, char* val)','name' => 'SvPV_set'},'mess_sv' => {'text' => 'Expands a message, intended for the user, to include an indication of
4359             the current location in the code, if the message does not already appear
4360             to be complete.
4361              
4362             C is the initial message or object. If it is a reference, it
4363             will be used as-is and will be the result of this function. Otherwise it
4364             is used as a string, and if it already ends with a newline, it is taken
4365             to be complete, and the result of this function will be the same string.
4366             If the message does not end with a newline, then a segment such as C
4367             foo.pl line 37> will be appended, and possibly other clauses indicating
4368             the current state of execution. The resulting message will end with a
4369             dot and a newline.
4370              
4371             Normally, the resulting message is returned in a new mortal SV.
4372             During global destruction a single SV may be shared between uses of this
4373             function. If C is true, then the function is permitted (but not
4374             required) to modify and return C instead of allocating a new SV.
4375              
4376             SV * mess_sv(SV *basemsg, bool consume)','name' => 'mess_sv'},'hv_clear' => {'text' => 'Frees the all the elements of a hash, leaving it empty.
4377             The XS equivalent of C<%hash = ()>. See also L.
4378              
4379             If any destructors are triggered as a result, the hv itself may
4380             be freed.
4381              
4382             void hv_clear(HV *hv)','name' => 'hv_clear'},'get_hv' => {'text' => 'Returns the HV of the specified Perl hash. C are passed to
4383             C. If C is set and the
4384             Perl variable does not exist then it will be created. If C is zero
4385             and the variable does not exist then NULL is returned.
4386              
4387             NOTE: the perl_ form of this function is deprecated.
4388              
4389             HV* get_hv(const char *name, I32 flags)','name' => 'get_hv'},'safesysrealloc' => {'text' => '','name' => 'safesysrealloc'},'XSRETURN_YES' => {'text' => 'Return C<&PL_sv_yes> from an XSUB immediately. Uses C.
4390              
4391             XSRETURN_YES;','name' => 'XSRETURN_YES'},'PoisonNew' => {'text' => 'PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
4392              
4393             void PoisonNew(void* dest, int nitems, type)','name' => 'PoisonNew'},'op_scope' => {'text' => 'NOTE: this function is experimental and may change or be
4394             removed without notice.
4395              
4396              
4397             Wraps up an op tree with some additional ops so that at runtime a dynamic
4398             scope will be created. The original ops run in the new dynamic scope,
4399             and then, provided that they exit normally, the scope will be unwound.
4400             The additional ops used to create and unwind the dynamic scope will
4401             normally be an C/C pair, but a C op may be used
4402             instead if the ops are simple enough to not need the full dynamic scope
4403             structure.
4404              
4405             OP * op_scope(OP *o)','name' => 'op_scope'},'Renewc' => {'text' => 'The XSUB-writer\'s interface to the C C function, with
4406             cast.
4407              
4408             Memory obtained by this should B be freed with L<"Safefree">.
4409              
4410             void Renewc(void* ptr, int nitems, type, cast)','name' => 'Renewc'},'sv_nv' => {'text' => 'A private implementation of the C macro for compilers which can\'t
4411             cope with complex macro expressions. Always use the macro instead.
4412              
4413             NV sv_nv(SV* sv)','name' => 'sv_nv'},'PUSHu' => {'text' => 'Push an unsigned integer onto the stack. The stack must have room for this
4414             element. Handles \'set\' magic. Uses C, so C or C
4415             should be called to declare it. Do not call multiple C-oriented
4416             macros to return lists from XSUB\'s - see C instead. See also
4417             C and C.
4418              
4419             void PUSHu(UV uv)','name' => 'PUSHu'},'SvPOK_off' => {'text' => 'Unsets the PV status of an SV.
4420              
4421             void SvPOK_off(SV* sv)','name' => 'SvPOK_off'},'newSVsv' => {'text' => 'Creates a new SV which is an exact duplicate of the original SV.
4422             (Uses C.)
4423              
4424             SV* newSVsv(SV *const old)','name' => 'newSVsv'},'hv_magic' => {'text' => 'Adds magic to a hash. See C.
4425              
4426             void hv_magic(HV *hv, GV *gv, int how)','name' => 'hv_magic'},'deb_nocontext' => {'text' => '','name' => 'deb_nocontext'},'new_stackinfo' => {'text' => '','name' => 'new_stackinfo'},'save_aelem' => {'text' => '','name' => 'save_aelem'},'PerlIO_clearerr' => {'text' => '','name' => 'PerlIO_clearerr'},'cx_dump' => {'text' => '','name' => 'cx_dump'},'SVt_PVIO' => {'text' => 'Type flag for I/O objects. See L.','name' => 'SVt_PVIO'},'XCPT_TRY_END' => {'text' => 'Ends a try block. See L.','name' => 'XCPT_TRY_END'},'HeKEY' => {'text' => 'Returns the actual pointer stored in the key slot of the hash entry. The
4427             pointer may be either C or C, depending on the value of
4428             C. Can be assigned to. The C or C macros are
4429             usually preferable for finding the value of a key.
4430              
4431             void* HeKEY(HE* he)','name' => 'HeKEY'},'SvEND' => {'text' => 'Returns a pointer to the spot just after the last character in
4432             the string which is in the SV, where there is usually a trailing
4433             C character (even though Perl scalars do not strictly require it).
4434             See C. Access the character as *(SvEND(sv)).
4435              
4436             Warning: If C is equal to C, then C points to
4437             unallocated memory.
4438              
4439             char* SvEND(SV* sv)','name' => 'SvEND'},'save_delete' => {'text' => '','name' => 'save_delete'},'GIMME_V' => {'text' => 'The XSUB-writer\'s equivalent to Perl\'s C. Returns C,
4440             C or C for void, scalar or list context,
4441             respectively. See L for a usage example.
4442              
4443             U32 GIMME_V','name' => 'GIMME_V'},'re_compile' => {'text' => '','name' => 're_compile'},'sv_setsv_flags' => {'text' => 'Copies the contents of the source SV C into the destination SV
4444             C. The source SV may be destroyed if it is mortal, so don\'t use this
4445             function if the source SV needs to be reused. Does not handle \'set\' magic.
4446             Loosely speaking, it performs a copy-by-value, obliterating any previous
4447             content of the destination.
4448             If the C parameter has the C bit set, will C on
4449             C if appropriate, else not. If the C
4450             parameter has the C bit set then the
4451             buffers of temps will not be stolen.
4452             and C are implemented in terms of this function.
4453              
4454             You probably want to use one of the assortment of wrappers, such as
4455             C, C, C and
4456             C.
4457              
4458             This is the primary function for copying scalars, and most other
4459             copy-ish functions and macros use this underneath.
4460              
4461             void sv_setsv_flags(SV *dstr, SV *sstr,
4462             const I32 flags)','name' => 'sv_setsv_flags'},'gv_init_pvn' => {'text' => 'Converts a scalar into a typeglob. This is an incoercible typeglob;
4463             assigning a reference to it will assign to one of its slots, instead of
4464             overwriting it as happens with typeglobs created by SvSetSV. Converting
4465             any scalar that is SvOK() may produce unpredictable results and is reserved
4466             for perl\'s internal use.
4467              
4468             C is the scalar to be converted.
4469              
4470             C is the parent stash/package, if any.
4471              
4472             C and C give the name. The name must be unqualified;
4473             that is, it must not include the package name. If C is a
4474             stash element, it is the caller\'s responsibility to ensure that the name
4475             passed to this function matches the name of the element. If it does not
4476             match, perl\'s internal bookkeeping will get out of sync.
4477              
4478             C can be set to SVf_UTF8 if C is a UTF8 string, or
4479             the return value of SvUTF8(sv). It can also take the
4480             GV_ADDMULTI flag, which means to pretend that the GV has been
4481             seen before (i.e., suppress "Used once" warnings).
4482              
4483             void gv_init_pvn(GV* gv, HV* stash, const char* name,
4484             STRLEN len, U32 flags)','name' => 'gv_init_pvn'},'newATTRSUB' => {'text' => '','name' => 'newATTRSUB'},'gv_fetchmeth_sv' => {'text' => 'Exactly like L, but takes the name string in the form
4485             of an SV instead of a string/length pair.
4486              
4487             GV* gv_fetchmeth_sv(HV* stash, SV* namesv,
4488             I32 level, U32 flags)','name' => 'gv_fetchmeth_sv'},'Copy' => {'text' => 'The XSUB-writer\'s interface to the C C function. The C is the
4489             source, C is the destination, C is the number of items, and
4490             C is the type. May fail on overlapping copies. See also C.
4491              
4492             void Copy(void* src, void* dest, int nitems, type)','name' => 'Copy'},'newSVpv_share' => {'text' => 'Like C, but takes a C-terminated string instead of a
4493             string/length pair.
4494              
4495             SV* newSVpv_share(const char* s, U32 hash)','name' => 'newSVpv_share'},'sv_taint' => {'text' => 'Taint an SV. Use C instead.
4496              
4497             void sv_taint(SV* sv)','name' => 'sv_taint'},'utf16_to_utf8' => {'text' => '','name' => 'utf16_to_utf8'},'SvIOK_notUV' => {'text' => 'Returns a boolean indicating whether the SV contains a signed integer.
4498              
4499             bool SvIOK_notUV(SV* sv)','name' => 'SvIOK_notUV'},'deb' => {'text' => '','name' => 'deb'},'PL_parser-Elinestart' => {'text' => 'NOTE: this function is experimental and may change or be
4500             removed without notice.
4501              
4502              
4503             Points to the start of the current line inside the lexer buffer.
4504             This is useful for indicating at which column an error occurred, and
4505             not much else. This must be updated by any lexing code that consumes
4506             a newline; the function L handles this detail.','name' => 'PL_parser-Elinestart'},'is_safe_syscall' => {'text' => 'Test that the given C doesn\'t contain any internal C characters.
4507             If it does, set C to ENOENT, optionally warn, and return FALSE.
4508              
4509             Return TRUE if the name is safe.
4510              
4511             Used by the IS_SAFE_SYSCALL() macro.
4512              
4513             bool is_safe_syscall(const char *pv, STRLEN len,
4514             const char *what,
4515             const char *op_name)','name' => 'is_safe_syscall'},'pad_add_name_pvn' => {'text' => 'Allocates a place in the currently-compiling pad for a named lexical
4516             variable. Stores the name and other metadata in the name part of the
4517             pad, and makes preparations to manage the variable\'s lexical scoping.
4518             Returns the offset of the allocated pad slot.
4519              
4520             I/I specify the variable\'s name, including leading sigil.
4521             If I is non-null, the name is for a typed lexical, and this
4522             identifies the type. If I is non-null, it\'s a lexical reference
4523             to a package variable, and this identifies the package. The following
4524             flags can be OR\'ed together:
4525              
4526             padadd_OUR redundantly specifies if it\'s a package var
4527             padadd_STATE variable will retain value persistently
4528             padadd_NO_DUP_CHECK skip check for lexical shadowing
4529              
4530             PADOFFSET pad_add_name_pvn(const char *namepv,
4531             STRLEN namelen, U32 flags,
4532             HV *typestash, HV *ourstash)','name' => 'pad_add_name_pvn'},'he_dup' => {'text' => '','name' => 'he_dup'},'gv_fullname3' => {'text' => '','name' => 'gv_fullname3'},'OP_TYPE_IS_OR_WAS' => {'text' => 'Returns true if the given OP is not a NULL pointer and
4533             if it is of the given type or used to be before being
4534             replaced by an OP of type OP_NULL.
4535              
4536             The negation of this macro, C
4537             is also available as well as C
4538             and C which elide
4539             the NULL pointer check.
4540              
4541             bool OP_TYPE_IS_OR_WAS(OP *o, Optype type)','name' => 'OP_TYPE_IS_OR_WAS'},'SVt_PVNV' => {'text' => 'Type flag for scalars. See L.','name' => 'SVt_PVNV'},'mPUSHu' => {'text' => 'Push an unsigned integer onto the stack. The stack must have room for this
4542             element. Does not use C. See also C, C and C.
4543              
4544             void mPUSHu(UV uv)','name' => 'mPUSHu'},'gv_fetchmeth_pvn' => {'text' => 'Returns the glob with the given C and a defined subroutine or
4545             C. The glob lives in the given C, or in the stashes
4546             accessible via @ISA and UNIVERSAL::.
4547              
4548             The argument C should be either 0 or -1. If C, as a
4549             side-effect creates a glob with the given C in the given C
4550             which in the case of success contains an alias for the subroutine, and sets
4551             up caching info for this glob.
4552              
4553             The only significant values for C are GV_SUPER and SVf_UTF8.
4554              
4555             GV_SUPER indicates that we want to look up the method in the superclasses
4556             of the C.
4557              
4558             The
4559             GV returned from C may be a method cache entry, which is not
4560             visible to Perl code. So when calling C, you should not use
4561             the GV directly; instead, you should use the method\'s CV, which can be
4562             obtained from the GV with the C macro.
4563              
4564             GV* gv_fetchmeth_pvn(HV* stash, const char* name,
4565             STRLEN len, I32 level,
4566             U32 flags)','name' => 'gv_fetchmeth_pvn'},'cophh_new_empty' => {'text' => 'NOTE: this function is experimental and may change or be
4567             removed without notice.
4568              
4569              
4570             Generate and return a fresh cop hints hash containing no entries.
4571              
4572             COPHH * cophh_new_empty()','name' => 'cophh_new_empty'},'sv_derived_from_pvn' => {'text' => 'Returns a boolean indicating whether the SV is derived from the specified class
4573             I. To check derivation at the Perl level, call C as a
4574             normal Perl method.
4575              
4576             Currently, the only significant value for C is SVf_UTF8.
4577              
4578             bool sv_derived_from_pvn(SV* sv,
4579             const char *const name,
4580             const STRLEN len, U32 flags)','name' => 'sv_derived_from_pvn'},'op_append_list' => {'text' => 'Concatenate the lists of ops contained directly within two list-type ops,
4581             returning the combined list. I and I are the list-type ops
4582             to concatenate. I specifies the intended opcode for the list.
4583             If either I or I is not already a list of the right type,
4584             it will be upgraded into one. If either I or I is null,
4585             the other is returned unchanged.
4586              
4587             OP * op_append_list(I32 optype, OP *first, OP *last)','name' => 'op_append_list'},'repeatcpy' => {'text' => '','name' => 'repeatcpy'},'do_spawn_nowait' => {'text' => '','name' => 'do_spawn_nowait'},'sv_setsv_nomg' => {'text' => 'Like C but doesn\'t process magic.
4588              
4589             void sv_setsv_nomg(SV* dsv, SV* ssv)','name' => 'sv_setsv_nomg'},'load_module_nocontext' => {'text' => '','name' => 'load_module_nocontext'},'re_intuit_string' => {'text' => '','name' => 're_intuit_string'},'do_magic_dump' => {'text' => '','name' => 'do_magic_dump'},'HvNAMELEN' => {'text' => 'Returns the length of the stash\'s name.
4590              
4591             STRLEN HvNAMELEN(HV *stash)','name' => 'HvNAMELEN'},'XPUSHp' => {'text' => 'Push a string onto the stack, extending the stack if necessary. The C
4592             indicates the length of the string. Handles \'set\' magic. Uses C, so
4593             C or C should be called to declare it. Do not call
4594             multiple C-oriented macros to return lists from XSUB\'s - see
4595             C instead. See also C and C.
4596              
4597             void XPUSHp(char* str, STRLEN len)','name' => 'XPUSHp'},'av_create_and_push' => {'text' => 'NOTE: this function is experimental and may change or be
4598             removed without notice.
4599              
4600              
4601             Push an SV onto the end of the array, creating the array if necessary.
4602             A small internal helper function to remove a commonly duplicated idiom.
4603              
4604             void av_create_and_push(AV **const avp,
4605             SV *const val)','name' => 'av_create_and_push'},'sv_utf8_encode' => {'text' => 'Converts the PV of an SV to UTF-8, but then turns the C
4606             flag off so that it looks like octets again.
4607              
4608             void sv_utf8_encode(SV *const sv)','name' => 'sv_utf8_encode'},'SvUTF8_on' => {'text' => 'Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
4609             Do not use frivolously.
4610              
4611             void SvUTF8_on(SV *sv)','name' => 'SvUTF8_on'},'sv_does_pv' => {'text' => 'Like L, but takes a nul-terminated string instead of an SV.
4612              
4613             bool sv_does_pv(SV* sv, const char *const name,
4614             U32 flags)','name' => 'sv_does_pv'},'sv_setpvn_mg' => {'text' => 'Like C, but also handles \'set\' magic.
4615              
4616             void sv_setpvn_mg(SV *const sv,
4617             const char *const ptr,
4618             const STRLEN len)','name' => 'sv_setpvn_mg'},'toLOWER' => {'text' => 'Converts the specified character to lowercase. If the input is anything but an
4619             ASCII uppercase character, that input character itself is returned. Variant
4620             C is equivalent.
4621              
4622             U8 toLOWER(U8 ch)','name' => 'toLOWER'},'PadlistNAMESMAX' => {'text' => 'NOTE: this function is experimental and may change or be
4623             removed without notice.
4624              
4625              
4626             The index of the last pad name.
4627              
4628             SSize_t PadlistNAMESMAX(PADLIST padlist)','name' => 'PadlistNAMESMAX'},'av_iter_p' => {'text' => '','name' => 'av_iter_p'},'prescan_version' => {'text' => 'Validate that a given string can be parsed as a version object, but doesn\'t
4629             actually perform the parsing. Can use either strict or lax validation rules.
4630             Can optionally set a number of hint variables to save the parsing code
4631             some time when tokenizing.
4632              
4633             const char* prescan_version(const char *s, bool strict,
4634             const char** errstr,
4635             bool *sqv,
4636             int *ssaw_decimal,
4637             int *swidth, bool *salpha)','name' => 'prescan_version'},'PerlIO_write' => {'text' => '','name' => 'PerlIO_write'},'hv_ksplit' => {'text' => '','name' => 'hv_ksplit'},'new_version' => {'text' => 'Returns a new version object based on the passed in SV:
4638              
4639             SV *sv = new_version(SV *ver);
4640              
4641             Does not alter the passed in ver SV. See "upg_version" if you
4642             want to upgrade the SV.
4643              
4644             SV* new_version(SV *ver)','name' => 'new_version'},'PerlIO_seek' => {'text' => '','name' => 'PerlIO_seek'},'free_tmps' => {'text' => '','name' => 'free_tmps'},'parse_arithexpr' => {'text' => 'NOTE: this function is experimental and may change or be
4645             removed without notice.
4646              
4647              
4648             Parse a Perl arithmetic expression. This may contain operators of precedence
4649             down to the bit shift operators. The expression must be followed (and thus
4650             terminated) either by a comparison or lower-precedence operator or by
4651             something that would normally terminate an expression such as semicolon.
4652             If I includes C then the expression is optional,
4653             otherwise it is mandatory. It is up to the caller to ensure that the
4654             dynamic parser state (L et al) is correctly set to reflect
4655             the source of the code to be parsed and the lexical context for the
4656             expression.
4657              
4658             The op tree representing the expression is returned. If an optional
4659             expression is absent, a null pointer is returned, otherwise the pointer
4660             will be non-null.
4661              
4662             If an error occurs in parsing or compilation, in most cases a valid op
4663             tree is returned anyway. The error is reflected in the parser state,
4664             normally resulting in a single exception at the top level of parsing
4665             which covers all the compilation errors that occurred. Some compilation
4666             errors, however, will throw an exception immediately.
4667              
4668             OP * parse_arithexpr(U32 flags)','name' => 'parse_arithexpr'},'Nullav' => {'text' => 'Null AV pointer.
4669              
4670             (deprecated - use C<(AV *)NULL> instead)','name' => 'Nullav'},'sv_pvbyten' => {'text' => 'A private implementation of the C macro for compilers
4671             which can\'t cope with complex macro expressions. Always use the macro
4672             instead.
4673              
4674             char* sv_pvbyten(SV *sv, STRLEN *lp)','name' => 'sv_pvbyten'},'isOCTAL' => {'text' => 'Returns a boolean indicating whether the specified character is an
4675             octal digit, [0-7].
4676             The only two variants are C and C; each is identical to
4677             C.
4678              
4679             bool isOCTAL(char ch)','name' => 'isOCTAL'},'rsignal' => {'text' => '','name' => 'rsignal'},'sv_pv' => {'text' => 'Use the C macro instead
4680              
4681             char* sv_pv(SV *sv)','name' => 'sv_pv'},'perl_alloc_using' => {'text' => '','name' => 'perl_alloc_using'},'pv_pretty' => {'text' => 'Converts a string into something presentable, handling escaping via
4682             pv_escape() and supporting quoting and ellipses.
4683              
4684             If the PERL_PV_PRETTY_QUOTE flag is set then the result will be
4685             double quoted with any double quotes in the string escaped. Otherwise
4686             if the PERL_PV_PRETTY_LTGT flag is set then the result be wrapped in
4687             angle brackets.
4688              
4689             If the PERL_PV_PRETTY_ELLIPSES flag is set and not all characters in
4690             string were output then an ellipsis C<...> will be appended to the
4691             string. Note that this happens AFTER it has been quoted.
4692              
4693             If start_color is non-null then it will be inserted after the opening
4694             quote (if there is one) but before the escaped text. If end_color
4695             is non-null then it will be inserted after the escaped text but before
4696             any quotes or ellipses.
4697              
4698             Returns a pointer to the prettified text as held by dsv.
4699              
4700             char* pv_pretty(SV *dsv, char const * const str,
4701             const STRLEN count, const STRLEN max,
4702             char const * const start_color,
4703             char const * const end_color,
4704             const U32 flags)','name' => 'pv_pretty'},'sv_setnv_mg' => {'text' => 'Like C, but also handles \'set\' magic.
4705              
4706             void sv_setnv_mg(SV *const sv, const NV num)','name' => 'sv_setnv_mg'},'utf8_to_bytes' => {'text' => 'NOTE: this function is experimental and may change or be
4707             removed without notice.
4708              
4709              
4710             Converts a string C of length C from UTF-8 into native byte encoding.
4711             Unlike L, this over-writes the original string, and
4712             updates C to contain the new length.
4713             Returns zero on failure, setting C to -1.
4714              
4715             If you need a copy of the string, see L.
4716              
4717             U8* utf8_to_bytes(U8 *s, STRLEN *len)','name' => 'utf8_to_bytes'},'sv_setref_pvs' => {'text' => 'Like C, but takes a literal string instead of a
4718             string/length pair.
4719              
4720             SV * sv_setref_pvs(const char* s)','name' => 'sv_setref_pvs'},'re_dup_guts' => {'text' => '','name' => 're_dup_guts'},'si_dup' => {'text' => '','name' => 'si_dup'},'uvuni_to_utf8_flags' => {'text' => 'Instead you almost certainly want to use L or
4721             L>.
4722              
4723             This function is a deprecated synonym for L,
4724             which itself, while not deprecated, should be used only in isolated
4725             circumstances. These functions were useful for code that wanted to handle
4726             both EBCDIC and ASCII platforms with Unicode properties, but starting in Perl
4727             v5.20, the distinctions between the platforms have mostly been made invisible
4728             to most code, so this function is quite unlikely to be what you want.
4729              
4730             U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)','name' => 'uvuni_to_utf8_flags'},'PL_rpeepp' => {'text' => 'Pointer to the recursive peephole optimiser. This is a function
4731             that gets called at the end of compilation of a Perl subroutine (or
4732             equivalently independent piece of Perl code) to perform fixups of some
4733             ops and to perform small-scale optimisations. The function is called
4734             once for each chain of ops linked through their C fields;
4735             it is recursively called to handle each side chain. It is passed, as
4736             sole parameter, a pointer to the op that is at the head of the chain.
4737             It modifies the op tree in place.
4738              
4739             The peephole optimiser should never be completely replaced. Rather,
4740             add code to it by wrapping the existing optimiser. The basic way to do
4741             this can be seen in L.
4742             If the new code wishes to operate only on ops at a subroutine\'s top level,
4743             rather than throughout the structure, it is likely to be more convenient
4744             to wrap the L hook.
4745              
4746             peep_t PL_rpeepp','name' => 'PL_rpeepp'},'G_DISCARD' => {'text' => 'Indicates that arguments returned from a callback should be discarded. See
4747             L.','name' => 'G_DISCARD'},'newGVREF' => {'text' => '','name' => 'newGVREF'},'XST_mNV' => {'text' => 'Place a double into the specified position C on the stack. The value
4748             is stored in a new mortal SV.
4749              
4750             void XST_mNV(int pos, NV nv)','name' => 'XST_mNV'},'UNDERBAR' => {'text' => 'The SV* corresponding to the $_ variable. Works even if there
4751             is a lexical $_ in scope.','name' => 'UNDERBAR'},'newSVOP' => {'text' => 'Constructs, checks, and returns an op of any type that involves an
4752             embedded SV. I is the opcode. I gives the eight bits
4753             of C. I gives the SV to embed in the op; this function
4754             takes ownership of one reference to it.
4755              
4756             OP * newSVOP(I32 type, I32 flags, SV *sv)','name' => 'newSVOP'},'cophh_fetch_pvn' => {'text' => 'NOTE: this function is experimental and may change or be
4757             removed without notice.
4758              
4759              
4760             Look up the entry in the cop hints hash I with the key specified by
4761             I and I. If I has the C bit set,
4762             the key octets are interpreted as UTF-8, otherwise they are interpreted
4763             as Latin-1. I is a precomputed hash of the key string, or zero if
4764             it has not been precomputed. Returns a mortal scalar copy of the value
4765             associated with the key, or C<&PL_sv_placeholder> if there is no value
4766             associated with the key.
4767              
4768             SV * cophh_fetch_pvn(const COPHH *cophh,
4769             const char *keypv,
4770             STRLEN keylen, U32 hash,
4771             U32 flags)','name' => 'cophh_fetch_pvn'},'pad_sv' => {'text' => 'Get the value at offset I in the current (compiling or executing) pad.
4772             Use macro PAD_SV instead of calling this function directly.
4773              
4774             SV * pad_sv(PADOFFSET po)','name' => 'pad_sv'},'amagic_call' => {'text' => '','name' => 'amagic_call'},'op_free' => {'text' => 'Free an op. Only use this when an op is no longer linked to from any
4775             optree.
4776              
4777             void op_free(OP *o)','name' => 'op_free'},'PadnameLEN' => {'text' => 'NOTE: this function is experimental and may change or be
4778             removed without notice.
4779              
4780              
4781             The length of the name.
4782              
4783             STRLEN PadnameLEN(PADNAME pn)','name' => 'PadnameLEN'},'SvPVutf8_force' => {'text' => 'Like C, but converts sv to utf8 first if necessary.
4784              
4785             char* SvPVutf8_force(SV* sv, STRLEN len)','name' => 'SvPVutf8_force'},'gv_AVadd' => {'text' => '','name' => 'gv_AVadd'},'pop_scope' => {'text' => '','name' => 'pop_scope'},'SVt_NV' => {'text' => 'Type flag for scalars. See L.','name' => 'SVt_NV'},'my_popen_list' => {'text' => '','name' => 'my_popen_list'},'sv_2uv' => {'text' => '','name' => 'sv_2uv'},'PUSHMARK' => {'text' => 'Opening bracket for arguments on a callback. See C and
4786             L.
4787              
4788             void PUSHMARK(SP)','name' => 'PUSHMARK'},'taint_proper' => {'text' => '','name' => 'taint_proper'},'save_generic_pvref' => {'text' => '','name' => 'save_generic_pvref'},'ST' => {'text' => 'Used to access elements on the XSUB\'s stack.
4789              
4790             SV* ST(int ix)','name' => 'ST'},'call_pv' => {'text' => 'Performs a callback to the specified Perl sub. See L.
4791              
4792             NOTE: the perl_ form of this function is deprecated.
4793              
4794             I32 call_pv(const char* sub_name, I32 flags)','name' => 'call_pv'},'gv_fetchmeth_autoload' => {'text' => 'This is the old form of L, which has no flags
4795             parameter.
4796              
4797             GV* gv_fetchmeth_autoload(HV* stash,
4798             const char* name,
4799             STRLEN len, I32 level)','name' => 'gv_fetchmeth_autoload'},'save_mortalizesv' => {'text' => '','name' => 'save_mortalizesv'},'sv_pos_b2u' => {'text' => 'Converts the value pointed to by offsetp from a count of bytes from the
4800             start of the string, to a count of the equivalent number of UTF-8 chars.
4801             Handles magic and type coercion.
4802              
4803             Use C in preference, which correctly handles strings
4804             longer than 2Gb.
4805              
4806             void sv_pos_b2u(SV *const sv, I32 *const offsetp)','name' => 'sv_pos_b2u'},'sv_utf8_upgrade_flags_grow' => {'text' => 'Like sv_utf8_upgrade_flags, but has an additional parameter C, which is
4807             the number of unused bytes the string of \'sv\' is guaranteed to have free after
4808             it upon return. This allows the caller to reserve extra space that it intends
4809             to fill, to avoid extra grows.
4810              
4811             C, C, and C
4812             are implemented in terms of this function.
4813              
4814             Returns the number of bytes in the converted string (not including the spares).
4815              
4816             STRLEN sv_utf8_upgrade_flags_grow(SV *const sv,
4817             const I32 flags,
4818             STRLEN extra)','name' => 'sv_utf8_upgrade_flags_grow'},'SVt_IV' => {'text' => 'Type flag for scalars. See L.','name' => 'SVt_IV'},'SvIsCOW' => {'text' => 'Returns a U32 value indicating whether the SV is Copy-On-Write (either shared
4819             hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
4820             COW).
4821              
4822             U32 SvIsCOW(SV* sv)','name' => 'SvIsCOW'},'reentrant_size' => {'text' => '','name' => 'reentrant_size'},'printf_nocontext' => {'text' => '','name' => 'printf_nocontext'},'save_freesv' => {'text' => '','name' => 'save_freesv'},'sv_catsv' => {'text' => 'Concatenates the string from SV C onto the end of the string in SV
4823             C. If C is null, does nothing; otherwise modifies only C.
4824             Handles \'get\' magic on both SVs, but no \'set\' magic. See C and
4825             C.
4826              
4827             void sv_catsv(SV *dstr, SV *sstr)','name' => 'sv_catsv'},'SvPOK_on' => {'text' => 'Tells an SV that it is a string.
4828              
4829             void SvPOK_on(SV* sv)','name' => 'SvPOK_on'},'ax' => {'text' => 'Variable which is setup by C to indicate the stack base offset,
4830             used by the C, C and C macros. The C macro
4831             must be called prior to setup the C variable.
4832              
4833             I32 ax','name' => 'ax'},'regexec_flags' => {'text' => '','name' => 'regexec_flags'},'pad_add_name_sv' => {'text' => 'Exactly like L, but takes the name string in the form
4834             of an SV instead of a string/length pair.
4835              
4836             PADOFFSET pad_add_name_sv(SV *name, U32 flags,
4837             HV *typestash, HV *ourstash)','name' => 'pad_add_name_sv'},'to_utf8_upper' => {'text' => 'Instead use L.
4838              
4839             UV to_utf8_upper(const U8 *p, U8* ustrp,
4840             STRLEN *lenp)','name' => 'to_utf8_upper'},'newSVpadname' => {'text' => 'NOTE: this function is experimental and may change or be
4841             removed without notice.
4842              
4843              
4844             Creates a new SV containing the pad name. This is currently identical
4845             to C, but pad names may cease being SVs at some point, so
4846             C is preferable.
4847              
4848             SV* newSVpadname(PADNAME *pn)','name' => 'newSVpadname'},'SvPVutf8x_force' => {'text' => 'Like C, but converts sv to utf8 first if necessary.
4849             Guarantees to evaluate sv only once; use the more efficient C
4850             otherwise.
4851              
4852             char* SvPVutf8x_force(SV* sv, STRLEN len)','name' => 'SvPVutf8x_force'},'warner_nocontext' => {'text' => '','name' => 'warner_nocontext'},'sv_eq_flags' => {'text' => 'Returns a boolean indicating whether the strings in the two SVs are
4853             identical. Is UTF-8 and \'use bytes\' aware and coerces its args to strings
4854             if necessary. If the flags include SV_GMAGIC, it handles get-magic, too.
4855              
4856             I32 sv_eq_flags(SV* sv1, SV* sv2, const U32 flags)','name' => 'sv_eq_flags'},'PUSHi' => {'text' => 'Push an integer onto the stack. The stack must have room for this element.
4857             Handles \'set\' magic. Uses C, so C or C should be
4858             called to declare it. Do not call multiple C-oriented macros to
4859             return lists from XSUB\'s - see C instead. See also C and
4860             C.
4861              
4862             void PUSHi(IV iv)','name' => 'PUSHi'},'SvLEN_set' => {'text' => 'Set the actual length of the string which is in the SV. See C.
4863              
4864             void SvLEN_set(SV* sv, STRLEN len)','name' => 'SvLEN_set'},'to_utf8_lower' => {'text' => 'Instead use L.
4865              
4866             UV to_utf8_lower(const U8 *p, U8* ustrp,
4867             STRLEN *lenp)','name' => 'to_utf8_lower'},'gv_init_pv' => {'text' => 'Same as gv_init_pvn(), but takes a nul-terminated string for the name
4868             instead of separate char * and length parameters.
4869              
4870             void gv_init_pv(GV* gv, HV* stash, const char* name,
4871             U32 flags)','name' => 'gv_init_pv'},'newSVpvf' => {'text' => 'Creates a new SV and initializes it with the string formatted like
4872             C.
4873              
4874             SV* newSVpvf(const char *const pat, ...)','name' => 'newSVpvf'},'doing_taint' => {'text' => '','name' => 'doing_taint'},'save_I8' => {'text' => '','name' => 'save_I8'},'Newxc' => {'text' => 'The XSUB-writer\'s interface to the C C function, with
4875             cast. See also C.
4876              
4877             Memory obtained by this should B be freed with L<"Safefree">.
4878              
4879             void Newxc(void* ptr, int nitems, type, cast)','name' => 'Newxc'},'lex_stuff_pvs' => {'text' => 'NOTE: this function is experimental and may change or be
4880             removed without notice.
4881              
4882              
4883             Like L, but takes a literal string instead of a
4884             string/length pair.
4885              
4886             void lex_stuff_pvs(const char *pv, U32 flags)','name' => 'lex_stuff_pvs'},'perl_destruct' => {'text' => 'Shuts down a Perl interpreter. See L.
4887              
4888             int perl_destruct(PerlInterpreter *my_perl)','name' => 'perl_destruct'},'SvIVX' => {'text' => 'Returns the raw value in the SV\'s IV slot, without checks or conversions.
4889             Only use when you are sure SvIOK is true. See also C.
4890              
4891             IV SvIVX(SV* sv)','name' => 'SvIVX'},'custom_op_name' => {'text' => 'Return the name for a given custom op. This was once used by the OP_NAME
4892             macro, but is no longer: it has only been kept for compatibility, and
4893             should not be used.
4894              
4895             const char * custom_op_name(const OP *o)','name' => 'custom_op_name'},'sv_vsetpvf' => {'text' => 'Works like C but copies the text into the SV instead of
4896             appending it. Does not handle \'set\' magic. See C.
4897              
4898             Usually used via its frontend C.
4899              
4900             void sv_vsetpvf(SV *const sv, const char *const pat,
4901             va_list *const args)','name' => 'sv_vsetpvf'},'any_dup' => {'text' => '','name' => 'any_dup'},'XCPT_CATCH' => {'text' => 'Introduces a catch block. See L.','name' => 'XCPT_CATCH'},'regclass_swash' => {'text' => '','name' => 'regclass_swash'},'my_dirfd' => {'text' => '','name' => 'my_dirfd'},'XST_mYES' => {'text' => 'Place C<&PL_sv_yes> into the specified position C on the
4902             stack.
4903              
4904             void XST_mYES(int pos)','name' => 'XST_mYES'},'SvIOK_off' => {'text' => 'Unsets the IV status of an SV.
4905              
4906             void SvIOK_off(SV* sv)','name' => 'SvIOK_off'},'sv_setsv' => {'text' => 'Copies the contents of the source SV C into the destination SV
4907             C. The source SV may be destroyed if it is mortal, so don\'t use this
4908             function if the source SV needs to be reused. Does not handle \'set\' magic on
4909             destination SV. Calls \'get\' magic on source SV. Loosely speaking, it
4910             performs a copy-by-value, obliterating any previous content of the
4911             destination.
4912              
4913             You probably want to use one of the assortment of wrappers, such as
4914             C, C, C and
4915             C.
4916              
4917             void sv_setsv(SV *dstr, SV *sstr)','name' => 'sv_setsv'},'PerlIO_stdin' => {'text' => '','name' => 'PerlIO_stdin'},'toTITLE' => {'text' => 'Converts the specified character to titlecase. If the input is anything but an
4918             ASCII lowercase character, that input character itself is returned. Variant
4919             C is equivalent. (There is no C for the full Latin1 range,
4920             as the full generality of L is needed there. Titlecase is not a
4921             concept used in locale handling, so there is no functionality for that.)
4922              
4923             U8 toTITLE(U8 ch)','name' => 'toTITLE'},'READ_XDIGIT' => {'text' => 'Returns the value of an ASCII-range hex digit and advances the string pointer.
4924             Behaviour is only well defined when isXDIGIT(*str) is true.
4925              
4926             U8 READ_XDIGIT(char str*)','name' => 'READ_XDIGIT'},'ix' => {'text' => 'Variable which is setup by C to indicate which of an
4927             XSUB\'s aliases was used to invoke it. See L.
4928              
4929             I32 ix','name' => 'ix'},'XSRETURN_UV' => {'text' => 'Return an integer from an XSUB immediately. Uses C.
4930              
4931             void XSRETURN_UV(IV uv)','name' => 'XSRETURN_UV'},'SvREFCNT_inc_simple' => {'text' => 'Same as SvREFCNT_inc, but can only be used with expressions without side
4932             effects. Since we don\'t have to store a temporary value, it\'s faster.
4933              
4934             SV* SvREFCNT_inc_simple(SV* sv)','name' => 'SvREFCNT_inc_simple'},'XopENTRYCUSTOM' => {'text' => 'Exactly like C but more
4935             efficient. The I parameter is identical to L.
4936              
4937             XopENTRYCUSTOM(const OP *o, which)','name' => 'XopENTRYCUSTOM'},'my_lstat' => {'text' => '','name' => 'my_lstat'},'my_atof' => {'text' => '','name' => 'my_atof'},'savestack_grow_cnt' => {'text' => '','name' => 'savestack_grow_cnt'},'PL_comppad_name' => {'text' => 'NOTE: this function is experimental and may change or be
4938             removed without notice.
4939              
4940              
4941             During compilation, this points to the array containing the names part
4942             of the pad for the currently-compiling code.','name' => 'PL_comppad_name'},'SvTRUE_nomg' => {'text' => 'Returns a boolean indicating whether Perl would evaluate the SV as true or
4943             false. See SvOK() for a defined/undefined test. Does not handle \'get\' magic.
4944              
4945             bool SvTRUE_nomg(SV* sv)','name' => 'SvTRUE_nomg'},'vverify' => {'text' => 'Validates that the SV contains valid internal structure for a version object.
4946             It may be passed either the version object (RV) or the hash itself (HV). If
4947             the structure is valid, it returns the HV. If the structure is invalid,
4948             it returns NULL.
4949              
4950             SV *hv = vverify(sv);
4951              
4952             Note that it only confirms the bare minimum structure (so as not to get
4953             confused by derived classes which may contain additional hash entries):
4954              
4955             SV* vverify(SV *vs)','name' => 'vverify'},'dXSI32' => {'text' => 'Sets up the C variable for an XSUB which has aliases. This is usually
4956             handled automatically by C.
4957              
4958             dXSI32;','name' => 'dXSI32'},'dXCPT' => {'text' => 'Set up necessary local variables for exception handling.
4959             See L.
4960              
4961             dXCPT;','name' => 'dXCPT'},'sv_tainted' => {'text' => 'Test an SV for taintedness. Use C instead.
4962              
4963             bool sv_tainted(SV *const sv)','name' => 'sv_tainted'},'mro_set_private_data' => {'text' => '','name' => 'mro_set_private_data'},'do_gv_dump' => {'text' => '','name' => 'do_gv_dump'},'reg_named_buff_nextkey' => {'text' => '','name' => 'reg_named_buff_nextkey'},'hv_fill' => {'text' => 'Returns the number of hash buckets that
4964             happen to be in use. This function is
4965             wrapped by the macro C.
4966              
4967             Previously this value was always stored in the HV structure, which created an
4968             overhead on every hash (and pretty much every object) for something that was
4969             rarely used. Now we calculate it on demand the first
4970             time that it is needed, and cache it if that calculation
4971             is going to be costly to repeat. The cached
4972             value is updated by insertions and deletions, but (currently) discarded if
4973             the hash is split.
4974              
4975             STRLEN hv_fill(HV *const hv)','name' => 'hv_fill'},'cv_const_sv' => {'text' => 'If C is a constant sub eligible for inlining, returns the constant
4976             value returned by the sub. Otherwise, returns NULL.
4977              
4978             Constant subs can be created with C or as described in
4979             L.
4980              
4981             SV* cv_const_sv(const CV *const cv)','name' => 'cv_const_sv'},'pad_add_name_pvs' => {'text' => 'Exactly like L, but takes a literal string instead
4982             of a string/length pair.
4983              
4984             PADOFFSET pad_add_name_pvs(const char *name, U32 flags,
4985             HV *typestash, HV *ourstash)','name' => 'pad_add_name_pvs'},'newSVnv' => {'text' => 'Creates a new SV and copies a floating point value into it.
4986             The reference count for the SV is set to 1.
4987              
4988             SV* newSVnv(const NV n)','name' => 'newSVnv'},'HeVAL' => {'text' => 'Returns the value slot (type C)
4989             stored in the hash entry. Can be assigned
4990             to.
4991              
4992             SV *foo= HeVAL(hv);
4993             HeVAL(hv)= sv;
4994              
4995              
4996             SV* HeVAL(HE* he)','name' => 'HeVAL'},'HePV' => {'text' => 'Returns the key slot of the hash entry as a C value, doing any
4997             necessary dereferencing of possibly C keys. The length of the string
4998             is placed in C (this is a macro, so do I use C<&len>). If you do
4999             not care about what the length of the key is, you may use the global
5000             variable C, though this is rather less efficient than using a local
5001             variable. Remember though, that hash keys in perl are free to contain
5002             embedded nulls, so using C or similar is not a good way to find
5003             the length of hash keys. This is very similar to the C macro
5004             described elsewhere in this document. See also C.
5005              
5006             If you are using C to get values to pass to C to create a
5007             new SV, you should consider using C as it is more
5008             efficient.
5009              
5010             char* HePV(HE* he, STRLEN len)','name' => 'HePV'},'hv_free_ent' => {'text' => '','name' => 'hv_free_ent'},'isIDCONT' => {'text' => 'Returns a boolean indicating whether the specified character can be the
5011             second or succeeding character of an identifier. This is very close to, but
5012             not quite the same as the official Unicode property C. The
5013             difference is that this returns true only if the input character also matches
5014             L. See the L for an
5015             explanation of variants C, C, C,
5016             C, C, C, and
5017             C.
5018              
5019             bool isIDCONT(char ch)','name' => 'isIDCONT'},'toLOWER_L1' => {'text' => 'Converts the specified Latin1 character to lowercase. The results are undefined if
5020             the input doesn\'t fit in a byte.
5021              
5022             U8 toLOWER_L1(U8 ch)','name' => 'toLOWER_L1'},'SvGETMAGIC' => {'text' => 'Invokes C on an SV if it has \'get\' magic. For example, this
5023             will call C on a tied variable. This macro evaluates its
5024             argument more than once.
5025              
5026             void SvGETMAGIC(SV* sv)','name' => 'SvGETMAGIC'},'PL_parser' => {'text' => 'Pointer to a structure encapsulating the state of the parsing operation
5027             currently in progress. The pointer can be locally changed to perform
5028             a nested parse without interfering with the state of an outer parse.
5029             Individual members of C have their own documentation.','name' => 'PL_parser'},'pv_uni_display' => {'text' => 'Build to the scalar C a displayable version of the string C,
5030             length C, the displayable version being at most C bytes long
5031             (if longer, the rest is truncated and "..." will be appended).
5032              
5033             The C argument can have UNI_DISPLAY_ISPRINT set to display
5034             isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
5035             to display the \\\\[nrfta\\\\] as the backslashed versions (like \'\\n\')
5036             (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\\\).
5037             UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
5038             UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
5039              
5040             The pointer to the PV of the C is returned.
5041              
5042             char* pv_uni_display(SV *dsv, const U8 *spv,
5043             STRLEN len, STRLEN pvlim,
5044             UV flags)','name' => 'pv_uni_display'},'init_stacks' => {'text' => '','name' => 'init_stacks'},'sv_inc' => {'text' => 'Auto-increment of the value in the SV, doing string to numeric conversion
5045             if necessary. Handles \'get\' magic and operator overloading.
5046              
5047             void sv_inc(SV *const sv)','name' => 'sv_inc'},'SvPVbytex_force' => {'text' => 'Like C, but converts sv to byte representation first if necessary.
5048             Guarantees to evaluate sv only once; use the more efficient C
5049             otherwise.
5050              
5051             char* SvPVbytex_force(SV* sv, STRLEN len)','name' => 'SvPVbytex_force'},'op_prepend_elem' => {'text' => 'Prepend an item to the list of ops contained directly within a list-type
5052             op, returning the lengthened list. I is the op to prepend to the
5053             list, and I is the list-type op. I specifies the intended
5054             opcode for the list. If I is not already a list of the right type,
5055             it will be upgraded into one. If either I or I is null,
5056             the other is returned unchanged.
5057              
5058             OP * op_prepend_elem(I32 optype, OP *first, OP *last)','name' => 'op_prepend_elem'},'hv_delete' => {'text' => 'Deletes a key/value pair in the hash. The value\'s SV is removed from
5059             the hash, made mortal, and returned to the caller. The absolute
5060             value of C is the length of the key. If C is negative the
5061             key is assumed to be in UTF-8-encoded Unicode. The C value
5062             will normally be zero; if set to G_DISCARD then NULL will be returned.
5063             NULL will also be returned if the key is not found.
5064              
5065             SV* hv_delete(HV *hv, const char *key, I32 klen,
5066             I32 flags)','name' => 'hv_delete'},'pad_add_name_pv' => {'text' => 'Exactly like L, but takes a nul-terminated string
5067             instead of a string/length pair.
5068              
5069             PADOFFSET pad_add_name_pv(const char *name, U32 flags,
5070             HV *typestash, HV *ourstash)','name' => 'pad_add_name_pv'},'POP_MULTICALL' => {'text' => 'Closing bracket for a lightweight callback.
5071             See L.
5072              
5073             POP_MULTICALL;','name' => 'POP_MULTICALL'},'sv_cat_decode' => {'text' => 'The encoding is assumed to be an Encode object, the PV of the ssv is
5074             assumed to be octets in that encoding and decoding the input starts
5075             from the position which (PV + *offset) pointed to. The dsv will be
5076             concatenated the decoded UTF-8 string from ssv. Decoding will terminate
5077             when the string tstr appears in decoding output or the input ends on
5078             the PV of the ssv. The value which the offset points will be modified
5079             to the last input position on the ssv.
5080              
5081             Returns TRUE if the terminator was found, else returns FALSE.
5082              
5083             bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv,
5084             int *offset, char* tstr, int tlen)','name' => 'sv_cat_decode'},'SvIV_set' => {'text' => 'Set the value of the IV pointer in sv to val. It is possible to perform
5085             the same function of this macro with an lvalue assignment to C.
5086             With future Perls, however, it will be more efficient to use
5087             C instead of the lvalue assignment to C.
5088              
5089             void SvIV_set(SV* sv, IV val)','name' => 'SvIV_set'},'sv_setiv' => {'text' => 'Copies an integer into the given SV, upgrading first if necessary.
5090             Does not handle \'set\' magic. See also C.
5091              
5092             void sv_setiv(SV *const sv, const IV num)','name' => 'sv_setiv'},'gv_efullname' => {'text' => '','name' => 'gv_efullname'},'sv_report_used' => {'text' => 'Dump the contents of all SVs not yet freed (debugging aid).
5093              
5094             void sv_report_used()','name' => 'sv_report_used'},'save_sptr' => {'text' => '','name' => 'save_sptr'},'sv_vcatpvfn_flags' => {'text' => 'Processes its arguments like C and appends the formatted output
5095             to an SV. Uses an array of SVs if the C style variable argument list is
5096             missing (NULL). When running with taint checks enabled, indicates via
5097             C if results are untrustworthy (often due to the use of
5098             locales).
5099              
5100             If called as C or flags include C, calls get magic.
5101              
5102             Usually used via one of its frontends C and C.
5103              
5104             void sv_vcatpvfn_flags(SV *const sv,
5105             const char *const pat,
5106             const STRLEN patlen,
5107             va_list *const args,
5108             SV **const svargs,
5109             const I32 svmax,
5110             bool *const maybe_tainted,
5111             const U32 flags)','name' => 'sv_vcatpvfn_flags'},'SvNVX' => {'text' => 'Returns the raw value in the SV\'s NV slot, without checks or conversions.
5112             Only use when you are sure SvNOK is true. See also C.
5113              
5114             NV SvNVX(SV* sv)','name' => 'SvNVX'},'do_open' => {'text' => '','name' => 'do_open'},'regnext' => {'text' => '','name' => 'regnext'},'HeHASH' => {'text' => 'Returns the computed hash stored in the hash entry.
5115              
5116             U32 HeHASH(HE* he)','name' => 'HeHASH'},'SvIOK' => {'text' => 'Returns a U32 value indicating whether the SV contains an integer.
5117              
5118             U32 SvIOK(SV* sv)','name' => 'SvIOK'},'newANONHASH' => {'text' => '','name' => 'newANONHASH'},'PadnameSV' => {'text' => 'NOTE: this function is experimental and may change or be
5119             removed without notice.
5120              
5121              
5122             Returns the pad name as an SV. This is currently just C. It will
5123             begin returning a new mortal SV if pad names ever stop being SVs.
5124              
5125             SV * PadnameSV(PADNAME pn)','name' => 'PadnameSV'},'is_utf8_char_buf' => {'text' => 'Returns the number of bytes that comprise the first UTF-8 encoded character in
5126             buffer C. C should point to one position beyond the end of the
5127             buffer. 0 is returned if C does not point to a complete, valid UTF-8
5128             encoded character.
5129              
5130             Note that an INVARIANT character (i.e. ASCII on non-EBCDIC
5131             machines) is a valid UTF-8 character.
5132              
5133             STRLEN is_utf8_char_buf(const U8 *buf,
5134             const U8 *buf_end)','name' => 'is_utf8_char_buf'},'SvPV_force' => {'text' => 'Like C but will force the SV into containing a string (C), and
5135             only a string (C), by hook or by crook. You need force if you are
5136             going to update the C directly. Processes get magic.
5137              
5138             Note that coercing an arbitrary scalar into a plain PV will potentially
5139             strip useful data from it. For example if the SV was C, then the
5140             referent will have its reference count decremented, and the SV itself may
5141             be converted to an C scalar with a string buffer containing a value
5142             such as C<"ARRAY(0x1234)">.
5143              
5144             char* SvPV_force(SV* sv, STRLEN len)','name' => 'SvPV_force'},'HeUTF8' => {'text' => 'Returns whether the C value returned by C is encoded in UTF-8,
5145             doing any necessary dereferencing of possibly C keys. The value returned
5146             will be 0 or non-0, not necessarily 1 (or even a value with any low bits set),
5147             so B blindly assign this to a C variable, as C may be a
5148             typedef for C.
5149              
5150             U32 HeUTF8(HE* he)','name' => 'HeUTF8'},'newRANGE' => {'text' => 'Constructs and returns a C op, with subordinate C and
5151             C ops. I gives the eight bits of C for the
5152             C op and, shifted up eight bits, the eight bits of C
5153             for both the C and C ops, except that the bit with value
5154             1 is automatically set. I and I supply the expressions
5155             controlling the endpoints of the range; they are consumed by this function
5156             and become part of the constructed op tree.
5157              
5158             OP * newRANGE(I32 flags, OP *left, OP *right)','name' => 'newRANGE'},'isCNTRL' => {'text' => 'Returns a boolean indicating whether the specified character is a
5159             control character, analogous to C.
5160             See the L for an explanation of variants
5161             C, C, C, C, C,
5162             C, and C
5163             On EBCDIC platforms, you almost always want to use the C variant.
5164              
5165             bool isCNTRL(char ch)','name' => 'isCNTRL'},'PadlistNAMESARRAY' => {'text' => 'NOTE: this function is experimental and may change or be
5166             removed without notice.
5167              
5168              
5169             The C array of pad names.
5170              
5171             PADNAME ** PadlistNAMESARRAY(PADLIST padlist)','name' => 'PadlistNAMESARRAY'},'cophh_delete_pvn' => {'text' => 'NOTE: this function is experimental and may change or be
5172             removed without notice.
5173              
5174              
5175             Delete a key and its associated value from the cop hints hash I,
5176             and returns the modified hash. The returned hash pointer is in general
5177             not the same as the hash pointer that was passed in. The input hash is
5178             consumed by the function, and the pointer to it must not be subsequently
5179             used. Use L if you need both hashes.
5180              
5181             The key is specified by I and I. If I has the
5182             C bit set, the key octets are interpreted as UTF-8,
5183             otherwise they are interpreted as Latin-1. I is a precomputed
5184             hash of the key string, or zero if it has not been precomputed.
5185              
5186             COPHH * cophh_delete_pvn(COPHH *cophh,
5187             const char *keypv,
5188             STRLEN keylen, U32 hash,
5189             U32 flags)','name' => 'cophh_delete_pvn'},'grok_hex' => {'text' => 'converts a string representing a hex number to numeric form.
5190              
5191             On entry I and I<*len_p> give the string to scan, I<*flags> gives
5192             conversion flags, and I should be NULL or a pointer to an NV.
5193             The scan stops at the end of the string, or the first invalid character.
5194             Unless C is set in I<*flags>, encountering an
5195             invalid character will also trigger a warning.
5196             On return I<*len> is set to the length of the scanned string,
5197             and I<*flags> gives output flags.
5198              
5199             If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
5200             and nothing is written to I<*result>. If the value is > UV_MAX C
5201             returns UV_MAX, sets C in the output flags,
5202             and writes the value to I<*result> (or the value is discarded if I
5203             is NULL).
5204              
5205             The hex number may optionally be prefixed with "0x" or "x" unless
5206             C is set in I<*flags> on entry. If
5207             C is set in I<*flags> then the hex
5208             number may use \'_\' characters to separate digits.
5209              
5210             UV grok_hex(const char* start, STRLEN* len_p,
5211             I32* flags, NV *result)','name' => 'grok_hex'},'newRV' => {'text' => '','name' => 'newRV'},'SvLOCK' => {'text' => 'Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
5212             has been loaded.
5213              
5214             void SvLOCK(SV* sv)','name' => 'SvLOCK'},'gv_fetchfile' => {'text' => '','name' => 'gv_fetchfile'},'sv_vsetpvfn' => {'text' => 'Works like C but copies the text into the SV instead of
5215             appending it.
5216              
5217             Usually used via one of its frontends C and C.
5218              
5219             void sv_vsetpvfn(SV *const sv, const char *const pat,
5220             const STRLEN patlen,
5221             va_list *const args,
5222             SV **const svargs, const I32 svmax,
5223             bool *const maybe_tainted)','name' => 'sv_vsetpvfn'},'PerlIO_get_cnt' => {'text' => '','name' => 'PerlIO_get_cnt'},'PerlIO_setlinebuf' => {'text' => '','name' => 'PerlIO_setlinebuf'},'utf16_to_utf8_reversed' => {'text' => '','name' => 'utf16_to_utf8_reversed'},'cast_ulong' => {'text' => '','name' => 'cast_ulong'},'to_utf8_case' => {'text' => 'C

contains the pointer to the UTF-8 string encoding

5224             the character that is being converted. This routine assumes that the character
5225             at C

is well-formed.

5226              
5227             C is a pointer to the character buffer to put the
5228             conversion result to. C is a pointer to the length
5229             of the result.
5230              
5231             C is a pointer to the swash to use.
5232              
5233             Both the special and normal mappings are stored in F,
5234             and loaded by SWASHNEW, using F. C (usually,
5235             but not always, a multicharacter mapping), is tried first.
5236              
5237             C is a string, normally C or C<"">. C means to not use
5238             any special mappings; C<""> means to use the special mappings. Values other
5239             than these two are treated as the name of the hash containing the special
5240             mappings, like C<"utf8::ToSpecLower">.
5241              
5242             C is a string like "ToLower" which means the swash
5243             %utf8::ToLower.
5244              
5245             UV to_utf8_case(const U8 *p, U8* ustrp,
5246             STRLEN *lenp, SV **swashp,
5247             const char *normal,
5248             const char *special)','name' => 'to_utf8_case'},'set_numeric_local' => {'text' => '','name' => 'set_numeric_local'},'calloc' => {'text' => '','name' => 'calloc'},'POPpbytex' => {'text' => 'Pops a string off the stack which must consist of bytes i.e. characters < 256.
5249              
5250             char* POPpbytex','name' => 'POPpbytex'},'cophh_store_sv' => {'text' => 'NOTE: this function is experimental and may change or be
5251             removed without notice.
5252              
5253              
5254             Like L, but takes a Perl scalar instead of a
5255             string/length pair.
5256              
5257             COPHH * cophh_store_sv(const COPHH *cophh, SV *key,
5258             U32 hash, SV *value, U32 flags)','name' => 'cophh_store_sv'},'newPMOP' => {'text' => 'Constructs, checks, and returns an op of any pattern matching type.
5259             I is the opcode. I gives the eight bits of C
5260             and, shifted up eight bits, the eight bits of C.
5261              
5262             OP * newPMOP(I32 type, I32 flags)','name' => 'newPMOP'},'PL_peepp' => {'text' => 'Pointer to the per-subroutine peephole optimiser. This is a function
5263             that gets called at the end of compilation of a Perl subroutine (or
5264             equivalently independent piece of Perl code) to perform fixups of
5265             some ops and to perform small-scale optimisations. The function is
5266             called once for each subroutine that is compiled, and is passed, as sole
5267             parameter, a pointer to the op that is the entry point to the subroutine.
5268             It modifies the op tree in place.
5269              
5270             The peephole optimiser should never be completely replaced. Rather,
5271             add code to it by wrapping the existing optimiser. The basic way to do
5272             this can be seen in L.
5273             If the new code wishes to operate on ops throughout the subroutine\'s
5274             structure, rather than just at the top level, it is likely to be more
5275             convenient to wrap the L hook.
5276              
5277             peep_t PL_peepp','name' => 'PL_peepp'},'SvSetMagicSV' => {'text' => 'Like C, but does any set magic required afterwards.
5278              
5279             void SvSetMagicSV(SV* dsv, SV* ssv)','name' => 'SvSetMagicSV'},'isALPHANUMERIC' => {'text' => 'Returns a boolean indicating whether the specified character is a either an
5280             alphabetic character or decimal digit, analogous to C.
5281             See the L for an explanation of variants
5282             C, C, C,
5283             C, C, C, and
5284             C.
5285              
5286             bool isALPHANUMERIC(char ch)','name' => 'isALPHANUMERIC'},'Move' => {'text' => 'The XSUB-writer\'s interface to the C C function. The C is the
5287             source, C is the destination, C is the number of items, and
5288             C is the type. Can do overlapping moves. See also C.
5289              
5290             void Move(void* src, void* dest, int nitems, type)','name' => 'Move'},'set_context' => {'text' => '','name' => 'set_context'},'sv_catpvn_flags' => {'text' => 'Concatenates the string onto the end of the string which is in the SV. The
5291             C indicates number of bytes to copy. If the SV has the UTF-8
5292             status set, then the bytes appended should be valid UTF-8.
5293             If C has the C bit set, will
5294             C on C afterwards if appropriate.
5295             C and C are implemented
5296             in terms of this function.
5297              
5298             void sv_catpvn_flags(SV *const dstr,
5299             const char *sstr,
5300             const STRLEN len,
5301             const I32 flags)','name' => 'sv_catpvn_flags'},'OP_TYPE_IS' => {'text' => 'Returns true if the given OP is not a NULL pointer
5302             and if it is of the given type.
5303              
5304             The negation of this macro, C is also available
5305             as well as C and C which elide
5306             the NULL pointer check.
5307              
5308             bool OP_TYPE_IS(OP *o, Optype type)','name' => 'OP_TYPE_IS'},'PerlIO_flush' => {'text' => '','name' => 'PerlIO_flush'},'sv_2iv_flags' => {'text' => 'Return the integer value of an SV, doing any necessary string
5309             conversion. If flags includes SV_GMAGIC, does an mg_get() first.
5310             Normally used via the C and C macros.
5311              
5312             IV sv_2iv_flags(SV *const sv, const I32 flags)','name' => 'sv_2iv_flags'},'runops_standard' => {'text' => '','name' => 'runops_standard'},'gv_efullname3' => {'text' => '','name' => 'gv_efullname3'},'newXS' => {'text' => 'Used by C to hook up XSUBs as Perl subs. I needs to be
5313             static storage, as it is used directly as CvFILE(), without a copy being made.','name' => 'newXS'},'XCPT_RETHROW' => {'text' => 'Rethrows a previously caught exception. See L.
5314              
5315             XCPT_RETHROW;','name' => 'XCPT_RETHROW'},'mg_dup' => {'text' => '','name' => 'mg_dup'},'cop_hints_fetch_pvs' => {'text' => 'Like L, but takes a literal string instead of a
5316             string/length pair, and no precomputed hash.
5317              
5318             SV * cop_hints_fetch_pvs(const COP *cop,
5319             const char *key, U32 flags)','name' => 'cop_hints_fetch_pvs'},'cop_store_label' => {'text' => 'NOTE: this function is experimental and may change or be
5320             removed without notice.
5321              
5322              
5323             Save a label into a C.
5324             You need to set flags to C
5325             for a utf-8 label.
5326              
5327             void cop_store_label(COP *const cop,
5328             const char *label, STRLEN len,
5329             U32 flags)','name' => 'cop_store_label'},'PUSHmortal' => {'text' => 'Push a new mortal SV onto the stack. The stack must have room for this
5330             element. Does not use C. See also C, C and C.
5331              
5332             void PUSHmortal()','name' => 'PUSHmortal'},'XS_EXTERNAL' => {'text' => 'Macro to declare an XSUB and its C parameter list explicitly exporting the symbols.','name' => 'XS_EXTERNAL'},'perl_alloc' => {'text' => 'Allocates a new Perl interpreter. See L.
5333              
5334             PerlInterpreter* perl_alloc()','name' => 'perl_alloc'},'sv_dump' => {'text' => 'Dumps the contents of an SV to the C filehandle.
5335              
5336             For an example of its output, see L.
5337              
5338             void sv_dump(SV* sv)','name' => 'sv_dump'},'pad_tidy' => {'text' => 'NOTE: this function is experimental and may change or be
5339             removed without notice.
5340              
5341              
5342             Tidy up a pad at the end of compilation of the code to which it belongs.
5343             Jobs performed here are: remove most stuff from the pads of anonsub
5344             prototypes; give it a @_; mark temporaries as such. I indicates
5345             the kind of subroutine:
5346              
5347             padtidy_SUB ordinary subroutine
5348             padtidy_SUBCLONE prototype for lexical closure
5349             padtidy_FORMAT format
5350              
5351             void pad_tidy(padtidy_type type)','name' => 'pad_tidy'},'OP_DESC' => {'text' => 'Return a short description of the provided OP.
5352              
5353             const char * OP_DESC(OP *o)','name' => 'OP_DESC'},'strLE' => {'text' => 'Test two strings to see if the first, C, is less than or equal to the
5354             second, C. Returns true or false.
5355              
5356             bool strLE(char* s1, char* s2)','name' => 'strLE'},'newSVpvn_flags' => {'text' => 'Creates a new SV and copies a string (which may contain C (C<\\0>)
5357             characters) into it. The reference count for the
5358             SV is set to 1. Note that if C is zero, Perl will create a zero length
5359             string. You are responsible for ensuring that the source string is at least
5360             C bytes long. If the C argument is NULL the new SV will be undefined.
5361             Currently the only flag bits accepted are C and C.
5362             If C is set, then C is called on the result before
5363             returning. If C is set, C
5364             is considered to be in UTF-8 and the
5365             C flag will be set on the new SV.
5366             C is a convenience wrapper for this function, defined as
5367              
5368             #define newSVpvn_utf8(s, len, u) \\
5369             newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
5370              
5371             SV* newSVpvn_flags(const char *const s,
5372             const STRLEN len,
5373             const U32 flags)','name' => 'newSVpvn_flags'},'XopFLAGS' => {'text' => 'Return the XOP\'s flags.
5374              
5375             U32 XopFLAGS(XOP *xop)','name' => 'XopFLAGS'},'SvOK' => {'text' => 'Returns a U32 value indicating whether the value is defined. This is
5376             only meaningful for scalars.
5377              
5378             U32 SvOK(SV* sv)','name' => 'SvOK'},'sv_setref_nv' => {'text' => 'Copies a double into a new SV, optionally blessing the SV. The C
5379             argument will be upgraded to an RV. That RV will be modified to point to
5380             the new SV. The C argument indicates the package for the
5381             blessing. Set C to C to avoid the blessing. The new SV
5382             will have a reference count of 1, and the RV will be returned.
5383              
5384             SV* sv_setref_nv(SV *const rv,
5385             const char *const classname,
5386             const NV nv)','name' => 'sv_setref_nv'},'lex_stuff_pvn' => {'text' => 'NOTE: this function is experimental and may change or be
5387             removed without notice.
5388              
5389              
5390             Insert characters into the lexer buffer (Llinestr>),
5391             immediately after the current lexing point (Lbufptr>),
5392             reallocating the buffer if necessary. This means that lexing code that
5393             runs later will see the characters as if they had appeared in the input.
5394             It is not recommended to do this as part of normal parsing, and most
5395             uses of this facility run the risk of the inserted characters being
5396             interpreted in an unintended manner.
5397              
5398             The string to be inserted is represented by I octets starting
5399             at I. These octets are interpreted as either UTF-8 or Latin-1,
5400             according to whether the C flag is set in I.
5401             The characters are recoded for the lexer buffer, according to how the
5402             buffer is currently being interpreted (L). If a string
5403             to be inserted is available as a Perl scalar, the L
5404             function is more convenient.
5405              
5406             void lex_stuff_pvn(const char *pv, STRLEN len,
5407             U32 flags)','name' => 'lex_stuff_pvn'},'eval_pv' => {'text' => 'Tells Perl to C the given string and return an SV* result.
5408              
5409             NOTE: the perl_ form of this function is deprecated.
5410              
5411             SV* eval_pv(const char* p, I32 croak_on_error)','name' => 'eval_pv'},'sv_usepvn_flags' => {'text' => 'Tells an SV to use C to find its string value. Normally the
5412             string is stored inside the SV, but sv_usepvn allows the SV to use an
5413             outside string. The C should point to memory that was allocated
5414             by L. It must be
5415             the start of a Newx-ed block of memory, and not a pointer to the
5416             middle of it (beware of L and copy-on-write),
5417             and not be from a non-Newx memory allocator like C. The
5418             string length, C, must be supplied. By default this function
5419             will C (i.e. realloc, move) the memory pointed to by C,
5420             so that pointer should not be freed or used by the programmer after
5421             giving it to sv_usepvn, and neither should any pointers from "behind"
5422             that pointer (e.g. ptr + 1) be used.
5423              
5424             If C & SV_SMAGIC is true, will call SvSETMAGIC. If C &
5425             SV_HAS_TRAILING_NUL is true, then C must be C, and the realloc
5426             will be skipped (i.e. the buffer is actually at least 1 byte longer than
5427             C, and already meets the requirements for storing in C).
5428              
5429             void sv_usepvn_flags(SV *const sv, char* ptr,
5430             const STRLEN len,
5431             const U32 flags)','name' => 'sv_usepvn_flags'},'hv_assert' => {'text' => 'Check that a hash is in an internally consistent state.
5432              
5433             void hv_assert(HV *hv)','name' => 'hv_assert'},'my_vsnprintf' => {'text' => 'The C library C if available and standards-compliant.
5434             However, if if the C is not available, will unfortunately
5435             use the unsafe C which can overrun the buffer (there is an
5436             overrun check, but that may be too late). Consider using
5437             C instead, or getting C.
5438              
5439             int my_vsnprintf(char *buffer, const Size_t len,
5440             const char *format, va_list ap)','name' => 'my_vsnprintf'},'sv_free' => {'text' => 'Decrement an SV\'s reference count, and if it drops to zero, call
5441             C to invoke destructors and free up any memory used by
5442             the body; finally, deallocate the SV\'s head itself.
5443             Normally called via a wrapper macro C.
5444              
5445             void sv_free(SV *const sv)','name' => 'sv_free'},'die_nocontext' => {'text' => '','name' => 'die_nocontext'},'hv_eiter_p' => {'text' => '','name' => 'hv_eiter_p'},'SvPVbyte_force' => {'text' => 'Like C, but converts sv to byte representation first if necessary.
5446              
5447             char* SvPVbyte_force(SV* sv, STRLEN len)','name' => 'SvPVbyte_force'},'av_pop' => {'text' => 'Removes one SV from the end of the array, reducing its size by one and
5448             returning the SV (transferring control of one reference count) to the
5449             caller. Returns C<&PL_sv_undef> if the array is empty.
5450              
5451             Perl equivalent: C
5452              
5453             SV* av_pop(AV *av)','name' => 'av_pop'},'reg_named_buff_exists' => {'text' => '','name' => 'reg_named_buff_exists'},'save_bool' => {'text' => '','name' => 'save_bool'},'ckwarn_d' => {'text' => '','name' => 'ckwarn_d'},'croak' => {'text' => 'This is an XS interface to Perl\'s C function.
5454              
5455             Take a sprintf-style format pattern and argument list. These are used to
5456             generate a string message. If the message does not end with a newline,
5457             then it will be extended with some indication of the current location
5458             in the code, as described for L.
5459              
5460             The error message will be used as an exception, by default
5461             returning control to the nearest enclosing C, but subject to
5462             modification by a C<$SIG{__DIE__}> handler. In any case, the C
5463             function never returns normally.
5464              
5465             For historical reasons, if C is null then the contents of C
5466             (C<$@>) will be used as an error message or object instead of building an
5467             error message from arguments. If you want to throw a non-string object,
5468             or build an error message in an SV yourself, it is preferable to use
5469             the L function, which does not involve clobbering C.
5470              
5471             void croak(const char *pat, ...)','name' => 'croak'},'save_freepv' => {'text' => '','name' => 'save_freepv'},'THIS' => {'text' => 'Variable which is setup by C to designate the object in a C++
5472             XSUB. This is always the proper type for the C++ object. See C and
5473             L.
5474              
5475             (whatever) THIS','name' => 'THIS'},'XSRETURN' => {'text' => 'Return from XSUB, indicating number of items on the stack. This is usually
5476             handled by C.
5477              
5478             void XSRETURN(int nitems)','name' => 'XSRETURN'},'dump_indent' => {'text' => '','name' => 'dump_indent'},'screaminstr' => {'text' => '','name' => 'screaminstr'},'op_append_elem' => {'text' => 'Append an item to the list of ops contained directly within a list-type
5479             op, returning the lengthened list. I is the list-type op,
5480             and I is the op to append to the list. I specifies the
5481             intended opcode for the list. If I is not already a list of the
5482             right type, it will be upgraded into one. If either I or I
5483             is null, the other is returned unchanged.
5484              
5485             OP * op_append_elem(I32 optype, OP *first, OP *last)','name' => 'op_append_elem'},'lex_read_unichar' => {'text' => 'NOTE: this function is experimental and may change or be
5486             removed without notice.
5487              
5488              
5489             Reads the next (Unicode) character in the text currently being lexed.
5490             Returns the codepoint (unsigned integer value) of the character read,
5491             and moves Lbufptr> past the character, or returns -1
5492             if lexing has reached the end of the input text. To non-destructively
5493             examine the next character, use L instead.
5494              
5495             If the next character is in (or extends into) the next chunk of input
5496             text, the next chunk will be read in. Normally the current chunk will be
5497             discarded at the same time, but if I includes C
5498             then the current chunk will not be discarded.
5499              
5500             If the input is being interpreted as UTF-8 and a UTF-8 encoding error
5501             is encountered, an exception is generated.
5502              
5503             I32 lex_read_unichar(U32 flags)','name' => 'lex_read_unichar'},'reginitcolors' => {'text' => '','name' => 'reginitcolors'},'get_av' => {'text' => 'Returns the AV of the specified Perl global or package array with the given
5504             name (so it won\'t work on lexical variables). C are passed
5505             to C. If C is set and the
5506             Perl variable does not exist then it will be created. If C is zero
5507             and the variable does not exist then NULL is returned.
5508              
5509             Perl equivalent: C<@{"$name"}>.
5510              
5511             NOTE: the perl_ form of this function is deprecated.
5512              
5513             AV* get_av(const char *name, I32 flags)','name' => 'get_av'},'sv_2pv_nolen' => {'text' => 'Like C, but doesn\'t return the length too. You should usually
5514             use the macro wrapper C instead.
5515              
5516             char* sv_2pv_nolen(SV* sv)','name' => 'sv_2pv_nolen'},'op_contextualize' => {'text' => 'Applies a syntactic context to an op tree representing an expression.
5517             I is the op tree, and I must be C, C,
5518             or C to specify the context to apply. The modified op tree
5519             is returned.
5520              
5521             OP * op_contextualize(OP *o, I32 context)','name' => 'op_contextualize'},'PoisonFree' => {'text' => 'PoisonWith(0xEF) for catching access to freed memory.
5522              
5523             void PoisonFree(void* dest, int nitems, type)','name' => 'PoisonFree'},'gv_SVadd' => {'text' => '','name' => 'gv_SVadd'},'hv_common' => {'text' => '','name' => 'hv_common'},'XopENTRY' => {'text' => 'Return a member of the XOP structure. I is a cpp token
5524             indicating which entry to return. If the member is not set
5525             this will return a default value. The return type depends
5526             on I. This macro evaluates its arguments more than
5527             once. If you are using C to retreive a
5528             C from a C, use the more efficient L instead.
5529              
5530             XopENTRY(XOP *xop, which)','name' => 'XopENTRY'},'newSVREF' => {'text' => '','name' => 'newSVREF'},'toUPPER' => {'text' => 'Converts the specified character to uppercase. If the input is anything but an
5531             ASCII lowercase character, that input character itself is returned. Variant
5532             C is equivalent.
5533              
5534             U8 toUPPER(U8 ch)','name' => 'toUPPER'},'sv_catpvs_flags' => {'text' => 'Like C, but takes a literal C-terminated string instead
5535             of a string/length pair.
5536              
5537             void sv_catpvs_flags(SV* sv, const char* s,
5538             I32 flags)','name' => 'sv_catpvs_flags'},'is_lvalue_sub' => {'text' => '','name' => 'is_lvalue_sub'},'is_utf8_string_loc' => {'text' => 'Like L but stores the location of the failure (in the
5539             case of "utf8ness failure") or the location C+C (in the case of
5540             "utf8ness success") in the C.
5541              
5542             See also L() and L().
5543              
5544             bool is_utf8_string_loc(const U8 *s, STRLEN len,
5545             const U8 **ep)','name' => 'is_utf8_string_loc'},'sv_gets' => {'text' => 'Get a line from the filehandle and store it into the SV, optionally
5546             appending to the currently-stored string. If C is not 0, the
5547             line is appended to the SV instead of overwriting it. C should
5548             be set to the byte offset that the appended string should start at
5549             in the SV (typically, C is a suitable choice).
5550              
5551             char* sv_gets(SV *const sv, PerlIO *const fp,
5552             I32 append)','name' => 'sv_gets'},'GvAV' => {'text' => 'Return the AV from the GV.
5553              
5554             AV* GvAV(GV* gv)','name' => 'GvAV'},'SvSetSV_nosteal' => {'text' => 'Calls a non-destructive version of C if dsv is not the same as
5555             ssv. May evaluate arguments more than once.
5556              
5557             void SvSetSV_nosteal(SV* dsv, SV* ssv)','name' => 'SvSetSV_nosteal'},'pad_add_anon' => {'text' => 'Allocates a place in the currently-compiling pad (via L)
5558             for an anonymous function that is lexically scoped inside the
5559             currently-compiling function.
5560             The function I is linked into the pad, and its C link
5561             to the outer scope is weakened to avoid a reference loop.
5562              
5563             One reference count is stolen, so you may need to do C.
5564              
5565             I should be an opcode indicating the type of operation that the
5566             pad entry is to support. This doesn\'t affect operational semantics,
5567             but is used for debugging.
5568              
5569             PADOFFSET pad_add_anon(CV *func, I32 optype)','name' => 'pad_add_anon'},'dUNDERBAR' => {'text' => 'Sets up any variable needed by the C macro. It used to define
5570             C, but it is currently a noop. However, it is strongly advised
5571             to still use it for ensuring past and future compatibility.
5572              
5573             dUNDERBAR;','name' => 'dUNDERBAR'},'sv_uv' => {'text' => 'A private implementation of the C macro for compilers which can\'t
5574             cope with complex macro expressions. Always use the macro instead.
5575              
5576             UV sv_uv(SV* sv)','name' => 'sv_uv'},'ptr_table_split' => {'text' => '','name' => 'ptr_table_split'},'foldEQ_utf8' => {'text' => 'Returns true if the leading portions of the strings C and C (either or both
5577             of which may be in UTF-8) are the same case-insensitively; false otherwise.
5578             How far into the strings to compare is determined by other input parameters.
5579              
5580             If C is true, the string C is assumed to be in UTF-8-encoded Unicode;
5581             otherwise it is assumed to be in native 8-bit encoding. Correspondingly for C
5582             with respect to C.
5583              
5584             If the byte length C is non-zero, it says how far into C to check for fold
5585             equality. In other words, C+C will be used as a goal to reach. The
5586             scan will not be considered to be a match unless the goal is reached, and
5587             scanning won\'t continue past that goal. Correspondingly for C with respect to
5588             C.
5589              
5590             If C is non-NULL and the pointer it points to is not NULL, that pointer is
5591             considered an end pointer to the position 1 byte past the maximum point
5592             in C beyond which scanning will not continue under any circumstances.
5593             (This routine assumes that UTF-8 encoded input strings are not malformed;
5594             malformed input can cause it to read past C).
5595             This means that if both C and C are specified, and C
5596             is less than C+C, the match will never be successful because it can
5597             never
5598             get as far as its goal (and in fact is asserted against). Correspondingly for
5599             C with respect to C.
5600              
5601             At least one of C and C must have a goal (at least one of C and
5602             C must be non-zero), and if both do, both have to be
5603             reached for a successful match. Also, if the fold of a character is multiple
5604             characters, all of them must be matched (see tr21 reference below for
5605             \'folding\').
5606              
5607             Upon a successful match, if C is non-NULL,
5608             it will be set to point to the beginning of the I character of C
5609             beyond what was matched. Correspondingly for C and C.
5610              
5611             For case-insensitiveness, the "casefolding" of Unicode is used
5612             instead of upper/lowercasing both the characters, see
5613             L (Case Mappings).
5614              
5615             I32 foldEQ_utf8(const char *s1, char **pe1, UV l1,
5616             bool u1, const char *s2, char **pe2,
5617             UV l2, bool u2)','name' => 'foldEQ_utf8'},'Nullch' => {'text' => 'Null character pointer. (No longer available when C is
5618             defined.)','name' => 'Nullch'},'sv_copypv_nomg' => {'text' => 'Like sv_copypv, but doesn\'t invoke get magic first.
5619              
5620             void sv_copypv_nomg(SV *const dsv, SV *const ssv)','name' => 'sv_copypv_nomg'},'get_context' => {'text' => '','name' => 'get_context'},'vcroak' => {'text' => 'This is an XS interface to Perl\'s C function.
5621              
5622             C and C are a sprintf-style format pattern and encapsulated
5623             argument list. These are used to generate a string message. If the
5624             message does not end with a newline, then it will be extended with
5625             some indication of the current location in the code, as described for
5626             L.
5627              
5628             The error message will be used as an exception, by default
5629             returning control to the nearest enclosing C, but subject to
5630             modification by a C<$SIG{__DIE__}> handler. In any case, the C
5631             function never returns normally.
5632              
5633             For historical reasons, if C is null then the contents of C
5634             (C<$@>) will be used as an error message or object instead of building an
5635             error message from arguments. If you want to throw a non-string object,
5636             or build an error message in an SV yourself, it is preferable to use
5637             the L function, which does not involve clobbering C.
5638              
5639             void vcroak(const char *pat, va_list *args)','name' => 'vcroak'},'parse_fullexpr' => {'text' => 'NOTE: this function is experimental and may change or be
5640             removed without notice.
5641              
5642              
5643             Parse a single complete Perl expression. This allows the full
5644             expression grammar, including the lowest-precedence operators such
5645             as C. The expression must be followed (and thus terminated) by a
5646             token that an expression would normally be terminated by: end-of-file,
5647             closing bracketing punctuation, semicolon, or one of the keywords that
5648             signals a postfix expression-statement modifier. If I includes
5649             C then the expression is optional, otherwise it is
5650             mandatory. It is up to the caller to ensure that the dynamic parser
5651             state (L et al) is correctly set to reflect the source of
5652             the code to be parsed and the lexical context for the expression.
5653              
5654             The op tree representing the expression is returned. If an optional
5655             expression is absent, a null pointer is returned, otherwise the pointer
5656             will be non-null.
5657              
5658             If an error occurs in parsing or compilation, in most cases a valid op
5659             tree is returned anyway. The error is reflected in the parser state,
5660             normally resulting in a single exception at the top level of parsing
5661             which covers all the compilation errors that occurred. Some compilation
5662             errors, however, will throw an exception immediately.
5663              
5664             OP * parse_fullexpr(U32 flags)','name' => 'parse_fullexpr'},'sv_magicext' => {'text' => 'Adds magic to an SV, upgrading it if necessary. Applies the
5665             supplied vtable and returns a pointer to the magic added.
5666              
5667             Note that C will allow things that C will not.
5668             In particular, you can add magic to SvREADONLY SVs, and add more than
5669             one instance of the same \'how\'.
5670              
5671             If C is greater than zero then a C I of C is
5672             stored, if C is zero then C is stored as-is and - as another
5673             special case - if C<(name && namlen == HEf_SVKEY)> then C is assumed
5674             to contain an C and is stored as-is with its REFCNT incremented.
5675              
5676             (This is now used as a subroutine by C.)
5677              
5678             MAGIC * sv_magicext(SV *const sv, SV *const obj,
5679             const int how,
5680             const MGVTBL *const vtbl,
5681             const char *const name,
5682             const I32 namlen)','name' => 'sv_magicext'},'gv_fullname4' => {'text' => '','name' => 'gv_fullname4'},'av_push' => {'text' => 'Pushes an SV onto the end of the array. The array will grow automatically
5683             to accommodate the addition. This takes ownership of one reference count.
5684              
5685             Perl equivalent: C.
5686              
5687             void av_push(AV *av, SV *val)','name' => 'av_push'},'XSRETURN_NO' => {'text' => 'Return C<&PL_sv_no> from an XSUB immediately. Uses C.
5688              
5689             XSRETURN_NO;','name' => 'XSRETURN_NO'},'POPn' => {'text' => 'Pops a double off the stack.
5690              
5691             NV POPn','name' => 'POPn'},'newRV_noinc' => {'text' => 'Creates an RV wrapper for an SV. The reference count for the original
5692             SV is B incremented.
5693              
5694             SV* newRV_noinc(SV *const sv)','name' => 'newRV_noinc'},'unsharepvn' => {'text' => '','name' => 'unsharepvn'},'my_memcmp' => {'text' => '','name' => 'my_memcmp'},'newSLICEOP' => {'text' => 'Constructs, checks, and returns an C (list slice) op. I
5695             gives the eight bits of C, except that C will
5696             be set automatically, and, shifted up eight bits, the eight bits of
5697             C, except that the bit with value 1 or 2 is automatically
5698             set as required. I and I supply the parameters of
5699             the slice; they are consumed by this function and become part of the
5700             constructed op tree.
5701              
5702             OP * newSLICEOP(I32 flags, OP *subscript,
5703             OP *listval)','name' => 'newSLICEOP'},'mfree' => {'text' => '','name' => 'mfree'},'save_re_context' => {'text' => '','name' => 'save_re_context'},'hv_iterinit' => {'text' => 'Prepares a starting point to traverse a hash table. Returns the number of
5704             keys in the hash (i.e. the same as C). The return value is
5705             currently only meaningful for hashes without tie magic.
5706              
5707             NOTE: Before version 5.004_65, C used to return the number of
5708             hash buckets that happen to be in use. If you still need that esoteric
5709             value, you can get it through the macro C.
5710              
5711              
5712             I32 hv_iterinit(HV *hv)','name' => 'hv_iterinit'}};};
5713              
5714 1         28 my $self = bless({
5715             'index' => $VAR1,
5716             perl_version => '5.020001',
5717             } => $class);
5718 1         501 return $self;
5719             }
5720              
5721             1;