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) = /^(.*?[^&\s])\s*(\&?)\s*\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         $func_args =~ s/\b($var_name)\b/&$1/ if $var_addr;
 448         if ($var_init =~ /^[=;]\s*NO_INIT\s*;?\s*$/
 449             or $in_out{$var_name} and $in_out{$var_name} =~ /^OUT/
 450             and $var_init !~ /\S/) {
 451           if ($name_printed) {
 452             print ";\n";
 453           } else {
 454             print "\t$var_name;\n";
 455           }
 456         } elsif ($var_init =~ /\S/) {
 457             &output_init($var_type, $var_num, $var_name, $var_init, $name_printed);
 458         } elsif ($var_num) {
 459             # generate initialization code
 460             &generate_init($var_type, $var_num, $var_name, $name_printed);
 461         } else {
 462             print ";\n";
 463         }
 464     }
 465 }
 466
 467 sub OUTPUT_handler {
 468     for (;  !/^$BLOCK_re/o;  $_ = shift(@line)) {
 469         next unless /\S/;
 470         if (/^\s*SETMAGIC\s*:\s*(ENABLE|DISABLE)\s*/) {
 471             $DoSetMagic = ($1 eq "ENABLE" ? 1 : 0);
 472             next;
 473         }
 474         my ($outarg, $outcode) = /^\s*(\S+)\s*(.*?)\s*$/s ;
 475         blurt ("Error: duplicate OUTPUT argument '$outarg' ignored"), next
 476             if $outargs{$outarg} ++ ;
 477         if (!$gotRETVAL and $outarg eq 'RETVAL') {
 478             # deal with RETVAL last
 479             $RETVAL_code = $outcode ;
 480             $gotRETVAL = 1 ;
 481             next ;
 482         }
 483         blurt ("Error: OUTPUT $outarg not an argument"), next
 484             unless defined($args_match{$outarg});
 485         blurt("Error: No input definition for OUTPUT argument '$outarg' - ignored"), next
 486             unless defined $var_types{$outarg} ;
 487         $var_num = $args_match{$outarg};
 488         if ($outcode) {
 489             print "\t$outcode\n";
 490             print "\tSvSETMAGIC(ST(" , $var_num-1 , "));\n" if $DoSetMagic;
 491         } else {
 492             &generate_output($var_types{$outarg}, $var_num, $outarg, $DoSetMagic);
 493         }
 494         delete $in_out{$outarg}         # No need to auto-OUTPUT
 495           if exists $in_out{$outarg} and $in_out{$outarg} =~ /OUT$/;
 496     }
 497 }
 498
 499 sub C_ARGS_handler() {
 500     my $in = merge_section();
 501
 502     TrimWhitespace($in);
 503     $func_args = $in;
 504 }
 505
 506 sub INTERFACE_MACRO_handler() {
 507     my $in = merge_section();
 508
 509     TrimWhitespace($in);
 510     if ($in =~ /\s/) {          # two
 511         ($interface_macro, $interface_macro_set) = split ' ', $in;
 512     } else {
 513         $interface_macro = $in;
 514         $interface_macro_set = 'UNKNOWN_CVT'; # catch later
 515     }
 516     $interface = 1;             # local
 517     $Interfaces = 1;            # global
 518 }
 519
 520 sub INTERFACE_handler() {
 521     my $in = merge_section();
 522
 523     TrimWhitespace($in);
 524
 525     foreach (split /[\s,]+/, $in) {
 526         $Interfaces{$_} = $_;
 527     }
 528     print Q<<"EOF";
 529 #       XSFUNCTION = $interface_macro($ret_type,cv,XSANY.any_dptr);
 530 EOF
 531     $interface = 1;             # local
 532     $Interfaces = 1;            # global
 533 }
 534
 535 sub CLEANUP_handler() { print_section() }
 536 sub PREINIT_handler() { print_section() }
 537 sub POSTCALL_handler() { print_section() }
 538 sub INIT_handler()    { print_section() }
 539
 540 sub GetAliases
 541 {
 542     my ($line) = @_ ;
 543     my ($orig) = $line ;
 544     my ($alias) ;
 545     my ($value) ;
 546
 547     # Parse alias definitions
 548     # format is
 549     #    alias = value alias = value ...
 550
 551     while ($line =~ s/^\s*([\w:]+)\s*=\s*(\w+)\s*//) {
 552         $alias = $1 ;
 553         $orig_alias = $alias ;
 554         $value = $2 ;
 555
 556         # check for optional package definition in the alias
 557         $alias = $Packprefix . $alias if $alias !~ /::/ ;
 558
 559         # check for duplicate alias name & duplicate value
 560         Warn("Warning: Ignoring duplicate alias '$orig_alias'")
 561             if defined $XsubAliases{$alias} ;
 562
 563         Warn("Warning: Aliases '$orig_alias' and '$XsubAliasValues{$value}' have identical values")
 564             if $XsubAliasValues{$value} ;
 565
 566         $XsubAliases = 1;
 567         $XsubAliases{$alias} = $value ;
 568         $XsubAliasValues{$value} = $orig_alias ;
 569     }
 570
 571     blurt("Error: Cannot parse ALIAS definitions from '$orig'")
 572         if $line ;
 573 }
 574
 575 sub ATTRS_handler ()
 576 {
 577     for (;  !/^$BLOCK_re/o;  $_ = shift(@line)) {
 578         next unless /\S/;
 579         TrimWhitespace($_) ;
 580         push @Attributes, $_;
 581     }
 582 }
 583
 584 sub ALIAS_handler ()
 585 {
 586     for (;  !/^$BLOCK_re/o;  $_ = shift(@line)) {
 587         next unless /\S/;
 588         TrimWhitespace($_) ;
 589         GetAliases($_) if $_ ;
 590     }
 591 }
 592
 593 sub REQUIRE_handler ()
 594 {
 595     # the rest of the current line should contain a version number
 596     my ($Ver) = $_ ;
 597
 598     TrimWhitespace($Ver) ;
 599
 600     death ("Error: REQUIRE expects a version number")
 601         unless $Ver ;
 602
 603     # check that the version number is of the form n.n
 604     death ("Error: REQUIRE: expected a number, got '$Ver'")
 605         unless $Ver =~ /^\d+(\.\d*)?/ ;
 606
 607     death ("Error: xsubpp $Ver (or better) required--this is only $XSUBPP_version.")
 608         unless $XSUBPP_version >= $Ver ;
 609 }
 610
 611 sub VERSIONCHECK_handler ()
 612 {
 613     # the rest of the current line should contain either ENABLE or
 614     # DISABLE
 615
 616     TrimWhitespace($_) ;
 617
 618     # check for ENABLE/DISABLE
 619     death ("Error: VERSIONCHECK: ENABLE/DISABLE")
 620         unless /^(ENABLE|DISABLE)/i ;
 621
 622     $WantVersionChk = 1 if $1 eq 'ENABLE' ;
 623     $WantVersionChk = 0 if $1 eq 'DISABLE' ;
 624
 625 }
 626
 627 sub PROTOTYPE_handler ()
 628 {
 629     my $specified ;
 630
 631     death("Error: Only 1 PROTOTYPE definition allowed per xsub")
 632         if $proto_in_this_xsub ++ ;
 633
 634     for (;  !/^$BLOCK_re/o;  $_ = shift(@line)) {
 635         next unless /\S/;
 636         $specified = 1 ;
 637         TrimWhitespace($_) ;
 638         if ($_ eq 'DISABLE') {
 639            $ProtoThisXSUB = 0
 640         }
 641         elsif ($_ eq 'ENABLE') {
 642            $ProtoThisXSUB = 1
 643         }
 644         else {
 645             # remove any whitespace
 646             s/\s+//g ;
 647             death("Error: Invalid prototype '$_'")
 648                 unless ValidProtoString($_) ;
 649             $ProtoThisXSUB = C_string($_) ;
 650         }
 651     }
 652
 653     # If no prototype specified, then assume empty prototype ""
 654     $ProtoThisXSUB = 2 unless $specified ;
 655
 656     $ProtoUsed = 1 ;
 657
 658 }
 659
 660 sub SCOPE_handler ()
 661 {
 662     death("Error: Only 1 SCOPE declaration allowed per xsub")
 663         if $scope_in_this_xsub ++ ;
 664
 665     for (;  !/^$BLOCK_re/o;  $_ = shift(@line)) {
 666                 next unless /\S/;
 667                 TrimWhitespace($_) ;
 668         if ($_ =~ /^DISABLE/i) {
 669                    $ScopeThisXSUB = 0
 670         }
 671         elsif ($_ =~ /^ENABLE/i) {
 672                    $ScopeThisXSUB = 1
 673         }
 674     }
 675
 676 }
 677
 678 sub PROTOTYPES_handler ()
 679 {
 680     # the rest of the current line should contain either ENABLE or
 681     # DISABLE
 682
 683     TrimWhitespace($_) ;
 684
 685     # check for ENABLE/DISABLE
 686     death ("Error: PROTOTYPES: ENABLE/DISABLE")
 687         unless /^(ENABLE|DISABLE)/i ;
 688
 689     $WantPrototypes = 1 if $1 eq 'ENABLE' ;
 690     $WantPrototypes = 0 if $1 eq 'DISABLE' ;
 691     $ProtoUsed = 1 ;
 692
 693 }
 694
 695 sub INCLUDE_handler ()
 696 {
 697     # the rest of the current line should contain a valid filename
 698
 699     TrimWhitespace($_) ;
 700
 701     death("INCLUDE: filename missing")
 702         unless $_ ;
 703
 704     death("INCLUDE: output pipe is illegal")
 705         if /^\s*\|/ ;
 706
 707     # simple minded recursion detector
 708     death("INCLUDE loop detected")
 709         if $IncludedFiles{$_} ;
 710
 711     ++ $IncludedFiles{$_} unless /\|\s*$/ ;
 712
 713     # Save the current file context.
 714     push(@XSStack, {
 715         type            => 'file',
 716         LastLine        => $lastline,
 717         LastLineNo      => $lastline_no,
 718         Line            => \@line,
 719         LineNo          => \@line_no,
 720         Filename        => $filename,
 721         Handle          => $FH,
 722         }) ;
 723
 724     ++ $FH ;
 725
 726     # open the new file
 727     open ($FH, "$_") or death("Cannot open '$_': $!") ;
 728
 729     print Q<<"EOF" ;
 730 #
 731 #/* INCLUDE:  Including '$_' from '$filename' */
 732 #
 733 EOF
 734
 735     $filename = $_ ;
 736
 737     # Prime the pump by reading the first
 738     # non-blank line
 739
 740     # skip leading blank lines
 741     while (<$FH>) {
 742         last unless /^\s*$/ ;
 743     }
 744
 745     $lastline = $_ ;
 746     $lastline_no = $. ;
 747
 748 }
 749
 750 sub PopFile()
 751 {
 752     return 0 unless $XSStack[-1]{type} eq 'file' ;
 753
 754     my $data     = pop @XSStack ;
 755     my $ThisFile = $filename ;
 756     my $isPipe   = ($filename =~ /\|\s*$/) ;
 757
 758     -- $IncludedFiles{$filename}
 759         unless $isPipe ;
 760
 761     close $FH ;
 762
 763     $FH         = $data->{Handle} ;
 764     $filename   = $data->{Filename} ;
 765     $lastline   = $data->{LastLine} ;
 766     $lastline_no = $data->{LastLineNo} ;
 767     @line       = @{ $data->{Line} } ;
 768     @line_no    = @{ $data->{LineNo} } ;
 769
 770     if ($isPipe and $? ) {
 771         -- $lastline_no ;
 772         print STDERR "Error reading from pipe '$ThisFile': $! in $filename, line $lastline_no\n"  ;
 773         exit 1 ;
 774     }
 775
 776     print Q<<"EOF" ;
 777 #
 778 #/* INCLUDE: Returning to '$filename' from '$ThisFile' */
 779 #
 780 EOF
 781
 782     return 1 ;
 783 }
 784
 785 sub ValidProtoString ($)
 786 {
 787     my($string) = @_ ;
 788
 789     if ( $string =~ /^$proto_re+$/ ) {
 790         return $string ;
 791     }
 792
 793     return 0 ;
 794 }
 795
 796 sub C_string ($)
 797 {
 798     my($string) = @_ ;
 799
 800     $string =~ s[\\][\\\\]g ;
 801     $string ;
 802 }
 803
 804 sub ProtoString ($)
 805 {
 806     my ($type) = @_ ;
 807
 808     $proto_letter{$type} or "\$" ;
 809 }
 810
 811 sub check_cpp {
 812     my @cpp = grep(/^\#\s*(?:if|e\w+)/, @line);
 813     if (@cpp) {
 814         my ($cpp, $cpplevel);
 815         for $cpp (@cpp) {
 816             if ($cpp =~ /^\#\s*if/) {
 817                 $cpplevel++;
 818             } elsif (!$cpplevel) {
 819                 Warn("Warning: #else/elif/endif without #if in this function");
 820                 print STDERR "    (precede it with a blank line if the matching #if is outside the function)\n"
 821                     if $XSStack[-1]{type} eq 'if';
 822                 return;
 823             } elsif ($cpp =~ /^\#\s*endif/) {
 824                 $cpplevel--;
 825             }
 826         }
 827         Warn("Warning: #if without #endif in this function") if $cpplevel;
 828     }
 829 }
 830
 831
 832 sub Q {
 833     my($text) = @_;
 834     $text =~ s/^#//gm;
 835     $text =~ s/\[\[/{/g;
 836     $text =~ s/\]\]/}/g;
 837     $text;
 838 }
 839
 840 open($FH, $filename) or die "cannot open $filename: $!\n";
 841
 842 # Identify the version of xsubpp used
 843 print <<EOM ;
 844 /*
 845  * This file was generated automatically by xsubpp version $XSUBPP_version from the
 846  * contents of $filename. Do not edit this file, edit $filename instead.
 847  *
 848  *      ANY CHANGES MADE HERE WILL BE LOST!
 849  *
 850  */
 851
 852 EOM
 853
 854
 855 print("#line 1 \"$filename\"\n")
 856     if $WantLineNumbers;
 857
 858 firstmodule:
 859 while (<$FH>) {
 860     if (/^=/) {
 861         my $podstartline = $.;
 862         do {
 863             if (/^=cut\s*$/) {
 864                 print("/* Skipped embedded POD. */\n");
 865                 printf("#line %d \"$filename\"\n", $. + 1)
 866                   if $WantLineNumbers;
 867                 next firstmodule
 868             }
 869
 870         } while (<$FH>);
 871         # At this point $. is at end of file so die won't state the start
 872         # of the problem, and as we haven't yet read any lines &death won't
 873         # show the correct line in the message either.
 874         die ("Error: Unterminated pod in $filename, line $podstartline\n")
 875           unless $lastline;
 876     }
 877     last if ($Module, $Package, $Prefix) =
 878         /^MODULE\s*=\s*([\w:]+)(?:\s+PACKAGE\s*=\s*([\w:]+))?(?:\s+PREFIX\s*=\s*(\S+))?\s*$/;
 879
 880     if ($OBJ) {
 881         s/#if(?:def\s|\s+defined)\s*(\(__cplusplus\)|__cplusplus)/#if defined(__cplusplus) && !defined(PERL_OBJECT)/;
 882     }
 883     print $_;
 884 }
 885 &Exit unless defined $_;
 886
 887 print "$xsubpp::counter::SECTION_END_MARKER\n" if $WantLineNumbers;
 888
 889 $lastline    = $_;
 890 $lastline_no = $.;
 891
 892 # Read next xsub into @line from ($lastline, <$FH>).
 893 sub fetch_para {
 894     # parse paragraph
 895     death ("Error: Unterminated `#if/#ifdef/#ifndef'")
 896         if !defined $lastline && $XSStack[-1]{type} eq 'if';
 897     @line = ();
 898     @line_no = () ;
 899     return PopFile() if !defined $lastline;
 900
 901     if ($lastline =~
 902         /^MODULE\s*=\s*([\w:]+)(?:\s+PACKAGE\s*=\s*([\w:]+))?(?:\s+PREFIX\s*=\s*(\S+))?\s*$/) {
 903         $Module = $1;
 904         $Package = defined($2) ? $2 : '';       # keep -w happy
 905         $Prefix  = defined($3) ? $3 : '';       # keep -w happy
 906         $Prefix = quotemeta $Prefix ;
 907         ($Module_cname = $Module) =~ s/\W/_/g;
 908         ($Packid = $Package) =~ tr/:/_/;
 909         $Packprefix = $Package;
 910         $Packprefix .= "::" if $Packprefix ne "";
 911         $lastline = "";
 912     }
 913
 914     for(;;) {
 915         # Skip embedded PODs
 916         while ($lastline =~ /^=/) {
 917             while ($lastline = <$FH>) {
 918                 last if ($lastline =~ /^=cut\s*$/);
 919             }
 920             death ("Error: Unterminated pod") unless $lastline;
 921             $lastline = <$FH>;
 922             chomp $lastline;
 923             $lastline =~ s/^\s+$//;
 924         }
 925         if ($lastline !~ /^\s*#/ ||
 926             # CPP directives:
 927             #   ANSI:   if ifdef ifndef elif else endif define undef
 928             #           line error pragma
 929             #   gcc:    warning include_next
 930             #   obj-c:  import
 931             #   others: ident (gcc notes that some cpps have this one)
 932             $lastline =~ /^#[ \t]*(?:(?:if|ifn?def|elif|else|endif|define|undef|pragma|error|warning|line\s+\d+|ident)\b|(?:include(?:_next)?|import)\s*["<].*[>"])/) {
 933             last if $lastline =~ /^\S/ && @line && $line[-1] eq "";
 934             push(@line, $lastline);
 935             push(@line_no, $lastline_no) ;
 936         }
 937
 938         # Read next line and continuation lines
 939         last unless defined($lastline = <$FH>);
 940         $lastline_no = $.;
 941         my $tmp_line;
 942         $lastline .= $tmp_line
 943             while ($lastline =~ /\\$/ && defined($tmp_line = <$FH>));
 944
 945         chomp $lastline;
 946         $lastline =~ s/^\s+$//;
 947     }
 948     pop(@line), pop(@line_no) while @line && $line[-1] eq "";
 949     1;
 950 }
 951
 952 PARAGRAPH:
 953 while (fetch_para()) {
 954     # Print initial preprocessor statements and blank lines
 955     while (@line && $line[0] !~ /^[^\#]/) {
 956         my $line = shift(@line);
 957         print $line, "\n";
 958         next unless $line =~ /^\#\s*((if)(?:n?def)?|elsif|else|endif)\b/;
 959         my $statement = $+;
 960         if ($statement eq 'if') {
 961             $XSS_work_idx = @XSStack;
 962             push(@XSStack, {type => 'if'});
 963         } else {
 964             death ("Error: `$statement' with no matching `if'")
 965                 if $XSStack[-1]{type} ne 'if';
 966             if ($XSStack[-1]{varname}) {
 967                 push(@InitFileCode, "#endif\n");
 968                 push(@BootCode,     "#endif");
 969             }
 970
 971             my(@fns) = keys %{$XSStack[-1]{functions}};
 972             if ($statement ne 'endif') {
 973                 # Hide the functions defined in other #if branches, and reset.
 974                 @{$XSStack[-1]{other_functions}}{@fns} = (1) x @fns;
 975                 @{$XSStack[-1]}{qw(varname functions)} = ('', {});
 976             } else {
 977                 my($tmp) = pop(@XSStack);
 978                 0 while (--$XSS_work_idx
 979                          && $XSStack[$XSS_work_idx]{type} ne 'if');
 980                 # Keep all new defined functions
 981                 push(@fns, keys %{$tmp->{other_functions}});
 982                 @{$XSStack[$XSS_work_idx]{functions}}{@fns} = (1) x @fns;
 983             }
 984         }
 985     }
 986
 987     next PARAGRAPH unless @line;
 988
 989     if ($XSS_work_idx && !$XSStack[$XSS_work_idx]{varname}) {
 990         # We are inside an #if, but have not yet #defined its xsubpp variable.
 991         print "#define $cpp_next_tmp 1\n\n";
 992         push(@InitFileCode, "#if $cpp_next_tmp\n");
 993         push(@BootCode,     "#if $cpp_next_tmp");
 994         $XSStack[$XSS_work_idx]{varname} = $cpp_next_tmp++;
 995     }
 996
 997     death ("Code is not inside a function"
 998            ." (maybe last function was ended by a blank line "
 999            ." followed by a statement on column one?)")
1000         if $line[0] =~ /^\s/;
1001
1002     # initialize info arrays
1003     undef(%args_match);
1004     undef(%var_types);
1005     undef(%defaults);
1006     undef($class);
1007     undef($static);
1008     undef($elipsis);
1009     undef($wantRETVAL) ;
1010     undef($RETVAL_no_return) ;
1011     undef(%arg_list) ;
1012     undef(@proto_arg) ;
1013     undef(@arg_with_types) ;
1014     undef($processing_arg_with_types) ;
1015     undef(%arg_types) ;
1016     undef(@outlist) ;
1017     undef(%in_out) ;
1018     undef($proto_in_this_xsub) ;
1019     undef($scope_in_this_xsub) ;
1020     undef($interface);
1021     undef($prepush_done);
1022     $interface_macro = 'XSINTERFACE_FUNC' ;
1023     $interface_macro_set = 'XSINTERFACE_FUNC_SET' ;
1024     $ProtoThisXSUB = $WantPrototypes ;
1025     $ScopeThisXSUB = 0;
1026     $xsreturn = 0;
1027
1028     $_ = shift(@line);
1029     while ($kwd = check_keyword("REQUIRE|PROTOTYPES|VERSIONCHECK|INCLUDE")) {
1030         &{"${kwd}_handler"}() ;
1031         next PARAGRAPH unless @line ;
1032         $_ = shift(@line);
1033     }
1034
1035     if (check_keyword("BOOT")) {
1036         &check_cpp;
1037         push (@BootCode, "#line $line_no[@line_no - @line] \"$filename\"")
1038           if $WantLineNumbers && $line[0] !~ /^\s*#\s*line\b/;
1039         push (@BootCode, @line, "") ;
1040         next PARAGRAPH ;
1041     }
1042
1043
1044     # extract return type, function name and arguments
1045     ($ret_type) = TidyType($_);
1046     $RETVAL_no_return = 1 if $ret_type =~ s/^NO_OUTPUT\s+//;
1047
1048     # Allow one-line ANSI-like declaration
1049     unshift @line, $2
1050       if $process_argtypes
1051         and $ret_type =~ s/^(.*?\w.*?)\s*\b(\w+\s*\(.*)/$1/s;
1052
1053     # a function definition needs at least 2 lines
1054     blurt ("Error: Function definition too short '$ret_type'"), next PARAGRAPH
1055         unless @line ;
1056
1057     $static = 1 if $ret_type =~ s/^static\s+//;
1058
1059     $func_header = shift(@line);
1060     blurt ("Error: Cannot parse function definition from '$func_header'"), next PARAGRAPH
1061         unless $func_header =~ /^(?:([\w:]*)::)?(\w+)\s*\(\s*(.*?)\s*\)\s*(const)?\s*(;\s*)?$/s;
1062
1063     ($class, $func_name, $orig_args) =  ($1, $2, $3) ;
1064     $class = "$4 $class" if $4;
1065     ($pname = $func_name) =~ s/^($Prefix)?/$Packprefix/;
1066     ($clean_func_name = $func_name) =~ s/^$Prefix//;
1067     $Full_func_name = "${Packid}_$clean_func_name";
1068     if ($Is_VMS) { $Full_func_name = $SymSet->addsym($Full_func_name); }
1069
1070     # Check for duplicate function definition
1071     for $tmp (@XSStack) {
1072         next unless defined $tmp->{functions}{$Full_func_name};
1073         Warn("Warning: duplicate function definition '$clean_func_name' detected");
1074         last;
1075     }
1076     $XSStack[$XSS_work_idx]{functions}{$Full_func_name} ++ ;
1077     %XsubAliases = %XsubAliasValues = %Interfaces = @Attributes = ();
1078     $DoSetMagic = 1;
1079
1080     $orig_args =~ s/\\\s*/ /g;          # process line continuations
1081
1082     my %only_outlist;
1083     if ($process_argtypes and $orig_args =~ /\S/) {
1084         my $args = "$orig_args ,";
1085         if ($args =~ /^( (??{ $C_arg }) , )* $ /x) {
1086             @args = ($args =~ /\G ( (??{ $C_arg }) ) , /xg);
1087             for ( @args ) {
1088                 s/^\s+//;
1089                 s/\s+$//;
1090                 my $arg = $_;
1091                 my $default;
1092                 ($arg, $default) = / ( [^=]* ) ( (?: = .* )? ) /x;
1093                 my ($pre, $name) = ($arg =~ /(.*?) \s* \b(\w+) \s* $ /x);
1094                 next unless length $pre;
1095                 my $out_type;
1096                 my $inout_var;
1097                 if ($process_inout and s/^(IN|IN_OUTLIST|OUTLIST|OUT|IN_OUT)\s+//) {
1098                     my $type = $1;
1099                     $out_type = $type if $type ne 'IN';
1100                     $arg =~ s/^(IN|IN_OUTLIST|OUTLIST|OUT|IN_OUT)\s+//;
1101                 }
1102                 if (/\W/) {     # Has a type
1103                     push @arg_with_types, $arg;
1104                     # warn "pushing '$arg'\n";
1105                     $arg_types{$name} = $arg;
1106                     $_ = "$name$default";
1107                 }
1108                 $only_outlist{$_} = 1 if $out_type eq "OUTLIST";
1109                 push @outlist, $name if $out_type =~ /OUTLIST$/;
1110                 $in_out{$name} = $out_type if $out_type;
1111             }
1112         } else {
1113             @args = split(/\s*,\s*/, $orig_args);
1114             Warn("Warning: cannot parse argument list '$orig_args', fallback to split");
1115         }
1116     } else {
1117         @args = split(/\s*,\s*/, $orig_args);
1118         for (@args) {
1119             if ($process_inout and s/^(IN|IN_OUTLIST|OUTLIST|IN_OUT|OUT)\s+//) {
1120                 my $out_type = $1;
1121                 next if $out_type eq 'IN';
1122                 $only_outlist{$_} = 1 if $out_type eq "OUTLIST";
1123                 push @outlist, $name if $out_type =~ /OUTLIST$/;
1124                 $in_out{$_} = $out_type;
1125             }
1126         }
1127     }
1128     if (defined($class)) {
1129         my $arg0 = ((defined($static) or $func_name eq 'new')
1130                     ? "CLASS" : "THIS");
1131         unshift(@args, $arg0);
1132         ($report_args = "$arg0, $report_args") =~ s/^\w+, $/$arg0/;
1133     }
1134     my $extra_args = 0;
1135     @args_num = ();
1136     $num_args = 0;
1137     my $report_args = '';
1138     foreach $i (0 .. $#args) {
1139             if ($args[$i] =~ s/\.\.\.//) {
1140                     $elipsis = 1;
1141                     if ($args[$i] eq '' && $i == $#args) {
1142                         $report_args .= ", ...";
1143                         pop(@args);
1144                         last;
1145                     }
1146             }
1147             if ($only_outlist{$args[$i]}) {
1148                 push @args_num, undef;
1149             } else {
1150                 push @args_num, ++$num_args;
1151                 $report_args .= ", $args[$i]";
1152             }
1153             if ($args[$i] =~ /^([^=]*[^\s=])\s*=\s*(.*)/s) {
1154                     $extra_args++;
1155                     $args[$i] = $1;
1156                     $defaults{$args[$i]} = $2;
1157                     $defaults{$args[$i]} =~ s/"/\\"/g;
1158             }
1159             $proto_arg[$i+1] = "\$" ;
1160     }
1161     $min_args = $num_args - $extra_args;
1162     $report_args =~ s/"/\\"/g;
1163     $report_args =~ s/^,\s+//;
1164     my @func_args = @args;
1165     shift @func_args if defined($class);
1166
1167     for (@func_args) {
1168         s/^/&/ if $in_out{$_};
1169     }
1170     $func_args = join(", ", @func_args);
1171     @args_match{@args} = @args_num;
1172
1173     $PPCODE = grep(/^\s*PPCODE\s*:/, @line);
1174     $CODE = grep(/^\s*CODE\s*:/, @line);
1175     # Detect CODE: blocks which use ST(n)= or XST_m*(n,v)
1176     #   to set explicit return values.
1177     $EXPLICIT_RETURN = ($CODE &&
1178                 ("@line" =~ /(\bST\s*\([^;]*=) | (\bXST_m\w+\s*\()/x ));
1179     $ALIAS  = grep(/^\s*ALIAS\s*:/,  @line);
1180     $INTERFACE  = grep(/^\s*INTERFACE\s*:/,  @line);
1181
1182     $xsreturn = 1 if $EXPLICIT_RETURN;
1183
1184     # print function header
1185     print Q<<"EOF";
1186 #XS(XS_${Full_func_name}); /* prototype to pass -Wmissing-prototypes */
1187 #XS(XS_${Full_func_name})
1188 #[[
1189 #    dXSARGS;
1190 EOF
1191     print Q<<"EOF" if $ALIAS ;
1192 #    dXSI32;
1193 EOF
1194     print Q<<"EOF" if $INTERFACE ;
1195 #    dXSFUNCTION($ret_type);
1196 EOF
1197     if ($elipsis) {
1198         $cond = ($min_args ? qq(items < $min_args) : 0);
1199     }
1200     elsif ($min_args == $num_args) {
1201         $cond = qq(items != $min_args);
1202     }
1203     else {
1204         $cond = qq(items < $min_args || items > $num_args);
1205     }
1206
1207     print Q<<"EOF" if $except;
1208 #    char errbuf[1024];
1209 #    *errbuf = '\0';
1210 EOF
1211
1212     if ($ALIAS)
1213       { print Q<<"EOF" if $cond }
1214 #    if ($cond)
1215 #       Perl_croak(aTHX_ "Usage: %s($report_args)", GvNAME(CvGV(cv)));
1216 EOF
1217     else
1218       { print Q<<"EOF" if $cond }
1219 #    if ($cond)
1220 #       Perl_croak(aTHX_ "Usage: $pname($report_args)");
1221 EOF
1222
1223     print Q<<"EOF" if $PPCODE;
1224 #    SP -= items;
1225 EOF
1226
1227     # Now do a block of some sort.
1228
1229     $condnum = 0;
1230     $cond = '';                 # last CASE: condidional
1231     push(@line, "$END:");
1232     push(@line_no, $line_no[-1]);
1233     $_ = '';
1234     &check_cpp;
1235     while (@line) {
1236         &CASE_handler if check_keyword("CASE");
1237         print Q<<"EOF";
1238 #   $except [[
1239 EOF
1240
1241         # do initialization of input variables
1242         $thisdone = 0;
1243         $retvaldone = 0;
1244         $deferred = "";
1245         %arg_list = () ;
1246         $gotRETVAL = 0;
1247
1248         INPUT_handler() ;
1249         process_keyword("INPUT|PREINIT|INTERFACE_MACRO|C_ARGS|ALIAS|ATTRS|PROTOTYPE|SCOPE") ;
1250
1251         print Q<<"EOF" if $ScopeThisXSUB;
1252 #   ENTER;
1253 #   [[
1254 EOF
1255
1256         if (!$thisdone && defined($class)) {
1257             if (defined($static) or $func_name eq 'new') {
1258                 print "\tchar *";
1259                 $var_types{"CLASS"} = "char *";
1260                 &generate_init("char *", 1, "CLASS");
1261             }
1262             else {
1263                 print "\t$class *";
1264                 $var_types{"THIS"} = "$class *";
1265                 &generate_init("$class *", 1, "THIS");
1266             }
1267         }
1268
1269         # do code
1270         if (/^\s*NOT_IMPLEMENTED_YET/) {
1271                 print "\n\tPerl_croak(aTHX_ \"$pname: not implemented yet\");\n";
1272                 $_ = '' ;
1273         } else {
1274                 if ($ret_type ne "void") {
1275                         print "\t" . &map_type($ret_type, 'RETVAL') . ";\n"
1276                                 if !$retvaldone;
1277                         $args_match{"RETVAL"} = 0;
1278                         $var_types{"RETVAL"} = $ret_type;
1279                         print "\tdXSTARG;\n"
1280                                 if $WantOptimize and $targetable{$type_kind{$ret_type}};
1281                 }
1282
1283                 if (@arg_with_types) {
1284                     unshift @line, @arg_with_types, $_;
1285                     $_ = "";
1286                     $processing_arg_with_types = 1;
1287                     INPUT_handler() ;
1288                 }
1289                 print $deferred;
1290
1291         process_keyword("INIT|ALIAS|ATTRS|PROTOTYPE|INTERFACE_MACRO|INTERFACE|C_ARGS") ;
1292
1293                 if (check_keyword("PPCODE")) {
1294                         print_section();
1295                         death ("PPCODE must be last thing") if @line;
1296                         print "\tLEAVE;\n" if $ScopeThisXSUB;
1297                         print "\tPUTBACK;\n\treturn;\n";
1298                 } elsif (check_keyword("CODE")) {
1299                         print_section() ;
1300                 } elsif (defined($class) and $func_name eq "DESTROY") {
1301                         print "\n\t";
1302                         print "delete THIS;\n";
1303                 } else {
1304                         print "\n\t";
1305                         if ($ret_type ne "void") {
1306                                 print "RETVAL = ";
1307                                 $wantRETVAL = 1;
1308                         }
1309                         if (defined($static)) {
1310                             if ($func_name eq 'new') {
1311                                 $func_name = "$class";
1312                             } else {
1313                                 print "${class}::";
1314                             }
1315                         } elsif (defined($class)) {
1316                             if ($func_name eq 'new') {
1317                                 $func_name .= " $class";
1318                             } else {
1319                                 print "THIS->";
1320                             }
1321                         }
1322                         $func_name =~ s/^($spat)//
1323                             if defined($spat);
1324                         $func_name = 'XSFUNCTION' if $interface;
1325                         print "$func_name($func_args);\n";
1326                 }
1327         }
1328
1329         # do output variables
1330         $gotRETVAL = 0;         # 1 if RETVAL seen in OUTPUT section;
1331         undef $RETVAL_code ;    # code to set RETVAL (from OUTPUT section);
1332         # $wantRETVAL set if 'RETVAL =' autogenerated
1333         ($wantRETVAL, $ret_type) = (0, 'void') if $RETVAL_no_return;
1334         undef %outargs ;
1335         process_keyword("POSTCALL|OUTPUT|ALIAS|ATTRS|PROTOTYPE");
1336
1337         &generate_output($var_types{$_}, $args_match{$_}, $_, $DoSetMagic)
1338           for grep $in_out{$_} =~ /OUT$/, keys %in_out;
1339
1340         # all OUTPUT done, so now push the return value on the stack
1341         if ($gotRETVAL && $RETVAL_code) {
1342             print "\t$RETVAL_code\n";
1343         } elsif ($gotRETVAL || $wantRETVAL) {
1344             my $t = $WantOptimize && $targetable{$type_kind{$ret_type}};
1345             my $var = 'RETVAL';
1346             my $type = $ret_type;
1347
1348             # 0: type, 1: with_size, 2: how, 3: how_size
1349             if ($t and not $t->[1] and $t->[0] eq 'p') {
1350                 # PUSHp corresponds to setpvn.  Treate setpv directly
1351                 my $what = eval qq("$t->[2]");
1352                 warn $@ if $@;
1353
1354                 print "\tsv_setpv(TARG, $what); XSprePUSH; PUSHTARG;\n";
1355                 $prepush_done = 1;
1356             }
1357             elsif ($t) {
1358                 my $what = eval qq("$t->[2]");
1359                 warn $@ if $@;
1360
1361                 my $size = $t->[3];
1362                 $size = '' unless defined $size;
1363                 $size = eval qq("$size");
1364                 warn $@ if $@;
1365                 print "\tXSprePUSH; PUSH$t->[0]($what$size);\n";
1366                 $prepush_done = 1;
1367             }
1368             else {
1369                 # RETVAL almost never needs SvSETMAGIC()
1370                 &generate_output($ret_type, 0, 'RETVAL', 0);
1371             }
1372         }
1373
1374         $xsreturn = 1 if $ret_type ne "void";
1375         my $num = $xsreturn;
1376         my $c = @outlist;
1377         print "\tXSprePUSH;" if $c and not $prepush_done;
1378         print "\tEXTEND(SP,$c);\n" if $c;
1379         $xsreturn += $c;
1380         generate_output($var_types{$_}, $num++, $_, 0, 1) for @outlist;
1381
1382         # do cleanup
1383         process_keyword("CLEANUP|ALIAS|ATTRS|PROTOTYPE") ;
1384
1385         print Q<<"EOF" if $ScopeThisXSUB;
1386 #   ]]
1387 EOF
1388         print Q<<"EOF" if $ScopeThisXSUB and not $PPCODE;
1389 #   LEAVE;
1390 EOF
1391
1392         # print function trailer
1393         print Q<<EOF;
1394 #    ]]
1395 EOF
1396         print Q<<EOF if $except;
1397 #    BEGHANDLERS
1398 #    CATCHALL
1399 #       sprintf(errbuf, "%s: %s\\tpropagated", Xname, Xreason);
1400 #    ENDHANDLERS
1401 EOF
1402         if (check_keyword("CASE")) {
1403             blurt ("Error: No `CASE:' at top of function")
1404                 unless $condnum;
1405             $_ = "CASE: $_";    # Restore CASE: label
1406             next;
1407         }
1408         last if $_ eq "$END:";
1409         death(/^$BLOCK_re/o ? "Misplaced `$1:'" : "Junk at end of function");
1410     }
1411
1412     print Q<<EOF if $except;
1413 #    if (errbuf[0])
1414 #       Perl_croak(aTHX_ errbuf);
1415 EOF
1416
1417     if ($xsreturn) {
1418         print Q<<EOF unless $PPCODE;
1419 #    XSRETURN($xsreturn);
1420 EOF
1421     } else {
1422         print Q<<EOF unless $PPCODE;
1423 #    XSRETURN_EMPTY;
1424 EOF
1425     }
1426
1427     print Q<<EOF;
1428 #]]
1429 #
1430 EOF
1431
1432     my $newXS = "newXS" ;
1433     my $proto = "" ;
1434
1435     # Build the prototype string for the xsub
1436     if ($ProtoThisXSUB) {
1437         $newXS = "newXSproto";
1438
1439         if ($ProtoThisXSUB eq 2) {
1440             # User has specified empty prototype
1441             $proto = ', ""' ;
1442         }
1443         elsif ($ProtoThisXSUB ne 1) {
1444             # User has specified a prototype
1445             $proto = ', "' . $ProtoThisXSUB . '"';
1446         }
1447         else {
1448             my $s = ';';
1449             if ($min_args < $num_args)  {
1450                 $s = '';
1451                 $proto_arg[$min_args] .= ";" ;
1452             }
1453             push @proto_arg, "$s\@"
1454                 if $elipsis ;
1455
1456             $proto = ', "' . join ("", @proto_arg) . '"';
1457         }
1458     }
1459
1460     if (%XsubAliases) {
1461         $XsubAliases{$pname} = 0
1462             unless defined $XsubAliases{$pname} ;
1463         while ( ($name, $value) = each %XsubAliases) {
1464             push(@InitFileCode, Q<<"EOF");
1465 #        cv = newXS(\"$name\", XS_$Full_func_name, file);
1466 #        XSANY.any_i32 = $value ;
1467 EOF
1468         push(@InitFileCode, Q<<"EOF") if $proto;
1469 #        sv_setpv((SV*)cv$proto) ;
1470 EOF
1471         }
1472     }
1473     elsif (@Attributes) {
1474             push(@InitFileCode, Q<<"EOF");
1475 #        cv = newXS(\"$pname\", XS_$Full_func_name, file);
1476 #        apply_attrs_string("$Package", cv, "@Attributes", 0);
1477 EOF
1478     }
1479     elsif ($interface) {
1480         while ( ($name, $value) = each %Interfaces) {
1481             $name = "$Package\::$name" unless $name =~ /::/;
1482             push(@InitFileCode, Q<<"EOF");
1483 #        cv = newXS(\"$name\", XS_$Full_func_name, file);
1484 #        $interface_macro_set(cv,$value) ;
1485 EOF
1486             push(@InitFileCode, Q<<"EOF") if $proto;
1487 #        sv_setpv((SV*)cv$proto) ;
1488 EOF
1489         }
1490     }
1491     else {
1492         push(@InitFileCode,
1493              "        ${newXS}(\"$pname\", XS_$Full_func_name, file$proto);\n");
1494     }
1495 }
1496
1497 # print initialization routine
1498
1499 print Q<<"EOF";
1500 ##ifdef __cplusplus
1501 #extern "C"
1502 ##endif
1503 EOF
1504
1505 print Q<<"EOF";
1506 #XS(boot_$Module_cname); /* prototype to pass -Wmissing-prototypes */
1507 #XS(boot_$Module_cname)
1508 EOF
1509
1510 print Q<<"EOF";
1511 #[[
1512 #    dXSARGS;
1513 #    char* file = __FILE__;
1514 #
1515 EOF
1516
1517 print Q<<"EOF" if $WantVersionChk ;
1518 #    XS_VERSION_BOOTCHECK ;
1519 #
1520 EOF
1521
1522 print Q<<"EOF" if defined $XsubAliases or defined $Interfaces ;
1523 #    {
1524 #        CV * cv ;
1525 #
1526 EOF
1527
1528 print @InitFileCode;
1529
1530 print Q<<"EOF" if defined $XsubAliases or defined $Interfaces ;
1531 #    }
1532 EOF
1533
1534 if (@BootCode)
1535 {
1536     print "\n    /* Initialisation Section */\n\n" ;
1537     @line = @BootCode;
1538     print_section();
1539     print "\n    /* End of Initialisation Section */\n\n" ;
1540 }
1541
1542 print Q<<"EOF";;
1543 #    XSRETURN_YES;
1544 #]]
1545 #
1546 EOF
1547
1548 warn("Please specify prototyping behavior for $filename (see perlxs manual)\n")
1549     unless $ProtoUsed ;
1550 &Exit;
1551
1552 sub output_init {
1553     local($type, $num, $var, $init, $name_printed) = @_;
1554     local($arg) = "ST(" . ($num - 1) . ")";
1555
1556     if(  $init =~ /^=/  ) {
1557         if ($name_printed) {
1558           eval qq/print " $init\\n"/;
1559         } else {
1560           eval qq/print "\\t$var $init\\n"/;
1561         }
1562         warn $@   if  $@;
1563     } else {
1564         if(  $init =~ s/^\+//  &&  $num  ) {
1565             &generate_init($type, $num, $var, $name_printed);
1566         } elsif ($name_printed) {
1567             print ";\n";
1568             $init =~ s/^;//;
1569         } else {
1570             eval qq/print "\\t$var;\\n"/;
1571             warn $@   if  $@;
1572             $init =~ s/^;//;
1573         }
1574         $deferred .= eval qq/"\\n\\t$init\\n"/;
1575         warn $@   if  $@;
1576     }
1577 }
1578
1579 sub Warn
1580 {
1581     # work out the line number
1582     my $line_no = $line_no[@line_no - @line -1] ;
1583
1584     print STDERR "@_ in $filename, line $line_no\n" ;
1585 }
1586
1587 sub blurt
1588 {
1589     Warn @_ ;
1590     $errors ++
1591 }
1592
1593 sub death
1594 {
1595     Warn @_ ;
1596     exit 1 ;
1597 }
1598
1599 sub generate_init {
1600     local($type, $num, $var) = @_;
1601     local($arg) = "ST(" . ($num - 1) . ")";
1602     local($argoff) = $num - 1;
1603     local($ntype);
1604     local($tk);
1605
1606     $type = TidyType($type) ;
1607     blurt("Error: '$type' not in typemap"), return
1608         unless defined($type_kind{$type});
1609
1610     ($ntype = $type) =~ s/\s*\*/Ptr/g;
1611     ($subtype = $ntype) =~ s/(?:Array)?(?:Ptr)?$//;
1612     $tk = $type_kind{$type};
1613     $tk =~ s/OBJ$/REF/ if $func_name =~ /DESTROY$/;
1614     $type =~ tr/:/_/;
1615     blurt("Error: No INPUT definition for type '$type', typekind '$type_kind{$type}' found"), return
1616         unless defined $input_expr{$tk} ;
1617     $expr = $input_expr{$tk};
1618     if ($expr =~ /DO_ARRAY_ELEM/) {
1619         blurt("Error: '$subtype' not in typemap"), return
1620             unless defined($type_kind{$subtype});
1621         blurt("Error: No INPUT definition for type '$subtype', typekind '$type_kind{$subtype}' found"), return
1622             unless defined $input_expr{$type_kind{$subtype}} ;
1623         $subexpr = $input_expr{$type_kind{$subtype}};
1624         $subexpr =~ s/\$type/\$subtype/g;
1625         $subexpr =~ s/ntype/subtype/g;
1626         $subexpr =~ s/\$arg/ST(ix_$var)/g;
1627         $subexpr =~ s/\n\t/\n\t\t/g;
1628         $subexpr =~ s/is not of (.*\")/[arg %d] is not of $1, ix_$var + 1/g;
1629         $subexpr =~ s/\$var/${var}[ix_$var - $argoff]/;
1630         $expr =~ s/DO_ARRAY_ELEM/$subexpr/;
1631     }
1632     if ($expr =~ m#/\*.*scope.*\*/#i) { # "scope" in C comments
1633         $ScopeThisXSUB = 1;
1634     }
1635     if (defined($defaults{$var})) {
1636             $expr =~ s/(\t+)/$1    /g;
1637             $expr =~ s/        /\t/g;
1638             if ($name_printed) {
1639               print ";\n";
1640             } else {
1641               eval qq/print "\\t$var;\\n"/;
1642               warn $@   if  $@;
1643             }
1644             if ($defaults{$var} eq 'NO_INIT') {
1645                 $deferred .= eval qq/"\\n\\tif (items >= $num) {\\n$expr;\\n\\t}\\n"/;
1646             } else {
1647                 $deferred .= eval qq/"\\n\\tif (items < $num)\\n\\t    $var = $defaults{$var};\\n\\telse {\\n$expr;\\n\\t}\\n"/;
1648             }
1649             warn $@   if  $@;
1650     } elsif ($ScopeThisXSUB or $expr !~ /^\t\$var =/) {
1651             if ($name_printed) {
1652               print ";\n";
1653             } else {
1654               eval qq/print "\\t$var;\\n"/;
1655               warn $@   if  $@;
1656             }
1657             $deferred .= eval qq/"\\n$expr;\\n"/;
1658             warn $@   if  $@;
1659     } else {
1660             die "panic: do not know how to handle this branch for function pointers"
1661               if $name_printed;
1662             eval qq/print "$expr;\\n"/;
1663             warn $@   if  $@;
1664     }
1665 }
1666
1667 sub generate_output {
1668     local($type, $num, $var, $do_setmagic, $do_push) = @_;
1669     local($arg) = "ST(" . ($num - ($num != 0)) . ")";
1670     local($argoff) = $num - 1;
1671     local($ntype);
1672
1673     $type = TidyType($type) ;
1674     if ($type =~ /^array\(([^,]*),(.*)\)/) {
1675             print "\t$arg = sv_newmortal();\n";
1676             print "\tsv_setpvn($arg, (char *)$var, $2 * sizeof($1));\n";
1677             print "\tSvSETMAGIC($arg);\n" if $do_setmagic;
1678     } else {
1679             blurt("Error: '$type' not in typemap"), return
1680                 unless defined($type_kind{$type});
1681             blurt("Error: No OUTPUT definition for type '$type', typekind '$type_kind{$type}' found"), return
1682                 unless defined $output_expr{$type_kind{$type}} ;
1683             ($ntype = $type) =~ s/\s*\*/Ptr/g;
1684             $ntype =~ s/\(\)//g;
1685             ($subtype = $ntype) =~ s/(?:Array)?(?:Ptr)?$//;
1686             $expr = $output_expr{$type_kind{$type}};
1687             if ($expr =~ /DO_ARRAY_ELEM/) {
1688                 blurt("Error: '$subtype' not in typemap"), return
1689                     unless defined($type_kind{$subtype});
1690                 blurt("Error: No OUTPUT definition for type '$subtype', typekind '$type_kind{$subtype}' found"), return
1691                     unless defined $output_expr{$type_kind{$subtype}} ;
1692                 $subexpr = $output_expr{$type_kind{$subtype}};
1693                 $subexpr =~ s/ntype/subtype/g;
1694                 $subexpr =~ s/\$arg/ST(ix_$var)/g;
1695                 $subexpr =~ s/\$var/${var}[ix_$var]/g;
1696                 $subexpr =~ s/\n\t/\n\t\t/g;
1697                 $expr =~ s/DO_ARRAY_ELEM\n/$subexpr/;
1698                 eval "print qq\a$expr\a";
1699                 warn $@   if  $@;
1700                 print "\t\tSvSETMAGIC(ST(ix_$var));\n" if $do_setmagic;
1701             }
1702             elsif ($var eq 'RETVAL') {
1703                 if ($expr =~ /^\t\$arg = new/) {
1704                     # We expect that $arg has refcnt 1, so we need to
1705                     # mortalize it.
1706                     eval "print qq\a$expr\a";
1707                     warn $@   if  $@;
1708                     print "\tsv_2mortal(ST($num));\n";
1709                     print "\tSvSETMAGIC(ST($num));\n" if $do_setmagic;
1710                 }
1711                 elsif ($expr =~ /^\s*\$arg\s*=/) {
1712                     # We expect that $arg has refcnt >=1, so we need
1713                     # to mortalize it!
1714                     eval "print qq\a$expr\a";
1715                     warn $@   if  $@;
1716                     print "\tsv_2mortal(ST(0));\n";
1717                     print "\tSvSETMAGIC(ST(0));\n" if $do_setmagic;
1718                 }
1719                 else {
1720                     # Just hope that the entry would safely write it
1721                     # over an already mortalized value. By
1722                     # coincidence, something like $arg = &sv_undef
1723                     # works too.
1724                     print "\tST(0) = sv_newmortal();\n";
1725                     eval "print qq\a$expr\a";
1726                     warn $@   if  $@;
1727                     # new mortals don't have set magic
1728                 }
1729             }
1730             elsif ($do_push) {
1731                 print "\tPUSHs(sv_newmortal());\n";
1732                 $arg = "ST($num)";
1733                 eval "print qq\a$expr\a";
1734                 warn $@   if  $@;
1735                 print "\tSvSETMAGIC($arg);\n" if $do_setmagic;
1736             }
1737             elsif ($arg =~ /^ST\(\d+\)$/) {
1738                 eval "print qq\a$expr\a";
1739                 warn $@   if  $@;
1740                 print "\tSvSETMAGIC($arg);\n" if $do_setmagic;
1741             }
1742     }
1743 }
1744
1745 sub map_type {
1746     my($type, $varname) = @_;
1747
1748     $type =~ tr/:/_/;
1749     $type =~ s/^array\(([^,]*),(.*)\).*/$1 */s;
1750     if ($varname) {
1751       if ($varname && $type =~ / \( \s* \* (?= \s* \) ) /xg) {
1752         (substr $type, pos $type, 0) = " $varname ";
1753       } else {
1754         $type .= "\t$varname";
1755       }
1756     }
1757     $type;
1758 }
1759
1760
1761 sub Exit {
1762 # If this is VMS, the exit status has meaning to the shell, so we
1763 # use a predictable value (SS$_Normal or SS$_Abort) rather than an
1764 # arbitrary number.
1765 #    exit ($Is_VMS ? ($errors ? 44 : 1) : $errors) ;
1766     exit ($errors ? 1 : 0);
1767 }