You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tde-packaging-gentoo/eclass/trinity-base-2.eclass

520 lines
15 KiB

# Copyright 1999-2020 Gentoo Authors
# Copyright 2020-2022 The Trinity Desktop Project
# Distributed under the terms of the GNU General Public License v2
# @ECLASS: trinity-base-2.eclass
# @MAINTAINER:
# gentoo@trinitydesktop.org
# @SUPPORTED_EAPIS: 7 8
# @BLURB: common ebuild functions for trinity-base packages
# @DESCRIPTION:
# Original Author: fat-zer
# Ported to git-r3 eclass and EAPI7 by E. Liddell
# Ported to cmake eclass and EAPI8 by ormorh
# Purpose: Support ebuilds for the Trinity Desktop (KDE3 fork).
#
inherit trinity-functions-2
# @ECLASS_VARIABLE: TRINITY_BUILD_ADMIN
# @DESCRIPTION:
# The value of this variable determines the package build mode.
# If set to "yes", the module "admin" is used for assembly.The build
# is done using the 'trinity-econf' and 'emake' functions.
# If set to "no", inherit cmake.
: ${TRINITY_BUILD_ADMIN:=no}
case ${TRINITY_BUILD_ADMIN} in
yes)
;;
no)
inherit cmake
;;
*)
eerror "Unknown value for \${CHECK_ADMIN}"
die "Value ${CHECK_ADMIN} is not supported"
esac
# Don't use Gentoo mirrors
RESTRICT="mirror"
addwrite "/usr/tqt3/etc/settings"
addpredict "/usr/tqt3/etc/settings"
# ban EAPI 0-6
case ${EAPI} in
0|1|2|3|4|5|6) die "EAPI=${EAPI} is not supported" ;;
7|8) ;;
*) die "Unknown EAPI=${EAPI}"
esac
# @ECLASS_VARIABLE: BUILD_TYPE
# @DESCRIPTION:
# Determines the build type: live or release
if [[ "${PV}" == *"9999"* ]]; then
BUILD_TYPE="live"
else
BUILD_TYPE="release"
fi
export BUILD_TYPE
# @ECLASS_VARIABLE: TRINITY_MODULE_NAME
# @DESCRIPTION:
# The name of trinity module; It's used for multiple purposes. First of all it
# determines the tarball name (git repository for live packages)
echo "${TRINITY_MODULE_NAME:=${PN}}" >/dev/null
# @ECLASS_VARIABLE: TRINITY_SCM
# @DESCRIPTION:
# Determines which version control system code is checking out live ebuilds from.
# @ECLASS_VARIABLE: TMP_DOCDIR
# @DESCRIPTION:
# A temporary directory used to copy common documentation before installing it
#
# @ECLASS_VARIABLE: TRINTY_BASE_NO_INSTALL_DOC
# @DESCRIPTION:
# if set to anything except "no" this variable prevents
# trinity-base_src_install() from installing documentation
#
# @ECLASS_VARIABLE: TRINTY_LANGS
# @DESCRIPTION:
# This is a whitespace-separated list of translations this ebuild supports.
# These translations are automatically added to IUSE. Therefore ebuilds must set
# this variable before inheriting any eclasses. To enable only selected
# translations, ebuilds must call enable_selected_linguas().
# @ECLASS_VARIABLE: TRINTY_DOC_LANGS
# @DESCRIPTION:
# This is a whitespace-separated list of translations this ebuild supports.
# These translations are automatically added to IUSE. Therefore ebuilds must set
# this variable before inheriting any eclasses. To enable only selected
# translations, ebuilds must call enable_selected_linguas().
# @ECLASS_VARIABLE: TRINITY_HANDBOOK
# @DESCRIPTION:
# Set to enable handbook in application. Possible values are 'always', 'optional'
# (handbook USE flag) and 'never'.
# This variable must be set before inheriting any eclasses. Defaults to 'never'.
# Also ensures buildtime and runtime dependencies are met.
TRINITY_HANDBOOK="${TRINITY_HANDBOOK:-never}"
# @ECLASS_VARIABLE: TRINITY_EXTRAGEAR_PACKAGING
# @DESCRIPTION:
# Set TRINITY_EXTRAGEAR_PACKAGING=yes before inheriting if the package use extragear-like
# packaging and then supports ${TRINITY_LANGS}, ${TRINITY_DOC_LANGS} and
# ${TRINITY_HANDBOOK} variables. The translations are found in the directory
# pointed by the TEG_PO_DIR variable.
# @ECLASS_VARIABLE: TRINITY_GIT_MIRROR
# @DESCRIPTION:
# User (or ebuild) can select another git mirror if it's needed;
# Defaults to https://mirror.git.trinitydesktop.org/gitea/TDE/
# @ECLASS_VARIABLE: TRINITY_GIT_BRANCH
# @DESCRIPTION:
# Specify git branch for live ebuilds. Default: master
# @ECLASS_VARIABLE: TRINITY_COMMON_DOCS
# @DESCRIPTION:
# Common doc names that were found in trinity project's dirs.
TRINITY_COMMON_DOCS="AUTHORS BUGS CHANGELOG CHANGES COMMENTS COMPLIANCE COMPILING
CONFIG_FORMAT CONFIGURING COPYING COPYRIGHT CREDITS DEBUG DESIGN FAQ
HACKING HISTORY HOWTO IDEAS INSTALL LICENSE MAINTAINERS NAMING NEWS
NOTES PLUGINS PORTING README SECURITY-HOLES TASKGROUPS TEMPLATE
TESTCASES THANKS THOUGHTS TODO VERSION"
# @ECLASS_VARIABLE: TRINITY_TARBALL
# @DESCRIPTION:
# This variable holds the name of the tarboll with current module's source code.
# @ECLASS_VARIABLE: TRINITY_BASE_SRC_URI
# @DESCRIPTION:
# The top SRC_URI for all trinity packages
TRINITY_BASE_SRC_URI="https://mirror.ppa.trinitydesktop.org/trinity/releases"
#reset TRINITY_SCM and inherit proper eclass
if [[ "${BUILD_TYPE}" == "live" ]]; then
# set default TRINITY_SCM if not set
[[ -z "${TRINITY_SCM}" ]] && TRINITY_SCM="git"
case ${TRINITY_SCM} in
git) inherit git-r3 ;;
*) die "Unsupported TRINITY_SCM=${TRINITY_SCM}" ;;
esac
#set some variables
EGIT_REPO_URI="${TRINITY_GIT_MIRROR:=https://mirror.git.trinitydesktop.org/gitea/TDE}/${TRINITY_MODULE_NAME}"
EGIT_BRANCH="${TRINITY_GIT_BRANCH:=master}"
# S="${WORKDIR}/${TRINITY_MODULE_NAME}"
elif [[ "${BUILD_TYPE}" == "release" ]]; then
# @ECLASS_VARIABLE: mod_name
# @DESCRIPTION:
# Package name.
mod_name="${TRINITY_MODULE_NAME}"
# @ECLASS_VARIABLE: TRINITY_MODULE_VER
# @DESCRIPTION:
# This variable is for local use in ebuilds.
# This variable can be used to set the package version.
# @ECLASS_VARIABLE: mod_ver
# @DESCRIPTION:
# Package version.
mod_ver="${TRINITY_MODULE_VER:=${PV}}"
#Note: Only releases in the 14.0 series are presently supported.
# @ECLASS_VARIABLE: full_mod_name
# @DESCRIPTION:
# Full package name.
full_mod_name="${mod_name}-trinity-${mod_ver}"
TRINITY_TARBALL="${full_mod_name}.tar.xz"
if [[ -n "${TRINITY_MODULE_TYPE}" ]] ; then
SRC_URI="${TRINITY_BASE_SRC_URI}/R${mod_ver}/main/${TRINITY_MODULE_TYPE}/$TRINITY_TARBALL"
else
SRC_URI="${TRINITY_BASE_SRC_URI}/R${mod_ver}/main/${TRINITY_TARBALL}"
fi
S="${WORKDIR}/${full_mod_name}"
else
die "Unknown BUILD_TYPE=${BUILD_TYPE}"
fi
if [[ ${BUILD_TYPE} == live ]]; then
# @ECLASS_VARIABLE: TRINITY_VER
# @DEPRECATED: none
# @DESCRIPTION:
# Synonymous with SLOT, this was used as a clutch between eclass and ebuilds to
# set SLOT for release and live ebuilds by some means of version detection. But
# for live it was really only using a hardcoded value inside trinity-functions-2
# that we may as well hardcode here.
# The *only* use in ebuilds is SLOT="${TRINITY_VER}" so this remains a fallback.
TRINITY_VER=14
if [[ ${CATEGORY} = trinity-base ]]; then
[[ -z ${SLOT} ]] && SLOT=${TRINITY_VER}
fi
# @ECLASS_VARIABLE: TDEDIR
# @DESCRIPTION:
# Location of tdelibs to link against.
# TODO: Rethink prefixing
export TDEDIR="/usr/trinity/${TRINITY_VER}"
# @ECLASS_VARIABLE: TDEDIRS
# @DESCRIPTION:
# TDE expects that the install path is listed first in TDEDIRS
# Reference: More information inside trinity-base/tdelibs package
# TODO: Rethink prefixing
export TDEDIRS="/usr/trinity/${TRINITY_VER}"
# TODO: get rid of these hacks re prefixing
adjust-trinity-paths
case ${CATEGORY} in
trinity-base|trinity-apps)
[[ ${PN} != tdelibs ]] && [[ ${TRINITY_MODULE_TYPE} != "dependencies" ]] && [[ ${PN} != "arts" ]] &&
[[ ${PN} != "trinity-cmake" ]] &&
COMMON_DEPEND+=" ~trinity-base/tdelibs-${PV}"
;;
*) ;;
esac
elif [[ ${CATEGORY} = trinity-base ]]; then
# Set SLOT, TDEDIR, TRINITY_VER and PREFIX
set-trinityver
[[ -z ${SLOT} ]] && SLOT=${TRINITY_VER}
# Common dependencies
[[ ${PN} != tdelibs ]] && [[ ${PN} != "arts" ]] && [[ ${PN} != "trinity-cmake" ]] && need-trinity
elif [[ ${CATEGORY} = "trinity-apps" ]]; then
need-trinity
fi
# Common dependencies
[[ ${PN} != "trinity-cmake" ]] &&
[[ ${TRINITY_BUILD_ADMIN} != "yes" ]] &&
BDEPEND+=" ~trinity-base/trinity-cmake-${PV}"
if [[ -n "${TRINITY_EXTRAGEAR_PACKAGING}" ]]; then
# @ECLASS_VARIABLE: TEG_PO_DIR
# @DESCRIPTION:
# Change the translation directory for extragear packages. The default is ${S}/po
TEG_PO_DIR="${TEG_PO_DIR:-${S}/po}"
# @ECLASS_VARIABLE: TEG_DOC_DIR
# @DESCRIPTION:
# Change the documentation directory for extragear packages. The default is ${S}/doc
TEG_DOC_DIR="${TEG_DOC_DIR:-${S}/doc}"
if [[ -n "${TRINITY_LANGS}" || -n "${TRINITY_DOC_LANGS}" ]]; then
for lang in ${TRINITY_LANGS} ${TRINITY_DOC_LANGS}; do
IUSE+=" l10n_${lang}"
done
trinityhandbookdepend="
app-text/docbook-xml-dtd
app-text/docbook-xsl-stylesheets
"
case ${TRINITY_HANDBOOK} in
yes | always)
DEPEND+=" ${trinityhandbookdepend}"
;;
optional)
IUSE+=" +handbook"
DEPEND+=" handbook? ( ${trinityhandbookdepend} )"
;;
*) ;;
esac
fi
fi
# @ECLASS_VARIABLE: TRINITY_NEED_ARTS
# @DESCRIPTION:
# Default value is "no". If set to "yes", add an unconditional dependency on
# trinity-base/arts and trinity-base/tdelibs[arts], if "optional" add both
# dependencies with IUSE="arts".
# TODO: This variable was set by the need-arts function but all invocations of
# need-arts should be replaced by setting TRINITY_NEED_ARTS directly in ebuild
# before inheriting this eclass.
: ${TRINITY_NEED_ARTS:=no}
case ${TRINITY_NEED_ARTS} in
no) ;;
yes)
COMMON_DEPEND+="
~trinity-base/arts-${PV}
~trinity-base/tdelibs-${PV}[arts]
"
;;
optional)
IUSE+=" arts"
COMMON_DEPEND+=" arts? (
~trinity-base/arts-${PV}
~trinity-base/tdelibs-${PV}[arts]
)"
;;
*)
eerror "Unknown value for \${TRINITY_NEED_ARTS}"
die "Value ${TRINITY_NEED_ARTS} is not supported"
;;
esac
DEPEND+=" ${COMMON_DEPEND}"
RDEPEND+=" ${COMMON_DEPEND}"
unset COMMON_DEPEND
# @FUNCTION: trinity-base-2_src_unpack
# @DESCRIPTION:
# A default src unpack function to call git-v3_src_unpack if necessary
trinity-base-2_src_unpack() {
if [[ "${BUILD_TYPE}" == "live" ]]; then
git-r3_src_unpack
else
base_src_unpack
fi
}
# @FUNCTION: trinity-base-2_src_prepare
# @DESCRIPTION:
# General pre-configure and pre-compile function for Trinity applications.
trinity-base-2_src_prepare() {
debug-print-function ${FUNCNAME} "${@}"
local dir lang
# SCM bootstrap--removed on the grounds that if you got this far,
# you have to be using git
# Apply patches
eapply_user
# Handle documentation and translations for extragear packages
if [[ -n "${TRINITY_EXTRAGEAR_PACKAGING}" ]]; then
# remove languages that have not been selected
if [[ -n "${TRINITY_LANGS}" ]]; then
einfo "Removing unselected translations from ${TEG_PO_DIR}"
for dir in $(find ${TEG_PO_DIR} -mindepth 1 -maxdepth 1 -type d ); do
lang="$(basename "${dir}")"
if ! has "${lang}" ${TRINITY_LANGS}; then
eerror "Translation ${lang} seems to present in the package but is not supported by the ebuild"
elif ! has ${lang} ${L10N}; then
rm -rf ${dir}
fi
done
fi
# If we removed all translations we should point it
#if [[ -z $(find ${TEG_PO_DIR} -mindepth 1 -maxdepth 1 -type d) ]]; then
# TRINITY_NO_TRANSLATIONS="yes"
#fi
# Remove not selected documentation
if [[ -n "${TRINITY_DOC_LANGS}" ]]; then
einfo "Removing unselected documentation from ${TEG_DOC_DIR}"
for dir in $(find ${TEG_DOC_DIR} -mindepth 1 -maxdepth 1 -type d ); do
lang="$(basename "${dir}")"
if [[ "${lang}" == "${PN}" || \
"${lang}" == "en" || \
"${lang}" == "man" || \
"${lang}" == "doxy" || \
"${lang}" == "online" || \
"${lang}" == "${TRINITY_MODULE_NAME}" ]] ; then
echo -n; # Do nothing it's main documentation
elif ! has "${lang}" ${TRINITY_LANGS}; then
eerror "Documentation translated to language ${lang} seems to present in the package but is not supported by the ebuild"
elif ! has ${lang} ${L10N}; then
rm -rf ${dir}
fi
done
fi
fi
if [[ ${TRINITY_BUILD_ADMIN} == "yes" ]] ; then
trinity-gen-configure
eapply_user
elif [[ ${TRINITY_BUILD_ADMIN} == "no" ]] ; then
cmake_src_prepare
fi
}
# @FUNCTION: trinity-base-2_src_configure
# @DESCRIPTION:
# Call standard cmake_src_onfigure and add some common arguments.
trinity-base-2_src_configure() {
debug-print-function ${FUNCNAME} "${@}"
local eg_cmakeargs
[[ -n "${PREFIX}" ]] && export PREFIX="${TDEDIR}"
if [[ -n "${TRINITY_EXTRAGEAR_PACKAGING}" ]]; then
eg_cmakeargs=( -DBUILD_ALL=ON )
if [[ "${TRINITY_NO_TRANSLATIONS}" == "yes" ]]; then
eg_cmakeargs=( -DBUILD_TRANSLATIONS=OFF "${eg_cmakeargs[@]}" )
else
eg_cmakeargs=( -DBUILD_TRANSLATIONS=ON "${eg_cmakeargs[@]}" )
fi
if [[ "${TRINITY_HANDBOOK}" == "optional" ]]; then
eg_cmakeargs=( -DBUILD_DOC="$(usex handbook)" "${eg_cmakeargs[@]}" )
fi
fi
if [[ "${TRINITY_NEED_ARTS}" == "optional" ]]; then
eg_cmakeargs=( -DWITH_ARTS="$(usex arts)" "${eg_cmakeargs[@]}" )
fi
if [[ "${TRINITY_NEED_ARTS}" == "yes" ]]; then
eg_cmakeargs=( -DWITH_ARTS=ON "${eg_cmakeargs[@]}" )
fi
mycmakeargs=(
-DCMAKE_INSTALL_PREFIX="${EPREFIX}${TDEDIR}"
-DCMAKE_INSTALL_RPATH="${EPREFIX}${TDEDIR}"
"${eg_cmakeargs[@]}"
"${mycmakeargs[@]}"
)
if ! has "-DBUILD_ALL=ON" ${mycmakeargs[@]} ; then
mycmakeargs+=(-DBUILD_ALL=OFF)
fi
if ! has "-DWITH_ALL_OPTIONS=ON" ${mycmakeargs[@]} ; then
mycmakeargs+=(-DWITH_ALL_OPTIONS=OFF)
fi
if [[ ${TRINITY_BUILD_ADMIN} == "yes" ]] ; then
trinity-econf
elif [[ ${TRINITY_BUILD_ADMIN} == "no" ]] ; then
cmake_src_configure
fi
}
# @FUNCTION: trinity-base-2_src_compile
# @DESCRIPTION:
# Just call cmake_src_compile.
trinity-base-2_src_compile() {
debug-print-function ${FUNCNAME} "${@}"
if [[ ${TRINITY_BUILD_ADMIN} == "yes" ]] ; then
emake
elif [[ ${TRINITY_BUILD_ADMIN} == "no" ]] ; then
cmake_src_compile
fi
}
# @FUNCTION: trinity-base-2_src_install
# @DESCRIPTION:
# Call standard cmake_src_install and installs common documentation.
trinity-base-2_src_install() {
debug-print-function ${FUNCNAME} "${@}"
if [[ ${TRINITY_BUILD_ADMIN} == "yes" ]] ; then
if [[ ${TRINITY_MODULE_NAME} == "${PN}" ]] ; then
emake install DESTDIR="${D}"
fi
elif [[ ${TRINITY_BUILD_ADMIN} == "no" ]] ; then
cmake_src_install
fi
if [[ -z "${TRINITY_BASE_NO_INSTALL_DOC}" ||
"${TRINITY_BASE_NO_INSTALL_DOC}" == "no" ]]; then
trinity-base-2_create_tmp_docfiles
trinity-base-2_install_docfiles
fi
}
# @FUNCTION: trinity-base-2_create_tmp_docfiles
# @DESCRIPTION:
# Create docfiles in the form ${TMP_DOCDIR}/path.to.docfile.COMMON_NAME
# Also see the description for TRINITY_COMMON_DOCS and TMP_DOCDIR.
trinity-base-2_create_tmp_docfiles() {
debug-print-function ${FUNCNAME} "${@}"
local srcdirs dir docfile targetdoc
if [[ -z "${TMP_DOCDIR}" || ! -d "${TMP_DOCDIR}" ]] ; then
TMP_DOCDIR="${T}/docs"
mkdir -p ${TMP_DOCDIR}
fi
if [[ -z "${@}" ]] ; then
srcdirs="./"
else
srcdirs="${@}"
fi
einfo "Generating documentation list..."
for dir in ${srcdirs}; do
for doc in ${TRINITY_COMMON_DOCS}; do
for docfile in $(find ${dir} -type f -name "*${doc}*"); do
targetdoc="${docfile//\//.}"
targetdoc="${targetdoc#..}"
cp "${docfile}" "${TMP_DOCDIR}/${targetdoc}"
done
done
done
}
# @FUNCTION: trinity-base-2_install_docfiles
# @DESCRIPTION:
# Install documentation from ${TMP_DOCDIR} or from first argument.
trinity-base-2_install_docfiles() {
debug-print-function ${FUNCNAME} "${@}"
local doc docdir
[[ -n "${TMP_DOCDIR}" ]] && docdir="${TMP_DOCDIR}"
[[ -n "${1}" ]] && docdir="${1}"
[[ -z "${docdir}" ]] && die "docdir is not set in ${FUNCNAME}."
pushd "${docdir}" >/dev/null
find . -maxdepth 1 -type f | while read doc; do
einfo "Installing documentation: ${doc##*/}"
dodoc "${doc}"
done
popd >/dev/null
}
EXPORT_FUNCTIONS src_configure src_compile src_install src_prepare