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

Contents of /eclass/elisp-common.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.85 - (hide annotations) (download)
Fri Aug 2 16:48:18 2013 UTC (11 months, 1 week ago) by ulm
Branch: MAIN
Changes since 1.84: +16 -4 lines
Sync from Emacs overlay: Make elisp-emacs-version() more robust.

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

  ViewVC Help
Powered by ViewVC 1.1.20