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] [-C++] [-csuffix csuffix] [-except] [-s pattern] [-proto‐
10       types] [-noversioncheck] [-nolinenumbers] [-nooptimize] [-typemap
11       typemap] ... file.xs
12

DESCRIPTION

14       This compiler is typically run by the makefiles created by ExtU‐
15       tils::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

OPTIONS

30       Note that the "XSOPT" MakeMaker option may be used to add these options
31       to any makefiles generated by MakeMaker.
32
33       -C++ Adds ``extern "C"'' to the C code.
34
35       -csuffix csuffix
36            Set the suffix used for the generated C or C++ code.  Defaults to
37            '.c' (even with -C++), but some platforms might want to have e.g.
38            '.cpp'.  Don't forget the '.' from the front.
39
40       -hiertype
41            Retains '::' in type names so that C++ hierachical types can be
42            mapped.
43
44       -except
45            Adds exception handling stubs to the C code.
46
47       -typemap typemap
48            Indicates that a user-supplied typemap should take precedence over
49            the default typemaps.  This option may be used multiple times,
50            with the last typemap having the highest precedence.
51
52       -v   Prints the xsubpp version number to standard output, then exits.
53
54       -prototypes
55            By default xsubpp will not automatically generate prototype code
56            for all xsubs. This flag will enable prototypes.
57
58       -noversioncheck
59            Disables the run time test that determines if the object file
60            (derived from the ".xs" file) and the ".pm" files have the same
61            version number.
62
63       -nolinenumbers
64            Prevents the inclusion of `#line' directives in the output.
65
66       -nooptimize
67            Disables certain optimizations.  The only optimization that is
68            currently affected is the use of targets by the output C code (see
69            perlguts).  This may significantly slow down the generated code,
70            but this is the way xsubpp of 5.005 and earlier operated.
71
72       -noinout
73            Disable recognition of "IN", "OUT_LIST" and "INOUT_LIST" declara‐
74            tions.
75
76       -noargtypes
77            Disable recognition of ANSI-like descriptions of function signa‐
78            ture.
79

ENVIRONMENT

81       No environment variables are used.
82

AUTHOR

84       Larry Wall
85

MODIFICATION HISTORY

87       See the file changes.pod.
88