/[gentoo-x86]/eclass/x-modular.eclass
Gentoo

Contents of /eclass/x-modular.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.119 - (show annotations) (download)
Sun Jul 4 20:42:22 2010 UTC (4 years, 1 month ago) by dirtyepic
Branch: MAIN
Changes since 1.118: +1 -41 lines
Drop cleanup_fonts from xorg eclasses as it's now handled by font.eclass. (bug #315369)

1 # Copyright 1999-2005 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
3 # $Header: /var/cvsroot/gentoo-x86/eclass/x-modular.eclass,v 1.118 2009/12/09 10:21:49 vapier Exp $
4 #
5 # @ECLASS: x-modular.eclass
6 # @MAINTAINER:
7 # Donnie Berkholz <dberkholz@gentoo.org>, x11@gentoo.org
8 # @BLURB: Reduces code duplication in the modularized X11 ebuilds.
9 # @DESCRIPTION:
10 # This eclass makes trivial X ebuilds possible for apps, fonts, drivers,
11 # and more. Many things that would normally be done in various functions
12 # can be accessed by setting variables instead, such as patching,
13 # running eautoreconf, passing options to configure and installing docs.
14 #
15 # All you need to do in a basic ebuild is inherit this eclass and set
16 # DESCRIPTION, KEYWORDS and RDEPEND/DEPEND. If your package is hosted
17 # with the other X packages, you don't need to set SRC_URI. Pretty much
18 # everything else should be automatic.
19
20 if [[ ${PV} = 9999* ]]; then
21 GIT_ECLASS="git"
22 SNAPSHOT="yes"
23 SRC_URI=""
24 fi
25
26 # If we're a font package, but not the font.alias one
27 FONT_ECLASS=""
28 if [[ "${PN/#font-}" != "${PN}" ]] \
29 && [[ "${CATEGORY}" = "media-fonts" ]] \
30 && [[ "${PN}" != "font-alias" ]] \
31 && [[ "${PN}" != "font-util" ]]; then
32 # Activate font code in the rest of the eclass
33 FONT="yes"
34
35 # Whether to inherit the font eclass
36 FONT_ECLASS="font"
37 fi
38
39 inherit eutils libtool multilib toolchain-funcs flag-o-matic autotools \
40 ${FONT_ECLASS} ${GIT_ECLASS}
41
42 EXPORTED_FUNCTIONS="src_unpack src_compile src_install pkg_preinst pkg_postinst pkg_postrm"
43
44 case "${EAPI:-0}" in
45 0|1)
46 ;;
47 2)
48 EXPORTED_FUNCTIONS="${EXPORTED_FUNCTIONS} src_prepare src_configure"
49 ;;
50 *)
51 die "Unknown EAPI ${EAPI}"
52 ;;
53 esac
54
55 # exports must be ALWAYS after inherit
56 EXPORT_FUNCTIONS ${EXPORTED_FUNCTIONS}
57
58 # @ECLASS-VARIABLE: XDIR
59 # @DESCRIPTION:
60 # Directory prefix to use for everything. If you want to install to a
61 # non-default prefix (e.g., /opt/xorg), change XDIR. This has not been
62 # recently tested. You may need to uncomment the setting of datadir and
63 # mandir in x-modular_src_install() or add it back in if it's no longer
64 # there. You may also want to change the SLOT.
65 XDIR="/usr"
66
67 IUSE=""
68 HOMEPAGE="http://xorg.freedesktop.org/"
69
70 # @ECLASS-VARIABLE: SNAPSHOT
71 # @DESCRIPTION:
72 # If set to 'yes' and configure.ac exists, eautoreconf will run. Set
73 # before inheriting this eclass.
74 : ${SNAPSHOT:=no}
75
76 # Set up SRC_URI for individual modular releases
77 BASE_INDIVIDUAL_URI="http://xorg.freedesktop.org/releases/individual"
78 # @ECLASS-VARIABLE: MODULE
79 # @DESCRIPTION:
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 ${MODULE} ]]; then
84 case ${CATEGORY} in
85 app-doc) MODULE="doc" ;;
86 media-fonts) MODULE="font" ;;
87 x11-apps|x11-wm) MODULE="app" ;;
88 x11-misc|x11-themes) MODULE="util" ;;
89 x11-drivers) MODULE="driver" ;;
90 x11-base) MODULE="xserver" ;;
91 x11-proto) MODULE="proto" ;;
92 x11-libs) MODULE="lib" ;;
93 esac
94 fi
95
96 if [[ -n ${GIT_ECLASS} ]]; then
97 EGIT_REPO_URI="git://anongit.freedesktop.org/git/xorg/${MODULE}/${PN}"
98 else
99 SRC_URI="${SRC_URI} ${BASE_INDIVIDUAL_URI}/${MODULE}/${P}.tar.bz2"
100 fi
101
102 SLOT="0"
103
104 # Set the license for the package. This can be overridden by setting
105 # LICENSE after the inherit. Nearly all FreeDesktop-hosted X packages
106 # are under the MIT license. (This is what Red Hat does in their rpms)
107 LICENSE="MIT"
108
109 # Set up shared dependencies
110 if [[ -n "${SNAPSHOT}" ]]; then
111 # FIXME: What's the minimal libtool version supporting arbitrary versioning?
112 DEPEND="${DEPEND}
113 >=sys-devel/libtool-1.5
114 >=sys-devel/m4-1.4"
115 WANT_AUTOCONF="latest"
116 WANT_AUTOMAKE="latest"
117 fi
118
119 if [[ -n "${FONT}" ]]; then
120 RDEPEND="${RDEPEND}
121 media-fonts/encodings
122 x11-apps/mkfontscale
123 x11-apps/mkfontdir"
124 PDEPEND="${PDEPEND}
125 media-fonts/font-alias"
126
127 # Starting with 7.0RC3, we can specify the font directory
128 # But oddly, we can't do the same for encodings or font-alias
129
130 # @ECLASS-VARIABLE: FONT_DIR
131 # @DESCRIPTION:
132 # If you're creating a font package and the suffix of PN is not equal to
133 # the subdirectory of /usr/share/fonts/ it should install into, set
134 # FONT_DIR to that directory or directories. Set before inheriting this
135 # eclass.
136 : ${FONT_DIR:=${PN##*-}}
137
138 # Fix case of font directories
139 FONT_DIR=${FONT_DIR/ttf/TTF}
140 FONT_DIR=${FONT_DIR/otf/OTF}
141 FONT_DIR=${FONT_DIR/type1/Type1}
142 FONT_DIR=${FONT_DIR/speedo/Speedo}
143
144 # Set up configure options, wrapped so ebuilds can override if need be
145 if [[ -z ${FONT_OPTIONS} ]]; then
146 FONT_OPTIONS="--with-fontdir=\"/usr/share/fonts/${FONT_DIR}\""
147 fi
148
149 if [[ -n "${FONT}" ]]; then
150 if [[ ${PN##*-} = misc ]] || [[ ${PN##*-} = 75dpi ]] || [[ ${PN##*-} = 100dpi ]] || [[ ${PN##*-} = cyrillic ]]; then
151 IUSE="${IUSE} nls"
152 fi
153 fi
154 fi
155
156 # If we're a driver package
157 if [[ "${PN/#xf86-video}" != "${PN}" ]] || [[ "${PN/#xf86-input}" != "${PN}" ]]; then
158 # Enable driver code in the rest of the eclass
159 DRIVER="yes"
160 fi
161
162 # Debugging -- ignore packages that can't be built with debugging
163 if [[ -z "${FONT}" ]] \
164 && [[ "${CATEGORY/app-doc}" = "${CATEGORY}" ]] \
165 && [[ "${CATEGORY/x11-proto}" = "${CATEGORY}" ]] \
166 && [[ "${PN/util-macros}" = "${PN}" ]] \
167 && [[ "${PN/xbitmaps}" = "${PN}" ]] \
168 && [[ "${PN/xkbdata}" = "${PN}" ]] \
169 && [[ "${PN/xorg-cf-files}" = "${PN}" ]] \
170 && [[ "${PN/xcursor}" = "${PN}" ]] \
171 ; then
172 DEBUGGABLE="yes"
173 IUSE="${IUSE} debug"
174 fi
175
176 DEPEND="${DEPEND}
177 >=dev-util/pkgconfig-0.18"
178
179 if [[ "${PN/util-macros}" = "${PN}" ]]; then
180 DEPEND="${DEPEND}
181 >=x11-misc/util-macros-1.3.0
182 sys-devel/binutils"
183 fi
184
185 RDEPEND="${RDEPEND}
186 !<=x11-base/xorg-x11-6.9"
187 # Provides virtual/x11 for temporary use until packages are ported
188 # x11-base/x11-env"
189
190 # @FUNCTION: x-modular_specs_check
191 # @USAGE:
192 # @DESCRIPTION:
193 # Make any necessary changes related to gcc specs (generally hardened)
194 x-modular_specs_check() {
195 if [[ ${PN:0:11} = "xorg-server" ]] || [[ -n "${DRIVER}" ]]; then
196 append-ldflags -Wl,-z,lazy
197 # (#116698) breaks loading
198 filter-ldflags -Wl,-z,now
199 fi
200 }
201
202 # @FUNCTION: x-modular_dri_check
203 # @USAGE:
204 # @DESCRIPTION:
205 # Ensures the server supports DRI if building a driver with DRI support
206 x-modular_dri_check() {
207 # (#120057) Enabling DRI in drivers requires that the server was built with
208 # support for it
209 # Starting with xorg-server 1.5.3, DRI support is always enabled unless
210 # USE=minimal is set (see bug #252084)
211 if [[ -n "${DRIVER}" ]]; then
212 if has dri ${IUSE} && use dri; then
213 einfo "Checking for direct rendering capabilities ..."
214 if has_version '>=x11-base/xorg-server-1.5.3'; then
215 if built_with_use x11-base/xorg-server minimal; then
216 die "You must build x11-base/xorg-server with USE=-minimal."
217 fi
218 else
219 if ! built_with_use x11-base/xorg-server dri; then
220 die "You must build x11-base/xorg-server with USE=dri."
221 fi
222 fi
223 fi
224 fi
225 }
226
227 # @FUNCTION: x-modular_server_supports_drivers_check
228 # @USAGE:
229 # @DESCRIPTION:
230 # Ensures the server SDK is installed if a driver is being built
231 x-modular_server_supports_drivers_check() {
232 # (#135873) Only certain servers will actually use or be capable of
233 # building external drivers, including binary drivers.
234 if [[ -n "${DRIVER}" ]]; then
235 if has_version '>=x11-base/xorg-server-1.1'; then
236 if ! built_with_use x11-base/xorg-server xorg; then
237 eerror "x11-base/xorg-server is not built with support for external drivers."
238 die "You must build x11-base/xorg-server with USE=xorg."
239 fi
240 fi
241 fi
242 }
243
244 # @FUNCTION: x-modular_unpack_source
245 # @USAGE:
246 # @DESCRIPTION:
247 # Simply unpack source code. Nothing else.
248 x-modular_unpack_source() {
249 if [[ -n ${GIT_ECLASS} ]]; then
250 git_src_unpack
251 else
252 unpack ${A}
253 fi
254 cd "${S}"
255
256 if [[ -n ${FONT_OPTIONS} ]]; then
257 einfo "Detected font directory: ${FONT_DIR}"
258 fi
259 }
260
261 # @FUNCTION: x-modular_patch_source
262 # @USAGE:
263 # @DESCRIPTION:
264 # Apply all patches
265 x-modular_patch_source() {
266 # Use standardized names and locations with bulk patching
267 # Patch directory is ${WORKDIR}/patch
268 # See epatch() in eutils.eclass for more documentation
269 if [[ -z "${EPATCH_SUFFIX}" ]] ; then
270 EPATCH_SUFFIX="patch"
271 fi
272
273 # @VARIABLE: PATCHES
274 # @DESCRIPTION:
275 # If you have any patches to apply, set PATCHES to their locations and epatch
276 # will apply them. It also handles epatch-style bulk patches, if you know how to
277 # use them and set the correct variables. If you don't, read eutils.eclass.
278 if [[ ${#PATCHES[@]} -gt 1 ]]; then
279 for x in "${PATCHES[@]}"; do
280 epatch "${x}"
281 done
282 elif [[ -n "${PATCHES}" ]]; then
283 for x in ${PATCHES}; do
284 epatch "${x}"
285 done
286 # For non-default directory bulk patching
287 elif [[ -n "${PATCH_LOC}" ]] ; then
288 epatch ${PATCH_LOC}
289 # For standard bulk patching
290 elif [[ -d "${EPATCH_SOURCE}" ]] ; then
291 epatch
292 fi
293 }
294
295 # @FUNCTION: x-modular_reconf_source
296 # @USAGE:
297 # @DESCRIPTION:
298 # Run eautoreconf if necessary, and run elibtoolize.
299 x-modular_reconf_source() {
300 if [[ "${SNAPSHOT}" = "yes" ]]
301 then
302 # If possible, generate configure if it doesn't exist
303 if [ -f "./configure.ac" ]
304 then
305 eautoreconf
306 fi
307 fi
308
309 # Joshua Baergen - October 23, 2005
310 # Fix shared lib issues on MIPS, FBSD, etc etc
311 elibtoolize
312 }
313
314 # @FUNCTION: x-modular_src_prepare
315 # @USAGE:
316 # @DESCRIPTION:
317 # Prepare a package after unpacking, performing all X-related tasks.
318 x-modular_src_prepare() {
319 [[ -n ${GIT_ECLASS} ]] && has src_prepare ${EXPORTED_FUNCTIONS} \
320 && git_src_prepare
321 x-modular_patch_source
322 x-modular_reconf_source
323 }
324
325 # @FUNCTION: x-modular_src_unpack
326 # @USAGE:
327 # @DESCRIPTION:
328 # Unpack a package, performing all X-related tasks.
329 x-modular_src_unpack() {
330 x-modular_specs_check
331 x-modular_server_supports_drivers_check
332 x-modular_dri_check
333 x-modular_unpack_source
334 has src_prepare ${EXPORTED_FUNCTIONS} || x-modular_src_prepare
335 }
336
337 # @FUNCTION: x-modular_font_configure
338 # @USAGE:
339 # @DESCRIPTION:
340 # If a font package, perform any necessary configuration steps
341 x-modular_font_configure() {
342 if [[ -n "${FONT}" ]]; then
343 # Might be worth adding an option to configure your desired font
344 # and exclude all others. Also, should this USE be nls or minimal?
345 if has nls ${IUSE//+} && ! use nls; then
346 FONT_OPTIONS="${FONT_OPTIONS}
347 --disable-iso8859-2
348 --disable-iso8859-3
349 --disable-iso8859-4
350 --disable-iso8859-5
351 --disable-iso8859-6
352 --disable-iso8859-7
353 --disable-iso8859-8
354 --disable-iso8859-9
355 --disable-iso8859-10
356 --disable-iso8859-11
357 --disable-iso8859-12
358 --disable-iso8859-13
359 --disable-iso8859-14
360 --disable-iso8859-15
361 --disable-iso8859-16
362 --disable-jisx0201
363 --disable-koi8-r"
364 fi
365 fi
366 }
367
368 # @FUNCTION: x-modular_debug_setup
369 # @USAGE:
370 # @DESCRIPTION:
371 # Set up CFLAGS for a debug build
372 x-modular_debug_setup() {
373 if [[ -n "${DEBUGGABLE}" ]]; then
374 if use debug; then
375 strip-flags
376 append-flags -g
377 fi
378 fi
379 }
380
381 # @FUNCTION: x-modular_src_configure
382 # @USAGE:
383 # @DESCRIPTION:
384 # Perform any necessary pre-configuration steps, then run configure
385 x-modular_src_configure() {
386 x-modular_font_configure
387 x-modular_debug_setup
388
389 # @VARIABLE: CONFIGURE_OPTIONS
390 # @DESCRIPTION:
391 # Any extra options to pass to configure
392
393 # If prefix isn't set here, .pc files cause problems
394 if [[ -x ${ECONF_SOURCE:-.}/configure ]]; then
395 econf --prefix=${XDIR} \
396 --datadir=${XDIR}/share \
397 ${FONT_OPTIONS} \
398 ${DRIVER_OPTIONS} \
399 ${CONFIGURE_OPTIONS}
400 fi
401 }
402
403 # @FUNCTION: x-modular_src_make
404 # @USAGE:
405 # @DESCRIPTION:
406 # Run make.
407 x-modular_src_make() {
408 emake || die "emake failed"
409 }
410
411 # @FUNCTION: x-modular_src_compile
412 # @USAGE:
413 # @DESCRIPTION:
414 # Compile a package, performing all X-related tasks.
415 x-modular_src_compile() {
416 has src_configure ${EXPORTED_FUNCTIONS} || x-modular_src_configure
417 x-modular_src_make
418 }
419
420 # @FUNCTION: x-modular_src_install
421 # @USAGE:
422 # @DESCRIPTION:
423 # Install a built package to ${D}, performing any necessary steps.
424 # Creates a ChangeLog from git if using live ebuilds.
425 x-modular_src_install() {
426 # Install everything to ${XDIR}
427 if [[ ${CATEGORY} = x11-proto ]]; then
428 make \
429 ${PN/proto/}docdir=/usr/share/doc/${PF} \
430 DESTDIR="${D}" \
431 install \
432 || die
433 else
434 make \
435 docdir=/usr/share/doc/${PF} \
436 DESTDIR="${D}" \
437 install \
438 || die
439 fi
440 # Shouldn't be necessary in XDIR=/usr
441 # einstall forces datadir, so we need to re-force it
442 # datadir=${XDIR}/share \
443 # mandir=${XDIR}/share/man \
444
445 if [[ -n ${GIT_ECLASS} ]]; then
446 pushd "${EGIT_STORE_DIR}/${EGIT_CLONE_DIR}"
447 git log ${GIT_TREE} > "${S}"/ChangeLog
448 popd
449 fi
450
451 if [[ -e ${S}/ChangeLog ]]; then
452 dodoc "${S}"/ChangeLog
453 fi
454 # @VARIABLE: DOCS
455 # @DESCRIPTION:
456 # Any documentation to install via dodoc
457 [[ -n ${DOCS} ]] && dodoc ${DOCS}
458
459 # Don't install libtool archives for server modules
460 if [[ -e ${D}/usr/$(get_libdir)/xorg/modules ]]; then
461 find "${D}"/usr/$(get_libdir)/xorg/modules -name '*.la' \
462 | xargs rm -f
463 fi
464
465 if [[ -n "${FONT}" ]]; then
466 remove_font_metadata
467 fi
468
469 if [[ -n "${DRIVER}" ]]; then
470 install_driver_hwdata
471 fi
472 }
473
474 # @FUNCTION: x-modular_pkg_preinst
475 # @USAGE:
476 # @DESCRIPTION:
477 # This function doesn't do anything right now, but it may in the future.
478 x-modular_pkg_preinst() {
479 # We no longer do anything here, but we can't remove it from the API
480 :
481 }
482
483 # @FUNCTION: x-modular_pkg_postinst
484 # @USAGE:
485 # @DESCRIPTION:
486 # Run X-specific post-installation tasks on the live filesystem. The
487 # only task right now is some setup for font packages.
488 x-modular_pkg_postinst() {
489 if [[ -n "${FONT}" ]]; then
490 setup_fonts
491 fi
492 }
493
494 # @FUNCTION: x-modular_pkg_postrm
495 # @USAGE:
496 # @DESCRIPTION:
497 # Run X-specific post-removal tasks on the live filesystem. The only
498 # task right now is some cleanup for font packages.
499 x-modular_pkg_postrm() {
500 if [[ -n "${FONT}" ]]; then
501 font_pkg_postrm
502 fi
503 }
504
505 # @FUNCTION: setup_fonts
506 # @USAGE:
507 # @DESCRIPTION:
508 # Generates needed files for fonts and fixes font permissions
509 setup_fonts() {
510 if [[ ! -n "${FONT_DIR}" ]]; then
511 msg="FONT_DIR is empty. The ebuild should set it to at least one subdir of /usr/share/fonts."
512 eerror "${msg}"
513 die "${msg}"
514 fi
515
516 create_fonts_scale
517 create_fonts_dir
518 create_font_cache
519 }
520
521 # @FUNCTION: remove_font_metadata
522 # @USAGE:
523 # @DESCRIPTION:
524 # Don't let the package install generated font files that may overlap
525 # with other packages. Instead, they're generated in pkg_postinst().
526 remove_font_metadata() {
527 local DIR
528 for DIR in ${FONT_DIR}; do
529 if [[ "${DIR}" != "Speedo" ]] && \
530 [[ "${DIR}" != "CID" ]] ; then
531 # Delete font metadata files
532 # fonts.scale, fonts.dir, fonts.cache-1
533 rm -f "${D}"/usr/share/fonts/${DIR}/fonts.{scale,dir,cache-1}
534 fi
535 done
536 }
537
538 # @FUNCTION: install_driver_hwdata
539 # @USAGE:
540 # @DESCRIPTION:
541 # Installs device-to-driver mappings for system-config-display and
542 # anything else that uses hwdata.
543 install_driver_hwdata() {
544 insinto /usr/share/hwdata/videoaliases
545 for i in "${FILESDIR}"/*.xinf; do
546 # We need this for the case when none exist,
547 # so *.xinf doesn't expand
548 if [[ -e $i ]]; then
549 doins $i
550 fi
551 done
552 }
553
554 # @FUNCTION: discover_font_dirs
555 # @USAGE:
556 # @DESCRIPTION:
557 # Deprecated. Sets up the now-unused FONT_DIRS variable.
558 discover_font_dirs() {
559 FONT_DIRS="${FONT_DIR}"
560 }
561
562 # @FUNCTION: create_fonts_scale
563 # @USAGE:
564 # @DESCRIPTION:
565 # Create fonts.scale file, used by the old server-side fonts subsystem.
566 create_fonts_scale() {
567 ebegin "Creating fonts.scale files"
568 local x
569 for DIR in ${FONT_DIR}; do
570 x=${ROOT}/usr/share/fonts/${DIR}
571 [[ -z "$(ls ${x}/)" ]] && continue
572 [[ "$(ls ${x}/)" = "fonts.cache-1" ]] && continue
573
574 # Only generate .scale files if truetype, opentype or type1
575 # fonts are present ...
576
577 # NOTE: There is no way to regenerate Speedo/CID fonts.scale
578 # <dberkholz@gentoo.org> 2 August 2004
579 if [[ "${x/encodings}" = "${x}" ]] \
580 && [[ -n "$(find ${x} -iname '*.[pot][ft][abcf]' -print)" ]]; then
581 mkfontscale \
582 -a "${ROOT}"/usr/share/fonts/encodings/encodings.dir \
583 -- ${x}
584 fi
585 done
586 eend 0
587 }
588
589 # @FUNCTION: create_fonts_dir
590 # @USAGE:
591 # @DESCRIPTION:
592 # Create fonts.dir file, used by the old server-side fonts subsystem.
593 create_fonts_dir() {
594 ebegin "Generating fonts.dir files"
595 for DIR in ${FONT_DIR}; do
596 x=${ROOT}/usr/share/fonts/${DIR}
597 [[ -z "$(ls ${x}/)" ]] && continue
598 [[ "$(ls ${x}/)" = "fonts.cache-1" ]] && continue
599
600 if [[ "${x/encodings}" = "${x}" ]]; then
601 mkfontdir \
602 -e "${ROOT}"/usr/share/fonts/encodings \
603 -e "${ROOT}"/usr/share/fonts/encodings/large \
604 -- ${x}
605 fi
606 done
607 eend 0
608 }
609
610 # @FUNCTION: create_font_cache
611 # @USAGE:
612 # @DESCRIPTION:
613 # Create fonts.cache-1 files, used by the new client-side fonts
614 # subsystem.
615 create_font_cache() {
616 font_pkg_postinst
617 }

  ViewVC Help
Powered by ViewVC 1.1.20