This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
085536e953608af54a41448dcb5fc859d76ada0a
[perl5.git] / dist / ExtUtils-ParseXS / lib / perlxs.pod
1 =head1 NAME
2
3 perlxs - XS language reference manual
4
5 =head1 DESCRIPTION
6
7 =head2 Introduction
8
9 XS is an interface description file format used to create an extension
10 interface between Perl and C code (or a C library) which one wishes
11 to use with Perl.  The XS interface is combined with the library to
12 create a new library which can then be either dynamically loaded
13 or statically linked into perl.  The XS interface description is
14 written in the XS language and is the core component of the Perl
15 extension interface.
16
17 An B<XSUB> forms the basic unit of the XS interface.  After compilation
18 by the B<xsubpp> compiler, each XSUB amounts to a C function definition
19 which will provide the glue between Perl calling conventions and C
20 calling conventions.
21
22 The glue code pulls the arguments from the Perl stack, converts these
23 Perl values to the formats expected by a C function, call this C function,
24 transfers the return values of the C function back to Perl.
25 Return values here may be a conventional C return value or any C
26 function arguments that may serve as output parameters.  These return
27 values may be passed back to Perl either by putting them on the
28 Perl stack, or by modifying the arguments supplied from the Perl side.
29
30 The above is a somewhat simplified view of what really happens.  Since
31 Perl allows more flexible calling conventions than C, XSUBs may do much
32 more in practice, such as checking input parameters for validity,
33 throwing exceptions (or returning undef/empty list) if the return value
34 from the C function indicates failure, calling different C functions
35 based on numbers and types of the arguments, providing an object-oriented
36 interface, etc.
37
38 Of course, one could write such glue code directly in C.  However, this
39 would be a tedious task, especially if one needs to write glue for
40 multiple C functions, and/or one is not familiar enough with the Perl
41 stack discipline and other such arcana.  XS comes to the rescue here:
42 instead of writing this glue C code in long-hand, one can write
43 a more concise short-hand I<description> of what should be done by
44 the glue, and let the XS compiler B<xsubpp> handle the rest.
45
46 The XS language allows one to describe the mapping between how the C
47 routine is used, and how the corresponding Perl routine is used.  It
48 also allows creation of Perl routines which are directly translated to
49 C code and which are not related to a pre-existing C function.  In cases
50 when the C interface coincides with the Perl interface, the XSUB
51 declaration is almost identical to a declaration of a C function (in K&R
52 style).  In such circumstances, there is another tool called C<h2xs>
53 that is able to translate an entire C header file into a corresponding
54 XS file that will provide glue to the functions/macros described in
55 the header file.
56
57 The XS compiler is called B<xsubpp>.  This compiler creates
58 the constructs necessary to let an XSUB manipulate Perl values, and
59 creates the glue necessary to let Perl call the XSUB.  The compiler
60 uses B<typemaps> to determine how to map C function parameters
61 and output values to Perl values and back.  The default typemap
62 (which comes with Perl) handles many common C types.  A supplementary
63 typemap may also be needed to handle any special structures and types
64 for the library being linked.
65
66 A file in XS format starts with a C language section which goes until the
67 first C<MODULE =Z<>> directive.  Other XS directives and XSUB definitions
68 may follow this line.  The "language" used in this part of the file
69 is usually referred to as the XS language.  B<xsubpp> recognizes and
70 skips POD (see L<perlpod>) in both the C and XS language sections, which
71 allows the XS file to contain embedded documentation.
72
73 See L<perlxstut> for a tutorial on the whole extension creation process.
74
75 Note: For some extensions, Dave Beazley's SWIG system may provide a
76 significantly more convenient mechanism for creating the extension
77 glue code.  See L<http://www.swig.org/> for more information.
78
79 =head2 On The Road
80
81 Many of the examples which follow will concentrate on creating an interface
82 between Perl and the ONC+ RPC bind library functions.  The rpcb_gettime()
83 function is used to demonstrate many features of the XS language.  This
84 function has two parameters; the first is an input parameter and the second
85 is an output parameter.  The function also returns a status value.
86
87         bool_t rpcb_gettime(const char *host, time_t *timep);
88
89 From C this function will be called with the following
90 statements.
91
92      #include <rpc/rpc.h>
93      bool_t status;
94      time_t timep;
95      status = rpcb_gettime( "localhost", &timep );
96
97 If an XSUB is created to offer a direct translation between this function
98 and Perl, then this XSUB will be used from Perl with the following code.
99 The $status and $timep variables will contain the output of the function.
100
101      use RPC;
102      $status = rpcb_gettime( "localhost", $timep );
103
104 The following XS file shows an XS subroutine, or XSUB, which
105 demonstrates one possible interface to the rpcb_gettime()
106 function.  This XSUB represents a direct translation between
107 C and Perl and so preserves the interface even from Perl.
108 This XSUB will be invoked from Perl with the usage shown
109 above.  Note that the first three #include statements, for
110 C<EXTERN.h>, C<perl.h>, and C<XSUB.h>, will always be present at the
111 beginning of an XS file.  This approach and others will be
112 expanded later in this document.
113
114      #include "EXTERN.h"
115      #include "perl.h"
116      #include "XSUB.h"
117      #include <rpc/rpc.h>
118
119      MODULE = RPC  PACKAGE = RPC
120
121      bool_t
122      rpcb_gettime(host,timep)
123           char *host
124           time_t &timep
125         OUTPUT:
126           timep
127
128 Any extension to Perl, including those containing XSUBs,
129 should have a Perl module to serve as the bootstrap which
130 pulls the extension into Perl.  This module will export the
131 extension's functions and variables to the Perl program and
132 will cause the extension's XSUBs to be linked into Perl.
133 The following module will be used for most of the examples
134 in this document and should be used from Perl with the C<use>
135 command as shown earlier.  Perl modules are explained in
136 more detail later in this document.
137
138      package RPC;
139
140      require Exporter;
141      require DynaLoader;
142      @ISA = qw(Exporter DynaLoader);
143      @EXPORT = qw( rpcb_gettime );
144
145      bootstrap RPC;
146      1;
147
148 Throughout this document a variety of interfaces to the rpcb_gettime()
149 XSUB will be explored.  The XSUBs will take their parameters in different
150 orders or will take different numbers of parameters.  In each case the
151 XSUB is an abstraction between Perl and the real C rpcb_gettime()
152 function, and the XSUB must always ensure that the real rpcb_gettime()
153 function is called with the correct parameters.  This abstraction will
154 allow the programmer to create a more Perl-like interface to the C
155 function.
156
157 =head2 The Anatomy of an XSUB
158
159 The simplest XSUBs consist of 3 parts: a description of the return
160 value, the name of the XSUB routine and the names of its arguments,
161 and a description of types or formats of the arguments.
162
163 The following XSUB allows a Perl program to access a C library function
164 called sin().  The XSUB will imitate the C function which takes a single
165 argument and returns a single value.
166
167      double
168      sin(x)
169        double x
170
171 Optionally, one can merge the description of types and the list of
172 argument names, rewriting this as
173
174      double
175      sin(double x)
176
177 This makes this XSUB look similar to an ANSI C declaration.  An optional
178 semicolon is allowed after the argument list, as in
179
180      double
181      sin(double x);
182
183 Parameters with C pointer types can have different semantic: C functions
184 with similar declarations
185
186      bool string_looks_as_a_number(char *s);
187      bool make_char_uppercase(char *c);
188
189 are used in absolutely incompatible manner.  Parameters to these functions
190 could be described B<xsubpp> like this:
191
192      char *  s
193      char    &c
194
195 Both these XS declarations correspond to the C<char*> C type, but they have
196 different semantics, see L<"The & Unary Operator">.
197
198 It is convenient to think that the indirection operator
199 C<*> should be considered as a part of the type and the address operator C<&>
200 should be considered part of the variable.  See L<"The Typemap">
201 for more info about handling qualifiers and unary operators in C types.
202
203 The function name and the return type must be placed on
204 separate lines and should be flush left-adjusted.
205
206   INCORRECT                        CORRECT
207
208   double sin(x)                    double
209     double x                       sin(x)
210                                      double x
211
212 The rest of the function description may be indented or left-adjusted. The
213 following example shows a function with its body left-adjusted.  Most
214 examples in this document will indent the body for better readability.
215
216   CORRECT
217
218   double
219   sin(x)
220   double x
221
222 More complicated XSUBs may contain many other sections.  Each section of
223 an XSUB starts with the corresponding keyword, such as INIT: or CLEANUP:.
224 However, the first two lines of an XSUB always contain the same data:
225 descriptions of the return type and the names of the function and its
226 parameters.  Whatever immediately follows these is considered to be
227 an INPUT: section unless explicitly marked with another keyword.
228 (See L<The INPUT: Keyword>.)
229
230 An XSUB section continues until another section-start keyword is found.
231
232 =head2 The Argument Stack
233
234 The Perl argument stack is used to store the values which are
235 sent as parameters to the XSUB and to store the XSUB's
236 return value(s).  In reality all Perl functions (including non-XSUB
237 ones) keep their values on this stack all the same time, each limited
238 to its own range of positions on the stack.  In this document the
239 first position on that stack which belongs to the active
240 function will be referred to as position 0 for that function.
241
242 XSUBs refer to their stack arguments with the macro B<ST(x)>, where I<x>
243 refers to a position in this XSUB's part of the stack.  Position 0 for that
244 function would be known to the XSUB as ST(0).  The XSUB's incoming
245 parameters and outgoing return values always begin at ST(0).  For many
246 simple cases the B<xsubpp> compiler will generate the code necessary to
247 handle the argument stack by embedding code fragments found in the
248 typemaps.  In more complex cases the programmer must supply the code.
249
250 =head2 The RETVAL Variable
251
252 The RETVAL variable is a special C variable that is declared automatically
253 for you.  The C type of RETVAL matches the return type of the C library
254 function.  The B<xsubpp> compiler will declare this variable in each XSUB
255 with non-C<void> return type.  By default the generated C function
256 will use RETVAL to hold the return value of the C library function being
257 called.  In simple cases the value of RETVAL will be placed in ST(0) of
258 the argument stack where it can be received by Perl as the return value
259 of the XSUB.
260
261 If the XSUB has a return type of C<void> then the compiler will
262 not declare a RETVAL variable for that function.  When using
263 a PPCODE: section no manipulation of the RETVAL variable is required, the
264 section may use direct stack manipulation to place output values on the stack.
265
266 If PPCODE: directive is not used, C<void> return value should be used
267 only for subroutines which do not return a value, I<even if> CODE:
268 directive is used which sets ST(0) explicitly.
269
270 Older versions of this document recommended to use C<void> return
271 value in such cases. It was discovered that this could lead to
272 segfaults in cases when XSUB was I<truly> C<void>. This practice is
273 now deprecated, and may be not supported at some future version. Use
274 the return value C<SV *> in such cases. (Currently C<xsubpp> contains
275 some heuristic code which tries to disambiguate between "truly-void"
276 and "old-practice-declared-as-void" functions. Hence your code is at
277 mercy of this heuristics unless you use C<SV *> as return value.)
278
279 =head2 Returning SVs, AVs and HVs through RETVAL
280
281 When you're using RETVAL to return an C<SV *>, there's some magic
282 going on behind the scenes that should be mentioned. When you're
283 manipulating the argument stack using the ST(x) macro, for example,
284 you usually have to pay special attention to reference counts. (For
285 more about reference counts, see L<perlguts>.) To make your life
286 easier, the typemap file automatically makes C<RETVAL> mortal when
287 you're returning an C<SV *>. Thus, the following two XSUBs are more
288 or less equivalent:
289
290   void
291   alpha()
292       PPCODE:
293           ST(0) = newSVpv("Hello World",0);
294           sv_2mortal(ST(0));
295           XSRETURN(1);
296
297   SV *
298   beta()
299       CODE:
300           RETVAL = newSVpv("Hello World",0);
301       OUTPUT:
302           RETVAL
303
304 This is quite useful as it usually improves readability. While
305 this works fine for an C<SV *>, it's unfortunately not as easy
306 to have C<AV *> or C<HV *> as a return value. You I<should> be
307 able to write:
308
309   AV *
310   array()
311       CODE:
312           RETVAL = newAV();
313           /* do something with RETVAL */
314       OUTPUT:
315           RETVAL
316
317 But due to an unfixable bug (fixing it would break lots of existing
318 CPAN modules) in the typemap file, the reference count of the C<AV *>
319 is not properly decremented. Thus, the above XSUB would leak memory
320 whenever it is being called. The same problem exists for C<HV *>.
321
322 When you're returning an C<AV *> or a C<HV *>, you have to make sure
323 their reference count is decremented by making the AV or HV mortal:
324
325   AV *
326   array()
327       CODE:
328           RETVAL = newAV();
329           sv_2mortal((SV*)RETVAL);
330           /* do something with RETVAL */
331       OUTPUT:
332           RETVAL
333
334 And also remember that you don't have to do this for an C<SV *>.
335
336 =head2 The MODULE Keyword
337
338 The MODULE keyword is used to start the XS code and to specify the package
339 of the functions which are being defined.  All text preceding the first
340 MODULE keyword is considered C code and is passed through to the output with
341 POD stripped, but otherwise untouched.  Every XS module will have a
342 bootstrap function which is used to hook the XSUBs into Perl.  The package
343 name of this bootstrap function will match the value of the last MODULE
344 statement in the XS source files.  The value of MODULE should always remain
345 constant within the same XS file, though this is not required.
346
347 The following example will start the XS code and will place
348 all functions in a package named RPC.
349
350      MODULE = RPC
351
352 =head2 The PACKAGE Keyword
353
354 When functions within an XS source file must be separated into packages
355 the PACKAGE keyword should be used.  This keyword is used with the MODULE
356 keyword and must follow immediately after it when used.
357
358      MODULE = RPC  PACKAGE = RPC
359
360      [ XS code in package RPC ]
361
362      MODULE = RPC  PACKAGE = RPCB
363
364      [ XS code in package RPCB ]
365
366      MODULE = RPC  PACKAGE = RPC
367
368      [ XS code in package RPC ]
369
370 The same package name can be used more than once, allowing for
371 non-contiguous code. This is useful if you have a stronger ordering
372 principle than package names.
373
374 Although this keyword is optional and in some cases provides redundant
375 information it should always be used.  This keyword will ensure that the
376 XSUBs appear in the desired package.
377
378 =head2 The PREFIX Keyword
379
380 The PREFIX keyword designates prefixes which should be
381 removed from the Perl function names.  If the C function is
382 C<rpcb_gettime()> and the PREFIX value is C<rpcb_> then Perl will
383 see this function as C<gettime()>.
384
385 This keyword should follow the PACKAGE keyword when used.
386 If PACKAGE is not used then PREFIX should follow the MODULE
387 keyword.
388
389      MODULE = RPC  PREFIX = rpc_
390
391      MODULE = RPC  PACKAGE = RPCB  PREFIX = rpcb_
392
393 =head2 The OUTPUT: Keyword
394
395 The OUTPUT: keyword indicates that certain function parameters should be
396 updated (new values made visible to Perl) when the XSUB terminates or that
397 certain values should be returned to the calling Perl function.  For
398 simple functions which have no CODE: or PPCODE: section,
399 such as the sin() function above, the RETVAL variable is
400 automatically designated as an output value.  For more complex functions
401 the B<xsubpp> compiler will need help to determine which variables are output
402 variables.
403
404 This keyword will normally be used to complement the CODE:  keyword.
405 The RETVAL variable is not recognized as an output variable when the
406 CODE: keyword is present.  The OUTPUT:  keyword is used in this
407 situation to tell the compiler that RETVAL really is an output
408 variable.
409
410 The OUTPUT: keyword can also be used to indicate that function parameters
411 are output variables.  This may be necessary when a parameter has been
412 modified within the function and the programmer would like the update to
413 be seen by Perl.
414
415      bool_t
416      rpcb_gettime(host,timep)
417           char *host
418           time_t &timep
419         OUTPUT:
420           timep
421
422 The OUTPUT: keyword will also allow an output parameter to
423 be mapped to a matching piece of code rather than to a
424 typemap.
425
426      bool_t
427      rpcb_gettime(host,timep)
428           char *host
429           time_t &timep
430         OUTPUT:
431           timep sv_setnv(ST(1), (double)timep);
432
433 B<xsubpp> emits an automatic C<SvSETMAGIC()> for all parameters in the
434 OUTPUT section of the XSUB, except RETVAL.  This is the usually desired
435 behavior, as it takes care of properly invoking 'set' magic on output
436 parameters (needed for hash or array element parameters that must be
437 created if they didn't exist).  If for some reason, this behavior is
438 not desired, the OUTPUT section may contain a C<SETMAGIC: DISABLE> line
439 to disable it for the remainder of the parameters in the OUTPUT section.
440 Likewise,  C<SETMAGIC: ENABLE> can be used to reenable it for the
441 remainder of the OUTPUT section.  See L<perlguts> for more details
442 about 'set' magic.
443
444 =head2 The NO_OUTPUT Keyword
445
446 The NO_OUTPUT can be placed as the first token of the XSUB.  This keyword
447 indicates that while the C subroutine we provide an interface to has
448 a non-C<void> return type, the return value of this C subroutine should not
449 be returned from the generated Perl subroutine.
450
451 With this keyword present L<The RETVAL Variable> is created, and in the
452 generated call to the subroutine this variable is assigned to, but the value
453 of this variable is not going to be used in the auto-generated code.
454
455 This keyword makes sense only if C<RETVAL> is going to be accessed by the
456 user-supplied code.  It is especially useful to make a function interface
457 more Perl-like, especially when the C return value is just an error condition
458 indicator.  For example,
459
460   NO_OUTPUT int
461   delete_file(char *name)
462     POSTCALL:
463       if (RETVAL != 0)
464           croak("Error %d while deleting file '%s'", RETVAL, name);
465
466 Here the generated XS function returns nothing on success, and will die()
467 with a meaningful error message on error.
468
469 =head2 The CODE: Keyword
470
471 This keyword is used in more complicated XSUBs which require
472 special handling for the C function.  The RETVAL variable is
473 still declared, but it will not be returned unless it is specified
474 in the OUTPUT: section.
475
476 The following XSUB is for a C function which requires special handling of
477 its parameters.  The Perl usage is given first.
478
479      $status = rpcb_gettime( "localhost", $timep );
480
481 The XSUB follows.
482
483      bool_t
484      rpcb_gettime(host,timep)
485           char *host
486           time_t timep
487         CODE:
488                RETVAL = rpcb_gettime( host, &timep );
489         OUTPUT:
490           timep
491           RETVAL
492
493 =head2 The INIT: Keyword
494
495 The INIT: keyword allows initialization to be inserted into the XSUB before
496 the compiler generates the call to the C function.  Unlike the CODE: keyword
497 above, this keyword does not affect the way the compiler handles RETVAL.
498
499     bool_t
500     rpcb_gettime(host,timep)
501           char *host
502           time_t &timep
503         INIT:
504           printf("# Host is %s\n", host );
505         OUTPUT:
506           timep
507
508 Another use for the INIT: section is to check for preconditions before
509 making a call to the C function:
510
511     long long
512     lldiv(a,b)
513         long long a
514         long long b
515       INIT:
516         if (a == 0 && b == 0)
517             XSRETURN_UNDEF;
518         if (b == 0)
519             croak("lldiv: cannot divide by 0");
520
521 =head2 The NO_INIT Keyword
522
523 The NO_INIT keyword is used to indicate that a function
524 parameter is being used only as an output value.  The B<xsubpp>
525 compiler will normally generate code to read the values of
526 all function parameters from the argument stack and assign
527 them to C variables upon entry to the function.  NO_INIT
528 will tell the compiler that some parameters will be used for
529 output rather than for input and that they will be handled
530 before the function terminates.
531
532 The following example shows a variation of the rpcb_gettime() function.
533 This function uses the timep variable only as an output variable and does
534 not care about its initial contents.
535
536      bool_t
537      rpcb_gettime(host,timep)
538           char *host
539           time_t &timep = NO_INIT
540         OUTPUT:
541           timep
542
543 =head2 The TYPEMAP: Keyword
544
545 Starting with Perl 5.16, you can embed typemaps into your XS code
546 instead of or in addition to typemaps in a separate file.  Multiple
547 such embedded typemaps will be processed in order of appearance in
548 the XS code and like local typemap files take precendence over the
549 default typemap, the embedded typemaps may overwrite previous
550 definitions of TYPEMAP, INPUT, and OUTPUT stanzas.  The syntax for
551 embedded typemaps is
552
553       TYPEMAP: <<HERE
554       ... your typemap code here ...
555       HERE
556
557 where the C<TYPEMAP> keyword must appear in the first column of a
558 new line.
559
560 Refer to the section on L<The Typemap> for details on writing typemaps.
561
562 =head2 Initializing Function Parameters
563
564 C function parameters are normally initialized with their values from
565 the argument stack (which in turn contains the parameters that were
566 passed to the XSUB from Perl).  The typemaps contain the
567 code segments which are used to translate the Perl values to
568 the C parameters.  The programmer, however, is allowed to
569 override the typemaps and supply alternate (or additional)
570 initialization code.  Initialization code starts with the first
571 C<=>, C<;> or C<+> on a line in the INPUT: section.  The only
572 exception happens if this C<;> terminates the line, then this C<;>
573 is quietly ignored.
574
575 The following code demonstrates how to supply initialization code for
576 function parameters.  The initialization code is eval'ed within double
577 quotes by the compiler before it is added to the output so anything
578 which should be interpreted literally [mainly C<$>, C<@>, or C<\\>]
579 must be protected with backslashes.  The variables $var, $arg,
580 and $type can be used as in typemaps.
581
582      bool_t
583      rpcb_gettime(host,timep)
584           char *host = (char *)SvPV_nolen($arg);
585           time_t &timep = 0;
586         OUTPUT:
587           timep
588
589 This should not be used to supply default values for parameters.  One
590 would normally use this when a function parameter must be processed by
591 another library function before it can be used.  Default parameters are
592 covered in the next section.
593
594 If the initialization begins with C<=>, then it is output in
595 the declaration for the input variable, replacing the initialization
596 supplied by the typemap.  If the initialization
597 begins with C<;> or C<+>, then it is performed after
598 all of the input variables have been declared.  In the C<;>
599 case the initialization normally supplied by the typemap is not performed.
600 For the C<+> case, the declaration for the variable will include the
601 initialization from the typemap.  A global
602 variable, C<%v>, is available for the truly rare case where
603 information from one initialization is needed in another
604 initialization.
605
606 Here's a truly obscure example:
607
608      bool_t
609      rpcb_gettime(host,timep)
610           time_t &timep; /* \$v{timep}=@{[$v{timep}=$arg]} */
611           char *host + SvOK($v{timep}) ? SvPV_nolen($arg) : NULL;
612         OUTPUT:
613           timep
614
615 The construct C<\$v{timep}=@{[$v{timep}=$arg]}> used in the above
616 example has a two-fold purpose: first, when this line is processed by
617 B<xsubpp>, the Perl snippet C<$v{timep}=$arg> is evaluated.  Second,
618 the text of the evaluated snippet is output into the generated C file
619 (inside a C comment)!  During the processing of C<char *host> line,
620 $arg will evaluate to C<ST(0)>, and C<$v{timep}> will evaluate to
621 C<ST(1)>.
622
623 =head2 Default Parameter Values
624
625 Default values for XSUB arguments can be specified by placing an
626 assignment statement in the parameter list.  The default value may
627 be a number, a string or the special string C<NO_INIT>.  Defaults should
628 always be used on the right-most parameters only.
629
630 To allow the XSUB for rpcb_gettime() to have a default host
631 value the parameters to the XSUB could be rearranged.  The
632 XSUB will then call the real rpcb_gettime() function with
633 the parameters in the correct order.  This XSUB can be called
634 from Perl with either of the following statements:
635
636      $status = rpcb_gettime( $timep, $host );
637
638      $status = rpcb_gettime( $timep );
639
640 The XSUB will look like the code  which  follows.   A  CODE:
641 block  is used to call the real rpcb_gettime() function with
642 the parameters in the correct order for that function.
643
644      bool_t
645      rpcb_gettime(timep,host="localhost")
646           char *host
647           time_t timep = NO_INIT
648         CODE:
649                RETVAL = rpcb_gettime( host, &timep );
650         OUTPUT:
651           timep
652           RETVAL
653
654 =head2 The PREINIT: Keyword
655
656 The PREINIT: keyword allows extra variables to be declared immediately
657 before or after the declarations of the parameters from the INPUT: section
658 are emitted.
659
660 If a variable is declared inside a CODE: section it will follow any typemap
661 code that is emitted for the input parameters.  This may result in the
662 declaration ending up after C code, which is C syntax error.  Similar
663 errors may happen with an explicit C<;>-type or C<+>-type initialization of
664 parameters is used (see L<"Initializing Function Parameters">).  Declaring
665 these variables in an INIT: section will not help.
666
667 In such cases, to force an additional variable to be declared together
668 with declarations of other variables, place the declaration into a
669 PREINIT: section.  The PREINIT: keyword may be used one or more times
670 within an XSUB.
671
672 The following examples are equivalent, but if the code is using complex
673 typemaps then the first example is safer.
674
675      bool_t
676      rpcb_gettime(timep)
677           time_t timep = NO_INIT
678         PREINIT:
679           char *host = "localhost";
680         CODE:
681           RETVAL = rpcb_gettime( host, &timep );
682         OUTPUT:
683           timep
684           RETVAL
685
686 For this particular case an INIT: keyword would generate the
687 same C code as the PREINIT: keyword.  Another correct, but error-prone example:
688
689      bool_t
690      rpcb_gettime(timep)
691           time_t timep = NO_INIT
692         CODE:
693           char *host = "localhost";
694           RETVAL = rpcb_gettime( host, &timep );
695         OUTPUT:
696           timep
697           RETVAL
698
699 Another way to declare C<host> is to use a C block in the CODE: section:
700
701      bool_t
702      rpcb_gettime(timep)
703           time_t timep = NO_INIT
704         CODE:
705           {
706             char *host = "localhost";
707             RETVAL = rpcb_gettime( host, &timep );
708           }
709         OUTPUT:
710           timep
711           RETVAL
712
713 The ability to put additional declarations before the typemap entries are
714 processed is very handy in the cases when typemap conversions manipulate
715 some global state:
716
717     MyObject
718     mutate(o)
719         PREINIT:
720             MyState st = global_state;
721         INPUT:
722             MyObject o;
723         CLEANUP:
724             reset_to(global_state, st);
725
726 Here we suppose that conversion to C<MyObject> in the INPUT: section and from
727 MyObject when processing RETVAL will modify a global variable C<global_state>.
728 After these conversions are performed, we restore the old value of
729 C<global_state> (to avoid memory leaks, for example).
730
731 There is another way to trade clarity for compactness: INPUT sections allow
732 declaration of C variables which do not appear in the parameter list of
733 a subroutine.  Thus the above code for mutate() can be rewritten as
734
735     MyObject
736     mutate(o)
737           MyState st = global_state;
738           MyObject o;
739         CLEANUP:
740           reset_to(global_state, st);
741
742 and the code for rpcb_gettime() can be rewritten as
743
744      bool_t
745      rpcb_gettime(timep)
746           time_t timep = NO_INIT
747           char *host = "localhost";
748         C_ARGS:
749           host, &timep
750         OUTPUT:
751           timep
752           RETVAL
753
754 =head2 The SCOPE: Keyword
755
756 The SCOPE: keyword allows scoping to be enabled for a particular XSUB. If
757 enabled, the XSUB will invoke ENTER and LEAVE automatically.
758
759 To support potentially complex type mappings, if a typemap entry used
760 by an XSUB contains a comment like C</*scope*/> then scoping will
761 be automatically enabled for that XSUB.
762
763 To enable scoping:
764
765     SCOPE: ENABLE
766
767 To disable scoping:
768
769     SCOPE: DISABLE
770
771 =head2 The INPUT: Keyword
772
773 The XSUB's parameters are usually evaluated immediately after entering the
774 XSUB.  The INPUT: keyword can be used to force those parameters to be
775 evaluated a little later.  The INPUT: keyword can be used multiple times
776 within an XSUB and can be used to list one or more input variables.  This
777 keyword is used with the PREINIT: keyword.
778
779 The following example shows how the input parameter C<timep> can be
780 evaluated late, after a PREINIT.
781
782     bool_t
783     rpcb_gettime(host,timep)
784           char *host
785         PREINIT:
786           time_t tt;
787         INPUT:
788           time_t timep
789         CODE:
790                RETVAL = rpcb_gettime( host, &tt );
791                timep = tt;
792         OUTPUT:
793           timep
794           RETVAL
795
796 The next example shows each input parameter evaluated late.
797
798     bool_t
799     rpcb_gettime(host,timep)
800         PREINIT:
801           time_t tt;
802         INPUT:
803           char *host
804         PREINIT:
805           char *h;
806         INPUT:
807           time_t timep
808         CODE:
809                h = host;
810                RETVAL = rpcb_gettime( h, &tt );
811                timep = tt;
812         OUTPUT:
813           timep
814           RETVAL
815
816 Since INPUT sections allow declaration of C variables which do not appear
817 in the parameter list of a subroutine, this may be shortened to:
818
819     bool_t
820     rpcb_gettime(host,timep)
821           time_t tt;
822           char *host;
823           char *h = host;
824           time_t timep;
825         CODE:
826           RETVAL = rpcb_gettime( h, &tt );
827           timep = tt;
828         OUTPUT:
829           timep
830           RETVAL
831
832 (We used our knowledge that input conversion for C<char *> is a "simple" one,
833 thus C<host> is initialized on the declaration line, and our assignment
834 C<h = host> is not performed too early.  Otherwise one would need to have the
835 assignment C<h = host> in a CODE: or INIT: section.)
836
837 =head2 The IN/OUTLIST/IN_OUTLIST/OUT/IN_OUT Keywords
838
839 In the list of parameters for an XSUB, one can precede parameter names
840 by the C<IN>/C<OUTLIST>/C<IN_OUTLIST>/C<OUT>/C<IN_OUT> keywords.
841 C<IN> keyword is the default, the other keywords indicate how the Perl
842 interface should differ from the C interface.
843
844 Parameters preceded by C<OUTLIST>/C<IN_OUTLIST>/C<OUT>/C<IN_OUT>
845 keywords are considered to be used by the C subroutine I<via
846 pointers>.  C<OUTLIST>/C<OUT> keywords indicate that the C subroutine
847 does not inspect the memory pointed by this parameter, but will write
848 through this pointer to provide additional return values.
849
850 Parameters preceded by C<OUTLIST> keyword do not appear in the usage
851 signature of the generated Perl function.
852
853 Parameters preceded by C<IN_OUTLIST>/C<IN_OUT>/C<OUT> I<do> appear as
854 parameters to the Perl function.  With the exception of
855 C<OUT>-parameters, these parameters are converted to the corresponding
856 C type, then pointers to these data are given as arguments to the C
857 function.  It is expected that the C function will write through these
858 pointers.
859
860 The return list of the generated Perl function consists of the C return value
861 from the function (unless the XSUB is of C<void> return type or
862 C<The NO_OUTPUT Keyword> was used) followed by all the C<OUTLIST>
863 and C<IN_OUTLIST> parameters (in the order of appearance).  On the
864 return from the XSUB the C<IN_OUT>/C<OUT> Perl parameter will be
865 modified to have the values written by the C function.
866
867 For example, an XSUB
868
869   void
870   day_month(OUTLIST day, IN unix_time, OUTLIST month)
871     int day
872     int unix_time
873     int month
874
875 should be used from Perl as
876
877   my ($day, $month) = day_month(time);
878
879 The C signature of the corresponding function should be
880
881   void day_month(int *day, int unix_time, int *month);
882
883 The C<IN>/C<OUTLIST>/C<IN_OUTLIST>/C<IN_OUT>/C<OUT> keywords can be
884 mixed with ANSI-style declarations, as in
885
886   void
887   day_month(OUTLIST int day, int unix_time, OUTLIST int month)
888
889 (here the optional C<IN> keyword is omitted).
890
891 The C<IN_OUT> parameters are identical with parameters introduced with
892 L<The & Unary Operator> and put into the C<OUTPUT:> section (see
893 L<The OUTPUT: Keyword>).  The C<IN_OUTLIST> parameters are very similar,
894 the only difference being that the value C function writes through the
895 pointer would not modify the Perl parameter, but is put in the output
896 list.
897
898 The C<OUTLIST>/C<OUT> parameter differ from C<IN_OUTLIST>/C<IN_OUT>
899 parameters only by the initial value of the Perl parameter not
900 being read (and not being given to the C function - which gets some
901 garbage instead).  For example, the same C function as above can be
902 interfaced with as
903
904   void day_month(OUT int day, int unix_time, OUT int month);
905
906 or
907
908   void
909   day_month(day, unix_time, month)
910       int &day = NO_INIT
911       int  unix_time
912       int &month = NO_INIT
913     OUTPUT:
914       day
915       month
916
917 However, the generated Perl function is called in very C-ish style:
918
919   my ($day, $month);
920   day_month($day, time, $month);
921
922 =head2 The C<length(NAME)> Keyword
923
924 If one of the input arguments to the C function is the length of a string
925 argument C<NAME>, one can substitute the name of the length-argument by
926 C<length(NAME)> in the XSUB declaration.  This argument must be omitted when
927 the generated Perl function is called.  E.g.,
928
929   void
930   dump_chars(char *s, short l)
931   {
932     short n = 0;
933     while (n < l) {
934         printf("s[%d] = \"\\%#03o\"\n", n, (int)s[n]);
935         n++;
936     }
937   }
938
939   MODULE = x            PACKAGE = x
940
941   void dump_chars(char *s, short length(s))
942
943 should be called as C<dump_chars($string)>.
944
945 This directive is supported with ANSI-type function declarations only.
946
947 =head2 Variable-length Parameter Lists
948
949 XSUBs can have variable-length parameter lists by specifying an ellipsis
950 C<(...)> in the parameter list.  This use of the ellipsis is similar to that
951 found in ANSI C.  The programmer is able to determine the number of
952 arguments passed to the XSUB by examining the C<items> variable which the
953 B<xsubpp> compiler supplies for all XSUBs.  By using this mechanism one can
954 create an XSUB which accepts a list of parameters of unknown length.
955
956 The I<host> parameter for the rpcb_gettime() XSUB can be
957 optional so the ellipsis can be used to indicate that the
958 XSUB will take a variable number of parameters.  Perl should
959 be able to call this XSUB with either of the following statements.
960
961      $status = rpcb_gettime( $timep, $host );
962
963      $status = rpcb_gettime( $timep );
964
965 The XS code, with ellipsis, follows.
966
967      bool_t
968      rpcb_gettime(timep, ...)
969           time_t timep = NO_INIT
970         PREINIT:
971           char *host = "localhost";
972         CODE:
973           if( items > 1 )
974                host = (char *)SvPV_nolen(ST(1));
975           RETVAL = rpcb_gettime( host, &timep );
976         OUTPUT:
977           timep
978           RETVAL
979
980 =head2 The C_ARGS: Keyword
981
982 The C_ARGS: keyword allows creating of XSUBS which have different
983 calling sequence from Perl than from C, without a need to write
984 CODE: or PPCODE: section.  The contents of the C_ARGS: paragraph is
985 put as the argument to the called C function without any change.
986
987 For example, suppose that a C function is declared as
988
989     symbolic nth_derivative(int n, symbolic function, int flags);
990
991 and that the default flags are kept in a global C variable
992 C<default_flags>.  Suppose that you want to create an interface which
993 is called as
994
995     $second_deriv = $function->nth_derivative(2);
996
997 To do this, declare the XSUB as
998
999     symbolic
1000     nth_derivative(function, n)
1001         symbolic        function
1002         int             n
1003       C_ARGS:
1004         n, function, default_flags
1005
1006 =head2 The PPCODE: Keyword
1007
1008 The PPCODE: keyword is an alternate form of the CODE: keyword and is used
1009 to tell the B<xsubpp> compiler that the programmer is supplying the code to
1010 control the argument stack for the XSUBs return values.  Occasionally one
1011 will want an XSUB to return a list of values rather than a single value.
1012 In these cases one must use PPCODE: and then explicitly push the list of
1013 values on the stack.  The PPCODE: and CODE:  keywords should not be used
1014 together within the same XSUB.
1015
1016 The actual difference between PPCODE: and CODE: sections is in the
1017 initialization of C<SP> macro (which stands for the I<current> Perl
1018 stack pointer), and in the handling of data on the stack when returning
1019 from an XSUB.  In CODE: sections SP preserves the value which was on
1020 entry to the XSUB: SP is on the function pointer (which follows the
1021 last parameter).  In PPCODE: sections SP is moved backward to the
1022 beginning of the parameter list, which allows C<PUSH*()> macros
1023 to place output values in the place Perl expects them to be when
1024 the XSUB returns back to Perl.
1025
1026 The generated trailer for a CODE: section ensures that the number of return
1027 values Perl will see is either 0 or 1 (depending on the C<void>ness of the
1028 return value of the C function, and heuristics mentioned in
1029 L<"The RETVAL Variable">).  The trailer generated for a PPCODE: section
1030 is based on the number of return values and on the number of times
1031 C<SP> was updated by C<[X]PUSH*()> macros.
1032
1033 Note that macros C<ST(i)>, C<XST_m*()> and C<XSRETURN*()> work equally
1034 well in CODE: sections and PPCODE: sections.
1035
1036 The following XSUB will call the C rpcb_gettime() function
1037 and will return its two output values, timep and status, to
1038 Perl as a single list.
1039
1040      void
1041      rpcb_gettime(host)
1042           char *host
1043         PREINIT:
1044           time_t  timep;
1045           bool_t  status;
1046         PPCODE:
1047           status = rpcb_gettime( host, &timep );
1048           EXTEND(SP, 2);
1049           PUSHs(sv_2mortal(newSViv(status)));
1050           PUSHs(sv_2mortal(newSViv(timep)));
1051
1052 Notice that the programmer must supply the C code necessary
1053 to have the real rpcb_gettime() function called and to have
1054 the return values properly placed on the argument stack.
1055
1056 The C<void> return type for this function tells the B<xsubpp> compiler that
1057 the RETVAL variable is not needed or used and that it should not be created.
1058 In most scenarios the void return type should be used with the PPCODE:
1059 directive.
1060
1061 The EXTEND() macro is used to make room on the argument
1062 stack for 2 return values.  The PPCODE: directive causes the
1063 B<xsubpp> compiler to create a stack pointer available as C<SP>, and it
1064 is this pointer which is being used in the EXTEND() macro.
1065 The values are then pushed onto the stack with the PUSHs()
1066 macro.
1067
1068 Now the rpcb_gettime() function can be used from Perl with
1069 the following statement.
1070
1071      ($status, $timep) = rpcb_gettime("localhost");
1072
1073 When handling output parameters with a PPCODE section, be sure to handle
1074 'set' magic properly.  See L<perlguts> for details about 'set' magic.
1075
1076 =head2 Returning Undef And Empty Lists
1077
1078 Occasionally the programmer will want to return simply
1079 C<undef> or an empty list if a function fails rather than a
1080 separate status value.  The rpcb_gettime() function offers
1081 just this situation.  If the function succeeds we would like
1082 to have it return the time and if it fails we would like to
1083 have undef returned.  In the following Perl code the value
1084 of $timep will either be undef or it will be a valid time.
1085
1086      $timep = rpcb_gettime( "localhost" );
1087
1088 The following XSUB uses the C<SV *> return type as a mnemonic only,
1089 and uses a CODE: block to indicate to the compiler
1090 that the programmer has supplied all the necessary code.  The
1091 sv_newmortal() call will initialize the return value to undef, making that
1092 the default return value.
1093
1094      SV *
1095      rpcb_gettime(host)
1096           char *  host
1097         PREINIT:
1098           time_t  timep;
1099           bool_t x;
1100         CODE:
1101           ST(0) = sv_newmortal();
1102           if( rpcb_gettime( host, &timep ) )
1103                sv_setnv( ST(0), (double)timep);
1104
1105 The next example demonstrates how one would place an explicit undef in the
1106 return value, should the need arise.
1107
1108      SV *
1109      rpcb_gettime(host)
1110           char *  host
1111         PREINIT:
1112           time_t  timep;
1113           bool_t x;
1114         CODE:
1115           if( rpcb_gettime( host, &timep ) ){
1116                ST(0) = sv_newmortal();
1117                sv_setnv( ST(0), (double)timep);
1118           }
1119           else{
1120                ST(0) = &PL_sv_undef;
1121           }
1122
1123 To return an empty list one must use a PPCODE: block and
1124 then not push return values on the stack.
1125
1126      void
1127      rpcb_gettime(host)
1128           char *host
1129         PREINIT:
1130           time_t  timep;
1131         PPCODE:
1132           if( rpcb_gettime( host, &timep ) )
1133                PUSHs(sv_2mortal(newSViv(timep)));
1134           else{
1135               /* Nothing pushed on stack, so an empty
1136                * list is implicitly returned. */
1137           }
1138
1139 Some people may be inclined to include an explicit C<return> in the above
1140 XSUB, rather than letting control fall through to the end.  In those
1141 situations C<XSRETURN_EMPTY> should be used, instead.  This will ensure that
1142 the XSUB stack is properly adjusted.  Consult L<perlapi> for other
1143 C<XSRETURN> macros.
1144
1145 Since C<XSRETURN_*> macros can be used with CODE blocks as well, one can
1146 rewrite this example as:
1147
1148      int
1149      rpcb_gettime(host)
1150           char *host
1151         PREINIT:
1152           time_t  timep;
1153         CODE:
1154           RETVAL = rpcb_gettime( host, &timep );
1155           if (RETVAL == 0)
1156                 XSRETURN_UNDEF;
1157         OUTPUT:
1158           RETVAL
1159
1160 In fact, one can put this check into a POSTCALL: section as well.  Together
1161 with PREINIT: simplifications, this leads to:
1162
1163      int
1164      rpcb_gettime(host)
1165           char *host
1166           time_t  timep;
1167         POSTCALL:
1168           if (RETVAL == 0)
1169                 XSRETURN_UNDEF;
1170
1171 =head2 The REQUIRE: Keyword
1172
1173 The REQUIRE: keyword is used to indicate the minimum version of the
1174 B<xsubpp> compiler needed to compile the XS module.  An XS module which
1175 contains the following statement will compile with only B<xsubpp> version
1176 1.922 or greater:
1177
1178         REQUIRE: 1.922
1179
1180 =head2 The CLEANUP: Keyword
1181
1182 This keyword can be used when an XSUB requires special cleanup procedures
1183 before it terminates.  When the CLEANUP:  keyword is used it must follow
1184 any CODE:, PPCODE:, or OUTPUT: blocks which are present in the XSUB.  The
1185 code specified for the cleanup block will be added as the last statements
1186 in the XSUB.
1187
1188 =head2 The POSTCALL: Keyword
1189
1190 This keyword can be used when an XSUB requires special procedures
1191 executed after the C subroutine call is performed.  When the POSTCALL:
1192 keyword is used it must precede OUTPUT: and CLEANUP: blocks which are
1193 present in the XSUB.
1194
1195 See examples in L<"The NO_OUTPUT Keyword"> and L<"Returning Undef And Empty Lists">.
1196
1197 The POSTCALL: block does not make a lot of sense when the C subroutine
1198 call is supplied by user by providing either CODE: or PPCODE: section.
1199
1200 =head2 The BOOT: Keyword
1201
1202 The BOOT: keyword is used to add code to the extension's bootstrap
1203 function.  The bootstrap function is generated by the B<xsubpp> compiler and
1204 normally holds the statements necessary to register any XSUBs with Perl.
1205 With the BOOT: keyword the programmer can tell the compiler to add extra
1206 statements to the bootstrap function.
1207
1208 This keyword may be used any time after the first MODULE keyword and should
1209 appear on a line by itself.  The first blank line after the keyword will
1210 terminate the code block.
1211
1212      BOOT:
1213      # The following message will be printed when the
1214      # bootstrap function executes.
1215      printf("Hello from the bootstrap!\n");
1216
1217 =head2 The VERSIONCHECK: Keyword
1218
1219 The VERSIONCHECK: keyword corresponds to B<xsubpp>'s C<-versioncheck> and
1220 C<-noversioncheck> options.  This keyword overrides the command line
1221 options.  Version checking is enabled by default.  When version checking is
1222 enabled the XS module will attempt to verify that its version matches the
1223 version of the PM module.
1224
1225 To enable version checking:
1226
1227     VERSIONCHECK: ENABLE
1228
1229 To disable version checking:
1230
1231     VERSIONCHECK: DISABLE
1232
1233 Note that if the version of the PM module is an NV (a floating point
1234 number), it will be stringified with a possible loss of precision
1235 (currently chopping to nine decimal places) so that it may not match
1236 the version of the XS module anymore. Quoting the $VERSION declaration
1237 to make it a string is recommended if long version numbers are used.
1238
1239 =head2 The PROTOTYPES: Keyword
1240
1241 The PROTOTYPES: keyword corresponds to B<xsubpp>'s C<-prototypes> and
1242 C<-noprototypes> options.  This keyword overrides the command line options.
1243 Prototypes are enabled by default.  When prototypes are enabled XSUBs will
1244 be given Perl prototypes.  This keyword may be used multiple times in an XS
1245 module to enable and disable prototypes for different parts of the module.
1246
1247 To enable prototypes:
1248
1249     PROTOTYPES: ENABLE
1250
1251 To disable prototypes:
1252
1253     PROTOTYPES: DISABLE
1254
1255 =head2 The PROTOTYPE: Keyword
1256
1257 This keyword is similar to the PROTOTYPES: keyword above but can be used to
1258 force B<xsubpp> to use a specific prototype for the XSUB.  This keyword
1259 overrides all other prototype options and keywords but affects only the
1260 current XSUB.  Consult L<perlsub/Prototypes> for information about Perl
1261 prototypes.
1262
1263     bool_t
1264     rpcb_gettime(timep, ...)
1265           time_t timep = NO_INIT
1266         PROTOTYPE: $;$
1267         PREINIT:
1268           char *host = "localhost";
1269         CODE:
1270                   if( items > 1 )
1271                        host = (char *)SvPV_nolen(ST(1));
1272                   RETVAL = rpcb_gettime( host, &timep );
1273         OUTPUT:
1274           timep
1275           RETVAL
1276
1277 If the prototypes are enabled, you can disable it locally for a given
1278 XSUB as in the following example:
1279
1280     void
1281     rpcb_gettime_noproto()
1282         PROTOTYPE: DISABLE
1283     ...
1284
1285 =head2 The ALIAS: Keyword
1286
1287 The ALIAS: keyword allows an XSUB to have two or more unique Perl names
1288 and to know which of those names was used when it was invoked.  The Perl
1289 names may be fully-qualified with package names.  Each alias is given an
1290 index.  The compiler will setup a variable called C<ix> which contain the
1291 index of the alias which was used.  When the XSUB is called with its
1292 declared name C<ix> will be 0.
1293
1294 The following example will create aliases C<FOO::gettime()> and
1295 C<BAR::getit()> for this function.
1296
1297     bool_t
1298     rpcb_gettime(host,timep)
1299           char *host
1300           time_t &timep
1301         ALIAS:
1302             FOO::gettime = 1
1303             BAR::getit = 2
1304         INIT:
1305           printf("# ix = %d\n", ix );
1306         OUTPUT:
1307           timep
1308
1309 =head2 The OVERLOAD: Keyword
1310
1311 Instead of writing an overloaded interface using pure Perl, you
1312 can also use the OVERLOAD keyword to define additional Perl names
1313 for your functions (like the ALIAS: keyword above).  However, the
1314 overloaded functions must be defined with three parameters (except
1315 for the nomethod() function which needs four parameters).  If any
1316 function has the OVERLOAD: keyword, several additional lines
1317 will be defined in the c file generated by xsubpp in order to
1318 register with the overload magic.
1319
1320 Since blessed objects are actually stored as RV's, it is useful
1321 to use the typemap features to preprocess parameters and extract
1322 the actual SV stored within the blessed RV. See the sample for
1323 T_PTROBJ_SPECIAL below.
1324
1325 To use the OVERLOAD: keyword, create an XS function which takes
1326 three input parameters ( or use the c style '...' definition) like
1327 this:
1328
1329     SV *
1330     cmp (lobj, robj, swap)
1331     My_Module_obj    lobj
1332     My_Module_obj    robj
1333     IV               swap
1334     OVERLOAD: cmp <=>
1335     { /* function defined here */}
1336
1337 In this case, the function will overload both of the three way
1338 comparison operators.  For all overload operations using non-alpha
1339 characters, you must type the parameter without quoting, separating
1340 multiple overloads with whitespace.  Note that "" (the stringify
1341 overload) should be entered as \"\" (i.e. escaped).
1342
1343 =head2 The FALLBACK: Keyword
1344
1345 In addition to the OVERLOAD keyword, if you need to control how
1346 Perl autogenerates missing overloaded operators, you can set the
1347 FALLBACK keyword in the module header section, like this:
1348
1349     MODULE = RPC  PACKAGE = RPC
1350
1351     FALLBACK: TRUE
1352     ...
1353
1354 where FALLBACK can take any of the three values TRUE, FALSE, or
1355 UNDEF.  If you do not set any FALLBACK value when using OVERLOAD,
1356 it defaults to UNDEF.  FALLBACK is not used except when one or
1357 more functions using OVERLOAD have been defined.  Please see
1358 L<overload/fallback> for more details.
1359
1360 =head2 The INTERFACE: Keyword
1361
1362 This keyword declares the current XSUB as a keeper of the given
1363 calling signature.  If some text follows this keyword, it is
1364 considered as a list of functions which have this signature, and
1365 should be attached to the current XSUB.
1366
1367 For example, if you have 4 C functions multiply(), divide(), add(),
1368 subtract() all having the signature:
1369
1370     symbolic f(symbolic, symbolic);
1371
1372 you can make them all to use the same XSUB using this:
1373
1374     symbolic
1375     interface_s_ss(arg1, arg2)
1376         symbolic        arg1
1377         symbolic        arg2
1378     INTERFACE:
1379         multiply divide
1380         add subtract
1381
1382 (This is the complete XSUB code for 4 Perl functions!)  Four generated
1383 Perl function share names with corresponding C functions.
1384
1385 The advantage of this approach comparing to ALIAS: keyword is that there
1386 is no need to code a switch statement, each Perl function (which shares
1387 the same XSUB) knows which C function it should call.  Additionally, one
1388 can attach an extra function remainder() at runtime by using
1389
1390     CV *mycv = newXSproto("Symbolic::remainder",
1391                           XS_Symbolic_interface_s_ss, __FILE__, "$$");
1392     XSINTERFACE_FUNC_SET(mycv, remainder);
1393
1394 say, from another XSUB.  (This example supposes that there was no
1395 INTERFACE_MACRO: section, otherwise one needs to use something else instead of
1396 C<XSINTERFACE_FUNC_SET>, see the next section.)
1397
1398 =head2 The INTERFACE_MACRO: Keyword
1399
1400 This keyword allows one to define an INTERFACE using a different way
1401 to extract a function pointer from an XSUB.  The text which follows
1402 this keyword should give the name of macros which would extract/set a
1403 function pointer.  The extractor macro is given return type, C<CV*>,
1404 and C<XSANY.any_dptr> for this C<CV*>.  The setter macro is given cv,
1405 and the function pointer.
1406
1407 The default value is C<XSINTERFACE_FUNC> and C<XSINTERFACE_FUNC_SET>.
1408 An INTERFACE keyword with an empty list of functions can be omitted if
1409 INTERFACE_MACRO keyword is used.
1410
1411 Suppose that in the previous example functions pointers for
1412 multiply(), divide(), add(), subtract() are kept in a global C array
1413 C<fp[]> with offsets being C<multiply_off>, C<divide_off>, C<add_off>,
1414 C<subtract_off>.  Then one can use
1415
1416     #define XSINTERFACE_FUNC_BYOFFSET(ret,cv,f) \
1417         ((XSINTERFACE_CVT_ANON(ret))fp[CvXSUBANY(cv).any_i32])
1418     #define XSINTERFACE_FUNC_BYOFFSET_set(cv,f) \
1419         CvXSUBANY(cv).any_i32 = CAT2( f, _off )
1420
1421 in C section,
1422
1423     symbolic
1424     interface_s_ss(arg1, arg2)
1425         symbolic        arg1
1426         symbolic        arg2
1427       INTERFACE_MACRO:
1428         XSINTERFACE_FUNC_BYOFFSET
1429         XSINTERFACE_FUNC_BYOFFSET_set
1430       INTERFACE:
1431         multiply divide
1432         add subtract
1433
1434 in XSUB section.
1435
1436 =head2 The INCLUDE: Keyword
1437
1438 This keyword can be used to pull other files into the XS module.  The other
1439 files may have XS code.  INCLUDE: can also be used to run a command to
1440 generate the XS code to be pulled into the module.
1441
1442 The file F<Rpcb1.xsh> contains our C<rpcb_gettime()> function:
1443
1444     bool_t
1445     rpcb_gettime(host,timep)
1446           char *host
1447           time_t &timep
1448         OUTPUT:
1449           timep
1450
1451 The XS module can use INCLUDE: to pull that file into it.
1452
1453     INCLUDE: Rpcb1.xsh
1454
1455 If the parameters to the INCLUDE: keyword are followed by a pipe (C<|>) then
1456 the compiler will interpret the parameters as a command. This feature is
1457 mildly deprecated in favour of the C<INCLUDE_COMMAND:> directive, as documented
1458 below.
1459
1460     INCLUDE: cat Rpcb1.xsh |
1461
1462 Do not use this to run perl: C<INCLUDE: perl |> will run the perl that
1463 happens to be the first in your path and not necessarily the same perl that is
1464 used to run C<xsubpp>. See L<"The INCLUDE_COMMAND: Keyword">.
1465
1466 =head2 The INCLUDE_COMMAND: Keyword
1467
1468 Runs the supplied command and includes its output into the current XS
1469 document. C<INCLUDE_COMMAND> assigns special meaning to the C<$^X> token
1470 in that it runs the same perl interpreter that is running C<xsubpp>:
1471
1472     INCLUDE_COMMAND: cat Rpcb1.xsh
1473
1474     INCLUDE_COMMAND: $^X -e ...
1475
1476 =head2 The CASE: Keyword
1477
1478 The CASE: keyword allows an XSUB to have multiple distinct parts with each
1479 part acting as a virtual XSUB.  CASE: is greedy and if it is used then all
1480 other XS keywords must be contained within a CASE:.  This means nothing may
1481 precede the first CASE: in the XSUB and anything following the last CASE: is
1482 included in that case.
1483
1484 A CASE: might switch via a parameter of the XSUB, via the C<ix> ALIAS:
1485 variable (see L<"The ALIAS: Keyword">), or maybe via the C<items> variable
1486 (see L<"Variable-length Parameter Lists">).  The last CASE: becomes the
1487 B<default> case if it is not associated with a conditional.  The following
1488 example shows CASE switched via C<ix> with a function C<rpcb_gettime()>
1489 having an alias C<x_gettime()>.  When the function is called as
1490 C<rpcb_gettime()> its parameters are the usual C<(char *host, time_t *timep)>,
1491 but when the function is called as C<x_gettime()> its parameters are
1492 reversed, C<(time_t *timep, char *host)>.
1493
1494     long
1495     rpcb_gettime(a,b)
1496       CASE: ix == 1
1497         ALIAS:
1498           x_gettime = 1
1499         INPUT:
1500           # 'a' is timep, 'b' is host
1501           char *b
1502           time_t a = NO_INIT
1503         CODE:
1504                RETVAL = rpcb_gettime( b, &a );
1505         OUTPUT:
1506           a
1507           RETVAL
1508       CASE:
1509           # 'a' is host, 'b' is timep
1510           char *a
1511           time_t &b = NO_INIT
1512         OUTPUT:
1513           b
1514           RETVAL
1515
1516 That function can be called with either of the following statements.  Note
1517 the different argument lists.
1518
1519         $status = rpcb_gettime( $host, $timep );
1520
1521         $status = x_gettime( $timep, $host );
1522
1523 =head2 The EXPORT_XSUB_SYMBOLS: Keyword
1524
1525 The EXPORT_XSUB_SYMBOLS: keyword is likely something you will never need.
1526 In perl versions earlier than 5.16.0, this keyword does nothing. Starting
1527 with 5.16, XSUB symbols are no longer exported by default. That is, they
1528 are C<static> functions. If you include
1529
1530   EXPORT_XSUB_SYMBOLS: ENABLE
1531
1532 in your XS code, the XSUBs following this line will not be declared C<static>.
1533 You can later disable this with
1534
1535   EXPORT_XSUB_SYMBOLS: DISABLE
1536
1537 which, again, is the default that you should probably never change.
1538 You cannot use this keyword on versions of perl before 5.16 to make
1539 XSUBs C<static>.
1540
1541 =head2 The & Unary Operator
1542
1543 The C<&> unary operator in the INPUT: section is used to tell B<xsubpp>
1544 that it should convert a Perl value to/from C using the C type to the left
1545 of C<&>, but provide a pointer to this value when the C function is called.
1546
1547 This is useful to avoid a CODE: block for a C function which takes a parameter
1548 by reference.  Typically, the parameter should be not a pointer type (an
1549 C<int> or C<long> but not an C<int*> or C<long*>).
1550
1551 The following XSUB will generate incorrect C code.  The B<xsubpp> compiler will
1552 turn this into code which calls C<rpcb_gettime()> with parameters C<(char
1553 *host, time_t timep)>, but the real C<rpcb_gettime()> wants the C<timep>
1554 parameter to be of type C<time_t*> rather than C<time_t>.
1555
1556     bool_t
1557     rpcb_gettime(host,timep)
1558           char *host
1559           time_t timep
1560         OUTPUT:
1561           timep
1562
1563 That problem is corrected by using the C<&> operator.  The B<xsubpp> compiler
1564 will now turn this into code which calls C<rpcb_gettime()> correctly with
1565 parameters C<(char *host, time_t *timep)>.  It does this by carrying the
1566 C<&> through, so the function call looks like C<rpcb_gettime(host, &timep)>.
1567
1568     bool_t
1569     rpcb_gettime(host,timep)
1570           char *host
1571           time_t &timep
1572         OUTPUT:
1573           timep
1574
1575 =head2 Inserting POD, Comments and C Preprocessor Directives
1576
1577 C preprocessor directives are allowed within BOOT:, PREINIT: INIT:, CODE:,
1578 PPCODE:, POSTCALL:, and CLEANUP: blocks, as well as outside the functions.
1579 Comments are allowed anywhere after the MODULE keyword.  The compiler will
1580 pass the preprocessor directives through untouched and will remove the
1581 commented lines. POD documentation is allowed at any point, both in the
1582 C and XS language sections. POD must be terminated with a C<=cut> command;
1583 C<xsubpp> will exit with an error if it does not. It is very unlikely that
1584 human generated C code will be mistaken for POD, as most indenting styles
1585 result in whitespace in front of any line starting with C<=>. Machine
1586 generated XS files may fall into this trap unless care is taken to
1587 ensure that a space breaks the sequence "\n=".
1588
1589 Comments can be added to XSUBs by placing a C<#> as the first
1590 non-whitespace of a line.  Care should be taken to avoid making the
1591 comment look like a C preprocessor directive, lest it be interpreted as
1592 such.  The simplest way to prevent this is to put whitespace in front of
1593 the C<#>.
1594
1595 If you use preprocessor directives to choose one of two
1596 versions of a function, use
1597
1598     #if ... version1
1599     #else /* ... version2  */
1600     #endif
1601
1602 and not
1603
1604     #if ... version1
1605     #endif
1606     #if ... version2
1607     #endif
1608
1609 because otherwise B<xsubpp> will believe that you made a duplicate
1610 definition of the function.  Also, put a blank line before the
1611 #else/#endif so it will not be seen as part of the function body.
1612
1613 =head2 Using XS With C++
1614
1615 If an XSUB name contains C<::>, it is considered to be a C++ method.
1616 The generated Perl function will assume that
1617 its first argument is an object pointer.  The object pointer
1618 will be stored in a variable called THIS.  The object should
1619 have been created by C++ with the new() function and should
1620 be blessed by Perl with the sv_setref_pv() macro.  The
1621 blessing of the object by Perl can be handled by a typemap.  An example
1622 typemap is shown at the end of this section.
1623
1624 If the return type of the XSUB includes C<static>, the method is considered
1625 to be a static method.  It will call the C++
1626 function using the class::method() syntax.  If the method is not static
1627 the function will be called using the THIS-E<gt>method() syntax.
1628
1629 The next examples will use the following C++ class.
1630
1631      class color {
1632           public:
1633           color();
1634           ~color();
1635           int blue();
1636           void set_blue( int );
1637
1638           private:
1639           int c_blue;
1640      };
1641
1642 The XSUBs for the blue() and set_blue() methods are defined with the class
1643 name but the parameter for the object (THIS, or "self") is implicit and is
1644 not listed.
1645
1646      int
1647      color::blue()
1648
1649      void
1650      color::set_blue( val )
1651           int val
1652
1653 Both Perl functions will expect an object as the first parameter.  In the
1654 generated C++ code the object is called C<THIS>, and the method call will
1655 be performed on this object.  So in the C++ code the blue() and set_blue()
1656 methods will be called as this:
1657
1658      RETVAL = THIS->blue();
1659
1660      THIS->set_blue( val );
1661
1662 You could also write a single get/set method using an optional argument:
1663
1664      int
1665      color::blue( val = NO_INIT )
1666          int val
1667          PROTOTYPE $;$
1668          CODE:
1669              if (items > 1)
1670                  THIS->set_blue( val );
1671              RETVAL = THIS->blue();
1672          OUTPUT:
1673              RETVAL
1674
1675 If the function's name is B<DESTROY> then the C++ C<delete> function will be
1676 called and C<THIS> will be given as its parameter.  The generated C++ code for
1677
1678      void
1679      color::DESTROY()
1680
1681 will look like this:
1682
1683      color *THIS = ...; // Initialized as in typemap
1684
1685      delete THIS;
1686
1687 If the function's name is B<new> then the C++ C<new> function will be called
1688 to create a dynamic C++ object.  The XSUB will expect the class name, which
1689 will be kept in a variable called C<CLASS>, to be given as the first
1690 argument.
1691
1692      color *
1693      color::new()
1694
1695 The generated C++ code will call C<new>.
1696
1697      RETVAL = new color();
1698
1699 The following is an example of a typemap that could be used for this C++
1700 example.
1701
1702     TYPEMAP
1703     color *             O_OBJECT
1704
1705     OUTPUT
1706     # The Perl object is blessed into 'CLASS', which should be a
1707     # char* having the name of the package for the blessing.
1708     O_OBJECT
1709         sv_setref_pv( $arg, CLASS, (void*)$var );
1710
1711     INPUT
1712     O_OBJECT
1713         if( sv_isobject($arg) && (SvTYPE(SvRV($arg)) == SVt_PVMG) )
1714                 $var = ($type)SvIV((SV*)SvRV( $arg ));
1715         else{
1716                 warn( \"${Package}::$func_name() -- $var is not a blessed SV reference\" );
1717                 XSRETURN_UNDEF;
1718         }
1719
1720 =head2 Interface Strategy
1721
1722 When designing an interface between Perl and a C library a straight
1723 translation from C to XS (such as created by C<h2xs -x>) is often sufficient.
1724 However, sometimes the interface will look
1725 very C-like and occasionally nonintuitive, especially when the C function
1726 modifies one of its parameters, or returns failure inband (as in "negative
1727 return values mean failure").  In cases where the programmer wishes to
1728 create a more Perl-like interface the following strategy may help to
1729 identify the more critical parts of the interface.
1730
1731 Identify the C functions with input/output or output parameters.  The XSUBs for
1732 these functions may be able to return lists to Perl.
1733
1734 Identify the C functions which use some inband info as an indication
1735 of failure.  They may be
1736 candidates to return undef or an empty list in case of failure.  If the
1737 failure may be detected without a call to the C function, you may want to use
1738 an INIT: section to report the failure.  For failures detectable after the C
1739 function returns one may want to use a POSTCALL: section to process the
1740 failure.  In more complicated cases use CODE: or PPCODE: sections.
1741
1742 If many functions use the same failure indication based on the return value,
1743 you may want to create a special typedef to handle this situation.  Put
1744
1745   typedef int negative_is_failure;
1746
1747 near the beginning of XS file, and create an OUTPUT typemap entry
1748 for C<negative_is_failure> which converts negative values to C<undef>, or
1749 maybe croak()s.  After this the return value of type C<negative_is_failure>
1750 will create more Perl-like interface.
1751
1752 Identify which values are used by only the C and XSUB functions
1753 themselves, say, when a parameter to a function should be a contents of a
1754 global variable.  If Perl does not need to access the contents of the value
1755 then it may not be necessary to provide a translation for that value
1756 from C to Perl.
1757
1758 Identify the pointers in the C function parameter lists and return
1759 values.  Some pointers may be used to implement input/output or
1760 output parameters, they can be handled in XS with the C<&> unary operator,
1761 and, possibly, using the NO_INIT keyword.
1762 Some others will require handling of types like C<int *>, and one needs
1763 to decide what a useful Perl translation will do in such a case.  When
1764 the semantic is clear, it is advisable to put the translation into a typemap
1765 file.
1766
1767 Identify the structures used by the C functions.  In many
1768 cases it may be helpful to use the T_PTROBJ typemap for
1769 these structures so they can be manipulated by Perl as
1770 blessed objects.  (This is handled automatically by C<h2xs -x>.)
1771
1772 If the same C type is used in several different contexts which require
1773 different translations, C<typedef> several new types mapped to this C type,
1774 and create separate F<typemap> entries for these new types.  Use these
1775 types in declarations of return type and parameters to XSUBs.
1776
1777 =head2 Perl Objects And C Structures
1778
1779 When dealing with C structures one should select either
1780 B<T_PTROBJ> or B<T_PTRREF> for the XS type.  Both types are
1781 designed to handle pointers to complex objects.  The
1782 T_PTRREF type will allow the Perl object to be unblessed
1783 while the T_PTROBJ type requires that the object be blessed.
1784 By using T_PTROBJ one can achieve a form of type-checking
1785 because the XSUB will attempt to verify that the Perl object
1786 is of the expected type.
1787
1788 The following XS code shows the getnetconfigent() function which is used
1789 with ONC+ TIRPC.  The getnetconfigent() function will return a pointer to a
1790 C structure and has the C prototype shown below.  The example will
1791 demonstrate how the C pointer will become a Perl reference.  Perl will
1792 consider this reference to be a pointer to a blessed object and will
1793 attempt to call a destructor for the object.  A destructor will be
1794 provided in the XS source to free the memory used by getnetconfigent().
1795 Destructors in XS can be created by specifying an XSUB function whose name
1796 ends with the word B<DESTROY>.  XS destructors can be used to free memory
1797 which may have been malloc'd by another XSUB.
1798
1799      struct netconfig *getnetconfigent(const char *netid);
1800
1801 A C<typedef> will be created for C<struct netconfig>.  The Perl
1802 object will be blessed in a class matching the name of the C
1803 type, with the tag C<Ptr> appended, and the name should not
1804 have embedded spaces if it will be a Perl package name.  The
1805 destructor will be placed in a class corresponding to the
1806 class of the object and the PREFIX keyword will be used to
1807 trim the name to the word DESTROY as Perl will expect.
1808
1809      typedef struct netconfig Netconfig;
1810
1811      MODULE = RPC  PACKAGE = RPC
1812
1813      Netconfig *
1814      getnetconfigent(netid)
1815           char *netid
1816
1817      MODULE = RPC  PACKAGE = NetconfigPtr  PREFIX = rpcb_
1818
1819      void
1820      rpcb_DESTROY(netconf)
1821           Netconfig *netconf
1822         CODE:
1823           printf("Now in NetconfigPtr::DESTROY\n");
1824           free( netconf );
1825
1826 This example requires the following typemap entry.  Consult the typemap
1827 section for more information about adding new typemaps for an extension.
1828
1829      TYPEMAP
1830      Netconfig *  T_PTROBJ
1831
1832 This example will be used with the following Perl statements.
1833
1834      use RPC;
1835      $netconf = getnetconfigent("udp");
1836
1837 When Perl destroys the object referenced by $netconf it will send the
1838 object to the supplied XSUB DESTROY function.  Perl cannot determine, and
1839 does not care, that this object is a C struct and not a Perl object.  In
1840 this sense, there is no difference between the object created by the
1841 getnetconfigent() XSUB and an object created by a normal Perl subroutine.
1842
1843 =head2 The Typemap
1844
1845 The typemap is a collection of code fragments which are used by the B<xsubpp>
1846 compiler to map C function parameters and values to Perl values.  The
1847 typemap file may consist of three sections labelled C<TYPEMAP>, C<INPUT>, and
1848 C<OUTPUT>.  An unlabelled initial section is assumed to be a C<TYPEMAP>
1849 section.  The INPUT section tells
1850 the compiler how to translate Perl values
1851 into variables of certain C types.  The OUTPUT section tells the compiler
1852 how to translate the values from certain C types into values Perl can
1853 understand.  The TYPEMAP section tells the compiler which of the INPUT and
1854 OUTPUT code fragments should be used to map a given C type to a Perl value.
1855 The section labels C<TYPEMAP>, C<INPUT>, or C<OUTPUT> must begin
1856 in the first column on a line by themselves, and must be in uppercase.
1857
1858 The default typemap in the F<lib/ExtUtils> directory of the Perl source
1859 contains many useful types which can be used by Perl extensions.  Some
1860 extensions define additional typemaps which they keep in their own directory.
1861 These additional typemaps may reference INPUT and OUTPUT maps in the main
1862 typemap.  The B<xsubpp> compiler will allow the extension's own typemap to
1863 override any mappings which are in the default typemap.  Instead of using
1864 an additional F<typemap> file, typemaps may be embedded verbatim in XS
1865 with a heredoc-like syntax.  See the documentation on the C<TYPEMAP:> XS
1866 keyword.
1867
1868 Most extensions which require a custom typemap will need only the TYPEMAP
1869 section of the typemap file.  The custom typemap used in the
1870 getnetconfigent() example shown earlier demonstrates what may be the typical
1871 use of extension typemaps.  That typemap is used to equate a C structure
1872 with the T_PTROBJ typemap.  The typemap used by getnetconfigent() is shown
1873 here.  Note that the C type is separated from the XS type with a tab and
1874 that the C unary operator C<*> is considered to be a part of the C type name.
1875
1876         TYPEMAP
1877         Netconfig *<tab>T_PTROBJ
1878
1879 Here's a more complicated example: suppose that you wanted C<struct
1880 netconfig> to be blessed into the class C<Net::Config>.  One way to do
1881 this is to use underscores (_) to separate package names, as follows:
1882
1883         typedef struct netconfig * Net_Config;
1884
1885 And then provide a typemap entry C<T_PTROBJ_SPECIAL> that maps underscores to
1886 double-colons (::), and declare C<Net_Config> to be of that type:
1887
1888
1889         TYPEMAP
1890         Net_Config      T_PTROBJ_SPECIAL
1891
1892         INPUT
1893         T_PTROBJ_SPECIAL
1894                 if (sv_derived_from($arg, \"${(my $ntt=$ntype)=~s/_/::/g;\$ntt}\")) {
1895                         IV tmp = SvIV((SV*)SvRV($arg));
1896                         $var = INT2PTR($type, tmp);
1897                 }
1898                 else
1899                         croak(\"$var is not of type ${(my $ntt=$ntype)=~s/_/::/g;\$ntt}\")
1900
1901         OUTPUT
1902         T_PTROBJ_SPECIAL
1903                 sv_setref_pv($arg, \"${(my $ntt=$ntype)=~s/_/::/g;\$ntt}\",
1904                 (void*)$var);
1905
1906 The INPUT and OUTPUT sections substitute underscores for double-colons
1907 on the fly, giving the desired effect.  This example demonstrates some
1908 of the power and versatility of the typemap facility.
1909
1910 The INT2PTR macro (defined in perl.h) casts an integer to a pointer,
1911 of a given type, taking care of the possible different size of integers
1912 and pointers.  There are also PTR2IV, PTR2UV, PTR2NV macros,
1913 to map the other way, which may be useful in OUTPUT sections.
1914
1915 =head2 Safely Storing Static Data in XS
1916
1917 Starting with Perl 5.8, a macro framework has been defined to allow
1918 static data to be safely stored in XS modules that will be accessed from
1919 a multi-threaded Perl.
1920
1921 Although primarily designed for use with multi-threaded Perl, the macros
1922 have been designed so that they will work with non-threaded Perl as well.
1923
1924 It is therefore strongly recommended that these macros be used by all
1925 XS modules that make use of static data.
1926
1927 The easiest way to get a template set of macros to use is by specifying
1928 the C<-g> (C<--global>) option with h2xs (see L<h2xs>).
1929
1930 Below is an example module that makes use of the macros.
1931
1932     #include "EXTERN.h"
1933     #include "perl.h"
1934     #include "XSUB.h"
1935
1936     /* Global Data */
1937
1938     #define MY_CXT_KEY "BlindMice::_guts" XS_VERSION
1939
1940     typedef struct {
1941         int count;
1942         char name[3][100];
1943     } my_cxt_t;
1944
1945     START_MY_CXT
1946
1947     MODULE = BlindMice           PACKAGE = BlindMice
1948
1949     BOOT:
1950     {
1951         MY_CXT_INIT;
1952         MY_CXT.count = 0;
1953         strcpy(MY_CXT.name[0], "None");
1954         strcpy(MY_CXT.name[1], "None");
1955         strcpy(MY_CXT.name[2], "None");
1956     }
1957
1958     int
1959     newMouse(char * name)
1960         char * name;
1961         PREINIT:
1962           dMY_CXT;
1963         CODE:
1964           if (MY_CXT.count >= 3) {
1965               warn("Already have 3 blind mice");
1966               RETVAL = 0;
1967           }
1968           else {
1969               RETVAL = ++ MY_CXT.count;
1970               strcpy(MY_CXT.name[MY_CXT.count - 1], name);
1971           }
1972
1973     char *
1974     get_mouse_name(index)
1975       int index
1976       CODE:
1977         dMY_CXT;
1978         RETVAL = MY_CXT.lives ++;
1979         if (index > MY_CXT.count)
1980           croak("There are only 3 blind mice.");
1981         else
1982           RETVAL = newSVpv(MY_CXT.name[index - 1]);
1983
1984     void
1985     CLONE(...)
1986         CODE:
1987         MY_CXT_CLONE;
1988
1989 B<REFERENCE>
1990
1991 =over 5
1992
1993 =item MY_CXT_KEY
1994
1995 This macro is used to define a unique key to refer to the static data
1996 for an XS module. The suggested naming scheme, as used by h2xs, is to
1997 use a string that consists of the module name, the string "::_guts"
1998 and the module version number.
1999
2000     #define MY_CXT_KEY "MyModule::_guts" XS_VERSION
2001
2002 =item typedef my_cxt_t
2003
2004 This struct typedef I<must> always be called C<my_cxt_t>. The other
2005 C<CXT*> macros assume the existence of the C<my_cxt_t> typedef name.
2006
2007 Declare a typedef named C<my_cxt_t> that is a structure that contains
2008 all the data that needs to be interpreter-local.
2009
2010     typedef struct {
2011         int some_value;
2012     } my_cxt_t;
2013
2014 =item START_MY_CXT
2015
2016 Always place the START_MY_CXT macro directly after the declaration
2017 of C<my_cxt_t>.
2018
2019 =item MY_CXT_INIT
2020
2021 The MY_CXT_INIT macro initialises storage for the C<my_cxt_t> struct.
2022
2023 It I<must> be called exactly once, typically in a BOOT: section. If you
2024 are maintaining multiple interpreters, it should be called once in each
2025 interpreter instance, except for interpreters cloned from existing ones.
2026 (But see L</MY_CXT_CLONE> below.)
2027
2028 =item dMY_CXT
2029
2030 Use the dMY_CXT macro (a declaration) in all the functions that access
2031 MY_CXT.
2032
2033 =item MY_CXT
2034
2035 Use the MY_CXT macro to access members of the C<my_cxt_t> struct. For
2036 example, if C<my_cxt_t> is
2037
2038     typedef struct {
2039         int index;
2040     } my_cxt_t;
2041
2042 then use this to access the C<index> member
2043
2044     dMY_CXT;
2045     MY_CXT.index = 2;
2046
2047 =item aMY_CXT/pMY_CXT
2048
2049 C<dMY_CXT> may be quite expensive to calculate, and to avoid the overhead
2050 of invoking it in each function it is possible to pass the declaration
2051 onto other functions using the C<aMY_CXT>/C<pMY_CXT> macros, eg
2052
2053     void sub1() {
2054         dMY_CXT;
2055         MY_CXT.index = 1;
2056         sub2(aMY_CXT);
2057     }
2058
2059     void sub2(pMY_CXT) {
2060         MY_CXT.index = 2;
2061     }
2062
2063 Analogously to C<pTHX>, there are equivalent forms for when the macro is the
2064 first or last in multiple arguments, where an underscore represents a
2065 comma, i.e.  C<_aMY_CXT>, C<aMY_CXT_>, C<_pMY_CXT> and C<pMY_CXT_>.
2066
2067 =item MY_CXT_CLONE
2068
2069 By default, when a new interpreter is created as a copy of an existing one
2070 (eg via C<< threads->create() >>), both interpreters share the same physical
2071 my_cxt_t structure. Calling C<MY_CXT_CLONE> (typically via the package's
2072 C<CLONE()> function), causes a byte-for-byte copy of the structure to be
2073 taken, and any future dMY_CXT will cause the copy to be accessed instead.
2074
2075 =item MY_CXT_INIT_INTERP(my_perl)
2076
2077 =item dMY_CXT_INTERP(my_perl)
2078
2079 These are versions of the macros which take an explicit interpreter as an
2080 argument.
2081
2082 =back
2083
2084 Note that these macros will only work together within the I<same> source
2085 file; that is, a dMY_CTX in one source file will access a different structure
2086 than a dMY_CTX in another source file.
2087
2088 =head2 Thread-aware system interfaces
2089
2090 Starting from Perl 5.8, in C/C++ level Perl knows how to wrap
2091 system/library interfaces that have thread-aware versions
2092 (e.g. getpwent_r()) into frontend macros (e.g. getpwent()) that
2093 correctly handle the multithreaded interaction with the Perl
2094 interpreter.  This will happen transparently, the only thing
2095 you need to do is to instantiate a Perl interpreter.
2096
2097 This wrapping happens always when compiling Perl core source
2098 (PERL_CORE is defined) or the Perl core extensions (PERL_EXT is
2099 defined).  When compiling XS code outside of Perl core the wrapping
2100 does not take place.  Note, however, that intermixing the _r-forms
2101 (as Perl compiled for multithreaded operation will do) and the _r-less
2102 forms is neither well-defined (inconsistent results, data corruption,
2103 or even crashes become more likely), nor is it very portable.
2104
2105 =head1 EXAMPLES
2106
2107 File C<RPC.xs>: Interface to some ONC+ RPC bind library functions.
2108
2109      #include "EXTERN.h"
2110      #include "perl.h"
2111      #include "XSUB.h"
2112
2113      #include <rpc/rpc.h>
2114
2115      typedef struct netconfig Netconfig;
2116
2117      MODULE = RPC  PACKAGE = RPC
2118
2119      SV *
2120      rpcb_gettime(host="localhost")
2121           char *host
2122         PREINIT:
2123           time_t  timep;
2124         CODE:
2125           ST(0) = sv_newmortal();
2126           if( rpcb_gettime( host, &timep ) )
2127                sv_setnv( ST(0), (double)timep );
2128
2129      Netconfig *
2130      getnetconfigent(netid="udp")
2131           char *netid
2132
2133      MODULE = RPC  PACKAGE = NetconfigPtr  PREFIX = rpcb_
2134
2135      void
2136      rpcb_DESTROY(netconf)
2137           Netconfig *netconf
2138         CODE:
2139           printf("NetconfigPtr::DESTROY\n");
2140           free( netconf );
2141
2142 File C<typemap>: Custom typemap for RPC.xs.
2143
2144      TYPEMAP
2145      Netconfig *  T_PTROBJ
2146
2147 File C<RPC.pm>: Perl module for the RPC extension.
2148
2149      package RPC;
2150
2151      require Exporter;
2152      require DynaLoader;
2153      @ISA = qw(Exporter DynaLoader);
2154      @EXPORT = qw(rpcb_gettime getnetconfigent);
2155
2156      bootstrap RPC;
2157      1;
2158
2159 File C<rpctest.pl>: Perl test program for the RPC extension.
2160
2161      use RPC;
2162
2163      $netconf = getnetconfigent();
2164      $a = rpcb_gettime();
2165      print "time = $a\n";
2166      print "netconf = $netconf\n";
2167
2168      $netconf = getnetconfigent("tcp");
2169      $a = rpcb_gettime("poplar");
2170      print "time = $a\n";
2171      print "netconf = $netconf\n";
2172
2173
2174 =head1 XS VERSION
2175
2176 This document covers features supported by C<xsubpp> 1.935.
2177
2178 =head1 AUTHOR
2179
2180 Originally written by Dean Roehrich <F<roehrich@cray.com>>.
2181
2182 Maintained since 1996 by The Perl Porters <F<perlbug@perl.org>>.