File Coverage

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