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

  ViewVC Help
Powered by ViewVC 1.1.20