This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
[perl #121585] Configure shouldn't write source tree
[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         DB_File|db_file)
154                 case "$i_db" in
155                 $define) avail_ext="$avail_ext $xxx" ;;
156                 esac
157                 ;;
158         GDBM_File|gdbm_fil)
159                 case "$i_gdbm" in
160                 $define) avail_ext="$avail_ext $xxx" ;;
161                 esac
162                 ;;
163         I18N/Langinfo|i18n_lan)
164                 case "$i_langinfo$d_nl_langinfo" in
165                 $define$define) avail_ext="$avail_ext $xxx" ;;
166                 esac
167                 ;;
168         IPC/SysV|ipc/sysv)
169                 : XXX Do we need a useipcsysv variable here
170                 case "${d_msg}${d_sem}${d_shm}" in
171                 *"${define}"*) avail_ext="$avail_ext $xxx" ;;
172                 esac
173                 ;;
174         NDBM_File|ndbm_fil)
175                 case "$d_ndbm" in
176                 $define)
177                     case "$osname-$use64bitint" in
178                     hpux-define)
179                         case "$libs" in
180                         *-lndbm*) avail_ext="$avail_ext $xxx" ;;
181                         esac
182                         ;;
183                     *) avail_ext="$avail_ext $xxx" ;;
184                     esac
185                     ;;
186                 esac
187                 ;;
188         ODBM_File|odbm_fil)
189                 case "${i_dbm}${i_rpcsvcdbm}" in
190                 *"${define}"*)
191                     case "$d_cplusplus" in
192                     define) ;; # delete as a function name will not work
193                     *)  case "$osname-$use64bitint" in
194                         hpux-define)
195                             case "$libs" in
196                             *-ldbm*) avail_ext="$avail_ext $xxx" ;;
197                             esac
198                             ;;
199                         *) avail_ext="$avail_ext $xxx" ;;
200                         esac
201                         ;;
202                     esac
203                     ;;
204                 esac
205                 ;;
206         Opcode|opcode)
207                 case "$useopcode" in
208                 true|define|y) avail_ext="$avail_ext $xxx" ;;
209                 esac
210                 ;;
211         POSIX|posix)
212                 case "$useposix" in
213                 true|define|y) avail_ext="$avail_ext $xxx" ;;
214                 esac
215                 ;;
216         Socket|socket)
217                 case "$d_socket" in
218                 true|$define|y) avail_ext="$avail_ext $xxx" ;;
219                 esac
220                 ;;
221         Sys/Syslog|sys/syslog)
222                 : XXX syslog requires socket
223                 case "$d_socket" in
224                 true|$define|y) avail_ext="$avail_ext $xxx" ;;
225                 esac
226                 ;;
227         Thread|thread)
228                 case "$usethreads" in
229                 true|$define|y)
230                         case "$use5005threads" in
231                         $define|true|[yY]*) avail_ext="$avail_ext $xxx" ;;
232                         esac
233                 esac
234                 ;;
235         threads|threads/shared)
236                 # threads and threads::shared are special cases.
237                 # To stop people from asking "Perl 5.8.0 was supposed
238                 # to have this new fancy threads implementation but my
239                 # perl doesn't have it" and from people trying to
240                 # (re)install the threads module using CPAN.pm and
241                 # CPAN.pm then offering to reinstall Perl 5.8.0,
242                 # the threads.pm and threads/shared.pm will always be
243                 # there, croaking informatively ("you need to rebuild
244                 # all of Perl with threads, sorry") when threads haven't
245                 # been compiled in.
246                 # --jhi
247                 avail_ext="$avail_ext $xxx"
248                 ;;
249         VMS*)
250                 ;;
251         Win32*)
252                 case "$osname" in
253                 cygwin) avail_ext="$avail_ext $xxx" ;;
254                 esac
255                 ;;
256         XS/APItest|xs/apitest)
257                 # This is just for testing.  Skip it unless we have dynamic loading.
258
259                 case "$usedl" in
260                 $define) avail_ext="$avail_ext $xxx" ;;
261                 esac
262                 ;;
263         XS/Typemap|xs/typemap)
264                 # This is just for testing.  Skip it unless we have dynamic loading.
265                 case "$usedl" in
266                 $define) avail_ext="$avail_ext $xxx" ;;
267                 esac
268                 ;;
269         *)      avail_ext="$avail_ext $xxx"
270                 ;;
271         esac
272 done
273
274 set X $avail_ext
275 shift
276 avail_ext="$*"
277
278 case "$onlyextensions" in
279 '') ;;
280 *)  keepextensions=''
281     echo "You have requested that only certain extensions be included..." >&4
282     for i in $onlyextensions; do
283         case " $avail_ext " in
284         *" $i "*)
285             echo "Keeping extension $i."
286             keepextensions="$keepextensions $i"
287             ;;
288         *) echo "Ignoring extension $i." ;;
289         esac
290     done
291     avail_ext="$keepextensions"
292     ;;
293 esac
294
295 case "$noextensions" in
296 '') ;;
297 *)  keepextensions=''
298     echo "You have requested that certain extensions be ignored..." >&4
299     for i in $avail_ext; do
300         case " $noextensions " in
301         *" $i "*) echo "Ignoring extension $i." ;;
302         *) echo "Keeping extension $i.";
303            keepextensions="$keepextensions $i"
304            ;;
305         esac
306     done
307     avail_ext="$keepextensions"
308     ;;
309 esac
310
311 : Now see which nonxs extensions are supported on this system.
312 : For now assume all are.
313 nonxs_ext=''
314 for xxx in $nonxs_extensions ; do
315         case "$xxx" in
316         VMS*)
317                 ;;
318         *)      nonxs_ext="$nonxs_ext $xxx"
319                 ;;
320         esac
321 done
322
323 set X $nonxs_ext
324 shift
325 nonxs_ext="$*"
326
327 case $usedl in
328 $define)
329         $cat <<EOM
330 A number of extensions are supplied with $package.  You may choose to
331 compile these extensions for dynamic loading (the default), compile
332 them into the $package executable (static loading), or not include
333 them at all.  Answer "none" to include no extensions.
334 Note that DynaLoader is always built and need not be mentioned here.
335
336 EOM
337         case "$dynamic_ext" in
338         '')
339                 : Exclude those listed in static_ext
340                 dflt=''
341                 for xxx in $avail_ext; do
342                         case " $static_ext " in
343                         *" $xxx "*) ;;
344                         *) dflt="$dflt $xxx" ;;
345                         esac
346                 done
347                 set X $dflt
348                 shift
349                 dflt="$*"
350                 ;;
351         *)      dflt="$dynamic_ext"
352                 # Perhaps we are reusing an old out-of-date config.sh.
353                 case "$hint" in
354                 previous)
355                         if test X"$dynamic_ext" != X"$avail_ext"; then
356                                 $cat <<EOM
357 NOTICE:  Your previous config.sh list may be incorrect.
358 The extensions now available to you are
359         ${avail_ext}
360 but the default list from your previous config.sh is
361         ${dynamic_ext}
362
363 EOM
364                         fi
365                         ;;
366                 esac
367                 ;;
368         esac
369         case "$dflt" in
370         '')     dflt=none;;
371         esac
372         rp="What extensions do you wish to load dynamically?"
373         . ./myread
374         case "$ans" in
375 ?X: Use ' ' so a subsequent Configure will preserve that value.
376         none) dynamic_ext=' ' ;;
377         *) dynamic_ext="$ans" ;;
378         esac
379
380         case "$static_ext" in
381         '')
382                 : Exclude those already listed in dynamic linking
383                 dflt=''
384                 for xxx in $avail_ext; do
385                         case " $dynamic_ext " in
386                         *" $xxx "*) ;;
387                         *) dflt="$dflt $xxx" ;;
388                         esac
389                 done
390                 set X $dflt
391                 shift
392                 dflt="$*"
393                 ;;
394         *)  dflt="$static_ext"
395                 ;;
396         esac
397
398         case "$dflt" in
399         '')     dflt=none;;
400         esac
401         rp="What extensions do you wish to load statically?"
402         . ./myread
403         case "$ans" in
404 ?X: Use ' ' so a subsequent Configure will preserve that value.
405         none) static_ext=' ' ;;
406         *) static_ext="$ans" ;;
407         esac
408         ;;
409 *)
410         $cat <<EOM
411 A number of extensions are supplied with $package.  Answer "none"
412 to include no extensions.
413 Note that DynaLoader is always built and need not be mentioned here.
414
415 EOM
416         case "$static_ext" in
417         '') dflt="$avail_ext" ;;
418         *)      dflt="$static_ext"
419                 # Perhaps we are reusing an old out-of-date config.sh.
420                 case "$hint" in
421                 previous)
422                         if test X"$static_ext" != X"$avail_ext"; then
423                                 $cat <<EOM
424 NOTICE:  Your previous config.sh list may be incorrect.
425 The extensions now available to you are
426         ${avail_ext}
427 but the default list from your previous config.sh is
428         ${static_ext}
429
430 EOM
431                         fi
432                         ;;
433                 esac
434                 ;;
435         esac
436         : Exclude those that are not xs extensions
437         case "$dflt" in
438         '')     dflt=none;;
439         esac
440         rp="What extensions do you wish to include?"
441         . ./myread
442         case "$ans" in
443 ?X: Use ' ' so a subsequent Configure will preserve that value.
444         none) static_ext=' ' ;;
445         *) static_ext="$ans" ;;
446         esac
447         ;;
448 esac
449 #
450 # Encode is a special case.  If we are building Encode as a static
451 # extension, we need to explicitly list its subextensions as well.
452 # For other nested extensions, this is handled automatically by
453 # the appropriate Makefile.PL.
454 case " $static_ext " in
455         *" Encode "*) # Add the subextensions of Encode
456         cd "$rsrc/cpan"
457         for xxx in `ls Encode/*/Makefile.PL|awk -F/ '{print $2}'`; do
458                 static_ext="$static_ext Encode/$xxx"
459                 known_extensions="$known_extensions Encode/$xxx"
460         done
461         cd "$tdir"
462         ;;
463 esac
464
465 set X $dynamic_ext $static_ext $nonxs_ext
466 shift
467 extensions="$*"
468
469 # Sanity check:  We require an extension suitable for use with
470 # AnyDBM_File, as well as Fcntl and IO.  (Failure to have these
471 # should show up as failures in the test suite, but it's helpful to
472 # catch them now.) The 'extensions' list is normally sorted
473 # alphabetically, so we need to accept either
474 #    DB_File ... Fcntl ... IO  ....
475 # or something like
476 #    Fcntl ... NDBM_File ... IO  ....
477 case " $extensions"  in
478 *"_File "*" Fcntl "*" IO "*) ;; # DB_File
479 *" Fcntl "*"_File "*" IO "*) ;; # GDBM_File
480 *" Fcntl "*" IO "*"_File "*) ;; # NDBM_File
481 *) echo "WARNING: Extensions DB_File or *DBM_File, Fcntl, and IO not configured." >&4
482    echo "WARNING: The Perl you are building will be quite crippled." >& 4
483    ;;
484 esac
485