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