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

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

  ViewVC Help
Powered by ViewVC 1.1.20