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