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