1 | # Copyright 1999-2007 Gentoo Foundation |
1 | # Copyright 1999-2010 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.28 2007/09/22 20:25:30 ulm Exp $ |
3 | # $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.70 2010/11/29 17:07:22 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 <fauli@gentoo.org> |
9 | # Copyright 2007 Ulrich Mueller <ulm@gentoo.org> |
9 | # Copyright 2007-2010 Ulrich Müller <ulm@gentoo.org> |
10 | # |
10 | # |
11 | # @ECLASS: elisp-common.eclass |
11 | # @ECLASS: elisp-common.eclass |
12 | # @MAINTAINER: |
12 | # @MAINTAINER: |
13 | # Feel free to contact the Emacs team through emacs@gentoo.org if you have |
13 | # Feel free to contact the Emacs team through <emacs@gentoo.org> if you |
14 | # problems, suggestions or questions. |
14 | # have problems, suggestions or questions. |
15 | # @BLURB: Emacs-related installation utilities |
15 | # @BLURB: Emacs-related installation utilities |
16 | # @DESCRIPTION: |
16 | # @DESCRIPTION: |
17 | # |
17 | # |
18 | # 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 |
19 | # your package. This is NOT for XEmacs! |
19 | # of your package. This is NOT for XEmacs! |
20 | # |
20 | # |
21 | # 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 |
22 | # package (especially compilation), so this is mainly for standalone elisp |
22 | # package (especially compilation), so this is mainly for standalone |
23 | # files you gathered from somewhere else. |
23 | # elisp files you gathered from somewhere else. |
24 | # |
24 | # |
25 | # When relying on the emacs USE flag, you need to add |
25 | # When relying on the emacs USE flag, you need to add |
26 | # |
26 | # |
27 | # emacs? ( virtual/emacs ) |
27 | # emacs? ( virtual/emacs ) |
28 | # |
28 | # |
29 | # 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 |
30 | # the files to the correct locations. |
30 | # bring the files to the correct locations. |
|
|
31 | # |
|
|
32 | # If your package requires a minimum Emacs version, e.g. Emacs 23, then |
|
|
33 | # the dependency should be on >=virtual/emacs-23 instead. Because the |
|
|
34 | # user can select the Emacs executable with eselect, you should also |
|
|
35 | # make sure that the active Emacs version is sufficient. This can be |
|
|
36 | # tested with function elisp-need-emacs(), which would typically be |
|
|
37 | # called from pkg_setup(), as in the following example: |
|
|
38 | # |
|
|
39 | # elisp-need-emacs 23 || die "Emacs version too low" |
|
|
40 | # |
|
|
41 | # Please note that such tests should be limited to packages that are |
|
|
42 | # known to fail with lower Emacs versions; the standard case is to |
|
|
43 | # depend on virtual/emacs without version. |
31 | # |
44 | # |
32 | # .SS |
45 | # .SS |
33 | # src_compile() usage: |
46 | # src_compile() usage: |
34 | # |
47 | # |
35 | # An elisp file is compiled by the elisp-compile() function defined here and |
48 | # An elisp file is compiled by the elisp-compile() function defined |
36 | # simply takes the source files as arguments. |
49 | # here and simply takes the source files as arguments. The case of |
|
|
50 | # interdependent elisp files is also supported, since the current |
|
|
51 | # directory is added to the load-path which makes sure that all files |
|
|
52 | # are loadable. |
37 | # |
53 | # |
38 | # elisp-compile *.el || die "elisp-compile failed" |
54 | # elisp-compile *.el || die |
39 | # |
55 | # |
40 | # In the case of interdependent elisp files, you can use the elisp-comp() |
|
|
41 | # function which makes sure all files are loadable. |
|
|
42 | # |
|
|
43 | # elisp-comp *.el || die "elisp-comp failed" |
|
|
44 | # |
|
|
45 | # Function elisp-make-autoload-file() can be used to generate a file with |
56 | # Function elisp-make-autoload-file() can be used to generate a file |
46 | # autoload definitions for the lisp functions. It takes the output file name |
57 | # with autoload definitions for the lisp functions. It takes the output |
47 | # (default: "${PN}-autoloads.el") and a list of directories (default: working |
58 | # file name (default: "${PN}-autoloads.el") and a list of directories |
48 | # directory) as its arguments. Use of this function requires that the elisp |
59 | # (default: working directory) as its arguments. Use of this function |
49 | # source files contain magic ";;;###autoload" comments. See the Emacs Lisp |
60 | # requires that the elisp source files contain magic ";;;###autoload" |
50 | # Reference Manual (node "Autoload") for a detailed explanation. |
61 | # comments. See the Emacs Lisp Reference Manual (node "Autoload") for |
|
|
62 | # a detailed explanation. |
51 | # |
63 | # |
52 | # .SS |
64 | # .SS |
53 | # src_install() usage: |
65 | # src_install() usage: |
54 | # |
66 | # |
55 | # The resulting compiled files (.elc) should be put in a subdirectory of |
67 | # The resulting compiled files (.elc) should be put in a subdirectory of |
56 | # /usr/share/emacs/site-lisp/ which is named after the first argument |
68 | # /usr/share/emacs/site-lisp/ which is named after the first argument |
57 | # of elisp-install(). The following parameters are the files to be put in |
69 | # of elisp-install(). The following parameters are the files to be put |
58 | # that directory. Usually the subdirectory should be ${PN}, you can choose |
70 | # in that directory. Usually the subdirectory should be ${PN}, you can |
59 | # something else, but remember to tell elisp-site-file-install() (see below) |
71 | # choose something else, but remember to tell elisp-site-file-install() |
60 | # the change, as it defaults to ${PN}. |
72 | # (see below) the change, as it defaults to ${PN}. |
61 | # |
73 | # |
62 | # elisp-install ${PN} *.el *.elc || die "elisp-install failed" |
74 | # elisp-install ${PN} *.el *.elc || die |
63 | # |
75 | # |
64 | # To let the Emacs support be activated by Emacs on startup, you need |
76 | # To let the Emacs support be activated by Emacs on startup, you need |
65 | # to provide a site file (shipped in ${FILESDIR}) which contains the startup |
77 | # to provide a site file (shipped in ${FILESDIR}) which contains the |
66 | # code (have a look in the documentation of your software). Normally this |
78 | # startup code (have a look in the documentation of your software). |
67 | # would look like this: |
79 | # Normally this would look like this: |
68 | # |
|
|
69 | # ;;; csv-mode site-lisp configuration |
|
|
70 | # |
80 | # |
71 | # (add-to-list 'load-path "@SITELISP@") |
81 | # (add-to-list 'load-path "@SITELISP@") |
72 | # (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode)) |
82 | # (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode)) |
73 | # (autoload 'csv-mode "csv-mode" "Major mode for csv files." t) |
83 | # (autoload 'csv-mode "csv-mode" "Major mode for csv files." t) |
74 | # |
84 | # |
75 | # If your Emacs support files are installed in a subdirectory of |
85 | # If your Emacs support files are installed in a subdirectory of |
76 | # /usr/share/emacs/site-lisp/ (which is recommended if more than one file is |
86 | # /usr/share/emacs/site-lisp/ (which is strongly recommended), you need |
77 | # installed), you need to extend Emacs' load-path as shown in the first |
87 | # to extend Emacs' load-path as shown in the first non-comment line. |
78 | # non-comment. The elisp-site-file-install() function of this eclass will |
88 | # The elisp-site-file-install() function of this eclass will replace |
79 | # replace "@SITELISP@" by the actual path. |
89 | # "@SITELISP@" and "@SITEETC@" by the actual paths. |
80 | # |
90 | # |
81 | # The next line tells Emacs to load the mode opening a file ending with |
91 | # The next line tells Emacs to load the mode opening a file ending |
82 | # ".csv" and load functions depending on the context and needed features. |
92 | # with ".csv" and load functions depending on the context and needed |
83 | # Be careful though. Commands as "load-library" or "require" bloat the |
93 | # features. Be careful though. Commands as "load-library" or "require" |
84 | # editor as they are loaded on every startup. When having a lot of Emacs |
94 | # bloat the editor as they are loaded on every startup. When having |
85 | # support files, users may be annoyed by the start-up time. Also avoid |
95 | # many Emacs support files, users may be annoyed by the start-up time. |
86 | # keybindings as they might interfere with the user's settings. Give a hint |
96 | # Also avoid keybindings as they might interfere with the user's |
87 | # in pkg_postinst(), which should be enough. |
97 | # settings. Give a hint in pkg_postinst(), which should be enough. |
88 | # |
98 | # |
89 | # The naming scheme for this site file is "[0-9][0-9]*-gentoo.el", where the |
99 | # The naming scheme for this site-init file matches the shell pattern |
90 | # two digits at the beginning define the loading order. So if you depend on |
100 | # "[1-8][0-9]*-gentoo*.el", where the two digits at the beginning define |
91 | # another Emacs package, your site file's number must be higher! |
101 | # the loading order (numbers below 10 or above 89 are reserved for |
|
|
102 | # internal use). So if your initialisation depends on another Emacs |
|
|
103 | # package, your site file's number must be higher! If there are no such |
|
|
104 | # interdependencies then the number should be 50. Otherwise, numbers |
|
|
105 | # divisible by 10 are preferred. |
92 | # |
106 | # |
93 | # Best practice is to define a SITEFILE variable in the global scope of your |
107 | # Best practice is to define a SITEFILE variable in the global scope of |
94 | # ebuild (right after DEPEND e.g.): |
108 | # your ebuild (e.g., right after S or RDEPEND): |
95 | # |
109 | # |
96 | # SITEFILE=50${PN}-gentoo.el |
110 | # SITEFILE="50${PN}-gentoo.el" |
97 | # |
111 | # |
98 | # Which is then installed by |
112 | # Which is then installed by |
99 | # |
113 | # |
100 | # elisp-site-file-install "${FILESDIR}/${SITEFILE}" |
114 | # elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die |
101 | # |
115 | # |
|
|
116 | # in src_install(). Any characters after the "-gentoo" part and before |
|
|
117 | # the extension will be stripped from the destination file's name. |
|
|
118 | # For example, a file "50${PN}-gentoo-${PV}.el" will be installed as |
102 | # in src_install(). If your subdirectory is not named ${PN}, give the |
119 | # "50${PN}-gentoo.el". If your subdirectory is not named ${PN}, give |
103 | # differing name as second argument. |
120 | # the differing name as second argument. |
104 | # |
121 | # |
105 | # .SS |
122 | # .SS |
106 | # pkg_postinst() / pkg_postrm() usage: |
123 | # pkg_postinst() / pkg_postrm() usage: |
107 | # |
124 | # |
108 | # After that you need to recreate the start-up file of Emacs after emerging |
125 | # After that you need to recreate the start-up file of Emacs after |
109 | # and unmerging by using |
126 | # emerging and unmerging by using |
110 | # |
127 | # |
111 | # pkg_postinst() { |
128 | # pkg_postinst() { |
112 | # elisp-site-regen |
129 | # elisp-site-regen |
113 | # } |
130 | # } |
114 | # |
131 | # |
115 | # pkg_postrm() { |
132 | # pkg_postrm() { |
116 | # elisp-site-regen |
133 | # elisp-site-regen |
117 | # } |
134 | # } |
118 | # |
135 | # |
119 | # When having optional Emacs support, you should prepend "use emacs &&" to |
136 | # When having optional Emacs support, you should prepend "use emacs &&" |
120 | # above calls of elisp-site-regen(). Don't use "has_version virtual/emacs"! |
137 | # to above calls of elisp-site-regen(). |
121 | # When unmerging the state of the emacs USE flag is taken from the package |
138 | # Don't use "has_version virtual/emacs"! When unmerging the state of |
122 | # database and not from the environment, so it is no problem when you unset |
139 | # the emacs USE flag is taken from the package database and not from the |
|
|
140 | # environment, so it is no problem when you unset USE=emacs between |
123 | # USE=emacs between merge and unmerge of a package. |
141 | # merge and unmerge of a package. |
124 | # |
|
|
125 | # .SS |
|
|
126 | # Miscellaneous functions: |
|
|
127 | # |
|
|
128 | # elisp-emacs-version() outputs the version of the currently active Emacs. |
|
|
129 | |
142 | |
|
|
143 | # @ECLASS-VARIABLE: SITELISP |
|
|
144 | # @DESCRIPTION: |
|
|
145 | # Directory where packages install Emacs Lisp files. |
130 | SITELISP=/usr/share/emacs/site-lisp |
146 | SITELISP=/usr/share/emacs/site-lisp |
131 | SITEFILE=50${PN}-gentoo.el |
147 | |
|
|
148 | # @ECLASS-VARIABLE: SITEETC |
|
|
149 | # @DESCRIPTION: |
|
|
150 | # Directory where packages install miscellaneous (not Lisp) files. |
|
|
151 | SITEETC=/usr/share/emacs/etc |
|
|
152 | |
|
|
153 | # @ECLASS-VARIABLE: EMACS |
|
|
154 | # @DESCRIPTION: |
|
|
155 | # Path of Emacs executable. |
132 | EMACS=/usr/bin/emacs |
156 | EMACS=${EPREFIX}/usr/bin/emacs |
|
|
157 | |
|
|
158 | # @ECLASS-VARIABLE: EMACSFLAGS |
|
|
159 | # @DESCRIPTION: |
|
|
160 | # Flags for executing Emacs in batch mode. |
133 | # The following works for Emacs versions 18-23, don't change it. |
161 | # These work for Emacs versions 18-23, so don't change them. |
134 | EMACS_BATCH_CLEAN="${EMACS} -batch -q --no-site-file" |
162 | EMACSFLAGS="-batch -q --no-site-file" |
135 | |
163 | |
136 | # @FUNCTION: elisp-compile |
164 | # @ECLASS-VARIABLE: BYTECOMPFLAGS |
137 | # @USAGE: <list of elisp files> |
|
|
138 | # @DESCRIPTION: |
165 | # @DESCRIPTION: |
139 | # Byte-compile Emacs Lisp files. |
166 | # Emacs flags used for byte-compilation in elisp-compile(). |
140 | |
167 | BYTECOMPFLAGS="-L ." |
141 | elisp-compile() { |
|
|
142 | einfo "Compiling GNU Emacs Elisp files ..." |
|
|
143 | ${EMACS_BATCH_CLEAN} -f batch-byte-compile "$@" |
|
|
144 | } |
|
|
145 | |
168 | |
146 | # @FUNCTION: elisp-emacs-version |
169 | # @FUNCTION: elisp-emacs-version |
147 | # @DESCRIPTION: |
170 | # @DESCRIPTION: |
148 | # Output version of currently active Emacs. |
171 | # Output version of currently active Emacs. |
149 | |
172 | |
150 | elisp-emacs-version() { |
173 | elisp-emacs-version() { |
151 | # The following will work for at least versions 18-23. |
174 | # The following will work for at least versions 18-23. |
152 | echo "(princ emacs-version)" >"${T}"/emacs-version.el |
175 | echo "(princ emacs-version)" >"${T}"/emacs-version.el |
153 | ${EMACS_BATCH_CLEAN} -l "${T}"/emacs-version.el |
176 | ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el |
|
|
177 | rm -f "${T}"/emacs-version.el |
|
|
178 | } |
|
|
179 | |
|
|
180 | # @FUNCTION: elisp-need-emacs |
|
|
181 | # @USAGE: <version> |
|
|
182 | # @RETURN: 0 if true, 1 otherwise |
|
|
183 | # @DESCRIPTION: |
|
|
184 | # Test if the eselected Emacs version is at least the major version |
|
|
185 | # specified as argument. |
|
|
186 | |
|
|
187 | elisp-need-emacs() { |
|
|
188 | local need_emacs=$1 |
|
|
189 | local have_emacs=$(elisp-emacs-version) |
|
|
190 | einfo "Emacs version: ${have_emacs}" |
|
|
191 | if ! [[ ${have_emacs%%.*} -ge ${need_emacs%%.*} ]]; then |
|
|
192 | eerror "This package needs at least Emacs ${need_emacs%%.*}." |
|
|
193 | eerror "Use \"eselect emacs\" to select the active version." |
|
|
194 | return 1 |
|
|
195 | fi |
|
|
196 | return 0 |
|
|
197 | } |
|
|
198 | |
|
|
199 | # @FUNCTION: elisp-compile |
|
|
200 | # @USAGE: <list of elisp files> |
|
|
201 | # @DESCRIPTION: |
|
|
202 | # Byte-compile Emacs Lisp files. |
|
|
203 | # |
|
|
204 | # This function uses GNU Emacs to byte-compile all ".el" specified by |
|
|
205 | # its arguments. The resulting byte-code (".elc") files are placed in |
|
|
206 | # the same directory as their corresponding source file. |
|
|
207 | # |
|
|
208 | # The current directory is added to the load-path. This will ensure |
|
|
209 | # that interdependent Emacs Lisp files are visible between themselves, |
|
|
210 | # in case they require or load one another. |
|
|
211 | |
|
|
212 | elisp-compile() { |
|
|
213 | ebegin "Compiling GNU Emacs Elisp files" |
|
|
214 | ${EMACS} ${EMACSFLAGS} ${BYTECOMPFLAGS} -f batch-byte-compile "$@" |
|
|
215 | eend $? "elisp-compile: batch-byte-compile failed" |
154 | } |
216 | } |
155 | |
217 | |
156 | # @FUNCTION: elisp-make-autoload-file |
218 | # @FUNCTION: elisp-make-autoload-file |
157 | # @USAGE: [output file] [list of directories] |
219 | # @USAGE: [output file] [list of directories] |
158 | # @DESCRIPTION: |
220 | # @DESCRIPTION: |
159 | # Generate a file with autoload definitions for the lisp functions. |
221 | # Generate a file with autoload definitions for the lisp functions. |
160 | |
222 | |
161 | elisp-make-autoload-file () { |
223 | elisp-make-autoload-file() { |
162 | local f="${1:-${PN}-autoloads.el}" |
224 | local f="${1:-${PN}-autoloads.el}" null="" page=$'\f' |
163 | shift |
225 | shift |
164 | einfo "Generating autoload file for GNU Emacs ..." |
226 | ebegin "Generating autoload file for GNU Emacs" |
165 | |
227 | |
166 | sed 's/^FF/\f/' >"${f}" <<-EOF |
228 | cat >"${f}" <<-EOF |
167 | ;;; ${f##*/} --- autoloads for ${P} |
229 | ;;; ${f##*/} --- autoloads for ${PN} |
168 | |
230 | |
169 | ;;; Commentary: |
231 | ;;; Commentary: |
170 | ;; Automatically generated by elisp-common.eclass |
232 | ;; Automatically generated by elisp-common.eclass |
171 | ;; DO NOT EDIT THIS FILE |
233 | ;; DO NOT EDIT THIS FILE |
172 | |
234 | |
173 | ;;; Code: |
235 | ;;; Code: |
174 | FF |
236 | ${page} |
175 | ;; Local Variables: |
237 | ;; Local ${null}Variables: |
176 | ;; version-control: never |
238 | ;; version-control: never |
177 | ;; no-byte-compile: t |
239 | ;; no-byte-compile: t |
178 | ;; no-update-autoloads: t |
240 | ;; no-update-autoloads: t |
179 | ;; End: |
241 | ;; End: |
|
|
242 | |
180 | ;;; ${f##*/} ends here |
243 | ;;; ${f##*/} ends here |
181 | EOF |
244 | EOF |
182 | |
245 | |
183 | ${EMACS_BATCH_CLEAN} \ |
246 | ${EMACS} ${EMACSFLAGS} \ |
184 | --eval "(setq make-backup-files nil)" \ |
247 | --eval "(setq make-backup-files nil)" \ |
185 | --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \ |
248 | --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \ |
186 | -f batch-update-autoloads "${@-.}" |
249 | -f batch-update-autoloads "${@-.}" |
|
|
250 | |
|
|
251 | eend $? "elisp-make-autoload-file: batch-update-autoloads failed" |
187 | } |
252 | } |
188 | |
253 | |
189 | # @FUNCTION: elisp-install |
254 | # @FUNCTION: elisp-install |
190 | # @USAGE: <subdirectory> <list of files> |
255 | # @USAGE: <subdirectory> <list of files> |
191 | # @DESCRIPTION: |
256 | # @DESCRIPTION: |
192 | # Install files in SITELISP directory. |
257 | # Install files in SITELISP directory. |
193 | |
258 | |
194 | elisp-install() { |
259 | elisp-install() { |
195 | local subdir="$1" |
260 | local subdir="$1" |
196 | shift |
261 | shift |
197 | einfo "Installing Elisp files for GNU Emacs support ..." |
262 | ebegin "Installing Elisp files for GNU Emacs support" |
198 | ( # subshell to avoid pollution of calling environment |
263 | ( # subshell to avoid pollution of calling environment |
199 | insinto "${SITELISP}/${subdir}" |
264 | insinto "${SITELISP}/${subdir}" |
200 | doins "$@" |
265 | doins "$@" |
201 | ) |
266 | ) |
|
|
267 | eend $? "elisp-install: doins failed" |
202 | } |
268 | } |
203 | |
269 | |
204 | # @FUNCTION: elisp-site-file-install |
270 | # @FUNCTION: elisp-site-file-install |
205 | # @USAGE: <site-init file> [subdirectory] |
271 | # @USAGE: <site-init file> [subdirectory] |
206 | # @DESCRIPTION: |
272 | # @DESCRIPTION: |
207 | # Install Emacs site-init file in SITELISP directory. |
273 | # Install Emacs site-init file in SITELISP directory. Automatically |
|
|
274 | # inserts a standard comment header with the name of the package (unless |
|
|
275 | # it is already present). Tokens @SITELISP@ and @SITEETC@ are replaced |
|
|
276 | # by the path to the package's subdirectory in SITELISP and SITEETC, |
|
|
277 | # respectively. |
208 | |
278 | |
209 | elisp-site-file-install() { |
279 | elisp-site-file-install() { |
210 | local sf="$1" my_pn="${2:-${PN}}" |
280 | local sf="${1##*/}" my_pn="${2:-${PN}}" ret |
|
|
281 | local header=";;; ${PN} site-lisp configuration" |
|
|
282 | |
|
|
283 | [[ ${sf} == [0-9][0-9]*-gentoo*.el ]] \ |
|
|
284 | || ewarn "elisp-site-file-install: bad name of site-init file" |
|
|
285 | sf="${T}/${sf/%-gentoo*.el/-gentoo.el}" |
211 | einfo "Installing site initialisation file for GNU Emacs ..." |
286 | ebegin "Installing site initialisation file for GNU Emacs" |
212 | cp "${sf}" "${T}" |
287 | [[ $1 = ${sf} ]] || cp "$1" "${sf}" |
213 | sed -i "s:@SITELISP@:${SITELISP}/${my_pn}:g" "${T}/$(basename "${sf}")" |
288 | sed -i -e "1{:x;/^\$/{n;bx;};/^;.*${PN}/I!s:^:${header}\n\n:;1s:^:\n:;}" \ |
|
|
289 | -e "s:@SITELISP@:${EPREFIX}${SITELISP}/${my_pn}:g" \ |
|
|
290 | -e "s:@SITEETC@:${EPREFIX}${SITEETC}/${my_pn}:g;\$q" "${sf}" |
214 | ( # subshell to avoid pollution of calling environment |
291 | ( # subshell to avoid pollution of calling environment |
215 | insinto "${SITELISP}" |
292 | insinto "${SITELISP}/site-gentoo.d" |
216 | doins "${T}/$(basename "${sf}")" |
293 | doins "${sf}" |
217 | ) |
294 | ) |
|
|
295 | ret=$? |
|
|
296 | rm -f "${sf}" |
|
|
297 | eend ${ret} "elisp-site-file-install: doins failed" |
218 | } |
298 | } |
219 | |
299 | |
220 | # @FUNCTION: elisp-site-regen |
300 | # @FUNCTION: elisp-site-regen |
221 | # @DESCRIPTION: |
301 | # @DESCRIPTION: |
222 | # Regenerate site-gentoo.el file. |
302 | # Regenerate the site-gentoo.el file, based on packages' site |
|
|
303 | # initialisation files in the /usr/share/emacs/site-lisp/site-gentoo.d/ |
|
|
304 | # directory. |
|
|
305 | # |
|
|
306 | # Note: Before December 2007, site initialisation files were installed |
|
|
307 | # in /usr/share/emacs/site-lisp/. For backwards compatibility, this |
|
|
308 | # location is still supported when generating site-gentoo.el. |
223 | |
309 | |
224 | elisp-site-regen() { |
310 | elisp-site-regen() { |
225 | local sflist sf line |
311 | local sitelisp=${ROOT}${EPREFIX}${SITELISP} |
|
|
312 | local sf i line null="" page=$'\f' |
|
|
313 | local -a sflist |
226 | |
314 | |
227 | einfon "Regenerating ${SITELISP}/site-gentoo.el ..." |
315 | if [ ! -d "${sitelisp}" ]; then |
|
|
316 | eerror "elisp-site-regen: Directory ${sitelisp} does not exist" |
|
|
317 | return 1 |
|
|
318 | fi |
|
|
319 | |
|
|
320 | if [ ! -d "${T}" ]; then |
|
|
321 | eerror "elisp-site-regen: Temporary directory ${T} does not exist" |
|
|
322 | return 1 |
|
|
323 | fi |
|
|
324 | |
|
|
325 | einfon "Regenerating site-gentoo.el for GNU Emacs (${EBUILD_PHASE}) ..." |
|
|
326 | |
|
|
327 | # Until January 2009, elisp-common.eclass sometimes created an |
|
|
328 | # auxiliary file for backwards compatibility. Remove any such file. |
|
|
329 | rm -f "${sitelisp}"/00site-gentoo.el |
|
|
330 | |
|
|
331 | for sf in "${sitelisp}"/[0-9][0-9]*-gentoo.el \ |
|
|
332 | "${sitelisp}"/site-gentoo.d/[0-9][0-9]*.el |
|
|
333 | do |
|
|
334 | [ -r "${sf}" ] || continue |
|
|
335 | # sort files by their basename. straight insertion sort. |
|
|
336 | for ((i=${#sflist[@]}; i>0; i--)); do |
|
|
337 | [[ ${sf##*/} < ${sflist[i-1]##*/} ]] || break |
|
|
338 | sflist[i]=${sflist[i-1]} |
|
|
339 | done |
|
|
340 | sflist[i]=${sf} |
|
|
341 | done |
|
|
342 | |
228 | cat <<-EOF >"${T}"/site-gentoo.el |
343 | cat <<-EOF >"${T}"/site-gentoo.el |
229 | ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages |
344 | ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages |
230 | |
345 | |
231 | ;;; Commentary: |
346 | ;;; Commentary: |
232 | ;; Automatically generated by elisp-common.eclass |
347 | ;; Automatically generated by elisp-common.eclass |
233 | ;; DO NOT EDIT THIS FILE |
348 | ;; DO NOT EDIT THIS FILE |
234 | |
349 | |
235 | ;;; Code: |
350 | ;;; Code: |
236 | EOF |
351 | EOF |
237 | |
352 | # Use sed instead of cat here, since files may miss a trailing newline. |
238 | for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el |
353 | sed '$q' "${sflist[@]}" </dev/null >>"${T}"/site-gentoo.el |
239 | do |
|
|
240 | [ -r "${sf}" ] || continue |
|
|
241 | sflist="${sflist} $(basename "${sf}")" |
|
|
242 | cat "${sf}" >>"${T}"/site-gentoo.el |
|
|
243 | done |
|
|
244 | |
|
|
245 | cat <<-EOF >>"${T}"/site-gentoo.el |
354 | cat <<-EOF >>"${T}"/site-gentoo.el |
246 | |
355 | |
|
|
356 | ${page} |
247 | (provide 'site-gentoo) |
357 | (provide 'site-gentoo) |
248 | |
358 | |
249 | ;; Local Variables: |
359 | ;; Local ${null}Variables: |
250 | ;; no-byte-compile: t |
360 | ;; no-byte-compile: t |
|
|
361 | ;; buffer-read-only: t |
251 | ;; End: |
362 | ;; End: |
|
|
363 | |
252 | ;;; site-gentoo.el ends here |
364 | ;;; site-gentoo.el ends here |
253 | EOF |
365 | EOF |
254 | |
366 | |
255 | if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${T}"/site-gentoo.el; then |
367 | if cmp -s "${sitelisp}"/site-gentoo.el "${T}"/site-gentoo.el; then |
256 | # This prevents outputting unnecessary text when there |
368 | # This prevents outputting unnecessary text when there |
257 | # was actually no change |
369 | # was actually no change. |
258 | # A case is a remerge where we have doubled output |
370 | # A case is a remerge where we have doubled output. |
|
|
371 | rm -f "${T}"/site-gentoo.el |
259 | echo " no changes." |
372 | echo " no changes." |
260 | else |
373 | else |
261 | mv "${T}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el |
374 | mv "${T}"/site-gentoo.el "${sitelisp}"/site-gentoo.el |
262 | echo; einfo |
|
|
263 | for sf in ${sflist}; do |
|
|
264 | einfo " Adding ${sf} ..." |
|
|
265 | done |
|
|
266 | while read line; do einfo "${line}"; done <<EOF |
|
|
267 | |
|
|
268 | All site initialisation for Gentoo-installed packages is added to |
|
|
269 | /usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer |
|
|
270 | managed by Gentoo. You are responsible for all maintenance of |
|
|
271 | site-start.el if there is such a file. |
|
|
272 | |
|
|
273 | In order for this site initialisation to be loaded for all users |
|
|
274 | automatically, you can add a line like this: |
|
|
275 | |
|
|
276 | (load "/usr/share/emacs/site-lisp/site-gentoo" nil t) |
|
|
277 | |
|
|
278 | to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line |
|
|
279 | can be added by individual users to their initialisation files, or for |
|
|
280 | greater flexibility, users can select which of the package-specific |
|
|
281 | initialisation files in /usr/share/emacs/site-lisp/ to load. |
|
|
282 | EOF |
|
|
283 | echo |
375 | echo |
|
|
376 | case ${#sflist[@]} in |
|
|
377 | 0) ewarn "... Huh? No site initialisation files found." ;; |
|
|
378 | 1) einfo "... ${#sflist[@]} site initialisation file included." ;; |
|
|
379 | *) einfo "... ${#sflist[@]} site initialisation files included." ;; |
|
|
380 | esac |
284 | fi |
381 | fi |
285 | } |
|
|
286 | |
382 | |
287 | # @FUNCTION: elisp-comp |
383 | return 0 |
288 | # @USAGE: <list of elisp files> |
|
|
289 | # @DESCRIPTION: |
|
|
290 | # Byte-compile interdependent Emacs Lisp files. |
|
|
291 | # |
|
|
292 | # This function byte-compiles all ".el" files which are part of its |
|
|
293 | # arguments, using GNU Emacs, and puts the resulting ".elc" files into the |
|
|
294 | # current directory, so disregarding the original directories used in ".el" |
|
|
295 | # arguments. |
|
|
296 | # |
|
|
297 | # This function manages in such a way that all Emacs Lisp files to be |
|
|
298 | # compiled are made visible between themselves, in the event they require or |
|
|
299 | # load one another. |
|
|
300 | |
|
|
301 | elisp-comp() { |
|
|
302 | # Copyright 1995 Free Software Foundation, Inc. |
|
|
303 | # François Pinard <pinard@iro.umontreal.ca>, 1995. |
|
|
304 | # Originally taken from GNU autotools. |
|
|
305 | |
|
|
306 | test $# -gt 0 || return 1 |
|
|
307 | |
|
|
308 | if test -z "${EMACS}" || test "${EMACS}" = "t"; then |
|
|
309 | # Value of "t" means we are running in a shell under Emacs. |
|
|
310 | # Just assume Emacs is called "emacs". |
|
|
311 | EMACS=/usr/bin/emacs |
|
|
312 | fi |
|
|
313 | einfo "Compiling GNU Emacs Elisp files ..." |
|
|
314 | |
|
|
315 | tempdir=elc.$$ |
|
|
316 | mkdir ${tempdir} |
|
|
317 | cp "$@" ${tempdir} |
|
|
318 | pushd ${tempdir} |
|
|
319 | |
|
|
320 | echo "(add-to-list 'load-path \"../\")" > script |
|
|
321 | ${EMACS_BATCH_CLEAN} -l script -f batch-byte-compile *.el |
|
|
322 | local ret=$? |
|
|
323 | mv *.elc .. |
|
|
324 | |
|
|
325 | popd |
|
|
326 | rm -fr ${tempdir} |
|
|
327 | return ${ret} |
|
|
328 | } |
384 | } |