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 a language used to create an extension interface
  10 between Perl and some C library which one wishes to use with
  11 Perl.  The XS interface is combined with the library to
  12 create a new library which can be linked to Perl.  An B<XSUB>
  13 is a function in the XS language and is the core component
  14 of the Perl application interface.
  15
  16 The XS compiler is called B<xsubpp>.  This compiler will embed
  17 the constructs necessary to let an XSUB, which is really a C
  18 function in disguise, manipulate Perl values and creates the
  19 glue necessary to let Perl access the XSUB.  The compiler
  20 uses B<typemaps> to determine how to map C function parameters
  21 and variables to Perl values.  The default typemap handles
  22 many common C types.  A supplement typemap must be created
  23 to handle special structures and types for the library being
  24 linked.
  25
  26 See L<perlxstut> for a tutorial on the whole extension creation process.
  27
  28 =head2 On The Road
  29
  30 Many of the examples which follow will concentrate on creating an interface
  31 between Perl and the ONC+ RPC bind library functions.  The rpcb_gettime()
  32 function is used to demonstrate many features of the XS language.  This
  33 function has two parameters; the first is an input parameter and the second
  34 is an output parameter.  The function also returns a status value.
  35
  36         bool_t rpcb_gettime(const char *host, time_t *timep);
  37
  38 From C this function will be called with the following
  39 statements.
  40
  41      #include <rpc/rpc.h>
  42      bool_t status;
  43      time_t timep;
  44      status = rpcb_gettime( "localhost", &timep );
  45
  46 If an XSUB is created to offer a direct translation between this function
  47 and Perl, then this XSUB will be used from Perl with the following code.
  48 The $status and $timep variables will contain the output of the function.
  49
  50      use RPC;
  51      $status = rpcb_gettime( "localhost", $timep );
  52
  53 The following XS file shows an XS subroutine, or XSUB, which
  54 demonstrates one possible interface to the rpcb_gettime()
  55 function.  This XSUB represents a direct translation between
  56 C and Perl and so preserves the interface even from Perl.
  57 This XSUB will be invoked from Perl with the usage shown
  58 above.  Note that the first three #include statements, for
  59 C<EXTERN.h>, C<perl.h>, and C<XSUB.h>, will always be present at the
  60 beginning of an XS file.  This approach and others will be
  61 expanded later in this document.
  62
  63      #include "EXTERN.h"
  64      #include "perl.h"
  65      #include "XSUB.h"
  66      #include <rpc/rpc.h>
  67
  68      MODULE = RPC  PACKAGE = RPC
  69
  70      bool_t
  71      rpcb_gettime(host,timep)
  72           char *host
  73           time_t &timep
  74           OUTPUT:
  75           timep
  76
  77 Any extension to Perl, including those containing XSUBs,
  78 should have a Perl module to serve as the bootstrap which
  79 pulls the extension into Perl.  This module will export the
  80 extension's functions and variables to the Perl program and
  81 will cause the extension's XSUBs to be linked into Perl.
  82 The following module will be used for most of the examples
  83 in this document and should be used from Perl with the C<use>
  84 command as shown earlier.  Perl modules are explained in
  85 more detail later in this document.
  86
  87      package RPC;
  88
  89      require Exporter;
  90      require DynaLoader;
  91      @ISA = qw(Exporter DynaLoader);
  92      @EXPORT = qw( rpcb_gettime );
  93
  94      bootstrap RPC;
  95      1;
  96
  97 Throughout this document a variety of interfaces to the rpcb_gettime()
  98 XSUB will be explored.  The XSUBs will take their parameters in different
  99 orders or will take different numbers of parameters.  In each case the
 100 XSUB is an abstraction between Perl and the real C rpcb_gettime()
 101 function, and the XSUB must always ensure that the real rpcb_gettime()
 102 function is called with the correct parameters.  This abstraction will
 103 allow the programmer to create a more Perl-like interface to the C
 104 function.
 105
 106 =head2 The Anatomy of an XSUB
 107
 108 The following XSUB allows a Perl program to access a C library function
 109 called sin().  The XSUB will imitate the C function which takes a single
 110 argument and returns a single value.
 111
 112      double
 113      sin(x)
 114        double x
 115
 116 When using C pointers the indirection operator C<*> should be considered
 117 part of the type and the address operator C<&> should be considered part of
 118 the variable, as is demonstrated in the rpcb_gettime() function above.  See
 119 the section on typemaps for more about handling qualifiers and unary
 120 operators in C types.
 121
 122 The function name and the return type must be placed on
 123 separate lines.
 124
 125   INCORRECT                        CORRECT
 126
 127   double sin(x)                    double
 128     double x                       sin(x)
 129                                      double x
 130
 131 The function body may be indented or left-adjusted.  The following example
 132 shows a function with its body left-adjusted.  Most examples in this
 133 document will indent the body.
 134
 135   CORRECT
 136
 137   double
 138   sin(x)
 139   double x
 140
 141 =head2 The Argument Stack
 142
 143 The argument stack is used to store the values which are
 144 sent as parameters to the XSUB and to store the XSUB's
 145 return value.  In reality all Perl functions keep their
 146 values on this stack at the same time, each limited to its
 147 own range of positions on the stack.  In this document the
 148 first position on that stack which belongs to the active
 149 function will be referred to as position 0 for that function.
 150
 151 XSUBs refer to their stack arguments with the macro B<ST(x)>, where I<x>
 152 refers to a position in this XSUB's part of the stack.  Position 0 for that
 153 function would be known to the XSUB as ST(0).  The XSUB's incoming
 154 parameters and outgoing return values always begin at ST(0).  For many
 155 simple cases the B<xsubpp> compiler will generate the code necessary to
 156 handle the argument stack by embedding code fragments found in the
 157 typemaps.  In more complex cases the programmer must supply the code.
 158
 159 =head2 The RETVAL Variable
 160
 161 The RETVAL variable is a magic variable which always matches
 162 the return type of the C library function.  The B<xsubpp> compiler will
 163 supply this variable in each XSUB and by default will use it to hold the
 164 return value of the C library function being called.  In simple cases the
 165 value of RETVAL will be placed in ST(0) of the argument stack where it can
 166 be received by Perl as the return value of the XSUB.
 167
 168 If the XSUB has a return type of C<void> then the compiler will
 169 not supply a RETVAL variable for that function.  When using
 170 the PPCODE: directive the RETVAL variable may not be needed.
 171
 172 =head2 The MODULE Keyword
 173
 174 The MODULE keyword is used to start the XS code and to
 175 specify the package of the functions which are being
 176 defined.  All text preceding the first MODULE keyword is
 177 considered C code and is passed through to the output
 178 untouched.  Every XS module will have a bootstrap function
 179 which is used to hook the XSUBs into Perl.  The package name
 180 of this bootstrap function will match the value of the last
 181 MODULE statement in the XS source files.  The value of
 182 MODULE should always remain constant within the same XS
 183 file, though this is not required.
 184
 185 The following example will start the XS code and will place
 186 all functions in a package named RPC.
 187
 188      MODULE = RPC
 189
 190 =head2 The PACKAGE Keyword
 191
 192 When functions within an XS source file must be separated into packages
 193 the PACKAGE keyword should be used.  This keyword is used with the MODULE
 194 keyword and must follow immediately after it when used.
 195
 196      MODULE = RPC  PACKAGE = RPC
 197
 198      [ XS code in package RPC ]
 199
 200      MODULE = RPC  PACKAGE = RPCB
 201
 202      [ XS code in package RPCB ]
 203
 204      MODULE = RPC  PACKAGE = RPC
 205
 206      [ XS code in package RPC ]
 207
 208 Although this keyword is optional and in some cases provides redundant
 209 information it should always be used.  This keyword will ensure that the
 210 XSUBs appear in the desired package.
 211
 212 =head2 The PREFIX Keyword
 213
 214 The PREFIX keyword designates prefixes which should be
 215 removed from the Perl function names.  If the C function is
 216 C<rpcb_gettime()> and the PREFIX value is C<rpcb_> then Perl will
 217 see this function as C<gettime()>.
 218
 219 This keyword should follow the PACKAGE keyword when used.
 220 If PACKAGE is not used then PREFIX should follow the MODULE
 221 keyword.
 222
 223      MODULE = RPC  PREFIX = rpc_
 224
 225      MODULE = RPC  PACKAGE = RPCB  PREFIX = rpcb_
 226
 227 =head2 The OUTPUT: Keyword
 228
 229 The OUTPUT: keyword indicates that certain function parameters should be
 230 updated (new values made visible to Perl) when the XSUB terminates or that
 231 certain values should be returned to the calling Perl function.  For
 232 simple functions, such as the sin() function above, the RETVAL variable is
 233 automatically designated as an output value.  In more complex functions
 234 the B<xsubpp> compiler will need help to determine which variables are output
 235 variables.
 236
 237 This keyword will normally be used to complement the CODE:  keyword.
 238 The RETVAL variable is not recognized as an output variable when the
 239 CODE: keyword is present.  The OUTPUT:  keyword is used in this
 240 situation to tell the compiler that RETVAL really is an output
 241 variable.
 242
 243 The OUTPUT: keyword can also be used to indicate that function parameters
 244 are output variables.  This may be necessary when a parameter has been
 245 modified within the function and the programmer would like the update to
 246 be seen by Perl.
 247
 248      bool_t
 249      rpcb_gettime(host,timep)
 250           char *host
 251           time_t &timep
 252           OUTPUT:
 253           timep
 254
 255 The OUTPUT: keyword will also allow an output parameter to
 256 be mapped to a matching piece of code rather than to a
 257 typemap.
 258
 259      bool_t
 260      rpcb_gettime(host,timep)
 261           char *host
 262           time_t &timep
 263           OUTPUT:
 264           timep sv_setnv(ST(1), (double)timep);
 265
 266 =head2 The CODE: Keyword
 267
 268 This keyword is used in more complicated XSUBs which require
 269 special handling for the C function.  The RETVAL variable is
 270 available but will not be returned unless it is specified
 271 under the OUTPUT: keyword.
 272
 273 The following XSUB is for a C function which requires special handling of
 274 its parameters.  The Perl usage is given first.
 275
 276      $status = rpcb_gettime( "localhost", $timep );
 277
 278 The XSUB follows.
 279
 280      bool_t
 281      rpcb_gettime(host,timep)
 282           char *host
 283           time_t timep
 284           CODE:
 285                RETVAL = rpcb_gettime( host, &timep );
 286           OUTPUT:
 287           timep
 288           RETVAL
 289
 290 =head2 The INIT: Keyword
 291
 292 The INIT: keyword allows initialization to be inserted into the XSUB before
 293 the compiler generates the call to the C function.  Unlike the CODE: keyword
 294 above, this keyword does not affect the way the compiler handles RETVAL.
 295
 296     bool_t
 297     rpcb_gettime(host,timep)
 298           char *host
 299           time_t &timep
 300           INIT:
 301           printf("# Host is %s\n", host );
 302           OUTPUT:
 303           timep
 304
 305 =head2 The NO_INIT Keyword
 306
 307 The NO_INIT keyword is used to indicate that a function
 308 parameter is being used as only an output value.  The B<xsubpp>
 309 compiler will normally generate code to read the values of
 310 all function parameters from the argument stack and assign
 311 them to C variables upon entry to the function.  NO_INIT
 312 will tell the compiler that some parameters will be used for
 313 output rather than for input and that they will be handled
 314 before the function terminates.
 315
 316 The following example shows a variation of the rpcb_gettime() function.
 317 This function uses the timep variable as only an output variable and does
 318 not care about its initial contents.
 319
 320      bool_t
 321      rpcb_gettime(host,timep)
 322           char *host
 323           time_t &timep = NO_INIT
 324           OUTPUT:
 325           timep
 326
 327 =head2 Initializing Function Parameters
 328
 329 Function parameters are normally initialized with their
 330 values from the argument stack.  The typemaps contain the
 331 code segments which are used to transfer the Perl values to
 332 the C parameters.  The programmer, however, is allowed to
 333 override the typemaps and supply alternate initialization
 334 code.
 335
 336 The following code demonstrates how to supply initialization code for
 337 function parameters.  The initialization code is eval'd by the compiler
 338 before it is added to the output so anything which should be interpreted
 339 literally, such as double quotes, must be protected with backslashes.
 340
 341      bool_t
 342      rpcb_gettime(host,timep)
 343           char *host = (char *)SvPV(ST(0),na);
 344           time_t &timep = 0;
 345           OUTPUT:
 346           timep
 347
 348 This should not be used to supply default values for parameters.  One
 349 would normally use this when a function parameter must be processed by
 350 another library function before it can be used.  Default parameters are
 351 covered in the next section.
 352
 353 =head2 Default Parameter Values
 354
 355 Default values can be specified for function parameters by
 356 placing an assignment statement in the parameter list.  The
 357 default value may be a number or a string.  Defaults should
 358 always be used on the right-most parameters only.
 359
 360 To allow the XSUB for rpcb_gettime() to have a default host
 361 value the parameters to the XSUB could be rearranged.  The
 362 XSUB will then call the real rpcb_gettime() function with
 363 the parameters in the correct order.  Perl will call this
 364 XSUB with either of the following statements.
 365
 366      $status = rpcb_gettime( $timep, $host );
 367
 368      $status = rpcb_gettime( $timep );
 369
 370 The XSUB will look like the code  which  follows.   A  CODE:
 371 block  is used to call the real rpcb_gettime() function with
 372 the parameters in the correct order for that function.
 373
 374      bool_t
 375      rpcb_gettime(timep,host="localhost")
 376           char *host
 377           time_t timep = NO_INIT
 378           CODE:
 379                RETVAL = rpcb_gettime( host, &timep );
 380           OUTPUT:
 381           timep
 382           RETVAL
 383
 384 =head2 The PREINIT: Keyword
 385
 386 The PREINIT: keyword allows extra variables to be declared before the
 387 typemaps are expanded.  If a variable is declared in a CODE: block then that
 388 variable will follow any typemap code.  This may result in a C syntax
 389 error.  To force the variable to be declared before the typemap code, place
 390 it into a PREINIT: block.  The PREINIT: keyword may be used one or more
 391 times within an XSUB.
 392
 393 The following examples are equivalent, but if the code is using complex
 394 typemaps then the first example is safer.
 395
 396      bool_t
 397      rpcb_gettime(timep)
 398           time_t timep = NO_INIT
 399           PREINIT:
 400           char *host = "localhost";
 401           CODE:
 402           RETVAL = rpcb_gettime( host, &timep );
 403           OUTPUT:
 404           timep
 405           RETVAL
 406
 407 A correct, but error-prone example.
 408
 409      bool_t
 410      rpcb_gettime(timep)
 411           time_t timep = NO_INIT
 412           CODE:
 413           char *host = "localhost";
 414           RETVAL = rpcb_gettime( host, &timep );
 415           OUTPUT:
 416           timep
 417           RETVAL
 418
 419 =head2 The INPUT: Keyword
 420
 421 The XSUB's parameters are usually evaluated immediately after entering the
 422 XSUB.  The INPUT: keyword can be used to force those parameters to be
 423 evaluated a little later.  The INPUT: keyword can be used multiple times
 424 within an XSUB and can be used to list one or more input variables.  This
 425 keyword is used with the PREINIT: keyword.
 426
 427 The following example shows how the input parameter C<timep> can be
 428 evaluated late, after a PREINIT.
 429
 430     bool_t
 431     rpcb_gettime(host,timep)
 432           char *host
 433           PREINIT:
 434           time_t tt;
 435           INPUT:
 436           time_t timep
 437           CODE:
 438                RETVAL = rpcb_gettime( host, &tt );
 439                timep = tt;
 440           OUTPUT:
 441           timep
 442           RETVAL
 443
 444 The next example shows each input parameter evaluated late.
 445
 446     bool_t
 447     rpcb_gettime(host,timep)
 448           PREINIT:
 449           time_t tt;
 450           INPUT:
 451           char *host
 452           PREINIT:
 453           char *h;
 454           INPUT:
 455           time_t timep
 456           CODE:
 457                h = host;
 458                RETVAL = rpcb_gettime( h, &tt );
 459                timep = tt;
 460           OUTPUT:
 461           timep
 462           RETVAL
 463
 464 =head2 Variable-length Parameter Lists
 465
 466 XSUBs can have variable-length parameter lists by specifying an ellipsis
 467 C<(...)> in the parameter list.  This use of the ellipsis is similar to that
 468 found in ANSI C.  The programmer is able to determine the number of
 469 arguments passed to the XSUB by examining the C<items> variable which the
 470 B<xsubpp> compiler supplies for all XSUBs.  By using this mechanism one can
 471 create an XSUB which accepts a list of parameters of unknown length.
 472
 473 The I<host> parameter for the rpcb_gettime() XSUB can be
 474 optional so the ellipsis can be used to indicate that the
 475 XSUB will take a variable number of parameters.  Perl should
 476 be able to call this XSUB with either of the following statements.
 477
 478      $status = rpcb_gettime( $timep, $host );
 479
 480      $status = rpcb_gettime( $timep );
 481
 482 The XS code, with ellipsis, follows.
 483
 484      bool_t
 485      rpcb_gettime(timep, ...)
 486           time_t timep = NO_INIT
 487           PREINIT:
 488           char *host = "localhost";
 489           CODE:
 490                   if( items > 1 )
 491                        host = (char *)SvPV(ST(1), na);
 492                   RETVAL = rpcb_gettime( host, &timep );
 493           OUTPUT:
 494           timep
 495           RETVAL
 496
 497 =head2 The PPCODE: Keyword
 498
 499 The PPCODE: keyword is an alternate form of the CODE: keyword and is used
 500 to tell the B<xsubpp> compiler that the programmer is supplying the code to
 501 control the argument stack for the XSUBs return values.  Occasionally one
 502 will want an XSUB to return a list of values rather than a single value.
 503 In these cases one must use PPCODE: and then explicitly push the list of
 504 values on the stack.  The PPCODE: and CODE:  keywords are not used
 505 together within the same XSUB.
 506
 507 The following XSUB will call the C rpcb_gettime() function
 508 and will return its two output values, timep and status, to
 509 Perl as a single list.
 510
 511      void
 512      rpcb_gettime(host)
 513           char *host
 514           PREINIT:
 515           time_t  timep;
 516           bool_t  status;
 517           PPCODE:
 518           status = rpcb_gettime( host, &timep );
 519           EXTEND(sp, 2);
 520           PUSHs(sv_2mortal(newSViv(status)));
 521           PUSHs(sv_2mortal(newSViv(timep)));
 522
 523 Notice that the programmer must supply the C code necessary
 524 to have the real rpcb_gettime() function called and to have
 525 the return values properly placed on the argument stack.
 526
 527 The C<void> return type for this function tells the B<xsubpp> compiler that
 528 the RETVAL variable is not needed or used and that it should not be created.
 529 In most scenarios the void return type should be used with the PPCODE:
 530 directive.
 531
 532 The EXTEND() macro is used to make room on the argument
 533 stack for 2 return values.  The PPCODE: directive causes the
 534 B<xsubpp> compiler to create a stack pointer called C<sp>, and it
 535 is this pointer which is being used in the EXTEND() macro.
 536 The values are then pushed onto the stack with the PUSHs()
 537 macro.
 538
 539 Now the rpcb_gettime() function can be used from Perl with
 540 the following statement.
 541
 542      ($status, $timep) = rpcb_gettime("localhost");
 543
 544 =head2 Returning Undef And Empty Lists
 545
 546 Occasionally the programmer will want to simply return
 547 C<undef> or an empty list if a function fails rather than a
 548 separate status value.  The rpcb_gettime() function offers
 549 just this situation.  If the function succeeds we would like
 550 to have it return the time and if it fails we would like to
 551 have undef returned.  In the following Perl code the value
 552 of $timep will either be undef or it will be a valid time.
 553
 554      $timep = rpcb_gettime( "localhost" );
 555
 556 The following XSUB uses the C<void> return type to disable the generation of
 557 the RETVAL variable and uses a CODE: block to indicate to the compiler
 558 that the programmer has supplied all the necessary code.  The
 559 sv_newmortal() call will initialize the return value to undef, making that
 560 the default return value.
 561
 562      void
 563      rpcb_gettime(host)
 564           char *  host
 565           PREINIT:
 566           time_t  timep;
 567           bool_t x;
 568           CODE:
 569           ST(0) = sv_newmortal();
 570           if( rpcb_gettime( host, &timep ) )
 571                sv_setnv( ST(0), (double)timep);
 572
 573 The next example demonstrates how one would place an explicit undef in the
 574 return value, should the need arise.
 575
 576      void
 577      rpcb_gettime(host)
 578           char *  host
 579           PREINIT:
 580           time_t  timep;
 581           bool_t x;
 582           CODE:
 583           ST(0) = sv_newmortal();
 584           if( rpcb_gettime( host, &timep ) ){
 585                sv_setnv( ST(0), (double)timep);
 586           }
 587           else{
 588                ST(0) = &sv_undef;
 589           }
 590
 591 To return an empty list one must use a PPCODE: block and
 592 then not push return values on the stack.
 593
 594      void
 595      rpcb_gettime(host)
 596           char *host
 597           PREINIT:
 598           time_t  timep;
 599           PPCODE:
 600           if( rpcb_gettime( host, &timep ) )
 601                PUSHs(sv_2mortal(newSViv(timep)));
 602           else{
 603           /* Nothing pushed on stack, so an empty */
 604           /* list is implicitly returned. */
 605           }
 606
 607 =head2 The REQUIRE: Keyword
 608
 609 The REQUIRE: keyword is used to indicate the minimum version of the
 610 B<xsubpp> compiler needed to compile the XS module.  An XS module which
 611 contains the following statement will only compile with B<xsubpp> version
 612 1.922 or greater:
 613
 614         REQUIRE: 1.922
 615
 616 =head2 The CLEANUP: Keyword
 617
 618 This keyword can be used when an XSUB requires special cleanup procedures
 619 before it terminates.  When the CLEANUP:  keyword is used it must follow
 620 any CODE:, PPCODE:, or OUTPUT: blocks which are present in the XSUB.  The
 621 code specified for the cleanup block will be added as the last statements
 622 in the XSUB.
 623
 624 =head2 The BOOT: Keyword
 625
 626 The BOOT: keyword is used to add code to the extension's bootstrap
 627 function.  The bootstrap function is generated by the B<xsubpp> compiler and
 628 normally holds the statements necessary to register any XSUBs with Perl.
 629 With the BOOT: keyword the programmer can tell the compiler to add extra
 630 statements to the bootstrap function.
 631
 632 This keyword may be used any time after the first MODULE keyword and should
 633 appear on a line by itself.  The first blank line after the keyword will
 634 terminate the code block.
 635
 636      BOOT:
 637      # The following message will be printed when the
 638      # bootstrap function executes.
 639      printf("Hello from the bootstrap!\n");
 640
 641 =head2 The VERSIONCHECK: Keyword
 642
 643 The VERSIONCHECK: keyword corresponds to B<xsubpp>'s C<-versioncheck> and
 644 C<-noversioncheck> options.  This keyword overrides the commandline
 645 options.  Version checking is enabled by default.  When version checking is
 646 enabled the XS module will attempt to verify that its version matches the
 647 version of the PM module.
 648
 649 To enable version checking:
 650
 651     VERSIONCHECK: ENABLE
 652
 653 To disable version checking:
 654
 655     VERSIONCHECK: DISABLE
 656
 657 =head2 The PROTOTYPES: Keyword
 658
 659 The PROTOTYPES: keyword corresponds to B<xsubpp>'s C<-prototypes> and
 660 C<-noprototypes> options.  This keyword overrides the commandline options.
 661 Prototypes are enabled by default.  When prototypes are enabled XSUBs will
 662 be given Perl prototypes.  This keyword may be used multiple times in an XS
 663 module to enable and disable prototypes for different parts of the module.
 664
 665 To enable prototypes:
 666
 667     PROTOTYPES: ENABLE
 668
 669 To disable prototypes:
 670
 671     PROTOTYPES: DISABLE
 672
 673 =head2 The PROTOTYPE: Keyword
 674
 675 This keyword is similar to the PROTOTYPES: keyword above but can be used to
 676 force B<xsubpp> to use a specific prototype for the XSUB.  This keyword
 677 overrides all other prototype options and keywords but affects only the
 678 current XSUB.  Consult L<perlsub/Prototypes> for information about Perl
 679 prototypes.
 680
 681     bool_t
 682     rpcb_gettime(timep, ...)
 683           time_t timep = NO_INIT
 684           PROTOTYPE: $;$
 685           PREINIT:
 686           char *host = "localhost";
 687           CODE:
 688                   if( items > 1 )
 689                        host = (char *)SvPV(ST(1), na);
 690                   RETVAL = rpcb_gettime( host, &timep );
 691           OUTPUT:
 692           timep
 693           RETVAL
 694
 695 =head2 The ALIAS: Keyword
 696
 697 The ALIAS: keyword allows an XSUB to have two more more unique Perl names
 698 and to know which of those names was used when it was invoked.  The Perl
 699 names may be fully-qualified with package names.  Each alias is given an
 700 index.  The compiler will setup a variable called C<ix> which contain the
 701 index of the alias which was used.  When the XSUB is called with its
 702 declared name C<ix> will be 0.
 703
 704 The following example will create aliases C<FOO::gettime()> and
 705 C<BAR::getit()> for this function.
 706
 707     bool_t
 708     rpcb_gettime(host,timep)
 709           char *host
 710           time_t &timep
 711           ALIAS:
 712             FOO::gettime = 1
 713             BAR::getit = 2
 714           INIT:
 715           printf("# ix = %d\n", ix );
 716           OUTPUT:
 717           timep
 718
 719 =head2 The INCLUDE: Keyword
 720
 721 This keyword can be used to pull other files into the XS module.  The other
 722 files may have XS code.  INCLUDE: can also be used to run a command to
 723 generate the XS code to be pulled into the module.
 724
 725 The file F<Rpcb1.xsh> contains our C<rpcb_gettime()> function:
 726
 727     bool_t
 728     rpcb_gettime(host,timep)
 729           char *host
 730           time_t &timep
 731           OUTPUT:
 732           timep
 733
 734 The XS module can use INCLUDE: to pull that file into it.
 735
 736     INCLUDE: Rpcb1.xsh
 737
 738 If the parameters to the INCLUDE: keyword are followed by a pipe (C<|>) then
 739 the compiler will interpret the parameters as a command.
 740
 741     INCLUDE: cat Rpcb1.xsh |
 742
 743 =head2 The CASE: Keyword
 744
 745 The CASE: keyword allows an XSUB to have multiple distinct parts with each
 746 part acting as a virtual XSUB.  CASE: is greedy and if it is used then all
 747 other XS keywords must be contained within a CASE:.  This means nothing may
 748 precede the first CASE: in the XSUB and anything following the last CASE: is
 749 included in that case.
 750
 751 A CASE: might switch via a parameter of the XSUB, via the C<ix> ALIAS:
 752 variable (see L<"The ALIAS: Keyword">), or maybe via the C<items> variable
 753 (see L<"Variable-length Parameter Lists">).  The last CASE: becomes the
 754 B<default> case if it is not associated with a conditional.  The following
 755 example shows CASE switched via C<ix> with a function C<rpcb_gettime()>
 756 having an alias C<x_gettime()>.  When the function is called as
 757 C<rpcb_gettime()> it's parameters are the usual C<(char *host, time_t
 758 *timep)>, but when the function is called as C<x_gettime()> is parameters are
 759 reversed, C<(time_t *timep, char *host)>.
 760
 761     long
 762     rpcb_gettime(a,b)
 763       CASE: ix == 1
 764           ALIAS:
 765           x_gettime = 1
 766           INPUT:
 767           # 'a' is timep, 'b' is host
 768           char *b
 769           time_t a = NO_INIT
 770           CODE:
 771                RETVAL = rpcb_gettime( b, &a );
 772           OUTPUT:
 773           a
 774           RETVAL
 775       CASE:
 776           # 'a' is host, 'b' is timep
 777           char *a
 778           time_t &b = NO_INIT
 779           OUTPUT:
 780           b
 781           RETVAL
 782
 783 That function can be called with either of the following statements.  Note
 784 the different argument lists.
 785
 786         $status = rpcb_gettime( $host, $timep );
 787
 788         $status = x_gettime( $timep, $host );
 789
 790 =head2 The & Unary Operator
 791
 792 The & unary operator is used to tell the compiler that it should dereference
 793 the object when it calls the C function.  This is used when a CODE: block is
 794 not used and the object is a not a pointer type (the object is an C<int> or
 795 C<long> but not a C<int*> or C<long*>).
 796
 797 The following XSUB will generate incorrect C code.  The xsubpp compiler will
 798 turn this into code which calls C<rpcb_gettime()> with parameters C<(char
 799 *host, time_t timep)>, but the real C<rpcb_gettime()> wants the C<timep>
 800 parameter to be of type C<time_t*> rather than C<time_t>.
 801
 802     bool_t
 803     rpcb_gettime(host,timep)
 804           char *host
 805           time_t timep
 806           OUTPUT:
 807           timep
 808
 809 That problem is corrected by using the C<&> operator.  The xsubpp compiler
 810 will now turn this into code which calls C<rpcb_gettime()> correctly with
 811 parameters C<(char *host, time_t *timep)>.  It does this by carrying the
 812 C<&> through, so the function call looks like C<rpcb_gettime(host, &timep)>.
 813
 814     bool_t
 815     rpcb_gettime(host,timep)
 816           char *host
 817           time_t &timep
 818           OUTPUT:
 819           timep
 820
 821 =head2 Inserting Comments and C Preprocessor Directives
 822
 823 Comments and C preprocessor directives are allowed within
 824 CODE:, PPCODE:, BOOT:, and CLEANUP: blocks.  The compiler
 825 will pass the preprocessor directives through untouched and
 826 will remove the commented lines.  Comments can be added to
 827 XSUBs by placing a C<#> at the beginning of the line.  Care
 828 should be taken to avoid making the comment look like a C
 829 preprocessor directive, lest it be interpreted as such.
 830
 831 =head2 Using XS With C++
 832
 833 If a function is defined as a C++ method then it will assume
 834 its first argument is an object pointer.  The object pointer
 835 will be stored in a variable called THIS.  The object should
 836 have been created by C++ with the new() function and should
 837 be blessed by Perl with the sv_setref_pv() macro.  The
 838 blessing of the object by Perl can be handled by a typemap.  An example
 839 typemap is shown at the end of this section.
 840
 841 If the method is defined as static it will call the C++
 842 function using the class::method() syntax.  If the method is not static
 843 the function will be called using the THIS->method() syntax.
 844
 845 The next examples will use the following C++ class.
 846
 847      class color {
 848           public:
 849           color();
 850           ~color();
 851           int blue();
 852           void set_blue( int );
 853
 854           private:
 855           int c_blue;
 856      };
 857
 858 The XSUBs for the blue() and set_blue() methods are defined with the class
 859 name but the parameter for the object (THIS, or "self") is implicit and is
 860 not listed.
 861
 862      int
 863      color::blue()
 864
 865      void
 866      color::set_blue( val )
 867           int val
 868
 869 Both functions will expect an object as the first parameter.  The xsubpp
 870 compiler will call that object C<THIS> and will use it to call the specified
 871 method.  So in the C++ code the blue() and set_blue() methods will be called
 872 in the following manner.
 873
 874      RETVAL = THIS->blue();
 875
 876      THIS->set_blue( val );
 877
 878 If the function's name is B<DESTROY> then the C++ C<delete> function will be
 879 called and C<THIS> will be given as its parameter.
 880
 881      void
 882      color::DESTROY()
 883
 884 The C++ code will call C<delete>.
 885
 886      delete THIS;
 887
 888 If the function's name is B<new> then the C++ C<new> function will be called
 889 to create a dynamic C++ object.  The XSUB will expect the class name, which
 890 will be kept in a variable called C<CLASS>, to be given as the first
 891 argument.
 892
 893      color *
 894      color::new()
 895
 896 The C++ code will call C<new>.
 897
 898         RETVAL = new color();
 899
 900 The following is an example of a typemap that could be used for this C++
 901 example.
 902
 903     TYPEMAP
 904     color *             O_OBJECT
 905
 906     OUTPUT
 907     # The Perl object is blessed into 'CLASS', which should be a
 908     # char* having the name of the package for the blessing.
 909     O_OBJECT
 910         sv_setref_pv( $arg, CLASS, (void*)$var );
 911
 912     INPUT
 913     O_OBJECT
 914         if( sv_isobject($arg) && (SvTYPE(SvRV($arg)) == SVt_PVMG) )
 915                 $var = ($type)SvIV((SV*)SvRV( $arg ));
 916         else{
 917                 warn( \"${Package}::$func_name() -- $var is not a blessed SV reference\" );
 918                 XSRETURN_UNDEF;
 919         }
 920
 921 =head2 Interface Strategy
 922
 923 When designing an interface between Perl and a C library a straight
 924 translation from C to XS is often sufficient.  The interface will often be
 925 very C-like and occasionally nonintuitive, especially when the C function
 926 modifies one of its parameters.  In cases where the programmer wishes to
 927 create a more Perl-like interface the following strategy may help to
 928 identify the more critical parts of the interface.
 929
 930 Identify the C functions which modify their parameters.  The XSUBs for
 931 these functions may be able to return lists to Perl, or may be
 932 candidates to return undef or an empty list in case of failure.
 933
 934 Identify which values are used by only the C and XSUB functions
 935 themselves.  If Perl does not need to access the contents of the value
 936 then it may not be necessary to provide a translation for that value
 937 from C to Perl.
 938
 939 Identify the pointers in the C function parameter lists and return
 940 values.  Some pointers can be handled in XS with the & unary operator on
 941 the variable name while others will require the use of the * operator on
 942 the type name.  In general it is easier to work with the & operator.
 943
 944 Identify the structures used by the C functions.  In many
 945 cases it may be helpful to use the T_PTROBJ typemap for
 946 these structures so they can be manipulated by Perl as
 947 blessed objects.
 948
 949 =head2 Perl Objects And C Structures
 950
 951 When dealing with C structures one should select either
 952 B<T_PTROBJ> or B<T_PTRREF> for the XS type.  Both types are
 953 designed to handle pointers to complex objects.  The
 954 T_PTRREF type will allow the Perl object to be unblessed
 955 while the T_PTROBJ type requires that the object be blessed.
 956 By using T_PTROBJ one can achieve a form of type-checking
 957 because the XSUB will attempt to verify that the Perl object
 958 is of the expected type.
 959
 960 The following XS code shows the getnetconfigent() function which is used
 961 with ONC+ TIRPC.  The getnetconfigent() function will return a pointer to a
 962 C structure and has the C prototype shown below.  The example will
 963 demonstrate how the C pointer will become a Perl reference.  Perl will
 964 consider this reference to be a pointer to a blessed object and will
 965 attempt to call a destructor for the object.  A destructor will be
 966 provided in the XS source to free the memory used by getnetconfigent().
 967 Destructors in XS can be created by specifying an XSUB function whose name
 968 ends with the word B<DESTROY>.  XS destructors can be used to free memory
 969 which may have been malloc'd by another XSUB.
 970
 971      struct netconfig *getnetconfigent(const char *netid);
 972
 973 A C<typedef> will be created for C<struct netconfig>.  The Perl
 974 object will be blessed in a class matching the name of the C
 975 type, with the tag C<Ptr> appended, and the name should not
 976 have embedded spaces if it will be a Perl package name.  The
 977 destructor will be placed in a class corresponding to the
 978 class of the object and the PREFIX keyword will be used to
 979 trim the name to the word DESTROY as Perl will expect.
 980
 981      typedef struct netconfig Netconfig;
 982
 983      MODULE = RPC  PACKAGE = RPC
 984
 985      Netconfig *
 986      getnetconfigent(netid)
 987           char *netid
 988
 989      MODULE = RPC  PACKAGE = NetconfigPtr  PREFIX = rpcb_
 990
 991      void
 992      rpcb_DESTROY(netconf)
 993           Netconfig *netconf
 994           CODE:
 995           printf("Now in NetconfigPtr::DESTROY\n");
 996           free( netconf );
 997
 998 This example requires the following typemap entry.  Consult the typemap
 999 section for more information about adding new typemaps for an extension.
1000
1001      TYPEMAP
1002      Netconfig *  T_PTROBJ
1003
1004 This example will be used with the following Perl statements.
1005
1006      use RPC;
1007      $netconf = getnetconfigent("udp");
1008
1009 When Perl destroys the object referenced by $netconf it will send the
1010 object to the supplied XSUB DESTROY function.  Perl cannot determine, and
1011 does not care, that this object is a C struct and not a Perl object.  In
1012 this sense, there is no difference between the object created by the
1013 getnetconfigent() XSUB and an object created by a normal Perl subroutine.
1014
1015 =head2 The Typemap
1016
1017 The typemap is a collection of code fragments which are used by the B<xsubpp>
1018 compiler to map C function parameters and values to Perl values.  The
1019 typemap file may consist of three sections labeled C<TYPEMAP>, C<INPUT>, and
1020 C<OUTPUT>.  The INPUT section tells the compiler how to translate Perl values
1021 into variables of certain C types.  The OUTPUT section tells the compiler
1022 how to translate the values from certain C types into values Perl can
1023 understand.  The TYPEMAP section tells the compiler which of the INPUT and
1024 OUTPUT code fragments should be used to map a given C type to a Perl value.
1025 Each of the sections of the typemap must be preceded by one of the TYPEMAP,
1026 INPUT, or OUTPUT keywords.
1027
1028 The default typemap in the C<ext> directory of the Perl source contains many
1029 useful types which can be used by Perl extensions.  Some extensions define
1030 additional typemaps which they keep in their own directory.  These
1031 additional typemaps may reference INPUT and OUTPUT maps in the main
1032 typemap.  The B<xsubpp> compiler will allow the extension's own typemap to
1033 override any mappings which are in the default typemap.
1034
1035 Most extensions which require a custom typemap will need only the TYPEMAP
1036 section of the typemap file.  The custom typemap used in the
1037 getnetconfigent() example shown earlier demonstrates what may be the typical
1038 use of extension typemaps.  That typemap is used to equate a C structure
1039 with the T_PTROBJ typemap.  The typemap used by getnetconfigent() is shown
1040 here.  Note that the C type is separated from the XS type with a tab and
1041 that the C unary operator C<*> is considered to be a part of the C type name.
1042
1043      TYPEMAP
1044      Netconfig *<tab>T_PTROBJ
1045
1046 =head1 EXAMPLES
1047
1048 File C<RPC.xs>: Interface to some ONC+ RPC bind library functions.
1049
1050      #include "EXTERN.h"
1051      #include "perl.h"
1052      #include "XSUB.h"
1053
1054      #include <rpc/rpc.h>
1055
1056      typedef struct netconfig Netconfig;
1057
1058      MODULE = RPC  PACKAGE = RPC
1059
1060      void
1061      rpcb_gettime(host="localhost")
1062           char *host
1063           PREINIT:
1064           time_t  timep;
1065           CODE:
1066           ST(0) = sv_newmortal();
1067           if( rpcb_gettime( host, &timep ) )
1068                sv_setnv( ST(0), (double)timep );
1069
1070      Netconfig *
1071      getnetconfigent(netid="udp")
1072           char *netid
1073
1074      MODULE = RPC  PACKAGE = NetconfigPtr  PREFIX = rpcb_
1075
1076      void
1077      rpcb_DESTROY(netconf)
1078           Netconfig *netconf
1079           CODE:
1080           printf("NetconfigPtr::DESTROY\n");
1081           free( netconf );
1082
1083 File C<typemap>: Custom typemap for RPC.xs.
1084
1085      TYPEMAP
1086      Netconfig *  T_PTROBJ
1087
1088 File C<RPC.pm>: Perl module for the RPC extension.
1089
1090      package RPC;
1091
1092      require Exporter;
1093      require DynaLoader;
1094      @ISA = qw(Exporter DynaLoader);
1095      @EXPORT = qw(rpcb_gettime getnetconfigent);
1096
1097      bootstrap RPC;
1098      1;
1099
1100 File C<rpctest.pl>: Perl test program for the RPC extension.
1101
1102      use RPC;
1103
1104      $netconf = getnetconfigent();
1105      $a = rpcb_gettime();
1106      print "time = $a\n";
1107      print "netconf = $netconf\n";
1108
1109      $netconf = getnetconfigent("tcp");
1110      $a = rpcb_gettime("poplar");
1111      print "time = $a\n";
1112      print "netconf = $netconf\n";
1113
1114
1115 =head1 XS VERSION
1116
1117 This document covers features supported by C<xsubpp> 1.933.
1118
1119 =head1 AUTHOR
1120
1121 Dean Roehrich F<E<lt>roehrich@cray.comE<gt>>
1122 Feb 13, 1996