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