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. |
be3174d2 |
16 | my $origdir = cwd; |
44a8e56a |
17 | chdir dirname($0); |
be3174d2 |
18 | my $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!"; |
1dea8210 |
29 | $Config{startperl} |
5f05dabc |
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 | |
1dea8210 |
38 | use warnings; |
39 | |
3edbfbe5 |
40 | =head1 NAME |
41 | |
42 | h2xs - convert .h C header files to Perl extensions |
43 | |
44 | =head1 SYNOPSIS |
45 | |
11946041 |
46 | B<h2xs> [B<OPTIONS> ...] [headerfile ... [extra_libraries]] |
f508c652 |
47 | |
11946041 |
48 | B<h2xs> B<-h>|B<-?>|B<--help> |
3edbfbe5 |
49 | |
50 | =head1 DESCRIPTION |
51 | |
a887ff11 |
52 | I<h2xs> builds a Perl extension from C header files. The extension |
53 | will include functions which can be used to retrieve the value of any |
54 | #define statement which was in the C header files. |
3edbfbe5 |
55 | |
56 | The I<module_name> will be used for the name of the extension. If |
a887ff11 |
57 | module_name is not supplied then the name of the first header file |
58 | will be used, with the first character capitalized. |
3edbfbe5 |
59 | |
60 | If the extension might need extra libraries, they should be included |
61 | here. The extension Makefile.PL will take care of checking whether |
9cacc32e |
62 | the libraries actually exist and how they should be loaded. The extra |
63 | libraries should be specified in the form -lm -lposix, etc, just as on |
64 | the cc command line. By default, the Makefile.PL will search through |
65 | the library path determined by Configure. That path can be augmented |
66 | by including arguments of the form B<-L/another/library/path> in the |
67 | extra-libraries argument. |
3edbfbe5 |
68 | |
e8843997 |
69 | In spite of its name, I<h2xs> may also be used to create a skeleton pure |
70 | Perl module. See the B<-X> option. |
71 | |
3edbfbe5 |
72 | =head1 OPTIONS |
73 | |
74 | =over 5 |
75 | |
4d2d0db2 |
76 | =item B<-A>, B<--omit-autoload> |
3edbfbe5 |
77 | |
9cacc32e |
78 | Omit all autoload facilities. This is the same as B<-c> but also |
79 | removes the S<C<use AutoLoader>> statement from the .pm file. |
3edbfbe5 |
80 | |
9e4509e4 |
81 | =item B<-B>, B<--beta-version> |
82 | |
83 | Use an alpha/beta style version number. Causes version number to |
84 | be "0.00_01" unless B<-v> is specified. |
85 | |
4d2d0db2 |
86 | =item B<-C>, B<--omit-changes> |
c0f8b9cd |
87 | |
88 | Omits creation of the F<Changes> file, and adds a HISTORY section to |
89 | the POD template. |
90 | |
4d2d0db2 |
91 | =item B<-F>, B<--cpp-flags>=I<addflags> |
b73edd97 |
92 | |
93 | Additional flags to specify to C preprocessor when scanning header for |
dcb5229a |
94 | function declarations. Writes these options in the generated F<Makefile.PL> |
95 | too. |
ddf6bed1 |
96 | |
4d2d0db2 |
97 | =item B<-M>, B<--func-mask>=I<regular expression> |
ddf6bed1 |
98 | |
99 | selects functions/macros to process. |
b73edd97 |
100 | |
4d2d0db2 |
101 | =item B<-O>, B<--overwrite-ok> |
2920c5d2 |
102 | |
103 | Allows a pre-existing extension directory to be overwritten. |
104 | |
4d2d0db2 |
105 | =item B<-P>, B<--omit-pod> |
3edbfbe5 |
106 | |
66b6773e |
107 | Omit the autogenerated stub POD section. |
3edbfbe5 |
108 | |
4d2d0db2 |
109 | =item B<-X>, B<--omit-XS> |
b73edd97 |
110 | |
e8843997 |
111 | Omit the XS portion. Used to generate a skeleton pure Perl module. |
112 | C<-c> and C<-f> are implicitly enabled. |
b73edd97 |
113 | |
4d2d0db2 |
114 | =item B<-a>, B<--gen-accessors> |
7c1d48a5 |
115 | |
116 | Generate an accessor method for each element of structs and unions. The |
117 | generated methods are named after the element name; will return the current |
118 | value of the element if called without additional arguments; and will set |
32fb2b78 |
119 | the element to the supplied value (and return the new value) if called with |
120 | an additional argument. Embedded structures and unions are returned as a |
121 | pointer rather than the complete structure, to facilitate chained calls. |
122 | |
123 | These methods all apply to the Ptr type for the structure; additionally |
124 | two methods are constructed for the structure type itself, C<_to_ptr> |
125 | which returns a Ptr type pointing to the same structure, and a C<new> |
126 | method to construct and return a new structure, initialised to zeroes. |
7c1d48a5 |
127 | |
4d2d0db2 |
128 | =item B<-b>, B<--compat-version>=I<version> |
af6c647e |
129 | |
130 | Generates a .pm file which is backwards compatible with the specified |
131 | perl version. |
132 | |
133 | For versions < 5.6.0, the changes are. |
134 | - no use of 'our' (uses 'use vars' instead) |
135 | - no 'use warnings' |
136 | |
137 | Specifying a compatibility version higher than the version of perl you |
3e6e4ea8 |
138 | are using to run h2xs will have no effect. If unspecified h2xs will default |
139 | to compatibility with the version of perl you are using to run h2xs. |
af6c647e |
140 | |
4d2d0db2 |
141 | =item B<-c>, B<--omit-constant> |
3edbfbe5 |
142 | |
143 | Omit C<constant()> from the .xs file and corresponding specialised |
144 | C<AUTOLOAD> from the .pm file. |
145 | |
4d2d0db2 |
146 | =item B<-d>, B<--debugging> |
b73edd97 |
147 | |
148 | Turn on debugging messages. |
149 | |
069eb725 |
150 | =item B<-e>, B<--omit-enums>=[I<regular expression>] |
151 | |
152 | If I<regular expression> is not given, skip all constants that are defined in |
153 | a C enumeration. Otherwise skip only those constants that are defined in an |
154 | enum whose name matches I<regular expression>. |
155 | |
156 | Since I<regular expression> is optional, make sure that this switch is followed |
157 | by at least one other switch if you omit I<regular expression> and have some |
158 | pending arguments such as header-file names. This is ok: |
159 | |
160 | h2xs -e -n Module::Foo foo.h |
161 | |
162 | This is not ok: |
163 | |
164 | h2xs -n Module::Foo -e foo.h |
165 | |
166 | In the latter, foo.h is taken as I<regular expression>. |
167 | |
4d2d0db2 |
168 | =item B<-f>, B<--force> |
3edbfbe5 |
169 | |
f508c652 |
170 | Allows an extension to be created for a header even if that header is |
ddf6bed1 |
171 | not found in standard include directories. |
f508c652 |
172 | |
e255a1c9 |
173 | =item B<-g>, B<--global> |
174 | |
66b6773e |
175 | Include code for safely storing static data in the .xs file. |
e255a1c9 |
176 | Extensions that do no make use of static data can ignore this option. |
177 | |
4d2d0db2 |
178 | =item B<-h>, B<-?>, B<--help> |
f508c652 |
179 | |
180 | Print the usage, help and version for this h2xs and exit. |
181 | |
4d2d0db2 |
182 | =item B<-k>, B<--omit-const-func> |
32fb2b78 |
183 | |
184 | For function arguments declared as C<const>, omit the const attribute in the |
185 | generated XS code. |
186 | |
4d2d0db2 |
187 | =item B<-m>, B<--gen-tied-var> |
32fb2b78 |
188 | |
189 | B<Experimental>: for each variable declared in the header file(s), declare |
190 | a perl variable of the same name magically tied to the C variable. |
191 | |
4d2d0db2 |
192 | =item B<-n>, B<--name>=I<module_name> |
f508c652 |
193 | |
194 | Specifies a name to be used for the extension, e.g., S<-n RPC::DCE> |
195 | |
4d2d0db2 |
196 | =item B<-o>, B<--opaque-re>=I<regular expression> |
ddf6bed1 |
197 | |
198 | Use "opaque" data type for the C types matched by the regular |
199 | expression, even if these types are C<typedef>-equivalent to types |
200 | from typemaps. Should not be used without B<-x>. |
201 | |
202 | This may be useful since, say, types which are C<typedef>-equivalent |
203 | to integers may represent OS-related handles, and one may want to work |
204 | with these handles in OO-way, as in C<$handle-E<gt>do_something()>. |
9cacc32e |
205 | Use C<-o .> if you want to handle all the C<typedef>ed types as opaque |
206 | types. |
ddf6bed1 |
207 | |
208 | The type-to-match is whitewashed (except for commas, which have no |
209 | whitespace before them, and multiple C<*> which have no whitespace |
210 | between them). |
211 | |
4d2d0db2 |
212 | =item B<-p>, B<--remove-prefix>=I<prefix> |
ead2a595 |
213 | |
9cacc32e |
214 | Specify a prefix which should be removed from the Perl function names, |
215 | e.g., S<-p sec_rgy_> This sets up the XS B<PREFIX> keyword and removes |
216 | the prefix from functions that are autoloaded via the C<constant()> |
217 | mechanism. |
ead2a595 |
218 | |
4d2d0db2 |
219 | =item B<-s>, B<--const-subs>=I<sub1,sub2> |
ead2a595 |
220 | |
9cacc32e |
221 | Create a perl subroutine for the specified macros rather than autoload |
222 | with the constant() subroutine. These macros are assumed to have a |
223 | return type of B<char *>, e.g., |
224 | S<-s sec_rgy_wildcard_name,sec_rgy_wildcard_sid>. |
ead2a595 |
225 | |
4d2d0db2 |
226 | =item B<-t>, B<--default-type>=I<type> |
af6c647e |
227 | |
228 | Specify the internal type that the constant() mechanism uses for macros. |
229 | The default is IV (signed integer). Currently all macros found during the |
230 | header scanning process will be assumed to have this type. Future versions |
231 | of C<h2xs> may gain the ability to make educated guesses. |
232 | |
11946041 |
233 | =item B<--use-new-tests> |
234 | |
235 | When B<--compat-version> (B<-b>) is present the generated tests will use |
9e4509e4 |
236 | C<Test::More> rather than C<Test> which is the default for versions before |
11946041 |
237 | 5.7.2 . C<Test::More> will be added to PREREQ_PM in the generated |
238 | C<Makefile.PL>. |
239 | |
240 | =item B<--use-old-tests> |
241 | |
242 | Will force the generation of test code that uses the older C<Test> module. |
243 | |
dcb5229a |
244 | =item B<--skip-exporter> |
245 | |
246 | Do not use C<Exporter> and/or export any symbol. |
247 | |
248 | =item B<--skip-ppport> |
249 | |
250 | Do not use C<Devel::PPPort>: no portability to older version. |
251 | |
252 | =item B<--skip-autoloader> |
253 | |
254 | Do not use the module C<AutoLoader>; but keep the constant() function |
255 | and C<sub AUTOLOAD> for constants. |
256 | |
257 | =item B<--skip-strict> |
258 | |
259 | Do not use the pragma C<strict>. |
260 | |
261 | =item B<--skip-warnings> |
262 | |
263 | Do not use the pragma C<warnings>. |
264 | |
4d2d0db2 |
265 | =item B<-v>, B<--version>=I<version> |
f508c652 |
266 | |
267 | Specify a version number for this extension. This version number is added |
9e4509e4 |
268 | to the templates. The default is 0.01, or 0.00_01 if C<-B> is specified. |
269 | The version specified should be numeric. |
3edbfbe5 |
270 | |
4d2d0db2 |
271 | =item B<-x>, B<--autogen-xsubs> |
760ac839 |
272 | |
273 | Automatically generate XSUBs basing on function declarations in the |
274 | header file. The package C<C::Scan> should be installed. If this |
275 | option is specified, the name of the header file may look like |
9cacc32e |
276 | C<NAME1,NAME2>. In this case NAME1 is used instead of the specified |
277 | string, but XSUBs are emitted only for the declarations included from |
278 | file NAME2. |
760ac839 |
279 | |
5273d82d |
280 | Note that some types of arguments/return-values for functions may |
281 | result in XSUB-declarations/typemap-entries which need |
282 | hand-editing. Such may be objects which cannot be converted from/to a |
ddf6bed1 |
283 | pointer (like C<long long>), pointers to functions, or arrays. See |
284 | also the section on L<LIMITATIONS of B<-x>>. |
5273d82d |
285 | |
3edbfbe5 |
286 | =back |
287 | |
288 | =head1 EXAMPLES |
289 | |
290 | |
069eb725 |
291 | # Default behavior, extension is Rusers |
292 | h2xs rpcsvc/rusers |
3edbfbe5 |
293 | |
069eb725 |
294 | # Same, but extension is RUSERS |
295 | h2xs -n RUSERS rpcsvc/rusers |
3edbfbe5 |
296 | |
069eb725 |
297 | # Extension is rpcsvc::rusers. Still finds <rpcsvc/rusers.h> |
298 | h2xs rpcsvc::rusers |
3edbfbe5 |
299 | |
069eb725 |
300 | # Extension is ONC::RPC. Still finds <rpcsvc/rusers.h> |
301 | h2xs -n ONC::RPC rpcsvc/rusers |
3edbfbe5 |
302 | |
069eb725 |
303 | # Without constant() or AUTOLOAD |
304 | h2xs -c rpcsvc/rusers |
3edbfbe5 |
305 | |
069eb725 |
306 | # Creates templates for an extension named RPC |
307 | h2xs -cfn RPC |
3edbfbe5 |
308 | |
069eb725 |
309 | # Extension is ONC::RPC. |
310 | h2xs -cfn ONC::RPC |
66b6773e |
311 | |
e8843997 |
312 | # Extension is a pure Perl module with no XS code. |
313 | h2xs -X My::Module |
314 | |
069eb725 |
315 | # Extension is Lib::Foo which works at least with Perl5.005_03. |
316 | # Constants are created for all #defines and enums h2xs can find |
317 | # in foo.h. |
318 | h2xs -b 5.5.3 -n Lib::Foo foo.h |
3edbfbe5 |
319 | |
069eb725 |
320 | # Extension is Lib::Foo which works at least with Perl5.005_03. |
321 | # Constants are created for all #defines but only for enums |
322 | # whose names do not start with 'bar_'. |
323 | h2xs -b 5.5.3 -e '^bar_' -n Lib::Foo foo.h |
3edbfbe5 |
324 | |
66b6773e |
325 | # Makefile.PL will look for library -lrpc in |
069eb725 |
326 | # additional directory /opt/net/lib |
327 | h2xs rpcsvc/rusers -L/opt/net/lib -lrpc |
ead2a595 |
328 | |
069eb725 |
329 | # Extension is DCE::rgynbase |
330 | # prefix "sec_rgy_" is dropped from perl function names |
331 | h2xs -n DCE::rgynbase -p sec_rgy_ dce/rgynbase |
3edbfbe5 |
332 | |
069eb725 |
333 | # Extension is DCE::rgynbase |
334 | # prefix "sec_rgy_" is dropped from perl function names |
66b6773e |
335 | # subroutines are created for sec_rgy_wildcard_name and |
069eb725 |
336 | # sec_rgy_wildcard_sid |
337 | h2xs -n DCE::rgynbase -p sec_rgy_ \ |
338 | -s sec_rgy_wildcard_name,sec_rgy_wildcard_sid dce/rgynbase |
760ac839 |
339 | |
069eb725 |
340 | # Make XS without defines in perl.h, but with function declarations |
341 | # visible from perl.h. Name of the extension is perl1. |
342 | # When scanning perl.h, define -DEXT=extern -DdEXT= -DINIT(x)= |
343 | # Extra backslashes below because the string is passed to shell. |
66b6773e |
344 | # Note that a directory with perl header files would |
069eb725 |
345 | # be added automatically to include path. |
346 | h2xs -xAn perl1 -F "-DEXT=extern -DdEXT= -DINIT\(x\)=" perl.h |
760ac839 |
347 | |
069eb725 |
348 | # Same with function declaration in proto.h as visible from perl.h. |
349 | h2xs -xAn perl2 perl.h,proto.h |
ddf6bed1 |
350 | |
069eb725 |
351 | # Same but select only functions which match /^av_/ |
352 | h2xs -M '^av_' -xAn perl2 perl.h,proto.h |
353 | |
354 | # Same but treat SV* etc as "opaque" types |
355 | h2xs -o '^[S]V \*$' -M '^av_' -xAn perl2 perl.h,proto.h |
ddf6bed1 |
356 | |
b68ece06 |
357 | =head2 Extension based on F<.h> and F<.c> files |
358 | |
359 | Suppose that you have some C files implementing some functionality, |
360 | and the corresponding header files. How to create an extension which |
3c4b39be |
361 | makes this functionality accessible in Perl? The example below |
b68ece06 |
362 | assumes that the header files are F<interface_simple.h> and |
363 | I<interface_hairy.h>, and you want the perl module be named as |
364 | C<Ext::Ension>. If you need some preprocessor directives and/or |
365 | linking with external libraries, see the flags C<-F>, C<-L> and C<-l> |
366 | in L<"OPTIONS">. |
367 | |
368 | =over |
369 | |
370 | =item Find the directory name |
371 | |
372 | Start with a dummy run of h2xs: |
373 | |
374 | h2xs -Afn Ext::Ension |
375 | |
376 | The only purpose of this step is to create the needed directories, and |
377 | let you know the names of these directories. From the output you can |
378 | see that the directory for the extension is F<Ext/Ension>. |
379 | |
380 | =item Copy C files |
381 | |
382 | Copy your header files and C files to this directory F<Ext/Ension>. |
383 | |
384 | =item Create the extension |
385 | |
386 | Run h2xs, overwriting older autogenerated files: |
387 | |
388 | h2xs -Oxan Ext::Ension interface_simple.h interface_hairy.h |
389 | |
390 | h2xs looks for header files I<after> changing to the extension |
391 | directory, so it will find your header files OK. |
392 | |
393 | =item Archive and test |
394 | |
395 | As usual, run |
396 | |
397 | cd Ext/Ension |
398 | perl Makefile.PL |
399 | make dist |
400 | make |
401 | make test |
402 | |
403 | =item Hints |
404 | |
405 | It is important to do C<make dist> as early as possible. This way you |
406 | can easily merge(1) your changes to autogenerated files if you decide |
407 | to edit your C<.h> files and rerun h2xs. |
408 | |
409 | Do not forget to edit the documentation in the generated F<.pm> file. |
410 | |
411 | Consider the autogenerated files as skeletons only, you may invent |
412 | better interfaces than what h2xs could guess. |
413 | |
414 | Consider this section as a guideline only, some other options of h2xs |
415 | may better suit your needs. |
416 | |
417 | =back |
418 | |
3edbfbe5 |
419 | =head1 ENVIRONMENT |
420 | |
421 | No environment variables are used. |
422 | |
423 | =head1 AUTHOR |
424 | |
425 | Larry Wall and others |
426 | |
427 | =head1 SEE ALSO |
428 | |
f508c652 |
429 | L<perl>, L<perlxstut>, L<ExtUtils::MakeMaker>, and L<AutoLoader>. |
3edbfbe5 |
430 | |
431 | =head1 DIAGNOSTICS |
432 | |
760ac839 |
433 | The usual warnings if it cannot read or write the files involved. |
3edbfbe5 |
434 | |
ddf6bed1 |
435 | =head1 LIMITATIONS of B<-x> |
436 | |
437 | F<h2xs> would not distinguish whether an argument to a C function |
438 | which is of the form, say, C<int *>, is an input, output, or |
439 | input/output parameter. In particular, argument declarations of the |
440 | form |
441 | |
442 | int |
443 | foo(n) |
444 | int *n |
445 | |
446 | should be better rewritten as |
447 | |
448 | int |
449 | foo(n) |
450 | int &n |
451 | |
452 | if C<n> is an input parameter. |
453 | |
454 | Additionally, F<h2xs> has no facilities to intuit that a function |
455 | |
456 | int |
457 | foo(addr,l) |
458 | char *addr |
459 | int l |
460 | |
461 | takes a pair of address and length of data at this address, so it is better |
462 | to rewrite this function as |
463 | |
464 | int |
465 | foo(sv) |
7aff18a2 |
466 | SV *addr |
467 | PREINIT: |
468 | STRLEN len; |
469 | char *s; |
470 | CODE: |
471 | s = SvPV(sv,len); |
472 | RETVAL = foo(s, len); |
473 | OUTPUT: |
474 | RETVAL |
ddf6bed1 |
475 | |
476 | or alternately |
477 | |
478 | static int |
479 | my_foo(SV *sv) |
480 | { |
481 | STRLEN len; |
482 | char *s = SvPV(sv,len); |
483 | |
484 | return foo(s, len); |
485 | } |
486 | |
487 | MODULE = foo PACKAGE = foo PREFIX = my_ |
488 | |
489 | int |
490 | foo(sv) |
491 | SV *sv |
492 | |
493 | See L<perlxs> and L<perlxstut> for additional details. |
494 | |
3edbfbe5 |
495 | =cut |
496 | |
9a7df4f2 |
497 | # ' # Grr |
3cb4da91 |
498 | use strict; |
499 | |
500 | |
d1c9eea3 |
501 | my( $H2XS_VERSION ) = ' $Revision: 1.23 $ ' =~ /\$Revision:\s+([^\s]+)/; |
f508c652 |
502 | my $TEMPLATE_VERSION = '0.01'; |
ddf6bed1 |
503 | my @ARGS = @ARGV; |
be3174d2 |
504 | my $compat_version = $]; |
a0d0e21e |
505 | |
4d2d0db2 |
506 | use Getopt::Long; |
65cf46c7 |
507 | use Config; |
af6c647e |
508 | use Text::Wrap; |
509 | $Text::Wrap::huge = 'overflow'; |
510 | $Text::Wrap::columns = 80; |
9a7df4f2 |
511 | use ExtUtils::Constant qw (WriteConstants WriteMakefileSnippet autoload); |
512 | use File::Compare; |
4a660237 |
513 | use File::Path; |
a0d0e21e |
514 | |
65cf46c7 |
515 | sub usage { |
516 | warn "@_\n" if @_; |
517 | die <<EOFUSAGE; |
4d2d0db2 |
518 | h2xs [OPTIONS ... ] [headerfile [extra_libraries]] |
f508c652 |
519 | version: $H2XS_VERSION |
4d2d0db2 |
520 | OPTIONS: |
521 | -A, --omit-autoload Omit all autoloading facilities (implies -c). |
9e4509e4 |
522 | -B, --beta-version Use beta \$VERSION of 0.00_01 (ignored if -v). |
4d2d0db2 |
523 | -C, --omit-changes Omit creating the Changes file, add HISTORY heading |
524 | to stub POD. |
dcb5229a |
525 | -F, --cpp-flags Additional flags for C preprocessor/compile. |
4d2d0db2 |
526 | -M, --func-mask Mask to select C functions/macros |
527 | (default is select all). |
528 | -O, --overwrite-ok Allow overwriting of a pre-existing extension directory. |
529 | -P, --omit-pod Omit the stub POD section. |
530 | -X, --omit-XS Omit the XS portion (implies both -c and -f). |
23e47b7f |
531 | -a, --gen-accessors Generate get/set accessors for struct and union members |
532 | (used with -x). |
533 | -b, --compat-version Specify a perl version to be backwards compatibile with. |
4d2d0db2 |
534 | -c, --omit-constant Omit the constant() function and specialised AUTOLOAD |
535 | from the XS file. |
536 | -d, --debugging Turn on debugging messages. |
069eb725 |
537 | -e, --omit-enums Omit constants from enums in the constant() function. |
66b6773e |
538 | If a pattern is given, only the matching enums are |
069eb725 |
539 | ignored. |
4d2d0db2 |
540 | -f, --force Force creation of the extension even if the C header |
541 | does not exist. |
66b6773e |
542 | -g, --global Include code for safely storing static data in the .xs file. |
23e47b7f |
543 | -h, -?, --help Display this help message. |
4d2d0db2 |
544 | -k, --omit-const-func Omit 'const' attribute on function arguments |
545 | (used with -x). |
546 | -m, --gen-tied-var Generate tied variables for access to declared |
547 | variables. |
548 | -n, --name Specify a name to use for the extension (recommended). |
549 | -o, --opaque-re Regular expression for \"opaque\" types. |
550 | -p, --remove-prefix Specify a prefix which should be removed from the |
551 | Perl function names. |
552 | -s, --const-subs Create subroutines for specified macros. |
23e47b7f |
553 | -t, --default-type Default type for autoloaded constants (default is IV). |
554 | --use-new-tests Use Test::More in backward compatible modules. |
555 | --use-old-tests Use the module Test rather than Test::More. |
556 | --skip-exporter Do not export symbols. |
557 | --skip-ppport Do not use portability layer. |
558 | --skip-autoloader Do not use the module C<AutoLoader>. |
559 | --skip-strict Do not use the pragma C<strict>. |
560 | --skip-warnings Do not use the pragma C<warnings>. |
4d2d0db2 |
561 | -v, --version Specify a version number for this extension. |
562 | -x, --autogen-xsubs Autogenerate XSUBs using C::Scan. |
a34e0dd0 |
563 | --use-xsloader Use XSLoader in backward compatible modules (ignored |
564 | when used with -X). |
4d2d0db2 |
565 | |
e1666bf5 |
566 | extra_libraries |
567 | are any libraries that might be needed for loading the |
568 | extension, e.g. -lm would try to link in the math library. |
65cf46c7 |
569 | EOFUSAGE |
e1666bf5 |
570 | } |
a0d0e21e |
571 | |
4d2d0db2 |
572 | my ($opt_A, |
9e4509e4 |
573 | $opt_B, |
4d2d0db2 |
574 | $opt_C, |
575 | $opt_F, |
576 | $opt_M, |
577 | $opt_O, |
578 | $opt_P, |
579 | $opt_X, |
580 | $opt_a, |
581 | $opt_c, |
582 | $opt_d, |
069eb725 |
583 | $opt_e, |
4d2d0db2 |
584 | $opt_f, |
e255a1c9 |
585 | $opt_g, |
4d2d0db2 |
586 | $opt_h, |
587 | $opt_k, |
588 | $opt_m, |
589 | $opt_n, |
590 | $opt_o, |
591 | $opt_p, |
592 | $opt_s, |
593 | $opt_v, |
594 | $opt_x, |
595 | $opt_b, |
11946041 |
596 | $opt_t, |
597 | $new_test, |
dcb5229a |
598 | $old_test, |
599 | $skip_exporter, |
600 | $skip_ppport, |
601 | $skip_autoloader, |
602 | $skip_strict, |
603 | $skip_warnings, |
a34e0dd0 |
604 | $use_xsloader |
4d2d0db2 |
605 | ); |
606 | |
607 | Getopt::Long::Configure('bundling'); |
cbca5cc3 |
608 | Getopt::Long::Configure('pass_through'); |
4d2d0db2 |
609 | |
610 | my %options = ( |
611 | 'omit-autoload|A' => \$opt_A, |
9e4509e4 |
612 | 'beta-version|B' => \$opt_B, |
4d2d0db2 |
613 | 'omit-changes|C' => \$opt_C, |
614 | 'cpp-flags|F=s' => \$opt_F, |
615 | 'func-mask|M=s' => \$opt_M, |
616 | 'overwrite_ok|O' => \$opt_O, |
617 | 'omit-pod|P' => \$opt_P, |
618 | 'omit-XS|X' => \$opt_X, |
619 | 'gen-accessors|a' => \$opt_a, |
620 | 'compat-version|b=s' => \$opt_b, |
621 | 'omit-constant|c' => \$opt_c, |
622 | 'debugging|d' => \$opt_d, |
069eb725 |
623 | 'omit-enums|e:s' => \$opt_e, |
4d2d0db2 |
624 | 'force|f' => \$opt_f, |
e255a1c9 |
625 | 'global|g' => \$opt_g, |
4d2d0db2 |
626 | 'help|h|?' => \$opt_h, |
627 | 'omit-const-func|k' => \$opt_k, |
628 | 'gen-tied-var|m' => \$opt_m, |
629 | 'name|n=s' => \$opt_n, |
630 | 'opaque-re|o=s' => \$opt_o, |
631 | 'remove-prefix|p=s' => \$opt_p, |
632 | 'const-subs|s=s' => \$opt_s, |
633 | 'default-type|t=s' => \$opt_t, |
634 | 'version|v=s' => \$opt_v, |
9de3b7c3 |
635 | 'autogen-xsubs|x' => \$opt_x, |
11946041 |
636 | 'use-new-tests' => \$new_test, |
dcb5229a |
637 | 'use-old-tests' => \$old_test, |
638 | 'skip-exporter' => \$skip_exporter, |
639 | 'skip-ppport' => \$skip_ppport, |
640 | 'skip-autoloader' => \$skip_autoloader, |
641 | 'skip-warnings' => \$skip_warnings, |
642 | 'skip-strict' => \$skip_strict, |
a34e0dd0 |
643 | 'use-xsloader' => \$use_xsloader, |
4d2d0db2 |
644 | ); |
645 | |
646 | GetOptions(%options) || usage; |
a0d0e21e |
647 | |
e1666bf5 |
648 | usage if $opt_h; |
f508c652 |
649 | |
be3174d2 |
650 | if( $opt_b ){ |
651 | usage "You cannot use -b and -m at the same time.\n" if ($opt_b && $opt_m); |
9137345a |
652 | $opt_b =~ /^v?(\d+)\.(\d+)\.(\d+)/ || |
11946041 |
653 | usage "You must provide the backwards compatibility version in X.Y.Z form. " |
654 | . "(i.e. 5.5.0)\n"; |
9137345a |
655 | my ($maj,$min,$sub) = ($1,$2,$3); |
3e6e4ea8 |
656 | if ($maj < 5 || ($maj == 5 && $min < 6)) { |
4282de36 |
657 | $compat_version = |
658 | $sub ? sprintf("%d.%03d%02d",$maj,$min,$sub) : |
659 | sprintf("%d.%03d", $maj,$min); |
3e6e4ea8 |
660 | } else { |
0e850f63 |
661 | $compat_version = sprintf("%d.%03d%03d",$maj,$min,$sub); |
3e6e4ea8 |
662 | } |
663 | } else { |
4282de36 |
664 | my ($maj,$min,$sub) = $compat_version =~ /(\d+)\.(\d\d\d)(\d*)/; |
665 | $sub ||= 0; |
3e6e4ea8 |
666 | warn sprintf <<'EOF', $maj,$min,$sub; |
667 | Defaulting to backwards compatibility with perl %d.%d.%d |
668 | If you intend this module to be compatible with earlier perl versions, please |
669 | specify a minimum perl version with the -b option. |
670 | |
671 | EOF |
672 | } |
be3174d2 |
673 | |
9e4509e4 |
674 | if( $opt_B ){ |
675 | $TEMPLATE_VERSION = '0.00_01'; |
676 | } |
677 | |
f508c652 |
678 | if( $opt_v ){ |
679 | $TEMPLATE_VERSION = $opt_v; |
9e4509e4 |
680 | |
681 | # check if it is numeric |
682 | my $temp_version = $TEMPLATE_VERSION; |
683 | my $beta_version = $temp_version =~ s/(\d)_(\d\d)/$1$2/; |
684 | my $notnum; |
685 | { |
686 | local $SIG{__WARN__} = sub { $notnum = 1 }; |
687 | use warnings 'numeric'; |
688 | $temp_version = 0+$temp_version; |
689 | } |
690 | |
691 | if ($notnum) { |
692 | my $module = $opt_n || 'Your::Module'; |
693 | warn <<"EOF"; |
694 | You have specified a non-numeric version. Unless you supply an |
695 | appropriate VERSION class method, users may not be able to specify a |
696 | minimum required version with C<use $module versionnum>. |
697 | |
698 | EOF |
699 | } |
700 | else { |
701 | $opt_B = $beta_version; |
702 | } |
f508c652 |
703 | } |
9ef261b5 |
704 | |
705 | # -A implies -c. |
dcb5229a |
706 | $skip_autoloader = $opt_c = 1 if $opt_A; |
9ef261b5 |
707 | |
708 | # -X implies -c and -f |
709 | $opt_c = $opt_f = 1 if $opt_X; |
710 | |
9a7df4f2 |
711 | $opt_t ||= 'IV'; |
712 | |
76df5e8f |
713 | my %const_xsub; |
714 | %const_xsub = map { $_,1 } split(/,+/, $opt_s) if $opt_s; |
f1f595f5 |
715 | |
716 | my $extralibs = ''; |
717 | |
3cb4da91 |
718 | my @path_h; |
a0d0e21e |
719 | |
a887ff11 |
720 | while (my $arg = shift) { |
721 | if ($arg =~ /^-l/i) { |
cbca5cc3 |
722 | $extralibs .= "$arg "; |
723 | next; |
a887ff11 |
724 | } |
cbca5cc3 |
725 | last if $extralibs; |
a887ff11 |
726 | push(@path_h, $arg); |
727 | } |
e1666bf5 |
728 | |
729 | usage "Must supply header file or module name\n" |
a887ff11 |
730 | unless (@path_h or $opt_n); |
e1666bf5 |
731 | |
ddf6bed1 |
732 | my $fmask; |
3cb4da91 |
733 | my $tmask; |
ddf6bed1 |
734 | |
735 | $fmask = qr{$opt_M} if defined $opt_M; |
736 | $tmask = qr{$opt_o} if defined $opt_o; |
737 | my $tmask_all = $tmask && $opt_o eq '.'; |
738 | |
739 | if ($opt_x) { |
740 | eval {require C::Scan; 1} |
741 | or die <<EOD; |
742 | C::Scan required if you use -x option. |
743 | To install C::Scan, execute |
744 | perl -MCPAN -e "install C::Scan" |
745 | EOD |
746 | unless ($tmask_all) { |
747 | $C::Scan::VERSION >= 0.70 |
748 | or die <<EOD; |
749 | C::Scan v. 0.70 or later required unless you use -o . option. |
750 | You have version $C::Scan::VERSION installed as $INC{'C/Scan.pm'}. |
751 | To install C::Scan, execute |
752 | perl -MCPAN -e "install C::Scan" |
753 | EOD |
754 | } |
32fb2b78 |
755 | if (($opt_m || $opt_a) && $C::Scan::VERSION < 0.73) { |
756 | die <<EOD; |
757 | C::Scan v. 0.73 or later required to use -m or -a options. |
758 | You have version $C::Scan::VERSION installed as $INC{'C/Scan.pm'}. |
759 | To install C::Scan, execute |
760 | perl -MCPAN -e "install C::Scan" |
761 | EOD |
762 | } |
7aff18a2 |
763 | } |
764 | elsif ($opt_o or $opt_F) { |
dcb5229a |
765 | warn <<EOD if $opt_o; |
766 | Option -o does not make sense without -x. |
767 | EOD |
768 | warn <<EOD if $opt_F and $opt_X ; |
769 | Option -F does not make sense with -X. |
ddf6bed1 |
770 | EOD |
771 | } |
772 | |
3cb4da91 |
773 | my @path_h_ini = @path_h; |
774 | my ($name, %fullpath, %prefix, %seen_define, %prefixless, %const_names); |
a0d0e21e |
775 | |
8a9d2888 |
776 | my $module = $opt_n; |
777 | |
a887ff11 |
778 | if( @path_h ){ |
ddf6bed1 |
779 | use File::Spec; |
780 | my @paths; |
3a9c887e |
781 | my $pre_sub_tri_graphs = 1; |
ddf6bed1 |
782 | if ($^O eq 'VMS') { # Consider overrides of default location |
3cb4da91 |
783 | # XXXX This is not equivalent to what the older version did: |
784 | # it was looking at $hadsys header-file per header-file... |
785 | my($hadsys) = grep s!^sys/!!i , @path_h; |
7aff18a2 |
786 | @paths = qw( Sys$Library VAXC$Include ); |
ddf6bed1 |
787 | push @paths, ($hadsys ? 'GNU_CC_Include[vms]' : 'GNU_CC_Include[000000]'); |
788 | push @paths, qw( DECC$Library_Include DECC$System_Include ); |
7aff18a2 |
789 | } |
790 | else { |
ddf6bed1 |
791 | @paths = (File::Spec->curdir(), $Config{usrinc}, |
792 | (split ' ', $Config{locincpth}), '/usr/include'); |
793 | } |
a887ff11 |
794 | foreach my $path_h (@path_h) { |
795 | $name ||= $path_h; |
8a9d2888 |
796 | $module ||= do { |
797 | $name =~ s/\.h$//; |
798 | if ( $name !~ /::/ ) { |
799 | $name =~ s#^.*/##; |
800 | $name = "\u$name"; |
801 | } |
802 | $name; |
803 | }; |
804 | |
e1666bf5 |
805 | if( $path_h =~ s#::#/#g && $opt_n ){ |
806 | warn "Nesting of headerfile ignored with -n\n"; |
807 | } |
808 | $path_h .= ".h" unless $path_h =~ /\.h$/; |
3cb4da91 |
809 | my $fullpath = $path_h; |
760ac839 |
810 | $path_h =~ s/,.*$// if $opt_x; |
3cb4da91 |
811 | $fullpath{$path_h} = $fullpath; |
ddf6bed1 |
812 | |
8a9d2888 |
813 | # Minor trickery: we can't chdir() before we processed the headers |
814 | # (so know the name of the extension), but the header may be in the |
815 | # extension directory... |
816 | my $tmp_path_h = $path_h; |
817 | my $rel_path_h = $path_h; |
818 | my @dirs = @paths; |
ddf6bed1 |
819 | if (not -f $path_h) { |
8a9d2888 |
820 | my $found; |
ddf6bed1 |
821 | for my $dir (@paths) { |
8a9d2888 |
822 | $found++, last |
823 | if -f ($path_h = File::Spec->catfile($dir, $tmp_path_h)); |
824 | } |
825 | if ($found) { |
826 | $rel_path_h = $path_h; |
9de3b7c3 |
827 | $fullpath{$path_h} = $fullpath; |
8a9d2888 |
828 | } else { |
829 | (my $epath = $module) =~ s,::,/,g; |
830 | $epath = File::Spec->catdir('ext', $epath) if -d 'ext'; |
831 | $rel_path_h = File::Spec->catfile($epath, $tmp_path_h); |
832 | $path_h = $tmp_path_h; # Used during -x |
833 | push @dirs, $epath; |
ddf6bed1 |
834 | } |
ead2a595 |
835 | } |
5273d82d |
836 | |
837 | if (!$opt_c) { |
66b6773e |
838 | die "Can't find $tmp_path_h in @dirs\n" |
8a9d2888 |
839 | if ( ! $opt_f && ! -f "$rel_path_h" ); |
5273d82d |
840 | # Scan the header file (we should deal with nested header files) |
841 | # Record the names of simple #define constants into const_names |
a887ff11 |
842 | # Function prototypes are processed below. |
8a9d2888 |
843 | open(CH, "<$rel_path_h") || die "Can't open $rel_path_h: $!\n"; |
ddf6bed1 |
844 | defines: |
5273d82d |
845 | while (<CH>) { |
3a9c887e |
846 | if ($pre_sub_tri_graphs) { |
66b6773e |
847 | # Preprocess all tri-graphs |
3a9c887e |
848 | # including things stuck in quoted string constants. |
849 | s/\?\?=/#/g; # | ??=| #| |
850 | s/\?\?\!/|/g; # | ??!| || |
851 | s/\?\?'/^/g; # | ??'| ^| |
852 | s/\?\?\(/[/g; # | ??(| [| |
853 | s/\?\?\)/]/g; # | ??)| ]| |
854 | s/\?\?\-/~/g; # | ??-| ~| |
855 | s/\?\?\//\\/g; # | ??/| \| |
856 | s/\?\?</{/g; # | ??<| {| |
857 | s/\?\?>/}/g; # | ??>| }| |
858 | } |
9de3b7c3 |
859 | if (/^[ \t]*#[ \t]*define\s+([\$\w]+)\b(?!\()\s*(?=[^"\s])(.*)/) { |
ddf6bed1 |
860 | my $def = $1; |
861 | my $rest = $2; |
862 | $rest =~ s!/\*.*?(\*/|\n)|//.*!!g; # Remove comments |
863 | $rest =~ s/^\s+//; |
864 | $rest =~ s/\s+$//; |
865 | # Cannot do: (-1) and ((LHANDLE)3) are OK: |
866 | #print("Skip non-wordy $def => $rest\n"), |
867 | # next defines if $rest =~ /[^\w\$]/; |
868 | if ($rest =~ /"/) { |
869 | print("Skip stringy $def => $rest\n") if $opt_d; |
870 | next defines; |
871 | } |
872 | print "Matched $_ ($def)\n" if $opt_d; |
873 | $seen_define{$def} = $rest; |
874 | $_ = $def; |
e1666bf5 |
875 | next if /^_.*_h_*$/i; # special case, but for what? |
760ac839 |
876 | if (defined $opt_p) { |
5273d82d |
877 | if (!/^$opt_p(\d)/) { |
878 | ++$prefix{$_} if s/^$opt_p//; |
879 | } |
880 | else { |
881 | warn "can't remove $opt_p prefix from '$_'!\n"; |
882 | } |
ead2a595 |
883 | } |
ddf6bed1 |
884 | $prefixless{$def} = $_; |
885 | if (!$fmask or /$fmask/) { |
886 | print "... Passes mask of -M.\n" if $opt_d and $fmask; |
887 | $const_names{$_}++; |
888 | } |
5273d82d |
889 | } |
890 | } |
069eb725 |
891 | if (defined $opt_e and !$opt_e) { |
892 | close(CH); |
893 | } |
894 | else { |
622913ab |
895 | # Work from miniperl too - on "normal" systems |
896 | my $SEEK_SET = eval 'use Fcntl qw/SEEK_SET/; SEEK_SET' or 0; |
897 | seek CH, 0, $SEEK_SET; |
069eb725 |
898 | my $src = do { local $/; <CH> }; |
899 | close CH; |
900 | no warnings 'uninitialized'; |
66b6773e |
901 | |
902 | # Remove C and C++ comments |
069eb725 |
903 | $src =~ s#/\*[^*]*\*+([^/*][^*]*\*+)*/|("(\\.|[^"\\])*"|'(\\.|[^'\\])*'|.[^/"'\\]*)#$2#gs; |
c7c8b664 |
904 | $src =~ s#//.*$##gm; |
66b6773e |
905 | |
6329a6bc |
906 | while ($src =~ /\benum\s*([\w_]*)\s*\{\s([^}]+)\}/gsc) { |
907 | my ($enum_name, $enum_body) = ($1, $2); |
069eb725 |
908 | # skip enums matching $opt_e |
909 | next if $opt_e && $enum_name =~ /$opt_e/; |
910 | my $val = 0; |
911 | for my $item (split /,/, $enum_body) { |
e78c7d95 |
912 | next if $item =~ /\A\s*\Z/; |
baf7177e |
913 | my ($key, $declared_val) = $item =~ /(\w+)\s*(?:=\s*(.*))?/; |
914 | $val = defined($declared_val) && length($declared_val) ? $declared_val : 1 + $val; |
3e0a3558 |
915 | $seen_define{$key} = $val; |
36d7a91d |
916 | $const_names{$key} = { name => $key, macro => 1 }; |
069eb725 |
917 | } |
918 | } # while (...) |
919 | } # if (!defined $opt_e or $opt_e) |
e1666bf5 |
920 | } |
a887ff11 |
921 | } |
a0d0e21e |
922 | } |
923 | |
869be497 |
924 | # Save current directory so that C::Scan can use it |
925 | my $cwd = File::Spec->rel2abs( File::Spec->curdir ); |
a0d0e21e |
926 | |
1cb0fb50 |
927 | # As Ilya suggested, use a name that contains - and then it can't clash with |
928 | # the names of any packages. A directory 'fallback' will clash with any |
929 | # new pragmata down the fallback:: tree, but that seems unlikely. |
930 | my $constscfname = 'const-c.inc'; |
931 | my $constsxsfname = 'const-xs.inc'; |
932 | my $fallbackdirname = 'fallback'; |
f1f595f5 |
933 | |
4a660237 |
934 | my $ext = chdir 'ext' ? 'ext/' : ''; |
66b6773e |
935 | |
4a660237 |
936 | my @modparts = split(/::/,$module); |
937 | my $modpname = join('-', @modparts); |
938 | my $modfname = pop @modparts; |
939 | my $modpmdir = join '/', 'lib', @modparts; |
940 | my $modpmname = join '/', $modpmdir, $modfname.'.pm'; |
66b6773e |
941 | |
2920c5d2 |
942 | if ($opt_O) { |
943 | warn "Overwriting existing $ext$modpname!!!\n" if -e $modpname; |
7aff18a2 |
944 | } |
945 | else { |
2920c5d2 |
946 | die "Won't overwrite existing $ext$modpname\n" if -e $modpname; |
947 | } |
4a660237 |
948 | -d "$modpname" || mkpath([$modpname], 0, 0775); |
8e07c86e |
949 | chdir($modpname) || die "Can't chdir $ext$modpname: $!\n"; |
a0d0e21e |
950 | |
5273d82d |
951 | my %types_seen; |
952 | my %std_types; |
f4d63e4e |
953 | my $fdecls = []; |
954 | my $fdecls_parsed = []; |
ddf6bed1 |
955 | my $typedef_rex; |
956 | my %typedefs_pre; |
957 | my %known_fnames; |
7c1d48a5 |
958 | my %structs; |
5273d82d |
959 | |
3cb4da91 |
960 | my @fnames; |
961 | my @fnames_no_prefix; |
32fb2b78 |
962 | my %vdecl_hash; |
963 | my @vdecls; |
5273d82d |
964 | |
2920c5d2 |
965 | if( ! $opt_X ){ # use XS, unless it was disabled |
dcb5229a |
966 | unless ($skip_ppport) { |
967 | require Devel::PPPort; |
968 | warn "Writing $ext$modpname/ppport.h\n"; |
969 | Devel::PPPort::WriteFile('ppport.h') |
970 | || die "Can't create $ext$modpname/ppport.h: $!\n"; |
971 | } |
2920c5d2 |
972 | open(XS, ">$modfname.xs") || die "Can't create $ext$modpname/$modfname.xs: $!\n"; |
5273d82d |
973 | if ($opt_x) { |
5273d82d |
974 | warn "Scanning typemaps...\n"; |
975 | get_typemap(); |
3cb4da91 |
976 | my @td; |
977 | my @good_td; |
978 | my $addflags = $opt_F || ''; |
979 | |
f4d63e4e |
980 | foreach my $filename (@path_h) { |
3cb4da91 |
981 | my $c; |
982 | my $filter; |
983 | |
984 | if ($fullpath{$filename} =~ /,/) { |
f4d63e4e |
985 | $filename = $`; |
986 | $filter = $'; |
987 | } |
988 | warn "Scanning $filename for functions...\n"; |
5ce74a3d |
989 | my @styles = $Config{gccversion} ? qw(C++ C9X GNU) : qw(C++ C9X); |
f4d63e4e |
990 | $c = new C::Scan 'filename' => $filename, 'filename_filter' => $filter, |
5ce74a3d |
991 | 'add_cppflags' => $addflags, 'c_styles' => \@styles; |
869be497 |
992 | $c->set('includeDirs' => ["$Config::Config{archlib}/CORE", $cwd]); |
ddf6bed1 |
993 | |
5db8a8c2 |
994 | $c->get('keywords')->{'__restrict'} = 1; |
995 | |
f4d63e4e |
996 | push @$fdecls_parsed, @{ $c->get('parsed_fdecls') }; |
997 | push(@$fdecls, @{$c->get('fdecls')}); |
3cb4da91 |
998 | |
999 | push @td, @{$c->get('typedefs_maybe')}; |
7c1d48a5 |
1000 | if ($opt_a) { |
1001 | my $structs = $c->get('typedef_structs'); |
1002 | @structs{keys %$structs} = values %$structs; |
1003 | } |
3cb4da91 |
1004 | |
32fb2b78 |
1005 | if ($opt_m) { |
1006 | %vdecl_hash = %{ $c->get('vdecl_hash') }; |
1007 | @vdecls = sort keys %vdecl_hash; |
1008 | for (local $_ = 0; $_ < @vdecls; ++$_) { |
1009 | my $var = $vdecls[$_]; |
1010 | my($type, $post) = @{ $vdecl_hash{$var} }; |
1011 | if (defined $post) { |
1012 | warn "Can't handle variable '$type $var $post', skipping.\n"; |
1013 | splice @vdecls, $_, 1; |
1014 | redo; |
1015 | } |
1016 | $type = normalize_type($type); |
1017 | $vdecl_hash{$var} = $type; |
1018 | } |
1019 | } |
1020 | |
3cb4da91 |
1021 | unless ($tmask_all) { |
1022 | warn "Scanning $filename for typedefs...\n"; |
1023 | my $td = $c->get('typedef_hash'); |
1024 | # eval {require 'dumpvar.pl'; ::dumpValue($td)} or warn $@ if $opt_d; |
1025 | my @f_good_td = grep $td->{$_}[1] eq '', keys %$td; |
1026 | push @good_td, @f_good_td; |
1027 | @typedefs_pre{@f_good_td} = map $_->[0], @$td{@f_good_td}; |
1028 | } |
1029 | } |
1030 | { local $" = '|'; |
6542b28e |
1031 | $typedef_rex = qr(\b(?<!struct )(?:@good_td)\b) if @good_td; |
5273d82d |
1032 | } |
ddf6bed1 |
1033 | %known_fnames = map @$_[1,3], @$fdecls_parsed; # [1,3] is NAME, FULLTEXT |
1034 | if ($fmask) { |
1035 | my @good; |
1036 | for my $i (0..$#$fdecls_parsed) { |
1037 | next unless $fdecls_parsed->[$i][1] =~ /$fmask/; # [1] is NAME |
1038 | push @good, $i; |
1039 | print "... Function $fdecls_parsed->[$i][1] passes -M mask.\n" |
1040 | if $opt_d; |
1041 | } |
1042 | $fdecls = [@$fdecls[@good]]; |
1043 | $fdecls_parsed = [@$fdecls_parsed[@good]]; |
1044 | } |
3cb4da91 |
1045 | @fnames = sort map $_->[1], @$fdecls_parsed; # 1 is NAME |
1046 | # Sort declarations: |
1047 | { |
1048 | my %h = map( ($_->[1], $_), @$fdecls_parsed); |
1049 | $fdecls_parsed = [ @h{@fnames} ]; |
ddf6bed1 |
1050 | } |
3cb4da91 |
1051 | @fnames_no_prefix = @fnames; |
1052 | @fnames_no_prefix |
869be497 |
1053 | = sort map { ++$prefix{$_} if s/^$opt_p(?!\d)//; $_ } @fnames_no_prefix |
1054 | if defined $opt_p; |
ddf6bed1 |
1055 | # Remove macros which expand to typedefs |
ddf6bed1 |
1056 | print "Typedefs are @td.\n" if $opt_d; |
1057 | my %td = map {($_, $_)} @td; |
1058 | # Add some other possible but meaningless values for macros |
1059 | for my $k (qw(char double float int long short unsigned signed void)) { |
1060 | $td{"$_$k"} = "$_$k" for ('', 'signed ', 'unsigned '); |
1061 | } |
1062 | # eval {require 'dumpvar.pl'; ::dumpValue( [\@td, \%td] ); 1} or warn $@; |
1063 | my $n = 0; |
1064 | my %bad_macs; |
1065 | while (keys %td > $n) { |
1066 | $n = keys %td; |
1067 | my ($k, $v); |
1068 | while (($k, $v) = each %seen_define) { |
66b6773e |
1069 | # print("found '$k'=>'$v'\n"), |
ddf6bed1 |
1070 | $bad_macs{$k} = $td{$k} = $td{$v} if exists $td{$v}; |
1071 | } |
1072 | } |
1073 | # Now %bad_macs contains names of bad macros |
1074 | for my $k (keys %bad_macs) { |
1075 | delete $const_names{$prefixless{$k}}; |
1076 | print "Ignoring macro $k which expands to a typedef name '$bad_macs{$k}'\n" if $opt_d; |
5273d82d |
1077 | } |
5273d82d |
1078 | } |
2920c5d2 |
1079 | } |
36d7a91d |
1080 | my (@const_specs, @const_names); |
1081 | |
1082 | for (sort(keys(%const_names))) { |
1083 | my $v = $const_names{$_}; |
1084 | |
1085 | push(@const_specs, ref($v) ? $v : $_); |
1086 | push(@const_names, $_); |
1087 | } |
5273d82d |
1088 | |
4a660237 |
1089 | -d $modpmdir || mkpath([$modpmdir], 0, 0775); |
1090 | open(PM, ">$modpmname") || die "Can't create $ext$modpname/$modpmname: $!\n"; |
a0d0e21e |
1091 | |
a0d0e21e |
1092 | $" = "\n\t"; |
4a660237 |
1093 | warn "Writing $ext$modpname/$modpmname\n"; |
a0d0e21e |
1094 | |
be3174d2 |
1095 | print PM <<"END"; |
1096 | package $module; |
1097 | |
1098 | use $compat_version; |
dcb5229a |
1099 | END |
1100 | |
1101 | print PM <<"END" unless $skip_strict; |
be3174d2 |
1102 | use strict; |
1103 | END |
dcb5229a |
1104 | |
1105 | print PM "use warnings;\n" unless $skip_warnings or $compat_version < 5.006; |
2920c5d2 |
1106 | |
aba05478 |
1107 | unless( $opt_X || $opt_c || $opt_A ){ |
2920c5d2 |
1108 | # we'll have an AUTOLOAD(), and it will have $AUTOLOAD and |
1109 | # will want Carp. |
1110 | print PM <<'END'; |
1111 | use Carp; |
2920c5d2 |
1112 | END |
1113 | } |
1114 | |
dcb5229a |
1115 | print PM <<'END' unless $skip_exporter; |
2920c5d2 |
1116 | |
a0d0e21e |
1117 | require Exporter; |
2920c5d2 |
1118 | END |
1119 | |
a34e0dd0 |
1120 | my $use_Dyna = (not $opt_X and $compat_version < 5.006 and not $use_xsloader); |
dcb5229a |
1121 | print PM <<"END" if $use_Dyna; # use DynaLoader, unless XS was disabled |
a0d0e21e |
1122 | require DynaLoader; |
3edbfbe5 |
1123 | END |
1124 | |
e1666bf5 |
1125 | |
9ef261b5 |
1126 | # Are we using AutoLoader or not? |
dcb5229a |
1127 | unless ($skip_autoloader) { # no autoloader whatsoever. |
9ef261b5 |
1128 | unless ($opt_c) { # we're doing the AUTOLOAD |
1129 | print PM "use AutoLoader;\n"; |
2920c5d2 |
1130 | } |
9ef261b5 |
1131 | else { |
1132 | print PM "use AutoLoader qw(AUTOLOAD);\n" |
2920c5d2 |
1133 | } |
3edbfbe5 |
1134 | } |
3edbfbe5 |
1135 | |
be3174d2 |
1136 | if ( $compat_version < 5.006 ) { |
9e4509e4 |
1137 | my $vars = '$VERSION @ISA'; |
1138 | $vars .= ' @EXPORT @EXPORT_OK %EXPORT_TAGS' unless $skip_exporter; |
1139 | $vars .= ' $AUTOLOAD' unless $opt_X || $opt_c || $opt_A; |
1140 | $vars .= ' $XS_VERSION' if $opt_B && !$opt_X; |
1141 | print PM "use vars qw($vars);"; |
be3174d2 |
1142 | } |
1143 | |
9ef261b5 |
1144 | # Determine @ISA. |
dcb5229a |
1145 | my @modISA; |
66b6773e |
1146 | push @modISA, 'Exporter' unless $skip_exporter; |
dcb5229a |
1147 | push @modISA, 'DynaLoader' if $use_Dyna; # no XS |
1148 | my $myISA = "our \@ISA = qw(@modISA);"; |
be3174d2 |
1149 | $myISA =~ s/^our // if $compat_version < 5.006; |
1150 | |
9ef261b5 |
1151 | print PM "\n$myISA\n\n"; |
e1666bf5 |
1152 | |
32fb2b78 |
1153 | my @exported_names = (@const_names, @fnames_no_prefix, map '$'.$_, @vdecls); |
3cb4da91 |
1154 | |
dcb5229a |
1155 | my $tmp=''; |
1156 | $tmp .= <<"END" unless $skip_exporter; |
e1666bf5 |
1157 | # Items to export into callers namespace by default. Note: do not export |
1158 | # names by default without a very good reason. Use EXPORT_OK instead. |
1159 | # Do not simply export all your public functions/methods/constants. |
ddf6bed1 |
1160 | |
1161 | # This allows declaration use $module ':all'; |
1162 | # If you do not need this, moving things directly into \@EXPORT or \@EXPORT_OK |
1163 | # will save memory. |
51fac20b |
1164 | our %EXPORT_TAGS = ( 'all' => [ qw( |
3cb4da91 |
1165 | @exported_names |
ddf6bed1 |
1166 | ) ] ); |
1167 | |
51fac20b |
1168 | our \@EXPORT_OK = ( \@{ \$EXPORT_TAGS{'all'} } ); |
ddf6bed1 |
1169 | |
77ca0c92 |
1170 | our \@EXPORT = qw( |
e1666bf5 |
1171 | @const_names |
a0d0e21e |
1172 | ); |
dcb5229a |
1173 | |
1174 | END |
1175 | |
9e4509e4 |
1176 | $tmp .= "our \$VERSION = '$TEMPLATE_VERSION';\n"; |
1177 | if ($opt_B) { |
1178 | $tmp .= "our \$XS_VERSION = \$VERSION;\n" unless $opt_X; |
1179 | $tmp .= "\$VERSION = eval \$VERSION; # see L<perlmodstyle>\n"; |
1180 | } |
1181 | $tmp .= "\n"; |
e1666bf5 |
1182 | |
be3174d2 |
1183 | $tmp =~ s/^our //mg if $compat_version < 5.006; |
1184 | print PM $tmp; |
1185 | |
32fb2b78 |
1186 | if (@vdecls) { |
1187 | printf PM "our(@{[ join ', ', map '$'.$_, @vdecls ]});\n\n"; |
1188 | } |
1189 | |
be3174d2 |
1190 | |
af6c647e |
1191 | print PM autoload ($module, $compat_version) unless $opt_c or $opt_X; |
a0d0e21e |
1192 | |
2920c5d2 |
1193 | if( ! $opt_X ){ # print bootstrap, unless XS is disabled |
dcb5229a |
1194 | if ($use_Dyna) { |
9e4509e4 |
1195 | $tmp = <<"END"; |
f508c652 |
1196 | bootstrap $module \$VERSION; |
2920c5d2 |
1197 | END |
dcb5229a |
1198 | } else { |
9e4509e4 |
1199 | $tmp = <<"END"; |
dcb5229a |
1200 | require XSLoader; |
1201 | XSLoader::load('$module', \$VERSION); |
1202 | END |
1203 | } |
9e4509e4 |
1204 | $tmp =~ s:\$VERSION:\$XS_VERSION:g if $opt_B; |
1205 | print PM $tmp; |
2920c5d2 |
1206 | } |
1207 | |
32fb2b78 |
1208 | # tying the variables can happen only after bootstrap |
1209 | if (@vdecls) { |
1210 | printf PM <<END; |
1211 | { |
1212 | @{[ join "\n", map " _tievar_$_(\$$_);", @vdecls ]} |
1213 | } |
1214 | |
1215 | END |
1216 | } |
1217 | |
3cb4da91 |
1218 | my $after; |
2920c5d2 |
1219 | if( $opt_P ){ # if POD is disabled |
1220 | $after = '__END__'; |
1221 | } |
1222 | else { |
1223 | $after = '=cut'; |
1224 | } |
1225 | |
1226 | print PM <<"END"; |
a0d0e21e |
1227 | |
e1666bf5 |
1228 | # Preloaded methods go here. |
9ef261b5 |
1229 | END |
1230 | |
1231 | print PM <<"END" unless $opt_A; |
a0d0e21e |
1232 | |
2920c5d2 |
1233 | # Autoload methods go after $after, and are processed by the autosplit program. |
9ef261b5 |
1234 | END |
1235 | |
1236 | print PM <<"END"; |
a0d0e21e |
1237 | |
1238 | 1; |
e1666bf5 |
1239 | __END__ |
a0d0e21e |
1240 | END |
a0d0e21e |
1241 | |
a42b7cd7 |
1242 | my ($email,$author,$licence); |
65cf46c7 |
1243 | |
1244 | eval { |
317fb126 |
1245 | my $username; |
1246 | ($username,$author) = (getpwuid($>))[0,6]; |
1247 | if (defined $username && defined $author) { |
1248 | $author =~ s/,.*$//; # in case of sub fields |
1249 | my $domain = $Config{'mydomain'}; |
1250 | $domain =~ s/^\.//; |
1251 | $email = "$username\@$domain"; |
1252 | } |
65cf46c7 |
1253 | }; |
1254 | |
5a4d6b2b |
1255 | $author =~ s/'/\\'/g if defined $author; |
65cf46c7 |
1256 | $author ||= "A. U. Thor"; |
1257 | $email ||= 'a.u.thor@a.galaxy.far.far.away'; |
f508c652 |
1258 | |
a42b7cd7 |
1259 | $licence = sprintf << "DEFAULT", $^V; |
1260 | Copyright (C) ${\(1900 + (localtime) [5])} by $author |
1261 | |
1262 | This library is free software; you can redistribute it and/or modify |
1263 | it under the same terms as Perl itself, either Perl version %vd or, |
1264 | at your option, any later version of Perl 5 you may have available. |
1265 | DEFAULT |
1266 | |
c0f8b9cd |
1267 | my $revhist = ''; |
1268 | $revhist = <<EOT if $opt_C; |
497711e7 |
1269 | # |
1270 | #=head1 HISTORY |
1271 | # |
1272 | #=over 8 |
1273 | # |
1274 | #=item $TEMPLATE_VERSION |
1275 | # |
1276 | #Original version; created by h2xs $H2XS_VERSION with options |
1277 | # |
1278 | # @ARGS |
1279 | # |
1280 | #=back |
1281 | # |
c0f8b9cd |
1282 | EOT |
1283 | |
dcb5229a |
1284 | my $exp_doc = $skip_exporter ? '' : <<EOD; |
497711e7 |
1285 | # |
1286 | #=head2 EXPORT |
1287 | # |
1288 | #None by default. |
1289 | # |
ddf6bed1 |
1290 | EOD |
b7d5fa84 |
1291 | |
5273d82d |
1292 | if (@const_names and not $opt_P) { |
dcb5229a |
1293 | $exp_doc .= <<EOD unless $skip_exporter; |
497711e7 |
1294 | #=head2 Exportable constants |
1295 | # |
1296 | # @{[join "\n ", @const_names]} |
1297 | # |
5273d82d |
1298 | EOD |
1299 | } |
b7d5fa84 |
1300 | |
5273d82d |
1301 | if (defined $fdecls and @$fdecls and not $opt_P) { |
dcb5229a |
1302 | $exp_doc .= <<EOD unless $skip_exporter; |
497711e7 |
1303 | #=head2 Exportable functions |
1304 | # |
3cb4da91 |
1305 | EOD |
b7d5fa84 |
1306 | |
497711e7 |
1307 | # $exp_doc .= <<EOD if $opt_p; |
1308 | #When accessing these functions from Perl, prefix C<$opt_p> should be removed. |
1309 | # |
b7d5fa84 |
1310 | #EOD |
dcb5229a |
1311 | $exp_doc .= <<EOD unless $skip_exporter; |
497711e7 |
1312 | # @{[join "\n ", @known_fnames{@fnames}]} |
1313 | # |
5273d82d |
1314 | EOD |
1315 | } |
1316 | |
b7d5fa84 |
1317 | my $meth_doc = ''; |
1318 | |
1319 | if ($opt_x && $opt_a) { |
1320 | my($name, $struct); |
1321 | $meth_doc .= accessor_docs($name, $struct) |
1322 | while ($name, $struct) = each %structs; |
1323 | } |
1324 | |
a42b7cd7 |
1325 | # Prefix the default licence with hash symbols. |
1326 | # Is this just cargo cult - it seems that the first thing that happens to this |
1327 | # block is that all the hashes are then s///g out. |
1328 | my $licence_hash = $licence; |
1329 | $licence_hash =~ s/^/#/gm; |
1330 | |
76df5e8f |
1331 | my $pod; |
1332 | $pod = <<"END" unless $opt_P; |
973ae360 |
1333 | ## Below is stub documentation for your module. You'd better edit it! |
f508c652 |
1334 | # |
1335 | #=head1 NAME |
1336 | # |
1337 | #$module - Perl extension for blah blah blah |
1338 | # |
1339 | #=head1 SYNOPSIS |
1340 | # |
1341 | # use $module; |
1342 | # blah blah blah |
1343 | # |
1344 | #=head1 DESCRIPTION |
1345 | # |
7aff18a2 |
1346 | #Stub documentation for $module, created by h2xs. It looks like the |
f508c652 |
1347 | #author of the extension was negligent enough to leave the stub |
1348 | #unedited. |
1349 | # |
1350 | #Blah blah blah. |
b7d5fa84 |
1351 | $exp_doc$meth_doc$revhist |
f508c652 |
1352 | # |
09c48e64 |
1353 | #=head1 SEE ALSO |
f508c652 |
1354 | # |
09c48e64 |
1355 | #Mention other useful documentation such as the documentation of |
1356 | #related modules or operating system documentation (such as man pages |
1357 | #in UNIX), or any relevant external documentation such as RFCs or |
1358 | #standards. |
e8f26592 |
1359 | # |
1360 | #If you have a mailing list set up for your module, mention it here. |
1361 | # |
09c48e64 |
1362 | #If you have a web site set up for your module, mention it here. |
1363 | # |
1364 | #=head1 AUTHOR |
1365 | # |
1366 | #$author, E<lt>${email}E<gt> |
1367 | # |
e8f26592 |
1368 | #=head1 COPYRIGHT AND LICENSE |
1369 | # |
a42b7cd7 |
1370 | $licence_hash |
e8f26592 |
1371 | # |
f508c652 |
1372 | #=cut |
1373 | END |
1374 | |
1375 | $pod =~ s/^\#//gm unless $opt_P; |
1376 | print PM $pod unless $opt_P; |
1377 | |
a0d0e21e |
1378 | close PM; |
1379 | |
e1666bf5 |
1380 | |
2920c5d2 |
1381 | if( ! $opt_X ){ # print XS, unless it is disabled |
8e07c86e |
1382 | warn "Writing $ext$modpname/$modfname.xs\n"; |
e1666bf5 |
1383 | |
a0d0e21e |
1384 | print XS <<"END"; |
1385 | #include "EXTERN.h" |
1386 | #include "perl.h" |
1387 | #include "XSUB.h" |
dcb5229a |
1388 | |
1389 | END |
1390 | |
1391 | print XS <<"END" unless $skip_ppport; |
0a7c7f4f |
1392 | #include "ppport.h" |
a0d0e21e |
1393 | |
1394 | END |
dcb5229a |
1395 | |
a887ff11 |
1396 | if( @path_h ){ |
3cb4da91 |
1397 | foreach my $path_h (@path_h_ini) { |
a0d0e21e |
1398 | my($h) = $path_h; |
1399 | $h =~ s#^/usr/include/##; |
ead2a595 |
1400 | if ($^O eq 'VMS') { $h =~ s#.*vms\]#sys/# or $h =~ s#.*[:>\]]##; } |
a887ff11 |
1401 | print XS qq{#include <$h>\n}; |
1402 | } |
1403 | print XS "\n"; |
a0d0e21e |
1404 | } |
1405 | |
e255a1c9 |
1406 | print XS <<"END" if $opt_g; |
1407 | |
1408 | /* Global Data */ |
1409 | |
1410 | #define MY_CXT_KEY "${module}::_guts" XS_VERSION |
1411 | |
1412 | typedef struct { |
1413 | /* Put Global Data in here */ |
1414 | int dummy; /* you can access this elsewhere as MY_CXT.dummy */ |
1415 | } my_cxt_t; |
1416 | |
1417 | START_MY_CXT |
1418 | |
1419 | END |
1420 | |
ddf6bed1 |
1421 | my %pointer_typedefs; |
1422 | my %struct_typedefs; |
1423 | |
1424 | sub td_is_pointer { |
1425 | my $type = shift; |
1426 | my $out = $pointer_typedefs{$type}; |
1427 | return $out if defined $out; |
1428 | my $otype = $type; |
1429 | $out = ($type =~ /\*$/); |
1430 | # This converts only the guys which do not have trailing part in the typedef |
1431 | if (not $out |
1432 | and $typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) { |
1433 | $type = normalize_type($type); |
1434 | print "Is-Pointer: Type mutation via typedefs: $otype ==> $type\n" |
1435 | if $opt_d; |
1436 | $out = td_is_pointer($type); |
1437 | } |
1438 | return ($pointer_typedefs{$otype} = $out); |
1439 | } |
1440 | |
1441 | sub td_is_struct { |
1442 | my $type = shift; |
1443 | my $out = $struct_typedefs{$type}; |
1444 | return $out if defined $out; |
1445 | my $otype = $type; |
32fb2b78 |
1446 | $out = ($type =~ /^(struct|union)\b/) && !td_is_pointer($type); |
ddf6bed1 |
1447 | # This converts only the guys which do not have trailing part in the typedef |
1448 | if (not $out |
1449 | and $typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) { |
1450 | $type = normalize_type($type); |
1451 | print "Is-Struct: Type mutation via typedefs: $otype ==> $type\n" |
1452 | if $opt_d; |
1453 | $out = td_is_struct($type); |
1454 | } |
1455 | return ($struct_typedefs{$otype} = $out); |
1456 | } |
1457 | |
9a7df4f2 |
1458 | print_tievar_subs(\*XS, $_, $vdecl_hash{$_}) for @vdecls; |
e1666bf5 |
1459 | |
ddf6bed1 |
1460 | if( ! $opt_c ) { |
9a7df4f2 |
1461 | # We write the "sample" files used when this module is built by perl without |
1462 | # ExtUtils::Constant. |
1463 | # h2xs will later check that these are the same as those generated by the |
1464 | # code embedded into Makefile.PL |
1cb0fb50 |
1465 | unless (-d $fallbackdirname) { |
1466 | mkdir "$fallbackdirname" or die "Cannot mkdir $fallbackdirname: $!\n"; |
1467 | } |
1468 | warn "Writing $ext$modpname/$fallbackdirname/$constscfname\n"; |
1469 | warn "Writing $ext$modpname/$fallbackdirname/$constsxsfname\n"; |
1470 | my $cfallback = File::Spec->catfile($fallbackdirname, $constscfname); |
1471 | my $xsfallback = File::Spec->catfile($fallbackdirname, $constsxsfname); |
1472 | WriteConstants ( C_FILE => $cfallback, |
1473 | XS_FILE => $xsfallback, |
9a7df4f2 |
1474 | DEFAULT_TYPE => $opt_t, |
1475 | NAME => $module, |
36d7a91d |
1476 | NAMES => \@const_specs, |
9a7df4f2 |
1477 | ); |
1cb0fb50 |
1478 | print XS "#include \"$constscfname\"\n"; |
e1666bf5 |
1479 | } |
1480 | |
32fb2b78 |
1481 | |
f1f595f5 |
1482 | my $prefix = defined $opt_p ? "PREFIX = $opt_p" : ''; |
3cb4da91 |
1483 | |
e1666bf5 |
1484 | # Now switch from C to XS by issuing the first MODULE declaration: |
1485 | print XS <<"END"; |
a0d0e21e |
1486 | |
ead2a595 |
1487 | MODULE = $module PACKAGE = $module $prefix |
1488 | |
1489 | END |
1490 | |
9a7df4f2 |
1491 | # If a constant() function was #included then output a corresponding |
1492 | # XS declaration: |
1cb0fb50 |
1493 | print XS "INCLUDE: $constsxsfname\n" unless $opt_c; |
9a7df4f2 |
1494 | |
e255a1c9 |
1495 | print XS <<"END" if $opt_g; |
1496 | |
1497 | BOOT: |
1498 | { |
1499 | MY_CXT_INIT; |
1500 | /* If any of the fields in the my_cxt_t struct need |
1501 | to be initialised, do it here. |
1502 | */ |
1503 | } |
1504 | |
1505 | END |
1506 | |
ead2a595 |
1507 | foreach (sort keys %const_xsub) { |
1508 | print XS <<"END"; |
1509 | char * |
1510 | $_() |
1511 | |
1512 | CODE: |
1513 | #ifdef $_ |
7aff18a2 |
1514 | RETVAL = $_; |
ead2a595 |
1515 | #else |
7aff18a2 |
1516 | croak("Your vendor has not defined the $module macro $_"); |
ead2a595 |
1517 | #endif |
1518 | |
1519 | OUTPUT: |
7aff18a2 |
1520 | RETVAL |
a0d0e21e |
1521 | |
e1666bf5 |
1522 | END |
ead2a595 |
1523 | } |
e1666bf5 |
1524 | |
5273d82d |
1525 | my %seen_decl; |
ddf6bed1 |
1526 | my %typemap; |
5273d82d |
1527 | |
ead2a595 |
1528 | sub print_decl { |
1529 | my $fh = shift; |
1530 | my $decl = shift; |
1531 | my ($type, $name, $args) = @$decl; |
5273d82d |
1532 | return if $seen_decl{$name}++; # Need to do the same for docs as well? |
1533 | |
ead2a595 |
1534 | my @argnames = map {$_->[1]} @$args; |
ddf6bed1 |
1535 | my @argtypes = map { normalize_type( $_->[0], 1 ) } @$args; |
32fb2b78 |
1536 | if ($opt_k) { |
1537 | s/^\s*const\b\s*// for @argtypes; |
1538 | } |
5273d82d |
1539 | my @argarrays = map { $_->[4] || '' } @$args; |
ead2a595 |
1540 | my $numargs = @$args; |
1541 | if ($numargs and $argtypes[-1] eq '...') { |
1542 | $numargs--; |
1543 | $argnames[-1] = '...'; |
1544 | } |
1545 | local $" = ', '; |
ddf6bed1 |
1546 | $type = normalize_type($type, 1); |
1547 | |
ead2a595 |
1548 | print $fh <<"EOP"; |
1549 | |
1550 | $type |
1551 | $name(@argnames) |
1552 | EOP |
1553 | |
3cb4da91 |
1554 | for my $arg (0 .. $numargs - 1) { |
ead2a595 |
1555 | print $fh <<"EOP"; |
5273d82d |
1556 | $argtypes[$arg] $argnames[$arg]$argarrays[$arg] |
ead2a595 |
1557 | EOP |
1558 | } |
1559 | } |
1560 | |
32fb2b78 |
1561 | sub print_tievar_subs { |
1562 | my($fh, $name, $type) = @_; |
1563 | print $fh <<END; |
1564 | I32 |
1565 | _get_$name(IV index, SV *sv) { |
1566 | dSP; |
1567 | PUSHMARK(SP); |
1568 | XPUSHs(sv); |
1569 | PUTBACK; |
1570 | (void)call_pv("$module\::_get_$name", G_DISCARD); |
1571 | return (I32)0; |
1572 | } |
1573 | |
1574 | I32 |
1575 | _set_$name(IV index, SV *sv) { |
1576 | dSP; |
1577 | PUSHMARK(SP); |
1578 | XPUSHs(sv); |
1579 | PUTBACK; |
1580 | (void)call_pv("$module\::_set_$name", G_DISCARD); |
1581 | return (I32)0; |
1582 | } |
1583 | |
1584 | END |
1585 | } |
1586 | |
1587 | sub print_tievar_xsubs { |
1588 | my($fh, $name, $type) = @_; |
1589 | print $fh <<END; |
1590 | void |
1591 | _tievar_$name(sv) |
1592 | SV* sv |
1593 | PREINIT: |
1594 | struct ufuncs uf; |
1595 | CODE: |
1596 | uf.uf_val = &_get_$name; |
1597 | uf.uf_set = &_set_$name; |
1598 | uf.uf_index = (IV)&_get_$name; |
1599 | sv_magic(sv, 0, 'U', (char*)&uf, sizeof(uf)); |
1600 | |
1601 | void |
1602 | _get_$name(THIS) |
1603 | $type THIS = NO_INIT |
1604 | CODE: |
1605 | THIS = $name; |
1606 | OUTPUT: |
1607 | SETMAGIC: DISABLE |
1608 | THIS |
1609 | |
1610 | void |
1611 | _set_$name(THIS) |
1612 | $type THIS |
1613 | CODE: |
1614 | $name = THIS; |
1615 | |
1616 | END |
1617 | } |
1618 | |
7c1d48a5 |
1619 | sub print_accessors { |
1620 | my($fh, $name, $struct) = @_; |
1621 | return unless defined $struct && $name !~ /\s|_ANON/; |
1622 | $name = normalize_type($name); |
1623 | my $ptrname = normalize_type("$name *"); |
32fb2b78 |
1624 | print $fh <<"EOF"; |
1625 | |
1626 | MODULE = $module PACKAGE = ${name} $prefix |
1627 | |
1628 | $name * |
1629 | _to_ptr(THIS) |
1630 | $name THIS = NO_INIT |
1631 | PROTOTYPE: \$ |
1632 | CODE: |
1633 | if (sv_derived_from(ST(0), "$name")) { |
1634 | STRLEN len; |
1635 | char *s = SvPV((SV*)SvRV(ST(0)), len); |
1636 | if (len != sizeof(THIS)) |
1637 | croak("Size \%d of packed data != expected \%d", |
1638 | len, sizeof(THIS)); |
1639 | RETVAL = ($name *)s; |
66b6773e |
1640 | } |
32fb2b78 |
1641 | else |
1642 | croak("THIS is not of type $name"); |
1643 | OUTPUT: |
1644 | RETVAL |
1645 | |
1646 | $name |
1647 | new(CLASS) |
1648 | char *CLASS = NO_INIT |
1649 | PROTOTYPE: \$ |
1650 | CODE: |
1651 | Zero((void*)&RETVAL, sizeof(RETVAL), char); |
1652 | OUTPUT: |
1653 | RETVAL |
7c1d48a5 |
1654 | |
1655 | MODULE = $module PACKAGE = ${name}Ptr $prefix |
1656 | |
1657 | EOF |
1658 | my @items = @$struct; |
1659 | while (@items) { |
1660 | my $item = shift @items; |
1661 | if ($item->[0] =~ /_ANON/) { |
32fb2b78 |
1662 | if (defined $item->[2]) { |
7c1d48a5 |
1663 | push @items, map [ |
32fb2b78 |
1664 | @$_[0, 1], "$item->[2]_$_->[2]", "$item->[2].$_->[2]", |
7c1d48a5 |
1665 | ], @{ $structs{$item->[0]} }; |
1666 | } else { |
1667 | push @items, @{ $structs{$item->[0]} }; |
1668 | } |
1669 | } else { |
1670 | my $type = normalize_type($item->[0]); |
32fb2b78 |
1671 | my $ttype = $structs{$type} ? normalize_type("$type *") : $type; |
7c1d48a5 |
1672 | print $fh <<"EOF"; |
32fb2b78 |
1673 | $ttype |
1674 | $item->[2](THIS, __value = NO_INIT) |
7c1d48a5 |
1675 | $ptrname THIS |
1676 | $type __value |
1677 | PROTOTYPE: \$;\$ |
1678 | CODE: |
7c1d48a5 |
1679 | if (items > 1) |
1680 | THIS->$item->[-1] = __value; |
32fb2b78 |
1681 | RETVAL = @{[ |
1682 | $type eq $ttype ? "THIS->$item->[-1]" : "&(THIS->$item->[-1])" |
1683 | ]}; |
7c1d48a5 |
1684 | OUTPUT: |
1685 | RETVAL |
1686 | |
1687 | EOF |
1688 | } |
1689 | } |
1690 | } |
1691 | |
b7d5fa84 |
1692 | sub accessor_docs { |
1693 | my($name, $struct) = @_; |
1694 | return unless defined $struct && $name !~ /\s|_ANON/; |
1695 | $name = normalize_type($name); |
1696 | my $ptrname = $name . 'Ptr'; |
1697 | my @items = @$struct; |
1698 | my @list; |
1699 | while (@items) { |
1700 | my $item = shift @items; |
1701 | if ($item->[0] =~ /_ANON/) { |
1702 | if (defined $item->[2]) { |
1703 | push @items, map [ |
1704 | @$_[0, 1], "$item->[2]_$_->[2]", "$item->[2].$_->[2]", |
1705 | ], @{ $structs{$item->[0]} }; |
1706 | } else { |
1707 | push @items, @{ $structs{$item->[0]} }; |
1708 | } |
1709 | } else { |
1710 | push @list, $item->[2]; |
1711 | } |
1712 | } |
b68ece06 |
1713 | my $methods = (join '(...)>, C<', @list) . '(...)'; |
b7d5fa84 |
1714 | |
b68ece06 |
1715 | my $pod = <<"EOF"; |
1716 | # |
1717 | #=head2 Object and class methods for C<$name>/C<$ptrname> |
1718 | # |
1719 | #The principal Perl representation of a C object of type C<$name> is an |
1720 | #object of class C<$ptrname> which is a reference to an integer |
1721 | #representation of a C pointer. To create such an object, one may use |
1722 | #a combination |
1723 | # |
1724 | # my \$buffer = $name->new(); |
1725 | # my \$obj = \$buffer->_to_ptr(); |
1726 | # |
1727 | #This exersizes the following two methods, and an additional class |
1728 | #C<$name>, the internal representation of which is a reference to a |
1729 | #packed string with the C structure. Keep in mind that \$buffer should |
1730 | #better survive longer than \$obj. |
1731 | # |
1732 | #=over |
1733 | # |
1734 | #=item C<\$object_of_type_$name-E<gt>_to_ptr()> |
1735 | # |
1736 | #Converts an object of type C<$name> to an object of type C<$ptrname>. |
1737 | # |
1738 | #=item C<$name-E<gt>new()> |
1739 | # |
1740 | #Creates an empty object of type C<$name>. The corresponding packed |
1741 | #string is zeroed out. |
1742 | # |
1743 | #=item C<$methods> |
1744 | # |
1745 | #return the current value of the corresponding element if called |
1746 | #without additional arguments. Set the element to the supplied value |
1747 | #(and return the new value) if called with an additional argument. |
1748 | # |
1749 | #Applicable to objects of type C<$ptrname>. |
1750 | # |
1751 | #=back |
1752 | # |
b7d5fa84 |
1753 | EOF |
b68ece06 |
1754 | $pod =~ s/^\#//gm; |
1755 | return $pod; |
b7d5fa84 |
1756 | } |
1757 | |
5273d82d |
1758 | # Should be called before any actual call to normalize_type(). |
1759 | sub get_typemap { |
1760 | # We do not want to read ./typemap by obvios reasons. |
1761 | my @tm = qw(../../../typemap ../../typemap ../typemap); |
1762 | my $stdtypemap = "$Config::Config{privlib}/ExtUtils/typemap"; |
1763 | unshift @tm, $stdtypemap; |
1764 | my $proto_re = "[" . quotemeta('\$%&*@;') . "]" ; |
ddf6bed1 |
1765 | |
1766 | # Start with useful default values |
9cacc32e |
1767 | $typemap{float} = 'T_NV'; |
ddf6bed1 |
1768 | |
3cb4da91 |
1769 | foreach my $typemap (@tm) { |
5273d82d |
1770 | next unless -e $typemap ; |
1771 | # skip directories, binary files etc. |
1772 | warn " Scanning $typemap\n"; |
66b6773e |
1773 | warn("Warning: ignoring non-text typemap file '$typemap'\n"), next |
5273d82d |
1774 | unless -T $typemap ; |
66b6773e |
1775 | open(TYPEMAP, $typemap) |
5273d82d |
1776 | or warn ("Warning: could not open typemap file '$typemap': $!\n"), next; |
1777 | my $mode = 'Typemap'; |
1778 | while (<TYPEMAP>) { |
1779 | next if /^\s*\#/; |
1780 | if (/^INPUT\s*$/) { $mode = 'Input'; next; } |
1781 | elsif (/^OUTPUT\s*$/) { $mode = 'Output'; next; } |
1782 | elsif (/^TYPEMAP\s*$/) { $mode = 'Typemap'; next; } |
1783 | elsif ($mode eq 'Typemap') { |
1784 | next if /^\s*($|\#)/ ; |
3cb4da91 |
1785 | my ($type, $image); |
ddf6bed1 |
1786 | if ( ($type, $image) = |
5273d82d |
1787 | /^\s*(.*?\S)\s+(\S+)\s*($proto_re*)\s*$/o |
1788 | # This may reference undefined functions: |
1789 | and not ($image eq 'T_PACKED' and $typemap eq $stdtypemap)) { |
ddf6bed1 |
1790 | $typemap{normalize_type($type)} = $image; |
5273d82d |
1791 | } |
1792 | } |
1793 | } |
1794 | close(TYPEMAP) or die "Cannot close $typemap: $!"; |
1795 | } |
1796 | %std_types = %types_seen; |
1797 | %types_seen = (); |
1798 | } |
1799 | |
ead2a595 |
1800 | |
ddf6bed1 |
1801 | sub normalize_type { # Second arg: do not strip const's before \* |
ead2a595 |
1802 | my $type = shift; |
3cb4da91 |
1803 | my $do_keep_deep_const = shift; |
1804 | # If $do_keep_deep_const this is heuristical only |
1805 | my $keep_deep_const = ($do_keep_deep_const ? '\b(?![^(,)]*\*)' : ''); |
66b6773e |
1806 | my $ignore_mods |
3cb4da91 |
1807 | = "(?:\\b(?:(?:__const__|const)$keep_deep_const|static|inline|__inline__)\\b\\s*)*"; |
1808 | if ($do_keep_deep_const) { # Keep different compiled /RExen/o separately! |
1809 | $type =~ s/$ignore_mods//go; |
7aff18a2 |
1810 | } |
1811 | else { |
3cb4da91 |
1812 | $type =~ s/$ignore_mods//go; |
1813 | } |
f1f595f5 |
1814 | $type =~ s/([^\s\w])/ $1 /g; |
ead2a595 |
1815 | $type =~ s/\s+$//; |
1816 | $type =~ s/^\s+//; |
ddf6bed1 |
1817 | $type =~ s/\s+/ /g; |
1818 | $type =~ s/\* (?=\*)/*/g; |
1819 | $type =~ s/\. \. \./.../g; |
1820 | $type =~ s/ ,/,/g; |
66b6773e |
1821 | $types_seen{$type}++ |
5273d82d |
1822 | unless $type eq '...' or $type eq 'void' or $std_types{$type}; |
ead2a595 |
1823 | $type; |
1824 | } |
1825 | |
ddf6bed1 |
1826 | my $need_opaque; |
1827 | |
1828 | sub assign_typemap_entry { |
1829 | my $type = shift; |
1830 | my $otype = $type; |
1831 | my $entry; |
1832 | if ($tmask and $type =~ /$tmask/) { |
1833 | print "Type $type matches -o mask\n" if $opt_d; |
1834 | $entry = (td_is_struct($type) ? "T_OPAQUE_STRUCT" : "T_PTROBJ"); |
1835 | } |
1836 | elsif ($typedef_rex and $type =~ s/($typedef_rex)/$typedefs_pre{$1}/go) { |
1837 | $type = normalize_type $type; |
1838 | print "Type mutation via typedefs: $otype ==> $type\n" if $opt_d; |
1839 | $entry = assign_typemap_entry($type); |
1840 | } |
40292913 |
1841 | # XXX good do better if our UV happens to be long long |
1842 | return "T_NV" if $type =~ /^(unsigned\s+)?long\s+(long|double)\z/; |
ddf6bed1 |
1843 | $entry ||= $typemap{$otype} |
1844 | || (td_is_struct($type) ? "T_OPAQUE_STRUCT" : "T_PTROBJ"); |
1845 | $typemap{$otype} = $entry; |
1846 | $need_opaque = 1 if $entry eq "T_OPAQUE_STRUCT"; |
1847 | return $entry; |
1848 | } |
1849 | |
32fb2b78 |
1850 | for (@vdecls) { |
1851 | print_tievar_xsubs(\*XS, $_, $vdecl_hash{$_}); |
1852 | } |
1853 | |
ead2a595 |
1854 | if ($opt_x) { |
32fb2b78 |
1855 | for my $decl (@$fdecls_parsed) { print_decl(\*XS, $decl) } |
1856 | if ($opt_a) { |
1857 | while (my($name, $struct) = each %structs) { |
1858 | print_accessors(\*XS, $name, $struct); |
7c1d48a5 |
1859 | } |
32fb2b78 |
1860 | } |
ead2a595 |
1861 | } |
1862 | |
a0d0e21e |
1863 | close XS; |
5273d82d |
1864 | |
1865 | if (%types_seen) { |
1866 | my $type; |
1867 | warn "Writing $ext$modpname/typemap\n"; |
1868 | open TM, ">typemap" or die "Cannot open typemap file for write: $!"; |
1869 | |
3cb4da91 |
1870 | for $type (sort keys %types_seen) { |
ddf6bed1 |
1871 | my $entry = assign_typemap_entry $type; |
1872 | print TM $type, "\t" x (5 - int((length $type)/8)), "\t$entry\n" |
5273d82d |
1873 | } |
1874 | |
ddf6bed1 |
1875 | print TM <<'EOP' if $need_opaque; # Older Perls do not have correct entry |
1876 | ############################################################################# |
1877 | INPUT |
1878 | T_OPAQUE_STRUCT |
1879 | if (sv_derived_from($arg, \"${ntype}\")) { |
1880 | STRLEN len; |
1881 | char *s = SvPV((SV*)SvRV($arg), len); |
1882 | |
1883 | if (len != sizeof($var)) |
1884 | croak(\"Size %d of packed data != expected %d\", |
1885 | len, sizeof($var)); |
1886 | $var = *($type *)s; |
1887 | } |
1888 | else |
1889 | croak(\"$var is not of type ${ntype}\") |
1890 | ############################################################################# |
1891 | OUTPUT |
1892 | T_OPAQUE_STRUCT |
1893 | sv_setref_pvn($arg, \"${ntype}\", (char *)&$var, sizeof($var)); |
1894 | EOP |
1895 | |
5273d82d |
1896 | close TM or die "Cannot close typemap file for write: $!"; |
1897 | } |
1898 | |
2920c5d2 |
1899 | } # if( ! $opt_X ) |
e1666bf5 |
1900 | |
8e07c86e |
1901 | warn "Writing $ext$modpname/Makefile.PL\n"; |
1902 | open(PL, ">Makefile.PL") || die "Can't create $ext$modpname/Makefile.PL: $!\n"; |
a0d0e21e |
1903 | |
fe0496b9 |
1904 | my $prereq_pm = ''; |
11946041 |
1905 | |
1906 | if ( $compat_version < 5.00702 and $new_test ) |
1907 | { |
fe0496b9 |
1908 | $prereq_pm .= q%'Test::More' => 0, %; |
11946041 |
1909 | } |
fe0496b9 |
1910 | |
a34e0dd0 |
1911 | if ( $compat_version < 5.00600 and !$opt_X and $use_xsloader) |
11946041 |
1912 | { |
fe0496b9 |
1913 | $prereq_pm .= q%'XSLoader' => 0, %; |
11946041 |
1914 | } |
1915 | |
9a7df4f2 |
1916 | print PL <<"END"; |
1917 | use $compat_version; |
a0d0e21e |
1918 | use ExtUtils::MakeMaker; |
1919 | # See lib/ExtUtils/MakeMaker.pm for details of how to influence |
42793c05 |
1920 | # the contents of the Makefile that is written. |
8bc03d0d |
1921 | WriteMakefile( |
1dd73f27 |
1922 | NAME => '$module', |
4a660237 |
1923 | VERSION_FROM => '$modpmname', # finds \$VERSION |
1dd73f27 |
1924 | PREREQ_PM => {$prereq_pm}, # e.g., Module::Name => 1.1 |
1925 | (\$] >= 5.005 ? ## Add these new keywords supported since 5.005 |
4a660237 |
1926 | (ABSTRACT_FROM => '$modpmname', # retrieve abstract from module |
1dd73f27 |
1927 | AUTHOR => '$author <$email>') : ()), |
a0d0e21e |
1928 | END |
8bc03d0d |
1929 | if (!$opt_X) { # print C stuff, unless XS is disabled |
ddf6bed1 |
1930 | $opt_F = '' unless defined $opt_F; |
b68ece06 |
1931 | my $I = (((glob '*.h') || (glob '*.hh')) ? '-I.' : ''); |
1932 | my $Ihelp = ($I ? '-I. ' : ''); |
1933 | my $Icomment = ($I ? '' : <<EOC); |
1934 | # Insert -I. if you add *.h files later: |
1935 | EOC |
1936 | |
8bc03d0d |
1937 | print PL <<END; |
1dd73f27 |
1938 | LIBS => ['$extralibs'], # e.g., '-lm' |
1939 | DEFINE => '$opt_F', # e.g., '-DHAVE_SOMETHING' |
1940 | $Icomment INC => '$I', # e.g., '${Ihelp}-I/usr/include/other' |
b68ece06 |
1941 | END |
1942 | |
1cb0fb50 |
1943 | my $C = grep {$_ ne "$modfname.c"} |
9a7df4f2 |
1944 | (glob '*.c'), (glob '*.cc'), (glob '*.C'); |
b68ece06 |
1945 | my $Cpre = ($C ? '' : '# '); |
1946 | my $Ccomment = ($C ? '' : <<EOC); |
1947 | # Un-comment this if you add C files to link with later: |
1948 | EOC |
1949 | |
1950 | print PL <<END; |
1dd73f27 |
1951 | $Ccomment ${Cpre}OBJECT => '\$(O_FILES)', # link all the C files too |
8bc03d0d |
1952 | END |
9a7df4f2 |
1953 | } # ' # Grr |
a0d0e21e |
1954 | print PL ");\n"; |
9a7df4f2 |
1955 | if (!$opt_c) { |
1956 | my $generate_code = |
1cb0fb50 |
1957 | WriteMakefileSnippet ( C_FILE => $constscfname, |
1958 | XS_FILE => $constsxsfname, |
9a7df4f2 |
1959 | DEFAULT_TYPE => $opt_t, |
1960 | NAME => $module, |
36d7a91d |
1961 | NAMES => \@const_specs, |
9a7df4f2 |
1962 | ); |
1963 | print PL <<"END"; |
1964 | if (eval {require ExtUtils::Constant; 1}) { |
1965 | # If you edit these definitions to change the constants used by this module, |
1cb0fb50 |
1966 | # you will need to use the generated $constscfname and $constsxsfname |
9a7df4f2 |
1967 | # files to replace their "fallback" counterparts before distributing your |
1968 | # changes. |
1969 | $generate_code |
1970 | } |
1971 | else { |
1972 | use File::Copy; |
1cb0fb50 |
1973 | use File::Spec; |
1974 | foreach my \$file ('$constscfname', '$constsxsfname') { |
1975 | my \$fallback = File::Spec->catfile('$fallbackdirname', \$file); |
1976 | copy (\$fallback, \$file) or die "Can't copy \$fallback to \$file: \$!"; |
1977 | } |
9a7df4f2 |
1978 | } |
1979 | END |
1980 | |
1981 | eval $generate_code; |
1982 | if ($@) { |
1983 | warn <<"EOM"; |
1984 | Attempting to test constant code in $ext$modpname/Makefile.PL: |
1985 | $generate_code |
1986 | __END__ |
1987 | gave unexpected error $@ |
1988 | Please report the circumstances of this bug in h2xs version $H2XS_VERSION |
1989 | using the perlbug script. |
1990 | EOM |
1991 | } else { |
1992 | my $fail; |
1993 | |
1cb0fb50 |
1994 | foreach my $file ($constscfname, $constsxsfname) { |
1995 | my $fallback = File::Spec->catfile($fallbackdirname, $file); |
1996 | if (compare($file, $fallback)) { |
9a7df4f2 |
1997 | warn << "EOM"; |
1cb0fb50 |
1998 | Files "$ext$modpname/$fallbackdirname/$file" and "$ext$modpname/$file" differ. |
9a7df4f2 |
1999 | EOM |
2000 | $fail++; |
2001 | } |
2002 | } |
2003 | if ($fail) { |
2004 | warn fill ('','', <<"EOM") . "\n"; |
2005 | It appears that the code in $ext$modpname/Makefile.PL does not autogenerate |
1cb0fb50 |
2006 | the files $ext$modpname/$constscfname and $ext$modpname/$constsxsfname |
9a7df4f2 |
2007 | correctly. |
1cb0fb50 |
2008 | |
9a7df4f2 |
2009 | Please report the circumstances of this bug in h2xs version $H2XS_VERSION |
2010 | using the perlbug script. |
2011 | EOM |
2012 | } else { |
1cb0fb50 |
2013 | unlink $constscfname, $constsxsfname; |
9a7df4f2 |
2014 | } |
2015 | } |
2016 | } |
f508c652 |
2017 | close(PL) || die "Can't close $ext$modpname/Makefile.PL: $!\n"; |
2018 | |
fcd67389 |
2019 | # Create a simple README since this is a CPAN requirement |
2020 | # and it doesnt hurt to have one |
2021 | warn "Writing $ext$modpname/README\n"; |
2022 | open(RM, ">README") || die "Can't create $ext$modpname/README:$!\n"; |
2023 | my $thisyear = (gmtime)[5] + 1900; |
2024 | my $rmhead = "$modpname version $TEMPLATE_VERSION"; |
2025 | my $rmheadeq = "=" x length($rmhead); |
11946041 |
2026 | |
2027 | my $rm_prereq; |
2028 | |
2029 | if ( $compat_version < 5.00702 and $new_test ) |
2030 | { |
2031 | $rm_prereq = 'Test::More'; |
2032 | } |
2033 | else |
2034 | { |
2035 | $rm_prereq = 'blah blah blah'; |
2036 | } |
2037 | |
fcd67389 |
2038 | print RM <<_RMEND_; |
2039 | $rmhead |
2040 | $rmheadeq |
2041 | |
2042 | The README is used to introduce the module and provide instructions on |
2043 | how to install the module, any machine dependencies it may have (for |
2044 | example C compilers and installed libraries) and any other information |
2045 | that should be provided before the module is installed. |
2046 | |
2047 | A README file is required for CPAN modules since CPAN extracts the |
2048 | README file from a module distribution so that people browsing the |
2049 | archive can use it get an idea of the modules uses. It is usually a |
2050 | good idea to provide version information here so that people can |
2051 | decide whether fixes for the module are worth downloading. |
2052 | |
2053 | INSTALLATION |
2054 | |
2055 | To install this module type the following: |
2056 | |
2057 | perl Makefile.PL |
2058 | make |
2059 | make test |
2060 | make install |
2061 | |
2062 | DEPENDENCIES |
2063 | |
2064 | This module requires these other modules and libraries: |
2065 | |
11946041 |
2066 | $rm_prereq |
fcd67389 |
2067 | |
2068 | COPYRIGHT AND LICENCE |
2069 | |
2070 | Put the correct copyright and licence information here. |
2071 | |
a42b7cd7 |
2072 | $licence |
fcd67389 |
2073 | |
2074 | _RMEND_ |
2075 | close(RM) || die "Can't close $ext$modpname/README: $!\n"; |
2076 | |
1b99c731 |
2077 | my $testdir = "t"; |
4a660237 |
2078 | my $testfile = "$testdir/$modpname.t"; |
e42bd63e |
2079 | unless (-d "$testdir") { |
2080 | mkdir "$testdir" or die "Cannot mkdir $testdir: $!\n"; |
2081 | } |
1b99c731 |
2082 | warn "Writing $ext$modpname/$testfile\n"; |
d3837a33 |
2083 | my $tests = @const_names ? 2 : 1; |
2084 | |
1b99c731 |
2085 | open EX, ">$testfile" or die "Can't create $ext$modpname/$testfile: $!\n"; |
11946041 |
2086 | |
d3837a33 |
2087 | print EX <<_END_; |
f508c652 |
2088 | # Before `make install' is performed this script should be runnable with |
4a660237 |
2089 | # `make test'. After `make install' it should work as `perl $modpname.t' |
f508c652 |
2090 | |
452e8205 |
2091 | ######################### |
f508c652 |
2092 | |
d3837a33 |
2093 | # change 'tests => $tests' to 'tests => last_test_to_print'; |
f508c652 |
2094 | |
11946041 |
2095 | _END_ |
2096 | |
2097 | my $test_mod = 'Test::More'; |
2098 | |
2099 | if ( $old_test or ($compat_version < 5.007 and not $new_test )) |
2100 | { |
2101 | my $test_mod = 'Test'; |
2102 | |
2103 | print EX <<_END_; |
452e8205 |
2104 | use Test; |
d3837a33 |
2105 | BEGIN { plan tests => $tests }; |
f508c652 |
2106 | use $module; |
452e8205 |
2107 | ok(1); # If we made it this far, we're ok. |
f508c652 |
2108 | |
d3837a33 |
2109 | _END_ |
11946041 |
2110 | |
2111 | if (@const_names) { |
2112 | my $const_names = join " ", @const_names; |
2113 | print EX <<'_END_'; |
d3837a33 |
2114 | |
af6c647e |
2115 | my $fail; |
2116 | foreach my $constname (qw( |
2117 | _END_ |
11946041 |
2118 | |
2119 | print EX wrap ("\t", "\t", $const_names); |
2120 | print EX (")) {\n"); |
2121 | |
2122 | print EX <<_END_; |
d3837a33 |
2123 | next if (eval "my \\\$a = \$constname; 1"); |
2124 | if (\$\@ =~ /^Your vendor has not defined $module macro \$constname/) { |
2125 | print "# pass: \$\@"; |
2126 | } else { |
2127 | print "# fail: \$\@"; |
66b6773e |
2128 | \$fail = 1; |
d3837a33 |
2129 | } |
2130 | } |
2131 | if (\$fail) { |
2132 | print "not ok 2\\n"; |
2133 | } else { |
2134 | print "ok 2\\n"; |
2135 | } |
2136 | |
2137 | _END_ |
11946041 |
2138 | } |
2139 | } |
2140 | else |
2141 | { |
2142 | print EX <<_END_; |
2143 | use Test::More tests => $tests; |
2144 | BEGIN { use_ok('$module') }; |
2145 | |
2146 | _END_ |
2147 | |
2148 | if (@const_names) { |
2149 | my $const_names = join " ", @const_names; |
2150 | print EX <<'_END_'; |
2151 | |
2152 | my $fail = 0; |
2153 | foreach my $constname (qw( |
2154 | _END_ |
2155 | |
2156 | print EX wrap ("\t", "\t", $const_names); |
2157 | print EX (")) {\n"); |
2158 | |
2159 | print EX <<_END_; |
2160 | next if (eval "my \\\$a = \$constname; 1"); |
2161 | if (\$\@ =~ /^Your vendor has not defined $module macro \$constname/) { |
2162 | print "# pass: \$\@"; |
2163 | } else { |
2164 | print "# fail: \$\@"; |
2165 | \$fail = 1; |
2166 | } |
2167 | |
2168 | } |
2169 | |
2170 | ok( \$fail == 0 , 'Constants' ); |
2171 | _END_ |
2172 | } |
d3837a33 |
2173 | } |
11946041 |
2174 | |
2175 | print EX <<_END_; |
452e8205 |
2176 | ######################### |
f508c652 |
2177 | |
11946041 |
2178 | # Insert your test code below, the $test_mod module is use()ed here so read |
2179 | # its man page ( perldoc $test_mod ) for help writing this test script. |
e1666bf5 |
2180 | |
f508c652 |
2181 | _END_ |
11946041 |
2182 | |
1b99c731 |
2183 | close(EX) || die "Can't close $ext$modpname/$testfile: $!\n"; |
a0d0e21e |
2184 | |
c0f8b9cd |
2185 | unless ($opt_C) { |
ddf6bed1 |
2186 | warn "Writing $ext$modpname/Changes\n"; |
2187 | $" = ' '; |
2188 | open(EX, ">Changes") || die "Can't create $ext$modpname/Changes: $!\n"; |
2189 | @ARGS = map {/[\s\"\'\`\$*?^|&<>\[\]\{\}\(\)]/ ? "'$_'" : $_} @ARGS; |
2190 | print EX <<EOP; |
2191 | Revision history for Perl extension $module. |
2192 | |
2193 | $TEMPLATE_VERSION @{[scalar localtime]} |
2194 | \t- original version; created by h2xs $H2XS_VERSION with options |
2195 | \t\t@ARGS |
2196 | |
2197 | EOP |
2198 | close(EX) || die "Can't close $ext$modpname/Changes: $!\n"; |
c0f8b9cd |
2199 | } |
c07a80fd |
2200 | |
2201 | warn "Writing $ext$modpname/MANIFEST\n"; |
5ae7f1db |
2202 | open(MANI,'>MANIFEST') or die "Can't create MANIFEST: $!"; |
4a660237 |
2203 | my @files = grep { -f } (<*>, <t/*>, <$fallbackdirname/*>, <$modpmdir/*>); |
5ae7f1db |
2204 | if (!@files) { |
2205 | eval {opendir(D,'.');}; |
2206 | unless ($@) { @files = readdir(D); closedir(D); } |
2207 | } |
2208 | if (!@files) { @files = map {chomp && $_} `ls`; } |
55497cff |
2209 | if ($^O eq 'VMS') { |
2210 | foreach (@files) { |
2211 | # Clip trailing '.' for portability -- non-VMS OSs don't expect it |
2212 | s%\.$%%; |
2213 | # Fix up for case-sensitive file systems |
2214 | s/$modfname/$modfname/i && next; |
2215 | $_ = "\U$_" if $_ eq 'manifest' or $_ eq 'changes'; |
bbce6d69 |
2216 | $_ = 'Makefile.PL' if $_ eq 'makefile.pl'; |
55497cff |
2217 | } |
2218 | } |
3e3baf6d |
2219 | print MANI join("\n",@files), "\n"; |
5ae7f1db |
2220 | close MANI; |
40000a8c |
2221 | !NO!SUBS! |
4633a7c4 |
2222 | |
2223 | close OUT or die "Can't close $file: $!"; |
2224 | chmod 0755, $file or die "Can't reset permissions for $file: $!\n"; |
2225 | exec("$Config{'eunicefix'} $file") if $Config{'eunicefix'} ne ':'; |
8a5546a1 |
2226 | chdir $origdir; |