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