From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by finch.gentoo.org (Postfix) with ESMTPS id EFD99138334 for ; Mon, 23 Dec 2019 23:09:08 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 4EAD5E0ABB; Mon, 23 Dec 2019 23:09:04 +0000 (UTC) Received: from smtp.gentoo.org (mail.gentoo.org [IPv6:2001:470:ea4a:1:5054:ff:fec7:86e4]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id D2561E09C7 for ; Mon, 23 Dec 2019 23:09:03 +0000 (UTC) Received: from tuxbrain.localnet (62-46-127-101.adsl.highway.telekom.at [62.46.127.101]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) (Authenticated sender: asturm) by smtp.gentoo.org (Postfix) with ESMTPSA id D14B134DB05 for ; Mon, 23 Dec 2019 23:09:01 +0000 (UTC) From: Andreas Sturmlechner To: gentoo-dev@lists.gentoo.org Subject: [gentoo-dev] [PATCH 1/2] cmake.eclass: New eclass, a cmake-utils cleanup for >=EAPI-7 Date: Tue, 24 Dec 2019 00:08:50 +0100 Message-ID: <1777207.7Z3S40VBb9@tuxbrain> Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-dev@lists.gentoo.org Reply-to: gentoo-dev@lists.gentoo.org X-Auto-Response-Suppress: DR, RN, NRN, OOF, AutoReply MIME-Version: 1.0 Content-Transfer-Encoding: 7Bit Content-Type: text/plain; charset="us-ascii" X-Archives-Salt: b9462ea7-dcb4-4ede-ae13-82a8f373cb2f X-Archives-Hash: 3aa1a3aeebad353a7cefcb86a8101943 This will be a drop-in replacement for 99% of cmake-utils inheriting ebuilds that are already EAPI-7 based today, that is, at long last, a qualified majority. Besides the cleanup, the new name is correcting a historical mistake and will let overlays with old EAPI ebuilds keep working. Maybe then declaring cmake-utils.eclass deprecated and unmaintained will increase the pressure to port to EAPI-7++ and the new cmake.eclass a bit. tl;dr: - Drop all pre-EAPI-7 compatibility - Drop CMAKE_MIN_VERSION - Drop CMAKE_REMOVE_MODULES - Array support for CMAKE_REMOVE_MODULES_LIST - Drop pushd/popd from src_prepare - Drop _cmake_generator_to_use() CMAKE_MAKEFILE_GENERATOR validity is already checked in global scope. Move the check for dev-util/ninja into src_prepare. - Rename cmake_src_make() -> cmake_build() - Drop _cmake_ninja_src_build and _cmake_emake_src_build, move into cmake_build Below patch is for showing diff, of course cmake-utils.eclass will not be dropped just yet. --- eclass/cmake-utils.eclass +++ eclass/cmake.eclass @@ -1,7 +1,7 @@ # Copyright 1999-2019 Gentoo Authors # Distributed under the terms of the GNU General Public License v2 -# @ECLASS: cmake-utils.eclass +# @ECLASS: cmake.eclass # @MAINTAINER: # kde@gentoo.org # @AUTHOR: @@ -9,16 +9,16 @@ # Maciej Mrozowski # (undisclosed contributors) # Original author: Zephyrus (zephyrus@mirach.it) -# @SUPPORTED_EAPIS: 5 6 7 +# @SUPPORTED_EAPIS: 7 # @BLURB: common ebuild functions for cmake-based packages # @DESCRIPTION: -# The cmake-utils eclass makes creating ebuilds for cmake-based packages much easier. -# It provides all inherited features (DOCS, HTML_DOCS, PATCHES) along with out-of-source -# builds (default), in-source builds and an implementation of the well-known use_enable -# and use_with functions for CMake. +# The cmake eclass makes creating ebuilds for cmake-based packages much easier. +# It provides all inherited features (DOCS, HTML_DOCS, PATCHES) along with +# out-of-source builds (default), in-source builds and an implementation of the +# well-known use_enable function for CMake. -if [[ -z ${_CMAKE_UTILS_ECLASS} ]]; then -_CMAKE_UTILS_ECLASS=1 +if [[ -z ${_CMAKE_ECLASS} ]]; then +_CMAKE_ECLASS=1 # @ECLASS-VARIABLE: BUILD_DIR # @DESCRIPTION: @@ -26,9 +26,7 @@ # For in-source build it's fixed to ${CMAKE_USE_DIR}. # For out-of-source build it can be overridden, by default it uses # ${WORKDIR}/${P}_build. -# -# This variable has been called CMAKE_BUILD_DIR formerly. -# It is set under that name for compatibility. +: ${BUILD_DIR:=${WORKDIR}/${P}_build} # @ECLASS-VARIABLE: CMAKE_BINARY # @DESCRIPTION: @@ -39,9 +37,9 @@ # @DESCRIPTION: # Set to override default CMAKE_BUILD_TYPE. Only useful for packages # known to make use of "if (CMAKE_BUILD_TYPE MATCHES xxx)". -# If about to be set - needs to be set before invoking cmake-utils_src_configure. -# You usualy do *NOT* want nor need to set it as it pulls CMake default build-type -# specific compiler flags overriding make.conf. +# If about to be set - needs to be set before invoking cmake_src_configure. +# You usually do *NOT* want nor need to set it as it pulls CMake default +# build-type specific compiler flags overriding make.conf. : ${CMAKE_BUILD_TYPE:=Gentoo} # @ECLASS-VARIABLE: CMAKE_IN_SOURCE_BUILD @@ -54,30 +52,20 @@ # @DESCRIPTION: # Specify a makefile generator to be used by cmake. # At this point only "emake" and "ninja" are supported. -# In EAPI 7 and above, the default is set to "ninja", -# whereas in EAPIs below 7, it is set to "emake". - -# @ECLASS-VARIABLE: CMAKE_MIN_VERSION -# @DESCRIPTION: -# Specify the minimum required CMake version. -: ${CMAKE_MIN_VERSION:=3.9.6} - -# @ECLASS-VARIABLE: CMAKE_REMOVE_MODULES -# @DESCRIPTION: -# Do we want to remove anything? yes or whatever else for no -: ${CMAKE_REMOVE_MODULES:=yes} +# The default is set to "ninja". +: ${CMAKE_MAKEFILE_GENERATOR:=ninja} # @ECLASS-VARIABLE: CMAKE_REMOVE_MODULES_LIST # @DESCRIPTION: -# Space-separated list of CMake modules that will be removed in $S during src_prepare, +# Array of CMake modules that will be removed in $S during src_prepare, # in order to force packages to use the system version. +# Set to "none" to disable removing modules entirely. : ${CMAKE_REMOVE_MODULES_LIST:=FindBLAS FindLAPACK} # @ECLASS-VARIABLE: CMAKE_USE_DIR # @DESCRIPTION: -# Sets the directory where we are working with cmake. -# For example when application uses autotools and only one -# plugin needs to be done by cmake. +# Sets the directory where we are working with cmake, for example when +# application uses autotools and only one plugin needs to be done by cmake. # By default it uses ${S}. # @ECLASS-VARIABLE: CMAKE_VERBOSE @@ -90,6 +78,7 @@ # Warn about variables that are declared on the command line # but not used. Might give false-positives. # "no" to disable (default) or anything else to enable. +: ${CMAKE_WARN_UNUSED_CLI:=yes} # @ECLASS-VARIABLE: CMAKE_EXTRA_CACHE_FILE # @DEFAULT_UNSET @@ -98,41 +87,27 @@ # for econf and is needed to pass TRY_RUN results when cross-compiling. # Should be set by user in a per-package basis in /etc/portage/package.env. -# @ECLASS-VARIABLE: CMAKE_UTILS_QA_SRC_DIR_READONLY +# @ECLASS-VARIABLE: CMAKE_QA_SRC_DIR_READONLY # @DEFAULT_UNSET # @DESCRIPTION: -# After running cmake-utils_src_prepare, sets ${S} to read-only. This is +# After running cmake_src_prepare, sets ${S} to read-only. This is # a user flag and should under _no circumstances_ be set in the ebuild. # Helps in improving QA of build systems that write to source tree. case ${EAPI} in - 5) : ${CMAKE_WARN_UNUSED_CLI:=no} ;; - 6|7) : ${CMAKE_WARN_UNUSED_CLI:=yes} ;; + 7) ;; *) die "EAPI=${EAPI:-0} is not supported" ;; esac inherit toolchain-funcs ninja-utils flag-o-matic multiprocessing xdg-utils -case ${EAPI} in - [56]) - : ${CMAKE_MAKEFILE_GENERATOR:=emake} - inherit eutils multilib - ;; - *) - : ${CMAKE_MAKEFILE_GENERATOR:=ninja} - ;; -esac - EXPORT_FUNCTIONS src_prepare src_configure src_compile src_test src_install -if [[ ${WANT_CMAKE} ]]; then - if [[ ${EAPI} != [56] ]]; then - die "\${WANT_CMAKE} has been removed and is a no-op now" - else - eqawarn "\${WANT_CMAKE} has been removed and is a no-op now" - fi -fi -[[ ${PREFIX} ]] && die "\${PREFIX} has been removed and is a no-op now" +[[ ${CMAKE_BUILD_DIR} ]] && die "The ebuild must be migrated to BUILD_DIR" +[[ ${CMAKE_REMOVE_MODULES} ]] && die "CMAKE_REMOVE_MODULES is banned, set CMAKE_REMOVE_MODULES_LIST=\"\" instead" +[[ ${CMAKE_UTILS_QA_SRC_DIR_READONLY} ]] && die "Use CMAKE_QA_SRC_DIR_READONLY instead" +[[ ${WANT_CMAKE} ]] && die "WANT_CMAKE has been removed and is a no-op" +[[ ${PREFIX} ]] && die "PREFIX has been removed and is a no-op" case ${CMAKE_MAKEFILE_GENERATOR} in emake) @@ -148,60 +123,15 @@ esac if [[ ${PN} != cmake ]]; then - BDEPEND+=" >=dev-util/cmake-${CMAKE_MIN_VERSION}" + BDEPEND+=" dev-util/cmake" fi -case ${EAPI} in - 7) ;; - *) DEPEND=" ${BDEPEND}" ;; -esac - -# Internal functions used by cmake-utils_use_* -_cmake_use_me_now() { - debug-print-function ${FUNCNAME} "$@" - - local arg=$2 - [[ ! -z $3 ]] && arg=$3 - - [[ ${EAPI} == 5 ]] || die "${FUNCNAME[1]} is banned in EAPI 6 and later: use -D$1=\"\$(usex $2)\" instead" - - local uper capitalised x - [[ -z $2 ]] && die "cmake-utils_use-$1 []" - if [[ ! -z $3 ]]; then - # user specified the use name so use it - echo "-D$1$3=$(use $2 && echo ON || echo OFF)" - else - # use all various most used combinations - uper=$(echo ${2} | tr '[:lower:]' '[:upper:]') - capitalised=$(echo ${2} | sed 's/\<\(.\)\([^ ]*\)/\u\1\L\2/g') - for x in $2 $uper $capitalised; do - echo "-D$1$x=$(use $2 && echo ON || echo OFF) " - done - fi -} -_cmake_use_me_now_inverted() { - debug-print-function ${FUNCNAME} "$@" - - local arg=$2 - [[ ! -z $3 ]] && arg=$3 - - if [[ ${EAPI} != 5 && "${FUNCNAME[1]}" != cmake-utils_use_find_package ]] ; then - die "${FUNCNAME[1]} is banned in EAPI 6 and later: use -D$1=\"\$(usex $2)\" instead" - fi - - local uper capitalised x - [[ -z $2 ]] && die "cmake-utils_use-$1 []" - if [[ ! -z $3 ]]; then - # user specified the use name so use it - echo "-D$1$3=$(use $2 && echo OFF || echo ON)" - else - # use all various most used combinations - uper=$(echo ${2} | tr '[:lower:]' '[:upper:]') - capitalised=$(echo ${2} | sed 's/\<\(.\)\([^ ]*\)/\u\1\L\2/g') - for x in $2 $uper $capitalised; do - echo "-D$1$x=$(use $2 && echo OFF || echo ON) " - done - fi +# @FUNCTION: _cmake_banned_func +# @INTERNAL +# @DESCRIPTION: +# Banned functions are banned. +_cmake_banned_func() { + die "${FUNCNAME[1]} is banned. use -D$1=\"\$(usex $2)\" instead" } # Determine using IN or OUT source build @@ -210,69 +140,10 @@ if [[ -n ${CMAKE_IN_SOURCE_BUILD} ]]; then # we build in source dir BUILD_DIR="${CMAKE_USE_DIR}" - else - # Respect both the old variable and the new one, depending - # on which one was set by the ebuild. - if [[ ! ${BUILD_DIR} && ${CMAKE_BUILD_DIR} ]]; then - if [[ ${EAPI} != [56] ]]; then - eerror "The CMAKE_BUILD_DIR variable has been renamed to BUILD_DIR." - die "The ebuild must be migrated to BUILD_DIR." - else - eqawarn "The CMAKE_BUILD_DIR variable has been renamed to BUILD_DIR." - eqawarn "Please migrate the ebuild to use the new one." - fi - - # In the next call, both variables will be set already - # and we'd have to know which one takes precedence. - _RESPECT_CMAKE_BUILD_DIR=1 - fi - - if [[ ${_RESPECT_CMAKE_BUILD_DIR} ]]; then - BUILD_DIR=${CMAKE_BUILD_DIR:-${WORKDIR}/${P}_build} - else - : ${BUILD_DIR:=${WORKDIR}/${P}_build} - fi fi - # Backwards compatibility for getting the value. - [[ ${EAPI} == [56] ]] && CMAKE_BUILD_DIR=${BUILD_DIR} - mkdir -p "${BUILD_DIR}" || die - echo ">>> Working in BUILD_DIR: \"$BUILD_DIR\"" -} - -# Determine which generator to use -_cmake_generator_to_use() { - local generator_name - - case ${CMAKE_MAKEFILE_GENERATOR} in - ninja) - # if ninja is enabled but not installed, the build could fail - # this could happen if ninja is manually enabled (eg. make.conf) but not installed - case ${EAPI} in - 5|6) - if ! ROOT=/ has_version dev-util/ninja; then - die "CMAKE_MAKEFILE_GENERATOR is set to ninja, but ninja is not installed. Please install dev-util/ninja or unset CMAKE_MAKEFILE_GENERATOR." - fi - ;; - *) - if ! has_version -b dev-util/ninja; then - die "CMAKE_MAKEFILE_GENERATOR is set to ninja, but ninja is not installed. Please install dev-util/ninja or unset CMAKE_MAKEFILE_GENERATOR." - fi - ;; - esac - generator_name="Ninja" - ;; - emake) - generator_name="Unix Makefiles" - ;; - *) - eerror "Unknown value for \${CMAKE_MAKEFILE_GENERATOR}" - die "Value ${CMAKE_MAKEFILE_GENERATOR} is not supported" - ;; - esac - - echo ${generator_name} + einfo "Working in BUILD_DIR: \"$BUILD_DIR\"" } # @FUNCTION: cmake_comment_add_subdirectory @@ -294,133 +165,90 @@ } # @FUNCTION: comment_add_subdirectory -# @USAGE: +# @INTERNAL # @DESCRIPTION: -# Comment out an add_subdirectory call in CMakeLists.txt in the current directory -# Banned in EAPI 6 and later - use cmake_comment_add_subdirectory instead. +# Banned. Use cmake_comment_add_subdirectory instead. comment_add_subdirectory() { - [[ ${EAPI} == 5 ]] || die "comment_add_subdirectory is banned in EAPI 6 and later - use cmake_comment_add_subdirectory instead" - - cmake_comment_add_subdirectory "$@" + die "comment_add_subdirectory is banned. Use cmake_comment_add_subdirectory instead" } # @FUNCTION: cmake-utils_use_with -# @USAGE: [flag name] +# @INTERNAL # @DESCRIPTION: -# Based on use_with. See ebuild(5). -# -# `cmake-utils_use_with foo FOO` echoes -DWITH_FOO=ON if foo is enabled -# and -DWITH_FOO=OFF if it is disabled. -cmake-utils_use_with() { _cmake_use_me_now WITH_ "$@" ; } +# Banned. Use -DWITH_FOO=$(usex foo) instead. +cmake-utils_use_with() { _cmake_banned_func WITH_ "$@" ; } # @FUNCTION: cmake-utils_use_enable -# @USAGE: [flag name] +# @INTERNAL # @DESCRIPTION: -# Based on use_enable. See ebuild(5). -# -# `cmake-utils_use_enable foo FOO` echoes -DENABLE_FOO=ON if foo is enabled -# and -DENABLE_FOO=OFF if it is disabled. -cmake-utils_use_enable() { _cmake_use_me_now ENABLE_ "$@" ; } +# Banned. Use -DENABLE_FOO=$(usex foo) instead. +cmake-utils_use_enable() { _cmake_banned_func ENABLE_ "$@" ; } -# @FUNCTION: cmake-utils_use_find_package +# @FUNCTION: cmake_use_find_package # @USAGE: # @DESCRIPTION: # Based on use_enable. See ebuild(5). # -# `cmake-utils_use_find_package foo LibFoo` echoes -DCMAKE_DISABLE_FIND_PACKAGE_LibFoo=OFF +# `cmake_use_find_package foo LibFoo` echoes -DCMAKE_DISABLE_FIND_PACKAGE_LibFoo=OFF # if foo is enabled and -DCMAKE_DISABLE_FIND_PACKAGE_LibFoo=ON if it is disabled. # This can be used to make find_package optional. -cmake-utils_use_find_package() { - if [[ ${EAPI} != 5 && "$#" != 2 ]] ; then - die "Usage: cmake-utils_use_find_package " - fi - - _cmake_use_me_now_inverted CMAKE_DISABLE_FIND_PACKAGE_ "$@" ; -} - -# @FUNCTION: cmake_use_find_package -# @USAGE: -# @DESCRIPTION: -# Alias for cmake-utils_use_find_package. cmake_use_find_package() { - if [[ "$#" != 2 ]] ; then + debug-print-function ${FUNCNAME} "$@" + + if [[ "$#" != 2 || -z $1 ]] ; then die "Usage: cmake_use_find_package " fi - cmake-utils_use_find_package "$@" ; + echo "-DCMAKE_DISABLE_FIND_PACKAGE_$2=$(use $1 && echo OFF || echo ON)" } # @FUNCTION: cmake-utils_use_disable -# @USAGE: [flag name] +# @INTERNAL # @DESCRIPTION: -# Based on inversion of use_enable. See ebuild(5). -# -# `cmake-utils_use_enable foo FOO` echoes -DDISABLE_FOO=OFF if foo is enabled -# and -DDISABLE_FOO=ON if it is disabled. -cmake-utils_use_disable() { _cmake_use_me_now_inverted DISABLE_ "$@" ; } +# Banned. Use -DDISABLE_FOO=$(usex !foo) instead. +cmake-utils_use_disable() { _cmake_banned_func DISABLE_ "$@" ; } # @FUNCTION: cmake-utils_use_no -# @USAGE: [flag name] +# @INTERNAL # @DESCRIPTION: -# Based on use_disable. See ebuild(5). -# -# `cmake-utils_use_no foo FOO` echoes -DNO_FOO=OFF if foo is enabled -# and -DNO_FOO=ON if it is disabled. -cmake-utils_use_no() { _cmake_use_me_now_inverted NO_ "$@" ; } +# Banned. Use -DNO_FOO=$(usex !foo) instead. +cmake-utils_use_no() { _cmake_banned_func NO_ "$@" ; } # @FUNCTION: cmake-utils_use_want -# @USAGE: [flag name] +# @INTERNAL # @DESCRIPTION: -# Based on use_enable. See ebuild(5). -# -# `cmake-utils_use_want foo FOO` echoes -DWANT_FOO=ON if foo is enabled -# and -DWANT_FOO=OFF if it is disabled. -cmake-utils_use_want() { _cmake_use_me_now WANT_ "$@" ; } +# Banned. Use -DWANT_FOO=$(usex foo) instead. +cmake-utils_use_want() { _cmake_banned_func WANT_ "$@" ; } # @FUNCTION: cmake-utils_use_build -# @USAGE: [flag name] +# @INTERNAL # @DESCRIPTION: -# Based on use_enable. See ebuild(5). -# -# `cmake-utils_use_build foo FOO` echoes -DBUILD_FOO=ON if foo is enabled -# and -DBUILD_FOO=OFF if it is disabled. -cmake-utils_use_build() { _cmake_use_me_now BUILD_ "$@" ; } +# Banned. Use -DBUILD_FOO=$(usex foo) instead. +cmake-utils_use_build() { _cmake_banned_func BUILD_ "$@" ; } # @FUNCTION: cmake-utils_use_has -# @USAGE: [flag name] +# @INTERNAL # @DESCRIPTION: -# Based on use_enable. See ebuild(5). -# -# `cmake-utils_use_has foo FOO` echoes -DHAVE_FOO=ON if foo is enabled -# and -DHAVE_FOO=OFF if it is disabled. -cmake-utils_use_has() { _cmake_use_me_now HAVE_ "$@" ; } +# Banned. Use -DHAVE_FOO=$(usex foo) instead. +cmake-utils_use_has() { _cmake_banned_func HAVE_ "$@" ; } # @FUNCTION: cmake-utils_use_use -# @USAGE: [flag name] +# @INTERNAL # @DESCRIPTION: -# Based on use_enable. See ebuild(5). -# -# `cmake-utils_use_use foo FOO` echoes -DUSE_FOO=ON if foo is enabled -# and -DUSE_FOO=OFF if it is disabled. -cmake-utils_use_use() { _cmake_use_me_now USE_ "$@" ; } +# Banned. Use -DUSE_FOO=$(usex foo) instead. +cmake-utils_use_use() { _cmake_banned_func USE_ "$@" ; } # @FUNCTION: cmake-utils_use -# @USAGE: [flag name] +# @INTERNAL # @DESCRIPTION: -# Based on use_enable. See ebuild(5). -# -# `cmake-utils_use foo FOO` echoes -DFOO=ON if foo is enabled -# and -DFOO=OFF if it is disabled. -cmake-utils_use() { _cmake_use_me_now "" "$@" ; } +# Banned. Use -DFOO=$(usex foo) instead. +cmake-utils_use() { _cmake_banned_func "" "$@" ; } # @FUNCTION: cmake-utils_useno -# @USAGE: [flag name] +# @INTERNAL # @DESCRIPTION: -# Based on use_enable. See ebuild(5). -# -# `cmake-utils_useno foo NOFOO` echoes -DNOFOO=OFF if foo is enabled -# and -DNOFOO=ON if it is disabled. -cmake-utils_useno() { _cmake_use_me_now_inverted "" "$@" ; } +# Banned. Use -DNOFOO=$(usex !foo) instead. +cmake-utils_useno() { _cmake_banned_func "" "$@" ; } # Internal function for modifying hardcoded definitions. # Removes dangerous definitions that override Gentoo settings. @@ -459,17 +287,14 @@ _EOF_ } -# temporary function for moving cmake cleanups from from src_configure -> src_prepare. -# bug #378850 -_cmake_cleanup_cmake() { - : ${CMAKE_USE_DIR:=${S}} +# @FUNCTION: cmake_src_prepare +# @DESCRIPTION: +# Apply ebuild and user patches. +cmake_src_prepare() { + debug-print-function ${FUNCNAME} "$@" - if [[ "${CMAKE_REMOVE_MODULES}" == "yes" ]] ; then - local name - for name in ${CMAKE_REMOVE_MODULES_LIST} ; do - find "${S}" -name ${name}.cmake -exec rm -v {} + || die - done - fi + default_src_prepare + _cmake_check_build_dir # check if CMakeLists.txt exist and if no then die if [[ ! -e ${CMAKE_USE_DIR}/CMakeLists.txt ]] ; then @@ -479,37 +304,34 @@ die "FATAL: Unable to find CMakeLists.txt" fi - # Remove dangerous things. - _cmake_modify-cmakelists -} - -# @FUNCTION: cmake-utils_src_prepare -# @DESCRIPTION: -# Apply ebuild and user patches. -cmake-utils_src_prepare() { - debug-print-function ${FUNCNAME} "$@" - - pushd "${S}" > /dev/null || die + # if ninja is enabled but not installed, the build could fail + # this could happen if ninja is manually enabled (eg. make.conf) but not installed + if [[ ${CMAKE_MAKEFILE_GENERATOR} == ninja ]] && ! has_version -b dev-util/ninja; then + eerror "CMAKE_MAKEFILE_GENERATOR is set to ninja, but ninja is not installed." + die "Please install dev-util/ninja or unset CMAKE_MAKEFILE_GENERATOR." + fi - if [[ ${EAPI} != 5 ]]; then - default_src_prepare - _cmake_cleanup_cmake + local modules_list + if [[ $(declare -p CMAKE_REMOVE_MODULES_LIST) == "declare -a"* ]]; then + modules_list=( "${CMAKE_REMOVE_MODULES_LIST[@]}" ) else - debug-print "$FUNCNAME: PATCHES=$PATCHES" - [[ ${PATCHES[@]} ]] && epatch "${PATCHES[@]}" - - debug-print "$FUNCNAME: applying user patches" - epatch_user + modules_list=( ${CMAKE_REMOVE_MODULES_LIST} ) fi - popd > /dev/null || die + local name + for name in "${modules_list[@]}" ; do + find "${S}" -name ${name}.cmake -exec rm -v {} + || die + done + + # Remove dangerous things. + _cmake_modify-cmakelists # make ${S} read-only in order to detect broken build-systems - if [[ ${CMAKE_UTILS_QA_SRC_DIR_READONLY} && ! ${CMAKE_IN_SOURCE_BUILD} ]]; then + if [[ ${CMAKE_QA_SRC_DIR_READONLY} && ! ${CMAKE_IN_SOURCE_BUILD} ]]; then chmod -R a-w "${S}" fi - _CMAKE_UTILS_SRC_PREPARE_HAS_RUN=1 + _CMAKE_SRC_PREPARE_HAS_RUN=1 } # @VARIABLE: mycmakeargs @@ -520,29 +342,22 @@ # @CODE # src_configure() { # local mycmakeargs=( -# $(cmake-utils_use_with openconnect) +# $(cmake_use_with openconnect) # ) # -# cmake-utils_src_configure +# cmake_src_configure # } # @CODE -# @FUNCTION: cmake-utils_src_configure +# @FUNCTION: cmake_src_configure # @DESCRIPTION: # General function for configuring with cmake. Default behaviour is to start an # out-of-source build. -cmake-utils_src_configure() { +cmake_src_configure() { debug-print-function ${FUNCNAME} "$@" - if [[ ! ${_CMAKE_UTILS_SRC_PREPARE_HAS_RUN} ]]; then - if [[ ${EAPI} != [56] ]]; then - die "FATAL: cmake-utils_src_prepare has not been run" - else - eqawarn "cmake-utils_src_prepare has not been run, please open a bug on https://bugs.gentoo.org/" - fi - fi - - [[ ${EAPI} == 5 ]] && _cmake_cleanup_cmake + [[ ${_CMAKE_SRC_PREPARE_HAS_RUN} ]] || \ + die "FATAL: cmake_src_prepare has not been run" _cmake_check_build_dir @@ -552,7 +367,7 @@ # @SEE CMAKE_BUILD_TYPE if [[ ${CMAKE_BUILD_TYPE} = Gentoo ]]; then # Handle release builds - if ! has debug ${IUSE//+} || ! use debug; then + if ! in_iuse debug || ! use debug; then local CPPFLAGS=${CPPFLAGS} append-cppflags -DNDEBUG fi @@ -655,18 +470,15 @@ SET (CMAKE_INSTALL_INFODIR "${EPREFIX}/usr/share/info" CACHE PATH "") SET (CMAKE_INSTALL_MANDIR "${EPREFIX}/usr/share/man" CACHE PATH "") SET (CMAKE_USER_MAKE_RULES_OVERRIDE "${build_rules}" CACHE FILEPATH "Gentoo override rules") + SET (CMAKE_INSTALL_DOCDIR "${EPREFIX}/usr/share/doc/${PF}" CACHE PATH "") + SET (BUILD_SHARED_LIBS ON CACHE BOOL "") _EOF_ - [[ "${NOCOLOR}" = true || "${NOCOLOR}" = yes ]] && echo 'SET (CMAKE_COLOR_MAKEFILE OFF CACHE BOOL "pretty colors during make" FORCE)' >> "${common_config}" - - if [[ ${EAPI} != [56] ]]; then - cat >> "${common_config}" <<- _EOF_ || die - SET (CMAKE_INSTALL_DOCDIR "${EPREFIX}/usr/share/doc/${PF}" CACHE PATH "") - SET (BUILD_SHARED_LIBS ON CACHE BOOL "") - _EOF_ + if [[ "${NOCOLOR}" = true || "${NOCOLOR}" = yes ]]; then + echo 'SET (CMAKE_COLOR_MAKEFILE OFF CACHE BOOL "pretty colors during make" FORCE)' >> "${common_config}" || die fi # Wipe the default optimization flags out of CMake - if [[ ${CMAKE_BUILD_TYPE} != Gentoo && ${EAPI} != 5 ]]; then + if [[ ${CMAKE_BUILD_TYPE} != Gentoo ]]; then cat >> ${common_config} <<- _EOF_ || die SET (CMAKE_ASM_FLAGS_${CMAKE_BUILD_TYPE^^} "" CACHE STRING "") SET (CMAKE_ASM-ATT_FLAGS_${CMAKE_BUILD_TYPE^^} "" CACHE STRING "") @@ -680,40 +492,36 @@ _EOF_ fi - # Convert mycmakeargs to an array, for backwards compatibility # Make the array a local variable since <=portage-2.1.6.x does not # support global arrays (see bug #297255). local mycmakeargstype=$(declare -p mycmakeargs 2>&-) if [[ "${mycmakeargstype}" != "declare -a mycmakeargs="* ]]; then - if [[ -n "${mycmakeargstype}" ]] ; then - if [[ ${EAPI} == 5 ]]; then - eqawarn "Declaring mycmakeargs as a variable is deprecated. Please use an array instead." - else - die "Declaring mycmakeargs as a variable is banned in EAPI=${EAPI}. Please use an array instead." - fi - fi - local mycmakeargs_local=(${mycmakeargs}) - else - local mycmakeargs_local=("${mycmakeargs[@]}") + die "mycmakeargs must be declared as array" fi + local mycmakeargs_local=( "${mycmakeargs[@]}" ) + + local warn_unused_cli="" if [[ ${CMAKE_WARN_UNUSED_CLI} == no ]] ; then - local warn_unused_cli="--no-warn-unused-cli" - else - local warn_unused_cli="" + warn_unused_cli="--no-warn-unused-cli" fi + local generator_name + case ${CMAKE_MAKEFILE_GENERATOR} in + ninja) generator_name="Ninja" ;; + emake) generator_name="Unix Makefiles" ;; + esac + # Common configure parameters (overridable) # NOTE CMAKE_BUILD_TYPE can be only overridden via CMAKE_BUILD_TYPE eclass variable # No -DCMAKE_BUILD_TYPE=xxx definitions will be in effect. local cmakeargs=( ${warn_unused_cli} -C "${common_config}" - -G "$(_cmake_generator_to_use)" + -G "${generator_name}" -DCMAKE_INSTALL_PREFIX="${EPREFIX}/usr" "${mycmakeargs_local[@]}" -DCMAKE_BUILD_TYPE="${CMAKE_BUILD_TYPE}" - $([[ ${EAPI} == 5 ]] && echo -DCMAKE_INSTALL_DO_STRIP=OFF) -DCMAKE_TOOLCHAIN_FILE="${toolchain_file}" "${MYCMAKEARGS}" ) @@ -729,64 +537,53 @@ popd > /dev/null || die } -# @FUNCTION: cmake-utils_src_compile +# @FUNCTION: cmake_src_compile # @DESCRIPTION: # General function for compiling with cmake. # Automatically detects the build type. All arguments are passed to emake. -cmake-utils_src_compile() { +cmake_src_compile() { debug-print-function ${FUNCNAME} "$@" - cmake-utils_src_make "$@" + cmake_build "$@" } -# @FUNCTION: _cmake_ninja_src_make -# @INTERNAL -# @DESCRIPTION: -# Build the package using ninja generator -_cmake_ninja_src_make() { - debug-print-function ${FUNCNAME} "$@" - - [[ -e build.ninja ]] || die "build.ninja not found. Error during configure stage." - - eninja "$@" -} - -# @FUNCTION: _cmake_emake_src_make -# @INTERNAL -# @DESCRIPTION: -# Build the package using make generator -_cmake_emake_src_make() { - debug-print-function ${FUNCNAME} "$@" - - [[ -e Makefile ]] || die "Makefile not found. Error during configure stage." - - if [[ "${CMAKE_VERBOSE}" != "OFF" ]]; then - emake VERBOSE=1 "$@" || die - else - emake "$@" || die - fi - -} - -# @FUNCTION: cmake-utils_src_make +# @FUNCTION: cmake_build # @DESCRIPTION: # Function for building the package. Automatically detects the build type. # All arguments are passed to emake. -cmake-utils_src_make() { +cmake_build() { debug-print-function ${FUNCNAME} "$@" _cmake_check_build_dir pushd "${BUILD_DIR}" > /dev/null || die - _cmake_${CMAKE_MAKEFILE_GENERATOR}_src_make "$@" + case ${CMAKE_MAKEFILE_GENERATOR} in + emake) + [[ -e Makefile ]] || die "Makefile not found. Error during configure stage." + [[ "${CMAKE_VERBOSE}" != "OFF" ]] && local verbosity="VERBOSE=1" + emake "${verbosity} ""$@" + ;; + ninja) + [[ -e build.ninja ]] || die "build.ninja not found. Error during configure stage." + eninja "$@" + ;; + esac popd > /dev/null || die } -# @FUNCTION: cmake-utils_src_test +# @FUNCTION: cmake-utils_src_make +# @INTERNAL +# @DESCRIPTION: +# Banned. Use cmake_build instead. +cmake-utils_src_make() { + die "cmake_src_make is banned. Use cmake_build instead" +} + +# @FUNCTION: cmake_src_test # @DESCRIPTION: # Function for testing the package. Automatically detects the build type. -cmake-utils_src_test() { +cmake_src_test() { debug-print-function ${FUNCNAME} "$@" _cmake_check_build_dir @@ -819,15 +616,16 @@ fi } -# @FUNCTION: cmake-utils_src_install +# @FUNCTION: cmake_src_install # @DESCRIPTION: # Function for installing the package. Automatically detects the build type. -cmake-utils_src_install() { +cmake_src_install() { debug-print-function ${FUNCNAME} "$@" _cmake_check_build_dir pushd "${BUILD_DIR}" > /dev/null || die - DESTDIR="${D}" ${CMAKE_MAKEFILE_GENERATOR} install "$@" || die "died running ${CMAKE_MAKEFILE_GENERATOR} install" + DESTDIR="${D}" ${CMAKE_MAKEFILE_GENERATOR} install "$@" || + die "died running ${CMAKE_MAKEFILE_GENERATOR} install" popd > /dev/null || die pushd "${S}" > /dev/null || die