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

Contents of /eclass/elisp-common.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.69 - (show annotations) (download)
Tue Nov 23 20:56:08 2010 UTC (3 years, 8 months ago) by ulm
Branch: MAIN
Changes since 1.68: +33 -10 lines
Sync eclasses from Emacs overlay (revision 1542).

elisp-common.eclass:
Remove dead function elisp-comp; it has	been deprecated more than two
years ago in bug 235442.
New function elisp-need-emacs, tests if the eselected Emacs version is
at least the major version specified as argument.

elisp.eclass:
Use function elisp-need-emacs in elisp_pkg_setup.

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

  ViewVC Help
Powered by ViewVC 1.1.20