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 overridden 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 esac
 231
 232 case ${KDE_EXAMPLES} in
 233         false)  ;;
 234         *)
 235                 IUSE+=" examples"
 236                 ;;
 237 esac
 238
 239 case ${KDE_HANDBOOK} in
 240         false)  ;;
 241         *)
 242                 IUSE+=" +handbook"
 243                 DEPEND+=" handbook? ( $(add_frameworks_dep kdoctools) )"
 244                 ;;
 245 esac
 246
 247 case ${KDE_QTHELP} in
 248         false)  ;;
 249         *)
 250                 IUSE+=" doc"
 251                 COMMONDEPEND+=" doc? ( $(add_qt_dep qt-docs) )"
 252                 DEPEND+=" doc? (
 253                         $(add_qt_dep qthelp)
 254                         >=app-doc/doxygen-1.8.13-r1
 255                 )"
 256                 ;;
 257 esac
 258
 259 case ${KDE_TEST} in
 260         false)  ;;
 261         *)
 262                 IUSE+=" test"
 263                 DEPEND+=" test? ( $(add_qt_dep qttest) )"
 264                 ;;
 265 esac
 266
 267 case ${KDE_SELINUX_MODULE} in
 268         none)   ;;
 269         *)
 270                 IUSE+=" selinux"
 271                 RDEPEND+=" selinux? ( sec-policy/selinux-${KDE_SELINUX_MODULE} )"
 272                 ;;
 273 esac
 274
 275 DEPEND+=" ${COMMONDEPEND} dev-util/desktop-file-utils"
 276 RDEPEND+=" ${COMMONDEPEND}"
 277 unset COMMONDEPEND
 278
 279 if [[ -n ${KMNAME} && ${KMNAME} != ${PN} && ${KDE_BUILD_TYPE} = release ]]; then
 280         S=${WORKDIR}/${KMNAME}-${PV}
 281 fi
 282
 283 if [[ -n ${KDEBASE} && ${KDEBASE} = kdevelop && ${KDE_BUILD_TYPE} = release ]]; then
 284         if [[ -n ${KMNAME} ]]; then
 285                 S=${WORKDIR}/${KMNAME}-${PV}
 286         else
 287                 S=${WORKDIR}/${P}
 288         fi
 289 fi
 290
 291 _kde_is_unreleased() {
 292         local pair
 293         for pair in "${KDE_UNRELEASED[@]}" ; do
 294                 if [[ "${pair}" = "${CATEGORY}-${PV}" ]]; then
 295                         return 0
 296                 fi
 297         done
 298
 299         return 1
 300 }
 301
 302 # Determine fetch location for released tarballs
 303 _calculate_src_uri() {
 304         debug-print-function ${FUNCNAME} "$@"
 305
 306         local _kmname
 307
 308         if [[ -n ${KMNAME} ]]; then
 309                 _kmname=${KMNAME}
 310         else
 311                 _kmname=${PN}
 312         fi
 313
 314         case ${PN} in
 315                 kdelibs4support | \
 316                 khtml | \
 317                 kjs | \
 318                 kjsembed | \
 319                 kmediaplayer | \
 320                 kross)
 321                         _kmname="portingAids/${_kmname}"
 322                         ;;
 323         esac
 324
 325         DEPEND+=" app-arch/xz-utils"
 326
 327         case ${CATEGORY} in
 328                 kde-apps)
 329                         case ${PV} in
 330                                 ??.?.[6-9]? | ??.??.[6-9]? )
 331                                         SRC_URI="mirror://kde/unstable/applications/${PV}/src/${_kmname}-${PV}.tar.xz"
 332                                         RESTRICT+=" mirror"
 333                                         ;;
 334                                 *)
 335                                         SRC_URI="mirror://kde/stable/applications/${PV}/src/${_kmname}-${PV}.tar.xz" ;;
 336                         esac
 337                         ;;
 338                 kde-frameworks)
 339                         SRC_URI="mirror://kde/stable/frameworks/${PV%.*}/${_kmname}-${PV}.tar.xz" ;;
 340                 kde-plasma)
 341                         local plasmapv=$(get_version_component_range 1-3)
 342
 343                         case ${PV} in
 344                                 5.?.[6-9]? | 5.??.[6-9]? )
 345                                         # Plasma 5 beta releases
 346                                         SRC_URI="mirror://kde/unstable/plasma/${plasmapv}/${_kmname}-${PV}.tar.xz"
 347                                         RESTRICT+=" mirror"
 348                                         ;;
 349                                 *)
 350                                         # Plasma 5 stable releases
 351                                         SRC_URI="mirror://kde/stable/plasma/${plasmapv}/${_kmname}-${PV}.tar.xz" ;;
 352                         esac
 353                         ;;
 354         esac
 355
 356         if [[ -z ${SRC_URI} && -n ${KDEBASE} ]] ; then
 357                 local _kdebase
 358                 case ${PN} in
 359                         kdevelop-pg-qt)
 360                                 _kdebase=${PN} ;;
 361                         *)
 362                                 _kdebase=${KDEBASE} ;;
 363                 esac
 364                 case ${PV} in
 365                         *.*.[6-9]? )
 366                                 SRC_URI="mirror://kde/unstable/${_kdebase}/${PV}/src/${_kmname}-${PV}.tar.xz"
 367                                 RESTRICT+=" mirror"
 368                                 ;;
 369                         *)
 370                                 SRC_URI="mirror://kde/stable/${_kdebase}/${PV}/src/${_kmname}-${PV}.tar.xz" ;;
 371                 esac
 372                 unset _kdebase
 373         fi
 374
 375         if _kde_is_unreleased ; then
 376                 RESTRICT+=" fetch"
 377         fi
 378 }
 379
 380 # Determine fetch location for live sources
 381 _calculate_live_repo() {
 382         debug-print-function ${FUNCNAME} "$@"
 383
 384         SRC_URI=""
 385
 386         case ${KDE_SCM} in
 387                 git)
 388                         # @ECLASS-VARIABLE: EGIT_MIRROR
 389                         # @DESCRIPTION:
 390                         # This variable allows easy overriding of default kde mirror service
 391                         # (anongit) with anything else you might want to use.
 392                         EGIT_MIRROR=${EGIT_MIRROR:=https://anongit.kde.org}
 393
 394                         local _kmname
 395
 396                         # @ECLASS-VARIABLE: EGIT_REPONAME
 397                         # @DESCRIPTION:
 398                         # This variable allows overriding of default repository
 399                         # name. Specify only if this differ from PN and KMNAME.
 400                         if [[ -n ${EGIT_REPONAME} ]]; then
 401                                 # the repository and kmname different
 402                                 _kmname=${EGIT_REPONAME}
 403                         elif [[ -n ${KMNAME} ]]; then
 404                                 _kmname=${KMNAME}
 405                         else
 406                                 _kmname=${PN}
 407                         fi
 408
 409                         if [[ ${PV} == ??.??.49.9999 && ${CATEGORY} = kde-apps ]]; then
 410                                 EGIT_BRANCH="Applications/$(get_version_component_range 1-2)"
 411                         fi
 412
 413                         if [[ ${PV} != 9999 && ${CATEGORY} = kde-plasma ]]; then
 414                                 EGIT_BRANCH="Plasma/$(get_version_component_range 1-2)"
 415                         fi
 416
 417                         EGIT_REPO_URI="${EGIT_MIRROR}/${_kmname}"
 418                         ;;
 419         esac
 420 }
 421
 422 case ${KDE_BUILD_TYPE} in
 423         live) _calculate_live_repo ;;
 424         *) _calculate_src_uri ;;
 425 esac
 426
 427 debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: SRC_URI is ${SRC_URI}"
 428
 429 # @FUNCTION: kde5_pkg_pretend
 430 # @DESCRIPTION:
 431 # Checks if the active compiler meets the minimum version requirements.
 432 # phase function is only exported if KDE_GCC_MINIMAL is defined.
 433 kde5_pkg_pretend() {
 434         debug-print-function ${FUNCNAME} "$@"
 435         _check_gcc_version
 436 }
 437
 438 # @FUNCTION: kde5_pkg_setup
 439 # @DESCRIPTION:
 440 # Checks if the active compiler meets the minimum version requirements.
 441 kde5_pkg_setup() {
 442         debug-print-function ${FUNCNAME} "$@"
 443         _check_gcc_version
 444 }
 445
 446 # @FUNCTION: kde5_pkg_nofetch
 447 # @DESCRIPTION:
 448 # Intended for use in the KDE overlay. If this package matches something in
 449 # KDE_UNRELEASED, display a giant warning that the package has not yet been
 450 # released upstream and should not be used.
 451 kde5_pkg_nofetch() {
 452         if ! _kde_is_unreleased ; then
 453                 return
 454         fi
 455
 456         eerror " _   _ _   _ ____  _____ _     _____    _    ____  _____ ____  "
 457         eerror "| | | | \ | |  _ \| ____| |   | ____|  / \  / ___|| ____|  _ \ "
 458         eerror "| | | |  \| | |_) |  _| | |   |  _|   / _ \ \___ \|  _| | | | |"
 459         eerror "| |_| | |\  |  _ <| |___| |___| |___ / ___ \ ___) | |___| |_| |"
 460         eerror " \___/|_| \_|_| \_\_____|_____|_____/_/   \_\____/|_____|____/ "
 461         eerror "                                                               "
 462         eerror " ____   _    ____ _  __    _    ____ _____ "
 463         eerror "|  _ \ / \  / ___| |/ /   / \  / ___| ____|"
 464         eerror "| |_) / _ \| |   | ' /   / _ \| |  _|  _|  "
 465         eerror "|  __/ ___ \ |___| . \  / ___ \ |_| | |___ "
 466         eerror "|_| /_/   \_\____|_|\_\/_/   \_\____|_____|"
 467         eerror
 468         eerror "${CATEGORY}/${P} has not been released to the public yet"
 469         eerror "and is only available to packagers right now."
 470         eerror ""
 471         eerror "This is not a bug. Please do not file bugs or contact upstream about this."
 472         eerror ""
 473         eerror "Please consult the upstream release schedule to see when this "
 474         eerror "package is scheduled to be released:"
 475         eerror "https://community.kde.org/Schedules"
 476 }
 477
 478 # @FUNCTION: kde5_src_unpack
 479 # @DESCRIPTION:
 480 # Unpack the sources, automatically handling both release and live ebuilds.
 481 kde5_src_unpack() {
 482         debug-print-function ${FUNCNAME} "$@"
 483
 484         if [[ ${KDE_BUILD_TYPE} = live ]]; then
 485                 case ${KDE_SCM} in
 486                         git)
 487                                 git-r3_src_unpack
 488                                 ;;
 489                 esac
 490         else
 491                 default
 492         fi
 493 }
 494
 495 # @FUNCTION: kde5_src_prepare
 496 # @DESCRIPTION:
 497 # Wrapper for cmake-utils_src_prepare with lots of extra logic for magic
 498 # handling of linguas, tests, handbook etc.
 499 kde5_src_prepare() {
 500         debug-print-function ${FUNCNAME} "$@"
 501
 502         cmake-utils_src_prepare
 503
 504         # only build examples when required
 505         if ! use_if_iuse examples || ! use examples ; then
 506                 cmake_comment_add_subdirectory examples
 507         fi
 508
 509         # only enable handbook when required
 510         if ! use_if_iuse handbook ; then
 511                 cmake_comment_add_subdirectory ${KDE_DOC_DIR}
 512
 513                 if [[ ${KDE_HANDBOOK} = forceoptional ]] ; then
 514                         punt_bogus_dep KF5 DocTools
 515                         sed -i -e "/kdoctools_install/ s/^/#DONT/" CMakeLists.txt || die
 516                 fi
 517         fi
 518
 519         # drop translations when nls is not wanted
 520         if in_iuse nls && ! use nls ; then
 521                 local po
 522                 for po in ${KDE_PO_DIRS}; do
 523                         if [[ -d ${po} ]] ; then
 524                                 rm -r ${po} || die
 525                         fi
 526                 done
 527         fi
 528
 529         # enable only the requested translations when required
 530         if [[ -v LINGUAS ]] ; then
 531                 local po
 532                 for po in ${KDE_PO_DIRS}; do
 533                 if [[ -d ${po} ]] ; then
 534                         pushd ${po} > /dev/null || die
 535                         local lang
 536                         for lang in *; do
 537                                 if [[ -e ${lang} ]] && ! has ${lang/.po/} ${LINGUAS} ; then
 538                                         case ${lang} in
 539                                                 cmake_modules | \
 540                                                 CMakeLists.txt | \
 541                                                 ${PN}.pot)      ;;
 542                                                 *) rm -r ${lang} || die ;;
 543                                         esac
 544                                         if [[ -e CMakeLists.txt ]] ; then
 545                                                 cmake_comment_add_subdirectory ${lang}
 546                                                 sed -e "/add_subdirectory([[:space:]]*${lang}\/.*[[:space:]]*)/d" \
 547                                                         -i CMakeLists.txt || die
 548                                         fi
 549                                 fi
 550                         done
 551                         popd > /dev/null || die
 552                 fi
 553                 done
 554         fi
 555
 556         if [[ ${KDE_BUILD_TYPE} = release && ${CATEGORY} != kde-apps ]] ; then
 557                 if [[ ${KDE_HANDBOOK} != false && -d ${KDE_DOC_DIR} && -v LINGUAS ]] ; then
 558                         pushd ${KDE_DOC_DIR} > /dev/null || die
 559                         local lang
 560                         for lang in *; do
 561                                 if ! has ${lang} ${LINGUAS} ; then
 562                                         cmake_comment_add_subdirectory ${lang}
 563                                 fi
 564                         done
 565                         popd > /dev/null || die
 566                 fi
 567         fi
 568
 569         # only build unit tests when required
 570         if ! use_if_iuse test ; then
 571                 if [[ ${KDE_TEST} = forceoptional ]] ; then
 572                         punt_bogus_dep Qt5 Test
 573                         # if forceoptional, also cover non-kde categories
 574                         cmake_comment_add_subdirectory autotests test tests
 575                 elif [[ ${KDE_TEST} = forceoptional-recursive ]] ; then
 576                         punt_bogus_dep Qt5 Test
 577                         local f pf="${T}/${P}"-tests-optional.patch
 578                         touch ${pf} || die "Failed to touch patch file"
 579                         for f in $(find . -type f -name "CMakeLists.txt" -exec \
 580                                 grep -l "^\s*add_subdirectory\s*\(\s*.*${KDE_TESTPATTERN}\s*)\s*\)" {} \;); do
 581                                 cp ${f} ${f}.old || die "Failed to prepare patch origfile"
 582                                 pushd ${f%/*} > /dev/null || die
 583                                         punt_bogus_dep Qt5 Test
 584                                         sed -i CMakeLists.txt -e \
 585                                                 "/^#/! s/add_subdirectory\s*\(\s*.*${KDE_TESTPATTERN}\s*)\s*\)/if(BUILD_TESTING)\n&\nendif()/" \
 586                                                 || die
 587                                 popd > /dev/null || die
 588                                 diff -Naur ${f}.old ${f} 1>>${pf}
 589                                 rm ${f}.old || die "Failed to clean up"
 590                         done
 591                         einfo "Build system was modified by KDE_TEST=forceoptional-recursive."
 592                         einfo "Unified diff file ready for pickup in:"
 593                         einfo "  ${pf}"
 594                         einfo "Push it upstream to make this message go away."
 595                 elif [[ ${CATEGORY} = kde-frameworks || ${CATEGORY} = kde-plasma || ${CATEGORY} = kde-apps ]] ; then
 596                         cmake_comment_add_subdirectory autotests test tests
 597                 fi
 598         fi
 599
 600         # in frameworks, tests = manual tests so never build them
 601         if [[ ${CATEGORY} = kde-frameworks ]] && [[ ${PN} != extra-cmake-modules ]]; then
 602                 cmake_comment_add_subdirectory tests
 603         fi
 604 }
 605
 606 # @FUNCTION: kde5_src_configure
 607 # @DESCRIPTION:
 608 # Wrapper for cmake-utils_src_configure with extra logic for magic handling of
 609 # handbook, tests etc.
 610 kde5_src_configure() {
 611         debug-print-function ${FUNCNAME} "$@"
 612
 613         # we rely on cmake-utils.eclass to append -DNDEBUG too
 614         if ! use_if_iuse debug; then
 615                 append-cppflags -DQT_NO_DEBUG
 616         fi
 617
 618         local cmakeargs
 619
 620         if in_iuse test && ! use test ; then
 621                 cmakeargs+=( -DBUILD_TESTING=OFF )
 622
 623                 if [[ ${KDE_TEST} = optional ]] ; then
 624                         cmakeargs+=( -DCMAKE_DISABLE_FIND_PACKAGE_Qt5Test=ON )
 625                 fi
 626         fi
 627
 628         if ! use_if_iuse handbook && [[ ${KDE_HANDBOOK} = optional ]] ; then
 629                 cmakeargs+=( -DCMAKE_DISABLE_FIND_PACKAGE_KF5DocTools=ON )
 630         fi
 631
 632         if ! use_if_iuse designer && [[ ${KDE_DESIGNERPLUGIN} != false ]] ; then
 633                 cmakeargs+=( -DCMAKE_DISABLE_FIND_PACKAGE_KF5DesignerPlugin=ON )
 634         fi
 635
 636         if [[ ${KDE_QTHELP} != false ]]; then
 637                 cmakeargs+=( -DBUILD_QCH=$(usex doc) )
 638         fi
 639
 640         # install mkspecs in the same directory as qt stuff
 641         cmakeargs+=(-DKDE_INSTALL_USE_QT_SYS_PATHS=ON)
 642
 643         # allow the ebuild to override what we set here
 644         mycmakeargs=("${cmakeargs[@]}" "${mycmakeargs[@]}")
 645
 646         cmake-utils_src_configure
 647 }
 648
 649 # @FUNCTION: kde5_src_compile
 650 # @DESCRIPTION:
 651 # Wrapper for cmake-utils_src_compile. Currently doesn't do anything extra, but
 652 # is included as part of the API just in case it's needed in the future.
 653 kde5_src_compile() {
 654         debug-print-function ${FUNCNAME} "$@"
 655
 656         cmake-utils_src_compile "$@"
 657 }
 658
 659 # @FUNCTION: kde5_src_test
 660 # @DESCRIPTION:
 661 # Wrapper for cmake-utils_src_test with extra logic for magic handling of dbus
 662 # and virtualx.
 663 kde5_src_test() {
 664         debug-print-function ${FUNCNAME} "$@"
 665
 666         _test_runner() {
 667                 if [[ -n "${VIRTUALDBUS_TEST}" ]]; then
 668                         export $(dbus-launch)
 669                 fi
 670
 671                 cmake-utils_src_test
 672         }
 673
 674         # When run as normal user during ebuild development with the ebuild command, the
 675         # kde tests tend to access the session DBUS. This however is not possible in a real
 676         # emerge or on the tinderbox.
 677         # > make sure it does not happen, so bad tests can be recognized and disabled
 678         unset DBUS_SESSION_BUS_ADDRESS DBUS_SESSION_BUS_PID
 679
 680         if [[ ${VIRTUALX_REQUIRED} = always || ${VIRTUALX_REQUIRED} = test ]]; then
 681                 virtx _test_runner
 682         else
 683                 _test_runner
 684         fi
 685
 686         if [[ -n "${DBUS_SESSION_BUS_PID}" ]] ; then
 687                 kill ${DBUS_SESSION_BUS_PID}
 688         fi
 689 }
 690
 691 # @FUNCTION: kde5_src_install
 692 # @DESCRIPTION:
 693 # Wrapper for cmake-utils_src_install with extra logic to avoid compressing
 694 # certain types of files. For example, khelpcenter is not able to read
 695 # compressed handbooks.
 696 kde5_src_install() {
 697         debug-print-function ${FUNCNAME} "$@"
 698
 699         cmake-utils_src_install
 700
 701         # We don't want QCH and tags files to be compressed, because then
 702         # cmake can't find the tags and qthelp viewers can't find the docs
 703         local p=$(best_version dev-qt/qtcore:5)
 704         local pv=$(echo ${p/%-r[0-9]*/} | rev | cut -d - -f 1 | rev)
 705         if [[ -d ${ED%/}/usr/share/doc/qt-${pv} ]]; then
 706                 docompress -x /usr/share/doc/qt-${pv}
 707         fi
 708
 709         # We don't want /usr/share/doc/HTML to be compressed,
 710         # because then khelpcenter can't find the docs
 711         if [[ -d ${ED%/}/usr/share/doc/HTML ]]; then
 712                 docompress -x /usr/share/doc/HTML
 713         fi
 714 }
 715
 716 # @FUNCTION: kde5_pkg_preinst
 717 # @DESCRIPTION:
 718 # Sets up environment variables required in kde5_pkg_postinst.
 719 kde5_pkg_preinst() {
 720         debug-print-function ${FUNCNAME} "$@"
 721
 722         gnome2_icon_savelist
 723         xdg_pkg_preinst
 724 }
 725
 726 # @FUNCTION: kde5_pkg_postinst
 727 # @DESCRIPTION:
 728 # Updates the various XDG caches (icon, desktop, mime) if necessary.
 729 kde5_pkg_postinst() {
 730         debug-print-function ${FUNCNAME} "$@"
 731
 732         if [[ -n ${GNOME2_ECLASS_ICONS} ]]; then
 733                 gnome2_icon_cache_update
 734         fi
 735         xdg_pkg_postinst
 736
 737         if [[ -z ${I_KNOW_WHAT_I_AM_DOING} ]]; then
 738                 if [[ ${KDE_BUILD_TYPE} = live ]]; then
 739                         echo
 740                         einfo "WARNING! This is an experimental live ebuild of ${CATEGORY}/${PN}"
 741                         einfo "Use it at your own risk."
 742                         einfo "Do _NOT_ file bugs at bugs.gentoo.org because of this ebuild!"
 743                 fi
 744         fi
 745 }
 746
 747 # @FUNCTION: kde5_pkg_postrm
 748 # @DESCRIPTION:
 749 # Updates the various XDG caches (icon, desktop, mime) if necessary.
 750 kde5_pkg_postrm() {
 751         debug-print-function ${FUNCNAME} "$@"
 752
 753         if [[ -n ${GNOME2_ECLASS_ICONS} ]]; then
 754                 gnome2_icon_cache_update
 755         fi
 756         xdg_pkg_postrm
 757 }
 758
 759 fi