/[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.58
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.58 2009/03/26 14:14:22 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 <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 68# ;;; csv-mode site-lisp configuration
64# 69#
65# (add-to-list 'load-path "@SITELISP@") 70# (add-to-list 'load-path "@SITELISP@")
66# (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode)) 71# (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode))
67# (autoload 'csv-mode "csv-mode" "Major mode for editing csv files." t) 72# (autoload 'csv-mode "csv-mode" "Major mode for csv files." t)
68# 73#
69# If your Emacs support files are installed in a subdirectory of 74# 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 75# /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 76# 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 77# The elisp-site-file-install() function of this eclass will replace
73# replace "@SITELISP@" by the actual path. 78# "@SITELISP@" and "@SITEETC@" by the actual paths.
79#
74# The next line tells Emacs to load the mode opening a file ending with 80# 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. 81# with ".csv" and load functions depending on the context and needed
76# Be careful though. Commands as "load-library" or "require" bloat the 82# 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 83# 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 84# 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 85# Also avoid keybindings as they might interfere with the user's
80# in pkg_postinst(), which should be enough. 86# 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 87#
82# two digits at the beginning define the loading order. So if you depend on 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
83# another Emacs package, your site file's number must be higher! 92# package, your site file's number must be higher!
93#
84# Best practice is to define a SITEFILE variable in the global scope of your 94# Best practice is to define a SITEFILE variable in the global scope of
85# ebuild (right after DEPEND e.g.): 95# your ebuild (e.g., right after S or RDEPEND):
86# 96#
87# SITEFILE=50${PN}-gentoo.el 97# SITEFILE="50${PN}-gentoo.el"
88# 98#
89# Which is then installed by 99# Which is then installed by
90# 100#
91# elisp-site-file-install "${FILESDIR}/${SITEFILE}" 101# elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
92# 102#
93# in src_install(). If your subdirectory is not named ${PN}, give the 103# in src_install(). If your subdirectory is not named ${PN}, give the
94# differing name as second argument. 104# differing name as second argument.
95# 105#
106# .SS
96# pkg_postinst() / pkg_postrm() usage: 107# pkg_postinst() / pkg_postrm() usage:
97# ------------------------------------
98# 108#
99# After that you need to recreate the start-up file of Emacs after emerging 109# After that you need to recreate the start-up file of Emacs after
100# and unmerging by using 110# emerging and unmerging by using
101# 111#
102# pkg_postinst() { 112# pkg_postinst() {
103# elisp-site-regen 113# elisp-site-regen
104# } 114# }
115#
105# pkg_postrm() { 116# pkg_postrm() {
106# elisp-site-regen 117# elisp-site-regen
107# } 118# }
108# 119#
109# As always: Feel free to contact Emacs team through emacs@gentoo.org if you 120# When having optional Emacs support, you should prepend "use emacs &&"
110# have problems, suggestions or questions. 121# to above calls of elisp-site-regen().
122# Don't use "has_version virtual/emacs"! When unmerging the state of
123# the emacs USE flag is taken from the package database and not from the
124# environment, so it is no problem when you unset USE=emacs between
125# merge and unmerge of a package.
126#
127# .SS
128# Miscellaneous functions:
129#
130# elisp-emacs-version() outputs the version of the currently active Emacs.
111 131
132# @ECLASS-VARIABLE: SITELISP
133# @DESCRIPTION:
134# Directory where packages install Emacs Lisp files.
112SITELISP=/usr/share/emacs/site-lisp 135SITELISP=/usr/share/emacs/site-lisp
113 136
137# @ECLASS-VARIABLE: SITEETC
138# @DESCRIPTION:
139# Directory where packages install miscellaneous (not Lisp) files.
140SITEETC=/usr/share/emacs/etc
141
142# @ECLASS-VARIABLE: EMACS
143# @DESCRIPTION:
144# Path of Emacs executable.
145EMACS=/usr/bin/emacs
146
147# @ECLASS-VARIABLE: EMACSFLAGS
148# @DESCRIPTION:
149# Flags for executing Emacs in batch mode.
150# These work for Emacs versions 18-23, so don't change them.
151EMACSFLAGS="-batch -q --no-site-file"
152
153# @ECLASS-VARIABLE: BYTECOMPFLAGS
154# @DESCRIPTION:
155# Emacs flags used for byte-compilation in elisp-compile().
156BYTECOMPFLAGS="-L ."
157
158# @FUNCTION: elisp-compile
159# @USAGE: <list of elisp files>
160# @DESCRIPTION:
161# Byte-compile Emacs Lisp files.
162#
163# This function uses GNU Emacs to byte-compile all ".el" specified by
164# its arguments. The resulting byte-code (".elc") files are placed in
165# the same directory as their corresponding source file.
166#
167# The current directory is added to the load-path. This will ensure
168# that interdependent Emacs Lisp files are visible between themselves,
169# in case they require or load one another.
170
114elisp-compile() { 171elisp-compile() {
115 /usr/bin/emacs --batch -f batch-byte-compile --no-site-file --no-init-file $* 172 ebegin "Compiling GNU Emacs Elisp files"
173 ${EMACS} ${EMACSFLAGS} ${BYTECOMPFLAGS} -f batch-byte-compile "$@"
174 eend $? "elisp-compile: batch-byte-compile failed"
116} 175}
117 176
177elisp-comp() {
178 die "Function elisp-comp is not supported any more, see bug 235442"
179}
180
181# @FUNCTION: elisp-emacs-version
182# @DESCRIPTION:
183# Output version of currently active Emacs.
184
185elisp-emacs-version() {
186 # The following will work for at least versions 18-23.
187 echo "(princ emacs-version)" >"${T}"/emacs-version.el
188 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
189 rm -f "${T}"/emacs-version.el
190}
191
192# @FUNCTION: elisp-make-autoload-file
193# @USAGE: [output file] [list of directories]
194# @DESCRIPTION:
195# Generate a file with autoload definitions for the lisp functions.
196
118elisp-make-autoload-file () { 197elisp-make-autoload-file() {
119 local f="${1:-${PN}-autoloads.el}" 198 local f="${1:-${PN}-autoloads.el}"
120 shift 199 shift
121 echo >"${f}" 200 ebegin "Generating autoload file for GNU Emacs"
122 emacs --batch -q --no-site-file \ 201
202 sed 's/^FF/\f/' >"${f}" <<-EOF
203 ;;; ${f##*/} --- autoloads for ${P}
204
205 ;;; Commentary:
206 ;; Automatically generated by elisp-common.eclass
207 ;; DO NOT EDIT THIS FILE
208
209 ;;; Code:
210 FF
211 ;; Local Variables:
212 ;; version-control: never
213 ;; no-byte-compile: t
214 ;; no-update-autoloads: t
215 ;; End:
216 ;;; ${f##*/} ends here
217 EOF
218
219 ${EMACS} ${EMACSFLAGS} \
123 --eval "(setq make-backup-files nil)" \ 220 --eval "(setq make-backup-files nil)" \
124 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \ 221 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
125 -f batch-update-autoloads "${@-.}" 222 -f batch-update-autoloads "${@-.}"
223
224 eend $? "elisp-make-autoload-file: batch-update-autoloads failed"
126} 225}
226
227# @FUNCTION: elisp-install
228# @USAGE: <subdirectory> <list of files>
229# @DESCRIPTION:
230# Install files in SITELISP directory.
127 231
128elisp-install() { 232elisp-install() {
129 local subdir=$1 233 local subdir="$1"
130 dodir "${SITELISP}/${subdir}"
131 insinto "${SITELISP}/${subdir}"
132 shift 234 shift
235 ebegin "Installing Elisp files for GNU Emacs support"
236 ( # subshell to avoid pollution of calling environment
237 insinto "${SITELISP}/${subdir}"
133 doins $@ 238 doins "$@"
239 )
240 eend $? "elisp-install: doins failed"
134} 241}
242
243# @FUNCTION: elisp-site-file-install
244# @USAGE: <site-init file> [subdirectory]
245# @DESCRIPTION:
246# Install Emacs site-init file in SITELISP directory.
135 247
136elisp-site-file-install() { 248elisp-site-file-install() {
137 local sitefile=$1 my_pn=${2:-${PN}} 249 local sf="${T}/${1##*/}" my_pn="${2:-${PN}}" ret
138 pushd "${S}" 250 ebegin "Installing site initialisation file for GNU Emacs"
139 cp ${sitefile} "${T}" 251 cp "$1" "${sf}"
140 sed -i "s:@SITELISP@:${SITELISP}/${my_pn}:g" "${T}/$(basename ${sitefile})" 252 sed -i -e "s:@SITELISP@:${SITELISP}/${my_pn}:g" \
141 insinto ${SITELISP} 253 -e "s:@SITEETC@:${SITEETC}/${my_pn}:g;\$q" "${sf}"
142 doins "${T}/$(basename ${sitefile})" || die "failed to install site file" 254 ( # subshell to avoid pollution of calling environment
143 popd 255 insinto "${SITELISP}/site-gentoo.d"
256 doins "${sf}"
257 )
258 ret=$?
259 rm -f "${sf}"
260 eend ${ret} "elisp-site-file-install: doins failed"
144} 261}
262
263# @FUNCTION: elisp-site-regen
264# @DESCRIPTION:
265# Regenerate the site-gentoo.el file, based on packages' site
266# initialisation files in the /usr/share/emacs/site-lisp/site-gentoo.d/
267# directory.
268#
269# Note: Before December 2007, site initialisation files were installed
270# in /usr/share/emacs/site-lisp/. For backwards compatibility, this
271# location is still supported when generating site-gentoo.el.
145 272
146elisp-site-regen() { 273elisp-site-regen() {
147 einfo "Regenerating ${SITELISP}/site-gentoo.el ..." 274 local i sf line firstrun obsolete
148 einfo "" 275 local -a sflist
276
277 if [ ! -d "${ROOT}${SITELISP}" ]; then
278 eerror "elisp-site-regen: Directory ${SITELISP} does not exist"
279 return 1
280 fi
281
282 if [ ! -d "${T}" ]; then
283 eerror "elisp-site-regen: Temporary directory ${T} does not exist"
284 return 1
285 fi
286
287 [ -e "${ROOT}${SITELISP}"/site-gentoo.el ] \
288 || [ "${PN}" = emacs-common-gentoo ] || firstrun=t
289
290 if [ "${firstrun}" ] && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then
291 einfo "Creating default 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
308 einfon "Regenerating site-gentoo.el (${EBUILD_PHASE}) ..."
309
310 # Until January 2009, elisp-common.eclass sometimes created an
311 # auxiliary file for backwards compatibility. Remove any such file.
149 cat <<EOF >${ROOT}${SITELISP}/site-gentoo.el 312 rm -f "${ROOT}${SITELISP}"/00site-gentoo.el
150;;; DO NOT EDIT THIS FILE -- IT IS GENERATED AUTOMATICALLY BY PORTAGE
151;;; -----------------------------------------------------------------
152 313
153EOF 314 # set nullglob option, there may be a directory without matching files
315 local old_shopts=$(shopt -p nullglob)
316 shopt -s nullglob
317
154 for sf in ${ROOT}${SITELISP}/[0-9][0-9]*-gentoo.el 318 for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el \
319 "${ROOT}${SITELISP}"/site-gentoo.d/[0-9][0-9]*.el
155 do 320 do
156 [ -r "${sf}" ] || continue 321 [ -r "${sf}" ] || continue
157 einfo " Adding $(basename ${sf}) ..." 322 # sort files by their basename. straight insertion sort.
158 cat "${sf}" >>${ROOT}${SITELISP}/site-gentoo.el 323 for ((i=${#sflist[@]}; i>0; i--)); do
324 [[ ${sf##*/} < ${sflist[i-1]##*/} ]] || break
325 sflist[i]=${sflist[i-1]}
326 done
327 sflist[i]=${sf}
328 # set a flag if there are obsolete files
329 [ "${sf%/*}" = "${ROOT}${SITELISP}" ] && obsolete=t
159 done 330 done
160 while read line; do einfo "${line}"; done <<EOF
161 331
162All site initialization for Gentoo-installed packages is now added to 332 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 333
167In order for this site initialization to be loaded for all users 334 cat <<-EOF >"${T}"/site-gentoo.el
168automatically, as was done previously, you can add a line like this: 335 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
169 336
170 (load "/usr/share/emacs/site-lisp/site-gentoo" nil t) 337 ;;; Commentary:
338 ;; Automatically generated by elisp-common.eclass
339 ;; DO NOT EDIT THIS FILE
171 340
172to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line 341 ;;; 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 342 EOF
177 echo 343 # Use sed instead of cat here, since files may miss a trailing newline.
178} 344 sed '$q' "${sflist[@]}" </dev/null >>"${T}"/site-gentoo.el
345 cat <<-EOF >>"${T}"/site-gentoo.el
179 346
180# The following Emacs Lisp compilation routine is taken from GNU 347 (provide 'site-gentoo)
181# autotools.
182 348
183elisp-comp() { 349 ;; Local Variables:
184# Copyright 1995 Free Software Foundation, Inc. 350 ;; no-byte-compile: t
185# Fran├žois Pinard <pinard@iro.umontreal.ca>, 1995. 351 ;; End:
186# This script byte-compiles all `.el' files which are part of its 352 ;;; site-gentoo.el ends here
187# arguments, using GNU Emacs, and put the resulting `.elc' files into 353 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 354
195 if test $# = 0; then 355 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${T}"/site-gentoo.el
196 exit 1 356 then
357 # This prevents outputting unnecessary text when there
358 # was actually no change.
359 # A case is a remerge where we have doubled output.
360 echo " no changes."
197 else 361 else
198 if test -z "${EMACS}" || test "${EMACS}" = "t"; then 362 mv "${T}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
199 # Value of "t" means we are running in a shell under Emacs. 363 [ -f "${T}"/site-start.el ] \
200 # Just assume Emacs is called "emacs". 364 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \
201 EMACS=emacs 365 && mv "${T}"/site-start.el "${ROOT}${SITELISP}"/site-start.el
366 echo
367 einfo "... ${#sflist[@]} site initialisation file(s) included."
202 fi 368 fi
203 369
204 tempdir=elc.$$ 370 if [ "${firstrun}" ]; then
205 mkdir ${tempdir} 371 echo
206 cp $* ${tempdir} 372 while read line; do einfo "${line:- }"; done <<-EOF
207 cd ${tempdir} 373 All site initialisation for Gentoo-installed packages is added to
374 /usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is not
375 managed by Gentoo. You are responsible for all maintenance of
376 site-start.el if there is such a file.
208 377
209 echo "(add-to-list 'load-path \"../\")" > script 378 In order for this site initialisation to be loaded for all users
210 ${EMACS} -batch -q --no-site-file --no-init-file -l script -f batch-byte-compile *.el 379 automatically, you can add a line like this:
211 mv *.elc ..
212 380
213 cd .. 381 (require 'site-gentoo)
214 rm -fr ${tempdir} 382
383 to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
384 can be added by individual users to their initialisation files, or,
385 for greater flexibility, users can load individual package-specific
386 initialisation files from /usr/share/emacs/site-lisp/site-gentoo.d/.
387 EOF
388 echo
215 fi 389 fi
390
391 if [ "${obsolete}" ]; then
392 echo
393 while read line; do ewarn "${line}"; done <<-EOF
394 Site-initialisation files of Emacs packages are now installed in
395 /usr/share/emacs/site-lisp/site-gentoo.d/. We strongly recommend
396 that you use app-admin/emacs-updater to rebuild the installed
397 Emacs packages.
398 EOF
399 fi
400
401 # cleanup
402 rm -f "${T}"/site-{gentoo,start}.el
403
404 return 0
216} 405}

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

  ViewVC Help
Powered by ViewVC 1.1.20