1 # Copyright 2002-2019 Gentoo Authors
2 # Distributed under the terms of the GNU General Public License v2
4 # @ECLASS: elisp-common.eclass
6 # Gentoo GNU Emacs project <gnu-emacs@gentoo.org>
8 # Matthew Kennedy <mkennedy@gentoo.org>
9 # Jeremy Maitin-Shepard <jbms@attbi.com>
10 # Mamoru Komachi <usata@gentoo.org>
11 # Christian Faulhammer <fauli@gentoo.org>
12 # Ulrich Müller <ulm@gentoo.org>
13 # @SUPPORTED_EAPIS: 4 5 6 7
14 # @BLURB: Emacs-related installation utilities
17 # Usually you want to use this eclass for (optional) GNU Emacs support
18 # of your package. This is NOT for XEmacs!
20 # Many of the steps here are sometimes done by the build system of your
21 # package (especially compilation), so this is mainly for standalone
22 # elisp files you gathered from somewhere else.
24 # When relying on the emacs USE flag, you need to add
27 # emacs? ( virtual/emacs )
30 # to your DEPEND/RDEPEND line and use the functions provided here to
31 # bring the files to the correct locations.
33 # If your package requires a minimum Emacs version, e.g. Emacs 24, then
34 # the dependency should be on >=virtual/emacs-24 instead. Because the
35 # user can select the Emacs executable with eselect, you should also
36 # make sure that the active Emacs version is sufficient. This can be
37 # tested with function elisp-need-emacs(), which would typically be
38 # called from pkg_setup(), as in the following example:
41 # elisp-need-emacs 24 || die "Emacs version too low"
44 # Please note that such tests should be limited to packages that are
45 # known to fail with lower Emacs versions; the standard case is to
46 # depend on virtual/emacs without version.
49 # src_compile() usage:
51 # An elisp file is compiled by the elisp-compile() function defined
52 # here and simply takes the source files as arguments. The case of
53 # interdependent elisp files is also supported, since the current
54 # directory is added to the load-path which makes sure that all files
61 # Function elisp-make-autoload-file() can be used to generate a file
62 # with autoload definitions for the lisp functions. It takes the output
63 # file name (default: "${PN}-autoloads.el") and a list of directories
64 # (default: working directory) as its arguments. Use of this function
65 # requires that the elisp source files contain magic ";;;###autoload"
66 # comments. See the Emacs Lisp Reference Manual (node "Autoload") for
67 # a detailed explanation.
70 # src_install() usage:
72 # The resulting compiled files (.elc) should be put in a subdirectory of
73 # /usr/share/emacs/site-lisp/ which is named after the first argument
74 # of elisp-install(). The following parameters are the files to be put
75 # in that directory. Usually the subdirectory should be ${PN}, you can
76 # choose something else, but remember to tell elisp-site-file-install()
77 # (see below) the change, as it defaults to ${PN}.
80 # elisp-install ${PN} *.el *.elc
83 # To let the Emacs support be activated by Emacs on startup, you need
84 # to provide a site file (shipped in ${FILESDIR}) which contains the
85 # startup code (have a look in the documentation of your software).
86 # Normally this would look like this:
89 # (add-to-list 'load-path "@SITELISP@")
90 # (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode))
91 # (autoload 'csv-mode "csv-mode" "Major mode for csv files." t)
94 # If your Emacs support files are installed in a subdirectory of
95 # /usr/share/emacs/site-lisp/ (which is strongly recommended), you need
96 # to extend Emacs' load-path as shown in the first non-comment line.
97 # The elisp-site-file-install() function of this eclass will replace
98 # "@SITELISP@" and "@SITEETC@" by the actual paths.
100 # The next line tells Emacs to load the mode opening a file ending
101 # with ".csv" and load functions depending on the context and needed
102 # features. Be careful though. Commands as "load-library" or "require"
103 # bloat the editor as they are loaded on every startup. When having
104 # many Emacs support files, users may be annoyed by the start-up time.
105 # Also avoid keybindings as they might interfere with the user's
106 # settings. Give a hint in pkg_postinst(), which should be enough.
107 # The guiding principle is that emerging your package should not by
108 # itself cause a change of standard Emacs behaviour.
110 # The naming scheme for this site-init file matches the shell pattern
111 # "[1-8][0-9]*-gentoo*.el", where the two digits at the beginning define
112 # the loading order (numbers below 10 or above 89 are reserved for
113 # internal use). So if your initialisation depends on another Emacs
114 # package, your site file's number must be higher! If there are no such
115 # interdependencies then the number should be 50. Otherwise, numbers
116 # divisible by 10 are preferred.
118 # Best practice is to define a SITEFILE variable in the global scope of
119 # your ebuild (e.g., right after S or RDEPEND):
122 # SITEFILE="50${PN}-gentoo.el"
125 # Which is then installed by
128 # elisp-site-file-install "${FILESDIR}/${SITEFILE}"
131 # in src_install(). Any characters after the "-gentoo" part and before
132 # the extension will be stripped from the destination file's name.
133 # For example, a file "50${PN}-gentoo-${PV}.el" will be installed as
134 # "50${PN}-gentoo.el". If your subdirectory is not named ${PN}, give
135 # the differing name as second argument.
138 # pkg_postinst() / pkg_postrm() usage:
140 # After that you need to recreate the start-up file of Emacs after
141 # emerging and unmerging by using
153 # When having optional Emacs support, you should prepend "use emacs &&"
154 # to above calls of elisp-site-regen().
155 # Don't use "has_version virtual/emacs"! When unmerging the state of
156 # the emacs USE flag is taken from the package database and not from the
157 # environment, so it is no problem when you unset USE=emacs between
158 # merge and unmerge of a package.
162 *) die "${ECLASS}: EAPI ${EAPI:-0} not supported" ;;
165 # @ECLASS-VARIABLE: SITELISP
167 # Directory where packages install Emacs Lisp files.
168 SITELISP=/usr/share/emacs/site-lisp
170 # @ECLASS-VARIABLE: SITEETC
172 # Directory where packages install miscellaneous (not Lisp) files.
173 SITEETC=/usr/share/emacs/etc
175 # @ECLASS-VARIABLE: EMACS
177 # Path of Emacs executable.
178 EMACS=${EPREFIX}/usr/bin/emacs
180 # @ECLASS-VARIABLE: EMACSFLAGS
182 # Flags for executing Emacs in batch mode.
183 # These work for Emacs versions 18-24, so don't change them.
184 EMACSFLAGS="-batch -q --no-site-file"
186 # @ECLASS-VARIABLE: BYTECOMPFLAGS
188 # Emacs flags used for byte-compilation in elisp-compile().
191 # @FUNCTION: elisp-emacs-version
192 # @RETURN: exit status of Emacs
194 # Output version of currently active Emacs.
196 elisp-emacs-version() {
198 # The following will work for at least versions 18-24.
199 echo "(princ emacs-version)" >"${T}"/emacs-version.el
201 # EMACS could be a microemacs variant that ignores the -batch
202 # option and would therefore hang, waiting for user interaction.
203 # Redirecting stdin and unsetting TERM and DISPLAY will cause
204 # most of them to exit with an error.
206 ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el </dev/null
209 rm -f "${T}"/emacs-version.el
210 if [[ ${ret} -ne 0 ]]; then
211 eerror "elisp-emacs-version: Failed to run ${EMACS}"
214 if [[ -z ${version} ]]; then
215 eerror "elisp-emacs-version: Could not determine Emacs version"
221 # @FUNCTION: elisp-need-emacs
223 # @RETURN: 0 if true, 1 if false, 2 if trouble
225 # Test if the eselected Emacs version is at least the major version
226 # of GNU Emacs specified as argument.
229 local need_emacs=$1 have_emacs
230 have_emacs=$(elisp-emacs-version) || return 2
231 einfo "Emacs version: ${have_emacs}"
232 if [[ ${have_emacs} =~ XEmacs|Lucid ]]; then
233 eerror "This package needs GNU Emacs."
236 if ! [[ ${have_emacs%%.*} -ge ${need_emacs%%.*} ]]; then
237 eerror "This package needs at least Emacs ${need_emacs%%.*}."
238 eerror "Use \"eselect emacs\" to select the active version."
244 # @FUNCTION: elisp-compile
245 # @USAGE: <list of elisp files>
247 # Byte-compile Emacs Lisp files.
249 # This function uses GNU Emacs to byte-compile all ".el" specified by
250 # its arguments. The resulting byte-code (".elc") files are placed in
251 # the same directory as their corresponding source file.
253 # The current directory is added to the load-path. This will ensure
254 # that interdependent Emacs Lisp files are visible between themselves,
255 # in case they require or load one another.
258 ebegin "Compiling GNU Emacs Elisp files"
259 ${EMACS} ${EMACSFLAGS} ${BYTECOMPFLAGS} -f batch-byte-compile "$@"
260 eend $? "elisp-compile: batch-byte-compile failed" || die
263 # @FUNCTION: elisp-make-autoload-file
264 # @USAGE: [output file] [list of directories]
266 # Generate a file with autoload definitions for the lisp functions.
268 elisp-make-autoload-file() {
269 local f="${1:-${PN}-autoloads.el}" null="" page=$'\f'
271 ebegin "Generating autoload file for GNU Emacs"
274 ;;; ${f##*/} --- autoloads for ${PN}
277 ;; Automatically generated by elisp-common.eclass
278 ;; DO NOT EDIT THIS FILE
282 ;; Local ${null}Variables:
283 ;; version-control: never
284 ;; no-byte-compile: t
285 ;; no-update-autoloads: t
288 ;;; ${f##*/} ends here
291 ${EMACS} ${EMACSFLAGS} \
292 --eval "(setq make-backup-files nil)" \
293 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
294 -f batch-update-autoloads "${@-.}"
296 eend $? "elisp-make-autoload-file: batch-update-autoloads failed" || die
299 # @FUNCTION: elisp-install
300 # @USAGE: <subdirectory> <list of files>
302 # Install files in SITELISP directory.
307 einfo "Installing Elisp files for GNU Emacs support"
308 ( # subshell to avoid pollution of calling environment
309 insinto "${SITELISP}/${subdir}"
314 # @FUNCTION: elisp-site-file-install
315 # @USAGE: <site-init file> [subdirectory]
317 # Install Emacs site-init file in SITELISP directory. Automatically
318 # inserts a standard comment header with the name of the package (unless
319 # it is already present). Tokens @SITELISP@ and @SITEETC@ are replaced
320 # by the path to the package's subdirectory in SITELISP and SITEETC,
323 elisp-site-file-install() {
324 local sf="${1##*/}" my_pn="${2:-${PN}}"
325 local header=";;; ${PN} site-lisp configuration"
327 [[ ${sf} == [0-9][0-9]*-gentoo*.el ]] \
328 || ewarn "elisp-site-file-install: bad name of site-init file"
329 [[ ${sf%-gentoo*.el} != "${sf}" ]] && sf="${sf%-gentoo*.el}-gentoo.el"
330 einfo "Installing site-init file ${sf} for GNU Emacs"
332 [[ $1 = "${sf}" ]] || cp "$1" "${sf}"
333 sed -i -e "1{:x;/^\$/{n;bx;};/^;.*${PN}/I!s:^:${header}\n\n:;1s:^:\n:;}" \
334 -e "s:@SITELISP@:${EPREFIX}${SITELISP}/${my_pn}:g" \
335 -e "s:@SITEETC@:${EPREFIX}${SITEETC}/${my_pn}:g;\$q" "${sf}"
336 ( # subshell to avoid pollution of calling environment
337 insinto "${SITELISP}/site-gentoo.d"
343 # @FUNCTION: elisp-site-regen
345 # Regenerate the site-gentoo.el file, based on packages' site
346 # initialisation files in the /usr/share/emacs/site-lisp/site-gentoo.d/
350 local sitelisp=${ROOT%/}${EPREFIX}${SITELISP}
351 local sf i ret=0 null="" page=$'\f'
354 if [[ ${EBUILD_PHASE} = *rm && ! -e ${sitelisp}/site-gentoo.el ]]; then
355 ewarn "Refusing to create site-gentoo.el in ${EBUILD_PHASE} phase."
359 [[ -d ${sitelisp} ]] \
360 || die "elisp-site-regen: Directory ${sitelisp} does not exist"
363 || die "elisp-site-regen: Temporary directory ${T} does not exist"
365 ebegin "Regenerating site-gentoo.el for GNU Emacs (${EBUILD_PHASE})"
367 for sf in "${sitelisp}"/site-gentoo.d/[0-9][0-9]*.el; do
368 [[ -r ${sf} ]] && sflist+=("${sf}")
371 cat <<-EOF >"${T}"/site-gentoo.el || ret=$?
372 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
375 ;; Automatically generated by elisp-common.eclass
376 ;; DO NOT EDIT THIS FILE
380 # Use sed instead of cat here, since files may miss a trailing newline.
381 sed '$q' "${sflist[@]}" </dev/null >>"${T}"/site-gentoo.el || ret=$?
382 cat <<-EOF >>"${T}"/site-gentoo.el || ret=$?
385 (provide 'site-gentoo)
387 ;; Local ${null}Variables:
388 ;; no-byte-compile: t
389 ;; buffer-read-only: t
392 ;;; site-gentoo.el ends here
395 if [[ ${ret} -ne 0 ]]; then
396 eend ${ret} "elisp-site-regen: Writing site-gentoo.el failed."
398 elif cmp -s "${sitelisp}"/site-gentoo.el "${T}"/site-gentoo.el; then
399 # This prevents outputting unnecessary text when there
400 # was actually no change.
401 # A case is a remerge where we have doubled output.
402 rm -f "${T}"/site-gentoo.el
404 einfo "... no changes."
406 mv "${T}"/site-gentoo.el "${sitelisp}"/site-gentoo.el
407 eend $? "elisp-site-regen: Replacing site-gentoo.el failed" || die
408 case ${#sflist[@]} in
409 0) [[ ${PN} = emacs-common-gentoo ]] \
410 || ewarn "... Huh? No site initialisation files found." ;;
411 1) einfo "... ${#sflist[@]} site initialisation file included." ;;
412 *) einfo "... ${#sflist[@]} site initialisation files included." ;;