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