| 1 |
# Copyright 1999-2010 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.67 2010/09/17 07:41:05 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-2010 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 |
# (add-to-list 'load-path "@SITELISP@") |
| 69 |
# (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode)) |
| 70 |
# (autoload 'csv-mode "csv-mode" "Major mode for csv files." t) |
| 71 |
# |
| 72 |
# If your Emacs support files are installed in a subdirectory of |
| 73 |
# /usr/share/emacs/site-lisp/ (which is strongly recommended), you need |
| 74 |
# to extend Emacs' load-path as shown in the first non-comment line. |
| 75 |
# The elisp-site-file-install() function of this eclass will replace |
| 76 |
# "@SITELISP@" and "@SITEETC@" by the actual paths. |
| 77 |
# |
| 78 |
# The next line tells Emacs to load the mode opening a file ending |
| 79 |
# with ".csv" and load functions depending on the context and needed |
| 80 |
# features. Be careful though. Commands as "load-library" or "require" |
| 81 |
# bloat the editor as they are loaded on every startup. When having |
| 82 |
# many Emacs support files, users may be annoyed by the start-up time. |
| 83 |
# Also avoid keybindings as they might interfere with the user's |
| 84 |
# settings. Give a hint in pkg_postinst(), which should be enough. |
| 85 |
# |
| 86 |
# The naming scheme for this site-init file matches the shell pattern |
| 87 |
# "[1-8][0-9]*-gentoo*.el", where the two digits at the beginning define |
| 88 |
# the loading order (numbers below 10 or above 89 are reserved for |
| 89 |
# internal use). So if your initialisation depends on another Emacs |
| 90 |
# package, your site file's number must be higher! If there are no such |
| 91 |
# interdependencies then the number should be 50. Otherwise, numbers |
| 92 |
# divisible by 10 are preferred. |
| 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=${EPREFIX}/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}" null="" page=$'\f' |
| 202 |
shift |
| 203 |
ebegin "Generating autoload file for GNU Emacs" |
| 204 |
|
| 205 |
cat >"${f}" <<-EOF |
| 206 |
;;; ${f##*/} --- autoloads for ${PN} |
| 207 |
|
| 208 |
;;; Commentary: |
| 209 |
;; Automatically generated by elisp-common.eclass |
| 210 |
;; DO NOT EDIT THIS FILE |
| 211 |
|
| 212 |
;;; Code: |
| 213 |
${page} |
| 214 |
;; Local ${null}Variables: |
| 215 |
;; version-control: never |
| 216 |
;; no-byte-compile: t |
| 217 |
;; no-update-autoloads: t |
| 218 |
;; End: |
| 219 |
|
| 220 |
;;; ${f##*/} ends here |
| 221 |
EOF |
| 222 |
|
| 223 |
${EMACS} ${EMACSFLAGS} \ |
| 224 |
--eval "(setq make-backup-files nil)" \ |
| 225 |
--eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \ |
| 226 |
-f batch-update-autoloads "${@-.}" |
| 227 |
|
| 228 |
eend $? "elisp-make-autoload-file: batch-update-autoloads failed" |
| 229 |
} |
| 230 |
|
| 231 |
# @FUNCTION: elisp-install |
| 232 |
# @USAGE: <subdirectory> <list of files> |
| 233 |
# @DESCRIPTION: |
| 234 |
# Install files in SITELISP directory. |
| 235 |
|
| 236 |
elisp-install() { |
| 237 |
local subdir="$1" |
| 238 |
shift |
| 239 |
ebegin "Installing Elisp files for GNU Emacs support" |
| 240 |
( # subshell to avoid pollution of calling environment |
| 241 |
insinto "${SITELISP}/${subdir}" |
| 242 |
doins "$@" |
| 243 |
) |
| 244 |
eend $? "elisp-install: doins failed" |
| 245 |
} |
| 246 |
|
| 247 |
# @FUNCTION: elisp-site-file-install |
| 248 |
# @USAGE: <site-init file> [subdirectory] |
| 249 |
# @DESCRIPTION: |
| 250 |
# Install Emacs site-init file in SITELISP directory. Automatically |
| 251 |
# inserts a standard comment header with the name of the package (unless |
| 252 |
# it is already present). Tokens @SITELISP@ and @SITEETC@ are replaced |
| 253 |
# by the path to the package's subdirectory in SITELISP and SITEETC, |
| 254 |
# respectively. |
| 255 |
|
| 256 |
elisp-site-file-install() { |
| 257 |
local sf="${1##*/}" my_pn="${2:-${PN}}" ret |
| 258 |
local header=";;; ${PN} site-lisp configuration" |
| 259 |
|
| 260 |
[[ ${sf} == [0-9][0-9]*-gentoo*.el ]] \ |
| 261 |
|| ewarn "elisp-site-file-install: bad name of site-init file" |
| 262 |
sf="${T}/${sf/%-gentoo*.el/-gentoo.el}" |
| 263 |
ebegin "Installing site initialisation file for GNU Emacs" |
| 264 |
[[ $1 = ${sf} ]] || cp "$1" "${sf}" |
| 265 |
sed -i -e "1{:x;/^\$/{n;bx;};/^;.*${PN}/I!s:^:${header}\n\n:;1s:^:\n:;}" \ |
| 266 |
-e "s:@SITELISP@:${EPREFIX}${SITELISP}/${my_pn}:g" \ |
| 267 |
-e "s:@SITEETC@:${EPREFIX}${SITEETC}/${my_pn}:g;\$q" "${sf}" |
| 268 |
( # subshell to avoid pollution of calling environment |
| 269 |
insinto "${SITELISP}/site-gentoo.d" |
| 270 |
doins "${sf}" |
| 271 |
) |
| 272 |
ret=$? |
| 273 |
rm -f "${sf}" |
| 274 |
eend ${ret} "elisp-site-file-install: doins failed" |
| 275 |
} |
| 276 |
|
| 277 |
# @FUNCTION: elisp-site-regen |
| 278 |
# @DESCRIPTION: |
| 279 |
# Regenerate the site-gentoo.el file, based on packages' site |
| 280 |
# initialisation files in the /usr/share/emacs/site-lisp/site-gentoo.d/ |
| 281 |
# directory. |
| 282 |
# |
| 283 |
# Note: Before December 2007, site initialisation files were installed |
| 284 |
# in /usr/share/emacs/site-lisp/. For backwards compatibility, this |
| 285 |
# location is still supported when generating site-gentoo.el. |
| 286 |
|
| 287 |
elisp-site-regen() { |
| 288 |
local sitelisp=${ROOT}${EPREFIX}${SITELISP} |
| 289 |
local sf i line null="" page=$'\f' |
| 290 |
local -a sflist |
| 291 |
|
| 292 |
if [ ! -d "${sitelisp}" ]; then |
| 293 |
eerror "elisp-site-regen: Directory ${sitelisp} does not exist" |
| 294 |
return 1 |
| 295 |
fi |
| 296 |
|
| 297 |
if [ ! -d "${T}" ]; then |
| 298 |
eerror "elisp-site-regen: Temporary directory ${T} does not exist" |
| 299 |
return 1 |
| 300 |
fi |
| 301 |
|
| 302 |
einfon "Regenerating site-gentoo.el for GNU Emacs (${EBUILD_PHASE}) ..." |
| 303 |
|
| 304 |
# Until January 2009, elisp-common.eclass sometimes created an |
| 305 |
# auxiliary file for backwards compatibility. Remove any such file. |
| 306 |
rm -f "${sitelisp}"/00site-gentoo.el |
| 307 |
|
| 308 |
for sf in "${sitelisp}"/[0-9][0-9]*-gentoo.el \ |
| 309 |
"${sitelisp}"/site-gentoo.d/[0-9][0-9]*.el |
| 310 |
do |
| 311 |
[ -r "${sf}" ] || continue |
| 312 |
# sort files by their basename. straight insertion sort. |
| 313 |
for ((i=${#sflist[@]}; i>0; i--)); do |
| 314 |
[[ ${sf##*/} < ${sflist[i-1]##*/} ]] || break |
| 315 |
sflist[i]=${sflist[i-1]} |
| 316 |
done |
| 317 |
sflist[i]=${sf} |
| 318 |
done |
| 319 |
|
| 320 |
cat <<-EOF >"${T}"/site-gentoo.el |
| 321 |
;;; site-gentoo.el --- site initialisation for Gentoo-installed packages |
| 322 |
|
| 323 |
;;; Commentary: |
| 324 |
;; Automatically generated by elisp-common.eclass |
| 325 |
;; DO NOT EDIT THIS FILE |
| 326 |
|
| 327 |
;;; Code: |
| 328 |
EOF |
| 329 |
# Use sed instead of cat here, since files may miss a trailing newline. |
| 330 |
sed '$q' "${sflist[@]}" </dev/null >>"${T}"/site-gentoo.el |
| 331 |
cat <<-EOF >>"${T}"/site-gentoo.el |
| 332 |
|
| 333 |
(provide 'site-gentoo) |
| 334 |
|
| 335 |
${page} |
| 336 |
;; Local ${null}Variables: |
| 337 |
;; no-byte-compile: t |
| 338 |
;; buffer-read-only: t |
| 339 |
;; End: |
| 340 |
|
| 341 |
;;; site-gentoo.el ends here |
| 342 |
EOF |
| 343 |
|
| 344 |
if cmp -s "${sitelisp}"/site-gentoo.el "${T}"/site-gentoo.el; then |
| 345 |
# This prevents outputting unnecessary text when there |
| 346 |
# was actually no change. |
| 347 |
# A case is a remerge where we have doubled output. |
| 348 |
rm -f "${T}"/site-gentoo.el |
| 349 |
echo " no changes." |
| 350 |
else |
| 351 |
mv "${T}"/site-gentoo.el "${sitelisp}"/site-gentoo.el |
| 352 |
echo |
| 353 |
case ${#sflist[@]} in |
| 354 |
0) ewarn "... Huh? No site initialisation files found." ;; |
| 355 |
1) einfo "... ${#sflist[@]} site initialisation file included." ;; |
| 356 |
*) einfo "... ${#sflist[@]} site initialisation files included." ;; |
| 357 |
esac |
| 358 |
fi |
| 359 |
|
| 360 |
return 0 |
| 361 |
} |
Parent Directory
| 
Revision Log