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

Diff of /eclass/elisp-common.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.50 Revision 1.70
1# Copyright 1999-2008 Gentoo Foundation 1# Copyright 1999-2010 Gentoo Foundation
2# Distributed under the terms of the GNU General Public License v2 2# Distributed under the terms of the GNU General Public License v2
3# $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.50 2008/10/16 09:28:58 ulm Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.70 2010/11/29 17:07:22 ulm Exp $
4# 4#
5# Copyright 2002-2004 Matthew Kennedy <mkennedy@gentoo.org> 5# Copyright 2002-2004 Matthew Kennedy <mkennedy@gentoo.org>
6# Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com> 6# Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com>
7# Copyright 2004-2005 Mamoru Komachi <usata@gentoo.org> 7# Copyright 2004-2005 Mamoru Komachi <usata@gentoo.org>
8# Copyright 2007-2008 Christian Faulhammer <opfer@gentoo.org> 8# Copyright 2007-2008 Christian Faulhammer <fauli@gentoo.org>
9# Copyright 2007-2008 Ulrich Müller <ulm@gentoo.org> 9# Copyright 2007-2010 Ulrich Müller <ulm@gentoo.org>
10# 10#
11# @ECLASS: elisp-common.eclass 11# @ECLASS: elisp-common.eclass
12# @MAINTAINER: 12# @MAINTAINER:
13# Feel free to contact the Emacs team through <emacs@gentoo.org> if you have 13# Feel free to contact the Emacs team through <emacs@gentoo.org> if you
14# problems, suggestions or questions. 14# have problems, suggestions or questions.
15# @BLURB: Emacs-related installation utilities 15# @BLURB: Emacs-related installation utilities
16# @DESCRIPTION: 16# @DESCRIPTION:
17# 17#
18# Usually you want to use this eclass for (optional) GNU Emacs support of 18# Usually you want to use this eclass for (optional) GNU Emacs support
19# your package. This is NOT for XEmacs! 19# of your package. This is NOT for XEmacs!
20# 20#
21# Many of the steps here are sometimes done by the build system of your 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 elisp 22# package (especially compilation), so this is mainly for standalone
23# files you gathered from somewhere else. 23# elisp files you gathered from somewhere else.
24# 24#
25# When relying on the emacs USE flag, you need to add 25# When relying on the emacs USE flag, you need to add
26# 26#
27# emacs? ( virtual/emacs ) 27# emacs? ( virtual/emacs )
28# 28#
29# to your DEPEND/RDEPEND line and use the functions provided here to bring 29# to your DEPEND/RDEPEND line and use the functions provided here to
30# the files to the correct locations. 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.
31# 44#
32# .SS 45# .SS
33# src_compile() usage: 46# src_compile() usage:
34# 47#
35# An elisp file is compiled by the elisp-compile() function defined here and 48# An elisp file is compiled by the elisp-compile() function defined
36# simply takes the source files as arguments. The case of interdependent 49# here and simply takes the source files as arguments. The case of
37# elisp files is also supported, since the current directory is added to the 50# interdependent elisp files is also supported, since the current
38# load-path which makes sure that all files are loadable. 51# directory is added to the load-path which makes sure that all files
52# are loadable.
39# 53#
40# elisp-compile *.el || die 54# elisp-compile *.el || die
41# 55#
42# Formerly, function elisp-comp() was used for compilation of interdependent
43# elisp files. This usage is considered as obsolete.
44#
45# Function elisp-make-autoload-file() can be used to generate a file with 56# Function elisp-make-autoload-file() can be used to generate a file
46# autoload definitions for the lisp functions. It takes the output file name 57# with autoload definitions for the lisp functions. It takes the output
47# (default: "${PN}-autoloads.el") and a list of directories (default: working 58# file name (default: "${PN}-autoloads.el") and a list of directories
48# directory) as its arguments. Use of this function requires that the elisp 59# (default: working directory) as its arguments. Use of this function
49# source files contain magic ";;;###autoload" comments. See the Emacs Lisp 60# requires that the elisp source files contain magic ";;;###autoload"
50# Reference Manual (node "Autoload") for a detailed explanation. 61# comments. See the Emacs Lisp Reference Manual (node "Autoload") for
62# a detailed explanation.
51# 63#
52# .SS 64# .SS
53# src_install() usage: 65# src_install() usage:
54# 66#
55# The resulting compiled files (.elc) should be put in a subdirectory of 67# 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 68# /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 69# of elisp-install(). The following parameters are the files to be put
58# that directory. Usually the subdirectory should be ${PN}, you can choose 70# in that directory. Usually the subdirectory should be ${PN}, you can
59# something else, but remember to tell elisp-site-file-install() (see below) 71# choose something else, but remember to tell elisp-site-file-install()
60# the change, as it defaults to ${PN}. 72# (see below) the change, as it defaults to ${PN}.
61# 73#
62# elisp-install ${PN} *.el *.elc || die 74# elisp-install ${PN} *.el *.elc || die
63# 75#
64# To let the Emacs support be activated by Emacs on startup, you need 76# To let the Emacs support be activated by Emacs on startup, you need
65# to provide a site file (shipped in ${FILESDIR}) which contains the startup 77# to provide a site file (shipped in ${FILESDIR}) which contains the
66# code (have a look in the documentation of your software). Normally this 78# startup code (have a look in the documentation of your software).
67# would look like this: 79# Normally this would look like this:
68#
69# ;;; csv-mode site-lisp configuration
70# 80#
71# (add-to-list 'load-path "@SITELISP@") 81# (add-to-list 'load-path "@SITELISP@")
72# (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode)) 82# (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode))
73# (autoload 'csv-mode "csv-mode" "Major mode for csv files." t) 83# (autoload 'csv-mode "csv-mode" "Major mode for csv files." t)
74# 84#
75# If your Emacs support files are installed in a subdirectory of 85# If your Emacs support files are installed in a subdirectory of
76# /usr/share/emacs/site-lisp/ (which is recommended), you need to extend 86# /usr/share/emacs/site-lisp/ (which is strongly recommended), you need
77# Emacs' load-path as shown in the first non-comment. 87# to extend Emacs' load-path as shown in the first non-comment line.
78# The elisp-site-file-install() function of this eclass will replace 88# The elisp-site-file-install() function of this eclass will replace
79# "@SITELISP@" by the actual path. 89# "@SITELISP@" and "@SITEETC@" by the actual paths.
80# 90#
81# The next line tells Emacs to load the mode opening a file ending with 91# The next line tells Emacs to load the mode opening a file ending
82# ".csv" and load functions depending on the context and needed features. 92# with ".csv" and load functions depending on the context and needed
83# Be careful though. Commands as "load-library" or "require" bloat the 93# features. Be careful though. Commands as "load-library" or "require"
84# editor as they are loaded on every startup. When having a lot of Emacs 94# bloat the editor as they are loaded on every startup. When having
85# support files, users may be annoyed by the start-up time. Also avoid 95# many Emacs support files, users may be annoyed by the start-up time.
86# keybindings as they might interfere with the user's settings. Give a hint 96# Also avoid keybindings as they might interfere with the user's
87# in pkg_postinst(), which should be enough. 97# settings. Give a hint in pkg_postinst(), which should be enough.
88# 98#
89# The naming scheme for this site-init file matches the shell pattern 99# The naming scheme for this site-init file matches the shell pattern
90# "[1-8][0-9]*-gentoo.el", where the two digits at the beginning define the 100# "[1-8][0-9]*-gentoo*.el", where the two digits at the beginning define
91# loading order (numbers below 10 or above 89 are reserved for internal use). 101# the loading order (numbers below 10 or above 89 are reserved for
92# So if you depend on another Emacs package, your site file's number must be 102# internal use). So if your initialisation depends on another Emacs
93# higher! 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.
94# 106#
95# Best practice is to define a SITEFILE variable in the global scope of your 107# Best practice is to define a SITEFILE variable in the global scope of
96# ebuild (e.g., right after DEPEND): 108# your ebuild (e.g., right after S or RDEPEND):
97# 109#
98# SITEFILE=50${PN}-gentoo.el 110# SITEFILE="50${PN}-gentoo.el"
99# 111#
100# Which is then installed by 112# Which is then installed by
101# 113#
102# elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die 114# elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
103# 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
104# in src_install(). If your subdirectory is not named ${PN}, give the 119# "50${PN}-gentoo.el". If your subdirectory is not named ${PN}, give
105# differing name as second argument. 120# the differing name as second argument.
106# 121#
107# .SS 122# .SS
108# pkg_postinst() / pkg_postrm() usage: 123# pkg_postinst() / pkg_postrm() usage:
109# 124#
110# After that you need to recreate the start-up file of Emacs after emerging 125# After that you need to recreate the start-up file of Emacs after
111# and unmerging by using 126# emerging and unmerging by using
112# 127#
113# pkg_postinst() { 128# pkg_postinst() {
114# elisp-site-regen 129# elisp-site-regen
115# } 130# }
116# 131#
117# pkg_postrm() { 132# pkg_postrm() {
118# elisp-site-regen 133# elisp-site-regen
119# } 134# }
120# 135#
121# When having optional Emacs support, you should prepend "use emacs &&" to 136# When having optional Emacs support, you should prepend "use emacs &&"
122# above calls of elisp-site-regen(). Don't use "has_version virtual/emacs"! 137# to above calls of elisp-site-regen().
123# When unmerging the state of the emacs USE flag is taken from the package 138# Don't use "has_version virtual/emacs"! When unmerging the state of
124# database and not from the environment, so it is no problem when you unset 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
125# USE=emacs between merge and unmerge of a package. 141# merge and unmerge of a package.
126#
127# .SS
128# Miscellaneous functions:
129#
130# elisp-emacs-version() outputs the version of the currently active Emacs.
131 142
132# @ECLASS-VARIABLE: SITELISP 143# @ECLASS-VARIABLE: SITELISP
133# @DESCRIPTION: 144# @DESCRIPTION:
134# Directory where packages install Emacs Lisp files. 145# Directory where packages install Emacs Lisp files.
135SITELISP=/usr/share/emacs/site-lisp 146SITELISP=/usr/share/emacs/site-lisp
137# @ECLASS-VARIABLE: SITEETC 148# @ECLASS-VARIABLE: SITEETC
138# @DESCRIPTION: 149# @DESCRIPTION:
139# Directory where packages install miscellaneous (not Lisp) files. 150# Directory where packages install miscellaneous (not Lisp) files.
140SITEETC=/usr/share/emacs/etc 151SITEETC=/usr/share/emacs/etc
141 152
142# @ECLASS-VARIABLE: SITEFILE
143# @DESCRIPTION:
144# Name of package's site-init file.
145SITEFILE=50${PN}-gentoo.el
146
147# @ECLASS-VARIABLE: EMACS 153# @ECLASS-VARIABLE: EMACS
148# @DESCRIPTION: 154# @DESCRIPTION:
149# Path of Emacs executable. 155# Path of Emacs executable.
150EMACS=/usr/bin/emacs 156EMACS=${EPREFIX}/usr/bin/emacs
151 157
152# @ECLASS-VARIABLE: EMACSFLAGS 158# @ECLASS-VARIABLE: EMACSFLAGS
153# @DESCRIPTION: 159# @DESCRIPTION:
154# Flags for executing Emacs in batch mode. 160# Flags for executing Emacs in batch mode.
155# These work for Emacs versions 18-23, so don't change them. 161# These work for Emacs versions 18-23, so don't change them.
157 163
158# @ECLASS-VARIABLE: BYTECOMPFLAGS 164# @ECLASS-VARIABLE: BYTECOMPFLAGS
159# @DESCRIPTION: 165# @DESCRIPTION:
160# Emacs flags used for byte-compilation in elisp-compile(). 166# Emacs flags used for byte-compilation in elisp-compile().
161BYTECOMPFLAGS="-L ." 167BYTECOMPFLAGS="-L ."
162
163# @FUNCTION: elisp-compile
164# @USAGE: <list of elisp files>
165# @DESCRIPTION:
166# Byte-compile Emacs Lisp files.
167#
168# This function uses GNU Emacs to byte-compile all ".el" specified by its
169# arguments. The resulting byte-code (".elc") files are placed in the same
170# directory as their corresponding source file.
171#
172# The current directory is added to the load-path. This will ensure that
173# interdependent Emacs Lisp files are visible between themselves, in case
174# they require or load one another.
175
176elisp-compile() {
177 ebegin "Compiling GNU Emacs Elisp files"
178 ${EMACS} ${EMACSFLAGS} ${BYTECOMPFLAGS} -f batch-byte-compile "$@"
179 eend $? "elisp-compile: batch-byte-compile failed"
180}
181
182# #FUNCTION: elisp-comp
183# #USAGE: <list of elisp files>
184# #DESCRIPTION:
185# Byte-compile interdependent Emacs Lisp files.
186# THIS FUNCTION IS DEPRECATED.
187#
188# This function byte-compiles all ".el" files which are part of its
189# arguments, using GNU Emacs, and puts the resulting ".elc" files into the
190# current directory, so disregarding the original directories used in ".el"
191# arguments.
192#
193# This function manages in such a way that all Emacs Lisp files to be
194# compiled are made visible between themselves, in the event they require or
195# load one another.
196
197elisp-comp() {
198 # Copyright 1995 Free Software Foundation, Inc.
199 # François Pinard <pinard@iro.umontreal.ca>, 1995.
200 # Originally taken from GNU autotools.
201
202 ewarn "Function elisp-comp is deprecated and may be removed in future."
203 ewarn "Please use function elisp-compile instead, or report a bug about"
204 ewarn "${CATEGORY}/${PF} at <http://bugs.gentoo.org/>."
205 echo
206
207 [ $# -gt 0 ] || return 1
208
209 ebegin "Compiling GNU Emacs Elisp files"
210
211 local tempdir=elc.$$
212 mkdir ${tempdir}
213 cp "$@" ${tempdir}
214 pushd ${tempdir}
215
216 echo "(add-to-list 'load-path \"../\")" > script
217 ${EMACS} ${EMACSFLAGS} -l script -f batch-byte-compile *.el
218 local ret=$?
219 mv *.elc ..
220
221 popd
222 rm -fr ${tempdir}
223
224 eend ${ret} "elisp-comp: batch-byte-compile failed"
225}
226 168
227# @FUNCTION: elisp-emacs-version 169# @FUNCTION: elisp-emacs-version
228# @DESCRIPTION: 170# @DESCRIPTION:
229# Output version of currently active Emacs. 171# Output version of currently active Emacs.
230 172
233 echo "(princ emacs-version)" >"${T}"/emacs-version.el 175 echo "(princ emacs-version)" >"${T}"/emacs-version.el
234 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el 176 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
235 rm -f "${T}"/emacs-version.el 177 rm -f "${T}"/emacs-version.el
236} 178}
237 179
180# @FUNCTION: elisp-need-emacs
181# @USAGE: <version>
182# @RETURN: 0 if true, 1 otherwise
183# @DESCRIPTION:
184# Test if the eselected Emacs version is at least the major version
185# specified as argument.
186
187elisp-need-emacs() {
188 local need_emacs=$1
189 local have_emacs=$(elisp-emacs-version)
190 einfo "Emacs version: ${have_emacs}"
191 if ! [[ ${have_emacs%%.*} -ge ${need_emacs%%.*} ]]; then
192 eerror "This package needs at least Emacs ${need_emacs%%.*}."
193 eerror "Use \"eselect emacs\" to select the active version."
194 return 1
195 fi
196 return 0
197}
198
199# @FUNCTION: elisp-compile
200# @USAGE: <list of elisp files>
201# @DESCRIPTION:
202# Byte-compile Emacs Lisp files.
203#
204# This function uses GNU Emacs to byte-compile all ".el" specified by
205# its arguments. The resulting byte-code (".elc") files are placed in
206# the same directory as their corresponding source file.
207#
208# The current directory is added to the load-path. This will ensure
209# that interdependent Emacs Lisp files are visible between themselves,
210# in case they require or load one another.
211
212elisp-compile() {
213 ebegin "Compiling GNU Emacs Elisp files"
214 ${EMACS} ${EMACSFLAGS} ${BYTECOMPFLAGS} -f batch-byte-compile "$@"
215 eend $? "elisp-compile: batch-byte-compile failed"
216}
217
238# @FUNCTION: elisp-make-autoload-file 218# @FUNCTION: elisp-make-autoload-file
239# @USAGE: [output file] [list of directories] 219# @USAGE: [output file] [list of directories]
240# @DESCRIPTION: 220# @DESCRIPTION:
241# Generate a file with autoload definitions for the lisp functions. 221# Generate a file with autoload definitions for the lisp functions.
242 222
243elisp-make-autoload-file() { 223elisp-make-autoload-file() {
244 local f="${1:-${PN}-autoloads.el}" 224 local f="${1:-${PN}-autoloads.el}" null="" page=$'\f'
245 shift 225 shift
246 ebegin "Generating autoload file for GNU Emacs" 226 ebegin "Generating autoload file for GNU Emacs"
247 227
248 sed 's/^FF/\f/' >"${f}" <<-EOF 228 cat >"${f}" <<-EOF
249 ;;; ${f##*/} --- autoloads for ${P} 229 ;;; ${f##*/} --- autoloads for ${PN}
250 230
251 ;;; Commentary: 231 ;;; Commentary:
252 ;; Automatically generated by elisp-common.eclass 232 ;; Automatically generated by elisp-common.eclass
253 ;; DO NOT EDIT THIS FILE 233 ;; DO NOT EDIT THIS FILE
254 234
255 ;;; Code: 235 ;;; Code:
256 FF 236 ${page}
257 ;; Local Variables: 237 ;; Local ${null}Variables:
258 ;; version-control: never 238 ;; version-control: never
259 ;; no-byte-compile: t 239 ;; no-byte-compile: t
260 ;; no-update-autoloads: t 240 ;; no-update-autoloads: t
261 ;; End: 241 ;; End:
242
262 ;;; ${f##*/} ends here 243 ;;; ${f##*/} ends here
263 EOF 244 EOF
264 245
265 ${EMACS} ${EMACSFLAGS} \ 246 ${EMACS} ${EMACSFLAGS} \
266 --eval "(setq make-backup-files nil)" \ 247 --eval "(setq make-backup-files nil)" \
287} 268}
288 269
289# @FUNCTION: elisp-site-file-install 270# @FUNCTION: elisp-site-file-install
290# @USAGE: <site-init file> [subdirectory] 271# @USAGE: <site-init file> [subdirectory]
291# @DESCRIPTION: 272# @DESCRIPTION:
292# Install Emacs site-init file in SITELISP directory. 273# Install Emacs site-init file in SITELISP directory. Automatically
274# inserts a standard comment header with the name of the package (unless
275# it is already present). Tokens @SITELISP@ and @SITEETC@ are replaced
276# by the path to the package's subdirectory in SITELISP and SITEETC,
277# respectively.
293 278
294elisp-site-file-install() { 279elisp-site-file-install() {
295 local sf="${T}/${1##*/}" my_pn="${2:-${PN}}" ret 280 local sf="${1##*/}" my_pn="${2:-${PN}}" ret
281 local header=";;; ${PN} site-lisp configuration"
282
283 [[ ${sf} == [0-9][0-9]*-gentoo*.el ]] \
284 || ewarn "elisp-site-file-install: bad name of site-init file"
285 sf="${T}/${sf/%-gentoo*.el/-gentoo.el}"
296 ebegin "Installing site initialisation file for GNU Emacs" 286 ebegin "Installing site initialisation file for GNU Emacs"
297 cp "$1" "${sf}" 287 [[ $1 = ${sf} ]] || cp "$1" "${sf}"
288 sed -i -e "1{:x;/^\$/{n;bx;};/^;.*${PN}/I!s:^:${header}\n\n:;1s:^:\n:;}" \
298 sed -i -e "s:@SITELISP@:${SITELISP}/${my_pn}:g" \ 289 -e "s:@SITELISP@:${EPREFIX}${SITELISP}/${my_pn}:g" \
299 -e "s:@SITEETC@:${SITEETC}/${my_pn}:g" "${sf}" 290 -e "s:@SITEETC@:${EPREFIX}${SITEETC}/${my_pn}:g;\$q" "${sf}"
300 ( # subshell to avoid pollution of calling environment 291 ( # subshell to avoid pollution of calling environment
301 insinto "${SITELISP}/site-gentoo.d" 292 insinto "${SITELISP}/site-gentoo.d"
302 doins "${sf}" 293 doins "${sf}"
303 ) 294 )
304 ret=$? 295 ret=$?
306 eend ${ret} "elisp-site-file-install: doins failed" 297 eend ${ret} "elisp-site-file-install: doins failed"
307} 298}
308 299
309# @FUNCTION: elisp-site-regen 300# @FUNCTION: elisp-site-regen
310# @DESCRIPTION: 301# @DESCRIPTION:
311# Regenerate the site-gentoo.el file, based on packages' site initialisation 302# Regenerate the site-gentoo.el file, based on packages' site
312# files in the /usr/share/emacs/site-lisp/site-gentoo.d/ directory. 303# initialisation files in the /usr/share/emacs/site-lisp/site-gentoo.d/
304# directory.
313# 305#
314# Note: Before December 2007, site initialisation files were installed in 306# Note: Before December 2007, site initialisation files were installed
315# /usr/share/emacs/site-lisp/. For backwards compatibility, this location is 307# in /usr/share/emacs/site-lisp/. For backwards compatibility, this
316# still supported when generating site-gentoo.el. 308# location is still supported when generating site-gentoo.el.
317 309
318elisp-site-regen() { 310elisp-site-regen() {
319 local i sf line firstrun obsolete 311 local sitelisp=${ROOT}${EPREFIX}${SITELISP}
312 local sf i line null="" page=$'\f'
320 local -a sflist 313 local -a sflist
321 # Work around Paludis borkage: variable T is empty in pkg_postrm
322 local tmpdir=${T:-$(mktemp -d)}
323 314
324 if [ ! -d "${ROOT}${SITELISP}" ]; then 315 if [ ! -d "${sitelisp}" ]; then
325 eerror "elisp-site-regen: Directory ${SITELISP} does not exist" 316 eerror "elisp-site-regen: Directory ${sitelisp} does not exist"
326 return 1 317 return 1
327 fi 318 fi
328 319
329 [ -e "${ROOT}${SITELISP}"/site-gentoo.el ] || firstrun=t 320 if [ ! -d "${T}" ]; then
330 321 eerror "elisp-site-regen: Temporary directory ${T} does not exist"
331 if [ "${firstrun}" ] && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then 322 return 1
332 einfo "Creating default ${SITELISP}/site-start.el ..."
333 cat <<-EOF >"${tmpdir}"/site-start.el
334 ;;; site-start.el
335
336 ;;; Commentary:
337 ;; This default site startup file is installed by elisp-common.eclass.
338 ;; You may replace this file by your own site initialisation, or even
339 ;; remove it completely; it will not be recreated.
340
341 ;;; Code:
342 ;; Load site initialisation for Gentoo-installed packages.
343 (require 'site-gentoo)
344
345 ;;; site-start.el ends here
346 EOF
347 fi 323 fi
348 324
349 einfon "Regenerating ${SITELISP}/site-gentoo.el ..." 325 einfon "Regenerating site-gentoo.el for GNU Emacs (${EBUILD_PHASE}) ..."
350 326
351 # remove any auxiliary file (from previous run) 327 # Until January 2009, elisp-common.eclass sometimes created an
352 rm -f "${ROOT}${SITELISP}"/00site-gentoo.el 328 # auxiliary file for backwards compatibility. Remove any such file.
329 rm -f "${sitelisp}"/00site-gentoo.el
353 330
354 # set nullglob option, there may be a directory without matching files
355 local old_shopts=$(shopt -p nullglob)
356 shopt -s nullglob
357
358 for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el \ 331 for sf in "${sitelisp}"/[0-9][0-9]*-gentoo.el \
359 "${ROOT}${SITELISP}"/site-gentoo.d/[0-9][0-9]*.el 332 "${sitelisp}"/site-gentoo.d/[0-9][0-9]*.el
360 do 333 do
361 [ -r "${sf}" ] || continue 334 [ -r "${sf}" ] || continue
362 # sort files by their basename. straight insertion sort. 335 # sort files by their basename. straight insertion sort.
363 for ((i=${#sflist[@]}; i>0; i--)); do 336 for ((i=${#sflist[@]}; i>0; i--)); do
364 [[ ${sf##*/} < ${sflist[i-1]##*/} ]] || break 337 [[ ${sf##*/} < ${sflist[i-1]##*/} ]] || break
365 sflist[i]=${sflist[i-1]} 338 sflist[i]=${sflist[i-1]}
366 done 339 done
367 sflist[i]=${sf} 340 sflist[i]=${sf}
368 # set a flag if there are obsolete files
369 [ "${sf%/*}" = "${ROOT}${SITELISP}" ] && obsolete=t
370 done 341 done
371 342
372 eval "${old_shopts}"
373
374 cat <<-EOF >"${tmpdir}"/site-gentoo.el 343 cat <<-EOF >"${T}"/site-gentoo.el
375 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages 344 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
376 345
377 ;;; Commentary: 346 ;;; Commentary:
378 ;; Automatically generated by elisp-common.eclass 347 ;; Automatically generated by elisp-common.eclass
379 ;; DO NOT EDIT THIS FILE 348 ;; DO NOT EDIT THIS FILE
380 349
381 ;;; Code: 350 ;;; Code:
382 EOF 351 EOF
383 # Use sed instead of cat here, since files may miss a trailing newline. 352 # Use sed instead of cat here, since files may miss a trailing newline.
384 sed '$q' "${sflist[@]}" </dev/null >>"${tmpdir}"/site-gentoo.el 353 sed '$q' "${sflist[@]}" </dev/null >>"${T}"/site-gentoo.el
385 cat <<-EOF >>"${tmpdir}"/site-gentoo.el 354 cat <<-EOF >>"${T}"/site-gentoo.el
386 355
356 ${page}
387 (provide 'site-gentoo) 357 (provide 'site-gentoo)
388 358
389 ;; Local Variables: 359 ;; Local ${null}Variables:
390 ;; no-byte-compile: t 360 ;; no-byte-compile: t
361 ;; buffer-read-only: t
391 ;; End: 362 ;; End:
363
392 ;;; site-gentoo.el ends here 364 ;;; site-gentoo.el ends here
393 EOF 365 EOF
394 366
395 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${tmpdir}"/site-gentoo.el 367 if cmp -s "${sitelisp}"/site-gentoo.el "${T}"/site-gentoo.el; then
396 then
397 # This prevents outputting unnecessary text when there 368 # This prevents outputting unnecessary text when there
398 # was actually no change. 369 # was actually no change.
399 # A case is a remerge where we have doubled output. 370 # A case is a remerge where we have doubled output.
371 rm -f "${T}"/site-gentoo.el
400 echo " no changes." 372 echo " no changes."
401 else 373 else
402 mv "${tmpdir}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el 374 mv "${T}"/site-gentoo.el "${sitelisp}"/site-gentoo.el
403 [ -f "${tmpdir}"/site-start.el ] \
404 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \
405 && mv "${tmpdir}"/site-start.el "${ROOT}${SITELISP}"/site-start.el
406 echo 375 echo
376 case ${#sflist[@]} in
377 0) ewarn "... Huh? No site initialisation files found." ;;
378 1) einfo "... ${#sflist[@]} site initialisation file included." ;;
407 einfo "... ${#sflist[@]} site initialisation file(s) included." 379 *) einfo "... ${#sflist[@]} site initialisation files included." ;;
380 esac
408 fi 381 fi
409 382
410 if [ "${firstrun}" ]; then
411 echo
412 while read line; do einfo "${line:- }"; done <<-EOF
413 All site initialisation for Gentoo-installed packages is added to
414 /usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is not
415 managed by Gentoo. You are responsible for all maintenance of
416 site-start.el if there is such a file.
417
418 In order for this site initialisation to be loaded for all users
419 automatically, you can add a line like this:
420
421 (require 'site-gentoo)
422
423 to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
424 can be added by individual users to their initialisation files, or,
425 for greater flexibility, users can load individual package-specific
426 initialisation files from /usr/share/emacs/site-lisp/site-gentoo.d/.
427 EOF
428 echo
429 fi
430
431 if [ "${obsolete}" ]; then
432 echo
433 while read line; do ewarn "${line}"; done <<-EOF
434 Site-initialisation files of Emacs packages are now installed in
435 /usr/share/emacs/site-lisp/site-gentoo.d/. We strongly recommend
436 that you use app-admin/emacs-updater to rebuild the installed
437 Emacs packages.
438 EOF
439
440 # Kludge for backwards compatibility: During pkg_postrm, old versions
441 # of this eclass (saved in the VDB) won't find packages' site-init
442 # files in the new location. So we copy them to an auxiliary file
443 # that is visible to old eclass versions.
444 for sf in "${sflist[@]}"; do
445 [ "${sf%/*}" = "${ROOT}${SITELISP}/site-gentoo.d" ] \
446 && cat "${sf}" >>"${ROOT}${SITELISP}"/00site-gentoo.el
447 done
448 fi
449
450 # cleanup
451 rm -f "${tmpdir}"/site-{gentoo,start}.el
452
453 return 0 383 return 0
454} 384}

Legend:
Removed from v.1.50  
changed lines
  Added in v.1.70

  ViewVC Help
Powered by ViewVC 1.1.20