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

Contents of /eclass/elisp-common.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.31 - (hide annotations) (download)
Sat Dec 1 15:35:02 2007 UTC (7 years ago) by ulm
Branch: MAIN
Changes since 1.30: +13 -9 lines
Partial sync from Emacs overlay:
New variable SITEETC.
Replace basename by bash parameter expansion.

1 opfer 1.15 # Copyright 1999-2007 Gentoo Foundation
2 mkennedy 1.1 # Distributed under the terms of the GNU General Public License v2
3 ulm 1.31 # $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.30 2007/11/17 15:39:35 ulm Exp $
4 mkennedy 1.1 #
5 opfer 1.15 # Copyright 2007 Christian Faulhammer <opfer@gentoo.org>
6 ulm 1.24 # Copyright 2002-2004 Matthew Kennedy <mkennedy@gentoo.org>
7     # Copyright 2004-2005 Mamoru Komachi <usata@gentoo.org>
8 mkennedy 1.2 # Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com>
9 opfer 1.15 # Copyright 2007 Ulrich Mueller <ulm@gentoo.org>
10 mkennedy 1.1 #
11 ulm 1.25 # @ECLASS: elisp-common.eclass
12     # @MAINTAINER:
13 ulm 1.29 # Feel free to contact the Emacs team through <emacs@gentoo.org> if you have
14 ulm 1.25 # problems, suggestions or questions.
15     # @BLURB: Emacs-related installation utilities
16     # @DESCRIPTION:
17 opfer 1.15 #
18     # Usually you want to use this eclass for (optional) GNU Emacs support of
19 ulm 1.18 # your package. This is NOT for XEmacs!
20 ulm 1.25 #
21     # Many of the steps here are sometimes done by the build system of your
22 opfer 1.15 # package (especially compilation), so this is mainly for standalone elisp
23     # files you gathered from somewhere else.
24 ulm 1.25 #
25     # When relying on the emacs USE flag, you need to add
26 opfer 1.15 #
27 ulm 1.26 # emacs? ( virtual/emacs )
28 opfer 1.15 #
29     # to your DEPEND/RDEPEND line and use the functions provided here to bring
30     # the files to the correct locations.
31     #
32 ulm 1.25 # .SS
33 opfer 1.15 # src_compile() usage:
34     #
35     # An elisp file is compiled by the elisp-compile() function defined here and
36 ulm 1.25 # simply takes the source files as arguments.
37 opfer 1.15 #
38 ulm 1.26 # elisp-compile *.el || die "elisp-compile failed"
39 ulm 1.25 #
40     # In the case of interdependent elisp files, you can use the elisp-comp()
41     # function which makes sure all files are loadable.
42     #
43 ulm 1.26 # elisp-comp *.el || die "elisp-comp failed"
44 opfer 1.15 #
45 ulm 1.25 # Function elisp-make-autoload-file() can be used to generate a file with
46 ulm 1.18 # autoload definitions for the lisp functions. It takes the output file name
47 opfer 1.15 # (default: "${PN}-autoloads.el") and a list of directories (default: working
48 ulm 1.18 # directory) as its arguments. Use of this function requires that the elisp
49 opfer 1.15 # source files contain magic ";;;###autoload" comments. See the Emacs Lisp
50     # Reference Manual (node "Autoload") for a detailed explanation.
51     #
52 ulm 1.25 # .SS
53 opfer 1.15 # src_install() usage:
54     #
55     # The resulting compiled files (.elc) should be put in a subdirectory of
56     # /usr/share/emacs/site-lisp/ which is named after the first argument
57     # of elisp-install(). The following parameters are the files to be put in
58     # that directory. Usually the subdirectory should be ${PN}, you can choose
59     # something else, but remember to tell elisp-site-file-install() (see below)
60     # the change, as it defaults to ${PN}.
61     #
62 ulm 1.26 # elisp-install ${PN} *.el *.elc || die "elisp-install failed"
63 opfer 1.15 #
64 ulm 1.25 # To let the Emacs support be activated by Emacs on startup, you need
65 opfer 1.15 # to provide a site file (shipped in ${FILESDIR}) which contains the startup
66 ulm 1.18 # code (have a look in the documentation of your software). Normally this
67 opfer 1.15 # would look like this:
68     #
69 ulm 1.26 # ;;; csv-mode site-lisp configuration
70 opfer 1.15 #
71 ulm 1.26 # (add-to-list 'load-path "@SITELISP@")
72     # (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode))
73     # (autoload 'csv-mode "csv-mode" "Major mode for csv files." t)
74 opfer 1.15 #
75 ulm 1.25 # If your Emacs support files are installed in a subdirectory of
76 ulm 1.29 # /usr/share/emacs/site-lisp/ (which is recommended), you need to extend
77     # Emacs' load-path as shown in the first non-comment.
78     # The elisp-site-file-install() function of this eclass will replace
79     # "@SITELISP@" by the actual path.
80 ulm 1.25 #
81     # The next line tells Emacs to load the mode opening a file ending with
82 opfer 1.15 # ".csv" and load functions depending on the context and needed features.
83     # Be careful though. Commands as "load-library" or "require" bloat the
84     # editor as they are loaded on every startup. When having a lot of Emacs
85 ulm 1.18 # support files, users may be annoyed by the start-up time. Also avoid
86     # keybindings as they might interfere with the user's settings. Give a hint
87 opfer 1.15 # in pkg_postinst(), which should be enough.
88 ulm 1.25 #
89     # The naming scheme for this site file is "[0-9][0-9]*-gentoo.el", where the
90 ulm 1.18 # two digits at the beginning define the loading order. So if you depend on
91 opfer 1.15 # another Emacs package, your site file's number must be higher!
92 ulm 1.25 #
93     # Best practice is to define a SITEFILE variable in the global scope of your
94 opfer 1.15 # ebuild (right after DEPEND e.g.):
95     #
96 ulm 1.26 # SITEFILE=50${PN}-gentoo.el
97 opfer 1.15 #
98 ulm 1.25 # Which is then installed by
99 opfer 1.15 #
100 ulm 1.29 # elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
101 opfer 1.15 #
102 ulm 1.18 # in src_install(). If your subdirectory is not named ${PN}, give the
103 opfer 1.15 # differing name as second argument.
104     #
105 ulm 1.25 # .SS
106 opfer 1.15 # pkg_postinst() / pkg_postrm() usage:
107     #
108     # After that you need to recreate the start-up file of Emacs after emerging
109     # and unmerging by using
110     #
111 ulm 1.26 # pkg_postinst() {
112     # elisp-site-regen
113     # }
114     #
115     # pkg_postrm() {
116     # elisp-site-regen
117     # }
118 opfer 1.15 #
119 ulm 1.25 # When having optional Emacs support, you should prepend "use emacs &&" to
120 opfer 1.22 # above calls of elisp-site-regen(). Don't use "has_version virtual/emacs"!
121 ulm 1.25 # When unmerging the state of the emacs USE flag is taken from the package
122 opfer 1.22 # database and not from the environment, so it is no problem when you unset
123 ulm 1.25 # USE=emacs between merge and unmerge of a package.
124 opfer 1.22 #
125 ulm 1.25 # .SS
126 opfer 1.22 # Miscellaneous functions:
127     #
128     # elisp-emacs-version() outputs the version of the currently active Emacs.
129 mkennedy 1.1
130 ulm 1.29 # @ECLASS-VARIABLE: SITELISP
131     # @DESCRIPTION:
132 ulm 1.31 # Directory where packages install Emacs Lisp files.
133 mkennedy 1.1 SITELISP=/usr/share/emacs/site-lisp
134 ulm 1.29
135 ulm 1.31 # Directory where packages install miscellaneous (not Lisp) files.
136     SITEETC=/usr/share/emacs/etc
137    
138 ulm 1.29 # @ECLASS-VARIABLE: SITEFILE
139     # @DESCRIPTION:
140     # Name of package's site-init file.
141 ulm 1.25 SITEFILE=50${PN}-gentoo.el
142 ulm 1.29
143 ulm 1.28 EMACS=/usr/bin/emacs
144 ulm 1.29 # The following works for Emacs versions 18--23, don't change it.
145 ulm 1.30 EMACSFLAGS="-batch -q --no-site-file"
146 ulm 1.25
147     # @FUNCTION: elisp-compile
148     # @USAGE: <list of elisp files>
149     # @DESCRIPTION:
150     # Byte-compile Emacs Lisp files.
151 mkennedy 1.1
152 mkennedy 1.2 elisp-compile() {
153 opfer 1.22 einfo "Compiling GNU Emacs Elisp files ..."
154 ulm 1.30 ${EMACS} ${EMACSFLAGS} -f batch-byte-compile "$@"
155     }
156    
157     # @FUNCTION: elisp-comp
158     # @USAGE: <list of elisp files>
159     # @DESCRIPTION:
160     # Byte-compile interdependent Emacs Lisp files.
161     #
162     # This function byte-compiles all ".el" files which are part of its
163     # arguments, using GNU Emacs, and puts the resulting ".elc" files into the
164     # current directory, so disregarding the original directories used in ".el"
165     # arguments.
166     #
167     # This function manages in such a way that all Emacs Lisp files to be
168     # compiled are made visible between themselves, in the event they require or
169     # load one another.
170    
171     elisp-comp() {
172     # Copyright 1995 Free Software Foundation, Inc.
173     # Fran├žois Pinard <pinard@iro.umontreal.ca>, 1995.
174     # Originally taken from GNU autotools.
175    
176     [ $# -gt 0 ] || return 1
177    
178     einfo "Compiling GNU Emacs Elisp files ..."
179    
180     tempdir=elc.$$
181     mkdir ${tempdir}
182     cp "$@" ${tempdir}
183     pushd ${tempdir}
184    
185     echo "(add-to-list 'load-path \"../\")" > script
186     ${EMACS} ${EMACSFLAGS} -l script -f batch-byte-compile *.el
187     local ret=$?
188     mv *.elc ..
189    
190     popd
191     rm -fr ${tempdir}
192     return ${ret}
193 opfer 1.22 }
194    
195 ulm 1.25 # @FUNCTION: elisp-emacs-version
196     # @DESCRIPTION:
197     # Output version of currently active Emacs.
198    
199 opfer 1.22 elisp-emacs-version() {
200 ulm 1.28 # The following will work for at least versions 18-23.
201 opfer 1.22 echo "(princ emacs-version)" >"${T}"/emacs-version.el
202 ulm 1.30 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
203 mkennedy 1.2 }
204    
205 ulm 1.25 # @FUNCTION: elisp-make-autoload-file
206     # @USAGE: [output file] [list of directories]
207     # @DESCRIPTION:
208     # Generate a file with autoload definitions for the lisp functions.
209    
210 ulm 1.29 elisp-make-autoload-file() {
211 opfer 1.17 local f="${1:-${PN}-autoloads.el}"
212 opfer 1.15 shift
213 opfer 1.22 einfo "Generating autoload file for GNU Emacs ..."
214    
215 ulm 1.21 sed 's/^FF/\f/' >"${f}" <<-EOF
216     ;;; ${f##*/} --- autoloads for ${P}
217    
218     ;;; Commentary:
219     ;; Automatically generated by elisp-common.eclass
220     ;; DO NOT EDIT THIS FILE
221    
222     ;;; Code:
223     FF
224     ;; Local Variables:
225     ;; version-control: never
226     ;; no-byte-compile: t
227     ;; no-update-autoloads: t
228     ;; End:
229     ;;; ${f##*/} ends here
230     EOF
231 opfer 1.22
232 ulm 1.30 ${EMACS} ${EMACSFLAGS} \
233 opfer 1.15 --eval "(setq make-backup-files nil)" \
234     --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
235     -f batch-update-autoloads "${@-.}"
236     }
237    
238 ulm 1.25 # @FUNCTION: elisp-install
239     # @USAGE: <subdirectory> <list of files>
240     # @DESCRIPTION:
241     # Install files in SITELISP directory.
242    
243 mkennedy 1.1 elisp-install() {
244 ulm 1.28 local subdir="$1"
245     shift
246 opfer 1.22 einfo "Installing Elisp files for GNU Emacs support ..."
247 ulm 1.28 ( # subshell to avoid pollution of calling environment
248     insinto "${SITELISP}/${subdir}"
249     doins "$@"
250     )
251 mkennedy 1.1 }
252    
253 ulm 1.25 # @FUNCTION: elisp-site-file-install
254     # @USAGE: <site-init file> [subdirectory]
255     # @DESCRIPTION:
256     # Install Emacs site-init file in SITELISP directory.
257    
258 mkennedy 1.1 elisp-site-file-install() {
259 ulm 1.28 local sf="$1" my_pn="${2:-${PN}}"
260 opfer 1.22 einfo "Installing site initialisation file for GNU Emacs ..."
261 ulm 1.28 cp "${sf}" "${T}"
262 ulm 1.31 sed -i -e "s:@SITELISP@:${SITELISP}/${my_pn}:g" \
263     -e "s:@SITEETC@:${SITEETC}/${my_pn}:g" "${T}/${sf##*/}"
264 ulm 1.28 ( # subshell to avoid pollution of calling environment
265     insinto "${SITELISP}"
266 ulm 1.31 doins "${T}/${sf##*/}"
267 ulm 1.28 )
268 mkennedy 1.1 }
269    
270 ulm 1.25 # @FUNCTION: elisp-site-regen
271     # @DESCRIPTION:
272     # Regenerate site-gentoo.el file.
273    
274 mkennedy 1.1 elisp-site-regen() {
275 opfer 1.22 local sflist sf line
276    
277 ulm 1.29 if [ ! -e "${ROOT}${SITELISP}"/site-gentoo.el ] \
278     && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then
279     einfo "Creating default ${SITELISP}/site-start.el ..."
280     cat <<-EOF >"${T}"/site-start.el
281     ;;; site-start.el
282    
283     ;;; Commentary:
284     ;; This default site startup file is installed by elisp-common.eclass.
285     ;; You may replace this file by your own site initialisation, or even
286     ;; remove it completely; it will not be recreated.
287    
288     ;;; Code:
289     ;; Load site initialisation for Gentoo-installed packages.
290     (require 'site-gentoo)
291    
292     ;;; site-start.el ends here
293     EOF
294     fi
295    
296 ulm 1.25 einfon "Regenerating ${SITELISP}/site-gentoo.el ..."
297 ulm 1.24 cat <<-EOF >"${T}"/site-gentoo.el
298     ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
299    
300     ;;; Commentary:
301     ;; Automatically generated by elisp-common.eclass
302     ;; DO NOT EDIT THIS FILE
303    
304     ;;; Code:
305     EOF
306 mkennedy 1.1
307 opfer 1.22 for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el
308 mkennedy 1.1 do
309 ulm 1.20 [ -r "${sf}" ] || continue
310 ulm 1.31 sflist="${sflist} ${sf##*/}"
311 opfer 1.22 cat "${sf}" >>"${T}"/site-gentoo.el
312 mkennedy 1.1 done
313 opfer 1.22
314 ulm 1.24 cat <<-EOF >>"${T}"/site-gentoo.el
315    
316 ulm 1.28 (provide 'site-gentoo)
317    
318     ;; Local Variables:
319     ;; no-byte-compile: t
320     ;; End:
321 ulm 1.24 ;;; site-gentoo.el ends here
322     EOF
323    
324 opfer 1.22 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${T}"/site-gentoo.el; then
325     # This prevents outputting unnecessary text when there
326 ulm 1.29 # was actually no change.
327     # A case is a remerge where we have doubled output.
328 ulm 1.25 echo " no changes."
329 opfer 1.22 else
330 ulm 1.24 mv "${T}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
331 ulm 1.29 [ -f "${T}"/site-start.el ] \
332     && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \
333     && mv "${T}"/site-start.el "${ROOT}${SITELISP}"/site-start.el
334 ulm 1.25 echo; einfo
335 opfer 1.22 for sf in ${sflist}; do
336     einfo " Adding ${sf} ..."
337     done
338     while read line; do einfo "${line}"; done <<EOF
339 jbms 1.4
340 ulm 1.25 All site initialisation for Gentoo-installed packages is added to
341 jbms 1.4 /usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer
342 ulm 1.31 managed by Gentoo. You are responsible for all maintenance of
343 usata 1.8 site-start.el if there is such a file.
344 jbms 1.4
345 ulm 1.24 In order for this site initialisation to be loaded for all users
346 ulm 1.25 automatically, you can add a line like this:
347 jbms 1.4
348 ulm 1.29 (require 'site-gentoo)
349 jbms 1.4
350     to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
351 ulm 1.31 can be added by individual users to their initialisation files, or,
352     for greater flexibility, users can load individual package-specific
353     initialisation files from /usr/share/emacs/site-lisp/.
354 jbms 1.4 EOF
355 opfer 1.22 echo
356     fi
357 mkennedy 1.3 }

  ViewVC Help
Powered by ViewVC 1.1.20