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