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