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>] [B<-perlobject>]... 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.
64 Compile code as C in a PERL_OBJECT environment.
70 No environment variables are used.
76 =head1 MODIFICATION HISTORY
78 See the file F<changes.pod>.
82 perl(1), perlxs(1), perlxstut(1)
88 use vars '$cplusplus';
96 $XSUBPP_version = "1.9506";
98 my ($Is_VMS, $SymSet);
101 # Establish set of global symbols with max length 28, since xsubpp
102 # will later add the 'XS_' prefix.
103 require ExtUtils::XSSymSet;
104 $SymSet = new ExtUtils::XSSymSet 28;
109 $usage = "Usage: xsubpp [-v] [-C++] [-except] [-prototypes] [-noversioncheck] [-nolinenumbers] [-s pattern] [-typemap typemap]... file.xs\n";
111 $proto_re = "[" . quotemeta('\$%&*@;') . "]" ;
113 $OBJ = 1 if $Config{'ccflags'} =~ /PERL_OBJECT/i;
116 $WantPrototypes = -1 ;
117 $WantVersionChk = 1 ;
119 $WantLineNumbers = 1 ;
120 SWITCH: while (@ARGV and $ARGV[0] =~ /^-./) {
123 $spat = quotemeta shift, next SWITCH if $flag eq 's';
124 $cplusplus = 1, next SWITCH if $flag eq 'C++';
125 $WantPrototypes = 0, next SWITCH if $flag eq 'noprototypes';
126 $WantPrototypes = 1, next SWITCH if $flag eq 'prototypes';
127 $WantVersionChk = 0, next SWITCH if $flag eq 'noversioncheck';
128 $WantVersionChk = 1, next SWITCH if $flag eq 'versioncheck';
129 $WantCAPI = 1, next SWITCH if $flag eq 'perlobject';
130 $except = " TRY", next SWITCH if $flag eq 'except';
131 push(@tm,shift), next SWITCH if $flag eq 'typemap';
132 $WantLineNumbers = 0, next SWITCH if $flag eq 'nolinenumbers';
133 $WantLineNumbers = 1, next SWITCH if $flag eq 'linenumbers';
134 (print "xsubpp version $XSUBPP_version\n"), exit
138 if ($WantPrototypes == -1)
139 { $WantPrototypes = 0}
144 @ARGV == 1 or die $usage;
145 ($dir, $filename) = $ARGV[0] =~ m#(.*)/(.*)#
146 or ($dir, $filename) = $ARGV[0] =~ m#(.*)\\(.*)#
147 or ($dir, $filename) = $ARGV[0] =~ m#(.*[>\]])(.*)#
148 or ($dir, $filename) = ('.', $ARGV[0]);
152 ++ $IncludedFiles{$ARGV[0]} ;
154 my(@XSStack) = ({type => 'none'}); # Stack of conditionals and INCLUDEs
155 my($XSS_work_idx, $cpp_next_tmp) = (0, "XSubPPtmpAAAA");
160 $_[0] =~ s/^\s+|\s+$//go ;
167 # rationalise any '*' by joining them into bunches and removing whitespace
171 # change multiple whitespace into a single space
174 # trim leading & trailing whitespace
180 $typemap = shift @ARGV;
181 foreach $typemap (@tm) {
182 die "Can't find $typemap in $pwd\n" unless -r $typemap;
184 unshift @tm, qw(../../../../lib/ExtUtils/typemap ../../../lib/ExtUtils/typemap
185 ../../lib/ExtUtils/typemap ../../../typemap ../../typemap
187 foreach $typemap (@tm) {
188 next unless -e $typemap ;
189 # skip directories, binary files etc.
190 warn("Warning: ignoring non-text typemap file '$typemap'\n"), next
192 open(TYPEMAP, $typemap)
193 or warn ("Warning: could not open typemap file '$typemap': $!\n"), next;
199 my $line_no = $. + 1;
200 if (/^INPUT\s*$/) { $mode = 'Input'; $current = \$junk; next; }
201 if (/^OUTPUT\s*$/) { $mode = 'Output'; $current = \$junk; next; }
202 if (/^TYPEMAP\s*$/) { $mode = 'Typemap'; $current = \$junk; next; }
203 if ($mode eq 'Typemap') {
207 # skip blank lines and comment lines
208 next if /^$/ or /^#/ ;
209 my($type,$kind, $proto) = /^\s*(.*?\S)\s+(\S+)\s*($proto_re*)\s*$/ or
210 warn("Warning: File '$typemap' Line $. '$line' TYPEMAP entry needs 2 or 3 columns\n"), next;
211 $type = TidyType($type) ;
212 $type_kind{$type} = $kind ;
213 # prototype defaults to '$'
214 $proto = "\$" unless $proto ;
215 warn("Warning: File '$typemap' Line $. '$line' Invalid prototype '$proto'\n")
216 unless ValidProtoString($proto) ;
217 $proto_letter{$type} = C_string($proto) ;
222 elsif ($mode eq 'Input') {
224 $input_expr{$_} = '';
225 $current = \$input_expr{$_};
229 $output_expr{$_} = '';
230 $current = \$output_expr{$_};
236 foreach $key (keys %input_expr) {
237 $input_expr{$key} =~ s/\n+$//;
240 $END = "!End!\n\n"; # "impossible" keyword (multiple newline)
242 # Match an XS keyword
243 $BLOCK_re= '\s*(' . join('|', qw(
244 REQUIRE BOOT CASE PREINIT INPUT INIT CODE PPCODE OUTPUT
245 CLEANUP ALIAS PROTOTYPES PROTOTYPE VERSIONCHECK INCLUDE
249 # Input: ($_, @line) == unparsed input.
250 # Output: ($_, @line) == (rest of line, following lines).
251 # Return: the matched keyword if found, otherwise 0
253 $_ = shift(@line) while !/\S/ && @line;
254 s/^(\s*)($_[0])\s*:\s*(?:#.*)?/$1/s && $2;
258 if ($WantLineNumbers) {
260 package xsubpp::counter;
262 my ($class, $cfile) = @_;
264 $SECTION_END_MARKER = "#line --- \"$cfile\"";
273 while ($$self =~ s/^([^\n]*\n)//) {
276 $line =~ s|^\#line\s+---(?=\s)|#line $line_no|;
285 $self->PRINT(sprintf($fmt, @_));
289 # Not necessary if we're careful to end with a "\n"
295 my $cfile = $filename;
296 $cfile =~ s/\.xs$/.c/i or $cfile .= ".c";
297 tie(*PSEUDO_STDOUT, 'xsubpp::counter', $cfile);
298 select PSEUDO_STDOUT;
302 # the "do" is required for right semantics
303 do { $_ = shift(@line) } while !/\S/ && @line;
305 print("#line ", $line_no[@line_no - @line -1], " \"$filename\"\n")
306 if $WantLineNumbers && !/^\s*#\s*line\b/ && !/^#if XSubPPtmp/;
307 for (; defined($_) && !/^$BLOCK_re/o; $_ = shift(@line)) {
310 print "$xsubpp::counter::SECTION_END_MARKER\n" if $WantLineNumbers;
313 sub process_keyword($)
318 &{"${kwd}_handler"}()
319 while $kwd = check_keyword($pattern) ;
323 blurt ("Error: `CASE:' after unconditional `CASE:'")
324 if $condnum && $cond eq '';
326 TrimWhitespace($cond);
327 print " ", ($condnum++ ? " else" : ""), ($cond ? " if ($cond)\n" : "\n");
332 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
333 last if /^\s*NOT_IMPLEMENTED_YET/;
334 next unless /\S/; # skip blank lines
339 # remove trailing semicolon if no initialisation
340 s/\s*;$//g unless /=/ ;
342 # check for optional initialisation code
344 $var_init = $1 if s/\s*(=.*)$//s ;
345 $var_init =~ s/"/\\"/g;
348 my ($var_type, $var_addr, $var_name) = /^(.*?[^& ]) *(\&?) *\b(\w+)$/s
349 or blurt("Error: invalid argument declaration '$line'"), next;
351 # Check for duplicate definitions
352 blurt ("Error: duplicate definition of argument '$var_name' ignored"), next
353 if $arg_list{$var_name} ++ ;
355 $thisdone |= $var_name eq "THIS";
356 $retvaldone |= $var_name eq "RETVAL";
357 $var_types{$var_name} = $var_type;
358 print "\t" . &map_type($var_type);
359 $var_num = $args_match{$var_name};
361 $proto_arg[$var_num] = ProtoString($var_type)
364 $var_addr{$var_name} = 1;
365 $func_args =~ s/\b($var_name)\b/&$1/;
367 if ($var_init =~ /^=\s*NO_INIT\s*;?\s*$/) {
368 print "\t$var_name;\n";
369 } elsif ($var_init =~ /\S/) {
370 &output_init($var_type, $var_num, "$var_name $var_init");
372 # generate initialization code
373 &generate_init($var_type, $var_num, $var_name);
381 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
383 if (/^\s*SETMAGIC\s*:\s*(ENABLE|DISABLE)\s*/) {
384 $DoSetMagic = ($1 eq "ENABLE" ? 1 : 0);
387 my ($outarg, $outcode) = /^\s*(\S+)\s*(.*?)\s*$/s ;
388 blurt ("Error: duplicate OUTPUT argument '$outarg' ignored"), next
389 if $outargs{$outarg} ++ ;
390 if (!$gotRETVAL and $outarg eq 'RETVAL') {
391 # deal with RETVAL last
392 $RETVAL_code = $outcode ;
396 blurt ("Error: OUTPUT $outarg not an argument"), next
397 unless defined($args_match{$outarg});
398 blurt("Error: No input definition for OUTPUT argument '$outarg' - ignored"), next
399 unless defined $var_types{$outarg} ;
400 $var_num = $args_match{$outarg};
402 print "\t$outcode\n";
403 print "\tSvSETMAGIC(ST(" , $var_num-1 , "));\n" if $DoSetMagic;
405 &generate_output($var_types{$outarg}, $var_num, $outarg, $DoSetMagic);
410 sub CLEANUP_handler() { print_section() }
411 sub PREINIT_handler() { print_section() }
412 sub INIT_handler() { print_section() }
421 # Parse alias definitions
423 # alias = value alias = value ...
425 while ($line =~ s/^\s*([\w:]+)\s*=\s*(\w+)\s*//) {
427 $orig_alias = $alias ;
430 # check for optional package definition in the alias
431 $alias = $Packprefix . $alias if $alias !~ /::/ ;
433 # check for duplicate alias name & duplicate value
434 Warn("Warning: Ignoring duplicate alias '$orig_alias'")
435 if defined $XsubAliases{$alias} ;
437 Warn("Warning: Aliases '$orig_alias' and '$XsubAliasValues{$value}' have identical values")
438 if $XsubAliasValues{$value} ;
441 $XsubAliases{$alias} = $value ;
442 $XsubAliasValues{$value} = $orig_alias ;
445 blurt("Error: Cannot parse ALIAS definitions from '$orig'")
451 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
454 GetAliases($_) if $_ ;
458 sub REQUIRE_handler ()
460 # the rest of the current line should contain a version number
463 TrimWhitespace($Ver) ;
465 death ("Error: REQUIRE expects a version number")
468 # check that the version number is of the form n.n
469 death ("Error: REQUIRE: expected a number, got '$Ver'")
470 unless $Ver =~ /^\d+(\.\d*)?/ ;
472 death ("Error: xsubpp $Ver (or better) required--this is only $XSUBPP_version.")
473 unless $XSUBPP_version >= $Ver ;
476 sub VERSIONCHECK_handler ()
478 # the rest of the current line should contain either ENABLE or
483 # check for ENABLE/DISABLE
484 death ("Error: VERSIONCHECK: ENABLE/DISABLE")
485 unless /^(ENABLE|DISABLE)/i ;
487 $WantVersionChk = 1 if $1 eq 'ENABLE' ;
488 $WantVersionChk = 0 if $1 eq 'DISABLE' ;
492 sub PROTOTYPE_handler ()
496 death("Error: Only 1 PROTOTYPE definition allowed per xsub")
497 if $proto_in_this_xsub ++ ;
499 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
503 if ($_ eq 'DISABLE') {
506 elsif ($_ eq 'ENABLE') {
510 # remove any whitespace
512 death("Error: Invalid prototype '$_'")
513 unless ValidProtoString($_) ;
514 $ProtoThisXSUB = C_string($_) ;
518 # If no prototype specified, then assume empty prototype ""
519 $ProtoThisXSUB = 2 unless $specified ;
527 death("Error: Only 1 SCOPE declaration allowed per xsub")
528 if $scope_in_this_xsub ++ ;
530 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
533 if ($_ =~ /^DISABLE/i) {
536 elsif ($_ =~ /^ENABLE/i) {
543 sub PROTOTYPES_handler ()
545 # the rest of the current line should contain either ENABLE or
550 # check for ENABLE/DISABLE
551 death ("Error: PROTOTYPES: ENABLE/DISABLE")
552 unless /^(ENABLE|DISABLE)/i ;
554 $WantPrototypes = 1 if $1 eq 'ENABLE' ;
555 $WantPrototypes = 0 if $1 eq 'DISABLE' ;
560 sub INCLUDE_handler ()
562 # the rest of the current line should contain a valid filename
566 death("INCLUDE: filename missing")
569 death("INCLUDE: output pipe is illegal")
572 # simple minded recursion detector
573 death("INCLUDE loop detected")
574 if $IncludedFiles{$_} ;
576 ++ $IncludedFiles{$_} unless /\|\s*$/ ;
578 # Save the current file context.
581 LastLine => $lastline,
582 LastLineNo => $lastline_no,
585 Filename => $filename,
592 open ($FH, "$_") or death("Cannot open '$_': $!") ;
596 #/* INCLUDE: Including '$_' from '$filename' */
602 # Prime the pump by reading the first
605 # skip leading blank lines
607 last unless /^\s*$/ ;
617 return 0 unless $XSStack[-1]{type} eq 'file' ;
619 my $data = pop @XSStack ;
620 my $ThisFile = $filename ;
621 my $isPipe = ($filename =~ /\|\s*$/) ;
623 -- $IncludedFiles{$filename}
628 $FH = $data->{Handle} ;
629 $filename = $data->{Filename} ;
630 $lastline = $data->{LastLine} ;
631 $lastline_no = $data->{LastLineNo} ;
632 @line = @{ $data->{Line} } ;
633 @line_no = @{ $data->{LineNo} } ;
635 if ($isPipe and $? ) {
637 print STDERR "Error reading from pipe '$ThisFile': $! in $filename, line $lastline_no\n" ;
643 #/* INCLUDE: Returning to '$filename' from '$ThisFile' */
650 sub ValidProtoString ($)
654 if ( $string =~ /^$proto_re+$/ ) {
665 $string =~ s[\\][\\\\]g ;
673 $proto_letter{$type} or "\$" ;
677 my @cpp = grep(/^\#\s*(?:if|e\w+)/, @line);
679 my ($cpp, $cpplevel);
681 if ($cpp =~ /^\#\s*if/) {
683 } elsif (!$cpplevel) {
684 Warn("Warning: #else/elif/endif without #if in this function");
685 print STDERR " (precede it with a blank line if the matching #if is outside the function)\n"
686 if $XSStack[-1]{type} eq 'if';
688 } elsif ($cpp =~ /^\#\s*endif/) {
692 Warn("Warning: #if without #endif in this function") if $cpplevel;
705 open($FH, $filename) or die "cannot open $filename: $!\n";
707 # Identify the version of xsubpp used
710 * This file was generated automatically by xsubpp version $XSUBPP_version from the
711 * contents of $filename. Do not edit this file, edit $filename instead.
713 * ANY CHANGES MADE HERE WILL BE LOST!
720 print("#line 1 \"$filename\"\n")
724 last if ($Module, $Package, $Prefix) =
725 /^MODULE\s*=\s*([\w:]+)(?:\s+PACKAGE\s*=\s*([\w:]+))?(?:\s+PREFIX\s*=\s*(\S+))?\s*$/;
728 s/#if(?:def|\s+defined)\s+(\(__cplusplus\)|__cplusplus)/#if defined(__cplusplus) && !defined(PERL_OBJECT)/;
732 &Exit unless defined $_;
737 # Read next xsub into @line from ($lastline, <$FH>).
740 death ("Error: Unterminated `#if/#ifdef/#ifndef'")
741 if !defined $lastline && $XSStack[-1]{type} eq 'if';
744 return PopFile() if !defined $lastline;
747 /^MODULE\s*=\s*([\w:]+)(?:\s+PACKAGE\s*=\s*([\w:]+))?(?:\s+PREFIX\s*=\s*(\S+))?\s*$/) {
749 $Package = defined($2) ? $2 : ''; # keep -w happy
750 $Prefix = defined($3) ? $3 : ''; # keep -w happy
751 $Prefix = quotemeta $Prefix ;
752 ($Module_cname = $Module) =~ s/\W/_/g;
753 ($Packid = $Package) =~ tr/:/_/;
754 $Packprefix = $Package;
755 $Packprefix .= "::" if $Packprefix ne "";
760 if ($lastline !~ /^\s*#/ ||
762 # ANSI: if ifdef ifndef elif else endif define undef
764 # gcc: warning include_next
766 # others: ident (gcc notes that some cpps have this one)
767 $lastline =~ /^#[ \t]*(?:(?:if|ifn?def|elif|else|endif|define|undef|pragma|error|warning|line\s+\d+|ident)\b|(?:include(?:_next)?|import)\s*["<].*[>"])/) {
768 last if $lastline =~ /^\S/ && @line && $line[-1] eq "";
769 push(@line, $lastline);
770 push(@line_no, $lastline_no) ;
773 # Read next line and continuation lines
774 last unless defined($lastline = <$FH>);
777 $lastline .= $tmp_line
778 while ($lastline =~ /\\$/ && defined($tmp_line = <$FH>));
781 $lastline =~ s/^\s+$//;
783 pop(@line), pop(@line_no) while @line && $line[-1] eq "";
788 while (fetch_para()) {
789 # Print initial preprocessor statements and blank lines
790 while (@line && $line[0] !~ /^[^\#]/) {
791 my $line = shift(@line);
793 next unless $line =~ /^\#\s*((if)(?:n?def)?|elsif|else|endif)\b/;
795 if ($statement eq 'if') {
796 $XSS_work_idx = @XSStack;
797 push(@XSStack, {type => 'if'});
799 death ("Error: `$statement' with no matching `if'")
800 if $XSStack[-1]{type} ne 'if';
801 if ($XSStack[-1]{varname}) {
802 push(@InitFileCode, "#endif\n");
803 push(@BootCode, "#endif");
806 my(@fns) = keys %{$XSStack[-1]{functions}};
807 if ($statement ne 'endif') {
808 # Hide the functions defined in other #if branches, and reset.
809 @{$XSStack[-1]{other_functions}}{@fns} = (1) x @fns;
810 @{$XSStack[-1]}{qw(varname functions)} = ('', {});
812 my($tmp) = pop(@XSStack);
813 0 while (--$XSS_work_idx
814 && $XSStack[$XSS_work_idx]{type} ne 'if');
815 # Keep all new defined functions
816 push(@fns, keys %{$tmp->{other_functions}});
817 @{$XSStack[$XSS_work_idx]{functions}}{@fns} = (1) x @fns;
822 next PARAGRAPH unless @line;
824 if ($XSS_work_idx && !$XSStack[$XSS_work_idx]{varname}) {
825 # We are inside an #if, but have not yet #defined its xsubpp variable.
826 print "#define $cpp_next_tmp 1\n\n";
827 push(@InitFileCode, "#if $cpp_next_tmp\n");
828 push(@BootCode, "#if $cpp_next_tmp");
829 $XSStack[$XSS_work_idx]{varname} = $cpp_next_tmp++;
832 death ("Code is not inside a function"
833 ." (maybe last function was ended by a blank line "
834 ." followed by a a statement on column one?)")
835 if $line[0] =~ /^\s/;
837 # initialize info arrays
848 undef($proto_in_this_xsub) ;
849 undef($scope_in_this_xsub) ;
850 $ProtoThisXSUB = $WantPrototypes ;
854 while ($kwd = check_keyword("REQUIRE|PROTOTYPES|VERSIONCHECK|INCLUDE")) {
855 &{"${kwd}_handler"}() ;
856 next PARAGRAPH unless @line ;
860 if (check_keyword("BOOT")) {
862 push (@BootCode, "#line $line_no[@line_no - @line] \"$filename\"")
863 if $WantLineNumbers && $line[0] !~ /^\s*#\s*line\b/;
864 push (@BootCode, @line, "") ;
869 # extract return type, function name and arguments
870 my($ret_type) = TidyType($_);
872 # a function definition needs at least 2 lines
873 blurt ("Error: Function definition too short '$ret_type'"), next PARAGRAPH
876 $static = 1 if $ret_type =~ s/^static\s+//;
878 $func_header = shift(@line);
879 blurt ("Error: Cannot parse function definition from '$func_header'"), next PARAGRAPH
880 unless $func_header =~ /^(?:([\w:]*)::)?(\w+)\s*\(\s*(.*?)\s*\)\s*$/s;
882 ($class, $func_name, $orig_args) = ($1, $2, $3) ;
883 ($pname = $func_name) =~ s/^($Prefix)?/$Packprefix/;
884 ($clean_func_name = $func_name) =~ s/^$Prefix//;
885 $Full_func_name = "${Packid}_$clean_func_name";
886 if ($Is_VMS) { $Full_func_name = $SymSet->addsym($Full_func_name); }
888 # Check for duplicate function definition
889 for $tmp (@XSStack) {
890 next unless defined $tmp->{functions}{$Full_func_name};
891 Warn("Warning: duplicate function definition '$clean_func_name' detected");
894 $XSStack[$XSS_work_idx]{functions}{$Full_func_name} ++ ;
895 %XsubAliases = %XsubAliasValues = ();
898 @args = split(/\s*,\s*/, $orig_args);
899 if (defined($class)) {
900 my $arg0 = ((defined($static) or $func_name eq 'new')
902 unshift(@args, $arg0);
903 ($orig_args = "$arg0, $orig_args") =~ s/^$arg0, $/$arg0/;
905 $orig_args =~ s/"/\\"/g;
906 $min_args = $num_args = @args;
907 foreach $i (0..$num_args-1) {
908 if ($args[$i] =~ s/\.\.\.//) {
911 if ($args[$i] eq '' && $i == $num_args - 1) {
916 if ($args[$i] =~ /^([^=]*[^\s=])\s*=\s*(.*)/s) {
919 $defaults{$args[$i]} = $2;
920 $defaults{$args[$i]} =~ s/"/\\"/g;
922 $proto_arg[$i+1] = "\$" ;
924 if (defined($class)) {
925 $func_args = join(", ", @args[1..$#args]);
927 $func_args = join(", ", @args);
929 @args_match{@args} = 1..@args;
931 $PPCODE = grep(/^\s*PPCODE\s*:/, @line);
932 $CODE = grep(/^\s*CODE\s*:/, @line);
933 # Detect CODE: blocks which use ST(n)= or XST_m*(n,v)
934 # to set explicit return values.
935 $EXPLICIT_RETURN = ($CODE &&
936 ("@line" =~ /(\bST\s*\([^;]*=) | (\bXST_m\w+\s*\()/x ));
937 $ALIAS = grep(/^\s*ALIAS\s*:/, @line);
939 # print function header
941 #XS(XS_${Full_func_name})
945 print Q<<"EOF" if $ALIAS ;
949 $cond = ($min_args ? qq(items < $min_args) : 0);
951 elsif ($min_args == $num_args) {
952 $cond = qq(items != $min_args);
955 $cond = qq(items < $min_args || items > $num_args);
958 print Q<<"EOF" if $except;
964 { print Q<<"EOF" if $cond }
966 # croak("Usage: %s($orig_args)", GvNAME(CvGV(cv)));
969 { print Q<<"EOF" if $cond }
971 # croak("Usage: $pname($orig_args)");
974 print Q<<"EOF" if $PPCODE;
978 # Now do a block of some sort.
981 $cond = ''; # last CASE: condidional
982 push(@line, "$END:");
983 push(@line_no, $line_no[-1]);
987 &CASE_handler if check_keyword("CASE");
992 # do initialization of input variables
1000 process_keyword("INPUT|PREINIT|ALIAS|PROTOTYPE|SCOPE") ;
1002 print Q<<"EOF" if $ScopeThisXSUB;
1007 if (!$thisdone && defined($class)) {
1008 if (defined($static) or $func_name eq 'new') {
1010 $var_types{"CLASS"} = "char *";
1011 &generate_init("char *", 1, "CLASS");
1015 $var_types{"THIS"} = "$class *";
1016 &generate_init("$class *", 1, "THIS");
1021 if (/^\s*NOT_IMPLEMENTED_YET/) {
1022 print "\n\tcroak(\"$pname: not implemented yet\");\n";
1025 if ($ret_type ne "void") {
1026 print "\t" . &map_type($ret_type) . "\tRETVAL;\n"
1028 $args_match{"RETVAL"} = 0;
1029 $var_types{"RETVAL"} = $ret_type;
1034 process_keyword("INIT|ALIAS|PROTOTYPE") ;
1036 if (check_keyword("PPCODE")) {
1038 death ("PPCODE must be last thing") if @line;
1039 print "\tLEAVE;\n" if $ScopeThisXSUB;
1040 print "\tPUTBACK;\n\treturn;\n";
1041 } elsif (check_keyword("CODE")) {
1043 } elsif (defined($class) and $func_name eq "DESTROY") {
1045 print "delete THIS;\n";
1048 if ($ret_type ne "void") {
1052 if (defined($static)) {
1053 if ($func_name eq 'new') {
1054 $func_name = "$class";
1058 } elsif (defined($class)) {
1059 if ($func_name eq 'new') {
1060 $func_name .= " $class";
1065 $func_name =~ s/^($spat)//
1067 print "$func_name($func_args);\n";
1071 # do output variables
1073 undef $RETVAL_code ;
1075 process_keyword("OUTPUT|ALIAS|PROTOTYPE");
1077 # all OUTPUT done, so now push the return value on the stack
1078 if ($gotRETVAL && $RETVAL_code) {
1079 print "\t$RETVAL_code\n";
1080 } elsif ($gotRETVAL || $wantRETVAL) {
1081 # RETVAL almost never needs SvSETMAGIC()
1082 &generate_output($ret_type, 0, 'RETVAL', 0);
1086 process_keyword("CLEANUP|ALIAS|PROTOTYPE") ;
1088 print Q<<"EOF" if $ScopeThisXSUB;
1091 print Q<<"EOF" if $ScopeThisXSUB and not $PPCODE;
1095 # print function trailer
1099 print Q<<EOF if $except;
1102 # sprintf(errbuf, "%s: %s\\tpropagated", Xname, Xreason);
1105 if (check_keyword("CASE")) {
1106 blurt ("Error: No `CASE:' at top of function")
1108 $_ = "CASE: $_"; # Restore CASE: label
1111 last if $_ eq "$END:";
1112 death(/^$BLOCK_re/o ? "Misplaced `$1:'" : "Junk at end of function");
1115 print Q<<EOF if $except;
1120 if ($ret_type ne "void" or $EXPLICIT_RETURN) {
1121 print Q<<EOF unless $PPCODE;
1125 print Q<<EOF unless $PPCODE;
1135 my $newXS = "newXS" ;
1138 # Build the prototype string for the xsub
1139 if ($ProtoThisXSUB) {
1140 $newXS = "newXSproto";
1142 if ($ProtoThisXSUB eq 2) {
1143 # User has specified empty prototype
1146 elsif ($ProtoThisXSUB ne 1) {
1147 # User has specified a prototype
1148 $proto = ', "' . $ProtoThisXSUB . '"';
1152 if ($min_args < $num_args) {
1154 $proto_arg[$min_args] .= ";" ;
1156 push @proto_arg, "$s\@"
1159 $proto = ', "' . join ("", @proto_arg) . '"';
1164 $XsubAliases{$pname} = 0
1165 unless defined $XsubAliases{$pname} ;
1166 while ( ($name, $value) = each %XsubAliases) {
1167 push(@InitFileCode, Q<<"EOF");
1168 # cv = newXS(\"$name\", XS_$Full_func_name, file);
1169 # XSANY.any_i32 = $value ;
1171 push(@InitFileCode, Q<<"EOF") if $proto;
1172 # sv_setpv((SV*)cv$proto) ;
1178 " ${newXS}(\"$pname\", XS_$Full_func_name, file$proto);\n");
1182 # print initialization routine
1189 #XS(boot__CAPI_entry)
1192 # char* file = __FILE__;
1200 #XS(boot_$Module_cname)
1203 # char* file = __FILE__;
1208 print Q<<"EOF" if $WantVersionChk ;
1209 # XS_VERSION_BOOTCHECK ;
1213 print Q<<"EOF" if defined $XsubAliases ;
1219 print @InitFileCode;
1221 print Q<<"EOF" if defined $XsubAliases ;
1227 print "\n /* Initialisation Section */\n\n" ;
1230 print "\n /* End of Initialisation Section */\n\n" ;
1243 ##define XSCAPI(name) void name(void* pPerl, CV* cv)
1247 #XSCAPI(boot_$Module_cname)
1249 # SetCPerlObj(pPerl);
1250 # boot__CAPI_entry(cv);
1256 warn("Please specify prototyping behavior for $filename (see perlxs manual)\n")
1262 local($type, $num, $init) = @_;
1263 local($arg) = "ST(" . ($num - 1) . ")";
1265 eval qq/print " $init\\\n"/;
1270 # work out the line number
1271 my $line_no = $line_no[@line_no - @line -1] ;
1273 print STDERR "@_ in $filename, line $line_no\n" ;
1289 local($type, $num, $var) = @_;
1290 local($arg) = "ST(" . ($num - 1) . ")";
1291 local($argoff) = $num - 1;
1295 $type = TidyType($type) ;
1296 blurt("Error: '$type' not in typemap"), return
1297 unless defined($type_kind{$type});
1299 ($ntype = $type) =~ s/\s*\*/Ptr/g;
1300 ($subtype = $ntype) =~ s/(?:Array)?(?:Ptr)?$//;
1301 $tk = $type_kind{$type};
1302 $tk =~ s/OBJ$/REF/ if $func_name =~ /DESTROY$/;
1304 blurt("Error: No INPUT definition for type '$type' found"), return
1305 unless defined $input_expr{$tk} ;
1306 $expr = $input_expr{$tk};
1307 if ($expr =~ /DO_ARRAY_ELEM/) {
1308 blurt("Error: '$subtype' not in typemap"), return
1309 unless defined($type_kind{$subtype});
1310 blurt("Error: No INPUT definition for type '$subtype' found"), return
1311 unless defined $input_expr{$type_kind{$subtype}} ;
1312 $subexpr = $input_expr{$type_kind{$subtype}};
1313 $subexpr =~ s/ntype/subtype/g;
1314 $subexpr =~ s/\$arg/ST(ix_$var)/g;
1315 $subexpr =~ s/\n\t/\n\t\t/g;
1316 $subexpr =~ s/is not of (.*\")/[arg %d] is not of $1, ix_$var + 1/g;
1317 $subexpr =~ s/\$var/${var}[ix_$var - $argoff]/;
1318 $expr =~ s/DO_ARRAY_ELEM/$subexpr/;
1320 if ($expr =~ m#/\*.*scope.*\*/#i) { # "scope" in C comments
1323 if (defined($defaults{$var})) {
1324 $expr =~ s/(\t+)/$1 /g;
1326 eval qq/print "\\t$var;\\n"/;
1327 $deferred .= eval qq/"\\n\\tif (items < $num)\\n\\t $var = $defaults{$var};\\n\\telse {\\n$expr;\\n\\t}\\n"/;
1328 } elsif ($ScopeThisXSUB or $expr !~ /^\t\$var =/) {
1329 eval qq/print "\\t$var;\\n"/;
1330 $deferred .= eval qq/"\\n$expr;\\n"/;
1332 eval qq/print "$expr;\\n"/;
1336 sub generate_output {
1337 local($type, $num, $var, $do_setmagic) = @_;
1338 local($arg) = "ST(" . ($num - ($num != 0)) . ")";
1339 local($argoff) = $num - 1;
1342 $type = TidyType($type) ;
1343 if ($type =~ /^array\(([^,]*),(.*)\)/) {
1344 print "\tsv_setpvn($arg, (char *)$var, $2 * sizeof($1)), XFree((char *)$var);\n";
1345 print "\tSvSETMAGIC($arg);\n" if $do_setmagic;
1347 blurt("Error: '$type' not in typemap"), return
1348 unless defined($type_kind{$type});
1349 blurt("Error: No OUTPUT definition for type '$type' found"), return
1350 unless defined $output_expr{$type_kind{$type}} ;
1351 ($ntype = $type) =~ s/\s*\*/Ptr/g;
1352 $ntype =~ s/\(\)//g;
1353 ($subtype = $ntype) =~ s/(?:Array)?(?:Ptr)?$//;
1354 $expr = $output_expr{$type_kind{$type}};
1355 if ($expr =~ /DO_ARRAY_ELEM/) {
1356 blurt("Error: '$subtype' not in typemap"), return
1357 unless defined($type_kind{$subtype});
1358 blurt("Error: No OUTPUT definition for type '$subtype' found"), return
1359 unless defined $output_expr{$type_kind{$subtype}} ;
1360 $subexpr = $output_expr{$type_kind{$subtype}};
1361 $subexpr =~ s/ntype/subtype/g;
1362 $subexpr =~ s/\$arg/ST(ix_$var)/g;
1363 $subexpr =~ s/\$var/${var}[ix_$var]/g;
1364 $subexpr =~ s/\n\t/\n\t\t/g;
1365 $expr =~ s/DO_ARRAY_ELEM\n/$subexpr/;
1366 eval "print qq\a$expr\a";
1367 print "\t\tSvSETMAGIC(ST(ix_$var));\n" if $do_setmagic;
1369 elsif ($var eq 'RETVAL') {
1370 if ($expr =~ /^\t\$arg = new/) {
1371 # We expect that $arg has refcnt 1, so we need to
1373 eval "print qq\a$expr\a";
1374 print "\tsv_2mortal(ST(0));\n";
1375 print "\tSvSETMAGIC(ST(0));\n" if $do_setmagic;
1377 elsif ($expr =~ /^\s*\$arg\s*=/) {
1378 # We expect that $arg has refcnt >=1, so we need
1379 # to mortalize it. However, the extension may have
1380 # returned the built-in perl value, which is
1381 # read-only, thus not mortalizable. However, it is
1382 # safe to leave it as it is, since it would be
1383 # ignored by REFCNT_dec. Builtin values have REFCNT==0.
1384 eval "print qq\a$expr\a";
1385 print "\tif (SvREFCNT(ST(0))) sv_2mortal(ST(0));\n";
1386 print "\tSvSETMAGIC(ST(0));\n" if $do_setmagic;
1389 # Just hope that the entry would safely write it
1390 # over an already mortalized value. By
1391 # coincidence, something like $arg = &sv_undef
1393 print "\tST(0) = sv_newmortal();\n";
1394 eval "print qq\a$expr\a";
1395 # new mortals don't have set magic
1398 elsif ($arg =~ /^ST\(\d+\)$/) {
1399 eval "print qq\a$expr\a";
1400 print "\tSvSETMAGIC($arg);\n" if $do_setmagic;
1409 $type =~ s/^array\(([^,]*),(.*)\).*/$1 */s;
1415 # If this is VMS, the exit status has meaning to the shell, so we
1416 # use a predictable value (SS$_Normal or SS$_Abort) rather than an
1418 # exit ($Is_VMS ? ($errors ? 44 : 1) : $errors) ;
1419 exit ($errors ? 1 : 0);