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