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