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

Contents of /eclass/elisp-common.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.33 - (hide annotations) (download)
Wed Dec 12 21:58:57 2007 UTC (7 years ago) by ulm
Branch: MAIN
Changes since 1.32: +2 -2 lines
Redirect input for cat command to /dev/null, otherwise it will hang if the list
of files is empty. Thanks to bicatali for pointing this out.

1 opfer 1.15 # Copyright 1999-2007 Gentoo Foundation
2 mkennedy 1.1 # Distributed under the terms of the GNU General Public License v2
3 ulm 1.33 # $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.32 2007/12/11 12:28:05 ulm Exp $
4 mkennedy 1.1 #
5 opfer 1.15 # Copyright 2007 Christian Faulhammer <opfer@gentoo.org>
6 ulm 1.24 # Copyright 2002-2004 Matthew Kennedy <mkennedy@gentoo.org>
7     # Copyright 2004-2005 Mamoru Komachi <usata@gentoo.org>
8 mkennedy 1.2 # Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com>
9 opfer 1.15 # Copyright 2007 Ulrich Mueller <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.25 # simply takes the source files as arguments.
37 opfer 1.15 #
38 ulm 1.26 # elisp-compile *.el || die "elisp-compile failed"
39 ulm 1.25 #
40     # In the case of interdependent elisp files, you can use the elisp-comp()
41     # function which makes sure all files are loadable.
42     #
43 ulm 1.26 # elisp-comp *.el || die "elisp-comp failed"
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 opfer 1.15 # source files contain magic ";;;###autoload" comments. See the Emacs Lisp
50     # 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.31 # Directory where packages install miscellaneous (not Lisp) files.
136     SITEETC=/usr/share/emacs/etc
137    
138 ulm 1.29 # @ECLASS-VARIABLE: SITEFILE
139     # @DESCRIPTION:
140     # Name of package's site-init file.
141 ulm 1.25 SITEFILE=50${PN}-gentoo.el
142 ulm 1.29
143 ulm 1.28 EMACS=/usr/bin/emacs
144 ulm 1.29 # The following works for Emacs versions 18--23, don't change it.
145 ulm 1.30 EMACSFLAGS="-batch -q --no-site-file"
146 ulm 1.25
147     # @FUNCTION: elisp-compile
148     # @USAGE: <list of elisp files>
149     # @DESCRIPTION:
150     # Byte-compile Emacs Lisp files.
151 mkennedy 1.1
152 mkennedy 1.2 elisp-compile() {
153 ulm 1.32 ebegin "Compiling GNU Emacs Elisp files"
154 ulm 1.30 ${EMACS} ${EMACSFLAGS} -f batch-byte-compile "$@"
155 ulm 1.32 eend $? "batch-byte-compile failed"
156 ulm 1.30 }
157    
158     # @FUNCTION: elisp-comp
159     # @USAGE: <list of elisp files>
160     # @DESCRIPTION:
161     # Byte-compile interdependent Emacs Lisp files.
162     #
163     # This function byte-compiles all ".el" files which are part of its
164     # arguments, using GNU Emacs, and puts the resulting ".elc" files into the
165     # current directory, so disregarding the original directories used in ".el"
166     # arguments.
167     #
168     # This function manages in such a way that all Emacs Lisp files to be
169     # compiled are made visible between themselves, in the event they require or
170     # load one another.
171    
172     elisp-comp() {
173     # Copyright 1995 Free Software Foundation, Inc.
174     # Fran├žois Pinard <pinard@iro.umontreal.ca>, 1995.
175     # Originally taken from GNU autotools.
176    
177     [ $# -gt 0 ] || return 1
178    
179 ulm 1.32 ebegin "Compiling GNU Emacs Elisp files"
180 ulm 1.30
181     tempdir=elc.$$
182     mkdir ${tempdir}
183     cp "$@" ${tempdir}
184     pushd ${tempdir}
185    
186     echo "(add-to-list 'load-path \"../\")" > script
187     ${EMACS} ${EMACSFLAGS} -l script -f batch-byte-compile *.el
188     local ret=$?
189     mv *.elc ..
190    
191     popd
192     rm -fr ${tempdir}
193 ulm 1.32
194     eend ${ret} "batch-byte-compile failed"
195 ulm 1.30 return ${ret}
196 opfer 1.22 }
197    
198 ulm 1.25 # @FUNCTION: elisp-emacs-version
199     # @DESCRIPTION:
200     # Output version of currently active Emacs.
201    
202 opfer 1.22 elisp-emacs-version() {
203 ulm 1.28 # The following will work for at least versions 18-23.
204 opfer 1.22 echo "(princ emacs-version)" >"${T}"/emacs-version.el
205 ulm 1.30 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
206 mkennedy 1.2 }
207    
208 ulm 1.25 # @FUNCTION: elisp-make-autoload-file
209     # @USAGE: [output file] [list of directories]
210     # @DESCRIPTION:
211     # Generate a file with autoload definitions for the lisp functions.
212    
213 ulm 1.29 elisp-make-autoload-file() {
214 opfer 1.17 local f="${1:-${PN}-autoloads.el}"
215 opfer 1.15 shift
216 ulm 1.32 ebegin "Generating autoload file for GNU Emacs"
217 opfer 1.22
218 ulm 1.21 sed 's/^FF/\f/' >"${f}" <<-EOF
219     ;;; ${f##*/} --- autoloads for ${P}
220    
221     ;;; Commentary:
222     ;; Automatically generated by elisp-common.eclass
223     ;; DO NOT EDIT THIS FILE
224    
225     ;;; Code:
226     FF
227     ;; Local Variables:
228     ;; version-control: never
229     ;; no-byte-compile: t
230     ;; no-update-autoloads: t
231     ;; End:
232     ;;; ${f##*/} ends here
233     EOF
234 opfer 1.22
235 ulm 1.30 ${EMACS} ${EMACSFLAGS} \
236 opfer 1.15 --eval "(setq make-backup-files nil)" \
237     --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
238     -f batch-update-autoloads "${@-.}"
239 ulm 1.32
240     eend $? "batch-update-autoloads failed"
241 opfer 1.15 }
242    
243 ulm 1.25 # @FUNCTION: elisp-install
244     # @USAGE: <subdirectory> <list of files>
245     # @DESCRIPTION:
246     # Install files in SITELISP directory.
247    
248 mkennedy 1.1 elisp-install() {
249 ulm 1.28 local subdir="$1"
250     shift
251 ulm 1.32 ebegin "Installing Elisp files for GNU Emacs support"
252 ulm 1.28 ( # subshell to avoid pollution of calling environment
253     insinto "${SITELISP}/${subdir}"
254     doins "$@"
255     )
256 ulm 1.32 eend $? "doins failed"
257 mkennedy 1.1 }
258    
259 ulm 1.25 # @FUNCTION: elisp-site-file-install
260     # @USAGE: <site-init file> [subdirectory]
261     # @DESCRIPTION:
262     # Install Emacs site-init file in SITELISP directory.
263    
264 mkennedy 1.1 elisp-site-file-install() {
265 ulm 1.28 local sf="$1" my_pn="${2:-${PN}}"
266 ulm 1.32 ebegin "Installing site initialisation file for GNU Emacs"
267 ulm 1.28 cp "${sf}" "${T}"
268 ulm 1.31 sed -i -e "s:@SITELISP@:${SITELISP}/${my_pn}:g" \
269     -e "s:@SITEETC@:${SITEETC}/${my_pn}:g" "${T}/${sf##*/}"
270 ulm 1.28 ( # subshell to avoid pollution of calling environment
271     insinto "${SITELISP}"
272 ulm 1.31 doins "${T}/${sf##*/}"
273 ulm 1.28 )
274 ulm 1.32 eend $? "doins failed"
275 mkennedy 1.1 }
276    
277 ulm 1.25 # @FUNCTION: elisp-site-regen
278     # @DESCRIPTION:
279     # Regenerate site-gentoo.el file.
280    
281 ulm 1.32 # Old location for site initialisation files of packages was
282     # /usr/share/emacs/site-lisp/. It is planned to change this to
283     # /usr/share/emacs/site-lisp/site-gentoo.d/.
284    
285 mkennedy 1.1 elisp-site-regen() {
286 ulm 1.32 local i sf line
287     local -a sflist
288 opfer 1.22
289 ulm 1.29 if [ ! -e "${ROOT}${SITELISP}"/site-gentoo.el ] \
290     && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then
291     einfo "Creating default ${SITELISP}/site-start.el ..."
292     cat <<-EOF >"${T}"/site-start.el
293     ;;; site-start.el
294    
295     ;;; Commentary:
296     ;; This default site startup file is installed by elisp-common.eclass.
297     ;; You may replace this file by your own site initialisation, or even
298     ;; remove it completely; it will not be recreated.
299    
300     ;;; Code:
301     ;; Load site initialisation for Gentoo-installed packages.
302     (require 'site-gentoo)
303    
304     ;;; site-start.el ends here
305     EOF
306     fi
307    
308 ulm 1.25 einfon "Regenerating ${SITELISP}/site-gentoo.el ..."
309 ulm 1.32
310     # remove auxiliary file
311     rm -f "${ROOT}${SITELISP}"/00site-gentoo.el
312    
313     # set nullglob option, there may be a directory without matching files
314     local old_shopts=$(shopt -p nullglob)
315     shopt -s nullglob
316    
317     for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el \
318     "${ROOT}${SITELISP}"/site-gentoo.d/[0-9][0-9]*.el
319     do
320     [ -r "${sf}" ] || continue
321     # sort files by their basename. straight insertion sort.
322     for ((i=${#sflist[@]}; i>0; i--)); do
323     [[ ${sf##*/} < ${sflist[i-1]##*/} ]] || break
324     sflist[i]=${sflist[i-1]}
325     done
326     sflist[i]=${sf}
327     done
328    
329     eval "${old_shopts}"
330    
331 ulm 1.24 cat <<-EOF >"${T}"/site-gentoo.el
332     ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
333    
334     ;;; Commentary:
335     ;; Automatically generated by elisp-common.eclass
336     ;; DO NOT EDIT THIS FILE
337    
338     ;;; Code:
339     EOF
340 ulm 1.33 cat "${sflist[@]}" </dev/null >>"${T}"/site-gentoo.el
341 ulm 1.24 cat <<-EOF >>"${T}"/site-gentoo.el
342    
343 ulm 1.28 (provide 'site-gentoo)
344    
345     ;; Local Variables:
346     ;; no-byte-compile: t
347     ;; End:
348 ulm 1.24 ;;; site-gentoo.el ends here
349     EOF
350    
351 opfer 1.22 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${T}"/site-gentoo.el; then
352     # This prevents outputting unnecessary text when there
353 ulm 1.29 # was actually no change.
354     # A case is a remerge where we have doubled output.
355 ulm 1.25 echo " no changes."
356 opfer 1.22 else
357 ulm 1.24 mv "${T}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
358 ulm 1.29 [ -f "${T}"/site-start.el ] \
359     && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \
360     && mv "${T}"/site-start.el "${ROOT}${SITELISP}"/site-start.el
361 ulm 1.25 echo; einfo
362 ulm 1.32 for sf in "${sflist[@]##*/}"; do
363 opfer 1.22 einfo " Adding ${sf} ..."
364     done
365 ulm 1.32 einfo "Regenerated ${SITELISP}/site-gentoo.el."
366    
367     echo
368 opfer 1.22 while read line; do einfo "${line}"; done <<EOF
369 ulm 1.25 All site initialisation for Gentoo-installed packages is added to
370 jbms 1.4 /usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer
371 ulm 1.31 managed by Gentoo. You are responsible for all maintenance of
372 usata 1.8 site-start.el if there is such a file.
373 jbms 1.4
374 ulm 1.24 In order for this site initialisation to be loaded for all users
375 ulm 1.25 automatically, you can add a line like this:
376 jbms 1.4
377 ulm 1.29 (require 'site-gentoo)
378 jbms 1.4
379     to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
380 ulm 1.31 can be added by individual users to their initialisation files, or,
381     for greater flexibility, users can load individual package-specific
382     initialisation files from /usr/share/emacs/site-lisp/.
383 jbms 1.4 EOF
384 opfer 1.22 echo
385     fi
386 ulm 1.32
387     # Kludge for backwards compatibility: During pkg_postrm, old versions
388     # of this eclass (saved in the PDB) won't find packages' site-init files
389     # in the new location. So we copy them to an auxiliary file that is
390     # visible to old eclass versions.
391     for sf in "${sflist[@]}"; do
392     [ "${sf%/*}" = "${ROOT}${SITELISP}/site-gentoo.d" ] \
393     && cat "${sf}" >>"${ROOT}${SITELISP}"/00site-gentoo.el
394     done
395 mkennedy 1.3 }

  ViewVC Help
Powered by ViewVC 1.1.20