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

Legend:
Removed from v.1.40  
changed lines
  Added in v.1.81

  ViewVC Help
Powered by ViewVC 1.1.20