/[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.58 Revision 1.70
1# Copyright 1999-2009 Gentoo Foundation 1# Copyright 1999-2010 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.58 2009/03/26 14:14:22 ulm Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.70 2010/11/29 17:07:22 ulm Exp $
4# 4#
5# Copyright 2002-2004 Matthew Kennedy <mkennedy@gentoo.org> 5# Copyright 2002-2004 Matthew Kennedy <mkennedy@gentoo.org>
6# 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> 7# Copyright 2004-2005 Mamoru Komachi <usata@gentoo.org>
8# Copyright 2007-2008 Christian Faulhammer <fauli@gentoo.org> 8# Copyright 2007-2008 Christian Faulhammer <fauli@gentoo.org>
9# Copyright 2007-2009 Ulrich Müller <ulm@gentoo.org> 9# Copyright 2007-2010 Ulrich Müller <ulm@gentoo.org>
10# 10#
11# @ECLASS: elisp-common.eclass 11# @ECLASS: elisp-common.eclass
12# @MAINTAINER: 12# @MAINTAINER:
13# Feel free to contact the Emacs team through <emacs@gentoo.org> if you 13# Feel free to contact the Emacs team through <emacs@gentoo.org> if you
14# have problems, suggestions or questions. 14# have problems, suggestions or questions.
26# 26#
27# emacs? ( virtual/emacs ) 27# emacs? ( virtual/emacs )
28# 28#
29# to your DEPEND/RDEPEND line and use the functions provided here to 29# to your DEPEND/RDEPEND line and use the functions provided here to
30# bring the files to the correct locations. 30# bring the files to the correct locations.
31#
32# If your package requires a minimum Emacs version, e.g. Emacs 23, then
33# the dependency should be on >=virtual/emacs-23 instead. Because the
34# user can select the Emacs executable with eselect, you should also
35# make sure that the active Emacs version is sufficient. This can be
36# tested with function elisp-need-emacs(), which would typically be
37# called from pkg_setup(), as in the following example:
38#
39# elisp-need-emacs 23 || die "Emacs version too low"
40#
41# Please note that such tests should be limited to packages that are
42# known to fail with lower Emacs versions; the standard case is to
43# depend on virtual/emacs without version.
31# 44#
32# .SS 45# .SS
33# src_compile() usage: 46# src_compile() usage:
34# 47#
35# An elisp file is compiled by the elisp-compile() function defined 48# An elisp file is compiled by the elisp-compile() function defined
63# To let the Emacs support be activated by Emacs on startup, you need 76# 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 77# to provide a site file (shipped in ${FILESDIR}) which contains the
65# startup code (have a look in the documentation of your software). 78# startup code (have a look in the documentation of your software).
66# Normally this would look like this: 79# Normally this would look like this:
67# 80#
68# ;;; csv-mode site-lisp configuration
69#
70# (add-to-list 'load-path "@SITELISP@") 81# (add-to-list 'load-path "@SITELISP@")
71# (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode)) 82# (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode))
72# (autoload 'csv-mode "csv-mode" "Major mode for csv files." t) 83# (autoload 'csv-mode "csv-mode" "Major mode for csv files." t)
73# 84#
74# If your Emacs support files are installed in a subdirectory of 85# If your Emacs support files are installed in a subdirectory of
84# many Emacs support files, users may be annoyed by the start-up time. 95# many Emacs support files, users may be annoyed by the start-up time.
85# Also avoid keybindings as they might interfere with the user's 96# Also avoid keybindings as they might interfere with the user's
86# settings. Give a hint in pkg_postinst(), which should be enough. 97# settings. Give a hint in pkg_postinst(), which should be enough.
87# 98#
88# The naming scheme for this site-init file matches the shell pattern 99# 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 100# "[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 101# the loading order (numbers below 10 or above 89 are reserved for
91# internal use). So if your initialisation depends on another Emacs 102# internal use). So if your initialisation depends on another Emacs
92# package, your site file's number must be higher! 103# package, your site file's number must be higher! If there are no such
104# interdependencies then the number should be 50. Otherwise, numbers
105# divisible by 10 are preferred.
93# 106#
94# Best practice is to define a SITEFILE variable in the global scope of 107# Best practice is to define a SITEFILE variable in the global scope of
95# your ebuild (e.g., right after S or RDEPEND): 108# your ebuild (e.g., right after S or RDEPEND):
96# 109#
97# SITEFILE="50${PN}-gentoo.el" 110# SITEFILE="50${PN}-gentoo.el"
98# 111#
99# Which is then installed by 112# Which is then installed by
100# 113#
101# elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die 114# elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
102# 115#
116# in src_install(). Any characters after the "-gentoo" part and before
117# the extension will be stripped from the destination file's name.
118# For example, a file "50${PN}-gentoo-${PV}.el" will be installed as
103# in src_install(). If your subdirectory is not named ${PN}, give the 119# "50${PN}-gentoo.el". If your subdirectory is not named ${PN}, give
104# differing name as second argument. 120# the differing name as second argument.
105# 121#
106# .SS 122# .SS
107# pkg_postinst() / pkg_postrm() usage: 123# pkg_postinst() / pkg_postrm() usage:
108# 124#
109# After that you need to recreate the start-up file of Emacs after 125# After that you need to recreate the start-up file of Emacs after
121# to above calls of elisp-site-regen(). 137# to above calls of elisp-site-regen().
122# Don't use "has_version virtual/emacs"! When unmerging the state of 138# 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 139# 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 140# environment, so it is no problem when you unset USE=emacs between
125# merge and unmerge of a package. 141# 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.
131 142
132# @ECLASS-VARIABLE: SITELISP 143# @ECLASS-VARIABLE: SITELISP
133# @DESCRIPTION: 144# @DESCRIPTION:
134# Directory where packages install Emacs Lisp files. 145# Directory where packages install Emacs Lisp files.
135SITELISP=/usr/share/emacs/site-lisp 146SITELISP=/usr/share/emacs/site-lisp
140SITEETC=/usr/share/emacs/etc 151SITEETC=/usr/share/emacs/etc
141 152
142# @ECLASS-VARIABLE: EMACS 153# @ECLASS-VARIABLE: EMACS
143# @DESCRIPTION: 154# @DESCRIPTION:
144# Path of Emacs executable. 155# Path of Emacs executable.
145EMACS=/usr/bin/emacs 156EMACS=${EPREFIX}/usr/bin/emacs
146 157
147# @ECLASS-VARIABLE: EMACSFLAGS 158# @ECLASS-VARIABLE: EMACSFLAGS
148# @DESCRIPTION: 159# @DESCRIPTION:
149# Flags for executing Emacs in batch mode. 160# Flags for executing Emacs in batch mode.
150# These work for Emacs versions 18-23, so don't change them. 161# These work for Emacs versions 18-23, so don't change them.
152 163
153# @ECLASS-VARIABLE: BYTECOMPFLAGS 164# @ECLASS-VARIABLE: BYTECOMPFLAGS
154# @DESCRIPTION: 165# @DESCRIPTION:
155# Emacs flags used for byte-compilation in elisp-compile(). 166# Emacs flags used for byte-compilation in elisp-compile().
156BYTECOMPFLAGS="-L ." 167BYTECOMPFLAGS="-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
171elisp-compile() {
172 ebegin "Compiling GNU Emacs Elisp files"
173 ${EMACS} ${EMACSFLAGS} ${BYTECOMPFLAGS} -f batch-byte-compile "$@"
174 eend $? "elisp-compile: batch-byte-compile failed"
175}
176
177elisp-comp() {
178 die "Function elisp-comp is not supported any more, see bug 235442"
179}
180 168
181# @FUNCTION: elisp-emacs-version 169# @FUNCTION: elisp-emacs-version
182# @DESCRIPTION: 170# @DESCRIPTION:
183# Output version of currently active Emacs. 171# Output version of currently active Emacs.
184 172
187 echo "(princ emacs-version)" >"${T}"/emacs-version.el 175 echo "(princ emacs-version)" >"${T}"/emacs-version.el
188 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el 176 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
189 rm -f "${T}"/emacs-version.el 177 rm -f "${T}"/emacs-version.el
190} 178}
191 179
180# @FUNCTION: elisp-need-emacs
181# @USAGE: <version>
182# @RETURN: 0 if true, 1 otherwise
183# @DESCRIPTION:
184# Test if the eselected Emacs version is at least the major version
185# specified as argument.
186
187elisp-need-emacs() {
188 local need_emacs=$1
189 local have_emacs=$(elisp-emacs-version)
190 einfo "Emacs version: ${have_emacs}"
191 if ! [[ ${have_emacs%%.*} -ge ${need_emacs%%.*} ]]; then
192 eerror "This package needs at least Emacs ${need_emacs%%.*}."
193 eerror "Use \"eselect emacs\" to select the active version."
194 return 1
195 fi
196 return 0
197}
198
199# @FUNCTION: elisp-compile
200# @USAGE: <list of elisp files>
201# @DESCRIPTION:
202# Byte-compile Emacs Lisp files.
203#
204# This function uses GNU Emacs to byte-compile all ".el" specified by
205# its arguments. The resulting byte-code (".elc") files are placed in
206# the same directory as their corresponding source file.
207#
208# The current directory is added to the load-path. This will ensure
209# that interdependent Emacs Lisp files are visible between themselves,
210# in case they require or load one another.
211
212elisp-compile() {
213 ebegin "Compiling GNU Emacs Elisp files"
214 ${EMACS} ${EMACSFLAGS} ${BYTECOMPFLAGS} -f batch-byte-compile "$@"
215 eend $? "elisp-compile: batch-byte-compile failed"
216}
217
192# @FUNCTION: elisp-make-autoload-file 218# @FUNCTION: elisp-make-autoload-file
193# @USAGE: [output file] [list of directories] 219# @USAGE: [output file] [list of directories]
194# @DESCRIPTION: 220# @DESCRIPTION:
195# Generate a file with autoload definitions for the lisp functions. 221# Generate a file with autoload definitions for the lisp functions.
196 222
197elisp-make-autoload-file() { 223elisp-make-autoload-file() {
198 local f="${1:-${PN}-autoloads.el}" 224 local f="${1:-${PN}-autoloads.el}" null="" page=$'\f'
199 shift 225 shift
200 ebegin "Generating autoload file for GNU Emacs" 226 ebegin "Generating autoload file for GNU Emacs"
201 227
202 sed 's/^FF/\f/' >"${f}" <<-EOF 228 cat >"${f}" <<-EOF
203 ;;; ${f##*/} --- autoloads for ${P} 229 ;;; ${f##*/} --- autoloads for ${PN}
204 230
205 ;;; Commentary: 231 ;;; Commentary:
206 ;; Automatically generated by elisp-common.eclass 232 ;; Automatically generated by elisp-common.eclass
207 ;; DO NOT EDIT THIS FILE 233 ;; DO NOT EDIT THIS FILE
208 234
209 ;;; Code: 235 ;;; Code:
210 FF 236 ${page}
211 ;; Local Variables: 237 ;; Local ${null}Variables:
212 ;; version-control: never 238 ;; version-control: never
213 ;; no-byte-compile: t 239 ;; no-byte-compile: t
214 ;; no-update-autoloads: t 240 ;; no-update-autoloads: t
215 ;; End: 241 ;; End:
242
216 ;;; ${f##*/} ends here 243 ;;; ${f##*/} ends here
217 EOF 244 EOF
218 245
219 ${EMACS} ${EMACSFLAGS} \ 246 ${EMACS} ${EMACSFLAGS} \
220 --eval "(setq make-backup-files nil)" \ 247 --eval "(setq make-backup-files nil)" \
241} 268}
242 269
243# @FUNCTION: elisp-site-file-install 270# @FUNCTION: elisp-site-file-install
244# @USAGE: <site-init file> [subdirectory] 271# @USAGE: <site-init file> [subdirectory]
245# @DESCRIPTION: 272# @DESCRIPTION:
246# Install Emacs site-init file in SITELISP directory. 273# Install Emacs site-init file in SITELISP directory. Automatically
274# inserts a standard comment header with the name of the package (unless
275# it is already present). Tokens @SITELISP@ and @SITEETC@ are replaced
276# by the path to the package's subdirectory in SITELISP and SITEETC,
277# respectively.
247 278
248elisp-site-file-install() { 279elisp-site-file-install() {
249 local sf="${T}/${1##*/}" my_pn="${2:-${PN}}" ret 280 local sf="${1##*/}" my_pn="${2:-${PN}}" ret
281 local header=";;; ${PN} site-lisp configuration"
282
283 [[ ${sf} == [0-9][0-9]*-gentoo*.el ]] \
284 || ewarn "elisp-site-file-install: bad name of site-init file"
285 sf="${T}/${sf/%-gentoo*.el/-gentoo.el}"
250 ebegin "Installing site initialisation file for GNU Emacs" 286 ebegin "Installing site initialisation file for GNU Emacs"
251 cp "$1" "${sf}" 287 [[ $1 = ${sf} ]] || cp "$1" "${sf}"
288 sed -i -e "1{:x;/^\$/{n;bx;};/^;.*${PN}/I!s:^:${header}\n\n:;1s:^:\n:;}" \
252 sed -i -e "s:@SITELISP@:${SITELISP}/${my_pn}:g" \ 289 -e "s:@SITELISP@:${EPREFIX}${SITELISP}/${my_pn}:g" \
253 -e "s:@SITEETC@:${SITEETC}/${my_pn}:g;\$q" "${sf}" 290 -e "s:@SITEETC@:${EPREFIX}${SITEETC}/${my_pn}:g;\$q" "${sf}"
254 ( # subshell to avoid pollution of calling environment 291 ( # subshell to avoid pollution of calling environment
255 insinto "${SITELISP}/site-gentoo.d" 292 insinto "${SITELISP}/site-gentoo.d"
256 doins "${sf}" 293 doins "${sf}"
257 ) 294 )
258 ret=$? 295 ret=$?
269# Note: Before December 2007, site initialisation files were installed 306# Note: Before December 2007, site initialisation files were installed
270# in /usr/share/emacs/site-lisp/. For backwards compatibility, this 307# in /usr/share/emacs/site-lisp/. For backwards compatibility, this
271# location is still supported when generating site-gentoo.el. 308# location is still supported when generating site-gentoo.el.
272 309
273elisp-site-regen() { 310elisp-site-regen() {
274 local i sf line firstrun obsolete 311 local sitelisp=${ROOT}${EPREFIX}${SITELISP}
312 local sf i line null="" page=$'\f'
275 local -a sflist 313 local -a sflist
276 314
277 if [ ! -d "${ROOT}${SITELISP}" ]; then 315 if [ ! -d "${sitelisp}" ]; then
278 eerror "elisp-site-regen: Directory ${SITELISP} does not exist" 316 eerror "elisp-site-regen: Directory ${sitelisp} does not exist"
279 return 1 317 return 1
280 fi 318 fi
281 319
282 if [ ! -d "${T}" ]; then 320 if [ ! -d "${T}" ]; then
283 eerror "elisp-site-regen: Temporary directory ${T} does not exist" 321 eerror "elisp-site-regen: Temporary directory ${T} does not exist"
284 return 1 322 return 1
285 fi 323 fi
286 324
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}) ..." 325 einfon "Regenerating site-gentoo.el for GNU Emacs (${EBUILD_PHASE}) ..."
309 326
310 # Until January 2009, elisp-common.eclass sometimes created an 327 # Until January 2009, elisp-common.eclass sometimes created an
311 # auxiliary file for backwards compatibility. Remove any such file. 328 # auxiliary file for backwards compatibility. Remove any such file.
312 rm -f "${ROOT}${SITELISP}"/00site-gentoo.el 329 rm -f "${sitelisp}"/00site-gentoo.el
313 330
314 # set nullglob option, there may be a directory without matching files
315 local old_shopts=$(shopt -p nullglob)
316 shopt -s nullglob
317
318 for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el \ 331 for sf in "${sitelisp}"/[0-9][0-9]*-gentoo.el \
319 "${ROOT}${SITELISP}"/site-gentoo.d/[0-9][0-9]*.el 332 "${sitelisp}"/site-gentoo.d/[0-9][0-9]*.el
320 do 333 do
321 [ -r "${sf}" ] || continue 334 [ -r "${sf}" ] || continue
322 # sort files by their basename. straight insertion sort. 335 # sort files by their basename. straight insertion sort.
323 for ((i=${#sflist[@]}; i>0; i--)); do 336 for ((i=${#sflist[@]}; i>0; i--)); do
324 [[ ${sf##*/} < ${sflist[i-1]##*/} ]] || break 337 [[ ${sf##*/} < ${sflist[i-1]##*/} ]] || break
325 sflist[i]=${sflist[i-1]} 338 sflist[i]=${sflist[i-1]}
326 done 339 done
327 sflist[i]=${sf} 340 sflist[i]=${sf}
328 # set a flag if there are obsolete files
329 [ "${sf%/*}" = "${ROOT}${SITELISP}" ] && obsolete=t
330 done 341 done
331
332 eval "${old_shopts}"
333 342
334 cat <<-EOF >"${T}"/site-gentoo.el 343 cat <<-EOF >"${T}"/site-gentoo.el
335 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages 344 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
336 345
337 ;;; Commentary: 346 ;;; Commentary:
342 EOF 351 EOF
343 # Use sed instead of cat here, since files may miss a trailing newline. 352 # Use sed instead of cat here, since files may miss a trailing newline.
344 sed '$q' "${sflist[@]}" </dev/null >>"${T}"/site-gentoo.el 353 sed '$q' "${sflist[@]}" </dev/null >>"${T}"/site-gentoo.el
345 cat <<-EOF >>"${T}"/site-gentoo.el 354 cat <<-EOF >>"${T}"/site-gentoo.el
346 355
356 ${page}
347 (provide 'site-gentoo) 357 (provide 'site-gentoo)
348 358
349 ;; Local Variables: 359 ;; Local ${null}Variables:
350 ;; no-byte-compile: t 360 ;; no-byte-compile: t
361 ;; buffer-read-only: t
351 ;; End: 362 ;; End:
363
352 ;;; site-gentoo.el ends here 364 ;;; site-gentoo.el ends here
353 EOF 365 EOF
354 366
355 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${T}"/site-gentoo.el 367 if cmp -s "${sitelisp}"/site-gentoo.el "${T}"/site-gentoo.el; then
356 then
357 # This prevents outputting unnecessary text when there 368 # This prevents outputting unnecessary text when there
358 # was actually no change. 369 # was actually no change.
359 # A case is a remerge where we have doubled output. 370 # A case is a remerge where we have doubled output.
371 rm -f "${T}"/site-gentoo.el
360 echo " no changes." 372 echo " no changes."
361 else 373 else
362 mv "${T}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el 374 mv "${T}"/site-gentoo.el "${sitelisp}"/site-gentoo.el
363 [ -f "${T}"/site-start.el ] \
364 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \
365 && mv "${T}"/site-start.el "${ROOT}${SITELISP}"/site-start.el
366 echo 375 echo
376 case ${#sflist[@]} in
377 0) ewarn "... Huh? No site initialisation files found." ;;
378 1) einfo "... ${#sflist[@]} site initialisation file included." ;;
367 einfo "... ${#sflist[@]} site initialisation file(s) included." 379 *) einfo "... ${#sflist[@]} site initialisation files included." ;;
380 esac
368 fi 381 fi
369 382
370 if [ "${firstrun}" ]; then
371 echo
372 while read line; do einfo "${line:- }"; done <<-EOF
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.
377
378 In order for this site initialisation to be loaded for all users
379 automatically, you can add a line like this:
380
381 (require 'site-gentoo)
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
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 383 return 0
405} 384}

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

  ViewVC Help
Powered by ViewVC 1.1.20