This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Re: perl@9359 breaks HTML::Parser
[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 bytes_from_utf8
186
187 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
188 Unlike <utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
189 the newly-created string, and updates C<len> to contain the new
190 length.  Returns the original string if no conversion occurs, C<len>
191 is unchanged. Do nothing if C<is_utf8> points to 0. Sets C<is_utf8> to
192 0 if C<s> is converted or contains all 7bit characters.
193
194 NOTE: this function is experimental and may change or be
195 removed without notice.
196
197         U8*     bytes_from_utf8(U8 *s, STRLEN *len, bool *is_utf8)
198
199 =for hackers
200 Found in file utf8.c
201
202 =item bytes_to_utf8
203
204 Converts a string C<s> of length C<len> from ASCII into UTF8 encoding.
205 Returns a pointer to the newly-created string, and sets C<len> to
206 reflect the new length.
207
208 NOTE: this function is experimental and may change or be
209 removed without notice.
210
211         U8*     bytes_to_utf8(U8 *s, STRLEN *len)
212
213 =for hackers
214 Found in file utf8.c
215
216 =item call_argv
217
218 Performs a callback to the specified Perl sub.  See L<perlcall>.
219
220 NOTE: the perl_ form of this function is deprecated.
221
222         I32     call_argv(const char* sub_name, I32 flags, char** argv)
223
224 =for hackers
225 Found in file perl.c
226
227 =item call_method
228
229 Performs a callback to the specified Perl method.  The blessed object must
230 be on the stack.  See L<perlcall>.
231
232 NOTE: the perl_ form of this function is deprecated.
233
234         I32     call_method(const char* methname, I32 flags)
235
236 =for hackers
237 Found in file perl.c
238
239 =item call_pv
240
241 Performs a callback to the specified Perl sub.  See L<perlcall>.
242
243 NOTE: the perl_ form of this function is deprecated.
244
245         I32     call_pv(const char* sub_name, I32 flags)
246
247 =for hackers
248 Found in file perl.c
249
250 =item call_sv
251
252 Performs a callback to the Perl sub whose name is in the SV.  See
253 L<perlcall>.
254
255 NOTE: the perl_ form of this function is deprecated.
256
257         I32     call_sv(SV* sv, I32 flags)
258
259 =for hackers
260 Found in file perl.c
261
262 =item CLASS
263
264 Variable which is setup by C<xsubpp> to indicate the 
265 class name for a C++ XS constructor.  This is always a C<char*>.  See C<THIS>.
266
267         char*   CLASS
268
269 =for hackers
270 Found in file XSUB.h
271
272 =item Copy
273
274 The XSUB-writer's interface to the C C<memcpy> function.  The C<src> is the
275 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
276 the type.  May fail on overlapping copies.  See also C<Move>.
277
278         void    Copy(void* src, void* dest, int nitems, type)
279
280 =for hackers
281 Found in file handy.h
282
283 =item croak
284
285 This is the XSUB-writer's interface to Perl's C<die> function.
286 Normally use this function the same way you use the C C<printf>
287 function.  See C<warn>.
288
289 If you want to throw an exception object, assign the object to
290 C<$@> and then pass C<Nullch> to croak():
291
292    errsv = get_sv("@", TRUE);
293    sv_setsv(errsv, exception_object);
294    croak(Nullch);
295
296         void    croak(const char* pat, ...)
297
298 =for hackers
299 Found in file util.c
300
301 =item CvSTASH
302
303 Returns the stash of the CV.
304
305         HV*     CvSTASH(CV* cv)
306
307 =for hackers
308 Found in file cv.h
309
310 =item cv_const_sv
311
312 If C<cv> is a constant sub eligible for inlining. returns the constant
313 value returned by the sub.  Otherwise, returns NULL.
314
315 Constant subs can be created with C<newCONSTSUB> or as described in
316 L<perlsub/"Constant Functions">.
317
318         SV*     cv_const_sv(CV* cv)
319
320 =for hackers
321 Found in file op.c
322
323 =item dMARK
324
325 Declare a stack marker variable, C<mark>, for the XSUB.  See C<MARK> and
326 C<dORIGMARK>.
327
328                 dMARK;
329
330 =for hackers
331 Found in file pp.h
332
333 =item dORIGMARK
334
335 Saves the original stack mark for the XSUB.  See C<ORIGMARK>.
336
337                 dORIGMARK;
338
339 =for hackers
340 Found in file pp.h
341
342 =item dSP
343
344 Declares a local copy of perl's stack pointer for the XSUB, available via
345 the C<SP> macro.  See C<SP>.
346
347                 dSP;
348
349 =for hackers
350 Found in file pp.h
351
352 =item dXSARGS
353
354 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.  This
355 is usually handled automatically by C<xsubpp>.  Declares the C<items>
356 variable to indicate the number of items on the stack.
357
358                 dXSARGS;
359
360 =for hackers
361 Found in file XSUB.h
362
363 =item dXSI32
364
365 Sets up the C<ix> variable for an XSUB which has aliases.  This is usually
366 handled automatically by C<xsubpp>.
367
368                 dXSI32;
369
370 =for hackers
371 Found in file XSUB.h
372
373 =item ENTER
374
375 Opening bracket on a callback.  See C<LEAVE> and L<perlcall>.
376
377                 ENTER;
378
379 =for hackers
380 Found in file scope.h
381
382 =item eval_pv
383
384 Tells Perl to C<eval> the given string and return an SV* result.
385
386 NOTE: the perl_ form of this function is deprecated.
387
388         SV*     eval_pv(const char* p, I32 croak_on_error)
389
390 =for hackers
391 Found in file perl.c
392
393 =item eval_sv
394
395 Tells Perl to C<eval> the string in the SV.
396
397 NOTE: the perl_ form of this function is deprecated.
398
399         I32     eval_sv(SV* sv, I32 flags)
400
401 =for hackers
402 Found in file perl.c
403
404 =item EXTEND
405
406 Used to extend the argument stack for an XSUB's return values. Once
407 used, guarantees that there is room for at least C<nitems> to be pushed
408 onto the stack.
409
410         void    EXTEND(SP, int nitems)
411
412 =for hackers
413 Found in file pp.h
414
415 =item fbm_compile
416
417 Analyses the string in order to make fast searches on it using fbm_instr()
418 -- the Boyer-Moore algorithm.
419
420         void    fbm_compile(SV* sv, U32 flags)
421
422 =for hackers
423 Found in file util.c
424
425 =item fbm_instr
426
427 Returns the location of the SV in the string delimited by C<str> and
428 C<strend>.  It returns C<Nullch> if the string can't be found.  The C<sv>
429 does not have to be fbm_compiled, but the search will not be as fast
430 then.
431
432         char*   fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlesv, U32 flags)
433
434 =for hackers
435 Found in file util.c
436
437 =item FREETMPS
438
439 Closing bracket for temporaries on a callback.  See C<SAVETMPS> and
440 L<perlcall>.
441
442                 FREETMPS;
443
444 =for hackers
445 Found in file scope.h
446
447 =item get_av
448
449 Returns the AV of the specified Perl array.  If C<create> is set and the
450 Perl variable does not exist then it will be created.  If C<create> is not
451 set and the variable does not exist then NULL is returned.
452
453 NOTE: the perl_ form of this function is deprecated.
454
455         AV*     get_av(const char* name, I32 create)
456
457 =for hackers
458 Found in file perl.c
459
460 =item get_cv
461
462 Returns the CV of the specified Perl subroutine.  If C<create> is set and
463 the Perl subroutine does not exist then it will be declared (which has the
464 same effect as saying C<sub name;>).  If C<create> is not set and the
465 subroutine does not exist then NULL is returned.
466
467 NOTE: the perl_ form of this function is deprecated.
468
469         CV*     get_cv(const char* name, I32 create)
470
471 =for hackers
472 Found in file perl.c
473
474 =item get_hv
475
476 Returns the HV of the specified Perl hash.  If C<create> is set and the
477 Perl variable does not exist then it will be created.  If C<create> is not
478 set and the variable does not exist then NULL is returned.
479
480 NOTE: the perl_ form of this function is deprecated.
481
482         HV*     get_hv(const char* name, I32 create)
483
484 =for hackers
485 Found in file perl.c
486
487 =item get_sv
488
489 Returns the SV of the specified Perl scalar.  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         SV*     get_sv(const char* name, I32 create)
496
497 =for hackers
498 Found in file perl.c
499
500 =item GIMME
501
502 A backward-compatible version of C<GIMME_V> which can only return
503 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
504 Deprecated.  Use C<GIMME_V> instead.
505
506         U32     GIMME
507
508 =for hackers
509 Found in file op.h
510
511 =item GIMME_V
512
513 The XSUB-writer's equivalent to Perl's C<wantarray>.  Returns C<G_VOID>,
514 C<G_SCALAR> or C<G_ARRAY> for void, scalar or list context,
515 respectively.
516
517         U32     GIMME_V
518
519 =for hackers
520 Found in file op.h
521
522 =item GvSV
523
524 Return the SV from the GV.
525
526         SV*     GvSV(GV* gv)
527
528 =for hackers
529 Found in file gv.h
530
531 =item gv_fetchmeth
532
533 Returns the glob with the given C<name> and a defined subroutine or
534 C<NULL>.  The glob lives in the given C<stash>, or in the stashes
535 accessible via @ISA and @UNIVERSAL.
536
537 The argument C<level> should be either 0 or -1.  If C<level==0>, as a
538 side-effect creates a glob with the given C<name> in the given C<stash>
539 which in the case of success contains an alias for the subroutine, and sets
540 up caching info for this glob.  Similarly for all the searched stashes.
541
542 This function grants C<"SUPER"> token as a postfix of the stash name. The
543 GV returned from C<gv_fetchmeth> may be a method cache entry, which is not
544 visible to Perl code.  So when calling C<call_sv>, you should not use
545 the GV directly; instead, you should use the method's CV, which can be
546 obtained from the GV with the C<GvCV> macro.
547
548         GV*     gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)
549
550 =for hackers
551 Found in file gv.c
552
553 =item gv_fetchmethod
554
555 See L<gv_fetchmethod_autoload>.
556
557         GV*     gv_fetchmethod(HV* stash, const char* name)
558
559 =for hackers
560 Found in file gv.c
561
562 =item gv_fetchmethod_autoload
563
564 Returns the glob which contains the subroutine to call to invoke the method
565 on the C<stash>.  In fact in the presence of autoloading this may be the
566 glob for "AUTOLOAD".  In this case the corresponding variable $AUTOLOAD is
567 already setup.
568
569 The third parameter of C<gv_fetchmethod_autoload> determines whether
570 AUTOLOAD lookup is performed if the given method is not present: non-zero
571 means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.
572 Calling C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload>
573 with a non-zero C<autoload> parameter.
574
575 These functions grant C<"SUPER"> token as a prefix of the method name. Note
576 that if you want to keep the returned glob for a long time, you need to
577 check for it being "AUTOLOAD", since at the later time the call may load a
578 different subroutine due to $AUTOLOAD changing its value. Use the glob
579 created via a side effect to do this.
580
581 These functions have the same side-effects and as C<gv_fetchmeth> with
582 C<level==0>.  C<name> should be writable if contains C<':'> or C<'
583 ''>. The warning against passing the GV returned by C<gv_fetchmeth> to
584 C<call_sv> apply equally to these functions.
585
586         GV*     gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)
587
588 =for hackers
589 Found in file gv.c
590
591 =item gv_stashpv
592
593 Returns a pointer to the stash for a specified package.  C<name> should
594 be a valid UTF-8 string.  If C<create> is set then the package will be
595 created if it does not already exist.  If C<create> is not set and the
596 package does not exist then NULL is returned.
597
598         HV*     gv_stashpv(const char* name, I32 create)
599
600 =for hackers
601 Found in file gv.c
602
603 =item gv_stashsv
604
605 Returns a pointer to the stash for a specified package, which must be a
606 valid UTF-8 string.  See C<gv_stashpv>.
607
608         HV*     gv_stashsv(SV* sv, I32 create)
609
610 =for hackers
611 Found in file gv.c
612
613 =item G_ARRAY
614
615 Used to indicate list context.  See C<GIMME_V>, C<GIMME> and
616 L<perlcall>.
617
618 =for hackers
619 Found in file cop.h
620
621 =item G_DISCARD
622
623 Indicates that arguments returned from a callback should be discarded.  See
624 L<perlcall>.
625
626 =for hackers
627 Found in file cop.h
628
629 =item G_EVAL
630
631 Used to force a Perl C<eval> wrapper around a callback.  See
632 L<perlcall>.
633
634 =for hackers
635 Found in file cop.h
636
637 =item G_NOARGS
638
639 Indicates that no arguments are being sent to a callback.  See
640 L<perlcall>.
641
642 =for hackers
643 Found in file cop.h
644
645 =item G_SCALAR
646
647 Used to indicate scalar context.  See C<GIMME_V>, C<GIMME>, and
648 L<perlcall>.
649
650 =for hackers
651 Found in file cop.h
652
653 =item G_VOID
654
655 Used to indicate void context.  See C<GIMME_V> and L<perlcall>.
656
657 =for hackers
658 Found in file cop.h
659
660 =item HEf_SVKEY
661
662 This flag, used in the length slot of hash entries and magic structures,
663 specifies the structure contains a C<SV*> pointer where a C<char*> pointer
664 is to be expected. (For information only--not to be used).
665
666 =for hackers
667 Found in file hv.h
668
669 =item HeHASH
670
671 Returns the computed hash stored in the hash entry.
672
673         U32     HeHASH(HE* he)
674
675 =for hackers
676 Found in file hv.h
677
678 =item HeKEY
679
680 Returns the actual pointer stored in the key slot of the hash entry. The
681 pointer may be either C<char*> or C<SV*>, depending on the value of
682 C<HeKLEN()>.  Can be assigned to.  The C<HePV()> or C<HeSVKEY()> macros are
683 usually preferable for finding the value of a key.
684
685         void*   HeKEY(HE* he)
686
687 =for hackers
688 Found in file hv.h
689
690 =item HeKLEN
691
692 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
693 holds an C<SV*> key.  Otherwise, holds the actual length of the key.  Can
694 be assigned to. The C<HePV()> macro is usually preferable for finding key
695 lengths.
696
697         STRLEN  HeKLEN(HE* he)
698
699 =for hackers
700 Found in file hv.h
701
702 =item HePV
703
704 Returns the key slot of the hash entry as a C<char*> value, doing any
705 necessary dereferencing of possibly C<SV*> keys.  The length of the string
706 is placed in C<len> (this is a macro, so do I<not> use C<&len>).  If you do
707 not care about what the length of the key is, you may use the global
708 variable C<PL_na>, though this is rather less efficient than using a local
709 variable.  Remember though, that hash keys in perl are free to contain
710 embedded nulls, so using C<strlen()> or similar is not a good way to find
711 the length of hash keys. This is very similar to the C<SvPV()> macro
712 described elsewhere in this document.
713
714         char*   HePV(HE* he, STRLEN len)
715
716 =for hackers
717 Found in file hv.h
718
719 =item HeSVKEY
720
721 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
722 contain an C<SV*> key.
723
724         SV*     HeSVKEY(HE* he)
725
726 =for hackers
727 Found in file hv.h
728
729 =item HeSVKEY_force
730
731 Returns the key as an C<SV*>.  Will create and return a temporary mortal
732 C<SV*> if the hash entry contains only a C<char*> key.
733
734         SV*     HeSVKEY_force(HE* he)
735
736 =for hackers
737 Found in file hv.h
738
739 =item HeSVKEY_set
740
741 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
742 indicate the presence of an C<SV*> key, and returns the same
743 C<SV*>.
744
745         SV*     HeSVKEY_set(HE* he, SV* sv)
746
747 =for hackers
748 Found in file hv.h
749
750 =item HeVAL
751
752 Returns the value slot (type C<SV*>) stored in the hash entry.
753
754         SV*     HeVAL(HE* he)
755
756 =for hackers
757 Found in file hv.h
758
759 =item HvNAME
760
761 Returns the package name of a stash.  See C<SvSTASH>, C<CvSTASH>.
762
763         char*   HvNAME(HV* stash)
764
765 =for hackers
766 Found in file hv.h
767
768 =item hv_clear
769
770 Clears a hash, making it empty.
771
772         void    hv_clear(HV* tb)
773
774 =for hackers
775 Found in file hv.c
776
777 =item hv_delete
778
779 Deletes a key/value pair in the hash.  The value SV is removed from the
780 hash and returned to the caller.  The C<klen> is the length of the key.
781 The C<flags> value will normally be zero; if set to G_DISCARD then NULL
782 will be returned.
783
784         SV*     hv_delete(HV* tb, const char* key, I32 klen, I32 flags)
785
786 =for hackers
787 Found in file hv.c
788
789 =item hv_delete_ent
790
791 Deletes a key/value pair in the hash.  The value SV is removed from the
792 hash and returned to the caller.  The C<flags> value will normally be zero;
793 if set to G_DISCARD then NULL will be returned.  C<hash> can be a valid
794 precomputed hash value, or 0 to ask for it to be computed.
795
796         SV*     hv_delete_ent(HV* tb, SV* key, I32 flags, U32 hash)
797
798 =for hackers
799 Found in file hv.c
800
801 =item hv_exists
802
803 Returns a boolean indicating whether the specified hash key exists.  The
804 C<klen> is the length of the key.
805
806         bool    hv_exists(HV* tb, const char* key, I32 klen)
807
808 =for hackers
809 Found in file hv.c
810
811 =item hv_exists_ent
812
813 Returns a boolean indicating whether the specified hash key exists. C<hash>
814 can be a valid precomputed hash value, or 0 to ask for it to be
815 computed.
816
817         bool    hv_exists_ent(HV* tb, SV* key, U32 hash)
818
819 =for hackers
820 Found in file hv.c
821
822 =item hv_fetch
823
824 Returns the SV which corresponds to the specified key in the hash.  The
825 C<klen> is the length of the key.  If C<lval> is set then the fetch will be
826 part of a store.  Check that the return value is non-null before
827 dereferencing it to a C<SV*>.
828
829 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
830 information on how to use this function on tied hashes.
831
832         SV**    hv_fetch(HV* tb, const char* key, I32 klen, I32 lval)
833
834 =for hackers
835 Found in file hv.c
836
837 =item hv_fetch_ent
838
839 Returns the hash entry which corresponds to the specified key in the hash.
840 C<hash> must be a valid precomputed hash number for the given C<key>, or 0
841 if you want the function to compute it.  IF C<lval> is set then the fetch
842 will be part of a store.  Make sure the return value is non-null before
843 accessing it.  The return value when C<tb> is a tied hash is a pointer to a
844 static location, so be sure to make a copy of the structure if you need to
845 store it somewhere.
846
847 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
848 information on how to use this function on tied hashes.
849
850         HE*     hv_fetch_ent(HV* tb, SV* key, I32 lval, U32 hash)
851
852 =for hackers
853 Found in file hv.c
854
855 =item hv_iterinit
856
857 Prepares a starting point to traverse a hash table.  Returns the number of
858 keys in the hash (i.e. the same as C<HvKEYS(tb)>).  The return value is
859 currently only meaningful for hashes without tie magic.
860
861 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number of
862 hash buckets that happen to be in use.  If you still need that esoteric
863 value, you can get it through the macro C<HvFILL(tb)>.
864
865         I32     hv_iterinit(HV* tb)
866
867 =for hackers
868 Found in file hv.c
869
870 =item hv_iterkey
871
872 Returns the key from the current position of the hash iterator.  See
873 C<hv_iterinit>.
874
875         char*   hv_iterkey(HE* entry, I32* retlen)
876
877 =for hackers
878 Found in file hv.c
879
880 =item hv_iterkeysv
881
882 Returns the key as an C<SV*> from the current position of the hash
883 iterator.  The return value will always be a mortal copy of the key.  Also
884 see C<hv_iterinit>.
885
886         SV*     hv_iterkeysv(HE* entry)
887
888 =for hackers
889 Found in file hv.c
890
891 =item hv_iternext
892
893 Returns entries from a hash iterator.  See C<hv_iterinit>.
894
895         HE*     hv_iternext(HV* tb)
896
897 =for hackers
898 Found in file hv.c
899
900 =item hv_iternextsv
901
902 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
903 operation.
904
905         SV*     hv_iternextsv(HV* hv, char** key, I32* retlen)
906
907 =for hackers
908 Found in file hv.c
909
910 =item hv_iterval
911
912 Returns the value from the current position of the hash iterator.  See
913 C<hv_iterkey>.
914
915         SV*     hv_iterval(HV* tb, HE* entry)
916
917 =for hackers
918 Found in file hv.c
919
920 =item hv_magic
921
922 Adds magic to a hash.  See C<sv_magic>.
923
924         void    hv_magic(HV* hv, GV* gv, int how)
925
926 =for hackers
927 Found in file hv.c
928
929 =item hv_store
930
931 Stores an SV in a hash.  The hash key is specified as C<key> and C<klen> is
932 the length of the key.  The C<hash> parameter is the precomputed hash
933 value; if it is zero then Perl will compute it.  The return value will be
934 NULL if the operation failed or if the value did not need to be actually
935 stored within the hash (as in the case of tied hashes).  Otherwise it can
936 be dereferenced to get the original C<SV*>.  Note that the caller is
937 responsible for suitably incrementing the reference count of C<val> before
938 the call, and decrementing it if the function returned NULL.
939
940 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
941 information on how to use this function on tied hashes.
942
943         SV**    hv_store(HV* tb, const char* key, I32 klen, SV* val, U32 hash)
944
945 =for hackers
946 Found in file hv.c
947
948 =item hv_store_ent
949
950 Stores C<val> in a hash.  The hash key is specified as C<key>.  The C<hash>
951 parameter is the precomputed hash value; if it is zero then Perl will
952 compute it.  The return value is the new hash entry so created.  It will be
953 NULL if the operation failed or if the value did not need to be actually
954 stored within the hash (as in the case of tied hashes).  Otherwise the
955 contents of the return value can be accessed using the C<He???> macros
956 described here.  Note that the caller is responsible for suitably
957 incrementing the reference count of C<val> before the call, and
958 decrementing it if the function returned NULL.
959
960 See L<perlguts/"Understanding the Magic of Tied Hashes and Arrays"> for more
961 information on how to use this function on tied hashes.
962
963         HE*     hv_store_ent(HV* tb, SV* key, SV* val, U32 hash)
964
965 =for hackers
966 Found in file hv.c
967
968 =item hv_undef
969
970 Undefines the hash.
971
972         void    hv_undef(HV* tb)
973
974 =for hackers
975 Found in file hv.c
976
977 =item isALNUM
978
979 Returns a boolean indicating whether the C C<char> is an ASCII alphanumeric
980 character (including underscore) or digit.
981
982         bool    isALNUM(char ch)
983
984 =for hackers
985 Found in file handy.h
986
987 =item isALPHA
988
989 Returns a boolean indicating whether the C C<char> is an ASCII alphabetic
990 character.
991
992         bool    isALPHA(char ch)
993
994 =for hackers
995 Found in file handy.h
996
997 =item isDIGIT
998
999 Returns a boolean indicating whether the C C<char> is an ASCII
1000 digit.
1001
1002         bool    isDIGIT(char ch)
1003
1004 =for hackers
1005 Found in file handy.h
1006
1007 =item isLOWER
1008
1009 Returns a boolean indicating whether the C C<char> is a lowercase
1010 character.
1011
1012         bool    isLOWER(char ch)
1013
1014 =for hackers
1015 Found in file handy.h
1016
1017 =item isSPACE
1018
1019 Returns a boolean indicating whether the C C<char> is whitespace.
1020
1021         bool    isSPACE(char ch)
1022
1023 =for hackers
1024 Found in file handy.h
1025
1026 =item isUPPER
1027
1028 Returns a boolean indicating whether the C C<char> is an uppercase
1029 character.
1030
1031         bool    isUPPER(char ch)
1032
1033 =for hackers
1034 Found in file handy.h
1035
1036 =item is_utf8_char
1037
1038 Tests if some arbitrary number of bytes begins in a valid UTF-8
1039 character.  Note that an INVARIANT (i.e. ASCII) character is a valid UTF-8 character.
1040 The actual number of bytes in the UTF-8 character will be returned if
1041 it is valid, otherwise 0.
1042
1043         STRLEN  is_utf8_char(U8 *p)
1044
1045 =for hackers
1046 Found in file utf8.c
1047
1048 =item is_utf8_string
1049
1050 Returns true if first C<len> bytes of the given string form a valid UTF8
1051 string, false otherwise.  Note that 'a valid UTF8 string' does not mean
1052 'a string that contains UTF8' because a valid ASCII string is a valid
1053 UTF8 string.
1054
1055         bool    is_utf8_string(U8 *s, STRLEN len)
1056
1057 =for hackers
1058 Found in file utf8.c
1059
1060 =item items
1061
1062 Variable which is setup by C<xsubpp> to indicate the number of 
1063 items on the stack.  See L<perlxs/"Variable-length Parameter Lists">.
1064
1065         I32     items
1066
1067 =for hackers
1068 Found in file XSUB.h
1069
1070 =item ix
1071
1072 Variable which is setup by C<xsubpp> to indicate which of an 
1073 XSUB's aliases was used to invoke it.  See L<perlxs/"The ALIAS: Keyword">.
1074
1075         I32     ix
1076
1077 =for hackers
1078 Found in file XSUB.h
1079
1080 =item LEAVE
1081
1082 Closing bracket on a callback.  See C<ENTER> and L<perlcall>.
1083
1084                 LEAVE;
1085
1086 =for hackers
1087 Found in file scope.h
1088
1089 =item looks_like_number
1090
1091 Test if an the content of an SV looks like a number (or is a
1092 number). C<Inf> and C<Infinity> are treated as numbers (so will not
1093 issue a non-numeric warning), even if your atof() doesn't grok them.
1094
1095         I32     looks_like_number(SV* sv)
1096
1097 =for hackers
1098 Found in file sv.c
1099
1100 =item MARK
1101
1102 Stack marker variable for the XSUB.  See C<dMARK>.
1103
1104 =for hackers
1105 Found in file pp.h
1106
1107 =item mg_clear
1108
1109 Clear something magical that the SV represents.  See C<sv_magic>.
1110
1111         int     mg_clear(SV* sv)
1112
1113 =for hackers
1114 Found in file mg.c
1115
1116 =item mg_copy
1117
1118 Copies the magic from one SV to another.  See C<sv_magic>.
1119
1120         int     mg_copy(SV* sv, SV* nsv, const char* key, I32 klen)
1121
1122 =for hackers
1123 Found in file mg.c
1124
1125 =item mg_find
1126
1127 Finds the magic pointer for type matching the SV.  See C<sv_magic>.
1128
1129         MAGIC*  mg_find(SV* sv, int type)
1130
1131 =for hackers
1132 Found in file mg.c
1133
1134 =item mg_free
1135
1136 Free any magic storage used by the SV.  See C<sv_magic>.
1137
1138         int     mg_free(SV* sv)
1139
1140 =for hackers
1141 Found in file mg.c
1142
1143 =item mg_get
1144
1145 Do magic after a value is retrieved from the SV.  See C<sv_magic>.
1146
1147         int     mg_get(SV* sv)
1148
1149 =for hackers
1150 Found in file mg.c
1151
1152 =item mg_length
1153
1154 Report on the SV's length.  See C<sv_magic>.
1155
1156         U32     mg_length(SV* sv)
1157
1158 =for hackers
1159 Found in file mg.c
1160
1161 =item mg_magical
1162
1163 Turns on the magical status of an SV.  See C<sv_magic>.
1164
1165         void    mg_magical(SV* sv)
1166
1167 =for hackers
1168 Found in file mg.c
1169
1170 =item mg_set
1171
1172 Do magic after a value is assigned to the SV.  See C<sv_magic>.
1173
1174         int     mg_set(SV* sv)
1175
1176 =for hackers
1177 Found in file mg.c
1178
1179 =item Move
1180
1181 The XSUB-writer's interface to the C C<memmove> function.  The C<src> is the
1182 source, C<dest> is the destination, C<nitems> is the number of items, and C<type> is
1183 the type.  Can do overlapping moves.  See also C<Copy>.
1184
1185         void    Move(void* src, void* dest, int nitems, type)
1186
1187 =for hackers
1188 Found in file handy.h
1189
1190 =item New
1191
1192 The XSUB-writer's interface to the C C<malloc> function.
1193
1194         void    New(int id, void* ptr, int nitems, type)
1195
1196 =for hackers
1197 Found in file handy.h
1198
1199 =item newAV
1200
1201 Creates a new AV.  The reference count is set to 1.
1202
1203         AV*     newAV()
1204
1205 =for hackers
1206 Found in file av.c
1207
1208 =item Newc
1209
1210 The XSUB-writer's interface to the C C<malloc> function, with
1211 cast.
1212
1213         void    Newc(int id, void* ptr, int nitems, type, cast)
1214
1215 =for hackers
1216 Found in file handy.h
1217
1218 =item newCONSTSUB
1219
1220 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }> which is
1221 eligible for inlining at compile-time.
1222
1223         CV*     newCONSTSUB(HV* stash, char* name, SV* sv)
1224
1225 =for hackers
1226 Found in file op.c
1227
1228 =item newHV
1229
1230 Creates a new HV.  The reference count is set to 1.
1231
1232         HV*     newHV()
1233
1234 =for hackers
1235 Found in file hv.c
1236
1237 =item newRV_inc
1238
1239 Creates an RV wrapper for an SV.  The reference count for the original SV is
1240 incremented.
1241
1242         SV*     newRV_inc(SV* sv)
1243
1244 =for hackers
1245 Found in file sv.h
1246
1247 =item newRV_noinc
1248
1249 Creates an RV wrapper for an SV.  The reference count for the original
1250 SV is B<not> incremented.
1251
1252         SV*     newRV_noinc(SV *sv)
1253
1254 =for hackers
1255 Found in file sv.c
1256
1257 =item NEWSV
1258
1259 Creates a new SV.  A non-zero C<len> parameter indicates the number of
1260 bytes of preallocated string space the SV should have.  An extra byte for a
1261 tailing NUL is also reserved.  (SvPOK is not set for the SV even if string
1262 space is allocated.)  The reference count for the new SV is set to 1.
1263 C<id> is an integer id between 0 and 1299 (used to identify leaks).
1264
1265         SV*     NEWSV(int id, STRLEN len)
1266
1267 =for hackers
1268 Found in file handy.h
1269
1270 =item newSViv
1271
1272 Creates a new SV and copies an integer into it.  The reference count for the
1273 SV is set to 1.
1274
1275         SV*     newSViv(IV i)
1276
1277 =for hackers
1278 Found in file sv.c
1279
1280 =item newSVnv
1281
1282 Creates a new SV and copies a floating point value into it.
1283 The reference count for the SV is set to 1.
1284
1285         SV*     newSVnv(NV n)
1286
1287 =for hackers
1288 Found in file sv.c
1289
1290 =item newSVpv
1291
1292 Creates a new SV and copies a string into it.  The reference count for the
1293 SV is set to 1.  If C<len> is zero, Perl will compute the length using
1294 strlen().  For efficiency, consider using C<newSVpvn> instead.
1295
1296         SV*     newSVpv(const char* s, STRLEN len)
1297
1298 =for hackers
1299 Found in file sv.c
1300
1301 =item newSVpvf
1302
1303 Creates a new SV an initialize it with the string formatted like
1304 C<sprintf>.
1305
1306         SV*     newSVpvf(const char* pat, ...)
1307
1308 =for hackers
1309 Found in file sv.c
1310
1311 =item newSVpvn
1312
1313 Creates a new SV and copies a string into it.  The reference count for the
1314 SV is set to 1.  Note that if C<len> is zero, Perl will create a zero length
1315 string.  You are responsible for ensuring that the source string is at least
1316 C<len> bytes long.
1317
1318         SV*     newSVpvn(const char* s, STRLEN len)
1319
1320 =for hackers
1321 Found in file sv.c
1322
1323 =item newSVpvn_share
1324
1325 Creates a new SV and populates it with a string from
1326 the string table. Turns on READONLY and FAKE.
1327 The idea here is that as string table is used for shared hash
1328 keys these strings will have SvPVX == HeKEY and hash lookup
1329 will avoid string compare.
1330
1331         SV*     newSVpvn_share(const char* s, I32 len, U32 hash)
1332
1333 =for hackers
1334 Found in file sv.c
1335
1336 =item newSVrv
1337
1338 Creates a new SV for the RV, C<rv>, to point to.  If C<rv> is not an RV then
1339 it will be upgraded to one.  If C<classname> is non-null then the new SV will
1340 be blessed in the specified package.  The new SV is returned and its
1341 reference count is 1.
1342
1343         SV*     newSVrv(SV* rv, const char* classname)
1344
1345 =for hackers
1346 Found in file sv.c
1347
1348 =item newSVsv
1349
1350 Creates a new SV which is an exact duplicate of the original SV.
1351
1352         SV*     newSVsv(SV* old)
1353
1354 =for hackers
1355 Found in file sv.c
1356
1357 =item newSVuv
1358
1359 Creates a new SV and copies an unsigned integer into it.
1360 The reference count for the SV is set to 1.
1361
1362         SV*     newSVuv(UV u)
1363
1364 =for hackers
1365 Found in file sv.c
1366
1367 =item newXS
1368
1369 Used by C<xsubpp> to hook up XSUBs as Perl subs.
1370
1371 =for hackers
1372 Found in file op.c
1373
1374 =item newXSproto
1375
1376 Used by C<xsubpp> to hook up XSUBs as Perl subs.  Adds Perl prototypes to
1377 the subs.
1378
1379 =for hackers
1380 Found in file XSUB.h
1381
1382 =item Newz
1383
1384 The XSUB-writer's interface to the C C<malloc> function.  The allocated
1385 memory is zeroed with C<memzero>.
1386
1387         void    Newz(int id, void* ptr, int nitems, type)
1388
1389 =for hackers
1390 Found in file handy.h
1391
1392 =item Nullav
1393
1394 Null AV pointer.
1395
1396 =for hackers
1397 Found in file av.h
1398
1399 =item Nullch
1400
1401 Null character pointer.
1402
1403 =for hackers
1404 Found in file handy.h
1405
1406 =item Nullcv
1407
1408 Null CV pointer.
1409
1410 =for hackers
1411 Found in file cv.h
1412
1413 =item Nullhv
1414
1415 Null HV pointer.
1416
1417 =for hackers
1418 Found in file hv.h
1419
1420 =item Nullsv
1421
1422 Null SV pointer.
1423
1424 =for hackers
1425 Found in file handy.h
1426
1427 =item ORIGMARK
1428
1429 The original stack mark for the XSUB.  See C<dORIGMARK>.
1430
1431 =for hackers
1432 Found in file pp.h
1433
1434 =item perl_alloc
1435
1436 Allocates a new Perl interpreter.  See L<perlembed>.
1437
1438         PerlInterpreter*        perl_alloc()
1439
1440 =for hackers
1441 Found in file perl.c
1442
1443 =item perl_construct
1444
1445 Initializes a new Perl interpreter.  See L<perlembed>.
1446
1447         void    perl_construct(PerlInterpreter* interp)
1448
1449 =for hackers
1450 Found in file perl.c
1451
1452 =item perl_destruct
1453
1454 Shuts down a Perl interpreter.  See L<perlembed>.
1455
1456         void    perl_destruct(PerlInterpreter* interp)
1457
1458 =for hackers
1459 Found in file perl.c
1460
1461 =item perl_free
1462
1463 Releases a Perl interpreter.  See L<perlembed>.
1464
1465         void    perl_free(PerlInterpreter* interp)
1466
1467 =for hackers
1468 Found in file perl.c
1469
1470 =item perl_parse
1471
1472 Tells a Perl interpreter to parse a Perl script.  See L<perlembed>.
1473
1474         int     perl_parse(PerlInterpreter* interp, XSINIT_t xsinit, int argc, char** argv, char** env)
1475
1476 =for hackers
1477 Found in file perl.c
1478
1479 =item perl_run
1480
1481 Tells a Perl interpreter to run.  See L<perlembed>.
1482
1483         int     perl_run(PerlInterpreter* interp)
1484
1485 =for hackers
1486 Found in file perl.c
1487
1488 =item PL_modglobal
1489
1490 C<PL_modglobal> is a general purpose, interpreter global HV for use by
1491 extensions that need to keep information on a per-interpreter basis.
1492 In a pinch, it can also be used as a symbol table for extensions
1493 to share data among each other.  It is a good idea to use keys
1494 prefixed by the package name of the extension that owns the data.
1495
1496         HV*     PL_modglobal
1497
1498 =for hackers
1499 Found in file intrpvar.h
1500
1501 =item PL_na
1502
1503 A convenience variable which is typically used with C<SvPV> when one
1504 doesn't care about the length of the string.  It is usually more efficient
1505 to either declare a local variable and use that instead or to use the
1506 C<SvPV_nolen> macro.
1507
1508         STRLEN  PL_na
1509
1510 =for hackers
1511 Found in file thrdvar.h
1512
1513 =item PL_sv_no
1514
1515 This is the C<false> SV.  See C<PL_sv_yes>.  Always refer to this as
1516 C<&PL_sv_no>.
1517
1518         SV      PL_sv_no
1519
1520 =for hackers
1521 Found in file intrpvar.h
1522
1523 =item PL_sv_undef
1524
1525 This is the C<undef> SV.  Always refer to this as C<&PL_sv_undef>.
1526
1527         SV      PL_sv_undef
1528
1529 =for hackers
1530 Found in file intrpvar.h
1531
1532 =item PL_sv_yes
1533
1534 This is the C<true> SV.  See C<PL_sv_no>.  Always refer to this as
1535 C<&PL_sv_yes>.
1536
1537         SV      PL_sv_yes
1538
1539 =for hackers
1540 Found in file intrpvar.h
1541
1542 =item POPi
1543
1544 Pops an integer off the stack.
1545
1546         IV      POPi
1547
1548 =for hackers
1549 Found in file pp.h
1550
1551 =item POPl
1552
1553 Pops a long off the stack.
1554
1555         long    POPl
1556
1557 =for hackers
1558 Found in file pp.h
1559
1560 =item POPn
1561
1562 Pops a double off the stack.
1563
1564         NV      POPn
1565
1566 =for hackers
1567 Found in file pp.h
1568
1569 =item POPp
1570
1571 Pops a string off the stack. Deprecated. New code should provide
1572 a STRLEN n_a and use POPpx.
1573
1574         char*   POPp
1575
1576 =for hackers
1577 Found in file pp.h
1578
1579 =item POPpbytex
1580
1581 Pops a string off the stack which must consist of bytes i.e. characters < 256.
1582 Requires a variable STRLEN n_a in scope.
1583
1584         char*   POPpbytex
1585
1586 =for hackers
1587 Found in file pp.h
1588
1589 =item POPpx
1590
1591 Pops a string off the stack.
1592 Requires a variable STRLEN n_a in scope.
1593
1594         char*   POPpx
1595
1596 =for hackers
1597 Found in file pp.h
1598
1599 =item POPs
1600
1601 Pops an SV off the stack.
1602
1603         SV*     POPs
1604
1605 =for hackers
1606 Found in file pp.h
1607
1608 =item PUSHi
1609
1610 Push an integer onto the stack.  The stack must have room for this element.
1611 Handles 'set' magic.  See C<XPUSHi>.
1612
1613         void    PUSHi(IV iv)
1614
1615 =for hackers
1616 Found in file pp.h
1617
1618 =item PUSHMARK
1619
1620 Opening bracket for arguments on a callback.  See C<PUTBACK> and
1621 L<perlcall>.
1622
1623                 PUSHMARK;
1624
1625 =for hackers
1626 Found in file pp.h
1627
1628 =item PUSHn
1629
1630 Push a double onto the stack.  The stack must have room for this element.
1631 Handles 'set' magic.  See C<XPUSHn>.
1632
1633         void    PUSHn(NV nv)
1634
1635 =for hackers
1636 Found in file pp.h
1637
1638 =item PUSHp
1639
1640 Push a string onto the stack.  The stack must have room for this element.
1641 The C<len> indicates the length of the string.  Handles 'set' magic.  See
1642 C<XPUSHp>.
1643
1644         void    PUSHp(char* str, STRLEN len)
1645
1646 =for hackers
1647 Found in file pp.h
1648
1649 =item PUSHs
1650
1651 Push an SV onto the stack.  The stack must have room for this element.
1652 Does not handle 'set' magic.  See C<XPUSHs>.
1653
1654         void    PUSHs(SV* sv)
1655
1656 =for hackers
1657 Found in file pp.h
1658
1659 =item PUSHu
1660
1661 Push an unsigned integer onto the stack.  The stack must have room for this
1662 element.  See C<XPUSHu>.
1663
1664         void    PUSHu(UV uv)
1665
1666 =for hackers
1667 Found in file pp.h
1668
1669 =item PUTBACK
1670
1671 Closing bracket for XSUB arguments.  This is usually handled by C<xsubpp>.
1672 See C<PUSHMARK> and L<perlcall> for other uses.
1673
1674                 PUTBACK;
1675
1676 =for hackers
1677 Found in file pp.h
1678
1679 =item Renew
1680
1681 The XSUB-writer's interface to the C C<realloc> function.
1682
1683         void    Renew(void* ptr, int nitems, type)
1684
1685 =for hackers
1686 Found in file handy.h
1687
1688 =item Renewc
1689
1690 The XSUB-writer's interface to the C C<realloc> function, with
1691 cast.
1692
1693         void    Renewc(void* ptr, int nitems, type, cast)
1694
1695 =for hackers
1696 Found in file handy.h
1697
1698 =item require_pv
1699
1700 Tells Perl to C<require> a module.
1701
1702 NOTE: the perl_ form of this function is deprecated.
1703
1704         void    require_pv(const char* pv)
1705
1706 =for hackers
1707 Found in file perl.c
1708
1709 =item RETVAL
1710
1711 Variable which is setup by C<xsubpp> to hold the return value for an 
1712 XSUB. This is always the proper type for the XSUB. See 
1713 L<perlxs/"The RETVAL Variable">.
1714
1715         (whatever)      RETVAL
1716
1717 =for hackers
1718 Found in file XSUB.h
1719
1720 =item Safefree
1721
1722 The XSUB-writer's interface to the C C<free> function.
1723
1724         void    Safefree(void* ptr)
1725
1726 =for hackers
1727 Found in file handy.h
1728
1729 =item savepv
1730
1731 Copy a string to a safe spot.  This does not use an SV.
1732
1733         char*   savepv(const char* sv)
1734
1735 =for hackers
1736 Found in file util.c
1737
1738 =item savepvn
1739
1740 Copy a string to a safe spot.  The C<len> indicates number of bytes to
1741 copy.  This does not use an SV.
1742
1743         char*   savepvn(const char* sv, I32 len)
1744
1745 =for hackers
1746 Found in file util.c
1747
1748 =item SAVETMPS
1749
1750 Opening bracket for temporaries on a callback.  See C<FREETMPS> and
1751 L<perlcall>.
1752
1753                 SAVETMPS;
1754
1755 =for hackers
1756 Found in file scope.h
1757
1758 =item SP
1759
1760 Stack pointer.  This is usually handled by C<xsubpp>.  See C<dSP> and
1761 C<SPAGAIN>.
1762
1763 =for hackers
1764 Found in file pp.h
1765
1766 =item SPAGAIN
1767
1768 Refetch the stack pointer.  Used after a callback.  See L<perlcall>.
1769
1770                 SPAGAIN;
1771
1772 =for hackers
1773 Found in file pp.h
1774
1775 =item ST
1776
1777 Used to access elements on the XSUB's stack.
1778
1779         SV*     ST(int ix)
1780
1781 =for hackers
1782 Found in file XSUB.h
1783
1784 =item strEQ
1785
1786 Test two strings to see if they are equal.  Returns true or false.
1787
1788         bool    strEQ(char* s1, char* s2)
1789
1790 =for hackers
1791 Found in file handy.h
1792
1793 =item strGE
1794
1795 Test two strings to see if the first, C<s1>, is greater than or equal to
1796 the second, C<s2>.  Returns true or false.
1797
1798         bool    strGE(char* s1, char* s2)
1799
1800 =for hackers
1801 Found in file handy.h
1802
1803 =item strGT
1804
1805 Test two strings to see if the first, C<s1>, is greater than the second,
1806 C<s2>.  Returns true or false.
1807
1808         bool    strGT(char* s1, char* s2)
1809
1810 =for hackers
1811 Found in file handy.h
1812
1813 =item strLE
1814
1815 Test two strings to see if the first, C<s1>, is less than or equal to the
1816 second, C<s2>.  Returns true or false.
1817
1818         bool    strLE(char* s1, char* s2)
1819
1820 =for hackers
1821 Found in file handy.h
1822
1823 =item strLT
1824
1825 Test two strings to see if the first, C<s1>, is less than the second,
1826 C<s2>.  Returns true or false.
1827
1828         bool    strLT(char* s1, char* s2)
1829
1830 =for hackers
1831 Found in file handy.h
1832
1833 =item strNE
1834
1835 Test two strings to see if they are different.  Returns true or
1836 false.
1837
1838         bool    strNE(char* s1, char* s2)
1839
1840 =for hackers
1841 Found in file handy.h
1842
1843 =item strnEQ
1844
1845 Test two strings to see if they are equal.  The C<len> parameter indicates
1846 the number of bytes to compare.  Returns true or false. (A wrapper for
1847 C<strncmp>).
1848
1849         bool    strnEQ(char* s1, char* s2, STRLEN len)
1850
1851 =for hackers
1852 Found in file handy.h
1853
1854 =item strnNE
1855
1856 Test two strings to see if they are different.  The C<len> parameter
1857 indicates the number of bytes to compare.  Returns true or false. (A
1858 wrapper for C<strncmp>).
1859
1860         bool    strnNE(char* s1, char* s2, STRLEN len)
1861
1862 =for hackers
1863 Found in file handy.h
1864
1865 =item StructCopy
1866
1867 This is an architecture-independent macro to copy one structure to another.
1868
1869         void    StructCopy(type src, type dest, type)
1870
1871 =for hackers
1872 Found in file handy.h
1873
1874 =item SvCUR
1875
1876 Returns the length of the string which is in the SV.  See C<SvLEN>.
1877
1878         STRLEN  SvCUR(SV* sv)
1879
1880 =for hackers
1881 Found in file sv.h
1882
1883 =item SvCUR_set
1884
1885 Set the length of the string which is in the SV.  See C<SvCUR>.
1886
1887         void    SvCUR_set(SV* sv, STRLEN len)
1888
1889 =for hackers
1890 Found in file sv.h
1891
1892 =item SvEND
1893
1894 Returns a pointer to the last character in the string which is in the SV.
1895 See C<SvCUR>.  Access the character as *(SvEND(sv)).
1896
1897         char*   SvEND(SV* sv)
1898
1899 =for hackers
1900 Found in file sv.h
1901
1902 =item SvGETMAGIC
1903
1904 Invokes C<mg_get> on an SV if it has 'get' magic.  This macro evaluates its
1905 argument more than once.
1906
1907         void    SvGETMAGIC(SV* sv)
1908
1909 =for hackers
1910 Found in file sv.h
1911
1912 =item SvGROW
1913
1914 Expands the character buffer in the SV so that it has room for the
1915 indicated number of bytes (remember to reserve space for an extra trailing
1916 NUL character).  Calls C<sv_grow> to perform the expansion if necessary. 
1917 Returns a pointer to the character buffer.
1918
1919         void    SvGROW(SV* sv, STRLEN len)
1920
1921 =for hackers
1922 Found in file sv.h
1923
1924 =item SvIOK
1925
1926 Returns a boolean indicating whether the SV contains an integer.
1927
1928         bool    SvIOK(SV* sv)
1929
1930 =for hackers
1931 Found in file sv.h
1932
1933 =item SvIOKp
1934
1935 Returns a boolean indicating whether the SV contains an integer.  Checks
1936 the B<private> setting.  Use C<SvIOK>.
1937
1938         bool    SvIOKp(SV* sv)
1939
1940 =for hackers
1941 Found in file sv.h
1942
1943 =item SvIOK_notUV
1944
1945 Returns a boolean indicating whether the SV contains an signed integer.
1946
1947         void    SvIOK_notUV(SV* sv)
1948
1949 =for hackers
1950 Found in file sv.h
1951
1952 =item SvIOK_off
1953
1954 Unsets the IV status of an SV.
1955
1956         void    SvIOK_off(SV* sv)
1957
1958 =for hackers
1959 Found in file sv.h
1960
1961 =item SvIOK_on
1962
1963 Tells an SV that it is an integer.
1964
1965         void    SvIOK_on(SV* sv)
1966
1967 =for hackers
1968 Found in file sv.h
1969
1970 =item SvIOK_only
1971
1972 Tells an SV that it is an integer and disables all other OK bits.
1973
1974         void    SvIOK_only(SV* sv)
1975
1976 =for hackers
1977 Found in file sv.h
1978
1979 =item SvIOK_only_UV
1980
1981 Tells and SV that it is an unsigned integer and disables all other OK bits.
1982
1983         void    SvIOK_only_UV(SV* sv)
1984
1985 =for hackers
1986 Found in file sv.h
1987
1988 =item SvIOK_UV
1989
1990 Returns a boolean indicating whether the SV contains an unsigned integer.
1991
1992         void    SvIOK_UV(SV* sv)
1993
1994 =for hackers
1995 Found in file sv.h
1996
1997 =item SvIV
1998
1999 Coerces the given SV to an integer and returns it.
2000
2001         IV      SvIV(SV* sv)
2002
2003 =for hackers
2004 Found in file sv.h
2005
2006 =item SvIVX
2007
2008 Returns the integer which is stored in the SV, assuming SvIOK is
2009 true.
2010
2011         IV      SvIVX(SV* sv)
2012
2013 =for hackers
2014 Found in file sv.h
2015
2016 =item SvLEN
2017
2018 Returns the size of the string buffer in the SV, not including any part
2019 attributable to C<SvOOK>.  See C<SvCUR>.
2020
2021         STRLEN  SvLEN(SV* sv)
2022
2023 =for hackers
2024 Found in file sv.h
2025
2026 =item SvNIOK
2027
2028 Returns a boolean indicating whether the SV contains a number, integer or
2029 double.
2030
2031         bool    SvNIOK(SV* sv)
2032
2033 =for hackers
2034 Found in file sv.h
2035
2036 =item SvNIOKp
2037
2038 Returns a boolean indicating whether the SV contains a number, integer or
2039 double.  Checks the B<private> setting.  Use C<SvNIOK>.
2040
2041         bool    SvNIOKp(SV* sv)
2042
2043 =for hackers
2044 Found in file sv.h
2045
2046 =item SvNIOK_off
2047
2048 Unsets the NV/IV status of an SV.
2049
2050         void    SvNIOK_off(SV* sv)
2051
2052 =for hackers
2053 Found in file sv.h
2054
2055 =item SvNOK
2056
2057 Returns a boolean indicating whether the SV contains a double.
2058
2059         bool    SvNOK(SV* sv)
2060
2061 =for hackers
2062 Found in file sv.h
2063
2064 =item SvNOKp
2065
2066 Returns a boolean indicating whether the SV contains a double.  Checks the
2067 B<private> setting.  Use C<SvNOK>.
2068
2069         bool    SvNOKp(SV* sv)
2070
2071 =for hackers
2072 Found in file sv.h
2073
2074 =item SvNOK_off
2075
2076 Unsets the NV status of an SV.
2077
2078         void    SvNOK_off(SV* sv)
2079
2080 =for hackers
2081 Found in file sv.h
2082
2083 =item SvNOK_on
2084
2085 Tells an SV that it is a double.
2086
2087         void    SvNOK_on(SV* sv)
2088
2089 =for hackers
2090 Found in file sv.h
2091
2092 =item SvNOK_only
2093
2094 Tells an SV that it is a double and disables all other OK bits.
2095
2096         void    SvNOK_only(SV* sv)
2097
2098 =for hackers
2099 Found in file sv.h
2100
2101 =item SvNV
2102
2103 Coerce the given SV to a double and return it.
2104
2105         NV      SvNV(SV* sv)
2106
2107 =for hackers
2108 Found in file sv.h
2109
2110 =item SvNVX
2111
2112 Returns the double which is stored in the SV, assuming SvNOK is
2113 true.
2114
2115         NV      SvNVX(SV* sv)
2116
2117 =for hackers
2118 Found in file sv.h
2119
2120 =item SvOK
2121
2122 Returns a boolean indicating whether the value is an SV.
2123
2124         bool    SvOK(SV* sv)
2125
2126 =for hackers
2127 Found in file sv.h
2128
2129 =item SvOOK
2130
2131 Returns a boolean indicating whether the SvIVX is a valid offset value for
2132 the SvPVX.  This hack is used internally to speed up removal of characters
2133 from the beginning of a SvPV.  When SvOOK is true, then the start of the
2134 allocated string buffer is really (SvPVX - SvIVX).
2135
2136         bool    SvOOK(SV* sv)
2137
2138 =for hackers
2139 Found in file sv.h
2140
2141 =item SvPOK
2142
2143 Returns a boolean indicating whether the SV contains a character
2144 string.
2145
2146         bool    SvPOK(SV* sv)
2147
2148 =for hackers
2149 Found in file sv.h
2150
2151 =item SvPOKp
2152
2153 Returns a boolean indicating whether the SV contains a character string.
2154 Checks the B<private> setting.  Use C<SvPOK>.
2155
2156         bool    SvPOKp(SV* sv)
2157
2158 =for hackers
2159 Found in file sv.h
2160
2161 =item SvPOK_off
2162
2163 Unsets the PV status of an SV.
2164
2165         void    SvPOK_off(SV* sv)
2166
2167 =for hackers
2168 Found in file sv.h
2169
2170 =item SvPOK_on
2171
2172 Tells an SV that it is a string.
2173
2174         void    SvPOK_on(SV* sv)
2175
2176 =for hackers
2177 Found in file sv.h
2178
2179 =item SvPOK_only
2180
2181 Tells an SV that it is a string and disables all other OK bits.
2182 Will also turn off the UTF8 status.
2183
2184         void    SvPOK_only(SV* sv)
2185
2186 =for hackers
2187 Found in file sv.h
2188
2189 =item SvPOK_only_UTF8
2190
2191 Tells an SV that it is a string and disables all other OK bits,
2192 and leaves the UTF8 status as it was.
2193   
2194         void    SvPOK_only_UTF8(SV* sv)
2195
2196 =for hackers
2197 Found in file sv.h
2198
2199 =item SvPV
2200
2201 Returns a pointer to the string in the SV, or a stringified form of the SV
2202 if the SV does not contain a string.  Handles 'get' magic.
2203
2204         char*   SvPV(SV* sv, STRLEN len)
2205
2206 =for hackers
2207 Found in file sv.h
2208
2209 =item SvPVX
2210
2211 Returns a pointer to the string in the SV.  The SV must contain a
2212 string.
2213
2214         char*   SvPVX(SV* sv)
2215
2216 =for hackers
2217 Found in file sv.h
2218
2219 =item SvPV_force
2220
2221 Like <SvPV> but will force the SV into becoming a string (SvPOK).  You want
2222 force if you are going to update the SvPVX directly.
2223
2224         char*   SvPV_force(SV* sv, STRLEN len)
2225
2226 =for hackers
2227 Found in file sv.h
2228
2229 =item SvPV_nolen
2230
2231 Returns a pointer to the string in the SV, or a stringified form of the SV
2232 if the SV does not contain a string.  Handles 'get' magic.
2233
2234         char*   SvPV_nolen(SV* sv)
2235
2236 =for hackers
2237 Found in file sv.h
2238
2239 =item SvREFCNT
2240
2241 Returns the value of the object's reference count.
2242
2243         U32     SvREFCNT(SV* sv)
2244
2245 =for hackers
2246 Found in file sv.h
2247
2248 =item SvREFCNT_dec
2249
2250 Decrements the reference count of the given SV.
2251
2252         void    SvREFCNT_dec(SV* sv)
2253
2254 =for hackers
2255 Found in file sv.h
2256
2257 =item SvREFCNT_inc
2258
2259 Increments the reference count of the given SV.
2260
2261         SV*     SvREFCNT_inc(SV* sv)
2262
2263 =for hackers
2264 Found in file sv.h
2265
2266 =item SvROK
2267
2268 Tests if the SV is an RV.
2269
2270         bool    SvROK(SV* sv)
2271
2272 =for hackers
2273 Found in file sv.h
2274
2275 =item SvROK_off
2276
2277 Unsets the RV status of an SV.
2278
2279         void    SvROK_off(SV* sv)
2280
2281 =for hackers
2282 Found in file sv.h
2283
2284 =item SvROK_on
2285
2286 Tells an SV that it is an RV.
2287
2288         void    SvROK_on(SV* sv)
2289
2290 =for hackers
2291 Found in file sv.h
2292
2293 =item SvRV
2294
2295 Dereferences an RV to return the SV.
2296
2297         SV*     SvRV(SV* sv)
2298
2299 =for hackers
2300 Found in file sv.h
2301
2302 =item SvSETMAGIC
2303
2304 Invokes C<mg_set> on an SV if it has 'set' magic.  This macro evaluates its
2305 argument more than once.
2306
2307         void    SvSETMAGIC(SV* sv)
2308
2309 =for hackers
2310 Found in file sv.h
2311
2312 =item SvSetSV
2313
2314 Calls C<sv_setsv> if dsv is not the same as ssv.  May evaluate arguments
2315 more than once.
2316
2317         void    SvSetSV(SV* dsb, SV* ssv)
2318
2319 =for hackers
2320 Found in file sv.h
2321
2322 =item SvSetSV_nosteal
2323
2324 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as
2325 ssv. May evaluate arguments more than once.
2326
2327         void    SvSetSV_nosteal(SV* dsv, SV* ssv)
2328
2329 =for hackers
2330 Found in file sv.h
2331
2332 =item SvSTASH
2333
2334 Returns the stash of the SV.
2335
2336         HV*     SvSTASH(SV* sv)
2337
2338 =for hackers
2339 Found in file sv.h
2340
2341 =item SvTAINT
2342
2343 Taints an SV if tainting is enabled
2344
2345         void    SvTAINT(SV* sv)
2346
2347 =for hackers
2348 Found in file sv.h
2349
2350 =item SvTAINTED
2351
2352 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if
2353 not.
2354
2355         bool    SvTAINTED(SV* sv)
2356
2357 =for hackers
2358 Found in file sv.h
2359
2360 =item SvTAINTED_off
2361
2362 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
2363 some of Perl's fundamental security features. XS module authors should not
2364 use this function unless they fully understand all the implications of
2365 unconditionally untainting the value. Untainting should be done in the
2366 standard perl fashion, via a carefully crafted regexp, rather than directly
2367 untainting variables.
2368
2369         void    SvTAINTED_off(SV* sv)
2370
2371 =for hackers
2372 Found in file sv.h
2373
2374 =item SvTAINTED_on
2375
2376 Marks an SV as tainted.
2377
2378         void    SvTAINTED_on(SV* sv)
2379
2380 =for hackers
2381 Found in file sv.h
2382
2383 =item SvTRUE
2384
2385 Returns a boolean indicating whether Perl would evaluate the SV as true or
2386 false, defined or undefined.  Does not handle 'get' magic.
2387
2388         bool    SvTRUE(SV* sv)
2389
2390 =for hackers
2391 Found in file sv.h
2392
2393 =item svtype
2394
2395 An enum of flags for Perl types.  These are found in the file B<sv.h> 
2396 in the C<svtype> enum.  Test these flags with the C<SvTYPE> macro.
2397
2398 =for hackers
2399 Found in file sv.h
2400
2401 =item SvTYPE
2402
2403 Returns the type of the SV.  See C<svtype>.
2404
2405         svtype  SvTYPE(SV* sv)
2406
2407 =for hackers
2408 Found in file sv.h
2409
2410 =item SVt_IV
2411
2412 Integer type flag for scalars.  See C<svtype>.
2413
2414 =for hackers
2415 Found in file sv.h
2416
2417 =item SVt_NV
2418
2419 Double type flag for scalars.  See C<svtype>.
2420
2421 =for hackers
2422 Found in file sv.h
2423
2424 =item SVt_PV
2425
2426 Pointer type flag for scalars.  See C<svtype>.
2427
2428 =for hackers
2429 Found in file sv.h
2430
2431 =item SVt_PVAV
2432
2433 Type flag for arrays.  See C<svtype>.
2434
2435 =for hackers
2436 Found in file sv.h
2437
2438 =item SVt_PVCV
2439
2440 Type flag for code refs.  See C<svtype>.
2441
2442 =for hackers
2443 Found in file sv.h
2444
2445 =item SVt_PVHV
2446
2447 Type flag for hashes.  See C<svtype>.
2448
2449 =for hackers
2450 Found in file sv.h
2451
2452 =item SVt_PVMG
2453
2454 Type flag for blessed scalars.  See C<svtype>.
2455
2456 =for hackers
2457 Found in file sv.h
2458
2459 =item SvUOK
2460
2461 Returns a boolean indicating whether the SV contains an unsigned integer.
2462
2463         void    SvUOK(SV* sv)
2464
2465 =for hackers
2466 Found in file sv.h
2467
2468 =item SvUPGRADE
2469
2470 Used to upgrade an SV to a more complex form.  Uses C<sv_upgrade> to
2471 perform the upgrade if necessary.  See C<svtype>.
2472
2473         void    SvUPGRADE(SV* sv, svtype type)
2474
2475 =for hackers
2476 Found in file sv.h
2477
2478 =item SvUTF8
2479
2480 Returns a boolean indicating whether the SV contains UTF-8 encoded data.
2481
2482         void    SvUTF8(SV* sv)
2483
2484 =for hackers
2485 Found in file sv.h
2486
2487 =item SvUTF8_off
2488
2489 Unsets the UTF8 status of an SV.
2490
2491         void    SvUTF8_off(SV *sv)
2492
2493 =for hackers
2494 Found in file sv.h
2495
2496 =item SvUTF8_on
2497
2498 Turn on the UTF8 status of an SV (the data is not changed, just the flag).
2499 Do not use frivolously.
2500
2501         void    SvUTF8_on(SV *sv)
2502
2503 =for hackers
2504 Found in file sv.h
2505
2506 =item SvUV
2507
2508 Coerces the given SV to an unsigned integer and returns it.
2509
2510         UV      SvUV(SV* sv)
2511
2512 =for hackers
2513 Found in file sv.h
2514
2515 =item SvUVX
2516
2517 Returns the unsigned integer which is stored in the SV, assuming SvIOK is
2518 true.
2519
2520         UV      SvUVX(SV* sv)
2521
2522 =for hackers
2523 Found in file sv.h
2524
2525 =item sv_2mortal
2526
2527 Marks an SV as mortal.  The SV will be destroyed when the current context
2528 ends.
2529
2530         SV*     sv_2mortal(SV* sv)
2531
2532 =for hackers
2533 Found in file sv.c
2534
2535 =item sv_bless
2536
2537 Blesses an SV into a specified package.  The SV must be an RV.  The package
2538 must be designated by its stash (see C<gv_stashpv()>).  The reference count
2539 of the SV is unaffected.
2540
2541         SV*     sv_bless(SV* sv, HV* stash)
2542
2543 =for hackers
2544 Found in file sv.c
2545
2546 =item sv_catpv
2547
2548 Concatenates the string onto the end of the string which is in the SV.
2549 If the SV has the UTF8 status set, then the bytes appended should be
2550 valid UTF8.  Handles 'get' magic, but not 'set' magic.  See C<sv_catpv_mg>.
2551
2552         void    sv_catpv(SV* sv, const char* ptr)
2553
2554 =for hackers
2555 Found in file sv.c
2556
2557 =item sv_catpvf
2558
2559 Processes its arguments like C<sprintf> and appends the formatted
2560 output to an SV.  If the appended data contains "wide" characters
2561 (including, but not limited to, SVs with a UTF-8 PV formatted with %s,
2562 and characters >255 formatted with %c), the original SV might get
2563 upgraded to UTF-8.  Handles 'get' magic, but not 'set' magic.
2564 C<SvSETMAGIC()> must typically be called after calling this function
2565 to handle 'set' magic.
2566
2567         void    sv_catpvf(SV* sv, const char* pat, ...)
2568
2569 =for hackers
2570 Found in file sv.c
2571
2572 =item sv_catpvf_mg
2573
2574 Like C<sv_catpvf>, but also handles 'set' magic.
2575
2576         void    sv_catpvf_mg(SV *sv, const char* pat, ...)
2577
2578 =for hackers
2579 Found in file sv.c
2580
2581 =item sv_catpvn
2582
2583 Concatenates the string onto the end of the string which is in the SV.  The
2584 C<len> indicates number of bytes to copy.  If the SV has the UTF8
2585 status set, then the bytes appended should be valid UTF8.
2586 Handles 'get' magic, but not 'set' magic.  See C<sv_catpvn_mg>.
2587
2588         void    sv_catpvn(SV* sv, const char* ptr, STRLEN len)
2589
2590 =for hackers
2591 Found in file sv.c
2592
2593 =item sv_catpvn_mg
2594
2595 Like C<sv_catpvn>, but also handles 'set' magic.
2596
2597         void    sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)
2598
2599 =for hackers
2600 Found in file sv.c
2601
2602 =item sv_catpv_mg
2603
2604 Like C<sv_catpv>, but also handles 'set' magic.
2605
2606         void    sv_catpv_mg(SV *sv, const char *ptr)
2607
2608 =for hackers
2609 Found in file sv.c
2610
2611 =item sv_catsv
2612
2613 Concatenates the string from SV C<ssv> onto the end of the string in
2614 SV C<dsv>.  Modifies C<dsv> but not C<ssv>.  Handles 'get' magic, but
2615 not 'set' magic.  See C<sv_catsv_mg>.
2616
2617         void    sv_catsv(SV* dsv, SV* ssv)
2618
2619 =for hackers
2620 Found in file sv.c
2621
2622 =item sv_catsv_mg
2623
2624 Like C<sv_catsv>, but also handles 'set' magic.
2625
2626         void    sv_catsv_mg(SV *dstr, SV *sstr)
2627
2628 =for hackers
2629 Found in file sv.c
2630
2631 =item sv_chop
2632
2633 Efficient removal of characters from the beginning of the string buffer.
2634 SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
2635 the string buffer.  The C<ptr> becomes the first character of the adjusted
2636 string.
2637
2638         void    sv_chop(SV* sv, char* ptr)
2639
2640 =for hackers
2641 Found in file sv.c
2642
2643 =item sv_clear
2644
2645 Clear an SV, making it empty. Does not free the memory used by the SV
2646 itself.
2647
2648         void    sv_clear(SV* sv)
2649
2650 =for hackers
2651 Found in file sv.c
2652
2653 =item sv_cmp
2654
2655 Compares the strings in two SVs.  Returns -1, 0, or 1 indicating whether the
2656 string in C<sv1> is less than, equal to, or greater than the string in
2657 C<sv2>.
2658
2659         I32     sv_cmp(SV* sv1, SV* sv2)
2660
2661 =for hackers
2662 Found in file sv.c
2663
2664 =item sv_cmp_locale
2665
2666 Compares the strings in two SVs in a locale-aware manner. See
2667 L</sv_cmp_locale>
2668
2669         I32     sv_cmp_locale(SV* sv1, SV* sv2)
2670
2671 =for hackers
2672 Found in file sv.c
2673
2674 =item sv_dec
2675
2676 Auto-decrement of the value in the SV.
2677
2678         void    sv_dec(SV* sv)
2679
2680 =for hackers
2681 Found in file sv.c
2682
2683 =item sv_derived_from
2684
2685 Returns a boolean indicating whether the SV is derived from the specified
2686 class.  This is the function that implements C<UNIVERSAL::isa>.  It works
2687 for class names as well as for objects.
2688
2689         bool    sv_derived_from(SV* sv, const char* name)
2690
2691 =for hackers
2692 Found in file universal.c
2693
2694 =item sv_eq
2695
2696 Returns a boolean indicating whether the strings in the two SVs are
2697 identical.
2698
2699         I32     sv_eq(SV* sv1, SV* sv2)
2700
2701 =for hackers
2702 Found in file sv.c
2703
2704 =item sv_free
2705
2706 Free the memory used by an SV.
2707
2708         void    sv_free(SV* sv)
2709
2710 =for hackers
2711 Found in file sv.c
2712
2713 =item sv_gets
2714
2715 Get a line from the filehandle and store it into the SV, optionally
2716 appending to the currently-stored string.
2717
2718         char*   sv_gets(SV* sv, PerlIO* fp, I32 append)
2719
2720 =for hackers
2721 Found in file sv.c
2722
2723 =item sv_grow
2724
2725 Expands the character buffer in the SV.  This will use C<sv_unref> and will
2726 upgrade the SV to C<SVt_PV>.  Returns a pointer to the character buffer.
2727 Use C<SvGROW>.
2728
2729         char*   sv_grow(SV* sv, STRLEN newlen)
2730
2731 =for hackers
2732 Found in file sv.c
2733
2734 =item sv_inc
2735
2736 Auto-increment of the value in the SV.
2737
2738         void    sv_inc(SV* sv)
2739
2740 =for hackers
2741 Found in file sv.c
2742
2743 =item sv_insert
2744
2745 Inserts a string at the specified offset/length within the SV. Similar to
2746 the Perl substr() function.
2747
2748         void    sv_insert(SV* bigsv, STRLEN offset, STRLEN len, char* little, STRLEN littlelen)
2749
2750 =for hackers
2751 Found in file sv.c
2752
2753 =item sv_isa
2754
2755 Returns a boolean indicating whether the SV is blessed into the specified
2756 class.  This does not check for subtypes; use C<sv_derived_from> to verify
2757 an inheritance relationship.
2758
2759         int     sv_isa(SV* sv, const char* name)
2760
2761 =for hackers
2762 Found in file sv.c
2763
2764 =item sv_isobject
2765
2766 Returns a boolean indicating whether the SV is an RV pointing to a blessed
2767 object.  If the SV is not an RV, or if the object is not blessed, then this
2768 will return false.
2769
2770         int     sv_isobject(SV* sv)
2771
2772 =for hackers
2773 Found in file sv.c
2774
2775 =item sv_len
2776
2777 Returns the length of the string in the SV.  See also C<SvCUR>.
2778
2779         STRLEN  sv_len(SV* sv)
2780
2781 =for hackers
2782 Found in file sv.c
2783
2784 =item sv_len_utf8
2785
2786 Returns the number of characters in the string in an SV, counting wide
2787 UTF8 bytes as a single character.
2788
2789         STRLEN  sv_len_utf8(SV* sv)
2790
2791 =for hackers
2792 Found in file sv.c
2793
2794 =item sv_magic
2795
2796 Adds magic to an SV.
2797
2798         void    sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)
2799
2800 =for hackers
2801 Found in file sv.c
2802
2803 =item sv_mortalcopy
2804
2805 Creates a new SV which is a copy of the original SV.  The new SV is marked
2806 as mortal.
2807
2808         SV*     sv_mortalcopy(SV* oldsv)
2809
2810 =for hackers
2811 Found in file sv.c
2812
2813 =item sv_newmortal
2814
2815 Creates a new SV which is mortal.  The reference count of the SV is set to 1.
2816
2817         SV*     sv_newmortal()
2818
2819 =for hackers
2820 Found in file sv.c
2821
2822 =item sv_pvn_force
2823
2824 Get a sensible string out of the SV somehow.
2825
2826         char*   sv_pvn_force(SV* sv, STRLEN* lp)
2827
2828 =for hackers
2829 Found in file sv.c
2830
2831 =item sv_pvutf8n_force
2832
2833 Get a sensible UTF8-encoded string out of the SV somehow. See
2834 L</sv_pvn_force>.
2835
2836         char*   sv_pvutf8n_force(SV* sv, STRLEN* lp)
2837
2838 =for hackers
2839 Found in file sv.c
2840
2841 =item sv_reftype
2842
2843 Returns a string describing what the SV is a reference to.
2844
2845         char*   sv_reftype(SV* sv, int ob)
2846
2847 =for hackers
2848 Found in file sv.c
2849
2850 =item sv_replace
2851
2852 Make the first argument a copy of the second, then delete the original.
2853
2854         void    sv_replace(SV* sv, SV* nsv)
2855
2856 =for hackers
2857 Found in file sv.c
2858
2859 =item sv_rvweaken
2860
2861 Weaken a reference.
2862
2863         SV*     sv_rvweaken(SV *sv)
2864
2865 =for hackers
2866 Found in file sv.c
2867
2868 =item sv_setiv
2869
2870 Copies an integer into the given SV.  Does not handle 'set' magic.  See
2871 C<sv_setiv_mg>.
2872
2873         void    sv_setiv(SV* sv, IV num)
2874
2875 =for hackers
2876 Found in file sv.c
2877
2878 =item sv_setiv_mg
2879
2880 Like C<sv_setiv>, but also handles 'set' magic.
2881
2882         void    sv_setiv_mg(SV *sv, IV i)
2883
2884 =for hackers
2885 Found in file sv.c
2886
2887 =item sv_setnv
2888
2889 Copies a double into the given SV.  Does not handle 'set' magic.  See
2890 C<sv_setnv_mg>.
2891
2892         void    sv_setnv(SV* sv, NV num)
2893
2894 =for hackers
2895 Found in file sv.c
2896
2897 =item sv_setnv_mg
2898
2899 Like C<sv_setnv>, but also handles 'set' magic.
2900
2901         void    sv_setnv_mg(SV *sv, NV num)
2902
2903 =for hackers
2904 Found in file sv.c
2905
2906 =item sv_setpv
2907
2908 Copies a string into an SV.  The string must be null-terminated.  Does not
2909 handle 'set' magic.  See C<sv_setpv_mg>.
2910
2911         void    sv_setpv(SV* sv, const char* ptr)
2912
2913 =for hackers
2914 Found in file sv.c
2915
2916 =item sv_setpvf
2917
2918 Processes its arguments like C<sprintf> and sets an SV to the formatted
2919 output.  Does not handle 'set' magic.  See C<sv_setpvf_mg>.
2920
2921         void    sv_setpvf(SV* sv, const char* pat, ...)
2922
2923 =for hackers
2924 Found in file sv.c
2925
2926 =item sv_setpvf_mg
2927
2928 Like C<sv_setpvf>, but also handles 'set' magic.
2929
2930         void    sv_setpvf_mg(SV *sv, const char* pat, ...)
2931
2932 =for hackers
2933 Found in file sv.c
2934
2935 =item sv_setpviv
2936
2937 Copies an integer into the given SV, also updating its string value.
2938 Does not handle 'set' magic.  See C<sv_setpviv_mg>.
2939
2940         void    sv_setpviv(SV* sv, IV num)
2941
2942 =for hackers
2943 Found in file sv.c
2944
2945 =item sv_setpviv_mg
2946
2947 Like C<sv_setpviv>, but also handles 'set' magic.
2948
2949         void    sv_setpviv_mg(SV *sv, IV iv)
2950
2951 =for hackers
2952 Found in file sv.c
2953
2954 =item sv_setpvn
2955
2956 Copies a string into an SV.  The C<len> parameter indicates the number of
2957 bytes to be copied.  Does not handle 'set' magic.  See C<sv_setpvn_mg>.
2958
2959         void    sv_setpvn(SV* sv, const char* ptr, STRLEN len)
2960
2961 =for hackers
2962 Found in file sv.c
2963
2964 =item sv_setpvn_mg
2965
2966 Like C<sv_setpvn>, but also handles 'set' magic.
2967
2968         void    sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)
2969
2970 =for hackers
2971 Found in file sv.c
2972
2973 =item sv_setpv_mg
2974
2975 Like C<sv_setpv>, but also handles 'set' magic.
2976
2977         void    sv_setpv_mg(SV *sv, const char *ptr)
2978
2979 =for hackers
2980 Found in file sv.c
2981
2982 =item sv_setref_iv
2983
2984 Copies an integer into a new SV, optionally blessing the SV.  The C<rv>
2985 argument will be upgraded to an RV.  That RV will be modified to point to
2986 the new SV.  The C<classname> argument indicates the package for the
2987 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
2988 will be returned and will have a reference count of 1.
2989
2990         SV*     sv_setref_iv(SV* rv, const char* classname, IV iv)
2991
2992 =for hackers
2993 Found in file sv.c
2994
2995 =item sv_setref_nv
2996
2997 Copies a double into a new SV, optionally blessing the SV.  The C<rv>
2998 argument will be upgraded to an RV.  That RV will be modified to point to
2999 the new SV.  The C<classname> argument indicates the package for the
3000 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
3001 will be returned and will have a reference count of 1.
3002
3003         SV*     sv_setref_nv(SV* rv, const char* classname, NV nv)
3004
3005 =for hackers
3006 Found in file sv.c
3007
3008 =item sv_setref_pv
3009
3010 Copies a pointer into a new SV, optionally blessing the SV.  The C<rv>
3011 argument will be upgraded to an RV.  That RV will be modified to point to
3012 the new SV.  If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
3013 into the SV.  The C<classname> argument indicates the package for the
3014 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
3015 will be returned and will have a reference count of 1.
3016
3017 Do not use with other Perl types such as HV, AV, SV, CV, because those
3018 objects will become corrupted by the pointer copy process.
3019
3020 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
3021
3022         SV*     sv_setref_pv(SV* rv, const char* classname, void* pv)
3023
3024 =for hackers
3025 Found in file sv.c
3026
3027 =item sv_setref_pvn
3028
3029 Copies a string into a new SV, optionally blessing the SV.  The length of the
3030 string must be specified with C<n>.  The C<rv> argument will be upgraded to
3031 an RV.  That RV will be modified to point to the new SV.  The C<classname>
3032 argument indicates the package for the blessing.  Set C<classname> to
3033 C<Nullch> to avoid the blessing.  The new SV will be returned and will have
3034 a reference count of 1.
3035
3036 Note that C<sv_setref_pv> copies the pointer while this copies the string.
3037
3038         SV*     sv_setref_pvn(SV* rv, const char* classname, char* pv, STRLEN n)
3039
3040 =for hackers
3041 Found in file sv.c
3042
3043 =item sv_setref_uv
3044
3045 Copies an unsigned integer into a new SV, optionally blessing the SV.  The C<rv>
3046 argument will be upgraded to an RV.  That RV will be modified to point to
3047 the new SV.  The C<classname> argument indicates the package for the
3048 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
3049 will be returned and will have a reference count of 1.
3050
3051         SV*     sv_setref_uv(SV* rv, const char* classname, UV uv)
3052
3053 =for hackers
3054 Found in file sv.c
3055
3056 =item sv_setsv
3057
3058 Copies the contents of the source SV C<ssv> into the destination SV C<dsv>.
3059 The source SV may be destroyed if it is mortal.  Does not handle 'set'
3060 magic.  See the macro forms C<SvSetSV>, C<SvSetSV_nosteal> and
3061 C<sv_setsv_mg>.
3062
3063         void    sv_setsv(SV* dsv, SV* ssv)
3064
3065 =for hackers
3066 Found in file sv.c
3067
3068 =item sv_setsv_mg
3069
3070 Like C<sv_setsv>, but also handles 'set' magic.
3071
3072         void    sv_setsv_mg(SV *dstr, SV *sstr)
3073
3074 =for hackers
3075 Found in file sv.c
3076
3077 =item sv_setuv
3078
3079 Copies an unsigned integer into the given SV.  Does not handle 'set' magic.
3080 See C<sv_setuv_mg>.
3081
3082         void    sv_setuv(SV* sv, UV num)
3083
3084 =for hackers
3085 Found in file sv.c
3086
3087 =item sv_setuv_mg
3088
3089 Like C<sv_setuv>, but also handles 'set' magic.
3090
3091         void    sv_setuv_mg(SV *sv, UV u)
3092
3093 =for hackers
3094 Found in file sv.c
3095
3096 =item sv_true
3097
3098 Returns true if the SV has a true value by Perl's rules.
3099
3100         I32     sv_true(SV *sv)
3101
3102 =for hackers
3103 Found in file sv.c
3104
3105 =item sv_unmagic
3106
3107 Removes magic from an SV.
3108
3109         int     sv_unmagic(SV* sv, int type)
3110
3111 =for hackers
3112 Found in file sv.c
3113
3114 =item sv_unref
3115
3116 Unsets the RV status of the SV, and decrements the reference count of
3117 whatever was being referenced by the RV.  This can almost be thought of
3118 as a reversal of C<newSVrv>.  This is C<sv_unref_flags> with the C<flag>
3119 being zero.  See C<SvROK_off>.
3120
3121         void    sv_unref(SV* sv)
3122
3123 =for hackers
3124 Found in file sv.c
3125
3126 =item sv_unref_flags
3127
3128 Unsets the RV status of the SV, and decrements the reference count of
3129 whatever was being referenced by the RV.  This can almost be thought of
3130 as a reversal of C<newSVrv>.  The C<cflags> argument can contain
3131 C<SV_IMMEDIATE_UNREF> to force the reference count to be decremented
3132 (otherwise the decrementing is conditional on the reference count being
3133 different from one or the reference being a readonly SV).
3134 See C<SvROK_off>.
3135
3136         void    sv_unref_flags(SV* sv, U32 flags)
3137
3138 =for hackers
3139 Found in file sv.c
3140
3141 =item sv_upgrade
3142
3143 Upgrade an SV to a more complex form.  Use C<SvUPGRADE>.  See
3144 C<svtype>.
3145
3146         bool    sv_upgrade(SV* sv, U32 mt)
3147
3148 =for hackers
3149 Found in file sv.c
3150
3151 =item sv_usepvn
3152
3153 Tells an SV to use C<ptr> to find its string value.  Normally the string is
3154 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3155 The C<ptr> should point to memory that was allocated by C<malloc>.  The
3156 string length, C<len>, must be supplied.  This function will realloc the
3157 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3158 the programmer after giving it to sv_usepvn.  Does not handle 'set' magic.
3159 See C<sv_usepvn_mg>.
3160
3161         void    sv_usepvn(SV* sv, char* ptr, STRLEN len)
3162
3163 =for hackers
3164 Found in file sv.c
3165
3166 =item sv_usepvn_mg
3167
3168 Like C<sv_usepvn>, but also handles 'set' magic.
3169
3170         void    sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)
3171
3172 =for hackers
3173 Found in file sv.c
3174
3175 =item sv_utf8_decode
3176
3177 Convert the octets in the PV from UTF-8 to chars. Scan for validity and then
3178 turn of SvUTF8 if needed so that we see characters. Used as a building block
3179 for decode_utf8 in Encode.xs
3180
3181 NOTE: this function is experimental and may change or be
3182 removed without notice.
3183
3184         bool    sv_utf8_decode(SV *sv)
3185
3186 =for hackers
3187 Found in file sv.c
3188
3189 =item sv_utf8_downgrade
3190
3191 Attempt to convert the PV of an SV from UTF8-encoded to byte encoding.
3192 This may not be possible if the PV contains non-byte encoding characters;
3193 if this is the case, either returns false or, if C<fail_ok> is not
3194 true, croaks.
3195
3196 NOTE: this function is experimental and may change or be
3197 removed without notice.
3198
3199         bool    sv_utf8_downgrade(SV *sv, bool fail_ok)
3200
3201 =for hackers
3202 Found in file sv.c
3203
3204 =item sv_utf8_encode
3205
3206 Convert the PV of an SV to UTF8-encoded, but then turn off the C<SvUTF8>
3207 flag so that it looks like octets again. Used as a building block
3208 for encode_utf8 in Encode.xs
3209
3210         void    sv_utf8_encode(SV *sv)
3211
3212 =for hackers
3213 Found in file sv.c
3214
3215 =item sv_utf8_upgrade
3216
3217 Convert the PV of an SV to its UTF8-encoded form.
3218 Forces the SV to string form it it is not already.
3219 Always sets the SvUTF8 flag to avoid future validity checks even
3220 if all the bytes have hibit clear.
3221
3222         STRLEN  sv_utf8_upgrade(SV *sv)
3223
3224 =for hackers
3225 Found in file sv.c
3226
3227 =item sv_vcatpvfn
3228
3229 Processes its arguments like C<vsprintf> and appends the formatted output
3230 to an SV.  Uses an array of SVs if the C style variable argument list is
3231 missing (NULL).  When running with taint checks enabled, indicates via
3232 C<maybe_tainted> if results are untrustworthy (often due to the use of
3233 locales).
3234
3235         void    sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
3236
3237 =for hackers
3238 Found in file sv.c
3239
3240 =item sv_vsetpvfn
3241
3242 Works like C<vcatpvfn> but copies the text into the SV instead of
3243 appending it.
3244
3245         void    sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)
3246
3247 =for hackers
3248 Found in file sv.c
3249
3250 =item THIS
3251
3252 Variable which is setup by C<xsubpp> to designate the object in a C++ 
3253 XSUB.  This is always the proper type for the C++ object.  See C<CLASS> and 
3254 L<perlxs/"Using XS With C++">.
3255
3256         (whatever)      THIS
3257
3258 =for hackers
3259 Found in file XSUB.h
3260
3261 =item toLOWER
3262
3263 Converts the specified character to lowercase.
3264
3265         char    toLOWER(char ch)
3266
3267 =for hackers
3268 Found in file handy.h
3269
3270 =item toUPPER
3271
3272 Converts the specified character to uppercase.
3273
3274         char    toUPPER(char ch)
3275
3276 =for hackers
3277 Found in file handy.h
3278
3279 =item utf8n_to_uvchr
3280
3281 Returns the native character value of the first character in the string C<s>
3282 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
3283 length, in bytes, of that character.
3284
3285 Allows length and flags to be passed to low level routine.
3286
3287         UV      utf8n_to_uvchr(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
3288
3289 =for hackers
3290 Found in file utf8.c
3291
3292 =item utf8n_to_uvuni
3293
3294 Bottom level UTF-8 decode routine.
3295 Returns the unicode code point value of the first character in the string C<s>
3296 which is assumed to be in UTF8 encoding and no longer than C<curlen>;
3297 C<retlen> will be set to the length, in bytes, of that character.
3298
3299 If C<s> does not point to a well-formed UTF8 character, the behaviour
3300 is dependent on the value of C<flags>: if it contains UTF8_CHECK_ONLY,
3301 it is assumed that the caller will raise a warning, and this function
3302 will silently just set C<retlen> to C<-1> and return zero.  If the
3303 C<flags> does not contain UTF8_CHECK_ONLY, warnings about
3304 malformations will be given, C<retlen> will be set to the expected
3305 length of the UTF-8 character in bytes, and zero will be returned.
3306
3307 The C<flags> can also contain various flags to allow deviations from
3308 the strict UTF-8 encoding (see F<utf8.h>).
3309
3310 Most code should use utf8_to_uvchr() rather than call this directly.
3311
3312         UV      utf8n_to_uvuni(U8 *s, STRLEN curlen, STRLEN* retlen, U32 flags)
3313
3314 =for hackers
3315 Found in file utf8.c
3316
3317 =item utf8_distance
3318
3319 Returns the number of UTF8 characters between the UTF-8 pointers C<a>
3320 and C<b>.
3321
3322 WARNING: use only if you *know* that the pointers point inside the
3323 same UTF-8 buffer.
3324
3325         IV      utf8_distance(U8 *a, U8 *b)
3326
3327 =for hackers
3328 Found in file utf8.c
3329
3330 =item utf8_hop
3331
3332 Return the UTF-8 pointer C<s> displaced by C<off> characters, either
3333 forward or backward.
3334
3335 WARNING: do not use the following unless you *know* C<off> is within
3336 the UTF-8 data pointed to by C<s> *and* that on entry C<s> is aligned
3337 on the first byte of character or just after the last byte of a character.
3338
3339         U8*     utf8_hop(U8 *s, I32 off)
3340
3341 =for hackers
3342 Found in file utf8.c
3343
3344 =item utf8_length
3345
3346 Return the length of the UTF-8 char encoded string C<s> in characters.
3347 Stops at C<e> (inclusive).  If C<e E<lt> s> or if the scan would end
3348 up past C<e>, croaks.
3349
3350         STRLEN  utf8_length(U8* s, U8 *e)
3351
3352 =for hackers
3353 Found in file utf8.c
3354
3355 =item utf8_to_bytes
3356
3357 Converts a string C<s> of length C<len> from UTF8 into byte encoding.
3358 Unlike C<bytes_to_utf8>, this over-writes the original string, and
3359 updates len to contain the new length.
3360 Returns zero on failure, setting C<len> to -1.
3361
3362 NOTE: this function is experimental and may change or be
3363 removed without notice.
3364
3365         U8*     utf8_to_bytes(U8 *s, STRLEN *len)
3366
3367 =for hackers
3368 Found in file utf8.c
3369
3370 =item utf8_to_uvchr
3371
3372 Returns the native character value of the first character in the string C<s>
3373 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
3374 length, in bytes, of that character.
3375
3376 If C<s> does not point to a well-formed UTF8 character, zero is
3377 returned and retlen is set, if possible, to -1.
3378
3379         UV      utf8_to_uvchr(U8 *s, STRLEN* retlen)
3380
3381 =for hackers
3382 Found in file utf8.c
3383
3384 =item utf8_to_uvuni
3385
3386 Returns the Unicode code point of the first character in the string C<s>
3387 which is assumed to be in UTF8 encoding; C<retlen> will be set to the
3388 length, in bytes, of that character.
3389
3390 This function should only be used when returned UV is considered
3391 an index into the Unicode semantic tables (e.g. swashes).
3392
3393 If C<s> does not point to a well-formed UTF8 character, zero is
3394 returned and retlen is set, if possible, to -1.
3395
3396         UV      utf8_to_uvuni(U8 *s, STRLEN* retlen)
3397
3398 =for hackers
3399 Found in file utf8.c
3400
3401 =item uvchr_to_utf8
3402
3403 Adds the UTF8 representation of the Native codepoint C<uv> to the end
3404 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
3405 bytes available. The return value is the pointer to the byte after the
3406 end of the new character. In other words,
3407
3408     d = uvchr_to_utf8(d, uv);
3409
3410 is the recommended wide native character-aware way of saying
3411
3412     *(d++) = uv;
3413
3414         U8*     uvchr_to_utf8(U8 *d, UV uv)
3415
3416 =for hackers
3417 Found in file utf8.c
3418
3419 =item uvuni_to_utf8
3420
3421 Adds the UTF8 representation of the Unicode codepoint C<uv> to the end
3422 of the string C<d>; C<d> should be have at least C<UTF8_MAXLEN+1> free
3423 bytes available. The return value is the pointer to the byte after the
3424 end of the new character. In other words,
3425
3426     d = uvuni_to_utf8(d, uv);
3427
3428 is the recommended Unicode-aware way of saying
3429
3430     *(d++) = uv;
3431
3432         U8*     uvuni_to_utf8(U8 *d, UV uv)
3433
3434 =for hackers
3435 Found in file utf8.c
3436
3437 =item warn
3438
3439 This is the XSUB-writer's interface to Perl's C<warn> function.  Use this
3440 function the same way you use the C C<printf> function.  See
3441 C<croak>.
3442
3443         void    warn(const char* pat, ...)
3444
3445 =for hackers
3446 Found in file util.c
3447
3448 =item XPUSHi
3449
3450 Push an integer onto the stack, extending the stack if necessary.  Handles
3451 'set' magic. See C<PUSHi>.
3452
3453         void    XPUSHi(IV iv)
3454
3455 =for hackers
3456 Found in file pp.h
3457
3458 =item XPUSHn
3459
3460 Push a double onto the stack, extending the stack if necessary.  Handles
3461 'set' magic.  See C<PUSHn>.
3462
3463         void    XPUSHn(NV nv)
3464
3465 =for hackers
3466 Found in file pp.h
3467
3468 =item XPUSHp
3469
3470 Push a string onto the stack, extending the stack if necessary.  The C<len>
3471 indicates the length of the string.  Handles 'set' magic.  See
3472 C<PUSHp>.
3473
3474         void    XPUSHp(char* str, STRLEN len)
3475
3476 =for hackers
3477 Found in file pp.h
3478
3479 =item XPUSHs
3480
3481 Push an SV onto the stack, extending the stack if necessary.  Does not
3482 handle 'set' magic.  See C<PUSHs>.
3483
3484         void    XPUSHs(SV* sv)
3485
3486 =for hackers
3487 Found in file pp.h
3488
3489 =item XPUSHu
3490
3491 Push an unsigned integer onto the stack, extending the stack if necessary.
3492 See C<PUSHu>.
3493
3494         void    XPUSHu(UV uv)
3495
3496 =for hackers
3497 Found in file pp.h
3498
3499 =item XS
3500
3501 Macro to declare an XSUB and its C parameter list.  This is handled by
3502 C<xsubpp>.
3503
3504 =for hackers
3505 Found in file XSUB.h
3506
3507 =item XSRETURN
3508
3509 Return from XSUB, indicating number of items on the stack.  This is usually
3510 handled by C<xsubpp>.
3511
3512         void    XSRETURN(int nitems)
3513
3514 =for hackers
3515 Found in file XSUB.h
3516
3517 =item XSRETURN_EMPTY
3518
3519 Return an empty list from an XSUB immediately.
3520
3521                 XSRETURN_EMPTY;
3522
3523 =for hackers
3524 Found in file XSUB.h
3525
3526 =item XSRETURN_IV
3527
3528 Return an integer from an XSUB immediately.  Uses C<XST_mIV>.
3529
3530         void    XSRETURN_IV(IV iv)
3531
3532 =for hackers
3533 Found in file XSUB.h
3534
3535 =item XSRETURN_NO
3536
3537 Return C<&PL_sv_no> from an XSUB immediately.  Uses C<XST_mNO>.
3538
3539                 XSRETURN_NO;
3540
3541 =for hackers
3542 Found in file XSUB.h
3543
3544 =item XSRETURN_NV
3545
3546 Return an double from an XSUB immediately.  Uses C<XST_mNV>.
3547
3548         void    XSRETURN_NV(NV nv)
3549
3550 =for hackers
3551 Found in file XSUB.h
3552
3553 =item XSRETURN_PV
3554
3555 Return a copy of a string from an XSUB immediately.  Uses C<XST_mPV>.
3556
3557         void    XSRETURN_PV(char* str)
3558
3559 =for hackers
3560 Found in file XSUB.h
3561
3562 =item XSRETURN_UNDEF
3563
3564 Return C<&PL_sv_undef> from an XSUB immediately.  Uses C<XST_mUNDEF>.
3565
3566                 XSRETURN_UNDEF;
3567
3568 =for hackers
3569 Found in file XSUB.h
3570
3571 =item XSRETURN_YES
3572
3573 Return C<&PL_sv_yes> from an XSUB immediately.  Uses C<XST_mYES>.
3574
3575                 XSRETURN_YES;
3576
3577 =for hackers
3578 Found in file XSUB.h
3579
3580 =item XST_mIV
3581
3582 Place an integer into the specified position C<pos> on the stack.  The
3583 value is stored in a new mortal SV.
3584
3585         void    XST_mIV(int pos, IV iv)
3586
3587 =for hackers
3588 Found in file XSUB.h
3589
3590 =item XST_mNO
3591
3592 Place C<&PL_sv_no> into the specified position C<pos> on the
3593 stack.
3594
3595         void    XST_mNO(int pos)
3596
3597 =for hackers
3598 Found in file XSUB.h
3599
3600 =item XST_mNV
3601
3602 Place a double into the specified position C<pos> on the stack.  The value
3603 is stored in a new mortal SV.
3604
3605         void    XST_mNV(int pos, NV nv)
3606
3607 =for hackers
3608 Found in file XSUB.h
3609
3610 =item XST_mPV
3611
3612 Place a copy of a string into the specified position C<pos> on the stack. 
3613 The value is stored in a new mortal SV.
3614
3615         void    XST_mPV(int pos, char* str)
3616
3617 =for hackers
3618 Found in file XSUB.h
3619
3620 =item XST_mUNDEF
3621
3622 Place C<&PL_sv_undef> into the specified position C<pos> on the
3623 stack.
3624
3625         void    XST_mUNDEF(int pos)
3626
3627 =for hackers
3628 Found in file XSUB.h
3629
3630 =item XST_mYES
3631
3632 Place C<&PL_sv_yes> into the specified position C<pos> on the
3633 stack.
3634
3635         void    XST_mYES(int pos)
3636
3637 =for hackers
3638 Found in file XSUB.h
3639
3640 =item XS_VERSION
3641
3642 The version identifier for an XS module.  This is usually
3643 handled automatically by C<ExtUtils::MakeMaker>.  See C<XS_VERSION_BOOTCHECK>.
3644
3645 =for hackers
3646 Found in file XSUB.h
3647
3648 =item XS_VERSION_BOOTCHECK
3649
3650 Macro to verify that a PM module's $VERSION variable matches the XS
3651 module's C<XS_VERSION> variable.  This is usually handled automatically by
3652 C<xsubpp>.  See L<perlxs/"The VERSIONCHECK: Keyword">.
3653
3654                 XS_VERSION_BOOTCHECK;
3655
3656 =for hackers
3657 Found in file XSUB.h
3658
3659 =item Zero
3660
3661 The XSUB-writer's interface to the C C<memzero> function.  The C<dest> is the
3662 destination, C<nitems> is the number of items, and C<type> is the type.
3663
3664         void    Zero(void* dest, int nitems, type)
3665
3666 =for hackers
3667 Found in file handy.h
3668
3669 =back
3670
3671 =head1 AUTHORS
3672
3673 Until May 1997, this document was maintained by Jeff Okamoto
3674 <okamoto@corp.hp.com>.  It is now maintained as part of Perl itself.
3675
3676 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
3677 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
3678 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
3679 Stephen McCamant, and Gurusamy Sarathy.
3680
3681 API Listing originally by Dean Roehrich <roehrich@cray.com>.
3682
3683 Updated to be autogenerated from comments in the source by Benjamin Stuhl.
3684
3685 =head1 SEE ALSO
3686
3687 perlguts(1), perlxs(1), perlxstut(1), perlintern(1)
3688