gentoo-x86/eclass/elisp-common.eclass

# Copyright 1999-2008 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.50 2008/10/16 09:28:58 ulm Exp $
#
# Copyright 2002-2004 Matthew Kennedy <mkennedy@gentoo.org>
# Copyright 2003      Jeremy Maitin-Shepard <jbms@attbi.com>
# Copyright 2004-2005 Mamoru Komachi <usata@gentoo.org>
# Copyright 2007-2008 Christian Faulhammer <opfer@gentoo.org>
# Copyright 2007-2008 Ulrich Müller <ulm@gentoo.org>
#
# @ECLASS: elisp-common.eclass
# @MAINTAINER:
# Feel free to contact the Emacs team through <emacs@gentoo.org> if you have
# problems, suggestions or questions.
# @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
#
#       emacs? ( virtual/emacs )
#
# to your DEPEND/RDEPEND line and use the functions provided here to bring
# the files to the correct locations.
#
# .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.
#
#       elisp-compile *.el || die
#
# Formerly, function elisp-comp() was used for compilation of interdependent
# elisp files.  This usage is considered as obsolete.
#
# 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.
#
# .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}.
#
#       elisp-install ${PN} *.el *.elc || die
#
# 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:
#
#       ;;; csv-mode site-lisp configuration
#
#       (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)
#
# If your Emacs support files are installed in a subdirectory of
# /usr/share/emacs/site-lisp/ (which is recommended), you need to extend
# Emacs' load-path as shown in the first non-comment.
# The elisp-site-file-install() function of this eclass will replace
# "@SITELISP@" by the actual path.
#
# 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 a lot of 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 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 you depend on another Emacs package, your site file's number must be
# higher!
#
# Best practice is to define a SITEFILE variable in the global scope of your
# ebuild (e.g., right after DEPEND):
#
#       SITEFILE=50${PN}-gentoo.el
#
# Which is then installed by
#
#       elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
#
# in src_install().  If your subdirectory is not named ${PN}, give the
# differing name as second argument.
#
# .SS
# pkg_postinst() / pkg_postrm() usage:
#
# After that you need to recreate the start-up file of Emacs after emerging
# and unmerging by using
#
#       pkg_postinst() {
#               elisp-site-regen
#       }
#
#       pkg_postrm() {
#               elisp-site-regen
#       }
#
# 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.
#
# .SS
# Miscellaneous functions:
#
# elisp-emacs-version() outputs the version of the currently active Emacs.

# @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=/usr/bin/emacs

# @ECLASS-VARIABLE: EMACSFLAGS
# @DESCRIPTION:
# Flags for executing Emacs in batch mode.
# These work for Emacs versions 18-23, 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-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"
}

# #FUNCTION: elisp-comp
# #USAGE: <list of elisp files>
# #DESCRIPTION:
# Byte-compile interdependent Emacs Lisp files.
# THIS FUNCTION IS DEPRECATED.
#
# This function byte-compiles all ".el" files which are part of its
# arguments, using GNU Emacs, and puts the resulting ".elc" files into the
# current directory, so disregarding the original directories used in ".el"
# arguments.
#
# This function manages in such a way that all Emacs Lisp files to be
# compiled are made visible between themselves, in the event they require or
# load one another.

elisp-comp() {
        # Copyright 1995 Free Software Foundation, Inc.
        # François Pinard <pinard@iro.umontreal.ca>, 1995.
        # Originally taken from GNU autotools.

        ewarn "Function elisp-comp is deprecated and may be removed in future."
        ewarn "Please use function elisp-compile instead, or report a bug about"
        ewarn "${CATEGORY}/${PF} at <http://bugs.gentoo.org/>."
        echo

        [ $# -gt 0 ] || return 1

        ebegin "Compiling GNU Emacs Elisp files"

        local tempdir=elc.$$
        mkdir ${tempdir}
        cp "$@" ${tempdir}
        pushd ${tempdir}

        echo "(add-to-list 'load-path \"../\")" > script
        ${EMACS} ${EMACSFLAGS} -l script -f batch-byte-compile *.el
        local ret=$?
        mv *.elc ..

        popd
        rm -fr ${tempdir}

        eend ${ret} "elisp-comp: batch-byte-compile failed"
}

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

elisp-emacs-version() {
        # The following will work for at least versions 18-23.
        echo "(princ emacs-version)" >"${T}"/emacs-version.el
        ${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
        rm -f "${T}"/emacs-version.el
}

# @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}"
        shift
        ebegin "Generating autoload file for GNU Emacs"

        sed 's/^FF/\f/' >"${f}" <<-EOF
        ;;; ${f##*/} --- autoloads for ${P}

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

        ;;; Code:
        FF
        ;; Local 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"
}

# @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"
}

# @FUNCTION: elisp-site-file-install
# @USAGE: <site-init file> [subdirectory]
# @DESCRIPTION:
# Install Emacs site-init file in SITELISP directory.

elisp-site-file-install() {
        local sf="${T}/${1##*/}" my_pn="${2:-${PN}}" ret
        ebegin "Installing site initialisation file for GNU Emacs"
        cp "$1" "${sf}"
        sed -i -e "s:@SITELISP@:${SITELISP}/${my_pn}:g" \
                -e "s:@SITEETC@:${SITEETC}/${my_pn}:g" "${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"
}

# @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.
#
# Note: Before December 2007, site initialisation files were installed in
# /usr/share/emacs/site-lisp/.  For backwards compatibility, this location is
# still supported when generating site-gentoo.el.

elisp-site-regen() {
        local i sf line firstrun obsolete
        local -a sflist
        # Work around Paludis borkage: variable T is empty in pkg_postrm
        local tmpdir=${T:-$(mktemp -d)}

        if [ ! -d "${ROOT}${SITELISP}" ]; then
                eerror "elisp-site-regen: Directory ${SITELISP} does not exist"
                return 1
        fi

        [ -e "${ROOT}${SITELISP}"/site-gentoo.el ] || firstrun=t

        if [ "${firstrun}" ] && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then
                einfo "Creating default ${SITELISP}/site-start.el ..."
                cat <<-EOF >"${tmpdir}"/site-start.el
                ;;; site-start.el

                ;;; Commentary:
                ;; This default site startup file is installed by elisp-common.eclass.
                ;; You may replace this file by your own site initialisation, or even
                ;; remove it completely; it will not be recreated.

                ;;; Code:
                ;; Load site initialisation for Gentoo-installed packages.
                (require 'site-gentoo)

                ;;; site-start.el ends here
                EOF
        fi

        einfon "Regenerating ${SITELISP}/site-gentoo.el ..."

        # remove any auxiliary file (from previous run)
        rm -f "${ROOT}${SITELISP}"/00site-gentoo.el

        # set nullglob option, there may be a directory without matching files
        local old_shopts=$(shopt -p nullglob)
        shopt -s nullglob

        for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el \
                "${ROOT}${SITELISP}"/site-gentoo.d/[0-9][0-9]*.el
        do
                [ -r "${sf}" ] || continue
                # sort files by their basename. straight insertion sort.
                for ((i=${#sflist[@]}; i>0; i--)); do
                        [[ ${sf##*/} < ${sflist[i-1]##*/} ]] || break
                        sflist[i]=${sflist[i-1]}
                done
                sflist[i]=${sf}
                # set a flag if there are obsolete files
                [ "${sf%/*}" = "${ROOT}${SITELISP}" ] && obsolete=t
        done

        eval "${old_shopts}"

        cat <<-EOF >"${tmpdir}"/site-gentoo.el
        ;;; 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 >>"${tmpdir}"/site-gentoo.el
        cat <<-EOF >>"${tmpdir}"/site-gentoo.el

        (provide 'site-gentoo)

        ;; Local Variables:
        ;; no-byte-compile: t
        ;; End:
        ;;; site-gentoo.el ends here
        EOF

        if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${tmpdir}"/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.
                echo " no changes."
        else
                mv "${tmpdir}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
                [ -f "${tmpdir}"/site-start.el ] \
                        && [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \
                        && mv "${tmpdir}"/site-start.el "${ROOT}${SITELISP}"/site-start.el
                echo
                einfo "... ${#sflist[@]} site initialisation file(s) included."
        fi

        if [ "${firstrun}" ]; then
                echo
                while read line; do einfo "${line:- }"; done <<-EOF
                All site initialisation for Gentoo-installed packages is added to
                /usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is not
                managed by Gentoo. You are responsible for all maintenance of
                site-start.el if there is such a file.

                In order for this site initialisation to be loaded for all users
                automatically, you can add a line like this:

                (require 'site-gentoo)

                to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
                can be added by individual users to their initialisation files, or,
                for greater flexibility, users can load individual package-specific
                initialisation files from /usr/share/emacs/site-lisp/site-gentoo.d/.
                EOF
                echo
        fi

        if [ "${obsolete}" ]; then
                echo
                while read line; do ewarn "${line}"; done <<-EOF
                Site-initialisation files of Emacs packages are now installed in
                /usr/share/emacs/site-lisp/site-gentoo.d/. We strongly recommend
                that you use app-admin/emacs-updater to rebuild the installed
                Emacs packages.
                EOF

                # Kludge for backwards compatibility: During pkg_postrm, old versions
                # of this eclass (saved in the VDB) won't find packages' site-init
                # files in the new location. So we copy them to an auxiliary file
                # that is visible to old eclass versions.
                for sf in "${sflist[@]}"; do
                        [ "${sf%/*}" = "${ROOT}${SITELISP}/site-gentoo.d" ] \
                                && cat "${sf}" >>"${ROOT}${SITELISP}"/00site-gentoo.el
                done
        fi

        # cleanup
        rm -f "${tmpdir}"/site-{gentoo,start}.el

        return 0
}
1	ulm	1.36	# Copyright 1999-2008 Gentoo Foundation
2	mkennedy	1.1	# Distributed under the terms of the GNU General Public License v2
3	ulm	1.51	# $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.50 2008/10/16 09:28:58 ulm Exp $
4	mkennedy	1.1	#
5	ulm	1.24	# Copyright 2002-2004 Matthew Kennedy <mkennedy@gentoo.org>
6	ulm	1.35	# Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com>
7	ulm	1.24	# Copyright 2004-2005 Mamoru Komachi <usata@gentoo.org>
8	ulm	1.35	# Copyright 2007-2008 Christian Faulhammer <opfer@gentoo.org>
9			# Copyright 2007-2008 Ulrich Müller <ulm@gentoo.org>
10	mkennedy	1.1	#
11	ulm	1.25	# @ECLASS: elisp-common.eclass
12			# @MAINTAINER:
13	ulm	1.29	# Feel free to contact the Emacs team through <emacs@gentoo.org> if you have
14	ulm	1.25	# problems, suggestions or questions.
15			# @BLURB: Emacs-related installation utilities
16			# @DESCRIPTION:
17	opfer	1.15	#
18			# Usually you want to use this eclass for (optional) GNU Emacs support of
19	ulm	1.18	# your package. This is NOT for XEmacs!
20	ulm	1.25	#
21			# Many of the steps here are sometimes done by the build system of your
22	opfer	1.15	# package (especially compilation), so this is mainly for standalone elisp
23			# files you gathered from somewhere else.
24	ulm	1.25	#
25			# When relying on the emacs USE flag, you need to add
26	opfer	1.15	#
27	ulm	1.26	# emacs? ( virtual/emacs )
28	opfer	1.15	#
29			# to your DEPEND/RDEPEND line and use the functions provided here to bring
30			# the files to the correct locations.
31			#
32	ulm	1.25	# .SS
33	opfer	1.15	# src_compile() usage:
34			#
35			# An elisp file is compiled by the elisp-compile() function defined here and
36	ulm	1.43	# simply takes the source files as arguments. The case of interdependent
37			# elisp files is also supported, since the current directory is added to the
38			# load-path which makes sure that all files are loadable.
39	opfer	1.15	#
40	ulm	1.50	# elisp-compile *.el \|\| die
41	ulm	1.25	#
42	ulm	1.43	# Formerly, function elisp-comp() was used for compilation of interdependent
43			# elisp files. This usage is considered as obsolete.
44	opfer	1.15	#
45	ulm	1.25	# Function elisp-make-autoload-file() can be used to generate a file with
46	ulm	1.18	# autoload definitions for the lisp functions. It takes the output file name
47	opfer	1.15	# (default: "${PN}-autoloads.el") and a list of directories (default: working
48	ulm	1.18	# directory) as its arguments. Use of this function requires that the elisp
49	ulm	1.43	# source files contain magic ";;;###autoload" comments. See the Emacs Lisp
50	opfer	1.15	# Reference Manual (node "Autoload") for a detailed explanation.
51			#
52	ulm	1.25	# .SS
53	opfer	1.15	# src_install() usage:
54			#
55			# 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
57			# of elisp-install(). The following parameters are the files to be put in
58			# that directory. Usually the subdirectory should be ${PN}, you can choose
59			# something else, but remember to tell elisp-site-file-install() (see below)
60			# the change, as it defaults to ${PN}.
61			#
62	ulm	1.50	# elisp-install ${PN} .el .elc \|\| die
63	opfer	1.15	#
64	ulm	1.25	# To let the Emacs support be activated by Emacs on startup, you need
65	opfer	1.15	# to provide a site file (shipped in ${FILESDIR}) which contains the startup
66	ulm	1.18	# code (have a look in the documentation of your software). Normally this
67	opfer	1.15	# would look like this:
68			#
69	ulm	1.26	# ;;; csv-mode site-lisp configuration
70	opfer	1.15	#
71	ulm	1.26	# (add-to-list 'load-path "@SITELISP@")
72			# (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode))
73			# (autoload 'csv-mode "csv-mode" "Major mode for csv files." t)
74	opfer	1.15	#
75	ulm	1.25	# If your Emacs support files are installed in a subdirectory of
76	ulm	1.29	# /usr/share/emacs/site-lisp/ (which is recommended), you need to extend
77			# Emacs' load-path as shown in the first non-comment.
78			# The elisp-site-file-install() function of this eclass will replace
79			# "@SITELISP@" by the actual path.
80	ulm	1.25	#
81			# The next line tells Emacs to load the mode opening a file ending with
82	opfer	1.15	# ".csv" and load functions depending on the context and needed features.
83			# Be careful though. Commands as "load-library" or "require" bloat the
84			# editor as they are loaded on every startup. When having a lot of Emacs
85	ulm	1.18	# support files, users may be annoyed by the start-up time. Also avoid
86			# keybindings as they might interfere with the user's settings. Give a hint
87	opfer	1.15	# in pkg_postinst(), which should be enough.
88	ulm	1.25	#
89	ulm	1.50	# 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).
92			# So if you depend on another Emacs package, your site file's number must be
93			# higher!
94	ulm	1.25	#
95			# Best practice is to define a SITEFILE variable in the global scope of your
96	ulm	1.50	# ebuild (e.g., right after DEPEND):
97	opfer	1.15	#
98	ulm	1.26	# SITEFILE=50${PN}-gentoo.el
99	opfer	1.15	#
100	ulm	1.25	# Which is then installed by
101	opfer	1.15	#
102	ulm	1.29	# elisp-site-file-install "${FILESDIR}/${SITEFILE}" \|\| die
103	opfer	1.15	#
104	ulm	1.18	# in src_install(). If your subdirectory is not named ${PN}, give the
105	opfer	1.15	# differing name as second argument.
106			#
107	ulm	1.25	# .SS
108	opfer	1.15	# pkg_postinst() / pkg_postrm() usage:
109			#
110			# After that you need to recreate the start-up file of Emacs after emerging
111			# and unmerging by using
112			#
113	ulm	1.26	# pkg_postinst() {
114			# elisp-site-regen
115			# }
116			#
117			# pkg_postrm() {
118			# elisp-site-regen
119			# }
120	opfer	1.15	#
121	ulm	1.25	# When having optional Emacs support, you should prepend "use emacs &&" to
122	opfer	1.22	# above calls of elisp-site-regen(). Don't use "has_version virtual/emacs"!
123	ulm	1.25	# When unmerging the state of the emacs USE flag is taken from the package
124	opfer	1.22	# database and not from the environment, so it is no problem when you unset
125	ulm	1.25	# USE=emacs between merge and unmerge of a package.
126	opfer	1.22	#
127	ulm	1.25	# .SS
128	opfer	1.22	# Miscellaneous functions:
129			#
130			# elisp-emacs-version() outputs the version of the currently active Emacs.
131	mkennedy	1.1
132	ulm	1.29	# @ECLASS-VARIABLE: SITELISP
133			# @DESCRIPTION:
134	ulm	1.31	# Directory where packages install Emacs Lisp files.
135	mkennedy	1.1	SITELISP=/usr/share/emacs/site-lisp
136	ulm	1.29
137	ulm	1.48	# @ECLASS-VARIABLE: SITEETC
138			# @DESCRIPTION:
139	ulm	1.31	# Directory where packages install miscellaneous (not Lisp) files.
140			SITEETC=/usr/share/emacs/etc
141
142	ulm	1.43	# @ECLASS-VARIABLE: EMACS
143			# @DESCRIPTION:
144			# Path of Emacs executable.
145	ulm	1.28	EMACS=/usr/bin/emacs
146	ulm	1.43
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	ulm	1.30	EMACSFLAGS="-batch -q --no-site-file"
152	ulm	1.25
153	ulm	1.43	# @ECLASS-VARIABLE: BYTECOMPFLAGS
154			# @DESCRIPTION:
155			# Emacs flags used for byte-compilation in elisp-compile().
156			BYTECOMPFLAGS="-L ."
157
158	ulm	1.25	# @FUNCTION: elisp-compile
159			# @USAGE: <list of elisp files>
160			# @DESCRIPTION:
161			# Byte-compile Emacs Lisp files.
162	ulm	1.43	#
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	mkennedy	1.1
171	mkennedy	1.2	elisp-compile() {
172	ulm	1.32	ebegin "Compiling GNU Emacs Elisp files"
173	ulm	1.43	${EMACS} ${EMACSFLAGS} ${BYTECOMPFLAGS} -f batch-byte-compile "$@"
174	ulm	1.49	eend $? "elisp-compile: batch-byte-compile failed"
175	ulm	1.30	}
176
177	ulm	1.44	# #FUNCTION: elisp-comp
178			# #USAGE: <list of elisp files>
179			# #DESCRIPTION:
180	ulm	1.30	# Byte-compile interdependent Emacs Lisp files.
181	ulm	1.46	# THIS FUNCTION IS DEPRECATED.
182	ulm	1.30	#
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	ulm	1.46	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	ulm	1.30	[ $# -gt 0 ] \|\| return 1
203
204	ulm	1.32	ebegin "Compiling GNU Emacs Elisp files"
205	ulm	1.30
206	ulm	1.45	local tempdir=elc.$$
207	ulm	1.30	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	ulm	1.32
219	ulm	1.49	eend ${ret} "elisp-comp: batch-byte-compile failed"
220	opfer	1.22	}
221
222	ulm	1.25	# @FUNCTION: elisp-emacs-version
223			# @DESCRIPTION:
224			# Output version of currently active Emacs.
225
226	opfer	1.22	elisp-emacs-version() {
227	ulm	1.38	# The following will work for at least versions 18-23.
228	opfer	1.22	echo "(princ emacs-version)" >"${T}"/emacs-version.el
229	ulm	1.30	${EMACS} ${EMACSFLAGS} -l "${T}"/emacs-version.el
230	ulm	1.37	rm -f "${T}"/emacs-version.el
231	mkennedy	1.2	}
232
233	ulm	1.25	# @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
238	ulm	1.29	elisp-make-autoload-file() {
239	opfer	1.17	local f="${1:-${PN}-autoloads.el}"
240	opfer	1.15	shift
241	ulm	1.32	ebegin "Generating autoload file for GNU Emacs"
242	opfer	1.22
243	ulm	1.21	sed 's/^FF/\f/' >"${f}" <<-EOF
244			;;; ${f##*/} --- autoloads for ${P}
245
246			;;; Commentary:
247			;; Automatically generated by elisp-common.eclass
248			;; DO NOT EDIT THIS FILE
249
250			;;; Code:
251			FF
252			;; Local Variables:
253			;; version-control: never
254			;; no-byte-compile: t
255			;; no-update-autoloads: t
256			;; End:
257			;;; ${f##*/} ends here
258			EOF
259	opfer	1.22
260	ulm	1.30	${EMACS} ${EMACSFLAGS} \
261	opfer	1.15	--eval "(setq make-backup-files nil)" \
262			--eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
263			-f batch-update-autoloads "${@-.}"
264	ulm	1.32
265	ulm	1.49	eend $? "elisp-make-autoload-file: batch-update-autoloads failed"
266	opfer	1.15	}
267
268	ulm	1.25	# @FUNCTION: elisp-install
269			# @USAGE: <subdirectory> <list of files>
270			# @DESCRIPTION:
271			# Install files in SITELISP directory.
272
273	mkennedy	1.1	elisp-install() {
274	ulm	1.28	local subdir="$1"
275			shift
276	ulm	1.32	ebegin "Installing Elisp files for GNU Emacs support"
277	ulm	1.28	( # subshell to avoid pollution of calling environment
278			insinto "${SITELISP}/${subdir}"
279			doins "$@"
280			)
281	ulm	1.49	eend $? "elisp-install: doins failed"
282	mkennedy	1.1	}
283
284	ulm	1.25	# @FUNCTION: elisp-site-file-install
285			# @USAGE: <site-init file> [subdirectory]
286			# @DESCRIPTION:
287			# Install Emacs site-init file in SITELISP directory.
288
289	mkennedy	1.1	elisp-site-file-install() {
290	ulm	1.37	local sf="${T}/${1##*/}" my_pn="${2:-${PN}}" ret
291	ulm	1.32	ebegin "Installing site initialisation file for GNU Emacs"
292	ulm	1.37	cp "$1" "${sf}"
293	ulm	1.31	sed -i -e "s:@SITELISP@:${SITELISP}/${my_pn}:g" \
294	ulm	1.37	-e "s:@SITEETC@:${SITEETC}/${my_pn}:g" "${sf}"
295	ulm	1.28	( # subshell to avoid pollution of calling environment
296	ulm	1.34	insinto "${SITELISP}/site-gentoo.d"
297	ulm	1.37	doins "${sf}"
298	ulm	1.28	)
299	ulm	1.37	ret=$?
300			rm -f "${sf}"
301	ulm	1.49	eend ${ret} "elisp-site-file-install: doins failed"
302	mkennedy	1.1	}
303
304	ulm	1.25	# @FUNCTION: elisp-site-regen
305			# @DESCRIPTION:
306	ulm	1.48	# 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.
312	ulm	1.32
313	mkennedy	1.1	elisp-site-regen() {
314	ulm	1.47	local i sf line firstrun obsolete
315	ulm	1.32	local -a sflist
316	ulm	1.38	# Work around Paludis borkage: variable T is empty in pkg_postrm
317	ulm	1.39	local tmpdir=${T:-$(mktemp -d)}
318	opfer	1.22
319	ulm	1.38	if [ ! -d "${ROOT}${SITELISP}" ]; then
320	ulm	1.49	eerror "elisp-site-regen: Directory ${SITELISP} does not exist"
321	ulm	1.38	return 1
322			fi
323
324	ulm	1.47	[ -e "${ROOT}${SITELISP}"/site-gentoo.el ] \|\| firstrun=t
325
326			if [ "${firstrun}" ] && [ ! -e "${ROOT}${SITELISP}"/site-start.el ]; then
327	ulm	1.29	einfo "Creating default ${SITELISP}/site-start.el ..."
328	ulm	1.37	cat <<-EOF >"${tmpdir}"/site-start.el
329	ulm	1.29	;;; 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
344	ulm	1.25	einfon "Regenerating ${SITELISP}/site-gentoo.el ..."
345	ulm	1.32
346	ulm	1.41	# remove any auxiliary file (from previous run)
347	ulm	1.32	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	ulm	1.34	# set a flag if there are obsolete files
364			[ "${sf%/*}" = "${ROOT}${SITELISP}" ] && obsolete=t
365	ulm	1.32	done
366
367			eval "${old_shopts}"
368
369	ulm	1.37	cat <<-EOF >"${tmpdir}"/site-gentoo.el
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			sed '$q' "${sflist[@]}" </dev/null >>"${tmpdir}"/site-gentoo.el
380	ulm	1.37	cat <<-EOF >>"${tmpdir}"/site-gentoo.el
381	ulm	1.24
382	ulm	1.28	(provide 'site-gentoo)
383
384			;; Local Variables:
385			;; no-byte-compile: t
386			;; End:
387	ulm	1.24	;;; site-gentoo.el ends here
388			EOF
389
390	ulm	1.37	if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${tmpdir}"/site-gentoo.el
391			then
392	opfer	1.22	# This prevents outputting unnecessary text when there
393	ulm	1.29	# was actually no change.
394			# A case is a remerge where we have doubled output.
395	ulm	1.25	echo " no changes."
396	opfer	1.22	else
397	ulm	1.37	mv "${tmpdir}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
398			[ -f "${tmpdir}"/site-start.el ] \
399	ulm	1.29	&& [ ! -e "${ROOT}${SITELISP}"/site-start.el ] \
400	ulm	1.37	&& mv "${tmpdir}"/site-start.el "${ROOT}${SITELISP}"/site-start.el
401	ulm	1.46	echo
402	ulm	1.47	einfo "... ${#sflist[@]} site initialisation file(s) included."
403			fi
404	ulm	1.32
405	ulm	1.47	if [ "${firstrun}" ]; then
406	ulm	1.32	echo
407	ulm	1.42	while read line; do einfo "${line:- }"; done <<-EOF
408			All site initialisation for Gentoo-installed packages is added to
409			/usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is not
410			managed by Gentoo. You are responsible for all maintenance of
411			site-start.el if there is such a file.
412
413			In order for this site initialisation to be loaded for all users
414			automatically, you can add a line like this:
415
416			(require 'site-gentoo)
417
418			to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
419			can be added by individual users to their initialisation files, or,
420			for greater flexibility, users can load individual package-specific
421			initialisation files from /usr/share/emacs/site-lisp/site-gentoo.d/.
422			EOF
423	opfer	1.22	echo
424	ulm	1.41	fi
425
426			if [ "${obsolete}" ]; then
427	ulm	1.46	echo
428	ulm	1.41	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	ulm	1.46	that you use app-admin/emacs-updater to rebuild the installed
432	ulm	1.41	Emacs packages.
433			EOF
434	ulm	1.35
435	ulm	1.41	# Kludge for backwards compatibility: During pkg_postrm, old versions
436			# of this eclass (saved in the VDB) won't find packages' site-init
437			# files in the new location. So we copy them to an auxiliary file
438			# that is visible to old eclass versions.
439			for sf in "${sflist[@]}"; do
440			[ "${sf%/*}" = "${ROOT}${SITELISP}/site-gentoo.d" ] \
441			&& cat "${sf}" >>"${ROOT}${SITELISP}"/00site-gentoo.el
442			done
443	opfer	1.22	fi
444	ulm	1.32
445	ulm	1.37	# cleanup
446			rm -f "${tmpdir}"/site-{gentoo,start}.el
447	ulm	1.45
448			return 0
449	mkennedy	1.3	}