/[gentoo-x86]/eclass/elisp-common.eclass
Gentoo

Contents of /eclass/elisp-common.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.84 - (show annotations) (download)
Sat Mar 16 08:55:30 2013 UTC (16 months ago) by ulm
Branch: MAIN
Changes since 1.83: +9 -8 lines
Sync eclasses from Emacs overlay.
elisp-common.eclass: Functions elisp-compile, elisp-make-autoload-file,
elisp-install, and elisp-site-file-install now die on failure.
elisp.eclass: Remove die commands that are no longer necessary because the
called functions die themselves. Call readme.gentoo_create_doc and
readme.gentoo_print_elog from readme.gentoo.eclass if these functions exist.

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

  ViewVC Help
Powered by ViewVC 1.1.20