xsubpp - compiler to convert Perl XS code into C code
B<xsubpp> [B<-v>] [B<-C++>] [B<-csuffix csuffix>] [B<-except>] [B<-s pattern>] [B<-prototypes>] [B<-noversioncheck>] [B<-nolinenumbers>] [B<-nooptimize>] [B<-typemap typemap>] ... file.xs
This compiler is typically run by the makefiles created by L<ExtUtils::MakeMaker>.
I<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 I<typemap>. It will use
the following search path to find default typemaps, with the rightmost
typemap taking precedence.
../../../typemap:../../typemap:../typemap:typemap
Note that the C<XSOPT> MakeMaker option may be used to add these options to
any makefiles generated by MakeMaker.
Adds ``extern "C"'' to the C code.
=item B<-csuffix csuffix>
Set the suffix used for the generated C or C++ code. Defaults to '.c'
(even with B<-C++>), but some platforms might want to have e.g. '.cpp'.
Don't forget the '.' from the front.
Retains '::' in type names so that C++ hierachical types can be mapped.
Adds exception handling stubs to the C code.
=item B<-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.
Prints the I<xsubpp> version number to standard output, then exits.
By default I<xsubpp> will not automatically generate prototype code for
all xsubs. This flag will enable prototypes.
Disables the run time test that determines if the object file (derived
from the C<.xs> file) and the C<.pm> files have the same version
Prevents the inclusion of `#line' directives in the output.
Disables certain optimizations. The only optimization that is currently
affected is the use of I<target>s by the output C code (see L<perlguts>).
This may significantly slow down the generated code, but this is the way
B<xsubpp> of 5.005 and earlier operated.
Disable recognition of C<IN>, C<OUT_LIST> and C<INOUT_LIST> declarations.
Disable recognition of ANSI-like descriptions of function signature.
No environment variables are used.
=head1 MODIFICATION HISTORY
See the file F<changes.pod>.
perl(1), perlxs(1), perlxstut(1)
use vars qw($cplusplus $hiertype);
$XSUBPP_version = "1.9508";
# Establish set of global symbols with max length 28, since xsubpp
# will later add the 'XS_' prefix.
require ExtUtils::XSSymSet;
$SymSet = new ExtUtils::XSSymSet 28;
$usage = "Usage: xsubpp [-v] [-C++] [-csuffix csuffix] [-except] [-prototypes] [-noversioncheck] [-nolinenumbers] [-nooptimize] [-noinout] [-noargtypes] [-s pattern] [-typemap typemap]... file.xs\n";
$proto_re = "[" . quotemeta('\$%&*@;[]') . "]" ;
$Fallback = 'PL_sv_undef';
my $process_argtypes = 1;
SWITCH: while (@ARGV and $ARGV[0] =~ /^-./) {
$spat = quotemeta shift, next SWITCH if $flag eq 's';
$cplusplus = 1, next SWITCH if $flag eq 'C++';
$csuffix = shift, next SWITCH if $flag eq 'csuffix';
$hiertype = 1, next SWITCH if $flag eq 'hiertype';
$WantPrototypes = 0, next SWITCH if $flag eq 'noprototypes';
$WantPrototypes = 1, next SWITCH if $flag eq 'prototypes';
$WantVersionChk = 0, next SWITCH if $flag eq 'noversioncheck';
$WantVersionChk = 1, next SWITCH if $flag eq 'versioncheck';
# XXX left this in for compat
next SWITCH if $flag eq 'object_capi';
$except = " TRY", next SWITCH if $flag eq 'except';
push(@tm,shift), next SWITCH if $flag eq 'typemap';
$WantLineNumbers = 0, next SWITCH if $flag eq 'nolinenumbers';
$WantLineNumbers = 1, next SWITCH if $flag eq 'linenumbers';
$WantOptimize = 0, next SWITCH if $flag eq 'nooptimize';
$WantOptimize = 1, next SWITCH if $flag eq 'optimize';
$process_inout = 0, next SWITCH if $flag eq 'noinout';
$process_inout = 1, next SWITCH if $flag eq 'inout';
$process_argtypes = 0, next SWITCH if $flag eq 'noargtypes';
$process_argtypes = 1, next SWITCH if $flag eq 'argtypes';
(print "xsubpp version $XSUBPP_version\n"), exit
if ($WantPrototypes == -1)
@ARGV == 1 or die $usage;
($dir, $filename) = $ARGV[0] =~ m#(.*)/(.*)#
or ($dir, $filename) = $ARGV[0] =~ m#(.*)\\(.*)#
or ($dir, $filename) = $ARGV[0] =~ m#(.*[>\]])(.*)#
or ($dir, $filename) = ('.', $ARGV[0]);
++ $IncludedFiles{$ARGV[0]} ;
my(@XSStack) = ({type => 'none'}); # Stack of conditionals and INCLUDEs
my($XSS_work_idx, $cpp_next_tmp) = (0, "XSubPPtmpAAAA");
$_[0] =~ s/^\s+|\s+$//go ;
# rationalise any '*' by joining them into bunches and removing whitespace
# change multiple whitespace into a single space
# trim leading & trailing whitespace
die "Can't find $typemap in $pwd\n" unless -r $typemap;
unshift @tm, qw(../../../../lib/ExtUtils/typemap ../../../lib/ExtUtils/typemap
../../lib/ExtUtils/typemap ../../../typemap ../../typemap
next unless -f $typemap ;
# skip directories, binary files etc.
warn("Warning: ignoring non-text typemap file '$typemap'\n"), next
or warn ("Warning: could not open typemap file '$typemap': $!\n"), next;
if (/^INPUT\s*$/) { $mode = 'Input'; $current = \$junk; next; }
if (/^OUTPUT\s*$/) { $mode = 'Output'; $current = \$junk; next; }
if (/^TYPEMAP\s*$/) { $mode = 'Typemap'; $current = \$junk; next; }
if ($mode eq 'Typemap') {
# skip blank lines and comment lines
my($type,$kind, $proto) = /^\s*(.*?\S)\s+(\S+)\s*($proto_re*)\s*$/ or
warn("Warning: File '$typemap' Line $. '$line' TYPEMAP entry needs 2 or 3 columns\n"), next;
$type = TidyType($type) ;
$type_kind{$type} = $kind ;
# prototype defaults to '$'
$proto = "\$" unless $proto ;
warn("Warning: File '$typemap' Line $. '$line' Invalid prototype '$proto'\n")
unless ValidProtoString($proto) ;
$proto_letter{$type} = C_string($proto) ;
elsif ($mode eq 'Input') {
$current = \$input_expr{$_};
$current = \$output_expr{$_};
foreach $key (keys %input_expr) {
$input_expr{$key} =~ s/;*\s+\z//;
$bal = qr[(?:(?>[^()]+)|\((??{ $bal })\))*]; # ()-balanced
$cast = qr[(?:\(\s*SV\s*\*\s*\)\s*)?]; # Optional (SV*) cast
$size = qr[,\s* (??{ $bal }) ]x; # Third arg (to setpvn)
foreach $key (keys %output_expr) {
my ($t, $with_size, $arg, $sarg) =
m[^ \s+ sv_set ( [iunp] ) v (n)? # Type, is_setpvn
\s* \( \s* $cast \$arg \s* ,
\s* ( (??{ $bal }) ) # Set from
( (??{ $size }) )? # Possible sizeof set-from
$targetable{$key} = [$t, $with_size, $arg, $sarg] if $t;
$END = "!End!\n\n"; # "impossible" keyword (multiple newline)
$BLOCK_re= '\s*(' . join('|', qw(
REQUIRE BOOT CASE PREINIT INPUT INIT CODE PPCODE OUTPUT
CLEANUP ALIAS ATTRS PROTOTYPES PROTOTYPE VERSIONCHECK INCLUDE
SCOPE INTERFACE INTERFACE_MACRO C_ARGS POSTCALL OVERLOAD FALLBACK
# Input: ($_, @line) == unparsed input.
# Output: ($_, @line) == (rest of line, following lines).
# Return: the matched keyword if found, otherwise 0
$_ = shift(@line) while !/\S/ && @line;
s/^(\s*)($_[0])\s*:\s*(?:#.*)?/$1/s && $2;
my ($C_group_rex, $C_arg);
# Group in C (no support for comments or literals)
$C_group_rex = qr/ [({\[]
(?: (?> [^()\[\]{}]+ ) | (??{ $C_group_rex }) )*
# Chunk in C without comma at toplevel (no comments):
$C_arg = qr/ (?: (?> [^()\[\]{},"']+ )
| ' (?: (?> [^\\']+ ) | \\. )* ' # Char literal
my ($class, $cfile) = @_;
$SECTION_END_MARKER = "#line --- \"$cfile\"";
while ($$self =~ s/^([^\n]*\n)//) {
$line =~ s|^\#line\s+---(?=\s)|#line $line_no|;
$self->PRINT(sprintf($fmt, @_));
# Not necessary if we're careful to end with a "\n"
$cfile =~ s/\.xs$/$csuffix/i or $cfile .= $csuffix;
tie(*PSEUDO_STDOUT, 'xsubpp::counter', $cfile);
# the "do" is required for right semantics
do { $_ = shift(@line) } while !/\S/ && @line;
print("#line ", $line_no[@line_no - @line -1], " \"$filename\"\n")
if $WantLineNumbers && !/^\s*#\s*line\b/ && !/^#if XSubPPtmp/;
for (; defined($_) && !/^$BLOCK_re/o; $_ = shift(@line)) {
print "$xsubpp::counter::SECTION_END_MARKER\n" if $WantLineNumbers;
for (; defined($_) && !/^$BLOCK_re/o; $_ = shift(@line)) {
while $kwd = check_keyword($pattern) ;
blurt ("Error: `CASE:' after unconditional `CASE:'")
if $condnum && $cond eq '';
print " ", ($condnum++ ? " else" : ""), ($cond ? " if ($cond)\n" : "\n");
for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
last if /^\s*NOT_IMPLEMENTED_YET/;
next unless /\S/; # skip blank lines
# remove trailing semicolon if no initialisation
s/\s*;$//g unless /[=;+].*\S/ ;
# Process the length(foo) declarations
if (s/^([^=]*)\blength\(\s*(\w+)\s*\)\s*$/$1 XSauto_length_of_$2=NO_INIT/x) {
print "\tSTRLEN\tSTRLEN_length_of_$2;\n";
# $islengthof{$name} = $1;
$deferred .= "\n\tXSauto_length_of_$2 = STRLEN_length_of_$2;";
# check for optional initialisation code
$var_init = $1 if s/\s*([=;+].*)$//s ;
my ($var_type, $var_addr, $var_name) = /^(.*?[^&\s])\s*(\&?)\s*\b(\w+)$/s
or blurt("Error: invalid argument declaration '$line'"), next;
# Check for duplicate definitions
blurt ("Error: duplicate definition of argument '$var_name' ignored"), next
if $arg_list{$var_name}++
or defined $argtype_seen{$var_name} and not $processing_arg_with_types;
$thisdone |= $var_name eq "THIS";
$retvaldone |= $var_name eq "RETVAL";
$var_types{$var_name} = $var_type;
# XXXX This check is a safeguard against the unfinished conversion of
# generate_init(). When generate_init() is fixed,
# one can use 2-args map_type() unconditionally.
if ($var_type =~ / \( \s* \* \s* \) /x) {
# Function pointers are not yet supported with &output_init!
print "\t" . &map_type($var_type, $var_name);
print "\t" . &map_type($var_type);
$var_num = $args_match{$var_name};
$proto_arg[$var_num] = ProtoString($var_type)
$func_args =~ s/\b($var_name)\b/&$1/ if $var_addr;
if ($var_init =~ /^[=;]\s*NO_INIT\s*;?\s*$/
or $in_out{$var_name} and $in_out{$var_name} =~ /^OUT/
} elsif ($var_init =~ /\S/) {
&output_init($var_type, $var_num, $var_name, $var_init, $name_printed);
# generate initialization code
&generate_init($var_type, $var_num, $var_name, $name_printed);
for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
if (/^\s*SETMAGIC\s*:\s*(ENABLE|DISABLE)\s*/) {
$DoSetMagic = ($1 eq "ENABLE" ? 1 : 0);
my ($outarg, $outcode) = /^\s*(\S+)\s*(.*?)\s*$/s ;
blurt ("Error: duplicate OUTPUT argument '$outarg' ignored"), next
if $outargs{$outarg} ++ ;
if (!$gotRETVAL and $outarg eq 'RETVAL') {
$RETVAL_code = $outcode ;
blurt ("Error: OUTPUT $outarg not an argument"), next
unless defined($args_match{$outarg});
blurt("Error: No input definition for OUTPUT argument '$outarg' - ignored"), next
unless defined $var_types{$outarg} ;
$var_num = $args_match{$outarg};
print "\tSvSETMAGIC(ST(" , $var_num-1 , "));\n" if $DoSetMagic;
&generate_output($var_types{$outarg}, $var_num, $outarg, $DoSetMagic);
delete $in_out{$outarg} # No need to auto-OUTPUT
if exists $in_out{$outarg} and $in_out{$outarg} =~ /OUT$/;
my $in = merge_section();
sub INTERFACE_MACRO_handler() {
my $in = merge_section();
($interface_macro, $interface_macro_set) = split ' ', $in;
$interface_macro_set = 'UNKNOWN_CVT'; # catch later
$Interfaces = 1; # global
sub INTERFACE_handler() {
my $in = merge_section();
foreach (split /[\s,]+/, $in) {
# XSFUNCTION = $interface_macro($ret_type,cv,XSANY.any_dptr);
$Interfaces = 1; # global
sub CLEANUP_handler() { print_section() }
sub PREINIT_handler() { print_section() }
sub POSTCALL_handler() { print_section() }
sub INIT_handler() { print_section() }
# Parse alias definitions
# alias = value alias = value ...
while ($line =~ s/^\s*([\w:]+)\s*=\s*(\w+)\s*//) {
# check for optional package definition in the alias
$alias = $Packprefix . $alias if $alias !~ /::/ ;
# check for duplicate alias name & duplicate value
Warn("Warning: Ignoring duplicate alias '$orig_alias'")
if defined $XsubAliases{$alias} ;
Warn("Warning: Aliases '$orig_alias' and '$XsubAliasValues{$value}' have identical values")
if $XsubAliasValues{$value} ;
$XsubAliases{$alias} = $value ;
$XsubAliasValues{$value} = $orig_alias ;
blurt("Error: Cannot parse ALIAS definitions from '$orig'")
for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
while ( s/^\s*([\w:"\\)\+\-\*\/\%\<\>\.\&\|\^\!\~\{\}\=]+)\s*//) {
$Overload = 1 unless $Overload;
my $overload = "$Package\::(".$1 ;
" newXS(\"$overload\", XS_$Full_func_name, file$proto);\n");
# the rest of the current line should contain either TRUE,
TRUE => "PL_sv_yes", 1 => "PL_sv_yes",
FALSE => "PL_sv_no", 0 => "PL_sv_no",
# check for valid FALLBACK value
death ("Error: FALLBACK: TRUE/FALSE/UNDEF") unless exists $map{uc $_} ;
$Fallback = $map{uc $_} ;
# the rest of the current line should contain a version number
death ("Error: REQUIRE expects a version number")
# check that the version number is of the form n.n
death ("Error: REQUIRE: expected a number, got '$Ver'")
unless $Ver =~ /^\d+(\.\d*)?/ ;
death ("Error: xsubpp $Ver (or better) required--this is only $XSUBPP_version.")
unless $XSUBPP_version >= $Ver ;
sub VERSIONCHECK_handler ()
# the rest of the current line should contain either ENABLE or
# check for ENABLE/DISABLE
death ("Error: VERSIONCHECK: ENABLE/DISABLE")
unless /^(ENABLE|DISABLE)/i ;
$WantVersionChk = 1 if $1 eq 'ENABLE' ;
$WantVersionChk = 0 if $1 eq 'DISABLE' ;
death("Error: Only 1 PROTOTYPE definition allowed per xsub")
if $proto_in_this_xsub ++ ;
for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
death("Error: Invalid prototype '$_'")
unless ValidProtoString($_) ;
$ProtoThisXSUB = C_string($_) ;
# If no prototype specified, then assume empty prototype ""
$ProtoThisXSUB = 2 unless $specified ;
death("Error: Only 1 SCOPE declaration allowed per xsub")
if $scope_in_this_xsub ++ ;
for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
elsif ($_ =~ /^ENABLE/i) {
sub PROTOTYPES_handler ()
# the rest of the current line should contain either ENABLE or
# check for ENABLE/DISABLE
death ("Error: PROTOTYPES: ENABLE/DISABLE")
unless /^(ENABLE|DISABLE)/i ;
$WantPrototypes = 1 if $1 eq 'ENABLE' ;
$WantPrototypes = 0 if $1 eq 'DISABLE' ;
# the rest of the current line should contain a valid filename
death("INCLUDE: filename missing")
death("INCLUDE: output pipe is illegal")
# simple minded recursion detector
death("INCLUDE loop detected")
++ $IncludedFiles{$_} unless /\|\s*$/ ;
# Save the current file context.
LastLineNo => $lastline_no,
open ($FH, "$_") or death("Cannot open '$_': $!") ;
#/* INCLUDE: Including '$_' from '$filename' */
# Prime the pump by reading the first
# skip leading blank lines
return 0 unless $XSStack[-1]{type} eq 'file' ;
my $data = pop @XSStack ;
my $ThisFile = $filename ;
my $isPipe = ($filename =~ /\|\s*$/) ;
-- $IncludedFiles{$filename}
$filename = $data->{Filename} ;
$lastline = $data->{LastLine} ;
$lastline_no = $data->{LastLineNo} ;
@line = @{ $data->{Line} } ;
@line_no = @{ $data->{LineNo} } ;
print STDERR "Error reading from pipe '$ThisFile': $! in $filename, line $lastline_no\n" ;
#/* INCLUDE: Returning to '$filename' from '$ThisFile' */
if ( $string =~ /^$proto_re+$/ ) {
$string =~ s[\\][\\\\]g ;
$proto_letter{$type} or "\$" ;
my @cpp = grep(/^\#\s*(?:if|e\w+)/, @line);
if ($cpp =~ /^\#\s*if/) {
Warn("Warning: #else/elif/endif without #if in this function");
print STDERR " (precede it with a blank line if the matching #if is outside the function)\n"
if $XSStack[-1]{type} eq 'if';
} elsif ($cpp =~ /^\#\s*endif/) {
Warn("Warning: #if without #endif in this function") if $cpplevel;
open($FH, $filename) or die "cannot open $filename: $!\n";
# Identify the version of xsubpp used
* This file was generated automatically by xsubpp version $XSUBPP_version from the
* contents of $filename. Do not edit this file, edit $filename instead.
* ANY CHANGES MADE HERE WILL BE LOST!
print("#line 1 \"$filename\"\n")
# We can't just write out a /* */ comment, as our embedded
# POD might itself be in a comment. We can't put a /**/
# comment inside #if 0, as the C standard says that the source
# file is decomposed into preprocessing characters in the stage
# before preprocessing commands are executed.
# I don't want to leave the text as barewords, because the spec
# isn't clear whether macros are expanded before or after
# preprocessing commands are executed, and someone pathological
# may just have defined one of the 3 words as a macro that does
# something strange. Multiline strings are illegal in C, so
# the "" we write must be a string literal. And they aren't
# concatenated until 2 steps later, so we are safe.
print("#if 0\n \"Skipped embedded POD.\"\n#endif\n");
printf("#line %d \"$filename\"\n", $. + 1)
# At this point $. is at end of file so die won't state the start
# of the problem, and as we haven't yet read any lines &death won't
# show the correct line in the message either.
die ("Error: Unterminated pod in $filename, line $podstartline\n")
last if ($Module, $Package, $Prefix) =
/^MODULE\s*=\s*([\w:]+)(?:\s+PACKAGE\s*=\s*([\w:]+))?(?:\s+PREFIX\s*=\s*(\S+))?\s*$/;
print "$xsubpp::counter::SECTION_END_MARKER\n" if $WantLineNumbers;
# Read next xsub into @line from ($lastline, <$FH>).
death ("Error: Unterminated `#if/#ifdef/#ifndef'")
if !defined $lastline && $XSStack[-1]{type} eq 'if';
return PopFile() if !defined $lastline;
/^MODULE\s*=\s*([\w:]+)(?:\s+PACKAGE\s*=\s*([\w:]+))?(?:\s+PREFIX\s*=\s*(\S+))?\s*$/) {
$Package = defined($2) ? $2 : ''; # keep -w happy
$Prefix = defined($3) ? $3 : ''; # keep -w happy
$Prefix = quotemeta $Prefix ;
($Module_cname = $Module) =~ s/\W/_/g;
($Packid = $Package) =~ tr/:/_/;
$Packprefix .= "::" if $Packprefix ne "";
while ($lastline =~ /^=/) {
while ($lastline = <$FH>) {
last if ($lastline =~ /^=cut\s*$/);
death ("Error: Unterminated pod") unless $lastline;
if ($lastline !~ /^\s*#/ ||
# ANSI: if ifdef ifndef elif else endif define undef
# gcc: warning include_next
# others: ident (gcc notes that some cpps have this one)
$lastline =~ /^#[ \t]*(?:(?:if|ifn?def|elif|else|endif|define|undef|pragma|error|warning|line\s+\d+|ident)\b|(?:include(?:_next)?|import)\s*["<].*[>"])/) {
last if $lastline =~ /^\S/ && @line && $line[-1] eq "";
push(@line_no, $lastline_no) ;
# Read next line and continuation lines
last unless defined($lastline = <$FH>);
while ($lastline =~ /\\$/ && defined($tmp_line = <$FH>));
pop(@line), pop(@line_no) while @line && $line[-1] eq "";
# Print initial preprocessor statements and blank lines
while (@line && $line[0] !~ /^[^\#]/) {
next unless $line =~ /^\#\s*((if)(?:n?def)?|elsif|else|endif)\b/;
if ($statement eq 'if') {
$XSS_work_idx = @XSStack;
push(@XSStack, {type => 'if'});
death ("Error: `$statement' with no matching `if'")
if $XSStack[-1]{type} ne 'if';
if ($XSStack[-1]{varname}) {
push(@InitFileCode, "#endif\n");
push(@BootCode, "#endif");
my(@fns) = keys %{$XSStack[-1]{functions}};
if ($statement ne 'endif') {
# Hide the functions defined in other #if branches, and reset.
@{$XSStack[-1]{other_functions}}{@fns} = (1) x @fns;
@{$XSStack[-1]}{qw(varname functions)} = ('', {});
my($tmp) = pop(@XSStack);
&& $XSStack[$XSS_work_idx]{type} ne 'if');
# Keep all new defined functions
push(@fns, keys %{$tmp->{other_functions}});
@{$XSStack[$XSS_work_idx]{functions}}{@fns} = (1) x @fns;
next PARAGRAPH unless @line;
if ($XSS_work_idx && !$XSStack[$XSS_work_idx]{varname}) {
# We are inside an #if, but have not yet #defined its xsubpp variable.
print "#define $cpp_next_tmp 1\n\n";
push(@InitFileCode, "#if $cpp_next_tmp\n");
push(@BootCode, "#if $cpp_next_tmp");
$XSStack[$XSS_work_idx]{varname} = $cpp_next_tmp++;
death ("Code is not inside a function"
." (maybe last function was ended by a blank line "
." followed by a statement on column one?)")
undef($RETVAL_no_return) ;
undef(@fake_INPUT_pre) ; # For length(s) generated variables
undef($processing_arg_with_types) ;
undef($proto_in_this_xsub) ;
undef($scope_in_this_xsub) ;
$interface_macro = 'XSINTERFACE_FUNC' ;
$interface_macro_set = 'XSINTERFACE_FUNC_SET' ;
$ProtoThisXSUB = $WantPrototypes ;
while ($kwd = check_keyword("REQUIRE|PROTOTYPES|FALLBACK|VERSIONCHECK|INCLUDE")) {
next PARAGRAPH unless @line ;
if (check_keyword("BOOT")) {
push (@BootCode, "#line $line_no[@line_no - @line] \"$filename\"")
if $WantLineNumbers && $line[0] !~ /^\s*#\s*line\b/;
push (@BootCode, @line, "") ;
# extract return type, function name and arguments
($ret_type) = TidyType($_);
$RETVAL_no_return = 1 if $ret_type =~ s/^NO_OUTPUT\s+//;
# Allow one-line ANSI-like declaration
and $ret_type =~ s/^(.*?\w.*?)\s*\b(\w+\s*\(.*)/$1/s;
# a function definition needs at least 2 lines
blurt ("Error: Function definition too short '$ret_type'"), next PARAGRAPH
$externC = 1 if $ret_type =~ s/^extern "C"\s+//;
$static = 1 if $ret_type =~ s/^static\s+//;
$func_header = shift(@line);
blurt ("Error: Cannot parse function definition from '$func_header'"), next PARAGRAPH
unless $func_header =~ /^(?:([\w:]*)::)?(\w+)\s*\(\s*(.*?)\s*\)\s*(const)?\s*(;\s*)?$/s;
($class, $func_name, $orig_args) = ($1, $2, $3) ;
$class = "$4 $class" if $4;
($pname = $func_name) =~ s/^($Prefix)?/$Packprefix/;
($clean_func_name = $func_name) =~ s/^$Prefix//;
$Full_func_name = "${Packid}_$clean_func_name";
if ($Is_VMS) { $Full_func_name = $SymSet->addsym($Full_func_name); }
# Check for duplicate function definition
next unless defined $tmp->{functions}{$Full_func_name};
Warn("Warning: duplicate function definition '$clean_func_name' detected");
$XSStack[$XSS_work_idx]{functions}{$Full_func_name} ++ ;
%XsubAliases = %XsubAliasValues = %Interfaces = @Attributes = ();
$orig_args =~ s/\\\s*/ /g; # process line continuations
my %only_C_inlist; # Not in the signature of Perl function
if ($process_argtypes and $orig_args =~ /\S/) {
my $args = "$orig_args ,";
if ($args =~ /^( (??{ $C_arg }) , )* $ /x) {
@args = ($args =~ /\G ( (??{ $C_arg }) ) , /xg);
my ($arg, $default) = / ( [^=]* ) ( (?: = .* )? ) /x;
my ($pre, $name) = ($arg =~ /(.*?) \s*
\b ( \w+ | length\( \s*\w+\s* \) )
if ($process_inout and s/^(IN|IN_OUTLIST|OUTLIST|OUT|IN_OUT)\s+//) {
$out_type = $type if $type ne 'IN';
$arg =~ s/^(IN|IN_OUTLIST|OUTLIST|OUT|IN_OUT)\s+//;
$pre =~ s/^(IN|IN_OUTLIST|OUTLIST|OUT|IN_OUT)\s+//;
if ($name =~ /^length\( \s* (\w+) \s* \)\z/x) {
$name = "XSauto_length_of_$1";
die "Default value on length() argument: `$_'"
if (length $pre or $islength) { # Has a type
push @fake_INPUT_pre, $arg;
# warn "pushing '$arg'\n";
$_ = "$name$default"; # Assigns to @args
$only_C_inlist{$_} = 1 if $out_type eq "OUTLIST" or $islength;
push @outlist, $name if $out_type =~ /OUTLIST$/;
$in_out{$name} = $out_type if $out_type;
@args = split(/\s*,\s*/, $orig_args);
Warn("Warning: cannot parse argument list '$orig_args', fallback to split");
@args = split(/\s*,\s*/, $orig_args);
if ($process_inout and s/^(IN|IN_OUTLIST|OUTLIST|IN_OUT|OUT)\s+//) {
next if $out_type eq 'IN';
$only_C_inlist{$_} = 1 if $out_type eq "OUTLIST";
push @outlist, $name if $out_type =~ /OUTLIST$/;
my $arg0 = ((defined($static) or $func_name eq 'new')
($report_args = "$arg0, $report_args") =~ s/^\w+, $/$arg0/;
foreach $i (0 .. $#args) {
if ($args[$i] =~ s/\.\.\.//) {
if ($args[$i] eq '' && $i == $#args) {
if ($only_C_inlist{$args[$i]}) {
push @args_num, ++$num_args;
$report_args .= ", $args[$i]";
if ($args[$i] =~ /^([^=]*[^\s=])\s*=\s*(.*)/s) {
$defaults{$args[$i]} = $2;
$defaults{$args[$i]} =~ s/"/\\"/g;
$proto_arg[$i+1] = "\$" ;
$min_args = $num_args - $extra_args;
$report_args =~ s/"/\\"/g;
$report_args =~ s/^,\s+//;
shift @func_args if defined($class);
$func_args = join(", ", @func_args);
@args_match{@args} = @args_num;
$PPCODE = grep(/^\s*PPCODE\s*:/, @line);
$CODE = grep(/^\s*CODE\s*:/, @line);
# Detect CODE: blocks which use ST(n)= or XST_m*(n,v)
# to set explicit return values.
$EXPLICIT_RETURN = ($CODE &&
("@line" =~ /(\bST\s*\([^;]*=) | (\bXST_m\w+\s*\()/x ));
$ALIAS = grep(/^\s*ALIAS\s*:/, @line);
$INTERFACE = grep(/^\s*INTERFACE\s*:/, @line);
$xsreturn = 1 if $EXPLICIT_RETURN;
$externC = $externC ? qq[extern "C"] : "";
#XS(XS_${Full_func_name}); /* prototype to pass -Wmissing-prototypes */
#XS(XS_${Full_func_name})
print Q<<"EOF" if $ALIAS ;
print Q<<"EOF" if $INTERFACE ;
# dXSFUNCTION($ret_type);
$cond = ($min_args ? qq(items < $min_args) : 0);
elsif ($min_args == $num_args) {
$cond = qq(items != $min_args);
$cond = qq(items < $min_args || items > $num_args);
print Q<<"EOF" if $except;
{ print Q<<"EOF" if $cond }
# Perl_croak(aTHX_ "Usage: %s($report_args)", GvNAME(CvGV(cv)));
{ print Q<<"EOF" if $cond }
# Perl_croak(aTHX_ "Usage: $pname($report_args)");
#gcc -Wall: if an xsub has no arguments and PPCODE is used
#it is likely none of ST, XSRETURN or XSprePUSH macros are used
#hence `ax' (setup by dXSARGS) is unused
#XXX: could breakup the dXSARGS; into dSP;dMARK;dITEMS
#but such a move could break third-party extensions
print Q<<"EOF" if $PPCODE and $num_args == 0;
# PERL_UNUSED_VAR(ax); /* -Wall */
print Q<<"EOF" if $PPCODE;
# Now do a block of some sort.
$cond = ''; # last CASE: condidional
push(@line_no, $line_no[-1]);
&CASE_handler if check_keyword("CASE");
# do initialization of input variables
process_keyword("INPUT|PREINIT|INTERFACE_MACRO|C_ARGS|ALIAS|ATTRS|PROTOTYPE|SCOPE|OVERLOAD") ;
print Q<<"EOF" if $ScopeThisXSUB;
if (!$thisdone && defined($class)) {
if (defined($static) or $func_name eq 'new') {
$var_types{"CLASS"} = "char *";
&generate_init("char *", 1, "CLASS");
$var_types{"THIS"} = "$class *";
&generate_init("$class *", 1, "THIS");
if (/^\s*NOT_IMPLEMENTED_YET/) {
print "\n\tPerl_croak(aTHX_ \"$pname: not implemented yet\");\n";
if ($ret_type ne "void") {
print "\t" . &map_type($ret_type, 'RETVAL') . ";\n"
$args_match{"RETVAL"} = 0;
$var_types{"RETVAL"} = $ret_type;
if $WantOptimize and $targetable{$type_kind{$ret_type}};
if (@fake_INPUT or @fake_INPUT_pre) {
unshift @line, @fake_INPUT_pre, @fake_INPUT, $_;
$processing_arg_with_types = 1;
process_keyword("INIT|ALIAS|ATTRS|PROTOTYPE|INTERFACE_MACRO|INTERFACE|C_ARGS|OVERLOAD") ;
if (check_keyword("PPCODE")) {
death ("PPCODE must be last thing") if @line;
print "\tLEAVE;\n" if $ScopeThisXSUB;
print "\tPUTBACK;\n\treturn;\n";
} elsif (check_keyword("CODE")) {
} elsif (defined($class) and $func_name eq "DESTROY") {
if ($ret_type ne "void") {
if ($func_name eq 'new') {
} elsif (defined($class)) {
if ($func_name eq 'new') {
$func_name =~ s/^($spat)//
$func_name = 'XSFUNCTION' if $interface;
print "$func_name($func_args);\n";
$gotRETVAL = 0; # 1 if RETVAL seen in OUTPUT section;
undef $RETVAL_code ; # code to set RETVAL (from OUTPUT section);
# $wantRETVAL set if 'RETVAL =' autogenerated
($wantRETVAL, $ret_type) = (0, 'void') if $RETVAL_no_return;
process_keyword("POSTCALL|OUTPUT|ALIAS|ATTRS|PROTOTYPE|OVERLOAD");
&generate_output($var_types{$_}, $args_match{$_}, $_, $DoSetMagic)
for grep $in_out{$_} =~ /OUT$/, keys %in_out;
# all OUTPUT done, so now push the return value on the stack
if ($gotRETVAL && $RETVAL_code) {
print "\t$RETVAL_code\n";
} elsif ($gotRETVAL || $wantRETVAL) {
my $t = $WantOptimize && $targetable{$type_kind{$ret_type}};
# 0: type, 1: with_size, 2: how, 3: how_size
if ($t and not $t->[1] and $t->[0] eq 'p') {
# PUSHp corresponds to setpvn. Treate setpv directly
my $what = eval qq("$t->[2]");
print "\tsv_setpv(TARG, $what); XSprePUSH; PUSHTARG;\n";
my $what = eval qq("$t->[2]");
$size = '' unless defined $size;
$size = eval qq("$size");
print "\tXSprePUSH; PUSH$t->[0]($what$size);\n";
# RETVAL almost never needs SvSETMAGIC()
&generate_output($ret_type, 0, 'RETVAL', 0);
$xsreturn = 1 if $ret_type ne "void";
# (PP)CODE set different values of SP; reset to PPCODE's with 0 output
print "\tXSprePUSH;" if $c and not $prepush_done;
# Take into account stuff already put on stack
print "\t++SP;" if $c and not $prepush_done and $xsreturn;
# Now SP corresponds to ST($xsreturn), so one can combine PUSH and ST()
print "\tEXTEND(SP,$c);\n" if $c;
generate_output($var_types{$_}, $num++, $_, 0, 1) for @outlist;
process_keyword("CLEANUP|ALIAS|ATTRS|PROTOTYPE|OVERLOAD") ;
print Q<<"EOF" if $ScopeThisXSUB;
print Q<<"EOF" if $ScopeThisXSUB and not $PPCODE;
# sprintf(errbuf, "%s: %s\\tpropagated", Xname, Xreason);
if (check_keyword("CASE")) {
blurt ("Error: No `CASE:' at top of function")
$_ = "CASE: $_"; # Restore CASE: label
death(/^$BLOCK_re/o ? "Misplaced `$1:'" : "Junk at end of function");
# Perl_croak(aTHX_ errbuf);
print Q<<EOF unless $PPCODE;
print Q<<EOF unless $PPCODE;
# Build the prototype string for the xsub
if ($ProtoThisXSUB eq 2) {
# User has specified empty prototype
elsif ($ProtoThisXSUB ne 1) {
# User has specified a prototype
$proto = ', "' . $ProtoThisXSUB . '"';
if ($min_args < $num_args) {
$proto_arg[$min_args] .= ";" ;
$proto = ', "' . join ("", @proto_arg) . '"';
unless defined $XsubAliases{$pname} ;
while ( ($name, $value) = each %XsubAliases) {
push(@InitFileCode, Q<<"EOF");
# cv = newXS(\"$name\", XS_$Full_func_name, file);
# XSANY.any_i32 = $value ;
push(@InitFileCode, Q<<"EOF") if $proto;
# sv_setpv((SV*)cv$proto) ;
push(@InitFileCode, Q<<"EOF");
# cv = newXS(\"$pname\", XS_$Full_func_name, file);
# apply_attrs_string("$Package", cv, "@Attributes", 0);
while ( ($name, $value) = each %Interfaces) {
$name = "$Package\::$name" unless $name =~ /::/;
push(@InitFileCode, Q<<"EOF");
# cv = newXS(\"$name\", XS_$Full_func_name, file);
# $interface_macro_set(cv,$value) ;
push(@InitFileCode, Q<<"EOF") if $proto;
# sv_setpv((SV*)cv$proto) ;
" ${newXS}(\"$pname\", XS_$Full_func_name, file$proto);\n");
if ($Overload) # make it findable with fetchmethod
#XS(XS_${Packid}_nil); /* prototype to pass -Wmissing-prototypes */
unshift(@InitFileCode, <<"MAKE_FETCHMETHOD_WORK");
/* Making a sub named "${Package}::()" allows the package */
/* to be findable via fetchmethod(), and causes */
/* overload::Overloaded("${Package}") to return true. */
newXS("${Package}::()", XS_${Packid}_nil, file$proto);
# print initialization routine
#XS(boot_$Module_cname); /* prototype to pass -Wmissing-prototypes */
#-Wall: if there is no $Full_func_name there are no xsubs in this .xs
print Q<<"EOF" if $Full_func_name;
print Q<<"EOF" if $WantVersionChk ;
print Q<<"EOF" if defined $XsubAliases or defined $Interfaces ;
print Q<<"EOF" if ($Overload);
# /* register the overloading (type 'A') magic */
# PL_amagic_generation++;
# /* The magic for overload gets a GV* via gv_fetchmeth as */
# /* mentioned above, and looks in the SV* slot of it for */
# /* the "fallback" status. */
# get_sv( "${Package}::()", TRUE ),
print Q<<"EOF" if defined $XsubAliases or defined $Interfaces ;
print "\n /* Initialisation Section */\n\n" ;
print "\n /* End of Initialisation Section */\n\n" ;
warn("Please specify prototyping behavior for $filename (see perlxs manual)\n")
local($type, $num, $var, $init, $name_printed) = @_;
local($arg) = "ST(" . ($num - 1) . ")";
eval qq/print " $init\\n"/;
eval qq/print "\\t$var $init\\n"/;
if( $init =~ s/^\+// && $num ) {
&generate_init($type, $num, $var, $name_printed);
} elsif ($name_printed) {
eval qq/print "\\t$var;\\n"/;
$deferred .= eval qq/"\\n\\t$init\\n"/;
# work out the line number
my $line_no = $line_no[@line_no - @line -1] ;
print STDERR "@_ in $filename, line $line_no\n" ;
local($type, $num, $var) = @_;
local($arg) = "ST(" . ($num - 1) . ")";
local($argoff) = $num - 1;
$type = TidyType($type) ;
blurt("Error: '$type' not in typemap"), return
unless defined($type_kind{$type});
($ntype = $type) =~ s/\s*\*/Ptr/g;
($subtype = $ntype) =~ s/(?:Array)?(?:Ptr)?$//;
$tk =~ s/OBJ$/REF/ if $func_name =~ /DESTROY$/;
if ($tk eq 'T_PV' and exists $lengthof{$var}) {
print "\t$var" unless $name_printed;
print " = ($type)SvPV($arg, STRLEN_length_of_$var);\n";
die "default value not supported with length(NAME) supplied"
if defined $defaults{$var};
$type =~ tr/:/_/ unless $hiertype;
blurt("Error: No INPUT definition for type '$type', typekind '$type_kind{$type}' found"), return
unless defined $input_expr{$tk} ;
$expr = $input_expr{$tk};
if ($expr =~ /DO_ARRAY_ELEM/) {
blurt("Error: '$subtype' not in typemap"), return
unless defined($type_kind{$subtype});
blurt("Error: No INPUT definition for type '$subtype', typekind '$type_kind{$subtype}' found"), return
unless defined $input_expr{$type_kind{$subtype}} ;
$subexpr = $input_expr{$type_kind{$subtype}};
$subexpr =~ s/\$type/\$subtype/g;
$subexpr =~ s/ntype/subtype/g;
$subexpr =~ s/\$arg/ST(ix_$var)/g;
$subexpr =~ s/\n\t/\n\t\t/g;
$subexpr =~ s/is not of (.*\")/[arg %d] is not of $1, ix_$var + 1/g;
$subexpr =~ s/\$var/${var}[ix_$var - $argoff]/;
$expr =~ s/DO_ARRAY_ELEM/$subexpr/;
if ($expr =~ m#/\*.*scope.*\*/#i) { # "scope" in C comments
if (defined($defaults{$var})) {
eval qq/print "\\t$var;\\n"/;
if ($defaults{$var} eq 'NO_INIT') {
$deferred .= eval qq/"\\n\\tif (items >= $num) {\\n$expr;\\n\\t}\\n"/;
$deferred .= eval qq/"\\n\\tif (items < $num)\\n\\t $var = $defaults{$var};\\n\\telse {\\n$expr;\\n\\t}\\n"/;
} elsif ($ScopeThisXSUB or $expr !~ /^\s*\$var =/) {
eval qq/print "\\t$var;\\n"/;
$deferred .= eval qq/"\\n$expr;\\n"/;
die "panic: do not know how to handle this branch for function pointers"
eval qq/print "$expr;\\n"/;
local($type, $num, $var, $do_setmagic, $do_push) = @_;
local($arg) = "ST(" . ($num - ($num != 0)) . ")";
local($argoff) = $num - 1;
$type = TidyType($type) ;
if ($type =~ /^array\(([^,]*),(.*)\)/) {
print "\t$arg = sv_newmortal();\n";
print "\tsv_setpvn($arg, (char *)$var, $2 * sizeof($1));\n";
print "\tSvSETMAGIC($arg);\n" if $do_setmagic;
blurt("Error: '$type' not in typemap"), return
unless defined($type_kind{$type});
blurt("Error: No OUTPUT definition for type '$type', typekind '$type_kind{$type}' found"), return
unless defined $output_expr{$type_kind{$type}} ;
($ntype = $type) =~ s/\s*\*/Ptr/g;
($subtype = $ntype) =~ s/(?:Array)?(?:Ptr)?$//;
$expr = $output_expr{$type_kind{$type}};
if ($expr =~ /DO_ARRAY_ELEM/) {
blurt("Error: '$subtype' not in typemap"), return
unless defined($type_kind{$subtype});
blurt("Error: No OUTPUT definition for type '$subtype', typekind '$type_kind{$subtype}' found"), return
unless defined $output_expr{$type_kind{$subtype}} ;
$subexpr = $output_expr{$type_kind{$subtype}};
$subexpr =~ s/ntype/subtype/g;
$subexpr =~ s/\$arg/ST(ix_$var)/g;
$subexpr =~ s/\$var/${var}[ix_$var]/g;
$subexpr =~ s/\n\t/\n\t\t/g;
$expr =~ s/DO_ARRAY_ELEM\n/$subexpr/;
eval "print qq\a$expr\a";
print "\t\tSvSETMAGIC(ST(ix_$var));\n" if $do_setmagic;
elsif ($var eq 'RETVAL') {
if ($expr =~ /^\t\$arg = new/) {
# We expect that $arg has refcnt 1, so we need to
eval "print qq\a$expr\a";
print "\tsv_2mortal(ST($num));\n";
print "\tSvSETMAGIC(ST($num));\n" if $do_setmagic;
elsif ($expr =~ /^\s*\$arg\s*=/) {
# We expect that $arg has refcnt >=1, so we need
eval "print qq\a$expr\a";
print "\tsv_2mortal(ST(0));\n";
print "\tSvSETMAGIC(ST(0));\n" if $do_setmagic;
# Just hope that the entry would safely write it
# over an already mortalized value. By
# coincidence, something like $arg = &sv_undef
print "\tST(0) = sv_newmortal();\n";
eval "print qq\a$expr\a";
# new mortals don't have set magic
print "\tPUSHs(sv_newmortal());\n";
eval "print qq\a$expr\a";
print "\tSvSETMAGIC($arg);\n" if $do_setmagic;
elsif ($arg =~ /^ST\(\d+\)$/) {
eval "print qq\a$expr\a";
print "\tSvSETMAGIC($arg);\n" if $do_setmagic;
my($type, $varname) = @_;
# C++ has :: in types too so skip this
$type =~ tr/:/_/ unless $hiertype;
$type =~ s/^array\(([^,]*),(.*)\).*/$1 */s;
if ($varname && $type =~ / \( \s* \* (?= \s* \) ) /xg) {
(substr $type, pos $type, 0) = " $varname ";
# If this is VMS, the exit status has meaning to the shell, so we
# use a predictable value (SS$_Normal or SS$_Abort) rather than an
# exit ($Is_VMS ? ($errors ? 44 : 1) : $errors) ;