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

Contents of /eclass/elisp-common.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.29 - (hide annotations) (download)
Sun Oct 14 22:12:30 2007 UTC (7 years, 1 month ago) by ulm
Branch: MAIN
Changes since 1.28: +42 -12 lines
Sync eclasses from Emacs overlay (revision 668).

elisp.eclass:
Comment changes.

elisp-common.eclass:
Create default site-start.el when running elisp-site-regen for the
first time; recommend "require" instead of "load" in einfo message.
Document SITELISP and SITEFILE eclass variables.
Other comment changes.

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.29 # $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.28 2007/09/22 20:25:30 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     # Directory where Emacs Lisp files are installed.
133 mkennedy 1.1 SITELISP=/usr/share/emacs/site-lisp
134 ulm 1.29
135     # @ECLASS-VARIABLE: SITEFILE
136     # @DESCRIPTION:
137     # Name of package's site-init file.
138 ulm 1.25 SITEFILE=50${PN}-gentoo.el
139 ulm 1.29
140 ulm 1.28 EMACS=/usr/bin/emacs
141 ulm 1.29 # The following works for Emacs versions 18--23, don't change it.
142 ulm 1.28 EMACS_BATCH_CLEAN="${EMACS} -batch -q --no-site-file"
143 ulm 1.25
144     # @FUNCTION: elisp-compile
145     # @USAGE: <list of elisp files>
146     # @DESCRIPTION:
147     # Byte-compile Emacs Lisp files.
148 mkennedy 1.1
149 mkennedy 1.2 elisp-compile() {
150 opfer 1.22 einfo "Compiling GNU Emacs Elisp files ..."
151 ulm 1.28 ${EMACS_BATCH_CLEAN} -f batch-byte-compile "$@"
152 opfer 1.22 }
153    
154 ulm 1.25 # @FUNCTION: elisp-emacs-version
155     # @DESCRIPTION:
156     # Output version of currently active Emacs.
157    
158 opfer 1.22 elisp-emacs-version() {
159 ulm 1.28 # The following will work for at least versions 18-23.
160 opfer 1.22 echo "(princ emacs-version)" >"${T}"/emacs-version.el
161 ulm 1.28 ${EMACS_BATCH_CLEAN} -l "${T}"/emacs-version.el
162 mkennedy 1.2 }
163    
164 ulm 1.25 # @FUNCTION: elisp-make-autoload-file
165     # @USAGE: [output file] [list of directories]
166     # @DESCRIPTION:
167     # Generate a file with autoload definitions for the lisp functions.
168    
169 ulm 1.29 elisp-make-autoload-file() {
170 opfer 1.17 local f="${1:-${PN}-autoloads.el}"
171 opfer 1.15 shift
172 opfer 1.22 einfo "Generating autoload file for GNU Emacs ..."
173    
174 ulm 1.21 sed 's/^FF/\f/' >"${f}" <<-EOF
175     ;;; ${f##*/} --- autoloads for ${P}
176    
177     ;;; Commentary:
178     ;; Automatically generated by elisp-common.eclass
179     ;; DO NOT EDIT THIS FILE
180    
181     ;;; Code:
182     FF
183     ;; Local Variables:
184     ;; version-control: never
185     ;; no-byte-compile: t
186     ;; no-update-autoloads: t
187     ;; End:
188     ;;; ${f##*/} ends here
189     EOF
190 opfer 1.22
191 ulm 1.28 ${EMACS_BATCH_CLEAN} \
192 opfer 1.15 --eval "(setq make-backup-files nil)" \
193     --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
194     -f batch-update-autoloads "${@-.}"
195     }
196    
197 ulm 1.25 # @FUNCTION: elisp-install
198     # @USAGE: <subdirectory> <list of files>
199     # @DESCRIPTION:
200     # Install files in SITELISP directory.
201    
202 mkennedy 1.1 elisp-install() {
203 ulm 1.28 local subdir="$1"
204     shift
205 opfer 1.22 einfo "Installing Elisp files for GNU Emacs support ..."
206 ulm 1.28 ( # subshell to avoid pollution of calling environment
207     insinto "${SITELISP}/${subdir}"
208     doins "$@"
209     )
210 mkennedy 1.1 }
211    
212 ulm 1.25 # @FUNCTION: elisp-site-file-install
213     # @USAGE: <site-init file> [subdirectory]
214     # @DESCRIPTION:
215     # Install Emacs site-init file in SITELISP directory.
216    
217 mkennedy 1.1 elisp-site-file-install() {
218 ulm 1.28 local sf="$1" my_pn="${2:-${PN}}"
219 opfer 1.22 einfo "Installing site initialisation file for GNU Emacs ..."
220 ulm 1.28 cp "${sf}" "${T}"
221     sed -i "s:@SITELISP@:${SITELISP}/${my_pn}:g" "${T}/$(basename "${sf}")"
222     ( # subshell to avoid pollution of calling environment
223     insinto "${SITELISP}"
224     doins "${T}/$(basename "${sf}")"
225     )
226 mkennedy 1.1 }
227    
228 ulm 1.25 # @FUNCTION: elisp-site-regen
229     # @DESCRIPTION:
230     # Regenerate site-gentoo.el file.
231    
232 mkennedy 1.1 elisp-site-regen() {
233 opfer 1.22 local sflist sf line
234    
235 ulm 1.29 if [ ! -e "${ROOT}${SITELISP}"/site-gentoo.el ] \
236     && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then
237     einfo "Creating default ${SITELISP}/site-start.el ..."
238     cat <<-EOF >"${T}"/site-start.el
239     ;;; site-start.el
240    
241     ;;; Commentary:
242     ;; This default site startup file is installed by elisp-common.eclass.
243     ;; You may replace this file by your own site initialisation, or even
244     ;; remove it completely; it will not be recreated.
245    
246     ;;; Code:
247     ;; Load site initialisation for Gentoo-installed packages.
248     (require 'site-gentoo)
249    
250     ;;; site-start.el ends here
251     EOF
252     fi
253    
254 ulm 1.25 einfon "Regenerating ${SITELISP}/site-gentoo.el ..."
255 ulm 1.24 cat <<-EOF >"${T}"/site-gentoo.el
256     ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
257    
258     ;;; Commentary:
259     ;; Automatically generated by elisp-common.eclass
260     ;; DO NOT EDIT THIS FILE
261    
262     ;;; Code:
263     EOF
264 mkennedy 1.1
265 opfer 1.22 for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el
266 mkennedy 1.1 do
267 ulm 1.20 [ -r "${sf}" ] || continue
268 opfer 1.22 sflist="${sflist} $(basename "${sf}")"
269     cat "${sf}" >>"${T}"/site-gentoo.el
270 mkennedy 1.1 done
271 opfer 1.22
272 ulm 1.24 cat <<-EOF >>"${T}"/site-gentoo.el
273    
274 ulm 1.28 (provide 'site-gentoo)
275    
276     ;; Local Variables:
277     ;; no-byte-compile: t
278     ;; End:
279 ulm 1.24 ;;; site-gentoo.el ends here
280     EOF
281    
282 opfer 1.22 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${T}"/site-gentoo.el; then
283     # This prevents outputting unnecessary text when there
284 ulm 1.29 # was actually no change.
285     # A case is a remerge where we have doubled output.
286 ulm 1.25 echo " no changes."
287 opfer 1.22 else
288 ulm 1.24 mv "${T}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
289 ulm 1.29 [ -f "${T}"/site-start.el ] \
290     && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \
291     && mv "${T}"/site-start.el "${ROOT}${SITELISP}"/site-start.el
292 ulm 1.25 echo; einfo
293 opfer 1.22 for sf in ${sflist}; do
294     einfo " Adding ${sf} ..."
295     done
296     while read line; do einfo "${line}"; done <<EOF
297 jbms 1.4
298 ulm 1.25 All site initialisation for Gentoo-installed packages is added to
299 jbms 1.4 /usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer
300 usata 1.8 managed by Gentoo. You are responsible for all maintenance of
301     site-start.el if there is such a file.
302 jbms 1.4
303 ulm 1.24 In order for this site initialisation to be loaded for all users
304 ulm 1.25 automatically, you can add a line like this:
305 jbms 1.4
306 ulm 1.29 (require 'site-gentoo)
307 jbms 1.4
308     to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
309 ulm 1.24 can be added by individual users to their initialisation files, or for
310 jbms 1.4 greater flexibility, users can select which of the package-specific
311 ulm 1.27 initialisation files in /usr/share/emacs/site-lisp/ to load.
312 jbms 1.4 EOF
313 opfer 1.22 echo
314     fi
315 mkennedy 1.3 }
316    
317 ulm 1.25 # @FUNCTION: elisp-comp
318     # @USAGE: <list of elisp files>
319     # @DESCRIPTION:
320     # Byte-compile interdependent Emacs Lisp files.
321 ulm 1.28 #
322     # This function byte-compiles all ".el" files which are part of its
323     # arguments, using GNU Emacs, and puts the resulting ".elc" files into the
324     # current directory, so disregarding the original directories used in ".el"
325     # arguments.
326     #
327     # This function manages in such a way that all Emacs Lisp files to be
328     # compiled are made visible between themselves, in the event they require or
329     # load one another.
330 mkennedy 1.3
331     elisp-comp() {
332 opfer 1.22 # Copyright 1995 Free Software Foundation, Inc.
333     # Fran├žois Pinard <pinard@iro.umontreal.ca>, 1995.
334 ulm 1.28 # Originally taken from GNU autotools.
335 opfer 1.22
336     test $# -gt 0 || return 1
337 mkennedy 1.3
338 opfer 1.22 if test -z "${EMACS}" || test "${EMACS}" = "t"; then
339 jbms 1.4 # Value of "t" means we are running in a shell under Emacs.
340     # Just assume Emacs is called "emacs".
341 opfer 1.22 EMACS=/usr/bin/emacs
342     fi
343     einfo "Compiling GNU Emacs Elisp files ..."
344 mkennedy 1.3
345 opfer 1.22 tempdir=elc.$$
346     mkdir ${tempdir}
347 ulm 1.28 cp "$@" ${tempdir}
348 opfer 1.22 pushd ${tempdir}
349    
350     echo "(add-to-list 'load-path \"../\")" > script
351 ulm 1.28 ${EMACS_BATCH_CLEAN} -l script -f batch-byte-compile *.el
352     local ret=$?
353 opfer 1.22 mv *.elc ..
354 mkennedy 1.3
355 opfer 1.22 popd
356     rm -fr ${tempdir}
357 ulm 1.28 return ${ret}
358 mkennedy 1.1 }

  ViewVC Help
Powered by ViewVC 1.1.20