This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Add a new flag character 'm' to embed.pl set to represent
[perl5.git] / pod / perlapi.pod
1 =head1 NAME
2
3 perlapi - autogenerated documentation for the perl public API
4
5 =head1 DESCRIPTION
6
7 This file contains the documentation of the perl public API generated by
8 embed.pl, specifically a listing of functions, macros, flags, and variables
9 that may be used by extension writers.  The interfaces of any functions that
10 are not listed here are subject to change without notice.  For this reason,
11 blindly using functions listed in proto.h is to be avoided when writing
12 extensions.
13
14 Note that all Perl API global variables must be referenced with the C<PL_>
15 prefix.  Some macros are provided for compatibility with the older,
16 unadorned names, but this support may be disabled in a future release.
17
18 The listing is alphabetical, case insensitive.
19
20 =over 8
21
22 =item AvFILL
23
24 Same as C<av_len()>.  Deprecated, use C<av_len()> instead.
25
26         int     AvFILL(AV* av)
27
28 =for hackers
29 Found in file av.h
30
31 =item av_clear
32
33 Clears an array, making it empty.  Does not free the memory used by the
34 array itself.
35
36         void    av_clear(AV* ar)
37
38 =for hackers
39 Found in file av.c
40
41 =item av_delete
42
43 Deletes the element indexed by C<key> from the array.  Returns the
44 deleted element. C<flags> is currently ignored.
45
46         SV*     av_delete(AV* ar, I32 key, I32 flags)
47
48 =for hackers
49 Found in file av.c
50
51 =item av_exists
52
53 Returns true if the element indexed by C<key> has been initialized.
54
55 This relies on the fact that uninitialized array elements are set to
56 C<&PL_sv_undef>.
57
58         bool    av_exists(AV* ar, I32 key)
59
60 =for hackers
61 Found in file av.c
62
63 =item av_extend
64
65 Pre-extend an array.  The C<key> is the index to which the array should be
66 extended.
67
68         void    av_extend(AV* ar, I32 key)
69
70 =for hackers
71 Found in file av.c
72
73 =item av_fetch
74
75 Returns the SV at the specified index in the array.  The C<key> is the
76 index.  If C<lval> is set then the fetch will be part of a store.  Check
77 that the return value is non-null before dereferencing it to a C<SV*>.
78
79 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
80 more information on how to use this function on tied arrays. 
81
82         SV**    av_fetch(AV* ar, I32 key, I32 lval)
83
84 =for hackers
85 Found in file av.c
86
87 =item av_fill
88
89 Ensure than an array has a given number of elements, equivalent to
90 Perl's C<$#array = $fill;>.
91
92         void    av_fill(AV* ar, I32 fill)
93
94 =for hackers
95 Found in file av.c
96
97 =item av_len
98
99 Returns the highest index in the array.  Returns -1 if the array is
100 empty.
101
102         I32     av_len(AV* ar)
103
104 =for hackers
105 Found in file av.c
106
107 =item av_make
108
109 Creates a new AV and populates it with a list of SVs.  The SVs are copied
110 into the array, so they may be freed after the call to av_make.  The new AV
111 will have a reference count of 1.
112
113         AV*     av_make(I32 size, SV** svp)
114
115 =for hackers
116 Found in file av.c
117
118 =item av_pop
119
120 Pops an SV off the end of the array.  Returns C<&PL_sv_undef> if the array
121 is empty.
122
123         SV*     av_pop(AV* ar)
124
125 =for hackers
126 Found in file av.c
127
128 =item av_push
129
130 Pushes an SV onto the end of the array.  The array will grow automatically
131 to accommodate the addition.
132
133         void    av_push(AV* ar, SV* val)
134
135 =for hackers
136 Found in file av.c
137
138 =item av_shift
139
140 Shifts an SV off the beginning of the array.
141
142         SV*     av_shift(AV* ar)
143
144 =for hackers
145 Found in file av.c
146
147 =item av_store
148
149 Stores an SV in an array.  The array index is specified as C<key>.  The
150 return value will be NULL if the operation failed or if the value did not
151 need to be actually stored within the array (as in the case of tied
152 arrays). Otherwise it can be dereferenced to get the original C<SV*>.  Note
153 that the caller is responsible for suitably incrementing the reference
154 count of C<val> before the call, and decrementing it if the function
155 returned NULL.
156
157 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for
158 more information on how to use this function on tied arrays.
159
160         SV**    av_store(AV* ar, I32 key, SV* val)
161
162 =for hackers
163 Found in file av.c
164
165 =item av_undef
166
167 Undefines the array.  Frees the memory used by the array itself.
168
169         void    av_undef(AV* ar)
170
171 =for hackers
172 Found in file av.c
173
174 =item av_unshift
175
176 Unshift the given number of C<undef> values onto the beginning of the
177 array.  The array will grow automatically to accommodate the addition.  You
178 must then use C<av_store> to assign values to these new elements.
179
180         void    av_unshift(AV* ar, I32 num)
181
182 =for hackers
183 Found in file av.c
184
185 =item ax
186
187 Variable which is setup by C<xsubpp> to indicate the stack base offset,
188 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros.  The C<dMARK> macro
189 must be called prior to setup the C<MARK> variable.
190
191         I32     ax
192
193 =for hackers
194 Found in file XSUB.h
195
196 =item bytes_from_utf8
197
198 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
199 Unlike <utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
200 the newly-created string, and updates C<len> to contain the new
201 length.  Returns the original string if no conversion occurs, C<len>
202 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
203 0 if C<s> is converted or contains all 7bit characters.
204
205 NOTE: this function is experimental and may change or be
206 removed without notice.
207
208         U8*     bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8)
209
210 =for hackers
211 Found in file utf8.c
212
213 =item bytes_to_utf8
214
215 Converts a string C<s> of length C<len> from ASCII into UTF8 encoding.
216 Returns a pointer to the newly-created string, and sets C<len> to
217 reflect the new length.
218
219 NOTE: this function is experimental and may change or be
220 removed without notice.
221
222         U8*     bytes_to_utf8(U8 *s, STRLEN *len)
223
224 =for hackers
225 Found in file utf8.c
226
227 =item call_argv
228
229 Performs a callback to the specified Perl sub.  See L<perlcall>.
230
231 NOTE: the perl_ form of this function is deprecated.
232
233         I32     call_argv(const char* sub_name, I32 flags, char** argv)
234
235 =for hackers
236 Found in file perl.c
237
238 =item call_method
239
240 Performs a callback to the specified Perl method.  The blessed object must
241 be on the stack.  See L<perlcall>.
242
243 NOTE: the perl_ form of this function is deprecated.
244
245         I32     call_method(const char* methname, I32 flags)
246
247 =for hackers
248 Found in file perl.c
249
250 =item call_pv
251
252 Performs a callback to the specified Perl sub.  See L<perlcall>.
253
254 NOTE: the perl_ form of this function is deprecated.
255
256         I32     call_pv(const char* sub_name, I32 flags)
257
258 =for hackers
259 Found in file perl.c
260
261 =item call_sv
262
263 Performs a callback to the Perl sub whose name is in the SV.  See
264 L<perlcall>.
265
266 NOTE: the perl_ form of this function is deprecated.
267
268         I32     call_sv(SV* sv, I32 flags)
269
270 =for hackers
271 Found in file perl.c
272
273 =item CLASS
274
275 Variable which is setup by C<xsubpp> to indicate the 
276 class name for a C++ XS constructor.  This is always a C<char*>.  See C<THIS>.
277
278         char*   CLASS
279
280 =for hackers
281 Found in file XSUB.h
282
283 =item Copy
284
285 The XSUB-writer's interface to the C C<memcpy> function.  The C<src> is the
286 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
287 the type.  May fail on overlapping copies.  See also C<Move>.
288
289         void    Copy(void* src, void* dest, int nitems, type)
290
291 =for hackers
292 Found in file handy.h
293
294 =item croak
295
296 This is the XSUB-writer's interface to Perl's C<die> function.
297 Normally use this function the same way you use the C C<printf>
298 function.  See C<warn>.
299
300 If you want to throw an exception object, assign the object to
301 C<$@> and then pass C<Nullch> to croak():
302
303    errsv = get_sv("@", TRUE);
304    sv_setsv(errsv, exception_object);
305    croak(Nullch);
306
307         void    croak(const char* pat, ...)
308
309 =for hackers
310 Found in file util.c
311
312 =item CvSTASH
313
314 Returns the stash of the CV.
315
316         HV*     CvSTASH(CV* cv)
317
318 =for hackers
319 Found in file cv.h
320
321 =item cv_const_sv
322
323 If C<cv> is a constant sub eligible for inlining. returns the constant
324 value returned by the sub.  Otherwise, returns NULL.
325
326 Constant subs can be created with C<newCONSTSUB> or as described in
327 L<perlsub/"Constant Functions">.
328
329         SV*     cv_const_sv(CV* cv)
330
331 =for hackers
332 Found in file opmini.c
333
334 =item dAX
335
336 Sets up the C<ax> variable.
337 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
338
339                 dAX;
340
341 =for hackers
342 Found in file XSUB.h
343
344 =item dITEMS
345
346 Sets up the C<items> variable.
347 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
348
349                 dITEMS;
350
351 =for hackers
352 Found in file XSUB.h
353
354 =item dMARK
355
356 Declare a stack marker variable, C<mark>, for the XSUB.  See C<MARK> and
357 C<dORIGMARK>.
358
359                 dMARK;
360
361 =for hackers
362 Found in file pp.h
363
364 =item dORIGMARK
365
366 Saves the original stack mark for the XSUB.  See C<ORIGMARK>.
367
368                 dORIGMARK;
369
370 =for hackers
371 Found in file pp.h
372
373 =item dSP
374
375 Declares a local copy of perl's stack pointer for the XSUB, available via
376 the C<SP> macro.  See C<SP>.
377
378                 dSP;
379
380 =for hackers
381 Found in file pp.h
382
383 =item dXSARGS
384
385 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
386 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
387 This is usually handled automatically by C<xsubpp>.
388
389                 dXSARGS;
390
391 =for hackers
392 Found in file XSUB.h
393
394 =item dXSI32
395
396 Sets up the C<ix> variable for an XSUB which has aliases.  This is usually
397 handled automatically by C<xsubpp>.
398
399                 dXSI32;
400
401 =for hackers
402 Found in file XSUB.h
403
404 =item ENTER
405
406 Opening bracket on a callback.  See C<LEAVE> and L<perlcall>.
407
408                 ENTER;
409
410 =for hackers
411 Found in file scope.h
412
413 =item eval_pv
414
415 Tells Perl to C<eval> the given string and return an SV* result.
416
417 NOTE: the perl_ form of this function is deprecated.
418
419         SV*     eval_pv(const char* p, I32 croak_on_error)
420
421 =for hackers
422 Found in file perl.c
423
424 =item eval_sv
425
426 Tells Perl to C<eval> the string in the SV.
427
428 NOTE: the perl_ form of this function is deprecated.
429
430         I32     eval_sv(SV* sv, I32 flags)
431
432 =for hackers
433 Found in file perl.c
434
435 =item EXTEND
436
437 Used to extend the argument stack for an XSUB's return values. Once
438 used, guarantees that there is room for at least C<nitems> to be pushed
439 onto the stack.
440
441         void    EXTEND(SP, int nitems)
442
443 =for hackers
444 Found in file pp.h
445
446 =item fbm_compile
447
448 Analyses the string in order to make fast searches on it using fbm_instr()
449 -- the Boyer-Moore algorithm.
450
451         void    fbm_compile(SV* sv, U32 flags)
452
453 =for hackers
454 Found in file util.c
455
456 =item fbm_instr
457
458 Returns the location of the SV in the string delimited by C<str> and
459 C<strend>.  It returns C<Nullch> if the string can't be found.  The C<sv>
460 does not have to be fbm_compiled, but the search will not be as fast
461 then.
462
463         char*   fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
464
465 =for hackers
466 Found in file util.c
467
468 =item FREETMPS
469
470 Closing bracket for temporaries on a callback.  See C<SAVETMPS> and
471 L<perlcall>.
472
473                 FREETMPS;
474
475 =for hackers
476 Found in file scope.h
477
478 =item getcwd_sv
479
480 Fill the sv with current working directory
481
482         int     getcwd_sv(SV* sv)
483
484 =for hackers
485 Found in file util.c
486
487 =item get_av
488
489 Returns the AV of the specified Perl array.  If C<create> is set and the
490 Perl variable does not exist then it will be created.  If C<create> is not
491 set and the variable does not exist then NULL is returned.
492
493 NOTE: the perl_ form of this function is deprecated.
494
495         AV*     get_av(const char* name, I32 create)
496
497 =for hackers
498 Found in file perl.c
499
500 =item get_cv
501
502 Returns the CV of the specified Perl subroutine.  If C<create> is set and
503 the Perl subroutine does not exist then it will be declared (which has the
504 same effect as saying C<sub name;>).  If C<create> is not set and the
505 subroutine does not exist then NULL is returned.
506
507 NOTE: the perl_ form of this function is deprecated.
508
509         CV*     get_cv(const char* name, I32 create)
510
511 =for hackers
512 Found in file perl.c
513
514 =item get_hv
515
516 Returns the HV of the specified Perl hash.  If C<create> is set and the
517 Perl variable does not exist then it will be created.  If C<create> is not
518 set and the variable does not exist then NULL is returned.
519
520 NOTE: the perl_ form of this function is deprecated.
521
522         HV*     get_hv(const char* name, I32 create)
523
524 =for hackers
525 Found in file perl.c
526
527 =item get_sv
528
529 Returns the SV of the specified Perl scalar.  If C<create> is set and the
530 Perl variable does not exist then it will be created.  If C<create> is not
531 set and the variable does not exist then NULL is returned.
532
533 NOTE: the perl_ form of this function is deprecated.
534
535         SV*     get_sv(const char* name, I32 create)
536
537 =for hackers
538 Found in file perl.c
539
540 =item GIMME
541
542 A backward-compatible version of C<GIMME_V> which can only return
543 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
544 Deprecated.  Use C<GIMME_V> instead.
545
546         U32     GIMME
547
548 =for hackers
549 Found in file op.h
550
551 =item GIMME_V
552
553 The XSUB-writer's equivalent to Perl's C<wantarray>.  Returns C<G_VOID>,
554 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
555 respectively.
556
557         U32     GIMME_V
558
559 =for hackers
560 Found in file op.h
561
562 =item grok_bin
563
564 converts a string representing a binary number to numeric form.
565
566 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
567 conversion flags, and I<result> should be NULL or a pointer to an NV.
568 The scan stops at the end of the string, or the first invalid character.
569 On return I<*len> is set to the length scanned string, and I<*flags> gives
570 output flags.
571
572 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
573 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
574 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
575 and writes the value to I<*result> (or the value is discarded if I<result>
576 is NULL).
577
578 The hex number may optinally be prefixed with "0b" or "b" unless
579 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
580 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
581 number may use '_' characters to separate digits.
582
583         UV      grok_bin(char* start, STRLEN* len, I32* flags, NV *result)
584
585 =for hackers
586 Found in file numeric.c
587
588 =item grok_hex
589
590 converts a string representing a hex number to numeric form.
591
592 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
593 conversion flags, and I<result> should be NULL or a pointer to an NV.
594 The scan stops at the end of the string, or the first non-hex-digit character.
595 On return I<*len> is set to the length scanned string, and I<*flags> gives
596 output flags.
597
598 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
599 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
600 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
601 and writes the value to I<*result> (or the value is discarded if I<result>
602 is NULL).
603
604 The hex number may optinally be prefixed with "0x" or "x" unless
605 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
606 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
607 number may use '_' characters to separate digits.
608
609         UV      grok_hex(char* start, STRLEN* len, I32* flags, NV *result)
610
611 =for hackers
612 Found in file numeric.c
613
614 =item grok_number
615
616 Recognise (or not) a number.  The type of the number is returned
617 (0 if unrecognised), otherwise it is a bit-ORed combination of
618 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
619 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
620
621 If the value of the number can fit an in UV, it is returned in the *valuep
622 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
623 will never be set unless *valuep is valid, but *valuep may have been assigned
624 to during processing even though IS_NUMBER_IN_UV is not set on return.
625 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
626 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
627
628 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
629 seen (in which case *valuep gives the true value truncated to an integer), and
630 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
631 absolute value).  IS_NUMBER_IN_UV is not set if e notation was used or the
632 number is larger than a UV.
633
634         int     grok_number(const char *pv, STRLEN len, UV *valuep)
635
636 =for hackers
637 Found in file numeric.c
638
639 =item grok_numeric_radix
640
641 Scan and skip for a numeric decimal separator (radix).
642
643         bool    grok_numeric_radix(const char **sp, const char *send)
644
645 =for hackers
646 Found in file numeric.c
647
648 =item grok_oct
649
650
651         UV      grok_oct(char* start, STRLEN* len, I32* flags, NV *result)
652
653 =for hackers
654 Found in file numeric.c
655
656 =item GvSV
657
658 Return the SV from the GV.
659
660         SV*     GvSV(GV* gv)
661
662 =for hackers
663 Found in file gv.h
664
665 =item gv_fetchmeth
666
667 Returns the glob with the given C<name> and a defined subroutine or
668 C<NULL>.  The glob lives in the given C<stash>, or in the stashes
669 accessible via @ISA and UNIVERSAL::.
670
671 The argument C<level> should be either 0 or -1.  If C<level==0>, as a
672 side-effect creates a glob with the given C<name> in the given C<stash>
673 which in the case of success contains an alias for the subroutine, and sets
674 up caching info for this glob.  Similarly for all the searched stashes.
675
676 This function grants C<"SUPER"> token as a postfix of the stash name. The
677 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
678 visible to Perl code.  So when calling C<call_sv>, you should not use
679 the GV directly; instead, you should use the method's CV, which can be
680 obtained from the GV with the C<GvCV> macro.
681
682         GV*     gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
683
684 =for hackers
685 Found in file gv.c
686
687 =item gv_fetchmethod
688
689 See L<gv_fetchmethod_autoload>.
690
691         GV*     gv_fetchmethod(HV* stash, const char* name)
692
693 =for hackers
694 Found in file gv.c
695
696 =item gv_fetchmethod_autoload
697
698 Returns the glob which contains the subroutine to call to invoke the method
699 on the C<stash>.  In fact in the presence of autoloading this may be the
700 glob for "AUTOLOAD".  In this case the corresponding variable $AUTOLOAD is
701 already setup.
702
703 The third parameter of C<gv_fetchmethod_autoload> determines whether
704 AUTOLOAD lookup is performed if the given method is not present: non-zero
705 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
706 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
707 with a non-zero C<autoload> parameter.
708
709 These functions grant C<"SUPER"> token as a prefix of the method name. Note
710 that if you want to keep the returned glob for a long time, you need to
711 check for it being "AUTOLOAD", since at the later time the call may load a
712 different subroutine due to $AUTOLOAD changing its value. Use the glob
713 created via a side effect to do this.
714
715 These functions have the same side-effects and as C<gv_fetchmeth> with
716 C<level==0>.  C<name> should be writable if contains C<':'> or C<'
717 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
718 C<call_sv> apply equally to these functions.
719
720         GV*     gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
721
722 =for hackers
723 Found in file gv.c
724
725 =item gv_stashpv
726
727 Returns a pointer to the stash for a specified package.  C<name> should
728 be a valid UTF-8 string.  If C<create> is set then the package will be
729 created if it does not already exist.  If C<create> is not set and the
730 package does not exist then NULL is returned.
731
732         HV*     gv_stashpv(const char* name, I32 create)
733
734 =for hackers
735 Found in file gv.c
736
737 =item gv_stashsv
738
739 Returns a pointer to the stash for a specified package, which must be a
740 valid UTF-8 string.  See C<gv_stashpv>.
741
742         HV*     gv_stashsv(SV* sv, I32 create)
743
744 =for hackers
745 Found in file gv.c
746
747 =item G_ARRAY
748
749 Used to indicate list context.  See C<GIMME_V>, C<GIMME> and
750 L<perlcall>.
751
752 =for hackers
753 Found in file cop.h
754
755 =item G_DISCARD
756
757 Indicates that arguments returned from a callback should be discarded.  See
758 L<perlcall>.
759
760 =for hackers
761 Found in file cop.h
762
763 =item G_EVAL
764
765 Used to force a Perl C<eval> wrapper around a callback.  See
766 L<perlcall>.
767
768 =for hackers
769 Found in file cop.h
770
771 =item G_NOARGS
772
773 Indicates that no arguments are being sent to a callback.  See
774 L<perlcall>.
775
776 =for hackers
777 Found in file cop.h
778
779 =item G_SCALAR
780
781 Used to indicate scalar context.  See C<GIMME_V>, C<GIMME>, and
782 L<perlcall>.
783
784 =for hackers
785 Found in file cop.h
786
787 =item G_VOID
788
789 Used to indicate void context.  See C<GIMME_V> and L<perlcall>.
790
791 =for hackers
792 Found in file cop.h
793
794 =item HEf_SVKEY
795
796 This flag, used in the length slot of hash entries and magic structures,
797 specifies the structure contains a C<SV*> pointer where a C<char*> pointer
798 is to be expected. (For information only--not to be used).
799
800 =for hackers
801 Found in file hv.h
802
803 =item HeHASH
804
805 Returns the computed hash stored in the hash entry.
806
807         U32     HeHASH(HE* he)
808
809 =for hackers
810 Found in file hv.h
811
812 =item HeKEY
813
814 Returns the actual pointer stored in the key slot of the hash entry. The
815 pointer may be either C<char*> or C<SV*>, depending on the value of
816 C<HeKLEN()>.  Can be assigned to.  The C<HePV()> or C<HeSVKEY()> macros are
817 usually preferable for finding the value of a key.
818
819         void*   HeKEY(HE* he)
820
821 =for hackers
822 Found in file hv.h
823
824 =item HeKLEN
825
826 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
827 holds an C<SV*> key.  Otherwise, holds the actual length of the key.  Can
828 be assigned to. The C<HePV()> macro is usually preferable for finding key
829 lengths.
830
831         STRLEN  HeKLEN(HE* he)
832
833 =for hackers
834 Found in file hv.h
835
836 =item HePV
837
838 Returns the key slot of the hash entry as a C<char*> value, doing any
839 necessary dereferencing of possibly C<SV*> keys.  The length of the string
840 is placed in C<len> (this is a macro, so do I<not> use C<&len>).  If you do
841 not care about what the length of the key is, you may use the global
842 variable C<PL_na>, though this is rather less efficient than using a local
843 variable.  Remember though, that hash keys in perl are free to contain
844 embedded nulls, so using C<strlen()> or similar is not a good way to find
845 the length of hash keys. This is very similar to the C<SvPV()> macro
846 described elsewhere in this document.
847
848         char*   HePV(HE* he, STRLEN len)
849
850 =for hackers
851 Found in file hv.h
852
853 =item HeSVKEY
854
855 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
856 contain an C<SV*> key.
857
858         SV*     HeSVKEY(HE* he)
859
860 =for hackers
861 Found in file hv.h
862
863 =item HeSVKEY_force
864
865 Returns the key as an C<SV*>.  Will create and return a temporary mortal
866 C<SV*> if the hash entry contains only a C<char*> key.
867
868         SV*     HeSVKEY_force(HE* he)
869
870 =for hackers
871 Found in file hv.h
872
873 =item HeSVKEY_set
874
875 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
876 indicate the presence of an C<SV*> key, and returns the same
877 C<SV*>.
878
879         SV*     HeSVKEY_set(HE* he, SV* sv)
880
881 =for hackers
882 Found in file hv.h
883
884 =item HeVAL
885
886 Returns the value slot (type C<SV*>) stored in the hash entry.
887
888         SV*     HeVAL(HE* he)
889
890 =for hackers
891 Found in file hv.h
892
893 =item HvNAME
894
895 Returns the package name of a stash.  See C<SvSTASH>, C<CvSTASH>.
896
897         char*   HvNAME(HV* stash)
898
899 =for hackers
900 Found in file hv.h
901
902 =item hv_clear
903
904 Clears a hash, making it empty.
905
906         void    hv_clear(HV* tb)
907
908 =for hackers
909 Found in file hv.c
910
911 =item hv_delete
912
913 Deletes a key/value pair in the hash.  The value SV is removed from the
914 hash and returned to the caller.  The C<klen> is the length of the key.
915 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
916 will be returned.
917
918         SV*     hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
919
920 =for hackers
921 Found in file hv.c
922
923 =item hv_delete_ent
924
925 Deletes a key/value pair in the hash.  The value SV is removed from the
926 hash and returned to the caller.  The C<flags> value will normally be zero;
927 if set to G_DISCARD then NULL will be returned.  C<hash> can be a valid
928 precomputed hash value, or 0 to ask for it to be computed.
929
930         SV*     hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
931
932 =for hackers
933 Found in file hv.c
934
935 =item hv_exists
936
937 Returns a boolean indicating whether the specified hash key exists.  The
938 C<klen> is the length of the key.
939
940         bool    hv_exists(HV* tb, const char* key, I32 klen)
941
942 =for hackers
943 Found in file hv.c
944
945 =item hv_exists_ent
946
947 Returns a boolean indicating whether the specified hash key exists. C<hash>
948 can be a valid precomputed hash value, or 0 to ask for it to be
949 computed.
950
951         bool    hv_exists_ent(HV* tb, SV* key, U32 hash)
952
953 =for hackers
954 Found in file hv.c
955
956 =item hv_fetch
957
958 Returns the SV which corresponds to the specified key in the hash.  The
959 C<klen> is the length of the key.  If C<lval> is set then the fetch will be
960 part of a store.  Check that the return value is non-null before
961 dereferencing it to a C<SV*>.
962
963 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
964 information on how to use this function on tied hashes.
965
966         SV**    hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
967
968 =for hackers
969 Found in file hv.c
970
971 =item hv_fetch_ent
972
973 Returns the hash entry which corresponds to the specified key in the hash.
974 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
975 if you want the function to compute it.  IF C<lval> is set then the fetch
976 will be part of a store.  Make sure the return value is non-null before
977 accessing it.  The return value when C<tb> is a tied hash is a pointer to a
978 static location, so be sure to make a copy of the structure if you need to
979 store it somewhere.
980
981 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
982 information on how to use this function on tied hashes.
983
984         HE*     hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
985
986 =for hackers
987 Found in file hv.c
988
989 =item hv_iterinit
990
991 Prepares a starting point to traverse a hash table.  Returns the number of
992 keys in the hash (i.e. the same as C<HvKEYS(tb)>).  The return value is
993 currently only meaningful for hashes without tie magic.
994
995 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
996 hash buckets that happen to be in use.  If you still need that esoteric
997 value, you can get it through the macro C<HvFILL(tb)>.
998
999         I32     hv_iterinit(HV* tb)
1000
1001 =for hackers
1002 Found in file hv.c
1003
1004 =item hv_iterkey
1005
1006 Returns the key from the current position of the hash iterator.  See
1007 C<hv_iterinit>.
1008
1009         char*   hv_iterkey(HE* entry, I32* retlen)
1010
1011 =for hackers
1012 Found in file hv.c
1013
1014 =item hv_iterkeysv
1015
1016 Returns the key as an C<SV*> from the current position of the hash
1017 iterator.  The return value will always be a mortal copy of the key.  Also
1018 see C<hv_iterinit>.
1019
1020         SV*     hv_iterkeysv(HE* entry)
1021
1022 =for hackers
1023 Found in file hv.c
1024
1025 =item hv_iternext
1026
1027 Returns entries from a hash iterator.  See C<hv_iterinit>.
1028
1029         HE*     hv_iternext(HV* tb)
1030
1031 =for hackers
1032 Found in file hv.c
1033
1034 =item hv_iternextsv
1035
1036 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1037 operation.
1038
1039         SV*     hv_iternextsv(HV* hv, char** key, I32* retlen)
1040
1041 =for hackers
1042 Found in file hv.c
1043
1044 =item hv_iterval
1045
1046 Returns the value from the current position of the hash iterator.  See
1047 C<hv_iterkey>.
1048
1049         SV*     hv_iterval(HV* tb, HE* entry)
1050
1051 =for hackers
1052 Found in file hv.c
1053
1054 =item hv_magic
1055
1056 Adds magic to a hash.  See C<sv_magic>.
1057
1058         void    hv_magic(HV* hv, GV* gv, int how)
1059
1060 =for hackers
1061 Found in file hv.c
1062
1063 =item hv_store
1064
1065 Stores an SV in a hash.  The hash key is specified as C<key> and C<klen> is
1066 the length of the key.  The C<hash> parameter is the precomputed hash
1067 value; if it is zero then Perl will compute it.  The return value will be
1068 NULL if the operation failed or if the value did not need to be actually
1069 stored within the hash (as in the case of tied hashes).  Otherwise it can
1070 be dereferenced to get the original C<SV*>.  Note that the caller is
1071 responsible for suitably incrementing the reference count of C<val> before
1072 the call, and decrementing it if the function returned NULL.
1073
1074 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1075 information on how to use this function on tied hashes.
1076
1077         SV**    hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1078
1079 =for hackers
1080 Found in file hv.c
1081
1082 =item hv_store_ent
1083
1084 Stores C<val> in a hash.  The hash key is specified as C<key>.  The C<hash>
1085 parameter is the precomputed hash value; if it is zero then Perl will
1086 compute it.  The return value is the new hash entry so created.  It will be
1087 NULL if the operation failed or if the value did not need to be actually
1088 stored within the hash (as in the case of tied hashes).  Otherwise the
1089 contents of the return value can be accessed using the C<He?> macros
1090 described here.  Note that the caller is responsible for suitably
1091 incrementing the reference count of C<val> before the call, and
1092 decrementing it if the function returned NULL.
1093
1094 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1095 information on how to use this function on tied hashes.
1096
1097         HE*     hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1098
1099 =for hackers
1100 Found in file hv.c
1101
1102 =item hv_undef
1103
1104 Undefines the hash.
1105
1106         void    hv_undef(HV* tb)
1107
1108 =for hackers
1109 Found in file hv.c
1110
1111 =item isALNUM
1112
1113 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
1114 character (including underscore) or digit.
1115
1116         bool    isALNUM(char ch)
1117
1118 =for hackers
1119 Found in file handy.h
1120
1121 =item isALPHA
1122
1123 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
1124 character.
1125
1126         bool    isALPHA(char ch)
1127
1128 =for hackers
1129 Found in file handy.h
1130
1131 =item isDIGIT
1132
1133 Returns a boolean indicating whether the C C<char> is an ASCII
1134 digit.
1135
1136         bool    isDIGIT(char ch)
1137
1138 =for hackers
1139 Found in file handy.h
1140
1141 =item isLOWER
1142
1143 Returns a boolean indicating whether the C C<char> is a lowercase
1144 character.
1145
1146         bool    isLOWER(char ch)
1147
1148 =for hackers
1149 Found in file handy.h
1150
1151 =item isSPACE
1152
1153 Returns a boolean indicating whether the C C<char> is whitespace.
1154
1155         bool    isSPACE(char ch)
1156
1157 =for hackers
1158 Found in file handy.h
1159
1160 =item isUPPER
1161
1162 Returns a boolean indicating whether the C C<char> is an uppercase
1163 character.
1164
1165         bool    isUPPER(char ch)
1166
1167 =for hackers
1168 Found in file handy.h
1169
1170 =item is_utf8_char
1171
1172 Tests if some arbitrary number of bytes begins in a valid UTF-8
1173 character.  Note that an INVARIANT (i.e. ASCII) character is a valid UTF-8 character.
1174 The actual number of bytes in the UTF-8 character will be returned if
1175 it is valid, otherwise 0.
1176
1177         STRLEN  is_utf8_char(U8 *p)
1178
1179 =for hackers
1180 Found in file utf8.c
1181
1182 =item is_utf8_string
1183
1184 Returns true if first C<len> bytes of the given string form a valid UTF8
1185 string, false otherwise.  Note that 'a valid UTF8 string' does not mean
1186 'a string that contains UTF8' because a valid ASCII string is a valid
1187 UTF8 string.
1188
1189         bool    is_utf8_string(U8 *s, STRLEN len)
1190
1191 =for hackers
1192 Found in file utf8.c
1193
1194 =item items
1195
1196 Variable which is setup by C<xsubpp> to indicate the number of 
1197 items on the stack.  See L<perlxs/"Variable-length Parameter Lists">.
1198
1199         I32     items
1200
1201 =for hackers
1202 Found in file XSUB.h
1203
1204 =item ix
1205
1206 Variable which is setup by C<xsubpp> to indicate which of an 
1207 XSUB's aliases was used to invoke it.  See L<perlxs/"The ALIAS: Keyword">.
1208
1209         I32     ix
1210
1211 =for hackers
1212 Found in file XSUB.h
1213
1214 =item LEAVE
1215
1216 Closing bracket on a callback.  See C<ENTER> and L<perlcall>.
1217
1218                 LEAVE;
1219
1220 =for hackers
1221 Found in file scope.h
1222
1223 =item load_module
1224
1225 Loads the module whose name is pointed to by the string part of name.
1226 Note that the actual module name, not its filename, should be given.
1227 Eg, "Foo::Bar" instead of "Foo/Bar.pm".  flags can be any of
1228 PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS
1229 (or 0 for no flags). ver, if specified, provides version semantics
1230 similar to C<use Foo::Bar VERSION>.  The optional trailing SV*
1231 arguments can be used to specify arguments to the module's import()
1232 method, similar to C<use Foo::Bar VERSION LIST>.
1233
1234         void    load_module(U32 flags, SV* name, SV* ver, ...)
1235
1236 =for hackers
1237 Found in file opmini.c
1238
1239 =item looks_like_number
1240
1241 Test if the content of an SV looks like a number (or is a number).
1242 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
1243 non-numeric warning), even if your atof() doesn't grok them.
1244
1245         I32     looks_like_number(SV* sv)
1246
1247 =for hackers
1248 Found in file sv.c
1249
1250 =item MARK
1251
1252 Stack marker variable for the XSUB.  See C<dMARK>.
1253
1254 =for hackers
1255 Found in file pp.h
1256
1257 =item mg_clear
1258
1259 Clear something magical that the SV represents.  See C<sv_magic>.
1260
1261         int     mg_clear(SV* sv)
1262
1263 =for hackers
1264 Found in file mg.c
1265
1266 =item mg_copy
1267
1268 Copies the magic from one SV to another.  See C<sv_magic>.
1269
1270         int     mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1271
1272 =for hackers
1273 Found in file mg.c
1274
1275 =item mg_find
1276
1277 Finds the magic pointer for type matching the SV.  See C<sv_magic>.
1278
1279         MAGIC*  mg_find(SV* sv, int type)
1280
1281 =for hackers
1282 Found in file mg.c
1283
1284 =item mg_free
1285
1286 Free any magic storage used by the SV.  See C<sv_magic>.
1287
1288         int     mg_free(SV* sv)
1289
1290 =for hackers
1291 Found in file mg.c
1292
1293 =item mg_get
1294
1295 Do magic after a value is retrieved from the SV.  See C<sv_magic>.
1296
1297         int     mg_get(SV* sv)
1298
1299 =for hackers
1300 Found in file mg.c
1301
1302 =item mg_length
1303
1304 Report on the SV's length.  See C<sv_magic>.
1305
1306         U32     mg_length(SV* sv)
1307
1308 =for hackers
1309 Found in file mg.c
1310
1311 =item mg_magical
1312
1313 Turns on the magical status of an SV.  See C<sv_magic>.
1314
1315         void    mg_magical(SV* sv)
1316
1317 =for hackers
1318 Found in file mg.c
1319
1320 =item mg_set
1321
1322 Do magic after a value is assigned to the SV.  See C<sv_magic>.
1323
1324         int     mg_set(SV* sv)
1325
1326 =for hackers
1327 Found in file mg.c
1328
1329 =item Move
1330
1331 The XSUB-writer's interface to the C C<memmove> function.  The C<src> is the
1332 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1333 the type.  Can do overlapping moves.  See also C<Copy>.
1334
1335         void    Move(void* src, void* dest, int nitems, type)
1336
1337 =for hackers
1338 Found in file handy.h
1339
1340 =item New
1341
1342 The XSUB-writer's interface to the C C<malloc> function.
1343
1344         void    New(int id, void* ptr, int nitems, type)
1345
1346 =for hackers
1347 Found in file handy.h
1348
1349 =item newAV
1350
1351 Creates a new AV.  The reference count is set to 1.
1352
1353         AV*     newAV()
1354
1355 =for hackers
1356 Found in file av.c
1357
1358 =item Newc
1359
1360 The XSUB-writer's interface to the C C<malloc> function, with
1361 cast.
1362
1363         void    Newc(int id, void* ptr, int nitems, type, cast)
1364
1365 =for hackers
1366 Found in file handy.h
1367
1368 =item newCONSTSUB
1369
1370 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
1371 eligible for inlining at compile-time.
1372
1373         CV*     newCONSTSUB(HV* stash, char* name, SV* sv)
1374
1375 =for hackers
1376 Found in file opmini.c
1377
1378 =item newHV
1379
1380 Creates a new HV.  The reference count is set to 1.
1381
1382         HV*     newHV()
1383
1384 =for hackers
1385 Found in file hv.c
1386
1387 =item newRV_inc
1388
1389 Creates an RV wrapper for an SV.  The reference count for the original SV is
1390 incremented.
1391
1392         SV*     newRV_inc(SV* sv)
1393
1394 =for hackers
1395 Found in file sv.h
1396
1397 =item newRV_noinc
1398
1399 Creates an RV wrapper for an SV.  The reference count for the original
1400 SV is B<not> incremented.
1401
1402         SV*     newRV_noinc(SV *sv)
1403
1404 =for hackers
1405 Found in file sv.c
1406
1407 =item newSV
1408
1409 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
1410 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
1411 macro.
1412
1413         SV*     newSV(STRLEN len)
1414
1415 =for hackers
1416 Found in file sv.c
1417
1418 =item NEWSV
1419
1420 Creates a new SV.  A non-zero C<len> parameter indicates the number of
1421 bytes of preallocated string space the SV should have.  An extra byte for a
1422 tailing NUL is also reserved.  (SvPOK is not set for the SV even if string
1423 space is allocated.)  The reference count for the new SV is set to 1.
1424 C<id> is an integer id between 0 and 1299 (used to identify leaks).
1425
1426         SV*     NEWSV(int id, STRLEN len)
1427
1428 =for hackers
1429 Found in file handy.h
1430
1431 =item newSViv
1432
1433 Creates a new SV and copies an integer into it.  The reference count for the
1434 SV is set to 1.
1435
1436         SV*     newSViv(IV i)
1437
1438 =for hackers
1439 Found in file sv.c
1440
1441 =item newSVnv
1442
1443 Creates a new SV and copies a floating point value into it.
1444 The reference count for the SV is set to 1.
1445
1446         SV*     newSVnv(NV n)
1447
1448 =for hackers
1449 Found in file sv.c
1450
1451 =item newSVpv
1452
1453 Creates a new SV and copies a string into it.  The reference count for the
1454 SV is set to 1.  If C<len> is zero, Perl will compute the length using
1455 strlen().  For efficiency, consider using C<newSVpvn> instead.
1456
1457         SV*     newSVpv(const char* s, STRLEN len)
1458
1459 =for hackers
1460 Found in file sv.c
1461
1462 =item newSVpvf
1463
1464 Creates a new SV and initializes it with the string formatted like
1465 C<sprintf>.
1466
1467         SV*     newSVpvf(const char* pat, ...)
1468
1469 =for hackers
1470 Found in file sv.c
1471
1472 =item newSVpvn
1473
1474 Creates a new SV and copies a string into it.  The reference count for the
1475 SV is set to 1.  Note that if C<len> is zero, Perl will create a zero length
1476 string.  You are responsible for ensuring that the source string is at least
1477 C<len> bytes long.
1478
1479         SV*     newSVpvn(const char* s, STRLEN len)
1480
1481 =for hackers
1482 Found in file sv.c
1483
1484 =item newSVpvn_share
1485
1486 Creates a new SV with its SvPVX pointing to a shared string in the string
1487 table. If the string does not already exist in the table, it is created
1488 first.  Turns on READONLY and FAKE.  The string's hash is stored in the UV
1489 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
1490 otherwise the hash is computed.  The idea here is that as the string table
1491 is used for shared hash keys these strings will have SvPVX == HeKEY and
1492 hash lookup will avoid string compare.
1493
1494         SV*     newSVpvn_share(const char* s, I32 len, U32 hash)
1495
1496 =for hackers
1497 Found in file sv.c
1498
1499 =item newSVrv
1500
1501 Creates a new SV for the RV, C<rv>, to point to.  If C<rv> is not an RV then
1502 it will be upgraded to one.  If C<classname> is non-null then the new SV will
1503 be blessed in the specified package.  The new SV is returned and its
1504 reference count is 1.
1505
1506         SV*     newSVrv(SV* rv, const char* classname)
1507
1508 =for hackers
1509 Found in file sv.c
1510
1511 =item newSVsv
1512
1513 Creates a new SV which is an exact duplicate of the original SV.
1514 (Uses C<sv_setsv>).
1515
1516         SV*     newSVsv(SV* old)
1517
1518 =for hackers
1519 Found in file sv.c
1520
1521 =item newSVuv
1522
1523 Creates a new SV and copies an unsigned integer into it.
1524 The reference count for the SV is set to 1.
1525
1526         SV*     newSVuv(UV u)
1527
1528 =for hackers
1529 Found in file sv.c
1530
1531 =item newXS
1532
1533 Used by C<xsubpp> to hook up XSUBs as Perl subs.
1534
1535 =for hackers
1536 Found in file opmini.c
1537
1538 =item newXSproto
1539
1540 Used by C<xsubpp> to hook up XSUBs as Perl subs.  Adds Perl prototypes to
1541 the subs.
1542
1543 =for hackers
1544 Found in file XSUB.h
1545
1546 =item Newz
1547
1548 The XSUB-writer's interface to the C C<malloc> function.  The allocated
1549 memory is zeroed with C<memzero>.
1550
1551         void    Newz(int id, void* ptr, int nitems, type)
1552
1553 =for hackers
1554 Found in file handy.h
1555
1556 =item Nullav
1557
1558 Null AV pointer.
1559
1560 =for hackers
1561 Found in file av.h
1562
1563 =item Nullch
1564
1565 Null character pointer.
1566
1567 =for hackers
1568 Found in file handy.h
1569
1570 =item Nullcv
1571
1572 Null CV pointer.
1573
1574 =for hackers
1575 Found in file cv.h
1576
1577 =item Nullhv
1578
1579 Null HV pointer.
1580
1581 =for hackers
1582 Found in file hv.h
1583
1584 =item Nullsv
1585
1586 Null SV pointer.
1587
1588 =for hackers
1589 Found in file handy.h
1590
1591 =item ORIGMARK
1592
1593 The original stack mark for the XSUB.  See C<dORIGMARK>.
1594
1595 =for hackers
1596 Found in file pp.h
1597
1598 =item perl_alloc
1599
1600 Allocates a new Perl interpreter.  See L<perlembed>.
1601
1602         PerlInterpreter*        perl_alloc()
1603
1604 =for hackers
1605 Found in file perl.c
1606
1607 =item perl_clone
1608
1609 Create and return a new interpreter by cloning the current one.
1610
1611         PerlInterpreter*        perl_clone(PerlInterpreter* interp, UV flags)
1612
1613 =for hackers
1614 Found in file sv.c
1615
1616 =item perl_construct
1617
1618 Initializes a new Perl interpreter.  See L<perlembed>.
1619
1620         void    perl_construct(PerlInterpreter* interp)
1621
1622 =for hackers
1623 Found in file perl.c
1624
1625 =item perl_destruct
1626
1627 Shuts down a Perl interpreter.  See L<perlembed>.
1628
1629         int     perl_destruct(PerlInterpreter* interp)
1630
1631 =for hackers
1632 Found in file perl.c
1633
1634 =item perl_free
1635
1636 Releases a Perl interpreter.  See L<perlembed>.
1637
1638         void    perl_free(PerlInterpreter* interp)
1639
1640 =for hackers
1641 Found in file perl.c
1642
1643 =item perl_parse
1644
1645 Tells a Perl interpreter to parse a Perl script.  See L<perlembed>.
1646
1647         int     perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
1648
1649 =for hackers
1650 Found in file perl.c
1651
1652 =item perl_run
1653
1654 Tells a Perl interpreter to run.  See L<perlembed>.
1655
1656         int     perl_run(PerlInterpreter* interp)
1657
1658 =for hackers
1659 Found in file perl.c
1660
1661 =item PL_modglobal
1662
1663 C<PL_modglobal> is a general purpose, interpreter global HV for use by
1664 extensions that need to keep information on a per-interpreter basis.
1665 In a pinch, it can also be used as a symbol table for extensions
1666 to share data among each other.  It is a good idea to use keys
1667 prefixed by the package name of the extension that owns the data.
1668
1669         HV*     PL_modglobal
1670
1671 =for hackers
1672 Found in file intrpvar.h
1673
1674 =item PL_na
1675
1676 A convenience variable which is typically used with C<SvPV> when one
1677 doesn't care about the length of the string.  It is usually more efficient
1678 to either declare a local variable and use that instead or to use the
1679 C<SvPV_nolen> macro.
1680
1681         STRLEN  PL_na
1682
1683 =for hackers
1684 Found in file thrdvar.h
1685
1686 =item PL_sv_no
1687
1688 This is the C<false> SV.  See C<PL_sv_yes>.  Always refer to this as
1689 C<&PL_sv_no>.
1690
1691         SV      PL_sv_no
1692
1693 =for hackers
1694 Found in file intrpvar.h
1695
1696 =item PL_sv_undef
1697
1698 This is the C<undef> SV.  Always refer to this as C<&PL_sv_undef>.
1699
1700         SV      PL_sv_undef
1701
1702 =for hackers
1703 Found in file intrpvar.h
1704
1705 =item PL_sv_yes
1706
1707 This is the C<true> SV.  See C<PL_sv_no>.  Always refer to this as
1708 C<&PL_sv_yes>.
1709
1710         SV      PL_sv_yes
1711
1712 =for hackers
1713 Found in file intrpvar.h
1714
1715 =item POPi
1716
1717 Pops an integer off the stack.
1718
1719         IV      POPi
1720
1721 =for hackers
1722 Found in file pp.h
1723
1724 =item POPl
1725
1726 Pops a long off the stack.
1727
1728         long    POPl
1729
1730 =for hackers
1731 Found in file pp.h
1732
1733 =item POPn
1734
1735 Pops a double off the stack.
1736
1737         NV      POPn
1738
1739 =for hackers
1740 Found in file pp.h
1741
1742 =item POPp
1743
1744 Pops a string off the stack. Deprecated. New code should provide
1745 a STRLEN n_a and use POPpx.
1746
1747         char*   POPp
1748
1749 =for hackers
1750 Found in file pp.h
1751
1752 =item POPpbytex
1753
1754 Pops a string off the stack which must consist of bytes i.e. characters < 256.
1755 Requires a variable STRLEN n_a in scope.
1756
1757         char*   POPpbytex
1758
1759 =for hackers
1760 Found in file pp.h
1761
1762 =item POPpx
1763
1764 Pops a string off the stack.
1765 Requires a variable STRLEN n_a in scope.
1766
1767         char*   POPpx
1768
1769 =for hackers
1770 Found in file pp.h
1771
1772 =item POPs
1773
1774 Pops an SV off the stack.
1775
1776         SV*     POPs
1777
1778 =for hackers
1779 Found in file pp.h
1780
1781 =item PUSHi
1782
1783 Push an integer onto the stack.  The stack must have room for this element.
1784 Handles 'set' magic.  See C<XPUSHi>.
1785
1786         void    PUSHi(IV iv)
1787
1788 =for hackers
1789 Found in file pp.h
1790
1791 =item PUSHMARK
1792
1793 Opening bracket for arguments on a callback.  See C<PUTBACK> and
1794 L<perlcall>.
1795
1796                 PUSHMARK;
1797
1798 =for hackers
1799 Found in file pp.h
1800
1801 =item PUSHn
1802
1803 Push a double onto the stack.  The stack must have room for this element.
1804 Handles 'set' magic.  See C<XPUSHn>.
1805
1806         void    PUSHn(NV nv)
1807
1808 =for hackers
1809 Found in file pp.h
1810
1811 =item PUSHp
1812
1813 Push a string onto the stack.  The stack must have room for this element.
1814 The C<len> indicates the length of the string.  Handles 'set' magic.  See
1815 C<XPUSHp>.
1816
1817         void    PUSHp(char* str, STRLEN len)
1818
1819 =for hackers
1820 Found in file pp.h
1821
1822 =item PUSHs
1823
1824 Push an SV onto the stack.  The stack must have room for this element.
1825 Does not handle 'set' magic.  See C<XPUSHs>.
1826
1827         void    PUSHs(SV* sv)
1828
1829 =for hackers
1830 Found in file pp.h
1831
1832 =item PUSHu
1833
1834 Push an unsigned integer onto the stack.  The stack must have room for this
1835 element.  See C<XPUSHu>.
1836
1837         void    PUSHu(UV uv)
1838
1839 =for hackers
1840 Found in file pp.h
1841
1842 =item PUTBACK
1843
1844 Closing bracket for XSUB arguments.  This is usually handled by C<xsubpp>.
1845 See C<PUSHMARK> and L<perlcall> for other uses.
1846
1847                 PUTBACK;
1848
1849 =for hackers
1850 Found in file pp.h
1851
1852 =item Renew
1853
1854 The XSUB-writer's interface to the C C<realloc> function.
1855
1856         void    Renew(void* ptr, int nitems, type)
1857
1858 =for hackers
1859 Found in file handy.h
1860
1861 =item Renewc
1862
1863 The XSUB-writer's interface to the C C<realloc> function, with
1864 cast.
1865
1866         void    Renewc(void* ptr, int nitems, type, cast)
1867
1868 =for hackers
1869 Found in file handy.h
1870
1871 =item require_pv
1872
1873 Tells Perl to C<require> the file named by the string argument.  It is
1874 analogous to the Perl code C<eval "require '$file'">.  It's even
1875 implemented that way; consider using Perl_load_module instead.
1876
1877 NOTE: the perl_ form of this function is deprecated.
1878
1879         void    require_pv(const char* pv)
1880
1881 =for hackers
1882 Found in file perl.c
1883
1884 =item RETVAL
1885
1886 Variable which is setup by C<xsubpp> to hold the return value for an 
1887 XSUB. This is always the proper type for the XSUB. See 
1888 L<perlxs/"The RETVAL Variable">.
1889
1890         (whatever)      RETVAL
1891
1892 =for hackers
1893 Found in file XSUB.h
1894
1895 =item Safefree
1896
1897 The XSUB-writer's interface to the C C<free> function.
1898
1899         void    Safefree(void* ptr)
1900
1901 =for hackers
1902 Found in file handy.h
1903
1904 =item savepv
1905
1906 Copy a string to a safe spot.  This does not use an SV.
1907
1908         char*   savepv(const char* sv)
1909
1910 =for hackers
1911 Found in file util.c
1912
1913 =item savepvn
1914
1915 Copy a string to a safe spot.  The C<len> indicates number of bytes to
1916 copy.  This does not use an SV.
1917
1918         char*   savepvn(const char* sv, I32 len)
1919
1920 =for hackers
1921 Found in file util.c
1922
1923 =item SAVETMPS
1924
1925 Opening bracket for temporaries on a callback.  See C<FREETMPS> and
1926 L<perlcall>.
1927
1928                 SAVETMPS;
1929
1930 =for hackers
1931 Found in file scope.h
1932
1933 =item scan_bin
1934
1935 For backwards compatibility. Use C<grok_bin> instead.
1936
1937         NV      scan_bin(char* start, STRLEN len, STRLEN* retlen)
1938
1939 =for hackers
1940 Found in file numeric.c
1941
1942 =item scan_hex
1943
1944 For backwards compatibility. Use C<grok_hex> instead.
1945
1946         NV      scan_hex(char* start, STRLEN len, STRLEN* retlen)
1947
1948 =for hackers
1949 Found in file numeric.c
1950
1951 =item scan_oct
1952
1953 For backwards compatibility. Use C<grok_oct> instead.
1954
1955         NV      scan_oct(char* start, STRLEN len, STRLEN* retlen)
1956
1957 =for hackers
1958 Found in file numeric.c
1959
1960 =item sharedsv_find
1961
1962 Tries to find if a given SV has a shared backend, either by
1963 looking at magic, or by checking if it is tied again threads::shared.
1964
1965         shared_sv*      sharedsv_find(SV* sv)
1966
1967 =for hackers
1968 Found in file sharedsv.c
1969
1970 =item sharedsv_init
1971
1972 Saves a space for keeping SVs wider than an interpreter,
1973 currently only stores a pointer to the first interpreter.
1974
1975         void    sharedsv_init()
1976
1977 =for hackers
1978 Found in file sharedsv.c
1979
1980 =item sharedsv_lock
1981
1982 Recursive locks on a sharedsv.
1983 Locks are dynamicly scoped at the level of the first lock.
1984         void    sharedsv_lock(shared_sv* ssv)
1985
1986 =for hackers
1987 Found in file sharedsv.c
1988
1989 =item sharedsv_new
1990
1991 Allocates a new shared sv struct, you must yourself create the SV/AV/HV.
1992         shared_sv*      sharedsv_new()
1993
1994 =for hackers
1995 Found in file sharedsv.c
1996
1997 =item sharedsv_thrcnt_dec
1998
1999 Decrements the threadcount of a shared sv. When a threads frontend is freed
2000 this function should be called.
2001
2002         void    sharedsv_thrcnt_dec(shared_sv* ssv)
2003
2004 =for hackers
2005 Found in file sharedsv.c
2006
2007 =item sharedsv_thrcnt_inc
2008
2009 Increments the threadcount of a sharedsv.
2010         void    sharedsv_thrcnt_inc(shared_sv* ssv)
2011
2012 =for hackers
2013 Found in file sharedsv.c
2014
2015 =item sharedsv_unlock
2016
2017 Recursively unlocks a shared sv.
2018
2019         void    sharedsv_unlock(shared_sv* ssv)
2020
2021 =for hackers
2022 Found in file sharedsv.c
2023
2024 =item sortsv
2025
2026    
2027 Sort an array. Here is an example:
2028
2029     sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale); 
2030
2031         void    sortsv(SV ** array, size_t num_elts, SVCOMPARE_t f)
2032
2033 =for hackers
2034 Found in file pp_ctl.c
2035
2036 =item SP
2037
2038 Stack pointer.  This is usually handled by C<xsubpp>.  See C<dSP> and
2039 C<SPAGAIN>.
2040
2041 =for hackers
2042 Found in file pp.h
2043
2044 =item SPAGAIN
2045
2046 Refetch the stack pointer.  Used after a callback.  See L<perlcall>.
2047
2048                 SPAGAIN;
2049
2050 =for hackers
2051 Found in file pp.h
2052
2053 =item ST
2054
2055 Used to access elements on the XSUB's stack.
2056
2057         SV*     ST(int ix)
2058
2059 =for hackers
2060 Found in file XSUB.h
2061
2062 =item strEQ
2063
2064 Test two strings to see if they are equal.  Returns true or false.
2065
2066         bool    strEQ(char* s1, char* s2)
2067
2068 =for hackers
2069 Found in file handy.h
2070
2071 =item strGE
2072
2073 Test two strings to see if the first, C<s1>, is greater than or equal to
2074 the second, C<s2>.  Returns true or false.
2075
2076         bool    strGE(char* s1, char* s2)
2077
2078 =for hackers
2079 Found in file handy.h
2080
2081 =item strGT
2082
2083 Test two strings to see if the first, C<s1>, is greater than the second,
2084 C<s2>.  Returns true or false.
2085
2086         bool    strGT(char* s1, char* s2)
2087
2088 =for hackers
2089 Found in file handy.h
2090
2091 =item strLE
2092
2093 Test two strings to see if the first, C<s1>, is less than or equal to the
2094 second, C<s2>.  Returns true or false.
2095
2096         bool    strLE(char* s1, char* s2)
2097
2098 =for hackers
2099 Found in file handy.h
2100
2101 =item strLT
2102
2103 Test two strings to see if the first, C<s1>, is less than the second,
2104 C<s2>.  Returns true or false.
2105
2106         bool    strLT(char* s1, char* s2)
2107
2108 =for hackers
2109 Found in file handy.h
2110
2111 =item strNE
2112
2113 Test two strings to see if they are different.  Returns true or
2114 false.
2115
2116         bool    strNE(char* s1, char* s2)
2117
2118 =for hackers
2119 Found in file handy.h
2120
2121 =item strnEQ
2122
2123 Test two strings to see if they are equal.  The C<len> parameter indicates
2124 the number of bytes to compare.  Returns true or false. (A wrapper for
2125 C<strncmp>).
2126
2127         bool    strnEQ(char* s1, char* s2, STRLEN len)
2128
2129 =for hackers
2130 Found in file handy.h
2131
2132 =item strnNE
2133
2134 Test two strings to see if they are different.  The C<len> parameter
2135 indicates the number of bytes to compare.  Returns true or false. (A
2136 wrapper for C<strncmp>).
2137
2138         bool    strnNE(char* s1, char* s2, STRLEN len)
2139
2140 =for hackers
2141 Found in file handy.h
2142
2143 =item StructCopy
2144
2145 This is an architecture-independent macro to copy one structure to another.
2146
2147         void    StructCopy(type src, type dest, type)
2148
2149 =for hackers
2150 Found in file handy.h
2151
2152 =item SvCUR
2153
2154 Returns the length of the string which is in the SV.  See C<SvLEN>.
2155
2156         STRLEN  SvCUR(SV* sv)
2157
2158 =for hackers
2159 Found in file sv.h
2160
2161 =item SvCUR_set
2162
2163 Set the length of the string which is in the SV.  See C<SvCUR>.
2164
2165         void    SvCUR_set(SV* sv, STRLEN len)
2166
2167 =for hackers
2168 Found in file sv.h
2169
2170 =item SvEND
2171
2172 Returns a pointer to the last character in the string which is in the SV.
2173 See C<SvCUR>.  Access the character as *(SvEND(sv)).
2174
2175         char*   SvEND(SV* sv)
2176
2177 =for hackers
2178 Found in file sv.h
2179
2180 =item SvGETMAGIC
2181
2182 Invokes C<mg_get> on an SV if it has 'get' magic.  This macro evaluates its
2183 argument more than once.
2184
2185         void    SvGETMAGIC(SV* sv)
2186
2187 =for hackers
2188 Found in file sv.h
2189
2190 =item SvGROW
2191
2192 Expands the character buffer in the SV so that it has room for the
2193 indicated number of bytes (remember to reserve space for an extra trailing
2194 NUL character).  Calls C<sv_grow> to perform the expansion if necessary.
2195 Returns a pointer to the character buffer.
2196
2197         char *  SvGROW(SV* sv, STRLEN len)
2198
2199 =for hackers
2200 Found in file sv.h
2201
2202 =item SvIOK
2203
2204 Returns a boolean indicating whether the SV contains an integer.
2205
2206         bool    SvIOK(SV* sv)
2207
2208 =for hackers
2209 Found in file sv.h
2210
2211 =item SvIOKp
2212
2213 Returns a boolean indicating whether the SV contains an integer.  Checks
2214 the B<private> setting.  Use C<SvIOK>.
2215
2216         bool    SvIOKp(SV* sv)
2217
2218 =for hackers
2219 Found in file sv.h
2220
2221 =item SvIOK_notUV
2222
2223 Returns a boolean indicating whether the SV contains an signed integer.
2224
2225         void    SvIOK_notUV(SV* sv)
2226
2227 =for hackers
2228 Found in file sv.h
2229
2230 =item SvIOK_off
2231
2232 Unsets the IV status of an SV.
2233
2234         void    SvIOK_off(SV* sv)
2235
2236 =for hackers
2237 Found in file sv.h
2238
2239 =item SvIOK_on
2240
2241 Tells an SV that it is an integer.
2242
2243         void    SvIOK_on(SV* sv)
2244
2245 =for hackers
2246 Found in file sv.h
2247
2248 =item SvIOK_only
2249
2250 Tells an SV that it is an integer and disables all other OK bits.
2251
2252         void    SvIOK_only(SV* sv)
2253
2254 =for hackers
2255 Found in file sv.h
2256
2257 =item SvIOK_only_UV
2258
2259 Tells and SV that it is an unsigned integer and disables all other OK bits.
2260
2261         void    SvIOK_only_UV(SV* sv)
2262
2263 =for hackers
2264 Found in file sv.h
2265
2266 =item SvIOK_UV
2267
2268 Returns a boolean indicating whether the SV contains an unsigned integer.
2269
2270         void    SvIOK_UV(SV* sv)
2271
2272 =for hackers
2273 Found in file sv.h
2274
2275 =item SvIV
2276
2277 Coerces the given SV to an integer and returns it. See  C<SvIVx> for a
2278 version which guarantees to evaluate sv only once.
2279
2280         IV      SvIV(SV* sv)
2281
2282 =for hackers
2283 Found in file sv.h
2284
2285 =item SvIVX
2286
2287 Returns the raw value in the SV's IV slot, without checks or conversions.
2288 Only use when you are sure SvIOK is true. See also C<SvIV()>.
2289
2290         IV      SvIVX(SV* sv)
2291
2292 =for hackers
2293 Found in file sv.h
2294
2295 =item SvIVx
2296
2297 Coerces the given SV to an integer and returns it. Guarantees to evaluate
2298 sv only once. Use the more efficent C<SvIV> otherwise.
2299
2300         IV      SvIVx(SV* sv)
2301
2302 =for hackers
2303 Found in file sv.h
2304
2305 =item SvLEN
2306
2307 Returns the size of the string buffer in the SV, not including any part
2308 attributable to C<SvOOK>.  See C<SvCUR>.
2309
2310         STRLEN  SvLEN(SV* sv)
2311
2312 =for hackers
2313 Found in file sv.h
2314
2315 =item SvNIOK
2316
2317 Returns a boolean indicating whether the SV contains a number, integer or
2318 double.
2319
2320         bool    SvNIOK(SV* sv)
2321
2322 =for hackers
2323 Found in file sv.h
2324
2325 =item SvNIOKp
2326
2327 Returns a boolean indicating whether the SV contains a number, integer or
2328 double.  Checks the B<private> setting.  Use C<SvNIOK>.
2329
2330         bool    SvNIOKp(SV* sv)
2331
2332 =for hackers
2333 Found in file sv.h
2334
2335 =item SvNIOK_off
2336
2337 Unsets the NV/IV status of an SV.
2338
2339         void    SvNIOK_off(SV* sv)
2340
2341 =for hackers
2342 Found in file sv.h
2343
2344 =item SvNOK
2345
2346 Returns a boolean indicating whether the SV contains a double.
2347
2348         bool    SvNOK(SV* sv)
2349
2350 =for hackers
2351 Found in file sv.h
2352
2353 =item SvNOKp
2354
2355 Returns a boolean indicating whether the SV contains a double.  Checks the
2356 B<private> setting.  Use C<SvNOK>.
2357
2358         bool    SvNOKp(SV* sv)
2359
2360 =for hackers
2361 Found in file sv.h
2362
2363 =item SvNOK_off
2364
2365 Unsets the NV status of an SV.
2366
2367         void    SvNOK_off(SV* sv)
2368
2369 =for hackers
2370 Found in file sv.h
2371
2372 =item SvNOK_on
2373
2374 Tells an SV that it is a double.
2375
2376         void    SvNOK_on(SV* sv)
2377
2378 =for hackers
2379 Found in file sv.h
2380
2381 =item SvNOK_only
2382
2383 Tells an SV that it is a double and disables all other OK bits.
2384
2385         void    SvNOK_only(SV* sv)
2386
2387 =for hackers
2388 Found in file sv.h
2389
2390 =item SvNV
2391
2392 Coerce the given SV to a double and return it. See  C<SvNVx> for a version
2393 which guarantees to evaluate sv only once.
2394
2395         NV      SvNV(SV* sv)
2396
2397 =for hackers
2398 Found in file sv.h
2399
2400 =item SvNVx
2401
2402 Coerces the given SV to a double and returns it. Guarantees to evaluate
2403 sv only once. Use the more efficent C<SvNV> otherwise.
2404
2405         NV      SvNVx(SV* sv)
2406
2407 =for hackers
2408 Found in file sv.h
2409
2410 =item SvNVX
2411
2412 Returns the raw value in the SV's NV slot, without checks or conversions.
2413 Only use when you are sure SvNOK is true. See also C<SvNV()>.
2414
2415         NV      SvNVX(SV* sv)
2416
2417 =for hackers
2418 Found in file sv.h
2419
2420 =item SvOK
2421
2422 Returns a boolean indicating whether the value is an SV.
2423
2424         bool    SvOK(SV* sv)
2425
2426 =for hackers
2427 Found in file sv.h
2428
2429 =item SvOOK
2430
2431 Returns a boolean indicating whether the SvIVX is a valid offset value for
2432 the SvPVX.  This hack is used internally to speed up removal of characters
2433 from the beginning of a SvPV.  When SvOOK is true, then the start of the
2434 allocated string buffer is really (SvPVX - SvIVX).
2435
2436         bool    SvOOK(SV* sv)
2437
2438 =for hackers
2439 Found in file sv.h
2440
2441 =item SvPOK
2442
2443 Returns a boolean indicating whether the SV contains a character
2444 string.
2445
2446         bool    SvPOK(SV* sv)
2447
2448 =for hackers
2449 Found in file sv.h
2450
2451 =item SvPOKp
2452
2453 Returns a boolean indicating whether the SV contains a character string.
2454 Checks the B<private> setting.  Use C<SvPOK>.
2455
2456         bool    SvPOKp(SV* sv)
2457
2458 =for hackers
2459 Found in file sv.h
2460
2461 =item SvPOK_off
2462
2463 Unsets the PV status of an SV.
2464
2465         void    SvPOK_off(SV* sv)
2466
2467 =for hackers
2468 Found in file sv.h
2469
2470 =item SvPOK_on
2471
2472 Tells an SV that it is a string.
2473
2474         void    SvPOK_on(SV* sv)
2475
2476 =for hackers
2477 Found in file sv.h
2478
2479 =item SvPOK_only
2480
2481 Tells an SV that it is a string and disables all other OK bits.
2482 Will also turn off the UTF8 status.
2483
2484         void    SvPOK_only(SV* sv)
2485
2486 =for hackers
2487 Found in file sv.h
2488
2489 =item SvPOK_only_UTF8
2490
2491 Tells an SV that it is a string and disables all other OK bits,
2492 and leaves the UTF8 status as it was.
2493
2494         void    SvPOK_only_UTF8(SV* sv)
2495
2496 =for hackers
2497 Found in file sv.h
2498
2499 =item SvPV
2500
2501 Returns a pointer to the string in the SV, or a stringified form of the SV
2502 if the SV does not contain a string.  Handles 'get' magic. See also
2503 C<SvPVx> for a version which guarantees to evaluate sv only once.
2504
2505         char*   SvPV(SV* sv, STRLEN len)
2506
2507 =for hackers
2508 Found in file sv.h
2509
2510 =item SvPVbyte
2511
2512 Like C<SvPV>, but converts sv to byte representation first if necessary.
2513
2514         char*   SvPVbyte(SV* sv, STRLEN len)
2515
2516 =for hackers
2517 Found in file sv.h
2518
2519 =item SvPVbytex
2520
2521 Like C<SvPV>, but converts sv to byte representation first if necessary.
2522 Guarantees to evalute sv only once; use the more efficient C<SvPVbyte>
2523 otherwise.
2524
2525
2526         char*   SvPVbytex(SV* sv, STRLEN len)
2527
2528 =for hackers
2529 Found in file sv.h
2530
2531 =item SvPVbytex_force
2532
2533 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
2534 Guarantees to evalute sv only once; use the more efficient C<SvPVbyte_force>
2535 otherwise.
2536
2537         char*   SvPVbytex_force(SV* sv, STRLEN len)
2538
2539 =for hackers
2540 Found in file sv.h
2541
2542 =item SvPVbyte_force
2543
2544 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
2545
2546         char*   SvPVbyte_force(SV* sv, STRLEN len)
2547
2548 =for hackers
2549 Found in file sv.h
2550
2551 =item SvPVbyte_nolen
2552
2553 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
2554
2555         char*   SvPVbyte_nolen(SV* sv, STRLEN len)
2556
2557 =for hackers
2558 Found in file sv.h
2559
2560 =item SvPVutf8
2561
2562 Like C<SvPV>, but converts sv to uft8 first if necessary.
2563
2564         char*   SvPVutf8(SV* sv, STRLEN len)
2565
2566 =for hackers
2567 Found in file sv.h
2568
2569 =item SvPVutf8x
2570
2571 Like C<SvPV>, but converts sv to uft8 first if necessary.
2572 Guarantees to evalute sv only once; use the more efficient C<SvPVutf8>
2573 otherwise.
2574
2575         char*   SvPVutf8x(SV* sv, STRLEN len)
2576
2577 =for hackers
2578 Found in file sv.h
2579
2580 =item SvPVutf8x_force
2581
2582 Like C<SvPV_force>, but converts sv to uft8 first if necessary.
2583 Guarantees to evalute sv only once; use the more efficient C<SvPVutf8_force>
2584 otherwise.
2585
2586         char*   SvPVutf8x_force(SV* sv, STRLEN len)
2587
2588 =for hackers
2589 Found in file sv.h
2590
2591 =item SvPVutf8_force
2592
2593 Like C<SvPV_force>, but converts sv to uft8 first if necessary.
2594
2595         char*   SvPVutf8_force(SV* sv, STRLEN len)
2596
2597 =for hackers
2598 Found in file sv.h
2599
2600 =item SvPVutf8_nolen
2601
2602 Like C<SvPV_nolen>, but converts sv to uft8 first if necessary.
2603
2604         char*   SvPVutf8_nolen(SV* sv, STRLEN len)
2605
2606 =for hackers
2607 Found in file sv.h
2608
2609 =item SvPVX
2610
2611 Returns a pointer to the physical string in the SV.  The SV must contain a
2612 string.
2613
2614         char*   SvPVX(SV* sv)
2615
2616 =for hackers
2617 Found in file sv.h
2618
2619 =item SvPVx
2620
2621 A version of C<SvPV> which guarantees to evaluate sv only once.
2622
2623         char*   SvPVx(SV* sv, STRLEN len)
2624
2625 =for hackers
2626 Found in file sv.h
2627
2628 =item SvPV_force
2629
2630 Like <SvPV> but will force the SV into becoming a string (SvPOK).  You want
2631 force if you are going to update the SvPVX directly.
2632
2633         char*   SvPV_force(SV* sv, STRLEN len)
2634
2635 =for hackers
2636 Found in file sv.h
2637
2638 =item SvPV_force_nomg
2639
2640 Like <SvPV> but will force the SV into becoming a string (SvPOK).  You want
2641 force if you are going to update the SvPVX directly. Doesn't process magic.
2642
2643         char*   SvPV_force_nomg(SV* sv, STRLEN len)
2644
2645 =for hackers
2646 Found in file sv.h
2647
2648 =item SvPV_nolen
2649
2650 Returns a pointer to the string in the SV, or a stringified form of the SV
2651 if the SV does not contain a string.  Handles 'get' magic.
2652
2653         char*   SvPV_nolen(SV* sv)
2654
2655 =for hackers
2656 Found in file sv.h
2657
2658 =item SvREFCNT
2659
2660 Returns the value of the object's reference count.
2661
2662         U32     SvREFCNT(SV* sv)
2663
2664 =for hackers
2665 Found in file sv.h
2666
2667 =item SvREFCNT_dec
2668
2669 Decrements the reference count of the given SV.
2670
2671         void    SvREFCNT_dec(SV* sv)
2672
2673 =for hackers
2674 Found in file sv.h
2675
2676 =item SvREFCNT_inc
2677
2678 Increments the reference count of the given SV.
2679
2680         SV*     SvREFCNT_inc(SV* sv)
2681
2682 =for hackers
2683 Found in file sv.h
2684
2685 =item SvROK
2686
2687 Tests if the SV is an RV.
2688
2689         bool    SvROK(SV* sv)
2690
2691 =for hackers
2692 Found in file sv.h
2693
2694 =item SvROK_off
2695
2696 Unsets the RV status of an SV.
2697
2698         void    SvROK_off(SV* sv)
2699
2700 =for hackers
2701 Found in file sv.h
2702
2703 =item SvROK_on
2704
2705 Tells an SV that it is an RV.
2706
2707         void    SvROK_on(SV* sv)
2708
2709 =for hackers
2710 Found in file sv.h
2711
2712 =item SvRV
2713
2714 Dereferences an RV to return the SV.
2715
2716         SV*     SvRV(SV* sv)
2717
2718 =for hackers
2719 Found in file sv.h
2720
2721 =item SvSETMAGIC
2722
2723 Invokes C<mg_set> on an SV if it has 'set' magic.  This macro evaluates its
2724 argument more than once.
2725
2726         void    SvSETMAGIC(SV* sv)
2727
2728 =for hackers
2729 Found in file sv.h
2730
2731 =item SvSetMagicSV
2732
2733 Like C<SvSetSV>, but does any set magic required afterwards.
2734
2735         void    SvSetMagicSV(SV* dsb, SV* ssv)
2736
2737 =for hackers
2738 Found in file sv.h
2739
2740 =item SvSetMagicSV_nosteal
2741
2742 Like C<SvSetMagicSV>, but does any set magic required afterwards.
2743
2744         void    SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
2745
2746 =for hackers
2747 Found in file sv.h
2748
2749 =item SvSetSV
2750
2751 Calls C<sv_setsv> if dsv is not the same as ssv.  May evaluate arguments
2752 more than once.
2753
2754         void    SvSetSV(SV* dsb, SV* ssv)
2755
2756 =for hackers
2757 Found in file sv.h
2758
2759 =item SvSetSV_nosteal
2760
2761 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2762 ssv. May evaluate arguments more than once.
2763
2764         void    SvSetSV_nosteal(SV* dsv, SV* ssv)
2765
2766 =for hackers
2767 Found in file sv.h
2768
2769 =item SvSTASH
2770
2771 Returns the stash of the SV.
2772
2773         HV*     SvSTASH(SV* sv)
2774
2775 =for hackers
2776 Found in file sv.h
2777
2778 =item SvTAINT
2779
2780 Taints an SV if tainting is enabled
2781
2782         void    SvTAINT(SV* sv)
2783
2784 =for hackers
2785 Found in file sv.h
2786
2787 =item SvTAINTED
2788
2789 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
2790 not.
2791
2792         bool    SvTAINTED(SV* sv)
2793
2794 =for hackers
2795 Found in file sv.h
2796
2797 =item SvTAINTED_off
2798
2799 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
2800 some of Perl's fundamental security features. XS module authors should not
2801 use this function unless they fully understand all the implications of
2802 unconditionally untainting the value. Untainting should be done in the
2803 standard perl fashion, via a carefully crafted regexp, rather than directly
2804 untainting variables.
2805
2806         void    SvTAINTED_off(SV* sv)
2807
2808 =for hackers
2809 Found in file sv.h
2810
2811 =item SvTAINTED_on
2812
2813 Marks an SV as tainted.
2814
2815         void    SvTAINTED_on(SV* sv)
2816
2817 =for hackers
2818 Found in file sv.h
2819
2820 =item SvTRUE
2821
2822 Returns a boolean indicating whether Perl would evaluate the SV as true or
2823 false, defined or undefined.  Does not handle 'get' magic.
2824
2825         bool    SvTRUE(SV* sv)
2826
2827 =for hackers
2828 Found in file sv.h
2829
2830 =item svtype
2831
2832 An enum of flags for Perl types.  These are found in the file B<sv.h>
2833 in the C<svtype> enum.  Test these flags with the C<SvTYPE> macro.
2834
2835 =for hackers
2836 Found in file sv.h
2837
2838 =item SvTYPE
2839
2840 Returns the type of the SV.  See C<svtype>.
2841
2842         svtype  SvTYPE(SV* sv)
2843
2844 =for hackers
2845 Found in file sv.h
2846
2847 =item SVt_IV
2848
2849 Integer type flag for scalars.  See C<svtype>.
2850
2851 =for hackers
2852 Found in file sv.h
2853
2854 =item SVt_NV
2855
2856 Double type flag for scalars.  See C<svtype>.
2857
2858 =for hackers
2859 Found in file sv.h
2860
2861 =item SVt_PV
2862
2863 Pointer type flag for scalars.  See C<svtype>.
2864
2865 =for hackers
2866 Found in file sv.h
2867
2868 =item SVt_PVAV
2869
2870 Type flag for arrays.  See C<svtype>.
2871
2872 =for hackers
2873 Found in file sv.h
2874
2875 =item SVt_PVCV
2876
2877 Type flag for code refs.  See C<svtype>.
2878
2879 =for hackers
2880 Found in file sv.h
2881
2882 =item SVt_PVHV
2883
2884 Type flag for hashes.  See C<svtype>.
2885
2886 =for hackers
2887 Found in file sv.h
2888
2889 =item SVt_PVMG
2890
2891 Type flag for blessed scalars.  See C<svtype>.
2892
2893 =for hackers
2894 Found in file sv.h
2895
2896 =item SvUOK
2897
2898 Returns a boolean indicating whether the SV contains an unsigned integer.
2899
2900         void    SvUOK(SV* sv)
2901
2902 =for hackers
2903 Found in file sv.h
2904
2905 =item SvUPGRADE
2906
2907 Used to upgrade an SV to a more complex form.  Uses C<sv_upgrade> to
2908 perform the upgrade if necessary.  See C<svtype>.
2909
2910         void    SvUPGRADE(SV* sv, svtype type)
2911
2912 =for hackers
2913 Found in file sv.h
2914
2915 =item SvUTF8
2916
2917 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
2918
2919         void    SvUTF8(SV* sv)
2920
2921 =for hackers
2922 Found in file sv.h
2923
2924 =item SvUTF8_off
2925
2926 Unsets the UTF8 status of an SV.
2927
2928         void    SvUTF8_off(SV *sv)
2929
2930 =for hackers
2931 Found in file sv.h
2932
2933 =item SvUTF8_on
2934
2935 Turn on the UTF8 status of an SV (the data is not changed, just the flag).
2936 Do not use frivolously.
2937
2938         void    SvUTF8_on(SV *sv)
2939
2940 =for hackers
2941 Found in file sv.h
2942
2943 =item SvUV
2944
2945 Coerces the given SV to an unsigned integer and returns it.  See C<SvUVx>
2946 for a version which guarantees to evaluate sv only once.
2947
2948         UV      SvUV(SV* sv)
2949
2950 =for hackers
2951 Found in file sv.h
2952
2953 =item SvUVX
2954
2955 Returns the raw value in the SV's UV slot, without checks or conversions.
2956 Only use when you are sure SvIOK is true. See also C<SvUV()>.
2957
2958         UV      SvUVX(SV* sv)
2959
2960 =for hackers
2961 Found in file sv.h
2962
2963 =item SvUVx
2964
2965 Coerces the given SV to an unsigned integer and returns it. Guarantees to
2966 evaluate sv only once. Use the more efficent C<SvUV> otherwise.
2967
2968         UV      SvUVx(SV* sv)
2969
2970 =for hackers
2971 Found in file sv.h
2972
2973 =item sv_2bool
2974
2975 This function is only called on magical items, and is only used by
2976 sv_true() or its macro equivalent.
2977
2978         bool    sv_2bool(SV* sv)
2979
2980 =for hackers
2981 Found in file sv.c
2982
2983 =item sv_2cv
2984
2985 Using various gambits, try to get a CV from an SV; in addition, try if
2986 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
2987
2988         CV*     sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
2989
2990 =for hackers
2991 Found in file sv.c
2992
2993 =item sv_2io
2994
2995 Using various gambits, try to get an IO from an SV: the IO slot if its a
2996 GV; or the recursive result if we're an RV; or the IO slot of the symbol
2997 named after the PV if we're a string.
2998
2999         IO*     sv_2io(SV* sv)
3000
3001 =for hackers
3002 Found in file sv.c
3003
3004 =item sv_2iv
3005
3006 Return the integer value of an SV, doing any necessary string conversion,
3007 magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
3008
3009         IV      sv_2iv(SV* sv)
3010
3011 =for hackers
3012 Found in file sv.c
3013
3014 =item sv_2mortal
3015
3016 Marks an existing SV as mortal.  The SV will be destroyed "soon", either
3017 by an explicit call to FREETMPS, or by an implicit call at places such as
3018 statement boundaries.  See also C<sv_newmortal> and C<sv_mortalcopy>.
3019
3020         SV*     sv_2mortal(SV* sv)
3021
3022 =for hackers
3023 Found in file sv.c
3024
3025 =item sv_2nv
3026
3027 Return the num value of an SV, doing any necessary string or integer
3028 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3029 macros.
3030
3031         NV      sv_2nv(SV* sv)
3032
3033 =for hackers
3034 Found in file sv.c
3035
3036 =item sv_2pvbyte
3037
3038 Return a pointer to the byte-encoded representation of the SV, and set *lp
3039 to its length.  May cause the SV to be downgraded from UTF8 as a
3040 side-effect.
3041
3042 Usually accessed via the C<SvPVbyte> macro.
3043
3044         char*   sv_2pvbyte(SV* sv, STRLEN* lp)
3045
3046 =for hackers
3047 Found in file sv.c
3048
3049 =item sv_2pvbyte_nolen
3050
3051 Return a pointer to the byte-encoded representation of the SV.
3052 May cause the SV to be downgraded from UTF8 as a side-effect.
3053
3054 Usually accessed via the C<SvPVbyte_nolen> macro.
3055
3056         char*   sv_2pvbyte_nolen(SV* sv)
3057
3058 =for hackers
3059 Found in file sv.c
3060
3061 =item sv_2pvutf8
3062
3063 Return a pointer to the UTF8-encoded representation of the SV, and set *lp
3064 to its length.  May cause the SV to be upgraded to UTF8 as a side-effect.
3065
3066 Usually accessed via the C<SvPVutf8> macro.
3067
3068         char*   sv_2pvutf8(SV* sv, STRLEN* lp)
3069
3070 =for hackers
3071 Found in file sv.c
3072
3073 =item sv_2pvutf8_nolen
3074
3075 Return a pointer to the UTF8-encoded representation of the SV.
3076 May cause the SV to be upgraded to UTF8 as a side-effect.
3077
3078 Usually accessed via the C<SvPVutf8_nolen> macro.
3079
3080         char*   sv_2pvutf8_nolen(SV* sv)
3081
3082 =for hackers
3083 Found in file sv.c
3084
3085 =item sv_2pv_flags
3086
3087 Returns a pointer to the string value of an SV, and sets *lp to its length.
3088 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3089 if necessary.
3090 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3091 usually end up here too.
3092
3093         char*   sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
3094
3095 =for hackers
3096 Found in file sv.c
3097
3098 =item sv_2pv_nolen
3099
3100 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3101 use the macro wrapper C<SvPV_nolen(sv)> instead.
3102         char*   sv_2pv_nolen(SV* sv)
3103
3104 =for hackers
3105 Found in file sv.c
3106
3107 =item sv_2uv
3108
3109 Return the unsigned integer value of an SV, doing any necessary string
3110 conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
3111 macros.
3112
3113         UV      sv_2uv(SV* sv)
3114
3115 =for hackers
3116 Found in file sv.c
3117
3118 =item sv_backoff
3119
3120 Remove any string offset. You should normally use the C<SvOOK_off> macro
3121 wrapper instead.
3122
3123         int     sv_backoff(SV* sv)
3124
3125 =for hackers
3126 Found in file sv.c
3127
3128 =item sv_bless
3129
3130 Blesses an SV into a specified package.  The SV must be an RV.  The package
3131 must be designated by its stash (see C<gv_stashpv()>).  The reference count
3132 of the SV is unaffected.
3133
3134         SV*     sv_bless(SV* sv, HV* stash)
3135
3136 =for hackers
3137 Found in file sv.c
3138
3139 =item sv_catpv
3140
3141 Concatenates the string onto the end of the string which is in the SV.
3142 If the SV has the UTF8 status set, then the bytes appended should be
3143 valid UTF8.  Handles 'get' magic, but not 'set' magic.  See C<sv_catpv_mg>.
3144
3145         void    sv_catpv(SV* sv, const char* ptr)
3146
3147 =for hackers
3148 Found in file sv.c
3149
3150 =item sv_catpvf
3151
3152 Processes its arguments like C<sprintf> and appends the formatted
3153 output to an SV.  If the appended data contains "wide" characters
3154 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
3155 and characters >255 formatted with %c), the original SV might get
3156 upgraded to UTF-8.  Handles 'get' magic, but not 'set' magic.
3157 C<SvSETMAGIC()> must typically be called after calling this function
3158 to handle 'set' magic.
3159
3160         void    sv_catpvf(SV* sv, const char* pat, ...)
3161
3162 =for hackers
3163 Found in file sv.c
3164
3165 =item sv_catpvf_mg
3166
3167 Like C<sv_catpvf>, but also handles 'set' magic.
3168
3169         void    sv_catpvf_mg(SV *sv, const char* pat, ...)
3170
3171 =for hackers
3172 Found in file sv.c
3173
3174 =item sv_catpvn
3175
3176 Concatenates the string onto the end of the string which is in the SV.  The
3177 C<len> indicates number of bytes to copy.  If the SV has the UTF8
3178 status set, then the bytes appended should be valid UTF8.
3179 Handles 'get' magic, but not 'set' magic.  See C<sv_catpvn_mg>.
3180
3181         void    sv_catpvn(SV* sv, const char* ptr, STRLEN len)
3182
3183 =for hackers
3184 Found in file sv.c
3185
3186 =item sv_catpvn_flags
3187
3188 Concatenates the string onto the end of the string which is in the SV.  The
3189 C<len> indicates number of bytes to copy.  If the SV has the UTF8
3190 status set, then the bytes appended should be valid UTF8.
3191 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3192 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3193 in terms of this function.
3194
3195         void    sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
3196
3197 =for hackers
3198 Found in file sv.c
3199
3200 =item sv_catpvn_mg
3201
3202 Like C<sv_catpvn>, but also handles 'set' magic.
3203
3204         void    sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
3205
3206 =for hackers
3207 Found in file sv.c
3208
3209 =item sv_catpv_mg
3210
3211 Like C<sv_catpv>, but also handles 'set' magic.
3212
3213         void    sv_catpv_mg(SV *sv, const char *ptr)
3214
3215 =for hackers
3216 Found in file sv.c
3217
3218 =item sv_catsv
3219
3220 Concatenates the string from SV C<ssv> onto the end of the string in
3221 SV C<dsv>.  Modifies C<dsv> but not C<ssv>.  Handles 'get' magic, but
3222 not 'set' magic.  See C<sv_catsv_mg>.
3223
3224         void    sv_catsv(SV* dsv, SV* ssv)
3225
3226 =for hackers
3227 Found in file sv.c
3228
3229 =item sv_catsv_flags
3230
3231 Concatenates the string from SV C<ssv> onto the end of the string in
3232 SV C<dsv>.  Modifies C<dsv> but not C<ssv>.  If C<flags> has C<SV_GMAGIC>
3233 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3234 and C<sv_catsv_nomg> are implemented in terms of this function.
3235
3236         void    sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
3237
3238 =for hackers
3239 Found in file sv.c
3240
3241 =item sv_catsv_mg
3242
3243 Like C<sv_catsv>, but also handles 'set' magic.
3244
3245         void    sv_catsv_mg(SV *dstr, SV *sstr)
3246
3247 =for hackers
3248 Found in file sv.c
3249
3250 =item sv_chop
3251
3252 Efficient removal of characters from the beginning of the string buffer.
3253 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3254 the string buffer.  The C<ptr> becomes the first character of the adjusted
3255 string. Uses the "OOK hack".
3256
3257         void    sv_chop(SV* sv, char* ptr)
3258
3259 =for hackers
3260 Found in file sv.c
3261
3262 =item sv_clear
3263
3264 Clear an SV: call any destructors, free up any memory used by the body,
3265 and free the body itself. The SV's head is I<not> freed, although
3266 its type is set to all 1's so that it won't inadvertently be assumed
3267 to be live during global destruction etc.
3268 This function should only be called when REFCNT is zero. Most of the time
3269 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
3270 instead.
3271
3272         void    sv_clear(SV* sv)
3273
3274 =for hackers
3275 Found in file sv.c
3276
3277 =item sv_cmp
3278
3279 Compares the strings in two SVs.  Returns -1, 0, or 1 indicating whether the
3280 string in C<sv1> is less than, equal to, or greater than the string in
3281 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3282 coerce its args to strings if necessary.  See also C<sv_cmp_locale>.
3283
3284         I32     sv_cmp(SV* sv1, SV* sv2)
3285
3286 =for hackers
3287 Found in file sv.c
3288
3289 =item sv_cmp_locale
3290
3291 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
3292 'use bytes' aware, handles get magic, and will coerce its args to strings
3293 if necessary.  See also C<sv_cmp_locale>.  See also C<sv_cmp>.
3294
3295         I32     sv_cmp_locale(SV* sv1, SV* sv2)
3296
3297 =for hackers
3298 Found in file sv.c
3299
3300 =item sv_collxfrm
3301
3302 Add Collate Transform magic to an SV if it doesn't already have it.
3303
3304 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
3305 scalar data of the variable, but transformed to such a format that a normal
3306 memory comparison can be used to compare the data according to the locale
3307 settings.
3308
3309         char*   sv_collxfrm(SV* sv, STRLEN* nxp)
3310
3311 =for hackers
3312 Found in file sv.c
3313
3314 =item sv_dec
3315
3316 Auto-decrement of the value in the SV, doing string to numeric conversion
3317 if necessary. Handles 'get' magic.
3318
3319         void    sv_dec(SV* sv)
3320
3321 =for hackers
3322 Found in file sv.c
3323
3324 =item sv_derived_from
3325
3326 Returns a boolean indicating whether the SV is derived from the specified
3327 class.  This is the function that implements C<UNIVERSAL::isa>.  It works
3328 for class names as well as for objects.
3329
3330         bool    sv_derived_from(SV* sv, const char* name)
3331
3332 =for hackers
3333 Found in file universal.c
3334
3335 =item sv_eq
3336
3337 Returns a boolean indicating whether the strings in the two SVs are
3338 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3339 coerce its args to strings if necessary.
3340
3341         I32     sv_eq(SV* sv1, SV* sv2)
3342
3343 =for hackers
3344 Found in file sv.c
3345
3346 =item sv_force_normal
3347
3348 Undo various types of fakery on an SV: if the PV is a shared string, make
3349 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3350 an xpvmg. See also C<sv_force_normal_flags>.
3351
3352         void    sv_force_normal(SV *sv)
3353
3354 =for hackers
3355 Found in file sv.c
3356
3357 =item sv_force_normal_flags
3358
3359 Undo various types of fakery on an SV: if the PV is a shared string, make
3360 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3361 an xpvmg. The C<flags> parameter gets passed to  C<sv_unref_flags()>
3362 when unrefing. C<sv_force_normal> calls this function with flags set to 0.
3363
3364         void    sv_force_normal_flags(SV *sv, U32 flags)
3365
3366 =for hackers
3367 Found in file sv.c
3368
3369 =item sv_free
3370
3371 Decrement an SV's reference count, and if it drops to zero, call
3372 C<sv_clear> to invoke destructors and free up any memory used by
3373 the body; finally, deallocate the SV's head itself.
3374 Normally called via a wrapper macro C<SvREFCNT_dec>.
3375
3376         void    sv_free(SV* sv)
3377
3378 =for hackers
3379 Found in file sv.c
3380
3381 =item sv_gets
3382
3383 Get a line from the filehandle and store it into the SV, optionally
3384 appending to the currently-stored string.
3385
3386         char*   sv_gets(SV* sv, PerlIO* fp, I32 append)
3387
3388 =for hackers
3389 Found in file sv.c
3390
3391 =item sv_grow
3392
3393 Expands the character buffer in the SV.  If necessary, uses C<sv_unref> and
3394 upgrades the SV to C<SVt_PV>.  Returns a pointer to the character buffer.
3395 Use the C<SvGROW> wrapper instead.
3396
3397         char*   sv_grow(SV* sv, STRLEN newlen)
3398
3399 =for hackers
3400 Found in file sv.c
3401
3402 =item sv_inc
3403
3404 Auto-increment of the value in the SV, doing string to numeric conversion
3405 if necessary. Handles 'get' magic.
3406
3407         void    sv_inc(SV* sv)
3408
3409 =for hackers
3410 Found in file sv.c
3411
3412 =item sv_insert
3413
3414 Inserts a string at the specified offset/length within the SV. Similar to
3415 the Perl substr() function.
3416
3417         void    sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
3418
3419 =for hackers
3420 Found in file sv.c
3421
3422 =item sv_isa
3423
3424 Returns a boolean indicating whether the SV is blessed into the specified
3425 class.  This does not check for subtypes; use C<sv_derived_from> to verify
3426 an inheritance relationship.
3427
3428         int     sv_isa(SV* sv, const char* name)
3429
3430 =for hackers
3431 Found in file sv.c
3432
3433 =item sv_isobject
3434
3435 Returns a boolean indicating whether the SV is an RV pointing to a blessed
3436 object.  If the SV is not an RV, or if the object is not blessed, then this
3437 will return false.
3438
3439         int     sv_isobject(SV* sv)
3440
3441 =for hackers
3442 Found in file sv.c
3443
3444 =item sv_iv
3445
3446 A private implementation of the C<SvIVx> macro for compilers which can't
3447 cope with complex macro expressions. Always use the macro instead.
3448
3449         IV      sv_iv(SV* sv)
3450
3451 =for hackers
3452 Found in file sv.c
3453
3454 =item sv_len
3455
3456 Returns the length of the string in the SV. Handles magic and type
3457 coercion.  See also C<SvCUR>, which gives raw access to the xpv_cur slot.
3458
3459         STRLEN  sv_len(SV* sv)
3460
3461 =for hackers
3462 Found in file sv.c
3463
3464 =item sv_len_utf8
3465
3466 Returns the number of characters in the string in an SV, counting wide
3467 UTF8 bytes as a single character. Handles magic and type coercion.
3468
3469         STRLEN  sv_len_utf8(SV* sv)
3470
3471 =for hackers
3472 Found in file sv.c
3473
3474 =item sv_magic
3475
3476 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
3477 then adds a new magic item of type C<how> to the head of the magic list.
3478
3479 C<name> is assumed to contain an C<SV*> if C<(name && namelen == HEf_SVKEY)>
3480
3481         void    sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
3482
3483 =for hackers
3484 Found in file sv.c
3485
3486 =item sv_mortalcopy
3487
3488 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
3489 The new SV is marked as mortal. It will be destroyed "soon", either by an
3490 explicit call to FREETMPS, or by an implicit call at places such as
3491 statement boundaries.  See also C<sv_newmortal> and C<sv_2mortal>.
3492
3493         SV*     sv_mortalcopy(SV* oldsv)
3494
3495 =for hackers
3496 Found in file sv.c
3497
3498 =item sv_newmortal
3499
3500 Creates a new null SV which is mortal.  The reference count of the SV is
3501 set to 1. It will be destroyed "soon", either by an explicit call to
3502 FREETMPS, or by an implicit call at places such as statement boundaries.
3503 See also C<sv_mortalcopy> and C<sv_2mortal>.
3504
3505         SV*     sv_newmortal()
3506
3507 =for hackers
3508 Found in file sv.c
3509
3510 =item sv_newref
3511
3512 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
3513 instead.
3514
3515         SV*     sv_newref(SV* sv)
3516
3517 =for hackers
3518 Found in file sv.c
3519
3520 =item sv_nv
3521
3522 A private implementation of the C<SvNVx> macro for compilers which can't
3523 cope with complex macro expressions. Always use the macro instead.
3524
3525         NV      sv_nv(SV* sv)
3526
3527 =for hackers
3528 Found in file sv.c
3529
3530 =item sv_pos_b2u
3531
3532 Converts the value pointed to by offsetp from a count of bytes from the
3533 start of the string, to a count of the equivalent number of UTF8 chars.
3534 Handles magic and type coercion.
3535
3536         void    sv_pos_b2u(SV* sv, I32* offsetp)
3537
3538 =for hackers
3539 Found in file sv.c
3540
3541 =item sv_pos_u2b
3542
3543 Converts the value pointed to by offsetp from a count of UTF8 chars from
3544 the start of the string, to a count of the equivalent number of bytes; if
3545 lenp is non-zero, it does the same to lenp, but this time starting from
3546 the offset, rather than from the start of the string. Handles magic and
3547 type coercion.
3548
3549         void    sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
3550
3551 =for hackers
3552 Found in file sv.c
3553
3554 =item sv_pv
3555
3556 A private implementation of the C<SvPV_nolen> macro for compilers which can't
3557 cope with complex macro expressions. Always use the macro instead.
3558
3559         char*   sv_pv(SV *sv)
3560
3561 =for hackers
3562 Found in file sv.c
3563
3564 =item sv_pvbyte
3565
3566 A private implementation of the C<SvPVbyte_nolen> macro for compilers
3567 which can't cope with complex macro expressions. Always use the macro
3568 instead.
3569
3570         char*   sv_pvbyte(SV *sv)
3571
3572 =for hackers
3573 Found in file sv.c
3574
3575 =item sv_pvbyten
3576
3577 A private implementation of the C<SvPVbyte> macro for compilers
3578 which can't cope with complex macro expressions. Always use the macro
3579 instead.
3580
3581         char*   sv_pvbyten(SV *sv, STRLEN *len)
3582
3583 =for hackers
3584 Found in file sv.c
3585
3586 =item sv_pvbyten_force
3587
3588 A private implementation of the C<SvPVbytex_force> macro for compilers
3589 which can't cope with complex macro expressions. Always use the macro
3590 instead.
3591
3592         char*   sv_pvbyten_force(SV* sv, STRLEN* lp)
3593
3594 =for hackers
3595 Found in file sv.c
3596
3597 =item sv_pvn
3598
3599 A private implementation of the C<SvPV> macro for compilers which can't
3600 cope with complex macro expressions. Always use the macro instead.
3601
3602         char*   sv_pvn(SV *sv, STRLEN *len)
3603
3604 =for hackers
3605 Found in file sv.c
3606
3607 =item sv_pvn_force
3608
3609 Get a sensible string out of the SV somehow.
3610 A private implementation of the C<SvPV_force> macro for compilers which
3611 can't cope with complex macro expressions. Always use the macro instead.
3612
3613         char*   sv_pvn_force(SV* sv, STRLEN* lp)
3614
3615 =for hackers
3616 Found in file sv.c
3617
3618 =item sv_pvn_force_flags
3619
3620 Get a sensible string out of the SV somehow.
3621 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
3622 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
3623 implemented in terms of this function.
3624 You normally want to use the various wrapper macros instead: see
3625 C<SvPV_force> and C<SvPV_force_nomg>
3626
3627         char*   sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
3628
3629 =for hackers
3630 Found in file sv.c
3631
3632 =item sv_pvutf8
3633
3634 A private implementation of the C<SvPVutf8_nolen> macro for compilers
3635 which can't cope with complex macro expressions. Always use the macro
3636 instead.
3637
3638         char*   sv_pvutf8(SV *sv)
3639
3640 =for hackers
3641 Found in file sv.c
3642
3643 =item sv_pvutf8n
3644
3645 A private implementation of the C<SvPVutf8> macro for compilers
3646 which can't cope with complex macro expressions. Always use the macro
3647 instead.
3648
3649         char*   sv_pvutf8n(SV *sv, STRLEN *len)
3650
3651 =for hackers
3652 Found in file sv.c
3653
3654 =item sv_pvutf8n_force
3655
3656 A private implementation of the C<SvPVutf8_force> macro for compilers
3657 which can't cope with complex macro expressions. Always use the macro
3658 instead.
3659
3660         char*   sv_pvutf8n_force(SV* sv, STRLEN* lp)
3661
3662 =for hackers
3663 Found in file sv.c
3664
3665 =item sv_reftype
3666
3667 Returns a string describing what the SV is a reference to.
3668
3669         char*   sv_reftype(SV* sv, int ob)
3670
3671 =for hackers
3672 Found in file sv.c
3673
3674 =item sv_replace
3675
3676 Make the first argument a copy of the second, then delete the original.
3677 The target SV physically takes over ownership of the body of the source SV
3678 and inherits its flags; however, the target keeps any magic it owns,
3679 and any magic in the source is discarded.
3680 Note that this is a rather specialist SV copying operation; most of the
3681 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
3682
3683         void    sv_replace(SV* sv, SV* nsv)
3684
3685 =for hackers
3686 Found in file sv.c
3687
3688 =item sv_report_used
3689
3690 Dump the contents of all SVs not yet freed. (Debugging aid).
3691
3692         void    sv_report_used()
3693
3694 =for hackers
3695 Found in file sv.c
3696
3697 =item sv_reset
3698
3699 Underlying implementation for the C<reset> Perl function.
3700 Note that the perl-level function is vaguely deprecated.
3701
3702         void    sv_reset(char* s, HV* stash)
3703
3704 =for hackers
3705 Found in file sv.c
3706
3707 =item sv_rvweaken
3708
3709 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
3710 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
3711 push a back-reference to this RV onto the array of backreferences
3712 associated with that magic.
3713
3714         SV*     sv_rvweaken(SV *sv)
3715
3716 =for hackers
3717 Found in file sv.c
3718
3719 =item sv_setiv
3720
3721 Copies an integer into the given SV, upgrading first if necessary.
3722 Does not handle 'set' magic.  See also C<sv_setiv_mg>.
3723
3724         void    sv_setiv(SV* sv, IV num)
3725
3726 =for hackers
3727 Found in file sv.c
3728
3729 =item sv_setiv_mg
3730
3731 Like C<sv_setiv>, but also handles 'set' magic.
3732
3733         void    sv_setiv_mg(SV *sv, IV i)
3734
3735 =for hackers
3736 Found in file sv.c
3737
3738 =item sv_setnv
3739
3740 Copies a double into the given SV, upgrading first if necessary.
3741 Does not handle 'set' magic.  See also C<sv_setnv_mg>.
3742
3743         void    sv_setnv(SV* sv, NV num)
3744
3745 =for hackers
3746 Found in file sv.c
3747
3748 =item sv_setnv_mg
3749
3750 Like C<sv_setnv>, but also handles 'set' magic.
3751
3752         void    sv_setnv_mg(SV *sv, NV num)
3753
3754 =for hackers
3755 Found in file sv.c
3756
3757 =item sv_setpv
3758
3759 Copies a string into an SV.  The string must be null-terminated.  Does not
3760 handle 'set' magic.  See C<sv_setpv_mg>.
3761
3762         void    sv_setpv(SV* sv, const char* ptr)
3763
3764 =for hackers
3765 Found in file sv.c
3766
3767 =item sv_setpvf
3768
3769 Processes its arguments like C<sprintf> and sets an SV to the formatted
3770 output.  Does not handle 'set' magic.  See C<sv_setpvf_mg>.
3771
3772         void    sv_setpvf(SV* sv, const char* pat, ...)
3773
3774 =for hackers
3775 Found in file sv.c
3776
3777 =item sv_setpvf_mg
3778
3779 Like C<sv_setpvf>, but also handles 'set' magic.
3780
3781         void    sv_setpvf_mg(SV *sv, const char* pat, ...)
3782
3783 =for hackers
3784 Found in file sv.c
3785
3786 =item sv_setpviv
3787
3788 Copies an integer into the given SV, also updating its string value.
3789 Does not handle 'set' magic.  See C<sv_setpviv_mg>.
3790
3791         void    sv_setpviv(SV* sv, IV num)
3792
3793 =for hackers
3794 Found in file sv.c
3795
3796 =item sv_setpviv_mg
3797
3798 Like C<sv_setpviv>, but also handles 'set' magic.
3799
3800         void    sv_setpviv_mg(SV *sv, IV iv)
3801
3802 =for hackers
3803 Found in file sv.c
3804
3805 =item sv_setpvn
3806
3807 Copies a string into an SV.  The C<len> parameter indicates the number of
3808 bytes to be copied.  Does not handle 'set' magic.  See C<sv_setpvn_mg>.
3809
3810         void    sv_setpvn(SV* sv, const char* ptr, STRLEN len)
3811
3812 =for hackers
3813 Found in file sv.c
3814
3815 =item sv_setpvn_mg
3816
3817 Like C<sv_setpvn>, but also handles 'set' magic.
3818
3819         void    sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
3820
3821 =for hackers
3822 Found in file sv.c
3823
3824 =item sv_setpv_mg
3825
3826 Like C<sv_setpv>, but also handles 'set' magic.
3827
3828         void    sv_setpv_mg(SV *sv, const char *ptr)
3829
3830 =for hackers
3831 Found in file sv.c
3832
3833 =item sv_setref_iv
3834
3835 Copies an integer into a new SV, optionally blessing the SV.  The C<rv>
3836 argument will be upgraded to an RV.  That RV will be modified to point to
3837 the new SV.  The C<classname> argument indicates the package for the
3838 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
3839 will be returned and will have a reference count of 1.
3840
3841         SV*     sv_setref_iv(SV* rv, const char* classname, IV iv)
3842
3843 =for hackers
3844 Found in file sv.c
3845
3846 =item sv_setref_nv
3847
3848 Copies a double into a new SV, optionally blessing the SV.  The C<rv>
3849 argument will be upgraded to an RV.  That RV will be modified to point to
3850 the new SV.  The C<classname> argument indicates the package for the
3851 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
3852 will be returned and will have a reference count of 1.
3853
3854         SV*     sv_setref_nv(SV* rv, const char* classname, NV nv)
3855
3856 =for hackers
3857 Found in file sv.c
3858
3859 =item sv_setref_pv
3860
3861 Copies a pointer into a new SV, optionally blessing the SV.  The C<rv>
3862 argument will be upgraded to an RV.  That RV will be modified to point to
3863 the new SV.  If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
3864 into the SV.  The C<classname> argument indicates the package for the
3865 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
3866 will be returned and will have a reference count of 1.
3867
3868 Do not use with other Perl types such as HV, AV, SV, CV, because those
3869 objects will become corrupted by the pointer copy process.
3870
3871 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
3872
3873         SV*     sv_setref_pv(SV* rv, const char* classname, void* pv)
3874
3875 =for hackers
3876 Found in file sv.c
3877
3878 =item sv_setref_pvn
3879
3880 Copies a string into a new SV, optionally blessing the SV.  The length of the
3881 string must be specified with C<n>.  The C<rv> argument will be upgraded to
3882 an RV.  That RV will be modified to point to the new SV.  The C<classname>
3883 argument indicates the package for the blessing.  Set C<classname> to
3884 C<Nullch> to avoid the blessing.  The new SV will be returned and will have
3885 a reference count of 1.
3886
3887 Note that C<sv_setref_pv> copies the pointer while this copies the string.
3888
3889         SV*     sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
3890
3891 =for hackers
3892 Found in file sv.c
3893
3894 =item sv_setref_uv
3895
3896 Copies an unsigned integer into a new SV, optionally blessing the SV.  The C<rv>
3897 argument will be upgraded to an RV.  That RV will be modified to point to
3898 the new SV.  The C<classname> argument indicates the package for the
3899 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
3900 will be returned and will have a reference count of 1.
3901
3902         SV*     sv_setref_uv(SV* rv, const char* classname, UV uv)
3903
3904 =for hackers
3905 Found in file sv.c
3906
3907 =item sv_setsv
3908
3909 Copies the contents of the source SV C<ssv> into the destination SV
3910 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
3911 function if the source SV needs to be reused. Does not handle 'set' magic.
3912 Loosely speaking, it performs a copy-by-value, obliterating any previous
3913 content of the destination.
3914
3915 You probably want to use one of the assortment of wrappers, such as
3916 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3917 C<SvSetMagicSV_nosteal>.
3918
3919
3920         void    sv_setsv(SV* dsv, SV* ssv)
3921
3922 =for hackers
3923 Found in file sv.c
3924
3925 =item sv_setsv_flags
3926
3927 Copies the contents of the source SV C<ssv> into the destination SV
3928 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
3929 function if the source SV needs to be reused. Does not handle 'set' magic.
3930 Loosely speaking, it performs a copy-by-value, obliterating any previous
3931 content of the destination.
3932 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
3933 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
3934 implemented in terms of this function.
3935
3936 You probably want to use one of the assortment of wrappers, such as
3937 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
3938 C<SvSetMagicSV_nosteal>.
3939
3940 This is the primary function for copying scalars, and most other
3941 copy-ish functions and macros use this underneath.
3942
3943         void    sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
3944
3945 =for hackers
3946 Found in file sv.c
3947
3948 =item sv_setsv_mg
3949
3950 Like C<sv_setsv>, but also handles 'set' magic.
3951
3952         void    sv_setsv_mg(SV *dstr, SV *sstr)
3953
3954 =for hackers
3955 Found in file sv.c
3956
3957 =item sv_setuv
3958
3959 Copies an unsigned integer into the given SV, upgrading first if necessary.
3960 Does not handle 'set' magic.  See also C<sv_setuv_mg>.
3961
3962         void    sv_setuv(SV* sv, UV num)
3963
3964 =for hackers
3965 Found in file sv.c
3966
3967 =item sv_setuv_mg
3968
3969 Like C<sv_setuv>, but also handles 'set' magic.
3970
3971         void    sv_setuv_mg(SV *sv, UV u)
3972
3973 =for hackers
3974 Found in file sv.c
3975
3976 =item sv_taint
3977
3978 Taint an SV. Use C<SvTAINTED_on> instead.
3979         void    sv_taint(SV* sv)
3980
3981 =for hackers
3982 Found in file sv.c
3983
3984 =item sv_tainted
3985
3986 Test an SV for taintedness. Use C<SvTAINTED> instead.
3987         bool    sv_tainted(SV* sv)
3988
3989 =for hackers
3990 Found in file sv.c
3991
3992 =item sv_true
3993
3994 Returns true if the SV has a true value by Perl's rules.
3995 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
3996 instead use an in-line version.
3997
3998         I32     sv_true(SV *sv)
3999
4000 =for hackers
4001 Found in file sv.c
4002
4003 =item sv_unmagic
4004
4005 Removes all magic of type C<type> from an SV.
4006
4007         int     sv_unmagic(SV* sv, int type)
4008
4009 =for hackers
4010 Found in file sv.c
4011
4012 =item sv_unref
4013
4014 Unsets the RV status of the SV, and decrements the reference count of
4015 whatever was being referenced by the RV.  This can almost be thought of
4016 as a reversal of C<newSVrv>.  This is C<sv_unref_flags> with the C<flag>
4017 being zero.  See C<SvROK_off>.
4018
4019         void    sv_unref(SV* sv)
4020
4021 =for hackers
4022 Found in file sv.c
4023
4024 =item sv_unref_flags
4025
4026 Unsets the RV status of the SV, and decrements the reference count of
4027 whatever was being referenced by the RV.  This can almost be thought of
4028 as a reversal of C<newSVrv>.  The C<cflags> argument can contain
4029 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
4030 (otherwise the decrementing is conditional on the reference count being
4031 different from one or the reference being a readonly SV).
4032 See C<SvROK_off>.
4033
4034         void    sv_unref_flags(SV* sv, U32 flags)
4035
4036 =for hackers
4037 Found in file sv.c
4038
4039 =item sv_untaint
4040
4041 Untaint an SV. Use C<SvTAINTED_off> instead.
4042         void    sv_untaint(SV* sv)
4043
4044 =for hackers
4045 Found in file sv.c
4046
4047 =item sv_upgrade
4048
4049 Upgrade an SV to a more complex form.  Generally adds a new body type to the
4050 SV, then copies across as much information as possible from the old body.
4051 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
4052
4053         bool    sv_upgrade(SV* sv, U32 mt)
4054
4055 =for hackers
4056 Found in file sv.c
4057
4058 =item sv_usepvn
4059
4060 Tells an SV to use C<ptr> to find its string value.  Normally the string is
4061 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4062 The C<ptr> should point to memory that was allocated by C<malloc>.  The
4063 string length, C<len>, must be supplied.  This function will realloc the
4064 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4065 the programmer after giving it to sv_usepvn.  Does not handle 'set' magic.
4066 See C<sv_usepvn_mg>.
4067
4068         void    sv_usepvn(SV* sv, char* ptr, STRLEN len)
4069
4070 =for hackers
4071 Found in file sv.c
4072
4073 =item sv_usepvn_mg
4074
4075 Like C<sv_usepvn>, but also handles 'set' magic.
4076
4077         void    sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
4078
4079 =for hackers
4080 Found in file sv.c
4081
4082 =item sv_utf8_decode
4083
4084 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
4085 turn off SvUTF8 if needed so that we see characters. Used as a building block
4086 for decode_utf8 in Encode.xs
4087
4088 NOTE: this function is experimental and may change or be
4089 removed without notice.
4090
4091         bool    sv_utf8_decode(SV *sv)
4092
4093 =for hackers
4094 Found in file sv.c
4095
4096 =item sv_utf8_downgrade
4097
4098 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
4099 This may not be possible if the PV contains non-byte encoding characters;
4100 if this is the case, either returns false or, if C<fail_ok> is not
4101 true, croaks.
4102
4103 NOTE: this function is experimental and may change or be
4104 removed without notice.
4105
4106         bool    sv_utf8_downgrade(SV *sv, bool fail_ok)
4107
4108 =for hackers
4109 Found in file sv.c
4110
4111 =item sv_utf8_encode
4112
4113 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
4114 flag so that it looks like octets again. Used as a building block
4115 for encode_utf8 in Encode.xs
4116
4117         void    sv_utf8_encode(SV *sv)
4118
4119 =for hackers
4120 Found in file sv.c
4121
4122 =item sv_utf8_upgrade
4123
4124 Convert the PV of an SV to its UTF8-encoded form.
4125 Forces the SV to string form if it is not already.
4126 Always sets the SvUTF8 flag to avoid future validity checks even
4127 if all the bytes have hibit clear.
4128
4129         STRLEN  sv_utf8_upgrade(SV *sv)
4130
4131 =for hackers
4132 Found in file sv.c
4133
4134 =item sv_utf8_upgrade_flags
4135
4136 Convert the PV of an SV to its UTF8-encoded form.
4137 Forces the SV to string form if it is not already.
4138 Always sets the SvUTF8 flag to avoid future validity checks even
4139 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
4140 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
4141 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
4142
4143         STRLEN  sv_utf8_upgrade_flags(SV *sv, I32 flags)
4144
4145 =for hackers
4146 Found in file sv.c
4147
4148 =item sv_uv
4149
4150 A private implementation of the C<SvUVx> macro for compilers which can't
4151 cope with complex macro expressions. Always use the macro instead.
4152
4153         UV      sv_uv(SV* sv)
4154
4155 =for hackers
4156 Found in file sv.c
4157
4158 =item sv_vcatpvfn
4159
4160 Processes its arguments like C<vsprintf> and appends the formatted output
4161 to an SV.  Uses an array of SVs if the C style variable argument list is
4162 missing (NULL).  When running with taint checks enabled, indicates via
4163 C<maybe_tainted> if results are untrustworthy (often due to the use of
4164 locales).
4165
4166 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
4167
4168         void    sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4169
4170 =for hackers
4171 Found in file sv.c
4172
4173 =item sv_vsetpvfn
4174
4175 Works like C<vcatpvfn> but copies the text into the SV instead of
4176 appending it.
4177
4178 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
4179
4180         void    sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4181
4182 =for hackers
4183 Found in file sv.c
4184
4185 =item THIS
4186
4187 Variable which is setup by C<xsubpp> to designate the object in a C++ 
4188 XSUB.  This is always the proper type for the C++ object.  See C<CLASS> and 
4189 L<perlxs/"Using XS With C++">.
4190
4191         (whatever)      THIS
4192
4193 =for hackers
4194 Found in file XSUB.h
4195
4196 =item toLOWER
4197
4198 Converts the specified character to lowercase.
4199
4200         char    toLOWER(char ch)
4201
4202 =for hackers
4203 Found in file handy.h
4204
4205 =item toUPPER
4206
4207 Converts the specified character to uppercase.
4208
4209         char    toUPPER(char ch)
4210
4211 =for hackers
4212 Found in file handy.h
4213
4214 =item utf8n_to_uvchr
4215
4216 Returns the native character value of the first character in the string C<s>
4217 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4218 length, in bytes, of that character.
4219
4220 Allows length and flags to be passed to low level routine.
4221
4222         UV      utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4223
4224 =for hackers
4225 Found in file utf8.c
4226
4227 =item utf8n_to_uvuni
4228
4229 Bottom level UTF-8 decode routine.
4230 Returns the unicode code point value of the first character in the string C<s>
4231 which is assumed to be in UTF8 encoding and no longer than C<curlen>;
4232 C<retlen> will be set to the length, in bytes, of that character.
4233
4234 If C<s> does not point to a well-formed UTF8 character, the behaviour
4235 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
4236 it is assumed that the caller will raise a warning, and this function
4237 will silently just set C<retlen> to C<-1> and return zero.  If the
4238 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
4239 malformations will be given, C<retlen> will be set to the expected
4240 length of the UTF-8 character in bytes, and zero will be returned.
4241
4242 The C<flags> can also contain various flags to allow deviations from
4243 the strict UTF-8 encoding (see F<utf8.h>).
4244
4245 Most code should use utf8_to_uvchr() rather than call this directly.
4246
4247         UV      utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4248
4249 =for hackers
4250 Found in file utf8.c
4251
4252 =item utf8_distance
4253
4254 Returns the number of UTF8 characters between the UTF-8 pointers C<a>
4255 and C<b>.
4256
4257 WARNING: use only if you *know* that the pointers point inside the
4258 same UTF-8 buffer.
4259
4260         IV      utf8_distance(U8 *a, U8 *b)
4261
4262 =for hackers
4263 Found in file utf8.c
4264
4265 =item utf8_hop
4266
4267 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
4268 forward or backward.
4269
4270 WARNING: do not use the following unless you *know* C<off> is within
4271 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
4272 on the first byte of character or just after the last byte of a character.
4273
4274         U8*     utf8_hop(U8 *s, I32 off)
4275
4276 =for hackers
4277 Found in file utf8.c
4278
4279 =item utf8_length
4280
4281 Return the length of the UTF-8 char encoded string C<s> in characters.
4282 Stops at C<e> (inclusive).  If C<e E<lt> s> or if the scan would end
4283 up past C<e>, croaks.
4284
4285         STRLEN  utf8_length(U8* s, U8 *e)
4286
4287 =for hackers
4288 Found in file utf8.c
4289
4290 =item utf8_to_bytes
4291
4292 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
4293 Unlike C<bytes_to_utf8>, this over-writes the original string, and
4294 updates len to contain the new length.
4295 Returns zero on failure, setting C<len> to -1.
4296
4297 NOTE: this function is experimental and may change or be
4298 removed without notice.
4299
4300         U8*     utf8_to_bytes(U8 *s, STRLEN *len)
4301
4302 =for hackers
4303 Found in file utf8.c
4304
4305 =item utf8_to_uvchr
4306
4307 Returns the native character value of the first character in the string C<s>
4308 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4309 length, in bytes, of that character.
4310
4311 If C<s> does not point to a well-formed UTF8 character, zero is
4312 returned and retlen is set, if possible, to -1.
4313
4314         UV      utf8_to_uvchr(U8 *s, STRLEN* retlen)
4315
4316 =for hackers
4317 Found in file utf8.c
4318
4319 =item utf8_to_uvuni
4320
4321 Returns the Unicode code point of the first character in the string C<s>
4322 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4323 length, in bytes, of that character.
4324
4325 This function should only be used when returned UV is considered
4326 an index into the Unicode semantic tables (e.g. swashes).
4327
4328 If C<s> does not point to a well-formed UTF8 character, zero is
4329 returned and retlen is set, if possible, to -1.
4330
4331         UV      utf8_to_uvuni(U8 *s, STRLEN* retlen)
4332
4333 =for hackers
4334 Found in file utf8.c
4335
4336 =item uvchr_to_utf8
4337
4338 Adds the UTF8 representation of the Native codepoint C<uv> to the end
4339 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
4340 bytes available. The return value is the pointer to the byte after the
4341 end of the new character. In other words,
4342
4343     d = uvchr_to_utf8(d, uv);
4344
4345 is the recommended wide native character-aware way of saying
4346
4347     *(d++) = uv;
4348
4349         U8*     uvchr_to_utf8(U8 *d, UV uv)
4350
4351 =for hackers
4352 Found in file utf8.c
4353
4354 =item uvuni_to_utf8
4355
4356 Adds the UTF8 representation of the Unicode codepoint C<uv> to the end
4357 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
4358 bytes available. The return value is the pointer to the byte after the
4359 end of the new character. In other words,
4360
4361     d = uvuni_to_utf8(d, uv);
4362
4363 is the recommended Unicode-aware way of saying
4364
4365     *(d++) = uv;
4366
4367         U8*     uvuni_to_utf8(U8 *d, UV uv)
4368
4369 =for hackers
4370 Found in file utf8.c
4371
4372 =item warn
4373
4374 This is the XSUB-writer's interface to Perl's C<warn> function.  Use this
4375 function the same way you use the C C<printf> function.  See
4376 C<croak>.
4377
4378         void    warn(const char* pat, ...)
4379
4380 =for hackers
4381 Found in file util.c
4382
4383 =item XPUSHi
4384
4385 Push an integer onto the stack, extending the stack if necessary.  Handles
4386 'set' magic. See C<PUSHi>.
4387
4388         void    XPUSHi(IV iv)
4389
4390 =for hackers
4391 Found in file pp.h
4392
4393 =item XPUSHn
4394
4395 Push a double onto the stack, extending the stack if necessary.  Handles
4396 'set' magic.  See C<PUSHn>.
4397
4398         void    XPUSHn(NV nv)
4399
4400 =for hackers
4401 Found in file pp.h
4402
4403 =item XPUSHp
4404
4405 Push a string onto the stack, extending the stack if necessary.  The C<len>
4406 indicates the length of the string.  Handles 'set' magic.  See
4407 C<PUSHp>.
4408
4409         void    XPUSHp(char* str, STRLEN len)
4410
4411 =for hackers
4412 Found in file pp.h
4413
4414 =item XPUSHs
4415
4416 Push an SV onto the stack, extending the stack if necessary.  Does not
4417 handle 'set' magic.  See C<PUSHs>.
4418
4419         void    XPUSHs(SV* sv)
4420
4421 =for hackers
4422 Found in file pp.h
4423
4424 =item XPUSHu
4425
4426 Push an unsigned integer onto the stack, extending the stack if necessary.
4427 See C<PUSHu>.
4428
4429         void    XPUSHu(UV uv)
4430
4431 =for hackers
4432 Found in file pp.h
4433
4434 =item XS
4435
4436 Macro to declare an XSUB and its C parameter list.  This is handled by
4437 C<xsubpp>.
4438
4439 =for hackers
4440 Found in file XSUB.h
4441
4442 =item XSRETURN
4443
4444 Return from XSUB, indicating number of items on the stack.  This is usually
4445 handled by C<xsubpp>.
4446
4447         void    XSRETURN(int nitems)
4448
4449 =for hackers
4450 Found in file XSUB.h
4451
4452 =item XSRETURN_EMPTY
4453
4454 Return an empty list from an XSUB immediately.
4455
4456                 XSRETURN_EMPTY;
4457
4458 =for hackers
4459 Found in file XSUB.h
4460
4461 =item XSRETURN_IV
4462
4463 Return an integer from an XSUB immediately.  Uses C<XST_mIV>.
4464
4465         void    XSRETURN_IV(IV iv)
4466
4467 =for hackers
4468 Found in file XSUB.h
4469
4470 =item XSRETURN_NO
4471
4472 Return C<&PL_sv_no> from an XSUB immediately.  Uses C<XST_mNO>.
4473
4474                 XSRETURN_NO;
4475
4476 =for hackers
4477 Found in file XSUB.h
4478
4479 =item XSRETURN_NV
4480
4481 Return an double from an XSUB immediately.  Uses C<XST_mNV>.
4482
4483         void    XSRETURN_NV(NV nv)
4484
4485 =for hackers
4486 Found in file XSUB.h
4487
4488 =item XSRETURN_PV
4489
4490 Return a copy of a string from an XSUB immediately.  Uses C<XST_mPV>.
4491
4492         void    XSRETURN_PV(char* str)
4493
4494 =for hackers
4495 Found in file XSUB.h
4496
4497 =item XSRETURN_UNDEF
4498
4499 Return C<&PL_sv_undef> from an XSUB immediately.  Uses C<XST_mUNDEF>.
4500
4501                 XSRETURN_UNDEF;
4502
4503 =for hackers
4504 Found in file XSUB.h
4505
4506 =item XSRETURN_YES
4507
4508 Return C<&PL_sv_yes> from an XSUB immediately.  Uses C<XST_mYES>.
4509
4510                 XSRETURN_YES;
4511
4512 =for hackers
4513 Found in file XSUB.h
4514
4515 =item XST_mIV
4516
4517 Place an integer into the specified position C<pos> on the stack.  The
4518 value is stored in a new mortal SV.
4519
4520         void    XST_mIV(int pos, IV iv)
4521
4522 =for hackers
4523 Found in file XSUB.h
4524
4525 =item XST_mNO
4526
4527 Place C<&PL_sv_no> into the specified position C<pos> on the
4528 stack.
4529
4530         void    XST_mNO(int pos)
4531
4532 =for hackers
4533 Found in file XSUB.h
4534
4535 =item XST_mNV
4536
4537 Place a double into the specified position C<pos> on the stack.  The value
4538 is stored in a new mortal SV.
4539
4540         void    XST_mNV(int pos, NV nv)
4541
4542 =for hackers
4543 Found in file XSUB.h
4544
4545 =item XST_mPV
4546
4547 Place a copy of a string into the specified position C<pos> on the stack. 
4548 The value is stored in a new mortal SV.
4549
4550         void    XST_mPV(int pos, char* str)
4551
4552 =for hackers
4553 Found in file XSUB.h
4554
4555 =item XST_mUNDEF
4556
4557 Place C<&PL_sv_undef> into the specified position C<pos> on the
4558 stack.
4559
4560         void    XST_mUNDEF(int pos)
4561
4562 =for hackers
4563 Found in file XSUB.h
4564
4565 =item XST_mYES
4566
4567 Place C<&PL_sv_yes> into the specified position C<pos> on the
4568 stack.
4569
4570         void    XST_mYES(int pos)
4571
4572 =for hackers
4573 Found in file XSUB.h
4574
4575 =item XS_VERSION
4576
4577 The version identifier for an XS module.  This is usually
4578 handled automatically by C<ExtUtils::MakeMaker>.  See C<XS_VERSION_BOOTCHECK>.
4579
4580 =for hackers
4581 Found in file XSUB.h
4582
4583 =item XS_VERSION_BOOTCHECK
4584
4585 Macro to verify that a PM module's $VERSION variable matches the XS
4586 module's C<XS_VERSION> variable.  This is usually handled automatically by
4587 C<xsubpp>.  See L<perlxs/"The VERSIONCHECK: Keyword">.
4588
4589                 XS_VERSION_BOOTCHECK;
4590
4591 =for hackers
4592 Found in file XSUB.h
4593
4594 =item Zero
4595
4596 The XSUB-writer's interface to the C C<memzero> function.  The C<dest> is the
4597 destination, C<nitems> is the number of items, and C<type> is the type.
4598
4599         void    Zero(void* dest, int nitems, type)
4600
4601 =for hackers
4602 Found in file handy.h
4603
4604 =back
4605
4606 =head1 AUTHORS
4607
4608 Until May 1997, this document was maintained by Jeff Okamoto
4609 <okamoto@corp.hp.com>.  It is now maintained as part of Perl itself.
4610
4611 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
4612 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
4613 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
4614 Stephen McCamant, and Gurusamy Sarathy.
4615
4616 API Listing originally by Dean Roehrich <roehrich@cray.com>.
4617
4618 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
4619
4620 =head1 SEE ALSO
4621
4622 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
4623