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

Contents of /eclass/elisp-common.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.75 - (hide annotations) (download)
Tue Aug 30 20:10:13 2011 UTC (3 years, 1 month ago) by ulm
Branch: MAIN
Changes since 1.74: +4 -4 lines
Sync eclasses from Emacs overlay (revision 1683).
Change [ ] to [[ ]] throughout.

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.75 # $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.74 2011/08/22 06:56:26 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.25 #
98 ulm 1.50 # The naming scheme for this site-init file matches the shell pattern
99 ulm 1.59 # "[1-8][0-9]*-gentoo*.el", where the two digits at the beginning define
100 ulm 1.58 # the loading order (numbers below 10 or above 89 are reserved for
101     # internal use). So if your initialisation depends on another Emacs
102 ulm 1.68 # package, your site file's number must be higher! If there are no such
103     # interdependencies then the number should be 50. Otherwise, numbers
104     # divisible by 10 are preferred.
105 ulm 1.25 #
106 ulm 1.58 # Best practice is to define a SITEFILE variable in the global scope of
107     # your ebuild (e.g., right after S or RDEPEND):
108 opfer 1.15 #
109 ulm 1.58 # SITEFILE="50${PN}-gentoo.el"
110 opfer 1.15 #
111 ulm 1.25 # Which is then installed by
112 opfer 1.15 #
113 ulm 1.29 # elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
114 opfer 1.15 #
115 ulm 1.59 # in src_install(). Any characters after the "-gentoo" part and before
116     # the extension will be stripped from the destination file's name.
117     # For example, a file "50${PN}-gentoo-${PV}.el" will be installed as
118     # "50${PN}-gentoo.el". If your subdirectory is not named ${PN}, give
119     # the differing name as second argument.
120 opfer 1.15 #
121 ulm 1.25 # .SS
122 opfer 1.15 # pkg_postinst() / pkg_postrm() usage:
123     #
124 ulm 1.58 # After that you need to recreate the start-up file of Emacs after
125     # emerging and unmerging by using
126 opfer 1.15 #
127 ulm 1.26 # pkg_postinst() {
128     # elisp-site-regen
129     # }
130     #
131     # pkg_postrm() {
132     # elisp-site-regen
133     # }
134 opfer 1.15 #
135 ulm 1.58 # When having optional Emacs support, you should prepend "use emacs &&"
136     # to above calls of elisp-site-regen().
137     # Don't use "has_version virtual/emacs"! When unmerging the state of
138     # the emacs USE flag is taken from the package database and not from the
139     # environment, so it is no problem when you unset USE=emacs between
140     # merge and unmerge of a package.
141 mkennedy 1.1
142 ulm 1.29 # @ECLASS-VARIABLE: SITELISP
143     # @DESCRIPTION:
144 ulm 1.31 # Directory where packages install Emacs Lisp files.
145 mkennedy 1.1 SITELISP=/usr/share/emacs/site-lisp
146 ulm 1.29
147 ulm 1.48 # @ECLASS-VARIABLE: SITEETC
148     # @DESCRIPTION:
149 ulm 1.31 # Directory where packages install miscellaneous (not Lisp) files.
150     SITEETC=/usr/share/emacs/etc
151    
152 ulm 1.43 # @ECLASS-VARIABLE: EMACS
153     # @DESCRIPTION:
154     # Path of Emacs executable.
155 ulm 1.64 EMACS=${EPREFIX}/usr/bin/emacs
156 ulm 1.43
157     # @ECLASS-VARIABLE: EMACSFLAGS
158     # @DESCRIPTION:
159     # Flags for executing Emacs in batch mode.
160     # These work for Emacs versions 18-23, so don't change them.
161 ulm 1.30 EMACSFLAGS="-batch -q --no-site-file"
162 ulm 1.25
163 ulm 1.43 # @ECLASS-VARIABLE: BYTECOMPFLAGS
164     # @DESCRIPTION:
165     # Emacs flags used for byte-compilation in elisp-compile().
166     BYTECOMPFLAGS="-L ."
167    
168 ulm 1.25 # @FUNCTION: elisp-emacs-version
169     # @DESCRIPTION:
170     # Output version of currently active Emacs.
171    
172 opfer 1.22 elisp-emacs-version() {
173 ulm 1.72 local ret
174 ulm 1.38 # The following will work for at least versions 18-23.
175 opfer 1.22 echo "(princ emacs-version)" >"${T}"/emacs-version.el
176 ulm 1.30 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
177 ulm 1.72 ret=$?
178 ulm 1.37 rm -f "${T}"/emacs-version.el
179 ulm 1.72 if [[ ${ret} -ne 0 ]]; then
180     eerror "elisp-emacs-version: Failed to run ${EMACS}"
181     fi
182     return ${ret}
183 mkennedy 1.2 }
184    
185 ulm 1.69 # @FUNCTION: elisp-need-emacs
186     # @USAGE: <version>
187     # @RETURN: 0 if true, 1 otherwise
188     # @DESCRIPTION:
189     # Test if the eselected Emacs version is at least the major version
190     # specified as argument.
191    
192     elisp-need-emacs() {
193 ulm 1.72 local need_emacs=$1 have_emacs
194     have_emacs=$(elisp-emacs-version) || return
195 ulm 1.69 einfo "Emacs version: ${have_emacs}"
196     if ! [[ ${have_emacs%%.*} -ge ${need_emacs%%.*} ]]; then
197     eerror "This package needs at least Emacs ${need_emacs%%.*}."
198     eerror "Use \"eselect emacs\" to select the active version."
199     return 1
200     fi
201     return 0
202     }
203    
204 ulm 1.70 # @FUNCTION: elisp-compile
205     # @USAGE: <list of elisp files>
206     # @DESCRIPTION:
207     # Byte-compile Emacs Lisp files.
208     #
209     # This function uses GNU Emacs to byte-compile all ".el" specified by
210     # its arguments. The resulting byte-code (".elc") files are placed in
211     # the same directory as their corresponding source file.
212     #
213     # The current directory is added to the load-path. This will ensure
214     # that interdependent Emacs Lisp files are visible between themselves,
215     # in case they require or load one another.
216    
217     elisp-compile() {
218     ebegin "Compiling GNU Emacs Elisp files"
219     ${EMACS} ${EMACSFLAGS} ${BYTECOMPFLAGS} -f batch-byte-compile "$@"
220     eend $? "elisp-compile: batch-byte-compile failed"
221     }
222    
223 ulm 1.25 # @FUNCTION: elisp-make-autoload-file
224     # @USAGE: [output file] [list of directories]
225     # @DESCRIPTION:
226     # Generate a file with autoload definitions for the lisp functions.
227    
228 ulm 1.29 elisp-make-autoload-file() {
229 ulm 1.62 local f="${1:-${PN}-autoloads.el}" null="" page=$'\f'
230 opfer 1.15 shift
231 ulm 1.32 ebegin "Generating autoload file for GNU Emacs"
232 opfer 1.22
233 ulm 1.62 cat >"${f}" <<-EOF
234 ulm 1.67 ;;; ${f##*/} --- autoloads for ${PN}
235 ulm 1.21
236     ;;; Commentary:
237     ;; Automatically generated by elisp-common.eclass
238     ;; DO NOT EDIT THIS FILE
239    
240     ;;; Code:
241 ulm 1.62 ${page}
242     ;; Local ${null}Variables:
243 ulm 1.21 ;; version-control: never
244     ;; no-byte-compile: t
245     ;; no-update-autoloads: t
246     ;; End:
247 ulm 1.62
248 ulm 1.21 ;;; ${f##*/} ends here
249     EOF
250 opfer 1.22
251 ulm 1.30 ${EMACS} ${EMACSFLAGS} \
252 opfer 1.15 --eval "(setq make-backup-files nil)" \
253     --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
254     -f batch-update-autoloads "${@-.}"
255 ulm 1.32
256 ulm 1.49 eend $? "elisp-make-autoload-file: batch-update-autoloads failed"
257 opfer 1.15 }
258    
259 ulm 1.25 # @FUNCTION: elisp-install
260     # @USAGE: <subdirectory> <list of files>
261     # @DESCRIPTION:
262     # Install files in SITELISP directory.
263    
264 mkennedy 1.1 elisp-install() {
265 ulm 1.28 local subdir="$1"
266     shift
267 ulm 1.32 ebegin "Installing Elisp files for GNU Emacs support"
268 ulm 1.28 ( # subshell to avoid pollution of calling environment
269     insinto "${SITELISP}/${subdir}"
270     doins "$@"
271     )
272 ulm 1.49 eend $? "elisp-install: doins failed"
273 mkennedy 1.1 }
274    
275 ulm 1.25 # @FUNCTION: elisp-site-file-install
276     # @USAGE: <site-init file> [subdirectory]
277     # @DESCRIPTION:
278 ulm 1.59 # Install Emacs site-init file in SITELISP directory. Automatically
279     # inserts a standard comment header with the name of the package (unless
280     # it is already present). Tokens @SITELISP@ and @SITEETC@ are replaced
281     # by the path to the package's subdirectory in SITELISP and SITEETC,
282     # respectively.
283 ulm 1.25
284 mkennedy 1.1 elisp-site-file-install() {
285 ulm 1.59 local sf="${1##*/}" my_pn="${2:-${PN}}" ret
286     local header=";;; ${PN} site-lisp configuration"
287    
288     [[ ${sf} == [0-9][0-9]*-gentoo*.el ]] \
289     || ewarn "elisp-site-file-install: bad name of site-init file"
290     sf="${T}/${sf/%-gentoo*.el/-gentoo.el}"
291 ulm 1.32 ebegin "Installing site initialisation file for GNU Emacs"
292 ulm 1.71 [[ $1 = "${sf}" ]] || cp "$1" "${sf}"
293 ulm 1.59 sed -i -e "1{:x;/^\$/{n;bx;};/^;.*${PN}/I!s:^:${header}\n\n:;1s:^:\n:;}" \
294 ulm 1.64 -e "s:@SITELISP@:${EPREFIX}${SITELISP}/${my_pn}:g" \
295     -e "s:@SITEETC@:${EPREFIX}${SITEETC}/${my_pn}:g;\$q" "${sf}"
296 ulm 1.28 ( # subshell to avoid pollution of calling environment
297 ulm 1.34 insinto "${SITELISP}/site-gentoo.d"
298 ulm 1.37 doins "${sf}"
299 ulm 1.28 )
300 ulm 1.37 ret=$?
301     rm -f "${sf}"
302 ulm 1.49 eend ${ret} "elisp-site-file-install: doins failed"
303 mkennedy 1.1 }
304    
305 ulm 1.25 # @FUNCTION: elisp-site-regen
306     # @DESCRIPTION:
307 ulm 1.58 # Regenerate the site-gentoo.el file, based on packages' site
308     # initialisation files in the /usr/share/emacs/site-lisp/site-gentoo.d/
309     # directory.
310     #
311     # Note: Before December 2007, site initialisation files were installed
312     # in /usr/share/emacs/site-lisp/. For backwards compatibility, this
313     # location is still supported when generating site-gentoo.el.
314 ulm 1.32
315 mkennedy 1.1 elisp-site-regen() {
316 ulm 1.64 local sitelisp=${ROOT}${EPREFIX}${SITELISP}
317 ulm 1.65 local sf i line null="" page=$'\f'
318 ulm 1.32 local -a sflist
319 opfer 1.22
320 ulm 1.75 if [[ ! -d ${sitelisp} ]]; then
321 ulm 1.64 eerror "elisp-site-regen: Directory ${sitelisp} does not exist"
322 ulm 1.38 return 1
323     fi
324    
325 ulm 1.75 if [[ ! -d ${T} ]]; then
326 ulm 1.55 eerror "elisp-site-regen: Temporary directory ${T} does not exist"
327     return 1
328     fi
329    
330 ulm 1.60 einfon "Regenerating site-gentoo.el for GNU Emacs (${EBUILD_PHASE}) ..."
331 ulm 1.32
332 ulm 1.58 # Until January 2009, elisp-common.eclass sometimes created an
333     # auxiliary file for backwards compatibility. Remove any such file.
334 ulm 1.64 rm -f "${sitelisp}"/00site-gentoo.el
335 ulm 1.32
336 ulm 1.64 for sf in "${sitelisp}"/[0-9][0-9]*-gentoo.el \
337     "${sitelisp}"/site-gentoo.d/[0-9][0-9]*.el
338 ulm 1.32 do
339 ulm 1.75 [[ -r ${sf} ]] || continue
340 ulm 1.32 # sort files by their basename. straight insertion sort.
341     for ((i=${#sflist[@]}; i>0; i--)); do
342     [[ ${sf##*/} < ${sflist[i-1]##*/} ]] || break
343     sflist[i]=${sflist[i-1]}
344     done
345     sflist[i]=${sf}
346     done
347    
348 ulm 1.55 cat <<-EOF >"${T}"/site-gentoo.el
349 ulm 1.24 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
350    
351     ;;; Commentary:
352     ;; Automatically generated by elisp-common.eclass
353     ;; DO NOT EDIT THIS FILE
354    
355     ;;; Code:
356     EOF
357 ulm 1.50 # Use sed instead of cat here, since files may miss a trailing newline.
358 ulm 1.55 sed '$q' "${sflist[@]}" </dev/null >>"${T}"/site-gentoo.el
359     cat <<-EOF >>"${T}"/site-gentoo.el
360 ulm 1.24
361 ulm 1.70 ${page}
362 ulm 1.28 (provide 'site-gentoo)
363    
364 ulm 1.62 ;; Local ${null}Variables:
365 ulm 1.28 ;; no-byte-compile: t
366 ulm 1.62 ;; buffer-read-only: t
367 ulm 1.28 ;; End:
368 ulm 1.62
369 ulm 1.24 ;;; site-gentoo.el ends here
370     EOF
371    
372 ulm 1.64 if cmp -s "${sitelisp}"/site-gentoo.el "${T}"/site-gentoo.el; then
373 opfer 1.22 # This prevents outputting unnecessary text when there
374 ulm 1.29 # was actually no change.
375     # A case is a remerge where we have doubled output.
376 ulm 1.66 rm -f "${T}"/site-gentoo.el
377 ulm 1.25 echo " no changes."
378 opfer 1.22 else
379 ulm 1.64 mv "${T}"/site-gentoo.el "${sitelisp}"/site-gentoo.el
380 ulm 1.46 echo
381 ulm 1.63 case ${#sflist[@]} in
382     0) ewarn "... Huh? No site initialisation files found." ;;
383     1) einfo "... ${#sflist[@]} site initialisation file included." ;;
384     *) einfo "... ${#sflist[@]} site initialisation files included." ;;
385     esac
386 ulm 1.47 fi
387 ulm 1.32
388 ulm 1.45 return 0
389 mkennedy 1.3 }

  ViewVC Help
Powered by ViewVC 1.1.20