xsubpp(1)

1XSUBPP(1)              Perl Programmers Reference Guide              XSUBPP(1)
2
3
4

NAME

6       xsubpp - compiler to convert Perl XS code into C code
7

SYNOPSIS

9       xsubpp [-v] [-except] [-s pattern] [-prototypes] [-noversioncheck]
10       [-nolinenumbers] [-nooptimize] [-typemap typemap] [-output filename]...
11       file.xs
12

DESCRIPTION

14       This compiler is typically run by the makefiles created by
15       ExtUtils::MakeMaker.
16
17       xsubpp will compile XS code into C code by embedding the constructs
18       necessary to let C functions manipulate Perl values and creates the
19       glue necessary to let Perl access those functions.  The compiler uses
20       typemaps to determine how to map C function parameters and variables to
21       Perl values.
22
23       The compiler will search for typemap files called typemap.  It will use
24       the following search path to find default typemaps, with the rightmost
25       typemap taking precedence.
26
27               ../../../typemap:../../typemap:../typemap:typemap
28
29       It will also use a default typemap installed as "ExtUtils::typemap".
30

OPTIONS

32       Note that the "XSOPT" MakeMaker option may be used to add these options
33       to any makefiles generated by MakeMaker.
34
35       -hiertype
36            Retains '::' in type names so that C++ hierarchical types can be
37            mapped.
38
39       -except
40            Adds exception handling stubs to the C code.
41
42       -typemap typemap
43            Indicates that a user-supplied typemap should take precedence over
44            the default typemaps.  This option may be used multiple times,
45            with the last typemap having the highest precedence.
46
47       -output filename
48            Specifies the name of the output file to generate.  If no file is
49            specified, output will be written to standard output.
50
51       -v   Prints the xsubpp version number to standard output, then exits.
52
53       -prototypes
54            By default xsubpp will not automatically generate prototype code
55            for all xsubs. This flag will enable prototypes.
56
57       -noversioncheck
58            Disables the run time test that determines if the object file
59            (derived from the ".xs" file) and the ".pm" files have the same
60            version number.
61
62       -nolinenumbers
63            Prevents the inclusion of `#line' directives in the output.
64
65       -nooptimize
66            Disables certain optimizations.  The only optimization that is
67            currently affected is the use of targets by the output C code (see
68            perlguts).  This may significantly slow down the generated code,
69            but this is the way xsubpp of 5.005 and earlier operated.
70
71       -noinout
72            Disable recognition of "IN", "OUT_LIST" and "INOUT_LIST"
73            declarations.
74
75       -noargtypes
76            Disable recognition of ANSI-like descriptions of function
77            signature.
78
79       -C++ Currently doesn't do anything at all.  This flag has been a no-op
80            for many versions of perl, at least as far back as perl5.003_07.
81            It's allowed here for backwards compatibility.
82

ENVIRONMENT

84       No environment variables are used.
85

AUTHOR

87       Originally by Larry Wall.  Turned into the "ExtUtils::ParseXS" module
88       by Ken Williams.
89

MODIFICATION HISTORY

91       See the file Changes.
92