1 # Copyright 1999-2017 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
7 # @BLURB: Support eclass for packages that follow KDE packaging conventions.
9 # This eclass is intended to streamline the creation of ebuilds for packages
10 # that follow KDE upstream packaging conventions. It's primarily intended for
11 # the three upstream release groups (Frameworks, Plasma, Applications) but
12 # is also for any package that follows similar conventions.
14 # This eclass unconditionally inherits kde5-functions.eclass and all its public
15 # functions and variables may be considered as part of this eclass's API.
17 # This eclass unconditionally inherits cmake-utils.eclass and all its public
18 # variables and helper functions (not phase functions) may be considered as part
19 # of this eclass's API.
21 # This eclass's phase functions are not intended to be mixed and matched, so if
22 # any phase functions are overriden the version here should also be called.
24 if [[ -z ${_KDE5_ECLASS} ]]; then
27 # @ECLASS-VARIABLE: VIRTUALX_REQUIRED
29 # For proper description see virtualx.eclass manpage.
30 # Here we redefine default value to be manual, if your package needs virtualx
31 # for tests you should proceed with setting VIRTUALX_REQUIRED=test.
32 : ${VIRTUALX_REQUIRED:=manual}
34 inherit cmake-utils eutils flag-o-matic gnome2-utils kde5-functions versionator virtualx xdg
36 if [[ ${KDE_BUILD_TYPE} = live ]]; then
38 git) inherit git-r3 ;;
42 if [[ -v KDE_GCC_MINIMAL ]]; then
43 EXPORT_FUNCTIONS pkg_pretend
46 EXPORT_FUNCTIONS pkg_setup pkg_nofetch src_unpack src_prepare src_configure src_compile src_test src_install pkg_preinst pkg_postinst pkg_postrm
48 # @ECLASS-VARIABLE: KDE_AUTODEPS
50 # If set to "false", do nothing.
51 # For any other value, add dependencies on dev-qt/qtcore:5, kde-frameworks/kf-env
52 # and kde-frameworks/extra-cmake-modules:5. Additionally, required blockers may
53 # be set depending on the value of CATEGORY.
54 : ${KDE_AUTODEPS:=true}
56 # @ECLASS-VARIABLE: KDE_BLOCK_SLOT4
58 # This variable only has any effect when when CATEGORY = "kde-apps" and
59 # KDE_AUTODEPS is also set. If set to "true", add RDEPEND block on kde-apps/${PN}:4
60 : ${KDE_BLOCK_SLOT4:=true}
62 # @ECLASS-VARIABLE: KDE_DEBUG
64 # If set to "false", add -DNDEBUG (via cmake-utils_src_configure) and -DQT_NO_DEBUG
66 # Otherwise, add debug to IUSE.
69 # @ECLASS-VARIABLE: KDE_DESIGNERPLUGIN
71 # If set to "false", do nothing.
72 # Otherwise, add "designer" to IUSE to toggle build of designer plugins
73 # and add the necessary DEPENDs.
74 : ${KDE_DESIGNERPLUGIN:=false}
76 # @ECLASS-VARIABLE: KDE_EXAMPLES
78 # If set to "false", unconditionally ignore a top-level examples subdirectory.
79 # Otherwise, add "examples" to IUSE to toggle adding that subdirectory.
80 : ${KDE_EXAMPLES:=false}
82 # @ECLASS-VARIABLE: KDE_HANDBOOK
84 # If set to "false", do nothing.
85 # Otherwise, add "+handbook" to IUSE, add the appropriate dependency, and
86 # generate and install KDE handbook.
87 # If set to "optional", config with -DCMAKE_DISABLE_FIND_PACKAGE_KF5DocTools=ON
88 # when USE=!handbook. In case package requires KF5KDELibs4Support, see next:
89 # If set to "forceoptional", remove a KF5DocTools dependency from the root
90 # CMakeLists.txt in addition to the above.
91 : ${KDE_HANDBOOK:=false}
93 # @ECLASS-VARIABLE: KDE_DOC_DIR
95 # Specifies the location of the KDE handbook if not the default.
98 # @ECLASS-VARIABLE: KDE_QTHELP
100 # If set to "false", do nothing.
101 # Otherwise, add "doc" to IUSE, add the appropriate dependency, generate
102 # and install Qt compressed help files with -DBUILD_QCH=ON when USE=doc.
103 if [[ ${CATEGORY} = kde-frameworks ]]; then
104 : ${KDE_QTHELP:=true}
106 : ${KDE_QTHELP:=false}
109 # @ECLASS-VARIABLE: KDE_TESTPATTERN
111 # DANGER: Only touch it if you know what you are doing.
112 # By default, matches autotest(s), unittest(s) and test(s) pattern inside
113 # cmake add_subdirectory calls.
114 : ${KDE_TESTPATTERN:="\(auto|unit\)\?tests\?"}
116 # @ECLASS-VARIABLE: KDE_TEST
118 # If set to "false", do nothing.
119 # For any other value, add test to IUSE and add a dependency on dev-qt/qttest:5.
120 # If set to "optional", configure with -DCMAKE_DISABLE_FIND_PACKAGE_Qt5Test=ON
122 # If set to "forceoptional", remove a Qt5Test dependency and comment test
123 # subdirs from the root CMakeLists.txt in addition to the above.
124 # If set to "forceoptional-recursive", remove Qt5Test dependencies and make
125 # test subdirs according to KDE_TESTPATTERN from *any* CMakeLists.txt in ${S}
126 # and below conditional on BUILD_TESTING. This is always meant as a short-term
127 # fix and creates ${T}/${P}-tests-optional.patch to refine and submit upstream.
128 if [[ ${CATEGORY} = kde-frameworks ]]; then
134 # @ECLASS-VARIABLE: KDE_SELINUX_MODULE
136 # If set to "none", do nothing.
137 # For any other value, add selinux to IUSE, and depending on that useflag
138 # add a dependency on sec-policy/selinux-${KDE_SELINUX_MODULE} to (R)DEPEND.
139 : ${KDE_SELINUX_MODULE:=none}
141 # @ECLASS-VARIABLE: KDE_SUBSLOT
143 # If set to "false", do nothing.
144 # If set to "true", add a subslot to the package, where subslot is either
145 # defined as major.minor version for kde-*/ categories or ${PV} if other.
146 # For any other value, that value will be used as subslot.
147 : ${KDE_SUBSLOT:=false}
149 # @ECLASS-VARIABLE: KDE_UNRELEASED
152 # An array of $CATEGORY-$PV pairs of packages that are unreleased upstream.
153 # Any package matching this will have fetch restriction enabled, and receive
154 # a proper error message via pkg_nofetch.
157 if [[ ${KDEBASE} = kdevelop ]]; then
158 HOMEPAGE="https://www.kdevelop.org/"
159 elif [[ ${KMNAME} = kdepim ]]; then
160 HOMEPAGE="https://www.kde.org/applications/office/kontact/"
162 HOMEPAGE="https://www.kde.org/"
169 if [[ ${CATEGORY} = kde-frameworks ]]; then
173 case ${KDE_SUBSLOT} in
180 SLOT+="/$(get_version_component_range 1-2)"
188 SLOT+="/${KDE_SUBSLOT}"
192 case ${KDE_AUTODEPS} in
195 DEPEND+=" $(add_frameworks_dep extra-cmake-modules)"
196 RDEPEND+=" >=kde-frameworks/kf-env-4"
197 COMMONDEPEND+=" $(add_qt_dep qtcore)"
202 RDEPEND+=" !<kde-apps/kde4-l10n-15.12.3-r1"
205 [[ ${KDE_BLOCK_SLOT4} = true ]] && RDEPEND+=" !kde-apps/${PN}:4"
206 [[ $(get_version_component_range 1) -ge 17 ]] && \
209 !<kde-apps/kde4-l10n-16.12.0:4
210 !kde-apps/kdepim-l10n:5
224 case ${KDE_DESIGNERPLUGIN} in
228 DEPEND+=" designer? (
229 $(add_frameworks_dep kdesignerplugin)
230 $(add_qt_dep designer)
235 case ${KDE_EXAMPLES} in
242 case ${KDE_HANDBOOK} in
246 DEPEND+=" handbook? ( $(add_frameworks_dep kdoctools) )"
250 case ${KDE_QTHELP} in
254 COMMONDEPEND+=" doc? ( $(add_qt_dep qt-docs) )"
257 >=app-doc/doxygen-1.8.13-r1
266 DEPEND+=" test? ( $(add_qt_dep qttest) )"
270 case ${KDE_SELINUX_MODULE} in
274 RDEPEND+=" selinux? ( sec-policy/selinux-${KDE_SELINUX_MODULE} )"
278 DEPEND+=" ${COMMONDEPEND} dev-util/desktop-file-utils"
279 RDEPEND+=" ${COMMONDEPEND}"
282 if [[ -n ${KMNAME} && ${KMNAME} != ${PN} && ${KDE_BUILD_TYPE} = release ]]; then
283 S=${WORKDIR}/${KMNAME}-${PV}
286 if [[ -n ${KDEBASE} && ${KDEBASE} = kdevelop && ${KDE_BUILD_TYPE} = release ]]; then
287 if [[ -n ${KMNAME} ]]; then
288 S=${WORKDIR}/${KMNAME}-${PV}
294 _kde_is_unreleased() {
296 for pair in "${KDE_UNRELEASED[@]}" ; do
297 if [[ "${pair}" = "${CATEGORY}-${PV}" ]]; then
305 # Determine fetch location for released tarballs
306 _calculate_src_uri() {
307 debug-print-function ${FUNCNAME} "$@"
311 if [[ -n ${KMNAME} ]]; then
324 _kmname="portingAids/${_kmname}"
328 DEPEND+=" app-arch/xz-utils"
333 ??.?.[6-9]? | ??.??.[6-9]? )
334 SRC_URI="mirror://kde/unstable/applications/${PV}/src/${_kmname}-${PV}.tar.xz"
338 SRC_URI="mirror://kde/stable/applications/${PV}/src/${_kmname}-${PV}.tar.xz" ;;
342 SRC_URI="mirror://kde/stable/frameworks/${PV%.*}/${_kmname}-${PV}.tar.xz" ;;
344 local plasmapv=$(get_version_component_range 1-3)
348 # Plasma 5 beta releases
349 SRC_URI="mirror://kde/unstable/plasma/${plasmapv}/${_kmname}-${PV}.tar.xz"
353 # Plasma 5 stable releases
354 SRC_URI="mirror://kde/stable/plasma/${plasmapv}/${_kmname}-${PV}.tar.xz" ;;
359 if [[ -z ${SRC_URI} && -n ${KDEBASE} ]] ; then
365 _kdebase=${KDEBASE} ;;
369 SRC_URI="mirror://kde/unstable/${_kdebase}/${PV}/src/${_kmname}-${PV}.tar.xz"
373 SRC_URI="mirror://kde/stable/${_kdebase}/${PV}/src/${_kmname}-${PV}.tar.xz" ;;
378 if _kde_is_unreleased ; then
383 # Determine fetch location for live sources
384 _calculate_live_repo() {
385 debug-print-function ${FUNCNAME} "$@"
391 # @ECLASS-VARIABLE: EGIT_MIRROR
393 # This variable allows easy overriding of default kde mirror service
394 # (anongit) with anything else you might want to use.
395 EGIT_MIRROR=${EGIT_MIRROR:=https://anongit.kde.org}
399 # @ECLASS-VARIABLE: EGIT_REPONAME
401 # This variable allows overriding of default repository
402 # name. Specify only if this differ from PN and KMNAME.
403 if [[ -n ${EGIT_REPONAME} ]]; then
404 # the repository and kmname different
405 _kmname=${EGIT_REPONAME}
406 elif [[ -n ${KMNAME} ]]; then
412 if [[ ${PV} == ??.??.49.9999 && ${CATEGORY} = kde-apps ]]; then
413 EGIT_BRANCH="Applications/$(get_version_component_range 1-2)"
416 if [[ ${PV} != 9999 && ${CATEGORY} = kde-plasma ]]; then
417 EGIT_BRANCH="Plasma/$(get_version_component_range 1-2)"
420 EGIT_REPO_URI="${EGIT_MIRROR}/${_kmname}"
425 case ${KDE_BUILD_TYPE} in
426 live) _calculate_live_repo ;;
427 *) _calculate_src_uri ;;
430 debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: SRC_URI is ${SRC_URI}"
432 # @FUNCTION: kde5_pkg_pretend
434 # Checks if the active compiler meets the minimum version requirements.
435 # phase function is only exported if KDE_GCC_MINIMAL is defined.
437 debug-print-function ${FUNCNAME} "$@"
441 # @FUNCTION: kde5_pkg_setup
443 # Checks if the active compiler meets the minimum version requirements.
445 debug-print-function ${FUNCNAME} "$@"
449 # @FUNCTION: kde5_pkg_nofetch
451 # Intended for use in the KDE overlay. If this package matches something in
452 # KDE_UNRELEASED, display a giant warning that the package has not yet been
453 # released upstream and should not be used.
455 if ! _kde_is_unreleased ; then
459 eerror " _ _ _ _ ____ _____ _ _____ _ ____ _____ ____ "
460 eerror "| | | | \ | | _ \| ____| | | ____| / \ / ___|| ____| _ \ "
461 eerror "| | | | \| | |_) | _| | | | _| / _ \ \___ \| _| | | | |"
462 eerror "| |_| | |\ | _ <| |___| |___| |___ / ___ \ ___) | |___| |_| |"
463 eerror " \___/|_| \_|_| \_\_____|_____|_____/_/ \_\____/|_____|____/ "
465 eerror " ____ _ ____ _ __ _ ____ _____ "
466 eerror "| _ \ / \ / ___| |/ / / \ / ___| ____|"
467 eerror "| |_) / _ \| | | ' / / _ \| | _| _| "
468 eerror "| __/ ___ \ |___| . \ / ___ \ |_| | |___ "
469 eerror "|_| /_/ \_\____|_|\_\/_/ \_\____|_____|"
471 eerror "${CATEGORY}/${P} has not been released to the public yet"
472 eerror "and is only available to packagers right now."
474 eerror "This is not a bug. Please do not file bugs or contact upstream about this."
476 eerror "Please consult the upstream release schedule to see when this "
477 eerror "package is scheduled to be released:"
478 eerror "https://community.kde.org/Schedules"
481 # @FUNCTION: kde5_src_unpack
483 # Unpack the sources, automatically handling both release and live ebuilds.
485 debug-print-function ${FUNCNAME} "$@"
487 if [[ ${KDE_BUILD_TYPE} = live ]]; then
498 # @FUNCTION: kde5_src_prepare
500 # Wrapper for cmake-utils_src_prepare with lots of extra logic for magic
501 # handling of linguas, tests, handbook etc.
503 debug-print-function ${FUNCNAME} "$@"
505 cmake-utils_src_prepare
507 # only build examples when required
508 if ! use_if_iuse examples || ! use examples ; then
509 cmake_comment_add_subdirectory examples
512 # only enable handbook when required
513 if ! use_if_iuse handbook ; then
514 cmake_comment_add_subdirectory ${KDE_DOC_DIR}
516 if [[ ${KDE_HANDBOOK} = forceoptional ]] ; then
517 punt_bogus_dep KF5 DocTools
518 sed -i -e "/kdoctools_install/ s/^/#DONT/" CMakeLists.txt || die
522 # drop translations when nls is not wanted
523 if in_iuse nls && ! use nls ; then
524 if [[ -d po ]] ; then
527 if [[ -d poqm ]] ; then
532 # enable only the requested translations when required
533 if [[ -v LINGUAS ]] ; then
535 for po in po poqm; do
536 if [[ -d ${po} ]] ; then
537 pushd ${po} > /dev/null || die
540 if [[ -e ${lang} ]] && ! has ${lang/.po/} ${LINGUAS} ; then
545 *) rm -r ${lang} || die ;;
547 if [[ -e CMakeLists.txt ]] ; then
548 cmake_comment_add_subdirectory ${lang}
549 sed -e "/add_subdirectory([[:space:]]*${lang}\/.*[[:space:]]*)/d" \
550 -i CMakeLists.txt || die
554 popd > /dev/null || die
559 if [[ ${KDE_BUILD_TYPE} = release && ${CATEGORY} != kde-apps ]] ; then
560 if [[ ${KDE_HANDBOOK} != false && -d ${KDE_DOC_DIR} && -v LINGUAS ]] ; then
561 pushd ${KDE_DOC_DIR} > /dev/null || die
564 if ! has ${lang} ${LINGUAS} ; then
565 cmake_comment_add_subdirectory ${lang}
568 popd > /dev/null || die
572 # only build unit tests when required
573 if ! use_if_iuse test ; then
574 if [[ ${KDE_TEST} = forceoptional ]] ; then
575 punt_bogus_dep Qt5 Test
576 # if forceoptional, also cover non-kde categories
577 cmake_comment_add_subdirectory autotests test tests
578 elif [[ ${KDE_TEST} = forceoptional-recursive ]] ; then
579 punt_bogus_dep Qt5 Test
580 local f pf="${T}/${P}"-tests-optional.patch
581 touch ${pf} || die "Failed to touch patch file"
582 for f in $(find . -type f -name "CMakeLists.txt" -exec \
583 grep -l "^\s*add_subdirectory\s*\(\s*.*${KDE_TESTPATTERN}\s*)\s*\)" {} \;); do
584 cp ${f} ${f}.old || die "Failed to prepare patch origfile"
585 pushd ${f%/*} > /dev/null || die
586 punt_bogus_dep Qt5 Test
587 sed -i CMakeLists.txt -e \
588 "/^#/! s/add_subdirectory\s*\(\s*.*${KDE_TESTPATTERN}\s*)\s*\)/if(BUILD_TESTING)\n&\nendif()/" \
590 popd > /dev/null || die
591 diff -Naur ${f}.old ${f} 1>>${pf}
592 rm ${f}.old || die "Failed to clean up"
594 einfo "Build system was modified by KDE_TEST=forceoptional-recursive."
595 einfo "Unified diff file ready for pickup in:"
597 einfo "Push it upstream to make this message go away."
598 elif [[ ${CATEGORY} = kde-frameworks || ${CATEGORY} = kde-plasma || ${CATEGORY} = kde-apps ]] ; then
599 cmake_comment_add_subdirectory autotests test tests
603 # in frameworks, tests = manual tests so never build them
604 if [[ ${CATEGORY} = kde-frameworks ]] && [[ ${PN} != extra-cmake-modules ]]; then
605 cmake_comment_add_subdirectory tests
609 # @FUNCTION: kde5_src_configure
611 # Wrapper for cmake-utils_src_configure with extra logic for magic handling of
612 # handbook, tests etc.
613 kde5_src_configure() {
614 debug-print-function ${FUNCNAME} "$@"
616 # we rely on cmake-utils.eclass to append -DNDEBUG too
617 if ! use_if_iuse debug; then
618 append-cppflags -DQT_NO_DEBUG
623 if in_iuse test && ! use test ; then
624 cmakeargs+=( -DBUILD_TESTING=OFF )
626 if [[ ${KDE_TEST} = optional ]] ; then
627 cmakeargs+=( -DCMAKE_DISABLE_FIND_PACKAGE_Qt5Test=ON )
631 if ! use_if_iuse handbook && [[ ${KDE_HANDBOOK} = optional ]] ; then
632 cmakeargs+=( -DCMAKE_DISABLE_FIND_PACKAGE_KF5DocTools=ON )
635 if ! use_if_iuse designer && [[ ${KDE_DESIGNERPLUGIN} != false ]] ; then
636 cmakeargs+=( -DCMAKE_DISABLE_FIND_PACKAGE_Qt5Designer=ON )
639 if [[ ${KDE_QTHELP} != false ]]; then
640 cmakeargs+=( -DBUILD_QCH=$(usex doc) )
643 # install mkspecs in the same directory as qt stuff
644 cmakeargs+=(-DKDE_INSTALL_USE_QT_SYS_PATHS=ON)
646 # allow the ebuild to override what we set here
647 mycmakeargs=("${cmakeargs[@]}" "${mycmakeargs[@]}")
649 cmake-utils_src_configure
652 # @FUNCTION: kde5_src_compile
654 # Wrapper for cmake-utils_src_compile. Currently doesn't do anything extra, but
655 # is included as part of the API just in case it's needed in the future.
657 debug-print-function ${FUNCNAME} "$@"
659 cmake-utils_src_compile "$@"
662 # @FUNCTION: kde5_src_test
664 # Wrapper for cmake-utils_src_test with extra logic for magic handling of dbus
667 debug-print-function ${FUNCNAME} "$@"
670 if [[ -n "${VIRTUALDBUS_TEST}" ]]; then
671 export $(dbus-launch)
677 # When run as normal user during ebuild development with the ebuild command, the
678 # kde tests tend to access the session DBUS. This however is not possible in a real
679 # emerge or on the tinderbox.
680 # > make sure it does not happen, so bad tests can be recognized and disabled
681 unset DBUS_SESSION_BUS_ADDRESS DBUS_SESSION_BUS_PID
683 if [[ ${VIRTUALX_REQUIRED} = always || ${VIRTUALX_REQUIRED} = test ]]; then
689 if [[ -n "${DBUS_SESSION_BUS_PID}" ]] ; then
690 kill ${DBUS_SESSION_BUS_PID}
694 # @FUNCTION: kde5_src_install
696 # Wrapper for cmake-utils_src_install with extra logic to avoid compressing
697 # certain types of files. For example, khelpcenter is not able to read
698 # compressed handbooks.
700 debug-print-function ${FUNCNAME} "$@"
702 cmake-utils_src_install
704 # We don't want QCH and tags files to be compressed, because then
705 # cmake can't find the tags and qthelp viewers can't find the docs
706 local p=$(best_version dev-qt/qtcore:5)
707 local pv=$(echo ${p/%-r[0-9]*/} | rev | cut -d - -f 1 | rev)
708 if [[ -d ${ED%/}/usr/share/doc/qt-${pv} ]]; then
709 docompress -x /usr/share/doc/qt-${pv}
712 # We don't want /usr/share/doc/HTML to be compressed,
713 # because then khelpcenter can't find the docs
714 if [[ -d ${ED%/}/usr/share/doc/HTML ]]; then
715 docompress -x /usr/share/doc/HTML
719 # @FUNCTION: kde5_pkg_preinst
721 # Sets up environment variables required in kde5_pkg_postinst.
723 debug-print-function ${FUNCNAME} "$@"
729 # @FUNCTION: kde5_pkg_postinst
731 # Updates the various XDG caches (icon, desktop, mime) if necessary.
732 kde5_pkg_postinst() {
733 debug-print-function ${FUNCNAME} "$@"
735 if [[ -n ${GNOME2_ECLASS_ICONS} ]]; then
736 gnome2_icon_cache_update
740 if [[ -z ${I_KNOW_WHAT_I_AM_DOING} ]]; then
741 if [[ ${KDE_BUILD_TYPE} = live ]]; then
743 einfo "WARNING! This is an experimental live ebuild of ${CATEGORY}/${PN}"
744 einfo "Use it at your own risk."
745 einfo "Do _NOT_ file bugs at bugs.gentoo.org because of this ebuild!"
750 # @FUNCTION: kde5_pkg_postrm
752 # Updates the various XDG caches (icon, desktop, mime) if necessary.
754 debug-print-function ${FUNCNAME} "$@"
756 if [[ -n ${GNOME2_ECLASS_ICONS} ]]; then
757 gnome2_icon_cache_update