/[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.29 Revision 1.37
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.29 2007/10/14 22:12:30 ulm Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.37 2008/03/07 08:19:19 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.
142EMACS_BATCH_CLEAN="${EMACS} -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_BATCH_CLEAN} -f batch-byte-compile "$@" 154 ${EMACS} ${EMACSFLAGS} -f batch-byte-compile "$@"
155 eend $? "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}
152} 196}
153 197
154# @FUNCTION: elisp-emacs-version 198# @FUNCTION: elisp-emacs-version
155# @DESCRIPTION: 199# @DESCRIPTION:
156# Output version of currently active Emacs. 200# Output version of currently active Emacs.
157 201
158elisp-emacs-version() { 202elisp-emacs-version() {
159 # The following will work for at least versions 18-23. 203 # The following will work for at least versions 18--23.
160 echo "(princ emacs-version)" >"${T}"/emacs-version.el 204 echo "(princ emacs-version)" >"${T}"/emacs-version.el
161 ${EMACS_BATCH_CLEAN} -l "${T}"/emacs-version.el 205 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
206 rm -f "${T}"/emacs-version.el
162} 207}
163 208
164# @FUNCTION: elisp-make-autoload-file 209# @FUNCTION: elisp-make-autoload-file
165# @USAGE: [output file] [list of directories] 210# @USAGE: [output file] [list of directories]
166# @DESCRIPTION: 211# @DESCRIPTION:
167# Generate a file with autoload definitions for the lisp functions. 212# Generate a file with autoload definitions for the lisp functions.
168 213
169elisp-make-autoload-file() { 214elisp-make-autoload-file() {
170 local f="${1:-${PN}-autoloads.el}" 215 local f="${1:-${PN}-autoloads.el}"
171 shift 216 shift
172 einfo "Generating autoload file for GNU Emacs ..." 217 ebegin "Generating autoload file for GNU Emacs"
173 218
174 sed 's/^FF/\f/' >"${f}" <<-EOF 219 sed 's/^FF/\f/' >"${f}" <<-EOF
175 ;;; ${f##*/} --- autoloads for ${P} 220 ;;; ${f##*/} --- autoloads for ${P}
176 221
177 ;;; Commentary: 222 ;;; Commentary:
186 ;; no-update-autoloads: t 231 ;; no-update-autoloads: t
187 ;; End: 232 ;; End:
188 ;;; ${f##*/} ends here 233 ;;; ${f##*/} ends here
189 EOF 234 EOF
190 235
191 ${EMACS_BATCH_CLEAN} \ 236 ${EMACS} ${EMACSFLAGS} \
192 --eval "(setq make-backup-files nil)" \ 237 --eval "(setq make-backup-files nil)" \
193 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \ 238 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
194 -f batch-update-autoloads "${@-.}" 239 -f batch-update-autoloads "${@-.}"
240
241 eend $? "batch-update-autoloads failed"
195} 242}
196 243
197# @FUNCTION: elisp-install 244# @FUNCTION: elisp-install
198# @USAGE: <subdirectory> <list of files> 245# @USAGE: <subdirectory> <list of files>
199# @DESCRIPTION: 246# @DESCRIPTION:
200# Install files in SITELISP directory. 247# Install files in SITELISP directory.
201 248
202elisp-install() { 249elisp-install() {
203 local subdir="$1" 250 local subdir="$1"
204 shift 251 shift
205 einfo "Installing Elisp files for GNU Emacs support ..." 252 ebegin "Installing Elisp files for GNU Emacs support"
206 ( # subshell to avoid pollution of calling environment 253 ( # subshell to avoid pollution of calling environment
207 insinto "${SITELISP}/${subdir}" 254 insinto "${SITELISP}/${subdir}"
208 doins "$@" 255 doins "$@"
209 ) 256 )
257 eend $? "doins failed"
210} 258}
211 259
212# @FUNCTION: elisp-site-file-install 260# @FUNCTION: elisp-site-file-install
213# @USAGE: <site-init file> [subdirectory] 261# @USAGE: <site-init file> [subdirectory]
214# @DESCRIPTION: 262# @DESCRIPTION:
215# Install Emacs site-init file in SITELISP directory. 263# Install Emacs site-init file in SITELISP directory.
216 264
217elisp-site-file-install() { 265elisp-site-file-install() {
218 local sf="$1" my_pn="${2:-${PN}}" 266 local sf="${T}/${1##*/}" my_pn="${2:-${PN}}" ret
219 einfo "Installing site initialisation file for GNU Emacs ..." 267 ebegin "Installing site initialisation file for GNU Emacs"
220 cp "${sf}" "${T}" 268 cp "$1" "${sf}"
221 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}"
222 ( # subshell to avoid pollution of calling environment 271 ( # subshell to avoid pollution of calling environment
223 insinto "${SITELISP}" 272 insinto "${SITELISP}/site-gentoo.d"
224 doins "${T}/$(basename "${sf}")" 273 doins "${sf}"
225 ) 274 )
275 ret=$?
276 rm -f "${sf}"
277 eend ${ret} "doins failed"
226} 278}
227 279
228# @FUNCTION: elisp-site-regen 280# @FUNCTION: elisp-site-regen
229# @DESCRIPTION: 281# @DESCRIPTION:
230# 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.
231 287
232elisp-site-regen() { 288elisp-site-regen() {
233 local sflist sf line 289 local i sf line obsolete
290 local -a sflist
291 local tmpdir=${T:-/tmp}
234 292
235 if [ ! -e "${ROOT}${SITELISP}"/site-gentoo.el ] \ 293 if [ ! -e "${ROOT}${SITELISP}"/site-gentoo.el ] \
236 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then 294 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then
237 einfo "Creating default ${SITELISP}/site-start.el ..." 295 einfo "Creating default ${SITELISP}/site-start.el ..."
238 cat <<-EOF >"${T}"/site-start.el 296 cat <<-EOF >"${tmpdir}"/site-start.el
239 ;;; site-start.el 297 ;;; site-start.el
240 298
241 ;;; Commentary: 299 ;;; Commentary:
242 ;; This default site startup file is installed by elisp-common.eclass. 300 ;; This default site startup file is installed by elisp-common.eclass.
243 ;; You may replace this file by your own site initialisation, or even 301 ;; You may replace this file by your own site initialisation, or even
250 ;;; site-start.el ends here 308 ;;; site-start.el ends here
251 EOF 309 EOF
252 fi 310 fi
253 311
254 einfon "Regenerating ${SITELISP}/site-gentoo.el ..." 312 einfon "Regenerating ${SITELISP}/site-gentoo.el ..."
313
314 # remove auxiliary file
315 rm -f "${ROOT}${SITELISP}"/00site-gentoo.el
316
317 # set nullglob option, there may be a directory without matching files
318 local old_shopts=$(shopt -p nullglob)
319 shopt -s nullglob
320
321 for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el \
322 "${ROOT}${SITELISP}"/site-gentoo.d/[0-9][0-9]*.el
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
334
335 eval "${old_shopts}"
336
255 cat <<-EOF >"${T}"/site-gentoo.el 337 cat <<-EOF >"${tmpdir}"/site-gentoo.el
256 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages 338 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
257 339
258 ;;; Commentary: 340 ;;; Commentary:
259 ;; Automatically generated by elisp-common.eclass 341 ;; Automatically generated by elisp-common.eclass
260 ;; DO NOT EDIT THIS FILE 342 ;; DO NOT EDIT THIS FILE
261 343
262 ;;; Code: 344 ;;; Code:
263 EOF 345 EOF
264 346 cat "${sflist[@]}" </dev/null >>"${tmpdir}"/site-gentoo.el
265 for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el
266 do
267 [ -r "${sf}" ] || continue
268 sflist="${sflist} $(basename "${sf}")"
269 cat "${sf}" >>"${T}"/site-gentoo.el
270 done
271
272 cat <<-EOF >>"${T}"/site-gentoo.el 347 cat <<-EOF >>"${tmpdir}"/site-gentoo.el
273 348
274 (provide 'site-gentoo) 349 (provide 'site-gentoo)
275 350
276 ;; Local Variables: 351 ;; Local Variables:
277 ;; no-byte-compile: t 352 ;; no-byte-compile: t
278 ;; End: 353 ;; End:
279 ;;; site-gentoo.el ends here 354 ;;; site-gentoo.el ends here
280 EOF 355 EOF
281 356
282 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${T}"/site-gentoo.el; then 357 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${tmpdir}"/site-gentoo.el
358 then
283 # This prevents outputting unnecessary text when there 359 # This prevents outputting unnecessary text when there
284 # was actually no change. 360 # was actually no change.
285 # A case is a remerge where we have doubled output. 361 # A case is a remerge where we have doubled output.
286 echo " no changes." 362 echo " no changes."
287 else 363 else
288 mv "${T}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el 364 mv "${tmpdir}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
289 [ -f "${T}"/site-start.el ] \ 365 [ -f "${tmpdir}"/site-start.el ] \
290 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \ 366 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \
291 && mv "${T}"/site-start.el "${ROOT}${SITELISP}"/site-start.el 367 && mv "${tmpdir}"/site-start.el "${ROOT}${SITELISP}"/site-start.el
292 echo; einfo 368 echo; einfo
293 for sf in ${sflist}; do 369 for sf in "${sflist[@]##*/}"; do
294 einfo " Adding ${sf} ..." 370 einfo " Adding ${sf} ..."
295 done 371 done
372 einfo "Regenerated ${SITELISP}/site-gentoo.el."
373
374 echo
296 while read line; do einfo "${line}"; done <<EOF 375 while read line; do einfo "${line}"; done <<EOF
297
298All site initialisation for Gentoo-installed packages is added to 376All site initialisation for Gentoo-installed packages is added to
299/usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer 377/usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer
300managed by Gentoo. You are responsible for all maintenance of 378managed by Gentoo. You are responsible for all maintenance of
301site-start.el if there is such a file. 379site-start.el if there is such a file.
302 380
303In order for this site initialisation to be loaded for all users 381In order for this site initialisation to be loaded for all users
304automatically, you can add a line like this: 382automatically, you can add a line like this:
305 383
306 (require 'site-gentoo) 384 (require 'site-gentoo)
307 385
308to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line 386to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
309can be added by individual users to their initialisation files, or for 387can be added by individual users to their initialisation files, or,
310greater flexibility, users can select which of the package-specific 388for greater flexibility, users can load individual package-specific
311initialisation files in /usr/share/emacs/site-lisp/ to load. 389initialisation files from /usr/share/emacs/site-lisp/site-gentoo.d/.
312EOF 390EOF
313 echo 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
314 fi 402 fi
315}
316 403
317# @FUNCTION: elisp-comp 404 # Kludge for backwards compatibility: During pkg_postrm, old versions
318# @USAGE: <list of elisp files> 405 # of this eclass (saved in the VDB) won't find packages' site-init files
319# @DESCRIPTION: 406 # in the new location. So we copy them to an auxiliary file that is
320# Byte-compile interdependent Emacs Lisp files. 407 # visible to old eclass versions.
321# 408 for sf in "${sflist[@]}"; do
322# This function byte-compiles all ".el" files which are part of its 409 [ "${sf%/*}" = "${ROOT}${SITELISP}/site-gentoo.d" ] \
323# arguments, using GNU Emacs, and puts the resulting ".elc" files into the 410 && cat "${sf}" >>"${ROOT}${SITELISP}"/00site-gentoo.el
324# current directory, so disregarding the original directories used in ".el" 411 done
325# arguments.
326#
327# This function manages in such a way that all Emacs Lisp files to be
328# compiled are made visible between themselves, in the event they require or
329# load one another.
330 412
331elisp-comp() { 413 # cleanup
332 # Copyright 1995 Free Software Foundation, Inc. 414 rm -f "${tmpdir}"/site-{gentoo,start}.el
333 # François Pinard <pinard@iro.umontreal.ca>, 1995.
334 # Originally taken from GNU autotools.
335
336 test $# -gt 0 || return 1
337
338 if test -z "${EMACS}" || test "${EMACS}" = "t"; then
339 # Value of "t" means we are running in a shell under Emacs.
340 # Just assume Emacs is called "emacs".
341 EMACS=/usr/bin/emacs
342 fi
343 einfo "Compiling GNU Emacs Elisp files ..."
344
345 tempdir=elc.$$
346 mkdir ${tempdir}
347 cp "$@" ${tempdir}
348 pushd ${tempdir}
349
350 echo "(add-to-list 'load-path \"../\")" > script
351 ${EMACS_BATCH_CLEAN} -l script -f batch-byte-compile *.el
352 local ret=$?
353 mv *.elc ..
354
355 popd
356 rm -fr ${tempdir}
357 return ${ret}
358} 415}

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

  ViewVC Help
Powered by ViewVC 1.1.20