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

Contents of /eclass/elisp-common.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.86 - (hide annotations) (download)
Wed Sep 4 19:16:40 2013 UTC (15 months, 3 weeks ago) by ulm
Branch: MAIN
Changes since 1.85: +33 -17 lines
elisp-common.eclass: Add proper @CODE tags in comments.

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

  ViewVC Help
Powered by ViewVC 1.1.20