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

Contents of /eclass/virtualx.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.40 - (show annotations) (download)
Mon Aug 22 04:46:32 2011 UTC (2 years, 8 months ago) by vapier
Branch: MAIN
Changes since 1.39: +9 -9 lines
fix random bugs in eclass documentation, and convert to new @AUTHOR tag

1 # Copyright 1999-2011 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
3 # $Header: /var/cvsroot/gentoo-x86/eclass/virtualx.eclass,v 1.39 2011/06/09 21:42:58 mattst88 Exp $
4
5 # @ECLASS: virtualx.eclass
6 # @MAINTAINER:
7 # x11@gentoo.org
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.
11
12 # @ECLASS-VARIABLE: VIRTUALX_REQUIRED
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.
20 : ${VIRTUALX_REQUIRED:=test}
21
22 # @ECLASS-VARIABLE: VIRTUALX_DEPEND
23 # @DESCRIPTION:
24 # Dep string available for use outside of eclass, in case a more
25 # complicated dep is needed.
26 # You can specify the variable BEFORE inherit to add more dependencies.
27 VIRTUALX_DEPEND="${VIRTUALX_DEPEND}
28 !prefix? ( x11-base/xorg-server[xvfb] )
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
38 has "${EAPI:-0}" 0 1 && die "virtualx eclass require EAPI=2 or newer."
39
40 case ${VIRTUALX_REQUIRED} in
41 manual)
42 ;;
43 always)
44 DEPEND="${VIRTUALX_DEPEND}"
45 RDEPEND=""
46 ;;
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"
61 DEPEND="${VIRTUALX_USE}? ( ${VIRTUALX_DEPEND} )"
62 RDEPEND=""
63 IUSE="${VIRTUALX_USE}"
64 ;;
65 *)
66 DEPEND="${VIRTUALX_REQUIRED}? ( ${VIRTUALX_DEPEND} )"
67 RDEPEND=""
68 IUSE="${VIRTUALX_REQUIRED}"
69 ;;
70 esac
71
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.
76 virtualmake() {
77 debug-print-function ${FUNCNAME} "$@"
78
79 local i=0
80 local retval=0
81 local OLD_SANDBOX_ON="${SANDBOX_ON}"
82 local XVFB=$(type -p Xvfb)
83 local XHOST=$(type -p xhost)
84 local xvfbargs="-screen 0 800x600x24"
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
93
94 # If $DISPLAY is not set, or xhost cannot connect to an X
95 # display, then do the Xvfb hack.
96 if [[ -n ${XVFB} && -n ${XHOST} ]] && \
97 ( [[ -z ${DISPLAY} ]] || ! (${XHOST} &>/dev/null) ) ; then
98 debug-print "${FUNCNAME}: running Xvfb hack"
99 export XAUTHORITY=
100 # The following is derived from Mandrake's hack to allow
101 # compiling without the X display
102
103 einfo "Scanning for an open DISPLAY to start Xvfb ..."
104 # If we are in a chrooted environment, and there is already a
105 # X server started outside of the chroot, Xvfb will fail to start
106 # on the same display (most cases this is :0 ), so make sure
107 # Xvfb is started, else bump the display number
108 #
109 # Azarah - 5 May 2002
110 XDISPLAY=$(i=0; while [[ -f /tmp/.X${i}-lock ]] ; do ((i++));done; echo ${i})
111 debug-print "${FUNCNAME}: XDISPLAY=${XDISPLAY}"
112
113 # We really do not want SANDBOX enabled here
114 export SANDBOX_ON="0"
115
116 debug-print "${FUNCNAME}: ${XVFB} :${XDISPLAY} ${xvfbargs}"
117 ${XVFB} :${XDISPLAY} ${xvfbargs} &>/dev/null &
118 sleep 2
119
120 local start=${XDISPLAY}
121 while [[ ! -f /tmp/.X${XDISPLAY}-lock ]]; do
122 # Stop trying after 15 tries
123 if ((XDISPLAY - start > 15)) ; then
124 eerror "'${XVFB} :${XDISPLAY} ${xvfbargs}' returns:"
125 echo
126 ${XVFB} :${XDISPLAY} ${xvfbargs}
127 echo
128 eerror "If possible, correct the above error and try your emerge again."
129 die "Unable to start Xvfb"
130 fi
131
132 ((XDISPLAY++))
133 debug-print "${FUNCNAME}: ${XVFB} :${XDISPLAY} ${xvfbargs}"
134 ${XVFB} :${XDISPLAY} ${xvfbargs} &>/dev/null &
135 sleep 2
136 done
137
138 # Now enable SANDBOX again if needed.
139 export SANDBOX_ON="${OLD_SANDBOX_ON}"
140
141 einfo "Starting Xvfb on \$DISPLAY=${XDISPLAY} ..."
142
143 export DISPLAY=:${XDISPLAY}
144 # Do not break on error, but setup $retval, as we need
145 # to kill Xvfb
146 debug-print "${FUNCNAME}: ${VIRTUALX_COMMAND} \"$@\""
147 ${VIRTUALX_COMMAND} "$@"
148 retval=$?
149
150 # Now kill Xvfb
151 kill $(cat /tmp/.X${XDISPLAY}-lock)
152 else
153 debug-print "${FUNCNAME}: attaching to running X display"
154 # Normal make if we can connect to an X display
155 debug-print "${FUNCNAME}: ${VIRTUALX_COMMAND} \"$@\""
156 ${VIRTUALX_COMMAND} "$@"
157 retval=$?
158 fi
159
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
164 }
165
166 # @FUNCTION: Xmake
167 # @DESCRIPTION:
168 # Same as "make", but set up the Xvfb hack if needed.
169 # Deprecated call.
170 Xmake() {
171 debug-print-function ${FUNCNAME} "$@"
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 "$@"
176 }
177
178 # @FUNCTION: Xemake
179 # @DESCRIPTION:
180 # Same as "emake", but set up the Xvfb hack if needed.
181 Xemake() {
182 debug-print-function ${FUNCNAME} "$@"
183
184 VIRTUALX_COMMAND="emake" virtualmake "$@"
185 }
186
187 # @FUNCTION: Xeconf
188 # @DESCRIPTION:
189 # Same as "econf", but set up the Xvfb hack if needed.
190 Xeconf() {
191 debug-print-function ${FUNCNAME} "$@"
192
193 VIRTUALX_COMMAND="econf" virtualmake "$@"
194 }

  ViewVC Help
Powered by ViewVC 1.1.20