5 xsubpp - compiler to convert Perl XS code into C code
9 B<xsubpp> [B<-v>] [B<-C++>] [B<-except>] [B<-s pattern>] [B<-prototypes>] [B<-noversioncheck>] [B<-typemap typemap>]... file.xs
13 I<xsubpp> will compile XS code into C code by embedding the constructs
14 necessary to let C functions manipulate Perl values and creates the glue
15 necessary to let Perl access those functions. The compiler uses typemaps to
16 determine how to map C function parameters and variables to Perl values.
18 The compiler will search for typemap files called I<typemap>. It will use
19 the following search path to find default typemaps, with the rightmost
20 typemap taking precedence.
22 ../../../typemap:../../typemap:../typemap:typemap
30 Adds ``extern "C"'' to the C code.
35 Adds exception handling stubs to the C code.
37 =item B<-typemap typemap>
39 Indicates that a user-supplied typemap should take precedence over the
40 default typemaps. This option may be used multiple times, with the last
41 typemap having the highest precedence.
45 Prints the I<xsubpp> version number to standard output, then exits.
49 By default I<xsubpp> will not automatically generate prototype code for
50 all xsubs. This flag will enable prototypes.
52 =item B<-noversioncheck>
54 Disables the run time test that determines if the object file (derived
55 from the C<.xs> file) and the C<.pm> files have the same version
62 No environment variables are used.
68 =head1 MODIFICATION HISTORY
70 See the file F<changes.pod>.
74 perl(1), perlxs(1), perlxstut(1), perlxs(1)
80 use vars '$cplusplus';
83 $XSUBPP_version = "1.94001";
84 $Is_VMS = $^O eq 'VMS';
90 $usage = "Usage: xsubpp [-v] [-C++] [-except] [-prototypes] [-noversioncheck] [-s pattern] [-typemap typemap]... file.xs\n";
92 $proto_re = "[" . quotemeta('\$%&*@;') . "]" ;
95 $WantPrototypes = -1 ;
98 SWITCH: while (@ARGV and $ARGV[0] =~ /^-./) {
101 $spat = quotemeta shift, next SWITCH if $flag eq 's';
102 $cplusplus = 1, next SWITCH if $flag eq 'C++';
103 $WantPrototypes = 0, next SWITCH if $flag eq 'noprototypes';
104 $WantPrototypes = 1, next SWITCH if $flag eq 'prototypes';
105 $WantVersionChk = 0, next SWITCH if $flag eq 'noversioncheck';
106 $WantVersionChk = 1, next SWITCH if $flag eq 'versioncheck';
107 $except = " TRY", next SWITCH if $flag eq 'except';
108 push(@tm,shift), next SWITCH if $flag eq 'typemap';
109 (print "xsubpp version $XSUBPP_version\n"), exit
113 if ($WantPrototypes == -1)
114 { $WantPrototypes = 0}
119 @ARGV == 1 or die $usage;
120 ($dir, $filename) = $ARGV[0] =~ m#(.*)/(.*)#
121 or ($dir, $filename) = $ARGV[0] =~ m#(.*[>\]])(.*)#
122 or ($dir, $filename) = ('.', $ARGV[0]);
126 ++ $IncludedFiles{$ARGV[0]} ;
128 my(@XSStack) = ({type => 'none'}); # Stack of conditionals and INCLUDEs
129 my($XSS_work_idx, $cpp_next_tmp) = (0, "XSubPPtmpAAAA");
133 $_[0] =~ s/^\s+|\s+$//go ;
140 # rationalise any '*' by joining them into bunches and removing whitespace
144 # change multiple whitespace into a single space
147 # trim leading & trailing whitespace
153 $typemap = shift @ARGV;
154 foreach $typemap (@tm) {
155 die "Can't find $typemap in $pwd\n" unless -r $typemap;
157 unshift @tm, qw(../../../../lib/ExtUtils/typemap ../../../lib/ExtUtils/typemap
158 ../../lib/ExtUtils/typemap ../../../typemap ../../typemap
160 foreach $typemap (@tm) {
161 next unless -e $typemap ;
162 # skip directories, binary files etc.
163 warn("Warning: ignoring non-text typemap file '$typemap'\n"), next
165 open(TYPEMAP, $typemap)
166 or warn ("Warning: could not open typemap file '$typemap': $!\n"), next;
172 my $line_no = $. + 1;
173 if (/^INPUT\s*$/) { $mode = 'Input'; $current = \$junk; next; }
174 if (/^OUTPUT\s*$/) { $mode = 'Output'; $current = \$junk; next; }
175 if (/^TYPEMAP\s*$/) { $mode = 'Typemap'; $current = \$junk; next; }
176 if ($mode eq 'Typemap') {
180 # skip blank lines and comment lines
181 next if /^$/ or /^#/ ;
182 my($type,$kind, $proto) = /^\s*(.*?\S)\s+(\S+)\s*($proto_re*)\s*$/ or
183 warn("Warning: File '$typemap' Line $. '$line' TYPEMAP entry needs 2 or 3 columns\n"), next;
184 $type = TidyType($type) ;
185 $type_kind{$type} = $kind ;
186 # prototype defaults to '$'
187 $proto = "\$" unless $proto ;
188 warn("Warning: File '$typemap' Line $. '$line' Invalid prototype '$proto'\n")
189 unless ValidProtoString($proto) ;
190 $proto_letter{$type} = C_string($proto) ;
195 elsif ($mode eq 'Input') {
197 $input_expr{$_} = '';
198 $current = \$input_expr{$_};
202 $output_expr{$_} = '';
203 $current = \$output_expr{$_};
209 foreach $key (keys %input_expr) {
210 $input_expr{$key} =~ s/\n+$//;
213 $END = "!End!\n\n"; # "impossible" keyword (multiple newline)
215 # Match an XS keyword
216 $BLOCK_re= '\s*(' . join('|', qw(
217 REQUIRE BOOT CASE PREINIT INPUT INIT CODE PPCODE OUTPUT
218 CLEANUP ALIAS PROTOTYPES PROTOTYPE VERSIONCHECK INCLUDE
222 # Input: ($_, @line) == unparsed input.
223 # Output: ($_, @line) == (rest of line, following lines).
224 # Return: the matched keyword if found, otherwise 0
226 $_ = shift(@line) while !/\S/ && @line;
227 s/^(\s*)($_[0])\s*:\s*(?:#.*)?/$1/s && $2;
233 $_ = shift(@line) while !/\S/ && @line;
234 for (; defined($_) && !/^$BLOCK_re/o; $_ = shift(@line)) {
235 print line_directive() unless ($count++);
240 sub process_keyword($)
245 &{"${kwd}_handler"}()
246 while $kwd = check_keyword($pattern) ;
247 print line_directive();
251 blurt ("Error: `CASE:' after unconditional `CASE:'")
252 if $condnum && $cond eq '';
254 TrimWhitespace($cond);
255 print " ", ($condnum++ ? " else" : ""), ($cond ? " if ($cond)\n" : "\n");
260 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
261 last if /^\s*NOT_IMPLEMENTED_YET/;
262 next unless /\S/; # skip blank lines
267 # remove trailing semicolon if no initialisation
268 s/\s*;$//g unless /=/ ;
270 # check for optional initialisation code
272 $var_init = $1 if s/\s*(=.*)$//s ;
273 $var_init =~ s/"/\\"/g;
276 my ($var_type, $var_addr, $var_name) = /^(.*?[^& ]) *(\&?) *\b(\w+)$/s
277 or blurt("Error: invalid argument declaration '$line'"), next;
279 # Check for duplicate definitions
280 blurt ("Error: duplicate definition of argument '$var_name' ignored"), next
281 if $arg_list{$var_name} ++ ;
283 $thisdone |= $var_name eq "THIS";
284 $retvaldone |= $var_name eq "RETVAL";
285 $var_types{$var_name} = $var_type;
286 print "\t" . &map_type($var_type);
287 $var_num = $args_match{$var_name};
289 $proto_arg[$var_num] = ProtoString($var_type)
292 $var_addr{$var_name} = 1;
293 $func_args =~ s/\b($var_name)\b/&$1/;
295 if ($var_init =~ /^=\s*NO_INIT\s*;?\s*$/) {
296 print "\t$var_name;\n";
297 } elsif ($var_init =~ /\S/) {
298 &output_init($var_type, $var_num, "$var_name $var_init");
300 # generate initialization code
301 &generate_init($var_type, $var_num, $var_name);
309 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
311 my ($outarg, $outcode) = /^\s*(\S+)\s*(.*?)\s*$/s ;
312 blurt ("Error: duplicate OUTPUT argument '$outarg' ignored"), next
313 if $outargs{$outarg} ++ ;
314 if (!$gotRETVAL and $outarg eq 'RETVAL') {
315 # deal with RETVAL last
316 $RETVAL_code = $outcode ;
320 blurt ("Error: OUTPUT $outarg not an argument"), next
321 unless defined($args_match{$outarg});
322 blurt("Error: No input definition for OUTPUT argument '$outarg' - ignored"), next
323 unless defined $var_types{$outarg} ;
324 print line_directive();
326 print "\t$outcode\n";
328 $var_num = $args_match{$outarg};
329 &generate_output($var_types{$outarg}, $var_num, $outarg);
334 sub CLEANUP_handler() { print_section() }
335 sub PREINIT_handler() { print_section() }
336 sub INIT_handler() { print_section() }
345 # Parse alias definitions
347 # alias = value alias = value ...
349 while ($line =~ s/^\s*([\w:]+)\s*=\s*(\w+)\s*//) {
351 $orig_alias = $alias ;
354 # check for optional package definition in the alias
355 $alias = $Packprefix . $alias if $alias !~ /::/ ;
357 # check for duplicate alias name & duplicate value
358 Warn("Warning: Ignoring duplicate alias '$orig_alias'")
359 if defined $XsubAliases{$alias} ;
361 Warn("Warning: Aliases '$orig_alias' and '$XsubAliasValues{$value}' have identical values")
362 if $XsubAliasValues{$value} ;
365 $XsubAliases{$alias} = $value ;
366 $XsubAliasValues{$value} = $orig_alias ;
369 blurt("Error: Cannot parse ALIAS definitions from '$orig'")
375 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
378 GetAliases($_) if $_ ;
382 sub REQUIRE_handler ()
384 # the rest of the current line should contain a version number
387 TrimWhitespace($Ver) ;
389 death ("Error: REQUIRE expects a version number")
392 # check that the version number is of the form n.n
393 death ("Error: REQUIRE: expected a number, got '$Ver'")
394 unless $Ver =~ /^\d+(\.\d*)?/ ;
396 death ("Error: xsubpp $Ver (or better) required--this is only $XSUBPP_version.")
397 unless $XSUBPP_version >= $Ver ;
400 sub VERSIONCHECK_handler ()
402 # the rest of the current line should contain either ENABLE or
407 # check for ENABLE/DISABLE
408 death ("Error: VERSIONCHECK: ENABLE/DISABLE")
409 unless /^(ENABLE|DISABLE)/i ;
411 $WantVersionChk = 1 if $1 eq 'ENABLE' ;
412 $WantVersionChk = 0 if $1 eq 'DISABLE' ;
416 sub PROTOTYPE_handler ()
420 death("Error: Only 1 PROTOTYPE definition allowed per xsub")
421 if $proto_in_this_xsub ++ ;
423 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
427 if ($_ eq 'DISABLE') {
430 elsif ($_ eq 'ENABLE') {
434 # remove any whitespace
436 death("Error: Invalid prototype '$_'")
437 unless ValidProtoString($_) ;
438 $ProtoThisXSUB = C_string($_) ;
442 # If no prototype specified, then assume empty prototype ""
443 $ProtoThisXSUB = 2 unless $specified ;
451 death("Error: Only 1 SCOPE declaration allowed per xsub")
452 if $scope_in_this_xsub ++ ;
454 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
457 if ($_ =~ /^DISABLE/i) {
460 elsif ($_ =~ /^ENABLE/i) {
467 sub PROTOTYPES_handler ()
469 # the rest of the current line should contain either ENABLE or
474 # check for ENABLE/DISABLE
475 death ("Error: PROTOTYPES: ENABLE/DISABLE")
476 unless /^(ENABLE|DISABLE)/i ;
478 $WantPrototypes = 1 if $1 eq 'ENABLE' ;
479 $WantPrototypes = 0 if $1 eq 'DISABLE' ;
484 sub INCLUDE_handler ()
486 # the rest of the current line should contain a valid filename
490 death("INCLUDE: filename missing")
493 death("INCLUDE: output pipe is illegal")
496 # simple minded recursion detector
497 death("INCLUDE loop detected")
498 if $IncludedFiles{$_} ;
500 ++ $IncludedFiles{$_} unless /\|\s*$/ ;
502 # Save the current file context.
505 LastLine => $lastline,
506 LastLineNo => $lastline_no,
509 Filename => $filename,
516 open ($FH, "$_") or death("Cannot open '$_': $!") ;
520 #/* INCLUDE: Including '$_' from '$filename' */
526 # Prime the pump by reading the first
529 # skip leading blank lines
531 last unless /^\s*$/ ;
541 return 0 unless $XSStack[-1]{type} eq 'file' ;
543 my $data = pop @XSStack ;
544 my $ThisFile = $filename ;
545 my $isPipe = ($filename =~ /\|\s*$/) ;
547 -- $IncludedFiles{$filename}
552 $FH = $data->{Handle} ;
553 $filename = $data->{Filename} ;
554 $lastline = $data->{LastLine} ;
555 $lastline_no = $data->{LastLineNo} ;
556 @line = @{ $data->{Line} } ;
557 @line_no = @{ $data->{LineNo} } ;
559 if ($isPipe and $? ) {
561 print STDERR "Error reading from pipe '$ThisFile': $! in $filename, line $lastline_no\n" ;
567 #/* INCLUDE: Returning to '$filename' from '$ThisFile' */
574 sub ValidProtoString ($)
578 if ( $string =~ /^$proto_re+$/ ) {
589 $string =~ s[\\][\\\\]g ;
597 $proto_letter{$type} or "\$" ;
601 my @cpp = grep(/^\#\s*(?:if|e\w+)/, @line);
603 my ($cpp, $cpplevel);
605 if ($cpp =~ /^\#\s*if/) {
607 } elsif (!$cpplevel) {
608 Warn("Warning: #else/elif/endif without #if in this function");
609 print STDERR " (precede it with a blank line if the matching #if is outside the function)\n"
610 if $XSStack[-1]{type} eq 'if';
612 } elsif ($cpp =~ /^\#\s*endif/) {
616 Warn("Warning: #if without #endif in this function") if $cpplevel;
629 open($FH, $filename) or die "cannot open $filename: $!\n";
631 # Identify the version of xsubpp used
634 * This file was generated automatically by xsubpp version $XSUBPP_version from the
635 * contents of $filename. Do not edit this file, edit $filename instead.
637 * ANY CHANGES MADE HERE WILL BE LOST!
642 print "#line 1 \"$filename\"\n";
645 last if ($Module, $Package, $Prefix) =
646 /^MODULE\s*=\s*([\w:]+)(?:\s+PACKAGE\s*=\s*([\w:]+))?(?:\s+PREFIX\s*=\s*(\S+))?\s*$/;
649 &Exit unless defined $_;
654 # Read next xsub into @line from ($lastline, <$FH>).
657 death ("Error: Unterminated `#if/#ifdef/#ifndef'")
658 if !defined $lastline && $XSStack[-1]{type} eq 'if';
661 return PopFile() if !defined $lastline;
664 /^MODULE\s*=\s*([\w:]+)(?:\s+PACKAGE\s*=\s*([\w:]+))?(?:\s+PREFIX\s*=\s*(\S+))?\s*$/) {
666 $Package = defined($2) ? $2 : ''; # keep -w happy
667 $Prefix = defined($3) ? $3 : ''; # keep -w happy
668 $Prefix = quotemeta $Prefix ;
669 ($Module_cname = $Module) =~ s/\W/_/g;
670 ($Packid = $Package) =~ tr/:/_/;
671 $Packprefix = $Package;
672 $Packprefix .= "::" if $Packprefix ne "";
677 if ($lastline !~ /^\s*#/ ||
679 # ANSI: if ifdef ifndef elif else endif define undef
681 # gcc: warning include_next
683 # others: ident (gcc notes that some cpps have this one)
684 $lastline =~ /^#[ \t]*(?:(?:if|ifn?def|elif|else|endif|define|undef|pragma|error|warning|line\s+\d+|ident)\b|(?:include(?:_next)?|import)\s*["<].*[>"])/) {
685 last if $lastline =~ /^\S/ && @line && $line[-1] eq "";
686 push(@line, $lastline);
687 push(@line_no, $lastline_no) ;
690 # Read next line and continuation lines
691 last unless defined($lastline = <$FH>);
694 $lastline .= $tmp_line
695 while ($lastline =~ /\\$/ && defined($tmp_line = <$FH>));
698 $lastline =~ s/^\s+$//;
700 pop(@line), pop(@line_no) while @line && $line[-1] eq "";
705 while (fetch_para()) {
706 # Print initial preprocessor statements and blank lines
707 while (@line && $line[0] !~ /^[^\#]/) {
708 my $line = shift(@line);
710 next unless $line =~ /^\#\s*((if)(?:n?def)?|elsif|else|endif)\b/;
712 if ($statement eq 'if') {
713 $XSS_work_idx = @XSStack;
714 push(@XSStack, {type => 'if'});
716 death ("Error: `$statement' with no matching `if'")
717 if $XSStack[-1]{type} ne 'if';
718 if ($XSStack[-1]{varname}) {
719 push(@InitFileCode, "#endif\n");
720 push(@BootCode, "#endif");
723 my(@fns) = keys %{$XSStack[-1]{functions}};
724 if ($statement ne 'endif') {
725 # Hide the functions defined in other #if branches, and reset.
726 @{$XSStack[-1]{other_functions}}{@fns} = (1) x @fns;
727 @{$XSStack[-1]}{qw(varname functions)} = ('', {});
729 my($tmp) = pop(@XSStack);
730 0 while (--$XSS_work_idx
731 && $XSStack[$XSS_work_idx]{type} ne 'if');
732 # Keep all new defined functions
733 push(@fns, keys %{$tmp->{other_functions}});
734 @{$XSStack[$XSS_work_idx]{functions}}{@fns} = (1) x @fns;
739 next PARAGRAPH unless @line;
741 if ($XSS_work_idx && !$XSStack[$XSS_work_idx]{varname}) {
742 # We are inside an #if, but have not yet #defined its xsubpp variable.
743 print "#define $cpp_next_tmp 1\n\n";
744 push(@InitFileCode, "#if $cpp_next_tmp\n");
745 push(@BootCode, "#if $cpp_next_tmp");
746 $XSStack[$XSS_work_idx]{varname} = $cpp_next_tmp++;
749 death ("Code is not inside a function"
750 ." (maybe last function was ended by a blank line "
751 ." followed by a a statement on column one?)")
752 if $line[0] =~ /^\s/;
754 # initialize info arrays
765 undef($proto_in_this_xsub) ;
766 undef($scope_in_this_xsub) ;
767 $ProtoThisXSUB = $WantPrototypes ;
771 while ($kwd = check_keyword("REQUIRE|PROTOTYPES|VERSIONCHECK|INCLUDE")) {
772 &{"${kwd}_handler"}() ;
773 next PARAGRAPH unless @line ;
777 if (check_keyword("BOOT")) {
779 push (@BootCode, $_, line_directive(), @line, "") ;
784 # extract return type, function name and arguments
785 my($ret_type) = TidyType($_);
787 # a function definition needs at least 2 lines
788 blurt ("Error: Function definition too short '$ret_type'"), next PARAGRAPH
791 $static = 1 if $ret_type =~ s/^static\s+//;
793 $func_header = shift(@line);
794 blurt ("Error: Cannot parse function definition from '$func_header'"), next PARAGRAPH
795 unless $func_header =~ /^(?:([\w:]*)::)?(\w+)\s*\(\s*(.*?)\s*\)\s*$/s;
797 ($class, $func_name, $orig_args) = ($1, $2, $3) ;
798 ($pname = $func_name) =~ s/^($Prefix)?/$Packprefix/;
799 ($clean_func_name = $func_name) =~ s/^$Prefix//;
800 $Full_func_name = "${Packid}_$clean_func_name";
802 # Check for duplicate function definition
803 for $tmp (@XSStack) {
804 next unless defined $tmp->{functions}{$Full_func_name};
805 Warn("Warning: duplicate function definition '$clean_func_name' detected");
808 $XSStack[$XSS_work_idx]{functions}{$Full_func_name} ++ ;
809 %XsubAliases = %XsubAliasValues = ();
811 @args = split(/\s*,\s*/, $orig_args);
812 if (defined($class)) {
813 my $arg0 = ((defined($static) or $func_name =~ /^new/) ? "CLASS" : "THIS");
814 unshift(@args, $arg0);
815 ($orig_args = "$arg0, $orig_args") =~ s/^$arg0, $/$arg0/;
817 $orig_args =~ s/"/\\"/g;
818 $min_args = $num_args = @args;
819 foreach $i (0..$num_args-1) {
820 if ($args[$i] =~ s/\.\.\.//) {
823 if ($args[$i] eq '' && $i == $num_args - 1) {
828 if ($args[$i] =~ /^([^=]*[^\s=])\s*=\s*(.*)/s) {
831 $defaults{$args[$i]} = $2;
832 $defaults{$args[$i]} =~ s/"/\\"/g;
834 $proto_arg[$i+1] = "\$" ;
836 if (defined($class)) {
837 $func_args = join(", ", @args[1..$#args]);
839 $func_args = join(", ", @args);
841 @args_match{@args} = 1..@args;
843 $PPCODE = grep(/^\s*PPCODE\s*:/, @line);
844 $CODE = grep(/^\s*CODE\s*:/, @line);
845 # Detect CODE: blocks which use ST(n)= or XST_m*(n,v)
846 # to set explicit return values.
847 $EXPLICIT_RETURN = ($CODE &&
848 ("@line" =~ /(\bST\s*\([^;]*=) | (\bXST_m\w+\s*\()/x ));
849 $ALIAS = grep(/^\s*ALIAS\s*:/, @line);
851 # print function header
853 #XS(XS_${Full_func_name})
857 print Q<<"EOF" if $ALIAS ;
861 $cond = ($min_args ? qq(items < $min_args) : 0);
863 elsif ($min_args == $num_args) {
864 $cond = qq(items != $min_args);
867 $cond = qq(items < $min_args || items > $num_args);
870 print Q<<"EOF" if $except;
876 { print Q<<"EOF" if $cond }
878 # croak("Usage: %s($orig_args)", GvNAME(CvGV(cv)));
881 { print Q<<"EOF" if $cond }
883 # croak("Usage: $pname($orig_args)");
886 print Q<<"EOF" if $PPCODE;
890 # Now do a block of some sort.
893 $cond = ''; # last CASE: condidional
894 push(@line, "$END:");
895 push(@line_no, $line_no[-1]);
899 &CASE_handler if check_keyword("CASE");
904 # do initialization of input variables
912 process_keyword("INPUT|PREINIT|ALIAS|PROTOTYPE|SCOPE") ;
914 print Q<<"EOF" if $ScopeThisXSUB;
919 if (!$thisdone && defined($class)) {
920 if (defined($static) or $func_name =~ /^new/) {
922 $var_types{"CLASS"} = "char *";
923 &generate_init("char *", 1, "CLASS");
927 $var_types{"THIS"} = "$class *";
928 &generate_init("$class *", 1, "THIS");
933 if (/^\s*NOT_IMPLEMENTED_YET/) {
934 print "\n\tcroak(\"$pname: not implemented yet\");\n";
937 if ($ret_type ne "void") {
938 print "\t" . &map_type($ret_type) . "\tRETVAL;\n"
940 $args_match{"RETVAL"} = 0;
941 $var_types{"RETVAL"} = $ret_type;
946 process_keyword("INIT|ALIAS|PROTOTYPE") ;
948 if (check_keyword("PPCODE")) {
950 death ("PPCODE must be last thing") if @line;
951 print "\tLEAVE;\n" if $ScopeThisXSUB;
952 print "\tPUTBACK;\n\treturn;\n";
953 } elsif (check_keyword("CODE")) {
955 } elsif (defined($class) and $func_name eq "DESTROY") {
957 print "delete THIS;\n";
960 if ($ret_type ne "void") {
964 if (defined($static)) {
965 if ($func_name =~ /^new/) {
966 $func_name = "$class";
970 } elsif (defined($class)) {
971 if ($func_name =~ /^new/) {
972 $func_name .= " $class";
977 $func_name =~ s/^($spat)//
979 print "$func_name($func_args);\n";
983 # do output variables
987 process_keyword("OUTPUT|ALIAS|PROTOTYPE");
989 # all OUTPUT done, so now push the return value on the stack
990 if ($gotRETVAL && $RETVAL_code) {
991 print "\t$RETVAL_code\n";
992 } elsif ($gotRETVAL || $wantRETVAL) {
993 &generate_output($ret_type, 0, 'RETVAL');
995 print line_directive();
998 process_keyword("CLEANUP|ALIAS|PROTOTYPE") ;
1000 print Q<<"EOF" if $ScopeThisXSUB;
1003 print Q<<"EOF" if $ScopeThisXSUB and not $PPCODE;
1007 # print function trailer
1011 print Q<<EOF if $except;
1014 # sprintf(errbuf, "%s: %s\\tpropagated", Xname, Xreason);
1017 if (check_keyword("CASE")) {
1018 blurt ("Error: No `CASE:' at top of function")
1020 $_ = "CASE: $_"; # Restore CASE: label
1023 last if $_ eq "$END:";
1024 death(/^$BLOCK_re/o ? "Misplaced `$1:'" : "Junk at end of function");
1027 print Q<<EOF if $except;
1032 if ($ret_type ne "void" or $EXPLICIT_RETURN) {
1033 print Q<<EOF unless $PPCODE;
1037 print Q<<EOF unless $PPCODE;
1047 my $newXS = "newXS" ;
1050 # Build the prototype string for the xsub
1051 if ($ProtoThisXSUB) {
1052 $newXS = "newXSproto";
1054 if ($ProtoThisXSUB == 2) {
1055 # User has specified empty prototype
1058 elsif ($ProtoThisXSUB != 1) {
1059 # User has specified a prototype
1060 $proto = ', "' . $ProtoThisXSUB . '"';
1064 if ($min_args < $num_args) {
1066 $proto_arg[$min_args] .= ";" ;
1068 push @proto_arg, "$s\@"
1071 $proto = ', "' . join ("", @proto_arg) . '"';
1076 $XsubAliases{$pname} = 0
1077 unless defined $XsubAliases{$pname} ;
1078 while ( ($name, $value) = each %XsubAliases) {
1079 push(@InitFileCode, Q<<"EOF");
1080 # cv = newXS(\"$name\", XS_$Full_func_name, file);
1081 # XSANY.any_i32 = $value ;
1083 push(@InitFileCode, Q<<"EOF") if $proto;
1084 # sv_setpv((SV*)cv$proto) ;
1090 " ${newXS}(\"$pname\", XS_$Full_func_name, file$proto);\n");
1094 # print initialization routine
1099 #XS(boot_$Module_cname)
1102 # char* file = __FILE__;
1106 print Q<<"EOF" if $WantVersionChk ;
1107 # XS_VERSION_BOOTCHECK ;
1111 print Q<<"EOF" if defined $XsubAliases ;
1117 print @InitFileCode;
1119 print Q<<"EOF" if defined $XsubAliases ;
1125 print "\n /* Initialisation Section */\n" ;
1126 print grep (s/$/\n/, @BootCode) ;
1127 print "\n /* End of Initialisation Section */\n\n" ;
1136 warn("Please specify prototyping behavior for $filename (see perlxs manual)\n")
1142 local($type, $num, $init) = @_;
1143 local($arg) = "ST(" . ($num - 1) . ")";
1145 eval qq/print " $init\\\n"/;
1150 # work out the line number
1151 my $line_no = $line_no[@line_no - @line -1] ;
1153 return "#line $line_no \"$filename\"\n" ;
1159 # work out the line number
1160 my $line_no = $line_no[@line_no - @line -1] ;
1162 print STDERR "@_ in $filename, line $line_no\n" ;
1178 local($type, $num, $var) = @_;
1179 local($arg) = "ST(" . ($num - 1) . ")";
1180 local($argoff) = $num - 1;
1184 $type = TidyType($type) ;
1185 blurt("Error: '$type' not in typemap"), return
1186 unless defined($type_kind{$type});
1188 ($ntype = $type) =~ s/\s*\*/Ptr/g;
1189 ($subtype = $ntype) =~ s/(?:Array)?(?:Ptr)?$//;
1190 $tk = $type_kind{$type};
1191 $tk =~ s/OBJ$/REF/ if $func_name =~ /DESTROY$/;
1193 blurt("Error: No INPUT definition for type '$type' found"), return
1194 unless defined $input_expr{$tk} ;
1195 $expr = $input_expr{$tk};
1196 if ($expr =~ /DO_ARRAY_ELEM/) {
1197 blurt("Error: '$subtype' not in typemap"), return
1198 unless defined($type_kind{$subtype});
1199 blurt("Error: No INPUT definition for type '$subtype' found"), return
1200 unless defined $input_expr{$type_kind{$subtype}} ;
1201 $subexpr = $input_expr{$type_kind{$subtype}};
1202 $subexpr =~ s/ntype/subtype/g;
1203 $subexpr =~ s/\$arg/ST(ix_$var)/g;
1204 $subexpr =~ s/\n\t/\n\t\t/g;
1205 $subexpr =~ s/is not of (.*\")/[arg %d] is not of $1, ix_$var + 1/g;
1206 $subexpr =~ s/\$var/${var}[ix_$var - $argoff]/;
1207 $expr =~ s/DO_ARRAY_ELEM/$subexpr/;
1209 if ($expr =~ m#/\*.*scope.*\*/#i) { # "scope" in C comments
1212 if (defined($defaults{$var})) {
1213 $expr =~ s/(\t+)/$1 /g;
1215 eval qq/print "\\t$var;\\n"/;
1216 $deferred .= eval qq/"\\n\\tif (items < $num)\\n\\t $var = $defaults{$var};\\n\\telse {\\n$expr;\\n\\t}\\n"/;
1217 } elsif ($ScopeThisXSUB or $expr !~ /^\t\$var =/) {
1218 eval qq/print "\\t$var;\\n"/;
1219 $deferred .= eval qq/"\\n$expr;\\n"/;
1221 eval qq/print "$expr;\\n"/;
1225 sub generate_output {
1226 local($type, $num, $var) = @_;
1227 local($arg) = "ST(" . ($num - ($num != 0)) . ")";
1228 local($argoff) = $num - 1;
1231 $type = TidyType($type) ;
1232 if ($type =~ /^array\(([^,]*),(.*)\)/) {
1233 print "\tsv_setpvn($arg, (char *)$var, $2 * sizeof($1)), XFree((char *)$var);\n";
1235 blurt("Error: '$type' not in typemap"), return
1236 unless defined($type_kind{$type});
1237 blurt("Error: No OUTPUT definition for type '$type' found"), return
1238 unless defined $output_expr{$type_kind{$type}} ;
1239 ($ntype = $type) =~ s/\s*\*/Ptr/g;
1240 $ntype =~ s/\(\)//g;
1241 ($subtype = $ntype) =~ s/(?:Array)?(?:Ptr)?$//;
1242 $expr = $output_expr{$type_kind{$type}};
1243 if ($expr =~ /DO_ARRAY_ELEM/) {
1244 blurt("Error: '$subtype' not in typemap"), return
1245 unless defined($type_kind{$subtype});
1246 blurt("Error: No OUTPUT definition for type '$subtype' found"), return
1247 unless defined $output_expr{$type_kind{$subtype}} ;
1248 $subexpr = $output_expr{$type_kind{$subtype}};
1249 $subexpr =~ s/ntype/subtype/g;
1250 $subexpr =~ s/\$arg/ST(ix_$var)/g;
1251 $subexpr =~ s/\$var/${var}[ix_$var]/g;
1252 $subexpr =~ s/\n\t/\n\t\t/g;
1253 $expr =~ s/DO_ARRAY_ELEM\n/$subexpr/;
1254 eval "print qq\a$expr\a";
1256 elsif ($var eq 'RETVAL') {
1257 if ($expr =~ /^\t\$arg = new/) {
1258 # We expect that $arg has refcnt 1, so we need to
1260 eval "print qq\a$expr\a";
1261 print "\tsv_2mortal(ST(0));\n";
1263 elsif ($expr =~ /^\s*\$arg\s*=/) {
1264 # We expect that $arg has refcnt >=1, so we need
1265 # to mortalize it. However, the extension may have
1266 # returned the built-in perl value, which is
1267 # read-only, thus not mortalizable. However, it is
1268 # safe to leave it as it is, since it would be
1269 # ignored by REFCNT_dec. Builtin values have REFCNT==0.
1270 eval "print qq\a$expr\a";
1271 print "\tif (SvREFCNT(ST(0))) sv_2mortal(ST(0));\n";
1274 # Just hope that the entry would safely write it
1275 # over an already mortalized value. By
1276 # coincidence, something like $arg = &sv_undef
1278 print "\tST(0) = sv_newmortal();\n";
1279 eval "print qq\a$expr\a";
1282 elsif ($arg =~ /^ST\(\d+\)$/) {
1283 eval "print qq\a$expr\a";
1292 $type =~ s/^array\(([^,]*),(.*)\).*/$1 */s;
1298 # If this is VMS, the exit status has meaning to the shell, so we
1299 # use a predictable value (SS$_Normal or SS$_Abort) rather than an
1301 exit ($Is_VMS ? ($errors ? 44 : 1) : $errors) ;