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

Contents of /eclass/elisp-common.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.48 - (hide annotations) (download)
Sun Oct 5 13:56:08 2008 UTC (5 years, 11 months ago) by ulm
Branch: MAIN
Changes since 1.47: +9 -6 lines
Document SITEETC as eclass variable. Update comment for elisp-site-regen.

1 ulm 1.36 # Copyright 1999-2008 Gentoo Foundation
2 mkennedy 1.1 # Distributed under the terms of the GNU General Public License v2
3 ulm 1.48 # $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.47 2008/09/24 09:47:04 ulm Exp $
4 mkennedy 1.1 #
5 ulm 1.24 # Copyright 2002-2004 Matthew Kennedy <mkennedy@gentoo.org>
6 ulm 1.35 # Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com>
7 ulm 1.24 # Copyright 2004-2005 Mamoru Komachi <usata@gentoo.org>
8 ulm 1.35 # Copyright 2007-2008 Christian Faulhammer <opfer@gentoo.org>
9     # Copyright 2007-2008 Ulrich Müller <ulm@gentoo.org>
10 mkennedy 1.1 #
11 ulm 1.25 # @ECLASS: elisp-common.eclass
12     # @MAINTAINER:
13 ulm 1.29 # Feel free to contact the Emacs team through <emacs@gentoo.org> if you have
14 ulm 1.25 # problems, suggestions or questions.
15     # @BLURB: Emacs-related installation utilities
16     # @DESCRIPTION:
17 opfer 1.15 #
18     # Usually you want to use this eclass for (optional) GNU Emacs support of
19 ulm 1.18 # your package. This is NOT for XEmacs!
20 ulm 1.25 #
21     # Many of the steps here are sometimes done by the build system of your
22 opfer 1.15 # package (especially compilation), so this is mainly for standalone elisp
23     # files you gathered from somewhere else.
24 ulm 1.25 #
25     # When relying on the emacs USE flag, you need to add
26 opfer 1.15 #
27 ulm 1.26 # emacs? ( virtual/emacs )
28 opfer 1.15 #
29     # to your DEPEND/RDEPEND line and use the functions provided here to bring
30     # the files to the correct locations.
31     #
32 ulm 1.25 # .SS
33 opfer 1.15 # src_compile() usage:
34     #
35     # An elisp file is compiled by the elisp-compile() function defined here and
36 ulm 1.43 # 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 opfer 1.15 #
40 ulm 1.26 # elisp-compile *.el || die "elisp-compile failed"
41 ulm 1.25 #
42 ulm 1.43 # Formerly, function elisp-comp() was used for compilation of interdependent
43     # elisp files. This usage is considered as obsolete.
44 opfer 1.15 #
45 ulm 1.25 # Function elisp-make-autoload-file() can be used to generate a file with
46 ulm 1.18 # autoload definitions for the lisp functions. It takes the output file name
47 opfer 1.15 # (default: "${PN}-autoloads.el") and a list of directories (default: working
48 ulm 1.18 # directory) as its arguments. Use of this function requires that the elisp
49 ulm 1.43 # source files contain magic ";;;###autoload" comments. See the Emacs Lisp
50 opfer 1.15 # Reference Manual (node "Autoload") for a detailed explanation.
51     #
52 ulm 1.25 # .SS
53 opfer 1.15 # 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 ulm 1.26 # elisp-install ${PN} *.el *.elc || die "elisp-install failed"
63 opfer 1.15 #
64 ulm 1.25 # To let the Emacs support be activated by Emacs on startup, you need
65 opfer 1.15 # to provide a site file (shipped in ${FILESDIR}) which contains the startup
66 ulm 1.18 # code (have a look in the documentation of your software). Normally this
67 opfer 1.15 # would look like this:
68     #
69 ulm 1.26 # ;;; csv-mode site-lisp configuration
70 opfer 1.15 #
71 ulm 1.26 # (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 opfer 1.15 #
75 ulm 1.25 # If your Emacs support files are installed in a subdirectory of
76 ulm 1.29 # /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 ulm 1.25 #
81     # The next line tells Emacs to load the mode opening a file ending with
82 opfer 1.15 # ".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 ulm 1.18 # 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 opfer 1.15 # in pkg_postinst(), which should be enough.
88 ulm 1.25 #
89     # The naming scheme for this site file is "[0-9][0-9]*-gentoo.el", where the
90 ulm 1.18 # two digits at the beginning define the loading order. So if you depend on
91 opfer 1.15 # another Emacs package, your site file's number must be higher!
92 ulm 1.25 #
93     # Best practice is to define a SITEFILE variable in the global scope of your
94 opfer 1.15 # ebuild (right after DEPEND e.g.):
95     #
96 ulm 1.26 # SITEFILE=50${PN}-gentoo.el
97 opfer 1.15 #
98 ulm 1.25 # Which is then installed by
99 opfer 1.15 #
100 ulm 1.29 # elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
101 opfer 1.15 #
102 ulm 1.18 # in src_install(). If your subdirectory is not named ${PN}, give the
103 opfer 1.15 # differing name as second argument.
104     #
105 ulm 1.25 # .SS
106 opfer 1.15 # 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 ulm 1.26 # pkg_postinst() {
112     # elisp-site-regen
113     # }
114     #
115     # pkg_postrm() {
116     # elisp-site-regen
117     # }
118 opfer 1.15 #
119 ulm 1.25 # When having optional Emacs support, you should prepend "use emacs &&" to
120 opfer 1.22 # above calls of elisp-site-regen(). Don't use "has_version virtual/emacs"!
121 ulm 1.25 # When unmerging the state of the emacs USE flag is taken from the package
122 opfer 1.22 # database and not from the environment, so it is no problem when you unset
123 ulm 1.25 # USE=emacs between merge and unmerge of a package.
124 opfer 1.22 #
125 ulm 1.25 # .SS
126 opfer 1.22 # Miscellaneous functions:
127     #
128     # elisp-emacs-version() outputs the version of the currently active Emacs.
129 mkennedy 1.1
130 ulm 1.29 # @ECLASS-VARIABLE: SITELISP
131     # @DESCRIPTION:
132 ulm 1.31 # Directory where packages install Emacs Lisp files.
133 mkennedy 1.1 SITELISP=/usr/share/emacs/site-lisp
134 ulm 1.29
135 ulm 1.48 # @ECLASS-VARIABLE: SITEETC
136     # @DESCRIPTION:
137 ulm 1.31 # Directory where packages install miscellaneous (not Lisp) files.
138     SITEETC=/usr/share/emacs/etc
139    
140 ulm 1.29 # @ECLASS-VARIABLE: SITEFILE
141     # @DESCRIPTION:
142     # Name of package's site-init file.
143 ulm 1.25 SITEFILE=50${PN}-gentoo.el
144 ulm 1.29
145 ulm 1.43 # @ECLASS-VARIABLE: EMACS
146     # @DESCRIPTION:
147     # Path of Emacs executable.
148 ulm 1.28 EMACS=/usr/bin/emacs
149 ulm 1.43
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 ulm 1.30 EMACSFLAGS="-batch -q --no-site-file"
155 ulm 1.25
156 ulm 1.43 # @ECLASS-VARIABLE: BYTECOMPFLAGS
157     # @DESCRIPTION:
158     # Emacs flags used for byte-compilation in elisp-compile().
159     BYTECOMPFLAGS="-L ."
160    
161 ulm 1.25 # @FUNCTION: elisp-compile
162     # @USAGE: <list of elisp files>
163     # @DESCRIPTION:
164     # Byte-compile Emacs Lisp files.
165 ulm 1.43 #
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 mkennedy 1.1
174 mkennedy 1.2 elisp-compile() {
175 ulm 1.32 ebegin "Compiling GNU Emacs Elisp files"
176 ulm 1.43 ${EMACS} ${EMACSFLAGS} ${BYTECOMPFLAGS} -f batch-byte-compile "$@"
177 ulm 1.32 eend $? "batch-byte-compile failed"
178 ulm 1.30 }
179    
180 ulm 1.44 # #FUNCTION: elisp-comp
181     # #USAGE: <list of elisp files>
182     # #DESCRIPTION:
183 ulm 1.30 # Byte-compile interdependent Emacs Lisp files.
184 ulm 1.46 # THIS FUNCTION IS DEPRECATED.
185 ulm 1.30 #
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 ulm 1.46 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 ulm 1.30 [ $# -gt 0 ] || return 1
206    
207 ulm 1.32 ebegin "Compiling GNU Emacs Elisp files"
208 ulm 1.30
209 ulm 1.45 local tempdir=elc.$$
210 ulm 1.30 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 ulm 1.32
222     eend ${ret} "batch-byte-compile failed"
223 ulm 1.30 return ${ret}
224 opfer 1.22 }
225    
226 ulm 1.25 # @FUNCTION: elisp-emacs-version
227     # @DESCRIPTION:
228     # Output version of currently active Emacs.
229    
230 opfer 1.22 elisp-emacs-version() {
231 ulm 1.38 # The following will work for at least versions 18-23.
232 opfer 1.22 echo "(princ emacs-version)" >"${T}"/emacs-version.el
233 ulm 1.30 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
234 ulm 1.37 rm -f "${T}"/emacs-version.el
235 mkennedy 1.2 }
236    
237 ulm 1.25 # @FUNCTION: elisp-make-autoload-file
238     # @USAGE: [output file] [list of directories]
239     # @DESCRIPTION:
240     # Generate a file with autoload definitions for the lisp functions.
241    
242 ulm 1.29 elisp-make-autoload-file() {
243 opfer 1.17 local f="${1:-${PN}-autoloads.el}"
244 opfer 1.15 shift
245 ulm 1.32 ebegin "Generating autoload file for GNU Emacs"
246 opfer 1.22
247 ulm 1.21 sed 's/^FF/\f/' >"${f}" <<-EOF
248     ;;; ${f##*/} --- autoloads for ${P}
249    
250     ;;; Commentary:
251     ;; Automatically generated by elisp-common.eclass
252     ;; DO NOT EDIT THIS FILE
253    
254     ;;; Code:
255     FF
256     ;; Local Variables:
257     ;; version-control: never
258     ;; no-byte-compile: t
259     ;; no-update-autoloads: t
260     ;; End:
261     ;;; ${f##*/} ends here
262     EOF
263 opfer 1.22
264 ulm 1.30 ${EMACS} ${EMACSFLAGS} \
265 opfer 1.15 --eval "(setq make-backup-files nil)" \
266     --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
267     -f batch-update-autoloads "${@-.}"
268 ulm 1.32
269     eend $? "batch-update-autoloads failed"
270 opfer 1.15 }
271    
272 ulm 1.25 # @FUNCTION: elisp-install
273     # @USAGE: <subdirectory> <list of files>
274     # @DESCRIPTION:
275     # Install files in SITELISP directory.
276    
277 mkennedy 1.1 elisp-install() {
278 ulm 1.28 local subdir="$1"
279     shift
280 ulm 1.32 ebegin "Installing Elisp files for GNU Emacs support"
281 ulm 1.28 ( # subshell to avoid pollution of calling environment
282     insinto "${SITELISP}/${subdir}"
283     doins "$@"
284     )
285 ulm 1.32 eend $? "doins failed"
286 mkennedy 1.1 }
287    
288 ulm 1.25 # @FUNCTION: elisp-site-file-install
289     # @USAGE: <site-init file> [subdirectory]
290     # @DESCRIPTION:
291     # Install Emacs site-init file in SITELISP directory.
292    
293 mkennedy 1.1 elisp-site-file-install() {
294 ulm 1.37 local sf="${T}/${1##*/}" my_pn="${2:-${PN}}" ret
295 ulm 1.32 ebegin "Installing site initialisation file for GNU Emacs"
296 ulm 1.37 cp "$1" "${sf}"
297 ulm 1.31 sed -i -e "s:@SITELISP@:${SITELISP}/${my_pn}:g" \
298 ulm 1.37 -e "s:@SITEETC@:${SITEETC}/${my_pn}:g" "${sf}"
299 ulm 1.28 ( # subshell to avoid pollution of calling environment
300 ulm 1.34 insinto "${SITELISP}/site-gentoo.d"
301 ulm 1.37 doins "${sf}"
302 ulm 1.28 )
303 ulm 1.37 ret=$?
304     rm -f "${sf}"
305     eend ${ret} "doins failed"
306 mkennedy 1.1 }
307    
308 ulm 1.25 # @FUNCTION: elisp-site-regen
309     # @DESCRIPTION:
310 ulm 1.48 # Regenerate the site-gentoo.el file, based on packages' site initialisation
311     # files in the /usr/share/emacs/site-lisp/site-gentoo.d/ directory.
312     #
313     # Note: Before December 2007, site initialisation files were installed in
314     # /usr/share/emacs/site-lisp/. For backwards compatibility, this location is
315     # still supported when generating site-gentoo.el.
316 ulm 1.32
317 mkennedy 1.1 elisp-site-regen() {
318 ulm 1.47 local i sf line firstrun obsolete
319 ulm 1.32 local -a sflist
320 ulm 1.38 # Work around Paludis borkage: variable T is empty in pkg_postrm
321 ulm 1.39 local tmpdir=${T:-$(mktemp -d)}
322 opfer 1.22
323 ulm 1.38 if [ ! -d "${ROOT}${SITELISP}" ]; then
324     eerror "Directory ${SITELISP} does not exist"
325     return 1
326     fi
327    
328 ulm 1.47 [ -e "${ROOT}${SITELISP}"/site-gentoo.el ] || firstrun=t
329    
330     if [ "${firstrun}" ] && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then
331 ulm 1.29 einfo "Creating default ${SITELISP}/site-start.el ..."
332 ulm 1.37 cat <<-EOF >"${tmpdir}"/site-start.el
333 ulm 1.29 ;;; site-start.el
334    
335     ;;; Commentary:
336     ;; This default site startup file is installed by elisp-common.eclass.
337     ;; You may replace this file by your own site initialisation, or even
338     ;; remove it completely; it will not be recreated.
339    
340     ;;; Code:
341     ;; Load site initialisation for Gentoo-installed packages.
342     (require 'site-gentoo)
343    
344     ;;; site-start.el ends here
345     EOF
346     fi
347    
348 ulm 1.25 einfon "Regenerating ${SITELISP}/site-gentoo.el ..."
349 ulm 1.32
350 ulm 1.41 # remove any auxiliary file (from previous run)
351 ulm 1.32 rm -f "${ROOT}${SITELISP}"/00site-gentoo.el
352    
353     # set nullglob option, there may be a directory without matching files
354     local old_shopts=$(shopt -p nullglob)
355     shopt -s nullglob
356    
357     for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el \
358     "${ROOT}${SITELISP}"/site-gentoo.d/[0-9][0-9]*.el
359     do
360     [ -r "${sf}" ] || continue
361     # sort files by their basename. straight insertion sort.
362     for ((i=${#sflist[@]}; i>0; i--)); do
363     [[ ${sf##*/} < ${sflist[i-1]##*/} ]] || break
364     sflist[i]=${sflist[i-1]}
365     done
366     sflist[i]=${sf}
367 ulm 1.34 # set a flag if there are obsolete files
368     [ "${sf%/*}" = "${ROOT}${SITELISP}" ] && obsolete=t
369 ulm 1.32 done
370    
371     eval "${old_shopts}"
372    
373 ulm 1.37 cat <<-EOF >"${tmpdir}"/site-gentoo.el
374 ulm 1.24 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
375    
376     ;;; Commentary:
377     ;; Automatically generated by elisp-common.eclass
378     ;; DO NOT EDIT THIS FILE
379    
380     ;;; Code:
381     EOF
382 ulm 1.37 cat "${sflist[@]}" </dev/null >>"${tmpdir}"/site-gentoo.el
383     cat <<-EOF >>"${tmpdir}"/site-gentoo.el
384 ulm 1.24
385 ulm 1.28 (provide 'site-gentoo)
386    
387     ;; Local Variables:
388     ;; no-byte-compile: t
389     ;; End:
390 ulm 1.24 ;;; site-gentoo.el ends here
391     EOF
392    
393 ulm 1.37 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${tmpdir}"/site-gentoo.el
394     then
395 opfer 1.22 # This prevents outputting unnecessary text when there
396 ulm 1.29 # was actually no change.
397     # A case is a remerge where we have doubled output.
398 ulm 1.25 echo " no changes."
399 opfer 1.22 else
400 ulm 1.37 mv "${tmpdir}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
401     [ -f "${tmpdir}"/site-start.el ] \
402 ulm 1.29 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \
403 ulm 1.37 && mv "${tmpdir}"/site-start.el "${ROOT}${SITELISP}"/site-start.el
404 ulm 1.46 echo
405 ulm 1.47 einfo "... ${#sflist[@]} site initialisation file(s) included."
406     fi
407 ulm 1.32
408 ulm 1.47 if [ "${firstrun}" ]; then
409 ulm 1.32 echo
410 ulm 1.42 while read line; do einfo "${line:- }"; done <<-EOF
411     All site initialisation for Gentoo-installed packages is added to
412     /usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is not
413     managed by Gentoo. You are responsible for all maintenance of
414     site-start.el if there is such a file.
415    
416     In order for this site initialisation to be loaded for all users
417     automatically, you can add a line like this:
418    
419     (require 'site-gentoo)
420    
421     to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
422     can be added by individual users to their initialisation files, or,
423     for greater flexibility, users can load individual package-specific
424     initialisation files from /usr/share/emacs/site-lisp/site-gentoo.d/.
425     EOF
426 opfer 1.22 echo
427 ulm 1.41 fi
428    
429     if [ "${obsolete}" ]; then
430 ulm 1.46 echo
431 ulm 1.41 while read line; do ewarn "${line}"; done <<-EOF
432     Site-initialisation files of Emacs packages are now installed in
433     /usr/share/emacs/site-lisp/site-gentoo.d/. We strongly recommend
434 ulm 1.46 that you use app-admin/emacs-updater to rebuild the installed
435 ulm 1.41 Emacs packages.
436     EOF
437 ulm 1.35
438 ulm 1.41 # Kludge for backwards compatibility: During pkg_postrm, old versions
439     # of this eclass (saved in the VDB) won't find packages' site-init
440     # files in the new location. So we copy them to an auxiliary file
441     # that is visible to old eclass versions.
442     for sf in "${sflist[@]}"; do
443     [ "${sf%/*}" = "${ROOT}${SITELISP}/site-gentoo.d" ] \
444     && cat "${sf}" >>"${ROOT}${SITELISP}"/00site-gentoo.el
445     done
446 opfer 1.22 fi
447 ulm 1.32
448 ulm 1.37 # cleanup
449     rm -f "${tmpdir}"/site-{gentoo,start}.el
450 ulm 1.45
451     return 0
452 mkennedy 1.3 }

  ViewVC Help
Powered by ViewVC 1.1.20