mingw/html/ext/XS/Typemap/Typemap.html

   1 <?xml version="1.0" ?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5 <title>XS::Typemap - module to test the XS typemaps distributed with perl</title>
   6 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
   7 <link rev="made" href="mailto:" />
   8 </head>
   9
  10 <body style="background-color: white">
  11 <table border="0" width="100%" cellspacing="0" cellpadding="3">
  12 <tr><td class="block" style="background-color: #cccccc" valign="middle">
  13 <big><strong><span class="block">&nbsp;XS::Typemap - module to test the XS typemaps distributed with perl</span></strong></big>
  14 </td></tr>
  15 </table>
  16
  17 <p><a name="__index__"></a></p>
  18 <!-- INDEX BEGIN -->
  19
  20 <ul>
  21
  22         <li><a href="#name">NAME</a></li>
  23         <li><a href="#synopsis">SYNOPSIS</a></li>
  24         <li><a href="#description">DESCRIPTION</a></li>
  25         <li><a href="#notes">NOTES</a></li>
  26         <li><a href="#author">AUTHOR</a></li>
  27 </ul>
  28 <!-- INDEX END -->
  29
  30 <hr />
  31 <p>
  32 </p>
  33 <h1><a name="name">NAME</a></h1>
  34 <p>XS::Typemap - module to test the XS typemaps distributed with perl</p>
  35 <p>
  36 </p>
  37 <hr />
  38 <h1><a name="synopsis">SYNOPSIS</a></h1>
  39 <pre>
  40   use XS::Typemap;</pre>
  41 <pre>
  42   $output = T_IV( $input );
  43   $output = T_PV( $input );
  44   @output = T_ARRAY( @input );</pre>
  45 <p>
  46 </p>
  47 <hr />
  48 <h1><a name="description">DESCRIPTION</a></h1>
  49 <p>This module is used to test that the XS typemaps distributed
  50 with perl are working as advertised. A function is available
  51 for each typemap definition (eventually). In general each function
  52 takes a variable, processes it through the OUTPUT typemap and then
  53 returns it using the INPUT typemap.</p>
  54 <p>A test script can then compare the input and output to make sure they
  55 are the expected values. When only an input or output function is
  56 provided the function will be named after the typemap entry and have
  57 either '_IN' or '_OUT' appended.</p>
  58 <p>All the functions are exported. There is no reason not to do this since
  59 the entire purpose is for testing Perl. Namespace pollution will be limited
  60 to the test script.</p>
  61 <p>
  62 </p>
  63 <hr />
  64 <h1><a name="notes">NOTES</a></h1>
  65 <p>This module is for testing only and should not normally be installed.</p>
  66 <p>
  67 </p>
  68 <hr />
  69 <h1><a name="author">AUTHOR</a></h1>
  70 <p>Tim Jenness &lt;<a href="mailto:t.jenness@jach.hawaii.edu">t.jenness@jach.hawaii.edu</a>&gt;</p>
  71 <p>Copyright (C) 2001 Tim Jenness All Rights Reserved.  This program is
  72 free software; you can redistribute it and/or modify it under the same
  73 terms as Perl itself.</p>
  74 <table border="0" width="100%" cellspacing="0" cellpadding="3">
  75 <tr><td class="block" style="background-color: #cccccc" valign="middle">
  76 <big><strong><span class="block">&nbsp;XS::Typemap - module to test the XS typemaps distributed with perl</span></strong></big>
  77 </td></tr>
  78 </table>
  79
  80 </body>
  81
  82 </html>