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