/[gentoo-x86]/eclass/virtualx.eclass
Gentoo

Diff of /eclass/virtualx.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.32 Revision 1.42
1# Copyright 1999-2009 Gentoo Foundation 1# Copyright 1999-2012 Gentoo Foundation
2# Distributed under the terms of the GNU General Public License v2 2# Distributed under the terms of the GNU General Public License v2
3# $Header: /var/cvsroot/gentoo-x86/eclass/virtualx.eclass,v 1.32 2009/10/21 23:59:51 abcd Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/virtualx.eclass,v 1.42 2012/10/02 08:14:36 kensington Exp $
4#
5# Author: Martin Schlemmer <azarah@gentoo.org>
6#
7# This eclass can be used for packages that needs a working X environment to build
8 4
9# Is a dependency on xorg-server and xhost needed? 5# @ECLASS: virtualx.eclass
10# Valid values are "always", "optional", and "manual" 6# @MAINTAINER:
11# "tests" is treated as a synonym for "optional" 7# x11@gentoo.org
12: ${VIRTUALX_REQUIRED:=optional} 8# @AUTHOR:
9# Original author: Martin Schlemmer <azarah@gentoo.org>
10# @BLURB: This eclass can be used for packages that needs a working X environment to build.
13 11
14# If VIRTUALX_REQUIRED=optional, what use flag should control 12# @ECLASS-VARIABLE: VIRTUALX_REQUIRED
15# the dependency? Default is "test" 13# @DESCRIPTION:
14# Variable specifying the dependency on xorg-server and xhost.
15# Possible special values are "always" and "manual", which specify
16# the dependency to be set unconditionaly or not at all.
17# Any other value is taken as useflag desired to be in control of
18# the dependency (eg. VIRTUALX_REQUIRED="kde" will add the dependency
19# into "kde? ( )" and add kde into IUSE.
16: ${VIRTUALX_USE:=test} 20: ${VIRTUALX_REQUIRED:=test}
17 21
22# @ECLASS-VARIABLE: VIRTUALX_DEPEND
23# @DESCRIPTION:
18# Dep string available for use outside of eclass, in case a more 24# Dep string available for use outside of eclass, in case a more
19# complicated dep is needed 25# complicated dep is needed.
20VIRTUALX_DEPEND="x11-base/xorg-server 26# You can specify the variable BEFORE inherit to add more dependencies.
27VIRTUALX_DEPEND="${VIRTUALX_DEPEND}
28 !prefix? ( x11-base/xorg-server[xvfb] )
21 x11-apps/xhost" 29 x11-apps/xhost
30"
31
32# @ECLASS-VARIABLE: VIRTUALX_COMMAND
33# @DESCRIPTION:
34# Command (or eclass function call) to be run in the X11 environment
35# (within virtualmake function).
36: ${VIRTUALX_COMMAND:="emake"}
37
38has "${EAPI:-0}" 0 1 && die "virtualx eclass require EAPI=2 or newer."
22 39
23case ${VIRTUALX_REQUIRED} in 40case ${VIRTUALX_REQUIRED} in
41 manual)
42 ;;
24 always) 43 always)
25 DEPEND="${VIRTUALX_DEPEND}" 44 DEPEND="${VIRTUALX_DEPEND}"
26 RDEPEND="" 45 RDEPEND=""
27 ;; 46 ;;
28 optional|tests) 47 optional|tests)
48 # deprecated section YAY.
49 ewarn "QA: VIRTUALX_REQUIRED=optional and VIRTUALX_REQUIRED=tests are deprecated."
50 ewarn "QA: You can drop the variable definition completely from ebuild,"
51 ewarn "QA: because it is default behaviour."
52
53 if [[ -n ${VIRTUALX_USE} ]]; then
54 # so they like to specify the useflag
55 ewarn "QA: VIRTUALX_USE variable is deprecated."
56 ewarn "QA: Please read eclass manpage to find out how to use VIRTUALX_REQUIRED"
57 ewarn "QA: to achieve the same behaviour."
58 fi
59
60 [[ -z ${VIRTUALX_USE} ]] && VIRTUALX_USE="test"
29 DEPEND="${VIRTUALX_USE}? ( ${VIRTUALX_DEPEND} )" 61 DEPEND="${VIRTUALX_USE}? ( ${VIRTUALX_DEPEND} )"
30 RDEPEND="" 62 RDEPEND=""
31 IUSE="${VIRTUALX_USE}" 63 IUSE="${VIRTUALX_USE}"
32 ;; 64 ;;
33 manual)
34 ;;
35 *) 65 *)
36 eerror "Invalid value (${VIRTUALX_REQUIRED}) for VIRTUALX_REQUIRED" 66 DEPEND="${VIRTUALX_REQUIRED}? ( ${VIRTUALX_DEPEND} )"
37 eerror "Valid values are:" 67 RDEPEND=""
38 eerror " always" 68 IUSE="${VIRTUALX_REQUIRED}"
39 eerror " optional (default if unset)"
40 eerror " manual"
41 die "Invalid value (${VIRTUALX_REQUIRED}) for VIRTUALX_REQUIRED"
42 ;; 69 ;;
43esac 70esac
44 71
45DESCRIPTION="Based on the $ECLASS eclass" 72# @FUNCTION: virtualmake
73# @DESCRIPTION:
74# Function which attach to running X session or start new Xvfb session
75# where the VIRTUALX_COMMAND variable content gets executed.
76virtualmake() {
77 debug-print-function ${FUNCNAME} "$@"
46 78
47# 79 local i=0
48# Brian Harring <ferringb@gentoo.org> 11/04/2004
49# do not disable the sandbox during the depend phase.
50# ebuilds shouldn't touch the fs during depend phase, nor screw with the sandbox.
51#
52if [[ ${EBUILD_PHASE/depend} == "${EBUILD_PHASE}" ]] ; then
53 [[ -z ${SANDBOX_DISABLED} ]] && export SANDBOX_DISABLED="0" || :
54fi
55
56virtualmake() {
57 local retval=0 80 local retval=0
58 local OLD_SANDBOX_DISABLED="${SANDBOX_DISABLED}" 81 local OLD_SANDBOX_ON="${SANDBOX_ON}"
59 local XVFB=$(type -p Xvfb) 82 local XVFB=$(type -p Xvfb)
60 local XHOST=$(type -p xhost) 83 local XHOST=$(type -p xhost)
84 local xvfbargs="-screen 0 1280x1024x24"
85
86 # backcompat for maketype
87 if [[ -n ${maketype} ]]; then
88 ewarn "QA: ebuild is exporting \$maketype=${maketype}"
89 ewarn "QA: Ebuild should be migrated to use VIRTUALX_COMMAND=${maketype} instead."
90 ewarn "QA: Setting VIRTUALX_COMMAND to \$maketype conveniently for now."
91 VIRTUALX_COMMAND=${maketype}
92 fi
61 93
62 # If $DISPLAY is not set, or xhost cannot connect to an X 94 # If $DISPLAY is not set, or xhost cannot connect to an X
63 # display, then do the Xvfb hack. 95 # display, then do the Xvfb hack.
64 if [[ -n ${XVFB} && -n ${XHOST} ]] && \ 96 if [[ -n ${XVFB} && -n ${XHOST} ]] && \
65 ( [[ -z ${DISPLAY} ]] || ! (${XHOST} &>/dev/null) ) ; then 97 ( [[ -z ${DISPLAY} ]] || ! (${XHOST} &>/dev/null) ) ; then
98 debug-print "${FUNCNAME}: running Xvfb hack"
66 export XAUTHORITY= 99 export XAUTHORITY=
67 # The following is derived from Mandrake's hack to allow 100 # The following is derived from Mandrake's hack to allow
68 # compiling without the X display 101 # compiling without the X display
69 102
70 einfo "Scanning for an open DISPLAY to start Xvfb ..." 103 einfo "Scanning for an open DISPLAY to start Xvfb ..."
71
72 # We really do not want SANDBOX enabled here
73 export SANDBOX_DISABLED="1"
74
75 local i=0
76 XDISPLAY=$(i=0; while [[ -f /tmp/.X${i}-lock ]] ; do ((i++));done; echo ${i})
77
78 # If we are in a chrooted environment, and there is already a 104 # If we are in a chrooted environment, and there is already a
79 # X server started outside of the chroot, Xvfb will fail to start 105 # X server started outside of the chroot, Xvfb will fail to start
80 # on the same display (most cases this is :0 ), so make sure 106 # on the same display (most cases this is :0 ), so make sure
81 # Xvfb is started, else bump the display number 107 # Xvfb is started, else bump the display number
82 # 108 #
83 # Azarah - 5 May 2002 109 # Azarah - 5 May 2002
84 # 110 XDISPLAY=$(i=0; while [[ -f /tmp/.X${i}-lock ]] ; do ((i++));done; echo ${i})
85 # Changed the mode from 800x600x32 to 800x600x24 because the mfb 111 debug-print "${FUNCNAME}: XDISPLAY=${XDISPLAY}"
86 # support has been dropped in Xvfb in the xorg-x11 pre-releases. 112
87 # For now only depths up to 24-bit are supported. 113 # We really do not want SANDBOX enabled here
88 # 114 export SANDBOX_ON="0"
89 # Sven Wegener <swegener@gentoo.org> - 22 Aug 2004 115
90 # 116 debug-print "${FUNCNAME}: ${XVFB} :${XDISPLAY} ${xvfbargs}"
91 # Use "-fp built-ins" because it's only part of the default font path 117 ${XVFB} :${XDISPLAY} ${xvfbargs} &>/dev/null &
92 # for Xorg but not the other DDXs (Xvfb, Kdrive, etc). Temporarily fixes
93 # bug 278487 until xorg-server is properly patched
94 #
95 # RĂ©mi Cardona <remi@gentoo.org> (10 Aug 2009)
96 ${XVFB} :${XDISPLAY} -fp built-ins -screen 0 800x600x24 &>/dev/null &
97 sleep 2 118 sleep 2
98 119
99 local start=${XDISPLAY} 120 local start=${XDISPLAY}
100 while [[ ! -f /tmp/.X${XDISPLAY}-lock ]] ; do 121 while [[ ! -f /tmp/.X${XDISPLAY}-lock ]]; do
101 # Stop trying after 15 tries 122 # Stop trying after 15 tries
102 if ((XDISPLAY - start > 15)) ; then 123 if ((XDISPLAY - start > 15)) ; then
103 124 eerror "'${XVFB} :${XDISPLAY} ${xvfbargs}' returns:"
104 eerror "" 125 echo
105 eerror "Unable to start Xvfb." 126 ${XVFB} :${XDISPLAY} ${xvfbargs}
106 eerror "" 127 echo
107 eerror "'${XVFB} :${XDISPLAY} -fp built-ins -screen 0 800x600x24' returns:"
108 eerror ""
109 ${XVFB} :${XDISPLAY} -fp built-ins -screen 0 800x600x24
110 eerror ""
111 eerror "If possible, correct the above error and try your emerge again." 128 eerror "If possible, correct the above error and try your emerge again."
112 eerror "" 129 die "Unable to start Xvfb"
113 die
114 fi 130 fi
115 131
116 ((XDISPLAY++)) 132 ((XDISPLAY++))
117 ${XVFB} :${XDISPLAY} -fp built-ins -screen 0 800x600x24 &>/dev/null & 133 debug-print "${FUNCNAME}: ${XVFB} :${XDISPLAY} ${xvfbargs}"
134 ${XVFB} :${XDISPLAY} ${xvfbargs} &>/dev/null &
118 sleep 2 135 sleep 2
119 done 136 done
120 137
121 # Now enable SANDBOX again if needed. 138 # Now enable SANDBOX again if needed.
122 export SANDBOX_DISABLED="${OLD_SANDBOX_DISABLED}" 139 export SANDBOX_ON="${OLD_SANDBOX_ON}"
123 140
124 einfo "Starting Xvfb on \$DISPLAY=${XDISPLAY} ..." 141 einfo "Starting Xvfb on \$DISPLAY=${XDISPLAY} ..."
125 142
126 export DISPLAY=:${XDISPLAY} 143 export DISPLAY=:${XDISPLAY}
127 #Do not break on error, but setup $retval, as we need 144 # Do not break on error, but setup $retval, as we need
128 #to kill Xvfb 145 # to kill Xvfb
129 ${maketype} "$@" 146 debug-print "${FUNCNAME}: ${VIRTUALX_COMMAND} \"$@\""
147 nonfatal ${VIRTUALX_COMMAND} "$@"
130 retval=$? 148 retval=$?
131 149
132 #Now kill Xvfb 150 # Now kill Xvfb
133 kill $(cat /tmp/.X${XDISPLAY}-lock) 151 kill $(cat /tmp/.X${XDISPLAY}-lock)
134 else 152 else
153 debug-print "${FUNCNAME}: attaching to running X display"
135 #Normal make if we can connect to an X display 154 # Normal make if we can connect to an X display
136 ${maketype} "$@" 155 debug-print "${FUNCNAME}: ${VIRTUALX_COMMAND} \"$@\""
156 ${VIRTUALX_COMMAND} "$@"
137 retval=$? 157 retval=$?
138 fi 158 fi
139 159
140 return ${retval} 160 # die if our command failed
161 [[ ${retval} -ne 0 ]] && die "${FUNCNAME}: the ${VIRTUALX_COMMAND} failed."
162
163 return 0 # always return 0, it can be altered by failed kill for Xvfb
141} 164}
142 165
166# @FUNCTION: Xmake
167# @DESCRIPTION:
143#Same as "make", but setup the Xvfb hack if needed 168# Same as "make", but set up the Xvfb hack if needed.
169# Deprecated call.
144Xmake() { 170Xmake() {
145 export maketype="make" 171 debug-print-function ${FUNCNAME} "$@"
146 virtualmake "$@" 172
173 ewarn "QA: you should not execute make directly"
174 ewarn "QA: rather execute Xemake -j1 if you have issues with parallel make"
175 VIRTUALX_COMMAND="emake -j1" virtualmake "$@"
147} 176}
148 177
178# @FUNCTION: Xemake
179# @DESCRIPTION:
149#Same as "emake", but setup the Xvfb hack if needed 180# Same as "emake", but set up the Xvfb hack if needed.
150Xemake() { 181Xemake() {
151 export maketype="emake" 182 debug-print-function ${FUNCNAME} "$@"
152 virtualmake "$@" 183
184 VIRTUALX_COMMAND="emake" virtualmake "$@"
153} 185}
154 186
187# @FUNCTION: Xeconf
188# @DESCRIPTION:
155#Same as "econf", but setup the Xvfb hack if needed 189# Same as "econf", but set up the Xvfb hack if needed.
156Xeconf() { 190Xeconf() {
157 export maketype="econf" 191 debug-print-function ${FUNCNAME} "$@"
158 virtualmake "$@" 192
193 VIRTUALX_COMMAND="econf" virtualmake "$@"
159} 194}

Legend:
Removed from v.1.32  
changed lines
  Added in v.1.42

  ViewVC Help
Powered by ViewVC 1.1.20