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