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

Contents of /eclass/eutils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.444 - (hide annotations) (download)
Fri Mar 20 18:28:11 2015 UTC (4 weeks ago) by vapier
Branch: MAIN
CVS Tags: HEAD
Changes since 1.443: +10 -1 lines
epatch_user: add an explicit notice of patches applied when die is called #543878 by Sergey S. Starikoff

1 mgorny 1.442 # Copyright 1999-2015 Gentoo Foundation
2 azarah 1.1 # Distributed under the terms of the GNU General Public License v2
3 vapier 1.444 # $Header: /var/cvsroot/gentoo-x86/eclass/eutils.eclass,v 1.443 2015/03/20 18:22:05 vapier Exp $
4 vapier 1.283
5     # @ECLASS: eutils.eclass
6     # @MAINTAINER:
7     # base-system@gentoo.org
8     # @BLURB: many extra (but common) functions that are used in ebuilds
9     # @DESCRIPTION:
10     # The eutils eclass contains a suite of functions that complement
11     # the ones that ebuild.sh already contain. The idea is that the functions
12     # are not required in all ebuilds but enough utilize them to have a common
13     # home rather than having multiple ebuilds implementing the same thing.
14 swegener 1.286 #
15 vapier 1.283 # Due to the nature of this eclass, some functions may have maintainers
16     # different from the overall eclass!
17 azarah 1.1
18 ulm 1.436 if [[ -z ${_EUTILS_ECLASS} ]]; then
19     _EUTILS_ECLASS=1
20 vapier 1.371
21 vapier 1.431 inherit multilib toolchain-funcs
22 azarah 1.1
23 betelgeuse 1.329 if has "${EAPI:-0}" 0 1 2; then
24    
25 vapier 1.283 # @FUNCTION: epause
26     # @USAGE: [seconds]
27     # @DESCRIPTION:
28     # Sleep for the specified number of seconds (default of 5 seconds). Useful when
29     # printing a message the user should probably be reading and often used in
30     # conjunction with the ebeep function. If the EPAUSE_IGNORE env var is set,
31 betelgeuse 1.329 # don't wait at all. Defined in EAPIs 0 1 and 2.
32 ciaranm 1.98 epause() {
33 vapier 1.245 [[ -z ${EPAUSE_IGNORE} ]] && sleep ${1:-5}
34 ciaranm 1.98 }
35    
36 vapier 1.283 # @FUNCTION: ebeep
37     # @USAGE: [number of beeps]
38     # @DESCRIPTION:
39     # Issue the specified number of beeps (default of 5 beeps). Useful when
40     # printing a message the user should probably be reading and often used in
41     # conjunction with the epause function. If the EBEEP_IGNORE env var is set,
42 betelgeuse 1.329 # don't beep at all. Defined in EAPIs 0 1 and 2.
43 ciaranm 1.98 ebeep() {
44     local n
45 vapier 1.245 if [[ -z ${EBEEP_IGNORE} ]] ; then
46 ciaranm 1.98 for ((n=1 ; n <= ${1:-5} ; n++)) ; do
47     echo -ne "\a"
48     sleep 0.1 &>/dev/null ; sleep 0,1 &>/dev/null
49     echo -ne "\a"
50     sleep 1
51     done
52     fi
53     }
54    
55 reavertm 1.331 else
56    
57 reavertm 1.332 ebeep() {
58 reavertm 1.337 ewarn "QA Notice: ebeep is not defined in EAPI=${EAPI}, please file a bug at http://bugs.gentoo.org"
59 reavertm 1.332 }
60 reavertm 1.331
61 reavertm 1.332 epause() {
62 reavertm 1.337 ewarn "QA Notice: epause is not defined in EAPI=${EAPI}, please file a bug at http://bugs.gentoo.org"
63 reavertm 1.332 }
64 reavertm 1.331
65 betelgeuse 1.329 fi
66    
67 betelgeuse 1.348 # @FUNCTION: eqawarn
68     # @USAGE: [message]
69     # @DESCRIPTION:
70 mgorny 1.363 # Proxy to ewarn for package managers that don't provide eqawarn and use the PM
71     # implementation if available. Reuses PORTAGE_ELOG_CLASSES as set by the dev
72     # profile.
73 betelgeuse 1.348 if ! declare -F eqawarn >/dev/null ; then
74     eqawarn() {
75 mgorny 1.363 has qa ${PORTAGE_ELOG_CLASSES} && ewarn "$@"
76 ferringb 1.370 :
77 betelgeuse 1.348 }
78     fi
79    
80 hollow 1.298 # @FUNCTION: ecvs_clean
81 vapier 1.299 # @USAGE: [list of dirs]
82 hollow 1.298 # @DESCRIPTION:
83 vapier 1.299 # Remove CVS directories recursiveley. Useful when a source tarball contains
84     # internal CVS directories. Defaults to $PWD.
85 hollow 1.298 ecvs_clean() {
86 vapier 1.299 [[ -z $* ]] && set -- .
87 hollow 1.298 find "$@" -type d -name 'CVS' -prune -print0 | xargs -0 rm -rf
88     find "$@" -type f -name '.cvs*' -print0 | xargs -0 rm -rf
89     }
90    
91     # @FUNCTION: esvn_clean
92 vapier 1.299 # @USAGE: [list of dirs]
93 hollow 1.298 # @DESCRIPTION:
94 vapier 1.299 # Remove .svn directories recursiveley. Useful when a source tarball contains
95     # internal Subversion directories. Defaults to $PWD.
96 hollow 1.298 esvn_clean() {
97 vapier 1.299 [[ -z $* ]] && set -- .
98 hollow 1.298 find "$@" -type d -name '.svn' -prune -print0 | xargs -0 rm -rf
99     }
100    
101 vapier 1.373 # @FUNCTION: estack_push
102     # @USAGE: <stack> [items to push]
103     # @DESCRIPTION:
104     # Push any number of items onto the specified stack. Pick a name that
105     # is a valid variable (i.e. stick to alphanumerics), and push as many
106     # items as you like onto the stack at once.
107     #
108     # The following code snippet will echo 5, then 4, then 3, then ...
109     # @CODE
110     # estack_push mystack 1 2 3 4 5
111     # while estack_pop mystack i ; do
112     # echo "${i}"
113     # done
114     # @CODE
115     estack_push() {
116     [[ $# -eq 0 ]] && die "estack_push: incorrect # of arguments"
117 ulm 1.436 local stack_name="_ESTACK_$1_" ; shift
118 vapier 1.373 eval ${stack_name}+=\( \"\$@\" \)
119     }
120    
121     # @FUNCTION: estack_pop
122     # @USAGE: <stack> [variable]
123     # @DESCRIPTION:
124     # Pop a single item off the specified stack. If a variable is specified,
125     # the popped item is stored there. If no more items are available, return
126     # 1, else return 0. See estack_push for more info.
127     estack_pop() {
128     [[ $# -eq 0 || $# -gt 2 ]] && die "estack_pop: incorrect # of arguments"
129    
130 ulm 1.436 # We use the fugly _estack_xxx var names to avoid collision with
131 vapier 1.373 # passing back the return value. If we used "local i" and the
132     # caller ran `estack_pop ... i`, we'd end up setting the local
133 ulm 1.436 # copy of "i" rather than the caller's copy. The _estack_xxx
134 vapier 1.373 # garbage is preferable to using $1/$2 everywhere as that is a
135     # bit harder to read.
136 ulm 1.436 local _estack_name="_ESTACK_$1_" ; shift
137     local _estack_retvar=$1 ; shift
138     eval local _estack_i=\${#${_estack_name}\[@\]}
139 vapier 1.373 # Don't warn -- let the caller interpret this as a failure
140     # or as normal behavior (akin to `shift`)
141 ulm 1.436 [[ $(( --_estack_i )) -eq -1 ]] && return 1
142 vapier 1.373
143 ulm 1.436 if [[ -n ${_estack_retvar} ]] ; then
144     eval ${_estack_retvar}=\"\${${_estack_name}\[${_estack_i}\]}\"
145 vapier 1.373 fi
146 ulm 1.436 eval unset ${_estack_name}\[${_estack_i}\]
147 vapier 1.373 }
148    
149 vapier 1.423 # @FUNCTION: evar_push
150     # @USAGE: <variable to save> [more vars to save]
151     # @DESCRIPTION:
152     # This let's you temporarily modify a variable and then restore it (including
153     # set vs unset semantics). Arrays are not supported at this time.
154     #
155     # This is meant for variables where using `local` does not work (such as
156     # exported variables, or only temporarily changing things in a func).
157     #
158     # For example:
159     # @CODE
160     # evar_push LC_ALL
161     # export LC_ALL=C
162     # ... do some stuff that needs LC_ALL=C set ...
163     # evar_pop
164     #
165     # # You can also save/restore more than one var at a time
166     # evar_push BUTTERFLY IN THE SKY
167     # ... do stuff with the vars ...
168     # evar_pop # This restores just one var, SKY
169     # ... do more stuff ...
170     # evar_pop 3 # This pops the remaining 3 vars
171     # @CODE
172     evar_push() {
173     local var val
174     for var ; do
175     [[ ${!var+set} == "set" ]] \
176     && val=${!var} \
177 ulm 1.436 || val="unset_76fc3c462065bb4ca959f939e6793f94"
178 vapier 1.423 estack_push evar "${var}" "${val}"
179     done
180     }
181    
182     # @FUNCTION: evar_push_set
183     # @USAGE: <variable to save> [new value to store]
184     # @DESCRIPTION:
185     # This is a handy shortcut to save and temporarily set a variable. If a value
186     # is not specified, the var will be unset.
187     evar_push_set() {
188     local var=$1
189     evar_push ${var}
190     case $# in
191     1) unset ${var} ;;
192     2) printf -v "${var}" '%s' "$2" ;;
193     *) die "${FUNCNAME}: incorrect # of args: $*" ;;
194     esac
195     }
196    
197     # @FUNCTION: evar_pop
198     # @USAGE: [number of vars to restore]
199     # @DESCRIPTION:
200     # Restore the variables to the state saved with the corresponding
201     # evar_push call. See that function for more details.
202     evar_pop() {
203     local cnt=${1:-bad}
204     case $# in
205     0) cnt=1 ;;
206     1) isdigit "${cnt}" || die "${FUNCNAME}: first arg must be a number: $*" ;;
207     *) die "${FUNCNAME}: only accepts one arg: $*" ;;
208     esac
209    
210     local var val
211     while (( cnt-- )) ; do
212     estack_pop evar val || die "${FUNCNAME}: unbalanced push"
213     estack_pop evar var || die "${FUNCNAME}: unbalanced push"
214 ulm 1.436 [[ ${val} == "unset_76fc3c462065bb4ca959f939e6793f94" ]] \
215 vapier 1.423 && unset ${var} \
216     || printf -v "${var}" '%s' "${val}"
217     done
218     }
219    
220 vapier 1.322 # @FUNCTION: eshopts_push
221 vapier 1.330 # @USAGE: [options to `set` or `shopt`]
222 vapier 1.322 # @DESCRIPTION:
223     # Often times code will want to enable a shell option to change code behavior.
224     # Since changing shell options can easily break other pieces of code (which
225     # assume the default state), eshopts_push is used to (1) push the current shell
226     # options onto a stack and (2) pass the specified arguments to set.
227     #
228 vapier 1.330 # If the first argument is '-s' or '-u', we assume you want to call `shopt`
229     # rather than `set` as there are some options only available via that.
230     #
231 vapier 1.322 # A common example is to disable shell globbing so that special meaning/care
232     # may be used with variables/arguments to custom functions. That would be:
233     # @CODE
234 vapier 1.438 # eshopts_push -o noglob
235 vapier 1.322 # for x in ${foo} ; do
236     # if ...some check... ; then
237     # eshopts_pop
238     # return 0
239     # fi
240     # done
241     # eshopts_pop
242     # @CODE
243     eshopts_push() {
244 vapier 1.330 if [[ $1 == -[su] ]] ; then
245 vapier 1.376 estack_push eshopts "$(shopt -p)"
246 vapier 1.330 [[ $# -eq 0 ]] && return 0
247 vapier 1.375 shopt "$@" || die "${FUNCNAME}: bad options to shopt: $*"
248 vapier 1.330 else
249 vapier 1.376 estack_push eshopts $-
250 vapier 1.330 [[ $# -eq 0 ]] && return 0
251 vapier 1.375 set "$@" || die "${FUNCNAME}: bad options to set: $*"
252 vapier 1.330 fi
253 vapier 1.322 }
254    
255     # @FUNCTION: eshopts_pop
256     # @USAGE:
257     # @DESCRIPTION:
258     # Restore the shell options to the state saved with the corresponding
259     # eshopts_push call. See that function for more details.
260     eshopts_pop() {
261 vapier 1.376 local s
262     estack_pop eshopts s || die "${FUNCNAME}: unbalanced push"
263 vapier 1.330 if [[ ${s} == "shopt -"* ]] ; then
264 vapier 1.375 eval "${s}" || die "${FUNCNAME}: sanity: invalid shopt options: ${s}"
265 vapier 1.330 else
266 vapier 1.375 set +$- || die "${FUNCNAME}: sanity: invalid shell settings: $-"
267     set -${s} || die "${FUNCNAME}: sanity: unable to restore saved shell settings: ${s}"
268 vapier 1.330 fi
269 vapier 1.322 }
270    
271 vapier 1.373 # @FUNCTION: eumask_push
272     # @USAGE: <new umask>
273     # @DESCRIPTION:
274     # Set the umask to the new value specified while saving the previous
275     # value onto a stack. Useful for temporarily changing the umask.
276     eumask_push() {
277     estack_push eumask "$(umask)"
278     umask "$@" || die "${FUNCNAME}: bad options to umask: $*"
279     }
280    
281     # @FUNCTION: eumask_pop
282     # @USAGE:
283     # @DESCRIPTION:
284     # Restore the previous umask state.
285     eumask_pop() {
286 vapier 1.382 [[ $# -eq 0 ]] || die "${FUNCNAME}: we take no options"
287 vapier 1.373 local s
288     estack_pop eumask s || die "${FUNCNAME}: unbalanced push"
289     umask ${s} || die "${FUNCNAME}: sanity: could not restore umask: ${s}"
290     }
291    
292 vapier 1.422 # @FUNCTION: isdigit
293     # @USAGE: <number> [more numbers]
294     # @DESCRIPTION:
295     # Return true if all arguments are numbers.
296     isdigit() {
297     local d
298     for d ; do
299     [[ ${d:-bad} == *[!0-9]* ]] && return 1
300     done
301     return 0
302     }
303    
304 vapier 1.325 # @VARIABLE: EPATCH_SOURCE
305     # @DESCRIPTION:
306     # Default directory to search for patches.
307 azarah 1.2 EPATCH_SOURCE="${WORKDIR}/patch"
308 vapier 1.325 # @VARIABLE: EPATCH_SUFFIX
309     # @DESCRIPTION:
310     # Default extension for patches (do not prefix the period yourself).
311 azarah 1.2 EPATCH_SUFFIX="patch.bz2"
312 vapier 1.325 # @VARIABLE: EPATCH_OPTS
313     # @DESCRIPTION:
314 vapier 1.391 # Options to pass to patch. Meant for ebuild/package-specific tweaking
315     # such as forcing the patch level (-p#) or fuzz (-F#) factor. Note that
316     # for single patch tweaking, you can also pass flags directly to epatch.
317     EPATCH_OPTS=""
318     # @VARIABLE: EPATCH_COMMON_OPTS
319     # @DESCRIPTION:
320     # Common options to pass to `patch`. You probably should never need to
321     # change these. If you do, please discuss it with base-system first to
322     # be sure.
323 vapier 1.325 # @CODE
324     # -g0 - keep RCS, ClearCase, Perforce and SCCS happy #24571
325     # --no-backup-if-mismatch - do not leave .orig files behind
326     # -E - automatically remove empty files
327     # @CODE
328 vapier 1.391 EPATCH_COMMON_OPTS="-g0 -E --no-backup-if-mismatch"
329 vapier 1.325 # @VARIABLE: EPATCH_EXCLUDE
330     # @DESCRIPTION:
331 mr_bones_ 1.308 # List of patches not to apply. Note this is only file names,
332 vapier 1.325 # and not the full path. Globs accepted.
333 azarah 1.6 EPATCH_EXCLUDE=""
334 vapier 1.325 # @VARIABLE: EPATCH_SINGLE_MSG
335     # @DESCRIPTION:
336 azarah 1.9 # Change the printed message for a single patch.
337     EPATCH_SINGLE_MSG=""
338 vapier 1.325 # @VARIABLE: EPATCH_MULTI_MSG
339     # @DESCRIPTION:
340 vapier 1.173 # Change the printed message for multiple patches.
341     EPATCH_MULTI_MSG="Applying various patches (bugfixes/updates) ..."
342 vapier 1.325 # @VARIABLE: EPATCH_FORCE
343     # @DESCRIPTION:
344     # Only require patches to match EPATCH_SUFFIX rather than the extended
345     # arch naming style.
346 azarah 1.29 EPATCH_FORCE="no"
347 vapier 1.416 # @VARIABLE: EPATCH_USER_EXCLUDE
348     # @DEFAULT_UNSET
349     # @DESCRIPTION:
350     # List of patches not to apply. Note this is only file names,
351     # and not the full path. Globs accepted.
352 azarah 1.2
353 vapier 1.325 # @FUNCTION: epatch
354 vapier 1.391 # @USAGE: [options] [patches] [dirs of patches]
355 vapier 1.325 # @DESCRIPTION:
356     # epatch is designed to greatly simplify the application of patches. It can
357     # process patch files directly, or directories of patches. The patches may be
358     # compressed (bzip/gzip/etc...) or plain text. You generally need not specify
359 vapier 1.425 # the -p option as epatch will automatically attempt -p0 to -p4 until things
360 vapier 1.325 # apply successfully.
361 azarah 1.2 #
362 vapier 1.391 # If you do not specify any patches/dirs, then epatch will default to the
363     # directory specified by EPATCH_SOURCE.
364     #
365     # Any options specified that start with a dash will be passed down to patch
366     # for this specific invocation. As soon as an arg w/out a dash is found, then
367     # arg processing stops.
368 azarah 1.2 #
369 vapier 1.325 # When processing directories, epatch will apply all patches that match:
370     # @CODE
371 vapier 1.350 # if ${EPATCH_FORCE} != "yes"
372 vapier 1.325 # ??_${ARCH}_foo.${EPATCH_SUFFIX}
373     # else
374     # *.${EPATCH_SUFFIX}
375     # @CODE
376     # The leading ?? are typically numbers used to force consistent patch ordering.
377     # The arch field is used to apply patches only for the host architecture with
378     # the special value of "all" means apply for everyone. Note that using values
379     # other than "all" is highly discouraged -- you should apply patches all the
380     # time and let architecture details be detected at configure/compile time.
381 azarah 1.2 #
382 vapier 1.325 # If EPATCH_SUFFIX is empty, then no period before it is implied when searching
383     # for patches to apply.
384 azarah 1.2 #
385 vapier 1.325 # Refer to the other EPATCH_xxx variables for more customization of behavior.
386 azarah 1.2 epatch() {
387 swegener 1.231 _epatch_draw_line() {
388 vapier 1.325 # create a line of same length as input string
389 agriffis 1.229 [[ -z $1 ]] && set "$(printf "%65s" '')"
390     echo "${1//?/=}"
391 vapier 1.219 }
392 azarah 1.3
393 vapier 1.195 unset P4CONFIG P4PORT P4USER # keep perforce at bay #56402
394    
395 vapier 1.391 # First process options. We localize the EPATCH_OPTS setting
396     # from above so that we can pass it on in the loop below with
397     # any additional values the user has specified.
398     local EPATCH_OPTS=( ${EPATCH_OPTS[*]} )
399     while [[ $# -gt 0 ]] ; do
400     case $1 in
401     -*) EPATCH_OPTS+=( "$1" ) ;;
402     *) break ;;
403     esac
404     shift
405     done
406    
407 vapier 1.325 # Let the rest of the code process one user arg at a time --
408     # each arg may expand into multiple patches, and each arg may
409     # need to start off with the default global EPATCH_xxx values
410     if [[ $# -gt 1 ]] ; then
411     local m
412 vapier 1.94 for m in "$@" ; do
413     epatch "${m}"
414     done
415     return 0
416 azarah 1.3 fi
417    
418 vapier 1.325 local SINGLE_PATCH="no"
419     # no args means process ${EPATCH_SOURCE}
420     [[ $# -eq 0 ]] && set -- "${EPATCH_SOURCE}"
421    
422     if [[ -f $1 ]] ; then
423 azarah 1.3 SINGLE_PATCH="yes"
424 vapier 1.325 set -- "$1"
425     # Use the suffix from the single patch (localize it); the code
426     # below will find the suffix for us
427     local EPATCH_SUFFIX=$1
428    
429     elif [[ -d $1 ]] ; then
430 vapier 1.424 # We have to force sorting to C so that the wildcard expansion is consistent #471666.
431     evar_push_set LC_COLLATE C
432     # Some people like to make dirs of patches w/out suffixes (vim).
433 vapier 1.325 set -- "$1"/*${EPATCH_SUFFIX:+."${EPATCH_SUFFIX}"}
434 vapier 1.424 evar_pop
435 danarmak 1.32
436 vapier 1.359 elif [[ -f ${EPATCH_SOURCE}/$1 ]] ; then
437     # Re-use EPATCH_SOURCE as a search dir
438     epatch "${EPATCH_SOURCE}/$1"
439     return $?
440    
441 azarah 1.3 else
442 vapier 1.325 # sanity check ... if it isn't a dir or file, wtf man ?
443     [[ $# -ne 0 ]] && EPATCH_SOURCE=$1
444     echo
445     eerror "Cannot find \$EPATCH_SOURCE! Value for \$EPATCH_SOURCE is:"
446     eerror
447     eerror " ${EPATCH_SOURCE}"
448     eerror " ( ${EPATCH_SOURCE##*/} )"
449     echo
450     die "Cannot find \$EPATCH_SOURCE!"
451 azarah 1.3 fi
452 azarah 1.2
453 vapier 1.391 # Now that we know we're actually going to apply something, merge
454     # all of the patch options back in to a single variable for below.
455     EPATCH_OPTS="${EPATCH_COMMON_OPTS} ${EPATCH_OPTS[*]}"
456    
457 vapier 1.325 local PIPE_CMD
458 azarah 1.2 case ${EPATCH_SUFFIX##*\.} in
459 vapier 1.325 xz) PIPE_CMD="xz -dc" ;;
460     lzma) PIPE_CMD="lzma -dc" ;;
461     bz2) PIPE_CMD="bzip2 -dc" ;;
462     gz|Z|z) PIPE_CMD="gzip -dc" ;;
463     ZIP|zip) PIPE_CMD="unzip -p" ;;
464     *) ;;
465 azarah 1.2 esac
466    
467 vapier 1.325 [[ ${SINGLE_PATCH} == "no" ]] && einfo "${EPATCH_MULTI_MSG}"
468    
469     local x
470     for x in "$@" ; do
471     # If the patch dir given contains subdirs, or our EPATCH_SUFFIX
472     # didn't match anything, ignore continue on
473     [[ ! -f ${x} ]] && continue
474    
475     local patchname=${x##*/}
476    
477     # Apply single patches, or forced sets of patches, or
478     # patches with ARCH dependant names.
479 flameeyes 1.266 # ???_arch_foo.patch
480 vapier 1.325 # Else, skip this input altogether
481     local a=${patchname#*_} # strip the ???_
482     a=${a%%_*} # strip the _foo.patch
483     if ! [[ ${SINGLE_PATCH} == "yes" || \
484 ulm 1.354 ${EPATCH_FORCE} == "yes" || \
485     ${a} == all || \
486     ${a} == ${ARCH} ]]
487 azarah 1.2 then
488 vapier 1.325 continue
489     fi
490 azarah 1.6
491 vapier 1.325 # Let people filter things dynamically
492 vapier 1.437 if [[ -n ${EPATCH_EXCLUDE}${EPATCH_USER_EXCLUDE} ]] ; then
493 vapier 1.325 # let people use globs in the exclude
494     eshopts_push -o noglob
495    
496 scarabeus 1.328 local ex
497 vapier 1.325 for ex in ${EPATCH_EXCLUDE} ; do
498 scarabeus 1.328 if [[ ${patchname} == ${ex} ]] ; then
499 vapier 1.416 einfo " Skipping ${patchname} due to EPATCH_EXCLUDE ..."
500     eshopts_pop
501     continue 2
502     fi
503     done
504    
505     for ex in ${EPATCH_USER_EXCLUDE} ; do
506     if [[ ${patchname} == ${ex} ]] ; then
507     einfo " Skipping ${patchname} due to EPATCH_USER_EXCLUDE ..."
508 scarabeus 1.328 eshopts_pop
509     continue 2
510     fi
511 vapier 1.325 done
512 vapier 1.326
513 vapier 1.325 eshopts_pop
514     fi
515 danarmak 1.32
516 vapier 1.325 if [[ ${SINGLE_PATCH} == "yes" ]] ; then
517     if [[ -n ${EPATCH_SINGLE_MSG} ]] ; then
518     einfo "${EPATCH_SINGLE_MSG}"
519 azarah 1.3 else
520 vapier 1.325 einfo "Applying ${patchname} ..."
521 azarah 1.3 fi
522 vapier 1.325 else
523     einfo " ${patchname} ..."
524     fi
525 azarah 1.2
526 vapier 1.443 # Handle aliased patch command #404447 #461568
527     local patch="patch"
528     eval $(alias patch 2>/dev/null | sed 's:^alias ::')
529    
530 vapier 1.325 # most of the time, there will only be one run per unique name,
531     # but if there are more, make sure we get unique log filenames
532     local STDERR_TARGET="${T}/${patchname}.out"
533     if [[ -e ${STDERR_TARGET} ]] ; then
534     STDERR_TARGET="${T}/${patchname}-$$.out"
535     fi
536 azarah 1.2
537 vapier 1.443 printf "***** %s *****\nPWD: %s\nPATCH TOOL: %s -> %s\nVERSION INFO:\n%s\n\n" \
538     "${patchname}" \
539     "${PWD}" \
540     "${patch}" \
541     "$(type -P "${patch}")" \
542     "$(${patch} --version)" \
543     > "${STDERR_TARGET}"
544 vapier 1.304
545 vapier 1.325 # Decompress the patch if need be
546     local count=0
547     local PATCH_TARGET
548     if [[ -n ${PIPE_CMD} ]] ; then
549     PATCH_TARGET="${T}/$$.patch"
550     echo "PIPE_COMMAND: ${PIPE_CMD} ${x} > ${PATCH_TARGET}" >> "${STDERR_TARGET}"
551 vapier 1.304
552 vapier 1.325 if ! (${PIPE_CMD} "${x}" > "${PATCH_TARGET}") >> "${STDERR_TARGET}" 2>&1 ; then
553     echo
554     eerror "Could not extract patch!"
555     #die "Could not extract patch!"
556     count=5
557     break
558 vapier 1.305 fi
559 vapier 1.325 else
560     PATCH_TARGET=${x}
561     fi
562 vapier 1.305
563 vapier 1.325 # Check for absolute paths in patches. If sandbox is disabled,
564     # people could (accidently) patch files in the root filesystem.
565     # Or trigger other unpleasantries #237667. So disallow -p0 on
566     # such patches.
567     local abs_paths=$(egrep -n '^[-+]{3} /' "${PATCH_TARGET}" | awk '$2 != "/dev/null" { print }')
568     if [[ -n ${abs_paths} ]] ; then
569     count=1
570     printf "NOTE: skipping -p0 due to absolute paths in patch:\n%s\n" "${abs_paths}" >> "${STDERR_TARGET}"
571     fi
572 vapier 1.353 # Similar reason, but with relative paths.
573     local rel_paths=$(egrep -n '^[-+]{3} [^ ]*[.][.]/' "${PATCH_TARGET}")
574     if [[ -n ${rel_paths} ]] ; then
575 vapier 1.419 echo
576     eerror "Rejected Patch: ${patchname} !"
577     eerror " ( ${PATCH_TARGET} )"
578     eerror
579     eerror "Your patch uses relative paths '../':"
580     eerror "${rel_paths}"
581     echo
582     die "you need to fix the relative paths in patch"
583 vapier 1.353 fi
584 vapier 1.325
585     # Dynamically detect the correct -p# ... i'm lazy, so shoot me :/
586 vapier 1.383 local patch_cmd
587 vapier 1.325 while [[ ${count} -lt 5 ]] ; do
588 vapier 1.417 patch_cmd="${patch} -p${count} ${EPATCH_OPTS}"
589 vapier 1.383
590 vapier 1.325 # Generate some useful debug info ...
591     (
592     _epatch_draw_line "***** ${patchname} *****"
593     echo
594 vapier 1.383 echo "PATCH COMMAND: ${patch_cmd} < '${PATCH_TARGET}'"
595 vapier 1.325 echo
596     _epatch_draw_line "***** ${patchname} *****"
597 vapier 1.383 ${patch_cmd} --dry-run -f < "${PATCH_TARGET}" 2>&1
598 vapier 1.360 ret=$?
599     echo
600     echo "patch program exited with status ${ret}"
601     exit ${ret}
602 vapier 1.325 ) >> "${STDERR_TARGET}"
603 azarah 1.8
604 vapier 1.360 if [ $? -eq 0 ] ; then
605 vapier 1.325 (
606     _epatch_draw_line "***** ${patchname} *****"
607     echo
608     echo "ACTUALLY APPLYING ${patchname} ..."
609     echo
610     _epatch_draw_line "***** ${patchname} *****"
611 vapier 1.383 ${patch_cmd} < "${PATCH_TARGET}" 2>&1
612 vapier 1.360 ret=$?
613     echo
614     echo "patch program exited with status ${ret}"
615     exit ${ret}
616 vapier 1.325 ) >> "${STDERR_TARGET}"
617 danarmak 1.32
618 vapier 1.325 if [ $? -ne 0 ] ; then
619     echo
620     eerror "A dry-run of patch command succeeded, but actually"
621     eerror "applying the patch failed!"
622     #die "Real world sux compared to the dreamworld!"
623     count=5
624 azarah 1.2 fi
625 vapier 1.325 break
626 azarah 1.8 fi
627    
628 vapier 1.325 : $(( count++ ))
629     done
630 azarah 1.8
631 vapier 1.325 # if we had to decompress the patch, delete the temp one
632     if [[ -n ${PIPE_CMD} ]] ; then
633     rm -f "${PATCH_TARGET}"
634     fi
635 azarah 1.3
636 vapier 1.325 if [[ ${count} -ge 5 ]] ; then
637     echo
638     eerror "Failed Patch: ${patchname} !"
639     eerror " ( ${PATCH_TARGET} )"
640     eerror
641     eerror "Include in your bugreport the contents of:"
642     eerror
643     eerror " ${STDERR_TARGET}"
644     echo
645     die "Failed Patch: ${patchname}!"
646 azarah 1.2 fi
647 vapier 1.325
648 vapier 1.383 # if everything worked, delete the full debug patch log
649 vapier 1.325 rm -f "${STDERR_TARGET}"
650 vapier 1.383
651     # then log away the exact stuff for people to review later
652     cat <<-EOF >> "${T}/epatch.log"
653     PATCH: ${x}
654     CMD: ${patch_cmd}
655     PWD: ${PWD}
656    
657     EOF
658 vapier 1.325 eend 0
659 azarah 1.2 done
660 vapier 1.325
661     [[ ${SINGLE_PATCH} == "no" ]] && einfo "Done with patching"
662     : # everything worked
663 azarah 1.26 }
664 vapier 1.361
665     # @FUNCTION: epatch_user
666     # @USAGE:
667     # @DESCRIPTION:
668     # Applies user-provided patches to the source tree. The patches are
669 vapier 1.434 # taken from /etc/portage/patches/<CATEGORY>/<P-PR|P|PN>[:SLOT]/, where the first
670 vapier 1.361 # of these three directories to exist will be the one to use, ignoring
671 vapier 1.387 # any more general directories which might exist as well. They must end
672     # in ".patch" to be applied.
673 vapier 1.361 #
674     # User patches are intended for quick testing of patches without ebuild
675     # modifications, as well as for permanent customizations a user might
676     # desire. Obviously, there can be no official support for arbitrarily
677     # patched ebuilds. So whenever a build log in a bug report mentions that
678     # user patches were applied, the user should be asked to reproduce the
679     # problem without these.
680     #
681     # Not all ebuilds do call this function, so placing patches in the
682     # stated directory might or might not work, depending on the package and
683     # the eclasses it inherits and uses. It is safe to call the function
684     # repeatedly, so it is always possible to add a call at the ebuild
685     # level. The first call is the time when the patches will be
686     # applied.
687     #
688     # Ideally, this function should be called after gentoo-specific patches
689     # have been applied, so that their code can be modified as well, but
690     # before calls to e.g. eautoreconf, as the user patches might affect
691     # autotool input files as well.
692 vapier 1.318 epatch_user() {
693     [[ $# -ne 0 ]] && die "epatch_user takes no options"
694    
695 vapier 1.361 # Allow multiple calls to this function; ignore all but the first
696 vapier 1.383 local applied="${T}/epatch_user.log"
697 vapier 1.361 [[ -e ${applied} ]] && return 2
698    
699 vapier 1.318 # don't clobber any EPATCH vars that the parent might want
700 zmedico 1.323 local EPATCH_SOURCE check base=${PORTAGE_CONFIGROOT%/}/etc/portage/patches
701 vapier 1.406 for check in ${CATEGORY}/{${P}-${PR},${P},${PN}}{,:${SLOT}}; do
702 vapier 1.318 EPATCH_SOURCE=${base}/${CTARGET}/${check}
703     [[ -r ${EPATCH_SOURCE} ]] || EPATCH_SOURCE=${base}/${CHOST}/${check}
704     [[ -r ${EPATCH_SOURCE} ]] || EPATCH_SOURCE=${base}/${check}
705     if [[ -d ${EPATCH_SOURCE} ]] ; then
706     EPATCH_SOURCE=${EPATCH_SOURCE} \
707     EPATCH_SUFFIX="patch" \
708     EPATCH_FORCE="yes" \
709     EPATCH_MULTI_MSG="Applying user patches from ${EPATCH_SOURCE} ..." \
710     epatch
711 vapier 1.361 echo "${EPATCH_SOURCE}" > "${applied}"
712 vapier 1.444 has epatch_user_death_notice ${EBUILD_DEATH_HOOKS} || EBUILD_DEATH_HOOKS+=" epatch_user_death_notice"
713 vapier 1.349 return 0
714 vapier 1.318 fi
715     done
716 vapier 1.361 echo "none" > "${applied}"
717 vapier 1.349 return 1
718 vapier 1.318 }
719 vapier 1.444 # @FUNCTION: epatch_user_death_notice
720     # @INTERNAL
721     # @DESCRIPTION:
722     # Include an explicit notice in the die message itself that user patches were
723     # applied to this build.
724     epatch_user_death_notice() {
725     ewarn "!!! User patches were applied to this build!"
726     }
727 azarah 1.26
728 vapier 1.283 # @FUNCTION: emktemp
729     # @USAGE: [temp dir]
730     # @DESCRIPTION:
731 vapier 1.52 # Cheap replacement for when debianutils (and thus mktemp)
732 vapier 1.283 # does not exist on the users system.
733 vapier 1.117 emktemp() {
734 vapier 1.119 local exe="touch"
735 vapier 1.194 [[ $1 == -d ]] && exe="mkdir" && shift
736     local topdir=$1
737 mr_bones_ 1.100
738 vapier 1.194 if [[ -z ${topdir} ]] ; then
739     [[ -z ${T} ]] \
740 vapier 1.117 && topdir="/tmp" \
741 vapier 1.194 || topdir=${T}
742 vapier 1.117 fi
743    
744 vapier 1.280 if ! type -P mktemp > /dev/null ; then
745     # system lacks `mktemp` so we have to fake it
746 vapier 1.117 local tmp=/
747 vapier 1.194 while [[ -e ${tmp} ]] ; do
748     tmp=${topdir}/tmp.${RANDOM}.${RANDOM}.${RANDOM}
749 vapier 1.117 done
750 vapier 1.194 ${exe} "${tmp}" || ${exe} -p "${tmp}"
751 vapier 1.117 echo "${tmp}"
752 vapier 1.52 else
753 vapier 1.280 # the args here will give slightly wierd names on BSD,
754     # but should produce a usable file on all userlands
755 flameeyes 1.223 if [[ ${exe} == "touch" ]] ; then
756 vapier 1.280 TMPDIR="${topdir}" mktemp -t tmp.XXXXXXXXXX
757 flameeyes 1.223 else
758 vapier 1.280 TMPDIR="${topdir}" mktemp -dt tmp.XXXXXXXXXX
759 flameeyes 1.223 fi
760 vapier 1.52 fi
761     }
762    
763 vapier 1.283 # @FUNCTION: edos2unix
764     # @USAGE: <file> [more files ...]
765     # @DESCRIPTION:
766     # A handy replacement for dos2unix, recode, fixdos, etc... This allows you
767     # to remove all of these text utilities from DEPEND variables because this
768     # is a script based solution. Just give it a list of files to convert and
769     # they will all be changed from the DOS CRLF format to the UNIX LF format.
770 vapier 1.24 edos2unix() {
771 vapier 1.366 [[ $# -eq 0 ]] && return 0
772     sed -i 's/\r$//' -- "$@" || die
773 vapier 1.39 }
774    
775 jlec 1.377 # @FUNCTION: make_desktop_entry
776     # @USAGE: make_desktop_entry(<command>, [name], [icon], [type], [fields])
777     # @DESCRIPTION:
778     # Make a .desktop file.
779     #
780     # @CODE
781     # binary: what command does the app run with ?
782     # name: the name that will show up in the menu
783 vapier 1.401 # icon: the icon to use in the menu entry
784 jlec 1.377 # this can be relative (to /usr/share/pixmaps) or
785     # a full path to an icon
786     # type: what kind of application is this?
787     # for categories:
788     # http://standards.freedesktop.org/menu-spec/latest/apa.html
789     # if unset, function tries to guess from package's category
790 vapier 1.341 # fields: extra fields to append to the desktop file; a printf string
791 jlec 1.377 # @CODE
792 vapier 1.39 make_desktop_entry() {
793 vapier 1.341 [[ -z $1 ]] && die "make_desktop_entry: You must specify the executable"
794 vapier 1.39
795 vapier 1.158 local exec=${1}
796     local name=${2:-${PN}}
797 wolf31o2 1.293 local icon=${3:-${PN}}
798 vapier 1.158 local type=${4}
799 vapier 1.341 local fields=${5}
800 vapier 1.158
801     if [[ -z ${type} ]] ; then
802     local catmaj=${CATEGORY%%-*}
803     local catmin=${CATEGORY##*-}
804     case ${catmaj} in
805     app)
806     case ${catmin} in
807 pacho 1.384 accessibility) type="Utility;Accessibility";;
808 vapier 1.338 admin) type=System;;
809     antivirus) type=System;;
810 pacho 1.384 arch) type="Utility;Archiving";;
811     backup) type="Utility;Archiving";;
812     cdr) type="AudioVideo;DiscBurning";;
813     dicts) type="Office;Dictionary";;
814 vapier 1.338 doc) type=Documentation;;
815 pacho 1.384 editors) type="Utility;TextEditor";;
816     emacs) type="Development;TextEditor";;
817     emulation) type="System;Emulator";;
818     laptop) type="Settings;HardwareSettings";;
819 vapier 1.338 office) type=Office;;
820 pacho 1.384 pda) type="Office;PDA";;
821     vim) type="Development;TextEditor";;
822     xemacs) type="Development;TextEditor";;
823 vapier 1.158 esac
824 azarah 1.59 ;;
825 vapier 1.158
826     dev)
827 vapier 1.159 type="Development"
828 vapier 1.158 ;;
829    
830     games)
831     case ${catmin} in
832 wolf31o2 1.265 action|fps) type=ActionGame;;
833 vapier 1.338 arcade) type=ArcadeGame;;
834     board) type=BoardGame;;
835     emulation) type=Emulator;;
836     kids) type=KidsGame;;
837     puzzle) type=LogicGame;;
838     roguelike) type=RolePlaying;;
839     rpg) type=RolePlaying;;
840 vapier 1.158 simulation) type=Simulation;;
841 vapier 1.338 sports) type=SportsGame;;
842     strategy) type=StrategyGame;;
843 vapier 1.158 esac
844 vapier 1.159 type="Game;${type}"
845 vapier 1.158 ;;
846    
847 vapier 1.284 gnome)
848     type="Gnome;GTK"
849     ;;
850    
851     kde)
852     type="KDE;Qt"
853     ;;
854    
855 vapier 1.158 mail)
856 vapier 1.159 type="Network;Email"
857 vapier 1.158 ;;
858    
859     media)
860     case ${catmin} in
861 vapier 1.339 gfx)
862     type=Graphics
863     ;;
864     *)
865     case ${catmin} in
866     radio) type=Tuner;;
867     sound) type=Audio;;
868     tv) type=TV;;
869     video) type=Video;;
870     esac
871     type="AudioVideo;${type}"
872     ;;
873 vapier 1.158 esac
874 wolf31o2 1.65 ;;
875 vapier 1.158
876     net)
877     case ${catmin} in
878     dialup) type=Dialup;;
879 vapier 1.338 ftp) type=FileTransfer;;
880     im) type=InstantMessaging;;
881     irc) type=IRCClient;;
882     mail) type=Email;;
883     news) type=News;;
884     nntp) type=News;;
885     p2p) type=FileTransfer;;
886     voip) type=Telephony;;
887 vapier 1.158 esac
888 vapier 1.159 type="Network;${type}"
889 vapier 1.158 ;;
890    
891     sci)
892     case ${catmin} in
893 vapier 1.284 astro*) type=Astronomy;;
894 vapier 1.338 bio*) type=Biology;;
895     calc*) type=Calculator;;
896     chem*) type=Chemistry;;
897 vapier 1.284 elec*) type=Electronics;;
898 vapier 1.338 geo*) type=Geology;;
899     math*) type=Math;;
900 vapier 1.284 physics) type=Physics;;
901     visual*) type=DataVisualization;;
902 vapier 1.159 esac
903 abcd 1.336 type="Education;Science;${type}"
904 vapier 1.158 ;;
905    
906 vapier 1.284 sys)
907     type="System"
908     ;;
909    
910 vapier 1.158 www)
911     case ${catmin} in
912     client) type=WebBrowser;;
913     esac
914 abcd 1.336 type="Network;${type}"
915 azarah 1.59 ;;
916 vapier 1.158
917 azarah 1.59 *)
918     type=
919     ;;
920 vapier 1.39 esac
921     fi
922 vapier 1.440 local slot=${SLOT%/*}
923     if [[ ${slot} == "0" ]] ; then
924 carlo 1.177 local desktop_name="${PN}"
925     else
926 vapier 1.440 local desktop_name="${PN}-${slot}"
927 carlo 1.177 fi
928 vapier 1.272 local desktop="${T}/$(echo ${exec} | sed 's:[[:space:]/:]:_:g')-${desktop_name}.desktop"
929 vapier 1.271 #local desktop=${T}/${exec%% *:-${desktop_name}}.desktop
930 vapier 1.39
931 abcd 1.336 # Don't append another ";" when a valid category value is provided.
932     type=${type%;}${type:+;}
933    
934     eshopts_push -s extglob
935     if [[ -n ${icon} && ${icon} != /* ]] && [[ ${icon} == *.xpm || ${icon} == *.png || ${icon} == *.svg ]]; then
936     ewarn "As described in the Icon Theme Specification, icon file extensions are not"
937     ewarn "allowed in .desktop files if the value is not an absolute path."
938     icon=${icon%.@(xpm|png|svg)}
939     fi
940     eshopts_pop
941    
942 vapier 1.271 cat <<-EOF > "${desktop}"
943     [Desktop Entry]
944     Name=${name}
945     Type=Application
946     Comment=${DESCRIPTION}
947     Exec=${exec}
948     TryExec=${exec%% *}
949     Icon=${icon}
950 abcd 1.336 Categories=${type}
951 vapier 1.271 EOF
952 vapier 1.39
953 vapier 1.341 if [[ ${fields:-=} != *=* ]] ; then
954     # 5th arg used to be value to Path=
955     ewarn "make_desktop_entry: update your 5th arg to read Path=${fields}"
956     fields="Path=${fields}"
957     fi
958 vapier 1.342 [[ -n ${fields} ]] && printf '%b\n' "${fields}" >> "${desktop}"
959 wolf31o2 1.293
960 vapier 1.204 (
961     # wrap the env here so that the 'insinto' call
962     # doesn't corrupt the env of the caller
963     insinto /usr/share/applications
964     doins "${desktop}"
965 vapier 1.340 ) || die "installing desktop file failed"
966 danarmak 1.32 }
967    
968 vapier 1.428 # @FUNCTION: _eutils_eprefix_init
969     # @INTERNAL
970     # @DESCRIPTION:
971 ulm 1.435 # Initialized prefix variables for EAPI<3.
972 vapier 1.428 _eutils_eprefix_init() {
973     has "${EAPI:-0}" 0 1 2 && : ${ED:=${D}} ${EPREFIX:=} ${EROOT:=${ROOT}}
974     }
975    
976 vapier 1.283 # @FUNCTION: validate_desktop_entries
977     # @USAGE: [directories]
978     # @MAINTAINER:
979     # Carsten Lohrke <carlo@gentoo.org>
980     # @DESCRIPTION:
981 carlo 1.278 # Validate desktop entries using desktop-file-utils
982 carlo 1.277 validate_desktop_entries() {
983 vapier 1.428 _eutils_eprefix_init
984     if [[ -x "${EPREFIX}"/usr/bin/desktop-file-validate ]] ; then
985 carlo 1.277 einfo "Checking desktop entry validity"
986     local directories=""
987 carlo 1.279 for d in /usr/share/applications $@ ; do
988 vapier 1.428 [[ -d ${ED}${d} ]] && directories="${directories} ${ED}${d}"
989 carlo 1.277 done
990 carlo 1.279 if [[ -n ${directories} ]] ; then
991     for FILE in $(find ${directories} -name "*\.desktop" \
992     -not -path '*.hidden*' | sort -u 2>/dev/null)
993     do
994     local temp=$(desktop-file-validate ${FILE} | grep -v "warning:" | \
995     sed -e "s|error: ||" -e "s|${FILE}:|--|g" )
996 vapier 1.428 [[ -n $temp ]] && elog ${temp/--/${FILE/${ED}/}:}
997 carlo 1.279 done
998     fi
999 carlo 1.277 echo ""
1000     else
1001     einfo "Passing desktop entry validity check. Install dev-util/desktop-file-utils, if you want to help to improve Gentoo."
1002     fi
1003     }
1004    
1005 vapier 1.283 # @FUNCTION: make_session_desktop
1006 vapier 1.314 # @USAGE: <title> <command> [command args...]
1007 vapier 1.283 # @DESCRIPTION:
1008     # Make a GDM/KDM Session file. The title is the file to execute to start the
1009     # Window Manager. The command is the name of the Window Manager.
1010 vapier 1.314 #
1011     # You can set the name of the file via the ${wm} variable.
1012 lanius 1.133 make_session_desktop() {
1013 vapier 1.314 [[ -z $1 ]] && eerror "$0: You must specify the title" && return 1
1014     [[ -z $2 ]] && eerror "$0: You must specify the command" && return 1
1015 lanius 1.133
1016 vapier 1.167 local title=$1
1017     local command=$2
1018 vapier 1.314 local desktop=${T}/${wm:-${PN}}.desktop
1019     shift 2
1020 lanius 1.133
1021 vapier 1.271 cat <<-EOF > "${desktop}"
1022     [Desktop Entry]
1023     Name=${title}
1024     Comment=This session logs you into ${title}
1025 vapier 1.314 Exec=${command} $*
1026 vapier 1.271 TryExec=${command}
1027 vapier 1.314 Type=XSession
1028 vapier 1.271 EOF
1029 lanius 1.133
1030 vapier 1.271 (
1031     # wrap the env here so that the 'insinto' call
1032     # doesn't corrupt the env of the caller
1033 lanius 1.133 insinto /usr/share/xsessions
1034     doins "${desktop}"
1035 vapier 1.271 )
1036 lanius 1.133 }
1037    
1038 vapier 1.283 # @FUNCTION: domenu
1039     # @USAGE: <menus>
1040     # @DESCRIPTION:
1041     # Install the list of .desktop menu files into the appropriate directory
1042     # (/usr/share/applications).
1043 lanius 1.133 domenu() {
1044 vapier 1.271 (
1045     # wrap the env here so that the 'insinto' call
1046     # doesn't corrupt the env of the caller
1047     local i j ret=0
1048 lanius 1.133 insinto /usr/share/applications
1049 vapier 1.167 for i in "$@" ; do
1050     if [[ -f ${i} ]] ; then
1051     doins "${i}"
1052 vapier 1.271 ((ret+=$?))
1053 vapier 1.167 elif [[ -d ${i} ]] ; then
1054     for j in "${i}"/*.desktop ; do
1055     doins "${j}"
1056 vapier 1.271 ((ret+=$?))
1057 lanius 1.133 done
1058 vapier 1.285 else
1059     ((++ret))
1060 swegener 1.190 fi
1061 lanius 1.133 done
1062 vapier 1.271 exit ${ret}
1063     )
1064 lanius 1.133 }
1065 vapier 1.283
1066     # @FUNCTION: newmenu
1067     # @USAGE: <menu> <newname>
1068     # @DESCRIPTION:
1069     # Like all other new* functions, install the specified menu as newname.
1070 vapier 1.167 newmenu() {
1071 vapier 1.271 (
1072     # wrap the env here so that the 'insinto' call
1073     # doesn't corrupt the env of the caller
1074 vapier 1.167 insinto /usr/share/applications
1075 vapier 1.271 newins "$@"
1076     )
1077 vapier 1.167 }
1078 lanius 1.133
1079 hasufell 1.394 # @FUNCTION: _iconins
1080     # @INTERNAL
1081 vapier 1.283 # @DESCRIPTION:
1082 hasufell 1.394 # function for use in doicon and newicon
1083     _iconins() {
1084 vapier 1.271 (
1085     # wrap the env here so that the 'insinto' call
1086     # doesn't corrupt the env of the caller
1087 hasufell 1.394 local funcname=$1; shift
1088     local size dir
1089     local context=apps
1090     local theme=hicolor
1091    
1092     while [[ $# -gt 0 ]] ; do
1093     case $1 in
1094     -s|--size)
1095     if [[ ${2%%x*}x${2%%x*} == "$2" ]] ; then
1096     size=${2%%x*}
1097     else
1098     size=${2}
1099     fi
1100     case ${size} in
1101 williamh 1.441 16|22|24|32|36|48|64|72|96|128|192|256|512)
1102 hasufell 1.394 size=${size}x${size};;
1103     scalable)
1104     ;;
1105     *)
1106     eerror "${size} is an unsupported icon size!"
1107     exit 1;;
1108     esac
1109     shift 2;;
1110     -t|--theme)
1111     theme=${2}
1112     shift 2;;
1113     -c|--context)
1114     context=${2}
1115     shift 2;;
1116     *)
1117     if [[ -z ${size} ]] ; then
1118     insinto /usr/share/pixmaps
1119     else
1120     insinto /usr/share/icons/${theme}/${size}/${context}
1121     fi
1122    
1123     if [[ ${funcname} == doicon ]] ; then
1124     if [[ -f $1 ]] ; then
1125     doins "${1}"
1126     elif [[ -d $1 ]] ; then
1127     shopt -s nullglob
1128     doins "${1}"/*.{png,svg}
1129     shopt -u nullglob
1130     else
1131     eerror "${1} is not a valid file/directory!"
1132     exit 1
1133     fi
1134     else
1135     break
1136     fi
1137     shift 1;;
1138     esac
1139 lanius 1.133 done
1140 hasufell 1.394 if [[ ${funcname} == newicon ]] ; then
1141     newins "$@"
1142     fi
1143     ) || die
1144     }
1145    
1146     # @FUNCTION: doicon
1147     # @USAGE: [options] <icons>
1148     # @DESCRIPTION:
1149     # Install icon into the icon directory /usr/share/icons or into
1150     # /usr/share/pixmaps if "--size" is not set.
1151     # This is useful in conjunction with creating desktop/menu files.
1152     #
1153     # @CODE
1154     # options:
1155     # -s, --size
1156     # !!! must specify to install into /usr/share/icons/... !!!
1157     # size of the icon, like 48 or 48x48
1158     # supported icon sizes are:
1159     # 16 22 24 32 36 48 64 72 96 128 192 256 scalable
1160     # -c, --context
1161     # defaults to "apps"
1162     # -t, --theme
1163     # defaults to "hicolor"
1164     #
1165     # icons: list of icons
1166     #
1167 hasufell 1.398 # example 1: doicon foobar.png fuqbar.svg suckbar.png
1168 hasufell 1.394 # results in: insinto /usr/share/pixmaps
1169 hasufell 1.398 # doins foobar.png fuqbar.svg suckbar.png
1170 hasufell 1.394 #
1171 ssuominen 1.399 # example 2: doicon -s 48 foobar.png fuqbar.png blobbar.png
1172 hasufell 1.394 # results in: insinto /usr/share/icons/hicolor/48x48/apps
1173 ssuominen 1.399 # doins foobar.png fuqbar.png blobbar.png
1174 hasufell 1.394 # @CODE
1175     doicon() {
1176     _iconins ${FUNCNAME} "$@"
1177 lanius 1.133 }
1178 vapier 1.283
1179     # @FUNCTION: newicon
1180 hasufell 1.394 # @USAGE: [options] <icon> <newname>
1181 vapier 1.283 # @DESCRIPTION:
1182 hasufell 1.394 # Like doicon, install the specified icon as newname.
1183     #
1184     # @CODE
1185     # example 1: newicon foobar.png NEWNAME.png
1186     # results in: insinto /usr/share/pixmaps
1187     # newins foobar.png NEWNAME.png
1188     #
1189 ulm 1.435 # example 2: newicon -s 48 foobar.png NEWNAME.png
1190 hasufell 1.394 # results in: insinto /usr/share/icons/hicolor/48x48/apps
1191     # newins foobar.png NEWNAME.png
1192     # @CODE
1193 vapier 1.167 newicon() {
1194 hasufell 1.394 _iconins ${FUNCNAME} "$@"
1195 vapier 1.167 }
1196 lanius 1.133
1197 vapier 1.287 # @FUNCTION: strip-linguas
1198     # @USAGE: [<allow LINGUAS>|<-i|-u> <directories of .po files>]
1199     # @DESCRIPTION:
1200 mr_bones_ 1.100 # Make sure that LINGUAS only contains languages that
1201 vapier 1.287 # a package can support. The first form allows you to
1202     # specify a list of LINGUAS. The -i builds a list of po
1203     # files found in all the directories and uses the
1204     # intersection of the lists. The -u builds a list of po
1205     # files found in all the directories and uses the union
1206     # of the lists.
1207 vapier 1.92 strip-linguas() {
1208 vapier 1.242 local ls newls nols
1209 vapier 1.154 if [[ $1 == "-i" ]] || [[ $1 == "-u" ]] ; then
1210     local op=$1; shift
1211 vapier 1.315 ls=$(find "$1" -name '*.po' -exec basename {} .po ';'); shift
1212 vapier 1.92 local d f
1213     for d in "$@" ; do
1214 vapier 1.154 if [[ ${op} == "-u" ]] ; then
1215     newls=${ls}
1216 vapier 1.92 else
1217     newls=""
1218     fi
1219 vapier 1.315 for f in $(find "$d" -name '*.po' -exec basename {} .po ';') ; do
1220 vapier 1.154 if [[ ${op} == "-i" ]] ; then
1221 ssuominen 1.358 has ${f} ${ls} && newls="${newls} ${f}"
1222 vapier 1.92 else
1223 ssuominen 1.358 has ${f} ${ls} || newls="${newls} ${f}"
1224 vapier 1.92 fi
1225     done
1226 vapier 1.154 ls=${newls}
1227 vapier 1.92 done
1228     else
1229 vapier 1.236 ls="$@"
1230 vapier 1.92 fi
1231    
1232 vapier 1.242 nols=""
1233 vapier 1.92 newls=""
1234     for f in ${LINGUAS} ; do
1235 ssuominen 1.358 if has ${f} ${ls} ; then
1236 vapier 1.120 newls="${newls} ${f}"
1237 vapier 1.92 else
1238 vapier 1.242 nols="${nols} ${f}"
1239 vapier 1.92 fi
1240     done
1241 vapier 1.244 [[ -n ${nols} ]] \
1242 pacho 1.388 && einfo "Sorry, but ${PN} does not support the LINGUAS:" ${nols}
1243 vapier 1.237 export LINGUAS=${newls:1}
1244 vapier 1.92 }
1245 iggy 1.110
1246 vapier 1.283 # @FUNCTION: preserve_old_lib
1247     # @USAGE: <libs to preserve> [more libs]
1248     # @DESCRIPTION:
1249     # These functions are useful when a lib in your package changes ABI SONAME.
1250     # An example might be from libogg.so.0 to libogg.so.1. Removing libogg.so.0
1251 eradicator 1.111 # would break packages that link against it. Most people get around this
1252     # by using the portage SLOT mechanism, but that is not always a relevant
1253 vapier 1.283 # solution, so instead you can call this from pkg_preinst. See also the
1254     # preserve_old_lib_notify function.
1255 eradicator 1.111 preserve_old_lib() {
1256 vapier 1.428 _eutils_eprefix_init
1257 vapier 1.268 if [[ ${EBUILD_PHASE} != "preinst" ]] ; then
1258 vapier 1.267 eerror "preserve_old_lib() must be called from pkg_preinst() only"
1259 vapier 1.276 die "Invalid preserve_old_lib() usage"
1260 vapier 1.267 fi
1261     [[ -z $1 ]] && die "Usage: preserve_old_lib <library to preserve> [more libraries to preserve]"
1262    
1263 vapier 1.297 # let portage worry about it
1264     has preserve-libs ${FEATURES} && return 0
1265    
1266 vapier 1.267 local lib dir
1267     for lib in "$@" ; do
1268 vapier 1.428 [[ -e ${EROOT}/${lib} ]] || continue
1269 vapier 1.267 dir=${lib%/*}
1270     dodir ${dir} || die "dodir ${dir} failed"
1271 vapier 1.428 cp "${EROOT}"/${lib} "${ED}"/${lib} || die "cp ${lib} failed"
1272     touch "${ED}"/${lib}
1273 vapier 1.267 done
1274 eradicator 1.111 }
1275    
1276 vapier 1.283 # @FUNCTION: preserve_old_lib_notify
1277     # @USAGE: <libs to notify> [more libs]
1278     # @DESCRIPTION:
1279     # Spit helpful messages about the libraries preserved by preserve_old_lib.
1280 eradicator 1.111 preserve_old_lib_notify() {
1281 vapier 1.268 if [[ ${EBUILD_PHASE} != "postinst" ]] ; then
1282 vapier 1.267 eerror "preserve_old_lib_notify() must be called from pkg_postinst() only"
1283 vapier 1.276 die "Invalid preserve_old_lib_notify() usage"
1284 vapier 1.267 fi
1285    
1286 vapier 1.297 # let portage worry about it
1287     has preserve-libs ${FEATURES} && return 0
1288    
1289 vapier 1.428 _eutils_eprefix_init
1290 ulm 1.435
1291 vapier 1.267 local lib notice=0
1292     for lib in "$@" ; do
1293 vapier 1.428 [[ -e ${EROOT}/${lib} ]] || continue
1294 vapier 1.267 if [[ ${notice} -eq 0 ]] ; then
1295     notice=1
1296     ewarn "Old versions of installed libraries were detected on your system."
1297     ewarn "In order to avoid breaking packages that depend on these old libs,"
1298     ewarn "the libraries are not being removed. You need to run revdep-rebuild"
1299     ewarn "in order to remove these old dependencies. If you do not have this"
1300     ewarn "helper program, simply emerge the 'gentoolkit' package."
1301     ewarn
1302     fi
1303 phajdan.jr 1.393 ewarn " # revdep-rebuild --library '${lib}' && rm '${lib}'"
1304 vapier 1.267 done
1305 eradicator 1.111 }
1306 vapier 1.125
1307 vapier 1.283 # @FUNCTION: built_with_use
1308     # @USAGE: [--hidden] [--missing <action>] [-a|-o] <DEPEND ATOM> <List of USE flags>
1309     # @DESCRIPTION:
1310 betelgeuse 1.329 #
1311     # Deprecated: Use EAPI 2 use deps in DEPEND|RDEPEND and with has_version calls.
1312     #
1313 vapier 1.283 # A temporary hack until portage properly supports DEPENDing on USE
1314     # flags being enabled in packages. This will check to see if the specified
1315     # DEPEND atom was built with the specified list of USE flags. The
1316     # --missing option controls the behavior if called on a package that does
1317     # not actually support the defined USE flags (aka listed in IUSE).
1318     # The default is to abort (call die). The -a and -o flags control
1319     # the requirements of the USE flags. They correspond to "and" and "or"
1320     # logic. So the -a flag means all listed USE flags must be enabled
1321 opfer 1.302 # while the -o flag means at least one of the listed IUSE flags must be
1322 vapier 1.283 # enabled. The --hidden option is really for internal use only as it
1323     # means the USE flag we're checking is hidden expanded, so it won't be found
1324     # in IUSE like normal USE flags.
1325 swegener 1.286 #
1326 vapier 1.283 # Remember that this function isn't terribly intelligent so order of optional
1327     # flags matter.
1328 vapier 1.125 built_with_use() {
1329 vapier 1.428 _eutils_eprefix_init
1330 vapier 1.275 local hidden="no"
1331     if [[ $1 == "--hidden" ]] ; then
1332     hidden="yes"
1333     shift
1334     fi
1335    
1336 vapier 1.269 local missing_action="die"
1337     if [[ $1 == "--missing" ]] ; then
1338     missing_action=$2
1339     shift ; shift
1340     case ${missing_action} in
1341     true|false|die) ;;
1342     *) die "unknown action '${missing_action}'";;
1343     esac
1344     fi
1345    
1346 vapier 1.130 local opt=$1
1347     [[ ${opt:0:1} = "-" ]] && shift || opt="-a"
1348    
1349     local PKG=$(best_version $1)
1350 vapier 1.247 [[ -z ${PKG} ]] && die "Unable to resolve $1 to an installed package"
1351 vapier 1.130 shift
1352    
1353 vapier 1.428 local USEFILE=${EROOT}/var/db/pkg/${PKG}/USE
1354     local IUSEFILE=${EROOT}/var/db/pkg/${PKG}/IUSE
1355 vapier 1.213
1356 cardoe 1.273 # if the IUSE file doesn't exist, the read will error out, we need to handle
1357     # this gracefully
1358 vapier 1.275 if [[ ! -e ${USEFILE} ]] || [[ ! -e ${IUSEFILE} && ${hidden} == "no" ]] ; then
1359 cardoe 1.273 case ${missing_action} in
1360     true) return 0;;
1361     false) return 1;;
1362     die) die "Unable to determine what USE flags $PKG was built with";;
1363     esac
1364     fi
1365    
1366 vapier 1.275 if [[ ${hidden} == "no" ]] ; then
1367 zmedico 1.301 local IUSE_BUILT=( $(<"${IUSEFILE}") )
1368 vapier 1.275 # Don't check USE_EXPAND #147237
1369     local expand
1370     for expand in $(echo ${USE_EXPAND} | tr '[:upper:]' '[:lower:]') ; do
1371     if [[ $1 == ${expand}_* ]] ; then
1372     expand=""
1373     break
1374     fi
1375     done
1376     if [[ -n ${expand} ]] ; then
1377 zmedico 1.301 if ! has $1 ${IUSE_BUILT[@]#[-+]} ; then
1378 vapier 1.275 case ${missing_action} in
1379     true) return 0;;
1380     false) return 1;;
1381     die) die "$PKG does not actually support the $1 USE flag!";;
1382     esac
1383     fi
1384 vapier 1.269 fi
1385 vapier 1.250 fi
1386 vapier 1.249
1387 vapier 1.125 local USE_BUILT=$(<${USEFILE})
1388 vapier 1.130 while [[ $# -gt 0 ]] ; do
1389     if [[ ${opt} = "-o" ]] ; then
1390     has $1 ${USE_BUILT} && return 0
1391     else
1392     has $1 ${USE_BUILT} || return 1
1393     fi
1394 vapier 1.125 shift
1395     done
1396 vapier 1.130 [[ ${opt} = "-a" ]]
1397 vapier 1.125 }
1398 vapier 1.126
1399 vapier 1.289 # @FUNCTION: epunt_cxx
1400 vapier 1.283 # @USAGE: [dir to scan]
1401     # @DESCRIPTION:
1402     # Many configure scripts wrongly bail when a C++ compiler could not be
1403     # detected. If dir is not specified, then it defaults to ${S}.
1404     #
1405     # http://bugs.gentoo.org/73450
1406 vapier 1.126 epunt_cxx() {
1407 vapier 1.127 local dir=$1
1408     [[ -z ${dir} ]] && dir=${S}
1409     ebegin "Removing useless C++ checks"
1410 vapier 1.415 local f p any_found
1411 mgorny 1.412 while IFS= read -r -d '' f; do
1412 vapier 1.415 for p in "${PORTDIR}"/eclass/ELT-patches/nocxx/*.patch ; do
1413     if patch --no-backup-if-mismatch -p1 "${f}" "${p}" >/dev/null ; then
1414     any_found=1
1415     break
1416     fi
1417     done
1418 mgorny 1.412 done < <(find "${dir}" -name configure -print0)
1419 mgorny 1.410
1420 vapier 1.415 if [[ -z ${any_found} ]]; then
1421     eqawarn "epunt_cxx called unnecessarily (no C++ checks to punt)."
1422     fi
1423 vapier 1.127 eend 0
1424 vapier 1.126 }
1425 ka0ttic 1.143
1426 vapier 1.283 # @FUNCTION: make_wrapper
1427 wolf31o2 1.295 # @USAGE: <wrapper> <target> [chdir] [libpaths] [installpath]
1428 vapier 1.283 # @DESCRIPTION:
1429     # Create a shell wrapper script named wrapper in installpath
1430     # (defaults to the bindir) to execute target (default of wrapper) by
1431     # first optionally setting LD_LIBRARY_PATH to the colon-delimited
1432     # libpaths followed by optionally changing directory to chdir.
1433 wolf31o2 1.160 make_wrapper() {
1434 vapier 1.428 _eutils_eprefix_init
1435 wolf31o2 1.164 local wrapper=$1 bin=$2 chdir=$3 libdir=$4 path=$5
1436 wolf31o2 1.160 local tmpwrapper=$(emktemp)
1437 vapier 1.414
1438     (
1439     echo '#!/bin/sh'
1440 vapier 1.428 [[ -n ${chdir} ]] && printf 'cd "%s"\n' "${EPREFIX}${chdir}"
1441 vapier 1.414 if [[ -n ${libdir} ]] ; then
1442 vapier 1.428 local var
1443     if [[ ${CHOST} == *-darwin* ]] ; then
1444     var=DYLD_LIBRARY_PATH
1445     else
1446     var=LD_LIBRARY_PATH
1447     fi
1448 vapier 1.414 cat <<-EOF
1449 vapier 1.428 if [ "\${${var}+set}" = "set" ] ; then
1450     export ${var}="\${${var}}:${EPREFIX}${libdir}"
1451 vapier 1.414 else
1452 vapier 1.428 export ${var}="${EPREFIX}${libdir}"
1453 vapier 1.414 fi
1454     EOF
1455     fi
1456 vapier 1.202 # We don't want to quote ${bin} so that people can pass complex
1457 vapier 1.414 # things as ${bin} ... "./someprog --args"
1458 vapier 1.439 printf 'exec %s "$@"\n' "${bin/#\//${EPREFIX}/}"
1459 vapier 1.414 ) > "${tmpwrapper}"
1460 wolf31o2 1.160 chmod go+rx "${tmpwrapper}"
1461 vapier 1.414
1462 vapier 1.201 if [[ -n ${path} ]] ; then
1463 vapier 1.283 (
1464 vapier 1.201 exeinto "${path}"
1465 wolf31o2 1.164 newexe "${tmpwrapper}" "${wrapper}"
1466 vapier 1.283 ) || die
1467 wolf31o2 1.164 else
1468 vapier 1.283 newbin "${tmpwrapper}" "${wrapper}" || die
1469 wolf31o2 1.164 fi
1470 wolf31o2 1.160 }
1471 mr_bones_ 1.311
1472 vapier 1.351 # @FUNCTION: path_exists
1473     # @USAGE: [-a|-o] <paths>
1474     # @DESCRIPTION:
1475     # Check if the specified paths exist. Works for all types of paths
1476     # (files/dirs/etc...). The -a and -o flags control the requirements
1477     # of the paths. They correspond to "and" and "or" logic. So the -a
1478     # flag means all the paths must exist while the -o flag means at least
1479     # one of the paths must exist. The default behavior is "and". If no
1480     # paths are specified, then the return value is "false".
1481     path_exists() {
1482     local opt=$1
1483     [[ ${opt} == -[ao] ]] && shift || opt="-a"
1484    
1485     # no paths -> return false
1486     # same behavior as: [[ -e "" ]]
1487     [[ $# -eq 0 ]] && return 1
1488    
1489     local p r=0
1490     for p in "$@" ; do
1491     [[ -e ${p} ]]
1492     : $(( r += $? ))
1493     done
1494    
1495     case ${opt} in
1496     -a) return $(( r != 0 )) ;;
1497     -o) return $(( r == $# )) ;;
1498     esac
1499     }
1500 mgorny 1.364
1501     # @FUNCTION: in_iuse
1502     # @USAGE: <flag>
1503     # @DESCRIPTION:
1504     # Determines whether the given flag is in IUSE. Strips IUSE default prefixes
1505     # as necessary.
1506     #
1507     # Note that this function should not be used in the global scope.
1508     in_iuse() {
1509     debug-print-function ${FUNCNAME} "${@}"
1510     [[ ${#} -eq 1 ]] || die "Invalid args to ${FUNCNAME}()"
1511    
1512     local flag=${1}
1513     local liuse=( ${IUSE} )
1514    
1515     has "${flag}" "${liuse[@]#[+-]}"
1516     }
1517 vapier 1.365
1518 vapier 1.367 # @FUNCTION: use_if_iuse
1519     # @USAGE: <flag>
1520     # @DESCRIPTION:
1521     # Return true if the given flag is in USE and IUSE.
1522     #
1523     # Note that this function should not be used in the global scope.
1524     use_if_iuse() {
1525     in_iuse $1 || return 1
1526     use $1
1527     }
1528    
1529 vapier 1.365 # @FUNCTION: usex
1530     # @USAGE: <USE flag> [true output] [false output] [true suffix] [false suffix]
1531     # @DESCRIPTION:
1532 axs 1.404 # Proxy to declare usex for package managers or EAPIs that do not provide it
1533     # and use the package manager implementation when available (i.e. EAPI >= 5).
1534 vapier 1.365 # If USE flag is set, echo [true output][true suffix] (defaults to "yes"),
1535     # otherwise echo [false output][false suffix] (defaults to "no").
1536 ulm 1.405 if has "${EAPI:-0}" 0 1 2 3 4; then
1537 axs 1.404 usex() { use "$1" && echo "${2-yes}$4" || echo "${3-no}$5" ; } #382963
1538     fi
1539 vapier 1.371
1540 mgorny 1.395 # @FUNCTION: prune_libtool_files
1541 mgorny 1.408 # @USAGE: [--all|--modules]
1542 mgorny 1.395 # @DESCRIPTION:
1543     # Locate unnecessary libtool files (.la) and libtool static archives
1544     # (.a) and remove them from installation image.
1545     #
1546     # By default, .la files are removed whenever the static linkage can
1547     # either be performed using pkg-config or doesn't introduce additional
1548     # flags.
1549     #
1550 mgorny 1.408 # If '--modules' argument is passed, .la files for modules (plugins) are
1551     # removed as well. This is usually useful when the package installs
1552     # plugins and the plugin loader does not use .la files.
1553     #
1554     # If '--all' argument is passed, all .la files are removed without
1555     # performing any heuristic on them. You shouldn't ever use that,
1556     # and instead report a bug in the algorithm instead.
1557 mgorny 1.395 #
1558     # The .a files are only removed whenever corresponding .la files state
1559     # that they should not be linked to, i.e. whenever these files
1560     # correspond to plugins.
1561     #
1562 mgorny 1.411 # Note: if your package installs both static libraries and .pc files
1563     # which use variable substitution for -l flags, you need to add
1564     # pkg-config to your DEPEND.
1565 mgorny 1.395 prune_libtool_files() {
1566     debug-print-function ${FUNCNAME} "$@"
1567    
1568 mgorny 1.408 local removing_all removing_modules opt
1569 vapier 1.428 _eutils_eprefix_init
1570 mgorny 1.395 for opt; do
1571     case "${opt}" in
1572     --all)
1573     removing_all=1
1574 mgorny 1.408 removing_modules=1
1575     ;;
1576     --modules)
1577     removing_modules=1
1578 mgorny 1.395 ;;
1579     *)
1580     die "Invalid argument to ${FUNCNAME}(): ${opt}"
1581     esac
1582     done
1583    
1584     local f
1585 mgorny 1.407 local queue=()
1586 mgorny 1.395 while IFS= read -r -d '' f; do # for all .la files
1587     local archivefile=${f/%.la/.a}
1588    
1589 mgorny 1.420 # The following check is done by libtool itself.
1590     # It helps us avoid removing random files which match '*.la',
1591     # see bug #468380.
1592 mgorny 1.421 if ! sed -n -e '/^# Generated by .*libtool/q0;4q1' "${f}"; then
1593 mgorny 1.420 continue
1594     fi
1595    
1596 mgorny 1.395 [[ ${f} != ${archivefile} ]] || die 'regex sanity check failed'
1597 mgorny 1.442 local reason= pkgconfig_scanned=
1598 mgorny 1.418 local snotlink=$(sed -n -e 's:^shouldnotlink=::p' "${f}")
1599 mgorny 1.395
1600 mgorny 1.418 if [[ ${snotlink} == yes ]]; then
1601 mgorny 1.408
1602 mgorny 1.418 # Remove static libs we're not supposed to link against.
1603 mgorny 1.400 if [[ -f ${archivefile} ]]; then
1604     einfo "Removing unnecessary ${archivefile#${D%/}} (static plugin)"
1605 mgorny 1.407 queue+=( "${archivefile}" )
1606 mgorny 1.400 fi
1607 mgorny 1.395
1608     # The .la file may be used by a module loader, so avoid removing it
1609     # unless explicitly requested.
1610 mgorny 1.408 if [[ ${removing_modules} ]]; then
1611     reason='module'
1612     fi
1613 mgorny 1.395
1614 mgorny 1.420 else
1615 mgorny 1.418
1616     # Remove .la files when:
1617     # - user explicitly wants us to remove all .la files,
1618     # - respective static archive doesn't exist,
1619     # - they are covered by a .pc file already,
1620     # - they don't provide any new information (no libs & no flags).
1621    
1622     if [[ ${removing_all} ]]; then
1623     reason='requested'
1624     elif [[ ! -f ${archivefile} ]]; then
1625     reason='no static archive'
1626     elif [[ ! $(sed -nre \
1627     "s/^(dependency_libs|inherited_linker_flags)='(.*)'$/\2/p" \
1628     "${f}") ]]; then
1629     reason='no libs & flags'
1630     else
1631     if [[ ! ${pkgconfig_scanned} ]]; then
1632     # Create a list of all .pc-covered libs.
1633     local pc_libs=()
1634     if [[ ! ${removing_all} ]]; then
1635     local pc
1636     local tf=${T}/prune-lt-files.pc
1637     local pkgconf=$(tc-getPKG_CONFIG)
1638    
1639     while IFS= read -r -d '' pc; do # for all .pc files
1640     local arg libs
1641    
1642     # Use pkg-config if available (and works),
1643     # fallback to sed.
1644     if ${pkgconf} --exists "${pc}" &>/dev/null; then
1645     sed -e '/^Requires:/d' "${pc}" > "${tf}"
1646     libs=$(${pkgconf} --libs "${tf}")
1647     else
1648     libs=$(sed -ne 's/^Libs://p' "${pc}")
1649     fi
1650    
1651     for arg in ${libs}; do
1652     if [[ ${arg} == -l* ]]; then
1653     if [[ ${arg} == '*$*' ]]; then
1654     eqawarn "${FUNCNAME}: variable substitution likely failed in ${pc}"
1655     eqawarn "(arg: ${arg})"
1656     eqawarn "Most likely, you need to add virtual/pkgconfig to DEPEND."
1657     fi
1658    
1659     pc_libs+=( lib${arg#-l}.la )
1660 mgorny 1.411 fi
1661 mgorny 1.418 done
1662     done < <(find "${D}" -type f -name '*.pc' -print0)
1663 mgorny 1.411
1664 mgorny 1.418 rm -f "${tf}"
1665     fi
1666 mgorny 1.402
1667 mgorny 1.418 pkgconfig_scanned=1
1668     fi # pkgconfig_scanned
1669 mgorny 1.402
1670 mgorny 1.418 has "${f##*/}" "${pc_libs[@]}" && reason='covered by .pc'
1671     fi # removal due to .pc
1672 mgorny 1.402
1673 mgorny 1.418 fi # shouldnotlink==no
1674 mgorny 1.395
1675     if [[ ${reason} ]]; then
1676     einfo "Removing unnecessary ${f#${D%/}} (${reason})"
1677 mgorny 1.407 queue+=( "${f}" )
1678 mgorny 1.395 fi
1679 vapier 1.428 done < <(find "${ED}" -xtype f -name '*.la' -print0)
1680 mgorny 1.407
1681     if [[ ${queue[@]} ]]; then
1682     rm -f "${queue[@]}"
1683     fi
1684 mgorny 1.395 }
1685    
1686 mgorny 1.430 # @FUNCTION: einstalldocs
1687 mgorny 1.429 # @DESCRIPTION:
1688     # Install documentation using DOCS and HTML_DOCS.
1689     #
1690     # If DOCS is declared and non-empty, all files listed in it are
1691     # installed. The files must exist, otherwise the function will fail.
1692     # In EAPI 4 and subsequent EAPIs DOCS may specify directories as well,
1693     # in other EAPIs using directories is unsupported.
1694     #
1695     # If DOCS is not declared, the files matching patterns given
1696     # in the default EAPI implementation of src_install will be installed.
1697     # If this is undesired, DOCS can be set to empty value to prevent any
1698     # documentation from being installed.
1699     #
1700     # If HTML_DOCS is declared and non-empty, all files and/or directories
1701     # listed in it are installed as HTML docs (using dohtml).
1702     #
1703     # Both DOCS and HTML_DOCS can either be an array or a whitespace-
1704     # separated list. Whenever directories are allowed, '<directory>/.' may
1705     # be specified in order to install all files within the directory
1706     # without creating a sub-directory in docdir.
1707     #
1708     # Passing additional options to dodoc and dohtml is not supported.
1709     # If you needed such a thing, you need to call those helpers explicitly.
1710 mgorny 1.426 einstalldocs() {
1711     debug-print-function ${FUNCNAME} "${@}"
1712    
1713 mgorny 1.427 local dodoc_opts=-r
1714     has ${EAPI} 0 1 2 3 && dodoc_opts=
1715    
1716 mgorny 1.426 if ! declare -p DOCS &>/dev/null ; then
1717     local d
1718     for d in README* ChangeLog AUTHORS NEWS TODO CHANGES \
1719     THANKS BUGS FAQ CREDITS CHANGELOG ; do
1720 mgorny 1.427 if [[ -s ${d} ]] ; then
1721     dodoc "${d}" || die
1722     fi
1723 mgorny 1.426 done
1724     elif [[ $(declare -p DOCS) == "declare -a"* ]] ; then
1725 mgorny 1.427 if [[ ${DOCS[@]} ]] ; then
1726     dodoc ${dodoc_opts} "${DOCS[@]}" || die
1727     fi
1728 mgorny 1.426 else
1729 mgorny 1.427 if [[ ${DOCS} ]] ; then
1730     dodoc ${dodoc_opts} ${DOCS} || die
1731     fi
1732 mgorny 1.426 fi
1733    
1734     if [[ $(declare -p HTML_DOCS 2>/dev/null) == "declare -a"* ]] ; then
1735 mgorny 1.427 if [[ ${HTML_DOCS[@]} ]] ; then
1736     dohtml -r "${HTML_DOCS[@]}" || die
1737     fi
1738 mgorny 1.426 else
1739 mgorny 1.427 if [[ ${HTML_DOCS} ]] ; then
1740     dohtml -r ${HTML_DOCS} || die
1741     fi
1742 mgorny 1.426 fi
1743    
1744     return 0
1745     }
1746    
1747 vapier 1.372 check_license() { die "you no longer need this as portage supports ACCEPT_LICENSE itself"; }
1748    
1749 creffett 1.432 # @FUNCTION: optfeature
1750     # @USAGE: <short description> <package atom to match> [other atoms]
1751     # @DESCRIPTION:
1752     # Print out a message suggesting an optional package (or packages) which
1753     # provide the described functionality
1754     #
1755     # The following snippet would suggest app-misc/foo for optional foo support,
1756     # app-misc/bar or app-misc/baz[bar] for optional bar support
1757     # and either both app-misc/a and app-misc/b or app-misc/c for alphabet support.
1758 vapier 1.433 # @CODE
1759     # optfeature "foo support" app-misc/foo
1760     # optfeature "bar support" app-misc/bar app-misc/baz[bar]
1761     # optfeature "alphabet support" "app-misc/a app-misc/b" app-misc/c
1762     # @CODE
1763 creffett 1.432 optfeature() {
1764     debug-print-function ${FUNCNAME} "$@"
1765     local i j msg
1766     local desc=$1
1767     local flag=0
1768     shift
1769     for i; do
1770 vapier 1.433 for j in ${i}; do
1771     if has_version "${j}"; then
1772 creffett 1.432 flag=1
1773     else
1774     flag=0
1775     break
1776     fi
1777     done
1778 vapier 1.433 if [[ ${flag} -eq 1 ]]; then
1779 creffett 1.432 break
1780     fi
1781     done
1782 vapier 1.433 if [[ ${flag} -eq 0 ]]; then
1783 creffett 1.432 for i; do
1784     msg=" "
1785 vapier 1.433 for j in ${i}; do
1786     msg+=" ${j} and"
1787 creffett 1.432 done
1788     msg="${msg:0: -4} for ${desc}"
1789     elog "${msg}"
1790     done
1791     fi
1792     }
1793    
1794 vapier 1.371 fi

  ViewVC Help
Powered by ViewVC 1.1.20