pod/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 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 The MODULE Keyword
 280
 281 The MODULE keyword is used to start the XS code and to specify the package
 282 of the functions which are being defined.  All text preceding the first
 283 MODULE keyword is considered C code and is passed through to the output with
 284 POD stripped, but otherwise untouched.  Every XS module will have a
 285 bootstrap function which is used to hook the XSUBs into Perl.  The package
 286 name of this bootstrap function will match the value of the last MODULE
 287 statement in the XS source files.  The value of MODULE should always remain
 288 constant within the same XS file, though this is not required.
 289
 290 The following example will start the XS code and will place
 291 all functions in a package named RPC.
 292
 293      MODULE = RPC
 294
 295 =head2 The PACKAGE Keyword
 296
 297 When functions within an XS source file must be separated into packages
 298 the PACKAGE keyword should be used.  This keyword is used with the MODULE
 299 keyword and must follow immediately after it when used.
 300
 301      MODULE = RPC  PACKAGE = RPC
 302
 303      [ XS code in package RPC ]
 304
 305      MODULE = RPC  PACKAGE = RPCB
 306
 307      [ XS code in package RPCB ]
 308
 309      MODULE = RPC  PACKAGE = RPC
 310
 311      [ XS code in package RPC ]
 312
 313 Although this keyword is optional and in some cases provides redundant
 314 information it should always be used.  This keyword will ensure that the
 315 XSUBs appear in the desired package.
 316
 317 =head2 The PREFIX Keyword
 318
 319 The PREFIX keyword designates prefixes which should be
 320 removed from the Perl function names.  If the C function is
 321 C<rpcb_gettime()> and the PREFIX value is C<rpcb_> then Perl will
 322 see this function as C<gettime()>.
 323
 324 This keyword should follow the PACKAGE keyword when used.
 325 If PACKAGE is not used then PREFIX should follow the MODULE
 326 keyword.
 327
 328      MODULE = RPC  PREFIX = rpc_
 329
 330      MODULE = RPC  PACKAGE = RPCB  PREFIX = rpcb_
 331
 332 =head2 The OUTPUT: Keyword
 333
 334 The OUTPUT: keyword indicates that certain function parameters should be
 335 updated (new values made visible to Perl) when the XSUB terminates or that
 336 certain values should be returned to the calling Perl function.  For
 337 simple functions which have no CODE: or PPCODE: section,
 338 such as the sin() function above, the RETVAL variable is
 339 automatically designated as an output value.  For more complex functions
 340 the B<xsubpp> compiler will need help to determine which variables are output
 341 variables.
 342
 343 This keyword will normally be used to complement the CODE:  keyword.
 344 The RETVAL variable is not recognized as an output variable when the
 345 CODE: keyword is present.  The OUTPUT:  keyword is used in this
 346 situation to tell the compiler that RETVAL really is an output
 347 variable.
 348
 349 The OUTPUT: keyword can also be used to indicate that function parameters
 350 are output variables.  This may be necessary when a parameter has been
 351 modified within the function and the programmer would like the update to
 352 be seen by Perl.
 353
 354      bool_t
 355      rpcb_gettime(host,timep)
 356           char *host
 357           time_t &timep
 358         OUTPUT:
 359           timep
 360
 361 The OUTPUT: keyword will also allow an output parameter to
 362 be mapped to a matching piece of code rather than to a
 363 typemap.
 364
 365      bool_t
 366      rpcb_gettime(host,timep)
 367           char *host
 368           time_t &timep
 369         OUTPUT:
 370           timep sv_setnv(ST(1), (double)timep);
 371
 372 B<xsubpp> emits an automatic C<SvSETMAGIC()> for all parameters in the
 373 OUTPUT section of the XSUB, except RETVAL.  This is the usually desired
 374 behavior, as it takes care of properly invoking 'set' magic on output
 375 parameters (needed for hash or array element parameters that must be
 376 created if they didn't exist).  If for some reason, this behavior is
 377 not desired, the OUTPUT section may contain a C<SETMAGIC: DISABLE> line
 378 to disable it for the remainder of the parameters in the OUTPUT section.
 379 Likewise,  C<SETMAGIC: ENABLE> can be used to reenable it for the
 380 remainder of the OUTPUT section.  See L<perlguts> for more details
 381 about 'set' magic.
 382
 383 =head2 The NO_OUTPUT Keyword
 384
 385 The NO_OUTPUT can be placed as the first token of the XSUB.  This keyword
 386 indicates that while the C subroutine we provide an interface to has
 387 a non-C<void> return type, the return value of this C subroutine should not
 388 be returned from the generated Perl subroutine.
 389
 390 With this keyword present L<The RETVAL Variable> is created, and in the
 391 generated call to the subroutine this variable is assigned to, but the value
 392 of this variable is not going to be used in the auto-generated code.
 393
 394 This keyword makes sense only if C<RETVAL> is going to be accessed by the
 395 user-supplied code.  It is especially useful to make a function interface
 396 more Perl-like, especially when the C return value is just an error condition
 397 indicator.  For example,
 398
 399   NO_OUTPUT int
 400   delete_file(char *name)
 401     POST_CALL:
 402       if (RETVAL != 0)
 403           croak("Error %d while deleting file '%s'", RETVAL, name);
 404
 405 Here the generated XS function returns nothing on success, and will die()
 406 with a meaningful error message on error.
 407
 408 =head2 The CODE: Keyword
 409
 410 This keyword is used in more complicated XSUBs which require
 411 special handling for the C function.  The RETVAL variable is
 412 still declared, but it will not be returned unless it is specified
 413 in the OUTPUT: section.
 414
 415 The following XSUB is for a C function which requires special handling of
 416 its parameters.  The Perl usage is given first.
 417
 418      $status = rpcb_gettime( "localhost", $timep );
 419
 420 The XSUB follows.
 421
 422      bool_t
 423      rpcb_gettime(host,timep)
 424           char *host
 425           time_t timep
 426         CODE:
 427                RETVAL = rpcb_gettime( host, &timep );
 428         OUTPUT:
 429           timep
 430           RETVAL
 431
 432 =head2 The INIT: Keyword
 433
 434 The INIT: keyword allows initialization to be inserted into the XSUB before
 435 the compiler generates the call to the C function.  Unlike the CODE: keyword
 436 above, this keyword does not affect the way the compiler handles RETVAL.
 437
 438     bool_t
 439     rpcb_gettime(host,timep)
 440           char *host
 441           time_t &timep
 442         INIT:
 443           printf("# Host is %s\n", host );
 444         OUTPUT:
 445           timep
 446
 447 Another use for the INIT: section is to check for preconditions before
 448 making a call to the C function:
 449
 450     long long
 451     lldiv(a,b)
 452         long long a
 453         long long b
 454       INIT:
 455         if (a == 0 && b == 0)
 456             XSRETURN_UNDEF;
 457         if (b == 0)
 458             croak("lldiv: cannot divide by 0");
 459
 460 =head2 The NO_INIT Keyword
 461
 462 The NO_INIT keyword is used to indicate that a function
 463 parameter is being used only as an output value.  The B<xsubpp>
 464 compiler will normally generate code to read the values of
 465 all function parameters from the argument stack and assign
 466 them to C variables upon entry to the function.  NO_INIT
 467 will tell the compiler that some parameters will be used for
 468 output rather than for input and that they will be handled
 469 before the function terminates.
 470
 471 The following example shows a variation of the rpcb_gettime() function.
 472 This function uses the timep variable only as an output variable and does
 473 not care about its initial contents.
 474
 475      bool_t
 476      rpcb_gettime(host,timep)
 477           char *host
 478           time_t &timep = NO_INIT
 479         OUTPUT:
 480           timep
 481
 482 =head2 Initializing Function Parameters
 483
 484 C function parameters are normally initialized with their values from
 485 the argument stack (which in turn contains the parameters that were
 486 passed to the XSUB from Perl).  The typemaps contain the
 487 code segments which are used to translate the Perl values to
 488 the C parameters.  The programmer, however, is allowed to
 489 override the typemaps and supply alternate (or additional)
 490 initialization code.  Initialization code starts with the first
 491 C<=>, C<;> or C<+> on a line in the INPUT: section.  The only
 492 exception happens if this C<;> terminates the line, then this C<;>
 493 is quietly ignored.
 494
 495 The following code demonstrates how to supply initialization code for
 496 function parameters.  The initialization code is eval'd within double
 497 quotes by the compiler before it is added to the output so anything
 498 which should be interpreted literally [mainly C<$>, C<@>, or C<\\>]
 499 must be protected with backslashes.  The variables $var, $arg,
 500 and $type can be used as in typemaps.
 501
 502      bool_t
 503      rpcb_gettime(host,timep)
 504           char *host = (char *)SvPV($arg,PL_na);
 505           time_t &timep = 0;
 506         OUTPUT:
 507           timep
 508
 509 This should not be used to supply default values for parameters.  One
 510 would normally use this when a function parameter must be processed by
 511 another library function before it can be used.  Default parameters are
 512 covered in the next section.
 513
 514 If the initialization begins with C<=>, then it is output in
 515 the declaration for the input variable, replacing the initialization
 516 supplied by the typemap.  If the initialization
 517 begins with C<;> or C<+>, then it is performed after
 518 all of the input variables have been declared.  In the C<;>
 519 case the initialization normally supplied by the typemap is not performed.
 520 For the C<+> case, the declaration for the variable will include the
 521 initialization from the typemap.  A global
 522 variable, C<%v>, is available for the truly rare case where
 523 information from one initialization is needed in another
 524 initialization.
 525
 526 Here's a truly obscure example:
 527
 528      bool_t
 529      rpcb_gettime(host,timep)
 530           time_t &timep ; /* \$v{timep}=@{[$v{timep}=$arg]} */
 531           char *host + SvOK($v{timep}) ? SvPV($arg,PL_na) : NULL;
 532         OUTPUT:
 533           timep
 534
 535 The construct C<\$v{timep}=@{[$v{timep}=$arg]}> used in the above
 536 example has a two-fold purpose: first, when this line is processed by
 537 B<xsubpp>, the Perl snippet C<$v{timep}=$arg> is evaluated.  Second,
 538 the text of the evaluated snippet is output into the generated C file
 539 (inside a C comment)!  During the processing of C<char *host> line,
 540 $arg will evaluate to C<ST(0)>, and C<$v{timep}> will evaluate to
 541 C<ST(1)>.
 542
 543 =head2 Default Parameter Values
 544
 545 Default values for XSUB arguments can be specified by placing an
 546 assignment statement in the parameter list.  The default value may
 547 be a number, a string or the special string C<NO_INIT>.  Defaults should
 548 always be used on the right-most parameters only.
 549
 550 To allow the XSUB for rpcb_gettime() to have a default host
 551 value the parameters to the XSUB could be rearranged.  The
 552 XSUB will then call the real rpcb_gettime() function with
 553 the parameters in the correct order.  This XSUB can be called
 554 from Perl with either of the following statements:
 555
 556      $status = rpcb_gettime( $timep, $host );
 557
 558      $status = rpcb_gettime( $timep );
 559
 560 The XSUB will look like the code  which  follows.   A  CODE:
 561 block  is used to call the real rpcb_gettime() function with
 562 the parameters in the correct order for that function.
 563
 564      bool_t
 565      rpcb_gettime(timep,host="localhost")
 566           char *host
 567           time_t timep = NO_INIT
 568         CODE:
 569                RETVAL = rpcb_gettime( host, &timep );
 570         OUTPUT:
 571           timep
 572           RETVAL
 573
 574 =head2 The PREINIT: Keyword
 575
 576 The PREINIT: keyword allows extra variables to be declared immediately
 577 before or after the declarations of the parameters from the INPUT: section
 578 are emitted.
 579
 580 If a variable is declared inside a CODE: section it will follow any typemap
 581 code that is emitted for the input parameters.  This may result in the
 582 declaration ending up after C code, which is C syntax error.  Similar
 583 errors may happen with an explicit C<;>-type or C<+>-type initialization of
 584 parameters is used (see L<"Initializing Function Parameters">).  Declaring
 585 these variables in an INIT: section will not help.
 586
 587 In such cases, to force an additional variable to be declared together
 588 with declarations of other variables, place the declaration into a
 589 PREINIT: section.  The PREINIT: keyword may be used one or more times
 590 within an XSUB.
 591
 592 The following examples are equivalent, but if the code is using complex
 593 typemaps then the first example is safer.
 594
 595      bool_t
 596      rpcb_gettime(timep)
 597           time_t timep = NO_INIT
 598         PREINIT:
 599           char *host = "localhost";
 600         CODE:
 601           RETVAL = rpcb_gettime( host, &timep );
 602         OUTPUT:
 603           timep
 604           RETVAL
 605
 606 For this particular case an INIT: keyword would generate the
 607 same C code as the PREINIT: keyword.  Another correct, but error-prone example:
 608
 609      bool_t
 610      rpcb_gettime(timep)
 611           time_t timep = NO_INIT
 612         CODE:
 613           char *host = "localhost";
 614           RETVAL = rpcb_gettime( host, &timep );
 615         OUTPUT:
 616           timep
 617           RETVAL
 618
 619 Another way to declare C<host> is to use a C block in the CODE: section:
 620
 621      bool_t
 622      rpcb_gettime(timep)
 623           time_t timep = NO_INIT
 624         CODE:
 625           {
 626             char *host = "localhost";
 627             RETVAL = rpcb_gettime( host, &timep );
 628           }
 629         OUTPUT:
 630           timep
 631           RETVAL
 632
 633 The ability to put additional declarations before the typemap entries are
 634 processed is very handy in the cases when typemap conversions manipulate
 635 some global state:
 636
 637     MyObject
 638     mutate(o)
 639         PREINIT:
 640             MyState st = global_state;
 641         INPUT:
 642             MyObject o;
 643         CLEANUP:
 644             reset_to(global_state, st);
 645
 646 Here we suppose that conversion to C<MyObject> in the INPUT: section and from
 647 MyObject when processing RETVAL will modify a global variable C<global_state>.
 648 After these conversions are performed, we restore the old value of
 649 C<global_state> (to avoid memory leaks, for example).
 650
 651 There is another way to trade clarity for compactness: INPUT sections allow
 652 declaration of C variables which do not appear in the parameter list of
 653 a subroutine.  Thus the above code for mutate() can be rewritten as
 654
 655     MyObject
 656     mutate(o)
 657           MyState st = global_state;
 658           MyObject o;
 659         CLEANUP:
 660           reset_to(global_state, st);
 661
 662 and the code for rpcb_gettime() can be rewritten as
 663
 664      bool_t
 665      rpcb_gettime(timep)
 666           time_t timep = NO_INIT
 667           char *host = "localhost";
 668         C_ARGS:
 669           host, &timep
 670         OUTPUT:
 671           timep
 672           RETVAL
 673
 674 =head2 The SCOPE: Keyword
 675
 676 The SCOPE: keyword allows scoping to be enabled for a particular XSUB. If
 677 enabled, the XSUB will invoke ENTER and LEAVE automatically.
 678
 679 To support potentially complex type mappings, if a typemap entry used
 680 by an XSUB contains a comment like C</*scope*/> then scoping will
 681 be automatically enabled for that XSUB.
 682
 683 To enable scoping:
 684
 685     SCOPE: ENABLE
 686
 687 To disable scoping:
 688
 689     SCOPE: DISABLE
 690
 691 =head2 The INPUT: Keyword
 692
 693 The XSUB's parameters are usually evaluated immediately after entering the
 694 XSUB.  The INPUT: keyword can be used to force those parameters to be
 695 evaluated a little later.  The INPUT: keyword can be used multiple times
 696 within an XSUB and can be used to list one or more input variables.  This
 697 keyword is used with the PREINIT: keyword.
 698
 699 The following example shows how the input parameter C<timep> can be
 700 evaluated late, after a PREINIT.
 701
 702     bool_t
 703     rpcb_gettime(host,timep)
 704           char *host
 705         PREINIT:
 706           time_t tt;
 707         INPUT:
 708           time_t timep
 709         CODE:
 710                RETVAL = rpcb_gettime( host, &tt );
 711                timep = tt;
 712         OUTPUT:
 713           timep
 714           RETVAL
 715
 716 The next example shows each input parameter evaluated late.
 717
 718     bool_t
 719     rpcb_gettime(host,timep)
 720         PREINIT:
 721           time_t tt;
 722         INPUT:
 723           char *host
 724         PREINIT:
 725           char *h;
 726         INPUT:
 727           time_t timep
 728         CODE:
 729                h = host;
 730                RETVAL = rpcb_gettime( h, &tt );
 731                timep = tt;
 732         OUTPUT:
 733           timep
 734           RETVAL
 735
 736 Since INPUT sections allow declaration of C variables which do not appear
 737 in the parameter list of a subroutine, this may be shortened to:
 738
 739     bool_t
 740     rpcb_gettime(host,timep)
 741           time_t tt;
 742           char *host;
 743           char *h = host;
 744           time_t timep;
 745         CODE:
 746           RETVAL = rpcb_gettime( h, &tt );
 747           timep = tt;
 748         OUTPUT:
 749           timep
 750           RETVAL
 751
 752 (We used our knowledge that input conversion for C<char *> is a "simple" one,
 753 thus C<host> is initialized on the declaration line, and our assignment
 754 C<h = host> is not performed too early.  Otherwise one would need to have the
 755 assignment C<h = host> in a CODE: or INIT: section.)
 756
 757 =head2 The IN/OUTLIST/IN_OUTLIST/OUT/IN_OUT Keywords
 758
 759 In the list of parameters for an XSUB, one can precede parameter names
 760 by the C<IN>/C<OUTLIST>/C<IN_OUTLIST>/C<OUT>/C<IN_OUT> keywords.
 761 C<IN> keyword is the default, the other keywords indicate how the Perl
 762 interface should differ from the C interface.
 763
 764 Parameters preceded by C<OUTLIST>/C<IN_OUTLIST>/C<OUT>/C<IN_OUT>
 765 keywords are considered to be used by the C subroutine I<via
 766 pointers>.  C<OUTLIST>/C<OUT> keywords indicate that the C subroutine
 767 does not inspect the memory pointed by this parameter, but will write
 768 through this pointer to provide additional return values.
 769
 770 Parameters preceded by C<OUTLIST> keyword do not appear in the usage
 771 signature of the generated Perl function.
 772
 773 Parameters preceded by C<IN_OUTLIST>/C<IN_OUT>/C<OUT> I<do> appear as
 774 parameters to the Perl function.  With the exception of
 775 C<OUT>-parameters, these parameters are converted to the corresponding
 776 C type, then pointers to these data are given as arguments to the C
 777 function.  It is expected that the C function will write through these
 778 pointers.
 779
 780 The return list of the generated Perl function consists of the C return value
 781 from the function (unless the XSUB is of C<void> return type or
 782 C<The NO_OUTPUT Keyword> was used) followed by all the C<OUTLIST>
 783 and C<IN_OUTLIST> parameters (in the order of appearance).  On the
 784 return from the XSUB the C<IN_OUT>/C<OUT> Perl parameter will be
 785 modified to have the values written by the C function.
 786
 787 For example, an XSUB
 788
 789   void
 790   day_month(OUTLIST day, IN unix_time, OUTLIST month)
 791     int day
 792     int unix_time
 793     int month
 794
 795 should be used from Perl as
 796
 797   my ($day, $month) = day_month(time);
 798
 799 The C signature of the corresponding function should be
 800
 801   void day_month(int *day, int unix_time, int *month);
 802
 803 The C<IN>/C<OUTLIST>/C<IN_OUTLIST>/C<IN_OUT>/C<OUT> keywords can be
 804 mixed with ANSI-style declarations, as in
 805
 806   void
 807   day_month(OUTLIST int day, int unix_time, OUTLIST int month)
 808
 809 (here the optional C<IN> keyword is omitted).
 810
 811 The C<IN_OUT> parameters are identical with parameters introduced with
 812 L<The & Unary Operator> and put into the C<OUTPUT:> section (see
 813 L<The OUTPUT: Keyword>).  The C<IN_OUTLIST> parameters are very similar,
 814 the only difference being that the value C function writes through the
 815 pointer would not modify the Perl parameter, but is put in the output
 816 list.
 817
 818 The C<OUTLIST>/C<OUT> parameter differ from C<IN_OUTLIST>/C<IN_OUT>
 819 parameters only by the the initial value of the Perl parameter not
 820 being read (and not being given to the C function - which gets some
 821 garbage instead).  For example, the same C function as above can be
 822 interfaced with as
 823
 824   void day_month(OUT int day, int unix_time, OUT int month);
 825
 826 or
 827
 828   void
 829   day_month(day, unix_time, month)
 830       int &day = NO_INIT
 831       int  unix_time
 832       int &month = NO_INIT
 833     OUTPUT:
 834       day
 835       month
 836
 837 However, the generated Perl function is called in very C-ish style:
 838
 839   my ($day, $month);
 840   day_month($day, time, $month);
 841
 842 =head2 Variable-length Parameter Lists
 843
 844 XSUBs can have variable-length parameter lists by specifying an ellipsis
 845 C<(...)> in the parameter list.  This use of the ellipsis is similar to that
 846 found in ANSI C.  The programmer is able to determine the number of
 847 arguments passed to the XSUB by examining the C<items> variable which the
 848 B<xsubpp> compiler supplies for all XSUBs.  By using this mechanism one can
 849 create an XSUB which accepts a list of parameters of unknown length.
 850
 851 The I<host> parameter for the rpcb_gettime() XSUB can be
 852 optional so the ellipsis can be used to indicate that the
 853 XSUB will take a variable number of parameters.  Perl should
 854 be able to call this XSUB with either of the following statements.
 855
 856      $status = rpcb_gettime( $timep, $host );
 857
 858      $status = rpcb_gettime( $timep );
 859
 860 The XS code, with ellipsis, follows.
 861
 862      bool_t
 863      rpcb_gettime(timep, ...)
 864           time_t timep = NO_INIT
 865         PREINIT:
 866           char *host = "localhost";
 867           STRLEN n_a;
 868         CODE:
 869           if( items > 1 )
 870                host = (char *)SvPV(ST(1), n_a);
 871           RETVAL = rpcb_gettime( host, &timep );
 872         OUTPUT:
 873           timep
 874           RETVAL
 875
 876 =head2 The C_ARGS: Keyword
 877
 878 The C_ARGS: keyword allows creating of XSUBS which have different
 879 calling sequence from Perl than from C, without a need to write
 880 CODE: or PPCODE: section.  The contents of the C_ARGS: paragraph is
 881 put as the argument to the called C function without any change.
 882
 883 For example, suppose that a C function is declared as
 884
 885     symbolic nth_derivative(int n, symbolic function, int flags);
 886
 887 and that the default flags are kept in a global C variable
 888 C<default_flags>.  Suppose that you want to create an interface which
 889 is called as
 890
 891     $second_deriv = $function->nth_derivative(2);
 892
 893 To do this, declare the XSUB as
 894
 895     symbolic
 896     nth_derivative(function, n)
 897         symbolic        function
 898         int             n
 899       C_ARGS:
 900         n, function, default_flags
 901
 902 =head2 The PPCODE: Keyword
 903
 904 The PPCODE: keyword is an alternate form of the CODE: keyword and is used
 905 to tell the B<xsubpp> compiler that the programmer is supplying the code to
 906 control the argument stack for the XSUBs return values.  Occasionally one
 907 will want an XSUB to return a list of values rather than a single value.
 908 In these cases one must use PPCODE: and then explicitly push the list of
 909 values on the stack.  The PPCODE: and CODE:  keywords should not be used
 910 together within the same XSUB.
 911
 912 The actual difference between PPCODE: and CODE: sections is in the
 913 initialization of C<SP> macro (which stands for the I<current> Perl
 914 stack pointer), and in the handling of data on the stack when returning
 915 from an XSUB.  In CODE: sections SP preserves the value which was on
 916 entry to the XSUB: SP is on the function pointer (which follows the
 917 last parameter).  In PPCODE: sections SP is moved backward to the
 918 beginning of the parameter list, which allows C<PUSH*()> macros
 919 to place output values in the place Perl expects them to be when
 920 the XSUB returns back to Perl.
 921
 922 The generated trailer for a CODE: section ensures that the number of return
 923 values Perl will see is either 0 or 1 (depending on the C<void>ness of the
 924 return value of the C function, and heuristics mentioned in
 925 L<"The RETVAL Variable">).  The trailer generated for a PPCODE: section
 926 is based on the number of return values and on the number of times
 927 C<SP> was updated by C<[X]PUSH*()> macros.
 928
 929 Note that macros C<ST(i)>, C<XST_m*()> and C<XSRETURN*()> work equally
 930 well in CODE: sections and PPCODE: sections.
 931
 932 The following XSUB will call the C rpcb_gettime() function
 933 and will return its two output values, timep and status, to
 934 Perl as a single list.
 935
 936      void
 937      rpcb_gettime(host)
 938           char *host
 939         PREINIT:
 940           time_t  timep;
 941           bool_t  status;
 942         PPCODE:
 943           status = rpcb_gettime( host, &timep );
 944           EXTEND(SP, 2);
 945           PUSHs(sv_2mortal(newSViv(status)));
 946           PUSHs(sv_2mortal(newSViv(timep)));
 947
 948 Notice that the programmer must supply the C code necessary
 949 to have the real rpcb_gettime() function called and to have
 950 the return values properly placed on the argument stack.
 951
 952 The C<void> return type for this function tells the B<xsubpp> compiler that
 953 the RETVAL variable is not needed or used and that it should not be created.
 954 In most scenarios the void return type should be used with the PPCODE:
 955 directive.
 956
 957 The EXTEND() macro is used to make room on the argument
 958 stack for 2 return values.  The PPCODE: directive causes the
 959 B<xsubpp> compiler to create a stack pointer available as C<SP>, and it
 960 is this pointer which is being used in the EXTEND() macro.
 961 The values are then pushed onto the stack with the PUSHs()
 962 macro.
 963
 964 Now the rpcb_gettime() function can be used from Perl with
 965 the following statement.
 966
 967      ($status, $timep) = rpcb_gettime("localhost");
 968
 969 When handling output parameters with a PPCODE section, be sure to handle
 970 'set' magic properly.  See L<perlguts> for details about 'set' magic.
 971
 972 =head2 Returning Undef And Empty Lists
 973
 974 Occasionally the programmer will want to return simply
 975 C<undef> or an empty list if a function fails rather than a
 976 separate status value.  The rpcb_gettime() function offers
 977 just this situation.  If the function succeeds we would like
 978 to have it return the time and if it fails we would like to
 979 have undef returned.  In the following Perl code the value
 980 of $timep will either be undef or it will be a valid time.
 981
 982      $timep = rpcb_gettime( "localhost" );
 983
 984 The following XSUB uses the C<SV *> return type as a mnemonic only,
 985 and uses a CODE: block to indicate to the compiler
 986 that the programmer has supplied all the necessary code.  The
 987 sv_newmortal() call will initialize the return value to undef, making that
 988 the default return value.
 989
 990      SV *
 991      rpcb_gettime(host)
 992           char *  host
 993         PREINIT:
 994           time_t  timep;
 995           bool_t x;
 996         CODE:
 997           ST(0) = sv_newmortal();
 998           if( rpcb_gettime( host, &timep ) )
 999                sv_setnv( ST(0), (double)timep);
1000
1001 The next example demonstrates how one would place an explicit undef in the
1002 return value, should the need arise.
1003
1004      SV *
1005      rpcb_gettime(host)
1006           char *  host
1007         PREINIT:
1008           time_t  timep;
1009           bool_t x;
1010         CODE:
1011           ST(0) = sv_newmortal();
1012           if( rpcb_gettime( host, &timep ) ){
1013                sv_setnv( ST(0), (double)timep);
1014           }
1015           else{
1016                ST(0) = &PL_sv_undef;
1017           }
1018
1019 To return an empty list one must use a PPCODE: block and
1020 then not push return values on the stack.
1021
1022      void
1023      rpcb_gettime(host)
1024           char *host
1025         PREINIT:
1026           time_t  timep;
1027         PPCODE:
1028           if( rpcb_gettime( host, &timep ) )
1029                PUSHs(sv_2mortal(newSViv(timep)));
1030           else{
1031               /* Nothing pushed on stack, so an empty
1032                * list is implicitly returned. */
1033           }
1034
1035 Some people may be inclined to include an explicit C<return> in the above
1036 XSUB, rather than letting control fall through to the end.  In those
1037 situations C<XSRETURN_EMPTY> should be used, instead.  This will ensure that
1038 the XSUB stack is properly adjusted.  Consult L<perlguts/"API LISTING"> for
1039 other C<XSRETURN> macros.
1040
1041 Since C<XSRETURN_*> macros can be used with CODE blocks as well, one can
1042 rewrite this example as:
1043
1044      int
1045      rpcb_gettime(host)
1046           char *host
1047         PREINIT:
1048           time_t  timep;
1049         CODE:
1050           RETVAL = rpcb_gettime( host, &timep );
1051           if (RETVAL == 0)
1052                 XSRETURN_UNDEF;
1053         OUTPUT:
1054           RETVAL
1055
1056 In fact, one can put this check into a POST_CALL: section as well.  Together
1057 with PREINIT: simplifications, this leads to:
1058
1059      int
1060      rpcb_gettime(host)
1061           char *host
1062           time_t  timep;
1063         POST_CALL:
1064           if (RETVAL == 0)
1065                 XSRETURN_UNDEF;
1066
1067 =head2 The REQUIRE: Keyword
1068
1069 The REQUIRE: keyword is used to indicate the minimum version of the
1070 B<xsubpp> compiler needed to compile the XS module.  An XS module which
1071 contains the following statement will compile with only B<xsubpp> version
1072 1.922 or greater:
1073
1074         REQUIRE: 1.922
1075
1076 =head2 The CLEANUP: Keyword
1077
1078 This keyword can be used when an XSUB requires special cleanup procedures
1079 before it terminates.  When the CLEANUP:  keyword is used it must follow
1080 any CODE:, PPCODE:, or OUTPUT: blocks which are present in the XSUB.  The
1081 code specified for the cleanup block will be added as the last statements
1082 in the XSUB.
1083
1084 =head2 The POST_CALL: Keyword
1085
1086 This keyword can be used when an XSUB requires special procedures
1087 executed after the C subroutine call is performed.  When the POST_CALL:
1088 keyword is used it must precede OUTPUT: and CLEANUP: blocks which are
1089 present in the XSUB.
1090
1091 The POST_CALL: block does not make a lot of sense when the C subroutine
1092 call is supplied by user by providing either CODE: or PPCODE: section.
1093
1094 =head2 The BOOT: Keyword
1095
1096 The BOOT: keyword is used to add code to the extension's bootstrap
1097 function.  The bootstrap function is generated by the B<xsubpp> compiler and
1098 normally holds the statements necessary to register any XSUBs with Perl.
1099 With the BOOT: keyword the programmer can tell the compiler to add extra
1100 statements to the bootstrap function.
1101
1102 This keyword may be used any time after the first MODULE keyword and should
1103 appear on a line by itself.  The first blank line after the keyword will
1104 terminate the code block.
1105
1106      BOOT:
1107      # The following message will be printed when the
1108      # bootstrap function executes.
1109      printf("Hello from the bootstrap!\n");
1110
1111 =head2 The VERSIONCHECK: Keyword
1112
1113 The VERSIONCHECK: keyword corresponds to B<xsubpp>'s C<-versioncheck> and
1114 C<-noversioncheck> options.  This keyword overrides the command line
1115 options.  Version checking is enabled by default.  When version checking is
1116 enabled the XS module will attempt to verify that its version matches the
1117 version of the PM module.
1118
1119 To enable version checking:
1120
1121     VERSIONCHECK: ENABLE
1122
1123 To disable version checking:
1124
1125     VERSIONCHECK: DISABLE
1126
1127 =head2 The PROTOTYPES: Keyword
1128
1129 The PROTOTYPES: keyword corresponds to B<xsubpp>'s C<-prototypes> and
1130 C<-noprototypes> options.  This keyword overrides the command line options.
1131 Prototypes are enabled by default.  When prototypes are enabled XSUBs will
1132 be given Perl prototypes.  This keyword may be used multiple times in an XS
1133 module to enable and disable prototypes for different parts of the module.
1134
1135 To enable prototypes:
1136
1137     PROTOTYPES: ENABLE
1138
1139 To disable prototypes:
1140
1141     PROTOTYPES: DISABLE
1142
1143 =head2 The PROTOTYPE: Keyword
1144
1145 This keyword is similar to the PROTOTYPES: keyword above but can be used to
1146 force B<xsubpp> to use a specific prototype for the XSUB.  This keyword
1147 overrides all other prototype options and keywords but affects only the
1148 current XSUB.  Consult L<perlsub/Prototypes> for information about Perl
1149 prototypes.
1150
1151     bool_t
1152     rpcb_gettime(timep, ...)
1153           time_t timep = NO_INIT
1154         PROTOTYPE: $;$
1155         PREINIT:
1156           char *host = "localhost";
1157           STRLEN n_a;
1158         CODE:
1159                   if( items > 1 )
1160                        host = (char *)SvPV(ST(1), n_a);
1161                   RETVAL = rpcb_gettime( host, &timep );
1162         OUTPUT:
1163           timep
1164           RETVAL
1165
1166 =head2 The ALIAS: Keyword
1167
1168 The ALIAS: keyword allows an XSUB to have two or more unique Perl names
1169 and to know which of those names was used when it was invoked.  The Perl
1170 names may be fully-qualified with package names.  Each alias is given an
1171 index.  The compiler will setup a variable called C<ix> which contain the
1172 index of the alias which was used.  When the XSUB is called with its
1173 declared name C<ix> will be 0.
1174
1175 The following example will create aliases C<FOO::gettime()> and
1176 C<BAR::getit()> for this function.
1177
1178     bool_t
1179     rpcb_gettime(host,timep)
1180           char *host
1181           time_t &timep
1182         ALIAS:
1183             FOO::gettime = 1
1184             BAR::getit = 2
1185         INIT:
1186           printf("# ix = %d\n", ix );
1187         OUTPUT:
1188           timep
1189
1190 =head2 The INTERFACE: Keyword
1191
1192 This keyword declares the current XSUB as a keeper of the given
1193 calling signature.  If some text follows this keyword, it is
1194 considered as a list of functions which have this signature, and
1195 should be attached to the current XSUB.
1196
1197 For example, if you have 4 C functions multiply(), divide(), add(),
1198 subtract() all having the signature:
1199
1200     symbolic f(symbolic, symbolic);
1201
1202 you can make them all to use the same XSUB using this:
1203
1204     symbolic
1205     interface_s_ss(arg1, arg2)
1206         symbolic        arg1
1207         symbolic        arg2
1208     INTERFACE:
1209         multiply divide
1210         add subtract
1211
1212 (This is the complete XSUB code for 4 Perl functions!)  Four generated
1213 Perl function share names with corresponding C functions.
1214
1215 The advantage of this approach comparing to ALIAS: keyword is that there
1216 is no need to code a switch statement, each Perl function (which shares
1217 the same XSUB) knows which C function it should call.  Additionally, one
1218 can attach an extra function remainder() at runtime by using
1219
1220     CV *mycv = newXSproto("Symbolic::remainder",
1221                           XS_Symbolic_interface_s_ss, __FILE__, "$$");
1222     XSINTERFACE_FUNC_SET(mycv, remainder);
1223
1224 say, from another XSUB.  (This example supposes that there was no
1225 INTERFACE_MACRO: section, otherwise one needs to use something else instead of
1226 C<XSINTERFACE_FUNC_SET>, see the next section.)
1227
1228 =head2 The INTERFACE_MACRO: Keyword
1229
1230 This keyword allows one to define an INTERFACE using a different way
1231 to extract a function pointer from an XSUB.  The text which follows
1232 this keyword should give the name of macros which would extract/set a
1233 function pointer.  The extractor macro is given return type, C<CV*>,
1234 and C<XSANY.any_dptr> for this C<CV*>.  The setter macro is given cv,
1235 and the function pointer.
1236
1237 The default value is C<XSINTERFACE_FUNC> and C<XSINTERFACE_FUNC_SET>.
1238 An INTERFACE keyword with an empty list of functions can be omitted if
1239 INTERFACE_MACRO keyword is used.
1240
1241 Suppose that in the previous example functions pointers for
1242 multiply(), divide(), add(), subtract() are kept in a global C array
1243 C<fp[]> with offsets being C<multiply_off>, C<divide_off>, C<add_off>,
1244 C<subtract_off>.  Then one can use
1245
1246     #define XSINTERFACE_FUNC_BYOFFSET(ret,cv,f) \
1247         ((XSINTERFACE_CVT(ret,))fp[CvXSUBANY(cv).any_i32])
1248     #define XSINTERFACE_FUNC_BYOFFSET_set(cv,f) \
1249         CvXSUBANY(cv).any_i32 = CAT2( f, _off )
1250
1251 in C section,
1252
1253     symbolic
1254     interface_s_ss(arg1, arg2)
1255         symbolic        arg1
1256         symbolic        arg2
1257       INTERFACE_MACRO:
1258         XSINTERFACE_FUNC_BYOFFSET
1259         XSINTERFACE_FUNC_BYOFFSET_set
1260       INTERFACE:
1261         multiply divide
1262         add subtract
1263
1264 in XSUB section.
1265
1266 =head2 The INCLUDE: Keyword
1267
1268 This keyword can be used to pull other files into the XS module.  The other
1269 files may have XS code.  INCLUDE: can also be used to run a command to
1270 generate the XS code to be pulled into the module.
1271
1272 The file F<Rpcb1.xsh> contains our C<rpcb_gettime()> function:
1273
1274     bool_t
1275     rpcb_gettime(host,timep)
1276           char *host
1277           time_t &timep
1278         OUTPUT:
1279           timep
1280
1281 The XS module can use INCLUDE: to pull that file into it.
1282
1283     INCLUDE: Rpcb1.xsh
1284
1285 If the parameters to the INCLUDE: keyword are followed by a pipe (C<|>) then
1286 the compiler will interpret the parameters as a command.
1287
1288     INCLUDE: cat Rpcb1.xsh |
1289
1290 =head2 The CASE: Keyword
1291
1292 The CASE: keyword allows an XSUB to have multiple distinct parts with each
1293 part acting as a virtual XSUB.  CASE: is greedy and if it is used then all
1294 other XS keywords must be contained within a CASE:.  This means nothing may
1295 precede the first CASE: in the XSUB and anything following the last CASE: is
1296 included in that case.
1297
1298 A CASE: might switch via a parameter of the XSUB, via the C<ix> ALIAS:
1299 variable (see L<"The ALIAS: Keyword">), or maybe via the C<items> variable
1300 (see L<"Variable-length Parameter Lists">).  The last CASE: becomes the
1301 B<default> case if it is not associated with a conditional.  The following
1302 example shows CASE switched via C<ix> with a function C<rpcb_gettime()>
1303 having an alias C<x_gettime()>.  When the function is called as
1304 C<rpcb_gettime()> its parameters are the usual C<(char *host, time_t *timep)>,
1305 but when the function is called as C<x_gettime()> its parameters are
1306 reversed, C<(time_t *timep, char *host)>.
1307
1308     long
1309     rpcb_gettime(a,b)
1310       CASE: ix == 1
1311         ALIAS:
1312           x_gettime = 1
1313         INPUT:
1314           # 'a' is timep, 'b' is host
1315           char *b
1316           time_t a = NO_INIT
1317         CODE:
1318                RETVAL = rpcb_gettime( b, &a );
1319         OUTPUT:
1320           a
1321           RETVAL
1322       CASE:
1323           # 'a' is host, 'b' is timep
1324           char *a
1325           time_t &b = NO_INIT
1326         OUTPUT:
1327           b
1328           RETVAL
1329
1330 That function can be called with either of the following statements.  Note
1331 the different argument lists.
1332
1333         $status = rpcb_gettime( $host, $timep );
1334
1335         $status = x_gettime( $timep, $host );
1336
1337 =head2 The & Unary Operator
1338
1339 The C<&> unary operator in the INPUT: section is used to tell B<xsubpp>
1340 that it should convert a Perl value to/from C using the C type to the left
1341 of C<&>, but provide a pointer to this value when the C function is called.
1342
1343 This is useful to avoid a CODE: block for a C function which takes a parameter
1344 by reference.  Typically, the parameter should be not a pointer type (an
1345 C<int> or C<long> but not a C<int*> or C<long*>).
1346
1347 The following XSUB will generate incorrect C code.  The B<xsubpp> compiler will
1348 turn this into code which calls C<rpcb_gettime()> with parameters C<(char
1349 *host, time_t timep)>, but the real C<rpcb_gettime()> wants the C<timep>
1350 parameter to be of type C<time_t*> rather than C<time_t>.
1351
1352     bool_t
1353     rpcb_gettime(host,timep)
1354           char *host
1355           time_t timep
1356         OUTPUT:
1357           timep
1358
1359 That problem is corrected by using the C<&> operator.  The B<xsubpp> compiler
1360 will now turn this into code which calls C<rpcb_gettime()> correctly with
1361 parameters C<(char *host, time_t *timep)>.  It does this by carrying the
1362 C<&> through, so the function call looks like C<rpcb_gettime(host, &timep)>.
1363
1364     bool_t
1365     rpcb_gettime(host,timep)
1366           char *host
1367           time_t &timep
1368         OUTPUT:
1369           timep
1370
1371 =head2 Inserting POD, Comments and C Preprocessor Directives
1372
1373 C preprocessor directives are allowed within BOOT:, PREINIT: INIT:, CODE:,
1374 PPCODE:, POST_CALL:, and CLEANUP: blocks, as well as outside the functions.
1375 Comments are allowed anywhere after the MODULE keyword.  The compiler will
1376 pass the preprocessor directives through untouched and will remove the
1377 commented lines. POD documentation is allowed at any point, both in the
1378 C and XS language sections. POD must be terminated with a C<=cut> command;
1379 C<xsubpp> will exit with an error if it does not. It is very unlikely that
1380 human generated C code will be mistaken for POD, as most indenting styles
1381 result in whitespace in front of any line starting with C<=>. Machine
1382 generated XS files may fall into this trap unless care is taken to
1383 ensure that a space breaks the sequence "\n=".
1384
1385 Comments can be added to XSUBs by placing a C<#> as the first
1386 non-whitespace of a line.  Care should be taken to avoid making the
1387 comment look like a C preprocessor directive, lest it be interpreted as
1388 such.  The simplest way to prevent this is to put whitespace in front of
1389 the C<#>.
1390
1391 If you use preprocessor directives to choose one of two
1392 versions of a function, use
1393
1394     #if ... version1
1395     #else /* ... version2  */
1396     #endif
1397
1398 and not
1399
1400     #if ... version1
1401     #endif
1402     #if ... version2
1403     #endif
1404
1405 because otherwise B<xsubpp> will believe that you made a duplicate
1406 definition of the function.  Also, put a blank line before the
1407 #else/#endif so it will not be seen as part of the function body.
1408
1409 =head2 Using XS With C++
1410
1411 If an XSUB name contains C<::>, it is considered to be a C++ method.
1412 The generated Perl function will assume that
1413 its first argument is an object pointer.  The object pointer
1414 will be stored in a variable called THIS.  The object should
1415 have been created by C++ with the new() function and should
1416 be blessed by Perl with the sv_setref_pv() macro.  The
1417 blessing of the object by Perl can be handled by a typemap.  An example
1418 typemap is shown at the end of this section.
1419
1420 If the return type of the XSUB includes C<static>, the method is considered
1421 to be a static method.  It will call the C++
1422 function using the class::method() syntax.  If the method is not static
1423 the function will be called using the THIS-E<gt>method() syntax.
1424
1425 The next examples will use the following C++ class.
1426
1427      class color {
1428           public:
1429           color();
1430           ~color();
1431           int blue();
1432           void set_blue( int );
1433
1434           private:
1435           int c_blue;
1436      };
1437
1438 The XSUBs for the blue() and set_blue() methods are defined with the class
1439 name but the parameter for the object (THIS, or "self") is implicit and is
1440 not listed.
1441
1442      int
1443      color::blue()
1444
1445      void
1446      color::set_blue( val )
1447           int val
1448
1449 Both Perl functions will expect an object as the first parameter.  In the
1450 generated C++ code the object is called C<THIS>, and the method call will
1451 be performed on this object.  So in the C++ code the blue() and set_blue()
1452 methods will be called as this:
1453
1454      RETVAL = THIS->blue();
1455
1456      THIS->set_blue( val );
1457
1458 You could also write a single get/set method using an optional argument:
1459
1460      int
1461      color::blue( val = NO_INIT )
1462          int val
1463          PROTOTYPE $;$
1464          CODE:
1465              if (items > 1)
1466                  THIS->set_blue( val );
1467              RETVAL = THIS->blue();
1468          OUTPUT:
1469              RETVAL
1470
1471 If the function's name is B<DESTROY> then the C++ C<delete> function will be
1472 called and C<THIS> will be given as its parameter.  The generated C++ code for
1473
1474      void
1475      color::DESTROY()
1476
1477 will look like this:
1478
1479      color *THIS = ...; // Initialized as in typemap
1480
1481      delete THIS;
1482
1483 If the function's name is B<new> then the C++ C<new> function will be called
1484 to create a dynamic C++ object.  The XSUB will expect the class name, which
1485 will be kept in a variable called C<CLASS>, to be given as the first
1486 argument.
1487
1488      color *
1489      color::new()
1490
1491 The generated C++ code will call C<new>.
1492
1493      RETVAL = new color();
1494
1495 The following is an example of a typemap that could be used for this C++
1496 example.
1497
1498     TYPEMAP
1499     color *             O_OBJECT
1500
1501     OUTPUT
1502     # The Perl object is blessed into 'CLASS', which should be a
1503     # char* having the name of the package for the blessing.
1504     O_OBJECT
1505         sv_setref_pv( $arg, CLASS, (void*)$var );
1506
1507     INPUT
1508     O_OBJECT
1509         if( sv_isobject($arg) && (SvTYPE(SvRV($arg)) == SVt_PVMG) )
1510                 $var = ($type)SvIV((SV*)SvRV( $arg ));
1511         else{
1512                 warn( \"${Package}::$func_name() -- $var is not a blessed SV reference\" );
1513                 XSRETURN_UNDEF;
1514         }
1515
1516 =head2 Interface Strategy
1517
1518 When designing an interface between Perl and a C library a straight
1519 translation from C to XS (such as created by C<h2xs -x>) is often sufficient.
1520 However, sometimes the interface will look
1521 very C-like and occasionally nonintuitive, especially when the C function
1522 modifies one of its parameters, or returns failure inband (as in "negative
1523 return values mean failure").  In cases where the programmer wishes to
1524 create a more Perl-like interface the following strategy may help to
1525 identify the more critical parts of the interface.
1526
1527 Identify the C functions with input/output or output parameters.  The XSUBs for
1528 these functions may be able to return lists to Perl.
1529
1530 Identify the C functions which use some inband info as an indication
1531 of failure.  They may be
1532 candidates to return undef or an empty list in case of failure.  If the
1533 failure may be detected without a call to the C function, you may want to use
1534 an INIT: section to report the failure.  For failures detectable after the C
1535 function returns one may want to use a POST_CALL: section to process the
1536 failure.  In more complicated cases use CODE: or PPCODE: sections.
1537
1538 If many functions use the same failure indication based on the return value,
1539 you may want to create a special typedef to handle this situation.  Put
1540
1541   typedef int negative_is_failure;
1542
1543 near the beginning of XS file, and create an OUTPUT typemap entry
1544 for C<negative_is_failure> which converts negative values to C<undef>, or
1545 maybe croak()s.  After this the return value of type C<negative_is_failure>
1546 will create more Perl-like interface.
1547
1548 Identify which values are used by only the C and XSUB functions
1549 themselves, say, when a parameter to a function should be a contents of a
1550 global variable.  If Perl does not need to access the contents of the value
1551 then it may not be necessary to provide a translation for that value
1552 from C to Perl.
1553
1554 Identify the pointers in the C function parameter lists and return
1555 values.  Some pointers may be used to implement input/output or
1556 output parameters, they can be handled in XS with the C<&> unary operator,
1557 and, possibly, using the NO_INIT keyword.
1558 Some others will require handling of types like C<int *>, and one needs
1559 to decide what a useful Perl translation will do in such a case.  When
1560 the semantic is clear, it is advisable to put the translation into a typemap
1561 file.
1562
1563 Identify the structures used by the C functions.  In many
1564 cases it may be helpful to use the T_PTROBJ typemap for
1565 these structures so they can be manipulated by Perl as
1566 blessed objects.  (This is handled automatically by C<h2xs -x>.)
1567
1568 If the same C type is used in several different contexts which require
1569 different translations, C<typedef> several new types mapped to this C type,
1570 and create separate F<typemap> entries for these new types.  Use these
1571 types in declarations of return type and parameters to XSUBs.
1572
1573 =head2 Perl Objects And C Structures
1574
1575 When dealing with C structures one should select either
1576 B<T_PTROBJ> or B<T_PTRREF> for the XS type.  Both types are
1577 designed to handle pointers to complex objects.  The
1578 T_PTRREF type will allow the Perl object to be unblessed
1579 while the T_PTROBJ type requires that the object be blessed.
1580 By using T_PTROBJ one can achieve a form of type-checking
1581 because the XSUB will attempt to verify that the Perl object
1582 is of the expected type.
1583
1584 The following XS code shows the getnetconfigent() function which is used
1585 with ONC+ TIRPC.  The getnetconfigent() function will return a pointer to a
1586 C structure and has the C prototype shown below.  The example will
1587 demonstrate how the C pointer will become a Perl reference.  Perl will
1588 consider this reference to be a pointer to a blessed object and will
1589 attempt to call a destructor for the object.  A destructor will be
1590 provided in the XS source to free the memory used by getnetconfigent().
1591 Destructors in XS can be created by specifying an XSUB function whose name
1592 ends with the word B<DESTROY>.  XS destructors can be used to free memory
1593 which may have been malloc'd by another XSUB.
1594
1595      struct netconfig *getnetconfigent(const char *netid);
1596
1597 A C<typedef> will be created for C<struct netconfig>.  The Perl
1598 object will be blessed in a class matching the name of the C
1599 type, with the tag C<Ptr> appended, and the name should not
1600 have embedded spaces if it will be a Perl package name.  The
1601 destructor will be placed in a class corresponding to the
1602 class of the object and the PREFIX keyword will be used to
1603 trim the name to the word DESTROY as Perl will expect.
1604
1605      typedef struct netconfig Netconfig;
1606
1607      MODULE = RPC  PACKAGE = RPC
1608
1609      Netconfig *
1610      getnetconfigent(netid)
1611           char *netid
1612
1613      MODULE = RPC  PACKAGE = NetconfigPtr  PREFIX = rpcb_
1614
1615      void
1616      rpcb_DESTROY(netconf)
1617           Netconfig *netconf
1618         CODE:
1619           printf("Now in NetconfigPtr::DESTROY\n");
1620           free( netconf );
1621
1622 This example requires the following typemap entry.  Consult the typemap
1623 section for more information about adding new typemaps for an extension.
1624
1625      TYPEMAP
1626      Netconfig *  T_PTROBJ
1627
1628 This example will be used with the following Perl statements.
1629
1630      use RPC;
1631      $netconf = getnetconfigent("udp");
1632
1633 When Perl destroys the object referenced by $netconf it will send the
1634 object to the supplied XSUB DESTROY function.  Perl cannot determine, and
1635 does not care, that this object is a C struct and not a Perl object.  In
1636 this sense, there is no difference between the object created by the
1637 getnetconfigent() XSUB and an object created by a normal Perl subroutine.
1638
1639 =head2 The Typemap
1640
1641 The typemap is a collection of code fragments which are used by the B<xsubpp>
1642 compiler to map C function parameters and values to Perl values.  The
1643 typemap file may consist of three sections labelled C<TYPEMAP>, C<INPUT>, and
1644 C<OUTPUT>.  An unlabelled initial section is assumed to be a C<TYPEMAP>
1645 section.  The INPUT section tells
1646 the compiler how to translate Perl values
1647 into variables of certain C types.  The OUTPUT section tells the compiler
1648 how to translate the values from certain C types into values Perl can
1649 understand.  The TYPEMAP section tells the compiler which of the INPUT and
1650 OUTPUT code fragments should be used to map a given C type to a Perl value.
1651 The section labels C<TYPEMAP>, C<INPUT>, or C<OUTPUT> must begin
1652 in the first column on a line by themselves, and must be in uppercase.
1653
1654 The default typemap in the C<lib/ExtUtils> directory of the Perl source
1655 contains many useful types which can be used by Perl extensions.  Some
1656 extensions define additional typemaps which they keep in their own directory.
1657 These additional typemaps may reference INPUT and OUTPUT maps in the main
1658 typemap.  The B<xsubpp> compiler will allow the extension's own typemap to
1659 override any mappings which are in the default typemap.
1660
1661 Most extensions which require a custom typemap will need only the TYPEMAP
1662 section of the typemap file.  The custom typemap used in the
1663 getnetconfigent() example shown earlier demonstrates what may be the typical
1664 use of extension typemaps.  That typemap is used to equate a C structure
1665 with the T_PTROBJ typemap.  The typemap used by getnetconfigent() is shown
1666 here.  Note that the C type is separated from the XS type with a tab and
1667 that the C unary operator C<*> is considered to be a part of the C type name.
1668
1669         TYPEMAP
1670         Netconfig *<tab>T_PTROBJ
1671
1672 Here's a more complicated example: suppose that you wanted C<struct
1673 netconfig> to be blessed into the class C<Net::Config>.  One way to do
1674 this is to use underscores (_) to separate package names, as follows:
1675
1676         typedef struct netconfig * Net_Config;
1677
1678 And then provide a typemap entry C<T_PTROBJ_SPECIAL> that maps underscores to
1679 double-colons (::), and declare C<Net_Config> to be of that type:
1680
1681
1682         TYPEMAP
1683         Net_Config      T_PTROBJ_SPECIAL
1684
1685         INPUT
1686         T_PTROBJ_SPECIAL
1687                 if (sv_derived_from($arg, \"${(my $ntt=$ntype)=~s/_/::/g;\$ntt}\")) {
1688                         IV tmp = SvIV((SV*)SvRV($arg));
1689                 $var = ($type) tmp;
1690                 }
1691                 else
1692                         croak(\"$var is not of type ${(my $ntt=$ntype)=~s/_/::/g;\$ntt}\")
1693
1694         OUTPUT
1695         T_PTROBJ_SPECIAL
1696                 sv_setref_pv($arg, \"${(my $ntt=$ntype)=~s/_/::/g;\$ntt}\",
1697                 (void*)$var);
1698
1699 The INPUT and OUTPUT sections substitute underscores for double-colons
1700 on the fly, giving the desired effect.  This example demonstrates some
1701 of the power and versatility of the typemap facility.
1702
1703 =head1 EXAMPLES
1704
1705 File C<RPC.xs>: Interface to some ONC+ RPC bind library functions.
1706
1707      #include "EXTERN.h"
1708      #include "perl.h"
1709      #include "XSUB.h"
1710
1711      #include <rpc/rpc.h>
1712
1713      typedef struct netconfig Netconfig;
1714
1715      MODULE = RPC  PACKAGE = RPC
1716
1717      SV *
1718      rpcb_gettime(host="localhost")
1719           char *host
1720         PREINIT:
1721           time_t  timep;
1722         CODE:
1723           ST(0) = sv_newmortal();
1724           if( rpcb_gettime( host, &timep ) )
1725                sv_setnv( ST(0), (double)timep );
1726
1727      Netconfig *
1728      getnetconfigent(netid="udp")
1729           char *netid
1730
1731      MODULE = RPC  PACKAGE = NetconfigPtr  PREFIX = rpcb_
1732
1733      void
1734      rpcb_DESTROY(netconf)
1735           Netconfig *netconf
1736         CODE:
1737           printf("NetconfigPtr::DESTROY\n");
1738           free( netconf );
1739
1740 File C<typemap>: Custom typemap for RPC.xs.
1741
1742      TYPEMAP
1743      Netconfig *  T_PTROBJ
1744
1745 File C<RPC.pm>: Perl module for the RPC extension.
1746
1747      package RPC;
1748
1749      require Exporter;
1750      require DynaLoader;
1751      @ISA = qw(Exporter DynaLoader);
1752      @EXPORT = qw(rpcb_gettime getnetconfigent);
1753
1754      bootstrap RPC;
1755      1;
1756
1757 File C<rpctest.pl>: Perl test program for the RPC extension.
1758
1759      use RPC;
1760
1761      $netconf = getnetconfigent();
1762      $a = rpcb_gettime();
1763      print "time = $a\n";
1764      print "netconf = $netconf\n";
1765
1766      $netconf = getnetconfigent("tcp");
1767      $a = rpcb_gettime("poplar");
1768      print "time = $a\n";
1769      print "netconf = $netconf\n";
1770
1771
1772 =head1 XS VERSION
1773
1774 This document covers features supported by C<xsubpp> 1.935.
1775
1776 =head1 AUTHOR
1777
1778 Originally written by Dean Roehrich <F<roehrich@cray.com>>.
1779
1780 Maintained since 1996 by The Perl Porters <F<perlbug@perl.org>>.