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