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

Contents of /eclass/elisp-common.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.46 - (hide annotations) (download)
Fri Sep 19 08:12:48 2008 UTC (5 years, 11 months ago) by ulm
Branch: MAIN
Changes since 1.45: +10 -4 lines
Partial sync from Emacs overlay.
Output a deprecation warning in elisp-comp().

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.46 # $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.45 2008/09/01 10:45:26 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.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.43 # @ECLASS-VARIABLE: EMACS
144     # @DESCRIPTION:
145     # Path of Emacs executable.
146 ulm 1.28 EMACS=/usr/bin/emacs
147 ulm 1.43
148     # @ECLASS-VARIABLE: EMACSFLAGS
149     # @DESCRIPTION:
150     # Flags for executing Emacs in batch mode.
151     # These work for Emacs versions 18-23, so don't change them.
152 ulm 1.30 EMACSFLAGS="-batch -q --no-site-file"
153 ulm 1.25
154 ulm 1.43 # @ECLASS-VARIABLE: BYTECOMPFLAGS
155     # @DESCRIPTION:
156     # Emacs flags used for byte-compilation in elisp-compile().
157     BYTECOMPFLAGS="-L ."
158    
159 ulm 1.25 # @FUNCTION: elisp-compile
160     # @USAGE: <list of elisp files>
161     # @DESCRIPTION:
162     # Byte-compile Emacs Lisp files.
163 ulm 1.43 #
164     # This function uses GNU Emacs to byte-compile all ".el" specified by its
165     # arguments. The resulting byte-code (".elc") files are placed in the same
166     # directory as their corresponding source file.
167     #
168     # The current directory is added to the load-path. This will ensure that
169     # interdependent Emacs Lisp files are visible between themselves, in case
170     # they require or load one another.
171 mkennedy 1.1
172 mkennedy 1.2 elisp-compile() {
173 ulm 1.32 ebegin "Compiling GNU Emacs Elisp files"
174 ulm 1.43 ${EMACS} ${EMACSFLAGS} ${BYTECOMPFLAGS} -f batch-byte-compile "$@"
175 ulm 1.32 eend $? "batch-byte-compile failed"
176 ulm 1.30 }
177    
178 ulm 1.44 # #FUNCTION: elisp-comp
179     # #USAGE: <list of elisp files>
180     # #DESCRIPTION:
181 ulm 1.30 # Byte-compile interdependent Emacs Lisp files.
182 ulm 1.46 # THIS FUNCTION IS DEPRECATED.
183 ulm 1.30 #
184     # This function byte-compiles all ".el" files which are part of its
185     # arguments, using GNU Emacs, and puts the resulting ".elc" files into the
186     # current directory, so disregarding the original directories used in ".el"
187     # arguments.
188     #
189     # This function manages in such a way that all Emacs Lisp files to be
190     # compiled are made visible between themselves, in the event they require or
191     # load one another.
192    
193     elisp-comp() {
194     # Copyright 1995 Free Software Foundation, Inc.
195     # François Pinard <pinard@iro.umontreal.ca>, 1995.
196     # Originally taken from GNU autotools.
197    
198 ulm 1.46 ewarn "Function elisp-comp is deprecated and may be removed in future."
199     ewarn "Please use function elisp-compile instead, or report a bug about"
200     ewarn "${CATEGORY}/${PF} at <http://bugs.gentoo.org/>."
201     echo
202    
203 ulm 1.30 [ $# -gt 0 ] || return 1
204    
205 ulm 1.32 ebegin "Compiling GNU Emacs Elisp files"
206 ulm 1.30
207 ulm 1.45 local tempdir=elc.$$
208 ulm 1.30 mkdir ${tempdir}
209     cp "$@" ${tempdir}
210     pushd ${tempdir}
211    
212     echo "(add-to-list 'load-path \"../\")" > script
213     ${EMACS} ${EMACSFLAGS} -l script -f batch-byte-compile *.el
214     local ret=$?
215     mv *.elc ..
216    
217     popd
218     rm -fr ${tempdir}
219 ulm 1.32
220     eend ${ret} "batch-byte-compile failed"
221 ulm 1.30 return ${ret}
222 opfer 1.22 }
223    
224 ulm 1.25 # @FUNCTION: elisp-emacs-version
225     # @DESCRIPTION:
226     # Output version of currently active Emacs.
227    
228 opfer 1.22 elisp-emacs-version() {
229 ulm 1.38 # The following will work for at least versions 18-23.
230 opfer 1.22 echo "(princ emacs-version)" >"${T}"/emacs-version.el
231 ulm 1.30 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
232 ulm 1.37 rm -f "${T}"/emacs-version.el
233 mkennedy 1.2 }
234    
235 ulm 1.25 # @FUNCTION: elisp-make-autoload-file
236     # @USAGE: [output file] [list of directories]
237     # @DESCRIPTION:
238     # Generate a file with autoload definitions for the lisp functions.
239    
240 ulm 1.29 elisp-make-autoload-file() {
241 opfer 1.17 local f="${1:-${PN}-autoloads.el}"
242 opfer 1.15 shift
243 ulm 1.32 ebegin "Generating autoload file for GNU Emacs"
244 opfer 1.22
245 ulm 1.21 sed 's/^FF/\f/' >"${f}" <<-EOF
246     ;;; ${f##*/} --- autoloads for ${P}
247    
248     ;;; Commentary:
249     ;; Automatically generated by elisp-common.eclass
250     ;; DO NOT EDIT THIS FILE
251    
252     ;;; Code:
253     FF
254     ;; Local Variables:
255     ;; version-control: never
256     ;; no-byte-compile: t
257     ;; no-update-autoloads: t
258     ;; End:
259     ;;; ${f##*/} ends here
260     EOF
261 opfer 1.22
262 ulm 1.30 ${EMACS} ${EMACSFLAGS} \
263 opfer 1.15 --eval "(setq make-backup-files nil)" \
264     --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
265     -f batch-update-autoloads "${@-.}"
266 ulm 1.32
267     eend $? "batch-update-autoloads failed"
268 opfer 1.15 }
269    
270 ulm 1.25 # @FUNCTION: elisp-install
271     # @USAGE: <subdirectory> <list of files>
272     # @DESCRIPTION:
273     # Install files in SITELISP directory.
274    
275 mkennedy 1.1 elisp-install() {
276 ulm 1.28 local subdir="$1"
277     shift
278 ulm 1.32 ebegin "Installing Elisp files for GNU Emacs support"
279 ulm 1.28 ( # subshell to avoid pollution of calling environment
280     insinto "${SITELISP}/${subdir}"
281     doins "$@"
282     )
283 ulm 1.32 eend $? "doins failed"
284 mkennedy 1.1 }
285    
286 ulm 1.25 # @FUNCTION: elisp-site-file-install
287     # @USAGE: <site-init file> [subdirectory]
288     # @DESCRIPTION:
289     # Install Emacs site-init file in SITELISP directory.
290    
291 mkennedy 1.1 elisp-site-file-install() {
292 ulm 1.37 local sf="${T}/${1##*/}" my_pn="${2:-${PN}}" ret
293 ulm 1.32 ebegin "Installing site initialisation file for GNU Emacs"
294 ulm 1.37 cp "$1" "${sf}"
295 ulm 1.31 sed -i -e "s:@SITELISP@:${SITELISP}/${my_pn}:g" \
296 ulm 1.37 -e "s:@SITEETC@:${SITEETC}/${my_pn}:g" "${sf}"
297 ulm 1.28 ( # subshell to avoid pollution of calling environment
298 ulm 1.34 insinto "${SITELISP}/site-gentoo.d"
299 ulm 1.37 doins "${sf}"
300 ulm 1.28 )
301 ulm 1.37 ret=$?
302     rm -f "${sf}"
303     eend ${ret} "doins failed"
304 mkennedy 1.1 }
305    
306 ulm 1.25 # @FUNCTION: elisp-site-regen
307     # @DESCRIPTION:
308 ulm 1.34 # Regenerate site-gentoo.el file. The old location for site initialisation
309     # files of packages was /usr/share/emacs/site-lisp/. In December 2007 this
310     # has been changed to /usr/share/emacs/site-lisp/site-gentoo.d/. Remerge of
311     # packages with Emacs support is enough, the old location is still supported
312     # when generating the start-up file.
313 ulm 1.32
314 mkennedy 1.1 elisp-site-regen() {
315 ulm 1.34 local i sf line obsolete
316 ulm 1.32 local -a sflist
317 ulm 1.38 # Work around Paludis borkage: variable T is empty in pkg_postrm
318 ulm 1.39 local tmpdir=${T:-$(mktemp -d)}
319 opfer 1.22
320 ulm 1.38 if [ ! -d "${ROOT}${SITELISP}" ]; then
321     eerror "Directory ${SITELISP} does not exist"
322     return 1
323     fi
324    
325 ulm 1.29 if [ ! -e "${ROOT}${SITELISP}"/site-gentoo.el ] \
326     && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then
327     einfo "Creating default ${SITELISP}/site-start.el ..."
328 ulm 1.37 cat <<-EOF >"${tmpdir}"/site-start.el
329 ulm 1.29 ;;; site-start.el
330    
331     ;;; Commentary:
332     ;; This default site startup file is installed by elisp-common.eclass.
333     ;; You may replace this file by your own site initialisation, or even
334     ;; remove it completely; it will not be recreated.
335    
336     ;;; Code:
337     ;; Load site initialisation for Gentoo-installed packages.
338     (require 'site-gentoo)
339    
340     ;;; site-start.el ends here
341     EOF
342     fi
343    
344 ulm 1.25 einfon "Regenerating ${SITELISP}/site-gentoo.el ..."
345 ulm 1.32
346 ulm 1.41 # remove any auxiliary file (from previous run)
347 ulm 1.32 rm -f "${ROOT}${SITELISP}"/00site-gentoo.el
348    
349     # set nullglob option, there may be a directory without matching files
350     local old_shopts=$(shopt -p nullglob)
351     shopt -s nullglob
352    
353     for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el \
354     "${ROOT}${SITELISP}"/site-gentoo.d/[0-9][0-9]*.el
355     do
356     [ -r "${sf}" ] || continue
357     # sort files by their basename. straight insertion sort.
358     for ((i=${#sflist[@]}; i>0; i--)); do
359     [[ ${sf##*/} < ${sflist[i-1]##*/} ]] || break
360     sflist[i]=${sflist[i-1]}
361     done
362     sflist[i]=${sf}
363 ulm 1.34 # set a flag if there are obsolete files
364     [ "${sf%/*}" = "${ROOT}${SITELISP}" ] && obsolete=t
365 ulm 1.32 done
366    
367     eval "${old_shopts}"
368    
369 ulm 1.37 cat <<-EOF >"${tmpdir}"/site-gentoo.el
370 ulm 1.24 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
371    
372     ;;; Commentary:
373     ;; Automatically generated by elisp-common.eclass
374     ;; DO NOT EDIT THIS FILE
375    
376     ;;; Code:
377     EOF
378 ulm 1.37 cat "${sflist[@]}" </dev/null >>"${tmpdir}"/site-gentoo.el
379     cat <<-EOF >>"${tmpdir}"/site-gentoo.el
380 ulm 1.24
381 ulm 1.28 (provide 'site-gentoo)
382    
383     ;; Local Variables:
384     ;; no-byte-compile: t
385     ;; End:
386 ulm 1.24 ;;; site-gentoo.el ends here
387     EOF
388    
389 ulm 1.37 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${tmpdir}"/site-gentoo.el
390     then
391 opfer 1.22 # This prevents outputting unnecessary text when there
392 ulm 1.29 # was actually no change.
393     # A case is a remerge where we have doubled output.
394 ulm 1.25 echo " no changes."
395 opfer 1.22 else
396 ulm 1.37 mv "${tmpdir}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
397     [ -f "${tmpdir}"/site-start.el ] \
398 ulm 1.29 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \
399 ulm 1.37 && mv "${tmpdir}"/site-start.el "${ROOT}${SITELISP}"/site-start.el
400 ulm 1.46 echo
401 ulm 1.32 for sf in "${sflist[@]##*/}"; do
402 opfer 1.22 einfo " Adding ${sf} ..."
403     done
404 ulm 1.32 einfo "Regenerated ${SITELISP}/site-gentoo.el."
405    
406     echo
407 ulm 1.42 while read line; do einfo "${line:- }"; done <<-EOF
408     All site initialisation for Gentoo-installed packages is added to
409     /usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is not
410     managed by Gentoo. You are responsible for all maintenance of
411     site-start.el if there is such a file.
412    
413     In order for this site initialisation to be loaded for all users
414     automatically, you can add a line like this:
415    
416     (require 'site-gentoo)
417    
418     to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
419     can be added by individual users to their initialisation files, or,
420     for greater flexibility, users can load individual package-specific
421     initialisation files from /usr/share/emacs/site-lisp/site-gentoo.d/.
422     EOF
423 opfer 1.22 echo
424 ulm 1.41 fi
425    
426     if [ "${obsolete}" ]; then
427 ulm 1.46 echo
428 ulm 1.41 while read line; do ewarn "${line}"; done <<-EOF
429     Site-initialisation files of Emacs packages are now installed in
430     /usr/share/emacs/site-lisp/site-gentoo.d/. We strongly recommend
431 ulm 1.46 that you use app-admin/emacs-updater to rebuild the installed
432 ulm 1.41 Emacs packages.
433     EOF
434 ulm 1.35
435 ulm 1.41 # Kludge for backwards compatibility: During pkg_postrm, old versions
436     # of this eclass (saved in the VDB) won't find packages' site-init
437     # files in the new location. So we copy them to an auxiliary file
438     # that is visible to old eclass versions.
439     for sf in "${sflist[@]}"; do
440     [ "${sf%/*}" = "${ROOT}${SITELISP}/site-gentoo.d" ] \
441     && cat "${sf}" >>"${ROOT}${SITELISP}"/00site-gentoo.el
442     done
443 opfer 1.22 fi
444 ulm 1.32
445 ulm 1.37 # cleanup
446     rm -f "${tmpdir}"/site-{gentoo,start}.el
447 ulm 1.45
448     return 0
449 mkennedy 1.3 }

  ViewVC Help
Powered by ViewVC 1.1.20