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