CPAN is upstream for Time::Local again
[perl.git] / pod / perlxstut.pod
1 =head1 NAME
2
3 perlXStut - Tutorial for writing XSUBs
4
5 =head1 DESCRIPTION
6
7 This tutorial will educate the reader on the steps involved in creating
8 a Perl extension.  The reader is assumed to have access to L<perlguts>,
9 L<perlapi> and L<perlxs>.
10
11 This tutorial starts with very simple examples and becomes more complex,
12 with each new example adding new features.  Certain concepts may not be
13 completely explained until later in the tutorial in order to slowly ease
14 the reader into building extensions.
15
16 This tutorial was written from a Unix point of view.  Where I know them
17 to be otherwise different for other platforms (e.g. Win32), I will list
18 them.  If you find something that was missed, please let me know.
19
20 =head1 SPECIAL NOTES
21
22 =head2 make
23
24 This tutorial assumes that the make program that Perl is configured to
25 use is called C<make>.  Instead of running "make" in the examples that
26 follow, you may have to substitute whatever make program Perl has been
27 configured to use.  Running B<perl -V:make> should tell you what it is.
28
29 =head2 Version caveat
30
31 When writing a Perl extension for general consumption, one should expect that
32 the extension will be used with versions of Perl different from the
33 version available on your machine.  Since you are reading this document,
34 the version of Perl on your machine is probably 5.005 or later, but the users
35 of your extension may have more ancient versions.
36
37 To understand what kinds of incompatibilities one may expect, and in the rare
38 case that the version of Perl on your machine is older than this document,
39 see the section on "Troubleshooting these Examples" for more information.
40
41 If your extension uses some features of Perl which are not available on older
42 releases of Perl, your users would appreciate an early meaningful warning.
43 You would probably put this information into the F<README> file, but nowadays
44 installation of extensions may be performed automatically, guided by F<CPAN.pm>
45 module or other tools.
46
47 In MakeMaker-based installations, F<Makefile.PL> provides the earliest
48 opportunity to perform version checks.  One can put something like this
49 in F<Makefile.PL> for this purpose:
50
51     eval { require 5.007 }
52         or die <<EOD;
53     ############
54     ### This module uses frobnication framework which is not available before
55     ### version 5.007 of Perl.  Upgrade your Perl before installing Kara::Mba.
56     ############
57     EOD
58
59 =head2 Dynamic Loading versus Static Loading
60
61 It is commonly thought that if a system does not have the capability to
62 dynamically load a library, you cannot build XSUBs.  This is incorrect.
63 You I<can> build them, but you must link the XSUBs subroutines with the
64 rest of Perl, creating a new executable.  This situation is similar to
65 Perl 4.
66
67 This tutorial can still be used on such a system.  The XSUB build mechanism
68 will check the system and build a dynamically-loadable library if possible,
69 or else a static library and then, optionally, a new statically-linked
70 executable with that static library linked in.
71
72 Should you wish to build a statically-linked executable on a system which
73 can dynamically load libraries, you may, in all the following examples,
74 where the command "C<make>" with no arguments is executed, run the command
75 "C<make perl>" instead.
76
77 If you have generated such a statically-linked executable by choice, then
78 instead of saying "C<make test>", you should say "C<make test_static>".
79 On systems that cannot build dynamically-loadable libraries at all, simply
80 saying "C<make test>" is sufficient.
81
82 =head1 TUTORIAL
83
84 Now let's go on with the show!
85
86 =head2 EXAMPLE 1
87
88 Our first extension will be very simple.  When we call the routine in the
89 extension, it will print out a well-known message and return.
90
91 Run "C<h2xs -A -n Mytest>".  This creates a directory named Mytest,
92 possibly under ext/ if that directory exists in the current working
93 directory.  Several files will be created under the Mytest dir, including
94 MANIFEST, Makefile.PL, lib/Mytest.pm, Mytest.xs, t/Mytest.t, and Changes.
95
96 The MANIFEST file contains the names of all the files just created in the
97 Mytest directory.
98
99 The file Makefile.PL should look something like this:
100
101     use ExtUtils::MakeMaker;
102     # See lib/ExtUtils/MakeMaker.pm for details of how to influence
103     # the contents of the Makefile that is written.
104     WriteMakefile(
105         NAME         => 'Mytest',
106         VERSION_FROM => 'Mytest.pm', # finds $VERSION
107         LIBS         => [''],   # e.g., '-lm'
108         DEFINE       => '',     # e.g., '-DHAVE_SOMETHING'
109         INC          => '',     # e.g., '-I/usr/include/other'
110     );
111
112 The file Mytest.pm should start with something like this:
113
114     package Mytest;
115
116     use 5.008008;
117     use strict;
118     use warnings;
119
120     require Exporter;
121
122     our @ISA = qw(Exporter);
123     our %EXPORT_TAGS = ( 'all' => [ qw(
124
125     ) ] );
126
127     our @EXPORT_OK = ( @{ $EXPORT_TAGS{'all'} } );
128
129     our @EXPORT = qw(
130
131     );
132
133     our $VERSION = '0.01';
134
135     require XSLoader;
136     XSLoader::load('Mytest', $VERSION);
137
138     # Preloaded methods go here.
139
140     1;
141     __END__
142     # Below is the stub of documentation for your module. You better edit it!
143
144 The rest of the .pm file contains sample code for providing documentation for
145 the extension.
146
147 Finally, the Mytest.xs file should look something like this:
148
149     #include "EXTERN.h"
150     #include "perl.h"
151     #include "XSUB.h"
152
153     #include "ppport.h"
154
155     MODULE = Mytest             PACKAGE = Mytest
156
157 Let's edit the .xs file by adding this to the end of the file:
158
159     void
160     hello()
161         CODE:
162             printf("Hello, world!\n");
163
164 It is okay for the lines starting at the "CODE:" line to not be indented.
165 However, for readability purposes, it is suggested that you indent CODE:
166 one level and the lines following one more level.
167
168 Now we'll run "C<perl Makefile.PL>".  This will create a real Makefile,
169 which make needs.  Its output looks something like:
170
171     % perl Makefile.PL
172     Checking if your kit is complete...
173     Looks good
174     Writing Makefile for Mytest
175     %
176
177 Now, running make will produce output that looks something like this (some
178 long lines have been shortened for clarity and some extraneous lines have
179 been deleted):
180
181     % make
182     cp lib/Mytest.pm blib/lib/Mytest.pm
183     perl xsubpp  -typemap typemap  Mytest.xs > Mytest.xsc && mv Mytest.xsc Mytest.c
184     Please specify prototyping behavior for Mytest.xs (see perlxs manual)
185     cc -c     Mytest.c
186     Running Mkbootstrap for Mytest ()
187     chmod 644 Mytest.bs
188     rm -f blib/arch/auto/Mytest/Mytest.so
189     cc  -shared -L/usr/local/lib Mytest.o  -o blib/arch/auto/Mytest/Mytest.so   \
190                 \
191
192     chmod 755 blib/arch/auto/Mytest/Mytest.so
193     cp Mytest.bs blib/arch/auto/Mytest/Mytest.bs
194     chmod 644 blib/arch/auto/Mytest/Mytest.bs
195     Manifying blib/man3/Mytest.3pm
196     %
197
198 You can safely ignore the line about "prototyping behavior" - it is
199 explained in L<perlxs/"The PROTOTYPES: Keyword">.
200
201 Perl has its own special way of easily writing test scripts, but for this
202 example only, we'll create our own test script.  Create a file called hello
203 that looks like this:
204
205     #! /opt/perl5/bin/perl
206
207     use ExtUtils::testlib;
208
209     use Mytest;
210
211     Mytest::hello();
212
213 Now we make the script executable (C<chmod +x hello>), run the script
214 and we should see the following output:
215
216     % ./hello
217     Hello, world!
218     %
219
220 =head2 EXAMPLE 2
221
222 Now let's add to our extension a subroutine that will take a single numeric
223 argument as input and return 0 if the number is even or 1 if the number
224 is odd.
225
226 Add the following to the end of Mytest.xs:
227
228     int
229     is_even(input)
230             int input
231         CODE:
232             RETVAL = (input % 2 == 0);
233         OUTPUT:
234             RETVAL
235
236 There does not need to be whitespace at the start of the "C<int input>"
237 line, but it is useful for improving readability.  Placing a semi-colon at
238 the end of that line is also optional.  Any amount and kind of whitespace
239 may be placed between the "C<int>" and "C<input>".
240
241 Now re-run make to rebuild our new shared library.
242
243 Now perform the same steps as before, generating a Makefile from the
244 Makefile.PL file, and running make.
245
246 In order to test that our extension works, we now need to look at the
247 file Mytest.t.  This file is set up to imitate the same kind of testing
248 structure that Perl itself has.  Within the test script, you perform a
249 number of tests to confirm the behavior of the extension, printing "ok"
250 when the test is correct, "not ok" when it is not.
251
252     use Test::More tests => 4;
253     BEGIN { use_ok('Mytest') };
254
255     #########################
256
257     # Insert your test code below, the Test::More module is use()ed here so read
258     # its man page ( perldoc Test::More ) for help writing this test script.
259
260     is(&Mytest::is_even(0), 1);
261     is(&Mytest::is_even(1), 0);
262     is(&Mytest::is_even(2), 1);
263
264 We will be calling the test script through the command "C<make test>".  You
265 should see output that looks something like this:
266
267     %make test
268     PERL_DL_NONLAZY=1 /usr/bin/perl "-MExtUtils::Command::MM" "-e" "test_harness(0, 'blib/lib', 'blib/arch')" t/*.t
269     t/Mytest....ok
270     All tests successful.
271     Files=1, Tests=4,  0 wallclock secs ( 0.03 cusr +  0.00 csys =  0.03 CPU)
272     %
273
274 =head2 What has gone on?
275
276 The program h2xs is the starting point for creating extensions.  In later
277 examples we'll see how we can use h2xs to read header files and generate
278 templates to connect to C routines.
279
280 h2xs creates a number of files in the extension directory.  The file
281 Makefile.PL is a perl script which will generate a true Makefile to build
282 the extension.  We'll take a closer look at it later.
283
284 The .pm and .xs files contain the meat of the extension.  The .xs file holds
285 the C routines that make up the extension.  The .pm file contains routines
286 that tell Perl how to load your extension.
287
288 Generating the Makefile and running C<make> created a directory called blib
289 (which stands for "build library") in the current working directory.  This
290 directory will contain the shared library that we will build.  Once we have
291 tested it, we can install it into its final location.
292
293 Invoking the test script via "C<make test>" did something very important.
294 It invoked perl with all those C<-I> arguments so that it could find the
295 various files that are part of the extension.  It is I<very> important that
296 while you are still testing extensions that you use "C<make test>".  If you
297 try to run the test script all by itself, you will get a fatal error.
298 Another reason it is important to use "C<make test>" to run your test
299 script is that if you are testing an upgrade to an already-existing version,
300 using "C<make test>" ensures that you will test your new extension, not the
301 already-existing version.
302
303 When Perl sees a C<use extension;>, it searches for a file with the same name
304 as the C<use>'d extension that has a .pm suffix.  If that file cannot be found,
305 Perl dies with a fatal error.  The default search path is contained in the
306 C<@INC> array.
307
308 In our case, Mytest.pm tells perl that it will need the Exporter and Dynamic
309 Loader extensions.  It then sets the C<@ISA> and C<@EXPORT> arrays and the
310 C<$VERSION> scalar; finally it tells perl to bootstrap the module.  Perl
311 will call its dynamic loader routine (if there is one) and load the shared
312 library.
313
314 The two arrays C<@ISA> and C<@EXPORT> are very important.  The C<@ISA>
315 array contains a list of other packages in which to search for methods (or
316 subroutines) that do not exist in the current package.  This is usually
317 only important for object-oriented extensions (which we will talk about
318 much later), and so usually doesn't need to be modified.
319
320 The C<@EXPORT> array tells Perl which of the extension's variables and
321 subroutines should be placed into the calling package's namespace.  Because
322 you don't know if the user has already used your variable and subroutine
323 names, it's vitally important to carefully select what to export.  Do I<not>
324 export method or variable names I<by default> without a good reason.
325
326 As a general rule, if the module is trying to be object-oriented then don't
327 export anything.  If it's just a collection of functions and variables, then
328 you can export them via another array, called C<@EXPORT_OK>.  This array
329 does not automatically place its subroutine and variable names into the
330 namespace unless the user specifically requests that this be done.
331
332 See L<perlmod> for more information.
333
334 The C<$VERSION> variable is used to ensure that the .pm file and the shared
335 library are "in sync" with each other.  Any time you make changes to
336 the .pm or .xs files, you should increment the value of this variable.
337
338 =head2 Writing good test scripts
339
340 The importance of writing good test scripts cannot be over-emphasized.  You
341 should closely follow the "ok/not ok" style that Perl itself uses, so that
342 it is very easy and unambiguous to determine the outcome of each test case.
343 When you find and fix a bug, make sure you add a test case for it.
344
345 By running "C<make test>", you ensure that your Mytest.t script runs and uses
346 the correct version of your extension.  If you have many test cases,
347 save your test files in the "t" directory and use the suffix ".t".
348 When you run "C<make test>", all of these test files will be executed.
349
350 =head2 EXAMPLE 3
351
352 Our third extension will take one argument as its input, round off that
353 value, and set the I<argument> to the rounded value.
354
355 Add the following to the end of Mytest.xs:
356
357         void
358         round(arg)
359                 double  arg
360             CODE:
361                 if (arg > 0.0) {
362                         arg = floor(arg + 0.5);
363                 } else if (arg < 0.0) {
364                         arg = ceil(arg - 0.5);
365                 } else {
366                         arg = 0.0;
367                 }
368             OUTPUT:
369                 arg
370
371 Edit the Makefile.PL file so that the corresponding line looks like this:
372
373         'LIBS'      => ['-lm'],   # e.g., '-lm'
374
375 Generate the Makefile and run make.  Change the test number in Mytest.t to
376 "9" and add the following tests:
377
378         $i = -1.5; &Mytest::round($i); is( $i, -2.0 );
379         $i = -1.1; &Mytest::round($i); is( $i, -1.0 );
380         $i = 0.0; &Mytest::round($i);  is( $i,  0.0 );
381         $i = 0.5; &Mytest::round($i);  is( $i,  1.0 );
382         $i = 1.2; &Mytest::round($i);  is( $i,  1.0 );
383
384 Running "C<make test>" should now print out that all nine tests are okay.
385
386 Notice that in these new test cases, the argument passed to round was a
387 scalar variable.  You might be wondering if you can round a constant or
388 literal.  To see what happens, temporarily add the following line to Mytest.t:
389
390         &Mytest::round(3);
391
392 Run "C<make test>" and notice that Perl dies with a fatal error.  Perl won't
393 let you change the value of constants!
394
395 =head2 What's new here?
396
397 =over 4
398
399 =item *
400
401 We've made some changes to Makefile.PL.  In this case, we've specified an
402 extra library to be linked into the extension's shared library, the math
403 library libm in this case.  We'll talk later about how to write XSUBs that
404 can call every routine in a library.
405
406 =item *
407
408 The value of the function is not being passed back as the function's return
409 value, but by changing the value of the variable that was passed into the
410 function.  You might have guessed that when you saw that the return value
411 of round is of type "void".
412
413 =back
414
415 =head2 Input and Output Parameters
416
417 You specify the parameters that will be passed into the XSUB on the line(s)
418 after you declare the function's return value and name.  Each input parameter
419 line starts with optional whitespace, and may have an optional terminating
420 semicolon.
421
422 The list of output parameters occurs at the very end of the function, just
423 after the OUTPUT: directive.  The use of RETVAL tells Perl that you
424 wish to send this value back as the return value of the XSUB function.  In
425 Example 3, we wanted the "return value" placed in the original variable
426 which we passed in, so we listed it (and not RETVAL) in the OUTPUT: section.
427
428 =head2 The XSUBPP Program
429
430 The B<xsubpp> program takes the XS code in the .xs file and translates it into
431 C code, placing it in a file whose suffix is .c.  The C code created makes
432 heavy use of the C functions within Perl.
433
434 =head2 The TYPEMAP file
435
436 The B<xsubpp> program uses rules to convert from Perl's data types (scalar,
437 array, etc.) to C's data types (int, char, etc.).  These rules are stored
438 in the typemap file ($PERLLIB/ExtUtils/typemap).  This file is split into
439 three parts.
440
441 The first section maps various C data types to a name, which corresponds
442 somewhat with the various Perl types.  The second section contains C code
443 which B<xsubpp> uses to handle input parameters.  The third section contains
444 C code which B<xsubpp> uses to handle output parameters.
445
446 Let's take a look at a portion of the .c file created for our extension.
447 The file name is Mytest.c:
448
449         XS(XS_Mytest_round)
450         {
451             dXSARGS;
452             if (items != 1)
453                 Perl_croak(aTHX_ "Usage: Mytest::round(arg)");
454         PERL_UNUSED_VAR(cv); /* -W */
455             {
456                 double  arg = (double)SvNV(ST(0));      /* XXXXX */
457                 if (arg > 0.0) {
458                         arg = floor(arg + 0.5);
459                 } else if (arg < 0.0) {
460                         arg = ceil(arg - 0.5);
461                 } else {
462                         arg = 0.0;
463                 }
464                 sv_setnv(ST(0), (double)arg);   /* XXXXX */
465         SvSETMAGIC(ST(0));
466             }
467             XSRETURN_EMPTY;
468         }
469
470 Notice the two lines commented with "XXXXX".  If you check the first section
471 of the typemap file, you'll see that doubles are of type T_DOUBLE.  In the
472 INPUT section, an argument that is T_DOUBLE is assigned to the variable
473 arg by calling the routine SvNV on something, then casting it to double,
474 then assigned to the variable arg.  Similarly, in the OUTPUT section,
475 once arg has its final value, it is passed to the sv_setnv function to
476 be passed back to the calling subroutine.  These two functions are explained
477 in L<perlguts>; we'll talk more later about what that "ST(0)" means in the
478 section on the argument stack.
479
480 =head2 Warning about Output Arguments
481
482 In general, it's not a good idea to write extensions that modify their input
483 parameters, as in Example 3.  Instead, you should probably return multiple
484 values in an array and let the caller handle them (we'll do this in a later
485 example).  However, in order to better accommodate calling pre-existing C
486 routines, which often do modify their input parameters, this behavior is
487 tolerated.
488
489 =head2 EXAMPLE 4
490
491 In this example, we'll now begin to write XSUBs that will interact with
492 pre-defined C libraries.  To begin with, we will build a small library of
493 our own, then let h2xs write our .pm and .xs files for us.
494
495 Create a new directory called Mytest2 at the same level as the directory
496 Mytest.  In the Mytest2 directory, create another directory called mylib,
497 and cd into that directory.
498
499 Here we'll create some files that will generate a test library.  These will
500 include a C source file and a header file.  We'll also create a Makefile.PL
501 in this directory.  Then we'll make sure that running make at the Mytest2
502 level will automatically run this Makefile.PL file and the resulting Makefile.
503
504 In the mylib directory, create a file mylib.h that looks like this:
505
506         #define TESTVAL 4
507
508         extern double   foo(int, long, const char*);
509
510 Also create a file mylib.c that looks like this:
511
512         #include <stdlib.h>
513         #include "./mylib.h"
514
515         double
516         foo(int a, long b, const char *c)
517         {
518                 return (a + b + atof(c) + TESTVAL);
519         }
520
521 And finally create a file Makefile.PL that looks like this:
522
523         use ExtUtils::MakeMaker;
524         $Verbose = 1;
525         WriteMakefile(
526             NAME   => 'Mytest2::mylib',
527             SKIP   => [qw(all static static_lib dynamic dynamic_lib)],
528             clean  => {'FILES' => 'libmylib$(LIB_EXT)'},
529         );
530
531
532         sub MY::top_targets {
533                 '
534         all :: static
535
536         pure_all :: static
537
538         static ::       libmylib$(LIB_EXT)
539
540         libmylib$(LIB_EXT): $(O_FILES)
541                 $(AR) cr libmylib$(LIB_EXT) $(O_FILES)
542                 $(RANLIB) libmylib$(LIB_EXT)
543
544         ';
545         }
546
547 Make sure you use a tab and not spaces on the lines beginning with "$(AR)"
548 and "$(RANLIB)".  Make will not function properly if you use spaces.
549 It has also been reported that the "cr" argument to $(AR) is unnecessary
550 on Win32 systems.
551
552 We will now create the main top-level Mytest2 files.  Change to the directory
553 above Mytest2 and run the following command:
554
555         % h2xs -O -n Mytest2 ./Mytest2/mylib/mylib.h
556
557 This will print out a warning about overwriting Mytest2, but that's okay.
558 Our files are stored in Mytest2/mylib, and will be untouched.
559
560 The normal Makefile.PL that h2xs generates doesn't know about the mylib
561 directory.  We need to tell it that there is a subdirectory and that we
562 will be generating a library in it.  Let's add the argument MYEXTLIB to
563 the WriteMakefile call so that it looks like this:
564
565         WriteMakefile(
566             'NAME'      => 'Mytest2',
567             'VERSION_FROM' => 'Mytest2.pm', # finds $VERSION
568             'LIBS'      => [''],   # e.g., '-lm'
569             'DEFINE'    => '',     # e.g., '-DHAVE_SOMETHING'
570             'INC'       => '',     # e.g., '-I/usr/include/other'
571             'MYEXTLIB' => 'mylib/libmylib$(LIB_EXT)',
572         );
573
574 and then at the end add a subroutine (which will override the pre-existing
575 subroutine).  Remember to use a tab character to indent the line beginning
576 with "cd"!
577
578         sub MY::postamble {
579         '
580         $(MYEXTLIB): mylib/Makefile
581                 cd mylib && $(MAKE) $(PASSTHRU)
582         ';
583         }
584
585 Let's also fix the MANIFEST file so that it accurately reflects the contents
586 of our extension.  The single line that says "mylib" should be replaced by
587 the following three lines:
588
589         mylib/Makefile.PL
590         mylib/mylib.c
591         mylib/mylib.h
592
593 To keep our namespace nice and unpolluted, edit the .pm file and change
594 the variable C<@EXPORT> to C<@EXPORT_OK>.  Finally, in the
595 .xs file, edit the #include line to read:
596
597         #include "mylib/mylib.h"
598
599 And also add the following function definition to the end of the .xs file:
600
601         double
602         foo(a,b,c)
603                 int             a
604                 long            b
605                 const char *    c
606             OUTPUT:
607                 RETVAL
608
609 Now we also need to create a typemap file because the default Perl doesn't
610 currently support the const char * type.  Create a file called typemap in
611 the Mytest2 directory and place the following in it:
612
613         const char *    T_PV
614
615 Now run perl on the top-level Makefile.PL.  Notice that it also created a
616 Makefile in the mylib directory.  Run make and watch that it does cd into
617 the mylib directory and run make in there as well.
618
619 Now edit the Mytest2.t script and change the number of tests to "4",
620 and add the following lines to the end of the script:
621
622         is( &Mytest2::foo(1, 2, "Hello, world!"), 7 );
623         is( &Mytest2::foo(1, 2, "0.0"), 7 );
624         ok( abs(&Mytest2::foo(0, 0, "-3.4") - 0.6) <= 0.01 );
625
626 (When dealing with floating-point comparisons, it is best to not check for
627 equality, but rather that the difference between the expected and actual
628 result is below a certain amount (called epsilon) which is 0.01 in this case)
629
630 Run "C<make test>" and all should be well. There are some warnings on missing tests
631 for the Mytest2::mylib extension, but you can ignore them.
632
633 =head2 What has happened here?
634
635 Unlike previous examples, we've now run h2xs on a real include file.  This
636 has caused some extra goodies to appear in both the .pm and .xs files.
637
638 =over 4
639
640 =item *
641
642 In the .xs file, there's now a #include directive with the absolute path to
643 the mylib.h header file.  We changed this to a relative path so that we
644 could move the extension directory if we wanted to.
645
646 =item *
647
648 There's now some new C code that's been added to the .xs file.  The purpose
649 of the C<constant> routine is to make the values that are #define'd in the
650 header file accessible by the Perl script (by calling either C<TESTVAL> or
651 C<&Mytest2::TESTVAL>).  There's also some XS code to allow calls to the
652 C<constant> routine.
653
654 =item *
655
656 The .pm file originally exported the name C<TESTVAL> in the C<@EXPORT> array.
657 This could lead to name clashes.  A good rule of thumb is that if the #define
658 is only going to be used by the C routines themselves, and not by the user,
659 they should be removed from the C<@EXPORT> array.  Alternately, if you don't
660 mind using the "fully qualified name" of a variable, you could move most
661 or all of the items from the C<@EXPORT> array into the C<@EXPORT_OK> array.
662
663 =item *
664
665 If our include file had contained #include directives, these would not have
666 been processed by h2xs.  There is no good solution to this right now.
667
668 =item *
669
670 We've also told Perl about the library that we built in the mylib
671 subdirectory.  That required only the addition of the C<MYEXTLIB> variable
672 to the WriteMakefile call and the replacement of the postamble subroutine
673 to cd into the subdirectory and run make.  The Makefile.PL for the
674 library is a bit more complicated, but not excessively so.  Again we
675 replaced the postamble subroutine to insert our own code.  This code
676 simply specified that the library to be created here was a static archive
677 library (as opposed to a dynamically loadable library) and provided the
678 commands to build it.
679
680 =back
681
682 =head2 Anatomy of .xs file
683
684 The .xs file of L<"EXAMPLE 4"> contained some new elements.  To understand
685 the meaning of these elements, pay attention to the line which reads
686
687         MODULE = Mytest2                PACKAGE = Mytest2
688
689 Anything before this line is plain C code which describes which headers
690 to include, and defines some convenience functions.  No translations are
691 performed on this part, apart from having embedded POD documentation
692 skipped over (see L<perlpod>) it goes into the generated output C file as is.
693
694 Anything after this line is the description of XSUB functions.
695 These descriptions are translated by B<xsubpp> into C code which
696 implements these functions using Perl calling conventions, and which
697 makes these functions visible from Perl interpreter.
698
699 Pay a special attention to the function C<constant>.  This name appears
700 twice in the generated .xs file: once in the first part, as a static C
701 function, then another time in the second part, when an XSUB interface to
702 this static C function is defined.
703
704 This is quite typical for .xs files: usually the .xs file provides
705 an interface to an existing C function.  Then this C function is defined
706 somewhere (either in an external library, or in the first part of .xs file),
707 and a Perl interface to this function (i.e. "Perl glue") is described in the
708 second part of .xs file.  The situation in L<"EXAMPLE 1">, L<"EXAMPLE 2">,
709 and L<"EXAMPLE 3">, when all the work is done inside the "Perl glue", is
710 somewhat of an exception rather than the rule.
711
712 =head2 Getting the fat out of XSUBs
713
714 In L<"EXAMPLE 4"> the second part of .xs file contained the following
715 description of an XSUB:
716
717         double
718         foo(a,b,c)
719                 int             a
720                 long            b
721                 const char *    c
722             OUTPUT:
723                 RETVAL
724
725 Note that in contrast with L<"EXAMPLE 1">, L<"EXAMPLE 2"> and L<"EXAMPLE 3">,
726 this description does not contain the actual I<code> for what is done
727 is done during a call to Perl function foo().  To understand what is going
728 on here, one can add a CODE section to this XSUB:
729
730         double
731         foo(a,b,c)
732                 int             a
733                 long            b
734                 const char *    c
735             CODE:
736                 RETVAL = foo(a,b,c);
737             OUTPUT:
738                 RETVAL
739
740 However, these two XSUBs provide almost identical generated C code: B<xsubpp>
741 compiler is smart enough to figure out the C<CODE:> section from the first
742 two lines of the description of XSUB.  What about C<OUTPUT:> section?  In
743 fact, that is absolutely the same!  The C<OUTPUT:> section can be removed
744 as well, I<as far as C<CODE:> section or C<PPCODE:> section> is not
745 specified: B<xsubpp> can see that it needs to generate a function call
746 section, and will autogenerate the OUTPUT section too.  Thus one can
747 shortcut the XSUB to become:
748
749         double
750         foo(a,b,c)
751                 int             a
752                 long            b
753                 const char *    c
754
755 Can we do the same with an XSUB
756
757         int
758         is_even(input)
759                 int     input
760             CODE:
761                 RETVAL = (input % 2 == 0);
762             OUTPUT:
763                 RETVAL
764
765 of L<"EXAMPLE 2">?  To do this, one needs to define a C function C<int
766 is_even(int input)>.  As we saw in L<Anatomy of .xs file>, a proper place
767 for this definition is in the first part of .xs file.  In fact a C function
768
769         int
770         is_even(int arg)
771         {
772                 return (arg % 2 == 0);
773         }
774
775 is probably overkill for this.  Something as simple as a C<#define> will
776 do too:
777
778         #define is_even(arg)    ((arg) % 2 == 0)
779
780 After having this in the first part of .xs file, the "Perl glue" part becomes
781 as simple as
782
783         int
784         is_even(input)
785                 int     input
786
787 This technique of separation of the glue part from the workhorse part has
788 obvious tradeoffs: if you want to change a Perl interface, you need to
789 change two places in your code.  However, it removes a lot of clutter,
790 and makes the workhorse part independent from idiosyncrasies of Perl calling
791 convention.  (In fact, there is nothing Perl-specific in the above description,
792 a different version of B<xsubpp> might have translated this to TCL glue or
793 Python glue as well.)
794
795 =head2 More about XSUB arguments
796
797 With the completion of Example 4, we now have an easy way to simulate some
798 real-life libraries whose interfaces may not be the cleanest in the world.
799 We shall now continue with a discussion of the arguments passed to the
800 B<xsubpp> compiler.
801
802 When you specify arguments to routines in the .xs file, you are really
803 passing three pieces of information for each argument listed.  The first
804 piece is the order of that argument relative to the others (first, second,
805 etc).  The second is the type of argument, and consists of the type
806 declaration of the argument (e.g., int, char*, etc).  The third piece is
807 the calling convention for the argument in the call to the library function.
808
809 While Perl passes arguments to functions by reference,
810 C passes arguments by value; to implement a C function which modifies data
811 of one of the "arguments", the actual argument of this C function would be
812 a pointer to the data.  Thus two C functions with declarations
813
814         int string_length(char *s);
815         int upper_case_char(char *cp);
816
817 may have completely different semantics: the first one may inspect an array
818 of chars pointed by s, and the second one may immediately dereference C<cp>
819 and manipulate C<*cp> only (using the return value as, say, a success
820 indicator).  From Perl one would use these functions in
821 a completely different manner.
822
823 One conveys this info to B<xsubpp> by replacing C<*> before the
824 argument by C<&>.  C<&> means that the argument should be passed to a library
825 function by its address.  The above two function may be XSUB-ified as
826
827         int
828         string_length(s)
829                 char *  s
830
831         int
832         upper_case_char(cp)
833                 char    &cp
834
835 For example, consider:
836
837         int
838         foo(a,b)
839                 char    &a
840                 char *  b
841
842 The first Perl argument to this function would be treated as a char and assigned
843 to the variable a, and its address would be passed into the function foo.
844 The second Perl argument would be treated as a string pointer and assigned to the
845 variable b.  The I<value> of b would be passed into the function foo.  The
846 actual call to the function foo that B<xsubpp> generates would look like this:
847
848         foo(&a, b);
849
850 B<xsubpp> will parse the following function argument lists identically:
851
852         char    &a
853         char&a
854         char    & a
855
856 However, to help ease understanding, it is suggested that you place a "&"
857 next to the variable name and away from the variable type), and place a
858 "*" near the variable type, but away from the variable name (as in the
859 call to foo above).  By doing so, it is easy to understand exactly what
860 will be passed to the C function; it will be whatever is in the "last
861 column".
862
863 You should take great pains to try to pass the function the type of variable
864 it wants, when possible.  It will save you a lot of trouble in the long run.
865
866 =head2 The Argument Stack
867
868 If we look at any of the C code generated by any of the examples except
869 example 1, you will notice a number of references to ST(n), where n is
870 usually 0.  "ST" is actually a macro that points to the n'th argument
871 on the argument stack.  ST(0) is thus the first argument on the stack and
872 therefore the first argument passed to the XSUB, ST(1) is the second
873 argument, and so on.
874
875 When you list the arguments to the XSUB in the .xs file, that tells B<xsubpp>
876 which argument corresponds to which of the argument stack (i.e., the first
877 one listed is the first argument, and so on).  You invite disaster if you
878 do not list them in the same order as the function expects them.
879
880 The actual values on the argument stack are pointers to the values passed
881 in.  When an argument is listed as being an OUTPUT value, its corresponding
882 value on the stack (i.e., ST(0) if it was the first argument) is changed.
883 You can verify this by looking at the C code generated for Example 3.
884 The code for the round() XSUB routine contains lines that look like this:
885
886         double  arg = (double)SvNV(ST(0));
887         /* Round the contents of the variable arg */
888         sv_setnv(ST(0), (double)arg);
889
890 The arg variable is initially set by taking the value from ST(0), then is
891 stored back into ST(0) at the end of the routine.
892
893 XSUBs are also allowed to return lists, not just scalars.  This must be
894 done by manipulating stack values ST(0), ST(1), etc, in a subtly
895 different way.  See L<perlxs> for details.
896
897 XSUBs are also allowed to avoid automatic conversion of Perl function arguments
898 to C function arguments.  See L<perlxs> for details.  Some people prefer
899 manual conversion by inspecting C<ST(i)> even in the cases when automatic
900 conversion will do, arguing that this makes the logic of an XSUB call clearer.
901 Compare with L<"Getting the fat out of XSUBs"> for a similar tradeoff of
902 a complete separation of "Perl glue" and "workhorse" parts of an XSUB.
903
904 While experts may argue about these idioms, a novice to Perl guts may
905 prefer a way which is as little Perl-guts-specific as possible, meaning
906 automatic conversion and automatic call generation, as in
907 L<"Getting the fat out of XSUBs">.  This approach has the additional
908 benefit of protecting the XSUB writer from future changes to the Perl API.
909
910 =head2 Extending your Extension
911
912 Sometimes you might want to provide some extra methods or subroutines
913 to assist in making the interface between Perl and your extension simpler
914 or easier to understand.  These routines should live in the .pm file.
915 Whether they are automatically loaded when the extension itself is loaded
916 or only loaded when called depends on where in the .pm file the subroutine
917 definition is placed.  You can also consult L<AutoLoader> for an alternate
918 way to store and load your extra subroutines.
919
920 =head2 Documenting your Extension
921
922 There is absolutely no excuse for not documenting your extension.
923 Documentation belongs in the .pm file.  This file will be fed to pod2man,
924 and the embedded documentation will be converted to the manpage format,
925 then placed in the blib directory.  It will be copied to Perl's
926 manpage directory when the extension is installed.
927
928 You may intersperse documentation and Perl code within the .pm file.
929 In fact, if you want to use method autoloading, you must do this,
930 as the comment inside the .pm file explains.
931
932 See L<perlpod> for more information about the pod format.
933
934 =head2 Installing your Extension
935
936 Once your extension is complete and passes all its tests, installing it
937 is quite simple: you simply run "make install".  You will either need
938 to have write permission into the directories where Perl is installed,
939 or ask your system administrator to run the make for you.
940
941 Alternately, you can specify the exact directory to place the extension's
942 files by placing a "PREFIX=/destination/directory" after the make install.
943 (or in between the make and install if you have a brain-dead version of make).
944 This can be very useful if you are building an extension that will eventually
945 be distributed to multiple systems.  You can then just archive the files in
946 the destination directory and distribute them to your destination systems.
947
948 =head2 EXAMPLE 5
949
950 In this example, we'll do some more work with the argument stack.  The
951 previous examples have all returned only a single value.  We'll now
952 create an extension that returns an array.
953
954 This extension is very Unix-oriented (struct statfs and the statfs system
955 call).  If you are not running on a Unix system, you can substitute for
956 statfs any other function that returns multiple values, you can hard-code
957 values to be returned to the caller (although this will be a bit harder
958 to test the error case), or you can simply not do this example.  If you
959 change the XSUB, be sure to fix the test cases to match the changes.
960
961 Return to the Mytest directory and add the following code to the end of
962 Mytest.xs:
963
964         void
965         statfs(path)
966                 char *  path
967             INIT:
968                 int i;
969                 struct statfs buf;
970
971             PPCODE:
972                 i = statfs(path, &buf);
973                 if (i == 0) {
974                         XPUSHs(sv_2mortal(newSVnv(buf.f_bavail)));
975                         XPUSHs(sv_2mortal(newSVnv(buf.f_bfree)));
976                         XPUSHs(sv_2mortal(newSVnv(buf.f_blocks)));
977                         XPUSHs(sv_2mortal(newSVnv(buf.f_bsize)));
978                         XPUSHs(sv_2mortal(newSVnv(buf.f_ffree)));
979                         XPUSHs(sv_2mortal(newSVnv(buf.f_files)));
980                         XPUSHs(sv_2mortal(newSVnv(buf.f_type)));
981                 } else {
982                         XPUSHs(sv_2mortal(newSVnv(errno)));
983                 }
984
985 You'll also need to add the following code to the top of the .xs file, just
986 after the include of "XSUB.h":
987
988         #include <sys/vfs.h>
989
990 Also add the following code segment to Mytest.t while incrementing the "9"
991 tests to "11":
992
993         @a = &Mytest::statfs("/blech");
994         ok( scalar(@a) == 1 && $a[0] == 2 );
995         @a = &Mytest::statfs("/");
996         is( scalar(@a), 7 );
997
998 =head2 New Things in this Example
999
1000 This example added quite a few new concepts.  We'll take them one at a time.
1001
1002 =over 4
1003
1004 =item *
1005
1006 The INIT: directive contains code that will be placed immediately after
1007 the argument stack is decoded.  C does not allow variable declarations at
1008 arbitrary locations inside a function,
1009 so this is usually the best way to declare local variables needed by the XSUB.
1010 (Alternatively, one could put the whole C<PPCODE:> section into braces, and
1011 put these declarations on top.)
1012
1013 =item *
1014
1015 This routine also returns a different number of arguments depending on the
1016 success or failure of the call to statfs.  If there is an error, the error
1017 number is returned as a single-element array.  If the call is successful,
1018 then a 9-element array is returned.  Since only one argument is passed into
1019 this function, we need room on the stack to hold the 9 values which may be
1020 returned.
1021
1022 We do this by using the PPCODE: directive, rather than the CODE: directive.
1023 This tells B<xsubpp> that we will be managing the return values that will be
1024 put on the argument stack by ourselves.
1025
1026 =item *
1027
1028 When we want to place values to be returned to the caller onto the stack,
1029 we use the series of macros that begin with "XPUSH".  There are five
1030 different versions, for placing integers, unsigned integers, doubles,
1031 strings, and Perl scalars on the stack.  In our example, we placed a
1032 Perl scalar onto the stack.  (In fact this is the only macro which
1033 can be used to return multiple values.)
1034
1035 The XPUSH* macros will automatically extend the return stack to prevent
1036 it from being overrun.  You push values onto the stack in the order you
1037 want them seen by the calling program.
1038
1039 =item *
1040
1041 The values pushed onto the return stack of the XSUB are actually mortal SV's.
1042 They are made mortal so that once the values are copied by the calling
1043 program, the SV's that held the returned values can be deallocated.
1044 If they were not mortal, then they would continue to exist after the XSUB
1045 routine returned, but would not be accessible.  This is a memory leak.
1046
1047 =item *
1048
1049 If we were interested in performance, not in code compactness, in the success
1050 branch we would not use C<XPUSHs> macros, but C<PUSHs> macros, and would
1051 pre-extend the stack before pushing the return values:
1052
1053         EXTEND(SP, 7);
1054
1055 The tradeoff is that one needs to calculate the number of return values
1056 in advance (though overextending the stack will not typically hurt
1057 anything but memory consumption).
1058
1059 Similarly, in the failure branch we could use C<PUSHs> I<without> extending
1060 the stack: the Perl function reference comes to an XSUB on the stack, thus
1061 the stack is I<always> large enough to take one return value.
1062
1063 =back
1064
1065 =head2 EXAMPLE 6
1066
1067 In this example, we will accept a reference to an array as an input
1068 parameter, and return a reference to an array of hashes.  This will
1069 demonstrate manipulation of complex Perl data types from an XSUB.
1070
1071 This extension is somewhat contrived.  It is based on the code in
1072 the previous example.  It calls the statfs function multiple times,
1073 accepting a reference to an array of filenames as input, and returning
1074 a reference to an array of hashes containing the data for each of the
1075 filesystems.
1076
1077 Return to the Mytest directory and add the following code to the end of
1078 Mytest.xs:
1079
1080     SV *
1081     multi_statfs(paths)
1082             SV * paths
1083         INIT:
1084             AV * results;
1085             I32 numpaths = 0;
1086             int i, n;
1087             struct statfs buf;
1088
1089             if ((!SvROK(paths))
1090                 || (SvTYPE(SvRV(paths)) != SVt_PVAV)
1091                 || ((numpaths = av_len((AV *)SvRV(paths))) < 0))
1092             {
1093                 XSRETURN_UNDEF;
1094             }
1095             results = (AV *)sv_2mortal((SV *)newAV());
1096         CODE:
1097             for (n = 0; n <= numpaths; n++) {
1098                 HV * rh;
1099                 STRLEN l;
1100                 char * fn = SvPV(*av_fetch((AV *)SvRV(paths), n, 0), l);
1101
1102                 i = statfs(fn, &buf);
1103                 if (i != 0) {
1104                     av_push(results, newSVnv(errno));
1105                     continue;
1106                 }
1107
1108                 rh = (HV *)sv_2mortal((SV *)newHV());
1109
1110                 hv_store(rh, "f_bavail", 8, newSVnv(buf.f_bavail), 0);
1111                 hv_store(rh, "f_bfree",  7, newSVnv(buf.f_bfree),  0);
1112                 hv_store(rh, "f_blocks", 8, newSVnv(buf.f_blocks), 0);
1113                 hv_store(rh, "f_bsize",  7, newSVnv(buf.f_bsize),  0);
1114                 hv_store(rh, "f_ffree",  7, newSVnv(buf.f_ffree),  0);
1115                 hv_store(rh, "f_files",  7, newSVnv(buf.f_files),  0);
1116                 hv_store(rh, "f_type",   6, newSVnv(buf.f_type),   0);
1117
1118                 av_push(results, newRV((SV *)rh));
1119             }
1120             RETVAL = newRV((SV *)results);
1121         OUTPUT:
1122             RETVAL
1123
1124 And add the following code to Mytest.t, while incrementing the "11"
1125 tests to "13":
1126
1127         $results = Mytest::multi_statfs([ '/', '/blech' ]);
1128         ok( ref $results->[0]) );
1129         ok( ! ref $results->[1] );
1130
1131 =head2 New Things in this Example
1132
1133 There are a number of new concepts introduced here, described below:
1134
1135 =over 4
1136
1137 =item *
1138
1139 This function does not use a typemap.  Instead, we declare it as accepting
1140 one SV* (scalar) parameter, and returning an SV* value, and we take care of
1141 populating these scalars within the code.  Because we are only returning
1142 one value, we don't need a C<PPCODE:> directive - instead, we use C<CODE:>
1143 and C<OUTPUT:> directives.
1144
1145 =item *
1146
1147 When dealing with references, it is important to handle them with caution.
1148 The C<INIT:> block first checks that
1149 C<SvROK> returns true, which indicates that paths is a valid reference.  It
1150 then verifies that the object referenced by paths is an array, using C<SvRV>
1151 to dereference paths, and C<SvTYPE> to discover its type.  As an added test,
1152 it checks that the array referenced by paths is non-empty, using the C<av_len>
1153 function (which returns -1 if the array is empty).  The XSRETURN_UNDEF macro
1154 is used to abort the XSUB and return the undefined value whenever all three of
1155 these conditions are not met.
1156
1157 =item *
1158
1159 We manipulate several arrays in this XSUB.  Note that an array is represented
1160 internally by an AV* pointer.  The functions and macros for manipulating
1161 arrays are similar to the functions in Perl: C<av_len> returns the highest
1162 index in an AV*, much like $#array; C<av_fetch> fetches a single scalar value
1163 from an array, given its index; C<av_push> pushes a scalar value onto the
1164 end of the array, automatically extending the array as necessary.
1165
1166 Specifically, we read pathnames one at a time from the input array, and
1167 store the results in an output array (results) in the same order.  If
1168 statfs fails, the element pushed onto the return array is the value of
1169 errno after the failure.  If statfs succeeds, though, the value pushed
1170 onto the return array is a reference to a hash containing some of the
1171 information in the statfs structure.
1172
1173 As with the return stack, it would be possible (and a small performance win)
1174 to pre-extend the return array before pushing data into it, since we know
1175 how many elements we will return:
1176
1177         av_extend(results, numpaths);
1178
1179 =item *
1180
1181 We are performing only one hash operation in this function, which is storing
1182 a new scalar under a key using C<hv_store>.  A hash is represented by an HV*
1183 pointer.  Like arrays, the functions for manipulating hashes from an XSUB
1184 mirror the functionality available from Perl.  See L<perlguts> and L<perlapi>
1185 for details.
1186
1187 =item *
1188
1189 To create a reference, we use the C<newRV> function.  Note that you can
1190 cast an AV* or an HV* to type SV* in this case (and many others).  This
1191 allows you to take references to arrays, hashes and scalars with the same
1192 function.  Conversely, the C<SvRV> function always returns an SV*, which may
1193 need to be cast to the appropriate type if it is something other than a
1194 scalar (check with C<SvTYPE>).
1195
1196 =item *
1197
1198 At this point, xsubpp is doing very little work - the differences between
1199 Mytest.xs and Mytest.c are minimal.
1200
1201 =back
1202
1203 =head2 EXAMPLE 7 (Coming Soon)
1204
1205 XPUSH args AND set RETVAL AND assign return value to array
1206
1207 =head2 EXAMPLE 8 (Coming Soon)
1208
1209 Setting $!
1210
1211 =head2 EXAMPLE 9 Passing open files to XSes
1212
1213 You would think passing files to an XS is difficult, with all the
1214 typeglobs and stuff. Well, it isn't.
1215
1216 Suppose that for some strange reason we need a wrapper around the
1217 standard C library function C<fputs()>. This is all we need:
1218
1219         #define PERLIO_NOT_STDIO 0
1220         #include "EXTERN.h"
1221         #include "perl.h"
1222         #include "XSUB.h"
1223
1224         #include <stdio.h>
1225
1226         int
1227         fputs(s, stream)
1228                 char *          s
1229                 FILE *          stream
1230
1231 The real work is done in the standard typemap.
1232
1233 B<But> you loose all the fine stuff done by the perlio layers. This
1234 calls the stdio function C<fputs()>, which knows nothing about them.
1235
1236 The standard typemap offers three variants of PerlIO *:
1237 C<InputStream> (T_IN), C<InOutStream> (T_INOUT) and C<OutputStream>
1238 (T_OUT). A bare C<PerlIO *> is considered a T_INOUT. If it matters
1239 in your code (see below for why it might) #define or typedef
1240 one of the specific names and use that as the argument or result
1241 type in your XS file.
1242
1243 The standard typemap does not contain PerlIO * before perl 5.7,
1244 but it has the three stream variants. Using a PerlIO * directly
1245 is not backwards compatible unless you provide your own typemap.
1246
1247 For streams coming I<from> perl the main difference is that
1248 C<OutputStream> will get the output PerlIO * - which may make
1249 a difference on a socket. Like in our example...
1250
1251 For streams being handed I<to> perl a new file handle is created
1252 (i.e. a reference to a new glob) and associated with the PerlIO *
1253 provided. If the read/write state of the PerlIO * is not correct then you
1254 may get errors or warnings from when the file handle is used.
1255 So if you opened the PerlIO * as "w" it should really be an
1256 C<OutputStream> if open as "r" it should be an C<InputStream>.
1257
1258 Now, suppose you want to use perlio layers in your XS. We'll use the
1259 perlio C<PerlIO_puts()> function as an example.
1260
1261 In the C part of the XS file (above the first MODULE line) you
1262 have
1263
1264         #define OutputStream    PerlIO *
1265     or
1266         typedef PerlIO *        OutputStream;
1267
1268
1269 And this is the XS code:
1270
1271         int
1272         perlioputs(s, stream)
1273                 char *          s
1274                 OutputStream    stream
1275         CODE:
1276                 RETVAL = PerlIO_puts(stream, s);
1277         OUTPUT:
1278                 RETVAL
1279
1280 We have to use a C<CODE> section because C<PerlIO_puts()> has the arguments
1281 reversed compared to C<fputs()>, and we want to keep the arguments the same.
1282
1283 Wanting to explore this thoroughly, we want to use the stdio C<fputs()>
1284 on a PerlIO *. This means we have to ask the perlio system for a stdio
1285 C<FILE *>:
1286
1287         int
1288         perliofputs(s, stream)
1289                 char *          s
1290                 OutputStream    stream
1291         PREINIT:
1292                 FILE *fp = PerlIO_findFILE(stream);
1293         CODE:
1294                 if (fp != (FILE*) 0) {
1295                         RETVAL = fputs(s, fp);
1296                 } else {
1297                         RETVAL = -1;
1298                 }
1299         OUTPUT:
1300                 RETVAL
1301
1302 Note: C<PerlIO_findFILE()> will search the layers for a stdio
1303 layer. If it can't find one, it will call C<PerlIO_exportFILE()> to
1304 generate a new stdio C<FILE>. Please only call C<PerlIO_exportFILE()> if
1305 you want a I<new> C<FILE>. It will generate one on each call and push a
1306 new stdio layer. So don't call it repeatedly on the same
1307 file. C<PerlIO()>_findFILE will retrieve the stdio layer once it has been
1308 generated by C<PerlIO_exportFILE()>.
1309
1310 This applies to the perlio system only. For versions before 5.7,
1311 C<PerlIO_exportFILE()> is equivalent to C<PerlIO_findFILE()>.
1312
1313 =head2 Troubleshooting these Examples
1314
1315 As mentioned at the top of this document, if you are having problems with
1316 these example extensions, you might see if any of these help you.
1317
1318 =over 4
1319
1320 =item *
1321
1322 In versions of 5.002 prior to the gamma version, the test script in Example
1323 1 will not function properly.  You need to change the "use lib" line to
1324 read:
1325
1326         use lib './blib';
1327
1328 =item *
1329
1330 In versions of 5.002 prior to version 5.002b1h, the test.pl file was not
1331 automatically created by h2xs.  This means that you cannot say "make test"
1332 to run the test script.  You will need to add the following line before the
1333 "use extension" statement:
1334
1335         use lib './blib';
1336
1337 =item *
1338
1339 In versions 5.000 and 5.001, instead of using the above line, you will need
1340 to use the following line:
1341
1342         BEGIN { unshift(@INC, "./blib") }
1343
1344 =item *
1345
1346 This document assumes that the executable named "perl" is Perl version 5.
1347 Some systems may have installed Perl version 5 as "perl5".
1348
1349 =back
1350
1351 =head1 See also
1352
1353 For more information, consult L<perlguts>, L<perlapi>, L<perlxs>, L<perlmod>,
1354 and L<perlpod>.
1355
1356 =head1 Author
1357
1358 Jeff Okamoto <F<okamoto@corp.hp.com>>
1359
1360 Reviewed and assisted by Dean Roehrich, Ilya Zakharevich, Andreas Koenig,
1361 and Tim Bunce.
1362
1363 PerlIO material contributed by Lupe Christoph, with some clarification
1364 by Nick Ing-Simmons.
1365
1366 Changes for h2xs as of Perl 5.8.x by Renee Baecker
1367
1368 =head2 Last Changed
1369
1370 2007/10/11