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<-nolinenumbers>] [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
58 =item B<-nolinenumbers>
60 Prevents the inclusion of `#line' directives in the output.
66 No environment variables are used.
72 =head1 MODIFICATION HISTORY
74 See the file F<changes.pod>.
78 perl(1), perlxs(1), perlxstut(1)
84 use vars '$cplusplus';
90 $XSUBPP_version = "1.9505";
92 my ($Is_VMS, $SymSet);
95 # Establish set of global symbols with max length 28, since xsubpp
96 # will later add the 'XS_' prefix.
97 require ExtUtils::XSSymSet;
98 $SymSet = new ExtUtils::XSSymSet 28;
103 $usage = "Usage: xsubpp [-v] [-C++] [-except] [-prototypes] [-noversioncheck] [-nolinenumbers] [-s pattern] [-typemap typemap]... file.xs\n";
105 $proto_re = "[" . quotemeta('\$%&*@;') . "]" ;
108 $WantPrototypes = -1 ;
109 $WantVersionChk = 1 ;
111 $WantLineNumbers = 1 ;
112 SWITCH: while (@ARGV and $ARGV[0] =~ /^-./) {
115 $spat = quotemeta shift, next SWITCH if $flag eq 's';
116 $cplusplus = 1, next SWITCH if $flag eq 'C++';
117 $WantPrototypes = 0, next SWITCH if $flag eq 'noprototypes';
118 $WantPrototypes = 1, next SWITCH if $flag eq 'prototypes';
119 $WantVersionChk = 0, next SWITCH if $flag eq 'noversioncheck';
120 $WantVersionChk = 1, next SWITCH if $flag eq 'versioncheck';
121 $except = " TRY", next SWITCH if $flag eq 'except';
122 push(@tm,shift), next SWITCH if $flag eq 'typemap';
123 $WantLineNumbers = 0, next SWITCH if $flag eq 'nolinenumbers';
124 $WantLineNumbers = 1, next SWITCH if $flag eq 'linenumbers';
125 (print "xsubpp version $XSUBPP_version\n"), exit
129 if ($WantPrototypes == -1)
130 { $WantPrototypes = 0}
135 @ARGV == 1 or die $usage;
136 ($dir, $filename) = $ARGV[0] =~ m#(.*)/(.*)#
137 or ($dir, $filename) = $ARGV[0] =~ m#(.*)\\(.*)#
138 or ($dir, $filename) = $ARGV[0] =~ m#(.*[>\]])(.*)#
139 or ($dir, $filename) = ('.', $ARGV[0]);
143 ++ $IncludedFiles{$ARGV[0]} ;
145 my(@XSStack) = ({type => 'none'}); # Stack of conditionals and INCLUDEs
146 my($XSS_work_idx, $cpp_next_tmp) = (0, "XSubPPtmpAAAA");
151 $_[0] =~ s/^\s+|\s+$//go ;
158 # rationalise any '*' by joining them into bunches and removing whitespace
162 # change multiple whitespace into a single space
165 # trim leading & trailing whitespace
171 $typemap = shift @ARGV;
172 foreach $typemap (@tm) {
173 die "Can't find $typemap in $pwd\n" unless -r $typemap;
175 unshift @tm, qw(../../../../lib/ExtUtils/typemap ../../../lib/ExtUtils/typemap
176 ../../lib/ExtUtils/typemap ../../../typemap ../../typemap
178 foreach $typemap (@tm) {
179 next unless -e $typemap ;
180 # skip directories, binary files etc.
181 warn("Warning: ignoring non-text typemap file '$typemap'\n"), next
183 open(TYPEMAP, $typemap)
184 or warn ("Warning: could not open typemap file '$typemap': $!\n"), next;
190 my $line_no = $. + 1;
191 if (/^INPUT\s*$/) { $mode = 'Input'; $current = \$junk; next; }
192 if (/^OUTPUT\s*$/) { $mode = 'Output'; $current = \$junk; next; }
193 if (/^TYPEMAP\s*$/) { $mode = 'Typemap'; $current = \$junk; next; }
194 if ($mode eq 'Typemap') {
198 # skip blank lines and comment lines
199 next if /^$/ or /^#/ ;
200 my($type,$kind, $proto) = /^\s*(.*?\S)\s+(\S+)\s*($proto_re*)\s*$/ or
201 warn("Warning: File '$typemap' Line $. '$line' TYPEMAP entry needs 2 or 3 columns\n"), next;
202 $type = TidyType($type) ;
203 $type_kind{$type} = $kind ;
204 # prototype defaults to '$'
205 $proto = "\$" unless $proto ;
206 warn("Warning: File '$typemap' Line $. '$line' Invalid prototype '$proto'\n")
207 unless ValidProtoString($proto) ;
208 $proto_letter{$type} = C_string($proto) ;
213 elsif ($mode eq 'Input') {
215 $input_expr{$_} = '';
216 $current = \$input_expr{$_};
220 $output_expr{$_} = '';
221 $current = \$output_expr{$_};
227 foreach $key (keys %input_expr) {
228 $input_expr{$key} =~ s/\n+$//;
231 $END = "!End!\n\n"; # "impossible" keyword (multiple newline)
233 # Match an XS keyword
234 $BLOCK_re= '\s*(' . join('|', qw(
235 REQUIRE BOOT CASE PREINIT INPUT INIT CODE PPCODE OUTPUT
236 CLEANUP ALIAS PROTOTYPES PROTOTYPE VERSIONCHECK INCLUDE
240 # Input: ($_, @line) == unparsed input.
241 # Output: ($_, @line) == (rest of line, following lines).
242 # Return: the matched keyword if found, otherwise 0
244 $_ = shift(@line) while !/\S/ && @line;
245 s/^(\s*)($_[0])\s*:\s*(?:#.*)?/$1/s && $2;
249 if ($WantLineNumbers) {
251 package xsubpp::counter;
253 my ($class, $cfile) = @_;
255 $SECTION_END_MARKER = "#line --- \"$cfile\"";
264 while ($$self =~ s/^([^\n]*\n)//) {
267 $line =~ s|^\#line\s+---(?=\s)|#line $line_no|;
276 $self->PRINT(sprintf($fmt, @_));
280 # Not necessary if we're careful to end with a "\n"
286 my $cfile = $filename;
287 $cfile =~ s/\.xs$/.c/i or $cfile .= ".c";
288 tie(*PSEUDO_STDOUT, 'xsubpp::counter', $cfile);
289 select PSEUDO_STDOUT;
293 # the "do" is required for right semantics
294 do { $_ = shift(@line) } while !/\S/ && @line;
296 print("#line ", $line_no[@line_no - @line -1], " \"$filename\"\n")
297 if $WantLineNumbers && !/^\s*#\s*line\b/ && !/^#if XSubPPtmp/;
298 for (; defined($_) && !/^$BLOCK_re/o; $_ = shift(@line)) {
301 print "$xsubpp::counter::SECTION_END_MARKER\n" if $WantLineNumbers;
304 sub process_keyword($)
309 &{"${kwd}_handler"}()
310 while $kwd = check_keyword($pattern) ;
314 blurt ("Error: `CASE:' after unconditional `CASE:'")
315 if $condnum && $cond eq '';
317 TrimWhitespace($cond);
318 print " ", ($condnum++ ? " else" : ""), ($cond ? " if ($cond)\n" : "\n");
323 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
324 last if /^\s*NOT_IMPLEMENTED_YET/;
325 next unless /\S/; # skip blank lines
330 # remove trailing semicolon if no initialisation
331 s/\s*;$//g unless /=/ ;
333 # check for optional initialisation code
335 $var_init = $1 if s/\s*(=.*)$//s ;
336 $var_init =~ s/"/\\"/g;
339 my ($var_type, $var_addr, $var_name) = /^(.*?[^& ]) *(\&?) *\b(\w+)$/s
340 or blurt("Error: invalid argument declaration '$line'"), next;
342 # Check for duplicate definitions
343 blurt ("Error: duplicate definition of argument '$var_name' ignored"), next
344 if $arg_list{$var_name} ++ ;
346 $thisdone |= $var_name eq "THIS";
347 $retvaldone |= $var_name eq "RETVAL";
348 $var_types{$var_name} = $var_type;
349 print "\t" . &map_type($var_type);
350 $var_num = $args_match{$var_name};
352 $proto_arg[$var_num] = ProtoString($var_type)
355 $var_addr{$var_name} = 1;
356 $func_args =~ s/\b($var_name)\b/&$1/;
358 if ($var_init =~ /^=\s*NO_INIT\s*;?\s*$/) {
359 print "\t$var_name;\n";
360 } elsif ($var_init =~ /\S/) {
361 &output_init($var_type, $var_num, "$var_name $var_init");
363 # generate initialization code
364 &generate_init($var_type, $var_num, $var_name);
372 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
374 my ($outarg, $outcode) = /^\s*(\S+)\s*(.*?)\s*$/s ;
375 blurt ("Error: duplicate OUTPUT argument '$outarg' ignored"), next
376 if $outargs{$outarg} ++ ;
377 if (!$gotRETVAL and $outarg eq 'RETVAL') {
378 # deal with RETVAL last
379 $RETVAL_code = $outcode ;
383 blurt ("Error: OUTPUT $outarg not an argument"), next
384 unless defined($args_match{$outarg});
385 blurt("Error: No input definition for OUTPUT argument '$outarg' - ignored"), next
386 unless defined $var_types{$outarg} ;
388 print "\t$outcode\n";
390 $var_num = $args_match{$outarg};
391 &generate_output($var_types{$outarg}, $var_num, $outarg);
396 sub CLEANUP_handler() { print_section() }
397 sub PREINIT_handler() { print_section() }
398 sub INIT_handler() { print_section() }
407 # Parse alias definitions
409 # alias = value alias = value ...
411 while ($line =~ s/^\s*([\w:]+)\s*=\s*(\w+)\s*//) {
413 $orig_alias = $alias ;
416 # check for optional package definition in the alias
417 $alias = $Packprefix . $alias if $alias !~ /::/ ;
419 # check for duplicate alias name & duplicate value
420 Warn("Warning: Ignoring duplicate alias '$orig_alias'")
421 if defined $XsubAliases{$alias} ;
423 Warn("Warning: Aliases '$orig_alias' and '$XsubAliasValues{$value}' have identical values")
424 if $XsubAliasValues{$value} ;
427 $XsubAliases{$alias} = $value ;
428 $XsubAliasValues{$value} = $orig_alias ;
431 blurt("Error: Cannot parse ALIAS definitions from '$orig'")
437 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
440 GetAliases($_) if $_ ;
444 sub REQUIRE_handler ()
446 # the rest of the current line should contain a version number
449 TrimWhitespace($Ver) ;
451 death ("Error: REQUIRE expects a version number")
454 # check that the version number is of the form n.n
455 death ("Error: REQUIRE: expected a number, got '$Ver'")
456 unless $Ver =~ /^\d+(\.\d*)?/ ;
458 death ("Error: xsubpp $Ver (or better) required--this is only $XSUBPP_version.")
459 unless $XSUBPP_version >= $Ver ;
462 sub VERSIONCHECK_handler ()
464 # the rest of the current line should contain either ENABLE or
469 # check for ENABLE/DISABLE
470 death ("Error: VERSIONCHECK: ENABLE/DISABLE")
471 unless /^(ENABLE|DISABLE)/i ;
473 $WantVersionChk = 1 if $1 eq 'ENABLE' ;
474 $WantVersionChk = 0 if $1 eq 'DISABLE' ;
478 sub PROTOTYPE_handler ()
482 death("Error: Only 1 PROTOTYPE definition allowed per xsub")
483 if $proto_in_this_xsub ++ ;
485 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
489 if ($_ eq 'DISABLE') {
492 elsif ($_ eq 'ENABLE') {
496 # remove any whitespace
498 death("Error: Invalid prototype '$_'")
499 unless ValidProtoString($_) ;
500 $ProtoThisXSUB = C_string($_) ;
504 # If no prototype specified, then assume empty prototype ""
505 $ProtoThisXSUB = 2 unless $specified ;
513 death("Error: Only 1 SCOPE declaration allowed per xsub")
514 if $scope_in_this_xsub ++ ;
516 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
519 if ($_ =~ /^DISABLE/i) {
522 elsif ($_ =~ /^ENABLE/i) {
529 sub PROTOTYPES_handler ()
531 # the rest of the current line should contain either ENABLE or
536 # check for ENABLE/DISABLE
537 death ("Error: PROTOTYPES: ENABLE/DISABLE")
538 unless /^(ENABLE|DISABLE)/i ;
540 $WantPrototypes = 1 if $1 eq 'ENABLE' ;
541 $WantPrototypes = 0 if $1 eq 'DISABLE' ;
546 sub INCLUDE_handler ()
548 # the rest of the current line should contain a valid filename
552 death("INCLUDE: filename missing")
555 death("INCLUDE: output pipe is illegal")
558 # simple minded recursion detector
559 death("INCLUDE loop detected")
560 if $IncludedFiles{$_} ;
562 ++ $IncludedFiles{$_} unless /\|\s*$/ ;
564 # Save the current file context.
567 LastLine => $lastline,
568 LastLineNo => $lastline_no,
571 Filename => $filename,
578 open ($FH, "$_") or death("Cannot open '$_': $!") ;
582 #/* INCLUDE: Including '$_' from '$filename' */
588 # Prime the pump by reading the first
591 # skip leading blank lines
593 last unless /^\s*$/ ;
603 return 0 unless $XSStack[-1]{type} eq 'file' ;
605 my $data = pop @XSStack ;
606 my $ThisFile = $filename ;
607 my $isPipe = ($filename =~ /\|\s*$/) ;
609 -- $IncludedFiles{$filename}
614 $FH = $data->{Handle} ;
615 $filename = $data->{Filename} ;
616 $lastline = $data->{LastLine} ;
617 $lastline_no = $data->{LastLineNo} ;
618 @line = @{ $data->{Line} } ;
619 @line_no = @{ $data->{LineNo} } ;
621 if ($isPipe and $? ) {
623 print STDERR "Error reading from pipe '$ThisFile': $! in $filename, line $lastline_no\n" ;
629 #/* INCLUDE: Returning to '$filename' from '$ThisFile' */
636 sub ValidProtoString ($)
640 if ( $string =~ /^$proto_re+$/ ) {
651 $string =~ s[\\][\\\\]g ;
659 $proto_letter{$type} or "\$" ;
663 my @cpp = grep(/^\#\s*(?:if|e\w+)/, @line);
665 my ($cpp, $cpplevel);
667 if ($cpp =~ /^\#\s*if/) {
669 } elsif (!$cpplevel) {
670 Warn("Warning: #else/elif/endif without #if in this function");
671 print STDERR " (precede it with a blank line if the matching #if is outside the function)\n"
672 if $XSStack[-1]{type} eq 'if';
674 } elsif ($cpp =~ /^\#\s*endif/) {
678 Warn("Warning: #if without #endif in this function") if $cpplevel;
691 open($FH, $filename) or die "cannot open $filename: $!\n";
693 # Identify the version of xsubpp used
696 * This file was generated automatically by xsubpp version $XSUBPP_version from the
697 * contents of $filename. Do not edit this file, edit $filename instead.
699 * ANY CHANGES MADE HERE WILL BE LOST!
706 print("#line 1 \"$filename\"\n")
710 last if ($Module, $Package, $Prefix) =
711 /^MODULE\s*=\s*([\w:]+)(?:\s+PACKAGE\s*=\s*([\w:]+))?(?:\s+PREFIX\s*=\s*(\S+))?\s*$/;
714 &Exit unless defined $_;
719 # Read next xsub into @line from ($lastline, <$FH>).
722 death ("Error: Unterminated `#if/#ifdef/#ifndef'")
723 if !defined $lastline && $XSStack[-1]{type} eq 'if';
726 return PopFile() if !defined $lastline;
729 /^MODULE\s*=\s*([\w:]+)(?:\s+PACKAGE\s*=\s*([\w:]+))?(?:\s+PREFIX\s*=\s*(\S+))?\s*$/) {
731 $Package = defined($2) ? $2 : ''; # keep -w happy
732 $Prefix = defined($3) ? $3 : ''; # keep -w happy
733 $Prefix = quotemeta $Prefix ;
734 ($Module_cname = $Module) =~ s/\W/_/g;
735 ($Packid = $Package) =~ tr/:/_/;
736 $Packprefix = $Package;
737 $Packprefix .= "::" if $Packprefix ne "";
742 if ($lastline !~ /^\s*#/ ||
744 # ANSI: if ifdef ifndef elif else endif define undef
746 # gcc: warning include_next
748 # others: ident (gcc notes that some cpps have this one)
749 $lastline =~ /^#[ \t]*(?:(?:if|ifn?def|elif|else|endif|define|undef|pragma|error|warning|line\s+\d+|ident)\b|(?:include(?:_next)?|import)\s*["<].*[>"])/) {
750 last if $lastline =~ /^\S/ && @line && $line[-1] eq "";
751 push(@line, $lastline);
752 push(@line_no, $lastline_no) ;
755 # Read next line and continuation lines
756 last unless defined($lastline = <$FH>);
759 $lastline .= $tmp_line
760 while ($lastline =~ /\\$/ && defined($tmp_line = <$FH>));
763 $lastline =~ s/^\s+$//;
765 pop(@line), pop(@line_no) while @line && $line[-1] eq "";
770 while (fetch_para()) {
771 # Print initial preprocessor statements and blank lines
772 while (@line && $line[0] !~ /^[^\#]/) {
773 my $line = shift(@line);
775 next unless $line =~ /^\#\s*((if)(?:n?def)?|elsif|else|endif)\b/;
777 if ($statement eq 'if') {
778 $XSS_work_idx = @XSStack;
779 push(@XSStack, {type => 'if'});
781 death ("Error: `$statement' with no matching `if'")
782 if $XSStack[-1]{type} ne 'if';
783 if ($XSStack[-1]{varname}) {
784 push(@InitFileCode, "#endif\n");
785 push(@BootCode, "#endif");
788 my(@fns) = keys %{$XSStack[-1]{functions}};
789 if ($statement ne 'endif') {
790 # Hide the functions defined in other #if branches, and reset.
791 @{$XSStack[-1]{other_functions}}{@fns} = (1) x @fns;
792 @{$XSStack[-1]}{qw(varname functions)} = ('', {});
794 my($tmp) = pop(@XSStack);
795 0 while (--$XSS_work_idx
796 && $XSStack[$XSS_work_idx]{type} ne 'if');
797 # Keep all new defined functions
798 push(@fns, keys %{$tmp->{other_functions}});
799 @{$XSStack[$XSS_work_idx]{functions}}{@fns} = (1) x @fns;
804 next PARAGRAPH unless @line;
806 if ($XSS_work_idx && !$XSStack[$XSS_work_idx]{varname}) {
807 # We are inside an #if, but have not yet #defined its xsubpp variable.
808 print "#define $cpp_next_tmp 1\n\n";
809 push(@InitFileCode, "#if $cpp_next_tmp\n");
810 push(@BootCode, "#if $cpp_next_tmp");
811 $XSStack[$XSS_work_idx]{varname} = $cpp_next_tmp++;
814 death ("Code is not inside a function"
815 ." (maybe last function was ended by a blank line "
816 ." followed by a a statement on column one?)")
817 if $line[0] =~ /^\s/;
819 # initialize info arrays
830 undef($proto_in_this_xsub) ;
831 undef($scope_in_this_xsub) ;
832 $ProtoThisXSUB = $WantPrototypes ;
836 while ($kwd = check_keyword("REQUIRE|PROTOTYPES|VERSIONCHECK|INCLUDE")) {
837 &{"${kwd}_handler"}() ;
838 next PARAGRAPH unless @line ;
842 if (check_keyword("BOOT")) {
844 push (@BootCode, "#line $line_no[@line_no - @line] \"$filename\"")
845 if $WantLineNumbers && $line[0] !~ /^\s*#\s*line\b/;
846 push (@BootCode, @line, "") ;
851 # extract return type, function name and arguments
852 my($ret_type) = TidyType($_);
854 # a function definition needs at least 2 lines
855 blurt ("Error: Function definition too short '$ret_type'"), next PARAGRAPH
858 $static = 1 if $ret_type =~ s/^static\s+//;
860 $func_header = shift(@line);
861 blurt ("Error: Cannot parse function definition from '$func_header'"), next PARAGRAPH
862 unless $func_header =~ /^(?:([\w:]*)::)?(\w+)\s*\(\s*(.*?)\s*\)\s*$/s;
864 ($class, $func_name, $orig_args) = ($1, $2, $3) ;
865 ($pname = $func_name) =~ s/^($Prefix)?/$Packprefix/;
866 ($clean_func_name = $func_name) =~ s/^$Prefix//;
867 $Full_func_name = "${Packid}_$clean_func_name";
868 if ($Is_VMS) { $Full_func_name = $SymSet->addsym($Full_func_name); }
870 # Check for duplicate function definition
871 for $tmp (@XSStack) {
872 next unless defined $tmp->{functions}{$Full_func_name};
873 Warn("Warning: duplicate function definition '$clean_func_name' detected");
876 $XSStack[$XSS_work_idx]{functions}{$Full_func_name} ++ ;
877 %XsubAliases = %XsubAliasValues = ();
879 @args = split(/\s*,\s*/, $orig_args);
880 if (defined($class)) {
881 my $arg0 = ((defined($static) or $func_name eq 'new')
883 unshift(@args, $arg0);
884 ($orig_args = "$arg0, $orig_args") =~ s/^$arg0, $/$arg0/;
886 $orig_args =~ s/"/\\"/g;
887 $min_args = $num_args = @args;
888 foreach $i (0..$num_args-1) {
889 if ($args[$i] =~ s/\.\.\.//) {
892 if ($args[$i] eq '' && $i == $num_args - 1) {
897 if ($args[$i] =~ /^([^=]*[^\s=])\s*=\s*(.*)/s) {
900 $defaults{$args[$i]} = $2;
901 $defaults{$args[$i]} =~ s/"/\\"/g;
903 $proto_arg[$i+1] = "\$" ;
905 if (defined($class)) {
906 $func_args = join(", ", @args[1..$#args]);
908 $func_args = join(", ", @args);
910 @args_match{@args} = 1..@args;
912 $PPCODE = grep(/^\s*PPCODE\s*:/, @line);
913 $CODE = grep(/^\s*CODE\s*:/, @line);
914 # Detect CODE: blocks which use ST(n)= or XST_m*(n,v)
915 # to set explicit return values.
916 $EXPLICIT_RETURN = ($CODE &&
917 ("@line" =~ /(\bST\s*\([^;]*=) | (\bXST_m\w+\s*\()/x ));
918 $ALIAS = grep(/^\s*ALIAS\s*:/, @line);
920 # print function header
922 #XS(XS_${Full_func_name})
926 print Q<<"EOF" if $ALIAS ;
930 $cond = ($min_args ? qq(items < $min_args) : 0);
932 elsif ($min_args == $num_args) {
933 $cond = qq(items != $min_args);
936 $cond = qq(items < $min_args || items > $num_args);
939 print Q<<"EOF" if $except;
945 { print Q<<"EOF" if $cond }
947 # croak("Usage: %s($orig_args)", GvNAME(CvGV(cv)));
950 { print Q<<"EOF" if $cond }
952 # croak("Usage: $pname($orig_args)");
955 print Q<<"EOF" if $PPCODE;
959 # Now do a block of some sort.
962 $cond = ''; # last CASE: condidional
963 push(@line, "$END:");
964 push(@line_no, $line_no[-1]);
968 &CASE_handler if check_keyword("CASE");
973 # do initialization of input variables
981 process_keyword("INPUT|PREINIT|ALIAS|PROTOTYPE|SCOPE") ;
983 print Q<<"EOF" if $ScopeThisXSUB;
988 if (!$thisdone && defined($class)) {
989 if (defined($static) or $func_name eq 'new') {
991 $var_types{"CLASS"} = "char *";
992 &generate_init("char *", 1, "CLASS");
996 $var_types{"THIS"} = "$class *";
997 &generate_init("$class *", 1, "THIS");
1002 if (/^\s*NOT_IMPLEMENTED_YET/) {
1003 print "\n\tcroak(\"$pname: not implemented yet\");\n";
1006 if ($ret_type ne "void") {
1007 print "\t" . &map_type($ret_type) . "\tRETVAL;\n"
1009 $args_match{"RETVAL"} = 0;
1010 $var_types{"RETVAL"} = $ret_type;
1015 process_keyword("INIT|ALIAS|PROTOTYPE") ;
1017 if (check_keyword("PPCODE")) {
1019 death ("PPCODE must be last thing") if @line;
1020 print "\tLEAVE;\n" if $ScopeThisXSUB;
1021 print "\tPUTBACK;\n\treturn;\n";
1022 } elsif (check_keyword("CODE")) {
1024 } elsif (defined($class) and $func_name eq "DESTROY") {
1026 print "delete THIS;\n";
1029 if ($ret_type ne "void") {
1033 if (defined($static)) {
1034 if ($func_name eq 'new') {
1035 $func_name = "$class";
1039 } elsif (defined($class)) {
1040 if ($func_name eq 'new') {
1041 $func_name .= " $class";
1046 $func_name =~ s/^($spat)//
1048 print "$func_name($func_args);\n";
1052 # do output variables
1054 undef $RETVAL_code ;
1056 process_keyword("OUTPUT|ALIAS|PROTOTYPE");
1058 # all OUTPUT done, so now push the return value on the stack
1059 if ($gotRETVAL && $RETVAL_code) {
1060 print "\t$RETVAL_code\n";
1061 } elsif ($gotRETVAL || $wantRETVAL) {
1062 &generate_output($ret_type, 0, 'RETVAL');
1066 process_keyword("CLEANUP|ALIAS|PROTOTYPE") ;
1068 print Q<<"EOF" if $ScopeThisXSUB;
1071 print Q<<"EOF" if $ScopeThisXSUB and not $PPCODE;
1075 # print function trailer
1079 print Q<<EOF if $except;
1082 # sprintf(errbuf, "%s: %s\\tpropagated", Xname, Xreason);
1085 if (check_keyword("CASE")) {
1086 blurt ("Error: No `CASE:' at top of function")
1088 $_ = "CASE: $_"; # Restore CASE: label
1091 last if $_ eq "$END:";
1092 death(/^$BLOCK_re/o ? "Misplaced `$1:'" : "Junk at end of function");
1095 print Q<<EOF if $except;
1100 if ($ret_type ne "void" or $EXPLICIT_RETURN) {
1101 print Q<<EOF unless $PPCODE;
1105 print Q<<EOF unless $PPCODE;
1115 my $newXS = "newXS" ;
1118 # Build the prototype string for the xsub
1119 if ($ProtoThisXSUB) {
1120 $newXS = "newXSproto";
1122 if ($ProtoThisXSUB eq 2) {
1123 # User has specified empty prototype
1126 elsif ($ProtoThisXSUB ne 1) {
1127 # User has specified a prototype
1128 $proto = ', "' . $ProtoThisXSUB . '"';
1132 if ($min_args < $num_args) {
1134 $proto_arg[$min_args] .= ";" ;
1136 push @proto_arg, "$s\@"
1139 $proto = ', "' . join ("", @proto_arg) . '"';
1144 $XsubAliases{$pname} = 0
1145 unless defined $XsubAliases{$pname} ;
1146 while ( ($name, $value) = each %XsubAliases) {
1147 push(@InitFileCode, Q<<"EOF");
1148 # cv = newXS(\"$name\", XS_$Full_func_name, file);
1149 # XSANY.any_i32 = $value ;
1151 push(@InitFileCode, Q<<"EOF") if $proto;
1152 # sv_setpv((SV*)cv$proto) ;
1158 " ${newXS}(\"$pname\", XS_$Full_func_name, file$proto);\n");
1162 # print initialization routine
1167 #XS(boot_$Module_cname)
1170 # char* file = __FILE__;
1174 print Q<<"EOF" if $WantVersionChk ;
1175 # XS_VERSION_BOOTCHECK ;
1179 print Q<<"EOF" if defined $XsubAliases ;
1185 print @InitFileCode;
1187 print Q<<"EOF" if defined $XsubAliases ;
1193 print "\n /* Initialisation Section */\n\n" ;
1196 print "\n /* End of Initialisation Section */\n\n" ;
1205 warn("Please specify prototyping behavior for $filename (see perlxs manual)\n")
1211 local($type, $num, $init) = @_;
1212 local($arg) = "ST(" . ($num - 1) . ")";
1214 eval qq/print " $init\\\n"/;
1219 # work out the line number
1220 my $line_no = $line_no[@line_no - @line -1] ;
1222 print STDERR "@_ in $filename, line $line_no\n" ;
1238 local($type, $num, $var) = @_;
1239 local($arg) = "ST(" . ($num - 1) . ")";
1240 local($argoff) = $num - 1;
1244 $type = TidyType($type) ;
1245 blurt("Error: '$type' not in typemap"), return
1246 unless defined($type_kind{$type});
1248 ($ntype = $type) =~ s/\s*\*/Ptr/g;
1249 ($subtype = $ntype) =~ s/(?:Array)?(?:Ptr)?$//;
1250 $tk = $type_kind{$type};
1251 $tk =~ s/OBJ$/REF/ if $func_name =~ /DESTROY$/;
1253 blurt("Error: No INPUT definition for type '$type' found"), return
1254 unless defined $input_expr{$tk} ;
1255 $expr = $input_expr{$tk};
1256 if ($expr =~ /DO_ARRAY_ELEM/) {
1257 blurt("Error: '$subtype' not in typemap"), return
1258 unless defined($type_kind{$subtype});
1259 blurt("Error: No INPUT definition for type '$subtype' found"), return
1260 unless defined $input_expr{$type_kind{$subtype}} ;
1261 $subexpr = $input_expr{$type_kind{$subtype}};
1262 $subexpr =~ s/ntype/subtype/g;
1263 $subexpr =~ s/\$arg/ST(ix_$var)/g;
1264 $subexpr =~ s/\n\t/\n\t\t/g;
1265 $subexpr =~ s/is not of (.*\")/[arg %d] is not of $1, ix_$var + 1/g;
1266 $subexpr =~ s/\$var/${var}[ix_$var - $argoff]/;
1267 $expr =~ s/DO_ARRAY_ELEM/$subexpr/;
1269 if ($expr =~ m#/\*.*scope.*\*/#i) { # "scope" in C comments
1272 if (defined($defaults{$var})) {
1273 $expr =~ s/(\t+)/$1 /g;
1275 eval qq/print "\\t$var;\\n"/;
1276 $deferred .= eval qq/"\\n\\tif (items < $num)\\n\\t $var = $defaults{$var};\\n\\telse {\\n$expr;\\n\\t}\\n"/;
1277 } elsif ($ScopeThisXSUB or $expr !~ /^\t\$var =/) {
1278 eval qq/print "\\t$var;\\n"/;
1279 $deferred .= eval qq/"\\n$expr;\\n"/;
1281 eval qq/print "$expr;\\n"/;
1285 sub generate_output {
1286 local($type, $num, $var) = @_;
1287 local($arg) = "ST(" . ($num - ($num != 0)) . ")";
1288 local($argoff) = $num - 1;
1291 $type = TidyType($type) ;
1292 if ($type =~ /^array\(([^,]*),(.*)\)/) {
1293 print "\tsv_setpvn($arg, (char *)$var, $2 * sizeof($1)), XFree((char *)$var);\n";
1295 blurt("Error: '$type' not in typemap"), return
1296 unless defined($type_kind{$type});
1297 blurt("Error: No OUTPUT definition for type '$type' found"), return
1298 unless defined $output_expr{$type_kind{$type}} ;
1299 ($ntype = $type) =~ s/\s*\*/Ptr/g;
1300 $ntype =~ s/\(\)//g;
1301 ($subtype = $ntype) =~ s/(?:Array)?(?:Ptr)?$//;
1302 $expr = $output_expr{$type_kind{$type}};
1303 if ($expr =~ /DO_ARRAY_ELEM/) {
1304 blurt("Error: '$subtype' not in typemap"), return
1305 unless defined($type_kind{$subtype});
1306 blurt("Error: No OUTPUT definition for type '$subtype' found"), return
1307 unless defined $output_expr{$type_kind{$subtype}} ;
1308 $subexpr = $output_expr{$type_kind{$subtype}};
1309 $subexpr =~ s/ntype/subtype/g;
1310 $subexpr =~ s/\$arg/ST(ix_$var)/g;
1311 $subexpr =~ s/\$var/${var}[ix_$var]/g;
1312 $subexpr =~ s/\n\t/\n\t\t/g;
1313 $expr =~ s/DO_ARRAY_ELEM\n/$subexpr/;
1314 eval "print qq\a$expr\a";
1316 elsif ($var eq 'RETVAL') {
1317 if ($expr =~ /^\t\$arg = new/) {
1318 # We expect that $arg has refcnt 1, so we need to
1320 eval "print qq\a$expr\a";
1321 print "\tsv_2mortal(ST(0));\n";
1323 elsif ($expr =~ /^\s*\$arg\s*=/) {
1324 # We expect that $arg has refcnt >=1, so we need
1325 # to mortalize it. However, the extension may have
1326 # returned the built-in perl value, which is
1327 # read-only, thus not mortalizable. However, it is
1328 # safe to leave it as it is, since it would be
1329 # ignored by REFCNT_dec. Builtin values have REFCNT==0.
1330 eval "print qq\a$expr\a";
1331 print "\tif (SvREFCNT(ST(0))) sv_2mortal(ST(0));\n";
1334 # Just hope that the entry would safely write it
1335 # over an already mortalized value. By
1336 # coincidence, something like $arg = &sv_undef
1338 print "\tST(0) = sv_newmortal();\n";
1339 eval "print qq\a$expr\a";
1342 elsif ($arg =~ /^ST\(\d+\)$/) {
1343 eval "print qq\a$expr\a";
1352 $type =~ s/^array\(([^,]*),(.*)\).*/$1 */s;
1358 # If this is VMS, the exit status has meaning to the shell, so we
1359 # use a predictable value (SS$_Normal or SS$_Abort) rather than an
1361 # exit ($Is_VMS ? ($errors ? 44 : 1) : $errors) ;
1362 exit ($errors ? 1 : 0);