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

Contents of /eclass/x-modular.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.105 - (show annotations) (download)
Wed Feb 18 18:40:52 2009 UTC (5 years, 5 months ago) by dberkholz
Branch: MAIN
Changes since 1.104: +1 -4 lines
(#259491) Stop using prepalldocs, stuff is breaking because of the eutils.eclass change.

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

  ViewVC Help
Powered by ViewVC 1.1.20