/[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.26
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.26 2007/07/25 05:07:32 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#
63# ;;; csv-mode site-lisp configuration 69# ;;; csv-mode site-lisp configuration
64# 70#
65# (add-to-list 'load-path "@SITELISP@") 71# (add-to-list 'load-path "@SITELISP@")
66# (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode)) 72# (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode))
67# (autoload 'csv-mode "csv-mode" "Major mode for editing csv files." t) 73# (autoload 'csv-mode "csv-mode" "Major mode for csv files." t)
68# 74#
69# If your Emacs support files are installed in a subdirectory of 75# 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 76# /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 77# 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 78# non-comment. The elisp-site-file-install() function of this eclass will
73# replace "@SITELISP@" by the actual path. 79# replace "@SITELISP@" by the actual path.
80#
74# The next line tells Emacs to load the mode opening a file ending with 81# 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. 82# ".csv" and load functions depending on the context and needed features.
76# Be careful though. Commands as "load-library" or "require" bloat the 83# 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 84# 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 85# 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 86# keybindings as they might interfere with the user's settings. Give a hint
80# in pkg_postinst(), which should be enough. 87# in pkg_postinst(), which should be enough.
88#
81# The naming scheme for this site file is "[0-9][0-9]*-gentoo.el", where the 89# 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 90# 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! 91# another Emacs package, your site file's number must be higher!
92#
84# Best practice is to define a SITEFILE variable in the global scope of your 93# Best practice is to define a SITEFILE variable in the global scope of your
85# ebuild (right after DEPEND e.g.): 94# ebuild (right after DEPEND e.g.):
86# 95#
87# SITEFILE=50${PN}-gentoo.el 96# SITEFILE=50${PN}-gentoo.el
88# 97#
89# Which is then installed by 98# Which is then installed by
90# 99#
91# elisp-site-file-install "${FILESDIR}/${SITEFILE}" 100# elisp-site-file-install "${FILESDIR}/${SITEFILE}"
92# 101#
93# in src_install(). If your subdirectory is not named ${PN}, give the 102# in src_install(). If your subdirectory is not named ${PN}, give the
94# differing name as second argument. 103# differing name as second argument.
95# 104#
105# .SS
96# pkg_postinst() / pkg_postrm() usage: 106# pkg_postinst() / pkg_postrm() usage:
97# ------------------------------------
98# 107#
99# After that you need to recreate the start-up file of Emacs after emerging 108# After that you need to recreate the start-up file of Emacs after emerging
100# and unmerging by using 109# and unmerging by using
101# 110#
102# pkg_postinst() { 111# pkg_postinst() {
103# elisp-site-regen 112# elisp-site-regen
104# } 113# }
114#
105# pkg_postrm() { 115# pkg_postrm() {
106# elisp-site-regen 116# elisp-site-regen
107# } 117# }
108# 118#
109# As always: Feel free to contact Emacs team through emacs@gentoo.org if you 119# When having optional Emacs support, you should prepend "use emacs &&" to
110# have problems, suggestions or questions. 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.
111 129
112SITELISP=/usr/share/emacs/site-lisp 130SITELISP=/usr/share/emacs/site-lisp
131SITEFILE=50${PN}-gentoo.el
132
133# @FUNCTION: elisp-compile
134# @USAGE: <list of elisp files>
135# @DESCRIPTION:
136# Byte-compile Emacs Lisp files.
113 137
114elisp-compile() { 138elisp-compile() {
115 /usr/bin/emacs --batch -f batch-byte-compile --no-site-file --no-init-file $* 139 einfo "Compiling GNU Emacs Elisp files ..."
140 /usr/bin/emacs -batch -q --no-site-file -f batch-byte-compile $*
116} 141}
142
143# @FUNCTION: elisp-emacs-version
144# @DESCRIPTION:
145# Output version of currently active Emacs.
146
147elisp-emacs-version() {
148 # The following will work for at least versions 18-22.
149 echo "(princ emacs-version)" >"${T}"/emacs-version.el
150 /usr/bin/emacs -batch -q --no-site-file -l "${T}"/emacs-version.el
151}
152
153# @FUNCTION: elisp-make-autoload-file
154# @USAGE: [output file] [list of directories]
155# @DESCRIPTION:
156# Generate a file with autoload definitions for the lisp functions.
117 157
118elisp-make-autoload-file () { 158elisp-make-autoload-file () {
119 local f="${1:-${PN}-autoloads.el}" 159 local f="${1:-${PN}-autoloads.el}"
120 shift 160 shift
121 echo >"${f}" 161 einfo "Generating autoload file for GNU Emacs ..."
162
163 sed 's/^FF/\f/' >"${f}" <<-EOF
164 ;;; ${f##*/} --- autoloads for ${P}
165
166 ;;; Commentary:
167 ;; Automatically generated by elisp-common.eclass
168 ;; DO NOT EDIT THIS FILE
169
170 ;;; Code:
171 FF
172 ;; Local Variables:
173 ;; version-control: never
174 ;; no-byte-compile: t
175 ;; no-update-autoloads: t
176 ;; End:
177 ;;; ${f##*/} ends here
178 EOF
179
122 emacs --batch -q --no-site-file \ 180 /usr/bin/emacs -batch -q --no-site-file \
123 --eval "(setq make-backup-files nil)" \ 181 --eval "(setq make-backup-files nil)" \
124 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \ 182 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
125 -f batch-update-autoloads "${@-.}" 183 -f batch-update-autoloads "${@-.}"
126} 184}
127 185
186# @FUNCTION: elisp-install
187# @USAGE: <subdirectory> <list of files>
188# @DESCRIPTION:
189# Install files in SITELISP directory.
190
128elisp-install() { 191elisp-install() {
129 local subdir=$1 192 local subdir=$1
193 einfo "Installing Elisp files for GNU Emacs support ..."
130 dodir "${SITELISP}/${subdir}" 194 dodir "${SITELISP}/${subdir}"
131 insinto "${SITELISP}/${subdir}" 195 insinto "${SITELISP}/${subdir}"
132 shift 196 shift
133 doins $@ 197 doins $@
134} 198}
135 199
200# @FUNCTION: elisp-site-file-install
201# @USAGE: <site-init file> [subdirectory]
202# @DESCRIPTION:
203# Install Emacs site-init file in SITELISP directory.
204
136elisp-site-file-install() { 205elisp-site-file-install() {
137 local sitefile=$1 my_pn=${2:-${PN}} 206 local sitefile=$1 my_pn=${2:-${PN}}
207 einfo "Installing site initialisation file for GNU Emacs ..."
138 pushd "${S}" 208 pushd "${S}"
139 cp ${sitefile} "${T}" 209 cp ${sitefile} "${T}"
140 sed -i "s:@SITELISP@:${SITELISP}/${my_pn}:g" "${T}/$(basename ${sitefile})" 210 sed -i "s:@SITELISP@:${SITELISP}/${my_pn}:g" "${T}/$(basename ${sitefile})"
141 insinto ${SITELISP} 211 insinto ${SITELISP}
142 doins "${T}/$(basename ${sitefile})" || die "failed to install site file" 212 doins "${T}/$(basename ${sitefile})" || die "failed to install site file"
143 popd 213 popd
144} 214}
145 215
216# @FUNCTION: elisp-site-regen
217# @DESCRIPTION:
218# Regenerate site-gentoo.el file.
219
146elisp-site-regen() { 220elisp-site-regen() {
221 local sflist sf line
222
147 einfo "Regenerating ${SITELISP}/site-gentoo.el ..." 223 einfon "Regenerating ${SITELISP}/site-gentoo.el ..."
148 einfo ""
149 cat <<EOF >${ROOT}${SITELISP}/site-gentoo.el 224 cat <<-EOF >"${T}"/site-gentoo.el
150;;; DO NOT EDIT THIS FILE -- IT IS GENERATED AUTOMATICALLY BY PORTAGE 225 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
151;;; -----------------------------------------------------------------
152 226
227 ;;; Commentary:
228 ;; Automatically generated by elisp-common.eclass
229 ;; DO NOT EDIT THIS FILE
230
231 ;;; Code:
153EOF 232 EOF
233
154 for sf in ${ROOT}${SITELISP}/[0-9][0-9]*-gentoo.el 234 for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el
155 do 235 do
156 [ -r "${sf}" ] || continue 236 [ -r "${sf}" ] || continue
157 einfo " Adding $(basename ${sf}) ..." 237 sflist="${sflist} $(basename "${sf}")"
158 cat "${sf}" >>${ROOT}${SITELISP}/site-gentoo.el 238 cat "${sf}" >>"${T}"/site-gentoo.el
159 done 239 done
240
241 cat <<-EOF >>"${T}"/site-gentoo.el
242
243 ;;; site-gentoo.el ends here
244 EOF
245
246 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${T}"/site-gentoo.el; then
247 # This prevents outputting unnecessary text when there
248 # was actually no change
249 # A case is a remerge where we have doubled output
250 echo " no changes."
251 else
252 mv "${T}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
253 echo; einfo
254 for sf in ${sflist}; do
255 einfo " Adding ${sf} ..."
256 done
160 while read line; do einfo "${line}"; done <<EOF 257 while read line; do einfo "${line}"; done <<EOF
161 258
162All site initialization for Gentoo-installed packages is now added to 259All site initialisation for Gentoo-installed packages is added to
163/usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer 260/usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer
164managed by Gentoo. You are responsible for all maintenance of 261managed by Gentoo. You are responsible for all maintenance of
165site-start.el if there is such a file. 262site-start.el if there is such a file.
166 263
167In order for this site initialization to be loaded for all users 264In order for this site initialisation to be loaded for all users
168automatically, as was done previously, you can add a line like this: 265automatically, you can add a line like this:
169 266
170 (load "/usr/share/emacs/site-lisp/site-gentoo" nil t) 267 (load "/usr/share/emacs/site-lisp/site-gentoo" nil t)
171 268
172to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line 269to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
173can be added by individual users to their initialization files, or for 270can be added by individual users to their initialisation files, or for
174greater flexibility, users can select which of the package-specific 271greater flexibility, users can select which of the package-specific
175initialization files in /usr/share/emacs/site-lisp to load. 272initialisation files in /usr/share/emacs/site-lisp to load.
176EOF 273EOF
177 echo 274 echo
275 fi
178} 276}
179 277
180# The following Emacs Lisp compilation routine is taken from GNU 278# @FUNCTION: elisp-comp
181# autotools. 279# @USAGE: <list of elisp files>
280# @DESCRIPTION:
281# Byte-compile interdependent Emacs Lisp files.
282# Originally taken from GNU autotools.
182 283
183elisp-comp() { 284elisp-comp() {
184# Copyright 1995 Free Software Foundation, Inc. 285 # Copyright 1995 Free Software Foundation, Inc.
185# Fran├žois Pinard <pinard@iro.umontreal.ca>, 1995. 286 # Fran├žois Pinard <pinard@iro.umontreal.ca>, 1995.
186# This script byte-compiles all `.el' files which are part of its 287 # This script byte-compiles all `.el' files which are part of its
187# arguments, using GNU Emacs, and put the resulting `.elc' files into 288 # arguments, using GNU Emacs, and put the resulting `.elc' files into
188# the current directory, so disregarding the original directories used 289 # the current directory, so disregarding the original directories used
189# in `.el' arguments. 290 # in `.el' arguments.
190# 291 #
191# This script manages in such a way that all Emacs LISP files to 292 # This script manages in such a way that all Emacs LISP files to
192# be compiled are made visible between themselves, in the event 293 # be compiled are made visible between themselves, in the event
193# they require or load-library one another. 294 # they require or load-library one another.
194 295
195 if test $# = 0; then 296 test $# -gt 0 || return 1
196 exit 1 297
197 else
198 if test -z "${EMACS}" || test "${EMACS}" = "t"; then 298 if test -z "${EMACS}" || test "${EMACS}" = "t"; then
199 # Value of "t" means we are running in a shell under Emacs. 299 # Value of "t" means we are running in a shell under Emacs.
200 # Just assume Emacs is called "emacs". 300 # Just assume Emacs is called "emacs".
201 EMACS=emacs 301 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 302 fi
303 einfo "Compiling GNU Emacs Elisp files ..."
304
305 tempdir=elc.$$
306 mkdir ${tempdir}
307 cp $* ${tempdir}
308 pushd ${tempdir}
309
310 echo "(add-to-list 'load-path \"../\")" > script
311 ${EMACS} -batch -q --no-site-file --no-init-file -l script \
312 -f batch-byte-compile *.el
313 local status=$?
314 mv *.elc ..
315
316 popd
317 rm -fr ${tempdir}
318 return ${status}
216} 319}

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

  ViewVC Help
Powered by ViewVC 1.1.20