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

Legend:
Removed from v.1.37  
changed lines
  Added in v.1.93

  ViewVC Help
Powered by ViewVC 1.1.20