This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
fix .gitignore: only ignore 'perl' in root of repo, not U/perl subdir
[metaconfig.git] / U / perl / Extensions.U
1 ?RCS: $Id: Extensions.U,v$
2 ?RCS:
3 ?RCS: Copyright (c) 1996-1998, Andy Dougherty
4 ?RCS:
5 ?RCS: You may distribute under the terms of either the GNU General Public
6 ?RCS: License or the Artistic License, as specified in the README file.
7 ?RCS:
8 ?RCS: $Log: Extensions.U,v $
9 ?RCS:
10 ?MAKE:known_extensions extensions dynamic_ext static_ext nonxs_ext \
11         useposix useopcode : \
12         Myread hint usedl d_sem d_socket i_db i_dbm i_rpcsvcdbm i_gdbm \
13         d_ndbm usethreads use5005threads package test cat rsrc \
14         d_msg d_shm osname use64bitint i_langinfo d_nl_langinfo \
15         libs d_cplusplus sed ls rm contains trnl sort
16 ?MAKE:  -pick add $@ %<
17 ?Y:BOTTOM
18 ?S:known_extensions:
19 ?S:     This variable holds a list of all extensions (both XS and non-xs)
20 ?S:     included in the package source distribution.  This information is
21 ?S:     only really of use during the Perl build, as the list makes no
22 ?S:     distinction between extensions which were build and installed, and
23 ?S:     those which where not.  See "extensions" for the list of extensions
24 ?S:     actually built and available.
25 ?S:.
26 ?S:dynamic_ext:
27 ?S:     This variable holds a list of XS extension files we want to
28 ?S:     link dynamically into the package.  It is used by Makefile.
29 ?S:.
30 ?S:static_ext:
31 ?S:     This variable holds a list of XS extension files we want to
32 ?S:     link statically into the package.  It is used by Makefile.
33 ?S:.
34 ?S:nonxs_ext:
35 ?S:     This variable holds a list of all non-xs extensions built and
36 ?S:     installed by the package.  By default, all non-xs extensions
37 ?S:     distributed will be built, with the exception of platform-specific
38 ?S:     extensions (currently only one VMS specific extension).
39 ?S:.
40 ?S:extensions:
41 ?S:     This variable holds a list of all extension files (both XS and
42 ?S:     non-xs) installed with the package.  It is propagated to Config.pm
43 ?S:     and is typically used to test whether a particular extension
44 ?S:     is available.
45 ?S:.
46 ?S:useposix:
47 ?S:     This variable holds either 'true' or 'false' to indicate
48 ?S:     whether the POSIX extension should be used.  The sole
49 ?S:     use for this currently is to allow an easy mechanism
50 ?S:     for hints files to indicate that POSIX will not compile
51 ?S:     on a particular system.
52 ?S:.
53 ?S:useopcode:
54 ?S:     This variable holds either 'true' or 'false' to indicate
55 ?S:     whether the Opcode extension should be used.  The sole
56 ?S:     use for this currently is to allow an easy mechanism
57 ?S:     for users to skip the Opcode extension from the Configure
58 ?S:     command line.
59 ?S:.
60 ?T:xxx avail_ext this_ext tdir xs_extensions nonxs_extensions find_extensions
61 ?INIT:: set useposix=false in your hint file to disable the POSIX extension.
62 ?INIT:useposix=true
63 ?INIT:: set useopcode=false in your hint file to disable the Opcode extension.
64 ?INIT:useopcode=true
65 ?LINT:extern noextensions
66 ?LINT:extern onlyextensions
67 ?T:keepextensions i
68 : Check extensions
69 echo " "
70 echo "Looking for extensions..." >&4
71 : If we are using the old config.sh, nonxs_extensions and xs_extensions may
72 : contain old or inaccurate or duplicate values.
73 nonxs_extensions=''
74 xs_extensions=''
75 : We do not use find because it might not be available.
76 : We do not just use MANIFEST because the user may have dropped
77 : some additional extensions into the source tree and expect them
78 : to be built.
79
80 : Function to recursively find available extensions, ignoring DynaLoader
81 : NOTE: recursion limit of 10 to prevent runaway in case of symlink madness
82 : In 5.10.1 and later, extensions are stored in directories
83 : like File-Glob instead of the older File/Glob/.
84 find_extensions='
85     for xxx in *; do
86         case "$xxx" in
87             DynaLoader|dynaload) ;;
88             *)
89             this_ext=`echo "$xxx" | $sed -e s/-/\\\//g`;
90             case "$this_ext" in
91                 Scalar/List/Utils) this_ext="List/Util" ;;
92                 PathTools)         this_ext="Cwd"       ;;
93             esac;
94             echo " $xs_extensions $nonxs_extensions" > "$tdir/$$.tmp";
95             if $contains " $this_ext " "$tdir/$$.tmp"; then
96                 echo >&4;
97                 echo "Duplicate directories detected for extension $xxx" >&4;
98                 echo "Configure cannot correctly recover from this - shall I abort?" >&4;
99                 case "$knowitall" in
100                 "") dflt=y;;
101                 *) dflt=n;;
102                 esac;
103                 . ../UU/myread;
104                 case "$ans" in
105                 n*|N*) ;;
106                 *) echo >&4;
107                     echo "Ok.  Stopping Configure." >&4;
108                     echo "Please remove the duplicate directory (e.g. using git clean) and then re-run Configure" >&4;
109                     exit 1;;
110                 esac;
111                 echo "Ok.  You will need to correct config.sh before running make." >&4;
112             fi;
113             $ls -1 "$xxx" > "$tdir/$$.tmp";
114             if   $contains "\.xs$" "$tdir/$$.tmp" > /dev/null 2>&1; then
115                 xs_extensions="$xs_extensions $this_ext";
116             elif $contains "\.c$"  "$tdir/$$.tmp" > /dev/null 2>&1; then
117                 xs_extensions="$xs_extensions $this_ext";
118             elif $test -d "$xxx"; then
119                 nonxs_extensions="$nonxs_extensions $this_ext";
120             fi;
121             $rm -f "$tdir/$$.tmp";
122             ;;
123         esac;
124     done'
125 tdir=`pwd`
126 cd "$rsrc/cpan"
127 set X
128 shift
129 eval $find_extensions
130 cd "$rsrc/dist"
131 set X
132 shift
133 eval $find_extensions
134 cd "$rsrc/ext"
135 set X
136 shift
137 eval $find_extensions
138 set X $xs_extensions
139 shift
140 xs_extensions=`echo "$*" | tr ' ' $trnl | $sort | tr $trnl ' '`
141 set X $nonxs_extensions
142 shift
143 nonxs_extensions=`echo "$*" | tr ' ' $trnl | $sort | tr $trnl ' '`
144 cd "$tdir"
145 known_extensions=`echo $nonxs_extensions $xs_extensions  | tr ' ' $trnl | $sort | tr $trnl ' '`
146
147 : Now see which are supported on this system.
148 ?X: avail_ext lists available XS extensions.
149 avail_ext=''
150 for xxx in $xs_extensions ; do
151         case "$xxx" in
152 ?X: Handle possible DOS 8.3 filename and case alterations
153         Amiga*)
154                 case "$osname" in
155                 amigaos) avail_ext="$avail_ext $xxx" ;;
156                 esac
157                 ;;
158         DB_File|db_file)
159                 case "$i_db" in
160                 $define) avail_ext="$avail_ext $xxx" ;;
161                 esac
162                 ;;
163         GDBM_File|gdbm_fil)
164                 case "$i_gdbm" in
165                 $define) avail_ext="$avail_ext $xxx" ;;
166                 esac
167                 ;;
168         I18N/Langinfo|i18n_lan)
169                 case "$i_langinfo$d_nl_langinfo" in
170                 $define$define) avail_ext="$avail_ext $xxx" ;;
171                 esac
172                 ;;
173         IPC/SysV|ipc/sysv)
174                 : XXX Do we need a useipcsysv variable here
175                 case "${d_msg}${d_sem}${d_shm}" in
176                 *"${define}"*) avail_ext="$avail_ext $xxx" ;;
177                 esac
178                 ;;
179         NDBM_File|ndbm_fil)
180                 case "$d_ndbm" in
181                 $define)
182                     case "$osname-$use64bitint" in
183                     hpux-define)
184                         case "$libs" in
185                         *-lndbm*) avail_ext="$avail_ext $xxx" ;;
186                         esac
187                         ;;
188                     *) avail_ext="$avail_ext $xxx" ;;
189                     esac
190                     ;;
191                 esac
192                 ;;
193         ODBM_File|odbm_fil)
194                 case "${i_dbm}${i_rpcsvcdbm}" in
195                 *"${define}"*)
196                     case "$d_cplusplus" in
197                     define) ;; # delete as a function name will not work
198                     *)  case "$osname-$use64bitint" in
199                         hpux-define)
200                             case "$libs" in
201                             *-ldbm*) avail_ext="$avail_ext $xxx" ;;
202                             esac
203                             ;;
204                         *) avail_ext="$avail_ext $xxx" ;;
205                         esac
206                         ;;
207                     esac
208                     ;;
209                 esac
210                 ;;
211         Opcode|opcode)
212                 case "$useopcode" in
213                 true|define|y) avail_ext="$avail_ext $xxx" ;;
214                 esac
215                 ;;
216         POSIX|posix)
217                 case "$useposix" in
218                 true|define|y) avail_ext="$avail_ext $xxx" ;;
219                 esac
220                 ;;
221         Socket|socket)
222                 case "$d_socket" in
223                 true|$define|y) avail_ext="$avail_ext $xxx" ;;
224                 esac
225                 ;;
226         Sys/Syslog|sys/syslog)
227                 case $osname in
228                         amigaos) ;; # not really very useful on AmigaOS
229                         *)
230                         : XXX syslog requires socket
231                         case "$d_socket" in
232                         true|$define|y) avail_ext="$avail_ext $xxx" ;;
233                         esac
234                         ;;
235                 esac
236                 ;;
237         Thread|thread)
238                 case "$usethreads" in
239                 true|$define|y)
240                         case "$use5005threads" in
241                         $define|true|[yY]*) avail_ext="$avail_ext $xxx" ;;
242                         esac
243                 esac
244                 ;;
245         threads|threads/shared)
246                 # threads and threads::shared are special cases.
247                 # To stop people from asking "Perl 5.8.0 was supposed
248                 # to have this new fancy threads implementation but my
249                 # perl doesn't have it" and from people trying to
250                 # (re)install the threads module using CPAN.pm and
251                 # CPAN.pm then offering to reinstall Perl 5.8.0,
252                 # the threads.pm and threads/shared.pm will always be
253                 # there, croaking informatively ("you need to rebuild
254                 # all of Perl with threads, sorry") when threads haven't
255                 # been compiled in.
256                 # --jhi
257                 avail_ext="$avail_ext $xxx"
258                 ;;
259         VMS*)
260                 ;;
261         Win32*)
262                 case "$osname" in
263                 cygwin) avail_ext="$avail_ext $xxx" ;;
264                 esac
265                 ;;
266         XS/APItest|xs/apitest)
267                 # This is just for testing.  Skip it unless we have dynamic loading.
268
269                 case "$usedl" in
270                 $define) avail_ext="$avail_ext $xxx" ;;
271                 esac
272                 ;;
273         XS/Typemap|xs/typemap)
274                 # This is just for testing.  Skip it unless we have dynamic loading.
275                 case "$usedl" in
276                 $define) avail_ext="$avail_ext $xxx" ;;
277                 esac
278                 ;;
279         *)      avail_ext="$avail_ext $xxx"
280                 ;;
281         esac
282 done
283
284 set X $avail_ext
285 shift
286 avail_ext="$*"
287
288 case "$onlyextensions" in
289 '') ;;
290 *)  keepextensions=''
291     echo "You have requested that only certain extensions be included..." >&4
292     for i in $onlyextensions; do
293         case " $avail_ext " in
294         *" $i "*)
295             echo "Keeping extension $i."
296             keepextensions="$keepextensions $i"
297             ;;
298         *) echo "Ignoring extension $i." ;;
299         esac
300     done
301     avail_ext="$keepextensions"
302     ;;
303 esac
304
305 case "$noextensions" in
306 '') ;;
307 *)  keepextensions=''
308     echo "You have requested that certain extensions be ignored..." >&4
309     for i in $avail_ext; do
310         case " $noextensions " in
311         *" $i "*) echo "Ignoring extension $i." ;;
312         *) echo "Keeping extension $i.";
313            keepextensions="$keepextensions $i"
314            ;;
315         esac
316     done
317     avail_ext="$keepextensions"
318     ;;
319 esac
320
321 : Now see which nonxs extensions are supported on this system.
322 : For now assume all are.
323 nonxs_ext=''
324 for xxx in $nonxs_extensions ; do
325         case "$xxx" in
326         VMS*)
327                 ;;
328         *)      nonxs_ext="$nonxs_ext $xxx"
329                 ;;
330         esac
331 done
332
333 set X $nonxs_ext
334 shift
335 nonxs_ext="$*"
336
337 case $usedl in
338 $define)
339         $cat <<EOM
340 A number of extensions are supplied with $package.  You may choose to
341 compile these extensions for dynamic loading (the default), compile
342 them into the $package executable (static loading), or not include
343 them at all.  Answer "none" to include no extensions.
344 Note that DynaLoader is always built and need not be mentioned here.
345
346 EOM
347         case "$dynamic_ext" in
348         '')
349                 : Exclude those listed in static_ext
350                 dflt=''
351                 for xxx in $avail_ext; do
352                         case " $static_ext " in
353                         *" $xxx "*) ;;
354                         *) dflt="$dflt $xxx" ;;
355                         esac
356                 done
357                 set X $dflt
358                 shift
359                 dflt="$*"
360                 ;;
361         *)      dflt="$dynamic_ext"
362                 # Perhaps we are reusing an old out-of-date config.sh.
363                 case "$hint" in
364                 previous)
365                         if test X"$dynamic_ext" != X"$avail_ext"; then
366                                 $cat <<EOM
367 NOTICE:  Your previous config.sh list may be incorrect.
368 The extensions now available to you are
369         ${avail_ext}
370 but the default list from your previous config.sh is
371         ${dynamic_ext}
372
373 EOM
374                         fi
375                         ;;
376                 esac
377                 ;;
378         esac
379         case "$dflt" in
380         '')     dflt=none;;
381         esac
382         rp="What extensions do you wish to load dynamically?"
383         . ./myread
384         case "$ans" in
385 ?X: Use ' ' so a subsequent Configure will preserve that value.
386         none) dynamic_ext=' ' ;;
387         *) dynamic_ext="$ans" ;;
388         esac
389
390         case "$static_ext" in
391         '')
392                 : Exclude those already listed in dynamic linking
393                 dflt=''
394                 for xxx in $avail_ext; do
395                         case " $dynamic_ext " in
396                         *" $xxx "*) ;;
397                         *) dflt="$dflt $xxx" ;;
398                         esac
399                 done
400                 set X $dflt
401                 shift
402                 dflt="$*"
403                 ;;
404         *)  dflt="$static_ext"
405                 ;;
406         esac
407
408         case "$dflt" in
409         '')     dflt=none;;
410         esac
411         rp="What extensions do you wish to load statically?"
412         . ./myread
413         case "$ans" in
414 ?X: Use ' ' so a subsequent Configure will preserve that value.
415         none) static_ext=' ' ;;
416         *) static_ext="$ans" ;;
417         esac
418         ;;
419 *)
420         $cat <<EOM
421 A number of extensions are supplied with $package.  Answer "none"
422 to include no extensions.
423 Note that DynaLoader is always built and need not be mentioned here.
424
425 EOM
426         case "$static_ext" in
427         '') dflt="$avail_ext" ;;
428         *)      dflt="$static_ext"
429                 # Perhaps we are reusing an old out-of-date config.sh.
430                 case "$hint" in
431                 previous)
432                         if test X"$static_ext" != X"$avail_ext"; then
433                                 $cat <<EOM
434 NOTICE:  Your previous config.sh list may be incorrect.
435 The extensions now available to you are
436         ${avail_ext}
437 but the default list from your previous config.sh is
438         ${static_ext}
439
440 EOM
441                         fi
442                         ;;
443                 esac
444                 ;;
445         esac
446         : Exclude those that are not xs extensions
447         case "$dflt" in
448         '')     dflt=none;;
449         esac
450         rp="What extensions do you wish to include?"
451         . ./myread
452         case "$ans" in
453 ?X: Use ' ' so a subsequent Configure will preserve that value.
454         none) static_ext=' ' ;;
455         *) static_ext="$ans" ;;
456         esac
457         ;;
458 esac
459 #
460 # Encode is a special case.  If we are building Encode as a static
461 # extension, we need to explicitly list its subextensions as well.
462 # For other nested extensions, this is handled automatically by
463 # the appropriate Makefile.PL.
464 case " $static_ext " in
465         *" Encode "*) # Add the subextensions of Encode
466         cd "$rsrc/cpan"
467         for xxx in `ls Encode/*/Makefile.PL|awk -F/ '{print $2}'`; do
468                 static_ext="$static_ext Encode/$xxx"
469                 known_extensions="$known_extensions Encode/$xxx"
470         done
471         cd "$tdir"
472         ;;
473 esac
474
475 set X $dynamic_ext $static_ext $nonxs_ext
476 shift
477 extensions="$*"
478
479 # Sanity check:  We require an extension suitable for use with
480 # AnyDBM_File, as well as Fcntl and IO.  (Failure to have these
481 # should show up as failures in the test suite, but it's helpful to
482 # catch them now.) The 'extensions' list is normally sorted
483 # alphabetically, so we need to accept either
484 #    DB_File ... Fcntl ... IO  ....
485 # or something like
486 #    Fcntl ... NDBM_File ... IO  ....
487 case " $extensions"  in
488 *"_File "*" Fcntl "*" IO "*) ;; # DB_File
489 *" Fcntl "*"_File "*" IO "*) ;; # GDBM_File
490 *" Fcntl "*" IO "*"_File "*) ;; # NDBM_File
491 *) echo "WARNING: Extensions DB_File or *DBM_File, Fcntl, and IO not configured." >&4
492    echo "WARNING: The Perl you are building will be quite crippled." >& 4
493    ;;
494 esac
495