# Copyright 1999-2020 Gentoo Authors
# Distributed under the terms of the GNU General Public License v2
# @ECLASS: ecm.eclass
# @MAINTAINER:
# kde@gentoo.org
# @SUPPORTED_EAPIS: 7
# @BLURB: Support eclass for packages that use KDE Frameworks with ECM.
# @DESCRIPTION:
# This eclass is intended to streamline the creation of ebuilds for packages
# that use cmake and KDE Frameworks' extra-cmake-modules, thereby following
# some of their packaging conventions. It is primarily intended for the three
# upstream release groups (Frameworks, Plasma, Applications) but also for any
# other package that follows similar conventions.
#
# This eclass unconditionally inherits cmake.eclass and all its public
# variables and helper functions (not phase functions) may be considered as part
# of this eclass's API.
#
# This eclass's phase functions are not intended to be mixed and matched, so if
# any phase functions are overridden the version here should also be called.
#
# Porting from kde5.class
# - Convert all add_*_dep dependency functions to regular dependencies
# - Manually set LICENSE
# - Manually set SLOT
# - Rename vars and function names as needed, see kde5.eclass PORTING comments
# - Instead of FRAMEWORKS_MINIMAL, define KFMIN in ebuilds and use it for deps
if [ [ -z ${ _ECM_ECLASS } ] ] ; then
_ECM_ECLASS = 1
# @ECLASS-VARIABLE: VIRTUALX_REQUIRED
# @DESCRIPTION:
# For proper description see virtualx.eclass manpage.
# Here we redefine default value to be manual, if your package needs virtualx
# for tests you should proceed with setting VIRTUALX_REQUIRED=test.
: ${ VIRTUALX_REQUIRED : =manual }
# @ECLASS-VARIABLE: ECM_NONGUI
# @DEFAULT_UNSET
# @DESCRIPTION:
# By default, for all CATEGORIES except kde-frameworks, assume we are building
# a GUI application. Add dependency on kde-frameworks/breeze-icons or
# kde-frameworks/oxygen-icons and run the xdg.eclass routines for pkg_preinst,
# pkg_postinst and pkg_postrm. If set to "true", do nothing.
if [ [ ${ CATEGORY } = kde-frameworks ] ] ; then
: ${ ECM_NONGUI : =true }
fi
: ${ ECM_NONGUI : =false }
inherit cmake flag-o-matic toolchain-funcs virtualx
if [ [ ${ ECM_NONGUI } = false ] ] ; then
inherit xdg
fi
case ${ EAPI } in
7) ; ;
*) die " EAPI= ${ EAPI :- 0 } is not supported " ; ;
esac
if [ [ -v KDE_GCC_MINIMAL ] ] ; then
EXPORT_FUNCTIONS pkg_pretend
fi
EXPORT_FUNCTIONS pkg_setup src_prepare src_configure src_test pkg_preinst pkg_postinst pkg_postrm
# @ECLASS-VARIABLE: ECM_KDEINSTALLDIRS
# @DESCRIPTION:
# Assume the package is using KDEInstallDirs macro and switch
# KDE_INSTALL_USE_QT_SYS_PATHS to ON. If set to "false", do nothing.
: ${ ECM_KDEINSTALLDIRS : =true }
# @ECLASS-VARIABLE: ECM_DEBUG
# @DESCRIPTION:
# Add "debug" to IUSE. If !debug, add -DQT_NO_DEBUG to CPPFLAGS. If set to
# "false", do nothing.
: ${ ECM_DEBUG : =true }
# @ECLASS-VARIABLE: ECM_DESIGNERPLUGIN
# @DESCRIPTION:
# If set to "true", add "designer" to IUSE to toggle build of designer plugins
# and add the necessary BDEPEND. If set to "false", do nothing.
: ${ ECM_DESIGNERPLUGIN : =false }
# @ECLASS-VARIABLE: ECM_EXAMPLES
# @DESCRIPTION:
# By default unconditionally ignore a top-level examples subdirectory.
# If set to "true", add "examples" to IUSE to toggle adding that subdirectory.
: ${ ECM_EXAMPLES : =false }
# @ECLASS-VARIABLE: ECM_HANDBOOK
# @DESCRIPTION:
# Will accept "true", "false", "optional", "forceoptional". If set to "false",
# do nothing.
# Otherwise, add "+handbook" to IUSE, add the appropriate dependency, and let
# KF5DocTools generate and install the handbook from docbook file(s) found in
# ECM_HANDBOOK_DIR. However if !handbook, disable build of ECM_HANDBOOK_DIR
# in CMakeLists.txt.
# If set to "optional", build with -DCMAKE_DISABLE_FIND_PACKAGE_KF5DocTools=ON
# when !handbook. In case package requires KF5KDELibs4Support, see next:
# If set to "forceoptional", remove a KF5DocTools dependency from the root
# CMakeLists.txt in addition to the above.
: ${ ECM_HANDBOOK : =false }
# @ECLASS-VARIABLE: ECM_HANDBOOK_DIR
# @DESCRIPTION:
# Specifies the directory containing the docbook file(s) relative to ${S} to
# be processed by KF5DocTools (kdoctools_install).
: ${ ECM_HANDBOOK_DIR : =doc }
# @ECLASS-VARIABLE: ECM_PO_DIRS
# @DESCRIPTION:
# Specifies directories of l10n files relative to ${S} to be processed by
# KF5I18n (ki18n_install). If IUSE nls exists and is disabled then disable
# build of these directories in CMakeLists.txt.
: ${ ECM_PO_DIRS : = "po poqm" }
# @ECLASS-VARIABLE: ECM_QTHELP
# @DEFAULT_UNSET
# @DESCRIPTION:
# Default value for all CATEGORIES except kde-frameworks is "false".
# If set to "true", add "doc" to IUSE, add the appropriate dependency, let
# -DBUILD_QCH=ON generate and install Qt compressed help files when USE=doc.
# If set to "false", do nothing.
if [ [ ${ CATEGORY } = kde-frameworks ] ] ; then
: ${ ECM_QTHELP : =true }
fi
: ${ ECM_QTHELP : =false }
# @ECLASS-VARIABLE: ECM_TEST
# @DEFAULT_UNSET
# @DESCRIPTION:
# Will accept "true", "false", "optional", "forceoptional",
# "forceoptional-recursive".
# Default value is "false", except for CATEGORY=kde-frameworks where it is
# set to "true". If set to "false", do nothing.
# For any other value, add "test" to IUSE and DEPEND on dev-qt/qttest:5.
# If set to "optional", build with -DCMAKE_DISABLE_FIND_PACKAGE_Qt5Test=ON
# when USE=!test.
# If set to "forceoptional", punt Qt5Test dependency and ignore "autotests",
# "test", "tests" subdirs from top-level CMakeLists.txt when USE=!test.
# If set to "forceoptional-recursive", punt Qt5Test dependencies and make
# autotest(s), unittest(s) and test(s) subdirs from *any* CMakeLists.txt in
# ${S} and below conditional on BUILD_TESTING when USE=!test. This is always
# meant as a short-term fix and creates ${T}/${P}-tests-optional.patch to
# refine and submit upstream.
if [ [ ${ CATEGORY } = kde-frameworks ] ] ; then
: ${ ECM_TEST : =true }
fi
: ${ ECM_TEST : =false }
# @ECLASS-VARIABLE: KFMIN
# @DEFAULT_UNSET
# @DESCRIPTION:
# Minimum version of Frameworks to require. Default value for kde-frameworks
# is ${PV} and 5.64.0 baseline for everything else. This is not going to be
# changed unless we also bump EAPI, which usually implies (rev-)bumping.
# Version will later be used to differentiate between KF5/Qt5 and KF6/Qt6.
if [ [ ${ CATEGORY } = kde-frameworks ] ] ; then
: ${ KFMIN : = $( ver_cut 1-2) }
fi
: ${ KFMIN : =5.64.0 }
# @ECLASS-VARIABLE: KFSLOT
# @INTERNAL
# @DESCRIPTION:
# KDE Frameworks and Qt slot dependency, implied by KFMIN version.
: ${ KFSLOT : =5 }
case ${ ECM_NONGUI } in
true ) ; ;
false )
# gui applications need breeze or oxygen for basic iconset, bug #564838
RDEPEND += " || (
kde-frameworks/breeze-icons:*
kde-frameworks/oxygen-icons:*
) "
; ;
*)
eerror "Unknown value for \${ECM_NONGUI}"
die " Value ${ ECM_NONGUI } is not supported "
; ;
esac
case ${ ECM_DEBUG } in
true )
IUSE += " debug"
; ;
false ) ; ;
*)
eerror "Unknown value for \${ECM_DEBUG}"
die " Value ${ ECM_DEBUG } is not supported "
; ;
esac
case ${ ECM_DESIGNERPLUGIN } in
true )
IUSE += " designer"
BDEPEND += " designer? ( dev-qt/designer: ${ KFSLOT } ) "
; ;
false ) ; ;
*)
eerror "Unknown value for \${ECM_DESIGNERPLUGIN}"
die " Value ${ ECM_DESIGNERPLUGIN } is not supported "
; ;
esac
case ${ ECM_EXAMPLES } in
true )
IUSE += " examples"
; ;
false ) ; ;
*)
eerror "Unknown value for \${ECM_EXAMPLES}"
die " Value ${ ECM_EXAMPLES } is not supported "
; ;
esac
case ${ ECM_HANDBOOK } in
true| optional| forceoptional)
IUSE += " +handbook"
BDEPEND += " handbook? ( >=kde-frameworks/kdoctools- ${ KFMIN } : ${ KFSLOT } ) "
; ;
false ) ; ;
*)
eerror "Unknown value for \${ECM_HANDBOOK}"
die " Value ${ ECM_HANDBOOK } is not supported "
; ;
esac
case ${ ECM_QTHELP } in
true )
IUSE += " doc"
COMMONDEPEND += " doc? ( dev-qt/qt-docs: ${ KFSLOT } ) "
BDEPEND += " doc? (
>= app-doc/doxygen-1.8.13-r1
dev-qt/qthelp:${ KFSLOT }
) "
; ;
false ) ; ;
*)
eerror "Unknown value for \${ECM_QTHELP}"
die " Value ${ ECM_QTHELP } is not supported "
; ;
esac
case ${ ECM_TEST } in
true| optional| forceoptional| forceoptional-recursive)
IUSE += " test"
DEPEND += " test? ( dev-qt/qttest: ${ KFSLOT } ) "
RESTRICT += " !test? ( test )"
; ;
false ) ; ;
*)
eerror "Unknown value for \${ECM_TEST}"
die " Value ${ ECM_TEST } is not supported "
; ;
esac
BDEPEND += " >=kde-frameworks/extra-cmake-modules- ${ KFMIN } : ${ KFSLOT } "
RDEPEND += " >=kde-frameworks/kf-env-4"
COMMONDEPEND += " dev-qt/qtcore: ${ KFSLOT } "
DEPEND += " ${ COMMONDEPEND } "
RDEPEND += " ${ COMMONDEPEND } "
unset COMMONDEPEND
# @FUNCTION: _ecm_banned_var
# @INTERNAL
# @DESCRIPTION:
# Banned kde5*.eclass variables are banned.
_ecm_banned_var( ) {
die " $1 is banned. use $2 instead. "
}
if [ [ -z ${ _KDE5_ECLASS } ] ] ; then
[ [ -n ${ KDE_DEBUG } ] ] && _ecm_banned_var KDE_DEBUG ECM_DEBUG
[ [ -n ${ KDE_EXAMPLES } ] ] && _ecm_banned_var KDE_EXAMPLES ECM_EXAMPLES
[ [ -n ${ KDE_HANDBOOK } ] ] && _ecm_banned_var KDE_HANDBOOK ECM_HANDBOOK
[ [ -n ${ KDE_DOC_DIR } ] ] && _ecm_banned_var KDE_DOC_DIR ECM_HANDBOOK_DIR
[ [ -n ${ KDE_PO_DIRS } ] ] && _ecm_banned_var KDE_PO_DIRS ECM_PO_DIRS
[ [ -n ${ KDE_QTHELP } ] ] && _ecm_banned_var KDE_QTHELP ECM_QTHELP
[ [ -n ${ KDE_TEST } ] ] && _ecm_banned_var KDE_TEST ECM_TEST
fi
# @ECLASS-VARIABLE: KDE_GCC_MINIMAL
# @DEFAULT_UNSET
# @DESCRIPTION:
# Minimum version of active GCC to require. This is checked in
# ecm_pkg_pretend and ecm_pkg_setup.
# @FUNCTION: _ecm_check_gcc_version
# @INTERNAL
# @DESCRIPTION:
# Determine if the current GCC version is acceptable, otherwise die.
_ecm_check_gcc_version( ) {
if [ [ ${ MERGE_TYPE } != binary && -v KDE_GCC_MINIMAL ] ] && tc-is-gcc; then
local version = $( gcc-version)
debug-print "GCC version check activated"
debug-print " Version detected: ${ version } "
debug-print " Version required: ${ KDE_GCC_MINIMAL } "
ver_test ${ version } -lt ${ KDE_GCC_MINIMAL } &&
die " Sorry, but gcc- ${ KDE_GCC_MINIMAL } or later is required for this package (found ${ version } ). "
fi
}
# @FUNCTION: _ecm_strip_handbook_translations
# @INTERNAL
# @DESCRIPTION:
# If LINGUAS is defined, enable only the requested translations when required.
_ecm_strip_handbook_translations( ) {
if ! [ [ -v LINGUAS ] ] ; then
return
fi
local lang po
for po in ${ ECM_PO_DIRS } ; do
if [ [ -d ${ po } ] ] ; then
pushd ${ po } > /dev/null || die
local lang
for lang in *; do
if [ [ -e ${ lang } ] ] && ! has ${ lang /.po/ } ${ LINGUAS } ; then
case ${ lang } in
cmake_modules | \
CMakeLists.txt | \
${ PN } .pot) ; ;
*) rm -r ${ lang } || die ; ;
esac
if [ [ -e CMakeLists.txt ] ] ; then
cmake_comment_add_subdirectory ${ lang }
sed -e " /add_subdirectory([[:space:]]* ${ lang } \/.*[[:space:]]*)/d " \
-i CMakeLists.txt || die
fi
fi
done
popd > /dev/null || die
fi
done
}
# @FUNCTION: ecm_punt_bogus_dep
# @USAGE: <prefix> <dependency>
# @DESCRIPTION:
# Removes a specified dependency from a find_package call with multiple
# components.
ecm_punt_bogus_dep( ) {
local prefix = ${ 1 }
local dep = ${ 2 }
if [ [ ! -e "CMakeLists.txt" ] ] ; then
return
fi
pcregrep -Mni " (?s)find_package\s*\(\s* ${ prefix } [^)]*? ${ dep } .*?\) " CMakeLists.txt > " ${ T } /bogus ${ dep } "
# pcregrep returns non-zero on no matches/error
if [ [ $? -ne 0 ] ] ; then
return
fi
local length = $( wc -l " ${ T } /bogus ${ dep } " | cut -d " " -f 1)
local first = $( head -n 1 " ${ T } /bogus ${ dep } " | cut -d ":" -f 1)
local last = $(( length + first - 1 ))
sed -e " ${ first } , ${ last } s/ ${ dep } // " -i CMakeLists.txt || die
if [ [ ${ length } -eq 1 ] ] ; then
sed -e " /find_package\s*(\s* ${ prefix } \(\s\+\(REQUIRED\|CONFIG\|COMPONENTS\|\${[A-Z0-9_]*}\)\)\+\s*)/Is/^/# removed by ecm.eclass - / " -i CMakeLists.txt || die
fi
}
# @FUNCTION: ecm_pkg_pretend
# @DESCRIPTION:
# Checks if the active compiler meets the minimum version requirements.
# phase function is only exported if KDE_GCC_MINIMAL is defined.
ecm_pkg_pretend( ) {
debug-print-function ${ FUNCNAME } " $@ "
_ecm_check_gcc_version
}
# @FUNCTION: ecm_pkg_setup
# @DESCRIPTION:
# Checks if the active compiler meets the minimum version requirements.
ecm_pkg_setup( ) {
debug-print-function ${ FUNCNAME } " $@ "
_ecm_check_gcc_version
}
# @FUNCTION: ecm_src_prepare
# @DESCRIPTION:
# Wrapper for cmake_src_prepare with lots of extra logic for magic
# handling of linguas, tests, handbook etc.
ecm_src_prepare( ) {
debug-print-function ${ FUNCNAME } " $@ "
cmake_src_prepare
# only build examples when required
if ! { in_iuse examples && use examples; } ; then
cmake_comment_add_subdirectory examples
fi
# only enable handbook when required
if in_iuse handbook && ! use handbook ; then
cmake_comment_add_subdirectory ${ ECM_HANDBOOK_DIR }
if [ [ ${ ECM_HANDBOOK } = forceoptional ] ] ; then
ecm_punt_bogus_dep KF5 DocTools
sed -i -e "/kdoctools_install/ s/^/#DONT/" CMakeLists.txt || die
fi
fi
# drop translations when nls is not wanted
if in_iuse nls && ! use nls ; then
local po
for po in ${ ECM_PO_DIRS } ; do
rm -rf ${ po } || die
done
fi
# limit playing field of locale stripping to kde-*/ categories
if [ [ ${ CATEGORY } = kde-* ] ] ; then
# always install unconditionally for kconfigwidgets - if you use
# language X as system language, and there is a combobox with language
# names, the translated language name for language Y is taken from
# /usr/share/locale/Y/kf5_entry.desktop
[ [ ${ PN } != kconfigwidgets ] ] && _ecm_strip_handbook_translations
fi
# only build unit tests when required
if ! { in_iuse test && use test; } ; then
if [ [ ${ ECM_TEST } = forceoptional ] ] ; then
ecm_punt_bogus_dep Qt5 Test
# if forceoptional, also cover non-kde categories
cmake_comment_add_subdirectory autotests test tests
elif [ [ ${ ECM_TEST } = forceoptional-recursive ] ] ; then
ecm_punt_bogus_dep Qt5 Test
local f pf = " ${ T } / ${ P } " -tests-optional.patch
touch ${ pf } || die "Failed to touch patch file"
for f in $( find . -type f -name "CMakeLists.txt" -exec \
grep -l "^\s*add_subdirectory\s*\(\s*.*\(auto|unit\)\?tests\?\s*)\s*\)" { } \; ) ; do
cp ${ f } ${ f } .old || die "Failed to prepare patch origfile"
pushd ${ f %/* } > /dev/null || die
ecm_punt_bogus_dep Qt5 Test
sed -i CMakeLists.txt -e \
"/^#/! s/add_subdirectory\s*\(\s*.*\(auto|unit\)\?tests\?\s*)\s*\)/if(BUILD_TESTING)\n&\nendif()/" \
|| die
popd > /dev/null || die
diff -Naur ${ f } .old ${ f } 1>>${ pf }
rm ${ f } .old || die "Failed to clean up"
done
eqawarn "Build system was modified by ECM_TEST=forceoptional-recursive."
eqawarn "Unified diff file ready for pickup in:"
eqawarn " ${ pf } "
eqawarn "Push it upstream to make this message go away."
elif [ [ ${ CATEGORY } = kde-frameworks || ${ CATEGORY } = kde-plasma || ${ CATEGORY } = kde-apps ] ] ; then
cmake_comment_add_subdirectory autotests test tests
fi
fi
# in frameworks, tests = manual tests so never build them
if [ [ ${ CATEGORY } = kde-frameworks ] ] && [ [ ${ PN } != extra-cmake-modules ] ] ; then
cmake_comment_add_subdirectory tests
fi
}
# @FUNCTION: ecm_src_configure
# @DESCRIPTION:
# Wrapper for cmake_src_configure with extra logic for magic handling of
# handbook, tests etc.
ecm_src_configure( ) {
debug-print-function ${ FUNCNAME } " $@ "
if in_iuse debug && ! use debug; then
append-cppflags -DQT_NO_DEBUG
fi
local cmakeargs
if in_iuse test && ! use test ; then
cmakeargs += ( -DBUILD_TESTING= OFF )
if [ [ ${ ECM_TEST } = optional ] ] ; then
cmakeargs += ( -DCMAKE_DISABLE_FIND_PACKAGE_Qt5Test= ON )
fi
fi
if [ [ ${ ECM_HANDBOOK } = optional ] ] ; then
cmakeargs += ( -DCMAKE_DISABLE_FIND_PACKAGE_KF5DocTools= $( usex !handbook) )
fi
if in_iuse designer && [ [ ${ ECM_DESIGNERPLUGIN } = true ] ] ; then
cmakeargs += ( -DBUILD_DESIGNERPLUGIN= $( usex designer) )
fi
if [ [ ${ ECM_QTHELP } = true ] ] ; then
cmakeargs += ( -DBUILD_QCH= $( usex doc) )
fi
if [ [ ${ ECM_KDEINSTALLDIRS } = true ] ] ; then
cmakeargs += (
# install mkspecs in the same directory as Qt stuff
-DKDE_INSTALL_USE_QT_SYS_PATHS= ON
# move handbook outside of doc dir, bug 667138
-DKDE_INSTALL_DOCBUNDLEDIR= " ${ EPREFIX } /usr/share/help "
)
fi
# allow the ebuild to override what we set here
mycmakeargs = ( " ${ cmakeargs [@] } " " ${ mycmakeargs [@] } " )
cmake_src_configure
}
# @FUNCTION: ecm_src_compile
# @DESCRIPTION:
# Wrapper for cmake_src_compile. Currently doesn't do anything extra, but
# is included as part of the API just in case it's needed in the future.
ecm_src_compile( ) {
debug-print-function ${ FUNCNAME } " $@ "
cmake_src_compile " $@ "
}
# @FUNCTION: ecm_src_test
# @DESCRIPTION:
# Wrapper for cmake_src_test with extra logic for magic handling of dbus
# and virtualx.
ecm_src_test( ) {
debug-print-function ${ FUNCNAME } " $@ "
_test_runner( ) {
if [ [ -n " ${ VIRTUALDBUS_TEST } " ] ] ; then
export $( dbus-launch)
fi
cmake_src_test
}
# When run as normal user during ebuild development with the ebuild command,
# tests tend to access the session DBUS. This however is not possible in a
# real emerge or on the tinderbox.
# make sure it does not happen, so bad tests can be recognized and disabled
unset DBUS_SESSION_BUS_ADDRESS DBUS_SESSION_BUS_PID
if [ [ ${ VIRTUALX_REQUIRED } = always || ${ VIRTUALX_REQUIRED } = test ] ] ; then
virtx _test_runner
else
_test_runner
fi
if [ [ -n " ${ DBUS_SESSION_BUS_PID } " ] ] ; then
kill ${ DBUS_SESSION_BUS_PID }
fi
}
# @FUNCTION: ecm_src_install
# @DESCRIPTION:
# Wrapper for cmake_src_install. Currently doesn't do anything extra, but
# is included as part of the API just in case it's needed in the future.
ecm_src_install( ) {
debug-print-function ${ FUNCNAME } " $@ "
cmake_src_install
}
# @FUNCTION: ecm_pkg_preinst
# @DESCRIPTION:
# Sets up environment variables required in ecm_pkg_postinst.
ecm_pkg_preinst( ) {
debug-print-function ${ FUNCNAME } " $@ "
case ${ ECM_NONGUI } in
false ) xdg_pkg_preinst ; ;
*) ; ;
esac
}
# @FUNCTION: ecm_pkg_postinst
# @DESCRIPTION:
# Updates the various XDG caches (icon, desktop, mime) if necessary.
ecm_pkg_postinst( ) {
debug-print-function ${ FUNCNAME } " $@ "
case ${ ECM_NONGUI } in
false ) xdg_pkg_postinst ; ;
*) ; ;
esac
if [ [ -n ${ _KDE_ORG_ECLASS } ] ] && [ [ -z ${ I_KNOW_WHAT_I_AM_DOING } ] ] && [ [ ${ KDE_BUILD_TYPE } = live ] ] ; then
einfo " WARNING! This is an experimental live ebuild of ${ CATEGORY } / ${ PN } "
einfo "Use it at your own risk."
einfo "Do _NOT_ file bugs at bugs.gentoo.org because of this ebuild!"
fi
}
# @FUNCTION: ecm_pkg_postrm
# @DESCRIPTION:
# Updates the various XDG caches (icon, desktop, mime) if necessary.
ecm_pkg_postrm( ) {
debug-print-function ${ FUNCNAME } " $@ "
case ${ ECM_NONGUI } in
false ) xdg_pkg_postrm ; ;
*) ; ;
esac
}
fi