/[gentoo-x86]/eclass/elisp-common.eclass
Gentoo

Diff of /eclass/elisp-common.eclass

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

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

Legend:
Removed from v.1.20  
changed lines
  Added in v.1.77

  ViewVC Help
Powered by ViewVC 1.1.20