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

Legend:
Removed from v.1.20  
changed lines
  Added in v.1.68

  ViewVC Help
Powered by ViewVC 1.1.20