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

Contents of /eclass/elisp-common.eclass

Parent Directory Parent Directory | Revision Log Revision Log


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

1 # Copyright 1999-2011 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
3 # $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.74 2011/08/22 06:56:26 ulm Exp $
4 #
5 # @ECLASS: elisp-common.eclass
6 # @MAINTAINER:
7 # Gentoo Emacs team <emacs@gentoo.org>
8 # @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 # @BLURB: Emacs-related installation utilities
15 # @DESCRIPTION:
16 #
17 # Usually you want to use this eclass for (optional) GNU Emacs support
18 # of your package. This is NOT for XEmacs!
19 #
20 # Many of the steps here are sometimes done by the build system of your
21 # package (especially compilation), so this is mainly for standalone
22 # elisp files you gathered from somewhere else.
23 #
24 # When relying on the emacs USE flag, you need to add
25 #
26 # emacs? ( virtual/emacs )
27 #
28 # to your DEPEND/RDEPEND line and use the functions provided here to
29 # bring the files to the correct locations.
30 #
31 # 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 # .SS
45 # src_compile() usage:
46 #
47 # 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 #
53 # elisp-compile *.el || die
54 #
55 # 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 #
63 # .SS
64 # 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 # 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 #
73 # elisp-install ${PN} *.el *.elc || die
74 #
75 # To let the Emacs support be activated by Emacs on startup, you need
76 # 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 #
80 # (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 #
84 # If your Emacs support files are installed in a subdirectory of
85 # /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 # The elisp-site-file-install() function of this eclass will replace
88 # "@SITELISP@" and "@SITEETC@" by the actual paths.
89 #
90 # 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 #
98 # The naming scheme for this site-init file matches the shell pattern
99 # "[1-8][0-9]*-gentoo*.el", where the two digits at the beginning define
100 # the loading order (numbers below 10 or above 89 are reserved for
101 # internal use). So if your initialisation depends on another Emacs
102 # 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 #
106 # Best practice is to define a SITEFILE variable in the global scope of
107 # your ebuild (e.g., right after S or RDEPEND):
108 #
109 # SITEFILE="50${PN}-gentoo.el"
110 #
111 # Which is then installed by
112 #
113 # elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
114 #
115 # 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 #
121 # .SS
122 # pkg_postinst() / pkg_postrm() usage:
123 #
124 # After that you need to recreate the start-up file of Emacs after
125 # emerging and unmerging by using
126 #
127 # pkg_postinst() {
128 # elisp-site-regen
129 # }
130 #
131 # pkg_postrm() {
132 # elisp-site-regen
133 # }
134 #
135 # 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
142 # @ECLASS-VARIABLE: SITELISP
143 # @DESCRIPTION:
144 # Directory where packages install Emacs Lisp files.
145 SITELISP=/usr/share/emacs/site-lisp
146
147 # @ECLASS-VARIABLE: SITEETC
148 # @DESCRIPTION:
149 # Directory where packages install miscellaneous (not Lisp) files.
150 SITEETC=/usr/share/emacs/etc
151
152 # @ECLASS-VARIABLE: EMACS
153 # @DESCRIPTION:
154 # Path of Emacs executable.
155 EMACS=${EPREFIX}/usr/bin/emacs
156
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 EMACSFLAGS="-batch -q --no-site-file"
162
163 # @ECLASS-VARIABLE: BYTECOMPFLAGS
164 # @DESCRIPTION:
165 # Emacs flags used for byte-compilation in elisp-compile().
166 BYTECOMPFLAGS="-L ."
167
168 # @FUNCTION: elisp-emacs-version
169 # @DESCRIPTION:
170 # Output version of currently active Emacs.
171
172 elisp-emacs-version() {
173 local ret
174 # The following will work for at least versions 18-23.
175 echo "(princ emacs-version)" >"${T}"/emacs-version.el
176 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
177 ret=$?
178 rm -f "${T}"/emacs-version.el
179 if [[ ${ret} -ne 0 ]]; then
180 eerror "elisp-emacs-version: Failed to run ${EMACS}"
181 fi
182 return ${ret}
183 }
184
185 # @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 local need_emacs=$1 have_emacs
194 have_emacs=$(elisp-emacs-version) || return
195 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 # @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 # @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 elisp-make-autoload-file() {
229 local f="${1:-${PN}-autoloads.el}" null="" page=$'\f'
230 shift
231 ebegin "Generating autoload file for GNU Emacs"
232
233 cat >"${f}" <<-EOF
234 ;;; ${f##*/} --- autoloads for ${PN}
235
236 ;;; Commentary:
237 ;; Automatically generated by elisp-common.eclass
238 ;; DO NOT EDIT THIS FILE
239
240 ;;; Code:
241 ${page}
242 ;; Local ${null}Variables:
243 ;; version-control: never
244 ;; no-byte-compile: t
245 ;; no-update-autoloads: t
246 ;; End:
247
248 ;;; ${f##*/} ends here
249 EOF
250
251 ${EMACS} ${EMACSFLAGS} \
252 --eval "(setq make-backup-files nil)" \
253 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
254 -f batch-update-autoloads "${@-.}"
255
256 eend $? "elisp-make-autoload-file: batch-update-autoloads failed"
257 }
258
259 # @FUNCTION: elisp-install
260 # @USAGE: <subdirectory> <list of files>
261 # @DESCRIPTION:
262 # Install files in SITELISP directory.
263
264 elisp-install() {
265 local subdir="$1"
266 shift
267 ebegin "Installing Elisp files for GNU Emacs support"
268 ( # subshell to avoid pollution of calling environment
269 insinto "${SITELISP}/${subdir}"
270 doins "$@"
271 )
272 eend $? "elisp-install: doins failed"
273 }
274
275 # @FUNCTION: elisp-site-file-install
276 # @USAGE: <site-init file> [subdirectory]
277 # @DESCRIPTION:
278 # 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
284 elisp-site-file-install() {
285 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 ebegin "Installing site initialisation file for GNU Emacs"
292 [[ $1 = "${sf}" ]] || cp "$1" "${sf}"
293 sed -i -e "1{:x;/^\$/{n;bx;};/^;.*${PN}/I!s:^:${header}\n\n:;1s:^:\n:;}" \
294 -e "s:@SITELISP@:${EPREFIX}${SITELISP}/${my_pn}:g" \
295 -e "s:@SITEETC@:${EPREFIX}${SITEETC}/${my_pn}:g;\$q" "${sf}"
296 ( # subshell to avoid pollution of calling environment
297 insinto "${SITELISP}/site-gentoo.d"
298 doins "${sf}"
299 )
300 ret=$?
301 rm -f "${sf}"
302 eend ${ret} "elisp-site-file-install: doins failed"
303 }
304
305 # @FUNCTION: elisp-site-regen
306 # @DESCRIPTION:
307 # 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
315 elisp-site-regen() {
316 local sitelisp=${ROOT}${EPREFIX}${SITELISP}
317 local sf i line null="" page=$'\f'
318 local -a sflist
319
320 if [[ ! -d ${sitelisp} ]]; then
321 eerror "elisp-site-regen: Directory ${sitelisp} does not exist"
322 return 1
323 fi
324
325 if [[ ! -d ${T} ]]; then
326 eerror "elisp-site-regen: Temporary directory ${T} does not exist"
327 return 1
328 fi
329
330 einfon "Regenerating site-gentoo.el for GNU Emacs (${EBUILD_PHASE}) ..."
331
332 # Until January 2009, elisp-common.eclass sometimes created an
333 # auxiliary file for backwards compatibility. Remove any such file.
334 rm -f "${sitelisp}"/00site-gentoo.el
335
336 for sf in "${sitelisp}"/[0-9][0-9]*-gentoo.el \
337 "${sitelisp}"/site-gentoo.d/[0-9][0-9]*.el
338 do
339 [[ -r ${sf} ]] || continue
340 # 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 cat <<-EOF >"${T}"/site-gentoo.el
349 ;;; 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 # Use sed instead of cat here, since files may miss a trailing newline.
358 sed '$q' "${sflist[@]}" </dev/null >>"${T}"/site-gentoo.el
359 cat <<-EOF >>"${T}"/site-gentoo.el
360
361 ${page}
362 (provide 'site-gentoo)
363
364 ;; Local ${null}Variables:
365 ;; no-byte-compile: t
366 ;; buffer-read-only: t
367 ;; End:
368
369 ;;; site-gentoo.el ends here
370 EOF
371
372 if cmp -s "${sitelisp}"/site-gentoo.el "${T}"/site-gentoo.el; then
373 # This prevents outputting unnecessary text when there
374 # was actually no change.
375 # A case is a remerge where we have doubled output.
376 rm -f "${T}"/site-gentoo.el
377 echo " no changes."
378 else
379 mv "${T}"/site-gentoo.el "${sitelisp}"/site-gentoo.el
380 echo
381 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 fi
387
388 return 0
389 }

  ViewVC Help
Powered by ViewVC 1.1.20