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

Contents of /eclass/elisp-common.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.49 - (show annotations) (download)
Sun Oct 12 19:48:21 2008 UTC (5 years, 11 months ago) by ulm
Branch: MAIN
Changes since 1.48: +7 -8 lines
Add function names to error messages.

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.48 2008/10/05 13:56:08 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 "elisp-compile failed"
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 "elisp-install failed"
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 file is "[0-9][0-9]*-gentoo.el", where the
90 # two digits at the beginning define the loading order. So if you depend on
91 # another Emacs package, your site file's number must be higher!
92 #
93 # Best practice is to define a SITEFILE variable in the global scope of your
94 # ebuild (right after DEPEND e.g.):
95 #
96 # SITEFILE=50${PN}-gentoo.el
97 #
98 # Which is then installed by
99 #
100 # elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
101 #
102 # in src_install(). If your subdirectory is not named ${PN}, give the
103 # differing name as second argument.
104 #
105 # .SS
106 # pkg_postinst() / pkg_postrm() usage:
107 #
108 # After that you need to recreate the start-up file of Emacs after emerging
109 # and unmerging by using
110 #
111 # pkg_postinst() {
112 # elisp-site-regen
113 # }
114 #
115 # pkg_postrm() {
116 # elisp-site-regen
117 # }
118 #
119 # When having optional Emacs support, you should prepend "use emacs &&" to
120 # above calls of elisp-site-regen(). Don't use "has_version virtual/emacs"!
121 # When unmerging the state of the emacs USE flag is taken from the package
122 # database and not from the environment, so it is no problem when you unset
123 # USE=emacs between merge and unmerge of a package.
124 #
125 # .SS
126 # Miscellaneous functions:
127 #
128 # elisp-emacs-version() outputs the version of the currently active Emacs.
129
130 # @ECLASS-VARIABLE: SITELISP
131 # @DESCRIPTION:
132 # Directory where packages install Emacs Lisp files.
133 SITELISP=/usr/share/emacs/site-lisp
134
135 # @ECLASS-VARIABLE: SITEETC
136 # @DESCRIPTION:
137 # Directory where packages install miscellaneous (not Lisp) files.
138 SITEETC=/usr/share/emacs/etc
139
140 # @ECLASS-VARIABLE: SITEFILE
141 # @DESCRIPTION:
142 # Name of package's site-init file.
143 SITEFILE=50${PN}-gentoo.el
144
145 # @ECLASS-VARIABLE: EMACS
146 # @DESCRIPTION:
147 # Path of Emacs executable.
148 EMACS=/usr/bin/emacs
149
150 # @ECLASS-VARIABLE: EMACSFLAGS
151 # @DESCRIPTION:
152 # Flags for executing Emacs in batch mode.
153 # These work for Emacs versions 18-23, so don't change them.
154 EMACSFLAGS="-batch -q --no-site-file"
155
156 # @ECLASS-VARIABLE: BYTECOMPFLAGS
157 # @DESCRIPTION:
158 # Emacs flags used for byte-compilation in elisp-compile().
159 BYTECOMPFLAGS="-L ."
160
161 # @FUNCTION: elisp-compile
162 # @USAGE: <list of elisp files>
163 # @DESCRIPTION:
164 # Byte-compile Emacs Lisp files.
165 #
166 # This function uses GNU Emacs to byte-compile all ".el" specified by its
167 # arguments. The resulting byte-code (".elc") files are placed in the same
168 # directory as their corresponding source file.
169 #
170 # The current directory is added to the load-path. This will ensure that
171 # interdependent Emacs Lisp files are visible between themselves, in case
172 # they require or load one another.
173
174 elisp-compile() {
175 ebegin "Compiling GNU Emacs Elisp files"
176 ${EMACS} ${EMACSFLAGS} ${BYTECOMPFLAGS} -f batch-byte-compile "$@"
177 eend $? "elisp-compile: batch-byte-compile failed"
178 }
179
180 # #FUNCTION: elisp-comp
181 # #USAGE: <list of elisp files>
182 # #DESCRIPTION:
183 # Byte-compile interdependent Emacs Lisp files.
184 # THIS FUNCTION IS DEPRECATED.
185 #
186 # This function byte-compiles all ".el" files which are part of its
187 # arguments, using GNU Emacs, and puts the resulting ".elc" files into the
188 # current directory, so disregarding the original directories used in ".el"
189 # arguments.
190 #
191 # This function manages in such a way that all Emacs Lisp files to be
192 # compiled are made visible between themselves, in the event they require or
193 # load one another.
194
195 elisp-comp() {
196 # Copyright 1995 Free Software Foundation, Inc.
197 # François Pinard <pinard@iro.umontreal.ca>, 1995.
198 # Originally taken from GNU autotools.
199
200 ewarn "Function elisp-comp is deprecated and may be removed in future."
201 ewarn "Please use function elisp-compile instead, or report a bug about"
202 ewarn "${CATEGORY}/${PF} at <http://bugs.gentoo.org/>."
203 echo
204
205 [ $# -gt 0 ] || return 1
206
207 ebegin "Compiling GNU Emacs Elisp files"
208
209 local tempdir=elc.$$
210 mkdir ${tempdir}
211 cp "$@" ${tempdir}
212 pushd ${tempdir}
213
214 echo "(add-to-list 'load-path \"../\")" > script
215 ${EMACS} ${EMACSFLAGS} -l script -f batch-byte-compile *.el
216 local ret=$?
217 mv *.elc ..
218
219 popd
220 rm -fr ${tempdir}
221
222 eend ${ret} "elisp-comp: batch-byte-compile failed"
223 }
224
225 # @FUNCTION: elisp-emacs-version
226 # @DESCRIPTION:
227 # Output version of currently active Emacs.
228
229 elisp-emacs-version() {
230 # The following will work for at least versions 18-23.
231 echo "(princ emacs-version)" >"${T}"/emacs-version.el
232 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
233 rm -f "${T}"/emacs-version.el
234 }
235
236 # @FUNCTION: elisp-make-autoload-file
237 # @USAGE: [output file] [list of directories]
238 # @DESCRIPTION:
239 # Generate a file with autoload definitions for the lisp functions.
240
241 elisp-make-autoload-file() {
242 local f="${1:-${PN}-autoloads.el}"
243 shift
244 ebegin "Generating autoload file for GNU Emacs"
245
246 sed 's/^FF/\f/' >"${f}" <<-EOF
247 ;;; ${f##*/} --- autoloads for ${P}
248
249 ;;; Commentary:
250 ;; Automatically generated by elisp-common.eclass
251 ;; DO NOT EDIT THIS FILE
252
253 ;;; Code:
254 FF
255 ;; Local Variables:
256 ;; version-control: never
257 ;; no-byte-compile: t
258 ;; no-update-autoloads: t
259 ;; End:
260 ;;; ${f##*/} ends here
261 EOF
262
263 ${EMACS} ${EMACSFLAGS} \
264 --eval "(setq make-backup-files nil)" \
265 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
266 -f batch-update-autoloads "${@-.}"
267
268 eend $? "elisp-make-autoload-file: batch-update-autoloads failed"
269 }
270
271 # @FUNCTION: elisp-install
272 # @USAGE: <subdirectory> <list of files>
273 # @DESCRIPTION:
274 # Install files in SITELISP directory.
275
276 elisp-install() {
277 local subdir="$1"
278 shift
279 ebegin "Installing Elisp files for GNU Emacs support"
280 ( # subshell to avoid pollution of calling environment
281 insinto "${SITELISP}/${subdir}"
282 doins "$@"
283 )
284 eend $? "elisp-install: doins failed"
285 }
286
287 # @FUNCTION: elisp-site-file-install
288 # @USAGE: <site-init file> [subdirectory]
289 # @DESCRIPTION:
290 # Install Emacs site-init file in SITELISP directory.
291
292 elisp-site-file-install() {
293 local sf="${T}/${1##*/}" my_pn="${2:-${PN}}" ret
294 ebegin "Installing site initialisation file for GNU Emacs"
295 cp "$1" "${sf}"
296 sed -i -e "s:@SITELISP@:${SITELISP}/${my_pn}:g" \
297 -e "s:@SITEETC@:${SITEETC}/${my_pn}:g" "${sf}"
298 ( # subshell to avoid pollution of calling environment
299 insinto "${SITELISP}/site-gentoo.d"
300 doins "${sf}"
301 )
302 ret=$?
303 rm -f "${sf}"
304 eend ${ret} "elisp-site-file-install: doins failed"
305 }
306
307 # @FUNCTION: elisp-site-regen
308 # @DESCRIPTION:
309 # Regenerate the site-gentoo.el file, based on packages' site initialisation
310 # files in the /usr/share/emacs/site-lisp/site-gentoo.d/ directory.
311 #
312 # Note: Before December 2007, site initialisation files were installed in
313 # /usr/share/emacs/site-lisp/. For backwards compatibility, this location is
314 # still supported when generating site-gentoo.el.
315
316 elisp-site-regen() {
317 local i sf line firstrun obsolete
318 local -a sflist
319 # Work around Paludis borkage: variable T is empty in pkg_postrm
320 local tmpdir=${T:-$(mktemp -d)}
321
322 if [ ! -d "${ROOT}${SITELISP}" ]; then
323 eerror "elisp-site-regen: Directory ${SITELISP} does not exist"
324 return 1
325 fi
326
327 [ -e "${ROOT}${SITELISP}"/site-gentoo.el ] || firstrun=t
328
329 if [ "${firstrun}" ] && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then
330 einfo "Creating default ${SITELISP}/site-start.el ..."
331 cat <<-EOF >"${tmpdir}"/site-start.el
332 ;;; site-start.el
333
334 ;;; Commentary:
335 ;; This default site startup file is installed by elisp-common.eclass.
336 ;; You may replace this file by your own site initialisation, or even
337 ;; remove it completely; it will not be recreated.
338
339 ;;; Code:
340 ;; Load site initialisation for Gentoo-installed packages.
341 (require 'site-gentoo)
342
343 ;;; site-start.el ends here
344 EOF
345 fi
346
347 einfon "Regenerating ${SITELISP}/site-gentoo.el ..."
348
349 # remove any auxiliary file (from previous run)
350 rm -f "${ROOT}${SITELISP}"/00site-gentoo.el
351
352 # set nullglob option, there may be a directory without matching files
353 local old_shopts=$(shopt -p nullglob)
354 shopt -s nullglob
355
356 for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el \
357 "${ROOT}${SITELISP}"/site-gentoo.d/[0-9][0-9]*.el
358 do
359 [ -r "${sf}" ] || continue
360 # sort files by their basename. straight insertion sort.
361 for ((i=${#sflist[@]}; i>0; i--)); do
362 [[ ${sf##*/} < ${sflist[i-1]##*/} ]] || break
363 sflist[i]=${sflist[i-1]}
364 done
365 sflist[i]=${sf}
366 # set a flag if there are obsolete files
367 [ "${sf%/*}" = "${ROOT}${SITELISP}" ] && obsolete=t
368 done
369
370 eval "${old_shopts}"
371
372 cat <<-EOF >"${tmpdir}"/site-gentoo.el
373 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
374
375 ;;; Commentary:
376 ;; Automatically generated by elisp-common.eclass
377 ;; DO NOT EDIT THIS FILE
378
379 ;;; Code:
380 EOF
381 cat "${sflist[@]}" </dev/null >>"${tmpdir}"/site-gentoo.el
382 cat <<-EOF >>"${tmpdir}"/site-gentoo.el
383
384 (provide 'site-gentoo)
385
386 ;; Local Variables:
387 ;; no-byte-compile: t
388 ;; End:
389 ;;; site-gentoo.el ends here
390 EOF
391
392 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${tmpdir}"/site-gentoo.el
393 then
394 # This prevents outputting unnecessary text when there
395 # was actually no change.
396 # A case is a remerge where we have doubled output.
397 echo " no changes."
398 else
399 mv "${tmpdir}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
400 [ -f "${tmpdir}"/site-start.el ] \
401 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \
402 && mv "${tmpdir}"/site-start.el "${ROOT}${SITELISP}"/site-start.el
403 echo
404 einfo "... ${#sflist[@]} site initialisation file(s) included."
405 fi
406
407 if [ "${firstrun}" ]; then
408 echo
409 while read line; do einfo "${line:- }"; done <<-EOF
410 All site initialisation for Gentoo-installed packages is added to
411 /usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is not
412 managed by Gentoo. You are responsible for all maintenance of
413 site-start.el if there is such a file.
414
415 In order for this site initialisation to be loaded for all users
416 automatically, you can add a line like this:
417
418 (require 'site-gentoo)
419
420 to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
421 can be added by individual users to their initialisation files, or,
422 for greater flexibility, users can load individual package-specific
423 initialisation files from /usr/share/emacs/site-lisp/site-gentoo.d/.
424 EOF
425 echo
426 fi
427
428 if [ "${obsolete}" ]; then
429 echo
430 while read line; do ewarn "${line}"; done <<-EOF
431 Site-initialisation files of Emacs packages are now installed in
432 /usr/share/emacs/site-lisp/site-gentoo.d/. We strongly recommend
433 that you use app-admin/emacs-updater to rebuild the installed
434 Emacs packages.
435 EOF
436
437 # Kludge for backwards compatibility: During pkg_postrm, old versions
438 # of this eclass (saved in the VDB) won't find packages' site-init
439 # files in the new location. So we copy them to an auxiliary file
440 # that is visible to old eclass versions.
441 for sf in "${sflist[@]}"; do
442 [ "${sf%/*}" = "${ROOT}${SITELISP}/site-gentoo.d" ] \
443 && cat "${sf}" >>"${ROOT}${SITELISP}"/00site-gentoo.el
444 done
445 fi
446
447 # cleanup
448 rm -f "${tmpdir}"/site-{gentoo,start}.el
449
450 return 0
451 }

  ViewVC Help
Powered by ViewVC 1.1.20