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

Contents of /eclass/elisp-common.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.68 - (hide annotations) (download)
Sat Oct 9 15:30:43 2010 UTC (3 years, 9 months ago) by ulm
Branch: MAIN
Changes since 1.67: +4 -2 lines
Add a comment about naming of site-init files.

1 ulm 1.66 # Copyright 1999-2010 Gentoo Foundation
2 mkennedy 1.1 # Distributed under the terms of the GNU General Public License v2
3 ulm 1.68 # $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.67 2010/09/17 07:41:05 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.66 # Copyright 2007-2010 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 ulm 1.68 # package, your site file's number must be higher! If there are no such
91     # interdependencies then the number should be 50. Otherwise, numbers
92     # divisible by 10 are preferred.
93 ulm 1.25 #
94 ulm 1.58 # Best practice is to define a SITEFILE variable in the global scope of
95     # your ebuild (e.g., right after S or RDEPEND):
96 opfer 1.15 #
97 ulm 1.58 # SITEFILE="50${PN}-gentoo.el"
98 opfer 1.15 #
99 ulm 1.25 # Which is then installed by
100 opfer 1.15 #
101 ulm 1.29 # elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
102 opfer 1.15 #
103 ulm 1.59 # in src_install(). Any characters after the "-gentoo" part and before
104     # the extension will be stripped from the destination file's name.
105     # For example, a file "50${PN}-gentoo-${PV}.el" will be installed as
106     # "50${PN}-gentoo.el". If your subdirectory is not named ${PN}, give
107     # the differing name as second argument.
108 opfer 1.15 #
109 ulm 1.25 # .SS
110 opfer 1.15 # pkg_postinst() / pkg_postrm() usage:
111     #
112 ulm 1.58 # After that you need to recreate the start-up file of Emacs after
113     # emerging and unmerging by using
114 opfer 1.15 #
115 ulm 1.26 # pkg_postinst() {
116     # elisp-site-regen
117     # }
118     #
119     # pkg_postrm() {
120     # elisp-site-regen
121     # }
122 opfer 1.15 #
123 ulm 1.58 # When having optional Emacs support, you should prepend "use emacs &&"
124     # to above calls of elisp-site-regen().
125     # Don't use "has_version virtual/emacs"! When unmerging the state of
126     # the emacs USE flag is taken from the package database and not from the
127     # environment, so it is no problem when you unset USE=emacs between
128     # merge and unmerge of a package.
129 opfer 1.22 #
130 ulm 1.25 # .SS
131 opfer 1.22 # Miscellaneous functions:
132     #
133     # elisp-emacs-version() outputs the version of the currently active Emacs.
134 mkennedy 1.1
135 ulm 1.29 # @ECLASS-VARIABLE: SITELISP
136     # @DESCRIPTION:
137 ulm 1.31 # Directory where packages install Emacs Lisp files.
138 mkennedy 1.1 SITELISP=/usr/share/emacs/site-lisp
139 ulm 1.29
140 ulm 1.48 # @ECLASS-VARIABLE: SITEETC
141     # @DESCRIPTION:
142 ulm 1.31 # Directory where packages install miscellaneous (not Lisp) files.
143     SITEETC=/usr/share/emacs/etc
144    
145 ulm 1.43 # @ECLASS-VARIABLE: EMACS
146     # @DESCRIPTION:
147     # Path of Emacs executable.
148 ulm 1.64 EMACS=${EPREFIX}/usr/bin/emacs
149 ulm 1.43
150     # @ECLASS-VARIABLE: EMACSFLAGS
151     # @DESCRIPTION:
152     # Flags for executing Emacs in batch mode.
153     # These work for Emacs versions 18-23, so don't change them.
154 ulm 1.30 EMACSFLAGS="-batch -q --no-site-file"
155 ulm 1.25
156 ulm 1.43 # @ECLASS-VARIABLE: BYTECOMPFLAGS
157     # @DESCRIPTION:
158     # Emacs flags used for byte-compilation in elisp-compile().
159     BYTECOMPFLAGS="-L ."
160    
161 ulm 1.25 # @FUNCTION: elisp-compile
162     # @USAGE: <list of elisp files>
163     # @DESCRIPTION:
164     # Byte-compile Emacs Lisp files.
165 ulm 1.43 #
166 ulm 1.58 # This function uses GNU Emacs to byte-compile all ".el" specified by
167     # its arguments. The resulting byte-code (".elc") files are placed in
168     # the same directory as their corresponding source file.
169     #
170     # The current directory is added to the load-path. This will ensure
171     # that interdependent Emacs Lisp files are visible between themselves,
172     # in case they require or load one another.
173 mkennedy 1.1
174 mkennedy 1.2 elisp-compile() {
175 ulm 1.32 ebegin "Compiling GNU Emacs Elisp files"
176 ulm 1.43 ${EMACS} ${EMACSFLAGS} ${BYTECOMPFLAGS} -f batch-byte-compile "$@"
177 ulm 1.49 eend $? "elisp-compile: batch-byte-compile failed"
178 ulm 1.30 }
179    
180     elisp-comp() {
181 ulm 1.58 die "Function elisp-comp is not supported any more, see bug 235442"
182 opfer 1.22 }
183    
184 ulm 1.25 # @FUNCTION: elisp-emacs-version
185     # @DESCRIPTION:
186     # Output version of currently active Emacs.
187    
188 opfer 1.22 elisp-emacs-version() {
189 ulm 1.38 # The following will work for at least versions 18-23.
190 opfer 1.22 echo "(princ emacs-version)" >"${T}"/emacs-version.el
191 ulm 1.30 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
192 ulm 1.37 rm -f "${T}"/emacs-version.el
193 mkennedy 1.2 }
194    
195 ulm 1.25 # @FUNCTION: elisp-make-autoload-file
196     # @USAGE: [output file] [list of directories]
197     # @DESCRIPTION:
198     # Generate a file with autoload definitions for the lisp functions.
199    
200 ulm 1.29 elisp-make-autoload-file() {
201 ulm 1.62 local f="${1:-${PN}-autoloads.el}" null="" page=$'\f'
202 opfer 1.15 shift
203 ulm 1.32 ebegin "Generating autoload file for GNU Emacs"
204 opfer 1.22
205 ulm 1.62 cat >"${f}" <<-EOF
206 ulm 1.67 ;;; ${f##*/} --- autoloads for ${PN}
207 ulm 1.21
208     ;;; Commentary:
209     ;; Automatically generated by elisp-common.eclass
210     ;; DO NOT EDIT THIS FILE
211    
212     ;;; Code:
213 ulm 1.62 ${page}
214     ;; Local ${null}Variables:
215 ulm 1.21 ;; version-control: never
216     ;; no-byte-compile: t
217     ;; no-update-autoloads: t
218     ;; End:
219 ulm 1.62
220 ulm 1.21 ;;; ${f##*/} ends here
221     EOF
222 opfer 1.22
223 ulm 1.30 ${EMACS} ${EMACSFLAGS} \
224 opfer 1.15 --eval "(setq make-backup-files nil)" \
225     --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
226     -f batch-update-autoloads "${@-.}"
227 ulm 1.32
228 ulm 1.49 eend $? "elisp-make-autoload-file: batch-update-autoloads failed"
229 opfer 1.15 }
230    
231 ulm 1.25 # @FUNCTION: elisp-install
232     # @USAGE: <subdirectory> <list of files>
233     # @DESCRIPTION:
234     # Install files in SITELISP directory.
235    
236 mkennedy 1.1 elisp-install() {
237 ulm 1.28 local subdir="$1"
238     shift
239 ulm 1.32 ebegin "Installing Elisp files for GNU Emacs support"
240 ulm 1.28 ( # subshell to avoid pollution of calling environment
241     insinto "${SITELISP}/${subdir}"
242     doins "$@"
243     )
244 ulm 1.49 eend $? "elisp-install: doins failed"
245 mkennedy 1.1 }
246    
247 ulm 1.25 # @FUNCTION: elisp-site-file-install
248     # @USAGE: <site-init file> [subdirectory]
249     # @DESCRIPTION:
250 ulm 1.59 # Install Emacs site-init file in SITELISP directory. Automatically
251     # inserts a standard comment header with the name of the package (unless
252     # it is already present). Tokens @SITELISP@ and @SITEETC@ are replaced
253     # by the path to the package's subdirectory in SITELISP and SITEETC,
254     # respectively.
255 ulm 1.25
256 mkennedy 1.1 elisp-site-file-install() {
257 ulm 1.59 local sf="${1##*/}" my_pn="${2:-${PN}}" ret
258     local header=";;; ${PN} site-lisp configuration"
259    
260     [[ ${sf} == [0-9][0-9]*-gentoo*.el ]] \
261     || ewarn "elisp-site-file-install: bad name of site-init file"
262     sf="${T}/${sf/%-gentoo*.el/-gentoo.el}"
263 ulm 1.32 ebegin "Installing site initialisation file for GNU Emacs"
264 ulm 1.60 [[ $1 = ${sf} ]] || cp "$1" "${sf}"
265 ulm 1.59 sed -i -e "1{:x;/^\$/{n;bx;};/^;.*${PN}/I!s:^:${header}\n\n:;1s:^:\n:;}" \
266 ulm 1.64 -e "s:@SITELISP@:${EPREFIX}${SITELISP}/${my_pn}:g" \
267     -e "s:@SITEETC@:${EPREFIX}${SITEETC}/${my_pn}:g;\$q" "${sf}"
268 ulm 1.28 ( # subshell to avoid pollution of calling environment
269 ulm 1.34 insinto "${SITELISP}/site-gentoo.d"
270 ulm 1.37 doins "${sf}"
271 ulm 1.28 )
272 ulm 1.37 ret=$?
273     rm -f "${sf}"
274 ulm 1.49 eend ${ret} "elisp-site-file-install: doins failed"
275 mkennedy 1.1 }
276    
277 ulm 1.25 # @FUNCTION: elisp-site-regen
278     # @DESCRIPTION:
279 ulm 1.58 # Regenerate the site-gentoo.el file, based on packages' site
280     # initialisation files in the /usr/share/emacs/site-lisp/site-gentoo.d/
281     # directory.
282     #
283     # Note: Before December 2007, site initialisation files were installed
284     # in /usr/share/emacs/site-lisp/. For backwards compatibility, this
285     # location is still supported when generating site-gentoo.el.
286 ulm 1.32
287 mkennedy 1.1 elisp-site-regen() {
288 ulm 1.64 local sitelisp=${ROOT}${EPREFIX}${SITELISP}
289 ulm 1.65 local sf i line null="" page=$'\f'
290 ulm 1.32 local -a sflist
291 opfer 1.22
292 ulm 1.64 if [ ! -d "${sitelisp}" ]; then
293     eerror "elisp-site-regen: Directory ${sitelisp} does not exist"
294 ulm 1.38 return 1
295     fi
296    
297 ulm 1.55 if [ ! -d "${T}" ]; then
298     eerror "elisp-site-regen: Temporary directory ${T} does not exist"
299     return 1
300     fi
301    
302 ulm 1.60 einfon "Regenerating site-gentoo.el for GNU Emacs (${EBUILD_PHASE}) ..."
303 ulm 1.32
304 ulm 1.58 # Until January 2009, elisp-common.eclass sometimes created an
305     # auxiliary file for backwards compatibility. Remove any such file.
306 ulm 1.64 rm -f "${sitelisp}"/00site-gentoo.el
307 ulm 1.32
308 ulm 1.64 for sf in "${sitelisp}"/[0-9][0-9]*-gentoo.el \
309     "${sitelisp}"/site-gentoo.d/[0-9][0-9]*.el
310 ulm 1.32 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     done
319    
320 ulm 1.55 cat <<-EOF >"${T}"/site-gentoo.el
321 ulm 1.24 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
322    
323     ;;; Commentary:
324     ;; Automatically generated by elisp-common.eclass
325     ;; DO NOT EDIT THIS FILE
326    
327     ;;; Code:
328     EOF
329 ulm 1.50 # Use sed instead of cat here, since files may miss a trailing newline.
330 ulm 1.55 sed '$q' "${sflist[@]}" </dev/null >>"${T}"/site-gentoo.el
331     cat <<-EOF >>"${T}"/site-gentoo.el
332 ulm 1.24
333 ulm 1.28 (provide 'site-gentoo)
334    
335 ulm 1.62 ${page}
336     ;; Local ${null}Variables:
337 ulm 1.28 ;; no-byte-compile: t
338 ulm 1.62 ;; buffer-read-only: t
339 ulm 1.28 ;; End:
340 ulm 1.62
341 ulm 1.24 ;;; site-gentoo.el ends here
342     EOF
343    
344 ulm 1.64 if cmp -s "${sitelisp}"/site-gentoo.el "${T}"/site-gentoo.el; then
345 opfer 1.22 # This prevents outputting unnecessary text when there
346 ulm 1.29 # was actually no change.
347     # A case is a remerge where we have doubled output.
348 ulm 1.66 rm -f "${T}"/site-gentoo.el
349 ulm 1.25 echo " no changes."
350 opfer 1.22 else
351 ulm 1.64 mv "${T}"/site-gentoo.el "${sitelisp}"/site-gentoo.el
352 ulm 1.46 echo
353 ulm 1.63 case ${#sflist[@]} in
354     0) ewarn "... Huh? No site initialisation files found." ;;
355     1) einfo "... ${#sflist[@]} site initialisation file included." ;;
356     *) einfo "... ${#sflist[@]} site initialisation files included." ;;
357     esac
358 ulm 1.47 fi
359 ulm 1.32
360 ulm 1.45 return 0
361 mkennedy 1.3 }

  ViewVC Help
Powered by ViewVC 1.1.20