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

Diff of /eclass/eutils.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.279 Revision 1.314
1# Copyright 1999-2006 Gentoo Foundation 1# Copyright 1999-2007 Gentoo Foundation
2# Distributed under the terms of the GNU General Public License v2 2# Distributed under the terms of the GNU General Public License v2
3# $Header: /var/cvsroot/gentoo-x86/eclass/eutils.eclass,v 1.279 2007/04/25 09:14:35 carlo Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/eutils.eclass,v 1.314 2009/02/21 07:35:14 vapier Exp $
4
5# @ECLASS: eutils.eclass
6# @MAINTAINER:
7# base-system@gentoo.org
8# @BLURB: many extra (but common) functions that are used in ebuilds
9# @DESCRIPTION:
10# The eutils eclass contains a suite of functions that complement
11# the ones that ebuild.sh already contain. The idea is that the functions
12# are not required in all ebuilds but enough utilize them to have a common
13# home rather than having multiple ebuilds implementing the same thing.
4# 14#
5# This eclass is for general purpose functions that most ebuilds 15# Due to the nature of this eclass, some functions may have maintainers
6# have to implement themselves. 16# different from the overall eclass!
7#
8# NB: If you add anything, please comment it!
9#
10# Maintainer: see each individual function, base-system@gentoo.org as default
11 17
12inherit multilib portability 18inherit multilib portability
13 19
14DESCRIPTION="Based on the ${ECLASS} eclass" 20DESCRIPTION="Based on the ${ECLASS} eclass"
15 21
16# Wait for the supplied number of seconds. If no argument is supplied, defaults 22# @FUNCTION: epause
17# to five seconds. If the EPAUSE_IGNORE env var is set, don't wait. If we're not 23# @USAGE: [seconds]
18# outputting to a terminal, don't wait. For compatability purposes, the argument 24# @DESCRIPTION:
19# must be an integer greater than zero. 25# Sleep for the specified number of seconds (default of 5 seconds). Useful when
20# Bug 62950, Ciaran McCreesh <ciaranm@gentoo.org> (05 Sep 2004) 26# printing a message the user should probably be reading and often used in
27# conjunction with the ebeep function. If the EPAUSE_IGNORE env var is set,
28# don't wait at all.
21epause() { 29epause() {
22 [[ -z ${EPAUSE_IGNORE} ]] && sleep ${1:-5} 30 [[ -z ${EPAUSE_IGNORE} ]] && sleep ${1:-5}
23} 31}
24 32
25# Beep the specified number of times (defaults to five). If our output 33# @FUNCTION: ebeep
26# is not a terminal, don't beep. If the EBEEP_IGNORE env var is set, 34# @USAGE: [number of beeps]
35# @DESCRIPTION:
36# Issue the specified number of beeps (default of 5 beeps). Useful when
37# printing a message the user should probably be reading and often used in
38# conjunction with the epause function. If the EBEEP_IGNORE env var is set,
27# don't beep. 39# don't beep at all.
28# Bug 62950, Ciaran McCreesh <ciaranm@gentoo.org> (05 Sep 2004)
29ebeep() { 40ebeep() {
30 local n 41 local n
31 if [[ -z ${EBEEP_IGNORE} ]] ; then 42 if [[ -z ${EBEEP_IGNORE} ]] ; then
32 for ((n=1 ; n <= ${1:-5} ; n++)) ; do 43 for ((n=1 ; n <= ${1:-5} ; n++)) ; do
33 echo -ne "\a" 44 echo -ne "\a"
36 sleep 1 47 sleep 1
37 done 48 done
38 fi 49 fi
39} 50}
40 51
41# This function generate linker scripts in /usr/lib for dynamic 52# @FUNCTION: ecvs_clean
42# libs in /lib. This is to fix linking problems when you have 53# @USAGE: [list of dirs]
43# the .so in /lib, and the .a in /usr/lib. What happens is that 54# @DESCRIPTION:
44# in some cases when linking dynamic, the .a in /usr/lib is used 55# Remove CVS directories recursiveley. Useful when a source tarball contains
45# instead of the .so in /lib due to gcc/libtool tweaking ld's 56# internal CVS directories. Defaults to $PWD.
46# library search path. This cause many builds to fail. 57ecvs_clean() {
47# See bug #4411 for more info. 58 [[ -z $* ]] && set -- .
48# 59 find "$@" -type d -name 'CVS' -prune -print0 | xargs -0 rm -rf
49# To use, simply call: 60 find "$@" -type f -name '.cvs*' -print0 | xargs -0 rm -rf
50#
51# gen_usr_ldscript libfoo.so
52#
53# Note that you should in general use the unversioned name of
54# the library, as ldconfig should usually update it correctly
55# to point to the latest version of the library present.
56#
57# <azarah@gentoo.org> (26 Oct 2002)
58#
59gen_usr_ldscript() {
60 if [[ $(type -t _tc_gen_usr_ldscript) == "function" ]] ; then
61 _tc_gen_usr_ldscript "$@"
62 return $?
63 fi
64
65 ewarn "QA Notice: Please upgrade your ebuild to use toolchain-funcs"
66 ewarn "QA Notice: rather than gen_usr_ldscript() from eutils"
67
68 local lib libdir=$(get_libdir)
69 # Just make sure it exists
70 dodir /usr/${libdir}
71
72 for lib in "${@}" ; do
73 cat > "${D}/usr/${libdir}/${lib}" <<-END_LDSCRIPT
74 /* GNU ld script
75 Since Gentoo has critical dynamic libraries
76 in /lib, and the static versions in /usr/lib,
77 we need to have a "fake" dynamic lib in /usr/lib,
78 otherwise we run into linking problems.
79
80 See bug http://bugs.gentoo.org/4411 for more info.
81 */
82 GROUP ( /${libdir}/${lib} )
83 END_LDSCRIPT
84 fperms a+x "/usr/${libdir}/${lib}" || die "could not change perms on ${lib}"
85 done
86} 61}
87 62
63# @FUNCTION: esvn_clean
64# @USAGE: [list of dirs]
65# @DESCRIPTION:
66# Remove .svn directories recursiveley. Useful when a source tarball contains
67# internal Subversion directories. Defaults to $PWD.
68esvn_clean() {
69 [[ -z $* ]] && set -- .
70 find "$@" -type d -name '.svn' -prune -print0 | xargs -0 rm -rf
71}
88 72
89# Default directory where patches are located 73# Default directory where patches are located
90EPATCH_SOURCE="${WORKDIR}/patch" 74EPATCH_SOURCE="${WORKDIR}/patch"
91# Default extension for patches 75# Default extension for patches
92EPATCH_SUFFIX="patch.bz2" 76EPATCH_SUFFIX="patch.bz2"
93# Default options for patch 77# Default options for patch
94# Set -g0 to keep RCS, ClearCase, Perforce and SCCS happy. Bug #24571 78# Set -g0 to keep RCS, ClearCase, Perforce and SCCS happy. Bug #24571
95# Set --no-backup-if-mismatch so we don't leave '.orig' files behind. 79# Set --no-backup-if-mismatch so we don't leave '.orig' files behind.
96# Set -E to automatically remove empty files. 80# Set -E to automatically remove empty files.
97EPATCH_OPTS="-g0 -E --no-backup-if-mismatch" 81EPATCH_OPTS="-g0 -E --no-backup-if-mismatch"
98# List of patches not to apply. Not this is only file names, 82# List of patches not to apply. Note this is only file names,
99# and not the full path .. 83# and not the full path ..
100EPATCH_EXCLUDE="" 84EPATCH_EXCLUDE=""
101# Change the printed message for a single patch. 85# Change the printed message for a single patch.
102EPATCH_SINGLE_MSG="" 86EPATCH_SINGLE_MSG=""
103# Change the printed message for multiple patches. 87# Change the printed message for multiple patches.
121# bug they should be left as is to ensure an ebuild can rely on 105# bug they should be left as is to ensure an ebuild can rely on
122# them for. 106# them for.
123# 107#
124# Patches are applied in current directory. 108# Patches are applied in current directory.
125# 109#
126# Bulk Patches should preferibly have the form of: 110# Bulk Patches should preferably have the form of:
127# 111#
128# ??_${ARCH}_foo.${EPATCH_SUFFIX} 112# ??_${ARCH}_foo.${EPATCH_SUFFIX}
129# 113#
130# For example: 114# For example:
131# 115#
180 local EPATCH_SOURCE="$1/*" 164 local EPATCH_SOURCE="$1/*"
181 else 165 else
182 local EPATCH_SOURCE="$1/*.${EPATCH_SUFFIX}" 166 local EPATCH_SOURCE="$1/*.${EPATCH_SUFFIX}"
183 fi 167 fi
184 else 168 else
185 if [ ! -d ${EPATCH_SOURCE} ] || [ -n "$1" ] 169 if [[ ! -d ${EPATCH_SOURCE} ]] || [[ -n $1 ]] ; then
186 then
187 if [ -n "$1" -a "${EPATCH_SOURCE}" = "${WORKDIR}/patch" ] 170 if [ -n "$1" -a "${EPATCH_SOURCE}" = "${WORKDIR}/patch" ]
188 then 171 then
189 EPATCH_SOURCE="$1" 172 EPATCH_SOURCE="$1"
190 fi 173 fi
191 174
200 183
201 local EPATCH_SOURCE="${EPATCH_SOURCE}/*.${EPATCH_SUFFIX}" 184 local EPATCH_SOURCE="${EPATCH_SOURCE}/*.${EPATCH_SUFFIX}"
202 fi 185 fi
203 186
204 case ${EPATCH_SUFFIX##*\.} in 187 case ${EPATCH_SUFFIX##*\.} in
188 lzma)
189 PIPE_CMD="lzma -dc"
190 PATCH_SUFFIX="lzma"
191 ;;
205 bz2) 192 bz2)
206 PIPE_CMD="bzip2 -dc" 193 PIPE_CMD="bzip2 -dc"
207 PATCH_SUFFIX="bz2" 194 PATCH_SUFFIX="bz2"
208 ;; 195 ;;
209 gz|Z|z) 196 gz|Z|z)
259 fi 246 fi
260 247
261 echo "***** ${patchname} *****" > ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 248 echo "***** ${patchname} *****" > ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
262 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 249 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
263 250
251 # Decompress the patch if need be
252 if [[ ${PATCH_SUFFIX} != "patch" ]] ; then
253 echo -n "PIPE_COMMAND: " >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
254 echo "${PIPE_CMD} ${x} > ${PATCH_TARGET}" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
255
256 if ! (${PIPE_CMD} ${x} > ${PATCH_TARGET}) >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 2>&1 ; then
257 echo
258 eerror "Could not extract patch!"
259 #die "Could not extract patch!"
260 count=5
261 break
262 fi
263 else
264 PATCH_TARGET="${x}"
265 fi
266
267 # Check for absolute paths in patches. If sandbox is disabled,
268 # people could (accidently) patch files in the root filesystem.
269 # Or trigger other unpleasantries #237667. So disallow -p0 on
270 # such patches.
271 local abs_paths=$(egrep -n '^[-+]{3} /' "${PATCH_TARGET}" | awk '$2 != "/dev/null" { print }')
272 if [[ -n ${abs_paths} ]] ; then
273 count=1
274 echo "NOTE: skipping -p0 due to absolute paths in patch:" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
275 echo "${abs_paths}" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
276 fi
277
264 # Allow for prefix to differ ... im lazy, so shoot me :/ 278 # Allow for prefix to differ ... im lazy, so shoot me :/
265 while [ "${count}" -lt 5 ] 279 while [ "${count}" -lt 5 ]
266 do 280 do
267 # Generate some useful debug info ... 281 # Generate some useful debug info ...
268 _epatch_draw_line "***** ${patchname} *****" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 282 _epatch_draw_line "***** ${patchname} *****" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
269 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 283 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
270 284
271 if [ "${PATCH_SUFFIX}" != "patch" ]
272 then
273 echo -n "PIPE_COMMAND: " >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
274 echo "${PIPE_CMD} ${x} > ${PATCH_TARGET}" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
275 else
276 PATCH_TARGET="${x}"
277 fi
278
279 echo -n "PATCH COMMAND: " >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 285 echo -n "PATCH COMMAND: " >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
280 echo "patch -p${count} ${popts} < ${PATCH_TARGET}" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 286 echo "patch -p${count} ${popts} < ${PATCH_TARGET}" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
281 287
282 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 288 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
283 _epatch_draw_line "***** ${patchname} *****" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 289 _epatch_draw_line "***** ${patchname} *****" >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}
284
285 if [ "${PATCH_SUFFIX}" != "patch" ]
286 then
287 if ! (${PIPE_CMD} ${x} > ${PATCH_TARGET}) >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 2>&1
288 then
289 echo
290 eerror "Could not extract patch!"
291 #die "Could not extract patch!"
292 count=5
293 break
294 fi
295 fi
296 290
297 if (cat ${PATCH_TARGET} | patch -p${count} ${popts} --dry-run -f ; _epatch_assert) >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 2>&1 291 if (cat ${PATCH_TARGET} | patch -p${count} ${popts} --dry-run -f ; _epatch_assert) >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/} 2>&1
298 then 292 then
299 _epatch_draw_line "***** ${patchname} *****" > ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real 293 _epatch_draw_line "***** ${patchname} *****" > ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real
300 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real 294 echo >> ${STDERR_TARGET%/*}/${patchname}-${STDERR_TARGET##*/}.real
350 then 344 then
351 einfo "Done with patching" 345 einfo "Done with patching"
352 fi 346 fi
353} 347}
354 348
349# @FUNCTION: emktemp
350# @USAGE: [temp dir]
351# @DESCRIPTION:
355# Cheap replacement for when debianutils (and thus mktemp) 352# Cheap replacement for when debianutils (and thus mktemp)
356# does not exist on the users system 353# does not exist on the users system.
357# vapier@gentoo.org
358#
359# Takes just 1 optional parameter (the directory to create tmpfile in)
360emktemp() { 354emktemp() {
361 local exe="touch" 355 local exe="touch"
362 [[ $1 == -d ]] && exe="mkdir" && shift 356 [[ $1 == -d ]] && exe="mkdir" && shift
363 local topdir=$1 357 local topdir=$1
364 358
366 [[ -z ${T} ]] \ 360 [[ -z ${T} ]] \
367 && topdir="/tmp" \ 361 && topdir="/tmp" \
368 || topdir=${T} 362 || topdir=${T}
369 fi 363 fi
370 364
371 if [[ -z $(type -p mktemp) ]] ; then 365 if ! type -P mktemp > /dev/null ; then
366 # system lacks `mktemp` so we have to fake it
372 local tmp=/ 367 local tmp=/
373 while [[ -e ${tmp} ]] ; do 368 while [[ -e ${tmp} ]] ; do
374 tmp=${topdir}/tmp.${RANDOM}.${RANDOM}.${RANDOM} 369 tmp=${topdir}/tmp.${RANDOM}.${RANDOM}.${RANDOM}
375 done 370 done
376 ${exe} "${tmp}" || ${exe} -p "${tmp}" 371 ${exe} "${tmp}" || ${exe} -p "${tmp}"
377 echo "${tmp}" 372 echo "${tmp}"
378 else 373 else
374 # the args here will give slightly wierd names on BSD,
375 # but should produce a usable file on all userlands
379 if [[ ${exe} == "touch" ]] ; then 376 if [[ ${exe} == "touch" ]] ; then
380 [[ ${USERLAND} == "GNU" ]] \
381 && mktemp -p "${topdir}" \
382 || TMPDIR="${topdir}" mktemp -t tmp 377 TMPDIR="${topdir}" mktemp -t tmp.XXXXXXXXXX
383 else 378 else
384 [[ ${USERLAND} == "GNU" ]] \
385 && mktemp -d "${topdir}" \
386 || TMPDIR="${topdir}" mktemp -dt tmp 379 TMPDIR="${topdir}" mktemp -dt tmp.XXXXXXXXXX
387 fi
388 fi 380 fi
381 fi
389} 382}
390 383
384# @FUNCTION: egetent
385# @USAGE: <database> <key>
386# @MAINTAINER:
387# base-system@gentoo.org (Linux)
388# Joe Jezak <josejx@gmail.com> (OS X)
389# usata@gentoo.org (OS X)
390# Aaron Walker <ka0ttic@gentoo.org> (FreeBSD)
391# @DESCRIPTION:
391# Small wrapper for getent (Linux), nidump (Mac OS X), 392# Small wrapper for getent (Linux),
393# nidump (< Mac OS X 10.5), dscl (Mac OS X 10.5),
392# and pw (FreeBSD) used in enewuser()/enewgroup() 394# and pw (FreeBSD) used in enewuser()/enewgroup()
393# Joe Jezak <josejx@gmail.com> and usata@gentoo.org
394# FBSD stuff: Aaron Walker <ka0ttic@gentoo.org>
395#
396# egetent(database, key)
397egetent() { 395egetent() {
398 case ${CHOST} in 396 case ${CHOST} in
397 *-darwin9)
398 local mytype=$1
399 [[ "passwd" == $mytype ]] && mytype="Users"
400 [[ "group" == $mytype ]] && mytype="Groups"
401 case "$2" in
402 *[!0-9]*) # Non numeric
403 dscl . -read /$mytype/$2 2>/dev/null |grep RecordName
404 ;;
405 *) # Numeric
406 local mykey="UniqueID"
407 [[ $mytype == "Groups" ]] && mykey="PrimaryGroupID"
408 dscl . -search /$mytype $mykey $2 2>/dev/null
409 ;;
410 esac
411 ;;
399 *-darwin*) 412 *-darwin*)
400 case "$2" in 413 case "$2" in
401 *[!0-9]*) # Non numeric 414 *[!0-9]*) # Non numeric
402 nidump $1 . | awk -F":" "{ if (\$1 ~ /^$2$/) {print \$0;exit;} }" 415 nidump $1 . | awk -F":" "{ if (\$1 ~ /^$2$/) {print \$0;exit;} }"
403 ;; 416 ;;
425 getent "$1" "$2" 438 getent "$1" "$2"
426 ;; 439 ;;
427 esac 440 esac
428} 441}
429 442
430# Simplify/standardize adding users to the system 443# @FUNCTION: enewuser
431# vapier@gentoo.org 444# @USAGE: <user> [uid] [shell] [homedir] [groups] [params]
432# 445# @DESCRIPTION:
433# enewuser(username, uid, shell, homedir, groups, extra options) 446# Same as enewgroup, you are not required to understand how to properly add
434# 447# a user to the system. The only required parameter is the username.
435# Default values if you do not specify any: 448# Default uid is (pass -1 for this) next available, default shell is
436# username: REQUIRED ! 449# /bin/false, default homedir is /dev/null, there are no default groups,
437# uid: next available (see useradd(8)) 450# and default params sets the comment as 'added by portage for ${PN}'.
438# note: pass -1 to get default behavior
439# shell: /bin/false
440# homedir: /dev/null
441# groups: none
442# extra: comment of 'added by portage for ${PN}'
443enewuser() { 451enewuser() {
444 case ${EBUILD_PHASE} in 452 case ${EBUILD_PHASE} in
445 unpack|compile|test|install) 453 unpack|compile|test|install)
446 eerror "'enewuser()' called from '${EBUILD_PHASE}()' which is not a pkg_* function." 454 eerror "'enewuser()' called from '${EBUILD_PHASE}()' which is not a pkg_* function."
447 eerror "Package fails at QA and at life. Please file a bug." 455 eerror "Package fails at QA and at life. Please file a bug."
636 fi 644 fi
637 645
638 export SANDBOX_ON=${oldsandbox} 646 export SANDBOX_ON=${oldsandbox}
639} 647}
640 648
641# Simplify/standardize adding groups to the system 649# @FUNCTION: enewgroup
642# vapier@gentoo.org 650# @USAGE: <group> [gid]
643# 651# @DESCRIPTION:
644# enewgroup(group, gid) 652# This function does not require you to understand how to properly add a
645# 653# group to the system. Just give it a group name to add and enewgroup will
646# Default values if you do not specify any: 654# do the rest. You may specify the gid for the group or allow the group to
647# groupname: REQUIRED ! 655# allocate the next available one.
648# gid: next available (see groupadd(8))
649# extra: none
650enewgroup() { 656enewgroup() {
651 case ${EBUILD_PHASE} in 657 case ${EBUILD_PHASE} in
652 unpack|compile|test|install) 658 unpack|compile|test|install)
653 eerror "'enewgroup()' called from '${EBUILD_PHASE}()' which is not a pkg_* function." 659 eerror "'enewgroup()' called from '${EBUILD_PHASE}()' which is not a pkg_* function."
654 eerror "Package fails at QA and at life. Please file a bug." 660 eerror "Package fails at QA and at life. Please file a bug."
750 ;; 756 ;;
751 esac 757 esac
752 export SANDBOX_ON="${oldsandbox}" 758 export SANDBOX_ON="${oldsandbox}"
753} 759}
754 760
755# Simple script to replace 'dos2unix' binaries 761# @FUNCTION: edos2unix
756# vapier@gentoo.org 762# @USAGE: <file> [more files ...]
757# 763# @DESCRIPTION:
758# edos2unix(file, <more files> ...) 764# A handy replacement for dos2unix, recode, fixdos, etc... This allows you
765# to remove all of these text utilities from DEPEND variables because this
766# is a script based solution. Just give it a list of files to convert and
767# they will all be changed from the DOS CRLF format to the UNIX LF format.
759edos2unix() { 768edos2unix() {
760 echo "$@" | xargs sed -i 's/\r$//' 769 echo "$@" | xargs sed -i 's/\r$//'
761} 770}
762
763
764##############################################################
765# START: Handle .desktop files and menu entries #
766# maybe this should be separated into a new eclass some time #
767# lanius@gentoo.org #
768##############################################################
769 771
770# Make a desktop file ! 772# Make a desktop file !
771# Great for making those icons in kde/gnome startmenu ! 773# Great for making those icons in kde/gnome startmenu !
772# Amaze your friends ! Get the women ! Join today ! 774# Amaze your friends ! Get the women ! Join today !
773# 775#
777# name: the name that will show up in the menu 779# name: the name that will show up in the menu
778# icon: give your little like a pretty little icon ... 780# icon: give your little like a pretty little icon ...
779# this can be relative (to /usr/share/pixmaps) or 781# this can be relative (to /usr/share/pixmaps) or
780# a full path to an icon 782# a full path to an icon
781# type: what kind of application is this ? for categories: 783# type: what kind of application is this ? for categories:
782# http://www.freedesktop.org/Standards/desktop-entry-spec 784# http://standards.freedesktop.org/menu-spec/latest/apa.html
783# path: if your app needs to startup in a specific dir 785# path: if your app needs to startup in a specific dir
784make_desktop_entry() { 786make_desktop_entry() {
785 [[ -z $1 ]] && eerror "make_desktop_entry: You must specify the executable" && return 1 787 [[ -z $1 ]] && eerror "make_desktop_entry: You must specify the executable" && return 1
786 788
787 local exec=${1} 789 local exec=${1}
788 local name=${2:-${PN}} 790 local name=${2:-${PN}}
789 local icon=${3:-${PN}.png} 791 local icon=${3:-${PN}}
790 local type=${4} 792 local type=${4}
791 local path=${5} 793 local path=${5}
792 794
793 if [[ -z ${type} ]] ; then 795 if [[ -z ${type} ]] ; then
794 local catmaj=${CATEGORY%%-*} 796 local catmaj=${CATEGORY%%-*}
795 local catmin=${CATEGORY##*-} 797 local catmin=${CATEGORY##*-}
796 case ${catmaj} in 798 case ${catmaj} in
797 app) 799 app)
798 case ${catmin} in 800 case ${catmin} in
801 accessibility) type=Accessibility;;
799 admin) type=System;; 802 admin) type=System;;
803 antivirus) type=System;;
804 arch) type=Archiving;;
805 backup) type=Archiving;;
800 cdr) type=DiscBurning;; 806 cdr) type=DiscBurning;;
801 dicts) type=Dictionary;; 807 dicts) type=Dictionary;;
808 doc) type=Documentation;;
802 editors) type=TextEditor;; 809 editors) type=TextEditor;;
803 emacs) type=TextEditor;; 810 emacs) type=TextEditor;;
804 emulation) type=Emulator;; 811 emulation) type=Emulator;;
805 laptop) type=HardwareSettings;; 812 laptop) type=HardwareSettings;;
806 office) type=Office;; 813 office) type=Office;;
814 pda) type=PDA;;
807 vim) type=TextEditor;; 815 vim) type=TextEditor;;
808 xemacs) type=TextEditor;; 816 xemacs) type=TextEditor;;
809 *) type=;; 817 *) type=;;
810 esac 818 esac
811 ;; 819 ;;
817 games) 825 games)
818 case ${catmin} in 826 case ${catmin} in
819 action|fps) type=ActionGame;; 827 action|fps) type=ActionGame;;
820 arcade) type=ArcadeGame;; 828 arcade) type=ArcadeGame;;
821 board) type=BoardGame;; 829 board) type=BoardGame;;
830 emulation) type=Emulator;;
822 kids) type=KidsGame;; 831 kids) type=KidsGame;;
823 emulation) type=Emulator;;
824 puzzle) type=LogicGame;; 832 puzzle) type=LogicGame;;
833 roguelike) type=RolePlaying;;
825 rpg) type=RolePlaying;; 834 rpg) type=RolePlaying;;
826 roguelike) type=RolePlaying;;
827 simulation) type=Simulation;; 835 simulation) type=Simulation;;
828 sports) type=SportsGame;; 836 sports) type=SportsGame;;
829 strategy) type=StrategyGame;; 837 strategy) type=StrategyGame;;
830 *) type=;; 838 *) type=;;
831 esac 839 esac
832 type="Game;${type}" 840 type="Game;${type}"
841 ;;
842
843 gnome)
844 type="Gnome;GTK"
845 ;;
846
847 kde)
848 type="KDE;Qt"
833 ;; 849 ;;
834 850
835 mail) 851 mail)
836 type="Network;Email" 852 type="Network;Email"
837 ;; 853 ;;
863 type="Network;${type}" 879 type="Network;${type}"
864 ;; 880 ;;
865 881
866 sci) 882 sci)
867 case ${catmin} in 883 case ${catmin} in
868 astro*) type=Astronomy;; 884 astro*) type=Astronomy;;
869 bio*) type=Biology;; 885 bio*) type=Biology;;
870 calc*) type=Calculator;; 886 calc*) type=Calculator;;
871 chem*) type=Chemistry;; 887 chem*) type=Chemistry;;
888 elec*) type=Electronics;;
872 geo*) type=Geology;; 889 geo*) type=Geology;;
873 math*) type=Math;; 890 math*) type=Math;;
891 physics) type=Physics;;
892 visual*) type=DataVisualization;;
874 *) type=;; 893 *) type=;;
875 esac 894 esac
876 type="Science;${type}" 895 type="Science;${type}"
896 ;;
897
898 sys)
899 type="System"
877 ;; 900 ;;
878 901
879 www) 902 www)
880 case ${catmin} in 903 case ${catmin} in
881 client) type=WebBrowser;; 904 client) type=WebBrowser;;
897 local desktop="${T}/$(echo ${exec} | sed 's:[[:space:]/:]:_:g')-${desktop_name}.desktop" 920 local desktop="${T}/$(echo ${exec} | sed 's:[[:space:]/:]:_:g')-${desktop_name}.desktop"
898 #local desktop=${T}/${exec%% *:-${desktop_name}}.desktop 921 #local desktop=${T}/${exec%% *:-${desktop_name}}.desktop
899 922
900 cat <<-EOF > "${desktop}" 923 cat <<-EOF > "${desktop}"
901 [Desktop Entry] 924 [Desktop Entry]
902 Encoding=UTF-8
903 Version=0.9.2 925 Version=1.0
904 Name=${name} 926 Name=${name}
905 Type=Application 927 Type=Application
906 Comment=${DESCRIPTION} 928 Comment=${DESCRIPTION}
907 Exec=${exec} 929 Exec=${exec}
908 TryExec=${exec%% *} 930 TryExec=${exec%% *}
909 Path=${path}
910 Icon=${icon} 931 Icon=${icon}
911 Categories=Application;${type}; 932 Categories=${type};
912 EOF 933 EOF
934
935 [[ ${path} ]] && echo "Path=${path}" >> "${desktop}"
913 936
914 ( 937 (
915 # wrap the env here so that the 'insinto' call 938 # wrap the env here so that the 'insinto' call
916 # doesn't corrupt the env of the caller 939 # doesn't corrupt the env of the caller
917 insinto /usr/share/applications 940 insinto /usr/share/applications
918 doins "${desktop}" 941 doins "${desktop}"
919 ) 942 )
920} 943}
921 944
922 945# @FUNCTION: validate_desktop_entries
946# @USAGE: [directories]
947# @MAINTAINER:
948# Carsten Lohrke <carlo@gentoo.org>
949# @DESCRIPTION:
923# Validate desktop entries using desktop-file-utils 950# Validate desktop entries using desktop-file-utils
924# Carsten Lohrke <carlo@gentoo.org>
925#
926# Usage: validate_desktop_entries [directory ...]
927
928validate_desktop_entries() { 951validate_desktop_entries() {
929 if [[ -x /usr/bin/desktop-file-validate ]] ; then 952 if [[ -x /usr/bin/desktop-file-validate ]] ; then
930 einfo "Checking desktop entry validity" 953 einfo "Checking desktop entry validity"
931 local directories="" 954 local directories=""
932 for d in /usr/share/applications $@ ; do 955 for d in /usr/share/applications $@ ; do
945 else 968 else
946 einfo "Passing desktop entry validity check. Install dev-util/desktop-file-utils, if you want to help to improve Gentoo." 969 einfo "Passing desktop entry validity check. Install dev-util/desktop-file-utils, if you want to help to improve Gentoo."
947 fi 970 fi
948} 971}
949 972
950 973# @FUNCTION: make_session_desktop
951# Make a GDM/KDM Session file 974# @USAGE: <title> <command> [command args...]
975# @DESCRIPTION:
976# Make a GDM/KDM Session file. The title is the file to execute to start the
977# Window Manager. The command is the name of the Window Manager.
952# 978#
953# make_session_desktop(<title>, <command>) 979# You can set the name of the file via the ${wm} variable.
954# title: File to execute to start the Window Manager
955# command: Name of the Window Manager
956
957make_session_desktop() { 980make_session_desktop() {
958 [[ -z $1 ]] && eerror "make_session_desktop: You must specify the title" && return 1 981 [[ -z $1 ]] && eerror "$0: You must specify the title" && return 1
959 [[ -z $2 ]] && eerror "make_session_desktop: You must specify the command" && return 1 982 [[ -z $2 ]] && eerror "$0: You must specify the command" && return 1
960 983
961 local title=$1 984 local title=$1
962 local command=$2 985 local command=$2
963 local desktop=${T}/${wm}.desktop 986 local desktop=${T}/${wm:-${PN}}.desktop
987 shift 2
964 988
965 cat <<-EOF > "${desktop}" 989 cat <<-EOF > "${desktop}"
966 [Desktop Entry] 990 [Desktop Entry]
967 Encoding=UTF-8
968 Name=${title} 991 Name=${title}
969 Comment=This session logs you into ${title} 992 Comment=This session logs you into ${title}
970 Exec=${command} 993 Exec=${command} $*
971 TryExec=${command} 994 TryExec=${command}
972 Type=Application 995 Type=XSession
973 EOF 996 EOF
974 997
975 ( 998 (
976 # wrap the env here so that the 'insinto' call 999 # wrap the env here so that the 'insinto' call
977 # doesn't corrupt the env of the caller 1000 # doesn't corrupt the env of the caller
978 insinto /usr/share/xsessions 1001 insinto /usr/share/xsessions
979 doins "${desktop}" 1002 doins "${desktop}"
980 ) 1003 )
981} 1004}
982 1005
1006# @FUNCTION: domenu
1007# @USAGE: <menus>
1008# @DESCRIPTION:
1009# Install the list of .desktop menu files into the appropriate directory
1010# (/usr/share/applications).
983domenu() { 1011domenu() {
984 ( 1012 (
985 # wrap the env here so that the 'insinto' call 1013 # wrap the env here so that the 'insinto' call
986 # doesn't corrupt the env of the caller 1014 # doesn't corrupt the env of the caller
987 local i j ret=0 1015 local i j ret=0
993 elif [[ -d ${i} ]] ; then 1021 elif [[ -d ${i} ]] ; then
994 for j in "${i}"/*.desktop ; do 1022 for j in "${i}"/*.desktop ; do
995 doins "${j}" 1023 doins "${j}"
996 ((ret+=$?)) 1024 ((ret+=$?))
997 done 1025 done
1026 else
1027 ((++ret))
998 fi 1028 fi
999 done 1029 done
1000 exit ${ret} 1030 exit ${ret}
1001 ) 1031 )
1002} 1032}
1033
1034# @FUNCTION: newmenu
1035# @USAGE: <menu> <newname>
1036# @DESCRIPTION:
1037# Like all other new* functions, install the specified menu as newname.
1003newmenu() { 1038newmenu() {
1004 ( 1039 (
1005 # wrap the env here so that the 'insinto' call 1040 # wrap the env here so that the 'insinto' call
1006 # doesn't corrupt the env of the caller 1041 # doesn't corrupt the env of the caller
1007 insinto /usr/share/applications 1042 insinto /usr/share/applications
1008 newins "$@" 1043 newins "$@"
1009 ) 1044 )
1010} 1045}
1011 1046
1047# @FUNCTION: doicon
1048# @USAGE: <list of icons>
1049# @DESCRIPTION:
1050# Install the list of icons into the icon directory (/usr/share/pixmaps).
1051# This is useful in conjunction with creating desktop/menu files.
1012doicon() { 1052doicon() {
1013 ( 1053 (
1014 # wrap the env here so that the 'insinto' call 1054 # wrap the env here so that the 'insinto' call
1015 # doesn't corrupt the env of the caller 1055 # doesn't corrupt the env of the caller
1016 local i j ret 1056 local i j ret
1022 elif [[ -d ${i} ]] ; then 1062 elif [[ -d ${i} ]] ; then
1023 for j in "${i}"/*.png ; do 1063 for j in "${i}"/*.png ; do
1024 doins "${j}" 1064 doins "${j}"
1025 ((ret+=$?)) 1065 ((ret+=$?))
1026 done 1066 done
1067 else
1068 ((++ret))
1027 fi 1069 fi
1028 done 1070 done
1029 exit ${ret} 1071 exit ${ret}
1030 ) 1072 )
1031} 1073}
1074
1075# @FUNCTION: newicon
1076# @USAGE: <icon> <newname>
1077# @DESCRIPTION:
1078# Like all other new* functions, install the specified icon as newname.
1032newicon() { 1079newicon() {
1033 ( 1080 (
1034 # wrap the env here so that the 'insinto' call 1081 # wrap the env here so that the 'insinto' call
1035 # doesn't corrupt the env of the caller 1082 # doesn't corrupt the env of the caller
1036 insinto /usr/share/pixmaps 1083 insinto /usr/share/pixmaps
1037 newins "$@" 1084 newins "$@"
1038 ) 1085 )
1039} 1086}
1040
1041##############################################################
1042# END: Handle .desktop files and menu entries #
1043##############################################################
1044
1045 1087
1046# for internal use only (unpack_pdv and unpack_makeself) 1088# for internal use only (unpack_pdv and unpack_makeself)
1047find_unpackable_file() { 1089find_unpackable_file() {
1048 local src=$1 1090 local src=$1
1049 if [[ -z ${src} ]] ; then 1091 if [[ -z ${src} ]] ; then
1059 fi 1101 fi
1060 [[ ! -e ${src} ]] && return 1 1102 [[ ! -e ${src} ]] && return 1
1061 echo "${src}" 1103 echo "${src}"
1062} 1104}
1063 1105
1106# @FUNCTION: unpack_pdv
1107# @USAGE: <file to unpack> <size of off_t>
1108# @DESCRIPTION:
1064# Unpack those pesky pdv generated files ... 1109# Unpack those pesky pdv generated files ...
1065# They're self-unpacking programs with the binary package stuffed in 1110# They're self-unpacking programs with the binary package stuffed in
1066# the middle of the archive. Valve seems to use it a lot ... too bad 1111# the middle of the archive. Valve seems to use it a lot ... too bad
1067# it seems to like to segfault a lot :(. So lets take it apart ourselves. 1112# it seems to like to segfault a lot :(. So lets take it apart ourselves.
1068# 1113#
1069# Usage: unpack_pdv [file to unpack] [size of off_t]
1070# - you have to specify the off_t size ... i have no idea how to extract that 1114# You have to specify the off_t size ... I have no idea how to extract that
1071# information out of the binary executable myself. basically you pass in 1115# information out of the binary executable myself. Basically you pass in
1072# the size of the off_t type (in bytes) on the machine that built the pdv 1116# the size of the off_t type (in bytes) on the machine that built the pdv
1117# archive.
1118#
1073# archive. one way to determine this is by running the following commands: 1119# One way to determine this is by running the following commands:
1120#
1121# @CODE
1074# strings <pdv archive> | grep lseek 1122# strings <pdv archive> | grep lseek
1075# strace -elseek <pdv archive> 1123# strace -elseek <pdv archive>
1124# @CODE
1125#
1076# basically look for the first lseek command (we do the strings/grep because 1126# Basically look for the first lseek command (we do the strings/grep because
1077# sometimes the function call is _llseek or something) and steal the 2nd 1127# sometimes the function call is _llseek or something) and steal the 2nd
1078# parameter. here is an example: 1128# parameter. Here is an example:
1129#
1130# @CODE
1079# root@vapier 0 pdv_unpack # strings hldsupdatetool.bin | grep lseek 1131# vapier@vapier 0 pdv_unpack # strings hldsupdatetool.bin | grep lseek
1080# lseek 1132# lseek
1081# root@vapier 0 pdv_unpack # strace -elseek ./hldsupdatetool.bin 1133# vapier@vapier 0 pdv_unpack # strace -elseek ./hldsupdatetool.bin
1082# lseek(3, -4, SEEK_END) = 2981250 1134# lseek(3, -4, SEEK_END) = 2981250
1135# @CODE
1136#
1083# thus we would pass in the value of '4' as the second parameter. 1137# Thus we would pass in the value of '4' as the second parameter.
1084unpack_pdv() { 1138unpack_pdv() {
1085 local src=$(find_unpackable_file "$1") 1139 local src=$(find_unpackable_file "$1")
1086 local sizeoff_t=$2 1140 local sizeoff_t=$2
1087 1141
1088 [[ -z ${src} ]] && die "Could not locate source for '$1'" 1142 [[ -z ${src} ]] && die "Could not locate source for '$1'"
1150 true 1204 true
1151 #[ -s "${datafile}" ] || die "failure unpacking pdv ('${metaskip}' '${tailskip}' '${datafile}')" 1205 #[ -s "${datafile}" ] || die "failure unpacking pdv ('${metaskip}' '${tailskip}' '${datafile}')"
1152 #assert "failure unpacking pdv ('${metaskip}' '${tailskip}' '${datafile}')" 1206 #assert "failure unpacking pdv ('${metaskip}' '${tailskip}' '${datafile}')"
1153} 1207}
1154 1208
1209# @FUNCTION: unpack_makeself
1210# @USAGE: [file to unpack] [offset] [tail|dd]
1211# @DESCRIPTION:
1155# Unpack those pesky makeself generated files ... 1212# Unpack those pesky makeself generated files ...
1156# They're shell scripts with the binary package tagged onto 1213# They're shell scripts with the binary package tagged onto
1157# the end of the archive. Loki utilized the format as does 1214# the end of the archive. Loki utilized the format as does
1158# many other game companies. 1215# many other game companies.
1159# 1216#
1160# Usage: unpack_makeself [file to unpack] [offset] [tail|dd] 1217# If the file is not specified, then ${A} is used. If the
1161# - If the file is not specified then unpack will utilize ${A}.
1162# - If the offset is not specified then we will attempt to extract 1218# offset is not specified then we will attempt to extract
1163# the proper offset from the script itself. 1219# the proper offset from the script itself.
1164unpack_makeself() { 1220unpack_makeself() {
1165 local src_input=${1:-${A}} 1221 local src_input=${1:-${A}}
1166 local src=$(find_unpackable_file "${src_input}") 1222 local src=$(find_unpackable_file "${src_input}")
1167 local skip=$2 1223 local skip=$2
1168 local exe=$3 1224 local exe=$3
1238 ;; 1294 ;;
1239 esac 1295 esac
1240 assert "failure unpacking (${filetype}) makeself ${shrtsrc} ('${ver}' +${skip})" 1296 assert "failure unpacking (${filetype}) makeself ${shrtsrc} ('${ver}' +${skip})"
1241} 1297}
1242 1298
1299# @FUNCTION: check_license
1300# @USAGE: [license]
1301# @DESCRIPTION:
1243# Display a license for user to accept. 1302# Display a license for user to accept. If no license is
1244#
1245# Usage: check_license [license]
1246# - If the file is not specified then ${LICENSE} is used. 1303# specified, then ${LICENSE} is used.
1247check_license() { 1304check_license() {
1248 local lic=$1 1305 local lic=$1
1249 if [ -z "${lic}" ] ; then 1306 if [ -z "${lic}" ] ; then
1250 lic="${PORTDIR}/licenses/${LICENSE}" 1307 lic="${PORTDIR}/licenses/${LICENSE}"
1251 else 1308 else
1279 The following license outlines the terms of use of this 1336 The following license outlines the terms of use of this
1280 package. You MUST accept this license for installation to 1337 package. You MUST accept this license for installation to
1281 continue. When you are done viewing, hit 'q'. If you 1338 continue. When you are done viewing, hit 'q'. If you
1282 CTRL+C out of this, the install will not run! 1339 CTRL+C out of this, the install will not run!
1283 ********************************************************** 1340 **********************************************************
1284 1341
1285 EOF 1342 EOF
1286 cat ${lic} >> ${licmsg} 1343 cat ${lic} >> ${licmsg}
1287 ${PAGER:-less} ${licmsg} || die "Could not execute pager (${PAGER}) to accept ${lic}" 1344 ${PAGER:-less} ${licmsg} || die "Could not execute pager (${PAGER}) to accept ${lic}"
1288 einfon "Do you accept the terms of this license (${l})? [yes/no] " 1345 einfon "Do you accept the terms of this license (${l})? [yes/no] "
1289 read alic 1346 read alic
1297 die "Failed to accept license" 1354 die "Failed to accept license"
1298 ;; 1355 ;;
1299 esac 1356 esac
1300} 1357}
1301 1358
1359# @FUNCTION: cdrom_get_cds
1360# @USAGE: <file on cd1> [file on cd2] [file on cd3] [...]
1361# @DESCRIPTION:
1302# Aquire cd(s) for those lovely cd-based emerges. Yes, this violates 1362# Aquire cd(s) for those lovely cd-based emerges. Yes, this violates
1303# the whole 'non-interactive' policy, but damnit I want CD support ! 1363# the whole 'non-interactive' policy, but damnit I want CD support !
1304# 1364#
1305# with these cdrom functions we handle all the user interaction and 1365# With these cdrom functions we handle all the user interaction and
1306# standardize everything. all you have to do is call cdrom_get_cds() 1366# standardize everything. All you have to do is call cdrom_get_cds()
1307# and when the function returns, you can assume that the cd has been 1367# and when the function returns, you can assume that the cd has been
1308# found at CDROM_ROOT. 1368# found at CDROM_ROOT.
1309# 1369#
1370# The function will attempt to locate a cd based upon a file that is on
1371# the cd. The more files you give this function, the more cds
1372# the cdrom functions will handle.
1373#
1310# normally the cdrom functions will refer to the cds as 'cd #1', 'cd #2', 1374# Normally the cdrom functions will refer to the cds as 'cd #1', 'cd #2',
1311# etc... if you want to give the cds better names, then just export 1375# etc... If you want to give the cds better names, then just export
1312# the appropriate CDROM_NAME variable before calling cdrom_get_cds(). 1376# the appropriate CDROM_NAME variable before calling cdrom_get_cds().
1313# - CDROM_NAME="fooie cd" - for when you only want 1 cd 1377# Use CDROM_NAME for one cd, or CDROM_NAME_# for multiple cds. You can
1314# - CDROM_NAME_1="install cd" - for when you want more than 1 cd 1378# also use the CDROM_NAME_SET bash array.
1315# CDROM_NAME_2="data cd"
1316# - CDROM_NAME_SET=( "install cd" "data cd" ) - short hand for CDROM_NAME_#
1317# 1379#
1318# for those multi cd ebuilds, see the cdrom_load_next_cd() below. 1380# For those multi cd ebuilds, see the cdrom_load_next_cd() function.
1319#
1320# Usage: cdrom_get_cds <file on cd1> [file on cd2] [file on cd3] [...]
1321# - this will attempt to locate a cd based upon a file that is on
1322# the cd ... the more files you give this function, the more cds
1323# the cdrom functions will handle
1324cdrom_get_cds() { 1381cdrom_get_cds() {
1325 # first we figure out how many cds we're dealing with by 1382 # first we figure out how many cds we're dealing with by
1326 # the # of files they gave us 1383 # the # of files they gave us
1327 local cdcnt=0 1384 local cdcnt=0
1328 local f= 1385 local f=
1414 export CDROM_SET="" 1471 export CDROM_SET=""
1415 export CDROM_CURRENT_CD=0 1472 export CDROM_CURRENT_CD=0
1416 cdrom_load_next_cd 1473 cdrom_load_next_cd
1417} 1474}
1418 1475
1419# this is only used when you need access to more than one cd. 1476# @FUNCTION: cdrom_load_next_cd
1420# when you have finished using the first cd, just call this function. 1477# @DESCRIPTION:
1421# when it returns, CDROM_ROOT will be pointing to the second cd. 1478# Some packages are so big they come on multiple CDs. When you're done reading
1422# remember, you can only go forward in the cd chain, you can't go back. 1479# files off a CD and want access to the next one, just call this function.
1480# Again, all the messy details of user interaction are taken care of for you.
1481# Once this returns, just read the variable CDROM_ROOT for the location of the
1482# mounted CD. Note that you can only go forward in the CD list, so make sure
1483# you only call this function when you're done using the current CD.
1423cdrom_load_next_cd() { 1484cdrom_load_next_cd() {
1424 local var 1485 local var
1425 ((++CDROM_CURRENT_CD)) 1486 ((++CDROM_CURRENT_CD))
1426 1487
1427 unset CDROM_ROOT 1488 unset CDROM_ROOT
1444# displayed and we'll hang out here until: 1505# displayed and we'll hang out here until:
1445# (1) the file is found on a mounted cdrom 1506# (1) the file is found on a mounted cdrom
1446# (2) the user hits CTRL+C 1507# (2) the user hits CTRL+C
1447_cdrom_locate_file_on_cd() { 1508_cdrom_locate_file_on_cd() {
1448 local mline="" 1509 local mline=""
1449 local showedmsg=0 1510 local showedmsg=0 showjolietmsg=0
1450 1511
1451 while [[ -z ${CDROM_ROOT} ]] ; do 1512 while [[ -z ${CDROM_ROOT} ]] ; do
1452 local i=0 1513 local i=0
1453 local -a cdset=(${*//:/ }) 1514 local -a cdset=(${*//:/ })
1454 if [[ -n ${CDROM_SET} ]] ; then 1515 if [[ -n ${CDROM_SET} ]] ; then
1459 local dir=$(dirname ${cdset[${i}]}) 1520 local dir=$(dirname ${cdset[${i}]})
1460 local file=$(basename ${cdset[${i}]}) 1521 local file=$(basename ${cdset[${i}]})
1461 1522
1462 local point= node= fs= foo= 1523 local point= node= fs= foo=
1463 while read point node fs foo ; do 1524 while read point node fs foo ; do
1464 [[ " cd9660 iso9660 " != *" ${fs} "* ]] && \ 1525 [[ " cd9660 iso9660 udf " != *" ${fs} "* ]] && \
1465 ! [[ ${fs} == "subfs" && ",${opts}," == *",fs=cdfss,"* ]] \ 1526 ! [[ ${fs} == "subfs" && ",${opts}," == *",fs=cdfss,"* ]] \
1466 && continue 1527 && continue
1467 point=${point//\040/ } 1528 point=${point//\040/ }
1529 [[ ! -d ${point}/${dir} ]] && continue
1468 [[ -z $(find "${point}/${dir}" -maxdepth 1 -iname "${file}") ]] && continue 1530 [[ -z $(find "${point}/${dir}" -maxdepth 1 -iname "${file}") ]] && continue
1469 export CDROM_ROOT=${point} 1531 export CDROM_ROOT=${point}
1470 export CDROM_SET=${i} 1532 export CDROM_SET=${i}
1471 export CDROM_MATCH=${cdset[${i}]} 1533 export CDROM_MATCH=${cdset[${i}]}
1472 return 1534 return
1494 showedmsg=1 1556 showedmsg=1
1495 fi 1557 fi
1496 einfo "Press return to scan for the cd again" 1558 einfo "Press return to scan for the cd again"
1497 einfo "or hit CTRL+C to abort the emerge." 1559 einfo "or hit CTRL+C to abort the emerge."
1498 echo 1560 echo
1561 if [[ ${showjolietmsg} -eq 0 ]] ; then
1562 showjolietmsg=1
1563 else
1499 einfo "If you are having trouble with the detection" 1564 ewarn "If you are having trouble with the detection"
1500 einfo "of your CD, it is possible that you do not have" 1565 ewarn "of your CD, it is possible that you do not have"
1501 einfo "Joliet support enabled in your kernel. Please" 1566 ewarn "Joliet support enabled in your kernel. Please"
1502 einfo "check that CONFIG_JOLIET is enabled in your kernel." 1567 ewarn "check that CONFIG_JOLIET is enabled in your kernel."
1568 ebeep 5
1569 fi
1503 read || die "something is screwed with your system" 1570 read || die "something is screwed with your system"
1504 done 1571 done
1505} 1572}
1506 1573
1574# @FUNCTION: strip-linguas
1575# @USAGE: [<allow LINGUAS>|<-i|-u> <directories of .po files>]
1576# @DESCRIPTION:
1507# Make sure that LINGUAS only contains languages that 1577# Make sure that LINGUAS only contains languages that
1508# a package can support 1578# a package can support. The first form allows you to
1509# 1579# specify a list of LINGUAS. The -i builds a list of po
1510# usage: strip-linguas <allow LINGUAS> 1580# files found in all the directories and uses the
1511# strip-linguas -i <directories of .po files> 1581# intersection of the lists. The -u builds a list of po
1512# strip-linguas -u <directories of .po files> 1582# files found in all the directories and uses the union
1513# 1583# of the lists.
1514# The first form allows you to specify a list of LINGUAS.
1515# The -i builds a list of po files found in all the
1516# directories and uses the intersection of the lists.
1517# The -u builds a list of po files found in all the
1518# directories and uses the union of the lists.
1519strip-linguas() { 1584strip-linguas() {
1520 local ls newls nols 1585 local ls newls nols
1521 if [[ $1 == "-i" ]] || [[ $1 == "-u" ]] ; then 1586 if [[ $1 == "-i" ]] || [[ $1 == "-u" ]] ; then
1522 local op=$1; shift 1587 local op=$1; shift
1523 ls=$(find "$1" -name '*.po' -exec basename {} .po \;); shift 1588 ls=$(find "$1" -name '*.po' -exec basename {} .po \;); shift
1553 [[ -n ${nols} ]] \ 1618 [[ -n ${nols} ]] \
1554 && ewarn "Sorry, but ${PN} does not support the LINGUAs:" ${nols} 1619 && ewarn "Sorry, but ${PN} does not support the LINGUAs:" ${nols}
1555 export LINGUAS=${newls:1} 1620 export LINGUAS=${newls:1}
1556} 1621}
1557 1622
1558# moved from kernel.eclass since they are generally useful outside of 1623# @FUNCTION: preserve_old_lib
1559# kernel.eclass -iggy (20041002) 1624# @USAGE: <libs to preserve> [more libs]
1560 1625# @DESCRIPTION:
1561# the following functions are useful in kernel module ebuilds, etc.
1562# for an example see ivtv or drbd ebuilds
1563
1564# set's ARCH to match what the kernel expects
1565set_arch_to_kernel() {
1566 i=10
1567 while ((i--)) ; do
1568 ewarn "PLEASE UPDATE TO YOUR PACKAGE TO USE linux-info.eclass"
1569 done
1570 export EUTILS_ECLASS_PORTAGE_ARCH="${ARCH}"
1571 case ${ARCH} in
1572 x86) export ARCH="i386";;
1573 amd64) export ARCH="x86_64";;
1574 hppa) export ARCH="parisc";;
1575 mips) export ARCH="mips";;
1576 sparc) export ARCH="$(tc-arch-kernel)";; # Yeah this is ugly, but it's even WORSE if you don't do this. linux-info.eclass's set_arch_to_kernel is fixed, but won't get used over this one!
1577 *) export ARCH="${ARCH}";;
1578 esac
1579}
1580
1581# set's ARCH back to what portage expects
1582set_arch_to_portage() {
1583 i=10
1584 while ((i--)) ; do
1585 ewarn "PLEASE UPDATE TO YOUR PACKAGE TO USE linux-info.eclass"
1586 done
1587 export ARCH="${EUTILS_ECLASS_PORTAGE_ARCH}"
1588}
1589
1590# Jeremy Huddleston <eradicator@gentoo.org>:
1591# preserve_old_lib /path/to/libblah.so.0
1592# preserve_old_lib_notify /path/to/libblah.so.0
1593#
1594# These functions are useful when a lib in your package changes --library. Such 1626# These functions are useful when a lib in your package changes ABI SONAME.
1595# an example might be from libogg.so.0 to libogg.so.1. Removing libogg.so.0 1627# An example might be from libogg.so.0 to libogg.so.1. Removing libogg.so.0
1596# would break packages that link against it. Most people get around this 1628# would break packages that link against it. Most people get around this
1597# by using the portage SLOT mechanism, but that is not always a relevant 1629# by using the portage SLOT mechanism, but that is not always a relevant
1598# solution, so instead you can add the following to your ebuilds: 1630# solution, so instead you can call this from pkg_preinst. See also the
1599# 1631# preserve_old_lib_notify function.
1600# pkg_preinst() {
1601# ...
1602# preserve_old_lib /usr/$(get_libdir)/libogg.so.0
1603# ...
1604# }
1605#
1606# pkg_postinst() {
1607# ...
1608# preserve_old_lib_notify /usr/$(get_libdir)/libogg.so.0
1609# ...
1610# }
1611
1612preserve_old_lib() { 1632preserve_old_lib() {
1613 if [[ ${EBUILD_PHASE} != "preinst" ]] ; then 1633 if [[ ${EBUILD_PHASE} != "preinst" ]] ; then
1614 eerror "preserve_old_lib() must be called from pkg_preinst() only" 1634 eerror "preserve_old_lib() must be called from pkg_preinst() only"
1615 die "Invalid preserve_old_lib() usage" 1635 die "Invalid preserve_old_lib() usage"
1616 fi 1636 fi
1617 [[ -z $1 ]] && die "Usage: preserve_old_lib <library to preserve> [more libraries to preserve]" 1637 [[ -z $1 ]] && die "Usage: preserve_old_lib <library to preserve> [more libraries to preserve]"
1638
1639 # let portage worry about it
1640 has preserve-libs ${FEATURES} && return 0
1618 1641
1619 local lib dir 1642 local lib dir
1620 for lib in "$@" ; do 1643 for lib in "$@" ; do
1621 [[ -e ${ROOT}/${lib} ]] || continue 1644 [[ -e ${ROOT}/${lib} ]] || continue
1622 dir=${lib%/*} 1645 dir=${lib%/*}
1624 cp "${ROOT}"/${lib} "${D}"/${lib} || die "cp ${lib} failed" 1647 cp "${ROOT}"/${lib} "${D}"/${lib} || die "cp ${lib} failed"
1625 touch "${D}"/${lib} 1648 touch "${D}"/${lib}
1626 done 1649 done
1627} 1650}
1628 1651
1652# @FUNCTION: preserve_old_lib_notify
1653# @USAGE: <libs to notify> [more libs]
1654# @DESCRIPTION:
1655# Spit helpful messages about the libraries preserved by preserve_old_lib.
1629preserve_old_lib_notify() { 1656preserve_old_lib_notify() {
1630 if [[ ${EBUILD_PHASE} != "postinst" ]] ; then 1657 if [[ ${EBUILD_PHASE} != "postinst" ]] ; then
1631 eerror "preserve_old_lib_notify() must be called from pkg_postinst() only" 1658 eerror "preserve_old_lib_notify() must be called from pkg_postinst() only"
1632 die "Invalid preserve_old_lib_notify() usage" 1659 die "Invalid preserve_old_lib_notify() usage"
1633 fi 1660 fi
1661
1662 # let portage worry about it
1663 has preserve-libs ${FEATURES} && return 0
1634 1664
1635 local lib notice=0 1665 local lib notice=0
1636 for lib in "$@" ; do 1666 for lib in "$@" ; do
1637 [[ -e ${ROOT}/${lib} ]] || continue 1667 [[ -e ${ROOT}/${lib} ]] || continue
1638 if [[ ${notice} -eq 0 ]] ; then 1668 if [[ ${notice} -eq 0 ]] ; then
1644 ewarn "helper program, simply emerge the 'gentoolkit' package." 1674 ewarn "helper program, simply emerge the 'gentoolkit' package."
1645 ewarn 1675 ewarn
1646 fi 1676 fi
1647 ewarn " # revdep-rebuild --library ${lib##*/}" 1677 ewarn " # revdep-rebuild --library ${lib##*/}"
1648 done 1678 done
1679 if [[ ${notice} -eq 1 ]] ; then
1680 ewarn
1681 ewarn "Once you've finished running revdep-rebuild, it should be safe to"
1682 ewarn "delete the old libraries. Here is a copy & paste for the lazy:"
1683 for lib in "$@" ; do
1684 ewarn " # rm '${lib}'"
1685 done
1686 fi
1649} 1687}
1650 1688
1651# Hack for people to figure out if a package was built with 1689# @FUNCTION: built_with_use
1652# certain USE flags
1653#
1654# Usage: built_with_use [--missing <action>] [-a|-o] <DEPEND ATOM> <List of USE flags> 1690# @USAGE: [--hidden] [--missing <action>] [-a|-o] <DEPEND ATOM> <List of USE flags>
1655# ex: built_with_use xchat gtk2 1691# @DESCRIPTION:
1692# A temporary hack until portage properly supports DEPENDing on USE
1693# flags being enabled in packages. This will check to see if the specified
1694# DEPEND atom was built with the specified list of USE flags. The
1695# --missing option controls the behavior if called on a package that does
1696# not actually support the defined USE flags (aka listed in IUSE).
1697# The default is to abort (call die). The -a and -o flags control
1698# the requirements of the USE flags. They correspond to "and" and "or"
1699# logic. So the -a flag means all listed USE flags must be enabled
1700# while the -o flag means at least one of the listed IUSE flags must be
1701# enabled. The --hidden option is really for internal use only as it
1702# means the USE flag we're checking is hidden expanded, so it won't be found
1703# in IUSE like normal USE flags.
1656# 1704#
1657# Flags: -a all USE flags should be utilized 1705# Remember that this function isn't terribly intelligent so order of optional
1658# -o at least one USE flag should be utilized 1706# flags matter.
1659# --missing peform the specified action if the flag is not in IUSE (true/false/die)
1660# --hidden USE flag we're checking is hidden expanded so it isnt in IUSE
1661# Note: the default flag is '-a'
1662built_with_use() { 1707built_with_use() {
1663 local hidden="no" 1708 local hidden="no"
1664 if [[ $1 == "--hidden" ]] ; then 1709 if [[ $1 == "--hidden" ]] ; then
1665 hidden="yes" 1710 hidden="yes"
1666 shift 1711 shift
1695 die) die "Unable to determine what USE flags $PKG was built with";; 1740 die) die "Unable to determine what USE flags $PKG was built with";;
1696 esac 1741 esac
1697 fi 1742 fi
1698 1743
1699 if [[ ${hidden} == "no" ]] ; then 1744 if [[ ${hidden} == "no" ]] ; then
1700 local IUSE_BUILT=$(<${IUSEFILE}) 1745 local IUSE_BUILT=( $(<"${IUSEFILE}") )
1701 # Don't check USE_EXPAND #147237 1746 # Don't check USE_EXPAND #147237
1702 local expand 1747 local expand
1703 for expand in $(echo ${USE_EXPAND} | tr '[:upper:]' '[:lower:]') ; do 1748 for expand in $(echo ${USE_EXPAND} | tr '[:upper:]' '[:lower:]') ; do
1704 if [[ $1 == ${expand}_* ]] ; then 1749 if [[ $1 == ${expand}_* ]] ; then
1705 expand="" 1750 expand=""
1706 break 1751 break
1707 fi 1752 fi
1708 done 1753 done
1709 if [[ -n ${expand} ]] ; then 1754 if [[ -n ${expand} ]] ; then
1710 if ! has $1 ${IUSE_BUILT} ; then 1755 if ! has $1 ${IUSE_BUILT[@]#[-+]} ; then
1711 case ${missing_action} in 1756 case ${missing_action} in
1712 true) return 0;; 1757 true) return 0;;
1713 false) return 1;; 1758 false) return 1;;
1714 die) die "$PKG does not actually support the $1 USE flag!";; 1759 die) die "$PKG does not actually support the $1 USE flag!";;
1715 esac 1760 esac
1727 shift 1772 shift
1728 done 1773 done
1729 [[ ${opt} = "-a" ]] 1774 [[ ${opt} = "-a" ]]
1730} 1775}
1731 1776
1777# @FUNCTION: epunt_cxx
1778# @USAGE: [dir to scan]
1779# @DESCRIPTION:
1732# Many configure scripts wrongly bail when a C++ compiler 1780# Many configure scripts wrongly bail when a C++ compiler could not be
1733# could not be detected. #73450 1781# detected. If dir is not specified, then it defaults to ${S}.
1782#
1783# http://bugs.gentoo.org/73450
1734epunt_cxx() { 1784epunt_cxx() {
1735 local dir=$1 1785 local dir=$1
1736 [[ -z ${dir} ]] && dir=${S} 1786 [[ -z ${dir} ]] && dir=${S}
1737 ebegin "Removing useless C++ checks" 1787 ebegin "Removing useless C++ checks"
1738 local f 1788 local f
1739 for f in $(find ${dir} -name configure) ; do 1789 find "${dir}" -name configure | while read f ; do
1740 patch -p0 "${f}" "${PORTDIR}/eclass/ELT-patches/nocxx/nocxx.patch" > /dev/null 1790 patch --no-backup-if-mismatch -p0 "${f}" "${PORTDIR}/eclass/ELT-patches/nocxx/nocxx.patch" > /dev/null
1741 done 1791 done
1742 eend 0 1792 eend 0
1743} 1793}
1744 1794
1745# make a wrapper script ... 1795# @FUNCTION: make_wrapper
1746# NOTE: this was originally games_make_wrapper, but I noticed other places where 1796# @USAGE: <wrapper> <target> [chdir] [libpaths] [installpath]
1747# this could be used, so I have moved it here and made it not games-specific 1797# @DESCRIPTION:
1748# -- wolf31o2 1798# Create a shell wrapper script named wrapper in installpath
1749# $1 == wrapper name 1799# (defaults to the bindir) to execute target (default of wrapper) by
1750# $2 == binary to run 1800# first optionally setting LD_LIBRARY_PATH to the colon-delimited
1751# $3 == directory to chdir before running binary 1801# libpaths followed by optionally changing directory to chdir.
1752# $4 == extra LD_LIBRARY_PATH's (make it : delimited)
1753# $5 == path for wrapper
1754make_wrapper() { 1802make_wrapper() {
1755 local wrapper=$1 bin=$2 chdir=$3 libdir=$4 path=$5 1803 local wrapper=$1 bin=$2 chdir=$3 libdir=$4 path=$5
1756 local tmpwrapper=$(emktemp) 1804 local tmpwrapper=$(emktemp)
1757 # We don't want to quote ${bin} so that people can pass complex 1805 # We don't want to quote ${bin} so that people can pass complex
1758 # things as $bin ... "./someprog --args" 1806 # things as $bin ... "./someprog --args"
1768fi 1816fi
1769exec ${bin} "\$@" 1817exec ${bin} "\$@"
1770EOF 1818EOF
1771 chmod go+rx "${tmpwrapper}" 1819 chmod go+rx "${tmpwrapper}"
1772 if [[ -n ${path} ]] ; then 1820 if [[ -n ${path} ]] ; then
1821 (
1773 exeinto "${path}" 1822 exeinto "${path}"
1774 newexe "${tmpwrapper}" "${wrapper}" 1823 newexe "${tmpwrapper}" "${wrapper}"
1824 ) || die
1775 else 1825 else
1776 newbin "${tmpwrapper}" "${wrapper}" 1826 newbin "${tmpwrapper}" "${wrapper}" || die
1827 fi
1828}
1829
1830# @FUNCTION: prepalldocs
1831# @USAGE:
1832# @DESCRIPTION:
1833# Compress files in /usr/share/doc which are not already
1834# compressed, excluding /usr/share/doc/${PF}/html.
1835# Uses the ecompressdir to do the compression.
1836# 2009-02-18 by betelgeuse:
1837# Commented because ecompressdir is even more internal to
1838# Portage than prepalldocs (it's not even mentioned in man 5
1839# ebuild). Please submit a better version for review to gentoo-dev
1840# if you want prepalldocs here.
1841#prepalldocs() {
1842# if [[ -n $1 ]] ; then
1843# ewarn "prepalldocs: invalid usage; takes no arguments"
1777 fi 1844# fi
1778} 1845
1846# cd "${D}"
1847# [[ -d usr/share/doc ]] || return 0
1848
1849# find usr/share/doc -exec gzip {} +
1850# ecompressdir --ignore /usr/share/doc/${PF}/html
1851# ecompressdir --queue /usr/share/doc
1852#}

Legend:
Removed from v.1.279  
changed lines
  Added in v.1.314

  ViewVC Help
Powered by ViewVC 1.1.20