/[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.24
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.24 2007/07/10 20:14:52 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# This is not a real eclass, but it does provide Emacs-related installation
11# utilities. 12# utilities.
30# An elisp file is compiled by the elisp-compile() function defined here and 31# 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 32# simply takes the source files as arguments. In the case of interdependent
32# elisp files, you can use the elisp-comp() function which makes sure all 33# elisp files, you can use the elisp-comp() function which makes sure all
33# files are loadable. 34# files are loadable.
34# 35#
35# elisp-compile *.el || die "elisp-compile failed!" 36# elisp-compile *.el || die "elisp-compile failed"
36# or 37# or
37# elisp-comp *.el || die "elisp-comp failed!" 38# elisp-comp *.el || die "elisp-comp failed"
38# 39#
39# Function elisp-make-autoload-file() can be used to generate a file with 40# 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 41# autoload definitions for the lisp functions. It takes the output file name
41# (default: "${PN}-autoloads.el") and a list of directories (default: working 42# (default: "${PN}-autoloads.el") and a list of directories (default: working
42# directory) as its arguments. Use of this function requires that the elisp 43# directory) as its arguments. Use of this function requires that the elisp
51# of elisp-install(). The following parameters are the files to be put in 52# 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 53# that directory. Usually the subdirectory should be ${PN}, you can choose
53# something else, but remember to tell elisp-site-file-install() (see below) 54# something else, but remember to tell elisp-site-file-install() (see below)
54# the change, as it defaults to ${PN}. 55# the change, as it defaults to ${PN}.
55# 56#
56# elisp-install ${PN} *.elc *.el || die "elisp-install failed!" 57# elisp-install ${PN} *.el *.elc || die "elisp-install failed"
57# 58#
58# To let the Emacs support be activated by Emacs on startup, you need 59# 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 60# 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 61# code (have a look in the documentation of your software). Normally this
61# would look like this: 62# would look like this:
100# and unmerging by using 101# and unmerging by using
101# 102#
102# pkg_postinst() { 103# pkg_postinst() {
103# elisp-site-regen 104# elisp-site-regen
104# } 105# }
106#
105# pkg_postrm() { 107# pkg_postrm() {
106# elisp-site-regen 108# elisp-site-regen
107# } 109# }
108# 110#
111# When having optional Emacs support, you should prepend "use emacs &&" to
112# above calls of elisp-site-regen(). Don't use "has_version virtual/emacs"!
113# When unmerging the state of the USE flag emacs is taken from the package
114# database and not from the environment, so it is no problem when you unset
115# USE=emacs between merge und unmerge of a package.
116#
117# Miscellaneous functions:
118# ------------------------
119#
120# elisp-emacs-version() outputs the version of the currently active Emacs.
121#
109# As always: Feel free to contact Emacs team through emacs@gentoo.org if you 122# As always: Feel free to contact Emacs team through emacs@gentoo.org if you
110# have problems, suggestions or questions. 123# have problems, suggestions or questions.
111 124
112SITELISP=/usr/share/emacs/site-lisp 125SITELISP=/usr/share/emacs/site-lisp
113 126
114elisp-compile() { 127elisp-compile() {
115 /usr/bin/emacs --batch -f batch-byte-compile --no-site-file --no-init-file $* 128 einfo "Compiling GNU Emacs Elisp files ..."
129 /usr/bin/emacs -batch -q --no-site-file -f batch-byte-compile $*
130}
131
132elisp-emacs-version() {
133 # Output version of currently active Emacs.
134 # The following will work for at least versions 18-22.
135 echo "(princ emacs-version)" >"${T}"/emacs-version.el
136 /usr/bin/emacs -batch -q --no-site-file -l "${T}"/emacs-version.el
116} 137}
117 138
118elisp-make-autoload-file () { 139elisp-make-autoload-file () {
119 local f="${1:-${PN}-autoloads.el}" 140 local f="${1:-${PN}-autoloads.el}"
120 shift 141 shift
121 echo >"${f}" 142 einfo "Generating autoload file for GNU Emacs ..."
143
144 sed 's/^FF/\f/' >"${f}" <<-EOF
145 ;;; ${f##*/} --- autoloads for ${P}
146
147 ;;; Commentary:
148 ;; Automatically generated by elisp-common.eclass
149 ;; DO NOT EDIT THIS FILE
150
151 ;;; Code:
152 FF
153 ;; Local Variables:
154 ;; version-control: never
155 ;; no-byte-compile: t
156 ;; no-update-autoloads: t
157 ;; End:
158 ;;; ${f##*/} ends here
159 EOF
160
122 emacs --batch -q --no-site-file \ 161 /usr/bin/emacs -batch -q --no-site-file \
123 --eval "(setq make-backup-files nil)" \ 162 --eval "(setq make-backup-files nil)" \
124 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \ 163 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
125 -f batch-update-autoloads "${@-.}" 164 -f batch-update-autoloads "${@-.}"
126} 165}
127 166
128elisp-install() { 167elisp-install() {
129 local subdir=$1 168 local subdir=$1
169 einfo "Installing Elisp files for GNU Emacs support ..."
130 dodir "${SITELISP}/${subdir}" 170 dodir "${SITELISP}/${subdir}"
131 insinto "${SITELISP}/${subdir}" 171 insinto "${SITELISP}/${subdir}"
132 shift 172 shift
133 doins $@ 173 doins $@
134} 174}
135 175
136elisp-site-file-install() { 176elisp-site-file-install() {
137 local sitefile=$1 my_pn=${2:-${PN}} 177 local sitefile=$1 my_pn=${2:-${PN}}
178 einfo "Installing site initialisation file for GNU Emacs ..."
138 pushd "${S}" 179 pushd "${S}"
139 cp ${sitefile} "${T}" 180 cp ${sitefile} "${T}"
140 sed -i "s:@SITELISP@:${SITELISP}/${my_pn}:g" "${T}/$(basename ${sitefile})" 181 sed -i "s:@SITELISP@:${SITELISP}/${my_pn}:g" "${T}/$(basename ${sitefile})"
141 insinto ${SITELISP} 182 insinto ${SITELISP}
142 doins "${T}/$(basename ${sitefile})" || die "failed to install site file" 183 doins "${T}/$(basename ${sitefile})" || die "failed to install site file"
143 popd 184 popd
144} 185}
145 186
146elisp-site-regen() { 187elisp-site-regen() {
188 local sflist sf line
189
147 einfo "Regenerating ${SITELISP}/site-gentoo.el ..." 190 einfo "Regenerating ${SITELISP}/site-gentoo.el ..."
148 einfo ""
149 cat <<EOF >${ROOT}${SITELISP}/site-gentoo.el 191 cat <<-EOF >"${T}"/site-gentoo.el
150;;; DO NOT EDIT THIS FILE -- IT IS GENERATED AUTOMATICALLY BY PORTAGE 192 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
151;;; -----------------------------------------------------------------
152 193
194 ;;; Commentary:
195 ;; Automatically generated by elisp-common.eclass
196 ;; DO NOT EDIT THIS FILE
197
198 ;;; Code:
153EOF 199 EOF
200
154 for sf in ${ROOT}${SITELISP}/[0-9][0-9]*-gentoo.el 201 for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el
155 do 202 do
156 [ -r "${sf}" ] || continue 203 [ -r "${sf}" ] || continue
157 einfo " Adding $(basename ${sf}) ..." 204 sflist="${sflist} $(basename "${sf}")"
158 cat "${sf}" >>${ROOT}${SITELISP}/site-gentoo.el 205 cat "${sf}" >>"${T}"/site-gentoo.el
159 done 206 done
207
208 cat <<-EOF >>"${T}"/site-gentoo.el
209
210 ;;; site-gentoo.el ends here
211 EOF
212
213 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${T}"/site-gentoo.el; then
214 # This prevents outputting unnecessary text when there
215 # was actually no change
216 # A case is a remerge where we have doubled output
217 einfo "... no changes"
218 else
219 mv "${T}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
220 einfo ""
221 for sf in ${sflist}; do
222 einfo " Adding ${sf} ..."
223 done
160 while read line; do einfo "${line}"; done <<EOF 224 while read line; do einfo "${line}"; done <<EOF
161 225
162All site initialization for Gentoo-installed packages is now added to 226All site initialisation for Gentoo-installed packages is now added to
163/usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer 227/usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer
164managed by Gentoo. You are responsible for all maintenance of 228managed by Gentoo. You are responsible for all maintenance of
165site-start.el if there is such a file. 229site-start.el if there is such a file.
166 230
167In order for this site initialization to be loaded for all users 231In order for this site initialisation to be loaded for all users
168automatically, as was done previously, you can add a line like this: 232automatically, as was done previously, you can add a line like this:
169 233
170 (load "/usr/share/emacs/site-lisp/site-gentoo" nil t) 234 (load "/usr/share/emacs/site-lisp/site-gentoo" nil t)
171 235
172to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line 236to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
173can be added by individual users to their initialization files, or for 237can be added by individual users to their initialisation files, or for
174greater flexibility, users can select which of the package-specific 238greater flexibility, users can select which of the package-specific
175initialization files in /usr/share/emacs/site-lisp to load. 239initialisation files in /usr/share/emacs/site-lisp to load.
176EOF 240EOF
177 echo 241 echo
242 fi
178} 243}
179 244
180# The following Emacs Lisp compilation routine is taken from GNU 245# The following Emacs Lisp compilation routine was originally taken from
181# autotools. 246# GNU autotools.
182 247
183elisp-comp() { 248elisp-comp() {
184# Copyright 1995 Free Software Foundation, Inc. 249 # Copyright 1995 Free Software Foundation, Inc.
185# Fran├žois Pinard <pinard@iro.umontreal.ca>, 1995. 250 # Fran├žois Pinard <pinard@iro.umontreal.ca>, 1995.
186# This script byte-compiles all `.el' files which are part of its 251 # This script byte-compiles all `.el' files which are part of its
187# arguments, using GNU Emacs, and put the resulting `.elc' files into 252 # arguments, using GNU Emacs, and put the resulting `.elc' files into
188# the current directory, so disregarding the original directories used 253 # the current directory, so disregarding the original directories used
189# in `.el' arguments. 254 # in `.el' arguments.
190# 255 #
191# This script manages in such a way that all Emacs LISP files to 256 # This script manages in such a way that all Emacs LISP files to
192# be compiled are made visible between themselves, in the event 257 # be compiled are made visible between themselves, in the event
193# they require or load-library one another. 258 # they require or load-library one another.
194 259
195 if test $# = 0; then 260 test $# -gt 0 || return 1
196 exit 1 261
197 else
198 if test -z "${EMACS}" || test "${EMACS}" = "t"; then 262 if test -z "${EMACS}" || test "${EMACS}" = "t"; then
199 # Value of "t" means we are running in a shell under Emacs. 263 # Value of "t" means we are running in a shell under Emacs.
200 # Just assume Emacs is called "emacs". 264 # Just assume Emacs is called "emacs".
201 EMACS=emacs 265 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 266 fi
267 einfo "Compiling GNU Emacs Elisp files ..."
268
269 tempdir=elc.$$
270 mkdir ${tempdir}
271 cp $* ${tempdir}
272 pushd ${tempdir}
273
274 echo "(add-to-list 'load-path \"../\")" > script
275 ${EMACS} -batch -q --no-site-file --no-init-file -l script \
276 -f batch-byte-compile *.el
277 local status=$?
278 mv *.elc ..
279
280 popd
281 rm -fr ${tempdir}
282 return ${status}
216} 283}

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

  ViewVC Help
Powered by ViewVC 1.1.20