/[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.31 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.31 2007/12/01 15:35:02 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.
139# @DESCRIPTION: 139# @DESCRIPTION:
140# Name of package's site-init file. 140# Name of package's site-init file.
141SITEFILE=50${PN}-gentoo.el 141SITEFILE=50${PN}-gentoo.el
142 142
143EMACS=/usr/bin/emacs 143EMACS=/usr/bin/emacs
144# 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.
145EMACSFLAGS="-batch -q --no-site-file" 145EMACSFLAGS="-batch -q --no-site-file"
146 146
147# @FUNCTION: elisp-compile 147# @FUNCTION: elisp-compile
148# @USAGE: <list of elisp files> 148# @USAGE: <list of elisp files>
149# @DESCRIPTION: 149# @DESCRIPTION:
150# Byte-compile Emacs Lisp files. 150# Byte-compile Emacs Lisp files.
151 151
152elisp-compile() { 152elisp-compile() {
153 einfo "Compiling GNU Emacs Elisp files ..." 153 ebegin "Compiling GNU Emacs Elisp files"
154 ${EMACS} ${EMACSFLAGS} -f batch-byte-compile "$@" 154 ${EMACS} ${EMACSFLAGS} -f batch-byte-compile "$@"
155 eend $? "batch-byte-compile failed"
155} 156}
156 157
157# @FUNCTION: elisp-comp 158# @FUNCTION: elisp-comp
158# @USAGE: <list of elisp files> 159# @USAGE: <list of elisp files>
159# @DESCRIPTION: 160# @DESCRIPTION:
173 # François Pinard <pinard@iro.umontreal.ca>, 1995. 174 # François Pinard <pinard@iro.umontreal.ca>, 1995.
174 # Originally taken from GNU autotools. 175 # Originally taken from GNU autotools.
175 176
176 [ $# -gt 0 ] || return 1 177 [ $# -gt 0 ] || return 1
177 178
178 einfo "Compiling GNU Emacs Elisp files ..." 179 ebegin "Compiling GNU Emacs Elisp files"
179 180
180 tempdir=elc.$$ 181 tempdir=elc.$$
181 mkdir ${tempdir} 182 mkdir ${tempdir}
182 cp "$@" ${tempdir} 183 cp "$@" ${tempdir}
183 pushd ${tempdir} 184 pushd ${tempdir}
187 local ret=$? 188 local ret=$?
188 mv *.elc .. 189 mv *.elc ..
189 190
190 popd 191 popd
191 rm -fr ${tempdir} 192 rm -fr ${tempdir}
193
194 eend ${ret} "batch-byte-compile failed"
192 return ${ret} 195 return ${ret}
193} 196}
194 197
195# @FUNCTION: elisp-emacs-version 198# @FUNCTION: elisp-emacs-version
196# @DESCRIPTION: 199# @DESCRIPTION:
198 201
199elisp-emacs-version() { 202elisp-emacs-version() {
200 # The following will work for at least versions 18-23. 203 # The following will work for at least versions 18-23.
201 echo "(princ emacs-version)" >"${T}"/emacs-version.el 204 echo "(princ emacs-version)" >"${T}"/emacs-version.el
202 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el 205 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
206 rm -f "${T}"/emacs-version.el
203} 207}
204 208
205# @FUNCTION: elisp-make-autoload-file 209# @FUNCTION: elisp-make-autoload-file
206# @USAGE: [output file] [list of directories] 210# @USAGE: [output file] [list of directories]
207# @DESCRIPTION: 211# @DESCRIPTION:
208# Generate a file with autoload definitions for the lisp functions. 212# Generate a file with autoload definitions for the lisp functions.
209 213
210elisp-make-autoload-file() { 214elisp-make-autoload-file() {
211 local f="${1:-${PN}-autoloads.el}" 215 local f="${1:-${PN}-autoloads.el}"
212 shift 216 shift
213 einfo "Generating autoload file for GNU Emacs ..." 217 ebegin "Generating autoload file for GNU Emacs"
214 218
215 sed 's/^FF/\f/' >"${f}" <<-EOF 219 sed 's/^FF/\f/' >"${f}" <<-EOF
216 ;;; ${f##*/} --- autoloads for ${P} 220 ;;; ${f##*/} --- autoloads for ${P}
217 221
218 ;;; Commentary: 222 ;;; Commentary:
231 235
232 ${EMACS} ${EMACSFLAGS} \ 236 ${EMACS} ${EMACSFLAGS} \
233 --eval "(setq make-backup-files nil)" \ 237 --eval "(setq make-backup-files nil)" \
234 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \ 238 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
235 -f batch-update-autoloads "${@-.}" 239 -f batch-update-autoloads "${@-.}"
240
241 eend $? "batch-update-autoloads failed"
236} 242}
237 243
238# @FUNCTION: elisp-install 244# @FUNCTION: elisp-install
239# @USAGE: <subdirectory> <list of files> 245# @USAGE: <subdirectory> <list of files>
240# @DESCRIPTION: 246# @DESCRIPTION:
241# Install files in SITELISP directory. 247# Install files in SITELISP directory.
242 248
243elisp-install() { 249elisp-install() {
244 local subdir="$1" 250 local subdir="$1"
245 shift 251 shift
246 einfo "Installing Elisp files for GNU Emacs support ..." 252 ebegin "Installing Elisp files for GNU Emacs support"
247 ( # subshell to avoid pollution of calling environment 253 ( # subshell to avoid pollution of calling environment
248 insinto "${SITELISP}/${subdir}" 254 insinto "${SITELISP}/${subdir}"
249 doins "$@" 255 doins "$@"
250 ) 256 )
257 eend $? "doins failed"
251} 258}
252 259
253# @FUNCTION: elisp-site-file-install 260# @FUNCTION: elisp-site-file-install
254# @USAGE: <site-init file> [subdirectory] 261# @USAGE: <site-init file> [subdirectory]
255# @DESCRIPTION: 262# @DESCRIPTION:
256# Install Emacs site-init file in SITELISP directory. 263# Install Emacs site-init file in SITELISP directory.
257 264
258elisp-site-file-install() { 265elisp-site-file-install() {
259 local sf="$1" my_pn="${2:-${PN}}" 266 local sf="${T}/${1##*/}" my_pn="${2:-${PN}}" ret
260 einfo "Installing site initialisation file for GNU Emacs ..." 267 ebegin "Installing site initialisation file for GNU Emacs"
261 cp "${sf}" "${T}" 268 cp "$1" "${sf}"
262 sed -i -e "s:@SITELISP@:${SITELISP}/${my_pn}:g" \ 269 sed -i -e "s:@SITELISP@:${SITELISP}/${my_pn}:g" \
263 -e "s:@SITEETC@:${SITEETC}/${my_pn}:g" "${T}/${sf##*/}" 270 -e "s:@SITEETC@:${SITEETC}/${my_pn}:g" "${sf}"
264 ( # subshell to avoid pollution of calling environment 271 ( # subshell to avoid pollution of calling environment
265 insinto "${SITELISP}" 272 insinto "${SITELISP}/site-gentoo.d"
266 doins "${T}/${sf##*/}" 273 doins "${sf}"
267 ) 274 )
275 ret=$?
276 rm -f "${sf}"
277 eend ${ret} "doins failed"
268} 278}
269 279
270# @FUNCTION: elisp-site-regen 280# @FUNCTION: elisp-site-regen
271# @DESCRIPTION: 281# @DESCRIPTION:
272# 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.
273 287
274elisp-site-regen() { 288elisp-site-regen() {
275 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
276 298
277 if [ ! -e "${ROOT}${SITELISP}"/site-gentoo.el ] \ 299 if [ ! -e "${ROOT}${SITELISP}"/site-gentoo.el ] \
278 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then 300 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then
279 einfo "Creating default ${SITELISP}/site-start.el ..." 301 einfo "Creating default ${SITELISP}/site-start.el ..."
280 cat <<-EOF >"${T}"/site-start.el 302 cat <<-EOF >"${tmpdir}"/site-start.el
281 ;;; site-start.el 303 ;;; site-start.el
282 304
283 ;;; Commentary: 305 ;;; Commentary:
284 ;; This default site startup file is installed by elisp-common.eclass. 306 ;; This default site startup file is installed by elisp-common.eclass.
285 ;; 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
292 ;;; site-start.el ends here 314 ;;; site-start.el ends here
293 EOF 315 EOF
294 fi 316 fi
295 317
296 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
297 cat <<-EOF >"${T}"/site-gentoo.el 343 cat <<-EOF >"${tmpdir}"/site-gentoo.el
298 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages 344 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
299 345
300 ;;; Commentary: 346 ;;; Commentary:
301 ;; Automatically generated by elisp-common.eclass 347 ;; Automatically generated by elisp-common.eclass
302 ;; DO NOT EDIT THIS FILE 348 ;; DO NOT EDIT THIS FILE
303 349
304 ;;; Code: 350 ;;; Code:
305 EOF 351 EOF
306 352 cat "${sflist[@]}" </dev/null >>"${tmpdir}"/site-gentoo.el
307 for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el
308 do
309 [ -r "${sf}" ] || continue
310 sflist="${sflist} ${sf##*/}"
311 cat "${sf}" >>"${T}"/site-gentoo.el
312 done
313
314 cat <<-EOF >>"${T}"/site-gentoo.el 353 cat <<-EOF >>"${tmpdir}"/site-gentoo.el
315 354
316 (provide 'site-gentoo) 355 (provide 'site-gentoo)
317 356
318 ;; Local Variables: 357 ;; Local Variables:
319 ;; no-byte-compile: t 358 ;; no-byte-compile: t
320 ;; End: 359 ;; End:
321 ;;; site-gentoo.el ends here 360 ;;; site-gentoo.el ends here
322 EOF 361 EOF
323 362
324 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
325 # This prevents outputting unnecessary text when there 365 # This prevents outputting unnecessary text when there
326 # was actually no change. 366 # was actually no change.
327 # A case is a remerge where we have doubled output. 367 # A case is a remerge where we have doubled output.
328 echo " no changes." 368 echo " no changes."
329 else 369 else
330 mv "${T}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el 370 mv "${tmpdir}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
331 [ -f "${T}"/site-start.el ] \ 371 [ -f "${tmpdir}"/site-start.el ] \
332 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \ 372 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \
333 && mv "${T}"/site-start.el "${ROOT}${SITELISP}"/site-start.el 373 && mv "${tmpdir}"/site-start.el "${ROOT}${SITELISP}"/site-start.el
334 echo; einfo 374 echo; einfo
335 for sf in ${sflist}; do 375 for sf in "${sflist[@]##*/}"; do
336 einfo " Adding ${sf} ..." 376 einfo " Adding ${sf} ..."
337 done 377 done
378 einfo "Regenerated ${SITELISP}/site-gentoo.el."
379
380 echo
338 while read line; do einfo "${line}"; done <<EOF 381 while read line; do einfo "${line}"; done <<EOF
339
340All site initialisation for Gentoo-installed packages is added to 382All site initialisation for Gentoo-installed packages is added to
341/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
342managed by Gentoo. You are responsible for all maintenance of 384managed by Gentoo. You are responsible for all maintenance of
343site-start.el if there is such a file. 385site-start.el if there is such a file.
344 386
348 (require 'site-gentoo) 390 (require 'site-gentoo)
349 391
350to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line 392to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
351can be added by individual users to their initialisation files, or, 393can be added by individual users to their initialisation files, or,
352for greater flexibility, users can load individual package-specific 394for greater flexibility, users can load individual package-specific
353initialisation files from /usr/share/emacs/site-lisp/. 395initialisation files from /usr/share/emacs/site-lisp/site-gentoo.d/.
354EOF 396EOF
355 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
356 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
357} 421}

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

  ViewVC Help
Powered by ViewVC 1.1.20