build_cmake_app.sh

#!/bin/bash

#
# Copyright (c) 2023, 219 Design, LLC
# See LICENSE.txt
#
# https://www.219design.com
# Software | Electrical | Mechanical | Product Design
#

set -Eeuxo pipefail # https://vaneyckt.io/posts/safer_bash_scripts_with_set_euxo_pipefail/
IFS=$'\n\t'

DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
cd $DIR  # enter this script's directory. (in case called from root of repository)
source "${DIR}/tools/ci/rootdirhelper.bash"
source "${CUR_GUICODE_ROOT}/tools/ci/utils.bash" # for terminal colorization

if [[ -n ${UTILS_WE_ARE_RUNNING_IN_CI-} ]]; then
  # Some workflows on github build multiple times with different flags.
  # Therefore, when under CI, we always build from zero. Remove any prior artifacts:
  rm -rf cbuild
fi

cmake --version # print version to CI logs.

file /usr/bin/c++ || true # cmake seems to choose `c++`, so print what it's linked to.
file /etc/alternatives/c++ || true
c++ --version || true

MYAPP_JOBS="-j$(nproc)"

if [[ -n ${UTILS_WE_ARE_RUNNING_IN_CI-} ]];
# The '-' hyphen above tests without angering the 'set -u' about unbound variables
then
  # Some projects will want to change this to speed up CI.
  # The rationale for -j1 in CI in our case is so that CI logs are more deterministic,
  # more human-readable (less interleaving of compiler invocations), and more diffable.
  MYAPP_JOBS="-j1"
fi

if [[ "$OSTYPE" == "cygwin" || "$OSTYPE" == "msys" ]]; then
  if [[ -z ${VCToolsInstallDir-} ]]; then
    echo "WHOOPS. vcvars64 (or vcvarsall) was not called yet."
    echo "You MUST start a VISUAL STUDIO command prompt. (Then start git-bash from within it.)"
    echo "Read the above and try again."
    exit 1
  fi

  makecmd=nmake
  MYAPP_JOBS=""
  MYAPP_EXTRA_CONF=( "-G" "NMake Makefiles" )

  MSVCPATHFORBUILDING=$(cygpath -u "${VCToolsInstallDir}/bin/HOSTx64/x64")
  export PATH="${MSVCPATHFORBUILDING}:$PATH" # make sure MSVC link.exe is found (not bash/unix 'link' tool)
else
  makecmd=make
  MYAPP_EXTRA_CONF=()
  # adding this next line here (rather than in run_all_tests.sh), because we think
  # of the graph-generation as more of a "build" step than a "test":
  $DIR/sw_arch_doc/generate_graph.sh ${DIR}/src/ ${DIR}/

  # Next step done here (rather than inside generate_graph.sh) because the
  # graph script does not need to be "git aware".
  sw_arch_changed=$(git diff --exit-code ${DIR}/sw_arch_doc/all_src.dot || true)
  if [[ -z ${sw_arch_changed} ]]; then
      # What this block achieves is:
      #
      # If the '*.dot' file was not actually changed, then we FORCE the svg to
      # also be in an unchanged state.
      #
      # This solves a problem where the svg can always come up dirty if a
      # contributor is running the build script but the version of graphviz/dot
      # on that contributor's build machine is not an exact match for the
      # graphviz/dot version used by whoever caused the most recent changes in
      # sw_arch_doc/.
      git checkout ${DIR}/sw_arch_doc/all_src.svg
  fi
fi

if [[ -n ${MYAPP_TEMPLATE_QT6-} ]]; then
  # Strip out usage of QML 'import QtGraphicalEffects' on Qt 6.
  # Effects have moved to 'import QtQuick3D.Effects' and we have not
  # yet made that available in our CI job.
  git apply $DIR/tools/ci/strip_effects_for_sake_of_qt6.patch
fi

$DIR/tools/ci/version.sh cbuild

source $DIR/path_to_qmake.bash

if [[ -n ${MYAPP_TEMPLATE_COMPILERCHOICE_CLANG-} ]]; then
  clang -v # to print info into CI log.
  MYAPP_EXTRA_CONF+=( "-Dwants_clang=ON" )
fi

mkdir -p cbuild
pushd cbuild

  cmake ${MYAPP_EXTRA_CONF[@]} -DCMAKE_VERBOSE_MAKEFILE:BOOL=ON $DIR

  ${makecmd} ${MYAPP_JOBS}

  # TODO
  #${makecmd} install # puts necessary items side-by-side with app exe

  # TODO?
  #if [[ "$OSTYPE" == "cygwin" || "$OSTYPE" == "msys" ]]; then
  #  ${makecmd} debug
  #fi

popd # pushd cbuild

if [[ -n ${MYAPP_TEMPLATE_BUILD_ANDROID-} ]]; then
  tools/ci/get_android_toolchain.sh
  tools/ci/build_android_app.sh build/for_android "CONFIG+=force_debug_info"
fi

if [[ "$OSTYPE" == "darwin"* ]]; then
  true
  #pushd cbuild/src/app
  #  macdeployqt app.app        -no-strip -libpath=$PWD -qmldir=../../../src/
  #  macdeployqt lib_tests.app  -no-strip -libpath=$PWD -qmldir=../../../src/
  #  macdeployqt util_tests.app -no-strip -libpath=$PWD -qmldir=../../../src/
  #popd # pushd cbuild/src/app

  #./build_ios_app.sh
fi

if [[ "$OSTYPE" == "cygwin" || "$OSTYPE" == "msys" ]]; then
  # TODO? release?
  #windows_deploy "--release" ${EXEDIR} ${PLUGINDIR} ${SHIPDIR}

  EXEDIRDBG=cbuild/stage
  PLUGINDIRDBG=cbuild/stage
  SHIPDIRDBG=cbuild/windeployfolder_debug

  #windows_deploy "--release" ${EXEDIR} ${PLUGINDIR} ${SHIPDIR}
  windows_deploy "--debug" ${EXEDIRDBG} ${PLUGINDIRDBG} ${SHIPDIRDBG}

fi

echo 'We assume this was run with '\''set -e'\'' (look at upper lines of this script).'
echo 'Assuming so, then getting here means:'
echo "${u_green}build_cmake_app.sh SUCCESS${u_resetcolor}"