lib/ExtUtils/xsubpp

   1 #!./miniperl
   2
   3 =head1 NAME
   4
   5 xsubpp - compiler to convert Perl XS code into C code
   6
   7 =head1 SYNOPSIS
   8
   9 B<xsubpp> [B<-v>] [B<-C++>] [B<-except>] [B<-s pattern>] [B<-prototypes>] [B<-noversioncheck>] [B<-nolinenumbers>] [B<-nooptimize>] [B<-typemap typemap>] ... file.xs
  10
  11 =head1 DESCRIPTION
  12
  13 This compiler is typically run by the makefiles created by L<ExtUtils::MakeMaker>.
  14
  15 I<xsubpp> will compile XS code into C code by embedding the constructs
  16 necessary to let C functions manipulate Perl values and creates the glue
  17 necessary to let Perl access those functions.  The compiler uses typemaps to
  18 determine how to map C function parameters and variables to Perl values.
  19
  20 The compiler will search for typemap files called I<typemap>.  It will use
  21 the following search path to find default typemaps, with the rightmost
  22 typemap taking precedence.
  23
  24         ../../../typemap:../../typemap:../typemap:typemap
  25
  26 =head1 OPTIONS
  27
  28 Note that the C<XSOPT> MakeMaker option may be used to add these options to
  29 any makefiles generated by MakeMaker.
  30
  31 =over 5
  32
  33 =item B<-C++>
  34
  35 Adds ``extern "C"'' to the C code.
  36
  37 =item B<-except>
  38
  39 Adds exception handling stubs to the C code.
  40
  41 =item B<-typemap typemap>
  42
  43 Indicates that a user-supplied typemap should take precedence over the
  44 default typemaps.  This option may be used multiple times, with the last
  45 typemap having the highest precedence.
  46
  47 =item B<-v>
  48
  49 Prints the I<xsubpp> version number to standard output, then exits.
  50
  51 =item B<-prototypes>
  52
  53 By default I<xsubpp> will not automatically generate prototype code for
  54 all xsubs. This flag will enable prototypes.
  55
  56 =item B<-noversioncheck>
  57
  58 Disables the run time test that determines if the object file (derived
  59 from the C<.xs> file) and the C<.pm> files have the same version
  60 number.
  61
  62 =item B<-nolinenumbers>
  63
  64 Prevents the inclusion of `#line' directives in the output.
  65
  66 =item B<-nooptimize>
  67
  68 Disables certain optimizations.  The only optimization that is currently
  69 affected is the use of I<target>s by the output C code (see L<perlguts>).
  70 This may significantly slow down the generated code, but this is the way
  71 B<xsubpp> of 5.005 and earlier operated.
  72
  73 =item B<-noinout>
  74
  75 Disable recognition of C<IN>, C<OUT_LIST> and C<INOUT_LIST> declarations.
  76
  77 =item B<-noargtypes>
  78
  79 Disable recognition of ANSI-like descriptions of function signature.
  80
  81 =back
  82
  83 =head1 ENVIRONMENT
  84
  85 No environment variables are used.
  86
  87 =head1 AUTHOR
  88
  89 Larry Wall
  90
  91 =head1 MODIFICATION HISTORY
  92
  93 See the file F<changes.pod>.
  94
  95 =head1 SEE ALSO
  96
  97 perl(1), perlxs(1), perlxstut(1)
  98
  99 =cut
 100
 101 require 5.002;
 102 use Cwd;
 103 use vars '$cplusplus';
 104 use vars '%v';
 105
 106 use Config;
 107
 108 sub Q ;
 109
 110 # Global Constants
 111
 112 $XSUBPP_version = "1.9508";
 113
 114 my ($Is_VMS, $SymSet);
 115 if ($^O eq 'VMS') {
 116     $Is_VMS = 1;
 117     # Establish set of global symbols with max length 28, since xsubpp
 118     # will later add the 'XS_' prefix.
 119     require ExtUtils::XSSymSet;
 120     $SymSet = new ExtUtils::XSSymSet 28;
 121 }
 122
 123 $FH = 'File0000' ;
 124
 125 $usage = "Usage: xsubpp [-v] [-C++] [-except] [-prototypes] [-noversioncheck] [-nolinenumbers] [-nooptimize] [-noinout] [-noargtypes] [-s pattern] [-typemap typemap]... file.xs\n";
 126
 127 $proto_re = "[" . quotemeta('\$%&*@;') . "]" ;
 128 # mjn
 129 $OBJ   = 1 if $Config{'ccflags'} =~ /PERL_OBJECT/i;
 130
 131 $except = "";
 132 $WantPrototypes = -1 ;
 133 $WantVersionChk = 1 ;
 134 $ProtoUsed = 0 ;
 135 $WantLineNumbers = 1 ;
 136 $WantOptimize = 1 ;
 137
 138 my $process_inout = 1;
 139 my $process_argtypes = 1;
 140
 141 SWITCH: while (@ARGV and $ARGV[0] =~ /^-./) {
 142     $flag = shift @ARGV;
 143     $flag =~ s/^-// ;
 144     $spat = quotemeta shift,    next SWITCH     if $flag eq 's';
 145     $cplusplus = 1,     next SWITCH     if $flag eq 'C++';
 146     $WantPrototypes = 0, next SWITCH    if $flag eq 'noprototypes';
 147     $WantPrototypes = 1, next SWITCH    if $flag eq 'prototypes';
 148     $WantVersionChk = 0, next SWITCH    if $flag eq 'noversioncheck';
 149     $WantVersionChk = 1, next SWITCH    if $flag eq 'versioncheck';
 150     # XXX left this in for compat
 151     $WantCAPI = 1, next SWITCH    if $flag eq 'object_capi';
 152     $except = " TRY",   next SWITCH     if $flag eq 'except';
 153     push(@tm,shift),    next SWITCH     if $flag eq 'typemap';
 154     $WantLineNumbers = 0, next SWITCH   if $flag eq 'nolinenumbers';
 155     $WantLineNumbers = 1, next SWITCH   if $flag eq 'linenumbers';
 156     $WantOptimize = 0, next SWITCH      if $flag eq 'nooptimize';
 157     $WantOptimize = 1, next SWITCH      if $flag eq 'optimize';
 158     $process_inout = 0, next SWITCH     if $flag eq 'noinout';
 159     $process_inout = 1, next SWITCH     if $flag eq 'inout';
 160     $process_argtypes = 0, next SWITCH  if $flag eq 'noargtypes';
 161     $process_argtypes = 1, next SWITCH  if $flag eq 'argtypes';
 162     (print "xsubpp version $XSUBPP_version\n"), exit
 163         if $flag eq 'v';
 164     die $usage;
 165 }
 166 if ($WantPrototypes == -1)
 167   { $WantPrototypes = 0}
 168 else
 169   { $ProtoUsed = 1 }
 170
 171
 172 @ARGV == 1 or die $usage;
 173 ($dir, $filename) = $ARGV[0] =~ m#(.*)/(.*)#
 174         or ($dir, $filename) = $ARGV[0] =~ m#(.*)\\(.*)#
 175         or ($dir, $filename) = $ARGV[0] =~ m#(.*[>\]])(.*)#
 176         or ($dir, $filename) = ('.', $ARGV[0]);
 177 chdir($dir);
 178 $pwd = cwd();
 179
 180 ++ $IncludedFiles{$ARGV[0]} ;
 181
 182 my(@XSStack) = ({type => 'none'});      # Stack of conditionals and INCLUDEs
 183 my($XSS_work_idx, $cpp_next_tmp) = (0, "XSubPPtmpAAAA");
 184
 185
 186 sub TrimWhitespace
 187 {
 188     $_[0] =~ s/^\s+|\s+$//go ;
 189 }
 190
 191 sub TidyType
 192 {
 193     local ($_) = @_ ;
 194
 195     # rationalise any '*' by joining them into bunches and removing whitespace
 196     s#\s*(\*+)\s*#$1#g;
 197     s#(\*+)# $1 #g ;
 198
 199     # change multiple whitespace into a single space
 200     s/\s+/ /g ;
 201
 202     # trim leading & trailing whitespace
 203     TrimWhitespace($_) ;
 204
 205     $_ ;
 206 }
 207
 208 $typemap = shift @ARGV;
 209 foreach $typemap (@tm) {
 210     die "Can't find $typemap in $pwd\n" unless -r $typemap;
 211 }
 212 unshift @tm, qw(../../../../lib/ExtUtils/typemap ../../../lib/ExtUtils/typemap
 213                 ../../lib/ExtUtils/typemap ../../../typemap ../../typemap
 214                 ../typemap typemap);
 215 foreach $typemap (@tm) {
 216     next unless -e $typemap ;
 217     # skip directories, binary files etc.
 218     warn("Warning: ignoring non-text typemap file '$typemap'\n"), next
 219         unless -T $typemap ;
 220     open(TYPEMAP, $typemap)
 221         or warn ("Warning: could not open typemap file '$typemap': $!\n"), next;
 222     $mode = 'Typemap';
 223     $junk = "" ;
 224     $current = \$junk;
 225     while (<TYPEMAP>) {
 226         next if /^\s*#/;
 227         my $line_no = $. + 1;
 228         if (/^INPUT\s*$/)   { $mode = 'Input';   $current = \$junk;  next; }
 229         if (/^OUTPUT\s*$/)  { $mode = 'Output';  $current = \$junk;  next; }
 230         if (/^TYPEMAP\s*$/) { $mode = 'Typemap'; $current = \$junk;  next; }
 231         if ($mode eq 'Typemap') {
 232             chomp;
 233             my $line = $_ ;
 234             TrimWhitespace($_) ;
 235             # skip blank lines and comment lines
 236             next if /^$/ or /^#/ ;
 237             my($type,$kind, $proto) = /^\s*(.*?\S)\s+(\S+)\s*($proto_re*)\s*$/ or
 238                 warn("Warning: File '$typemap' Line $. '$line' TYPEMAP entry needs 2 or 3 columns\n"), next;
 239             $type = TidyType($type) ;
 240             $type_kind{$type} = $kind ;
 241             # prototype defaults to '$'
 242             $proto = "\$" unless $proto ;
 243             warn("Warning: File '$typemap' Line $. '$line' Invalid prototype '$proto'\n")
 244                 unless ValidProtoString($proto) ;
 245             $proto_letter{$type} = C_string($proto) ;
 246         }
 247         elsif (/^\s/) {
 248             $$current .= $_;
 249         }
 250         elsif ($mode eq 'Input') {
 251             s/\s+$//;
 252             $input_expr{$_} = '';
 253             $current = \$input_expr{$_};
 254         }
 255         else {
 256             s/\s+$//;
 257             $output_expr{$_} = '';
 258             $current = \$output_expr{$_};
 259         }
 260     }
 261     close(TYPEMAP);
 262 }
 263
 264 foreach $key (keys %input_expr) {
 265     $input_expr{$key} =~ s/\n+$//;
 266 }
 267
 268 $bal = qr[(?:(?>[^()]+)|\((??{ $bal })\))*];    # ()-balanced
 269 $cast = qr[(?:\(\s*SV\s*\*\s*\)\s*)?];          # Optional (SV*) cast
 270 $size = qr[,\s* (??{ $bal }) ]x;                # Third arg (to setpvn)
 271
 272 foreach $key (keys %output_expr) {
 273     use re 'eval';
 274
 275     my ($t, $with_size, $arg, $sarg) =
 276       ($output_expr{$key} =~
 277          m[^ \s+ sv_set ( [iunp] ) v (n)?       # Type, is_setpvn
 278              \s* \( \s* $cast \$arg \s* ,
 279              \s* ( (??{ $bal }) )               # Set from
 280              ( (??{ $size }) )?                 # Possible sizeof set-from
 281              \) \s* ; \s* $
 282           ]x);
 283     $targetable{$key} = [$t, $with_size, $arg, $sarg] if $t;
 284 }
 285
 286 $END = "!End!\n\n";             # "impossible" keyword (multiple newline)
 287
 288 # Match an XS keyword
 289 $BLOCK_re= '\s*(' . join('|', qw(
 290         REQUIRE BOOT CASE PREINIT INPUT INIT CODE PPCODE OUTPUT
 291         CLEANUP ALIAS ATTRS PROTOTYPES PROTOTYPE VERSIONCHECK INCLUDE
 292         SCOPE INTERFACE INTERFACE_MACRO C_ARGS POSTCALL
 293         )) . "|$END)\\s*:";
 294
 295 # Input:  ($_, @line) == unparsed input.
 296 # Output: ($_, @line) == (rest of line, following lines).
 297 # Return: the matched keyword if found, otherwise 0
 298 sub check_keyword {
 299         $_ = shift(@line) while !/\S/ && @line;
 300         s/^(\s*)($_[0])\s*:\s*(?:#.*)?/$1/s && $2;
 301 }
 302
 303 my ($C_group_rex, $C_arg);
 304 # Group in C (no support for comments or literals)
 305 $C_group_rex = qr/ [({\[]
 306                    (?: (?> [^()\[\]{}]+ ) | (??{ $C_group_rex }) )*
 307                    [)}\]] /x ;
 308 # Chunk in C without comma at toplevel (no comments):
 309 $C_arg = qr/ (?: (?> [^()\[\]{},"']+ )
 310              |   (??{ $C_group_rex })
 311              |   " (?: (?> [^\\"]+ )
 312                    |   \\.
 313                    )* "         # String literal
 314              |   ' (?: (?> [^\\']+ ) | \\. )* ' # Char literal
 315              )* /xs;
 316
 317 if ($WantLineNumbers) {
 318     {
 319         package xsubpp::counter;
 320         sub TIEHANDLE {
 321             my ($class, $cfile) = @_;
 322             my $buf = "";
 323             $SECTION_END_MARKER = "#line --- \"$cfile\"";
 324             $line_no = 1;
 325             bless \$buf;
 326         }
 327
 328         sub PRINT {
 329             my $self = shift;
 330             for (@_) {
 331                 $$self .= $_;
 332                 while ($$self =~ s/^([^\n]*\n)//) {
 333                     my $line = $1;
 334                     ++ $line_no;
 335                     $line =~ s|^\#line\s+---(?=\s)|#line $line_no|;
 336                     print STDOUT $line;
 337                 }
 338             }
 339         }
 340
 341         sub PRINTF {
 342             my $self = shift;
 343             my $fmt = shift;
 344             $self->PRINT(sprintf($fmt, @_));
 345         }
 346
 347         sub DESTROY {
 348             # Not necessary if we're careful to end with a "\n"
 349             my $self = shift;
 350             print STDOUT $$self;
 351         }
 352     }
 353
 354     my $cfile = $filename;
 355     $cfile =~ s/\.xs$/.c/i or $cfile .= ".c";
 356     tie(*PSEUDO_STDOUT, 'xsubpp::counter', $cfile);
 357     select PSEUDO_STDOUT;
 358 }
 359
 360 sub print_section {
 361     # the "do" is required for right semantics
 362     do { $_ = shift(@line) } while !/\S/ && @line;
 363
 364     print("#line ", $line_no[@line_no - @line -1], " \"$filename\"\n")
 365         if $WantLineNumbers && !/^\s*#\s*line\b/ && !/^#if XSubPPtmp/;
 366     for (;  defined($_) && !/^$BLOCK_re/o;  $_ = shift(@line)) {
 367         print "$_\n";
 368     }
 369     print "$xsubpp::counter::SECTION_END_MARKER\n" if $WantLineNumbers;
 370 }
 371
 372 sub merge_section {
 373     my $in = '';
 374
 375     while (!/\S/ && @line) {
 376         $_ = shift(@line);
 377     }
 378
 379     for (;  defined($_) && !/^$BLOCK_re/o;  $_ = shift(@line)) {
 380         $in .= "$_\n";
 381     }
 382     chomp $in;
 383     return $in;
 384 }
 385
 386 sub process_keyword($)
 387 {
 388     my($pattern) = @_ ;
 389     my $kwd ;
 390
 391     &{"${kwd}_handler"}()
 392         while $kwd = check_keyword($pattern) ;
 393 }
 394
 395 sub CASE_handler {
 396     blurt ("Error: `CASE:' after unconditional `CASE:'")
 397         if $condnum && $cond eq '';
 398     $cond = $_;
 399     TrimWhitespace($cond);
 400     print "   ", ($condnum++ ? " else" : ""), ($cond ? " if ($cond)\n" : "\n");
 401     $_ = '' ;
 402 }
 403
 404 sub INPUT_handler {
 405     for (;  !/^$BLOCK_re/o;  $_ = shift(@line)) {
 406         last if /^\s*NOT_IMPLEMENTED_YET/;
 407         next unless /\S/;       # skip blank lines
 408
 409         TrimWhitespace($_) ;
 410         my $line = $_ ;
 411
 412         # remove trailing semicolon if no initialisation
 413         s/\s*;$//g unless /[=;+].*\S/ ;
 414
 415         # check for optional initialisation code
 416         my $var_init = '' ;
 417         $var_init = $1 if s/\s*([=;+].*)$//s ;
 418         $var_init =~ s/"/\\"/g;
 419
 420         s/\s+/ /g;
 421         my ($var_type, $var_addr, $var_name) = /^(.*?[^& ]) *(\&?) *\b(\w+)$/s
 422             or blurt("Error: invalid argument declaration '$line'"), next;
 423
 424         # Check for duplicate definitions
 425         blurt ("Error: duplicate definition of argument '$var_name' ignored"), next
 426             if $arg_list{$var_name}++
 427               or defined $arg_types{$var_name} and not $processing_arg_with_types;
 428
 429         $thisdone |= $var_name eq "THIS";
 430         $retvaldone |= $var_name eq "RETVAL";
 431         $var_types{$var_name} = $var_type;
 432         # XXXX This check is a safeguard against the unfinished conversion of
 433         # generate_init().  When generate_init() is fixed,
 434         # one can use 2-args map_type() unconditionally.
 435         if ($var_type =~ / \( \s* \* \s* \) /x) {
 436           # Function pointers are not yet supported with &output_init!
 437           print "\t" . &map_type($var_type, $var_name);
 438           $name_printed = 1;
 439         } else {
 440           print "\t" . &map_type($var_type);
 441           $name_printed = 0;
 442         }
 443         $var_num = $args_match{$var_name};
 444
 445         $proto_arg[$var_num] = ProtoString($var_type)
 446             if $var_num ;
 447         if ($var_addr) {
 448             $var_addr{$var_name} = 1;
 449             $func_args =~ s/\b($var_name)\b/&$1/;
 450         }
 451         if ($var_init =~ /^[=;]\s*NO_INIT\s*;?\s*$/
 452             or $in_out{$var_name} and $in_out{$var_name} eq 'OUTLIST'
 453             and $var_init !~ /\S/) {
 454           if ($name_printed) {
 455             print ";\n";
 456           } else {
 457             print "\t$var_name;\n";
 458           }
 459         } elsif ($var_init =~ /\S/) {
 460             &output_init($var_type, $var_num, $var_name, $var_init, $name_printed);
 461         } elsif ($var_num) {
 462             # generate initialization code
 463             &generate_init($var_type, $var_num, $var_name, $name_printed);
 464         } else {
 465             print ";\n";
 466         }
 467     }
 468 }
 469
 470 sub OUTPUT_handler {
 471     for (;  !/^$BLOCK_re/o;  $_ = shift(@line)) {
 472         next unless /\S/;
 473         if (/^\s*SETMAGIC\s*:\s*(ENABLE|DISABLE)\s*/) {
 474             $DoSetMagic = ($1 eq "ENABLE" ? 1 : 0);
 475             next;
 476         }
 477         my ($outarg, $outcode) = /^\s*(\S+)\s*(.*?)\s*$/s ;
 478         blurt ("Error: duplicate OUTPUT argument '$outarg' ignored"), next
 479             if $outargs{$outarg} ++ ;
 480         if (!$gotRETVAL and $outarg eq 'RETVAL') {
 481             # deal with RETVAL last
 482             $RETVAL_code = $outcode ;
 483             $gotRETVAL = 1 ;
 484             next ;
 485         }
 486         blurt ("Error: OUTPUT $outarg not an argument"), next
 487             unless defined($args_match{$outarg});
 488         blurt("Error: No input definition for OUTPUT argument '$outarg' - ignored"), next
 489             unless defined $var_types{$outarg} ;
 490         $var_num = $args_match{$outarg};
 491         if ($outcode) {
 492             print "\t$outcode\n";
 493             print "\tSvSETMAGIC(ST(" , $var_num-1 , "));\n" if $DoSetMagic;
 494         } else {
 495             &generate_output($var_types{$outarg}, $var_num, $outarg, $DoSetMagic);
 496         }
 497     }
 498 }
 499
 500 sub C_ARGS_handler() {
 501     my $in = merge_section();
 502
 503     TrimWhitespace($in);
 504     $func_args = $in;
 505 }
 506
 507 sub INTERFACE_MACRO_handler() {
 508     my $in = merge_section();
 509
 510     TrimWhitespace($in);
 511     if ($in =~ /\s/) {          # two
 512         ($interface_macro, $interface_macro_set) = split ' ', $in;
 513     } else {
 514         $interface_macro = $in;
 515         $interface_macro_set = 'UNKNOWN_CVT'; # catch later
 516     }
 517     $interface = 1;             # local
 518     $Interfaces = 1;            # global
 519 }
 520
 521 sub INTERFACE_handler() {
 522     my $in = merge_section();
 523
 524     TrimWhitespace($in);
 525
 526     foreach (split /[\s,]+/, $in) {
 527         $Interfaces{$_} = $_;
 528     }
 529     print Q<<"EOF";
 530 #       XSFUNCTION = $interface_macro($ret_type,cv,XSANY.any_dptr);
 531 EOF
 532     $interface = 1;             # local
 533     $Interfaces = 1;            # global
 534 }
 535
 536 sub CLEANUP_handler() { print_section() }
 537 sub PREINIT_handler() { print_section() }
 538 sub POSTCALL_handler() { print_section() }
 539 sub INIT_handler()    { print_section() }
 540
 541 sub GetAliases
 542 {
 543     my ($line) = @_ ;
 544     my ($orig) = $line ;
 545     my ($alias) ;
 546     my ($value) ;
 547
 548     # Parse alias definitions
 549     # format is
 550     #    alias = value alias = value ...
 551
 552     while ($line =~ s/^\s*([\w:]+)\s*=\s*(\w+)\s*//) {
 553         $alias = $1 ;
 554         $orig_alias = $alias ;
 555         $value = $2 ;
 556
 557         # check for optional package definition in the alias
 558         $alias = $Packprefix . $alias if $alias !~ /::/ ;
 559
 560         # check for duplicate alias name & duplicate value
 561         Warn("Warning: Ignoring duplicate alias '$orig_alias'")
 562             if defined $XsubAliases{$alias} ;
 563
 564         Warn("Warning: Aliases '$orig_alias' and '$XsubAliasValues{$value}' have identical values")
 565             if $XsubAliasValues{$value} ;
 566
 567         $XsubAliases = 1;
 568         $XsubAliases{$alias} = $value ;
 569         $XsubAliasValues{$value} = $orig_alias ;
 570     }
 571
 572     blurt("Error: Cannot parse ALIAS definitions from '$orig'")
 573         if $line ;
 574 }
 575
 576 sub ATTRS_handler ()
 577 {
 578     for (;  !/^$BLOCK_re/o;  $_ = shift(@line)) {
 579         next unless /\S/;
 580         TrimWhitespace($_) ;
 581         push @Attributes, $_;
 582     }
 583 }
 584
 585 sub ALIAS_handler ()
 586 {
 587     for (;  !/^$BLOCK_re/o;  $_ = shift(@line)) {
 588         next unless /\S/;
 589         TrimWhitespace($_) ;
 590         GetAliases($_) if $_ ;
 591     }
 592 }
 593
 594 sub REQUIRE_handler ()
 595 {
 596     # the rest of the current line should contain a version number
 597     my ($Ver) = $_ ;
 598
 599     TrimWhitespace($Ver) ;
 600
 601     death ("Error: REQUIRE expects a version number")
 602         unless $Ver ;
 603
 604     # check that the version number is of the form n.n
 605     death ("Error: REQUIRE: expected a number, got '$Ver'")
 606         unless $Ver =~ /^\d+(\.\d*)?/ ;
 607
 608     death ("Error: xsubpp $Ver (or better) required--this is only $XSUBPP_version.")
 609         unless $XSUBPP_version >= $Ver ;
 610 }
 611
 612 sub VERSIONCHECK_handler ()
 613 {
 614     # the rest of the current line should contain either ENABLE or
 615     # DISABLE
 616
 617     TrimWhitespace($_) ;
 618
 619     # check for ENABLE/DISABLE
 620     death ("Error: VERSIONCHECK: ENABLE/DISABLE")
 621         unless /^(ENABLE|DISABLE)/i ;
 622
 623     $WantVersionChk = 1 if $1 eq 'ENABLE' ;
 624     $WantVersionChk = 0 if $1 eq 'DISABLE' ;
 625
 626 }
 627
 628 sub PROTOTYPE_handler ()
 629 {
 630     my $specified ;
 631
 632     death("Error: Only 1 PROTOTYPE definition allowed per xsub")
 633         if $proto_in_this_xsub ++ ;
 634
 635     for (;  !/^$BLOCK_re/o;  $_ = shift(@line)) {
 636         next unless /\S/;
 637         $specified = 1 ;
 638         TrimWhitespace($_) ;
 639         if ($_ eq 'DISABLE') {
 640            $ProtoThisXSUB = 0
 641         }
 642         elsif ($_ eq 'ENABLE') {
 643            $ProtoThisXSUB = 1
 644         }
 645         else {
 646             # remove any whitespace
 647             s/\s+//g ;
 648             death("Error: Invalid prototype '$_'")
 649                 unless ValidProtoString($_) ;
 650             $ProtoThisXSUB = C_string($_) ;
 651         }
 652     }
 653
 654     # If no prototype specified, then assume empty prototype ""
 655     $ProtoThisXSUB = 2 unless $specified ;
 656
 657     $ProtoUsed = 1 ;
 658
 659 }
 660
 661 sub SCOPE_handler ()
 662 {
 663     death("Error: Only 1 SCOPE declaration allowed per xsub")
 664         if $scope_in_this_xsub ++ ;
 665
 666     for (;  !/^$BLOCK_re/o;  $_ = shift(@line)) {
 667                 next unless /\S/;
 668                 TrimWhitespace($_) ;
 669         if ($_ =~ /^DISABLE/i) {
 670                    $ScopeThisXSUB = 0
 671         }
 672         elsif ($_ =~ /^ENABLE/i) {
 673                    $ScopeThisXSUB = 1
 674         }
 675     }
 676
 677 }
 678
 679 sub PROTOTYPES_handler ()
 680 {
 681     # the rest of the current line should contain either ENABLE or
 682     # DISABLE
 683
 684     TrimWhitespace($_) ;
 685
 686     # check for ENABLE/DISABLE
 687     death ("Error: PROTOTYPES: ENABLE/DISABLE")
 688         unless /^(ENABLE|DISABLE)/i ;
 689
 690     $WantPrototypes = 1 if $1 eq 'ENABLE' ;
 691     $WantPrototypes = 0 if $1 eq 'DISABLE' ;
 692     $ProtoUsed = 1 ;
 693
 694 }
 695
 696 sub INCLUDE_handler ()
 697 {
 698     # the rest of the current line should contain a valid filename
 699
 700     TrimWhitespace($_) ;
 701
 702     death("INCLUDE: filename missing")
 703         unless $_ ;
 704
 705     death("INCLUDE: output pipe is illegal")
 706         if /^\s*\|/ ;
 707
 708     # simple minded recursion detector
 709     death("INCLUDE loop detected")
 710         if $IncludedFiles{$_} ;
 711
 712     ++ $IncludedFiles{$_} unless /\|\s*$/ ;
 713
 714     # Save the current file context.
 715     push(@XSStack, {
 716         type            => 'file',
 717         LastLine        => $lastline,
 718         LastLineNo      => $lastline_no,
 719         Line            => \@line,
 720         LineNo          => \@line_no,
 721         Filename        => $filename,
 722         Handle          => $FH,
 723         }) ;
 724
 725     ++ $FH ;
 726
 727     # open the new file
 728     open ($FH, "$_") or death("Cannot open '$_': $!") ;
 729
 730     print Q<<"EOF" ;
 731 #
 732 #/* INCLUDE:  Including '$_' from '$filename' */
 733 #
 734 EOF
 735
 736     $filename = $_ ;
 737
 738     # Prime the pump by reading the first
 739     # non-blank line
 740
 741     # skip leading blank lines
 742     while (<$FH>) {
 743         last unless /^\s*$/ ;
 744     }
 745
 746     $lastline = $_ ;
 747     $lastline_no = $. ;
 748
 749 }
 750
 751 sub PopFile()
 752 {
 753     return 0 unless $XSStack[-1]{type} eq 'file' ;
 754
 755     my $data     = pop @XSStack ;
 756     my $ThisFile = $filename ;
 757     my $isPipe   = ($filename =~ /\|\s*$/) ;
 758
 759     -- $IncludedFiles{$filename}
 760         unless $isPipe ;
 761
 762     close $FH ;
 763
 764     $FH         = $data->{Handle} ;
 765     $filename   = $data->{Filename} ;
 766     $lastline   = $data->{LastLine} ;
 767     $lastline_no = $data->{LastLineNo} ;
 768     @line       = @{ $data->{Line} } ;
 769     @line_no    = @{ $data->{LineNo} } ;
 770
 771     if ($isPipe and $? ) {
 772         -- $lastline_no ;
 773         print STDERR "Error reading from pipe '$ThisFile': $! in $filename, line $lastline_no\n"  ;
 774         exit 1 ;
 775     }
 776
 777     print Q<<"EOF" ;
 778 #
 779 #/* INCLUDE: Returning to '$filename' from '$ThisFile' */
 780 #
 781 EOF
 782
 783     return 1 ;
 784 }
 785
 786 sub ValidProtoString ($)
 787 {
 788     my($string) = @_ ;
 789
 790     if ( $string =~ /^$proto_re+$/ ) {
 791         return $string ;
 792     }
 793
 794     return 0 ;
 795 }
 796
 797 sub C_string ($)
 798 {
 799     my($string) = @_ ;
 800
 801     $string =~ s[\\][\\\\]g ;
 802     $string ;
 803 }
 804
 805 sub ProtoString ($)
 806 {
 807     my ($type) = @_ ;
 808
 809     $proto_letter{$type} or "\$" ;
 810 }
 811
 812 sub check_cpp {
 813     my @cpp = grep(/^\#\s*(?:if|e\w+)/, @line);
 814     if (@cpp) {
 815         my ($cpp, $cpplevel);
 816         for $cpp (@cpp) {
 817             if ($cpp =~ /^\#\s*if/) {
 818                 $cpplevel++;
 819             } elsif (!$cpplevel) {
 820                 Warn("Warning: #else/elif/endif without #if in this function");
 821                 print STDERR "    (precede it with a blank line if the matching #if is outside the function)\n"
 822                     if $XSStack[-1]{type} eq 'if';
 823                 return;
 824             } elsif ($cpp =~ /^\#\s*endif/) {
 825                 $cpplevel--;
 826             }
 827         }
 828         Warn("Warning: #if without #endif in this function") if $cpplevel;
 829     }
 830 }
 831
 832
 833 sub Q {
 834     my($text) = @_;
 835     $text =~ s/^#//gm;
 836     $text =~ s/\[\[/{/g;
 837     $text =~ s/\]\]/}/g;
 838     $text;
 839 }
 840
 841 open($FH, $filename) or die "cannot open $filename: $!\n";
 842
 843 # Identify the version of xsubpp used
 844 print <<EOM ;
 845 /*
 846  * This file was generated automatically by xsubpp version $XSUBPP_version from the
 847  * contents of $filename. Do not edit this file, edit $filename instead.
 848  *
 849  *      ANY CHANGES MADE HERE WILL BE LOST!
 850  *
 851  */
 852
 853 EOM
 854
 855
 856 print("#line 1 \"$filename\"\n")
 857     if $WantLineNumbers;
 858
 859 firstmodule:
 860 while (<$FH>) {
 861     if (/^=/) {
 862         my $podstartline = $.;
 863         do {
 864             if (/^=cut\s*$/) {
 865                 print("/* Skipped embedded POD. */\n");
 866                 printf("#line %d \"$filename\"\n", $. + 1)
 867                   if $WantLineNumbers;
 868                 next firstmodule
 869             }
 870
 871         } while (<$FH>);
 872         # At this point $. is at end of file so die won't state the start
 873         # of the problem, and as we haven't yet read any lines &death won't
 874         # show the correct line in the message either.
 875         die ("Error: Unterminated pod in $filename, line $podstartline\n")
 876           unless $lastline;
 877     }
 878     last if ($Module, $Package, $Prefix) =
 879         /^MODULE\s*=\s*([\w:]+)(?:\s+PACKAGE\s*=\s*([\w:]+))?(?:\s+PREFIX\s*=\s*(\S+))?\s*$/;
 880
 881     if ($OBJ) {
 882         s/#if(?:def\s|\s+defined)\s*(\(__cplusplus\)|__cplusplus)/#if defined(__cplusplus) && !defined(PERL_OBJECT)/;
 883     }
 884     print $_;
 885 }
 886 &Exit unless defined $_;
 887
 888 print "$xsubpp::counter::SECTION_END_MARKER\n" if $WantLineNumbers;
 889
 890 $lastline    = $_;
 891 $lastline_no = $.;
 892
 893 # Read next xsub into @line from ($lastline, <$FH>).
 894 sub fetch_para {
 895     # parse paragraph
 896     death ("Error: Unterminated `#if/#ifdef/#ifndef'")
 897         if !defined $lastline && $XSStack[-1]{type} eq 'if';
 898     @line = ();
 899     @line_no = () ;
 900     return PopFile() if !defined $lastline;
 901
 902     if ($lastline =~
 903         /^MODULE\s*=\s*([\w:]+)(?:\s+PACKAGE\s*=\s*([\w:]+))?(?:\s+PREFIX\s*=\s*(\S+))?\s*$/) {
 904         $Module = $1;
 905         $Package = defined($2) ? $2 : '';       # keep -w happy
 906         $Prefix  = defined($3) ? $3 : '';       # keep -w happy
 907         $Prefix = quotemeta $Prefix ;
 908         ($Module_cname = $Module) =~ s/\W/_/g;
 909         ($Packid = $Package) =~ tr/:/_/;
 910         $Packprefix = $Package;
 911         $Packprefix .= "::" if $Packprefix ne "";
 912         $lastline = "";
 913     }
 914
 915     for(;;) {
 916         # Skip embedded PODs
 917         while ($lastline =~ /^=/) {
 918             while ($lastline = <$FH>) {
 919                 last if ($lastline =~ /^=cut\s*$/);
 920             }
 921             death ("Error: Unterminated pod") unless $lastline;
 922             $lastline = <$FH>;
 923             chomp $lastline;
 924             $lastline =~ s/^\s+$//;
 925         }
 926         if ($lastline !~ /^\s*#/ ||
 927             # CPP directives:
 928             #   ANSI:   if ifdef ifndef elif else endif define undef
 929             #           line error pragma
 930             #   gcc:    warning include_next
 931             #   obj-c:  import
 932             #   others: ident (gcc notes that some cpps have this one)
 933             $lastline =~ /^#[ \t]*(?:(?:if|ifn?def|elif|else|endif|define|undef|pragma|error|warning|line\s+\d+|ident)\b|(?:include(?:_next)?|import)\s*["<].*[>"])/) {
 934             last if $lastline =~ /^\S/ && @line && $line[-1] eq "";
 935             push(@line, $lastline);
 936             push(@line_no, $lastline_no) ;
 937         }
 938
 939         # Read next line and continuation lines
 940         last unless defined($lastline = <$FH>);
 941         $lastline_no = $.;
 942         my $tmp_line;
 943         $lastline .= $tmp_line
 944             while ($lastline =~ /\\$/ && defined($tmp_line = <$FH>));
 945
 946         chomp $lastline;
 947         $lastline =~ s/^\s+$//;
 948     }
 949     pop(@line), pop(@line_no) while @line && $line[-1] eq "";
 950     1;
 951 }
 952
 953 PARAGRAPH:
 954 while (fetch_para()) {
 955     # Print initial preprocessor statements and blank lines
 956     while (@line && $line[0] !~ /^[^\#]/) {
 957         my $line = shift(@line);
 958         print $line, "\n";
 959         next unless $line =~ /^\#\s*((if)(?:n?def)?|elsif|else|endif)\b/;
 960         my $statement = $+;
 961         if ($statement eq 'if') {
 962             $XSS_work_idx = @XSStack;
 963             push(@XSStack, {type => 'if'});
 964         } else {
 965             death ("Error: `$statement' with no matching `if'")
 966                 if $XSStack[-1]{type} ne 'if';
 967             if ($XSStack[-1]{varname}) {
 968                 push(@InitFileCode, "#endif\n");
 969                 push(@BootCode,     "#endif");
 970             }
 971
 972             my(@fns) = keys %{$XSStack[-1]{functions}};
 973             if ($statement ne 'endif') {
 974                 # Hide the functions defined in other #if branches, and reset.
 975                 @{$XSStack[-1]{other_functions}}{@fns} = (1) x @fns;
 976                 @{$XSStack[-1]}{qw(varname functions)} = ('', {});
 977             } else {
 978                 my($tmp) = pop(@XSStack);
 979                 0 while (--$XSS_work_idx
 980                          && $XSStack[$XSS_work_idx]{type} ne 'if');
 981                 # Keep all new defined functions
 982                 push(@fns, keys %{$tmp->{other_functions}});
 983                 @{$XSStack[$XSS_work_idx]{functions}}{@fns} = (1) x @fns;
 984             }
 985         }
 986     }
 987
 988     next PARAGRAPH unless @line;
 989
 990     if ($XSS_work_idx && !$XSStack[$XSS_work_idx]{varname}) {
 991         # We are inside an #if, but have not yet #defined its xsubpp variable.
 992         print "#define $cpp_next_tmp 1\n\n";
 993         push(@InitFileCode, "#if $cpp_next_tmp\n");
 994         push(@BootCode,     "#if $cpp_next_tmp");
 995         $XSStack[$XSS_work_idx]{varname} = $cpp_next_tmp++;
 996     }
 997
 998     death ("Code is not inside a function"
 999            ." (maybe last function was ended by a blank line "
1000            ." followed by a a statement on column one?)")
1001         if $line[0] =~ /^\s/;
1002
1003     # initialize info arrays
1004     undef(%args_match);
1005     undef(%var_types);
1006     undef(%var_addr);
1007     undef(%defaults);
1008     undef($class);
1009     undef($static);
1010     undef($elipsis);
1011     undef($wantRETVAL) ;
1012     undef($RETVAL_no_return) ;
1013     undef(%arg_list) ;
1014     undef(@proto_arg) ;
1015     undef(@arg_with_types) ;
1016     undef($processing_arg_with_types) ;
1017     undef(%arg_types) ;
1018     undef(@in_out) ;
1019     undef(%in_out) ;
1020     undef($proto_in_this_xsub) ;
1021     undef($scope_in_this_xsub) ;
1022     undef($interface);
1023     undef($prepush_done);
1024     $interface_macro = 'XSINTERFACE_FUNC' ;
1025     $interface_macro_set = 'XSINTERFACE_FUNC_SET' ;
1026     $ProtoThisXSUB = $WantPrototypes ;
1027     $ScopeThisXSUB = 0;
1028     $xsreturn = 0;
1029
1030     $_ = shift(@line);
1031     while ($kwd = check_keyword("REQUIRE|PROTOTYPES|VERSIONCHECK|INCLUDE")) {
1032         &{"${kwd}_handler"}() ;
1033         next PARAGRAPH unless @line ;
1034         $_ = shift(@line);
1035     }
1036
1037     if (check_keyword("BOOT")) {
1038         &check_cpp;
1039         push (@BootCode, "#line $line_no[@line_no - @line] \"$filename\"")
1040           if $WantLineNumbers && $line[0] !~ /^\s*#\s*line\b/;
1041         push (@BootCode, @line, "") ;
1042         next PARAGRAPH ;
1043     }
1044
1045
1046     # extract return type, function name and arguments
1047     ($ret_type) = TidyType($_);
1048     $RETVAL_no_return = 1 if $ret_type =~ s/^NO_OUTPUT\s+//;
1049
1050     # Allow one-line ANSI-like declaration
1051     unshift @line, $2
1052       if $process_argtypes
1053         and $ret_type =~ s/^(.*?\w.*?)\s*\b(\w+\s*\(.*)/$1/s;
1054
1055     # a function definition needs at least 2 lines
1056     blurt ("Error: Function definition too short '$ret_type'"), next PARAGRAPH
1057         unless @line ;
1058
1059     $static = 1 if $ret_type =~ s/^static\s+//;
1060
1061     $func_header = shift(@line);
1062     blurt ("Error: Cannot parse function definition from '$func_header'"), next PARAGRAPH
1063         unless $func_header =~ /^(?:([\w:]*)::)?(\w+)\s*\(\s*(.*?)\s*\)\s*(const)?\s*(;\s*)?$/s;
1064
1065     ($class, $func_name, $orig_args) =  ($1, $2, $3) ;
1066     $class = "$4 $class" if $4;
1067     ($pname = $func_name) =~ s/^($Prefix)?/$Packprefix/;
1068     ($clean_func_name = $func_name) =~ s/^$Prefix//;
1069     $Full_func_name = "${Packid}_$clean_func_name";
1070     if ($Is_VMS) { $Full_func_name = $SymSet->addsym($Full_func_name); }
1071
1072     # Check for duplicate function definition
1073     for $tmp (@XSStack) {
1074         next unless defined $tmp->{functions}{$Full_func_name};
1075         Warn("Warning: duplicate function definition '$clean_func_name' detected");
1076         last;
1077     }
1078     $XSStack[$XSS_work_idx]{functions}{$Full_func_name} ++ ;
1079     %XsubAliases = %XsubAliasValues = %Interfaces = @Attributes = ();
1080     $DoSetMagic = 1;
1081
1082     $orig_args =~ s/\\\s*/ /g;          # process line continuations
1083
1084     my %out_vars;
1085     if ($process_argtypes and $orig_args =~ /\S/) {
1086         my $args = "$orig_args ,";
1087         if ($args =~ /^( (??{ $C_arg }) , )* $ /x) {
1088             @args = ($args =~ /\G ( (??{ $C_arg }) ) , /xg);
1089             for ( @args ) {
1090                 s/^\s+//;
1091                 s/\s+$//;
1092                 my $arg = $_;
1093                 my $default;
1094                 ($arg, $default) = / ( [^=]* ) ( (?: = .* )? ) /x;
1095                 my ($pre, $name) = ($arg =~ /(.*?) \s* \b(\w+) \s* $ /x);
1096                 next unless length $pre;
1097                 my $out_type;
1098                 my $inout_var;
1099                 if ($process_inout and s/^(IN|IN_OUTLIST|OUTLIST)\s+//) {
1100                     my $type = $1;
1101                     $out_type = $type if $type ne 'IN';
1102                     $arg =~ s/^(IN|IN_OUTLIST|OUTLIST)\s+//;
1103                 }
1104                 if (/\W/) {     # Has a type
1105                     push @arg_with_types, $arg;
1106                     # warn "pushing '$arg'\n";
1107                     $arg_types{$name} = $arg;
1108                     $_ = "$name$default";
1109                 }
1110                 $out_vars{$_} = 1 if $out_type eq 'OUTLIST';
1111                 push @in_out, $name if $out_type;
1112                 $in_out{$name} = $out_type if $out_type;
1113             }
1114         } else {
1115             @args = split(/\s*,\s*/, $orig_args);
1116             Warn("Warning: cannot parse argument list '$orig_args', fallback to split");
1117         }
1118     } else {
1119         @args = split(/\s*,\s*/, $orig_args);
1120         for (@args) {
1121             if ($process_inout and s/^(IN|IN_OUTLIST|OUTLIST)\s+//) {
1122                 my $out_type = $1;
1123                 next if $out_type eq 'IN';
1124                 $out_vars{$_} = 1 if $out_type eq 'OUTLIST';
1125                 push @in_out, $name;
1126                 $in_out{$_} = $out_type;
1127             }
1128         }
1129     }
1130     if (defined($class)) {
1131         my $arg0 = ((defined($static) or $func_name eq 'new')
1132                     ? "CLASS" : "THIS");
1133         unshift(@args, $arg0);
1134         ($report_args = "$arg0, $report_args") =~ s/^\w+, $/$arg0/;
1135     }
1136     my $extra_args = 0;
1137     @args_num = ();
1138     $num_args = 0;
1139     my $report_args = '';
1140     foreach $i (0 .. $#args) {
1141             if ($args[$i] =~ s/\.\.\.//) {
1142                     $elipsis = 1;
1143                     if ($args[$i] eq '' && $i == $#args) {
1144                         $report_args .= ", ...";
1145                         pop(@args);
1146                         last;
1147                     }
1148             }
1149             if ($out_vars{$args[$i]}) {
1150                 push @args_num, undef;
1151             } else {
1152                 push @args_num, ++$num_args;
1153                 $report_args .= ", $args[$i]";
1154             }
1155             if ($args[$i] =~ /^([^=]*[^\s=])\s*=\s*(.*)/s) {
1156                     $extra_args++;
1157                     $args[$i] = $1;
1158                     $defaults{$args[$i]} = $2;
1159                     $defaults{$args[$i]} =~ s/"/\\"/g;
1160             }
1161             $proto_arg[$i+1] = "\$" ;
1162     }
1163     $min_args = $num_args - $extra_args;
1164     $report_args =~ s/"/\\"/g;
1165     $report_args =~ s/^,\s+//;
1166     my @func_args = @args;
1167     shift @func_args if defined($class);
1168
1169     for (@func_args) {
1170         s/^/&/ if $in_out{$_};
1171     }
1172     $func_args = join(", ", @func_args);
1173     @args_match{@args} = @args_num;
1174
1175     $PPCODE = grep(/^\s*PPCODE\s*:/, @line);
1176     $CODE = grep(/^\s*CODE\s*:/, @line);
1177     # Detect CODE: blocks which use ST(n)= or XST_m*(n,v)
1178     #   to set explicit return values.
1179     $EXPLICIT_RETURN = ($CODE &&
1180                 ("@line" =~ /(\bST\s*\([^;]*=) | (\bXST_m\w+\s*\()/x ));
1181     $ALIAS  = grep(/^\s*ALIAS\s*:/,  @line);
1182     $INTERFACE  = grep(/^\s*INTERFACE\s*:/,  @line);
1183
1184     $xsreturn = 1 if $EXPLICIT_RETURN;
1185
1186     # print function header
1187     print Q<<"EOF";
1188 #XS(XS_${Full_func_name})
1189 #[[
1190 #    dXSARGS;
1191 EOF
1192     print Q<<"EOF" if $ALIAS ;
1193 #    dXSI32;
1194 EOF
1195     print Q<<"EOF" if $INTERFACE ;
1196 #    dXSFUNCTION($ret_type);
1197 EOF
1198     if ($elipsis) {
1199         $cond = ($min_args ? qq(items < $min_args) : 0);
1200     }
1201     elsif ($min_args == $num_args) {
1202         $cond = qq(items != $min_args);
1203     }
1204     else {
1205         $cond = qq(items < $min_args || items > $num_args);
1206     }
1207
1208     print Q<<"EOF" if $except;
1209 #    char errbuf[1024];
1210 #    *errbuf = '\0';
1211 EOF
1212
1213     if ($ALIAS)
1214       { print Q<<"EOF" if $cond }
1215 #    if ($cond)
1216 #       Perl_croak(aTHX_ "Usage: %s($report_args)", GvNAME(CvGV(cv)));
1217 EOF
1218     else
1219       { print Q<<"EOF" if $cond }
1220 #    if ($cond)
1221 #       Perl_croak(aTHX_ "Usage: $pname($report_args)");
1222 EOF
1223
1224     print Q<<"EOF" if $PPCODE;
1225 #    SP -= items;
1226 EOF
1227
1228     # Now do a block of some sort.
1229
1230     $condnum = 0;
1231     $cond = '';                 # last CASE: condidional
1232     push(@line, "$END:");
1233     push(@line_no, $line_no[-1]);
1234     $_ = '';
1235     &check_cpp;
1236     while (@line) {
1237         &CASE_handler if check_keyword("CASE");
1238         print Q<<"EOF";
1239 #   $except [[
1240 EOF
1241
1242         # do initialization of input variables
1243         $thisdone = 0;
1244         $retvaldone = 0;
1245         $deferred = "";
1246         %arg_list = () ;
1247         $gotRETVAL = 0;
1248
1249         INPUT_handler() ;
1250         process_keyword("INPUT|PREINIT|INTERFACE_MACRO|C_ARGS|ALIAS|ATTRS|PROTOTYPE|SCOPE") ;
1251
1252         print Q<<"EOF" if $ScopeThisXSUB;
1253 #   ENTER;
1254 #   [[
1255 EOF
1256
1257         if (!$thisdone && defined($class)) {
1258             if (defined($static) or $func_name eq 'new') {
1259                 print "\tchar *";
1260                 $var_types{"CLASS"} = "char *";
1261                 &generate_init("char *", 1, "CLASS");
1262             }
1263             else {
1264                 print "\t$class *";
1265                 $var_types{"THIS"} = "$class *";
1266                 &generate_init("$class *", 1, "THIS");
1267             }
1268         }
1269
1270         # do code
1271         if (/^\s*NOT_IMPLEMENTED_YET/) {
1272                 print "\n\tPerl_croak(aTHX_ \"$pname: not implemented yet\");\n";
1273                 $_ = '' ;
1274         } else {
1275                 if ($ret_type ne "void") {
1276                         print "\t" . &map_type($ret_type, 'RETVAL') . ";\n"
1277                                 if !$retvaldone;
1278                         $args_match{"RETVAL"} = 0;
1279                         $var_types{"RETVAL"} = $ret_type;
1280                         print "\tdXSTARG;\n"
1281                                 if $WantOptimize and $targetable{$type_kind{$ret_type}};
1282                 }
1283
1284                 if (@arg_with_types) {
1285                     unshift @line, @arg_with_types, $_;
1286                     $_ = "";
1287                     $processing_arg_with_types = 1;
1288                     INPUT_handler() ;
1289                 }
1290                 print $deferred;
1291
1292         process_keyword("INIT|ALIAS|ATTRS|PROTOTYPE|INTERFACE_MACRO|INTERFACE|C_ARGS") ;
1293
1294                 if (check_keyword("PPCODE")) {
1295                         print_section();
1296                         death ("PPCODE must be last thing") if @line;
1297                         print "\tLEAVE;\n" if $ScopeThisXSUB;
1298                         print "\tPUTBACK;\n\treturn;\n";
1299                 } elsif (check_keyword("CODE")) {
1300                         print_section() ;
1301                 } elsif (defined($class) and $func_name eq "DESTROY") {
1302                         print "\n\t";
1303                         print "delete THIS;\n";
1304                 } else {
1305                         print "\n\t";
1306                         if ($ret_type ne "void") {
1307                                 print "RETVAL = ";
1308                                 $wantRETVAL = 1;
1309                         }
1310                         if (defined($static)) {
1311                             if ($func_name eq 'new') {
1312                                 $func_name = "$class";
1313                             } else {
1314                                 print "${class}::";
1315                             }
1316                         } elsif (defined($class)) {
1317                             if ($func_name eq 'new') {
1318                                 $func_name .= " $class";
1319                             } else {
1320                                 print "THIS->";
1321                             }
1322                         }
1323                         $func_name =~ s/^($spat)//
1324                             if defined($spat);
1325                         $func_name = 'XSFUNCTION' if $interface;
1326                         print "$func_name($func_args);\n";
1327                 }
1328         }
1329
1330         # do output variables
1331         $gotRETVAL = 0;         # 1 if RETVAL seen in OUTPUT section;
1332         undef $RETVAL_code ;    # code to set RETVAL (from OUTPUT section);
1333         # $wantRETVAL set if 'RETVAL =' autogenerated
1334         ($wantRETVAL, $ret_type) = (0, 'void') if $RETVAL_no_return;
1335         undef %outargs ;
1336         process_keyword("POSTCALL|OUTPUT|ALIAS|ATTRS|PROTOTYPE");
1337
1338         # all OUTPUT done, so now push the return value on the stack
1339         if ($gotRETVAL && $RETVAL_code) {
1340             print "\t$RETVAL_code\n";
1341         } elsif ($gotRETVAL || $wantRETVAL) {
1342             my $t = $WantOptimize && $targetable{$type_kind{$ret_type}};
1343             my $var = 'RETVAL';
1344             my $type = $ret_type;
1345
1346             # 0: type, 1: with_size, 2: how, 3: how_size
1347             if ($t and not $t->[1] and $t->[0] eq 'p') {
1348                 # PUSHp corresponds to setpvn.  Treate setpv directly
1349                 my $what = eval qq("$t->[2]");
1350                 warn $@ if $@;
1351
1352                 print "\tsv_setpv(TARG, $what); XSprePUSH; PUSHTARG;\n";
1353                 $prepush_done = 1;
1354             }
1355             elsif ($t) {
1356                 my $what = eval qq("$t->[2]");
1357                 warn $@ if $@;
1358
1359                 my $size = $t->[3];
1360                 $size = '' unless defined $size;
1361                 $size = eval qq("$size");
1362                 warn $@ if $@;
1363                 print "\tXSprePUSH; PUSH$t->[0]($what$size);\n";
1364                 $prepush_done = 1;
1365             }
1366             else {
1367                 # RETVAL almost never needs SvSETMAGIC()
1368                 &generate_output($ret_type, 0, 'RETVAL', 0);
1369             }
1370         }
1371
1372         $xsreturn = 1 if $ret_type ne "void";
1373         my $num = $xsreturn;
1374         my $c = @in_out;
1375         print "\tXSprePUSH;" if $c and not $prepush_done;
1376         print "\tEXTEND(SP,$c);\n" if $c;
1377         $xsreturn += $c;
1378         generate_output($var_types{$_}, $num++, $_, 0, 1) for @in_out;
1379
1380         # do cleanup
1381         process_keyword("CLEANUP|ALIAS|ATTRS|PROTOTYPE") ;
1382
1383         print Q<<"EOF" if $ScopeThisXSUB;
1384 #   ]]
1385 EOF
1386         print Q<<"EOF" if $ScopeThisXSUB and not $PPCODE;
1387 #   LEAVE;
1388 EOF
1389
1390         # print function trailer
1391         print Q<<EOF;
1392 #    ]]
1393 EOF
1394         print Q<<EOF if $except;
1395 #    BEGHANDLERS
1396 #    CATCHALL
1397 #       sprintf(errbuf, "%s: %s\\tpropagated", Xname, Xreason);
1398 #    ENDHANDLERS
1399 EOF
1400         if (check_keyword("CASE")) {
1401             blurt ("Error: No `CASE:' at top of function")
1402                 unless $condnum;
1403             $_ = "CASE: $_";    # Restore CASE: label
1404             next;
1405         }
1406         last if $_ eq "$END:";
1407         death(/^$BLOCK_re/o ? "Misplaced `$1:'" : "Junk at end of function");
1408     }
1409
1410     print Q<<EOF if $except;
1411 #    if (errbuf[0])
1412 #       Perl_croak(aTHX_ errbuf);
1413 EOF
1414
1415     if ($xsreturn) {
1416         print Q<<EOF unless $PPCODE;
1417 #    XSRETURN($xsreturn);
1418 EOF
1419     } else {
1420         print Q<<EOF unless $PPCODE;
1421 #    XSRETURN_EMPTY;
1422 EOF
1423     }
1424
1425     print Q<<EOF;
1426 #]]
1427 #
1428 EOF
1429
1430     my $newXS = "newXS" ;
1431     my $proto = "" ;
1432
1433     # Build the prototype string for the xsub
1434     if ($ProtoThisXSUB) {
1435         $newXS = "newXSproto";
1436
1437         if ($ProtoThisXSUB eq 2) {
1438             # User has specified empty prototype
1439             $proto = ', ""' ;
1440         }
1441         elsif ($ProtoThisXSUB ne 1) {
1442             # User has specified a prototype
1443             $proto = ', "' . $ProtoThisXSUB . '"';
1444         }
1445         else {
1446             my $s = ';';
1447             if ($min_args < $num_args)  {
1448                 $s = '';
1449                 $proto_arg[$min_args] .= ";" ;
1450             }
1451             push @proto_arg, "$s\@"
1452                 if $elipsis ;
1453
1454             $proto = ', "' . join ("", @proto_arg) . '"';
1455         }
1456     }
1457
1458     if (%XsubAliases) {
1459         $XsubAliases{$pname} = 0
1460             unless defined $XsubAliases{$pname} ;
1461         while ( ($name, $value) = each %XsubAliases) {
1462             push(@InitFileCode, Q<<"EOF");
1463 #        cv = newXS(\"$name\", XS_$Full_func_name, file);
1464 #        XSANY.any_i32 = $value ;
1465 EOF
1466         push(@InitFileCode, Q<<"EOF") if $proto;
1467 #        sv_setpv((SV*)cv$proto) ;
1468 EOF
1469         }
1470     }
1471     elsif (@Attributes) {
1472             push(@InitFileCode, Q<<"EOF");
1473 #        cv = newXS(\"$pname\", XS_$Full_func_name, file);
1474 #        apply_attrs_string("$Package", cv, "@Attributes", 0);
1475 EOF
1476     }
1477     elsif ($interface) {
1478         while ( ($name, $value) = each %Interfaces) {
1479             $name = "$Package\::$name" unless $name =~ /::/;
1480             push(@InitFileCode, Q<<"EOF");
1481 #        cv = newXS(\"$name\", XS_$Full_func_name, file);
1482 #        $interface_macro_set(cv,$value) ;
1483 EOF
1484             push(@InitFileCode, Q<<"EOF") if $proto;
1485 #        sv_setpv((SV*)cv$proto) ;
1486 EOF
1487         }
1488     }
1489     else {
1490         push(@InitFileCode,
1491              "        ${newXS}(\"$pname\", XS_$Full_func_name, file$proto);\n");
1492     }
1493 }
1494
1495 # print initialization routine
1496
1497 print Q<<"EOF";
1498 ##ifdef __cplusplus
1499 #extern "C"
1500 ##endif
1501 EOF
1502
1503 print Q<<"EOF";
1504 #XS(boot_$Module_cname)
1505 EOF
1506
1507 print Q<<"EOF";
1508 #[[
1509 #    dXSARGS;
1510 #    char* file = __FILE__;
1511 #
1512 EOF
1513
1514 print Q<<"EOF" if $WantVersionChk ;
1515 #    XS_VERSION_BOOTCHECK ;
1516 #
1517 EOF
1518
1519 print Q<<"EOF" if defined $XsubAliases or defined $Interfaces ;
1520 #    {
1521 #        CV * cv ;
1522 #
1523 EOF
1524
1525 print @InitFileCode;
1526
1527 print Q<<"EOF" if defined $XsubAliases or defined $Interfaces ;
1528 #    }
1529 EOF
1530
1531 if (@BootCode)
1532 {
1533     print "\n    /* Initialisation Section */\n\n" ;
1534     @line = @BootCode;
1535     print_section();
1536     print "\n    /* End of Initialisation Section */\n\n" ;
1537 }
1538
1539 print Q<<"EOF";;
1540 #    XSRETURN_YES;
1541 #]]
1542 #
1543 EOF
1544
1545 warn("Please specify prototyping behavior for $filename (see perlxs manual)\n")
1546     unless $ProtoUsed ;
1547 &Exit;
1548
1549 sub output_init {
1550     local($type, $num, $var, $init, $name_printed) = @_;
1551     local($arg) = "ST(" . ($num - 1) . ")";
1552
1553     if(  $init =~ /^=/  ) {
1554         if ($name_printed) {
1555           eval qq/print " $init\\n"/;
1556         } else {
1557           eval qq/print "\\t$var $init\\n"/;
1558         }
1559         warn $@   if  $@;
1560     } else {
1561         if(  $init =~ s/^\+//  &&  $num  ) {
1562             &generate_init($type, $num, $var, $name_printed);
1563         } elsif ($name_printed) {
1564             print ";\n";
1565             $init =~ s/^;//;
1566         } else {
1567             eval qq/print "\\t$var;\\n"/;
1568             warn $@   if  $@;
1569             $init =~ s/^;//;
1570         }
1571         $deferred .= eval qq/"\\n\\t$init\\n"/;
1572         warn $@   if  $@;
1573     }
1574 }
1575
1576 sub Warn
1577 {
1578     # work out the line number
1579     my $line_no = $line_no[@line_no - @line -1] ;
1580
1581     print STDERR "@_ in $filename, line $line_no\n" ;
1582 }
1583
1584 sub blurt
1585 {
1586     Warn @_ ;
1587     $errors ++
1588 }
1589
1590 sub death
1591 {
1592     Warn @_ ;
1593     exit 1 ;
1594 }
1595
1596 sub generate_init {
1597     local($type, $num, $var) = @_;
1598     local($arg) = "ST(" . ($num - 1) . ")";
1599     local($argoff) = $num - 1;
1600     local($ntype);
1601     local($tk);
1602
1603     $type = TidyType($type) ;
1604     blurt("Error: '$type' not in typemap"), return
1605         unless defined($type_kind{$type});
1606
1607     ($ntype = $type) =~ s/\s*\*/Ptr/g;
1608     ($subtype = $ntype) =~ s/(?:Array)?(?:Ptr)?$//;
1609     $tk = $type_kind{$type};
1610     $tk =~ s/OBJ$/REF/ if $func_name =~ /DESTROY$/;
1611     $type =~ tr/:/_/;
1612     blurt("Error: No INPUT definition for type '$type', typekind '$type_kind{$type}' found"), return
1613         unless defined $input_expr{$tk} ;
1614     $expr = $input_expr{$tk};
1615     if ($expr =~ /DO_ARRAY_ELEM/) {
1616         blurt("Error: '$subtype' not in typemap"), return
1617             unless defined($type_kind{$subtype});
1618         blurt("Error: No INPUT definition for type '$subtype', typekind '$type_kind{$subtype}' found"), return
1619             unless defined $input_expr{$type_kind{$subtype}} ;
1620         $subexpr = $input_expr{$type_kind{$subtype}};
1621         $subexpr =~ s/ntype/subtype/g;
1622         $subexpr =~ s/\$arg/ST(ix_$var)/g;
1623         $subexpr =~ s/\n\t/\n\t\t/g;
1624         $subexpr =~ s/is not of (.*\")/[arg %d] is not of $1, ix_$var + 1/g;
1625         $subexpr =~ s/\$var/${var}[ix_$var - $argoff]/;
1626         $expr =~ s/DO_ARRAY_ELEM/$subexpr/;
1627     }
1628     if ($expr =~ m#/\*.*scope.*\*/#i) { # "scope" in C comments
1629         $ScopeThisXSUB = 1;
1630     }
1631     if (defined($defaults{$var})) {
1632             $expr =~ s/(\t+)/$1    /g;
1633             $expr =~ s/        /\t/g;
1634             if ($name_printed) {
1635               print ";\n";
1636             } else {
1637               eval qq/print "\\t$var;\\n"/;
1638               warn $@   if  $@;
1639             }
1640             if ($defaults{$var} eq 'NO_INIT') {
1641                 $deferred .= eval qq/"\\n\\tif (items >= $num) {\\n$expr;\\n\\t}\\n"/;
1642             } else {
1643                 $deferred .= eval qq/"\\n\\tif (items < $num)\\n\\t    $var = $defaults{$var};\\n\\telse {\\n$expr;\\n\\t}\\n"/;
1644             }
1645             warn $@   if  $@;
1646     } elsif ($ScopeThisXSUB or $expr !~ /^\t\$var =/) {
1647             if ($name_printed) {
1648               print ";\n";
1649             } else {
1650               eval qq/print "\\t$var;\\n"/;
1651               warn $@   if  $@;
1652             }
1653             $deferred .= eval qq/"\\n$expr;\\n"/;
1654             warn $@   if  $@;
1655     } else {
1656             die "panic: do not know how to handle this branch for function pointers"
1657               if $name_printed;
1658             eval qq/print "$expr;\\n"/;
1659             warn $@   if  $@;
1660     }
1661 }
1662
1663 sub generate_output {
1664     local($type, $num, $var, $do_setmagic, $do_push) = @_;
1665     local($arg) = "ST(" . ($num - ($num != 0)) . ")";
1666     local($argoff) = $num - 1;
1667     local($ntype);
1668
1669     $type = TidyType($type) ;
1670     if ($type =~ /^array\(([^,]*),(.*)\)/) {
1671             print "\tsv_setpvn($arg, (char *)$var, $2 * sizeof($1));\n";
1672             print "\tSvSETMAGIC($arg);\n" if $do_setmagic;
1673     } else {
1674             blurt("Error: '$type' not in typemap"), return
1675                 unless defined($type_kind{$type});
1676             blurt("Error: No OUTPUT definition for type '$type', typekind '$type_kind{$type}' found"), return
1677                 unless defined $output_expr{$type_kind{$type}} ;
1678             ($ntype = $type) =~ s/\s*\*/Ptr/g;
1679             $ntype =~ s/\(\)//g;
1680             ($subtype = $ntype) =~ s/(?:Array)?(?:Ptr)?$//;
1681             $expr = $output_expr{$type_kind{$type}};
1682             if ($expr =~ /DO_ARRAY_ELEM/) {
1683                 blurt("Error: '$subtype' not in typemap"), return
1684                     unless defined($type_kind{$subtype});
1685                 blurt("Error: No OUTPUT definition for type '$subtype', typekind '$type_kind{$subtype}' found"), return
1686                     unless defined $output_expr{$type_kind{$subtype}} ;
1687                 $subexpr = $output_expr{$type_kind{$subtype}};
1688                 $subexpr =~ s/ntype/subtype/g;
1689                 $subexpr =~ s/\$arg/ST(ix_$var)/g;
1690                 $subexpr =~ s/\$var/${var}[ix_$var]/g;
1691                 $subexpr =~ s/\n\t/\n\t\t/g;
1692                 $expr =~ s/DO_ARRAY_ELEM\n/$subexpr/;
1693                 eval "print qq\a$expr\a";
1694                 warn $@   if  $@;
1695                 print "\t\tSvSETMAGIC(ST(ix_$var));\n" if $do_setmagic;
1696             }
1697             elsif ($var eq 'RETVAL') {
1698                 if ($expr =~ /^\t\$arg = new/) {
1699                     # We expect that $arg has refcnt 1, so we need to
1700                     # mortalize it.
1701                     eval "print qq\a$expr\a";
1702                     warn $@   if  $@;
1703                     print "\tsv_2mortal(ST($num));\n";
1704                     print "\tSvSETMAGIC(ST($num));\n" if $do_setmagic;
1705                 }
1706                 elsif ($expr =~ /^\s*\$arg\s*=/) {
1707                     # We expect that $arg has refcnt >=1, so we need
1708                     # to mortalize it!
1709                     eval "print qq\a$expr\a";
1710                     warn $@   if  $@;
1711                     print "\tsv_2mortal(ST(0));\n";
1712                     print "\tSvSETMAGIC(ST(0));\n" if $do_setmagic;
1713                 }
1714                 else {
1715                     # Just hope that the entry would safely write it
1716                     # over an already mortalized value. By
1717                     # coincidence, something like $arg = &sv_undef
1718                     # works too.
1719                     print "\tST(0) = sv_newmortal();\n";
1720                     eval "print qq\a$expr\a";
1721                     warn $@   if  $@;
1722                     # new mortals don't have set magic
1723                 }
1724             }
1725             elsif ($do_push) {
1726                 print "\tPUSHs(sv_newmortal());\n";
1727                 $arg = "ST($num)";
1728                 eval "print qq\a$expr\a";
1729                 warn $@   if  $@;
1730                 print "\tSvSETMAGIC($arg);\n" if $do_setmagic;
1731             }
1732             elsif ($arg =~ /^ST\(\d+\)$/) {
1733                 eval "print qq\a$expr\a";
1734                 warn $@   if  $@;
1735                 print "\tSvSETMAGIC($arg);\n" if $do_setmagic;
1736             }
1737     }
1738 }
1739
1740 sub map_type {
1741     my($type, $varname) = @_;
1742
1743     $type =~ tr/:/_/;
1744     $type =~ s/^array\(([^,]*),(.*)\).*/$1 */s;
1745     if ($varname) {
1746       if ($varname && $type =~ / \( \s* \* (?= \s* \) ) /xg) {
1747         (substr $type, pos $type, 0) = " $varname ";
1748       } else {
1749         $type .= "\t$varname";
1750       }
1751     }
1752     $type;
1753 }
1754
1755
1756 sub Exit {
1757 # If this is VMS, the exit status has meaning to the shell, so we
1758 # use a predictable value (SS$_Normal or SS$_Abort) rather than an
1759 # arbitrary number.
1760 #    exit ($Is_VMS ? ($errors ? 44 : 1) : $errors) ;
1761     exit ($errors ? 1 : 0);
1762 }