=head1 SYNOPSIS
-B<xsubpp> [B<-v>] [B<-C++>] [B<-except>] [B<-s pattern>] [B<-typemap typemap>]... file.xs
+B<xsubpp> [B<-v>] [B<-C++>] [B<-except>] [B<-s pattern>] [B<-prototypes>] [B<-noversioncheck>] [B<-typemap typemap>]... file.xs
=head1 DESCRIPTION
Prints the I<xsubpp> version number to standard output, then exits.
+=item B<-prototypes>
+
+By default I<xsubpp> will not automatically generate prototype code for
+all xsubs. This flag will enable prototypes.
+
+=item B<-noversioncheck>
+
+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
+number.
+
=back
=head1 ENVIRONMENT
=head1 SEE ALSO
-perl(1), perlapi(1)
+perl(1), perlxs(1), perlxstut(1), perlapi(1)
=cut
# Global Constants
-$XSUBPP_version = "1.922";
-require 5.001;
+$XSUBPP_version = "1.933";
+require 5.002;
-$usage = "Usage: xsubpp [-v] [-C++] [-except] [-s pattern] [-typemap typemap]... file.xs\n";
+sub Q ;
+
+$FH = 'File0000' ;
+
+$usage = "Usage: xsubpp [-v] [-C++] [-except] [-prototypes] [-noversioncheck] [-s pattern] [-typemap typemap]... file.xs\n";
+
+$proto_re = "[" . quotemeta('\$%&*@;') . "]" ;
$except = "";
+$WantPrototypes = -1 ;
+$WantVersionChk = 1 ;
+$ProtoUsed = 0 ;
SWITCH: while (@ARGV and $ARGV[0] =~ /^-./) {
$flag = shift @ARGV;
$flag =~ s/^-// ;
$spat = shift, next SWITCH if $flag eq 's';
$cplusplus = 1, next SWITCH if $flag eq 'C++';
+ $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';
$except = " TRY", next SWITCH if $flag eq 'except';
push(@tm,shift), next SWITCH if $flag eq 'typemap';
(print "xsubpp version $XSUBPP_version\n"), exit
if $flag eq 'v';
die $usage;
}
+if ($WantPrototypes == -1)
+ { $WantPrototypes = 0}
+else
+ { $ProtoUsed = 1 }
+
+
@ARGV == 1 or die $usage;
-chomp($pwd = `pwd`);
-# Check for error message from VMS
-if ($pwd =~ /unrecognized command verb/) { $Is_VMS = 1; $pwd = $ENV{DEFAULT} }
($dir, $filename) = $ARGV[0] =~ m#(.*)/(.*)#
or ($dir, $filename) = $ARGV[0] =~ m#(.*[>\]])(.*)#
or ($dir, $filename) = ('.', $ARGV[0]);
chdir($dir);
+# Check for VMS; Config.pm may not be installed yet, but this routine
+# is built into VMS perl
+if (defined(&VMS::Filespec::vmsify)) { $Is_VMS = 1; $pwd = $ENV{DEFAULT}; }
+else { $Is_VMS = 0; chomp($pwd = `pwd`); }
+
+++ $IncludedFiles{$ARGV[0]} ;
sub TrimWhitespace
{
TrimWhitespace($_) ;
# skip blank lines and comment lines
next if /^$/ or /^#/ ;
- my($type,$kind) = /^\s*(.*?\S)\s+(\S+)\s*$/ or
- warn("Warning: File '$typemap' Line $. '$line' TYPEMAP entry needs 2 columns\n"), next;
- $type_kind{TidyType($type)} = $kind ;
+ 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 (/^\s/) {
$$current .= $_;
$END = "!End!\n\n"; # "impossible" keyword (multiple newline)
# Match an XS keyword
-$BLOCK_re= "\\s*(REQUIRE|BOOT|CASE|PREINIT|INPUT|INIT|CODE|PPCODE|OUTPUT|CLEANUP|ALIAS|$END)\\s*:";
+$BLOCK_re= '\s*(' . join('|', qw(
+ REQUIRE BOOT CASE PREINIT INPUT INIT CODE PPCODE OUTPUT
+ CLEANUP ALIAS PROTOTYPES PROTOTYPE VERSIONCHECK INCLUDE
+ )) . "|$END)\\s*:";
# Input: ($_, @line) == unparsed input.
# Output: ($_, @line) == (rest of line, following lines).
}
}
+sub process_keyword($)
+{
+ my($pattern) = @_ ;
+ my $kwd ;
+
+ &{"${kwd}_handler"}()
+ while $kwd = check_keyword($pattern) ;
+}
+
sub CASE_handler {
blurt ("Error: `CASE:' after unconditional `CASE:'")
if $condnum && $cond eq '';
$var_types{$var_name} = $var_type;
print "\t" . &map_type($var_type);
$var_num = $args_match{$var_name};
+
+ $proto_arg[$var_num] = ProtoString($var_type)
+ if $var_num ;
if ($var_addr) {
$var_addr{$var_name} = 1;
$func_args =~ s/\b($var_name)\b/&$1/;
}
}
+sub CLEANUP_handler() { print_section() }
+sub PREINIT_handler() { print_section() }
+sub INIT_handler() { print_section() }
+
sub GetAliases
{
my ($line) = @_ ;
if $line ;
}
-sub ALIAS_handler
+sub ALIAS_handler ()
{
for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
next unless /\S/;
}
}
-sub REQUIRE_handler
+sub REQUIRE_handler ()
{
# the rest of the current line should contain a version number
my ($Ver) = $_ ;
unless $XSUBPP_version >= $Ver ;
}
+sub VERSIONCHECK_handler ()
+{
+ # the rest of the current line should contain either ENABLE or
+ # DISABLE
+
+ TrimWhitespace($_) ;
+
+ # 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' ;
+
+}
+
+sub PROTOTYPE_handler ()
+{
+ my $specified ;
+
+ death("Error: Only 1 PROTOTYPE definition allowed per xsub")
+ if $proto_in_this_xsub ++ ;
+
+ for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
+ next unless /\S/;
+ $specified = 1 ;
+ TrimWhitespace($_) ;
+ if ($_ eq 'DISABLE') {
+ $ProtoThisXSUB = 0
+ }
+ elsif ($_ eq 'ENABLE') {
+ $ProtoThisXSUB = 1
+ }
+ else {
+ # remove any whitespace
+ s/\s+//g ;
+ death("Error: Invalid prototype '$_'")
+ unless ValidProtoString($_) ;
+ $ProtoThisXSUB = C_string($_) ;
+ }
+ }
+
+ # If no prototype specified, then assume empty prototype ""
+ $ProtoThisXSUB = 2 unless $specified ;
+
+ $ProtoUsed = 1 ;
+
+}
+
+sub PROTOTYPES_handler ()
+{
+ # the rest of the current line should contain either ENABLE or
+ # DISABLE
+
+ TrimWhitespace($_) ;
+
+ # 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' ;
+ $ProtoUsed = 1 ;
+
+}
+
+sub INCLUDE_handler ()
+{
+ # the rest of the current line should contain a valid filename
+
+ TrimWhitespace($_) ;
+
+ death("INCLUDE: filename missing")
+ unless $_ ;
+
+ death("INCLUDE: output pipe is illegal")
+ if /^\s*\|/ ;
+
+ # simple minded recursion detector
+ death("INCLUDE loop detected")
+ if $IncludedFiles{$_} ;
+
+ ++ $IncludedFiles{$_} unless /\|\s*$/ ;
+
+ # Save the current file context.
+ push(@FileStack, {
+ LastLine => $lastline,
+ LastLineNo => $lastline_no,
+ Line => \@line,
+ LineNo => \@line_no,
+ Filename => $filename,
+ Handle => $FH,
+ }) ;
+
+ ++ $FH ;
+
+ # open the new file
+ open ($FH, "$_") or death("Cannot open '$_': $!") ;
+
+ print Q<<"EOF" ;
+#
+#/* INCLUDE: Including '$_' from '$filename' */
+#
+EOF
+
+ $filename = $_ ;
+
+ # Prime the pump by reading the first
+ # non-blank line
+
+ # skip leading blank lines
+ while (<$FH>) {
+ last unless /^\s*$/ ;
+ }
+
+ $lastline = $_ ;
+ $lastline_no = $. ;
+
+}
+
+sub PopFile()
+{
+ return 0 unless @FileStack ;
+
+ my $data = pop @FileStack ;
+ my $ThisFile = $filename ;
+ my $isPipe = ($filename =~ /\|\s*$/) ;
+
+ -- $IncludedFiles{$filename}
+ unless $isPipe ;
+
+ close $FH ;
+
+ $FH = $data->{Handle} ;
+ $filename = $data->{Filename} ;
+ $lastline = $data->{LastLine} ;
+ $lastline_no = $data->{LastLineNo} ;
+ @line = @{ $data->{Line} } ;
+ @line_no = @{ $data->{LineNo} } ;
+
+ if ($isPipe and $? ) {
+ -- $lastline_no ;
+ print STDERR "Error reading from pipe '$ThisFile': $! in $filename, line $lastline_no\n" ;
+ exit 1 ;
+ }
+
+ print Q<<"EOF" ;
+#
+#/* INCLUDE: Returning to '$filename' from '$ThisFile' */
+#
+EOF
+
+ return 1 ;
+}
+
+sub ValidProtoString ($)
+{
+ my($string) = @_ ;
+
+ if ( $string =~ /^$proto_re+$/ ) {
+ return $string ;
+ }
+
+ return 0 ;
+}
+
+sub C_string ($)
+{
+ my($string) = @_ ;
+
+ $string =~ s[\\][\\\\]g ;
+ $string ;
+}
+
+sub ProtoString ($)
+{
+ my ($type) = @_ ;
+
+ $proto_letter{$type} or '$' ;
+}
+
sub check_cpp {
my @cpp = grep(/^\#\s*(?:if|e\w+)/, @line);
if (@cpp) {
sub Q {
my($text) = @_;
- $text =~ tr/#//d;
+ $text =~ s/^#//gm;
$text =~ s/\[\[/{/g;
$text =~ s/\]\]/}/g;
$text;
}
-open(F, $filename) or die "cannot open $filename: $!\n";
+open($FH, $filename) or die "cannot open $filename: $!\n";
# Identify the version of xsubpp used
print <<EOM ;
EOM
-while (<F>) {
+while (<$FH>) {
last if ($Module, $Package, $Prefix) =
/^MODULE\s*=\s*([\w:]+)(?:\s+PACKAGE\s*=\s*([\w:]+))?(?:\s+PREFIX\s*=\s*(\S+))?\s*$/;
print $_;
}
&Exit unless defined $_;
-my $lastline = $_;
-my $lastline_no = $.;
+$lastline = $_;
+$lastline_no = $.;
-# Read next xsub into @line from ($lastline, <F>).
+# Read next xsub into @line from ($lastline, <$FH>).
sub fetch_para {
# parse paragraph
@line = ();
@line_no = () ;
- return 0 unless defined $lastline;
+ if (! defined $lastline) {
+ return 1 if PopFile() ;
+ return 0 ;
+ }
if ($lastline =~
/^MODULE\s*=\s*([\w:]+)(?:\s+PACKAGE\s*=\s*([\w:]+))?(?:\s+PREFIX\s*=\s*(\S+))?\s*$/) {
}
# Read next line and continuation lines
- last unless defined($lastline = <F>);
+ last unless defined($lastline = <$FH>);
$lastline_no = $.;
my $tmp_line;
$lastline .= $tmp_line
- while ($lastline =~ /\\$/ && defined($tmp_line = <F>));
+ while ($lastline =~ /\\$/ && defined($tmp_line = <$FH>));
chomp $lastline;
$lastline =~ s/^\s+$//;
undef($elipsis);
undef($wantRETVAL) ;
undef(%arg_list) ;
+ undef(@proto_arg) ;
+ undef($proto_in_this_xsub) ;
+ $ProtoThisXSUB = $WantPrototypes ;
$_ = shift(@line);
- if (check_keyword("REQUIRE")) {
- REQUIRE_handler() ;
+ while ($kwd = check_keyword("REQUIRE|PROTOTYPES|VERSIONCHECK|INCLUDE")) {
+ &{"${kwd}_handler"}() ;
next PARAGRAPH unless @line ;
$_ = shift(@line);
}
@args = split(/\s*,\s*/, $orig_args);
if (defined($class)) {
- my $arg0 = (defined($static) ? "CLASS" : "THIS");
+ my $arg0 = ((defined($static) or $func_name =~ /^new/) ? "CLASS" : "THIS");
unshift(@args, $arg0);
($orig_args = "$arg0, $orig_args") =~ s/^$arg0, $/$arg0/;
}
$defaults{$args[$i]} = $2;
$defaults{$args[$i]} =~ s/"/\\"/g;
}
+ $proto_arg[$i+1] = '$' ;
}
if (defined($class)) {
$func_args = join(", ", @args[1..$#args]);
%arg_list = () ;
$gotRETVAL = 0;
- &INPUT_handler;
- my $kwd;
- while ($kwd = check_keyword("INPUT|PREINIT")) {
- if ($kwd eq 'PREINIT') { &print_section; } else { &INPUT_handler; }
- }
+ INPUT_handler() ;
+ process_keyword("INPUT|PREINIT|ALIAS|PROTOTYPE") ;
+
if (!$thisdone && defined($class)) {
- if (defined($static)) {
+ if (defined($static) or $func_name =~ /^new/) {
print "\tchar *";
$var_types{"CLASS"} = "char *";
&generate_init("char *", 1, "CLASS");
# do code
if (/^\s*NOT_IMPLEMENTED_YET/) {
- print "\ncroak(\"$pname: not implemented yet\");\n";
+ print "\n\tcroak(\"$pname: not implemented yet\");\n";
+ $_ = '' ;
} else {
if ($ret_type ne "void") {
print "\t" . &map_type($ret_type) . "\tRETVAL;\n"
$var_types{"RETVAL"} = $ret_type;
}
print $deferred;
- while ($kwd = check_keyword("INIT|ALIAS")) {
- if ($kwd eq 'INIT') {
- &print_section
- }
- else {
- ALIAS_handler
- }
- }
+ process_keyword("INIT|ALIAS|PROTOTYPE") ;
if (check_keyword("PPCODE")) {
- &print_section;
+ print_section();
death ("PPCODE must be last thing") if @line;
print "\tPUTBACK;\n\treturn;\n";
} elsif (check_keyword("CODE")) {
- &print_section;
- } elsif ($func_name eq "DESTROY") {
+ print_section() ;
+ } elsif (defined($class) and $func_name eq "DESTROY") {
print "\n\t";
print "delete THIS;\n";
} else {
print "${class}::";
}
} elsif (defined($class)) {
+ if ($func_name =~ /^new/) {
+ $func_name .= " $class";
+ } else {
print "THIS->";
+ }
}
$func_name =~ s/^($spat)//
if defined($spat);
$gotRETVAL = 0;
undef $RETVAL_code ;
undef %outargs ;
- &OUTPUT_handler while check_keyword("OUTPUT");
+ process_keyword("OUTPUT|ALIAS|PROTOTYPE");
# all OUTPUT done, so now push the return value on the stack
if ($gotRETVAL && $RETVAL_code) {
}
# do cleanup
- &print_section while check_keyword("CLEANUP");
+ process_keyword("CLEANUP|ALIAS|PROTOTYPE") ;
# print function trailer
print Q<<EOF;
#]]
#
EOF
+
+ # Build the prototype string for the xsub
+ if ($ProtoThisXSUB) {
+ if ($ProtoThisXSUB == 2) {
+ # User has specified empty prototype
+ $ProtoXSUB{$pname} = '""'
+ }
+ elsif ($ProtoThisXSUB != 1) {
+ # User has specified a prototype
+ $ProtoXSUB{$pname} = '"' . $ProtoThisXSUB . '"'
+ }
+ else {
+ my $s = ';';
+ if ($min_args < $num_args) {
+ $s = '';
+ $proto_arg[$min_args] .= ";" ;
+ }
+ push @proto_arg, "${s}@"
+ if $elipsis ;
+
+ $ProtoXSUB{$pname} = '"' . join ("", @proto_arg) . '"'
+ }
+ }
+
}
# print initialization routine
-print qq/extern "C"\n/ if $cplusplus;
print Q<<"EOF";
+##ifdef __cplusplus
+#extern "C"
+##endif
#XS(boot_$Module_cname)
#[[
# dXSARGS;
#
EOF
+print Q<<"EOF" if $WantVersionChk ;
+# XS_VERSION_BOOTCHECK ;
+#
+EOF
+
print Q<<"EOF" if defined %XsubAliases ;
# {
# CV * cv ;
for (@Func_name) {
$pname = shift(@Func_pname);
+ my $newXS = "newXS" ;
+ my $proto = "" ;
+
+ if ($ProtoXSUB{$pname}) {
+ $newXS = "newXSproto" ;
+ $proto = ", $ProtoXSUB{$pname}" ;
+ }
if ($XsubAliases{$pname}) {
$XsubAliases{$pname}{$pname} = 0
# cv = newXS(\"$name\", XS_$_, file);
# XSANY.any_i32 = $value ;
EOF
+ print Q<<"EOF" if $proto ;
+# sv_setpv((SV*)cv, $ProtoXSUB{$pname}) ;
+EOF
}
}
else {
- print " newXS(\"$pname\", XS_$_, file);\n";
+ print " ${newXS}(\"$pname\", XS_$_, file$proto);\n";
}
}
#]]
EOF
+warn("Please specify prototyping behavior for $filename (see perlxs manual)\n")
+ unless $ProtoUsed ;
&Exit;
sub Exit {
# If this is VMS, the exit status has meaning to the shell, so we
-# use a predictable value (SS$_Abort) rather than an arbitrary
-# number.
- exit ($Is_VMS ? 44 : $errors) ;
+# use a predictable value (SS$_Normal or SS$_Abort) rather than an
+# arbitrary number.
+ exit ($Is_VMS ? ($errors ? 44 : 1) : $errors) ;
}
projects / p5sagit/p5-mst-13.2.git / blobdiff