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

Contents of /eclass/elisp-common.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.79 - (hide annotations) (download)
Sat Feb 11 12:20:33 2012 UTC (2 years, 7 months ago) by ulm
Branch: MAIN
Changes since 1.78: +3 -3 lines
Delete declaration of unused variable.

1 ulm 1.79 # Copyright 1999-2012 Gentoo Foundation
2 mkennedy 1.1 # Distributed under the terms of the GNU General Public License v2
3 ulm 1.79 # $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.78 2011/12/03 20:43:21 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 ulm 1.25 # .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.50 # elisp-compile *.el || die
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 ulm 1.25 # .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.50 # elisp-install ${PN} *.el *.elc || die
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.29 # elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
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 ulm 1.25 # .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     # These work for Emacs versions 18-23, 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     # @DESCRIPTION:
172     # Output version of currently active Emacs.
173    
174 opfer 1.22 elisp-emacs-version() {
175 ulm 1.72 local ret
176 ulm 1.38 # The following will work for at least versions 18-23.
177 opfer 1.22 echo "(princ emacs-version)" >"${T}"/emacs-version.el
178 ulm 1.30 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
179 ulm 1.72 ret=$?
180 ulm 1.37 rm -f "${T}"/emacs-version.el
181 ulm 1.72 if [[ ${ret} -ne 0 ]]; then
182     eerror "elisp-emacs-version: Failed to run ${EMACS}"
183     fi
184     return ${ret}
185 mkennedy 1.2 }
186    
187 ulm 1.69 # @FUNCTION: elisp-need-emacs
188     # @USAGE: <version>
189     # @RETURN: 0 if true, 1 otherwise
190     # @DESCRIPTION:
191     # Test if the eselected Emacs version is at least the major version
192     # specified as argument.
193    
194     elisp-need-emacs() {
195 ulm 1.72 local need_emacs=$1 have_emacs
196     have_emacs=$(elisp-emacs-version) || return
197 ulm 1.69 einfo "Emacs version: ${have_emacs}"
198     if ! [[ ${have_emacs%%.*} -ge ${need_emacs%%.*} ]]; then
199     eerror "This package needs at least Emacs ${need_emacs%%.*}."
200     eerror "Use \"eselect emacs\" to select the active version."
201     return 1
202     fi
203     return 0
204     }
205    
206 ulm 1.70 # @FUNCTION: elisp-compile
207     # @USAGE: <list of elisp files>
208     # @DESCRIPTION:
209     # Byte-compile Emacs Lisp files.
210     #
211     # This function uses GNU Emacs to byte-compile all ".el" specified by
212     # its arguments. The resulting byte-code (".elc") files are placed in
213     # the same directory as their corresponding source file.
214     #
215     # The current directory is added to the load-path. This will ensure
216     # that interdependent Emacs Lisp files are visible between themselves,
217     # in case they require or load one another.
218    
219     elisp-compile() {
220     ebegin "Compiling GNU Emacs Elisp files"
221     ${EMACS} ${EMACSFLAGS} ${BYTECOMPFLAGS} -f batch-byte-compile "$@"
222     eend $? "elisp-compile: batch-byte-compile failed"
223     }
224    
225 ulm 1.25 # @FUNCTION: elisp-make-autoload-file
226     # @USAGE: [output file] [list of directories]
227     # @DESCRIPTION:
228     # Generate a file with autoload definitions for the lisp functions.
229    
230 ulm 1.29 elisp-make-autoload-file() {
231 ulm 1.62 local f="${1:-${PN}-autoloads.el}" null="" page=$'\f'
232 opfer 1.15 shift
233 ulm 1.32 ebegin "Generating autoload file for GNU Emacs"
234 opfer 1.22
235 ulm 1.62 cat >"${f}" <<-EOF
236 ulm 1.67 ;;; ${f##*/} --- autoloads for ${PN}
237 ulm 1.21
238     ;;; Commentary:
239     ;; Automatically generated by elisp-common.eclass
240     ;; DO NOT EDIT THIS FILE
241    
242     ;;; Code:
243 ulm 1.62 ${page}
244     ;; Local ${null}Variables:
245 ulm 1.21 ;; version-control: never
246     ;; no-byte-compile: t
247     ;; no-update-autoloads: t
248     ;; End:
249 ulm 1.62
250 ulm 1.21 ;;; ${f##*/} ends here
251     EOF
252 opfer 1.22
253 ulm 1.30 ${EMACS} ${EMACSFLAGS} \
254 opfer 1.15 --eval "(setq make-backup-files nil)" \
255     --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
256     -f batch-update-autoloads "${@-.}"
257 ulm 1.32
258 ulm 1.49 eend $? "elisp-make-autoload-file: batch-update-autoloads failed"
259 opfer 1.15 }
260    
261 ulm 1.25 # @FUNCTION: elisp-install
262     # @USAGE: <subdirectory> <list of files>
263     # @DESCRIPTION:
264     # Install files in SITELISP directory.
265    
266 mkennedy 1.1 elisp-install() {
267 ulm 1.28 local subdir="$1"
268     shift
269 ulm 1.32 ebegin "Installing Elisp files for GNU Emacs support"
270 ulm 1.28 ( # subshell to avoid pollution of calling environment
271     insinto "${SITELISP}/${subdir}"
272     doins "$@"
273     )
274 ulm 1.49 eend $? "elisp-install: doins failed"
275 mkennedy 1.1 }
276    
277 ulm 1.25 # @FUNCTION: elisp-site-file-install
278     # @USAGE: <site-init file> [subdirectory]
279     # @DESCRIPTION:
280 ulm 1.59 # Install Emacs site-init file in SITELISP directory. Automatically
281     # inserts a standard comment header with the name of the package (unless
282     # it is already present). Tokens @SITELISP@ and @SITEETC@ are replaced
283     # by the path to the package's subdirectory in SITELISP and SITEETC,
284     # respectively.
285 ulm 1.25
286 mkennedy 1.1 elisp-site-file-install() {
287 ulm 1.59 local sf="${1##*/}" my_pn="${2:-${PN}}" ret
288     local header=";;; ${PN} site-lisp configuration"
289    
290     [[ ${sf} == [0-9][0-9]*-gentoo*.el ]] \
291     || ewarn "elisp-site-file-install: bad name of site-init file"
292     sf="${T}/${sf/%-gentoo*.el/-gentoo.el}"
293 ulm 1.32 ebegin "Installing site initialisation file for GNU Emacs"
294 ulm 1.71 [[ $1 = "${sf}" ]] || cp "$1" "${sf}"
295 ulm 1.59 sed -i -e "1{:x;/^\$/{n;bx;};/^;.*${PN}/I!s:^:${header}\n\n:;1s:^:\n:;}" \
296 ulm 1.64 -e "s:@SITELISP@:${EPREFIX}${SITELISP}/${my_pn}:g" \
297     -e "s:@SITEETC@:${EPREFIX}${SITEETC}/${my_pn}:g;\$q" "${sf}"
298 ulm 1.28 ( # subshell to avoid pollution of calling environment
299 ulm 1.34 insinto "${SITELISP}/site-gentoo.d"
300 ulm 1.37 doins "${sf}"
301 ulm 1.28 )
302 ulm 1.37 ret=$?
303     rm -f "${sf}"
304 ulm 1.49 eend ${ret} "elisp-site-file-install: doins failed"
305 mkennedy 1.1 }
306    
307 ulm 1.25 # @FUNCTION: elisp-site-regen
308     # @DESCRIPTION:
309 ulm 1.58 # Regenerate the site-gentoo.el file, based on packages' site
310     # initialisation files in the /usr/share/emacs/site-lisp/site-gentoo.d/
311     # directory.
312     #
313     # Note: Before December 2007, site initialisation files were installed
314     # in /usr/share/emacs/site-lisp/. For backwards compatibility, this
315     # location is still supported when generating site-gentoo.el.
316 ulm 1.32
317 mkennedy 1.1 elisp-site-regen() {
318 ulm 1.64 local sitelisp=${ROOT}${EPREFIX}${SITELISP}
319 ulm 1.79 local sf i null="" page=$'\f'
320 ulm 1.32 local -a sflist
321 opfer 1.22
322 ulm 1.75 if [[ ! -d ${sitelisp} ]]; then
323 ulm 1.64 eerror "elisp-site-regen: Directory ${sitelisp} does not exist"
324 ulm 1.38 return 1
325     fi
326    
327 ulm 1.75 if [[ ! -d ${T} ]]; then
328 ulm 1.55 eerror "elisp-site-regen: Temporary directory ${T} does not exist"
329     return 1
330     fi
331    
332 ulm 1.78 ebegin "Regenerating site-gentoo.el for GNU Emacs (${EBUILD_PHASE})"
333 ulm 1.32
334 ulm 1.58 # Until January 2009, elisp-common.eclass sometimes created an
335     # auxiliary file for backwards compatibility. Remove any such file.
336 ulm 1.64 rm -f "${sitelisp}"/00site-gentoo.el
337 ulm 1.32
338 ulm 1.64 for sf in "${sitelisp}"/[0-9][0-9]*-gentoo.el \
339     "${sitelisp}"/site-gentoo.d/[0-9][0-9]*.el
340 ulm 1.32 do
341 ulm 1.75 [[ -r ${sf} ]] || continue
342 ulm 1.32 # sort files by their basename. straight insertion sort.
343     for ((i=${#sflist[@]}; i>0; i--)); do
344     [[ ${sf##*/} < ${sflist[i-1]##*/} ]] || break
345     sflist[i]=${sflist[i-1]}
346     done
347     sflist[i]=${sf}
348     done
349    
350 ulm 1.55 cat <<-EOF >"${T}"/site-gentoo.el
351 ulm 1.24 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
352    
353     ;;; Commentary:
354     ;; Automatically generated by elisp-common.eclass
355     ;; DO NOT EDIT THIS FILE
356    
357     ;;; Code:
358     EOF
359 ulm 1.50 # Use sed instead of cat here, since files may miss a trailing newline.
360 ulm 1.55 sed '$q' "${sflist[@]}" </dev/null >>"${T}"/site-gentoo.el
361     cat <<-EOF >>"${T}"/site-gentoo.el
362 ulm 1.24
363 ulm 1.70 ${page}
364 ulm 1.28 (provide 'site-gentoo)
365    
366 ulm 1.62 ;; Local ${null}Variables:
367 ulm 1.28 ;; no-byte-compile: t
368 ulm 1.62 ;; buffer-read-only: t
369 ulm 1.28 ;; End:
370 ulm 1.62
371 ulm 1.24 ;;; site-gentoo.el ends here
372     EOF
373    
374 ulm 1.64 if cmp -s "${sitelisp}"/site-gentoo.el "${T}"/site-gentoo.el; then
375 opfer 1.22 # This prevents outputting unnecessary text when there
376 ulm 1.29 # was actually no change.
377     # A case is a remerge where we have doubled output.
378 ulm 1.66 rm -f "${T}"/site-gentoo.el
379 ulm 1.78 eend
380 ulm 1.77 einfo "... no changes."
381 opfer 1.22 else
382 ulm 1.64 mv "${T}"/site-gentoo.el "${sitelisp}"/site-gentoo.el
383 ulm 1.78 eend
384 ulm 1.63 case ${#sflist[@]} in
385     0) ewarn "... Huh? No site initialisation files found." ;;
386     1) einfo "... ${#sflist[@]} site initialisation file included." ;;
387     *) einfo "... ${#sflist[@]} site initialisation files included." ;;
388     esac
389 ulm 1.47 fi
390 ulm 1.32
391 ulm 1.45 return 0
392 mkennedy 1.3 }

  ViewVC Help
Powered by ViewVC 1.1.20