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

Contents of /eclass/elisp-common.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.50 - (show annotations) (download)
Thu Oct 16 09:28:58 2008 UTC (5 years, 9 months ago) by ulm
Branch: MAIN
Changes since 1.49: +11 -8 lines
Partial sync from Emacs overlay (revision 1176).

elisp.class:
Allow for packages without site-init file in elisp_src_install.
Remove "die" messages since elisp-common.eclass is verbose enough.
Document SITEFILE variable.

elisp-common.eclass:
Use sed instead of cat for concatenation of site-init files, since they
may not have a trailing newline.
Add function names to error messages.
Document SITEETC as eclass variable.

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

  ViewVC Help
Powered by ViewVC 1.1.20