This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
6798ed4ef4f3faa29bbd9c94eebecb28aa06e21f
[perl5.git] / dist / ExtUtils-ParseXS / lib / ExtUtils / ParseXS.pm
1 package ExtUtils::ParseXS;
2 use strict;
3
4 use 5.006;  # We use /??{}/ in regexes
5 use Cwd;
6 use Config;
7 use Exporter;
8 use File::Basename;
9 use File::Spec;
10 use Symbol;
11 use ExtUtils::ParseXS::Constants ();
12 use ExtUtils::ParseXS::CountLines;
13 use ExtUtils::ParseXS::Utilities qw(
14   standard_typemap_locations
15   trim_whitespace
16   tidy_type
17   C_string
18   valid_proto_string
19   process_typemaps
20   make_targetable
21   map_type
22 );
23
24 our (@ISA, @EXPORT_OK, $VERSION);
25 @ISA = qw(Exporter);
26 @EXPORT_OK = qw(process_file);
27 $VERSION = '3';
28 $VERSION = eval $VERSION if $VERSION =~ /_/;
29
30 # use strict;  # One of these days ...
31
32 our (
33   $ProtoUsed, @InitFileCode, $FH, $proto_re, $Overload, $errors, $Fallback, 
34   $hiertype, $WantPrototypes, $WantVersionChk, $WantLineNumbers, $filepathname, 
35   $dir, $filename, %IncludedFiles, %input_expr, %output_expr, 
36   %type_kind, %proto_letter, $BLOCK_re, $lastline, $lastline_no, $Package, 
37   $Prefix, @line, %args_match, %defaults, %var_types, %arg_list, @proto_arg,
38   $processing_arg_with_types, %argtype_seen, %in_out, %lengthof, 
39   $proto_in_this_xsub, $scope_in_this_xsub, $interface, 
40   $interface_macro, $interface_macro_set, $ProtoThisXSUB, $ScopeThisXSUB, 
41   @line_no, $ret_type, $func_name, $Full_func_name, $Packprefix, $Packid,  
42   %XsubAliases, %XsubAliasValues, %Interfaces, @Attributes, %outargs, $pname,
43   $thisdone, $retvaldone, $deferred, $gotRETVAL, $condnum, $cond,
44   $RETVAL_code, $printed_name, $func_args, @XSStack, $ALIAS, 
45 );
46 our ($DoSetMagic, $newXS, $proto, $Module_cname, $XsubAliases, $Interfaces, $var_num, );
47
48 sub process_file {
49
50   # Allow for $package->process_file(%hash) in the future
51   my ($pkg, %options) = @_ % 2 ? @_ : (__PACKAGE__, @_);
52
53   $ProtoUsed = exists $options{prototypes};
54
55   # Set defaults.
56   my %args = (
57     argtypes        => 1,
58     csuffix         => '.c',
59     except          => 0,
60     hiertype        => 0,
61     inout           => 1,
62     linenumbers     => 1,
63     optimize        => 1,
64     output          => \*STDOUT,
65     prototypes      => 0,
66     typemap         => [],
67     versioncheck    => 1,
68     %options,
69   );
70   $args{except} = $args{except} ? ' TRY' : '';
71
72   # Global Constants
73
74   my ($Is_VMS, $SymSet);
75   if ($^O eq 'VMS') {
76     $Is_VMS = 1;
77     # Establish set of global symbols with max length 28, since xsubpp
78     # will later add the 'XS_' prefix.
79     require ExtUtils::XSSymSet;
80     $SymSet = new ExtUtils::XSSymSet 28;
81   }
82   @XSStack = ({type => 'none'});
83   my $XSS_work_idx = 0;
84   my $cpp_next_tmp = 'XSubPPtmpAAAA';
85   @InitFileCode = @ExtUtils::ParseXS::Constants::InitFileCode;
86   $FH           = $ExtUtils::ParseXS::Constants::FH;
87   $proto_re     = $ExtUtils::ParseXS::Constants::proto_re;
88   $Overload     = $ExtUtils::ParseXS::Constants::Overload;
89   $errors       = $ExtUtils::ParseXS::Constants::errors;
90   $Fallback     = $ExtUtils::ParseXS::Constants::Fallback;
91
92   # Most of the 1500 lines below uses these globals.  We'll have to
93   # clean this up sometime, probably.  For now, we just pull them out
94   # of %args.  -Ken
95
96   $hiertype = $args{hiertype};
97   $WantPrototypes = $args{prototypes};
98   $WantVersionChk = $args{versioncheck};
99   $WantLineNumbers = $args{linenumbers};
100
101   for my $f ($args{filename}) {
102     die "Missing required parameter 'filename'" unless $f;
103     $filepathname = $f;
104     ($dir, $filename) = (dirname($f), basename($f));
105     $filepathname =~ s/\\/\\\\/g;
106     $IncludedFiles{$f}++;
107   }
108
109   # Open the output file if given as a string.  If they provide some
110   # other kind of reference, trust them that we can print to it.
111   if (not ref $args{output}) {
112     open my($fh), "> $args{output}" or die "Can't create $args{output}: $!";
113     $args{outfile} = $args{output};
114     $args{output} = $fh;
115   }
116
117   # Really, we shouldn't have to chdir() or select() in the first
118   # place.  For now, just save & restore.
119   my $orig_cwd = cwd();
120   my $orig_fh = select();
121
122   chdir($dir);
123   my $pwd = cwd();
124   my $csuffix = $args{csuffix};
125
126   if ($WantLineNumbers) {
127     my $cfile;
128     if ( $args{outfile} ) {
129       $cfile = $args{outfile};
130     }
131     else {
132       $cfile = $args{filename};
133       $cfile =~ s/\.xs$/$csuffix/i or $cfile .= $csuffix;
134     }
135     tie(*PSEUDO_STDOUT, 'ExtUtils::ParseXS::CountLines', $cfile, $args{output});
136     select PSEUDO_STDOUT;
137   }
138   else {
139     select $args{output};
140   }
141
142   my ($type_kind_ref, $proto_letter_ref, $input_expr_ref, $output_expr_ref) =
143     process_typemaps( $args{typemap}, $pwd );
144
145   %type_kind    = %{ $type_kind_ref };
146   %proto_letter = %{ $proto_letter_ref };
147   %input_expr   = %{ $input_expr_ref };
148   %output_expr  = %{ $output_expr_ref };
149
150   foreach my $value (values %input_expr) {
151     $value =~ s/;*\s+\z//;
152     # Move C pre-processor instructions to column 1 to be strictly ANSI
153     # conformant. Some pre-processors are fussy about this.
154     $value =~ s/^\s+#/#/mg;
155   }
156   foreach my $value (values %output_expr) {
157     # And again.
158     $value =~ s/^\s+#/#/mg;
159   }
160
161   my %targetable = make_targetable(\%output_expr);
162
163   my $END = "!End!\n\n";        # "impossible" keyword (multiple newline)
164
165   # Match an XS keyword
166   $BLOCK_re = '\s*(' . join('|', qw(
167     REQUIRE BOOT CASE PREINIT INPUT INIT CODE PPCODE
168     OUTPUT CLEANUP ALIAS ATTRS PROTOTYPES PROTOTYPE
169     VERSIONCHECK INCLUDE INCLUDE_COMMAND SCOPE INTERFACE
170     INTERFACE_MACRO C_ARGS POSTCALL OVERLOAD FALLBACK
171     )) . "|$END)\\s*:";
172
173   our ($C_group_rex, $C_arg);
174   # Group in C (no support for comments or literals)
175   $C_group_rex = qr/ [({\[]
176                (?: (?> [^()\[\]{}]+ ) | (??{ $C_group_rex }) )*
177                [)}\]] /x;
178   # Chunk in C without comma at toplevel (no comments):
179   $C_arg = qr/ (?: (?> [^()\[\]{},"']+ )
180          |   (??{ $C_group_rex })
181          |   " (?: (?> [^\\"]+ )
182            |   \\.
183            )* "        # String literal
184                 |   ' (?: (?> [^\\']+ ) | \\. )* ' # Char literal
185          )* /xs;
186
187   # Identify the version of xsubpp used
188   print <<EOM;
189 /*
190  * This file was generated automatically by ExtUtils::ParseXS version $VERSION from the
191  * contents of $filename. Do not edit this file, edit $filename instead.
192  *
193  *    ANY CHANGES MADE HERE WILL BE LOST!
194  *
195  */
196
197 EOM
198
199
200   print("#line 1 \"$filepathname\"\n")
201     if $WantLineNumbers;
202
203   # Open the input file (using basename'd $args{filename} due to chdir above)
204   open($FH, $filename) or die "cannot open $filename: $!\n";
205
206   firstmodule:
207   while (<$FH>) {
208     if (/^=/) {
209       my $podstartline = $.;
210       do {
211         if (/^=cut\s*$/) {
212           # We can't just write out a /* */ comment, as our embedded
213           # POD might itself be in a comment. We can't put a /**/
214           # comment inside #if 0, as the C standard says that the source
215           # file is decomposed into preprocessing characters in the stage
216           # before preprocessing commands are executed.
217           # I don't want to leave the text as barewords, because the spec
218           # isn't clear whether macros are expanded before or after
219           # preprocessing commands are executed, and someone pathological
220           # may just have defined one of the 3 words as a macro that does
221           # something strange. Multiline strings are illegal in C, so
222           # the "" we write must be a string literal. And they aren't
223           # concatenated until 2 steps later, so we are safe.
224           #     - Nicholas Clark
225           print("#if 0\n  \"Skipped embedded POD.\"\n#endif\n");
226           printf("#line %d \"$filepathname\"\n", $. + 1)
227             if $WantLineNumbers;
228           next firstmodule
229         }
230
231       } while (<$FH>);
232       # At this point $. is at end of file so die won't state the start
233       # of the problem, and as we haven't yet read any lines &death won't
234       # show the correct line in the message either.
235       die ("Error: Unterminated pod in $filename, line $podstartline\n")
236         unless $lastline;
237     }
238     last if ($Package, $Prefix) =
239       /^MODULE\s*=\s*[\w:]+(?:\s+PACKAGE\s*=\s*([\w:]+))?(?:\s+PREFIX\s*=\s*(\S+))?\s*$/;
240
241     print $_;
242   }
243   unless (defined $_) {
244     warn "Didn't find a 'MODULE ... PACKAGE ... PREFIX' line\n";
245     exit 0; # Not a fatal error for the caller process
246   }
247
248   print 'ExtUtils::ParseXS::CountLines'->end_marker, "\n" if $WantLineNumbers;
249
250   print <<"EOF";
251 #ifndef PERL_UNUSED_VAR
252 #  define PERL_UNUSED_VAR(var) if (0) var = var
253 #endif
254
255 EOF
256
257   print <<"EOF";
258 #ifndef PERL_ARGS_ASSERT_CROAK_XS_USAGE
259 #define PERL_ARGS_ASSERT_CROAK_XS_USAGE assert(cv); assert(params)
260
261 /* prototype to pass -Wmissing-prototypes */
262 STATIC void
263 S_croak_xs_usage(pTHX_ const CV *const cv, const char *const params);
264
265 STATIC void
266 S_croak_xs_usage(pTHX_ const CV *const cv, const char *const params)
267 {
268     const GV *const gv = CvGV(cv);
269
270     PERL_ARGS_ASSERT_CROAK_XS_USAGE;
271
272     if (gv) {
273         const char *const gvname = GvNAME(gv);
274         const HV *const stash = GvSTASH(gv);
275         const char *const hvname = stash ? HvNAME(stash) : NULL;
276
277         if (hvname)
278             Perl_croak(aTHX_ "Usage: %s::%s(%s)", hvname, gvname, params);
279         else
280             Perl_croak(aTHX_ "Usage: %s(%s)", gvname, params);
281     } else {
282         /* Pants. I don't think that it should be possible to get here. */
283         Perl_croak(aTHX_ "Usage: CODE(0x%"UVxf")(%s)", PTR2UV(cv), params);
284     }
285 }
286 #undef  PERL_ARGS_ASSERT_CROAK_XS_USAGE
287
288 #ifdef PERL_IMPLICIT_CONTEXT
289 #define croak_xs_usage(a,b)    S_croak_xs_usage(aTHX_ a,b)
290 #else
291 #define croak_xs_usage        S_croak_xs_usage
292 #endif
293
294 #endif
295
296 /* NOTE: the prototype of newXSproto() is different in versions of perls,
297  * so we define a portable version of newXSproto()
298  */
299 #ifdef newXS_flags
300 #define newXSproto_portable(name, c_impl, file, proto) newXS_flags(name, c_impl, file, proto, 0)
301 #else
302 #define newXSproto_portable(name, c_impl, file, proto) (PL_Sv=(SV*)newXS(name, c_impl, file), sv_setpv(PL_Sv, proto), (CV*)PL_Sv)
303 #endif /* !defined(newXS_flags) */
304
305 EOF
306
307   print 'ExtUtils::ParseXS::CountLines'->end_marker, "\n" if $WantLineNumbers;
308
309   $lastline    = $_;
310   $lastline_no = $.;
311
312   my (@BootCode, @outlist, $prepush_done, $xsreturn, $func_header, $orig_args, );
313  PARAGRAPH:
314   while (fetch_para()) {
315     # Print initial preprocessor statements and blank lines
316     while (@line && $line[0] !~ /^[^\#]/) {
317       my $ln = shift(@line);
318       print $ln, "\n";
319       next unless $ln =~ /^\#\s*((if)(?:n?def)?|elsif|else|endif)\b/;
320       my $statement = $+;
321       if ($statement eq 'if') {
322         $XSS_work_idx = @XSStack;
323         push(@XSStack, {type => 'if'});
324       }
325       else {
326         death ("Error: `$statement' with no matching `if'")
327           if $XSStack[-1]{type} ne 'if';
328         if ($XSStack[-1]{varname}) {
329           push(@InitFileCode, "#endif\n");
330           push(@BootCode,     "#endif");
331         }
332
333         my(@fns) = keys %{$XSStack[-1]{functions}};
334         if ($statement ne 'endif') {
335           # Hide the functions defined in other #if branches, and reset.
336           @{$XSStack[-1]{other_functions}}{@fns} = (1) x @fns;
337           @{$XSStack[-1]}{qw(varname functions)} = ('', {});
338         }
339         else {
340           my($tmp) = pop(@XSStack);
341           0 while (--$XSS_work_idx
342                && $XSStack[$XSS_work_idx]{type} ne 'if');
343           # Keep all new defined functions
344           push(@fns, keys %{$tmp->{other_functions}});
345           @{$XSStack[$XSS_work_idx]{functions}}{@fns} = (1) x @fns;
346         }
347       }
348     }
349
350     next PARAGRAPH unless @line;
351
352     if ($XSS_work_idx && !$XSStack[$XSS_work_idx]{varname}) {
353       # We are inside an #if, but have not yet #defined its xsubpp variable.
354       print "#define $cpp_next_tmp 1\n\n";
355       push(@InitFileCode, "#if $cpp_next_tmp\n");
356       push(@BootCode,     "#if $cpp_next_tmp");
357       $XSStack[$XSS_work_idx]{varname} = $cpp_next_tmp++;
358     }
359
360     death ("Code is not inside a function"
361        ." (maybe last function was ended by a blank line "
362        ." followed by a statement on column one?)")
363       if $line[0] =~ /^\s/;
364
365     my ($class, $externC, $static, $ellipsis, $wantRETVAL, $RETVAL_no_return);
366     my (@fake_INPUT_pre);    # For length(s) generated variables
367     my (@fake_INPUT);
368
369     # initialize info arrays
370     undef(%args_match);
371     undef(%var_types);
372     undef(%defaults);
373     undef(%arg_list);
374     undef(@proto_arg);
375     undef($processing_arg_with_types);
376     undef(%argtype_seen);
377     undef(@outlist);
378     undef(%in_out);
379     undef(%lengthof);
380     undef($proto_in_this_xsub);
381     undef($scope_in_this_xsub);
382     undef($interface);
383     undef($prepush_done);
384     $interface_macro = 'XSINTERFACE_FUNC';
385     $interface_macro_set = 'XSINTERFACE_FUNC_SET';
386     $ProtoThisXSUB = $WantPrototypes;
387     $ScopeThisXSUB = 0;
388     $xsreturn = 0;
389
390     $_ = shift(@line);
391     while (my $kwd = check_keyword("REQUIRE|PROTOTYPES|FALLBACK|VERSIONCHECK|INCLUDE(?:_COMMAND)?|SCOPE")) {
392       no strict 'refs';
393       &{"${kwd}_handler"}();
394       use strict 'refs';
395       next PARAGRAPH unless @line;
396       $_ = shift(@line);
397     }
398
399     if (check_keyword("BOOT")) {
400       &check_cpp;
401       push (@BootCode, "#line $line_no[@line_no - @line] \"$filepathname\"")
402         if $WantLineNumbers && $line[0] !~ /^\s*#\s*line\b/;
403       push (@BootCode, @line, "");
404       next PARAGRAPH;
405     }
406
407     # extract return type, function name and arguments
408     ($ret_type) = tidy_type($_);
409     $RETVAL_no_return = 1 if $ret_type =~ s/^NO_OUTPUT\s+//;
410
411     # Allow one-line ANSI-like declaration
412     unshift @line, $2
413       if $args{argtypes}
414         and $ret_type =~ s/^(.*?\w.*?)\s*\b(\w+\s*\(.*)/$1/s;
415
416     # a function definition needs at least 2 lines
417     blurt ("Error: Function definition too short '$ret_type'"), next PARAGRAPH
418       unless @line;
419
420     $externC = 1 if $ret_type =~ s/^extern "C"\s+//;
421     $static  = 1 if $ret_type =~ s/^static\s+//;
422
423     $func_header = shift(@line);
424     blurt ("Error: Cannot parse function definition from '$func_header'"), next PARAGRAPH
425       unless $func_header =~ /^(?:([\w:]*)::)?(\w+)\s*\(\s*(.*?)\s*\)\s*(const)?\s*(;\s*)?$/s;
426
427     ($class, $func_name, $orig_args) =  ($1, $2, $3);
428     $class = "$4 $class" if $4;
429     ($pname = $func_name) =~ s/^($Prefix)?/$Packprefix/;
430     my $clean_func_name;
431     ($clean_func_name = $func_name) =~ s/^$Prefix//;
432     $Full_func_name = "${Packid}_$clean_func_name";
433     if ($Is_VMS) {
434       $Full_func_name = $SymSet->addsym($Full_func_name);
435     }
436
437     # Check for duplicate function definition
438     for my $tmp (@XSStack) {
439       next unless defined $tmp->{functions}{$Full_func_name};
440       Warn("Warning: duplicate function definition '$clean_func_name' detected");
441       last;
442     }
443     $XSStack[$XSS_work_idx]{functions}{$Full_func_name}++;
444     %XsubAliases = %XsubAliasValues = %Interfaces = @Attributes = ();
445     $DoSetMagic = 1;
446
447     $orig_args =~ s/\\\s*/ /g;    # process line continuations
448     my @args;
449
450     my %only_C_inlist;        # Not in the signature of Perl function
451     if ($args{argtypes} and $orig_args =~ /\S/) {
452       my $args = "$orig_args ,";
453       if ($args =~ /^( (??{ $C_arg }) , )* $ /x) {
454         @args = ($args =~ /\G ( (??{ $C_arg }) ) , /xg);
455         for ( @args ) {
456           s/^\s+//;
457           s/\s+$//;
458           my ($arg, $default) = ($_ =~ m/ ( [^=]* ) ( (?: = .* )? ) /x);
459           my ($pre, $len_name) = ($arg =~ /(.*?) \s*
460                              \b ( \w+ | length\( \s*\w+\s* \) )
461                              \s* $ /x);
462           next unless defined($pre) && length($pre);
463           my $out_type = '';
464           my $inout_var;
465           if ($args{inout} and s/^(IN|IN_OUTLIST|OUTLIST|OUT|IN_OUT)\b\s*//) {
466             my $type = $1;
467             $out_type = $type if $type ne 'IN';
468             $arg =~ s/^(IN|IN_OUTLIST|OUTLIST|OUT|IN_OUT)\b\s*//;
469             $pre =~ s/^(IN|IN_OUTLIST|OUTLIST|OUT|IN_OUT)\b\s*//;
470           }
471           my $islength;
472           if ($len_name =~ /^length\( \s* (\w+) \s* \)\z/x) {
473             $len_name = "XSauto_length_of_$1";
474             $islength = 1;
475             die "Default value on length() argument: `$_'"
476               if length $default;
477           }
478           if (length $pre or $islength) { # Has a type
479             if ($islength) {
480               push @fake_INPUT_pre, $arg;
481             }
482             else {
483               push @fake_INPUT, $arg;
484             }
485             # warn "pushing '$arg'\n";
486             $argtype_seen{$len_name}++;
487             $_ = "$len_name$default"; # Assigns to @args
488           }
489           $only_C_inlist{$_} = 1 if $out_type eq "OUTLIST" or $islength;
490           push @outlist, $len_name if $out_type =~ /OUTLIST$/;
491           $in_out{$len_name} = $out_type if $out_type;
492         }
493       }
494       else {
495         @args = split(/\s*,\s*/, $orig_args);
496         Warn("Warning: cannot parse argument list '$orig_args', fallback to split");
497       }
498     }
499     else {
500       @args = split(/\s*,\s*/, $orig_args);
501       for (@args) {
502         if ($args{inout} and s/^(IN|IN_OUTLIST|OUTLIST|IN_OUT|OUT)\b\s*//) {
503           my $out_type = $1;
504           next if $out_type eq 'IN';
505           $only_C_inlist{$_} = 1 if $out_type eq "OUTLIST";
506           if ($out_type =~ /OUTLIST$/) {
507               push @outlist, undef;
508           }
509           $in_out{$_} = $out_type;
510         }
511       }
512     }
513     if (defined($class)) {
514       my $arg0 = ((defined($static) or $func_name eq 'new')
515           ? "CLASS" : "THIS");
516       unshift(@args, $arg0);
517     }
518     my $extra_args = 0;
519     my @args_num = ();
520     my $num_args = 0;
521     my $report_args = '';
522     foreach my $i (0 .. $#args) {
523       if ($args[$i] =~ s/\.\.\.//) {
524         $ellipsis = 1;
525         if ($args[$i] eq '' && $i == $#args) {
526           $report_args .= ", ...";
527           pop(@args);
528           last;
529         }
530       }
531       if ($only_C_inlist{$args[$i]}) {
532         push @args_num, undef;
533       }
534       else {
535         push @args_num, ++$num_args;
536           $report_args .= ", $args[$i]";
537       }
538       if ($args[$i] =~ /^([^=]*[^\s=])\s*=\s*(.*)/s) {
539         $extra_args++;
540         $args[$i] = $1;
541         $defaults{$args[$i]} = $2;
542         $defaults{$args[$i]} =~ s/"/\\"/g;
543       }
544       $proto_arg[$i+1] = '$';
545     }
546     my $min_args = $num_args - $extra_args;
547     $report_args =~ s/"/\\"/g;
548     $report_args =~ s/^,\s+//;
549     my @func_args = @args;
550     shift @func_args if defined($class);
551
552     for (@func_args) {
553       s/^/&/ if $in_out{$_};
554     }
555     $func_args = join(", ", @func_args);
556     @args_match{@args} = @args_num;
557
558     my $PPCODE = grep(/^\s*PPCODE\s*:/, @line);
559     my $CODE = grep(/^\s*CODE\s*:/, @line);
560     # Detect CODE: blocks which use ST(n)= or XST_m*(n,v)
561     #   to set explicit return values.
562     my $EXPLICIT_RETURN = ($CODE &&
563             ("@line" =~ /(\bST\s*\([^;]*=) | (\bXST_m\w+\s*\()/x ));
564
565     # The $ALIAS which follows is only explicitly called within the scope of
566     # process_file().  In principle, it ought to be a lexical, i.e., 'my
567     # $ALIAS' like the other nearby variables.  However, implementing that
568     # change produced a slight difference in the resulting .c output in at
569     # least two distributions:  B/BD/BDFOY/Crypt-Rijndael and
570     # G/GF/GFUJI/Hash-FieldHash.  The difference is, arguably, an improvement
571     # in the resulting C code.  Example:
572     # 388c388
573     # <                       GvNAME(CvGV(cv)),
574     # ---
575     # >                       "Crypt::Rijndael::encrypt",
576     # But at this point we're committed to generating the *same* C code that
577     # the current version of ParseXS.pm does.  So we're declaring it as 'our'.
578     $ALIAS  = grep(/^\s*ALIAS\s*:/,  @line);
579
580     my $INTERFACE  = grep(/^\s*INTERFACE\s*:/,  @line);
581
582     $xsreturn = 1 if $EXPLICIT_RETURN;
583
584     $externC = $externC ? qq[extern "C"] : "";
585
586     # print function header
587     print Q(<<"EOF");
588 #$externC
589 #XS(XS_${Full_func_name}); /* prototype to pass -Wmissing-prototypes */
590 #XS(XS_${Full_func_name})
591 #[[
592 ##ifdef dVAR
593 #    dVAR; dXSARGS;
594 ##else
595 #    dXSARGS;
596 ##endif
597 EOF
598     print Q(<<"EOF") if $ALIAS;
599 #    dXSI32;
600 EOF
601     print Q(<<"EOF") if $INTERFACE;
602 #    dXSFUNCTION($ret_type);
603 EOF
604     if ($ellipsis) {
605       $cond = ($min_args ? qq(items < $min_args) : 0);
606     }
607     elsif ($min_args == $num_args) {
608       $cond = qq(items != $min_args);
609     }
610     else {
611       $cond = qq(items < $min_args || items > $num_args);
612     }
613
614     print Q(<<"EOF") if $args{except};
615 #    char errbuf[1024];
616 #    *errbuf = '\0';
617 EOF
618
619     if($cond) {
620       print Q(<<"EOF");
621 #    if ($cond)
622 #       croak_xs_usage(cv,  "$report_args");
623 EOF
624     }
625     else {
626     # cv likely to be unused
627     print Q(<<"EOF");
628 #    PERL_UNUSED_VAR(cv); /* -W */
629 EOF
630     }
631
632     #gcc -Wall: if an xsub has PPCODE is used
633     #it is possible none of ST, XSRETURN or XSprePUSH macros are used
634     #hence `ax' (setup by dXSARGS) is unused
635     #XXX: could breakup the dXSARGS; into dSP;dMARK;dITEMS
636     #but such a move could break third-party extensions
637     print Q(<<"EOF") if $PPCODE;
638 #    PERL_UNUSED_VAR(ax); /* -Wall */
639 EOF
640
641     print Q(<<"EOF") if $PPCODE;
642 #    SP -= items;
643 EOF
644
645     # Now do a block of some sort.
646
647     $condnum = 0;
648     $cond = '';            # last CASE: condidional
649     push(@line, "$END:");
650     push(@line_no, $line_no[-1]);
651     $_ = '';
652     &check_cpp;
653     while (@line) {
654       &CASE_handler if check_keyword("CASE");
655       print Q(<<"EOF");
656 #   $args{except} [[
657 EOF
658
659       # do initialization of input variables
660       $thisdone = 0;
661       $retvaldone = 0;
662       $deferred = "";
663       %arg_list = ();
664       $gotRETVAL = 0;
665
666       INPUT_handler();
667       process_keyword("INPUT|PREINIT|INTERFACE_MACRO|C_ARGS|ALIAS|ATTRS|PROTOTYPE|SCOPE|OVERLOAD");
668
669       print Q(<<"EOF") if $ScopeThisXSUB;
670 #   ENTER;
671 #   [[
672 EOF
673
674       if (!$thisdone && defined($class)) {
675         if (defined($static) or $func_name eq 'new') {
676           print "\tchar *";
677           $var_types{"CLASS"} = "char *";
678           &generate_init("char *", 1, "CLASS", undef);
679         }
680         else {
681           print "\t$class *";
682           $var_types{"THIS"} = "$class *";
683           &generate_init("$class *", 1, "THIS", undef);
684         }
685       }
686
687       # do code
688       if (/^\s*NOT_IMPLEMENTED_YET/) {
689         print "\n\tPerl_croak(aTHX_ \"$pname: not implemented yet\");\n";
690         $_ = '';
691       }
692       else {
693         if ($ret_type ne "void") {
694           print "\t" . &map_type($ret_type, 'RETVAL', $hiertype) . ";\n"
695             if !$retvaldone;
696           $args_match{"RETVAL"} = 0;
697           $var_types{"RETVAL"} = $ret_type;
698           print "\tdXSTARG;\n"
699             if $args{optimize} and $targetable{$type_kind{$ret_type}};
700         }
701
702         if (@fake_INPUT or @fake_INPUT_pre) {
703           unshift @line, @fake_INPUT_pre, @fake_INPUT, $_;
704           $_ = "";
705           $processing_arg_with_types = 1;
706           INPUT_handler();
707         }
708         print $deferred;
709
710         process_keyword("INIT|ALIAS|ATTRS|PROTOTYPE|INTERFACE_MACRO|INTERFACE|C_ARGS|OVERLOAD");
711
712         if (check_keyword("PPCODE")) {
713           print_section();
714           death ("PPCODE must be last thing") if @line;
715           print "\tLEAVE;\n" if $ScopeThisXSUB;
716           print "\tPUTBACK;\n\treturn;\n";
717         }
718         elsif (check_keyword("CODE")) {
719           print_section();
720         }
721         elsif (defined($class) and $func_name eq "DESTROY") {
722           print "\n\t";
723           print "delete THIS;\n";
724         }
725         else {
726           print "\n\t";
727           if ($ret_type ne "void") {
728             print "RETVAL = ";
729             $wantRETVAL = 1;
730           }
731           if (defined($static)) {
732             if ($func_name eq 'new') {
733               $func_name = "$class";
734             }
735             else {
736               print "${class}::";
737             }
738           }
739           elsif (defined($class)) {
740             if ($func_name eq 'new') {
741               $func_name .= " $class";
742             }
743             else {
744               print "THIS->";
745             }
746           }
747           $func_name =~ s/^\Q$args{'s'}//
748             if exists $args{'s'};
749           $func_name = 'XSFUNCTION' if $interface;
750           print "$func_name($func_args);\n";
751         }
752       }
753
754       # do output variables
755       $gotRETVAL = 0;        # 1 if RETVAL seen in OUTPUT section;
756       undef $RETVAL_code ;    # code to set RETVAL (from OUTPUT section);
757       # $wantRETVAL set if 'RETVAL =' autogenerated
758       ($wantRETVAL, $ret_type) = (0, 'void') if $RETVAL_no_return;
759       undef %outargs;
760       process_keyword("POSTCALL|OUTPUT|ALIAS|ATTRS|PROTOTYPE|OVERLOAD");
761
762       &generate_output($var_types{$_}, $args_match{$_}, $_, $DoSetMagic)
763         for grep $in_out{$_} =~ /OUT$/, keys %in_out;
764
765       # all OUTPUT done, so now push the return value on the stack
766       if ($gotRETVAL && $RETVAL_code) {
767         print "\t$RETVAL_code\n";
768       }
769       elsif ($gotRETVAL || $wantRETVAL) {
770         my $t = $args{optimize} && $targetable{$type_kind{$ret_type}};
771         # Although the '$var' declared in the next line is never explicitly
772         # used within this 'elsif' block, commenting it out leads to
773         # disaster, starting with the first 'eval qq' inside the 'elsif' block
774         # below.
775         # It appears that this is related to the fact that at this point the
776         # value of $t is a reference to an array whose [2] element includes
777         # '$var' as a substring:
778         # <i> <> <(IV)$var>
779         my $var = 'RETVAL';
780         my $type = $ret_type;
781     
782         # 0: type, 1: with_size, 2: how, 3: how_size
783         if ($t and not $t->[1] and $t->[0] eq 'p') {
784           # PUSHp corresponds to setpvn.  Treate setpv directly
785           my $what = eval qq("$t->[2]");
786           warn $@ if $@;
787     
788           print "\tsv_setpv(TARG, $what); XSprePUSH; PUSHTARG;\n";
789           $prepush_done = 1;
790         }
791         elsif ($t) {
792           my $what = eval qq("$t->[2]");
793           warn $@ if $@;
794     
795           my $tsize = $t->[3];
796           $tsize = '' unless defined $tsize;
797           $tsize = eval qq("$tsize");
798           warn $@ if $@;
799           print "\tXSprePUSH; PUSH$t->[0]($what$tsize);\n";
800           $prepush_done = 1;
801         }
802         else {
803           # RETVAL almost never needs SvSETMAGIC()
804           &generate_output($ret_type, 0, 'RETVAL', 0);
805         }
806       }
807
808       $xsreturn = 1 if $ret_type ne "void";
809       my $num = $xsreturn;
810       my $c = @outlist;
811       print "\tXSprePUSH;" if $c and not $prepush_done;
812       print "\tEXTEND(SP,$c);\n" if $c;
813       $xsreturn += $c;
814       generate_output($var_types{$_}, $num++, $_, 0, 1) for @outlist;
815
816       # do cleanup
817       process_keyword("CLEANUP|ALIAS|ATTRS|PROTOTYPE|OVERLOAD");
818
819       print Q(<<"EOF") if $ScopeThisXSUB;
820 #   ]]
821 EOF
822       print Q(<<"EOF") if $ScopeThisXSUB and not $PPCODE;
823 #   LEAVE;
824 EOF
825
826       # print function trailer
827       print Q(<<"EOF");
828 #    ]]
829 EOF
830       print Q(<<"EOF") if $args{except};
831 #    BEGHANDLERS
832 #    CATCHALL
833 #    sprintf(errbuf, "%s: %s\\tpropagated", Xname, Xreason);
834 #    ENDHANDLERS
835 EOF
836       if (check_keyword("CASE")) {
837         blurt ("Error: No `CASE:' at top of function")
838           unless $condnum;
839         $_ = "CASE: $_";    # Restore CASE: label
840         next;
841       }
842       last if $_ eq "$END:";
843       death(/^$BLOCK_re/o ? "Misplaced `$1:'" : "Junk at end of function ($_)");
844     }
845
846     print Q(<<"EOF") if $args{except};
847 #    if (errbuf[0])
848 #    Perl_croak(aTHX_ errbuf);
849 EOF
850
851     if ($xsreturn) {
852       print Q(<<"EOF") unless $PPCODE;
853 #    XSRETURN($xsreturn);
854 EOF
855     }
856     else {
857       print Q(<<"EOF") unless $PPCODE;
858 #    XSRETURN_EMPTY;
859 EOF
860     }
861
862     print Q(<<"EOF");
863 #]]
864 #
865 EOF
866
867     $newXS = "newXS";
868     $proto = "";
869
870     # Build the prototype string for the xsub
871     if ($ProtoThisXSUB) {
872       $newXS = "newXSproto_portable";
873
874       if ($ProtoThisXSUB eq 2) {
875         # User has specified empty prototype
876       }
877       elsif ($ProtoThisXSUB eq 1) {
878         my $s = ';';
879         if ($min_args < $num_args)  {
880           $s = '';
881           $proto_arg[$min_args] .= ";";
882         }
883         push @proto_arg, "$s\@"
884           if $ellipsis;
885     
886         $proto = join ("", grep defined, @proto_arg);
887       }
888       else {
889         # User has specified a prototype
890         $proto = $ProtoThisXSUB;
891       }
892       $proto = qq{, "$proto"};
893     }
894
895     if (%XsubAliases) {
896       $XsubAliases{$pname} = 0
897         unless defined $XsubAliases{$pname};
898       while ( my ($xname, $value) = each %XsubAliases) {
899         push(@InitFileCode, Q(<<"EOF"));
900 #        cv = ${newXS}(\"$xname\", XS_$Full_func_name, file$proto);
901 #        XSANY.any_i32 = $value;
902 EOF
903       }
904     }
905     elsif (@Attributes) {
906       push(@InitFileCode, Q(<<"EOF"));
907 #        cv = ${newXS}(\"$pname\", XS_$Full_func_name, file$proto);
908 #        apply_attrs_string("$Package", cv, "@Attributes", 0);
909 EOF
910     }
911     elsif ($interface) {
912       while ( my ($yname, $value) = each %Interfaces) {
913         $yname = "$Package\::$yname" unless $yname =~ /::/;
914         push(@InitFileCode, Q(<<"EOF"));
915 #        cv = ${newXS}(\"$yname\", XS_$Full_func_name, file$proto);
916 #        $interface_macro_set(cv,$value);
917 EOF
918       }
919     }
920     elsif($newXS eq 'newXS'){ # work around P5NCI's empty newXS macro
921       push(@InitFileCode,
922        "        ${newXS}(\"$pname\", XS_$Full_func_name, file$proto);\n");
923     }
924     else {
925       push(@InitFileCode,
926        "        (void)${newXS}(\"$pname\", XS_$Full_func_name, file$proto);\n");
927     }
928   } # END 'PARAGRAPH' 'while' loop
929
930   if ($Overload) { # make it findable with fetchmethod
931     print Q(<<"EOF");
932 #XS(XS_${Packid}_nil); /* prototype to pass -Wmissing-prototypes */
933 #XS(XS_${Packid}_nil)
934 #{
935 #   dXSARGS;
936 #   XSRETURN_EMPTY;
937 #}
938 #
939 EOF
940     unshift(@InitFileCode, <<"MAKE_FETCHMETHOD_WORK");
941     /* Making a sub named "${Package}::()" allows the package */
942     /* to be findable via fetchmethod(), and causes */
943     /* overload::Overloaded("${Package}") to return true. */
944     (void)${newXS}("${Package}::()", XS_${Packid}_nil, file$proto);
945 MAKE_FETCHMETHOD_WORK
946   }
947
948   # print initialization routine
949
950   print Q(<<"EOF");
951 ##ifdef __cplusplus
952 #extern "C"
953 ##endif
954 EOF
955
956   print Q(<<"EOF");
957 #XS(boot_$Module_cname); /* prototype to pass -Wmissing-prototypes */
958 #XS(boot_$Module_cname)
959 EOF
960
961   print Q(<<"EOF");
962 #[[
963 ##ifdef dVAR
964 #    dVAR; dXSARGS;
965 ##else
966 #    dXSARGS;
967 ##endif
968 EOF
969
970   #Under 5.8.x and lower, newXS is declared in proto.h as expecting a non-const
971   #file name argument. If the wrong qualifier is used, it causes breakage with
972   #C++ compilers and warnings with recent gcc.
973   #-Wall: if there is no $Full_func_name there are no xsubs in this .xs
974   #so `file' is unused
975   print Q(<<"EOF") if $Full_func_name;
976 ##if (PERL_REVISION == 5 && PERL_VERSION < 9)
977 #    char* file = __FILE__;
978 ##else
979 #    const char* file = __FILE__;
980 ##endif
981 EOF
982
983   print Q("#\n");
984
985   print Q(<<"EOF");
986 #    PERL_UNUSED_VAR(cv); /* -W */
987 #    PERL_UNUSED_VAR(items); /* -W */
988 EOF
989
990   print Q(<<"EOF") if $WantVersionChk;
991 #    XS_VERSION_BOOTCHECK;
992 #
993 EOF
994
995   print Q(<<"EOF") if defined $XsubAliases or defined $Interfaces;
996 #    {
997 #        CV * cv;
998 #
999 EOF
1000
1001   print Q(<<"EOF") if ($Overload);
1002 #    /* register the overloading (type 'A') magic */
1003 #    PL_amagic_generation++;
1004 #    /* The magic for overload gets a GV* via gv_fetchmeth as */
1005 #    /* mentioned above, and looks in the SV* slot of it for */
1006 #    /* the "fallback" status. */
1007 #    sv_setsv(
1008 #        get_sv( "${Package}::()", TRUE ),
1009 #        $Fallback
1010 #    );
1011 EOF
1012
1013   print @InitFileCode;
1014
1015   print Q(<<"EOF") if defined $XsubAliases or defined $Interfaces;
1016 #    }
1017 EOF
1018
1019   if (@BootCode) {
1020     print "\n    /* Initialisation Section */\n\n";
1021     @line = @BootCode;
1022     print_section();
1023     print "\n    /* End of Initialisation Section */\n\n";
1024   }
1025
1026   print Q(<<'EOF');
1027 ##if (PERL_REVISION == 5 && PERL_VERSION >= 9)
1028 #  if (PL_unitcheckav)
1029 #       call_list(PL_scopestack_ix, PL_unitcheckav);
1030 ##endif
1031 EOF
1032
1033   print Q(<<"EOF");
1034 #    XSRETURN_YES;
1035 #]]
1036 #
1037 EOF
1038
1039   warn("Please specify prototyping behavior for $filename (see perlxs manual)\n")
1040     unless $ProtoUsed;
1041
1042   chdir($orig_cwd);
1043   select($orig_fh);
1044   untie *PSEUDO_STDOUT if tied *PSEUDO_STDOUT;
1045   close $FH;
1046
1047   return 1;
1048 }
1049
1050 sub errors { $errors }
1051
1052 # Input:  ($_, @line) == unparsed input.
1053 # Output: ($_, @line) == (rest of line, following lines).
1054 # Return: the matched keyword if found, otherwise 0
1055 sub check_keyword {
1056   $_ = shift(@line) while !/\S/ && @line;
1057   s/^(\s*)($_[0])\s*:\s*(?:#.*)?/$1/s && $2;
1058 }
1059
1060 sub print_section {
1061   # the "do" is required for right semantics
1062   do { $_ = shift(@line) } while !/\S/ && @line;
1063
1064   print("#line ", $line_no[@line_no - @line -1], " \"$filepathname\"\n")
1065     if $WantLineNumbers && !/^\s*#\s*line\b/ && !/^#if XSubPPtmp/;
1066   for (;  defined($_) && !/^$BLOCK_re/o;  $_ = shift(@line)) {
1067     print "$_\n";
1068   }
1069   print 'ExtUtils::ParseXS::CountLines'->end_marker, "\n" if $WantLineNumbers;
1070 }
1071
1072 sub merge_section {
1073   my $in = '';
1074
1075   while (!/\S/ && @line) {
1076     $_ = shift(@line);
1077   }
1078
1079   for (;  defined($_) && !/^$BLOCK_re/o;  $_ = shift(@line)) {
1080     $in .= "$_\n";
1081   }
1082   chomp $in;
1083   return $in;
1084 }
1085
1086 sub process_keyword($) {
1087   my($pattern) = @_;
1088   my $kwd;
1089
1090   no strict 'refs';
1091   &{"${kwd}_handler"}()
1092     while $kwd = check_keyword($pattern);
1093   use strict 'refs';
1094 }
1095
1096 sub CASE_handler {
1097   blurt ("Error: `CASE:' after unconditional `CASE:'")
1098     if $condnum && $cond eq '';
1099   $cond = $_;
1100   trim_whitespace($cond);
1101   print "   ", ($condnum++ ? " else" : ""), ($cond ? " if ($cond)\n" : "\n");
1102   $_ = '';
1103 }
1104
1105 sub INPUT_handler {
1106   for (;  !/^$BLOCK_re/o;  $_ = shift(@line)) {
1107     last if /^\s*NOT_IMPLEMENTED_YET/;
1108     next unless /\S/;        # skip blank lines
1109
1110     trim_whitespace($_);
1111     my $ln = $_;
1112
1113     # remove trailing semicolon if no initialisation
1114     s/\s*;$//g unless /[=;+].*\S/;
1115
1116     # Process the length(foo) declarations
1117     if (s/^([^=]*)\blength\(\s*(\w+)\s*\)\s*$/$1 XSauto_length_of_$2=NO_INIT/x) {
1118       print "\tSTRLEN\tSTRLEN_length_of_$2;\n";
1119       $lengthof{$2} = undef;
1120       $deferred .= "\n\tXSauto_length_of_$2 = STRLEN_length_of_$2;\n";
1121     }
1122
1123     # check for optional initialisation code
1124     my $var_init = '';
1125     $var_init = $1 if s/\s*([=;+].*)$//s;
1126     $var_init =~ s/"/\\"/g;
1127
1128     s/\s+/ /g;
1129     my ($var_type, $var_addr, $var_name) = /^(.*?[^&\s])\s*(\&?)\s*\b(\w+)$/s
1130       or blurt("Error: invalid argument declaration '$ln'"), next;
1131
1132     # Check for duplicate definitions
1133     blurt ("Error: duplicate definition of argument '$var_name' ignored"), next
1134       if $arg_list{$var_name}++
1135     or defined $argtype_seen{$var_name} and not $processing_arg_with_types;
1136
1137     $thisdone |= $var_name eq "THIS";
1138     $retvaldone |= $var_name eq "RETVAL";
1139     $var_types{$var_name} = $var_type;
1140     # XXXX This check is a safeguard against the unfinished conversion of
1141     # generate_init().  When generate_init() is fixed,
1142     # one can use 2-args map_type() unconditionally.
1143     if ($var_type =~ / \( \s* \* \s* \) /x) {
1144       # Function pointers are not yet supported with &output_init!
1145       print "\t" . &map_type($var_type, $var_name, $hiertype);
1146       $printed_name = 1;
1147     }
1148     else {
1149       print "\t" . &map_type($var_type, undef, $hiertype);
1150       $printed_name = 0;
1151     }
1152     $var_num = $args_match{$var_name};
1153
1154     $proto_arg[$var_num] = ProtoString($var_type)
1155       if $var_num;
1156     $func_args =~ s/\b($var_name)\b/&$1/ if $var_addr;
1157     if ($var_init =~ /^[=;]\s*NO_INIT\s*;?\s*$/
1158       or $in_out{$var_name} and $in_out{$var_name} =~ /^OUT/
1159       and $var_init !~ /\S/) {
1160       if ($printed_name) {
1161         print ";\n";
1162       }
1163       else {
1164         print "\t$var_name;\n";
1165       }
1166     }
1167     elsif ($var_init =~ /\S/) {
1168       &output_init($var_type, $var_num, $var_name, $var_init, $printed_name);
1169     }
1170     elsif ($var_num) {
1171       # generate initialization code
1172       &generate_init($var_type, $var_num, $var_name, $printed_name);
1173     }
1174     else {
1175       print ";\n";
1176     }
1177   }
1178 }
1179
1180 sub OUTPUT_handler {
1181   for (;  !/^$BLOCK_re/o;  $_ = shift(@line)) {
1182     next unless /\S/;
1183     if (/^\s*SETMAGIC\s*:\s*(ENABLE|DISABLE)\s*/) {
1184       $DoSetMagic = ($1 eq "ENABLE" ? 1 : 0);
1185       next;
1186     }
1187     my ($outarg, $outcode) = /^\s*(\S+)\s*(.*?)\s*$/s;
1188     blurt ("Error: duplicate OUTPUT argument '$outarg' ignored"), next
1189       if $outargs{$outarg}++;
1190     if (!$gotRETVAL and $outarg eq 'RETVAL') {
1191       # deal with RETVAL last
1192       $RETVAL_code = $outcode;
1193       $gotRETVAL = 1;
1194       next;
1195     }
1196     blurt ("Error: OUTPUT $outarg not an argument"), next
1197       unless defined($args_match{$outarg});
1198     blurt("Error: No input definition for OUTPUT argument '$outarg' - ignored"), next
1199       unless defined $var_types{$outarg};
1200     $var_num = $args_match{$outarg};
1201     if ($outcode) {
1202       print "\t$outcode\n";
1203       print "\tSvSETMAGIC(ST(" , $var_num-1 , "));\n" if $DoSetMagic;
1204     }
1205     else {
1206       &generate_output($var_types{$outarg}, $var_num, $outarg, $DoSetMagic);
1207     }
1208     delete $in_out{$outarg}     # No need to auto-OUTPUT
1209       if exists $in_out{$outarg} and $in_out{$outarg} =~ /OUT$/;
1210   }
1211 }
1212
1213 sub C_ARGS_handler() {
1214   my $in = merge_section();
1215
1216   trim_whitespace($in);
1217   $func_args = $in;
1218 }
1219
1220 sub INTERFACE_MACRO_handler() {
1221   my $in = merge_section();
1222
1223   trim_whitespace($in);
1224   if ($in =~ /\s/) {        # two
1225     ($interface_macro, $interface_macro_set) = split ' ', $in;
1226   }
1227   else {
1228     $interface_macro = $in;
1229     $interface_macro_set = 'UNKNOWN_CVT'; # catch later
1230   }
1231   $interface = 1;        # local
1232   $Interfaces = 1;        # global
1233 }
1234
1235 sub INTERFACE_handler() {
1236   my $in = merge_section();
1237
1238   trim_whitespace($in);
1239
1240   foreach (split /[\s,]+/, $in) {
1241     my $iface_name = $_;
1242     $iface_name =~ s/^$Prefix//;
1243     $Interfaces{$iface_name} = $_;
1244   }
1245   print Q(<<"EOF");
1246 #    XSFUNCTION = $interface_macro($ret_type,cv,XSANY.any_dptr);
1247 EOF
1248   $interface = 1;        # local
1249   $Interfaces = 1;        # global
1250 }
1251
1252 sub CLEANUP_handler() { print_section() }
1253 sub PREINIT_handler() { print_section() }
1254 sub POSTCALL_handler() { print_section() }
1255 sub INIT_handler()    { print_section() }
1256
1257 sub GetAliases {
1258   my ($line) = @_;
1259   my ($orig) = $line;
1260
1261   # Parse alias definitions
1262   # format is
1263   #    alias = value alias = value ...
1264
1265   while ($line =~ s/^\s*([\w:]+)\s*=\s*(\w+)\s*//) {
1266     my ($alias, $value) = ($1, $2);
1267     my $orig_alias = $alias;
1268
1269     # check for optional package definition in the alias
1270     $alias = $Packprefix . $alias if $alias !~ /::/;
1271
1272     # check for duplicate alias name & duplicate value
1273     Warn("Warning: Ignoring duplicate alias '$orig_alias'")
1274       if defined $XsubAliases{$alias};
1275
1276     Warn("Warning: Aliases '$orig_alias' and '$XsubAliasValues{$value}' have identical values")
1277       if $XsubAliasValues{$value};
1278
1279     $XsubAliases = 1;
1280     $XsubAliases{$alias} = $value;
1281     $XsubAliasValues{$value} = $orig_alias;
1282   }
1283
1284   blurt("Error: Cannot parse ALIAS definitions from '$orig'")
1285     if $line;
1286 }
1287
1288 sub ATTRS_handler () {
1289   for (;  !/^$BLOCK_re/o;  $_ = shift(@line)) {
1290     next unless /\S/;
1291     trim_whitespace($_);
1292     push @Attributes, $_;
1293   }
1294 }
1295
1296 sub ALIAS_handler () {
1297   for (;  !/^$BLOCK_re/o;  $_ = shift(@line)) {
1298     next unless /\S/;
1299     trim_whitespace($_);
1300     GetAliases($_) if $_;
1301   }
1302 }
1303
1304 sub OVERLOAD_handler() {
1305   for (;  !/^$BLOCK_re/o;  $_ = shift(@line)) {
1306     next unless /\S/;
1307     trim_whitespace($_);
1308     while ( s/^\s*([\w:"\\)\+\-\*\/\%\<\>\.\&\|\^\!\~\{\}\=]+)\s*//) {
1309       $Overload = 1 unless $Overload;
1310       my $overload = "$Package\::(".$1;
1311       push(@InitFileCode,
1312        "        (void)${newXS}(\"$overload\", XS_$Full_func_name, file$proto);\n");
1313     }
1314   }
1315 }
1316
1317 sub FALLBACK_handler() {
1318   # the rest of the current line should contain either TRUE,
1319   # FALSE or UNDEF
1320
1321   trim_whitespace($_);
1322   my %map = (
1323     TRUE => "&PL_sv_yes", 1 => "&PL_sv_yes",
1324     FALSE => "&PL_sv_no", 0 => "&PL_sv_no",
1325     UNDEF => "&PL_sv_undef",
1326   );
1327
1328   # check for valid FALLBACK value
1329   death ("Error: FALLBACK: TRUE/FALSE/UNDEF") unless exists $map{uc $_};
1330
1331   $Fallback = $map{uc $_};
1332 }
1333
1334
1335 sub REQUIRE_handler () {
1336   # the rest of the current line should contain a version number
1337   my ($Ver) = $_;
1338
1339   trim_whitespace($Ver);
1340
1341   death ("Error: REQUIRE expects a version number")
1342     unless $Ver;
1343
1344   # check that the version number is of the form n.n
1345   death ("Error: REQUIRE: expected a number, got '$Ver'")
1346     unless $Ver =~ /^\d+(\.\d*)?/;
1347
1348   death ("Error: xsubpp $Ver (or better) required--this is only $VERSION.")
1349     unless $VERSION >= $Ver;
1350 }
1351
1352 sub VERSIONCHECK_handler () {
1353   # the rest of the current line should contain either ENABLE or
1354   # DISABLE
1355
1356   trim_whitespace($_);
1357
1358   # check for ENABLE/DISABLE
1359   death ("Error: VERSIONCHECK: ENABLE/DISABLE")
1360     unless /^(ENABLE|DISABLE)/i;
1361
1362   $WantVersionChk = 1 if $1 eq 'ENABLE';
1363   $WantVersionChk = 0 if $1 eq 'DISABLE';
1364
1365 }
1366
1367 sub PROTOTYPE_handler () {
1368   my $specified;
1369
1370   death("Error: Only 1 PROTOTYPE definition allowed per xsub")
1371     if $proto_in_this_xsub++;
1372
1373   for (;  !/^$BLOCK_re/o;  $_ = shift(@line)) {
1374     next unless /\S/;
1375     $specified = 1;
1376     trim_whitespace($_);
1377     if ($_ eq 'DISABLE') {
1378       $ProtoThisXSUB = 0;
1379     }
1380     elsif ($_ eq 'ENABLE') {
1381       $ProtoThisXSUB = 1;
1382     }
1383     else {
1384       # remove any whitespace
1385       s/\s+//g;
1386       death("Error: Invalid prototype '$_'")
1387         unless valid_proto_string($_);
1388       $ProtoThisXSUB = C_string($_);
1389     }
1390   }
1391
1392   # If no prototype specified, then assume empty prototype ""
1393   $ProtoThisXSUB = 2 unless $specified;
1394
1395   $ProtoUsed = 1;
1396 }
1397
1398 sub SCOPE_handler () {
1399   death("Error: Only 1 SCOPE declaration allowed per xsub")
1400     if $scope_in_this_xsub++;
1401
1402   trim_whitespace($_);
1403   death ("Error: SCOPE: ENABLE/DISABLE")
1404       unless /^(ENABLE|DISABLE)\b/i;
1405   $ScopeThisXSUB = ( uc($1) eq 'ENABLE' );
1406 }
1407
1408 sub PROTOTYPES_handler () {
1409   # the rest of the current line should contain either ENABLE or
1410   # DISABLE
1411
1412   trim_whitespace($_);
1413
1414   # check for ENABLE/DISABLE
1415   death ("Error: PROTOTYPES: ENABLE/DISABLE")
1416     unless /^(ENABLE|DISABLE)/i;
1417
1418   $WantPrototypes = 1 if $1 eq 'ENABLE';
1419   $WantPrototypes = 0 if $1 eq 'DISABLE';
1420   $ProtoUsed = 1;
1421 }
1422
1423 sub PushXSStack {
1424   my %args = @_;
1425   # Save the current file context.
1426   push(@XSStack, {
1427           type            => 'file',
1428           LastLine        => $lastline,
1429           LastLineNo      => $lastline_no,
1430           Line            => \@line,
1431           LineNo          => \@line_no,
1432           Filename        => $filename,
1433           Filepathname    => $filepathname,
1434           Handle          => $FH,
1435           IsPipe          => scalar($filename =~ /\|\s*$/),
1436           %args,
1437          });
1438
1439 }
1440
1441 sub INCLUDE_handler () {
1442   # the rest of the current line should contain a valid filename
1443
1444   trim_whitespace($_);
1445
1446   death("INCLUDE: filename missing")
1447     unless $_;
1448
1449   death("INCLUDE: output pipe is illegal")
1450     if /^\s*\|/;
1451
1452   # simple minded recursion detector
1453   death("INCLUDE loop detected")
1454     if $IncludedFiles{$_};
1455
1456   ++$IncludedFiles{$_} unless /\|\s*$/;
1457
1458   if (/\|\s*$/ && /^\s*perl\s/) {
1459     Warn("The INCLUDE directive with a command is discouraged." .
1460          " Use INCLUDE_COMMAND instead! In particular using 'perl'" .
1461          " in an 'INCLUDE: ... |' directive is not guaranteed to pick" .
1462          " up the correct perl. The INCLUDE_COMMAND directive allows" .
1463          " the use of \$^X as the currently running perl, see" .
1464          " 'perldoc perlxs' for details.");
1465   }
1466
1467   PushXSStack();
1468
1469   $FH = Symbol::gensym();
1470
1471   # open the new file
1472   open ($FH, "$_") or death("Cannot open '$_': $!");
1473
1474   print Q(<<"EOF");
1475 #
1476 #/* INCLUDE:  Including '$_' from '$filename' */
1477 #
1478 EOF
1479
1480   $filename = $_;
1481   $filepathname = File::Spec->catfile($dir, $filename);
1482
1483   # Prime the pump by reading the first
1484   # non-blank line
1485
1486   # skip leading blank lines
1487   while (<$FH>) {
1488     last unless /^\s*$/;
1489   }
1490
1491   $lastline = $_;
1492   $lastline_no = $.;
1493 }
1494
1495 sub QuoteArgs {
1496   my $cmd = shift;
1497   my @args = split /\s+/, $cmd;
1498   $cmd = shift @args;
1499   for (@args) {
1500     $_ = q(").$_.q(") if !/^\"/ && length($_) > 0;
1501   }
1502   return join (' ', ($cmd, @args));
1503 }
1504
1505 sub INCLUDE_COMMAND_handler () {
1506   # the rest of the current line should contain a valid command
1507
1508   trim_whitespace($_);
1509
1510   $_ = QuoteArgs($_) if $^O eq 'VMS';
1511
1512   death("INCLUDE_COMMAND: command missing")
1513     unless $_;
1514
1515   death("INCLUDE_COMMAND: pipes are illegal")
1516     if /^\s*\|/ or /\|\s*$/;
1517
1518   PushXSStack( IsPipe => 1 );
1519
1520   $FH = Symbol::gensym();
1521
1522   # If $^X is used in INCLUDE_COMMAND, we know it's supposed to be
1523   # the same perl interpreter as we're currently running
1524   s/^\s*\$\^X/$^X/;
1525
1526   # open the new file
1527   open ($FH, "-|", "$_")
1528     or death("Cannot run command '$_' to include its output: $!");
1529
1530   print Q(<<"EOF");
1531 #
1532 #/* INCLUDE_COMMAND:  Including output of '$_' from '$filename' */
1533 #
1534 EOF
1535
1536   $filename = $_;
1537   $filepathname = $filename;
1538   $filepathname =~ s/\"/\\"/g;
1539
1540   # Prime the pump by reading the first
1541   # non-blank line
1542
1543   # skip leading blank lines
1544   while (<$FH>) {
1545     last unless /^\s*$/;
1546   }
1547
1548   $lastline = $_;
1549   $lastline_no = $.;
1550 }
1551
1552 sub PopFile() {
1553   return 0 unless $XSStack[-1]{type} eq 'file';
1554
1555   my $data     = pop @XSStack;
1556   my $ThisFile = $filename;
1557   my $isPipe   = $data->{IsPipe};
1558
1559   --$IncludedFiles{$filename}
1560     unless $isPipe;
1561
1562   close $FH;
1563
1564   $FH         = $data->{Handle};
1565   # $filename is the leafname, which for some reason isused for diagnostic
1566   # messages, whereas $filepathname is the full pathname, and is used for
1567   # #line directives.
1568   $filename   = $data->{Filename};
1569   $filepathname = $data->{Filepathname};
1570   $lastline   = $data->{LastLine};
1571   $lastline_no = $data->{LastLineNo};
1572   @line       = @{ $data->{Line} };
1573   @line_no    = @{ $data->{LineNo} };
1574
1575   if ($isPipe and $? ) {
1576     --$lastline_no;
1577     print STDERR "Error reading from pipe '$ThisFile': $! in $filename, line $lastline_no\n" ;
1578     exit 1;
1579   }
1580
1581   print Q(<<"EOF");
1582 #
1583 #/* INCLUDE: Returning to '$filename' from '$ThisFile' */
1584 #
1585 EOF
1586
1587   return 1;
1588 }
1589
1590 sub ProtoString ($) {
1591   my ($type) = @_;
1592
1593   $proto_letter{$type} or "\$";
1594 }
1595
1596 sub check_cpp {
1597   my @cpp = grep(/^\#\s*(?:if|e\w+)/, @line);
1598   if (@cpp) {
1599     my ($cpp, $cpplevel);
1600     for $cpp (@cpp) {
1601       if ($cpp =~ /^\#\s*if/) {
1602         $cpplevel++;
1603       }
1604       elsif (!$cpplevel) {
1605         Warn("Warning: #else/elif/endif without #if in this function");
1606         print STDERR "    (precede it with a blank line if the matching #if is outside the function)\n"
1607           if $XSStack[-1]{type} eq 'if';
1608         return;
1609       }
1610       elsif ($cpp =~ /^\#\s*endif/) {
1611         $cpplevel--;
1612       }
1613     }
1614     Warn("Warning: #if without #endif in this function") if $cpplevel;
1615   }
1616 }
1617
1618
1619 sub Q {
1620   my($text) = @_;
1621   $text =~ s/^#//gm;
1622   $text =~ s/\[\[/{/g;
1623   $text =~ s/\]\]/}/g;
1624   $text;
1625 }
1626
1627 # Read next xsub into @line from ($lastline, <$FH>).
1628 sub fetch_para {
1629   # parse paragraph
1630   death ("Error: Unterminated `#if/#ifdef/#ifndef'")
1631     if !defined $lastline && $XSStack[-1]{type} eq 'if';
1632   @line = ();
1633   @line_no = ();
1634   return PopFile() if !defined $lastline;
1635
1636   if ($lastline =~
1637       /^MODULE\s*=\s*([\w:]+)(?:\s+PACKAGE\s*=\s*([\w:]+))?(?:\s+PREFIX\s*=\s*(\S+))?\s*$/) {
1638     my $Module = $1;
1639     $Package = defined($2) ? $2 : ''; # keep -w happy
1640     $Prefix  = defined($3) ? $3 : ''; # keep -w happy
1641     $Prefix = quotemeta $Prefix;
1642     ($Module_cname = $Module) =~ s/\W/_/g;
1643     ($Packid = $Package) =~ tr/:/_/;
1644     $Packprefix = $Package;
1645     $Packprefix .= "::" if $Packprefix ne "";
1646     $lastline = "";
1647   }
1648
1649   for (;;) {
1650     # Skip embedded PODs
1651     while ($lastline =~ /^=/) {
1652       while ($lastline = <$FH>) {
1653         last if ($lastline =~ /^=cut\s*$/);
1654       }
1655       death ("Error: Unterminated pod") unless $lastline;
1656       $lastline = <$FH>;
1657       chomp $lastline;
1658       $lastline =~ s/^\s+$//;
1659     }
1660     if ($lastline !~ /^\s*#/ ||
1661     # CPP directives:
1662     #    ANSI:    if ifdef ifndef elif else endif define undef
1663     #        line error pragma
1664     #    gcc:    warning include_next
1665     #   obj-c:    import
1666     #   others:    ident (gcc notes that some cpps have this one)
1667     $lastline =~ /^#[ \t]*(?:(?:if|ifn?def|elif|else|endif|define|undef|pragma|error|warning|line\s+\d+|ident)\b|(?:include(?:_next)?|import)\s*["<].*[>"])/) {
1668       last if $lastline =~ /^\S/ && @line && $line[-1] eq "";
1669       push(@line, $lastline);
1670       push(@line_no, $lastline_no);
1671     }
1672
1673     # Read next line and continuation lines
1674     last unless defined($lastline = <$FH>);
1675     $lastline_no = $.;
1676     my $tmp_line;
1677     $lastline .= $tmp_line
1678       while ($lastline =~ /\\$/ && defined($tmp_line = <$FH>));
1679
1680     chomp $lastline;
1681     $lastline =~ s/^\s+$//;
1682   }
1683   pop(@line), pop(@line_no) while @line && $line[-1] eq "";
1684   1;
1685 }
1686
1687 sub output_init {
1688   my ($type, $num, $var, $init, $printed_name) = @_;
1689   my $arg = "ST(" . ($num - 1) . ")";
1690
1691   if (  $init =~ /^=/  ) {
1692     if ($printed_name) {
1693       eval qq/print " $init\\n"/;
1694     }
1695     else {
1696       eval qq/print "\\t$var $init\\n"/;
1697     }
1698     warn $@ if $@;
1699   }
1700   else {
1701     if (  $init =~ s/^\+//  &&  $num  ) {
1702       &generate_init($type, $num, $var, $printed_name);
1703     }
1704     elsif ($printed_name) {
1705       print ";\n";
1706       $init =~ s/^;//;
1707     }
1708     else {
1709       eval qq/print "\\t$var;\\n"/;
1710       warn $@ if $@;
1711       $init =~ s/^;//;
1712     }
1713     $deferred .= eval qq/"\\n\\t$init\\n"/;
1714     warn $@ if $@;
1715   }
1716 }
1717
1718 sub Warn {
1719   # work out the line number
1720   my $warn_line_number = $line_no[@line_no - @line -1];
1721
1722   print STDERR "@_ in $filename, line $warn_line_number\n";
1723 }
1724
1725 sub blurt {
1726   Warn @_;
1727   $errors++
1728 }
1729
1730 sub death {
1731   Warn @_;
1732   exit 1;
1733 }
1734
1735 sub generate_init {
1736   my ($type, $num, $var, $printed_name) = @_;
1737   my $arg = "ST(" . ($num - 1) . ")";
1738   my ($argoff, $ntype, $tk);
1739   $argoff = $num - 1;
1740
1741   $type = tidy_type($type);
1742   blurt("Error: '$type' not in typemap"), return
1743     unless defined($type_kind{$type});
1744
1745   ($ntype = $type) =~ s/\s*\*/Ptr/g;
1746   my $subtype;
1747   ($subtype = $ntype) =~ s/(?:Array)?(?:Ptr)?$//;
1748   $tk = $type_kind{$type};
1749   $tk =~ s/OBJ$/REF/ if $func_name =~ /DESTROY$/;
1750   if ($tk eq 'T_PV' and exists $lengthof{$var}) {
1751     print "\t$var" unless $printed_name;
1752     print " = ($type)SvPV($arg, STRLEN_length_of_$var);\n";
1753     die "default value not supported with length(NAME) supplied"
1754       if defined $defaults{$var};
1755     return;
1756   }
1757   $type =~ tr/:/_/ unless $hiertype;
1758   blurt("Error: No INPUT definition for type '$type', typekind '$type_kind{$type}' found"), return
1759     unless defined $input_expr{$tk};
1760   my $expr = $input_expr{$tk};
1761   if ($expr =~ /DO_ARRAY_ELEM/) {
1762     blurt("Error: '$subtype' not in typemap"), return
1763       unless defined($type_kind{$subtype});
1764     blurt("Error: No INPUT definition for type '$subtype', typekind '$type_kind{$subtype}' found"), return
1765       unless defined $input_expr{$type_kind{$subtype}};
1766     my $subexpr = $input_expr{$type_kind{$subtype}};
1767     $subexpr =~ s/\$type/\$subtype/g;
1768     $subexpr =~ s/ntype/subtype/g;
1769     $subexpr =~ s/\$arg/ST(ix_$var)/g;
1770     $subexpr =~ s/\n\t/\n\t\t/g;
1771     $subexpr =~ s/is not of (.*\")/[arg %d] is not of $1, ix_$var + 1/g;
1772     $subexpr =~ s/\$var/${var}[ix_$var - $argoff]/;
1773     $expr =~ s/DO_ARRAY_ELEM/$subexpr/;
1774   }
1775   if ($expr =~ m#/\*.*scope.*\*/#i) {  # "scope" in C comments
1776     $ScopeThisXSUB = 1;
1777   }
1778   if (defined($defaults{$var})) {
1779     $expr =~ s/(\t+)/$1    /g;
1780     $expr =~ s/        /\t/g;
1781     if ($printed_name) {
1782       print ";\n";
1783     }
1784     else {
1785       eval qq/print "\\t$var;\\n"/;
1786       warn $@ if $@;
1787     }
1788     if ($defaults{$var} eq 'NO_INIT') {
1789       $deferred .= eval qq/"\\n\\tif (items >= $num) {\\n$expr;\\n\\t}\\n"/;
1790     }
1791     else {
1792       $deferred .= eval qq/"\\n\\tif (items < $num)\\n\\t    $var = $defaults{$var};\\n\\telse {\\n$expr;\\n\\t}\\n"/;
1793     }
1794     warn $@ if $@;
1795   }
1796   elsif ($ScopeThisXSUB or $expr !~ /^\s*\$var =/) {
1797     if ($printed_name) {
1798       print ";\n";
1799     }
1800     else {
1801       eval qq/print "\\t$var;\\n"/;
1802       warn $@ if $@;
1803     }
1804     $deferred .= eval qq/"\\n$expr;\\n"/;
1805     warn $@ if $@;
1806   }
1807   else {
1808     die "panic: do not know how to handle this branch for function pointers"
1809       if $printed_name;
1810     eval qq/print "$expr;\\n"/;
1811     warn $@ if $@;
1812   }
1813 }
1814
1815 sub generate_output {
1816   my ($type, $num, $var, $do_setmagic, $do_push) = @_;
1817   my $arg = "ST(" . ($num - ($num != 0)) . ")";
1818   my $ntype;
1819
1820   $type = tidy_type($type);
1821   if ($type =~ /^array\(([^,]*),(.*)\)/) {
1822     print "\t$arg = sv_newmortal();\n";
1823     print "\tsv_setpvn($arg, (char *)$var, $2 * sizeof($1));\n";
1824     print "\tSvSETMAGIC($arg);\n" if $do_setmagic;
1825   }
1826   else {
1827     blurt("Error: '$type' not in typemap"), return
1828       unless defined($type_kind{$type});
1829     blurt("Error: No OUTPUT definition for type '$type', typekind '$type_kind{$type}' found"), return
1830       unless defined $output_expr{$type_kind{$type}};
1831     ($ntype = $type) =~ s/\s*\*/Ptr/g;
1832     $ntype =~ s/\(\)//g;
1833     my $subtype;
1834     ($subtype = $ntype) =~ s/(?:Array)?(?:Ptr)?$//;
1835     my $expr = $output_expr{$type_kind{$type}};
1836     if ($expr =~ /DO_ARRAY_ELEM/) {
1837       blurt("Error: '$subtype' not in typemap"), return
1838     unless defined($type_kind{$subtype});
1839       blurt("Error: No OUTPUT definition for type '$subtype', typekind '$type_kind{$subtype}' found"), return
1840     unless defined $output_expr{$type_kind{$subtype}};
1841       my $subexpr = $output_expr{$type_kind{$subtype}};
1842       $subexpr =~ s/ntype/subtype/g;
1843       $subexpr =~ s/\$arg/ST(ix_$var)/g;
1844       $subexpr =~ s/\$var/${var}[ix_$var]/g;
1845       $subexpr =~ s/\n\t/\n\t\t/g;
1846       $expr =~ s/DO_ARRAY_ELEM\n/$subexpr/;
1847       eval "print qq\a$expr\a";
1848       warn $@ if $@;
1849       print "\t\tSvSETMAGIC(ST(ix_$var));\n" if $do_setmagic;
1850     }
1851     elsif ($var eq 'RETVAL') {
1852       if ($expr =~ /^\t\$arg = new/) {
1853         # We expect that $arg has refcnt 1, so we need to
1854         # mortalize it.
1855         eval "print qq\a$expr\a";
1856         warn $@ if $@;
1857         print "\tsv_2mortal(ST($num));\n";
1858         print "\tSvSETMAGIC(ST($num));\n" if $do_setmagic;
1859       }
1860       elsif ($expr =~ /^\s*\$arg\s*=/) {
1861         # We expect that $arg has refcnt >=1, so we need
1862         # to mortalize it!
1863         eval "print qq\a$expr\a";
1864         warn $@ if $@;
1865         print "\tsv_2mortal(ST(0));\n";
1866         print "\tSvSETMAGIC(ST(0));\n" if $do_setmagic;
1867       }
1868       else {
1869         # Just hope that the entry would safely write it
1870         # over an already mortalized value. By
1871         # coincidence, something like $arg = &sv_undef
1872         # works too.
1873         print "\tST(0) = sv_newmortal();\n";
1874         eval "print qq\a$expr\a";
1875         warn $@ if $@;
1876         # new mortals don't have set magic
1877       }
1878     }
1879     elsif ($do_push) {
1880       print "\tPUSHs(sv_newmortal());\n";
1881       $arg = "ST($num)";
1882       eval "print qq\a$expr\a";
1883       warn $@ if $@;
1884       print "\tSvSETMAGIC($arg);\n" if $do_setmagic;
1885     }
1886     elsif ($arg =~ /^ST\(\d+\)$/) {
1887       eval "print qq\a$expr\a";
1888       warn $@ if $@;
1889       print "\tSvSETMAGIC($arg);\n" if $do_setmagic;
1890     }
1891   }
1892 }
1893
1894 1;