/[gentoo-x86]/eclass/elisp-common.eclass
Gentoo

Contents of /eclass/elisp-common.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.23 - (show annotations) (download)
Mon Jul 9 13:40:58 2007 UTC (7 years, 5 months ago) by flameeyes
Branch: MAIN
Changes since 1.22: +6 -2 lines
Unbreak on BSD userland: mv -b is non-standard option.

1 # Copyright 1999-2007 Gentoo Foundation
2 # Distributed under the terms of the GNU General Public License v2
3 # $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.22 2007/07/02 06:19:18 opfer Exp $
4 #
5 # Copyright 2007 Christian Faulhammer <opfer@gentoo.org>
6 # Copyright 2002-2007 Matthew Kennedy <mkennedy@gentoo.org>
7 # Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com>
8 # Copyright 2007 Ulrich Mueller <ulm@gentoo.org>
9 #
10 # This is not a real eclass, but it does provide Emacs-related installation
11 # utilities.
12 #
13 # USAGE:
14 #
15 # Usually you want to use this eclass for (optional) GNU Emacs support of
16 # your package. This is NOT for XEmacs!
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
19 # files you gathered from somewhere else.
20 # When relying on the emacs USE flag, you need to add
21 #
22 # emacs? ( virtual/emacs )
23 #
24 # to your DEPEND/RDEPEND line and use the functions provided here to bring
25 # the files to the correct locations.
26 #
27 # src_compile() usage:
28 # --------------------
29 #
30 # 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 # elisp files, you can use the elisp-comp() function which makes sure all
33 # files are loadable.
34 #
35 # elisp-compile *.el || die "elisp-compile failed!"
36 # or
37 # elisp-comp *.el || die "elisp-comp failed!"
38 #
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
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
43 # source files contain magic ";;;###autoload" comments. See the Emacs Lisp
44 # Reference Manual (node "Autoload") for a detailed explanation.
45 #
46 # src_install() usage:
47 # --------------------
48 #
49 # 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
51 # 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 # something else, but remember to tell elisp-site-file-install() (see below)
54 # the change, as it defaults to ${PN}.
55 #
56 # elisp-install ${PN} *.elc *.el || die "elisp-install failed!"
57 #
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
60 # code (have a look in the documentation of your software). Normally this
61 # would look like this:
62 #
63 # ;;; csv-mode site-lisp configuration
64 #
65 # (add-to-list 'load-path "@SITELISP@")
66 # (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode))
67 # (autoload 'csv-mode "csv-mode" "Major mode for editing csv files." t)
68 #
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
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
73 # replace "@SITELISP@" by the actual path.
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.
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
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
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
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!
84 # Best practice is to define a SITEFILE variable in the global scope of your
85 # ebuild (right after DEPEND e.g.):
86 #
87 # SITEFILE=50${PN}-gentoo.el
88 #
89 # Which is then installed by
90 #
91 # elisp-site-file-install "${FILESDIR}/${SITEFILE}"
92 #
93 # in src_install(). If your subdirectory is not named ${PN}, give the
94 # differing name as second argument.
95 #
96 # pkg_postinst() / pkg_postrm() usage:
97 # ------------------------------------
98 #
99 # After that you need to recreate the start-up file of Emacs after emerging
100 # and unmerging by using
101 #
102 # pkg_postinst() {
103 # elisp-site-regen
104 # }
105 #
106 # pkg_postrm() {
107 # elisp-site-regen
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 #
121 # As always: Feel free to contact Emacs team through emacs@gentoo.org if you
122 # have problems, suggestions or questions.
123
124 IUSE="userland_GNU"
125
126 SITELISP=/usr/share/emacs/site-lisp
127
128 elisp-compile() {
129 einfo "Compiling GNU Emacs Elisp files ..."
130 /usr/bin/emacs -batch -q --no-site-file -f batch-byte-compile $*
131 }
132
133 elisp-emacs-version() {
134 # Output version of currently active Emacs.
135 # The following will work for at least versions 18-22.
136 echo "(princ emacs-version)" >"${T}"/emacs-version.el
137 /usr/bin/emacs -batch -q --no-site-file -l "${T}"/emacs-version.el
138 }
139
140 elisp-make-autoload-file () {
141 local f="${1:-${PN}-autoloads.el}"
142 shift
143 einfo "Generating autoload file for GNU Emacs ..."
144
145 sed 's/^FF/\f/' >"${f}" <<-EOF
146 ;;; ${f##*/} --- autoloads for ${P}
147
148 ;;; Commentary:
149 ;; Automatically generated by elisp-common.eclass
150 ;; DO NOT EDIT THIS FILE
151
152 ;;; Code:
153 FF
154 ;; Local Variables:
155 ;; version-control: never
156 ;; no-byte-compile: t
157 ;; no-update-autoloads: t
158 ;; End:
159 ;;; ${f##*/} ends here
160 EOF
161
162 /usr/bin/emacs -batch -q --no-site-file \
163 --eval "(setq make-backup-files nil)" \
164 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
165 -f batch-update-autoloads "${@-.}"
166 }
167
168 elisp-install() {
169 local subdir=$1
170 einfo "Installing Elisp files for GNU Emacs support ..."
171 dodir "${SITELISP}/${subdir}"
172 insinto "${SITELISP}/${subdir}"
173 shift
174 doins $@
175 }
176
177 elisp-site-file-install() {
178 local sitefile=$1 my_pn=${2:-${PN}}
179 einfo "Installing site initialisation file for GNU Emacs ..."
180 pushd "${S}"
181 cp ${sitefile} "${T}"
182 sed -i "s:@SITELISP@:${SITELISP}/${my_pn}:g" "${T}/$(basename ${sitefile})"
183 insinto ${SITELISP}
184 doins "${T}/$(basename ${sitefile})" || die "failed to install site file"
185 popd
186 }
187
188 elisp-site-regen() {
189 local sflist sf line
190
191 einfo "Regenerating ${SITELISP}/site-gentoo.el ..."
192 cat <<EOF >"${T}"/site-gentoo.el
193 ;;; DO NOT EDIT THIS FILE -- IT IS GENERATED AUTOMATICALLY BY PORTAGE
194 ;;; -----------------------------------------------------------------
195
196 EOF
197 for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el
198 do
199 [ -r "${sf}" ] || continue
200 sflist="${sflist} $(basename "${sf}")"
201 cat "${sf}" >>"${T}"/site-gentoo.el
202 done
203
204 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${T}"/site-gentoo.el; then
205 # This prevents outputting unnecessary text when there
206 # was actually no change
207 # A case is a remerge where we have doubled output
208 einfo "... no changes"
209 else
210 local mvopts=""
211 use userland_GNU && mvopts="-b"
212 mv ${mvopts} "${T}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
213 einfo ""
214 for sf in ${sflist}; do
215 einfo " Adding ${sf} ..."
216 done
217 while read line; do einfo "${line}"; done <<EOF
218
219 All site initialization for Gentoo-installed packages is now added to
220 /usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer
221 managed by Gentoo. You are responsible for all maintenance of
222 site-start.el if there is such a file.
223
224 In order for this site initialization to be loaded for all users
225 automatically, as was done previously, you can add a line like this:
226
227 (load "/usr/share/emacs/site-lisp/site-gentoo" nil t)
228
229 to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
230 can be added by individual users to their initialization files, or for
231 greater flexibility, users can select which of the package-specific
232 initialization files in /usr/share/emacs/site-lisp to load.
233 EOF
234 echo
235 fi
236 }
237
238 # The following Emacs Lisp compilation routine is taken from GNU
239 # autotools.
240
241 elisp-comp() {
242 # Copyright 1995 Free Software Foundation, Inc.
243 # Fran├žois Pinard <pinard@iro.umontreal.ca>, 1995.
244 # This script byte-compiles all `.el' files which are part of its
245 # arguments, using GNU Emacs, and put the resulting `.elc' files into
246 # the current directory, so disregarding the original directories used
247 # in `.el' arguments.
248 #
249 # This script manages in such a way that all Emacs LISP files to
250 # be compiled are made visible between themselves, in the event
251 # they require or load-library one another.
252
253 test $# -gt 0 || return 1
254
255 if test -z "${EMACS}" || test "${EMACS}" = "t"; then
256 # Value of "t" means we are running in a shell under Emacs.
257 # Just assume Emacs is called "emacs".
258 EMACS=/usr/bin/emacs
259 fi
260 einfo "Compiling GNU Emacs Elisp files ..."
261
262 tempdir=elc.$$
263 mkdir ${tempdir}
264 cp $* ${tempdir}
265 pushd ${tempdir}
266
267 echo "(add-to-list 'load-path \"../\")" > script
268 ${EMACS} -batch -q --no-site-file --no-init-file -l script \
269 -f batch-byte-compile *.el
270 local status=$?
271 mv *.elc ..
272
273 popd
274 rm -fr ${tempdir}
275 return ${status}
276 }

  ViewVC Help
Powered by ViewVC 1.1.20