This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
support USE_THREADS+MULTIPLICITY; source compat tweaks for
[perl5.git] / pod / perlguts.pod
1 =head1 NAME
2
3 perlguts - Perl's Internal Functions
4
5 =head1 DESCRIPTION
6
7 This document attempts to describe some of the internal functions of the
8 Perl executable.  It is far from complete and probably contains many errors.
9 Please refer any questions or comments to the author below.
10
11 =head1 Variables
12
13 =head2 Datatypes
14
15 Perl has three typedefs that handle Perl's three main data types:
16
17     SV  Scalar Value
18     AV  Array Value
19     HV  Hash Value
20
21 Each typedef has specific routines that manipulate the various data types.
22
23 =head2 What is an "IV"?
24
25 Perl uses a special typedef IV which is a simple integer type that is
26 guaranteed to be large enough to hold a pointer (as well as an integer).
27
28 Perl also uses two special typedefs, I32 and I16, which will always be at
29 least 32-bits and 16-bits long, respectively.
30
31 =head2 Working with SVs
32
33 An SV can be created and loaded with one command.  There are four types of
34 values that can be loaded: an integer value (IV), a double (NV), a string,
35 (PV), and another scalar (SV).
36
37 The six routines are:
38
39     SV*  newSViv(IV);
40     SV*  newSVnv(double);
41     SV*  newSVpv(const char*, int);
42     SV*  newSVpvn(const char*, int);
43     SV*  newSVpvf(const char*, ...);
44     SV*  newSVsv(SV*);
45
46 To change the value of an *already-existing* SV, there are seven routines:
47
48     void  sv_setiv(SV*, IV);
49     void  sv_setuv(SV*, UV);
50     void  sv_setnv(SV*, double);
51     void  sv_setpv(SV*, const char*);
52     void  sv_setpvn(SV*, const char*, int)
53     void  sv_setpvf(SV*, const char*, ...);
54     void  sv_setpvfn(SV*, const char*, STRLEN, va_list *, SV **, I32, bool);
55     void  sv_setsv(SV*, SV*);
56
57 Notice that you can choose to specify the length of the string to be
58 assigned by using C<sv_setpvn>, C<newSVpvn>, or C<newSVpv>, or you may
59 allow Perl to calculate the length by using C<sv_setpv> or by specifying
60 0 as the second argument to C<newSVpv>.  Be warned, though, that Perl will
61 determine the string's length by using C<strlen>, which depends on the
62 string terminating with a NUL character.
63
64 The arguments of C<sv_setpvf> are processed like C<sprintf>, and the
65 formatted output becomes the value.
66
67 C<sv_setpvfn> is an analogue of C<vsprintf>, but it allows you to specify
68 either a pointer to a variable argument list or the address and length of
69 an array of SVs.  The last argument points to a boolean; on return, if that
70 boolean is true, then locale-specific information has been used to format
71 the string, and the string's contents are therefore untrustworthy (see
72 L<perlsec>).  This pointer may be NULL if that information is not
73 important.  Note that this function requires you to specify the length of
74 the format.
75
76 The C<sv_set*()> functions are not generic enough to operate on values
77 that have "magic".  See L<Magic Virtual Tables> later in this document.
78
79 All SVs that contain strings should be terminated with a NUL character.
80 If it is not NUL-terminated there is a risk of
81 core dumps and corruptions from code which passes the string to C
82 functions or system calls which expect a NUL-terminated string.
83 Perl's own functions typically add a trailing NUL for this reason.
84 Nevertheless, you should be very careful when you pass a string stored
85 in an SV to a C function or system call.
86
87 To access the actual value that an SV points to, you can use the macros:
88
89     SvIV(SV*)
90     SvNV(SV*)
91     SvPV(SV*, STRLEN len)
92     SvPV_nolen(SV*)
93
94 which will automatically coerce the actual scalar type into an IV, double,
95 or string.
96
97 In the C<SvPV> macro, the length of the string returned is placed into the
98 variable C<len> (this is a macro, so you do I<not> use C<&len>).  If you do
99 not care what the length of the data is, use the C<SvPV_nolen> macro.
100 Historically the C<SvPV> macro with the global variable C<PL_na> has been
101 used in this case.  But that can be quite inefficient because C<PL_na> must
102 be accessed in thread-local storage in threaded Perl.  In any case, remember
103 that Perl allows arbitrary strings of data that may both contain NULs and
104 might not be terminated by a NUL.
105
106 Also remember that C doesn't allow you to safely say C<foo(SvPV(s, len),
107 len);>. It might work with your compiler, but it won't work for everyone.
108 Break this sort of statement up into separate assignments:
109
110         STRLEN len;
111         char * ptr;
112         ptr = SvPV(len);
113         foo(ptr, len);
114
115 If you want to know if the scalar value is TRUE, you can use:
116
117     SvTRUE(SV*)
118
119 Although Perl will automatically grow strings for you, if you need to force
120 Perl to allocate more memory for your SV, you can use the macro
121
122     SvGROW(SV*, STRLEN newlen)
123
124 which will determine if more memory needs to be allocated.  If so, it will
125 call the function C<sv_grow>.  Note that C<SvGROW> can only increase, not
126 decrease, the allocated memory of an SV and that it does not automatically
127 add a byte for the a trailing NUL (perl's own string functions typically do
128 C<SvGROW(sv, len + 1)>).
129
130 If you have an SV and want to know what kind of data Perl thinks is stored
131 in it, you can use the following macros to check the type of SV you have.
132
133     SvIOK(SV*)
134     SvNOK(SV*)
135     SvPOK(SV*)
136
137 You can get and set the current length of the string stored in an SV with
138 the following macros:
139
140     SvCUR(SV*)
141     SvCUR_set(SV*, I32 val)
142
143 You can also get a pointer to the end of the string stored in the SV
144 with the macro:
145
146     SvEND(SV*)
147
148 But note that these last three macros are valid only if C<SvPOK()> is true.
149
150 If you want to append something to the end of string stored in an C<SV*>,
151 you can use the following functions:
152
153     void  sv_catpv(SV*, const char*);
154     void  sv_catpvn(SV*, const char*, STRLEN);
155     void  sv_catpvf(SV*, const char*, ...);
156     void  sv_catpvfn(SV*, const char*, STRLEN, va_list *, SV **, I32, bool);
157     void  sv_catsv(SV*, SV*);
158
159 The first function calculates the length of the string to be appended by
160 using C<strlen>.  In the second, you specify the length of the string
161 yourself.  The third function processes its arguments like C<sprintf> and
162 appends the formatted output.  The fourth function works like C<vsprintf>.
163 You can specify the address and length of an array of SVs instead of the
164 va_list argument. The fifth function extends the string stored in the first
165 SV with the string stored in the second SV.  It also forces the second SV
166 to be interpreted as a string.
167
168 The C<sv_cat*()> functions are not generic enough to operate on values that
169 have "magic".  See L<Magic Virtual Tables> later in this document.
170
171 If you know the name of a scalar variable, you can get a pointer to its SV
172 by using the following:
173
174     SV*  perl_get_sv("package::varname", FALSE);
175
176 This returns NULL if the variable does not exist.
177
178 If you want to know if this variable (or any other SV) is actually C<defined>,
179 you can call:
180
181     SvOK(SV*)
182
183 The scalar C<undef> value is stored in an SV instance called C<PL_sv_undef>.  Its
184 address can be used whenever an C<SV*> is needed.
185
186 There are also the two values C<PL_sv_yes> and C<PL_sv_no>, which contain Boolean
187 TRUE and FALSE values, respectively.  Like C<PL_sv_undef>, their addresses can
188 be used whenever an C<SV*> is needed.
189
190 Do not be fooled into thinking that C<(SV *) 0> is the same as C<&PL_sv_undef>.
191 Take this code:
192
193     SV* sv = (SV*) 0;
194     if (I-am-to-return-a-real-value) {
195             sv = sv_2mortal(newSViv(42));
196     }
197     sv_setsv(ST(0), sv);
198
199 This code tries to return a new SV (which contains the value 42) if it should
200 return a real value, or undef otherwise.  Instead it has returned a NULL
201 pointer which, somewhere down the line, will cause a segmentation violation,
202 bus error, or just weird results.  Change the zero to C<&PL_sv_undef> in the first
203 line and all will be well.
204
205 To free an SV that you've created, call C<SvREFCNT_dec(SV*)>.  Normally this
206 call is not necessary (see L<Reference Counts and Mortality>).
207
208 =head2 What's Really Stored in an SV?
209
210 Recall that the usual method of determining the type of scalar you have is
211 to use C<Sv*OK> macros.  Because a scalar can be both a number and a string,
212 usually these macros will always return TRUE and calling the C<Sv*V>
213 macros will do the appropriate conversion of string to integer/double or
214 integer/double to string.
215
216 If you I<really> need to know if you have an integer, double, or string
217 pointer in an SV, you can use the following three macros instead:
218
219     SvIOKp(SV*)
220     SvNOKp(SV*)
221     SvPOKp(SV*)
222
223 These will tell you if you truly have an integer, double, or string pointer
224 stored in your SV.  The "p" stands for private.
225
226 In general, though, it's best to use the C<Sv*V> macros.
227
228 =head2 Working with AVs
229
230 There are two ways to create and load an AV.  The first method creates an
231 empty AV:
232
233     AV*  newAV();
234
235 The second method both creates the AV and initially populates it with SVs:
236
237     AV*  av_make(I32 num, SV **ptr);
238
239 The second argument points to an array containing C<num> C<SV*>'s.  Once the
240 AV has been created, the SVs can be destroyed, if so desired.
241
242 Once the AV has been created, the following operations are possible on AVs:
243
244     void  av_push(AV*, SV*);
245     SV*   av_pop(AV*);
246     SV*   av_shift(AV*);
247     void  av_unshift(AV*, I32 num);
248
249 These should be familiar operations, with the exception of C<av_unshift>.
250 This routine adds C<num> elements at the front of the array with the C<undef>
251 value.  You must then use C<av_store> (described below) to assign values
252 to these new elements.
253
254 Here are some other functions:
255
256     I32   av_len(AV*);
257     SV**  av_fetch(AV*, I32 key, I32 lval);
258     SV**  av_store(AV*, I32 key, SV* val);
259
260 The C<av_len> function returns the highest index value in array (just
261 like $#array in Perl).  If the array is empty, -1 is returned.  The
262 C<av_fetch> function returns the value at index C<key>, but if C<lval>
263 is non-zero, then C<av_fetch> will store an undef value at that index.
264 The C<av_store> function stores the value C<val> at index C<key>, and does
265 not increment the reference count of C<val>.  Thus the caller is responsible
266 for taking care of that, and if C<av_store> returns NULL, the caller will
267 have to decrement the reference count to avoid a memory leak.  Note that
268 C<av_fetch> and C<av_store> both return C<SV**>'s, not C<SV*>'s as their
269 return value.
270
271     void  av_clear(AV*);
272     void  av_undef(AV*);
273     void  av_extend(AV*, I32 key);
274
275 The C<av_clear> function deletes all the elements in the AV* array, but
276 does not actually delete the array itself.  The C<av_undef> function will
277 delete all the elements in the array plus the array itself.  The
278 C<av_extend> function extends the array so that it contains at least C<key+1>
279 elements.  If C<key+1> is less than the currently allocated length of the array,
280 then nothing is done.
281
282 If you know the name of an array variable, you can get a pointer to its AV
283 by using the following:
284
285     AV*  perl_get_av("package::varname", FALSE);
286
287 This returns NULL if the variable does not exist.
288
289 See L<Understanding the Magic of Tied Hashes and Arrays> for more
290 information on how to use the array access functions on tied arrays.
291
292 =head2 Working with HVs
293
294 To create an HV, you use the following routine:
295
296     HV*  newHV();
297
298 Once the HV has been created, the following operations are possible on HVs:
299
300     SV**  hv_store(HV*, const char* key, U32 klen, SV* val, U32 hash);
301     SV**  hv_fetch(HV*, const char* key, U32 klen, I32 lval);
302
303 The C<klen> parameter is the length of the key being passed in (Note that
304 you cannot pass 0 in as a value of C<klen> to tell Perl to measure the
305 length of the key).  The C<val> argument contains the SV pointer to the
306 scalar being stored, and C<hash> is the precomputed hash value (zero if
307 you want C<hv_store> to calculate it for you).  The C<lval> parameter
308 indicates whether this fetch is actually a part of a store operation, in
309 which case a new undefined value will be added to the HV with the supplied
310 key and C<hv_fetch> will return as if the value had already existed.
311
312 Remember that C<hv_store> and C<hv_fetch> return C<SV**>'s and not just
313 C<SV*>.  To access the scalar value, you must first dereference the return
314 value.  However, you should check to make sure that the return value is
315 not NULL before dereferencing it.
316
317 These two functions check if a hash table entry exists, and deletes it.
318
319     bool  hv_exists(HV*, const char* key, U32 klen);
320     SV*   hv_delete(HV*, const char* key, U32 klen, I32 flags);
321
322 If C<flags> does not include the C<G_DISCARD> flag then C<hv_delete> will
323 create and return a mortal copy of the deleted value.
324
325 And more miscellaneous functions:
326
327     void   hv_clear(HV*);
328     void   hv_undef(HV*);
329
330 Like their AV counterparts, C<hv_clear> deletes all the entries in the hash
331 table but does not actually delete the hash table.  The C<hv_undef> deletes
332 both the entries and the hash table itself.
333
334 Perl keeps the actual data in linked list of structures with a typedef of HE.
335 These contain the actual key and value pointers (plus extra administrative
336 overhead).  The key is a string pointer; the value is an C<SV*>.  However,
337 once you have an C<HE*>, to get the actual key and value, use the routines
338 specified below.
339
340     I32    hv_iterinit(HV*);
341             /* Prepares starting point to traverse hash table */
342     HE*    hv_iternext(HV*);
343             /* Get the next entry, and return a pointer to a
344                structure that has both the key and value */
345     char*  hv_iterkey(HE* entry, I32* retlen);
346             /* Get the key from an HE structure and also return
347                the length of the key string */
348     SV*    hv_iterval(HV*, HE* entry);
349             /* Return a SV pointer to the value of the HE
350                structure */
351     SV*    hv_iternextsv(HV*, char** key, I32* retlen);
352             /* This convenience routine combines hv_iternext,
353                hv_iterkey, and hv_iterval.  The key and retlen
354                arguments are return values for the key and its
355                length.  The value is returned in the SV* argument */
356
357 If you know the name of a hash variable, you can get a pointer to its HV
358 by using the following:
359
360     HV*  perl_get_hv("package::varname", FALSE);
361
362 This returns NULL if the variable does not exist.
363
364 The hash algorithm is defined in the C<PERL_HASH(hash, key, klen)> macro:
365
366     hash = 0;
367     while (klen--)
368         hash = (hash * 33) + *key++;
369     hash = hash + (hash >> 5);                  /* after 5.6 */
370
371 The last step was added in version 5.6 to improve distribution of
372 lower bits in the resulting hash value.
373
374 See L<Understanding the Magic of Tied Hashes and Arrays> for more
375 information on how to use the hash access functions on tied hashes.
376
377 =head2 Hash API Extensions
378
379 Beginning with version 5.004, the following functions are also supported:
380
381     HE*     hv_fetch_ent  (HV* tb, SV* key, I32 lval, U32 hash);
382     HE*     hv_store_ent  (HV* tb, SV* key, SV* val, U32 hash);
383     
384     bool    hv_exists_ent (HV* tb, SV* key, U32 hash);
385     SV*     hv_delete_ent (HV* tb, SV* key, I32 flags, U32 hash);
386     
387     SV*     hv_iterkeysv  (HE* entry);
388
389 Note that these functions take C<SV*> keys, which simplifies writing
390 of extension code that deals with hash structures.  These functions
391 also allow passing of C<SV*> keys to C<tie> functions without forcing
392 you to stringify the keys (unlike the previous set of functions).
393
394 They also return and accept whole hash entries (C<HE*>), making their
395 use more efficient (since the hash number for a particular string
396 doesn't have to be recomputed every time).  See L<API LISTING> later in
397 this document for detailed descriptions.
398
399 The following macros must always be used to access the contents of hash
400 entries.  Note that the arguments to these macros must be simple
401 variables, since they may get evaluated more than once.  See
402 L<API LISTING> later in this document for detailed descriptions of these
403 macros.
404
405     HePV(HE* he, STRLEN len)
406     HeVAL(HE* he)
407     HeHASH(HE* he)
408     HeSVKEY(HE* he)
409     HeSVKEY_force(HE* he)
410     HeSVKEY_set(HE* he, SV* sv)
411
412 These two lower level macros are defined, but must only be used when
413 dealing with keys that are not C<SV*>s:
414
415     HeKEY(HE* he)
416     HeKLEN(HE* he)
417
418 Note that both C<hv_store> and C<hv_store_ent> do not increment the
419 reference count of the stored C<val>, which is the caller's responsibility.
420 If these functions return a NULL value, the caller will usually have to
421 decrement the reference count of C<val> to avoid a memory leak.
422
423 =head2 References
424
425 References are a special type of scalar that point to other data types
426 (including references).
427
428 To create a reference, use either of the following functions:
429
430     SV* newRV_inc((SV*) thing);
431     SV* newRV_noinc((SV*) thing);
432
433 The C<thing> argument can be any of an C<SV*>, C<AV*>, or C<HV*>.  The
434 functions are identical except that C<newRV_inc> increments the reference
435 count of the C<thing>, while C<newRV_noinc> does not.  For historical
436 reasons, C<newRV> is a synonym for C<newRV_inc>.
437
438 Once you have a reference, you can use the following macro to dereference
439 the reference:
440
441     SvRV(SV*)
442
443 then call the appropriate routines, casting the returned C<SV*> to either an
444 C<AV*> or C<HV*>, if required.
445
446 To determine if an SV is a reference, you can use the following macro:
447
448     SvROK(SV*)
449
450 To discover what type of value the reference refers to, use the following
451 macro and then check the return value.
452
453     SvTYPE(SvRV(SV*))
454
455 The most useful types that will be returned are:
456
457     SVt_IV    Scalar
458     SVt_NV    Scalar
459     SVt_PV    Scalar
460     SVt_RV    Scalar
461     SVt_PVAV  Array
462     SVt_PVHV  Hash
463     SVt_PVCV  Code
464     SVt_PVGV  Glob (possible a file handle)
465     SVt_PVMG  Blessed or Magical Scalar
466
467     See the sv.h header file for more details.
468
469 =head2 Blessed References and Class Objects
470
471 References are also used to support object-oriented programming.  In the
472 OO lexicon, an object is simply a reference that has been blessed into a
473 package (or class).  Once blessed, the programmer may now use the reference
474 to access the various methods in the class.
475
476 A reference can be blessed into a package with the following function:
477
478     SV* sv_bless(SV* sv, HV* stash);
479
480 The C<sv> argument must be a reference.  The C<stash> argument specifies
481 which class the reference will belong to.  See
482 L<Stashes and Globs> for information on converting class names into stashes.
483
484 /* Still under construction */
485
486 Upgrades rv to reference if not already one.  Creates new SV for rv to
487 point to.  If C<classname> is non-null, the SV is blessed into the specified
488 class.  SV is returned.
489
490         SV* newSVrv(SV* rv, const char* classname);
491
492 Copies integer or double into an SV whose reference is C<rv>.  SV is blessed
493 if C<classname> is non-null.
494
495         SV* sv_setref_iv(SV* rv, const char* classname, IV iv);
496         SV* sv_setref_nv(SV* rv, const char* classname, NV iv);
497
498 Copies the pointer value (I<the address, not the string!>) into an SV whose
499 reference is rv.  SV is blessed if C<classname> is non-null.
500
501         SV* sv_setref_pv(SV* rv, const char* classname, PV iv);
502
503 Copies string into an SV whose reference is C<rv>.  Set length to 0 to let
504 Perl calculate the string length.  SV is blessed if C<classname> is non-null.
505
506         SV* sv_setref_pvn(SV* rv, const char* classname, PV iv, STRLEN length);
507
508 Tests whether the SV is blessed into the specified class.  It does not
509 check inheritance relationships.
510
511         int  sv_isa(SV* sv, const char* name);
512
513 Tests whether the SV is a reference to a blessed object.
514
515         int  sv_isobject(SV* sv);
516
517 Tests whether the SV is derived from the specified class. SV can be either
518 a reference to a blessed object or a string containing a class name. This
519 is the function implementing the C<UNIVERSAL::isa> functionality.
520
521         bool sv_derived_from(SV* sv, const char* name);
522
523 To check if you've got an object derived from a specific class you have 
524 to write:
525
526         if (sv_isobject(sv) && sv_derived_from(sv, class)) { ... }
527
528 =head2 Creating New Variables
529
530 To create a new Perl variable with an undef value which can be accessed from
531 your Perl script, use the following routines, depending on the variable type.
532
533     SV*  perl_get_sv("package::varname", TRUE);
534     AV*  perl_get_av("package::varname", TRUE);
535     HV*  perl_get_hv("package::varname", TRUE);
536
537 Notice the use of TRUE as the second parameter.  The new variable can now
538 be set, using the routines appropriate to the data type.
539
540 There are additional macros whose values may be bitwise OR'ed with the
541 C<TRUE> argument to enable certain extra features.  Those bits are:
542
543     GV_ADDMULTI Marks the variable as multiply defined, thus preventing the
544                 "Name <varname> used only once: possible typo" warning.
545     GV_ADDWARN  Issues the warning "Had to create <varname> unexpectedly" if
546                 the variable did not exist before the function was called.
547
548 If you do not specify a package name, the variable is created in the current
549 package.
550
551 =head2 Reference Counts and Mortality
552
553 Perl uses an reference count-driven garbage collection mechanism. SVs,
554 AVs, or HVs (xV for short in the following) start their life with a
555 reference count of 1.  If the reference count of an xV ever drops to 0,
556 then it will be destroyed and its memory made available for reuse.
557
558 This normally doesn't happen at the Perl level unless a variable is
559 undef'ed or the last variable holding a reference to it is changed or
560 overwritten.  At the internal level, however, reference counts can be
561 manipulated with the following macros:
562
563     int SvREFCNT(SV* sv);
564     SV* SvREFCNT_inc(SV* sv);
565     void SvREFCNT_dec(SV* sv);
566
567 However, there is one other function which manipulates the reference
568 count of its argument.  The C<newRV_inc> function, you will recall,
569 creates a reference to the specified argument.  As a side effect,
570 it increments the argument's reference count.  If this is not what
571 you want, use C<newRV_noinc> instead.
572
573 For example, imagine you want to return a reference from an XSUB function.
574 Inside the XSUB routine, you create an SV which initially has a reference
575 count of one.  Then you call C<newRV_inc>, passing it the just-created SV.
576 This returns the reference as a new SV, but the reference count of the
577 SV you passed to C<newRV_inc> has been incremented to two.  Now you
578 return the reference from the XSUB routine and forget about the SV.
579 But Perl hasn't!  Whenever the returned reference is destroyed, the
580 reference count of the original SV is decreased to one and nothing happens.
581 The SV will hang around without any way to access it until Perl itself
582 terminates.  This is a memory leak.
583
584 The correct procedure, then, is to use C<newRV_noinc> instead of
585 C<newRV_inc>.  Then, if and when the last reference is destroyed,
586 the reference count of the SV will go to zero and it will be destroyed,
587 stopping any memory leak.
588
589 There are some convenience functions available that can help with the
590 destruction of xVs.  These functions introduce the concept of "mortality".
591 An xV that is mortal has had its reference count marked to be decremented,
592 but not actually decremented, until "a short time later".  Generally the
593 term "short time later" means a single Perl statement, such as a call to
594 an XSUB function.  The actual determinant for when mortal xVs have their
595 reference count decremented depends on two macros, SAVETMPS and FREETMPS.
596 See L<perlcall> and L<perlxs> for more details on these macros.
597
598 "Mortalization" then is at its simplest a deferred C<SvREFCNT_dec>.
599 However, if you mortalize a variable twice, the reference count will
600 later be decremented twice.
601
602 You should be careful about creating mortal variables.  Strange things
603 can happen if you make the same value mortal within multiple contexts,
604 or if you make a variable mortal multiple times.
605
606 To create a mortal variable, use the functions:
607
608     SV*  sv_newmortal()
609     SV*  sv_2mortal(SV*)
610     SV*  sv_mortalcopy(SV*)
611
612 The first call creates a mortal SV, the second converts an existing
613 SV to a mortal SV (and thus defers a call to C<SvREFCNT_dec>), and the
614 third creates a mortal copy of an existing SV.
615
616 The mortal routines are not just for SVs -- AVs and HVs can be
617 made mortal by passing their address (type-casted to C<SV*>) to the
618 C<sv_2mortal> or C<sv_mortalcopy> routines.
619
620 =head2 Stashes and Globs
621
622 A "stash" is a hash that contains all of the different objects that
623 are contained within a package.  Each key of the stash is a symbol
624 name (shared by all the different types of objects that have the same
625 name), and each value in the hash table is a GV (Glob Value).  This GV
626 in turn contains references to the various objects of that name,
627 including (but not limited to) the following:
628
629     Scalar Value
630     Array Value
631     Hash Value
632     I/O Handle
633     Format
634     Subroutine
635
636 There is a single stash called "PL_defstash" that holds the items that exist
637 in the "main" package.  To get at the items in other packages, append the
638 string "::" to the package name.  The items in the "Foo" package are in
639 the stash "Foo::" in PL_defstash.  The items in the "Bar::Baz" package are
640 in the stash "Baz::" in "Bar::"'s stash.
641
642 To get the stash pointer for a particular package, use the function:
643
644     HV*  gv_stashpv(const char* name, I32 create)
645     HV*  gv_stashsv(SV*, I32 create)
646
647 The first function takes a literal string, the second uses the string stored
648 in the SV.  Remember that a stash is just a hash table, so you get back an
649 C<HV*>.  The C<create> flag will create a new package if it is set.
650
651 The name that C<gv_stash*v> wants is the name of the package whose symbol table
652 you want.  The default package is called C<main>.  If you have multiply nested
653 packages, pass their names to C<gv_stash*v>, separated by C<::> as in the Perl
654 language itself.
655
656 Alternately, if you have an SV that is a blessed reference, you can find
657 out the stash pointer by using:
658
659     HV*  SvSTASH(SvRV(SV*));
660
661 then use the following to get the package name itself:
662
663     char*  HvNAME(HV* stash);
664
665 If you need to bless or re-bless an object you can use the following
666 function:
667
668     SV*  sv_bless(SV*, HV* stash)
669
670 where the first argument, an C<SV*>, must be a reference, and the second
671 argument is a stash.  The returned C<SV*> can now be used in the same way
672 as any other SV.
673
674 For more information on references and blessings, consult L<perlref>.
675
676 =head2 Double-Typed SVs
677
678 Scalar variables normally contain only one type of value, an integer,
679 double, pointer, or reference.  Perl will automatically convert the
680 actual scalar data from the stored type into the requested type.
681
682 Some scalar variables contain more than one type of scalar data.  For
683 example, the variable C<$!> contains either the numeric value of C<errno>
684 or its string equivalent from either C<strerror> or C<sys_errlist[]>.
685
686 To force multiple data values into an SV, you must do two things: use the
687 C<sv_set*v> routines to add the additional scalar type, then set a flag
688 so that Perl will believe it contains more than one type of data.  The
689 four macros to set the flags are:
690
691         SvIOK_on
692         SvNOK_on
693         SvPOK_on
694         SvROK_on
695
696 The particular macro you must use depends on which C<sv_set*v> routine
697 you called first.  This is because every C<sv_set*v> routine turns on
698 only the bit for the particular type of data being set, and turns off
699 all the rest.
700
701 For example, to create a new Perl variable called "dberror" that contains
702 both the numeric and descriptive string error values, you could use the
703 following code:
704
705     extern int  dberror;
706     extern char *dberror_list;
707
708     SV* sv = perl_get_sv("dberror", TRUE);
709     sv_setiv(sv, (IV) dberror);
710     sv_setpv(sv, dberror_list[dberror]);
711     SvIOK_on(sv);
712
713 If the order of C<sv_setiv> and C<sv_setpv> had been reversed, then the
714 macro C<SvPOK_on> would need to be called instead of C<SvIOK_on>.
715
716 =head2 Magic Variables
717
718 [This section still under construction.  Ignore everything here.  Post no
719 bills.  Everything not permitted is forbidden.]
720
721 Any SV may be magical, that is, it has special features that a normal
722 SV does not have.  These features are stored in the SV structure in a
723 linked list of C<struct magic>'s, typedef'ed to C<MAGIC>.
724
725     struct magic {
726         MAGIC*      mg_moremagic;
727         MGVTBL*     mg_virtual;
728         U16         mg_private;
729         char        mg_type;
730         U8          mg_flags;
731         SV*         mg_obj;
732         char*       mg_ptr;
733         I32         mg_len;
734     };
735
736 Note this is current as of patchlevel 0, and could change at any time.
737
738 =head2 Assigning Magic
739
740 Perl adds magic to an SV using the sv_magic function:
741
742     void sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen);
743
744 The C<sv> argument is a pointer to the SV that is to acquire a new magical
745 feature.
746
747 If C<sv> is not already magical, Perl uses the C<SvUPGRADE> macro to
748 set the C<SVt_PVMG> flag for the C<sv>.  Perl then continues by adding
749 it to the beginning of the linked list of magical features.  Any prior
750 entry of the same type of magic is deleted.  Note that this can be
751 overridden, and multiple instances of the same type of magic can be
752 associated with an SV.
753
754 The C<name> and C<namlen> arguments are used to associate a string with
755 the magic, typically the name of a variable. C<namlen> is stored in the
756 C<mg_len> field and if C<name> is non-null and C<namlen> >= 0 a malloc'd
757 copy of the name is stored in C<mg_ptr> field.
758
759 The sv_magic function uses C<how> to determine which, if any, predefined
760 "Magic Virtual Table" should be assigned to the C<mg_virtual> field.
761 See the "Magic Virtual Table" section below.  The C<how> argument is also
762 stored in the C<mg_type> field.
763
764 The C<obj> argument is stored in the C<mg_obj> field of the C<MAGIC>
765 structure.  If it is not the same as the C<sv> argument, the reference
766 count of the C<obj> object is incremented.  If it is the same, or if
767 the C<how> argument is "#", or if it is a NULL pointer, then C<obj> is
768 merely stored, without the reference count being incremented.
769
770 There is also a function to add magic to an C<HV>:
771
772     void hv_magic(HV *hv, GV *gv, int how);
773
774 This simply calls C<sv_magic> and coerces the C<gv> argument into an C<SV>.
775
776 To remove the magic from an SV, call the function sv_unmagic:
777
778     void sv_unmagic(SV *sv, int type);
779
780 The C<type> argument should be equal to the C<how> value when the C<SV>
781 was initially made magical.
782
783 =head2 Magic Virtual Tables
784
785 The C<mg_virtual> field in the C<MAGIC> structure is a pointer to a
786 C<MGVTBL>, which is a structure of function pointers and stands for
787 "Magic Virtual Table" to handle the various operations that might be
788 applied to that variable.
789
790 The C<MGVTBL> has five pointers to the following routine types:
791
792     int  (*svt_get)(SV* sv, MAGIC* mg);
793     int  (*svt_set)(SV* sv, MAGIC* mg);
794     U32  (*svt_len)(SV* sv, MAGIC* mg);
795     int  (*svt_clear)(SV* sv, MAGIC* mg);
796     int  (*svt_free)(SV* sv, MAGIC* mg);
797
798 This MGVTBL structure is set at compile-time in C<perl.h> and there are
799 currently 19 types (or 21 with overloading turned on).  These different
800 structures contain pointers to various routines that perform additional
801 actions depending on which function is being called.
802
803     Function pointer    Action taken
804     ----------------    ------------
805     svt_get             Do something after the value of the SV is retrieved.
806     svt_set             Do something after the SV is assigned a value.
807     svt_len             Report on the SV's length.
808     svt_clear           Clear something the SV represents.
809     svt_free            Free any extra storage associated with the SV.
810
811 For instance, the MGVTBL structure called C<vtbl_sv> (which corresponds
812 to an C<mg_type> of '\0') contains:
813
814     { magic_get, magic_set, magic_len, 0, 0 }
815
816 Thus, when an SV is determined to be magical and of type '\0', if a get
817 operation is being performed, the routine C<magic_get> is called.  All
818 the various routines for the various magical types begin with C<magic_>.
819
820 The current kinds of Magic Virtual Tables are:
821
822     mg_type  MGVTBL              Type of magic
823     -------  ------              ----------------------------
824     \0       vtbl_sv             Special scalar variable
825     A        vtbl_amagic         %OVERLOAD hash
826     a        vtbl_amagicelem     %OVERLOAD hash element
827     c        (none)              Holds overload table (AMT) on stash
828     B        vtbl_bm             Boyer-Moore (fast string search)
829     E        vtbl_env            %ENV hash
830     e        vtbl_envelem        %ENV hash element
831     f        vtbl_fm             Formline ('compiled' format)
832     g        vtbl_mglob          m//g target / study()ed string
833     I        vtbl_isa            @ISA array
834     i        vtbl_isaelem        @ISA array element
835     k        vtbl_nkeys          scalar(keys()) lvalue
836     L        (none)              Debugger %_<filename 
837     l        vtbl_dbline         Debugger %_<filename element
838     o        vtbl_collxfrm       Locale transformation
839     P        vtbl_pack           Tied array or hash
840     p        vtbl_packelem       Tied array or hash element
841     q        vtbl_packelem       Tied scalar or handle
842     S        vtbl_sig            %SIG hash
843     s        vtbl_sigelem        %SIG hash element
844     t        vtbl_taint          Taintedness
845     U        vtbl_uvar           Available for use by extensions
846     v        vtbl_vec            vec() lvalue
847     x        vtbl_substr         substr() lvalue
848     y        vtbl_defelem        Shadow "foreach" iterator variable /
849                                   smart parameter vivification
850     *        vtbl_glob           GV (typeglob)
851     #        vtbl_arylen         Array length ($#ary)
852     .        vtbl_pos            pos() lvalue
853     ~        (none)              Available for use by extensions
854
855 When an uppercase and lowercase letter both exist in the table, then the
856 uppercase letter is used to represent some kind of composite type (a list
857 or a hash), and the lowercase letter is used to represent an element of
858 that composite type.
859
860 The '~' and 'U' magic types are defined specifically for use by
861 extensions and will not be used by perl itself.  Extensions can use
862 '~' magic to 'attach' private information to variables (typically
863 objects).  This is especially useful because there is no way for
864 normal perl code to corrupt this private information (unlike using
865 extra elements of a hash object).
866
867 Similarly, 'U' magic can be used much like tie() to call a C function
868 any time a scalar's value is used or changed.  The C<MAGIC>'s
869 C<mg_ptr> field points to a C<ufuncs> structure:
870
871     struct ufuncs {
872         I32 (*uf_val)(IV, SV*);
873         I32 (*uf_set)(IV, SV*);
874         IV uf_index;
875     };
876
877 When the SV is read from or written to, the C<uf_val> or C<uf_set>
878 function will be called with C<uf_index> as the first arg and a
879 pointer to the SV as the second.  A simple example of how to add 'U'
880 magic is shown below.  Note that the ufuncs structure is copied by
881 sv_magic, so you can safely allocate it on the stack.
882
883     void
884     Umagic(sv)
885         SV *sv;
886     PREINIT:
887         struct ufuncs uf;
888     CODE:
889         uf.uf_val   = &my_get_fn;
890         uf.uf_set   = &my_set_fn;
891         uf.uf_index = 0;
892         sv_magic(sv, 0, 'U', (char*)&uf, sizeof(uf));
893
894 Note that because multiple extensions may be using '~' or 'U' magic,
895 it is important for extensions to take extra care to avoid conflict.
896 Typically only using the magic on objects blessed into the same class
897 as the extension is sufficient.  For '~' magic, it may also be
898 appropriate to add an I32 'signature' at the top of the private data
899 area and check that.
900
901 Also note that the C<sv_set*()> and C<sv_cat*()> functions described
902 earlier do B<not> invoke 'set' magic on their targets.  This must
903 be done by the user either by calling the C<SvSETMAGIC()> macro after
904 calling these functions, or by using one of the C<sv_set*_mg()> or
905 C<sv_cat*_mg()> functions.  Similarly, generic C code must call the
906 C<SvGETMAGIC()> macro to invoke any 'get' magic if they use an SV
907 obtained from external sources in functions that don't handle magic.
908 L<API LISTING> later in this document identifies such functions.
909 For example, calls to the C<sv_cat*()> functions typically need to be
910 followed by C<SvSETMAGIC()>, but they don't need a prior C<SvGETMAGIC()>
911 since their implementation handles 'get' magic.
912
913 =head2 Finding Magic
914
915     MAGIC* mg_find(SV*, int type); /* Finds the magic pointer of that type */
916
917 This routine returns a pointer to the C<MAGIC> structure stored in the SV.
918 If the SV does not have that magical feature, C<NULL> is returned.  Also,
919 if the SV is not of type SVt_PVMG, Perl may core dump.
920
921     int mg_copy(SV* sv, SV* nsv, const char* key, STRLEN klen);
922
923 This routine checks to see what types of magic C<sv> has.  If the mg_type
924 field is an uppercase letter, then the mg_obj is copied to C<nsv>, but
925 the mg_type field is changed to be the lowercase letter.
926
927 =head2 Understanding the Magic of Tied Hashes and Arrays
928
929 Tied hashes and arrays are magical beasts of the 'P' magic type.
930
931 WARNING: As of the 5.004 release, proper usage of the array and hash
932 access functions requires understanding a few caveats.  Some
933 of these caveats are actually considered bugs in the API, to be fixed
934 in later releases, and are bracketed with [MAYCHANGE] below. If
935 you find yourself actually applying such information in this section, be
936 aware that the behavior may change in the future, umm, without warning.
937
938 The perl tie function associates a variable with an object that implements
939 the various GET, SET etc methods.  To perform the equivalent of the perl
940 tie function from an XSUB, you must mimic this behaviour.  The code below
941 carries out the necessary steps - firstly it creates a new hash, and then
942 creates a second hash which it blesses into the class which will implement
943 the tie methods. Lastly it ties the two hashes together, and returns a
944 reference to the new tied hash.  Note that the code below does NOT call the
945 TIEHASH method in the MyTie class -
946 see L<Calling Perl Routines from within C Programs> for details on how
947 to do this.
948
949     SV*
950     mytie()
951     PREINIT:
952         HV *hash;
953         HV *stash;
954         SV *tie;
955     CODE:
956         hash = newHV();
957         tie = newRV_noinc((SV*)newHV());
958         stash = gv_stashpv("MyTie", TRUE);
959         sv_bless(tie, stash);
960         hv_magic(hash, tie, 'P');
961         RETVAL = newRV_noinc(hash);
962     OUTPUT:
963         RETVAL
964
965 The C<av_store> function, when given a tied array argument, merely
966 copies the magic of the array onto the value to be "stored", using
967 C<mg_copy>.  It may also return NULL, indicating that the value did not
968 actually need to be stored in the array.  [MAYCHANGE] After a call to
969 C<av_store> on a tied array, the caller will usually need to call
970 C<mg_set(val)> to actually invoke the perl level "STORE" method on the
971 TIEARRAY object.  If C<av_store> did return NULL, a call to
972 C<SvREFCNT_dec(val)> will also be usually necessary to avoid a memory
973 leak. [/MAYCHANGE]
974
975 The previous paragraph is applicable verbatim to tied hash access using the
976 C<hv_store> and C<hv_store_ent> functions as well.
977
978 C<av_fetch> and the corresponding hash functions C<hv_fetch> and
979 C<hv_fetch_ent> actually return an undefined mortal value whose magic
980 has been initialized using C<mg_copy>.  Note the value so returned does not
981 need to be deallocated, as it is already mortal.  [MAYCHANGE] But you will
982 need to call C<mg_get()> on the returned value in order to actually invoke
983 the perl level "FETCH" method on the underlying TIE object.  Similarly,
984 you may also call C<mg_set()> on the return value after possibly assigning
985 a suitable value to it using C<sv_setsv>,  which will invoke the "STORE"
986 method on the TIE object. [/MAYCHANGE]
987
988 [MAYCHANGE]
989 In other words, the array or hash fetch/store functions don't really
990 fetch and store actual values in the case of tied arrays and hashes.  They
991 merely call C<mg_copy> to attach magic to the values that were meant to be
992 "stored" or "fetched".  Later calls to C<mg_get> and C<mg_set> actually
993 do the job of invoking the TIE methods on the underlying objects.  Thus
994 the magic mechanism currently implements a kind of lazy access to arrays
995 and hashes.
996
997 Currently (as of perl version 5.004), use of the hash and array access
998 functions requires the user to be aware of whether they are operating on
999 "normal" hashes and arrays, or on their tied variants.  The API may be
1000 changed to provide more transparent access to both tied and normal data
1001 types in future versions.
1002 [/MAYCHANGE]
1003
1004 You would do well to understand that the TIEARRAY and TIEHASH interfaces
1005 are mere sugar to invoke some perl method calls while using the uniform hash
1006 and array syntax.  The use of this sugar imposes some overhead (typically
1007 about two to four extra opcodes per FETCH/STORE operation, in addition to
1008 the creation of all the mortal variables required to invoke the methods).
1009 This overhead will be comparatively small if the TIE methods are themselves
1010 substantial, but if they are only a few statements long, the overhead
1011 will not be insignificant.
1012
1013 =head2 Localizing changes
1014
1015 Perl has a very handy construction
1016
1017   {
1018     local $var = 2;
1019     ...
1020   }
1021
1022 This construction is I<approximately> equivalent to
1023
1024   {
1025     my $oldvar = $var;
1026     $var = 2;
1027     ...
1028     $var = $oldvar;
1029   }
1030
1031 The biggest difference is that the first construction would
1032 reinstate the initial value of $var, irrespective of how control exits
1033 the block: C<goto>, C<return>, C<die>/C<eval> etc. It is a little bit
1034 more efficient as well.
1035
1036 There is a way to achieve a similar task from C via Perl API: create a
1037 I<pseudo-block>, and arrange for some changes to be automatically
1038 undone at the end of it, either explicit, or via a non-local exit (via
1039 die()). A I<block>-like construct is created by a pair of
1040 C<ENTER>/C<LEAVE> macros (see L<perlcall/"Returning a Scalar">).
1041 Such a construct may be created specially for some important localized
1042 task, or an existing one (like boundaries of enclosing Perl
1043 subroutine/block, or an existing pair for freeing TMPs) may be
1044 used. (In the second case the overhead of additional localization must
1045 be almost negligible.) Note that any XSUB is automatically enclosed in
1046 an C<ENTER>/C<LEAVE> pair.
1047
1048 Inside such a I<pseudo-block> the following service is available:
1049
1050 =over
1051
1052 =item C<SAVEINT(int i)>
1053
1054 =item C<SAVEIV(IV i)>
1055
1056 =item C<SAVEI32(I32 i)>
1057
1058 =item C<SAVELONG(long i)>
1059
1060 These macros arrange things to restore the value of integer variable
1061 C<i> at the end of enclosing I<pseudo-block>.
1062
1063 =item C<SAVESPTR(s)>
1064
1065 =item C<SAVEPPTR(p)>
1066
1067 These macros arrange things to restore the value of pointers C<s> and
1068 C<p>. C<s> must be a pointer of a type which survives conversion to
1069 C<SV*> and back, C<p> should be able to survive conversion to C<char*>
1070 and back.
1071
1072 =item C<SAVEFREESV(SV *sv)>
1073
1074 The refcount of C<sv> would be decremented at the end of
1075 I<pseudo-block>. This is similar to C<sv_2mortal>, which should (?) be
1076 used instead.
1077
1078 =item C<SAVEFREEOP(OP *op)>
1079
1080 The C<OP *> is op_free()ed at the end of I<pseudo-block>.
1081
1082 =item C<SAVEFREEPV(p)>
1083
1084 The chunk of memory which is pointed to by C<p> is Safefree()ed at the
1085 end of I<pseudo-block>.
1086
1087 =item C<SAVECLEARSV(SV *sv)>
1088
1089 Clears a slot in the current scratchpad which corresponds to C<sv> at
1090 the end of I<pseudo-block>.
1091
1092 =item C<SAVEDELETE(HV *hv, char *key, I32 length)>
1093
1094 The key C<key> of C<hv> is deleted at the end of I<pseudo-block>. The
1095 string pointed to by C<key> is Safefree()ed.  If one has a I<key> in
1096 short-lived storage, the corresponding string may be reallocated like
1097 this:
1098
1099   SAVEDELETE(PL_defstash, savepv(tmpbuf), strlen(tmpbuf));
1100
1101 =item C<SAVEDESTRUCTOR(f,p)>
1102
1103 At the end of I<pseudo-block> the function C<f> is called with the
1104 only argument (of type C<void*>) C<p>.
1105
1106 =item C<SAVESTACK_POS()>
1107
1108 The current offset on the Perl internal stack (cf. C<SP>) is restored
1109 at the end of I<pseudo-block>.
1110
1111 =back
1112
1113 The following API list contains functions, thus one needs to
1114 provide pointers to the modifiable data explicitly (either C pointers,
1115 or Perlish C<GV *>s).  Where the above macros take C<int>, a similar 
1116 function takes C<int *>.
1117
1118 =over
1119
1120 =item C<SV* save_scalar(GV *gv)>
1121
1122 Equivalent to Perl code C<local $gv>.
1123
1124 =item C<AV* save_ary(GV *gv)>
1125
1126 =item C<HV* save_hash(GV *gv)>
1127
1128 Similar to C<save_scalar>, but localize C<@gv> and C<%gv>.
1129
1130 =item C<void save_item(SV *item)>
1131
1132 Duplicates the current value of C<SV>, on the exit from the current
1133 C<ENTER>/C<LEAVE> I<pseudo-block> will restore the value of C<SV>
1134 using the stored value.
1135
1136 =item C<void save_list(SV **sarg, I32 maxsarg)>
1137
1138 A variant of C<save_item> which takes multiple arguments via an array
1139 C<sarg> of C<SV*> of length C<maxsarg>.
1140
1141 =item C<SV* save_svref(SV **sptr)>
1142
1143 Similar to C<save_scalar>, but will reinstate a C<SV *>.
1144
1145 =item C<void save_aptr(AV **aptr)>
1146
1147 =item C<void save_hptr(HV **hptr)>
1148
1149 Similar to C<save_svref>, but localize C<AV *> and C<HV *>.
1150
1151 =back
1152
1153 The C<Alias> module implements localization of the basic types within the
1154 I<caller's scope>.  People who are interested in how to localize things in
1155 the containing scope should take a look there too.
1156
1157 =head1 Subroutines
1158
1159 =head2 XSUBs and the Argument Stack
1160
1161 The XSUB mechanism is a simple way for Perl programs to access C subroutines.
1162 An XSUB routine will have a stack that contains the arguments from the Perl
1163 program, and a way to map from the Perl data structures to a C equivalent.
1164
1165 The stack arguments are accessible through the C<ST(n)> macro, which returns
1166 the C<n>'th stack argument.  Argument 0 is the first argument passed in the
1167 Perl subroutine call.  These arguments are C<SV*>, and can be used anywhere
1168 an C<SV*> is used.
1169
1170 Most of the time, output from the C routine can be handled through use of
1171 the RETVAL and OUTPUT directives.  However, there are some cases where the
1172 argument stack is not already long enough to handle all the return values.
1173 An example is the POSIX tzname() call, which takes no arguments, but returns
1174 two, the local time zone's standard and summer time abbreviations.
1175
1176 To handle this situation, the PPCODE directive is used and the stack is
1177 extended using the macro:
1178
1179     EXTEND(SP, num);
1180
1181 where C<SP> is the macro that represents the local copy of the stack pointer,
1182 and C<num> is the number of elements the stack should be extended by.
1183
1184 Now that there is room on the stack, values can be pushed on it using the
1185 macros to push IVs, doubles, strings, and SV pointers respectively:
1186
1187     PUSHi(IV)
1188     PUSHn(double)
1189     PUSHp(char*, I32)
1190     PUSHs(SV*)
1191
1192 And now the Perl program calling C<tzname>, the two values will be assigned
1193 as in:
1194
1195     ($standard_abbrev, $summer_abbrev) = POSIX::tzname;
1196
1197 An alternate (and possibly simpler) method to pushing values on the stack is
1198 to use the macros:
1199
1200     XPUSHi(IV)
1201     XPUSHn(double)
1202     XPUSHp(char*, I32)
1203     XPUSHs(SV*)
1204
1205 These macros automatically adjust the stack for you, if needed.  Thus, you
1206 do not need to call C<EXTEND> to extend the stack.
1207
1208 For more information, consult L<perlxs> and L<perlxstut>.
1209
1210 =head2 Calling Perl Routines from within C Programs
1211
1212 There are four routines that can be used to call a Perl subroutine from
1213 within a C program.  These four are:
1214
1215     I32  perl_call_sv(SV*, I32);
1216     I32  perl_call_pv(const char*, I32);
1217     I32  perl_call_method(const char*, I32);
1218     I32  perl_call_argv(const char*, I32, register char**);
1219
1220 The routine most often used is C<perl_call_sv>.  The C<SV*> argument
1221 contains either the name of the Perl subroutine to be called, or a
1222 reference to the subroutine.  The second argument consists of flags
1223 that control the context in which the subroutine is called, whether
1224 or not the subroutine is being passed arguments, how errors should be
1225 trapped, and how to treat return values.
1226
1227 All four routines return the number of arguments that the subroutine returned
1228 on the Perl stack.
1229
1230 When using any of these routines (except C<perl_call_argv>), the programmer
1231 must manipulate the Perl stack.  These include the following macros and
1232 functions:
1233
1234     dSP
1235     SP
1236     PUSHMARK()
1237     PUTBACK
1238     SPAGAIN
1239     ENTER
1240     SAVETMPS
1241     FREETMPS
1242     LEAVE
1243     XPUSH*()
1244     POP*()
1245
1246 For a detailed description of calling conventions from C to Perl,
1247 consult L<perlcall>.
1248
1249 =head2 Memory Allocation
1250
1251 All memory meant to be used with the Perl API functions should be manipulated
1252 using the macros described in this section.  The macros provide the necessary
1253 transparency between differences in the actual malloc implementation that is
1254 used within perl.
1255
1256 It is suggested that you enable the version of malloc that is distributed
1257 with Perl.  It keeps pools of various sizes of unallocated memory in
1258 order to satisfy allocation requests more quickly.  However, on some
1259 platforms, it may cause spurious malloc or free errors.
1260
1261     New(x, pointer, number, type);
1262     Newc(x, pointer, number, type, cast);
1263     Newz(x, pointer, number, type);
1264
1265 These three macros are used to initially allocate memory.
1266
1267 The first argument C<x> was a "magic cookie" that was used to keep track
1268 of who called the macro, to help when debugging memory problems.  However,
1269 the current code makes no use of this feature (most Perl developers now
1270 use run-time memory checkers), so this argument can be any number.
1271
1272 The second argument C<pointer> should be the name of a variable that will
1273 point to the newly allocated memory.
1274
1275 The third and fourth arguments C<number> and C<type> specify how many of
1276 the specified type of data structure should be allocated.  The argument
1277 C<type> is passed to C<sizeof>.  The final argument to C<Newc>, C<cast>,
1278 should be used if the C<pointer> argument is different from the C<type>
1279 argument.
1280
1281 Unlike the C<New> and C<Newc> macros, the C<Newz> macro calls C<memzero>
1282 to zero out all the newly allocated memory.
1283
1284     Renew(pointer, number, type);
1285     Renewc(pointer, number, type, cast);
1286     Safefree(pointer)
1287
1288 These three macros are used to change a memory buffer size or to free a
1289 piece of memory no longer needed.  The arguments to C<Renew> and C<Renewc>
1290 match those of C<New> and C<Newc> with the exception of not needing the
1291 "magic cookie" argument.
1292
1293     Move(source, dest, number, type);
1294     Copy(source, dest, number, type);
1295     Zero(dest, number, type);
1296
1297 These three macros are used to move, copy, or zero out previously allocated
1298 memory.  The C<source> and C<dest> arguments point to the source and
1299 destination starting points.  Perl will move, copy, or zero out C<number>
1300 instances of the size of the C<type> data structure (using the C<sizeof>
1301 function).
1302
1303 =head2 PerlIO
1304
1305 The most recent development releases of Perl has been experimenting with
1306 removing Perl's dependency on the "normal" standard I/O suite and allowing
1307 other stdio implementations to be used.  This involves creating a new
1308 abstraction layer that then calls whichever implementation of stdio Perl
1309 was compiled with.  All XSUBs should now use the functions in the PerlIO
1310 abstraction layer and not make any assumptions about what kind of stdio
1311 is being used.
1312
1313 For a complete description of the PerlIO abstraction, consult L<perlapio>.
1314
1315 =head2 Putting a C value on Perl stack
1316
1317 A lot of opcodes (this is an elementary operation in the internal perl
1318 stack machine) put an SV* on the stack. However, as an optimization
1319 the corresponding SV is (usually) not recreated each time. The opcodes
1320 reuse specially assigned SVs (I<target>s) which are (as a corollary)
1321 not constantly freed/created.
1322
1323 Each of the targets is created only once (but see
1324 L<Scratchpads and recursion> below), and when an opcode needs to put
1325 an integer, a double, or a string on stack, it just sets the
1326 corresponding parts of its I<target> and puts the I<target> on stack.
1327
1328 The macro to put this target on stack is C<PUSHTARG>, and it is
1329 directly used in some opcodes, as well as indirectly in zillions of
1330 others, which use it via C<(X)PUSH[pni]>.
1331
1332 =head2 Scratchpads
1333
1334 The question remains on when the SVs which are I<target>s for opcodes
1335 are created. The answer is that they are created when the current unit --
1336 a subroutine or a file (for opcodes for statements outside of
1337 subroutines) -- is compiled. During this time a special anonymous Perl
1338 array is created, which is called a scratchpad for the current
1339 unit.
1340
1341 A scratchpad keeps SVs which are lexicals for the current unit and are
1342 targets for opcodes. One can deduce that an SV lives on a scratchpad
1343 by looking on its flags: lexicals have C<SVs_PADMY> set, and
1344 I<target>s have C<SVs_PADTMP> set.
1345
1346 The correspondence between OPs and I<target>s is not 1-to-1. Different
1347 OPs in the compile tree of the unit can use the same target, if this
1348 would not conflict with the expected life of the temporary.
1349
1350 =head2 Scratchpads and recursion
1351
1352 In fact it is not 100% true that a compiled unit contains a pointer to
1353 the scratchpad AV. In fact it contains a pointer to an AV of
1354 (initially) one element, and this element is the scratchpad AV. Why do
1355 we need an extra level of indirection?
1356
1357 The answer is B<recursion>, and maybe (sometime soon) B<threads>. Both
1358 these can create several execution pointers going into the same
1359 subroutine. For the subroutine-child not write over the temporaries
1360 for the subroutine-parent (lifespan of which covers the call to the
1361 child), the parent and the child should have different
1362 scratchpads. (I<And> the lexicals should be separate anyway!)
1363
1364 So each subroutine is born with an array of scratchpads (of length 1).
1365 On each entry to the subroutine it is checked that the current
1366 depth of the recursion is not more than the length of this array, and
1367 if it is, new scratchpad is created and pushed into the array.
1368
1369 The I<target>s on this scratchpad are C<undef>s, but they are already
1370 marked with correct flags.
1371
1372 =head1 Compiled code
1373
1374 =head2 Code tree
1375
1376 Here we describe the internal form your code is converted to by
1377 Perl. Start with a simple example:
1378
1379   $a = $b + $c;
1380
1381 This is converted to a tree similar to this one:
1382
1383              assign-to
1384            /           \
1385           +             $a
1386         /   \
1387       $b     $c
1388
1389 (but slightly more complicated).  This tree reflects the way Perl
1390 parsed your code, but has nothing to do with the execution order.
1391 There is an additional "thread" going through the nodes of the tree
1392 which shows the order of execution of the nodes.  In our simplified
1393 example above it looks like:
1394
1395      $b ---> $c ---> + ---> $a ---> assign-to
1396
1397 But with the actual compile tree for C<$a = $b + $c> it is different:
1398 some nodes I<optimized away>.  As a corollary, though the actual tree
1399 contains more nodes than our simplified example, the execution order
1400 is the same as in our example.
1401
1402 =head2 Examining the tree
1403
1404 If you have your perl compiled for debugging (usually done with C<-D
1405 optimize=-g> on C<Configure> command line), you may examine the
1406 compiled tree by specifying C<-Dx> on the Perl command line.  The
1407 output takes several lines per node, and for C<$b+$c> it looks like
1408 this:
1409
1410     5           TYPE = add  ===> 6
1411                 TARG = 1
1412                 FLAGS = (SCALAR,KIDS)
1413                 {
1414                     TYPE = null  ===> (4)
1415                       (was rv2sv)
1416                     FLAGS = (SCALAR,KIDS)
1417                     {
1418     3                   TYPE = gvsv  ===> 4
1419                         FLAGS = (SCALAR)
1420                         GV = main::b
1421                     }
1422                 }
1423                 {
1424                     TYPE = null  ===> (5)
1425                       (was rv2sv)
1426                     FLAGS = (SCALAR,KIDS)
1427                     {
1428     4                   TYPE = gvsv  ===> 5
1429                         FLAGS = (SCALAR)
1430                         GV = main::c
1431                     }
1432                 }
1433
1434 This tree has 5 nodes (one per C<TYPE> specifier), only 3 of them are
1435 not optimized away (one per number in the left column).  The immediate
1436 children of the given node correspond to C<{}> pairs on the same level
1437 of indentation, thus this listing corresponds to the tree:
1438
1439                    add
1440                  /     \
1441                null    null
1442                 |       |
1443                gvsv    gvsv
1444
1445 The execution order is indicated by C<===E<gt>> marks, thus it is C<3
1446 4 5 6> (node C<6> is not included into above listing), i.e.,
1447 C<gvsv gvsv add whatever>.
1448
1449 =head2 Compile pass 1: check routines
1450
1451 The tree is created by the I<pseudo-compiler> while yacc code feeds it
1452 the constructions it recognizes. Since yacc works bottom-up, so does
1453 the first pass of perl compilation.
1454
1455 What makes this pass interesting for perl developers is that some
1456 optimization may be performed on this pass.  This is optimization by
1457 so-called I<check routines>.  The correspondence between node names
1458 and corresponding check routines is described in F<opcode.pl> (do not
1459 forget to run C<make regen_headers> if you modify this file).
1460
1461 A check routine is called when the node is fully constructed except
1462 for the execution-order thread.  Since at this time there are no
1463 back-links to the currently constructed node, one can do most any
1464 operation to the top-level node, including freeing it and/or creating
1465 new nodes above/below it.
1466
1467 The check routine returns the node which should be inserted into the
1468 tree (if the top-level node was not modified, check routine returns
1469 its argument).
1470
1471 By convention, check routines have names C<ck_*>. They are usually
1472 called from C<new*OP> subroutines (or C<convert>) (which in turn are
1473 called from F<perly.y>).
1474
1475 =head2 Compile pass 1a: constant folding
1476
1477 Immediately after the check routine is called the returned node is
1478 checked for being compile-time executable.  If it is (the value is
1479 judged to be constant) it is immediately executed, and a I<constant>
1480 node with the "return value" of the corresponding subtree is
1481 substituted instead.  The subtree is deleted.
1482
1483 If constant folding was not performed, the execution-order thread is
1484 created.
1485
1486 =head2 Compile pass 2: context propagation
1487
1488 When a context for a part of compile tree is known, it is propagated
1489 down through the tree.  At this time the context can have 5 values
1490 (instead of 2 for runtime context): void, boolean, scalar, list, and
1491 lvalue.  In contrast with the pass 1 this pass is processed from top
1492 to bottom: a node's context determines the context for its children.
1493
1494 Additional context-dependent optimizations are performed at this time.
1495 Since at this moment the compile tree contains back-references (via
1496 "thread" pointers), nodes cannot be free()d now.  To allow
1497 optimized-away nodes at this stage, such nodes are null()ified instead
1498 of free()ing (i.e. their type is changed to OP_NULL).
1499
1500 =head2 Compile pass 3: peephole optimization
1501
1502 After the compile tree for a subroutine (or for an C<eval> or a file)
1503 is created, an additional pass over the code is performed. This pass
1504 is neither top-down or bottom-up, but in the execution order (with
1505 additional complications for conditionals).  These optimizations are
1506 done in the subroutine peep().  Optimizations performed at this stage
1507 are subject to the same restrictions as in the pass 2.
1508
1509 =head1 The Perl API
1510
1511 WARNING: This information is subject to radical changes prior to
1512 the Perl 5.6 release.  Use with caution.
1513
1514 =head2 Background and PERL_IMPLICIT_CONTEXT
1515
1516 The Perl interpreter can be regarded as a closed box: it has an API
1517 for feeding it code or otherwise making it do things, but it also has
1518 functions for its own use.  This smells a lot like an object, and
1519 there are ways for you to build Perl so that you can have multiple
1520 interpreters, with one interpreter represented either as a C++ object,
1521 a C structure, or inside a thread.  The thread, the C structure, or
1522 the C++ object will contain all the context, the state of that
1523 interpreter.
1524
1525 Three macros control the major Perl build flavors: MULTIPLICITY,
1526 USE_THREADS and PERL_OBJECT.  The MULTIPLICITY build has a C structure
1527 that packages all the interpreter state, there is a similar thread-specific
1528 data structure under USE_THREADS, and the PERL_OBJECT build has a C++
1529 class to maintain interpreter state.  In all three cases,
1530 PERL_IMPLICIT_CONTEXT is also normally defined, and enables the
1531 support for passing in a "hidden" first argument that represents all three
1532 data structures.  (The traditional MULTIPLICITY and USE_THREADS builds
1533 built without PERL_IMPLICIT_CONTEXT may also be supported, but this is
1534 currently somewhat broken.)
1535
1536 All this obviously requires a way for the Perl internal functions to be
1537 C++ methods, subroutines taking some kind of structure as the first
1538 argument, or subroutines taking nothing as the first argument.  To
1539 enable these three very different ways of building the interpreter,
1540 the Perl source (as it does in so many other situations) makes heavy
1541 use of macros and subroutine naming conventions.
1542
1543 First problem: deciding which functions will be public API functions and
1544 which will be private.  Those functions whose names begin C<Perl_> are
1545 public, and those whose names begin C<S_> are private (think "S" for
1546 "secret" or "static").
1547
1548 Some functions have no prefix (e.g., restore_rsfp in toke.c).  These
1549 are not parts of the object or pseudo-structure because you need to
1550 pass pointers to them to other subroutines.
1551
1552 Second problem: there must be a syntax so that the same subroutine
1553 declarations and calls can pass a structure as their first argument,
1554 or pass nothing.  To solve this, the subroutines are named and
1555 declared in a particular way.  Here's a typical start of a static
1556 function used within the Perl guts:
1557
1558   STATIC void
1559   S_incline(pTHX_ char *s)
1560
1561 STATIC becomes "static" in C, and is #define'd to nothing in C++.
1562
1563 A public function (i.e. part of the API) begins like this:
1564
1565   void
1566   Perl_sv_setsv(pTHX_ SV* dsv, SV* ssv)
1567
1568 C<pTHX_> is one of a number of macros (in perl.h) that hide the
1569 details of the interpreter's context.  THX stands for "thread", "this",
1570 or "thingy", as the case may be.  (And no, George Lucas is not involved. :-)
1571 The first character could be 'p' for a B<p>rototype, 'a' for B<a>rgument,
1572 or 'd' for B<d>eclaration.
1573
1574 When Perl is built without PERL_IMPLICIT_CONTEXT, there is no first
1575 argument containing the interpreter's context.  The trailing underscore
1576 in the pTHX_ macro indicates that the macro expansion needs a comma
1577 after the context argument because other arguments follow it.  If
1578 PERL_IMPLICIT_CONTEXT is not defined, pTHX_ will be ignored, and the
1579 subroutine is not prototyped to take the extra argument.  The form of the
1580 macro without the trailing underscore is used when there are no additional
1581 explicit arguments.
1582
1583 When a core function calls another, it must pass the context.  This
1584 is normally hidden via macros.  Consider C<sv_setsv>.  It expands
1585 something like this:
1586
1587     ifdef PERL_IMPLICIT_CONTEXT
1588       define sv_setsv(a,b)      Perl_sv_setsv(aTHX_ a, b)
1589       /* can't do this for vararg functions, see below */
1590     else
1591       define sv_setsv           Perl_sv_setsv
1592     endif
1593
1594 This works well, and means that XS authors can gleefully write:
1595
1596     sv_setsv(foo, bar);
1597
1598 and still have it work under all the modes Perl could have been
1599 compiled with.
1600
1601 Under PERL_OBJECT in the core, that will translate to either:
1602
1603     CPerlObj::Perl_sv_setsv(foo,bar);  # in CPerlObj functions,
1604                                        # C++ takes care of 'this'
1605   or
1606
1607     pPerl->Perl_sv_setsv(foo,bar);     # in truly static functions,
1608                                        # see objXSUB.h
1609
1610 Under PERL_OBJECT in extensions (aka PERL_CAPI), or under
1611 MULTIPLICITY/USE_THREADS w/ PERL_IMPLICIT_CONTEXT in both core
1612 and extensions, it will be:
1613
1614     Perl_sv_setsv(aTHX_ foo, bar);     # the canonical Perl "API"
1615                                        # for all build flavors
1616
1617 This doesn't work so cleanly for varargs functions, though, as macros
1618 imply that the number of arguments is known in advance.  Instead we
1619 either need to spell them out fully, passing C<aTHX_> as the first
1620 argument (the Perl core tends to do this with functions like
1621 Perl_warner), or use a context-free version.
1622
1623 The context-free version of Perl_warner is called
1624 Perl_warner_nocontext, and does not take the extra argument.  Instead
1625 it does dTHX; to get the context from thread-local storage.  We
1626 C<#define warner Perl_warner_nocontext> so that extensions get source
1627 compatibility at the expense of performance.  (Passing an arg is
1628 cheaper than grabbing it from thread-local storage.)
1629
1630 You can ignore [pad]THX[xo] when browsing the Perl headers/sources.
1631 Those are strictly for use within the core.  Extensions and embedders
1632 need only be aware of [pad]THX.
1633
1634 =head2 How do I use all this in extensions?
1635
1636 When Perl is built with PERL_IMPLICIT_CONTEXT, extensions that call
1637 any functions in the Perl API will need to pass the initial context
1638 argument somehow.  The kicker is that you will need to write it in
1639 such a way that the extension still compiles when Perl hasn't been
1640 built with PERL_IMPLICIT_CONTEXT enabled.
1641
1642 There are three ways to do this.  First, the easy but inefficient way,
1643 which is also the default, in order to maintain source compatibility
1644 with extensions: whenever XSUB.h is #included, it redefines the aTHX
1645 and aTHX_ macros to call a function that will return the context.
1646 Thus, something like:
1647
1648         sv_setsv(asv, bsv);
1649
1650 in your extesion will translate to this when PERL_IMPLICIT_CONTEXT is
1651 in effect:
1652
1653         Perl_sv_setsv(GetPerlInterpreter(), asv, bsv);
1654
1655 or to this otherwise:
1656
1657         Perl_sv_setsv(asv, bsv);
1658
1659 You have to do nothing new in your extension to get this; since
1660 the Perl library provides GetPerlInterpreter(), it will all just
1661 work.
1662
1663 The second, more efficient way is to use the following template for
1664 your Foo.xs:
1665
1666         #define PERL_NO_GET_CONTEXT     /* we want efficiency */
1667         #include "EXTERN.h"
1668         #include "perl.h"
1669         #include "XSUB.h"
1670
1671         static my_private_function(int arg1, int arg2);
1672
1673         static SV *
1674         my_private_function(int arg1, int arg2)
1675         {
1676             dTHX;       /* fetch context */
1677             ... call many Perl API functions ...
1678         }
1679
1680         [... etc ...]
1681
1682         MODULE = Foo            PACKAGE = Foo
1683
1684         /* typical XSUB */
1685
1686         void
1687         my_xsub(arg)
1688                 int arg
1689             CODE:
1690                 my_private_function(arg, 10);
1691
1692 Note that the only two changes from the normal way of writing an
1693 extension is the addition of a C<#define PERL_NO_GET_CONTEXT> before
1694 including the Perl headers, followed by a C<dTHX;> declaration at
1695 the start of every function that will call the Perl API.  (You'll
1696 know which functions need this, because the C compiler will complain
1697 that there's an undeclared identifier in those functions.)  No changes
1698 are needed for the XSUBs themselves, because the XS() macro is
1699 correctly defined to pass in the implicit context if needed.
1700
1701 The third, even more efficient way is to ape how it is done within
1702 the Perl guts:
1703
1704
1705         #define PERL_NO_GET_CONTEXT     /* we want efficiency */
1706         #include "EXTERN.h"
1707         #include "perl.h"
1708         #include "XSUB.h"
1709
1710         /* pTHX_ only needed for functions that call Perl API */
1711         static my_private_function(pTHX_ int arg1, int arg2);
1712
1713         static SV *
1714         my_private_function(pTHX_ int arg1, int arg2)
1715         {
1716             /* dTHX; not needed here, because THX is an argument */
1717             ... call Perl API functions ...
1718         }
1719
1720         [... etc ...]
1721
1722         MODULE = Foo            PACKAGE = Foo
1723
1724         /* typical XSUB */
1725
1726         void
1727         my_xsub(arg)
1728                 int arg
1729             CODE:
1730                 my_private_function(aTHX_ arg, 10);
1731
1732 This implementation never has to fetch the context using a function
1733 call, since it is always passed as an extra argument.  Depending on
1734 your needs for simplicity or efficiency, you may mix the previous
1735 two approaches freely.
1736
1737 Never say C<pTHX,> yourself--always use the form of the macro with the
1738 underscore for functions that take explicit arguments, or the form
1739 without the argument for functions with no explicit arguments.
1740
1741 =head2 Future Plans and PERL_IMPLICIT_SYS
1742
1743 Just as PERL_IMPLICIT_CONTEXT provides a way to bundle up everything
1744 that the interpreter knows about itself and pass it around, so too are
1745 there plans to allow the interpreter to bundle up everything it knows
1746 about the environment it's running on.  This is enabled with the
1747 PERL_IMPLICIT_SYS macro.  Currently it only works with PERL_OBJECT,
1748 but is mostly there for MULTIPLICITY and USE_THREADS (see inside
1749 iperlsys.h).
1750
1751 This allows the ability to provide an extra pointer (called the "host"
1752 environment) for all the system calls.  This makes it possible for
1753 all the system stuff to maintain their own state, broken down into
1754 seven C structures.  These are thin wrappers around the usual system
1755 calls (see win32/perllib.c) for the default perl executable, but for a
1756 more ambitious host (like the one that would do fork() emulation) all
1757 the extra work needed to pretend that different interpreters are
1758 actually different "processes", would be done here.
1759
1760 The Perl engine/interpreter and the host are orthogonal entities.
1761 There could be one or more interpreters in a process, and one or
1762 more "hosts", with free association between them.
1763
1764 =head1 API LISTING
1765
1766 This is a listing of functions, macros, flags, and variables that may be
1767 useful to extension writers or that may be found while reading other
1768 extensions.
1769
1770 Note that all Perl API global variables must be referenced with the C<PL_>
1771 prefix.  Some macros are provided for compatibility with the older,
1772 unadorned names, but this support may be disabled in a future release.
1773
1774 The sort order of the listing is case insensitive, with any
1775 occurrences of '_' ignored for the purpose of sorting.
1776
1777 =over 8
1778
1779 =item av_clear
1780
1781 Clears an array, making it empty.  Does not free the memory used by the
1782 array itself.
1783
1784         void    av_clear (AV* ar)
1785
1786 =item av_extend
1787
1788 Pre-extend an array.  The C<key> is the index to which the array should be
1789 extended.
1790
1791         void    av_extend (AV* ar, I32 key)
1792
1793 =item av_fetch
1794
1795 Returns the SV at the specified index in the array.  The C<key> is the
1796 index.  If C<lval> is set then the fetch will be part of a store.  Check
1797 that the return value is non-null before dereferencing it to a C<SV*>.
1798
1799 See L<Understanding the Magic of Tied Hashes and Arrays> for more
1800 information on how to use this function on tied arrays.
1801
1802         SV**    av_fetch (AV* ar, I32 key, I32 lval)
1803
1804 =item AvFILL
1805
1806 Same as C<av_len()>.  Deprecated, use C<av_len()> instead.
1807
1808 =item av_len
1809
1810 Returns the highest index in the array.  Returns -1 if the array is empty.
1811
1812         I32     av_len (AV* ar)
1813
1814 =item av_make
1815
1816 Creates a new AV and populates it with a list of SVs.  The SVs are copied
1817 into the array, so they may be freed after the call to av_make.  The new AV
1818 will have a reference count of 1.
1819
1820         AV*     av_make (I32 size, SV** svp)
1821
1822 =item av_pop
1823
1824 Pops an SV off the end of the array.  Returns C<&PL_sv_undef> if the array is
1825 empty.
1826
1827         SV*     av_pop (AV* ar)
1828
1829 =item av_push
1830
1831 Pushes an SV onto the end of the array.  The array will grow automatically
1832 to accommodate the addition.
1833
1834         void    av_push (AV* ar, SV* val)
1835
1836 =item av_shift
1837
1838 Shifts an SV off the beginning of the array.
1839
1840         SV*     av_shift (AV* ar)
1841
1842 =item av_store
1843
1844 Stores an SV in an array.  The array index is specified as C<key>.  The
1845 return value will be NULL if the operation failed or if the value did not
1846 need to be actually stored within the array (as in the case of tied arrays).
1847 Otherwise it can be dereferenced to get the original C<SV*>.  Note that the
1848 caller is responsible for suitably incrementing the reference count of C<val>
1849 before the call, and decrementing it if the function returned NULL.
1850
1851 See L<Understanding the Magic of Tied Hashes and Arrays> for more
1852 information on how to use this function on tied arrays.
1853
1854         SV**    av_store (AV* ar, I32 key, SV* val)
1855
1856 =item av_undef
1857
1858 Undefines the array.  Frees the memory used by the array itself.
1859
1860         void    av_undef (AV* ar)
1861
1862 =item av_unshift
1863
1864 Unshift the given number of C<undef> values onto the beginning of the
1865 array.  The array will grow automatically to accommodate the addition.
1866 You must then use C<av_store> to assign values to these new elements.
1867
1868         void    av_unshift (AV* ar, I32 num)
1869
1870 =item CLASS
1871
1872 Variable which is setup by C<xsubpp> to indicate the class name for a C++ XS
1873 constructor.  This is always a C<char*>.  See C<THIS> and
1874 L<perlxs/"Using XS With C++">.
1875
1876 =item Copy
1877
1878 The XSUB-writer's interface to the C C<memcpy> function.  The C<s> is the
1879 source, C<d> is the destination, C<n> is the number of items, and C<t> is
1880 the type.  May fail on overlapping copies.  See also C<Move>.
1881
1882         void    Copy( s, d, n, t )
1883
1884 =item croak
1885
1886 This is the XSUB-writer's interface to Perl's C<die> function.  Use this
1887 function the same way you use the C C<printf> function.  See C<warn>.
1888
1889 =item CvSTASH
1890
1891 Returns the stash of the CV.
1892
1893         HV*     CvSTASH( SV* sv )
1894
1895 =item PL_DBsingle
1896
1897 When Perl is run in debugging mode, with the B<-d> switch, this SV is a
1898 boolean which indicates whether subs are being single-stepped.
1899 Single-stepping is automatically turned on after every step.  This is the C
1900 variable which corresponds to Perl's $DB::single variable.  See C<PL_DBsub>.
1901
1902 =item PL_DBsub
1903
1904 When Perl is run in debugging mode, with the B<-d> switch, this GV contains
1905 the SV which holds the name of the sub being debugged.  This is the C
1906 variable which corresponds to Perl's $DB::sub variable.  See C<PL_DBsingle>.
1907 The sub name can be found by
1908
1909         SvPV( GvSV( PL_DBsub ), len )
1910
1911 =item PL_DBtrace
1912
1913 Trace variable used when Perl is run in debugging mode, with the B<-d>
1914 switch.  This is the C variable which corresponds to Perl's $DB::trace
1915 variable.  See C<PL_DBsingle>.
1916
1917 =item dMARK
1918
1919 Declare a stack marker variable, C<mark>, for the XSUB.  See C<MARK> and
1920 C<dORIGMARK>.
1921
1922 =item dORIGMARK
1923
1924 Saves the original stack mark for the XSUB.  See C<ORIGMARK>.
1925
1926 =item PL_dowarn
1927
1928 The C variable which corresponds to Perl's $^W warning variable.
1929
1930 =item dSP
1931
1932 Declares a local copy of perl's stack pointer for the XSUB, available via
1933 the C<SP> macro.  See C<SP>.
1934
1935 =item dXSARGS
1936
1937 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.  This is
1938 usually handled automatically by C<xsubpp>.  Declares the C<items> variable
1939 to indicate the number of items on the stack.
1940
1941 =item dXSI32
1942
1943 Sets up the C<ix> variable for an XSUB which has aliases.  This is usually
1944 handled automatically by C<xsubpp>.
1945
1946 =item do_binmode
1947
1948 Switches filehandle to binmode.  C<iotype> is what C<IoTYPE(io)> would
1949 contain.
1950
1951         do_binmode(fp, iotype, TRUE);
1952
1953 =item ENTER
1954
1955 Opening bracket on a callback.  See C<LEAVE> and L<perlcall>.
1956
1957         ENTER;
1958
1959 =item EXTEND
1960
1961 Used to extend the argument stack for an XSUB's return values.
1962
1963         EXTEND( sp, int x )
1964
1965 =item fbm_compile
1966
1967 Analyses the string in order to make fast searches on it using fbm_instr() --
1968 the Boyer-Moore algorithm.
1969
1970         void    fbm_compile(SV* sv, U32 flags)
1971
1972 =item fbm_instr
1973
1974 Returns the location of the SV in the string delimited by C<str> and
1975 C<strend>.  It returns C<Nullch> if the string can't be found.  The
1976 C<sv> does not have to be fbm_compiled, but the search will not be as
1977 fast then.
1978
1979         char*   fbm_instr(char *str, char *strend, SV *sv, U32 flags)
1980
1981 =item FREETMPS
1982
1983 Closing bracket for temporaries on a callback.  See C<SAVETMPS> and
1984 L<perlcall>.
1985
1986         FREETMPS;
1987
1988 =item G_ARRAY
1989
1990 Used to indicate array context.  See C<GIMME_V>, C<GIMME> and L<perlcall>.
1991
1992 =item G_DISCARD
1993
1994 Indicates that arguments returned from a callback should be discarded.  See
1995 L<perlcall>.
1996
1997 =item G_EVAL
1998
1999 Used to force a Perl C<eval> wrapper around a callback.  See L<perlcall>.
2000
2001 =item GIMME
2002
2003 A backward-compatible version of C<GIMME_V> which can only return
2004 C<G_SCALAR> or C<G_ARRAY>; in a void context, it returns C<G_SCALAR>.
2005
2006 =item GIMME_V
2007
2008 The XSUB-writer's equivalent to Perl's C<wantarray>.  Returns
2009 C<G_VOID>, C<G_SCALAR> or C<G_ARRAY> for void, scalar or array
2010 context, respectively.
2011
2012 =item G_NOARGS
2013
2014 Indicates that no arguments are being sent to a callback.  See L<perlcall>.
2015
2016 =item G_SCALAR
2017
2018 Used to indicate scalar context.  See C<GIMME_V>, C<GIMME>, and L<perlcall>.
2019
2020 =item gv_fetchmeth
2021
2022 Returns the glob with the given C<name> and a defined subroutine or
2023 C<NULL>.  The glob lives in the given C<stash>, or in the stashes
2024 accessible via @ISA and @UNIVERSAL.
2025
2026 The argument C<level> should be either 0 or -1.  If C<level==0>, as a
2027 side-effect creates a glob with the given C<name> in the given
2028 C<stash> which in the case of success contains an alias for the
2029 subroutine, and sets up caching info for this glob.  Similarly for all
2030 the searched stashes.
2031
2032 This function grants C<"SUPER"> token as a postfix of the stash name.
2033
2034 The GV returned from C<gv_fetchmeth> may be a method cache entry,
2035 which is not visible to Perl code.  So when calling C<perl_call_sv>,
2036 you should not use the GV directly; instead, you should use the
2037 method's CV, which can be obtained from the GV with the C<GvCV> macro.
2038
2039         GV*     gv_fetchmeth (HV* stash, const char* name, STRLEN len, I32 level)
2040
2041 =item gv_fetchmethod
2042
2043 =item gv_fetchmethod_autoload
2044
2045 Returns the glob which contains the subroutine to call to invoke the
2046 method on the C<stash>.  In fact in the presence of autoloading this may
2047 be the glob for "AUTOLOAD".  In this case the corresponding variable
2048 $AUTOLOAD is already setup.
2049
2050 The third parameter of C<gv_fetchmethod_autoload> determines whether AUTOLOAD
2051 lookup is performed if the given method is not present: non-zero means
2052 yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD.  Calling
2053 C<gv_fetchmethod> is equivalent to calling C<gv_fetchmethod_autoload> with a
2054 non-zero C<autoload> parameter.
2055
2056 These functions grant C<"SUPER"> token as a prefix of the method name.
2057
2058 Note that if you want to keep the returned glob for a long time, you
2059 need to check for it being "AUTOLOAD", since at the later time the call
2060 may load a different subroutine due to $AUTOLOAD changing its value.
2061 Use the glob created via a side effect to do this.
2062
2063 These functions have the same side-effects and as C<gv_fetchmeth> with
2064 C<level==0>.  C<name> should be writable if contains C<':'> or C<'\''>.
2065 The warning against passing the GV returned by C<gv_fetchmeth> to
2066 C<perl_call_sv> apply equally to these functions.
2067
2068         GV*     gv_fetchmethod (HV* stash, const char* name)
2069         GV*     gv_fetchmethod_autoload (HV* stash, const char* name, I32 autoload)
2070
2071 =item G_VOID
2072
2073 Used to indicate void context.  See C<GIMME_V> and L<perlcall>.
2074
2075 =item gv_stashpv
2076
2077 Returns a pointer to the stash for a specified package.  If C<create> is set
2078 then the package will be created if it does not already exist.  If C<create>
2079 is not set and the package does not exist then NULL is returned.
2080
2081         HV*     gv_stashpv (const char* name, I32 create)
2082
2083 =item gv_stashsv
2084
2085 Returns a pointer to the stash for a specified package.  See C<gv_stashpv>.
2086
2087         HV*     gv_stashsv (SV* sv, I32 create)
2088
2089 =item GvSV
2090
2091 Return the SV from the GV.
2092
2093 =item HEf_SVKEY
2094
2095 This flag, used in the length slot of hash entries and magic
2096 structures, specifies the structure contains a C<SV*> pointer where a
2097 C<char*> pointer is to be expected. (For information only--not to be used).
2098
2099 =item HeHASH
2100
2101 Returns the computed hash stored in the hash entry.
2102
2103         U32     HeHASH(HE* he)
2104
2105 =item HeKEY
2106
2107 Returns the actual pointer stored in the key slot of the hash entry.
2108 The pointer may be either C<char*> or C<SV*>, depending on the value of
2109 C<HeKLEN()>.  Can be assigned to.  The C<HePV()> or C<HeSVKEY()> macros
2110 are usually preferable for finding the value of a key.
2111
2112         char*   HeKEY(HE* he)
2113
2114 =item HeKLEN
2115
2116 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
2117 holds an C<SV*> key.  Otherwise, holds the actual length of the key.
2118 Can be assigned to. The C<HePV()> macro is usually preferable for finding
2119 key lengths.
2120
2121         int     HeKLEN(HE* he)
2122
2123 =item HePV
2124
2125 Returns the key slot of the hash entry as a C<char*> value, doing any
2126 necessary dereferencing of possibly C<SV*> keys.  The length of
2127 the string is placed in C<len> (this is a macro, so do I<not> use
2128 C<&len>).  If you do not care about what the length of the key is,
2129 you may use the global variable C<PL_na>, though this is rather less
2130 efficient than using a local variable.  Remember though, that hash
2131 keys in perl are free to contain embedded nulls, so using C<strlen()>
2132 or similar is not a good way to find the length of hash keys.
2133 This is very similar to the C<SvPV()> macro described elsewhere in
2134 this document.
2135
2136         char*   HePV(HE* he, STRLEN len)
2137
2138 =item HeSVKEY
2139
2140 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry
2141 does not contain an C<SV*> key.
2142
2143         HeSVKEY(HE* he)
2144
2145 =item HeSVKEY_force
2146
2147 Returns the key as an C<SV*>.  Will create and return a temporary
2148 mortal C<SV*> if the hash entry contains only a C<char*> key.
2149
2150         HeSVKEY_force(HE* he)
2151
2152 =item HeSVKEY_set
2153
2154 Sets the key to a given C<SV*>, taking care to set the appropriate flags
2155 to indicate the presence of an C<SV*> key, and returns the same C<SV*>.
2156
2157         HeSVKEY_set(HE* he, SV* sv)
2158
2159 =item HeVAL
2160
2161 Returns the value slot (type C<SV*>) stored in the hash entry.
2162
2163         HeVAL(HE* he)
2164
2165 =item hv_clear
2166
2167 Clears a hash, making it empty.
2168
2169         void    hv_clear (HV* tb)
2170
2171 =item hv_delete
2172
2173 Deletes a key/value pair in the hash.  The value SV is removed from the hash
2174 and returned to the caller.  The C<klen> is the length of the key.  The
2175 C<flags> value will normally be zero; if set to G_DISCARD then NULL will be
2176 returned.
2177
2178         SV*     hv_delete (HV* tb, const char* key, U32 klen, I32 flags)
2179
2180 =item hv_delete_ent
2181
2182 Deletes a key/value pair in the hash.  The value SV is removed from the hash
2183 and returned to the caller.  The C<flags> value will normally be zero; if set
2184 to G_DISCARD then NULL will be returned.  C<hash> can be a valid precomputed
2185 hash value, or 0 to ask for it to be computed.
2186
2187         SV*     hv_delete_ent (HV* tb, SV* key, I32 flags, U32 hash)
2188
2189 =item hv_exists
2190
2191 Returns a boolean indicating whether the specified hash key exists.  The
2192 C<klen> is the length of the key.
2193
2194         bool    hv_exists (HV* tb, const char* key, U32 klen)
2195
2196 =item hv_exists_ent
2197
2198 Returns a boolean indicating whether the specified hash key exists. C<hash>
2199 can be a valid precomputed hash value, or 0 to ask for it to be computed.
2200
2201         bool    hv_exists_ent (HV* tb, SV* key, U32 hash)
2202
2203 =item hv_fetch
2204
2205 Returns the SV which corresponds to the specified key in the hash.  The
2206 C<klen> is the length of the key.  If C<lval> is set then the fetch will be
2207 part of a store.  Check that the return value is non-null before
2208 dereferencing it to a C<SV*>.
2209
2210 See L<Understanding the Magic of Tied Hashes and Arrays> for more
2211 information on how to use this function on tied hashes.
2212
2213         SV**    hv_fetch (HV* tb, const char* key, U32 klen, I32 lval)
2214
2215 =item hv_fetch_ent
2216
2217 Returns the hash entry which corresponds to the specified key in the hash.
2218 C<hash> must be a valid precomputed hash number for the given C<key>, or
2219 0 if you want the function to compute it.  IF C<lval> is set then the
2220 fetch will be part of a store.  Make sure the return value is non-null
2221 before accessing it.  The return value when C<tb> is a tied hash
2222 is a pointer to a static location, so be sure to make a copy of the
2223 structure if you need to store it somewhere.
2224
2225 See L<Understanding the Magic of Tied Hashes and Arrays> for more
2226 information on how to use this function on tied hashes.
2227
2228         HE*     hv_fetch_ent  (HV* tb, SV* key, I32 lval, U32 hash)
2229
2230 =item hv_iterinit
2231
2232 Prepares a starting point to traverse a hash table.
2233
2234         I32     hv_iterinit (HV* tb)
2235
2236 Returns the number of keys in the hash (i.e. the same as C<HvKEYS(tb)>).
2237 The return value is currently only meaningful for hashes without tie
2238 magic.
2239
2240 NOTE: Before version 5.004_65, C<hv_iterinit> used to return the number
2241 of hash buckets that happen to be in use.  If you still need that
2242 esoteric value, you can get it through the macro C<HvFILL(tb)>.
2243
2244 =item hv_iterkey
2245
2246 Returns the key from the current position of the hash iterator.  See
2247 C<hv_iterinit>.
2248
2249         char*   hv_iterkey (HE* entry, I32* retlen)
2250
2251 =item hv_iterkeysv
2252
2253 Returns the key as an C<SV*> from the current position of the hash
2254 iterator.  The return value will always be a mortal copy of the
2255 key.  Also see C<hv_iterinit>.
2256
2257         SV*     hv_iterkeysv  (HE* entry)
2258
2259 =item hv_iternext
2260
2261 Returns entries from a hash iterator.  See C<hv_iterinit>.
2262
2263         HE*     hv_iternext (HV* tb)
2264
2265 =item hv_iternextsv
2266
2267 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
2268 operation.
2269
2270         SV*     hv_iternextsv (HV* hv, char** key, I32* retlen)
2271
2272 =item hv_iterval
2273
2274 Returns the value from the current position of the hash iterator.  See
2275 C<hv_iterkey>.
2276
2277         SV*     hv_iterval (HV* tb, HE* entry)
2278
2279 =item hv_magic
2280
2281 Adds magic to a hash.  See C<sv_magic>.
2282
2283         void    hv_magic (HV* hv, GV* gv, int how)
2284
2285 =item HvNAME
2286
2287 Returns the package name of a stash.  See C<SvSTASH>, C<CvSTASH>.
2288
2289         char*   HvNAME (HV* stash)
2290
2291 =item hv_store
2292
2293 Stores an SV in a hash.  The hash key is specified as C<key> and C<klen> is
2294 the length of the key.  The C<hash> parameter is the precomputed hash
2295 value; if it is zero then Perl will compute it.  The return value will be
2296 NULL if the operation failed or if the value did not need to be actually
2297 stored within the hash (as in the case of tied hashes).  Otherwise it can
2298 be dereferenced to get the original C<SV*>.  Note that the caller is
2299 responsible for suitably incrementing the reference count of C<val>
2300 before the call, and decrementing it if the function returned NULL.
2301
2302 See L<Understanding the Magic of Tied Hashes and Arrays> for more
2303 information on how to use this function on tied hashes.
2304
2305         SV**    hv_store (HV* tb, const char* key, U32 klen, SV* val, U32 hash)
2306
2307 =item hv_store_ent
2308
2309 Stores C<val> in a hash.  The hash key is specified as C<key>.  The C<hash>
2310 parameter is the precomputed hash value; if it is zero then Perl will
2311 compute it.  The return value is the new hash entry so created.  It will be
2312 NULL if the operation failed or if the value did not need to be actually
2313 stored within the hash (as in the case of tied hashes).  Otherwise the
2314 contents of the return value can be accessed using the C<He???> macros
2315 described here.  Note that the caller is responsible for suitably
2316 incrementing the reference count of C<val> before the call, and decrementing
2317 it if the function returned NULL.
2318
2319 See L<Understanding the Magic of Tied Hashes and Arrays> for more
2320 information on how to use this function on tied hashes.
2321
2322         HE*     hv_store_ent  (HV* tb, SV* key, SV* val, U32 hash)
2323
2324 =item hv_undef
2325
2326 Undefines the hash.
2327
2328         void    hv_undef (HV* tb)
2329
2330 =item isALNUM
2331
2332 Returns a boolean indicating whether the C C<char> is an ascii alphanumeric
2333 character or digit.
2334
2335         int     isALNUM (char c)
2336
2337 =item isALPHA
2338
2339 Returns a boolean indicating whether the C C<char> is an ascii alphabetic
2340 character.
2341
2342         int     isALPHA (char c)
2343
2344 =item isDIGIT
2345
2346 Returns a boolean indicating whether the C C<char> is an ascii digit.
2347
2348         int     isDIGIT (char c)
2349
2350 =item isLOWER
2351
2352 Returns a boolean indicating whether the C C<char> is a lowercase character.
2353
2354         int     isLOWER (char c)
2355
2356 =item isSPACE
2357
2358 Returns a boolean indicating whether the C C<char> is whitespace.
2359
2360         int     isSPACE (char c)
2361
2362 =item isUPPER
2363
2364 Returns a boolean indicating whether the C C<char> is an uppercase character.
2365
2366         int     isUPPER (char c)
2367
2368 =item items
2369
2370 Variable which is setup by C<xsubpp> to indicate the number of items on the
2371 stack.  See L<perlxs/"Variable-length Parameter Lists">.
2372
2373 =item ix
2374
2375 Variable which is setup by C<xsubpp> to indicate which of an XSUB's aliases
2376 was used to invoke it.  See L<perlxs/"The ALIAS: Keyword">.
2377
2378 =item LEAVE
2379
2380 Closing bracket on a callback.  See C<ENTER> and L<perlcall>.
2381
2382         LEAVE;
2383
2384 =item looks_like_number
2385
2386 Test if an the content of an SV looks like a number (or is a number).
2387
2388         int     looks_like_number(SV*)
2389
2390
2391 =item MARK
2392
2393 Stack marker variable for the XSUB.  See C<dMARK>.
2394
2395 =item mg_clear
2396
2397 Clear something magical that the SV represents.  See C<sv_magic>.
2398
2399         int     mg_clear (SV* sv)
2400
2401 =item mg_copy
2402
2403 Copies the magic from one SV to another.  See C<sv_magic>.
2404
2405         int     mg_copy (SV *, SV *, const char *, STRLEN)
2406
2407 =item mg_find
2408
2409 Finds the magic pointer for type matching the SV.  See C<sv_magic>.
2410
2411         MAGIC*  mg_find (SV* sv, int type)
2412
2413 =item mg_free
2414
2415 Free any magic storage used by the SV.  See C<sv_magic>.
2416
2417         int     mg_free (SV* sv)
2418
2419 =item mg_get
2420
2421 Do magic after a value is retrieved from the SV.  See C<sv_magic>.
2422
2423         int     mg_get (SV* sv)
2424
2425 =item mg_len
2426
2427 Report on the SV's length.  See C<sv_magic>.
2428
2429         U32     mg_len (SV* sv)
2430
2431 =item mg_magical
2432
2433 Turns on the magical status of an SV.  See C<sv_magic>.
2434
2435         void    mg_magical (SV* sv)
2436
2437 =item mg_set
2438
2439 Do magic after a value is assigned to the SV.  See C<sv_magic>.
2440
2441         int     mg_set (SV* sv)
2442
2443 =item modglobal
2444
2445 C<modglobal> is a general purpose, interpreter global HV for use by
2446 extensions that need to keep information on a per-interpreter basis.
2447 In a pinch, it can also be used as a symbol table for extensions
2448 to share data among each other.  It is a good idea to use keys
2449 prefixed by the package name of the extension that owns the data.
2450
2451 =item Move
2452
2453 The XSUB-writer's interface to the C C<memmove> function.  The C<s> is the
2454 source, C<d> is the destination, C<n> is the number of items, and C<t> is
2455 the type.  Can do overlapping moves.  See also C<Copy>.
2456
2457         void    Move( s, d, n, t )
2458
2459 =item PL_na
2460
2461 A convenience variable which is typically used with C<SvPV> when one doesn't
2462 care about the length of the string.  It is usually more efficient to
2463 either declare a local variable and use that instead or to use the C<SvPV_nolen>
2464 macro.
2465
2466 =item New
2467
2468 The XSUB-writer's interface to the C C<malloc> function.
2469
2470         void*   New( x, void *ptr, int size, type )
2471
2472 =item newAV
2473
2474 Creates a new AV.  The reference count is set to 1.
2475
2476         AV*     newAV (void)
2477
2478 =item Newc
2479
2480 The XSUB-writer's interface to the C C<malloc> function, with cast.
2481
2482         void*   Newc( x, void *ptr, int size, type, cast )
2483
2484 =item newCONSTSUB
2485
2486 Creates a constant sub equivalent to Perl C<sub FOO () { 123 }>
2487 which is eligible for inlining at compile-time.
2488
2489         void    newCONSTSUB(HV* stash, char* name, SV* sv)
2490
2491 =item newHV
2492
2493 Creates a new HV.  The reference count is set to 1.
2494
2495         HV*     newHV (void)
2496
2497 =item newRV_inc
2498
2499 Creates an RV wrapper for an SV.  The reference count for the original SV is
2500 incremented.
2501
2502         SV*     newRV_inc (SV* ref)
2503
2504 For historical reasons, "newRV" is a synonym for "newRV_inc".
2505
2506 =item newRV_noinc
2507
2508 Creates an RV wrapper for an SV.  The reference count for the original
2509 SV is B<not> incremented.
2510
2511         SV*     newRV_noinc (SV* ref)
2512
2513 =item NEWSV
2514
2515 Creates a new SV.  A non-zero C<len> parameter indicates the number of
2516 bytes of preallocated string space the SV should have.  An extra byte
2517 for a tailing NUL is also reserved.  (SvPOK is not set for the SV even
2518 if string space is allocated.)  The reference count for the new SV is
2519 set to 1.  C<id> is an integer id between 0 and 1299 (used to identify
2520 leaks).
2521
2522         SV*     NEWSV (int id, STRLEN len)
2523
2524 =item newSViv
2525
2526 Creates a new SV and copies an integer into it.  The reference count for the
2527 SV is set to 1.
2528
2529         SV*     newSViv (IV i)
2530
2531 =item newSVnv
2532
2533 Creates a new SV and copies a double into it.  The reference count for the
2534 SV is set to 1.
2535
2536         SV*     newSVnv (NV i)
2537
2538 =item newSVpv
2539
2540 Creates a new SV and copies a string into it.  The reference count for the
2541 SV is set to 1.  If C<len> is zero, Perl will compute the length using
2542 strlen().  For efficiency, consider using C<newSVpvn> instead.
2543
2544         SV*     newSVpv (const char* s, STRLEN len)
2545
2546 =item newSVpvf
2547
2548 Creates a new SV an initialize it with the string formatted like
2549 C<sprintf>.
2550
2551         SV*     newSVpvf(const char* pat, ...)
2552
2553 =item newSVpvn
2554
2555 Creates a new SV and copies a string into it.  The reference count for the
2556 SV is set to 1.  Note that if C<len> is zero, Perl will create a zero length 
2557 string.  You are responsible for ensuring that the source string is at least
2558 C<len> bytes long.
2559
2560         SV*     newSVpvn (const char* s, STRLEN len)
2561
2562 =item newSVrv
2563
2564 Creates a new SV for the RV, C<rv>, to point to.  If C<rv> is not an RV then
2565 it will be upgraded to one.  If C<classname> is non-null then the new SV will
2566 be blessed in the specified package.  The new SV is returned and its
2567 reference count is 1.
2568
2569         SV*     newSVrv (SV* rv, const char* classname)
2570
2571 =item newSVsv
2572
2573 Creates a new SV which is an exact duplicate of the original SV.
2574
2575         SV*     newSVsv (SV* old)
2576
2577 =item newXS
2578
2579 Used by C<xsubpp> to hook up XSUBs as Perl subs.
2580
2581 =item newXSproto
2582
2583 Used by C<xsubpp> to hook up XSUBs as Perl subs.  Adds Perl prototypes to
2584 the subs.
2585
2586 =item Newz
2587
2588 The XSUB-writer's interface to the C C<malloc> function.  The allocated
2589 memory is zeroed with C<memzero>.
2590
2591         void*   Newz( x, void *ptr, int size, type )
2592
2593 =item Nullav
2594
2595 Null AV pointer.
2596
2597 =item Nullch
2598
2599 Null character pointer.
2600
2601 =item Nullcv
2602
2603 Null CV pointer.
2604
2605 =item Nullhv
2606
2607 Null HV pointer.
2608
2609 =item Nullsv
2610
2611 Null SV pointer.
2612
2613 =item ORIGMARK
2614
2615 The original stack mark for the XSUB.  See C<dORIGMARK>.
2616
2617 =item perl_alloc
2618
2619 Allocates a new Perl interpreter.  See L<perlembed>.
2620
2621 =item perl_call_argv
2622
2623 Performs a callback to the specified Perl sub.  See L<perlcall>.
2624
2625         I32     perl_call_argv (const char* subname, I32 flags, char** argv)
2626
2627 =item perl_call_method
2628
2629 Performs a callback to the specified Perl method.  The blessed object must
2630 be on the stack.  See L<perlcall>.
2631
2632         I32     perl_call_method (const char* methname, I32 flags)
2633
2634 =item perl_call_pv
2635
2636 Performs a callback to the specified Perl sub.  See L<perlcall>.
2637
2638         I32     perl_call_pv (const char* subname, I32 flags)
2639
2640 =item perl_call_sv
2641
2642 Performs a callback to the Perl sub whose name is in the SV.  See
2643 L<perlcall>.
2644
2645         I32     perl_call_sv (SV* sv, I32 flags)
2646
2647 =item perl_construct
2648
2649 Initializes a new Perl interpreter.  See L<perlembed>.
2650
2651 =item perl_destruct
2652
2653 Shuts down a Perl interpreter.  See L<perlembed>.
2654
2655 =item perl_eval_sv
2656
2657 Tells Perl to C<eval> the string in the SV.
2658
2659         I32     perl_eval_sv (SV* sv, I32 flags)
2660
2661 =item perl_eval_pv
2662
2663 Tells Perl to C<eval> the given string and return an SV* result.
2664
2665         SV*     perl_eval_pv (const char* p, I32 croak_on_error)
2666
2667 =item perl_free
2668
2669 Releases a Perl interpreter.  See L<perlembed>.
2670
2671 =item perl_get_av
2672
2673 Returns the AV of the specified Perl array.  If C<create> is set and the
2674 Perl variable does not exist then it will be created.  If C<create> is not
2675 set and the variable does not exist then NULL is returned.
2676
2677         AV*     perl_get_av (const char* name, I32 create)
2678
2679 =item perl_get_cv
2680
2681 Returns the CV of the specified Perl subroutine.  If C<create> is set and
2682 the Perl subroutine does not exist then it will be declared (which has
2683 the same effect as saying C<sub name;>).  If C<create> is not
2684 set and the subroutine does not exist then NULL is returned.
2685
2686         CV*     perl_get_cv (const char* name, I32 create)
2687
2688 =item perl_get_hv
2689
2690 Returns the HV of the specified Perl hash.  If C<create> is set and the Perl
2691 variable does not exist then it will be created.  If C<create> is not
2692 set and the variable does not exist then NULL is returned.
2693
2694         HV*     perl_get_hv (const char* name, I32 create)
2695
2696 =item perl_get_sv
2697
2698 Returns the SV of the specified Perl scalar.  If C<create> is set and the
2699 Perl variable does not exist then it will be created.  If C<create> is not
2700 set and the variable does not exist then NULL is returned.
2701
2702         SV*     perl_get_sv (const char* name, I32 create)
2703
2704 =item perl_parse
2705
2706 Tells a Perl interpreter to parse a Perl script.  See L<perlembed>.
2707
2708 =item perl_require_pv
2709
2710 Tells Perl to C<require> a module.
2711
2712         void    perl_require_pv (const char* pv)
2713
2714 =item perl_run
2715
2716 Tells a Perl interpreter to run.  See L<perlembed>.
2717
2718 =item POPi
2719
2720 Pops an integer off the stack.
2721
2722         int     POPi()
2723
2724 =item POPl
2725
2726 Pops a long off the stack.
2727
2728         long    POPl()
2729
2730 =item POPp
2731
2732 Pops a string off the stack.
2733
2734         char*   POPp()
2735
2736 =item POPn
2737
2738 Pops a double off the stack.
2739
2740         double  POPn()
2741
2742 =item POPs
2743
2744 Pops an SV off the stack.
2745
2746         SV*     POPs()
2747
2748 =item PUSHMARK
2749
2750 Opening bracket for arguments on a callback.  See C<PUTBACK> and L<perlcall>.
2751
2752         PUSHMARK(p)
2753
2754 =item PUSHi
2755
2756 Push an integer onto the stack.  The stack must have room for this element.
2757 Handles 'set' magic.  See C<XPUSHi>.
2758
2759         void    PUSHi(int d)
2760
2761 =item PUSHn
2762
2763 Push a double onto the stack.  The stack must have room for this element.
2764 Handles 'set' magic.  See C<XPUSHn>.
2765
2766         void    PUSHn(double d)
2767
2768 =item PUSHp
2769
2770 Push a string onto the stack.  The stack must have room for this element.
2771 The C<len> indicates the length of the string.  Handles 'set' magic.  See
2772 C<XPUSHp>.
2773
2774         void    PUSHp(char *c, int len )
2775
2776 =item PUSHs
2777
2778 Push an SV onto the stack.  The stack must have room for this element.  Does
2779 not handle 'set' magic.  See C<XPUSHs>.
2780
2781         void    PUSHs(sv)
2782
2783 =item PUSHu
2784
2785 Push an unsigned integer onto the stack.  The stack must have room for
2786 this element.  See C<XPUSHu>.
2787
2788         void    PUSHu(unsigned int d)
2789
2790
2791 =item PUTBACK
2792
2793 Closing bracket for XSUB arguments.  This is usually handled by C<xsubpp>.
2794 See C<PUSHMARK> and L<perlcall> for other uses.
2795
2796         PUTBACK;
2797
2798 =item Renew
2799
2800 The XSUB-writer's interface to the C C<realloc> function.
2801
2802         void*   Renew( void *ptr, int size, type )
2803
2804 =item Renewc
2805
2806 The XSUB-writer's interface to the C C<realloc> function, with cast.
2807
2808         void*   Renewc( void *ptr, int size, type, cast )
2809
2810 =item RETVAL
2811
2812 Variable which is setup by C<xsubpp> to hold the return value for an XSUB.
2813 This is always the proper type for the XSUB.
2814 See L<perlxs/"The RETVAL Variable">.
2815
2816 =item safefree
2817
2818 The XSUB-writer's interface to the C C<free> function.
2819
2820 =item safemalloc
2821
2822 The XSUB-writer's interface to the C C<malloc> function.
2823
2824 =item saferealloc
2825
2826 The XSUB-writer's interface to the C C<realloc> function.
2827
2828 =item savepv
2829
2830 Copy a string to a safe spot.  This does not use an SV.
2831
2832         char*   savepv (const char* sv)
2833
2834 =item savepvn
2835
2836 Copy a string to a safe spot.  The C<len> indicates number of bytes to
2837 copy.  This does not use an SV.
2838
2839         char*   savepvn (const char* sv, I32 len)
2840
2841 =item SAVETMPS
2842
2843 Opening bracket for temporaries on a callback.  See C<FREETMPS> and
2844 L<perlcall>.
2845
2846         SAVETMPS;
2847
2848 =item SP
2849
2850 Stack pointer.  This is usually handled by C<xsubpp>.  See C<dSP> and
2851 C<SPAGAIN>.
2852
2853 =item SPAGAIN
2854
2855 Refetch the stack pointer.  Used after a callback.  See L<perlcall>.
2856
2857         SPAGAIN;
2858
2859 =item ST
2860
2861 Used to access elements on the XSUB's stack.
2862
2863         SV*     ST(int x)
2864
2865 =item strEQ
2866
2867 Test two strings to see if they are equal.  Returns true or false.
2868
2869         int     strEQ( char *s1, char *s2 )
2870
2871 =item strGE
2872
2873 Test two strings to see if the first, C<s1>, is greater than or equal to the
2874 second, C<s2>.  Returns true or false.
2875
2876         int     strGE( char *s1, char *s2 )
2877
2878 =item strGT
2879
2880 Test two strings to see if the first, C<s1>, is greater than the second,
2881 C<s2>.  Returns true or false.
2882
2883         int     strGT( char *s1, char *s2 )
2884
2885 =item strLE
2886
2887 Test two strings to see if the first, C<s1>, is less than or equal to the
2888 second, C<s2>.  Returns true or false.
2889
2890         int     strLE( char *s1, char *s2 )
2891
2892 =item strLT
2893
2894 Test two strings to see if the first, C<s1>, is less than the second,
2895 C<s2>.  Returns true or false.
2896
2897         int     strLT( char *s1, char *s2 )
2898
2899 =item strNE
2900
2901 Test two strings to see if they are different.  Returns true or false.
2902
2903         int     strNE( char *s1, char *s2 )
2904
2905 =item strnEQ
2906
2907 Test two strings to see if they are equal.  The C<len> parameter indicates
2908 the number of bytes to compare.  Returns true or false.
2909
2910         int     strnEQ( char *s1, char *s2 )
2911
2912 =item strnNE
2913
2914 Test two strings to see if they are different.  The C<len> parameter
2915 indicates the number of bytes to compare.  Returns true or false.
2916
2917         int     strnNE( char *s1, char *s2, int len )
2918
2919 =item sv_2mortal
2920
2921 Marks an SV as mortal.  The SV will be destroyed when the current context
2922 ends.
2923
2924         SV*     sv_2mortal (SV* sv)
2925
2926 =item sv_bless
2927
2928 Blesses an SV into a specified package.  The SV must be an RV.  The package
2929 must be designated by its stash (see C<gv_stashpv()>).  The reference count
2930 of the SV is unaffected.
2931
2932         SV*     sv_bless (SV* sv, HV* stash)
2933
2934 =item sv_catpv
2935
2936 Concatenates the string onto the end of the string which is in the SV.
2937 Handles 'get' magic, but not 'set' magic.  See C<sv_catpv_mg>.
2938
2939         void    sv_catpv (SV* sv, const char* ptr)
2940
2941 =item sv_catpv_mg
2942
2943 Like C<sv_catpv>, but also handles 'set' magic.
2944
2945         void    sv_catpvn (SV* sv, const char* ptr)
2946
2947 =item sv_catpvn
2948
2949 Concatenates the string onto the end of the string which is in the SV.  The
2950 C<len> indicates number of bytes to copy.  Handles 'get' magic, but not
2951 'set' magic.  See C<sv_catpvn_mg>.
2952
2953         void    sv_catpvn (SV* sv, const char* ptr, STRLEN len)
2954
2955 =item sv_catpvn_mg
2956
2957 Like C<sv_catpvn>, but also handles 'set' magic.
2958
2959         void    sv_catpvn_mg (SV* sv, const char* ptr, STRLEN len)
2960
2961 =item sv_catpvf
2962
2963 Processes its arguments like C<sprintf> and appends the formatted output
2964 to an SV.  Handles 'get' magic, but not 'set' magic.  C<SvSETMAGIC()> must
2965 typically be called after calling this function to handle 'set' magic.
2966
2967         void    sv_catpvf (SV* sv, const char* pat, ...)
2968
2969 =item sv_catpvf_mg
2970
2971 Like C<sv_catpvf>, but also handles 'set' magic.
2972
2973         void    sv_catpvf_mg (SV* sv, const char* pat, ...)
2974
2975 =item sv_catsv
2976
2977 Concatenates the string from SV C<ssv> onto the end of the string in SV
2978 C<dsv>.  Handles 'get' magic, but not 'set' magic.  See C<sv_catsv_mg>.
2979
2980         void    sv_catsv (SV* dsv, SV* ssv)
2981
2982 =item sv_catsv_mg
2983
2984 Like C<sv_catsv>, but also handles 'set' magic.
2985
2986         void    sv_catsv_mg (SV* dsv, SV* ssv)
2987
2988 =item sv_chop
2989
2990 Efficient removal of characters from the beginning of the string
2991 buffer.  SvPOK(sv) must be true and the C<ptr> must be a pointer to
2992 somewhere inside the string buffer.  The C<ptr> becomes the first
2993 character of the adjusted string.
2994
2995         void    sv_chop(SV* sv, const char *ptr)
2996
2997
2998 =item sv_cmp
2999
3000 Compares the strings in two SVs.  Returns -1, 0, or 1 indicating whether the
3001 string in C<sv1> is less than, equal to, or greater than the string in
3002 C<sv2>.
3003
3004         I32     sv_cmp (SV* sv1, SV* sv2)
3005
3006 =item SvCUR
3007
3008 Returns the length of the string which is in the SV.  See C<SvLEN>.
3009
3010         int     SvCUR (SV* sv)
3011
3012 =item SvCUR_set
3013
3014 Set the length of the string which is in the SV.  See C<SvCUR>.
3015
3016         void    SvCUR_set (SV* sv, int val)
3017
3018 =item sv_dec
3019
3020 Auto-decrement of the value in the SV.
3021
3022         void    sv_dec (SV* sv)
3023
3024 =item sv_derived_from
3025
3026 Returns a boolean indicating whether the SV is derived from the specified
3027 class.  This is the function that implements C<UNIVERSAL::isa>.  It works
3028 for class names as well as for objects.
3029
3030         bool    sv_derived_from (SV* sv, const char* name);
3031
3032 =item SvEND
3033
3034 Returns a pointer to the last character in the string which is in the SV.
3035 See C<SvCUR>.  Access the character as
3036
3037         char*   SvEND(sv)
3038
3039 =item sv_eq
3040
3041 Returns a boolean indicating whether the strings in the two SVs are
3042 identical.
3043
3044         I32     sv_eq (SV* sv1, SV* sv2)
3045
3046 =item SvGETMAGIC
3047
3048 Invokes C<mg_get> on an SV if it has 'get' magic.  This macro evaluates
3049 its argument more than once.
3050
3051         void    SvGETMAGIC(SV *sv)
3052
3053 =item SvGROW
3054
3055 Expands the character buffer in the SV so that it has room for the
3056 indicated number of bytes (remember to reserve space for an extra
3057 trailing NUL character).  Calls C<sv_grow> to perform the expansion if
3058 necessary.  Returns a pointer to the character buffer.
3059
3060         char*   SvGROW(SV* sv, STRLEN len)
3061
3062 =item sv_grow
3063
3064 Expands the character buffer in the SV.  This will use C<sv_unref> and will
3065 upgrade the SV to C<SVt_PV>.  Returns a pointer to the character buffer.
3066 Use C<SvGROW>.
3067
3068 =item sv_inc
3069
3070 Auto-increment of the value in the SV.
3071
3072         void    sv_inc (SV* sv)
3073
3074 =item sv_insert
3075
3076 Inserts a string at the specified offset/length within the SV.
3077 Similar to the Perl substr() function.
3078
3079         void    sv_insert(SV *sv, STRLEN offset, STRLEN len,
3080                           char *str, STRLEN strlen)
3081
3082 =item SvIOK
3083
3084 Returns a boolean indicating whether the SV contains an integer.
3085
3086         int     SvIOK (SV* SV)
3087
3088 =item SvIOK_off
3089
3090 Unsets the IV status of an SV.
3091
3092         void    SvIOK_off (SV* sv)
3093
3094 =item SvIOK_on
3095
3096 Tells an SV that it is an integer.
3097
3098         void    SvIOK_on (SV* sv)
3099
3100 =item SvIOK_only
3101
3102 Tells an SV that it is an integer and disables all other OK bits.
3103
3104         void    SvIOK_only (SV* sv)
3105
3106 =item SvIOKp
3107
3108 Returns a boolean indicating whether the SV contains an integer.  Checks the
3109 B<private> setting.  Use C<SvIOK>.
3110
3111         int     SvIOKp (SV* SV)
3112
3113 =item sv_isa
3114
3115 Returns a boolean indicating whether the SV is blessed into the specified
3116 class.  This does not check for subtypes; use C<sv_derived_from> to verify
3117 an inheritance relationship.
3118
3119         int     sv_isa (SV* sv, char* name)
3120
3121 =item sv_isobject
3122
3123 Returns a boolean indicating whether the SV is an RV pointing to a blessed
3124 object.  If the SV is not an RV, or if the object is not blessed, then this
3125 will return false.
3126
3127         int     sv_isobject (SV* sv)
3128
3129 =item SvIV
3130
3131 Coerces the given SV to an integer and returns it.
3132
3133         int SvIV (SV* sv)
3134
3135 =item SvIVX
3136
3137 Returns the integer which is stored in the SV, assuming SvIOK is true.
3138
3139         int     SvIVX (SV* sv)
3140
3141 =item SvLEN
3142
3143 Returns the size of the string buffer in the SV.  See C<SvCUR>.
3144
3145         int     SvLEN (SV* sv)
3146
3147 =item sv_len
3148
3149 Returns the length of the string in the SV.  Use C<SvCUR>.
3150
3151         STRLEN  sv_len (SV* sv)
3152
3153 =item sv_magic
3154
3155 Adds magic to an SV.
3156
3157         void    sv_magic (SV* sv, SV* obj, int how, const char* name, I32 namlen)
3158
3159 =item sv_mortalcopy
3160
3161 Creates a new SV which is a copy of the original SV.  The new SV is marked
3162 as mortal.
3163
3164         SV*     sv_mortalcopy (SV* oldsv)
3165
3166 =item sv_newmortal
3167
3168 Creates a new SV which is mortal.  The reference count of the SV is set to 1.
3169
3170         SV*     sv_newmortal (void)
3171
3172 =item SvNIOK
3173
3174 Returns a boolean indicating whether the SV contains a number, integer or
3175 double.
3176
3177         int     SvNIOK (SV* SV)
3178
3179 =item SvNIOK_off
3180
3181 Unsets the NV/IV status of an SV.
3182
3183         void    SvNIOK_off (SV* sv)
3184
3185 =item SvNIOKp
3186
3187 Returns a boolean indicating whether the SV contains a number, integer or
3188 double.  Checks the B<private> setting.  Use C<SvNIOK>.
3189
3190         int     SvNIOKp (SV* SV)
3191
3192 =item PL_sv_no
3193
3194 This is the C<false> SV.  See C<PL_sv_yes>.  Always refer to this as C<&PL_sv_no>.
3195
3196 =item SvNOK
3197
3198 Returns a boolean indicating whether the SV contains a double.
3199
3200         int     SvNOK (SV* SV)
3201
3202 =item SvNOK_off
3203
3204 Unsets the NV status of an SV.
3205
3206         void    SvNOK_off (SV* sv)
3207
3208 =item SvNOK_on
3209
3210 Tells an SV that it is a double.
3211
3212         void    SvNOK_on (SV* sv)
3213
3214 =item SvNOK_only
3215
3216 Tells an SV that it is a double and disables all other OK bits.
3217
3218         void    SvNOK_only (SV* sv)
3219
3220 =item SvNOKp
3221
3222 Returns a boolean indicating whether the SV contains a double.  Checks the
3223 B<private> setting.  Use C<SvNOK>.
3224
3225         int     SvNOKp (SV* SV)
3226
3227 =item SvNV
3228
3229 Coerce the given SV to a double and return it.
3230
3231         double  SvNV (SV* sv)
3232
3233 =item SvNVX
3234
3235 Returns the double which is stored in the SV, assuming SvNOK is true.
3236
3237         double  SvNVX (SV* sv)
3238
3239 =item SvOK
3240
3241 Returns a boolean indicating whether the value is an SV.
3242
3243         int     SvOK (SV* sv)
3244
3245 =item SvOOK
3246
3247 Returns a boolean indicating whether the SvIVX is a valid offset value
3248 for the SvPVX.  This hack is used internally to speed up removal of
3249 characters from the beginning of a SvPV.  When SvOOK is true, then the
3250 start of the allocated string buffer is really (SvPVX - SvIVX).
3251
3252         int     SvOOK(SV* sv)
3253
3254 =item SvPOK
3255
3256 Returns a boolean indicating whether the SV contains a character string.
3257
3258         int     SvPOK (SV* SV)
3259
3260 =item SvPOK_off
3261
3262 Unsets the PV status of an SV.
3263
3264         void    SvPOK_off (SV* sv)
3265
3266 =item SvPOK_on
3267
3268 Tells an SV that it is a string.
3269
3270         void    SvPOK_on (SV* sv)
3271
3272 =item SvPOK_only
3273
3274 Tells an SV that it is a string and disables all other OK bits.
3275
3276         void    SvPOK_only (SV* sv)
3277
3278 =item SvPOKp
3279
3280 Returns a boolean indicating whether the SV contains a character string.
3281 Checks the B<private> setting.  Use C<SvPOK>.
3282
3283         int     SvPOKp (SV* SV)
3284
3285 =item SvPV
3286
3287 Returns a pointer to the string in the SV, or a stringified form of the SV
3288 if the SV does not contain a string.  Handles 'get' magic.
3289
3290         char*   SvPV (SV* sv, STRLEN len)
3291
3292 =item SvPV_force
3293
3294 Like <SvPV> but will force the SV into becoming a string (SvPOK).  You
3295 want force if you are going to update the SvPVX directly.
3296
3297         char*   SvPV_force(SV* sv, STRLEN len)
3298
3299 =item SvPV_nolen
3300
3301 Returns a pointer to the string in the SV, or a stringified form of the SV
3302 if the SV does not contain a string.  Handles 'get' magic.
3303
3304         char*   SvPV_nolen (SV* sv)
3305
3306 =item SvPVX
3307
3308 Returns a pointer to the string in the SV.  The SV must contain a string.
3309
3310         char*   SvPVX (SV* sv)
3311
3312 =item SvREFCNT
3313
3314 Returns the value of the object's reference count.
3315
3316         int     SvREFCNT (SV* sv)
3317
3318 =item SvREFCNT_dec
3319
3320 Decrements the reference count of the given SV.
3321
3322         void    SvREFCNT_dec (SV* sv)
3323
3324 =item SvREFCNT_inc
3325
3326 Increments the reference count of the given SV.
3327
3328         void    SvREFCNT_inc (SV* sv)
3329
3330 =item SvROK
3331
3332 Tests if the SV is an RV.
3333
3334         int     SvROK (SV* sv)
3335
3336 =item SvROK_off
3337
3338 Unsets the RV status of an SV.
3339
3340         void    SvROK_off (SV* sv)
3341
3342 =item SvROK_on
3343
3344 Tells an SV that it is an RV.
3345
3346         void    SvROK_on (SV* sv)
3347
3348 =item SvRV
3349
3350 Dereferences an RV to return the SV.
3351
3352         SV*     SvRV (SV* sv)
3353
3354 =item SvSETMAGIC
3355
3356 Invokes C<mg_set> on an SV if it has 'set' magic.  This macro evaluates
3357 its argument more than once.
3358
3359         void    SvSETMAGIC( SV *sv )
3360
3361 =item sv_setiv
3362
3363 Copies an integer into the given SV.  Does not handle 'set' magic.
3364 See C<sv_setiv_mg>.
3365
3366         void    sv_setiv (SV* sv, IV num)
3367
3368 =item sv_setiv_mg
3369
3370 Like C<sv_setiv>, but also handles 'set' magic.
3371
3372         void    sv_setiv_mg (SV* sv, IV num)
3373
3374 =item sv_setnv
3375
3376 Copies a double into the given SV.  Does not handle 'set' magic.
3377 See C<sv_setnv_mg>.
3378
3379         void    sv_setnv (SV* sv, double num)
3380
3381 =item sv_setnv_mg
3382
3383 Like C<sv_setnv>, but also handles 'set' magic.
3384
3385         void    sv_setnv_mg (SV* sv, double num)
3386
3387 =item sv_setpv
3388
3389 Copies a string into an SV.  The string must be null-terminated.
3390 Does not handle 'set' magic.  See C<sv_setpv_mg>.
3391
3392         void    sv_setpv (SV* sv, const char* ptr)
3393
3394 =item sv_setpv_mg
3395
3396 Like C<sv_setpv>, but also handles 'set' magic.
3397
3398         void    sv_setpv_mg (SV* sv, const char* ptr)
3399
3400 =item sv_setpviv
3401
3402 Copies an integer into the given SV, also updating its string value.
3403 Does not handle 'set' magic.  See C<sv_setpviv_mg>.
3404
3405         void    sv_setpviv (SV* sv, IV num)
3406
3407 =item sv_setpviv_mg
3408
3409 Like C<sv_setpviv>, but also handles 'set' magic.
3410
3411         void    sv_setpviv_mg (SV* sv, IV num)
3412
3413 =item sv_setpvn
3414
3415 Copies a string into an SV.  The C<len> parameter indicates the number of
3416 bytes to be copied.  Does not handle 'set' magic.  See C<sv_setpvn_mg>.
3417
3418         void    sv_setpvn (SV* sv, const char* ptr, STRLEN len)
3419
3420 =item sv_setpvn_mg
3421
3422 Like C<sv_setpvn>, but also handles 'set' magic.
3423
3424         void    sv_setpvn_mg (SV* sv, const char* ptr, STRLEN len)
3425
3426 =item sv_setpvf
3427
3428 Processes its arguments like C<sprintf> and sets an SV to the formatted
3429 output.  Does not handle 'set' magic.  See C<sv_setpvf_mg>.
3430
3431         void    sv_setpvf (SV* sv, const char* pat, ...)
3432
3433 =item sv_setpvf_mg
3434
3435 Like C<sv_setpvf>, but also handles 'set' magic.
3436
3437         void    sv_setpvf_mg (SV* sv, const char* pat, ...)
3438
3439 =item sv_setref_iv
3440
3441 Copies an integer into a new SV, optionally blessing the SV.  The C<rv>
3442 argument will be upgraded to an RV.  That RV will be modified to point to
3443 the new SV.  The C<classname> argument indicates the package for the
3444 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
3445 will be returned and will have a reference count of 1.
3446
3447         SV*     sv_setref_iv (SV *rv, char *classname, IV iv)
3448
3449 =item sv_setref_nv
3450
3451 Copies a double into a new SV, optionally blessing the SV.  The C<rv>
3452 argument will be upgraded to an RV.  That RV will be modified to point to
3453 the new SV.  The C<classname> argument indicates the package for the
3454 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
3455 will be returned and will have a reference count of 1.
3456
3457         SV*     sv_setref_nv (SV *rv, char *classname, double nv)
3458
3459 =item sv_setref_pv
3460
3461 Copies a pointer into a new SV, optionally blessing the SV.  The C<rv>
3462 argument will be upgraded to an RV.  That RV will be modified to point to
3463 the new SV.  If the C<pv> argument is NULL then C<PL_sv_undef> will be placed
3464 into the SV.  The C<classname> argument indicates the package for the
3465 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
3466 will be returned and will have a reference count of 1.
3467
3468         SV*     sv_setref_pv (SV *rv, char *classname, void* pv)
3469
3470 Do not use with integral Perl types such as HV, AV, SV, CV, because those
3471 objects will become corrupted by the pointer copy process.
3472
3473 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
3474
3475 =item sv_setref_pvn
3476
3477 Copies a string into a new SV, optionally blessing the SV.  The length of the
3478 string must be specified with C<n>.  The C<rv> argument will be upgraded to
3479 an RV.  That RV will be modified to point to the new SV.  The C<classname>
3480 argument indicates the package for the blessing.  Set C<classname> to
3481 C<Nullch> to avoid the blessing.  The new SV will be returned and will have
3482 a reference count of 1.
3483
3484         SV*     sv_setref_pvn (SV *rv, char *classname, char* pv, I32 n)
3485
3486 Note that C<sv_setref_pv> copies the pointer while this copies the string.
3487
3488 =item SvSetSV
3489
3490 Calls C<sv_setsv> if dsv is not the same as ssv.  May evaluate arguments
3491 more than once.
3492
3493         void    SvSetSV (SV* dsv, SV* ssv)
3494
3495 =item SvSetSV_nosteal
3496
3497 Calls a non-destructive version of C<sv_setsv> if dsv is not the same as ssv.
3498 May evaluate arguments more than once.
3499
3500         void    SvSetSV_nosteal (SV* dsv, SV* ssv)
3501
3502 =item sv_setsv
3503
3504 Copies the contents of the source SV C<ssv> into the destination SV C<dsv>.
3505 The source SV may be destroyed if it is mortal.  Does not handle 'set' magic.
3506 See the macro forms C<SvSetSV>, C<SvSetSV_nosteal> and C<sv_setsv_mg>.
3507
3508         void    sv_setsv (SV* dsv, SV* ssv)
3509
3510 =item sv_setsv_mg
3511
3512 Like C<sv_setsv>, but also handles 'set' magic.
3513
3514         void    sv_setsv_mg (SV* dsv, SV* ssv)
3515
3516 =item sv_setuv
3517
3518 Copies an unsigned integer into the given SV.  Does not handle 'set' magic.
3519 See C<sv_setuv_mg>.
3520
3521         void    sv_setuv (SV* sv, UV num)
3522
3523 =item sv_setuv_mg
3524
3525 Like C<sv_setuv>, but also handles 'set' magic.
3526
3527         void    sv_setuv_mg (SV* sv, UV num)
3528
3529 =item SvSTASH
3530
3531 Returns the stash of the SV.
3532
3533         HV*     SvSTASH (SV* sv)
3534
3535 =item SvTAINT
3536
3537 Taints an SV if tainting is enabled
3538
3539         void    SvTAINT (SV* sv)
3540
3541 =item SvTAINTED
3542
3543 Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if not.
3544
3545         int     SvTAINTED (SV* sv)
3546
3547 =item SvTAINTED_off
3548
3549 Untaints an SV. Be I<very> careful with this routine, as it short-circuits
3550 some of Perl's fundamental security features. XS module authors should
3551 not use this function unless they fully understand all the implications
3552 of unconditionally untainting the value. Untainting should be done in
3553 the standard perl fashion, via a carefully crafted regexp, rather than
3554 directly untainting variables.
3555
3556         void    SvTAINTED_off (SV* sv)
3557
3558 =item SvTAINTED_on
3559
3560 Marks an SV as tainted.
3561
3562         void    SvTAINTED_on (SV* sv)
3563
3564 =item SVt_IV
3565
3566 Integer type flag for scalars.  See C<svtype>.
3567
3568 =item SVt_PV
3569
3570 Pointer type flag for scalars.  See C<svtype>.
3571
3572 =item SVt_PVAV
3573
3574 Type flag for arrays.  See C<svtype>.
3575
3576 =item SVt_PVCV
3577
3578 Type flag for code refs.  See C<svtype>.
3579
3580 =item SVt_PVHV
3581
3582 Type flag for hashes.  See C<svtype>.
3583
3584 =item SVt_PVMG
3585
3586 Type flag for blessed scalars.  See C<svtype>.
3587
3588 =item SVt_NV
3589
3590 Double type flag for scalars.  See C<svtype>.
3591
3592 =item SvTRUE
3593
3594 Returns a boolean indicating whether Perl would evaluate the SV as true or
3595 false, defined or undefined.  Does not handle 'get' magic.
3596
3597         int     SvTRUE (SV* sv)
3598
3599 =item SvTYPE
3600
3601 Returns the type of the SV.  See C<svtype>.
3602
3603         svtype  SvTYPE (SV* sv)
3604
3605 =item svtype
3606
3607 An enum of flags for Perl types.  These are found in the file B<sv.h> in the
3608 C<svtype> enum.  Test these flags with the C<SvTYPE> macro.
3609
3610 =item PL_sv_undef
3611
3612 This is the C<undef> SV.  Always refer to this as C<&PL_sv_undef>.
3613
3614 =item sv_unref
3615
3616 Unsets the RV status of the SV, and decrements the reference count of
3617 whatever was being referenced by the RV.  This can almost be thought of
3618 as a reversal of C<newSVrv>.  See C<SvROK_off>.
3619
3620         void    sv_unref (SV* sv)
3621
3622 =item SvUPGRADE
3623
3624 Used to upgrade an SV to a more complex form.  Uses C<sv_upgrade> to perform
3625 the upgrade if necessary.  See C<svtype>.
3626
3627         bool    SvUPGRADE (SV* sv, svtype mt)
3628
3629 =item sv_upgrade
3630
3631 Upgrade an SV to a more complex form.  Use C<SvUPGRADE>.  See C<svtype>.
3632
3633 =item sv_usepvn
3634
3635 Tells an SV to use C<ptr> to find its string value.  Normally the string is
3636 stored inside the SV but sv_usepvn allows the SV to use an outside string.
3637 The C<ptr> should point to memory that was allocated by C<malloc>.  The
3638 string length, C<len>, must be supplied.  This function will realloc the
3639 memory pointed to by C<ptr>, so that pointer should not be freed or used by
3640 the programmer after giving it to sv_usepvn.  Does not handle 'set' magic.
3641 See C<sv_usepvn_mg>.
3642
3643         void    sv_usepvn (SV* sv, char* ptr, STRLEN len)
3644
3645 =item sv_usepvn_mg
3646
3647 Like C<sv_usepvn>, but also handles 'set' magic.
3648
3649         void    sv_usepvn_mg (SV* sv, char* ptr, STRLEN len)
3650
3651 =item sv_vcatpvfn(sv, pat, patlen, args, svargs, svmax, used_locale)
3652
3653 Processes its arguments like C<vsprintf> and appends the formatted output
3654 to an SV.  Uses an array of SVs if the C style variable argument list is
3655 missing (NULL).  Indicates if locale information has been used for formatting.
3656
3657         void    sv_catpvfn (SV* sv, const char* pat, STRLEN patlen,
3658                             va_list *args, SV **svargs, I32 svmax,
3659                             bool *used_locale);
3660
3661 =item sv_vsetpvfn(sv, pat, patlen, args, svargs, svmax, used_locale)
3662
3663 Works like C<vcatpvfn> but copies the text into the SV instead of
3664 appending it.
3665
3666         void    sv_setpvfn (SV* sv, const char* pat, STRLEN patlen,
3667                             va_list *args, SV **svargs, I32 svmax,
3668                             bool *used_locale);
3669
3670 =item SvUV
3671
3672 Coerces the given SV to an unsigned integer and returns it.
3673
3674         UV      SvUV(SV* sv)
3675
3676 =item SvUVX
3677
3678 Returns the unsigned integer which is stored in the SV, assuming SvIOK is true.
3679
3680         UV      SvUVX(SV* sv)
3681
3682 =item PL_sv_yes
3683
3684 This is the C<true> SV.  See C<PL_sv_no>.  Always refer to this as C<&PL_sv_yes>.
3685
3686 =item THIS
3687
3688 Variable which is setup by C<xsubpp> to designate the object in a C++ XSUB.
3689 This is always the proper type for the C++ object.  See C<CLASS> and
3690 L<perlxs/"Using XS With C++">.
3691
3692 =item toLOWER
3693
3694 Converts the specified character to lowercase.
3695
3696         int     toLOWER (char c)
3697
3698 =item toUPPER
3699
3700 Converts the specified character to uppercase.
3701
3702         int     toUPPER (char c)
3703
3704 =item warn
3705
3706 This is the XSUB-writer's interface to Perl's C<warn> function.  Use this
3707 function the same way you use the C C<printf> function.  See C<croak()>.
3708
3709 =item XPUSHi
3710
3711 Push an integer onto the stack, extending the stack if necessary.  Handles
3712 'set' magic. See C<PUSHi>.
3713
3714         XPUSHi(int d)
3715
3716 =item XPUSHn
3717
3718 Push a double onto the stack, extending the stack if necessary.  Handles 'set'
3719 magic.  See C<PUSHn>.
3720
3721         XPUSHn(double d)
3722
3723 =item XPUSHp
3724
3725 Push a string onto the stack, extending the stack if necessary.  The C<len>
3726 indicates the length of the string.  Handles 'set' magic.  See C<PUSHp>.
3727
3728         XPUSHp(char *c, int len)
3729
3730 =item XPUSHs
3731
3732 Push an SV onto the stack, extending the stack if necessary.  Does not
3733 handle 'set' magic.  See C<PUSHs>.
3734
3735         XPUSHs(sv)
3736
3737 =item XPUSHu
3738
3739 Push an unsigned integer onto the stack, extending the stack if
3740 necessary.  See C<PUSHu>.
3741
3742 =item XS
3743
3744 Macro to declare an XSUB and its C parameter list.  This is handled by
3745 C<xsubpp>.
3746
3747 =item XSRETURN
3748
3749 Return from XSUB, indicating number of items on the stack.  This is usually
3750 handled by C<xsubpp>.
3751
3752         XSRETURN(int x)
3753
3754 =item XSRETURN_EMPTY
3755
3756 Return an empty list from an XSUB immediately.
3757
3758         XSRETURN_EMPTY;
3759
3760 =item XSRETURN_IV
3761
3762 Return an integer from an XSUB immediately.  Uses C<XST_mIV>.
3763
3764         XSRETURN_IV(IV v)
3765
3766 =item XSRETURN_NO
3767
3768 Return C<&PL_sv_no> from an XSUB immediately.  Uses C<XST_mNO>.
3769
3770         XSRETURN_NO;
3771
3772 =item XSRETURN_NV
3773
3774 Return an double from an XSUB immediately.  Uses C<XST_mNV>.
3775
3776         XSRETURN_NV(NV v)
3777
3778 =item XSRETURN_PV
3779
3780 Return a copy of a string from an XSUB immediately.  Uses C<XST_mPV>.
3781
3782         XSRETURN_PV(char *v)
3783
3784 =item XSRETURN_UNDEF
3785
3786 Return C<&PL_sv_undef> from an XSUB immediately.  Uses C<XST_mUNDEF>.
3787
3788         XSRETURN_UNDEF;
3789
3790 =item XSRETURN_YES
3791
3792 Return C<&PL_sv_yes> from an XSUB immediately.  Uses C<XST_mYES>.
3793
3794         XSRETURN_YES;
3795
3796 =item XST_mIV
3797
3798 Place an integer into the specified position C<i> on the stack.  The value is
3799 stored in a new mortal SV.
3800
3801         XST_mIV( int i, IV v )
3802
3803 =item XST_mNV
3804
3805 Place a double into the specified position C<i> on the stack.  The value is
3806 stored in a new mortal SV.
3807
3808         XST_mNV( int i, NV v )
3809
3810 =item XST_mNO
3811
3812 Place C<&PL_sv_no> into the specified position C<i> on the stack.
3813
3814         XST_mNO( int i )
3815
3816 =item XST_mPV
3817
3818 Place a copy of a string into the specified position C<i> on the stack.  The
3819 value is stored in a new mortal SV.
3820
3821         XST_mPV( int i, char *v )
3822
3823 =item XST_mUNDEF
3824
3825 Place C<&PL_sv_undef> into the specified position C<i> on the stack.
3826
3827         XST_mUNDEF( int i )
3828
3829 =item XST_mYES
3830
3831 Place C<&PL_sv_yes> into the specified position C<i> on the stack.
3832
3833         XST_mYES( int i )
3834
3835 =item XS_VERSION
3836
3837 The version identifier for an XS module.  This is usually handled
3838 automatically by C<ExtUtils::MakeMaker>.  See C<XS_VERSION_BOOTCHECK>.
3839
3840 =item XS_VERSION_BOOTCHECK
3841
3842 Macro to verify that a PM module's $VERSION variable matches the XS module's
3843 C<XS_VERSION> variable.  This is usually handled automatically by
3844 C<xsubpp>.  See L<perlxs/"The VERSIONCHECK: Keyword">.
3845
3846 =item Zero
3847
3848 The XSUB-writer's interface to the C C<memzero> function.  The C<d> is the
3849 destination, C<n> is the number of items, and C<t> is the type.
3850
3851         void    Zero( d, n, t )
3852
3853 =back
3854
3855 =head1 AUTHORS
3856
3857 Until May 1997, this document was maintained by Jeff Okamoto
3858 <okamoto@corp.hp.com>.  It is now maintained as part of Perl itself.
3859
3860 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
3861 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
3862 Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer,
3863 Stephen McCamant, and Gurusamy Sarathy.
3864
3865 API Listing originally by Dean Roehrich <roehrich@cray.com>.