[gentoo-dev] [RFC] Font eclass EAPI update and design

["Tomáš Chvátal" <scarabeus@gentoo.org>]

[-- Attachment #1.1: Type: text/plain, Size: 508 bytes --]

Hi guys,

As I was reworking the x-modular-r2 eclass I found out that most of the
slowdowns for fonts were produced in fonts eclass.
Since we were the guys who are supposed to update it, I redesign it to
be bit faster and also to support all known eapis.

I would like to ask you to review the changes and spot anything that
might slipped my sight.

(Diff and full eclass attached)

Expected addition to main tree: if nothing huge is found after fosdem,
otherwise in 3 weeks

Cheers

Tomas

[-- Attachment #1.2: font.eclass --]
[-- Type: text/plain, Size: 4402 bytes --]

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

# @ECLASS: font.eclass
# @MAINTAINER:
# fonts@gentoo.org

# Author: Tomáš Chvátal <scarabeus@gentoo.org>
# Author: foser <foser@gentoo.org>
# @BLURB: Eclass to make font installation uniform

inherit eutils

EXPORT_FUNCTIONS pkg_setup src_install pkg_postinst pkg_postrm

# @ECLASS-VARIABLE: FONT_SUFFIX
# @DESCRIPTION:
# Space delimited list of font suffixes to install
: ${FONT_SUFFIX:=}

# @ECLASS-VARIABLE: FONT_S
# @DESCRIPTION:
# Dir containing the fonts
: ${FONT_S:=${S}}

# @ECLASS-VARIABLE: FONT_PN
# @DESCRIPTION:
# Last part of $FONTDIR
: ${FONT_PN:=${PN}}

# @ECLASS-VARIABLE: FONTDIR
# @DESCRIPTION:
# This is where the fonts are installed
: ${FONTDIR:-/usr/share/fonts/${FONT_PN}}

# @ECLASS-VARIABLE: FONT_CONF
# @DESCRIPTION:
# Array, which element(s) is(are) path(s) of fontconfig-2.4 file(s) to install
FONT_CONF=( "" )

# @ECLASS-VARIABLE: DOCS
# @DESCRIPTION:
# Docs to install
: ${DOCS:-}

IUSE="X"

DEPEND="X? (
		x11-apps/mkfontdir
		media-fonts/encodings
	)
	media-libs/fontconfig"

# @FUNCTION: font_xfont_config
# @DESCRIPTION:
# Creates the Xfont files.
font_xfont_config() {
	# create Xfont files
	if has X ${IUSE//+} && use X ; then
		ebegin "Creating fonts.scale & fonts.dir"
		rm -f "${ED}${FONTDIR}"/fonts.{dir,scale}
		mkfontscale "${ED}${FONTDIR}"
		mkfontdir \
			-e ${EPREFIX}/usr/share/fonts/encodings \
			-e ${EPREFIX}/usr/share/fonts/encodings/large \
			"${ED}${FONTDIR}"
		eend $?
		if [ -e "${FONT_S}/fonts.alias" ] ; then
			doins "${FONT_S}/fonts.alias"
		fi
	fi
}

# @FUNCTION: font_xft_config
# @DESCRIPTION:
# Creates the fontconfig cache if necessary.
font_xft_config() {
	# create fontconfig cache
	ebegin "Creating fontconfig cache"
	fc-cache -sf "${ED}${FONTDIR}"
	eend $?
}

# @FUNCTION: font_fontconfig
# @DESCRIPTION:
# Installs the fontconfig config files of FONT_CONF.
font_fontconfig() {
	local conffile
	if [[ -n ${FONT_CONF[@]} ]]; then
		insinto /etc/fonts/conf.avail/
		for conffile in "${FONT_CONF[@]}"; do
			[[ -e  ${conffile} ]] && doins ${conffile}
		done
	fi
}

# @FUNCTION: font_src_install
# @DESCRIPTION:
# The font src_install function.
font_src_install() {
	local suffix commondoc

	pushd "${FONT_S}" > /dev/null

	insinto "${FONTDIR}"

	for suffix in ${FONT_SUFFIX}; do
		doins *.${suffix}
	done

	rm -f fonts.{dir,scale} encodings.dir

	font_xfont_config
	font_xft_config
	font_fontconfig

	popd > /dev/null

	[[ -n ${DOCS} ]] && { dodoc ${DOCS} || die "docs installation failed" ; }

	# install common docs
	for commondoc in COPYRIGHT README{,.txt} NEWS AUTHORS BUGS ChangeLog FONTLOG.txt; do
		[[ -s ${commondoc} ]] && dodoc ${commondoc}
	done
}

# @FUNCTION: font_pkg_setup
# @DESCRIPTION:
# The font pkg_setup function.
# Collision portection and Prefix compat for eapi < 3.
font_pkg_setup() {
	# make sure we get no collisions
	# setup is not the nicest place, but preinst doesn't cut it
	[[ -e "${FONTDIR}/fonts.cache-1" ]] && rm -f "${FONTDIR}/fonts.cache-1"

	# Prefix compat
	case ${EAPI:-0} in
		0|1|2)
			if ! use prefix; then
				EPREFIX=
				ED=${D}
				EROOT=${ROOT}
				[[ ${EROOT} = */ ]] || EROOT+="/"
			fi
			;;
	esac
}

# @FUNCTION: font_pkg_postinst
# @DESCRIPTION:
# The font pkg_postinst function.
# Update global font cache and fix permissions.
font_pkg_postinst() {
	# unreadable font files = fontconfig segfaults
	find "${EROOT}"usr/share/fonts/ -type f '!' -perm 0644 -print0 \
		| xargs -0 chmod -v 0644 2>/dev/null

	if [[ -n ${FONT_CONF[@]} ]]; then
		local conffile
		echo
		elog "The following fontconfig configuration files have been installed:"
		elog
		for conffile in "${FONT_CONF[@]}"; do
			if [[ -e ${EROOT}etc/fonts/conf.avail/$(basename ${conffile}) ]]; then
				elog "  $(basename ${conffile})"
			fi
		done
		elog
		elog "Use \`eselect fontconfig\` to enable/disable them."
		echo
	fi

	if [[ ${ROOT} == / ]]; then
		ebegin "Updating global fontcache"
		fc-cache -fs
		eend $?
	fi
}

# @FUNCTION: font_pkg_postrm
# @DESCRIPTION:
# The font pkg_postrm function.
# Updates global font cache
font_pkg_postrm() {
	# unreadable font files = fontconfig segfaults
	find "${EROOT}"usr/share/fonts/ -type f '!' -perm 0644 -print0 \
		| xargs -0 chmod -v 0644 2>/dev/null

	if [[ ${ROOT} == / ]]; then
		ebegin "Updating global fontcache"
		fc-cache -fs
		eend $?
	fi
}

[-- Attachment #1.3: font.diff --]
[-- Type: text/plain, Size: 6697 bytes --]

--- gentoo/gentoo-x86/eclass/font.eclass	2009-10-11 21:26:11.000000000 +0200
+++ /usr/local/portage/x11/eclass/font.eclass	2010-01-31 18:38:19.000000000 +0100
@@ -1,42 +1,38 @@
-# Copyright 1999-2007 Gentoo Foundation
+# Copyright 1999-2010 Gentoo Foundation
 # Distributed under the terms of the GNU General Public License v2
-# $Header: /var/cvsroot/gentoo-x86/eclass/font.eclass,v 1.47 2009/10/11 11:44:42 maekke Exp $
+# $Header: $
 
 # @ECLASS: font.eclass
 # @MAINTAINER:
 # fonts@gentoo.org
-#
+
+# Author: Tomáš Chvátal <scarabeus@gentoo.org>
 # Author: foser <foser@gentoo.org>
 # @BLURB: Eclass to make font installation uniform
 
 inherit eutils
 
-
 EXPORT_FUNCTIONS pkg_setup src_install pkg_postinst pkg_postrm
 
-#
-# Variable declarations
-#
-
 # @ECLASS-VARIABLE: FONT_SUFFIX
 # @DESCRIPTION:
 # Space delimited list of font suffixes to install
-FONT_SUFFIX=${FONT_SUFFIX:-}
+: ${FONT_SUFFIX:=}
 
 # @ECLASS-VARIABLE: FONT_S
 # @DESCRIPTION:
 # Dir containing the fonts
-FONT_S=${S}
+: ${FONT_S:=${S}}
 
 # @ECLASS-VARIABLE: FONT_PN
 # @DESCRIPTION:
 # Last part of $FONTDIR
-FONT_PN=${FONT_PN:-${PN}}
+: ${FONT_PN:=${PN}}
 
 # @ECLASS-VARIABLE: FONTDIR
 # @DESCRIPTION:
 # This is where the fonts are installed
-FONTDIR=${FONTDIR:-/usr/share/fonts/${FONT_PN}}
+: ${FONTDIR:-/usr/share/fonts/${FONT_PN}}
 
 # @ECLASS-VARIABLE: FONT_CONF
 # @DESCRIPTION:
@@ -46,31 +42,30 @@
 # @ECLASS-VARIABLE: DOCS
 # @DESCRIPTION:
 # Docs to install
-DOCS=${DOCS:-}
+: ${DOCS:-}
 
 IUSE="X"
 
-DEPEND="X? ( x11-apps/mkfontdir
-			media-fonts/encodings )
-		media-libs/fontconfig"
-
-#
-# Public functions
-#
+DEPEND="X? (
+		x11-apps/mkfontdir
+		media-fonts/encodings
+	)
+	media-libs/fontconfig"
 
 # @FUNCTION: font_xfont_config
 # @DESCRIPTION:
 # Creates the Xfont files.
 font_xfont_config() {
 	# create Xfont files
-	if use X ; then
-		einfo "Creating fonts.scale & fonts.dir ..."
-		rm -f "${D}${FONTDIR}"/fonts.{dir,scale}
-		mkfontscale "${D}${FONTDIR}"
+	if has X ${IUSE//+} && use X ; then
+		ebegin "Creating fonts.scale & fonts.dir"
+		rm -f "${ED}${FONTDIR}"/fonts.{dir,scale}
+		mkfontscale "${ED}${FONTDIR}"
 		mkfontdir \
-			-e /usr/share/fonts/encodings \
-			-e /usr/share/fonts/encodings/large \
-			"${D}${FONTDIR}"
+			-e ${EPREFIX}/usr/share/fonts/encodings \
+			-e ${EPREFIX}/usr/share/fonts/encodings/large \
+			"${ED}${FONTDIR}"
+		eend $?
 		if [ -e "${FONT_S}/fonts.alias" ] ; then
 			doins "${FONT_S}/fonts.alias"
 		fi
@@ -81,11 +76,10 @@
 # @DESCRIPTION:
 # Creates the fontconfig cache if necessary.
 font_xft_config() {
-	if ! has_version '>=media-libs/fontconfig-2.4'; then
-		# create fontconfig cache
-		einfo "Creating fontconfig cache ..."
-		fc-cache -sf "${D}${FONTDIR}"
-	fi
+	# create fontconfig cache
+	ebegin "Creating fontconfig cache"
+	fc-cache -sf "${ED}${FONTDIR}"
+	eend $?
 }
 
 # @FUNCTION: font_fontconfig
@@ -94,26 +88,20 @@
 font_fontconfig() {
 	local conffile
 	if [[ -n ${FONT_CONF[@]} ]]; then
-		if has_version '>=media-libs/fontconfig-2.4'; then
-			insinto /etc/fonts/conf.avail/
-			for conffile in "${FONT_CONF[@]}"; do
-				[[ -e  ${conffile} ]] && doins ${conffile}
-			done
-		fi
+		insinto /etc/fonts/conf.avail/
+		for conffile in "${FONT_CONF[@]}"; do
+			[[ -e  ${conffile} ]] && doins ${conffile}
+		done
 	fi
 }
 
-#
-# Public inheritable functions
-#
-
 # @FUNCTION: font_src_install
 # @DESCRIPTION:
-# The font src_install function, which is exported.
+# The font src_install function.
 font_src_install() {
 	local suffix commondoc
 
-	cd "${FONT_S}"
+	pushd "${FONT_S}" > /dev/null
 
 	insinto "${FONTDIR}"
 
@@ -127,8 +115,9 @@
 	font_xft_config
 	font_fontconfig
 
-	cd "${S}"
-	dodoc ${DOCS} 2> /dev/null
+	popd > /dev/null
+
+	[[ -n ${DOCS} ]] && { dodoc ${DOCS} || die "docs installation failed" ; }
 
 	# install common docs
 	for commondoc in COPYRIGHT README{,.txt} NEWS AUTHORS BUGS ChangeLog FONTLOG.txt; do
@@ -138,60 +127,69 @@
 
 # @FUNCTION: font_pkg_setup
 # @DESCRIPTION:
-# The font pkg_setup function, which is exported.
+# The font pkg_setup function.
+# Collision portection and Prefix compat for eapi < 3.
 font_pkg_setup() {
 	# make sure we get no collisions
 	# setup is not the nicest place, but preinst doesn't cut it
 	[[ -e "${FONTDIR}/fonts.cache-1" ]] && rm -f "${FONTDIR}/fonts.cache-1"
+
+	# Prefix compat
+	case ${EAPI:-0} in
+		0|1|2)
+			if ! use prefix; then
+				EPREFIX=
+				ED=${D}
+				EROOT=${ROOT}
+				[[ ${EROOT} = */ ]] || EROOT+="/"
+			fi
+			;;
+	esac
 }
 
 # @FUNCTION: font_pkg_postinst
 # @DESCRIPTION:
-# The font pkg_postinst function, which is exported.
+# The font pkg_postinst function.
+# Update global font cache and fix permissions.
 font_pkg_postinst() {
 	# unreadable font files = fontconfig segfaults
-	find "${ROOT}"usr/share/fonts/ -type f '!' -perm 0644 -print0 \
+	find "${EROOT}"usr/share/fonts/ -type f '!' -perm 0644 -print0 \
 		| xargs -0 chmod -v 0644 2>/dev/null
 
 	if [[ -n ${FONT_CONF[@]} ]]; then
-		if has_version '>=media-libs/fontconfig-2.4'; then
-			local conffile
-			echo
-			elog "The following fontconfig configuration files have been installed:"
-			elog
-			for conffile in "${FONT_CONF[@]}"; do
-				if [[ -e ${ROOT}etc/fonts/conf.avail/$(basename ${conffile}) ]]; then
-					elog "  $(basename ${conffile})"
-				fi
-			done
-			elog
-			elog "Use \`eselect fontconfig\` to enable/disable them."
-			echo
-		fi
-	fi
-
-	if has_version '>=media-libs/fontconfig-2.4'; then
-		if [[ ${ROOT} == "/" ]]; then
-			ebegin "Updating global fontcache"
-			fc-cache -fs
-			eend $?
-		fi
+		local conffile
+		echo
+		elog "The following fontconfig configuration files have been installed:"
+		elog
+		for conffile in "${FONT_CONF[@]}"; do
+			if [[ -e ${EROOT}etc/fonts/conf.avail/$(basename ${conffile}) ]]; then
+				elog "  $(basename ${conffile})"
+			fi
+		done
+		elog
+		elog "Use \`eselect fontconfig\` to enable/disable them."
+		echo
+	fi
+
+	if [[ ${ROOT} == / ]]; then
+		ebegin "Updating global fontcache"
+		fc-cache -fs
+		eend $?
 	fi
 }
 
 # @FUNCTION: font_pkg_postrm
 # @DESCRIPTION:
-# The font pkg_postrm function, which is exported.
+# The font pkg_postrm function.
+# Updates global font cache
 font_pkg_postrm() {
 	# unreadable font files = fontconfig segfaults
-	find "${ROOT}"usr/share/fonts/ -type f '!' -perm 0644 -print0 \
+	find "${EROOT}"usr/share/fonts/ -type f '!' -perm 0644 -print0 \
 		| xargs -0 chmod -v 0644 2>/dev/null
 
-	if has_version '>=media-libs/fontconfig-2.4'; then
-		if [[ ${ROOT} == "/" ]]; then
-			ebegin "Updating global fontcache"
-			fc-cache -fs
-			eend $?
-		fi
+	if [[ ${ROOT} == / ]]; then
+		ebegin "Updating global fontcache"
+		fc-cache -fs
+		eend $?
 	fi
 }

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 262 bytes --]