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

Contents of /eclass/eutils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.423 - (show annotations) (download)
Fri Jun 21 23:56:06 2013 UTC (9 months, 3 weeks ago) by vapier
Branch: MAIN
Changes since 1.422: +72 -1 lines
evar_push/evar_pop: new api for saving/restoring variables on a stack

1 # Copyright 1999-2013 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
3 # $Header: /var/cvsroot/gentoo-x86/eclass/eutils.eclass,v 1.422 2013/06/21 23:52:50 vapier Exp $
4
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 #
15 # Due to the nature of this eclass, some functions may have maintainers
16 # different from the overall eclass!
17
18 if [[ ${___ECLASS_ONCE_EUTILS} != "recur -_+^+_- spank" ]] ; then
19 ___ECLASS_ONCE_EUTILS="recur -_+^+_- spank"
20
21 inherit multilib toolchain-funcs user
22
23 if has "${EAPI:-0}" 0 1 2; then
24
25 # @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 # don't wait at all. Defined in EAPIs 0 1 and 2.
32 epause() {
33 [[ -z ${EPAUSE_IGNORE} ]] && sleep ${1:-5}
34 }
35
36 # @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 # don't beep at all. Defined in EAPIs 0 1 and 2.
43 ebeep() {
44 local n
45 if [[ -z ${EBEEP_IGNORE} ]] ; then
46 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 else
56
57 ebeep() {
58 ewarn "QA Notice: ebeep is not defined in EAPI=${EAPI}, please file a bug at http://bugs.gentoo.org"
59 }
60
61 epause() {
62 ewarn "QA Notice: epause is not defined in EAPI=${EAPI}, please file a bug at http://bugs.gentoo.org"
63 }
64
65 fi
66
67 # @FUNCTION: eqawarn
68 # @USAGE: [message]
69 # @DESCRIPTION:
70 # 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 if ! declare -F eqawarn >/dev/null ; then
74 eqawarn() {
75 has qa ${PORTAGE_ELOG_CLASSES} && ewarn "$@"
76 :
77 }
78 fi
79
80 # @FUNCTION: ecvs_clean
81 # @USAGE: [list of dirs]
82 # @DESCRIPTION:
83 # Remove CVS directories recursiveley. Useful when a source tarball contains
84 # internal CVS directories. Defaults to $PWD.
85 ecvs_clean() {
86 [[ -z $* ]] && set -- .
87 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 # @USAGE: [list of dirs]
93 # @DESCRIPTION:
94 # Remove .svn directories recursiveley. Useful when a source tarball contains
95 # internal Subversion directories. Defaults to $PWD.
96 esvn_clean() {
97 [[ -z $* ]] && set -- .
98 find "$@" -type d -name '.svn' -prune -print0 | xargs -0 rm -rf
99 }
100
101 # @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 local stack_name="__ESTACK_$1__" ; shift
118 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 # We use the fugly __estack_xxx var names to avoid collision with
131 # 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 # copy of "i" rather than the caller's copy. The __estack_xxx
134 # garbage is preferable to using $1/$2 everywhere as that is a
135 # bit harder to read.
136 local __estack_name="__ESTACK_$1__" ; shift
137 local __estack_retvar=$1 ; shift
138 eval local __estack_i=\${#${__estack_name}\[@\]}
139 # Don't warn -- let the caller interpret this as a failure
140 # or as normal behavior (akin to `shift`)
141 [[ $(( --__estack_i )) -eq -1 ]] && return 1
142
143 if [[ -n ${__estack_retvar} ]] ; then
144 eval ${__estack_retvar}=\"\${${__estack_name}\[${__estack_i}\]}\"
145 fi
146 eval unset ${__estack_name}\[${__estack_i}\]
147 }
148
149 # @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 || val="${___ECLASS_ONCE_EUTILS}"
178 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 [[ ${val} == "${___ECLASS_ONCE_EUTILS}" ]] \
215 && unset ${var} \
216 || printf -v "${var}" '%s' "${val}"
217 done
218 }
219
220 # @FUNCTION: eshopts_push
221 # @USAGE: [options to `set` or `shopt`]
222 # @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 # 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 # 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 # eshopts_push -s noglob
235 # 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 if [[ $1 == -[su] ]] ; then
245 estack_push eshopts "$(shopt -p)"
246 [[ $# -eq 0 ]] && return 0
247 shopt "$@" || die "${FUNCNAME}: bad options to shopt: $*"
248 else
249 estack_push eshopts $-
250 [[ $# -eq 0 ]] && return 0
251 set "$@" || die "${FUNCNAME}: bad options to set: $*"
252 fi
253 }
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 local s
262 estack_pop eshopts s || die "${FUNCNAME}: unbalanced push"
263 if [[ ${s} == "shopt -"* ]] ; then
264 eval "${s}" || die "${FUNCNAME}: sanity: invalid shopt options: ${s}"
265 else
266 set +$- || die "${FUNCNAME}: sanity: invalid shell settings: $-"
267 set -${s} || die "${FUNCNAME}: sanity: unable to restore saved shell settings: ${s}"
268 fi
269 }
270
271 # @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 [[ $# -eq 0 ]] || die "${FUNCNAME}: we take no options"
287 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 # @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 # @VARIABLE: EPATCH_SOURCE
305 # @DESCRIPTION:
306 # Default directory to search for patches.
307 EPATCH_SOURCE="${WORKDIR}/patch"
308 # @VARIABLE: EPATCH_SUFFIX
309 # @DESCRIPTION:
310 # Default extension for patches (do not prefix the period yourself).
311 EPATCH_SUFFIX="patch.bz2"
312 # @VARIABLE: EPATCH_OPTS
313 # @DESCRIPTION:
314 # 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 # @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 EPATCH_COMMON_OPTS="-g0 -E --no-backup-if-mismatch"
329 # @VARIABLE: EPATCH_EXCLUDE
330 # @DESCRIPTION:
331 # List of patches not to apply. Note this is only file names,
332 # and not the full path. Globs accepted.
333 EPATCH_EXCLUDE=""
334 # @VARIABLE: EPATCH_SINGLE_MSG
335 # @DESCRIPTION:
336 # Change the printed message for a single patch.
337 EPATCH_SINGLE_MSG=""
338 # @VARIABLE: EPATCH_MULTI_MSG
339 # @DESCRIPTION:
340 # Change the printed message for multiple patches.
341 EPATCH_MULTI_MSG="Applying various patches (bugfixes/updates) ..."
342 # @VARIABLE: EPATCH_FORCE
343 # @DESCRIPTION:
344 # Only require patches to match EPATCH_SUFFIX rather than the extended
345 # arch naming style.
346 EPATCH_FORCE="no"
347 # @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
353 # @FUNCTION: epatch
354 # @USAGE: [options] [patches] [dirs of patches]
355 # @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 # the -p option as epatch will automatically attempt -p0 to -p5 until things
360 # apply successfully.
361 #
362 # 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 #
369 # When processing directories, epatch will apply all patches that match:
370 # @CODE
371 # if ${EPATCH_FORCE} != "yes"
372 # ??_${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 #
382 # If EPATCH_SUFFIX is empty, then no period before it is implied when searching
383 # for patches to apply.
384 #
385 # Refer to the other EPATCH_xxx variables for more customization of behavior.
386 epatch() {
387 _epatch_draw_line() {
388 # create a line of same length as input string
389 [[ -z $1 ]] && set "$(printf "%65s" '')"
390 echo "${1//?/=}"
391 }
392
393 unset P4CONFIG P4PORT P4USER # keep perforce at bay #56402
394
395 # 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 # 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 for m in "$@" ; do
413 epatch "${m}"
414 done
415 return 0
416 fi
417
418 local SINGLE_PATCH="no"
419 # no args means process ${EPATCH_SOURCE}
420 [[ $# -eq 0 ]] && set -- "${EPATCH_SOURCE}"
421
422 if [[ -f $1 ]] ; then
423 SINGLE_PATCH="yes"
424 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 # Some people like to make dirs of patches w/out suffixes (vim)
431 set -- "$1"/*${EPATCH_SUFFIX:+."${EPATCH_SUFFIX}"}
432
433 elif [[ -f ${EPATCH_SOURCE}/$1 ]] ; then
434 # Re-use EPATCH_SOURCE as a search dir
435 epatch "${EPATCH_SOURCE}/$1"
436 return $?
437
438 else
439 # sanity check ... if it isn't a dir or file, wtf man ?
440 [[ $# -ne 0 ]] && EPATCH_SOURCE=$1
441 echo
442 eerror "Cannot find \$EPATCH_SOURCE! Value for \$EPATCH_SOURCE is:"
443 eerror
444 eerror " ${EPATCH_SOURCE}"
445 eerror " ( ${EPATCH_SOURCE##*/} )"
446 echo
447 die "Cannot find \$EPATCH_SOURCE!"
448 fi
449
450 # Now that we know we're actually going to apply something, merge
451 # all of the patch options back in to a single variable for below.
452 EPATCH_OPTS="${EPATCH_COMMON_OPTS} ${EPATCH_OPTS[*]}"
453
454 local PIPE_CMD
455 case ${EPATCH_SUFFIX##*\.} in
456 xz) PIPE_CMD="xz -dc" ;;
457 lzma) PIPE_CMD="lzma -dc" ;;
458 bz2) PIPE_CMD="bzip2 -dc" ;;
459 gz|Z|z) PIPE_CMD="gzip -dc" ;;
460 ZIP|zip) PIPE_CMD="unzip -p" ;;
461 *) ;;
462 esac
463
464 [[ ${SINGLE_PATCH} == "no" ]] && einfo "${EPATCH_MULTI_MSG}"
465
466 local x
467 for x in "$@" ; do
468 # If the patch dir given contains subdirs, or our EPATCH_SUFFIX
469 # didn't match anything, ignore continue on
470 [[ ! -f ${x} ]] && continue
471
472 local patchname=${x##*/}
473
474 # Apply single patches, or forced sets of patches, or
475 # patches with ARCH dependant names.
476 # ???_arch_foo.patch
477 # Else, skip this input altogether
478 local a=${patchname#*_} # strip the ???_
479 a=${a%%_*} # strip the _foo.patch
480 if ! [[ ${SINGLE_PATCH} == "yes" || \
481 ${EPATCH_FORCE} == "yes" || \
482 ${a} == all || \
483 ${a} == ${ARCH} ]]
484 then
485 continue
486 fi
487
488 # Let people filter things dynamically
489 if [[ -n ${EPATCH_EXCLUDE} ]] ; then
490 # let people use globs in the exclude
491 eshopts_push -o noglob
492
493 local ex
494 for ex in ${EPATCH_EXCLUDE} ; do
495 if [[ ${patchname} == ${ex} ]] ; then
496 einfo " Skipping ${patchname} due to EPATCH_EXCLUDE ..."
497 eshopts_pop
498 continue 2
499 fi
500 done
501
502 for ex in ${EPATCH_USER_EXCLUDE} ; do
503 if [[ ${patchname} == ${ex} ]] ; then
504 einfo " Skipping ${patchname} due to EPATCH_USER_EXCLUDE ..."
505 eshopts_pop
506 continue 2
507 fi
508 done
509
510 eshopts_pop
511 fi
512
513 if [[ ${SINGLE_PATCH} == "yes" ]] ; then
514 if [[ -n ${EPATCH_SINGLE_MSG} ]] ; then
515 einfo "${EPATCH_SINGLE_MSG}"
516 else
517 einfo "Applying ${patchname} ..."
518 fi
519 else
520 einfo " ${patchname} ..."
521 fi
522
523 # most of the time, there will only be one run per unique name,
524 # but if there are more, make sure we get unique log filenames
525 local STDERR_TARGET="${T}/${patchname}.out"
526 if [[ -e ${STDERR_TARGET} ]] ; then
527 STDERR_TARGET="${T}/${patchname}-$$.out"
528 fi
529
530 printf "***** %s *****\nPWD: %s\n\n" "${patchname}" "${PWD}" > "${STDERR_TARGET}"
531
532 # Decompress the patch if need be
533 local count=0
534 local PATCH_TARGET
535 if [[ -n ${PIPE_CMD} ]] ; then
536 PATCH_TARGET="${T}/$$.patch"
537 echo "PIPE_COMMAND: ${PIPE_CMD} ${x} > ${PATCH_TARGET}" >> "${STDERR_TARGET}"
538
539 if ! (${PIPE_CMD} "${x}" > "${PATCH_TARGET}") >> "${STDERR_TARGET}" 2>&1 ; then
540 echo
541 eerror "Could not extract patch!"
542 #die "Could not extract patch!"
543 count=5
544 break
545 fi
546 else
547 PATCH_TARGET=${x}
548 fi
549
550 # Check for absolute paths in patches. If sandbox is disabled,
551 # people could (accidently) patch files in the root filesystem.
552 # Or trigger other unpleasantries #237667. So disallow -p0 on
553 # such patches.
554 local abs_paths=$(egrep -n '^[-+]{3} /' "${PATCH_TARGET}" | awk '$2 != "/dev/null" { print }')
555 if [[ -n ${abs_paths} ]] ; then
556 count=1
557 printf "NOTE: skipping -p0 due to absolute paths in patch:\n%s\n" "${abs_paths}" >> "${STDERR_TARGET}"
558 fi
559 # Similar reason, but with relative paths.
560 local rel_paths=$(egrep -n '^[-+]{3} [^ ]*[.][.]/' "${PATCH_TARGET}")
561 if [[ -n ${rel_paths} ]] ; then
562 echo
563 eerror "Rejected Patch: ${patchname} !"
564 eerror " ( ${PATCH_TARGET} )"
565 eerror
566 eerror "Your patch uses relative paths '../':"
567 eerror "${rel_paths}"
568 echo
569 die "you need to fix the relative paths in patch"
570 fi
571
572 # Dynamically detect the correct -p# ... i'm lazy, so shoot me :/
573 local patch_cmd
574 # Handle aliased patch command #404447 #461568
575 local patch="patch"
576 eval $(alias patch 2>/dev/null | sed 's:^alias ::')
577 while [[ ${count} -lt 5 ]] ; do
578 patch_cmd="${patch} -p${count} ${EPATCH_OPTS}"
579
580 # Generate some useful debug info ...
581 (
582 _epatch_draw_line "***** ${patchname} *****"
583 echo
584 echo "PATCH COMMAND: ${patch_cmd} < '${PATCH_TARGET}'"
585 echo
586 _epatch_draw_line "***** ${patchname} *****"
587 ${patch_cmd} --dry-run -f < "${PATCH_TARGET}" 2>&1
588 ret=$?
589 echo
590 echo "patch program exited with status ${ret}"
591 exit ${ret}
592 ) >> "${STDERR_TARGET}"
593
594 if [ $? -eq 0 ] ; then
595 (
596 _epatch_draw_line "***** ${patchname} *****"
597 echo
598 echo "ACTUALLY APPLYING ${patchname} ..."
599 echo
600 _epatch_draw_line "***** ${patchname} *****"
601 ${patch_cmd} < "${PATCH_TARGET}" 2>&1
602 ret=$?
603 echo
604 echo "patch program exited with status ${ret}"
605 exit ${ret}
606 ) >> "${STDERR_TARGET}"
607
608 if [ $? -ne 0 ] ; then
609 echo
610 eerror "A dry-run of patch command succeeded, but actually"
611 eerror "applying the patch failed!"
612 #die "Real world sux compared to the dreamworld!"
613 count=5
614 fi
615 break
616 fi
617
618 : $(( count++ ))
619 done
620
621 # if we had to decompress the patch, delete the temp one
622 if [[ -n ${PIPE_CMD} ]] ; then
623 rm -f "${PATCH_TARGET}"
624 fi
625
626 if [[ ${count} -ge 5 ]] ; then
627 echo
628 eerror "Failed Patch: ${patchname} !"
629 eerror " ( ${PATCH_TARGET} )"
630 eerror
631 eerror "Include in your bugreport the contents of:"
632 eerror
633 eerror " ${STDERR_TARGET}"
634 echo
635 die "Failed Patch: ${patchname}!"
636 fi
637
638 # if everything worked, delete the full debug patch log
639 rm -f "${STDERR_TARGET}"
640
641 # then log away the exact stuff for people to review later
642 cat <<-EOF >> "${T}/epatch.log"
643 PATCH: ${x}
644 CMD: ${patch_cmd}
645 PWD: ${PWD}
646
647 EOF
648 eend 0
649 done
650
651 [[ ${SINGLE_PATCH} == "no" ]] && einfo "Done with patching"
652 : # everything worked
653 }
654
655 # @FUNCTION: epatch_user
656 # @USAGE:
657 # @DESCRIPTION:
658 # Applies user-provided patches to the source tree. The patches are
659 # taken from /etc/portage/patches/<CATEGORY>/<PF|P|PN>[:SLOT]/, where the first
660 # of these three directories to exist will be the one to use, ignoring
661 # any more general directories which might exist as well. They must end
662 # in ".patch" to be applied.
663 #
664 # User patches are intended for quick testing of patches without ebuild
665 # modifications, as well as for permanent customizations a user might
666 # desire. Obviously, there can be no official support for arbitrarily
667 # patched ebuilds. So whenever a build log in a bug report mentions that
668 # user patches were applied, the user should be asked to reproduce the
669 # problem without these.
670 #
671 # Not all ebuilds do call this function, so placing patches in the
672 # stated directory might or might not work, depending on the package and
673 # the eclasses it inherits and uses. It is safe to call the function
674 # repeatedly, so it is always possible to add a call at the ebuild
675 # level. The first call is the time when the patches will be
676 # applied.
677 #
678 # Ideally, this function should be called after gentoo-specific patches
679 # have been applied, so that their code can be modified as well, but
680 # before calls to e.g. eautoreconf, as the user patches might affect
681 # autotool input files as well.
682 epatch_user() {
683 [[ $# -ne 0 ]] && die "epatch_user takes no options"
684
685 # Allow multiple calls to this function; ignore all but the first
686 local applied="${T}/epatch_user.log"
687 [[ -e ${applied} ]] && return 2
688
689 # don't clobber any EPATCH vars that the parent might want
690 local EPATCH_SOURCE check base=${PORTAGE_CONFIGROOT%/}/etc/portage/patches
691 for check in ${CATEGORY}/{${P}-${PR},${P},${PN}}{,:${SLOT}}; do
692 EPATCH_SOURCE=${base}/${CTARGET}/${check}
693 [[ -r ${EPATCH_SOURCE} ]] || EPATCH_SOURCE=${base}/${CHOST}/${check}
694 [[ -r ${EPATCH_SOURCE} ]] || EPATCH_SOURCE=${base}/${check}
695 if [[ -d ${EPATCH_SOURCE} ]] ; then
696 EPATCH_SOURCE=${EPATCH_SOURCE} \
697 EPATCH_SUFFIX="patch" \
698 EPATCH_FORCE="yes" \
699 EPATCH_MULTI_MSG="Applying user patches from ${EPATCH_SOURCE} ..." \
700 epatch
701 echo "${EPATCH_SOURCE}" > "${applied}"
702 return 0
703 fi
704 done
705 echo "none" > "${applied}"
706 return 1
707 }
708
709 # @FUNCTION: emktemp
710 # @USAGE: [temp dir]
711 # @DESCRIPTION:
712 # Cheap replacement for when debianutils (and thus mktemp)
713 # does not exist on the users system.
714 emktemp() {
715 local exe="touch"
716 [[ $1 == -d ]] && exe="mkdir" && shift
717 local topdir=$1
718
719 if [[ -z ${topdir} ]] ; then
720 [[ -z ${T} ]] \
721 && topdir="/tmp" \
722 || topdir=${T}
723 fi
724
725 if ! type -P mktemp > /dev/null ; then
726 # system lacks `mktemp` so we have to fake it
727 local tmp=/
728 while [[ -e ${tmp} ]] ; do
729 tmp=${topdir}/tmp.${RANDOM}.${RANDOM}.${RANDOM}
730 done
731 ${exe} "${tmp}" || ${exe} -p "${tmp}"
732 echo "${tmp}"
733 else
734 # the args here will give slightly wierd names on BSD,
735 # but should produce a usable file on all userlands
736 if [[ ${exe} == "touch" ]] ; then
737 TMPDIR="${topdir}" mktemp -t tmp.XXXXXXXXXX
738 else
739 TMPDIR="${topdir}" mktemp -dt tmp.XXXXXXXXXX
740 fi
741 fi
742 }
743
744 # @FUNCTION: edos2unix
745 # @USAGE: <file> [more files ...]
746 # @DESCRIPTION:
747 # A handy replacement for dos2unix, recode, fixdos, etc... This allows you
748 # to remove all of these text utilities from DEPEND variables because this
749 # is a script based solution. Just give it a list of files to convert and
750 # they will all be changed from the DOS CRLF format to the UNIX LF format.
751 edos2unix() {
752 [[ $# -eq 0 ]] && return 0
753 sed -i 's/\r$//' -- "$@" || die
754 }
755
756 # @FUNCTION: make_desktop_entry
757 # @USAGE: make_desktop_entry(<command>, [name], [icon], [type], [fields])
758 # @DESCRIPTION:
759 # Make a .desktop file.
760 #
761 # @CODE
762 # binary: what command does the app run with ?
763 # name: the name that will show up in the menu
764 # icon: the icon to use in the menu entry
765 # this can be relative (to /usr/share/pixmaps) or
766 # a full path to an icon
767 # type: what kind of application is this?
768 # for categories:
769 # http://standards.freedesktop.org/menu-spec/latest/apa.html
770 # if unset, function tries to guess from package's category
771 # fields: extra fields to append to the desktop file; a printf string
772 # @CODE
773 make_desktop_entry() {
774 [[ -z $1 ]] && die "make_desktop_entry: You must specify the executable"
775
776 local exec=${1}
777 local name=${2:-${PN}}
778 local icon=${3:-${PN}}
779 local type=${4}
780 local fields=${5}
781
782 if [[ -z ${type} ]] ; then
783 local catmaj=${CATEGORY%%-*}
784 local catmin=${CATEGORY##*-}
785 case ${catmaj} in
786 app)
787 case ${catmin} in
788 accessibility) type="Utility;Accessibility";;
789 admin) type=System;;
790 antivirus) type=System;;
791 arch) type="Utility;Archiving";;
792 backup) type="Utility;Archiving";;
793 cdr) type="AudioVideo;DiscBurning";;
794 dicts) type="Office;Dictionary";;
795 doc) type=Documentation;;
796 editors) type="Utility;TextEditor";;
797 emacs) type="Development;TextEditor";;
798 emulation) type="System;Emulator";;
799 laptop) type="Settings;HardwareSettings";;
800 office) type=Office;;
801 pda) type="Office;PDA";;
802 vim) type="Development;TextEditor";;
803 xemacs) type="Development;TextEditor";;
804 esac
805 ;;
806
807 dev)
808 type="Development"
809 ;;
810
811 games)
812 case ${catmin} in
813 action|fps) type=ActionGame;;
814 arcade) type=ArcadeGame;;
815 board) type=BoardGame;;
816 emulation) type=Emulator;;
817 kids) type=KidsGame;;
818 puzzle) type=LogicGame;;
819 roguelike) type=RolePlaying;;
820 rpg) type=RolePlaying;;
821 simulation) type=Simulation;;
822 sports) type=SportsGame;;
823 strategy) type=StrategyGame;;
824 esac
825 type="Game;${type}"
826 ;;
827
828 gnome)
829 type="Gnome;GTK"
830 ;;
831
832 kde)
833 type="KDE;Qt"
834 ;;
835
836 mail)
837 type="Network;Email"
838 ;;
839
840 media)
841 case ${catmin} in
842 gfx)
843 type=Graphics
844 ;;
845 *)
846 case ${catmin} in
847 radio) type=Tuner;;
848 sound) type=Audio;;
849 tv) type=TV;;
850 video) type=Video;;
851 esac
852 type="AudioVideo;${type}"
853 ;;
854 esac
855 ;;
856
857 net)
858 case ${catmin} in
859 dialup) type=Dialup;;
860 ftp) type=FileTransfer;;
861 im) type=InstantMessaging;;
862 irc) type=IRCClient;;
863 mail) type=Email;;
864 news) type=News;;
865 nntp) type=News;;
866 p2p) type=FileTransfer;;
867 voip) type=Telephony;;
868 esac
869 type="Network;${type}"
870 ;;
871
872 sci)
873 case ${catmin} in
874 astro*) type=Astronomy;;
875 bio*) type=Biology;;
876 calc*) type=Calculator;;
877 chem*) type=Chemistry;;
878 elec*) type=Electronics;;
879 geo*) type=Geology;;
880 math*) type=Math;;
881 physics) type=Physics;;
882 visual*) type=DataVisualization;;
883 esac
884 type="Education;Science;${type}"
885 ;;
886
887 sys)
888 type="System"
889 ;;
890
891 www)
892 case ${catmin} in
893 client) type=WebBrowser;;
894 esac
895 type="Network;${type}"
896 ;;
897
898 *)
899 type=
900 ;;
901 esac
902 fi
903 if [ "${SLOT}" == "0" ] ; then
904 local desktop_name="${PN}"
905 else
906 local desktop_name="${PN}-${SLOT}"
907 fi
908 local desktop="${T}/$(echo ${exec} | sed 's:[[:space:]/:]:_:g')-${desktop_name}.desktop"
909 #local desktop=${T}/${exec%% *:-${desktop_name}}.desktop
910
911 # Don't append another ";" when a valid category value is provided.
912 type=${type%;}${type:+;}
913
914 eshopts_push -s extglob
915 if [[ -n ${icon} && ${icon} != /* ]] && [[ ${icon} == *.xpm || ${icon} == *.png || ${icon} == *.svg ]]; then
916 ewarn "As described in the Icon Theme Specification, icon file extensions are not"
917 ewarn "allowed in .desktop files if the value is not an absolute path."
918 icon=${icon%.@(xpm|png|svg)}
919 fi
920 eshopts_pop
921
922 cat <<-EOF > "${desktop}"
923 [Desktop Entry]
924 Name=${name}
925 Type=Application
926 Comment=${DESCRIPTION}
927 Exec=${exec}
928 TryExec=${exec%% *}
929 Icon=${icon}
930 Categories=${type}
931 EOF
932
933 if [[ ${fields:-=} != *=* ]] ; then
934 # 5th arg used to be value to Path=
935 ewarn "make_desktop_entry: update your 5th arg to read Path=${fields}"
936 fields="Path=${fields}"
937 fi
938 [[ -n ${fields} ]] && printf '%b\n' "${fields}" >> "${desktop}"
939
940 (
941 # wrap the env here so that the 'insinto' call
942 # doesn't corrupt the env of the caller
943 insinto /usr/share/applications
944 doins "${desktop}"
945 ) || die "installing desktop file failed"
946 }
947
948 # @FUNCTION: validate_desktop_entries
949 # @USAGE: [directories]
950 # @MAINTAINER:
951 # Carsten Lohrke <carlo@gentoo.org>
952 # @DESCRIPTION:
953 # Validate desktop entries using desktop-file-utils
954 validate_desktop_entries() {
955 if [[ -x /usr/bin/desktop-file-validate ]] ; then
956 einfo "Checking desktop entry validity"
957 local directories=""
958 for d in /usr/share/applications $@ ; do
959 [[ -d ${D}${d} ]] && directories="${directories} ${D}${d}"
960 done
961 if [[ -n ${directories} ]] ; then
962 for FILE in $(find ${directories} -name "*\.desktop" \
963 -not -path '*.hidden*' | sort -u 2>/dev/null)
964 do
965 local temp=$(desktop-file-validate ${FILE} | grep -v "warning:" | \
966 sed -e "s|error: ||" -e "s|${FILE}:|--|g" )
967 [[ -n $temp ]] && elog ${temp/--/${FILE/${D}/}:}
968 done
969 fi
970 echo ""
971 else
972 einfo "Passing desktop entry validity check. Install dev-util/desktop-file-utils, if you want to help to improve Gentoo."
973 fi
974 }
975
976 # @FUNCTION: make_session_desktop
977 # @USAGE: <title> <command> [command args...]
978 # @DESCRIPTION:
979 # Make a GDM/KDM Session file. The title is the file to execute to start the
980 # Window Manager. The command is the name of the Window Manager.
981 #
982 # You can set the name of the file via the ${wm} variable.
983 make_session_desktop() {
984 [[ -z $1 ]] && eerror "$0: You must specify the title" && return 1
985 [[ -z $2 ]] && eerror "$0: You must specify the command" && return 1
986
987 local title=$1
988 local command=$2
989 local desktop=${T}/${wm:-${PN}}.desktop
990 shift 2
991
992 cat <<-EOF > "${desktop}"
993 [Desktop Entry]
994 Name=${title}
995 Comment=This session logs you into ${title}
996 Exec=${command} $*
997 TryExec=${command}
998 Type=XSession
999 EOF
1000
1001 (
1002 # wrap the env here so that the 'insinto' call
1003 # doesn't corrupt the env of the caller
1004 insinto /usr/share/xsessions
1005 doins "${desktop}"
1006 )
1007 }
1008
1009 # @FUNCTION: domenu
1010 # @USAGE: <menus>
1011 # @DESCRIPTION:
1012 # Install the list of .desktop menu files into the appropriate directory
1013 # (/usr/share/applications).
1014 domenu() {
1015 (
1016 # wrap the env here so that the 'insinto' call
1017 # doesn't corrupt the env of the caller
1018 local i j ret=0
1019 insinto /usr/share/applications
1020 for i in "$@" ; do
1021 if [[ -f ${i} ]] ; then
1022 doins "${i}"
1023 ((ret+=$?))
1024 elif [[ -d ${i} ]] ; then
1025 for j in "${i}"/*.desktop ; do
1026 doins "${j}"
1027 ((ret+=$?))
1028 done
1029 else
1030 ((++ret))
1031 fi
1032 done
1033 exit ${ret}
1034 )
1035 }
1036
1037 # @FUNCTION: newmenu
1038 # @USAGE: <menu> <newname>
1039 # @DESCRIPTION:
1040 # Like all other new* functions, install the specified menu as newname.
1041 newmenu() {
1042 (
1043 # wrap the env here so that the 'insinto' call
1044 # doesn't corrupt the env of the caller
1045 insinto /usr/share/applications
1046 newins "$@"
1047 )
1048 }
1049
1050 # @FUNCTION: _iconins
1051 # @INTERNAL
1052 # @DESCRIPTION:
1053 # function for use in doicon and newicon
1054 _iconins() {
1055 (
1056 # wrap the env here so that the 'insinto' call
1057 # doesn't corrupt the env of the caller
1058 local funcname=$1; shift
1059 local size dir
1060 local context=apps
1061 local theme=hicolor
1062
1063 while [[ $# -gt 0 ]] ; do
1064 case $1 in
1065 -s|--size)
1066 if [[ ${2%%x*}x${2%%x*} == "$2" ]] ; then
1067 size=${2%%x*}
1068 else
1069 size=${2}
1070 fi
1071 case ${size} in
1072 16|22|24|32|36|48|64|72|96|128|192|256)
1073 size=${size}x${size};;
1074 scalable)
1075 ;;
1076 *)
1077 eerror "${size} is an unsupported icon size!"
1078 exit 1;;
1079 esac
1080 shift 2;;
1081 -t|--theme)
1082 theme=${2}
1083 shift 2;;
1084 -c|--context)
1085 context=${2}
1086 shift 2;;
1087 *)
1088 if [[ -z ${size} ]] ; then
1089 insinto /usr/share/pixmaps
1090 else
1091 insinto /usr/share/icons/${theme}/${size}/${context}
1092 fi
1093
1094 if [[ ${funcname} == doicon ]] ; then
1095 if [[ -f $1 ]] ; then
1096 doins "${1}"
1097 elif [[ -d $1 ]] ; then
1098 shopt -s nullglob
1099 doins "${1}"/*.{png,svg}
1100 shopt -u nullglob
1101 else
1102 eerror "${1} is not a valid file/directory!"
1103 exit 1
1104 fi
1105 else
1106 break
1107 fi
1108 shift 1;;
1109 esac
1110 done
1111 if [[ ${funcname} == newicon ]] ; then
1112 newins "$@"
1113 fi
1114 ) || die
1115 }
1116
1117 # @FUNCTION: doicon
1118 # @USAGE: [options] <icons>
1119 # @DESCRIPTION:
1120 # Install icon into the icon directory /usr/share/icons or into
1121 # /usr/share/pixmaps if "--size" is not set.
1122 # This is useful in conjunction with creating desktop/menu files.
1123 #
1124 # @CODE
1125 # options:
1126 # -s, --size
1127 # !!! must specify to install into /usr/share/icons/... !!!
1128 # size of the icon, like 48 or 48x48
1129 # supported icon sizes are:
1130 # 16 22 24 32 36 48 64 72 96 128 192 256 scalable
1131 # -c, --context
1132 # defaults to "apps"
1133 # -t, --theme
1134 # defaults to "hicolor"
1135 #
1136 # icons: list of icons
1137 #
1138 # example 1: doicon foobar.png fuqbar.svg suckbar.png
1139 # results in: insinto /usr/share/pixmaps
1140 # doins foobar.png fuqbar.svg suckbar.png
1141 #
1142 # example 2: doicon -s 48 foobar.png fuqbar.png blobbar.png
1143 # results in: insinto /usr/share/icons/hicolor/48x48/apps
1144 # doins foobar.png fuqbar.png blobbar.png
1145 # @CODE
1146 doicon() {
1147 _iconins ${FUNCNAME} "$@"
1148 }
1149
1150 # @FUNCTION: newicon
1151 # @USAGE: [options] <icon> <newname>
1152 # @DESCRIPTION:
1153 # Like doicon, install the specified icon as newname.
1154 #
1155 # @CODE
1156 # example 1: newicon foobar.png NEWNAME.png
1157 # results in: insinto /usr/share/pixmaps
1158 # newins foobar.png NEWNAME.png
1159 #
1160 # example 2: newicon -s 48 foobar.png NEWNAME.png
1161 # results in: insinto /usr/share/icons/hicolor/48x48/apps
1162 # newins foobar.png NEWNAME.png
1163 # @CODE
1164 newicon() {
1165 _iconins ${FUNCNAME} "$@"
1166 }
1167
1168 # @FUNCTION: strip-linguas
1169 # @USAGE: [<allow LINGUAS>|<-i|-u> <directories of .po files>]
1170 # @DESCRIPTION:
1171 # Make sure that LINGUAS only contains languages that
1172 # a package can support. The first form allows you to
1173 # specify a list of LINGUAS. The -i builds a list of po
1174 # files found in all the directories and uses the
1175 # intersection of the lists. The -u builds a list of po
1176 # files found in all the directories and uses the union
1177 # of the lists.
1178 strip-linguas() {
1179 local ls newls nols
1180 if [[ $1 == "-i" ]] || [[ $1 == "-u" ]] ; then
1181 local op=$1; shift
1182 ls=$(find "$1" -name '*.po' -exec basename {} .po ';'); shift
1183 local d f
1184 for d in "$@" ; do
1185 if [[ ${op} == "-u" ]] ; then
1186 newls=${ls}
1187 else
1188 newls=""
1189 fi
1190 for f in $(find "$d" -name '*.po' -exec basename {} .po ';') ; do
1191 if [[ ${op} == "-i" ]] ; then
1192 has ${f} ${ls} && newls="${newls} ${f}"
1193 else
1194 has ${f} ${ls} || newls="${newls} ${f}"
1195 fi
1196 done
1197 ls=${newls}
1198 done
1199 else
1200 ls="$@"
1201 fi
1202
1203 nols=""
1204 newls=""
1205 for f in ${LINGUAS} ; do
1206 if has ${f} ${ls} ; then
1207 newls="${newls} ${f}"
1208 else
1209 nols="${nols} ${f}"
1210 fi
1211 done
1212 [[ -n ${nols} ]] \
1213 && einfo "Sorry, but ${PN} does not support the LINGUAS:" ${nols}
1214 export LINGUAS=${newls:1}
1215 }
1216
1217 # @FUNCTION: preserve_old_lib
1218 # @USAGE: <libs to preserve> [more libs]
1219 # @DESCRIPTION:
1220 # These functions are useful when a lib in your package changes ABI SONAME.
1221 # An example might be from libogg.so.0 to libogg.so.1. Removing libogg.so.0
1222 # would break packages that link against it. Most people get around this
1223 # by using the portage SLOT mechanism, but that is not always a relevant
1224 # solution, so instead you can call this from pkg_preinst. See also the
1225 # preserve_old_lib_notify function.
1226 preserve_old_lib() {
1227 if [[ ${EBUILD_PHASE} != "preinst" ]] ; then
1228 eerror "preserve_old_lib() must be called from pkg_preinst() only"
1229 die "Invalid preserve_old_lib() usage"
1230 fi
1231 [[ -z $1 ]] && die "Usage: preserve_old_lib <library to preserve> [more libraries to preserve]"
1232
1233 # let portage worry about it
1234 has preserve-libs ${FEATURES} && return 0
1235
1236 local lib dir
1237 for lib in "$@" ; do
1238 [[ -e ${ROOT}/${lib} ]] || continue
1239 dir=${lib%/*}
1240 dodir ${dir} || die "dodir ${dir} failed"
1241 cp "${ROOT}"/${lib} "${D}"/${lib} || die "cp ${lib} failed"
1242 touch "${D}"/${lib}
1243 done
1244 }
1245
1246 # @FUNCTION: preserve_old_lib_notify
1247 # @USAGE: <libs to notify> [more libs]
1248 # @DESCRIPTION:
1249 # Spit helpful messages about the libraries preserved by preserve_old_lib.
1250 preserve_old_lib_notify() {
1251 if [[ ${EBUILD_PHASE} != "postinst" ]] ; then
1252 eerror "preserve_old_lib_notify() must be called from pkg_postinst() only"
1253 die "Invalid preserve_old_lib_notify() usage"
1254 fi
1255
1256 # let portage worry about it
1257 has preserve-libs ${FEATURES} && return 0
1258
1259 local lib notice=0
1260 for lib in "$@" ; do
1261 [[ -e ${ROOT}/${lib} ]] || continue
1262 if [[ ${notice} -eq 0 ]] ; then
1263 notice=1
1264 ewarn "Old versions of installed libraries were detected on your system."
1265 ewarn "In order to avoid breaking packages that depend on these old libs,"
1266 ewarn "the libraries are not being removed. You need to run revdep-rebuild"
1267 ewarn "in order to remove these old dependencies. If you do not have this"
1268 ewarn "helper program, simply emerge the 'gentoolkit' package."
1269 ewarn
1270 fi
1271 ewarn " # revdep-rebuild --library '${lib}' && rm '${lib}'"
1272 done
1273 }
1274
1275 # @FUNCTION: built_with_use
1276 # @USAGE: [--hidden] [--missing <action>] [-a|-o] <DEPEND ATOM> <List of USE flags>
1277 # @DESCRIPTION:
1278 #
1279 # Deprecated: Use EAPI 2 use deps in DEPEND|RDEPEND and with has_version calls.
1280 #
1281 # A temporary hack until portage properly supports DEPENDing on USE
1282 # flags being enabled in packages. This will check to see if the specified
1283 # DEPEND atom was built with the specified list of USE flags. The
1284 # --missing option controls the behavior if called on a package that does
1285 # not actually support the defined USE flags (aka listed in IUSE).
1286 # The default is to abort (call die). The -a and -o flags control
1287 # the requirements of the USE flags. They correspond to "and" and "or"
1288 # logic. So the -a flag means all listed USE flags must be enabled
1289 # while the -o flag means at least one of the listed IUSE flags must be
1290 # enabled. The --hidden option is really for internal use only as it
1291 # means the USE flag we're checking is hidden expanded, so it won't be found
1292 # in IUSE like normal USE flags.
1293 #
1294 # Remember that this function isn't terribly intelligent so order of optional
1295 # flags matter.
1296 built_with_use() {
1297 local hidden="no"
1298 if [[ $1 == "--hidden" ]] ; then
1299 hidden="yes"
1300 shift
1301 fi
1302
1303 local missing_action="die"
1304 if [[ $1 == "--missing" ]] ; then
1305 missing_action=$2
1306 shift ; shift
1307 case ${missing_action} in
1308 true|false|die) ;;
1309 *) die "unknown action '${missing_action}'";;
1310 esac
1311 fi
1312
1313 local opt=$1
1314 [[ ${opt:0:1} = "-" ]] && shift || opt="-a"
1315
1316 local PKG=$(best_version $1)
1317 [[ -z ${PKG} ]] && die "Unable to resolve $1 to an installed package"
1318 shift
1319
1320 local USEFILE=${ROOT}/var/db/pkg/${PKG}/USE
1321 local IUSEFILE=${ROOT}/var/db/pkg/${PKG}/IUSE
1322
1323 # if the IUSE file doesn't exist, the read will error out, we need to handle
1324 # this gracefully
1325 if [[ ! -e ${USEFILE} ]] || [[ ! -e ${IUSEFILE} && ${hidden} == "no" ]] ; then
1326 case ${missing_action} in
1327 true) return 0;;
1328 false) return 1;;
1329 die) die "Unable to determine what USE flags $PKG was built with";;
1330 esac
1331 fi
1332
1333 if [[ ${hidden} == "no" ]] ; then
1334 local IUSE_BUILT=( $(<"${IUSEFILE}") )
1335 # Don't check USE_EXPAND #147237
1336 local expand
1337 for expand in $(echo ${USE_EXPAND} | tr '[:upper:]' '[:lower:]') ; do
1338 if [[ $1 == ${expand}_* ]] ; then
1339 expand=""
1340 break
1341 fi
1342 done
1343 if [[ -n ${expand} ]] ; then
1344 if ! has $1 ${IUSE_BUILT[@]#[-+]} ; then
1345 case ${missing_action} in
1346 true) return 0;;
1347 false) return 1;;
1348 die) die "$PKG does not actually support the $1 USE flag!";;
1349 esac
1350 fi
1351 fi
1352 fi
1353
1354 local USE_BUILT=$(<${USEFILE})
1355 while [[ $# -gt 0 ]] ; do
1356 if [[ ${opt} = "-o" ]] ; then
1357 has $1 ${USE_BUILT} && return 0
1358 else
1359 has $1 ${USE_BUILT} || return 1
1360 fi
1361 shift
1362 done
1363 [[ ${opt} = "-a" ]]
1364 }
1365
1366 # @FUNCTION: epunt_cxx
1367 # @USAGE: [dir to scan]
1368 # @DESCRIPTION:
1369 # Many configure scripts wrongly bail when a C++ compiler could not be
1370 # detected. If dir is not specified, then it defaults to ${S}.
1371 #
1372 # http://bugs.gentoo.org/73450
1373 epunt_cxx() {
1374 local dir=$1
1375 [[ -z ${dir} ]] && dir=${S}
1376 ebegin "Removing useless C++ checks"
1377 local f p any_found
1378 while IFS= read -r -d '' f; do
1379 for p in "${PORTDIR}"/eclass/ELT-patches/nocxx/*.patch ; do
1380 if patch --no-backup-if-mismatch -p1 "${f}" "${p}" >/dev/null ; then
1381 any_found=1
1382 break
1383 fi
1384 done
1385 done < <(find "${dir}" -name configure -print0)
1386
1387 if [[ -z ${any_found} ]]; then
1388 eqawarn "epunt_cxx called unnecessarily (no C++ checks to punt)."
1389 fi
1390 eend 0
1391 }
1392
1393 # @FUNCTION: make_wrapper
1394 # @USAGE: <wrapper> <target> [chdir] [libpaths] [installpath]
1395 # @DESCRIPTION:
1396 # Create a shell wrapper script named wrapper in installpath
1397 # (defaults to the bindir) to execute target (default of wrapper) by
1398 # first optionally setting LD_LIBRARY_PATH to the colon-delimited
1399 # libpaths followed by optionally changing directory to chdir.
1400 make_wrapper() {
1401 local wrapper=$1 bin=$2 chdir=$3 libdir=$4 path=$5
1402 local tmpwrapper=$(emktemp)
1403
1404 (
1405 echo '#!/bin/sh'
1406 [[ -n ${chdir} ]] && printf 'cd "%s"\n' "${chdir}"
1407 if [[ -n ${libdir} ]] ; then
1408 cat <<-EOF
1409 if [ "\${LD_LIBRARY_PATH+set}" = "set" ] ; then
1410 export LD_LIBRARY_PATH="\${LD_LIBRARY_PATH}:${libdir}"
1411 else
1412 export LD_LIBRARY_PATH="${libdir}"
1413 fi
1414 EOF
1415 fi
1416 # We don't want to quote ${bin} so that people can pass complex
1417 # things as ${bin} ... "./someprog --args"
1418 printf 'exec %s "$@"\n' "${bin}"
1419 ) > "${tmpwrapper}"
1420 chmod go+rx "${tmpwrapper}"
1421
1422 if [[ -n ${path} ]] ; then
1423 (
1424 exeinto "${path}"
1425 newexe "${tmpwrapper}" "${wrapper}"
1426 ) || die
1427 else
1428 newbin "${tmpwrapper}" "${wrapper}" || die
1429 fi
1430 }
1431
1432 # @FUNCTION: path_exists
1433 # @USAGE: [-a|-o] <paths>
1434 # @DESCRIPTION:
1435 # Check if the specified paths exist. Works for all types of paths
1436 # (files/dirs/etc...). The -a and -o flags control the requirements
1437 # of the paths. They correspond to "and" and "or" logic. So the -a
1438 # flag means all the paths must exist while the -o flag means at least
1439 # one of the paths must exist. The default behavior is "and". If no
1440 # paths are specified, then the return value is "false".
1441 path_exists() {
1442 local opt=$1
1443 [[ ${opt} == -[ao] ]] && shift || opt="-a"
1444
1445 # no paths -> return false
1446 # same behavior as: [[ -e "" ]]
1447 [[ $# -eq 0 ]] && return 1
1448
1449 local p r=0
1450 for p in "$@" ; do
1451 [[ -e ${p} ]]
1452 : $(( r += $? ))
1453 done
1454
1455 case ${opt} in
1456 -a) return $(( r != 0 )) ;;
1457 -o) return $(( r == $# )) ;;
1458 esac
1459 }
1460
1461 # @FUNCTION: in_iuse
1462 # @USAGE: <flag>
1463 # @DESCRIPTION:
1464 # Determines whether the given flag is in IUSE. Strips IUSE default prefixes
1465 # as necessary.
1466 #
1467 # Note that this function should not be used in the global scope.
1468 in_iuse() {
1469 debug-print-function ${FUNCNAME} "${@}"
1470 [[ ${#} -eq 1 ]] || die "Invalid args to ${FUNCNAME}()"
1471
1472 local flag=${1}
1473 local liuse=( ${IUSE} )
1474
1475 has "${flag}" "${liuse[@]#[+-]}"
1476 }
1477
1478 # @FUNCTION: use_if_iuse
1479 # @USAGE: <flag>
1480 # @DESCRIPTION:
1481 # Return true if the given flag is in USE and IUSE.
1482 #
1483 # Note that this function should not be used in the global scope.
1484 use_if_iuse() {
1485 in_iuse $1 || return 1
1486 use $1
1487 }
1488
1489 # @FUNCTION: usex
1490 # @USAGE: <USE flag> [true output] [false output] [true suffix] [false suffix]
1491 # @DESCRIPTION:
1492 # Proxy to declare usex for package managers or EAPIs that do not provide it
1493 # and use the package manager implementation when available (i.e. EAPI >= 5).
1494 # If USE flag is set, echo [true output][true suffix] (defaults to "yes"),
1495 # otherwise echo [false output][false suffix] (defaults to "no").
1496 if has "${EAPI:-0}" 0 1 2 3 4; then
1497 usex() { use "$1" && echo "${2-yes}$4" || echo "${3-no}$5" ; } #382963
1498 fi
1499
1500 # @FUNCTION: prune_libtool_files
1501 # @USAGE: [--all|--modules]
1502 # @DESCRIPTION:
1503 # Locate unnecessary libtool files (.la) and libtool static archives
1504 # (.a) and remove them from installation image.
1505 #
1506 # By default, .la files are removed whenever the static linkage can
1507 # either be performed using pkg-config or doesn't introduce additional
1508 # flags.
1509 #
1510 # If '--modules' argument is passed, .la files for modules (plugins) are
1511 # removed as well. This is usually useful when the package installs
1512 # plugins and the plugin loader does not use .la files.
1513 #
1514 # If '--all' argument is passed, all .la files are removed without
1515 # performing any heuristic on them. You shouldn't ever use that,
1516 # and instead report a bug in the algorithm instead.
1517 #
1518 # The .a files are only removed whenever corresponding .la files state
1519 # that they should not be linked to, i.e. whenever these files
1520 # correspond to plugins.
1521 #
1522 # Note: if your package installs both static libraries and .pc files
1523 # which use variable substitution for -l flags, you need to add
1524 # pkg-config to your DEPEND.
1525 prune_libtool_files() {
1526 debug-print-function ${FUNCNAME} "$@"
1527
1528 local removing_all removing_modules opt
1529 for opt; do
1530 case "${opt}" in
1531 --all)
1532 removing_all=1
1533 removing_modules=1
1534 ;;
1535 --modules)
1536 removing_modules=1
1537 ;;
1538 *)
1539 die "Invalid argument to ${FUNCNAME}(): ${opt}"
1540 esac
1541 done
1542
1543 local f
1544 local queue=()
1545 while IFS= read -r -d '' f; do # for all .la files
1546 local archivefile=${f/%.la/.a}
1547
1548 # The following check is done by libtool itself.
1549 # It helps us avoid removing random files which match '*.la',
1550 # see bug #468380.
1551 if ! sed -n -e '/^# Generated by .*libtool/q0;4q1' "${f}"; then
1552 continue
1553 fi
1554
1555 [[ ${f} != ${archivefile} ]] || die 'regex sanity check failed'
1556 local reason pkgconfig_scanned
1557 local snotlink=$(sed -n -e 's:^shouldnotlink=::p' "${f}")
1558
1559 if [[ ${snotlink} == yes ]]; then
1560
1561 # Remove static libs we're not supposed to link against.
1562 if [[ -f ${archivefile} ]]; then
1563 einfo "Removing unnecessary ${archivefile#${D%/}} (static plugin)"
1564 queue+=( "${archivefile}" )
1565 fi
1566
1567 # The .la file may be used by a module loader, so avoid removing it
1568 # unless explicitly requested.
1569 if [[ ${removing_modules} ]]; then
1570 reason='module'
1571 fi
1572
1573 else
1574
1575 # Remove .la files when:
1576 # - user explicitly wants us to remove all .la files,
1577 # - respective static archive doesn't exist,
1578 # - they are covered by a .pc file already,
1579 # - they don't provide any new information (no libs & no flags).
1580
1581 if [[ ${removing_all} ]]; then
1582 reason='requested'
1583 elif [[ ! -f ${archivefile} ]]; then
1584 reason='no static archive'
1585 elif [[ ! $(sed -nre \
1586 "s/^(dependency_libs|inherited_linker_flags)='(.*)'$/\2/p" \
1587 "${f}") ]]; then
1588 reason='no libs & flags'
1589 else
1590 if [[ ! ${pkgconfig_scanned} ]]; then
1591 # Create a list of all .pc-covered libs.
1592 local pc_libs=()
1593 if [[ ! ${removing_all} ]]; then
1594 local pc
1595 local tf=${T}/prune-lt-files.pc
1596 local pkgconf=$(tc-getPKG_CONFIG)
1597
1598 while IFS= read -r -d '' pc; do # for all .pc files
1599 local arg libs
1600
1601 # Use pkg-config if available (and works),
1602 # fallback to sed.
1603 if ${pkgconf} --exists "${pc}" &>/dev/null; then
1604 sed -e '/^Requires:/d' "${pc}" > "${tf}"
1605 libs=$(${pkgconf} --libs "${tf}")
1606 else
1607 libs=$(sed -ne 's/^Libs://p' "${pc}")
1608 fi
1609
1610 for arg in ${libs}; do
1611 if [[ ${arg} == -l* ]]; then
1612 if [[ ${arg} == '*$*' ]]; then
1613 eqawarn "${FUNCNAME}: variable substitution likely failed in ${pc}"
1614 eqawarn "(arg: ${arg})"
1615 eqawarn "Most likely, you need to add virtual/pkgconfig to DEPEND."
1616 fi
1617
1618 pc_libs+=( lib${arg#-l}.la )
1619 fi
1620 done
1621 done < <(find "${D}" -type f -name '*.pc' -print0)
1622
1623 rm -f "${tf}"
1624 fi
1625
1626 pkgconfig_scanned=1
1627 fi # pkgconfig_scanned
1628
1629 has "${f##*/}" "${pc_libs[@]}" && reason='covered by .pc'
1630 fi # removal due to .pc
1631
1632 fi # shouldnotlink==no
1633
1634 if [[ ${reason} ]]; then
1635 einfo "Removing unnecessary ${f#${D%/}} (${reason})"
1636 queue+=( "${f}" )
1637 fi
1638 done < <(find "${D}" -xtype f -name '*.la' -print0)
1639
1640 if [[ ${queue[@]} ]]; then
1641 rm -f "${queue[@]}"
1642 fi
1643 }
1644
1645 check_license() { die "you no longer need this as portage supports ACCEPT_LICENSE itself"; }
1646
1647 fi

  ViewVC Help
Powered by ViewVC 1.1.20