/[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.30 Revision 1.40
1# Copyright 1999-2007 Gentoo Foundation 1# Copyright 1999-2008 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.30 2007/11/17 15:39:35 ulm Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.40 2008/05/18 06:15:12 ulm Exp $
4# 4#
5# Copyright 2007 Christian Faulhammer <opfer@gentoo.org>
6# 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>
7# Copyright 2004-2005 Mamoru Komachi <usata@gentoo.org> 7# Copyright 2004-2005 Mamoru Komachi <usata@gentoo.org>
8# Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com> 8# Copyright 2007-2008 Christian Faulhammer <opfer@gentoo.org>
9# Copyright 2007 Ulrich Mueller <ulm@gentoo.org> 9# Copyright 2007-2008 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 have
14# problems, suggestions or questions. 14# problems, suggestions or questions.
127# 127#
128# elisp-emacs-version() outputs the version of the currently active Emacs. 128# elisp-emacs-version() outputs the version of the currently active Emacs.
129 129
130# @ECLASS-VARIABLE: SITELISP 130# @ECLASS-VARIABLE: SITELISP
131# @DESCRIPTION: 131# @DESCRIPTION:
132# Directory where Emacs Lisp files are installed. 132# Directory where packages install Emacs Lisp files.
133SITELISP=/usr/share/emacs/site-lisp 133SITELISP=/usr/share/emacs/site-lisp
134
135# Directory where packages install miscellaneous (not Lisp) files.
136SITEETC=/usr/share/emacs/etc
134 137
135# @ECLASS-VARIABLE: SITEFILE 138# @ECLASS-VARIABLE: SITEFILE
136# @DESCRIPTION: 139# @DESCRIPTION:
137# Name of package's site-init file. 140# Name of package's site-init file.
138SITEFILE=50${PN}-gentoo.el 141SITEFILE=50${PN}-gentoo.el
139 142
140EMACS=/usr/bin/emacs 143EMACS=/usr/bin/emacs
141# The following works for Emacs versions 18--23, don't change it. 144# The following works for Emacs versions 18-23, don't change it.
142EMACSFLAGS="-batch -q --no-site-file" 145EMACSFLAGS="-batch -q --no-site-file"
143 146
144# @FUNCTION: elisp-compile 147# @FUNCTION: elisp-compile
145# @USAGE: <list of elisp files> 148# @USAGE: <list of elisp files>
146# @DESCRIPTION: 149# @DESCRIPTION:
147# Byte-compile Emacs Lisp files. 150# Byte-compile Emacs Lisp files.
148 151
149elisp-compile() { 152elisp-compile() {
150 einfo "Compiling GNU Emacs Elisp files ..." 153 ebegin "Compiling GNU Emacs Elisp files"
151 ${EMACS} ${EMACSFLAGS} -f batch-byte-compile "$@" 154 ${EMACS} ${EMACSFLAGS} -f batch-byte-compile "$@"
155 eend $? "batch-byte-compile failed"
152} 156}
153 157
154# @FUNCTION: elisp-comp 158# @FUNCTION: elisp-comp
155# @USAGE: <list of elisp files> 159# @USAGE: <list of elisp files>
156# @DESCRIPTION: 160# @DESCRIPTION:
170 # François Pinard <pinard@iro.umontreal.ca>, 1995. 174 # François Pinard <pinard@iro.umontreal.ca>, 1995.
171 # Originally taken from GNU autotools. 175 # Originally taken from GNU autotools.
172 176
173 [ $# -gt 0 ] || return 1 177 [ $# -gt 0 ] || return 1
174 178
175 einfo "Compiling GNU Emacs Elisp files ..." 179 ebegin "Compiling GNU Emacs Elisp files"
176 180
177 tempdir=elc.$$ 181 tempdir=elc.$$
178 mkdir ${tempdir} 182 mkdir ${tempdir}
179 cp "$@" ${tempdir} 183 cp "$@" ${tempdir}
180 pushd ${tempdir} 184 pushd ${tempdir}
184 local ret=$? 188 local ret=$?
185 mv *.elc .. 189 mv *.elc ..
186 190
187 popd 191 popd
188 rm -fr ${tempdir} 192 rm -fr ${tempdir}
193
194 eend ${ret} "batch-byte-compile failed"
189 return ${ret} 195 return ${ret}
190} 196}
191 197
192# @FUNCTION: elisp-emacs-version 198# @FUNCTION: elisp-emacs-version
193# @DESCRIPTION: 199# @DESCRIPTION:
195 201
196elisp-emacs-version() { 202elisp-emacs-version() {
197 # The following will work for at least versions 18-23. 203 # The following will work for at least versions 18-23.
198 echo "(princ emacs-version)" >"${T}"/emacs-version.el 204 echo "(princ emacs-version)" >"${T}"/emacs-version.el
199 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el 205 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
206 rm -f "${T}"/emacs-version.el
200} 207}
201 208
202# @FUNCTION: elisp-make-autoload-file 209# @FUNCTION: elisp-make-autoload-file
203# @USAGE: [output file] [list of directories] 210# @USAGE: [output file] [list of directories]
204# @DESCRIPTION: 211# @DESCRIPTION:
205# Generate a file with autoload definitions for the lisp functions. 212# Generate a file with autoload definitions for the lisp functions.
206 213
207elisp-make-autoload-file() { 214elisp-make-autoload-file() {
208 local f="${1:-${PN}-autoloads.el}" 215 local f="${1:-${PN}-autoloads.el}"
209 shift 216 shift
210 einfo "Generating autoload file for GNU Emacs ..." 217 ebegin "Generating autoload file for GNU Emacs"
211 218
212 sed 's/^FF/\f/' >"${f}" <<-EOF 219 sed 's/^FF/\f/' >"${f}" <<-EOF
213 ;;; ${f##*/} --- autoloads for ${P} 220 ;;; ${f##*/} --- autoloads for ${P}
214 221
215 ;;; Commentary: 222 ;;; Commentary:
228 235
229 ${EMACS} ${EMACSFLAGS} \ 236 ${EMACS} ${EMACSFLAGS} \
230 --eval "(setq make-backup-files nil)" \ 237 --eval "(setq make-backup-files nil)" \
231 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \ 238 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
232 -f batch-update-autoloads "${@-.}" 239 -f batch-update-autoloads "${@-.}"
240
241 eend $? "batch-update-autoloads failed"
233} 242}
234 243
235# @FUNCTION: elisp-install 244# @FUNCTION: elisp-install
236# @USAGE: <subdirectory> <list of files> 245# @USAGE: <subdirectory> <list of files>
237# @DESCRIPTION: 246# @DESCRIPTION:
238# Install files in SITELISP directory. 247# Install files in SITELISP directory.
239 248
240elisp-install() { 249elisp-install() {
241 local subdir="$1" 250 local subdir="$1"
242 shift 251 shift
243 einfo "Installing Elisp files for GNU Emacs support ..." 252 ebegin "Installing Elisp files for GNU Emacs support"
244 ( # subshell to avoid pollution of calling environment 253 ( # subshell to avoid pollution of calling environment
245 insinto "${SITELISP}/${subdir}" 254 insinto "${SITELISP}/${subdir}"
246 doins "$@" 255 doins "$@"
247 ) 256 )
257 eend $? "doins failed"
248} 258}
249 259
250# @FUNCTION: elisp-site-file-install 260# @FUNCTION: elisp-site-file-install
251# @USAGE: <site-init file> [subdirectory] 261# @USAGE: <site-init file> [subdirectory]
252# @DESCRIPTION: 262# @DESCRIPTION:
253# Install Emacs site-init file in SITELISP directory. 263# Install Emacs site-init file in SITELISP directory.
254 264
255elisp-site-file-install() { 265elisp-site-file-install() {
256 local sf="$1" my_pn="${2:-${PN}}" 266 local sf="${T}/${1##*/}" my_pn="${2:-${PN}}" ret
257 einfo "Installing site initialisation file for GNU Emacs ..." 267 ebegin "Installing site initialisation file for GNU Emacs"
258 cp "${sf}" "${T}" 268 cp "$1" "${sf}"
259 sed -i "s:@SITELISP@:${SITELISP}/${my_pn}:g" "${T}/$(basename "${sf}")" 269 sed -i -e "s:@SITELISP@:${SITELISP}/${my_pn}:g" \
270 -e "s:@SITEETC@:${SITEETC}/${my_pn}:g" "${sf}"
260 ( # subshell to avoid pollution of calling environment 271 ( # subshell to avoid pollution of calling environment
261 insinto "${SITELISP}" 272 insinto "${SITELISP}/site-gentoo.d"
262 doins "${T}/$(basename "${sf}")" 273 doins "${sf}"
263 ) 274 )
275 ret=$?
276 rm -f "${sf}"
277 eend ${ret} "doins failed"
264} 278}
265 279
266# @FUNCTION: elisp-site-regen 280# @FUNCTION: elisp-site-regen
267# @DESCRIPTION: 281# @DESCRIPTION:
268# Regenerate site-gentoo.el file. 282# Regenerate site-gentoo.el file. The old location for site initialisation
283# files of packages was /usr/share/emacs/site-lisp/. In December 2007 this
284# has been changed to /usr/share/emacs/site-lisp/site-gentoo.d/. Remerge of
285# packages with Emacs support is enough, the old location is still supported
286# when generating the start-up file.
269 287
270elisp-site-regen() { 288elisp-site-regen() {
271 local sflist sf line 289 local i sf line obsolete
290 local -a sflist
291 # Work around Paludis borkage: variable T is empty in pkg_postrm
292 local tmpdir=${T:-$(mktemp -d)}
293
294 if [ ! -d "${ROOT}${SITELISP}" ]; then
295 eerror "Directory ${SITELISP} does not exist"
296 return 1
297 fi
272 298
273 if [ ! -e "${ROOT}${SITELISP}"/site-gentoo.el ] \ 299 if [ ! -e "${ROOT}${SITELISP}"/site-gentoo.el ] \
274 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then 300 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then
275 einfo "Creating default ${SITELISP}/site-start.el ..." 301 einfo "Creating default ${SITELISP}/site-start.el ..."
276 cat <<-EOF >"${T}"/site-start.el 302 cat <<-EOF >"${tmpdir}"/site-start.el
277 ;;; site-start.el 303 ;;; site-start.el
278 304
279 ;;; Commentary: 305 ;;; Commentary:
280 ;; This default site startup file is installed by elisp-common.eclass. 306 ;; This default site startup file is installed by elisp-common.eclass.
281 ;; You may replace this file by your own site initialisation, or even 307 ;; You may replace this file by your own site initialisation, or even
288 ;;; site-start.el ends here 314 ;;; site-start.el ends here
289 EOF 315 EOF
290 fi 316 fi
291 317
292 einfon "Regenerating ${SITELISP}/site-gentoo.el ..." 318 einfon "Regenerating ${SITELISP}/site-gentoo.el ..."
319
320 # remove auxiliary file
321 rm -f "${ROOT}${SITELISP}"/00site-gentoo.el
322
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 \
328 "${ROOT}${SITELISP}"/site-gentoo.d/[0-9][0-9]*.el
329 do
330 [ -r "${sf}" ] || continue
331 # sort files by their basename. straight insertion sort.
332 for ((i=${#sflist[@]}; i>0; i--)); do
333 [[ ${sf##*/} < ${sflist[i-1]##*/} ]] || break
334 sflist[i]=${sflist[i-1]}
335 done
336 sflist[i]=${sf}
337 # set a flag if there are obsolete files
338 [ "${sf%/*}" = "${ROOT}${SITELISP}" ] && obsolete=t
339 done
340
341 eval "${old_shopts}"
342
293 cat <<-EOF >"${T}"/site-gentoo.el 343 cat <<-EOF >"${tmpdir}"/site-gentoo.el
294 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages 344 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
295 345
296 ;;; Commentary: 346 ;;; Commentary:
297 ;; Automatically generated by elisp-common.eclass 347 ;; Automatically generated by elisp-common.eclass
298 ;; DO NOT EDIT THIS FILE 348 ;; DO NOT EDIT THIS FILE
299 349
300 ;;; Code: 350 ;;; Code:
301 EOF 351 EOF
302 352 cat "${sflist[@]}" </dev/null >>"${tmpdir}"/site-gentoo.el
303 for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el
304 do
305 [ -r "${sf}" ] || continue
306 sflist="${sflist} $(basename "${sf}")"
307 cat "${sf}" >>"${T}"/site-gentoo.el
308 done
309
310 cat <<-EOF >>"${T}"/site-gentoo.el 353 cat <<-EOF >>"${tmpdir}"/site-gentoo.el
311 354
312 (provide 'site-gentoo) 355 (provide 'site-gentoo)
313 356
314 ;; Local Variables: 357 ;; Local Variables:
315 ;; no-byte-compile: t 358 ;; no-byte-compile: t
316 ;; End: 359 ;; End:
317 ;;; site-gentoo.el ends here 360 ;;; site-gentoo.el ends here
318 EOF 361 EOF
319 362
320 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${T}"/site-gentoo.el; then 363 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${tmpdir}"/site-gentoo.el
364 then
321 # This prevents outputting unnecessary text when there 365 # This prevents outputting unnecessary text when there
322 # was actually no change. 366 # was actually no change.
323 # A case is a remerge where we have doubled output. 367 # A case is a remerge where we have doubled output.
324 echo " no changes." 368 echo " no changes."
325 else 369 else
326 mv "${T}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el 370 mv "${tmpdir}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
327 [ -f "${T}"/site-start.el ] \ 371 [ -f "${tmpdir}"/site-start.el ] \
328 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \ 372 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \
329 && mv "${T}"/site-start.el "${ROOT}${SITELISP}"/site-start.el 373 && mv "${tmpdir}"/site-start.el "${ROOT}${SITELISP}"/site-start.el
330 echo; einfo 374 echo; einfo
331 for sf in ${sflist}; do 375 for sf in "${sflist[@]##*/}"; do
332 einfo " Adding ${sf} ..." 376 einfo " Adding ${sf} ..."
333 done 377 done
378 einfo "Regenerated ${SITELISP}/site-gentoo.el."
379
380 echo
334 while read line; do einfo "${line}"; done <<EOF 381 while read line; do einfo "${line}"; done <<EOF
335
336All site initialisation for Gentoo-installed packages is added to 382All site initialisation for Gentoo-installed packages is added to
337/usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer 383/usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer
338managed by Gentoo. You are responsible for all maintenance of 384managed by Gentoo. You are responsible for all maintenance of
339site-start.el if there is such a file. 385site-start.el if there is such a file.
340 386
341In order for this site initialisation to be loaded for all users 387In order for this site initialisation to be loaded for all users
342automatically, you can add a line like this: 388automatically, you can add a line like this:
343 389
344 (require 'site-gentoo) 390 (require 'site-gentoo)
345 391
346to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line 392to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
347can be added by individual users to their initialisation files, or for 393can be added by individual users to their initialisation files, or,
348greater flexibility, users can select which of the package-specific 394for greater flexibility, users can load individual package-specific
349initialisation files in /usr/share/emacs/site-lisp/ to load. 395initialisation files from /usr/share/emacs/site-lisp/site-gentoo.d/.
350EOF 396EOF
351 echo 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
352 fi 408 fi
409
410 # Kludge for backwards compatibility: During pkg_postrm, old versions
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
353} 421}

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

  ViewVC Help
Powered by ViewVC 1.1.20