eclass/elisp.eclass

   1 # Copyright 1999-2015 Gentoo Foundation
   2 # Distributed under the terms of the GNU General Public License v2
   3 # $Id$
   4 #
   5 # @ECLASS: elisp.eclass
   6 # @MAINTAINER:
   7 # Gentoo GNU Emacs project <gnu-emacs@gentoo.org>
   8 # @AUTHOR:
   9 # Matthew Kennedy <mkennedy@gentoo.org>
  10 # Jeremy Maitin-Shepard <jbms@attbi.com>
  11 # Christian Faulhammer <fauli@gentoo.org>
  12 # Ulrich Müller <ulm@gentoo.org>
  13 # @BLURB: Eclass for Emacs Lisp packages
  14 # @DESCRIPTION:
  15 #
  16 # This eclass is designed to install elisp files of Emacs related
  17 # packages into the site-lisp directory.  The majority of elisp packages
  18 # will only need to define the standard ebuild variables (like SRC_URI)
  19 # and optionally SITEFILE for successful installation.
  20 #
  21 # Emacs support for other than pure elisp packages is handled by
  22 # elisp-common.eclass where you won't have a dependency on Emacs itself.
  23 # All elisp-* functions are documented there.
  24 #
  25 # If the package's source is a single (in whatever way) compressed elisp
  26 # file with the file name ${P}.el, then this eclass will move ${P}.el to
  27 # ${PN}.el in src_unpack().
  28
  29 # @ECLASS-VARIABLE: NEED_EMACS
  30 # @DEFAULT_UNSET
  31 # @DESCRIPTION:
  32 # If you need anything different from Emacs 23, use the NEED_EMACS
  33 # variable before inheriting elisp.eclass.  Set it to the major version
  34 # your package uses and the dependency will be adjusted.
  35
  36 # @ECLASS-VARIABLE: ELISP_PATCHES
  37 # @DEFAULT_UNSET
  38 # @DESCRIPTION:
  39 # Space separated list of patches to apply after unpacking the sources.
  40 # Patch files are searched for in the current working dir, WORKDIR, and
  41 # FILESDIR.
  42
  43 # @ECLASS-VARIABLE: ELISP_REMOVE
  44 # @DEFAULT_UNSET
  45 # @DESCRIPTION:
  46 # Space separated list of files to remove after unpacking the sources.
  47
  48 # @ECLASS-VARIABLE: SITEFILE
  49 # @DEFAULT_UNSET
  50 # @DESCRIPTION:
  51 # Name of package's site-init file.  The filename must match the shell
  52 # pattern "[1-8][0-9]*-gentoo.el"; numbers below 10 and above 89 are
  53 # reserved for internal use.  "50${PN}-gentoo.el" is a reasonable choice
  54 # in most cases.
  55
  56 # @ECLASS-VARIABLE: ELISP_TEXINFO
  57 # @DEFAULT_UNSET
  58 # @DESCRIPTION:
  59 # Space separated list of Texinfo sources.  Respective GNU Info files
  60 # will be generated in src_compile() and installed in src_install().
  61
  62 # @ECLASS-VARIABLE: DOCS
  63 # @DEFAULT_UNSET
  64 # @DESCRIPTION:
  65 # DOCS="blah.txt ChangeLog" is automatically used to install the given
  66 # files by dodoc in src_install().
  67
  68 inherit elisp-common
  69
  70 case ${EAPI:-0} in
  71         0|1)
  72                 inherit eutils
  73                 EXPORT_FUNCTIONS src_{unpack,compile,install} \
  74                         pkg_{setup,postinst,postrm} ;;
  75         2|3|4|5)
  76                 inherit eutils
  77                 EXPORT_FUNCTIONS src_{unpack,prepare,configure,compile,install} \
  78                         pkg_{setup,postinst,postrm} ;;
  79         6)
  80                 EXPORT_FUNCTIONS src_{unpack,prepare,configure,compile,install} \
  81                         pkg_{setup,postinst,postrm} ;;
  82         *) die "${ECLASS}: EAPI ${EAPI} not supported" ;;
  83 esac
  84
  85 DEPEND=">=virtual/emacs-${NEED_EMACS:-23}"
  86 RDEPEND="${DEPEND}"
  87
  88 # @FUNCTION: elisp_pkg_setup
  89 # @DESCRIPTION:
  90 # Test if the eselected Emacs version is sufficient to fulfil the major
  91 # version requirement of the NEED_EMACS variable.
  92
  93 elisp_pkg_setup() {
  94         elisp-need-emacs "${NEED_EMACS:-23}"
  95         case $? in
  96                 0) ;;
  97                 1) die "Emacs version too low" ;;
  98                 *) die "Could not determine Emacs version" ;;
  99         esac
 100 }
 101
 102 # @FUNCTION: elisp_src_unpack
 103 # @DESCRIPTION:
 104 # Unpack the sources; also handle the case of a single *.el file in
 105 # WORKDIR for packages distributed that way.  For EAPIs without
 106 # src_prepare, call elisp_src_prepare.
 107
 108 elisp_src_unpack() {
 109         [[ -n ${A} ]] && unpack ${A}
 110         if [[ -f ${P}.el ]]; then
 111                 # the "simple elisp" case with a single *.el file in WORKDIR
 112                 mv ${P}.el ${PN}.el || die
 113                 [[ -d ${S} ]] || S=${WORKDIR}
 114         fi
 115
 116         case ${EAPI:-0} in
 117                 0|1) [[ -d ${S} ]] && cd "${S}"
 118                         elisp_src_prepare ;;
 119         esac
 120 }
 121
 122 # @FUNCTION: elisp_src_prepare
 123 # @DESCRIPTION:
 124 # Apply any patches listed in ELISP_PATCHES.  Patch files are searched
 125 # for in the current working dir, WORKDIR, and FILESDIR.
 126
 127 elisp_src_prepare() {
 128         local patch file
 129         for patch in ${ELISP_PATCHES}; do
 130                 if [[ -f ${patch} ]]; then
 131                         file="${patch}"
 132                 elif [[ -f ${WORKDIR}/${patch} ]]; then
 133                         file="${WORKDIR}/${patch}"
 134                 elif [[ -f ${FILESDIR}/${patch} ]]; then
 135                         file="${FILESDIR}/${patch}"
 136                 else
 137                         die "Cannot find ${patch}"
 138                 fi
 139                 case ${EAPI:-0} in
 140                         0|1|2|3|4|5) epatch "${file}" ;;
 141                         6) eapply "${file}" ;;
 142                 esac
 143         done
 144
 145         # apply any user patches
 146         case ${EAPI:-0} in
 147                 0|1|2|3|4|5) epatch_user ;;
 148                 6) eapply_user ;;
 149         esac
 150
 151         if [[ -n ${ELISP_REMOVE} ]]; then
 152                 rm ${ELISP_REMOVE} || die
 153         fi
 154 }
 155
 156 # @FUNCTION: elisp_src_configure
 157 # @DESCRIPTION:
 158 # Do nothing, because Emacs packages seldomly bring a full build system.
 159
 160 elisp_src_configure() { :; }
 161
 162 # @FUNCTION: elisp_src_compile
 163 # @DESCRIPTION:
 164 # Call elisp-compile to byte-compile all Emacs Lisp (*.el) files.
 165 # If ELISP_TEXINFO lists any Texinfo sources, call makeinfo to generate
 166 # GNU Info files from them.
 167
 168 elisp_src_compile() {
 169         elisp-compile *.el
 170         if [[ -n ${ELISP_TEXINFO} ]]; then
 171                 makeinfo ${ELISP_TEXINFO} || die
 172         fi
 173 }
 174
 175 # @FUNCTION: elisp_src_install
 176 # @DESCRIPTION:
 177 # Call elisp-install to install all Emacs Lisp (*.el and *.elc) files.
 178 # If the SITEFILE variable specifies a site-init file, install it with
 179 # elisp-site-file-install.  Also install any GNU Info files listed in
 180 # ELISP_TEXINFO and documentation listed in the DOCS variable.
 181
 182 elisp_src_install() {
 183         elisp-install ${PN} *.el *.elc
 184         if [[ -n ${SITEFILE} ]]; then
 185                 elisp-site-file-install "${FILESDIR}/${SITEFILE}"
 186         fi
 187         if [[ -n ${ELISP_TEXINFO} ]]; then
 188                 set -- ${ELISP_TEXINFO}
 189                 set -- ${@##*/}
 190                 doinfo ${@/%.*/.info*} || die
 191         fi
 192         if [[ -n ${DOCS} ]]; then
 193                 dodoc ${DOCS} || die
 194         fi
 195         if declare -f readme.gentoo_create_doc >/dev/null; then
 196                 readme.gentoo_create_doc
 197         fi
 198 }
 199
 200 # @FUNCTION: elisp_pkg_postinst
 201 # @DESCRIPTION:
 202 # Call elisp-site-regen, in order to collect the site initialisation for
 203 # all installed Emacs Lisp packages in the site-gentoo.el file.
 204
 205 elisp_pkg_postinst() {
 206         elisp-site-regen
 207         if declare -f readme.gentoo_print_elog >/dev/null; then
 208                 readme.gentoo_print_elog
 209         fi
 210 }
 211
 212 # @FUNCTION: elisp_pkg_postrm
 213 # @DESCRIPTION:
 214 # Call elisp-site-regen, in order to collect the site initialisation for
 215 # all installed Emacs Lisp packages in the site-gentoo.el file.
 216
 217 elisp_pkg_postrm() {
 218         elisp-site-regen
 219 }