gentoo-x86/eclass/elisp-common.eclass

# Copyright 1999-2015 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.90 2014/06/11 09:13:36 ulm Exp $
#
# @ECLASS: elisp-common.eclass
# @MAINTAINER:
# Gentoo Emacs team <emacs@gentoo.org>
# @AUTHOR:
# Matthew Kennedy <mkennedy@gentoo.org>
# Jeremy Maitin-Shepard <jbms@attbi.com>
# Mamoru Komachi <usata@gentoo.org>
# Christian Faulhammer <fauli@gentoo.org>
# Ulrich Müller <ulm@gentoo.org>
# @BLURB: Emacs-related installation utilities
# @DESCRIPTION:
#
# Usually you want to use this eclass for (optional) GNU Emacs support
# of your package.  This is NOT for XEmacs!
#
# Many of the steps here are sometimes done by the build system of your
# package (especially compilation), so this is mainly for standalone
# elisp files you gathered from somewhere else.
#
# When relying on the emacs USE flag, you need to add
#
# @CODE
#       emacs? ( virtual/emacs )
# @CODE
#
# to your DEPEND/RDEPEND line and use the functions provided here to
# bring the files to the correct locations.
#
# If your package requires a minimum Emacs version, e.g. Emacs 24, then
# the dependency should be on >=virtual/emacs-24 instead.  Because the
# user can select the Emacs executable with eselect, you should also
# make sure that the active Emacs version is sufficient.  This can be
# tested with function elisp-need-emacs(), which would typically be
# called from pkg_setup(), as in the following example:
#
# @CODE
#       elisp-need-emacs 24 || die "Emacs version too low"
# @CODE
#
# Please note that such tests should be limited to packages that are
# known to fail with lower Emacs versions; the standard case is to
# depend on virtual/emacs without version.
#
# @ROFF .SS
# src_compile() usage:
#
# An elisp file is compiled by the elisp-compile() function defined
# here and simply takes the source files as arguments.  The case of
# interdependent elisp files is also supported, since the current
# directory is added to the load-path which makes sure that all files
# are loadable.
#
# @CODE
#       elisp-compile *.el
# @CODE
#
# Function elisp-make-autoload-file() can be used to generate a file
# with autoload definitions for the lisp functions.  It takes the output
# file name (default: "${PN}-autoloads.el") and a list of directories
# (default: working directory) as its arguments.  Use of this function
# requires that the elisp source files contain magic ";;;###autoload"
# comments.  See the Emacs Lisp Reference Manual (node "Autoload") for
# a detailed explanation.
#
# @ROFF .SS
# src_install() usage:
#
# The resulting compiled files (.elc) should be put in a subdirectory of
# /usr/share/emacs/site-lisp/ which is named after the first argument
# of elisp-install().  The following parameters are the files to be put
# in that directory.  Usually the subdirectory should be ${PN}, you can
# choose something else, but remember to tell elisp-site-file-install()
# (see below) the change, as it defaults to ${PN}.
#
# @CODE
#       elisp-install ${PN} *.el *.elc
# @CODE
#
# To let the Emacs support be activated by Emacs on startup, you need
# to provide a site file (shipped in ${FILESDIR}) which contains the
# startup code (have a look in the documentation of your software).
# Normally this would look like this:
#
# @CODE
#       (add-to-list 'load-path "@SITELISP@")
#       (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode))
#       (autoload 'csv-mode "csv-mode" "Major mode for csv files." t)
# @CODE
#
# If your Emacs support files are installed in a subdirectory of
# /usr/share/emacs/site-lisp/ (which is strongly recommended), you need
# to extend Emacs' load-path as shown in the first non-comment line.
# The elisp-site-file-install() function of this eclass will replace
# "@SITELISP@" and "@SITEETC@" by the actual paths.
#
# The next line tells Emacs to load the mode opening a file ending
# with ".csv" and load functions depending on the context and needed
# features.  Be careful though.  Commands as "load-library" or "require"
# bloat the editor as they are loaded on every startup.  When having
# many Emacs support files, users may be annoyed by the start-up time.
# Also avoid keybindings as they might interfere with the user's
# settings.  Give a hint in pkg_postinst(), which should be enough.
# The guiding principle is that emerging your package should not by
# itself cause a change of standard Emacs behaviour.
#
# The naming scheme for this site-init file matches the shell pattern
# "[1-8][0-9]*-gentoo*.el", where the two digits at the beginning define
# the loading order (numbers below 10 or above 89 are reserved for
# internal use).  So if your initialisation depends on another Emacs
# package, your site file's number must be higher!  If there are no such
# interdependencies then the number should be 50.  Otherwise, numbers
# divisible by 10 are preferred.
#
# Best practice is to define a SITEFILE variable in the global scope of
# your ebuild (e.g., right after S or RDEPEND):
#
# @CODE
#       SITEFILE="50${PN}-gentoo.el"
# @CODE
#
# Which is then installed by
#
# @CODE
#       elisp-site-file-install "${FILESDIR}/${SITEFILE}"
# @CODE
#
# in src_install().  Any characters after the "-gentoo" part and before
# the extension will be stripped from the destination file's name.
# For example, a file "50${PN}-gentoo-${PV}.el" will be installed as
# "50${PN}-gentoo.el".  If your subdirectory is not named ${PN}, give
# the differing name as second argument.
#
# @ROFF .SS
# pkg_postinst() / pkg_postrm() usage:
#
# After that you need to recreate the start-up file of Emacs after
# emerging and unmerging by using
#
# @CODE
#       pkg_postinst() {
#               elisp-site-regen
#       }
#
#       pkg_postrm() {
#               elisp-site-regen
#       }
# @CODE
#
# When having optional Emacs support, you should prepend "use emacs &&"
# to above calls of elisp-site-regen().
# Don't use "has_version virtual/emacs"!  When unmerging the state of
# the emacs USE flag is taken from the package database and not from the
# environment, so it is no problem when you unset USE=emacs between
# merge and unmerge of a package.

# @ECLASS-VARIABLE: SITELISP
# @DESCRIPTION:
# Directory where packages install Emacs Lisp files.
SITELISP=/usr/share/emacs/site-lisp

# @ECLASS-VARIABLE: SITEETC
# @DESCRIPTION:
# Directory where packages install miscellaneous (not Lisp) files.
SITEETC=/usr/share/emacs/etc

# @ECLASS-VARIABLE: EMACS
# @DESCRIPTION:
# Path of Emacs executable.
EMACS=${EPREFIX}/usr/bin/emacs

# @ECLASS-VARIABLE: EMACSFLAGS
# @DESCRIPTION:
# Flags for executing Emacs in batch mode.
# These work for Emacs versions 18-24, so don't change them.
EMACSFLAGS="-batch -q --no-site-file"

# @ECLASS-VARIABLE: BYTECOMPFLAGS
# @DESCRIPTION:
# Emacs flags used for byte-compilation in elisp-compile().
BYTECOMPFLAGS="-L ."

# @FUNCTION: elisp-emacs-version
# @RETURN: exit status of Emacs
# @DESCRIPTION:
# Output version of currently active Emacs.

elisp-emacs-version() {
        local version ret
        # The following will work for at least versions 18-24.
        echo "(princ emacs-version)" >"${T}"/emacs-version.el
        version=$(
                # EMACS could be a microemacs variant that ignores the -batch
                # option and would therefore hang, waiting for user interaction.
                # Redirecting stdin and unsetting TERM and DISPLAY will cause
                # most of them to exit with an error.
                unset TERM DISPLAY
                ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el </dev/null
        )
        ret=$?
        rm -f "${T}"/emacs-version.el
        if [[ ${ret} -ne 0 ]]; then
                eerror "elisp-emacs-version: Failed to run ${EMACS}"
                return ${ret}
        fi
        if [[ -z ${version} ]]; then
                eerror "elisp-emacs-version: Could not determine Emacs version"
                return 1
        fi
        echo "${version}"
}

# @FUNCTION: elisp-need-emacs
# @USAGE: <version>
# @RETURN: 0 if true, 1 if false, 2 if trouble
# @DESCRIPTION:
# Test if the eselected Emacs version is at least the major version
# of GNU Emacs specified as argument.

elisp-need-emacs() {
        local need_emacs=$1 have_emacs
        have_emacs=$(elisp-emacs-version) || return 2
        einfo "Emacs version: ${have_emacs}"
        if [[ ${have_emacs} =~ XEmacs|Lucid ]]; then
                eerror "This package needs GNU Emacs."
                return 1
        fi
        if ! [[ ${have_emacs%%.*} -ge ${need_emacs%%.*} ]]; then
                eerror "This package needs at least Emacs ${need_emacs%%.*}."
                eerror "Use \"eselect emacs\" to select the active version."
                return 1
        fi
        return 0
}

# @FUNCTION: elisp-compile
# @USAGE: <list of elisp files>
# @DESCRIPTION:
# Byte-compile Emacs Lisp files.
#
# This function uses GNU Emacs to byte-compile all ".el" specified by
# its arguments.  The resulting byte-code (".elc") files are placed in
# the same directory as their corresponding source file.
#
# The current directory is added to the load-path.  This will ensure
# that interdependent Emacs Lisp files are visible between themselves,
# in case they require or load one another.

elisp-compile() {
        ebegin "Compiling GNU Emacs Elisp files"
        ${EMACS} ${EMACSFLAGS} ${BYTECOMPFLAGS} -f batch-byte-compile "$@"
        eend $? "elisp-compile: batch-byte-compile failed" || die
}

# @FUNCTION: elisp-make-autoload-file
# @USAGE: [output file] [list of directories]
# @DESCRIPTION:
# Generate a file with autoload definitions for the lisp functions.

elisp-make-autoload-file() {
        local f="${1:-${PN}-autoloads.el}" null="" page=$'\f'
        shift
        ebegin "Generating autoload file for GNU Emacs"

        cat >"${f}" <<-EOF
        ;;; ${f##*/} --- autoloads for ${PN}

        ;;; Commentary:
        ;; Automatically generated by elisp-common.eclass
        ;; DO NOT EDIT THIS FILE

        ;;; Code:
        ${page}
        ;; Local ${null}Variables:
        ;; version-control: never
        ;; no-byte-compile: t
        ;; no-update-autoloads: t
        ;; End:

        ;;; ${f##*/} ends here
        EOF

        ${EMACS} ${EMACSFLAGS} \
                --eval "(setq make-backup-files nil)" \
                --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
                -f batch-update-autoloads "${@-.}"

        eend $? "elisp-make-autoload-file: batch-update-autoloads failed" || die
}

# @FUNCTION: elisp-install
# @USAGE: <subdirectory> <list of files>
# @DESCRIPTION:
# Install files in SITELISP directory.

elisp-install() {
        local subdir="$1"
        shift
        ebegin "Installing Elisp files for GNU Emacs support"
        ( # subshell to avoid pollution of calling environment
                insinto "${SITELISP}/${subdir}"
                doins "$@"
        )
        eend $? "elisp-install: doins failed" || die
}

# @FUNCTION: elisp-site-file-install
# @USAGE: <site-init file> [subdirectory]
# @DESCRIPTION:
# Install Emacs site-init file in SITELISP directory.  Automatically
# inserts a standard comment header with the name of the package (unless
# it is already present).  Tokens @SITELISP@ and @SITEETC@ are replaced
# by the path to the package's subdirectory in SITELISP and SITEETC,
# respectively.

elisp-site-file-install() {
        local sf="${1##*/}" my_pn="${2:-${PN}}" ret
        local header=";;; ${PN} site-lisp configuration"

        [[ ${sf} == [0-9][0-9]*-gentoo*.el ]] \
                || ewarn "elisp-site-file-install: bad name of site-init file"
        [[ ${sf%-gentoo*.el} != "${sf}" ]] && sf="${sf%-gentoo*.el}-gentoo.el"
        sf="${T}/${sf}"
        ebegin "Installing site initialisation file for GNU Emacs"
        [[ $1 = "${sf}" ]] || cp "$1" "${sf}"
        sed -i -e "1{:x;/^\$/{n;bx;};/^;.*${PN}/I!s:^:${header}\n\n:;1s:^:\n:;}" \
                -e "s:@SITELISP@:${EPREFIX}${SITELISP}/${my_pn}:g" \
                -e "s:@SITEETC@:${EPREFIX}${SITEETC}/${my_pn}:g;\$q" "${sf}"
        ( # subshell to avoid pollution of calling environment
                insinto "${SITELISP}/site-gentoo.d"
                doins "${sf}"
        )
        ret=$?
        rm -f "${sf}"
        eend ${ret} "elisp-site-file-install: doins failed" || die
}

# @FUNCTION: elisp-site-regen
# @DESCRIPTION:
# Regenerate the site-gentoo.el file, based on packages' site
# initialisation files in the /usr/share/emacs/site-lisp/site-gentoo.d/
# directory.

elisp-site-regen() {
        local sitelisp=${ROOT}${EPREFIX}${SITELISP}
        local sf i ret=0 null="" page=$'\f'
        local -a sflist

        if [[ ${EBUILD_PHASE} = *rm && ! -e ${sitelisp}/site-gentoo.el ]]; then
                ewarn "Refusing to create site-gentoo.el in ${EBUILD_PHASE} phase."
                return 0
        fi

        [[ -d ${sitelisp} ]] \
                || die "elisp-site-regen: Directory ${sitelisp} does not exist"

        [[ -d ${T} ]] \
                || die "elisp-site-regen: Temporary directory ${T} does not exist"

        ebegin "Regenerating site-gentoo.el for GNU Emacs (${EBUILD_PHASE})"

        for sf in "${sitelisp}"/site-gentoo.d/[0-9][0-9]*.el; do
                [[ -r ${sf} ]] && sflist+=("${sf}")
        done

        cat <<-EOF >"${T}"/site-gentoo.el || ret=$?
        ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages

        ;;; Commentary:
        ;; Automatically generated by elisp-common.eclass
        ;; DO NOT EDIT THIS FILE

        ;;; Code:
        EOF
        # Use sed instead of cat here, since files may miss a trailing newline.
        sed '$q' "${sflist[@]}" </dev/null >>"${T}"/site-gentoo.el || ret=$?
        cat <<-EOF >>"${T}"/site-gentoo.el || ret=$?

        ${page}
        (provide 'site-gentoo)

        ;; Local ${null}Variables:
        ;; no-byte-compile: t
        ;; buffer-read-only: t
        ;; End:

        ;;; site-gentoo.el ends here
        EOF

        if [[ ${ret} -ne 0 ]]; then
                eend ${ret} "elisp-site-regen: Writing site-gentoo.el failed."
                die
        elif cmp -s "${sitelisp}"/site-gentoo.el "${T}"/site-gentoo.el; then
                # This prevents outputting unnecessary text when there
                # was actually no change.
                # A case is a remerge where we have doubled output.
                rm -f "${T}"/site-gentoo.el
                eend
                einfo "... no changes."
        else
                mv "${T}"/site-gentoo.el "${sitelisp}"/site-gentoo.el
                eend $? "elisp-site-regen: Replacing site-gentoo.el failed" || die
                case ${#sflist[@]} in
                        0) [[ ${PN} = emacs-common-gentoo ]] \
                                || ewarn "... Huh? No site initialisation files found." ;;
                        1) einfo "... ${#sflist[@]} site initialisation file included." ;;
                        *) einfo "... ${#sflist[@]} site initialisation files included." ;;
                esac
        fi

        return 0
}
1	ulm	1.91	# Copyright 1999-2015 Gentoo Foundation
2	mkennedy	1.1	# Distributed under the terms of the GNU General Public License v2
3	ulm	1.91	# $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.90 2014/06/11 09:13:36 ulm Exp $
4	mkennedy	1.1	#
5	ulm	1.25	# @ECLASS: elisp-common.eclass
6			# @MAINTAINER:
7	ulm	1.74	# Gentoo Emacs team <emacs@gentoo.org>
8	ulm	1.73	# @AUTHOR:
9			# Matthew Kennedy <mkennedy@gentoo.org>
10			# Jeremy Maitin-Shepard <jbms@attbi.com>
11			# Mamoru Komachi <usata@gentoo.org>
12			# Christian Faulhammer <fauli@gentoo.org>
13			# Ulrich Müller <ulm@gentoo.org>
14	ulm	1.25	# @BLURB: Emacs-related installation utilities
15			# @DESCRIPTION:
16	opfer	1.15	#
17	ulm	1.58	# Usually you want to use this eclass for (optional) GNU Emacs support
18			# of your package. This is NOT for XEmacs!
19	ulm	1.25	#
20			# Many of the steps here are sometimes done by the build system of your
21	ulm	1.58	# package (especially compilation), so this is mainly for standalone
22			# elisp files you gathered from somewhere else.
23	ulm	1.25	#
24			# When relying on the emacs USE flag, you need to add
25	opfer	1.15	#
26	ulm	1.86	# @CODE
27			# emacs? ( virtual/emacs )
28			# @CODE
29	opfer	1.15	#
30	ulm	1.58	# to your DEPEND/RDEPEND line and use the functions provided here to
31			# bring the files to the correct locations.
32	opfer	1.15	#
33	ulm	1.90	# 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	ulm	1.69	# 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:
39			#
40	ulm	1.86	# @CODE
41	ulm	1.90	# elisp-need-emacs 24 \|\| die "Emacs version too low"
42	ulm	1.86	# @CODE
43	ulm	1.69	#
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.
47			#
48	vapier	1.81	# @ROFF .SS
49	opfer	1.15	# src_compile() usage:
50			#
51	ulm	1.58	# 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
55			# are loadable.
56	opfer	1.15	#
57	ulm	1.86	# @CODE
58			# elisp-compile *.el
59			# @CODE
60	ulm	1.25	#
61	ulm	1.58	# 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.
68	opfer	1.15	#
69	vapier	1.81	# @ROFF .SS
70	opfer	1.15	# src_install() usage:
71			#
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	ulm	1.58	# 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}.
78	opfer	1.15	#
79	ulm	1.86	# @CODE
80			# elisp-install ${PN} .el .elc
81			# @CODE
82	opfer	1.15	#
83	ulm	1.25	# To let the Emacs support be activated by Emacs on startup, you need
84	ulm	1.58	# 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:
87	opfer	1.15	#
88	ulm	1.86	# @CODE
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)
92			# @CODE
93	opfer	1.15	#
94	ulm	1.25	# If your Emacs support files are installed in a subdirectory of
95	ulm	1.58	# /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	ulm	1.29	# The elisp-site-file-install() function of this eclass will replace
98	ulm	1.58	# "@SITELISP@" and "@SITEETC@" by the actual paths.
99	ulm	1.25	#
100	ulm	1.58	# 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	ulm	1.76	# The guiding principle is that emerging your package should not by
108			# itself cause a change of standard Emacs behaviour.
109	ulm	1.25	#
110	ulm	1.50	# The naming scheme for this site-init file matches the shell pattern
111	ulm	1.59	# "[1-8][0-9]-gentoo.el", where the two digits at the beginning define
112	ulm	1.58	# the loading order (numbers below 10 or above 89 are reserved for
113			# internal use). So if your initialisation depends on another Emacs
114	ulm	1.68	# 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.
117	ulm	1.25	#
118	ulm	1.58	# Best practice is to define a SITEFILE variable in the global scope of
119			# your ebuild (e.g., right after S or RDEPEND):
120	opfer	1.15	#
121	ulm	1.86	# @CODE
122			# SITEFILE="50${PN}-gentoo.el"
123			# @CODE
124	opfer	1.15	#
125	ulm	1.25	# Which is then installed by
126	opfer	1.15	#
127	ulm	1.86	# @CODE
128			# elisp-site-file-install "${FILESDIR}/${SITEFILE}"
129			# @CODE
130	opfer	1.15	#
131	ulm	1.59	# 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.
136	opfer	1.15	#
137	vapier	1.81	# @ROFF .SS
138	opfer	1.15	# pkg_postinst() / pkg_postrm() usage:
139			#
140	ulm	1.58	# After that you need to recreate the start-up file of Emacs after
141			# emerging and unmerging by using
142	opfer	1.15	#
143	ulm	1.86	# @CODE
144			# pkg_postinst() {
145			# elisp-site-regen
146			# }
147			#
148			# pkg_postrm() {
149			# elisp-site-regen
150			# }
151			# @CODE
152	opfer	1.15	#
153	ulm	1.58	# 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.
159	mkennedy	1.1
160	ulm	1.29	# @ECLASS-VARIABLE: SITELISP
161			# @DESCRIPTION:
162	ulm	1.31	# Directory where packages install Emacs Lisp files.
163	mkennedy	1.1	SITELISP=/usr/share/emacs/site-lisp
164	ulm	1.29
165	ulm	1.48	# @ECLASS-VARIABLE: SITEETC
166			# @DESCRIPTION:
167	ulm	1.31	# Directory where packages install miscellaneous (not Lisp) files.
168			SITEETC=/usr/share/emacs/etc
169
170	ulm	1.43	# @ECLASS-VARIABLE: EMACS
171			# @DESCRIPTION:
172			# Path of Emacs executable.
173	ulm	1.64	EMACS=${EPREFIX}/usr/bin/emacs
174	ulm	1.43
175			# @ECLASS-VARIABLE: EMACSFLAGS
176			# @DESCRIPTION:
177			# Flags for executing Emacs in batch mode.
178	ulm	1.80	# These work for Emacs versions 18-24, so don't change them.
179	ulm	1.30	EMACSFLAGS="-batch -q --no-site-file"
180	ulm	1.25
181	ulm	1.43	# @ECLASS-VARIABLE: BYTECOMPFLAGS
182			# @DESCRIPTION:
183			# Emacs flags used for byte-compilation in elisp-compile().
184			BYTECOMPFLAGS="-L ."
185
186	ulm	1.25	# @FUNCTION: elisp-emacs-version
187	ulm	1.84	# @RETURN: exit status of Emacs
188	ulm	1.25	# @DESCRIPTION:
189			# Output version of currently active Emacs.
190
191	opfer	1.22	elisp-emacs-version() {
192	ulm	1.85	local version ret
193	ulm	1.80	# The following will work for at least versions 18-24.
194	opfer	1.22	echo "(princ emacs-version)" >"${T}"/emacs-version.el
195	ulm	1.85	version=$(
196			# EMACS could be a microemacs variant that ignores the -batch
197			# option and would therefore hang, waiting for user interaction.
198			# Redirecting stdin and unsetting TERM and DISPLAY will cause
199			# most of them to exit with an error.
200			unset TERM DISPLAY
201			${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el </dev/null
202			)
203	ulm	1.72	ret=$?
204	ulm	1.37	rm -f "${T}"/emacs-version.el
205	ulm	1.72	if [[ ${ret} -ne 0 ]]; then
206			eerror "elisp-emacs-version: Failed to run ${EMACS}"
207	ulm	1.85	return ${ret}
208			fi
209			if [[ -z ${version} ]]; then
210			eerror "elisp-emacs-version: Could not determine Emacs version"
211			return 1
212	ulm	1.72	fi
213	ulm	1.85	echo "${version}"
214	mkennedy	1.2	}
215
216	ulm	1.69	# @FUNCTION: elisp-need-emacs
217			# @USAGE: <version>
218	ulm	1.83	# @RETURN: 0 if true, 1 if false, 2 if trouble
219	ulm	1.69	# @DESCRIPTION:
220			# Test if the eselected Emacs version is at least the major version
221	ulm	1.83	# of GNU Emacs specified as argument.
222	ulm	1.69
223			elisp-need-emacs() {
224	ulm	1.72	local need_emacs=$1 have_emacs
225	ulm	1.83	have_emacs=$(elisp-emacs-version) \|\| return 2
226	ulm	1.69	einfo "Emacs version: ${have_emacs}"
227	ulm	1.80	if [[ ${have_emacs} =~ XEmacs\|Lucid ]]; then
228			eerror "This package needs GNU Emacs."
229			return 1
230			fi
231	ulm	1.69	if ! [[ ${have_emacs%%.} -ge ${need_emacs%%.} ]]; then
232			eerror "This package needs at least Emacs ${need_emacs%%.*}."
233			eerror "Use \"eselect emacs\" to select the active version."
234			return 1
235			fi
236			return 0
237			}
238
239	ulm	1.70	# @FUNCTION: elisp-compile
240			# @USAGE: <list of elisp files>
241			# @DESCRIPTION:
242			# Byte-compile Emacs Lisp files.
243			#
244			# This function uses GNU Emacs to byte-compile all ".el" specified by
245			# its arguments. The resulting byte-code (".elc") files are placed in
246			# the same directory as their corresponding source file.
247			#
248			# The current directory is added to the load-path. This will ensure
249			# that interdependent Emacs Lisp files are visible between themselves,
250			# in case they require or load one another.
251
252			elisp-compile() {
253			ebegin "Compiling GNU Emacs Elisp files"
254			${EMACS} ${EMACSFLAGS} ${BYTECOMPFLAGS} -f batch-byte-compile "$@"
255	ulm	1.84	eend $? "elisp-compile: batch-byte-compile failed" \|\| die
256	ulm	1.70	}
257
258	ulm	1.25	# @FUNCTION: elisp-make-autoload-file
259			# @USAGE: [output file] [list of directories]
260			# @DESCRIPTION:
261			# Generate a file with autoload definitions for the lisp functions.
262
263	ulm	1.29	elisp-make-autoload-file() {
264	ulm	1.62	local f="${1:-${PN}-autoloads.el}" null="" page=$'\f'
265	opfer	1.15	shift
266	ulm	1.32	ebegin "Generating autoload file for GNU Emacs"
267	opfer	1.22
268	ulm	1.62	cat >"${f}" <<-EOF
269	ulm	1.67	;;; ${f##*/} --- autoloads for ${PN}
270	ulm	1.21
271			;;; Commentary:
272			;; Automatically generated by elisp-common.eclass
273			;; DO NOT EDIT THIS FILE
274
275			;;; Code:
276	ulm	1.62	${page}
277			;; Local ${null}Variables:
278	ulm	1.21	;; version-control: never
279			;; no-byte-compile: t
280			;; no-update-autoloads: t
281			;; End:
282	ulm	1.62
283	ulm	1.21	;;; ${f##*/} ends here
284			EOF
285	opfer	1.22
286	ulm	1.30	${EMACS} ${EMACSFLAGS} \
287	opfer	1.15	--eval "(setq make-backup-files nil)" \
288			--eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
289			-f batch-update-autoloads "${@-.}"
290	ulm	1.32
291	ulm	1.84	eend $? "elisp-make-autoload-file: batch-update-autoloads failed" \|\| die
292	opfer	1.15	}
293
294	ulm	1.25	# @FUNCTION: elisp-install
295			# @USAGE: <subdirectory> <list of files>
296			# @DESCRIPTION:
297			# Install files in SITELISP directory.
298
299	mkennedy	1.1	elisp-install() {
300	ulm	1.28	local subdir="$1"
301			shift
302	ulm	1.32	ebegin "Installing Elisp files for GNU Emacs support"
303	ulm	1.28	( # subshell to avoid pollution of calling environment
304			insinto "${SITELISP}/${subdir}"
305			doins "$@"
306			)
307	ulm	1.84	eend $? "elisp-install: doins failed" \|\| die
308	mkennedy	1.1	}
309
310	ulm	1.25	# @FUNCTION: elisp-site-file-install
311			# @USAGE: <site-init file> [subdirectory]
312			# @DESCRIPTION:
313	ulm	1.59	# Install Emacs site-init file in SITELISP directory. Automatically
314			# inserts a standard comment header with the name of the package (unless
315			# it is already present). Tokens @SITELISP@ and @SITEETC@ are replaced
316			# by the path to the package's subdirectory in SITELISP and SITEETC,
317			# respectively.
318	ulm	1.25
319	mkennedy	1.1	elisp-site-file-install() {
320	ulm	1.59	local sf="${1##*/}" my_pn="${2:-${PN}}" ret
321			local header=";;; ${PN} site-lisp configuration"
322
323			[[ ${sf} == [0-9][0-9]-gentoo.el ]] \
324			\|\| ewarn "elisp-site-file-install: bad name of site-init file"
325	ulm	1.91	[[ ${sf%-gentoo.el} != "${sf}" ]] && sf="${sf%-gentoo.el}-gentoo.el"
326			sf="${T}/${sf}"
327	ulm	1.32	ebegin "Installing site initialisation file for GNU Emacs"
328	ulm	1.71	[[ $1 = "${sf}" ]] \|\| cp "$1" "${sf}"
329	ulm	1.59	sed -i -e "1{:x;/^\$/{n;bx;};/^;.*${PN}/I!s:^:${header}\n\n:;1s:^:\n:;}" \
330	ulm	1.64	-e "s:@SITELISP@:${EPREFIX}${SITELISP}/${my_pn}:g" \
331			-e "s:@SITEETC@:${EPREFIX}${SITEETC}/${my_pn}:g;\$q" "${sf}"
332	ulm	1.28	( # subshell to avoid pollution of calling environment
333	ulm	1.34	insinto "${SITELISP}/site-gentoo.d"
334	ulm	1.37	doins "${sf}"
335	ulm	1.28	)
336	ulm	1.37	ret=$?
337			rm -f "${sf}"
338	ulm	1.84	eend ${ret} "elisp-site-file-install: doins failed" \|\| die
339	mkennedy	1.1	}
340
341	ulm	1.25	# @FUNCTION: elisp-site-regen
342			# @DESCRIPTION:
343	ulm	1.58	# Regenerate the site-gentoo.el file, based on packages' site
344			# initialisation files in the /usr/share/emacs/site-lisp/site-gentoo.d/
345			# directory.
346	ulm	1.32
347	mkennedy	1.1	elisp-site-regen() {
348	ulm	1.64	local sitelisp=${ROOT}${EPREFIX}${SITELISP}
349	ulm	1.89	local sf i ret=0 null="" page=$'\f'
350	ulm	1.32	local -a sflist
351	opfer	1.22
352	ulm	1.87	if [[ ${EBUILD_PHASE} = *rm && ! -e ${sitelisp}/site-gentoo.el ]]; then
353			ewarn "Refusing to create site-gentoo.el in ${EBUILD_PHASE} phase."
354			return 0
355			fi
356
357	ulm	1.89	[[ -d ${sitelisp} ]] \
358			\|\| die "elisp-site-regen: Directory ${sitelisp} does not exist"
359
360			[[ -d ${T} ]] \
361			\|\| die "elisp-site-regen: Temporary directory ${T} does not exist"
362
363	ulm	1.78	ebegin "Regenerating site-gentoo.el for GNU Emacs (${EBUILD_PHASE})"
364	ulm	1.32
365	ulm	1.88	for sf in "${sitelisp}"/site-gentoo.d/[0-9][0-9]*.el; do
366			[[ -r ${sf} ]] && sflist+=("${sf}")
367	ulm	1.32	done
368
369	ulm	1.89	cat <<-EOF >"${T}"/site-gentoo.el \|\| ret=$?
370	ulm	1.24	;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
371
372			;;; Commentary:
373			;; Automatically generated by elisp-common.eclass
374			;; DO NOT EDIT THIS FILE
375
376			;;; Code:
377			EOF
378	ulm	1.50	# Use sed instead of cat here, since files may miss a trailing newline.
379	ulm	1.89	sed '$q' "${sflist[@]}" </dev/null >>"${T}"/site-gentoo.el \|\| ret=$?
380			cat <<-EOF >>"${T}"/site-gentoo.el \|\| ret=$?
381	ulm	1.24
382	ulm	1.70	${page}
383	ulm	1.28	(provide 'site-gentoo)
384
385	ulm	1.62	;; Local ${null}Variables:
386	ulm	1.28	;; no-byte-compile: t
387	ulm	1.62	;; buffer-read-only: t
388	ulm	1.28	;; End:
389	ulm	1.62
390	ulm	1.24	;;; site-gentoo.el ends here
391			EOF
392
393	ulm	1.89	if [[ ${ret} -ne 0 ]]; then
394			eend ${ret} "elisp-site-regen: Writing site-gentoo.el failed."
395			die
396			elif cmp -s "${sitelisp}"/site-gentoo.el "${T}"/site-gentoo.el; then
397	opfer	1.22	# This prevents outputting unnecessary text when there
398	ulm	1.29	# was actually no change.
399			# A case is a remerge where we have doubled output.
400	ulm	1.66	rm -f "${T}"/site-gentoo.el
401	ulm	1.78	eend
402	ulm	1.77	einfo "... no changes."
403	opfer	1.22	else
404	ulm	1.64	mv "${T}"/site-gentoo.el "${sitelisp}"/site-gentoo.el
405	ulm	1.89	eend $? "elisp-site-regen: Replacing site-gentoo.el failed" \|\| die
406	ulm	1.63	case ${#sflist[@]} in
407	ulm	1.82	0) [[ ${PN} = emacs-common-gentoo ]] \
408			\|\| ewarn "... Huh? No site initialisation files found." ;;
409	ulm	1.63	1) einfo "... ${#sflist[@]} site initialisation file included." ;;
410			*) einfo "... ${#sflist[@]} site initialisation files included." ;;
411			esac
412	ulm	1.47	fi
413	ulm	1.32
414	ulm	1.45	return 0
415	mkennedy	1.3	}