This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Allow enabling -pedantic(-errors) (with -std=c89) for the core.
[perl5.git] / cflags.SH
index 8a1ba82..83fc3f8 100755 (executable)
--- a/cflags.SH
+++ b/cflags.SH
@@ -1,4 +1,29 @@
-case $CONFIG in
+#!/bin/sh
+
+# Generate the cflags script, which is used to determine what cflags
+# to pass to the compiler for compiling the core perl.
+#
+# This does NOT affect the XS compilation (ext, dist, cpan)
+# since that uses %Config values directly.
+#
+# For example, since -Wall adds -Wunused-*, a bare -Wall (without
+# amending that with -Wno-unused-..., or with the PERL_UNUSED_...)
+# would be too much for XS code because there are too many generated
+# but often unused things.
+#
+# We create a temporary test C program and repeatedly compile it with
+# various candidate flags, and from the compiler output, determine what
+# flags are supported.
+#
+# From this we initialise the following variables in the cflags script:
+#
+#   $myccflags (possibly edited version of $Config{ccflags})
+#   $warn
+#   $stdflags
+#   $extra
+#   $_exe
+
+case $PERL_CONFIG_SH in
 '')
        if test -f config.sh; then TOP=.;
        elif test -f ../config.sh; then TOP=..;
@@ -11,24 +36,347 @@ case $CONFIG in
        . $TOP/config.sh
        ;;
 esac
-: This forces SH files to create target in same directory as SH file.
-: This is so that make depend always knows where to find SH derivatives.
+# This forces SH files to create target in same directory as SH file.
+# This is so that make depend always knows where to find SH derivatives.
 case "$0" in
 */*) cd `expr X$0 : 'X\(.*\)/'` ;;
 esac
+
+if test -f config_h.SH -a ! -f config.h; then
+    . ./config_h.SH
+    CONFIG_H=already-done
+fi
+
+warn=''
+
+# Add -Wall for the core modules iff gcc and not already -Wall
+case "$gccversion" in
+'') ;;
+Intel*) ;; # The Intel C++ plays gcc on TV but is not really it.
+*)  case "$ccflags" in
+    *-Wall*) ;;
+    *) warn="$warn -Wall" ;;
+    esac
+    ;;
+esac
+
+# Create a test source file for testing what options can be fed to
+# gcc in this system; include a selection of most common and commonly
+# hairy include files.
+
+cat >_cflags.c <<__EOT__
+#include "EXTERN.h"
+#include "perl.h"
+/* The stdio.h, errno.h, and setjmp.h should be there in any ANSI C89. */
+#include <stdio.h>
+#include <errno.h>
+#include <setjmp.h>
+/* Just in case the inclusion of perl.h did not
+ * pull in enough system headers, let's try again. */
+#ifdef I_STDLIB
+#include <stdlib.h>
+#endif
+#ifdef I_STDDEF
+#include <stddef.h>
+#endif
+#ifdef I_STDARG
+#include <stdarg.h>
+#endif
+#ifdef I_LIMITS
+#include <limits.h>
+#endif
+#ifdef I_DIRENT
+#include <dirent.h>
+#endif
+#ifdef I_UNISTD
+#include <unistd.h>
+#endif
+#ifdef I_SYS_TYPES
+#include <sys/types.h>
+#endif
+#ifdef I_SYS_PARAM
+#include <sys/param.h>
+#endif
+#ifdef I_SYS_RESOURCE
+#include <sys/resource.h>
+#endif
+#ifdef I_SYS_SELECT
+#include <sys/select.h>
+#endif
+#if defined(HAS_SOCKET) && !defined(VMS) && !defined(WIN32) /* See perl.h. */
+#include <sys/socket.h>
+#endif
+#ifdef I_SYS_STAT
+#include <sys/stat.h>
+#endif
+#ifdef I_SYS_TIME
+#include <sys/time.h>
+#endif
+#ifdef I_SYS_TIMES
+#include <sys/times.h>
+#endif
+#ifdef I_SYS_WAIT
+#include <sys/wait.h>
+#endif
+/* The gcc -ansi can cause a lot of noise in Solaris because of:
+ /usr/include/sys/resource.h:148: warning: 'struct rlimit64' declared inside parameter list
+ */
+int main(int argc, char *argv[]) {
+
+/* Add here test code found to be problematic in some gcc platform. */
+
+/* Off_t/off_t is a struct in Solaris with largefiles, and with gcc -ansi
+ * that struct cannot be compared in some gcc releases with a flat
+ * integer, such as a STRLEN. */
+
+  IV iv;
+  Off_t t0a = 2;
+  STRLEN t0b = 3;
+  int t0c = (STRLEN)t0a == t0b;
+
+  printf("%s: %d\n", argv[0], argc);
+
+/* In FreeBSD 6.2 (and probably other releases too), with -Duse64bitint,
+   perl will use atoll(3).  However, that declaration is hidden in <stdlib.h>
+   if we force the compiler to use -std=c89 mode.
+*/
+  iv = Atol("42");
+
+  return (!t0c && (iv == 42)) ? 0 : -1; /* Try to avoid 'unused' warnings. */
+}
+__EOT__
+
+stdflags=''
+
+# Further gcc warning options.  Build up a list of options that work.
+# Note that some problems may only show up with combinations of options,
+# e.g. a warning might show up only with -Wall -ansi, not with either
+# one individually.
+# TODO:  Ponder whether to migrate this back to Configure so hints files can
+# tweak it.  Also, be paranoid about whether results we've deduced in Configure
+# (especially about things like long long, which are not in C89) will still be
+# valid if we now add flags like -std=c89.
+
+pedantic=''
+case "$gccansipedantic" in
+define) pedantic='-pedantic' ;;
+esac
+
+case "$gccversion" in
+'') ;;
+[12]*) ;; # gcc versions 1 (gasp!) and 2 are not good for this.
+Intel*) ;; # # Is that you, Intel C++?
+#
+# NOTE 1: the -std=c89 without -pedantic is a bit pointless.
+# Just -std=c89 means "if there is room for interpretation,
+# interpret the C89 way."  It does NOT mean "strict C89" on its own.
+# You need to add the -pedantic for that.  To do this with Configure,
+# do -Dgccansipedantic (note that the -ansi is included in any case,
+# the option is a bit oddly named, for historical reasons.)
+#
+# NOTE 2: -pedantic necessitates adding a couple of flags:
+# * -PERL_GCC_PEDANTIC so that the perl code can adapt: there's nothing
+#   added by gcc itself to indicate pedanticness.
+# * -Wno-overlength-strings under -DDEBUGGING because quite many of
+#   the LEAVE_with_name() and assert() calls generate string literals
+#   longer then the ANSI minimum of 509 bytes.
+#
+# NOTE 3: the relative order of these options matters:
+# -Wextra before -W, and -pedantic* before -Werror=d-a-s.
+#
+*)  for opt in -ansi -std=c89 $pedantic \
+               -Werror=declaration-after-statement \
+               -Wextra -W \
+               -Wc++-compat -Wwrite-strings
+    do
+       case " $ccflags " in
+       *" $opt "*) ;; # Skip if already there.
+       *) rm -f _cflags$_exe
+         flags="-DPERL_NO_INLINE_FUNCTIONS $ccflags $warn $stdflags $opt"
+         case "$opt" in
+         *-pedantic*) flags="$flags -DPERL_GCC_PEDANTIC" ;;
+         esac
+          # echo "opt = $opt, flags = $flags"
+          cmd="$cc $flags _cflags.c -o _cflags$_exe"
+          out="`$cmd 2>&1`"
+          # echo "$cmd --> $out"
+          case "$out" in
+          *"unrecognized"*) ;;
+          *"unknown"*) ;;
+          *"implicit declaration"*) ;; # Was something useful hidden?
+          *"Invalid"*) ;;
+          *"is valid for C"*) ;;
+          *) if test -x _cflags$_exe
+             then
+               case "$opt" in
+               -std*)
+                 echo "cflags.SH: Adding $opt."
+                 stdflags="$stdflags $opt"
+                 ;;
+               *) case "$opt" in
+                  -W)
+                    # -Wextra is the modern form of -W, so add
+                    # -W only if -Wextra is not there already.
+                    case " $warn " in
+                    *-Wextra*) ;;
+                    *)
+                      echo "cflags.SH: Adding $opt."
+                      warn="$warn $opt"
+                      ;;
+                    esac
+                    ;;
+                 -Werror=declaration-after-statement)
+                    # -pedantic* (with -std=c89) covers -Werror=d-a-s.
+                    case "$stdflags$warn" in
+                    *-std=c89*-pedantic*|*-pedantic*-std=c89*) ;;
+                    *)
+                      echo "cflags.SH: Adding $opt."
+                      warn="$warn $opt"
+                      ;;
+                    esac
+                   ;;
+                  *)
+                     echo "cflags.SH: Adding $opt."
+                     warn="$warn $opt"
+                     ;;
+                  esac
+               esac
+             fi
+             ;;
+          esac
+          ;;
+       esac
+       case "$ccflags$warn" in
+       *-pedantic*)
+         overlength=''
+         case "$ccflags$optimize" in
+         *-DDEBUGGING*) overlength='-Wno-overlength-strings' ;;
+         esac
+         for opt2 in -DPERL_GCC_PEDANTIC $overlength
+         do
+          case "$ccflags$warn" in
+          *"$opt2"*) ;;
+          *) echo "cflags.SH: Adding $opt2 because of -pedantic."
+             warn="$warn $opt2" ;;
+           esac
+         done
+         ;;
+       esac
+    done
+    ;;
+esac
+rm -f _cflags.c _cflags$_exe
+
+case "$gccversion" in
+'') ;;
+*)
+  case "$warn$ccflags" in
+  *-pedantic*)
+    # If we have -Duse64bitint (or equivalent) in effect and the quadtype
+    # has become 'long long', gcc -pedantic* becomes unbearable
+    # (moreso when combined with -Wall) because long long and LL and %lld|%Ld
+    # become warn-worthy.  So let's drop the -pedantic in that case.
+    #
+    # Similarly, since 'long long' isn't part of C89, FreeBSD 6.2 headers
+    # don't declare atoll() under -std=c89, but we need it.  In general,
+    # insisting on -std=c89 is inconsistent with insisting on using
+    # 'long long'. So drop -std=c89 and -ansi as well if we're using
+    # 'long long' as our main integral type.
+    #
+    # usedtrace (DTrace) uses unportable features (dollars in identifiers,
+    # and gcc statement expressions), it is just easier to turn off pedantic.
+    remove=''
+    case "$quadtype:$ivtype:$sPRId64:$usedtrace" in
+    *"long long"*|*lld*|*Ld*) remove='long long' ;;
+    *) case "$usedtrace" in
+       define) remove='usedtrace' ;;
+       esac
+       ;;
+    esac
+    case "$remove" in
+    '') ;;
+    *) echo "cflags.SH: Removing -pedantic*, -std=c89, and -ansi because of $remove."
+      ccflags=`echo $ccflags|sed -e 's/-pedantic-errors/ /' -e 's/-pedantic/ /' -e 's/-std=c89/ /' -e 's/-ansi/ /' -e 's/-DPERL_GCC_PEDANTIC/ /'`
+      warn=`echo $warn|sed -e 's/-pedantic-errors/ /' -e 's/-pedantic/ /' -e 's/-ansi/ /' -e 's/-DPERL_GCC_PEDANTIC/ /'`
+      stdflags=`echo $stdflags|sed -e 's/-std=c89/ /'`
+      ;;
+    esac
+    ;;
+  esac
+  ;;
+esac
+
+case "$cc" in
+*g++*)
+  # Extra paranoia in case people have bad canned ccflags:
+  # bad in the sense that the flags are accepted by g++,
+  # but then whined about.
+  #
+  # -Werror=d-a-s option is valid for g++, by definition,
+  # but we remove it just for cleanliness and shorter command lines.
+  for f in -Wdeclaration-after-statement \
+               -Werror=declaration-after-statement \
+               -Wc++-compat \
+               -std=c89
+  do
+    case "$ccflags$warn" in
+    *"$f"*)
+      echo "cflags.SH: Removing $f because of g++."
+      ccflags=`echo $ccflags|sed 's/$f/ /'`
+      warn=`echo $warn|sed 's/$f/ /'`
+      ;;
+    esac
+  done
+  ;;
+esac
+
+for f in -Wdeclaration-after-statement -Werror=declaration-after-statement
+do
+  case "$cppflags" in
+  *"$f"*)
+    echo "cflags.SH: Removing $f from cppflags."
+    cppflags=`echo $cppflags|sed 's/$f/ /'` ;;
+  esac
+done
+
+echo "cflags.SH: cc       = $cc"
+echo "cflags.SH: ccflags  = $ccflags"
+echo "cflags.SH: stdflags = $stdflags"
+echo "cflags.SH: optimize = $optimize"
+echo "cflags.SH: warn     = $warn"
+
+# Code to set any extra flags here.
+extra=''
+
 echo "Extracting cflags (with variable substitutions)"
-: This section of the file will have variable substitutions done on it.
-: Move anything that needs config subs from !NO!SUBS! section to !GROK!THIS!.
-: Protect any dollar signs and backticks that you do not want interpreted
-: by putting a backslash in front.  You may delete these comments.
+# This section of the file will have variable substitutions done on it.
+# Move anything that needs config subs from !NO!SUBS! section to !GROK!THIS!.
+# Protect any dollar signs and backticks that you do not want interpreted
+# by putting a backslash in front.  You may delete these comments.
 rm -f cflags
 $spitshell >cflags <<!GROK!THIS!
 $startsh
+
+# !!!!!!!   DO NOT EDIT THIS FILE   !!!!!!!
+
+# This file is generated by cflags.SH
+
+# Used to restore possible edits by cflags.SH.
+myccflags="$ccflags"
+# Extra warnings, used e.g. for gcc.
+warn="$warn"
+# Extra standardness.
+stdflags="$stdflags"
+# Extra extra.
+extra="$extra"
+# what do executables look like?
+_exe="$_exe"
+
 !GROK!THIS!
 
-: In the following dollars and backticks do not need the extra backslash.
+# In the following dollars and backticks do not need the extra backslash.
 $spitshell >>cflags <<'!NO!SUBS!'
-case $CONFIG in
+case $PERL_CONFIG_SH in
 '')
        if test -f config.sh; then TOP=.;
        elif test -f ../config.sh; then TOP=..;
@@ -39,33 +387,30 @@ case $CONFIG in
                echo "Can't find config.sh."; exit 1
        fi
        . $TOP/config.sh
+        ccflags="$myccflags"  # Restore possible edits by cflags.SH.
        ;;
 esac
 
-perltype=''
-optdebug=''    # ensure -g used if building a -DDEBUGGING libperl
-case $# in
-2) case $1 in
-    *perl.*)    perltype='';;
-    *perld.*)   perltype='-DDEBUGGING'; optdebug='-g' ;;
-    *perle.*)   perltype='-DEMBED';;
-    *perlde.*)  perltype='-DDEBUGGING -DEMBED'; optdebug='-g' ;;
-    *perlm.*)   perltype='-DEMBED -DMULTIPLICITY';;
-    *perldm.*)  perltype='-DDEBUGGING -DEMBED -DMULTIPLICITY'; optdebug='-g' ;;
-    esac
-    shift ;;
-esac
+# syntax: cflags [optimize=XXX] [file[.suffix]] ...
+#   displays the proposed compiler command line for each 'file'
+#
+#   with no file, dispalys it for all *.c files.
+#   The optimise=XXX arg (if present) is evalled, setting the default
+#   value of the $optimise variable, which is output on the command line
+#   (but which may be overridden for specific files below)
 
-also=': '
-case $# in
-1) also='echo 1>&2 "     CCCMD = "'
+case "X$1" in
+Xoptimize=*|X"optimize=*")
+       eval "$1"
+       shift
+       ;;
 esac
 
 case $# in
 0) set *.c; echo "The current C flags are:" ;;
 esac
 
-set `echo "$* " | sed -e 's/\.[oc] / /g' -e 's/\.obj / /g'`
+set `echo "$* " | sed -e 's/\.[oc] / /g' -e 's/\.obj / /g' -e "s/\\$obj_ext / /g"`
 
 for file do
 
@@ -74,62 +419,39 @@ for file do
     *) echo $n "    $file.c    $c" ;;
     esac
 
-    : allow variables like toke_cflags to be evaluated
+    # allow variables like toke_cflags to be evaluated
 
-    eval 'eval ${'"${file}_cflags"'-""}'
+    if echo $file | grep -v / >/dev/null
+    then
+      eval 'eval ${'"${file}_cflags"'-""}'
+    fi
 
-    : or customize here
+    # or customize here
 
     case "$file" in
-    DB_File) ;;
-    GDBM_File) ;;
-    NDBM_File) ;;
-    ODBM_File) ;;
-    POSIX) ;;
-    SDBM_File) ;;
-    av) ;;
-    byterun) ;;
-    deb) ;;
-    dl) ;;
-    doio) ;;
-    doop) ;;
-    dump) ;;
-    gv) ;;
-    hv) ;;
-    main) ;;
-    malloc) ;;
-    mg) ;;
-    miniperlmain) ;;
-    op) ;;
-    perl) ;;
-    perlmain) ;;
-    perly) ;;
-    pp) ;;
-    pp_ctl) ;;
-    pp_hot) ;;
-    pp_sys) ;;
-    regcomp) ;;
-    regexec) ;;
-    run) ;;
-    scope) ;;
-    sv) ;;
-    taint) ;;
-    toke) ;;
-    usersub) ;;
-    util) ;;
     *) ;;
-    esac
 
-       if test "X$optdebug" != "X"; then
-               optimize="$optdebug"
-       fi
+    # Customization examples follow.
+    #
+    # The examples are intentionally unreachable as the '*)' case above always
+    # matches. To use them, move before the '*)' and edit as appropriate.
+    # It is not a good idea to set ccflags to an absolute value here, as it
+    # often contains general -D defines which are needed for correct
+    # compilation. It is better to edit ccflags as shown, using interpolation
+    # to add flags, or sed to remove flags.
+
+    av) ccflags=`echo $ccflags | sed -e s/-pipe//` ;;
+    deb) ccflags="$ccflags -fno-jump-tables" ;;
+    hv) warn=`echo $warn | sed -e s/-Wextra//` ;;
+    toke) optimize=-O0 ;;
+    esac
 
-    : Can we perhaps use $ansi2knr here
-    echo "$cc -c -DPERL_CORE $ccflags $optimize $perltype $large $split"
-    eval "$also "'"$cc -DPERL_CORE -c $ccflags $optimize $perltype $large $split"'
+    # Can we perhaps use $ansi2knr here
+    echo "$cc -c -DPERL_CORE $ccflags $stdflags $optimize $warn $extra"
 
     . $TOP/config.sh
 
+    # end per file behaviour
 done
 !NO!SUBS!
 chmod 755 cflags