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

Contents of /eclass/elisp-common.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.35 - (show annotations) (download)
Fri Feb 22 09:28:53 2008 UTC (6 years, 6 months ago) by ulm
Branch: MAIN
Changes since 1.34: +14 -14 lines
Sync eclasses from Emacs overlay (revision 967).

elisp-common.eclass:
Enable warning message about obsolete files.

1 # Copyright 1999-2007 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.34 2007/12/28 17:48:34 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-2008 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.
37 #
38 # elisp-compile *.el || die "elisp-compile failed"
39 #
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 # elisp-comp *.el || die "elisp-comp failed"
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 "elisp-install failed"
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 file is "[0-9][0-9]*-gentoo.el", where the
90 # two digits at the beginning define the loading order. So if you depend on
91 # another Emacs package, your site file's number must be higher!
92 #
93 # Best practice is to define a SITEFILE variable in the global scope of your
94 # ebuild (right after DEPEND e.g.):
95 #
96 # SITEFILE=50${PN}-gentoo.el
97 #
98 # Which is then installed by
99 #
100 # elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
101 #
102 # in src_install(). If your subdirectory is not named ${PN}, give the
103 # differing name as second argument.
104 #
105 # .SS
106 # 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 # pkg_postinst() {
112 # elisp-site-regen
113 # }
114 #
115 # pkg_postrm() {
116 # elisp-site-regen
117 # }
118 #
119 # When having optional Emacs support, you should prepend "use emacs &&" to
120 # above calls of elisp-site-regen(). Don't use "has_version virtual/emacs"!
121 # When unmerging the state of the emacs USE flag is taken from the package
122 # database and not from the environment, so it is no problem when you unset
123 # USE=emacs between merge and unmerge of a package.
124 #
125 # .SS
126 # Miscellaneous functions:
127 #
128 # elisp-emacs-version() outputs the version of the currently active Emacs.
129
130 # @ECLASS-VARIABLE: SITELISP
131 # @DESCRIPTION:
132 # Directory where packages install Emacs Lisp files.
133 SITELISP=/usr/share/emacs/site-lisp
134
135 # Directory where packages install miscellaneous (not Lisp) files.
136 SITEETC=/usr/share/emacs/etc
137
138 # @ECLASS-VARIABLE: SITEFILE
139 # @DESCRIPTION:
140 # Name of package's site-init file.
141 SITEFILE=50${PN}-gentoo.el
142
143 EMACS=/usr/bin/emacs
144 # The following works for Emacs versions 18--23, don't change it.
145 EMACSFLAGS="-batch -q --no-site-file"
146
147 # @FUNCTION: elisp-compile
148 # @USAGE: <list of elisp files>
149 # @DESCRIPTION:
150 # Byte-compile Emacs Lisp files.
151
152 elisp-compile() {
153 ebegin "Compiling GNU Emacs Elisp files"
154 ${EMACS} ${EMACSFLAGS} -f batch-byte-compile "$@"
155 eend $? "batch-byte-compile failed"
156 }
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 ebegin "Compiling GNU Emacs Elisp files"
180
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
194 eend ${ret} "batch-byte-compile failed"
195 return ${ret}
196 }
197
198 # @FUNCTION: elisp-emacs-version
199 # @DESCRIPTION:
200 # Output version of currently active Emacs.
201
202 elisp-emacs-version() {
203 # The following will work for at least versions 18--23.
204 echo "(princ emacs-version)" >"${T}"/emacs-version.el
205 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
206 }
207
208 # @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 elisp-make-autoload-file() {
214 local f="${1:-${PN}-autoloads.el}"
215 shift
216 ebegin "Generating autoload file for GNU Emacs"
217
218 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
235 ${EMACS} ${EMACSFLAGS} \
236 --eval "(setq make-backup-files nil)" \
237 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
238 -f batch-update-autoloads "${@-.}"
239
240 eend $? "batch-update-autoloads failed"
241 }
242
243 # @FUNCTION: elisp-install
244 # @USAGE: <subdirectory> <list of files>
245 # @DESCRIPTION:
246 # Install files in SITELISP directory.
247
248 elisp-install() {
249 local subdir="$1"
250 shift
251 ebegin "Installing Elisp files for GNU Emacs support"
252 ( # subshell to avoid pollution of calling environment
253 insinto "${SITELISP}/${subdir}"
254 doins "$@"
255 )
256 eend $? "doins failed"
257 }
258
259 # @FUNCTION: elisp-site-file-install
260 # @USAGE: <site-init file> [subdirectory]
261 # @DESCRIPTION:
262 # Install Emacs site-init file in SITELISP directory.
263
264 elisp-site-file-install() {
265 local sf="${1##*/}" my_pn="${2:-${PN}}"
266 ebegin "Installing site initialisation file for GNU Emacs"
267 cp "$1" "${T}/${sf}"
268 sed -i -e "s:@SITELISP@:${SITELISP}/${my_pn}:g" \
269 -e "s:@SITEETC@:${SITEETC}/${my_pn}:g" "${T}/${sf}"
270 ( # subshell to avoid pollution of calling environment
271 insinto "${SITELISP}/site-gentoo.d"
272 doins "${T}/${sf}"
273 )
274 eend $? "doins failed"
275 }
276
277 # @FUNCTION: elisp-site-regen
278 # @DESCRIPTION:
279 # Regenerate site-gentoo.el file. The old location for site initialisation
280 # files of packages was /usr/share/emacs/site-lisp/. In December 2007 this
281 # has been changed to /usr/share/emacs/site-lisp/site-gentoo.d/. Remerge of
282 # packages with Emacs support is enough, the old location is still supported
283 # when generating the start-up file.
284
285 elisp-site-regen() {
286 local i sf line obsolete
287 local -a sflist
288
289 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 einfon "Regenerating ${SITELISP}/site-gentoo.el ..."
309
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 # set a flag if there are obsolete files
328 [ "${sf%/*}" = "${ROOT}${SITELISP}" ] && obsolete=t
329 done
330
331 eval "${old_shopts}"
332
333 cat <<-EOF >"${T}"/site-gentoo.el
334 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
335
336 ;;; Commentary:
337 ;; Automatically generated by elisp-common.eclass
338 ;; DO NOT EDIT THIS FILE
339
340 ;;; Code:
341 EOF
342 cat "${sflist[@]}" </dev/null >>"${T}"/site-gentoo.el
343 cat <<-EOF >>"${T}"/site-gentoo.el
344
345 (provide 'site-gentoo)
346
347 ;; Local Variables:
348 ;; no-byte-compile: t
349 ;; End:
350 ;;; site-gentoo.el ends here
351 EOF
352
353 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${T}"/site-gentoo.el; then
354 # This prevents outputting unnecessary text when there
355 # was actually no change.
356 # A case is a remerge where we have doubled output.
357 echo " no changes."
358 else
359 mv "${T}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
360 [ -f "${T}"/site-start.el ] \
361 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \
362 && mv "${T}"/site-start.el "${ROOT}${SITELISP}"/site-start.el
363 echo; einfo
364 for sf in "${sflist[@]##*/}"; do
365 einfo " Adding ${sf} ..."
366 done
367 einfo "Regenerated ${SITELISP}/site-gentoo.el."
368
369 echo
370 while read line; do einfo "${line}"; done <<EOF
371 All site initialisation for Gentoo-installed packages is added to
372 /usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer
373 managed by Gentoo. You are responsible for all maintenance of
374 site-start.el if there is such a file.
375
376 In order for this site initialisation to be loaded for all users
377 automatically, you can add a line like this:
378
379 (require 'site-gentoo)
380
381 to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
382 can be added by individual users to their initialisation files, or,
383 for greater flexibility, users can load individual package-specific
384 initialisation files from /usr/share/emacs/site-lisp/site-gentoo.d/.
385 EOF
386 echo
387
388 if [ "${obsolete}" ]; then
389 while read line; do ewarn "${line}"; done <<-EOF
390 Site-initialisation files of Emacs packages are now installed in
391 /usr/share/emacs/site-lisp/site-gentoo.d/. You may consider using
392 /usr/sbin/emacs-updater to rebuild the installed Emacs packages.
393 However, the old location is still supported.
394 EOF
395 echo
396 fi
397 fi
398
399 # Kludge for backwards compatibility: During pkg_postrm, old versions
400 # of this eclass (saved in the VDB) won't find packages' site-init files
401 # in the new location. So we copy them to an auxiliary file that is
402 # visible to old eclass versions.
403 for sf in "${sflist[@]}"; do
404 [ "${sf%/*}" = "${ROOT}${SITELISP}/site-gentoo.d" ] \
405 && cat "${sf}" >>"${ROOT}${SITELISP}"/00site-gentoo.el
406 done
407 }

  ViewVC Help
Powered by ViewVC 1.1.20