1 package ExtUtils::ParseXS;
3 use 5.006; # We use /??{}/ in regexes
12 @EXPORT_OK = qw(process_file);
14 # use strict; # One of these days...
16 my(@XSStack); # Stack of conditionals and INCLUDEs
17 my($XSS_work_idx, $cpp_next_tmp);
19 use vars qw($VERSION);
21 $VERSION = eval $VERSION;
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.
39 # Allow for $package->process_file(%hash) in the future
40 my ($pkg, %args) = @_ % 2 ? @_ : (__PACKAGE__, @_);
42 $ProtoUsed = exists $args{prototypes};
46 # 'C++' => 0, # Doesn't seem to *do* anything...
64 my ($Is_VMS, $SymSet);
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;
72 @XSStack = ({type => 'none'});
73 ($XSS_work_idx, $cpp_next_tmp) = (0, "XSubPPtmpAAAA");
76 $proto_re = "[" . quotemeta('\$%&*@;[]') . "]" ;
79 $Fallback = 'PL_sv_undef';
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
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});
96 for ($args{filename}) {
97 die "Missing required parameter 'filename'" unless $_;
99 ($dir, $filename) = (dirname($_), basename($_));
100 $filepathname =~ s/\\/\\\\/g;
101 $IncludedFiles{$_}++;
104 # Open the input file
105 open($FH, $args{filename}) or die "cannot open $args{filename}: $!\n";
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};
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();
122 my $csuffix = $args{csuffix};
124 if ($WantLineNumbers) {
126 if ( $args{outfile} ) {
127 $cfile = $args{outfile};
129 $cfile = $args{filename};
130 $cfile =~ s/\.xs$/$csuffix/i or $cfile .= $csuffix;
132 tie(*PSEUDO_STDOUT, 'ExtUtils::ParseXS::CountLines', $cfile, $args{output});
133 select PSEUDO_STDOUT;
135 select $args{output};
138 foreach my $typemap (@tm) {
139 die "Can't find $typemap in $pwd\n" unless -r $typemap;
142 push @tm, standard_typemap_locations();
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
149 open(TYPEMAP, $typemap)
150 or warn ("Warning: could not open typemap file '$typemap': $!\n"), next;
151 my $mode = 'Typemap';
153 my $current = \$junk;
156 my $line_no = $. + 1;
158 $mode = 'Input'; $current = \$junk; next;
161 $mode = 'Output'; $current = \$junk; next;
163 if (/^TYPEMAP\s*$/) {
164 $mode = 'Typemap'; $current = \$junk; next;
166 if ($mode eq 'Typemap') {
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) ;
183 } elsif ($mode eq 'Input') {
185 $input_expr{$_} = '';
186 $current = \$input_expr{$_};
189 $output_expr{$_} = '';
190 $current = \$output_expr{$_};
196 foreach my $key (keys %input_expr) {
197 $input_expr{$key} =~ s/;*\s+\z//;
200 my ($bal, $cast, $size);
201 $bal = qr[(?:(?>[^()]+)|\((??{ $bal })\))*]; # ()-balanced
202 $cast = qr[(?:\(\s*SV\s*\*\s*\)\s*)?]; # Optional (SV*) cast
203 $size = qr[,\s* (??{ $bal }) ]x; # Third arg (to setpvn)
205 foreach my $key (keys %output_expr) {
208 my ($t, $with_size, $arg, $sarg) =
209 ($output_expr{$key} =~
210 m[^ \s+ sv_set ( [iunp] ) v (n)? # Type, is_setpvn
211 \s* \( \s* $cast \$arg \s* ,
212 \s* ( (??{ $bal }) ) # Set from
213 ( (??{ $size }) )? # Possible sizeof set-from
216 $targetable{$key} = [$t, $with_size, $arg, $sarg] if $t;
219 my $END = "!End!\n\n"; # "impossible" keyword (multiple newline)
221 # Match an XS keyword
222 $BLOCK_re= '\s*(' . join('|', qw(
223 REQUIRE BOOT CASE PREINIT INPUT INIT CODE PPCODE OUTPUT
224 CLEANUP ALIAS ATTRS PROTOTYPES PROTOTYPE VERSIONCHECK INCLUDE
225 SCOPE INTERFACE INTERFACE_MACRO C_ARGS POSTCALL OVERLOAD FALLBACK
229 my ($C_group_rex, $C_arg);
230 # Group in C (no support for comments or literals)
231 $C_group_rex = qr/ [({\[]
232 (?: (?> [^()\[\]{}]+ ) | (??{ $C_group_rex }) )*
234 # Chunk in C without comma at toplevel (no comments):
235 $C_arg = qr/ (?: (?> [^()\[\]{},"']+ )
236 | (??{ $C_group_rex })
237 | " (?: (?> [^\\"]+ )
239 )* " # String literal
240 | ' (?: (?> [^\\']+ ) | \\. )* ' # Char literal
243 # Identify the version of xsubpp used
246 * This file was generated automatically by ExtUtils::ParseXS version $VERSION from the
247 * contents of $filename. Do not edit this file, edit $filename instead.
249 * ANY CHANGES MADE HERE WILL BE LOST!
256 print("#line 1 \"$filepathname\"\n")
262 my $podstartline = $.;
265 # We can't just write out a /* */ comment, as our embedded
266 # POD might itself be in a comment. We can't put a /**/
267 # comment inside #if 0, as the C standard says that the source
268 # file is decomposed into preprocessing characters in the stage
269 # before preprocessing commands are executed.
270 # I don't want to leave the text as barewords, because the spec
271 # isn't clear whether macros are expanded before or after
272 # preprocessing commands are executed, and someone pathological
273 # may just have defined one of the 3 words as a macro that does
274 # something strange. Multiline strings are illegal in C, so
275 # the "" we write must be a string literal. And they aren't
276 # concatenated until 2 steps later, so we are safe.
278 print("#if 0\n \"Skipped embedded POD.\"\n#endif\n");
279 printf("#line %d \"$filepathname\"\n", $. + 1)
285 # At this point $. is at end of file so die won't state the start
286 # of the problem, and as we haven't yet read any lines &death won't
287 # show the correct line in the message either.
288 die ("Error: Unterminated pod in $filename, line $podstartline\n")
291 last if ($Package, $Prefix) =
292 /^MODULE\s*=\s*[\w:]+(?:\s+PACKAGE\s*=\s*([\w:]+))?(?:\s+PREFIX\s*=\s*(\S+))?\s*$/;
296 unless (defined $_) {
297 warn "Didn't find a 'MODULE ... PACKAGE ... PREFIX' line\n";
298 exit 0; # Not a fatal error for the caller process
302 #ifndef PERL_UNUSED_VAR
303 # define PERL_UNUSED_VAR(var) if (0) var = var
308 print 'ExtUtils::ParseXS::CountLines'->end_marker, "\n" if $WantLineNumbers;
314 while (fetch_para()) {
315 # Print initial preprocessor statements and blank lines
316 while (@line && $line[0] !~ /^[^\#]/) {
317 my $line = shift(@line);
319 next unless $line =~ /^\#\s*((if)(?:n?def)?|elsif|else|endif)\b/;
321 if ($statement eq 'if') {
322 $XSS_work_idx = @XSStack;
323 push(@XSStack, {type => 'if'});
325 death ("Error: `$statement' with no matching `if'")
326 if $XSStack[-1]{type} ne 'if';
327 if ($XSStack[-1]{varname}) {
328 push(@InitFileCode, "#endif\n");
329 push(@BootCode, "#endif");
332 my(@fns) = keys %{$XSStack[-1]{functions}};
333 if ($statement ne 'endif') {
334 # Hide the functions defined in other #if branches, and reset.
335 @{$XSStack[-1]{other_functions}}{@fns} = (1) x @fns;
336 @{$XSStack[-1]}{qw(varname functions)} = ('', {});
338 my($tmp) = pop(@XSStack);
339 0 while (--$XSS_work_idx
340 && $XSStack[$XSS_work_idx]{type} ne 'if');
341 # Keep all new defined functions
342 push(@fns, keys %{$tmp->{other_functions}});
343 @{$XSStack[$XSS_work_idx]{functions}}{@fns} = (1) x @fns;
348 next PARAGRAPH unless @line;
350 if ($XSS_work_idx && !$XSStack[$XSS_work_idx]{varname}) {
351 # We are inside an #if, but have not yet #defined its xsubpp variable.
352 print "#define $cpp_next_tmp 1\n\n";
353 push(@InitFileCode, "#if $cpp_next_tmp\n");
354 push(@BootCode, "#if $cpp_next_tmp");
355 $XSStack[$XSS_work_idx]{varname} = $cpp_next_tmp++;
358 death ("Code is not inside a function"
359 ." (maybe last function was ended by a blank line "
360 ." followed by a statement on column one?)")
361 if $line[0] =~ /^\s/;
363 my ($class, $externC, $static, $elipsis, $wantRETVAL, $RETVAL_no_return);
364 my (@fake_INPUT_pre); # For length(s) generated variables
367 # initialize info arrays
373 undef($processing_arg_with_types) ;
374 undef(%argtype_seen) ;
378 undef($proto_in_this_xsub) ;
379 undef($scope_in_this_xsub) ;
381 undef($prepush_done);
382 $interface_macro = 'XSINTERFACE_FUNC' ;
383 $interface_macro_set = 'XSINTERFACE_FUNC_SET' ;
384 $ProtoThisXSUB = $WantPrototypes ;
389 while (my $kwd = check_keyword("REQUIRE|PROTOTYPES|FALLBACK|VERSIONCHECK|INCLUDE")) {
390 &{"${kwd}_handler"}() ;
391 next PARAGRAPH unless @line ;
395 if (check_keyword("BOOT")) {
397 push (@BootCode, "#line $line_no[@line_no - @line] \"$filepathname\"")
398 if $WantLineNumbers && $line[0] !~ /^\s*#\s*line\b/;
399 push (@BootCode, @line, "") ;
404 # extract return type, function name and arguments
405 ($ret_type) = TidyType($_);
406 $RETVAL_no_return = 1 if $ret_type =~ s/^NO_OUTPUT\s+//;
408 # Allow one-line ANSI-like declaration
411 and $ret_type =~ s/^(.*?\w.*?)\s*\b(\w+\s*\(.*)/$1/s;
413 # a function definition needs at least 2 lines
414 blurt ("Error: Function definition too short '$ret_type'"), next PARAGRAPH
417 $externC = 1 if $ret_type =~ s/^extern "C"\s+//;
418 $static = 1 if $ret_type =~ s/^static\s+//;
420 $func_header = shift(@line);
421 blurt ("Error: Cannot parse function definition from '$func_header'"), next PARAGRAPH
422 unless $func_header =~ /^(?:([\w:]*)::)?(\w+)\s*\(\s*(.*?)\s*\)\s*(const)?\s*(;\s*)?$/s;
424 ($class, $func_name, $orig_args) = ($1, $2, $3) ;
425 $class = "$4 $class" if $4;
426 ($pname = $func_name) =~ s/^($Prefix)?/$Packprefix/;
427 ($clean_func_name = $func_name) =~ s/^$Prefix//;
428 $Full_func_name = "${Packid}_$clean_func_name";
430 $Full_func_name = $SymSet->addsym($Full_func_name);
433 # Check for duplicate function definition
434 for my $tmp (@XSStack) {
435 next unless defined $tmp->{functions}{$Full_func_name};
436 Warn("Warning: duplicate function definition '$clean_func_name' detected");
439 $XSStack[$XSS_work_idx]{functions}{$Full_func_name} ++ ;
440 %XsubAliases = %XsubAliasValues = %Interfaces = @Attributes = ();
443 $orig_args =~ s/\\\s*/ /g; # process line continuations
446 my %only_C_inlist; # Not in the signature of Perl function
447 if ($process_argtypes and $orig_args =~ /\S/) {
448 my $args = "$orig_args ,";
449 if ($args =~ /^( (??{ $C_arg }) , )* $ /x) {
450 @args = ($args =~ /\G ( (??{ $C_arg }) ) , /xg);
454 my ($arg, $default) = / ( [^=]* ) ( (?: = .* )? ) /x;
455 my ($pre, $name) = ($arg =~ /(.*?) \s*
456 \b ( \w+ | length\( \s*\w+\s* \) )
458 next unless defined($pre) && length($pre);
461 if ($process_inout and s/^(IN|IN_OUTLIST|OUTLIST|OUT|IN_OUT)\s+//) {
463 $out_type = $type if $type ne 'IN';
464 $arg =~ s/^(IN|IN_OUTLIST|OUTLIST|OUT|IN_OUT)\s+//;
465 $pre =~ s/^(IN|IN_OUTLIST|OUTLIST|OUT|IN_OUT)\s+//;
468 if ($name =~ /^length\( \s* (\w+) \s* \)\z/x) {
469 $name = "XSauto_length_of_$1";
471 die "Default value on length() argument: `$_'"
474 if (length $pre or $islength) { # Has a type
476 push @fake_INPUT_pre, $arg;
478 push @fake_INPUT, $arg;
480 # warn "pushing '$arg'\n";
481 $argtype_seen{$name}++;
482 $_ = "$name$default"; # Assigns to @args
484 $only_C_inlist{$_} = 1 if $out_type eq "OUTLIST" or $islength;
485 push @outlist, $name if $out_type =~ /OUTLIST$/;
486 $in_out{$name} = $out_type if $out_type;
489 @args = split(/\s*,\s*/, $orig_args);
490 Warn("Warning: cannot parse argument list '$orig_args', fallback to split");
493 @args = split(/\s*,\s*/, $orig_args);
495 if ($process_inout and s/^(IN|IN_OUTLIST|OUTLIST|IN_OUT|OUT)\s+//) {
497 next if $out_type eq 'IN';
498 $only_C_inlist{$_} = 1 if $out_type eq "OUTLIST";
499 push @outlist, $name if $out_type =~ /OUTLIST$/;
500 $in_out{$_} = $out_type;
504 if (defined($class)) {
505 my $arg0 = ((defined($static) or $func_name eq 'new')
507 unshift(@args, $arg0);
508 ($report_args = "$arg0, $report_args") =~ s/^\w+, $/$arg0/;
513 my $report_args = '';
514 foreach my $i (0 .. $#args) {
515 if ($args[$i] =~ s/\.\.\.//) {
517 if ($args[$i] eq '' && $i == $#args) {
518 $report_args .= ", ...";
523 if ($only_C_inlist{$args[$i]}) {
524 push @args_num, undef;
526 push @args_num, ++$num_args;
527 $report_args .= ", $args[$i]";
529 if ($args[$i] =~ /^([^=]*[^\s=])\s*=\s*(.*)/s) {
532 $defaults{$args[$i]} = $2;
533 $defaults{$args[$i]} =~ s/"/\\"/g;
535 $proto_arg[$i+1] = '$' ;
537 $min_args = $num_args - $extra_args;
538 $report_args =~ s/"/\\"/g;
539 $report_args =~ s/^,\s+//;
540 my @func_args = @args;
541 shift @func_args if defined($class);
544 s/^/&/ if $in_out{$_};
546 $func_args = join(", ", @func_args);
547 @args_match{@args} = @args_num;
549 $PPCODE = grep(/^\s*PPCODE\s*:/, @line);
550 $CODE = grep(/^\s*CODE\s*:/, @line);
551 # Detect CODE: blocks which use ST(n)= or XST_m*(n,v)
552 # to set explicit return values.
553 $EXPLICIT_RETURN = ($CODE &&
554 ("@line" =~ /(\bST\s*\([^;]*=) | (\bXST_m\w+\s*\()/x ));
555 $ALIAS = grep(/^\s*ALIAS\s*:/, @line);
556 $INTERFACE = grep(/^\s*INTERFACE\s*:/, @line);
558 $xsreturn = 1 if $EXPLICIT_RETURN;
560 $externC = $externC ? qq[extern "C"] : "";
562 # print function header
565 #XS(XS_${Full_func_name}); /* prototype to pass -Wmissing-prototypes */
566 #XS(XS_${Full_func_name})
570 print Q(<<"EOF") if $ALIAS ;
573 print Q(<<"EOF") if $INTERFACE ;
574 # dXSFUNCTION($ret_type);
577 $cond = ($min_args ? qq(items < $min_args) : 0);
578 } elsif ($min_args == $num_args) {
579 $cond = qq(items != $min_args);
581 $cond = qq(items < $min_args || items > $num_args);
584 print Q(<<"EOF") if $except;
590 { print Q(<<"EOF") if $cond }
592 # Perl_croak(aTHX_ "Usage: %s($report_args)", GvNAME(CvGV(cv)));
595 { print Q(<<"EOF") if $cond }
597 # Perl_croak(aTHX_ "Usage: $pname($report_args)");
600 # cv doesn't seem to be used, in most cases unless we go in
601 # the if of this else
603 # PERL_UNUSED_VAR(cv); /* -W */
606 #gcc -Wall: if an xsub has PPCODE is used
607 #it is possible none of ST, XSRETURN or XSprePUSH macros are used
608 #hence `ax' (setup by dXSARGS) is unused
609 #XXX: could breakup the dXSARGS; into dSP;dMARK;dITEMS
610 #but such a move could break third-party extensions
611 print Q(<<"EOF") if $PPCODE;
612 # PERL_UNUSED_VAR(ax); /* -Wall */
615 print Q(<<"EOF") if $PPCODE;
619 # Now do a block of some sort.
622 $cond = ''; # last CASE: condidional
623 push(@line, "$END:");
624 push(@line_no, $line_no[-1]);
628 &CASE_handler if check_keyword("CASE");
633 # do initialization of input variables
641 process_keyword("INPUT|PREINIT|INTERFACE_MACRO|C_ARGS|ALIAS|ATTRS|PROTOTYPE|SCOPE|OVERLOAD") ;
643 print Q(<<"EOF") if $ScopeThisXSUB;
648 if (!$thisdone && defined($class)) {
649 if (defined($static) or $func_name eq 'new') {
651 $var_types{"CLASS"} = "char *";
652 &generate_init("char *", 1, "CLASS");
656 $var_types{"THIS"} = "$class *";
657 &generate_init("$class *", 1, "THIS");
662 if (/^\s*NOT_IMPLEMENTED_YET/) {
663 print "\n\tPerl_croak(aTHX_ \"$pname: not implemented yet\");\n";
666 if ($ret_type ne "void") {
667 print "\t" . &map_type($ret_type, 'RETVAL') . ";\n"
669 $args_match{"RETVAL"} = 0;
670 $var_types{"RETVAL"} = $ret_type;
672 if $WantOptimize and $targetable{$type_kind{$ret_type}};
675 if (@fake_INPUT or @fake_INPUT_pre) {
676 unshift @line, @fake_INPUT_pre, @fake_INPUT, $_;
678 $processing_arg_with_types = 1;
683 process_keyword("INIT|ALIAS|ATTRS|PROTOTYPE|INTERFACE_MACRO|INTERFACE|C_ARGS|OVERLOAD") ;
685 if (check_keyword("PPCODE")) {
687 death ("PPCODE must be last thing") if @line;
688 print "\tLEAVE;\n" if $ScopeThisXSUB;
689 print "\tPUTBACK;\n\treturn;\n";
690 } elsif (check_keyword("CODE")) {
692 } elsif (defined($class) and $func_name eq "DESTROY") {
694 print "delete THIS;\n";
697 if ($ret_type ne "void") {
701 if (defined($static)) {
702 if ($func_name eq 'new') {
703 $func_name = "$class";
707 } elsif (defined($class)) {
708 if ($func_name eq 'new') {
709 $func_name .= " $class";
714 $func_name =~ s/^\Q$args{'s'}//
715 if exists $args{'s'};
716 $func_name = 'XSFUNCTION' if $interface;
717 print "$func_name($func_args);\n";
721 # do output variables
722 $gotRETVAL = 0; # 1 if RETVAL seen in OUTPUT section;
723 undef $RETVAL_code ; # code to set RETVAL (from OUTPUT section);
724 # $wantRETVAL set if 'RETVAL =' autogenerated
725 ($wantRETVAL, $ret_type) = (0, 'void') if $RETVAL_no_return;
727 process_keyword("POSTCALL|OUTPUT|ALIAS|ATTRS|PROTOTYPE|OVERLOAD");
729 &generate_output($var_types{$_}, $args_match{$_}, $_, $DoSetMagic)
730 for grep $in_out{$_} =~ /OUT$/, keys %in_out;
732 # all OUTPUT done, so now push the return value on the stack
733 if ($gotRETVAL && $RETVAL_code) {
734 print "\t$RETVAL_code\n";
735 } elsif ($gotRETVAL || $wantRETVAL) {
736 my $t = $WantOptimize && $targetable{$type_kind{$ret_type}};
738 my $type = $ret_type;
740 # 0: type, 1: with_size, 2: how, 3: how_size
741 if ($t and not $t->[1] and $t->[0] eq 'p') {
742 # PUSHp corresponds to setpvn. Treate setpv directly
743 my $what = eval qq("$t->[2]");
746 print "\tsv_setpv(TARG, $what); XSprePUSH; PUSHTARG;\n";
750 my $what = eval qq("$t->[2]");
754 $size = '' unless defined $size;
755 $size = eval qq("$size");
757 print "\tXSprePUSH; PUSH$t->[0]($what$size);\n";
761 # RETVAL almost never needs SvSETMAGIC()
762 &generate_output($ret_type, 0, 'RETVAL', 0);
766 $xsreturn = 1 if $ret_type ne "void";
769 print "\tXSprePUSH;" if $c and not $prepush_done;
770 print "\tEXTEND(SP,$c);\n" if $c;
772 generate_output($var_types{$_}, $num++, $_, 0, 1) for @outlist;
775 process_keyword("CLEANUP|ALIAS|ATTRS|PROTOTYPE|OVERLOAD") ;
777 print Q(<<"EOF") if $ScopeThisXSUB;
780 print Q(<<"EOF") if $ScopeThisXSUB and not $PPCODE;
784 # print function trailer
788 print Q(<<"EOF") if $except;
791 # sprintf(errbuf, "%s: %s\\tpropagated", Xname, Xreason);
794 if (check_keyword("CASE")) {
795 blurt ("Error: No `CASE:' at top of function")
797 $_ = "CASE: $_"; # Restore CASE: label
800 last if $_ eq "$END:";
801 death(/^$BLOCK_re/o ? "Misplaced `$1:'" : "Junk at end of function");
804 print Q(<<"EOF") if $except;
806 # Perl_croak(aTHX_ errbuf);
810 print Q(<<"EOF") unless $PPCODE;
811 # XSRETURN($xsreturn);
814 print Q(<<"EOF") unless $PPCODE;
824 my $newXS = "newXS" ;
827 # Build the prototype string for the xsub
828 if ($ProtoThisXSUB) {
829 $newXS = "newXSproto";
831 if ($ProtoThisXSUB eq 2) {
832 # User has specified empty prototype
834 elsif ($ProtoThisXSUB eq 1) {
836 if ($min_args < $num_args) {
838 $proto_arg[$min_args] .= ";" ;
840 push @proto_arg, "$s\@"
843 $proto = join ("", grep defined, @proto_arg);
846 # User has specified a prototype
847 $proto = $ProtoThisXSUB;
849 $proto = qq{, "$proto"};
853 $XsubAliases{$pname} = 0
854 unless defined $XsubAliases{$pname} ;
855 while ( ($name, $value) = each %XsubAliases) {
856 push(@InitFileCode, Q(<<"EOF"));
857 # cv = newXS(\"$name\", XS_$Full_func_name, file);
858 # XSANY.any_i32 = $value ;
860 push(@InitFileCode, Q(<<"EOF")) if $proto;
861 # sv_setpv((SV*)cv$proto) ;
865 elsif (@Attributes) {
866 push(@InitFileCode, Q(<<"EOF"));
867 # cv = newXS(\"$pname\", XS_$Full_func_name, file);
868 # apply_attrs_string("$Package", cv, "@Attributes", 0);
872 while ( ($name, $value) = each %Interfaces) {
873 $name = "$Package\::$name" unless $name =~ /::/;
874 push(@InitFileCode, Q(<<"EOF"));
875 # cv = newXS(\"$name\", XS_$Full_func_name, file);
876 # $interface_macro_set(cv,$value) ;
878 push(@InitFileCode, Q(<<"EOF")) if $proto;
879 # sv_setpv((SV*)cv$proto) ;
885 " ${newXS}(\"$pname\", XS_$Full_func_name, file$proto);\n");
889 if ($Overload) # make it findable with fetchmethod
892 #XS(XS_${Packid}_nil); /* prototype to pass -Wmissing-prototypes */
893 #XS(XS_${Packid}_nil)
899 unshift(@InitFileCode, <<"MAKE_FETCHMETHOD_WORK");
900 /* Making a sub named "${Package}::()" allows the package */
901 /* to be findable via fetchmethod(), and causes */
902 /* overload::Overloaded("${Package}") to return true. */
903 newXS("${Package}::()", XS_${Packid}_nil, file$proto);
904 MAKE_FETCHMETHOD_WORK
907 # print initialization routine
916 #XS(boot_$Module_cname); /* prototype to pass -Wmissing-prototypes */
917 #XS(boot_$Module_cname)
925 #-Wall: if there is no $Full_func_name there are no xsubs in this .xs
927 print Q(<<"EOF") if $Full_func_name;
928 # char* file = __FILE__;
934 # PERL_UNUSED_VAR(cv); /* -W */
935 # PERL_UNUSED_VAR(items); /* -W */
938 print Q(<<"EOF") if $WantVersionChk ;
939 # XS_VERSION_BOOTCHECK ;
943 print Q(<<"EOF") if defined $XsubAliases or defined $Interfaces ;
949 print Q(<<"EOF") if ($Overload);
950 # /* register the overloading (type 'A') magic */
951 # PL_amagic_generation++;
952 # /* The magic for overload gets a GV* via gv_fetchmeth as */
953 # /* mentioned above, and looks in the SV* slot of it for */
954 # /* the "fallback" status. */
956 # get_sv( "${Package}::()", TRUE ),
963 print Q(<<"EOF") if defined $XsubAliases or defined $Interfaces ;
969 print "\n /* Initialisation Section */\n\n" ;
972 print "\n /* End of Initialisation Section */\n\n" ;
981 warn("Please specify prototyping behavior for $filename (see perlxs manual)\n")
986 untie *PSEUDO_STDOUT if tied *PSEUDO_STDOUT;
991 sub errors { $errors }
993 sub standard_typemap_locations {
994 # Add all the default typemap locations to the search path
995 my @tm = qw(typemap);
997 my $updir = File::Spec->updir;
998 foreach my $dir (File::Spec->catdir(($updir) x 1), File::Spec->catdir(($updir) x 2),
999 File::Spec->catdir(($updir) x 3), File::Spec->catdir(($updir) x 4)) {
1001 unshift @tm, File::Spec->catfile($dir, 'typemap');
1002 unshift @tm, File::Spec->catfile($dir, lib => ExtUtils => 'typemap');
1004 foreach my $dir (@INC) {
1005 my $file = File::Spec->catfile($dir, ExtUtils => 'typemap');
1006 unshift @tm, $file if -e $file;
1013 $_[0] =~ s/^\s+|\s+$//go ;
1020 # rationalise any '*' by joining them into bunches and removing whitespace
1024 # change multiple whitespace into a single space
1027 # trim leading & trailing whitespace
1028 TrimWhitespace($_) ;
1033 # Input: ($_, @line) == unparsed input.
1034 # Output: ($_, @line) == (rest of line, following lines).
1035 # Return: the matched keyword if found, otherwise 0
1037 $_ = shift(@line) while !/\S/ && @line;
1038 s/^(\s*)($_[0])\s*:\s*(?:#.*)?/$1/s && $2;
1042 # the "do" is required for right semantics
1043 do { $_ = shift(@line) } while !/\S/ && @line;
1045 print("#line ", $line_no[@line_no - @line -1], " \"$filepathname\"\n")
1046 if $WantLineNumbers && !/^\s*#\s*line\b/ && !/^#if XSubPPtmp/;
1047 for (; defined($_) && !/^$BLOCK_re/o; $_ = shift(@line)) {
1050 print 'ExtUtils::ParseXS::CountLines'->end_marker, "\n" if $WantLineNumbers;
1056 while (!/\S/ && @line) {
1060 for (; defined($_) && !/^$BLOCK_re/o; $_ = shift(@line)) {
1067 sub process_keyword($)
1072 &{"${kwd}_handler"}()
1073 while $kwd = check_keyword($pattern) ;
1077 blurt ("Error: `CASE:' after unconditional `CASE:'")
1078 if $condnum && $cond eq '';
1080 TrimWhitespace($cond);
1081 print " ", ($condnum++ ? " else" : ""), ($cond ? " if ($cond)\n" : "\n");
1086 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
1087 last if /^\s*NOT_IMPLEMENTED_YET/;
1088 next unless /\S/; # skip blank lines
1090 TrimWhitespace($_) ;
1093 # remove trailing semicolon if no initialisation
1094 s/\s*;$//g unless /[=;+].*\S/ ;
1096 # Process the length(foo) declarations
1097 if (s/^([^=]*)\blength\(\s*(\w+)\s*\)\s*$/$1 XSauto_length_of_$2=NO_INIT/x) {
1098 print "\tSTRLEN\tSTRLEN_length_of_$2;\n";
1099 $lengthof{$2} = $name;
1100 # $islengthof{$name} = $1;
1101 $deferred .= "\n\tXSauto_length_of_$2 = STRLEN_length_of_$2;";
1104 # check for optional initialisation code
1106 $var_init = $1 if s/\s*([=;+].*)$//s ;
1107 $var_init =~ s/"/\\"/g;
1110 my ($var_type, $var_addr, $var_name) = /^(.*?[^&\s])\s*(\&?)\s*\b(\w+)$/s
1111 or blurt("Error: invalid argument declaration '$line'"), next;
1113 # Check for duplicate definitions
1114 blurt ("Error: duplicate definition of argument '$var_name' ignored"), next
1115 if $arg_list{$var_name}++
1116 or defined $argtype_seen{$var_name} and not $processing_arg_with_types;
1118 $thisdone |= $var_name eq "THIS";
1119 $retvaldone |= $var_name eq "RETVAL";
1120 $var_types{$var_name} = $var_type;
1121 # XXXX This check is a safeguard against the unfinished conversion of
1122 # generate_init(). When generate_init() is fixed,
1123 # one can use 2-args map_type() unconditionally.
1124 if ($var_type =~ / \( \s* \* \s* \) /x) {
1125 # Function pointers are not yet supported with &output_init!
1126 print "\t" . &map_type($var_type, $var_name);
1129 print "\t" . &map_type($var_type);
1132 $var_num = $args_match{$var_name};
1134 $proto_arg[$var_num] = ProtoString($var_type)
1136 $func_args =~ s/\b($var_name)\b/&$1/ if $var_addr;
1137 if ($var_init =~ /^[=;]\s*NO_INIT\s*;?\s*$/
1138 or $in_out{$var_name} and $in_out{$var_name} =~ /^OUT/
1139 and $var_init !~ /\S/) {
1140 if ($name_printed) {
1143 print "\t$var_name;\n";
1145 } elsif ($var_init =~ /\S/) {
1146 &output_init($var_type, $var_num, $var_name, $var_init, $name_printed);
1147 } elsif ($var_num) {
1148 # generate initialization code
1149 &generate_init($var_type, $var_num, $var_name, $name_printed);
1156 sub OUTPUT_handler {
1157 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
1159 if (/^\s*SETMAGIC\s*:\s*(ENABLE|DISABLE)\s*/) {
1160 $DoSetMagic = ($1 eq "ENABLE" ? 1 : 0);
1163 my ($outarg, $outcode) = /^\s*(\S+)\s*(.*?)\s*$/s ;
1164 blurt ("Error: duplicate OUTPUT argument '$outarg' ignored"), next
1165 if $outargs{$outarg} ++ ;
1166 if (!$gotRETVAL and $outarg eq 'RETVAL') {
1167 # deal with RETVAL last
1168 $RETVAL_code = $outcode ;
1172 blurt ("Error: OUTPUT $outarg not an argument"), next
1173 unless defined($args_match{$outarg});
1174 blurt("Error: No input definition for OUTPUT argument '$outarg' - ignored"), next
1175 unless defined $var_types{$outarg} ;
1176 $var_num = $args_match{$outarg};
1178 print "\t$outcode\n";
1179 print "\tSvSETMAGIC(ST(" , $var_num-1 , "));\n" if $DoSetMagic;
1181 &generate_output($var_types{$outarg}, $var_num, $outarg, $DoSetMagic);
1183 delete $in_out{$outarg} # No need to auto-OUTPUT
1184 if exists $in_out{$outarg} and $in_out{$outarg} =~ /OUT$/;
1188 sub C_ARGS_handler() {
1189 my $in = merge_section();
1191 TrimWhitespace($in);
1195 sub INTERFACE_MACRO_handler() {
1196 my $in = merge_section();
1198 TrimWhitespace($in);
1199 if ($in =~ /\s/) { # two
1200 ($interface_macro, $interface_macro_set) = split ' ', $in;
1202 $interface_macro = $in;
1203 $interface_macro_set = 'UNKNOWN_CVT'; # catch later
1205 $interface = 1; # local
1206 $Interfaces = 1; # global
1209 sub INTERFACE_handler() {
1210 my $in = merge_section();
1212 TrimWhitespace($in);
1214 foreach (split /[\s,]+/, $in) {
1215 $Interfaces{$_} = $_;
1218 # XSFUNCTION = $interface_macro($ret_type,cv,XSANY.any_dptr);
1220 $interface = 1; # local
1221 $Interfaces = 1; # global
1224 sub CLEANUP_handler() { print_section() }
1225 sub PREINIT_handler() { print_section() }
1226 sub POSTCALL_handler() { print_section() }
1227 sub INIT_handler() { print_section() }
1232 my ($orig) = $line ;
1236 # Parse alias definitions
1238 # alias = value alias = value ...
1240 while ($line =~ s/^\s*([\w:]+)\s*=\s*(\w+)\s*//) {
1242 $orig_alias = $alias ;
1245 # check for optional package definition in the alias
1246 $alias = $Packprefix . $alias if $alias !~ /::/ ;
1248 # check for duplicate alias name & duplicate value
1249 Warn("Warning: Ignoring duplicate alias '$orig_alias'")
1250 if defined $XsubAliases{$alias} ;
1252 Warn("Warning: Aliases '$orig_alias' and '$XsubAliasValues{$value}' have identical values")
1253 if $XsubAliasValues{$value} ;
1256 $XsubAliases{$alias} = $value ;
1257 $XsubAliasValues{$value} = $orig_alias ;
1260 blurt("Error: Cannot parse ALIAS definitions from '$orig'")
1264 sub ATTRS_handler ()
1266 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
1268 TrimWhitespace($_) ;
1269 push @Attributes, $_;
1273 sub ALIAS_handler ()
1275 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
1277 TrimWhitespace($_) ;
1278 GetAliases($_) if $_ ;
1282 sub OVERLOAD_handler()
1284 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
1286 TrimWhitespace($_) ;
1287 while ( s/^\s*([\w:"\\)\+\-\*\/\%\<\>\.\&\|\^\!\~\{\}\=]+)\s*//) {
1288 $Overload = 1 unless $Overload;
1289 my $overload = "$Package\::(".$1 ;
1291 " newXS(\"$overload\", XS_$Full_func_name, file$proto);\n");
1296 sub FALLBACK_handler()
1298 # the rest of the current line should contain either TRUE,
1301 TrimWhitespace($_) ;
1303 TRUE => "PL_sv_yes", 1 => "PL_sv_yes",
1304 FALSE => "PL_sv_no", 0 => "PL_sv_no",
1305 UNDEF => "PL_sv_undef",
1308 # check for valid FALLBACK value
1309 death ("Error: FALLBACK: TRUE/FALSE/UNDEF") unless exists $map{uc $_} ;
1311 $Fallback = $map{uc $_} ;
1315 sub REQUIRE_handler ()
1317 # the rest of the current line should contain a version number
1320 TrimWhitespace($Ver) ;
1322 death ("Error: REQUIRE expects a version number")
1325 # check that the version number is of the form n.n
1326 death ("Error: REQUIRE: expected a number, got '$Ver'")
1327 unless $Ver =~ /^\d+(\.\d*)?/ ;
1329 death ("Error: xsubpp $Ver (or better) required--this is only $VERSION.")
1330 unless $VERSION >= $Ver ;
1333 sub VERSIONCHECK_handler ()
1335 # the rest of the current line should contain either ENABLE or
1338 TrimWhitespace($_) ;
1340 # check for ENABLE/DISABLE
1341 death ("Error: VERSIONCHECK: ENABLE/DISABLE")
1342 unless /^(ENABLE|DISABLE)/i ;
1344 $WantVersionChk = 1 if $1 eq 'ENABLE' ;
1345 $WantVersionChk = 0 if $1 eq 'DISABLE' ;
1349 sub PROTOTYPE_handler ()
1353 death("Error: Only 1 PROTOTYPE definition allowed per xsub")
1354 if $proto_in_this_xsub ++ ;
1356 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
1359 TrimWhitespace($_) ;
1360 if ($_ eq 'DISABLE') {
1362 } elsif ($_ eq 'ENABLE') {
1365 # remove any whitespace
1367 death("Error: Invalid prototype '$_'")
1368 unless ValidProtoString($_) ;
1369 $ProtoThisXSUB = C_string($_) ;
1373 # If no prototype specified, then assume empty prototype ""
1374 $ProtoThisXSUB = 2 unless $specified ;
1380 sub SCOPE_handler ()
1382 death("Error: Only 1 SCOPE declaration allowed per xsub")
1383 if $scope_in_this_xsub ++ ;
1385 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
1387 TrimWhitespace($_) ;
1388 if ($_ =~ /^DISABLE/i) {
1390 } elsif ($_ =~ /^ENABLE/i) {
1397 sub PROTOTYPES_handler ()
1399 # the rest of the current line should contain either ENABLE or
1402 TrimWhitespace($_) ;
1404 # check for ENABLE/DISABLE
1405 death ("Error: PROTOTYPES: ENABLE/DISABLE")
1406 unless /^(ENABLE|DISABLE)/i ;
1408 $WantPrototypes = 1 if $1 eq 'ENABLE' ;
1409 $WantPrototypes = 0 if $1 eq 'DISABLE' ;
1414 sub INCLUDE_handler ()
1416 # the rest of the current line should contain a valid filename
1418 TrimWhitespace($_) ;
1420 death("INCLUDE: filename missing")
1423 death("INCLUDE: output pipe is illegal")
1426 # simple minded recursion detector
1427 death("INCLUDE loop detected")
1428 if $IncludedFiles{$_} ;
1430 ++ $IncludedFiles{$_} unless /\|\s*$/ ;
1432 # Save the current file context.
1435 LastLine => $lastline,
1436 LastLineNo => $lastline_no,
1438 LineNo => \@line_no,
1439 Filename => $filename,
1446 open ($FH, "$_") or death("Cannot open '$_': $!") ;
1450 #/* INCLUDE: Including '$_' from '$filename' */
1456 # Prime the pump by reading the first
1459 # skip leading blank lines
1461 last unless /^\s*$/ ;
1471 return 0 unless $XSStack[-1]{type} eq 'file' ;
1473 my $data = pop @XSStack ;
1474 my $ThisFile = $filename ;
1475 my $isPipe = ($filename =~ /\|\s*$/) ;
1477 -- $IncludedFiles{$filename}
1482 $FH = $data->{Handle} ;
1483 $filename = $data->{Filename} ;
1484 $lastline = $data->{LastLine} ;
1485 $lastline_no = $data->{LastLineNo} ;
1486 @line = @{ $data->{Line} } ;
1487 @line_no = @{ $data->{LineNo} } ;
1489 if ($isPipe and $? ) {
1491 print STDERR "Error reading from pipe '$ThisFile': $! in $filename, line $lastline_no\n" ;
1497 #/* INCLUDE: Returning to '$filename' from '$ThisFile' */
1504 sub ValidProtoString ($)
1508 if ( $string =~ /^$proto_re+$/ ) {
1519 $string =~ s[\\][\\\\]g ;
1527 $proto_letter{$type} or "\$" ;
1531 my @cpp = grep(/^\#\s*(?:if|e\w+)/, @line);
1533 my ($cpp, $cpplevel);
1535 if ($cpp =~ /^\#\s*if/) {
1537 } elsif (!$cpplevel) {
1538 Warn("Warning: #else/elif/endif without #if in this function");
1539 print STDERR " (precede it with a blank line if the matching #if is outside the function)\n"
1540 if $XSStack[-1]{type} eq 'if';
1542 } elsif ($cpp =~ /^\#\s*endif/) {
1546 Warn("Warning: #if without #endif in this function") if $cpplevel;
1554 $text =~ s/\[\[/{/g;
1555 $text =~ s/\]\]/}/g;
1559 # Read next xsub into @line from ($lastline, <$FH>).
1562 death ("Error: Unterminated `#if/#ifdef/#ifndef'")
1563 if !defined $lastline && $XSStack[-1]{type} eq 'if';
1566 return PopFile() if !defined $lastline;
1569 /^MODULE\s*=\s*([\w:]+)(?:\s+PACKAGE\s*=\s*([\w:]+))?(?:\s+PREFIX\s*=\s*(\S+))?\s*$/) {
1571 $Package = defined($2) ? $2 : ''; # keep -w happy
1572 $Prefix = defined($3) ? $3 : ''; # keep -w happy
1573 $Prefix = quotemeta $Prefix ;
1574 ($Module_cname = $Module) =~ s/\W/_/g;
1575 ($Packid = $Package) =~ tr/:/_/;
1576 $Packprefix = $Package;
1577 $Packprefix .= "::" if $Packprefix ne "";
1582 # Skip embedded PODs
1583 while ($lastline =~ /^=/) {
1584 while ($lastline = <$FH>) {
1585 last if ($lastline =~ /^=cut\s*$/);
1587 death ("Error: Unterminated pod") unless $lastline;
1590 $lastline =~ s/^\s+$//;
1592 if ($lastline !~ /^\s*#/ ||
1594 # ANSI: if ifdef ifndef elif else endif define undef
1596 # gcc: warning include_next
1598 # others: ident (gcc notes that some cpps have this one)
1599 $lastline =~ /^#[ \t]*(?:(?:if|ifn?def|elif|else|endif|define|undef|pragma|error|warning|line\s+\d+|ident)\b|(?:include(?:_next)?|import)\s*["<].*[>"])/) {
1600 last if $lastline =~ /^\S/ && @line && $line[-1] eq "";
1601 push(@line, $lastline);
1602 push(@line_no, $lastline_no) ;
1605 # Read next line and continuation lines
1606 last unless defined($lastline = <$FH>);
1609 $lastline .= $tmp_line
1610 while ($lastline =~ /\\$/ && defined($tmp_line = <$FH>));
1613 $lastline =~ s/^\s+$//;
1615 pop(@line), pop(@line_no) while @line && $line[-1] eq "";
1620 local($type, $num, $var, $init, $name_printed) = @_;
1621 local($arg) = "ST(" . ($num - 1) . ")";
1623 if ( $init =~ /^=/ ) {
1624 if ($name_printed) {
1625 eval qq/print " $init\\n"/;
1627 eval qq/print "\\t$var $init\\n"/;
1631 if ( $init =~ s/^\+// && $num ) {
1632 &generate_init($type, $num, $var, $name_printed);
1633 } elsif ($name_printed) {
1637 eval qq/print "\\t$var;\\n"/;
1641 $deferred .= eval qq/"\\n\\t$init\\n"/;
1648 # work out the line number
1649 my $line_no = $line_no[@line_no - @line -1] ;
1651 print STDERR "@_ in $filename, line $line_no\n" ;
1667 local($type, $num, $var) = @_;
1668 local($arg) = "ST(" . ($num - 1) . ")";
1669 local($argoff) = $num - 1;
1673 $type = TidyType($type) ;
1674 blurt("Error: '$type' not in typemap"), return
1675 unless defined($type_kind{$type});
1677 ($ntype = $type) =~ s/\s*\*/Ptr/g;
1678 ($subtype = $ntype) =~ s/(?:Array)?(?:Ptr)?$//;
1679 $tk = $type_kind{$type};
1680 $tk =~ s/OBJ$/REF/ if $func_name =~ /DESTROY$/;
1681 if ($tk eq 'T_PV' and exists $lengthof{$var}) {
1682 print "\t$var" unless $name_printed;
1683 print " = ($type)SvPV($arg, STRLEN_length_of_$var);\n";
1684 die "default value not supported with length(NAME) supplied"
1685 if defined $defaults{$var};
1688 $type =~ tr/:/_/ unless $hiertype;
1689 blurt("Error: No INPUT definition for type '$type', typekind '$type_kind{$type}' found"), return
1690 unless defined $input_expr{$tk} ;
1691 $expr = $input_expr{$tk};
1692 if ($expr =~ /DO_ARRAY_ELEM/) {
1693 blurt("Error: '$subtype' not in typemap"), return
1694 unless defined($type_kind{$subtype});
1695 blurt("Error: No INPUT definition for type '$subtype', typekind '$type_kind{$subtype}' found"), return
1696 unless defined $input_expr{$type_kind{$subtype}} ;
1697 $subexpr = $input_expr{$type_kind{$subtype}};
1698 $subexpr =~ s/\$type/\$subtype/g;
1699 $subexpr =~ s/ntype/subtype/g;
1700 $subexpr =~ s/\$arg/ST(ix_$var)/g;
1701 $subexpr =~ s/\n\t/\n\t\t/g;
1702 $subexpr =~ s/is not of (.*\")/[arg %d] is not of $1, ix_$var + 1/g;
1703 $subexpr =~ s/\$var/${var}[ix_$var - $argoff]/;
1704 $expr =~ s/DO_ARRAY_ELEM/$subexpr/;
1706 if ($expr =~ m#/\*.*scope.*\*/#i) { # "scope" in C comments
1709 if (defined($defaults{$var})) {
1710 $expr =~ s/(\t+)/$1 /g;
1712 if ($name_printed) {
1715 eval qq/print "\\t$var;\\n"/;
1718 if ($defaults{$var} eq 'NO_INIT') {
1719 $deferred .= eval qq/"\\n\\tif (items >= $num) {\\n$expr;\\n\\t}\\n"/;
1721 $deferred .= eval qq/"\\n\\tif (items < $num)\\n\\t $var = $defaults{$var};\\n\\telse {\\n$expr;\\n\\t}\\n"/;
1724 } elsif ($ScopeThisXSUB or $expr !~ /^\s*\$var =/) {
1725 if ($name_printed) {
1728 eval qq/print "\\t$var;\\n"/;
1731 $deferred .= eval qq/"\\n$expr;\\n"/;
1734 die "panic: do not know how to handle this branch for function pointers"
1736 eval qq/print "$expr;\\n"/;
1741 sub generate_output {
1742 local($type, $num, $var, $do_setmagic, $do_push) = @_;
1743 local($arg) = "ST(" . ($num - ($num != 0)) . ")";
1744 local($argoff) = $num - 1;
1747 $type = TidyType($type) ;
1748 if ($type =~ /^array\(([^,]*),(.*)\)/) {
1749 print "\t$arg = sv_newmortal();\n";
1750 print "\tsv_setpvn($arg, (char *)$var, $2 * sizeof($1));\n";
1751 print "\tSvSETMAGIC($arg);\n" if $do_setmagic;
1753 blurt("Error: '$type' not in typemap"), return
1754 unless defined($type_kind{$type});
1755 blurt("Error: No OUTPUT definition for type '$type', typekind '$type_kind{$type}' found"), return
1756 unless defined $output_expr{$type_kind{$type}} ;
1757 ($ntype = $type) =~ s/\s*\*/Ptr/g;
1758 $ntype =~ s/\(\)//g;
1759 ($subtype = $ntype) =~ s/(?:Array)?(?:Ptr)?$//;
1760 $expr = $output_expr{$type_kind{$type}};
1761 if ($expr =~ /DO_ARRAY_ELEM/) {
1762 blurt("Error: '$subtype' not in typemap"), return
1763 unless defined($type_kind{$subtype});
1764 blurt("Error: No OUTPUT definition for type '$subtype', typekind '$type_kind{$subtype}' found"), return
1765 unless defined $output_expr{$type_kind{$subtype}} ;
1766 $subexpr = $output_expr{$type_kind{$subtype}};
1767 $subexpr =~ s/ntype/subtype/g;
1768 $subexpr =~ s/\$arg/ST(ix_$var)/g;
1769 $subexpr =~ s/\$var/${var}[ix_$var]/g;
1770 $subexpr =~ s/\n\t/\n\t\t/g;
1771 $expr =~ s/DO_ARRAY_ELEM\n/$subexpr/;
1772 eval "print qq\a$expr\a";
1774 print "\t\tSvSETMAGIC(ST(ix_$var));\n" if $do_setmagic;
1775 } elsif ($var eq 'RETVAL') {
1776 if ($expr =~ /^\t\$arg = new/) {
1777 # We expect that $arg has refcnt 1, so we need to
1779 eval "print qq\a$expr\a";
1781 print "\tsv_2mortal(ST($num));\n";
1782 print "\tSvSETMAGIC(ST($num));\n" if $do_setmagic;
1783 } elsif ($expr =~ /^\s*\$arg\s*=/) {
1784 # We expect that $arg has refcnt >=1, so we need
1786 eval "print qq\a$expr\a";
1788 print "\tsv_2mortal(ST(0));\n";
1789 print "\tSvSETMAGIC(ST(0));\n" if $do_setmagic;
1791 # Just hope that the entry would safely write it
1792 # over an already mortalized value. By
1793 # coincidence, something like $arg = &sv_undef
1795 print "\tST(0) = sv_newmortal();\n";
1796 eval "print qq\a$expr\a";
1798 # new mortals don't have set magic
1800 } elsif ($do_push) {
1801 print "\tPUSHs(sv_newmortal());\n";
1803 eval "print qq\a$expr\a";
1805 print "\tSvSETMAGIC($arg);\n" if $do_setmagic;
1806 } elsif ($arg =~ /^ST\(\d+\)$/) {
1807 eval "print qq\a$expr\a";
1809 print "\tSvSETMAGIC($arg);\n" if $do_setmagic;
1815 my($type, $varname) = @_;
1817 # C++ has :: in types too so skip this
1818 $type =~ tr/:/_/ unless $hiertype;
1819 $type =~ s/^array\(([^,]*),(.*)\).*/$1 */s;
1821 if ($varname && $type =~ / \( \s* \* (?= \s* \) ) /xg) {
1822 (substr $type, pos $type, 0) = " $varname ";
1824 $type .= "\t$varname";
1831 #########################################################
1833 ExtUtils::ParseXS::CountLines;
1835 use vars qw($SECTION_END_MARKER);
1838 my ($class, $cfile, $fh) = @_;
1839 $cfile =~ s/\\/\\\\/g;
1840 $SECTION_END_MARKER = qq{#line --- "$cfile"};
1842 return bless {buffer => '',
1851 $self->{buffer} .= $_;
1852 while ($self->{buffer} =~ s/^([^\n]*\n)//) {
1854 ++ $self->{line_no};
1855 $line =~ s|^\#line\s+---(?=\s)|#line $self->{line_no}|;
1856 print {$self->{fh}} $line;
1864 $self->PRINT(sprintf($fmt, @_));
1868 # Not necessary if we're careful to end with a "\n"
1870 print {$self->{fh}} $self->{buffer};
1874 # This sub does nothing, but is neccessary for references to be released.
1878 return $SECTION_END_MARKER;
1887 ExtUtils::ParseXS - converts Perl XS code into C code
1891 use ExtUtils::ParseXS qw(process_file);
1893 process_file( filename => 'foo.xs' );
1895 process_file( filename => 'foo.xs',
1898 typemap => 'path/to/typemap',
1909 C<ExtUtils::ParseXS> will compile XS code into C code by embedding the constructs
1910 necessary to let C functions manipulate Perl values and creates the glue
1911 necessary to let Perl access those functions. The compiler uses typemaps to
1912 determine how to map C function parameters and variables to Perl values.
1914 The compiler will search for typemap files called I<typemap>. It will use
1915 the following search path to find default typemaps, with the rightmost
1916 typemap taking precedence.
1918 ../../../typemap:../../typemap:../typemap:typemap
1922 None by default. C<process_file()> may be exported upon request.
1931 This function processes an XS file and sends output to a C file.
1932 Named parameters control how the processing is done. The following
1933 parameters are accepted:
1939 Adds C<extern "C"> to the C code. Default is false.
1943 Retains C<::> in type names so that C++ hierachical types can be
1944 mapped. Default is false.
1948 Adds exception handling stubs to the C code. Default is false.
1952 Indicates that a user-supplied typemap should take precedence over the
1953 default typemaps. A single typemap may be specified as a string, or
1954 multiple typemaps can be specified in an array reference, with the
1955 last typemap having the highest precedence.
1959 Generates prototype code for all xsubs. Default is false.
1961 =item B<versioncheck>
1963 Makes sure at run time that the object file (derived from the C<.xs>
1964 file) and the C<.pm> files have the same version number. Default is
1967 =item B<linenumbers>
1969 Adds C<#line> directives to the C output so error messages will look
1970 like they came from the original XS file. Default is true.
1974 Enables certain optimizations. The only optimization that is currently
1975 affected is the use of I<target>s by the output C code (see L<perlguts>).
1976 Not optimizing may significantly slow down the generated code, but this is the way
1977 B<xsubpp> of 5.005 and earlier operated. Default is to optimize.
1981 Enable recognition of C<IN>, C<OUT_LIST> and C<INOUT_LIST>
1982 declarations. Default is true.
1986 Enable recognition of ANSI-like descriptions of function signature.
1991 I have no clue what this does. Strips function prefixes?
1997 This function returns the number of [a certain kind of] errors
1998 encountered during processing of the XS file.
2004 Based on xsubpp code, written by Larry Wall.
2006 Maintained by Ken Williams, <ken@mathforum.org>
2010 Copyright 2002-2003 Ken Williams. All rights reserved.
2012 This library is free software; you can redistribute it and/or
2013 modify it under the same terms as Perl itself.
2015 Based on the ExtUtils::xsubpp code by Larry Wall and the Perl 5
2016 Porters, which was released under the same license terms.
2020 L<perl>, ExtUtils::xsubpp, ExtUtils::MakeMaker, L<perlxs>, L<perlxstut>.