/[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.29
1# Copyright 1999-2004 Gentoo Foundation 1# Copyright 1999-2007 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.29 2007/10/14 22:12:30 ulm Exp $
4# 4#
5# Copyright 2007 Christian Faulhammer <opfer@gentoo.org>
5# Copyright 2002-2003 Matthew Kennedy <mkennedy@gentoo.org> 6# Copyright 2002-2004 Matthew Kennedy <mkennedy@gentoo.org>
7# Copyright 2004-2005 Mamoru Komachi <usata@gentoo.org>
6# Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com> 8# Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com>
9# Copyright 2007 Ulrich Mueller <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 have
14# 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 of
19# 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 elisp
23# 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 bring
30# 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 here and
36# simply takes the source files as arguments.
37#
38# elisp-compile *.el || die "elisp-compile failed"
39#
40# In the case of interdependent elisp files, you can use the elisp-comp()
41# function which makes sure all files are loadable.
42#
43# elisp-comp *.el || die "elisp-comp failed"
44#
45# Function elisp-make-autoload-file() can be used to generate a file with
46# autoload definitions for the lisp functions. It takes the output file name
47# (default: "${PN}-autoloads.el") and a list of directories (default: working
48# directory) as its arguments. Use of this function requires that the elisp
49# source files contain magic ";;;###autoload" comments. See the Emacs Lisp
50# Reference Manual (node "Autoload") for a detailed explanation.
51#
52# .SS
53# src_install() usage:
54#
55# The resulting compiled files (.elc) should be put in a subdirectory of
56# /usr/share/emacs/site-lisp/ which is named after the first argument
57# of elisp-install(). The following parameters are the files to be put in
58# that directory. Usually the subdirectory should be ${PN}, you can choose
59# something else, but remember to tell elisp-site-file-install() (see below)
60# the change, as it defaults to ${PN}.
61#
62# elisp-install ${PN} *.el *.elc || die "elisp-install failed"
63#
64# To let the Emacs support be activated by Emacs on startup, you need
65# to provide a site file (shipped in ${FILESDIR}) which contains the startup
66# code (have a look in the documentation of your software). Normally this
67# would look like this:
68#
69# ;;; csv-mode site-lisp configuration
70#
71# (add-to-list 'load-path "@SITELISP@")
72# (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode))
73# (autoload 'csv-mode "csv-mode" "Major mode for csv files." t)
74#
75# If your Emacs support files are installed in a subdirectory of
76# /usr/share/emacs/site-lisp/ (which is recommended), you need to extend
77# Emacs' load-path as shown in the first non-comment.
78# The elisp-site-file-install() function of this eclass will replace
79# "@SITELISP@" by the actual path.
80#
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.
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
85# support files, users may be annoyed by the start-up time. Also avoid
86# keybindings as they might interfere with the user's settings. Give a hint
87# in pkg_postinst(), which should be enough.
88#
89# The naming scheme for this site file is "[0-9][0-9]*-gentoo.el", where the
90# two digits at the beginning define the loading order. So if you depend on
91# another Emacs package, your site file's number must be higher!
92#
93# Best practice is to define a SITEFILE variable in the global scope of your
94# ebuild (right after DEPEND e.g.):
95#
96# SITEFILE=50${PN}-gentoo.el
97#
98# Which is then installed by
99#
100# elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
101#
102# in src_install(). If your subdirectory is not named ${PN}, give the
103# differing name as second argument.
104#
105# .SS
106# pkg_postinst() / pkg_postrm() usage:
107#
108# After that you need to recreate the start-up file of Emacs after emerging
109# and unmerging by using
110#
111# pkg_postinst() {
112# elisp-site-regen
113# }
114#
115# pkg_postrm() {
116# elisp-site-regen
117# }
118#
119# When having optional Emacs support, you should prepend "use emacs &&" to
120# above calls of elisp-site-regen(). Don't use "has_version virtual/emacs"!
121# When unmerging the state of the emacs USE flag is taken from the package
122# database and not from the environment, so it is no problem when you unset
123# USE=emacs between merge and unmerge of a package.
124#
125# .SS
126# Miscellaneous functions:
127#
128# elisp-emacs-version() outputs the version of the currently active Emacs.
10 129
11INHERITED="$INHERITED $ECLASS" 130# @ECLASS-VARIABLE: SITELISP
12 131# @DESCRIPTION:
132# Directory where Emacs Lisp files are installed.
13SITELISP=/usr/share/emacs/site-lisp 133SITELISP=/usr/share/emacs/site-lisp
14 134
135# @ECLASS-VARIABLE: SITEFILE
136# @DESCRIPTION:
137# Name of package's site-init file.
138SITEFILE=50${PN}-gentoo.el
139
140EMACS=/usr/bin/emacs
141# The following works for Emacs versions 18--23, don't change it.
142EMACS_BATCH_CLEAN="${EMACS} -batch -q --no-site-file"
143
144# @FUNCTION: elisp-compile
145# @USAGE: <list of elisp files>
146# @DESCRIPTION:
147# Byte-compile Emacs Lisp files.
148
15elisp-compile() { 149elisp-compile() {
16 /usr/bin/emacs --batch -f batch-byte-compile --no-site-file --no-init-file $* 150 einfo "Compiling GNU Emacs Elisp files ..."
151 ${EMACS_BATCH_CLEAN} -f batch-byte-compile "$@"
17} 152}
153
154# @FUNCTION: elisp-emacs-version
155# @DESCRIPTION:
156# Output version of currently active Emacs.
157
158elisp-emacs-version() {
159 # The following will work for at least versions 18-23.
160 echo "(princ emacs-version)" >"${T}"/emacs-version.el
161 ${EMACS_BATCH_CLEAN} -l "${T}"/emacs-version.el
162}
163
164# @FUNCTION: elisp-make-autoload-file
165# @USAGE: [output file] [list of directories]
166# @DESCRIPTION:
167# Generate a file with autoload definitions for the lisp functions.
168
169elisp-make-autoload-file() {
170 local f="${1:-${PN}-autoloads.el}"
171 shift
172 einfo "Generating autoload file for GNU Emacs ..."
173
174 sed 's/^FF/\f/' >"${f}" <<-EOF
175 ;;; ${f##*/} --- autoloads for ${P}
176
177 ;;; Commentary:
178 ;; Automatically generated by elisp-common.eclass
179 ;; DO NOT EDIT THIS FILE
180
181 ;;; Code:
182 FF
183 ;; Local Variables:
184 ;; version-control: never
185 ;; no-byte-compile: t
186 ;; no-update-autoloads: t
187 ;; End:
188 ;;; ${f##*/} ends here
189 EOF
190
191 ${EMACS_BATCH_CLEAN} \
192 --eval "(setq make-backup-files nil)" \
193 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
194 -f batch-update-autoloads "${@-.}"
195}
196
197# @FUNCTION: elisp-install
198# @USAGE: <subdirectory> <list of files>
199# @DESCRIPTION:
200# Install files in SITELISP directory.
18 201
19elisp-install() { 202elisp-install() {
20 local subdir=$1 203 local subdir="$1"
21 dodir ${SITELISP}/${subdir}
22 insinto ${SITELISP}/${subdir}
23 shift 204 shift
205 einfo "Installing Elisp files for GNU Emacs support ..."
206 ( # subshell to avoid pollution of calling environment
207 insinto "${SITELISP}/${subdir}"
24 doins $@ 208 doins "$@"
209 )
25} 210}
211
212# @FUNCTION: elisp-site-file-install
213# @USAGE: <site-init file> [subdirectory]
214# @DESCRIPTION:
215# Install Emacs site-init file in SITELISP directory.
26 216
27elisp-site-file-install() { 217elisp-site-file-install() {
28 local sitefile=$1 my_pn=${2:-${PN}} 218 local sf="$1" my_pn="${2:-${PN}}"
29 pushd ${S} 219 einfo "Installing site initialisation file for GNU Emacs ..."
30 cp ${sitefile} ${T} 220 cp "${sf}" "${T}"
31 sed -i "s:@SITELISP@:${SITELISP}/${my_pn}:g" ${T}/$(basename ${sitefile}) 221 sed -i "s:@SITELISP@:${SITELISP}/${my_pn}:g" "${T}/$(basename "${sf}")"
222 ( # subshell to avoid pollution of calling environment
32 insinto ${SITELISP} 223 insinto "${SITELISP}"
33 doins ${T}/$(basename ${sitefile}) || die "failed to install site file" 224 doins "${T}/$(basename "${sf}")"
34 popd 225 )
35} 226}
227
228# @FUNCTION: elisp-site-regen
229# @DESCRIPTION:
230# Regenerate site-gentoo.el file.
36 231
37elisp-site-regen() { 232elisp-site-regen() {
233 local sflist sf line
234
235 if [ ! -e "${ROOT}${SITELISP}"/site-gentoo.el ] \
236 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then
237 einfo "Creating default ${SITELISP}/site-start.el ..."
238 cat <<-EOF >"${T}"/site-start.el
239 ;;; site-start.el
240
241 ;;; Commentary:
242 ;; This default site startup file is installed by elisp-common.eclass.
243 ;; You may replace this file by your own site initialisation, or even
244 ;; remove it completely; it will not be recreated.
245
246 ;;; Code:
247 ;; Load site initialisation for Gentoo-installed packages.
248 (require 'site-gentoo)
249
250 ;;; site-start.el ends here
251 EOF
252 fi
253
38 einfo "Regenerating ${SITELISP}/site-gentoo.el ..." 254 einfon "Regenerating ${SITELISP}/site-gentoo.el ..."
39 einfo ""
40 cat <<EOF >${SITELISP}/site-gentoo.el 255 cat <<-EOF >"${T}"/site-gentoo.el
41;;; DO NOT EDIT THIS FILE -- IT IS GENERATED AUTOMATICALLY BY PORTAGE 256 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
42;;; -----------------------------------------------------------------
43 257
258 ;;; Commentary:
259 ;; Automatically generated by elisp-common.eclass
260 ;; DO NOT EDIT THIS FILE
261
262 ;;; Code:
44EOF 263 EOF
45 ls ${SITELISP}/[0-9][0-9]*-gentoo.el |sort -n | \ 264
46 while read sf 265 for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el
47 do 266 do
48 einfo " Adding $(basename $sf) ..." 267 [ -r "${sf}" ] || continue
49 # Great for debugging, too noisy and slow for users though 268 sflist="${sflist} $(basename "${sf}")"
50# echo "(message \"Loading $sf ...\")" >>${SITELISP}/site-start.el
51 cat $sf >>${SITELISP}/site-gentoo.el 269 cat "${sf}" >>"${T}"/site-gentoo.el
52 done 270 done
271
272 cat <<-EOF >>"${T}"/site-gentoo.el
273
274 (provide 'site-gentoo)
275
276 ;; Local Variables:
277 ;; no-byte-compile: t
278 ;; End:
279 ;;; site-gentoo.el ends here
280 EOF
281
282 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${T}"/site-gentoo.el; then
283 # This prevents outputting unnecessary text when there
284 # was actually no change.
285 # A case is a remerge where we have doubled output.
286 echo " no changes."
287 else
288 mv "${T}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
289 [ -f "${T}"/site-start.el ] \
290 && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \
291 && mv "${T}"/site-start.el "${ROOT}${SITELISP}"/site-start.el
292 echo; einfo
293 for sf in ${sflist}; do
294 einfo " Adding ${sf} ..."
295 done
53 while read line; do einfo "${line}"; done <<EOF 296 while read line; do einfo "${line}"; done <<EOF
54 297
55All site initialization for Gentoo-installed packages is now added to 298All site initialisation for Gentoo-installed packages is added to
56/usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer 299/usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer
57managed by Gentoo. You are responsible for all maintenance of 300managed by Gentoo. You are responsible for all maintenance of
58site-start.el if there is such a file. 301site-start.el if there is such a file.
59 302
60In order for this site initialization to be loaded for all users 303In order for this site initialisation to be loaded for all users
61automatically, as was done previously, you can add a line like this: 304automatically, you can add a line like this:
62 305
63 (load "/usr/share/emacs/site-lisp/site-gentoo") 306 (require 'site-gentoo)
64 307
65to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line 308to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
66can be added by individual users to their initialization files, or for 309can be added by individual users to their initialisation files, or for
67greater flexibility, users can select which of the package-specific 310greater flexibility, users can select which of the package-specific
68initialization files in /usr/share/emacs/site-lisp to load. 311initialisation files in /usr/share/emacs/site-lisp/ to load.
69EOF 312EOF
70 echo 313 echo
314 fi
71} 315}
72 316
73# The following Emacs Lisp compilation routine is taken from GNU 317# @FUNCTION: elisp-comp
74# autotools. 318# @USAGE: <list of elisp files>
319# @DESCRIPTION:
320# Byte-compile interdependent Emacs Lisp files.
321#
322# This function byte-compiles all ".el" files which are part of its
323# arguments, using GNU Emacs, and puts the resulting ".elc" files into the
324# current directory, so disregarding the original directories used in ".el"
325# arguments.
326#
327# This function manages in such a way that all Emacs Lisp files to be
328# compiled are made visible between themselves, in the event they require or
329# load one another.
75 330
76elisp-comp() { 331elisp-comp() {
77# Copyright 1995 Free Software Foundation, Inc. 332 # Copyright 1995 Free Software Foundation, Inc.
78# Fran็ois Pinard <pinard@iro.umontreal.ca>, 1995. 333 # Franรงois Pinard <pinard@iro.umontreal.ca>, 1995.
79# 334 # Originally taken from GNU autotools.
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 335
94# As a special exception to the GNU General Public License, if you 336 test $# -gt 0 || return 1
95# distribute this file as part of a program that contains a
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 337
99# This script byte-compiles all `.el' files which are part of its
100# arguments, using GNU Emacs, and put the resulting `.elc' files into
101# the current directory, so disregarding the original directories used
102# in `.el' arguments.
103#
104# This script manages in such a way that all Emacs LISP files to
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
112 if test -z "$EMACS" || test "$EMACS" = "t"; then 338 if test -z "${EMACS}" || test "${EMACS}" = "t"; then
113 # Value of "t" means we are running in a shell under Emacs. 339 # Value of "t" means we are running in a shell under Emacs.
114 # Just assume Emacs is called "emacs". 340 # Just assume Emacs is called "emacs".
115 EMACS=emacs 341 EMACS=/usr/bin/emacs
116 fi
117
118 tempdir=elc.$$
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 342 fi
130} 343 einfo "Compiling GNU Emacs Elisp files ..."
131 344
132# Local Variables: *** 345 tempdir=elc.$$
133# mode: shell-script *** 346 mkdir ${tempdir}
134# tab-width: 4 *** 347 cp "$@" ${tempdir}
135# indent-tabs-mode: t *** 348 pushd ${tempdir}
136# End: ***
137 349
350 echo "(add-to-list 'load-path \"../\")" > script
351 ${EMACS_BATCH_CLEAN} -l script -f batch-byte-compile *.el
352 local ret=$?
353 mv *.elc ..
354
355 popd
356 rm -fr ${tempdir}
357 return ${ret}
358}
Legend:
Removed from v.1.11  
changed lines
  Added in v.1.29
  ViewVC Help
Powered by ViewVC 1.1.13