/[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.28 Revision 1.38
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.28 2007/09/22 20:25:30 ulm Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.38 2008/04/04 18:11:28 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.
15# @BLURB: Emacs-related installation utilities 15# @BLURB: Emacs-related installation utilities
16# @DESCRIPTION: 16# @DESCRIPTION:
17# 17#
18# Usually you want to use this eclass for (optional) GNU Emacs support of 18# Usually you want to use this eclass for (optional) GNU Emacs support of
71# (add-to-list 'load-path "@SITELISP@") 71# (add-to-list 'load-path "@SITELISP@")
72# (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode)) 72# (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode))
73# (autoload 'csv-mode "csv-mode" "Major mode for csv files." t) 73# (autoload 'csv-mode "csv-mode" "Major mode for csv files." t)
74# 74#
75# If your Emacs support files are installed in a subdirectory of 75# If your Emacs support files are installed in a subdirectory of
76# /usr/share/emacs/site-lisp/ (which is recommended if more than one file is 76# /usr/share/emacs/site-lisp/ (which is recommended), you need to extend
77# installed), you need to extend Emacs' load-path as shown in the first 77# Emacs' load-path as shown in the first non-comment.
78# non-comment. The elisp-site-file-install() function of this eclass will 78# The elisp-site-file-install() function of this eclass will replace
79# replace "@SITELISP@" by the actual path. 79# "@SITELISP@" by the actual path.
80# 80#
81# The next line tells Emacs to load the mode opening a file ending with 81# The next line tells Emacs to load the mode opening a file ending with
82# ".csv" and load functions depending on the context and needed features. 82# ".csv" and load functions depending on the context and needed features.
83# Be careful though. Commands as "load-library" or "require" bloat the 83# Be careful though. Commands as "load-library" or "require" bloat the
84# editor as they are loaded on every startup. When having a lot of Emacs 84# editor as they are loaded on every startup. When having a lot of Emacs
95# 95#
96# SITEFILE=50${PN}-gentoo.el 96# SITEFILE=50${PN}-gentoo.el
97# 97#
98# Which is then installed by 98# Which is then installed by
99# 99#
100# elisp-site-file-install "${FILESDIR}/${SITEFILE}" 100# elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
101# 101#
102# in src_install(). If your subdirectory is not named ${PN}, give the 102# in src_install(). If your subdirectory is not named ${PN}, give the
103# differing name as second argument. 103# differing name as second argument.
104# 104#
105# .SS 105# .SS
125# .SS 125# .SS
126# Miscellaneous functions: 126# Miscellaneous functions:
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
131# @DESCRIPTION:
132# Directory where packages install Emacs Lisp files.
130SITELISP=/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
137
138# @ECLASS-VARIABLE: SITEFILE
139# @DESCRIPTION:
140# Name of package's site-init file.
131SITEFILE=50${PN}-gentoo.el 141SITEFILE=50${PN}-gentoo.el
142
132EMACS=/usr/bin/emacs 143EMACS=/usr/bin/emacs
133# 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.
134EMACS_BATCH_CLEAN="${EMACS} -batch -q --no-site-file" 145EMACSFLAGS="-batch -q --no-site-file"
135 146
136# @FUNCTION: elisp-compile 147# @FUNCTION: elisp-compile
137# @USAGE: <list of elisp files> 148# @USAGE: <list of elisp files>
138# @DESCRIPTION: 149# @DESCRIPTION:
139# Byte-compile Emacs Lisp files. 150# Byte-compile Emacs Lisp files.
140 151
141elisp-compile() { 152elisp-compile() {
142 einfo "Compiling GNU Emacs Elisp files ..." 153 ebegin "Compiling GNU Emacs Elisp files"
143 ${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}
144} 196}
145 197
146# @FUNCTION: elisp-emacs-version 198# @FUNCTION: elisp-emacs-version
147# @DESCRIPTION: 199# @DESCRIPTION:
148# Output version of currently active Emacs. 200# Output version of currently active Emacs.
149 201
150elisp-emacs-version() { 202elisp-emacs-version() {
151 # The following will work for at least versions 18-23. 203 # The following will work for at least versions 18-23.
152 echo "(princ emacs-version)" >"${T}"/emacs-version.el 204 echo "(princ emacs-version)" >"${T}"/emacs-version.el
153 ${EMACS_BATCH_CLEAN} -l "${T}"/emacs-version.el 205 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
206 rm -f "${T}"/emacs-version.el
154} 207}
155 208
156# @FUNCTION: elisp-make-autoload-file 209# @FUNCTION: elisp-make-autoload-file
157# @USAGE: [output file] [list of directories] 210# @USAGE: [output file] [list of directories]
158# @DESCRIPTION: 211# @DESCRIPTION:
159# Generate a file with autoload definitions for the lisp functions. 212# Generate a file with autoload definitions for the lisp functions.
160 213
161elisp-make-autoload-file () { 214elisp-make-autoload-file() {
162 local f="${1:-${PN}-autoloads.el}" 215 local f="${1:-${PN}-autoloads.el}"
163 shift 216 shift
164 einfo "Generating autoload file for GNU Emacs ..." 217 ebegin "Generating autoload file for GNU Emacs"
165 218
166 sed 's/^FF/\f/' >"${f}" <<-EOF 219 sed 's/^FF/\f/' >"${f}" <<-EOF
167 ;;; ${f##*/} --- autoloads for ${P} 220 ;;; ${f##*/} --- autoloads for ${P}
168 221
169 ;;; Commentary: 222 ;;; Commentary:
178 ;; no-update-autoloads: t 231 ;; no-update-autoloads: t
179 ;; End: 232 ;; End:
180 ;;; ${f##*/} ends here 233 ;;; ${f##*/} ends here
181 EOF 234 EOF
182 235
183 ${EMACS_BATCH_CLEAN} \ 236 ${EMACS} ${EMACSFLAGS} \
184 --eval "(setq make-backup-files nil)" \ 237 --eval "(setq make-backup-files nil)" \
185 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \ 238 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
186 -f batch-update-autoloads "${@-.}" 239 -f batch-update-autoloads "${@-.}"
240
241 eend $? "batch-update-autoloads failed"
187} 242}
188 243
189# @FUNCTION: elisp-install 244# @FUNCTION: elisp-install
190# @USAGE: <subdirectory> <list of files> 245# @USAGE: <subdirectory> <list of files>
191# @DESCRIPTION: 246# @DESCRIPTION:
192# Install files in SITELISP directory. 247# Install files in SITELISP directory.
193 248
194elisp-install() { 249elisp-install() {
195 local subdir="$1" 250 local subdir="$1"
196 shift 251 shift
197 einfo "Installing Elisp files for GNU Emacs support ..." 252 ebegin "Installing Elisp files for GNU Emacs support"
198 ( # subshell to avoid pollution of calling environment 253 ( # subshell to avoid pollution of calling environment
199 insinto "${SITELISP}/${subdir}" 254 insinto "${SITELISP}/${subdir}"
200 doins "$@" 255 doins "$@"
201 ) 256 )
257 eend $? "doins failed"
202} 258}
203 259
204# @FUNCTION: elisp-site-file-install 260# @FUNCTION: elisp-site-file-install
205# @USAGE: <site-init file> [subdirectory] 261# @USAGE: <site-init file> [subdirectory]
206# @DESCRIPTION: 262# @DESCRIPTION:
207# Install Emacs site-init file in SITELISP directory. 263# Install Emacs site-init file in SITELISP directory.
208 264
209elisp-site-file-install() { 265elisp-site-file-install() {
210 local sf="$1" my_pn="${2:-${PN}}" 266 local sf="${T}/${1##*/}" my_pn="${2:-${PN}}" ret
211 einfo "Installing site initialisation file for GNU Emacs ..." 267 ebegin "Installing site initialisation file for GNU Emacs"
212 cp "${sf}" "${T}" 268 cp "$1" "${sf}"
213 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}"
214 ( # subshell to avoid pollution of calling environment 271 ( # subshell to avoid pollution of calling environment
215 insinto "${SITELISP}" 272 insinto "${SITELISP}/site-gentoo.d"
216 doins "${T}/$(basename "${sf}")" 273 doins "${sf}"
217 ) 274 )
275 ret=$?
276 rm -f "${sf}"
277 eend ${ret} "doins failed"
218} 278}
219 279
220# @FUNCTION: elisp-site-regen 280# @FUNCTION: elisp-site-regen
221# @DESCRIPTION: 281# @DESCRIPTION:
222# 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.
223 287
224elisp-site-regen() { 288elisp-site-regen() {
225 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:-/tmp}
293
294 if [ ! -d "${ROOT}${SITELISP}" ]; then
295 eerror "Directory ${SITELISP} does not exist"
296 return 1
297 fi
298
299 if [ ! -e "${ROOT}${SITELISP}"/site-gentoo.el ] \
300 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then
301 einfo "Creating default ${SITELISP}/site-start.el ..."
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
226 317
227 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
228 cat <<-EOF >"${T}"/site-gentoo.el 343 cat <<-EOF >"${tmpdir}"/site-gentoo.el
229 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages 344 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
230 345
231 ;;; Commentary: 346 ;;; Commentary:
232 ;; Automatically generated by elisp-common.eclass 347 ;; Automatically generated by elisp-common.eclass
233 ;; DO NOT EDIT THIS FILE 348 ;; DO NOT EDIT THIS FILE
234 349
235 ;;; Code: 350 ;;; Code:
236 EOF 351 EOF
237 352 cat "${sflist[@]}" </dev/null >>"${tmpdir}"/site-gentoo.el
238 for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el
239 do
240 [ -r "${sf}" ] || continue
241 sflist="${sflist} $(basename "${sf}")"
242 cat "${sf}" >>"${T}"/site-gentoo.el
243 done
244
245 cat <<-EOF >>"${T}"/site-gentoo.el 353 cat <<-EOF >>"${tmpdir}"/site-gentoo.el
246 354
247 (provide 'site-gentoo) 355 (provide 'site-gentoo)
248 356
249 ;; Local Variables: 357 ;; Local Variables:
250 ;; no-byte-compile: t 358 ;; no-byte-compile: t
251 ;; End: 359 ;; End:
252 ;;; site-gentoo.el ends here 360 ;;; site-gentoo.el ends here
253 EOF 361 EOF
254 362
255 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
256 # This prevents outputting unnecessary text when there 365 # This prevents outputting unnecessary text when there
257 # was actually no change 366 # was actually no change.
258 # A case is a remerge where we have doubled output 367 # A case is a remerge where we have doubled output.
259 echo " no changes." 368 echo " no changes."
260 else 369 else
261 mv "${T}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el 370 mv "${tmpdir}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
371 [ -f "${tmpdir}"/site-start.el ] \
372 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \
373 && mv "${tmpdir}"/site-start.el "${ROOT}${SITELISP}"/site-start.el
262 echo; einfo 374 echo; einfo
263 for sf in ${sflist}; do 375 for sf in "${sflist[@]##*/}"; do
264 einfo " Adding ${sf} ..." 376 einfo " Adding ${sf} ..."
265 done 377 done
378 einfo "Regenerated ${SITELISP}/site-gentoo.el."
379
380 echo
266 while read line; do einfo "${line}"; done <<EOF 381 while read line; do einfo "${line}"; done <<EOF
267
268All site initialisation for Gentoo-installed packages is added to 382All site initialisation for Gentoo-installed packages is added to
269/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
270managed by Gentoo. You are responsible for all maintenance of 384managed by Gentoo. You are responsible for all maintenance of
271site-start.el if there is such a file. 385site-start.el if there is such a file.
272 386
273In order for this site initialisation to be loaded for all users 387In order for this site initialisation to be loaded for all users
274automatically, you can add a line like this: 388automatically, you can add a line like this:
275 389
276 (load "/usr/share/emacs/site-lisp/site-gentoo" nil t) 390 (require 'site-gentoo)
277 391
278to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line 392to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
279can be added by individual users to their initialisation files, or for 393can be added by individual users to their initialisation files, or,
280greater flexibility, users can select which of the package-specific 394for greater flexibility, users can load individual package-specific
281initialisation files in /usr/share/emacs/site-lisp/ to load. 395initialisation files from /usr/share/emacs/site-lisp/site-gentoo.d/.
282EOF 396EOF
283 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/. You may consider using
403 /usr/sbin/emacs-updater to rebuild the installed Emacs packages.
404 However, the old location is still supported.
405 EOF
406 echo
407 fi
284 fi 408 fi
285}
286 409
287# @FUNCTION: elisp-comp 410 # Kludge for backwards compatibility: During pkg_postrm, old versions
288# @USAGE: <list of elisp files> 411 # of this eclass (saved in the VDB) won't find packages' site-init files
289# @DESCRIPTION: 412 # in the new location. So we copy them to an auxiliary file that is
290# Byte-compile interdependent Emacs Lisp files. 413 # visible to old eclass versions.
291# 414 for sf in "${sflist[@]}"; do
292# This function byte-compiles all ".el" files which are part of its 415 [ "${sf%/*}" = "${ROOT}${SITELISP}/site-gentoo.d" ] \
293# arguments, using GNU Emacs, and puts the resulting ".elc" files into the 416 && cat "${sf}" >>"${ROOT}${SITELISP}"/00site-gentoo.el
294# current directory, so disregarding the original directories used in ".el" 417 done
295# arguments.
296#
297# This function manages in such a way that all Emacs Lisp files to be
298# compiled are made visible between themselves, in the event they require or
299# load one another.
300 418
301elisp-comp() { 419 # cleanup
302 # Copyright 1995 Free Software Foundation, Inc. 420 rm -f "${tmpdir}"/site-{gentoo,start}.el
303 # François Pinard <pinard@iro.umontreal.ca>, 1995.
304 # Originally taken from GNU autotools.
305
306 test $# -gt 0 || return 1
307
308 if test -z "${EMACS}" || test "${EMACS}" = "t"; then
309 # Value of "t" means we are running in a shell under Emacs.
310 # Just assume Emacs is called "emacs".
311 EMACS=/usr/bin/emacs
312 fi
313 einfo "Compiling GNU Emacs Elisp files ..."
314
315 tempdir=elc.$$
316 mkdir ${tempdir}
317 cp "$@" ${tempdir}
318 pushd ${tempdir}
319
320 echo "(add-to-list 'load-path \"../\")" > script
321 ${EMACS_BATCH_CLEAN} -l script -f batch-byte-compile *.el
322 local ret=$?
323 mv *.elc ..
324
325 popd
326 rm -fr ${tempdir}
327 return ${ret}
328} 421}

Legend:
Removed from v.1.28  
changed lines
  Added in v.1.38

  ViewVC Help
Powered by ViewVC 1.1.20