File Coverage

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

2113             stores that in UTF-8 in C, and its length in bytes in C. Note
2114             that the buffer pointed to by C needs to be at least C
2115             bytes since the uppercase version may be longer than the original character.
2116              
2117             The first code point of the uppercased version is returned
2118             (but note, as explained just above, that there may be more.)
2119              
2120             The input character at C

is assumed to be well-formed.

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

2278             stores that in UTF-8 in C, and its length in bytes in C. Note
2279             that the buffer pointed to by C needs to be at least C
2280             bytes since the lowercase version may be longer than the original character.
2281              
2282             The first code point of the lowercased version is returned
2283             (but note, as explained just above, that there may be more.)
2284              
2285             The input character at C

is assumed to be well-formed.

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

2401             stores that in UTF-8 in C, and its length in bytes in C. Note
2402             that the buffer pointed to by C needs to be at least C
2403             bytes since the foldcase version may be longer than the original character.
2404              
2405             The first code point of the foldcased version is returned
2406             (but note, as explained just above, that there may be more.)
2407              
2408             The input character at C

is assumed to be well-formed.

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

3207             stores that in UTF-8 in C, and its length in bytes in C. Note
3208             that the buffer pointed to by C needs to be at least C
3209             bytes since the titlecase version may be longer than the original character.
3210              
3211             The first code point of the titlecased version is returned
3212             (but note, as explained just above, that there may be more.)
3213              
3214             The input character at C

is assumed to be well-formed.

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

5205             the character that is being converted. This routine assumes that the character
5206             at C

is well-formed.

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