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

Contents of /eclass/elisp-common.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.61 - (hide annotations) (download)
Mon May 25 16:25:32 2009 UTC (5 years, 2 months ago) by fauli
Branch: MAIN
Changes since 1.60: +1 -3 lines
Remove comment line from example site-init file

1 ulm 1.54 # Copyright 1999-2009 Gentoo Foundation
2 mkennedy 1.1 # Distributed under the terms of the GNU General Public License v2
3 fauli 1.61 # $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.60 2009/04/14 15:45:45 ulm Exp $
4 mkennedy 1.1 #
5 ulm 1.24 # Copyright 2002-2004 Matthew Kennedy <mkennedy@gentoo.org>
6 ulm 1.35 # Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com>
7 ulm 1.24 # Copyright 2004-2005 Mamoru Komachi <usata@gentoo.org>
8 ulm 1.56 # Copyright 2007-2008 Christian Faulhammer <fauli@gentoo.org>
9 ulm 1.54 # Copyright 2007-2009 Ulrich Müller <ulm@gentoo.org>
10 mkennedy 1.1 #
11 ulm 1.25 # @ECLASS: elisp-common.eclass
12     # @MAINTAINER:
13 ulm 1.58 # Feel free to contact the Emacs team through <emacs@gentoo.org> if you
14     # have problems, suggestions or questions.
15 ulm 1.25 # @BLURB: Emacs-related installation utilities
16     # @DESCRIPTION:
17 opfer 1.15 #
18 ulm 1.58 # Usually you want to use this eclass for (optional) GNU Emacs support
19     # of 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 ulm 1.58 # package (especially compilation), so this is mainly for standalone
23     # elisp 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 ulm 1.58 # to your DEPEND/RDEPEND line and use the functions provided here to
30     # bring the files to the correct locations.
31 opfer 1.15 #
32 ulm 1.25 # .SS
33 opfer 1.15 # src_compile() usage:
34     #
35 ulm 1.58 # 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 opfer 1.15 #
41 ulm 1.50 # elisp-compile *.el || die
42 ulm 1.25 #
43 ulm 1.58 # 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 opfer 1.15 #
51 ulm 1.25 # .SS
52 opfer 1.15 # 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 ulm 1.58 # 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 opfer 1.15 #
61 ulm 1.50 # elisp-install ${PN} *.el *.elc || die
62 opfer 1.15 #
63 ulm 1.25 # To let the Emacs support be activated by Emacs on startup, you need
64 ulm 1.58 # 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 opfer 1.15 #
68 ulm 1.26 # (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 opfer 1.15 #
72 ulm 1.25 # If your Emacs support files are installed in a subdirectory of
73 ulm 1.58 # /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 ulm 1.29 # The elisp-site-file-install() function of this eclass will replace
76 ulm 1.58 # "@SITELISP@" and "@SITEETC@" by the actual paths.
77 ulm 1.25 #
78 ulm 1.58 # 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 ulm 1.25 #
86 ulm 1.50 # The naming scheme for this site-init file matches the shell pattern
87 ulm 1.59 # "[1-8][0-9]*-gentoo*.el", where the two digits at the beginning define
88 ulm 1.58 # 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 ulm 1.25 #
92 ulm 1.58 # Best practice is to define a SITEFILE variable in the global scope of
93     # your ebuild (e.g., right after S or RDEPEND):
94 opfer 1.15 #
95 ulm 1.58 # SITEFILE="50${PN}-gentoo.el"
96 opfer 1.15 #
97 ulm 1.25 # Which is then installed by
98 opfer 1.15 #
99 ulm 1.29 # elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
100 opfer 1.15 #
101 ulm 1.59 # 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 opfer 1.15 #
107 ulm 1.25 # .SS
108 opfer 1.15 # pkg_postinst() / pkg_postrm() usage:
109     #
110 ulm 1.58 # After that you need to recreate the start-up file of Emacs after
111     # emerging and unmerging by using
112 opfer 1.15 #
113 ulm 1.26 # pkg_postinst() {
114     # elisp-site-regen
115     # }
116     #
117     # pkg_postrm() {
118     # elisp-site-regen
119     # }
120 opfer 1.15 #
121 ulm 1.58 # 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 opfer 1.22 #
128 ulm 1.25 # .SS
129 opfer 1.22 # Miscellaneous functions:
130     #
131     # elisp-emacs-version() outputs the version of the currently active Emacs.
132 mkennedy 1.1
133 ulm 1.29 # @ECLASS-VARIABLE: SITELISP
134     # @DESCRIPTION:
135 ulm 1.31 # Directory where packages install Emacs Lisp files.
136 mkennedy 1.1 SITELISP=/usr/share/emacs/site-lisp
137 ulm 1.29
138 ulm 1.48 # @ECLASS-VARIABLE: SITEETC
139     # @DESCRIPTION:
140 ulm 1.31 # Directory where packages install miscellaneous (not Lisp) files.
141     SITEETC=/usr/share/emacs/etc
142    
143 ulm 1.43 # @ECLASS-VARIABLE: EMACS
144     # @DESCRIPTION:
145     # Path of Emacs executable.
146 ulm 1.28 EMACS=/usr/bin/emacs
147 ulm 1.43
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 ulm 1.30 EMACSFLAGS="-batch -q --no-site-file"
153 ulm 1.25
154 ulm 1.43 # @ECLASS-VARIABLE: BYTECOMPFLAGS
155     # @DESCRIPTION:
156     # Emacs flags used for byte-compilation in elisp-compile().
157     BYTECOMPFLAGS="-L ."
158    
159 ulm 1.25 # @FUNCTION: elisp-compile
160     # @USAGE: <list of elisp files>
161     # @DESCRIPTION:
162     # Byte-compile Emacs Lisp files.
163 ulm 1.43 #
164 ulm 1.58 # 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 mkennedy 1.1
172 mkennedy 1.2 elisp-compile() {
173 ulm 1.32 ebegin "Compiling GNU Emacs Elisp files"
174 ulm 1.43 ${EMACS} ${EMACSFLAGS} ${BYTECOMPFLAGS} -f batch-byte-compile "$@"
175 ulm 1.49 eend $? "elisp-compile: batch-byte-compile failed"
176 ulm 1.30 }
177    
178     elisp-comp() {
179 ulm 1.58 die "Function elisp-comp is not supported any more, see bug 235442"
180 opfer 1.22 }
181    
182 ulm 1.25 # @FUNCTION: elisp-emacs-version
183     # @DESCRIPTION:
184     # Output version of currently active Emacs.
185    
186 opfer 1.22 elisp-emacs-version() {
187 ulm 1.38 # The following will work for at least versions 18-23.
188 opfer 1.22 echo "(princ emacs-version)" >"${T}"/emacs-version.el
189 ulm 1.30 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
190 ulm 1.37 rm -f "${T}"/emacs-version.el
191 mkennedy 1.2 }
192    
193 ulm 1.25 # @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 ulm 1.29 elisp-make-autoload-file() {
199 opfer 1.17 local f="${1:-${PN}-autoloads.el}"
200 opfer 1.15 shift
201 ulm 1.32 ebegin "Generating autoload file for GNU Emacs"
202 opfer 1.22
203 ulm 1.21 sed 's/^FF/\f/' >"${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     FF
212     ;; Local Variables:
213     ;; version-control: never
214     ;; no-byte-compile: t
215     ;; no-update-autoloads: t
216     ;; End:
217     ;;; ${f##*/} ends here
218     EOF
219 opfer 1.22
220 ulm 1.30 ${EMACS} ${EMACSFLAGS} \
221 opfer 1.15 --eval "(setq make-backup-files nil)" \
222     --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
223     -f batch-update-autoloads "${@-.}"
224 ulm 1.32
225 ulm 1.49 eend $? "elisp-make-autoload-file: batch-update-autoloads failed"
226 opfer 1.15 }
227    
228 ulm 1.25 # @FUNCTION: elisp-install
229     # @USAGE: <subdirectory> <list of files>
230     # @DESCRIPTION:
231     # Install files in SITELISP directory.
232    
233 mkennedy 1.1 elisp-install() {
234 ulm 1.28 local subdir="$1"
235     shift
236 ulm 1.32 ebegin "Installing Elisp files for GNU Emacs support"
237 ulm 1.28 ( # subshell to avoid pollution of calling environment
238     insinto "${SITELISP}/${subdir}"
239     doins "$@"
240     )
241 ulm 1.49 eend $? "elisp-install: doins failed"
242 mkennedy 1.1 }
243    
244 ulm 1.25 # @FUNCTION: elisp-site-file-install
245     # @USAGE: <site-init file> [subdirectory]
246     # @DESCRIPTION:
247 ulm 1.59 # Install Emacs site-init file in SITELISP directory. Automatically
248     # inserts a standard comment header with the name of the package (unless
249     # it is already present). Tokens @SITELISP@ and @SITEETC@ are replaced
250     # by the path to the package's subdirectory in SITELISP and SITEETC,
251     # respectively.
252 ulm 1.25
253 mkennedy 1.1 elisp-site-file-install() {
254 ulm 1.59 local sf="${1##*/}" my_pn="${2:-${PN}}" ret
255     local header=";;; ${PN} site-lisp configuration"
256    
257     [[ ${sf} == [0-9][0-9]*-gentoo*.el ]] \
258     || ewarn "elisp-site-file-install: bad name of site-init file"
259     sf="${T}/${sf/%-gentoo*.el/-gentoo.el}"
260 ulm 1.32 ebegin "Installing site initialisation file for GNU Emacs"
261 ulm 1.60 [[ $1 = ${sf} ]] || cp "$1" "${sf}"
262 ulm 1.59 sed -i -e "1{:x;/^\$/{n;bx;};/^;.*${PN}/I!s:^:${header}\n\n:;1s:^:\n:;}" \
263     -e "s:@SITELISP@:${SITELISP}/${my_pn}:g" \
264 ulm 1.52 -e "s:@SITEETC@:${SITEETC}/${my_pn}:g;\$q" "${sf}"
265 ulm 1.28 ( # subshell to avoid pollution of calling environment
266 ulm 1.34 insinto "${SITELISP}/site-gentoo.d"
267 ulm 1.37 doins "${sf}"
268 ulm 1.28 )
269 ulm 1.37 ret=$?
270     rm -f "${sf}"
271 ulm 1.49 eend ${ret} "elisp-site-file-install: doins failed"
272 mkennedy 1.1 }
273    
274 ulm 1.25 # @FUNCTION: elisp-site-regen
275     # @DESCRIPTION:
276 ulm 1.58 # Regenerate the site-gentoo.el file, based on packages' site
277     # initialisation files in the /usr/share/emacs/site-lisp/site-gentoo.d/
278     # directory.
279     #
280     # Note: Before December 2007, site initialisation files were installed
281     # in /usr/share/emacs/site-lisp/. For backwards compatibility, this
282     # location is still supported when generating site-gentoo.el.
283 ulm 1.32
284 mkennedy 1.1 elisp-site-regen() {
285 ulm 1.60 local i sf line obsolete
286 ulm 1.32 local -a sflist
287 opfer 1.22
288 ulm 1.38 if [ ! -d "${ROOT}${SITELISP}" ]; then
289 ulm 1.49 eerror "elisp-site-regen: Directory ${SITELISP} does not exist"
290 ulm 1.38 return 1
291     fi
292    
293 ulm 1.55 if [ ! -d "${T}" ]; then
294     eerror "elisp-site-regen: Temporary directory ${T} does not exist"
295     return 1
296     fi
297    
298 ulm 1.60 einfon "Regenerating site-gentoo.el for GNU Emacs (${EBUILD_PHASE}) ..."
299 ulm 1.32
300 ulm 1.58 # Until January 2009, elisp-common.eclass sometimes created an
301     # auxiliary file for backwards compatibility. Remove any such file.
302 ulm 1.32 rm -f "${ROOT}${SITELISP}"/00site-gentoo.el
303    
304     # set nullglob option, there may be a directory without matching files
305     local old_shopts=$(shopt -p nullglob)
306     shopt -s nullglob
307    
308     for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el \
309     "${ROOT}${SITELISP}"/site-gentoo.d/[0-9][0-9]*.el
310     do
311     [ -r "${sf}" ] || continue
312     # sort files by their basename. straight insertion sort.
313     for ((i=${#sflist[@]}; i>0; i--)); do
314     [[ ${sf##*/} < ${sflist[i-1]##*/} ]] || break
315     sflist[i]=${sflist[i-1]}
316     done
317     sflist[i]=${sf}
318 ulm 1.34 # set a flag if there are obsolete files
319     [ "${sf%/*}" = "${ROOT}${SITELISP}" ] && obsolete=t
320 ulm 1.32 done
321    
322     eval "${old_shopts}"
323    
324 ulm 1.55 cat <<-EOF >"${T}"/site-gentoo.el
325 ulm 1.24 ;;; 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 ulm 1.50 # Use sed instead of cat here, since files may miss a trailing newline.
334 ulm 1.55 sed '$q' "${sflist[@]}" </dev/null >>"${T}"/site-gentoo.el
335     cat <<-EOF >>"${T}"/site-gentoo.el
336 ulm 1.24
337 ulm 1.28 (provide 'site-gentoo)
338    
339     ;; Local Variables:
340     ;; no-byte-compile: t
341     ;; End:
342 ulm 1.24 ;;; site-gentoo.el ends here
343     EOF
344    
345 ulm 1.55 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${T}"/site-gentoo.el
346 ulm 1.37 then
347 opfer 1.22 # This prevents outputting unnecessary text when there
348 ulm 1.29 # was actually no change.
349     # A case is a remerge where we have doubled output.
350 ulm 1.25 echo " no changes."
351 opfer 1.22 else
352 ulm 1.55 mv "${T}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
353 ulm 1.46 echo
354 ulm 1.47 einfo "... ${#sflist[@]} site initialisation file(s) included."
355     fi
356 ulm 1.32
357 ulm 1.41 if [ "${obsolete}" ]; then
358 ulm 1.46 echo
359 ulm 1.41 while read line; do ewarn "${line}"; done <<-EOF
360     Site-initialisation files of Emacs packages are now installed in
361     /usr/share/emacs/site-lisp/site-gentoo.d/. We strongly recommend
362 ulm 1.46 that you use app-admin/emacs-updater to rebuild the installed
363 ulm 1.41 Emacs packages.
364     EOF
365 opfer 1.22 fi
366 ulm 1.32
367 ulm 1.37 # cleanup
368 ulm 1.60 rm -f "${T}"/site-gentoo.el
369 ulm 1.45
370     return 0
371 mkennedy 1.3 }

  ViewVC Help
Powered by ViewVC 1.1.20