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