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