/[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.35
1# Copyright 1999-2007 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/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.35 2008/02/22 09:28:53 ulm 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 <opfer@gentoo.org>
8# Copyright 2007 Ulrich Mueller <ulm@gentoo.org> 9# Copyright 2007-2008 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:
12# 13# Feel free to contact the Emacs team through <emacs@gentoo.org> if you have
13# USAGE: 14# problems, suggestions or questions.
15# @BLURB: Emacs-related installation utilities
16# @DESCRIPTION:
14# 17#
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 of
16# your package. This is NOT for XEmacs! 19# 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 elisp
19# files you gathered from somewhere else. 23# 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 bring
25# the files to the correct locations. 30# 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 here and
31# simply takes the source files as arguments. In the case of interdependent 36# simply takes the source files as arguments.
32# elisp files, you can use the elisp-comp() function which makes sure all
33# files are loadable.
34# 37#
35# elisp-compile *.el || die "elisp-compile failed!" 38# elisp-compile *.el || die "elisp-compile failed"
36# or 39#
40# In the case of interdependent elisp files, you can use the elisp-comp()
41# function which makes sure all files are loadable.
42#
37# elisp-comp *.el || die "elisp-comp failed!" 43# elisp-comp *.el || die "elisp-comp failed"
38# 44#
39# Function elisp-make-autoload-file() can be used to generate a file with 45# Function elisp-make-autoload-file() can be used to generate a file with
40# autoload definitions for the lisp functions. It takes the output file name 46# autoload definitions for the lisp functions. It takes the output file name
41# (default: "${PN}-autoloads.el") and a list of directories (default: working 47# (default: "${PN}-autoloads.el") and a list of directories (default: working
42# directory) as its arguments. Use of this function requires that the elisp 48# directory) as its arguments. Use of this function requires that the elisp
43# source files contain magic ";;;###autoload" comments. See the Emacs Lisp 49# source files contain magic ";;;###autoload" comments. See the Emacs Lisp
44# Reference Manual (node "Autoload") for a detailed explanation. 50# Reference Manual (node "Autoload") for a detailed explanation.
45# 51#
52# .SS
46# src_install() usage: 53# src_install() usage:
47# --------------------
48# 54#
49# The resulting compiled files (.elc) should be put in a subdirectory of 55# 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 56# /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 57# of elisp-install(). The following parameters are the files to be put in
52# that directory. Usually the subdirectory should be ${PN}, you can choose 58# that directory. Usually the subdirectory should be ${PN}, you can choose
53# something else, but remember to tell elisp-site-file-install() (see below) 59# something else, but remember to tell elisp-site-file-install() (see below)
54# the change, as it defaults to ${PN}. 60# the change, as it defaults to ${PN}.
55# 61#
56# elisp-install ${PN} *.elc *.el || die "elisp-install failed!" 62# elisp-install ${PN} *.el *.elc || die "elisp-install failed"
57# 63#
58# To let the Emacs support be activated by Emacs on startup, you need 64# 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 65# to provide a site file (shipped in ${FILESDIR}) which contains the startup
60# code (have a look in the documentation of your software). Normally this 66# code (have a look in the documentation of your software). Normally this
61# would look like this: 67# would look like this:
62# 68#
63# ;;; csv-mode site-lisp configuration 69# ;;; csv-mode site-lisp configuration
64# 70#
65# (add-to-list 'load-path "@SITELISP@") 71# (add-to-list 'load-path "@SITELISP@")
66# (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode)) 72# (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode))
67# (autoload 'csv-mode "csv-mode" "Major mode for editing csv files." t) 73# (autoload 'csv-mode "csv-mode" "Major mode for csv files." t)
68# 74#
69# If your Emacs support files are installed in a subdirectory of 75# 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 76# /usr/share/emacs/site-lisp/ (which is recommended), you need to extend
71# installed), you need to extend Emacs' load-path as shown in the first 77# Emacs' load-path as shown in the first non-comment.
72# non-comment. The elisp-site-file-install() function of this eclass will 78# The elisp-site-file-install() function of this eclass will replace
73# replace "@SITELISP@" by the actual path. 79# "@SITELISP@" by the actual path.
80#
74# The next line tells Emacs to load the mode opening a file ending with 81# The next line tells Emacs to load the mode opening a file ending with
75# ".csv" and load functions depending on the context and needed features. 82# ".csv" and load functions depending on the context and needed features.
76# Be careful though. Commands as "load-library" or "require" bloat the 83# Be careful though. Commands as "load-library" or "require" bloat the
77# editor as they are loaded on every startup. When having a lot of Emacs 84# editor as they are loaded on every startup. When having a lot of Emacs
78# support files, users may be annoyed by the start-up time. Also avoid 85# support files, users may be annoyed by the start-up time. Also avoid
79# keybindings as they might interfere with the user's settings. Give a hint 86# keybindings as they might interfere with the user's settings. Give a hint
80# in pkg_postinst(), which should be enough. 87# in pkg_postinst(), which should be enough.
88#
81# The naming scheme for this site file is "[0-9][0-9]*-gentoo.el", where the 89# The naming scheme for this site file is "[0-9][0-9]*-gentoo.el", where the
82# two digits at the beginning define the loading order. So if you depend on 90# two digits at the beginning define the loading order. So if you depend on
83# another Emacs package, your site file's number must be higher! 91# another Emacs package, your site file's number must be higher!
92#
84# Best practice is to define a SITEFILE variable in the global scope of your 93# Best practice is to define a SITEFILE variable in the global scope of your
85# ebuild (right after DEPEND e.g.): 94# ebuild (right after DEPEND e.g.):
86# 95#
87# SITEFILE=50${PN}-gentoo.el 96# SITEFILE=50${PN}-gentoo.el
88# 97#
89# Which is then installed by 98# Which is then installed by
90# 99#
91# elisp-site-file-install "${FILESDIR}/${SITEFILE}" 100# elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
92# 101#
93# in src_install(). If your subdirectory is not named ${PN}, give the 102# in src_install(). If your subdirectory is not named ${PN}, give the
94# differing name as second argument. 103# differing name as second argument.
95# 104#
105# .SS
96# pkg_postinst() / pkg_postrm() usage: 106# pkg_postinst() / pkg_postrm() usage:
97# ------------------------------------
98# 107#
99# After that you need to recreate the start-up file of Emacs after emerging 108# After that you need to recreate the start-up file of Emacs after emerging
100# and unmerging by using 109# and unmerging by using
101# 110#
102# pkg_postinst() { 111# pkg_postinst() {
103# elisp-site-regen 112# elisp-site-regen
104# } 113# }
114#
105# pkg_postrm() { 115# pkg_postrm() {
106# elisp-site-regen 116# elisp-site-regen
107# } 117# }
108# 118#
109# As always: Feel free to contact Emacs team through emacs@gentoo.org if you 119# When having optional Emacs support, you should prepend "use emacs &&" to
110# have problems, suggestions or questions. 120# above calls of elisp-site-regen(). Don't use "has_version virtual/emacs"!
121# When unmerging the state of the emacs USE flag is taken from the package
122# database and not from the environment, so it is no problem when you unset
123# USE=emacs between merge and unmerge of a package.
124#
125# .SS
126# Miscellaneous functions:
127#
128# elisp-emacs-version() outputs the version of the currently active Emacs.
111 129
130# @ECLASS-VARIABLE: SITELISP
131# @DESCRIPTION:
132# Directory where packages install Emacs Lisp files.
112SITELISP=/usr/share/emacs/site-lisp 133SITELISP=/usr/share/emacs/site-lisp
113 134
135# Directory where packages install miscellaneous (not Lisp) files.
136SITEETC=/usr/share/emacs/etc
137
138# @ECLASS-VARIABLE: SITEFILE
139# @DESCRIPTION:
140# Name of package's site-init file.
141SITEFILE=50${PN}-gentoo.el
142
143EMACS=/usr/bin/emacs
144# The following works for Emacs versions 18--23, don't change it.
145EMACSFLAGS="-batch -q --no-site-file"
146
147# @FUNCTION: elisp-compile
148# @USAGE: <list of elisp files>
149# @DESCRIPTION:
150# Byte-compile Emacs Lisp files.
151
114elisp-compile() { 152elisp-compile() {
115 /usr/bin/emacs --batch -f batch-byte-compile --no-site-file --no-init-file $* 153 ebegin "Compiling GNU Emacs Elisp files"
154 ${EMACS} ${EMACSFLAGS} -f batch-byte-compile "$@"
155 eend $? "batch-byte-compile failed"
116} 156}
117 157
158# @FUNCTION: elisp-comp
159# @USAGE: <list of elisp files>
160# @DESCRIPTION:
161# Byte-compile interdependent Emacs Lisp files.
162#
163# This function byte-compiles all ".el" files which are part of its
164# arguments, using GNU Emacs, and puts the resulting ".elc" files into the
165# current directory, so disregarding the original directories used in ".el"
166# arguments.
167#
168# This function manages in such a way that all Emacs Lisp files to be
169# compiled are made visible between themselves, in the event they require or
170# load one another.
171
172elisp-comp() {
173 # Copyright 1995 Free Software Foundation, Inc.
174 # François Pinard <pinard@iro.umontreal.ca>, 1995.
175 # Originally taken from GNU autotools.
176
177 [ $# -gt 0 ] || return 1
178
179 ebegin "Compiling GNU Emacs Elisp files"
180
181 tempdir=elc.$$
182 mkdir ${tempdir}
183 cp "$@" ${tempdir}
184 pushd ${tempdir}
185
186 echo "(add-to-list 'load-path \"../\")" > script
187 ${EMACS} ${EMACSFLAGS} -l script -f batch-byte-compile *.el
188 local ret=$?
189 mv *.elc ..
190
191 popd
192 rm -fr ${tempdir}
193
194 eend ${ret} "batch-byte-compile failed"
195 return ${ret}
196}
197
198# @FUNCTION: elisp-emacs-version
199# @DESCRIPTION:
200# Output version of currently active Emacs.
201
202elisp-emacs-version() {
203 # The following will work for at least versions 18--23.
204 echo "(princ emacs-version)" >"${T}"/emacs-version.el
205 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
206}
207
208# @FUNCTION: elisp-make-autoload-file
209# @USAGE: [output file] [list of directories]
210# @DESCRIPTION:
211# Generate a file with autoload definitions for the lisp functions.
212
118elisp-make-autoload-file () { 213elisp-make-autoload-file() {
119 local f="${1:-${PN}-autoloads.el}" 214 local f="${1:-${PN}-autoloads.el}"
120 shift 215 shift
121 echo >"${f}" 216 ebegin "Generating autoload file for GNU Emacs"
122 emacs --batch -q --no-site-file \ 217
218 sed 's/^FF/\f/' >"${f}" <<-EOF
219 ;;; ${f##*/} --- autoloads for ${P}
220
221 ;;; Commentary:
222 ;; Automatically generated by elisp-common.eclass
223 ;; DO NOT EDIT THIS FILE
224
225 ;;; Code:
226 FF
227 ;; Local Variables:
228 ;; version-control: never
229 ;; no-byte-compile: t
230 ;; no-update-autoloads: t
231 ;; End:
232 ;;; ${f##*/} ends here
233 EOF
234
235 ${EMACS} ${EMACSFLAGS} \
123 --eval "(setq make-backup-files nil)" \ 236 --eval "(setq make-backup-files nil)" \
124 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \ 237 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
125 -f batch-update-autoloads "${@-.}" 238 -f batch-update-autoloads "${@-.}"
239
240 eend $? "batch-update-autoloads failed"
126} 241}
242
243# @FUNCTION: elisp-install
244# @USAGE: <subdirectory> <list of files>
245# @DESCRIPTION:
246# Install files in SITELISP directory.
127 247
128elisp-install() { 248elisp-install() {
129 local subdir=$1 249 local subdir="$1"
130 dodir "${SITELISP}/${subdir}"
131 insinto "${SITELISP}/${subdir}"
132 shift 250 shift
251 ebegin "Installing Elisp files for GNU Emacs support"
252 ( # subshell to avoid pollution of calling environment
253 insinto "${SITELISP}/${subdir}"
133 doins $@ 254 doins "$@"
255 )
256 eend $? "doins failed"
134} 257}
258
259# @FUNCTION: elisp-site-file-install
260# @USAGE: <site-init file> [subdirectory]
261# @DESCRIPTION:
262# Install Emacs site-init file in SITELISP directory.
135 263
136elisp-site-file-install() { 264elisp-site-file-install() {
137 local sitefile=$1 my_pn=${2:-${PN}} 265 local sf="${1##*/}" my_pn="${2:-${PN}}"
138 pushd "${S}" 266 ebegin "Installing site initialisation file for GNU Emacs"
139 cp ${sitefile} "${T}" 267 cp "$1" "${T}/${sf}"
140 sed -i "s:@SITELISP@:${SITELISP}/${my_pn}:g" "${T}/$(basename ${sitefile})" 268 sed -i -e "s:@SITELISP@:${SITELISP}/${my_pn}:g" \
141 insinto ${SITELISP} 269 -e "s:@SITEETC@:${SITEETC}/${my_pn}:g" "${T}/${sf}"
142 doins "${T}/$(basename ${sitefile})" || die "failed to install site file" 270 ( # subshell to avoid pollution of calling environment
143 popd 271 insinto "${SITELISP}/site-gentoo.d"
272 doins "${T}/${sf}"
273 )
274 eend $? "doins failed"
144} 275}
276
277# @FUNCTION: elisp-site-regen
278# @DESCRIPTION:
279# Regenerate site-gentoo.el file. The old location for site initialisation
280# files of packages was /usr/share/emacs/site-lisp/. In December 2007 this
281# has been changed to /usr/share/emacs/site-lisp/site-gentoo.d/. Remerge of
282# packages with Emacs support is enough, the old location is still supported
283# when generating the start-up file.
145 284
146elisp-site-regen() { 285elisp-site-regen() {
286 local i sf line obsolete
287 local -a sflist
288
289 if [ ! -e "${ROOT}${SITELISP}"/site-gentoo.el ] \
290 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then
291 einfo "Creating default ${SITELISP}/site-start.el ..."
292 cat <<-EOF >"${T}"/site-start.el
293 ;;; site-start.el
294
295 ;;; Commentary:
296 ;; This default site startup file is installed by elisp-common.eclass.
297 ;; You may replace this file by your own site initialisation, or even
298 ;; remove it completely; it will not be recreated.
299
300 ;;; Code:
301 ;; Load site initialisation for Gentoo-installed packages.
302 (require 'site-gentoo)
303
304 ;;; site-start.el ends here
305 EOF
306 fi
307
147 einfo "Regenerating ${SITELISP}/site-gentoo.el ..." 308 einfon "Regenerating ${SITELISP}/site-gentoo.el ..."
148 einfo "" 309
310 # remove auxiliary file
149 cat <<EOF >${ROOT}${SITELISP}/site-gentoo.el 311 rm -f "${ROOT}${SITELISP}"/00site-gentoo.el
150;;; DO NOT EDIT THIS FILE -- IT IS GENERATED AUTOMATICALLY BY PORTAGE
151;;; -----------------------------------------------------------------
152 312
153EOF 313 # set nullglob option, there may be a directory without matching files
314 local old_shopts=$(shopt -p nullglob)
315 shopt -s nullglob
316
154 for sf in ${ROOT}${SITELISP}/[0-9][0-9]*-gentoo.el 317 for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el \
318 "${ROOT}${SITELISP}"/site-gentoo.d/[0-9][0-9]*.el
155 do 319 do
156 [ -r "${sf}" ] || continue 320 [ -r "${sf}" ] || continue
157 einfo " Adding $(basename ${sf}) ..." 321 # sort files by their basename. straight insertion sort.
158 cat "${sf}" >>${ROOT}${SITELISP}/site-gentoo.el 322 for ((i=${#sflist[@]}; i>0; i--)); do
323 [[ ${sf##*/} < ${sflist[i-1]##*/} ]] || break
324 sflist[i]=${sflist[i-1]}
325 done
326 sflist[i]=${sf}
327 # set a flag if there are obsolete files
328 [ "${sf%/*}" = "${ROOT}${SITELISP}" ] && obsolete=t
159 done 329 done
330
331 eval "${old_shopts}"
332
333 cat <<-EOF >"${T}"/site-gentoo.el
334 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
335
336 ;;; Commentary:
337 ;; Automatically generated by elisp-common.eclass
338 ;; DO NOT EDIT THIS FILE
339
340 ;;; Code:
341 EOF
342 cat "${sflist[@]}" </dev/null >>"${T}"/site-gentoo.el
343 cat <<-EOF >>"${T}"/site-gentoo.el
344
345 (provide 'site-gentoo)
346
347 ;; Local Variables:
348 ;; no-byte-compile: t
349 ;; End:
350 ;;; site-gentoo.el ends here
351 EOF
352
353 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${T}"/site-gentoo.el; then
354 # This prevents outputting unnecessary text when there
355 # was actually no change.
356 # A case is a remerge where we have doubled output.
357 echo " no changes."
358 else
359 mv "${T}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
360 [ -f "${T}"/site-start.el ] \
361 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \
362 && mv "${T}"/site-start.el "${ROOT}${SITELISP}"/site-start.el
363 echo; einfo
364 for sf in "${sflist[@]##*/}"; do
365 einfo " Adding ${sf} ..."
366 done
367 einfo "Regenerated ${SITELISP}/site-gentoo.el."
368
369 echo
160 while read line; do einfo "${line}"; done <<EOF 370 while read line; do einfo "${line}"; done <<EOF
161
162All site initialization for Gentoo-installed packages is now added to 371All site initialisation for Gentoo-installed packages is added to
163/usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer 372/usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer
164managed by Gentoo. You are responsible for all maintenance of 373managed by Gentoo. You are responsible for all maintenance of
165site-start.el if there is such a file. 374site-start.el if there is such a file.
166 375
167In order for this site initialization to be loaded for all users 376In order for this site initialisation to be loaded for all users
168automatically, as was done previously, you can add a line like this: 377automatically, you can add a line like this:
169 378
170 (load "/usr/share/emacs/site-lisp/site-gentoo" nil t) 379 (require 'site-gentoo)
171 380
172to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line 381to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
173can be added by individual users to their initialization files, or for 382can be added by individual users to their initialisation files, or,
174greater flexibility, users can select which of the package-specific 383for greater flexibility, users can load individual package-specific
175initialization files in /usr/share/emacs/site-lisp to load. 384initialisation files from /usr/share/emacs/site-lisp/site-gentoo.d/.
176EOF 385EOF
177 echo 386 echo
178}
179 387
180# The following Emacs Lisp compilation routine is taken from GNU 388 if [ "${obsolete}" ]; then
181# autotools. 389 while read line; do ewarn "${line}"; done <<-EOF
182 390 Site-initialisation files of Emacs packages are now installed in
183elisp-comp() { 391 /usr/share/emacs/site-lisp/site-gentoo.d/. You may consider using
184# Copyright 1995 Free Software Foundation, Inc. 392 /usr/sbin/emacs-updater to rebuild the installed Emacs packages.
185# François Pinard <pinard@iro.umontreal.ca>, 1995. 393 However, the old location is still supported.
186# This script byte-compiles all `.el' files which are part of its 394 EOF
187# arguments, using GNU Emacs, and put the resulting `.elc' files into 395 echo
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
195 if test $# = 0; then
196 exit 1
197 else
198 if test -z "${EMACS}" || test "${EMACS}" = "t"; then
199 # Value of "t" means we are running in a shell under Emacs.
200 # Just assume Emacs is called "emacs".
201 EMACS=emacs
202 fi 396 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 397 fi
398
399 # Kludge for backwards compatibility: During pkg_postrm, old versions
400 # of this eclass (saved in the VDB) won't find packages' site-init files
401 # in the new location. So we copy them to an auxiliary file that is
402 # visible to old eclass versions.
403 for sf in "${sflist[@]}"; do
404 [ "${sf%/*}" = "${ROOT}${SITELISP}/site-gentoo.d" ] \
405 && cat "${sf}" >>"${ROOT}${SITELISP}"/00site-gentoo.el
406 done
216} 407}

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

  ViewVC Help
Powered by ViewVC 1.1.20