From 4f2d7949f03e1c198bc888f2d05f421d35c57e21 Mon Sep 17 00:00:00 2001 From: V3n3RiX Date: Mon, 9 Oct 2017 18:53:29 +0100 Subject: reinit the tree, so we can have metadata --- eclass/kde5.eclass | 739 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 739 insertions(+) create mode 100644 eclass/kde5.eclass (limited to 'eclass/kde5.eclass') diff --git a/eclass/kde5.eclass b/eclass/kde5.eclass new file mode 100644 index 000000000000..a72f2d23ce4a --- /dev/null +++ b/eclass/kde5.eclass @@ -0,0 +1,739 @@ +# Copyright 1999-2017 Gentoo Foundation +# Distributed under the terms of the GNU General Public License v2 + +# @ECLASS: kde5.eclass +# @MAINTAINER: +# kde@gentoo.org +# @BLURB: Support eclass for KDE 5-related packages. +# @DESCRIPTION: +# The kde5.eclass provides support for building KDE 5-related packages. + +if [[ -z ${_KDE5_ECLASS} ]]; then +_KDE5_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} + +inherit cmake-utils eutils flag-o-matic gnome2-utils kde5-functions versionator virtualx xdg + +if [[ ${KDE_BUILD_TYPE} = live ]]; then + case ${KDE_SCM} in + git) inherit git-r3 ;; + esac +fi + +if [[ -v KDE_GCC_MINIMAL ]]; then + EXPORT_FUNCTIONS pkg_pretend +fi + +EXPORT_FUNCTIONS pkg_setup pkg_nofetch src_unpack src_prepare src_configure src_compile src_test src_install pkg_preinst pkg_postinst pkg_postrm + +# @ECLASS-VARIABLE: KDE_AUTODEPS +# @DESCRIPTION: +# If set to "false", do nothing. +# For any other value, add a dependency on dev-qt/qtcore:5 and kde-frameworks/extra-cmake-modules:5. +: ${KDE_AUTODEPS:=true} + +# @ECLASS-VARIABLE: KDE_BLOCK_SLOT4 +# @DESCRIPTION: +# This variable is used when KDE_AUTODEPS is set. +# If set to "true", add RDEPEND block on kde-apps/${PN}:4 +: ${KDE_BLOCK_SLOT4:=true} + +# @ECLASS-VARIABLE: KDE_DEBUG +# @DESCRIPTION: +# If set to "false", unconditionally build with -DNDEBUG. +# Otherwise, add debug to IUSE to control building with that flag. +: ${KDE_DEBUG:=true} + +# @ECLASS-VARIABLE: KDE_DESIGNERPLUGIN +# @DESCRIPTION: +# If set to "false", do nothing. +# Otherwise, add "designer" to IUSE to toggle build of designer plugins +# and add the necessary DEPENDs. +: ${KDE_DESIGNERPLUGIN:=false} + +# @ECLASS-VARIABLE: KDE_EXAMPLES +# @DESCRIPTION: +# If set to "false", unconditionally ignore a top-level examples subdirectory. +# Otherwise, add "examples" to IUSE to toggle adding that subdirectory. +: ${KDE_EXAMPLES:=false} + +# @ECLASS-VARIABLE: KDE_HANDBOOK +# @DESCRIPTION: +# If set to "false", do nothing. +# Otherwise, add "+handbook" to IUSE, add the appropriate dependency, and +# generate and install KDE handbook. +# If set to "optional", config with -DCMAKE_DISABLE_FIND_PACKAGE_KF5DocTools=ON +# when USE=!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. +: ${KDE_HANDBOOK:=false} + +# @ECLASS-VARIABLE: KDE_DOC_DIR +# @DESCRIPTION: +# Defaults to "doc". Otherwise, use alternative KDE handbook path. +: ${KDE_DOC_DIR:=doc} + +# @ECLASS-VARIABLE: KDE_QTHELP +# @DESCRIPTION: +# If set to "false", do nothing. +# Otherwise, add "doc" to IUSE, add the appropriate dependency, generate +# and install Qt compressed help files with -DBUILD_QCH=ON when USE=doc. +if [[ ${CATEGORY} = kde-frameworks && ( $(get_version_component_range 2) -ge 36 || ${KDE_BUILD_TYPE} = live ) ]]; then + : ${KDE_QTHELP:=true} +else + : ${KDE_QTHELP:=false} +fi + +# @ECLASS-VARIABLE: KDE_TESTPATTERN +# @DESCRIPTION: +# DANGER: Only touch it if you know what you are doing. +# By default, matches autotest(s), unittest(s) and test(s) pattern inside +# cmake add_subdirectory calls. +: ${KDE_TESTPATTERN:="\(auto|unit\)\?tests\?"} + +# @ECLASS-VARIABLE: KDE_TEST +# @DESCRIPTION: +# If set to "false", do nothing. +# For any other value, add test to IUSE and add a dependency on dev-qt/qttest:5. +# If set to "optional", configure with -DCMAKE_DISABLE_FIND_PACKAGE_Qt5Test=ON +# when USE=!test. +# If set to "forceoptional", remove a Qt5Test dependency and comment test +# subdirs from the root CMakeLists.txt in addition to the above. +# If set to "forceoptional-recursive", remove Qt5Test dependencies and make +# test subdirs according to KDE_TESTPATTERN from *any* CMakeLists.txt in ${S} +# and below conditional on BUILD_TESTING. 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 + : ${KDE_TEST:=true} +else + : ${KDE_TEST:=false} +fi + +# @ECLASS-VARIABLE: KDE_SELINUX_MODULE +# @DESCRIPTION: +# If set to "none", do nothing. +# For any other value, add selinux to IUSE, and depending on that useflag +# add a dependency on sec-policy/selinux-${KDE_SELINUX_MODULE} to (R)DEPEND. +: ${KDE_SELINUX_MODULE:=none} + +# @ECLASS-VARIABLE: KDE_SUBSLOT +# @DESCRIPTION: +# If set to "false", do nothing. +# If set to "true", add a subslot to the package, where subslot is either +# defined as major.minor version for kde-*/ categories or ${PV} if other. +# For any other value, that value will be used as subslot. +: ${KDE_SUBSLOT:=false} + +# @ECLASS-VARIABLE: KDE_UNRELEASED +# @INTERNAL +# @DESCRIPTION +# An array of $CATEGORY-$PV pairs of packages that are unreleased upstream. +# Any package matching this will have fetch restriction enabled, and receive +# a proper error message via pkg_nofetch. +KDE_UNRELEASED=( ) + +if [[ ${KDEBASE} = kdevelop ]]; then + HOMEPAGE="https://www.kdevelop.org/" +elif [[ ${KMNAME} = kdepim ]]; then + HOMEPAGE="https://www.kde.org/applications/office/kontact/" +else + HOMEPAGE="https://www.kde.org/" +fi + +LICENSE="GPL-2" + +SLOT=5 + +if [[ ${CATEGORY} = kde-frameworks ]]; then + KDE_SUBSLOT=true +fi + +case ${KDE_SUBSLOT} in + false) ;; + true) + case ${CATEGORY} in + kde-frameworks | \ + kde-plasma | \ + kde-apps) + SLOT+="/$(get_version_component_range 1-2)" + ;; + *) + SLOT+="/${PV}" + ;; + esac + ;; + *) + SLOT+="/${KDE_SUBSLOT}" + ;; +esac + +case ${KDE_AUTODEPS} in + false) ;; + *) + DEPEND+=" $(add_frameworks_dep extra-cmake-modules)" + RDEPEND+=" >=kde-frameworks/kf-env-4" + COMMONDEPEND+=" $(add_qt_dep qtcore)" + + case ${CATEGORY} in + kde-frameworks | \ + kde-plasma) + RDEPEND+=" ! /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 + fi + + if [[ ${KDE_BUILD_TYPE} = release && ${CATEGORY} != kde-apps ]] ; then + if [[ ${KDE_HANDBOOK} != false && -d ${KDE_DOC_DIR} && -v LINGUAS ]] ; then + pushd ${KDE_DOC_DIR} > /dev/null || die + local lang + for lang in *; do + if ! has ${lang} ${LINGUAS} ; then + cmake_comment_add_subdirectory ${lang} + fi + done + popd > /dev/null || die + fi + fi + + # only build unit tests when required + if ! use_if_iuse test ; then + if [[ ${KDE_TEST} = forceoptional ]] ; then + punt_bogus_dep Qt5 Test + # if forceoptional, also cover non-kde categories + cmake_comment_add_subdirectory autotests test tests + elif [[ ${KDE_TEST} = forceoptional-recursive ]] ; then + 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*.*${KDE_TESTPATTERN}\s*)\s*\)" {} \;); do + cp ${f} ${f}.old || die "Failed to prepare patch origfile" + pushd ${f%/*} > /dev/null || die + punt_bogus_dep Qt5 Test + sed -i CMakeLists.txt -e \ + "/^#/! s/add_subdirectory\s*\(\s*.*${KDE_TESTPATTERN}\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 + einfo "Build system was modified by KDE_TEST=forceoptional-recursive." + einfo "Unified diff file ready for pickup in:" + einfo " ${pf}" + einfo "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: kde5_src_configure +# @DESCRIPTION: +# Function for configuring the build of KDE 5. +kde5_src_configure() { + debug-print-function ${FUNCNAME} "$@" + + # we rely on cmake-utils.eclass to append -DNDEBUG too + if ! use_if_iuse debug; then + append-cppflags -DQT_NO_DEBUG + fi + + local cmakeargs + + if ! use_if_iuse test ; then + cmakeargs+=( -DBUILD_TESTING=OFF ) + + if [[ ${KDE_TEST} = optional ]] ; then + cmakeargs+=( -DCMAKE_DISABLE_FIND_PACKAGE_Qt5Test=ON ) + fi + fi + + if ! use_if_iuse handbook && [[ ${KDE_HANDBOOK} = optional ]] ; then + cmakeargs+=( -DCMAKE_DISABLE_FIND_PACKAGE_KF5DocTools=ON ) + fi + + if ! use_if_iuse designer && [[ ${KDE_DESIGNERPLUGIN} != false ]] ; then + cmakeargs+=( -DCMAKE_DISABLE_FIND_PACKAGE_Qt5Designer=ON ) + fi + + if [[ ${KDE_QTHELP} != false ]]; then + cmakeargs+=( -DBUILD_QCH=$(usex doc) ) + fi + + # install mkspecs in the same directory as qt stuff + cmakeargs+=(-DKDE_INSTALL_USE_QT_SYS_PATHS=ON) + + # allow the ebuild to override what we set here + mycmakeargs=("${cmakeargs[@]}" "${mycmakeargs[@]}") + + cmake-utils_src_configure +} + +# @FUNCTION: kde5_src_compile +# @DESCRIPTION: +# Function for compiling KDE 5. +kde5_src_compile() { + debug-print-function ${FUNCNAME} "$@" + + cmake-utils_src_compile "$@" +} + +# @FUNCTION: kde5_src_test +# @DESCRIPTION: +# Function for testing KDE 5. +kde5_src_test() { + debug-print-function ${FUNCNAME} "$@" + + _test_runner() { + if [[ -n "${VIRTUALDBUS_TEST}" ]]; then + export $(dbus-launch) + fi + + cmake-utils_src_test + } + + # When run as normal user during ebuild development with the ebuild command, the + # kde 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: kde5_src_install +# @DESCRIPTION: +# Function for installing KDE 5. +kde5_src_install() { + debug-print-function ${FUNCNAME} "$@" + + cmake-utils_src_install + + # We don't want QCH and tags files to be compressed, because then + # cmake can't find the tags and qthelp viewers can't find the docs + local p=$(best_version dev-qt/qtcore:5) + local pv=$(echo ${p/%-r[0-9]*/} | rev | cut -d - -f 1 | rev) + if [[ -d ${ED%/}/usr/share/doc/qt-${pv} ]]; then + docompress -x /usr/share/doc/qt-${pv} + fi + + # We don't want /usr/share/doc/HTML to be compressed, + # because then khelpcenter can't find the docs + if [[ -d ${ED%/}/usr/share/doc/HTML ]]; then + docompress -x /usr/share/doc/HTML + fi +} + +# @FUNCTION: kde5_pkg_preinst +# @DESCRIPTION: +# Function storing icon caches +kde5_pkg_preinst() { + debug-print-function ${FUNCNAME} "$@" + + gnome2_icon_savelist + xdg_pkg_preinst +} + +# @FUNCTION: kde5_pkg_postinst +# @DESCRIPTION: +# Function to rebuild the KDE System Configuration Cache after an application has been installed. +kde5_pkg_postinst() { + debug-print-function ${FUNCNAME} "$@" + + if [[ -n ${GNOME2_ECLASS_ICONS} ]]; then + gnome2_icon_cache_update + fi + xdg_pkg_postinst + + if [[ -z ${I_KNOW_WHAT_I_AM_DOING} ]]; then + if [[ ${KDE_BUILD_TYPE} = live ]]; then + echo + 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 + fi +} + +# @FUNCTION: kde5_pkg_postrm +# @DESCRIPTION: +# Function to rebuild the KDE System Configuration Cache after an application has been removed. +kde5_pkg_postrm() { + debug-print-function ${FUNCNAME} "$@" + + if [[ -n ${GNOME2_ECLASS_ICONS} ]]; then + gnome2_icon_cache_update + fi + xdg_pkg_postrm +} + +fi -- cgit v1.2.3