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

Legend:
Removed from v.1.11  
changed lines
  Added in v.1.73

  ViewVC Help
Powered by ViewVC 1.1.20