bootstrap

#!/bin/bash
#
#******************************************************************************
# bootstrap (Seq66)
#------------------------------------------------------------------------------
##
# \file           bootstrap
# \library        Seq66
# \author         Chris Ahlstrom
# \date           2018-11-09
# \update         2024-11-23
# \version        $Revision$
# \license        $XPC_SUITE_GPL_LICENSE$
#
#     The above is modified by the following to remove even the mild GPL
#     restrictions:
#
#     Use this script in any manner whatsoever.  You don't even need to give
#     me any credit.  However, keep in mind the value of the GPL in keeping
#     software and its descendant modifications available to the community for
#     all time.  Runs the configure script by default.
#
#     This file provides the functionality we expect to find in an autogen.sh
#     script.  Also see contrib/scripts/reconf, which is less comprehensive
#     but more standard.
#
#     Also see the helper functions in contrib/scripts/strap_functions.
#
#------------------------------------------------------------------------------

#******************************************************************************
#  Provide a sane environment, just in case it is needed.
#------------------------------------------------------------------------------

LANG=C
export LANG
CYGWIN=binmode
export CYGWIN
export SEQ66_BOOTSTRAP_EDIT_DATE="2024-11-23"
export SEQ66_LIBRARY_API_VERSION="0.99"
export SEQ66_LIBRARY_VERSION="$SEQ66_LIBRARY_API_VERSION.15"

#******************************************************************************
#  Version info
#------------------------------------------------------------------------------

if [ "$1" == "--version" ] || [ "$1" == "-v" ] ; then
   echo "Seq66 version $SEQ66_LIBRARY_VERSION $SEQ66_BOOTSTRAP_EDIT_DATE"
   exit 0
fi

#******************************************************************************
#  Set up for local bootstrapping
#------------------------------------------------------------------------------

source contrib/scripts/strap_functions

if [ $? != 0 ] ; then
   echo "'source strap_functions' failed.  Must abort."
   exit 255
fi

checkdir libseq66

#******************************************************************************
#  Option settings
#------------------------------------------------------------------------------

DOAUTOCONF_ONLY="no"
DOBOOTSTRAP="yes"
DOCLEAN="no"
DOCONFIGURE="no"
DODEBUG="no"
DOFULLCLEAN="no"
DOJACK="yes"
DOMINGW="no"
DONSM="yes"
DOPORTMIDI="no"
DOPORTREFRESH="no"
DOPROFILING="no"
DORELEASE="yes"
DORTCLI="no"
DORTMIDI="no"
DOSTATIC="no"
DOTESTING="no"
DOVERSION="no"
CLANGSET=""
LOGFILENAME=""
M4DIR="m4"

#******************************************************************************
#  Default boostrap build when not using Windows/MSYS2. Note that MSYS2
#  autotools build support is still in progress.
#------------------------------------------------------------------------------

if [ "$MSYS2_PATH" == "" ] ; then
   echo "Assuming a Linux environment..."
   DORTMIDI="yes"
   DOJACK="yes"
   EXTRAFLAGS=""
else
   echo "Assuming an MSYS2 environment..."
   DOPORTMIDI="yes"
   DOCONFIGURE="yes"
   EXTRAFLAGS=" --enable-portmidi --disable-rtmidi"
fi

#******************************************************************************
#  Help
#------------------------------------------------------------------------------

if [ "$1" == "--help" ] ; then

   cat << E_O_F
Usage: ./bootstrap [options]    ($SEQ66_LIBRARY_VERSION-$SEQ66_BOOTSTRAP_EDIT_DATE)

'bootstrap' sets up GNU automake and libtool support for the Seq66 project
and creates the 'configure' script.  It can super-clean the project, removing
all generated files and directories.  It provides options to save trouble
passing long options to the configure script for some canned setups.

 --autoconf          Just create the autoconf/automake setup and exit.
 --clean             Delete the usual derived files from the project.
 --full-clean        Delete all derived and configure-related files.  The
                     bootstrap script will need to be run again.
 --debug, -ed        Configure for debugging and disable shared libraries for
                     easier debugging.  Also: --enable-debug=gdb
 --clang             Use the clang++ compiler when bootstrapping the
                     configuration.
 --release, -er      Configure for release.  Sets up a 'silent' build as well.
                     Equivalent to --enable-release; defaults to 'release'.
 --static            Do a static release build.
 --portmidi, -pm     Configure for qpseq66 (--enable-portmidi).
 --rtmidi, -rm       Configure for qseq66 (ALSA/JACK version, the default).
                     Implies --enable-rtmidi.  The official GUI is Qt 5.
 --port-refresh, -pr Enables the port-refresh feature for JACK.  Will be
                     the default once it works.
 --disable-jack, -dj Disables JACK support, enables rtmidi.
 --no-metadata       Disable JACK metadata support.
 --cli, -cli         Configure for seq66cli (command-line rtmidi version).
 --both              Build qseq66 and seq66cli in one pass.
 --no-nsm            Disable Non Session Manager support.  Saves some code.
 --profile, -prof    Enable profiling and debugging.
 --help              Show this help text.

There are other options too rare to document here. Read the bootstrap script.
The default (no options) bootstraps the project (e.g. runs 'autoheader'.)
Then one must run 'configure', which sets up for a normal release build.
A common option for 'bootstrap' is --enable-debug (-ed), which adds
--disable-shared and sets up the configure script for debugging without
needing "libtool --mode=execute gdb qseq66".  The most common command
sequence would be:

    $ ./bootstrap -er
    $ make &> make.log

E_O_F
   exit 1
fi

#******************************************************************************
#  Brute-force options loop
#------------------------------------------------------------------------------

if [ $# -ge 1 ] ; then

   while [ "$1" != "" ] ; do

      case "$1" in

         --autoconf)

            DOAUTOCONF_ONLY="yes"
            DOCONFIGURE="no"
            ;;

         --no-bootstrap | -nb)
            DOBOOTSTRAP="no"
            DOCONFIGURE="no"
            ;;

         --clean | clean)
            DOBOOTSTRAP="no"
            DOCONFIGURE="no"
            DOCLEAN="yes"
            ;;

         --full-clean | --super-clean)
            DOBOOTSTRAP="no"
            DOCONFIGURE="no"
            DOFULLCLEAN="yes"
            DOCLEAN="yes"
            ;;

         --debug | -ed | --enable-debug)
            DODEBUG="yes"
            DOCONFIGURE="yes"
            EXTRAFLAGS+=" --disable-shared --enable-static"
            ;;

         --clang)
            DOCONFIGURE="yes"
            CLANGSET="CC=clang CXX=clang++"
            ;;

         --profile | -prof | --prof)
            DODEBUG="yes"
            DOPROFILING="yes"
            DOCONFIGURE="yes"
            EXTRAFLAGS+=" --enable-profile --disable-shared"
            ;;

         --release | -er | --enable-release)
            DORELEASE="yes"
            DOCONFIGURE="yes"
            ;;

         --static)
            DORELEASE="yes"
            DOCONFIGURE="yes"
            EXTRAFLAGS+=" --disable-shared --enable-static"
            ;;

         --no-nsm)
            DONSM="no"
            DOCONFIGURE="yes"
            EXTRAFLAGS+=" --disable-nsm"
            ;;

         --portmidi | -pm | --pm)
            DOPORTMIDI="yes"
            DOCONFIGURE="yes"
            EXTRAFLAGS+=" --enable-portmidi --disable-rtmidi"
            ;;

         --rtmidi | -rm | --rm)
            DORTMIDI="yes"
            DOCONFIGURE="yes"
            EXTRAFLAGS+=" --enable-rtmidi"
            ;;

         --port-refresh | -pr | --pr)
            DOPORTREFRESH="yes"
            DOCONFIGURE="yes"
            EXTRAFLAGS+=" --enable-port-refresh"
            ;;

         --disable-jack | -dj)
            DOJACK="no"
            DOCONFIGURE="yes"
            EXTRAFLAGS+=" --disable-jack --enable-rtmidi"
            ;;

         --no-metadata | --disable-jack-metadata)
            DOCONFIGURE="yes"
            EXTRAFLAGS+=" --disable-jack-metadata"
            ;;

         --cli | -cli)
            DORTCLI="yes"
            DORELEASE="yes"
            DOCONFIGURE="yes"
            EXTRAFLAGS+=" --enable-cli"
            ;;

         --both | -both)
            DORTCLI="yes"
            DORELEASE="yes"
            DOCONFIGURE="yes"
            EXTRAFLAGS+=" --enable-rtmidi --enable-both"
            ;;

         --testing | -stt)
            DOTESTING="yes"
            DOCONFIGURE="yes"
            EXTRAFLAGS+=" --enable-testing"
            ;;

         --version)
            DOVERSION="yes"
            DOBOOTSTRAP="no"
            ;;

         *)
            echo "? Unsupported bootstrap option $1; --help for more information"
            exit $EXIT_ERROR_NO_SUCH_OPTION
            ;;

      esac
      shift
   done
fi

if [ "$EXTRAFLAGS" == "" ] ; then
   EXTRAFLAGS="--enable-rtmidi"
fi

echo "EXTRAFLAGS = $EXTRAFLAGS"

#******************************************************************************
#  Implement the clean option.
#------------------------------------------------------------------------------
#
#     This goes well beyond "make clean" and "make distclean".  It cleans
#     out /everything/ that gets created by bootstrapping and building the
#     library and test application.
#
#------------------------------------------------------------------------------

if [ $DOCLEAN == "yes" ] ; then
   make clean 
   clean_gnufiles
   clean_tempfiles
   clean_m4
   clean_qt5files
   rm -f include/seq66-config.h
   echo "   Config, GNU, temp, m4, and Qt 5 generated files removed."
fi

if [ $DOFULLCLEAN == "yes" ] ; then

   rm -rf config
   rm -f include/config.h
   rm -f include/stamp-h1
   rm -f include/seq66-config.h
   rm -rf po
   clean_debfiles
   echo "   All junk files removed."

fi

if [ $DOBOOTSTRAP == "yes" ] ; then

#************************************************************************
#  Set up GNU Autotools
#------------------------------------------------------------------------

   AUTOMAKE_BAD=no
   INSTALL_BAD=no
   ACVERSION=
   ACLOCAL=aclocal${ACVERSION}
   AUTOCONF=autoconf
   AUTOHEADER=autoheader
   AUTOMAKE=automake
   LIBTOOLIZE=libtoolize

# Exit if a simple command exits with a non-zero status.

   set -e

# After expanding a simple command, display PS4 and the command with its
# expanded arguments.  This setting makes any error messages too
# difficult to read:
#
# set -x

# Check Autoconf version and perform clean ups if all is well.

   if [ -x `which autoconf` ] ; then

      AC_VER=`autoconf --version | head -1 | sed 's/^[^0-9]*//'`
      AC_VER_MAJOR=`echo $AC_VER | cut -f1 -d'.'`
      AC_VER_MINOR=`echo $AC_VER | cut -f2 -d'.' | sed 's/[^0-9]*$//'`

      if [ "$AC_VER_MAJOR" -lt "2" ] ; then

         echo
         echo "Autoconf 2.13 or greater may be needed to build configure."
         echo "Edit the bootstrap file to ignore this test, if desired."
         echo
         exit $EXIT_ERROR_AUTOCONF_VERSION

      fi

      if [ "$AC_VER_MINOR" -lt "13" ] ; then

         echo
         echo "Autoconf 2.13 or greater may be needed to build configure."
         echo "Edit the bootstrap file to ignore this test, if desired."
         echo
         exit $EXIT_ERROR_AUTOCONF_VERSION_2

      fi

      if [ "$AC_VER_MINOR" -lt "50" ] ; then

         if [ -e configure.ac ] ; then
            if [ ! -e configure.in ] ; then
               ln -s configure.ac configure.in
            fi
         fi
         echo "Some warnings about cross-compiling are normal."

      else

         rm -f configure.in
         if [  $DOCONFIGURE == "yes" ] ; then
            if [ -x configure ] ; then
               echo The Seq66 configure script already exists.  Replacing it.
            fi
         fi
      fi

   else

      cat << E_O_F

   The GNU autoconf application was not found.  This project requires GNU
   autoconf (and automake, and ac-autoconf-archive) in order to
   bootstrap itself.

E_O_F
      exit $EXIT_ERROR_AUTOCONF_VERSION_3
   fi

# Check for automake.

   amvers="none"
   if automake-1.8 --version >/dev/null 2>&1; then
      amvers="-1.8"

     # If we also have 1.6 (>> 1.6.1), use it instead because it is faster

      if automake-1.6 --version >/dev/null 2>&1; then
         if expr "`automake-1.6 --version | sed -e '1s/[^0-9]*//' -e q`" ">" "1.6.1" > /dev/null 2>&1; then
            amvers="-1.6"
         fi
      fi
   elif automake-1.7 --version >/dev/null 2>&1; then
      amvers="-1.7"

      # If we also have 1.6 (>> 1.6.1), use it instead because it is faster

      if automake-1.6 --version >/dev/null 2>&1; then
         if expr "`automake-1.6 --version | sed -e '1s/[^0-9]*//' -e q`" ">" "1.6.1" > /dev/null 2>&1; then
            amvers="-1.6"
         fi
      fi

   elif automake-1.6 --version >/dev/null 2>&1; then

      amvers="-1.6"
      if expr "`automake-1.6 --version | sed -e '1s/[^0-9]*//' -e q`" "<=" "1.6.1" > /dev/null 2>&1; then
         AUTOMAKE_BAD=yes
      fi

   elif automake-1.5 --version >/dev/null 2>&1; then

      INSTALL_BAD=yes
      amvers="-1.5"

   elif automake --version > /dev/null 2>&1; then

      amvers=""
      case "`automake --version | sed -e '1s/[^0-9]*//' -e q`" in
         0|0.*|1|1.[01234]|1.[01234][-.]*)
            amvers="none" ;;
         1.5|1.5.*)
            INSTALL_BAD=yes ;;
         1.6|1.6.0|1.6.1)
            AUTOMAKE_BAD=yes ;;
      esac
   fi

#******************************************************************************
# Check for the installation of the GNU gettext facility.
# Autopoint is available from 0.11.3, but we need at least 0.11.5
#------------------------------------------------------------------------------

# Check for pkg-config

   if pkg-config --version >/dev/null 2>&1; then
      PKGCONFIG=yes
   else
      PKGCONFIG=no
   fi

#************************************************************************
# Create config and m4 directories.  Note that they might be empty for
# this project.  Also create an include directory, mainly for "config.h"
# stuff.
#------------------------------------------------------------------------

   mkdir -p aux-files
   mkdir -p config
   mkdir -p m4
   mkdir -p po
   mkdir -p include

#************************************************************************
# Call a number of "auto" programs in the strict order shown below.  Note:
# Earlier versions of auto-tools don't ignore duplicate definitions of
# macros.  (The system normally provides m4 macros in /usr/share/aclocal,
# but the project also provides them in the project's m4 directory.)
#------------------------------------------------------------------------

# We still need to make aux-files/config.rpath and some other files
# available, since they are listed in configure.ac, and not provided by
# autoconf:

   cp contrib/config.rpath aux-files
   run_cmd ${ACLOCAL} -I ${M4DIR} --install
   run_cmd ${AUTOCONF}
   run_cmd ${AUTOHEADER}

#  The LT_INIT macro of libtool 2.0 (formerly called AC_PROG_LIBTOOL)
#  would do this, but Debian ships with version 1.5 libtool, so we have
#  to do things the old-fashioned way.

   run_cmd ${LIBTOOLIZE} --automake --force --copy
   run_cmd ${AUTOMAKE} --foreign --add-missing --copy

# Automake seems to need this one, but doesn't provide it!

   cp contrib/mkinstalldirs-1.10 aux-files/mkinstalldirs

   if [ $DOAUTOCONF_ONLY == "yes" ] ; then
      echo "Autoconf is set up, exiting..."
      exit 0
   fi

# At this point, remove files which always need to be regenerated.
# Right now, this is done with the --clean option.

   case "$PKGCONFIG" in
     yes) ;;
     no) cat << E_O_F

   =============================================================================
   NOTE: The "pkg-config" utility is not installed on your system; detection of
      the gtk-2.0 and GNOME 2.0 libraries will not be reliable.
E_O_F
     ;;

   esac

   case "$AUTOMAKE_BAD" in
     no) ;;
     yes) cat << E_O_F

   =============================================================================
   NOTE: Your version of automake has a bug which prevents proper plugin
      compilation. Either compile Seq66 with the --disable-plugins flag, or
      use a version of automake newer than 1.6.1 (1.6.2 is OK, and so are
      the 1.5 series).
E_O_F
     ;;

   esac

   case "$INSTALL_BAD" in
     no) ;;
     yes) cat << E_O_F

   =============================================================================
   NOTE: Your version of automake has a bug which prevents proper installation.
      Do not use "make install" with this version of automake, or use a
      version of automake newer than 1.5 (such as 1.6 or 1.7).
E_O_F
     ;;

   esac

   if [ -x /usr/bin/dot ] ; then
      echo "Graphviz package found, can build diagrams in Doxygen."
   else
      echo "! To build the documentation, you need to install graphviz."
   fi

   if [ -x /usr/bin/doxygen ] ; then
      echo "Doxygen package found, can build the reference manual."
   else
      echo "! To build the documentation, you need to install doxygen."
   fi

   echo "Bootstrap complete at `date`" >> bootstrap.stamp

#************************************************************************
# --configure
#------------------------------------------------------------------------

   if [ "$DOBOOTSTRAP" == "yes" ] ; then

      echo "Bootstrapping enabled...."

      if [ "$DOCONFIGURE" == "yes" ] ; then

         if [ "$DODEBUG" == "yes" ] ; then

            echo "Running '$CLANGSET ./configure --enable-debug=gdb $EXTRAFLAGS'"
            env $CLANGSET ./configure --enable-debug=gdb $EXTRAFLAGS

         elif [ "$DORELEASE" == "yes" ] ; then

            echo "Running '$CLANGSET ./configure --enable-silent-rules $EXTRAFLAGS'"
            env $CLANGSET ./configure --enable-silent-rules $EXTRAFLAGS
            echo "Running 'make V=1' will turn on full command output."

         fi

      else

         cat << E_O_F

Run './configure' to configure Seq66 for compilation, or
'./configure --help' for configuration options.  Useful options:

      --enable-debug=gdb --enable-calls --disable-shared --enable-silent-rules
      --enable-rtmidi (default) --enable-cli (no GUI) --enable-portmidi
      --enable-both (both Qt and CLI versions)

E_O_F
      fi
   fi

fi

#******************************************************************************
# bootstrap (Seq66)
#------------------------------------------------------------------------------
# vim: ts=3 sw=3 wm=4 et ft=sh
#------------------------------------------------------------------------------