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

Contents of /eclass/elisp-common.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.65 - (show annotations) (download)
Tue Dec 29 20:15:12 2009 UTC (4 years, 6 months ago) by ulm
Branch: MAIN
Changes since 1.64: +2 -14 lines
Sync from Emacs overlay (revision 1477).
Remove the warning about obsolete files; the install location was
changed two years ago.

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

  ViewVC Help
Powered by ViewVC 1.1.20