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

Contents of /eclass/elisp-common.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.73 - (show annotations) (download)
Mon Aug 22 06:13:14 2011 UTC (3 years ago) by ulm
Branch: MAIN
Changes since 1.72: +7 -7 lines
Move authors' list to new @AUTHOR block.

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

  ViewVC Help
Powered by ViewVC 1.1.20