This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
expanded flock() docs
[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 =head2 Datatypes
12
13 Perl has three typedefs that handle Perl's three main data types:
14
15     SV  Scalar Value
16     AV  Array Value
17     HV  Hash Value
18
19 Each typedef has specific routines that manipulate the various data types.
20
21 =head2 What is an "IV"?
22
23 Perl uses a special typedef IV which is a simple integer type that is
24 guaranteed to be large enough to hold a pointer (as well as an integer).
25
26 Perl also uses two special typedefs, I32 and I16, which will always be at
27 least 32-bits and 16-bits long, respectively.
28
29 =head2 Working with SV's
30
31 An SV can be created and loaded with one command.  There are four types of
32 values that can be loaded: an integer value (IV), a double (NV), a string,
33 (PV), and another scalar (SV).
34
35 The four routines are:
36
37     SV*  newSViv(IV);
38     SV*  newSVnv(double);
39     SV*  newSVpv(char*, int);
40     SV*  newSVsv(SV*);
41
42 To change the value of an *already-existing* SV, there are five routines:
43
44     void  sv_setiv(SV*, IV);
45     void  sv_setnv(SV*, double);
46     void  sv_setpvn(SV*, char*, int)
47     void  sv_setpv(SV*, char*);
48     void  sv_setsv(SV*, SV*);
49
50 Notice that you can choose to specify the length of the string to be
51 assigned by using C<sv_setpvn> or C<newSVpv>, or you may allow Perl to
52 calculate the length by using C<sv_setpv> or by specifying 0 as the second
53 argument to C<newSVpv>.  Be warned, though, that Perl will determine the
54 string's length by using C<strlen>, which depends on the string terminating
55 with a NUL character.
56
57 All SV's that will contain strings should, but need not, be terminated
58 with a NUL character.  If it is not NUL-terminated there is a risk of
59 core dumps and corruptions from code which passes the string to C
60 functions or system calls which expect a NUL-terminated string.
61 Perl's own functions typically add a trailing NUL for this reason.
62 Nevertheless, you should be very careful when you pass a string stored
63 in an SV to a C function or system call.
64
65 To access the actual value that an SV points to, you can use the macros:
66
67     SvIV(SV*)
68     SvNV(SV*)
69     SvPV(SV*, STRLEN len)
70
71 which will automatically coerce the actual scalar type into an IV, double,
72 or string.
73
74 In the C<SvPV> macro, the length of the string returned is placed into the
75 variable C<len> (this is a macro, so you do I<not> use C<&len>).  If you do not
76 care what the length of the data is, use the global variable C<na>.  Remember,
77 however, that Perl allows arbitrary strings of data that may both contain
78 NUL's and might not be terminated by a NUL.
79
80 If you want to know if the scalar value is TRUE, you can use:
81
82     SvTRUE(SV*)
83
84 Although Perl will automatically grow strings for you, if you need to force
85 Perl to allocate more memory for your SV, you can use the macro
86
87     SvGROW(SV*, STRLEN newlen)
88
89 which will determine if more memory needs to be allocated.  If so, it will
90 call the function C<sv_grow>.  Note that C<SvGROW> can only increase, not
91 decrease, the allocated memory of an SV and that it does not automatically
92 add a byte for the a trailing NUL (perl's own string functions typically do
93 SvGROW(sv, len + 1)).
94
95 If you have an SV and want to know what kind of data Perl thinks is stored
96 in it, you can use the following macros to check the type of SV you have.
97
98     SvIOK(SV*)
99     SvNOK(SV*)
100     SvPOK(SV*)
101
102 You can get and set the current length of the string stored in an SV with
103 the following macros:
104
105     SvCUR(SV*)
106     SvCUR_set(SV*, I32 val)
107
108 You can also get a pointer to the end of the string stored in the SV
109 with the macro:
110
111     SvEND(SV*)
112
113 But note that these last three macros are valid only if C<SvPOK()> is true.
114
115 If you want to append something to the end of string stored in an C<SV*>,
116 you can use the following functions:
117
118     void  sv_catpv(SV*, char*);
119     void  sv_catpvn(SV*, char*, int);
120     void  sv_catsv(SV*, SV*);
121
122 The first function calculates the length of the string to be appended by
123 using C<strlen>.  In the second, you specify the length of the string
124 yourself.  The third function extends the string stored in the first SV
125 with the string stored in the second SV.  It also forces the second SV to
126 be interpreted as a string.
127
128 If you know the name of a scalar variable, you can get a pointer to its SV
129 by using the following:
130
131     SV*  perl_get_sv("package::varname", FALSE);
132
133 This returns NULL if the variable does not exist.
134
135 If you want to know if this variable (or any other SV) is actually C<defined>,
136 you can call:
137
138     SvOK(SV*)
139
140 The scalar C<undef> value is stored in an SV instance called C<sv_undef>.  Its
141 address can be used whenever an C<SV*> is needed.
142
143 There are also the two values C<sv_yes> and C<sv_no>, which contain Boolean
144 TRUE and FALSE values, respectively.  Like C<sv_undef>, their addresses can
145 be used whenever an C<SV*> is needed.
146
147 Do not be fooled into thinking that C<(SV *) 0> is the same as C<&sv_undef>.
148 Take this code:
149
150     SV* sv = (SV*) 0;
151     if (I-am-to-return-a-real-value) {
152             sv = sv_2mortal(newSViv(42));
153     }
154     sv_setsv(ST(0), sv);
155
156 This code tries to return a new SV (which contains the value 42) if it should
157 return a real value, or undef otherwise.  Instead it has returned a null
158 pointer which, somewhere down the line, will cause a segmentation violation,
159 bus error, or just weird results.  Change the zero to C<&sv_undef> in the first
160 line and all will be well.
161
162 To free an SV that you've created, call C<SvREFCNT_dec(SV*)>.  Normally this
163 call is not necessary (see the section on L<Mortality>).
164
165 =head2 What's Really Stored in an SV?
166
167 Recall that the usual method of determining the type of scalar you have is
168 to use C<Sv*OK> macros.  Because a scalar can be both a number and a string,
169 usually these macros will always return TRUE and calling the C<Sv*V>
170 macros will do the appropriate conversion of string to integer/double or
171 integer/double to string.
172
173 If you I<really> need to know if you have an integer, double, or string
174 pointer in an SV, you can use the following three macros instead:
175
176     SvIOKp(SV*)
177     SvNOKp(SV*)
178     SvPOKp(SV*)
179
180 These will tell you if you truly have an integer, double, or string pointer
181 stored in your SV.  The "p" stands for private.
182
183 In general, though, it's best to use the C<Sv*V> macros.
184
185 =head2 Working with AV's
186
187 There are two ways to create and load an AV.  The first method creates an
188 empty AV:
189
190     AV*  newAV();
191
192 The second method both creates the AV and initially populates it with SV's:
193
194     AV*  av_make(I32 num, SV **ptr);
195
196 The second argument points to an array containing C<num> C<SV*>'s.  Once the
197 AV has been created, the SV's can be destroyed, if so desired.
198
199 Once the AV has been created, the following operations are possible on AV's:
200
201     void  av_push(AV*, SV*);
202     SV*   av_pop(AV*);
203     SV*   av_shift(AV*);
204     void  av_unshift(AV*, I32 num);
205
206 These should be familiar operations, with the exception of C<av_unshift>.
207 This routine adds C<num> elements at the front of the array with the C<undef>
208 value.  You must then use C<av_store> (described below) to assign values
209 to these new elements.
210
211 Here are some other functions:
212
213     I32   av_len(AV*);
214     SV**  av_fetch(AV*, I32 key, I32 lval);
215     SV**  av_store(AV*, I32 key, SV* val);
216
217 The C<av_len> function returns the highest index value in array (just
218 like $#array in Perl).  If the array is empty, -1 is returned.  The
219 C<av_fetch> function returns the value at index C<key>, but if C<lval>
220 is non-zero, then C<av_fetch> will store an undef value at that index.
221 The C<av_store> function stores the value C<val> at index C<key>.
222 note that C<av_fetch> and C<av_store> both return C<SV**>'s, not C<SV*>'s
223 as their return value.
224
225     void  av_clear(AV*);
226     void  av_undef(AV*);
227     void  av_extend(AV*, I32 key);
228
229 The C<av_clear> function deletes all the elements in the AV* array, but
230 does not actually delete the array itself.  The C<av_undef> function will
231 delete all the elements in the array plus the array itself.  The
232 C<av_extend> function extends the array so that it contains C<key>
233 elements.  If C<key> is less than the current length of the array, then
234 nothing is done.
235
236 If you know the name of an array variable, you can get a pointer to its AV
237 by using the following:
238
239     AV*  perl_get_av("package::varname", FALSE);
240
241 This returns NULL if the variable does not exist.
242
243 =head2 Working with HV's
244
245 To create an HV, you use the following routine:
246
247     HV*  newHV();
248
249 Once the HV has been created, the following operations are possible on HV's:
250
251     SV**  hv_store(HV*, char* key, U32 klen, SV* val, U32 hash);
252     SV**  hv_fetch(HV*, char* key, U32 klen, I32 lval);
253
254 The C<klen> parameter is the length of the key being passed in (Note that
255 you cannot pass 0 in as a value of C<klen> to tell Perl to measure the
256 length of the key).  The C<val> argument contains the SV pointer to the
257 scalar being stored, and C<hash> is the pre-computed hash value (zero if
258 you want C<hv_store> to calculate it for you).  The C<lval> parameter
259 indicates whether this fetch is actually a part of a store operation, in
260 which case a new undefined value will be added to the HV with the supplied
261 key and C<hv_fetch> will return as if the value had already existed.
262
263 Remember that C<hv_store> and C<hv_fetch> return C<SV**>'s and not just
264 C<SV*>.  To access the scalar value, you must first dereference the return
265 value.  However, you should check to make sure that the return value is
266 not NULL before dereferencing it.
267
268 These two functions check if a hash table entry exists, and deletes it.
269
270     bool  hv_exists(HV*, char* key, U32 klen);
271     SV*   hv_delete(HV*, char* key, U32 klen, I32 flags);
272
273 If C<flags> does not include the C<G_DISCARD> flag then C<hv_delete> will
274 create and return a mortal copy of the deleted value.
275
276 And more miscellaneous functions:
277
278     void   hv_clear(HV*);
279     void   hv_undef(HV*);
280
281 Like their AV counterparts, C<hv_clear> deletes all the entries in the hash
282 table but does not actually delete the hash table.  The C<hv_undef> deletes
283 both the entries and the hash table itself.
284
285 Perl keeps the actual data in linked list of structures with a typedef of HE.
286 These contain the actual key and value pointers (plus extra administrative
287 overhead).  The key is a string pointer; the value is an C<SV*>.  However,
288 once you have an C<HE*>, to get the actual key and value, use the routines
289 specified below.
290
291     I32    hv_iterinit(HV*);
292             /* Prepares starting point to traverse hash table */
293     HE*    hv_iternext(HV*);
294             /* Get the next entry, and return a pointer to a
295                structure that has both the key and value */
296     char*  hv_iterkey(HE* entry, I32* retlen);
297             /* Get the key from an HE structure and also return
298                the length of the key string */
299     SV*    hv_iterval(HV*, HE* entry);
300             /* Return a SV pointer to the value of the HE
301                structure */
302     SV*    hv_iternextsv(HV*, char** key, I32* retlen);
303             /* This convenience routine combines hv_iternext,
304                hv_iterkey, and hv_iterval.  The key and retlen
305                arguments are return values for the key and its
306                length.  The value is returned in the SV* argument */
307
308 If you know the name of a hash variable, you can get a pointer to its HV
309 by using the following:
310
311     HV*  perl_get_hv("package::varname", FALSE);
312
313 This returns NULL if the variable does not exist.
314
315 The hash algorithm is defined in the PERL_HASH(hash, key, klen) macro:
316
317     i = klen;
318     hash = 0;
319     s = key;
320     while (i--)
321         hash = hash * 33 + *s++;
322
323 =head2 References
324
325 References are a special type of scalar that point to other data types
326 (including references).
327
328 To create a reference, use either of the following functions:
329
330     SV* newRV_inc((SV*) thing);
331     SV* newRV_noinc((SV*) thing);
332
333 The C<thing> argument can be any of an C<SV*>, C<AV*>, or C<HV*>.  The
334 functions are identical except that C<newRV_inc> increments the reference
335 count of the C<thing>, while C<newRV_noinc> does not.  For historical
336 reasons, C<newRV> is a synonym for C<newRV_inc>.
337
338 Once you have a reference, you can use the following macro to dereference
339 the reference:
340
341     SvRV(SV*)
342
343 then call the appropriate routines, casting the returned C<SV*> to either an
344 C<AV*> or C<HV*>, if required.
345
346 To determine if an SV is a reference, you can use the following macro:
347
348     SvROK(SV*)
349
350 To discover what type of value the reference refers to, use the following
351 macro and then check the return value.
352
353     SvTYPE(SvRV(SV*))
354
355 The most useful types that will be returned are:
356
357     SVt_IV    Scalar
358     SVt_NV    Scalar
359     SVt_PV    Scalar
360     SVt_RV    Scalar
361     SVt_PVAV  Array
362     SVt_PVHV  Hash
363     SVt_PVCV  Code
364     SVt_PVGV  Glob (possible a file handle)
365     SVt_PVMG  Blessed or Magical Scalar
366
367     See the sv.h header file for more details.
368
369 =head2 Blessed References and Class Objects
370
371 References are also used to support object-oriented programming.  In the
372 OO lexicon, an object is simply a reference that has been blessed into a
373 package (or class).  Once blessed, the programmer may now use the reference
374 to access the various methods in the class.
375
376 A reference can be blessed into a package with the following function:
377
378     SV* sv_bless(SV* sv, HV* stash);
379
380 The C<sv> argument must be a reference.  The C<stash> argument specifies
381 which class the reference will belong to.  See the section on L<Stashes>
382 for information on converting class names into stashes.
383
384 /* Still under construction */
385
386 Upgrades rv to reference if not already one.  Creates new SV for rv to
387 point to.
388 If classname is non-null, the SV is blessed into the specified class.
389 SV is returned.
390
391         SV* newSVrv(SV* rv, char* classname);
392
393 Copies integer or double into an SV whose reference is rv.  SV is blessed
394 if classname is non-null.
395
396         SV* sv_setref_iv(SV* rv, char* classname, IV iv);
397         SV* sv_setref_nv(SV* rv, char* classname, NV iv);
398
399 Copies the pointer value (I<the address, not the string!>) into an SV whose
400 reference is rv.  SV is blessed if classname is non-null.
401
402         SV* sv_setref_pv(SV* rv, char* classname, PV iv);
403
404 Copies string into an SV whose reference is rv.
405 Set length to 0 to let Perl calculate the string length.
406 SV is blessed if classname is non-null.
407
408         SV* sv_setref_pvn(SV* rv, char* classname, PV iv, int length);
409
410         int sv_isa(SV* sv, char* name);
411         int sv_isobject(SV* sv);
412
413 =head2 Creating New Variables
414
415 To create a new Perl variable with an undef value which can be accessed from
416 your Perl script, use the following routines, depending on the variable type.
417
418     SV*  perl_get_sv("package::varname", TRUE);
419     AV*  perl_get_av("package::varname", TRUE);
420     HV*  perl_get_hv("package::varname", TRUE);
421
422 Notice the use of TRUE as the second parameter.  The new variable can now
423 be set, using the routines appropriate to the data type.
424
425 There are additional macros whose values may be bitwise OR'ed with the
426 C<TRUE> argument to enable certain extra features.  Those bits are:
427
428     GV_ADDMULTI Marks the variable as multiply defined, thus preventing the
429                 "Indentifier <varname> used only once: possible typo" warning.
430     GV_ADDWARN  Issues the warning "Had to create <varname> unexpectedly" if
431                 the variable did not exist before the function was called.
432
433 If you do not specify a package name, the variable is created in the current
434 package.
435
436 =head2 Reference Counts and Mortality
437
438 Perl uses an reference count-driven garbage collection mechanism. SV's,
439 AV's, or HV's (xV for short in the following) start their life with a
440 reference count of 1.  If the reference count of an xV ever drops to 0,
441 then it will be destroyed and its memory made available for reuse.
442
443 This normally doesn't happen at the Perl level unless a variable is
444 undef'ed or the last variable holding a reference to it is changed or
445 overwritten.  At the internal level, however, reference counts can be
446 manipulated with the following macros:
447
448     int SvREFCNT(SV* sv);
449     SV* SvREFCNT_inc(SV* sv);
450     void SvREFCNT_dec(SV* sv);
451
452 However, there is one other function which manipulates the reference
453 count of its argument.  The C<newRV_inc> function, you will recall,
454 creates a reference to the specified argument.  As a side effect,
455 it increments the argument's reference count.  If this is not what
456 you want, use C<newRV_noinc> instead.
457
458 For example, imagine you want to return a reference from an XSUB function.
459 Inside the XSUB routine, you create an SV which initially has a reference
460 count of one.  Then you call C<newRV_inc>, passing it the just-created SV.
461 This returns the reference as a new SV, but the reference count of the
462 SV you passed to C<newRV_inc> has been incremented to two.  Now you
463 return the reference from the XSUB routine and forget about the SV.
464 But Perl hasn't!  Whenever the returned reference is destroyed, the
465 reference count of the original SV is decreased to one and nothing happens.
466 The SV will hang around without any way to access it until Perl itself
467 terminates.  This is a memory leak.
468
469 The correct procedure, then, is to use C<newRV_noinc> instead of
470 C<newRV_inc>.  Then, if and when the last reference is destroyed,
471 the reference count of the SV will go to zero and it will be destroyed,
472 stopping any memory leak.
473
474 There are some convenience functions available that can help with the
475 destruction of xV's.  These functions introduce the concept of "mortality".
476 An xV that is mortal has had its reference count marked to be decremented,
477 but not actually decremented, until "a short time later".  Generally the
478 term "short time later" means a single Perl statement, such as a call to
479 an XSUB function.  The actual determinant for when mortal xV's have their
480 reference count decremented depends on two macros, SAVETMPS and FREETMPS.
481 See L<perlcall> and L<perlxs> for more details on these macros.
482
483 "Mortalization" then is at its simplest a deferred C<SvREFCNT_dec>.
484 However, if you mortalize a variable twice, the reference count will
485 later be decremented twice.
486
487 You should be careful about creating mortal variables.  Strange things
488 can happen if you make the same value mortal within multiple contexts,
489 or if you make a variable mortal multiple times.
490
491 To create a mortal variable, use the functions:
492
493     SV*  sv_newmortal()
494     SV*  sv_2mortal(SV*)
495     SV*  sv_mortalcopy(SV*)
496
497 The first call creates a mortal SV, the second converts an existing
498 SV to a mortal SV (and thus defers a call to C<SvREFCNT_dec>), and the
499 third creates a mortal copy of an existing SV.
500
501 The mortal routines are not just for SV's -- AV's and HV's can be
502 made mortal by passing their address (type-casted to C<SV*>) to the
503 C<sv_2mortal> or C<sv_mortalcopy> routines.
504
505 =head2 Stashes and Globs
506
507 A stash is a hash table (associative array) that contains all of the
508 different objects that are contained within a package.  Each key of the
509 stash is a symbol name (shared by all the different types of objects
510 that have the same name), and each value in the hash table is called a
511 GV (for Glob Value).  This GV in turn contains references to the various
512 objects of that name, including (but not limited to) the following:
513
514     Scalar Value
515     Array Value
516     Hash Value
517     File Handle
518     Directory Handle
519     Format
520     Subroutine
521
522 There is a single stash called "defstash" that holds the items that exist
523 in the "main" package.  To get at the items in other packages, append the
524 string "::" to the package name.  The items in the "Foo" package are in
525 the stash "Foo::" in defstash.  The items in the "Bar::Baz" package are
526 in the stash "Baz::" in "Bar::"'s stash.
527
528 To get the stash pointer for a particular package, use the function:
529
530     HV*  gv_stashpv(char* name, I32 create)
531     HV*  gv_stashsv(SV*, I32 create)
532
533 The first function takes a literal string, the second uses the string stored
534 in the SV.  Remember that a stash is just a hash table, so you get back an
535 C<HV*>.  The C<create> flag will create a new package if it is set.
536
537 The name that C<gv_stash*v> wants is the name of the package whose symbol table
538 you want.  The default package is called C<main>.  If you have multiply nested
539 packages, pass their names to C<gv_stash*v>, separated by C<::> as in the Perl
540 language itself.
541
542 Alternately, if you have an SV that is a blessed reference, you can find
543 out the stash pointer by using:
544
545     HV*  SvSTASH(SvRV(SV*));
546
547 then use the following to get the package name itself:
548
549     char*  HvNAME(HV* stash);
550
551 If you need to bless or re-bless an object you can use the following
552 function:
553
554     SV*  sv_bless(SV*, HV* stash)
555
556 where the first argument, an C<SV*>, must be a reference, and the second
557 argument is a stash.  The returned C<SV*> can now be used in the same way
558 as any other SV.
559
560 For more information on references and blessings, consult L<perlref>.
561
562 =head2 Magic
563
564 [This section still under construction.  Ignore everything here.  Post no
565 bills.  Everything not permitted is forbidden.]
566
567 Any SV may be magical, that is, it has special features that a normal
568 SV does not have.  These features are stored in the SV structure in a
569 linked list of C<struct magic>'s, typedef'ed to C<MAGIC>.
570
571     struct magic {
572         MAGIC*      mg_moremagic;
573         MGVTBL*     mg_virtual;
574         U16         mg_private;
575         char        mg_type;
576         U8          mg_flags;
577         SV*         mg_obj;
578         char*       mg_ptr;
579         I32         mg_len;
580     };
581
582 Note this is current as of patchlevel 0, and could change at any time.
583
584 =head2 Assigning Magic
585
586 Perl adds magic to an SV using the sv_magic function:
587
588     void sv_magic(SV* sv, SV* obj, int how, char* name, I32 namlen);
589
590 The C<sv> argument is a pointer to the SV that is to acquire a new magical
591 feature.
592
593 If C<sv> is not already magical, Perl uses the C<SvUPGRADE> macro to
594 set the C<SVt_PVMG> flag for the C<sv>.  Perl then continues by adding
595 it to the beginning of the linked list of magical features.  Any prior
596 entry of the same type of magic is deleted.  Note that this can be
597 overridden, and multiple instances of the same type of magic can be
598 associated with an SV.
599
600 The C<name> and C<namlem> arguments are used to associate a string with
601 the magic, typically the name of a variable. C<namlem> is stored in the
602 C<mg_len> field and if C<name> is non-null and C<namlem> >= 0 a malloc'd
603 copy of the name is stored in C<mg_ptr> field.
604
605 The sv_magic function uses C<how> to determine which, if any, predefined
606 "Magic Virtual Table" should be assigned to the C<mg_virtual> field.
607 See the "Magic Virtual Table" section below.  The C<how> argument is also
608 stored in the C<mg_type> field.
609
610 The C<obj> argument is stored in the C<mg_obj> field of the C<MAGIC>
611 structure.  If it is not the same as the C<sv> argument, the reference
612 count of the C<obj> object is incremented.  If it is the same, or if
613 the C<how> argument is "#", or if it is a null pointer, then C<obj> is
614 merely stored, without the reference count being incremented.
615
616 There is also a function to add magic to an C<HV>:
617
618     void hv_magic(HV *hv, GV *gv, int how);
619
620 This simply calls C<sv_magic> and coerces the C<gv> argument into an C<SV>.
621
622 To remove the magic from an SV, call the function sv_unmagic:
623
624     void sv_unmagic(SV *sv, int type);
625
626 The C<type> argument should be equal to the C<how> value when the C<SV>
627 was initially made magical.
628
629 =head2 Magic Virtual Tables
630
631 The C<mg_virtual> field in the C<MAGIC> structure is a pointer to a
632 C<MGVTBL>, which is a structure of function pointers and stands for
633 "Magic Virtual Table" to handle the various operations that might be
634 applied to that variable.
635
636 The C<MGVTBL> has five pointers to the following routine types:
637
638     int  (*svt_get)(SV* sv, MAGIC* mg);
639     int  (*svt_set)(SV* sv, MAGIC* mg);
640     U32  (*svt_len)(SV* sv, MAGIC* mg);
641     int  (*svt_clear)(SV* sv, MAGIC* mg);
642     int  (*svt_free)(SV* sv, MAGIC* mg);
643
644 This MGVTBL structure is set at compile-time in C<perl.h> and there are
645 currently 19 types (or 21 with overloading turned on).  These different
646 structures contain pointers to various routines that perform additional
647 actions depending on which function is being called.
648
649     Function pointer    Action taken
650     ----------------    ------------
651     svt_get             Do something after the value of the SV is retrieved.
652     svt_set             Do something after the SV is assigned a value.
653     svt_len             Report on the SV's length.
654     svt_clear           Clear something the SV represents.
655     svt_free            Free any extra storage associated with the SV.
656
657 For instance, the MGVTBL structure called C<vtbl_sv> (which corresponds
658 to an C<mg_type> of '\0') contains:
659
660     { magic_get, magic_set, magic_len, 0, 0 }
661
662 Thus, when an SV is determined to be magical and of type '\0', if a get
663 operation is being performed, the routine C<magic_get> is called.  All
664 the various routines for the various magical types begin with C<magic_>.
665
666 The current kinds of Magic Virtual Tables are:
667
668     mg_type  MGVTBL              Type of magical
669     -------  ------              ----------------------------
670     \0       vtbl_sv             Regexp???
671     A        vtbl_amagic         Operator Overloading
672     a        vtbl_amagicelem     Operator Overloading
673     c        0                   Used in Operator Overloading
674     B        vtbl_bm             Boyer-Moore???
675     E        vtbl_env            %ENV hash
676     e        vtbl_envelem        %ENV hash element
677     g        vtbl_mglob          Regexp /g flag???
678     I        vtbl_isa            @ISA array
679     i        vtbl_isaelem        @ISA array element
680     L        0 (but sets RMAGICAL)     Perl Module/Debugger???
681     l        vtbl_dbline         Debugger?
682     P        vtbl_pack           Tied Array or Hash
683     p        vtbl_packelem       Tied Array or Hash element
684     q        vtbl_packelem       Tied Scalar or Handle
685     S        vtbl_sig            Signal Hash
686     s        vtbl_sigelem        Signal Hash element
687     t        vtbl_taint          Taintedness
688     U        vtbl_uvar           ???
689     v        vtbl_vec            Vector
690     x        vtbl_substr         Substring???
691     y        vtbl_itervar        Shadow "foreach" iterator variable
692     *        vtbl_glob           GV???
693     #        vtbl_arylen         Array Length
694     .        vtbl_pos            $. scalar variable
695     ~        None                Used by certain extensions
696
697 When an upper-case and lower-case letter both exist in the table, then the
698 upper-case letter is used to represent some kind of composite type (a list
699 or a hash), and the lower-case letter is used to represent an element of
700 that composite type.
701
702 The '~' magic type is defined specifically for use by extensions and
703 will not be used by perl itself. Extensions can use ~ magic to 'attach'
704 private information to variables (typically objects).  This is especially
705 useful because there is no way for normal perl code to corrupt this
706 private information (unlike using extra elements of a hash object).
707
708 Note that because multiple extensions may be using ~ magic it is
709 important for extensions to take extra care with it.  Typically only
710 using it on objects blessed into the same class as the extension
711 is sufficient.  It may also be appropriate to add an I32 'signature'
712 at the top of the private data area and check that.
713
714 =head2 Finding Magic
715
716     MAGIC* mg_find(SV*, int type); /* Finds the magic pointer of that type */
717
718 This routine returns a pointer to the C<MAGIC> structure stored in the SV.
719 If the SV does not have that magical feature, C<NULL> is returned.  Also,
720 if the SV is not of type SVt_PVMG, Perl may core-dump.
721
722     int mg_copy(SV* sv, SV* nsv, char* key, STRLEN klen);
723
724 This routine checks to see what types of magic C<sv> has.  If the mg_type
725 field is an upper-case letter, then the mg_obj is copied to C<nsv>, but
726 the mg_type field is changed to be the lower-case letter.
727
728 =head2 Double-Typed SV's
729
730 Scalar variables normally contain only one type of value, an integer,
731 double, pointer, or reference.  Perl will automatically convert the
732 actual scalar data from the stored type into the requested type.
733
734 Some scalar variables contain more than one type of scalar data.  For
735 example, the variable C<$!> contains either the numeric value of C<errno>
736 or its string equivalent from either C<strerror> or C<sys_errlist[]>.
737
738 To force multiple data values into an SV, you must do two things: use the
739 C<sv_set*v> routines to add the additional scalar type, then set a flag
740 so that Perl will believe it contains more than one type of data.  The
741 four macros to set the flags are:
742
743         SvIOK_on
744         SvNOK_on
745         SvPOK_on
746         SvROK_on
747
748 The particular macro you must use depends on which C<sv_set*v> routine
749 you called first.  This is because every C<sv_set*v> routine turns on
750 only the bit for the particular type of data being set, and turns off
751 all the rest.
752
753 For example, to create a new Perl variable called "dberror" that contains
754 both the numeric and descriptive string error values, you could use the
755 following code:
756
757     extern int  dberror;
758     extern char *dberror_list;
759
760     SV* sv = perl_get_sv("dberror", TRUE);
761     sv_setiv(sv, (IV) dberror);
762     sv_setpv(sv, dberror_list[dberror]);
763     SvIOK_on(sv);
764
765 If the order of C<sv_setiv> and C<sv_setpv> had been reversed, then the
766 macro C<SvPOK_on> would need to be called instead of C<SvIOK_on>.
767
768 =head2 XSUB's and the Argument Stack
769
770 The XSUB mechanism is a simple way for Perl programs to access C subroutines.
771 An XSUB routine will have a stack that contains the arguments from the Perl
772 program, and a way to map from the Perl data structures to a C equivalent.
773
774 The stack arguments are accessible through the C<ST(n)> macro, which returns
775 the C<n>'th stack argument.  Argument 0 is the first argument passed in the
776 Perl subroutine call.  These arguments are C<SV*>, and can be used anywhere
777 an C<SV*> is used.
778
779 Most of the time, output from the C routine can be handled through use of
780 the RETVAL and OUTPUT directives.  However, there are some cases where the
781 argument stack is not already long enough to handle all the return values.
782 An example is the POSIX tzname() call, which takes no arguments, but returns
783 two, the local time zone's standard and summer time abbreviations.
784
785 To handle this situation, the PPCODE directive is used and the stack is
786 extended using the macro:
787
788     EXTEND(sp, num);
789
790 where C<sp> is the stack pointer, and C<num> is the number of elements the
791 stack should be extended by.
792
793 Now that there is room on the stack, values can be pushed on it using the
794 macros to push IV's, doubles, strings, and SV pointers respectively:
795
796     PUSHi(IV)
797     PUSHn(double)
798     PUSHp(char*, I32)
799     PUSHs(SV*)
800
801 And now the Perl program calling C<tzname>, the two values will be assigned
802 as in:
803
804     ($standard_abbrev, $summer_abbrev) = POSIX::tzname;
805
806 An alternate (and possibly simpler) method to pushing values on the stack is
807 to use the macros:
808
809     XPUSHi(IV)
810     XPUSHn(double)
811     XPUSHp(char*, I32)
812     XPUSHs(SV*)
813
814 These macros automatically adjust the stack for you, if needed.  Thus, you
815 do not need to call C<EXTEND> to extend the stack.
816
817 For more information, consult L<perlxs> and L<perlxstut>.
818
819 =head2 Calling Perl Routines from within C Programs
820
821 There are four routines that can be used to call a Perl subroutine from
822 within a C program.  These four are:
823
824     I32  perl_call_sv(SV*, I32);
825     I32  perl_call_pv(char*, I32);
826     I32  perl_call_method(char*, I32);
827     I32  perl_call_argv(char*, I32, register char**);
828
829 The routine most often used is C<perl_call_sv>.  The C<SV*> argument
830 contains either the name of the Perl subroutine to be called, or a
831 reference to the subroutine.  The second argument consists of flags
832 that control the context in which the subroutine is called, whether
833 or not the subroutine is being passed arguments, how errors should be
834 trapped, and how to treat return values.
835
836 All four routines return the number of arguments that the subroutine returned
837 on the Perl stack.
838
839 When using any of these routines (except C<perl_call_argv>), the programmer
840 must manipulate the Perl stack.  These include the following macros and
841 functions:
842
843     dSP
844     PUSHMARK()
845     PUTBACK
846     SPAGAIN
847     ENTER
848     SAVETMPS
849     FREETMPS
850     LEAVE
851     XPUSH*()
852     POP*()
853
854 For a detailed description of calling conventions from C to Perl,
855 consult L<perlcall>.
856
857 =head2 Memory Allocation
858
859 It is suggested that you use the version of malloc that is distributed
860 with Perl.  It keeps pools of various sizes of unallocated memory in
861 order to satisfy allocation requests more quickly.  However, on some
862 platforms, it may cause spurious malloc or free errors.
863
864     New(x, pointer, number, type);
865     Newc(x, pointer, number, type, cast);
866     Newz(x, pointer, number, type);
867
868 These three macros are used to initially allocate memory.
869
870 The first argument C<x> was a "magic cookie" that was used to keep track
871 of who called the macro, to help when debugging memory problems.  However,
872 the current code makes no use of this feature (most Perl developers now
873 use run-time memory checkers), so this argument can be any number.
874
875 The second argument C<pointer> should be the name of a variable that will
876 point to the newly allocated memory.
877
878 The third and fourth arguments C<number> and C<type> specify how many of
879 the specified type of data structure should be allocated.  The argument
880 C<type> is passed to C<sizeof>.  The final argument to C<Newc>, C<cast>,
881 should be used if the C<pointer> argument is different from the C<type>
882 argument.
883
884 Unlike the C<New> and C<Newc> macros, the C<Newz> macro calls C<memzero>
885 to zero out all the newly allocated memory.
886
887     Renew(pointer, number, type);
888     Renewc(pointer, number, type, cast);
889     Safefree(pointer)
890
891 These three macros are used to change a memory buffer size or to free a
892 piece of memory no longer needed.  The arguments to C<Renew> and C<Renewc>
893 match those of C<New> and C<Newc> with the exception of not needing the
894 "magic cookie" argument.
895
896     Move(source, dest, number, type);
897     Copy(source, dest, number, type);
898     Zero(dest, number, type);
899
900 These three macros are used to move, copy, or zero out previously allocated
901 memory.  The C<source> and C<dest> arguments point to the source and
902 destination starting points.  Perl will move, copy, or zero out C<number>
903 instances of the size of the C<type> data structure (using the C<sizeof>
904 function).
905
906 =head2 PerlIO
907
908 The most recent development releases of Perl has been experimenting with
909 removing Perl's dependency on the "normal" standard I/O suite and allowing
910 other stdio implementations to be used.  This involves creating a new
911 abstraction layer that then calls whichever implementation of stdio Perl
912 was compiled with.  All XSUB's should now use the functions in the PerlIO
913 abstraction layer and not make any assumptions about what kind of stdio
914 is being used.
915
916 For a complete description of the PerlIO abstraction, consult L<perlapio>.
917
918 =head2 Scratchpads
919
920 =head3 Putting a C value on Perl stack
921
922 A lot of opcodes (this is an elementary operation in the internal perl
923 stack machine) put an SV* on the stack. However, as an optimization
924 the corresponding SV is (usually) not recreated each time. The opcodes
925 reuse specially assigned SVs (I<target>s) which are (as a corollary)
926 not constantly freed/created.
927
928 Each of the targets is created only once (but see 
929 L<Scratchpads and recursion> below), and when an opcode needs to put
930 an integer, a double, or a string on stack, it just sets the
931 corresponding parts of its I<target> and puts the I<target> on stack.
932
933 The macro to put this target on stack is C<PUSHTARG>, and it is
934 directly used in some opcodes, as well as indirectly in zillions of
935 others, which use it via C<(X)PUSH[pni]>.
936
937 =head3 Scratchpads
938
939 The question remains on when the SV's which are I<target>s for opcodes
940 are created. The answer is that they are created when the current unit --
941 a subroutine or a file (for opcodes for statements outside of
942 subroutines) -- is compiled. During this time a special anonymous Perl
943 array is created, which is called a scratchpad for the current
944 unit.
945
946 A scratchpad keeps SV's which are lexicals for the current unit and are
947 targets for opcodes. One can deduce that an SV lives on a scratchpad
948 by looking on its flags: lexicals have C<SVs_PADMY> set, and
949 I<target>s have C<SVs_PADTMP> set.
950
951 The correspondence between OP's and I<target>s is not 1-to-1. Different
952 OP's in the compile tree of the unit can use the same target, if this
953 would not conflict with the expected life of the temporary.
954
955 =head3 Scratchpads and recursions
956
957 In fact it is not 100% true that a compiled unit contains a pointer to
958 the scratchpad AV. In fact it contains a pointer to an AV of
959 (initially) one element, and this element is the scratchpad AV. Why do
960 we need an extra level of indirection?
961
962 The answer is B<recursion>, and maybe (sometime soon) B<threads>. Both
963 these can create several execution pointers going into the same
964 subroutine. For the subroutine-child not write over the temporaries
965 for the subroutine-parent (lifespan of which covers the call to the
966 child), the parent and the child should have different
967 scratchpads. (I<And> the lexicals should be separate anyway!)
968
969 So each subroutine is born with an array of scratchpads (of length 1).
970 On each entry to the subroutine it is checked that the current
971 depth of the recursion is not more than the length of this array, and
972 if it is, new scratchpad is created and pushed into the array.
973
974 The I<target>s on this scratchpad are C<undef>s, but they are already
975 marked with correct flags.
976
977 =head2 API LISTING
978
979 This is a listing of functions, macros, flags, and variables that may be
980 useful to extension writers or that may be found while reading other
981 extensions.
982
983 =over 8
984
985 =item AvFILL
986
987 See C<av_len>.
988
989 =item av_clear
990
991 Clears an array, making it empty.
992
993         void    av_clear _((AV* ar));
994
995 =item av_extend
996
997 Pre-extend an array.  The C<key> is the index to which the array should be
998 extended.
999
1000         void    av_extend _((AV* ar, I32 key));
1001
1002 =item av_fetch
1003
1004 Returns the SV at the specified index in the array.  The C<key> is the
1005 index.  If C<lval> is set then the fetch will be part of a store.  Check
1006 that the return value is non-null before dereferencing it to a C<SV*>.
1007
1008         SV**    av_fetch _((AV* ar, I32 key, I32 lval));
1009
1010 =item av_len
1011
1012 Returns the highest index in the array.  Returns -1 if the array is empty.
1013
1014         I32     av_len _((AV* ar));
1015
1016 =item av_make
1017
1018 Creates a new AV and populates it with a list of SVs.  The SVs are copied
1019 into the array, so they may be freed after the call to av_make.  The new AV
1020 will have a reference count of 1.
1021
1022         AV*     av_make _((I32 size, SV** svp));
1023
1024 =item av_pop
1025
1026 Pops an SV off the end of the array.  Returns C<&sv_undef> if the array is
1027 empty.
1028
1029         SV*     av_pop _((AV* ar));
1030
1031 =item av_push
1032
1033 Pushes an SV onto the end of the array.  The array will grow automatically
1034 to accommodate the addition.
1035
1036         void    av_push _((AV* ar, SV* val));
1037
1038 =item av_shift
1039
1040 Shifts an SV off the beginning of the array.
1041
1042         SV*     av_shift _((AV* ar));
1043
1044 =item av_store
1045
1046 Stores an SV in an array.  The array index is specified as C<key>.  The
1047 return value will be null if the operation failed, otherwise it can be
1048 dereferenced to get the original C<SV*>.
1049
1050         SV**    av_store _((AV* ar, I32 key, SV* val));
1051
1052 =item av_undef
1053
1054 Undefines the array.
1055
1056         void    av_undef _((AV* ar));
1057
1058 =item av_unshift
1059
1060 Unshift an SV onto the beginning of the array.  The array will grow
1061 automatically to accommodate the addition.
1062
1063         void    av_unshift _((AV* ar, I32 num));
1064
1065 =item CLASS
1066
1067 Variable which is setup by C<xsubpp> to indicate the class name for a C++ XS
1068 constructor.  This is always a C<char*>.  See C<THIS> and
1069 L<perlxs/"Using XS With C++">.
1070
1071 =item Copy
1072
1073 The XSUB-writer's interface to the C C<memcpy> function.  The C<s> is the
1074 source, C<d> is the destination, C<n> is the number of items, and C<t> is
1075 the type.
1076
1077         (void) Copy( s, d, n, t );
1078
1079 =item croak
1080
1081 This is the XSUB-writer's interface to Perl's C<die> function.  Use this
1082 function the same way you use the C C<printf> function.  See C<warn>.
1083
1084 =item CvSTASH
1085
1086 Returns the stash of the CV.
1087
1088         HV * CvSTASH( SV* sv )
1089
1090 =item DBsingle
1091
1092 When Perl is run in debugging mode, with the B<-d> switch, this SV is a
1093 boolean which indicates whether subs are being single-stepped.
1094 Single-stepping is automatically turned on after every step.  This is the C
1095 variable which corresponds to Perl's $DB::single variable.  See C<DBsub>.
1096
1097 =item DBsub
1098
1099 When Perl is run in debugging mode, with the B<-d> switch, this GV contains
1100 the SV which holds the name of the sub being debugged.  This is the C
1101 variable which corresponds to Perl's $DB::sub variable.  See C<DBsingle>.
1102 The sub name can be found by
1103
1104         SvPV( GvSV( DBsub ), na )
1105
1106 =item DBtrace
1107
1108 Trace variable used when Perl is run in debugging mode, with the B<-d>
1109 switch.  This is the C variable which corresponds to Perl's $DB::trace
1110 variable.  See C<DBsingle>.
1111
1112 =item dMARK
1113
1114 Declare a stack marker variable, C<mark>, for the XSUB.  See C<MARK> and
1115 C<dORIGMARK>.
1116
1117 =item dORIGMARK
1118
1119 Saves the original stack mark for the XSUB.  See C<ORIGMARK>.
1120
1121 =item dowarn
1122
1123 The C variable which corresponds to Perl's $^W warning variable.
1124
1125 =item dSP
1126
1127 Declares a stack pointer variable, C<sp>, for the XSUB.  See C<SP>.
1128
1129 =item dXSARGS
1130
1131 Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.  This is
1132 usually handled automatically by C<xsubpp>.  Declares the C<items> variable
1133 to indicate the number of items on the stack.
1134
1135 =item dXSI32
1136
1137 Sets up the C<ix> variable for an XSUB which has aliases.  This is usually
1138 handled automatically by C<xsubpp>.
1139
1140 =item dXSI32
1141
1142 Sets up the C<ix> variable for an XSUB which has aliases.  This is usually
1143 handled automatically by C<xsubpp>.
1144
1145 =item ENTER
1146
1147 Opening bracket on a callback.  See C<LEAVE> and L<perlcall>.
1148
1149         ENTER;
1150
1151 =item EXTEND
1152
1153 Used to extend the argument stack for an XSUB's return values.
1154
1155         EXTEND( sp, int x );
1156
1157 =item FREETMPS
1158
1159 Closing bracket for temporaries on a callback.  See C<SAVETMPS> and
1160 L<perlcall>.
1161
1162         FREETMPS;
1163
1164 =item G_ARRAY
1165
1166 Used to indicate array context.  See C<GIMME> and L<perlcall>.
1167
1168 =item G_DISCARD
1169
1170 Indicates that arguments returned from a callback should be discarded.  See
1171 L<perlcall>.
1172
1173 =item G_EVAL
1174
1175 Used to force a Perl C<eval> wrapper around a callback.  See L<perlcall>.
1176
1177 =item GIMME
1178
1179 The XSUB-writer's equivalent to Perl's C<wantarray>.  Returns C<G_SCALAR> or
1180 C<G_ARRAY> for scalar or array context.
1181
1182 =item G_NOARGS
1183
1184 Indicates that no arguments are being sent to a callback.  See L<perlcall>.
1185
1186 =item G_SCALAR
1187
1188 Used to indicate scalar context.  See C<GIMME> and L<perlcall>.
1189
1190 =item gv_fetchmeth
1191
1192 Returns the glob with the given C<name> and a defined subroutine or
1193 C<NULL>. The glob lives in the given C<stash>, or in the stashes accessable
1194 via @ISA and @<UNIVERSAL>.
1195
1196 As a side-effect creates a glob with the given C<name> in the given C<stash>
1197 which in the case of success contains an alias for the subroutine, and
1198 sets up caching info for this glob.  Similarly for all the searched
1199 stashes.
1200
1201         GV*     gv_fetchmeth _((HV* stash, char* name, STRLEN len, I32 level));
1202
1203 =item gv_fetchmethod
1204
1205 Returns the glob which contains the subroutine to call to invoke the
1206 method on the C<stash>. In fact in the presense of autoloading this may
1207 be the glob for "AUTOLOAD".  In this case the corresponing variable
1208 $AUTOLOAD is already setup.
1209
1210 Note that if you want to keep this glob for a long time, you need to
1211 check for it being "AUTOLOAD", since at the later time the the call
1212 may load a different subroutine due to $AUTOLOAD changing its value.
1213 Use the glob created via a side effect to do this.
1214
1215 This function grants C<"SUPER"> token as prefix of name or postfix of
1216 the stash name.
1217
1218 Has the same side-effects and as C<gv_fetchmeth()>.  C<name> should be
1219 writable if contains C<':'> or C<'\''>.
1220
1221         GV*     gv_fetchmethod _((HV* stash, char* name));
1222
1223 =item gv_stashpv
1224
1225 Returns a pointer to the stash for a specified package.  If C<create> is set
1226 then the package will be created if it does not already exist.  If C<create>
1227 is not set and the package does not exist then NULL is returned.
1228
1229         HV*     gv_stashpv _((char* name, I32 create));
1230
1231 =item gv_stashsv
1232
1233 Returns a pointer to the stash for a specified package.  See C<gv_stashpv>.
1234
1235         HV*     gv_stashsv _((SV* sv, I32 create));
1236
1237 =item GvSV
1238
1239 Return the SV from the GV.
1240
1241 =item he_free
1242
1243 Releases a hash entry from an iterator.  See C<hv_iternext>.
1244
1245 =item hv_clear
1246
1247 Clears a hash, making it empty.
1248
1249         void    hv_clear _((HV* tb));
1250
1251 =item hv_delete
1252
1253 Deletes a key/value pair in the hash.  The value SV is removed from the hash
1254 and returned to the caller.  The C<klen> is the length of the key.  The
1255 C<flags> value will normally be zero; if set to G_DISCARD then null will be
1256 returned.
1257
1258         SV*     hv_delete _((HV* tb, char* key, U32 klen, I32 flags));
1259
1260 =item hv_exists
1261
1262 Returns a boolean indicating whether the specified hash key exists.  The
1263 C<klen> is the length of the key.
1264
1265         bool    hv_exists _((HV* tb, char* key, U32 klen));
1266
1267 =item hv_fetch
1268
1269 Returns the SV which corresponds to the specified key in the hash.  The
1270 C<klen> is the length of the key.  If C<lval> is set then the fetch will be
1271 part of a store.  Check that the return value is non-null before
1272 dereferencing it to a C<SV*>.
1273
1274         SV**    hv_fetch _((HV* tb, char* key, U32 klen, I32 lval));
1275
1276 =item hv_iterinit
1277
1278 Prepares a starting point to traverse a hash table.
1279
1280         I32     hv_iterinit _((HV* tb));
1281
1282 =item hv_iterkey
1283
1284 Returns the key from the current position of the hash iterator.  See
1285 C<hv_iterinit>.
1286
1287         char*   hv_iterkey _((HE* entry, I32* retlen));
1288
1289 =item hv_iternext
1290
1291 Returns entries from a hash iterator.  See C<hv_iterinit>.
1292
1293         HE*     hv_iternext _((HV* tb));
1294
1295 =item hv_iternextsv
1296
1297 Performs an C<hv_iternext>, C<hv_iterkey>, and C<hv_iterval> in one
1298 operation.
1299
1300         SV *    hv_iternextsv _((HV* hv, char** key, I32* retlen));
1301
1302 =item hv_iterval
1303
1304 Returns the value from the current position of the hash iterator.  See
1305 C<hv_iterkey>.
1306
1307         SV*     hv_iterval _((HV* tb, HE* entry));
1308
1309 =item hv_magic
1310
1311 Adds magic to a hash.  See C<sv_magic>.
1312
1313         void    hv_magic _((HV* hv, GV* gv, int how));
1314
1315 =item HvNAME
1316
1317 Returns the package name of a stash.  See C<SvSTASH>, C<CvSTASH>.
1318
1319         char *HvNAME (HV* stash)
1320
1321 =item hv_store
1322
1323 Stores an SV in a hash.  The hash key is specified as C<key> and C<klen> is
1324 the length of the key.  The C<hash> parameter is the pre-computed hash
1325 value; if it is zero then Perl will compute it.  The return value will be
1326 null if the operation failed, otherwise it can be dereferenced to get the
1327 original C<SV*>.
1328
1329         SV**    hv_store _((HV* tb, char* key, U32 klen, SV* val, U32 hash));
1330
1331 =item hv_undef
1332
1333 Undefines the hash.
1334
1335         void    hv_undef _((HV* tb));
1336
1337 =item isALNUM
1338
1339 Returns a boolean indicating whether the C C<char> is an ascii alphanumeric
1340 character or digit.
1341
1342         int isALNUM (char c)
1343
1344 =item isALPHA
1345
1346 Returns a boolean indicating whether the C C<char> is an ascii alphabetic
1347 character.
1348
1349         int isALPHA (char c)
1350
1351 =item isDIGIT
1352
1353 Returns a boolean indicating whether the C C<char> is an ascii digit.
1354
1355         int isDIGIT (char c)
1356
1357 =item isLOWER
1358
1359 Returns a boolean indicating whether the C C<char> is a lowercase character.
1360
1361         int isLOWER (char c)
1362
1363 =item isSPACE
1364
1365 Returns a boolean indicating whether the C C<char> is whitespace.
1366
1367         int isSPACE (char c)
1368
1369 =item isUPPER
1370
1371 Returns a boolean indicating whether the C C<char> is an uppercase character.
1372
1373         int isUPPER (char c)
1374
1375 =item items
1376
1377 Variable which is setup by C<xsubpp> to indicate the number of items on the
1378 stack.  See L<perlxs/"Variable-length Parameter Lists">.
1379
1380 =item ix
1381
1382 Variable which is setup by C<xsubpp> to indicate which of an XSUB's aliases
1383 was used to invoke it.  See L<perlxs/"The ALIAS: Keyword">.
1384
1385 =item LEAVE
1386
1387 Closing bracket on a callback.  See C<ENTER> and L<perlcall>.
1388
1389         LEAVE;
1390
1391 =item MARK
1392
1393 Stack marker variable for the XSUB.  See C<dMARK>.
1394
1395 =item mg_clear
1396
1397 Clear something magical that the SV represents.  See C<sv_magic>.
1398
1399         int     mg_clear _((SV* sv));
1400
1401 =item mg_copy
1402
1403 Copies the magic from one SV to another.  See C<sv_magic>.
1404
1405         int     mg_copy _((SV *, SV *, char *, STRLEN));
1406
1407 =item mg_find
1408
1409 Finds the magic pointer for type matching the SV.  See C<sv_magic>.
1410
1411         MAGIC*  mg_find _((SV* sv, int type));
1412
1413 =item mg_free
1414
1415 Free any magic storage used by the SV.  See C<sv_magic>.
1416
1417         int     mg_free _((SV* sv));
1418
1419 =item mg_get
1420
1421 Do magic after a value is retrieved from the SV.  See C<sv_magic>.
1422
1423         int     mg_get _((SV* sv));
1424
1425 =item mg_len
1426
1427 Report on the SV's length.  See C<sv_magic>.
1428
1429         U32     mg_len _((SV* sv));
1430
1431 =item mg_magical
1432
1433 Turns on the magical status of an SV.  See C<sv_magic>.
1434
1435         void    mg_magical _((SV* sv));
1436
1437 =item mg_set
1438
1439 Do magic after a value is assigned to the SV.  See C<sv_magic>.
1440
1441         int     mg_set _((SV* sv));
1442
1443 =item Move
1444
1445 The XSUB-writer's interface to the C C<memmove> function.  The C<s> is the
1446 source, C<d> is the destination, C<n> is the number of items, and C<t> is
1447 the type.
1448
1449         (void) Move( s, d, n, t );
1450
1451 =item na
1452
1453 A variable which may be used with C<SvPV> to tell Perl to calculate the
1454 string length.
1455
1456 =item New
1457
1458 The XSUB-writer's interface to the C C<malloc> function.
1459
1460         void * New( x, void *ptr, int size, type )
1461
1462 =item Newc
1463
1464 The XSUB-writer's interface to the C C<malloc> function, with cast.
1465
1466         void * Newc( x, void *ptr, int size, type, cast )
1467
1468 =item Newz
1469
1470 The XSUB-writer's interface to the C C<malloc> function.  The allocated
1471 memory is zeroed with C<memzero>.
1472
1473         void * Newz( x, void *ptr, int size, type )
1474
1475 =item newAV
1476
1477 Creates a new AV.  The reference count is set to 1.
1478
1479         AV*     newAV _((void));
1480
1481 =item newHV
1482
1483 Creates a new HV.  The reference count is set to 1.
1484
1485         HV*     newHV _((void));
1486
1487 =item newRV_inc
1488
1489 Creates an RV wrapper for an SV.  The reference count for the original SV is
1490 incremented.
1491
1492         SV*     newRV_inc _((SV* ref));
1493
1494 For historical reasons, "newRV" is a synonym for "newRV_inc".
1495
1496 =item newRV_noinc
1497
1498 Creates an RV wrapper for an SV.  The reference count for the original
1499 SV is B<not> incremented.
1500
1501         SV*     newRV_noinc _((SV* ref));
1502
1503 =item newSV
1504
1505 Creates a new SV.  The C<len> parameter indicates the number of bytes of
1506 pre-allocated string space the SV should have.  The reference count for the
1507 new SV is set to 1.
1508
1509         SV*     newSV _((STRLEN len));
1510
1511 =item newSViv
1512
1513 Creates a new SV and copies an integer into it.  The reference count for the
1514 SV is set to 1.
1515
1516         SV*     newSViv _((IV i));
1517
1518 =item newSVnv
1519
1520 Creates a new SV and copies a double into it.  The reference count for the
1521 SV is set to 1.
1522
1523         SV*     newSVnv _((NV i));
1524
1525 =item newSVpv
1526
1527 Creates a new SV and copies a string into it.  The reference count for the
1528 SV is set to 1.  If C<len> is zero then Perl will compute the length.
1529
1530         SV*     newSVpv _((char* s, STRLEN len));
1531
1532 =item newSVrv
1533
1534 Creates a new SV for the RV, C<rv>, to point to.  If C<rv> is not an RV then
1535 it will be upgraded to one.  If C<classname> is non-null then the new SV will
1536 be blessed in the specified package.  The new SV is returned and its
1537 reference count is 1.
1538         SV*     newSVrv _((SV* rv, char* classname));
1539
1540 =item newSVsv
1541
1542 Creates a new SV which is an exact duplicate of the original SV.
1543
1544         SV*     newSVsv _((SV* old));
1545
1546 =item newXS
1547
1548 Used by C<xsubpp> to hook up XSUBs as Perl subs.
1549
1550 =item newXSproto
1551
1552 Used by C<xsubpp> to hook up XSUBs as Perl subs.  Adds Perl prototypes to
1553 the subs.
1554
1555 =item Nullav
1556
1557 Null AV pointer.
1558
1559 =item Nullch
1560
1561 Null character pointer.
1562
1563 =item Nullcv
1564
1565 Null CV pointer.
1566
1567 =item Nullhv
1568
1569 Null HV pointer.
1570
1571 =item Nullsv
1572
1573 Null SV pointer.
1574
1575 =item ORIGMARK
1576
1577 The original stack mark for the XSUB.  See C<dORIGMARK>.
1578
1579 =item perl_alloc
1580
1581 Allocates a new Perl interpreter.  See L<perlembed>.
1582
1583 =item perl_call_argv
1584
1585 Performs a callback to the specified Perl sub.  See L<perlcall>.
1586
1587         I32     perl_call_argv _((char* subname, I32 flags, char** argv));
1588
1589 =item perl_call_method
1590
1591 Performs a callback to the specified Perl method.  The blessed object must
1592 be on the stack.  See L<perlcall>.
1593
1594         I32     perl_call_method _((char* methname, I32 flags));
1595
1596 =item perl_call_pv
1597
1598 Performs a callback to the specified Perl sub.  See L<perlcall>.
1599
1600         I32     perl_call_pv _((char* subname, I32 flags));
1601
1602 =item perl_call_sv
1603
1604 Performs a callback to the Perl sub whose name is in the SV.  See
1605 L<perlcall>.
1606
1607         I32     perl_call_sv _((SV* sv, I32 flags));
1608
1609 =item perl_construct
1610
1611 Initializes a new Perl interpreter.  See L<perlembed>.
1612
1613 =item perl_destruct
1614
1615 Shuts down a Perl interpreter.  See L<perlembed>.
1616
1617 =item perl_eval_sv
1618
1619 Tells Perl to C<eval> the string in the SV.
1620
1621         I32     perl_eval_sv _((SV* sv, I32 flags));
1622
1623 =item perl_free
1624
1625 Releases a Perl interpreter.  See L<perlembed>.
1626
1627 =item perl_get_av
1628
1629 Returns the AV of the specified Perl array.  If C<create> is set and the
1630 Perl variable does not exist then it will be created.  If C<create> is not
1631 set and the variable does not exist then null is returned.
1632
1633         AV*     perl_get_av _((char* name, I32 create));
1634
1635 =item perl_get_cv
1636
1637 Returns the CV of the specified Perl sub.  If C<create> is set and the Perl
1638 variable does not exist then it will be created.  If C<create> is not
1639 set and the variable does not exist then null is returned.
1640
1641         CV*     perl_get_cv _((char* name, I32 create));
1642
1643 =item perl_get_hv
1644
1645 Returns the HV of the specified Perl hash.  If C<create> is set and the Perl
1646 variable does not exist then it will be created.  If C<create> is not
1647 set and the variable does not exist then null is returned.
1648
1649         HV*     perl_get_hv _((char* name, I32 create));
1650
1651 =item perl_get_sv
1652
1653 Returns the SV of the specified Perl scalar.  If C<create> is set and the
1654 Perl variable does not exist then it will be created.  If C<create> is not
1655 set and the variable does not exist then null is returned.
1656
1657         SV*     perl_get_sv _((char* name, I32 create));
1658
1659 =item perl_parse
1660
1661 Tells a Perl interpreter to parse a Perl script.  See L<perlembed>.
1662
1663 =item perl_require_pv
1664
1665 Tells Perl to C<require> a module.
1666
1667         void    perl_require_pv _((char* pv));
1668
1669 =item perl_run
1670
1671 Tells a Perl interpreter to run.  See L<perlembed>.
1672
1673 =item POPi
1674
1675 Pops an integer off the stack.
1676
1677         int POPi();
1678
1679 =item POPl
1680
1681 Pops a long off the stack.
1682
1683         long POPl();
1684
1685 =item POPp
1686
1687 Pops a string off the stack.
1688
1689         char * POPp();
1690
1691 =item POPn
1692
1693 Pops a double off the stack.
1694
1695         double POPn();
1696
1697 =item POPs
1698
1699 Pops an SV off the stack.
1700
1701         SV* POPs();
1702
1703 =item PUSHMARK
1704
1705 Opening bracket for arguments on a callback.  See C<PUTBACK> and L<perlcall>.
1706
1707         PUSHMARK(p)
1708
1709 =item PUSHi
1710
1711 Push an integer onto the stack.  The stack must have room for this element.
1712 See C<XPUSHi>.
1713
1714         PUSHi(int d)
1715
1716 =item PUSHn
1717
1718 Push a double onto the stack.  The stack must have room for this element.
1719 See C<XPUSHn>.
1720
1721         PUSHn(double d)
1722
1723 =item PUSHp
1724
1725 Push a string onto the stack.  The stack must have room for this element.
1726 The C<len> indicates the length of the string.  See C<XPUSHp>.
1727
1728         PUSHp(char *c, int len )
1729
1730 =item PUSHs
1731
1732 Push an SV onto the stack.  The stack must have room for this element.  See
1733 C<XPUSHs>.
1734
1735         PUSHs(sv)
1736
1737 =item PUTBACK
1738
1739 Closing bracket for XSUB arguments.  This is usually handled by C<xsubpp>.
1740 See C<PUSHMARK> and L<perlcall> for other uses.
1741
1742         PUTBACK;
1743
1744 =item Renew
1745
1746 The XSUB-writer's interface to the C C<realloc> function.
1747
1748         void * Renew( void *ptr, int size, type )
1749
1750 =item Renewc
1751
1752 The XSUB-writer's interface to the C C<realloc> function, with cast.
1753
1754         void * Renewc( void *ptr, int size, type, cast )
1755
1756 =item RETVAL
1757
1758 Variable which is setup by C<xsubpp> to hold the return value for an XSUB.
1759 This is always the proper type for the XSUB.
1760 See L<perlxs/"The RETVAL Variable">.
1761
1762 =item safefree
1763
1764 The XSUB-writer's interface to the C C<free> function.
1765
1766 =item safemalloc
1767
1768 The XSUB-writer's interface to the C C<malloc> function.
1769
1770 =item saferealloc
1771
1772 The XSUB-writer's interface to the C C<realloc> function.
1773
1774 =item savepv
1775
1776 Copy a string to a safe spot.  This does not use an SV.
1777
1778         char*   savepv _((char* sv));
1779
1780 =item savepvn
1781
1782 Copy a string to a safe spot.  The C<len> indicates number of bytes to
1783 copy.  This does not use an SV.
1784
1785         char*   savepvn _((char* sv, I32 len));
1786
1787 =item SAVETMPS
1788
1789 Opening bracket for temporaries on a callback.  See C<FREETMPS> and
1790 L<perlcall>.
1791
1792         SAVETMPS;
1793
1794 =item SP
1795
1796 Stack pointer.  This is usually handled by C<xsubpp>.  See C<dSP> and
1797 C<SPAGAIN>.
1798
1799 =item SPAGAIN
1800
1801 Re-fetch the stack pointer.  Used after a callback.  See L<perlcall>.
1802
1803         SPAGAIN;
1804
1805 =item ST
1806
1807 Used to access elements on the XSUB's stack.
1808
1809         SV* ST(int x)
1810
1811 =item strEQ
1812
1813 Test two strings to see if they are equal.  Returns true or false.
1814
1815         int strEQ( char *s1, char *s2 )
1816
1817 =item strGE
1818
1819 Test two strings to see if the first, C<s1>, is greater than or equal to the
1820 second, C<s2>.  Returns true or false.
1821
1822         int strGE( char *s1, char *s2 )
1823
1824 =item strGT
1825
1826 Test two strings to see if the first, C<s1>, is greater than the second,
1827 C<s2>.  Returns true or false.
1828
1829         int strGT( char *s1, char *s2 )
1830
1831 =item strLE
1832
1833 Test two strings to see if the first, C<s1>, is less than or equal to the
1834 second, C<s2>.  Returns true or false.
1835
1836         int strLE( char *s1, char *s2 )
1837
1838 =item strLT
1839
1840 Test two strings to see if the first, C<s1>, is less than the second,
1841 C<s2>.  Returns true or false.
1842
1843         int strLT( char *s1, char *s2 )
1844
1845 =item strNE
1846
1847 Test two strings to see if they are different.  Returns true or false.
1848
1849         int strNE( char *s1, char *s2 )
1850
1851 =item strnEQ
1852
1853 Test two strings to see if they are equal.  The C<len> parameter indicates
1854 the number of bytes to compare.  Returns true or false.
1855
1856         int strnEQ( char *s1, char *s2 )
1857
1858 =item strnNE
1859
1860 Test two strings to see if they are different.  The C<len> parameter
1861 indicates the number of bytes to compare.  Returns true or false.
1862
1863         int strnNE( char *s1, char *s2, int len )
1864
1865 =item sv_2mortal
1866
1867 Marks an SV as mortal.  The SV will be destroyed when the current context
1868 ends.
1869
1870         SV*     sv_2mortal _((SV* sv));
1871
1872 =item sv_bless
1873
1874 Blesses an SV into a specified package.  The SV must be an RV.  The package
1875 must be designated by its stash (see C<gv_stashpv()>).  The reference count
1876 of the SV is unaffected.
1877
1878         SV*     sv_bless _((SV* sv, HV* stash));
1879
1880 =item sv_catpv
1881
1882 Concatenates the string onto the end of the string which is in the SV.
1883
1884         void    sv_catpv _((SV* sv, char* ptr));
1885
1886 =item sv_catpvn
1887
1888 Concatenates the string onto the end of the string which is in the SV.  The
1889 C<len> indicates number of bytes to copy.
1890
1891         void    sv_catpvn _((SV* sv, char* ptr, STRLEN len));
1892
1893 =item sv_catsv
1894
1895 Concatenates the string from SV C<ssv> onto the end of the string in SV
1896 C<dsv>.
1897
1898         void    sv_catsv _((SV* dsv, SV* ssv));
1899
1900 =item sv_cmp
1901
1902 Compares the strings in two SVs.  Returns -1, 0, or 1 indicating whether the
1903 string in C<sv1> is less than, equal to, or greater than the string in
1904 C<sv2>.
1905
1906         I32     sv_cmp _((SV* sv1, SV* sv2));
1907
1908 =item sv_cmp
1909
1910 Compares the strings in two SVs.  Returns -1, 0, or 1 indicating whether the
1911 string in C<sv1> is less than, equal to, or greater than the string in
1912 C<sv2>.
1913
1914         I32     sv_cmp _((SV* sv1, SV* sv2));
1915
1916 =item SvCUR
1917
1918 Returns the length of the string which is in the SV.  See C<SvLEN>.
1919
1920         int SvCUR (SV* sv)
1921
1922 =item SvCUR_set
1923
1924 Set the length of the string which is in the SV.  See C<SvCUR>.
1925
1926         SvCUR_set (SV* sv, int val )
1927
1928 =item sv_dec
1929
1930 Auto-decrement of the value in the SV.
1931
1932         void    sv_dec _((SV* sv));
1933
1934 =item sv_dec
1935
1936 Auto-decrement of the value in the SV.
1937
1938         void    sv_dec _((SV* sv));
1939
1940 =item SvEND
1941
1942 Returns a pointer to the last character in the string which is in the SV.
1943 See C<SvCUR>.  Access the character as
1944
1945         *SvEND(sv)
1946
1947 =item sv_eq
1948
1949 Returns a boolean indicating whether the strings in the two SVs are
1950 identical.
1951
1952         I32     sv_eq _((SV* sv1, SV* sv2));
1953
1954 =item SvGROW
1955
1956 Expands the character buffer in the SV.  Calls C<sv_grow> to perform the
1957 expansion if necessary.  Returns a pointer to the character buffer.
1958
1959         char * SvGROW( SV* sv, int len )
1960
1961 =item sv_grow
1962
1963 Expands the character buffer in the SV.  This will use C<sv_unref> and will
1964 upgrade the SV to C<SVt_PV>.  Returns a pointer to the character buffer.
1965 Use C<SvGROW>.
1966
1967 =item sv_inc
1968
1969 Auto-increment of the value in the SV.
1970
1971         void    sv_inc _((SV* sv));
1972
1973 =item SvIOK
1974
1975 Returns a boolean indicating whether the SV contains an integer.
1976
1977         int SvIOK (SV* SV)
1978
1979 =item SvIOK_off
1980
1981 Unsets the IV status of an SV.
1982
1983         SvIOK_off (SV* sv)
1984
1985 =item SvIOK_on
1986
1987 Tells an SV that it is an integer.
1988
1989         SvIOK_on (SV* sv)
1990
1991 =item SvIOK_only
1992
1993 Tells an SV that it is an integer and disables all other OK bits.
1994
1995         SvIOK_on (SV* sv)
1996
1997 =item SvIOK_only
1998
1999 Tells an SV that it is an integer and disables all other OK bits.
2000
2001         SvIOK_on (SV* sv)
2002
2003 =item SvIOKp
2004
2005 Returns a boolean indicating whether the SV contains an integer.  Checks the
2006 B<private> setting.  Use C<SvIOK>.
2007
2008         int SvIOKp (SV* SV)
2009
2010 =item sv_isa
2011
2012 Returns a boolean indicating whether the SV is blessed into the specified
2013 class.  This does not know how to check for subtype, so it doesn't work in
2014 an inheritance relationship.
2015
2016         int     sv_isa _((SV* sv, char* name));
2017
2018 =item SvIV
2019
2020 Returns the integer which is in the SV.
2021
2022         int SvIV (SV* sv)
2023
2024 =item sv_isobject
2025
2026 Returns a boolean indicating whether the SV is an RV pointing to a blessed
2027 object.  If the SV is not an RV, or if the object is not blessed, then this
2028 will return false.
2029
2030         int     sv_isobject _((SV* sv));
2031
2032 =item SvIVX
2033
2034 Returns the integer which is stored in the SV.
2035
2036         int  SvIVX (SV* sv);
2037
2038 =item SvLEN
2039
2040 Returns the size of the string buffer in the SV.  See C<SvCUR>.
2041
2042         int SvLEN (SV* sv)
2043
2044 =item sv_len
2045
2046 Returns the length of the string in the SV.  Use C<SvCUR>.
2047
2048         STRLEN  sv_len _((SV* sv));
2049
2050 =item sv_len
2051
2052 Returns the length of the string in the SV.  Use C<SvCUR>.
2053
2054         STRLEN  sv_len _((SV* sv));
2055
2056 =item sv_magic
2057
2058 Adds magic to an SV.
2059
2060         void    sv_magic _((SV* sv, SV* obj, int how, char* name, I32 namlen));
2061
2062 =item sv_mortalcopy
2063
2064 Creates a new SV which is a copy of the original SV.  The new SV is marked
2065 as mortal.
2066
2067         SV*     sv_mortalcopy _((SV* oldsv));
2068
2069 =item SvOK
2070
2071 Returns a boolean indicating whether the value is an SV.
2072
2073         int SvOK (SV* sv)
2074
2075 =item sv_newmortal
2076
2077 Creates a new SV which is mortal.  The reference count of the SV is set to 1.
2078
2079         SV*     sv_newmortal _((void));
2080
2081 =item sv_no
2082
2083 This is the C<false> SV.  See C<sv_yes>.  Always refer to this as C<&sv_no>.
2084
2085 =item SvNIOK
2086
2087 Returns a boolean indicating whether the SV contains a number, integer or
2088 double.
2089
2090         int SvNIOK (SV* SV)
2091
2092 =item SvNIOK_off
2093
2094 Unsets the NV/IV status of an SV.
2095
2096         SvNIOK_off (SV* sv)
2097
2098 =item SvNIOKp
2099
2100 Returns a boolean indicating whether the SV contains a number, integer or
2101 double.  Checks the B<private> setting.  Use C<SvNIOK>.
2102
2103         int SvNIOKp (SV* SV)
2104
2105 =item SvNOK
2106
2107 Returns a boolean indicating whether the SV contains a double.
2108
2109         int SvNOK (SV* SV)
2110
2111 =item SvNOK_off
2112
2113 Unsets the NV status of an SV.
2114
2115         SvNOK_off (SV* sv)
2116
2117 =item SvNOK_on
2118
2119 Tells an SV that it is a double.
2120
2121         SvNOK_on (SV* sv)
2122
2123 =item SvNOK_only
2124
2125 Tells an SV that it is a double and disables all other OK bits.
2126
2127         SvNOK_on (SV* sv)
2128
2129 =item SvNOK_only
2130
2131 Tells an SV that it is a double and disables all other OK bits.
2132
2133         SvNOK_on (SV* sv)
2134
2135 =item SvNOKp
2136
2137 Returns a boolean indicating whether the SV contains a double.  Checks the
2138 B<private> setting.  Use C<SvNOK>.
2139
2140         int SvNOKp (SV* SV)
2141
2142 =item SvNV
2143
2144 Returns the double which is stored in the SV.
2145
2146         double SvNV (SV* sv);
2147
2148 =item SvNVX
2149
2150 Returns the double which is stored in the SV.
2151
2152         double SvNVX (SV* sv);
2153
2154 =item SvPOK
2155
2156 Returns a boolean indicating whether the SV contains a character string.
2157
2158         int SvPOK (SV* SV)
2159
2160 =item SvPOK_off
2161
2162 Unsets the PV status of an SV.
2163
2164         SvPOK_off (SV* sv)
2165
2166 =item SvPOK_on
2167
2168 Tells an SV that it is a string.
2169
2170         SvPOK_on (SV* sv)
2171
2172 =item SvPOK_only
2173
2174 Tells an SV that it is a string and disables all other OK bits.
2175
2176         SvPOK_on (SV* sv)
2177
2178 =item SvPOK_only
2179
2180 Tells an SV that it is a string and disables all other OK bits.
2181
2182         SvPOK_on (SV* sv)
2183
2184 =item SvPOKp
2185
2186 Returns a boolean indicating whether the SV contains a character string.
2187 Checks the B<private> setting.  Use C<SvPOK>.
2188
2189         int SvPOKp (SV* SV)
2190
2191 =item SvPV
2192
2193 Returns a pointer to the string in the SV, or a stringified form of the SV
2194 if the SV does not contain a string.  If C<len> is C<na> then Perl will
2195 handle the length on its own.
2196
2197         char * SvPV (SV* sv, int len )
2198
2199 =item SvPVX
2200
2201 Returns a pointer to the string in the SV.  The SV must contain a string.
2202
2203         char * SvPVX (SV* sv)
2204
2205 =item SvREFCNT
2206
2207 Returns the value of the object's reference count.
2208
2209         int SvREFCNT (SV* sv);
2210
2211 =item SvREFCNT_dec
2212
2213 Decrements the reference count of the given SV.
2214
2215         void SvREFCNT_dec (SV* sv)
2216
2217 =item SvREFCNT_inc
2218
2219 Increments the reference count of the given SV.
2220
2221         void SvREFCNT_inc (SV* sv)
2222
2223 =item SvROK
2224
2225 Tests if the SV is an RV.
2226
2227         int SvROK (SV* sv)
2228
2229 =item SvROK_off
2230
2231 Unsets the RV status of an SV.
2232
2233         SvROK_off (SV* sv)
2234
2235 =item SvROK_on
2236
2237 Tells an SV that it is an RV.
2238
2239         SvROK_on (SV* sv)
2240
2241 =item SvRV
2242
2243 Dereferences an RV to return the SV.
2244
2245         SV*     SvRV (SV* sv);
2246
2247 =item sv_setiv
2248
2249 Copies an integer into the given SV.
2250
2251         void    sv_setiv _((SV* sv, IV num));
2252
2253 =item sv_setnv
2254
2255 Copies a double into the given SV.
2256
2257         void    sv_setnv _((SV* sv, double num));
2258
2259 =item sv_setpv
2260
2261 Copies a string into an SV.  The string must be null-terminated.
2262
2263         void    sv_setpv _((SV* sv, char* ptr));
2264
2265 =item sv_setpvn
2266
2267 Copies a string into an SV.  The C<len> parameter indicates the number of
2268 bytes to be copied.
2269
2270         void    sv_setpvn _((SV* sv, char* ptr, STRLEN len));
2271
2272 =item sv_setref_iv
2273
2274 Copies an integer into a new SV, optionally blessing the SV.  The C<rv>
2275 argument will be upgraded to an RV.  That RV will be modified to point to
2276 the new SV.  The C<classname> argument indicates the package for the
2277 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
2278 will be returned and will have a reference count of 1.
2279
2280         SV*     sv_setref_iv _((SV *rv, char *classname, IV iv));
2281
2282 =item sv_setref_nv
2283
2284 Copies a double into a new SV, optionally blessing the SV.  The C<rv>
2285 argument will be upgraded to an RV.  That RV will be modified to point to
2286 the new SV.  The C<classname> argument indicates the package for the
2287 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
2288 will be returned and will have a reference count of 1.
2289
2290         SV*     sv_setref_nv _((SV *rv, char *classname, double nv));
2291
2292 =item sv_setref_pv
2293
2294 Copies a pointer into a new SV, optionally blessing the SV.  The C<rv>
2295 argument will be upgraded to an RV.  That RV will be modified to point to
2296 the new SV.  If the C<pv> argument is NULL then C<sv_undef> will be placed
2297 into the SV.  The C<classname> argument indicates the package for the
2298 blessing.  Set C<classname> to C<Nullch> to avoid the blessing.  The new SV
2299 will be returned and will have a reference count of 1.
2300
2301         SV*     sv_setref_pv _((SV *rv, char *classname, void* pv));
2302
2303 Do not use with integral Perl types such as HV, AV, SV, CV, because those
2304 objects will become corrupted by the pointer copy process.
2305
2306 Note that C<sv_setref_pvn> copies the string while this copies the pointer.
2307
2308 =item sv_setref_pvn
2309
2310 Copies a string into a new SV, optionally blessing the SV.  The length of the
2311 string must be specified with C<n>.  The C<rv> argument will be upgraded to
2312 an RV.  That RV will be modified to point to the new SV.  The C<classname>
2313 argument indicates the package for the blessing.  Set C<classname> to
2314 C<Nullch> to avoid the blessing.  The new SV will be returned and will have
2315 a reference count of 1.
2316
2317         SV*     sv_setref_pvn _((SV *rv, char *classname, char* pv, I32 n));
2318
2319 Note that C<sv_setref_pv> copies the pointer while this copies the string.
2320
2321 =item sv_setsv
2322
2323 Copies the contents of the source SV C<ssv> into the destination SV C<dsv>.
2324 The source SV may be destroyed if it is mortal.
2325
2326         void    sv_setsv _((SV* dsv, SV* ssv));
2327
2328 =item SvSTASH
2329
2330 Returns the stash of the SV.
2331
2332         HV * SvSTASH (SV* sv)
2333
2334 =item SVt_IV
2335
2336 Integer type flag for scalars.  See C<svtype>.
2337
2338 =item SVt_PV
2339
2340 Pointer type flag for scalars.  See C<svtype>.
2341
2342 =item SVt_PVAV
2343
2344 Type flag for arrays.  See C<svtype>.
2345
2346 =item SVt_PVCV
2347
2348 Type flag for code refs.  See C<svtype>.
2349
2350 =item SVt_PVHV
2351
2352 Type flag for hashes.  See C<svtype>.
2353
2354 =item SVt_PVMG
2355
2356 Type flag for blessed scalars.  See C<svtype>.
2357
2358 =item SVt_NV
2359
2360 Double type flag for scalars.  See C<svtype>.
2361
2362 =item SvTRUE
2363
2364 Returns a boolean indicating whether Perl would evaluate the SV as true or
2365 false, defined or undefined.
2366
2367         int SvTRUE (SV* sv)
2368
2369 =item SvTYPE
2370
2371 Returns the type of the SV.  See C<svtype>.
2372
2373         svtype  SvTYPE (SV* sv)
2374
2375 =item svtype
2376
2377 An enum of flags for Perl types.  These are found in the file B<sv.h> in the
2378 C<svtype> enum.  Test these flags with the C<SvTYPE> macro.
2379
2380 =item SvUPGRADE
2381
2382 Used to upgrade an SV to a more complex form.  Uses C<sv_upgrade> to perform
2383 the upgrade if necessary.  See C<svtype>.
2384
2385         bool    SvUPGRADE _((SV* sv, svtype mt));
2386
2387 =item sv_upgrade
2388
2389 Upgrade an SV to a more complex form.  Use C<SvUPGRADE>.  See C<svtype>.
2390
2391 =item sv_undef
2392
2393 This is the C<undef> SV.  Always refer to this as C<&sv_undef>.
2394
2395 =item sv_unref
2396
2397 Unsets the RV status of the SV, and decrements the reference count of
2398 whatever was being referenced by the RV.  This can almost be thought of
2399 as a reversal of C<newSVrv>.  See C<SvROK_off>.
2400
2401         void    sv_unref _((SV* sv));
2402
2403 =item sv_usepvn
2404
2405 Tells an SV to use C<ptr> to find its string value.  Normally the string is
2406 stored inside the SV but sv_usepvn allows the SV to use an outside string.
2407 The C<ptr> should point to memory that was allocated by C<malloc>.  The
2408 string length, C<len>, must be supplied.  This function will realloc the
2409 memory pointed to by C<ptr>, so that pointer should not be freed or used by
2410 the programmer after giving it to sv_usepvn.
2411
2412         void    sv_usepvn _((SV* sv, char* ptr, STRLEN len));
2413
2414 =item sv_yes
2415
2416 This is the C<true> SV.  See C<sv_no>.  Always refer to this as C<&sv_yes>.
2417
2418 =item THIS
2419
2420 Variable which is setup by C<xsubpp> to designate the object in a C++ XSUB.
2421 This is always the proper type for the C++ object.  See C<CLASS> and
2422 L<perlxs/"Using XS With C++">.
2423
2424 =item toLOWER
2425
2426 Converts the specified character to lowercase.
2427
2428         int toLOWER (char c)
2429
2430 =item toUPPER
2431
2432 Converts the specified character to uppercase.
2433
2434         int toUPPER (char c)
2435
2436 =item warn
2437
2438 This is the XSUB-writer's interface to Perl's C<warn> function.  Use this
2439 function the same way you use the C C<printf> function.  See C<croak()>.
2440
2441 =item XPUSHi
2442
2443 Push an integer onto the stack, extending the stack if necessary.  See
2444 C<PUSHi>.
2445
2446         XPUSHi(int d)
2447
2448 =item XPUSHn
2449
2450 Push a double onto the stack, extending the stack if necessary.  See
2451 C<PUSHn>.
2452
2453         XPUSHn(double d)
2454
2455 =item XPUSHp
2456
2457 Push a string onto the stack, extending the stack if necessary.  The C<len>
2458 indicates the length of the string.  See C<PUSHp>.
2459
2460         XPUSHp(char *c, int len)
2461
2462 =item XPUSHs
2463
2464 Push an SV onto the stack, extending the stack if necessary.  See C<PUSHs>.
2465
2466         XPUSHs(sv)
2467
2468 =item XS
2469
2470 Macro to declare an XSUB and its C parameter list.  This is handled by
2471 C<xsubpp>.
2472
2473 =item XSRETURN
2474
2475 Return from XSUB, indicating number of items on the stack.  This is usually
2476 handled by C<xsubpp>.
2477
2478         XSRETURN(int x);
2479
2480 =item XSRETURN_EMPTY
2481
2482 Return an empty list from an XSUB immediately.
2483
2484         XSRETURN_EMPTY;
2485
2486 =item XSRETURN_IV
2487
2488 Return an integer from an XSUB immediately.  Uses C<XST_mIV>.
2489
2490         XSRETURN_IV(IV v);
2491
2492 =item XSRETURN_NO
2493
2494 Return C<&sv_no> from an XSUB immediately.  Uses C<XST_mNO>.
2495
2496         XSRETURN_NO;
2497
2498 =item XSRETURN_NV
2499
2500 Return an double from an XSUB immediately.  Uses C<XST_mNV>.
2501
2502         XSRETURN_NV(NV v);
2503
2504 =item XSRETURN_PV
2505
2506 Return a copy of a string from an XSUB immediately.  Uses C<XST_mPV>.
2507
2508         XSRETURN_PV(char *v);
2509
2510 =item XSRETURN_UNDEF
2511
2512 Return C<&sv_undef> from an XSUB immediately.  Uses C<XST_mUNDEF>.
2513
2514         XSRETURN_UNDEF;
2515
2516 =item XSRETURN_YES
2517
2518 Return C<&sv_yes> from an XSUB immediately.  Uses C<XST_mYES>.
2519
2520         XSRETURN_YES;
2521
2522 =item XST_mIV
2523
2524 Place an integer into the specified position C<i> on the stack.  The value is
2525 stored in a new mortal SV.
2526
2527         XST_mIV( int i, IV v );
2528
2529 =item XST_mNV
2530
2531 Place a double into the specified position C<i> on the stack.  The value is
2532 stored in a new mortal SV.
2533
2534         XST_mNV( int i, NV v );
2535
2536 =item XST_mNO
2537
2538 Place C<&sv_no> into the specified position C<i> on the stack.
2539
2540         XST_mNO( int i );
2541
2542 =item XST_mPV
2543
2544 Place a copy of a string into the specified position C<i> on the stack.  The
2545 value is stored in a new mortal SV.
2546
2547         XST_mPV( int i, char *v );
2548
2549 =item XST_mUNDEF
2550
2551 Place C<&sv_undef> into the specified position C<i> on the stack.
2552
2553         XST_mUNDEF( int i );
2554
2555 =item XST_mYES
2556
2557 Place C<&sv_yes> into the specified position C<i> on the stack.
2558
2559         XST_mYES( int i );
2560
2561 =item XS_VERSION
2562
2563 The version identifier for an XS module.  This is usually handled
2564 automatically by C<ExtUtils::MakeMaker>.  See C<XS_VERSION_BOOTCHECK>.
2565
2566 =item XS_VERSION_BOOTCHECK
2567
2568 Macro to verify that a PM module's $VERSION variable matches the XS module's
2569 C<XS_VERSION> variable.  This is usually handled automatically by
2570 C<xsubpp>.  See L<perlxs/"The VERSIONCHECK: Keyword">.
2571
2572 =item Zero
2573
2574 The XSUB-writer's interface to the C C<memzero> function.  The C<d> is the
2575 destination, C<n> is the number of items, and C<t> is the type.
2576
2577         (void) Zero( d, n, t );
2578
2579 =back
2580
2581 =head1 EDITOR
2582
2583 Jeff Okamoto <okamoto@corp.hp.com>
2584
2585 With lots of help and suggestions from Dean Roehrich, Malcolm Beattie,
2586 Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil
2587 Bowers, Matthew Green, Tim Bunce, Spider Boardman, and Ulrich Pfeifer.
2588
2589 API Listing by Dean Roehrich <roehrich@cray.com>.
2590
2591 =head1 DATE
2592
2593 Version 27: 1996/12/24