File Coverage

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


line stmt bran cond sub pod time code
1             package Perl::APIReference::V5_010_001;
2 1     1   5 use strict;
  1         2  
  1         41  
3 1     1   4 use warnings;
  1         2  
  1         29  
4 1     1   4 use parent 'Perl::APIReference';
  1         1  
  1         8  
5              
6             sub new {
7 1     1 1 2 my $class = shift;
8 1         2 my $VAR1;
9              
10 1         2 do{$VAR1 = {'hv_store_ent' => {'text' => 'Stores C in a hash. The hash key is specified as C. The C
  1         916  
11             parameter is the precomputed hash value; if it is zero then Perl will
12             compute it. The return value is the new hash entry so created. It will be
13             NULL if the operation failed or if the value did not need to be actually
14             stored within the hash (as in the case of tied hashes). Otherwise the
15             contents of the return value can be accessed using the C macros
16             described here. Note that the caller is responsible for suitably
17             incrementing the reference count of C before the call, and
18             decrementing it if the function returned NULL. Effectively a successful
19             hv_store_ent takes ownership of one reference to C. This is
20             usually what you want; a newly created SV has a reference count of one, so
21             if all your code does is create SVs then store them in a hash, hv_store
22             will own the only reference to the new SV, and your code doesn\'t need to do
23             anything further to tidy up. Note that hv_store_ent only reads the C;
24             unlike C it does not take ownership of it, so maintaining the correct
25             reference count on C is entirely the caller\'s responsibility. hv_store
26             is not implemented as a call to hv_store_ent, and does not create a temporary
27             SV for the key, so if your key data is not already in SV form then use
28             hv_store in preference to hv_store_ent.
29              
30             See L for more
31             information on how to use this function on tied hashes.
32              
33             HE* hv_store_ent(HV *hv, SV *key, SV *val, U32 hash)','name' => 'hv_store_ent'},'gv_stashsv' => {'text' => 'Returns a pointer to the stash for a specified package. See C.
34              
35             HV* gv_stashsv(SV* sv, I32 flags)','name' => 'gv_stashsv'},'newXSproto' => {'text' => 'Used by C to hook up XSUBs as Perl subs. Adds Perl prototypes to
36             the subs.','name' => 'newXSproto'},'strGE' => {'text' => 'Test two strings to see if the first, C, is greater than or equal to
37             the second, C. Returns true or false.
38              
39             bool strGE(char* s1, char* s2)','name' => 'strGE'},'form' => {'text' => 'Takes a sprintf-style format pattern and conventional
40             (non-SV) arguments and returns the formatted string.
41              
42             (char *) Perl_form(pTHX_ const char* pat, ...)
43              
44             can be used any place a string (char *) is required:
45              
46             char * s = Perl_form("%d.%d",major,minor);
47              
48             Uses a single private buffer so if you want to format several strings you
49             must explicitly copy the earlier strings away (and free the copies when you
50             are done).
51              
52             char* form(const char* pat, ...)','name' => 'form'},'SvPV' => {'text' => 'Returns a pointer to the string in the SV, or a stringified form of
53             the SV if the SV does not contain a string. The SV may cache the
54             stringified version becoming C. Handles \'get\' magic. See also
55             C for a version which guarantees to evaluate sv only once.
56              
57             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
58             UTF-8 string, false otherwise. Note that \'a valid UTF-8 string\' does
59             not mean \'a string that contains code points above 0x7F encoded in UTF-8\'
60             because a valid ASCII string is a valid UTF-8 string.
61              
62             See also is_utf8_string_loclen() and is_utf8_string_loc().
63              
64             bool is_utf8_string(const U8 *s, STRLEN len)','name' => 'is_utf8_string'},'croak_xs_usage' => {'text' => 'A specialised variant of C for emitting the usage message for xsubs
65              
66             croak_xs_usage(cv, "eee_yow");
67              
68             works out the package name and subroutine name from C, and then calls
69             C. Hence if C is C<&ouch::awk>, it would call C as:
70              
71             Perl_croak(aTHX_ "Usage %s::%s(%s)", "ouch" "awk", "eee_yow");
72              
73             void croak_xs_usage(const CV *const cv, const char *const params)','name' => 'croak_xs_usage'},'sv_insert' => {'text' => 'Inserts a string at the specified offset/length within the SV. Similar to
74             the Perl substr() function. Handles get magic.
75              
76             void sv_insert(SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)','name' => 'sv_insert'},'SvPOK' => {'text' => 'Returns a U32 value indicating whether the SV contains a character
77             string.
78              
79             U32 SvPOK(SV* sv)','name' => 'SvPOK'},'sv_vsetpvf_mg' => {'text' => 'Like C, but also handles \'set\' magic.
80              
81             Usually used via its frontend C.
82              
83             void sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args)','name' => 'sv_vsetpvf_mg'},'sv_destroyable' => {'text' => 'Dummy routine which reports that object can be destroyed when there is no
84             sharing module present. It ignores its single SV argument, and returns
85             \'true\'. Exists to avoid test for a NULL function pointer and because it
86             could potentially warn under some level of strict-ness.
87              
88             bool sv_destroyable(SV *sv)','name' => 'sv_destroyable'},'SvPVutf8' => {'text' => 'Like C, but converts sv to utf8 first if necessary.
89              
90             char* SvPVutf8(SV* sv, STRLEN len)','name' => 'SvPVutf8'},'sortsv_flags' => {'text' => 'Sort an array, with various options.
91              
92             void sortsv_flags(SV** array, size_t num_elts, SVCOMPARE_t cmp, U32 flags)','name' => 'sortsv_flags'},'XS' => {'text' => 'Macro to declare an XSUB and its C parameter list. This is handled by
93             C.','name' => 'XS'},'scan_oct' => {'text' => 'For backwards compatibility. Use C instead.
94              
95             NV scan_oct(const 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
96             bytes to be copied. If the C argument is NULL the SV will become
97             undefined. Does not handle \'set\' magic. See C.
98              
99             void sv_setpvn(SV* sv, const char* ptr, STRLEN len)','name' => 'sv_setpvn'},'mg_magical' => {'text' => 'Turns on the magical status of an SV. See C.
100              
101             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
102             it will be upgraded to one. If C is non-null then the new SV will
103             be blessed in the specified package. The new SV is returned and its
104             reference count is 1.
105              
106             SV* newSVrv(SV* rv, const char* classname)','name' => 'newSVrv'},'strnEQ' => {'text' => 'Test two strings to see if they are equal. The C parameter indicates
107             the number of bytes to compare. Returns true or false. (A wrapper for
108             C).
109              
110             bool strnEQ(char* s1, char* s2, STRLEN len)','name' => 'strnEQ'},'find_runcv' => {'text' => 'Locate the CV corresponding to the currently executing sub or eval.
111             If db_seqp is non_null, skip CVs that are in the DB package and populate
112             *db_seqp with the cop sequence number at the point that the DB:: code was
113             entered. (allows debuggers to eval in the scope of the breakpoint rather
114             than in the scope of the debugger itself).
115              
116             CV* find_runcv(U32 *db_seqp)','name' => 'find_runcv'},'PoisonWith' => {'text' => 'Fill up memory with a byte pattern (a byte repeated over and over
117             again) that hopefully catches attempts to access uninitialized memory.
118              
119             void PoisonWith(void* dest, int nitems, type, U8 byte)','name' => 'PoisonWith'},'utf8n_to_uvuni' => {'text' => 'Bottom level UTF-8 decode routine.
120             Returns the Unicode code point value of the first character in the string C
121             which is assumed to be in UTF-8 encoding and no longer than C;
122             C will be set to the length, in bytes, of that character.
123              
124             If C does not point to a well-formed UTF-8 character, the behaviour
125             is dependent on the value of C: if it contains UTF8_CHECK_ONLY,
126             it is assumed that the caller will raise a warning, and this function
127             will silently just set C to C<-1> and return zero. If the
128             C does not contain UTF8_CHECK_ONLY, warnings about
129             malformations will be given, C will be set to the expected
130             length of the UTF-8 character in bytes, and zero will be returned.
131              
132             The C can also contain various flags to allow deviations from
133             the strict UTF-8 encoding (see F).
134              
135             Most code should use utf8_to_uvchr() rather than call this directly.
136              
137             UV utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)','name' => 'utf8n_to_uvuni'},'av_create_and_unshift_one' => {'text' => 'Unshifts an SV onto the beginning of the array, creating the array if
138             necessary.
139             A small internal helper function to remove a commonly duplicated idiom.
140              
141             NOTE: this function is experimental and may change or be
142             removed without notice.
143              
144             SV** av_create_and_unshift_one(AV **const avp, SV *const val)','name' => 'av_create_and_unshift_one'},'SvNIOK_off' => {'text' => 'Unsets the NV/IV status of an SV.
145              
146             void SvNIOK_off(SV* sv)','name' => 'SvNIOK_off'},'newSVpvn_utf8' => {'text' => 'Creates a new SV and copies a string into it. If utf8 is true, calls
147             C on the new SV. Implemented as a wrapper around C.
148              
149             SV* newSVpvn_utf8(NULLOK const char* s, STRLEN len, U32 utf8)','name' => 'newSVpvn_utf8'},'sv_magic' => {'text' => 'Adds magic to an SV. First upgrades C to type C if necessary,
150             then adds a new magic item of type C to the head of the magic list.
151              
152             See C (which C now calls) for a description of the
153             handling of the C and C arguments.
154              
155             You need to use C to add magic to SvREADONLY SVs and also
156             to add more than one instance of the same \'how\'.
157              
158             void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)','name' => 'sv_magic'},'dMARK' => {'text' => 'Declare a stack marker variable, C, for the XSUB. See C and
159             C.
160              
161             dMARK;','name' => 'dMARK'},'sv_utf8_upgrade_flags' => {'text' => 'Converts the PV of an SV to its UTF-8-encoded form.
162             Forces the SV to string form if it is not already.
163             Always sets the SvUTF8 flag to avoid future validity checks even
164             if all the bytes are invariant in UTF-8. If C has C bit set,
165             will C on C if appropriate, else not.
166             Returns the number of bytes in the converted string
167             C and
168             C are implemented in terms of this function.
169              
170             This is not as a general purpose byte encoding to Unicode interface:
171             use the Encode extension for that.
172              
173             STRLEN sv_utf8_upgrade_flags(SV *sv, I32 flags)','name' => 'sv_utf8_upgrade_flags'},'ibcmp_utf8' => {'text' => 'Return true if the strings s1 and s2 differ case-insensitively, false
174             if not (if they are equal case-insensitively). If u1 is true, the
175             string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true,
176             the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2
177             are false, the respective string is assumed to be in native 8-bit
178             encoding.
179              
180             If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
181             in there (they will point at the beginning of the I character).
182             If the pointers behind pe1 or pe2 are non-NULL, they are the end
183             pointers beyond which scanning will not continue under any
184             circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and
185             s2+l2 will be used as goal end pointers that will also stop the scan,
186             and which qualify towards defining a successful match: all the scans
187             that define an explicit length must reach their goal pointers for
188             a match to succeed).
189              
190             For case-insensitiveness, the "casefolding" of Unicode is used
191             instead of upper/lowercasing both the characters, see
192             http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
193              
194             I32 ibcmp_utf8(const char *s1, char **pe1, UV l1, bool u1, const char *s2, char **pe2, UV l2, bool u2)','name' => 'ibcmp_utf8'},'SvREFCNT_inc_void' => {'text' => 'Same as SvREFCNT_inc, but can only be used if you don\'t need the
195             return value. The macro doesn\'t need to return a meaningful value.
196              
197             void SvREFCNT_inc_void(SV* sv)','name' => 'SvREFCNT_inc_void'},'mXPUSHp' => {'text' => 'Push a string onto the stack, extending the stack if necessary. The C
198             indicates the length of the string. Does not use C. See also C,
199             C and C.
200              
201             void mXPUSHp(char* str, STRLEN len)','name' => 'mXPUSHp'},'CvSTASH' => {'text' => 'Returns the stash of the CV.
202              
203             HV* CvSTASH(CV* cv)','name' => 'CvSTASH'},'gv_const_sv' => {'text' => 'If C is a typeglob whose subroutine entry is a constant sub eligible for
204             inlining, or C is a placeholder reference that would be promoted to such
205             a typeglob, then returns the value returned by the sub. Otherwise, returns
206             NULL.
207              
208             SV* gv_const_sv(GV* gv)','name' => 'gv_const_sv'},'sv_replace' => {'text' => 'Make the first argument a copy of the second, then delete the original.
209             The target SV physically takes over ownership of the body of the source SV
210             and inherits its flags; however, the target keeps any magic it owns,
211             and any magic in the source is discarded.
212             Note that this is a rather specialist SV copying operation; most of the
213             time you\'ll want to use C or one of its many macro front-ends.
214              
215             void sv_replace(SV* sv, SV* nsv)','name' => 'sv_replace'},'utf8n_to_uvchr' => {'text' => 'flags
216              
217             Returns the native character value of the first character in the string
218             C
219             which is assumed to be in UTF-8 encoding; C will be set to the
220             length, in bytes, of that character.
221              
222             Allows length and flags to be passed to low level routine.
223              
224             UV utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)','name' => 'utf8n_to_uvchr'},'G_ARRAY' => {'text' => 'Used to indicate list context. See C, C and
225             L.','name' => 'G_ARRAY'},'XS_VERSION_BOOTCHECK' => {'text' => 'Macro to verify that a PM module\'s $VERSION variable matches the XS
226             module\'s C variable. This is usually handled automatically by
227             C. See L.
228              
229             XS_VERSION_BOOTCHECK;','name' => 'XS_VERSION_BOOTCHECK'},'SvROK' => {'text' => 'Tests if the SV is an RV.
230              
231             U32 SvROK(SV* sv)','name' => 'SvROK'},'mXPUSHn' => {'text' => 'Push a double onto the stack, extending the stack if necessary.
232             Does not use C. See also C, C and C.
233              
234             void mXPUSHn(NV nv)','name' => 'mXPUSHn'},'sv_unref' => {'text' => 'Unsets the RV status of the SV, and decrements the reference count of
235             whatever was being referenced by the RV. This can almost be thought of
236             as a reversal of C. This is C with the C
237             being zero. See C.
238              
239             void sv_unref(SV* sv)','name' => 'sv_unref'},'SvSETMAGIC' => {'text' => 'Invokes C on an SV if it has \'set\' magic. This macro evaluates its
240             argument more than once.
241              
242             void SvSETMAGIC(SV* sv)','name' => 'SvSETMAGIC'},'G_EVAL' => {'text' => 'Used to force a Perl C wrapper around a callback. See
243             L.','name' => 'G_EVAL'},'sv_catsv_mg' => {'text' => 'Like C, but also handles \'set\' magic.
244              
245             void sv_catsv_mg(SV *dsv, SV *ssv)','name' => 'sv_catsv_mg'},'call_argv' => {'text' => 'Performs a callback to the specified Perl sub. See L.
246              
247             NOTE: the perl_ form of this function is deprecated.
248              
249             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
250             the SV if the SV does not contain a string. The SV may cache the
251             stringified form becoming C. Handles \'get\' magic.
252              
253             char* SvPV_nolen(SV* sv)','name' => 'SvPV_nolen'},'perl_clone' => {'text' => 'Create and return a new interpreter by cloning the current one.
254              
255             perl_clone takes these flags as parameters:
256              
257             CLONEf_COPY_STACKS - is used to, well, copy the stacks also,
258             without it we only clone the data and zero the stacks,
259             with it we copy the stacks and the new perl interpreter is
260             ready to run at the exact same point as the previous one.
261             The pseudo-fork code uses COPY_STACKS while the
262             threads->create doesn\'t.
263              
264             CLONEf_KEEP_PTR_TABLE
265             perl_clone keeps a ptr_table with the pointer of the old
266             variable as a key and the new variable as a value,
267             this allows it to check if something has been cloned and not
268             clone it again but rather just use the value and increase the
269             refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill
270             the ptr_table using the function
271             C,
272             reason to keep it around is if you want to dup some of your own
273             variable who are outside the graph perl scans, example of this
274             code is in threads.xs create
275              
276             CLONEf_CLONE_HOST
277             This is a win32 thing, it is ignored on unix, it tells perls
278             win32host code (which is c++) to clone itself, this is needed on
279             win32 if you want to run two threads at the same time,
280             if you just want to do some stuff in a separate perl interpreter
281             and then throw it away and return to the original one,
282             you don\'t need to do anything.
283              
284             PerlInterpreter* perl_clone(PerlInterpreter *proto_perl, UV flags)','name' => 'perl_clone'},'sv_setnv' => {'text' => 'Copies a double into the given SV, upgrading first if necessary.
285             Does not handle \'set\' magic. See also C.
286              
287             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
288             conversion, magic etc. Normally used via the C and C
289             macros.
290              
291             NV sv_2nv(SV* sv)','name' => 'sv_2nv'},'SvREFCNT_inc_simple_NN' => {'text' => 'Same as SvREFCNT_inc_simple, but can only be used if you know I
292             is not NULL. Since we don\'t have to check the NULLness, it\'s faster
293             and smaller.
294              
295             SV* SvREFCNT_inc_simple_NN(SV* sv)','name' => 'SvREFCNT_inc_simple_NN'},'SvSetSV' => {'text' => 'Calls C if dsv is not the same as ssv. May evaluate arguments
296             more than once.
297              
298             void SvSetSV(SV* dsb, SV* ssv)','name' => 'SvSetSV'},'hv_fetchs' => {'text' => 'Like C, but takes a literal string instead of a string/length pair.
299              
300             SV** hv_fetchs(HV* tb, const char* key, I32 lval)','name' => 'hv_fetchs'},'newHV' => {'text' => 'Creates a new HV. The reference count is set to 1.
301              
302             HV* newHV()','name' => 'newHV'},'strnNE' => {'text' => 'Test two strings to see if they are different. The C parameter
303             indicates the number of bytes to compare. Returns true or false. (A
304             wrapper for C).
305              
306             bool strnNE(char* s1, char* s2, STRLEN len)','name' => 'strnNE'},'strNE' => {'text' => 'Test two strings to see if they are different. Returns true or
307             false.
308              
309             bool strNE(char* s1, char* s2)','name' => 'strNE'},'sv_pvutf8n_force' => {'text' => 'The backend for the C macro. Always use the macro instead.
310              
311             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
312             string which is a duplicate of C. The size of the string is
313             determined by C. The memory allocated for the new string can
314             be freed with the C function.
315              
316             char* savepv(const char* pv)','name' => 'savepv'},'SvNV_set' => {'text' => 'Set the value of the NV pointer in sv to val. See C.
317              
318             void SvNV_set(SV* sv, NV val)','name' => 'SvNV_set'},'bytes_from_utf8' => {'text' => 'Converts a string C of length C from UTF-8 into native byte encoding.
319             Unlike C but like C, returns a pointer to
320             the newly-created string, and updates C to contain the new
321             length. Returns the original string if no conversion occurs, C
322             is unchanged. Do nothing if C points to 0. Sets C to
323             0 if C is converted or consisted entirely of characters that are invariant
324             in utf8 (i.e., US-ASCII on non-EBCDIC machines).
325              
326             NOTE: this function is experimental and may change or be
327             removed without notice.
328              
329             U8* bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)','name' => 'bytes_from_utf8'},'newAV' => {'text' => 'Creates a new AV. The reference count is set to 1.
330              
331             AV* newAV()','name' => 'newAV'},'HvNAME' => {'text' => 'Returns the package name of a stash, or NULL if C isn\'t a stash.
332             See C, C.
333              
334             char* HvNAME(HV* stash)','name' => 'HvNAME'},'sv_recode_to_utf8' => {'text' => 'The encoding is assumed to be an Encode object, on entry the PV
335             of the sv is assumed to be octets in that encoding, and the sv
336             will be converted into Unicode (and UTF-8).
337              
338             If the sv already is UTF-8 (or if it is not POK), or if the encoding
339             is not a reference, nothing is done to the sv. If the encoding is not
340             an C Encoding object, bad things will happen.
341             (See F and L).
342              
343             The PV of the sv is returned.
344              
345             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
346             into the array, so they may be freed after the call to av_make. The new AV
347             will have a reference count of 1.
348              
349             AV* av_make(I32 size, SV **strp)','name' => 'av_make'},'SvUV' => {'text' => 'Coerces the given SV to an unsigned integer and returns it. See C
350             for a version which guarantees to evaluate sv only once.
351              
352             UV SvUV(SV* sv)','name' => 'SvUV'},'PERL_SYS_INIT' => {'text' => 'Provides system-specific tune up of the C runtime environment necessary to
353             run Perl interpreters. This should be called only once, before creating
354             any Perl interpreters.
355              
356             void PERL_SYS_INIT(int argc, char** argv)','name' => 'PERL_SYS_INIT'},'perl_run' => {'text' => 'Tells a Perl interpreter to run. See L.
357              
358             int perl_run(PerlInterpreter *my_perl)','name' => 'perl_run'},'vstringify' => {'text' => 'In order to maintain maximum compatibility with earlier versions
359             of Perl, this function will return either the floating point
360             notation or the multiple dotted notation, depending on whether
361             the original version contained 1 or more dots, respectively
362              
363             SV* vstringify(SV *vs)','name' => 'vstringify'},'sv_catsv_flags' => {'text' => 'Concatenates the string from SV C onto the end of the string in
364             SV C. Modifies C but not C. If C has C
365             bit set, will C on the SVs if appropriate, else not. C
366             and C are implemented in terms of this function.
367              
368             void sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)','name' => 'sv_catsv_flags'},'sv_insert_flags' => {'text' => 'Same as C, but the extra C are passed the C that applies to C.
369              
370             void sv_insert_flags(SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen, const U32 flags)','name' => 'sv_insert_flags'},'SvPVutf8_nolen' => {'text' => 'Like C, but converts sv to utf8 first if necessary.
371              
372             char* SvPVutf8_nolen(SV* sv)','name' => 'SvPVutf8_nolen'},'SvRXOK' => {'text' => 'Returns a boolean indicating whether the SV contains qr magic
373             (PERL_MAGIC_qr).
374              
375             If you want to do something with the REGEXP* later use SvRX instead
376             and check for NULL.
377              
378             bool SvRXOK(SV* sv)','name' => 'SvRXOK'},'sv_setpviv' => {'text' => 'Copies an integer into the given SV, also updating its string value.
379             Does not handle \'set\' magic. See C.
380              
381             void sv_setpviv(SV* sv, IV num)','name' => 'sv_setpviv'},'sv_true' => {'text' => 'Returns true if the SV has a true value by Perl\'s rules.
382             Use the C macro instead, which may call C or may
383             instead use an in-line version.
384              
385             I32 sv_true(SV *sv)','name' => 'sv_true'},'sv_derived_from' => {'text' => 'Returns a boolean indicating whether the SV is derived from the specified class
386             I. To check derivation at the Perl level, call C as a
387             normal Perl method.
388              
389             bool sv_derived_from(SV* sv, const char* name)','name' => 'sv_derived_from'},'SvIOK_on' => {'text' => 'Tells an SV that it is an integer.
390              
391             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
392             \'use bytes\' aware, handles get magic, and will coerce its args to strings
393             if necessary. See also C.
394              
395             I32 sv_cmp_locale(SV* sv1, SV* sv2)','name' => 'sv_cmp_locale'},'sv_catpvs' => {'text' => 'Like C, but takes a literal string instead of a string/length pair.
396              
397             void sv_catpvs(SV* sv, const char* s)','name' => 'sv_catpvs'},'hv_exists' => {'text' => 'Returns a boolean indicating whether the specified hash key exists. The
398             C is the length of the key.
399              
400             bool hv_exists(HV *hv, const char *key, I32 klen)','name' => 'hv_exists'},'dSP' => {'text' => 'Declares a local copy of perl\'s stack pointer for the XSUB, available via
401             the C macro. See C.
402              
403             dSP;','name' => 'dSP'},'Nullsv' => {'text' => 'Null SV pointer.','name' => 'Nullsv'},'mg_length' => {'text' => 'Report on the SV\'s length. See C.
404              
405             U32 mg_length(SV* sv)','name' => 'mg_length'},'SvPVX' => {'text' => 'Returns a pointer to the physical string in the SV. The SV must contain a
406             string.
407              
408             char* SvPVX(SV* sv)','name' => 'SvPVX'},'XPUSHi' => {'text' => 'Push an integer onto the stack, extending the stack if necessary. Handles
409             \'set\' magic. Uses C, so C or C should be called to
410             declare it. Do not call multiple C-oriented macros to return lists
411             from XSUB\'s - see C instead. See also C and C.
412              
413             void XPUSHi(IV iv)','name' => 'XPUSHi'},'HEf_SVKEY' => {'text' => 'This flag, used in the length slot of hash entries and magic structures,
414             specifies the structure contains an C pointer where a C pointer
415             is to be expected. (For information only--not to be used).','name' => 'HEf_SVKEY'},'utf8_length' => {'text' => 'Return the length of the UTF-8 char encoded string C in characters.
416             Stops at C (inclusive). If C s> or if the scan would end
417             up past C, croaks.
418              
419             STRLEN utf8_length(const U8* s, const U8 *e)','name' => 'utf8_length'},'SvTAINTED_on' => {'text' => 'Marks an SV as tainted if tainting is enabled.
420              
421             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.
422              
423             void SvIOK_only_UV(SV* sv)','name' => 'SvIOK_only_UV'},'sv_nolocking' => {'text' => 'Dummy routine which "locks" an SV when there is no locking module present.
424             Exists to avoid test for a NULL function pointer and because it could
425             potentially warn under some level of strict-ness.
426              
427             "Superseded" by sv_nosharing().
428              
429             void sv_nolocking(SV *sv)','name' => 'sv_nolocking'},'sv_vcatpvfn' => {'text' => 'Processes its arguments like C and appends the formatted output
430             to an SV. Uses an array of SVs if the C style variable argument list is
431             missing (NULL). When running with taint checks enabled, indicates via
432             C if results are untrustworthy (often due to the use of
433             locales).
434              
435             Usually used via one of its frontends C and C.
436              
437             void sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)','name' => 'sv_vcatpvfn'},'strLT' => {'text' => 'Test two strings to see if the first, C, is less than the second,
438             C. Returns true or false.
439              
440             bool strLT(char* s1, char* s2)','name' => 'strLT'},'av_shift' => {'text' => 'Shifts an SV off the beginning of the array. Returns C<&PL_sv_undef> if the
441             array is empty.
442              
443             SV* av_shift(AV *av)','name' => 'av_shift'},'sv_pvutf8n' => {'text' => 'A private implementation of the C macro for compilers
444             which can\'t cope with complex macro expressions. Always use the macro
445             instead.
446              
447             char* sv_pvutf8n(SV *sv, STRLEN *lp)','name' => 'sv_pvutf8n'},'newSV' => {'text' => 'Creates a new SV. A non-zero C parameter indicates the number of
448             bytes of preallocated string space the SV should have. An extra byte for a
449             trailing NUL is also reserved. (SvPOK is not set for the SV even if string
450             space is allocated.) The reference count for the new SV is set to 1.
451              
452             In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
453             parameter, I, a debug aid which allowed callers to identify themselves.
454             This aid has been superseded by a new build option, PERL_MEM_LOG (see
455             L). The older API is still there for use in XS
456             modules supporting older perls.
457              
458             SV* newSV(STRLEN len)','name' => 'newSV'},'sv_2pvutf8' => {'text' => 'Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
459             to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.
460              
461             Usually accessed via the C macro.
462              
463             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.
464             Exists to avoid test for a NULL function pointer and because it could
465             potentially warn under some level of strict-ness.
466              
467             "Superseded" by sv_nosharing().
468              
469             void sv_nounlocking(SV *sv)','name' => 'sv_nounlocking'},'dITEMS' => {'text' => 'Sets up the C variable.
470             This is usually handled automatically by C by calling C.
471              
472             dITEMS;','name' => 'dITEMS'},'SvUV_set' => {'text' => 'Set the value of the UV pointer in sv to val. See C.
473              
474             void SvUV_set(SV* sv, UV val)','name' => 'SvUV_set'},'CopyD' => {'text' => 'Like C but returns dest. Useful for encouraging compilers to tail-call
475             optimise.
476              
477             void * CopyD(void* src, void* dest, int nitems, type)','name' => 'CopyD'},'sv_setiv_mg' => {'text' => 'Like C, but also handles \'set\' magic.
478              
479             void sv_setiv_mg(SV *sv, IV i)','name' => 'sv_setiv_mg'},'PUTBACK' => {'text' => 'Closing bracket for XSUB arguments. This is usually handled by C.
480             See C and L for other uses.
481              
482             PUTBACK;','name' => 'PUTBACK'},'savesharedpvn' => {'text' => 'A version of C which allocates the duplicate string in memory
483             which is shared between threads. (With the specific difference that a NULL
484             pointer is not acceptable)
485              
486             char* savesharedpvn(const char *const pv, const STRLEN len)','name' => 'savesharedpvn'},'dAXMARK' => {'text' => 'Sets up the C variable and stack marker variable C.
487             This is usually handled automatically by C by calling C.
488              
489             dAXMARK;','name' => 'dAXMARK'},'SvCUR_set' => {'text' => 'Set the current length of the string which is in the SV. See C
490             and C.
491              
492             void SvCUR_set(SV* sv, STRLEN len)','name' => 'SvCUR_set'},'sv_2uv_flags' => {'text' => 'Return the unsigned integer value of an SV, doing any necessary string
493             conversion. If flags includes SV_GMAGIC, does an mg_get() first.
494             Normally used via the C and C macros.
495              
496             UV sv_2uv_flags(SV* sv, I32 flags)','name' => 'sv_2uv_flags'},'SvNOK' => {'text' => 'Returns a U32 value indicating whether the SV contains a double.
497              
498             U32 SvNOK(SV* sv)','name' => 'SvNOK'},'mPUSHn' => {'text' => 'Push a double onto the stack. The stack must have room for this element.
499             Does not use C. See also C, C and C.
500              
501             void mPUSHn(NV nv)','name' => 'mPUSHn'},'G_SCALAR' => {'text' => 'Used to indicate scalar context. See C, C, and
502             L.','name' => 'G_SCALAR'},'sv_reset' => {'text' => 'Underlying implementation for the C Perl function.
503             Note that the perl-level function is vaguely deprecated.
504              
505             void sv_reset(const char* s, HV* stash)','name' => 'sv_reset'},'sv_2pv_flags' => {'text' => 'Returns a pointer to the string value of an SV, and sets *lp to its length.
506             If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
507             if necessary.
508             Normally invoked via the C macro. C and C
509             usually end up here too.
510              
511             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
512             some of Perl\'s fundamental security features. XS module authors should not
513             use this function unless they fully understand all the implications of
514             unconditionally untainting the value. Untainting should be done in the
515             standard perl fashion, via a carefully crafted regexp, rather than directly
516             untainting variables.
517              
518             void SvTAINTED_off(SV* sv)','name' => 'SvTAINTED_off'},'SvNVx' => {'text' => 'Coerces the given SV to a double and returns it. Guarantees to evaluate
519             C only once. Only use this if C is an expression with side effects,
520             otherwise use the more efficient C.
521              
522             NV SvNVx(SV* sv)','name' => 'SvNVx'},'require_pv' => {'text' => 'Tells Perl to C the file named by the string argument. It is
523             analogous to the Perl code C. It\'s even
524             implemented that way; consider using load_module instead.
525              
526             NOTE: the perl_ form of this function is deprecated.
527              
528             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
529             SV, then copies across as much information as possible from the old body.
530             You generally want to use the C macro wrapper. See also C.
531              
532             void sv_upgrade(SV* sv, svtype new_type)','name' => 'sv_upgrade'},'strEQ' => {'text' => 'Test two strings to see if they are equal. Returns true or false.
533              
534             bool strEQ(char* s1, char* s2)','name' => 'strEQ'},'hv_store' => {'text' => 'Stores an SV in a hash. The hash key is specified as C and C is
535             the length of the key. The C parameter is the precomputed hash
536             value; if it is zero then Perl will compute it. The return value will be
537             NULL if the operation failed or if the value did not need to be actually
538             stored within the hash (as in the case of tied hashes). Otherwise it can
539             be dereferenced to get the original C. Note that the caller is
540             responsible for suitably incrementing the reference count of C before
541             the call, and decrementing it if the function returned NULL. Effectively
542             a successful hv_store takes ownership of one reference to C. This is
543             usually what you want; a newly created SV has a reference count of one, so
544             if all your code does is create SVs then store them in a hash, hv_store
545             will own the only reference to the new SV, and your code doesn\'t need to do
546             anything further to tidy up. hv_store is not implemented as a call to
547             hv_store_ent, and does not create a temporary SV for the key, so if your
548             key data is not already in SV form then use hv_store in preference to
549             hv_store_ent.
550              
551             See L for more
552             information on how to use this function on tied hashes.
553              
554             SV** hv_store(HV *hv, const char *key, I32 klen, SV *val, U32 hash)','name' => 'hv_store'},'isUPPER' => {'text' => 'Returns a boolean indicating whether the C C is a US-ASCII (Basic Latin)
555             uppercase character.
556              
557             bool isUPPER(char ch)','name' => 'isUPPER'},'sv_setsv_mg' => {'text' => 'Like C, but also handles \'set\' magic.
558              
559             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.
560             C must be a valid precomputed hash number for the given C, or 0
561             if you want the function to compute it. IF C is set then the fetch
562             will be part of a store. Make sure the return value is non-null before
563             accessing it. The return value when C is a tied hash is a pointer to a
564             static location, so be sure to make a copy of the structure if you need to
565             store it somewhere.
566              
567             See L for more
568             information on how to use this function on tied hashes.
569              
570             HE* hv_fetch_ent(HV *hv, SV *keysv, I32 lval, U32 hash)','name' => 'hv_fetch_ent'},'isLOWER' => {'text' => 'Returns a boolean indicating whether the C C is a US-ASCII (Basic Latin)
571             lowercase character.
572              
573             bool isLOWER(char ch)','name' => 'isLOWER'},'ENTER' => {'text' => 'Opening bracket on a callback. See C and L.
574              
575             ENTER;','name' => 'ENTER'},'PL_sv_no' => {'text' => 'This is the C SV. See C. Always refer to this as
576             C<&PL_sv_no>.
577              
578             SV PL_sv_no','name' => 'PL_sv_no'},'hv_iterkey' => {'text' => 'Returns the key from the current position of the hash iterator. See
579             C.
580              
581             char* hv_iterkey(HE* entry, I32* retlen)','name' => 'hv_iterkey'},'SvNOKp' => {'text' => 'Returns a U32 value indicating whether the SV contains a double. Checks the
582             B setting. Use C instead.
583              
584             U32 SvNOKp(SV* sv)','name' => 'SvNOKp'},'Newx' => {'text' => 'The XSUB-writer\'s interface to the C C function.
585              
586             In 5.9.3, Newx() and friends replace the older New() API, and drops
587             the first parameter, I, a debug aid which allowed callers to identify
588             themselves. This aid has been superseded by a new build option,
589             PERL_MEM_LOG (see L). The older API is still
590             there for use in XS modules supporting older perls.
591              
592             void Newx(void* ptr, int nitems, type)','name' => 'Newx'},'PUSHs' => {'text' => 'Push an SV onto the stack. The stack must have room for this element.
593             Does not handle \'set\' magic. Does not use C. See also C,
594             C and C.
595              
596             void PUSHs(SV* sv)','name' => 'PUSHs'},'sv_setuv' => {'text' => 'Copies an unsigned integer into the given SV, upgrading first if necessary.
597             Does not handle \'set\' magic. See also C.
598              
599             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
600             perform the upgrade if necessary. See C.
601              
602             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
603             which is assumed to be in UTF-8 encoding; C will be set to the
604             length, in bytes, of that character.
605              
606             If C does not point to a well-formed UTF-8 character, zero is
607             returned and retlen is set, if possible, to -1.
608              
609             UV utf8_to_uvchr(const U8 *s, STRLEN *retlen)','name' => 'utf8_to_uvchr'},'nothreadhook' => {'text' => 'Stub that provides thread hook for perl_destruct when there are
610             no threads.
611              
612             int nothreadhook()','name' => 'nothreadhook'},'bytes_to_utf8' => {'text' => 'Converts a string C of length C from the native encoding into UTF-8.
613             Returns a pointer to the newly-created string, and sets C to
614             reflect the new length.
615              
616             A NUL character will be written after the end of the string.
617              
618             If you want to convert to UTF-8 from encodings other than
619             the native (Latin1 or EBCDIC),
620             see sv_recode_to_utf8().
621              
622             NOTE: this function is experimental and may change or be
623             removed without notice.
624              
625             U8* bytes_to_utf8(const U8 *s, STRLEN *len)','name' => 'bytes_to_utf8'},'SvIsCOW_shared_hash' => {'text' => 'Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
626             scalar.
627              
628             bool SvIsCOW_shared_hash(SV* sv)','name' => 'SvIsCOW_shared_hash'},'sv_pvn' => {'text' => 'A private implementation of the C macro for compilers which can\'t
629             cope with complex macro expressions. Always use the macro instead.
630              
631             char* sv_pvn(SV *sv, STRLEN *lp)','name' => 'sv_pvn'},'sv_setref_iv' => {'text' => 'Copies an integer into a new SV, optionally blessing the SV. The C
632             argument will be upgraded to an RV. That RV will be modified to point to
633             the new SV. The C argument indicates the package for the
634             blessing. Set C to C to avoid the blessing. The new SV
635             will have a reference count of 1, and the RV will be returned.
636              
637             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.
638             SvPOK(sv) must be true and the C must be a pointer to somewhere inside
639             the string buffer. The C becomes the first character of the adjusted
640             string. Uses the "OOK hack".
641             Beware: after this function returns, C and SvPVX_const(sv) may no longer
642             refer to the same chunk of data.
643              
644             void sv_chop(SV* sv, const char* ptr)','name' => 'sv_chop'},'sv_backoff' => {'text' => 'Remove any string offset. You should normally use the C macro
645             wrapper instead.
646              
647             int sv_backoff(SV* sv)','name' => 'sv_backoff'},'sv_catsv_nomg' => {'text' => 'Like C but doesn\'t process magic.
648              
649             void sv_catsv_nomg(SV* dsv, SV* ssv)','name' => 'sv_catsv_nomg'},'XPUSHu' => {'text' => 'Push an unsigned integer onto the stack, extending the stack if necessary.
650             Handles \'set\' magic. Uses C, so C or C should be
651             called to declare it. Do not call multiple C-oriented macros to
652             return lists from XSUB\'s - see C instead. See also C and
653             C.
654              
655             void XPUSHu(UV uv)','name' => 'XPUSHu'},'sv_setuv_mg' => {'text' => 'Like C, but also handles \'set\' magic.
656              
657             void sv_setuv_mg(SV *sv, UV u)','name' => 'sv_setuv_mg'},'XS_VERSION' => {'text' => 'The version identifier for an XS module. This is usually
658             handled automatically by C. See C.','name' => 'XS_VERSION'},'PL_na' => {'text' => 'A convenience variable which is typically used with C when one
659             doesn\'t care about the length of the string. It is usually more efficient
660             to either declare a local variable and use that instead or to use the
661             C macro.
662              
663             STRLEN PL_na','name' => 'PL_na'},'newSViv' => {'text' => 'Creates a new SV and copies an integer into it. The reference count for the
664             SV is set to 1.
665              
666             SV* newSViv(IV i)','name' => 'newSViv'},'sv_untaint' => {'text' => 'Untaint an SV. Use C instead.
667             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
668             handle \'set\' magic. See C.
669              
670             void sv_setpv(SV* sv, const char* ptr)','name' => 'sv_setpv'},'Newxz' => {'text' => 'The XSUB-writer\'s interface to the C C function. The allocated
671             memory is zeroed with C. See also C.
672              
673             void Newxz(void* ptr, int nitems, type)','name' => 'Newxz'},'SVt_PVHV' => {'text' => 'Type flag for hashes. See C.','name' => 'SVt_PVHV'},'SvGROW' => {'text' => 'Expands the character buffer in the SV so that it has room for the
674             indicated number of bytes (remember to reserve space for an extra trailing
675             NUL character). Calls C to perform the expansion if necessary.
676             Returns a pointer to the character buffer.
677              
678             char * SvGROW(SV* sv, STRLEN len)','name' => 'SvGROW'},'gv_fetchmethod' => {'text' => 'See L.
679              
680             GV* gv_fetchmethod(HV* stash, const char* name)','name' => 'gv_fetchmethod'},'dMULTICALL' => {'text' => 'Declare local variables for a multicall. See L.
681              
682             dMULTICALL;','name' => 'dMULTICALL'},'sv_catpv' => {'text' => 'Concatenates the string onto the end of the string which is in the SV.
683             If the SV has the UTF-8 status set, then the bytes appended should be
684             valid UTF-8. Handles \'get\' magic, but not \'set\' magic. See C.
685              
686             void sv_catpv(SV* sv, const char* ptr)','name' => 'sv_catpv'},'sv_len' => {'text' => 'Returns the length of the string in the SV. Handles magic and type
687             coercion. See also C, which gives raw access to the xpv_cur slot.
688              
689             STRLEN sv_len(SV* sv)','name' => 'sv_len'},'SvPVbyte_nolen' => {'text' => 'Like C, but converts sv to byte representation first if necessary.
690              
691             char* SvPVbyte_nolen(SV* sv)','name' => 'SvPVbyte_nolen'},'sv_pvutf8' => {'text' => 'Use the C macro instead
692              
693             char* sv_pvutf8(SV *sv)','name' => 'sv_pvutf8'},'SvRX' => {'text' => 'Convenience macro to get the REGEXP from a SV. This is approximately
694             equivalent to the following snippet:
695              
696             if (SvMAGICAL(sv))
697             mg_get(sv);
698             if (SvROK(sv) &&
699             (tmpsv = (SV*)SvRV(sv)) &&
700             SvTYPE(tmpsv) == SVt_PVMG &&
701             (tmpmg = mg_find(tmpsv, PERL_MAGIC_qr)))
702             {
703             return (REGEXP *)tmpmg->mg_obj;
704             }
705              
706             NULL will be returned if a REGEXP* is not found.
707              
708             REGEXP * SvRX(SV *sv)','name' => 'SvRX'},'SVt_PVAV' => {'text' => 'Type flag for arrays. See C.','name' => 'SVt_PVAV'},'LEAVE' => {'text' => 'Closing bracket on a callback. See C and L.
709              
710             LEAVE;','name' => 'LEAVE'},'hv_undef' => {'text' => 'Undefines the hash.
711              
712             void hv_undef(HV *hv)','name' => 'hv_undef'},'SvSetMagicSV_nosteal' => {'text' => 'Like C, but does any set magic required afterwards.
713              
714             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
715             hash and returned to the caller. The C value will normally be zero;
716             if set to G_DISCARD then NULL will be returned. C can be a valid
717             precomputed hash value, or 0 to ask for it to be computed.
718              
719             SV* hv_delete_ent(HV *hv, SV *keysv, I32 flags, U32 hash)','name' => 'hv_delete_ent'},'CLASS' => {'text' => 'Variable which is setup by C to indicate the
720             class name for a C++ XS constructor. This is always a C. See C.
721              
722             char* CLASS','name' => 'CLASS'},'savesvpv' => {'text' => 'A version of C/C which gets the string to duplicate from
723             the passed in SV using C
724              
725             char* savesvpv(SV* sv)','name' => 'savesvpv'},'sv_isobject' => {'text' => 'Returns a boolean indicating whether the SV is an RV pointing to a blessed
726             object. If the SV is not an RV, or if the object is not blessed, then this
727             will return false.
728              
729             int sv_isobject(SV* sv)','name' => 'sv_isobject'},'sv_pvn_force_flags' => {'text' => 'Get a sensible string out of the SV somehow.
730             If C has C bit set, will C on C if
731             appropriate, else not. C and C are
732             implemented in terms of this function.
733             You normally want to use the various wrapper macros instead: see
734             C and C
735              
736             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
737             holds an C key. Otherwise, holds the actual length of the key. Can
738             be assigned to. The C macro is usually preferable for finding key
739             lengths.
740              
741             STRLEN HeKLEN(HE* he)','name' => 'HeKLEN'},'to_utf8_title' => {'text' => 'Convert the UTF-8 encoded character at p to its titlecase version and
742             store that in UTF-8 in ustrp and its length in bytes in lenp. Note
743             that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
744             titlecase version may be longer than the original character.
745              
746             The first character of the titlecased version is returned
747             (but note, as explained above, that there may be more.)
748              
749             UV to_utf8_title(const U8 *p, U8* ustrp, STRLEN *lenp)','name' => 'to_utf8_title'},'PUSHn' => {'text' => 'Push a double onto the stack. The stack must have room for this element.
750             Handles \'set\' magic. Uses C, so C or C should be
751             called to declare it. Do not call multiple C-oriented macros to
752             return lists from XSUB\'s - see C instead. See also C and
753             C.
754              
755             void PUSHn(NV nv)','name' => 'PUSHn'},'mPUSHi' => {'text' => 'Push an integer onto the stack. The stack must have room for this element.
756             Does not use C. See also C, C and C.
757              
758             void mPUSHi(IV iv)','name' => 'mPUSHi'},'SvIV' => {'text' => 'Coerces the given SV to an integer and returns it. See C for a
759             version which guarantees to evaluate sv only once.
760              
761             IV SvIV(SV* sv)','name' => 'SvIV'},'PL_sv_yes' => {'text' => 'This is the C SV. See C. Always refer to this as
762             C<&PL_sv_yes>.
763              
764             SV PL_sv_yes','name' => 'PL_sv_yes'},'sv_nosharing' => {'text' => 'Dummy routine which "shares" an SV when there is no sharing module present.
765             Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
766             Exists to avoid test for a NULL function pointer and because it could
767             potentially warn under some level of strict-ness.
768              
769             void sv_nosharing(SV *sv)','name' => 'sv_nosharing'},'SvUTF8_off' => {'text' => 'Unsets the UTF-8 status of an SV.
770              
771             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).
772             C and C are treated as numbers (so will not issue a
773             non-numeric warning), even if your atof() doesn\'t grok them.
774              
775             I32 looks_like_number(SV* sv)','name' => 'looks_like_number'},'sv_catpv_mg' => {'text' => 'Like C, but also handles \'set\' magic.
776              
777             void sv_catpv_mg(SV *sv, const char *ptr)','name' => 'sv_catpv_mg'},'XSRETURN_EMPTY' => {'text' => 'Return an empty list from an XSUB immediately.
778              
779             XSRETURN_EMPTY;','name' => 'XSRETURN_EMPTY'},'sv_setref_uv' => {'text' => 'Copies an unsigned integer into a new SV, optionally blessing the SV. The C
780             argument will be upgraded to an RV. That RV will be modified to point to
781             the new SV. The C argument indicates the package for the
782             blessing. Set C to C to avoid the blessing. The new SV
783             will have a reference count of 1, and the RV will be returned.
784              
785             SV* sv_setref_uv(SV* rv, const char* classname, UV uv)','name' => 'sv_setref_uv'},'getcwd_sv' => {'text' => 'Fill the sv with current working directory
786              
787             int getcwd_sv(SV* sv)','name' => 'getcwd_sv'},'newSVpvs_share' => {'text' => 'Like C, but takes a literal string instead of a string/length
788             pair and omits the hash parameter.
789              
790             SV* newSVpvs_share(const char* s)','name' => 'newSVpvs_share'},'newSVpv' => {'text' => 'Creates a new SV and copies a string into it. The reference count for the
791             SV is set to 1. If C is zero, Perl will compute the length using
792             strlen(). For efficiency, consider using C instead.
793              
794             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
795             to its length. May cause the SV to be downgraded from UTF-8 as a
796             side-effect.
797              
798             Usually accessed via the C macro.
799              
800             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
801             C. It returns C if the string can\'t be found. The C
802             does not have to be fbm_compiled, but the search will not be as fast
803             then.
804              
805             char* fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlestr, U32 flags)','name' => 'fbm_instr'},'sv_setpvf' => {'text' => 'Works like C but copies the text into the SV instead of
806             appending it. Does not handle \'set\' magic. See C.
807              
808             void sv_setpvf(SV* sv, const char* pat, ...)','name' => 'sv_setpvf'},'XPUSHn' => {'text' => 'Push a double onto the stack, extending the stack if necessary. Handles
809             \'set\' magic. Uses C, so C or C should be called to
810             declare it. Do not call multiple C-oriented macros to return lists
811             from XSUB\'s - see C instead. See also C and C.
812              
813             void XPUSHn(NV nv)','name' => 'XPUSHn'},'SVt_PV' => {'text' => 'Pointer type flag for scalars. See C.','name' => 'SVt_PV'},'call_sv' => {'text' => 'Performs a callback to the Perl sub whose name is in the SV. See
814             L.
815              
816             NOTE: the perl_ form of this function is deprecated.
817              
818             I32 call_sv(SV* sv, VOL I32 flags)','name' => 'call_sv'},'strGT' => {'text' => 'Test two strings to see if the first, C, is greater than the second,
819             C. Returns true or false.
820              
821             bool strGT(char* s1, char* s2)','name' => 'strGT'},'mXPUSHs' => {'text' => 'Push an SV onto the stack, extending the stack if necessary and mortalizes
822             the SV. Does not use C. See also C and C.
823              
824             void mXPUSHs(SV* sv)','name' => 'mXPUSHs'},'sv_vcatpvf' => {'text' => 'Processes its arguments like C and appends the formatted output
825             to an SV. Does not handle \'set\' magic. See C.
826              
827             Usually used via its frontend C.
828              
829             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
830             the start of the string, to a count of the equivalent number of bytes; if
831             lenp is non-zero, it does the same to lenp, but this time starting from
832             the offset, rather than from the start of the string. Handles magic and
833             type coercion.
834              
835             void sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)','name' => 'sv_pos_u2b'},'PERL_SYS_INIT3' => {'text' => 'Provides system-specific tune up of the C runtime environment necessary to
836             run Perl interpreters. This should be called only once, before creating
837             any Perl interpreters.
838              
839             void PERL_SYS_INIT3(int argc, char** argv, char** env)','name' => 'PERL_SYS_INIT3'},'upg_version' => {'text' => 'In-place upgrade of the supplied SV to a version object.
840              
841             SV *sv = upg_version(SV *sv, bool qv);
842              
843             Returns a pointer to the upgraded SV. Set the boolean qv if you want
844             to force this SV to be interpreted as an "extended" version.
845              
846             SV* upg_version(SV *ver, bool qv)','name' => 'upg_version'},'HeSVKEY_set' => {'text' => 'Sets the key to a given C, taking care to set the appropriate flags to
847             indicate the presence of an C key, and returns the same
848             C.
849              
850             SV* HeSVKEY_set(HE* he, SV* sv)','name' => 'HeSVKEY_set'},'POPl' => {'text' => 'Pops a long off the stack.
851              
852             long POPl','name' => 'POPl'},'SPAGAIN' => {'text' => 'Refetch the stack pointer. Used after a callback. See L.
853              
854             SPAGAIN;','name' => 'SPAGAIN'},'scan_version' => {'text' => 'Returns a pointer to the next character after the parsed
855             version string, as well as upgrading the passed in SV to
856             an RV.
857              
858             Function must be called with an already existing SV like
859              
860             sv = newSV(0);
861             s = scan_version(s, SV *sv, bool qv);
862              
863             Performs some preprocessing to the string to ensure that
864             it has the correct characteristics of a version. Flags the
865             object if it contains an underscore (which denotes this
866             is an alpha version). The boolean qv denotes that the version
867             should be interpreted as if it had multiple decimals, even if
868             it doesn\'t.
869              
870             const char* scan_version(const char *s, SV *rv, bool qv)','name' => 'scan_version'},'SvIOKp' => {'text' => 'Returns a U32 value indicating whether the SV contains an integer. Checks
871             the B setting. Use C instead.
872              
873             U32 SvIOKp(SV* sv)','name' => 'SvIOKp'},'get_cv' => {'text' => 'Uses C to get the length of C, then calls C.
874              
875             NOTE: the perl_ form of this function is deprecated.
876              
877             CV* get_cv(const char* name, I32 flags)','name' => 'get_cv'},'vnumify' => {'text' => 'Accepts a version object and returns the normalized floating
878             point representation. Call like:
879              
880             sv = vnumify(rv);
881              
882             NOTE: you can pass either the object directly or the SV
883             contained within the RV.
884              
885             SV* vnumify(SV *vs)','name' => 'vnumify'},'XST_mUNDEF' => {'text' => 'Place C<&PL_sv_undef> into the specified position C on the
886             stack.
887              
888             void XST_mUNDEF(int pos)','name' => 'XST_mUNDEF'},'SvUNLOCK' => {'text' => 'Releases a mutual exclusion lock on sv if a suitable module
889             has been loaded.
890              
891             void SvUNLOCK(SV* sv)','name' => 'SvUNLOCK'},'mg_set' => {'text' => 'Do magic after a value is assigned to the SV. See C.
892              
893             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).
894             The new SV is marked as mortal. It will be destroyed "soon", either by an
895             explicit call to FREETMPS, or by an implicit call at places such as
896             statement boundaries. See also C and C.
897              
898             SV* sv_mortalcopy(SV* oldsv)','name' => 'sv_mortalcopy'},'sv_catpvn_nomg' => {'text' => 'Like C but doesn\'t process magic.
899              
900             void sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)','name' => 'sv_catpvn_nomg'},'newSVpvs_flags' => {'text' => 'Like C, but takes a literal string instead of a string/length
901             pair.
902              
903             SV* newSVpvs_flags(const char* s, U32 flags)','name' => 'newSVpvs_flags'},'G_NOARGS' => {'text' => 'Indicates that no arguments are being sent to a callback. See
904             L.','name' => 'G_NOARGS'},'savepvn' => {'text' => 'Perl\'s version of what C would be if it existed. Returns a
905             pointer to a newly allocated string which is a duplicate of the first
906             C bytes from C, plus a trailing NUL byte. The memory allocated for
907             the new string can be freed with the C function.
908              
909             char* savepvn(const char* pv, I32 len)','name' => 'savepvn'},'av_exists' => {'text' => 'Returns true if the element indexed by C has been initialized.
910              
911             This relies on the fact that uninitialized array elements are set to
912             C<&PL_sv_undef>.
913              
914             bool av_exists(AV *av, I32 key)','name' => 'av_exists'},'SvCUR' => {'text' => 'Returns the length of the string which is in the SV. See C.
915              
916             STRLEN SvCUR(SV* sv)','name' => 'SvCUR'},'sv_bless' => {'text' => 'Blesses an SV into a specified package. The SV must be an RV. The package
917             must be designated by its stash (see C). The reference count
918             of the SV is unaffected.
919              
920             SV* sv_bless(SV* sv, HV* stash)','name' => 'sv_bless'},'sv_isa' => {'text' => 'Returns a boolean indicating whether the SV is blessed into the specified
921             class. This does not check for subtypes; use C to verify
922             an inheritance relationship.
923              
924             int sv_isa(SV* sv, const char* name)','name' => 'sv_isa'},'sv_catpvf' => {'text' => 'Processes its arguments like C and appends the formatted
925             output to an SV. If the appended data contains "wide" characters
926             (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
927             and characters >255 formatted with %c), the original SV might get
928             upgraded to UTF-8. Handles \'get\' magic, but not \'set\' magic. See
929             C. If the original SV was UTF-8, the pattern should be
930             valid UTF-8; if the original SV was bytes, the pattern should be too.
931              
932             void sv_catpvf(SV* sv, const char* pat, ...)','name' => 'sv_catpvf'},'XSRETURN_PV' => {'text' => 'Return a copy of a string from an XSUB immediately. Uses C.
933              
934             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
935             which is assumed to be in UTF-8 encoding; C will be set to the
936             length, in bytes, of that character.
937              
938             This function should only be used when the returned UV is considered
939             an index into the Unicode semantic tables (e.g. swashes).
940              
941             If C does not point to a well-formed UTF-8 character, zero is
942             returned and retlen is set, if possible, to -1.
943              
944             UV utf8_to_uvuni(const 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
945             GV; or the recursive result if we\'re an RV; or the IO slot of the symbol
946             named after the PV if we\'re a string.
947              
948             IO* sv_2io(SV* sv)','name' => 'sv_2io'},'SvMAGIC_set' => {'text' => 'Set the value of the MAGIC pointer in sv to val. See C.
949              
950             void SvMAGIC_set(SV* sv, MAGIC* val)','name' => 'SvMAGIC_set'},'newSVhek' => {'text' => 'Creates a new SV from the hash key structure. It will generate scalars that
951             point to the shared string table where possible. Returns a new (undefined)
952             SV if the hek is NULL.
953              
954             SV* newSVhek(const HEK *hek)','name' => 'newSVhek'},'isALPHA' => {'text' => 'Returns a boolean indicating whether the C C is a US-ASCII (Basic Latin)
955             alphabetic character.
956              
957             bool isALPHA(char ch)','name' => 'isALPHA'},'Nullhv' => {'text' => 'Null HV pointer.','name' => 'Nullhv'},'av_fill' => {'text' => 'Set the highest index in the array to the given number, equivalent to
958             Perl\'s C<$#array = $fill;>.
959              
960             The number of elements in the an array will be C after
961             av_fill() returns. If the array was previously shorter then the
962             additional elements appended are set to C. If the array
963             was longer, then the excess elements are freed. C is
964             the same as C.
965              
966             void av_fill(AV *av, I32 fill)','name' => 'av_fill'},'SvREFCNT_inc' => {'text' => 'Increments the reference count of the given SV.
967              
968             All of the following SvREFCNT_inc* macros are optimized versions of
969             SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
970              
971             SV* SvREFCNT_inc(SV* sv)','name' => 'SvREFCNT_inc'},'SvTYPE' => {'text' => 'Returns the type of the SV. See C.
972              
973             svtype SvTYPE(SV* sv)','name' => 'SvTYPE'},'SvIOK_only' => {'text' => 'Tells an SV that it is an integer and disables all other OK bits.
974              
975             void SvIOK_only(SV* sv)','name' => 'SvIOK_only'},'MoveD' => {'text' => 'Like C but returns dest. Useful for encouraging compilers to tail-call
976             optimise.
977              
978             void * MoveD(void* src, void* dest, int nitems, type)','name' => 'MoveD'},'SvROK_off' => {'text' => 'Unsets the RV status of an SV.
979              
980             void SvROK_off(SV* sv)','name' => 'SvROK_off'},'Renew' => {'text' => 'The XSUB-writer\'s interface to the C C function.
981              
982             void Renew(void* ptr, int nitems, type)','name' => 'Renew'},'grok_bin' => {'text' => 'converts a string representing a binary number to numeric form.
983              
984             On entry I and I<*len> give the string to scan, I<*flags> gives
985             conversion flags, and I should be NULL or a pointer to an NV.
986             The scan stops at the end of the string, or the first invalid character.
987             Unless C is set in I<*flags>, encountering an
988             invalid character will also trigger a warning.
989             On return I<*len> is set to the length of the scanned string,
990             and I<*flags> gives output flags.
991              
992             If the value is <= C it is returned as a UV, the output flags are clear,
993             and nothing is written to I<*result>. If the value is > UV_MAX C
994             returns UV_MAX, sets C in the output flags,
995             and writes the value to I<*result> (or the value is discarded if I
996             is NULL).
997              
998             The binary number may optionally be prefixed with "0b" or "b" unless
999             C is set in I<*flags> on entry. If
1000             C is set in I<*flags> then the binary
1001             number may use \'_\' characters to separate digits.
1002              
1003             UV grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)','name' => 'grok_bin'},'perl_free' => {'text' => 'Releases a Perl interpreter. See L.
1004              
1005             void perl_free(PerlInterpreter *my_perl)','name' => 'perl_free'},'mg_find' => {'text' => 'Finds the magic pointer for type matching the SV. See C.
1006              
1007             MAGIC* mg_find(const SV* sv, int type)','name' => 'mg_find'},'SvNOK_on' => {'text' => 'Tells an SV that it is a double.
1008              
1009             void SvNOK_on(SV* sv)','name' => 'SvNOK_on'},'XPUSHmortal' => {'text' => 'Push a new mortal SV onto the stack, extending the stack if necessary.
1010             Does not use C. See also C, C and C.
1011              
1012             void XPUSHmortal()','name' => 'XPUSHmortal'},'SvVOK' => {'text' => 'Returns a boolean indicating whether the SV contains a v-string.
1013              
1014             bool SvVOK(SV* sv)','name' => 'SvVOK'},'newSVpvn_share' => {'text' => 'Creates a new SV with its SvPVX_const pointing to a shared string in the string
1015             table. If the string does not already exist in the table, it is created
1016             first. Turns on READONLY and FAKE. If the C parameter is non-zero, that
1017             value is used; otherwise the hash is computed. The string\'s hash can be later
1018             be retrieved from the SV with the C macro. The idea here is
1019             that as the string table is used for shared hash keys these strings will have
1020             SvPVX_const == HeKEY and hash lookup will avoid string compare.
1021              
1022             SV* newSVpvn_share(const char* s, I32 len, U32 hash)','name' => 'newSVpvn_share'},'sv_setpvf_mg' => {'text' => 'Like C, but also handles \'set\' magic.
1023              
1024             void sv_setpvf_mg(SV *sv, const char* pat, ...)','name' => 'sv_setpvf_mg'},'SvPOKp' => {'text' => 'Returns a U32 value indicating whether the SV contains a character string.
1025             Checks the B setting. Use C instead.
1026              
1027             U32 SvPOKp(SV* sv)','name' => 'SvPOKp'},'sv_catpvn' => {'text' => 'Concatenates the string onto the end of the string which is in the SV. The
1028             C indicates number of bytes to copy. If the SV has the UTF-8
1029             status set, then the bytes appended should be valid UTF-8.
1030             Handles \'get\' magic, but not \'set\' magic. See C.
1031              
1032             void sv_catpvn(SV *dsv, const char *sstr, STRLEN len)','name' => 'sv_catpvn'},'sv_setref_pv' => {'text' => 'Copies a pointer into a new SV, optionally blessing the SV. The C
1033             argument will be upgraded to an RV. That RV will be modified to point to
1034             the new SV. If the C argument is NULL then C will be placed
1035             into the SV. The C argument indicates the package for the
1036             blessing. Set C to C to avoid the blessing. The new SV
1037             will have a reference count of 1, and the RV will be returned.
1038              
1039             Do not use with other Perl types such as HV, AV, SV, CV, because those
1040             objects will become corrupted by the pointer copy process.
1041              
1042             Note that C copies the string while this copies the pointer.
1043              
1044             SV* sv_setref_pv(SV* rv, const char* classname, void* pv)','name' => 'sv_setref_pv'},'fbm_compile' => {'text' => 'Analyses the string in order to make fast searches on it using fbm_instr()
1045             -- the Boyer-Moore algorithm.
1046              
1047             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.
1048             If the PV contains a character that cannot fit
1049             in a byte, this conversion will fail;
1050             in this case, either returns false or, if C is not
1051             true, croaks.
1052              
1053             This is not as a general purpose Unicode to byte encoding interface:
1054             use the Encode extension for that.
1055              
1056             NOTE: this function is experimental and may change or be
1057             removed without notice.
1058              
1059             bool sv_utf8_downgrade(SV *sv, bool fail_ok)','name' => 'sv_utf8_downgrade'},'SvNIOKp' => {'text' => 'Returns a U32 value indicating whether the SV contains a number, integer or
1060             double. Checks the B setting. Use C instead.
1061              
1062             U32 SvNIOKp(SV* sv)','name' => 'SvNIOKp'},'PERL_SYS_TERM' => {'text' => 'Provides system-specific clean up of the C runtime environment after
1063             running Perl interpreters. This should be called only once, after
1064             freeing any remaining Perl interpreters.
1065              
1066             void PERL_SYS_TERM()','name' => 'PERL_SYS_TERM'},'utf8_hop' => {'text' => 'Return the UTF-8 pointer C displaced by C characters, either
1067             forward or backward.
1068              
1069             WARNING: do not use the following unless you *know* C is within
1070             the UTF-8 data pointed to by C *and* that on entry C is aligned
1071             on the first byte of character or just after the last byte of a character.
1072              
1073             U8* utf8_hop(const U8 *s, I32 off)','name' => 'utf8_hop'},'sv_len_utf8' => {'text' => 'Returns the number of characters in the string in an SV, counting wide
1074             UTF-8 bytes as a single character. Handles magic and type coercion.
1075              
1076             STRLEN sv_len_utf8(SV* sv)','name' => 'sv_len_utf8'},'sv_setref_pvn' => {'text' => 'Copies a string into a new SV, optionally blessing the SV. The length of the
1077             string must be specified with C. The C argument will be upgraded to
1078             an RV. That RV will be modified to point to the new SV. The C
1079             argument indicates the package for the blessing. Set C to
1080             C to avoid the blessing. The new SV will have a reference count
1081             of 1, and the RV will be returned.
1082              
1083             Note that C copies the pointer while this copies the string.
1084              
1085             SV* sv_setref_pvn(SV* rv, const char* classname, const 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.
1086             The C indicates the length of the string. Handles \'set\' magic. Uses
1087             C, so C or C should be called to declare it. Do not
1088             call multiple C-oriented macros to return lists from XSUB\'s - see
1089             C instead. See also C and C.
1090              
1091             void PUSHp(char* str, STRLEN len)','name' => 'PUSHp'},'SvREFCNT_inc_simple_void' => {'text' => 'Same as SvREFCNT_inc_simple, but can only be used if you don\'t need the
1092             return value. The macro doesn\'t need to return a meaningful value.
1093              
1094             void SvREFCNT_inc_simple_void(SV* sv)','name' => 'SvREFCNT_inc_simple_void'},'hv_clear_placeholders' => {'text' => 'Clears any placeholders from a hash. If a restricted hash has any of its keys
1095             marked as readonly and the key is subsequently deleted, the key is not actually
1096             deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags
1097             it so it will be ignored by future operations such as iterating over the hash,
1098             but will still allow the hash to have a value reassigned to the key at some
1099             future point. This function clears any such placeholder keys from the hash.
1100             See Hash::Util::lock_keys() for an example of its use.
1101              
1102             void hv_clear_placeholders(HV *hv)','name' => 'hv_clear_placeholders'},'mXPUSHi' => {'text' => 'Push an integer onto the stack, extending the stack if necessary.
1103             Does not use C. See also C, C and C.
1104              
1105             void mXPUSHi(IV iv)','name' => 'mXPUSHi'},'dAX' => {'text' => 'Sets up the C variable.
1106             This is usually handled automatically by C by calling C.
1107              
1108             dAX;','name' => 'dAX'},'PL_sv_undef' => {'text' => 'This is the C SV. Always refer to this as C<&PL_sv_undef>.
1109              
1110             SV PL_sv_undef','name' => 'PL_sv_undef'},'SvRV_set' => {'text' => 'Set the value of the RV pointer in sv to val. See C.
1111              
1112             void SvRV_set(SV* sv, SV* val)','name' => 'SvRV_set'},'hv_iterkeysv' => {'text' => 'Returns the key as an C from the current position of the hash
1113             iterator. The return value will always be a mortal copy of the key. Also
1114             see C.
1115              
1116             SV* hv_iterkeysv(HE* entry)','name' => 'hv_iterkeysv'},'grok_number' => {'text' => 'Recognise (or not) a number. The type of the number is returned
1117             (0 if unrecognised), otherwise it is a bit-ORed combination of
1118             IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
1119             IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
1120              
1121             If the value of the number can fit an in UV, it is returned in the *valuep
1122             IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
1123             will never be set unless *valuep is valid, but *valuep may have been assigned
1124             to during processing even though IS_NUMBER_IN_UV is not set on return.
1125             If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
1126             valuep is non-NULL, but no actual assignment (or SEGV) will occur.
1127              
1128             IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
1129             seen (in which case *valuep gives the true value truncated to an integer), and
1130             IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
1131             absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the
1132             number is larger than a UV.
1133              
1134             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
1135             C only once. Only use this if C is an expression with side effects,
1136             otherwise use the more efficient C.
1137              
1138             IV SvIVx(SV* sv)','name' => 'SvIVx'},'grok_numeric_radix' => {'text' => 'Scan and skip for a numeric decimal separator (radix).
1139              
1140             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
1141             stack.
1142              
1143             void XST_mNO(int pos)','name' => 'XST_mNO'},'mPUSHp' => {'text' => 'Push a string onto the stack. The stack must have room for this element.
1144             The C indicates the length of the string. Does not use C.
1145             See also C, C and C.
1146              
1147             void mPUSHp(char* str, STRLEN len)','name' => 'mPUSHp'},'av_delete' => {'text' => 'Deletes the element indexed by C from the array. Returns the
1148             deleted element. If C equals C, the element is freed
1149             and null is returned.
1150              
1151             SV* av_delete(AV *av, I32 key, I32 flags)','name' => 'av_delete'},'utf8_distance' => {'text' => 'Returns the number of UTF-8 characters between the UTF-8 pointers C
1152             and C.
1153              
1154             WARNING: use only if you *know* that the pointers point inside the
1155             same UTF-8 buffer.
1156              
1157             IV utf8_distance(const U8 *a, const U8 *b)','name' => 'utf8_distance'},'SvPV_nomg' => {'text' => 'Like C but doesn\'t process magic.
1158              
1159             char* SvPV_nomg(SV* sv, STRLEN len)','name' => 'SvPV_nomg'},'savepvs' => {'text' => 'Like C, but takes a literal string instead of a string/length pair.
1160              
1161             char* savepvs(const char* s)','name' => 'savepvs'},'SvSTASH_set' => {'text' => 'Set the value of the STASH pointer in sv to val. See C.
1162              
1163             void SvSTASH_set(SV* sv, HV* val)','name' => 'SvSTASH_set'},'sv_collxfrm' => {'text' => 'Add Collate Transform magic to an SV if it doesn\'t already have it.
1164              
1165             Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
1166             scalar data of the variable, but transformed to such a format that a normal
1167             memory comparison can be used to compare the data according to the locale
1168             settings.
1169              
1170             char* sv_collxfrm(SV* sv, STRLEN* nxp)','name' => 'sv_collxfrm'},'ZeroD' => {'text' => 'Like C but returns dest. Useful for encouraging compilers to tail-call
1171             optimise.
1172              
1173             void * ZeroD(void* dest, int nitems, type)','name' => 'ZeroD'},'SvUV_nomg' => {'text' => 'Like C but doesn\'t process magic.
1174              
1175             UV SvUV_nomg(SV* sv)','name' => 'SvUV_nomg'},'SP' => {'text' => 'Stack pointer. This is usually handled by C. See C and
1176             C.','name' => 'SP'},'sv_catpvn_mg' => {'text' => 'Like C, but also handles \'set\' magic.
1177              
1178             void sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)','name' => 'sv_catpvn_mg'},'POPpx' => {'text' => 'Pops a string off the stack.
1179              
1180             char* POPpx','name' => 'POPpx'},'SvSTASH' => {'text' => 'Returns the stash of the SV.
1181              
1182             HV* SvSTASH(SV* sv)','name' => 'SvSTASH'},'gv_stashpvs' => {'text' => 'Like C, but takes a literal string instead of a string/length pair.
1183              
1184             HV* gv_stashpvs(const char* name, I32 create)','name' => 'gv_stashpvs'},'Zero' => {'text' => 'The XSUB-writer\'s interface to the C C function. The C is the
1185             destination, C is the number of items, and C is the type.
1186              
1187             void Zero(void* dest, int nitems, type)','name' => 'Zero'},'vcmp' => {'text' => 'Version object aware cmp. Both operands must already have been
1188             converted into version objects.
1189              
1190             int vcmp(SV *lhv, SV *rhv)','name' => 'vcmp'},'PL_modglobal' => {'text' => 'C is a general purpose, interpreter global HV for use by
1191             extensions that need to keep information on a per-interpreter basis.
1192             In a pinch, it can also be used as a symbol table for extensions
1193             to share data among each other. It is a good idea to use keys
1194             prefixed by the package name of the extension that owns the data.
1195              
1196             HV* PL_modglobal','name' => 'PL_modglobal'},'sv_setpvs' => {'text' => 'Like C, but takes a literal string instead of a string/length pair.
1197              
1198             void sv_setpvs(SV* sv, const char* s)','name' => 'sv_setpvs'},'XSRETURN_UNDEF' => {'text' => 'Return C<&PL_sv_undef> from an XSUB immediately. Uses C.
1199              
1200             XSRETURN_UNDEF;','name' => 'XSRETURN_UNDEF'},'sv_iv' => {'text' => 'A private implementation of the C macro for compilers which can\'t
1201             cope with complex macro expressions. Always use the macro instead.
1202              
1203             IV sv_iv(SV* sv)','name' => 'sv_iv'},'pv_escape' => {'text' => 'Escapes at most the first "count" chars of pv and puts the results into
1204             dsv such that the size of the escaped string will not exceed "max" chars
1205             and will not contain any incomplete escape sequences.
1206              
1207             If flags contains PERL_PV_ESCAPE_QUOTE then any double quotes in the string
1208             will also be escaped.
1209              
1210             Normally the SV will be cleared before the escaped string is prepared,
1211             but when PERL_PV_ESCAPE_NOCLEAR is set this will not occur.
1212              
1213             If PERL_PV_ESCAPE_UNI is set then the input string is treated as Unicode,
1214             if PERL_PV_ESCAPE_UNI_DETECT is set then the input string is scanned
1215             using C to determine if it is Unicode.
1216              
1217             If PERL_PV_ESCAPE_ALL is set then all input chars will be output
1218             using C<\\x01F1> style escapes, otherwise only chars above 255 will be
1219             escaped using this style, other non printable chars will use octal or
1220             common escaped patterns like C<\\n>. If PERL_PV_ESCAPE_NOBACKSLASH
1221             then all chars below 255 will be treated as printable and
1222             will be output as literals.
1223              
1224             If PERL_PV_ESCAPE_FIRSTCHAR is set then only the first char of the
1225             string will be escaped, regardles of max. If the string is utf8 and
1226             the chars value is >255 then it will be returned as a plain hex
1227             sequence. Thus the output will either be a single char,
1228             an octal escape sequence, a special escape like C<\\n> or a 3 or
1229             more digit hex value.
1230              
1231             If PERL_PV_ESCAPE_RE is set then the escape char used will be a \'%\' and
1232             not a \'\\\\\'. This is because regexes very often contain backslashed
1233             sequences, whereas \'%\' is not a particularly common character in patterns.
1234              
1235             Returns a pointer to the escaped text as held by dsv.
1236              
1237             char* pv_escape(SV *dsv, char const * const str, const STRLEN count, const STRLEN max, STRLEN * const escaped, const U32 flags)','name' => 'pv_escape'},'HeSVKEY_force' => {'text' => 'Returns the key as an C. Will create and return a temporary mortal
1238             C if the hash entry contains only a C key.
1239              
1240             SV* HeSVKEY_force(HE* he)','name' => 'HeSVKEY_force'},'newRV_inc' => {'text' => 'Creates an RV wrapper for an SV. The reference count for the original SV is
1241             incremented.
1242              
1243             SV* newRV_inc(SV* sv)','name' => 'newRV_inc'},'SVt_PVCV' => {'text' => 'Type flag for code refs. See C.','name' => 'SVt_PVCV'},'sv_setpviv_mg' => {'text' => 'Like C, but also handles \'set\' magic.
1244              
1245             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
1246             C only once. Only use this if C is an expression with side effects,
1247             otherwise use the more efficient C.
1248              
1249             UV SvUVx(SV* sv)','name' => 'SvUVx'},'SvROK_on' => {'text' => 'Tells an SV that it is an RV.
1250              
1251             void SvROK_on(SV* sv)','name' => 'SvROK_on'},'sv_2bool' => {'text' => 'This function is only called on magical items, and is only used by
1252             sv_true() or its macro equivalent.
1253              
1254             bool sv_2bool(SV* sv)','name' => 'sv_2bool'},'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.
1255              
1256             dORIGMARK;','name' => 'dORIGMARK'},'sv_newmortal' => {'text' => 'Creates a new null SV which is mortal. The reference count of the SV is
1257             set to 1. It will be destroyed "soon", either by an explicit call to
1258             FREETMPS, or by an implicit call at places such as statement boundaries.
1259             See also C and C.
1260              
1261             SV* sv_newmortal()','name' => 'sv_newmortal'},'sv_clear' => {'text' => 'Clear an SV: call any destructors, free up any memory used by the body,
1262             and free the body itself. The SV\'s head is I freed, although
1263             its type is set to all 1\'s so that it won\'t inadvertently be assumed
1264             to be live during global destruction etc.
1265             This function should only be called when REFCNT is zero. Most of the time
1266             you\'ll want to call C (or its macro wrapper C)
1267             instead.
1268              
1269             void sv_clear(SV* sv)','name' => 'sv_clear'},'SvOOK' => {'text' => 'Returns a U32 indicating whether the SvIVX is a valid offset value for
1270             the SvPVX. This hack is used internally to speed up removal of characters
1271             from the beginning of a SvPV. When SvOOK is true, then the start of the
1272             allocated string buffer is really (SvPVX - SvIVX).
1273              
1274             U32 SvOOK(SV* sv)','name' => 'SvOOK'},'SvPV_set' => {'text' => 'Set the value of the PV pointer in sv to val. See C.
1275              
1276             void SvPV_set(SV* sv, char* val)','name' => 'SvPV_set'},'XSRETURN_NV' => {'text' => 'Return a double from an XSUB immediately. Uses C.
1277              
1278             void XSRETURN_NV(NV nv)','name' => 'XSRETURN_NV'},'SvGAMAGIC' => {'text' => 'Returns true if the SV has get magic or overloading. If either is true then
1279             the scalar is active data, and has the potential to return a new value every
1280             time it is accessed. Hence you must be careful to only read it once per user
1281             logical operation and work with that returned value. If neither is true then
1282             the scalar\'s value cannot change unless written to.
1283              
1284             U32 SvGAMAGIC(SV* sv)','name' => 'SvGAMAGIC'},'svtype' => {'text' => 'An enum of flags for Perl types. These are found in the file B
1285             in the C enum. Test these flags with the C macro.','name' => 'svtype'},'load_module' => {'text' => 'Loads the module whose name is pointed to by the string part of name.
1286             Note that the actual module name, not its filename, should be given.
1287             Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of
1288             PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
1289             (or 0 for no flags). ver, if specified, provides version semantics
1290             similar to C. The optional trailing SV*
1291             arguments can be used to specify arguments to the module\'s import()
1292             method, similar to C. They must be
1293             terminated with a final NULL pointer. Note that this list can only
1294             be omitted when the PERL_LOADMOD_NOIMPORT flag has been used.
1295             Otherwise at least a single NULL pointer to designate the default
1296             import list is required.
1297              
1298             void load_module(U32 flags, SV* name, SV* ver, ...)','name' => 'load_module'},'get_hv' => {'text' => 'Returns the HV of the specified Perl hash. C are passed to
1299             C. If C is set and the
1300             Perl variable does not exist then it will be created. If C is zero
1301             and the variable does not exist then NULL is returned.
1302              
1303             NOTE: the perl_ form of this function is deprecated.
1304              
1305             HV* get_hv(const char *name, I32 flags)','name' => 'get_hv'},'hv_clear' => {'text' => 'Clears a hash, making it empty.
1306              
1307             void hv_clear(HV* hv)','name' => 'hv_clear'},'PoisonNew' => {'text' => 'PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
1308              
1309             void PoisonNew(void* dest, int nitems, type)','name' => 'PoisonNew'},'XSRETURN_YES' => {'text' => 'Return C<&PL_sv_yes> from an XSUB immediately. Uses C.
1310              
1311             XSRETURN_YES;','name' => 'XSRETURN_YES'},'sv_nv' => {'text' => 'A private implementation of the C macro for compilers which can\'t
1312             cope with complex macro expressions. Always use the macro instead.
1313              
1314             NV sv_nv(SV* sv)','name' => 'sv_nv'},'Poison' => {'text' => 'PoisonWith(0xEF) for catching access to freed memory.
1315              
1316             void Poison(void* dest, int nitems, type)','name' => 'Poison'},'Renewc' => {'text' => 'The XSUB-writer\'s interface to the C C function, with
1317             cast.
1318              
1319             void Renewc(void* ptr, int nitems, type, cast)','name' => 'Renewc'},'sv_catpvf_mg' => {'text' => 'Like C, but also handles \'set\' magic.
1320              
1321             void sv_catpvf_mg(SV *sv, const char* pat, ...)','name' => 'sv_catpvf_mg'},'PUSHu' => {'text' => 'Push an unsigned integer onto the stack. The stack must have room for this
1322             element. Handles \'set\' magic. Uses C, so C or C
1323             should be called to declare it. Do not call multiple C-oriented
1324             macros to return lists from XSUB\'s - see C instead. See also
1325             C and C.
1326              
1327             void PUSHu(UV uv)','name' => 'PUSHu'},'get_sv' => {'text' => 'Returns the SV of the specified Perl scalar. C are passed to
1328             C. If C is set and the
1329             Perl variable does not exist then it will be created. If C is zero
1330             and the variable does not exist then NULL is returned.
1331              
1332             NOTE: the perl_ form of this function is deprecated.
1333              
1334             SV* get_sv(const char *name, I32 flags)','name' => 'get_sv'},'SvPOK_off' => {'text' => 'Unsets the PV status of an SV.
1335              
1336             void SvPOK_off(SV* sv)','name' => 'SvPOK_off'},'newSVsv' => {'text' => 'Creates a new SV which is an exact duplicate of the original SV.
1337             (Uses C).
1338              
1339             SV* newSVsv(SV* old)','name' => 'newSVsv'},'hv_magic' => {'text' => 'Adds magic to a hash. See C.
1340              
1341             void hv_magic(HV *hv, GV *gv, int how)','name' => 'hv_magic'},'sv_setpv_mg' => {'text' => 'Like C, but also handles \'set\' magic.
1342              
1343             void sv_setpv_mg(SV *sv, const char *ptr)','name' => 'sv_setpv_mg'},'sv_2mortal' => {'text' => 'Marks an existing SV as mortal. The SV will be destroyed "soon", either
1344             by an explicit call to FREETMPS, or by an implicit call at places such as
1345             statement boundaries. SvTEMP() is turned on which means that the SV\'s
1346             string buffer can be "stolen" if this SV is copied. See also C
1347             and C.
1348              
1349             SV* sv_2mortal(SV* sv)','name' => 'sv_2mortal'},'XCPT_TRY_END' => {'text' => 'Ends a try block. See L.','name' => 'XCPT_TRY_END'},'av_undef' => {'text' => 'Undefines the array. Frees the memory used by the array itself.
1350              
1351             void av_undef(AV *av)','name' => 'av_undef'},'HeKEY' => {'text' => 'Returns the actual pointer stored in the key slot of the hash entry. The
1352             pointer may be either C or C, depending on the value of
1353             C. Can be assigned to. The C or C macros are
1354             usually preferable for finding the value of a key.
1355              
1356             void* HeKEY(HE* he)','name' => 'HeKEY'},'pack_cat' => {'text' => 'The engine implementing pack() Perl function. Note: parameters next_in_list and
1357             flags are not used. This call should not be used; use packlist instead.
1358              
1359             void pack_cat(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)','name' => 'pack_cat'},'sv_cmp' => {'text' => 'Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the
1360             string in C is less than, equal to, or greater than the string in
1361             C. Is UTF-8 and \'use bytes\' aware, handles get magic, and will
1362             coerce its args to strings if necessary. See also C.
1363              
1364             I32 sv_cmp(SV* sv1, SV* sv2)','name' => 'sv_cmp'},'SvEND' => {'text' => 'Returns a pointer to the last character in the string which is in the SV.
1365             See C. Access the character as *(SvEND(sv)).
1366              
1367             char* SvEND(SV* sv)','name' => 'SvEND'},'mg_free' => {'text' => 'Free any magic storage used by the SV. See C.
1368              
1369             int mg_free(SV* sv)','name' => 'mg_free'},'GIMME_V' => {'text' => 'The XSUB-writer\'s equivalent to Perl\'s C. Returns C,
1370             C or C for void, scalar or list context,
1371             respectively.
1372              
1373             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
1374             a private copy; if we\'re a ref, stop refing; if we\'re a glob, downgrade to
1375             an xpvmg; if we\'re a copy-on-write scalar, this is the on-write time when
1376             we do the copy, and is also used locally. If C is set
1377             then a copy-on-write scalar drops its PV buffer (if any) and becomes
1378             SvPOK_off rather than making a copy. (Used where this scalar is about to be
1379             set to some other value.) In addition, the C parameter gets passed to
1380             C when unrefing. C calls this function
1381             with flags set to 0.
1382              
1383             void sv_force_normal_flags(SV *sv, U32 flags)','name' => 'sv_force_normal_flags'},'sv_setsv_flags' => {'text' => 'Copies the contents of the source SV C into the destination SV
1384             C. The source SV may be destroyed if it is mortal, so don\'t use this
1385             function if the source SV needs to be reused. Does not handle \'set\' magic.
1386             Loosely speaking, it performs a copy-by-value, obliterating any previous
1387             content of the destination.
1388             If the C parameter has the C bit set, will C on
1389             C if appropriate, else not. If the C parameter has the
1390             C bit set then the buffers of temps will not be stolen.
1391             and C are implemented in terms of this function.
1392              
1393             You probably want to use one of the assortment of wrappers, such as
1394             C, C, C and
1395             C.
1396              
1397             This is the primary function for copying scalars, and most other
1398             copy-ish functions and macros use this underneath.
1399              
1400             void sv_setsv_flags(SV *dstr, SV *sstr, I32 flags)','name' => 'sv_setsv_flags'},'is_utf8_char' => {'text' => 'Tests if some arbitrary number of bytes begins in a valid UTF-8
1401             character. Note that an INVARIANT (i.e. ASCII on non-EBCDIC machines)
1402             character is a valid UTF-8 character. The actual number of bytes in the UTF-8
1403             character will be returned if it is valid, otherwise 0.
1404              
1405             STRLEN is_utf8_char(const U8 *s)','name' => 'is_utf8_char'},'Copy' => {'text' => 'The XSUB-writer\'s interface to the C C function. The C is the
1406             source, C is the destination, C is the number of items, and C is
1407             the type. May fail on overlapping copies. See also C.
1408              
1409             void Copy(void* src, void* dest, int nitems, type)','name' => 'Copy'},'sv_taint' => {'text' => 'Taint an SV. Use C instead.
1410             void sv_taint(SV* sv)','name' => 'sv_taint'},'SvNOK_off' => {'text' => 'Unsets the NV status of an SV.
1411              
1412             void SvNOK_off(SV* sv)','name' => 'SvNOK_off'},'sv_utf8_upgrade' => {'text' => 'Converts the PV of an SV to its UTF-8-encoded form.
1413             Forces the SV to string form if it is not already.
1414             Will C on C if appropriate.
1415             Always sets the SvUTF8 flag to avoid future validity checks even
1416             if the whole string is the same in UTF-8 as not.
1417             Returns the number of bytes in the converted string
1418              
1419             This is not as a general purpose byte encoding to Unicode interface:
1420             use the Encode extension for that.
1421              
1422             STRLEN sv_utf8_upgrade(SV *sv)','name' => 'sv_utf8_upgrade'},'SvIOK_notUV' => {'text' => 'Returns a boolean indicating whether the SV contains a signed integer.
1423              
1424             bool SvIOK_notUV(SV* sv)','name' => 'SvIOK_notUV'},'dXSARGS' => {'text' => 'Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
1425             Sets up the C and C variables by calling C and C.
1426             This is usually handled automatically by C.
1427              
1428             dXSARGS;','name' => 'dXSARGS'},'savesharedpv' => {'text' => 'A version of C which allocates the duplicate string in memory
1429             which is shared between threads.
1430              
1431             char* savesharedpv(const char* pv)','name' => 'savesharedpv'},'isSPACE' => {'text' => 'Returns a boolean indicating whether the C C is a US-ASCII (Basic Latin)
1432             whitespace.
1433              
1434             bool isSPACE(char ch)','name' => 'isSPACE'},'Safefree' => {'text' => 'The XSUB-writer\'s interface to the C C function.
1435              
1436             void Safefree(void* ptr)','name' => 'Safefree'},'gv_stashpvn' => {'text' => 'Returns a pointer to the stash for a specified package. The C
1437             parameter indicates the length of the C, in bytes. C is passed
1438             to C, so if set to C then the package will be
1439             created if it does not already exist. If the package does not exist and
1440             C is 0 (or any other setting that does not create packages) then NULL
1441             is returned.
1442              
1443              
1444             HV* gv_stashpvn(const char* name, U32 namelen, I32 flags)','name' => 'gv_stashpvn'},'mPUSHu' => {'text' => 'Push an unsigned integer onto the stack. The stack must have room for this
1445             element. Does not use C. See also C, C and C.
1446              
1447             void mPUSHu(UV uv)','name' => 'mPUSHu'},'newSV_type' => {'text' => 'Creates a new SV, of the type specified. The reference count for the new SV
1448             is set to 1.
1449              
1450             SV* newSV_type(svtype type)','name' => 'newSV_type'},'sv_setsv_nomg' => {'text' => 'Like C but doesn\'t process magic.
1451              
1452             void sv_setsv_nomg(SV* dsv, SV* ssv)','name' => 'sv_setsv_nomg'},'SvREFCNT_inc_void_NN' => {'text' => 'Same as SvREFCNT_inc, but can only be used if you don\'t need the return
1453             value, and you know that I is not NULL. The macro doesn\'t need
1454             to return a meaningful value, or check for NULLness, so it\'s smaller
1455             and faster.
1456              
1457             void SvREFCNT_inc_void_NN(SV* sv)','name' => 'SvREFCNT_inc_void_NN'},'Perl_signbit' => {'text' => 'Return a non-zero integer if the sign bit on an NV is set, and 0 if
1458             it is not.
1459              
1460             If Configure detects this system has a signbit() that will work with
1461             our NVs, then we just use it via the #define in perl.h. Otherwise,
1462             fall back on this implementation. As a first pass, this gets everything
1463             right except -0.0. Alas, catching -0.0 is the main use for this function,
1464             so this is not too helpful yet. Still, at least we have the scaffolding
1465             in place to support other systems, should that prove useful.
1466              
1467              
1468             Configure notes: This function is called \'Perl_signbit\' instead of a
1469             plain \'signbit\' because it is easy to imagine a system having a signbit()
1470             function or macro that doesn\'t happen to work with our particular choice
1471             of NVs. We shouldn\'t just re-#define signbit as Perl_signbit and expect
1472             the standard system headers to be happy. Also, this is a no-context
1473             function (no pTHX_) because Perl_signbit() is usually re-#defined in
1474             perl.h as a simple macro call to the system\'s signbit().
1475             Users should just always call Perl_signbit().
1476              
1477             NOTE: this function is experimental and may change or be
1478             removed without notice.
1479              
1480             int Perl_signbit(NV f)','name' => 'Perl_signbit'},'av_create_and_push' => {'text' => 'Push an SV onto the end of the array, creating the array if necessary.
1481             A small internal helper function to remove a commonly duplicated idiom.
1482              
1483             NOTE: this function is experimental and may change or be
1484             removed without notice.
1485              
1486             void av_create_and_push(AV **const avp, SV *const val)','name' => 'av_create_and_push'},'PUSH_MULTICALL' => {'text' => 'Opening bracket for a lightweight callback.
1487             See L.
1488              
1489             PUSH_MULTICALL;','name' => 'PUSH_MULTICALL'},'XPUSHp' => {'text' => 'Push a string onto the stack, extending the stack if necessary. The C
1490             indicates the length of the string. Handles \'set\' magic. Uses C, so
1491             C or C should be called to declare it. Do not call
1492             multiple C-oriented macros to return lists from XSUB\'s - see
1493             C instead. See also C and C.
1494              
1495             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
1496             flag off so that it looks like octets again.
1497              
1498             void sv_utf8_encode(SV *sv)','name' => 'sv_utf8_encode'},'SvUTF8_on' => {'text' => 'Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
1499             Do not use frivolously.
1500              
1501             void SvUTF8_on(SV *sv)','name' => 'SvUTF8_on'},'sv_setpvn_mg' => {'text' => 'Like C, but also handles \'set\' magic.
1502              
1503             void sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)','name' => 'sv_setpvn_mg'},'toLOWER' => {'text' => 'Converts the specified character to lowercase. Characters outside the
1504             US-ASCII (Basic Latin) range are viewed as not having any case.
1505              
1506             char toLOWER(char ch)','name' => 'toLOWER'},'POPp' => {'text' => 'Pops a string off the stack. Deprecated. New code should use POPpx.
1507              
1508             char* POPp','name' => 'POPp'},'SvIV_nomg' => {'text' => 'Like C but doesn\'t process magic.
1509              
1510             IV SvIV_nomg(SV* sv)','name' => 'SvIV_nomg'},'RETVAL' => {'text' => 'Variable which is setup by C to hold the return value for an
1511             XSUB. This is always the proper type for the XSUB. See
1512             L.
1513              
1514             (whatever) RETVAL','name' => 'RETVAL'},'HeSVKEY' => {'text' => 'Returns the key as an C, or C if the hash entry does not
1515             contain an C key.
1516              
1517             SV* HeSVKEY(HE* he)','name' => 'HeSVKEY'},'new_version' => {'text' => 'Returns a new version object based on the passed in SV:
1518              
1519             SV *sv = new_version(SV *ver);
1520              
1521             Does not alter the passed in ver SV. See "upg_version" if you
1522             want to upgrade the SV.
1523              
1524             SV* new_version(SV *ver)','name' => 'new_version'},'sv_pvbyten' => {'text' => 'A private implementation of the C macro for compilers
1525             which can\'t cope with complex macro expressions. Always use the macro
1526             instead.
1527              
1528             char* sv_pvbyten(SV *sv, STRLEN *lp)','name' => 'sv_pvbyten'},'Nullav' => {'text' => 'Null AV pointer.','name' => 'Nullav'},'sv_copypv' => {'text' => 'Copies a stringified representation of the source SV into the
1529             destination SV. Automatically performs any necessary mg_get and
1530             coercion of numeric values into strings. Guaranteed to preserve
1531             UTF8 flag even from overloaded objects. Similar in nature to
1532             sv_2pv[_flags] but operates directly on an SV instead of just the
1533             string. Mostly uses sv_2pv_flags to do its work, except when that
1534             would lose the UTF-8\'ness of the PV.
1535              
1536             void sv_copypv(SV* dsv, SV* ssv)','name' => 'sv_copypv'},'sv_pv' => {'text' => 'Use the C macro instead
1537              
1538             char* sv_pv(SV *sv)','name' => 'sv_pv'},'pv_pretty' => {'text' => 'Converts a string into something presentable, handling escaping via
1539             pv_escape() and supporting quoting and ellipses.
1540              
1541             If the PERL_PV_PRETTY_QUOTE flag is set then the result will be
1542             double quoted with any double quotes in the string escaped. Otherwise
1543             if the PERL_PV_PRETTY_LTGT flag is set then the result be wrapped in
1544             angle brackets.
1545            
1546             If the PERL_PV_PRETTY_ELLIPSES flag is set and not all characters in
1547             string were output then an ellipsis C<...> will be appended to the
1548             string. Note that this happens AFTER it has been quoted.
1549            
1550             If start_color is non-null then it will be inserted after the opening
1551             quote (if there is one) but before the escaped text. If end_color
1552             is non-null then it will be inserted after the escaped text but before
1553             any quotes or ellipses.
1554              
1555             Returns a pointer to the prettified text as held by dsv.
1556            
1557             char* pv_pretty(SV *dsv, char const * const str, const STRLEN count, const STRLEN max, char const * const start_color, char const * const end_color, const U32 flags)','name' => 'pv_pretty'},'sv_setnv_mg' => {'text' => 'Like C, but also handles \'set\' magic.
1558              
1559             void sv_setnv_mg(SV *sv, NV num)','name' => 'sv_setnv_mg'},'hv_iternextsv' => {'text' => 'Performs an C, C, and C in one
1560             operation.
1561              
1562             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 native byte encoding.
1563             Unlike C, this over-writes the original string, and
1564             updates len to contain the new length.
1565             Returns zero on failure, setting C to -1.
1566              
1567             If you need a copy of the string, see C.
1568              
1569             NOTE: this function is experimental and may change or be
1570             removed without notice.
1571              
1572             U8* utf8_to_bytes(U8 *s, STRLEN *len)','name' => 'utf8_to_bytes'},'sv_pvbyten_force' => {'text' => 'The backend for the C macro. Always use the macro instead.
1573              
1574             char* sv_pvbyten_force(SV* sv, STRLEN* lp)','name' => 'sv_pvbyten_force'},'uvuni_to_utf8_flags' => {'text' => 'Adds the UTF-8 representation of the Unicode codepoint C to the end
1575             of the string C; C should be have at least C free
1576             bytes available. The return value is the pointer to the byte after the
1577             end of the new character. In other words,
1578              
1579             d = uvuni_to_utf8_flags(d, uv, flags);
1580              
1581             or, in most cases,
1582              
1583             d = uvuni_to_utf8(d, uv);
1584              
1585             (which is equivalent to)
1586              
1587             d = uvuni_to_utf8_flags(d, uv, 0);
1588              
1589             is the recommended Unicode-aware way of saying
1590              
1591             *(d++) = uv;
1592              
1593             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
1594             value is stored in a new mortal SV.
1595              
1596             void XST_mIV(int pos, IV iv)','name' => 'XST_mIV'},'mPUSHs' => {'text' => 'Push an SV onto the stack and mortalizes the SV. The stack must have room
1597             for this element. Does not use C. See also C and C.
1598              
1599             void mPUSHs(SV* sv)','name' => 'mPUSHs'},'G_DISCARD' => {'text' => 'Indicates that arguments returned from a callback should be discarded. See
1600             L.','name' => 'G_DISCARD'},'GvSV' => {'text' => 'Return the SV from the GV.
1601              
1602             SV* GvSV(GV* gv)','name' => 'GvSV'},'XST_mNV' => {'text' => 'Place a double into the specified position C on the stack. The value
1603             is stored in a new mortal SV.
1604              
1605             void XST_mNV(int pos, NV nv)','name' => 'XST_mNV'},'UNDERBAR' => {'text' => 'The SV* corresponding to the $_ variable. Works even if there
1606             is a lexical $_ in scope.','name' => 'UNDERBAR'},'pad_sv' => {'text' => 'Get the value at offset po in the current pad.
1607             Use macro PAD_SV instead of calling this function directly.
1608              
1609             SV* pad_sv(PADOFFSET po)','name' => 'pad_sv'},'POPi' => {'text' => 'Pops an integer off the stack.
1610              
1611             IV POPi','name' => 'POPi'},'SvPVutf8_force' => {'text' => 'Like C, but converts sv to utf8 first if necessary.
1612              
1613             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.
1614             May cause the SV to be upgraded to UTF-8 as a side-effect.
1615              
1616             Usually accessed via the C macro.
1617              
1618             char* sv_2pvutf8_nolen(SV* sv)','name' => 'sv_2pvutf8_nolen'},'SVt_NV' => {'text' => 'Double type flag for scalars. See C.','name' => 'SVt_NV'},'mro_get_linear_isa' => {'text' => 'Returns either C or
1619             C for the given stash,
1620             dependant upon which MRO is in effect
1621             for that stash. The return value is a
1622             read-only AV*.
1623              
1624             You are responsible for C on the
1625             return value if you plan to store it anywhere
1626             semi-permanently (otherwise it might be deleted
1627             out from under you the next time the cache is
1628             invalidated).
1629              
1630             AV* mro_get_linear_isa(HV* stash)','name' => 'mro_get_linear_isa'},'av_store' => {'text' => 'Stores an SV in an array. The array index is specified as C. The
1631             return value will be NULL if the operation failed or if the value did not
1632             need to be actually stored within the array (as in the case of tied
1633             arrays). Otherwise it can be dereferenced to get the original C. Note
1634             that the caller is responsible for suitably incrementing the reference
1635             count of C before the call, and decrementing it if the function
1636             returned NULL.
1637              
1638             See L for
1639             more information on how to use this function on tied arrays.
1640              
1641             SV** av_store(AV *av, I32 key, SV *val)','name' => 'av_store'},'SvPVbytex' => {'text' => 'Like C, but converts sv to byte representation first if necessary.
1642             Guarantees to evaluate sv only once; use the more efficient C
1643             otherwise.
1644              
1645             char* SvPVbytex(SV* sv, STRLEN len)','name' => 'SvPVbytex'},'PUSHMARK' => {'text' => 'Opening bracket for arguments on a callback. See C and
1646             L.
1647              
1648             void PUSHMARK(SP)','name' => 'PUSHMARK'},'ST' => {'text' => 'Used to access elements on the XSUB\'s stack.
1649              
1650             SV* ST(int ix)','name' => 'ST'},'call_pv' => {'text' => 'Performs a callback to the specified Perl sub. See L.
1651              
1652             NOTE: the perl_ form of this function is deprecated.
1653              
1654             I32 call_pv(const char* sub_name, I32 flags)','name' => 'call_pv'},'av_fetch' => {'text' => 'Returns the SV at the specified index in the array. The C is the
1655             index. If C is set then the fetch will be part of a store. Check
1656             that the return value is non-null before dereferencing it to a C.
1657              
1658             See L for
1659             more information on how to use this function on tied arrays.
1660              
1661             SV** av_fetch(AV *av, I32 key, I32 lval)','name' => 'av_fetch'},'gv_fetchmeth_autoload' => {'text' => 'Same as gv_fetchmeth(), but looks for autoloaded subroutines too.
1662             Returns a glob for the subroutine.
1663              
1664             For an autoloaded subroutine without a GV, will create a GV even
1665             if C. For an autoloaded subroutine without a stub, GvCV()
1666             of the result may be zero.
1667              
1668             GV* gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)','name' => 'gv_fetchmeth_autoload'},'SvNOK_only' => {'text' => 'Tells an SV that it is a double and disables all other OK bits.
1669              
1670             void SvNOK_only(SV* sv)','name' => 'SvNOK_only'},'hv_iterval' => {'text' => 'Returns the value from the current position of the hash iterator. See
1671             C.
1672              
1673             SV* hv_iterval(HV *hv, HE *entry)','name' => 'hv_iterval'},'sv_reftype' => {'text' => 'Returns a string describing what the SV is a reference to.
1674              
1675             const char* sv_reftype(const 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
1676             start of the string, to a count of the equivalent number of UTF-8 chars.
1677             Handles magic and type coercion.
1678              
1679             void sv_pos_b2u(SV* sv, I32* offsetp)','name' => 'sv_pos_b2u'},'SvREFCNT_inc_simple_void_NN' => {'text' => 'Same as SvREFCNT_inc, but can only be used if you don\'t need the return
1680             value, and you know that I is not NULL. The macro doesn\'t need
1681             to return a meaningful value, or check for NULLness, so it\'s smaller
1682             and faster.
1683              
1684             void SvREFCNT_inc_simple_void_NN(SV* sv)','name' => 'SvREFCNT_inc_simple_void_NN'},'av_len' => {'text' => 'Returns the highest index in the array. The number of elements in the
1685             array is C. Returns -1 if the array is empty.
1686              
1687             I32 av_len(const AV *av)','name' => 'av_len'},'SVt_IV' => {'text' => 'Integer type flag for scalars. See C.','name' => 'SVt_IV'},'SvIsCOW' => {'text' => 'Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
1688             hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
1689             COW)
1690              
1691             bool SvIsCOW(SV* sv)','name' => 'SvIsCOW'},'sv_unmagic' => {'text' => 'Removes all magic of type C from an SV.
1692              
1693             int sv_unmagic(SV* sv, int type)','name' => 'sv_unmagic'},'SvTAINT' => {'text' => 'Taints an SV if tainting is enabled.
1694              
1695             void SvTAINT(SV* sv)','name' => 'SvTAINT'},'sv_catsv' => {'text' => 'Concatenates the string from SV C onto the end of the string in
1696             SV C. Modifies C but not C. Handles \'get\' magic, but
1697             not \'set\' magic. See C.
1698              
1699             void sv_catsv(SV *dstr, SV *sstr)','name' => 'sv_catsv'},'SvPOK_on' => {'text' => 'Tells an SV that it is a string.
1700              
1701             void SvPOK_on(SV* sv)','name' => 'SvPOK_on'},'ax' => {'text' => 'Variable which is setup by C to indicate the stack base offset,
1702             used by the C, C and C macros. The C macro
1703             must be called prior to setup the C variable.
1704              
1705             I32 ax','name' => 'ax'},'mg_clear' => {'text' => 'Clear something magical that the SV represents. See C.
1706              
1707             int mg_clear(SV* sv)','name' => 'mg_clear'},'my_sprintf' => {'text' => 'The C library C, wrapped if necessary, to ensure that it will return
1708             the length of the string written to the buffer. Only rare pre-ANSI systems
1709             need the wrapper function - usually this is a direct call to C.
1710              
1711             int my_sprintf(char *buffer, const char *pat, ...)','name' => 'my_sprintf'},'to_utf8_fold' => {'text' => 'Convert the UTF-8 encoded character at p to its foldcase version and
1712             store that in UTF-8 in ustrp and its length in bytes in lenp. Note
1713             that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
1714             foldcase version may be longer than the original character (up to
1715             three characters).
1716              
1717             The first character of the foldcased version is returned
1718             (but note, as explained above, that there may be more.)
1719              
1720             UV to_utf8_fold(const 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
1721             store that in UTF-8 in ustrp and its length in bytes in lenp. Note
1722             that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since
1723             the uppercase version may be longer than the original character.
1724              
1725             The first character of the uppercased version is returned
1726             (but note, as explained above, that there may be more.)
1727              
1728             UV to_utf8_upper(const U8 *p, U8* ustrp, STRLEN *lenp)','name' => 'to_utf8_upper'},'gv_stashpv' => {'text' => 'Returns a pointer to the stash for a specified package. Uses C to
1729             determine the length of C, then calls C.
1730              
1731             HV* gv_stashpv(const char* name, I32 flags)','name' => 'gv_stashpv'},'sv_vcatpvf_mg' => {'text' => 'Like C, but also handles \'set\' magic.
1732              
1733             Usually used via its frontend C.
1734              
1735             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.
1736             Guarantees to evaluate sv only once; use the more efficient C
1737             otherwise.
1738              
1739             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.
1740             Handles \'set\' magic. Uses C, so C or C should be
1741             called to declare it. Do not call multiple C-oriented macros to
1742             return lists from XSUB\'s - see C instead. See also C and
1743             C.
1744              
1745             void PUSHi(IV iv)','name' => 'PUSHi'},'mXPUSHu' => {'text' => 'Push an unsigned integer onto the stack, extending the stack if necessary.
1746             Does not use C. See also C, C and C.
1747              
1748             void mXPUSHu(UV uv)','name' => 'mXPUSHu'},'hv_exists_ent' => {'text' => 'Returns a boolean indicating whether the specified hash key exists. C
1749             can be a valid precomputed hash value, or 0 to ask for it to be
1750             computed.
1751              
1752             bool hv_exists_ent(HV *hv, SV *keysv, U32 hash)','name' => 'hv_exists_ent'},'SvLEN_set' => {'text' => 'Set the actual length of the string which is in the SV. See C.
1753              
1754             void SvLEN_set(SV* sv, STRLEN len)','name' => 'SvLEN_set'},'to_utf8_lower' => {'text' => 'Convert the UTF-8 encoded character at p to its lowercase version and
1755             store that in UTF-8 in ustrp and its length in bytes in lenp. Note
1756             that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the
1757             lowercase version may be longer than the original character.
1758              
1759             The first character of the lowercased version is returned
1760             (but note, as explained above, that there may be more.)
1761              
1762             UV to_utf8_lower(const U8 *p, U8* ustrp, STRLEN *lenp)','name' => 'to_utf8_lower'},'SvNIOK' => {'text' => 'Returns a U32 value indicating whether the SV contains a number, integer or
1763             double.
1764              
1765             U32 SvNIOK(SV* sv)','name' => 'SvNIOK'},'mro_method_changed_in' => {'text' => 'Invalidates method caching on any child classes
1766             of the given stash, so that they might notice
1767             the changes in this one.
1768              
1769             Ideally, all instances of C in
1770             perl source outside of C should be
1771             replaced by calls to this.
1772              
1773             Perl automatically handles most of the common
1774             ways a method might be redefined. However, there
1775             are a few ways you could change a method in a stash
1776             without the cache code noticing, in which case you
1777             need to call this method afterwards:
1778              
1779             1) Directly manipulating the stash HV entries from
1780             XS code.
1781              
1782             2) Assigning a reference to a readonly scalar
1783             constant into a stash entry in order to create
1784             a constant subroutine (like constant.pm
1785             does).
1786              
1787             This same method is available from pure perl
1788             via, C.
1789              
1790             void mro_method_changed_in(HV* stash)','name' => 'mro_method_changed_in'},'unpack_str' => {'text' => 'The engine implementing unpack() Perl function. Note: parameters strbeg, new_s
1791             and ocnt are not used. This call should not be used, use unpackstring instead.
1792              
1793             I32 unpack_str(const char *pat, const char *patend, const char *s, const char *strbeg, const 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
1794             C.
1795              
1796             SV* newSVpvf(const char* pat, ...)','name' => 'newSVpvf'},'Newxc' => {'text' => 'The XSUB-writer\'s interface to the C C function, with
1797             cast. See also C.
1798              
1799             void Newxc(void* ptr, int nitems, type, cast)','name' => 'Newxc'},'sv_newref' => {'text' => 'Increment an SV\'s reference count. Use the C wrapper
1800             instead.
1801              
1802             SV* sv_newref(SV* sv)','name' => 'sv_newref'},'perl_destruct' => {'text' => 'Shuts down a Perl interpreter. See L.
1803              
1804             int perl_destruct(PerlInterpreter *my_perl)','name' => 'perl_destruct'},'XSRETURN_IV' => {'text' => 'Return an integer from an XSUB immediately. Uses C.
1805              
1806             void XSRETURN_IV(IV iv)','name' => 'XSRETURN_IV'},'SvIVX' => {'text' => 'Returns the raw value in the SV\'s IV slot, without checks or conversions.
1807             Only use when you are sure SvIOK is true. See also C.
1808              
1809             IV SvIVX(SV* sv)','name' => 'SvIVX'},'sv_uni_display' => {'text' => 'Build to the scalar dsv a displayable version of the scalar sv,
1810             the displayable version being at most pvlim bytes long
1811             (if longer, the rest is truncated and "..." will be appended).
1812              
1813             The flags argument is as in pv_uni_display().
1814              
1815             The pointer to the PV of the dsv is returned.
1816              
1817             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
1818             appending it. Does not handle \'set\' magic. See C.
1819              
1820             Usually used via its frontend C.
1821              
1822             void sv_vsetpvf(SV* sv, const char* pat, va_list* args)','name' => 'sv_vsetpvf'},'newSVpvs' => {'text' => 'Like C, but takes a literal string instead of a string/length pair.
1823              
1824             SV* newSVpvs(const char* s)','name' => 'newSVpvs'},'SvREFCNT_dec' => {'text' => 'Decrements the reference count of the given SV.
1825              
1826             void SvREFCNT_dec(SV* sv)','name' => 'SvREFCNT_dec'},'XCPT_CATCH' => {'text' => 'Introduces a catch block. See L.','name' => 'XCPT_CATCH'},'XST_mYES' => {'text' => 'Place C<&PL_sv_yes> into the specified position C on the
1827             stack.
1828              
1829             void XST_mYES(int pos)','name' => 'XST_mYES'},'SvIOK_off' => {'text' => 'Unsets the IV status of an SV.
1830              
1831             void SvIOK_off(SV* sv)','name' => 'SvIOK_off'},'sv_setsv' => {'text' => 'Copies the contents of the source SV C into the destination SV
1832             C. The source SV may be destroyed if it is mortal, so don\'t use this
1833             function if the source SV needs to be reused. Does not handle \'set\' magic.
1834             Loosely speaking, it performs a copy-by-value, obliterating any previous
1835             content of the destination.
1836              
1837             You probably want to use one of the assortment of wrappers, such as
1838             C, C, C and
1839             C.
1840              
1841             void sv_setsv(SV *dstr, SV *sstr)','name' => 'sv_setsv'},'POPs' => {'text' => 'Pops an SV off the stack.
1842              
1843             SV* POPs','name' => 'POPs'},'packlist' => {'text' => 'The engine implementing pack() Perl function.
1844              
1845             void packlist(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist)','name' => 'packlist'},'SvNV' => {'text' => 'Coerce the given SV to a double and return it. See C for a version
1846             which guarantees to evaluate sv only once.
1847              
1848             NV SvNV(SV* sv)','name' => 'SvNV'},'gv_fetchmethod_autoload' => {'text' => 'Returns the glob which contains the subroutine to call to invoke the method
1849             on the C. In fact in the presence of autoloading this may be the
1850             glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is
1851             already setup.
1852              
1853             The third parameter of C determines whether
1854             AUTOLOAD lookup is performed if the given method is not present: non-zero
1855             means yes, look for AUTOLOAD; zero means no, don\'t look for AUTOLOAD.
1856             Calling C is equivalent to calling C
1857             with a non-zero C parameter.
1858              
1859             These functions grant C<"SUPER"> token as a prefix of the method name. Note
1860             that if you want to keep the returned glob for a long time, you need to
1861             check for it being "AUTOLOAD", since at the later time the call may load a
1862             different subroutine due to $AUTOLOAD changing its value. Use the glob
1863             created via a side effect to do this.
1864              
1865             These functions have the same side-effects and as C with
1866             C. C should be writable if contains C<\':\'> or C<\'
1867             \'\'>. The warning against passing the GV returned by C to
1868             C apply equally to these functions.
1869              
1870             GV* gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)','name' => 'gv_fetchmethod_autoload'},'SvUTF8' => {'text' => 'Returns a U32 value indicating whether the SV contains UTF-8 encoded data.
1871             Call this after SvPV() in case any call to string overloading updates the
1872             internal flag.
1873              
1874             U32 SvUTF8(SV* sv)','name' => 'SvUTF8'},'SvTAINTED' => {'text' => 'Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
1875             not.
1876              
1877             bool SvTAINTED(SV* sv)','name' => 'SvTAINTED'},'sv_eq' => {'text' => 'Returns a boolean indicating whether the strings in the two SVs are
1878             identical. Is UTF-8 and \'use bytes\' aware, handles get magic, and will
1879             coerce its args to strings if necessary.
1880              
1881             I32 sv_eq(SV* sv1, SV* sv2)','name' => 'sv_eq'},'ix' => {'text' => 'Variable which is setup by C to indicate which of an
1882             XSUB\'s aliases was used to invoke it. See L.
1883              
1884             I32 ix','name' => 'ix'},'cv_undef' => {'text' => 'Clear out all the active components of a CV. This can happen either
1885             by an explicit C, or by the reference count going to zero.
1886             In the former case, we keep the CvOUTSIDE pointer, so that any anonymous
1887             children can still follow the full lexical scope chain.
1888              
1889             void cv_undef(CV* cv)','name' => 'cv_undef'},'StructCopy' => {'text' => 'This is an architecture-independent macro to copy one structure to another.
1890              
1891             void StructCopy(type src, type dest, type)','name' => 'StructCopy'},'XSRETURN_UV' => {'text' => 'Return an integer from an XSUB immediately. Uses C.
1892              
1893             void XSRETURN_UV(IV uv)','name' => 'XSRETURN_UV'},'SvREFCNT_inc_simple' => {'text' => 'Same as SvREFCNT_inc, but can only be used with expressions without side
1894             effects. Since we don\'t have to store a temporary value, it\'s faster.
1895              
1896             SV* SvREFCNT_inc_simple(SV* sv)','name' => 'SvREFCNT_inc_simple'},'get_cvn_flags' => {'text' => 'Returns the CV of the specified Perl subroutine. C are passed to
1897             C. If C is set and the Perl subroutine does not
1898             exist then it will be declared (which has the same effect as saying
1899             C). If C is not set and the subroutine does not exist
1900             then NULL is returned.
1901              
1902             NOTE: the perl_ form of this function is deprecated.
1903              
1904             CV* get_cvn_flags(const char* name, STRLEN len, I32 flags)','name' => 'get_cvn_flags'},'items' => {'text' => 'Variable which is setup by C to indicate the number of
1905             items on the stack. See L.
1906              
1907             I32 items','name' => 'items'},'XST_mPV' => {'text' => 'Place a copy of a string into the specified position C on the stack.
1908             The value is stored in a new mortal SV.
1909              
1910             void XST_mPV(int pos, char* str)','name' => 'XST_mPV'},'vverify' => {'text' => 'Validates that the SV contains a valid version object.
1911              
1912             bool vverify(SV *vobj);
1913              
1914             Note that it only confirms the bare minimum structure (so as not to get
1915             confused by derived classes which may contain additional hash entries):
1916              
1917             bool vverify(SV *vs)','name' => 'vverify'},'dXSI32' => {'text' => 'Sets up the C variable for an XSUB which has aliases. This is usually
1918             handled automatically by C.
1919              
1920             dXSI32;','name' => 'dXSI32'},'SvPVx' => {'text' => 'A version of C which guarantees to evaluate C only once.
1921             Only use this if C is an expression with side effects, otherwise use the
1922             more efficient C.
1923              
1924             char* SvPVx(SV* sv, STRLEN len)','name' => 'SvPVx'},'dXCPT' => {'text' => 'Set up necessary local variables for exception handling.
1925             See L.
1926              
1927             dXCPT;','name' => 'dXCPT'},'sv_tainted' => {'text' => 'Test an SV for taintedness. Use C instead.
1928             bool sv_tainted(SV* sv)','name' => 'sv_tainted'},'sv_grow' => {'text' => 'Expands the character buffer in the SV. If necessary, uses C and
1929             upgrades the SV to C. Returns a pointer to the character buffer.
1930             Use the C wrapper instead.
1931              
1932             char* sv_grow(SV* sv, STRLEN newlen)','name' => 'sv_grow'},'vnormal' => {'text' => 'Accepts a version object and returns the normalized string
1933             representation. Call like:
1934              
1935             sv = vnormal(rv);
1936              
1937             NOTE: you can pass either the object directly or the SV
1938             contained within the RV.
1939              
1940             SV* vnormal(SV *vs)','name' => 'vnormal'},'cv_const_sv' => {'text' => 'If C is a constant sub eligible for inlining. returns the constant
1941             value returned by the sub. Otherwise, returns NULL.
1942              
1943             Constant subs can be created with C or as described in
1944             L.
1945              
1946             SV* cv_const_sv(CV* cv)','name' => 'cv_const_sv'},'newSVnv' => {'text' => 'Creates a new SV and copies a floating point value into it.
1947             The reference count for the SV is set to 1.
1948              
1949             SV* newSVnv(NV n)','name' => 'newSVnv'},'XPUSHs' => {'text' => 'Push an SV onto the stack, extending the stack if necessary. Does not
1950             handle \'set\' magic. Does not use C. See also C,
1951             C and C.
1952              
1953             void XPUSHs(SV* sv)','name' => 'XPUSHs'},'HeVAL' => {'text' => 'Returns the value slot (type C) stored in the hash entry.
1954              
1955             SV* HeVAL(HE* he)','name' => 'HeVAL'},'HePV' => {'text' => 'Returns the key slot of the hash entry as a C value, doing any
1956             necessary dereferencing of possibly C keys. The length of the string
1957             is placed in C (this is a macro, so do I use C<&len>). If you do
1958             not care about what the length of the key is, you may use the global
1959             variable C, though this is rather less efficient than using a local
1960             variable. Remember though, that hash keys in perl are free to contain
1961             embedded nulls, so using C or similar is not a good way to find
1962             the length of hash keys. This is very similar to the C macro
1963             described elsewhere in this document. See also C.
1964              
1965             If you are using C to get values to pass to C to create a
1966             new SV, you should consider using C as it is more
1967             efficient.
1968              
1969             char* HePV(HE* he, STRLEN len)','name' => 'HePV'},'pv_uni_display' => {'text' => 'Build to the scalar dsv a displayable version of the string spv,
1970             length len, the displayable version being at most pvlim bytes long
1971             (if longer, the rest is truncated and "..." will be appended).
1972              
1973             The flags argument can have UNI_DISPLAY_ISPRINT set to display
1974             isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
1975             to display the \\\\[nrfta\\\\] as the backslashed versions (like \'\\n\')
1976             (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\\\).
1977             UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
1978             UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
1979              
1980             The pointer to the PV of the dsv is returned.
1981              
1982             char* pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)','name' => 'pv_uni_display'},'SvGETMAGIC' => {'text' => 'Invokes C on an SV if it has \'get\' magic. This macro evaluates its
1983             argument more than once.
1984              
1985             void SvGETMAGIC(SV* sv)','name' => 'SvGETMAGIC'},'sv_inc' => {'text' => 'Auto-increment of the value in the SV, doing string to numeric conversion
1986             if necessary. Handles \'get\' magic.
1987              
1988             void sv_inc(SV* sv)','name' => 'sv_inc'},'sv_usepvn' => {'text' => 'Tells an SV to use C to find its string value. Implemented by
1989             calling C with C of 0, hence does not handle \'set\'
1990             magic. See C.
1991              
1992             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.
1993             Guarantees to evaluate sv only once; use the more efficient C
1994             otherwise.
1995              
1996             char* SvPVbytex_force(SV* sv, STRLEN len)','name' => 'SvPVbytex_force'},'SvREFCNT' => {'text' => 'Returns the value of the object\'s reference count.
1997              
1998             U32 SvREFCNT(SV* sv)','name' => 'SvREFCNT'},'warn' => {'text' => 'This is the XSUB-writer\'s interface to Perl\'s C function. Call this
1999             function the same way you call the C C function. See C.
2000              
2001             void warn(const char* pat, ...)','name' => 'warn'},'hv_delete' => {'text' => 'Deletes a key/value pair in the hash. The value SV is removed from the
2002             hash and returned to the caller. The C is the length of the key.
2003             The C value will normally be zero; if set to G_DISCARD then NULL
2004             will be returned.
2005              
2006             SV* hv_delete(HV *hv, const char *key, I32 klen, I32 flags)','name' => 'hv_delete'},'sv_cat_decode' => {'text' => 'The encoding is assumed to be an Encode object, the PV of the ssv is
2007             assumed to be octets in that encoding and decoding the input starts
2008             from the position which (PV + *offset) pointed to. The dsv will be
2009             concatenated the decoded UTF-8 string from ssv. Decoding will terminate
2010             when the string tstr appears in decoding output or the input ends on
2011             the PV of the ssv. The value which the offset points will be modified
2012             to the last input position on the ssv.
2013              
2014             Returns TRUE if the terminator was found, else returns FALSE.
2015              
2016             bool sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)','name' => 'sv_cat_decode'},'POP_MULTICALL' => {'text' => 'Closing bracket for a lightweight callback.
2017             See L.
2018              
2019             POP_MULTICALL;','name' => 'POP_MULTICALL'},'SvIV_set' => {'text' => 'Set the value of the IV pointer in sv to val. It is possible to perform
2020             the same function of this macro with an lvalue assignment to C.
2021             With future Perls, however, it will be more efficient to use
2022             C instead of the lvalue assignment to C.
2023              
2024             void SvIV_set(SV* sv, IV val)','name' => 'SvIV_set'},'sv_setiv' => {'text' => 'Copies an integer into the given SV, upgrading first if necessary.
2025             Does not handle \'set\' magic. See also C.
2026              
2027             void sv_setiv(SV* sv, IV num)','name' => 'sv_setiv'},'sv_report_used' => {'text' => 'Dump the contents of all SVs not yet freed. (Debugging aid).
2028              
2029             void sv_report_used()','name' => 'sv_report_used'},'EXTEND' => {'text' => 'Used to extend the argument stack for an XSUB\'s return values. Once
2030             used, guarantees that there is room for at least C to be pushed
2031             onto the stack.
2032              
2033             void EXTEND(SP, int nitems)','name' => 'EXTEND'},'SvNVX' => {'text' => 'Returns the raw value in the SV\'s NV slot, without checks or conversions.
2034             Only use when you are sure SvNOK is true. See also C.
2035              
2036             NV SvNVX(SV* sv)','name' => 'SvNVX'},'newSVuv' => {'text' => 'Creates a new SV and copies an unsigned integer into it.
2037             The reference count for the SV is set to 1.
2038              
2039             SV* newSVuv(UV u)','name' => 'newSVuv'},'gv_fetchmeth' => {'text' => 'Returns the glob with the given C and a defined subroutine or
2040             C. The glob lives in the given C, or in the stashes
2041             accessible via @ISA and UNIVERSAL::.
2042              
2043             The argument C should be either 0 or -1. If C, as a
2044             side-effect creates a glob with the given C in the given C
2045             which in the case of success contains an alias for the subroutine, and sets
2046             up caching info for this glob.
2047              
2048             This function grants C<"SUPER"> token as a postfix of the stash name. The
2049             GV returned from C may be a method cache entry, which is not
2050             visible to Perl code. So when calling C, you should not use
2051             the GV directly; instead, you should use the method\'s CV, which can be
2052             obtained from the GV with the C macro.
2053              
2054             GV* gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)','name' => 'gv_fetchmeth'},'HeHASH' => {'text' => 'Returns the computed hash stored in the hash entry.
2055              
2056             U32 HeHASH(HE* he)','name' => 'HeHASH'},'SvIOK' => {'text' => 'Returns a U32 value indicating whether the SV contains an integer.
2057              
2058             U32 SvIOK(SV* sv)','name' => 'SvIOK'},'sv_does' => {'text' => 'Returns a boolean indicating whether the SV performs a specific, named role.
2059             The SV can be a Perl object or the name of a Perl class.
2060              
2061             bool sv_does(SV* sv, const char* name)','name' => 'sv_does'},'SvPV_force' => {'text' => 'Like C but will force the SV into containing just a string
2062             (C). You want force if you are going to update the C
2063             directly.
2064              
2065             char* SvPV_force(SV* sv, STRLEN len)','name' => 'SvPV_force'},'HeUTF8' => {'text' => 'Returns whether the C value returned by C is encoded in UTF-8,
2066             doing any necessary dereferencing of possibly C keys. The value returned
2067             will be 0 or non-0, not necessarily 1 (or even a value with any low bits set),
2068             so B blindly assign this to a C variable, as C may be a
2069             typedef for C.
2070              
2071             char* HeUTF8(HE* he, STRLEN len)','name' => 'HeUTF8'},'SvLEN' => {'text' => 'Returns the size of the string buffer in the SV, not including any part
2072             attributable to C. See C.
2073              
2074             STRLEN SvLEN(SV* sv)','name' => 'SvLEN'},'SvPOK_only_UTF8' => {'text' => 'Tells an SV that it is a string and disables all other OK bits,
2075             and leaves the UTF-8 status as it was.
2076              
2077             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.
2078              
2079             int mg_get(SV* sv)','name' => 'mg_get'},'SvTRUE' => {'text' => 'Returns a boolean indicating whether Perl would evaluate the SV as true or
2080             false. See SvOK() for a defined/undefined test. Does not handle \'get\' magic.
2081              
2082             bool SvTRUE(SV* sv)','name' => 'SvTRUE'},'grok_hex' => {'text' => 'converts a string representing a hex number to numeric form.
2083              
2084             On entry I and I<*len> give the string to scan, I<*flags> gives
2085             conversion flags, and I should be NULL or a pointer to an NV.
2086             The scan stops at the end of the string, or the first invalid character.
2087             Unless C is set in I<*flags>, encountering an
2088             invalid character will also trigger a warning.
2089             On return I<*len> is set to the length of the scanned string,
2090             and I<*flags> gives output flags.
2091              
2092             If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2093             and nothing is written to I<*result>. If the value is > UV_MAX C
2094             returns UV_MAX, sets C in the output flags,
2095             and writes the value to I<*result> (or the value is discarded if I
2096             is NULL).
2097              
2098             The hex number may optionally be prefixed with "0x" or "x" unless
2099             C is set in I<*flags> on entry. If
2100             C is set in I<*flags> then the hex
2101             number may use \'_\' characters to separate digits.
2102              
2103             UV grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)','name' => 'grok_hex'},'hv_iternext_flags' => {'text' => 'Returns entries from a hash iterator. See C and C.
2104             The C value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
2105             set the placeholders keys (for restricted hashes) will be returned in addition
2106             to normal keys. By default placeholders are automatically skipped over.
2107             Currently a placeholder is implemented with a value that is
2108             C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
2109             restricted hashes may change, and the implementation currently is
2110             insufficiently abstracted for any change to be tidy.
2111              
2112             NOTE: this function is experimental and may change or be
2113             removed without notice.
2114              
2115             HE* hv_iternext_flags(HV *hv, I32 flags)','name' => 'hv_iternext_flags'},'is_utf8_string_loclen' => {'text' => 'Like is_utf8_string() but stores the location of the failure (in the
2116             case of "utf8ness failure") or the location s+len (in the case of
2117             "utf8ness success") in the C, and the number of UTF-8
2118             encoded characters in the C.
2119              
2120             See also is_utf8_string_loc() and is_utf8_string().
2121              
2122             bool is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)','name' => 'is_utf8_string_loclen'},'call_method' => {'text' => 'Performs a callback to the specified Perl method. The blessed object must
2123             be on the stack. See L.
2124              
2125             NOTE: the perl_ form of this function is deprecated.
2126              
2127             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
2128             has been loaded.
2129              
2130             void SvLOCK(SV* sv)','name' => 'SvLOCK'},'sv_vsetpvfn' => {'text' => 'Works like C but copies the text into the SV instead of
2131             appending it.
2132              
2133             Usually used via one of its frontends C and C.
2134              
2135             void sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)','name' => 'sv_vsetpvfn'},'perl_parse' => {'text' => 'Tells a Perl interpreter to parse a Perl script. See L.
2136              
2137             int perl_parse(PerlInterpreter *my_perl, 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
2138             the character that is being converted.
2139              
2140             The "ustrp" is a pointer to the character buffer to put the
2141             conversion result to. The "lenp" is a pointer to the length
2142             of the result.
2143              
2144             The "swashp" is a pointer to the swash to use.
2145              
2146             Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
2147             and loaded by SWASHNEW, using lib/utf8_heavy.pl. The special (usually,
2148             but not always, a multicharacter mapping), is tried first.
2149              
2150             The "special" is a string like "utf8::ToSpecLower", which means the
2151             hash %utf8::ToSpecLower. The access to the hash is through
2152             Perl_to_utf8_case().
2153              
2154             The "normal" is a string like "ToLower" which means the swash
2155             %utf8::ToLower.
2156              
2157             UV to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, const char *normal, const char *special)','name' => 'to_utf8_case'},'av_clear' => {'text' => 'Clears an array, making it empty. Does not free the memory used by the
2158             array itself.
2159              
2160             void av_clear(AV *av)','name' => 'av_clear'},'sv_force_normal' => {'text' => 'Undo various types of fakery on an SV: if the PV is a shared string, make
2161             a private copy; if we\'re a ref, stop refing; if we\'re a glob, downgrade to
2162             an xpvmg. See also C.
2163              
2164             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
2165             array. The array will grow automatically to accommodate the addition. You
2166             must then use C to assign values to these new elements.
2167              
2168             void av_unshift(AV *av, I32 num)','name' => 'av_unshift'},'SvREFCNT_inc_NN' => {'text' => 'Same as SvREFCNT_inc, but can only be used if you know I
2169             is not NULL. Since we don\'t have to check the NULLness, it\'s faster
2170             and smaller.
2171              
2172             SV* SvREFCNT_inc_NN(SV* sv)','name' => 'SvREFCNT_inc_NN'},'POPpbytex' => {'text' => 'Pops a string off the stack which must consist of bytes i.e. characters < 256.
2173              
2174             char* POPpbytex','name' => 'POPpbytex'},'SvUVX' => {'text' => 'Returns the raw value in the SV\'s UV slot, without checks or conversions.
2175             Only use when you are sure SvIOK is true. See also C.
2176              
2177             UV SvUVX(SV* sv)','name' => 'SvUVX'},'SvSetMagicSV' => {'text' => 'Like C, but does any set magic required afterwards.
2178              
2179             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
2180             and contains a multiple-byte character, the C flag is turned on
2181             so that it looks like a character. If the PV contains only single-byte
2182             characters, the C flag stays being off.
2183             Scans PV for validity and returns false if the PV is invalid UTF-8.
2184              
2185             NOTE: this function is experimental and may change or be
2186             removed without notice.
2187              
2188             bool sv_utf8_decode(SV *sv)','name' => 'sv_utf8_decode'},'hv_stores' => {'text' => 'Like C, but takes a literal string instead of a string/length pair
2189             and omits the hash parameter.
2190              
2191             SV** hv_stores(HV* tb, const char* key, NULLOK SV* val)','name' => 'hv_stores'},'eval_sv' => {'text' => 'Tells Perl to C the string in the SV.
2192              
2193             NOTE: the perl_ form of this function is deprecated.
2194              
2195             I32 eval_sv(SV* sv, I32 flags)','name' => 'eval_sv'},'FREETMPS' => {'text' => 'Closing bracket for temporaries on a callback. See C and
2196             L.
2197              
2198             FREETMPS;','name' => 'FREETMPS'},'sv_utf8_upgrade_nomg' => {'text' => 'Like sv_utf8_upgrade, but doesn\'t do magic on C
2199              
2200             STRLEN sv_utf8_upgrade_nomg(SV *sv)','name' => 'sv_utf8_upgrade_nomg'},'Move' => {'text' => 'The XSUB-writer\'s interface to the C C function. The C is the
2201             source, C is the destination, C is the number of items, and C is
2202             the type. Can do overlapping moves. See also C.
2203              
2204             void Move(void* src, void* dest, int nitems, type)','name' => 'Move'},'sv_catpvn_flags' => {'text' => 'Concatenates the string onto the end of the string which is in the SV. The
2205             C indicates number of bytes to copy. If the SV has the UTF-8
2206             status set, then the bytes appended should be valid UTF-8.
2207             If C has C bit set, will C on C if
2208             appropriate, else not. C and C are implemented
2209             in terms of this function.
2210              
2211             void sv_catpvn_flags(SV *dstr, const char *sstr, STRLEN len, I32 flags)','name' => 'sv_catpvn_flags'},'sv_pvn_force' => {'text' => 'Get a sensible string out of the SV somehow.
2212             A private implementation of the C macro for compilers which
2213             can\'t cope with complex macro expressions. Always use the macro instead.
2214              
2215             char* sv_pvn_force(SV* sv, STRLEN* lp)','name' => 'sv_pvn_force'},'GIMME' => {'text' => 'A backward-compatible version of C which can only return
2216             C or C; in a void context, it returns C.
2217             Deprecated. Use C instead.
2218              
2219             U32 GIMME','name' => 'GIMME'},'sv_2iv_flags' => {'text' => 'Return the integer value of an SV, doing any necessary string
2220             conversion. If flags includes SV_GMAGIC, does an mg_get() first.
2221             Normally used via the C and C macros.
2222              
2223             IV sv_2iv_flags(SV* sv, I32 flags)','name' => 'sv_2iv_flags'},'newXS' => {'text' => 'Used by C to hook up XSUBs as Perl subs. I needs to be
2224             static storage, as it is used directly as CvFILE(), without a copy being made.','name' => 'newXS'},'isALNUM' => {'text' => 'Returns a boolean indicating whether the C C is a US-ASCII (Basic Latin)
2225             alphanumeric character (including underscore) or digit.
2226              
2227             bool isALNUM(char ch)','name' => 'isALNUM'},'XCPT_RETHROW' => {'text' => 'Rethrows a previously caught exception. See L.
2228              
2229             XCPT_RETHROW;','name' => 'XCPT_RETHROW'},'my_snprintf' => {'text' => 'The C library C functionality, if available and
2230             standards-compliant (uses C, actually). However, if the
2231             C is not available, will unfortunately use the unsafe
2232             C which can overrun the buffer (there is an overrun check,
2233             but that may be too late). Consider using C instead, or
2234             getting C.
2235              
2236             int my_snprintf(char *buffer, const Size_t len, const char *format, ...)','name' => 'my_snprintf'},'SvIOK_UV' => {'text' => 'Returns a boolean indicating whether the SV contains an unsigned integer.
2237              
2238             bool SvIOK_UV(SV* sv)','name' => 'SvIOK_UV'},'PUSHmortal' => {'text' => 'Push a new mortal SV onto the stack. The stack must have room for this
2239             element. Does not use C. See also C, C and C.
2240              
2241             void PUSHmortal()','name' => 'PUSHmortal'},'perl_alloc' => {'text' => 'Allocates a new Perl interpreter. See L.
2242              
2243             PerlInterpreter* perl_alloc()','name' => 'perl_alloc'},'perl_construct' => {'text' => 'Initializes a new Perl interpreter. See L.
2244              
2245             void perl_construct(PerlInterpreter *my_perl)','name' => 'perl_construct'},'SvUOK' => {'text' => 'Returns a boolean indicating whether the SV contains an unsigned integer.
2246              
2247             bool SvUOK(SV* sv)','name' => 'SvUOK'},'sv_dec' => {'text' => 'Auto-decrement of the value in the SV, doing string to numeric conversion
2248             if necessary. Handles \'get\' magic.
2249              
2250             void sv_dec(SV* sv)','name' => 'sv_dec'},'strLE' => {'text' => 'Test two strings to see if the first, C, is less than or equal to the
2251             second, C. Returns true or false.
2252              
2253             bool strLE(char* s1, char* s2)','name' => 'strLE'},'pv_display' => {'text' => 'Similar to
2254              
2255             pv_escape(dsv,pv,cur,pvlim,PERL_PV_ESCAPE_QUOTE);
2256              
2257             except that an additional "\\0" will be appended to the string when
2258             len > cur and pv[cur] is "\\0".
2259              
2260             Note that the final string may be up to 7 chars longer than pvlim.
2261              
2262             char* pv_display(SV *dsv, const char *pv, STRLEN cur, STRLEN len, STRLEN pvlim)','name' => 'pv_display'},'newSVpvn_flags' => {'text' => 'Creates a new SV and copies a string into it. The reference count for the
2263             SV is set to 1. Note that if C is zero, Perl will create a zero length
2264             string. You are responsible for ensuring that the source string is at least
2265             C bytes long. If the C argument is NULL the new SV will be undefined.
2266             Currently the only flag bits accepted are C and C.
2267             If C is set, then C is called on the result before
2268             returning. If C is set, then it will be set on the new SV.
2269             C is a convenience wrapper for this function, defined as
2270              
2271             #define newSVpvn_utf8(s, len, u) \\
2272             newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
2273              
2274             SV* newSVpvn_flags(const char* s, STRLEN len, U32 flags)','name' => 'newSVpvn_flags'},'sv_2pvbyte_nolen' => {'text' => 'Return a pointer to the byte-encoded representation of the SV.
2275             May cause the SV to be downgraded from UTF-8 as a side-effect.
2276              
2277             Usually accessed via the C macro.
2278              
2279             char* sv_2pvbyte_nolen(SV* sv)','name' => 'sv_2pvbyte_nolen'},'SvOK' => {'text' => 'Returns a U32 value indicating whether the value is defined. This is
2280             only meaningful for scalars.
2281              
2282             U32 SvOK(SV* sv)','name' => 'SvOK'},'sv_setref_nv' => {'text' => 'Copies a double into a new SV, optionally blessing the SV. The C
2283             argument will be upgraded to an RV. That RV will be modified to point to
2284             the new SV. The C argument indicates the package for the
2285             blessing. Set C to C to avoid the blessing. The new SV
2286             will have a reference count of 1, and the RV will be returned.
2287              
2288             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
2289             of the string C; C should be have at least C free
2290             bytes available. The return value is the pointer to the byte after the
2291             end of the new character. In other words,
2292              
2293             d = uvchr_to_utf8(d, uv);
2294              
2295             is the recommended wide native character-aware way of saying
2296              
2297             *(d++) = uv;
2298              
2299             U8* uvchr_to_utf8(U8 *d, UV uv)','name' => 'uvchr_to_utf8'},'isDIGIT' => {'text' => 'Returns a boolean indicating whether the C C is a US-ASCII (Basic Latin)
2300             digit.
2301              
2302             bool isDIGIT(char ch)','name' => 'isDIGIT'},'eval_pv' => {'text' => 'Tells Perl to C the given string and return an SV* result.
2303              
2304             NOTE: the perl_ form of this function is deprecated.
2305              
2306             SV* eval_pv(const char* p, I32 croak_on_error)','name' => 'eval_pv'},'sv_usepvn_flags' => {'text' => 'Tells an SV to use C to find its string value. Normally the
2307             string is stored inside the SV but sv_usepvn allows the SV to use an
2308             outside string. The C should point to memory that was allocated
2309             by C. The string length, C, must be supplied. By default
2310             this function will realloc (i.e. move) the memory pointed to by C,
2311             so that pointer should not be freed or used by the programmer after
2312             giving it to sv_usepvn, and neither should any pointers from "behind"
2313             that pointer (e.g. ptr + 1) be used.
2314              
2315             If C & SV_SMAGIC is true, will call SvSETMAGIC. If C &
2316             SV_HAS_TRAILING_NUL is true, then C must be NUL, and the realloc
2317             will be skipped. (i.e. the buffer is actually at least 1 byte longer than
2318             C, and already meets the requirements for storing in C)
2319              
2320             void sv_usepvn_flags(SV* sv, char* ptr, STRLEN len, U32 flags)','name' => 'sv_usepvn_flags'},'hv_assert' => {'text' => 'Check that a hash is in an internally consistent state.
2321              
2322             void hv_assert(HV *hv)','name' => 'hv_assert'},'my_vsnprintf' => {'text' => 'The C library C if available and standards-compliant.
2323             However, if if the C is not available, will unfortunately
2324             use the unsafe C which can overrun the buffer (there is an
2325             overrun check, but that may be too late). Consider using
2326             C instead, or getting C.
2327              
2328             int my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)','name' => 'my_vsnprintf'},'sv_free' => {'text' => 'Decrement an SV\'s reference count, and if it drops to zero, call
2329             C to invoke destructors and free up any memory used by
2330             the body; finally, deallocate the SV\'s head itself.
2331             Normally called via a wrapper macro C.
2332              
2333             void sv_free(SV* sv)','name' => 'sv_free'},'SvPVbyte_force' => {'text' => 'Like C, but converts sv to byte representation first if necessary.
2334              
2335             char* SvPVbyte_force(SV* sv, STRLEN len)','name' => 'SvPVbyte_force'},'newCONSTSUB' => {'text' => 'Creates a constant sub equivalent to Perl C which is
2336             eligible for inlining at compile-time.
2337              
2338             CV* newCONSTSUB(HV* stash, const char* name, SV* sv)','name' => 'newCONSTSUB'},'SvSHARE' => {'text' => 'Arranges for sv to be shared between threads if a suitable module
2339             has been loaded.
2340              
2341             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
2342             is empty.
2343              
2344             SV* av_pop(AV *av)','name' => 'av_pop'},'croak' => {'text' => 'This is the XSUB-writer\'s interface to Perl\'s C function.
2345             Normally call this function the same way you call the C C
2346             function. Calling C returns control directly to Perl,
2347             sidestepping the normal C order of execution. See C.
2348              
2349             If you want to throw an exception object, assign the object to
2350             C<$@> and then pass C to croak():
2351              
2352             errsv = get_sv("@", GV_ADD);
2353             sv_setsv(errsv, exception_object);
2354             croak(NULL);
2355              
2356             void croak(const char* pat, ...)','name' => 'croak'},'sortsv' => {'text' => 'Sort an array. Here is an example:
2357              
2358             sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale);
2359              
2360             Currently this always uses mergesort. See sortsv_flags for a more
2361             flexible routine.
2362              
2363             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++
2364             XSUB. This is always the proper type for the C++ object. See C and
2365             L.
2366              
2367             (whatever) THIS','name' => 'THIS'},'XSRETURN' => {'text' => 'Return from XSUB, indicating number of items on the stack. This is usually
2368             handled by C.
2369              
2370             void XSRETURN(int nitems)','name' => 'XSRETURN'},'scan_bin' => {'text' => 'For backwards compatibility. Use C instead.
2371              
2372             NV scan_bin(const char* start, STRLEN len, STRLEN* retlen)','name' => 'scan_bin'},'Nullcv' => {'text' => 'Null CV pointer.','name' => 'Nullcv'},'get_av' => {'text' => 'Returns the AV of the specified Perl array. C are passed to
2373             C. If C is set and the
2374             Perl variable does not exist then it will be created. If C is zero
2375             and the variable does not exist then NULL is returned.
2376              
2377             NOTE: the perl_ form of this function is deprecated.
2378              
2379             AV* get_av(const char *name, I32 flags)','name' => 'get_av'},'sv_2pv_nolen' => {'text' => 'Like C, but doesn\'t return the length too. You should usually
2380             use the macro wrapper C instead.
2381             char* sv_2pv_nolen(SV* sv)','name' => 'sv_2pv_nolen'},'MULTICALL' => {'text' => 'Make a lightweight callback. See L.
2382              
2383             MULTICALL;','name' => 'MULTICALL'},'SvPVbyte' => {'text' => 'Like C, but converts sv to byte representation first if necessary.
2384              
2385             char* SvPVbyte(SV* sv, STRLEN len)','name' => 'SvPVbyte'},'PoisonFree' => {'text' => 'PoisonWith(0xEF) for catching access to freed memory.
2386              
2387             void PoisonFree(void* dest, int nitems, type)','name' => 'PoisonFree'},'toUPPER' => {'text' => 'Converts the specified character to uppercase. Characters outside the
2388             US-ASCII (Basic Latin) range are viewed as not having any case.
2389              
2390             char toUPPER(char ch)','name' => 'toUPPER'},'is_utf8_string_loc' => {'text' => 'Like is_utf8_string() but stores the location of the failure (in the
2391             case of "utf8ness failure") or the location s+len (in the case of
2392             "utf8ness success") in the C.
2393              
2394             See also is_utf8_string_loclen() and is_utf8_string().
2395              
2396             bool is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)','name' => 'is_utf8_string_loc'},'SAVETMPS' => {'text' => 'Opening bracket for temporaries on a callback. See C and
2397             L.
2398              
2399             SAVETMPS;','name' => 'SAVETMPS'},'AvFILL' => {'text' => 'Same as C. Deprecated, use C instead.
2400              
2401             int AvFILL(AV* av)','name' => 'AvFILL'},'sv_gets' => {'text' => 'Get a line from the filehandle and store it into the SV, optionally
2402             appending to the currently-stored string.
2403              
2404             char* sv_gets(SV* sv, PerlIO* fp, I32 append)','name' => 'sv_gets'},'ORIGMARK' => {'text' => 'The original stack mark for the XSUB. See C.','name' => 'ORIGMARK'},'SvPVutf8x' => {'text' => 'Like C, but converts sv to utf8 first if necessary.
2405             Guarantees to evaluate sv only once; use the more efficient C
2406             otherwise.
2407              
2408             char* SvPVutf8x(SV* sv, STRLEN len)','name' => 'SvPVutf8x'},'sv_2cv' => {'text' => 'Using various gambits, try to get a CV from an SV; in addition, try if
2409             possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
2410             The flags in C are passed to sv_fetchsv.
2411              
2412             CV* sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)','name' => 'sv_2cv'},'SvPV_force_nomg' => {'text' => 'Like C but will force the SV into containing just a string
2413             (C). You want force if you are going to update the C
2414             directly. Doesn\'t process magic.
2415              
2416             char* SvPV_force_nomg(SV* sv, STRLEN len)','name' => 'SvPV_force_nomg'},'SvSetSV_nosteal' => {'text' => 'Calls a non-destructive version of C if dsv is not the same as
2417             ssv. May evaluate arguments more than once.
2418              
2419             void SvSetSV_nosteal(SV* dsv, SV* ssv)','name' => 'SvSetSV_nosteal'},'SvPOK_only' => {'text' => 'Tells an SV that it is a string and disables all other OK bits.
2420             Will also turn off the UTF-8 status.
2421              
2422             void SvPOK_only(SV* sv)','name' => 'SvPOK_only'},'dUNDERBAR' => {'text' => 'Sets up the C variable for an XSUB that wishes to use
2423             C.
2424              
2425             dUNDERBAR;','name' => 'dUNDERBAR'},'sv_usepvn_mg' => {'text' => 'Like C, but also handles \'set\' magic.
2426              
2427             void sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)','name' => 'sv_usepvn_mg'},'XCPT_TRY_START' => {'text' => 'Starts a try block. See L.','name' => 'XCPT_TRY_START'},'sv_pvbyte' => {'text' => 'Use C instead.
2428              
2429             char* sv_pvbyte(SV *sv)','name' => 'sv_pvbyte'},'sv_uv' => {'text' => 'A private implementation of the C macro for compilers which can\'t
2430             cope with complex macro expressions. Always use the macro instead.
2431              
2432             UV sv_uv(SV* sv)','name' => 'sv_uv'},'hv_fetch' => {'text' => 'Returns the SV which corresponds to the specified key in the hash. The
2433             C is the length of the key. If C is set then the fetch will be
2434             part of a store. Check that the return value is non-null before
2435             dereferencing it to an C.
2436              
2437             See L for more
2438             information on how to use this function on tied hashes.
2439              
2440             SV** hv_fetch(HV *hv, const char *key, I32 klen, I32 lval)','name' => 'hv_fetch'},'sv_unref_flags' => {'text' => 'Unsets the RV status of the SV, and decrements the reference count of
2441             whatever was being referenced by the RV. This can almost be thought of
2442             as a reversal of C. The C argument can contain
2443             C to force the reference count to be decremented
2444             (otherwise the decrementing is conditional on the reference count being
2445             different from one or the reference being a readonly SV).
2446             See C.
2447              
2448             void sv_unref_flags(SV *ref, U32 flags)','name' => 'sv_unref_flags'},'hv_scalar' => {'text' => 'Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
2449              
2450             SV* hv_scalar(HV *hv)','name' => 'hv_scalar'},'SvRV' => {'text' => 'Dereferences an RV to return the SV.
2451              
2452             SV* SvRV(SV* sv)','name' => 'SvRV'},'Nullch' => {'text' => 'Null character pointer.','name' => 'Nullch'},'mg_copy' => {'text' => 'Copies the magic from one SV to another. See C.
2453              
2454             int mg_copy(SV *sv, SV *nsv, const char *key, I32 klen)','name' => 'mg_copy'},'MARK' => {'text' => 'Stack marker variable for the XSUB. See C.','name' => 'MARK'},'grok_oct' => {'text' => 'converts a string representing an octal number to numeric form.
2455              
2456             On entry I and I<*len> give the string to scan, I<*flags> gives
2457             conversion flags, and I should be NULL or a pointer to an NV.
2458             The scan stops at the end of the string, or the first invalid character.
2459             Unless C is set in I<*flags>, encountering an
2460             invalid character will also trigger a warning.
2461             On return I<*len> is set to the length of the scanned string,
2462             and I<*flags> gives output flags.
2463              
2464             If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2465             and nothing is written to I<*result>. If the value is > UV_MAX C
2466             returns UV_MAX, sets C in the output flags,
2467             and writes the value to I<*result> (or the value is discarded if I
2468             is NULL).
2469              
2470             If C is set in I<*flags> then the octal
2471             number may use \'_\' characters to separate digits.
2472              
2473             UV grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)','name' => 'grok_oct'},'sv_rvweaken' => {'text' => 'Weaken a reference: set the C flag on this RV; give the
2474             referred-to SV C magic if it hasn\'t already; and
2475             push a back-reference to this RV onto the array of backreferences
2476             associated with that magic. If the RV is magical, set magic will be
2477             called after the RV is cleared.
2478              
2479             SV* sv_rvweaken(SV *sv)','name' => 'sv_rvweaken'},'scan_hex' => {'text' => 'For backwards compatibility. Use C instead.
2480              
2481             NV scan_hex(const 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
2482             SV is set to 1. Note that if C is zero, Perl will create a zero length
2483             string. You are responsible for ensuring that the source string is at least
2484             C bytes long. If the C argument is NULL the new SV will be undefined.
2485              
2486             SV* newSVpvn(const char* s, STRLEN len)','name' => 'newSVpvn'},'sv_magicext' => {'text' => 'Adds magic to an SV, upgrading it if necessary. Applies the
2487             supplied vtable and returns a pointer to the magic added.
2488              
2489             Note that C will allow things that C will not.
2490             In particular, you can add magic to SvREADONLY SVs, and add more than
2491             one instance of the same \'how\'.
2492              
2493             If C is greater than zero then a C I of C is
2494             stored, if C is zero then C is stored as-is and - as another
2495             special case - if C<(name && namlen == HEf_SVKEY)> then C is assumed
2496             to contain an C and is stored as-is with its REFCNT incremented.
2497              
2498             (This is now used as a subroutine by C.)
2499              
2500             MAGIC * sv_magicext(SV* sv, SV* obj, int how, const MGVTBL *vtbl, const char* name, I32 namlen)','name' => 'sv_magicext'},'av_push' => {'text' => 'Pushes an SV onto the end of the array. The array will grow automatically
2501             to accommodate the addition. Like C, this takes ownership of one
2502             reference count.
2503              
2504             void av_push(AV *av, SV *val)','name' => 'av_push'},'unpackstring' => {'text' => 'The engine implementing unpack() Perl function. C puts the
2505             extracted list items on the stack and returns the number of elements.
2506             Issue C before and C after the call to this function.
2507              
2508             I32 unpackstring(const char *pat, const char *patend, const char *s, const char *strend, U32 flags)','name' => 'unpackstring'},'POPn' => {'text' => 'Pops a double off the stack.
2509              
2510             NV POPn','name' => 'POPn'},'XSRETURN_NO' => {'text' => 'Return C<&PL_sv_no> from an XSUB immediately. Uses C.
2511              
2512             XSRETURN_NO;','name' => 'XSRETURN_NO'},'av_extend' => {'text' => 'Pre-extend an array. The C is the index to which the array should be
2513             extended.
2514              
2515             void av_extend(AV *av, I32 key)','name' => 'av_extend'},'newRV_noinc' => {'text' => 'Creates an RV wrapper for an SV. The reference count for the original
2516             SV is B incremented.
2517              
2518             SV* newRV_noinc(SV* sv)','name' => 'newRV_noinc'},'hv_iternext' => {'text' => 'Returns entries from a hash iterator. See C.
2519              
2520             You may call C or C on the hash entry that the
2521             iterator currently points to, without losing your place or invalidating your
2522             iterator. Note that in this case the current entry is deleted from the hash
2523             with your iterator holding the last reference to it. Your iterator is flagged
2524             to free the entry on the next call to C, so you must not discard
2525             your iterator immediately else the entry will leak - call C to
2526             trigger the resource deallocation.
2527              
2528             HE* hv_iternext(HV *hv)','name' => 'hv_iternext'},'hv_iterinit' => {'text' => 'Prepares a starting point to traverse a hash table. Returns the number of
2529             keys in the hash (i.e. the same as C). The return value is
2530             currently only meaningful for hashes without tie magic.
2531              
2532             NOTE: Before version 5.004_65, C used to return the number of
2533             hash buckets that happen to be in use. If you still need that esoteric
2534             value, you can get it through the macro C.
2535              
2536              
2537             I32 hv_iterinit(HV *hv)','name' => 'hv_iterinit'}};};
2538              
2539 1         16 my $self = bless({
2540             'index' => $VAR1,
2541             perl_version => '5.010001',
2542             } => $class);
2543 1         220 return $self;
2544             }
2545              
2546             1;