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<-nooptimize>] [B<-typemap typemap>] ... file.xs
13 This compiler is typically run by the makefiles created by L<ExtUtils::MakeMaker>.
15 I<xsubpp> will compile XS code into C code by embedding the constructs
16 necessary to let C functions manipulate Perl values and creates the glue
17 necessary to let Perl access those functions. The compiler uses typemaps to
18 determine how to map C function parameters and variables to Perl values.
20 The compiler will search for typemap files called I<typemap>. It will use
21 the following search path to find default typemaps, with the rightmost
22 typemap taking precedence.
24 ../../../typemap:../../typemap:../typemap:typemap
28 Note that the C<XSOPT> MakeMaker option may be used to add these options to
29 any makefiles generated by MakeMaker.
35 Adds ``extern "C"'' to the C code.
39 Adds exception handling stubs to the C code.
41 =item B<-typemap typemap>
43 Indicates that a user-supplied typemap should take precedence over the
44 default typemaps. This option may be used multiple times, with the last
45 typemap having the highest precedence.
49 Prints the I<xsubpp> version number to standard output, then exits.
53 By default I<xsubpp> will not automatically generate prototype code for
54 all xsubs. This flag will enable prototypes.
56 =item B<-noversioncheck>
58 Disables the run time test that determines if the object file (derived
59 from the C<.xs> file) and the C<.pm> files have the same version
62 =item B<-nolinenumbers>
64 Prevents the inclusion of `#line' directives in the output.
68 Disables certain optimizations. The only optimization that is currently
69 affected is the use of I<target>s by the output C code (see L<perlguts>).
70 This may significantly slow down the generated code, but this is the way
71 B<xsubpp> of 5.005 and earlier operated.
75 Disable recognition of C<IN>, C<OUT_LIST> and C<INOUT_LIST> declarations.
79 Disable recognition of ANSI-like descriptions of function signature.
85 No environment variables are used.
91 =head1 MODIFICATION HISTORY
93 See the file F<changes.pod>.
97 perl(1), perlxs(1), perlxstut(1)
103 use vars '$cplusplus';
112 $XSUBPP_version = "1.9507";
114 my ($Is_VMS, $SymSet);
117 # Establish set of global symbols with max length 28, since xsubpp
118 # will later add the 'XS_' prefix.
119 require ExtUtils::XSSymSet;
120 $SymSet = new ExtUtils::XSSymSet 28;
125 $usage = "Usage: xsubpp [-v] [-C++] [-except] [-prototypes] [-noversioncheck] [-nolinenumbers] [-nooptimize] [-noinout] [-noargtypes] [-s pattern] [-typemap typemap]... file.xs\n";
127 $proto_re = "[" . quotemeta('\$%&*@;') . "]" ;
129 $OBJ = 1 if $Config{'ccflags'} =~ /PERL_OBJECT/i;
132 $WantPrototypes = -1 ;
133 $WantVersionChk = 1 ;
135 $WantLineNumbers = 1 ;
138 my $process_inout = 1;
139 my $process_argtypes = 1;
141 SWITCH: while (@ARGV and $ARGV[0] =~ /^-./) {
144 $spat = quotemeta shift, next SWITCH if $flag eq 's';
145 $cplusplus = 1, next SWITCH if $flag eq 'C++';
146 $WantPrototypes = 0, next SWITCH if $flag eq 'noprototypes';
147 $WantPrototypes = 1, next SWITCH if $flag eq 'prototypes';
148 $WantVersionChk = 0, next SWITCH if $flag eq 'noversioncheck';
149 $WantVersionChk = 1, next SWITCH if $flag eq 'versioncheck';
150 # XXX left this in for compat
151 $WantCAPI = 1, next SWITCH if $flag eq 'object_capi';
152 $except = " TRY", next SWITCH if $flag eq 'except';
153 push(@tm,shift), next SWITCH if $flag eq 'typemap';
154 $WantLineNumbers = 0, next SWITCH if $flag eq 'nolinenumbers';
155 $WantLineNumbers = 1, next SWITCH if $flag eq 'linenumbers';
156 $WantOptimize = 0, next SWITCH if $flag eq 'nooptimize';
157 $WantOptimize = 1, next SWITCH if $flag eq 'optimize';
158 $process_inout = 0, next SWITCH if $flag eq 'noinout';
159 $process_inout = 1, next SWITCH if $flag eq 'inout';
160 $process_argtypes = 0, next SWITCH if $flag eq 'noargtypes';
161 $process_argtypes = 1, next SWITCH if $flag eq 'argtypes';
162 (print "xsubpp version $XSUBPP_version\n"), exit
166 if ($WantPrototypes == -1)
167 { $WantPrototypes = 0}
172 @ARGV == 1 or die $usage;
173 ($dir, $filename) = $ARGV[0] =~ m#(.*)/(.*)#
174 or ($dir, $filename) = $ARGV[0] =~ m#(.*)\\(.*)#
175 or ($dir, $filename) = $ARGV[0] =~ m#(.*[>\]])(.*)#
176 or ($dir, $filename) = ('.', $ARGV[0]);
180 ++ $IncludedFiles{$ARGV[0]} ;
182 my(@XSStack) = ({type => 'none'}); # Stack of conditionals and INCLUDEs
183 my($XSS_work_idx, $cpp_next_tmp) = (0, "XSubPPtmpAAAA");
188 $_[0] =~ s/^\s+|\s+$//go ;
195 # rationalise any '*' by joining them into bunches and removing whitespace
199 # change multiple whitespace into a single space
202 # trim leading & trailing whitespace
208 $typemap = shift @ARGV;
209 foreach $typemap (@tm) {
210 die "Can't find $typemap in $pwd\n" unless -r $typemap;
212 unshift @tm, qw(../../../../lib/ExtUtils/typemap ../../../lib/ExtUtils/typemap
213 ../../lib/ExtUtils/typemap ../../../typemap ../../typemap
215 foreach $typemap (@tm) {
216 next unless -e $typemap ;
217 # skip directories, binary files etc.
218 warn("Warning: ignoring non-text typemap file '$typemap'\n"), next
220 open(TYPEMAP, $typemap)
221 or warn ("Warning: could not open typemap file '$typemap': $!\n"), next;
227 my $line_no = $. + 1;
228 if (/^INPUT\s*$/) { $mode = 'Input'; $current = \$junk; next; }
229 if (/^OUTPUT\s*$/) { $mode = 'Output'; $current = \$junk; next; }
230 if (/^TYPEMAP\s*$/) { $mode = 'Typemap'; $current = \$junk; next; }
231 if ($mode eq 'Typemap') {
235 # skip blank lines and comment lines
236 next if /^$/ or /^#/ ;
237 my($type,$kind, $proto) = /^\s*(.*?\S)\s+(\S+)\s*($proto_re*)\s*$/ or
238 warn("Warning: File '$typemap' Line $. '$line' TYPEMAP entry needs 2 or 3 columns\n"), next;
239 $type = TidyType($type) ;
240 $type_kind{$type} = $kind ;
241 # prototype defaults to '$'
242 $proto = "\$" unless $proto ;
243 warn("Warning: File '$typemap' Line $. '$line' Invalid prototype '$proto'\n")
244 unless ValidProtoString($proto) ;
245 $proto_letter{$type} = C_string($proto) ;
250 elsif ($mode eq 'Input') {
252 $input_expr{$_} = '';
253 $current = \$input_expr{$_};
257 $output_expr{$_} = '';
258 $current = \$output_expr{$_};
264 foreach $key (keys %input_expr) {
265 $input_expr{$key} =~ s/\n+$//;
268 $bal = qr[(?:(?>[^()]+)|\((??{ $bal })\))*]; # ()-balanced
269 $cast = qr[(?:\(\s*SV\s*\*\s*\)\s*)?]; # Optional (SV*) cast
270 $size = qr[,\s* (??{ $bal }) ]x; # Third arg (to setpvn)
272 foreach $key (keys %output_expr) {
275 my ($t, $with_size, $arg, $sarg) =
276 ($output_expr{$key} =~
277 m[^ \s+ sv_set ( [iunp] ) v (n)? # Type, is_setpvn
278 \s* \( \s* $cast \$arg \s* ,
279 \s* ( (??{ $bal }) ) # Set from
280 ( (??{ $size }) )? # Possible sizeof set-from
283 $targetable{$key} = [$t, $with_size, $arg, $sarg] if $t;
286 $END = "!End!\n\n"; # "impossible" keyword (multiple newline)
288 # Match an XS keyword
289 $BLOCK_re= '\s*(' . join('|', qw(
290 REQUIRE BOOT CASE PREINIT INPUT INIT CODE PPCODE OUTPUT
291 CLEANUP ALIAS PROTOTYPES PROTOTYPE VERSIONCHECK INCLUDE
292 SCOPE INTERFACE INTERFACE_MACRO C_ARGS POSTCALL
295 # Input: ($_, @line) == unparsed input.
296 # Output: ($_, @line) == (rest of line, following lines).
297 # Return: the matched keyword if found, otherwise 0
299 $_ = shift(@line) while !/\S/ && @line;
300 s/^(\s*)($_[0])\s*:\s*(?:#.*)?/$1/s && $2;
303 my ($C_group_rex, $C_arg);
304 # Group in C (no support for comments or literals)
305 $C_group_rex = qr/ [({\[]
306 (?: (?> [^()\[\]{}]+ ) | (??{ $C_group_rex }) )*
308 # Chunk in C without comma at toplevel (no comments):
309 $C_arg = qr/ (?: (?> [^()\[\]{},"']+ )
310 | (??{ $C_group_rex })
311 | " (?: (?> [^\\"]+ )
313 )* " # String literal
314 | ' (?: (?> [^\\']+ ) | \\. )* ' # Char literal
317 if ($WantLineNumbers) {
319 package xsubpp::counter;
321 my ($class, $cfile) = @_;
323 $SECTION_END_MARKER = "#line --- \"$cfile\"";
332 while ($$self =~ s/^([^\n]*\n)//) {
335 $line =~ s|^\#line\s+---(?=\s)|#line $line_no|;
344 $self->PRINT(sprintf($fmt, @_));
348 # Not necessary if we're careful to end with a "\n"
354 my $cfile = $filename;
355 $cfile =~ s/\.xs$/.c/i or $cfile .= ".c";
356 tie(*PSEUDO_STDOUT, 'xsubpp::counter', $cfile);
357 select PSEUDO_STDOUT;
361 # the "do" is required for right semantics
362 do { $_ = shift(@line) } while !/\S/ && @line;
364 print("#line ", $line_no[@line_no - @line -1], " \"$filename\"\n")
365 if $WantLineNumbers && !/^\s*#\s*line\b/ && !/^#if XSubPPtmp/;
366 for (; defined($_) && !/^$BLOCK_re/o; $_ = shift(@line)) {
369 print "$xsubpp::counter::SECTION_END_MARKER\n" if $WantLineNumbers;
375 while (!/\S/ && @line) {
379 for (; defined($_) && !/^$BLOCK_re/o; $_ = shift(@line)) {
386 sub process_keyword($)
391 &{"${kwd}_handler"}()
392 while $kwd = check_keyword($pattern) ;
396 blurt ("Error: `CASE:' after unconditional `CASE:'")
397 if $condnum && $cond eq '';
399 TrimWhitespace($cond);
400 print " ", ($condnum++ ? " else" : ""), ($cond ? " if ($cond)\n" : "\n");
405 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
406 last if /^\s*NOT_IMPLEMENTED_YET/;
407 next unless /\S/; # skip blank lines
412 # remove trailing semicolon if no initialisation
413 s/\s*;$//g unless /[=;+].*\S/ ;
415 # check for optional initialisation code
417 $var_init = $1 if s/\s*([=;+].*)$//s ;
418 $var_init =~ s/"/\\"/g;
421 my ($var_type, $var_addr, $var_name) = /^(.*?[^& ]) *(\&?) *\b(\w+)$/s
422 or blurt("Error: invalid argument declaration '$line'"), next;
424 # Check for duplicate definitions
425 blurt ("Error: duplicate definition of argument '$var_name' ignored"), next
426 if $arg_list{$var_name}++
427 or defined $arg_types{$var_name} and not $processing_arg_with_types;
429 $thisdone |= $var_name eq "THIS";
430 $retvaldone |= $var_name eq "RETVAL";
431 $var_types{$var_name} = $var_type;
432 # XXXX This check is a safeguard against the unfinished conversion of
433 # generate_init(). When generate_init() is fixed,
434 # one can use 2-args map_type() unconditionally.
435 if ($var_type =~ / \( \s* \* \s* \) /x) {
436 # Function pointers are not yet supported with &output_init!
437 print "\t" . &map_type($var_type, $var_name);
440 print "\t" . &map_type($var_type);
443 $var_num = $args_match{$var_name};
445 $proto_arg[$var_num] = ProtoString($var_type)
448 $var_addr{$var_name} = 1;
449 $func_args =~ s/\b($var_name)\b/&$1/;
451 if ($var_init =~ /^[=;]\s*NO_INIT\s*;?\s*$/
452 or $in_out{$var_name} and $in_out{$var_name} eq 'OUTLIST'
453 and $var_init !~ /\S/) {
457 print "\t$var_name;\n";
459 } elsif ($var_init =~ /\S/) {
460 &output_init($var_type, $var_num, $var_name, $var_init, $name_printed);
462 # generate initialization code
463 &generate_init($var_type, $var_num, $var_name, $name_printed);
471 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
473 if (/^\s*SETMAGIC\s*:\s*(ENABLE|DISABLE)\s*/) {
474 $DoSetMagic = ($1 eq "ENABLE" ? 1 : 0);
477 my ($outarg, $outcode) = /^\s*(\S+)\s*(.*?)\s*$/s ;
478 blurt ("Error: duplicate OUTPUT argument '$outarg' ignored"), next
479 if $outargs{$outarg} ++ ;
480 if (!$gotRETVAL and $outarg eq 'RETVAL') {
481 # deal with RETVAL last
482 $RETVAL_code = $outcode ;
486 blurt ("Error: OUTPUT $outarg not an argument"), next
487 unless defined($args_match{$outarg});
488 blurt("Error: No input definition for OUTPUT argument '$outarg' - ignored"), next
489 unless defined $var_types{$outarg} ;
490 $var_num = $args_match{$outarg};
492 print "\t$outcode\n";
493 print "\tSvSETMAGIC(ST(" , $var_num-1 , "));\n" if $DoSetMagic;
495 &generate_output($var_types{$outarg}, $var_num, $outarg, $DoSetMagic);
500 sub C_ARGS_handler() {
501 my $in = merge_section();
507 sub INTERFACE_MACRO_handler() {
508 my $in = merge_section();
511 if ($in =~ /\s/) { # two
512 ($interface_macro, $interface_macro_set) = split ' ', $in;
514 $interface_macro = $in;
515 $interface_macro_set = 'UNKNOWN_CVT'; # catch later
517 $interface = 1; # local
518 $Interfaces = 1; # global
521 sub INTERFACE_handler() {
522 my $in = merge_section();
526 foreach (split /[\s,]+/, $in) {
527 $Interfaces{$_} = $_;
530 # XSFUNCTION = $interface_macro($ret_type,cv,XSANY.any_dptr);
532 $interface = 1; # local
533 $Interfaces = 1; # global
536 sub CLEANUP_handler() { print_section() }
537 sub PREINIT_handler() { print_section() }
538 sub POSTCALL_handler() { print_section() }
539 sub INIT_handler() { print_section() }
548 # Parse alias definitions
550 # alias = value alias = value ...
552 while ($line =~ s/^\s*([\w:]+)\s*=\s*(\w+)\s*//) {
554 $orig_alias = $alias ;
557 # check for optional package definition in the alias
558 $alias = $Packprefix . $alias if $alias !~ /::/ ;
560 # check for duplicate alias name & duplicate value
561 Warn("Warning: Ignoring duplicate alias '$orig_alias'")
562 if defined $XsubAliases{$alias} ;
564 Warn("Warning: Aliases '$orig_alias' and '$XsubAliasValues{$value}' have identical values")
565 if $XsubAliasValues{$value} ;
568 $XsubAliases{$alias} = $value ;
569 $XsubAliasValues{$value} = $orig_alias ;
572 blurt("Error: Cannot parse ALIAS definitions from '$orig'")
578 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
581 GetAliases($_) if $_ ;
585 sub REQUIRE_handler ()
587 # the rest of the current line should contain a version number
590 TrimWhitespace($Ver) ;
592 death ("Error: REQUIRE expects a version number")
595 # check that the version number is of the form n.n
596 death ("Error: REQUIRE: expected a number, got '$Ver'")
597 unless $Ver =~ /^\d+(\.\d*)?/ ;
599 death ("Error: xsubpp $Ver (or better) required--this is only $XSUBPP_version.")
600 unless $XSUBPP_version >= $Ver ;
603 sub VERSIONCHECK_handler ()
605 # the rest of the current line should contain either ENABLE or
610 # check for ENABLE/DISABLE
611 death ("Error: VERSIONCHECK: ENABLE/DISABLE")
612 unless /^(ENABLE|DISABLE)/i ;
614 $WantVersionChk = 1 if $1 eq 'ENABLE' ;
615 $WantVersionChk = 0 if $1 eq 'DISABLE' ;
619 sub PROTOTYPE_handler ()
623 death("Error: Only 1 PROTOTYPE definition allowed per xsub")
624 if $proto_in_this_xsub ++ ;
626 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
630 if ($_ eq 'DISABLE') {
633 elsif ($_ eq 'ENABLE') {
637 # remove any whitespace
639 death("Error: Invalid prototype '$_'")
640 unless ValidProtoString($_) ;
641 $ProtoThisXSUB = C_string($_) ;
645 # If no prototype specified, then assume empty prototype ""
646 $ProtoThisXSUB = 2 unless $specified ;
654 death("Error: Only 1 SCOPE declaration allowed per xsub")
655 if $scope_in_this_xsub ++ ;
657 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
660 if ($_ =~ /^DISABLE/i) {
663 elsif ($_ =~ /^ENABLE/i) {
670 sub PROTOTYPES_handler ()
672 # the rest of the current line should contain either ENABLE or
677 # check for ENABLE/DISABLE
678 death ("Error: PROTOTYPES: ENABLE/DISABLE")
679 unless /^(ENABLE|DISABLE)/i ;
681 $WantPrototypes = 1 if $1 eq 'ENABLE' ;
682 $WantPrototypes = 0 if $1 eq 'DISABLE' ;
687 sub INCLUDE_handler ()
689 # the rest of the current line should contain a valid filename
693 death("INCLUDE: filename missing")
696 death("INCLUDE: output pipe is illegal")
699 # simple minded recursion detector
700 death("INCLUDE loop detected")
701 if $IncludedFiles{$_} ;
703 ++ $IncludedFiles{$_} unless /\|\s*$/ ;
705 # Save the current file context.
708 LastLine => $lastline,
709 LastLineNo => $lastline_no,
712 Filename => $filename,
719 open ($FH, "$_") or death("Cannot open '$_': $!") ;
723 #/* INCLUDE: Including '$_' from '$filename' */
729 # Prime the pump by reading the first
732 # skip leading blank lines
734 last unless /^\s*$/ ;
744 return 0 unless $XSStack[-1]{type} eq 'file' ;
746 my $data = pop @XSStack ;
747 my $ThisFile = $filename ;
748 my $isPipe = ($filename =~ /\|\s*$/) ;
750 -- $IncludedFiles{$filename}
755 $FH = $data->{Handle} ;
756 $filename = $data->{Filename} ;
757 $lastline = $data->{LastLine} ;
758 $lastline_no = $data->{LastLineNo} ;
759 @line = @{ $data->{Line} } ;
760 @line_no = @{ $data->{LineNo} } ;
762 if ($isPipe and $? ) {
764 print STDERR "Error reading from pipe '$ThisFile': $! in $filename, line $lastline_no\n" ;
770 #/* INCLUDE: Returning to '$filename' from '$ThisFile' */
777 sub ValidProtoString ($)
781 if ( $string =~ /^$proto_re+$/ ) {
792 $string =~ s[\\][\\\\]g ;
800 $proto_letter{$type} or "\$" ;
804 my @cpp = grep(/^\#\s*(?:if|e\w+)/, @line);
806 my ($cpp, $cpplevel);
808 if ($cpp =~ /^\#\s*if/) {
810 } elsif (!$cpplevel) {
811 Warn("Warning: #else/elif/endif without #if in this function");
812 print STDERR " (precede it with a blank line if the matching #if is outside the function)\n"
813 if $XSStack[-1]{type} eq 'if';
815 } elsif ($cpp =~ /^\#\s*endif/) {
819 Warn("Warning: #if without #endif in this function") if $cpplevel;
832 open($FH, $filename) or die "cannot open $filename: $!\n";
834 # Identify the version of xsubpp used
837 * This file was generated automatically by xsubpp version $XSUBPP_version from the
838 * contents of $filename. Do not edit this file, edit $filename instead.
840 * ANY CHANGES MADE HERE WILL BE LOST!
847 print("#line 1 \"$filename\"\n")
851 last if ($Module, $Package, $Prefix) =
852 /^MODULE\s*=\s*([\w:]+)(?:\s+PACKAGE\s*=\s*([\w:]+))?(?:\s+PREFIX\s*=\s*(\S+))?\s*$/;
855 s/#if(?:def\s|\s+defined)\s*(\(__cplusplus\)|__cplusplus)/#if defined(__cplusplus) && !defined(PERL_OBJECT)/;
859 &Exit unless defined $_;
861 print "$xsubpp::counter::SECTION_END_MARKER\n" if $WantLineNumbers;
866 # Read next xsub into @line from ($lastline, <$FH>).
869 death ("Error: Unterminated `#if/#ifdef/#ifndef'")
870 if !defined $lastline && $XSStack[-1]{type} eq 'if';
873 return PopFile() if !defined $lastline;
876 /^MODULE\s*=\s*([\w:]+)(?:\s+PACKAGE\s*=\s*([\w:]+))?(?:\s+PREFIX\s*=\s*(\S+))?\s*$/) {
878 $Package = defined($2) ? $2 : ''; # keep -w happy
879 $Prefix = defined($3) ? $3 : ''; # keep -w happy
880 $Prefix = quotemeta $Prefix ;
881 ($Module_cname = $Module) =~ s/\W/_/g;
882 ($Packid = $Package) =~ tr/:/_/;
883 $Packprefix = $Package;
884 $Packprefix .= "::" if $Packprefix ne "";
889 if ($lastline !~ /^\s*#/ ||
891 # ANSI: if ifdef ifndef elif else endif define undef
893 # gcc: warning include_next
895 # others: ident (gcc notes that some cpps have this one)
896 $lastline =~ /^#[ \t]*(?:(?:if|ifn?def|elif|else|endif|define|undef|pragma|error|warning|line\s+\d+|ident)\b|(?:include(?:_next)?|import)\s*["<].*[>"])/) {
897 last if $lastline =~ /^\S/ && @line && $line[-1] eq "";
898 push(@line, $lastline);
899 push(@line_no, $lastline_no) ;
902 # Read next line and continuation lines
903 last unless defined($lastline = <$FH>);
906 $lastline .= $tmp_line
907 while ($lastline =~ /\\$/ && defined($tmp_line = <$FH>));
910 $lastline =~ s/^\s+$//;
912 pop(@line), pop(@line_no) while @line && $line[-1] eq "";
917 while (fetch_para()) {
918 # Print initial preprocessor statements and blank lines
919 while (@line && $line[0] !~ /^[^\#]/) {
920 my $line = shift(@line);
922 next unless $line =~ /^\#\s*((if)(?:n?def)?|elsif|else|endif)\b/;
924 if ($statement eq 'if') {
925 $XSS_work_idx = @XSStack;
926 push(@XSStack, {type => 'if'});
928 death ("Error: `$statement' with no matching `if'")
929 if $XSStack[-1]{type} ne 'if';
930 if ($XSStack[-1]{varname}) {
931 push(@InitFileCode, "#endif\n");
932 push(@BootCode, "#endif");
935 my(@fns) = keys %{$XSStack[-1]{functions}};
936 if ($statement ne 'endif') {
937 # Hide the functions defined in other #if branches, and reset.
938 @{$XSStack[-1]{other_functions}}{@fns} = (1) x @fns;
939 @{$XSStack[-1]}{qw(varname functions)} = ('', {});
941 my($tmp) = pop(@XSStack);
942 0 while (--$XSS_work_idx
943 && $XSStack[$XSS_work_idx]{type} ne 'if');
944 # Keep all new defined functions
945 push(@fns, keys %{$tmp->{other_functions}});
946 @{$XSStack[$XSS_work_idx]{functions}}{@fns} = (1) x @fns;
951 next PARAGRAPH unless @line;
953 if ($XSS_work_idx && !$XSStack[$XSS_work_idx]{varname}) {
954 # We are inside an #if, but have not yet #defined its xsubpp variable.
955 print "#define $cpp_next_tmp 1\n\n";
956 push(@InitFileCode, "#if $cpp_next_tmp\n");
957 push(@BootCode, "#if $cpp_next_tmp");
958 $XSStack[$XSS_work_idx]{varname} = $cpp_next_tmp++;
961 death ("Code is not inside a function"
962 ." (maybe last function was ended by a blank line "
963 ." followed by a a statement on column one?)")
964 if $line[0] =~ /^\s/;
966 # initialize info arrays
975 undef($RETVAL_no_return) ;
978 undef(@arg_with_types) ;
979 undef($processing_arg_with_types) ;
983 undef($proto_in_this_xsub) ;
984 undef($scope_in_this_xsub) ;
986 undef($prepush_done);
987 $interface_macro = 'XSINTERFACE_FUNC' ;
988 $interface_macro_set = 'XSINTERFACE_FUNC_SET' ;
989 $ProtoThisXSUB = $WantPrototypes ;
994 while ($kwd = check_keyword("REQUIRE|PROTOTYPES|VERSIONCHECK|INCLUDE")) {
995 &{"${kwd}_handler"}() ;
996 next PARAGRAPH unless @line ;
1000 if (check_keyword("BOOT")) {
1002 push (@BootCode, "#line $line_no[@line_no - @line] \"$filename\"")
1003 if $WantLineNumbers && $line[0] !~ /^\s*#\s*line\b/;
1004 push (@BootCode, @line, "") ;
1009 # extract return type, function name and arguments
1010 ($ret_type) = TidyType($_);
1011 $RETVAL_no_return = 1 if $ret_type =~ s/^NO_OUTPUT\s+//;
1013 # Allow one-line ANSI-like declaration
1015 if $process_argtypes
1016 and $ret_type =~ s/^(.*?\w.*?)\s*\b(\w+\s*\(.*)/$1/s;
1018 # a function definition needs at least 2 lines
1019 blurt ("Error: Function definition too short '$ret_type'"), next PARAGRAPH
1022 $static = 1 if $ret_type =~ s/^static\s+//;
1024 $func_header = shift(@line);
1025 blurt ("Error: Cannot parse function definition from '$func_header'"), next PARAGRAPH
1026 unless $func_header =~ /^(?:([\w:]*)::)?(\w+)\s*\(\s*(.*?)\s*\)\s*(const)?\s*(;\s*)?$/s;
1028 ($class, $func_name, $orig_args) = ($1, $2, $3) ;
1029 $class = "$4 $class" if $4;
1030 ($pname = $func_name) =~ s/^($Prefix)?/$Packprefix/;
1031 ($clean_func_name = $func_name) =~ s/^$Prefix//;
1032 $Full_func_name = "${Packid}_$clean_func_name";
1033 if ($Is_VMS) { $Full_func_name = $SymSet->addsym($Full_func_name); }
1035 # Check for duplicate function definition
1036 for $tmp (@XSStack) {
1037 next unless defined $tmp->{functions}{$Full_func_name};
1038 Warn("Warning: duplicate function definition '$clean_func_name' detected");
1041 $XSStack[$XSS_work_idx]{functions}{$Full_func_name} ++ ;
1042 %XsubAliases = %XsubAliasValues = %Interfaces = ();
1045 $orig_args =~ s/\\\s*/ /g; # process line continuations
1048 if ($process_argtypes and $orig_args =~ /\S/) {
1049 my $args = "$orig_args ,";
1050 if ($args =~ /^( (??{ $C_arg }) , )* $ /x) {
1051 @args = ($args =~ /\G ( (??{ $C_arg }) ) , /xg);
1057 ($arg, $default) = / ( [^=]* ) ( (?: = .* )? ) /x;
1058 my ($pre, $name) = ($arg =~ /(.*?) \s* \b(\w+) \s* $ /x);
1059 next unless length $pre;
1062 if ($process_inout and s/^(IN|IN_OUTLIST|OUTLIST)\s+//) {
1064 $out_type = $type if $type ne 'IN';
1065 $arg =~ s/^(IN|IN_OUTLIST|OUTLIST)\s+//;
1067 if (/\W/) { # Has a type
1068 push @arg_with_types, $arg;
1069 # warn "pushing '$arg'\n";
1070 $arg_types{$name} = $arg;
1071 $_ = "$name$default";
1073 $out_vars{$_} = 1 if $out_type eq 'OUTLIST';
1074 push @in_out, $name if $out_type;
1075 $in_out{$name} = $out_type if $out_type;
1078 @args = split(/\s*,\s*/, $orig_args);
1079 Warn("Warning: cannot parse argument list '$orig_args', fallback to split");
1082 @args = split(/\s*,\s*/, $orig_args);
1084 if ($process_inout and s/^(IN|IN_OUTLIST|OUTLIST)\s+//) {
1086 next if $out_type eq 'IN';
1087 $out_vars{$_} = 1 if $out_type eq 'OUTLIST';
1088 push @in_out, $name;
1089 $in_out{$_} = $out_type;
1093 if (defined($class)) {
1094 my $arg0 = ((defined($static) or $func_name eq 'new')
1095 ? "CLASS" : "THIS");
1096 unshift(@args, $arg0);
1097 ($report_args = "$arg0, $report_args") =~ s/^\w+, $/$arg0/;
1102 my $report_args = '';
1103 foreach $i (0 .. $#args) {
1104 if ($args[$i] =~ s/\.\.\.//) {
1106 if ($args[$i] eq '' && $i == $#args) {
1107 $report_args .= ", ...";
1112 if ($out_vars{$args[$i]}) {
1113 push @args_num, undef;
1115 push @args_num, ++$num_args;
1116 $report_args .= ", $args[$i]";
1118 if ($args[$i] =~ /^([^=]*[^\s=])\s*=\s*(.*)/s) {
1121 $defaults{$args[$i]} = $2;
1122 $defaults{$args[$i]} =~ s/"/\\"/g;
1124 $proto_arg[$i+1] = "\$" ;
1126 $min_args = $num_args - $extra_args;
1127 $report_args =~ s/"/\\"/g;
1128 $report_args =~ s/^,\s+//;
1129 my @func_args = @args;
1130 shift @func_args if defined($class);
1133 s/^/&/ if $in_out{$_};
1135 $func_args = join(", ", @func_args);
1136 @args_match{@args} = @args_num;
1138 $PPCODE = grep(/^\s*PPCODE\s*:/, @line);
1139 $CODE = grep(/^\s*CODE\s*:/, @line);
1140 # Detect CODE: blocks which use ST(n)= or XST_m*(n,v)
1141 # to set explicit return values.
1142 $EXPLICIT_RETURN = ($CODE &&
1143 ("@line" =~ /(\bST\s*\([^;]*=) | (\bXST_m\w+\s*\()/x ));
1144 $ALIAS = grep(/^\s*ALIAS\s*:/, @line);
1145 $INTERFACE = grep(/^\s*INTERFACE\s*:/, @line);
1147 $xsreturn = 1 if $EXPLICIT_RETURN;
1149 # print function header
1151 #XS(XS_${Full_func_name})
1155 print Q<<"EOF" if $ALIAS ;
1158 print Q<<"EOF" if $INTERFACE ;
1159 # dXSFUNCTION($ret_type);
1162 $cond = ($min_args ? qq(items < $min_args) : 0);
1164 elsif ($min_args == $num_args) {
1165 $cond = qq(items != $min_args);
1168 $cond = qq(items < $min_args || items > $num_args);
1171 print Q<<"EOF" if $except;
1172 # char errbuf[1024];
1177 { print Q<<"EOF" if $cond }
1179 # Perl_croak(aTHX_ "Usage: %s($report_args)", GvNAME(CvGV(cv)));
1182 { print Q<<"EOF" if $cond }
1184 # Perl_croak(aTHX_ "Usage: $pname($report_args)");
1187 print Q<<"EOF" if $PPCODE;
1191 # Now do a block of some sort.
1194 $cond = ''; # last CASE: condidional
1195 push(@line, "$END:");
1196 push(@line_no, $line_no[-1]);
1200 &CASE_handler if check_keyword("CASE");
1205 # do initialization of input variables
1213 process_keyword("INPUT|PREINIT|INTERFACE_MACRO|C_ARGS|ALIAS|PROTOTYPE|SCOPE") ;
1215 print Q<<"EOF" if $ScopeThisXSUB;
1220 if (!$thisdone && defined($class)) {
1221 if (defined($static) or $func_name eq 'new') {
1223 $var_types{"CLASS"} = "char *";
1224 &generate_init("char *", 1, "CLASS");
1228 $var_types{"THIS"} = "$class *";
1229 &generate_init("$class *", 1, "THIS");
1234 if (/^\s*NOT_IMPLEMENTED_YET/) {
1235 print "\n\tPerl_croak(aTHX_ \"$pname: not implemented yet\");\n";
1238 if ($ret_type ne "void") {
1239 print "\t" . &map_type($ret_type, 'RETVAL') . ";\n"
1241 $args_match{"RETVAL"} = 0;
1242 $var_types{"RETVAL"} = $ret_type;
1243 print "\tdXSTARG;\n"
1244 if $WantOptimize and $targetable{$type_kind{$ret_type}};
1247 if (@arg_with_types) {
1248 unshift @line, @arg_with_types, $_;
1250 $processing_arg_with_types = 1;
1255 process_keyword("INIT|ALIAS|PROTOTYPE|INTERFACE_MACRO|INTERFACE|C_ARGS") ;
1257 if (check_keyword("PPCODE")) {
1259 death ("PPCODE must be last thing") if @line;
1260 print "\tLEAVE;\n" if $ScopeThisXSUB;
1261 print "\tPUTBACK;\n\treturn;\n";
1262 } elsif (check_keyword("CODE")) {
1264 } elsif (defined($class) and $func_name eq "DESTROY") {
1266 print "delete THIS;\n";
1269 if ($ret_type ne "void") {
1273 if (defined($static)) {
1274 if ($func_name eq 'new') {
1275 $func_name = "$class";
1279 } elsif (defined($class)) {
1280 if ($func_name eq 'new') {
1281 $func_name .= " $class";
1286 $func_name =~ s/^($spat)//
1288 $func_name = 'XSFUNCTION' if $interface;
1289 print "$func_name($func_args);\n";
1293 # do output variables
1294 $gotRETVAL = 0; # 1 if RETVAL seen in OUTPUT section;
1295 undef $RETVAL_code ; # code to set RETVAL (from OUTPUT section);
1296 # $wantRETVAL set if 'RETVAL =' autogenerated
1297 ($wantRETVAL, $ret_type) = (0, 'void') if $RETVAL_no_return;
1299 process_keyword("POSTCALL|OUTPUT|ALIAS|PROTOTYPE");
1301 # all OUTPUT done, so now push the return value on the stack
1302 if ($gotRETVAL && $RETVAL_code) {
1303 print "\t$RETVAL_code\n";
1304 } elsif ($gotRETVAL || $wantRETVAL) {
1305 my $t = $WantOptimize && $targetable{$type_kind{$ret_type}};
1307 my $type = $ret_type;
1309 # 0: type, 1: with_size, 2: how, 3: how_size
1310 if ($t and not $t->[1] and $t->[0] eq 'p') {
1311 # PUSHp corresponds to setpvn. Treate setpv directly
1312 my $what = eval qq("$t->[2]");
1315 print "\tsv_setpv(TARG, $what); XSprePUSH; PUSHTARG;\n";
1319 my $what = eval qq("$t->[2]");
1323 $size = '' unless defined $size;
1324 $size = eval qq("$size");
1326 print "\tXSprePUSH; PUSH$t->[0]($what$size);\n";
1330 # RETVAL almost never needs SvSETMAGIC()
1331 &generate_output($ret_type, 0, 'RETVAL', 0);
1335 $xsreturn = 1 if $ret_type ne "void";
1336 my $num = $xsreturn;
1338 print "\tXSprePUSH;" if $c and not $prepush_done;
1339 print "\tEXTEND(SP,$c);\n" if $c;
1341 generate_output($var_types{$_}, $num++, $_, 0, 1) for @in_out;
1344 process_keyword("CLEANUP|ALIAS|PROTOTYPE") ;
1346 print Q<<"EOF" if $ScopeThisXSUB;
1349 print Q<<"EOF" if $ScopeThisXSUB and not $PPCODE;
1353 # print function trailer
1357 print Q<<EOF if $except;
1360 # sprintf(errbuf, "%s: %s\\tpropagated", Xname, Xreason);
1363 if (check_keyword("CASE")) {
1364 blurt ("Error: No `CASE:' at top of function")
1366 $_ = "CASE: $_"; # Restore CASE: label
1369 last if $_ eq "$END:";
1370 death(/^$BLOCK_re/o ? "Misplaced `$1:'" : "Junk at end of function");
1373 print Q<<EOF if $except;
1375 # Perl_croak(aTHX_ errbuf);
1379 print Q<<EOF unless $PPCODE;
1380 # XSRETURN($xsreturn);
1383 print Q<<EOF unless $PPCODE;
1393 my $newXS = "newXS" ;
1396 # Build the prototype string for the xsub
1397 if ($ProtoThisXSUB) {
1398 $newXS = "newXSproto";
1400 if ($ProtoThisXSUB eq 2) {
1401 # User has specified empty prototype
1404 elsif ($ProtoThisXSUB ne 1) {
1405 # User has specified a prototype
1406 $proto = ', "' . $ProtoThisXSUB . '"';
1410 if ($min_args < $num_args) {
1412 $proto_arg[$min_args] .= ";" ;
1414 push @proto_arg, "$s\@"
1417 $proto = ', "' . join ("", @proto_arg) . '"';
1422 $XsubAliases{$pname} = 0
1423 unless defined $XsubAliases{$pname} ;
1424 while ( ($name, $value) = each %XsubAliases) {
1425 push(@InitFileCode, Q<<"EOF");
1426 # cv = newXS(\"$name\", XS_$Full_func_name, file);
1427 # XSANY.any_i32 = $value ;
1429 push(@InitFileCode, Q<<"EOF") if $proto;
1430 # sv_setpv((SV*)cv$proto) ;
1434 elsif ($interface) {
1435 while ( ($name, $value) = each %Interfaces) {
1436 $name = "$Package\::$name" unless $name =~ /::/;
1437 push(@InitFileCode, Q<<"EOF");
1438 # cv = newXS(\"$name\", XS_$Full_func_name, file);
1439 # $interface_macro_set(cv,$value) ;
1441 push(@InitFileCode, Q<<"EOF") if $proto;
1442 # sv_setpv((SV*)cv$proto) ;
1448 " ${newXS}(\"$pname\", XS_$Full_func_name, file$proto);\n");
1452 # print initialization routine
1461 #XS(boot_$Module_cname)
1467 # char* file = __FILE__;
1471 print Q<<"EOF" if $WantVersionChk ;
1472 # XS_VERSION_BOOTCHECK ;
1476 print Q<<"EOF" if defined $XsubAliases or defined $Interfaces ;
1482 print @InitFileCode;
1484 print Q<<"EOF" if defined $XsubAliases or defined $Interfaces ;
1490 print "\n /* Initialisation Section */\n\n" ;
1493 print "\n /* End of Initialisation Section */\n\n" ;
1502 warn("Please specify prototyping behavior for $filename (see perlxs manual)\n")
1507 local($type, $num, $var, $init, $name_printed) = @_;
1508 local($arg) = "ST(" . ($num - 1) . ")";
1510 if( $init =~ /^=/ ) {
1511 if ($name_printed) {
1512 eval qq/print " $init\\n"/;
1514 eval qq/print "\\t$var $init\\n"/;
1518 if( $init =~ s/^\+// && $num ) {
1519 &generate_init($type, $num, $var, $name_printed);
1520 } elsif ($name_printed) {
1524 eval qq/print "\\t$var;\\n"/;
1528 $deferred .= eval qq/"\\n\\t$init\\n"/;
1535 # work out the line number
1536 my $line_no = $line_no[@line_no - @line -1] ;
1538 print STDERR "@_ in $filename, line $line_no\n" ;
1554 local($type, $num, $var) = @_;
1555 local($arg) = "ST(" . ($num - 1) . ")";
1556 local($argoff) = $num - 1;
1560 $type = TidyType($type) ;
1561 blurt("Error: '$type' not in typemap"), return
1562 unless defined($type_kind{$type});
1564 ($ntype = $type) =~ s/\s*\*/Ptr/g;
1565 ($subtype = $ntype) =~ s/(?:Array)?(?:Ptr)?$//;
1566 $tk = $type_kind{$type};
1567 $tk =~ s/OBJ$/REF/ if $func_name =~ /DESTROY$/;
1569 blurt("Error: No INPUT definition for type '$type', typekind '$type_kind{$type}' found"), return
1570 unless defined $input_expr{$tk} ;
1571 $expr = $input_expr{$tk};
1572 if ($expr =~ /DO_ARRAY_ELEM/) {
1573 blurt("Error: '$subtype' not in typemap"), return
1574 unless defined($type_kind{$subtype});
1575 blurt("Error: No INPUT definition for type '$subtype', typekind '$type_kind{$subtype}' found"), return
1576 unless defined $input_expr{$type_kind{$subtype}} ;
1577 $subexpr = $input_expr{$type_kind{$subtype}};
1578 $subexpr =~ s/ntype/subtype/g;
1579 $subexpr =~ s/\$arg/ST(ix_$var)/g;
1580 $subexpr =~ s/\n\t/\n\t\t/g;
1581 $subexpr =~ s/is not of (.*\")/[arg %d] is not of $1, ix_$var + 1/g;
1582 $subexpr =~ s/\$var/${var}[ix_$var - $argoff]/;
1583 $expr =~ s/DO_ARRAY_ELEM/$subexpr/;
1585 if ($expr =~ m#/\*.*scope.*\*/#i) { # "scope" in C comments
1588 if (defined($defaults{$var})) {
1589 $expr =~ s/(\t+)/$1 /g;
1591 if ($name_printed) {
1594 eval qq/print "\\t$var;\\n"/;
1597 if ($defaults{$var} eq 'NO_INIT') {
1598 $deferred .= eval qq/"\\n\\tif (items >= $num) {\\n$expr;\\n\\t}\\n"/;
1600 $deferred .= eval qq/"\\n\\tif (items < $num)\\n\\t $var = $defaults{$var};\\n\\telse {\\n$expr;\\n\\t}\\n"/;
1603 } elsif ($ScopeThisXSUB or $expr !~ /^\t\$var =/) {
1604 if ($name_printed) {
1607 eval qq/print "\\t$var;\\n"/;
1610 $deferred .= eval qq/"\\n$expr;\\n"/;
1613 die "panic: do not know how to handle this branch for function pointers"
1615 eval qq/print "$expr;\\n"/;
1620 sub generate_output {
1621 local($type, $num, $var, $do_setmagic, $do_push) = @_;
1622 local($arg) = "ST(" . ($num - ($num != 0)) . ")";
1623 local($argoff) = $num - 1;
1626 $type = TidyType($type) ;
1627 if ($type =~ /^array\(([^,]*),(.*)\)/) {
1628 print "\tsv_setpvn($arg, (char *)$var, $2 * sizeof($1));\n";
1629 print "\tSvSETMAGIC($arg);\n" if $do_setmagic;
1631 blurt("Error: '$type' not in typemap"), return
1632 unless defined($type_kind{$type});
1633 blurt("Error: No OUTPUT definition for type '$type', typekind '$type_kind{$type}' found"), return
1634 unless defined $output_expr{$type_kind{$type}} ;
1635 ($ntype = $type) =~ s/\s*\*/Ptr/g;
1636 $ntype =~ s/\(\)//g;
1637 ($subtype = $ntype) =~ s/(?:Array)?(?:Ptr)?$//;
1638 $expr = $output_expr{$type_kind{$type}};
1639 if ($expr =~ /DO_ARRAY_ELEM/) {
1640 blurt("Error: '$subtype' not in typemap"), return
1641 unless defined($type_kind{$subtype});
1642 blurt("Error: No OUTPUT definition for type '$subtype', typekind '$type_kind{$subtype}' found"), return
1643 unless defined $output_expr{$type_kind{$subtype}} ;
1644 $subexpr = $output_expr{$type_kind{$subtype}};
1645 $subexpr =~ s/ntype/subtype/g;
1646 $subexpr =~ s/\$arg/ST(ix_$var)/g;
1647 $subexpr =~ s/\$var/${var}[ix_$var]/g;
1648 $subexpr =~ s/\n\t/\n\t\t/g;
1649 $expr =~ s/DO_ARRAY_ELEM\n/$subexpr/;
1650 eval "print qq\a$expr\a";
1652 print "\t\tSvSETMAGIC(ST(ix_$var));\n" if $do_setmagic;
1654 elsif ($var eq 'RETVAL') {
1655 if ($expr =~ /^\t\$arg = new/) {
1656 # We expect that $arg has refcnt 1, so we need to
1658 eval "print qq\a$expr\a";
1660 print "\tsv_2mortal(ST($num));\n";
1661 print "\tSvSETMAGIC(ST($num));\n" if $do_setmagic;
1663 elsif ($expr =~ /^\s*\$arg\s*=/) {
1664 # We expect that $arg has refcnt >=1, so we need
1666 eval "print qq\a$expr\a";
1668 print "\tsv_2mortal(ST(0));\n";
1669 print "\tSvSETMAGIC(ST(0));\n" if $do_setmagic;
1672 # Just hope that the entry would safely write it
1673 # over an already mortalized value. By
1674 # coincidence, something like $arg = &sv_undef
1676 print "\tST(0) = sv_newmortal();\n";
1677 eval "print qq\a$expr\a";
1679 # new mortals don't have set magic
1683 print "\tPUSHs(sv_newmortal());\n";
1685 eval "print qq\a$expr\a";
1687 print "\tSvSETMAGIC($arg);\n" if $do_setmagic;
1689 elsif ($arg =~ /^ST\(\d+\)$/) {
1690 eval "print qq\a$expr\a";
1692 print "\tSvSETMAGIC($arg);\n" if $do_setmagic;
1698 my($type, $varname) = @_;
1701 $type =~ s/^array\(([^,]*),(.*)\).*/$1 */s;
1703 if ($varname && $type =~ / \( \s* \* (?= \s* \) ) /xg) {
1704 (substr $type, pos $type, 0) = " $varname ";
1706 $type .= "\t$varname";
1714 # If this is VMS, the exit status has meaning to the shell, so we
1715 # use a predictable value (SS$_Normal or SS$_Abort) rather than an
1717 # exit ($Is_VMS ? ($errors ? 44 : 1) : $errors) ;
1718 exit ($errors ? 1 : 0);