| 1 | # Copyright 1999-2007 Gentoo Foundation |
1 | # Copyright 1999-2008 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.24 2007/07/10 20:14:52 ulm Exp $ |
3 | # $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.52 2008/11/24 14:21:04 ulm Exp $ |
| 4 | # |
4 | # |
| 5 | # Copyright 2007 Christian Faulhammer <opfer@gentoo.org> |
|
|
| 6 | # Copyright 2002-2004 Matthew Kennedy <mkennedy@gentoo.org> |
5 | # Copyright 2002-2004 Matthew Kennedy <mkennedy@gentoo.org> |
|
|
6 | # Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com> |
| 7 | # Copyright 2004-2005 Mamoru Komachi <usata@gentoo.org> |
7 | # Copyright 2004-2005 Mamoru Komachi <usata@gentoo.org> |
| 8 | # Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com> |
8 | # Copyright 2007-2008 Christian Faulhammer <opfer@gentoo.org> |
| 9 | # Copyright 2007 Ulrich Mueller <ulm@gentoo.org> |
9 | # Copyright 2007-2008 Ulrich Müller <ulm@gentoo.org> |
| 10 | # |
10 | # |
| 11 | # This is not a real eclass, but it does provide Emacs-related installation |
11 | # @ECLASS: elisp-common.eclass |
| 12 | # utilities. |
12 | # @MAINTAINER: |
| 13 | # |
13 | # Feel free to contact the Emacs team through <emacs@gentoo.org> if you have |
| 14 | # USAGE: |
14 | # problems, suggestions or questions. |
|
|
15 | # @BLURB: Emacs-related installation utilities |
|
|
16 | # @DESCRIPTION: |
| 15 | # |
17 | # |
| 16 | # Usually you want to use this eclass for (optional) GNU Emacs support of |
18 | # Usually you want to use this eclass for (optional) GNU Emacs support of |
| 17 | # your package. This is NOT for XEmacs! |
19 | # your package. This is NOT for XEmacs! |
|
|
20 | # |
| 18 | # Many of the steps here are sometimes done by the build system of your |
21 | # 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 |
22 | # package (especially compilation), so this is mainly for standalone elisp |
| 20 | # files you gathered from somewhere else. |
23 | # files you gathered from somewhere else. |
|
|
24 | # |
| 21 | # When relying on the emacs USE flag, you need to add |
25 | # When relying on the emacs USE flag, you need to add |
| 22 | # |
26 | # |
| 23 | # emacs? ( virtual/emacs ) |
27 | # emacs? ( virtual/emacs ) |
| 24 | # |
28 | # |
| 25 | # to your DEPEND/RDEPEND line and use the functions provided here to bring |
29 | # to your DEPEND/RDEPEND line and use the functions provided here to bring |
| 26 | # the files to the correct locations. |
30 | # the files to the correct locations. |
| 27 | # |
31 | # |
|
|
32 | # .SS |
| 28 | # src_compile() usage: |
33 | # src_compile() usage: |
| 29 | # -------------------- |
|
|
| 30 | # |
34 | # |
| 31 | # An elisp file is compiled by the elisp-compile() function defined here and |
35 | # 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 |
36 | # simply takes the source files as arguments. The case of interdependent |
| 33 | # elisp files, you can use the elisp-comp() function which makes sure all |
37 | # elisp files is also supported, since the current directory is added to the |
| 34 | # files are loadable. |
38 | # load-path which makes sure that all files are loadable. |
| 35 | # |
39 | # |
| 36 | # elisp-compile *.el || die "elisp-compile failed" |
40 | # elisp-compile *.el || die |
| 37 | # or |
|
|
| 38 | # elisp-comp *.el || die "elisp-comp failed" |
|
|
| 39 | # |
41 | # |
|
|
42 | # Formerly, function elisp-comp() was used for compilation of interdependent |
|
|
43 | # elisp files. This usage is considered as obsolete. |
|
|
44 | # |
| 40 | # Function elisp-make-autoload-file() can be used to generate a file with |
45 | # Function elisp-make-autoload-file() can be used to generate a file with |
| 41 | # autoload definitions for the lisp functions. It takes the output file name |
46 | # autoload definitions for the lisp functions. It takes the output file name |
| 42 | # (default: "${PN}-autoloads.el") and a list of directories (default: working |
47 | # (default: "${PN}-autoloads.el") and a list of directories (default: working |
| 43 | # directory) as its arguments. Use of this function requires that the elisp |
48 | # directory) as its arguments. Use of this function requires that the elisp |
| 44 | # source files contain magic ";;;###autoload" comments. See the Emacs Lisp |
49 | # source files contain magic ";;;###autoload" comments. See the Emacs Lisp |
| 45 | # Reference Manual (node "Autoload") for a detailed explanation. |
50 | # Reference Manual (node "Autoload") for a detailed explanation. |
| 46 | # |
51 | # |
|
|
52 | # .SS |
| 47 | # src_install() usage: |
53 | # src_install() usage: |
| 48 | # -------------------- |
|
|
| 49 | # |
54 | # |
| 50 | # The resulting compiled files (.elc) should be put in a subdirectory of |
55 | # 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 |
56 | # /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 |
57 | # 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 |
58 | # that directory. Usually the subdirectory should be ${PN}, you can choose |
| 54 | # something else, but remember to tell elisp-site-file-install() (see below) |
59 | # something else, but remember to tell elisp-site-file-install() (see below) |
| 55 | # the change, as it defaults to ${PN}. |
60 | # the change, as it defaults to ${PN}. |
| 56 | # |
61 | # |
| 57 | # elisp-install ${PN} *.el *.elc || die "elisp-install failed" |
62 | # elisp-install ${PN} *.el *.elc || die |
| 58 | # |
63 | # |
| 59 | # To let the Emacs support be activated by Emacs on startup, you need |
64 | # 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 |
65 | # to provide a site file (shipped in ${FILESDIR}) which contains the startup |
| 61 | # code (have a look in the documentation of your software). Normally this |
66 | # code (have a look in the documentation of your software). Normally this |
| 62 | # would look like this: |
67 | # would look like this: |
| 63 | # |
68 | # |
| 64 | # ;;; csv-mode site-lisp configuration |
69 | # ;;; csv-mode site-lisp configuration |
| 65 | # |
70 | # |
| 66 | # (add-to-list 'load-path "@SITELISP@") |
71 | # (add-to-list 'load-path "@SITELISP@") |
| 67 | # (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode)) |
72 | # (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode)) |
| 68 | # (autoload 'csv-mode "csv-mode" "Major mode for editing csv files." t) |
73 | # (autoload 'csv-mode "csv-mode" "Major mode for csv files." t) |
| 69 | # |
74 | # |
| 70 | # If your Emacs support files are installed in a subdirectory of |
75 | # 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 |
76 | # /usr/share/emacs/site-lisp/ (which is recommended), you need to extend |
| 72 | # installed), you need to extend Emacs' load-path as shown in the first |
77 | # Emacs' load-path as shown in the first non-comment. |
| 73 | # non-comment. The elisp-site-file-install() function of this eclass will |
78 | # The elisp-site-file-install() function of this eclass will replace |
| 74 | # replace "@SITELISP@" by the actual path. |
79 | # "@SITELISP@" by the actual path. |
|
|
80 | # |
| 75 | # The next line tells Emacs to load the mode opening a file ending with |
81 | # 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. |
82 | # ".csv" and load functions depending on the context and needed features. |
| 77 | # Be careful though. Commands as "load-library" or "require" bloat the |
83 | # 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 |
84 | # editor as they are loaded on every startup. When having a lot of Emacs |
| 79 | # support files, users may be annoyed by the start-up time. Also avoid |
85 | # 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 |
86 | # keybindings as they might interfere with the user's settings. Give a hint |
| 81 | # in pkg_postinst(), which should be enough. |
87 | # in pkg_postinst(), which should be enough. |
| 82 | # The naming scheme for this site file is "[0-9][0-9]*-gentoo.el", where the |
88 | # |
| 83 | # two digits at the beginning define the loading order. So if you depend on |
89 | # The naming scheme for this site-init file matches the shell pattern |
|
|
90 | # "[1-8][0-9]*-gentoo.el", where the two digits at the beginning define the |
|
|
91 | # loading order (numbers below 10 or above 89 are reserved for internal use). |
| 84 | # another Emacs package, your site file's number must be higher! |
92 | # So if you depend on another Emacs package, your site file's number must be |
|
|
93 | # higher! |
|
|
94 | # |
| 85 | # Best practice is to define a SITEFILE variable in the global scope of your |
95 | # Best practice is to define a SITEFILE variable in the global scope of your |
| 86 | # ebuild (right after DEPEND e.g.): |
96 | # ebuild (e.g., right after DEPEND): |
| 87 | # |
97 | # |
| 88 | # SITEFILE=50${PN}-gentoo.el |
98 | # SITEFILE=50${PN}-gentoo.el |
| 89 | # |
99 | # |
| 90 | # Which is then installed by |
100 | # Which is then installed by |
| 91 | # |
101 | # |
| 92 | # elisp-site-file-install "${FILESDIR}/${SITEFILE}" |
102 | # elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die |
| 93 | # |
103 | # |
| 94 | # in src_install(). If your subdirectory is not named ${PN}, give the |
104 | # in src_install(). If your subdirectory is not named ${PN}, give the |
| 95 | # differing name as second argument. |
105 | # differing name as second argument. |
| 96 | # |
106 | # |
|
|
107 | # .SS |
| 97 | # pkg_postinst() / pkg_postrm() usage: |
108 | # pkg_postinst() / pkg_postrm() usage: |
| 98 | # ------------------------------------ |
|
|
| 99 | # |
109 | # |
| 100 | # After that you need to recreate the start-up file of Emacs after emerging |
110 | # After that you need to recreate the start-up file of Emacs after emerging |
| 101 | # and unmerging by using |
111 | # and unmerging by using |
| 102 | # |
112 | # |
| 103 | # pkg_postinst() { |
113 | # pkg_postinst() { |
| 104 | # elisp-site-regen |
114 | # elisp-site-regen |
| 105 | # } |
115 | # } |
| 106 | # |
116 | # |
| 107 | # pkg_postrm() { |
117 | # pkg_postrm() { |
| 108 | # elisp-site-regen |
118 | # elisp-site-regen |
| 109 | # } |
119 | # } |
| 110 | # |
120 | # |
| 111 | # When having optional Emacs support, you should prepend "use emacs &&" to |
121 | # 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"! |
122 | # 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 |
123 | # When unmerging the state of the emacs USE flag is taken from the package |
| 114 | # database and not from the environment, so it is no problem when you unset |
124 | # database and not from the environment, so it is no problem when you unset |
| 115 | # USE=emacs between merge und unmerge of a package. |
125 | # USE=emacs between merge and unmerge of a package. |
| 116 | # |
126 | # |
|
|
127 | # .SS |
| 117 | # Miscellaneous functions: |
128 | # Miscellaneous functions: |
| 118 | # ------------------------ |
|
|
| 119 | # |
129 | # |
| 120 | # elisp-emacs-version() outputs the version of the currently active Emacs. |
130 | # elisp-emacs-version() outputs the version of the currently active Emacs. |
| 121 | # |
|
|
| 122 | # As always: Feel free to contact Emacs team through emacs@gentoo.org if you |
|
|
| 123 | # have problems, suggestions or questions. |
|
|
| 124 | |
131 | |
|
|
132 | # @ECLASS-VARIABLE: SITELISP |
|
|
133 | # @DESCRIPTION: |
|
|
134 | # Directory where packages install Emacs Lisp files. |
| 125 | SITELISP=/usr/share/emacs/site-lisp |
135 | SITELISP=/usr/share/emacs/site-lisp |
| 126 | |
136 | |
|
|
137 | # @ECLASS-VARIABLE: SITEETC |
|
|
138 | # @DESCRIPTION: |
|
|
139 | # Directory where packages install miscellaneous (not Lisp) files. |
|
|
140 | SITEETC=/usr/share/emacs/etc |
|
|
141 | |
|
|
142 | # @ECLASS-VARIABLE: EMACS |
|
|
143 | # @DESCRIPTION: |
|
|
144 | # Path of Emacs executable. |
|
|
145 | EMACS=/usr/bin/emacs |
|
|
146 | |
|
|
147 | # @ECLASS-VARIABLE: EMACSFLAGS |
|
|
148 | # @DESCRIPTION: |
|
|
149 | # Flags for executing Emacs in batch mode. |
|
|
150 | # These work for Emacs versions 18-23, so don't change them. |
|
|
151 | EMACSFLAGS="-batch -q --no-site-file" |
|
|
152 | |
|
|
153 | # @ECLASS-VARIABLE: BYTECOMPFLAGS |
|
|
154 | # @DESCRIPTION: |
|
|
155 | # Emacs flags used for byte-compilation in elisp-compile(). |
|
|
156 | BYTECOMPFLAGS="-L ." |
|
|
157 | |
|
|
158 | # @FUNCTION: elisp-compile |
|
|
159 | # @USAGE: <list of elisp files> |
|
|
160 | # @DESCRIPTION: |
|
|
161 | # Byte-compile Emacs Lisp files. |
|
|
162 | # |
|
|
163 | # This function uses GNU Emacs to byte-compile all ".el" specified by its |
|
|
164 | # arguments. The resulting byte-code (".elc") files are placed in the same |
|
|
165 | # directory as their corresponding source file. |
|
|
166 | # |
|
|
167 | # The current directory is added to the load-path. This will ensure that |
|
|
168 | # interdependent Emacs Lisp files are visible between themselves, in case |
|
|
169 | # they require or load one another. |
|
|
170 | |
| 127 | elisp-compile() { |
171 | elisp-compile() { |
| 128 | einfo "Compiling GNU Emacs Elisp files ..." |
172 | ebegin "Compiling GNU Emacs Elisp files" |
| 129 | /usr/bin/emacs -batch -q --no-site-file -f batch-byte-compile $* |
173 | ${EMACS} ${EMACSFLAGS} ${BYTECOMPFLAGS} -f batch-byte-compile "$@" |
|
|
174 | eend $? "elisp-compile: batch-byte-compile failed" |
| 130 | } |
175 | } |
|
|
176 | |
|
|
177 | # #FUNCTION: elisp-comp |
|
|
178 | # #USAGE: <list of elisp files> |
|
|
179 | # #DESCRIPTION: |
|
|
180 | # Byte-compile interdependent Emacs Lisp files. |
|
|
181 | # THIS FUNCTION IS DEPRECATED. |
|
|
182 | # |
|
|
183 | # This function byte-compiles all ".el" files which are part of its |
|
|
184 | # arguments, using GNU Emacs, and puts the resulting ".elc" files into the |
|
|
185 | # current directory, so disregarding the original directories used in ".el" |
|
|
186 | # arguments. |
|
|
187 | # |
|
|
188 | # This function manages in such a way that all Emacs Lisp files to be |
|
|
189 | # compiled are made visible between themselves, in the event they require or |
|
|
190 | # load one another. |
|
|
191 | |
|
|
192 | elisp-comp() { |
|
|
193 | # Copyright 1995 Free Software Foundation, Inc. |
|
|
194 | # François Pinard <pinard@iro.umontreal.ca>, 1995. |
|
|
195 | # Originally taken from GNU autotools. |
|
|
196 | |
|
|
197 | ewarn "Function elisp-comp is deprecated and may be removed in future." |
|
|
198 | ewarn "Please use function elisp-compile instead, or report a bug about" |
|
|
199 | ewarn "${CATEGORY}/${PF} at <http://bugs.gentoo.org/>." |
|
|
200 | echo |
|
|
201 | |
|
|
202 | [ $# -gt 0 ] || return 1 |
|
|
203 | |
|
|
204 | ebegin "Compiling GNU Emacs Elisp files" |
|
|
205 | |
|
|
206 | local tempdir=elc.$$ |
|
|
207 | mkdir ${tempdir} |
|
|
208 | cp "$@" ${tempdir} |
|
|
209 | pushd ${tempdir} |
|
|
210 | |
|
|
211 | echo "(add-to-list 'load-path \"../\")" > script |
|
|
212 | ${EMACS} ${EMACSFLAGS} -l script -f batch-byte-compile *.el |
|
|
213 | local ret=$? |
|
|
214 | mv *.elc .. |
|
|
215 | |
|
|
216 | popd |
|
|
217 | rm -fr ${tempdir} |
|
|
218 | |
|
|
219 | eend ${ret} "elisp-comp: batch-byte-compile failed" |
|
|
220 | } |
|
|
221 | |
|
|
222 | # @FUNCTION: elisp-emacs-version |
|
|
223 | # @DESCRIPTION: |
|
|
224 | # Output version of currently active Emacs. |
| 131 | |
225 | |
| 132 | elisp-emacs-version() { |
226 | elisp-emacs-version() { |
| 133 | # Output version of currently active Emacs. |
|
|
| 134 | # The following will work for at least versions 18-22. |
227 | # The following will work for at least versions 18-23. |
| 135 | echo "(princ emacs-version)" >"${T}"/emacs-version.el |
228 | echo "(princ emacs-version)" >"${T}"/emacs-version.el |
| 136 | /usr/bin/emacs -batch -q --no-site-file -l "${T}"/emacs-version.el |
229 | ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el |
|
|
230 | rm -f "${T}"/emacs-version.el |
| 137 | } |
231 | } |
| 138 | |
232 | |
|
|
233 | # @FUNCTION: elisp-make-autoload-file |
|
|
234 | # @USAGE: [output file] [list of directories] |
|
|
235 | # @DESCRIPTION: |
|
|
236 | # Generate a file with autoload definitions for the lisp functions. |
|
|
237 | |
| 139 | elisp-make-autoload-file () { |
238 | elisp-make-autoload-file() { |
| 140 | local f="${1:-${PN}-autoloads.el}" |
239 | local f="${1:-${PN}-autoloads.el}" |
| 141 | shift |
240 | shift |
| 142 | einfo "Generating autoload file for GNU Emacs ..." |
241 | ebegin "Generating autoload file for GNU Emacs" |
| 143 | |
242 | |
| 144 | sed 's/^FF/\f/' >"${f}" <<-EOF |
243 | sed 's/^FF/\f/' >"${f}" <<-EOF |
| 145 | ;;; ${f##*/} --- autoloads for ${P} |
244 | ;;; ${f##*/} --- autoloads for ${P} |
| 146 | |
245 | |
| 147 | ;;; Commentary: |
246 | ;;; Commentary: |
| … | |
… | |
| 156 | ;; no-update-autoloads: t |
255 | ;; no-update-autoloads: t |
| 157 | ;; End: |
256 | ;; End: |
| 158 | ;;; ${f##*/} ends here |
257 | ;;; ${f##*/} ends here |
| 159 | EOF |
258 | EOF |
| 160 | |
259 | |
| 161 | /usr/bin/emacs -batch -q --no-site-file \ |
260 | ${EMACS} ${EMACSFLAGS} \ |
| 162 | --eval "(setq make-backup-files nil)" \ |
261 | --eval "(setq make-backup-files nil)" \ |
| 163 | --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \ |
262 | --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \ |
| 164 | -f batch-update-autoloads "${@-.}" |
263 | -f batch-update-autoloads "${@-.}" |
|
|
264 | |
|
|
265 | eend $? "elisp-make-autoload-file: batch-update-autoloads failed" |
| 165 | } |
266 | } |
|
|
267 | |
|
|
268 | # @FUNCTION: elisp-install |
|
|
269 | # @USAGE: <subdirectory> <list of files> |
|
|
270 | # @DESCRIPTION: |
|
|
271 | # Install files in SITELISP directory. |
| 166 | |
272 | |
| 167 | elisp-install() { |
273 | elisp-install() { |
| 168 | local subdir=$1 |
274 | local subdir="$1" |
| 169 | einfo "Installing Elisp files for GNU Emacs support ..." |
|
|
| 170 | dodir "${SITELISP}/${subdir}" |
|
|
| 171 | insinto "${SITELISP}/${subdir}" |
|
|
| 172 | shift |
275 | shift |
|
|
276 | ebegin "Installing Elisp files for GNU Emacs support" |
|
|
277 | ( # subshell to avoid pollution of calling environment |
|
|
278 | insinto "${SITELISP}/${subdir}" |
| 173 | doins $@ |
279 | doins "$@" |
|
|
280 | ) |
|
|
281 | eend $? "elisp-install: doins failed" |
| 174 | } |
282 | } |
|
|
283 | |
|
|
284 | # @FUNCTION: elisp-site-file-install |
|
|
285 | # @USAGE: <site-init file> [subdirectory] |
|
|
286 | # @DESCRIPTION: |
|
|
287 | # Install Emacs site-init file in SITELISP directory. |
| 175 | |
288 | |
| 176 | elisp-site-file-install() { |
289 | elisp-site-file-install() { |
| 177 | local sitefile=$1 my_pn=${2:-${PN}} |
290 | local sf="${T}/${1##*/}" my_pn="${2:-${PN}}" ret |
| 178 | einfo "Installing site initialisation file for GNU Emacs ..." |
291 | ebegin "Installing site initialisation file for GNU Emacs" |
| 179 | pushd "${S}" |
292 | cp "$1" "${sf}" |
| 180 | cp ${sitefile} "${T}" |
293 | sed -i -e "s:@SITELISP@:${SITELISP}/${my_pn}:g" \ |
| 181 | sed -i "s:@SITELISP@:${SITELISP}/${my_pn}:g" "${T}/$(basename ${sitefile})" |
294 | -e "s:@SITEETC@:${SITEETC}/${my_pn}:g;\$q" "${sf}" |
| 182 | insinto ${SITELISP} |
295 | ( # subshell to avoid pollution of calling environment |
| 183 | doins "${T}/$(basename ${sitefile})" || die "failed to install site file" |
296 | insinto "${SITELISP}/site-gentoo.d" |
| 184 | popd |
297 | doins "${sf}" |
|
|
298 | ) |
|
|
299 | ret=$? |
|
|
300 | rm -f "${sf}" |
|
|
301 | eend ${ret} "elisp-site-file-install: doins failed" |
| 185 | } |
302 | } |
|
|
303 | |
|
|
304 | # @FUNCTION: elisp-site-regen |
|
|
305 | # @DESCRIPTION: |
|
|
306 | # Regenerate the site-gentoo.el file, based on packages' site initialisation |
|
|
307 | # files in the /usr/share/emacs/site-lisp/site-gentoo.d/ directory. |
|
|
308 | # |
|
|
309 | # Note: Before December 2007, site initialisation files were installed in |
|
|
310 | # /usr/share/emacs/site-lisp/. For backwards compatibility, this location is |
|
|
311 | # still supported when generating site-gentoo.el. |
| 186 | |
312 | |
| 187 | elisp-site-regen() { |
313 | elisp-site-regen() { |
| 188 | local sflist sf line |
314 | local i sf line firstrun obsolete |
|
|
315 | local -a sflist |
|
|
316 | # Work around Paludis borkage: variable T is empty in pkg_postrm |
|
|
317 | local tmpdir=${T:-$(mktemp -d)} |
| 189 | |
318 | |
|
|
319 | if [ ! -d "${ROOT}${SITELISP}" ]; then |
|
|
320 | eerror "elisp-site-regen: Directory ${SITELISP} does not exist" |
|
|
321 | return 1 |
|
|
322 | fi |
|
|
323 | |
|
|
324 | [ -e "${ROOT}${SITELISP}"/site-gentoo.el ] || firstrun=t |
|
|
325 | |
|
|
326 | if [ "${firstrun}" ] && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then |
|
|
327 | einfo "Creating default ${SITELISP}/site-start.el ..." |
|
|
328 | cat <<-EOF >"${tmpdir}"/site-start.el |
|
|
329 | ;;; site-start.el |
|
|
330 | |
|
|
331 | ;;; Commentary: |
|
|
332 | ;; This default site startup file is installed by elisp-common.eclass. |
|
|
333 | ;; You may replace this file by your own site initialisation, or even |
|
|
334 | ;; remove it completely; it will not be recreated. |
|
|
335 | |
|
|
336 | ;;; Code: |
|
|
337 | ;; Load site initialisation for Gentoo-installed packages. |
|
|
338 | (require 'site-gentoo) |
|
|
339 | |
|
|
340 | ;;; site-start.el ends here |
|
|
341 | EOF |
|
|
342 | fi |
|
|
343 | |
| 190 | einfo "Regenerating ${SITELISP}/site-gentoo.el ..." |
344 | einfon "Regenerating ${SITELISP}/site-gentoo.el ..." |
|
|
345 | |
|
|
346 | # remove any auxiliary file (from previous run) |
|
|
347 | rm -f "${ROOT}${SITELISP}"/00site-gentoo.el |
|
|
348 | |
|
|
349 | # set nullglob option, there may be a directory without matching files |
|
|
350 | local old_shopts=$(shopt -p nullglob) |
|
|
351 | shopt -s nullglob |
|
|
352 | |
|
|
353 | for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el \ |
|
|
354 | "${ROOT}${SITELISP}"/site-gentoo.d/[0-9][0-9]*.el |
|
|
355 | do |
|
|
356 | [ -r "${sf}" ] || continue |
|
|
357 | # sort files by their basename. straight insertion sort. |
|
|
358 | for ((i=${#sflist[@]}; i>0; i--)); do |
|
|
359 | [[ ${sf##*/} < ${sflist[i-1]##*/} ]] || break |
|
|
360 | sflist[i]=${sflist[i-1]} |
|
|
361 | done |
|
|
362 | sflist[i]=${sf} |
|
|
363 | # set a flag if there are obsolete files |
|
|
364 | [ "${sf%/*}" = "${ROOT}${SITELISP}" ] && obsolete=t |
|
|
365 | done |
|
|
366 | |
|
|
367 | eval "${old_shopts}" |
|
|
368 | |
| 191 | cat <<-EOF >"${T}"/site-gentoo.el |
369 | cat <<-EOF >"${tmpdir}"/site-gentoo.el |
| 192 | ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages |
370 | ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages |
| 193 | |
371 | |
| 194 | ;;; Commentary: |
372 | ;;; Commentary: |
| 195 | ;; Automatically generated by elisp-common.eclass |
373 | ;; Automatically generated by elisp-common.eclass |
| 196 | ;; DO NOT EDIT THIS FILE |
374 | ;; DO NOT EDIT THIS FILE |
| 197 | |
375 | |
| 198 | ;;; Code: |
376 | ;;; Code: |
| 199 | EOF |
377 | EOF |
| 200 | |
378 | # Use sed instead of cat here, since files may miss a trailing newline. |
| 201 | for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el |
379 | sed '$q' "${sflist[@]}" </dev/null >>"${tmpdir}"/site-gentoo.el |
| 202 | do |
|
|
| 203 | [ -r "${sf}" ] || continue |
|
|
| 204 | sflist="${sflist} $(basename "${sf}")" |
|
|
| 205 | cat "${sf}" >>"${T}"/site-gentoo.el |
|
|
| 206 | done |
|
|
| 207 | |
|
|
| 208 | cat <<-EOF >>"${T}"/site-gentoo.el |
380 | cat <<-EOF >>"${tmpdir}"/site-gentoo.el |
| 209 | |
381 | |
|
|
382 | (provide 'site-gentoo) |
|
|
383 | |
|
|
384 | ;; Local Variables: |
|
|
385 | ;; no-byte-compile: t |
|
|
386 | ;; End: |
| 210 | ;;; site-gentoo.el ends here |
387 | ;;; site-gentoo.el ends here |
| 211 | EOF |
388 | EOF |
| 212 | |
389 | |
| 213 | if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${T}"/site-gentoo.el; then |
390 | if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${tmpdir}"/site-gentoo.el |
|
|
391 | then |
| 214 | # This prevents outputting unnecessary text when there |
392 | # This prevents outputting unnecessary text when there |
| 215 | # was actually no change |
393 | # was actually no change. |
| 216 | # A case is a remerge where we have doubled output |
394 | # A case is a remerge where we have doubled output. |
| 217 | einfo "... no changes" |
395 | echo " no changes." |
| 218 | else |
396 | else |
| 219 | mv "${T}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el |
397 | mv "${tmpdir}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el |
| 220 | einfo "" |
398 | [ -f "${tmpdir}"/site-start.el ] \ |
| 221 | for sf in ${sflist}; do |
399 | && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \ |
| 222 | einfo " Adding ${sf} ..." |
400 | && mv "${tmpdir}"/site-start.el "${ROOT}${SITELISP}"/site-start.el |
| 223 | done |
401 | echo |
|
|
402 | einfo "... ${#sflist[@]} site initialisation file(s) included." |
|
|
403 | fi |
|
|
404 | |
|
|
405 | if [ "${firstrun}" ]; then |
|
|
406 | echo |
| 224 | while read line; do einfo "${line}"; done <<EOF |
407 | while read line; do einfo "${line:- }"; done <<-EOF |
| 225 | |
|
|
| 226 | All site initialisation for Gentoo-installed packages is now added to |
408 | All site initialisation for Gentoo-installed packages is added to |
| 227 | /usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer |
409 | /usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is not |
| 228 | managed by Gentoo. You are responsible for all maintenance of |
410 | managed by Gentoo. You are responsible for all maintenance of |
| 229 | site-start.el if there is such a file. |
411 | site-start.el if there is such a file. |
| 230 | |
412 | |
| 231 | In order for this site initialisation to be loaded for all users |
413 | In order for this site initialisation to be loaded for all users |
| 232 | automatically, as was done previously, you can add a line like this: |
414 | automatically, you can add a line like this: |
| 233 | |
415 | |
| 234 | (load "/usr/share/emacs/site-lisp/site-gentoo" nil t) |
416 | (require 'site-gentoo) |
| 235 | |
417 | |
| 236 | to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line |
418 | to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line |
| 237 | can be added by individual users to their initialisation files, or for |
419 | can be added by individual users to their initialisation files, or, |
| 238 | greater flexibility, users can select which of the package-specific |
420 | for greater flexibility, users can load individual package-specific |
| 239 | initialisation files in /usr/share/emacs/site-lisp to load. |
421 | initialisation files from /usr/share/emacs/site-lisp/site-gentoo.d/. |
| 240 | EOF |
422 | EOF |
| 241 | echo |
423 | echo |
| 242 | fi |
424 | fi |
| 243 | } |
|
|
| 244 | |
425 | |
| 245 | # The following Emacs Lisp compilation routine was originally taken from |
426 | if [ "${obsolete}" ]; then |
| 246 | # GNU autotools. |
427 | echo |
|
|
428 | while read line; do ewarn "${line}"; done <<-EOF |
|
|
429 | Site-initialisation files of Emacs packages are now installed in |
|
|
430 | /usr/share/emacs/site-lisp/site-gentoo.d/. We strongly recommend |
|
|
431 | that you use app-admin/emacs-updater to rebuild the installed |
|
|
432 | Emacs packages. |
|
|
433 | EOF |
| 247 | |
434 | |
| 248 | elisp-comp() { |
435 | # Kludge for backwards compatibility: During pkg_postrm, old versions |
| 249 | # Copyright 1995 Free Software Foundation, Inc. |
436 | # of this eclass (saved in the VDB) won't find packages' site-init |
| 250 | # François Pinard <pinard@iro.umontreal.ca>, 1995. |
437 | # files in the new location. So we copy them to an auxiliary file |
| 251 | # This script byte-compiles all `.el' files which are part of its |
438 | # that is visible to old eclass versions. |
| 252 | # arguments, using GNU Emacs, and put the resulting `.elc' files into |
439 | for sf in "${sflist[@]}"; do |
| 253 | # the current directory, so disregarding the original directories used |
440 | [ "${sf%/*}" = "${ROOT}${SITELISP}/site-gentoo.d" ] \ |
| 254 | # in `.el' arguments. |
441 | && cat "${sf}" >>"${ROOT}${SITELISP}"/00site-gentoo.el |
| 255 | # |
442 | done |
| 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 | |
|
|
| 262 | if test -z "${EMACS}" || test "${EMACS}" = "t"; then |
|
|
| 263 | # Value of "t" means we are running in a shell under Emacs. |
|
|
| 264 | # Just assume Emacs is called "emacs". |
|
|
| 265 | EMACS=/usr/bin/emacs |
|
|
| 266 | fi |
443 | fi |
| 267 | einfo "Compiling GNU Emacs Elisp files ..." |
|
|
| 268 | |
444 | |
| 269 | tempdir=elc.$$ |
445 | # cleanup |
| 270 | mkdir ${tempdir} |
446 | rm -f "${tmpdir}"/site-{gentoo,start}.el |
| 271 | cp $* ${tempdir} |
|
|
| 272 | pushd ${tempdir} |
|
|
| 273 | |
447 | |
| 274 | echo "(add-to-list 'load-path \"../\")" > script |
448 | return 0 |
| 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} |
|
|
| 283 | } |
449 | } |