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

Contents of /eclass/eutils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.442 - (show annotations) (download)
Wed Jan 14 22:50:02 2015 UTC (2 years, 11 months ago) by mgorny
Branch: MAIN
Changes since 1.441: +3 -3 lines
prune_libtool_files: properly reset variables for following loop iterations.

1 # Copyright 1999-2015 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.441 2014/12/30 07:24:52 williamh 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 [[ -z ${_EUTILS_ECLASS} ]]; then
19 _EUTILS_ECLASS=1
20
21 inherit multilib toolchain-funcs
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="unset_76fc3c462065bb4ca959f939e6793f94"
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} == "unset_76fc3c462065bb4ca959f939e6793f94" ]] \
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 -o 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 -p4 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 # 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 set -- "$1"/*${EPATCH_SUFFIX:+."${EPATCH_SUFFIX}"}
434 evar_pop
435
436 elif [[ -f ${EPATCH_SOURCE}/$1 ]] ; then
437 # Re-use EPATCH_SOURCE as a search dir
438 epatch "${EPATCH_SOURCE}/$1"
439 return $?
440
441 else
442 # 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 fi
452
453 # 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 local PIPE_CMD
458 case ${EPATCH_SUFFIX##*\.} in
459 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 esac
466
467 [[ ${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 # ???_arch_foo.patch
480 # Else, skip this input altogether
481 local a=${patchname#*_} # strip the ???_
482 a=${a%%_*} # strip the _foo.patch
483 if ! [[ ${SINGLE_PATCH} == "yes" || \
484 ${EPATCH_FORCE} == "yes" || \
485 ${a} == all || \
486 ${a} == ${ARCH} ]]
487 then
488 continue
489 fi
490
491 # Let people filter things dynamically
492 if [[ -n ${EPATCH_EXCLUDE}${EPATCH_USER_EXCLUDE} ]] ; then
493 # let people use globs in the exclude
494 eshopts_push -o noglob
495
496 local ex
497 for ex in ${EPATCH_EXCLUDE} ; do
498 if [[ ${patchname} == ${ex} ]] ; then
499 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 eshopts_pop
509 continue 2
510 fi
511 done
512
513 eshopts_pop
514 fi
515
516 if [[ ${SINGLE_PATCH} == "yes" ]] ; then
517 if [[ -n ${EPATCH_SINGLE_MSG} ]] ; then
518 einfo "${EPATCH_SINGLE_MSG}"
519 else
520 einfo "Applying ${patchname} ..."
521 fi
522 else
523 einfo " ${patchname} ..."
524 fi
525
526 # most of the time, there will only be one run per unique name,
527 # but if there are more, make sure we get unique log filenames
528 local STDERR_TARGET="${T}/${patchname}.out"
529 if [[ -e ${STDERR_TARGET} ]] ; then
530 STDERR_TARGET="${T}/${patchname}-$$.out"
531 fi
532
533 printf "***** %s *****\nPWD: %s\n\n" "${patchname}" "${PWD}" > "${STDERR_TARGET}"
534
535 # Decompress the patch if need be
536 local count=0
537 local PATCH_TARGET
538 if [[ -n ${PIPE_CMD} ]] ; then
539 PATCH_TARGET="${T}/$$.patch"
540 echo "PIPE_COMMAND: ${PIPE_CMD} ${x} > ${PATCH_TARGET}" >> "${STDERR_TARGET}"
541
542 if ! (${PIPE_CMD} "${x}" > "${PATCH_TARGET}") >> "${STDERR_TARGET}" 2>&1 ; then
543 echo
544 eerror "Could not extract patch!"
545 #die "Could not extract patch!"
546 count=5
547 break
548 fi
549 else
550 PATCH_TARGET=${x}
551 fi
552
553 # Check for absolute paths in patches. If sandbox is disabled,
554 # people could (accidently) patch files in the root filesystem.
555 # Or trigger other unpleasantries #237667. So disallow -p0 on
556 # such patches.
557 local abs_paths=$(egrep -n '^[-+]{3} /' "${PATCH_TARGET}" | awk '$2 != "/dev/null" { print }')
558 if [[ -n ${abs_paths} ]] ; then
559 count=1
560 printf "NOTE: skipping -p0 due to absolute paths in patch:\n%s\n" "${abs_paths}" >> "${STDERR_TARGET}"
561 fi
562 # Similar reason, but with relative paths.
563 local rel_paths=$(egrep -n '^[-+]{3} [^ ]*[.][.]/' "${PATCH_TARGET}")
564 if [[ -n ${rel_paths} ]] ; then
565 echo
566 eerror "Rejected Patch: ${patchname} !"
567 eerror " ( ${PATCH_TARGET} )"
568 eerror
569 eerror "Your patch uses relative paths '../':"
570 eerror "${rel_paths}"
571 echo
572 die "you need to fix the relative paths in patch"
573 fi
574
575 # Dynamically detect the correct -p# ... i'm lazy, so shoot me :/
576 local patch_cmd
577 # Handle aliased patch command #404447 #461568
578 local patch="patch"
579 eval $(alias patch 2>/dev/null | sed 's:^alias ::')
580 while [[ ${count} -lt 5 ]] ; do
581 patch_cmd="${patch} -p${count} ${EPATCH_OPTS}"
582
583 # Generate some useful debug info ...
584 (
585 _epatch_draw_line "***** ${patchname} *****"
586 echo
587 echo "PATCH COMMAND: ${patch_cmd} < '${PATCH_TARGET}'"
588 echo
589 _epatch_draw_line "***** ${patchname} *****"
590 ${patch_cmd} --dry-run -f < "${PATCH_TARGET}" 2>&1
591 ret=$?
592 echo
593 echo "patch program exited with status ${ret}"
594 exit ${ret}
595 ) >> "${STDERR_TARGET}"
596
597 if [ $? -eq 0 ] ; then
598 (
599 _epatch_draw_line "***** ${patchname} *****"
600 echo
601 echo "ACTUALLY APPLYING ${patchname} ..."
602 echo
603 _epatch_draw_line "***** ${patchname} *****"
604 ${patch_cmd} < "${PATCH_TARGET}" 2>&1
605 ret=$?
606 echo
607 echo "patch program exited with status ${ret}"
608 exit ${ret}
609 ) >> "${STDERR_TARGET}"
610
611 if [ $? -ne 0 ] ; then
612 echo
613 eerror "A dry-run of patch command succeeded, but actually"
614 eerror "applying the patch failed!"
615 #die "Real world sux compared to the dreamworld!"
616 count=5
617 fi
618 break
619 fi
620
621 : $(( count++ ))
622 done
623
624 # if we had to decompress the patch, delete the temp one
625 if [[ -n ${PIPE_CMD} ]] ; then
626 rm -f "${PATCH_TARGET}"
627 fi
628
629 if [[ ${count} -ge 5 ]] ; then
630 echo
631 eerror "Failed Patch: ${patchname} !"
632 eerror " ( ${PATCH_TARGET} )"
633 eerror
634 eerror "Include in your bugreport the contents of:"
635 eerror
636 eerror " ${STDERR_TARGET}"
637 echo
638 die "Failed Patch: ${patchname}!"
639 fi
640
641 # if everything worked, delete the full debug patch log
642 rm -f "${STDERR_TARGET}"
643
644 # then log away the exact stuff for people to review later
645 cat <<-EOF >> "${T}/epatch.log"
646 PATCH: ${x}
647 CMD: ${patch_cmd}
648 PWD: ${PWD}
649
650 EOF
651 eend 0
652 done
653
654 [[ ${SINGLE_PATCH} == "no" ]] && einfo "Done with patching"
655 : # everything worked
656 }
657
658 # @FUNCTION: epatch_user
659 # @USAGE:
660 # @DESCRIPTION:
661 # Applies user-provided patches to the source tree. The patches are
662 # taken from /etc/portage/patches/<CATEGORY>/<P-PR|P|PN>[:SLOT]/, where the first
663 # of these three directories to exist will be the one to use, ignoring
664 # any more general directories which might exist as well. They must end
665 # in ".patch" to be applied.
666 #
667 # User patches are intended for quick testing of patches without ebuild
668 # modifications, as well as for permanent customizations a user might
669 # desire. Obviously, there can be no official support for arbitrarily
670 # patched ebuilds. So whenever a build log in a bug report mentions that
671 # user patches were applied, the user should be asked to reproduce the
672 # problem without these.
673 #
674 # Not all ebuilds do call this function, so placing patches in the
675 # stated directory might or might not work, depending on the package and
676 # the eclasses it inherits and uses. It is safe to call the function
677 # repeatedly, so it is always possible to add a call at the ebuild
678 # level. The first call is the time when the patches will be
679 # applied.
680 #
681 # Ideally, this function should be called after gentoo-specific patches
682 # have been applied, so that their code can be modified as well, but
683 # before calls to e.g. eautoreconf, as the user patches might affect
684 # autotool input files as well.
685 epatch_user() {
686 [[ $# -ne 0 ]] && die "epatch_user takes no options"
687
688 # Allow multiple calls to this function; ignore all but the first
689 local applied="${T}/epatch_user.log"
690 [[ -e ${applied} ]] && return 2
691
692 # don't clobber any EPATCH vars that the parent might want
693 local EPATCH_SOURCE check base=${PORTAGE_CONFIGROOT%/}/etc/portage/patches
694 for check in ${CATEGORY}/{${P}-${PR},${P},${PN}}{,:${SLOT}}; do
695 EPATCH_SOURCE=${base}/${CTARGET}/${check}
696 [[ -r ${EPATCH_SOURCE} ]] || EPATCH_SOURCE=${base}/${CHOST}/${check}
697 [[ -r ${EPATCH_SOURCE} ]] || EPATCH_SOURCE=${base}/${check}
698 if [[ -d ${EPATCH_SOURCE} ]] ; then
699 EPATCH_SOURCE=${EPATCH_SOURCE} \
700 EPATCH_SUFFIX="patch" \
701 EPATCH_FORCE="yes" \
702 EPATCH_MULTI_MSG="Applying user patches from ${EPATCH_SOURCE} ..." \
703 epatch
704 echo "${EPATCH_SOURCE}" > "${applied}"
705 return 0
706 fi
707 done
708 echo "none" > "${applied}"
709 return 1
710 }
711
712 # @FUNCTION: emktemp
713 # @USAGE: [temp dir]
714 # @DESCRIPTION:
715 # Cheap replacement for when debianutils (and thus mktemp)
716 # does not exist on the users system.
717 emktemp() {
718 local exe="touch"
719 [[ $1 == -d ]] && exe="mkdir" && shift
720 local topdir=$1
721
722 if [[ -z ${topdir} ]] ; then
723 [[ -z ${T} ]] \
724 && topdir="/tmp" \
725 || topdir=${T}
726 fi
727
728 if ! type -P mktemp > /dev/null ; then
729 # system lacks `mktemp` so we have to fake it
730 local tmp=/
731 while [[ -e ${tmp} ]] ; do
732 tmp=${topdir}/tmp.${RANDOM}.${RANDOM}.${RANDOM}
733 done
734 ${exe} "${tmp}" || ${exe} -p "${tmp}"
735 echo "${tmp}"
736 else
737 # the args here will give slightly wierd names on BSD,
738 # but should produce a usable file on all userlands
739 if [[ ${exe} == "touch" ]] ; then
740 TMPDIR="${topdir}" mktemp -t tmp.XXXXXXXXXX
741 else
742 TMPDIR="${topdir}" mktemp -dt tmp.XXXXXXXXXX
743 fi
744 fi
745 }
746
747 # @FUNCTION: edos2unix
748 # @USAGE: <file> [more files ...]
749 # @DESCRIPTION:
750 # A handy replacement for dos2unix, recode, fixdos, etc... This allows you
751 # to remove all of these text utilities from DEPEND variables because this
752 # is a script based solution. Just give it a list of files to convert and
753 # they will all be changed from the DOS CRLF format to the UNIX LF format.
754 edos2unix() {
755 [[ $# -eq 0 ]] && return 0
756 sed -i 's/\r$//' -- "$@" || die
757 }
758
759 # @FUNCTION: make_desktop_entry
760 # @USAGE: make_desktop_entry(<command>, [name], [icon], [type], [fields])
761 # @DESCRIPTION:
762 # Make a .desktop file.
763 #
764 # @CODE
765 # binary: what command does the app run with ?
766 # name: the name that will show up in the menu
767 # icon: the icon to use in the menu entry
768 # this can be relative (to /usr/share/pixmaps) or
769 # a full path to an icon
770 # type: what kind of application is this?
771 # for categories:
772 # http://standards.freedesktop.org/menu-spec/latest/apa.html
773 # if unset, function tries to guess from package's category
774 # fields: extra fields to append to the desktop file; a printf string
775 # @CODE
776 make_desktop_entry() {
777 [[ -z $1 ]] && die "make_desktop_entry: You must specify the executable"
778
779 local exec=${1}
780 local name=${2:-${PN}}
781 local icon=${3:-${PN}}
782 local type=${4}
783 local fields=${5}
784
785 if [[ -z ${type} ]] ; then
786 local catmaj=${CATEGORY%%-*}
787 local catmin=${CATEGORY##*-}
788 case ${catmaj} in
789 app)
790 case ${catmin} in
791 accessibility) type="Utility;Accessibility";;
792 admin) type=System;;
793 antivirus) type=System;;
794 arch) type="Utility;Archiving";;
795 backup) type="Utility;Archiving";;
796 cdr) type="AudioVideo;DiscBurning";;
797 dicts) type="Office;Dictionary";;
798 doc) type=Documentation;;
799 editors) type="Utility;TextEditor";;
800 emacs) type="Development;TextEditor";;
801 emulation) type="System;Emulator";;
802 laptop) type="Settings;HardwareSettings";;
803 office) type=Office;;
804 pda) type="Office;PDA";;
805 vim) type="Development;TextEditor";;
806 xemacs) type="Development;TextEditor";;
807 esac
808 ;;
809
810 dev)
811 type="Development"
812 ;;
813
814 games)
815 case ${catmin} in
816 action|fps) type=ActionGame;;
817 arcade) type=ArcadeGame;;
818 board) type=BoardGame;;
819 emulation) type=Emulator;;
820 kids) type=KidsGame;;
821 puzzle) type=LogicGame;;
822 roguelike) type=RolePlaying;;
823 rpg) type=RolePlaying;;
824 simulation) type=Simulation;;
825 sports) type=SportsGame;;
826 strategy) type=StrategyGame;;
827 esac
828 type="Game;${type}"
829 ;;
830
831 gnome)
832 type="Gnome;GTK"
833 ;;
834
835 kde)
836 type="KDE;Qt"
837 ;;
838
839 mail)
840 type="Network;Email"
841 ;;
842
843 media)
844 case ${catmin} in
845 gfx)
846 type=Graphics
847 ;;
848 *)
849 case ${catmin} in
850 radio) type=Tuner;;
851 sound) type=Audio;;
852 tv) type=TV;;
853 video) type=Video;;
854 esac
855 type="AudioVideo;${type}"
856 ;;
857 esac
858 ;;
859
860 net)
861 case ${catmin} in
862 dialup) type=Dialup;;
863 ftp) type=FileTransfer;;
864 im) type=InstantMessaging;;
865 irc) type=IRCClient;;
866 mail) type=Email;;
867 news) type=News;;
868 nntp) type=News;;
869 p2p) type=FileTransfer;;
870 voip) type=Telephony;;
871 esac
872 type="Network;${type}"
873 ;;
874
875 sci)
876 case ${catmin} in
877 astro*) type=Astronomy;;
878 bio*) type=Biology;;
879 calc*) type=Calculator;;
880 chem*) type=Chemistry;;
881 elec*) type=Electronics;;
882 geo*) type=Geology;;
883 math*) type=Math;;
884 physics) type=Physics;;
885 visual*) type=DataVisualization;;
886 esac
887 type="Education;Science;${type}"
888 ;;
889
890 sys)
891 type="System"
892 ;;
893
894 www)
895 case ${catmin} in
896 client) type=WebBrowser;;
897 esac
898 type="Network;${type}"
899 ;;
900
901 *)
902 type=
903 ;;
904 esac
905 fi
906 local slot=${SLOT%/*}
907 if [[ ${slot} == "0" ]] ; then
908 local desktop_name="${PN}"
909 else
910 local desktop_name="${PN}-${slot}"
911 fi
912 local desktop="${T}/$(echo ${exec} | sed 's:[[:space:]/:]:_:g')-${desktop_name}.desktop"
913 #local desktop=${T}/${exec%% *:-${desktop_name}}.desktop
914
915 # Don't append another ";" when a valid category value is provided.
916 type=${type%;}${type:+;}
917
918 eshopts_push -s extglob
919 if [[ -n ${icon} && ${icon} != /* ]] && [[ ${icon} == *.xpm || ${icon} == *.png || ${icon} == *.svg ]]; then
920 ewarn "As described in the Icon Theme Specification, icon file extensions are not"
921 ewarn "allowed in .desktop files if the value is not an absolute path."
922 icon=${icon%.@(xpm|png|svg)}
923 fi
924 eshopts_pop
925
926 cat <<-EOF > "${desktop}"
927 [Desktop Entry]
928 Name=${name}
929 Type=Application
930 Comment=${DESCRIPTION}
931 Exec=${exec}
932 TryExec=${exec%% *}
933 Icon=${icon}
934 Categories=${type}
935 EOF
936
937 if [[ ${fields:-=} != *=* ]] ; then
938 # 5th arg used to be value to Path=
939 ewarn "make_desktop_entry: update your 5th arg to read Path=${fields}"
940 fields="Path=${fields}"
941 fi
942 [[ -n ${fields} ]] && printf '%b\n' "${fields}" >> "${desktop}"
943
944 (
945 # wrap the env here so that the 'insinto' call
946 # doesn't corrupt the env of the caller
947 insinto /usr/share/applications
948 doins "${desktop}"
949 ) || die "installing desktop file failed"
950 }
951
952 # @FUNCTION: _eutils_eprefix_init
953 # @INTERNAL
954 # @DESCRIPTION:
955 # Initialized prefix variables for EAPI<3.
956 _eutils_eprefix_init() {
957 has "${EAPI:-0}" 0 1 2 && : ${ED:=${D}} ${EPREFIX:=} ${EROOT:=${ROOT}}
958 }
959
960 # @FUNCTION: validate_desktop_entries
961 # @USAGE: [directories]
962 # @MAINTAINER:
963 # Carsten Lohrke <carlo@gentoo.org>
964 # @DESCRIPTION:
965 # Validate desktop entries using desktop-file-utils
966 validate_desktop_entries() {
967 _eutils_eprefix_init
968 if [[ -x "${EPREFIX}"/usr/bin/desktop-file-validate ]] ; then
969 einfo "Checking desktop entry validity"
970 local directories=""
971 for d in /usr/share/applications $@ ; do
972 [[ -d ${ED}${d} ]] && directories="${directories} ${ED}${d}"
973 done
974 if [[ -n ${directories} ]] ; then
975 for FILE in $(find ${directories} -name "*\.desktop" \
976 -not -path '*.hidden*' | sort -u 2>/dev/null)
977 do
978 local temp=$(desktop-file-validate ${FILE} | grep -v "warning:" | \
979 sed -e "s|error: ||" -e "s|${FILE}:|--|g" )
980 [[ -n $temp ]] && elog ${temp/--/${FILE/${ED}/}:}
981 done
982 fi
983 echo ""
984 else
985 einfo "Passing desktop entry validity check. Install dev-util/desktop-file-utils, if you want to help to improve Gentoo."
986 fi
987 }
988
989 # @FUNCTION: make_session_desktop
990 # @USAGE: <title> <command> [command args...]
991 # @DESCRIPTION:
992 # Make a GDM/KDM Session file. The title is the file to execute to start the
993 # Window Manager. The command is the name of the Window Manager.
994 #
995 # You can set the name of the file via the ${wm} variable.
996 make_session_desktop() {
997 [[ -z $1 ]] && eerror "$0: You must specify the title" && return 1
998 [[ -z $2 ]] && eerror "$0: You must specify the command" && return 1
999
1000 local title=$1
1001 local command=$2
1002 local desktop=${T}/${wm:-${PN}}.desktop
1003 shift 2
1004
1005 cat <<-EOF > "${desktop}"
1006 [Desktop Entry]
1007 Name=${title}
1008 Comment=This session logs you into ${title}
1009 Exec=${command} $*
1010 TryExec=${command}
1011 Type=XSession
1012 EOF
1013
1014 (
1015 # wrap the env here so that the 'insinto' call
1016 # doesn't corrupt the env of the caller
1017 insinto /usr/share/xsessions
1018 doins "${desktop}"
1019 )
1020 }
1021
1022 # @FUNCTION: domenu
1023 # @USAGE: <menus>
1024 # @DESCRIPTION:
1025 # Install the list of .desktop menu files into the appropriate directory
1026 # (/usr/share/applications).
1027 domenu() {
1028 (
1029 # wrap the env here so that the 'insinto' call
1030 # doesn't corrupt the env of the caller
1031 local i j ret=0
1032 insinto /usr/share/applications
1033 for i in "$@" ; do
1034 if [[ -f ${i} ]] ; then
1035 doins "${i}"
1036 ((ret+=$?))
1037 elif [[ -d ${i} ]] ; then
1038 for j in "${i}"/*.desktop ; do
1039 doins "${j}"
1040 ((ret+=$?))
1041 done
1042 else
1043 ((++ret))
1044 fi
1045 done
1046 exit ${ret}
1047 )
1048 }
1049
1050 # @FUNCTION: newmenu
1051 # @USAGE: <menu> <newname>
1052 # @DESCRIPTION:
1053 # Like all other new* functions, install the specified menu as newname.
1054 newmenu() {
1055 (
1056 # wrap the env here so that the 'insinto' call
1057 # doesn't corrupt the env of the caller
1058 insinto /usr/share/applications
1059 newins "$@"
1060 )
1061 }
1062
1063 # @FUNCTION: _iconins
1064 # @INTERNAL
1065 # @DESCRIPTION:
1066 # function for use in doicon and newicon
1067 _iconins() {
1068 (
1069 # wrap the env here so that the 'insinto' call
1070 # doesn't corrupt the env of the caller
1071 local funcname=$1; shift
1072 local size dir
1073 local context=apps
1074 local theme=hicolor
1075
1076 while [[ $# -gt 0 ]] ; do
1077 case $1 in
1078 -s|--size)
1079 if [[ ${2%%x*}x${2%%x*} == "$2" ]] ; then
1080 size=${2%%x*}
1081 else
1082 size=${2}
1083 fi
1084 case ${size} in
1085 16|22|24|32|36|48|64|72|96|128|192|256|512)
1086 size=${size}x${size};;
1087 scalable)
1088 ;;
1089 *)
1090 eerror "${size} is an unsupported icon size!"
1091 exit 1;;
1092 esac
1093 shift 2;;
1094 -t|--theme)
1095 theme=${2}
1096 shift 2;;
1097 -c|--context)
1098 context=${2}
1099 shift 2;;
1100 *)
1101 if [[ -z ${size} ]] ; then
1102 insinto /usr/share/pixmaps
1103 else
1104 insinto /usr/share/icons/${theme}/${size}/${context}
1105 fi
1106
1107 if [[ ${funcname} == doicon ]] ; then
1108 if [[ -f $1 ]] ; then
1109 doins "${1}"
1110 elif [[ -d $1 ]] ; then
1111 shopt -s nullglob
1112 doins "${1}"/*.{png,svg}
1113 shopt -u nullglob
1114 else
1115 eerror "${1} is not a valid file/directory!"
1116 exit 1
1117 fi
1118 else
1119 break
1120 fi
1121 shift 1;;
1122 esac
1123 done
1124 if [[ ${funcname} == newicon ]] ; then
1125 newins "$@"
1126 fi
1127 ) || die
1128 }
1129
1130 # @FUNCTION: doicon
1131 # @USAGE: [options] <icons>
1132 # @DESCRIPTION:
1133 # Install icon into the icon directory /usr/share/icons or into
1134 # /usr/share/pixmaps if "--size" is not set.
1135 # This is useful in conjunction with creating desktop/menu files.
1136 #
1137 # @CODE
1138 # options:
1139 # -s, --size
1140 # !!! must specify to install into /usr/share/icons/... !!!
1141 # size of the icon, like 48 or 48x48
1142 # supported icon sizes are:
1143 # 16 22 24 32 36 48 64 72 96 128 192 256 scalable
1144 # -c, --context
1145 # defaults to "apps"
1146 # -t, --theme
1147 # defaults to "hicolor"
1148 #
1149 # icons: list of icons
1150 #
1151 # example 1: doicon foobar.png fuqbar.svg suckbar.png
1152 # results in: insinto /usr/share/pixmaps
1153 # doins foobar.png fuqbar.svg suckbar.png
1154 #
1155 # example 2: doicon -s 48 foobar.png fuqbar.png blobbar.png
1156 # results in: insinto /usr/share/icons/hicolor/48x48/apps
1157 # doins foobar.png fuqbar.png blobbar.png
1158 # @CODE
1159 doicon() {
1160 _iconins ${FUNCNAME} "$@"
1161 }
1162
1163 # @FUNCTION: newicon
1164 # @USAGE: [options] <icon> <newname>
1165 # @DESCRIPTION:
1166 # Like doicon, install the specified icon as newname.
1167 #
1168 # @CODE
1169 # example 1: newicon foobar.png NEWNAME.png
1170 # results in: insinto /usr/share/pixmaps
1171 # newins foobar.png NEWNAME.png
1172 #
1173 # example 2: newicon -s 48 foobar.png NEWNAME.png
1174 # results in: insinto /usr/share/icons/hicolor/48x48/apps
1175 # newins foobar.png NEWNAME.png
1176 # @CODE
1177 newicon() {
1178 _iconins ${FUNCNAME} "$@"
1179 }
1180
1181 # @FUNCTION: strip-linguas
1182 # @USAGE: [<allow LINGUAS>|<-i|-u> <directories of .po files>]
1183 # @DESCRIPTION:
1184 # Make sure that LINGUAS only contains languages that
1185 # a package can support. The first form allows you to
1186 # specify a list of LINGUAS. The -i builds a list of po
1187 # files found in all the directories and uses the
1188 # intersection of the lists. The -u builds a list of po
1189 # files found in all the directories and uses the union
1190 # of the lists.
1191 strip-linguas() {
1192 local ls newls nols
1193 if [[ $1 == "-i" ]] || [[ $1 == "-u" ]] ; then
1194 local op=$1; shift
1195 ls=$(find "$1" -name '*.po' -exec basename {} .po ';'); shift
1196 local d f
1197 for d in "$@" ; do
1198 if [[ ${op} == "-u" ]] ; then
1199 newls=${ls}
1200 else
1201 newls=""
1202 fi
1203 for f in $(find "$d" -name '*.po' -exec basename {} .po ';') ; do
1204 if [[ ${op} == "-i" ]] ; then
1205 has ${f} ${ls} && newls="${newls} ${f}"
1206 else
1207 has ${f} ${ls} || newls="${newls} ${f}"
1208 fi
1209 done
1210 ls=${newls}
1211 done
1212 else
1213 ls="$@"
1214 fi
1215
1216 nols=""
1217 newls=""
1218 for f in ${LINGUAS} ; do
1219 if has ${f} ${ls} ; then
1220 newls="${newls} ${f}"
1221 else
1222 nols="${nols} ${f}"
1223 fi
1224 done
1225 [[ -n ${nols} ]] \
1226 && einfo "Sorry, but ${PN} does not support the LINGUAS:" ${nols}
1227 export LINGUAS=${newls:1}
1228 }
1229
1230 # @FUNCTION: preserve_old_lib
1231 # @USAGE: <libs to preserve> [more libs]
1232 # @DESCRIPTION:
1233 # These functions are useful when a lib in your package changes ABI SONAME.
1234 # An example might be from libogg.so.0 to libogg.so.1. Removing libogg.so.0
1235 # would break packages that link against it. Most people get around this
1236 # by using the portage SLOT mechanism, but that is not always a relevant
1237 # solution, so instead you can call this from pkg_preinst. See also the
1238 # preserve_old_lib_notify function.
1239 preserve_old_lib() {
1240 _eutils_eprefix_init
1241 if [[ ${EBUILD_PHASE} != "preinst" ]] ; then
1242 eerror "preserve_old_lib() must be called from pkg_preinst() only"
1243 die "Invalid preserve_old_lib() usage"
1244 fi
1245 [[ -z $1 ]] && die "Usage: preserve_old_lib <library to preserve> [more libraries to preserve]"
1246
1247 # let portage worry about it
1248 has preserve-libs ${FEATURES} && return 0
1249
1250 local lib dir
1251 for lib in "$@" ; do
1252 [[ -e ${EROOT}/${lib} ]] || continue
1253 dir=${lib%/*}
1254 dodir ${dir} || die "dodir ${dir} failed"
1255 cp "${EROOT}"/${lib} "${ED}"/${lib} || die "cp ${lib} failed"
1256 touch "${ED}"/${lib}
1257 done
1258 }
1259
1260 # @FUNCTION: preserve_old_lib_notify
1261 # @USAGE: <libs to notify> [more libs]
1262 # @DESCRIPTION:
1263 # Spit helpful messages about the libraries preserved by preserve_old_lib.
1264 preserve_old_lib_notify() {
1265 if [[ ${EBUILD_PHASE} != "postinst" ]] ; then
1266 eerror "preserve_old_lib_notify() must be called from pkg_postinst() only"
1267 die "Invalid preserve_old_lib_notify() usage"
1268 fi
1269
1270 # let portage worry about it
1271 has preserve-libs ${FEATURES} && return 0
1272
1273 _eutils_eprefix_init
1274
1275 local lib notice=0
1276 for lib in "$@" ; do
1277 [[ -e ${EROOT}/${lib} ]] || continue
1278 if [[ ${notice} -eq 0 ]] ; then
1279 notice=1
1280 ewarn "Old versions of installed libraries were detected on your system."
1281 ewarn "In order to avoid breaking packages that depend on these old libs,"
1282 ewarn "the libraries are not being removed. You need to run revdep-rebuild"
1283 ewarn "in order to remove these old dependencies. If you do not have this"
1284 ewarn "helper program, simply emerge the 'gentoolkit' package."
1285 ewarn
1286 fi
1287 ewarn " # revdep-rebuild --library '${lib}' && rm '${lib}'"
1288 done
1289 }
1290
1291 # @FUNCTION: built_with_use
1292 # @USAGE: [--hidden] [--missing <action>] [-a|-o] <DEPEND ATOM> <List of USE flags>
1293 # @DESCRIPTION:
1294 #
1295 # Deprecated: Use EAPI 2 use deps in DEPEND|RDEPEND and with has_version calls.
1296 #
1297 # A temporary hack until portage properly supports DEPENDing on USE
1298 # flags being enabled in packages. This will check to see if the specified
1299 # DEPEND atom was built with the specified list of USE flags. The
1300 # --missing option controls the behavior if called on a package that does
1301 # not actually support the defined USE flags (aka listed in IUSE).
1302 # The default is to abort (call die). The -a and -o flags control
1303 # the requirements of the USE flags. They correspond to "and" and "or"
1304 # logic. So the -a flag means all listed USE flags must be enabled
1305 # while the -o flag means at least one of the listed IUSE flags must be
1306 # enabled. The --hidden option is really for internal use only as it
1307 # means the USE flag we're checking is hidden expanded, so it won't be found
1308 # in IUSE like normal USE flags.
1309 #
1310 # Remember that this function isn't terribly intelligent so order of optional
1311 # flags matter.
1312 built_with_use() {
1313 _eutils_eprefix_init
1314 local hidden="no"
1315 if [[ $1 == "--hidden" ]] ; then
1316 hidden="yes"
1317 shift
1318 fi
1319
1320 local missing_action="die"
1321 if [[ $1 == "--missing" ]] ; then
1322 missing_action=$2
1323 shift ; shift
1324 case ${missing_action} in
1325 true|false|die) ;;
1326 *) die "unknown action '${missing_action}'";;
1327 esac
1328 fi
1329
1330 local opt=$1
1331 [[ ${opt:0:1} = "-" ]] && shift || opt="-a"
1332
1333 local PKG=$(best_version $1)
1334 [[ -z ${PKG} ]] && die "Unable to resolve $1 to an installed package"
1335 shift
1336
1337 local USEFILE=${EROOT}/var/db/pkg/${PKG}/USE
1338 local IUSEFILE=${EROOT}/var/db/pkg/${PKG}/IUSE
1339
1340 # if the IUSE file doesn't exist, the read will error out, we need to handle
1341 # this gracefully
1342 if [[ ! -e ${USEFILE} ]] || [[ ! -e ${IUSEFILE} && ${hidden} == "no" ]] ; then
1343 case ${missing_action} in
1344 true) return 0;;
1345 false) return 1;;
1346 die) die "Unable to determine what USE flags $PKG was built with";;
1347 esac
1348 fi
1349
1350 if [[ ${hidden} == "no" ]] ; then
1351 local IUSE_BUILT=( $(<"${IUSEFILE}") )
1352 # Don't check USE_EXPAND #147237
1353 local expand
1354 for expand in $(echo ${USE_EXPAND} | tr '[:upper:]' '[:lower:]') ; do
1355 if [[ $1 == ${expand}_* ]] ; then
1356 expand=""
1357 break
1358 fi
1359 done
1360 if [[ -n ${expand} ]] ; then
1361 if ! has $1 ${IUSE_BUILT[@]#[-+]} ; then
1362 case ${missing_action} in
1363 true) return 0;;
1364 false) return 1;;
1365 die) die "$PKG does not actually support the $1 USE flag!";;
1366 esac
1367 fi
1368 fi
1369 fi
1370
1371 local USE_BUILT=$(<${USEFILE})
1372 while [[ $# -gt 0 ]] ; do
1373 if [[ ${opt} = "-o" ]] ; then
1374 has $1 ${USE_BUILT} && return 0
1375 else
1376 has $1 ${USE_BUILT} || return 1
1377 fi
1378 shift
1379 done
1380 [[ ${opt} = "-a" ]]
1381 }
1382
1383 # @FUNCTION: epunt_cxx
1384 # @USAGE: [dir to scan]
1385 # @DESCRIPTION:
1386 # Many configure scripts wrongly bail when a C++ compiler could not be
1387 # detected. If dir is not specified, then it defaults to ${S}.
1388 #
1389 # http://bugs.gentoo.org/73450
1390 epunt_cxx() {
1391 local dir=$1
1392 [[ -z ${dir} ]] && dir=${S}
1393 ebegin "Removing useless C++ checks"
1394 local f p any_found
1395 while IFS= read -r -d '' f; do
1396 for p in "${PORTDIR}"/eclass/ELT-patches/nocxx/*.patch ; do
1397 if patch --no-backup-if-mismatch -p1 "${f}" "${p}" >/dev/null ; then
1398 any_found=1
1399 break
1400 fi
1401 done
1402 done < <(find "${dir}" -name configure -print0)
1403
1404 if [[ -z ${any_found} ]]; then
1405 eqawarn "epunt_cxx called unnecessarily (no C++ checks to punt)."
1406 fi
1407 eend 0
1408 }
1409
1410 # @FUNCTION: make_wrapper
1411 # @USAGE: <wrapper> <target> [chdir] [libpaths] [installpath]
1412 # @DESCRIPTION:
1413 # Create a shell wrapper script named wrapper in installpath
1414 # (defaults to the bindir) to execute target (default of wrapper) by
1415 # first optionally setting LD_LIBRARY_PATH to the colon-delimited
1416 # libpaths followed by optionally changing directory to chdir.
1417 make_wrapper() {
1418 _eutils_eprefix_init
1419 local wrapper=$1 bin=$2 chdir=$3 libdir=$4 path=$5
1420 local tmpwrapper=$(emktemp)
1421
1422 (
1423 echo '#!/bin/sh'
1424 [[ -n ${chdir} ]] && printf 'cd "%s"\n' "${EPREFIX}${chdir}"
1425 if [[ -n ${libdir} ]] ; then
1426 local var
1427 if [[ ${CHOST} == *-darwin* ]] ; then
1428 var=DYLD_LIBRARY_PATH
1429 else
1430 var=LD_LIBRARY_PATH
1431 fi
1432 cat <<-EOF
1433 if [ "\${${var}+set}" = "set" ] ; then
1434 export ${var}="\${${var}}:${EPREFIX}${libdir}"
1435 else
1436 export ${var}="${EPREFIX}${libdir}"
1437 fi
1438 EOF
1439 fi
1440 # We don't want to quote ${bin} so that people can pass complex
1441 # things as ${bin} ... "./someprog --args"
1442 printf 'exec %s "$@"\n' "${bin/#\//${EPREFIX}/}"
1443 ) > "${tmpwrapper}"
1444 chmod go+rx "${tmpwrapper}"
1445
1446 if [[ -n ${path} ]] ; then
1447 (
1448 exeinto "${path}"
1449 newexe "${tmpwrapper}" "${wrapper}"
1450 ) || die
1451 else
1452 newbin "${tmpwrapper}" "${wrapper}" || die
1453 fi
1454 }
1455
1456 # @FUNCTION: path_exists
1457 # @USAGE: [-a|-o] <paths>
1458 # @DESCRIPTION:
1459 # Check if the specified paths exist. Works for all types of paths
1460 # (files/dirs/etc...). The -a and -o flags control the requirements
1461 # of the paths. They correspond to "and" and "or" logic. So the -a
1462 # flag means all the paths must exist while the -o flag means at least
1463 # one of the paths must exist. The default behavior is "and". If no
1464 # paths are specified, then the return value is "false".
1465 path_exists() {
1466 local opt=$1
1467 [[ ${opt} == -[ao] ]] && shift || opt="-a"
1468
1469 # no paths -> return false
1470 # same behavior as: [[ -e "" ]]
1471 [[ $# -eq 0 ]] && return 1
1472
1473 local p r=0
1474 for p in "$@" ; do
1475 [[ -e ${p} ]]
1476 : $(( r += $? ))
1477 done
1478
1479 case ${opt} in
1480 -a) return $(( r != 0 )) ;;
1481 -o) return $(( r == $# )) ;;
1482 esac
1483 }
1484
1485 # @FUNCTION: in_iuse
1486 # @USAGE: <flag>
1487 # @DESCRIPTION:
1488 # Determines whether the given flag is in IUSE. Strips IUSE default prefixes
1489 # as necessary.
1490 #
1491 # Note that this function should not be used in the global scope.
1492 in_iuse() {
1493 debug-print-function ${FUNCNAME} "${@}"
1494 [[ ${#} -eq 1 ]] || die "Invalid args to ${FUNCNAME}()"
1495
1496 local flag=${1}
1497 local liuse=( ${IUSE} )
1498
1499 has "${flag}" "${liuse[@]#[+-]}"
1500 }
1501
1502 # @FUNCTION: use_if_iuse
1503 # @USAGE: <flag>
1504 # @DESCRIPTION:
1505 # Return true if the given flag is in USE and IUSE.
1506 #
1507 # Note that this function should not be used in the global scope.
1508 use_if_iuse() {
1509 in_iuse $1 || return 1
1510 use $1
1511 }
1512
1513 # @FUNCTION: usex
1514 # @USAGE: <USE flag> [true output] [false output] [true suffix] [false suffix]
1515 # @DESCRIPTION:
1516 # Proxy to declare usex for package managers or EAPIs that do not provide it
1517 # and use the package manager implementation when available (i.e. EAPI >= 5).
1518 # If USE flag is set, echo [true output][true suffix] (defaults to "yes"),
1519 # otherwise echo [false output][false suffix] (defaults to "no").
1520 if has "${EAPI:-0}" 0 1 2 3 4; then
1521 usex() { use "$1" && echo "${2-yes}$4" || echo "${3-no}$5" ; } #382963
1522 fi
1523
1524 # @FUNCTION: prune_libtool_files
1525 # @USAGE: [--all|--modules]
1526 # @DESCRIPTION:
1527 # Locate unnecessary libtool files (.la) and libtool static archives
1528 # (.a) and remove them from installation image.
1529 #
1530 # By default, .la files are removed whenever the static linkage can
1531 # either be performed using pkg-config or doesn't introduce additional
1532 # flags.
1533 #
1534 # If '--modules' argument is passed, .la files for modules (plugins) are
1535 # removed as well. This is usually useful when the package installs
1536 # plugins and the plugin loader does not use .la files.
1537 #
1538 # If '--all' argument is passed, all .la files are removed without
1539 # performing any heuristic on them. You shouldn't ever use that,
1540 # and instead report a bug in the algorithm instead.
1541 #
1542 # The .a files are only removed whenever corresponding .la files state
1543 # that they should not be linked to, i.e. whenever these files
1544 # correspond to plugins.
1545 #
1546 # Note: if your package installs both static libraries and .pc files
1547 # which use variable substitution for -l flags, you need to add
1548 # pkg-config to your DEPEND.
1549 prune_libtool_files() {
1550 debug-print-function ${FUNCNAME} "$@"
1551
1552 local removing_all removing_modules opt
1553 _eutils_eprefix_init
1554 for opt; do
1555 case "${opt}" in
1556 --all)
1557 removing_all=1
1558 removing_modules=1
1559 ;;
1560 --modules)
1561 removing_modules=1
1562 ;;
1563 *)
1564 die "Invalid argument to ${FUNCNAME}(): ${opt}"
1565 esac
1566 done
1567
1568 local f
1569 local queue=()
1570 while IFS= read -r -d '' f; do # for all .la files
1571 local archivefile=${f/%.la/.a}
1572
1573 # The following check is done by libtool itself.
1574 # It helps us avoid removing random files which match '*.la',
1575 # see bug #468380.
1576 if ! sed -n -e '/^# Generated by .*libtool/q0;4q1' "${f}"; then
1577 continue
1578 fi
1579
1580 [[ ${f} != ${archivefile} ]] || die 'regex sanity check failed'
1581 local reason= pkgconfig_scanned=
1582 local snotlink=$(sed -n -e 's:^shouldnotlink=::p' "${f}")
1583
1584 if [[ ${snotlink} == yes ]]; then
1585
1586 # Remove static libs we're not supposed to link against.
1587 if [[ -f ${archivefile} ]]; then
1588 einfo "Removing unnecessary ${archivefile#${D%/}} (static plugin)"
1589 queue+=( "${archivefile}" )
1590 fi
1591
1592 # The .la file may be used by a module loader, so avoid removing it
1593 # unless explicitly requested.
1594 if [[ ${removing_modules} ]]; then
1595 reason='module'
1596 fi
1597
1598 else
1599
1600 # Remove .la files when:
1601 # - user explicitly wants us to remove all .la files,
1602 # - respective static archive doesn't exist,
1603 # - they are covered by a .pc file already,
1604 # - they don't provide any new information (no libs & no flags).
1605
1606 if [[ ${removing_all} ]]; then
1607 reason='requested'
1608 elif [[ ! -f ${archivefile} ]]; then
1609 reason='no static archive'
1610 elif [[ ! $(sed -nre \
1611 "s/^(dependency_libs|inherited_linker_flags)='(.*)'$/\2/p" \
1612 "${f}") ]]; then
1613 reason='no libs & flags'
1614 else
1615 if [[ ! ${pkgconfig_scanned} ]]; then
1616 # Create a list of all .pc-covered libs.
1617 local pc_libs=()
1618 if [[ ! ${removing_all} ]]; then
1619 local pc
1620 local tf=${T}/prune-lt-files.pc
1621 local pkgconf=$(tc-getPKG_CONFIG)
1622
1623 while IFS= read -r -d '' pc; do # for all .pc files
1624 local arg libs
1625
1626 # Use pkg-config if available (and works),
1627 # fallback to sed.
1628 if ${pkgconf} --exists "${pc}" &>/dev/null; then
1629 sed -e '/^Requires:/d' "${pc}" > "${tf}"
1630 libs=$(${pkgconf} --libs "${tf}")
1631 else
1632 libs=$(sed -ne 's/^Libs://p' "${pc}")
1633 fi
1634
1635 for arg in ${libs}; do
1636 if [[ ${arg} == -l* ]]; then
1637 if [[ ${arg} == '*$*' ]]; then
1638 eqawarn "${FUNCNAME}: variable substitution likely failed in ${pc}"
1639 eqawarn "(arg: ${arg})"
1640 eqawarn "Most likely, you need to add virtual/pkgconfig to DEPEND."
1641 fi
1642
1643 pc_libs+=( lib${arg#-l}.la )
1644 fi
1645 done
1646 done < <(find "${D}" -type f -name '*.pc' -print0)
1647
1648 rm -f "${tf}"
1649 fi
1650
1651 pkgconfig_scanned=1
1652 fi # pkgconfig_scanned
1653
1654 has "${f##*/}" "${pc_libs[@]}" && reason='covered by .pc'
1655 fi # removal due to .pc
1656
1657 fi # shouldnotlink==no
1658
1659 if [[ ${reason} ]]; then
1660 einfo "Removing unnecessary ${f#${D%/}} (${reason})"
1661 queue+=( "${f}" )
1662 fi
1663 done < <(find "${ED}" -xtype f -name '*.la' -print0)
1664
1665 if [[ ${queue[@]} ]]; then
1666 rm -f "${queue[@]}"
1667 fi
1668 }
1669
1670 # @FUNCTION: einstalldocs
1671 # @DESCRIPTION:
1672 # Install documentation using DOCS and HTML_DOCS.
1673 #
1674 # If DOCS is declared and non-empty, all files listed in it are
1675 # installed. The files must exist, otherwise the function will fail.
1676 # In EAPI 4 and subsequent EAPIs DOCS may specify directories as well,
1677 # in other EAPIs using directories is unsupported.
1678 #
1679 # If DOCS is not declared, the files matching patterns given
1680 # in the default EAPI implementation of src_install will be installed.
1681 # If this is undesired, DOCS can be set to empty value to prevent any
1682 # documentation from being installed.
1683 #
1684 # If HTML_DOCS is declared and non-empty, all files and/or directories
1685 # listed in it are installed as HTML docs (using dohtml).
1686 #
1687 # Both DOCS and HTML_DOCS can either be an array or a whitespace-
1688 # separated list. Whenever directories are allowed, '<directory>/.' may
1689 # be specified in order to install all files within the directory
1690 # without creating a sub-directory in docdir.
1691 #
1692 # Passing additional options to dodoc and dohtml is not supported.
1693 # If you needed such a thing, you need to call those helpers explicitly.
1694 einstalldocs() {
1695 debug-print-function ${FUNCNAME} "${@}"
1696
1697 local dodoc_opts=-r
1698 has ${EAPI} 0 1 2 3 && dodoc_opts=
1699
1700 if ! declare -p DOCS &>/dev/null ; then
1701 local d
1702 for d in README* ChangeLog AUTHORS NEWS TODO CHANGES \
1703 THANKS BUGS FAQ CREDITS CHANGELOG ; do
1704 if [[ -s ${d} ]] ; then
1705 dodoc "${d}" || die
1706 fi
1707 done
1708 elif [[ $(declare -p DOCS) == "declare -a"* ]] ; then
1709 if [[ ${DOCS[@]} ]] ; then
1710 dodoc ${dodoc_opts} "${DOCS[@]}" || die
1711 fi
1712 else
1713 if [[ ${DOCS} ]] ; then
1714 dodoc ${dodoc_opts} ${DOCS} || die
1715 fi
1716 fi
1717
1718 if [[ $(declare -p HTML_DOCS 2>/dev/null) == "declare -a"* ]] ; then
1719 if [[ ${HTML_DOCS[@]} ]] ; then
1720 dohtml -r "${HTML_DOCS[@]}" || die
1721 fi
1722 else
1723 if [[ ${HTML_DOCS} ]] ; then
1724 dohtml -r ${HTML_DOCS} || die
1725 fi
1726 fi
1727
1728 return 0
1729 }
1730
1731 check_license() { die "you no longer need this as portage supports ACCEPT_LICENSE itself"; }
1732
1733 # @FUNCTION: optfeature
1734 # @USAGE: <short description> <package atom to match> [other atoms]
1735 # @DESCRIPTION:
1736 # Print out a message suggesting an optional package (or packages) which
1737 # provide the described functionality
1738 #
1739 # The following snippet would suggest app-misc/foo for optional foo support,
1740 # app-misc/bar or app-misc/baz[bar] for optional bar support
1741 # and either both app-misc/a and app-misc/b or app-misc/c for alphabet support.
1742 # @CODE
1743 # optfeature "foo support" app-misc/foo
1744 # optfeature "bar support" app-misc/bar app-misc/baz[bar]
1745 # optfeature "alphabet support" "app-misc/a app-misc/b" app-misc/c
1746 # @CODE
1747 optfeature() {
1748 debug-print-function ${FUNCNAME} "$@"
1749 local i j msg
1750 local desc=$1
1751 local flag=0
1752 shift
1753 for i; do
1754 for j in ${i}; do
1755 if has_version "${j}"; then
1756 flag=1
1757 else
1758 flag=0
1759 break
1760 fi
1761 done
1762 if [[ ${flag} -eq 1 ]]; then
1763 break
1764 fi
1765 done
1766 if [[ ${flag} -eq 0 ]]; then
1767 for i; do
1768 msg=" "
1769 for j in ${i}; do
1770 msg+=" ${j} and"
1771 done
1772 msg="${msg:0: -4} for ${desc}"
1773 elog "${msg}"
1774 done
1775 fi
1776 }
1777
1778 fi

  ViewVC Help
Powered by ViewVC 1.1.20