File Coverage

blib/lib/Perl/APIReference/V5_008_006.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_008_006;
2 1     1   7 use strict;
  1         2  
  1         61  
3 1     1   7 use warnings;
  1         2  
  1         51  
4 1     1   8 use parent 'Perl::APIReference';
  1         1  
  1         11  
5              
6             sub new {
7 1     1 1 3 my $class = shift;
8 1         1 my $VAR1;
9              
10 1         3 do{$VAR1 = {'SvOOK' => {'text' => 'Returns a boolean indicating whether the SvIVX is a valid offset value for
  1         1141  
11             the SvPVX. This hack is used internally to speed up removal of characters
12             from the beginning of a SvPV. When SvOOK is true, then the start of the
13             allocated string buffer is really (SvPVX - SvIVX).
14              
15             bool SvOOK(SV* sv)','name' => 'SvOOK'},'hv_store_ent' => {'text' => 'Stores C in a hash. The hash key is specified as C. The C
16             parameter is the precomputed hash value; if it is zero then Perl will
17             compute it. The return value is the new hash entry so created. It will be
18             NULL if the operation failed or if the value did not need to be actually
19             stored within the hash (as in the case of tied hashes). Otherwise the
20             contents of the return value can be accessed using the C macros
21             described here. Note that the caller is responsible for suitably
22             incrementing the reference count of C before the call, and
23             decrementing it if the function returned NULL. Effectively a successful
24             hv_store_ent takes ownership of one reference to C. This is
25             usually what you want; a newly created SV has a reference count of one, so
26             if all your code does is create SVs then store them in a hash, hv_store
27             will own the only reference to the new SV, and your code doesn\'t need to do
28             anything further to tidy up. Note that hv_store_ent only reads the C;
29             unlike C it does not take ownership of it, so maintaining the correct
30             reference count on C is entirely the caller\'s responsibility. hv_store
31             is not implemented as a call to hv_store_ent, and does not create a temporary
32             SV for the key, so if your key data is not already in SV form then use
33             hv_store in preference to hv_store_ent.
34              
35             See L for more
36             information on how to use this function on tied hashes.
37              
38             HE* hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)','name' => 'hv_store_ent'},'gv_stashsv' => {'text' => 'Returns a pointer to the stash for a specified package, which must be a
39             valid UTF-8 string. See C.
40              
41             HV* gv_stashsv(SV* sv, I32 create)','name' => 'gv_stashsv'},'newXSproto' => {'text' => 'Used by C to hook up XSUBs as Perl subs. Adds Perl prototypes to
42             the subs.','name' => 'newXSproto'},'XSRETURN_NV' => {'text' => 'Return a double from an XSUB immediately. Uses C.
43              
44             void XSRETURN_NV(NV nv)','name' => 'XSRETURN_NV'},'strGE' => {'text' => 'Test two strings to see if the first, C, is greater than or equal to
45             the second, C. Returns true or false.
46              
47             bool strGE(char* s1, char* s2)','name' => 'strGE'},'form' => {'text' => 'Takes a sprintf-style format pattern and conventional
48             (non-SV) arguments and returns the formatted string.
49              
50             (char *) Perl_form(pTHX_ const char* pat, ...)
51              
52             can be used any place a string (char *) is required:
53              
54             char * s = Perl_form("%d.%d",major,minor);
55              
56             Uses a single private buffer so if you want to format several strings you
57             must explicitly copy the earlier strings away (and free the copies when you
58             are done).
59              
60             char* form(const char* pat, ...)','name' => 'form'},'SvPV' => {'text' => 'Returns a pointer to the string in the SV, or a stringified form of
61             the SV if the SV does not contain a string. The SV may cache the
62             stringified version becoming C. Handles \'get\' magic. See also
63             C for a version which guarantees to evaluate sv only once.
64              
65             char* SvPV(SV* sv, STRLEN len)','name' => 'SvPV'},'is_utf8_string' => {'text' => 'Returns true if first C bytes of the given string form a valid
66             UTF-8 string, false otherwise. Note that \'a valid UTF-8 string\' does
67             not mean \'a string that contains code points above 0x7F encoded in UTF-8\'
68             because a valid ASCII string is a valid UTF-8 string.
69              
70             bool is_utf8_string(U8 *s, STRLEN len)','name' => 'is_utf8_string'},'svtype' => {'text' => 'An enum of flags for Perl types. These are found in the file B
71             in the C enum. Test these flags with the C macro.','name' => 'svtype'},'hv_clear' => {'text' => 'Clears a hash, making it empty.
72              
73             void hv_clear(HV* tb)','name' => 'hv_clear'},'get_hv' => {'text' => 'Returns the HV of the specified Perl hash. If C is set and the
74             Perl variable does not exist then it will be created. If C is not
75             set and the variable does not exist then NULL is returned.
76              
77             NOTE: the perl_ form of this function is deprecated.
78              
79             HV* get_hv(const char* name, I32 create)','name' => 'get_hv'},'load_module' => {'text' => 'Loads the module whose name is pointed to by the string part of name.
80             Note that the actual module name, not its filename, should be given.
81             Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
82             PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
83             (or 0 for no flags). ver, if specified, provides version semantics
84             similar to C. The optional trailing SV*
85             arguments can be used to specify arguments to the module\'s import()
86             method, similar to C.
87              
88             void load_module(U32 flags, SV* name, SV* ver, ...)','name' => 'load_module'},'XSRETURN_YES' => {'text' => 'Return C<&PL_sv_yes> from an XSUB immediately. Uses C.
89              
90             XSRETURN_YES;','name' => 'XSRETURN_YES'},'sv_nv' => {'text' => 'A private implementation of the C macro for compilers which can\'t
91             cope with complex macro expressions. Always use the macro instead.
92              
93             NV sv_nv(SV* sv)','name' => 'sv_nv'},'Renewc' => {'text' => 'The XSUB-writer\'s interface to the C C function, with
94             cast.
95              
96             void Renewc(void* ptr, int nitems, type, cast)','name' => 'Renewc'},'Poison' => {'text' => 'Fill up memory with a pattern (byte 0xAB over and over again) that
97             hopefully catches attempts to access uninitialized memory.
98              
99             void Poison(void* dest, int nitems, type)','name' => 'Poison'},'sv_insert' => {'text' => 'Inserts a string at the specified offset/length within the SV. Similar to
100             the Perl substr() function.
101              
102             void sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)','name' => 'sv_insert'},'sv_catpvf_mg' => {'text' => 'Like C, but also handles \'set\' magic.
103              
104             void sv_catpvf_mg(SV *sv, const char* pat, ...)','name' => 'sv_catpvf_mg'},'SvPOK_off' => {'text' => 'Unsets the PV status of an SV.
105              
106             void SvPOK_off(SV* sv)','name' => 'SvPOK_off'},'SvPOK' => {'text' => 'Returns a boolean indicating whether the SV contains a character
107             string.
108              
109             bool SvPOK(SV* sv)','name' => 'SvPOK'},'get_sv' => {'text' => 'Returns the SV of the specified Perl scalar. If C is set and the
110             Perl variable does not exist then it will be created. If C is not
111             set and the variable does not exist then NULL is returned.
112              
113             NOTE: the perl_ form of this function is deprecated.
114              
115             SV* get_sv(const char* name, I32 create)','name' => 'get_sv'},'PUSHu' => {'text' => 'Push an unsigned integer onto the stack. The stack must have room for this
116             element. Handles \'set\' magic. Uses C, so C or C
117             should be called to declare it. Do not call multiple C-oriented
118             macros to return lists from XSUB\'s - see C instead. See also
119             C and C.
120              
121             void PUSHu(UV uv)','name' => 'PUSHu'},'sv_vsetpvf_mg' => {'text' => 'Like C, but also handles \'set\' magic.
122              
123             Usually used via its frontend C.
124              
125             void sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args)','name' => 'sv_vsetpvf_mg'},'newSVsv' => {'text' => 'Creates a new SV which is an exact duplicate of the original SV.
126             (Uses C).
127              
128             SV* newSVsv(SV* old)','name' => 'newSVsv'},'hv_magic' => {'text' => 'Adds magic to a hash. See C.
129              
130             void hv_magic(HV* hv, GV* gv, int how)','name' => 'hv_magic'},'SvPVutf8' => {'text' => 'Like C, but converts sv to utf8 first if necessary.
131              
132             char* SvPVutf8(SV* sv, STRLEN len)','name' => 'SvPVutf8'},'sv_setpv_mg' => {'text' => 'Like C, but also handles \'set\' magic.
133              
134             void sv_setpv_mg(SV *sv, const char *ptr)','name' => 'sv_setpv_mg'},'XS' => {'text' => 'Macro to declare an XSUB and its C parameter list. This is handled by
135             C.','name' => 'XS'},'scan_oct' => {'text' => 'For backwards compatibility. Use C instead.
136              
137             NV scan_oct(char* start, STRLEN len, STRLEN* retlen)','name' => 'scan_oct'},'sv_setpvn' => {'text' => 'Copies a string into an SV. The C parameter indicates the number of
138             bytes to be copied. If the C argument is NULL the SV will become
139             undefined. Does not handle \'set\' magic. See C.
140              
141             void sv_setpvn(SV* sv, const char* ptr, STRLEN len)','name' => 'sv_setpvn'},'sv_2mortal' => {'text' => 'Marks an existing SV as mortal. The SV will be destroyed "soon", either
142             by an explicit call to FREETMPS, or by an implicit call at places such as
143             statement boundaries. SvTEMP() is turned on which means that the SV\'s
144             string buffer can be "stolen" if this SV is copied. See also C
145             and C.
146              
147             SV* sv_2mortal(SV* sv)','name' => 'sv_2mortal'},'mg_magical' => {'text' => 'Turns on the magical status of an SV. See C.
148              
149             void mg_magical(SV* sv)','name' => 'mg_magical'},'newSVrv' => {'text' => 'Creates a new SV for the RV, C, to point to. If C is not an RV then
150             it will be upgraded to one. If C is non-null then the new SV will
151             be blessed in the specified package. The new SV is returned and its
152             reference count is 1.
153              
154             SV* newSVrv(SV* rv, const char* classname)','name' => 'newSVrv'},'strnEQ' => {'text' => 'Test two strings to see if they are equal. The C parameter indicates
155             the number of bytes to compare. Returns true or false. (A wrapper for
156             C).
157              
158             bool strnEQ(char* s1, char* s2, STRLEN len)','name' => 'strnEQ'},'av_undef' => {'text' => 'Undefines the array. Frees the memory used by the array itself.
159              
160             void av_undef(AV* ar)','name' => 'av_undef'},'HeKEY' => {'text' => 'Returns the actual pointer stored in the key slot of the hash entry. The
161             pointer may be either C or C, depending on the value of
162             C. Can be assigned to. The C or C macros are
163             usually preferable for finding the value of a key.
164              
165             void* HeKEY(HE* he)','name' => 'HeKEY'},'pack_cat' => {'text' => 'The engine implementing pack() Perl function. Note: parameters next_in_list and
166             flags are not used. This call should not be used; use packlist instead.
167              
168             void pack_cat(SV *cat, char *pat, char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)','name' => 'pack_cat'},'utf8n_to_uvuni' => {'text' => 'Bottom level UTF-8 decode routine.
169             Returns the unicode code point value of the first character in the string C
170             which is assumed to be in UTF-8 encoding and no longer than C;
171             C will be set to the length, in bytes, of that character.
172              
173             If C does not point to a well-formed UTF-8 character, the behaviour
174             is dependent on the value of C: if it contains UTF8_CHECK_ONLY,
175             it is assumed that the caller will raise a warning, and this function
176             will silently just set C to C<-1> and return zero. If the
177             C does not contain UTF8_CHECK_ONLY, warnings about
178             malformations will be given, C will be set to the expected
179             length of the UTF-8 character in bytes, and zero will be returned.
180              
181             The C can also contain various flags to allow deviations from
182             the strict UTF-8 encoding (see F).
183              
184             Most code should use utf8_to_uvchr() rather than call this directly.
185              
186             UV utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)','name' => 'utf8n_to_uvuni'},'sv_cmp' => {'text' => 'Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
187             string in C is less than, equal to, or greater than the string in
188             C. Is UTF-8 and \'use bytes\' aware, handles get magic, and will
189             coerce its args to strings if necessary. See also C.
190              
191             I32 sv_cmp(SV* sv1, SV* sv2)','name' => 'sv_cmp'},'SvNIOK_off' => {'text' => 'Unsets the NV/IV status of an SV.
192              
193             void SvNIOK_off(SV* sv)','name' => 'SvNIOK_off'},'SvEND' => {'text' => 'Returns a pointer to the last character in the string which is in the SV.
194             See C. Access the character as *(SvEND(sv)).
195              
196             char* SvEND(SV* sv)','name' => 'SvEND'},'sv_magic' => {'text' => 'Adds magic to an SV. First upgrades C to type C if necessary,
197             then adds a new magic item of type C to the head of the magic list.
198              
199             See C (which C now calls) for a description of the
200             handling of the C and C arguments.
201              
202             void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)','name' => 'sv_magic'},'mg_free' => {'text' => 'Free any magic storage used by the SV. See C.
203              
204             int mg_free(SV* sv)','name' => 'mg_free'},'GIMME_V' => {'text' => 'The XSUB-writer\'s equivalent to Perl\'s C. Returns C,
205             C or C for void, scalar or list context,
206             respectively.
207              
208             U32 GIMME_V','name' => 'GIMME_V'},'sv_force_normal_flags' => {'text' => 'Undo various types of fakery on an SV: if the PV is a shared string, make
209             a private copy; if we\'re a ref, stop refing; if we\'re a glob, downgrade to
210             an xpvmg. The C parameter gets passed to C
211             when unrefing. C calls this function with flags set to 0.
212              
213             void sv_force_normal_flags(SV *sv, U32 flags)','name' => 'sv_force_normal_flags'},'dMARK' => {'text' => 'Declare a stack marker variable, C, for the XSUB. See C and
214             C.
215              
216             dMARK;','name' => 'dMARK'},'sv_setsv_flags' => {'text' => 'Copies the contents of the source SV C into the destination SV
217             C. The source SV may be destroyed if it is mortal, so don\'t use this
218             function if the source SV needs to be reused. Does not handle \'set\' magic.
219             Loosely speaking, it performs a copy-by-value, obliterating any previous
220             content of the destination.
221             If the C parameter has the C bit set, will C on
222             C if appropriate, else not. If the C parameter has the
223             C bit set then the buffers of temps will not be stolen.
224             and C are implemented in terms of this function.
225              
226             You probably want to use one of the assortment of wrappers, such as
227             C, C, C and
228             C.
229              
230             This is the primary function for copying scalars, and most other
231             copy-ish functions and macros use this underneath.
232              
233             void sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)','name' => 'sv_setsv_flags'},'sv_utf8_upgrade_flags' => {'text' => 'Converts the PV of an SV to its UTF-8-encoded form.
234             Forces the SV to string form if it is not already.
235             Always sets the SvUTF8 flag to avoid future validity checks even
236             if all the bytes have hibit clear. If C has C bit set,
237             will C on C if appropriate, else not. C and
238             C are implemented in terms of this function.
239              
240             This is not as a general purpose byte encoding to Unicode interface:
241             use the Encode extension for that.
242              
243             STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)','name' => 'sv_utf8_upgrade_flags'},'New' => {'text' => 'The XSUB-writer\'s interface to the C C function.
244              
245             void New(int id, void* ptr, int nitems, type)','name' => 'New'},'is_utf8_char' => {'text' => 'Tests if some arbitrary number of bytes begins in a valid UTF-8
246             character. Note that an INVARIANT (i.e. ASCII) character is a valid
247             UTF-8 character. The actual number of bytes in the UTF-8 character
248             will be returned if it is valid, otherwise 0.
249              
250             STRLEN is_utf8_char(U8 *p)','name' => 'is_utf8_char'},'Copy' => {'text' => 'The XSUB-writer\'s interface to the C C function. The C is the
251             source, C is the destination, C is the number of items, and C is
252             the type. May fail on overlapping copies. See also C.
253              
254             void Copy(void* src, void* dest, int nitems, type)','name' => 'Copy'},'ibcmp_utf8' => {'text' => 'Return true if the strings s1 and s2 differ case-insensitively, false
255             if not (if they are equal case-insensitively). If u1 is true, the
256             string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
257             the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
258             are false, the respective string is assumed to be in native 8-bit
259             encoding.
260              
261             If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
262             in there (they will point at the beginning of the I character).
263             If the pointers behind pe1 or pe2 are non-NULL, they are the end
264             pointers beyond which scanning will not continue under any
265             circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
266             s2+l2 will be used as goal end pointers that will also stop the scan,
267             and which qualify towards defining a successful match: all the scans
268             that define an explicit length must reach their goal pointers for
269             a match to succeed).
270              
271             For case-insensitiveness, the "casefolding" of Unicode is used
272             instead of upper/lowercasing both the characters, see
273             http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
274              
275             I32 ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)','name' => 'ibcmp_utf8'},'mXPUSHp' => {'text' => 'Push a string onto the stack, extending the stack if necessary. The C
276             indicates the length of the string. Handles \'set\' magic. Does not use
277             C. See also C, C and C.
278              
279             void mXPUSHp(char* str, STRLEN len)','name' => 'mXPUSHp'},'CvSTASH' => {'text' => 'Returns the stash of the CV.
280              
281             HV* CvSTASH(CV* cv)','name' => 'CvSTASH'},'sv_taint' => {'text' => 'Taint an SV. Use C instead.
282             void sv_taint(SV* sv)','name' => 'sv_taint'},'SvNOK_off' => {'text' => 'Unsets the NV status of an SV.
283              
284             void SvNOK_off(SV* sv)','name' => 'SvNOK_off'},'sv_replace' => {'text' => 'Make the first argument a copy of the second, then delete the original.
285             The target SV physically takes over ownership of the body of the source SV
286             and inherits its flags; however, the target keeps any magic it owns,
287             and any magic in the source is discarded.
288             Note that this is a rather specialist SV copying operation; most of the
289             time you\'ll want to use C or one of its many macro front-ends.
290              
291             void sv_replace(SV* sv, SV* nsv)','name' => 'sv_replace'},'utf8n_to_uvchr' => {'text' => 'Returns the native character value of the first character in the string C
292             which is assumed to be in UTF-8 encoding; C will be set to the
293             length, in bytes, of that character.
294              
295             Allows length and flags to be passed to low level routine.
296              
297             UV utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)','name' => 'utf8n_to_uvchr'},'sv_utf8_upgrade' => {'text' => 'Converts the PV of an SV to its UTF-8-encoded form.
298             Forces the SV to string form if it is not already.
299             Always sets the SvUTF8 flag to avoid future validity checks even
300             if all the bytes have hibit clear.
301              
302             This is not as a general purpose byte encoding to Unicode interface:
303             use the Encode extension for that.
304              
305             STRLEN sv_utf8_upgrade(SV *sv)','name' => 'sv_utf8_upgrade'},'SvIOK_notUV' => {'text' => 'Returns a boolean indicating whether the SV contains a signed integer.
306              
307             bool SvIOK_notUV(SV* sv)','name' => 'SvIOK_notUV'},'G_ARRAY' => {'text' => 'Used to indicate list context. See C, C and
308             L.','name' => 'G_ARRAY'},'dXSARGS' => {'text' => 'Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
309             Sets up the C and C variables by calling C and C.
310             This is usually handled automatically by C.
311              
312             dXSARGS;','name' => 'dXSARGS'},'sv_2iv' => {'text' => 'Return the integer value of an SV, doing any necessary string conversion,
313             magic etc. Normally used via the C and C macros.
314              
315             IV sv_2iv(SV* sv)','name' => 'sv_2iv'},'savesharedpv' => {'text' => 'A version of C which allocates the duplicate string in memory
316             which is shared between threads.
317              
318             char* savesharedpv(const char* pv)','name' => 'savesharedpv'},'XS_VERSION_BOOTCHECK' => {'text' => 'Macro to verify that a PM module\'s $VERSION variable matches the XS
319             module\'s C variable. This is usually handled automatically by
320             C. See L.
321              
322             XS_VERSION_BOOTCHECK;','name' => 'XS_VERSION_BOOTCHECK'},'Safefree' => {'text' => 'The XSUB-writer\'s interface to the C C function.
323              
324             void Safefree(void* ptr)','name' => 'Safefree'},'isSPACE' => {'text' => 'Returns a boolean indicating whether the C C is whitespace.
325              
326             bool isSPACE(char ch)','name' => 'isSPACE'},'SvROK' => {'text' => 'Tests if the SV is an RV.
327              
328             bool SvROK(SV* sv)','name' => 'SvROK'},'mXPUSHn' => {'text' => 'Push a double onto the stack, extending the stack if necessary. Handles
329             \'set\' magic. Does not use C. See also C, C and
330             C.
331              
332             void mXPUSHn(NV nv)','name' => 'mXPUSHn'},'sv_unref' => {'text' => 'Unsets the RV status of the SV, and decrements the reference count of
333             whatever was being referenced by the RV. This can almost be thought of
334             as a reversal of C. This is C with the C
335             being zero. See C.
336              
337             void sv_unref(SV* sv)','name' => 'sv_unref'},'SvSETMAGIC' => {'text' => 'Invokes C on an SV if it has \'set\' magic. This macro evaluates its
338             argument more than once.
339              
340             void SvSETMAGIC(SV* sv)','name' => 'SvSETMAGIC'},'G_EVAL' => {'text' => 'Used to force a Perl C wrapper around a callback. See
341             L.','name' => 'G_EVAL'},'sv_catsv_mg' => {'text' => 'Like C, but also handles \'set\' magic.
342              
343             void sv_catsv_mg(SV *dstr, SV *sstr)','name' => 'sv_catsv_mg'},'mPUSHu' => {'text' => 'Push an unsigned integer onto the stack. The stack must have room for this
344             element. Handles \'set\' magic. Does not use C. See also C,
345             C and C.
346              
347             void mPUSHu(UV uv)','name' => 'mPUSHu'},'call_argv' => {'text' => 'Performs a callback to the specified Perl sub. See L.
348              
349             NOTE: the perl_ form of this function is deprecated.
350              
351             I32 call_argv(const char* sub_name, I32 flags, char** argv)','name' => 'call_argv'},'SvPV_nolen' => {'text' => 'Returns a pointer to the string in the SV, or a stringified form of
352             the SV if the SV does not contain a string. The SV may cache the
353             stringified form becoming C. Handles \'get\' magic.
354              
355             char* SvPV_nolen(SV* sv)','name' => 'SvPV_nolen'},'perl_clone' => {'text' => 'Create and return a new interpreter by cloning the current one.
356              
357             perl_clone takes these flags as parameters:
358              
359             CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
360             without it we only clone the data and zero the stacks,
361             with it we copy the stacks and the new perl interpreter is
362             ready to run at the exact same point as the previous one.
363             The pseudo-fork code uses COPY_STACKS while the
364             threads->new doesn\'t.
365              
366             CLONEf_KEEP_PTR_TABLE
367             perl_clone keeps a ptr_table with the pointer of the old
368             variable as a key and the new variable as a value,
369             this allows it to check if something has been cloned and not
370             clone it again but rather just use the value and increase the
371             refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
372             the ptr_table using the function
373             C,
374             reason to keep it around is if you want to dup some of your own
375             variable who are outside the graph perl scans, example of this
376             code is in threads.xs create
377              
378             CLONEf_CLONE_HOST
379             This is a win32 thing, it is ignored on unix, it tells perls
380             win32host code (which is c++) to clone itself, this is needed on
381             win32 if you want to run two threads at the same time,
382             if you just want to do some stuff in a separate perl interpreter
383             and then throw it away and return to the original one,
384             you don\'t need to do anything.
385              
386             PerlInterpreter* perl_clone(PerlInterpreter* interp, UV flags)','name' => 'perl_clone'},'sv_setnv' => {'text' => 'Copies a double into the given SV, upgrading first if necessary.
387             Does not handle \'set\' magic. See also C.
388              
389             void sv_setnv(SV* sv, NV num)','name' => 'sv_setnv'},'sv_2nv' => {'text' => 'Return the num value of an SV, doing any necessary string or integer
390             conversion, magic etc. Normally used via the C and C
391             macros.
392              
393             NV sv_2nv(SV* sv)','name' => 'sv_2nv'},'sv_setsv_nomg' => {'text' => 'Like C but doesn\'t process magic.
394              
395             void sv_setsv_nomg(SV* dsv, SV* ssv)','name' => 'sv_setsv_nomg'},'SvSetSV' => {'text' => 'Calls C if dsv is not the same as ssv. May evaluate arguments
396             more than once.
397              
398             void SvSetSV(SV* dsb, SV* ssv)','name' => 'SvSetSV'},'XPUSHp' => {'text' => 'Push a string onto the stack, extending the stack if necessary. The C
399             indicates the length of the string. Handles \'set\' magic. Uses C, so
400             C or C should be called to declare it. Do not call
401             multiple C-oriented macros to return lists from XSUB\'s - see
402             C instead. See also C and C.
403              
404             void XPUSHp(char* str, STRLEN len)','name' => 'XPUSHp'},'sv_utf8_encode' => {'text' => 'Converts the PV of an SV to UTF-8, but then turns the C
405             flag off so that it looks like octets again.
406              
407             void sv_utf8_encode(SV *sv)','name' => 'sv_utf8_encode'},'newHV' => {'text' => 'Creates a new HV. The reference count is set to 1.
408              
409             HV* newHV()','name' => 'newHV'},'strnNE' => {'text' => 'Test two strings to see if they are different. The C parameter
410             indicates the number of bytes to compare. Returns true or false. (A
411             wrapper for C).
412              
413             bool strnNE(char* s1, char* s2, STRLEN len)','name' => 'strnNE'},'strNE' => {'text' => 'Test two strings to see if they are different. Returns true or
414             false.
415              
416             bool strNE(char* s1, char* s2)','name' => 'strNE'},'SvUTF8_on' => {'text' => 'Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
417             Do not use frivolously.
418              
419             void SvUTF8_on(SV *sv)','name' => 'SvUTF8_on'},'sv_setpvn_mg' => {'text' => 'Like C, but also handles \'set\' magic.
420              
421             void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)','name' => 'sv_setpvn_mg'},'sv_pvutf8n_force' => {'text' => 'A private implementation of the C macro for compilers
422             which can\'t cope with complex macro expressions. Always use the macro
423             instead.
424              
425             char* sv_pvutf8n_force(SV* sv, STRLEN* lp)','name' => 'sv_pvutf8n_force'},'savepv' => {'text' => 'Perl\'s version of C. Returns a pointer to a newly allocated
426             string which is a duplicate of C. The size of the string is
427             determined by C. The memory allocated for the new string can
428             be freed with the C function.
429              
430             char* savepv(const char* pv)','name' => 'savepv'},'toLOWER' => {'text' => 'Converts the specified character to lowercase.
431              
432             char toLOWER(char ch)','name' => 'toLOWER'},'bytes_from_utf8' => {'text' => 'Converts a string C of length C from UTF-8 into byte encoding.
433             Unlike but like C, returns a pointer to
434             the newly-created string, and updates C to contain the new
435             length. Returns the original string if no conversion occurs, C
436             is unchanged. Do nothing if C points to 0. Sets C to
437             0 if C is converted or contains all 7bit characters.
438              
439             NOTE: this function is experimental and may change or be
440             removed without notice.
441              
442             U8* bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8)','name' => 'bytes_from_utf8'},'newAV' => {'text' => 'Creates a new AV. The reference count is set to 1.
443              
444             AV* newAV()','name' => 'newAV'},'POPp' => {'text' => 'Pops a string off the stack. Deprecated. New code should provide
445             a STRLEN n_a and use POPpx.
446              
447             char* POPp','name' => 'POPp'},'HvNAME' => {'text' => 'Returns the package name of a stash. See C, C.
448              
449             char* HvNAME(HV* stash)','name' => 'HvNAME'},'sv_recode_to_utf8' => {'text' => 'The encoding is assumed to be an Encode object, on entry the PV
450             of the sv is assumed to be octets in that encoding, and the sv
451             will be converted into Unicode (and UTF-8).
452              
453             If the sv already is UTF-8 (or if it is not POK), or if the encoding
454             is not a reference, nothing is done to the sv. If the encoding is not
455             an C Encoding object, bad things will happen.
456             (See F and L).
457              
458             The PV of the sv is returned.
459              
460             char* sv_recode_to_utf8(SV* sv, SV *encoding)','name' => 'sv_recode_to_utf8'},'av_make' => {'text' => 'Creates a new AV and populates it with a list of SVs. The SVs are copied
461             into the array, so they may be freed after the call to av_make. The new AV
462             will have a reference count of 1.
463              
464             AV* av_make(I32 size, SV** svp)','name' => 'av_make'},'RETVAL' => {'text' => 'Variable which is setup by C to hold the return value for an
465             XSUB. This is always the proper type for the XSUB. See
466             L.
467              
468             (whatever) RETVAL','name' => 'RETVAL'},'HeSVKEY' => {'text' => 'Returns the key as an C, or C if the hash entry does not
469             contain an C key.
470              
471             SV* HeSVKEY(HE* he)','name' => 'HeSVKEY'},'SvUV' => {'text' => 'Coerces the given SV to an unsigned integer and returns it. See C
472             for a version which guarantees to evaluate sv only once.
473              
474             UV SvUV(SV* sv)','name' => 'SvUV'},'perl_run' => {'text' => 'Tells a Perl interpreter to run. See L.
475              
476             int perl_run(PerlInterpreter* interp)','name' => 'perl_run'},'sv_pvbyten' => {'text' => 'A private implementation of the C macro for compilers
477             which can\'t cope with complex macro expressions. Always use the macro
478             instead.
479              
480             char* sv_pvbyten(SV *sv, STRLEN *len)','name' => 'sv_pvbyten'},'sv_catsv_flags' => {'text' => 'Concatenates the string from SV C onto the end of the string in
481             SV C. Modifies C but not C. If C has C
482             bit set, will C on the SVs if appropriate, else not. C
483             and C are implemented in terms of this function.
484              
485             void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)','name' => 'sv_catsv_flags'},'Nullav' => {'text' => 'Null AV pointer.','name' => 'Nullav'},'sv_copypv' => {'text' => 'Copies a stringified representation of the source SV into the
486             destination SV. Automatically performs any necessary mg_get and
487             coercion of numeric values into strings. Guaranteed to preserve
488             UTF-8 flag even from overloaded objects. Similar in nature to
489             sv_2pv[_flags] but operates directly on an SV instead of just the
490             string. Mostly uses sv_2pv_flags to do its work, except when that
491             would lose the UTF-8\'ness of the PV.
492              
493             void sv_copypv(SV* dsv, SV* ssv)','name' => 'sv_copypv'},'sv_pv' => {'text' => 'Use the C macro instead
494              
495             char* sv_pv(SV *sv)','name' => 'sv_pv'},'SvPVutf8_nolen' => {'text' => 'Like C, but converts sv to utf8 first if necessary.
496              
497             char* SvPVutf8_nolen(SV* sv)','name' => 'SvPVutf8_nolen'},'sv_setpviv' => {'text' => 'Copies an integer into the given SV, also updating its string value.
498             Does not handle \'set\' magic. See C.
499              
500             void sv_setpviv(SV* sv, IV num)','name' => 'sv_setpviv'},'sv_setnv_mg' => {'text' => 'Like C, but also handles \'set\' magic.
501              
502             void sv_setnv_mg(SV *sv, NV num)','name' => 'sv_setnv_mg'},'sv_true' => {'text' => 'Returns true if the SV has a true value by Perl\'s rules.
503             Use the C macro instead, which may call C or may
504             instead use an in-line version.
505              
506             I32 sv_true(SV *sv)','name' => 'sv_true'},'hv_iternextsv' => {'text' => 'Performs an C, C, and C in one
507             operation.
508              
509             SV* hv_iternextsv(HV* hv, char** key, I32* retlen)','name' => 'hv_iternextsv'},'utf8_to_bytes' => {'text' => 'Converts a string C of length C from UTF-8 into byte encoding.
510             Unlike C, this over-writes the original string, and
511             updates len to contain the new length.
512             Returns zero on failure, setting C to -1.
513              
514             NOTE: this function is experimental and may change or be
515             removed without notice.
516              
517             U8* utf8_to_bytes(U8 *s, STRLEN *len)','name' => 'utf8_to_bytes'},'sv_pvbyten_force' => {'text' => 'A private implementation of the C macro for compilers
518             which can\'t cope with complex macro expressions. Always use the macro
519             instead.
520              
521             char* sv_pvbyten_force(SV* sv, STRLEN* lp)','name' => 'sv_pvbyten_force'},'sv_derived_from' => {'text' => 'Returns a boolean indicating whether the SV is derived from the specified
522             class. This is the function that implements C. It works
523             for class names as well as for objects.
524              
525             bool sv_derived_from(SV* sv, const char* name)','name' => 'sv_derived_from'},'SvIOK_on' => {'text' => 'Tells an SV that it is an integer.
526              
527             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
528             \'use bytes\' aware, handles get magic, and will coerce its args to strings
529             if necessary. See also C. See also C.
530              
531             I32 sv_cmp_locale(SV* sv1, SV* sv2)','name' => 'sv_cmp_locale'},'uvuni_to_utf8_flags' => {'text' => 'Adds the UTF-8 representation of the Unicode codepoint C to the end
532             of the string C; C should be have at least C free
533             bytes available. The return value is the pointer to the byte after the
534             end of the new character. In other words,
535              
536             d = uvuni_to_utf8_flags(d, uv, flags);
537              
538             or, in most cases,
539              
540             d = uvuni_to_utf8(d, uv);
541              
542             (which is equivalent to)
543              
544             d = uvuni_to_utf8_flags(d, uv, 0);
545              
546             is the recommended Unicode-aware way of saying
547              
548             *(d++) = uv;
549              
550             U8* uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)','name' => 'uvuni_to_utf8_flags'},'XST_mIV' => {'text' => 'Place an integer into the specified position C on the stack. The
551             value is stored in a new mortal SV.
552              
553             void XST_mIV(int pos, IV iv)','name' => 'XST_mIV'},'hv_exists' => {'text' => 'Returns a boolean indicating whether the specified hash key exists. The
554             C is the length of the key.
555              
556             bool hv_exists(HV* tb, const char* key, I32 klen)','name' => 'hv_exists'},'dSP' => {'text' => 'Declares a local copy of perl\'s stack pointer for the XSUB, available via
557             the C macro. See C.
558              
559             dSP;','name' => 'dSP'},'G_DISCARD' => {'text' => 'Indicates that arguments returned from a callback should be discarded. See
560             L.','name' => 'G_DISCARD'},'Nullsv' => {'text' => 'Null SV pointer.','name' => 'Nullsv'},'mg_length' => {'text' => 'Report on the SV\'s length. See C.
561              
562             U32 mg_length(SV* sv)','name' => 'mg_length'},'GvSV' => {'text' => 'Return the SV from the GV.
563              
564             SV* GvSV(GV* gv)','name' => 'GvSV'},'SvPVX' => {'text' => 'Returns a pointer to the physical string in the SV. The SV must contain a
565             string.
566              
567             char* SvPVX(SV* sv)','name' => 'SvPVX'},'XST_mNV' => {'text' => 'Place a double into the specified position C on the stack. The value
568             is stored in a new mortal SV.
569              
570             void XST_mNV(int pos, NV nv)','name' => 'XST_mNV'},'XPUSHi' => {'text' => 'Push an integer onto the stack, extending the stack if necessary. Handles
571             \'set\' magic. Uses C, so C or C should be called to
572             declare it. Do not call multiple C-oriented macros to return lists
573             from XSUB\'s - see C instead. See also C and C.
574              
575             void XPUSHi(IV iv)','name' => 'XPUSHi'},'HEf_SVKEY' => {'text' => 'This flag, used in the length slot of hash entries and magic structures,
576             specifies the structure contains an C pointer where a C pointer
577             is to be expected. (For information only--not to be used).','name' => 'HEf_SVKEY'},'pad_sv' => {'text' => 'Get the value at offset po in the current pad.
578             Use macro PAD_SV instead of calling this function directly.
579              
580             SV* pad_sv(PADOFFSET po)','name' => 'pad_sv'},'POPi' => {'text' => 'Pops an integer off the stack.
581              
582             IV POPi','name' => 'POPi'},'utf8_length' => {'text' => 'Return the length of the UTF-8 char encoded string C in characters.
583             Stops at C (inclusive). If C s> or if the scan would end
584             up past C, croaks.
585              
586             STRLEN utf8_length(U8* s, U8 *e)','name' => 'utf8_length'},'SvPVutf8_force' => {'text' => 'Like C, but converts sv to utf8 first if necessary.
587              
588             char* SvPVutf8_force(SV* sv, STRLEN len)','name' => 'SvPVutf8_force'},'sv_2pvutf8_nolen' => {'text' => 'Return a pointer to the UTF-8-encoded representation of the SV.
589             May cause the SV to be upgraded to UTF-8 as a side-effect.
590              
591             Usually accessed via the C macro.
592              
593             char* sv_2pvutf8_nolen(SV* sv)','name' => 'sv_2pvutf8_nolen'},'SvTAINTED_on' => {'text' => 'Marks an SV as tainted if tainting is enabled.
594              
595             void SvTAINTED_on(SV* sv)','name' => 'SvTAINTED_on'},'SvIOK_only_UV' => {'text' => 'Tells and SV that it is an unsigned integer and disables all other OK bits.
596              
597             void SvIOK_only_UV(SV* sv)','name' => 'SvIOK_only_UV'},'SVt_NV' => {'text' => 'Double type flag for scalars. See C.','name' => 'SVt_NV'},'sv_nolocking' => {'text' => 'Dummy routine which "locks" an SV when there is no locking module present.
598             Exists to avoid test for a NULL function pointer and because it could potentially warn under
599             some level of strict-ness.
600              
601             void sv_nolocking(SV *)','name' => 'sv_nolocking'},'sv_vcatpvfn' => {'text' => 'Processes its arguments like C and appends the formatted output
602             to an SV. Uses an array of SVs if the C style variable argument list is
603             missing (NULL). When running with taint checks enabled, indicates via
604             C if results are untrustworthy (often due to the use of
605             locales).
606              
607             Usually used via one of its frontends C and C.
608              
609             void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)','name' => 'sv_vcatpvfn'},'SvPVbytex' => {'text' => 'Like C, but converts sv to byte representation first if necessary.
610             Guarantees to evaluate sv only once; use the more efficient C
611             otherwise.
612              
613             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
614             return value will be NULL if the operation failed or if the value did not
615             need to be actually stored within the array (as in the case of tied
616             arrays). Otherwise it can be dereferenced to get the original C. Note
617             that the caller is responsible for suitably incrementing the reference
618             count of C before the call, and decrementing it if the function
619             returned NULL.
620              
621             See L for
622             more information on how to use this function on tied arrays.
623              
624             SV** av_store(AV* ar, I32 key, SV* val)','name' => 'av_store'},'sv_2uv' => {'text' => 'Return the unsigned integer value of an SV, doing any necessary string
625             conversion, magic etc. Normally used via the C and C
626             macros.
627              
628             UV sv_2uv(SV* sv)','name' => 'sv_2uv'},'PUSHMARK' => {'text' => 'Opening bracket for arguments on a callback. See C and
629             L.
630              
631             void PUSHMARK(SP)','name' => 'PUSHMARK'},'ST' => {'text' => 'Used to access elements on the XSUB\'s stack.
632              
633             SV* ST(int ix)','name' => 'ST'},'strLT' => {'text' => 'Test two strings to see if the first, C, is less than the second,
634             C. Returns true or false.
635              
636             bool strLT(char* s1, char* s2)','name' => 'strLT'},'sv_pvutf8n' => {'text' => 'A private implementation of the C macro for compilers
637             which can\'t cope with complex macro expressions. Always use the macro
638             instead.
639              
640             char* sv_pvutf8n(SV *sv, STRLEN *len)','name' => 'sv_pvutf8n'},'call_pv' => {'text' => 'Performs a callback to the specified Perl sub. See L.
641              
642             NOTE: the perl_ form of this function is deprecated.
643              
644             I32 call_pv(const char* sub_name, I32 flags)','name' => 'call_pv'},'av_shift' => {'text' => 'Shifts an SV off the beginning of the array.
645              
646             SV* av_shift(AV* ar)','name' => 'av_shift'},'newSV' => {'text' => 'Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
647             with an initial PV allocation of len+1. Normally accessed via the C
648             macro.
649              
650             SV* newSV(STRLEN len)','name' => 'newSV'},'av_fetch' => {'text' => 'Returns the SV at the specified index in the array. The C is the
651             index. If C is set then the fetch will be part of a store. Check
652             that the return value is non-null before dereferencing it to a C.
653              
654             See L for
655             more information on how to use this function on tied arrays.
656              
657             SV** av_fetch(AV* ar, I32 key, I32 lval)','name' => 'av_fetch'},'SvNOK_only' => {'text' => 'Tells an SV that it is a double and disables all other OK bits.
658              
659             void SvNOK_only(SV* sv)','name' => 'SvNOK_only'},'gv_fetchmeth_autoload' => {'text' => 'Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
660             Returns a glob for the subroutine.
661              
662             For an autoloaded subroutine without a GV, will create a GV even
663             if C. For an autoloaded subroutine without a stub, GvCV()
664             of the result may be zero.
665              
666             GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)','name' => 'gv_fetchmeth_autoload'},'sv_2pvutf8' => {'text' => 'Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
667             to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
668              
669             Usually accessed via the C macro.
670              
671             char* sv_2pvutf8(SV* sv, STRLEN* lp)','name' => 'sv_2pvutf8'},'sv_nounlocking' => {'text' => 'Dummy routine which "unlocks" an SV when there is no locking module present.
672             Exists to avoid test for a NULL function pointer and because it could potentially warn under
673             some level of strict-ness.
674              
675             void sv_nounlocking(SV *)','name' => 'sv_nounlocking'},'dITEMS' => {'text' => 'Sets up the C variable.
676             This is usually handled automatically by C by calling C.
677              
678             dITEMS;','name' => 'dITEMS'},'hv_iterval' => {'text' => 'Returns the value from the current position of the hash iterator. See
679             C.
680              
681             SV* hv_iterval(HV* tb, HE* entry)','name' => 'hv_iterval'},'sv_reftype' => {'text' => 'Returns a string describing what the SV is a reference to.
682              
683             char* sv_reftype(SV* sv, int ob)','name' => 'sv_reftype'},'sv_pos_b2u' => {'text' => 'Converts the value pointed to by offsetp from a count of bytes from the
684             start of the string, to a count of the equivalent number of UTF-8 chars.
685             Handles magic and type coercion.
686              
687             void sv_pos_b2u(SV* sv, I32* offsetp)','name' => 'sv_pos_b2u'},'SVt_IV' => {'text' => 'Integer type flag for scalars. See C.','name' => 'SVt_IV'},'av_len' => {'text' => 'Returns the highest index in the array. Returns -1 if the array is
688             empty.
689              
690             I32 av_len(AV* ar)','name' => 'av_len'},'SvIsCOW' => {'text' => 'Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
691             hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
692             COW)
693              
694             bool SvIsCOW(SV* sv)','name' => 'SvIsCOW'},'CopyD' => {'text' => 'Like C but returns dest. Useful for encouraging compilers to tail-call
695             optimise.
696              
697             void * CopyD(void* src, void* dest, int nitems, type)','name' => 'CopyD'},'sv_unmagic' => {'text' => 'Removes all magic of type C from an SV.
698              
699             int sv_unmagic(SV* sv, int type)','name' => 'sv_unmagic'},'sv_setiv_mg' => {'text' => 'Like C, but also handles \'set\' magic.
700              
701             void sv_setiv_mg(SV *sv, IV i)','name' => 'sv_setiv_mg'},'sv_catsv' => {'text' => 'Concatenates the string from SV C onto the end of the string in
702             SV C. Modifies C but not C. Handles \'get\' magic, but
703             not \'set\' magic. See C.
704              
705             void sv_catsv(SV* dsv, SV* ssv)','name' => 'sv_catsv'},'SvTAINT' => {'text' => 'Taints an SV if tainting is enabled.
706              
707             void SvTAINT(SV* sv)','name' => 'SvTAINT'},'PUTBACK' => {'text' => 'Closing bracket for XSUB arguments. This is usually handled by C.
708             See C and L for other uses.
709              
710             PUTBACK;','name' => 'PUTBACK'},'SvPOK_on' => {'text' => 'Tells an SV that it is a string.
711              
712             void SvPOK_on(SV* sv)','name' => 'SvPOK_on'},'ax' => {'text' => 'Variable which is setup by C to indicate the stack base offset,
713             used by the C, C and C macros. The C macro
714             must be called prior to setup the C variable.
715              
716             I32 ax','name' => 'ax'},'mg_clear' => {'text' => 'Clear something magical that the SV represents. See C.
717              
718             int mg_clear(SV* sv)','name' => 'mg_clear'},'SvCUR_set' => {'text' => 'Set the length of the string which is in the SV. See C.
719              
720             void SvCUR_set(SV* sv, STRLEN len)','name' => 'SvCUR_set'},'to_utf8_fold' => {'text' => 'Convert the UTF-8 encoded character at p to its foldcase version and
721             store that in UTF-8 in ustrp and its length in bytes in lenp. Note
722             that the ustrp needs to be at least UTF8_MAXLEN_FOLD+1 bytes since the
723             foldcase version may be longer than the original character (up to
724             three characters).
725              
726             The first character of the foldcased version is returned
727             (but note, as explained above, that there may be more.)
728              
729             UV to_utf8_fold(U8 *p, U8* ustrp, STRLEN *lenp)','name' => 'to_utf8_fold'},'to_utf8_upper' => {'text' => 'Convert the UTF-8 encoded character at p to its uppercase version and
730             store that in UTF-8 in ustrp and its length in bytes in lenp. Note
731             that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
732             uppercase version may be longer than the original character (up to two
733             characters).
734              
735             The first character of the uppercased version is returned
736             (but note, as explained above, that there may be more.)
737              
738             UV to_utf8_upper(U8 *p, U8* ustrp, STRLEN *lenp)','name' => 'to_utf8_upper'},'SvNOK' => {'text' => 'Returns a boolean indicating whether the SV contains a double.
739              
740             bool SvNOK(SV* sv)','name' => 'SvNOK'},'mPUSHn' => {'text' => 'Push a double onto the stack. The stack must have room for this element.
741             Handles \'set\' magic. Does not use C. See also C, C
742             and C.
743              
744             void mPUSHn(NV nv)','name' => 'mPUSHn'},'gv_stashpv' => {'text' => 'Returns a pointer to the stash for a specified package. C should
745             be a valid UTF-8 string. If C is set then the package will be
746             created if it does not already exist. If C is not set and the
747             package does not exist then NULL is returned.
748              
749             HV* gv_stashpv(const char* name, I32 create)','name' => 'gv_stashpv'},'G_SCALAR' => {'text' => 'Used to indicate scalar context. See C, C, and
750             L.','name' => 'G_SCALAR'},'sv_vcatpvf_mg' => {'text' => 'Like C, but also handles \'set\' magic.
751              
752             Usually used via its frontend C.
753              
754             void sv_vcatpvf_mg(SV* sv, const char* pat, va_list* args)','name' => 'sv_vcatpvf_mg'},'SvPVutf8x_force' => {'text' => 'Like C, but converts sv to utf8 first if necessary.
755             Guarantees to evaluate sv only once; use the more efficient C
756             otherwise.
757              
758             char* SvPVutf8x_force(SV* sv, STRLEN len)','name' => 'SvPVutf8x_force'},'PUSHi' => {'text' => 'Push an integer onto the stack. The stack must have room for this element.
759             Handles \'set\' magic. Uses C, so C or C should be
760             called to declare it. Do not call multiple C-oriented macros to
761             return lists from XSUB\'s - see C instead. See also C and
762             C.
763              
764             void PUSHi(IV iv)','name' => 'PUSHi'},'sv_reset' => {'text' => 'Underlying implementation for the C Perl function.
765             Note that the perl-level function is vaguely deprecated.
766              
767             void sv_reset(char* s, HV* stash)','name' => 'sv_reset'},'mXPUSHu' => {'text' => 'Push an unsigned integer onto the stack, extending the stack if necessary.
768             Handles \'set\' magic. Does not use C. See also C, C
769             and C.
770              
771             void mXPUSHu(UV uv)','name' => 'mXPUSHu'},'hv_exists_ent' => {'text' => 'Returns a boolean indicating whether the specified hash key exists. C
772             can be a valid precomputed hash value, or 0 to ask for it to be
773             computed.
774              
775             bool hv_exists_ent(HV* tb, SV* key, U32 hash)','name' => 'hv_exists_ent'},'to_utf8_lower' => {'text' => 'Convert the UTF-8 encoded character at p to its lowercase version and
776             store that in UTF-8 in ustrp and its length in bytes in lenp. Note
777             that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
778             lowercase version may be longer than the original character (up to two
779             characters).
780              
781             The first character of the lowercased version is returned
782             (but note, as explained above, that there may be more.)
783              
784             UV to_utf8_lower(U8 *p, U8* ustrp, STRLEN *lenp)','name' => 'to_utf8_lower'},'SvNIOK' => {'text' => 'Returns a boolean indicating whether the SV contains a number, integer or
785             double.
786              
787             bool SvNIOK(SV* sv)','name' => 'SvNIOK'},'sv_2pv_flags' => {'text' => 'Returns a pointer to the string value of an SV, and sets *lp to its length.
788             If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
789             if necessary.
790             Normally invoked via the C macro. C and C
791             usually end up here too.
792              
793             char* sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)','name' => 'sv_2pv_flags'},'SvTAINTED_off' => {'text' => 'Untaints an SV. Be I careful with this routine, as it short-circuits
794             some of Perl\'s fundamental security features. XS module authors should not
795             use this function unless they fully understand all the implications of
796             unconditionally untainting the value. Untainting should be done in the
797             standard perl fashion, via a carefully crafted regexp, rather than directly
798             untainting variables.
799              
800             void SvTAINTED_off(SV* sv)','name' => 'SvTAINTED_off'},'SvNVx' => {'text' => 'Coerces the given SV to a double and returns it. Guarantees to evaluate
801             sv only once. Use the more efficient C otherwise.
802              
803             NV SvNVx(SV* sv)','name' => 'SvNVx'},'unpack_str' => {'text' => 'The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
804             and ocnt are not used. This call should not be used, use unpackstring instead.
805              
806             I32 unpack_str(char *pat, char *patend, char *s, char *strbeg, char *strend, char **new_s, I32 ocnt, U32 flags)','name' => 'unpack_str'},'newSVpvf' => {'text' => 'Creates a new SV and initializes it with the string formatted like
807             C.
808              
809             SV* newSVpvf(const char* pat, ...)','name' => 'newSVpvf'},'require_pv' => {'text' => 'Tells Perl to C the file named by the string argument. It is
810             analogous to the Perl code C. It\'s even
811             implemented that way; consider using load_module instead.
812              
813             NOTE: the perl_ form of this function is deprecated.
814              
815             void require_pv(const char* pv)','name' => 'require_pv'},'sv_upgrade' => {'text' => 'Upgrade an SV to a more complex form. Generally adds a new body type to the
816             SV, then copies across as much information as possible from the old body.
817             You generally want to use the C macro wrapper. See also C.
818              
819             bool sv_upgrade(SV* sv, U32 mt)','name' => 'sv_upgrade'},'strEQ' => {'text' => 'Test two strings to see if they are equal. Returns true or false.
820              
821             bool strEQ(char* s1, char* s2)','name' => 'strEQ'},'sv_newref' => {'text' => 'Increment an SV\'s reference count. Use the C wrapper
822             instead.
823              
824             SV* sv_newref(SV* sv)','name' => 'sv_newref'},'hv_store' => {'text' => 'Stores an SV in a hash. The hash key is specified as C and C is
825             the length of the key. The C parameter is the precomputed hash
826             value; if it is zero then Perl will compute it. The return value will be
827             NULL if the operation failed or if the value did not need to be actually
828             stored within the hash (as in the case of tied hashes). Otherwise it can
829             be dereferenced to get the original C. Note that the caller is
830             responsible for suitably incrementing the reference count of C before
831             the call, and decrementing it if the function returned NULL. Effectively
832             a successful hv_store takes ownership of one reference to C. This is
833             usually what you want; a newly created SV has a reference count of one, so
834             if all your code does is create SVs then store them in a hash, hv_store
835             will own the only reference to the new SV, and your code doesn\'t need to do
836             anything further to tidy up. hv_store is not implemented as a call to
837             hv_store_ent, and does not create a temporary SV for the key, so if your
838             key data is not already in SV form then use hv_store in preference to
839             hv_store_ent.
840              
841             See L for more
842             information on how to use this function on tied hashes.
843              
844             SV** hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)','name' => 'hv_store'},'SvIVX' => {'text' => 'Returns the raw value in the SV\'s IV slot, without checks or conversions.
845             Only use when you are sure SvIOK is true. See also C.
846              
847             IV SvIVX(SV* sv)','name' => 'SvIVX'},'XSRETURN_IV' => {'text' => 'Return an integer from an XSUB immediately. Uses C.
848              
849             void XSRETURN_IV(IV iv)','name' => 'XSRETURN_IV'},'perl_destruct' => {'text' => 'Shuts down a Perl interpreter. See L.
850              
851             int perl_destruct(PerlInterpreter* interp)','name' => 'perl_destruct'},'sv_uni_display' => {'text' => 'Build to the scalar dsv a displayable version of the scalar sv,
852             the displayable version being at most pvlim bytes long
853             (if longer, the rest is truncated and "..." will be appended).
854              
855             The flags argument is as in pv_uni_display().
856              
857             The pointer to the PV of the dsv is returned.
858              
859             char* sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)','name' => 'sv_uni_display'},'sv_vsetpvf' => {'text' => 'Works like C but copies the text into the SV instead of
860             appending it. Does not handle \'set\' magic. See C.
861              
862             Usually used via its frontend C.
863              
864             void sv_vsetpvf(SV* sv, const char* pat, va_list* args)','name' => 'sv_vsetpvf'},'isUPPER' => {'text' => 'Returns a boolean indicating whether the C C is an uppercase
865             character.
866              
867             bool isUPPER(char ch)','name' => 'isUPPER'},'SvREFCNT_dec' => {'text' => 'Decrements the reference count of the given SV.
868              
869             void SvREFCNT_dec(SV* sv)','name' => 'SvREFCNT_dec'},'sv_setsv' => {'text' => 'Copies the contents of the source SV C into the destination SV
870             C. The source SV may be destroyed if it is mortal, so don\'t use this
871             function if the source SV needs to be reused. Does not handle \'set\' magic.
872             Loosely speaking, it performs a copy-by-value, obliterating any previous
873             content of the destination.
874              
875             You probably want to use one of the assortment of wrappers, such as
876             C, C, C and
877             C.
878              
879             void sv_setsv(SV* dsv, SV* ssv)','name' => 'sv_setsv'},'SvIOK_off' => {'text' => 'Unsets the IV status of an SV.
880              
881             void SvIOK_off(SV* sv)','name' => 'SvIOK_off'},'XST_mYES' => {'text' => 'Place C<&PL_sv_yes> into the specified position C on the
882             stack.
883              
884             void XST_mYES(int pos)','name' => 'XST_mYES'},'POPs' => {'text' => 'Pops an SV off the stack.
885              
886             SV* POPs','name' => 'POPs'},'SvNV' => {'text' => 'Coerce the given SV to a double and return it. See C for a version
887             which guarantees to evaluate sv only once.
888              
889             NV SvNV(SV* sv)','name' => 'SvNV'},'packlist' => {'text' => 'The engine implementing pack() Perl function.
890              
891             void packlist(SV *cat, char *pat, char *patend, SV **beglist, SV **endlist)','name' => 'packlist'},'SvUTF8' => {'text' => 'Returns a boolean indicating whether the SV contains UTF-8 encoded data.
892              
893             bool SvUTF8(SV* sv)','name' => 'SvUTF8'},'gv_fetchmethod_autoload' => {'text' => 'Returns the glob which contains the subroutine to call to invoke the method
894             on the C. In fact in the presence of autoloading this may be the
895             glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
896             already setup.
897              
898             The third parameter of C determines whether
899             AUTOLOAD lookup is performed if the given method is not present: non-zero
900             means yes, look for AUTOLOAD; zero means no, don\'t look for AUTOLOAD.
901             Calling C is equivalent to calling C
902             with a non-zero C parameter.
903              
904             These functions grant C<"SUPER"> token as a prefix of the method name. Note
905             that if you want to keep the returned glob for a long time, you need to
906             check for it being "AUTOLOAD", since at the later time the call may load a
907             different subroutine due to $AUTOLOAD changing its value. Use the glob
908             created via a side effect to do this.
909              
910             These functions have the same side-effects and as C with
911             C. C should be writable if contains C<\':\'> or C<\'
912             \'\'>. The warning against passing the GV returned by C to
913             C apply equally to these functions.
914              
915             GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)','name' => 'gv_fetchmethod_autoload'},'sv_setsv_mg' => {'text' => 'Like C, but also handles \'set\' magic.
916              
917             void sv_setsv_mg(SV *dstr, SV *sstr)','name' => 'sv_setsv_mg'},'hv_fetch_ent' => {'text' => 'Returns the hash entry which corresponds to the specified key in the hash.
918             C must be a valid precomputed hash number for the given C, or 0
919             if you want the function to compute it. IF C is set then the fetch
920             will be part of a store. Make sure the return value is non-null before
921             accessing it. The return value when C is a tied hash is a pointer to a
922             static location, so be sure to make a copy of the structure if you need to
923             store it somewhere.
924              
925             See L for more
926             information on how to use this function on tied hashes.
927              
928             HE* hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)','name' => 'hv_fetch_ent'},'isLOWER' => {'text' => 'Returns a boolean indicating whether the C C is a lowercase
929             character.
930              
931             bool isLOWER(char ch)','name' => 'isLOWER'},'ENTER' => {'text' => 'Opening bracket on a callback. See C and L.
932              
933             ENTER;','name' => 'ENTER'},'sv_eq' => {'text' => 'Returns a boolean indicating whether the strings in the two SVs are
934             identical. Is UTF-8 and \'use bytes\' aware, handles get magic, and will
935             coerce its args to strings if necessary.
936              
937             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
938             not.
939              
940             bool SvTAINTED(SV* sv)','name' => 'SvTAINTED'},'PL_sv_no' => {'text' => 'This is the C SV. See C. Always refer to this as
941             C<&PL_sv_no>.
942              
943             SV PL_sv_no','name' => 'PL_sv_no'},'hv_iterkey' => {'text' => 'Returns the key from the current position of the hash iterator. See
944             C.
945              
946             char* hv_iterkey(HE* entry, I32* retlen)','name' => 'hv_iterkey'},'ix' => {'text' => 'Variable which is setup by C to indicate which of an
947             XSUB\'s aliases was used to invoke it. See L.
948              
949             I32 ix','name' => 'ix'},'SvNOKp' => {'text' => 'Returns a boolean indicating whether the SV contains a double. Checks the
950             B setting. Use C.
951              
952             bool SvNOKp(SV* sv)','name' => 'SvNOKp'},'XSRETURN_UV' => {'text' => 'Return an integer from an XSUB immediately. Uses C.
953              
954             void XSRETURN_UV(IV uv)','name' => 'XSRETURN_UV'},'StructCopy' => {'text' => 'This is an architecture-independent macro to copy one structure to another.
955              
956             void StructCopy(type src, type dest, type)','name' => 'StructCopy'},'cv_undef' => {'text' => 'Clear out all the active components of a CV. This can happen either
957             by an explicit C, or by the reference count going to zero.
958             In the former case, we keep the CvOUTSIDE pointer, so that any anonymous
959             children can still follow the full lexical scope chain.
960              
961             void cv_undef(CV* cv)','name' => 'cv_undef'},'PUSHs' => {'text' => 'Push an SV onto the stack. The stack must have room for this element.
962             Does not handle \'set\' magic. Does not use C. See also C,
963             C and C.
964              
965             void PUSHs(SV* sv)','name' => 'PUSHs'},'sv_setuv' => {'text' => 'Copies an unsigned integer into the given SV, upgrading first if necessary.
966             Does not handle \'set\' magic. See also C.
967              
968             void sv_setuv(SV* sv, UV num)','name' => 'sv_setuv'},'SvUPGRADE' => {'text' => 'Used to upgrade an SV to a more complex form. Uses C to
969             perform the upgrade if necessary. See C.
970              
971             void SvUPGRADE(SV* sv, svtype type)','name' => 'SvUPGRADE'},'utf8_to_uvchr' => {'text' => 'Returns the native character value of the first character in the string C
972             which is assumed to be in UTF-8 encoding; C will be set to the
973             length, in bytes, of that character.
974              
975             If C does not point to a well-formed UTF-8 character, zero is
976             returned and retlen is set, if possible, to -1.
977              
978             UV utf8_to_uvchr(U8 *s, STRLEN* retlen)','name' => 'utf8_to_uvchr'},'nothreadhook' => {'text' => 'Stub that provides thread hook for perl_destruct when there are
979             no threads.
980              
981             int nothreadhook()','name' => 'nothreadhook'},'items' => {'text' => 'Variable which is setup by C to indicate the number of
982             items on the stack. See L.
983              
984             I32 items','name' => 'items'},'bytes_to_utf8' => {'text' => 'Converts a string C of length C from ASCII into UTF-8 encoding.
985             Returns a pointer to the newly-created string, and sets C to
986             reflect the new length.
987              
988             If you want to convert to UTF-8 from other encodings than ASCII,
989             see sv_recode_to_utf8().
990              
991             NOTE: this function is experimental and may change or be
992             removed without notice.
993              
994             U8* bytes_to_utf8(U8 *s, STRLEN *len)','name' => 'bytes_to_utf8'},'sv_pvn' => {'text' => 'A private implementation of the C macro for compilers which can\'t
995             cope with complex macro expressions. Always use the macro instead.
996              
997             char* sv_pvn(SV *sv, STRLEN *len)','name' => 'sv_pvn'},'SvIsCOW_shared_hash' => {'text' => 'Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
998             scalar.
999              
1000             bool SvIsCOW_shared_hash(SV* sv)','name' => 'SvIsCOW_shared_hash'},'XST_mPV' => {'text' => 'Place a copy of a string into the specified position C on the stack.
1001             The value is stored in a new mortal SV.
1002              
1003             void XST_mPV(int pos, char* str)','name' => 'XST_mPV'},'dXSI32' => {'text' => 'Sets up the C variable for an XSUB which has aliases. This is usually
1004             handled automatically by C.
1005              
1006             dXSI32;','name' => 'dXSI32'},'sv_setref_iv' => {'text' => 'Copies an integer into a new SV, optionally blessing the SV. The C
1007             argument will be upgraded to an RV. That RV will be modified to point to
1008             the new SV. The C argument indicates the package for the
1009             blessing. Set C to C to avoid the blessing. The new SV
1010             will have a reference count of 1, and the RV will be returned.
1011              
1012             SV* sv_setref_iv(SV* rv, const char* classname, IV iv)','name' => 'sv_setref_iv'},'sv_chop' => {'text' => 'Efficient removal of characters from the beginning of the string buffer.
1013             SvPOK(sv) must be true and the C must be a pointer to somewhere inside
1014             the string buffer. The C becomes the first character of the adjusted
1015             string. Uses the "OOK hack".
1016             Beware: after this function returns, C and SvPVX(sv) may no longer
1017             refer to the same chunk of data.
1018              
1019             void sv_chop(SV* sv, char* ptr)','name' => 'sv_chop'},'SvPVx' => {'text' => 'A version of C which guarantees to evaluate sv only once.
1020              
1021             char* SvPVx(SV* sv, STRLEN len)','name' => 'SvPVx'},'sv_backoff' => {'text' => 'Remove any string offset. You should normally use the C macro
1022             wrapper instead.
1023              
1024             int sv_backoff(SV* sv)','name' => 'sv_backoff'},'sv_tainted' => {'text' => 'Test an SV for taintedness. Use C instead.
1025             bool sv_tainted(SV* sv)','name' => 'sv_tainted'},'sv_catsv_nomg' => {'text' => 'Like C but doesn\'t process magic.
1026              
1027             void sv_catsv_nomg(SV* dsv, SV* ssv)','name' => 'sv_catsv_nomg'},'sv_grow' => {'text' => 'Expands the character buffer in the SV. If necessary, uses C and
1028             upgrades the SV to C. Returns a pointer to the character buffer.
1029             Use the C wrapper instead.
1030              
1031             char* sv_grow(SV* sv, STRLEN newlen)','name' => 'sv_grow'},'XPUSHu' => {'text' => 'Push an unsigned integer onto the stack, extending the stack if necessary.
1032             Handles \'set\' magic. Uses C, so C or C should be
1033             called to declare it. Do not call multiple C-oriented macros to
1034             return lists from XSUB\'s - see C instead. See also C and
1035             C.
1036              
1037             void XPUSHu(UV uv)','name' => 'XPUSHu'},'sv_setuv_mg' => {'text' => 'Like C, but also handles \'set\' magic.
1038              
1039             void sv_setuv_mg(SV *sv, UV u)','name' => 'sv_setuv_mg'},'cv_const_sv' => {'text' => 'If C is a constant sub eligible for inlining. returns the constant
1040             value returned by the sub. Otherwise, returns NULL.
1041              
1042             Constant subs can be created with C or as described in
1043             L.
1044              
1045             SV* cv_const_sv(CV* cv)','name' => 'cv_const_sv'},'XS_VERSION' => {'text' => 'The version identifier for an XS module. This is usually
1046             handled automatically by C. See C.','name' => 'XS_VERSION'},'newSVnv' => {'text' => 'Creates a new SV and copies a floating point value into it.
1047             The reference count for the SV is set to 1.
1048              
1049             SV* newSVnv(NV n)','name' => 'newSVnv'},'XPUSHs' => {'text' => 'Push an SV onto the stack, extending the stack if necessary. Does not
1050             handle \'set\' magic. Does not use C. See also C,
1051             C and C.
1052              
1053             void XPUSHs(SV* sv)','name' => 'XPUSHs'},'HeVAL' => {'text' => 'Returns the value slot (type C) stored in the hash entry.
1054              
1055             SV* HeVAL(HE* he)','name' => 'HeVAL'},'PL_na' => {'text' => 'A convenience variable which is typically used with C when one
1056             doesn\'t care about the length of the string. It is usually more efficient
1057             to either declare a local variable and use that instead or to use the
1058             C macro.
1059              
1060             STRLEN PL_na','name' => 'PL_na'},'HePV' => {'text' => 'Returns the key slot of the hash entry as a C value, doing any
1061             necessary dereferencing of possibly C keys. The length of the string
1062             is placed in C (this is a macro, so do I use C<&len>). If you do
1063             not care about what the length of the key is, you may use the global
1064             variable C, though this is rather less efficient than using a local
1065             variable. Remember though, that hash keys in perl are free to contain
1066             embedded nulls, so using C or similar is not a good way to find
1067             the length of hash keys. This is very similar to the C macro
1068             described elsewhere in this document.
1069              
1070             char* HePV(HE* he, STRLEN len)','name' => 'HePV'},'newSViv' => {'text' => 'Creates a new SV and copies an integer into it. The reference count for the
1071             SV is set to 1.
1072              
1073             SV* newSViv(IV i)','name' => 'newSViv'},'sv_untaint' => {'text' => 'Untaint an SV. Use C instead.
1074             void sv_untaint(SV* sv)','name' => 'sv_untaint'},'sv_setpv' => {'text' => 'Copies a string into an SV. The string must be null-terminated. Does not
1075             handle \'set\' magic. See C.
1076              
1077             void sv_setpv(SV* sv, const char* ptr)','name' => 'sv_setpv'},'SVt_PVHV' => {'text' => 'Type flag for hashes. See C.','name' => 'SVt_PVHV'},'pv_uni_display' => {'text' => 'Build to the scalar dsv a displayable version of the string spv,
1078             length len, the displayable version being at most pvlim bytes long
1079             (if longer, the rest is truncated and "..." will be appended).
1080              
1081             The flags argument can have UNI_DISPLAY_ISPRINT set to display
1082             isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
1083             to display the \\\\[nrfta\\\\] as the backslashed versions (like \'\\n\')
1084             (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\\\).
1085             UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
1086             UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
1087              
1088             The pointer to the PV of the dsv is returned.
1089              
1090             char* pv_uni_display(SV *dsv, U8 *spv, STRLEN len, STRLEN pvlim, UV flags)','name' => 'pv_uni_display'},'gv_fetchmethod' => {'text' => 'See L.
1091              
1092             GV* gv_fetchmethod(HV* stash, const char* name)','name' => 'gv_fetchmethod'},'SvGETMAGIC' => {'text' => 'Invokes C on an SV if it has \'get\' magic. This macro evaluates its
1093             argument more than once.
1094              
1095             void SvGETMAGIC(SV* sv)','name' => 'SvGETMAGIC'},'SvGROW' => {'text' => 'Expands the character buffer in the SV so that it has room for the
1096             indicated number of bytes (remember to reserve space for an extra trailing
1097             NUL character). Calls C to perform the expansion if necessary.
1098             Returns a pointer to the character buffer.
1099              
1100             char * SvGROW(SV* sv, STRLEN len)','name' => 'SvGROW'},'sv_inc' => {'text' => 'Auto-increment of the value in the SV, doing string to numeric conversion
1101             if necessary. Handles \'get\' magic.
1102              
1103             void sv_inc(SV* sv)','name' => 'sv_inc'},'sv_usepvn' => {'text' => 'Tells an SV to use C to find its string value. Normally the string is
1104             stored inside the SV but sv_usepvn allows the SV to use an outside string.
1105             The C should point to memory that was allocated by C. The
1106             string length, C, must be supplied. This function will realloc the
1107             memory pointed to by C, so that pointer should not be freed or used by
1108             the programmer after giving it to sv_usepvn. Does not handle \'set\' magic.
1109             See C.
1110              
1111             void sv_usepvn(SV* sv, char* ptr, STRLEN len)','name' => 'sv_usepvn'},'SvPVbytex_force' => {'text' => 'Like C, but converts sv to byte representation first if necessary.
1112             Guarantees to evaluate sv only once; use the more efficient C
1113             otherwise.
1114              
1115             char* SvPVbytex_force(SV* sv, STRLEN len)','name' => 'SvPVbytex_force'},'sv_catpv' => {'text' => 'Concatenates the string onto the end of the string which is in the SV.
1116             If the SV has the UTF-8 status set, then the bytes appended should be
1117             valid UTF-8. Handles \'get\' magic, but not \'set\' magic. See C.
1118              
1119             void sv_catpv(SV* sv, const char* ptr)','name' => 'sv_catpv'},'SvREFCNT' => {'text' => 'Returns the value of the object\'s reference count.
1120              
1121             U32 SvREFCNT(SV* sv)','name' => 'SvREFCNT'},'sv_len' => {'text' => 'Returns the length of the string in the SV. Handles magic and type
1122             coercion. See also C, which gives raw access to the xpv_cur slot.
1123              
1124             STRLEN sv_len(SV* sv)','name' => 'sv_len'},'warn' => {'text' => 'This is the XSUB-writer\'s interface to Perl\'s C function. Call this
1125             function the same way you call the C C function. See C.
1126              
1127             void warn(const char* pat, ...)','name' => 'warn'},'sv_pvutf8' => {'text' => 'Use the C macro instead
1128              
1129             char* sv_pvutf8(SV *sv)','name' => 'sv_pvutf8'},'SvPVbyte_nolen' => {'text' => 'Like C, but converts sv to byte representation first if necessary.
1130              
1131             char* SvPVbyte_nolen(SV* sv)','name' => 'SvPVbyte_nolen'},'LEAVE' => {'text' => 'Closing bracket on a callback. See C and L.
1132              
1133             LEAVE;','name' => 'LEAVE'},'SVt_PVAV' => {'text' => 'Type flag for arrays. See C.','name' => 'SVt_PVAV'},'hv_delete' => {'text' => 'Deletes a key/value pair in the hash. The value SV is removed from the
1134             hash and returned to the caller. The C is the length of the key.
1135             The C value will normally be zero; if set to G_DISCARD then NULL
1136             will be returned.
1137              
1138             SV* hv_delete(HV* tb, const char* key, I32 klen, I32 flags)','name' => 'hv_delete'},'hv_undef' => {'text' => 'Undefines the hash.
1139              
1140             void hv_undef(HV* tb)','name' => 'hv_undef'},'SvSetMagicSV_nosteal' => {'text' => 'Like C, but does any set magic required afterwards.
1141              
1142             void SvSetMagicSV_nosteal(SV* dsv, SV* ssv)','name' => 'SvSetMagicSV_nosteal'},'hv_delete_ent' => {'text' => 'Deletes a key/value pair in the hash. The value SV is removed from the
1143             hash and returned to the caller. The C value will normally be zero;
1144             if set to G_DISCARD then NULL will be returned. C can be a valid
1145             precomputed hash value, or 0 to ask for it to be computed.
1146              
1147             SV* hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)','name' => 'hv_delete_ent'},'CLASS' => {'text' => 'Variable which is setup by C to indicate the
1148             class name for a C++ XS constructor. This is always a C. See C.
1149              
1150             char* CLASS','name' => 'CLASS'},'sv_isobject' => {'text' => 'Returns a boolean indicating whether the SV is an RV pointing to a blessed
1151             object. If the SV is not an RV, or if the object is not blessed, then this
1152             will return false.
1153              
1154             int sv_isobject(SV* sv)','name' => 'sv_isobject'},'Newc' => {'text' => 'The XSUB-writer\'s interface to the C C function, with
1155             cast.
1156              
1157             void Newc(int id, void* ptr, int nitems, type, cast)','name' => 'Newc'},'sv_pvn_force_flags' => {'text' => 'Get a sensible string out of the SV somehow.
1158             If C has C bit set, will C on C if
1159             appropriate, else not. C and C are
1160             implemented in terms of this function.
1161             You normally want to use the various wrapper macros instead: see
1162             C and C
1163              
1164             char* sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)','name' => 'sv_pvn_force_flags'},'HeKLEN' => {'text' => 'If this is negative, and amounts to C, it indicates the entry
1165             holds an C key. Otherwise, holds the actual length of the key. Can
1166             be assigned to. The C macro is usually preferable for finding key
1167             lengths.
1168              
1169             STRLEN HeKLEN(HE* he)','name' => 'HeKLEN'},'to_utf8_title' => {'text' => 'Convert the UTF-8 encoded character at p to its titlecase version and
1170             store that in UTF-8 in ustrp and its length in bytes in lenp. Note
1171             that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
1172             titlecase version may be longer than the original character (up to two
1173             characters).
1174              
1175             The first character of the titlecased version is returned
1176             (but note, as explained above, that there may be more.)
1177              
1178             UV to_utf8_title(U8 *p, U8* ustrp, STRLEN *lenp)','name' => 'to_utf8_title'},'sv_cat_decode' => {'text' => 'The encoding is assumed to be an Encode object, the PV of the ssv is
1179             assumed to be octets in that encoding and decoding the input starts
1180             from the position which (PV + *offset) pointed to. The dsv will be
1181             concatenated the decoded UTF-8 string from ssv. Decoding will terminate
1182             when the string tstr appears in decoding output or the input ends on
1183             the PV of the ssv. The value which the offset points will be modified
1184             to the last input position on the ssv.
1185              
1186             Returns TRUE if the terminator was found, else returns FALSE.
1187              
1188             bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)','name' => 'sv_cat_decode'},'mPUSHi' => {'text' => 'Push an integer onto the stack. The stack must have room for this element.
1189             Handles \'set\' magic. Does not use C. See also C, C
1190             and C.
1191              
1192             void mPUSHi(IV iv)','name' => 'mPUSHi'},'PUSHn' => {'text' => 'Push a double onto the stack. The stack must have room for this element.
1193             Handles \'set\' magic. Uses C, so C or C should be
1194             called to declare it. Do not call multiple C-oriented macros to
1195             return lists from XSUB\'s - see C instead. See also C and
1196             C.
1197              
1198             void PUSHn(NV nv)','name' => 'PUSHn'},'sv_setiv' => {'text' => 'Copies an integer into the given SV, upgrading first if necessary.
1199             Does not handle \'set\' magic. See also C.
1200              
1201             void sv_setiv(SV* sv, IV num)','name' => 'sv_setiv'},'SvIV' => {'text' => 'Coerces the given SV to an integer and returns it. See C for a
1202             version which guarantees to evaluate sv only once.
1203              
1204             IV SvIV(SV* sv)','name' => 'SvIV'},'sv_report_used' => {'text' => 'Dump the contents of all SVs not yet freed. (Debugging aid).
1205              
1206             void sv_report_used()','name' => 'sv_report_used'},'EXTEND' => {'text' => 'Used to extend the argument stack for an XSUB\'s return values. Once
1207             used, guarantees that there is room for at least C to be pushed
1208             onto the stack.
1209              
1210             void EXTEND(SP, int nitems)','name' => 'EXTEND'},'PL_sv_yes' => {'text' => 'This is the C SV. See C. Always refer to this as
1211             C<&PL_sv_yes>.
1212              
1213             SV PL_sv_yes','name' => 'PL_sv_yes'},'SvNVX' => {'text' => 'Returns the raw value in the SV\'s NV slot, without checks or conversions.
1214             Only use when you are sure SvNOK is true. See also C.
1215              
1216             NV SvNVX(SV* sv)','name' => 'SvNVX'},'newSVuv' => {'text' => 'Creates a new SV and copies an unsigned integer into it.
1217             The reference count for the SV is set to 1.
1218              
1219             SV* newSVuv(UV u)','name' => 'newSVuv'},'gv_fetchmeth' => {'text' => 'Returns the glob with the given C and a defined subroutine or
1220             C. The glob lives in the given C, or in the stashes
1221             accessible via @ISA and UNIVERSAL::.
1222              
1223             The argument C should be either 0 or -1. If C, as a
1224             side-effect creates a glob with the given C in the given C
1225             which in the case of success contains an alias for the subroutine, and sets
1226             up caching info for this glob. Similarly for all the searched stashes.
1227              
1228             This function grants C<"SUPER"> token as a postfix of the stash name. The
1229             GV returned from C may be a method cache entry, which is not
1230             visible to Perl code. So when calling C, you should not use
1231             the GV directly; instead, you should use the method\'s CV, which can be
1232             obtained from the GV with the C macro.
1233              
1234             GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)','name' => 'gv_fetchmeth'},'sv_nosharing' => {'text' => 'Dummy routine which "shares" an SV when there is no sharing module present.
1235             Exists to avoid test for a NULL function pointer and because it could potentially warn under
1236             some level of strict-ness.
1237              
1238             void sv_nosharing(SV *)','name' => 'sv_nosharing'},'SvUTF8_off' => {'text' => 'Unsets the UTF-8 status of an SV.
1239              
1240             void SvUTF8_off(SV *sv)','name' => 'SvUTF8_off'},'looks_like_number' => {'text' => 'Test if the content of an SV looks like a number (or is a number).
1241             C and C are treated as numbers (so will not issue a
1242             non-numeric warning), even if your atof() doesn\'t grok them.
1243              
1244             I32 looks_like_number(SV* sv)','name' => 'looks_like_number'},'sv_catpv_mg' => {'text' => 'Like C, but also handles \'set\' magic.
1245              
1246             void sv_catpv_mg(SV *sv, const char *ptr)','name' => 'sv_catpv_mg'},'HeHASH' => {'text' => 'Returns the computed hash stored in the hash entry.
1247              
1248             U32 HeHASH(HE* he)','name' => 'HeHASH'},'XSRETURN_EMPTY' => {'text' => 'Return an empty list from an XSUB immediately.
1249              
1250             XSRETURN_EMPTY;','name' => 'XSRETURN_EMPTY'},'sv_setref_uv' => {'text' => 'Copies an unsigned integer into a new SV, optionally blessing the SV. The C
1251             argument will be upgraded to an RV. That RV will be modified to point to
1252             the new SV. The C argument indicates the package for the
1253             blessing. Set C to C to avoid the blessing. The new SV
1254             will have a reference count of 1, and the RV will be returned.
1255              
1256             SV* sv_setref_uv(SV* rv, const char* classname, UV uv)','name' => 'sv_setref_uv'},'SvIOK' => {'text' => 'Returns a boolean indicating whether the SV contains an integer.
1257              
1258             bool SvIOK(SV* sv)','name' => 'SvIOK'},'getcwd_sv' => {'text' => 'Fill the sv with current working directory
1259              
1260             int getcwd_sv(SV* sv)','name' => 'getcwd_sv'},'newSVpv' => {'text' => 'Creates a new SV and copies a string into it. The reference count for the
1261             SV is set to 1. If C is zero, Perl will compute the length using
1262             strlen(). For efficiency, consider using C instead.
1263              
1264             SV* newSVpv(const char* s, STRLEN len)','name' => 'newSVpv'},'sv_2pvbyte' => {'text' => 'Return a pointer to the byte-encoded representation of the SV, and set *lp
1265             to its length. May cause the SV to be downgraded from UTF-8 as a
1266             side-effect.
1267              
1268             Usually accessed via the C macro.
1269              
1270             char* sv_2pvbyte(SV* sv, STRLEN* lp)','name' => 'sv_2pvbyte'},'fbm_instr' => {'text' => 'Returns the location of the SV in the string delimited by C and
1271             C. It returns C if the string can\'t be found. The C
1272             does not have to be fbm_compiled, but the search will not be as fast
1273             then.
1274              
1275             char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)','name' => 'fbm_instr'},'sv_setpvf' => {'text' => 'Works like C but copies the text into the SV instead of
1276             appending it. Does not handle \'set\' magic. See C.
1277              
1278             void sv_setpvf(SV* sv, const char* pat, ...)','name' => 'sv_setpvf'},'SvPV_force' => {'text' => 'Like C but will force the SV into containing just a string
1279             (C). You want force if you are going to update the C
1280             directly.
1281              
1282             char* SvPV_force(SV* sv, STRLEN len)','name' => 'SvPV_force'},'XPUSHn' => {'text' => 'Push a double onto the stack, extending the stack if necessary. Handles
1283             \'set\' magic. Uses C, so C or C should be called to
1284             declare it. Do not call multiple C-oriented macros to return lists
1285             from XSUB\'s - see C instead. See also C and C.
1286              
1287             void XPUSHn(NV nv)','name' => 'XPUSHn'},'SvLEN' => {'text' => 'Returns the size of the string buffer in the SV, not including any part
1288             attributable to C. See C.
1289              
1290             STRLEN SvLEN(SV* sv)','name' => 'SvLEN'},'call_sv' => {'text' => 'Performs a callback to the Perl sub whose name is in the SV. See
1291             L.
1292              
1293             NOTE: the perl_ form of this function is deprecated.
1294              
1295             I32 call_sv(SV* sv, I32 flags)','name' => 'call_sv'},'SVt_PV' => {'text' => 'Pointer type flag for scalars. See C.','name' => 'SVt_PV'},'strGT' => {'text' => 'Test two strings to see if the first, C, is greater than the second,
1296             C. Returns true or false.
1297              
1298             bool strGT(char* s1, char* s2)','name' => 'strGT'},'SvPOK_only_UTF8' => {'text' => 'Tells an SV that it is a string and disables all other OK bits,
1299             and leaves the UTF-8 status as it was.
1300              
1301             void SvPOK_only_UTF8(SV* sv)','name' => 'SvPOK_only_UTF8'},'mg_get' => {'text' => 'Do magic after a value is retrieved from the SV. See C.
1302              
1303             int mg_get(SV* sv)','name' => 'mg_get'},'sv_vcatpvf' => {'text' => 'Processes its arguments like C and appends the formatted output
1304             to an SV. Does not handle \'set\' magic. See C.
1305              
1306             Usually used via its frontend C.
1307              
1308             void sv_vcatpvf(SV* sv, const char* pat, va_list* args)','name' => 'sv_vcatpvf'},'sv_pos_u2b' => {'text' => 'Converts the value pointed to by offsetp from a count of UTF-8 chars from
1309             the start of the string, to a count of the equivalent number of bytes; if
1310             lenp is non-zero, it does the same to lenp, but this time starting from
1311             the offset, rather than from the start of the string. Handles magic and
1312             type coercion.
1313              
1314             void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)','name' => 'sv_pos_u2b'},'SvTRUE' => {'text' => 'Returns a boolean indicating whether Perl would evaluate the SV as true or
1315             false, defined or undefined. Does not handle \'get\' magic.
1316              
1317             bool SvTRUE(SV* sv)','name' => 'SvTRUE'},'HeSVKEY_set' => {'text' => 'Sets the key to a given C, taking care to set the appropriate flags to
1318             indicate the presence of an C key, and returns the same
1319             C.
1320              
1321             SV* HeSVKEY_set(HE* he, SV* sv)','name' => 'HeSVKEY_set'},'POPl' => {'text' => 'Pops a long off the stack.
1322              
1323             long POPl','name' => 'POPl'},'hv_iternext_flags' => {'text' => 'Returns entries from a hash iterator. See C and C.
1324             The C value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1325             set the placeholders keys (for restricted hashes) will be returned in addition
1326             to normal keys. By default placeholders are automatically skipped over.
1327             Currently a placeholder is implemented with a value that is
1328             C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1329             restricted hashes may change, and the implementation currently is
1330             insufficiently abstracted for any change to be tidy.
1331              
1332             NOTE: this function is experimental and may change or be
1333             removed without notice.
1334              
1335             HE* hv_iternext_flags(HV* tb, I32 flags)','name' => 'hv_iternext_flags'},'grok_hex' => {'text' => 'converts a string representing a hex number to numeric form.
1336              
1337             On entry I and I<*len> give the string to scan, I<*flags> gives
1338             conversion flags, and I should be NULL or a pointer to an NV.
1339             The scan stops at the end of the string, or the first invalid character.
1340             Unless C is set in I<*flags>, encountering an
1341             invalid character will also trigger a warning.
1342             On return I<*len> is set to the length of the scanned string,
1343             and I<*flags> gives output flags.
1344              
1345             If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1346             and nothing is written to I<*result>. If the value is > UV_MAX C
1347             returns UV_MAX, sets C in the output flags,
1348             and writes the value to I<*result> (or the value is discarded if I
1349             is NULL).
1350              
1351             The hex number may optionally be prefixed with "0x" or "x" unless
1352             C is set in I<*flags> on entry. If
1353             C is set in I<*flags> then the hex
1354             number may use \'_\' characters to separate digits.
1355              
1356             UV grok_hex(char* start, STRLEN* len, I32* flags, NV *result)','name' => 'grok_hex'},'SPAGAIN' => {'text' => 'Refetch the stack pointer. Used after a callback. See L.
1357              
1358             SPAGAIN;','name' => 'SPAGAIN'},'call_method' => {'text' => 'Performs a callback to the specified Perl method. The blessed object must
1359             be on the stack. See L.
1360              
1361             NOTE: the perl_ form of this function is deprecated.
1362              
1363             I32 call_method(const char* methname, I32 flags)','name' => 'call_method'},'SvLOCK' => {'text' => 'Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
1364             has been loaded.
1365              
1366             void SvLOCK(SV* sv)','name' => 'SvLOCK'},'sv_vsetpvfn' => {'text' => 'Works like C but copies the text into the SV instead of
1367             appending it.
1368              
1369             Usually used via one of its frontends C and C.
1370              
1371             void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)','name' => 'sv_vsetpvfn'},'get_cv' => {'text' => 'Returns the CV of the specified Perl subroutine. If C is set and
1372             the Perl subroutine does not exist then it will be declared (which has the
1373             same effect as saying C). If C is not set and the
1374             subroutine does not exist then NULL is returned.
1375              
1376             NOTE: the perl_ form of this function is deprecated.
1377              
1378             CV* get_cv(const char* name, I32 create)','name' => 'get_cv'},'SvIOKp' => {'text' => 'Returns a boolean indicating whether the SV contains an integer. Checks
1379             the B setting. Use C.
1380              
1381             bool SvIOKp(SV* sv)','name' => 'SvIOKp'},'XST_mUNDEF' => {'text' => 'Place C<&PL_sv_undef> into the specified position C on the
1382             stack.
1383              
1384             void XST_mUNDEF(int pos)','name' => 'XST_mUNDEF'},'perl_parse' => {'text' => 'Tells a Perl interpreter to parse a Perl script. See L.
1385              
1386             int perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)','name' => 'perl_parse'},'to_utf8_case' => {'text' => 'The "p" contains the pointer to the UTF-8 string encoding
1387             the character that is being converted.
1388              
1389             The "ustrp" is a pointer to the character buffer to put the
1390             conversion result to. The "lenp" is a pointer to the length
1391             of the result.
1392              
1393             The "swashp" is a pointer to the swash to use.
1394              
1395             Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
1396             and loaded by SWASHGET, using lib/utf8_heavy.pl. The special (usually,
1397             but not always, a multicharacter mapping), is tried first.
1398              
1399             The "special" is a string like "utf8::ToSpecLower", which means the
1400             hash %utf8::ToSpecLower. The access to the hash is through
1401             Perl_to_utf8_case().
1402              
1403             The "normal" is a string like "ToLower" which means the swash
1404             %utf8::ToLower.
1405              
1406             UV to_utf8_case(U8 *p, U8* ustrp, STRLEN *lenp, SV **swash, char *normal, char *special)','name' => 'to_utf8_case'},'av_clear' => {'text' => 'Clears an array, making it empty. Does not free the memory used by the
1407             array itself.
1408              
1409             void av_clear(AV* ar)','name' => 'av_clear'},'sv_force_normal' => {'text' => 'Undo various types of fakery on an SV: if the PV is a shared string, make
1410             a private copy; if we\'re a ref, stop refing; if we\'re a glob, downgrade to
1411             an xpvmg. See also C.
1412              
1413             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
1414             array. The array will grow automatically to accommodate the addition. You
1415             must then use C to assign values to these new elements.
1416              
1417             void av_unshift(AV* ar, I32 num)','name' => 'av_unshift'},'SvUNLOCK' => {'text' => 'Releases a mutual exclusion lock on sv if a suitable module
1418             has been loaded.
1419              
1420             void SvUNLOCK(SV* sv)','name' => 'SvUNLOCK'},'mg_set' => {'text' => 'Do magic after a value is assigned to the SV. See C.
1421              
1422             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).
1423             The new SV is marked as mortal. It will be destroyed "soon", either by an
1424             explicit call to FREETMPS, or by an implicit call at places such as
1425             statement boundaries. See also C and C.
1426              
1427             SV* sv_mortalcopy(SV* oldsv)','name' => 'sv_mortalcopy'},'POPpbytex' => {'text' => 'Pops a string off the stack which must consist of bytes i.e. characters < 256.
1428             Requires a variable STRLEN n_a in scope.
1429              
1430             char* POPpbytex','name' => 'POPpbytex'},'sv_catpvn_nomg' => {'text' => 'Like C but doesn\'t process magic.
1431              
1432             void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)','name' => 'sv_catpvn_nomg'},'SvUVX' => {'text' => 'Returns the raw value in the SV\'s UV slot, without checks or conversions.
1433             Only use when you are sure SvIOK is true. See also C.
1434              
1435             UV SvUVX(SV* sv)','name' => 'SvUVX'},'G_NOARGS' => {'text' => 'Indicates that no arguments are being sent to a callback. See
1436             L.','name' => 'G_NOARGS'},'SvSetMagicSV' => {'text' => 'Like C, but does any set magic required afterwards.
1437              
1438             void SvSetMagicSV(SV* dsb, SV* ssv)','name' => 'SvSetMagicSV'},'sv_utf8_decode' => {'text' => 'If the PV of the SV is an octet sequence in UTF-8
1439             and contains a multiple-byte character, the C flag is turned on
1440             so that it looks like a character. If the PV contains only single-byte
1441             characters, the C flag stays being off.
1442             Scans PV for validity and returns false if the PV is invalid UTF-8.
1443              
1444             NOTE: this function is experimental and may change or be
1445             removed without notice.
1446              
1447             bool sv_utf8_decode(SV *sv)','name' => 'sv_utf8_decode'},'Newz' => {'text' => 'The XSUB-writer\'s interface to the C C function. The allocated
1448             memory is zeroed with C.
1449              
1450             void Newz(int id, void* ptr, int nitems, type)','name' => 'Newz'},'savepvn' => {'text' => 'Perl\'s version of what C would be if it existed. Returns a
1451             pointer to a newly allocated string which is a duplicate of the first
1452             C bytes from C. The memory allocated for the new string can be
1453             freed with the C function.
1454              
1455             char* savepvn(const char* pv, I32 len)','name' => 'savepvn'},'eval_sv' => {'text' => 'Tells Perl to C the string in the SV.
1456              
1457             NOTE: the perl_ form of this function is deprecated.
1458              
1459             I32 eval_sv(SV* sv, I32 flags)','name' => 'eval_sv'},'FREETMPS' => {'text' => 'Closing bracket for temporaries on a callback. See C and
1460             L.
1461              
1462             FREETMPS;','name' => 'FREETMPS'},'av_exists' => {'text' => 'Returns true if the element indexed by C has been initialized.
1463              
1464             This relies on the fact that uninitialized array elements are set to
1465             C<&PL_sv_undef>.
1466              
1467             bool av_exists(AV* ar, I32 key)','name' => 'av_exists'},'SvCUR' => {'text' => 'Returns the length of the string which is in the SV. See C.
1468              
1469             STRLEN SvCUR(SV* sv)','name' => 'SvCUR'},'Move' => {'text' => 'The XSUB-writer\'s interface to the C C function. The C is the
1470             source, C is the destination, C is the number of items, and C is
1471             the type. Can do overlapping moves. See also C.
1472              
1473             void Move(void* src, void* dest, int nitems, type)','name' => 'Move'},'sv_pvn_force' => {'text' => 'Get a sensible string out of the SV somehow.
1474             A private implementation of the C macro for compilers which
1475             can\'t cope with complex macro expressions. Always use the macro instead.
1476              
1477             char* sv_pvn_force(SV* sv, STRLEN* lp)','name' => 'sv_pvn_force'},'sv_catpvn_flags' => {'text' => 'Concatenates the string onto the end of the string which is in the SV. The
1478             C indicates number of bytes to copy. If the SV has the UTF-8
1479             status set, then the bytes appended should be valid UTF-8.
1480             If C has C bit set, will C on C if
1481             appropriate, else not. C and C are implemented
1482             in terms of this function.
1483              
1484             void sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)','name' => 'sv_catpvn_flags'},'GIMME' => {'text' => 'A backward-compatible version of C which can only return
1485             C or C; in a void context, it returns C.
1486             Deprecated. Use C instead.
1487              
1488             U32 GIMME','name' => 'GIMME'},'sv_bless' => {'text' => 'Blesses an SV into a specified package. The SV must be an RV. The package
1489             must be designated by its stash (see C). The reference count
1490             of the SV is unaffected.
1491              
1492             SV* sv_bless(SV* sv, HV* stash)','name' => 'sv_bless'},'NEWSV' => {'text' => 'Creates a new SV. A non-zero C parameter indicates the number of
1493             bytes of preallocated string space the SV should have. An extra byte for a
1494             tailing NUL is also reserved. (SvPOK is not set for the SV even if string
1495             space is allocated.) The reference count for the new SV is set to 1.
1496             C is an integer id between 0 and 1299 (used to identify leaks).
1497              
1498             SV* NEWSV(int id, STRLEN len)','name' => 'NEWSV'},'sv_isa' => {'text' => 'Returns a boolean indicating whether the SV is blessed into the specified
1499             class. This does not check for subtypes; use C to verify
1500             an inheritance relationship.
1501              
1502             int sv_isa(SV* sv, const char* name)','name' => 'sv_isa'},'isALNUM' => {'text' => 'Returns a boolean indicating whether the C C is an ASCII alphanumeric
1503             character (including underscore) or digit.
1504              
1505             bool isALNUM(char ch)','name' => 'isALNUM'},'newXS' => {'text' => 'Used by C to hook up XSUBs as Perl subs.','name' => 'newXS'},'sv_catpvf' => {'text' => 'Processes its arguments like C and appends the formatted
1506             output to an SV. If the appended data contains "wide" characters
1507             (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
1508             and characters >255 formatted with %c), the original SV might get
1509             upgraded to UTF-8. Handles \'get\' magic, but not \'set\' magic. See
1510             C.
1511              
1512             void sv_catpvf(SV* sv, const char* pat, ...)','name' => 'sv_catpvf'},'SvIOK_UV' => {'text' => 'Returns a boolean indicating whether the SV contains an unsigned integer.
1513              
1514             bool SvIOK_UV(SV* sv)','name' => 'SvIOK_UV'},'XSRETURN_PV' => {'text' => 'Return a copy of a string from an XSUB immediately. Uses C.
1515              
1516             void XSRETURN_PV(char* str)','name' => 'XSRETURN_PV'},'utf8_to_uvuni' => {'text' => 'Returns the Unicode code point of the first character in the string C
1517             which is assumed to be in UTF-8 encoding; C will be set to the
1518             length, in bytes, of that character.
1519              
1520             This function should only be used when returned UV is considered
1521             an index into the Unicode semantic tables (e.g. swashes).
1522              
1523             If C does not point to a well-formed UTF-8 character, zero is
1524             returned and retlen is set, if possible, to -1.
1525              
1526             UV utf8_to_uvuni(U8 *s, STRLEN* retlen)','name' => 'utf8_to_uvuni'},'sv_2io' => {'text' => 'Using various gambits, try to get an IO from an SV: the IO slot if its a
1527             GV; or the recursive result if we\'re an RV; or the IO slot of the symbol
1528             named after the PV if we\'re a string.
1529              
1530             IO* sv_2io(SV* sv)','name' => 'sv_2io'},'PUSHmortal' => {'text' => 'Push a new mortal SV onto the stack. The stack must have room for this
1531             element. Does not handle \'set\' magic. Does not use C. See also
1532             C, C and C.
1533              
1534             void PUSHmortal()','name' => 'PUSHmortal'},'perl_alloc' => {'text' => 'Allocates a new Perl interpreter. See L.
1535              
1536             PerlInterpreter* perl_alloc()','name' => 'perl_alloc'},'isALPHA' => {'text' => 'Returns a boolean indicating whether the C C is an ASCII alphabetic
1537             character.
1538              
1539             bool isALPHA(char ch)','name' => 'isALPHA'},'Nullhv' => {'text' => 'Null HV pointer.','name' => 'Nullhv'},'av_fill' => {'text' => 'Ensure than an array has a given number of elements, equivalent to
1540             Perl\'s C<$#array = $fill;>.
1541              
1542             void av_fill(AV* ar, I32 fill)','name' => 'av_fill'},'SvREFCNT_inc' => {'text' => 'Increments the reference count of the given SV.
1543              
1544             SV* SvREFCNT_inc(SV* sv)','name' => 'SvREFCNT_inc'},'SvTYPE' => {'text' => 'Returns the type of the SV. See C.
1545              
1546             svtype SvTYPE(SV* sv)','name' => 'SvTYPE'},'perl_construct' => {'text' => 'Initializes a new Perl interpreter. See L.
1547              
1548             void perl_construct(PerlInterpreter* interp)','name' => 'perl_construct'},'SvUOK' => {'text' => 'Returns a boolean indicating whether the SV contains an unsigned integer.
1549              
1550             void SvUOK(SV* sv)','name' => 'SvUOK'},'sv_dec' => {'text' => 'Auto-decrement of the value in the SV, doing string to numeric conversion
1551             if necessary. Handles \'get\' magic.
1552              
1553             void sv_dec(SV* sv)','name' => 'sv_dec'},'MoveD' => {'text' => 'Like C but returns dest. Useful for encouraging compilers to tail-call
1554             optimise.
1555              
1556             void * MoveD(void* src, void* dest, int nitems, type)','name' => 'MoveD'},'SvIOK_only' => {'text' => 'Tells an SV that it is an integer and disables all other OK bits.
1557              
1558             void SvIOK_only(SV* sv)','name' => 'SvIOK_only'},'strLE' => {'text' => 'Test two strings to see if the first, C, is less than or equal to the
1559             second, C. Returns true or false.
1560              
1561             bool strLE(char* s1, char* s2)','name' => 'strLE'},'SvROK_off' => {'text' => 'Unsets the RV status of an SV.
1562              
1563             void SvROK_off(SV* sv)','name' => 'SvROK_off'},'Renew' => {'text' => 'The XSUB-writer\'s interface to the C C function.
1564              
1565             void Renew(void* ptr, int nitems, type)','name' => 'Renew'},'grok_bin' => {'text' => 'converts a string representing a binary number to numeric form.
1566              
1567             On entry I and I<*len> give the string to scan, I<*flags> gives
1568             conversion flags, and I should be NULL or a pointer to an NV.
1569             The scan stops at the end of the string, or the first invalid character.
1570             Unless C is set in I<*flags>, encountering an
1571             invalid character will also trigger a warning.
1572             On return I<*len> is set to the length of the scanned string,
1573             and I<*flags> gives output flags.
1574              
1575             If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1576             and nothing is written to I<*result>. If the value is > UV_MAX C
1577             returns UV_MAX, sets C in the output flags,
1578             and writes the value to I<*result> (or the value is discarded if I
1579             is NULL).
1580              
1581             The binary number may optionally be prefixed with "0b" or "b" unless
1582             C is set in I<*flags> on entry. If
1583             C is set in I<*flags> then the binary
1584             number may use \'_\' characters to separate digits.
1585              
1586             UV grok_bin(char* start, STRLEN* len, I32* flags, NV *result)','name' => 'grok_bin'},'sv_2pvbyte_nolen' => {'text' => 'Return a pointer to the byte-encoded representation of the SV.
1587             May cause the SV to be downgraded from UTF-8 as a side-effect.
1588              
1589             Usually accessed via the C macro.
1590              
1591             char* sv_2pvbyte_nolen(SV* sv)','name' => 'sv_2pvbyte_nolen'},'SvOK' => {'text' => 'Returns a boolean indicating whether the value is an SV. It also tells
1592             whether the value is defined or not.
1593              
1594             bool SvOK(SV* sv)','name' => 'SvOK'},'perl_free' => {'text' => 'Releases a Perl interpreter. See L.
1595              
1596             void perl_free(PerlInterpreter* interp)','name' => 'perl_free'},'sv_setref_nv' => {'text' => 'Copies a double into a new SV, optionally blessing the SV. The C
1597             argument will be upgraded to an RV. That RV will be modified to point to
1598             the new SV. The C argument indicates the package for the
1599             blessing. Set C to C to avoid the blessing. The new SV
1600             will have a reference count of 1, and the RV will be returned.
1601              
1602             SV* sv_setref_nv(SV* rv, const char* classname, NV nv)','name' => 'sv_setref_nv'},'uvchr_to_utf8' => {'text' => 'Adds the UTF-8 representation of the Native codepoint C to the end
1603             of the string C; C should be have at least C free
1604             bytes available. The return value is the pointer to the byte after the
1605             end of the new character. In other words,
1606              
1607             d = uvchr_to_utf8(d, uv);
1608              
1609             is the recommended wide native character-aware way of saying
1610              
1611             *(d++) = uv;
1612              
1613             U8* uvchr_to_utf8(U8 *d, UV uv)','name' => 'uvchr_to_utf8'},'mg_find' => {'text' => 'Finds the magic pointer for type matching the SV. See C.
1614              
1615             MAGIC* mg_find(SV* sv, int type)','name' => 'mg_find'},'isDIGIT' => {'text' => 'Returns a boolean indicating whether the C C is an ASCII
1616             digit.
1617              
1618             bool isDIGIT(char ch)','name' => 'isDIGIT'},'SvNOK_on' => {'text' => 'Tells an SV that it is a double.
1619              
1620             void SvNOK_on(SV* sv)','name' => 'SvNOK_on'},'XPUSHmortal' => {'text' => 'Push a new mortal SV onto the stack, extending the stack if necessary. Does
1621             not handle \'set\' magic. Does not use C. See also C,
1622             C and C.
1623              
1624             void XPUSHmortal()','name' => 'XPUSHmortal'},'eval_pv' => {'text' => 'Tells Perl to C the given string and return an SV* result.
1625              
1626             NOTE: the perl_ form of this function is deprecated.
1627              
1628             SV* eval_pv(const char* p, I32 croak_on_error)','name' => 'eval_pv'},'newSVpvn_share' => {'text' => 'Creates a new SV with its SvPVX pointing to a shared string in the string
1629             table. If the string does not already exist in the table, it is created
1630             first. Turns on READONLY and FAKE. The string\'s hash is stored in the UV
1631             slot of the SV; if the C parameter is non-zero, that value is used;
1632             otherwise the hash is computed. The idea here is that as the string table
1633             is used for shared hash keys these strings will have SvPVX == HeKEY and
1634             hash lookup will avoid string compare.
1635              
1636             SV* newSVpvn_share(const char* s, I32 len, U32 hash)','name' => 'newSVpvn_share'},'sv_setpvf_mg' => {'text' => 'Like C, but also handles \'set\' magic.
1637              
1638             void sv_setpvf_mg(SV *sv, const char* pat, ...)','name' => 'sv_setpvf_mg'},'SvPOKp' => {'text' => 'Returns a boolean indicating whether the SV contains a character string.
1639             Checks the B setting. Use C.
1640              
1641             bool SvPOKp(SV* sv)','name' => 'SvPOKp'},'sv_free' => {'text' => 'Decrement an SV\'s reference count, and if it drops to zero, call
1642             C to invoke destructors and free up any memory used by
1643             the body; finally, deallocate the SV\'s head itself.
1644             Normally called via a wrapper macro C.
1645              
1646             void sv_free(SV* sv)','name' => 'sv_free'},'sv_catpvn' => {'text' => 'Concatenates the string onto the end of the string which is in the SV. The
1647             C indicates number of bytes to copy. If the SV has the UTF-8
1648             status set, then the bytes appended should be valid UTF-8.
1649             Handles \'get\' magic, but not \'set\' magic. See C.
1650              
1651             void sv_catpvn(SV* sv, const char* ptr, STRLEN len)','name' => 'sv_catpvn'},'SvPVbyte_force' => {'text' => 'Like C, but converts sv to byte representation first if necessary.
1652              
1653             char* SvPVbyte_force(SV* sv, STRLEN len)','name' => 'SvPVbyte_force'},'newCONSTSUB' => {'text' => 'Creates a constant sub equivalent to Perl C which is
1654             eligible for inlining at compile-time.
1655              
1656             CV* newCONSTSUB(HV* stash, char* name, SV* sv)','name' => 'newCONSTSUB'},'sv_setref_pv' => {'text' => 'Copies a pointer into a new SV, optionally blessing the SV. The C
1657             argument will be upgraded to an RV. That RV will be modified to point to
1658             the new SV. If the C argument is NULL then C will be placed
1659             into the SV. The C argument indicates the package for the
1660             blessing. Set C to C to avoid the blessing. The new SV
1661             will have a reference count of 1, and the RV will be returned.
1662              
1663             Do not use with other Perl types such as HV, AV, SV, CV, because those
1664             objects will become corrupted by the pointer copy process.
1665              
1666             Note that C copies the string while this copies the pointer.
1667              
1668             SV* sv_setref_pv(SV* rv, const char* classname, void* pv)','name' => 'sv_setref_pv'},'SvSHARE' => {'text' => 'Arranges for sv to be shared between threads if a suitable module
1669             has been loaded.
1670              
1671             void SvSHARE(SV* sv)','name' => 'SvSHARE'},'av_pop' => {'text' => 'Pops an SV off the end of the array. Returns C<&PL_sv_undef> if the array
1672             is empty.
1673              
1674             SV* av_pop(AV* ar)','name' => 'av_pop'},'fbm_compile' => {'text' => 'Analyses the string in order to make fast searches on it using fbm_instr()
1675             -- the Boyer-Moore algorithm.
1676              
1677             void fbm_compile(SV* sv, U32 flags)','name' => 'fbm_compile'},'sv_utf8_downgrade' => {'text' => 'Attempts to convert the PV of an SV from characters to bytes.
1678             If the PV contains a character beyond byte, this conversion will fail;
1679             in this case, either returns false or, if C is not
1680             true, croaks.
1681              
1682             This is not as a general purpose Unicode to byte encoding interface:
1683             use the Encode extension for that.
1684              
1685             NOTE: this function is experimental and may change or be
1686             removed without notice.
1687              
1688             bool sv_utf8_downgrade(SV *sv, bool fail_ok)','name' => 'sv_utf8_downgrade'},'SvNIOKp' => {'text' => 'Returns a boolean indicating whether the SV contains a number, integer or
1689             double. Checks the B setting. Use C.
1690              
1691             bool SvNIOKp(SV* sv)','name' => 'SvNIOKp'},'croak' => {'text' => 'This is the XSUB-writer\'s interface to Perl\'s C function.
1692             Normally call this function the same way you call the C C
1693             function. Calling C returns control directly to Perl,
1694             sidestepping the normal C order of execution. See C.
1695              
1696             If you want to throw an exception object, assign the object to
1697             C<$@> and then pass C to croak():
1698              
1699             errsv = get_sv("@", TRUE);
1700             sv_setsv(errsv, exception_object);
1701             croak(Nullch);
1702              
1703             void croak(const char* pat, ...)','name' => 'croak'},'sortsv' => {'text' => 'Sort an array. Here is an example:
1704              
1705             sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale);
1706              
1707             See lib/sort.pm for details about controlling the sorting algorithm.
1708              
1709             void sortsv(SV ** array, size_t num_elts, SVCOMPARE_t cmp)','name' => 'sortsv'},'THIS' => {'text' => 'Variable which is setup by C to designate the object in a C++
1710             XSUB. This is always the proper type for the C++ object. See C and
1711             L.
1712              
1713             (whatever) THIS','name' => 'THIS'},'utf8_hop' => {'text' => 'Return the UTF-8 pointer C displaced by C characters, either
1714             forward or backward.
1715              
1716             WARNING: do not use the following unless you *know* C is within
1717             the UTF-8 data pointed to by C *and* that on entry C is aligned
1718             on the first byte of character or just after the last byte of a character.
1719              
1720             U8* utf8_hop(U8 *s, I32 off)','name' => 'utf8_hop'},'sv_len_utf8' => {'text' => 'Returns the number of characters in the string in an SV, counting wide
1721             UTF-8 bytes as a single character. Handles magic and type coercion.
1722              
1723             STRLEN sv_len_utf8(SV* sv)','name' => 'sv_len_utf8'},'XSRETURN' => {'text' => 'Return from XSUB, indicating number of items on the stack. This is usually
1724             handled by C.
1725              
1726             void XSRETURN(int nitems)','name' => 'XSRETURN'},'sv_setref_pvn' => {'text' => 'Copies a string into a new SV, optionally blessing the SV. The length of the
1727             string must be specified with C. The C argument will be upgraded to
1728             an RV. That RV will be modified to point to the new SV. The C
1729             argument indicates the package for the blessing. Set C to
1730             C to avoid the blessing. The new SV will have a reference count
1731             of 1, and the RV will be returned.
1732              
1733             Note that C copies the pointer while this copies the string.
1734              
1735             SV* sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)','name' => 'sv_setref_pvn'},'SVt_PVMG' => {'text' => 'Type flag for blessed scalars. See C.','name' => 'SVt_PVMG'},'PUSHp' => {'text' => 'Push a string onto the stack. The stack must have room for this element.
1736             The C indicates the length of the string. Handles \'set\' magic. Uses
1737             C, so C or C should be called to declare it. Do not
1738             call multiple C-oriented macros to return lists from XSUB\'s - see
1739             C instead. See also C and C.
1740              
1741             void PUSHp(char* str, STRLEN len)','name' => 'PUSHp'},'scan_bin' => {'text' => 'For backwards compatibility. Use C instead.
1742              
1743             NV scan_bin(char* start, STRLEN len, STRLEN* retlen)','name' => 'scan_bin'},'Nullcv' => {'text' => 'Null CV pointer.','name' => 'Nullcv'},'hv_clear_placeholders' => {'text' => 'Clears any placeholders from a hash. If a restricted hash has any of its keys
1744             marked as readonly and the key is subsequently deleted, the key is not actually
1745             deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1746             it so it will be ignored by future operations such as iterating over the hash,
1747             but will still allow the hash to have a value reassigned to the key at some
1748             future point. This function clears any such placeholder keys from the hash.
1749             See Hash::Util::lock_keys() for an example of its use.
1750              
1751             void hv_clear_placeholders(HV* hb)','name' => 'hv_clear_placeholders'},'mXPUSHi' => {'text' => 'Push an integer onto the stack, extending the stack if necessary. Handles
1752             \'set\' magic. Does not use C. See also C, C and
1753             C.
1754              
1755             void mXPUSHi(IV iv)','name' => 'mXPUSHi'},'dAX' => {'text' => 'Sets up the C variable.
1756             This is usually handled automatically by C by calling C.
1757              
1758             dAX;','name' => 'dAX'},'sv_2pv_nolen' => {'text' => 'Like C, but doesn\'t return the length too. You should usually
1759             use the macro wrapper C instead.
1760             char* sv_2pv_nolen(SV* sv)','name' => 'sv_2pv_nolen'},'get_av' => {'text' => 'Returns the AV of the specified Perl array. If C is set and the
1761             Perl variable does not exist then it will be created. If C is not
1762             set and the variable does not exist then NULL is returned.
1763              
1764             NOTE: the perl_ form of this function is deprecated.
1765              
1766             AV* get_av(const char* name, I32 create)','name' => 'get_av'},'PL_sv_undef' => {'text' => 'This is the C SV. Always refer to this as C<&PL_sv_undef>.
1767              
1768             SV PL_sv_undef','name' => 'PL_sv_undef'},'SvPVbyte' => {'text' => 'Like C, but converts sv to byte representation first if necessary.
1769              
1770             char* SvPVbyte(SV* sv, STRLEN len)','name' => 'SvPVbyte'},'hv_iterkeysv' => {'text' => 'Returns the key as an C from the current position of the hash
1771             iterator. The return value will always be a mortal copy of the key. Also
1772             see C.
1773              
1774             SV* hv_iterkeysv(HE* entry)','name' => 'hv_iterkeysv'},'grok_number' => {'text' => 'Recognise (or not) a number. The type of the number is returned
1775             (0 if unrecognised), otherwise it is a bit-ORed combination of
1776             IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
1777             IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
1778              
1779             If the value of the number can fit an in UV, it is returned in the *valuep
1780             IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
1781             will never be set unless *valuep is valid, but *valuep may have been assigned
1782             to during processing even though IS_NUMBER_IN_UV is not set on return.
1783             If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
1784             valuep is non-NULL, but no actual assignment (or SEGV) will occur.
1785              
1786             IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
1787             seen (in which case *valuep gives the true value truncated to an integer), and
1788             IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
1789             absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
1790             number is larger than a UV.
1791              
1792             int grok_number(const char *pv, STRLEN len, UV *valuep)','name' => 'grok_number'},'SvIVx' => {'text' => 'Coerces the given SV to an integer and returns it. Guarantees to evaluate
1793             sv only once. Use the more efficient C otherwise.
1794              
1795             IV SvIVx(SV* sv)','name' => 'SvIVx'},'grok_numeric_radix' => {'text' => 'Scan and skip for a numeric decimal separator (radix).
1796              
1797             bool grok_numeric_radix(const char **sp, const char *send)','name' => 'grok_numeric_radix'},'XST_mNO' => {'text' => 'Place C<&PL_sv_no> into the specified position C on the
1798             stack.
1799              
1800             void XST_mNO(int pos)','name' => 'XST_mNO'},'toUPPER' => {'text' => 'Converts the specified character to uppercase.
1801              
1802             char toUPPER(char ch)','name' => 'toUPPER'},'mPUSHp' => {'text' => 'Push a string onto the stack. The stack must have room for this element.
1803             The C indicates the length of the string. Handles \'set\' magic. Does
1804             not use C. See also C, C and C.
1805              
1806             void mPUSHp(char* str, STRLEN len)','name' => 'mPUSHp'},'av_delete' => {'text' => 'Deletes the element indexed by C from the array. Returns the
1807             deleted element. If C equals C, the element is freed
1808             and null is returned.
1809              
1810             SV* av_delete(AV* ar, I32 key, I32 flags)','name' => 'av_delete'},'is_utf8_string_loc' => {'text' => 'Like is_ut8_string but store the location of the failure in
1811             the last argument.
1812              
1813             bool is_utf8_string_loc(U8 *s, STRLEN len, U8 **p)','name' => 'is_utf8_string_loc'},'utf8_distance' => {'text' => 'Returns the number of UTF-8 characters between the UTF-8 pointers C
1814             and C.
1815              
1816             WARNING: use only if you *know* that the pointers point inside the
1817             same UTF-8 buffer.
1818              
1819             IV utf8_distance(U8 *a, U8 *b)','name' => 'utf8_distance'},'SAVETMPS' => {'text' => 'Opening bracket for temporaries on a callback. See C and
1820             L.
1821              
1822             SAVETMPS;','name' => 'SAVETMPS'},'sv_gets' => {'text' => 'Get a line from the filehandle and store it into the SV, optionally
1823             appending to the currently-stored string.
1824              
1825             char* sv_gets(SV* sv, PerlIO* fp, I32 append)','name' => 'sv_gets'},'AvFILL' => {'text' => 'Same as C. Deprecated, use C instead.
1826              
1827             int AvFILL(AV* av)','name' => 'AvFILL'},'SvPVutf8x' => {'text' => 'Like C, but converts sv to utf8 first if necessary.
1828             Guarantees to evaluate sv only once; use the more efficient C
1829             otherwise.
1830              
1831             char* SvPVutf8x(SV* sv, STRLEN len)','name' => 'SvPVutf8x'},'ORIGMARK' => {'text' => 'The original stack mark for the XSUB. See C.','name' => 'ORIGMARK'},'sv_collxfrm' => {'text' => 'Add Collate Transform magic to an SV if it doesn\'t already have it.
1832              
1833             Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
1834             scalar data of the variable, but transformed to such a format that a normal
1835             memory comparison can be used to compare the data according to the locale
1836             settings.
1837              
1838             char* sv_collxfrm(SV* sv, STRLEN* nxp)','name' => 'sv_collxfrm'},'sv_2cv' => {'text' => 'Using various gambits, try to get a CV from an SV; in addition, try if
1839             possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
1840              
1841             CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)','name' => 'sv_2cv'},'ZeroD' => {'text' => 'Like C but returns dest. Useful for encouraging compilers to tail-call
1842             optimise.
1843              
1844             void * ZeroD(void* dest, int nitems, type)','name' => 'ZeroD'},'SvPV_force_nomg' => {'text' => 'Like C but will force the SV into containing just a string
1845             (C). You want force if you are going to update the C
1846             directly. Doesn\'t process magic.
1847              
1848             char* SvPV_force_nomg(SV* sv, STRLEN len)','name' => 'SvPV_force_nomg'},'SP' => {'text' => 'Stack pointer. This is usually handled by C. See C and
1849             C.','name' => 'SP'},'SvPOK_only' => {'text' => 'Tells an SV that it is a string and disables all other OK bits.
1850             Will also turn off the UTF-8 status.
1851              
1852             void SvPOK_only(SV* sv)','name' => 'SvPOK_only'},'SvSetSV_nosteal' => {'text' => 'Calls a non-destructive version of C if dsv is not the same as
1853             ssv. May evaluate arguments more than once.
1854              
1855             void SvSetSV_nosteal(SV* dsv, SV* ssv)','name' => 'SvSetSV_nosteal'},'sv_catpvn_mg' => {'text' => 'Like C, but also handles \'set\' magic.
1856              
1857             void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)','name' => 'sv_catpvn_mg'},'POPpx' => {'text' => 'Pops a string off the stack.
1858             Requires a variable STRLEN n_a in scope.
1859              
1860             char* POPpx','name' => 'POPpx'},'sv_usepvn_mg' => {'text' => 'Like C, but also handles \'set\' magic.
1861              
1862             void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)','name' => 'sv_usepvn_mg'},'sv_uv' => {'text' => 'A private implementation of the C macro for compilers which can\'t
1863             cope with complex macro expressions. Always use the macro instead.
1864              
1865             UV sv_uv(SV* sv)','name' => 'sv_uv'},'sv_pvbyte' => {'text' => 'Use C instead.
1866              
1867             char* sv_pvbyte(SV *sv)','name' => 'sv_pvbyte'},'SvSTASH' => {'text' => 'Returns the stash of the SV.
1868              
1869             HV* SvSTASH(SV* sv)','name' => 'SvSTASH'},'hv_fetch' => {'text' => 'Returns the SV which corresponds to the specified key in the hash. The
1870             C is the length of the key. If C is set then the fetch will be
1871             part of a store. Check that the return value is non-null before
1872             dereferencing it to an C.
1873              
1874             See L for more
1875             information on how to use this function on tied hashes.
1876              
1877             SV** hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)','name' => 'hv_fetch'},'Zero' => {'text' => 'The XSUB-writer\'s interface to the C C function. The C is the
1878             destination, C is the number of items, and C is the type.
1879              
1880             void Zero(void* dest, int nitems, type)','name' => 'Zero'},'PL_modglobal' => {'text' => 'C is a general purpose, interpreter global HV for use by
1881             extensions that need to keep information on a per-interpreter basis.
1882             In a pinch, it can also be used as a symbol table for extensions
1883             to share data among each other. It is a good idea to use keys
1884             prefixed by the package name of the extension that owns the data.
1885              
1886             HV* PL_modglobal','name' => 'PL_modglobal'},'XSRETURN_UNDEF' => {'text' => 'Return C<&PL_sv_undef> from an XSUB immediately. Uses C.
1887              
1888             XSRETURN_UNDEF;','name' => 'XSRETURN_UNDEF'},'sv_unref_flags' => {'text' => 'Unsets the RV status of the SV, and decrements the reference count of
1889             whatever was being referenced by the RV. This can almost be thought of
1890             as a reversal of C. The C argument can contain
1891             C to force the reference count to be decremented
1892             (otherwise the decrementing is conditional on the reference count being
1893             different from one or the reference being a readonly SV).
1894             See C.
1895              
1896             void sv_unref_flags(SV* sv, U32 flags)','name' => 'sv_unref_flags'},'sv_iv' => {'text' => 'A private implementation of the C macro for compilers which can\'t
1897             cope with complex macro expressions. Always use the macro instead.
1898              
1899             IV sv_iv(SV* sv)','name' => 'sv_iv'},'SvRV' => {'text' => 'Dereferences an RV to return the SV.
1900              
1901             SV* SvRV(SV* sv)','name' => 'SvRV'},'hv_scalar' => {'text' => 'Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1902              
1903             SV* hv_scalar(HV* hv)','name' => 'hv_scalar'},'Nullch' => {'text' => 'Null character pointer.','name' => 'Nullch'},'mg_copy' => {'text' => 'Copies the magic from one SV to another. See C.
1904              
1905             int mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)','name' => 'mg_copy'},'HeSVKEY_force' => {'text' => 'Returns the key as an C. Will create and return a temporary mortal
1906             C if the hash entry contains only a C key.
1907              
1908             SV* HeSVKEY_force(HE* he)','name' => 'HeSVKEY_force'},'sv_rvweaken' => {'text' => 'Weaken a reference: set the C flag on this RV; give the
1909             referred-to SV C magic if it hasn\'t already; and
1910             push a back-reference to this RV onto the array of backreferences
1911             associated with that magic.
1912              
1913             SV* sv_rvweaken(SV *sv)','name' => 'sv_rvweaken'},'grok_oct' => {'text' => 'converts a string representing an octal number to numeric form.
1914              
1915             On entry I and I<*len> give the string to scan, I<*flags> gives
1916             conversion flags, and I should be NULL or a pointer to an NV.
1917             The scan stops at the end of the string, or the first invalid character.
1918             Unless C is set in I<*flags>, encountering an
1919             invalid character will also trigger a warning.
1920             On return I<*len> is set to the length of the scanned string,
1921             and I<*flags> gives output flags.
1922              
1923             If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
1924             and nothing is written to I<*result>. If the value is > UV_MAX C
1925             returns UV_MAX, sets C in the output flags,
1926             and writes the value to I<*result> (or the value is discarded if I
1927             is NULL).
1928              
1929             If C is set in I<*flags> then the octal
1930             number may use \'_\' characters to separate digits.
1931              
1932             UV grok_oct(char* start, STRLEN* len, I32* flags, NV *result)','name' => 'grok_oct'},'MARK' => {'text' => 'Stack marker variable for the XSUB. See C.','name' => 'MARK'},'scan_hex' => {'text' => 'For backwards compatibility. Use C instead.
1933              
1934             NV scan_hex(char* start, STRLEN len, STRLEN* retlen)','name' => 'scan_hex'},'newSVpvn' => {'text' => 'Creates a new SV and copies a string into it. The reference count for the
1935             SV is set to 1. Note that if C is zero, Perl will create a zero length
1936             string. You are responsible for ensuring that the source string is at least
1937             C bytes long. If the C argument is NULL the new SV will be undefined.
1938              
1939             SV* newSVpvn(const char* s, STRLEN len)','name' => 'newSVpvn'},'sv_magicext' => {'text' => 'Adds magic to an SV, upgrading it if necessary. Applies the
1940             supplied vtable and returns a pointer to the magic added.
1941              
1942             Note that C will allow things that C will not.
1943             In particular, you can add magic to SvREADONLY SVs, and add more than
1944             one instance of the same \'how\'.
1945              
1946             If C is greater than zero then a C I of C is
1947             stored, if C is zero then C is stored as-is and - as another
1948             special case - if C<(name && namlen == HEf_SVKEY)> then C is assumed
1949             to contain an C and is stored as-is with its REFCNT incremented.
1950              
1951             (This is now used as a subroutine by C.)
1952              
1953             MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen )','name' => 'sv_magicext'},'newRV_inc' => {'text' => 'Creates an RV wrapper for an SV. The reference count for the original SV is
1954             incremented.
1955              
1956             SV* newRV_inc(SV* sv)','name' => 'newRV_inc'},'SVt_PVCV' => {'text' => 'Type flag for code refs. See C.','name' => 'SVt_PVCV'},'av_push' => {'text' => 'Pushes an SV onto the end of the array. The array will grow automatically
1957             to accommodate the addition.
1958              
1959             void av_push(AV* ar, SV* val)','name' => 'av_push'},'unpackstring' => {'text' => 'The engine implementing unpack() Perl function. C puts the
1960             extracted list items on the stack and returns the number of elements.
1961             Issue C before and C after the call to this function.
1962              
1963             I32 unpackstring(char *pat, char *patend, char *s, char *strend, U32 flags)','name' => 'unpackstring'},'POPn' => {'text' => 'Pops a double off the stack.
1964              
1965             NV POPn','name' => 'POPn'},'XSRETURN_NO' => {'text' => 'Return C<&PL_sv_no> from an XSUB immediately. Uses C.
1966              
1967             XSRETURN_NO;','name' => 'XSRETURN_NO'},'av_extend' => {'text' => 'Pre-extend an array. The C is the index to which the array should be
1968             extended.
1969              
1970             void av_extend(AV* ar, I32 key)','name' => 'av_extend'},'newRV_noinc' => {'text' => 'Creates an RV wrapper for an SV. The reference count for the original
1971             SV is B incremented.
1972              
1973             SV* newRV_noinc(SV *sv)','name' => 'newRV_noinc'},'sv_setpviv_mg' => {'text' => 'Like C, but also handles \'set\' magic.
1974              
1975             void sv_setpviv_mg(SV *sv, IV iv)','name' => 'sv_setpviv_mg'},'SvUVx' => {'text' => 'Coerces the given SV to an unsigned integer and returns it. Guarantees to
1976             evaluate sv only once. Use the more efficient C otherwise.
1977              
1978             UV SvUVx(SV* sv)','name' => 'SvUVx'},'SvROK_on' => {'text' => 'Tells an SV that it is an RV.
1979              
1980             void SvROK_on(SV* sv)','name' => 'SvROK_on'},'sv_2bool' => {'text' => 'This function is only called on magical items, and is only used by
1981             sv_true() or its macro equivalent.
1982              
1983             bool sv_2bool(SV* sv)','name' => 'sv_2bool'},'hv_iternext' => {'text' => 'Returns entries from a hash iterator. See C.
1984              
1985             You may call C or C on the hash entry that the
1986             iterator currently points to, without losing your place or invalidating your
1987             iterator. Note that in this case the current entry is deleted from the hash
1988             with your iterator holding the last reference to it. Your iterator is flagged
1989             to free the entry on the next call to C, so you must not discard
1990             your iterator immediately else the entry will leak - call C to
1991             trigger the resource deallocation.
1992              
1993             HE* hv_iternext(HV* tb)','name' => 'hv_iternext'},'G_VOID' => {'text' => 'Used to indicate void context. See C and L.','name' => 'G_VOID'},'dORIGMARK' => {'text' => 'Saves the original stack mark for the XSUB. See C.
1994              
1995             dORIGMARK;','name' => 'dORIGMARK'},'sv_newmortal' => {'text' => 'Creates a new null SV which is mortal. The reference count of the SV is
1996             set to 1. It will be destroyed "soon", either by an explicit call to
1997             FREETMPS, or by an implicit call at places such as statement boundaries.
1998             See also C and C.
1999              
2000             SV* sv_newmortal()','name' => 'sv_newmortal'},'sv_clear' => {'text' => 'Clear an SV: call any destructors, free up any memory used by the body,
2001             and free the body itself. The SV\'s head is I freed, although
2002             its type is set to all 1\'s so that it won\'t inadvertently be assumed
2003             to be live during global destruction etc.
2004             This function should only be called when REFCNT is zero. Most of the time
2005             you\'ll want to call C (or its macro wrapper C)
2006             instead.
2007              
2008             void sv_clear(SV* sv)','name' => 'sv_clear'},'hv_iterinit' => {'text' => 'Prepares a starting point to traverse a hash table. Returns the number of
2009             keys in the hash (i.e. the same as C). The return value is
2010             currently only meaningful for hashes without tie magic.
2011              
2012             NOTE: Before version 5.004_65, C used to return the number of
2013             hash buckets that happen to be in use. If you still need that esoteric
2014             value, you can get it through the macro C.
2015              
2016              
2017             I32 hv_iterinit(HV* tb)','name' => 'hv_iterinit'}};};
2018              
2019 1         26 my $self = bless({
2020             'index' => $VAR1,
2021             perl_version => '5.008006',
2022             } => $class);
2023 1         281 return $self;
2024             }
2025              
2026             1;