path: root/eclass/kde4-functions.eclass

# Copyright 1999-2008 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: $

# @ECLASS: kde4-functions.eclass
# @MAINTAINER:
# kde@gentoo.org
# @BLURB: Common ebuild functions for monolithic and split KDE 4 packages
# @DESCRIPTION:
# This eclass contains all functions shared by the different eclasses,
# for KDE 4 monolithic and split ebuilds.
#
# NOTE: This eclass uses the SLOT dependencies from EAPI="1" or compatible,
# hence you must define EAPI="1" in the ebuild, before inheriting any eclasses.

# BLOCK FOR EAPI OLDER THAN 2.
case ${EAPI} in
	2) : ;;
	*) die "No way! EAPI older than 2 is not supported." ;;
esac

# @ECLASS-VARIABLE: KDEBASE
# @DESCRIPTION:
# This gets set to a non-zero value when a package is considered a kde or
# koffice ebuild.

if [[ "${CATEGORY}" == "kde-base" ]]; then
	debug-print "${ECLASS}: KDEBASE ebuild recognized"
	KDEBASE="kde-base"
fi

# is this a koffice ebuild?
if [[ "${KMNAME}" == "koffice" || "${PN}" == "koffice" ]]; then
	debug-print "${ECLASS}: KOFFICE ebuild recognized"
	KDEBASE="koffice"
fi

# @ECLASS-VARIABLE: KDE_SLOTS
# @DESCRIPTION:
# The slots used by all KDE versions later than 4.0. The live-ebuilds use
# KDE_LIVE_SLOTS instead.
KDE_SLOTS=( "kde-4" "4.1" "4.2" )

# @ECLASS-VARIABLE: KDE_LIVE_SLOTS
# @DESCRIPTION:
# The slots used by all KDE live versions.
KDE_LIVE_SLOTS=( "live" )

# @FUNCTION: buildsycoca
# @DESCRIPTION:
# Function to rebuild the KDE System Configuration Cache.
# All KDE ebuilds should run this in pkg_postinst and pkg_postrm.
#
# Note that kde4-base.eclass already does this.
buildsycoca() {
	debug-print-function ${FUNCNAME} "$@"

	if [[ -x ${KDEDIR}/bin/kbuildsycoca4 && -z "${ROOT%%/}" ]]; then
		# Make sure tha cache file exists, or kbuildsycoca4 will fail
		touch "${KDEDIR}/share/kde4/services/ksycoca4"

		# We have to unset DISPLAY and DBUS_SESSION_BUS_ADDRESS, the ones
		# in the user's environment (through su [without '-']) may cause
		# kbuildsycoca4 to hang.

		ebegin "Running kbuildsycoca4 to build global database"
		# This is needed because we support multiple kde versions installed together.
		XDG_DATA_DIRS="/usr/share:${KDEDIRS//:/\/share:}/share:/usr/local/share" \
			DISPLAY="" DBUS_SESSION_BUS_ADDRESS="" \
			${KDEDIR}/bin/kbuildsycoca4 --global --noincremental &> /dev/null
		eend $?
	fi
}

# @FUNCTION: comment_all_add_subdirectory
# @USAGE: [list of directory names]
# @DESCRIPTION:
# Recursively comment all add_subdirectory instructions in listed directories,
# except those in cmake/.
comment_all_add_subdirectory() {
	find "$@" -name CMakeLists.txt -print0 | grep -vFzZ "./cmake" | \
		xargs -0 sed -i -e '/add_subdirectory/s/^/#DONOTCOMPILE /' -e '/ADD_SUBDIRECTORY/s/^/#DONOTCOMPILE /' || \
		die "${LINENO}: Initial sed died"
}

# @ECLASS-VARIABLE: KDE_LINGUAS
# @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(). kde4-base.eclass does
# this for you.
#
# Example: KDE_LINGUAS="en_GB de nl"
for _lingua in ${KDE_LINGUAS}; do
	IUSE="${IUSE} linguas_${_lingua}"
done

# @FUNCTION: enable_selected_linguas
# @DESCRIPTION:
# Enable translations based on LINGUAS settings and translations supported by
# the package (see KDE_LINGUAS). By default, translations are found in "${S}"/po
# but this default can be overridden by defining KDE_LINGUAS_DIR.
enable_selected_linguas() {
	local lingua

	for lingua in ${KDE_LINGUAS}; do
		if [ -e "${S}"/po/"${lingua}".po ]; then
			mv "${S}"/po/"${lingua}".po "${S}"/po/"${lingua}".po.old
		fi
	done
	comment_all_add_subdirectory "${KDE_LINGUAS_DIR:-${S}/po}"
	for lingua in ${LINGUAS}; do
		if [ -d "${S}"/po/"${lingua}" ]; then
			sed -e "/add_subdirectory([[:space:]]*${lingua}[[:space:]]*)[[:space:]]*$/ s/^#DONOTCOMPILE //" \
				-e "/ADD_SUBDIRECTORY([[:space:]]*${lingua}[[:space:]]*)[[:space:]]*$/ s/^#DONOTCOMPILE //" \
				-i "${KDE_LINGUAS_DIR:-${S}/po}"/CMakeLists.txt || die "Sed to uncomment linguas_${lingua} failed."
		fi
		if [ -e "${S}"/po/"${lingua}".po.old ]; then
			mv "${S}"/po/"${lingua}".po.old "${S}"/po/"${lingua}".po
		fi
	done
}

# FIXME: descripton too brief?
# @FUNCTION: kdebase_toplevel_cmakelists
# @DESCRIPTION:
# replace includes for live ebuilds with optional requests
kdebase_toplevel_cmakelist() {
	insert=$(sed -e '/macro_optional_find_package/!d' < "${ESVN_WC_PATH}"/CMakeLists.txt)
	at=$(sed -n '/^include[[:space:]]*(/=' < "${S}"/CMakeLists.txt | sed -n '$p')
	for line in ${insert}; do
		sed "${at}a${line}" -i  "${S}"/CMakeLists.txt
	done
}

# @FUNCTION: koffice_fix_libraries
# @DESCRIPTION:
# replace the weird koffice lib search with hardcoded one, so it
# actually builds and works.
koffice_fix_libraries() {
	local LIB_ARRAY R_QT_kostore R_BAS_kostore R_BAS_koodf R_KROSS_kokross R_QT_komain
	local R_CMS_pigmentcms R_BAS_pigmentcms R_BAS_koresources R_BAS_flake R_BAS_koguiutils
	local R_BAS_kopageapp R_BAS_kotext R_BAS_kowmf libname R
	case ${PN} in
		koffice-data|koffice-libs)
			;;
		*)
			### basic array
			LIB_ARRAY="kostore koodf kokross komain pigmentcms koresources flake koguiutils kopageapp kotext kowmf"
			### dep array
			R_QT_kostore="\"/usr/$(get_libdir)/qt4/libQtCore.so\"
				\"/usr/$(get_libdir)/qt4/libQtXml.so\"
				\"${KDEDIR}/$(get_libdir)/libkdecore.so\""
			R_BAS_kostore="libkostore ${R_QT_kostore}"
			R_BAS_koodf="libkoodf ${R_BAS_kostore}"
			R_KROSS_kokross="
				\"${KDEDIR}/$(get_libdir)/libkrossui.so\"
				\"${KDEDIR}/$(get_libdir)/libkrosscore.so\""
			R_BAS_kokross="libkokross ${R_BAS_koodf} ${R_KROSS_kokross}"
			R_QT_komain="\"/usr/$(get_libdir)/qt4/libQtGui.so\""
			R_BAS_komain="libkomain ${R_BAS_koodf} ${R_QT_komain}"
			R_CMS_pigmentcms="\"/usr/$(get_libdir)/liblcms.so\""
			R_BAS_pigmentcms="libpigmentcms ${R_BAS_komain} ${R_CMS_pigmentcms}"
			R_BAS_koresources="libkoresources ${R_BAS_pigmentcms}"
			R_BAS_flake="libflake ${R_BAS_pigmentcms}"
			R_BAS_koguiutils="libkoguiutils libkoresources libflake ${R_BAS_pigmentcms}"
			R_BAS_kopageapp="libkopageapp ${R_BAS_koguitls}"
			R_BAS_kotext="libkotext libkoresources libflake ${R_BAS_pigmentcms}"
			### additional unmentioned stuff
			R_BAS_kowmf="libkowmf"
			for libname in ${LIB_ARRAY}; do
				echo "Fixing library ${libname} with hardcoded path"
				for libpath in $(eval "echo \$R_BAS_${libname}"); do
					if [[ "${libpath}" != "\"/usr/"* ]]; then
						R="${R} \"${KDEDIR}/$(get_libdir)/${libpath}.so\""
					else
						R="${R} ${libpath}"
					fi
				done
				find ${S} -name CMakeLists.txt -print| xargs -i \
					sed -i \
						-e "s: ${libname} : ${R} :g" \
						-e "s: ${libname}): ${R}):g" \
						-e "s:(${libname} :(${R} :g" \
						-e "s:(${libname}):(${R}):g" \
						-e "s: ${libname}$: ${R}:g" \
					{} || die "Fixing library names failed."
			done
			;;
	esac
}
# @FUNCTION: get_build_type
# @DESCRIPTION:
# Determine whether we are using live ebuild or normal tbzs.
get_build_type() {
	if [[ "${SLOT}" == "live" || "${PV}" == 9999* ]]; then
		BUILD_TYPE="live"
	else
		BUILD_TYPE="normal"
	fi
	export BUILD_TYPE
}

# @FUNCTION: get_latest_kdedir
# @DESCRIPTION:
# We set up KDEDIR according to the latest KDE version installed; installing our
# package for all available installs is just insane.
# We can check for kdelibs because it is the most basic package; no KDE package
# working without it. This might be changed in future.
get_latest_kdedir() {
	if [[ "${NEED_KDE}" == "latest" && "${KDEBASE}" != "kde-base"  ]]; then
		case ${KDE_WANTED} in
			# note this will need to be updated as stable moves and so on
			live)
				_versions="9999 4.1.69 4.1.0"
				;;
			snapshot)
				_versions="4.1.69 4.1.0 9999"
				;;
			testing)
				_versions="4.1.0 4.1.69 9999"
				;;
			stable)
				_versions="4.1.0 4.1.69 9999"
				;;
			*) die "KDE_WANTED=${KDE_WANTED} not supported here." ;;
		esac
		# check if exists and fallback as we go
		for X in ${_versions}; do
			if has_version ">=kde-base/kdelibs-${X}"; then
				# figure out which X we are in and set it into _kdedir
				case ${X} in
					# also keep track here same for kde_wanted
					9999)
						_kdedir="live"
						break
					;;
					4.1.69)
						_kdedir="4.2"
						break
					;;
					4.1.0)
						_kdedir="4.1"
						break
					;;
				esac
			fi
		done
	fi
}

# Functions handling KMLOADLIBS and KMSAVELIBS

# @FUNCTION: save_library_dependencies
# @DESCRIPTION:
# Add exporting CMake dependencies for current package
save_library_dependencies() {
	local depsfile="${T}/${PN}:${SLOT}"

	echo "Saving library dependendencies in ${depsfile##*/}"
	echo "EXPORT_LIBRARY_DEPENDENCIES(\"${depsfile}\")" >> "${S}/CMakeLists.txt" || \
		die "Failed to save the library dependencies."
}

# @FUNCTION: install_library_dependencies
# @DESCRIPTION:
# Install generated CMake library dependencies to /var/lib/kde
install_library_dependencies() {
	local depsfile="${T}/${PN}:${SLOT}"
	echo "Installing library dependendencies as ${depsfile##*/}"
	insinto /var/lib/kde
	doins "${depsfile}" || die "Failed to install library dependencies."
}

# @FUNCTION: load_library_dependencies
# @DESCRIPTION:
# Inject specified library dependencies in current package
load_library_dependencies() {
	local pn i depsfile
	echo "Injecting library dependendencies from '${KMLOADLIBS}'"

	i=0
	for pn in ${KMLOADLIBS} ; do
		((i++))
		depsfile="/var/lib/kde/${pn}:${SLOT}"
		[[ -r "${depsfile}" ]] || die "Depsfile '${depsfile}' not accessible. You probably need to reinstall ${pn}."
		sed -i -e "${i}iINCLUDE(\"${depsfile}\")" "${S}/CMakeLists.txt" || \
			die "Failed to include library dependencies for ${pn}"
	done
}