This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Regen perlapi.
[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_UV
2424
2425 Return an integer from an XSUB immediately.  Uses C<XST_mUV>.
2426
2427         void    XSRETURN_UV(IV uv)
2428
2429 =for hackers
2430 Found in file XSUB.h
2431
2432 =item XSRETURN_YES
2433
2434 Return C<&PL_sv_yes> from an XSUB immediately.  Uses C<XST_mYES>.
2435
2436                 XSRETURN_YES;
2437
2438 =for hackers
2439 Found in file XSUB.h
2440
2441 =item XST_mIV
2442
2443 Place an integer into the specified position C<pos> on the stack.  The
2444 value is stored in a new mortal SV.
2445
2446         void    XST_mIV(int pos, IV iv)
2447
2448 =for hackers
2449 Found in file XSUB.h
2450
2451 =item XST_mNO
2452
2453 Place C<&PL_sv_no> into the specified position C<pos> on the
2454 stack.
2455
2456         void    XST_mNO(int pos)
2457
2458 =for hackers
2459 Found in file XSUB.h
2460
2461 =item XST_mNV
2462
2463 Place a double into the specified position C<pos> on the stack.  The value
2464 is stored in a new mortal SV.
2465
2466         void    XST_mNV(int pos, NV nv)
2467
2468 =for hackers
2469 Found in file XSUB.h
2470
2471 =item XST_mPV
2472
2473 Place a copy of a string into the specified position C<pos> on the stack. 
2474 The value is stored in a new mortal SV.
2475
2476         void    XST_mPV(int pos, char* str)
2477
2478 =for hackers
2479 Found in file XSUB.h
2480
2481 =item XST_mUNDEF
2482
2483 Place C<&PL_sv_undef> into the specified position C<pos> on the
2484 stack.
2485
2486         void    XST_mUNDEF(int pos)
2487
2488 =for hackers
2489 Found in file XSUB.h
2490
2491 =item XST_mYES
2492
2493 Place C<&PL_sv_yes> into the specified position C<pos> on the
2494 stack.
2495
2496         void    XST_mYES(int pos)
2497
2498 =for hackers
2499 Found in file XSUB.h
2500
2501
2502 =back
2503
2504 =head1 SV Flags
2505
2506 =over 8
2507
2508 =item svtype
2509
2510 An enum of flags for Perl types.  These are found in the file B<sv.h>
2511 in the C<svtype> enum.  Test these flags with the C<SvTYPE> macro.
2512
2513 =for hackers
2514 Found in file sv.h
2515
2516 =item SVt_IV
2517
2518 Integer type flag for scalars.  See C<svtype>.
2519
2520 =for hackers
2521 Found in file sv.h
2522
2523 =item SVt_NV
2524
2525 Double type flag for scalars.  See C<svtype>.
2526
2527 =for hackers
2528 Found in file sv.h
2529
2530 =item SVt_PV
2531
2532 Pointer type flag for scalars.  See C<svtype>.
2533
2534 =for hackers
2535 Found in file sv.h
2536
2537 =item SVt_PVAV
2538
2539 Type flag for arrays.  See C<svtype>.
2540
2541 =for hackers
2542 Found in file sv.h
2543
2544 =item SVt_PVCV
2545
2546 Type flag for code refs.  See C<svtype>.
2547
2548 =for hackers
2549 Found in file sv.h
2550
2551 =item SVt_PVHV
2552
2553 Type flag for hashes.  See C<svtype>.
2554
2555 =for hackers
2556 Found in file sv.h
2557
2558 =item SVt_PVMG
2559
2560 Type flag for blessed scalars.  See C<svtype>.
2561
2562 =for hackers
2563 Found in file sv.h
2564
2565
2566 =back
2567
2568 =head1 SV Manipulation Functions
2569
2570 =over 8
2571
2572 =item get_sv
2573
2574 Returns the SV of the specified Perl scalar.  If C<create> is set and the
2575 Perl variable does not exist then it will be created.  If C<create> is not
2576 set and the variable does not exist then NULL is returned.
2577
2578 NOTE: the perl_ form of this function is deprecated.
2579
2580         SV*     get_sv(const char* name, I32 create)
2581
2582 =for hackers
2583 Found in file perl.c
2584
2585 =item looks_like_number
2586
2587 Test if the content of an SV looks like a number (or is a number).
2588 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
2589 non-numeric warning), even if your atof() doesn't grok them.
2590
2591         I32     looks_like_number(SV* sv)
2592
2593 =for hackers
2594 Found in file sv.c
2595
2596 =item newRV_inc
2597
2598 Creates an RV wrapper for an SV.  The reference count for the original SV is
2599 incremented.
2600
2601         SV*     newRV_inc(SV* sv)
2602
2603 =for hackers
2604 Found in file sv.h
2605
2606 =item newRV_noinc
2607
2608 Creates an RV wrapper for an SV.  The reference count for the original
2609 SV is B<not> incremented.
2610
2611         SV*     newRV_noinc(SV *sv)
2612
2613 =for hackers
2614 Found in file sv.c
2615
2616 =item newSV
2617
2618 Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
2619 with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
2620 macro.
2621
2622         SV*     newSV(STRLEN len)
2623
2624 =for hackers
2625 Found in file sv.c
2626
2627 =item newSViv
2628
2629 Creates a new SV and copies an integer into it.  The reference count for the
2630 SV is set to 1.
2631
2632         SV*     newSViv(IV i)
2633
2634 =for hackers
2635 Found in file sv.c
2636
2637 =item newSVnv
2638
2639 Creates a new SV and copies a floating point value into it.
2640 The reference count for the SV is set to 1.
2641
2642         SV*     newSVnv(NV n)
2643
2644 =for hackers
2645 Found in file sv.c
2646
2647 =item newSVpv
2648
2649 Creates a new SV and copies a string into it.  The reference count for the
2650 SV is set to 1.  If C<len> is zero, Perl will compute the length using
2651 strlen().  For efficiency, consider using C<newSVpvn> instead.
2652
2653         SV*     newSVpv(const char* s, STRLEN len)
2654
2655 =for hackers
2656 Found in file sv.c
2657
2658 =item newSVpvf
2659
2660 Creates a new SV and initializes it with the string formatted like
2661 C<sprintf>.
2662
2663         SV*     newSVpvf(const char* pat, ...)
2664
2665 =for hackers
2666 Found in file sv.c
2667
2668 =item newSVpvn
2669
2670 Creates a new SV and copies a string into it.  The reference count for the
2671 SV is set to 1.  Note that if C<len> is zero, Perl will create a zero length
2672 string.  You are responsible for ensuring that the source string is at least
2673 C<len> bytes long.
2674
2675         SV*     newSVpvn(const char* s, STRLEN len)
2676
2677 =for hackers
2678 Found in file sv.c
2679
2680 =item newSVpvn_share
2681
2682 Creates a new SV with its SvPVX pointing to a shared string in the string
2683 table. If the string does not already exist in the table, it is created
2684 first.  Turns on READONLY and FAKE.  The string's hash is stored in the UV
2685 slot of the SV; if the C<hash> parameter is non-zero, that value is used;
2686 otherwise the hash is computed.  The idea here is that as the string table
2687 is used for shared hash keys these strings will have SvPVX == HeKEY and
2688 hash lookup will avoid string compare.
2689
2690         SV*     newSVpvn_share(const char* s, I32 len, U32 hash)
2691
2692 =for hackers
2693 Found in file sv.c
2694
2695 =item newSVrv
2696
2697 Creates a new SV for the RV, C<rv>, to point to.  If C<rv> is not an RV then
2698 it will be upgraded to one.  If C<classname> is non-null then the new SV will
2699 be blessed in the specified package.  The new SV is returned and its
2700 reference count is 1.
2701
2702         SV*     newSVrv(SV* rv, const char* classname)
2703
2704 =for hackers
2705 Found in file sv.c
2706
2707 =item newSVsv
2708
2709 Creates a new SV which is an exact duplicate of the original SV.
2710 (Uses C<sv_setsv>).
2711
2712         SV*     newSVsv(SV* old)
2713
2714 =for hackers
2715 Found in file sv.c
2716
2717 =item newSVuv
2718
2719 Creates a new SV and copies an unsigned integer into it.
2720 The reference count for the SV is set to 1.
2721
2722         SV*     newSVuv(UV u)
2723
2724 =for hackers
2725 Found in file sv.c
2726
2727 =item SvCUR
2728
2729 Returns the length of the string which is in the SV.  See C<SvLEN>.
2730
2731         STRLEN  SvCUR(SV* sv)
2732
2733 =for hackers
2734 Found in file sv.h
2735
2736 =item SvCUR_set
2737
2738 Set the length of the string which is in the SV.  See C<SvCUR>.
2739
2740         void    SvCUR_set(SV* sv, STRLEN len)
2741
2742 =for hackers
2743 Found in file sv.h
2744
2745 =item SvEND
2746
2747 Returns a pointer to the last character in the string which is in the SV.
2748 See C<SvCUR>.  Access the character as *(SvEND(sv)).
2749
2750         char*   SvEND(SV* sv)
2751
2752 =for hackers
2753 Found in file sv.h
2754
2755 =item SvGROW
2756
2757 Expands the character buffer in the SV so that it has room for the
2758 indicated number of bytes (remember to reserve space for an extra trailing
2759 NUL character).  Calls C<sv_grow> to perform the expansion if necessary.
2760 Returns a pointer to the character buffer.
2761
2762         char *  SvGROW(SV* sv, STRLEN len)
2763
2764 =for hackers
2765 Found in file sv.h
2766
2767 =item SvIOK
2768
2769 Returns a boolean indicating whether the SV contains an integer.
2770
2771         bool    SvIOK(SV* sv)
2772
2773 =for hackers
2774 Found in file sv.h
2775
2776 =item SvIOKp
2777
2778 Returns a boolean indicating whether the SV contains an integer.  Checks
2779 the B<private> setting.  Use C<SvIOK>.
2780
2781         bool    SvIOKp(SV* sv)
2782
2783 =for hackers
2784 Found in file sv.h
2785
2786 =item SvIOK_notUV
2787
2788 Returns a boolean indicating whether the SV contains a signed integer.
2789
2790         void    SvIOK_notUV(SV* sv)
2791
2792 =for hackers
2793 Found in file sv.h
2794
2795 =item SvIOK_off
2796
2797 Unsets the IV status of an SV.
2798
2799         void    SvIOK_off(SV* sv)
2800
2801 =for hackers
2802 Found in file sv.h
2803
2804 =item SvIOK_on
2805
2806 Tells an SV that it is an integer.
2807
2808         void    SvIOK_on(SV* sv)
2809
2810 =for hackers
2811 Found in file sv.h
2812
2813 =item SvIOK_only
2814
2815 Tells an SV that it is an integer and disables all other OK bits.
2816
2817         void    SvIOK_only(SV* sv)
2818
2819 =for hackers
2820 Found in file sv.h
2821
2822 =item SvIOK_only_UV
2823
2824 Tells and SV that it is an unsigned integer and disables all other OK bits.
2825
2826         void    SvIOK_only_UV(SV* sv)
2827
2828 =for hackers
2829 Found in file sv.h
2830
2831 =item SvIOK_UV
2832
2833 Returns a boolean indicating whether the SV contains an unsigned integer.
2834
2835         void    SvIOK_UV(SV* sv)
2836
2837 =for hackers
2838 Found in file sv.h
2839
2840 =item SvIsCOW
2841
2842 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
2843 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
2844 COW)
2845
2846         bool    SvIsCOW(SV* sv)
2847
2848 =for hackers
2849 Found in file sv.h
2850
2851 =item SvIsCOW_shared_hash
2852
2853 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
2854 scalar.
2855
2856         bool    SvIsCOW_shared_hash(SV* sv)
2857
2858 =for hackers
2859 Found in file sv.h
2860
2861 =item SvIV
2862
2863 Coerces the given SV to an integer and returns it. See  C<SvIVx> for a
2864 version which guarantees to evaluate sv only once.
2865
2866         IV      SvIV(SV* sv)
2867
2868 =for hackers
2869 Found in file sv.h
2870
2871 =item SvIVx
2872
2873 Coerces the given SV to an integer and returns it. Guarantees to evaluate
2874 sv only once. Use the more efficient C<SvIV> otherwise.
2875
2876         IV      SvIVx(SV* sv)
2877
2878 =for hackers
2879 Found in file sv.h
2880
2881 =item SvIVX
2882
2883 Returns the raw value in the SV's IV slot, without checks or conversions.
2884 Only use when you are sure SvIOK is true. See also C<SvIV()>.
2885
2886         IV      SvIVX(SV* sv)
2887
2888 =for hackers
2889 Found in file sv.h
2890
2891 =item SvLEN
2892
2893 Returns the size of the string buffer in the SV, not including any part
2894 attributable to C<SvOOK>.  See C<SvCUR>.
2895
2896         STRLEN  SvLEN(SV* sv)
2897
2898 =for hackers
2899 Found in file sv.h
2900
2901 =item SvNIOK
2902
2903 Returns a boolean indicating whether the SV contains a number, integer or
2904 double.
2905
2906         bool    SvNIOK(SV* sv)
2907
2908 =for hackers
2909 Found in file sv.h
2910
2911 =item SvNIOKp
2912
2913 Returns a boolean indicating whether the SV contains a number, integer or
2914 double.  Checks the B<private> setting.  Use C<SvNIOK>.
2915
2916         bool    SvNIOKp(SV* sv)
2917
2918 =for hackers
2919 Found in file sv.h
2920
2921 =item SvNIOK_off
2922
2923 Unsets the NV/IV status of an SV.
2924
2925         void    SvNIOK_off(SV* sv)
2926
2927 =for hackers
2928 Found in file sv.h
2929
2930 =item SvNOK
2931
2932 Returns a boolean indicating whether the SV contains a double.
2933
2934         bool    SvNOK(SV* sv)
2935
2936 =for hackers
2937 Found in file sv.h
2938
2939 =item SvNOKp
2940
2941 Returns a boolean indicating whether the SV contains a double.  Checks the
2942 B<private> setting.  Use C<SvNOK>.
2943
2944         bool    SvNOKp(SV* sv)
2945
2946 =for hackers
2947 Found in file sv.h
2948
2949 =item SvNOK_off
2950
2951 Unsets the NV status of an SV.
2952
2953         void    SvNOK_off(SV* sv)
2954
2955 =for hackers
2956 Found in file sv.h
2957
2958 =item SvNOK_on
2959
2960 Tells an SV that it is a double.
2961
2962         void    SvNOK_on(SV* sv)
2963
2964 =for hackers
2965 Found in file sv.h
2966
2967 =item SvNOK_only
2968
2969 Tells an SV that it is a double and disables all other OK bits.
2970
2971         void    SvNOK_only(SV* sv)
2972
2973 =for hackers
2974 Found in file sv.h
2975
2976 =item SvNV
2977
2978 Coerce the given SV to a double and return it. See  C<SvNVx> for a version
2979 which guarantees to evaluate sv only once.
2980
2981         NV      SvNV(SV* sv)
2982
2983 =for hackers
2984 Found in file sv.h
2985
2986 =item SvNVX
2987
2988 Returns the raw value in the SV's NV slot, without checks or conversions.
2989 Only use when you are sure SvNOK is true. See also C<SvNV()>.
2990
2991         NV      SvNVX(SV* sv)
2992
2993 =for hackers
2994 Found in file sv.h
2995
2996 =item SvNVx
2997
2998 Coerces the given SV to a double and returns it. Guarantees to evaluate
2999 sv only once. Use the more efficient C<SvNV> otherwise.
3000
3001         NV      SvNVx(SV* sv)
3002
3003 =for hackers
3004 Found in file sv.h
3005
3006 =item SvOK
3007
3008 Returns a boolean indicating whether the value is an SV.
3009
3010         bool    SvOK(SV* sv)
3011
3012 =for hackers
3013 Found in file sv.h
3014
3015 =item SvOOK
3016
3017 Returns a boolean indicating whether the SvIVX is a valid offset value for
3018 the SvPVX.  This hack is used internally to speed up removal of characters
3019 from the beginning of a SvPV.  When SvOOK is true, then the start of the
3020 allocated string buffer is really (SvPVX - SvIVX).
3021
3022         bool    SvOOK(SV* sv)
3023
3024 =for hackers
3025 Found in file sv.h
3026
3027 =item SvPOK
3028
3029 Returns a boolean indicating whether the SV contains a character
3030 string.
3031
3032         bool    SvPOK(SV* sv)
3033
3034 =for hackers
3035 Found in file sv.h
3036
3037 =item SvPOKp
3038
3039 Returns a boolean indicating whether the SV contains a character string.
3040 Checks the B<private> setting.  Use C<SvPOK>.
3041
3042         bool    SvPOKp(SV* sv)
3043
3044 =for hackers
3045 Found in file sv.h
3046
3047 =item SvPOK_off
3048
3049 Unsets the PV status of an SV.
3050
3051         void    SvPOK_off(SV* sv)
3052
3053 =for hackers
3054 Found in file sv.h
3055
3056 =item SvPOK_on
3057
3058 Tells an SV that it is a string.
3059
3060         void    SvPOK_on(SV* sv)
3061
3062 =for hackers
3063 Found in file sv.h
3064
3065 =item SvPOK_only
3066
3067 Tells an SV that it is a string and disables all other OK bits.
3068 Will also turn off the UTF8 status.
3069
3070         void    SvPOK_only(SV* sv)
3071
3072 =for hackers
3073 Found in file sv.h
3074
3075 =item SvPOK_only_UTF8
3076
3077 Tells an SV that it is a string and disables all other OK bits,
3078 and leaves the UTF8 status as it was.
3079
3080         void    SvPOK_only_UTF8(SV* sv)
3081
3082 =for hackers
3083 Found in file sv.h
3084
3085 =item SvPV
3086
3087 Returns a pointer to the string in the SV, or a stringified form of
3088 the SV if the SV does not contain a string.  The SV may cache the
3089 stringified version becoming C<SvPOK>.  Handles 'get' magic. See also
3090 C<SvPVx> for a version which guarantees to evaluate sv only once.
3091
3092         char*   SvPV(SV* sv, STRLEN len)
3093
3094 =for hackers
3095 Found in file sv.h
3096
3097 =item SvPVbyte
3098
3099 Like C<SvPV>, but converts sv to byte representation first if necessary.
3100
3101         char*   SvPVbyte(SV* sv, STRLEN len)
3102
3103 =for hackers
3104 Found in file sv.h
3105
3106 =item SvPVbytex
3107
3108 Like C<SvPV>, but converts sv to byte representation first if necessary.
3109 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
3110 otherwise.
3111
3112         char*   SvPVbytex(SV* sv, STRLEN len)
3113
3114 =for hackers
3115 Found in file sv.h
3116
3117 =item SvPVbytex_force
3118
3119 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3120 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
3121 otherwise.
3122
3123         char*   SvPVbytex_force(SV* sv, STRLEN len)
3124
3125 =for hackers
3126 Found in file sv.h
3127
3128 =item SvPVbyte_force
3129
3130 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
3131
3132         char*   SvPVbyte_force(SV* sv, STRLEN len)
3133
3134 =for hackers
3135 Found in file sv.h
3136
3137 =item SvPVbyte_nolen
3138
3139 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
3140
3141         char*   SvPVbyte_nolen(SV* sv)
3142
3143 =for hackers
3144 Found in file sv.h
3145
3146 =item SvPVutf8
3147
3148 Like C<SvPV>, but converts sv to utf8 first if necessary.
3149
3150         char*   SvPVutf8(SV* sv, STRLEN len)
3151
3152 =for hackers
3153 Found in file sv.h
3154
3155 =item SvPVutf8x
3156
3157 Like C<SvPV>, but converts sv to utf8 first if necessary.
3158 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
3159 otherwise.
3160
3161         char*   SvPVutf8x(SV* sv, STRLEN len)
3162
3163 =for hackers
3164 Found in file sv.h
3165
3166 =item SvPVutf8x_force
3167
3168 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3169 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
3170 otherwise.
3171
3172         char*   SvPVutf8x_force(SV* sv, STRLEN len)
3173
3174 =for hackers
3175 Found in file sv.h
3176
3177 =item SvPVutf8_force
3178
3179 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
3180
3181         char*   SvPVutf8_force(SV* sv, STRLEN len)
3182
3183 =for hackers
3184 Found in file sv.h
3185
3186 =item SvPVutf8_nolen
3187
3188 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
3189
3190         char*   SvPVutf8_nolen(SV* sv)
3191
3192 =for hackers
3193 Found in file sv.h
3194
3195 =item SvPVx
3196
3197 A version of C<SvPV> which guarantees to evaluate sv only once.
3198
3199         char*   SvPVx(SV* sv, STRLEN len)
3200
3201 =for hackers
3202 Found in file sv.h
3203
3204 =item SvPVX
3205
3206 Returns a pointer to the physical string in the SV.  The SV must contain a
3207 string.
3208
3209         char*   SvPVX(SV* sv)
3210
3211 =for hackers
3212 Found in file sv.h
3213
3214 =item SvPV_force
3215
3216 Like C<SvPV> but will force the SV into containing just a string
3217 (C<SvPOK_only>).  You want force if you are going to update the C<SvPVX>
3218 directly.
3219
3220         char*   SvPV_force(SV* sv, STRLEN len)
3221
3222 =for hackers
3223 Found in file sv.h
3224
3225 =item SvPV_force_nomg
3226
3227 Like C<SvPV> but will force the SV into containing just a string
3228 (C<SvPOK_only>).  You want force if you are going to update the C<SvPVX>
3229 directly. Doesn't process magic.
3230
3231         char*   SvPV_force_nomg(SV* sv, STRLEN len)
3232
3233 =for hackers
3234 Found in file sv.h
3235
3236 =item SvPV_nolen
3237
3238 Returns a pointer to the string in the SV, or a stringified form of
3239 the SV if the SV does not contain a string.  The SV may cache the
3240 stringified form becoming C<SvPOK>.  Handles 'get' magic.
3241
3242         char*   SvPV_nolen(SV* sv)
3243
3244 =for hackers
3245 Found in file sv.h
3246
3247 =item SvREFCNT
3248
3249 Returns the value of the object's reference count.
3250
3251         U32     SvREFCNT(SV* sv)
3252
3253 =for hackers
3254 Found in file sv.h
3255
3256 =item SvREFCNT_dec
3257
3258 Decrements the reference count of the given SV.
3259
3260         void    SvREFCNT_dec(SV* sv)
3261
3262 =for hackers
3263 Found in file sv.h
3264
3265 =item SvREFCNT_inc
3266
3267 Increments the reference count of the given SV.
3268
3269         SV*     SvREFCNT_inc(SV* sv)
3270
3271 =for hackers
3272 Found in file sv.h
3273
3274 =item SvROK
3275
3276 Tests if the SV is an RV.
3277
3278         bool    SvROK(SV* sv)
3279
3280 =for hackers
3281 Found in file sv.h
3282
3283 =item SvROK_off
3284
3285 Unsets the RV status of an SV.
3286
3287         void    SvROK_off(SV* sv)
3288
3289 =for hackers
3290 Found in file sv.h
3291
3292 =item SvROK_on
3293
3294 Tells an SV that it is an RV.
3295
3296         void    SvROK_on(SV* sv)
3297
3298 =for hackers
3299 Found in file sv.h
3300
3301 =item SvRV
3302
3303 Dereferences an RV to return the SV.
3304
3305         SV*     SvRV(SV* sv)
3306
3307 =for hackers
3308 Found in file sv.h
3309
3310 =item SvSTASH
3311
3312 Returns the stash of the SV.
3313
3314         HV*     SvSTASH(SV* sv)
3315
3316 =for hackers
3317 Found in file sv.h
3318
3319 =item SvTAINT
3320
3321 Taints an SV if tainting is enabled.
3322
3323         void    SvTAINT(SV* sv)
3324
3325 =for hackers
3326 Found in file sv.h
3327
3328 =item SvTAINTED
3329
3330 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
3331 not.
3332
3333         bool    SvTAINTED(SV* sv)
3334
3335 =for hackers
3336 Found in file sv.h
3337
3338 =item SvTAINTED_off
3339
3340 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
3341 some of Perl's fundamental security features. XS module authors should not
3342 use this function unless they fully understand all the implications of
3343 unconditionally untainting the value. Untainting should be done in the
3344 standard perl fashion, via a carefully crafted regexp, rather than directly
3345 untainting variables.
3346
3347         void    SvTAINTED_off(SV* sv)
3348
3349 =for hackers
3350 Found in file sv.h
3351
3352 =item SvTAINTED_on
3353
3354 Marks an SV as tainted if tainting is enabled.
3355
3356         void    SvTAINTED_on(SV* sv)
3357
3358 =for hackers
3359 Found in file sv.h
3360
3361 =item SvTRUE
3362
3363 Returns a boolean indicating whether Perl would evaluate the SV as true or
3364 false, defined or undefined.  Does not handle 'get' magic.
3365
3366         bool    SvTRUE(SV* sv)
3367
3368 =for hackers
3369 Found in file sv.h
3370
3371 =item SvTYPE
3372
3373 Returns the type of the SV.  See C<svtype>.
3374
3375         svtype  SvTYPE(SV* sv)
3376
3377 =for hackers
3378 Found in file sv.h
3379
3380 =item SvUNLOCK
3381
3382 Releases a mutual exclusion lock on sv if a suitable module
3383 has been loaded.
3384
3385
3386         void    SvUNLOCK(SV* sv)
3387
3388 =for hackers
3389 Found in file sv.h
3390
3391 =item SvUOK
3392
3393 Returns a boolean indicating whether the SV contains an unsigned integer.
3394
3395         void    SvUOK(SV* sv)
3396
3397 =for hackers
3398 Found in file sv.h
3399
3400 =item SvUPGRADE
3401
3402 Used to upgrade an SV to a more complex form.  Uses C<sv_upgrade> to
3403 perform the upgrade if necessary.  See C<svtype>.
3404
3405         void    SvUPGRADE(SV* sv, svtype type)
3406
3407 =for hackers
3408 Found in file sv.h
3409
3410 =item SvUTF8
3411
3412 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
3413
3414         void    SvUTF8(SV* sv)
3415
3416 =for hackers
3417 Found in file sv.h
3418
3419 =item SvUTF8_off
3420
3421 Unsets the UTF8 status of an SV.
3422
3423         void    SvUTF8_off(SV *sv)
3424
3425 =for hackers
3426 Found in file sv.h
3427
3428 =item SvUTF8_on
3429
3430 Turn on the UTF8 status of an SV (the data is not changed, just the flag).
3431 Do not use frivolously.
3432
3433         void    SvUTF8_on(SV *sv)
3434
3435 =for hackers
3436 Found in file sv.h
3437
3438 =item SvUV
3439
3440 Coerces the given SV to an unsigned integer and returns it.  See C<SvUVx>
3441 for a version which guarantees to evaluate sv only once.
3442
3443         UV      SvUV(SV* sv)
3444
3445 =for hackers
3446 Found in file sv.h
3447
3448 =item SvUVX
3449
3450 Returns the raw value in the SV's UV slot, without checks or conversions.
3451 Only use when you are sure SvIOK is true. See also C<SvUV()>.
3452
3453         UV      SvUVX(SV* sv)
3454
3455 =for hackers
3456 Found in file sv.h
3457
3458 =item SvUVx
3459
3460 Coerces the given SV to an unsigned integer and returns it. Guarantees to
3461 evaluate sv only once. Use the more efficient C<SvUV> otherwise.
3462
3463         UV      SvUVx(SV* sv)
3464
3465 =for hackers
3466 Found in file sv.h
3467
3468 =item SvVOK
3469
3470 Returns a boolean indicating whether the SV contains a v-string.
3471
3472         bool    SvVOK(SV* sv)
3473
3474 =for hackers
3475 Found in file sv.h
3476
3477 =item sv_2bool
3478
3479 This function is only called on magical items, and is only used by
3480 sv_true() or its macro equivalent.
3481
3482         bool    sv_2bool(SV* sv)
3483
3484 =for hackers
3485 Found in file sv.c
3486
3487 =item sv_2cv
3488
3489 Using various gambits, try to get a CV from an SV; in addition, try if
3490 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
3491
3492         CV*     sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
3493
3494 =for hackers
3495 Found in file sv.c
3496
3497 =item sv_2io
3498
3499 Using various gambits, try to get an IO from an SV: the IO slot if its a
3500 GV; or the recursive result if we're an RV; or the IO slot of the symbol
3501 named after the PV if we're a string.
3502
3503         IO*     sv_2io(SV* sv)
3504
3505 =for hackers
3506 Found in file sv.c
3507
3508 =item sv_2iv
3509
3510 Return the integer value of an SV, doing any necessary string conversion,
3511 magic etc. Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
3512
3513         IV      sv_2iv(SV* sv)
3514
3515 =for hackers
3516 Found in file sv.c
3517
3518 =item sv_2mortal
3519
3520 Marks an existing SV as mortal.  The SV will be destroyed "soon", either
3521 by an explicit call to FREETMPS, or by an implicit call at places such as
3522 statement boundaries.  See also C<sv_newmortal> and C<sv_mortalcopy>.
3523
3524         SV*     sv_2mortal(SV* sv)
3525
3526 =for hackers
3527 Found in file sv.c
3528
3529 =item sv_2nv
3530
3531 Return the num value of an SV, doing any necessary string or integer
3532 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
3533 macros.
3534
3535         NV      sv_2nv(SV* sv)
3536
3537 =for hackers
3538 Found in file sv.c
3539
3540 =item sv_2pvbyte
3541
3542 Return a pointer to the byte-encoded representation of the SV, and set *lp
3543 to its length.  May cause the SV to be downgraded from UTF8 as a
3544 side-effect.
3545
3546 Usually accessed via the C<SvPVbyte> macro.
3547
3548         char*   sv_2pvbyte(SV* sv, STRLEN* lp)
3549
3550 =for hackers
3551 Found in file sv.c
3552
3553 =item sv_2pvbyte_nolen
3554
3555 Return a pointer to the byte-encoded representation of the SV.
3556 May cause the SV to be downgraded from UTF8 as a side-effect.
3557
3558 Usually accessed via the C<SvPVbyte_nolen> macro.
3559
3560         char*   sv_2pvbyte_nolen(SV* sv)
3561
3562 =for hackers
3563 Found in file sv.c
3564
3565 =item sv_2pvutf8
3566
3567 Return a pointer to the UTF8-encoded representation of the SV, and set *lp
3568 to its length.  May cause the SV to be upgraded to UTF8 as a side-effect.
3569
3570 Usually accessed via the C<SvPVutf8> macro.
3571
3572         char*   sv_2pvutf8(SV* sv, STRLEN* lp)
3573
3574 =for hackers
3575 Found in file sv.c
3576
3577 =item sv_2pvutf8_nolen
3578
3579 Return a pointer to the UTF8-encoded representation of the SV.
3580 May cause the SV to be upgraded to UTF8 as a side-effect.
3581
3582 Usually accessed via the C<SvPVutf8_nolen> macro.
3583
3584         char*   sv_2pvutf8_nolen(SV* sv)
3585
3586 =for hackers
3587 Found in file sv.c
3588
3589 =item sv_2pv_flags
3590
3591 Returns a pointer to the string value of an SV, and sets *lp to its length.
3592 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
3593 if necessary.
3594 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
3595 usually end up here too.
3596
3597         char*   sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
3598
3599 =for hackers
3600 Found in file sv.c
3601
3602 =item sv_2pv_nolen
3603
3604 Like C<sv_2pv()>, but doesn't return the length too. You should usually
3605 use the macro wrapper C<SvPV_nolen(sv)> instead.
3606         char*   sv_2pv_nolen(SV* sv)
3607
3608 =for hackers
3609 Found in file sv.c
3610
3611 =item sv_2uv
3612
3613 Return the unsigned integer value of an SV, doing any necessary string
3614 conversion, magic etc. Normally used via the C<SvUV(sv)> and C<SvUVx(sv)>
3615 macros.
3616
3617         UV      sv_2uv(SV* sv)
3618
3619 =for hackers
3620 Found in file sv.c
3621
3622 =item sv_backoff
3623
3624 Remove any string offset. You should normally use the C<SvOOK_off> macro
3625 wrapper instead.
3626
3627         int     sv_backoff(SV* sv)
3628
3629 =for hackers
3630 Found in file sv.c
3631
3632 =item sv_bless
3633
3634 Blesses an SV into a specified package.  The SV must be an RV.  The package
3635 must be designated by its stash (see C<gv_stashpv()>).  The reference count
3636 of the SV is unaffected.
3637
3638         SV*     sv_bless(SV* sv, HV* stash)
3639
3640 =for hackers
3641 Found in file sv.c
3642
3643 =item sv_catpv
3644
3645 Concatenates the string onto the end of the string which is in the SV.
3646 If the SV has the UTF8 status set, then the bytes appended should be
3647 valid UTF8.  Handles 'get' magic, but not 'set' magic.  See C<sv_catpv_mg>.
3648
3649         void    sv_catpv(SV* sv, const char* ptr)
3650
3651 =for hackers
3652 Found in file sv.c
3653
3654 =item sv_catpvf
3655
3656 Processes its arguments like C<sprintf> and appends the formatted
3657 output to an SV.  If the appended data contains "wide" characters
3658 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
3659 and characters >255 formatted with %c), the original SV might get
3660 upgraded to UTF-8.  Handles 'get' magic, but not 'set' magic.
3661 C<SvSETMAGIC()> must typically be called after calling this function
3662 to handle 'set' magic.
3663
3664         void    sv_catpvf(SV* sv, const char* pat, ...)
3665
3666 =for hackers
3667 Found in file sv.c
3668
3669 =item sv_catpvf_mg
3670
3671 Like C<sv_catpvf>, but also handles 'set' magic.
3672
3673         void    sv_catpvf_mg(SV *sv, const char* pat, ...)
3674
3675 =for hackers
3676 Found in file sv.c
3677
3678 =item sv_catpvn
3679
3680 Concatenates the string onto the end of the string which is in the SV.  The
3681 C<len> indicates number of bytes to copy.  If the SV has the UTF8
3682 status set, then the bytes appended should be valid UTF8.
3683 Handles 'get' magic, but not 'set' magic.  See C<sv_catpvn_mg>.
3684
3685         void    sv_catpvn(SV* sv, const char* ptr, STRLEN len)
3686
3687 =for hackers
3688 Found in file sv.c
3689
3690 =item sv_catpvn_flags
3691
3692 Concatenates the string onto the end of the string which is in the SV.  The
3693 C<len> indicates number of bytes to copy.  If the SV has the UTF8
3694 status set, then the bytes appended should be valid UTF8.
3695 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<dsv> if
3696 appropriate, else not. C<sv_catpvn> and C<sv_catpvn_nomg> are implemented
3697 in terms of this function.
3698
3699         void    sv_catpvn_flags(SV* sv, const char* ptr, STRLEN len, I32 flags)
3700
3701 =for hackers
3702 Found in file sv.c
3703
3704 =item sv_catpvn_mg
3705
3706 Like C<sv_catpvn>, but also handles 'set' magic.
3707
3708         void    sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
3709
3710 =for hackers
3711 Found in file sv.c
3712
3713 =item sv_catpv_mg
3714
3715 Like C<sv_catpv>, but also handles 'set' magic.
3716
3717         void    sv_catpv_mg(SV *sv, const char *ptr)
3718
3719 =for hackers
3720 Found in file sv.c
3721
3722 =item sv_catsv
3723
3724 Concatenates the string from SV C<ssv> onto the end of the string in
3725 SV C<dsv>.  Modifies C<dsv> but not C<ssv>.  Handles 'get' magic, but
3726 not 'set' magic.  See C<sv_catsv_mg>.
3727
3728         void    sv_catsv(SV* dsv, SV* ssv)
3729
3730 =for hackers
3731 Found in file sv.c
3732
3733 =item sv_catsv_flags
3734
3735 Concatenates the string from SV C<ssv> onto the end of the string in
3736 SV C<dsv>.  Modifies C<dsv> but not C<ssv>.  If C<flags> has C<SV_GMAGIC>
3737 bit set, will C<mg_get> on the SVs if appropriate, else not. C<sv_catsv>
3738 and C<sv_catsv_nomg> are implemented in terms of this function.
3739
3740         void    sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)
3741
3742 =for hackers
3743 Found in file sv.c
3744
3745 =item sv_catsv_mg
3746
3747 Like C<sv_catsv>, but also handles 'set' magic.
3748
3749         void    sv_catsv_mg(SV *dstr, SV *sstr)
3750
3751 =for hackers
3752 Found in file sv.c
3753
3754 =item sv_chop
3755
3756 Efficient removal of characters from the beginning of the string buffer.
3757 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
3758 the string buffer.  The C<ptr> becomes the first character of the adjusted
3759 string. Uses the "OOK hack".
3760 Beware: after this function returns, C<ptr> and SvPVX(sv) may no longer
3761 refer to the same chunk of data.
3762
3763         void    sv_chop(SV* sv, char* ptr)
3764
3765 =for hackers
3766 Found in file sv.c
3767
3768 =item sv_clear
3769
3770 Clear an SV: call any destructors, free up any memory used by the body,
3771 and free the body itself. The SV's head is I<not> freed, although
3772 its type is set to all 1's so that it won't inadvertently be assumed
3773 to be live during global destruction etc.
3774 This function should only be called when REFCNT is zero. Most of the time
3775 you'll want to call C<sv_free()> (or its macro wrapper C<SvREFCNT_dec>)
3776 instead.
3777
3778         void    sv_clear(SV* sv)
3779
3780 =for hackers
3781 Found in file sv.c
3782
3783 =item sv_cmp
3784
3785 Compares the strings in two SVs.  Returns -1, 0, or 1 indicating whether the
3786 string in C<sv1> is less than, equal to, or greater than the string in
3787 C<sv2>. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3788 coerce its args to strings if necessary.  See also C<sv_cmp_locale>.
3789
3790         I32     sv_cmp(SV* sv1, SV* sv2)
3791
3792 =for hackers
3793 Found in file sv.c
3794
3795 =item sv_cmp_locale
3796
3797 Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and
3798 'use bytes' aware, handles get magic, and will coerce its args to strings
3799 if necessary.  See also C<sv_cmp_locale>.  See also C<sv_cmp>.
3800
3801         I32     sv_cmp_locale(SV* sv1, SV* sv2)
3802
3803 =for hackers
3804 Found in file sv.c
3805
3806 =item sv_collxfrm
3807
3808 Add Collate Transform magic to an SV if it doesn't already have it.
3809
3810 Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the
3811 scalar data of the variable, but transformed to such a format that a normal
3812 memory comparison can be used to compare the data according to the locale
3813 settings.
3814
3815         char*   sv_collxfrm(SV* sv, STRLEN* nxp)
3816
3817 =for hackers
3818 Found in file sv.c
3819
3820 =item sv_copypv
3821
3822 Copies a stringified representation of the source SV into the
3823 destination SV.  Automatically performs any necessary mg_get and
3824 coercion of numeric values into strings.  Guaranteed to preserve
3825 UTF-8 flag even from overloaded objects.  Similar in nature to
3826 sv_2pv[_flags] but operates directly on an SV instead of just the
3827 string.  Mostly uses sv_2pv_flags to do its work, except when that
3828 would lose the UTF-8'ness of the PV.
3829
3830         void    sv_copypv(SV* dsv, SV* ssv)
3831
3832 =for hackers
3833 Found in file sv.c
3834
3835 =item sv_dec
3836
3837 Auto-decrement of the value in the SV, doing string to numeric conversion
3838 if necessary. Handles 'get' magic.
3839
3840         void    sv_dec(SV* sv)
3841
3842 =for hackers
3843 Found in file sv.c
3844
3845 =item sv_derived_from
3846
3847 Returns a boolean indicating whether the SV is derived from the specified
3848 class.  This is the function that implements C<UNIVERSAL::isa>.  It works
3849 for class names as well as for objects.
3850
3851         bool    sv_derived_from(SV* sv, const char* name)
3852
3853 =for hackers
3854 Found in file universal.c
3855
3856 =item sv_eq
3857
3858 Returns a boolean indicating whether the strings in the two SVs are
3859 identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will
3860 coerce its args to strings if necessary.
3861
3862         I32     sv_eq(SV* sv1, SV* sv2)
3863
3864 =for hackers
3865 Found in file sv.c
3866
3867 =item sv_force_normal
3868
3869 Undo various types of fakery on an SV: if the PV is a shared string, make
3870 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3871 an xpvmg. See also C<sv_force_normal_flags>.
3872
3873         void    sv_force_normal(SV *sv)
3874
3875 =for hackers
3876 Found in file sv.c
3877
3878 =item sv_force_normal_flags
3879
3880 Undo various types of fakery on an SV: if the PV is a shared string, make
3881 a private copy; if we're a ref, stop refing; if we're a glob, downgrade to
3882 an xpvmg; if we're a copy-on-write scalar, this is the on-write time when
3883 we do the copy, and is also used locally. If C<SV_COW_DROP_PV> is set
3884 then a copy-on-write scalar drops its PV buffer (if any) and becomes
3885 SvPOK_off rather than making a copy. (Used where this scalar is about to be
3886 set to some other value.) In addition, the C<flags> parameter gets passed to
3887 C<sv_unref_flags()> when unrefing. C<sv_force_normal> calls this function
3888 with flags set to 0.
3889
3890         void    sv_force_normal_flags(SV *sv, U32 flags)
3891
3892 =for hackers
3893 Found in file sv.c
3894
3895 =item sv_free
3896
3897 Decrement an SV's reference count, and if it drops to zero, call
3898 C<sv_clear> to invoke destructors and free up any memory used by
3899 the body; finally, deallocate the SV's head itself.
3900 Normally called via a wrapper macro C<SvREFCNT_dec>.
3901
3902         void    sv_free(SV* sv)
3903
3904 =for hackers
3905 Found in file sv.c
3906
3907 =item sv_gets
3908
3909 Get a line from the filehandle and store it into the SV, optionally
3910 appending to the currently-stored string.
3911
3912         char*   sv_gets(SV* sv, PerlIO* fp, I32 append)
3913
3914 =for hackers
3915 Found in file sv.c
3916
3917 =item sv_grow
3918
3919 Expands the character buffer in the SV.  If necessary, uses C<sv_unref> and
3920 upgrades the SV to C<SVt_PV>.  Returns a pointer to the character buffer.
3921 Use the C<SvGROW> wrapper instead.
3922
3923         char*   sv_grow(SV* sv, STRLEN newlen)
3924
3925 =for hackers
3926 Found in file sv.c
3927
3928 =item sv_inc
3929
3930 Auto-increment of the value in the SV, doing string to numeric conversion
3931 if necessary. Handles 'get' magic.
3932
3933         void    sv_inc(SV* sv)
3934
3935 =for hackers
3936 Found in file sv.c
3937
3938 =item sv_insert
3939
3940 Inserts a string at the specified offset/length within the SV. Similar to
3941 the Perl substr() function.
3942
3943         void    sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
3944
3945 =for hackers
3946 Found in file sv.c
3947
3948 =item sv_isa
3949
3950 Returns a boolean indicating whether the SV is blessed into the specified
3951 class.  This does not check for subtypes; use C<sv_derived_from> to verify
3952 an inheritance relationship.
3953
3954         int     sv_isa(SV* sv, const char* name)
3955
3956 =for hackers
3957 Found in file sv.c
3958
3959 =item sv_isobject
3960
3961 Returns a boolean indicating whether the SV is an RV pointing to a blessed
3962 object.  If the SV is not an RV, or if the object is not blessed, then this
3963 will return false.
3964
3965         int     sv_isobject(SV* sv)
3966
3967 =for hackers
3968 Found in file sv.c
3969
3970 =item sv_iv
3971
3972 A private implementation of the C<SvIVx> macro for compilers which can't
3973 cope with complex macro expressions. Always use the macro instead.
3974
3975         IV      sv_iv(SV* sv)
3976
3977 =for hackers
3978 Found in file sv.c
3979
3980 =item sv_len
3981
3982 Returns the length of the string in the SV. Handles magic and type
3983 coercion.  See also C<SvCUR>, which gives raw access to the xpv_cur slot.
3984
3985         STRLEN  sv_len(SV* sv)
3986
3987 =for hackers
3988 Found in file sv.c
3989
3990 =item sv_len_utf8
3991
3992 Returns the number of characters in the string in an SV, counting wide
3993 UTF8 bytes as a single character. Handles magic and type coercion.
3994
3995         STRLEN  sv_len_utf8(SV* sv)
3996
3997 =for hackers
3998 Found in file sv.c
3999
4000 =item sv_magic
4001
4002 Adds magic to an SV. First upgrades C<sv> to type C<SVt_PVMG> if necessary,
4003 then adds a new magic item of type C<how> to the head of the magic list.
4004
4005         void    sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
4006
4007 =for hackers
4008 Found in file sv.c
4009
4010 =item sv_magicext
4011
4012 Adds magic to an SV, upgrading it if necessary. Applies the
4013 supplied vtable and returns pointer to the magic added.
4014
4015 Note that sv_magicext will allow things that sv_magic will not.
4016 In particular you can add magic to SvREADONLY SVs and and more than
4017 one instance of the same 'how'
4018
4019 I C<namelen> is greater then zero then a savepvn() I<copy> of C<name> is stored,
4020 if C<namelen> is zero then C<name> is stored as-is and - as another special
4021 case - if C<(name && namelen == HEf_SVKEY)> then C<name> is assumed to contain
4022 an C<SV*> and has its REFCNT incremented
4023
4024 (This is now used as a subroutine by sv_magic.)
4025
4026         MAGIC * sv_magicext(SV* sv, SV* obj, int how, MGVTBL *vtbl, const char* name, I32 namlen        )
4027
4028 =for hackers
4029 Found in file sv.c
4030
4031 =item sv_mortalcopy
4032
4033 Creates a new SV which is a copy of the original SV (using C<sv_setsv>).
4034 The new SV is marked as mortal. It will be destroyed "soon", either by an
4035 explicit call to FREETMPS, or by an implicit call at places such as
4036 statement boundaries.  See also C<sv_newmortal> and C<sv_2mortal>.
4037
4038         SV*     sv_mortalcopy(SV* oldsv)
4039
4040 =for hackers
4041 Found in file sv.c
4042
4043 =item sv_newmortal
4044
4045 Creates a new null SV which is mortal.  The reference count of the SV is
4046 set to 1. It will be destroyed "soon", either by an explicit call to
4047 FREETMPS, or by an implicit call at places such as statement boundaries.
4048 See also C<sv_mortalcopy> and C<sv_2mortal>.
4049
4050         SV*     sv_newmortal()
4051
4052 =for hackers
4053 Found in file sv.c
4054
4055 =item sv_newref
4056
4057 Increment an SV's reference count. Use the C<SvREFCNT_inc()> wrapper
4058 instead.
4059
4060         SV*     sv_newref(SV* sv)
4061
4062 =for hackers
4063 Found in file sv.c
4064
4065 =item sv_nv
4066
4067 A private implementation of the C<SvNVx> macro for compilers which can't
4068 cope with complex macro expressions. Always use the macro instead.
4069
4070         NV      sv_nv(SV* sv)
4071
4072 =for hackers
4073 Found in file sv.c
4074
4075 =item sv_pos_b2u
4076
4077 Converts the value pointed to by offsetp from a count of bytes from the
4078 start of the string, to a count of the equivalent number of UTF8 chars.
4079 Handles magic and type coercion.
4080
4081         void    sv_pos_b2u(SV* sv, I32* offsetp)
4082
4083 =for hackers
4084 Found in file sv.c
4085
4086 =item sv_pos_u2b
4087
4088 Converts the value pointed to by offsetp from a count of UTF8 chars from
4089 the start of the string, to a count of the equivalent number of bytes; if
4090 lenp is non-zero, it does the same to lenp, but this time starting from
4091 the offset, rather than from the start of the string. Handles magic and
4092 type coercion.
4093
4094         void    sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)
4095
4096 =for hackers
4097 Found in file sv.c
4098
4099 =item sv_pv
4100
4101 Use the C<SvPV_nolen> macro instead
4102
4103         char*   sv_pv(SV *sv)
4104
4105 =for hackers
4106 Found in file sv.c
4107
4108 =item sv_pvbyte
4109
4110 Use C<SvPVbyte_nolen> instead.
4111
4112         char*   sv_pvbyte(SV *sv)
4113
4114 =for hackers
4115 Found in file sv.c
4116
4117 =item sv_pvbyten
4118
4119 A private implementation of the C<SvPVbyte> macro for compilers
4120 which can't cope with complex macro expressions. Always use the macro
4121 instead.
4122
4123         char*   sv_pvbyten(SV *sv, STRLEN *len)
4124
4125 =for hackers
4126 Found in file sv.c
4127
4128 =item sv_pvbyten_force
4129
4130 A private implementation of the C<SvPVbytex_force> macro for compilers
4131 which can't cope with complex macro expressions. Always use the macro
4132 instead.
4133
4134         char*   sv_pvbyten_force(SV* sv, STRLEN* lp)
4135
4136 =for hackers
4137 Found in file sv.c
4138
4139 =item sv_pvn
4140
4141 A private implementation of the C<SvPV> macro for compilers which can't
4142 cope with complex macro expressions. Always use the macro instead.
4143
4144         char*   sv_pvn(SV *sv, STRLEN *len)
4145
4146 =for hackers
4147 Found in file sv.c
4148
4149 =item sv_pvn_force
4150
4151 Get a sensible string out of the SV somehow.
4152 A private implementation of the C<SvPV_force> macro for compilers which
4153 can't cope with complex macro expressions. Always use the macro instead.
4154
4155         char*   sv_pvn_force(SV* sv, STRLEN* lp)
4156
4157 =for hackers
4158 Found in file sv.c
4159
4160 =item sv_pvn_force_flags
4161
4162 Get a sensible string out of the SV somehow.
4163 If C<flags> has C<SV_GMAGIC> bit set, will C<mg_get> on C<sv> if
4164 appropriate, else not. C<sv_pvn_force> and C<sv_pvn_force_nomg> are
4165 implemented in terms of this function.
4166 You normally want to use the various wrapper macros instead: see
4167 C<SvPV_force> and C<SvPV_force_nomg>
4168
4169         char*   sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)
4170
4171 =for hackers
4172 Found in file sv.c
4173
4174 =item sv_pvutf8
4175
4176 Use the C<SvPVutf8_nolen> macro instead
4177
4178         char*   sv_pvutf8(SV *sv)
4179
4180 =for hackers
4181 Found in file sv.c
4182
4183 =item sv_pvutf8n
4184
4185 A private implementation of the C<SvPVutf8> macro for compilers
4186 which can't cope with complex macro expressions. Always use the macro
4187 instead.
4188
4189         char*   sv_pvutf8n(SV *sv, STRLEN *len)
4190
4191 =for hackers
4192 Found in file sv.c
4193
4194 =item sv_pvutf8n_force
4195
4196 A private implementation of the C<SvPVutf8_force> macro for compilers
4197 which can't cope with complex macro expressions. Always use the macro
4198 instead.
4199
4200         char*   sv_pvutf8n_force(SV* sv, STRLEN* lp)
4201
4202 =for hackers
4203 Found in file sv.c
4204
4205 =item sv_reftype
4206
4207 Returns a string describing what the SV is a reference to.
4208
4209         char*   sv_reftype(SV* sv, int ob)
4210
4211 =for hackers
4212 Found in file sv.c
4213
4214 =item sv_replace
4215
4216 Make the first argument a copy of the second, then delete the original.
4217 The target SV physically takes over ownership of the body of the source SV
4218 and inherits its flags; however, the target keeps any magic it owns,
4219 and any magic in the source is discarded.
4220 Note that this is a rather specialist SV copying operation; most of the
4221 time you'll want to use C<sv_setsv> or one of its many macro front-ends.
4222
4223         void    sv_replace(SV* sv, SV* nsv)
4224
4225 =for hackers
4226 Found in file sv.c
4227
4228 =item sv_report_used
4229
4230 Dump the contents of all SVs not yet freed. (Debugging aid).
4231
4232         void    sv_report_used()
4233
4234 =for hackers
4235 Found in file sv.c
4236
4237 =item sv_reset
4238
4239 Underlying implementation for the C<reset> Perl function.
4240 Note that the perl-level function is vaguely deprecated.
4241
4242         void    sv_reset(char* s, HV* stash)
4243
4244 =for hackers
4245 Found in file sv.c
4246
4247 =item sv_rvweaken
4248
4249 Weaken a reference: set the C<SvWEAKREF> flag on this RV; give the
4250 referred-to SV C<PERL_MAGIC_backref> magic if it hasn't already; and
4251 push a back-reference to this RV onto the array of backreferences
4252 associated with that magic.
4253
4254         SV*     sv_rvweaken(SV *sv)
4255
4256 =for hackers
4257 Found in file sv.c
4258
4259 =item sv_setiv
4260
4261 Copies an integer into the given SV, upgrading first if necessary.
4262 Does not handle 'set' magic.  See also C<sv_setiv_mg>.
4263
4264         void    sv_setiv(SV* sv, IV num)
4265
4266 =for hackers
4267 Found in file sv.c
4268
4269 =item sv_setiv_mg
4270
4271 Like C<sv_setiv>, but also handles 'set' magic.
4272
4273         void    sv_setiv_mg(SV *sv, IV i)
4274
4275 =for hackers
4276 Found in file sv.c
4277
4278 =item sv_setnv
4279
4280 Copies a double into the given SV, upgrading first if necessary.
4281 Does not handle 'set' magic.  See also C<sv_setnv_mg>.
4282
4283         void    sv_setnv(SV* sv, NV num)
4284
4285 =for hackers
4286 Found in file sv.c
4287
4288 =item sv_setnv_mg
4289
4290 Like C<sv_setnv>, but also handles 'set' magic.
4291
4292         void    sv_setnv_mg(SV *sv, NV num)
4293
4294 =for hackers
4295 Found in file sv.c
4296
4297 =item sv_setpv
4298
4299 Copies a string into an SV.  The string must be null-terminated.  Does not
4300 handle 'set' magic.  See C<sv_setpv_mg>.
4301
4302         void    sv_setpv(SV* sv, const char* ptr)
4303
4304 =for hackers
4305 Found in file sv.c
4306
4307 =item sv_setpvf
4308
4309 Processes its arguments like C<sprintf> and sets an SV to the formatted
4310 output.  Does not handle 'set' magic.  See C<sv_setpvf_mg>.
4311
4312         void    sv_setpvf(SV* sv, const char* pat, ...)
4313
4314 =for hackers
4315 Found in file sv.c
4316
4317 =item sv_setpvf_mg
4318
4319 Like C<sv_setpvf>, but also handles 'set' magic.
4320
4321         void    sv_setpvf_mg(SV *sv, const char* pat, ...)
4322
4323 =for hackers
4324 Found in file sv.c
4325
4326 =item sv_setpviv
4327
4328 Copies an integer into the given SV, also updating its string value.
4329 Does not handle 'set' magic.  See C<sv_setpviv_mg>.
4330
4331         void    sv_setpviv(SV* sv, IV num)
4332
4333 =for hackers
4334 Found in file sv.c
4335
4336 =item sv_setpviv_mg
4337
4338 Like C<sv_setpviv>, but also handles 'set' magic.
4339
4340         void    sv_setpviv_mg(SV *sv, IV iv)
4341
4342 =for hackers
4343 Found in file sv.c
4344
4345 =item sv_setpvn
4346
4347 Copies a string into an SV.  The C<len> parameter indicates the number of
4348 bytes to be copied.  Does not handle 'set' magic.  See C<sv_setpvn_mg>.
4349
4350         void    sv_setpvn(SV* sv, const char* ptr, STRLEN len)
4351
4352 =for hackers
4353 Found in file sv.c
4354
4355 =item sv_setpvn_mg
4356
4357 Like C<sv_setpvn>, but also handles 'set' magic.
4358
4359         void    sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
4360
4361 =for hackers
4362 Found in file sv.c
4363
4364 =item sv_setpv_mg
4365
4366 Like C<sv_setpv>, but also handles 'set' magic.
4367
4368         void    sv_setpv_mg(SV *sv, const char *ptr)
4369
4370 =for hackers
4371 Found in file sv.c
4372
4373 =item sv_setref_iv
4374
4375 Copies an integer into a new SV, optionally blessing the SV.  The C<rv>
4376 argument will be upgraded to an RV.  That RV will be modified to point to
4377 the new SV.  The C<classname> argument indicates the package for the
4378 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
4379 will have a reference count of 1, and the RV will be returned.
4380
4381         SV*     sv_setref_iv(SV* rv, const char* classname, IV iv)
4382
4383 =for hackers
4384 Found in file sv.c
4385
4386 =item sv_setref_nv
4387
4388 Copies a double into a new SV, optionally blessing the SV.  The C<rv>
4389 argument will be upgraded to an RV.  That RV will be modified to point to
4390 the new SV.  The C<classname> argument indicates the package for the
4391 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
4392 will have a reference count of 1, and the RV will be returned.
4393
4394         SV*     sv_setref_nv(SV* rv, const char* classname, NV nv)
4395
4396 =for hackers
4397 Found in file sv.c
4398
4399 =item sv_setref_pv
4400
4401 Copies a pointer into a new SV, optionally blessing the SV.  The C<rv>
4402 argument will be upgraded to an RV.  That RV will be modified to point to
4403 the new SV.  If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
4404 into the SV.  The C<classname> argument indicates the package for the
4405 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
4406 will have a reference count of 1, and the RV will be returned.
4407
4408 Do not use with other Perl types such as HV, AV, SV, CV, because those
4409 objects will become corrupted by the pointer copy process.
4410
4411 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
4412
4413         SV*     sv_setref_pv(SV* rv, const char* classname, void* pv)
4414
4415 =for hackers
4416 Found in file sv.c
4417
4418 =item sv_setref_pvn
4419
4420 Copies a string into a new SV, optionally blessing the SV.  The length of the
4421 string must be specified with C<n>.  The C<rv> argument will be upgraded to
4422 an RV.  That RV will be modified to point to the new SV.  The C<classname>
4423 argument indicates the package for the blessing.  Set C<classname> to
4424 C<Nullch> to avoid the blessing.  The new SV will have a reference count 
4425 of 1, and the RV will be returned.
4426
4427 Note that C<sv_setref_pv> copies the pointer while this copies the string.
4428
4429         SV*     sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
4430
4431 =for hackers
4432 Found in file sv.c
4433
4434 =item sv_setref_uv
4435
4436 Copies an unsigned integer into a new SV, optionally blessing the SV.  The C<rv>
4437 argument will be upgraded to an RV.  That RV will be modified to point to
4438 the new SV.  The C<classname> argument indicates the package for the
4439 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
4440 will have a reference count of 1, and the RV will be returned.
4441
4442         SV*     sv_setref_uv(SV* rv, const char* classname, UV uv)
4443
4444 =for hackers
4445 Found in file sv.c
4446
4447 =item sv_setsv
4448
4449 Copies the contents of the source SV C<ssv> into the destination SV
4450 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
4451 function if the source SV needs to be reused. Does not handle 'set' magic.
4452 Loosely speaking, it performs a copy-by-value, obliterating any previous
4453 content of the destination.
4454
4455 You probably want to use one of the assortment of wrappers, such as
4456 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4457 C<SvSetMagicSV_nosteal>.
4458
4459         void    sv_setsv(SV* dsv, SV* ssv)
4460
4461 =for hackers
4462 Found in file sv.c
4463
4464 =item sv_setsv_flags
4465
4466 Copies the contents of the source SV C<ssv> into the destination SV
4467 C<dsv>.  The source SV may be destroyed if it is mortal, so don't use this
4468 function if the source SV needs to be reused. Does not handle 'set' magic.
4469 Loosely speaking, it performs a copy-by-value, obliterating any previous
4470 content of the destination.
4471 If the C<flags> parameter has the C<SV_GMAGIC> bit set, will C<mg_get> on
4472 C<ssv> if appropriate, else not. C<sv_setsv> and C<sv_setsv_nomg> are
4473 implemented in terms of this function.
4474
4475 You probably want to use one of the assortment of wrappers, such as
4476 C<SvSetSV>, C<SvSetSV_nosteal>, C<SvSetMagicSV> and
4477 C<SvSetMagicSV_nosteal>.
4478
4479 This is the primary function for copying scalars, and most other
4480 copy-ish functions and macros use this underneath.
4481
4482         void    sv_setsv_flags(SV* dsv, SV* ssv, I32 flags)
4483
4484 =for hackers
4485 Found in file sv.c
4486
4487 =item sv_setsv_mg
4488
4489 Like C<sv_setsv>, but also handles 'set' magic.
4490
4491         void    sv_setsv_mg(SV *dstr, SV *sstr)
4492
4493 =for hackers
4494 Found in file sv.c
4495
4496 =item sv_setuv
4497
4498 Copies an unsigned integer into the given SV, upgrading first if necessary.
4499 Does not handle 'set' magic.  See also C<sv_setuv_mg>.
4500
4501         void    sv_setuv(SV* sv, UV num)
4502
4503 =for hackers
4504 Found in file sv.c
4505
4506 =item sv_setuv_mg
4507
4508 Like C<sv_setuv>, but also handles 'set' magic.
4509
4510         void    sv_setuv_mg(SV *sv, UV u)
4511
4512 =for hackers
4513 Found in file sv.c
4514
4515 =item sv_taint
4516
4517 Taint an SV. Use C<SvTAINTED_on> instead.
4518         void    sv_taint(SV* sv)
4519
4520 =for hackers
4521 Found in file sv.c
4522
4523 =item sv_tainted
4524
4525 Test an SV for taintedness. Use C<SvTAINTED> instead.
4526         bool    sv_tainted(SV* sv)
4527
4528 =for hackers
4529 Found in file sv.c
4530
4531 =item sv_true
4532
4533 Returns true if the SV has a true value by Perl's rules.
4534 Use the C<SvTRUE> macro instead, which may call C<sv_true()> or may
4535 instead use an in-line version.
4536
4537         I32     sv_true(SV *sv)
4538
4539 =for hackers
4540 Found in file sv.c
4541
4542 =item sv_unmagic
4543
4544 Removes all magic of type C<type> from an SV.
4545
4546         int     sv_unmagic(SV* sv, int type)
4547
4548 =for hackers
4549 Found in file sv.c
4550
4551 =item sv_unref
4552
4553 Unsets the RV status of the SV, and decrements the reference count of
4554 whatever was being referenced by the RV.  This can almost be thought of
4555 as a reversal of C<newSVrv>.  This is C<sv_unref_flags> with the C<flag>
4556 being zero.  See C<SvROK_off>.
4557
4558         void    sv_unref(SV* sv)
4559
4560 =for hackers
4561 Found in file sv.c
4562
4563 =item sv_unref_flags
4564
4565 Unsets the RV status of the SV, and decrements the reference count of
4566 whatever was being referenced by the RV.  This can almost be thought of
4567 as a reversal of C<newSVrv>.  The C<cflags> argument can contain
4568 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
4569 (otherwise the decrementing is conditional on the reference count being
4570 different from one or the reference being a readonly SV).
4571 See C<SvROK_off>.
4572
4573         void    sv_unref_flags(SV* sv, U32 flags)
4574
4575 =for hackers
4576 Found in file sv.c
4577
4578 =item sv_untaint
4579
4580 Untaint an SV. Use C<SvTAINTED_off> instead.
4581         void    sv_untaint(SV* sv)
4582
4583 =for hackers
4584 Found in file sv.c
4585
4586 =item sv_upgrade
4587
4588 Upgrade an SV to a more complex form.  Generally adds a new body type to the
4589 SV, then copies across as much information as possible from the old body.
4590 You generally want to use the C<SvUPGRADE> macro wrapper. See also C<svtype>.
4591
4592         bool    sv_upgrade(SV* sv, U32 mt)
4593
4594 =for hackers
4595 Found in file sv.c
4596
4597 =item sv_usepvn
4598
4599 Tells an SV to use C<ptr> to find its string value.  Normally the string is
4600 stored inside the SV but sv_usepvn allows the SV to use an outside string.
4601 The C<ptr> should point to memory that was allocated by C<malloc>.  The
4602 string length, C<len>, must be supplied.  This function will realloc the
4603 memory pointed to by C<ptr>, so that pointer should not be freed or used by
4604 the programmer after giving it to sv_usepvn.  Does not handle 'set' magic.
4605 See C<sv_usepvn_mg>.
4606
4607         void    sv_usepvn(SV* sv, char* ptr, STRLEN len)
4608
4609 =for hackers
4610 Found in file sv.c
4611
4612 =item sv_usepvn_mg
4613
4614 Like C<sv_usepvn>, but also handles 'set' magic.
4615
4616         void    sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
4617
4618 =for hackers
4619 Found in file sv.c
4620
4621 =item sv_utf8_decode
4622
4623 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
4624 turn off SvUTF8 if needed so that we see characters. Used as a building block
4625 for decode_utf8 in Encode.xs
4626
4627 NOTE: this function is experimental and may change or be
4628 removed without notice.
4629
4630         bool    sv_utf8_decode(SV *sv)
4631
4632 =for hackers
4633 Found in file sv.c
4634
4635 =item sv_utf8_downgrade
4636
4637 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
4638 This may not be possible if the PV contains non-byte encoding characters;
4639 if this is the case, either returns false or, if C<fail_ok> is not
4640 true, croaks.
4641
4642 This is not as a general purpose Unicode to byte encoding interface:
4643 use the Encode extension for that.
4644
4645 NOTE: this function is experimental and may change or be
4646 removed without notice.
4647
4648         bool    sv_utf8_downgrade(SV *sv, bool fail_ok)
4649
4650 =for hackers
4651 Found in file sv.c
4652
4653 =item sv_utf8_encode
4654
4655 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
4656 flag so that it looks like octets again. Used as a building block
4657 for encode_utf8 in Encode.xs
4658
4659         void    sv_utf8_encode(SV *sv)
4660
4661 =for hackers
4662 Found in file sv.c
4663
4664 =item sv_utf8_upgrade
4665
4666 Convert the PV of an SV to its UTF8-encoded form.
4667 Forces the SV to string form if it is not already.
4668 Always sets the SvUTF8 flag to avoid future validity checks even
4669 if all the bytes have hibit clear.
4670
4671 This is not as a general purpose byte encoding to Unicode interface:
4672 use the Encode extension for that.
4673
4674         STRLEN  sv_utf8_upgrade(SV *sv)
4675
4676 =for hackers
4677 Found in file sv.c
4678
4679 =item sv_utf8_upgrade_flags
4680
4681 Convert the PV of an SV to its UTF8-encoded form.
4682 Forces the SV to string form if it is not already.
4683 Always sets the SvUTF8 flag to avoid future validity checks even
4684 if all the bytes have hibit clear. If C<flags> has C<SV_GMAGIC> bit set,
4685 will C<mg_get> on C<sv> if appropriate, else not. C<sv_utf8_upgrade> and
4686 C<sv_utf8_upgrade_nomg> are implemented in terms of this function.
4687
4688 This is not as a general purpose byte encoding to Unicode interface:
4689 use the Encode extension for that.
4690
4691         STRLEN  sv_utf8_upgrade_flags(SV *sv, I32 flags)
4692
4693 =for hackers
4694 Found in file sv.c
4695
4696 =item sv_uv
4697
4698 A private implementation of the C<SvUVx> macro for compilers which can't
4699 cope with complex macro expressions. Always use the macro instead.
4700
4701         UV      sv_uv(SV* sv)
4702
4703 =for hackers
4704 Found in file sv.c
4705
4706 =item sv_vcatpvfn
4707
4708 Processes its arguments like C<vsprintf> and appends the formatted output
4709 to an SV.  Uses an array of SVs if the C style variable argument list is
4710 missing (NULL).  When running with taint checks enabled, indicates via
4711 C<maybe_tainted> if results are untrustworthy (often due to the use of
4712 locales).
4713
4714 Usually used via one of its frontends C<sv_catpvf> and C<sv_catpvf_mg>.
4715
4716         void    sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4717
4718 =for hackers
4719 Found in file sv.c
4720
4721 =item sv_vsetpvfn
4722
4723 Works like C<vcatpvfn> but copies the text into the SV instead of
4724 appending it.
4725
4726 Usually used via one of its frontends C<sv_setpvf> and C<sv_setpvf_mg>.
4727
4728         void    sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
4729
4730 =for hackers
4731 Found in file sv.c
4732
4733
4734 =back
4735
4736 =head1 Unicode Support
4737
4738 =over 8
4739
4740 =item bytes_from_utf8
4741
4742 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
4743 Unlike <utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
4744 the newly-created string, and updates C<len> to contain the new
4745 length.  Returns the original string if no conversion occurs, C<len>
4746 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
4747 0 if C<s> is converted or contains all 7bit characters.
4748
4749 NOTE: this function is experimental and may change or be
4750 removed without notice.
4751
4752         U8*     bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8)
4753
4754 =for hackers
4755 Found in file utf8.c
4756
4757 =item bytes_to_utf8
4758
4759 Converts a string C<s> of length C<len> from ASCII into UTF8 encoding.
4760 Returns a pointer to the newly-created string, and sets C<len> to
4761 reflect the new length.
4762
4763 If you want to convert to UTF8 from other encodings than ASCII,
4764 see sv_recode_to_utf8().
4765
4766 NOTE: this function is experimental and may change or be
4767 removed without notice.
4768
4769         U8*     bytes_to_utf8(U8 *s, STRLEN *len)
4770
4771 =for hackers
4772 Found in file utf8.c
4773
4774 =item ibcmp_utf8
4775
4776 Return true if the strings s1 and s2 differ case-insensitively, false
4777 if not (if they are equal case-insensitively).  If u1 is true, the
4778 string s1 is assumed to be in UTF-8-encoded Unicode.  If u2 is true,
4779 the string s2 is assumed to be in UTF-8-encoded Unicode.  If u1 or u2
4780 are false, the respective string is assumed to be in native 8-bit
4781 encoding.
4782
4783 If the pe1 and pe2 are non-NULL, the scanning pointers will be copied
4784 in there (they will point at the beginning of the I<next> character).
4785 If the pointers behind pe1 or pe2 are non-NULL, they are the end
4786 pointers beyond which scanning will not continue under any
4787 circustances.  If the byte lengths l1 and l2 are non-zero, s1+l1 and
4788 s2+l2 will be used as goal end pointers that will also stop the scan,
4789 and which qualify towards defining a successful match: all the scans
4790 that define an explicit length must reach their goal pointers for
4791 a match to succeed).
4792
4793 For case-insensitiveness, the "casefolding" of Unicode is used
4794 instead of upper/lowercasing both the characters, see
4795 http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).
4796
4797         I32     ibcmp_utf8(const char* a, char **pe1, UV l1, bool u1, const char* b, char **pe2, UV l2, bool u2)
4798
4799 =for hackers
4800 Found in file utf8.c
4801
4802 =item is_utf8_char
4803
4804 Tests if some arbitrary number of bytes begins in a valid UTF-8
4805 character.  Note that an INVARIANT (i.e. ASCII) character is a valid
4806 UTF-8 character.  The actual number of bytes in the UTF-8 character
4807 will be returned if it is valid, otherwise 0.
4808
4809         STRLEN  is_utf8_char(U8 *p)
4810
4811 =for hackers
4812 Found in file utf8.c
4813
4814 =item is_utf8_string
4815
4816 Returns true if first C<len> bytes of the given string form a valid
4817 UTF8 string, false otherwise.  Note that 'a valid UTF8 string' does
4818 not mean 'a string that contains code points above 0x7F encoded in
4819 UTF8' because a valid ASCII string is a valid UTF8 string.
4820
4821         bool    is_utf8_string(U8 *s, STRLEN len)
4822
4823 =for hackers
4824 Found in file utf8.c
4825
4826 =item pv_uni_display
4827
4828 Build to the scalar dsv a displayable version of the string spv,
4829 length len, the displayable version being at most pvlim bytes long
4830 (if longer, the rest is truncated and "..." will be appended).
4831
4832 The flags argument can have UNI_DISPLAY_ISPRINT set to display
4833 isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH
4834 to display the \\[nrfta\\] as the backslashed versions (like '\n')
4835 (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\).
4836 UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both
4837 UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.
4838
4839 The pointer to the PV of the dsv is returned.
4840
4841         char*   pv_uni_display(SV *dsv, U8 *spv, STRLEN len, STRLEN pvlim, UV flags)
4842
4843 =for hackers
4844 Found in file utf8.c
4845
4846 =item sv_cat_decode
4847
4848 The encoding is assumed to be an Encode object, the PV of the ssv is
4849 assumed to be octets in that encoding and decoding the input starts
4850 from the position which (PV + *offset) pointed to.  The dsv will be
4851 concatenated the decoded UTF-8 string from ssv.  Decoding will terminate
4852 when the string tstr appears in decoding output or the input ends on
4853 the PV of the ssv. The value which the offset points will be modified
4854 to the last input position on the ssv.
4855
4856 Returns TRUE if the terminator was found, else returns FALSE.
4857
4858         bool    sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)
4859
4860 =for hackers
4861 Found in file sv.c
4862
4863 =item sv_recode_to_utf8
4864
4865 The encoding is assumed to be an Encode object, on entry the PV
4866 of the sv is assumed to be octets in that encoding, and the sv
4867 will be converted into Unicode (and UTF-8).
4868
4869 If the sv already is UTF-8 (or if it is not POK), or if the encoding
4870 is not a reference, nothing is done to the sv.  If the encoding is not
4871 an C<Encode::XS> Encoding object, bad things will happen.
4872 (See F<lib/encoding.pm> and L<Encode>).
4873
4874 The PV of the sv is returned.
4875
4876         char*   sv_recode_to_utf8(SV* sv, SV *encoding)
4877
4878 =for hackers
4879 Found in file sv.c
4880
4881 =item sv_uni_display
4882
4883 Build to the scalar dsv a displayable version of the scalar sv,
4884 the displayable version being at most pvlim bytes long
4885 (if longer, the rest is truncated and "..." will be appended).
4886
4887 The flags argument is as in pv_uni_display().
4888
4889 The pointer to the PV of the dsv is returned.
4890
4891         char*   sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)
4892
4893 =for hackers
4894 Found in file utf8.c
4895
4896 =item to_utf8_case
4897
4898 The "p" contains the pointer to the UTF-8 string encoding
4899 the character that is being converted.
4900
4901 The "ustrp" is a pointer to the character buffer to put the
4902 conversion result to.  The "lenp" is a pointer to the length
4903 of the result.
4904
4905 The "swashp" is a pointer to the swash to use.
4906
4907 Both the special and normal mappings are stored lib/unicore/To/Foo.pl,
4908 and loaded by SWASHGET, using lib/utf8_heavy.pl.  The special (usually,
4909 but not always, a multicharacter mapping), is tried first.
4910
4911 The "special" is a string like "utf8::ToSpecLower", which means the
4912 hash %utf8::ToSpecLower.  The access to the hash is through
4913 Perl_to_utf8_case().
4914
4915 The "normal" is a string like "ToLower" which means the swash
4916 %utf8::ToLower.
4917
4918         UV      to_utf8_case(U8 *p, U8* ustrp, STRLEN *lenp, SV **swash, char *normal, char *special)
4919
4920 =for hackers
4921 Found in file utf8.c
4922
4923 =item to_utf8_fold
4924
4925 Convert the UTF-8 encoded character at p to its foldcase version and
4926 store that in UTF-8 in ustrp and its length in bytes in lenp.  Note
4927 that the ustrp needs to be at least UTF8_MAXLEN_FOLD+1 bytes since the
4928 foldcase version may be longer than the original character (up to
4929 three characters).
4930
4931 The first character of the foldcased version is returned
4932 (but note, as explained above, that there may be more.)
4933
4934         UV      to_utf8_fold(U8 *p, U8* ustrp, STRLEN *lenp)
4935
4936 =for hackers
4937 Found in file utf8.c
4938
4939 =item to_utf8_lower
4940
4941 Convert the UTF-8 encoded character at p to its lowercase version and
4942 store that in UTF-8 in ustrp and its length in bytes in lenp.  Note
4943 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4944 lowercase version may be longer than the original character (up to two
4945 characters).
4946
4947 The first character of the lowercased version is returned
4948 (but note, as explained above, that there may be more.)
4949
4950         UV      to_utf8_lower(U8 *p, U8* ustrp, STRLEN *lenp)
4951
4952 =for hackers
4953 Found in file utf8.c
4954
4955 =item to_utf8_title
4956
4957 Convert the UTF-8 encoded character at p to its titlecase version and
4958 store that in UTF-8 in ustrp and its length in bytes in lenp.  Note
4959 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4960 titlecase version may be longer than the original character (up to two
4961 characters).
4962
4963 The first character of the titlecased version is returned
4964 (but note, as explained above, that there may be more.)
4965
4966         UV      to_utf8_title(U8 *p, U8* ustrp, STRLEN *lenp)
4967
4968 =for hackers
4969 Found in file utf8.c
4970
4971 =item to_utf8_upper
4972
4973 Convert the UTF-8 encoded character at p to its uppercase version and
4974 store that in UTF-8 in ustrp and its length in bytes in lenp.  Note
4975 that the ustrp needs to be at least UTF8_MAXLEN_UCLC+1 bytes since the
4976 uppercase version may be longer than the original character (up to two
4977 characters).
4978
4979 The first character of the uppercased version is returned
4980 (but note, as explained above, that there may be more.)
4981
4982         UV      to_utf8_upper(U8 *p, U8* ustrp, STRLEN *lenp)
4983
4984 =for hackers
4985 Found in file utf8.c
4986
4987 =item utf8n_to_uvchr
4988
4989 Returns the native character value of the first character in the string C<s>
4990 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
4991 length, in bytes, of that character.
4992
4993 Allows length and flags to be passed to low level routine.
4994
4995         UV      utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
4996
4997 =for hackers
4998 Found in file utf8.c
4999
5000 =item utf8n_to_uvuni
5001
5002 Bottom level UTF-8 decode routine.
5003 Returns the unicode code point value of the first character in the string C<s>
5004 which is assumed to be in UTF8 encoding and no longer than C<curlen>;
5005 C<retlen> will be set to the length, in bytes, of that character.
5006
5007 If C<s> does not point to a well-formed UTF8 character, the behaviour
5008 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
5009 it is assumed that the caller will raise a warning, and this function
5010 will silently just set C<retlen> to C<-1> and return zero.  If the
5011 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
5012 malformations will be given, C<retlen> will be set to the expected
5013 length of the UTF-8 character in bytes, and zero will be returned.
5014
5015 The C<flags> can also contain various flags to allow deviations from
5016 the strict UTF-8 encoding (see F<utf8.h>).
5017
5018 Most code should use utf8_to_uvchr() rather than call this directly.
5019
5020         UV      utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
5021
5022 =for hackers
5023 Found in file utf8.c
5024
5025 =item utf8_distance
5026
5027 Returns the number of UTF8 characters between the UTF-8 pointers C<a>
5028 and C<b>.
5029
5030 WARNING: use only if you *know* that the pointers point inside the
5031 same UTF-8 buffer.
5032
5033         IV      utf8_distance(U8 *a, U8 *b)
5034
5035 =for hackers
5036 Found in file utf8.c
5037
5038 =item utf8_hop
5039
5040 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
5041 forward or backward.
5042
5043 WARNING: do not use the following unless you *know* C<off> is within
5044 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
5045 on the first byte of character or just after the last byte of a character.
5046
5047         U8*     utf8_hop(U8 *s, I32 off)
5048
5049 =for hackers
5050 Found in file utf8.c
5051
5052 =item utf8_length
5053
5054 Return the length of the UTF-8 char encoded string C<s> in characters.
5055 Stops at C<e> (inclusive).  If C<e E<lt> s> or if the scan would end
5056 up past C<e>, croaks.
5057
5058         STRLEN  utf8_length(U8* s, U8 *e)
5059
5060 =for hackers
5061 Found in file utf8.c
5062
5063 =item utf8_to_bytes
5064
5065 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
5066 Unlike C<bytes_to_utf8>, this over-writes the original string, and
5067 updates len to contain the new length.
5068 Returns zero on failure, setting C<len> to -1.
5069
5070 NOTE: this function is experimental and may change or be
5071 removed without notice.
5072
5073         U8*     utf8_to_bytes(U8 *s, STRLEN *len)
5074
5075 =for hackers
5076 Found in file utf8.c
5077
5078 =item utf8_to_uvchr
5079
5080 Returns the native character value of the first character in the string C<s>
5081 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
5082 length, in bytes, of that character.
5083
5084 If C<s> does not point to a well-formed UTF8 character, zero is
5085 returned and retlen is set, if possible, to -1.
5086
5087         UV      utf8_to_uvchr(U8 *s, STRLEN* retlen)
5088
5089 =for hackers
5090 Found in file utf8.c
5091
5092 =item utf8_to_uvuni
5093
5094 Returns the Unicode code point of the first character in the string C<s>
5095 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
5096 length, in bytes, of that character.
5097
5098 This function should only be used when returned UV is considered
5099 an index into the Unicode semantic tables (e.g. swashes).
5100
5101 If C<s> does not point to a well-formed UTF8 character, zero is
5102 returned and retlen is set, if possible, to -1.
5103
5104         UV      utf8_to_uvuni(U8 *s, STRLEN* retlen)
5105
5106 =for hackers
5107 Found in file utf8.c
5108
5109 =item uvchr_to_utf8
5110
5111 Adds the UTF8 representation of the Native codepoint C<uv> to the end
5112 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
5113 bytes available. The return value is the pointer to the byte after the
5114 end of the new character. In other words,
5115
5116     d = uvchr_to_utf8(d, uv);
5117
5118 is the recommended wide native character-aware way of saying
5119
5120     *(d++) = uv;
5121
5122         U8*     uvchr_to_utf8(U8 *d, UV uv)
5123
5124 =for hackers
5125 Found in file utf8.c
5126
5127 =item uvuni_to_utf8_flags
5128
5129 Adds the UTF8 representation of the Unicode codepoint C<uv> to the end
5130 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
5131 bytes available. The return value is the pointer to the byte after the
5132 end of the new character. In other words,
5133
5134     d = uvuni_to_utf8_flags(d, uv, flags);
5135
5136 or, in most cases,
5137
5138     d = uvuni_to_utf8(d, uv);
5139
5140 (which is equivalent to)
5141
5142     d = uvuni_to_utf8_flags(d, uv, 0);
5143
5144 is the recommended Unicode-aware way of saying
5145
5146     *(d++) = uv;
5147
5148         U8*     uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)
5149
5150 =for hackers
5151 Found in file utf8.c
5152
5153
5154 =back
5155
5156 =head1 Variables created by C<xsubpp> and C<xsubpp> internal functions
5157
5158 =over 8
5159
5160 =item ax
5161
5162 Variable which is setup by C<xsubpp> to indicate the stack base offset,
5163 used by the C<ST>, C<XSprePUSH> and C<XSRETURN> macros.  The C<dMARK> macro
5164 must be called prior to setup the C<MARK> variable.
5165
5166         I32     ax
5167
5168 =for hackers
5169 Found in file XSUB.h
5170
5171 =item CLASS
5172
5173 Variable which is setup by C<xsubpp> to indicate the 
5174 class name for a C++ XS constructor.  This is always a C<char*>.  See C<THIS>.
5175
5176         char*   CLASS
5177
5178 =for hackers
5179 Found in file XSUB.h
5180
5181 =item dAX
5182
5183 Sets up the C<ax> variable.
5184 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5185
5186                 dAX;
5187
5188 =for hackers
5189 Found in file XSUB.h
5190
5191 =item dITEMS
5192
5193 Sets up the C<items> variable.
5194 This is usually handled automatically by C<xsubpp> by calling C<dXSARGS>.
5195
5196                 dITEMS;
5197
5198 =for hackers
5199 Found in file XSUB.h
5200
5201 =item dXSARGS
5202
5203 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
5204 Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
5205 This is usually handled automatically by C<xsubpp>.
5206
5207                 dXSARGS;
5208
5209 =for hackers
5210 Found in file XSUB.h
5211
5212 =item dXSI32
5213
5214 Sets up the C<ix> variable for an XSUB which has aliases.  This is usually
5215 handled automatically by C<xsubpp>.
5216
5217                 dXSI32;
5218
5219 =for hackers
5220 Found in file XSUB.h
5221
5222 =item items
5223
5224 Variable which is setup by C<xsubpp> to indicate the number of 
5225 items on the stack.  See L<perlxs/"Variable-length Parameter Lists">.
5226
5227         I32     items
5228
5229 =for hackers
5230 Found in file XSUB.h
5231
5232 =item ix
5233
5234 Variable which is setup by C<xsubpp> to indicate which of an 
5235 XSUB's aliases was used to invoke it.  See L<perlxs/"The ALIAS: Keyword">.
5236
5237         I32     ix
5238
5239 =for hackers
5240 Found in file XSUB.h
5241
5242 =item newXSproto
5243
5244 Used by C<xsubpp> to hook up XSUBs as Perl subs.  Adds Perl prototypes to
5245 the subs.
5246
5247 =for hackers
5248 Found in file XSUB.h
5249
5250 =item RETVAL
5251
5252 Variable which is setup by C<xsubpp> to hold the return value for an 
5253 XSUB. This is always the proper type for the XSUB. See 
5254 L<perlxs/"The RETVAL Variable">.
5255
5256         (whatever)      RETVAL
5257
5258 =for hackers
5259 Found in file XSUB.h
5260
5261 =item ST
5262
5263 Used to access elements on the XSUB's stack.
5264
5265         SV*     ST(int ix)
5266
5267 =for hackers
5268 Found in file XSUB.h
5269
5270 =item THIS
5271
5272 Variable which is setup by C<xsubpp> to designate the object in a C++ 
5273 XSUB.  This is always the proper type for the C++ object.  See C<CLASS> and 
5274 L<perlxs/"Using XS With C++">.
5275
5276         (whatever)      THIS
5277
5278 =for hackers
5279 Found in file XSUB.h
5280
5281 =item XS
5282
5283 Macro to declare an XSUB and its C parameter list.  This is handled by
5284 C<xsubpp>.
5285
5286 =for hackers
5287 Found in file XSUB.h
5288
5289 =item XSRETURN_EMPTY
5290
5291 Return an empty list from an XSUB immediately.
5292
5293
5294                 XSRETURN_EMPTY;
5295
5296 =for hackers
5297 Found in file XSUB.h
5298
5299 =item XS_VERSION
5300
5301 The version identifier for an XS module.  This is usually
5302 handled automatically by C<ExtUtils::MakeMaker>.  See C<XS_VERSION_BOOTCHECK>.
5303
5304 =for hackers
5305 Found in file XSUB.h
5306
5307 =item XS_VERSION_BOOTCHECK
5308
5309 Macro to verify that a PM module's $VERSION variable matches the XS
5310 module's C<XS_VERSION> variable.  This is usually handled automatically by
5311 C<xsubpp>.  See L<perlxs/"The VERSIONCHECK: Keyword">.
5312
5313                 XS_VERSION_BOOTCHECK;
5314
5315 =for hackers
5316 Found in file XSUB.h
5317
5318
5319 =back
5320
5321 =head1 Warning and Dieing
5322
5323 =over 8
5324
5325 =item croak
5326
5327 This is the XSUB-writer's interface to Perl's C<die> function.
5328 Normally use this function the same way you use the C C<printf>
5329 function.  See C<warn>.
5330
5331 If you want to throw an exception object, assign the object to
5332 C<$@> and then pass C<Nullch> to croak():
5333
5334    errsv = get_sv("@", TRUE);
5335    sv_setsv(errsv, exception_object);
5336    croak(Nullch);
5337
5338         void    croak(const char* pat, ...)
5339
5340 =for hackers
5341 Found in file util.c
5342
5343 =item warn
5344
5345 This is the XSUB-writer's interface to Perl's C<warn> function.  Use this
5346 function the same way you use the C C<printf> function.  See
5347 C<croak>.
5348
5349         void    warn(const char* pat, ...)
5350
5351 =for hackers
5352 Found in file util.c
5353
5354
5355 =back
5356
5357 =head1 AUTHORS
5358
5359 Until May 1997, this document was maintained by Jeff Okamoto
5360 <okamoto@corp.hp.com>.  It is now maintained as part of Perl itself.
5361
5362 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
5363 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
5364 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
5365 Stephen McCamant, and Gurusamy Sarathy.
5366
5367 API Listing originally by Dean Roehrich <roehrich@cray.com>.
5368
5369 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
5370
5371 =head1 SEE ALSO
5372
5373 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
5374