| 1 |
# Copyright 1999-2009 Gentoo Foundation
|
| 2 |
# Distributed under the terms of the GNU General Public License v2
|
| 3 |
# $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.59 2009/04/08 10:47:42 ulm Exp $
|
| 4 |
#
|
| 5 |
# Copyright 2002-2004 Matthew Kennedy <mkennedy@gentoo.org>
|
| 6 |
# Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com>
|
| 7 |
# Copyright 2004-2005 Mamoru Komachi <usata@gentoo.org>
|
| 8 |
# Copyright 2007-2008 Christian Faulhammer <fauli@gentoo.org>
|
| 9 |
# Copyright 2007-2009 Ulrich Müller <ulm@gentoo.org>
|
| 10 |
#
|
| 11 |
# @ECLASS: elisp-common.eclass
|
| 12 |
# @MAINTAINER:
|
| 13 |
# Feel free to contact the Emacs team through <emacs@gentoo.org> if you
|
| 14 |
# have problems, suggestions or questions.
|
| 15 |
# @BLURB: Emacs-related installation utilities
|
| 16 |
# @DESCRIPTION:
|
| 17 |
#
|
| 18 |
# Usually you want to use this eclass for (optional) GNU Emacs support
|
| 19 |
# of your package. This is NOT for XEmacs!
|
| 20 |
#
|
| 21 |
# Many of the steps here are sometimes done by the build system of your
|
| 22 |
# package (especially compilation), so this is mainly for standalone
|
| 23 |
# elisp files you gathered from somewhere else.
|
| 24 |
#
|
| 25 |
# When relying on the emacs USE flag, you need to add
|
| 26 |
#
|
| 27 |
# emacs? ( virtual/emacs )
|
| 28 |
#
|
| 29 |
# to your DEPEND/RDEPEND line and use the functions provided here to
|
| 30 |
# bring the files to the correct locations.
|
| 31 |
#
|
| 32 |
# .SS
|
| 33 |
# src_compile() usage:
|
| 34 |
#
|
| 35 |
# An elisp file is compiled by the elisp-compile() function defined
|
| 36 |
# here and simply takes the source files as arguments. The case of
|
| 37 |
# interdependent elisp files is also supported, since the current
|
| 38 |
# directory is added to the load-path which makes sure that all files
|
| 39 |
# are loadable.
|
| 40 |
#
|
| 41 |
# elisp-compile *.el || die
|
| 42 |
#
|
| 43 |
# Function elisp-make-autoload-file() can be used to generate a file
|
| 44 |
# with autoload definitions for the lisp functions. It takes the output
|
| 45 |
# file name (default: "${PN}-autoloads.el") and a list of directories
|
| 46 |
# (default: working directory) as its arguments. Use of this function
|
| 47 |
# requires that the elisp source files contain magic ";;;###autoload"
|
| 48 |
# comments. See the Emacs Lisp Reference Manual (node "Autoload") for
|
| 49 |
# a detailed explanation.
|
| 50 |
#
|
| 51 |
# .SS
|
| 52 |
# src_install() usage:
|
| 53 |
#
|
| 54 |
# The resulting compiled files (.elc) should be put in a subdirectory of
|
| 55 |
# /usr/share/emacs/site-lisp/ which is named after the first argument
|
| 56 |
# of elisp-install(). The following parameters are the files to be put
|
| 57 |
# in that directory. Usually the subdirectory should be ${PN}, you can
|
| 58 |
# choose something else, but remember to tell elisp-site-file-install()
|
| 59 |
# (see below) the change, as it defaults to ${PN}.
|
| 60 |
#
|
| 61 |
# elisp-install ${PN} *.el *.elc || die
|
| 62 |
#
|
| 63 |
# To let the Emacs support be activated by Emacs on startup, you need
|
| 64 |
# to provide a site file (shipped in ${FILESDIR}) which contains the
|
| 65 |
# startup code (have a look in the documentation of your software).
|
| 66 |
# Normally this would look like this:
|
| 67 |
#
|
| 68 |
# ;;; csv-mode site-lisp configuration
|
| 69 |
#
|
| 70 |
# (add-to-list 'load-path "@SITELISP@")
|
| 71 |
# (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode))
|
| 72 |
# (autoload 'csv-mode "csv-mode" "Major mode for csv files." t)
|
| 73 |
#
|
| 74 |
# If your Emacs support files are installed in a subdirectory of
|
| 75 |
# /usr/share/emacs/site-lisp/ (which is strongly recommended), you need
|
| 76 |
# to extend Emacs' load-path as shown in the first non-comment line.
|
| 77 |
# The elisp-site-file-install() function of this eclass will replace
|
| 78 |
# "@SITELISP@" and "@SITEETC@" by the actual paths.
|
| 79 |
#
|
| 80 |
# The next line tells Emacs to load the mode opening a file ending
|
| 81 |
# with ".csv" and load functions depending on the context and needed
|
| 82 |
# features. Be careful though. Commands as "load-library" or "require"
|
| 83 |
# bloat the editor as they are loaded on every startup. When having
|
| 84 |
# many Emacs support files, users may be annoyed by the start-up time.
|
| 85 |
# Also avoid keybindings as they might interfere with the user's
|
| 86 |
# settings. Give a hint in pkg_postinst(), which should be enough.
|
| 87 |
#
|
| 88 |
# The naming scheme for this site-init file matches the shell pattern
|
| 89 |
# "[1-8][0-9]*-gentoo*.el", where the two digits at the beginning define
|
| 90 |
# the loading order (numbers below 10 or above 89 are reserved for
|
| 91 |
# internal use). So if your initialisation depends on another Emacs
|
| 92 |
# package, your site file's number must be higher!
|
| 93 |
#
|
| 94 |
# Best practice is to define a SITEFILE variable in the global scope of
|
| 95 |
# your ebuild (e.g., right after S or RDEPEND):
|
| 96 |
#
|
| 97 |
# SITEFILE="50${PN}-gentoo.el"
|
| 98 |
#
|
| 99 |
# Which is then installed by
|
| 100 |
#
|
| 101 |
# elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
|
| 102 |
#
|
| 103 |
# in src_install(). Any characters after the "-gentoo" part and before
|
| 104 |
# the extension will be stripped from the destination file's name.
|
| 105 |
# For example, a file "50${PN}-gentoo-${PV}.el" will be installed as
|
| 106 |
# "50${PN}-gentoo.el". If your subdirectory is not named ${PN}, give
|
| 107 |
# the differing name as second argument.
|
| 108 |
#
|
| 109 |
# .SS
|
| 110 |
# pkg_postinst() / pkg_postrm() usage:
|
| 111 |
#
|
| 112 |
# After that you need to recreate the start-up file of Emacs after
|
| 113 |
# emerging and unmerging by using
|
| 114 |
#
|
| 115 |
# pkg_postinst() {
|
| 116 |
# elisp-site-regen
|
| 117 |
# }
|
| 118 |
#
|
| 119 |
# pkg_postrm() {
|
| 120 |
# elisp-site-regen
|
| 121 |
# }
|
| 122 |
#
|
| 123 |
# When having optional Emacs support, you should prepend "use emacs &&"
|
| 124 |
# to above calls of elisp-site-regen().
|
| 125 |
# Don't use "has_version virtual/emacs"! When unmerging the state of
|
| 126 |
# the emacs USE flag is taken from the package database and not from the
|
| 127 |
# environment, so it is no problem when you unset USE=emacs between
|
| 128 |
# merge and unmerge of a package.
|
| 129 |
#
|
| 130 |
# .SS
|
| 131 |
# Miscellaneous functions:
|
| 132 |
#
|
| 133 |
# elisp-emacs-version() outputs the version of the currently active Emacs.
|
| 134 |
|
| 135 |
# @ECLASS-VARIABLE: SITELISP
|
| 136 |
# @DESCRIPTION:
|
| 137 |
# Directory where packages install Emacs Lisp files.
|
| 138 |
SITELISP=/usr/share/emacs/site-lisp
|
| 139 |
|
| 140 |
# @ECLASS-VARIABLE: SITEETC
|
| 141 |
# @DESCRIPTION:
|
| 142 |
# Directory where packages install miscellaneous (not Lisp) files.
|
| 143 |
SITEETC=/usr/share/emacs/etc
|
| 144 |
|
| 145 |
# @ECLASS-VARIABLE: EMACS
|
| 146 |
# @DESCRIPTION:
|
| 147 |
# Path of Emacs executable.
|
| 148 |
EMACS=/usr/bin/emacs
|
| 149 |
|
| 150 |
# @ECLASS-VARIABLE: EMACSFLAGS
|
| 151 |
# @DESCRIPTION:
|
| 152 |
# Flags for executing Emacs in batch mode.
|
| 153 |
# These work for Emacs versions 18-23, so don't change them.
|
| 154 |
EMACSFLAGS="-batch -q --no-site-file"
|
| 155 |
|
| 156 |
# @ECLASS-VARIABLE: BYTECOMPFLAGS
|
| 157 |
# @DESCRIPTION:
|
| 158 |
# Emacs flags used for byte-compilation in elisp-compile().
|
| 159 |
BYTECOMPFLAGS="-L ."
|
| 160 |
|
| 161 |
# @FUNCTION: elisp-compile
|
| 162 |
# @USAGE: <list of elisp files>
|
| 163 |
# @DESCRIPTION:
|
| 164 |
# Byte-compile Emacs Lisp files.
|
| 165 |
#
|
| 166 |
# This function uses GNU Emacs to byte-compile all ".el" specified by
|
| 167 |
# its arguments. The resulting byte-code (".elc") files are placed in
|
| 168 |
# the same directory as their corresponding source file.
|
| 169 |
#
|
| 170 |
# The current directory is added to the load-path. This will ensure
|
| 171 |
# that interdependent Emacs Lisp files are visible between themselves,
|
| 172 |
# in case they require or load one another.
|
| 173 |
|
| 174 |
elisp-compile() {
|
| 175 |
ebegin "Compiling GNU Emacs Elisp files"
|
| 176 |
${EMACS} ${EMACSFLAGS} ${BYTECOMPFLAGS} -f batch-byte-compile "$@"
|
| 177 |
eend $? "elisp-compile: batch-byte-compile failed"
|
| 178 |
}
|
| 179 |
|
| 180 |
elisp-comp() {
|
| 181 |
die "Function elisp-comp is not supported any more, see bug 235442"
|
| 182 |
}
|
| 183 |
|
| 184 |
# @FUNCTION: elisp-emacs-version
|
| 185 |
# @DESCRIPTION:
|
| 186 |
# Output version of currently active Emacs.
|
| 187 |
|
| 188 |
elisp-emacs-version() {
|
| 189 |
# The following will work for at least versions 18-23.
|
| 190 |
echo "(princ emacs-version)" >"${T}"/emacs-version.el
|
| 191 |
${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
|
| 192 |
rm -f "${T}"/emacs-version.el
|
| 193 |
}
|
| 194 |
|
| 195 |
# @FUNCTION: elisp-make-autoload-file
|
| 196 |
# @USAGE: [output file] [list of directories]
|
| 197 |
# @DESCRIPTION:
|
| 198 |
# Generate a file with autoload definitions for the lisp functions.
|
| 199 |
|
| 200 |
elisp-make-autoload-file() {
|
| 201 |
local f="${1:-${PN}-autoloads.el}"
|
| 202 |
shift
|
| 203 |
ebegin "Generating autoload file for GNU Emacs"
|
| 204 |
|
| 205 |
sed 's/^FF/\f/' >"${f}" <<-EOF
|
| 206 |
;;; ${f##*/} --- autoloads for ${P}
|
| 207 |
|
| 208 |
;;; Commentary:
|
| 209 |
;; Automatically generated by elisp-common.eclass
|
| 210 |
;; DO NOT EDIT THIS FILE
|
| 211 |
|
| 212 |
;;; Code:
|
| 213 |
FF
|
| 214 |
;; Local Variables:
|
| 215 |
;; version-control: never
|
| 216 |
;; no-byte-compile: t
|
| 217 |
;; no-update-autoloads: t
|
| 218 |
;; End:
|
| 219 |
;;; ${f##*/} ends here
|
| 220 |
EOF
|
| 221 |
|
| 222 |
${EMACS} ${EMACSFLAGS} \
|
| 223 |
--eval "(setq make-backup-files nil)" \
|
| 224 |
--eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
|
| 225 |
-f batch-update-autoloads "${@-.}"
|
| 226 |
|
| 227 |
eend $? "elisp-make-autoload-file: batch-update-autoloads failed"
|
| 228 |
}
|
| 229 |
|
| 230 |
# @FUNCTION: elisp-install
|
| 231 |
# @USAGE: <subdirectory> <list of files>
|
| 232 |
# @DESCRIPTION:
|
| 233 |
# Install files in SITELISP directory.
|
| 234 |
|
| 235 |
elisp-install() {
|
| 236 |
local subdir="$1"
|
| 237 |
shift
|
| 238 |
ebegin "Installing Elisp files for GNU Emacs support"
|
| 239 |
( # subshell to avoid pollution of calling environment
|
| 240 |
insinto "${SITELISP}/${subdir}"
|
| 241 |
doins "$@"
|
| 242 |
)
|
| 243 |
eend $? "elisp-install: doins failed"
|
| 244 |
}
|
| 245 |
|
| 246 |
# @FUNCTION: elisp-site-file-install
|
| 247 |
# @USAGE: <site-init file> [subdirectory]
|
| 248 |
# @DESCRIPTION:
|
| 249 |
# Install Emacs site-init file in SITELISP directory. Automatically
|
| 250 |
# inserts a standard comment header with the name of the package (unless
|
| 251 |
# it is already present). Tokens @SITELISP@ and @SITEETC@ are replaced
|
| 252 |
# by the path to the package's subdirectory in SITELISP and SITEETC,
|
| 253 |
# respectively.
|
| 254 |
|
| 255 |
elisp-site-file-install() {
|
| 256 |
local sf="${1##*/}" my_pn="${2:-${PN}}" ret
|
| 257 |
local header=";;; ${PN} site-lisp configuration"
|
| 258 |
|
| 259 |
[[ ${sf} == [0-9][0-9]*-gentoo*.el ]] \
|
| 260 |
|| ewarn "elisp-site-file-install: bad name of site-init file"
|
| 261 |
sf="${T}/${sf/%-gentoo*.el/-gentoo.el}"
|
| 262 |
ebegin "Installing site initialisation file for GNU Emacs"
|
| 263 |
[[ $1 = ${sf} ]] || cp "$1" "${sf}"
|
| 264 |
sed -i -e "1{:x;/^\$/{n;bx;};/^;.*${PN}/I!s:^:${header}\n\n:;1s:^:\n:;}" \
|
| 265 |
-e "s:@SITELISP@:${SITELISP}/${my_pn}:g" \
|
| 266 |
-e "s:@SITEETC@:${SITEETC}/${my_pn}:g;\$q" "${sf}"
|
| 267 |
( # subshell to avoid pollution of calling environment
|
| 268 |
insinto "${SITELISP}/site-gentoo.d"
|
| 269 |
doins "${sf}"
|
| 270 |
)
|
| 271 |
ret=$?
|
| 272 |
rm -f "${sf}"
|
| 273 |
eend ${ret} "elisp-site-file-install: doins failed"
|
| 274 |
}
|
| 275 |
|
| 276 |
# @FUNCTION: elisp-site-regen
|
| 277 |
# @DESCRIPTION:
|
| 278 |
# Regenerate the site-gentoo.el file, based on packages' site
|
| 279 |
# initialisation files in the /usr/share/emacs/site-lisp/site-gentoo.d/
|
| 280 |
# directory.
|
| 281 |
#
|
| 282 |
# Note: Before December 2007, site initialisation files were installed
|
| 283 |
# in /usr/share/emacs/site-lisp/. For backwards compatibility, this
|
| 284 |
# location is still supported when generating site-gentoo.el.
|
| 285 |
|
| 286 |
elisp-site-regen() {
|
| 287 |
local i sf line obsolete
|
| 288 |
local -a sflist
|
| 289 |
|
| 290 |
if [ ! -d "${ROOT}${SITELISP}" ]; then
|
| 291 |
eerror "elisp-site-regen: Directory ${SITELISP} does not exist"
|
| 292 |
return 1
|
| 293 |
fi
|
| 294 |
|
| 295 |
if [ ! -d "${T}" ]; then
|
| 296 |
eerror "elisp-site-regen: Temporary directory ${T} does not exist"
|
| 297 |
return 1
|
| 298 |
fi
|
| 299 |
|
| 300 |
einfon "Regenerating site-gentoo.el for GNU Emacs (${EBUILD_PHASE}) ..."
|
| 301 |
|
| 302 |
# Until January 2009, elisp-common.eclass sometimes created an
|
| 303 |
# auxiliary file for backwards compatibility. Remove any such file.
|
| 304 |
rm -f "${ROOT}${SITELISP}"/00site-gentoo.el
|
| 305 |
|
| 306 |
# set nullglob option, there may be a directory without matching files
|
| 307 |
local old_shopts=$(shopt -p nullglob)
|
| 308 |
shopt -s nullglob
|
| 309 |
|
| 310 |
for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el \
|
| 311 |
"${ROOT}${SITELISP}"/site-gentoo.d/[0-9][0-9]*.el
|
| 312 |
do
|
| 313 |
[ -r "${sf}" ] || continue
|
| 314 |
# sort files by their basename. straight insertion sort.
|
| 315 |
for ((i=${#sflist[@]}; i>0; i--)); do
|
| 316 |
[[ ${sf##*/} < ${sflist[i-1]##*/} ]] || break
|
| 317 |
sflist[i]=${sflist[i-1]}
|
| 318 |
done
|
| 319 |
sflist[i]=${sf}
|
| 320 |
# set a flag if there are obsolete files
|
| 321 |
[ "${sf%/*}" = "${ROOT}${SITELISP}" ] && obsolete=t
|
| 322 |
done
|
| 323 |
|
| 324 |
eval "${old_shopts}"
|
| 325 |
|
| 326 |
cat <<-EOF >"${T}"/site-gentoo.el
|
| 327 |
;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
|
| 328 |
|
| 329 |
;;; Commentary:
|
| 330 |
;; Automatically generated by elisp-common.eclass
|
| 331 |
;; DO NOT EDIT THIS FILE
|
| 332 |
|
| 333 |
;;; Code:
|
| 334 |
EOF
|
| 335 |
# Use sed instead of cat here, since files may miss a trailing newline.
|
| 336 |
sed '$q' "${sflist[@]}" </dev/null >>"${T}"/site-gentoo.el
|
| 337 |
cat <<-EOF >>"${T}"/site-gentoo.el
|
| 338 |
|
| 339 |
(provide 'site-gentoo)
|
| 340 |
|
| 341 |
;; Local Variables:
|
| 342 |
;; no-byte-compile: t
|
| 343 |
;; End:
|
| 344 |
;;; site-gentoo.el ends here
|
| 345 |
EOF
|
| 346 |
|
| 347 |
if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${T}"/site-gentoo.el
|
| 348 |
then
|
| 349 |
# This prevents outputting unnecessary text when there
|
| 350 |
# was actually no change.
|
| 351 |
# A case is a remerge where we have doubled output.
|
| 352 |
echo " no changes."
|
| 353 |
else
|
| 354 |
mv "${T}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
|
| 355 |
echo
|
| 356 |
einfo "... ${#sflist[@]} site initialisation file(s) included."
|
| 357 |
fi
|
| 358 |
|
| 359 |
if [ "${obsolete}" ]; then
|
| 360 |
echo
|
| 361 |
while read line; do ewarn "${line}"; done <<-EOF
|
| 362 |
Site-initialisation files of Emacs packages are now installed in
|
| 363 |
/usr/share/emacs/site-lisp/site-gentoo.d/. We strongly recommend
|
| 364 |
that you use app-admin/emacs-updater to rebuild the installed
|
| 365 |
Emacs packages.
|
| 366 |
EOF
|
| 367 |
fi
|
| 368 |
|
| 369 |
# cleanup
|
| 370 |
rm -f "${T}"/site-gentoo.el
|
| 371 |
|
| 372 |
return 0
|
| 373 |
}
|
Parent Directory
| 
Revision Log