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';
86 $XSUBPP_version = "1.9402";
88 my ($Is_VMS, $SymSet);
91 # Establish set of global symbols with max length 28, since xsubpp
92 # will later add the 'XS_' prefix.
93 require ExtUtils::XSSymSet;
94 $SymSet = new ExtUtils::XSSymSet 28;
99 $usage = "Usage: xsubpp [-v] [-C++] [-except] [-prototypes] [-noversioncheck] [-s pattern] [-typemap typemap]... file.xs\n";
101 $proto_re = "[" . quotemeta('\$%&*@;') . "]" ;
104 $WantPrototypes = -1 ;
105 $WantVersionChk = 1 ;
107 SWITCH: while (@ARGV and $ARGV[0] =~ /^-./) {
110 $spat = quotemeta shift, next SWITCH if $flag eq 's';
111 $cplusplus = 1, next SWITCH if $flag eq 'C++';
112 $WantPrototypes = 0, next SWITCH if $flag eq 'noprototypes';
113 $WantPrototypes = 1, next SWITCH if $flag eq 'prototypes';
114 $WantVersionChk = 0, next SWITCH if $flag eq 'noversioncheck';
115 $WantVersionChk = 1, next SWITCH if $flag eq 'versioncheck';
116 $except = " TRY", next SWITCH if $flag eq 'except';
117 push(@tm,shift), next SWITCH if $flag eq 'typemap';
118 (print "xsubpp version $XSUBPP_version\n"), exit
122 if ($WantPrototypes == -1)
123 { $WantPrototypes = 0}
128 @ARGV == 1 or die $usage;
129 ($dir, $filename) = $ARGV[0] =~ m#(.*)/(.*)#
130 or ($dir, $filename) = $ARGV[0] =~ m#(.*[>\]])(.*)#
131 or ($dir, $filename) = ('.', $ARGV[0]);
135 ++ $IncludedFiles{$ARGV[0]} ;
137 my(@XSStack) = ({type => 'none'}); # Stack of conditionals and INCLUDEs
138 my($XSS_work_idx, $cpp_next_tmp) = (0, "XSubPPtmpAAAA");
143 $_[0] =~ s/^\s+|\s+$//go ;
150 # rationalise any '*' by joining them into bunches and removing whitespace
154 # change multiple whitespace into a single space
157 # trim leading & trailing whitespace
163 $typemap = shift @ARGV;
164 foreach $typemap (@tm) {
165 die "Can't find $typemap in $pwd\n" unless -r $typemap;
167 unshift @tm, qw(../../../../lib/ExtUtils/typemap ../../../lib/ExtUtils/typemap
168 ../../lib/ExtUtils/typemap ../../../typemap ../../typemap
170 foreach $typemap (@tm) {
171 next unless -e $typemap ;
172 # skip directories, binary files etc.
173 warn("Warning: ignoring non-text typemap file '$typemap'\n"), next
175 open(TYPEMAP, $typemap)
176 or warn ("Warning: could not open typemap file '$typemap': $!\n"), next;
182 my $line_no = $. + 1;
183 if (/^INPUT\s*$/) { $mode = 'Input'; $current = \$junk; next; }
184 if (/^OUTPUT\s*$/) { $mode = 'Output'; $current = \$junk; next; }
185 if (/^TYPEMAP\s*$/) { $mode = 'Typemap'; $current = \$junk; next; }
186 if ($mode eq 'Typemap') {
190 # skip blank lines and comment lines
191 next if /^$/ or /^#/ ;
192 my($type,$kind, $proto) = /^\s*(.*?\S)\s+(\S+)\s*($proto_re*)\s*$/ or
193 warn("Warning: File '$typemap' Line $. '$line' TYPEMAP entry needs 2 or 3 columns\n"), next;
194 $type = TidyType($type) ;
195 $type_kind{$type} = $kind ;
196 # prototype defaults to '$'
197 $proto = "\$" unless $proto ;
198 warn("Warning: File '$typemap' Line $. '$line' Invalid prototype '$proto'\n")
199 unless ValidProtoString($proto) ;
200 $proto_letter{$type} = C_string($proto) ;
205 elsif ($mode eq 'Input') {
207 $input_expr{$_} = '';
208 $current = \$input_expr{$_};
212 $output_expr{$_} = '';
213 $current = \$output_expr{$_};
219 foreach $key (keys %input_expr) {
220 $input_expr{$key} =~ s/\n+$//;
223 $END = "!End!\n\n"; # "impossible" keyword (multiple newline)
225 # Match an XS keyword
226 $BLOCK_re= '\s*(' . join('|', qw(
227 REQUIRE BOOT CASE PREINIT INPUT INIT CODE PPCODE OUTPUT
228 CLEANUP ALIAS PROTOTYPES PROTOTYPE VERSIONCHECK INCLUDE
232 # Input: ($_, @line) == unparsed input.
233 # Output: ($_, @line) == (rest of line, following lines).
234 # Return: the matched keyword if found, otherwise 0
236 $_ = shift(@line) while !/\S/ && @line;
237 s/^(\s*)($_[0])\s*:\s*(?:#.*)?/$1/s && $2;
243 $_ = shift(@line) while !/\S/ && @line;
244 for (; defined($_) && !/^$BLOCK_re/o; $_ = shift(@line)) {
245 print line_directive() unless ($count++);
250 sub process_keyword($)
255 &{"${kwd}_handler"}()
256 while $kwd = check_keyword($pattern) ;
257 print line_directive();
261 blurt ("Error: `CASE:' after unconditional `CASE:'")
262 if $condnum && $cond eq '';
264 TrimWhitespace($cond);
265 print " ", ($condnum++ ? " else" : ""), ($cond ? " if ($cond)\n" : "\n");
270 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
271 last if /^\s*NOT_IMPLEMENTED_YET/;
272 next unless /\S/; # skip blank lines
277 # remove trailing semicolon if no initialisation
278 s/\s*;$//g unless /=/ ;
280 # check for optional initialisation code
282 $var_init = $1 if s/\s*(=.*)$//s ;
283 $var_init =~ s/"/\\"/g;
286 my ($var_type, $var_addr, $var_name) = /^(.*?[^& ]) *(\&?) *\b(\w+)$/s
287 or blurt("Error: invalid argument declaration '$line'"), next;
289 # Check for duplicate definitions
290 blurt ("Error: duplicate definition of argument '$var_name' ignored"), next
291 if $arg_list{$var_name} ++ ;
293 $thisdone |= $var_name eq "THIS";
294 $retvaldone |= $var_name eq "RETVAL";
295 $var_types{$var_name} = $var_type;
296 print "\t" . &map_type($var_type);
297 $var_num = $args_match{$var_name};
299 $proto_arg[$var_num] = ProtoString($var_type)
302 $var_addr{$var_name} = 1;
303 $func_args =~ s/\b($var_name)\b/&$1/;
305 if ($var_init =~ /^=\s*NO_INIT\s*;?\s*$/) {
306 print "\t$var_name;\n";
307 } elsif ($var_init =~ /\S/) {
308 &output_init($var_type, $var_num, "$var_name $var_init");
310 # generate initialization code
311 &generate_init($var_type, $var_num, $var_name);
319 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
321 my ($outarg, $outcode) = /^\s*(\S+)\s*(.*?)\s*$/s ;
322 blurt ("Error: duplicate OUTPUT argument '$outarg' ignored"), next
323 if $outargs{$outarg} ++ ;
324 if (!$gotRETVAL and $outarg eq 'RETVAL') {
325 # deal with RETVAL last
326 $RETVAL_code = $outcode ;
330 blurt ("Error: OUTPUT $outarg not an argument"), next
331 unless defined($args_match{$outarg});
332 blurt("Error: No input definition for OUTPUT argument '$outarg' - ignored"), next
333 unless defined $var_types{$outarg} ;
334 print line_directive();
336 print "\t$outcode\n";
338 $var_num = $args_match{$outarg};
339 &generate_output($var_types{$outarg}, $var_num, $outarg);
344 sub CLEANUP_handler() { print_section() }
345 sub PREINIT_handler() { print_section() }
346 sub INIT_handler() { print_section() }
355 # Parse alias definitions
357 # alias = value alias = value ...
359 while ($line =~ s/^\s*([\w:]+)\s*=\s*(\w+)\s*//) {
361 $orig_alias = $alias ;
364 # check for optional package definition in the alias
365 $alias = $Packprefix . $alias if $alias !~ /::/ ;
367 # check for duplicate alias name & duplicate value
368 Warn("Warning: Ignoring duplicate alias '$orig_alias'")
369 if defined $XsubAliases{$alias} ;
371 Warn("Warning: Aliases '$orig_alias' and '$XsubAliasValues{$value}' have identical values")
372 if $XsubAliasValues{$value} ;
375 $XsubAliases{$alias} = $value ;
376 $XsubAliasValues{$value} = $orig_alias ;
379 blurt("Error: Cannot parse ALIAS definitions from '$orig'")
385 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
388 GetAliases($_) if $_ ;
392 sub REQUIRE_handler ()
394 # the rest of the current line should contain a version number
397 TrimWhitespace($Ver) ;
399 death ("Error: REQUIRE expects a version number")
402 # check that the version number is of the form n.n
403 death ("Error: REQUIRE: expected a number, got '$Ver'")
404 unless $Ver =~ /^\d+(\.\d*)?/ ;
406 death ("Error: xsubpp $Ver (or better) required--this is only $XSUBPP_version.")
407 unless $XSUBPP_version >= $Ver ;
410 sub VERSIONCHECK_handler ()
412 # the rest of the current line should contain either ENABLE or
417 # check for ENABLE/DISABLE
418 death ("Error: VERSIONCHECK: ENABLE/DISABLE")
419 unless /^(ENABLE|DISABLE)/i ;
421 $WantVersionChk = 1 if $1 eq 'ENABLE' ;
422 $WantVersionChk = 0 if $1 eq 'DISABLE' ;
426 sub PROTOTYPE_handler ()
430 death("Error: Only 1 PROTOTYPE definition allowed per xsub")
431 if $proto_in_this_xsub ++ ;
433 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
437 if ($_ eq 'DISABLE') {
440 elsif ($_ eq 'ENABLE') {
444 # remove any whitespace
446 death("Error: Invalid prototype '$_'")
447 unless ValidProtoString($_) ;
448 $ProtoThisXSUB = C_string($_) ;
452 # If no prototype specified, then assume empty prototype ""
453 $ProtoThisXSUB = 2 unless $specified ;
461 death("Error: Only 1 SCOPE declaration allowed per xsub")
462 if $scope_in_this_xsub ++ ;
464 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
467 if ($_ =~ /^DISABLE/i) {
470 elsif ($_ =~ /^ENABLE/i) {
477 sub PROTOTYPES_handler ()
479 # the rest of the current line should contain either ENABLE or
484 # check for ENABLE/DISABLE
485 death ("Error: PROTOTYPES: ENABLE/DISABLE")
486 unless /^(ENABLE|DISABLE)/i ;
488 $WantPrototypes = 1 if $1 eq 'ENABLE' ;
489 $WantPrototypes = 0 if $1 eq 'DISABLE' ;
494 sub INCLUDE_handler ()
496 # the rest of the current line should contain a valid filename
500 death("INCLUDE: filename missing")
503 death("INCLUDE: output pipe is illegal")
506 # simple minded recursion detector
507 death("INCLUDE loop detected")
508 if $IncludedFiles{$_} ;
510 ++ $IncludedFiles{$_} unless /\|\s*$/ ;
512 # Save the current file context.
515 LastLine => $lastline,
516 LastLineNo => $lastline_no,
519 Filename => $filename,
526 open ($FH, "$_") or death("Cannot open '$_': $!") ;
530 #/* INCLUDE: Including '$_' from '$filename' */
536 # Prime the pump by reading the first
539 # skip leading blank lines
541 last unless /^\s*$/ ;
551 return 0 unless $XSStack[-1]{type} eq 'file' ;
553 my $data = pop @XSStack ;
554 my $ThisFile = $filename ;
555 my $isPipe = ($filename =~ /\|\s*$/) ;
557 -- $IncludedFiles{$filename}
562 $FH = $data->{Handle} ;
563 $filename = $data->{Filename} ;
564 $lastline = $data->{LastLine} ;
565 $lastline_no = $data->{LastLineNo} ;
566 @line = @{ $data->{Line} } ;
567 @line_no = @{ $data->{LineNo} } ;
569 if ($isPipe and $? ) {
571 print STDERR "Error reading from pipe '$ThisFile': $! in $filename, line $lastline_no\n" ;
577 #/* INCLUDE: Returning to '$filename' from '$ThisFile' */
584 sub ValidProtoString ($)
588 if ( $string =~ /^$proto_re+$/ ) {
599 $string =~ s[\\][\\\\]g ;
607 $proto_letter{$type} or "\$" ;
611 my @cpp = grep(/^\#\s*(?:if|e\w+)/, @line);
613 my ($cpp, $cpplevel);
615 if ($cpp =~ /^\#\s*if/) {
617 } elsif (!$cpplevel) {
618 Warn("Warning: #else/elif/endif without #if in this function");
619 print STDERR " (precede it with a blank line if the matching #if is outside the function)\n"
620 if $XSStack[-1]{type} eq 'if';
622 } elsif ($cpp =~ /^\#\s*endif/) {
626 Warn("Warning: #if without #endif in this function") if $cpplevel;
639 open($FH, $filename) or die "cannot open $filename: $!\n";
641 # Identify the version of xsubpp used
644 * This file was generated automatically by xsubpp version $XSUBPP_version from the
645 * contents of $filename. Do not edit this file, edit $filename instead.
647 * ANY CHANGES MADE HERE WILL BE LOST!
652 print "#line 1 \"$filename\"\n";
655 last if ($Module, $Package, $Prefix) =
656 /^MODULE\s*=\s*([\w:]+)(?:\s+PACKAGE\s*=\s*([\w:]+))?(?:\s+PREFIX\s*=\s*(\S+))?\s*$/;
659 &Exit unless defined $_;
664 # Read next xsub into @line from ($lastline, <$FH>).
667 death ("Error: Unterminated `#if/#ifdef/#ifndef'")
668 if !defined $lastline && $XSStack[-1]{type} eq 'if';
671 return PopFile() if !defined $lastline;
674 /^MODULE\s*=\s*([\w:]+)(?:\s+PACKAGE\s*=\s*([\w:]+))?(?:\s+PREFIX\s*=\s*(\S+))?\s*$/) {
676 $Package = defined($2) ? $2 : ''; # keep -w happy
677 $Prefix = defined($3) ? $3 : ''; # keep -w happy
678 $Prefix = quotemeta $Prefix ;
679 ($Module_cname = $Module) =~ s/\W/_/g;
680 ($Packid = $Package) =~ tr/:/_/;
681 $Packprefix = $Package;
682 $Packprefix .= "::" if $Packprefix ne "";
687 if ($lastline !~ /^\s*#/ ||
689 # ANSI: if ifdef ifndef elif else endif define undef
691 # gcc: warning include_next
693 # others: ident (gcc notes that some cpps have this one)
694 $lastline =~ /^#[ \t]*(?:(?:if|ifn?def|elif|else|endif|define|undef|pragma|error|warning|line\s+\d+|ident)\b|(?:include(?:_next)?|import)\s*["<].*[>"])/) {
695 last if $lastline =~ /^\S/ && @line && $line[-1] eq "";
696 push(@line, $lastline);
697 push(@line_no, $lastline_no) ;
700 # Read next line and continuation lines
701 last unless defined($lastline = <$FH>);
704 $lastline .= $tmp_line
705 while ($lastline =~ /\\$/ && defined($tmp_line = <$FH>));
708 $lastline =~ s/^\s+$//;
710 pop(@line), pop(@line_no) while @line && $line[-1] eq "";
715 while (fetch_para()) {
716 # Print initial preprocessor statements and blank lines
717 while (@line && $line[0] !~ /^[^\#]/) {
718 my $line = shift(@line);
720 next unless $line =~ /^\#\s*((if)(?:n?def)?|elsif|else|endif)\b/;
722 if ($statement eq 'if') {
723 $XSS_work_idx = @XSStack;
724 push(@XSStack, {type => 'if'});
726 death ("Error: `$statement' with no matching `if'")
727 if $XSStack[-1]{type} ne 'if';
728 if ($XSStack[-1]{varname}) {
729 push(@InitFileCode, "#endif\n");
730 push(@BootCode, "#endif");
733 my(@fns) = keys %{$XSStack[-1]{functions}};
734 if ($statement ne 'endif') {
735 # Hide the functions defined in other #if branches, and reset.
736 @{$XSStack[-1]{other_functions}}{@fns} = (1) x @fns;
737 @{$XSStack[-1]}{qw(varname functions)} = ('', {});
739 my($tmp) = pop(@XSStack);
740 0 while (--$XSS_work_idx
741 && $XSStack[$XSS_work_idx]{type} ne 'if');
742 # Keep all new defined functions
743 push(@fns, keys %{$tmp->{other_functions}});
744 @{$XSStack[$XSS_work_idx]{functions}}{@fns} = (1) x @fns;
749 next PARAGRAPH unless @line;
751 if ($XSS_work_idx && !$XSStack[$XSS_work_idx]{varname}) {
752 # We are inside an #if, but have not yet #defined its xsubpp variable.
753 print "#define $cpp_next_tmp 1\n\n";
754 push(@InitFileCode, "#if $cpp_next_tmp\n");
755 push(@BootCode, "#if $cpp_next_tmp");
756 $XSStack[$XSS_work_idx]{varname} = $cpp_next_tmp++;
759 death ("Code is not inside a function"
760 ." (maybe last function was ended by a blank line "
761 ." followed by a a statement on column one?)")
762 if $line[0] =~ /^\s/;
764 # initialize info arrays
775 undef($proto_in_this_xsub) ;
776 undef($scope_in_this_xsub) ;
777 $ProtoThisXSUB = $WantPrototypes ;
781 while ($kwd = check_keyword("REQUIRE|PROTOTYPES|VERSIONCHECK|INCLUDE")) {
782 &{"${kwd}_handler"}() ;
783 next PARAGRAPH unless @line ;
787 if (check_keyword("BOOT")) {
789 push (@BootCode, $_, line_directive(), @line, "") ;
794 # extract return type, function name and arguments
795 my($ret_type) = TidyType($_);
797 # a function definition needs at least 2 lines
798 blurt ("Error: Function definition too short '$ret_type'"), next PARAGRAPH
801 $static = 1 if $ret_type =~ s/^static\s+//;
803 $func_header = shift(@line);
804 blurt ("Error: Cannot parse function definition from '$func_header'"), next PARAGRAPH
805 unless $func_header =~ /^(?:([\w:]*)::)?(\w+)\s*\(\s*(.*?)\s*\)\s*$/s;
807 ($class, $func_name, $orig_args) = ($1, $2, $3) ;
808 ($pname = $func_name) =~ s/^($Prefix)?/$Packprefix/;
809 ($clean_func_name = $func_name) =~ s/^$Prefix//;
810 $Full_func_name = "${Packid}_$clean_func_name";
811 if ($Is_VMS) { $Full_func_name = $SymSet->addsym($Full_func_name); }
813 # Check for duplicate function definition
814 for $tmp (@XSStack) {
815 next unless defined $tmp->{functions}{$Full_func_name};
816 Warn("Warning: duplicate function definition '$clean_func_name' detected");
819 $XSStack[$XSS_work_idx]{functions}{$Full_func_name} ++ ;
820 %XsubAliases = %XsubAliasValues = ();
822 @args = split(/\s*,\s*/, $orig_args);
823 if (defined($class)) {
824 my $arg0 = ((defined($static) or $func_name =~ /^new/) ? "CLASS" : "THIS");
825 unshift(@args, $arg0);
826 ($orig_args = "$arg0, $orig_args") =~ s/^$arg0, $/$arg0/;
828 $orig_args =~ s/"/\\"/g;
829 $min_args = $num_args = @args;
830 foreach $i (0..$num_args-1) {
831 if ($args[$i] =~ s/\.\.\.//) {
834 if ($args[$i] eq '' && $i == $num_args - 1) {
839 if ($args[$i] =~ /^([^=]*[^\s=])\s*=\s*(.*)/s) {
842 $defaults{$args[$i]} = $2;
843 $defaults{$args[$i]} =~ s/"/\\"/g;
845 $proto_arg[$i+1] = "\$" ;
847 if (defined($class)) {
848 $func_args = join(", ", @args[1..$#args]);
850 $func_args = join(", ", @args);
852 @args_match{@args} = 1..@args;
854 $PPCODE = grep(/^\s*PPCODE\s*:/, @line);
855 $CODE = grep(/^\s*CODE\s*:/, @line);
856 # Detect CODE: blocks which use ST(n)= or XST_m*(n,v)
857 # to set explicit return values.
858 $EXPLICIT_RETURN = ($CODE &&
859 ("@line" =~ /(\bST\s*\([^;]*=) | (\bXST_m\w+\s*\()/x ));
860 $ALIAS = grep(/^\s*ALIAS\s*:/, @line);
862 # print function header
864 #XS(XS_${Full_func_name})
868 print Q<<"EOF" if $ALIAS ;
872 $cond = ($min_args ? qq(items < $min_args) : 0);
874 elsif ($min_args == $num_args) {
875 $cond = qq(items != $min_args);
878 $cond = qq(items < $min_args || items > $num_args);
881 print Q<<"EOF" if $except;
887 { print Q<<"EOF" if $cond }
889 # croak("Usage: %s($orig_args)", GvNAME(CvGV(cv)));
892 { print Q<<"EOF" if $cond }
894 # croak("Usage: $pname($orig_args)");
897 print Q<<"EOF" if $PPCODE;
901 # Now do a block of some sort.
904 $cond = ''; # last CASE: condidional
905 push(@line, "$END:");
906 push(@line_no, $line_no[-1]);
910 &CASE_handler if check_keyword("CASE");
915 # do initialization of input variables
923 process_keyword("INPUT|PREINIT|ALIAS|PROTOTYPE|SCOPE") ;
925 print Q<<"EOF" if $ScopeThisXSUB;
930 if (!$thisdone && defined($class)) {
931 if (defined($static) or $func_name =~ /^new/) {
933 $var_types{"CLASS"} = "char *";
934 &generate_init("char *", 1, "CLASS");
938 $var_types{"THIS"} = "$class *";
939 &generate_init("$class *", 1, "THIS");
944 if (/^\s*NOT_IMPLEMENTED_YET/) {
945 print "\n\tcroak(\"$pname: not implemented yet\");\n";
948 if ($ret_type ne "void") {
949 print "\t" . &map_type($ret_type) . "\tRETVAL;\n"
951 $args_match{"RETVAL"} = 0;
952 $var_types{"RETVAL"} = $ret_type;
957 process_keyword("INIT|ALIAS|PROTOTYPE") ;
959 if (check_keyword("PPCODE")) {
961 death ("PPCODE must be last thing") if @line;
962 print "\tLEAVE;\n" if $ScopeThisXSUB;
963 print "\tPUTBACK;\n\treturn;\n";
964 } elsif (check_keyword("CODE")) {
966 } elsif (defined($class) and $func_name eq "DESTROY") {
968 print "delete THIS;\n";
971 if ($ret_type ne "void") {
975 if (defined($static)) {
976 if ($func_name =~ /^new/) {
977 $func_name = "$class";
981 } elsif (defined($class)) {
982 if ($func_name =~ /^new/) {
983 $func_name .= " $class";
988 $func_name =~ s/^($spat)//
990 print "$func_name($func_args);\n";
994 # do output variables
998 process_keyword("OUTPUT|ALIAS|PROTOTYPE");
1000 # all OUTPUT done, so now push the return value on the stack
1001 if ($gotRETVAL && $RETVAL_code) {
1002 print "\t$RETVAL_code\n";
1003 } elsif ($gotRETVAL || $wantRETVAL) {
1004 &generate_output($ret_type, 0, 'RETVAL');
1006 print line_directive();
1009 process_keyword("CLEANUP|ALIAS|PROTOTYPE") ;
1011 print Q<<"EOF" if $ScopeThisXSUB;
1014 print Q<<"EOF" if $ScopeThisXSUB and not $PPCODE;
1018 # print function trailer
1022 print Q<<EOF if $except;
1025 # sprintf(errbuf, "%s: %s\\tpropagated", Xname, Xreason);
1028 if (check_keyword("CASE")) {
1029 blurt ("Error: No `CASE:' at top of function")
1031 $_ = "CASE: $_"; # Restore CASE: label
1034 last if $_ eq "$END:";
1035 death(/^$BLOCK_re/o ? "Misplaced `$1:'" : "Junk at end of function");
1038 print Q<<EOF if $except;
1043 if ($ret_type ne "void" or $EXPLICIT_RETURN) {
1044 print Q<<EOF unless $PPCODE;
1048 print Q<<EOF unless $PPCODE;
1058 my $newXS = "newXS" ;
1061 # Build the prototype string for the xsub
1062 if ($ProtoThisXSUB) {
1063 $newXS = "newXSproto";
1065 if ($ProtoThisXSUB == 2) {
1066 # User has specified empty prototype
1069 elsif ($ProtoThisXSUB != 1) {
1070 # User has specified a prototype
1071 $proto = ', "' . $ProtoThisXSUB . '"';
1075 if ($min_args < $num_args) {
1077 $proto_arg[$min_args] .= ";" ;
1079 push @proto_arg, "$s\@"
1082 $proto = ', "' . join ("", @proto_arg) . '"';
1087 $XsubAliases{$pname} = 0
1088 unless defined $XsubAliases{$pname} ;
1089 while ( ($name, $value) = each %XsubAliases) {
1090 push(@InitFileCode, Q<<"EOF");
1091 # cv = newXS(\"$name\", XS_$Full_func_name, file);
1092 # XSANY.any_i32 = $value ;
1094 push(@InitFileCode, Q<<"EOF") if $proto;
1095 # sv_setpv((SV*)cv$proto) ;
1101 " ${newXS}(\"$pname\", XS_$Full_func_name, file$proto);\n");
1105 # print initialization routine
1110 #XS(boot_$Module_cname)
1113 # char* file = __FILE__;
1117 print Q<<"EOF" if $WantVersionChk ;
1118 # XS_VERSION_BOOTCHECK ;
1122 print Q<<"EOF" if defined $XsubAliases ;
1128 print @InitFileCode;
1130 print Q<<"EOF" if defined $XsubAliases ;
1136 print "\n /* Initialisation Section */\n" ;
1137 print grep (s/$/\n/, @BootCode) ;
1138 print "\n /* End of Initialisation Section */\n\n" ;
1147 warn("Please specify prototyping behavior for $filename (see perlxs manual)\n")
1153 local($type, $num, $init) = @_;
1154 local($arg) = "ST(" . ($num - 1) . ")";
1156 eval qq/print " $init\\\n"/;
1161 # work out the line number
1162 my $line_no = $line_no[@line_no - @line -1] ;
1164 return "#line $line_no \"$filename\"\n" ;
1170 # work out the line number
1171 my $line_no = $line_no[@line_no - @line -1] ;
1173 print STDERR "@_ in $filename, line $line_no\n" ;
1189 local($type, $num, $var) = @_;
1190 local($arg) = "ST(" . ($num - 1) . ")";
1191 local($argoff) = $num - 1;
1195 $type = TidyType($type) ;
1196 blurt("Error: '$type' not in typemap"), return
1197 unless defined($type_kind{$type});
1199 ($ntype = $type) =~ s/\s*\*/Ptr/g;
1200 ($subtype = $ntype) =~ s/(?:Array)?(?:Ptr)?$//;
1201 $tk = $type_kind{$type};
1202 $tk =~ s/OBJ$/REF/ if $func_name =~ /DESTROY$/;
1204 blurt("Error: No INPUT definition for type '$type' found"), return
1205 unless defined $input_expr{$tk} ;
1206 $expr = $input_expr{$tk};
1207 if ($expr =~ /DO_ARRAY_ELEM/) {
1208 blurt("Error: '$subtype' not in typemap"), return
1209 unless defined($type_kind{$subtype});
1210 blurt("Error: No INPUT definition for type '$subtype' found"), return
1211 unless defined $input_expr{$type_kind{$subtype}} ;
1212 $subexpr = $input_expr{$type_kind{$subtype}};
1213 $subexpr =~ s/ntype/subtype/g;
1214 $subexpr =~ s/\$arg/ST(ix_$var)/g;
1215 $subexpr =~ s/\n\t/\n\t\t/g;
1216 $subexpr =~ s/is not of (.*\")/[arg %d] is not of $1, ix_$var + 1/g;
1217 $subexpr =~ s/\$var/${var}[ix_$var - $argoff]/;
1218 $expr =~ s/DO_ARRAY_ELEM/$subexpr/;
1220 if ($expr =~ m#/\*.*scope.*\*/#i) { # "scope" in C comments
1223 if (defined($defaults{$var})) {
1224 $expr =~ s/(\t+)/$1 /g;
1226 eval qq/print "\\t$var;\\n"/;
1227 $deferred .= eval qq/"\\n\\tif (items < $num)\\n\\t $var = $defaults{$var};\\n\\telse {\\n$expr;\\n\\t}\\n"/;
1228 } elsif ($ScopeThisXSUB or $expr !~ /^\t\$var =/) {
1229 eval qq/print "\\t$var;\\n"/;
1230 $deferred .= eval qq/"\\n$expr;\\n"/;
1232 eval qq/print "$expr;\\n"/;
1236 sub generate_output {
1237 local($type, $num, $var) = @_;
1238 local($arg) = "ST(" . ($num - ($num != 0)) . ")";
1239 local($argoff) = $num - 1;
1242 $type = TidyType($type) ;
1243 if ($type =~ /^array\(([^,]*),(.*)\)/) {
1244 print "\tsv_setpvn($arg, (char *)$var, $2 * sizeof($1)), XFree((char *)$var);\n";
1246 blurt("Error: '$type' not in typemap"), return
1247 unless defined($type_kind{$type});
1248 blurt("Error: No OUTPUT definition for type '$type' found"), return
1249 unless defined $output_expr{$type_kind{$type}} ;
1250 ($ntype = $type) =~ s/\s*\*/Ptr/g;
1251 $ntype =~ s/\(\)//g;
1252 ($subtype = $ntype) =~ s/(?:Array)?(?:Ptr)?$//;
1253 $expr = $output_expr{$type_kind{$type}};
1254 if ($expr =~ /DO_ARRAY_ELEM/) {
1255 blurt("Error: '$subtype' not in typemap"), return
1256 unless defined($type_kind{$subtype});
1257 blurt("Error: No OUTPUT definition for type '$subtype' found"), return
1258 unless defined $output_expr{$type_kind{$subtype}} ;
1259 $subexpr = $output_expr{$type_kind{$subtype}};
1260 $subexpr =~ s/ntype/subtype/g;
1261 $subexpr =~ s/\$arg/ST(ix_$var)/g;
1262 $subexpr =~ s/\$var/${var}[ix_$var]/g;
1263 $subexpr =~ s/\n\t/\n\t\t/g;
1264 $expr =~ s/DO_ARRAY_ELEM\n/$subexpr/;
1265 eval "print qq\a$expr\a";
1267 elsif ($var eq 'RETVAL') {
1268 if ($expr =~ /^\t\$arg = new/) {
1269 # We expect that $arg has refcnt 1, so we need to
1271 eval "print qq\a$expr\a";
1272 print "\tsv_2mortal(ST(0));\n";
1274 elsif ($expr =~ /^\s*\$arg\s*=/) {
1275 # We expect that $arg has refcnt >=1, so we need
1276 # to mortalize it. However, the extension may have
1277 # returned the built-in perl value, which is
1278 # read-only, thus not mortalizable. However, it is
1279 # safe to leave it as it is, since it would be
1280 # ignored by REFCNT_dec. Builtin values have REFCNT==0.
1281 eval "print qq\a$expr\a";
1282 print "\tif (SvREFCNT(ST(0))) sv_2mortal(ST(0));\n";
1285 # Just hope that the entry would safely write it
1286 # over an already mortalized value. By
1287 # coincidence, something like $arg = &sv_undef
1289 print "\tST(0) = sv_newmortal();\n";
1290 eval "print qq\a$expr\a";
1293 elsif ($arg =~ /^ST\(\d+\)$/) {
1294 eval "print qq\a$expr\a";
1303 $type =~ s/^array\(([^,]*),(.*)\).*/$1 */s;
1309 # If this is VMS, the exit status has meaning to the shell, so we
1310 # use a predictable value (SS$_Normal or SS$_Abort) rather than an
1312 # exit ($Is_VMS ? ($errors ? 44 : 1) : $errors) ;
1313 exit ($errors ? 1 : 0);