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

Contents of /eclass/elisp-common.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.54 - (show annotations) (download)
Sat Jan 31 21:31:42 2009 UTC (5 years, 7 months ago) by ulm
Branch: MAIN
Changes since 1.53: +3 -3 lines
Update copyright years.

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

  ViewVC Help
Powered by ViewVC 1.1.20