xsubpp(1)
NAME
xsubpp - compiler to convert Perl XS code into C code
SYNOPSIS
xsubpp [-v] [-except] [-s pattern] [-prototypes] [-noversioncheck] [-nolinenumbers] [-nooptimize] [-typemap typemap] [-output filename]... file.xs
DESCRIPTION
This compiler is typically run by the makefiles created by
ExtUtils::MakeMaker or by Module::Build or other Perl module build
tools.
xsubpp will compile XS code into C code by embedding the constructs
necessary to let C functions manipulate Perl values and creates the
glue necessary to let Perl access those functions. The compiler uses
typemaps to determine how to map C function parameters and variables to
Perl values.
The compiler will search for typemap files called typemap. It will use
the following search path to find default typemaps, with the rightmost
typemap taking precedence.
../../../typemap:../../typemap:../typemap:typemap
It will also use a default typemap installed as "ExtUtils::typemap".
OPTIONS
Note that the "XSOPT" MakeMaker option may be used to add these options
to any makefiles generated by MakeMaker.
-hiertype
Retains '::' in type names so that C++ hierarchical types can be
mapped.
-except
Adds exception handling stubs to the C code.
-typemap typemap
Indicates that a user-supplied typemap should take precedence over
the default typemaps. This option may be used multiple times,
with the last typemap having the highest precedence.
-output filename
Specifies the name of the output file to generate. If no file is
specified, output will be written to standard output.
-v Prints the xsubpp version number to standard output, then exits.
-prototypes
By default xsubpp will not automatically generate prototype code
for all xsubs. This flag will enable prototypes.
-noversioncheck
Disables the run time test that determines if the object file
(derived from the ".xs" file) and the ".pm" files have the same
version number.
-nolinenumbers
Prevents the inclusion of '#line' directives in the output.
-nooptimize
Disables certain optimizations. The only optimization that is
currently affected is the use of targets by the output C code (see
perlguts). This may significantly slow down the generated code,
but this is the way xsubpp of 5.005 and earlier operated.
-noinout
Disable recognition of "IN", "OUT_LIST" and "INOUT_LIST"
declarations.
-noargtypes
Disable recognition of ANSI-like descriptions of function
signature.
-C++ Currently doesn't do anything at all. This flag has been a no-op
for many versions of perl, at least as far back as perl5.003_07.
It's allowed here for backwards compatibility.
-s=... or -strip=...
This option is obscure and discouraged.
If specified, the given string will be stripped off from the
beginning of the C function name in the generated XS functions (if
it starts with that prefix). This only applies to XSUBs without
"CODE" or "PPCODE" blocks. For example, the XS:
void foo_bar(int i);
when "xsubpp" is invoked with "-s foo_" will install a "foo_bar"
function in Perl, but really call bar(i) in C. Most of the time,
this is the opposite of what you want and failure modes are
somewhat obscure, so please avoid this option where possible.
ENVIRONMENT
No environment variables are used.
AUTHOR
Originally by Larry Wall. Turned into the "ExtUtils::ParseXS" module by Ken Williams.
MODIFICATION HISTORY
See the file Changes.
SEE ALSO
perl(1), perlxs(1), perlxstut(1), ExtUtils::ParseXS
Opportunity
Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.
Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.
Free Software
Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.
Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.
Free Books
The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.
Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.
Education
Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.
Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.
