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

Contents of /eclass/elisp-common.eclass

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.24 - (hide annotations) (download)
Tue Jul 10 20:14:52 2007 UTC (7 years ago) by ulm
Branch: MAIN
Changes since 1.23: +26 -19 lines
Add RDEPEND line. Put proper header information in site-gentoo.el.
Update copyright info. Consistent BE spelling. Some comment changes.
Remove -b option from mv since it does not work on BSD.

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 flameeyes 1.23 # $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.22 2007/07/02 06:19:18 opfer Exp $
4 mkennedy 1.1 #
5 opfer 1.15 # Copyright 2007 Christian Faulhammer <opfer@gentoo.org>
6 ulm 1.24 # Copyright 2002-2004 Matthew Kennedy <mkennedy@gentoo.org>
7     # Copyright 2004-2005 Mamoru Komachi <usata@gentoo.org>
8 mkennedy 1.2 # Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com>
9 opfer 1.15 # Copyright 2007 Ulrich Mueller <ulm@gentoo.org>
10 mkennedy 1.1 #
11 opfer 1.15 # This is not a real eclass, but it does provide Emacs-related installation
12     # utilities.
13     #
14     # USAGE:
15     #
16     # Usually you want to use this eclass for (optional) GNU Emacs support of
17 ulm 1.18 # your package. This is NOT for XEmacs!
18 opfer 1.15 # Many of the steps here are sometimes done by the build system of your
19     # package (especially compilation), so this is mainly for standalone elisp
20     # files you gathered from somewhere else.
21     # When relying on the emacs USE flag, you need to add
22     #
23     # emacs? ( virtual/emacs )
24     #
25     # to your DEPEND/RDEPEND line and use the functions provided here to bring
26     # the files to the correct locations.
27     #
28     # src_compile() usage:
29     # --------------------
30     #
31     # An elisp file is compiled by the elisp-compile() function defined here and
32     # simply takes the source files as arguments. In the case of interdependent
33     # elisp files, you can use the elisp-comp() function which makes sure all
34     # files are loadable.
35     #
36 ulm 1.24 # elisp-compile *.el || die "elisp-compile failed"
37 opfer 1.15 # or
38 ulm 1.24 # elisp-comp *.el || die "elisp-comp failed"
39 opfer 1.15 #
40     # Function elisp-make-autoload-file() can be used to generate a file with
41 ulm 1.18 # autoload definitions for the lisp functions. It takes the output file name
42 opfer 1.15 # (default: "${PN}-autoloads.el") and a list of directories (default: working
43 ulm 1.18 # directory) as its arguments. Use of this function requires that the elisp
44 opfer 1.15 # source files contain magic ";;;###autoload" comments. See the Emacs Lisp
45     # Reference Manual (node "Autoload") for a detailed explanation.
46     #
47     # src_install() usage:
48     # --------------------
49     #
50     # The resulting compiled files (.elc) should be put in a subdirectory of
51     # /usr/share/emacs/site-lisp/ which is named after the first argument
52     # of elisp-install(). The following parameters are the files to be put in
53     # that directory. Usually the subdirectory should be ${PN}, you can choose
54     # something else, but remember to tell elisp-site-file-install() (see below)
55     # the change, as it defaults to ${PN}.
56     #
57 ulm 1.24 # elisp-install ${PN} *.el *.elc || die "elisp-install failed"
58 opfer 1.15 #
59     # To let the Emacs support be activated by Emacs on startup, you need
60     # to provide a site file (shipped in ${FILESDIR}) which contains the startup
61 ulm 1.18 # code (have a look in the documentation of your software). Normally this
62 opfer 1.15 # would look like this:
63     #
64     # ;;; csv-mode site-lisp configuration
65     #
66     # (add-to-list 'load-path "@SITELISP@")
67     # (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode))
68     # (autoload 'csv-mode "csv-mode" "Major mode for editing csv files." t)
69     #
70     # If your Emacs support files are installed in a subdirectory of
71     # /usr/share/emacs/site-lisp/ (which is recommended if more than one file is
72     # installed), you need to extend Emacs' load-path as shown in the first
73 ulm 1.18 # non-comment. The elisp-site-file-install() function of this eclass will
74 opfer 1.15 # replace "@SITELISP@" by the actual path.
75     # The next line tells Emacs to load the mode opening a file ending with
76     # ".csv" and load functions depending on the context and needed features.
77     # Be careful though. Commands as "load-library" or "require" bloat the
78     # editor as they are loaded on every startup. When having a lot of Emacs
79 ulm 1.18 # support files, users may be annoyed by the start-up time. Also avoid
80     # keybindings as they might interfere with the user's settings. Give a hint
81 opfer 1.15 # in pkg_postinst(), which should be enough.
82     # The naming scheme for this site file is "[0-9][0-9]*-gentoo.el", where the
83 ulm 1.18 # two digits at the beginning define the loading order. So if you depend on
84 opfer 1.15 # another Emacs package, your site file's number must be higher!
85     # Best practice is to define a SITEFILE variable in the global scope of your
86     # ebuild (right after DEPEND e.g.):
87     #
88     # SITEFILE=50${PN}-gentoo.el
89     #
90     # Which is then installed by
91     #
92     # elisp-site-file-install "${FILESDIR}/${SITEFILE}"
93     #
94 ulm 1.18 # in src_install(). If your subdirectory is not named ${PN}, give the
95 opfer 1.15 # differing name as second argument.
96     #
97     # pkg_postinst() / pkg_postrm() usage:
98     # ------------------------------------
99     #
100     # After that you need to recreate the start-up file of Emacs after emerging
101     # and unmerging by using
102     #
103     # pkg_postinst() {
104     # elisp-site-regen
105     # }
106 opfer 1.22 #
107 opfer 1.15 # pkg_postrm() {
108     # elisp-site-regen
109     # }
110     #
111 opfer 1.22 # 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     #
122 opfer 1.15 # As always: Feel free to contact Emacs team through emacs@gentoo.org if you
123     # have problems, suggestions or questions.
124 mkennedy 1.1
125     SITELISP=/usr/share/emacs/site-lisp
126    
127 mkennedy 1.2 elisp-compile() {
128 opfer 1.22 einfo "Compiling GNU Emacs Elisp files ..."
129     /usr/bin/emacs -batch -q --no-site-file -f batch-byte-compile $*
130     }
131    
132     elisp-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
137 mkennedy 1.2 }
138    
139 opfer 1.15 elisp-make-autoload-file () {
140 opfer 1.17 local f="${1:-${PN}-autoloads.el}"
141 opfer 1.15 shift
142 opfer 1.22 einfo "Generating autoload file for GNU Emacs ..."
143    
144 ulm 1.21 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 opfer 1.22
161     /usr/bin/emacs -batch -q --no-site-file \
162 opfer 1.15 --eval "(setq make-backup-files nil)" \
163     --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
164     -f batch-update-autoloads "${@-.}"
165     }
166    
167 mkennedy 1.1 elisp-install() {
168     local subdir=$1
169 opfer 1.22 einfo "Installing Elisp files for GNU Emacs support ..."
170 opfer 1.15 dodir "${SITELISP}/${subdir}"
171     insinto "${SITELISP}/${subdir}"
172 mkennedy 1.1 shift
173     doins $@
174     }
175    
176     elisp-site-file-install() {
177 usata 1.6 local sitefile=$1 my_pn=${2:-${PN}}
178 opfer 1.22 einfo "Installing site initialisation file for GNU Emacs ..."
179 opfer 1.15 pushd "${S}"
180     cp ${sitefile} "${T}"
181     sed -i "s:@SITELISP@:${SITELISP}/${my_pn}:g" "${T}/$(basename ${sitefile})"
182 mkennedy 1.1 insinto ${SITELISP}
183 opfer 1.15 doins "${T}/$(basename ${sitefile})" || die "failed to install site file"
184 mkennedy 1.1 popd
185     }
186    
187     elisp-site-regen() {
188 opfer 1.22 local sflist sf line
189    
190 vapier 1.9 einfo "Regenerating ${SITELISP}/site-gentoo.el ..."
191 ulm 1.24 cat <<-EOF >"${T}"/site-gentoo.el
192     ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
193    
194     ;;; Commentary:
195     ;; Automatically generated by elisp-common.eclass
196     ;; DO NOT EDIT THIS FILE
197    
198     ;;; Code:
199     EOF
200 mkennedy 1.1
201 opfer 1.22 for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el
202 mkennedy 1.1 do
203 ulm 1.20 [ -r "${sf}" ] || continue
204 opfer 1.22 sflist="${sflist} $(basename "${sf}")"
205     cat "${sf}" >>"${T}"/site-gentoo.el
206 mkennedy 1.1 done
207 opfer 1.22
208 ulm 1.24 cat <<-EOF >>"${T}"/site-gentoo.el
209    
210     ;;; site-gentoo.el ends here
211     EOF
212    
213 opfer 1.22 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 ulm 1.24 mv "${T}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
220 opfer 1.22 einfo ""
221     for sf in ${sflist}; do
222     einfo " Adding ${sf} ..."
223     done
224     while read line; do einfo "${line}"; done <<EOF
225 jbms 1.4
226 ulm 1.24 All site initialisation for Gentoo-installed packages is now added to
227 jbms 1.4 /usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer
228 usata 1.8 managed by Gentoo. You are responsible for all maintenance of
229     site-start.el if there is such a file.
230 jbms 1.4
231 ulm 1.24 In order for this site initialisation to be loaded for all users
232 jbms 1.4 automatically, as was done previously, you can add a line like this:
233    
234 ulm 1.19 (load "/usr/share/emacs/site-lisp/site-gentoo" nil t)
235 jbms 1.4
236     to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
237 ulm 1.24 can be added by individual users to their initialisation files, or for
238 jbms 1.4 greater flexibility, users can select which of the package-specific
239 ulm 1.24 initialisation files in /usr/share/emacs/site-lisp to load.
240 jbms 1.4 EOF
241 opfer 1.22 echo
242     fi
243 mkennedy 1.3 }
244    
245 ulm 1.24 # The following Emacs Lisp compilation routine was originally taken from
246     # GNU autotools.
247 mkennedy 1.3
248     elisp-comp() {
249 opfer 1.22 # Copyright 1995 Free Software Foundation, Inc.
250     # Fran├žois Pinard <pinard@iro.umontreal.ca>, 1995.
251     # This script byte-compiles all `.el' files which are part of its
252     # arguments, using GNU Emacs, and put the resulting `.elc' files into
253     # the current directory, so disregarding the original directories used
254     # in `.el' arguments.
255     #
256     # This script manages in such a way that all Emacs LISP files to
257     # be compiled are made visible between themselves, in the event
258     # they require or load-library one another.
259    
260     test $# -gt 0 || return 1
261 mkennedy 1.3
262 opfer 1.22 if test -z "${EMACS}" || test "${EMACS}" = "t"; then
263 jbms 1.4 # Value of "t" means we are running in a shell under Emacs.
264     # Just assume Emacs is called "emacs".
265 opfer 1.22 EMACS=/usr/bin/emacs
266     fi
267     einfo "Compiling GNU Emacs Elisp files ..."
268 mkennedy 1.3
269 opfer 1.22 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 mkennedy 1.3
280 opfer 1.22 popd
281     rm -fr ${tempdir}
282     return ${status}
283 mkennedy 1.1 }

  ViewVC Help
Powered by ViewVC 1.1.20