1 # Copyright 1999-2012 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
6 # This eclass has been superseded by xorg-2
7 # Please modify your ebuilds to use that instead
9 # @ECLASS: x-modular.eclass
12 # @BLURB: Reduces code duplication in the modularized X11 ebuilds.
14 # This eclass makes trivial X ebuilds possible for apps, fonts, drivers,
15 # and more. Many things that would normally be done in various functions
16 # can be accessed by setting variables instead, such as patching,
17 # running eautoreconf, passing options to configure and installing docs.
19 # All you need to do in a basic ebuild is inherit this eclass and set
20 # DESCRIPTION, KEYWORDS and RDEPEND/DEPEND. If your package is hosted
21 # with the other X packages, you don't need to set SRC_URI. Pretty much
22 # everything else should be automatic.
24 if [[ ${PV} = 9999* ]]; then
30 # If we're a font package, but not the font.alias one
32 if [[ "${PN/#font-}" != "${PN}" ]] \
33 && [[ "${CATEGORY}" = "media-fonts" ]] \
34 && [[ "${PN}" != "font-alias" ]] \
35 && [[ "${PN}" != "font-util" ]]; then
36 # Activate font code in the rest of the eclass
39 # Whether to inherit the font eclass
43 inherit eutils libtool multilib toolchain-funcs flag-o-matic autotools \
44 ${FONT_ECLASS} ${GIT_ECLASS}
46 EXPORTED_FUNCTIONS="src_unpack src_compile src_install pkg_preinst pkg_postinst pkg_postrm"
52 EXPORTED_FUNCTIONS="${EXPORTED_FUNCTIONS} src_prepare src_configure"
55 die "Unknown EAPI ${EAPI}"
59 # exports must be ALWAYS after inherit
60 EXPORT_FUNCTIONS ${EXPORTED_FUNCTIONS}
62 # @ECLASS-VARIABLE: XDIR
64 # Directory prefix to use for everything. If you want to install to a
65 # non-default prefix (e.g., /opt/xorg), change XDIR. This has not been
66 # recently tested. You may need to uncomment the setting of datadir and
67 # mandir in x-modular_src_install() or add it back in if it's no longer
68 # there. You may also want to change the SLOT.
72 HOMEPAGE="http://xorg.freedesktop.org/"
74 # @ECLASS-VARIABLE: SNAPSHOT
76 # If set to 'yes' and configure.ac exists, eautoreconf will run. Set
77 # before inheriting this eclass.
80 # Set up SRC_URI for individual modular releases
81 BASE_INDIVIDUAL_URI="http://xorg.freedesktop.org/releases/individual"
82 # @ECLASS-VARIABLE: MODULE
84 # The subdirectory to download source from. Possible settings are app,
85 # doc, data, util, driver, font, lib, proto, xserver. Set above the
86 # inherit to override the default autoconfigured module.
87 if [[ -z ${MODULE} ]]; then
89 app-doc) MODULE="doc" ;;
90 media-fonts) MODULE="font" ;;
91 x11-apps|x11-wm) MODULE="app" ;;
92 x11-misc|x11-themes) MODULE="util" ;;
93 x11-drivers) MODULE="driver" ;;
94 x11-base) MODULE="xserver" ;;
95 x11-proto) MODULE="proto" ;;
96 x11-libs) MODULE="lib" ;;
100 if [[ -n ${GIT_ECLASS} ]]; then
101 EGIT_REPO_URI="git://anongit.freedesktop.org/git/xorg/${MODULE}/${PN}"
103 SRC_URI="${SRC_URI} ${BASE_INDIVIDUAL_URI}/${MODULE}/${P}.tar.bz2"
108 # Set the license for the package. This can be overridden by setting
109 # LICENSE after the inherit. Nearly all FreeDesktop-hosted X packages
110 # are under the MIT license. (This is what Red Hat does in their rpms)
113 # Set up shared dependencies
114 if [[ -n "${SNAPSHOT}" ]]; then
115 # FIXME: What's the minimal libtool version supporting arbitrary versioning?
117 >=sys-devel/libtool-1.5
119 WANT_AUTOCONF="latest"
120 WANT_AUTOMAKE="latest"
123 if [[ -n "${FONT}" ]]; then
125 media-fonts/encodings
129 media-fonts/font-alias"
131 # Starting with 7.0RC3, we can specify the font directory
132 # But oddly, we can't do the same for encodings or font-alias
134 # @ECLASS-VARIABLE: FONT_DIR
136 # If you're creating a font package and the suffix of PN is not equal to
137 # the subdirectory of /usr/share/fonts/ it should install into, set
138 # FONT_DIR to that directory or directories. Set before inheriting this
140 : ${FONT_DIR:=${PN##*-}}
142 # Fix case of font directories
143 FONT_DIR=${FONT_DIR/ttf/TTF}
144 FONT_DIR=${FONT_DIR/otf/OTF}
145 FONT_DIR=${FONT_DIR/type1/Type1}
146 FONT_DIR=${FONT_DIR/speedo/Speedo}
148 # Set up configure options, wrapped so ebuilds can override if need be
149 if [[ -z ${FONT_OPTIONS} ]]; then
150 FONT_OPTIONS="--with-fontdir=\"/usr/share/fonts/${FONT_DIR}\""
153 if [[ -n "${FONT}" ]]; then
154 if [[ ${PN##*-} = misc ]] || [[ ${PN##*-} = 75dpi ]] || [[ ${PN##*-} = 100dpi ]] || [[ ${PN##*-} = cyrillic ]]; then
160 # If we're a driver package
161 if [[ "${PN/#xf86-video}" != "${PN}" ]] || [[ "${PN/#xf86-input}" != "${PN}" ]]; then
162 # Enable driver code in the rest of the eclass
166 # Debugging -- ignore packages that can't be built with debugging
167 if [[ -z "${FONT}" ]] \
168 && [[ "${CATEGORY/app-doc}" = "${CATEGORY}" ]] \
169 && [[ "${CATEGORY/x11-proto}" = "${CATEGORY}" ]] \
170 && [[ "${PN/util-macros}" = "${PN}" ]] \
171 && [[ "${PN/xbitmaps}" = "${PN}" ]] \
172 && [[ "${PN/xkbdata}" = "${PN}" ]] \
173 && [[ "${PN/xorg-cf-files}" = "${PN}" ]] \
174 && [[ "${PN/xcursor}" = "${PN}" ]] \
183 if [[ "${PN/util-macros}" = "${PN}" ]]; then
185 >=x11-misc/util-macros-1.3.0"
189 !<=x11-base/xorg-x11-6.9"
190 # Provides virtual/x11 for temporary use until packages are ported
193 # @FUNCTION: x-modular_specs_check
196 # Make any necessary changes related to gcc specs (generally hardened)
197 x-modular_specs_check() {
198 if [[ ${PN:0:11} = "xorg-server" ]] || [[ -n "${DRIVER}" ]]; then
199 append-ldflags -Wl,-z,lazy
200 # (#116698) breaks loading
201 filter-ldflags -Wl,-z,now
205 # @FUNCTION: x-modular_dri_check
208 # Ensures the server supports DRI if building a driver with DRI support
209 x-modular_dri_check() {
210 # (#120057) Enabling DRI in drivers requires that the server was built with
212 # Starting with xorg-server 1.5.3, DRI support is always enabled unless
213 # USE=minimal is set (see bug #252084)
214 if [[ -n "${DRIVER}" ]]; then
215 if has dri ${IUSE} && use dri; then
216 einfo "Checking for direct rendering capabilities ..."
217 if has_version '>=x11-base/xorg-server-1.5.3'; then
218 if built_with_use x11-base/xorg-server minimal; then
219 die "You must build x11-base/xorg-server with USE=-minimal."
222 if ! built_with_use x11-base/xorg-server dri; then
223 die "You must build x11-base/xorg-server with USE=dri."
230 # @FUNCTION: x-modular_server_supports_drivers_check
233 # Ensures the server SDK is installed if a driver is being built
234 x-modular_server_supports_drivers_check() {
235 # (#135873) Only certain servers will actually use or be capable of
236 # building external drivers, including binary drivers.
237 if [[ -n "${DRIVER}" ]]; then
238 if has_version '>=x11-base/xorg-server-1.1'; then
239 if ! built_with_use x11-base/xorg-server xorg; then
240 eerror "x11-base/xorg-server is not built with support for external drivers."
241 die "You must build x11-base/xorg-server with USE=xorg."
247 # @FUNCTION: x-modular_unpack_source
250 # Simply unpack source code. Nothing else.
251 x-modular_unpack_source() {
252 if [[ -n ${GIT_ECLASS} ]]; then
259 if [[ -n ${FONT_OPTIONS} ]]; then
260 einfo "Detected font directory: ${FONT_DIR}"
264 # @FUNCTION: x-modular_patch_source
268 x-modular_patch_source() {
269 # Use standardized names and locations with bulk patching
270 # Patch directory is ${WORKDIR}/patch
271 # See epatch() in eutils.eclass for more documentation
272 if [[ -z "${EPATCH_SUFFIX}" ]] ; then
273 EPATCH_SUFFIX="patch"
278 # If you have any patches to apply, set PATCHES to their locations and epatch
279 # will apply them. It also handles epatch-style bulk patches, if you know how to
280 # use them and set the correct variables. If you don't, read eutils.eclass.
281 if [[ ${#PATCHES[@]} -gt 1 ]]; then
282 for x in "${PATCHES[@]}"; do
285 elif [[ -n "${PATCHES}" ]]; then
286 for x in ${PATCHES}; do
289 # For non-default directory bulk patching
290 elif [[ -n "${PATCH_LOC}" ]] ; then
292 # For standard bulk patching
293 elif [[ -d "${EPATCH_SOURCE}" ]] ; then
298 # @FUNCTION: x-modular_reconf_source
301 # Run eautoreconf if necessary, and run elibtoolize.
302 x-modular_reconf_source() {
303 if [[ "${SNAPSHOT}" = "yes" ]]
305 # If possible, generate configure if it doesn't exist
306 if [ -f "./configure.ac" ]
312 # Joshua Baergen - October 23, 2005
313 # Fix shared lib issues on MIPS, FBSD, etc etc
317 # @FUNCTION: x-modular_src_prepare
320 # Prepare a package after unpacking, performing all X-related tasks.
321 x-modular_src_prepare() {
322 [[ -n ${GIT_ECLASS} ]] && has src_prepare ${EXPORTED_FUNCTIONS} \
324 x-modular_patch_source
325 x-modular_reconf_source
328 # @FUNCTION: x-modular_src_unpack
331 # Unpack a package, performing all X-related tasks.
332 x-modular_src_unpack() {
333 x-modular_specs_check
334 x-modular_server_supports_drivers_check
336 x-modular_unpack_source
337 has src_prepare ${EXPORTED_FUNCTIONS} || x-modular_src_prepare
340 # @FUNCTION: x-modular_font_configure
343 # If a font package, perform any necessary configuration steps
344 x-modular_font_configure() {
345 if [[ -n "${FONT}" ]]; then
346 # Might be worth adding an option to configure your desired font
347 # and exclude all others. Also, should this USE be nls or minimal?
348 if has nls ${IUSE//+} && ! use nls; then
349 FONT_OPTIONS="${FONT_OPTIONS}
371 # @FUNCTION: x-modular_debug_setup
374 # Set up CFLAGS for a debug build
375 x-modular_debug_setup() {
376 if [[ -n "${DEBUGGABLE}" ]]; then
384 # @FUNCTION: x-modular_src_configure
387 # Perform any necessary pre-configuration steps, then run configure
388 x-modular_src_configure() {
389 x-modular_font_configure
390 x-modular_debug_setup
392 # @VARIABLE: CONFIGURE_OPTIONS
394 # Any extra options to pass to configure
396 # If prefix isn't set here, .pc files cause problems
397 if [[ -x ${ECONF_SOURCE:-.}/configure ]]; then
398 econf --prefix=${XDIR} \
399 --datadir=${XDIR}/share \
406 # @FUNCTION: x-modular_src_make
410 x-modular_src_make() {
411 emake || die "emake failed"
414 # @FUNCTION: x-modular_src_compile
417 # Compile a package, performing all X-related tasks.
418 x-modular_src_compile() {
419 has src_configure ${EXPORTED_FUNCTIONS} || x-modular_src_configure
423 # @FUNCTION: x-modular_src_install
426 # Install a built package to ${D}, performing any necessary steps.
427 # Creates a ChangeLog from git if using live ebuilds.
428 x-modular_src_install() {
429 # Install everything to ${XDIR}
430 if [[ ${CATEGORY} = x11-proto ]]; then
432 ${PN/proto/}docdir=/usr/share/doc/${PF} \
438 docdir=/usr/share/doc/${PF} \
443 # Shouldn't be necessary in XDIR=/usr
444 # einstall forces datadir, so we need to re-force it
445 # datadir=${XDIR}/share \
446 # mandir=${XDIR}/share/man \
448 if [[ -n ${GIT_ECLASS} ]]; then
449 pushd "${EGIT_STORE_DIR}/${EGIT_CLONE_DIR}"
450 git log ${GIT_TREE} > "${S}"/ChangeLog
454 if [[ -e ${S}/ChangeLog ]]; then
455 dodoc "${S}"/ChangeLog
459 # Any documentation to install via dodoc
460 [[ -n ${DOCS} ]] && dodoc ${DOCS}
462 # Don't install libtool archives for server modules
463 if [[ -e ${D}/usr/$(get_libdir)/xorg/modules ]]; then
464 find "${D}"/usr/$(get_libdir)/xorg/modules -name '*.la' \
468 if [[ -n "${FONT}" ]]; then
472 if [[ -n "${DRIVER}" ]]; then
473 install_driver_hwdata
477 # @FUNCTION: x-modular_pkg_preinst
480 # This function doesn't do anything right now, but it may in the future.
481 x-modular_pkg_preinst() {
482 # We no longer do anything here, but we can't remove it from the API
486 # @FUNCTION: x-modular_pkg_postinst
489 # Run X-specific post-installation tasks on the live filesystem. The
490 # only task right now is some setup for font packages.
491 x-modular_pkg_postinst() {
492 if [[ -n "${FONT}" ]]; then
497 # @FUNCTION: x-modular_pkg_postrm
500 # Run X-specific post-removal tasks on the live filesystem. The only
501 # task right now is some cleanup for font packages.
502 x-modular_pkg_postrm() {
503 if [[ -n "${FONT}" ]]; then
508 # @FUNCTION: setup_fonts
511 # Generates needed files for fonts and fixes font permissions
513 if [[ ! -n "${FONT_DIR}" ]]; then
514 msg="FONT_DIR is empty. The ebuild should set it to at least one subdir of /usr/share/fonts."
524 # @FUNCTION: remove_font_metadata
527 # Don't let the package install generated font files that may overlap
528 # with other packages. Instead, they're generated in pkg_postinst().
529 remove_font_metadata() {
531 for DIR in ${FONT_DIR}; do
532 if [[ "${DIR}" != "Speedo" ]] && \
533 [[ "${DIR}" != "CID" ]] ; then
534 # Delete font metadata files
535 # fonts.scale, fonts.dir, fonts.cache-1
536 rm -f "${D}"/usr/share/fonts/${DIR}/fonts.{scale,dir,cache-1}
541 # @FUNCTION: install_driver_hwdata
544 # Installs device-to-driver mappings for system-config-display and
545 # anything else that uses hwdata.
546 install_driver_hwdata() {
547 insinto /usr/share/hwdata/videoaliases
548 for i in "${FILESDIR}"/*.xinf; do
549 # We need this for the case when none exist,
550 # so *.xinf doesn't expand
557 # @FUNCTION: discover_font_dirs
560 # Deprecated. Sets up the now-unused FONT_DIRS variable.
561 discover_font_dirs() {
562 FONT_DIRS="${FONT_DIR}"
565 # @FUNCTION: create_fonts_scale
568 # Create fonts.scale file, used by the old server-side fonts subsystem.
569 create_fonts_scale() {
570 ebegin "Creating fonts.scale files"
572 for DIR in ${FONT_DIR}; do
573 x=${ROOT}/usr/share/fonts/${DIR}
574 [[ -z "$(ls ${x}/)" ]] && continue
575 [[ "$(ls ${x}/)" = "fonts.cache-1" ]] && continue
577 # Only generate .scale files if truetype, opentype or type1
578 # fonts are present ...
580 # NOTE: There is no way to regenerate Speedo/CID fonts.scale
581 # <dberkholz@gentoo.org> 2 August 2004
582 if [[ "${x/encodings}" = "${x}" ]] \
583 && [[ -n "$(find ${x} -iname '*.[pot][ft][abcf]' -print)" ]]; then
585 -a "${ROOT}"/usr/share/fonts/encodings/encodings.dir \
592 # @FUNCTION: create_fonts_dir
595 # Create fonts.dir file, used by the old server-side fonts subsystem.
597 ebegin "Generating fonts.dir files"
598 for DIR in ${FONT_DIR}; do
599 x=${ROOT}/usr/share/fonts/${DIR}
600 [[ -z "$(ls ${x}/)" ]] && continue
601 [[ "$(ls ${x}/)" = "fonts.cache-1" ]] && continue
603 if [[ "${x/encodings}" = "${x}" ]]; then
605 -e "${ROOT}"/usr/share/fonts/encodings \
606 -e "${ROOT}"/usr/share/fonts/encodings/large \
613 # @FUNCTION: create_font_cache
616 # Create fonts.cache-1 files, used by the new client-side fonts
618 create_font_cache() {