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

Contents of /eclass/elisp-common.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.58 - (show annotations) (download)
Thu Mar 26 14:14:22 2009 UTC (5 years, 5 months ago) by ulm
Branch: MAIN
Changes since 1.57: +70 -109 lines
Partial sync from Emacs overlay.

elisp.class:
In the "simple elisp" case, explicitly assign S=${WORKDIR} in
elisp_src_unpack.

elisp-common.eclass:
Remove function elisp-comp; it is not used by anything in the tree.
Reindent documentation to 72 columns for better readability.

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.57 2009/03/12 14:10:48 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 <fauli@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
14 # have 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
19 # of 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
23 # elisp 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
30 # bring 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
36 # here and simply takes the source files as arguments. The case of
37 # interdependent elisp files is also supported, since the current
38 # directory is added to the load-path which makes sure that all files
39 # are loadable.
40 #
41 # elisp-compile *.el || die
42 #
43 # Function elisp-make-autoload-file() can be used to generate a file
44 # with autoload definitions for the lisp functions. It takes the output
45 # file name (default: "${PN}-autoloads.el") and a list of directories
46 # (default: working directory) as its arguments. Use of this function
47 # requires that the elisp source files contain magic ";;;###autoload"
48 # comments. See the Emacs Lisp Reference Manual (node "Autoload") for
49 # a detailed explanation.
50 #
51 # .SS
52 # src_install() usage:
53 #
54 # The resulting compiled files (.elc) should be put in a subdirectory of
55 # /usr/share/emacs/site-lisp/ which is named after the first argument
56 # of elisp-install(). The following parameters are the files to be put
57 # in that directory. Usually the subdirectory should be ${PN}, you can
58 # choose something else, but remember to tell elisp-site-file-install()
59 # (see below) the change, as it defaults to ${PN}.
60 #
61 # elisp-install ${PN} *.el *.elc || die
62 #
63 # To let the Emacs support be activated by Emacs on startup, you need
64 # to provide a site file (shipped in ${FILESDIR}) which contains the
65 # startup code (have a look in the documentation of your software).
66 # Normally this would look like this:
67 #
68 # ;;; csv-mode site-lisp configuration
69 #
70 # (add-to-list 'load-path "@SITELISP@")
71 # (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode))
72 # (autoload 'csv-mode "csv-mode" "Major mode for csv files." t)
73 #
74 # If your Emacs support files are installed in a subdirectory of
75 # /usr/share/emacs/site-lisp/ (which is strongly recommended), you need
76 # to extend Emacs' load-path as shown in the first non-comment line.
77 # The elisp-site-file-install() function of this eclass will replace
78 # "@SITELISP@" and "@SITEETC@" by the actual paths.
79 #
80 # The next line tells Emacs to load the mode opening a file ending
81 # with ".csv" and load functions depending on the context and needed
82 # features. Be careful though. Commands as "load-library" or "require"
83 # bloat the editor as they are loaded on every startup. When having
84 # many Emacs support files, users may be annoyed by the start-up time.
85 # Also avoid keybindings as they might interfere with the user's
86 # settings. Give a hint in pkg_postinst(), which should be enough.
87 #
88 # The naming scheme for this site-init file matches the shell pattern
89 # "[1-8][0-9]*-gentoo.el", where the two digits at the beginning define
90 # the loading order (numbers below 10 or above 89 are reserved for
91 # internal use). So if your initialisation depends on another Emacs
92 # package, your site file's number must be higher!
93 #
94 # Best practice is to define a SITEFILE variable in the global scope of
95 # your ebuild (e.g., right after S or RDEPEND):
96 #
97 # SITEFILE="50${PN}-gentoo.el"
98 #
99 # Which is then installed by
100 #
101 # elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
102 #
103 # in src_install(). If your subdirectory is not named ${PN}, give the
104 # differing name as second argument.
105 #
106 # .SS
107 # pkg_postinst() / pkg_postrm() usage:
108 #
109 # After that you need to recreate the start-up file of Emacs after
110 # emerging and unmerging by using
111 #
112 # pkg_postinst() {
113 # elisp-site-regen
114 # }
115 #
116 # pkg_postrm() {
117 # elisp-site-regen
118 # }
119 #
120 # When having optional Emacs support, you should prepend "use emacs &&"
121 # to above calls of elisp-site-regen().
122 # Don't use "has_version virtual/emacs"! When unmerging the state of
123 # the emacs USE flag is taken from the package database and not from the
124 # environment, so it is no problem when you unset USE=emacs between
125 # 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
164 # its arguments. The resulting byte-code (".elc") files are placed in
165 # the same directory as their corresponding source file.
166 #
167 # The current directory is added to the load-path. This will ensure
168 # that interdependent Emacs Lisp files are visible between themselves,
169 # in case 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 elisp-comp() {
178 die "Function elisp-comp is not supported any more, see bug 235442"
179 }
180
181 # @FUNCTION: elisp-emacs-version
182 # @DESCRIPTION:
183 # Output version of currently active Emacs.
184
185 elisp-emacs-version() {
186 # The following will work for at least versions 18-23.
187 echo "(princ emacs-version)" >"${T}"/emacs-version.el
188 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
189 rm -f "${T}"/emacs-version.el
190 }
191
192 # @FUNCTION: elisp-make-autoload-file
193 # @USAGE: [output file] [list of directories]
194 # @DESCRIPTION:
195 # Generate a file with autoload definitions for the lisp functions.
196
197 elisp-make-autoload-file() {
198 local f="${1:-${PN}-autoloads.el}"
199 shift
200 ebegin "Generating autoload file for GNU Emacs"
201
202 sed 's/^FF/\f/' >"${f}" <<-EOF
203 ;;; ${f##*/} --- autoloads for ${P}
204
205 ;;; Commentary:
206 ;; Automatically generated by elisp-common.eclass
207 ;; DO NOT EDIT THIS FILE
208
209 ;;; Code:
210 FF
211 ;; Local Variables:
212 ;; version-control: never
213 ;; no-byte-compile: t
214 ;; no-update-autoloads: t
215 ;; End:
216 ;;; ${f##*/} ends here
217 EOF
218
219 ${EMACS} ${EMACSFLAGS} \
220 --eval "(setq make-backup-files nil)" \
221 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
222 -f batch-update-autoloads "${@-.}"
223
224 eend $? "elisp-make-autoload-file: batch-update-autoloads failed"
225 }
226
227 # @FUNCTION: elisp-install
228 # @USAGE: <subdirectory> <list of files>
229 # @DESCRIPTION:
230 # Install files in SITELISP directory.
231
232 elisp-install() {
233 local subdir="$1"
234 shift
235 ebegin "Installing Elisp files for GNU Emacs support"
236 ( # subshell to avoid pollution of calling environment
237 insinto "${SITELISP}/${subdir}"
238 doins "$@"
239 )
240 eend $? "elisp-install: doins failed"
241 }
242
243 # @FUNCTION: elisp-site-file-install
244 # @USAGE: <site-init file> [subdirectory]
245 # @DESCRIPTION:
246 # Install Emacs site-init file in SITELISP directory.
247
248 elisp-site-file-install() {
249 local sf="${T}/${1##*/}" my_pn="${2:-${PN}}" ret
250 ebegin "Installing site initialisation file for GNU Emacs"
251 cp "$1" "${sf}"
252 sed -i -e "s:@SITELISP@:${SITELISP}/${my_pn}:g" \
253 -e "s:@SITEETC@:${SITEETC}/${my_pn}:g;\$q" "${sf}"
254 ( # subshell to avoid pollution of calling environment
255 insinto "${SITELISP}/site-gentoo.d"
256 doins "${sf}"
257 )
258 ret=$?
259 rm -f "${sf}"
260 eend ${ret} "elisp-site-file-install: doins failed"
261 }
262
263 # @FUNCTION: elisp-site-regen
264 # @DESCRIPTION:
265 # Regenerate the site-gentoo.el file, based on packages' site
266 # initialisation files in the /usr/share/emacs/site-lisp/site-gentoo.d/
267 # directory.
268 #
269 # Note: Before December 2007, site initialisation files were installed
270 # in /usr/share/emacs/site-lisp/. For backwards compatibility, this
271 # location is still supported when generating site-gentoo.el.
272
273 elisp-site-regen() {
274 local i sf line firstrun obsolete
275 local -a sflist
276
277 if [ ! -d "${ROOT}${SITELISP}" ]; then
278 eerror "elisp-site-regen: Directory ${SITELISP} does not exist"
279 return 1
280 fi
281
282 if [ ! -d "${T}" ]; then
283 eerror "elisp-site-regen: Temporary directory ${T} does not exist"
284 return 1
285 fi
286
287 [ -e "${ROOT}${SITELISP}"/site-gentoo.el ] \
288 || [ "${PN}" = emacs-common-gentoo ] || firstrun=t
289
290 if [ "${firstrun}" ] && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then
291 einfo "Creating default 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 einfon "Regenerating site-gentoo.el (${EBUILD_PHASE}) ..."
309
310 # Until January 2009, elisp-common.eclass sometimes created an
311 # auxiliary file for backwards compatibility. Remove any such file.
312 rm -f "${ROOT}${SITELISP}"/00site-gentoo.el
313
314 # set nullglob option, there may be a directory without matching files
315 local old_shopts=$(shopt -p nullglob)
316 shopt -s nullglob
317
318 for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el \
319 "${ROOT}${SITELISP}"/site-gentoo.d/[0-9][0-9]*.el
320 do
321 [ -r "${sf}" ] || continue
322 # sort files by their basename. straight insertion sort.
323 for ((i=${#sflist[@]}; i>0; i--)); do
324 [[ ${sf##*/} < ${sflist[i-1]##*/} ]] || break
325 sflist[i]=${sflist[i-1]}
326 done
327 sflist[i]=${sf}
328 # set a flag if there are obsolete files
329 [ "${sf%/*}" = "${ROOT}${SITELISP}" ] && obsolete=t
330 done
331
332 eval "${old_shopts}"
333
334 cat <<-EOF >"${T}"/site-gentoo.el
335 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
336
337 ;;; Commentary:
338 ;; Automatically generated by elisp-common.eclass
339 ;; DO NOT EDIT THIS FILE
340
341 ;;; Code:
342 EOF
343 # Use sed instead of cat here, since files may miss a trailing newline.
344 sed '$q' "${sflist[@]}" </dev/null >>"${T}"/site-gentoo.el
345 cat <<-EOF >>"${T}"/site-gentoo.el
346
347 (provide 'site-gentoo)
348
349 ;; Local Variables:
350 ;; no-byte-compile: t
351 ;; End:
352 ;;; site-gentoo.el ends here
353 EOF
354
355 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${T}"/site-gentoo.el
356 then
357 # This prevents outputting unnecessary text when there
358 # was actually no change.
359 # A case is a remerge where we have doubled output.
360 echo " no changes."
361 else
362 mv "${T}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
363 [ -f "${T}"/site-start.el ] \
364 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \
365 && mv "${T}"/site-start.el "${ROOT}${SITELISP}"/site-start.el
366 echo
367 einfo "... ${#sflist[@]} site initialisation file(s) included."
368 fi
369
370 if [ "${firstrun}" ]; then
371 echo
372 while read line; do einfo "${line:- }"; done <<-EOF
373 All site initialisation for Gentoo-installed packages is added to
374 /usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is not
375 managed by Gentoo. You are responsible for all maintenance of
376 site-start.el if there is such a file.
377
378 In order for this site initialisation to be loaded for all users
379 automatically, you can add a line like this:
380
381 (require 'site-gentoo)
382
383 to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
384 can be added by individual users to their initialisation files, or,
385 for greater flexibility, users can load individual package-specific
386 initialisation files from /usr/share/emacs/site-lisp/site-gentoo.d/.
387 EOF
388 echo
389 fi
390
391 if [ "${obsolete}" ]; then
392 echo
393 while read line; do ewarn "${line}"; done <<-EOF
394 Site-initialisation files of Emacs packages are now installed in
395 /usr/share/emacs/site-lisp/site-gentoo.d/. We strongly recommend
396 that you use app-admin/emacs-updater to rebuild the installed
397 Emacs packages.
398 EOF
399 fi
400
401 # cleanup
402 rm -f "${T}"/site-{gentoo,start}.el
403
404 return 0
405 }

  ViewVC Help
Powered by ViewVC 1.1.20