xorg-2.eclass: Transition deps to x11-base/xorg-proto
[gentoo.git] / eclass / xorg-2.eclass
1 # Copyright 1999-2017 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
3
4 # @ECLASS: xorg-2.eclass
5 # @MAINTAINER:
6 # x11@gentoo.org
7 # @AUTHOR:
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.
11 # @DESCRIPTION:
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.
16 #
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.
21
22 GIT_ECLASS=""
23 if [[ ${PV} == *9999* ]]; then
24         GIT_ECLASS="git-r3"
25         XORG_EAUTORECONF="yes"
26 fi
27
28 # If we're a font package, but not the font.alias one
29 FONT_ECLASS=""
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
35         FONT="yes"
36         FONT_ECLASS="font"
37 fi
38
39 # @ECLASS-VARIABLE: XORG_MULTILIB
40 # @DESCRIPTION:
41 # If set to 'yes', the multilib support for package will be enabled. Set
42 # before inheriting this eclass.
43 : ${XORG_MULTILIB:="no"}
44
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}
48
49 if [[ ${XORG_MULTILIB} == yes ]]; then
50         inherit autotools-multilib
51 fi
52
53 EXPORTED_FUNCTIONS="src_unpack src_compile src_install pkg_postinst pkg_postrm"
54 case "${EAPI:-0}" in
55         3|4|5) EXPORTED_FUNCTIONS="${EXPORTED_FUNCTIONS} src_prepare src_configure" ;;
56         *) die "EAPI=${EAPI} is not supported" ;;
57 esac
58
59 # exports must be ALWAYS after inherit
60 EXPORT_FUNCTIONS ${EXPORTED_FUNCTIONS}
61
62 IUSE=""
63 HOMEPAGE="https://www.x.org/wiki/"
64
65 # @ECLASS-VARIABLE: XORG_EAUTORECONF
66 # @DESCRIPTION:
67 # If set to 'yes' and configure.ac exists, eautoreconf will run. Set
68 # before inheriting this eclass.
69 : ${XORG_EAUTORECONF:="no"}
70
71 # @ECLASS-VARIABLE: XORG_BASE_INDIVIDUAL_URI
72 # @DESCRIPTION:
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"}
76
77 # @ECLASS-VARIABLE: XORG_MODULE
78 # @DESCRIPTION:
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
83         case ${CATEGORY} in
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/     ;;
92                 *)                   XORG_MODULE=         ;;
93         esac
94 fi
95
96 # @ECLASS-VARIABLE: XORG_PACKAGE_NAME
97 # @DESCRIPTION:
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}}
101
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"
106 fi
107
108 : ${SLOT:=0}
109
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)
113 : ${LICENSE:=MIT}
114
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
120         sys-devel/m4"
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"
125 fi
126 WANT_AUTOCONF="latest"
127 WANT_AUTOMAKE="latest"
128 for arch in ${XORG_EAUTORECONF_ARCHES}; do
129         EAUTORECONF_DEPENDS+=" ${arch}? ( ${EAUTORECONF_DEPEND} )"
130 done
131 DEPEND+=" ${EAUTORECONF_DEPENDS}"
132 [[ ${XORG_EAUTORECONF} != no ]] && DEPEND+=" ${EAUTORECONF_DEPEND}"
133 unset EAUTORECONF_DEPENDS
134 unset EAUTORECONF_DEPEND
135
136 if [[ ${FONT} == yes ]]; then
137         RDEPEND+=" media-fonts/encodings
138                 x11-apps/mkfontscale
139                 x11-apps/mkfontdir"
140         PDEPEND+=" media-fonts/font-alias"
141         DEPEND+=" >=media-fonts/font-util-1.2.0"
142
143         # @ECLASS-VARIABLE: FONT_DIR
144         # @DESCRIPTION:
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
148         # eclass.
149         [[ -z ${FONT_DIR} ]] && FONT_DIR=${PN##*-}
150
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}
156
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}\""
159
160         [[ ${PN##*-} = misc || ${PN##*-} = 75dpi || ${PN##*-} = 100dpi || ${PN##*-} = cyrillic ]] && IUSE+=" nls"
161 fi
162
163 # If we're a driver package, then enable DRIVER case
164 [[ ${PN} == xf86-video-* || ${PN} == xf86-input-* ]] && DRIVER="yes"
165
166 # @ECLASS-VARIABLE: XORG_STATIC
167 # @DESCRIPTION:
168 # Enables static-libs useflag. Set to no, if your package gets:
169 #
170 # QA: configure: WARNING: unrecognized options: --disable-static
171 : ${XORG_STATIC:="yes"}
172
173 # Add static-libs useflag where usefull.
174 if [[ ${XORG_STATIC} == yes \
175                 && ${FONT} != 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
185         IUSE+=" static-libs"
186 fi
187
188 DEPEND+=" virtual/pkgconfig"
189
190 # @ECLASS-VARIABLE: XORG_DRI
191 # @DESCRIPTION:
192 # Possible values are "always" or the value of the useflag DRI capabilities
193 # are required for. Default value is "no"
194 #
195 # Eg. XORG_DRI="opengl" will pull all dri dependant deps for opengl useflag
196 : ${XORG_DRI:="no"}
197
198 DRI_COMMON_DEPEND="
199         x11-base/xorg-server[-minimal]
200         x11-libs/libdrm
201 "
202 case ${XORG_DRI} in
203         no)
204                 ;;
205         always)
206                 COMMON_DEPEND+=" ${DRI_COMMON_DEPEND}"
207                 ;;
208         *)
209                 COMMON_DEPEND+=" ${XORG_DRI}? ( ${DRI_COMMON_DEPEND} )"
210                 IUSE+=" ${XORG_DRI}"
211                 ;;
212 esac
213 unset DRI_COMMONDEPEND
214
215 if [[ -n "${DRIVER}" ]]; then
216         COMMON_DEPEND+="
217                 x11-base/xorg-server[xorg]
218         "
219 fi
220 if [[ -n "${DRIVER}" && ${PN} == xf86-input-* ]]; then
221         DEPEND+="x11-base/xorg-proto"
222 fi
223 if [[ -n "${DRIVER}" && ${PN} == xf86-video-* ]]; then
224         COMMON_DEPEND+="
225                 x11-libs/libpciaccess
226         "
227         DEPEND+="x11-base/xorg-proto"
228 fi
229
230 # @ECLASS-VARIABLE: XORG_DOC
231 # @DESCRIPTION:
232 # Possible values are "always" or the value of the useflag doc packages
233 # are required for. Default value is "no"
234 #
235 # Eg. XORG_DOC="manual" will pull all doc dependant deps for manual useflag
236 : ${XORG_DOC:="no"}
237
238 DOC_DEPEND="
239         doc? (
240                 app-text/asciidoc
241                 app-text/xmlto
242                 app-doc/doxygen
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
246         )
247 "
248 case ${XORG_DOC} in
249         no)
250                 ;;
251         always)
252                 DEPEND+=" ${DOC_DEPEND}"
253                 ;;
254         *)
255                 DEPEND+=" ${XORG_DOC}? ( ${DOC_DEPEND} )"
256                 IUSE+=" ${XORG_DOC}"
257                 ;;
258 esac
259 unset DOC_DEPEND
260
261 # @ECLASS-VARIABLE: XORG_MODULE_REBUILD
262 # @DESCRIPTION:
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"}
269 else
270         : ${XORG_MODULE_REBUILD:="no"}
271 fi
272
273 if [[ ${XORG_MODULE_REBUILD} == yes ]]; then
274         case ${EAPI} in
275                 3|4)
276                         ;;
277                 *)
278                         RDEPEND+=" x11-base/xorg-server:="
279                         ;;
280         esac
281 fi
282
283 DEPEND+=" ${COMMON_DEPEND}"
284 RDEPEND+=" ${COMMON_DEPEND}"
285 unset COMMON_DEPEND
286
287 debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: DEPEND=${DEPEND}"
288 debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: RDEPEND=${RDEPEND}"
289 debug-print "${LINENO} ${ECLASS} ${FUNCNAME}: PDEPEND=${PDEPEND}"
290
291 # @FUNCTION: xorg-2_pkg_setup
292 # @DESCRIPTION:
293 # Setup prefix compat
294 xorg-2_pkg_setup() {
295         debug-print-function ${FUNCNAME} "$@"
296
297         [[ ${FONT} == yes ]] && font_pkg_setup "$@"
298 }
299
300 # @FUNCTION: xorg-2_src_unpack
301 # @DESCRIPTION:
302 # Simply unpack source code.
303 xorg-2_src_unpack() {
304         debug-print-function ${FUNCNAME} "$@"
305
306         if [[ -n ${GIT_ECLASS} ]]; then
307                 git-r3_src_unpack
308         else
309                 unpack ${A}
310         fi
311
312         [[ -n ${FONT_OPTIONS} ]] && einfo "Detected font directory: ${FONT_DIR}"
313 }
314
315 # @FUNCTION: xorg-2_patch_source
316 # @DESCRIPTION:
317 # Apply all patches
318 xorg-2_patch_source() {
319         debug-print-function ${FUNCNAME} "$@"
320
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}
325
326         [[ -d "${EPATCH_SOURCE}" ]] && epatch
327 }
328
329 # @FUNCTION: xorg-2_reconf_source
330 # @DESCRIPTION:
331 # Run eautoreconf if necessary, and run elibtoolize.
332 xorg-2_reconf_source() {
333         debug-print-function ${FUNCNAME} "$@"
334
335         case ${CHOST} in
336                 *-aix* | *-winnt*)
337                         # some hosts need full eautoreconf
338                         [[ -e "./configure.ac" || -e "./configure.in" ]] \
339                                 && AUTOTOOLS_AUTORECONF=1
340                         ;;
341                 *)
342                         # elibtoolize required for BSD
343                         [[ ${XORG_EAUTORECONF} != no && ( -e "./configure.ac" || -e "./configure.in" ) ]] \
344                                 && AUTOTOOLS_AUTORECONF=1
345                         ;;
346         esac
347 }
348
349 # @FUNCTION: xorg-2_src_prepare
350 # @DESCRIPTION:
351 # Prepare a package after unpacking, performing all X-related tasks.
352 xorg-2_src_prepare() {
353         debug-print-function ${FUNCNAME} "$@"
354
355         xorg-2_patch_source
356         xorg-2_reconf_source
357         autotools-utils_src_prepare "$@"
358 }
359
360 # @FUNCTION: xorg-2_font_configure
361 # @DESCRIPTION:
362 # If a font package, perform any necessary configuration steps
363 xorg-2_font_configure() {
364         debug-print-function ${FUNCNAME} "$@"
365
366         if has nls ${IUSE//+} && ! use nls; then
367                 if grep -q -s "disable-all-encodings" ${ECONF_SOURCE:-.}/configure; then
368                         FONT_OPTIONS+="
369                                 --disable-all-encodings"
370                 else
371                         FONT_OPTIONS+="
372                                 --disable-iso8859-2
373                                 --disable-iso8859-3
374                                 --disable-iso8859-4
375                                 --disable-iso8859-5
376                                 --disable-iso8859-6
377                                 --disable-iso8859-7
378                                 --disable-iso8859-8
379                                 --disable-iso8859-9
380                                 --disable-iso8859-10
381                                 --disable-iso8859-11
382                                 --disable-iso8859-12
383                                 --disable-iso8859-13
384                                 --disable-iso8859-14
385                                 --disable-iso8859-15
386                                 --disable-iso8859-16
387                                 --disable-jisx0201
388                                 --disable-koi8-r"
389                 fi
390         fi
391 }
392
393 # @FUNCTION: xorg-2_flags_setup
394 # @DESCRIPTION:
395 # Set up CFLAGS for a debug build
396 xorg-2_flags_setup() {
397         debug-print-function ${FUNCNAME} "$@"
398
399         # Win32 require special define
400         [[ ${CHOST} == *-winnt* ]] && append-cppflags -DWIN32 -D__STDC__
401         # hardened ldflags
402         [[ ${PN} = xorg-server || -n ${DRIVER} ]] && append-ldflags -Wl,-z,lazy
403
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
409         fi
410 }
411
412 # @FUNCTION: xorg-2_src_configure
413 # @DESCRIPTION:
414 # Perform any necessary pre-configuration steps, then run configure
415 xorg-2_src_configure() {
416         debug-print-function ${FUNCNAME} "$@"
417
418         xorg-2_flags_setup
419
420         # @VARIABLE: XORG_CONFIGURE_OPTIONS
421         # @DESCRIPTION:
422         # Array of an additional options to pass to configure.
423         # @DEFAULT_UNSET
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."
429                 fi
430
431                 local xorgconfadd=(${CONFIGURE_OPTIONS} ${XORG_CONFIGURE_OPTIONS})
432         else
433                 local xorgconfadd=("${XORG_CONFIGURE_OPTIONS[@]}")
434         fi
435
436         [[ -n "${FONT}" ]] && xorg-2_font_configure
437
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"
443         fi
444
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"
448         fi
449
450         local myeconfargs=(
451                 ${dep_track}
452                 ${selective_werror}
453                 ${FONT_OPTIONS}
454                 "${xorgconfadd[@]}"
455         )
456
457         if [[ ${XORG_MULTILIB} == yes ]]; then
458                 autotools-multilib_src_configure "$@"
459         else
460                 autotools-utils_src_configure "$@"
461         fi
462 }
463
464 # @FUNCTION: xorg-2_src_compile
465 # @DESCRIPTION:
466 # Compile a package, performing all X-related tasks.
467 xorg-2_src_compile() {
468         debug-print-function ${FUNCNAME} "$@"
469
470         if [[ ${XORG_MULTILIB} == yes ]]; then
471                 autotools-multilib_src_compile "$@"
472         else
473                 autotools-utils_src_compile "$@"
474         fi
475 }
476
477 # @FUNCTION: xorg-2_src_install
478 # @DESCRIPTION:
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} "$@"
483
484         local install_args=( docdir="${EPREFIX}/usr/share/doc/${PF}" )
485
486         if [[ ${CATEGORY} == x11-proto ]]; then
487                 install_args+=(
488                         ${PN/proto/}docdir="${EPREFIX}/usr/share/doc/${PF}"
489                 )
490         fi
491
492         if [[ ${XORG_MULTILIB} == yes ]]; then
493                 autotools-multilib_src_install "${install_args[@]}"
494         else
495                 autotools-utils_src_install "${install_args[@]}"
496         fi
497
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
502         fi
503
504         if [[ -e "${S}"/ChangeLog ]]; then
505                 dodoc "${S}"/ChangeLog || die "dodoc failed"
506         fi
507
508         # Don't install libtool archives (even for modules)
509         prune_libtool_files --all
510
511         [[ -n ${FONT} ]] && remove_font_metadata
512 }
513
514 # @FUNCTION: xorg-2_pkg_postinst
515 # @DESCRIPTION:
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} "$@"
520
521         if [[ -n ${FONT} ]]; then
522                 create_fonts_scale
523                 create_fonts_dir
524                 font_pkg_postinst "$@"
525         fi
526 }
527
528 # @FUNCTION: xorg-2_pkg_postrm
529 # @DESCRIPTION:
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} "$@"
534
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
538                         create_fonts_scale
539                         create_fonts_dir
540                         font_pkg_postrm "$@"
541                 fi
542         fi
543 }
544
545 # @FUNCTION: remove_font_metadata
546 # @DESCRIPTION:
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} "$@"
551
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}
555         fi
556 }
557
558 # @FUNCTION: create_fonts_scale
559 # @DESCRIPTION:
560 # Create fonts.scale file, used by the old server-side fonts subsystem.
561 create_fonts_scale() {
562         debug-print-function ${FUNCNAME} "$@"
563
564         if [[ ${FONT_DIR} != Speedo && ${FONT_DIR} != CID ]]; then
565                 ebegin "Generating fonts.scale"
566                         mkfontscale \
567                                 -a "${EROOT}/usr/share/fonts/encodings/encodings.dir" \
568                                 -- "${EROOT}/usr/share/fonts/${FONT_DIR}"
569                 eend $?
570         fi
571 }
572
573 # @FUNCTION: create_fonts_dir
574 # @DESCRIPTION:
575 # Create fonts.dir file, used by the old server-side fonts subsystem.
576 create_fonts_dir() {
577         debug-print-function ${FUNCNAME} "$@"
578
579         ebegin "Generating fonts.dir"
580                         mkfontdir \
581                                 -e "${EROOT}"/usr/share/fonts/encodings \
582                                 -e "${EROOT}"/usr/share/fonts/encodings/large \
583                                 -- "${EROOT}/usr/share/fonts/${FONT_DIR}"
584         eend $?
585 }