This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
514e1589667f8693cf15fe1423cf5efa0efdf212
[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* ar)
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* ar, 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* ar, 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* ar, 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* ar, 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* ar, 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* ar)
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** svp)
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* ar)
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* ar, 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* ar)
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* ar, 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* ar)
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* ar, 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, 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* interp, 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* interp)
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* interp)
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* interp)
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* interp, 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* interp)
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 *dstr, SV *sstr)
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 *len)
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 *len)
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 *len)
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 =for hackers
1403 Found in file av.h
1404
1405 =item Nullch
1406 X<Nullch>
1407
1408 Null character pointer. (No longer available when C<PERL_CORE> is defined.)
1409
1410 =for hackers
1411 Found in file handy.h
1412
1413 =item Nullcv
1414 X<Nullcv>
1415
1416 Null CV pointer.
1417
1418 =for hackers
1419 Found in file cv.h
1420
1421 =item Nullhv
1422 X<Nullhv>
1423
1424 Null HV pointer.
1425
1426 =for hackers
1427 Found in file hv.h
1428
1429 =item Nullsv
1430 X<Nullsv>
1431
1432 Null SV pointer. (No longer available when C<PERL_CORE> is defined.)
1433
1434 =for hackers
1435 Found in file handy.h
1436
1437
1438 =back
1439
1440 =head1 Hash Manipulation Functions
1441
1442 =over 8
1443
1444 =item get_hv
1445 X<get_hv>
1446
1447 Returns the HV of the specified Perl hash.  If C<create> is set and the
1448 Perl variable does not exist then it will be created.  If C<create> is not
1449 set and the variable does not exist then NULL is returned.
1450
1451 NOTE: the perl_ form of this function is deprecated.
1452
1453         HV*     get_hv(const char* name, I32 create)
1454
1455 =for hackers
1456 Found in file perl.c
1457
1458 =item HEf_SVKEY
1459 X<HEf_SVKEY>
1460
1461 This flag, used in the length slot of hash entries and magic structures,
1462 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
1463 is to be expected. (For information only--not to be used).
1464
1465 =for hackers
1466 Found in file hv.h
1467
1468 =item HeHASH
1469 X<HeHASH>
1470
1471 Returns the computed hash stored in the hash entry.
1472
1473         U32     HeHASH(HE* he)
1474
1475 =for hackers
1476 Found in file hv.h
1477
1478 =item HeKEY
1479 X<HeKEY>
1480
1481 Returns the actual pointer stored in the key slot of the hash entry. The
1482 pointer may be either C<char*> or C<SV*>, depending on the value of
1483 C<HeKLEN()>.  Can be assigned to.  The C<HePV()> or C<HeSVKEY()> macros are
1484 usually preferable for finding the value of a key.
1485
1486         void*   HeKEY(HE* he)
1487
1488 =for hackers
1489 Found in file hv.h
1490
1491 =item HeKLEN
1492 X<HeKLEN>
1493
1494 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
1495 holds an C<SV*> key.  Otherwise, holds the actual length of the key.  Can
1496 be assigned to. The C<HePV()> macro is usually preferable for finding key
1497 lengths.
1498
1499         STRLEN  HeKLEN(HE* he)
1500
1501 =for hackers
1502 Found in file hv.h
1503
1504 =item HePV
1505 X<HePV>
1506
1507 Returns the key slot of the hash entry as a C<char*> value, doing any
1508 necessary dereferencing of possibly C<SV*> keys.  The length of the string
1509 is placed in C<len> (this is a macro, so do I<not> use C<&len>).  If you do
1510 not care about what the length of the key is, you may use the global
1511 variable C<PL_na>, though this is rather less efficient than using a local
1512 variable.  Remember though, that hash keys in perl are free to contain
1513 embedded nulls, so using C<strlen()> or similar is not a good way to find
1514 the length of hash keys. This is very similar to the C<SvPV()> macro
1515 described elsewhere in this document. See also C<HeUTF8>.
1516
1517 If you are using C<HePV> to get values to pass to C<newSVpvn()> to create a
1518 new SV, you should consider using C<newSVhek(HeKEY_hek(he))> as it is more
1519 efficient.
1520
1521         char*   HePV(HE* he, STRLEN len)
1522
1523 =for hackers
1524 Found in file hv.h
1525
1526 =item HeSVKEY
1527 X<HeSVKEY>
1528
1529 Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
1530 contain an C<SV*> key.
1531
1532         SV*     HeSVKEY(HE* he)
1533
1534 =for hackers
1535 Found in file hv.h
1536
1537 =item HeSVKEY_force
1538 X<HeSVKEY_force>
1539
1540 Returns the key as an C<SV*>.  Will create and return a temporary mortal
1541 C<SV*> if the hash entry contains only a C<char*> key.
1542
1543         SV*     HeSVKEY_force(HE* he)
1544
1545 =for hackers
1546 Found in file hv.h
1547
1548 =item HeSVKEY_set
1549 X<HeSVKEY_set>
1550
1551 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
1552 indicate the presence of an C<SV*> key, and returns the same
1553 C<SV*>.
1554
1555         SV*     HeSVKEY_set(HE* he, SV* sv)
1556
1557 =for hackers
1558 Found in file hv.h
1559
1560 =item HeUTF8
1561 X<HeUTF8>
1562
1563 Returns whether the C<char *> value returned by C<HePV> is encoded in UTF-8,
1564 doing any necessary dereferencing of possibly C<SV*> keys.  The value returned
1565 will be 0 or non-0, not necessarily 1 (or even a value with any low bits set),
1566 so B<do not> blindly assign this to a C<bool> variable, as C<bool> may be a
1567 typedef for C<char>.
1568
1569         char*   HeUTF8(HE* he, STRLEN len)
1570
1571 =for hackers
1572 Found in file hv.h
1573
1574 =item HeVAL
1575 X<HeVAL>
1576
1577 Returns the value slot (type C<SV*>) stored in the hash entry.
1578
1579         SV*     HeVAL(HE* he)
1580
1581 =for hackers
1582 Found in file hv.h
1583
1584 =item HvNAME
1585 X<HvNAME>
1586
1587 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
1588 See C<SvSTASH>, C<CvSTASH>.
1589
1590         char*   HvNAME(HV* stash)
1591
1592 =for hackers
1593 Found in file hv.h
1594
1595 =item hv_assert
1596 X<hv_assert>
1597
1598 Check that a hash is in an internally consistent state.
1599
1600         void    hv_assert(HV* tb)
1601
1602 =for hackers
1603 Found in file hv.c
1604
1605 =item hv_clear
1606 X<hv_clear>
1607
1608 Clears a hash, making it empty.
1609
1610         void    hv_clear(HV* tb)
1611
1612 =for hackers
1613 Found in file hv.c
1614
1615 =item hv_clear_placeholders
1616 X<hv_clear_placeholders>
1617
1618 Clears any placeholders from a hash.  If a restricted hash has any of its keys
1619 marked as readonly and the key is subsequently deleted, the key is not actually
1620 deleted but is marked by assigning it a value of &PL_sv_placeholder.  This tags
1621 it so it will be ignored by future operations such as iterating over the hash,
1622 but will still allow the hash to have a value reassigned to the key at some
1623 future point.  This function clears any such placeholder keys from the hash.
1624 See Hash::Util::lock_keys() for an example of its use.
1625
1626         void    hv_clear_placeholders(HV* hb)
1627
1628 =for hackers
1629 Found in file hv.c
1630
1631 =item hv_delete
1632 X<hv_delete>
1633
1634 Deletes a key/value pair in the hash.  The value SV is removed from the
1635 hash and returned to the caller.  The C<klen> is the length of the key.
1636 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
1637 will be returned.
1638
1639         SV*     hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
1640
1641 =for hackers
1642 Found in file hv.c
1643
1644 =item hv_delete_ent
1645 X<hv_delete_ent>
1646
1647 Deletes a key/value pair in the hash.  The value SV is removed from the
1648 hash and returned to the caller.  The C<flags> value will normally be zero;
1649 if set to G_DISCARD then NULL will be returned.  C<hash> can be a valid
1650 precomputed hash value, or 0 to ask for it to be computed.
1651
1652         SV*     hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
1653
1654 =for hackers
1655 Found in file hv.c
1656
1657 =item hv_exists
1658 X<hv_exists>
1659
1660 Returns a boolean indicating whether the specified hash key exists.  The
1661 C<klen> is the length of the key.
1662
1663         bool    hv_exists(HV* tb, const char* key, I32 klen)
1664
1665 =for hackers
1666 Found in file hv.c
1667
1668 =item hv_exists_ent
1669 X<hv_exists_ent>
1670
1671 Returns a boolean indicating whether the specified hash key exists. C<hash>
1672 can be a valid precomputed hash value, or 0 to ask for it to be
1673 computed.
1674
1675         bool    hv_exists_ent(HV* tb, SV* key, U32 hash)
1676
1677 =for hackers
1678 Found in file hv.c
1679
1680 =item hv_fetch
1681 X<hv_fetch>
1682
1683 Returns the SV which corresponds to the specified key in the hash.  The
1684 C<klen> is the length of the key.  If C<lval> is set then the fetch will be
1685 part of a store.  Check that the return value is non-null before
1686 dereferencing it to an C<SV*>.
1687
1688 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1689 information on how to use this function on tied hashes.
1690
1691         SV**    hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
1692
1693 =for hackers
1694 Found in file hv.c
1695
1696 =item hv_fetchs
1697 X<hv_fetchs>
1698
1699 Like C<hv_fetch>, but takes a literal string instead of a string/length pair.
1700
1701         SV**    hv_fetchs(HV* tb, const char* key, I32 lval)
1702
1703 =for hackers
1704 Found in file handy.h
1705
1706 =item hv_fetch_ent
1707 X<hv_fetch_ent>
1708
1709 Returns the hash entry which corresponds to the specified key in the hash.
1710 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
1711 if you want the function to compute it.  IF C<lval> is set then the fetch
1712 will be part of a store.  Make sure the return value is non-null before
1713 accessing it.  The return value when C<tb> is a tied hash is a pointer to a
1714 static location, so be sure to make a copy of the structure if you need to
1715 store it somewhere.
1716
1717 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1718 information on how to use this function on tied hashes.
1719
1720         HE*     hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
1721
1722 =for hackers
1723 Found in file hv.c
1724
1725 =item hv_iterinit
1726 X<hv_iterinit>
1727
1728 Prepares a starting point to traverse a hash table.  Returns the number of
1729 keys in the hash (i.e. the same as C<HvKEYS(tb)>).  The return value is
1730 currently only meaningful for hashes without tie magic.
1731
1732 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
1733 hash buckets that happen to be in use.  If you still need that esoteric
1734 value, you can get it through the macro C<HvFILL(tb)>.
1735
1736
1737         I32     hv_iterinit(HV* tb)
1738
1739 =for hackers
1740 Found in file hv.c
1741
1742 =item hv_iterkey
1743 X<hv_iterkey>
1744
1745 Returns the key from the current position of the hash iterator.  See
1746 C<hv_iterinit>.
1747
1748         char*   hv_iterkey(HE* entry, I32* retlen)
1749
1750 =for hackers
1751 Found in file hv.c
1752
1753 =item hv_iterkeysv
1754 X<hv_iterkeysv>
1755
1756 Returns the key as an C<SV*> from the current position of the hash
1757 iterator.  The return value will always be a mortal copy of the key.  Also
1758 see C<hv_iterinit>.
1759
1760         SV*     hv_iterkeysv(HE* entry)
1761
1762 =for hackers
1763 Found in file hv.c
1764
1765 =item hv_iternext
1766 X<hv_iternext>
1767
1768 Returns entries from a hash iterator.  See C<hv_iterinit>.
1769
1770 You may call C<hv_delete> or C<hv_delete_ent> on the hash entry that the
1771 iterator currently points to, without losing your place or invalidating your
1772 iterator.  Note that in this case the current entry is deleted from the hash
1773 with your iterator holding the last reference to it.  Your iterator is flagged
1774 to free the entry on the next call to C<hv_iternext>, so you must not discard
1775 your iterator immediately else the entry will leak - call C<hv_iternext> to
1776 trigger the resource deallocation.
1777
1778         HE*     hv_iternext(HV* tb)
1779
1780 =for hackers
1781 Found in file hv.c
1782
1783 =item hv_iternextsv
1784 X<hv_iternextsv>
1785
1786 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1787 operation.
1788
1789         SV*     hv_iternextsv(HV* hv, char** key, I32* retlen)
1790
1791 =for hackers
1792 Found in file hv.c
1793
1794 =item hv_iternext_flags
1795 X<hv_iternext_flags>
1796
1797 Returns entries from a hash iterator.  See C<hv_iterinit> and C<hv_iternext>.
1798 The C<flags> value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is
1799 set the placeholders keys (for restricted hashes) will be returned in addition
1800 to normal keys. By default placeholders are automatically skipped over.
1801 Currently a placeholder is implemented with a value that is
1802 C<&Perl_sv_placeholder>. Note that the implementation of placeholders and
1803 restricted hashes may change, and the implementation currently is
1804 insufficiently abstracted for any change to be tidy.
1805
1806 NOTE: this function is experimental and may change or be
1807 removed without notice.
1808
1809         HE*     hv_iternext_flags(HV* tb, I32 flags)
1810
1811 =for hackers
1812 Found in file hv.c
1813
1814 =item hv_iterval
1815 X<hv_iterval>
1816
1817 Returns the value from the current position of the hash iterator.  See
1818 C<hv_iterkey>.
1819
1820         SV*     hv_iterval(HV* tb, HE* entry)
1821
1822 =for hackers
1823 Found in file hv.c
1824
1825 =item hv_magic
1826 X<hv_magic>
1827
1828 Adds magic to a hash.  See C<sv_magic>.
1829
1830         void    hv_magic(HV* hv, GV* gv, int how)
1831
1832 =for hackers
1833 Found in file hv.c
1834
1835 =item hv_scalar
1836 X<hv_scalar>
1837
1838 Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.
1839
1840         SV*     hv_scalar(HV* hv)
1841
1842 =for hackers
1843 Found in file hv.c
1844
1845 =item hv_store
1846 X<hv_store>
1847
1848 Stores an SV in a hash.  The hash key is specified as C<key> and C<klen> is
1849 the length of the key.  The C<hash> parameter is the precomputed hash
1850 value; if it is zero then Perl will compute it.  The return value will be
1851 NULL if the operation failed or if the value did not need to be actually
1852 stored within the hash (as in the case of tied hashes).  Otherwise it can
1853 be dereferenced to get the original C<SV*>.  Note that the caller is
1854 responsible for suitably incrementing the reference count of C<val> before
1855 the call, and decrementing it if the function returned NULL.  Effectively
1856 a successful hv_store takes ownership of one reference to C<val>.  This is
1857 usually what you want; a newly created SV has a reference count of one, so
1858 if all your code does is create SVs then store them in a hash, hv_store
1859 will own the only reference to the new SV, and your code doesn't need to do
1860 anything further to tidy up.  hv_store is not implemented as a call to
1861 hv_store_ent, and does not create a temporary SV for the key, so if your
1862 key data is not already in SV form then use hv_store in preference to
1863 hv_store_ent.
1864
1865 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1866 information on how to use this function on tied hashes.
1867
1868         SV**    hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
1869
1870 =for hackers
1871 Found in file hv.c
1872
1873 =item hv_stores
1874 X<hv_stores>
1875
1876 Like C<hv_store>, but takes a literal string instead of a string/length pair
1877 and omits the hash parameter.
1878
1879         SV**    hv_stores(HV* tb, const char* key, NULLOK SV* val)
1880
1881 =for hackers
1882 Found in file handy.h
1883
1884 =item hv_store_ent
1885 X<hv_store_ent>
1886
1887 Stores C<val> in a hash.  The hash key is specified as C<key>.  The C<hash>
1888 parameter is the precomputed hash value; if it is zero then Perl will
1889 compute it.  The return value is the new hash entry so created.  It will be
1890 NULL if the operation failed or if the value did not need to be actually
1891 stored within the hash (as in the case of tied hashes).  Otherwise the
1892 contents of the return value can be accessed using the C<He?> macros
1893 described here.  Note that the caller is responsible for suitably
1894 incrementing the reference count of C<val> before the call, and
1895 decrementing it if the function returned NULL.  Effectively a successful
1896 hv_store_ent takes ownership of one reference to C<val>.  This is
1897 usually what you want; a newly created SV has a reference count of one, so
1898 if all your code does is create SVs then store them in a hash, hv_store
1899 will own the only reference to the new SV, and your code doesn't need to do
1900 anything further to tidy up.  Note that hv_store_ent only reads the C<key>;
1901 unlike C<val> it does not take ownership of it, so maintaining the correct
1902 reference count on C<key> is entirely the caller's responsibility.  hv_store
1903 is not implemented as a call to hv_store_ent, and does not create a temporary
1904 SV for the key, so if your key data is not already in SV form then use
1905 hv_store in preference to hv_store_ent.
1906
1907 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
1908 information on how to use this function on tied hashes.
1909
1910         HE*     hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
1911
1912 =for hackers
1913 Found in file hv.c
1914
1915 =item hv_undef
1916 X<hv_undef>
1917
1918 Undefines the hash.
1919
1920         void    hv_undef(HV* tb)
1921
1922 =for hackers
1923 Found in file hv.c
1924
1925 =item newHV
1926 X<newHV>
1927
1928 Creates a new HV.  The reference count is set to 1.
1929
1930         HV*     newHV()
1931
1932 =for hackers
1933 Found in file hv.h
1934
1935
1936 =back
1937
1938 =head1 Magical Functions
1939
1940 =over 8
1941
1942 =item mg_clear
1943 X<mg_clear>
1944
1945 Clear something magical that the SV represents.  See C<sv_magic>.
1946
1947         int     mg_clear(SV* sv)
1948
1949 =for hackers
1950 Found in file mg.c
1951
1952 =item mg_copy
1953 X<mg_copy>
1954
1955 Copies the magic from one SV to another.  See C<sv_magic>.
1956
1957         int     mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1958
1959 =for hackers
1960 Found in file mg.c
1961
1962 =item mg_find
1963 X<mg_find>
1964
1965 Finds the magic pointer for type matching the SV.  See C<sv_magic>.
1966
1967         MAGIC*  mg_find(const SV* sv, int type)
1968
1969 =for hackers
1970 Found in file mg.c
1971
1972 =item mg_free
1973 X<mg_free>
1974
1975 Free any magic storage used by the SV.  See C<sv_magic>.
1976
1977         int     mg_free(SV* sv)
1978
1979 =for hackers
1980 Found in file mg.c
1981
1982 =item mg_get
1983 X<mg_get>
1984
1985 Do magic after a value is retrieved from the SV.  See C<sv_magic>.
1986
1987         int     mg_get(SV* sv)
1988
1989 =for hackers
1990 Found in file mg.c
1991
1992 =item mg_length
1993 X<mg_length>
1994
1995 Report on the SV's length.  See C<sv_magic>.
1996
1997         U32     mg_length(SV* sv)
1998
1999 =for hackers
2000 Found in file mg.c
2001
2002 =item mg_magical
2003 X<mg_magical>
2004
2005 Turns on the magical status of an SV.  See C<sv_magic>.
2006
2007         void    mg_magical(SV* sv)
2008
2009 =for hackers
2010 Found in file mg.c
2011
2012 =item mg_set
2013 X<mg_set>
2014
2015 Do magic after a value is assigned to the SV.  See C<sv_magic>.
2016
2017         int     mg_set(SV* sv)
2018
2019 =for hackers
2020 Found in file mg.c
2021
2022 =item SvGETMAGIC
2023 X<SvGETMAGIC>
2024
2025 Invokes C<mg_get> on an SV if it has 'get' magic.  This macro evaluates its
2026 argument more than once.
2027
2028         void    SvGETMAGIC(SV* sv)
2029
2030 =for hackers
2031 Found in file sv.h
2032
2033 =item SvLOCK
2034 X<SvLOCK>
2035
2036 Arranges for a mutual exclusion lock to be obtained on sv if a suitable module
2037 has been loaded.
2038
2039         void    SvLOCK(SV* sv)
2040
2041 =for hackers
2042 Found in file sv.h
2043
2044 =item SvSETMAGIC
2045 X<SvSETMAGIC>
2046
2047 Invokes C<mg_set> on an SV if it has 'set' magic.  This macro evaluates its
2048 argument more than once.
2049
2050         void    SvSETMAGIC(SV* sv)
2051
2052 =for hackers
2053 Found in file sv.h
2054
2055 =item SvSetMagicSV
2056 X<SvSetMagicSV>
2057
2058 Like C<SvSetSV>, but does any set magic required afterwards.
2059
2060         void    SvSetMagicSV(SV* dsb, SV* ssv)
2061
2062 =for hackers
2063 Found in file sv.h
2064
2065 =item SvSetMagicSV_nosteal
2066 X<SvSetMagicSV_nosteal>
2067
2068 Like C<SvSetSV_nosteal>, but does any set magic required afterwards.
2069
2070         void    SvSetMagicSV_nosteal(SV* dsv, SV* ssv)
2071
2072 =for hackers
2073 Found in file sv.h
2074
2075 =item SvSetSV
2076 X<SvSetSV>
2077
2078 Calls C<sv_setsv> if dsv is not the same as ssv.  May evaluate arguments
2079 more than once.
2080
2081         void    SvSetSV(SV* dsb, SV* ssv)
2082
2083 =for hackers
2084 Found in file sv.h
2085
2086 =item SvSetSV_nosteal
2087 X<SvSetSV_nosteal>
2088
2089 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2090 ssv. May evaluate arguments more than once.
2091
2092         void    SvSetSV_nosteal(SV* dsv, SV* ssv)
2093
2094 =for hackers
2095 Found in file sv.h
2096
2097 =item SvSHARE
2098 X<SvSHARE>
2099
2100 Arranges for sv to be shared between threads if a suitable module
2101 has been loaded.
2102
2103         void    SvSHARE(SV* sv)
2104
2105 =for hackers
2106 Found in file sv.h
2107
2108 =item SvUNLOCK
2109 X<SvUNLOCK>
2110
2111 Releases a mutual exclusion lock on sv if a suitable module
2112 has been loaded.
2113
2114         void    SvUNLOCK(SV* sv)
2115
2116 =for hackers
2117 Found in file sv.h
2118
2119
2120 =back
2121
2122 =head1 Memory Management
2123
2124 =over 8
2125
2126 =item Copy
2127 X<Copy>
2128
2129 The XSUB-writer's interface to the C C<memcpy> function.  The C<src> is the
2130 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2131 the type.  May fail on overlapping copies.  See also C<Move>.
2132
2133         void    Copy(void* src, void* dest, int nitems, type)
2134
2135 =for hackers
2136 Found in file handy.h
2137
2138 =item CopyD
2139 X<CopyD>
2140
2141 Like C<Copy> but returns dest. Useful for encouraging compilers to tail-call
2142 optimise.
2143
2144         void *  CopyD(void* src, void* dest, int nitems, type)
2145
2146 =for hackers
2147 Found in file handy.h
2148
2149 =item Move
2150 X<Move>
2151
2152 The XSUB-writer's interface to the C C<memmove> function.  The C<src> is the
2153 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
2154 the type.  Can do overlapping moves.  See also C<Copy>.
2155
2156         void    Move(void* src, void* dest, int nitems, type)
2157
2158 =for hackers
2159 Found in file handy.h
2160
2161 =item MoveD
2162 X<MoveD>
2163
2164 Like C<Move> but returns dest. Useful for encouraging compilers to tail-call
2165 optimise.
2166
2167         void *  MoveD(void* src, void* dest, int nitems, type)
2168
2169 =for hackers
2170 Found in file handy.h
2171
2172 =item Newx
2173 X<Newx>
2174
2175 The XSUB-writer's interface to the C C<malloc> function.
2176
2177 In 5.9.3, Newx() and friends replace the older New() API, and drops
2178 the first parameter, I<x>, a debug aid which allowed callers to identify
2179 themselves.  This aid has been superseded by a new build option,
2180 PERL_MEM_LOG (see L<perlhack/PERL_MEM_LOG>).  The older API is still
2181 there for use in XS modules supporting older perls.
2182
2183         void    Newx(void* ptr, int nitems, type)
2184
2185 =for hackers
2186 Found in file handy.h
2187
2188 =item Newxc
2189 X<Newxc>
2190
2191 The XSUB-writer's interface to the C C<malloc> function, with
2192 cast.  See also C<Newx>.
2193
2194         void    Newxc(void* ptr, int nitems, type, cast)
2195
2196 =for hackers
2197 Found in file handy.h
2198
2199 =item Newxz
2200 X<Newxz>
2201
2202 The XSUB-writer's interface to the C C<malloc> function.  The allocated
2203 memory is zeroed with C<memzero>.  See also C<Newx>.
2204
2205         void    Newxz(void* ptr, int nitems, type)
2206
2207 =for hackers
2208 Found in file handy.h
2209
2210 =item Poison
2211 X<Poison>
2212
2213 PoisonWith(0xEF) for catching access to freed memory.
2214
2215         void    Poison(void* dest, int nitems, type)
2216
2217 =for hackers
2218 Found in file handy.h
2219
2220 =item PoisonFree
2221 X<PoisonFree>
2222
2223 PoisonWith(0xEF) for catching access to freed memory.
2224
2225         void    PoisonFree(void* dest, int nitems, type)
2226
2227 =for hackers
2228 Found in file handy.h
2229
2230 =item PoisonNew
2231 X<PoisonNew>
2232
2233 PoisonWith(0xAB) for catching access to allocated but uninitialized memory.
2234
2235         void    PoisonNew(void* dest, int nitems, type)
2236
2237 =for hackers
2238 Found in file handy.h
2239
2240 =item PoisonWith
2241 X<PoisonWith>
2242
2243 Fill up memory with a byte pattern (a byte repeated over and over
2244 again) that hopefully catches attempts to access uninitialized memory.
2245
2246         void    PoisonWith(void* dest, int nitems, type, U8 byte)
2247
2248 =for hackers
2249 Found in file handy.h
2250
2251 =item Renew
2252 X<Renew>
2253
2254 The XSUB-writer's interface to the C C<realloc> function.
2255
2256         void    Renew(void* ptr, int nitems, type)
2257
2258 =for hackers
2259 Found in file handy.h
2260
2261 =item Renewc
2262 X<Renewc>
2263
2264 The XSUB-writer's interface to the C C<realloc> function, with
2265 cast.
2266
2267         void    Renewc(void* ptr, int nitems, type, cast)
2268
2269 =for hackers
2270 Found in file handy.h
2271
2272 =item Safefree
2273 X<Safefree>
2274
2275 The XSUB-writer's interface to the C C<free> function.
2276
2277         void    Safefree(void* ptr)
2278
2279 =for hackers
2280 Found in file handy.h
2281
2282 =item savepv
2283 X<savepv>
2284
2285 Perl's version of C<strdup()>. Returns a pointer to a newly allocated
2286 string which is a duplicate of C<pv>. The size of the string is
2287 determined by C<strlen()>. The memory allocated for the new string can
2288 be freed with the C<Safefree()> function.
2289
2290         char*   savepv(const char* pv)
2291
2292 =for hackers
2293 Found in file util.c
2294
2295 =item savepvn
2296 X<savepvn>
2297
2298 Perl's version of what C<strndup()> would be if it existed. Returns a
2299 pointer to a newly allocated string which is a duplicate of the first
2300 C<len> bytes from C<pv>, plus a trailing NUL byte. The memory allocated for
2301 the new string can be freed with the C<Safefree()> function.
2302
2303         char*   savepvn(const char* pv, I32 len)
2304
2305 =for hackers
2306 Found in file util.c
2307
2308 =item savepvs
2309 X<savepvs>
2310
2311 Like C<savepvn>, but takes a literal string instead of a string/length pair.
2312
2313         char*   savepvs(const char* s)
2314
2315 =for hackers
2316 Found in file handy.h
2317
2318 =item savesharedpv
2319 X<savesharedpv>
2320
2321 A version of C<savepv()> which allocates the duplicate string in memory
2322 which is shared between threads.
2323
2324         char*   savesharedpv(const char* pv)
2325
2326 =for hackers
2327 Found in file util.c
2328
2329 =item savesharedpvn
2330 X<savesharedpvn>
2331
2332 A version of C<savepvn()> which allocates the duplicate string in memory
2333 which is shared between threads. (With the specific difference that a NULL
2334 pointer is not acceptable)
2335
2336         char*   savesharedpvn(const char *const pv, const STRLEN len)
2337
2338 =for hackers
2339 Found in file util.c
2340
2341 =item savesvpv
2342 X<savesvpv>
2343
2344 A version of C<savepv()>/C<savepvn()> which gets the string to duplicate from
2345 the passed in SV using C<SvPV()>
2346
2347         char*   savesvpv(SV* sv)
2348
2349 =for hackers
2350 Found in file util.c
2351
2352 =item StructCopy
2353 X<StructCopy>
2354
2355 This is an architecture-independent macro to copy one structure to another.
2356
2357         void    StructCopy(type src, type dest, type)
2358
2359 =for hackers
2360 Found in file handy.h
2361
2362 =item Zero
2363 X<Zero>
2364
2365 The XSUB-writer's interface to the C C<memzero> function.  The C<dest> is the
2366 destination, C<nitems> is the number of items, and C<type> is the type.
2367
2368         void    Zero(void* dest, int nitems, type)
2369
2370 =for hackers
2371 Found in file handy.h
2372
2373 =item ZeroD
2374 X<ZeroD>
2375
2376 Like C<Zero> but returns dest. Useful for encouraging compilers to tail-call
2377 optimise.
2378
2379         void *  ZeroD(void* dest, int nitems, type)
2380
2381 =for hackers
2382 Found in file handy.h
2383
2384
2385 =back
2386
2387 =head1 Miscellaneous Functions
2388
2389 =over 8
2390
2391 =item fbm_compile
2392 X<fbm_compile>
2393
2394 Analyses the string in order to make fast searches on it using fbm_instr()
2395 -- the Boyer-Moore algorithm.
2396
2397         void    fbm_compile(SV* sv, U32 flags)
2398
2399 =for hackers
2400 Found in file util.c
2401
2402 =item fbm_instr
2403 X<fbm_instr>
2404
2405 Returns the location of the SV in the string delimited by C<str> and
2406 C<strend>.  It returns C<NULL> if the string can't be found.  The C<sv>
2407 does not have to be fbm_compiled, but the search will not be as fast
2408 then.
2409
2410         char*   fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
2411
2412 =for hackers
2413 Found in file util.c
2414
2415 =item form
2416 X<form>
2417
2418 Takes a sprintf-style format pattern and conventional
2419 (non-SV) arguments and returns the formatted string.
2420
2421     (char *) Perl_form(pTHX_ const char* pat, ...)
2422
2423 can be used any place a string (char *) is required:
2424
2425     char * s = Perl_form("%d.%d",major,minor);
2426
2427 Uses a single private buffer so if you want to format several strings you
2428 must explicitly copy the earlier strings away (and free the copies when you
2429 are done).
2430
2431         char*   form(const char* pat, ...)
2432
2433 =for hackers
2434 Found in file util.c
2435
2436 =item getcwd_sv
2437 X<getcwd_sv>
2438
2439 Fill the sv with current working directory
2440
2441         int     getcwd_sv(SV* sv)
2442
2443 =for hackers
2444 Found in file util.c
2445
2446 =item my_snprintf
2447 X<my_snprintf>
2448
2449 The C library C<snprintf> functionality, if available and
2450 standards-compliant (uses C<vsnprintf>, actually).  However, if the
2451 C<vsnprintf> is not available, will unfortunately use the unsafe
2452 C<vsprintf> which can overrun the buffer (there is an overrun check,
2453 but that may be too late).  Consider using C<sv_vcatpvf> instead, or
2454 getting C<vsnprintf>.
2455
2456         int     my_snprintf(char *buffer, const Size_t len, const char *format, ...)
2457
2458 =for hackers
2459 Found in file util.c
2460
2461 =item my_sprintf
2462 X<my_sprintf>
2463
2464 The C library C<sprintf>, wrapped if necessary, to ensure that it will return
2465 the length of the string written to the buffer. Only rare pre-ANSI systems
2466 need the wrapper function - usually this is a direct call to C<sprintf>.
2467
2468         int     my_sprintf(char *buffer, const char *pat, ...)
2469
2470 =for hackers
2471 Found in file util.c
2472
2473 =item my_vsnprintf
2474 X<my_vsnprintf>
2475
2476 The C library C<vsnprintf> if available and standards-compliant.
2477 However, if if the C<vsnprintf> is not available, will unfortunately
2478 use the unsafe C<vsprintf> which can overrun the buffer (there is an
2479 overrun check, but that may be too late).  Consider using
2480 C<sv_vcatpvf> instead, or getting C<vsnprintf>.
2481
2482         int     my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)
2483
2484 =for hackers
2485 Found in file util.c
2486
2487 =item new_version
2488 X<new_version>
2489
2490 Returns a new version object based on the passed in SV:
2491
2492     SV *sv = new_version(SV *ver);
2493
2494 Does not alter the passed in ver SV.  See "upg_version" if you
2495 want to upgrade the SV.
2496
2497         SV*     new_version(SV *ver)
2498
2499 =for hackers
2500 Found in file util.c
2501
2502 =item scan_version
2503 X<scan_version>
2504
2505 Returns a pointer to the next character after the parsed
2506 version string, as well as upgrading the passed in SV to
2507 an RV.
2508
2509 Function must be called with an already existing SV like
2510
2511     sv = newSV(0);
2512     s = scan_version(s, SV *sv, bool qv);
2513
2514 Performs some preprocessing to the string to ensure that
2515 it has the correct characteristics of a version.  Flags the
2516 object if it contains an underscore (which denotes this
2517 is an alpha version).  The boolean qv denotes that the version
2518 should be interpreted as if it had multiple decimals, even if
2519 it doesn't.
2520
2521         const char*     scan_version(const char *vstr, SV *sv, bool qv)
2522
2523 =for hackers
2524 Found in file util.c
2525
2526 =item strEQ
2527 X<strEQ>
2528
2529 Test two strings to see if they are equal.  Returns true or false.
2530
2531         bool    strEQ(char* s1, char* s2)
2532
2533 =for hackers
2534 Found in file handy.h
2535
2536 =item strGE
2537 X<strGE>
2538
2539 Test two strings to see if the first, C<s1>, is greater than or equal to
2540 the second, C<s2>.  Returns true or false.
2541
2542         bool    strGE(char* s1, char* s2)
2543
2544 =for hackers
2545 Found in file handy.h
2546
2547 =item strGT
2548 X<strGT>
2549
2550 Test two strings to see if the first, C<s1>, is greater than the second,
2551 C<s2>.  Returns true or false.
2552
2553         bool    strGT(char* s1, char* s2)
2554
2555 =for hackers
2556 Found in file handy.h
2557
2558 =item strLE
2559 X<strLE>
2560
2561 Test two strings to see if the first, C<s1>, is less than or equal to the
2562 second, C<s2>.  Returns true or false.
2563
2564         bool    strLE(char* s1, char* s2)
2565
2566 =for hackers
2567 Found in file handy.h
2568
2569 =item strLT
2570 X<strLT>
2571
2572 Test two strings to see if the first, C<s1>, is less than the second,
2573 C<s2>.  Returns true or false.
2574
2575         bool    strLT(char* s1, char* s2)
2576
2577 =for hackers
2578 Found in file handy.h
2579
2580 =item strNE
2581 X<strNE>
2582
2583 Test two strings to see if they are different.  Returns true or
2584 false.
2585
2586         bool    strNE(char* s1, char* s2)
2587
2588 =for hackers
2589 Found in file handy.h
2590
2591 =item strnEQ
2592 X<strnEQ>
2593
2594 Test two strings to see if they are equal.  The C<len> parameter indicates
2595 the number of bytes to compare.  Returns true or false. (A wrapper for
2596 C<strncmp>).
2597
2598         bool    strnEQ(char* s1, char* s2, STRLEN len)
2599
2600 =for hackers
2601 Found in file handy.h
2602
2603 =item strnNE
2604 X<strnNE>
2605
2606 Test two strings to see if they are different.  The C<len> parameter
2607 indicates the number of bytes to compare.  Returns true or false. (A
2608 wrapper for C<strncmp>).
2609
2610         bool    strnNE(char* s1, char* s2, STRLEN len)
2611
2612 =for hackers
2613 Found in file handy.h
2614
2615 =item sv_destroyable
2616 X<sv_destroyable>
2617
2618 Dummy routine which reports that object can be destroyed when there is no
2619 sharing module present.  It ignores its single SV argument, and returns
2620 'true'.  Exists to avoid test for a NULL function pointer and because it
2621 could potentially warn under some level of strict-ness.
2622
2623         bool    sv_destroyable(SV *sv)
2624
2625 =for hackers
2626 Found in file util.c
2627
2628 =item sv_nosharing
2629 X<sv_nosharing>
2630
2631 Dummy routine which "shares" an SV when there is no sharing module present.
2632 Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument.
2633 Exists to avoid test for a NULL function pointer and because it could
2634 potentially warn under some level of strict-ness.
2635
2636         void    sv_nosharing(SV *sv)
2637
2638 =for hackers
2639 Found in file util.c
2640
2641 =item upg_version
2642 X<upg_version>
2643
2644 In-place upgrade of the supplied SV to a version object.
2645
2646     SV *sv = upg_version(SV *sv, bool qv);
2647
2648 Returns a pointer to the upgraded SV.  Set the boolean qv if you want
2649 to force this SV to be interpreted as an "extended" version.
2650
2651         SV*     upg_version(SV *ver, bool qv)
2652
2653 =for hackers
2654 Found in file util.c
2655
2656 =item vcmp
2657 X<vcmp>
2658
2659 Version object aware cmp.  Both operands must already have been 
2660 converted into version objects.
2661
2662         int     vcmp(SV *lvs, SV *rvs)
2663
2664 =for hackers
2665 Found in file util.c
2666
2667 =item vnormal
2668 X<vnormal>
2669
2670 Accepts a version object and returns the normalized string
2671 representation.  Call like:
2672
2673     sv = vnormal(rv);
2674
2675 NOTE: you can pass either the object directly or the SV
2676 contained within the RV.
2677
2678         SV*     vnormal(SV *vs)
2679
2680 =for hackers
2681 Found in file util.c
2682
2683 =item vnumify
2684 X<vnumify>
2685
2686 Accepts a version object and returns the normalized floating
2687 point representation.  Call like:
2688
2689     sv = vnumify(rv);
2690
2691 NOTE: you can pass either the object directly or the SV
2692 contained within the RV.
2693
2694         SV*     vnumify(SV *vs)
2695
2696 =for hackers
2697 Found in file util.c
2698
2699 =item vstringify
2700 X<vstringify>
2701
2702 In order to maintain maximum compatibility with earlier versions
2703 of Perl, this function will return either the floating point
2704 notation or the multiple dotted notation, depending on whether
2705 the original version contained 1 or more dots, respectively
2706
2707         SV*     vstringify(SV *vs)
2708
2709 =for hackers
2710 Found in file util.c
2711
2712 =item vverify
2713 X<vverify>
2714
2715 Validates that the SV contains a valid version object.
2716
2717     bool vverify(SV *vobj);
2718
2719 Note that it only confirms the bare minimum structure (so as not to get
2720 confused by derived classes which may contain additional hash entries):
2721
2722         bool    vverify(SV *vs)
2723
2724 =for hackers
2725 Found in file util.c
2726
2727
2728 =back
2729
2730 =head1 MRO Functions
2731
2732 =over 8
2733
2734 =item mro_get_linear_isa
2735 X<mro_get_linear_isa>
2736
2737 Returns either C<mro_get_linear_isa_c3> or
2738 C<mro_get_linear_isa_dfs> for the given stash,
2739 dependant upon which MRO is in effect
2740 for that stash.  The return value is a
2741 read-only AV*.
2742
2743 You are responsible for C<SvREFCNT_inc()> on the
2744 return value if you plan to store it anywhere
2745 semi-permanently (otherwise it might be deleted
2746 out from under you the next time the cache is
2747 invalidated).
2748
2749         AV*     mro_get_linear_isa(HV* stash)
2750
2751 =for hackers
2752 Found in file mro.c
2753
2754 =item mro_method_changed_in
2755 X<mro_method_changed_in>
2756
2757 Invalidates method caching on any child classes
2758 of the given stash, so that they might notice
2759 the changes in this one.
2760
2761 Ideally, all instances of C<PL_sub_generation++> in
2762 perl source outside of C<mro.c> should be
2763 replaced by calls to this.
2764
2765 Perl automatically handles most of the common
2766 ways a method might be redefined.  However, there
2767 are a few ways you could change a method in a stash
2768 without the cache code noticing, in which case you
2769 need to call this method afterwards:
2770
2771 1) Directly manipulating the stash HV entries from
2772 XS code.
2773
2774 2) Assigning a reference to a readonly scalar
2775 constant into a stash entry in order to create
2776 a constant subroutine (like constant.pm
2777 does).
2778
2779 This same method is available from pure perl
2780 via, C<mro::method_changed_in(classname)>.
2781
2782         void    mro_method_changed_in(HV* stash)
2783
2784 =for hackers
2785 Found in file mro.c
2786
2787
2788 =back
2789
2790 =head1 Multicall Functions
2791
2792 =over 8
2793
2794 =item dMULTICALL
2795 X<dMULTICALL>
2796
2797 Declare local variables for a multicall. See L<perlcall/Lightweight Callbacks>.
2798
2799                 dMULTICALL;
2800
2801 =for hackers
2802 Found in file cop.h
2803
2804 =item MULTICALL
2805 X<MULTICALL>
2806
2807 Make a lightweight callback. See L<perlcall/Lightweight Callbacks>.
2808
2809                 MULTICALL;
2810
2811 =for hackers
2812 Found in file cop.h
2813
2814 =item POP_MULTICALL
2815 X<POP_MULTICALL>
2816
2817 Closing bracket for a lightweight callback.
2818 See L<perlcall/Lightweight Callbacks>.
2819
2820                 POP_MULTICALL;
2821
2822 =for hackers
2823 Found in file cop.h
2824
2825 =item PUSH_MULTICALL
2826 X<PUSH_MULTICALL>
2827
2828 Opening bracket for a lightweight callback.
2829 See L<perlcall/Lightweight Callbacks>.
2830
2831                 PUSH_MULTICALL;
2832
2833 =for hackers
2834 Found in file cop.h
2835
2836
2837 =back
2838
2839 =head1 Numeric functions
2840
2841 =over 8
2842
2843 =item grok_bin
2844 X<grok_bin>
2845
2846 converts a string representing a binary number to numeric form.
2847
2848 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2849 conversion flags, and I<result> should be NULL or a pointer to an NV.
2850 The scan stops at the end of the string, or the first invalid character.
2851 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2852 invalid character will also trigger a warning.
2853 On return I<*len> is set to the length of the scanned string,
2854 and I<*flags> gives output flags.
2855
2856 If the value is <= C<UV_MAX> it is returned as a UV, the output flags are clear,
2857 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_bin>
2858 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2859 and writes the value to I<*result> (or the value is discarded if I<result>
2860 is NULL).
2861
2862 The binary number may optionally be prefixed with "0b" or "b" unless
2863 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2864 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the binary
2865 number may use '_' characters to separate digits.
2866
2867         UV      grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)
2868
2869 =for hackers
2870 Found in file numeric.c
2871
2872 =item grok_hex
2873 X<grok_hex>
2874
2875 converts a string representing a hex number to numeric form.
2876
2877 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2878 conversion flags, and I<result> should be NULL or a pointer to an NV.
2879 The scan stops at the end of the string, or the first invalid character.
2880 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2881 invalid character will also trigger a warning.
2882 On return I<*len> is set to the length of the scanned string,
2883 and I<*flags> gives output flags.
2884
2885 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2886 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_hex>
2887 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2888 and writes the value to I<*result> (or the value is discarded if I<result>
2889 is NULL).
2890
2891 The hex number may optionally be prefixed with "0x" or "x" unless
2892 C<PERL_SCAN_DISALLOW_PREFIX> is set in I<*flags> on entry. If
2893 C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the hex
2894 number may use '_' characters to separate digits.
2895
2896         UV      grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)
2897
2898 =for hackers
2899 Found in file numeric.c
2900
2901 =item grok_number
2902 X<grok_number>
2903
2904 Recognise (or not) a number.  The type of the number is returned
2905 (0 if unrecognised), otherwise it is a bit-ORed combination of
2906 IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT,
2907 IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).
2908
2909 If the value of the number can fit an in UV, it is returned in the *valuep
2910 IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV
2911 will never be set unless *valuep is valid, but *valuep may have been assigned
2912 to during processing even though IS_NUMBER_IN_UV is not set on return.
2913 If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when
2914 valuep is non-NULL, but no actual assignment (or SEGV) will occur.
2915
2916 IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were
2917 seen (in which case *valuep gives the true value truncated to an integer), and
2918 IS_NUMBER_NEG if the number is negative (in which case *valuep holds the
2919 absolute value).  IS_NUMBER_IN_UV is not set if e notation was used or the
2920 number is larger than a UV.
2921
2922         int     grok_number(const char *pv, STRLEN len, UV *valuep)
2923
2924 =for hackers
2925 Found in file numeric.c
2926
2927 =item grok_numeric_radix
2928 X<grok_numeric_radix>
2929
2930 Scan and skip for a numeric decimal separator (radix).
2931
2932         bool    grok_numeric_radix(const char **sp, const char *send)
2933
2934 =for hackers
2935 Found in file numeric.c
2936
2937 =item grok_oct
2938 X<grok_oct>
2939
2940 converts a string representing an octal number to numeric form.
2941
2942 On entry I<start> and I<*len> give the string to scan, I<*flags> gives
2943 conversion flags, and I<result> should be NULL or a pointer to an NV.
2944 The scan stops at the end of the string, or the first invalid character.
2945 Unless C<PERL_SCAN_SILENT_ILLDIGIT> is set in I<*flags>, encountering an
2946 invalid character will also trigger a warning.
2947 On return I<*len> is set to the length of the scanned string,
2948 and I<*flags> gives output flags.
2949
2950 If the value is <= UV_MAX it is returned as a UV, the output flags are clear,
2951 and nothing is written to I<*result>. If the value is > UV_MAX C<grok_oct>
2952 returns UV_MAX, sets C<PERL_SCAN_GREATER_THAN_UV_MAX> in the output flags,
2953 and writes the value to I<*result> (or the value is discarded if I<result>
2954 is NULL).
2955
2956 If C<PERL_SCAN_ALLOW_UNDERSCORES> is set in I<*flags> then the octal
2957 number may use '_' characters to separate digits.
2958
2959         UV      grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)
2960
2961 =for hackers
2962 Found in file numeric.c
2963
2964 =item Perl_signbit
2965 X<Perl_signbit>
2966
2967 Return a non-zero integer if the sign bit on an NV is set, and 0 if
2968 it is not.  
2969
2970 If Configure detects this system has a signbit() that will work with
2971 our NVs, then we just use it via the #define in perl.h.  Otherwise,
2972 fall back on this implementation.  As a first pass, this gets everything
2973 right except -0.0.  Alas, catching -0.0 is the main use for this function,
2974 so this is not too helpful yet.  Still, at least we have the scaffolding
2975 in place to support other systems, should that prove useful.
2976
2977
2978 Configure notes:  This function is called 'Perl_signbit' instead of a
2979 plain 'signbit' because it is easy to imagine a system having a signbit()
2980 function or macro that doesn't happen to work with our particular choice
2981 of NVs.  We shouldn't just re-#define signbit as Perl_signbit and expect
2982 the standard system headers to be happy.  Also, this is a no-context
2983 function (no pTHX_) because Perl_signbit() is usually re-#defined in
2984 perl.h as a simple macro call to the system's signbit().
2985 Users should just always call Perl_signbit().
2986
2987 NOTE: this function is experimental and may change or be
2988 removed without notice.
2989
2990         int     Perl_signbit(NV f)
2991
2992 =for hackers
2993 Found in file numeric.c
2994
2995 =item scan_bin
2996 X<scan_bin>
2997
2998 For backwards compatibility. Use C<grok_bin> instead.
2999
3000         NV      scan_bin(const char* start, STRLEN len, STRLEN* retlen)
3001
3002 =for hackers
3003 Found in file numeric.c
3004
3005 =item scan_hex
3006 X<scan_hex>
3007
3008 For backwards compatibility. Use C<grok_hex> instead.
3009
3010         NV      scan_hex(const char* start, STRLEN len, STRLEN* retlen)
3011
3012 =for hackers
3013 Found in file numeric.c
3014
3015 =item scan_oct
3016 X<scan_oct>
3017
3018 For backwards compatibility. Use C<grok_oct> instead.
3019
3020         NV      scan_oct(const char* start, STRLEN len, STRLEN* retlen)
3021
3022 =for hackers
3023 Found in file numeric.c
3024
3025
3026 =back
3027
3028 =head1 Optree Manipulation Functions
3029
3030 =over 8
3031
3032 =item cv_const_sv
3033 X<cv_const_sv>
3034
3035 If C<cv> is a constant sub eligible for inlining. returns the constant
3036 value returned by the sub.  Otherwise, returns NULL.
3037
3038 Constant subs can be created with C<newCONSTSUB> or as described in
3039 L<perlsub/"Constant Functions">.
3040
3041         SV*     cv_const_sv(CV* cv)
3042
3043 =for hackers
3044 Found in file op.c
3045
3046 =item newCONSTSUB
3047 X<newCONSTSUB>
3048
3049 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
3050 eligible for inlining at compile-time.
3051
3052         CV*     newCONSTSUB(HV* stash, const char* name, SV* sv)
3053
3054 =for hackers
3055 Found in file op.c
3056
3057 =item newXS
3058 X<newXS>
3059
3060 Used by C<xsubpp> to hook up XSUBs as Perl subs.  I<filename> needs to be
3061 static storage, as it is used directly as CvFILE(), without a copy being made.
3062
3063 =for hackers
3064 Found in file op.c
3065
3066
3067 =back
3068
3069 =head1 Pad Data Structures
3070
3071 =over 8
3072
3073 =item pad_sv
3074 X<pad_sv>
3075
3076 Get the value at offset po in the current pad.
3077 Use macro PAD_SV instead of calling this function directly.
3078
3079         SV*     pad_sv(PADOFFSET po)
3080
3081 =for hackers
3082 Found in file pad.c
3083
3084
3085 =back
3086
3087 =head1 Per-Interpreter Variables
3088
3089 =over 8
3090
3091 =item PL_modglobal
3092 X<PL_modglobal>
3093
3094 C<PL_modglobal> is a general purpose, interpreter global HV for use by
3095 extensions that need to keep information on a per-interpreter basis.
3096 In a pinch, it can also be used as a symbol table for extensions
3097 to share data among each other.  It is a good idea to use keys
3098 prefixed by the package name of the extension that owns the data.
3099
3100         HV*     PL_modglobal
3101
3102 =for hackers
3103 Found in file intrpvar.h
3104
3105 =item PL_na
3106 X<PL_na>
3107
3108 A convenience variable which is typically used with C<SvPV> when one
3109 doesn't care about the length of the string.  It is usually more efficient
3110 to either declare a local variable and use that instead or to use the
3111 C<SvPV_nolen> macro.
3112
3113         STRLEN  PL_na
3114
3115 =for hackers
3116 Found in file intrpvar.h
3117
3118 =item PL_sv_no
3119 X<PL_sv_no>
3120
3121 This is the C<false> SV.  See C<PL_sv_yes>.  Always refer to this as
3122 C<&PL_sv_no>.
3123
3124         SV      PL_sv_no
3125
3126 =for hackers
3127 Found in file intrpvar.h
3128
3129 =item PL_sv_undef
3130 X<PL_sv_undef>
3131
3132 This is the C<undef> SV.  Always refer to this as C<&PL_sv_undef>.
3133
3134         SV      PL_sv_undef
3135
3136 =for hackers
3137 Found in file intrpvar.h
3138
3139 =item PL_sv_yes
3140 X<PL_sv_yes>
3141
3142 This is the C<true> SV.  See C<PL_sv_no>.  Always refer to this as
3143 C<&PL_sv_yes>.
3144
3145         SV      PL_sv_yes
3146
3147 =for hackers
3148 Found in file intrpvar.h
3149
3150
3151 =back
3152
3153 =head1 REGEXP Functions
3154
3155 =over 8
3156
3157 =item SvRX
3158 X<SvRX>
3159
3160 Convenience macro to get the REGEXP from a SV. This is approximately
3161 equivalent to the following snippet:
3162
3163     if (SvMAGICAL(sv))
3164         mg_get(sv);
3165     if (SvROK(sv) &&
3166         (tmpsv = (SV*)SvRV(sv)) &&
3167         SvTYPE(tmpsv) == SVt_PVMG &&
3168         (tmpmg = mg_find(tmpsv, PERL_MAGIC_qr)))
3169     {
3170         return (REGEXP *)tmpmg->mg_obj;
3171     }
3172
3173 NULL will be returned if a REGEXP* is not found.
3174
3175         REGEXP *        SvRX(SV *sv)
3176
3177 =for hackers
3178 Found in file regexp.h
3179
3180 =item SvRXOK
3181 X<SvRXOK>
3182
3183 Returns a boolean indicating whether the SV contains qr magic
3184 (PERL_MAGIC_qr).
3185
3186 If you want to do something with the REGEXP* later use SvRX instead
3187 and check for NULL.
3188
3189         bool    SvRXOK(SV* sv)
3190
3191 =for hackers
3192 Found in file regexp.h
3193
3194
3195 =back
3196
3197 =head1 Simple Exception Handling Macros
3198
3199 =over 8
3200
3201 =item dXCPT
3202 X<dXCPT>
3203
3204 Set up necessary local variables for exception handling.
3205 See L<perlguts/"Exception Handling">.
3206
3207                 dXCPT;
3208
3209 =for hackers
3210 Found in file XSUB.h
3211
3212 =item XCPT_CATCH
3213 X<XCPT_CATCH>
3214
3215 Introduces a catch block.  See L<perlguts/"Exception Handling">.
3216
3217 =for hackers
3218 Found in file XSUB.h
3219
3220 =item XCPT_RETHROW
3221 X<XCPT_RETHROW>
3222
3223 Rethrows a previously caught exception.  See L<perlguts/"Exception Handling">.
3224
3225                 XCPT_RETHROW;
3226
3227 =for hackers
3228 Found in file XSUB.h
3229
3230 =item XCPT_TRY_END
3231 X<XCPT_TRY_END>
3232
3233 Ends a try block.  See L<perlguts/"Exception Handling">.
3234
3235 =for hackers
3236 Found in file XSUB.h
3237
3238 =item XCPT_TRY_START
3239 X<XCPT_TRY_START>
3240
3241 Starts a try block.  See L<perlguts/"Exception Handling">.
3242
3243 =for hackers
3244 Found in file XSUB.h
3245
3246
3247 =back
3248
3249 =head1 Stack Manipulation Macros
3250
3251 =over 8
3252
3253 =item dMARK
3254 X<dMARK>
3255
3256 Declare a stack marker variable, C<mark>, for the XSUB.  See C<MARK> and
3257 C<dORIGMARK>.
3258
3259                 dMARK;
3260
3261 =for hackers
3262 Found in file pp.h
3263
3264 =item dORIGMARK
3265 X<dORIGMARK>
3266
3267 Saves the original stack mark for the XSUB.  See C<ORIGMARK>.
3268
3269                 dORIGMARK;
3270
3271 =for hackers
3272 Found in file pp.h
3273
3274 =item dSP
3275 X<dSP>
3276
3277 Declares a local copy of perl's stack pointer for the XSUB, available via
3278 the C<SP> macro.  See C<SP>.
3279
3280                 dSP;
3281
3282 =for hackers
3283 Found in file pp.h
3284
3285 =item EXTEND
3286 X<EXTEND>
3287
3288 Used to extend the argument stack for an XSUB's return values. Once
3289 used, guarantees that there is room for at least C<nitems> to be pushed
3290 onto the stack.
3291
3292         void    EXTEND(SP, int nitems)
3293
3294 =for hackers
3295 Found in file pp.h
3296
3297 =item MARK
3298 X<MARK>
3299
3300 Stack marker variable for the XSUB.  See C<dMARK>.
3301
3302 =for hackers
3303 Found in file pp.h
3304
3305 =item mPUSHi
3306 X<mPUSHi>
3307
3308 Push an integer onto the stack.  The stack must have room for this element.
3309 Does not use C<TARG>.  See also C<PUSHi>, C<mXPUSHi> and C<XPUSHi>.
3310
3311         void    mPUSHi(IV iv)
3312
3313 =for hackers
3314 Found in file pp.h
3315
3316 =item mPUSHn
3317 X<mPUSHn>
3318
3319 Push a double onto the stack.  The stack must have room for this element.
3320 Does not use C<TARG>.  See also C<PUSHn>, C<mXPUSHn> and C<XPUSHn>.
3321
3322         void    mPUSHn(NV nv)
3323
3324 =for hackers
3325 Found in file pp.h
3326
3327 =item mPUSHp
3328 X<mPUSHp>
3329
3330 Push a string onto the stack.  The stack must have room for this element.
3331 The C<len> indicates the length of the string.  Does not use C<TARG>.
3332 See also C<PUSHp>, C<mXPUSHp> and C<XPUSHp>.
3333
3334         void    mPUSHp(char* str, STRLEN len)
3335
3336 =for hackers
3337 Found in file pp.h
3338
3339 =item mPUSHs
3340 X<mPUSHs>
3341
3342 Push an SV onto the stack and mortalizes the SV.  The stack must have room
3343 for this element.  Does not use C<TARG>.  See also C<PUSHs> and C<mXPUSHs>.
3344
3345         void    mPUSHs(SV* sv)
3346
3347 =for hackers
3348 Found in file pp.h
3349
3350 =item mPUSHu
3351 X<mPUSHu>
3352
3353 Push an unsigned integer onto the stack.  The stack must have room for this
3354 element.  Does not use C<TARG>.  See also C<PUSHu>, C<mXPUSHu> and C<XPUSHu>.
3355
3356         void    mPUSHu(UV uv)
3357
3358 =for hackers
3359 Found in file pp.h
3360
3361 =item mXPUSHi
3362 X<mXPUSHi>
3363
3364 Push an integer onto the stack, extending the stack if necessary.
3365 Does not use C<TARG>.  See also C<XPUSHi>, C<mPUSHi> and C<PUSHi>.
3366
3367         void    mXPUSHi(IV iv)
3368
3369 =for hackers
3370 Found in file pp.h
3371
3372 =item mXPUSHn
3373 X<mXPUSHn>
3374
3375 Push a double onto the stack, extending the stack if necessary.
3376 Does not use C<TARG>.  See also C<XPUSHn>, C<mPUSHn> and C<PUSHn>.
3377
3378         void    mXPUSHn(NV nv)
3379
3380 =for hackers
3381 Found in file pp.h
3382
3383 =item mXPUSHp
3384 X<mXPUSHp>
3385
3386 Push a string onto the stack, extending the stack if necessary.  The C<len>
3387 indicates the length of the string.  Does not use C<TARG>.  See also C<XPUSHp>,
3388 C<mPUSHp> and C<PUSHp>.
3389
3390         void    mXPUSHp(char* str, STRLEN len)
3391
3392 =for hackers
3393 Found in file pp.h
3394
3395 =item mXPUSHs
3396 X<mXPUSHs>
3397
3398 Push an SV onto the stack, extending the stack if necessary and mortalizes
3399 the SV.  Does not use C<TARG>.  See also C<XPUSHs> and C<mPUSHs>.
3400
3401         void    mXPUSHs(SV* sv)
3402
3403 =for hackers
3404 Found in file pp.h
3405
3406 =item mXPUSHu
3407 X<mXPUSHu>
3408
3409 Push an unsigned integer onto the stack, extending the stack if necessary.
3410 Does not use C<TARG>.  See also C<XPUSHu>, C<mPUSHu> and C<PUSHu>.
3411
3412         void    mXPUSHu(UV uv)
3413
3414 =for hackers
3415 Found in file pp.h
3416
3417 =item ORIGMARK
3418 X<ORIGMARK>
3419
3420 The original stack mark for the XSUB.  See C<dORIGMARK>.
3421
3422 =for hackers
3423 Found in file pp.h
3424
3425 =item POPi
3426 X<POPi>
3427
3428 Pops an integer off the stack.
3429
3430         IV      POPi
3431
3432 =for hackers
3433 Found in file pp.h
3434
3435 =item POPl
3436 X<POPl>
3437
3438 Pops a long off the stack.
3439
3440         long    POPl
3441
3442 =for hackers
3443 Found in file pp.h
3444
3445 =item POPn
3446 X<POPn>
3447
3448 Pops a double off the stack.
3449
3450         NV      POPn
3451
3452 =for hackers
3453 Found in file pp.h
3454
3455 =item POPp
3456 X<POPp>
3457
3458 Pops a string off the stack. Deprecated. New code should use POPpx.
3459
3460         char*   POPp
3461
3462 =for hackers
3463 Found in file pp.h
3464
3465 =item POPpbytex
3466 X<POPpbytex>
3467
3468 Pops a string off the stack which must consist of bytes i.e. characters < 256.
3469
3470         char*   POPpbytex
3471
3472 =for hackers
3473 Found in file pp.h
3474
3475 =item POPpx
3476 X<POPpx>
3477
3478 Pops a string off the stack.
3479
3480         char*   POPpx
3481
3482 =for hackers
3483 Found in file pp.h
3484
3485 =item POPs
3486 X<POPs>
3487
3488 Pops an SV off the stack.
3489
3490         SV*     POPs
3491
3492 =for hackers
3493 Found in file pp.h
3494
3495 =item PUSHi
3496 X<PUSHi>
3497
3498 Push an integer onto the stack.  The stack must have room for this element.
3499 Handles 'set' magic.  Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3500 called to declare it.  Do not call multiple C<TARG>-oriented macros to 
3501 return lists from XSUB's - see C<mPUSHi> instead.  See also C<XPUSHi> and
3502 C<mXPUSHi>.
3503
3504         void    PUSHi(IV iv)
3505
3506 =for hackers
3507 Found in file pp.h
3508
3509 =item PUSHMARK
3510 X<PUSHMARK>
3511
3512 Opening bracket for arguments on a callback.  See C<PUTBACK> and
3513 L<perlcall>.
3514
3515         void    PUSHMARK(SP)
3516
3517 =for hackers
3518 Found in file pp.h
3519
3520 =item PUSHmortal
3521 X<PUSHmortal>
3522
3523 Push a new mortal SV onto the stack.  The stack must have room for this
3524 element.  Does not use C<TARG>.  See also C<PUSHs>, C<XPUSHmortal> and C<XPUSHs>.
3525
3526         void    PUSHmortal()
3527
3528 =for hackers
3529 Found in file pp.h
3530
3531 =item PUSHn
3532 X<PUSHn>
3533
3534 Push a double onto the stack.  The stack must have room for this element.
3535 Handles 'set' magic.  Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3536 called to declare it.  Do not call multiple C<TARG>-oriented macros to
3537 return lists from XSUB's - see C<mPUSHn> instead.  See also C<XPUSHn> and
3538 C<mXPUSHn>.
3539
3540         void    PUSHn(NV nv)
3541
3542 =for hackers
3543 Found in file pp.h
3544
3545 =item PUSHp
3546 X<PUSHp>
3547
3548 Push a string onto the stack.  The stack must have room for this element.
3549 The C<len> indicates the length of the string.  Handles 'set' magic.  Uses
3550 C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to declare it.  Do not
3551 call multiple C<TARG>-oriented macros to return lists from XSUB's - see
3552 C<mPUSHp> instead.  See also C<XPUSHp> and C<mXPUSHp>.
3553
3554         void    PUSHp(char* str, STRLEN len)
3555
3556 =for hackers
3557 Found in file pp.h
3558
3559 =item PUSHs
3560 X<PUSHs>
3561
3562 Push an SV onto the stack.  The stack must have room for this element.
3563 Does not handle 'set' magic.  Does not use C<TARG>.  See also C<PUSHmortal>,
3564 C<XPUSHs> and C<XPUSHmortal>.
3565
3566         void    PUSHs(SV* sv)
3567
3568 =for hackers
3569 Found in file pp.h
3570
3571 =item PUSHu
3572 X<PUSHu>
3573
3574 Push an unsigned integer onto the stack.  The stack must have room for this
3575 element.  Handles 'set' magic.  Uses C<TARG>, so C<dTARGET> or C<dXSTARG>
3576 should be called to declare it.  Do not call multiple C<TARG>-oriented
3577 macros to return lists from XSUB's - see C<mPUSHu> instead.  See also
3578 C<XPUSHu> and C<mXPUSHu>.
3579
3580         void    PUSHu(UV uv)
3581
3582 =for hackers
3583 Found in file pp.h
3584
3585 =item PUTBACK
3586 X<PUTBACK>
3587
3588 Closing bracket for XSUB arguments.  This is usually handled by C<xsubpp>.
3589 See C<PUSHMARK> and L<perlcall> for other uses.
3590
3591                 PUTBACK;
3592
3593 =for hackers
3594 Found in file pp.h
3595
3596 =item SP
3597 X<SP>
3598
3599 Stack pointer.  This is usually handled by C<xsubpp>.  See C<dSP> and
3600 C<SPAGAIN>.
3601
3602 =for hackers
3603 Found in file pp.h
3604
3605 =item SPAGAIN
3606 X<SPAGAIN>
3607
3608 Refetch the stack pointer.  Used after a callback.  See L<perlcall>.
3609
3610                 SPAGAIN;
3611
3612 =for hackers
3613 Found in file pp.h
3614
3615 =item XPUSHi
3616 X<XPUSHi>
3617
3618 Push an integer onto the stack, extending the stack if necessary.  Handles
3619 'set' magic.  Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3620 declare it.  Do not call multiple C<TARG>-oriented macros to return lists
3621 from XSUB's - see C<mXPUSHi> instead.  See also C<PUSHi> and C<mPUSHi>.
3622
3623         void    XPUSHi(IV iv)
3624
3625 =for hackers
3626 Found in file pp.h
3627
3628 =item XPUSHmortal
3629 X<XPUSHmortal>
3630
3631 Push a new mortal SV onto the stack, extending the stack if necessary.
3632 Does not use C<TARG>.  See also C<XPUSHs>, C<PUSHmortal> and C<PUSHs>.
3633
3634         void    XPUSHmortal()
3635
3636 =for hackers
3637 Found in file pp.h
3638
3639 =item XPUSHn
3640 X<XPUSHn>
3641
3642 Push a double onto the stack, extending the stack if necessary.  Handles
3643 'set' magic.  Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be called to
3644 declare it.  Do not call multiple C<TARG>-oriented macros to return lists
3645 from XSUB's - see C<mXPUSHn> instead.  See also C<PUSHn> and C<mPUSHn>.
3646
3647         void    XPUSHn(NV nv)
3648
3649 =for hackers
3650 Found in file pp.h
3651
3652 =item XPUSHp
3653 X<XPUSHp>
3654
3655 Push a string onto the stack, extending the stack if necessary.  The C<len>
3656 indicates the length of the string.  Handles 'set' magic.  Uses C<TARG>, so
3657 C<dTARGET> or C<dXSTARG> should be called to declare it.  Do not call
3658 multiple C<TARG>-oriented macros to return lists from XSUB's - see
3659 C<mXPUSHp> instead.  See also C<PUSHp> and C<mPUSHp>.
3660
3661         void    XPUSHp(char* str, STRLEN len)
3662
3663 =for hackers
3664 Found in file pp.h
3665
3666 =item XPUSHs
3667 X<XPUSHs>
3668
3669 Push an SV onto the stack, extending the stack if necessary.  Does not
3670 handle 'set' magic.  Does not use C<TARG>.  See also C<XPUSHmortal>,
3671 C<PUSHs> and C<PUSHmortal>.
3672
3673         void    XPUSHs(SV* sv)
3674
3675 =for hackers
3676 Found in file pp.h
3677
3678 =item XPUSHu
3679 X<XPUSHu>
3680
3681 Push an unsigned integer onto the stack, extending the stack if necessary.
3682 Handles 'set' magic.  Uses C<TARG>, so C<dTARGET> or C<dXSTARG> should be
3683 called to declare it.  Do not call multiple C<TARG>-oriented macros to
3684 return lists from XSUB's - see C<mXPUSHu> instead.  See also C<PUSHu> and
3685 C<mPUSHu>.
3686
3687         void    XPUSHu(UV uv)
3688
3689 =for hackers
3690 Found in file pp.h
3691
3692 =item XSRETURN
3693 X<XSRETURN>
3694
3695 Return from XSUB, indicating number of items on the stack.  This is usually
3696 handled by C<xsubpp>.
3697
3698         void    XSRETURN(int nitems)
3699
3700 =for hackers
3701 Found in file XSUB.h
3702
3703 =item XSRETURN_EMPTY
3704 X<XSRETURN_EMPTY>
3705
3706 Return an empty list from an XSUB immediately.
3707
3708                 XSRETURN_EMPTY;
3709
3710 =for hackers
3711 Found in file XSUB.h
3712
3713 =item XSRETURN_IV
3714 X<XSRETURN_IV>
3715
3716 Return an integer from an XSUB immediately.  Uses C<XST_mIV>.
3717
3718         void    XSRETURN_IV(IV iv)
3719
3720 =for hackers
3721 Found in file XSUB.h
3722
3723 =item XSRETURN_NO
3724 X<XSRETURN_NO>
3725
3726 Return C<&PL_sv_no> from an XSUB immediately.  Uses C<XST_mNO>.
3727
3728                 XSRETURN_NO;
3729
3730 =for hackers
3731 Found in file XSUB.h
3732
3733 =item XSRETURN_NV
3734 X<XSRETURN_NV>
3735
3736 Return a double from an XSUB immediately.  Uses C<XST_mNV>.
3737
3738         void    XSRETURN_NV(NV nv)
3739
3740 =for hackers
3741 Found in file XSUB.h
3742
3743 =item XSRETURN_PV
3744 X<XSRETURN_PV>
3745
3746 Return a copy of a string from an XSUB immediately.  Uses C<XST_mPV>.
3747
3748         void    XSRETURN_PV(char* str)
3749
3750 =for hackers
3751 Found in file XSUB.h
3752
3753 =item XSRETURN_UNDEF
3754 X<XSRETURN_UNDEF>
3755
3756 Return C<&PL_sv_undef> from an XSUB immediately.  Uses C<XST_mUNDEF>.
3757
3758                 XSRETURN_UNDEF;
3759
3760 =for hackers
3761 Found in file XSUB.h
3762
3763 =item XSRETURN_UV
3764 X<XSRETURN_UV>
3765
3766 Return an integer from an XSUB immediately.  Uses C<XST_mUV>.
3767
3768         void    XSRETURN_UV(IV uv)
3769
3770 =for hackers
3771 Found in file XSUB.h
3772
3773 =item XSRETURN_YES
3774 X<XSRETURN_YES>
3775
3776 Return C<&PL_sv_yes> from an XSUB immediately.  Uses C<XST_mYES>.
3777
3778                 XSRETURN_YES;
3779
3780 =for hackers
3781 Found in file XSUB.h
3782
3783 =item XST_mIV
3784 X<XST_mIV>
3785
3786 Place an integer into the specified position C<pos> on the stack.  The
3787 value is stored in a new mortal SV.
3788
3789         void    XST_mIV(int pos, IV iv)
3790
3791 =for hackers
3792 Found in file XSUB.h
3793
3794 =item XST_mNO
3795 X<XST_mNO>
3796
3797 Place C<&PL_sv_no> into the specified position C<pos> on the
3798 stack.
3799
3800         void    XST_mNO(int pos)
3801
3802 =for hackers
3803 Found in file XSUB.h
3804
3805 =item XST_mNV
3806 X<XST_mNV>
3807
3808 Place a double into the specified position C<pos> on the stack.  The value
3809 is stored in a new mortal SV.
3810
3811         void    XST_mNV(int pos, NV nv)
3812
3813 =for hackers
3814 Found in file XSUB.h
3815
3816 =item XST_mPV
3817 X<XST_mPV>
3818
3819 Place a copy of a string into the specified position C<pos> on the stack. 
3820 The value is stored in a new mortal SV.
3821
3822         void    XST_mPV(int pos, char* str)
3823
3824 =for hackers
3825 Found in file XSUB.h
3826
3827 =item XST_mUNDEF
3828 X<XST_mUNDEF>
3829
3830 Place C<&PL_sv_undef> into the specified position C<pos> on the
3831 stack.
3832
3833         void    XST_mUNDEF(int pos)
3834
3835 =for hackers
3836 Found in file XSUB.h
3837
3838 =item XST_mYES
3839 X<XST_mYES>
3840
3841 Place C<&PL_sv_yes> into the specified position C<pos> on the
3842 stack.
3843
3844         void    XST_mYES(int pos)
3845
3846 =for hackers
3847 Found in file XSUB.h
3848
3849
3850 =back
3851
3852 =head1 SV Flags
3853
3854 =over 8
3855
3856 =item svtype
3857 X<svtype>
3858
3859 An enum of flags for Perl types.  These are found in the file B<sv.h>
3860 in the C<svtype> enum.  Test these flags with the C<SvTYPE> macro.
3861
3862 =for hackers
3863 Found in file sv.h
3864
3865 =item SVt_IV
3866 X<SVt_IV>
3867
3868 Integer type flag for scalars.  See C<svtype>.
3869
3870 =for hackers
3871 Found in file sv.h
3872
3873 =item SVt_NV
3874 X<SVt_NV>
3875
3876 Double type flag for scalars.  See C<svtype>.
3877
3878 =for hackers
3879 Found in file sv.h
3880
3881 =item SVt_PV
3882 X<SVt_PV>
3883
3884 Pointer type flag for scalars.  See C<svtype>.
3885
3886 =for hackers
3887 Found in file sv.h
3888
3889 =item SVt_PVAV
3890 X<SVt_PVAV>
3891
3892 Type flag for arrays.  See C<svtype>.
3893
3894 =for hackers
3895 Found in file sv.h
3896
3897 =item SVt_PVCV
3898 X<SVt_PVCV>
3899
3900 Type flag for code refs.  See C<svtype>.
3901
3902 =for hackers
3903 Found in file sv.h
3904
3905 =item SVt_PVHV
3906 X<SVt_PVHV>
3907
3908 Type flag for hashes.  See C<svtype>.
3909
3910 =for hackers
3911 Found in file sv.h
3912
3913 =item SVt_PVMG
3914 X<SVt_PVMG>
3915
3916 Type flag for blessed scalars.  See C<svtype>.
3917
3918 =for hackers
3919 Found in file sv.h
3920
3921
3922 =back
3923
3924 =head1 SV Manipulation Functions
3925
3926 =over 8
3927
3928 =item get_sv
3929 X<get_sv>
3930
3931 Returns the SV of the specified Perl scalar.  If C<create> is set and the
3932 Perl variable does not exist then it will be created.  If C<create> is not
3933 set and the variable does not exist then NULL is returned.
3934
3935 NOTE: the perl_ form of this function is deprecated.
3936
3937         SV*     get_sv(const char* name, I32 create)
3938
3939 =for hackers
3940 Found in file perl.c
3941
3942 =item newRV_inc
3943 X<newRV_inc>
3944
3945 Creates an RV wrapper for an SV.  The reference count for the original SV is
3946 incremented.
3947
3948         SV*     newRV_inc(SV* sv)
3949
3950 =for hackers
3951 Found in file sv.h
3952
3953 =item newSVpvn_utf8
3954 X<newSVpvn_utf8>
3955
3956 Creates a new SV and copies a string into it.  If utf8 is true, calls
3957 C<SvUTF8_on> on the new SV.  Implemented as a wrapper around C<newSVpvn_flags>.
3958
3959         SV*     newSVpvn_utf8(NULLOK const char* s, STRLEN len, U32 utf8)
3960
3961 =for hackers
3962 Found in file sv.h
3963
3964 =item SvCUR
3965 X<SvCUR>
3966
3967 Returns the length of the string which is in the SV.  See C<SvLEN>.
3968
3969         STRLEN  SvCUR(SV* sv)
3970
3971 =for hackers
3972 Found in file sv.h
3973
3974 =item SvCUR_set
3975 X<SvCUR_set>
3976
3977 Set the current length of the string which is in the SV.  See C<SvCUR>
3978 and C<SvIV_set>.
3979
3980         void    SvCUR_set(SV* sv, STRLEN len)
3981
3982 =for hackers
3983 Found in file sv.h
3984
3985 =item SvEND
3986 X<SvEND>
3987
3988 Returns a pointer to the last character in the string which is in the SV.
3989 See C<SvCUR>.  Access the character as *(SvEND(sv)).
3990
3991         char*   SvEND(SV* sv)
3992
3993 =for hackers
3994 Found in file sv.h
3995
3996 =item SvGAMAGIC
3997 X<SvGAMAGIC>
3998
3999 Returns true if the SV has get magic or overloading. If either is true then
4000 the scalar is active data, and has the potential to return a new value every
4001 time it is accessed. Hence you must be careful to only read it once per user
4002 logical operation and work with that returned value. If neither is true then
4003 the scalar's value cannot change unless written to.
4004
4005         char*   SvGAMAGIC(SV* sv)
4006
4007 =for hackers
4008 Found in file sv.h
4009
4010 =item SvGROW
4011 X<SvGROW>
4012
4013 Expands the character buffer in the SV so that it has room for the
4014 indicated number of bytes (remember to reserve space for an extra trailing
4015 NUL character).  Calls C<sv_grow> to perform the expansion if necessary.
4016 Returns a pointer to the character buffer.
4017
4018         char *  SvGROW(SV* sv, STRLEN len)
4019
4020 =for hackers
4021 Found in file sv.h
4022
4023 =item SvIOK
4024 X<SvIOK>
4025
4026 Returns a U32 value indicating whether the SV contains an integer.
4027
4028         U32     SvIOK(SV* sv)
4029
4030 =for hackers
4031 Found in file sv.h
4032
4033 =item SvIOKp
4034 X<SvIOKp>
4035
4036 Returns a U32 value indicating whether the SV contains an integer.  Checks
4037 the B<private> setting.  Use C<SvIOK>.
4038
4039         U32     SvIOKp(SV* sv)
4040
4041 =for hackers
4042 Found in file sv.h
4043
4044 =item SvIOK_notUV
4045 X<SvIOK_notUV>
4046
4047 Returns a boolean indicating whether the SV contains a signed integer.
4048
4049         bool    SvIOK_notUV(SV* sv)
4050
4051 =for hackers
4052 Found in file sv.h
4053
4054 =item SvIOK_off
4055 X<SvIOK_off>
4056
4057 Unsets the IV status of an SV.
4058
4059         void    SvIOK_off(SV* sv)
4060
4061 =for hackers
4062 Found in file sv.h
4063
4064 =item SvIOK_on
4065 X<SvIOK_on>
4066
4067 Tells an SV that it is an integer.
4068
4069         void    SvIOK_on(SV* sv)
4070
4071 =for hackers
4072 Found in file sv.h
4073
4074 =item SvIOK_only
4075 X<SvIOK_only>
4076
4077 Tells an SV that it is an integer and disables all other OK bits.
4078
4079         void    SvIOK_only(SV* sv)
4080
4081 =for hackers
4082 Found in file sv.h
4083
4084 =item SvIOK_only_UV
4085 X<SvIOK_only_UV>
4086
4087 Tells and SV that it is an unsigned integer and disables all other OK bits.
4088
4089         void    SvIOK_only_UV(SV* sv)
4090
4091 =for hackers
4092 Found in file sv.h
4093
4094 =item SvIOK_UV
4095 X<SvIOK_UV>
4096
4097 Returns a boolean indicating whether the SV contains an unsigned integer.
4098
4099         bool    SvIOK_UV(SV* sv)
4100
4101 =for hackers
4102 Found in file sv.h
4103
4104 =item SvIsCOW
4105 X<SvIsCOW>
4106
4107 Returns a boolean indicating whether the SV is Copy-On-Write. (either shared
4108 hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for
4109 COW)
4110
4111         bool    SvIsCOW(SV* sv)
4112
4113 =for hackers
4114 Found in file sv.h
4115
4116 =item SvIsCOW_shared_hash
4117 X<SvIsCOW_shared_hash>
4118
4119 Returns a boolean indicating whether the SV is Copy-On-Write shared hash key
4120 scalar.
4121
4122         bool    SvIsCOW_shared_hash(SV* sv)
4123
4124 =for hackers
4125 Found in file sv.h
4126
4127 =item SvIV
4128 X<SvIV>
4129
4130 Coerces the given SV to an integer and returns it. See C<SvIVx> for a
4131 version which guarantees to evaluate sv only once.
4132
4133         IV      SvIV(SV* sv)
4134
4135 =for hackers
4136 Found in file sv.h
4137
4138 =item SvIVX
4139 X<SvIVX>
4140
4141 Returns the raw value in the SV's IV slot, without checks or conversions.
4142 Only use when you are sure SvIOK is true. See also C<SvIV()>.
4143
4144         IV      SvIVX(SV* sv)
4145
4146 =for hackers
4147 Found in file sv.h
4148
4149 =item SvIVx
4150 X<SvIVx>
4151
4152 Coerces the given SV to an integer and returns it. Guarantees to evaluate
4153 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4154 otherwise use the more efficient C<SvIV>.
4155
4156         IV      SvIVx(SV* sv)
4157
4158 =for hackers
4159 Found in file sv.h
4160
4161 =item SvIV_nomg
4162 X<SvIV_nomg>
4163
4164 Like C<SvIV> but doesn't process magic.
4165
4166         IV      SvIV_nomg(SV* sv)
4167
4168 =for hackers
4169 Found in file sv.h
4170
4171 =item SvIV_set
4172 X<SvIV_set>
4173
4174 Set the value of the IV pointer in sv to val.  It is possible to perform
4175 the same function of this macro with an lvalue assignment to C<SvIVX>.
4176 With future Perls, however, it will be more efficient to use 
4177 C<SvIV_set> instead of the lvalue assignment to C<SvIVX>.
4178
4179         void    SvIV_set(SV* sv, IV val)
4180
4181 =for hackers
4182 Found in file sv.h
4183
4184 =item SvLEN
4185 X<SvLEN>
4186
4187 Returns the size of the string buffer in the SV, not including any part
4188 attributable to C<SvOOK>.  See C<SvCUR>.
4189
4190         STRLEN  SvLEN(SV* sv)
4191
4192 =for hackers
4193 Found in file sv.h
4194
4195 =item SvLEN_set
4196 X<SvLEN_set>
4197
4198 Set the actual length of the string which is in the SV.  See C<SvIV_set>.
4199
4200         void    SvLEN_set(SV* sv, STRLEN len)
4201
4202 =for hackers
4203 Found in file sv.h
4204
4205 =item SvMAGIC_set
4206 X<SvMAGIC_set>
4207
4208 Set the value of the MAGIC pointer in sv to val.  See C<SvIV_set>.
4209
4210         void    SvMAGIC_set(SV* sv, MAGIC* val)
4211
4212 =for hackers
4213 Found in file sv.h
4214
4215 =item SvNIOK
4216 X<SvNIOK>
4217
4218 Returns a U32 value indicating whether the SV contains a number, integer or
4219 double.
4220
4221         U32     SvNIOK(SV* sv)
4222
4223 =for hackers
4224 Found in file sv.h
4225
4226 =item SvNIOKp
4227 X<SvNIOKp>
4228
4229 Returns a U32 value indicating whether the SV contains a number, integer or
4230 double.  Checks the B<private> setting.  Use C<SvNIOK>.
4231
4232         U32     SvNIOKp(SV* sv)
4233
4234 =for hackers
4235 Found in file sv.h
4236
4237 =item SvNIOK_off
4238 X<SvNIOK_off>
4239
4240 Unsets the NV/IV status of an SV.
4241
4242         void    SvNIOK_off(SV* sv)
4243
4244 =for hackers
4245 Found in file sv.h
4246
4247 =item SvNOK
4248 X<SvNOK>
4249
4250 Returns a U32 value indicating whether the SV contains a double.
4251
4252         U32     SvNOK(SV* sv)
4253
4254 =for hackers
4255 Found in file sv.h
4256
4257 =item SvNOKp
4258 X<SvNOKp>
4259
4260 Returns a U32 value indicating whether the SV contains a double.  Checks the
4261 B<private> setting.  Use C<SvNOK>.
4262
4263         U32     SvNOKp(SV* sv)
4264
4265 =for hackers
4266 Found in file sv.h
4267
4268 =item SvNOK_off
4269 X<SvNOK_off>
4270
4271 Unsets the NV status of an SV.
4272
4273         void    SvNOK_off(SV* sv)
4274
4275 =for hackers
4276 Found in file sv.h
4277
4278 =item SvNOK_on
4279 X<SvNOK_on>
4280
4281 Tells an SV that it is a double.
4282
4283         void    SvNOK_on(SV* sv)
4284
4285 =for hackers
4286 Found in file sv.h
4287
4288 =item SvNOK_only
4289 X<SvNOK_only>
4290
4291 Tells an SV that it is a double and disables all other OK bits.
4292
4293         void    SvNOK_only(SV* sv)
4294
4295 =for hackers
4296 Found in file sv.h
4297
4298 =item SvNV
4299 X<SvNV>
4300
4301 Coerce the given SV to a double and return it. See C<SvNVx> for a version
4302 which guarantees to evaluate sv only once.
4303
4304         NV      SvNV(SV* sv)
4305
4306 =for hackers
4307 Found in file sv.h
4308
4309 =item SvNVX
4310 X<SvNVX>
4311
4312 Returns the raw value in the SV's NV slot, without checks or conversions.
4313 Only use when you are sure SvNOK is true. See also C<SvNV()>.
4314
4315         NV      SvNVX(SV* sv)
4316
4317 =for hackers
4318 Found in file sv.h
4319
4320 =item SvNVx
4321 X<SvNVx>
4322
4323 Coerces the given SV to a double and returns it. Guarantees to evaluate
4324 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4325 otherwise use the more efficient C<SvNV>.
4326
4327         NV      SvNVx(SV* sv)
4328
4329 =for hackers
4330 Found in file sv.h
4331
4332 =item SvNV_set
4333 X<SvNV_set>
4334
4335 Set the value of the NV pointer in sv to val.  See C<SvIV_set>.
4336
4337         void    SvNV_set(SV* sv, NV val)
4338
4339 =for hackers
4340 Found in file sv.h
4341
4342 =item SvOK
4343 X<SvOK>
4344
4345 Returns a U32 value indicating whether the value is an SV. It also tells
4346 whether the value is defined or not.
4347
4348         U32     SvOK(SV* sv)
4349
4350 =for hackers
4351 Found in file sv.h
4352
4353 =item SvOOK
4354 X<SvOOK>
4355
4356 Returns a U32 indicating whether the pointer to the string buffer is offset.
4357 This hack is used internally to speed up removal of characters from the
4358 beginning of a SvPV.  When SvOOK is true, then the start of the
4359 allocated string buffer is actually C<SvOOK_offset()> bytes before SvPVX.
4360 This offset used to be stored in SvIVX, but is now stored within the spare
4361 part of the buffer.
4362
4363         U32     SvOOK(SV* sv)
4364
4365 =for hackers
4366 Found in file sv.h
4367
4368 =item SvOOK_offset
4369 X<SvOOK_offset>
4370
4371 Reads into I<len> the offset from SvPVX back to the true start of the
4372 allocated buffer, which will be non-zero if C<sv_chop> has been used to
4373 efficiently remove characters from start of the buffer. Implemented as a
4374 macro, which takes the address of I<len>, which must be of type C<STRLEN>.
4375 Evaluates I<sv> more than once. Sets I<len> to 0 if C<SvOOK(sv)> is false.
4376
4377         void    SvOOK_offset(NN SV*sv, STRLEN len)
4378
4379 =for hackers
4380 Found in file sv.h
4381
4382 =item SvPOK
4383 X<SvPOK>
4384
4385 Returns a U32 value indicating whether the SV contains a character
4386 string.
4387
4388         U32     SvPOK(SV* sv)
4389
4390 =for hackers
4391 Found in file sv.h
4392
4393 =item SvPOKp
4394 X<SvPOKp>
4395
4396 Returns a U32 value indicating whether the SV contains a character string.
4397 Checks the B<private> setting.  Use C<SvPOK>.
4398
4399         U32     SvPOKp(SV* sv)
4400
4401 =for hackers
4402 Found in file sv.h
4403
4404 =item SvPOK_off
4405 X<SvPOK_off>
4406
4407 Unsets the PV status of an SV.
4408
4409         void    SvPOK_off(SV* sv)
4410
4411 =for hackers
4412 Found in file sv.h
4413
4414 =item SvPOK_on
4415 X<SvPOK_on>
4416
4417 Tells an SV that it is a string.
4418
4419         void    SvPOK_on(SV* sv)
4420
4421 =for hackers
4422 Found in file sv.h
4423
4424 =item SvPOK_only
4425 X<SvPOK_only>
4426
4427 Tells an SV that it is a string and disables all other OK bits.
4428 Will also turn off the UTF-8 status.
4429
4430         void    SvPOK_only(SV* sv)
4431
4432 =for hackers
4433 Found in file sv.h
4434
4435 =item SvPOK_only_UTF8
4436 X<SvPOK_only_UTF8>
4437
4438 Tells an SV that it is a string and disables all other OK bits,
4439 and leaves the UTF-8 status as it was.
4440
4441         void    SvPOK_only_UTF8(SV* sv)
4442
4443 =for hackers
4444 Found in file sv.h
4445
4446 =item SvPV
4447 X<SvPV>
4448
4449 Returns a pointer to the string in the SV, or a stringified form of
4450 the SV if the SV does not contain a string.  The SV may cache the
4451 stringified version becoming C<SvPOK>.  Handles 'get' magic. See also
4452 C<SvPVx> for a version which guarantees to evaluate sv only once.
4453
4454         char*   SvPV(SV* sv, STRLEN len)
4455
4456 =for hackers
4457 Found in file sv.h
4458
4459 =item SvPVbyte
4460 X<SvPVbyte>
4461
4462 Like C<SvPV>, but converts sv to byte representation first if necessary.
4463
4464         char*   SvPVbyte(SV* sv, STRLEN len)
4465
4466 =for hackers
4467 Found in file sv.h
4468
4469 =item SvPVbytex
4470 X<SvPVbytex>
4471
4472 Like C<SvPV>, but converts sv to byte representation first if necessary.
4473 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte>
4474 otherwise.
4475
4476         char*   SvPVbytex(SV* sv, STRLEN len)
4477
4478 =for hackers
4479 Found in file sv.h
4480
4481 =item SvPVbytex_force
4482 X<SvPVbytex_force>
4483
4484 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4485 Guarantees to evaluate sv only once; use the more efficient C<SvPVbyte_force>
4486 otherwise.
4487
4488         char*   SvPVbytex_force(SV* sv, STRLEN len)
4489
4490 =for hackers
4491 Found in file sv.h
4492
4493 =item SvPVbyte_force
4494 X<SvPVbyte_force>
4495
4496 Like C<SvPV_force>, but converts sv to byte representation first if necessary.
4497
4498         char*   SvPVbyte_force(SV* sv, STRLEN len)
4499
4500 =for hackers
4501 Found in file sv.h
4502
4503 =item SvPVbyte_nolen
4504 X<SvPVbyte_nolen>
4505
4506 Like C<SvPV_nolen>, but converts sv to byte representation first if necessary.
4507
4508         char*   SvPVbyte_nolen(SV* sv)
4509
4510 =for hackers
4511 Found in file sv.h
4512
4513 =item SvPVutf8
4514 X<SvPVutf8>
4515
4516 Like C<SvPV>, but converts sv to utf8 first if necessary.
4517
4518         char*   SvPVutf8(SV* sv, STRLEN len)
4519
4520 =for hackers
4521 Found in file sv.h
4522
4523 =item SvPVutf8x
4524 X<SvPVutf8x>
4525
4526 Like C<SvPV>, but converts sv to utf8 first if necessary.
4527 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8>
4528 otherwise.
4529
4530         char*   SvPVutf8x(SV* sv, STRLEN len)
4531
4532 =for hackers
4533 Found in file sv.h
4534
4535 =item SvPVutf8x_force
4536 X<SvPVutf8x_force>
4537
4538 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4539 Guarantees to evaluate sv only once; use the more efficient C<SvPVutf8_force>
4540 otherwise.
4541
4542         char*   SvPVutf8x_force(SV* sv, STRLEN len)
4543
4544 =for hackers
4545 Found in file sv.h
4546
4547 =item SvPVutf8_force
4548 X<SvPVutf8_force>
4549
4550 Like C<SvPV_force>, but converts sv to utf8 first if necessary.
4551
4552         char*   SvPVutf8_force(SV* sv, STRLEN len)
4553
4554 =for hackers
4555 Found in file sv.h
4556
4557 =item SvPVutf8_nolen
4558 X<SvPVutf8_nolen>
4559
4560 Like C<SvPV_nolen>, but converts sv to utf8 first if necessary.
4561
4562         char*   SvPVutf8_nolen(SV* sv)
4563
4564 =for hackers
4565 Found in file sv.h
4566
4567 =item SvPVX
4568 X<SvPVX>
4569
4570 Returns a pointer to the physical string in the SV.  The SV must contain a
4571 string.
4572
4573         char*   SvPVX(SV* sv)
4574
4575 =for hackers
4576 Found in file sv.h
4577
4578 =item SvPVx
4579 X<SvPVx>
4580
4581 A version of C<SvPV> which guarantees to evaluate C<sv> only once.
4582 Only use this if C<sv> is an expression with side effects, otherwise use the
4583 more efficient C<SvPVX>.
4584
4585         char*   SvPVx(SV* sv, STRLEN len)
4586
4587 =for hackers
4588 Found in file sv.h
4589
4590 =item SvPV_force
4591 X<SvPV_force>
4592
4593 Like C<SvPV> but will force the SV into containing just a string
4594 (C<SvPOK_only>).  You want force if you are going to update the C<SvPVX>
4595 directly.
4596
4597         char*   SvPV_force(SV* sv, STRLEN len)
4598
4599 =for hackers
4600 Found in file sv.h
4601
4602 =item SvPV_force_nomg
4603 X<SvPV_force_nomg>
4604
4605 Like C<SvPV> but will force the SV into containing just a string
4606 (C<SvPOK_only>).  You want force if you are going to update the C<SvPVX>
4607 directly. Doesn't process magic.
4608
4609         char*   SvPV_force_nomg(SV* sv, STRLEN len)
4610
4611 =for hackers
4612 Found in file sv.h
4613
4614 =item SvPV_nolen
4615 X<SvPV_nolen>
4616
4617 Returns a pointer to the string in the SV, or a stringified form of
4618 the SV if the SV does not contain a string.  The SV may cache the
4619 stringified form becoming C<SvPOK>.  Handles 'get' magic.
4620
4621         char*   SvPV_nolen(SV* sv)
4622
4623 =for hackers
4624 Found in file sv.h
4625
4626 =item SvPV_nomg
4627 X<SvPV_nomg>
4628
4629 Like C<SvPV> but doesn't process magic.
4630
4631         char*   SvPV_nomg(SV* sv, STRLEN len)
4632
4633 =for hackers
4634 Found in file sv.h
4635
4636 =item SvPV_set
4637 X<SvPV_set>
4638
4639 Set the value of the PV pointer in sv to val.  See C<SvIV_set>.
4640
4641         void    SvPV_set(SV* sv, char* val)
4642
4643 =for hackers
4644 Found in file sv.h
4645
4646 =item SvREFCNT
4647 X<SvREFCNT>
4648
4649 Returns the value of the object's reference count.
4650
4651         U32     SvREFCNT(SV* sv)
4652
4653 =for hackers
4654 Found in file sv.h
4655
4656 =item SvREFCNT_dec
4657 X<SvREFCNT_dec>
4658
4659 Decrements the reference count of the given SV.
4660
4661         void    SvREFCNT_dec(SV* sv)
4662
4663 =for hackers
4664 Found in file sv.h
4665
4666 =item SvREFCNT_inc
4667 X<SvREFCNT_inc>
4668
4669 Increments the reference count of the given SV.
4670
4671 All of the following SvREFCNT_inc* macros are optimized versions of
4672 SvREFCNT_inc, and can be replaced with SvREFCNT_inc.
4673
4674         SV*     SvREFCNT_inc(SV* sv)
4675
4676 =for hackers
4677 Found in file sv.h
4678
4679 =item SvREFCNT_inc_NN
4680 X<SvREFCNT_inc_NN>
4681
4682 Same as SvREFCNT_inc, but can only be used if you know I<sv>
4683 is not NULL.  Since we don't have to check the NULLness, it's faster
4684 and smaller.
4685
4686         SV*     SvREFCNT_inc_NN(SV* sv)
4687
4688 =for hackers
4689 Found in file sv.h
4690
4691 =item SvREFCNT_inc_simple
4692 X<SvREFCNT_inc_simple>
4693
4694 Same as SvREFCNT_inc, but can only be used with expressions without side
4695 effects.  Since we don't have to store a temporary value, it's faster.
4696
4697         SV*     SvREFCNT_inc_simple(SV* sv)
4698
4699 =for hackers
4700 Found in file sv.h
4701
4702 =item SvREFCNT_inc_simple_NN
4703 X<SvREFCNT_inc_simple_NN>
4704
4705 Same as SvREFCNT_inc_simple, 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_simple_NN(SV* sv)
4710
4711 =for hackers
4712 Found in file sv.h
4713
4714 =item SvREFCNT_inc_simple_void
4715 X<SvREFCNT_inc_simple_void>
4716
4717 Same as SvREFCNT_inc_simple, but can only be used if you don't need the
4718 return value.  The macro doesn't need to return a meaningful value.
4719
4720         void    SvREFCNT_inc_simple_void(SV* sv)
4721
4722 =for hackers
4723 Found in file sv.h
4724
4725 =item SvREFCNT_inc_simple_void_NN
4726 X<SvREFCNT_inc_simple_void_NN>
4727
4728 Same as SvREFCNT_inc, but can only be used if you don't need the return
4729 value, and you know that I<sv> is not NULL.  The macro doesn't need
4730 to return a meaningful value, or check for NULLness, so it's smaller
4731 and faster.
4732
4733         void    SvREFCNT_inc_simple_void_NN(SV* sv)
4734
4735 =for hackers
4736 Found in file sv.h
4737
4738 =item SvREFCNT_inc_void
4739 X<SvREFCNT_inc_void>
4740
4741 Same as SvREFCNT_inc, but can only be used if you don't need the
4742 return value.  The macro doesn't need to return a meaningful value.
4743
4744         void    SvREFCNT_inc_void(SV* sv)
4745
4746 =for hackers
4747 Found in file sv.h
4748
4749 =item SvREFCNT_inc_void_NN
4750 X<SvREFCNT_inc_void_NN>
4751
4752 Same as SvREFCNT_inc, but can only be used if you don't need the return
4753 value, and you know that I<sv> is not NULL.  The macro doesn't need
4754 to return a meaningful value, or check for NULLness, so it's smaller
4755 and faster.
4756
4757         void    SvREFCNT_inc_void_NN(SV* sv)
4758
4759 =for hackers
4760 Found in file sv.h
4761
4762 =item SvROK
4763 X<SvROK>
4764
4765 Tests if the SV is an RV.
4766
4767         U32     SvROK(SV* sv)
4768
4769 =for hackers
4770 Found in file sv.h
4771
4772 =item SvROK_off
4773 X<SvROK_off>
4774
4775 Unsets the RV status of an SV.
4776
4777         void    SvROK_off(SV* sv)
4778
4779 =for hackers
4780 Found in file sv.h
4781
4782 =item SvROK_on
4783 X<SvROK_on>
4784
4785 Tells an SV that it is an RV.
4786
4787         void    SvROK_on(SV* sv)
4788
4789 =for hackers
4790 Found in file sv.h
4791
4792 =item SvRV
4793 X<SvRV>
4794
4795 Dereferences an RV to return the SV.
4796
4797         SV*     SvRV(SV* sv)
4798
4799 =for hackers
4800 Found in file sv.h
4801
4802 =item SvRV_set
4803 X<SvRV_set>
4804
4805 Set the value of the RV pointer in sv to val.  See C<SvIV_set>.
4806
4807         void    SvRV_set(SV* sv, SV* val)
4808
4809 =for hackers
4810 Found in file sv.h
4811
4812 =item SvSTASH
4813 X<SvSTASH>
4814
4815 Returns the stash of the SV.
4816
4817         HV*     SvSTASH(SV* sv)
4818
4819 =for hackers
4820 Found in file sv.h
4821
4822 =item SvSTASH_set
4823 X<SvSTASH_set>
4824
4825 Set the value of the STASH pointer in sv to val.  See C<SvIV_set>.
4826
4827         void    SvSTASH_set(SV* sv, HV* val)
4828
4829 =for hackers
4830 Found in file sv.h
4831
4832 =item SvTAINT
4833 X<SvTAINT>
4834
4835 Taints an SV if tainting is enabled.
4836
4837         void    SvTAINT(SV* sv)
4838
4839 =for hackers
4840 Found in file sv.h
4841
4842 =item SvTAINTED
4843 X<SvTAINTED>
4844
4845 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
4846 not.
4847
4848         bool    SvTAINTED(SV* sv)
4849
4850 =for hackers
4851 Found in file sv.h
4852
4853 =item SvTAINTED_off
4854 X<SvTAINTED_off>
4855
4856 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
4857 some of Perl's fundamental security features. XS module authors should not
4858 use this function unless they fully understand all the implications of
4859 unconditionally untainting the value. Untainting should be done in the
4860 standard perl fashion, via a carefully crafted regexp, rather than directly
4861 untainting variables.
4862
4863         void    SvTAINTED_off(SV* sv)
4864
4865 =for hackers
4866 Found in file sv.h
4867
4868 =item SvTAINTED_on
4869 X<SvTAINTED_on>
4870
4871 Marks an SV as tainted if tainting is enabled.
4872
4873         void    SvTAINTED_on(SV* sv)
4874
4875 =for hackers
4876 Found in file sv.h
4877
4878 =item SvTRUE
4879 X<SvTRUE>
4880
4881 Returns a boolean indicating whether Perl would evaluate the SV as true or
4882 false, defined or undefined.  Does not handle 'get' magic.
4883
4884         bool    SvTRUE(SV* sv)
4885
4886 =for hackers
4887 Found in file sv.h
4888
4889 =item SvTYPE
4890 X<SvTYPE>
4891
4892 Returns the type of the SV.  See C<svtype>.
4893
4894         svtype  SvTYPE(SV* sv)
4895
4896 =for hackers
4897 Found in file sv.h
4898
4899 =item SvUOK
4900 X<SvUOK>
4901
4902 Returns a boolean indicating whether the SV contains an unsigned integer.
4903
4904         bool    SvUOK(SV* sv)
4905
4906 =for hackers
4907 Found in file sv.h
4908
4909 =item SvUPGRADE
4910 X<SvUPGRADE>
4911
4912 Used to upgrade an SV to a more complex form.  Uses C<sv_upgrade> to
4913 perform the upgrade if necessary.  See C<svtype>.
4914
4915         void    SvUPGRADE(SV* sv, svtype type)
4916
4917 =for hackers
4918 Found in file sv.h
4919
4920 =item SvUTF8
4921 X<SvUTF8>
4922
4923 Returns a U32 value indicating whether the SV contains UTF-8 encoded data.
4924 Call this after SvPV() in case any call to string overloading updates the
4925 internal flag.
4926
4927         U32     SvUTF8(SV* sv)
4928
4929 =for hackers
4930 Found in file sv.h
4931
4932 =item SvUTF8_off
4933 X<SvUTF8_off>
4934
4935 Unsets the UTF-8 status of an SV.
4936
4937         void    SvUTF8_off(SV *sv)
4938
4939 =for hackers
4940 Found in file sv.h
4941
4942 =item SvUTF8_on
4943 X<SvUTF8_on>
4944
4945 Turn on the UTF-8 status of an SV (the data is not changed, just the flag).
4946 Do not use frivolously.
4947
4948         void    SvUTF8_on(SV *sv)
4949
4950 =for hackers
4951 Found in file sv.h
4952
4953 =item SvUV
4954 X<SvUV>
4955
4956 Coerces the given SV to an unsigned integer and returns it.  See C<SvUVx>
4957 for a version which guarantees to evaluate sv only once.
4958
4959         UV      SvUV(SV* sv)
4960
4961 =for hackers
4962 Found in file sv.h
4963
4964 =item SvUVX
4965 X<SvUVX>
4966
4967 Returns the raw value in the SV's UV slot, without checks or conversions.
4968 Only use when you are sure SvIOK is true. See also C<SvUV()>.
4969
4970         UV      SvUVX(SV* sv)
4971
4972 =for hackers
4973 Found in file sv.h
4974
4975 =item SvUVx
4976 X<SvUVx>
4977
4978 Coerces the given SV to an unsigned integer and returns it. Guarantees to
4979 C<sv> only once. Only use this if C<sv> is an expression with side effects,
4980 otherwise use the more efficient C<SvUV>.
4981
4982         UV      SvUVx(SV* sv)
4983
4984 =for hackers
4985 Found in file sv.h
4986
4987 =item SvUV_nomg
4988 X<SvUV_nomg>
4989
4990 Like C<SvUV> but doesn't process magic.
4991
4992         UV      SvUV_nomg(SV* sv)
4993
4994 =for hackers
4995 Found in file sv.h
4996
4997 =item SvUV_set
4998 X<SvUV_set>
4999
5000 Set the value of the UV pointer in sv to val.  See C<SvIV_set>.
5001
5002         void    SvUV_set(SV* sv, UV val)
5003
5004 =for hackers
5005 Found in file sv.h
5006
5007 =item SvVOK
5008 X<SvVOK>
5009
5010 Returns a boolean indicating whether the SV contains a v-string.
5011
5012         bool    SvVOK(SV* sv)
5013
5014 =for hackers
5015 Found in file sv.h
5016
5017 =item sv_catpvn_nomg
5018 X<sv_catpvn_nomg>
5019
5020 Like C<sv_catpvn> but doesn't process magic.
5021
5022         void    sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)
5023
5024 =for hackers
5025 Found in file sv.h
5026
5027 =item sv_catsv_nomg
5028 X<sv_catsv_nomg>
5029
5030 Like C<sv_catsv> but doesn't process magic.
5031
5032         void    sv_catsv_nomg(SV* dsv, SV* ssv)
5033
5034 =for hackers
5035 Found in file sv.h
5036
5037 =item sv_derived_from
5038 X<sv_derived_from>
5039
5040 Returns a boolean indicating whether the SV is derived from the specified class
5041 I<at the C level>.  To check derivation at the Perl level, call C<isa()> as a
5042 normal Perl method.
5043
5044         bool    sv_derived_from(SV* sv, const char* name)
5045
5046 =for hackers
5047 Found in file universal.c
5048
5049 =item sv_does
5050 X<sv_does>
5051
5052 Returns a boolean indicating whether the SV performs a specific, named role.
5053 The SV can be a Perl object or the name of a Perl class.
5054
5055         bool    sv_does(SV* sv, const char* name)
5056
5057 =for hackers
5058 Found in file universal.c
5059
5060 =item sv_report_used
5061 X<sv_report_used>
5062
5063 Dump the contents of all SVs not yet freed. (Debugging aid).
5064
5065         void    sv_report_used()
5066
5067 =for hackers
5068 Found in file sv.c
5069
5070 =item sv_setsv_nomg
5071 X<sv_setsv_nomg>
5072
5073 Like C<sv_setsv> but doesn't process magic.
5074
5075         void    sv_setsv_nomg(SV* dsv, SV* ssv)
5076
5077 =for hackers
5078 Found in file sv.h
5079
5080
5081 =back
5082
5083 =head1 SV-Body Allocation
5084
5085 =over 8
5086
5087 =item looks_like_number
5088 X<looks_like_number>
5089
5090 Test if the content of an SV looks like a number (or is a number).
5091 C<Inf> and C<Infinity> are treated as numbers (so will not issue a
5092 non-numeric warning), even if your atof() doesn't grok them.
5093
5094         I32     looks_like_number(SV* sv)
5095
5096 =for hackers
5097 Found in file sv.c
5098
5099 =item newRV_noinc
5100 X<newRV_noinc>
5101
5102 Creates an RV wrapper for an SV.  The reference count for the original
5103 SV is B<not> incremented.
5104
5105         SV*     newRV_noinc(SV* sv)
5106
5107 =for hackers
5108 Found in file sv.c
5109
5110 =item newSV
5111 X<newSV>
5112
5113 Creates a new SV.  A non-zero C<len> parameter indicates the number of
5114 bytes of preallocated string space the SV should have.  An extra byte for a
5115 trailing NUL is also reserved.  (SvPOK is not set for the SV even if string
5116 space is allocated.)  The reference count for the new SV is set to 1.
5117
5118 In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first
5119 parameter, I<x>, a debug aid which allowed callers to identify themselves.
5120 This aid has been superseded by a new build option, PERL_MEM_LOG (see
5121 L<perlhack/PERL_MEM_LOG>).  The older API is still there for use in XS
5122 modules supporting older perls.
5123
5124         SV*     newSV(STRLEN len)
5125
5126 =for hackers
5127 Found in file sv.c
5128
5129 =item newSVhek
5130 X<newSVhek>
5131
5132 Creates a new SV from the hash key structure.  It will generate scalars that
5133 point to the shared string table where possible. Returns a new (undefined)
5134 SV if the hek is NULL.
5135
5136         SV*     newSVhek(const HEK *hek)
5137
5138 =for hackers
5139 Found in file sv.c
5140
5141 =item newSViv
5142 X<newSViv>
5143
5144 Creates a new SV and copies an integer into it.  The reference count for the
5145 SV is set to 1.
5146
5147         SV*     newSViv(IV i)
5148
5149 =for hackers
5150 Found in file sv.c
5151
5152 =item newSVnv
5153 X<newSVnv>
5154
5155 Creates a new SV and copies a floating point value into it.
5156 The reference count for the SV is set to 1.
5157
5158         SV*     newSVnv(NV n)
5159
5160 =for hackers
5161 Found in file sv.c
5162
5163 =item newSVpv
5164 X<newSVpv>
5165
5166 Creates a new SV and copies a string into it.  The reference count for the
5167 SV is set to 1.  If C<len> is zero, Perl will compute the length using
5168 strlen().  For efficiency, consider using C<newSVpvn> instead.
5169
5170         SV*     newSVpv(const char* s, STRLEN len)
5171
5172 =for hackers
5173 Found in file sv.c
5174
5175 =item newSVpvf
5176 X<newSVpvf>
5177
5178 Creates a new SV and initializes it with the string formatted like
5179 C<sprintf>.
5180
5181         SV*     newSVpvf(const char* pat, ...)
5182
5183 =for hackers
5184 Found in file sv.c
5185
5186 =item newSVpvn
5187 X<newSVpvn>
5188
5189 Creates a new SV and copies a string into it.  The reference count for the
5190 SV is set to 1.  Note that if C<len> is zero, Perl will create a zero length
5191 string.  You are responsible for ensuring that the source string is at least
5192 C<len> bytes long.  If the C<s> argument is NULL the new SV will be undefined.
5193
5194         SV*     newSVpvn(const char* s, STRLEN len)
5195
5196 =for hackers
5197 Found in file sv.c
5198
5199 =item newSVpvn_flags
5200 X<newSVpvn_flags>
5201
5202 Creates a new SV and copies a string into it.  The reference count for the
5203 SV is set to 1.  Note that if C<len> is zero, Perl will create a zero length
5204 string.  You are responsible for ensuring that the source string is at least
5205 C<len> bytes long.  If the C<s> argument is NULL the new SV will be undefined.
5206 Currently the only flag bits accepted are C<SVf_UTF8> and C<SVs_TEMP>.
5207 If C<SVs_TEMP> is set, then C<sv2mortal()> is called on the result before
5208 returning. If C<SVf_UTF8> is set, then it will be set on the new SV.
5209 C<newSVpvn_utf8()> is a convenience wrapper for this function, defined as
5210
5211     #define newSVpvn_utf8(s, len, u)                    \
5212         newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)
5213
5214         SV*     newSVpvn_flags(const char* s, STRLEN len, U32 flags)
5215
5216 =for hackers
5217 Found in file sv.c
5218
5219 =item newSVpvn_share
5220 X<newSVpvn_share>
5221
5222 Creates a new SV with its SvPVX_const pointing to a shared string in the string
5223 table. If the string does not already exist in the table, it is created
5224 first.  Turns on READONLY and FAKE. If the C<hash> parameter is non-zero, that
5225 value is used; otherwise the hash is computed. The string's hash can be later
5226 be retrieved from the SV with the C<SvSHARED_HASH()> macro. The idea here is
5227 that as the string table is used for shared hash keys these strings will have
5228 SvPVX_const == HeKEY and hash lookup will avoid string compare.
5229
5230         SV*     newSVpvn_share(const char* s, I32 len, U32 hash)
5231
5232 =for hackers
5233 Found in file sv.c
5234
5235 =item newSVpvs
5236 X<newSVpvs>
5237
5238 Like C<newSVpvn>, but takes a literal string instead of a string/length pair.
5239
5240         SV*     newSVpvs(const char* s)
5241
5242 =for hackers
5243 Found in file handy.h
5244
5245 =item newSVpvs_flags
5246 X<newSVpvs_flags>
5247
5248 Like C<newSVpvn_flags>, but takes a literal string instead of a string/length
5249 pair.
5250
5251         SV*     newSVpvs_flags(const char* s, U32 flags)
5252
5253 =for hackers
5254 Found in file handy.h
5255
5256 =item newSVpvs_share
5257 X<newSVpvs_share>
5258
5259 Like C<newSVpvn_share>, but takes a literal string instead of a string/length
5260 pair and omits the hash parameter.
5261
5262         SV*     newSVpvs_share(const char* s)
5263
5264 =for hackers
5265 Found in file handy.h
5266
5267 =item newSVrv
5268 X<newSVrv>
5269
5270 Creates a new SV for the RV, C<rv>, to point to.  If C<rv> is not an RV then
5271 it will be upgraded to one.  If C<classname> is non-null then the new SV will
5272 be blessed in the specified package.  The new SV is returned and its
5273 reference count is 1.
5274
5275         SV*     newSVrv(SV* rv, const char* classname)
5276
5277 =for hackers
5278 Found in file sv.c
5279
5280 =item newSVsv
5281 X<newSVsv>
5282
5283 Creates a new SV which is an exact duplicate of the original SV.
5284 (Uses C<sv_setsv>).
5285
5286         SV*     newSVsv(SV* old)
5287
5288 =for hackers
5289 Found in file sv.c
5290
5291 =item newSVuv
5292 X<newSVuv>
5293
5294 Creates a new SV and copies an unsigned integer into it.
5295 The reference count for the SV is set to 1.
5296
5297         SV*     newSVuv(UV u)
5298
5299 =for hackers
5300 Found in file sv.c
5301
5302 =item newSV_type
5303 X<newSV_type>
5304
5305 Creates a new SV, of the type specified.  The reference count for the new SV
5306 is set to 1.
5307
5308         SV*     newSV_type(svtype type)
5309
5310 =for hackers
5311 Found in file sv.c
5312
5313 =item sv_2bool
5314 X<sv_2bool>
5315
5316 This function is only called on magical items, and is only used by
5317 sv_true() or its macro equivalent.
5318
5319         bool    sv_2bool(SV* sv)
5320
5321 =for hackers
5322 Found in file sv.c
5323
5324 =item sv_2cv
5325 X<sv_2cv>
5326
5327 Using various gambits, try to get a CV from an SV; in addition, try if
5328 possible to set C<*st> and C<*gvp> to the stash and GV associated with it.
5329 The flags in C<lref> are passed to sv_fetchsv.
5330
5331         CV*     sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)
5332
5333 =for hackers
5334 Found in file sv.c
5335
5336 =item sv_2io
5337 X<sv_2io>
5338
5339 Using various gambits, try to get an IO from an SV: the IO slot if its a
5340 GV; or the recursive result if we're an RV; or the IO slot of the symbol
5341 named after the PV if we're a string.
5342
5343         IO*     sv_2io(SV* sv)
5344
5345 =for hackers
5346 Found in file sv.c
5347
5348 =item sv_2iv_flags
5349 X<sv_2iv_flags>
5350
5351 Return the integer value of an SV, doing any necessary string
5352 conversion.  If flags includes SV_GMAGIC, does an mg_get() first.
5353 Normally used via the C<SvIV(sv)> and C<SvIVx(sv)> macros.
5354
5355         IV      sv_2iv_flags(SV* sv, I32 flags)
5356
5357 =for hackers
5358 Found in file sv.c
5359
5360 =item sv_2mortal
5361 X<sv_2mortal>
5362
5363 Marks an existing SV as mortal.  The SV will be destroyed "soon", either
5364 by an explicit call to FREETMPS, or by an implicit call at places such as
5365 statement boundaries.  SvTEMP() is turned on which means that the SV's
5366 string buffer can be "stolen" if this SV is copied. See also C<sv_newmortal>
5367 and C<sv_mortalcopy>.
5368
5369         SV*     sv_2mortal(SV* sv)
5370
5371 =for hackers
5372 Found in file sv.c
5373
5374 =item sv_2nv
5375 X<sv_2nv>
5376
5377 Return the num value of an SV, doing any necessary string or integer
5378 conversion, magic etc. Normally used via the C<SvNV(sv)> and C<SvNVx(sv)>
5379 macros.
5380
5381         NV      sv_2nv(SV* sv)
5382
5383 =for hackers
5384 Found in file sv.c
5385
5386 =item sv_2pvbyte
5387 X<sv_2pvbyte>
5388
5389 Return a pointer to the byte-encoded representation of the SV, and set *lp
5390 to its length.  May cause the SV to be downgraded from UTF-8 as a
5391 side-effect.
5392
5393 Usually accessed via the C<SvPVbyte> macro.
5394
5395         char*   sv_2pvbyte(SV* sv, STRLEN* lp)
5396
5397 =for hackers
5398 Found in file sv.c
5399
5400 =item sv_2pvutf8
5401 X<sv_2pvutf8>
5402
5403 Return a pointer to the UTF-8-encoded representation of the SV, and set *lp
5404 to its length.  May cause the SV to be upgraded to UTF-8 as a side-effect.
5405
5406 Usually accessed via the C<SvPVutf8> macro.
5407
5408         char*   sv_2pvutf8(SV* sv, STRLEN* lp)
5409
5410 =for hackers
5411 Found in file sv.c
5412
5413 =item sv_2pv_flags
5414 X<sv_2pv_flags>
5415
5416 Returns a pointer to the string value of an SV, and sets *lp to its length.
5417 If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string
5418 if necessary.
5419 Normally invoked via the C<SvPV_flags> macro. C<sv_2pv()> and C<sv_2pv_nomg>
5420 usually end up here too.
5421
5422         char*   sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)
5423
5424 =for hackers
5425 Found in file sv.c
5426
5427 =item sv_2uv_flags
5428 X<sv_2uv_flags>
5429
5430 Return the unsigned integer value of an SV, doing any necessary string
5431 conversion.  If flags includes SV_GMAGIC, does an mg_get() first.
5432 Normally used via the C<SvUV(sv)> and C<SvUVx(sv)> macros.
5433
5434         UV      sv_2uv_flags(SV* sv, I32 flags)
5435
5436 =for hackers
5437 Found in file sv.c
5438
5439 =item sv_backoff
5440 X<sv_backoff>
5441
5442 Remove any string offset. You should normally use the C<SvOOK_off> macro
5443 wrapper instead.
5444
5445         int     sv_backoff(SV* sv)
5446
5447 =for hackers
5448 Found in file sv.c
5449
5450 =item sv_bless
5451 X<sv_bless>
5452
5453 Blesses an SV into a specified package.  The SV must be an RV.  The package
5454 must be designated by its stash (see C<gv_stashpv()>).  The reference count
5455 of the SV is unaffected.
5456
5457         SV*     sv_bless(SV* sv, HV* stash)
5458
5459 =for hackers
5460 Found in file sv.c
5461
5462 =item sv_catpv
5463 X<sv_catpv>
5464
5465 Concatenates the string onto the end of the string which is in the SV.
5466 If the SV has the UTF-8 status set, then the bytes appended should be
5467 valid UTF-8.  Handles 'get' magic, but not 'set' magic.  See C<sv_catpv_mg>.
5468
5469         void    sv_catpv(SV* sv, const char* ptr)
5470
5471 =for hackers
5472 Found in file sv.c
5473
5474 =item sv_catpvf
5475 X<sv_catpvf>
5476
5477 Processes its arguments like C<sprintf> and appends the formatted
5478 output to an SV.  If the appended data contains "wide" characters
5479 (including, but not limited to, SVs with a UTF-8 PV formatted&n