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

  ViewVC Help
Powered by ViewVC 1.1.20