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

Diff of /eclass/virtualx.eclass

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

Revision 1.20 Revision 1.42
1# Copyright 1999-2004 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.20 2005/06/07 14:26:03 azarah 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
9ECLASS=virtualx 5# @ECLASS: virtualx.eclass
10INHERITED="$INHERITED $ECLASS" 6# @MAINTAINER:
11DEPEND="X? ( virtual/x11 )" 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.
12 11
13DESCRIPTION="Based on the $ECLASS eclass" 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}
14 21
15# 22# @ECLASS-VARIABLE: VIRTUALX_DEPEND
16# Brian Harring <ferringb@gentoo.org> 11/04/2004 23# @DESCRIPTION:
17# do not disable the sandbox during the depend phase. 24# Dep string available for use outside of eclass, in case a more
18# ebuilds shouldn't touch the fs during depend phase, nor screw with the sandbox. 25# complicated dep is needed.
19# 26# You can specify the variable BEFORE inherit to add more dependencies.
20if [[ ${EBUILD_PHASE/depend} == "${EBUILD_PHASE}" ]] ; then 27VIRTUALX_DEPEND="${VIRTUALX_DEPEND}
21 [[ -z ${SANDBOX_DISABLED} ]] && export SANDBOX_DISABLED="0" || : 28 !prefix? ( x11-base/xorg-server[xvfb] )
22fi 29 x11-apps/xhost
30"
23 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."
39
40case ${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 ;;
70esac
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.
24virtualmake() { 76virtualmake() {
77 debug-print-function ${FUNCNAME} "$@"
78
79 local i=0
25 local retval=0 80 local retval=0
26 local OLD_SANDBOX_DISABLED="${SANDBOX_DISABLED}" 81 local OLD_SANDBOX_ON="${SANDBOX_ON}"
27 local XVFB=$(type -p Xvfb) 82 local XVFB=$(type -p Xvfb)
28 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
29 93
30 # 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
31 # display, then do the Xvfb hack. 95 # display, then do the Xvfb hack.
32 if [[ -n ${XVFB} && -n ${XHOST} ]] && \ 96 if [[ -n ${XVFB} && -n ${XHOST} ]] && \
33 ( [[ -z ${DISPLAY} ]] || ! (${XHOST} &>/dev/null) ) ; then 97 ( [[ -z ${DISPLAY} ]] || ! (${XHOST} &>/dev/null) ) ; then
98 debug-print "${FUNCNAME}: running Xvfb hack"
34 export XAUTHORITY= 99 export XAUTHORITY=
35 # The following is derived from Mandrake's hack to allow 100 # The following is derived from Mandrake's hack to allow
36 # compiling without the X display 101 # compiling without the X display
37 102
38 einfo "Scanning for a open DISPLAY to start Xvfb ..." 103 einfo "Scanning for an open DISPLAY to start Xvfb ..."
39
40 # We really do not want SANDBOX enabled here
41 export SANDBOX_DISABLED="1"
42
43 local i=0
44 XDISPLAY=$(i=0; while [[ -f /tmp/.X${i}-lock ]] ; do i=$((${i}+1));done; echo ${i})
45
46 # 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
47 # 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
48 # 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
49 # Xvfb is started, else bump the display number 107 # Xvfb is started, else bump the display number
50 # 108 #
51 # Azarah - 5 May 2002 109 # Azarah - 5 May 2002
52 # 110 XDISPLAY=$(i=0; while [[ -f /tmp/.X${i}-lock ]] ; do ((i++));done; echo ${i})
53 # Changed the mode from 800x600x32 to 800x600x24 because the mfb 111 debug-print "${FUNCNAME}: XDISPLAY=${XDISPLAY}"
54 # support has been dropped in Xvfb in the xorg-x11 pre-releases. 112
55 # For now only depths up to 24-bit are supported. 113 # We really do not want SANDBOX enabled here
56 # 114 export SANDBOX_ON="0"
57 # Sven Wegener <swegener@gentoo.org> - 22 Aug 2004 115
58 # 116 debug-print "${FUNCNAME}: ${XVFB} :${XDISPLAY} ${xvfbargs}"
59 ${XVFB} :${XDISPLAY} -screen 0 800x600x24 &>/dev/null & 117 ${XVFB} :${XDISPLAY} ${xvfbargs} &>/dev/null &
60 sleep 2 118 sleep 2
61 119
62 local start=${XDISPLAY} 120 local start=${XDISPLAY}
63 while [[ ! -f /tmp/.X${XDISPLAY}-lock ]] ; do 121 while [[ ! -f /tmp/.X${XDISPLAY}-lock ]]; do
64 # Stop trying after 15 tries 122 # Stop trying after 15 tries
65 if [[ $((${XDISPLAY} - ${start})) -gt 15 ]] ; then 123 if ((XDISPLAY - start > 15)) ; then
66 124 eerror "'${XVFB} :${XDISPLAY} ${xvfbargs}' returns:"
67 eerror "" 125 echo
68 eerror "Unable to start Xvfb." 126 ${XVFB} :${XDISPLAY} ${xvfbargs}
69 eerror "" 127 echo
70 eerror "'/usr/X11R6/bin/Xvfb :${XDISPLAY} -screen 0 800x600x24' returns:"
71 eerror ""
72 ${XVFB} :${XDISPLAY} -screen 0 800x600x24
73 eerror ""
74 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."
75 eerror "" 129 die "Unable to start Xvfb"
76 die
77 fi 130 fi
78 131
79 XDISPLAY=$((${XDISPLAY}+1)) 132 ((XDISPLAY++))
80 ${XVFB} :${XDISPLAY} -screen 0 800x600x24 &>/dev/null & 133 debug-print "${FUNCNAME}: ${XVFB} :${XDISPLAY} ${xvfbargs}"
134 ${XVFB} :${XDISPLAY} ${xvfbargs} &>/dev/null &
81 sleep 2 135 sleep 2
82 done 136 done
83 137
84 # Now enable SANDBOX again if needed. 138 # Now enable SANDBOX again if needed.
85 export SANDBOX_DISABLED="${OLD_SANDBOX_DISABLED}" 139 export SANDBOX_ON="${OLD_SANDBOX_ON}"
86 140
87 einfo "Starting Xvfb on \$DISPLAY=${XDISPLAY} ..." 141 einfo "Starting Xvfb on \$DISPLAY=${XDISPLAY} ..."
88 142
89 export DISPLAY=:${XDISPLAY} 143 export DISPLAY=:${XDISPLAY}
90 #Do not break on error, but setup $retval, as we need 144 # Do not break on error, but setup $retval, as we need
91 #to kill Xvfb 145 # to kill Xvfb
92 ${maketype} $* 146 debug-print "${FUNCNAME}: ${VIRTUALX_COMMAND} \"$@\""
147 nonfatal ${VIRTUALX_COMMAND} "$@"
93 retval=$? 148 retval=$?
94 149
95 #Now kill Xvfb 150 # Now kill Xvfb
96 kill $(cat /tmp/.X${XDISPLAY}-lock) 151 kill $(cat /tmp/.X${XDISPLAY}-lock)
97 else 152 else
153 debug-print "${FUNCNAME}: attaching to running X display"
98 #Normal make if we can connect to an X display 154 # Normal make if we can connect to an X display
99 ${maketype} $* 155 debug-print "${FUNCNAME}: ${VIRTUALX_COMMAND} \"$@\""
156 ${VIRTUALX_COMMAND} "$@"
100 retval=$? 157 retval=$?
101 fi 158 fi
102 159
103 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
104} 164}
105 165
166# @FUNCTION: Xmake
167# @DESCRIPTION:
106#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.
107Xmake() { 170Xmake() {
108 export maketype="make" 171 debug-print-function ${FUNCNAME} "$@"
109 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 "$@"
110} 176}
111 177
178# @FUNCTION: Xemake
179# @DESCRIPTION:
112#Same as "emake", but setup the Xvfb hack if needed 180# Same as "emake", but set up the Xvfb hack if needed.
113Xemake() { 181Xemake() {
114 export maketype="emake" 182 debug-print-function ${FUNCNAME} "$@"
115 virtualmake "$*" 183
184 VIRTUALX_COMMAND="emake" virtualmake "$@"
116} 185}
117 186
187# @FUNCTION: Xeconf
188# @DESCRIPTION:
118#Same as "econf", but setup the Xvfb hack if needed 189# Same as "econf", but set up the Xvfb hack if needed.
119Xeconf() { 190Xeconf() {
120 export maketype="econf" 191 debug-print-function ${FUNCNAME} "$@"
121 virtualmake "$*" 192
193 VIRTUALX_COMMAND="econf" virtualmake "$@"
122} 194}

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

  ViewVC Help
Powered by ViewVC 1.1.20