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