/[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.10 Revision 1.63
1# Copyright 1999-2004 Gentoo Foundation 1# Copyright 1999-2009 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.10 2005/05/03 09:20:13 usata Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.63 2009/11/22 12:06:43 ulm Exp $
4# 4#
5# Copyright 2002-2003 Matthew Kennedy <mkennedy@gentoo.org> 5# Copyright 2002-2004 Matthew Kennedy <mkennedy@gentoo.org>
6# Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com> 6# Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com>
7# Copyright 2004-2005 Mamoru Komachi <usata@gentoo.org>
8# Copyright 2007-2008 Christian Faulhammer <fauli@gentoo.org>
9# Copyright 2007-2009 Ulrich Müller <ulm@gentoo.org>
7# 10#
8# This is not an eclass, but it does provide emacs-related 11# @ECLASS: elisp-common.eclass
9# installation utilities. 12# @MAINTAINER:
13# Feel free to contact the Emacs team through <emacs@gentoo.org> if you
14# have problems, suggestions or questions.
15# @BLURB: Emacs-related installation utilities
16# @DESCRIPTION:
17#
18# Usually you want to use this eclass for (optional) GNU Emacs support
19# of your package. This is NOT for XEmacs!
20#
21# Many of the steps here are sometimes done by the build system of your
22# package (especially compilation), so this is mainly for standalone
23# elisp files you gathered from somewhere else.
24#
25# When relying on the emacs USE flag, you need to add
26#
27# emacs? ( virtual/emacs )
28#
29# to your DEPEND/RDEPEND line and use the functions provided here to
30# bring the files to the correct locations.
31#
32# .SS
33# src_compile() usage:
34#
35# An elisp file is compiled by the elisp-compile() function defined
36# here and simply takes the source files as arguments. The case of
37# interdependent elisp files is also supported, since the current
38# directory is added to the load-path which makes sure that all files
39# are loadable.
40#
41# elisp-compile *.el || die
42#
43# Function elisp-make-autoload-file() can be used to generate a file
44# with autoload definitions for the lisp functions. It takes the output
45# file name (default: "${PN}-autoloads.el") and a list of directories
46# (default: working directory) as its arguments. Use of this function
47# requires that the elisp source files contain magic ";;;###autoload"
48# comments. See the Emacs Lisp Reference Manual (node "Autoload") for
49# a detailed explanation.
50#
51# .SS
52# src_install() usage:
53#
54# The resulting compiled files (.elc) should be put in a subdirectory of
55# /usr/share/emacs/site-lisp/ which is named after the first argument
56# of elisp-install(). The following parameters are the files to be put
57# in that directory. Usually the subdirectory should be ${PN}, you can
58# choose something else, but remember to tell elisp-site-file-install()
59# (see below) the change, as it defaults to ${PN}.
60#
61# elisp-install ${PN} *.el *.elc || die
62#
63# To let the Emacs support be activated by Emacs on startup, you need
64# to provide a site file (shipped in ${FILESDIR}) which contains the
65# startup code (have a look in the documentation of your software).
66# Normally this would look like this:
67#
68# (add-to-list 'load-path "@SITELISP@")
69# (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode))
70# (autoload 'csv-mode "csv-mode" "Major mode for csv files." t)
71#
72# If your Emacs support files are installed in a subdirectory of
73# /usr/share/emacs/site-lisp/ (which is strongly recommended), you need
74# to extend Emacs' load-path as shown in the first non-comment line.
75# The elisp-site-file-install() function of this eclass will replace
76# "@SITELISP@" and "@SITEETC@" by the actual paths.
77#
78# The next line tells Emacs to load the mode opening a file ending
79# with ".csv" and load functions depending on the context and needed
80# features. Be careful though. Commands as "load-library" or "require"
81# bloat the editor as they are loaded on every startup. When having
82# many Emacs support files, users may be annoyed by the start-up time.
83# Also avoid keybindings as they might interfere with the user's
84# settings. Give a hint in pkg_postinst(), which should be enough.
85#
86# The naming scheme for this site-init file matches the shell pattern
87# "[1-8][0-9]*-gentoo*.el", where the two digits at the beginning define
88# the loading order (numbers below 10 or above 89 are reserved for
89# internal use). So if your initialisation depends on another Emacs
90# package, your site file's number must be higher!
91#
92# Best practice is to define a SITEFILE variable in the global scope of
93# your ebuild (e.g., right after S or RDEPEND):
94#
95# SITEFILE="50${PN}-gentoo.el"
96#
97# Which is then installed by
98#
99# elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
100#
101# in src_install(). Any characters after the "-gentoo" part and before
102# the extension will be stripped from the destination file's name.
103# For example, a file "50${PN}-gentoo-${PV}.el" will be installed as
104# "50${PN}-gentoo.el". If your subdirectory is not named ${PN}, give
105# the differing name as second argument.
106#
107# .SS
108# pkg_postinst() / pkg_postrm() usage:
109#
110# After that you need to recreate the start-up file of Emacs after
111# emerging and unmerging by using
112#
113# pkg_postinst() {
114# elisp-site-regen
115# }
116#
117# pkg_postrm() {
118# elisp-site-regen
119# }
120#
121# When having optional Emacs support, you should prepend "use emacs &&"
122# to above calls of elisp-site-regen().
123# Don't use "has_version virtual/emacs"! When unmerging the state of
124# the emacs USE flag is taken from the package database and not from the
125# environment, so it is no problem when you unset USE=emacs between
126# merge and unmerge of a package.
127#
128# .SS
129# Miscellaneous functions:
130#
131# elisp-emacs-version() outputs the version of the currently active Emacs.
10 132
11ECLASS=elisp-common 133# @ECLASS-VARIABLE: SITELISP
12INHERITED="$INHERITED $ECLASS" 134# @DESCRIPTION:
13 135# Directory where packages install Emacs Lisp files.
14SITELISP=/usr/share/emacs/site-lisp 136SITELISP=/usr/share/emacs/site-lisp
15 137
138# @ECLASS-VARIABLE: SITEETC
139# @DESCRIPTION:
140# Directory where packages install miscellaneous (not Lisp) files.
141SITEETC=/usr/share/emacs/etc
142
143# @ECLASS-VARIABLE: EMACS
144# @DESCRIPTION:
145# Path of Emacs executable.
146EMACS=/usr/bin/emacs
147
148# @ECLASS-VARIABLE: EMACSFLAGS
149# @DESCRIPTION:
150# Flags for executing Emacs in batch mode.
151# These work for Emacs versions 18-23, so don't change them.
152EMACSFLAGS="-batch -q --no-site-file"
153
154# @ECLASS-VARIABLE: BYTECOMPFLAGS
155# @DESCRIPTION:
156# Emacs flags used for byte-compilation in elisp-compile().
157BYTECOMPFLAGS="-L ."
158
159# @FUNCTION: elisp-compile
160# @USAGE: <list of elisp files>
161# @DESCRIPTION:
162# Byte-compile Emacs Lisp files.
163#
164# This function uses GNU Emacs to byte-compile all ".el" specified by
165# its arguments. The resulting byte-code (".elc") files are placed in
166# the same directory as their corresponding source file.
167#
168# The current directory is added to the load-path. This will ensure
169# that interdependent Emacs Lisp files are visible between themselves,
170# in case they require or load one another.
171
16elisp-compile() { 172elisp-compile() {
17 /usr/bin/emacs --batch -f batch-byte-compile --no-site-file --no-init-file $* 173 ebegin "Compiling GNU Emacs Elisp files"
174 ${EMACS} ${EMACSFLAGS} ${BYTECOMPFLAGS} -f batch-byte-compile "$@"
175 eend $? "elisp-compile: batch-byte-compile failed"
18} 176}
177
178elisp-comp() {
179 die "Function elisp-comp is not supported any more, see bug 235442"
180}
181
182# @FUNCTION: elisp-emacs-version
183# @DESCRIPTION:
184# Output version of currently active Emacs.
185
186elisp-emacs-version() {
187 # The following will work for at least versions 18-23.
188 echo "(princ emacs-version)" >"${T}"/emacs-version.el
189 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
190 rm -f "${T}"/emacs-version.el
191}
192
193# @FUNCTION: elisp-make-autoload-file
194# @USAGE: [output file] [list of directories]
195# @DESCRIPTION:
196# Generate a file with autoload definitions for the lisp functions.
197
198elisp-make-autoload-file() {
199 local f="${1:-${PN}-autoloads.el}" null="" page=$'\f'
200 shift
201 ebegin "Generating autoload file for GNU Emacs"
202
203 cat >"${f}" <<-EOF
204 ;;; ${f##*/} --- autoloads for ${P}
205
206 ;;; Commentary:
207 ;; Automatically generated by elisp-common.eclass
208 ;; DO NOT EDIT THIS FILE
209
210 ;;; Code:
211 ${page}
212 ;; Local ${null}Variables:
213 ;; version-control: never
214 ;; no-byte-compile: t
215 ;; no-update-autoloads: t
216 ;; End:
217
218 ;;; ${f##*/} ends here
219 EOF
220
221 ${EMACS} ${EMACSFLAGS} \
222 --eval "(setq make-backup-files nil)" \
223 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
224 -f batch-update-autoloads "${@-.}"
225
226 eend $? "elisp-make-autoload-file: batch-update-autoloads failed"
227}
228
229# @FUNCTION: elisp-install
230# @USAGE: <subdirectory> <list of files>
231# @DESCRIPTION:
232# Install files in SITELISP directory.
19 233
20elisp-install() { 234elisp-install() {
21 local subdir=$1 235 local subdir="$1"
22 dodir ${SITELISP}/${subdir}
23 insinto ${SITELISP}/${subdir}
24 shift 236 shift
237 ebegin "Installing Elisp files for GNU Emacs support"
238 ( # subshell to avoid pollution of calling environment
239 insinto "${SITELISP}/${subdir}"
25 doins $@ 240 doins "$@"
241 )
242 eend $? "elisp-install: doins failed"
26} 243}
244
245# @FUNCTION: elisp-site-file-install
246# @USAGE: <site-init file> [subdirectory]
247# @DESCRIPTION:
248# Install Emacs site-init file in SITELISP directory. Automatically
249# inserts a standard comment header with the name of the package (unless
250# it is already present). Tokens @SITELISP@ and @SITEETC@ are replaced
251# by the path to the package's subdirectory in SITELISP and SITEETC,
252# respectively.
27 253
28elisp-site-file-install() { 254elisp-site-file-install() {
29 local sitefile=$1 my_pn=${2:-${PN}} 255 local sf="${1##*/}" my_pn="${2:-${PN}}" ret
30 pushd ${S} 256 local header=";;; ${PN} site-lisp configuration"
31 cp ${sitefile} ${T} 257
32 sed -i "s:@SITELISP@:${SITELISP}/${my_pn}:g" ${T}/$(basename ${sitefile}) 258 [[ ${sf} == [0-9][0-9]*-gentoo*.el ]] \
33 insinto ${SITELISP} 259 || ewarn "elisp-site-file-install: bad name of site-init file"
34 doins ${T}/$(basename ${sitefile}) || die "failed to install site file" 260 sf="${T}/${sf/%-gentoo*.el/-gentoo.el}"
35 popd 261 ebegin "Installing site initialisation file for GNU Emacs"
262 [[ $1 = ${sf} ]] || cp "$1" "${sf}"
263 sed -i -e "1{:x;/^\$/{n;bx;};/^;.*${PN}/I!s:^:${header}\n\n:;1s:^:\n:;}" \
264 -e "s:@SITELISP@:${SITELISP}/${my_pn}:g" \
265 -e "s:@SITEETC@:${SITEETC}/${my_pn}:g;\$q" "${sf}"
266 ( # subshell to avoid pollution of calling environment
267 insinto "${SITELISP}/site-gentoo.d"
268 doins "${sf}"
269 )
270 ret=$?
271 rm -f "${sf}"
272 eend ${ret} "elisp-site-file-install: doins failed"
36} 273}
274
275# @FUNCTION: elisp-site-regen
276# @DESCRIPTION:
277# Regenerate the site-gentoo.el file, based on packages' site
278# initialisation files in the /usr/share/emacs/site-lisp/site-gentoo.d/
279# directory.
280#
281# Note: Before December 2007, site initialisation files were installed
282# in /usr/share/emacs/site-lisp/. For backwards compatibility, this
283# location is still supported when generating site-gentoo.el.
37 284
38elisp-site-regen() { 285elisp-site-regen() {
39 einfo "Regenerating ${SITELISP}/site-gentoo.el ..." 286 local i sf line obsolete null="" page=$'\f'
40 einfo "" 287 local -a sflist
41 cat <<EOF >${SITELISP}/site-gentoo.el
42;;; DO NOT EDIT THIS FILE -- IT IS GENERATED AUTOMATICALLY BY PORTAGE
43;;; -----------------------------------------------------------------
44 288
45EOF 289 if [ ! -d "${ROOT}${SITELISP}" ]; then
46 ls ${SITELISP}/[0-9][0-9]*-gentoo.el |sort -n | \ 290 eerror "elisp-site-regen: Directory ${SITELISP} does not exist"
47 while read sf 291 return 1
292 fi
293
294 if [ ! -d "${T}" ]; then
295 eerror "elisp-site-regen: Temporary directory ${T} does not exist"
296 return 1
297 fi
298
299 einfon "Regenerating site-gentoo.el for GNU Emacs (${EBUILD_PHASE}) ..."
300
301 # Until January 2009, elisp-common.eclass sometimes created an
302 # auxiliary file for backwards compatibility. Remove any such file.
303 rm -f "${ROOT}${SITELISP}"/00site-gentoo.el
304
305 # set nullglob option, there may be a directory without matching files
306 local old_shopts=$(shopt -p nullglob)
307 shopt -s nullglob
308
309 for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el \
310 "${ROOT}${SITELISP}"/site-gentoo.d/[0-9][0-9]*.el
48 do 311 do
49 einfo " Adding $(basename $sf) ..." 312 [ -r "${sf}" ] || continue
50 # Great for debugging, too noisy and slow for users though 313 # sort files by their basename. straight insertion sort.
51# echo "(message \"Loading $sf ...\")" >>${SITELISP}/site-start.el 314 for ((i=${#sflist[@]}; i>0; i--)); do
52 cat $sf >>${SITELISP}/site-gentoo.el 315 [[ ${sf##*/} < ${sflist[i-1]##*/} ]] || break
316 sflist[i]=${sflist[i-1]}
317 done
318 sflist[i]=${sf}
319 # set a flag if there are obsolete files
320 [ "${sf%/*}" = "${ROOT}${SITELISP}" ] && obsolete=t
53 done 321 done
54 while read line; do einfo "${line}"; done <<EOF
55 322
56All site initialization for Gentoo-installed packages is now added to 323 eval "${old_shopts}"
57/usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer
58managed by Gentoo. You are responsible for all maintenance of
59site-start.el if there is such a file.
60 324
61In order for this site initialization to be loaded for all users 325 cat <<-EOF >"${T}"/site-gentoo.el
62automatically, as was done previously, you can add a line like this: 326 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
63 327
64 (load "/usr/share/emacs/site-lisp/site-gentoo") 328 ;;; Commentary:
329 ;; Automatically generated by elisp-common.eclass
330 ;; DO NOT EDIT THIS FILE
65 331
66to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line 332 ;;; Code:
67can be added by individual users to their initialization files, or for
68greater flexibility, users can select which of the package-specific
69initialization files in /usr/share/emacs/site-lisp to load.
70EOF 333 EOF
71 echo 334 # Use sed instead of cat here, since files may miss a trailing newline.
72} 335 sed '$q' "${sflist[@]}" </dev/null >>"${T}"/site-gentoo.el
336 cat <<-EOF >>"${T}"/site-gentoo.el
73 337
74# The following Emacs Lisp compilation routine is taken from GNU 338 (provide 'site-gentoo)
75# autotools.
76 339
77elisp-comp() { 340 ${page}
78# Copyright 1995 Free Software Foundation, Inc. 341 ;; Local ${null}Variables:
79# François Pinard <pinard@iro.umontreal.ca>, 1995. 342 ;; no-byte-compile: t
80# 343 ;; buffer-read-only: t
81# This program is free software; you can redistribute it and/or modify 344 ;; End:
82# it under the terms of the GNU General Public License as published by
83# the Free Software Foundation; either version 2, or (at your option)
84# any later version.
85#
86# This program is distributed in the hope that it will be useful,
87# but WITHOUT ANY WARRANTY; without even the implied warranty of
88# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
89# GNU General Public License for more details.
90#
91# You should have received a copy of the GNU General Public License
92# along with this program; if not, write to the Free Software
93# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
94 345
95# As a special exception to the GNU General Public License, if you 346 ;;; site-gentoo.el ends here
96# distribute this file as part of a program that contains a 347 EOF
97# configuration script generated by Autoconf, you may include it under
98# the same distribution terms that you use for the rest of that program.
99 348
100# This script byte-compiles all `.el' files which are part of its 349 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${T}"/site-gentoo.el
101# arguments, using GNU Emacs, and put the resulting `.elc' files into 350 then
102# the current directory, so disregarding the original directories used 351 # This prevents outputting unnecessary text when there
103# in `.el' arguments. 352 # was actually no change.
104# 353 # A case is a remerge where we have doubled output.
105# This script manages in such a way that all Emacs LISP files to 354 echo " no changes."
106# be compiled are made visible between themselves, in the event
107# they require or load-library one another.
108
109 if test $# = 0; then
110 echo 1>&2 "No files given to $0"
111 exit 1
112 else 355 else
113 if test -z "$EMACS" || test "$EMACS" = "t"; then 356 mv "${T}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
114 # Value of "t" means we are running in a shell under Emacs. 357 echo
115 # Just assume Emacs is called "emacs". 358 case ${#sflist[@]} in
116 EMACS=emacs 359 0) ewarn "... Huh? No site initialisation files found." ;;
117 fi 360 1) einfo "... ${#sflist[@]} site initialisation file included." ;;
118 361 *) einfo "... ${#sflist[@]} site initialisation files included." ;;
119 tempdir=elc.$$ 362 esac
120 mkdir $tempdir
121 cp $* $tempdir
122 cd $tempdir
123
124 echo "(add-to-list 'load-path \"../\")" > script
125 $EMACS -batch -q --no-site-file --no-init-file -l script -f batch-byte-compile *.el
126 mv *.elc ..
127
128 cd ..
129 rm -fr $tempdir
130 fi 363 fi
131}
132 364
133# Local Variables: *** 365 if [ "${obsolete}" ]; then
134# mode: shell-script *** 366 echo
135# tab-width: 4 *** 367 while read line; do ewarn "${line}"; done <<-EOF
136# indent-tabs-mode: t *** 368 Site-initialisation files of Emacs packages are now installed in
137# End: *** 369 /usr/share/emacs/site-lisp/site-gentoo.d/. We strongly recommend
370 that you use app-admin/emacs-updater to rebuild the installed
371 Emacs packages.
372 EOF
373 fi
138 374
375 # cleanup
376 rm -f "${T}"/site-gentoo.el
377
378 return 0
379}

Legend:
Removed from v.1.10  
changed lines
  Added in v.1.63

  ViewVC Help
Powered by ViewVC 1.1.20