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