kde5.eclass: Cleanup obsolete blocker
[gentoo.git] / eclass / kde5.eclass
1 # Copyright 1999-2018 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
3
4 # @ECLASS: kde5.eclass
5 # @MAINTAINER:
6 # kde@gentoo.org
7 # @BLURB: Support eclass for packages that follow KDE packaging conventions.
8 # @DESCRIPTION:
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.
13 #
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.
16 #
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.
20 #
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.
23
24 if [[ -z ${_KDE5_ECLASS} ]]; then
25 _KDE5_ECLASS=1
26
27 # @ECLASS-VARIABLE: VIRTUALX_REQUIRED
28 # @DESCRIPTION:
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}
33
34 inherit cmake-utils eutils flag-o-matic gnome2-utils kde5-functions versionator virtualx xdg
35
36 if [[ ${KDE_BUILD_TYPE} = live ]]; then
37         case ${KDE_SCM} in
38                 git) inherit git-r3 ;;
39         esac
40 fi
41
42 if [[ -v KDE_GCC_MINIMAL ]]; then
43         EXPORT_FUNCTIONS pkg_pretend
44 fi
45
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
47
48 # @ECLASS-VARIABLE: KDE_AUTODEPS
49 # @DESCRIPTION:
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}
55
56 # @ECLASS-VARIABLE: KDE_BLOCK_SLOT4
57 # @DESCRIPTION:
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}
61
62 # @ECLASS-VARIABLE: KDE_DEBUG
63 # @DESCRIPTION:
64 # If set to "false", add -DNDEBUG (via cmake-utils_src_configure) and -DQT_NO_DEBUG
65 # to CPPFLAGS.
66 # Otherwise, add debug to IUSE.
67 : ${KDE_DEBUG:=true}
68
69 # @ECLASS-VARIABLE: KDE_DESIGNERPLUGIN
70 # @DESCRIPTION:
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}
75
76 # @ECLASS-VARIABLE: KDE_EXAMPLES
77 # @DESCRIPTION:
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}
81
82 # @ECLASS-VARIABLE: KDE_HANDBOOK
83 # @DESCRIPTION:
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}
92
93 # @ECLASS-VARIABLE: KDE_DOC_DIR
94 # @DESCRIPTION:
95 # Specifies the location of the KDE handbook if not the default.
96 : ${KDE_DOC_DIR:=doc}
97
98 # @ECLASS-VARIABLE: KDE_PO_DIRS
99 # @DESCRIPTION:
100 # Specifies the possible locations of KDE l10n files if not the default.
101 : ${KDE_PO_DIRS:="po poqm"}
102
103 # @ECLASS-VARIABLE: KDE_QTHELP
104 # @DESCRIPTION:
105 # If set to "false", do nothing.
106 # Otherwise, add "doc" to IUSE, add the appropriate dependency, generate
107 # and install Qt compressed help files with -DBUILD_QCH=ON when USE=doc.
108 if [[ ${CATEGORY} = kde-frameworks ]]; then
109         : ${KDE_QTHELP:=true}
110 fi
111 : ${KDE_QTHELP:=false}
112
113 # @ECLASS-VARIABLE: KDE_TESTPATTERN
114 # @DESCRIPTION:
115 # DANGER: Only touch it if you know what you are doing.
116 # By default, matches autotest(s), unittest(s) and test(s) pattern inside
117 # cmake add_subdirectory calls.
118 : ${KDE_TESTPATTERN:="\(auto|unit\)\?tests\?"}
119
120 # @ECLASS-VARIABLE: KDE_TEST
121 # @DESCRIPTION:
122 # If set to "false", do nothing.
123 # For any other value, add test to IUSE and add a dependency on dev-qt/qttest:5.
124 # If set to "optional", configure with -DCMAKE_DISABLE_FIND_PACKAGE_Qt5Test=ON
125 # when USE=!test.
126 # If set to "forceoptional", remove a Qt5Test dependency and comment test
127 # subdirs from the root CMakeLists.txt in addition to the above.
128 # If set to "forceoptional-recursive", remove Qt5Test dependencies and make
129 # test subdirs according to KDE_TESTPATTERN from *any* CMakeLists.txt in ${S}
130 # and below conditional on BUILD_TESTING. This is always meant as a short-term
131 # fix and creates ${T}/${P}-tests-optional.patch to refine and submit upstream.
132 if [[ ${CATEGORY} = kde-frameworks ]]; then
133         : ${KDE_TEST:=true}
134 fi
135 : ${KDE_TEST:=false}
136
137 # @ECLASS-VARIABLE: KDE_SELINUX_MODULE
138 # @DESCRIPTION:
139 # If set to "none", do nothing.
140 # For any other value, add selinux to IUSE, and depending on that useflag
141 # add a dependency on sec-policy/selinux-${KDE_SELINUX_MODULE} to (R)DEPEND.
142 : ${KDE_SELINUX_MODULE:=none}
143
144 # @ECLASS-VARIABLE: KDE_SUBSLOT
145 # @DESCRIPTION:
146 # If set to "false", do nothing.
147 # If set to "true", add a subslot to the package, where subslot is either
148 # defined as major.minor version for kde-*/ categories or ${PV} if other.
149 # For any other value, that value will be used as subslot.
150 : ${KDE_SUBSLOT:=false}
151
152 # @ECLASS-VARIABLE: KDE_UNRELEASED
153 # @INTERNAL
154 # @DESCRIPTION
155 # An array of $CATEGORY-$PV pairs of packages that are unreleased upstream.
156 # Any package matching this will have fetch restriction enabled, and receive
157 # a proper error message via pkg_nofetch.
158 KDE_UNRELEASED=( )
159
160 if [[ ${KDEBASE} = kdevelop ]]; then
161         HOMEPAGE="https://www.kdevelop.org/"
162 elif [[ ${KMNAME} = kdepim ]]; then
163         HOMEPAGE="https://www.kde.org/applications/office/kontact/"
164 else
165         HOMEPAGE="https://www.kde.org/"
166 fi
167
168 LICENSE="GPL-2"
169
170 SLOT=5
171
172 if [[ ${CATEGORY} = kde-frameworks ]]; then
173         KDE_SUBSLOT=true
174 fi
175
176 case ${KDE_SUBSLOT} in
177         false)  ;;
178         true)
179                 case ${CATEGORY} in
180                         kde-frameworks | \
181                         kde-plasma | \
182                         kde-apps)
183                                 SLOT+="/$(get_version_component_range 1-2)"
184                                 ;;
185                         *)
186                                 SLOT+="/${PV}"
187                                 ;;
188                 esac
189                 ;;
190         *)
191                 SLOT+="/${KDE_SUBSLOT}"
192                 ;;
193 esac
194
195 case ${KDE_AUTODEPS} in
196         false)  ;;
197         *)
198                 DEPEND+=" $(add_frameworks_dep extra-cmake-modules)"
199                 RDEPEND+=" >=kde-frameworks/kf-env-4"
200                 COMMONDEPEND+=" $(add_qt_dep qtcore)"
201
202                 # all packages need breeze/oxygen icons for basic iconset, bug #564838
203                 if [[ ${PN} != breeze-icons && ${PN} != oxygen-icons ]]; then
204                         RDEPEND+=" || ( $(add_frameworks_dep breeze-icons) kde-frameworks/oxygen-icons:* )"
205                 fi
206
207                 if [[ ${CATEGORY} = kde-apps ]]; then
208                         [[ ${KDE_BLOCK_SLOT4} = true ]] && RDEPEND+=" !kde-apps/${PN}:4"
209                         RDEPEND+="
210                                 !kde-apps/kde-l10n
211                                 !<kde-apps/kde4-l10n-16.12.0:4
212                                 !kde-apps/kdepim-l10n:5
213                         "
214                 fi
215                 ;;
216 esac
217
218 case ${KDE_DEBUG} in
219         false)  ;;
220         *)
221                 IUSE+=" debug"
222                 ;;
223 esac
224
225 case ${KDE_DESIGNERPLUGIN} in
226         false)  ;;
227         *)
228                 IUSE+=" designer"
229                 DEPEND+=" designer? ( $(add_frameworks_dep kdesignerplugin) )"
230                 [[ ${PV} = 17.08* ]] && \
231                         DEPEND+=" designer? ( $(add_qt_dep designer) )"
232                 ;;
233 esac
234
235 case ${KDE_EXAMPLES} in
236         false)  ;;
237         *)
238                 IUSE+=" examples"
239                 ;;
240 esac
241
242 case ${KDE_HANDBOOK} in
243         false)  ;;
244         *)
245                 IUSE+=" +handbook"
246                 DEPEND+=" handbook? ( $(add_frameworks_dep kdoctools) )"
247                 ;;
248 esac
249
250 case ${KDE_QTHELP} in
251         false)  ;;
252         *)
253                 IUSE+=" doc"
254                 COMMONDEPEND+=" doc? ( $(add_qt_dep qt-docs) )"
255                 DEPEND+=" doc? (
256                         $(add_qt_dep qthelp)
257                         >=app-doc/doxygen-1.8.13-r1
258                 )"
259                 ;;
260 esac
261
262 case ${KDE_TEST} in
263         false)  ;;
264         *)
265                 IUSE+=" test"
266                 DEPEND+=" test? ( $(add_qt_dep qttest) )"
267                 ;;
268 esac
269
270 case ${KDE_SELINUX_MODULE} in
271         none)   ;;
272         *)
273                 IUSE+=" selinux"
274                 RDEPEND+=" selinux? ( sec-policy/selinux-${KDE_SELINUX_MODULE} )"
275                 ;;
276 esac
277
278 DEPEND+=" ${COMMONDEPEND} dev-util/desktop-file-utils"
279 RDEPEND+=" ${COMMONDEPEND}"
280 unset COMMONDEPEND
281
282 if [[ -n ${KMNAME} && ${KMNAME} != ${PN} && ${KDE_BUILD_TYPE} = release ]]; then
283         S=${WORKDIR}/${KMNAME}-${PV}
284 fi
285
286 if [[ -n ${KDEBASE} && ${KDEBASE} = kdevelop && ${KDE_BUILD_TYPE} = release ]]; then
287         if [[ -n ${KMNAME} ]]; then
288                 S=${WORKDIR}/${KMNAME}-${PV}
289         else
290                 S=${WORKDIR}/${P}
291         fi
292 fi
293
294 _kde_is_unreleased() {
295         local pair
296         for pair in "${KDE_UNRELEASED[@]}" ; do
297                 if [[ "${pair}" = "${CATEGORY}-${PV}" ]]; then
298                         return 0
299                 fi
300         done
301
302         return 1
303 }
304
305 # Determine fetch location for released tarballs
306 _calculate_src_uri() {
307         debug-print-function ${FUNCNAME} "$@"
308
309         local _kmname
310
311         if [[ -n ${KMNAME} ]]; then
312                 _kmname=${KMNAME}
313         else
314                 _kmname=${PN}
315         fi
316
317         case ${PN} in
318                 kdelibs4support | \
319                 khtml | \
320                 kjs | \
321                 kjsembed | \
322                 kmediaplayer | \
323                 kross)
324                         _kmname="portingAids/${_kmname}"
325                         ;;
326         esac
327
328         DEPEND+=" app-arch/xz-utils"
329
330         case ${CATEGORY} in
331                 kde-apps)
332                         case ${PV} in
333                                 ??.?.[6-9]? | ??.??.[6-9]? )
334                                         SRC_URI="mirror://kde/unstable/applications/${PV}/src/${_kmname}-${PV}.tar.xz"
335                                         RESTRICT+=" mirror"
336                                         ;;
337                                 *)
338                                         SRC_URI="mirror://kde/stable/applications/${PV}/src/${_kmname}-${PV}.tar.xz" ;;
339                         esac
340                         ;;
341                 kde-frameworks)
342                         SRC_URI="mirror://kde/stable/frameworks/${PV%.*}/${_kmname}-${PV}.tar.xz" ;;
343                 kde-plasma)
344                         local plasmapv=$(get_version_component_range 1-3)
345
346                         case ${PV} in
347                                 5.?.[6-9]? | 5.??.[6-9]? )
348                                         # Plasma 5 beta releases
349                                         SRC_URI="mirror://kde/unstable/plasma/${plasmapv}/${_kmname}-${PV}.tar.xz"
350                                         RESTRICT+=" mirror"
351                                         ;;
352                                 *)
353                                         # Plasma 5 stable releases
354                                         SRC_URI="mirror://kde/stable/plasma/${plasmapv}/${_kmname}-${PV}.tar.xz" ;;
355                         esac
356                         ;;
357         esac
358
359         if [[ -z ${SRC_URI} && -n ${KDEBASE} ]] ; then
360                 local _kdebase
361                 case ${PN} in
362                         kdevelop-pg-qt)
363                                 _kdebase=${PN} ;;
364                         *)
365                                 _kdebase=${KDEBASE} ;;
366                 esac
367                 case ${PV} in
368                         *.*.[6-9]? )
369                                 SRC_URI="mirror://kde/unstable/${_kdebase}/${PV}/src/${_kmname}-${PV}.tar.xz"
370                                 RESTRICT+=" mirror"
371                                 ;;
372                         *)
373                                 SRC_URI="mirror://kde/stable/${_kdebase}/${PV}/src/${_kmname}-${PV}.tar.xz" ;;
374                 esac
375                 unset _kdebase
376         fi
377
378         if _kde_is_unreleased ; then
379                 RESTRICT+=" fetch"
380         fi
381 }
382
383 # Determine fetch location for live sources
384 _calculate_live_repo() {
385         debug-print-function ${FUNCNAME} "$@"
386
387         SRC_URI=""
388
389         case ${KDE_SCM} in
390                 git)
391                         # @ECLASS-VARIABLE: EGIT_MIRROR
392                         # @DESCRIPTION:
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}
396
397                         local _kmname
398
399                         # @ECLASS-VARIABLE: EGIT_REPONAME
400                         # @DESCRIPTION:
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
407                                 _kmname=${KMNAME}
408                         else
409                                 _kmname=${PN}
410                         fi
411
412                         if [[ ${PV} == ??.??.49.9999 && ${CATEGORY} = kde-apps ]]; then
413                                 EGIT_BRANCH="Applications/$(get_version_component_range 1-2)"
414                         fi
415
416                         if [[ ${PV} != 9999 && ${CATEGORY} = kde-plasma ]]; then
417                                 EGIT_BRANCH="Plasma/$(get_version_component_range 1-2)"
418                         fi
419
420                         EGIT_REPO_URI="${EGIT_MIRROR}/${_kmname}"
421                         ;;
422         esac
423 }
424
425 case ${KDE_BUILD_TYPE} in
426         live) _calculate_live_repo ;;
427         *) _calculate_src_uri ;;
428 esac
429
430 debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: SRC_URI is ${SRC_URI}"
431
432 # @FUNCTION: kde5_pkg_pretend
433 # @DESCRIPTION:
434 # Checks if the active compiler meets the minimum version requirements.
435 # phase function is only exported if KDE_GCC_MINIMAL is defined.
436 kde5_pkg_pretend() {
437         debug-print-function ${FUNCNAME} "$@"
438         _check_gcc_version
439 }
440
441 # @FUNCTION: kde5_pkg_setup
442 # @DESCRIPTION:
443 # Checks if the active compiler meets the minimum version requirements.
444 kde5_pkg_setup() {
445         debug-print-function ${FUNCNAME} "$@"
446         _check_gcc_version
447 }
448
449 # @FUNCTION: kde5_pkg_nofetch
450 # @DESCRIPTION:
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.
454 kde5_pkg_nofetch() {
455         if ! _kde_is_unreleased ; then
456                 return
457         fi
458
459         eerror " _   _ _   _ ____  _____ _     _____    _    ____  _____ ____  "
460         eerror "| | | | \ | |  _ \| ____| |   | ____|  / \  / ___|| ____|  _ \ "
461         eerror "| | | |  \| | |_) |  _| | |   |  _|   / _ \ \___ \|  _| | | | |"
462         eerror "| |_| | |\  |  _ <| |___| |___| |___ / ___ \ ___) | |___| |_| |"
463         eerror " \___/|_| \_|_| \_\_____|_____|_____/_/   \_\____/|_____|____/ "
464         eerror "                                                               "
465         eerror " ____   _    ____ _  __    _    ____ _____ "
466         eerror "|  _ \ / \  / ___| |/ /   / \  / ___| ____|"
467         eerror "| |_) / _ \| |   | ' /   / _ \| |  _|  _|  "
468         eerror "|  __/ ___ \ |___| . \  / ___ \ |_| | |___ "
469         eerror "|_| /_/   \_\____|_|\_\/_/   \_\____|_____|"
470         eerror
471         eerror "${CATEGORY}/${P} has not been released to the public yet"
472         eerror "and is only available to packagers right now."
473         eerror ""
474         eerror "This is not a bug. Please do not file bugs or contact upstream about this."
475         eerror ""
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"
479 }
480
481 # @FUNCTION: kde5_src_unpack
482 # @DESCRIPTION:
483 # Unpack the sources, automatically handling both release and live ebuilds.
484 kde5_src_unpack() {
485         debug-print-function ${FUNCNAME} "$@"
486
487         if [[ ${KDE_BUILD_TYPE} = live ]]; then
488                 case ${KDE_SCM} in
489                         git)
490                                 git-r3_src_unpack
491                                 ;;
492                 esac
493         else
494                 default
495         fi
496 }
497
498 # @FUNCTION: kde5_src_prepare
499 # @DESCRIPTION:
500 # Wrapper for cmake-utils_src_prepare with lots of extra logic for magic
501 # handling of linguas, tests, handbook etc.
502 kde5_src_prepare() {
503         debug-print-function ${FUNCNAME} "$@"
504
505         cmake-utils_src_prepare
506
507         # only build examples when required
508         if ! use_if_iuse examples || ! use examples ; then
509                 cmake_comment_add_subdirectory examples
510         fi
511
512         # only enable handbook when required
513         if ! use_if_iuse handbook ; then
514                 cmake_comment_add_subdirectory ${KDE_DOC_DIR}
515
516                 if [[ ${KDE_HANDBOOK} = forceoptional ]] ; then
517                         punt_bogus_dep KF5 DocTools
518                         sed -i -e "/kdoctools_install/ s/^/#DONT/" CMakeLists.txt || die
519                 fi
520         fi
521
522         # drop translations when nls is not wanted
523         if in_iuse nls && ! use nls ; then
524                 local po
525                 for po in ${KDE_PO_DIRS}; do
526                         if [[ -d ${po} ]] ; then
527                                 rm -r ${po} || die
528                         fi
529                 done
530         fi
531
532         # enable only the requested translations when required
533         if [[ -v LINGUAS ]] ; then
534                 local po
535                 for po in ${KDE_PO_DIRS}; do
536                 if [[ -d ${po} ]] ; then
537                         pushd ${po} > /dev/null || die
538                         local lang
539                         for lang in *; do
540                                 if [[ -e ${lang} ]] && ! has ${lang/.po/} ${LINGUAS} ; then
541                                         case ${lang} in
542                                                 cmake_modules | \
543                                                 CMakeLists.txt | \
544                                                 ${PN}.pot)      ;;
545                                                 *) rm -r ${lang} || die ;;
546                                         esac
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
551                                         fi
552                                 fi
553                         done
554                         popd > /dev/null || die
555                 fi
556                 done
557         fi
558
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
562                         local lang
563                         for lang in *; do
564                                 if ! has ${lang} ${LINGUAS} ; then
565                                         cmake_comment_add_subdirectory ${lang}
566                                 fi
567                         done
568                         popd > /dev/null || die
569                 fi
570         fi
571
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()/" \
589                                                 || die
590                                 popd > /dev/null || die
591                                 diff -Naur ${f}.old ${f} 1>>${pf}
592                                 rm ${f}.old || die "Failed to clean up"
593                         done
594                         einfo "Build system was modified by KDE_TEST=forceoptional-recursive."
595                         einfo "Unified diff file ready for pickup in:"
596                         einfo "  ${pf}"
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
600                 fi
601         fi
602
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
606         fi
607 }
608
609 # @FUNCTION: kde5_src_configure
610 # @DESCRIPTION:
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} "$@"
615
616         # we rely on cmake-utils.eclass to append -DNDEBUG too
617         if ! use_if_iuse debug; then
618                 append-cppflags -DQT_NO_DEBUG
619         fi
620
621         local cmakeargs
622
623         if in_iuse test && ! use test ; then
624                 cmakeargs+=( -DBUILD_TESTING=OFF )
625
626                 if [[ ${KDE_TEST} = optional ]] ; then
627                         cmakeargs+=( -DCMAKE_DISABLE_FIND_PACKAGE_Qt5Test=ON )
628                 fi
629         fi
630
631         if ! use_if_iuse handbook && [[ ${KDE_HANDBOOK} = optional ]] ; then
632                 cmakeargs+=( -DCMAKE_DISABLE_FIND_PACKAGE_KF5DocTools=ON )
633         fi
634
635         if ! use_if_iuse designer && [[ ${KDE_DESIGNERPLUGIN} != false ]] ; then
636                 if [[ ${PV} = 17.08* ]]; then
637                         cmakeargs+=( -DCMAKE_DISABLE_FIND_PACKAGE_Qt5Designer=ON )
638                 else
639                         cmakeargs+=( -DCMAKE_DISABLE_FIND_PACKAGE_KF5DesignerPlugin=ON )
640                 fi
641         fi
642
643         if [[ ${KDE_QTHELP} != false ]]; then
644                 cmakeargs+=( -DBUILD_QCH=$(usex doc) )
645         fi
646
647         # install mkspecs in the same directory as qt stuff
648         cmakeargs+=(-DKDE_INSTALL_USE_QT_SYS_PATHS=ON)
649
650         # allow the ebuild to override what we set here
651         mycmakeargs=("${cmakeargs[@]}" "${mycmakeargs[@]}")
652
653         cmake-utils_src_configure
654 }
655
656 # @FUNCTION: kde5_src_compile
657 # @DESCRIPTION:
658 # Wrapper for cmake-utils_src_compile. Currently doesn't do anything extra, but
659 # is included as part of the API just in case it's needed in the future.
660 kde5_src_compile() {
661         debug-print-function ${FUNCNAME} "$@"
662
663         cmake-utils_src_compile "$@"
664 }
665
666 # @FUNCTION: kde5_src_test
667 # @DESCRIPTION:
668 # Wrapper for cmake-utils_src_test with extra logic for magic handling of dbus
669 # and virtualx.
670 kde5_src_test() {
671         debug-print-function ${FUNCNAME} "$@"
672
673         _test_runner() {
674                 if [[ -n "${VIRTUALDBUS_TEST}" ]]; then
675                         export $(dbus-launch)
676                 fi
677
678                 cmake-utils_src_test
679         }
680
681         # When run as normal user during ebuild development with the ebuild command, the
682         # kde tests tend to access the session DBUS. This however is not possible in a real
683         # emerge or on the tinderbox.
684         # > make sure it does not happen, so bad tests can be recognized and disabled
685         unset DBUS_SESSION_BUS_ADDRESS DBUS_SESSION_BUS_PID
686
687         if [[ ${VIRTUALX_REQUIRED} = always || ${VIRTUALX_REQUIRED} = test ]]; then
688                 virtx _test_runner
689         else
690                 _test_runner
691         fi
692
693         if [[ -n "${DBUS_SESSION_BUS_PID}" ]] ; then
694                 kill ${DBUS_SESSION_BUS_PID}
695         fi
696 }
697
698 # @FUNCTION: kde5_src_install
699 # @DESCRIPTION:
700 # Wrapper for cmake-utils_src_install with extra logic to avoid compressing
701 # certain types of files. For example, khelpcenter is not able to read
702 # compressed handbooks.
703 kde5_src_install() {
704         debug-print-function ${FUNCNAME} "$@"
705
706         cmake-utils_src_install
707
708         # We don't want QCH and tags files to be compressed, because then
709         # cmake can't find the tags and qthelp viewers can't find the docs
710         local p=$(best_version dev-qt/qtcore:5)
711         local pv=$(echo ${p/%-r[0-9]*/} | rev | cut -d - -f 1 | rev)
712         if [[ -d ${ED%/}/usr/share/doc/qt-${pv} ]]; then
713                 docompress -x /usr/share/doc/qt-${pv}
714         fi
715
716         # We don't want /usr/share/doc/HTML to be compressed,
717         # because then khelpcenter can't find the docs
718         if [[ -d ${ED%/}/usr/share/doc/HTML ]]; then
719                 docompress -x /usr/share/doc/HTML
720         fi
721 }
722
723 # @FUNCTION: kde5_pkg_preinst
724 # @DESCRIPTION:
725 # Sets up environment variables required in kde5_pkg_postinst.
726 kde5_pkg_preinst() {
727         debug-print-function ${FUNCNAME} "$@"
728
729         gnome2_icon_savelist
730         xdg_pkg_preinst
731 }
732
733 # @FUNCTION: kde5_pkg_postinst
734 # @DESCRIPTION:
735 # Updates the various XDG caches (icon, desktop, mime) if necessary.
736 kde5_pkg_postinst() {
737         debug-print-function ${FUNCNAME} "$@"
738
739         if [[ -n ${GNOME2_ECLASS_ICONS} ]]; then
740                 gnome2_icon_cache_update
741         fi
742         xdg_pkg_postinst
743
744         if [[ -z ${I_KNOW_WHAT_I_AM_DOING} ]]; then
745                 if [[ ${KDE_BUILD_TYPE} = live ]]; then
746                         echo
747                         einfo "WARNING! This is an experimental live ebuild of ${CATEGORY}/${PN}"
748                         einfo "Use it at your own risk."
749                         einfo "Do _NOT_ file bugs at bugs.gentoo.org because of this ebuild!"
750                 fi
751         fi
752 }
753
754 # @FUNCTION: kde5_pkg_postrm
755 # @DESCRIPTION:
756 # Updates the various XDG caches (icon, desktop, mime) if necessary.
757 kde5_pkg_postrm() {
758         debug-print-function ${FUNCNAME} "$@"
759
760         if [[ -n ${GNOME2_ECLASS_ICONS} ]]; then
761                 gnome2_icon_cache_update
762         fi
763         xdg_pkg_postrm
764 }
765
766 fi