1 # Copyright 1999-2015 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
5 # @ECLASS: xorg-2.eclass
9 # Author: Tomáš Chvátal <scarabeus@gentoo.org>
10 # Author: Donnie Berkholz <dberkholz@gentoo.org>
11 # @BLURB: Reduces code duplication in the modularized X11 ebuilds.
13 # This eclass makes trivial X ebuilds possible for apps, fonts, drivers,
14 # and more. Many things that would normally be done in various functions
15 # can be accessed by setting variables instead, such as patching,
16 # running eautoreconf, passing options to configure and installing docs.
18 # All you need to do in a basic ebuild is inherit this eclass and set
19 # DESCRIPTION, KEYWORDS and RDEPEND/DEPEND. If your package is hosted
20 # with the other X packages, you don't need to set SRC_URI. Pretty much
21 # everything else should be automatic.
24 if [[ ${PV} == *9999* ]]; then
26 XORG_EAUTORECONF="yes"
29 # If we're a font package, but not the font.alias one
31 if [[ ${PN} == font* \
32 && ${CATEGORY} = media-fonts \
33 && ${PN} != font-alias \
34 && ${PN} != font-util ]]; then
35 # Activate font code in the rest of the eclass
40 # @ECLASS-VARIABLE: XORG_MULTILIB
42 # If set to 'yes', the multilib support for package will be enabled. Set
43 # before inheriting this eclass.
44 : ${XORG_MULTILIB:="no"}
46 # we need to inherit autotools first to get the deps
47 inherit autotools autotools-utils eutils libtool multilib toolchain-funcs \
48 flag-o-matic ${FONT_ECLASS} ${GIT_ECLASS}
50 if [[ ${XORG_MULTILIB} == yes ]]; then
51 inherit autotools-multilib
54 EXPORTED_FUNCTIONS="src_unpack src_compile src_install pkg_postinst pkg_postrm"
56 3|4|5) EXPORTED_FUNCTIONS="${EXPORTED_FUNCTIONS} src_prepare src_configure" ;;
57 *) die "EAPI=${EAPI} is not supported" ;;
60 # exports must be ALWAYS after inherit
61 EXPORT_FUNCTIONS ${EXPORTED_FUNCTIONS}
64 HOMEPAGE="http://xorg.freedesktop.org/"
66 # @ECLASS-VARIABLE: XORG_EAUTORECONF
68 # If set to 'yes' and configure.ac exists, eautoreconf will run. Set
69 # before inheriting this eclass.
70 : ${XORG_EAUTORECONF:="no"}
72 # @ECLASS-VARIABLE: XORG_BASE_INDIVIDUAL_URI
74 # Set up SRC_URI for individual modular releases. If set to an empty
75 # string, no SRC_URI will be provided by the eclass.
76 : ${XORG_BASE_INDIVIDUAL_URI="http://xorg.freedesktop.org/releases/individual"}
78 # @ECLASS-VARIABLE: XORG_MODULE
80 # The subdirectory to download source from. Possible settings are app,
81 # doc, data, util, driver, font, lib, proto, xserver. Set above the
82 # inherit to override the default autoconfigured module.
83 if [[ -z ${XORG_MODULE} ]]; then
85 app-doc) XORG_MODULE=doc/ ;;
86 media-fonts) XORG_MODULE=font/ ;;
87 x11-apps|x11-wm) XORG_MODULE=app/ ;;
88 x11-misc|x11-themes) XORG_MODULE=util/ ;;
89 x11-base) XORG_MODULE=xserver/ ;;
90 x11-drivers) XORG_MODULE=driver/ ;;
91 x11-proto) XORG_MODULE=proto/ ;;
92 x11-libs) XORG_MODULE=lib/ ;;
97 # @ECLASS-VARIABLE: XORG_PACKAGE_NAME
99 # For git checkout the git repository might differ from package name.
100 # This variable can be used for proper directory specification
101 : ${XORG_PACKAGE_NAME:=${PN}}
103 if [[ -n ${GIT_ECLASS} ]]; then
104 : ${EGIT_REPO_URI:="git://anongit.freedesktop.org/xorg/${XORG_MODULE}${XORG_PACKAGE_NAME} http://anongit.freedesktop.org/git/xorg/${XORG_MODULE}${XORG_PACKAGE_NAME}"}
105 elif [[ -n ${XORG_BASE_INDIVIDUAL_URI} ]]; then
106 SRC_URI="${XORG_BASE_INDIVIDUAL_URI}/${XORG_MODULE}${P}.tar.bz2"
111 # Set the license for the package. This can be overridden by setting
112 # LICENSE after the inherit. Nearly all FreeDesktop-hosted X packages
113 # are under the MIT license. (This is what Red Hat does in their rpms)
116 # Set up autotools shared dependencies
117 # Remember that all versions here MUST be stable
118 XORG_EAUTORECONF_ARCHES="x86-interix ppc-aix x86-winnt"
119 EAUTORECONF_DEPEND+="
120 >=sys-devel/libtool-2.2.6a
122 if [[ ${PN} != util-macros ]] ; then
123 EAUTORECONF_DEPEND+=" >=x11-misc/util-macros-1.18"
124 # Required even by xorg-server
125 [[ ${PN} == "font-util" ]] || EAUTORECONF_DEPEND+=" >=media-fonts/font-util-1.2.0"
127 WANT_AUTOCONF="latest"
128 WANT_AUTOMAKE="latest"
129 for arch in ${XORG_EAUTORECONF_ARCHES}; do
130 EAUTORECONF_DEPENDS+=" ${arch}? ( ${EAUTORECONF_DEPEND} )"
132 DEPEND+=" ${EAUTORECONF_DEPENDS}"
133 [[ ${XORG_EAUTORECONF} != no ]] && DEPEND+=" ${EAUTORECONF_DEPEND}"
134 unset EAUTORECONF_DEPENDS
135 unset EAUTORECONF_DEPEND
137 if [[ ${FONT} == yes ]]; then
138 RDEPEND+=" media-fonts/encodings
141 PDEPEND+=" media-fonts/font-alias"
142 DEPEND+=" >=media-fonts/font-util-1.2.0"
144 # @ECLASS-VARIABLE: FONT_DIR
146 # If you're creating a font package and the suffix of PN is not equal to
147 # the subdirectory of /usr/share/fonts/ it should install into, set
148 # FONT_DIR to that directory or directories. Set before inheriting this
150 [[ -z ${FONT_DIR} ]] && FONT_DIR=${PN##*-}
152 # Fix case of font directories
153 FONT_DIR=${FONT_DIR/ttf/TTF}
154 FONT_DIR=${FONT_DIR/otf/OTF}
155 FONT_DIR=${FONT_DIR/type1/Type1}
156 FONT_DIR=${FONT_DIR/speedo/Speedo}
158 # Set up configure options, wrapped so ebuilds can override if need be
159 [[ -z ${FONT_OPTIONS} ]] && FONT_OPTIONS="--with-fontdir=\"${EPREFIX}/usr/share/fonts/${FONT_DIR}\""
161 [[ ${PN##*-} = misc || ${PN##*-} = 75dpi || ${PN##*-} = 100dpi || ${PN##*-} = cyrillic ]] && IUSE+=" nls"
164 # If we're a driver package, then enable DRIVER case
165 [[ ${PN} == xf86-video-* || ${PN} == xf86-input-* ]] && DRIVER="yes"
167 # @ECLASS-VARIABLE: XORG_STATIC
169 # Enables static-libs useflag. Set to no, if your package gets:
171 # QA: configure: WARNING: unrecognized options: --disable-static
172 : ${XORG_STATIC:="yes"}
174 # Add static-libs useflag where usefull.
175 if [[ ${XORG_STATIC} == yes \
177 && ${CATEGORY} != app-doc \
178 && ${CATEGORY} != x11-apps \
179 && ${CATEGORY} != x11-proto \
180 && ${CATEGORY} != x11-drivers \
181 && ${CATEGORY} != media-fonts \
182 && ${PN} != util-macros \
183 && ${PN} != xbitmaps \
184 && ${PN} != xorg-cf-files \
185 && ${PN/xcursor} = ${PN} ]]; then
189 DEPEND+=" virtual/pkgconfig"
191 # @ECLASS-VARIABLE: XORG_DRI
193 # Possible values are "always" or the value of the useflag DRI capabilities
194 # are required for. Default value is "no"
196 # Eg. XORG_DRI="opengl" will pull all dri dependant deps for opengl useflag
200 x11-base/xorg-server[-minimal]
204 x11-proto/xf86driproto
212 COMMON_DEPEND+=" ${DRI_COMMON_DEPEND}"
213 DEPEND+=" ${DRI_DEPEND}"
216 COMMON_DEPEND+=" ${XORG_DRI}? ( ${DRI_COMMON_DEPEND} )"
217 DEPEND+=" ${XORG_DRI}? ( ${DRI_DEPEND} )"
222 unset DRI_COMMONDEPEND
224 if [[ -n "${DRIVER}" ]]; then
226 x11-base/xorg-server[xorg]
229 if [[ -n "${DRIVER}" && ${PN} == xf86-input-* ]]; then
236 if [[ -n "${DRIVER}" && ${PN} == xf86-video-* ]]; then
238 x11-libs/libpciaccess
240 # we also needs some protos and libs in all cases
244 x11-proto/renderproto
247 x11-proto/xineramaproto
252 # @ECLASS-VARIABLE: XORG_DOC
254 # Possible values are "always" or the value of the useflag doc packages
255 # are required for. Default value is "no"
257 # Eg. XORG_DOC="manual" will pull all doc dependant deps for manual useflag
265 app-text/docbook-xml-dtd:4.1.2
266 app-text/docbook-xml-dtd:4.2
267 app-text/docbook-xml-dtd:4.3
274 DEPEND+=" ${DOC_DEPEND}"
277 DEPEND+=" ${XORG_DOC}? ( ${DOC_DEPEND} )"
283 # @ECLASS-VARIABLE: XORG_MODULE_REBUILD
285 # Describes whether a package contains modules that need to be rebuilt on
286 # xorg-server upgrade. This has an effect only since EAPI=5.
287 # Possible values are "yes" or "no". Default value is "yes" for packages which
288 # are recognized as DRIVER by this eclass and "no" for all other packages.
289 if [[ "${DRIVER}" == yes ]]; then
290 : ${XORG_MODULE_REBUILD:="yes"}
292 : ${XORG_MODULE_REBUILD:="no"}
295 if [[ ${XORG_MODULE_REBUILD} == yes ]]; then
300 RDEPEND+=" x11-base/xorg-server:="
305 DEPEND+=" ${COMMON_DEPEND}"
306 RDEPEND+=" ${COMMON_DEPEND}"
309 if [[ ${XORG_MULTILIB} == yes ]]; then
310 RDEPEND+=" abi_x86_32? ( !app-emulation/emul-linux-x86-xlibs[-abi_x86_32(-)] )"
313 debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: DEPEND=${DEPEND}"
314 debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: RDEPEND=${RDEPEND}"
315 debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: PDEPEND=${PDEPEND}"
317 # @FUNCTION: xorg-2_pkg_setup
319 # Setup prefix compat
321 debug-print-function ${FUNCNAME} "$@"
323 [[ ${FONT} == yes ]] && font_pkg_setup "$@"
326 # @FUNCTION: xorg-2_src_unpack
328 # Simply unpack source code.
329 xorg-2_src_unpack() {
330 debug-print-function ${FUNCNAME} "$@"
332 if [[ -n ${GIT_ECLASS} ]]; then
338 [[ -n ${FONT_OPTIONS} ]] && einfo "Detected font directory: ${FONT_DIR}"
341 # @FUNCTION: xorg-2_patch_source
344 xorg-2_patch_source() {
345 debug-print-function ${FUNCNAME} "$@"
347 # Use standardized names and locations with bulk patching
348 # Patch directory is ${WORKDIR}/patch
349 # See epatch() in eutils.eclass for more documentation
350 EPATCH_SUFFIX=${EPATCH_SUFFIX:=patch}
352 [[ -d "${EPATCH_SOURCE}" ]] && epatch
355 # @FUNCTION: xorg-2_reconf_source
357 # Run eautoreconf if necessary, and run elibtoolize.
358 xorg-2_reconf_source() {
359 debug-print-function ${FUNCNAME} "$@"
362 *-interix* | *-aix* | *-winnt*)
363 # some hosts need full eautoreconf
364 [[ -e "./configure.ac" || -e "./configure.in" ]] \
365 && AUTOTOOLS_AUTORECONF=1
368 # elibtoolize required for BSD
369 [[ ${XORG_EAUTORECONF} != no && ( -e "./configure.ac" || -e "./configure.in" ) ]] \
370 && AUTOTOOLS_AUTORECONF=1
375 # @FUNCTION: xorg-2_src_prepare
377 # Prepare a package after unpacking, performing all X-related tasks.
378 xorg-2_src_prepare() {
379 debug-print-function ${FUNCNAME} "$@"
383 autotools-utils_src_prepare "$@"
386 # @FUNCTION: xorg-2_font_configure
388 # If a font package, perform any necessary configuration steps
389 xorg-2_font_configure() {
390 debug-print-function ${FUNCNAME} "$@"
392 if has nls ${IUSE//+} && ! use nls; then
393 if grep -q -s "disable-all-encodings" ${ECONF_SOURCE:-.}/configure; then
395 --disable-all-encodings"
419 # @FUNCTION: xorg-2_flags_setup
421 # Set up CFLAGS for a debug build
422 xorg-2_flags_setup() {
423 debug-print-function ${FUNCNAME} "$@"
425 # Win32 require special define
426 [[ ${CHOST} == *-winnt* ]] && append-cppflags -DWIN32 -D__STDC__
428 [[ ${PN} = xorg-server || -n ${DRIVER} ]] && append-ldflags -Wl,-z,lazy
430 # Quite few libraries fail on runtime without these:
431 if has static-libs ${IUSE//+}; then
432 filter-flags -Wl,-Bdirect
433 filter-ldflags -Bdirect
434 filter-ldflags -Wl,-Bdirect
438 # @FUNCTION: xorg-2_src_configure
440 # Perform any necessary pre-configuration steps, then run configure
441 xorg-2_src_configure() {
442 debug-print-function ${FUNCNAME} "$@"
446 # @VARIABLE: XORG_CONFIGURE_OPTIONS
448 # Array of an additional options to pass to configure.
450 if [[ $(declare -p XORG_CONFIGURE_OPTIONS 2>&-) != "declare -a"* ]]; then
451 # fallback to CONFIGURE_OPTIONS, deprecated.
452 if [[ -n "${CONFIGURE_OPTIONS}" ]]; then
453 eqawarn "CONFIGURE_OPTIONS are deprecated. Please migrate to XORG_CONFIGURE_OPTIONS"
454 eqawarn "to preserve namespace."
457 local xorgconfadd=(${CONFIGURE_OPTIONS} ${XORG_CONFIGURE_OPTIONS})
459 local xorgconfadd=("${XORG_CONFIGURE_OPTIONS[@]}")
462 [[ -n "${FONT}" ]] && xorg-2_font_configure
464 # Check if package supports disabling of dep tracking
465 # Fixes warnings like:
466 # WARNING: unrecognized options: --disable-dependency-tracking
467 if grep -q -s "disable-depencency-tracking" ${ECONF_SOURCE:-.}/configure; then
468 local dep_track="--disable-dependency-tracking"
477 if [[ ${XORG_MULTILIB} == yes ]]; then
478 autotools-multilib_src_configure "$@"
480 autotools-utils_src_configure "$@"
484 # @FUNCTION: xorg-2_src_compile
486 # Compile a package, performing all X-related tasks.
487 xorg-2_src_compile() {
488 debug-print-function ${FUNCNAME} "$@"
490 if [[ ${XORG_MULTILIB} == yes ]]; then
491 autotools-multilib_src_compile "$@"
493 autotools-utils_src_compile "$@"
497 # @FUNCTION: xorg-2_src_install
499 # Install a built package to ${D}, performing any necessary steps.
500 # Creates a ChangeLog from git if using live ebuilds.
501 xorg-2_src_install() {
502 debug-print-function ${FUNCNAME} "$@"
504 local install_args=( docdir="${EPREFIX}/usr/share/doc/${PF}" )
506 if [[ ${CATEGORY} == x11-proto ]]; then
508 ${PN/proto/}docdir="${EPREFIX}/usr/share/doc/${PF}"
512 if [[ ${XORG_MULTILIB} == yes ]]; then
513 autotools-multilib_src_install "${install_args[@]}"
515 autotools-utils_src_install "${install_args[@]}"
518 if [[ -n ${GIT_ECLASS} ]]; then
519 pushd "${EGIT_STORE_DIR}/${EGIT_CLONE_DIR}" > /dev/null || die
520 git log ${EGIT_COMMIT} > "${S}"/ChangeLog
521 popd > /dev/null || die
524 if [[ -e "${S}"/ChangeLog ]]; then
525 dodoc "${S}"/ChangeLog || die "dodoc failed"
528 # Don't install libtool archives (even for modules)
529 prune_libtool_files --all
531 [[ -n ${FONT} ]] && remove_font_metadata
534 # @FUNCTION: xorg-2_pkg_postinst
536 # Run X-specific post-installation tasks on the live filesystem. The
537 # only task right now is some setup for font packages.
538 xorg-2_pkg_postinst() {
539 debug-print-function ${FUNCNAME} "$@"
541 if [[ -n ${FONT} ]]; then
544 font_pkg_postinst "$@"
548 # @FUNCTION: xorg-2_pkg_postrm
550 # Run X-specific post-removal tasks on the live filesystem. The only
551 # task right now is some cleanup for font packages.
552 xorg-2_pkg_postrm() {
553 debug-print-function ${FUNCNAME} "$@"
555 if [[ -n ${FONT} ]]; then
556 # if we're doing an upgrade, postinst will do
557 if [[ ${EAPI} -lt 4 || -z ${REPLACED_BY_VERSION} ]]; then
565 # @FUNCTION: remove_font_metadata
567 # Don't let the package install generated font files that may overlap
568 # with other packages. Instead, they're generated in pkg_postinst().
569 remove_font_metadata() {
570 debug-print-function ${FUNCNAME} "$@"
572 if [[ ${FONT_DIR} != Speedo && ${FONT_DIR} != CID ]]; then
573 einfo "Removing font metadata"
574 rm -rf "${ED}"/usr/share/fonts/${FONT_DIR}/fonts.{scale,dir,cache-1}
578 # @FUNCTION: create_fonts_scale
580 # Create fonts.scale file, used by the old server-side fonts subsystem.
581 create_fonts_scale() {
582 debug-print-function ${FUNCNAME} "$@"
584 if [[ ${FONT_DIR} != Speedo && ${FONT_DIR} != CID ]]; then
585 ebegin "Generating fonts.scale"
587 -a "${EROOT}/usr/share/fonts/encodings/encodings.dir" \
588 -- "${EROOT}/usr/share/fonts/${FONT_DIR}"
593 # @FUNCTION: create_fonts_dir
595 # Create fonts.dir file, used by the old server-side fonts subsystem.
597 debug-print-function ${FUNCNAME} "$@"
599 ebegin "Generating fonts.dir"
601 -e "${EROOT}"/usr/share/fonts/encodings \
602 -e "${EROOT}"/usr/share/fonts/encodings/large \
603 -- "${EROOT}/usr/share/fonts/${FONT_DIR}"