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

Legend:
Removed from v.1.17  
changed lines
  Added in v.1.22

  ViewVC Help
Powered by ViewVC 1.1.20