diff options
Diffstat (limited to 'eclass/elisp-common.eclass')
-rw-r--r-- | eclass/elisp-common.eclass | 373 |
1 files changed, 0 insertions, 373 deletions
diff --git a/eclass/elisp-common.eclass b/eclass/elisp-common.eclass deleted file mode 100644 index d505750..0000000 --- a/eclass/elisp-common.eclass +++ /dev/null @@ -1,373 +0,0 @@ -# Copyright 1999-2009 Gentoo Foundation -# Distributed under the terms of the GNU General Public License v2 -# $Header: $ -# -# 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 <fauli@gentoo.org> -# Copyright 2007-2009 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 -# -# 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 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 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! -# -# Best practice is to define a SITEFILE variable in the global scope of -# your ebuild (e.g., right after S or RDEPEND): -# -# SITEFILE="50${PN}-gentoo.el" -# -# Which is then installed by -# -# elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die -# -# 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. -# -# .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" -} - -elisp-comp() { - die "Function elisp-comp is not supported any more, see bug 235442" -} - -# @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. 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="${T}/${sf/%-gentoo*.el/-gentoo.el}" - 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@:${SITELISP}/${my_pn}:g" \ - -e "s:@SITEETC@:${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" -} - -# @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 obsolete - local -a sflist - - if [ ! -d "${ROOT}${SITELISP}" ]; then - eerror "elisp-site-regen: Directory ${SITELISP} does not exist" - return 1 - fi - - if [ ! -d "${T}" ]; then - eerror "elisp-site-regen: Temporary directory ${T} does not exist" - return 1 - fi - - einfon "Regenerating site-gentoo.el for GNU Emacs (${EBUILD_PHASE}) ..." - - # Until January 2009, elisp-common.eclass sometimes created an - # auxiliary file for backwards compatibility. Remove any such file. - 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 >"${T}"/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 >>"${T}"/site-gentoo.el - cat <<-EOF >>"${T}"/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 "${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. - echo " no changes." - else - mv "${T}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el - echo - einfo "... ${#sflist[@]} site initialisation file(s) included." - 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 - fi - - # cleanup - rm -f "${T}"/site-gentoo.el - - return 0 -} |