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