1 # Copyright 1999-2017 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
4 # @ECLASS: xorg-2.eclass
8 # Author: Tomáš Chvátal <scarabeus@gentoo.org>
9 # Author: Donnie Berkholz <dberkholz@gentoo.org>
10 # @BLURB: Reduces code duplication in the modularized X11 ebuilds.
12 # This eclass makes trivial X ebuilds possible for apps, fonts, drivers,
13 # and more. Many things that would normally be done in various functions
14 # can be accessed by setting variables instead, such as patching,
15 # running eautoreconf, passing options to configure and installing docs.
17 # All you need to do in a basic ebuild is inherit this eclass and set
18 # DESCRIPTION, KEYWORDS and RDEPEND/DEPEND. If your package is hosted
19 # with the other X packages, you don't need to set SRC_URI. Pretty much
20 # everything else should be automatic.
23 if [[ ${PV} == *9999* ]]; then
25 XORG_EAUTORECONF="yes"
28 # If we're a font package, but not the font.alias one
30 if [[ ${PN} == font* \
31 && ${CATEGORY} = media-fonts \
32 && ${PN} != font-alias \
33 && ${PN} != font-util ]]; then
34 # Activate font code in the rest of the eclass
39 # @ECLASS-VARIABLE: XORG_MULTILIB
41 # If set to 'yes', the multilib support for package will be enabled. Set
42 # before inheriting this eclass.
43 : ${XORG_MULTILIB:="no"}
45 # we need to inherit autotools first to get the deps
46 inherit autotools autotools-utils eutils libtool multilib toolchain-funcs \
47 flag-o-matic ${FONT_ECLASS} ${GIT_ECLASS}
49 if [[ ${XORG_MULTILIB} == yes ]]; then
50 inherit autotools-multilib
53 EXPORTED_FUNCTIONS="src_unpack src_compile src_install pkg_postinst pkg_postrm"
55 3|4|5) EXPORTED_FUNCTIONS="${EXPORTED_FUNCTIONS} src_prepare src_configure" ;;
56 *) die "EAPI=${EAPI} is not supported" ;;
59 # exports must be ALWAYS after inherit
60 EXPORT_FUNCTIONS ${EXPORTED_FUNCTIONS}
63 HOMEPAGE="https://www.x.org/wiki/"
65 # @ECLASS-VARIABLE: XORG_EAUTORECONF
67 # If set to 'yes' and configure.ac exists, eautoreconf will run. Set
68 # before inheriting this eclass.
69 : ${XORG_EAUTORECONF:="no"}
71 # @ECLASS-VARIABLE: XORG_BASE_INDIVIDUAL_URI
73 # Set up SRC_URI for individual modular releases. If set to an empty
74 # string, no SRC_URI will be provided by the eclass.
75 : ${XORG_BASE_INDIVIDUAL_URI="https://www.x.org/releases/individual"}
77 # @ECLASS-VARIABLE: XORG_MODULE
79 # The subdirectory to download source from. Possible settings are app,
80 # doc, data, util, driver, font, lib, proto, xserver. Set above the
81 # inherit to override the default autoconfigured module.
82 if [[ -z ${XORG_MODULE} ]]; then
84 app-doc) XORG_MODULE=doc/ ;;
85 media-fonts) XORG_MODULE=font/ ;;
86 x11-apps|x11-wm) XORG_MODULE=app/ ;;
87 x11-misc|x11-themes) XORG_MODULE=util/ ;;
88 x11-base) XORG_MODULE=xserver/ ;;
89 x11-drivers) XORG_MODULE=driver/ ;;
90 x11-proto) XORG_MODULE=proto/ ;;
91 x11-libs) XORG_MODULE=lib/ ;;
96 # @ECLASS-VARIABLE: XORG_PACKAGE_NAME
98 # For git checkout the git repository might differ from package name.
99 # This variable can be used for proper directory specification
100 : ${XORG_PACKAGE_NAME:=${PN}}
102 if [[ -n ${GIT_ECLASS} ]]; then
103 : ${EGIT_REPO_URI:="https://anongit.freedesktop.org/git/xorg/${XORG_MODULE}${XORG_PACKAGE_NAME}.git"}
104 elif [[ -n ${XORG_BASE_INDIVIDUAL_URI} ]]; then
105 SRC_URI="${XORG_BASE_INDIVIDUAL_URI}/${XORG_MODULE}${P}.tar.bz2"
110 # Set the license for the package. This can be overridden by setting
111 # LICENSE after the inherit. Nearly all FreeDesktop-hosted X packages
112 # are under the MIT license. (This is what Red Hat does in their rpms)
115 # Set up autotools shared dependencies
116 # Remember that all versions here MUST be stable
117 XORG_EAUTORECONF_ARCHES="ppc-aix x86-winnt"
118 EAUTORECONF_DEPEND+="
119 >=sys-devel/libtool-2.2.6a
121 if [[ ${PN} != util-macros ]] ; then
122 EAUTORECONF_DEPEND+=" >=x11-misc/util-macros-1.18"
123 # Required even by xorg-server
124 [[ ${PN} == "font-util" ]] || EAUTORECONF_DEPEND+=" >=media-fonts/font-util-1.2.0"
126 WANT_AUTOCONF="latest"
127 WANT_AUTOMAKE="latest"
128 for arch in ${XORG_EAUTORECONF_ARCHES}; do
129 EAUTORECONF_DEPENDS+=" ${arch}? ( ${EAUTORECONF_DEPEND} )"
131 DEPEND+=" ${EAUTORECONF_DEPENDS}"
132 [[ ${XORG_EAUTORECONF} != no ]] && DEPEND+=" ${EAUTORECONF_DEPEND}"
133 unset EAUTORECONF_DEPENDS
134 unset EAUTORECONF_DEPEND
136 if [[ ${FONT} == yes ]]; then
137 RDEPEND+=" media-fonts/encodings
140 PDEPEND+=" media-fonts/font-alias"
141 DEPEND+=" >=media-fonts/font-util-1.2.0"
143 # @ECLASS-VARIABLE: FONT_DIR
145 # If you're creating a font package and the suffix of PN is not equal to
146 # the subdirectory of /usr/share/fonts/ it should install into, set
147 # FONT_DIR to that directory or directories. Set before inheriting this
149 [[ -z ${FONT_DIR} ]] && FONT_DIR=${PN##*-}
151 # Fix case of font directories
152 FONT_DIR=${FONT_DIR/ttf/TTF}
153 FONT_DIR=${FONT_DIR/otf/OTF}
154 FONT_DIR=${FONT_DIR/type1/Type1}
155 FONT_DIR=${FONT_DIR/speedo/Speedo}
157 # Set up configure options, wrapped so ebuilds can override if need be
158 [[ -z ${FONT_OPTIONS} ]] && FONT_OPTIONS="--with-fontdir=\"${EPREFIX}/usr/share/fonts/${FONT_DIR}\""
160 [[ ${PN##*-} = misc || ${PN##*-} = 75dpi || ${PN##*-} = 100dpi || ${PN##*-} = cyrillic ]] && IUSE+=" nls"
163 # If we're a driver package, then enable DRIVER case
164 [[ ${PN} == xf86-video-* || ${PN} == xf86-input-* ]] && DRIVER="yes"
166 # @ECLASS-VARIABLE: XORG_STATIC
168 # Enables static-libs useflag. Set to no, if your package gets:
170 # QA: configure: WARNING: unrecognized options: --disable-static
171 : ${XORG_STATIC:="yes"}
173 # Add static-libs useflag where usefull.
174 if [[ ${XORG_STATIC} == yes \
176 && ${CATEGORY} != app-doc \
177 && ${CATEGORY} != x11-apps \
178 && ${CATEGORY} != x11-proto \
179 && ${CATEGORY} != x11-drivers \
180 && ${CATEGORY} != media-fonts \
181 && ${PN} != util-macros \
182 && ${PN} != xbitmaps \
183 && ${PN} != xorg-cf-files \
184 && ${PN/xcursor} = ${PN} ]]; then
188 DEPEND+=" virtual/pkgconfig"
190 # @ECLASS-VARIABLE: XORG_DRI
192 # Possible values are "always" or the value of the useflag DRI capabilities
193 # are required for. Default value is "no"
195 # Eg. XORG_DRI="opengl" will pull all dri dependant deps for opengl useflag
199 x11-base/xorg-server[-minimal]
206 COMMON_DEPEND+=" ${DRI_COMMON_DEPEND}"
209 COMMON_DEPEND+=" ${XORG_DRI}? ( ${DRI_COMMON_DEPEND} )"
213 unset DRI_COMMONDEPEND
215 if [[ -n "${DRIVER}" ]]; then
217 x11-base/xorg-server[xorg]
220 if [[ -n "${DRIVER}" && ${PN} == xf86-input-* ]]; then
221 DEPEND+="x11-base/xorg-proto"
223 if [[ -n "${DRIVER}" && ${PN} == xf86-video-* ]]; then
225 x11-libs/libpciaccess
227 DEPEND+="x11-base/xorg-proto"
230 # @ECLASS-VARIABLE: XORG_DOC
232 # Possible values are "always" or the value of the useflag doc packages
233 # are required for. Default value is "no"
235 # Eg. XORG_DOC="manual" will pull all doc dependant deps for manual useflag
243 app-text/docbook-xml-dtd:4.1.2
244 app-text/docbook-xml-dtd:4.2
245 app-text/docbook-xml-dtd:4.3
252 DEPEND+=" ${DOC_DEPEND}"
255 DEPEND+=" ${XORG_DOC}? ( ${DOC_DEPEND} )"
261 # @ECLASS-VARIABLE: XORG_MODULE_REBUILD
263 # Describes whether a package contains modules that need to be rebuilt on
264 # xorg-server upgrade. This has an effect only since EAPI=5.
265 # Possible values are "yes" or "no". Default value is "yes" for packages which
266 # are recognized as DRIVER by this eclass and "no" for all other packages.
267 if [[ "${DRIVER}" == yes ]]; then
268 : ${XORG_MODULE_REBUILD:="yes"}
270 : ${XORG_MODULE_REBUILD:="no"}
273 if [[ ${XORG_MODULE_REBUILD} == yes ]]; then
278 RDEPEND+=" x11-base/xorg-server:="
283 DEPEND+=" ${COMMON_DEPEND}"
284 RDEPEND+=" ${COMMON_DEPEND}"
287 debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: DEPEND=${DEPEND}"
288 debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: RDEPEND=${RDEPEND}"
289 debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: PDEPEND=${PDEPEND}"
291 # @FUNCTION: xorg-2_pkg_setup
293 # Setup prefix compat
295 debug-print-function ${FUNCNAME} "$@"
297 [[ ${FONT} == yes ]] && font_pkg_setup "$@"
300 # @FUNCTION: xorg-2_src_unpack
302 # Simply unpack source code.
303 xorg-2_src_unpack() {
304 debug-print-function ${FUNCNAME} "$@"
306 if [[ -n ${GIT_ECLASS} ]]; then
312 [[ -n ${FONT_OPTIONS} ]] && einfo "Detected font directory: ${FONT_DIR}"
315 # @FUNCTION: xorg-2_patch_source
318 xorg-2_patch_source() {
319 debug-print-function ${FUNCNAME} "$@"
321 # Use standardized names and locations with bulk patching
322 # Patch directory is ${WORKDIR}/patch
323 # See epatch() in eutils.eclass for more documentation
324 EPATCH_SUFFIX=${EPATCH_SUFFIX:=patch}
326 [[ -d "${EPATCH_SOURCE}" ]] && epatch
329 # @FUNCTION: xorg-2_reconf_source
331 # Run eautoreconf if necessary, and run elibtoolize.
332 xorg-2_reconf_source() {
333 debug-print-function ${FUNCNAME} "$@"
337 # some hosts need full eautoreconf
338 [[ -e "./configure.ac" || -e "./configure.in" ]] \
339 && AUTOTOOLS_AUTORECONF=1
342 # elibtoolize required for BSD
343 [[ ${XORG_EAUTORECONF} != no && ( -e "./configure.ac" || -e "./configure.in" ) ]] \
344 && AUTOTOOLS_AUTORECONF=1
349 # @FUNCTION: xorg-2_src_prepare
351 # Prepare a package after unpacking, performing all X-related tasks.
352 xorg-2_src_prepare() {
353 debug-print-function ${FUNCNAME} "$@"
357 autotools-utils_src_prepare "$@"
360 # @FUNCTION: xorg-2_font_configure
362 # If a font package, perform any necessary configuration steps
363 xorg-2_font_configure() {
364 debug-print-function ${FUNCNAME} "$@"
366 if has nls ${IUSE//+} && ! use nls; then
367 if grep -q -s "disable-all-encodings" ${ECONF_SOURCE:-.}/configure; then
369 --disable-all-encodings"
393 # @FUNCTION: xorg-2_flags_setup
395 # Set up CFLAGS for a debug build
396 xorg-2_flags_setup() {
397 debug-print-function ${FUNCNAME} "$@"
399 # Win32 require special define
400 [[ ${CHOST} == *-winnt* ]] && append-cppflags -DWIN32 -D__STDC__
402 [[ ${PN} = xorg-server || -n ${DRIVER} ]] && append-ldflags -Wl,-z,lazy
404 # Quite few libraries fail on runtime without these:
405 if has static-libs ${IUSE//+}; then
406 filter-flags -Wl,-Bdirect
407 filter-ldflags -Bdirect
408 filter-ldflags -Wl,-Bdirect
412 # @FUNCTION: xorg-2_src_configure
414 # Perform any necessary pre-configuration steps, then run configure
415 xorg-2_src_configure() {
416 debug-print-function ${FUNCNAME} "$@"
420 # @VARIABLE: XORG_CONFIGURE_OPTIONS
422 # Array of an additional options to pass to configure.
424 if [[ $(declare -p XORG_CONFIGURE_OPTIONS 2>&-) != "declare -a"* ]]; then
425 # fallback to CONFIGURE_OPTIONS, deprecated.
426 if [[ -n "${CONFIGURE_OPTIONS}" ]]; then
427 eqawarn "CONFIGURE_OPTIONS are deprecated. Please migrate to XORG_CONFIGURE_OPTIONS"
428 eqawarn "to preserve namespace."
431 local xorgconfadd=(${CONFIGURE_OPTIONS} ${XORG_CONFIGURE_OPTIONS})
433 local xorgconfadd=("${XORG_CONFIGURE_OPTIONS[@]}")
436 [[ -n "${FONT}" ]] && xorg-2_font_configure
438 # Check if package supports disabling of dep tracking
439 # Fixes warnings like:
440 # WARNING: unrecognized options: --disable-dependency-tracking
441 if grep -q -s "disable-depencency-tracking" ${ECONF_SOURCE:-.}/configure; then
442 local dep_track="--disable-dependency-tracking"
445 # Check if package supports disabling of selective -Werror=...
446 if grep -q -s "disable-selective-werror" ${ECONF_SOURCE:-.}/configure; then
447 local selective_werror="--disable-selective-werror"
457 if [[ ${XORG_MULTILIB} == yes ]]; then
458 autotools-multilib_src_configure "$@"
460 autotools-utils_src_configure "$@"
464 # @FUNCTION: xorg-2_src_compile
466 # Compile a package, performing all X-related tasks.
467 xorg-2_src_compile() {
468 debug-print-function ${FUNCNAME} "$@"
470 if [[ ${XORG_MULTILIB} == yes ]]; then
471 autotools-multilib_src_compile "$@"
473 autotools-utils_src_compile "$@"
477 # @FUNCTION: xorg-2_src_install
479 # Install a built package to ${D}, performing any necessary steps.
480 # Creates a ChangeLog from git if using live ebuilds.
481 xorg-2_src_install() {
482 debug-print-function ${FUNCNAME} "$@"
484 local install_args=( docdir="${EPREFIX}/usr/share/doc/${PF}" )
486 if [[ ${CATEGORY} == x11-proto ]]; then
488 ${PN/proto/}docdir="${EPREFIX}/usr/share/doc/${PF}"
492 if [[ ${XORG_MULTILIB} == yes ]]; then
493 autotools-multilib_src_install "${install_args[@]}"
495 autotools-utils_src_install "${install_args[@]}"
498 if [[ -n ${GIT_ECLASS} ]]; then
499 pushd "${EGIT_STORE_DIR}/${EGIT_CLONE_DIR}" > /dev/null || die
500 git log ${EGIT_COMMIT} > "${S}"/ChangeLog
501 popd > /dev/null || die
504 if [[ -e "${S}"/ChangeLog ]]; then
505 dodoc "${S}"/ChangeLog || die "dodoc failed"
508 # Don't install libtool archives (even for modules)
509 prune_libtool_files --all
511 [[ -n ${FONT} ]] && remove_font_metadata
514 # @FUNCTION: xorg-2_pkg_postinst
516 # Run X-specific post-installation tasks on the live filesystem. The
517 # only task right now is some setup for font packages.
518 xorg-2_pkg_postinst() {
519 debug-print-function ${FUNCNAME} "$@"
521 if [[ -n ${FONT} ]]; then
524 font_pkg_postinst "$@"
528 # @FUNCTION: xorg-2_pkg_postrm
530 # Run X-specific post-removal tasks on the live filesystem. The only
531 # task right now is some cleanup for font packages.
532 xorg-2_pkg_postrm() {
533 debug-print-function ${FUNCNAME} "$@"
535 if [[ -n ${FONT} ]]; then
536 # if we're doing an upgrade, postinst will do
537 if [[ ${EAPI} -lt 4 || -z ${REPLACED_BY_VERSION} ]]; then
545 # @FUNCTION: remove_font_metadata
547 # Don't let the package install generated font files that may overlap
548 # with other packages. Instead, they're generated in pkg_postinst().
549 remove_font_metadata() {
550 debug-print-function ${FUNCNAME} "$@"
552 if [[ ${FONT_DIR} != Speedo && ${FONT_DIR} != CID ]]; then
553 einfo "Removing font metadata"
554 rm -rf "${ED}"/usr/share/fonts/${FONT_DIR}/fonts.{scale,dir,cache-1}
558 # @FUNCTION: create_fonts_scale
560 # Create fonts.scale file, used by the old server-side fonts subsystem.
561 create_fonts_scale() {
562 debug-print-function ${FUNCNAME} "$@"
564 if [[ ${FONT_DIR} != Speedo && ${FONT_DIR} != CID ]]; then
565 ebegin "Generating fonts.scale"
567 -a "${EROOT}/usr/share/fonts/encodings/encodings.dir" \
568 -- "${EROOT}/usr/share/fonts/${FONT_DIR}"
573 # @FUNCTION: create_fonts_dir
575 # Create fonts.dir file, used by the old server-side fonts subsystem.
577 debug-print-function ${FUNCNAME} "$@"
579 ebegin "Generating fonts.dir"
581 -e "${EROOT}"/usr/share/fonts/encodings \
582 -e "${EROOT}"/usr/share/fonts/encodings/large \
583 -- "${EROOT}/usr/share/fonts/${FONT_DIR}"