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

Contents of /eclass/elisp-common.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.72 - (hide annotations) (download)
Sat Aug 13 12:19:39 2011 UTC (3 years, 2 months ago) by ulm
Branch: MAIN
Changes since 1.71: +9 -3 lines
Sync elisp-common.eclass from Emacs overlay (revision 1670):
Error handling in function elisp-emacs-version.

1 ulm 1.71 # Copyright 1999-2011 Gentoo Foundation
2 mkennedy 1.1 # Distributed under the terms of the GNU General Public License v2
3 ulm 1.72 # $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.71 2011/02/19 10:12:42 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.56 # Copyright 2007-2008 Christian Faulhammer <fauli@gentoo.org>
9 ulm 1.71 # Copyright 2007-2011 Ulrich Müller <ulm@gentoo.org>
10 mkennedy 1.1 #
11 ulm 1.25 # @ECLASS: elisp-common.eclass
12     # @MAINTAINER:
13 ulm 1.58 # Feel free to contact the Emacs team through <emacs@gentoo.org> if you
14     # have problems, suggestions or questions.
15 ulm 1.25 # @BLURB: Emacs-related installation utilities
16     # @DESCRIPTION:
17 opfer 1.15 #
18 ulm 1.58 # Usually you want to use this eclass for (optional) GNU Emacs support
19     # of 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 ulm 1.58 # package (especially compilation), so this is mainly for standalone
23     # elisp 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 ulm 1.58 # to your DEPEND/RDEPEND line and use the functions provided here to
30     # bring the files to the correct locations.
31 opfer 1.15 #
32 ulm 1.69 # If your package requires a minimum Emacs version, e.g. Emacs 23, then
33     # the dependency should be on >=virtual/emacs-23 instead. Because the
34     # user can select the Emacs executable with eselect, you should also
35     # make sure that the active Emacs version is sufficient. This can be
36     # tested with function elisp-need-emacs(), which would typically be
37     # called from pkg_setup(), as in the following example:
38     #
39     # elisp-need-emacs 23 || die "Emacs version too low"
40     #
41     # Please note that such tests should be limited to packages that are
42     # known to fail with lower Emacs versions; the standard case is to
43     # depend on virtual/emacs without version.
44     #
45 ulm 1.25 # .SS
46 opfer 1.15 # src_compile() usage:
47     #
48 ulm 1.58 # An elisp file is compiled by the elisp-compile() function defined
49     # here and simply takes the source files as arguments. The case of
50     # interdependent elisp files is also supported, since the current
51     # directory is added to the load-path which makes sure that all files
52     # are loadable.
53 opfer 1.15 #
54 ulm 1.50 # elisp-compile *.el || die
55 ulm 1.25 #
56 ulm 1.58 # Function elisp-make-autoload-file() can be used to generate a file
57     # with autoload definitions for the lisp functions. It takes the output
58     # file name (default: "${PN}-autoloads.el") and a list of directories
59     # (default: working directory) as its arguments. Use of this function
60     # requires that the elisp source files contain magic ";;;###autoload"
61     # comments. See the Emacs Lisp Reference Manual (node "Autoload") for
62     # a detailed explanation.
63 opfer 1.15 #
64 ulm 1.25 # .SS
65 opfer 1.15 # src_install() usage:
66     #
67     # The resulting compiled files (.elc) should be put in a subdirectory of
68     # /usr/share/emacs/site-lisp/ which is named after the first argument
69 ulm 1.58 # of elisp-install(). The following parameters are the files to be put
70     # in that directory. Usually the subdirectory should be ${PN}, you can
71     # choose something else, but remember to tell elisp-site-file-install()
72     # (see below) the change, as it defaults to ${PN}.
73 opfer 1.15 #
74 ulm 1.50 # elisp-install ${PN} *.el *.elc || die
75 opfer 1.15 #
76 ulm 1.25 # To let the Emacs support be activated by Emacs on startup, you need
77 ulm 1.58 # to provide a site file (shipped in ${FILESDIR}) which contains the
78     # startup code (have a look in the documentation of your software).
79     # Normally this would look like this:
80 opfer 1.15 #
81 ulm 1.26 # (add-to-list 'load-path "@SITELISP@")
82     # (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode))
83     # (autoload 'csv-mode "csv-mode" "Major mode for csv files." t)
84 opfer 1.15 #
85 ulm 1.25 # If your Emacs support files are installed in a subdirectory of
86 ulm 1.58 # /usr/share/emacs/site-lisp/ (which is strongly recommended), you need
87     # to extend Emacs' load-path as shown in the first non-comment line.
88 ulm 1.29 # The elisp-site-file-install() function of this eclass will replace
89 ulm 1.58 # "@SITELISP@" and "@SITEETC@" by the actual paths.
90 ulm 1.25 #
91 ulm 1.58 # The next line tells Emacs to load the mode opening a file ending
92     # with ".csv" and load functions depending on the context and needed
93     # features. Be careful though. Commands as "load-library" or "require"
94     # bloat the editor as they are loaded on every startup. When having
95     # many Emacs support files, users may be annoyed by the start-up time.
96     # Also avoid keybindings as they might interfere with the user's
97     # settings. Give a hint in pkg_postinst(), which should be enough.
98 ulm 1.25 #
99 ulm 1.50 # The naming scheme for this site-init file matches the shell pattern
100 ulm 1.59 # "[1-8][0-9]*-gentoo*.el", where the two digits at the beginning define
101 ulm 1.58 # the loading order (numbers below 10 or above 89 are reserved for
102     # internal use). So if your initialisation depends on another Emacs
103 ulm 1.68 # package, your site file's number must be higher! If there are no such
104     # interdependencies then the number should be 50. Otherwise, numbers
105     # divisible by 10 are preferred.
106 ulm 1.25 #
107 ulm 1.58 # Best practice is to define a SITEFILE variable in the global scope of
108     # your ebuild (e.g., right after S or RDEPEND):
109 opfer 1.15 #
110 ulm 1.58 # SITEFILE="50${PN}-gentoo.el"
111 opfer 1.15 #
112 ulm 1.25 # Which is then installed by
113 opfer 1.15 #
114 ulm 1.29 # elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
115 opfer 1.15 #
116 ulm 1.59 # in src_install(). Any characters after the "-gentoo" part and before
117     # the extension will be stripped from the destination file's name.
118     # For example, a file "50${PN}-gentoo-${PV}.el" will be installed as
119     # "50${PN}-gentoo.el". If your subdirectory is not named ${PN}, give
120     # the differing name as second argument.
121 opfer 1.15 #
122 ulm 1.25 # .SS
123 opfer 1.15 # pkg_postinst() / pkg_postrm() usage:
124     #
125 ulm 1.58 # After that you need to recreate the start-up file of Emacs after
126     # emerging and unmerging by using
127 opfer 1.15 #
128 ulm 1.26 # pkg_postinst() {
129     # elisp-site-regen
130     # }
131     #
132     # pkg_postrm() {
133     # elisp-site-regen
134     # }
135 opfer 1.15 #
136 ulm 1.58 # When having optional Emacs support, you should prepend "use emacs &&"
137     # to above calls of elisp-site-regen().
138     # Don't use "has_version virtual/emacs"! When unmerging the state of
139     # the emacs USE flag is taken from the package database and not from the
140     # environment, so it is no problem when you unset USE=emacs between
141     # merge and unmerge of a package.
142 mkennedy 1.1
143 ulm 1.29 # @ECLASS-VARIABLE: SITELISP
144     # @DESCRIPTION:
145 ulm 1.31 # Directory where packages install Emacs Lisp files.
146 mkennedy 1.1 SITELISP=/usr/share/emacs/site-lisp
147 ulm 1.29
148 ulm 1.48 # @ECLASS-VARIABLE: SITEETC
149     # @DESCRIPTION:
150 ulm 1.31 # Directory where packages install miscellaneous (not Lisp) files.
151     SITEETC=/usr/share/emacs/etc
152    
153 ulm 1.43 # @ECLASS-VARIABLE: EMACS
154     # @DESCRIPTION:
155     # Path of Emacs executable.
156 ulm 1.64 EMACS=${EPREFIX}/usr/bin/emacs
157 ulm 1.43
158     # @ECLASS-VARIABLE: EMACSFLAGS
159     # @DESCRIPTION:
160     # Flags for executing Emacs in batch mode.
161     # These work for Emacs versions 18-23, so don't change them.
162 ulm 1.30 EMACSFLAGS="-batch -q --no-site-file"
163 ulm 1.25
164 ulm 1.43 # @ECLASS-VARIABLE: BYTECOMPFLAGS
165     # @DESCRIPTION:
166     # Emacs flags used for byte-compilation in elisp-compile().
167     BYTECOMPFLAGS="-L ."
168    
169 ulm 1.25 # @FUNCTION: elisp-emacs-version
170     # @DESCRIPTION:
171     # Output version of currently active Emacs.
172    
173 opfer 1.22 elisp-emacs-version() {
174 ulm 1.72 local ret
175 ulm 1.38 # The following will work for at least versions 18-23.
176 opfer 1.22 echo "(princ emacs-version)" >"${T}"/emacs-version.el
177 ulm 1.30 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
178 ulm 1.72 ret=$?
179 ulm 1.37 rm -f "${T}"/emacs-version.el
180 ulm 1.72 if [[ ${ret} -ne 0 ]]; then
181     eerror "elisp-emacs-version: Failed to run ${EMACS}"
182     fi
183     return ${ret}
184 mkennedy 1.2 }
185    
186 ulm 1.69 # @FUNCTION: elisp-need-emacs
187     # @USAGE: <version>
188     # @RETURN: 0 if true, 1 otherwise
189     # @DESCRIPTION:
190     # Test if the eselected Emacs version is at least the major version
191     # specified as argument.
192    
193     elisp-need-emacs() {
194 ulm 1.72 local need_emacs=$1 have_emacs
195     have_emacs=$(elisp-emacs-version) || return
196 ulm 1.69 einfo "Emacs version: ${have_emacs}"
197     if ! [[ ${have_emacs%%.*} -ge ${need_emacs%%.*} ]]; then
198     eerror "This package needs at least Emacs ${need_emacs%%.*}."
199     eerror "Use \"eselect emacs\" to select the active version."
200     return 1
201     fi
202     return 0
203     }
204    
205 ulm 1.70 # @FUNCTION: elisp-compile
206     # @USAGE: <list of elisp files>
207     # @DESCRIPTION:
208     # Byte-compile Emacs Lisp files.
209     #
210     # This function uses GNU Emacs to byte-compile all ".el" specified by
211     # its arguments. The resulting byte-code (".elc") files are placed in
212     # the same directory as their corresponding source file.
213     #
214     # The current directory is added to the load-path. This will ensure
215     # that interdependent Emacs Lisp files are visible between themselves,
216     # in case they require or load one another.
217    
218     elisp-compile() {
219     ebegin "Compiling GNU Emacs Elisp files"
220     ${EMACS} ${EMACSFLAGS} ${BYTECOMPFLAGS} -f batch-byte-compile "$@"
221     eend $? "elisp-compile: batch-byte-compile failed"
222     }
223    
224 ulm 1.25 # @FUNCTION: elisp-make-autoload-file
225     # @USAGE: [output file] [list of directories]
226     # @DESCRIPTION:
227     # Generate a file with autoload definitions for the lisp functions.
228    
229 ulm 1.29 elisp-make-autoload-file() {
230 ulm 1.62 local f="${1:-${PN}-autoloads.el}" null="" page=$'\f'
231 opfer 1.15 shift
232 ulm 1.32 ebegin "Generating autoload file for GNU Emacs"
233 opfer 1.22
234 ulm 1.62 cat >"${f}" <<-EOF
235 ulm 1.67 ;;; ${f##*/} --- autoloads for ${PN}
236 ulm 1.21
237     ;;; Commentary:
238     ;; Automatically generated by elisp-common.eclass
239     ;; DO NOT EDIT THIS FILE
240    
241     ;;; Code:
242 ulm 1.62 ${page}
243     ;; Local ${null}Variables:
244 ulm 1.21 ;; version-control: never
245     ;; no-byte-compile: t
246     ;; no-update-autoloads: t
247     ;; End:
248 ulm 1.62
249 ulm 1.21 ;;; ${f##*/} ends here
250     EOF
251 opfer 1.22
252 ulm 1.30 ${EMACS} ${EMACSFLAGS} \
253 opfer 1.15 --eval "(setq make-backup-files nil)" \
254     --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
255     -f batch-update-autoloads "${@-.}"
256 ulm 1.32
257 ulm 1.49 eend $? "elisp-make-autoload-file: batch-update-autoloads failed"
258 opfer 1.15 }
259    
260 ulm 1.25 # @FUNCTION: elisp-install
261     # @USAGE: <subdirectory> <list of files>
262     # @DESCRIPTION:
263     # Install files in SITELISP directory.
264    
265 mkennedy 1.1 elisp-install() {
266 ulm 1.28 local subdir="$1"
267     shift
268 ulm 1.32 ebegin "Installing Elisp files for GNU Emacs support"
269 ulm 1.28 ( # subshell to avoid pollution of calling environment
270     insinto "${SITELISP}/${subdir}"
271     doins "$@"
272     )
273 ulm 1.49 eend $? "elisp-install: doins failed"
274 mkennedy 1.1 }
275    
276 ulm 1.25 # @FUNCTION: elisp-site-file-install
277     # @USAGE: <site-init file> [subdirectory]
278     # @DESCRIPTION:
279 ulm 1.59 # Install Emacs site-init file in SITELISP directory. Automatically
280     # inserts a standard comment header with the name of the package (unless
281     # it is already present). Tokens @SITELISP@ and @SITEETC@ are replaced
282     # by the path to the package's subdirectory in SITELISP and SITEETC,
283     # respectively.
284 ulm 1.25
285 mkennedy 1.1 elisp-site-file-install() {
286 ulm 1.59 local sf="${1##*/}" my_pn="${2:-${PN}}" ret
287     local header=";;; ${PN} site-lisp configuration"
288    
289     [[ ${sf} == [0-9][0-9]*-gentoo*.el ]] \
290     || ewarn "elisp-site-file-install: bad name of site-init file"
291     sf="${T}/${sf/%-gentoo*.el/-gentoo.el}"
292 ulm 1.32 ebegin "Installing site initialisation file for GNU Emacs"
293 ulm 1.71 [[ $1 = "${sf}" ]] || cp "$1" "${sf}"
294 ulm 1.59 sed -i -e "1{:x;/^\$/{n;bx;};/^;.*${PN}/I!s:^:${header}\n\n:;1s:^:\n:;}" \
295 ulm 1.64 -e "s:@SITELISP@:${EPREFIX}${SITELISP}/${my_pn}:g" \
296     -e "s:@SITEETC@:${EPREFIX}${SITEETC}/${my_pn}:g;\$q" "${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 ulm 1.49 eend ${ret} "elisp-site-file-install: doins failed"
304 mkennedy 1.1 }
305    
306 ulm 1.25 # @FUNCTION: elisp-site-regen
307     # @DESCRIPTION:
308 ulm 1.58 # Regenerate the site-gentoo.el file, based on packages' site
309     # initialisation files in the /usr/share/emacs/site-lisp/site-gentoo.d/
310     # directory.
311     #
312     # Note: Before December 2007, site initialisation files were installed
313     # in /usr/share/emacs/site-lisp/. For backwards compatibility, this
314     # location is still supported when generating site-gentoo.el.
315 ulm 1.32
316 mkennedy 1.1 elisp-site-regen() {
317 ulm 1.64 local sitelisp=${ROOT}${EPREFIX}${SITELISP}
318 ulm 1.65 local sf i line null="" page=$'\f'
319 ulm 1.32 local -a sflist
320 opfer 1.22
321 ulm 1.64 if [ ! -d "${sitelisp}" ]; then
322     eerror "elisp-site-regen: Directory ${sitelisp} does not exist"
323 ulm 1.38 return 1
324     fi
325    
326 ulm 1.55 if [ ! -d "${T}" ]; then
327     eerror "elisp-site-regen: Temporary directory ${T} does not exist"
328     return 1
329     fi
330    
331 ulm 1.60 einfon "Regenerating site-gentoo.el for GNU Emacs (${EBUILD_PHASE}) ..."
332 ulm 1.32
333 ulm 1.58 # Until January 2009, elisp-common.eclass sometimes created an
334     # auxiliary file for backwards compatibility. Remove any such file.
335 ulm 1.64 rm -f "${sitelisp}"/00site-gentoo.el
336 ulm 1.32
337 ulm 1.64 for sf in "${sitelisp}"/[0-9][0-9]*-gentoo.el \
338     "${sitelisp}"/site-gentoo.d/[0-9][0-9]*.el
339 ulm 1.32 do
340     [ -r "${sf}" ] || continue
341     # sort files by their basename. straight insertion sort.
342     for ((i=${#sflist[@]}; i>0; i--)); do
343     [[ ${sf##*/} < ${sflist[i-1]##*/} ]] || break
344     sflist[i]=${sflist[i-1]}
345     done
346     sflist[i]=${sf}
347     done
348    
349 ulm 1.55 cat <<-EOF >"${T}"/site-gentoo.el
350 ulm 1.24 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
351    
352     ;;; Commentary:
353     ;; Automatically generated by elisp-common.eclass
354     ;; DO NOT EDIT THIS FILE
355    
356     ;;; Code:
357     EOF
358 ulm 1.50 # Use sed instead of cat here, since files may miss a trailing newline.
359 ulm 1.55 sed '$q' "${sflist[@]}" </dev/null >>"${T}"/site-gentoo.el
360     cat <<-EOF >>"${T}"/site-gentoo.el
361 ulm 1.24
362 ulm 1.70 ${page}
363 ulm 1.28 (provide 'site-gentoo)
364    
365 ulm 1.62 ;; Local ${null}Variables:
366 ulm 1.28 ;; no-byte-compile: t
367 ulm 1.62 ;; buffer-read-only: t
368 ulm 1.28 ;; End:
369 ulm 1.62
370 ulm 1.24 ;;; site-gentoo.el ends here
371     EOF
372    
373 ulm 1.64 if cmp -s "${sitelisp}"/site-gentoo.el "${T}"/site-gentoo.el; then
374 opfer 1.22 # This prevents outputting unnecessary text when there
375 ulm 1.29 # was actually no change.
376     # A case is a remerge where we have doubled output.
377 ulm 1.66 rm -f "${T}"/site-gentoo.el
378 ulm 1.25 echo " no changes."
379 opfer 1.22 else
380 ulm 1.64 mv "${T}"/site-gentoo.el "${sitelisp}"/site-gentoo.el
381 ulm 1.46 echo
382 ulm 1.63 case ${#sflist[@]} in
383     0) ewarn "... Huh? No site initialisation files found." ;;
384     1) einfo "... ${#sflist[@]} site initialisation file included." ;;
385     *) einfo "... ${#sflist[@]} site initialisation files included." ;;
386     esac
387 ulm 1.47 fi
388 ulm 1.32
389 ulm 1.45 return 0
390 mkennedy 1.3 }

  ViewVC Help
Powered by ViewVC 1.1.20