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

Contents of /eclass/eutils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.419 - (show annotations) (download)
Tue May 21 02:57:22 2013 UTC (17 months, 1 week ago) by vapier
Branch: MAIN
Changes since 1.418: +9 -4 lines
epatch: turn qa warning to hard failure w/relative paths in patches as people have had over 2 years to clean things up

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

  ViewVC Help
Powered by ViewVC 1.1.20