projects / p5sagit/p5-mst-13.2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | history | HEAD
cygwin: disable effect of -ansi -std=c89 on system include
[p5sagit/p5-mst-13.2.git] / lib / ExtUtils / ParseXS.pm
CommitLineData
6b09c160 1package ExtUtils::ParseXS;
2
3use 5.006; # We use /??{}/ in regexes
4use Cwd;
5use Config;
6use File::Basename;
7use File::Spec;
907ce46c 8use Symbol;
6b09c160 9
10require Exporter;
11
12@ISA = qw(Exporter);
13@EXPORT_OK = qw(process_file);
14
15# use strict; # One of these days...
16
17my(@XSStack); # Stack of conditionals and INCLUDEs
18my($XSS_work_idx, $cpp_next_tmp);
19
20use vars qw($VERSION);
0932863f 21$VERSION = '2.17_02';
6b09c160 22
23use vars qw(%input_expr %output_expr $ProtoUsed @InitFileCode $FH $proto_re $Overload $errors $Fallback
24 $cplusplus $hiertype $WantPrototypes $WantVersionChk $except $WantLineNumbers
25 $WantOptimize $process_inout $process_argtypes @tm
26 $dir $filename $filepathname %IncludedFiles
27 %type_kind %proto_letter
28 %targetable $BLOCK_re $lastline $lastline_no
29 $Package $Prefix @line @BootCode %args_match %defaults %var_types %arg_list @proto_arg
30 $processing_arg_with_types %argtype_seen @outlist %in_out %lengthof
31 $proto_in_this_xsub $scope_in_this_xsub $interface $prepush_done $interface_macro $interface_macro_set
32 $ProtoThisXSUB $ScopeThisXSUB $xsreturn
33 @line_no $ret_type $func_header $orig_args
34 ); # Add these just to get compilation to happen.
35
36
37sub process_file {
38
39 # Allow for $package->process_file(%hash) in the future
40 my ($pkg, %args) = @_ % 2 ? @_ : (__PACKAGE__, @_);
41
42 $ProtoUsed = exists $args{prototypes};
43
44 # Set defaults.
45 %args = (
46 # 'C++' => 0, # Doesn't seem to *do* anything...
47 hiertype => 0,
48 except => 0,
49 prototypes => 0,
50 versioncheck => 1,
51 linenumbers => 1,
52 optimize => 1,
53 prototypes => 0,
54 inout => 1,
55 argtypes => 1,
56 typemap => [],
57 output => \*STDOUT,
008fb49c 58 csuffix => '.c',
6b09c160 59 %args,
60 );
61
62 # Global Constants
63
64 my ($Is_VMS, $SymSet);
65 if ($^O eq 'VMS') {
66 $Is_VMS = 1;
67 # Establish set of global symbols with max length 28, since xsubpp
68 # will later add the 'XS_' prefix.
69 require ExtUtils::XSSymSet;
70 $SymSet = new ExtUtils::XSSymSet 28;
71 }
72 @XSStack = ({type => 'none'});
73 ($XSS_work_idx, $cpp_next_tmp) = (0, "XSubPPtmpAAAA");
74 @InitFileCode = ();
907ce46c 75 $FH = Symbol::gensym();
6b09c160 76 $proto_re = "[" . quotemeta('\$%&*@;[]') . "]" ;
77 $Overload = 0;
78 $errors = 0;
79 $Fallback = 'PL_sv_undef';
80
81 # Most of the 1500 lines below uses these globals. We'll have to
82 # clean this up sometime, probably. For now, we just pull them out
83 # of %args. -Ken
84
85 $cplusplus = $args{'C++'};
86 $hiertype = $args{hiertype};
87 $WantPrototypes = $args{prototypes};
88 $WantVersionChk = $args{versioncheck};
89 $except = $args{except} ? ' TRY' : '';
90 $WantLineNumbers = $args{linenumbers};
91 $WantOptimize = $args{optimize};
92 $process_inout = $args{inout};
93 $process_argtypes = $args{argtypes};
94 @tm = ref $args{typemap} ? @{$args{typemap}} : ($args{typemap});
95
96 for ($args{filename}) {
97 die "Missing required parameter 'filename'" unless $_;
98 $filepathname = $_;
99 ($dir, $filename) = (dirname($_), basename($_));
100 $filepathname =~ s/\\/\\\\/g;
101 $IncludedFiles{$_}++;
102 }
103
104 # Open the input file
105 open($FH, $args{filename}) or die "cannot open $args{filename}: $!\n";
106
107 # Open the output file if given as a string. If they provide some
108 # other kind of reference, trust them that we can print to it.
109 if (not ref $args{output}) {
110 open my($fh), "> $args{output}" or die "Can't create $args{output}: $!";
111 $args{outfile} = $args{output};
112 $args{output} = $fh;
113 }
114
115 # Really, we shouldn't have to chdir() or select() in the first
116 # place. For now, just save & restore.
117 my $orig_cwd = cwd();
118 my $orig_fh = select();
119
120 chdir($dir);
121 my $pwd = cwd();
008fb49c 122 my $csuffix = $args{csuffix};
6b09c160 123
124 if ($WantLineNumbers) {
125 my $cfile;
126 if ( $args{outfile} ) {
127 $cfile = $args{outfile};
128 } else {
129 $cfile = $args{filename};
008fb49c 130 $cfile =~ s/\.xs$/$csuffix/i or $cfile .= $csuffix;
6b09c160 131 }
132 tie(*PSEUDO_STDOUT, 'ExtUtils::ParseXS::CountLines', $cfile, $args{output});
133 select PSEUDO_STDOUT;
134 } else {
135 select $args{output};
136 }
137
138 foreach my $typemap (@tm) {
139 die "Can't find $typemap in $pwd\n" unless -r $typemap;
140 }
141
142 push @tm, standard_typemap_locations();
143
144 foreach my $typemap (@tm) {
145 next unless -f $typemap ;
146 # skip directories, binary files etc.
147 warn("Warning: ignoring non-text typemap file '$typemap'\n"), next
148 unless -T $typemap ;
149 open(TYPEMAP, $typemap)
150 or warn ("Warning: could not open typemap file '$typemap': $!\n"), next;
151 my $mode = 'Typemap';
152 my $junk = "" ;
153 my $current = \$junk;
154 while (<TYPEMAP>) {
155 next if /^\s* #/;
156 my $line_no = $. + 1;
157 if (/^INPUT\s*$/) {
158 $mode = 'Input'; $current = \$junk; next;
159 }
160 if (/^OUTPUT\s*$/) {
161 $mode = 'Output'; $current = \$junk; next;
162 }
163 if (/^TYPEMAP\s*$/) {
164 $mode = 'Typemap'; $current = \$junk; next;
165 }
166 if ($mode eq 'Typemap') {
167 chomp;
168 my $line = $_ ;
169 TrimWhitespace($_) ;
170 # skip blank lines and comment lines
171 next if /^$/ or /^#/ ;
172 my($type,$kind, $proto) = /^\s*(.*?\S)\s+(\S+)\s*($proto_re*)\s*$/ or
173 warn("Warning: File '$typemap' Line $. '$line' TYPEMAP entry needs 2 or 3 columns\n"), next;
174 $type = TidyType($type) ;
175 $type_kind{$type} = $kind ;
176 # prototype defaults to '$'
177 $proto = "\$" unless $proto ;
178 warn("Warning: File '$typemap' Line $. '$line' Invalid prototype '$proto'\n")
179 unless ValidProtoString($proto) ;
180 $proto_letter{$type} = C_string($proto) ;
181 } elsif (/^\s/) {
182 $$current .= $_;
183 } elsif ($mode eq 'Input') {
184 s/\s+$//;
185 $input_expr{$_} = '';
186 $current = \$input_expr{$_};
187 } else {
188 s/\s+$//;
189 $output_expr{$_} = '';
190 $current = \$output_expr{$_};
191 }
192 }
193 close(TYPEMAP);
194 }
195
196 foreach my $key (keys %input_expr) {
197 $input_expr{$key} =~ s/;*\s+\z//;
198 }
199
a8adbc99 200 my ($cast, $size);
201 our $bal = qr[(?:(?>[^()]+)|\((??{ $bal })\))*]; # ()-balanced
6b09c160 202 $cast = qr[(?:\(\s*SV\s*\*\s*\)\s*)?]; # Optional (SV*) cast
203 $size = qr[,\s* (??{ $bal }) ]x; # Third arg (to setpvn)
204
205 foreach my $key (keys %output_expr) {
de8c5301 206 #use re 'eval';
207 BEGIN { $^H |= 0x00200000};
6b09c160 208
209 my ($t, $with_size, $arg, $sarg) =
210 ($output_expr{$key} =~
211 m[^ \s+ sv_set ( [iunp] ) v (n)? # Type, is_setpvn
212 \s* \( \s* $cast \$arg \s* ,
213 \s* ( (??{ $bal }) ) # Set from
214 ( (??{ $size }) )? # Possible sizeof set-from
215 \) \s* ; \s* $
216 ]x);
217 $targetable{$key} = [$t, $with_size, $arg, $sarg] if $t;
218 }
219
220 my $END = "!End!\n\n"; # "impossible" keyword (multiple newline)
221
222 # Match an XS keyword
223 $BLOCK_re= '\s*(' . join('|', qw(
224 REQUIRE BOOT CASE PREINIT INPUT INIT CODE PPCODE OUTPUT
225 CLEANUP ALIAS ATTRS PROTOTYPES PROTOTYPE VERSIONCHECK INCLUDE
226 SCOPE INTERFACE INTERFACE_MACRO C_ARGS POSTCALL OVERLOAD FALLBACK
227 )) . "|$END)\\s*:";
228
229
a8adbc99 230 our ($C_group_rex, $C_arg);
6b09c160 231 # Group in C (no support for comments or literals)
232 $C_group_rex = qr/ [({\[]
233 (?: (?> [^()\[\]{}]+ ) | (??{ $C_group_rex }) )*
234 [)}\]] /x ;
235 # Chunk in C without comma at toplevel (no comments):
236 $C_arg = qr/ (?: (?> [^()\[\]{},"']+ )
237 | (??{ $C_group_rex })
238 | " (?: (?> [^\\"]+ )
239 | \\.
240 )* " # String literal
241 | ' (?: (?> [^\\']+ ) | \\. )* ' # Char literal
242 )* /xs;
243
244 # Identify the version of xsubpp used
245 print <<EOM ;
246/*
247 * This file was generated automatically by ExtUtils::ParseXS version $VERSION from the
248 * contents of $filename. Do not edit this file, edit $filename instead.
249 *
250 * ANY CHANGES MADE HERE WILL BE LOST!
251 *
252 */
253
254EOM
255
256
257 print("#line 1 \"$filepathname\"\n")
258 if $WantLineNumbers;
259
260 firstmodule:
261 while (<$FH>) {
262 if (/^=/) {
263 my $podstartline = $.;
264 do {
265 if (/^=cut\s*$/) {
266 # We can't just write out a /* */ comment, as our embedded
267 # POD might itself be in a comment. We can't put a /**/
268 # comment inside #if 0, as the C standard says that the source
269 # file is decomposed into preprocessing characters in the stage
270 # before preprocessing commands are executed.
271 # I don't want to leave the text as barewords, because the spec
272 # isn't clear whether macros are expanded before or after
273 # preprocessing commands are executed, and someone pathological
274 # may just have defined one of the 3 words as a macro that does
275 # something strange. Multiline strings are illegal in C, so
276 # the "" we write must be a string literal. And they aren't
277 # concatenated until 2 steps later, so we are safe.
278 # - Nicholas Clark
279 print("#if 0\n \"Skipped embedded POD.\"\n#endif\n");
280 printf("#line %d \"$filepathname\"\n", $. + 1)
281 if $WantLineNumbers;
282 next firstmodule
283 }
284
285 } while (<$FH>);
286 # At this point $. is at end of file so die won't state the start
287 # of the problem, and as we haven't yet read any lines &death won't
288 # show the correct line in the message either.
289 die ("Error: Unterminated pod in $filename, line $podstartline\n")
290 unless $lastline;
291 }
292 last if ($Package, $Prefix) =
293 /^MODULE\s*=\s*[\w:]+(?:\s+PACKAGE\s*=\s*([\w:]+))?(?:\s+PREFIX\s*=\s*(\S+))?\s*$/;
294
295 print $_;
296 }
297 unless (defined $_) {
298 warn "Didn't find a 'MODULE ... PACKAGE ... PREFIX' line\n";
299 exit 0; # Not a fatal error for the caller process
300 }
301
302 print <<"EOF";
303#ifndef PERL_UNUSED_VAR
304# define PERL_UNUSED_VAR(var) if (0) var = var
305#endif
306
307EOF
308
309 print 'ExtUtils::ParseXS::CountLines'->end_marker, "\n" if $WantLineNumbers;
310
311 $lastline = $_;
312 $lastline_no = $.;
313
314 PARAGRAPH:
315 while (fetch_para()) {
316 # Print initial preprocessor statements and blank lines
317 while (@line && $line[0] !~ /^[^\#]/) {
318 my $line = shift(@line);
319 print $line, "\n";
320 next unless $line =~ /^\#\s*((if)(?:n?def)?|elsif|else|endif)\b/;
321 my $statement = $+;
322 if ($statement eq 'if') {
323 $XSS_work_idx = @XSStack;
324 push(@XSStack, {type => 'if'});
325 } else {
326 death ("Error: `$statement' with no matching `if'")
327 if $XSStack[-1]{type} ne 'if';
328 if ($XSStack[-1]{varname}) {
329 push(@InitFileCode, "#endif\n");
330 push(@BootCode, "#endif");
331 }
332
333 my(@fns) = keys %{$XSStack[-1]{functions}};
334 if ($statement ne 'endif') {
335 # Hide the functions defined in other #if branches, and reset.
336 @{$XSStack[-1]{other_functions}}{@fns} = (1) x @fns;
337 @{$XSStack[-1]}{qw(varname functions)} = ('', {});
338 } else {
339 my($tmp) = pop(@XSStack);
340 0 while (--$XSS_work_idx
341 && $XSStack[$XSS_work_idx]{type} ne 'if');
342 # Keep all new defined functions
343 push(@fns, keys %{$tmp->{other_functions}});
344 @{$XSStack[$XSS_work_idx]{functions}}{@fns} = (1) x @fns;
345 }
346 }
347 }
348
349 next PARAGRAPH unless @line;
350
351 if ($XSS_work_idx && !$XSStack[$XSS_work_idx]{varname}) {
352 # We are inside an #if, but have not yet #defined its xsubpp variable.
353 print "#define $cpp_next_tmp 1\n\n";
354 push(@InitFileCode, "#if $cpp_next_tmp\n");
355 push(@BootCode, "#if $cpp_next_tmp");
356 $XSStack[$XSS_work_idx]{varname} = $cpp_next_tmp++;
357 }
358
359 death ("Code is not inside a function"
360 ." (maybe last function was ended by a blank line "
361 ." followed by a statement on column one?)")
362 if $line[0] =~ /^\s/;
363
008fb49c 364 my ($class, $externC, $static, $elipsis, $wantRETVAL, $RETVAL_no_return);
6b09c160 365 my (@fake_INPUT_pre); # For length(s) generated variables
366 my (@fake_INPUT);
367
368 # initialize info arrays
369 undef(%args_match);
370 undef(%var_types);
371 undef(%defaults);
372 undef(%arg_list) ;
373 undef(@proto_arg) ;
374 undef($processing_arg_with_types) ;
375 undef(%argtype_seen) ;
376 undef(@outlist) ;
377 undef(%in_out) ;
378 undef(%lengthof) ;
379 undef($proto_in_this_xsub) ;
380 undef($scope_in_this_xsub) ;
381 undef($interface);
382 undef($prepush_done);
383 $interface_macro = 'XSINTERFACE_FUNC' ;
384 $interface_macro_set = 'XSINTERFACE_FUNC_SET' ;
385 $ProtoThisXSUB = $WantPrototypes ;
386 $ScopeThisXSUB = 0;
387 $xsreturn = 0;
388
389 $_ = shift(@line);
390 while (my $kwd = check_keyword("REQUIRE|PROTOTYPES|FALLBACK|VERSIONCHECK|INCLUDE")) {
391 &{"${kwd}_handler"}() ;
392 next PARAGRAPH unless @line ;
393 $_ = shift(@line);
394 }
395
396 if (check_keyword("BOOT")) {
397 &check_cpp;
398 push (@BootCode, "#line $line_no[@line_no - @line] \"$filepathname\"")
399 if $WantLineNumbers && $line[0] !~ /^\s*#\s*line\b/;
400 push (@BootCode, @line, "") ;
401 next PARAGRAPH ;
402 }
403
404
405 # extract return type, function name and arguments
406 ($ret_type) = TidyType($_);
407 $RETVAL_no_return = 1 if $ret_type =~ s/^NO_OUTPUT\s+//;
408
409 # Allow one-line ANSI-like declaration
410 unshift @line, $2
411 if $process_argtypes
412 and $ret_type =~ s/^(.*?\w.*?)\s*\b(\w+\s*\(.*)/$1/s;
413
414 # a function definition needs at least 2 lines
415 blurt ("Error: Function definition too short '$ret_type'"), next PARAGRAPH
416 unless @line ;
417
008fb49c 418 $externC = 1 if $ret_type =~ s/^extern "C"\s+//;
419 $static = 1 if $ret_type =~ s/^static\s+//;
6b09c160 420
421 $func_header = shift(@line);
422 blurt ("Error: Cannot parse function definition from '$func_header'"), next PARAGRAPH
423 unless $func_header =~ /^(?:([\w:]*)::)?(\w+)\s*\(\s*(.*?)\s*\)\s*(const)?\s*(;\s*)?$/s;
424
425 ($class, $func_name, $orig_args) = ($1, $2, $3) ;
426 $class = "$4 $class" if $4;
427 ($pname = $func_name) =~ s/^($Prefix)?/$Packprefix/;
428 ($clean_func_name = $func_name) =~ s/^$Prefix//;
429 $Full_func_name = "${Packid}_$clean_func_name";
430 if ($Is_VMS) {
431 $Full_func_name = $SymSet->addsym($Full_func_name);
432 }
433
434 # Check for duplicate function definition
435 for my $tmp (@XSStack) {
436 next unless defined $tmp->{functions}{$Full_func_name};
437 Warn("Warning: duplicate function definition '$clean_func_name' detected");
438 last;
439 }
440 $XSStack[$XSS_work_idx]{functions}{$Full_func_name} ++ ;
441 %XsubAliases = %XsubAliasValues = %Interfaces = @Attributes = ();
442 $DoSetMagic = 1;
443
444 $orig_args =~ s/\\\s*/ /g; # process line continuations
445 my @args;
446
447 my %only_C_inlist; # Not in the signature of Perl function
448 if ($process_argtypes and $orig_args =~ /\S/) {
449 my $args = "$orig_args ,";
450 if ($args =~ /^( (??{ $C_arg }) , )* $ /x) {
451 @args = ($args =~ /\G ( (??{ $C_arg }) ) , /xg);
452 for ( @args ) {
453 s/^\s+//;
454 s/\s+$//;
455 my ($arg, $default) = / ( [^=]* ) ( (?: = .* )? ) /x;
456 my ($pre, $name) = ($arg =~ /(.*?) \s*
457 \b ( \w+ | length\( \s*\w+\s* \) )
458 \s* $ /x);
459 next unless defined($pre) && length($pre);
460 my $out_type;
461 my $inout_var;
462 if ($process_inout and s/^(IN|IN_OUTLIST|OUTLIST|OUT|IN_OUT)\s+//) {
463 my $type = $1;
464 $out_type = $type if $type ne 'IN';
465 $arg =~ s/^(IN|IN_OUTLIST|OUTLIST|OUT|IN_OUT)\s+//;
466 $pre =~ s/^(IN|IN_OUTLIST|OUTLIST|OUT|IN_OUT)\s+//;
467 }
468 my $islength;
469 if ($name =~ /^length\( \s* (\w+) \s* \)\z/x) {
470 $name = "XSauto_length_of_$1";
471 $islength = 1;
472 die "Default value on length() argument: `$_'"
473 if length $default;
474 }
475 if (length $pre or $islength) { # Has a type
476 if ($islength) {
477 push @fake_INPUT_pre, $arg;
478 } else {
479 push @fake_INPUT, $arg;
480 }
481 # warn "pushing '$arg'\n";
482 $argtype_seen{$name}++;
483 $_ = "$name$default"; # Assigns to @args
484 }
485 $only_C_inlist{$_} = 1 if $out_type eq "OUTLIST" or $islength;
486 push @outlist, $name if $out_type =~ /OUTLIST$/;
487 $in_out{$name} = $out_type if $out_type;
488 }
489 } else {
490 @args = split(/\s*,\s*/, $orig_args);
491 Warn("Warning: cannot parse argument list '$orig_args', fallback to split");
492 }
493 } else {
494 @args = split(/\s*,\s*/, $orig_args);
495 for (@args) {
496 if ($process_inout and s/^(IN|IN_OUTLIST|OUTLIST|IN_OUT|OUT)\s+//) {
497 my $out_type = $1;
498 next if $out_type eq 'IN';
499 $only_C_inlist{$_} = 1 if $out_type eq "OUTLIST";
500 push @outlist, $name if $out_type =~ /OUTLIST$/;
501 $in_out{$_} = $out_type;
502 }
503 }
504 }
505 if (defined($class)) {
506 my $arg0 = ((defined($static) or $func_name eq 'new')
507 ? "CLASS" : "THIS");
508 unshift(@args, $arg0);
509 ($report_args = "$arg0, $report_args") =~ s/^\w+, $/$arg0/;
510 }
511 my $extra_args = 0;
512 @args_num = ();
513 $num_args = 0;
514 my $report_args = '';
515 foreach my $i (0 .. $#args) {
516 if ($args[$i] =~ s/\.\.\.//) {
517 $elipsis = 1;
518 if ($args[$i] eq '' && $i == $#args) {
519 $report_args .= ", ...";
520 pop(@args);
521 last;
522 }
523 }
524 if ($only_C_inlist{$args[$i]}) {
525 push @args_num, undef;
526 } else {
527 push @args_num, ++$num_args;
528 $report_args .= ", $args[$i]";
529 }
530 if ($args[$i] =~ /^([^=]*[^\s=])\s*=\s*(.*)/s) {
531 $extra_args++;
532 $args[$i] = $1;
533 $defaults{$args[$i]} = $2;
534 $defaults{$args[$i]} =~ s/"/\\"/g;
535 }
536 $proto_arg[$i+1] = '$' ;
537 }
538 $min_args = $num_args - $extra_args;
539 $report_args =~ s/"/\\"/g;
540 $report_args =~ s/^,\s+//;
541 my @func_args = @args;
542 shift @func_args if defined($class);
543
544 for (@func_args) {
545 s/^/&/ if $in_out{$_};
546 }
547 $func_args = join(", ", @func_args);
548 @args_match{@args} = @args_num;
549
550 $PPCODE = grep(/^\s*PPCODE\s*:/, @line);
551 $CODE = grep(/^\s*CODE\s*:/, @line);
552 # Detect CODE: blocks which use ST(n)= or XST_m*(n,v)
553 # to set explicit return values.
554 $EXPLICIT_RETURN = ($CODE &&
555 ("@line" =~ /(\bST\s*\([^;]*=) | (\bXST_m\w+\s*\()/x ));
556 $ALIAS = grep(/^\s*ALIAS\s*:/, @line);
557 $INTERFACE = grep(/^\s*INTERFACE\s*:/, @line);
558
559 $xsreturn = 1 if $EXPLICIT_RETURN;
560
008fb49c 561 $externC = $externC ? qq[extern "C"] : "";
562
6b09c160 563 # print function header
564 print Q(<<"EOF");
008fb49c 565#$externC
6b09c160 566#XS(XS_${Full_func_name}); /* prototype to pass -Wmissing-prototypes */
567#XS(XS_${Full_func_name})
568#[[
97aff369 569##ifdef dVAR
570# dVAR; dXSARGS;
571##else
6b09c160 572# dXSARGS;
97aff369 573##endif
6b09c160 574EOF
575 print Q(<<"EOF") if $ALIAS ;
576# dXSI32;
577EOF
578 print Q(<<"EOF") if $INTERFACE ;
579# dXSFUNCTION($ret_type);
580EOF
581 if ($elipsis) {
582 $cond = ($min_args ? qq(items < $min_args) : 0);
583 } elsif ($min_args == $num_args) {
584 $cond = qq(items != $min_args);
585 } else {
586 $cond = qq(items < $min_args || items > $num_args);
587 }
588
589 print Q(<<"EOF") if $except;
590# char errbuf[1024];
591# *errbuf = '\0';
592EOF
593
594 if ($ALIAS)
595 { print Q(<<"EOF") if $cond }
596# if ($cond)
bfb0b58a 597# Perl_croak(aTHX_ "Usage: %s(%s)", GvNAME(CvGV(cv)), "$report_args");
6b09c160 598EOF
599 else
600 { print Q(<<"EOF") if $cond }
601# if ($cond)
bfb0b58a 602# Perl_croak(aTHX_ "Usage: %s(%s)", "$pname", "$report_args");
6b09c160 603EOF
604
605 # cv doesn't seem to be used, in most cases unless we go in
606 # the if of this else
607 print Q(<<"EOF");
608# PERL_UNUSED_VAR(cv); /* -W */
609EOF
610
611 #gcc -Wall: if an xsub has PPCODE is used
612 #it is possible none of ST, XSRETURN or XSprePUSH macros are used
613 #hence `ax' (setup by dXSARGS) is unused
614 #XXX: could breakup the dXSARGS; into dSP;dMARK;dITEMS
615 #but such a move could break third-party extensions
616 print Q(<<"EOF") if $PPCODE;
617# PERL_UNUSED_VAR(ax); /* -Wall */
618EOF
619
620 print Q(<<"EOF") if $PPCODE;
621# SP -= items;
622EOF
623
624 # Now do a block of some sort.
625
626 $condnum = 0;
627 $cond = ''; # last CASE: condidional
628 push(@line, "$END:");
629 push(@line_no, $line_no[-1]);
630 $_ = '';
631 &check_cpp;
632 while (@line) {
633 &CASE_handler if check_keyword("CASE");
634 print Q(<<"EOF");
635# $except [[
636EOF
637
638 # do initialization of input variables
639 $thisdone = 0;
640 $retvaldone = 0;
641 $deferred = "";
642 %arg_list = () ;
643 $gotRETVAL = 0;
644
645 INPUT_handler() ;
646 process_keyword("INPUT|PREINIT|INTERFACE_MACRO|C_ARGS|ALIAS|ATTRS|PROTOTYPE|SCOPE|OVERLOAD") ;
647
648 print Q(<<"EOF") if $ScopeThisXSUB;
649# ENTER;
650# [[
651EOF
652
653 if (!$thisdone && defined($class)) {
654 if (defined($static) or $func_name eq 'new') {
655 print "\tchar *";
656 $var_types{"CLASS"} = "char *";
657 &generate_init("char *", 1, "CLASS");
658 }
659 else {
660 print "\t$class *";
661 $var_types{"THIS"} = "$class *";
662 &generate_init("$class *", 1, "THIS");
663 }
664 }
665
666 # do code
667 if (/^\s*NOT_IMPLEMENTED_YET/) {
668 print "\n\tPerl_croak(aTHX_ \"$pname: not implemented yet\");\n";
669 $_ = '' ;
670 } else {
671 if ($ret_type ne "void") {
672 print "\t" . &map_type($ret_type, 'RETVAL') . ";\n"
673 if !$retvaldone;
674 $args_match{"RETVAL"} = 0;
675 $var_types{"RETVAL"} = $ret_type;
676 print "\tdXSTARG;\n"
677 if $WantOptimize and $targetable{$type_kind{$ret_type}};
678 }
679
680 if (@fake_INPUT or @fake_INPUT_pre) {
681 unshift @line, @fake_INPUT_pre, @fake_INPUT, $_;
682 $_ = "";
683 $processing_arg_with_types = 1;
684 INPUT_handler() ;
685 }
686 print $deferred;
687
688 process_keyword("INIT|ALIAS|ATTRS|PROTOTYPE|INTERFACE_MACRO|INTERFACE|C_ARGS|OVERLOAD") ;
689
690 if (check_keyword("PPCODE")) {
691 print_section();
692 death ("PPCODE must be last thing") if @line;
693 print "\tLEAVE;\n" if $ScopeThisXSUB;
694 print "\tPUTBACK;\n\treturn;\n";
695 } elsif (check_keyword("CODE")) {
696 print_section() ;
697 } elsif (defined($class) and $func_name eq "DESTROY") {
698 print "\n\t";
699 print "delete THIS;\n";
700 } else {
701 print "\n\t";
702 if ($ret_type ne "void") {
703 print "RETVAL = ";
704 $wantRETVAL = 1;
705 }
706 if (defined($static)) {
707 if ($func_name eq 'new') {
708 $func_name = "$class";
709 } else {
710 print "${class}::";
711 }
712 } elsif (defined($class)) {
713 if ($func_name eq 'new') {
714 $func_name .= " $class";
715 } else {
716 print "THIS->";
717 }
718 }
719 $func_name =~ s/^\Q$args{'s'}//
720 if exists $args{'s'};
721 $func_name = 'XSFUNCTION' if $interface;
722 print "$func_name($func_args);\n";
723 }
724 }
725
726 # do output variables
727 $gotRETVAL = 0; # 1 if RETVAL seen in OUTPUT section;
728 undef $RETVAL_code ; # code to set RETVAL (from OUTPUT section);
729 # $wantRETVAL set if 'RETVAL =' autogenerated
730 ($wantRETVAL, $ret_type) = (0, 'void') if $RETVAL_no_return;
731 undef %outargs ;
732 process_keyword("POSTCALL|OUTPUT|ALIAS|ATTRS|PROTOTYPE|OVERLOAD");
733
734 &generate_output($var_types{$_}, $args_match{$_}, $_, $DoSetMagic)
735 for grep $in_out{$_} =~ /OUT$/, keys %in_out;
736
737 # all OUTPUT done, so now push the return value on the stack
738 if ($gotRETVAL && $RETVAL_code) {
739 print "\t$RETVAL_code\n";
740 } elsif ($gotRETVAL || $wantRETVAL) {
741 my $t = $WantOptimize && $targetable{$type_kind{$ret_type}};
742 my $var = 'RETVAL';
743 my $type = $ret_type;
744
745 # 0: type, 1: with_size, 2: how, 3: how_size
746 if ($t and not $t->[1] and $t->[0] eq 'p') {
747 # PUSHp corresponds to setpvn. Treate setpv directly
748 my $what = eval qq("$t->[2]");
749 warn $@ if $@;
750
751 print "\tsv_setpv(TARG, $what); XSprePUSH; PUSHTARG;\n";
752 $prepush_done = 1;
753 }
754 elsif ($t) {
755 my $what = eval qq("$t->[2]");
756 warn $@ if $@;
757
758 my $size = $t->[3];
759 $size = '' unless defined $size;
760 $size = eval qq("$size");
761 warn $@ if $@;
762 print "\tXSprePUSH; PUSH$t->[0]($what$size);\n";
763 $prepush_done = 1;
764 }
765 else {
766 # RETVAL almost never needs SvSETMAGIC()
767 &generate_output($ret_type, 0, 'RETVAL', 0);
768 }
769 }
770
771 $xsreturn = 1 if $ret_type ne "void";
772 my $num = $xsreturn;
773 my $c = @outlist;
774 print "\tXSprePUSH;" if $c and not $prepush_done;
775 print "\tEXTEND(SP,$c);\n" if $c;
776 $xsreturn += $c;
777 generate_output($var_types{$_}, $num++, $_, 0, 1) for @outlist;
778
779 # do cleanup
780 process_keyword("CLEANUP|ALIAS|ATTRS|PROTOTYPE|OVERLOAD") ;
781
782 print Q(<<"EOF") if $ScopeThisXSUB;
783# ]]
784EOF
785 print Q(<<"EOF") if $ScopeThisXSUB and not $PPCODE;
786# LEAVE;
787EOF
788
789 # print function trailer
790 print Q(<<"EOF");
791# ]]
792EOF
793 print Q(<<"EOF") if $except;
794# BEGHANDLERS
795# CATCHALL
796# sprintf(errbuf, "%s: %s\\tpropagated", Xname, Xreason);
797# ENDHANDLERS
798EOF
799 if (check_keyword("CASE")) {
800 blurt ("Error: No `CASE:' at top of function")
801 unless $condnum;
802 $_ = "CASE: $_"; # Restore CASE: label
803 next;
804 }
805 last if $_ eq "$END:";
806 death(/^$BLOCK_re/o ? "Misplaced `$1:'" : "Junk at end of function");
807 }
808
809 print Q(<<"EOF") if $except;
810# if (errbuf[0])
811# Perl_croak(aTHX_ errbuf);
812EOF
813
814 if ($xsreturn) {
815 print Q(<<"EOF") unless $PPCODE;
816# XSRETURN($xsreturn);
817EOF
818 } else {
819 print Q(<<"EOF") unless $PPCODE;
820# XSRETURN_EMPTY;
821EOF
822 }
823
824 print Q(<<"EOF");
825#]]
826#
827EOF
828
829 my $newXS = "newXS" ;
830 my $proto = "" ;
831
832 # Build the prototype string for the xsub
833 if ($ProtoThisXSUB) {
834 $newXS = "newXSproto";
835
836 if ($ProtoThisXSUB eq 2) {
837 # User has specified empty prototype
838 }
839 elsif ($ProtoThisXSUB eq 1) {
840 my $s = ';';
841 if ($min_args < $num_args) {
842 $s = '';
843 $proto_arg[$min_args] .= ";" ;
844 }
845 push @proto_arg, "$s\@"
846 if $elipsis ;
847
848 $proto = join ("", grep defined, @proto_arg);
849 }
850 else {
851 # User has specified a prototype
852 $proto = $ProtoThisXSUB;
853 }
854 $proto = qq{, "$proto"};
855 }
856
857 if (%XsubAliases) {
858 $XsubAliases{$pname} = 0
859 unless defined $XsubAliases{$pname} ;
860 while ( ($name, $value) = each %XsubAliases) {
861 push(@InitFileCode, Q(<<"EOF"));
862# cv = newXS(\"$name\", XS_$Full_func_name, file);
863# XSANY.any_i32 = $value ;
864EOF
865 push(@InitFileCode, Q(<<"EOF")) if $proto;
866# sv_setpv((SV*)cv$proto) ;
867EOF
868 }
869 }
870 elsif (@Attributes) {
871 push(@InitFileCode, Q(<<"EOF"));
872# cv = newXS(\"$pname\", XS_$Full_func_name, file);
873# apply_attrs_string("$Package", cv, "@Attributes", 0);
874EOF
875 }
876 elsif ($interface) {
877 while ( ($name, $value) = each %Interfaces) {
878 $name = "$Package\::$name" unless $name =~ /::/;
879 push(@InitFileCode, Q(<<"EOF"));
880# cv = newXS(\"$name\", XS_$Full_func_name, file);
881# $interface_macro_set(cv,$value) ;
882EOF
883 push(@InitFileCode, Q(<<"EOF")) if $proto;
884# sv_setpv((SV*)cv$proto) ;
885EOF
886 }
887 }
888 else {
889 push(@InitFileCode,
890 " ${newXS}(\"$pname\", XS_$Full_func_name, file$proto);\n");
891 }
892 }
893
894 if ($Overload) # make it findable with fetchmethod
895 {
896 print Q(<<"EOF");
897#XS(XS_${Packid}_nil); /* prototype to pass -Wmissing-prototypes */
898#XS(XS_${Packid}_nil)
899#{
900# XSRETURN_EMPTY;
901#}
902#
903EOF
904 unshift(@InitFileCode, <<"MAKE_FETCHMETHOD_WORK");
905 /* Making a sub named "${Package}::()" allows the package */
906 /* to be findable via fetchmethod(), and causes */
907 /* overload::Overloaded("${Package}") to return true. */
908 newXS("${Package}::()", XS_${Packid}_nil, file$proto);
909MAKE_FETCHMETHOD_WORK
910 }
911
912 # print initialization routine
913
914 print Q(<<"EOF");
915##ifdef __cplusplus
916#extern "C"
917##endif
918EOF
919
920 print Q(<<"EOF");
921#XS(boot_$Module_cname); /* prototype to pass -Wmissing-prototypes */
922#XS(boot_$Module_cname)
923EOF
924
925 print Q(<<"EOF");
926#[[
97aff369 927##ifdef dVAR
928# dVAR; dXSARGS;
929##else
6b09c160 930# dXSARGS;
97aff369 931##endif
6b09c160 932EOF
933
934 #-Wall: if there is no $Full_func_name there are no xsubs in this .xs
935 #so `file' is unused
936 print Q(<<"EOF") if $Full_func_name;
937# char* file = __FILE__;
938EOF
939
940 print Q("#\n");
941
942 print Q(<<"EOF");
943# PERL_UNUSED_VAR(cv); /* -W */
944# PERL_UNUSED_VAR(items); /* -W */
945EOF
946
947 print Q(<<"EOF") if $WantVersionChk ;
948# XS_VERSION_BOOTCHECK ;
949#
950EOF
951
952 print Q(<<"EOF") if defined $XsubAliases or defined $Interfaces ;
953# {
954# CV * cv ;
955#
956EOF
957
958 print Q(<<"EOF") if ($Overload);
959# /* register the overloading (type 'A') magic */
960# PL_amagic_generation++;
961# /* The magic for overload gets a GV* via gv_fetchmeth as */
962# /* mentioned above, and looks in the SV* slot of it for */
963# /* the "fallback" status. */
964# sv_setsv(
965# get_sv( "${Package}::()", TRUE ),
966# $Fallback
967# );
968EOF
969
970 print @InitFileCode;
971
972 print Q(<<"EOF") if defined $XsubAliases or defined $Interfaces ;
973# }
974EOF
975
976 if (@BootCode)
977 {
978 print "\n /* Initialisation Section */\n\n" ;
979 @line = @BootCode;
980 print_section();
981 print "\n /* End of Initialisation Section */\n\n" ;
982 }
983
0932863f 984 if ($] >= 5.009) {
985 print <<'EOF';
986 if (PL_unitcheckav)
987 call_list(PL_scopestack_ix, PL_unitcheckav);
988EOF
989 }
6b09c160 990 print Q(<<"EOF");
991# XSRETURN_YES;
992#]]
993#
994EOF
995
996 warn("Please specify prototyping behavior for $filename (see perlxs manual)\n")
997 unless $ProtoUsed ;
998
999 chdir($orig_cwd);
1000 select($orig_fh);
1001 untie *PSEUDO_STDOUT if tied *PSEUDO_STDOUT;
907ce46c 1002 close $FH;
6b09c160 1003
1004 return 1;
1005}
1006
1007sub errors { $errors }
1008
1009sub standard_typemap_locations {
1010 # Add all the default typemap locations to the search path
1011 my @tm = qw(typemap);
1012
1013 my $updir = File::Spec->updir;
1014 foreach my $dir (File::Spec->catdir(($updir) x 1), File::Spec->catdir(($updir) x 2),
1015 File::Spec->catdir(($updir) x 3), File::Spec->catdir(($updir) x 4)) {
1016
1017 unshift @tm, File::Spec->catfile($dir, 'typemap');
1018 unshift @tm, File::Spec->catfile($dir, lib => ExtUtils => 'typemap');
1019 }
1020 foreach my $dir (@INC) {
1021 my $file = File::Spec->catfile($dir, ExtUtils => 'typemap');
1022 unshift @tm, $file if -e $file;
1023 }
1024 return @tm;
1025}
1026
1027sub TrimWhitespace
1028{
1029 $_[0] =~ s/^\s+|\s+$//go ;
1030}
1031
1032sub TidyType
1033 {
1034 local ($_) = @_ ;
1035
1036 # rationalise any '*' by joining them into bunches and removing whitespace
1037 s#\s*(\*+)\s*#$1#g;
1038 s#(\*+)# $1 #g ;
1039
1040 # change multiple whitespace into a single space
1041 s/\s+/ /g ;
1042
1043 # trim leading & trailing whitespace
1044 TrimWhitespace($_) ;
1045
1046 $_ ;
1047}
1048
1049# Input: ($_, @line) == unparsed input.
1050# Output: ($_, @line) == (rest of line, following lines).
1051# Return: the matched keyword if found, otherwise 0
1052sub check_keyword {
1053 $_ = shift(@line) while !/\S/ && @line;
1054 s/^(\s*)($_[0])\s*:\s*(?:#.*)?/$1/s && $2;
1055}
1056
1057sub print_section {
1058 # the "do" is required for right semantics
1059 do { $_ = shift(@line) } while !/\S/ && @line;
1060
1061 print("#line ", $line_no[@line_no - @line -1], " \"$filepathname\"\n")
1062 if $WantLineNumbers && !/^\s*#\s*line\b/ && !/^#if XSubPPtmp/;
1063 for (; defined($_) && !/^$BLOCK_re/o; $_ = shift(@line)) {
1064 print "$_\n";
1065 }
1066 print 'ExtUtils::ParseXS::CountLines'->end_marker, "\n" if $WantLineNumbers;
1067}
1068
1069sub merge_section {
1070 my $in = '';
1071
1072 while (!/\S/ && @line) {
1073 $_ = shift(@line);
1074 }
1075
1076 for (; defined($_) && !/^$BLOCK_re/o; $_ = shift(@line)) {
1077 $in .= "$_\n";
1078 }
1079 chomp $in;
1080 return $in;
1081 }
1082
1083sub process_keyword($)
1084 {
1085 my($pattern) = @_ ;
1086 my $kwd ;
1087
1088 &{"${kwd}_handler"}()
1089 while $kwd = check_keyword($pattern) ;
1090 }
1091
1092sub CASE_handler {
1093 blurt ("Error: `CASE:' after unconditional `CASE:'")
1094 if $condnum && $cond eq '';
1095 $cond = $_;
1096 TrimWhitespace($cond);
1097 print " ", ($condnum++ ? " else" : ""), ($cond ? " if ($cond)\n" : "\n");
1098 $_ = '' ;
1099}
1100
1101sub INPUT_handler {
1102 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
1103 last if /^\s*NOT_IMPLEMENTED_YET/;
1104 next unless /\S/; # skip blank lines
1105
1106 TrimWhitespace($_) ;
1107 my $line = $_ ;
1108
1109 # remove trailing semicolon if no initialisation
1110 s/\s*;$//g unless /[=;+].*\S/ ;
1111
1112 # Process the length(foo) declarations
1113 if (s/^([^=]*)\blength\(\s*(\w+)\s*\)\s*$/$1 XSauto_length_of_$2=NO_INIT/x) {
1114 print "\tSTRLEN\tSTRLEN_length_of_$2;\n";
1115 $lengthof{$2} = $name;
1116 # $islengthof{$name} = $1;
1117 $deferred .= "\n\tXSauto_length_of_$2 = STRLEN_length_of_$2;";
1118 }
1119
1120 # check for optional initialisation code
1121 my $var_init = '' ;
1122 $var_init = $1 if s/\s*([=;+].*)$//s ;
1123 $var_init =~ s/"/\\"/g;
1124
1125 s/\s+/ /g;
1126 my ($var_type, $var_addr, $var_name) = /^(.*?[^&\s])\s*(\&?)\s*\b(\w+)$/s
1127 or blurt("Error: invalid argument declaration '$line'"), next;
1128
1129 # Check for duplicate definitions
1130 blurt ("Error: duplicate definition of argument '$var_name' ignored"), next
1131 if $arg_list{$var_name}++
1132 or defined $argtype_seen{$var_name} and not $processing_arg_with_types;
1133
1134 $thisdone |= $var_name eq "THIS";
1135 $retvaldone |= $var_name eq "RETVAL";
1136 $var_types{$var_name} = $var_type;
1137 # XXXX This check is a safeguard against the unfinished conversion of
1138 # generate_init(). When generate_init() is fixed,
1139 # one can use 2-args map_type() unconditionally.
1140 if ($var_type =~ / \( \s* \* \s* \) /x) {
1141 # Function pointers are not yet supported with &output_init!
1142 print "\t" . &map_type($var_type, $var_name);
1143 $name_printed = 1;
1144 } else {
1145 print "\t" . &map_type($var_type);
1146 $name_printed = 0;
1147 }
1148 $var_num = $args_match{$var_name};
1149
1150 $proto_arg[$var_num] = ProtoString($var_type)
1151 if $var_num ;
1152 $func_args =~ s/\b($var_name)\b/&$1/ if $var_addr;
1153 if ($var_init =~ /^[=;]\s*NO_INIT\s*;?\s*$/
1154 or $in_out{$var_name} and $in_out{$var_name} =~ /^OUT/
1155 and $var_init !~ /\S/) {
1156 if ($name_printed) {
1157 print ";\n";
1158 } else {
1159 print "\t$var_name;\n";
1160 }
1161 } elsif ($var_init =~ /\S/) {
1162 &output_init($var_type, $var_num, $var_name, $var_init, $name_printed);
1163 } elsif ($var_num) {
1164 # generate initialization code
1165 &generate_init($var_type, $var_num, $var_name, $name_printed);
1166 } else {
1167 print ";\n";
1168 }
1169 }
1170}
1171
1172sub OUTPUT_handler {
1173 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
1174 next unless /\S/;
1175 if (/^\s*SETMAGIC\s*:\s*(ENABLE|DISABLE)\s*/) {
1176 $DoSetMagic = ($1 eq "ENABLE" ? 1 : 0);
1177 next;
1178 }
1179 my ($outarg, $outcode) = /^\s*(\S+)\s*(.*?)\s*$/s ;
1180 blurt ("Error: duplicate OUTPUT argument '$outarg' ignored"), next
1181 if $outargs{$outarg} ++ ;
1182 if (!$gotRETVAL and $outarg eq 'RETVAL') {
1183 # deal with RETVAL last
1184 $RETVAL_code = $outcode ;
1185 $gotRETVAL = 1 ;
1186 next ;
1187 }
1188 blurt ("Error: OUTPUT $outarg not an argument"), next
1189 unless defined($args_match{$outarg});
1190 blurt("Error: No input definition for OUTPUT argument '$outarg' - ignored"), next
1191 unless defined $var_types{$outarg} ;
1192 $var_num = $args_match{$outarg};
1193 if ($outcode) {
1194 print "\t$outcode\n";
1195 print "\tSvSETMAGIC(ST(" , $var_num-1 , "));\n" if $DoSetMagic;
1196 } else {
1197 &generate_output($var_types{$outarg}, $var_num, $outarg, $DoSetMagic);
1198 }
1199 delete $in_out{$outarg} # No need to auto-OUTPUT
1200 if exists $in_out{$outarg} and $in_out{$outarg} =~ /OUT$/;
1201 }
1202}
1203
1204sub C_ARGS_handler() {
1205 my $in = merge_section();
1206
1207 TrimWhitespace($in);
1208 $func_args = $in;
1209}
1210
1211sub INTERFACE_MACRO_handler() {
1212 my $in = merge_section();
1213
1214 TrimWhitespace($in);
1215 if ($in =~ /\s/) { # two
1216 ($interface_macro, $interface_macro_set) = split ' ', $in;
1217 } else {
1218 $interface_macro = $in;
1219 $interface_macro_set = 'UNKNOWN_CVT'; # catch later
1220 }
1221 $interface = 1; # local
1222 $Interfaces = 1; # global
1223}
1224
1225sub INTERFACE_handler() {
1226 my $in = merge_section();
1227
1228 TrimWhitespace($in);
1229
1230 foreach (split /[\s,]+/, $in) {
5331dc36 1231 my $name = $_;
1232 $name =~ s/^$Prefix//;
1233 $Interfaces{$name} = $_;
6b09c160 1234 }
1235 print Q(<<"EOF");
1236# XSFUNCTION = $interface_macro($ret_type,cv,XSANY.any_dptr);
1237EOF
1238 $interface = 1; # local
1239 $Interfaces = 1; # global
1240}
1241
1242sub CLEANUP_handler() { print_section() }
1243sub PREINIT_handler() { print_section() }
1244sub POSTCALL_handler() { print_section() }
1245sub INIT_handler() { print_section() }
1246
1247sub GetAliases
1248 {
1249 my ($line) = @_ ;
1250 my ($orig) = $line ;
1251 my ($alias) ;
1252 my ($value) ;
1253
1254 # Parse alias definitions
1255 # format is
1256 # alias = value alias = value ...
1257
1258 while ($line =~ s/^\s*([\w:]+)\s*=\s*(\w+)\s*//) {
1259 $alias = $1 ;
1260 $orig_alias = $alias ;
1261 $value = $2 ;
1262
1263 # check for optional package definition in the alias
1264 $alias = $Packprefix . $alias if $alias !~ /::/ ;
1265
1266 # check for duplicate alias name & duplicate value
1267 Warn("Warning: Ignoring duplicate alias '$orig_alias'")
1268 if defined $XsubAliases{$alias} ;
1269
1270 Warn("Warning: Aliases '$orig_alias' and '$XsubAliasValues{$value}' have identical values")
1271 if $XsubAliasValues{$value} ;
1272
1273 $XsubAliases = 1;
1274 $XsubAliases{$alias} = $value ;
1275 $XsubAliasValues{$value} = $orig_alias ;
1276 }
1277
1278 blurt("Error: Cannot parse ALIAS definitions from '$orig'")
1279 if $line ;
1280 }
1281
1282sub ATTRS_handler ()
1283 {
1284 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
1285 next unless /\S/;
1286 TrimWhitespace($_) ;
1287 push @Attributes, $_;
1288 }
1289 }
1290
1291sub ALIAS_handler ()
1292 {
1293 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
1294 next unless /\S/;
1295 TrimWhitespace($_) ;
1296 GetAliases($_) if $_ ;
1297 }
1298 }
1299
1300sub OVERLOAD_handler()
1301{
1302 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
1303 next unless /\S/;
1304 TrimWhitespace($_) ;
1305 while ( s/^\s*([\w:"\\)\+\-\*\/\%\<\>\.\&\|\^\!\~\{\}\=]+)\s*//) {
1306 $Overload = 1 unless $Overload;
1307 my $overload = "$Package\::(".$1 ;
1308 push(@InitFileCode,
1309 " newXS(\"$overload\", XS_$Full_func_name, file$proto);\n");
1310 }
1311 }
1312}
1313
1314sub FALLBACK_handler()
1315{
1316 # the rest of the current line should contain either TRUE,
1317 # FALSE or UNDEF
1318
1319 TrimWhitespace($_) ;
1320 my %map = (
1321 TRUE => "PL_sv_yes", 1 => "PL_sv_yes",
1322 FALSE => "PL_sv_no", 0 => "PL_sv_no",
1323 UNDEF => "PL_sv_undef",
1324 ) ;
1325
1326 # check for valid FALLBACK value
1327 death ("Error: FALLBACK: TRUE/FALSE/UNDEF") unless exists $map{uc $_} ;
1328
1329 $Fallback = $map{uc $_} ;
1330}
1331
1332
1333sub REQUIRE_handler ()
1334 {
1335 # the rest of the current line should contain a version number
1336 my ($Ver) = $_ ;
1337
1338 TrimWhitespace($Ver) ;
1339
1340 death ("Error: REQUIRE expects a version number")
1341 unless $Ver ;
1342
1343 # check that the version number is of the form n.n
1344 death ("Error: REQUIRE: expected a number, got '$Ver'")
1345 unless $Ver =~ /^\d+(\.\d*)?/ ;
1346
1347 death ("Error: xsubpp $Ver (or better) required--this is only $VERSION.")
1348 unless $VERSION >= $Ver ;
1349 }
1350
1351sub VERSIONCHECK_handler ()
1352 {
1353 # the rest of the current line should contain either ENABLE or
1354 # DISABLE
1355
1356 TrimWhitespace($_) ;
1357
1358 # check for ENABLE/DISABLE
1359 death ("Error: VERSIONCHECK: ENABLE/DISABLE")
1360 unless /^(ENABLE|DISABLE)/i ;
1361
1362 $WantVersionChk = 1 if $1 eq 'ENABLE' ;
1363 $WantVersionChk = 0 if $1 eq 'DISABLE' ;
1364
1365 }
1366
1367sub PROTOTYPE_handler ()
1368 {
1369 my $specified ;
1370
1371 death("Error: Only 1 PROTOTYPE definition allowed per xsub")
1372 if $proto_in_this_xsub ++ ;
1373
1374 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
1375 next unless /\S/;
1376 $specified = 1 ;
1377 TrimWhitespace($_) ;
1378 if ($_ eq 'DISABLE') {
1379 $ProtoThisXSUB = 0
1380 } elsif ($_ eq 'ENABLE') {
1381 $ProtoThisXSUB = 1
1382 } else {
1383 # remove any whitespace
1384 s/\s+//g ;
1385 death("Error: Invalid prototype '$_'")
1386 unless ValidProtoString($_) ;
1387 $ProtoThisXSUB = C_string($_) ;
1388 }
1389 }
1390
1391 # If no prototype specified, then assume empty prototype ""
1392 $ProtoThisXSUB = 2 unless $specified ;
1393
1394 $ProtoUsed = 1 ;
1395
1396 }
1397
1398sub SCOPE_handler ()
1399 {
1400 death("Error: Only 1 SCOPE declaration allowed per xsub")
1401 if $scope_in_this_xsub ++ ;
1402
1403 for (; !/^$BLOCK_re/o; $_ = shift(@line)) {
1404 next unless /\S/;
1405 TrimWhitespace($_) ;
1406 if ($_ =~ /^DISABLE/i) {
1407 $ScopeThisXSUB = 0
1408 } elsif ($_ =~ /^ENABLE/i) {
1409 $ScopeThisXSUB = 1
1410 }
1411 }
1412
1413 }
1414
1415sub PROTOTYPES_handler ()
1416 {
1417 # the rest of the current line should contain either ENABLE or
1418 # DISABLE
1419
1420 TrimWhitespace($_) ;
1421
1422 # check for ENABLE/DISABLE
1423 death ("Error: PROTOTYPES: ENABLE/DISABLE")
1424 unless /^(ENABLE|DISABLE)/i ;
1425
1426 $WantPrototypes = 1 if $1 eq 'ENABLE' ;
1427 $WantPrototypes = 0 if $1 eq 'DISABLE' ;
1428 $ProtoUsed = 1 ;
1429
1430 }
1431
1432sub INCLUDE_handler ()
1433 {
1434 # the rest of the current line should contain a valid filename
1435
1436 TrimWhitespace($_) ;
1437
1438 death("INCLUDE: filename missing")
1439 unless $_ ;
1440
1441 death("INCLUDE: output pipe is illegal")
1442 if /^\s*\|/ ;
1443
1444 # simple minded recursion detector
1445 death("INCLUDE loop detected")
1446 if $IncludedFiles{$_} ;
1447
1448 ++ $IncludedFiles{$_} unless /\|\s*$/ ;
1449
1450 # Save the current file context.
1451 push(@XSStack, {
1452 type => 'file',
1453 LastLine => $lastline,
1454 LastLineNo => $lastline_no,
1455 Line => \@line,
1456 LineNo => \@line_no,
1457 Filename => $filename,
d724ebe1 1458 Filepathname => $filepathname,
6b09c160 1459 Handle => $FH,
1460 }) ;
1461
907ce46c 1462 $FH = Symbol::gensym();
6b09c160 1463
1464 # open the new file
1465 open ($FH, "$_") or death("Cannot open '$_': $!") ;
1466
1467 print Q(<<"EOF");
1468#
1469#/* INCLUDE: Including '$_' from '$filename' */
1470#
1471EOF
1472
d724ebe1 1473 $filepathname = $filename = $_ ;
6b09c160 1474
1475 # Prime the pump by reading the first
1476 # non-blank line
1477
1478 # skip leading blank lines
1479 while (<$FH>) {
1480 last unless /^\s*$/ ;
1481 }
1482
1483 $lastline = $_ ;
1484 $lastline_no = $. ;
1485
1486 }
1487
1488sub PopFile()
1489 {
1490 return 0 unless $XSStack[-1]{type} eq 'file' ;
1491
1492 my $data = pop @XSStack ;
1493 my $ThisFile = $filename ;
1494 my $isPipe = ($filename =~ /\|\s*$/) ;
1495
1496 -- $IncludedFiles{$filename}
1497 unless $isPipe ;
1498
1499 close $FH ;
1500
1501 $FH = $data->{Handle} ;
d724ebe1 1502 # $filename is the leafname, which for some reason isused for diagnostic
1503 # messages, whereas $filepathname is the full pathname, and is used for
1504 # #line directives.
6b09c160 1505 $filename = $data->{Filename} ;
d724ebe1 1506 $filepathname = $data->{Filepathname} ;
6b09c160 1507 $lastline = $data->{LastLine} ;
1508 $lastline_no = $data->{LastLineNo} ;
1509 @line = @{ $data->{Line} } ;
1510 @line_no = @{ $data->{LineNo} } ;
1511
1512 if ($isPipe and $? ) {
1513 -- $lastline_no ;
1514 print STDERR "Error reading from pipe '$ThisFile': $! in $filename, line $lastline_no\n" ;
1515 exit 1 ;
1516 }
1517
1518 print Q(<<"EOF");
1519#
1520#/* INCLUDE: Returning to '$filename' from '$ThisFile' */
1521#
1522EOF
1523
1524 return 1 ;
1525 }
1526
1527sub ValidProtoString ($)
1528 {
1529 my($string) = @_ ;
1530
1531 if ( $string =~ /^$proto_re+$/ ) {
1532 return $string ;
1533 }
1534
1535 return 0 ;
1536 }
1537
1538sub C_string ($)
1539 {
1540 my($string) = @_ ;
1541
1542 $string =~ s[\\][\\\\]g ;
1543 $string ;
1544 }
1545
1546sub ProtoString ($)
1547 {
1548 my ($type) = @_ ;
1549
1550 $proto_letter{$type} or "\$" ;
1551 }
1552
1553sub check_cpp {
1554 my @cpp = grep(/^\#\s*(?:if|e\w+)/, @line);
1555 if (@cpp) {
1556 my ($cpp, $cpplevel);
1557 for $cpp (@cpp) {
1558 if ($cpp =~ /^\#\s*if/) {
1559 $cpplevel++;
1560 } elsif (!$cpplevel) {
1561 Warn("Warning: #else/elif/endif without #if in this function");
1562 print STDERR " (precede it with a blank line if the matching #if is outside the function)\n"
1563 if $XSStack[-1]{type} eq 'if';
1564 return;
1565 } elsif ($cpp =~ /^\#\s*endif/) {
1566 $cpplevel--;
1567 }
1568 }
1569 Warn("Warning: #if without #endif in this function") if $cpplevel;
1570 }
1571}
1572
1573
1574sub Q {
1575 my($text) = @_;
1576 $text =~ s/^#//gm;
1577 $text =~ s/\[\[/{/g;
1578 $text =~ s/\]\]/}/g;
1579 $text;
1580}
1581
1582# Read next xsub into @line from ($lastline, <$FH>).
1583sub fetch_para {
1584 # parse paragraph
1585 death ("Error: Unterminated `#if/#ifdef/#ifndef'")
1586 if !defined $lastline && $XSStack[-1]{type} eq 'if';
1587 @line = ();
1588 @line_no = () ;
1589 return PopFile() if !defined $lastline;
1590
1591 if ($lastline =~
1592 /^MODULE\s*=\s*([\w:]+)(?:\s+PACKAGE\s*=\s*([\w:]+))?(?:\s+PREFIX\s*=\s*(\S+))?\s*$/) {
1593 $Module = $1;
1594 $Package = defined($2) ? $2 : ''; # keep -w happy
1595 $Prefix = defined($3) ? $3 : ''; # keep -w happy
1596 $Prefix = quotemeta $Prefix ;
1597 ($Module_cname = $Module) =~ s/\W/_/g;
1598 ($Packid = $Package) =~ tr/:/_/;
1599 $Packprefix = $Package;
1600 $Packprefix .= "::" if $Packprefix ne "";
1601 $lastline = "";
1602 }
1603
1604 for (;;) {
1605 # Skip embedded PODs
1606 while ($lastline =~ /^=/) {
1607 while ($lastline = <$FH>) {
1608 last if ($lastline =~ /^=cut\s*$/);
1609 }
1610 death ("Error: Unterminated pod") unless $lastline;
1611 $lastline = <$FH>;
1612 chomp $lastline;
1613 $lastline =~ s/^\s+$//;
1614 }
1615 if ($lastline !~ /^\s*#/ ||
1616 # CPP directives:
1617 # ANSI: if ifdef ifndef elif else endif define undef
1618 # line error pragma
1619 # gcc: warning include_next
1620 # obj-c: import
1621 # others: ident (gcc notes that some cpps have this one)
1622 $lastline =~ /^#[ \t]*(?:(?:if|ifn?def|elif|else|endif|define|undef|pragma|error|warning|line\s+\d+|ident)\b|(?:include(?:_next)?|import)\s*["<].*[>"])/) {
1623 last if $lastline =~ /^\S/ && @line && $line[-1] eq "";
1624 push(@line, $lastline);
1625 push(@line_no, $lastline_no) ;
1626 }
1627
1628 # Read next line and continuation lines
1629 last unless defined($lastline = <$FH>);
1630 $lastline_no = $.;
1631 my $tmp_line;
1632 $lastline .= $tmp_line
1633 while ($lastline =~ /\\$/ && defined($tmp_line = <$FH>));
1634
1635 chomp $lastline;
1636 $lastline =~ s/^\s+$//;
1637 }
1638 pop(@line), pop(@line_no) while @line && $line[-1] eq "";
1639 1;
1640}
1641
1642sub output_init {
1643 local($type, $num, $var, $init, $name_printed) = @_;
1644 local($arg) = "ST(" . ($num - 1) . ")";
1645
1646 if ( $init =~ /^=/ ) {
1647 if ($name_printed) {
1648 eval qq/print " $init\\n"/;
1649 } else {
1650 eval qq/print "\\t$var $init\\n"/;
1651 }
1652 warn $@ if $@;
1653 } else {
1654 if ( $init =~ s/^\+// && $num ) {
1655 &generate_init($type, $num, $var, $name_printed);
1656 } elsif ($name_printed) {
1657 print ";\n";
1658 $init =~ s/^;//;
1659 } else {
1660 eval qq/print "\\t$var;\\n"/;
1661 warn $@ if $@;
1662 $init =~ s/^;//;
1663 }
1664 $deferred .= eval qq/"\\n\\t$init\\n"/;
1665 warn $@ if $@;
1666 }
1667}
1668
1669sub Warn
1670 {
1671 # work out the line number
1672 my $line_no = $line_no[@line_no - @line -1] ;
1673
1674 print STDERR "@_ in $filename, line $line_no\n" ;
1675 }
1676
1677sub blurt
1678 {
1679 Warn @_ ;
1680 $errors ++
1681 }
1682
1683sub death
1684 {
1685 Warn @_ ;
1686 exit 1 ;
1687 }
1688
1689sub generate_init {
1690 local($type, $num, $var) = @_;
1691 local($arg) = "ST(" . ($num - 1) . ")";
1692 local($argoff) = $num - 1;
1693 local($ntype);
1694 local($tk);
1695
1696 $type = TidyType($type) ;
1697 blurt("Error: '$type' not in typemap"), return
1698 unless defined($type_kind{$type});
1699
1700 ($ntype = $type) =~ s/\s*\*/Ptr/g;
1701 ($subtype = $ntype) =~ s/(?:Array)?(?:Ptr)?$//;
1702 $tk = $type_kind{$type};
1703 $tk =~ s/OBJ$/REF/ if $func_name =~ /DESTROY$/;
1704 if ($tk eq 'T_PV' and exists $lengthof{$var}) {
1705 print "\t$var" unless $name_printed;
1706 print " = ($type)SvPV($arg, STRLEN_length_of_$var);\n";
1707 die "default value not supported with length(NAME) supplied"
1708 if defined $defaults{$var};
1709 return;
1710 }
1711 $type =~ tr/:/_/ unless $hiertype;
1712 blurt("Error: No INPUT definition for type '$type', typekind '$type_kind{$type}' found"), return
1713 unless defined $input_expr{$tk} ;
1714 $expr = $input_expr{$tk};
1715 if ($expr =~ /DO_ARRAY_ELEM/) {
1716 blurt("Error: '$subtype' not in typemap"), return
1717 unless defined($type_kind{$subtype});
1718 blurt("Error: No INPUT definition for type '$subtype', typekind '$type_kind{$subtype}' found"), return
1719 unless defined $input_expr{$type_kind{$subtype}} ;
1720 $subexpr = $input_expr{$type_kind{$subtype}};
1721 $subexpr =~ s/\$type/\$subtype/g;
1722 $subexpr =~ s/ntype/subtype/g;
1723 $subexpr =~ s/\$arg/ST(ix_$var)/g;
1724 $subexpr =~ s/\n\t/\n\t\t/g;
1725 $subexpr =~ s/is not of (.*\")/[arg %d] is not of $1, ix_$var + 1/g;
1726 $subexpr =~ s/\$var/${var}[ix_$var - $argoff]/;
1727 $expr =~ s/DO_ARRAY_ELEM/$subexpr/;
1728 }
1729 if ($expr =~ m#/\*.*scope.*\*/#i) { # "scope" in C comments
1730 $ScopeThisXSUB = 1;
1731 }
1732 if (defined($defaults{$var})) {
1733 $expr =~ s/(\t+)/$1 /g;
1734 $expr =~ s/ /\t/g;
1735 if ($name_printed) {
1736 print ";\n";
1737 } else {
1738 eval qq/print "\\t$var;\\n"/;
1739 warn $@ if $@;
1740 }
1741 if ($defaults{$var} eq 'NO_INIT') {
1742 $deferred .= eval qq/"\\n\\tif (items >= $num) {\\n$expr;\\n\\t}\\n"/;
1743 } else {
1744 $deferred .= eval qq/"\\n\\tif (items < $num)\\n\\t $var = $defaults{$var};\\n\\telse {\\n$expr;\\n\\t}\\n"/;
1745 }
1746 warn $@ if $@;
1747 } elsif ($ScopeThisXSUB or $expr !~ /^\s*\$var =/) {
1748 if ($name_printed) {
1749 print ";\n";
1750 } else {
1751 eval qq/print "\\t$var;\\n"/;
1752 warn $@ if $@;
1753 }
1754 $deferred .= eval qq/"\\n$expr;\\n"/;
1755 warn $@ if $@;
1756 } else {
1757 die "panic: do not know how to handle this branch for function pointers"
1758 if $name_printed;
1759 eval qq/print "$expr;\\n"/;
1760 warn $@ if $@;
1761 }
1762}
1763
1764sub generate_output {
1765 local($type, $num, $var, $do_setmagic, $do_push) = @_;
1766 local($arg) = "ST(" . ($num - ($num != 0)) . ")";
1767 local($argoff) = $num - 1;
1768 local($ntype);
1769
1770 $type = TidyType($type) ;
1771 if ($type =~ /^array\(([^,]*),(.*)\)/) {
1772 print "\t$arg = sv_newmortal();\n";
1773 print "\tsv_setpvn($arg, (char *)$var, $2 * sizeof($1));\n";
1774 print "\tSvSETMAGIC($arg);\n" if $do_setmagic;
1775 } else {
1776 blurt("Error: '$type' not in typemap"), return
1777 unless defined($type_kind{$type});
1778 blurt("Error: No OUTPUT definition for type '$type', typekind '$type_kind{$type}' found"), return
1779 unless defined $output_expr{$type_kind{$type}} ;
1780 ($ntype = $type) =~ s/\s*\*/Ptr/g;
1781 $ntype =~ s/\(\)//g;
1782 ($subtype = $ntype) =~ s/(?:Array)?(?:Ptr)?$//;
1783 $expr = $output_expr{$type_kind{$type}};
1784 if ($expr =~ /DO_ARRAY_ELEM/) {
1785 blurt("Error: '$subtype' not in typemap"), return
1786 unless defined($type_kind{$subtype});
1787 blurt("Error: No OUTPUT definition for type '$subtype', typekind '$type_kind{$subtype}' found"), return
1788 unless defined $output_expr{$type_kind{$subtype}} ;
1789 $subexpr = $output_expr{$type_kind{$subtype}};
1790 $subexpr =~ s/ntype/subtype/g;
1791 $subexpr =~ s/\$arg/ST(ix_$var)/g;
1792 $subexpr =~ s/\$var/${var}[ix_$var]/g;
1793 $subexpr =~ s/\n\t/\n\t\t/g;
1794 $expr =~ s/DO_ARRAY_ELEM\n/$subexpr/;
1795 eval "print qq\a$expr\a";
1796 warn $@ if $@;
1797 print "\t\tSvSETMAGIC(ST(ix_$var));\n" if $do_setmagic;
1798 } elsif ($var eq 'RETVAL') {
1799 if ($expr =~ /^\t\$arg = new/) {
1800 # We expect that $arg has refcnt 1, so we need to
1801 # mortalize it.
1802 eval "print qq\a$expr\a";
1803 warn $@ if $@;
1804 print "\tsv_2mortal(ST($num));\n";
1805 print "\tSvSETMAGIC(ST($num));\n" if $do_setmagic;
1806 } elsif ($expr =~ /^\s*\$arg\s*=/) {
1807 # We expect that $arg has refcnt >=1, so we need
1808 # to mortalize it!
1809 eval "print qq\a$expr\a";
1810 warn $@ if $@;
1811 print "\tsv_2mortal(ST(0));\n";
1812 print "\tSvSETMAGIC(ST(0));\n" if $do_setmagic;
1813 } else {
1814 # Just hope that the entry would safely write it
1815 # over an already mortalized value. By
1816 # coincidence, something like $arg = &sv_undef
1817 # works too.
1818 print "\tST(0) = sv_newmortal();\n";
1819 eval "print qq\a$expr\a";
1820 warn $@ if $@;
1821 # new mortals don't have set magic
1822 }
1823 } elsif ($do_push) {
1824 print "\tPUSHs(sv_newmortal());\n";
1825 $arg = "ST($num)";
1826 eval "print qq\a$expr\a";
1827 warn $@ if $@;
1828 print "\tSvSETMAGIC($arg);\n" if $do_setmagic;
1829 } elsif ($arg =~ /^ST\(\d+\)$/) {
1830 eval "print qq\a$expr\a";
1831 warn $@ if $@;
1832 print "\tSvSETMAGIC($arg);\n" if $do_setmagic;
1833 }
1834 }
1835}
1836
1837sub map_type {
1838 my($type, $varname) = @_;
1839
1840 # C++ has :: in types too so skip this
1841 $type =~ tr/:/_/ unless $hiertype;
1842 $type =~ s/^array\(([^,]*),(.*)\).*/$1 */s;
1843 if ($varname) {
1844 if ($varname && $type =~ / \( \s* \* (?= \s* \) ) /xg) {
1845 (substr $type, pos $type, 0) = " $varname ";
1846 } else {
1847 $type .= "\t$varname";
1848 }
1849 }
1850 $type;
1851}
1852
1853
1854#########################################################
1855package
1856 ExtUtils::ParseXS::CountLines;
1857use strict;
1858use vars qw($SECTION_END_MARKER);
1859
1860sub TIEHANDLE {
1861 my ($class, $cfile, $fh) = @_;
1862 $cfile =~ s/\\/\\\\/g;
1863 $SECTION_END_MARKER = qq{#line --- "$cfile"};
1864
1865 return bless {buffer => '',
1866 fh => $fh,
1867 line_no => 1,
1868 }, $class;
1869}
1870
1871sub PRINT {
1872 my $self = shift;
1873 for (@_) {
1874 $self->{buffer} .= $_;
1875 while ($self->{buffer} =~ s/^([^\n]*\n)//) {
1876 my $line = $1;
1877 ++ $self->{line_no};
1878 $line =~ s|^\#line\s+---(?=\s)|#line $self->{line_no}|;
1879 print {$self->{fh}} $line;
1880 }
1881 }
1882}
1883
1884sub PRINTF {
1885 my $self = shift;
1886 my $fmt = shift;
1887 $self->PRINT(sprintf($fmt, @_));
1888}
1889
1890sub DESTROY {
1891 # Not necessary if we're careful to end with a "\n"
1892 my $self = shift;
1893 print {$self->{fh}} $self->{buffer};
1894}
1895
1896sub UNTIE {
2f47ab8e 1897 # This sub does nothing, but is neccessary for references to be released.
6b09c160 1898}
1899
1900sub end_marker {
1901 return $SECTION_END_MARKER;
1902}
1903
1904
19051;
1906__END__
1907
1908=head1 NAME
1909
1910ExtUtils::ParseXS - converts Perl XS code into C code
1911
1912=head1 SYNOPSIS
1913
1914 use ExtUtils::ParseXS qw(process_file);
1915
1916 process_file( filename => 'foo.xs' );
1917
1918 process_file( filename => 'foo.xs',
1919 output => 'bar.c',
1920 'C++' => 1,
1921 typemap => 'path/to/typemap',
1922 hiertype => 1,
1923 except => 1,
1924 prototypes => 1,
1925 versioncheck => 1,
1926 linenumbers => 1,
1927 optimize => 1,
1928 prototypes => 1,
1929 );
1930=head1 DESCRIPTION
1931
1932C<ExtUtils::ParseXS> will compile XS code into C code by embedding the constructs
1933necessary to let C functions manipulate Perl values and creates the glue
1934necessary to let Perl access those functions. The compiler uses typemaps to
1935determine how to map C function parameters and variables to Perl values.
1936
1937The compiler will search for typemap files called I<typemap>. It will use
1938the following search path to find default typemaps, with the rightmost
1939typemap taking precedence.
1940
1941 ../../../typemap:../../typemap:../typemap:typemap
1942
1943=head1 EXPORT
1944
1945None by default. C<process_file()> may be exported upon request.
1946
1947
1948=head1 FUNCTIONS
1949
1950=over 4
1951
1952=item process_xs()
1953
1954This function processes an XS file and sends output to a C file.
1955Named parameters control how the processing is done. The following
1956parameters are accepted:
1957
1958=over 4
1959
1960=item B<C++>
1961
1962Adds C<extern "C"> to the C code. Default is false.
1963
1964=item B<hiertype>
1965
2f47ab8e 1966Retains C<::> in type names so that C++ hierachical types can be
6b09c160 1967mapped. Default is false.
1968
1969=item B<except>
1970
1971Adds exception handling stubs to the C code. Default is false.
1972
1973=item B<typemap>
1974
1975Indicates that a user-supplied typemap should take precedence over the
1976default typemaps. A single typemap may be specified as a string, or
1977multiple typemaps can be specified in an array reference, with the
1978last typemap having the highest precedence.
1979
1980=item B<prototypes>
1981
1982Generates prototype code for all xsubs. Default is false.
1983
1984=item B<versioncheck>
1985
1986Makes sure at run time that the object file (derived from the C<.xs>
1987file) and the C<.pm> files have the same version number. Default is
1988true.
1989
1990=item B<linenumbers>
1991
1992Adds C<#line> directives to the C output so error messages will look
1993like they came from the original XS file. Default is true.
1994
1995=item B<optimize>
1996
1997Enables certain optimizations. The only optimization that is currently
1998affected is the use of I<target>s by the output C code (see L<perlguts>).
1999Not optimizing may significantly slow down the generated code, but this is the way
2000B<xsubpp> of 5.005 and earlier operated. Default is to optimize.
2001
2002=item B<inout>
2003
2004Enable recognition of C<IN>, C<OUT_LIST> and C<INOUT_LIST>
2005declarations. Default is true.
2006
2007=item B<argtypes>
2008
2009Enable recognition of ANSI-like descriptions of function signature.
2010Default is true.
2011
2012=item B<s>
2013
2014I have no clue what this does. Strips function prefixes?
2015
2016=back
2017
2018=item errors()
2019
2020This function returns the number of [a certain kind of] errors
2021encountered during processing of the XS file.
2022
2023=back
2024
2025=head1 AUTHOR
2026
2027Based on xsubpp code, written by Larry Wall.
2028
2029Maintained by Ken Williams, <ken@mathforum.org>
2030
2031=head1 COPYRIGHT
2032
2033Copyright 2002-2003 Ken Williams. All rights reserved.
2034
2035This library is free software; you can redistribute it and/or
2036modify it under the same terms as Perl itself.
2037
2038Based on the ExtUtils::xsubpp code by Larry Wall and the Perl 5
2039Porters, which was released under the same license terms.
2040
2041=head1 SEE ALSO
2042
2043L<perl>, ExtUtils::xsubpp, ExtUtils::MakeMaker, L<perlxs>, L<perlxstut>.
2044
2045=cut
Unnamed repository; edit this file to name it for gitweb.