Commit | Line | Data |
4633a7c4 |
1 | #!/usr/local/bin/perl |
2 | |
3 | use Config; |
4 | use File::Basename qw(&basename &dirname); |
8a5546a1 |
5 | use Cwd; |
4633a7c4 |
6 | |
7 | # List explicitly here the variables you want Configure to |
8 | # generate. Metaconfig only looks for shell variables, so you |
9 | # have to mention them as if they were shell variables, not |
10 | # %Config entries. Thus you write |
11 | # $startperl |
12 | # to ensure Configure will look for $Config{startperl}. |
13 | |
14 | # This forces PL files to create target in same directory as PL file. |
15 | # This is so that make depend always knows where to find PL derivatives. |
8a5546a1 |
16 | $origdir = cwd; |
44a8e56a |
17 | chdir dirname($0); |
18 | $file = basename($0, '.PL'); |
774d564b |
19 | $file .= '.com' if $^O eq 'VMS'; |
4633a7c4 |
20 | |
21 | open OUT,">$file" or die "Can't create $file: $!"; |
22 | |
23 | print "Extracting $file (with variable substitutions)\n"; |
24 | |
25 | # In this section, perl variables will be expanded during extraction. |
26 | # You can use $Config{...} to use Configure variables. |
27 | |
28 | print OUT <<"!GROK!THIS!"; |
5f05dabc |
29 | $Config{startperl} |
30 | eval 'exec $Config{perlpath} -S \$0 \${1+"\$@"}' |
31 | if \$running_under_some_shell; |
40000a8c |
32 | !GROK!THIS! |
33 | |
4633a7c4 |
34 | # In the following, perl variables are not expanded during extraction. |
35 | |
36 | print OUT <<'!NO!SUBS!'; |
cf35f3c1 |
37 | |
3edbfbe5 |
38 | =head1 NAME |
39 | |
40 | h2xs - convert .h C header files to Perl extensions |
41 | |
42 | =head1 SYNOPSIS |
43 | |
c0f8b9cd |
44 | B<h2xs> [B<-ACOPXcdf>] [B<-v> version] [B<-n> module_name] [B<-p> prefix] [B<-s> sub] [headerfile ... [extra_libraries]] |
f508c652 |
45 | |
46 | B<h2xs> B<-h> |
3edbfbe5 |
47 | |
48 | =head1 DESCRIPTION |
49 | |
a887ff11 |
50 | I<h2xs> builds a Perl extension from C header files. The extension |
51 | will include functions which can be used to retrieve the value of any |
52 | #define statement which was in the C header files. |
3edbfbe5 |
53 | |
54 | The I<module_name> will be used for the name of the extension. If |
a887ff11 |
55 | module_name is not supplied then the name of the first header file |
56 | will be used, with the first character capitalized. |
3edbfbe5 |
57 | |
58 | If the extension might need extra libraries, they should be included |
59 | here. The extension Makefile.PL will take care of checking whether |
60 | the libraries actually exist and how they should be loaded. |
61 | The extra libraries should be specified in the form -lm -lposix, etc, |
62 | just as on the cc command line. By default, the Makefile.PL will |
63 | search through the library path determined by Configure. That path |
64 | can be augmented by including arguments of the form B<-L/another/library/path> |
65 | in the extra-libraries argument. |
66 | |
67 | =head1 OPTIONS |
68 | |
69 | =over 5 |
70 | |
f508c652 |
71 | =item B<-A> |
3edbfbe5 |
72 | |
f508c652 |
73 | Omit all autoload facilities. This is the same as B<-c> but also removes the |
9ef261b5 |
74 | S<C<use AutoLoader>> statement from the .pm file. |
3edbfbe5 |
75 | |
c0f8b9cd |
76 | =item B<-C> |
77 | |
78 | Omits creation of the F<Changes> file, and adds a HISTORY section to |
79 | the POD template. |
80 | |
b73edd97 |
81 | =item B<-F> |
82 | |
83 | Additional flags to specify to C preprocessor when scanning header for |
ddf6bed1 |
84 | function declarations. Should not be used without B<-x>. |
85 | |
86 | =item B<-M> I<regular expression> |
87 | |
88 | selects functions/macros to process. |
b73edd97 |
89 | |
2920c5d2 |
90 | =item B<-O> |
91 | |
92 | Allows a pre-existing extension directory to be overwritten. |
93 | |
f508c652 |
94 | =item B<-P> |
3edbfbe5 |
95 | |
f508c652 |
96 | Omit the autogenerated stub POD section. |
3edbfbe5 |
97 | |
b73edd97 |
98 | =item B<-X> |
99 | |
100 | Omit the XS portion. Used to generate templates for a module which is not |
9ef261b5 |
101 | XS-based. C<-c> and C<-f> are implicitly enabled. |
b73edd97 |
102 | |
3edbfbe5 |
103 | =item B<-c> |
104 | |
105 | Omit C<constant()> from the .xs file and corresponding specialised |
106 | C<AUTOLOAD> from the .pm file. |
107 | |
b73edd97 |
108 | =item B<-d> |
109 | |
110 | Turn on debugging messages. |
111 | |
f508c652 |
112 | =item B<-f> |
3edbfbe5 |
113 | |
f508c652 |
114 | Allows an extension to be created for a header even if that header is |
ddf6bed1 |
115 | not found in standard include directories. |
f508c652 |
116 | |
117 | =item B<-h> |
118 | |
119 | Print the usage, help and version for this h2xs and exit. |
120 | |
121 | =item B<-n> I<module_name> |
122 | |
123 | Specifies a name to be used for the extension, e.g., S<-n RPC::DCE> |
124 | |
ddf6bed1 |
125 | =item B<-o> I<regular expression> |
126 | |
127 | Use "opaque" data type for the C types matched by the regular |
128 | expression, even if these types are C<typedef>-equivalent to types |
129 | from typemaps. Should not be used without B<-x>. |
130 | |
131 | This may be useful since, say, types which are C<typedef>-equivalent |
132 | to integers may represent OS-related handles, and one may want to work |
133 | with these handles in OO-way, as in C<$handle-E<gt>do_something()>. |
134 | Use C<-o .> if you want to handle all the C<typedef>ed types as opaque types. |
135 | |
136 | The type-to-match is whitewashed (except for commas, which have no |
137 | whitespace before them, and multiple C<*> which have no whitespace |
138 | between them). |
139 | |
ead2a595 |
140 | =item B<-p> I<prefix> |
141 | |
142 | Specify a prefix which should be removed from the Perl function names, e.g., S<-p sec_rgy_> |
143 | This sets up the XS B<PREFIX> keyword and removes the prefix from functions that are |
98a6f11e |
144 | autoloaded via the C<constant()> mechanism. |
ead2a595 |
145 | |
146 | =item B<-s> I<sub1,sub2> |
147 | |
148 | Create a perl subroutine for the specified macros rather than autoload with the constant() subroutine. |
149 | These macros are assumed to have a return type of B<char *>, e.g., S<-s sec_rgy_wildcard_name,sec_rgy_wildcard_sid>. |
150 | |
f508c652 |
151 | =item B<-v> I<version> |
152 | |
153 | Specify a version number for this extension. This version number is added |
154 | to the templates. The default is 0.01. |
3edbfbe5 |
155 | |
760ac839 |
156 | =item B<-x> |
157 | |
158 | Automatically generate XSUBs basing on function declarations in the |
159 | header file. The package C<C::Scan> should be installed. If this |
160 | option is specified, the name of the header file may look like |
161 | C<NAME1,NAME2>. In this case NAME1 is used instead of the specified string, |
b73edd97 |
162 | but XSUBs are emitted only for the declarations included from file NAME2. |
760ac839 |
163 | |
5273d82d |
164 | Note that some types of arguments/return-values for functions may |
165 | result in XSUB-declarations/typemap-entries which need |
166 | hand-editing. Such may be objects which cannot be converted from/to a |
ddf6bed1 |
167 | pointer (like C<long long>), pointers to functions, or arrays. See |
168 | also the section on L<LIMITATIONS of B<-x>>. |
5273d82d |
169 | |
3edbfbe5 |
170 | =back |
171 | |
172 | =head1 EXAMPLES |
173 | |
174 | |
175 | # Default behavior, extension is Rusers |
176 | h2xs rpcsvc/rusers |
177 | |
178 | # Same, but extension is RUSERS |
179 | h2xs -n RUSERS rpcsvc/rusers |
180 | |
181 | # Extension is rpcsvc::rusers. Still finds <rpcsvc/rusers.h> |
182 | h2xs rpcsvc::rusers |
183 | |
184 | # Extension is ONC::RPC. Still finds <rpcsvc/rusers.h> |
185 | h2xs -n ONC::RPC rpcsvc/rusers |
186 | |
187 | # Without constant() or AUTOLOAD |
188 | h2xs -c rpcsvc/rusers |
189 | |
190 | # Creates templates for an extension named RPC |
191 | h2xs -cfn RPC |
192 | |
193 | # Extension is ONC::RPC. |
194 | h2xs -cfn ONC::RPC |
195 | |
196 | # Makefile.PL will look for library -lrpc in |
197 | # additional directory /opt/net/lib |
198 | h2xs rpcsvc/rusers -L/opt/net/lib -lrpc |
199 | |
ead2a595 |
200 | # Extension is DCE::rgynbase |
201 | # prefix "sec_rgy_" is dropped from perl function names |
202 | h2xs -n DCE::rgynbase -p sec_rgy_ dce/rgynbase |
203 | |
204 | # Extension is DCE::rgynbase |
205 | # prefix "sec_rgy_" is dropped from perl function names |
206 | # subroutines are created for sec_rgy_wildcard_name and sec_rgy_wildcard_sid |
207 | h2xs -n DCE::rgynbase -p sec_rgy_ \ |
208 | -s sec_rgy_wildcard_name,sec_rgy_wildcard_sid dce/rgynbase |
3edbfbe5 |
209 | |
5273d82d |
210 | # Make XS without defines in perl.h, but with function declarations |
760ac839 |
211 | # visible from perl.h. Name of the extension is perl1. |
212 | # When scanning perl.h, define -DEXT=extern -DdEXT= -DINIT(x)= |
213 | # Extra backslashes below because the string is passed to shell. |
5273d82d |
214 | # Note that a directory with perl header files would |
215 | # be added automatically to include path. |
216 | h2xs -xAn perl1 -F "-DEXT=extern -DdEXT= -DINIT\(x\)=" perl.h |
760ac839 |
217 | |
218 | # Same with function declaration in proto.h as visible from perl.h. |
5273d82d |
219 | h2xs -xAn perl2 perl.h,proto.h |
760ac839 |
220 | |
ddf6bed1 |
221 | # Same but select only functions which match /^av_/ |
222 | h2xs -M '^av_' -xAn perl2 perl.h,proto.h |
223 | |
224 | # Same but treat SV* etc as "opaque" types |
225 | h2xs -o '^[S]V \*$' -M '^av_' -xAn perl2 perl.h,proto.h |
226 | |
3edbfbe5 |
227 | =head1 ENVIRONMENT |
228 | |
229 | No environment variables are used. |
230 | |
231 | =head1 AUTHOR |
232 | |
233 | Larry Wall and others |
234 | |
235 | =head1 SEE ALSO |
236 | |
f508c652 |
237 | L<perl>, L<perlxstut>, L<ExtUtils::MakeMaker>, and L<AutoLoader>. |
3edbfbe5 |
238 | |
239 | =head1 DIAGNOSTICS |
240 | |
760ac839 |
241 | The usual warnings if it cannot read or write the files involved. |
3edbfbe5 |
242 | |
ddf6bed1 |
243 | =head1 LIMITATIONS of B<-x> |
244 | |
245 | F<h2xs> would not distinguish whether an argument to a C function |
246 | which is of the form, say, C<int *>, is an input, output, or |
247 | input/output parameter. In particular, argument declarations of the |
248 | form |
249 | |
250 | int |
251 | foo(n) |
252 | int *n |
253 | |
254 | should be better rewritten as |
255 | |
256 | int |
257 | foo(n) |
258 | int &n |
259 | |
260 | if C<n> is an input parameter. |
261 | |
262 | Additionally, F<h2xs> has no facilities to intuit that a function |
263 | |
264 | int |
265 | foo(addr,l) |
266 | char *addr |
267 | int l |
268 | |
269 | takes a pair of address and length of data at this address, so it is better |
270 | to rewrite this function as |
271 | |
272 | int |
273 | foo(sv) |
7aff18a2 |
274 | SV *addr |
275 | PREINIT: |
276 | STRLEN len; |
277 | char *s; |
278 | CODE: |
279 | s = SvPV(sv,len); |
280 | RETVAL = foo(s, len); |
281 | OUTPUT: |
282 | RETVAL |
ddf6bed1 |
283 | |
284 | or alternately |
285 | |
286 | static int |
287 | my_foo(SV *sv) |
288 | { |
289 | STRLEN len; |
290 | char *s = SvPV(sv,len); |
291 | |
292 | return foo(s, len); |
293 | } |
294 | |
295 | MODULE = foo PACKAGE = foo PREFIX = my_ |
296 | |
297 | int |
298 | foo(sv) |
299 | SV *sv |
300 | |
301 | See L<perlxs> and L<perlxstut> for additional details. |
302 | |
3edbfbe5 |
303 | =cut |
304 | |
3cb4da91 |
305 | use strict; |
306 | |
307 | |
ddf6bed1 |
308 | my( $H2XS_VERSION ) = ' $Revision: 1.20 $ ' =~ /\$Revision:\s+([^\s]+)/; |
f508c652 |
309 | my $TEMPLATE_VERSION = '0.01'; |
ddf6bed1 |
310 | my @ARGS = @ARGV; |
a0d0e21e |
311 | |
312 | use Getopt::Std; |
313 | |
e1666bf5 |
314 | sub usage{ |
315 | warn "@_\n" if @_; |
c0f8b9cd |
316 | die "h2xs [-ACOPXcdfh] [-v version] [-n module_name] [-p prefix] [-s subs] [headerfile [extra_libraries]] |
f508c652 |
317 | version: $H2XS_VERSION |
3edbfbe5 |
318 | -A Omit all autoloading facilities (implies -c). |
c0f8b9cd |
319 | -C Omit creating the Changes file, add HISTORY heading to stub POD. |
b73edd97 |
320 | -F Additional flags for C preprocessor (used with -x). |
ddf6bed1 |
321 | -M Mask to select C functions/macros (default is select all). |
2920c5d2 |
322 | -O Allow overwriting of a pre-existing extension directory. |
f508c652 |
323 | -P Omit the stub POD section. |
9ef261b5 |
324 | -X Omit the XS portion (implies both -c and -f). |
b73edd97 |
325 | -c Omit the constant() function and specialised AUTOLOAD from the XS file. |
326 | -d Turn on debugging messages. |
327 | -f Force creation of the extension even if the C header does not exist. |
328 | -h Display this help message |
329 | -n Specify a name to use for the extension (recommended). |
ddf6bed1 |
330 | -o Regular expression for \"opaque\" types. |
b73edd97 |
331 | -p Specify a prefix which should be removed from the Perl function names. |
332 | -s Create subroutines for specified macros. |
f508c652 |
333 | -v Specify a version number for this extension. |
760ac839 |
334 | -x Autogenerate XSUBs using C::Scan. |
e1666bf5 |
335 | extra_libraries |
336 | are any libraries that might be needed for loading the |
337 | extension, e.g. -lm would try to link in the math library. |
f508c652 |
338 | "; |
e1666bf5 |
339 | } |
a0d0e21e |
340 | |
a0d0e21e |
341 | |
ddf6bed1 |
342 | getopts("ACF:M:OPXcdfhn:o:p:s:v:x") || usage; |
3cb4da91 |
343 | use vars qw($opt_A $opt_C $opt_F $opt_M $opt_O $opt_P $opt_X $opt_c |
344 | $opt_d $opt_f $opt_h $opt_n $opt_o $opt_p $opt_s $opt_v $opt_x); |
a0d0e21e |
345 | |
e1666bf5 |
346 | usage if $opt_h; |
f508c652 |
347 | |
348 | if( $opt_v ){ |
349 | $TEMPLATE_VERSION = $opt_v; |
350 | } |
9ef261b5 |
351 | |
352 | # -A implies -c. |
e1666bf5 |
353 | $opt_c = 1 if $opt_A; |
9ef261b5 |
354 | |
355 | # -X implies -c and -f |
356 | $opt_c = $opt_f = 1 if $opt_X; |
357 | |
3cb4da91 |
358 | my %const_xsub = map { $_,1 } split(/,+/, $opt_s) if $opt_s; |
359 | my $extralibs; |
360 | my @path_h; |
a0d0e21e |
361 | |
a887ff11 |
362 | while (my $arg = shift) { |
363 | if ($arg =~ /^-l/i) { |
364 | $extralibs = "$arg @ARGV"; |
365 | last; |
366 | } |
367 | push(@path_h, $arg); |
368 | } |
e1666bf5 |
369 | |
370 | usage "Must supply header file or module name\n" |
a887ff11 |
371 | unless (@path_h or $opt_n); |
e1666bf5 |
372 | |
ddf6bed1 |
373 | my $fmask; |
3cb4da91 |
374 | my $tmask; |
ddf6bed1 |
375 | |
376 | $fmask = qr{$opt_M} if defined $opt_M; |
377 | $tmask = qr{$opt_o} if defined $opt_o; |
378 | my $tmask_all = $tmask && $opt_o eq '.'; |
379 | |
380 | if ($opt_x) { |
381 | eval {require C::Scan; 1} |
382 | or die <<EOD; |
383 | C::Scan required if you use -x option. |
384 | To install C::Scan, execute |
385 | perl -MCPAN -e "install C::Scan" |
386 | EOD |
387 | unless ($tmask_all) { |
388 | $C::Scan::VERSION >= 0.70 |
389 | or die <<EOD; |
390 | C::Scan v. 0.70 or later required unless you use -o . option. |
391 | You have version $C::Scan::VERSION installed as $INC{'C/Scan.pm'}. |
392 | To install C::Scan, execute |
393 | perl -MCPAN -e "install C::Scan" |
394 | EOD |
395 | } |
7aff18a2 |
396 | } |
397 | elsif ($opt_o or $opt_F) { |
ddf6bed1 |
398 | warn <<EOD; |
399 | Options -o and -F do not make sense without -x. |
400 | EOD |
401 | } |
402 | |
3cb4da91 |
403 | my @path_h_ini = @path_h; |
404 | my ($name, %fullpath, %prefix, %seen_define, %prefixless, %const_names); |
a0d0e21e |
405 | |
a887ff11 |
406 | if( @path_h ){ |
ddf6bed1 |
407 | use Config; |
408 | use File::Spec; |
409 | my @paths; |
410 | if ($^O eq 'VMS') { # Consider overrides of default location |
3cb4da91 |
411 | # XXXX This is not equivalent to what the older version did: |
412 | # it was looking at $hadsys header-file per header-file... |
413 | my($hadsys) = grep s!^sys/!!i , @path_h; |
7aff18a2 |
414 | @paths = qw( Sys$Library VAXC$Include ); |
ddf6bed1 |
415 | push @paths, ($hadsys ? 'GNU_CC_Include[vms]' : 'GNU_CC_Include[000000]'); |
416 | push @paths, qw( DECC$Library_Include DECC$System_Include ); |
7aff18a2 |
417 | } |
418 | else { |
ddf6bed1 |
419 | @paths = (File::Spec->curdir(), $Config{usrinc}, |
420 | (split ' ', $Config{locincpth}), '/usr/include'); |
421 | } |
a887ff11 |
422 | foreach my $path_h (@path_h) { |
423 | $name ||= $path_h; |
e1666bf5 |
424 | if( $path_h =~ s#::#/#g && $opt_n ){ |
425 | warn "Nesting of headerfile ignored with -n\n"; |
426 | } |
427 | $path_h .= ".h" unless $path_h =~ /\.h$/; |
3cb4da91 |
428 | my $fullpath = $path_h; |
760ac839 |
429 | $path_h =~ s/,.*$// if $opt_x; |
3cb4da91 |
430 | $fullpath{$path_h} = $fullpath; |
ddf6bed1 |
431 | |
432 | if (not -f $path_h) { |
433 | my $tmp_path_h = $path_h; |
434 | for my $dir (@paths) { |
435 | last if -f ($path_h = File::Spec->catfile($dir, $tmp_path_h)); |
436 | } |
ead2a595 |
437 | } |
5273d82d |
438 | |
439 | if (!$opt_c) { |
440 | die "Can't find $path_h\n" if ( ! $opt_f && ! -f $path_h ); |
441 | # Scan the header file (we should deal with nested header files) |
442 | # Record the names of simple #define constants into const_names |
a887ff11 |
443 | # Function prototypes are processed below. |
5273d82d |
444 | open(CH, "<$path_h") || die "Can't open $path_h: $!\n"; |
ddf6bed1 |
445 | defines: |
5273d82d |
446 | while (<CH>) { |
3cb4da91 |
447 | if (/^[ \t]*#[ \t]*define\s+([\$\w]+)\b(?!\()\s*(?=[^" \t])(.*)/) { |
ddf6bed1 |
448 | my $def = $1; |
449 | my $rest = $2; |
450 | $rest =~ s!/\*.*?(\*/|\n)|//.*!!g; # Remove comments |
451 | $rest =~ s/^\s+//; |
452 | $rest =~ s/\s+$//; |
453 | # Cannot do: (-1) and ((LHANDLE)3) are OK: |
454 | #print("Skip non-wordy $def => $rest\n"), |
455 | # next defines if $rest =~ /[^\w\$]/; |
456 | if ($rest =~ /"/) { |
457 | print("Skip stringy $def => $rest\n") if $opt_d; |
458 | next defines; |
459 | } |
460 | print "Matched $_ ($def)\n" if $opt_d; |
461 | $seen_define{$def} = $rest; |
462 | $_ = $def; |
e1666bf5 |
463 | next if /^_.*_h_*$/i; # special case, but for what? |
760ac839 |
464 | if (defined $opt_p) { |
5273d82d |
465 | if (!/^$opt_p(\d)/) { |
466 | ++$prefix{$_} if s/^$opt_p//; |
467 | } |
468 | else { |
469 | warn "can't remove $opt_p prefix from '$_'!\n"; |
470 | } |
ead2a595 |
471 | } |
ddf6bed1 |
472 | $prefixless{$def} = $_; |
473 | if (!$fmask or /$fmask/) { |
474 | print "... Passes mask of -M.\n" if $opt_d and $fmask; |
475 | $const_names{$_}++; |
476 | } |
5273d82d |
477 | } |
478 | } |
479 | close(CH); |
e1666bf5 |
480 | } |
a887ff11 |
481 | } |
a0d0e21e |
482 | } |
483 | |
e1666bf5 |
484 | |
3cb4da91 |
485 | my $module = $opt_n || do { |
a0d0e21e |
486 | $name =~ s/\.h$//; |
487 | if( $name !~ /::/ ){ |
488 | $name =~ s#^.*/##; |
489 | $name = "\u$name"; |
490 | } |
491 | $name; |
492 | }; |
493 | |
3cb4da91 |
494 | my ($ext, $nested, @modparts, $modfname, $modpname); |
8e07c86e |
495 | (chdir 'ext', $ext = 'ext/') if -d 'ext'; |
a0d0e21e |
496 | |
497 | if( $module =~ /::/ ){ |
498 | $nested = 1; |
499 | @modparts = split(/::/,$module); |
500 | $modfname = $modparts[-1]; |
501 | $modpname = join('/',@modparts); |
502 | } |
503 | else { |
504 | $nested = 0; |
505 | @modparts = (); |
506 | $modfname = $modpname = $module; |
507 | } |
508 | |
509 | |
2920c5d2 |
510 | if ($opt_O) { |
511 | warn "Overwriting existing $ext$modpname!!!\n" if -e $modpname; |
7aff18a2 |
512 | } |
513 | else { |
2920c5d2 |
514 | die "Won't overwrite existing $ext$modpname\n" if -e $modpname; |
515 | } |
c07a80fd |
516 | if( $nested ){ |
3cb4da91 |
517 | my $modpath = ""; |
c07a80fd |
518 | foreach (@modparts){ |
519 | mkdir("$modpath$_", 0777); |
520 | $modpath .= "$_/"; |
521 | } |
522 | } |
a0d0e21e |
523 | mkdir($modpname, 0777); |
8e07c86e |
524 | chdir($modpname) || die "Can't chdir $ext$modpname: $!\n"; |
a0d0e21e |
525 | |
5273d82d |
526 | my %types_seen; |
527 | my %std_types; |
f4d63e4e |
528 | my $fdecls = []; |
529 | my $fdecls_parsed = []; |
ddf6bed1 |
530 | my $typedef_rex; |
531 | my %typedefs_pre; |
532 | my %known_fnames; |
5273d82d |
533 | |
3cb4da91 |
534 | my @fnames; |
535 | my @fnames_no_prefix; |
5273d82d |
536 | |
2920c5d2 |
537 | if( ! $opt_X ){ # use XS, unless it was disabled |
538 | open(XS, ">$modfname.xs") || die "Can't create $ext$modpname/$modfname.xs: $!\n"; |
5273d82d |
539 | if ($opt_x) { |
5273d82d |
540 | require Config; # Run-time directive |
541 | warn "Scanning typemaps...\n"; |
542 | get_typemap(); |
3cb4da91 |
543 | my @td; |
544 | my @good_td; |
545 | my $addflags = $opt_F || ''; |
546 | |
f4d63e4e |
547 | foreach my $filename (@path_h) { |
3cb4da91 |
548 | my $c; |
549 | my $filter; |
550 | |
551 | if ($fullpath{$filename} =~ /,/) { |
f4d63e4e |
552 | $filename = $`; |
553 | $filter = $'; |
554 | } |
555 | warn "Scanning $filename for functions...\n"; |
556 | $c = new C::Scan 'filename' => $filename, 'filename_filter' => $filter, |
557 | 'add_cppflags' => $addflags; |
558 | $c->set('includeDirs' => ["$Config::Config{archlib}/CORE"]); |
ddf6bed1 |
559 | |
f4d63e4e |
560 | push @$fdecls_parsed, @{ $c->get('parsed_fdecls') }; |
561 | push(@$fdecls, @{$c->get('fdecls')}); |
3cb4da91 |
562 | |
563 | push @td, @{$c->get('typedefs_maybe')}; |
564 | |
565 | unless ($tmask_all) { |
566 | warn "Scanning $filename for typedefs...\n"; |
567 | my $td = $c->get('typedef_hash'); |
568 | # eval {require 'dumpvar.pl'; ::dumpValue($td)} or warn $@ if $opt_d; |
569 | my @f_good_td = grep $td->{$_}[1] eq '', keys %$td; |
570 | push @good_td, @f_good_td; |
571 | @typedefs_pre{@f_good_td} = map $_->[0], @$td{@f_good_td}; |
572 | } |
573 | } |
574 | { local $" = '|'; |
575 | $typedef_rex = qr(\b(?<!struct )(?:@good_td)\b); |
5273d82d |
576 | } |
ddf6bed1 |
577 | %known_fnames = map @$_[1,3], @$fdecls_parsed; # [1,3] is NAME, FULLTEXT |
578 | if ($fmask) { |
579 | my @good; |
580 | for my $i (0..$#$fdecls_parsed) { |
581 | next unless $fdecls_parsed->[$i][1] =~ /$fmask/; # [1] is NAME |
582 | push @good, $i; |
583 | print "... Function $fdecls_parsed->[$i][1] passes -M mask.\n" |
584 | if $opt_d; |
585 | } |
586 | $fdecls = [@$fdecls[@good]]; |
587 | $fdecls_parsed = [@$fdecls_parsed[@good]]; |
588 | } |
3cb4da91 |
589 | @fnames = sort map $_->[1], @$fdecls_parsed; # 1 is NAME |
590 | # Sort declarations: |
591 | { |
592 | my %h = map( ($_->[1], $_), @$fdecls_parsed); |
593 | $fdecls_parsed = [ @h{@fnames} ]; |
ddf6bed1 |
594 | } |
3cb4da91 |
595 | @fnames_no_prefix = @fnames; |
596 | @fnames_no_prefix |
597 | = sort map { ++$prefix{$_} if s/^$opt_p(?!\d)//; $_ } @fnames_no_prefix; |
ddf6bed1 |
598 | # Remove macros which expand to typedefs |
ddf6bed1 |
599 | print "Typedefs are @td.\n" if $opt_d; |
600 | my %td = map {($_, $_)} @td; |
601 | # Add some other possible but meaningless values for macros |
602 | for my $k (qw(char double float int long short unsigned signed void)) { |
603 | $td{"$_$k"} = "$_$k" for ('', 'signed ', 'unsigned '); |
604 | } |
605 | # eval {require 'dumpvar.pl'; ::dumpValue( [\@td, \%td] ); 1} or warn $@; |
606 | my $n = 0; |
607 | my %bad_macs; |
608 | while (keys %td > $n) { |
609 | $n = keys %td; |
610 | my ($k, $v); |
611 | while (($k, $v) = each %seen_define) { |
612 | # print("found '$k'=>'$v'\n"), |
613 | $bad_macs{$k} = $td{$k} = $td{$v} if exists $td{$v}; |
614 | } |
615 | } |
616 | # Now %bad_macs contains names of bad macros |
617 | for my $k (keys %bad_macs) { |
618 | delete $const_names{$prefixless{$k}}; |
619 | print "Ignoring macro $k which expands to a typedef name '$bad_macs{$k}'\n" if $opt_d; |
5273d82d |
620 | } |
5273d82d |
621 | } |
2920c5d2 |
622 | } |
3cb4da91 |
623 | my @const_names = sort keys %const_names; |
5273d82d |
624 | |
8e07c86e |
625 | open(PM, ">$modfname.pm") || die "Can't create $ext$modpname/$modfname.pm: $!\n"; |
a0d0e21e |
626 | |
a0d0e21e |
627 | $" = "\n\t"; |
8e07c86e |
628 | warn "Writing $ext$modpname/$modfname.pm\n"; |
a0d0e21e |
629 | |
a0d0e21e |
630 | print PM <<"END"; |
631 | package $module; |
632 | |
51fac20b |
633 | require 5.005_62; |
2920c5d2 |
634 | use strict; |
635 | END |
636 | |
637 | if( $opt_X || $opt_c || $opt_A ){ |
638 | # we won't have our own AUTOLOAD(), so won't have $AUTOLOAD |
639 | print PM <<'END'; |
77ca0c92 |
640 | our @EXPORT_OK; |
2920c5d2 |
641 | END |
642 | } |
643 | else{ |
644 | # we'll have an AUTOLOAD(), and it will have $AUTOLOAD and |
645 | # will want Carp. |
646 | print PM <<'END'; |
647 | use Carp; |
77ca0c92 |
648 | our @EXPORT_OK; |
2920c5d2 |
649 | END |
650 | } |
651 | |
652 | print PM <<'END'; |
653 | |
a0d0e21e |
654 | require Exporter; |
2920c5d2 |
655 | END |
656 | |
657 | print PM <<"END" if ! $opt_X; # use DynaLoader, unless XS was disabled |
a0d0e21e |
658 | require DynaLoader; |
3edbfbe5 |
659 | END |
660 | |
e1666bf5 |
661 | |
9ef261b5 |
662 | # Are we using AutoLoader or not? |
663 | unless ($opt_A) { # no autoloader whatsoever. |
664 | unless ($opt_c) { # we're doing the AUTOLOAD |
665 | print PM "use AutoLoader;\n"; |
2920c5d2 |
666 | } |
9ef261b5 |
667 | else { |
668 | print PM "use AutoLoader qw(AUTOLOAD);\n" |
2920c5d2 |
669 | } |
3edbfbe5 |
670 | } |
3edbfbe5 |
671 | |
9ef261b5 |
672 | # Determine @ISA. |
77ca0c92 |
673 | my $myISA = 'our @ISA = qw(Exporter'; # We seem to always want this. |
9ef261b5 |
674 | $myISA .= ' DynaLoader' unless $opt_X; # no XS |
675 | $myISA .= ');'; |
676 | print PM "\n$myISA\n\n"; |
e1666bf5 |
677 | |
3cb4da91 |
678 | my @exported_names = (@const_names, @fnames_no_prefix); |
679 | |
3edbfbe5 |
680 | print PM<<"END"; |
e1666bf5 |
681 | # Items to export into callers namespace by default. Note: do not export |
682 | # names by default without a very good reason. Use EXPORT_OK instead. |
683 | # Do not simply export all your public functions/methods/constants. |
ddf6bed1 |
684 | |
685 | # This allows declaration use $module ':all'; |
686 | # If you do not need this, moving things directly into \@EXPORT or \@EXPORT_OK |
687 | # will save memory. |
51fac20b |
688 | our %EXPORT_TAGS = ( 'all' => [ qw( |
3cb4da91 |
689 | @exported_names |
ddf6bed1 |
690 | ) ] ); |
691 | |
51fac20b |
692 | our \@EXPORT_OK = ( \@{ \$EXPORT_TAGS{'all'} } ); |
ddf6bed1 |
693 | |
77ca0c92 |
694 | our \@EXPORT = qw( |
e1666bf5 |
695 | @const_names |
a0d0e21e |
696 | ); |
77ca0c92 |
697 | our \$VERSION = '$TEMPLATE_VERSION'; |
f508c652 |
698 | |
e1666bf5 |
699 | END |
700 | |
2920c5d2 |
701 | print PM <<"END" unless $opt_c or $opt_X; |
a0d0e21e |
702 | sub AUTOLOAD { |
3edbfbe5 |
703 | # This AUTOLOAD is used to 'autoload' constants from the constant() |
704 | # XS function. If a constant is not found then control is passed |
705 | # to the AUTOLOAD in AutoLoader. |
e1666bf5 |
706 | |
2920c5d2 |
707 | my \$constname; |
77ca0c92 |
708 | our $AUTOLOAD; |
a0d0e21e |
709 | (\$constname = \$AUTOLOAD) =~ s/.*:://; |
1d3434b8 |
710 | croak "&$module::constant not defined" if \$constname eq 'constant'; |
2920c5d2 |
711 | my \$val = constant(\$constname, \@_ ? \$_[0] : 0); |
a0d0e21e |
712 | if (\$! != 0) { |
265f5c4a |
713 | if (\$! =~ /Invalid/ || \$!{EINVAL}) { |
a0d0e21e |
714 | \$AutoLoader::AUTOLOAD = \$AUTOLOAD; |
715 | goto &AutoLoader::AUTOLOAD; |
716 | } |
717 | else { |
7aff18a2 |
718 | croak "Your vendor has not defined $module macro \$constname"; |
a0d0e21e |
719 | } |
720 | } |
7aff18a2 |
721 | { |
722 | no strict 'refs'; |
723 | # Fixed between 5.005_53 and 5.005_61 |
724 | if (\$] >= 5.00561) { |
725 | *\$AUTOLOAD = sub () { \$val }; |
726 | } |
727 | else { |
728 | *\$AUTOLOAD = sub { \$val }; |
729 | } |
ddf6bed1 |
730 | } |
a0d0e21e |
731 | goto &\$AUTOLOAD; |
732 | } |
733 | |
a0d0e21e |
734 | END |
a0d0e21e |
735 | |
2920c5d2 |
736 | if( ! $opt_X ){ # print bootstrap, unless XS is disabled |
737 | print PM <<"END"; |
f508c652 |
738 | bootstrap $module \$VERSION; |
2920c5d2 |
739 | END |
740 | } |
741 | |
3cb4da91 |
742 | my $after; |
2920c5d2 |
743 | if( $opt_P ){ # if POD is disabled |
744 | $after = '__END__'; |
745 | } |
746 | else { |
747 | $after = '=cut'; |
748 | } |
749 | |
750 | print PM <<"END"; |
a0d0e21e |
751 | |
e1666bf5 |
752 | # Preloaded methods go here. |
9ef261b5 |
753 | END |
754 | |
755 | print PM <<"END" unless $opt_A; |
a0d0e21e |
756 | |
2920c5d2 |
757 | # Autoload methods go after $after, and are processed by the autosplit program. |
9ef261b5 |
758 | END |
759 | |
760 | print PM <<"END"; |
a0d0e21e |
761 | |
762 | 1; |
e1666bf5 |
763 | __END__ |
a0d0e21e |
764 | END |
a0d0e21e |
765 | |
3cb4da91 |
766 | my $author = "A. U. Thor"; |
767 | my $email = 'a.u.thor@a.galaxy.far.far.away'; |
f508c652 |
768 | |
c0f8b9cd |
769 | my $revhist = ''; |
770 | $revhist = <<EOT if $opt_C; |
771 | |
772 | =head1 HISTORY |
773 | |
774 | =over 8 |
775 | |
776 | =item $TEMPLATE_VERSION |
777 | |
ddf6bed1 |
778 | Original version; created by h2xs $H2XS_VERSION with options |
779 | |
780 | @ARGS |
c0f8b9cd |
781 | |
782 | =back |
783 | |
784 | EOT |
785 | |
ddf6bed1 |
786 | my $exp_doc = <<EOD; |
787 | |
788 | =head2 EXPORT |
789 | |
790 | None by default. |
791 | |
792 | EOD |
5273d82d |
793 | if (@const_names and not $opt_P) { |
ddf6bed1 |
794 | $exp_doc .= <<EOD; |
795 | =head2 Exportable constants |
5273d82d |
796 | |
797 | @{[join "\n ", @const_names]} |
798 | |
799 | EOD |
800 | } |
801 | if (defined $fdecls and @$fdecls and not $opt_P) { |
ddf6bed1 |
802 | $exp_doc .= <<EOD; |
803 | =head2 Exportable functions |
5273d82d |
804 | |
3cb4da91 |
805 | EOD |
806 | $exp_doc .= <<EOD if $opt_p; |
807 | When accessing these functions from Perl, prefix C<$opt_p> should be removed. |
808 | |
809 | EOD |
810 | $exp_doc .= <<EOD; |
ddf6bed1 |
811 | @{[join "\n ", @known_fnames{@fnames}]} |
5273d82d |
812 | |
813 | EOD |
814 | } |
815 | |
3cb4da91 |
816 | my $pod = <<"END" unless $opt_P; |
7aff18a2 |
817 | ## Below is stub documentation for your module. You better edit it! |
f508c652 |
818 | # |
819 | #=head1 NAME |
820 | # |
821 | #$module - Perl extension for blah blah blah |
822 | # |
823 | #=head1 SYNOPSIS |
824 | # |
825 | # use $module; |
826 | # blah blah blah |
827 | # |
828 | #=head1 DESCRIPTION |
829 | # |
7aff18a2 |
830 | #Stub documentation for $module, created by h2xs. It looks like the |
f508c652 |
831 | #author of the extension was negligent enough to leave the stub |
832 | #unedited. |
833 | # |
834 | #Blah blah blah. |
ddf6bed1 |
835 | #$exp_doc$revhist |
f508c652 |
836 | #=head1 AUTHOR |
837 | # |
838 | #$author, $email |
839 | # |
840 | #=head1 SEE ALSO |
841 | # |
842 | #perl(1). |
843 | # |
844 | #=cut |
845 | END |
846 | |
847 | $pod =~ s/^\#//gm unless $opt_P; |
848 | print PM $pod unless $opt_P; |
849 | |
a0d0e21e |
850 | close PM; |
851 | |
e1666bf5 |
852 | |
2920c5d2 |
853 | if( ! $opt_X ){ # print XS, unless it is disabled |
8e07c86e |
854 | warn "Writing $ext$modpname/$modfname.xs\n"; |
e1666bf5 |
855 | |
a0d0e21e |
856 | print XS <<"END"; |
857 | #include "EXTERN.h" |
858 | #include "perl.h" |
859 | #include "XSUB.h" |
860 | |
861 | END |
a887ff11 |
862 | if( @path_h ){ |
3cb4da91 |
863 | foreach my $path_h (@path_h_ini) { |
a0d0e21e |
864 | my($h) = $path_h; |
865 | $h =~ s#^/usr/include/##; |
ead2a595 |
866 | if ($^O eq 'VMS') { $h =~ s#.*vms\]#sys/# or $h =~ s#.*[:>\]]##; } |
a887ff11 |
867 | print XS qq{#include <$h>\n}; |
868 | } |
869 | print XS "\n"; |
a0d0e21e |
870 | } |
871 | |
ddf6bed1 |
872 | my %pointer_typedefs; |
873 | my %struct_typedefs; |
874 | |
875 | sub td_is_pointer { |
876 | my $type = shift; |
877 | my $out = $pointer_typedefs{$type}; |
878 | return $out if defined $out; |
879 | my $otype = $type; |
880 | $out = ($type =~ /\*$/); |
881 | # This converts only the guys which do not have trailing part in the typedef |
882 | if (not $out |
883 | and $typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) { |
884 | $type = normalize_type($type); |
885 | print "Is-Pointer: Type mutation via typedefs: $otype ==> $type\n" |
886 | if $opt_d; |
887 | $out = td_is_pointer($type); |
888 | } |
889 | return ($pointer_typedefs{$otype} = $out); |
890 | } |
891 | |
892 | sub td_is_struct { |
893 | my $type = shift; |
894 | my $out = $struct_typedefs{$type}; |
895 | return $out if defined $out; |
896 | my $otype = $type; |
897 | $out = ($type =~ /^struct\b/) && !td_is_pointer($type); |
898 | # This converts only the guys which do not have trailing part in the typedef |
899 | if (not $out |
900 | and $typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) { |
901 | $type = normalize_type($type); |
902 | print "Is-Struct: Type mutation via typedefs: $otype ==> $type\n" |
903 | if $opt_d; |
904 | $out = td_is_struct($type); |
905 | } |
906 | return ($struct_typedefs{$otype} = $out); |
907 | } |
908 | |
909 | # Some macros will bomb if you try to return them from a double-returning func. |
910 | # Say, ((char *)0), or strlen (if somebody #define STRLEN strlen). |
911 | # Fortunately, we can detect both these cases... |
912 | sub protect_convert_to_double { |
913 | my $in = shift; |
914 | my $val; |
915 | return '' unless defined ($val = $seen_define{$in}); |
916 | return '(IV)' if $known_fnames{$val}; |
917 | # OUT_t of ((OUT_t)-1): |
918 | return '' unless $val =~ /^\s*(\(\s*)?\(\s*([^()]*?)\s*\)/; |
919 | td_is_pointer($2) ? '(IV)' : ''; |
a0d0e21e |
920 | } |
921 | |
ddf6bed1 |
922 | # For each of the generated functions, length($pref) leading |
923 | # letters are already checked. Moreover, it is recommended that |
924 | # the generated functions uses switch on letter at offset at least |
925 | # $off + length($pref). |
926 | # |
927 | # The given list has length($pref) chars removed at front, it is |
928 | # guarantied that $off leading chars in the rest are the same for all |
929 | # elts of the list. |
930 | # |
931 | # Returns: how at which offset it was decided to make a switch, or -1 if none. |
932 | |
933 | sub write_const; |
934 | |
935 | sub write_const { |
936 | my ($fh, $pref, $off, $list) = (shift,shift,shift,shift); |
937 | my %leading; |
938 | my $offarg = length $pref; |
939 | |
940 | if (@$list == 0) { # Can happen on the initial iteration only |
941 | print $fh <<"END"; |
a0d0e21e |
942 | static double |
3cb4da91 |
943 | constant(char *name, int len, int arg) |
a0d0e21e |
944 | { |
ddf6bed1 |
945 | errno = EINVAL; |
946 | return 0; |
947 | } |
a0d0e21e |
948 | END |
a0d0e21e |
949 | return -1; |
ddf6bed1 |
950 | } |
a0d0e21e |
951 | |
ddf6bed1 |
952 | if (@$list == 1) { # Can happen on the initial iteration only |
953 | my $protect = protect_convert_to_double("$pref$list->[0]"); |
e1666bf5 |
954 | |
ddf6bed1 |
955 | print $fh <<"END"; |
956 | static double |
3cb4da91 |
957 | constant(char *name, int len, int arg) |
ddf6bed1 |
958 | { |
959 | if (strEQ(name + $offarg, "$list->[0]")) { /* $pref removed */ |
960 | #ifdef $pref$list->[0] |
961 | return $protect$pref$list->[0]; |
962 | #else |
963 | errno = ENOENT; |
964 | return 0; |
965 | #endif |
966 | } |
967 | errno = EINVAL; |
968 | return 0; |
a0d0e21e |
969 | } |
ddf6bed1 |
970 | END |
971 | return -1; |
972 | } |
a0d0e21e |
973 | |
ddf6bed1 |
974 | for my $n (@$list) { |
975 | my $c = substr $n, $off, 1; |
976 | $leading{$c} = [] unless exists $leading{$c}; |
977 | push @{$leading{$c}}, substr $n, $off + 1; |
978 | } |
979 | |
980 | if (keys(%leading) == 1) { |
981 | return 1 + write_const $fh, $pref, $off + 1, $list; |
982 | } |
983 | |
984 | my $leader = substr $list->[0], 0, $off; |
3cb4da91 |
985 | foreach my $letter (keys %leading) { |
ddf6bed1 |
986 | write_const $fh, "$pref$leader$letter", 0, $leading{$letter} |
987 | if @{$leading{$letter}} > 1; |
988 | } |
a0d0e21e |
989 | |
ddf6bed1 |
990 | my $npref = "_$pref"; |
991 | $npref = '' if $pref eq ''; |
a0d0e21e |
992 | |
ddf6bed1 |
993 | print $fh <<"END"; |
a0d0e21e |
994 | static double |
3cb4da91 |
995 | constant$npref(char *name, int len, int arg) |
a0d0e21e |
996 | { |
997 | errno = 0; |
a0d0e21e |
998 | END |
999 | |
3cb4da91 |
1000 | print $fh <<"END" if $off; |
1001 | if ($offarg + $off >= len ) { |
1002 | errno = EINVAL; |
1003 | return 0; |
1004 | } |
1005 | END |
e1666bf5 |
1006 | |
3cb4da91 |
1007 | print $fh <<"END"; |
ddf6bed1 |
1008 | switch (name[$offarg + $off]) { |
1009 | END |
a0d0e21e |
1010 | |
3cb4da91 |
1011 | foreach my $letter (sort keys %leading) { |
ddf6bed1 |
1012 | my $let = $letter; |
1013 | $let = '\0' if $letter eq ''; |
a0d0e21e |
1014 | |
ddf6bed1 |
1015 | print $fh <<EOP; |
1016 | case '$let': |
1017 | EOP |
1018 | if (@{$leading{$letter}} > 1) { |
1019 | # It makes sense to call a function |
1020 | if ($off) { |
1021 | print $fh <<EOP; |
1022 | if (!strnEQ(name + $offarg,"$leader", $off)) |
1023 | break; |
1024 | EOP |
1025 | } |
1026 | print $fh <<EOP; |
3cb4da91 |
1027 | return constant_$pref$leader$letter(name, len, arg); |
ddf6bed1 |
1028 | EOP |
7aff18a2 |
1029 | } |
1030 | else { |
ddf6bed1 |
1031 | # Do it ourselves |
1032 | my $protect |
1033 | = protect_convert_to_double("$pref$leader$letter$leading{$letter}[0]"); |
1034 | |
1035 | print $fh <<EOP; |
1036 | if (strEQ(name + $offarg, "$leader$letter$leading{$letter}[0]")) { /* $pref removed */ |
1037 | #ifdef $pref$leader$letter$leading{$letter}[0] |
1038 | return $protect$pref$leader$letter$leading{$letter}[0]; |
a0d0e21e |
1039 | #else |
1040 | goto not_there; |
1041 | #endif |
ddf6bed1 |
1042 | } |
1043 | EOP |
a0d0e21e |
1044 | } |
ddf6bed1 |
1045 | } |
1046 | print $fh <<"END"; |
a0d0e21e |
1047 | } |
1048 | errno = EINVAL; |
1049 | return 0; |
1050 | |
1051 | not_there: |
1052 | errno = ENOENT; |
1053 | return 0; |
1054 | } |
1055 | |
e1666bf5 |
1056 | END |
ddf6bed1 |
1057 | |
e1666bf5 |
1058 | } |
1059 | |
ddf6bed1 |
1060 | if( ! $opt_c ) { |
1061 | print XS <<"END"; |
1062 | static int |
1063 | not_here(char *s) |
1064 | { |
1065 | croak("$module::%s not implemented on this architecture", s); |
1066 | return -1; |
1067 | } |
1068 | |
1069 | END |
1070 | |
1071 | write_const(\*XS, '', 0, \@const_names); |
e1666bf5 |
1072 | } |
1073 | |
3cb4da91 |
1074 | my $prefix; |
ead2a595 |
1075 | $prefix = "PREFIX = $opt_p" if defined $opt_p; |
3cb4da91 |
1076 | |
e1666bf5 |
1077 | # Now switch from C to XS by issuing the first MODULE declaration: |
1078 | print XS <<"END"; |
a0d0e21e |
1079 | |
ead2a595 |
1080 | MODULE = $module PACKAGE = $module $prefix |
1081 | |
1082 | END |
1083 | |
1084 | foreach (sort keys %const_xsub) { |
1085 | print XS <<"END"; |
1086 | char * |
1087 | $_() |
1088 | |
1089 | CODE: |
1090 | #ifdef $_ |
7aff18a2 |
1091 | RETVAL = $_; |
ead2a595 |
1092 | #else |
7aff18a2 |
1093 | croak("Your vendor has not defined the $module macro $_"); |
ead2a595 |
1094 | #endif |
1095 | |
1096 | OUTPUT: |
7aff18a2 |
1097 | RETVAL |
a0d0e21e |
1098 | |
e1666bf5 |
1099 | END |
ead2a595 |
1100 | } |
e1666bf5 |
1101 | |
1102 | # If a constant() function was written then output a corresponding |
1103 | # XS declaration: |
1104 | print XS <<"END" unless $opt_c; |
1105 | |
a0d0e21e |
1106 | double |
3cb4da91 |
1107 | constant(sv,arg) |
7aff18a2 |
1108 | PREINIT: |
3cb4da91 |
1109 | STRLEN len; |
7aff18a2 |
1110 | INPUT: |
3cb4da91 |
1111 | SV * sv |
1112 | char * s = SvPV(sv, len); |
a0d0e21e |
1113 | int arg |
7aff18a2 |
1114 | CODE: |
3cb4da91 |
1115 | RETVAL = constant(s,len,arg); |
7aff18a2 |
1116 | OUTPUT: |
3cb4da91 |
1117 | RETVAL |
a0d0e21e |
1118 | |
1119 | END |
a0d0e21e |
1120 | |
5273d82d |
1121 | my %seen_decl; |
ddf6bed1 |
1122 | my %typemap; |
5273d82d |
1123 | |
ead2a595 |
1124 | sub print_decl { |
1125 | my $fh = shift; |
1126 | my $decl = shift; |
1127 | my ($type, $name, $args) = @$decl; |
5273d82d |
1128 | return if $seen_decl{$name}++; # Need to do the same for docs as well? |
1129 | |
ead2a595 |
1130 | my @argnames = map {$_->[1]} @$args; |
ddf6bed1 |
1131 | my @argtypes = map { normalize_type( $_->[0], 1 ) } @$args; |
5273d82d |
1132 | my @argarrays = map { $_->[4] || '' } @$args; |
ead2a595 |
1133 | my $numargs = @$args; |
1134 | if ($numargs and $argtypes[-1] eq '...') { |
1135 | $numargs--; |
1136 | $argnames[-1] = '...'; |
1137 | } |
1138 | local $" = ', '; |
ddf6bed1 |
1139 | $type = normalize_type($type, 1); |
1140 | |
ead2a595 |
1141 | print $fh <<"EOP"; |
1142 | |
1143 | $type |
1144 | $name(@argnames) |
1145 | EOP |
1146 | |
3cb4da91 |
1147 | for my $arg (0 .. $numargs - 1) { |
ead2a595 |
1148 | print $fh <<"EOP"; |
5273d82d |
1149 | $argtypes[$arg] $argnames[$arg]$argarrays[$arg] |
ead2a595 |
1150 | EOP |
1151 | } |
1152 | } |
1153 | |
5273d82d |
1154 | # Should be called before any actual call to normalize_type(). |
1155 | sub get_typemap { |
1156 | # We do not want to read ./typemap by obvios reasons. |
1157 | my @tm = qw(../../../typemap ../../typemap ../typemap); |
1158 | my $stdtypemap = "$Config::Config{privlib}/ExtUtils/typemap"; |
1159 | unshift @tm, $stdtypemap; |
1160 | my $proto_re = "[" . quotemeta('\$%&*@;') . "]" ; |
ddf6bed1 |
1161 | |
1162 | # Start with useful default values |
1163 | $typemap{float} = 'T_DOUBLE'; |
1164 | |
3cb4da91 |
1165 | foreach my $typemap (@tm) { |
5273d82d |
1166 | next unless -e $typemap ; |
1167 | # skip directories, binary files etc. |
1168 | warn " Scanning $typemap\n"; |
1169 | warn("Warning: ignoring non-text typemap file '$typemap'\n"), next |
1170 | unless -T $typemap ; |
1171 | open(TYPEMAP, $typemap) |
1172 | or warn ("Warning: could not open typemap file '$typemap': $!\n"), next; |
1173 | my $mode = 'Typemap'; |
1174 | while (<TYPEMAP>) { |
1175 | next if /^\s*\#/; |
1176 | if (/^INPUT\s*$/) { $mode = 'Input'; next; } |
1177 | elsif (/^OUTPUT\s*$/) { $mode = 'Output'; next; } |
1178 | elsif (/^TYPEMAP\s*$/) { $mode = 'Typemap'; next; } |
1179 | elsif ($mode eq 'Typemap') { |
1180 | next if /^\s*($|\#)/ ; |
3cb4da91 |
1181 | my ($type, $image); |
ddf6bed1 |
1182 | if ( ($type, $image) = |
5273d82d |
1183 | /^\s*(.*?\S)\s+(\S+)\s*($proto_re*)\s*$/o |
1184 | # This may reference undefined functions: |
1185 | and not ($image eq 'T_PACKED' and $typemap eq $stdtypemap)) { |
ddf6bed1 |
1186 | $typemap{normalize_type($type)} = $image; |
5273d82d |
1187 | } |
1188 | } |
1189 | } |
1190 | close(TYPEMAP) or die "Cannot close $typemap: $!"; |
1191 | } |
1192 | %std_types = %types_seen; |
1193 | %types_seen = (); |
1194 | } |
1195 | |
ead2a595 |
1196 | |
ddf6bed1 |
1197 | sub normalize_type { # Second arg: do not strip const's before \* |
ead2a595 |
1198 | my $type = shift; |
3cb4da91 |
1199 | my $do_keep_deep_const = shift; |
1200 | # If $do_keep_deep_const this is heuristical only |
1201 | my $keep_deep_const = ($do_keep_deep_const ? '\b(?![^(,)]*\*)' : ''); |
ddf6bed1 |
1202 | my $ignore_mods |
3cb4da91 |
1203 | = "(?:\\b(?:(?:__const__|const)$keep_deep_const|static|inline|__inline__)\\b\\s*)*"; |
1204 | if ($do_keep_deep_const) { # Keep different compiled /RExen/o separately! |
1205 | $type =~ s/$ignore_mods//go; |
7aff18a2 |
1206 | } |
1207 | else { |
3cb4da91 |
1208 | $type =~ s/$ignore_mods//go; |
1209 | } |
ddf6bed1 |
1210 | $type =~ s/([^\s\w])/ \1 /g; |
ead2a595 |
1211 | $type =~ s/\s+$//; |
1212 | $type =~ s/^\s+//; |
ddf6bed1 |
1213 | $type =~ s/\s+/ /g; |
1214 | $type =~ s/\* (?=\*)/*/g; |
1215 | $type =~ s/\. \. \./.../g; |
1216 | $type =~ s/ ,/,/g; |
5273d82d |
1217 | $types_seen{$type}++ |
1218 | unless $type eq '...' or $type eq 'void' or $std_types{$type}; |
ead2a595 |
1219 | $type; |
1220 | } |
1221 | |
ddf6bed1 |
1222 | my $need_opaque; |
1223 | |
1224 | sub assign_typemap_entry { |
1225 | my $type = shift; |
1226 | my $otype = $type; |
1227 | my $entry; |
1228 | if ($tmask and $type =~ /$tmask/) { |
1229 | print "Type $type matches -o mask\n" if $opt_d; |
1230 | $entry = (td_is_struct($type) ? "T_OPAQUE_STRUCT" : "T_PTROBJ"); |
1231 | } |
1232 | elsif ($typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) { |
1233 | $type = normalize_type $type; |
1234 | print "Type mutation via typedefs: $otype ==> $type\n" if $opt_d; |
1235 | $entry = assign_typemap_entry($type); |
1236 | } |
1237 | $entry ||= $typemap{$otype} |
1238 | || (td_is_struct($type) ? "T_OPAQUE_STRUCT" : "T_PTROBJ"); |
1239 | $typemap{$otype} = $entry; |
1240 | $need_opaque = 1 if $entry eq "T_OPAQUE_STRUCT"; |
1241 | return $entry; |
1242 | } |
1243 | |
ead2a595 |
1244 | if ($opt_x) { |
3cb4da91 |
1245 | for my $decl (@$fdecls_parsed) { print_decl(\*XS, $decl) } |
ead2a595 |
1246 | } |
1247 | |
a0d0e21e |
1248 | close XS; |
5273d82d |
1249 | |
1250 | if (%types_seen) { |
1251 | my $type; |
1252 | warn "Writing $ext$modpname/typemap\n"; |
1253 | open TM, ">typemap" or die "Cannot open typemap file for write: $!"; |
1254 | |
3cb4da91 |
1255 | for $type (sort keys %types_seen) { |
ddf6bed1 |
1256 | my $entry = assign_typemap_entry $type; |
1257 | print TM $type, "\t" x (5 - int((length $type)/8)), "\t$entry\n" |
5273d82d |
1258 | } |
1259 | |
ddf6bed1 |
1260 | print TM <<'EOP' if $need_opaque; # Older Perls do not have correct entry |
1261 | ############################################################################# |
1262 | INPUT |
1263 | T_OPAQUE_STRUCT |
1264 | if (sv_derived_from($arg, \"${ntype}\")) { |
1265 | STRLEN len; |
1266 | char *s = SvPV((SV*)SvRV($arg), len); |
1267 | |
1268 | if (len != sizeof($var)) |
1269 | croak(\"Size %d of packed data != expected %d\", |
1270 | len, sizeof($var)); |
1271 | $var = *($type *)s; |
1272 | } |
1273 | else |
1274 | croak(\"$var is not of type ${ntype}\") |
1275 | ############################################################################# |
1276 | OUTPUT |
1277 | T_OPAQUE_STRUCT |
1278 | sv_setref_pvn($arg, \"${ntype}\", (char *)&$var, sizeof($var)); |
1279 | EOP |
1280 | |
5273d82d |
1281 | close TM or die "Cannot close typemap file for write: $!"; |
1282 | } |
1283 | |
2920c5d2 |
1284 | } # if( ! $opt_X ) |
e1666bf5 |
1285 | |
8e07c86e |
1286 | warn "Writing $ext$modpname/Makefile.PL\n"; |
1287 | open(PL, ">Makefile.PL") || die "Can't create $ext$modpname/Makefile.PL: $!\n"; |
a0d0e21e |
1288 | |
a0d0e21e |
1289 | print PL <<'END'; |
1290 | use ExtUtils::MakeMaker; |
1291 | # See lib/ExtUtils/MakeMaker.pm for details of how to influence |
42793c05 |
1292 | # the contents of the Makefile that is written. |
a0d0e21e |
1293 | END |
42793c05 |
1294 | print PL "WriteMakefile(\n"; |
1295 | print PL " 'NAME' => '$module',\n"; |
c07a80fd |
1296 | print PL " 'VERSION_FROM' => '$modfname.pm', # finds \$VERSION\n"; |
2920c5d2 |
1297 | if( ! $opt_X ){ # print C stuff, unless XS is disabled |
ddf6bed1 |
1298 | $opt_F = '' unless defined $opt_F; |
2920c5d2 |
1299 | print PL " 'LIBS' => ['$extralibs'], # e.g., '-lm' \n"; |
ddf6bed1 |
1300 | print PL " 'DEFINE' => '$opt_F', # e.g., '-DHAVE_SOMETHING' \n"; |
2920c5d2 |
1301 | print PL " 'INC' => '', # e.g., '-I/usr/include/other' \n"; |
1302 | } |
a0d0e21e |
1303 | print PL ");\n"; |
f508c652 |
1304 | close(PL) || die "Can't close $ext$modpname/Makefile.PL: $!\n"; |
1305 | |
1306 | warn "Writing $ext$modpname/test.pl\n"; |
1307 | open(EX, ">test.pl") || die "Can't create $ext$modpname/test.pl: $!\n"; |
1308 | print EX <<'_END_'; |
1309 | # Before `make install' is performed this script should be runnable with |
1310 | # `make test'. After `make install' it should work as `perl test.pl' |
1311 | |
1312 | ######################### We start with some black magic to print on failure. |
1313 | |
1314 | # Change 1..1 below to 1..last_test_to_print . |
1315 | # (It may become useful if the test is moved to ./t subdirectory.) |
1316 | |
5ae7f1db |
1317 | BEGIN { $| = 1; print "1..1\n"; } |
f508c652 |
1318 | END {print "not ok 1\n" unless $loaded;} |
1319 | _END_ |
1320 | print EX <<_END_; |
1321 | use $module; |
1322 | _END_ |
1323 | print EX <<'_END_'; |
1324 | $loaded = 1; |
1325 | print "ok 1\n"; |
1326 | |
1327 | ######################### End of black magic. |
1328 | |
1329 | # Insert your test code below (better if it prints "ok 13" |
1330 | # (correspondingly "not ok 13") depending on the success of chunk 13 |
1331 | # of the test code): |
e1666bf5 |
1332 | |
f508c652 |
1333 | _END_ |
1334 | close(EX) || die "Can't close $ext$modpname/test.pl: $!\n"; |
a0d0e21e |
1335 | |
c0f8b9cd |
1336 | unless ($opt_C) { |
ddf6bed1 |
1337 | warn "Writing $ext$modpname/Changes\n"; |
1338 | $" = ' '; |
1339 | open(EX, ">Changes") || die "Can't create $ext$modpname/Changes: $!\n"; |
1340 | @ARGS = map {/[\s\"\'\`\$*?^|&<>\[\]\{\}\(\)]/ ? "'$_'" : $_} @ARGS; |
1341 | print EX <<EOP; |
1342 | Revision history for Perl extension $module. |
1343 | |
1344 | $TEMPLATE_VERSION @{[scalar localtime]} |
1345 | \t- original version; created by h2xs $H2XS_VERSION with options |
1346 | \t\t@ARGS |
1347 | |
1348 | EOP |
1349 | close(EX) || die "Can't close $ext$modpname/Changes: $!\n"; |
c0f8b9cd |
1350 | } |
c07a80fd |
1351 | |
1352 | warn "Writing $ext$modpname/MANIFEST\n"; |
5ae7f1db |
1353 | open(MANI,'>MANIFEST') or die "Can't create MANIFEST: $!"; |
3cb4da91 |
1354 | my @files = <*>; |
5ae7f1db |
1355 | if (!@files) { |
1356 | eval {opendir(D,'.');}; |
1357 | unless ($@) { @files = readdir(D); closedir(D); } |
1358 | } |
1359 | if (!@files) { @files = map {chomp && $_} `ls`; } |
55497cff |
1360 | if ($^O eq 'VMS') { |
1361 | foreach (@files) { |
1362 | # Clip trailing '.' for portability -- non-VMS OSs don't expect it |
1363 | s%\.$%%; |
1364 | # Fix up for case-sensitive file systems |
1365 | s/$modfname/$modfname/i && next; |
1366 | $_ = "\U$_" if $_ eq 'manifest' or $_ eq 'changes'; |
bbce6d69 |
1367 | $_ = 'Makefile.PL' if $_ eq 'makefile.pl'; |
55497cff |
1368 | } |
1369 | } |
3e3baf6d |
1370 | print MANI join("\n",@files), "\n"; |
5ae7f1db |
1371 | close MANI; |
40000a8c |
1372 | !NO!SUBS! |
4633a7c4 |
1373 | |
1374 | close OUT or die "Can't close $file: $!"; |
1375 | chmod 0755, $file or die "Can't reset permissions for $file: $!\n"; |
1376 | exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':'; |
8a5546a1 |
1377 | chdir $origdir; |