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

Contents of /eclass/eutils.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.422 - (show annotations) (download)
Fri Jun 21 23:52:50 2013 UTC (22 months ago) by vapier
Branch: MAIN
Changes since 1.421: +13 -1 lines
isdigit: new func for testing if args are all numbers

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

  ViewVC Help
Powered by ViewVC 1.1.20