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     POSTCALL:
 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 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 The C<length(NAME)> Keyword
 843
 844 If one of the input arguments to the C function is the length of a string
 845 argument C<NAME>, one can substitute the name of the length-argument by
 846 C<length(NAME)> in the XSUB declaration.  This argument must be omited when
 847 the generated Perl function is called.  E.g.,
 848
 849   void
 850   dump_chars(char *s, short l)
 851   {
 852     short n = 0;
 853     while (n < l) {
 854         printf("s[%d] = \"\\%#03o\"\n", n, (int)s[n]);
 855         n++;
 856     }
 857   }
 858
 859   MODULE = x            PACKAGE = x
 860
 861   void dump_chars(char *s, short length(s))
 862
 863 should be called as C<dump_chars($string)>.
 864
 865 This directive is supported with ANSI-type function declarations only.
 866
 867 =head2 Variable-length Parameter Lists
 868
 869 XSUBs can have variable-length parameter lists by specifying an ellipsis
 870 C<(...)> in the parameter list.  This use of the ellipsis is similar to that
 871 found in ANSI C.  The programmer is able to determine the number of
 872 arguments passed to the XSUB by examining the C<items> variable which the
 873 B<xsubpp> compiler supplies for all XSUBs.  By using this mechanism one can
 874 create an XSUB which accepts a list of parameters of unknown length.
 875
 876 The I<host> parameter for the rpcb_gettime() XSUB can be
 877 optional so the ellipsis can be used to indicate that the
 878 XSUB will take a variable number of parameters.  Perl should
 879 be able to call this XSUB with either of the following statements.
 880
 881      $status = rpcb_gettime( $timep, $host );
 882
 883      $status = rpcb_gettime( $timep );
 884
 885 The XS code, with ellipsis, follows.
 886
 887      bool_t
 888      rpcb_gettime(timep, ...)
 889           time_t timep = NO_INIT
 890         PREINIT:
 891           char *host = "localhost";
 892           STRLEN n_a;
 893         CODE:
 894           if( items > 1 )
 895                host = (char *)SvPV(ST(1), n_a);
 896           RETVAL = rpcb_gettime( host, &timep );
 897         OUTPUT:
 898           timep
 899           RETVAL
 900
 901 =head2 The C_ARGS: Keyword
 902
 903 The C_ARGS: keyword allows creating of XSUBS which have different
 904 calling sequence from Perl than from C, without a need to write
 905 CODE: or PPCODE: section.  The contents of the C_ARGS: paragraph is
 906 put as the argument to the called C function without any change.
 907
 908 For example, suppose that a C function is declared as
 909
 910     symbolic nth_derivative(int n, symbolic function, int flags);
 911
 912 and that the default flags are kept in a global C variable
 913 C<default_flags>.  Suppose that you want to create an interface which
 914 is called as
 915
 916     $second_deriv = $function->nth_derivative(2);
 917
 918 To do this, declare the XSUB as
 919
 920     symbolic
 921     nth_derivative(function, n)
 922         symbolic        function
 923         int             n
 924       C_ARGS:
 925         n, function, default_flags
 926
 927 =head2 The PPCODE: Keyword
 928
 929 The PPCODE: keyword is an alternate form of the CODE: keyword and is used
 930 to tell the B<xsubpp> compiler that the programmer is supplying the code to
 931 control the argument stack for the XSUBs return values.  Occasionally one
 932 will want an XSUB to return a list of values rather than a single value.
 933 In these cases one must use PPCODE: and then explicitly push the list of
 934 values on the stack.  The PPCODE: and CODE:  keywords should not be used
 935 together within the same XSUB.
 936
 937 The actual difference between PPCODE: and CODE: sections is in the
 938 initialization of C<SP> macro (which stands for the I<current> Perl
 939 stack pointer), and in the handling of data on the stack when returning
 940 from an XSUB.  In CODE: sections SP preserves the value which was on
 941 entry to the XSUB: SP is on the function pointer (which follows the
 942 last parameter).  In PPCODE: sections SP is moved backward to the
 943 beginning of the parameter list, which allows C<PUSH*()> macros
 944 to place output values in the place Perl expects them to be when
 945 the XSUB returns back to Perl.
 946
 947 The generated trailer for a CODE: section ensures that the number of return
 948 values Perl will see is either 0 or 1 (depending on the C<void>ness of the
 949 return value of the C function, and heuristics mentioned in
 950 L<"The RETVAL Variable">).  The trailer generated for a PPCODE: section
 951 is based on the number of return values and on the number of times
 952 C<SP> was updated by C<[X]PUSH*()> macros.
 953
 954 Note that macros C<ST(i)>, C<XST_m*()> and C<XSRETURN*()> work equally
 955 well in CODE: sections and PPCODE: sections.
 956
 957 The following XSUB will call the C rpcb_gettime() function
 958 and will return its two output values, timep and status, to
 959 Perl as a single list.
 960
 961      void
 962      rpcb_gettime(host)
 963           char *host
 964         PREINIT:
 965           time_t  timep;
 966           bool_t  status;
 967         PPCODE:
 968           status = rpcb_gettime( host, &timep );
 969           EXTEND(SP, 2);
 970           PUSHs(sv_2mortal(newSViv(status)));
 971           PUSHs(sv_2mortal(newSViv(timep)));
 972
 973 Notice that the programmer must supply the C code necessary
 974 to have the real rpcb_gettime() function called and to have
 975 the return values properly placed on the argument stack.
 976
 977 The C<void> return type for this function tells the B<xsubpp> compiler that
 978 the RETVAL variable is not needed or used and that it should not be created.
 979 In most scenarios the void return type should be used with the PPCODE:
 980 directive.
 981
 982 The EXTEND() macro is used to make room on the argument
 983 stack for 2 return values.  The PPCODE: directive causes the
 984 B<xsubpp> compiler to create a stack pointer available as C<SP>, and it
 985 is this pointer which is being used in the EXTEND() macro.
 986 The values are then pushed onto the stack with the PUSHs()
 987 macro.
 988
 989 Now the rpcb_gettime() function can be used from Perl with
 990 the following statement.
 991
 992      ($status, $timep) = rpcb_gettime("localhost");
 993
 994 When handling output parameters with a PPCODE section, be sure to handle
 995 'set' magic properly.  See L<perlguts> for details about 'set' magic.
 996
 997 =head2 Returning Undef And Empty Lists
 998
 999 Occasionally the programmer will want to return simply
1000 C<undef> or an empty list if a function fails rather than a
1001 separate status value.  The rpcb_gettime() function offers
1002 just this situation.  If the function succeeds we would like
1003 to have it return the time and if it fails we would like to
1004 have undef returned.  In the following Perl code the value
1005 of $timep will either be undef or it will be a valid time.
1006
1007      $timep = rpcb_gettime( "localhost" );
1008
1009 The following XSUB uses the C<SV *> return type as a mnemonic only,
1010 and uses a CODE: block to indicate to the compiler
1011 that the programmer has supplied all the necessary code.  The
1012 sv_newmortal() call will initialize the return value to undef, making that
1013 the default return value.
1014
1015      SV *
1016      rpcb_gettime(host)
1017           char *  host
1018         PREINIT:
1019           time_t  timep;
1020           bool_t x;
1021         CODE:
1022           ST(0) = sv_newmortal();
1023           if( rpcb_gettime( host, &timep ) )
1024                sv_setnv( ST(0), (double)timep);
1025
1026 The next example demonstrates how one would place an explicit undef in the
1027 return value, should the need arise.
1028
1029      SV *
1030      rpcb_gettime(host)
1031           char *  host
1032         PREINIT:
1033           time_t  timep;
1034           bool_t x;
1035         CODE:
1036           ST(0) = sv_newmortal();
1037           if( rpcb_gettime( host, &timep ) ){
1038                sv_setnv( ST(0), (double)timep);
1039           }
1040           else{
1041                ST(0) = &PL_sv_undef;
1042           }
1043
1044 To return an empty list one must use a PPCODE: block and
1045 then not push return values on the stack.
1046
1047      void
1048      rpcb_gettime(host)
1049           char *host
1050         PREINIT:
1051           time_t  timep;
1052         PPCODE:
1053           if( rpcb_gettime( host, &timep ) )
1054                PUSHs(sv_2mortal(newSViv(timep)));
1055           else{
1056               /* Nothing pushed on stack, so an empty
1057                * list is implicitly returned. */
1058           }
1059
1060 Some people may be inclined to include an explicit C<return> in the above
1061 XSUB, rather than letting control fall through to the end.  In those
1062 situations C<XSRETURN_EMPTY> should be used, instead.  This will ensure that
1063 the XSUB stack is properly adjusted.  Consult L<perlguts/"API LISTING"> for
1064 other C<XSRETURN> macros.
1065
1066 Since C<XSRETURN_*> macros can be used with CODE blocks as well, one can
1067 rewrite this example as:
1068
1069      int
1070      rpcb_gettime(host)
1071           char *host
1072         PREINIT:
1073           time_t  timep;
1074         CODE:
1075           RETVAL = rpcb_gettime( host, &timep );
1076           if (RETVAL == 0)
1077                 XSRETURN_UNDEF;
1078         OUTPUT:
1079           RETVAL
1080
1081 In fact, one can put this check into a POSTCALL: section as well.  Together
1082 with PREINIT: simplifications, this leads to:
1083
1084      int
1085      rpcb_gettime(host)
1086           char *host
1087           time_t  timep;
1088         POSTCALL:
1089           if (RETVAL == 0)
1090                 XSRETURN_UNDEF;
1091
1092 =head2 The REQUIRE: Keyword
1093
1094 The REQUIRE: keyword is used to indicate the minimum version of the
1095 B<xsubpp> compiler needed to compile the XS module.  An XS module which
1096 contains the following statement will compile with only B<xsubpp> version
1097 1.922 or greater:
1098
1099         REQUIRE: 1.922
1100
1101 =head2 The CLEANUP: Keyword
1102
1103 This keyword can be used when an XSUB requires special cleanup procedures
1104 before it terminates.  When the CLEANUP:  keyword is used it must follow
1105 any CODE:, PPCODE:, or OUTPUT: blocks which are present in the XSUB.  The
1106 code specified for the cleanup block will be added as the last statements
1107 in the XSUB.
1108
1109 =head2 The POSTCALL: Keyword
1110
1111 This keyword can be used when an XSUB requires special procedures
1112 executed after the C subroutine call is performed.  When the POSTCALL:
1113 keyword is used it must precede OUTPUT: and CLEANUP: blocks which are
1114 present in the XSUB.
1115
1116 See examples in L<"The NO_OUTPUT Keyword"> and L<"Returning Undef And Empty Lists">.
1117
1118 The POSTCALL: block does not make a lot of sense when the C subroutine
1119 call is supplied by user by providing either CODE: or PPCODE: section.
1120
1121 =head2 The BOOT: Keyword
1122
1123 The BOOT: keyword is used to add code to the extension's bootstrap
1124 function.  The bootstrap function is generated by the B<xsubpp> compiler and
1125 normally holds the statements necessary to register any XSUBs with Perl.
1126 With the BOOT: keyword the programmer can tell the compiler to add extra
1127 statements to the bootstrap function.
1128
1129 This keyword may be used any time after the first MODULE keyword and should
1130 appear on a line by itself.  The first blank line after the keyword will
1131 terminate the code block.
1132
1133      BOOT:
1134      # The following message will be printed when the
1135      # bootstrap function executes.
1136      printf("Hello from the bootstrap!\n");
1137
1138 =head2 The VERSIONCHECK: Keyword
1139
1140 The VERSIONCHECK: keyword corresponds to B<xsubpp>'s C<-versioncheck> and
1141 C<-noversioncheck> options.  This keyword overrides the command line
1142 options.  Version checking is enabled by default.  When version checking is
1143 enabled the XS module will attempt to verify that its version matches the
1144 version of the PM module.
1145
1146 To enable version checking:
1147
1148     VERSIONCHECK: ENABLE
1149
1150 To disable version checking:
1151
1152     VERSIONCHECK: DISABLE
1153
1154 =head2 The PROTOTYPES: Keyword
1155
1156 The PROTOTYPES: keyword corresponds to B<xsubpp>'s C<-prototypes> and
1157 C<-noprototypes> options.  This keyword overrides the command line options.
1158 Prototypes are enabled by default.  When prototypes are enabled XSUBs will
1159 be given Perl prototypes.  This keyword may be used multiple times in an XS
1160 module to enable and disable prototypes for different parts of the module.
1161
1162 To enable prototypes:
1163
1164     PROTOTYPES: ENABLE
1165
1166 To disable prototypes:
1167
1168     PROTOTYPES: DISABLE
1169
1170 =head2 The PROTOTYPE: Keyword
1171
1172 This keyword is similar to the PROTOTYPES: keyword above but can be used to
1173 force B<xsubpp> to use a specific prototype for the XSUB.  This keyword
1174 overrides all other prototype options and keywords but affects only the
1175 current XSUB.  Consult L<perlsub/Prototypes> for information about Perl
1176 prototypes.
1177
1178     bool_t
1179     rpcb_gettime(timep, ...)
1180           time_t timep = NO_INIT
1181         PROTOTYPE: $;$
1182         PREINIT:
1183           char *host = "localhost";
1184           STRLEN n_a;
1185         CODE:
1186                   if( items > 1 )
1187                        host = (char *)SvPV(ST(1), n_a);
1188                   RETVAL = rpcb_gettime( host, &timep );
1189         OUTPUT:
1190           timep
1191           RETVAL
1192
1193 =head2 The ALIAS: Keyword
1194
1195 The ALIAS: keyword allows an XSUB to have two or more unique Perl names
1196 and to know which of those names was used when it was invoked.  The Perl
1197 names may be fully-qualified with package names.  Each alias is given an
1198 index.  The compiler will setup a variable called C<ix> which contain the
1199 index of the alias which was used.  When the XSUB is called with its
1200 declared name C<ix> will be 0.
1201
1202 The following example will create aliases C<FOO::gettime()> and
1203 C<BAR::getit()> for this function.
1204
1205     bool_t
1206     rpcb_gettime(host,timep)
1207           char *host
1208           time_t &timep
1209         ALIAS:
1210             FOO::gettime = 1
1211             BAR::getit = 2
1212         INIT:
1213           printf("# ix = %d\n", ix );
1214         OUTPUT:
1215           timep
1216
1217 =head2 The OVERLOAD: Keyword
1218
1219 Instead of writing an overloaded interface using pure Perl, you
1220 can also use the OVERLOAD keyword to define additional Perl names
1221 for your functions (like the ALIAS: keyword above).  However, the
1222 overloaded functions must be defined with three parameters (except
1223 for the nomethod() function which needs four parameters).  If any
1224 function has the OVERLOAD: keyword, several additional lines
1225 will be defined in the c file generated by xsubpp in order to
1226 register with the overload magic.
1227
1228 Since blessed objects are actually stored as RV's, it is useful
1229 to use the typemap features to preprocess parameters and extract
1230 the actual SV stored within the blessed RV. See the sample for
1231 T_PTROBJ_SPECIAL below.
1232
1233 To use the OVERLOAD: keyword, create an XS function which takes
1234 three input parameters ( or use the c style '...' definition) like
1235 this:
1236
1237     SV *
1238     cmp (lobj, robj, swap)
1239     My_Module_obj    lobj
1240     My_Module_obj    robj
1241     IV               swap
1242     OVERLOAD: cmp <=>
1243     { /* function defined here */}
1244
1245 In this case, the function will overload both of the three way
1246 comparison operators.  For all overload operations using non-alpha
1247 characters, you must type the parameter without quoting, seperating
1248 multiple overloads with whitespace.  Note that "" (the stringify
1249 overload) should be entered as \"\" (i.e. escaped).
1250
1251 =head2 The INTERFACE: Keyword
1252
1253 This keyword declares the current XSUB as a keeper of the given
1254 calling signature.  If some text follows this keyword, it is
1255 considered as a list of functions which have this signature, and
1256 should be attached to the current XSUB.
1257
1258 For example, if you have 4 C functions multiply(), divide(), add(),
1259 subtract() all having the signature:
1260
1261     symbolic f(symbolic, symbolic);
1262
1263 you can make them all to use the same XSUB using this:
1264
1265     symbolic
1266     interface_s_ss(arg1, arg2)
1267         symbolic        arg1
1268         symbolic        arg2
1269     INTERFACE:
1270         multiply divide
1271         add subtract
1272
1273 (This is the complete XSUB code for 4 Perl functions!)  Four generated
1274 Perl function share names with corresponding C functions.
1275
1276 The advantage of this approach comparing to ALIAS: keyword is that there
1277 is no need to code a switch statement, each Perl function (which shares
1278 the same XSUB) knows which C function it should call.  Additionally, one
1279 can attach an extra function remainder() at runtime by using
1280
1281     CV *mycv = newXSproto("Symbolic::remainder",
1282                           XS_Symbolic_interface_s_ss, __FILE__, "$$");
1283     XSINTERFACE_FUNC_SET(mycv, remainder);
1284
1285 say, from another XSUB.  (This example supposes that there was no
1286 INTERFACE_MACRO: section, otherwise one needs to use something else instead of
1287 C<XSINTERFACE_FUNC_SET>, see the next section.)
1288
1289 =head2 The INTERFACE_MACRO: Keyword
1290
1291 This keyword allows one to define an INTERFACE using a different way
1292 to extract a function pointer from an XSUB.  The text which follows
1293 this keyword should give the name of macros which would extract/set a
1294 function pointer.  The extractor macro is given return type, C<CV*>,
1295 and C<XSANY.any_dptr> for this C<CV*>.  The setter macro is given cv,
1296 and the function pointer.
1297
1298 The default value is C<XSINTERFACE_FUNC> and C<XSINTERFACE_FUNC_SET>.
1299 An INTERFACE keyword with an empty list of functions can be omitted if
1300 INTERFACE_MACRO keyword is used.
1301
1302 Suppose that in the previous example functions pointers for
1303 multiply(), divide(), add(), subtract() are kept in a global C array
1304 C<fp[]> with offsets being C<multiply_off>, C<divide_off>, C<add_off>,
1305 C<subtract_off>.  Then one can use
1306
1307     #define XSINTERFACE_FUNC_BYOFFSET(ret,cv,f) \
1308         ((XSINTERFACE_CVT(ret,))fp[CvXSUBANY(cv).any_i32])
1309     #define XSINTERFACE_FUNC_BYOFFSET_set(cv,f) \
1310         CvXSUBANY(cv).any_i32 = CAT2( f, _off )
1311
1312 in C section,
1313
1314     symbolic
1315     interface_s_ss(arg1, arg2)
1316         symbolic        arg1
1317         symbolic        arg2
1318       INTERFACE_MACRO:
1319         XSINTERFACE_FUNC_BYOFFSET
1320         XSINTERFACE_FUNC_BYOFFSET_set
1321       INTERFACE:
1322         multiply divide
1323         add subtract
1324
1325 in XSUB section.
1326
1327 =head2 The INCLUDE: Keyword
1328
1329 This keyword can be used to pull other files into the XS module.  The other
1330 files may have XS code.  INCLUDE: can also be used to run a command to
1331 generate the XS code to be pulled into the module.
1332
1333 The file F<Rpcb1.xsh> contains our C<rpcb_gettime()> function:
1334
1335     bool_t
1336     rpcb_gettime(host,timep)
1337           char *host
1338           time_t &timep
1339         OUTPUT:
1340           timep
1341
1342 The XS module can use INCLUDE: to pull that file into it.
1343
1344     INCLUDE: Rpcb1.xsh
1345
1346 If the parameters to the INCLUDE: keyword are followed by a pipe (C<|>) then
1347 the compiler will interpret the parameters as a command.
1348
1349     INCLUDE: cat Rpcb1.xsh |
1350
1351 =head2 The CASE: Keyword
1352
1353 The CASE: keyword allows an XSUB to have multiple distinct parts with each
1354 part acting as a virtual XSUB.  CASE: is greedy and if it is used then all
1355 other XS keywords must be contained within a CASE:.  This means nothing may
1356 precede the first CASE: in the XSUB and anything following the last CASE: is
1357 included in that case.
1358
1359 A CASE: might switch via a parameter of the XSUB, via the C<ix> ALIAS:
1360 variable (see L<"The ALIAS: Keyword">), or maybe via the C<items> variable
1361 (see L<"Variable-length Parameter Lists">).  The last CASE: becomes the
1362 B<default> case if it is not associated with a conditional.  The following
1363 example shows CASE switched via C<ix> with a function C<rpcb_gettime()>
1364 having an alias C<x_gettime()>.  When the function is called as
1365 C<rpcb_gettime()> its parameters are the usual C<(char *host, time_t *timep)>,
1366 but when the function is called as C<x_gettime()> its parameters are
1367 reversed, C<(time_t *timep, char *host)>.
1368
1369     long
1370     rpcb_gettime(a,b)
1371       CASE: ix == 1
1372         ALIAS:
1373           x_gettime = 1
1374         INPUT:
1375           # 'a' is timep, 'b' is host
1376           char *b
1377           time_t a = NO_INIT
1378         CODE:
1379                RETVAL = rpcb_gettime( b, &a );
1380         OUTPUT:
1381           a
1382           RETVAL
1383       CASE:
1384           # 'a' is host, 'b' is timep
1385           char *a
1386           time_t &b = NO_INIT
1387         OUTPUT:
1388           b
1389           RETVAL
1390
1391 That function can be called with either of the following statements.  Note
1392 the different argument lists.
1393
1394         $status = rpcb_gettime( $host, $timep );
1395
1396         $status = x_gettime( $timep, $host );
1397
1398 =head2 The & Unary Operator
1399
1400 The C<&> unary operator in the INPUT: section is used to tell B<xsubpp>
1401 that it should convert a Perl value to/from C using the C type to the left
1402 of C<&>, but provide a pointer to this value when the C function is called.
1403
1404 This is useful to avoid a CODE: block for a C function which takes a parameter
1405 by reference.  Typically, the parameter should be not a pointer type (an
1406 C<int> or C<long> but not an C<int*> or C<long*>).
1407
1408 The following XSUB will generate incorrect C code.  The B<xsubpp> compiler will
1409 turn this into code which calls C<rpcb_gettime()> with parameters C<(char
1410 *host, time_t timep)>, but the real C<rpcb_gettime()> wants the C<timep>
1411 parameter to be of type C<time_t*> rather than C<time_t>.
1412
1413     bool_t
1414     rpcb_gettime(host,timep)
1415           char *host
1416           time_t timep
1417         OUTPUT:
1418           timep
1419
1420 That problem is corrected by using the C<&> operator.  The B<xsubpp> compiler
1421 will now turn this into code which calls C<rpcb_gettime()> correctly with
1422 parameters C<(char *host, time_t *timep)>.  It does this by carrying the
1423 C<&> through, so the function call looks like C<rpcb_gettime(host, &timep)>.
1424
1425     bool_t
1426     rpcb_gettime(host,timep)
1427           char *host
1428           time_t &timep
1429         OUTPUT:
1430           timep
1431
1432 =head2 Inserting POD, Comments and C Preprocessor Directives
1433
1434 C preprocessor directives are allowed within BOOT:, PREINIT: INIT:, CODE:,
1435 PPCODE:, POSTCALL:, and CLEANUP: blocks, as well as outside the functions.
1436 Comments are allowed anywhere after the MODULE keyword.  The compiler will
1437 pass the preprocessor directives through untouched and will remove the
1438 commented lines. POD documentation is allowed at any point, both in the
1439 C and XS language sections. POD must be terminated with a C<=cut> command;
1440 C<xsubpp> will exit with an error if it does not. It is very unlikely that
1441 human generated C code will be mistaken for POD, as most indenting styles
1442 result in whitespace in front of any line starting with C<=>. Machine
1443 generated XS files may fall into this trap unless care is taken to
1444 ensure that a space breaks the sequence "\n=".
1445
1446 Comments can be added to XSUBs by placing a C<#> as the first
1447 non-whitespace of a line.  Care should be taken to avoid making the
1448 comment look like a C preprocessor directive, lest it be interpreted as
1449 such.  The simplest way to prevent this is to put whitespace in front of
1450 the C<#>.
1451
1452 If you use preprocessor directives to choose one of two
1453 versions of a function, use
1454
1455     #if ... version1
1456     #else /* ... version2  */
1457     #endif
1458
1459 and not
1460
1461     #if ... version1
1462     #endif
1463     #if ... version2
1464     #endif
1465
1466 because otherwise B<xsubpp> will believe that you made a duplicate
1467 definition of the function.  Also, put a blank line before the
1468 #else/#endif so it will not be seen as part of the function body.
1469
1470 =head2 Using XS With C++
1471
1472 If an XSUB name contains C<::>, it is considered to be a C++ method.
1473 The generated Perl function will assume that
1474 its first argument is an object pointer.  The object pointer
1475 will be stored in a variable called THIS.  The object should
1476 have been created by C++ with the new() function and should
1477 be blessed by Perl with the sv_setref_pv() macro.  The
1478 blessing of the object by Perl can be handled by a typemap.  An example
1479 typemap is shown at the end of this section.
1480
1481 If the return type of the XSUB includes C<static>, the method is considered
1482 to be a static method.  It will call the C++
1483 function using the class::method() syntax.  If the method is not static
1484 the function will be called using the THIS-E<gt>method() syntax.
1485
1486 The next examples will use the following C++ class.
1487
1488      class color {
1489           public:
1490           color();
1491           ~color();
1492           int blue();
1493           void set_blue( int );
1494
1495           private:
1496           int c_blue;
1497      };
1498
1499 The XSUBs for the blue() and set_blue() methods are defined with the class
1500 name but the parameter for the object (THIS, or "self") is implicit and is
1501 not listed.
1502
1503      int
1504      color::blue()
1505
1506      void
1507      color::set_blue( val )
1508           int val
1509
1510 Both Perl functions will expect an object as the first parameter.  In the
1511 generated C++ code the object is called C<THIS>, and the method call will
1512 be performed on this object.  So in the C++ code the blue() and set_blue()
1513 methods will be called as this:
1514
1515      RETVAL = THIS->blue();
1516
1517      THIS->set_blue( val );
1518
1519 You could also write a single get/set method using an optional argument:
1520
1521      int
1522      color::blue( val = NO_INIT )
1523          int val
1524          PROTOTYPE $;$
1525          CODE:
1526              if (items > 1)
1527                  THIS->set_blue( val );
1528              RETVAL = THIS->blue();
1529          OUTPUT:
1530              RETVAL
1531
1532 If the function's name is B<DESTROY> then the C++ C<delete> function will be
1533 called and C<THIS> will be given as its parameter.  The generated C++ code for
1534
1535      void
1536      color::DESTROY()
1537
1538 will look like this:
1539
1540      color *THIS = ...; // Initialized as in typemap
1541
1542      delete THIS;
1543
1544 If the function's name is B<new> then the C++ C<new> function will be called
1545 to create a dynamic C++ object.  The XSUB will expect the class name, which
1546 will be kept in a variable called C<CLASS>, to be given as the first
1547 argument.
1548
1549      color *
1550      color::new()
1551
1552 The generated C++ code will call C<new>.
1553
1554      RETVAL = new color();
1555
1556 The following is an example of a typemap that could be used for this C++
1557 example.
1558
1559     TYPEMAP
1560     color *             O_OBJECT
1561
1562     OUTPUT
1563     # The Perl object is blessed into 'CLASS', which should be a
1564     # char* having the name of the package for the blessing.
1565     O_OBJECT
1566         sv_setref_pv( $arg, CLASS, (void*)$var );
1567
1568     INPUT
1569     O_OBJECT
1570         if( sv_isobject($arg) && (SvTYPE(SvRV($arg)) == SVt_PVMG) )
1571                 $var = ($type)SvIV((SV*)SvRV( $arg ));
1572         else{
1573                 warn( \"${Package}::$func_name() -- $var is not a blessed SV reference\" );
1574                 XSRETURN_UNDEF;
1575         }
1576
1577 =head2 Interface Strategy
1578
1579 When designing an interface between Perl and a C library a straight
1580 translation from C to XS (such as created by C<h2xs -x>) is often sufficient.
1581 However, sometimes the interface will look
1582 very C-like and occasionally nonintuitive, especially when the C function
1583 modifies one of its parameters, or returns failure inband (as in "negative
1584 return values mean failure").  In cases where the programmer wishes to
1585 create a more Perl-like interface the following strategy may help to
1586 identify the more critical parts of the interface.
1587
1588 Identify the C functions with input/output or output parameters.  The XSUBs for
1589 these functions may be able to return lists to Perl.
1590
1591 Identify the C functions which use some inband info as an indication
1592 of failure.  They may be
1593 candidates to return undef or an empty list in case of failure.  If the
1594 failure may be detected without a call to the C function, you may want to use
1595 an INIT: section to report the failure.  For failures detectable after the C
1596 function returns one may want to use a POSTCALL: section to process the
1597 failure.  In more complicated cases use CODE: or PPCODE: sections.
1598
1599 If many functions use the same failure indication based on the return value,
1600 you may want to create a special typedef to handle this situation.  Put
1601
1602   typedef int negative_is_failure;
1603
1604 near the beginning of XS file, and create an OUTPUT typemap entry
1605 for C<negative_is_failure> which converts negative values to C<undef>, or
1606 maybe croak()s.  After this the return value of type C<negative_is_failure>
1607 will create more Perl-like interface.
1608
1609 Identify which values are used by only the C and XSUB functions
1610 themselves, say, when a parameter to a function should be a contents of a
1611 global variable.  If Perl does not need to access the contents of the value
1612 then it may not be necessary to provide a translation for that value
1613 from C to Perl.
1614
1615 Identify the pointers in the C function parameter lists and return
1616 values.  Some pointers may be used to implement input/output or
1617 output parameters, they can be handled in XS with the C<&> unary operator,
1618 and, possibly, using the NO_INIT keyword.
1619 Some others will require handling of types like C<int *>, and one needs
1620 to decide what a useful Perl translation will do in such a case.  When
1621 the semantic is clear, it is advisable to put the translation into a typemap
1622 file.
1623
1624 Identify the structures used by the C functions.  In many
1625 cases it may be helpful to use the T_PTROBJ typemap for
1626 these structures so they can be manipulated by Perl as
1627 blessed objects.  (This is handled automatically by C<h2xs -x>.)
1628
1629 If the same C type is used in several different contexts which require
1630 different translations, C<typedef> several new types mapped to this C type,
1631 and create separate F<typemap> entries for these new types.  Use these
1632 types in declarations of return type and parameters to XSUBs.
1633
1634 =head2 Perl Objects And C Structures
1635
1636 When dealing with C structures one should select either
1637 B<T_PTROBJ> or B<T_PTRREF> for the XS type.  Both types are
1638 designed to handle pointers to complex objects.  The
1639 T_PTRREF type will allow the Perl object to be unblessed
1640 while the T_PTROBJ type requires that the object be blessed.
1641 By using T_PTROBJ one can achieve a form of type-checking
1642 because the XSUB will attempt to verify that the Perl object
1643 is of the expected type.
1644
1645 The following XS code shows the getnetconfigent() function which is used
1646 with ONC+ TIRPC.  The getnetconfigent() function will return a pointer to a
1647 C structure and has the C prototype shown below.  The example will
1648 demonstrate how the C pointer will become a Perl reference.  Perl will
1649 consider this reference to be a pointer to a blessed object and will
1650 attempt to call a destructor for the object.  A destructor will be
1651 provided in the XS source to free the memory used by getnetconfigent().
1652 Destructors in XS can be created by specifying an XSUB function whose name
1653 ends with the word B<DESTROY>.  XS destructors can be used to free memory
1654 which may have been malloc'd by another XSUB.
1655
1656      struct netconfig *getnetconfigent(const char *netid);
1657
1658 A C<typedef> will be created for C<struct netconfig>.  The Perl
1659 object will be blessed in a class matching the name of the C
1660 type, with the tag C<Ptr> appended, and the name should not
1661 have embedded spaces if it will be a Perl package name.  The
1662 destructor will be placed in a class corresponding to the
1663 class of the object and the PREFIX keyword will be used to
1664 trim the name to the word DESTROY as Perl will expect.
1665
1666      typedef struct netconfig Netconfig;
1667
1668      MODULE = RPC  PACKAGE = RPC
1669
1670      Netconfig *
1671      getnetconfigent(netid)
1672           char *netid
1673
1674      MODULE = RPC  PACKAGE = NetconfigPtr  PREFIX = rpcb_
1675
1676      void
1677      rpcb_DESTROY(netconf)
1678           Netconfig *netconf
1679         CODE:
1680           printf("Now in NetconfigPtr::DESTROY\n");
1681           free( netconf );
1682
1683 This example requires the following typemap entry.  Consult the typemap
1684 section for more information about adding new typemaps for an extension.
1685
1686      TYPEMAP
1687      Netconfig *  T_PTROBJ
1688
1689 This example will be used with the following Perl statements.
1690
1691      use RPC;
1692      $netconf = getnetconfigent("udp");
1693
1694 When Perl destroys the object referenced by $netconf it will send the
1695 object to the supplied XSUB DESTROY function.  Perl cannot determine, and
1696 does not care, that this object is a C struct and not a Perl object.  In
1697 this sense, there is no difference between the object created by the
1698 getnetconfigent() XSUB and an object created by a normal Perl subroutine.
1699
1700 =head2 The Typemap
1701
1702 The typemap is a collection of code fragments which are used by the B<xsubpp>
1703 compiler to map C function parameters and values to Perl values.  The
1704 typemap file may consist of three sections labelled C<TYPEMAP>, C<INPUT>, and
1705 C<OUTPUT>.  An unlabelled initial section is assumed to be a C<TYPEMAP>
1706 section.  The INPUT section tells
1707 the compiler how to translate Perl values
1708 into variables of certain C types.  The OUTPUT section tells the compiler
1709 how to translate the values from certain C types into values Perl can
1710 understand.  The TYPEMAP section tells the compiler which of the INPUT and
1711 OUTPUT code fragments should be used to map a given C type to a Perl value.
1712 The section labels C<TYPEMAP>, C<INPUT>, or C<OUTPUT> must begin
1713 in the first column on a line by themselves, and must be in uppercase.
1714
1715 The default typemap in the C<lib/ExtUtils> directory of the Perl source
1716 contains many useful types which can be used by Perl extensions.  Some
1717 extensions define additional typemaps which they keep in their own directory.
1718 These additional typemaps may reference INPUT and OUTPUT maps in the main
1719 typemap.  The B<xsubpp> compiler will allow the extension's own typemap to
1720 override any mappings which are in the default typemap.
1721
1722 Most extensions which require a custom typemap will need only the TYPEMAP
1723 section of the typemap file.  The custom typemap used in the
1724 getnetconfigent() example shown earlier demonstrates what may be the typical
1725 use of extension typemaps.  That typemap is used to equate a C structure
1726 with the T_PTROBJ typemap.  The typemap used by getnetconfigent() is shown
1727 here.  Note that the C type is separated from the XS type with a tab and
1728 that the C unary operator C<*> is considered to be a part of the C type name.
1729
1730         TYPEMAP
1731         Netconfig *<tab>T_PTROBJ
1732
1733 Here's a more complicated example: suppose that you wanted C<struct
1734 netconfig> to be blessed into the class C<Net::Config>.  One way to do
1735 this is to use underscores (_) to separate package names, as follows:
1736
1737         typedef struct netconfig * Net_Config;
1738
1739 And then provide a typemap entry C<T_PTROBJ_SPECIAL> that maps underscores to
1740 double-colons (::), and declare C<Net_Config> to be of that type:
1741
1742
1743         TYPEMAP
1744         Net_Config      T_PTROBJ_SPECIAL
1745
1746         INPUT
1747         T_PTROBJ_SPECIAL
1748                 if (sv_derived_from($arg, \"${(my $ntt=$ntype)=~s/_/::/g;\$ntt}\")) {
1749                         IV tmp = SvIV((SV*)SvRV($arg));
1750                 $var = ($type) tmp;
1751                 }
1752                 else
1753                         croak(\"$var is not of type ${(my $ntt=$ntype)=~s/_/::/g;\$ntt}\")
1754
1755         OUTPUT
1756         T_PTROBJ_SPECIAL
1757                 sv_setref_pv($arg, \"${(my $ntt=$ntype)=~s/_/::/g;\$ntt}\",
1758                 (void*)$var);
1759
1760 The INPUT and OUTPUT sections substitute underscores for double-colons
1761 on the fly, giving the desired effect.  This example demonstrates some
1762 of the power and versatility of the typemap facility.
1763
1764 =head2 Safely Storing Static Data in XS
1765
1766 Starting with Perl 5.8, a macro framework has been defined to allow
1767 static data to be safely stored in XS modules that will be accessed from
1768 a multi-threaded Perl.
1769
1770 Although primarily designed for use with multi-threaded Perl, the macros
1771 have been designed so that they will work with non-threaded Perl as well.
1772
1773 It is therefore strongly recommended that these macros be used by all
1774 XS modules that make use of static data.
1775
1776 The easiest way to get a template set of macros to use is by specifying
1777 the C<-g> (C<--global>) option with h2xs (see L<h2xs>).
1778
1779 Below is an example module that makes use of the macros.
1780
1781     #include "EXTERN.h"
1782     #include "perl.h"
1783     #include "XSUB.h"
1784
1785     /* Global Data */
1786
1787     #define MY_CXT_KEY "BlindMice::_guts" XS_VERSION
1788
1789     typedef struct {
1790         int count;
1791         char name[3][100];
1792     } my_cxt_t;
1793
1794     START_MY_CXT
1795
1796     MODULE = BlindMice           PACKAGE = BlindMice
1797
1798     BOOT:
1799     {
1800         MY_CXT_INIT;
1801         MY_CXT.count = 0;
1802         strcpy(MY_CXT.name[0], "None");
1803         strcpy(MY_CXT.name[1], "None");
1804         strcpy(MY_CXT.name[2], "None");
1805     }
1806
1807     int
1808     newMouse(char * name)
1809         char * name;
1810         PREINIT:
1811           dMY_CXT;
1812         CODE:
1813           if (MY_CXT.count >= 3) {
1814               warn("Already have 3 blind mice") ;
1815               RETVAL = 0;
1816           }
1817           else {
1818               RETVAL = ++ MY_CXT.count;
1819               strcpy(MY_CXT.name[MY_CXT.count - 1], name);
1820           }
1821
1822     char *
1823     get_mouse_name(index)
1824       int index
1825       CODE:
1826         dMY_CXT;
1827         RETVAL = MY_CXT.lives ++;
1828         if (index > MY_CXT.count)
1829           croak("There are only 3 blind mice.");
1830         else
1831           RETVAL = newSVpv(MY_CXT.name[index - 1]);
1832
1833
1834 B<REFERENCE>
1835
1836 =over 5
1837
1838 =item MY_CXT_KEY
1839
1840 This macro is used to define a unique key to refer to the static data
1841 for an XS module. The suggested naming scheme, as used by h2xs, is to
1842 use a string that consists of the module name, the string "::_guts"
1843 and the module version number.
1844
1845     #define MY_CXT_KEY "MyModule::_guts" XS_VERSION
1846
1847 =item typedef my_cxt_t
1848
1849 This struct typedef I<must> always be called C<my_cxt_t> -- the other
1850 C<CXT*> macros assume the existence of the C<my_cxt_t> typedef name.
1851
1852 Declare a typedef named C<my_cxt_t> that is a structure that contains
1853 all the data that needs to be interpreter-local.
1854
1855     typedef struct {
1856         int some_value;
1857     } my_cxt_t;
1858
1859 =item START_MY_CXT
1860
1861 Always place the START_MY_CXT macro directly after the declaration
1862 of C<my_cxt_t>.
1863
1864 =item MY_CXT_INIT
1865
1866 The MY_CXT_INIT macro initialises storage for the C<my_cxt_t> struct.
1867
1868 It I<must> be called exactly once -- typically in a BOOT: section.
1869
1870 =item dMY_CXT
1871
1872 Use the dMY_CXT macro (a declaration) in all the functions that access
1873 MY_CXT.
1874
1875 =item MY_CXT
1876
1877 Use the MY_CXT macro to access members of the C<my_cxt_t> struct. For
1878 example, if C<my_cxt_t> is
1879
1880     typedef struct {
1881         int index;
1882     } my_cxt_t;
1883
1884 then use this to access the C<index> member
1885
1886     dMY_CXT;
1887     MY_CXT.index = 2;
1888
1889 =back
1890
1891 =head1 EXAMPLES
1892
1893 File C<RPC.xs>: Interface to some ONC+ RPC bind library functions.
1894
1895      #include "EXTERN.h"
1896      #include "perl.h"
1897      #include "XSUB.h"
1898
1899      #include <rpc/rpc.h>
1900
1901      typedef struct netconfig Netconfig;
1902
1903      MODULE = RPC  PACKAGE = RPC
1904
1905      SV *
1906      rpcb_gettime(host="localhost")
1907           char *host
1908         PREINIT:
1909           time_t  timep;
1910         CODE:
1911           ST(0) = sv_newmortal();
1912           if( rpcb_gettime( host, &timep ) )
1913                sv_setnv( ST(0), (double)timep );
1914
1915      Netconfig *
1916      getnetconfigent(netid="udp")
1917           char *netid
1918
1919      MODULE = RPC  PACKAGE = NetconfigPtr  PREFIX = rpcb_
1920
1921      void
1922      rpcb_DESTROY(netconf)
1923           Netconfig *netconf
1924         CODE:
1925           printf("NetconfigPtr::DESTROY\n");
1926           free( netconf );
1927
1928 File C<typemap>: Custom typemap for RPC.xs.
1929
1930      TYPEMAP
1931      Netconfig *  T_PTROBJ
1932
1933 File C<RPC.pm>: Perl module for the RPC extension.
1934
1935      package RPC;
1936
1937      require Exporter;
1938      require DynaLoader;
1939      @ISA = qw(Exporter DynaLoader);
1940      @EXPORT = qw(rpcb_gettime getnetconfigent);
1941
1942      bootstrap RPC;
1943      1;
1944
1945 File C<rpctest.pl>: Perl test program for the RPC extension.
1946
1947      use RPC;
1948
1949      $netconf = getnetconfigent();
1950      $a = rpcb_gettime();
1951      print "time = $a\n";
1952      print "netconf = $netconf\n";
1953
1954      $netconf = getnetconfigent("tcp");
1955      $a = rpcb_gettime("poplar");
1956      print "time = $a\n";
1957      print "netconf = $netconf\n";
1958
1959
1960 =head1 XS VERSION
1961
1962 This document covers features supported by C<xsubpp> 1.935.
1963
1964 =head1 AUTHOR
1965
1966 Originally written by Dean Roehrich <F<roehrich@cray.com>>.
1967
1968 Maintained since 1996 by The Perl Porters <F<perlbug@perl.org>>.