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