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