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

Contents of /eclass/elisp-common.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.22 - (hide annotations) (download)
Mon Jul 2 06:19:18 2007 UTC (7 years, 3 months ago) by opfer
Branch: MAIN
Changes since 1.21: +78 -37 lines
elisp.eclass:
* Depend on Emacs by NEED_EMACS=<version> before inherit
* DOCS variable is used in src_install() to give a number of
documentation files
* Documented some missing parts
* Some code clean-up

elisp-common:
* elisp-emacs-version() to determine Emacs' current major
version number
* site-gentoo.el is only regenerated if there was actually a change,
thus preventing unecessary output on postrm or postinst
* now every action is commented with an einfo output
* Documented some missing parts
* Some code clean-up

1 opfer 1.15 # Copyright 1999-2007 Gentoo Foundation
2 mkennedy 1.1 # Distributed under the terms of the GNU General Public License v2
3 opfer 1.22 # $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.21 2007/05/26 08:34:08 ulm Exp $
4 mkennedy 1.1 #
5 opfer 1.15 # Copyright 2007 Christian Faulhammer <opfer@gentoo.org>
6     # Copyright 2002-2007 Matthew Kennedy <mkennedy@gentoo.org>
7 mkennedy 1.2 # Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com>
8 opfer 1.15 # Copyright 2007 Ulrich Mueller <ulm@gentoo.org>
9 mkennedy 1.1 #
10 opfer 1.15 # 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 ulm 1.18 # your package. This is NOT for XEmacs!
17 opfer 1.15 # 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 ulm 1.18 # autoload definitions for the lisp functions. It takes the output file name
41 opfer 1.15 # (default: "${PN}-autoloads.el") and a list of directories (default: working
42 ulm 1.18 # directory) as its arguments. Use of this function requires that the elisp
43 opfer 1.15 # 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 ulm 1.18 # code (have a look in the documentation of your software). Normally this
61 opfer 1.15 # 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 ulm 1.18 # non-comment. The elisp-site-file-install() function of this eclass will
73 opfer 1.15 # 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 ulm 1.18 # 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 opfer 1.15 # 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 ulm 1.18 # two digits at the beginning define the loading order. So if you depend on
83 opfer 1.15 # 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 ulm 1.18 # in src_install(). If your subdirectory is not named ${PN}, give the
94 opfer 1.15 # 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 opfer 1.22 #
106 opfer 1.15 # pkg_postrm() {
107     # elisp-site-regen
108     # }
109     #
110 opfer 1.22 # 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 opfer 1.15 # As always: Feel free to contact Emacs team through emacs@gentoo.org if you
122     # have problems, suggestions or questions.
123 mkennedy 1.1
124     SITELISP=/usr/share/emacs/site-lisp
125    
126 mkennedy 1.2 elisp-compile() {
127 opfer 1.22 einfo "Compiling GNU Emacs Elisp files ..."
128     /usr/bin/emacs -batch -q --no-site-file -f batch-byte-compile $*
129     }
130    
131     elisp-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
136 mkennedy 1.2 }
137    
138 opfer 1.15 elisp-make-autoload-file () {
139 opfer 1.17 local f="${1:-${PN}-autoloads.el}"
140 opfer 1.15 shift
141 opfer 1.22 einfo "Generating autoload file for GNU Emacs ..."
142    
143 ulm 1.21 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 opfer 1.22
160     /usr/bin/emacs -batch -q --no-site-file \
161 opfer 1.15 --eval "(setq make-backup-files nil)" \
162     --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
163     -f batch-update-autoloads "${@-.}"
164     }
165    
166 mkennedy 1.1 elisp-install() {
167     local subdir=$1
168 opfer 1.22 einfo "Installing Elisp files for GNU Emacs support ..."
169 opfer 1.15 dodir "${SITELISP}/${subdir}"
170     insinto "${SITELISP}/${subdir}"
171 mkennedy 1.1 shift
172     doins $@
173     }
174    
175     elisp-site-file-install() {
176 usata 1.6 local sitefile=$1 my_pn=${2:-${PN}}
177 opfer 1.22 einfo "Installing site initialisation file for GNU Emacs ..."
178 opfer 1.15 pushd "${S}"
179     cp ${sitefile} "${T}"
180     sed -i "s:@SITELISP@:${SITELISP}/${my_pn}:g" "${T}/$(basename ${sitefile})"
181 mkennedy 1.1 insinto ${SITELISP}
182 opfer 1.15 doins "${T}/$(basename ${sitefile})" || die "failed to install site file"
183 mkennedy 1.1 popd
184     }
185    
186     elisp-site-regen() {
187 opfer 1.22 local sflist sf line
188    
189 vapier 1.9 einfo "Regenerating ${SITELISP}/site-gentoo.el ..."
190 opfer 1.22 cat <<EOF >"${T}"/site-gentoo.el
191 mkennedy 1.1 ;;; DO NOT EDIT THIS FILE -- IT IS GENERATED AUTOMATICALLY BY PORTAGE
192     ;;; -----------------------------------------------------------------
193    
194     EOF
195 opfer 1.22 for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el
196 mkennedy 1.1 do
197 ulm 1.20 [ -r "${sf}" ] || continue
198 opfer 1.22 sflist="${sflist} $(basename "${sf}")"
199     cat "${sf}" >>"${T}"/site-gentoo.el
200 mkennedy 1.1 done
201 opfer 1.22
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
213     while read line; do einfo "${line}"; done <<EOF
214 jbms 1.4
215     All site initialization for Gentoo-installed packages is now added to
216     /usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer
217 usata 1.8 managed by Gentoo. You are responsible for all maintenance of
218     site-start.el if there is such a file.
219 jbms 1.4
220     In order for this site initialization to be loaded for all users
221     automatically, as was done previously, you can add a line like this:
222    
223 ulm 1.19 (load "/usr/share/emacs/site-lisp/site-gentoo" nil t)
224 jbms 1.4
225     to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
226     can be added by individual users to their initialization files, or for
227     greater flexibility, users can select which of the package-specific
228     initialization files in /usr/share/emacs/site-lisp to load.
229     EOF
230 opfer 1.22 echo
231     fi
232 mkennedy 1.3 }
233    
234     # The following Emacs Lisp compilation routine is taken from GNU
235     # autotools.
236    
237     elisp-comp() {
238 opfer 1.22 # Copyright 1995 Free Software Foundation, Inc.
239     # Fran├žois Pinard <pinard@iro.umontreal.ca>, 1995.
240     # This script byte-compiles all `.el' files which are part of its
241     # arguments, using GNU Emacs, and put the resulting `.elc' files into
242     # the current directory, so disregarding the original directories used
243     # in `.el' arguments.
244     #
245     # This script manages in such a way that all Emacs LISP files to
246     # be compiled are made visible between themselves, in the event
247     # they require or load-library one another.
248    
249     test $# -gt 0 || return 1
250 mkennedy 1.3
251 opfer 1.22 if test -z "${EMACS}" || test "${EMACS}" = "t"; then
252 jbms 1.4 # Value of "t" means we are running in a shell under Emacs.
253     # Just assume Emacs is called "emacs".
254 opfer 1.22 EMACS=/usr/bin/emacs
255     fi
256     einfo "Compiling GNU Emacs Elisp files ..."
257 mkennedy 1.3
258 opfer 1.22 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 mkennedy 1.3
269 opfer 1.22 popd
270     rm -fr ${tempdir}
271     return ${status}
272 mkennedy 1.1 }

  ViewVC Help
Powered by ViewVC 1.1.20