eclass/elisp.eclass

   1 # Copyright 2002-2020 Gentoo Authors
   2 # Distributed under the terms of the GNU General Public License v2
   3
   4 # @ECLASS: elisp.eclass
   5 # @MAINTAINER:
   6 # Gentoo GNU Emacs project <gnu-emacs@gentoo.org>
   7 # @AUTHOR:
   8 # Matthew Kennedy <mkennedy@gentoo.org>
   9 # Jeremy Maitin-Shepard <jbms@attbi.com>
  10 # Christian Faulhammer <fauli@gentoo.org>
  11 # Ulrich Müller <ulm@gentoo.org>
  12 # @SUPPORTED_EAPIS: 4 5 6 7
  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 version your
  34 # 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.  This variable is semi-deprecated, preferably use the
  42 # PATCHES array instead if the EAPI supports it.
  43
  44 # @ECLASS-VARIABLE: ELISP_REMOVE
  45 # @DEFAULT_UNSET
  46 # @DESCRIPTION:
  47 # Space separated list of files to remove after unpacking the sources.
  48
  49 # @ECLASS-VARIABLE: SITEFILE
  50 # @DEFAULT_UNSET
  51 # @DESCRIPTION:
  52 # Name of package's site-init file.  The filename must match the shell
  53 # pattern "[1-8][0-9]*-gentoo.el"; numbers below 10 and above 89 are
  54 # reserved for internal use.  "50${PN}-gentoo.el" is a reasonable choice
  55 # in most cases.
  56
  57 # @ECLASS-VARIABLE: ELISP_TEXINFO
  58 # @DEFAULT_UNSET
  59 # @DESCRIPTION:
  60 # Space separated list of Texinfo sources.  Respective GNU Info files
  61 # will be generated in src_compile() and installed in src_install().
  62
  63 inherit elisp-common
  64 case ${EAPI:-0} in
  65         4|5) inherit epatch ;;
  66         6|7) ;;
  67         *) die "${ECLASS}: EAPI ${EAPI:-0} not supported" ;;
  68 esac
  69
  70 EXPORT_FUNCTIONS src_{unpack,prepare,configure,compile,install} \
  71         pkg_{setup,postinst,postrm}
  72
  73 RDEPEND=">=app-editors/emacs-${NEED_EMACS}:*"
  74 case ${EAPI} in
  75         4) RDEPEND="${RDEPEND%:*}"; DEPEND="${RDEPEND}" ;;
  76         5|6) DEPEND="${RDEPEND}" ;;
  77         *) BDEPEND="${RDEPEND}" ;;
  78 esac
  79
  80 # @FUNCTION: elisp_pkg_setup
  81 # @DESCRIPTION:
  82 # Test if the eselected Emacs version is sufficient to fulfil the
  83 # version requirement of the NEED_EMACS variable.
  84
  85 elisp_pkg_setup() {
  86         elisp-check-emacs-version
  87 }
  88
  89 # @FUNCTION: elisp_src_unpack
  90 # @DESCRIPTION:
  91 # Unpack the sources; also handle the case of a single *.el file in
  92 # WORKDIR for packages distributed that way.
  93
  94 elisp_src_unpack() {
  95         default
  96         if [[ -f ${P}.el ]]; then
  97                 # the "simple elisp" case with a single *.el file in WORKDIR
  98                 mv ${P}.el ${PN}.el || die
  99                 [[ -d ${S} ]] || S=${WORKDIR}
 100         fi
 101 }
 102
 103 # @FUNCTION: elisp_src_prepare
 104 # @DESCRIPTION:
 105 # Apply any patches listed in ELISP_PATCHES.  Patch files are searched
 106 # for in the current working dir, WORKDIR, and FILESDIR.
 107
 108 elisp_src_prepare() {
 109         local patch file
 110         for patch in ${ELISP_PATCHES}; do
 111                 if [[ -f ${patch} ]]; then
 112                         file="${patch}"
 113                 elif [[ -f ${WORKDIR}/${patch} ]]; then
 114                         file="${WORKDIR}/${patch}"
 115                 elif [[ -f ${FILESDIR}/${patch} ]]; then
 116                         file="${FILESDIR}/${patch}"
 117                 else
 118                         die "Cannot find ${patch}"
 119                 fi
 120                 case ${EAPI} in
 121                         4|5) epatch "${file}" ;;
 122                         *) eapply "${file}" ;;
 123                 esac
 124         done
 125
 126         # apply PATCHES (if supported in EAPI), and any user patches
 127         case ${EAPI} in
 128                 4|5) epatch_user ;;
 129                 *) default ;;
 130         esac
 131
 132         if [[ -n ${ELISP_REMOVE} ]]; then
 133                 rm ${ELISP_REMOVE} || die
 134         fi
 135 }
 136
 137 # @FUNCTION: elisp_src_configure
 138 # @DESCRIPTION:
 139 # Do nothing, because Emacs packages seldomly bring a full build system.
 140
 141 elisp_src_configure() { :; }
 142
 143 # @FUNCTION: elisp_src_compile
 144 # @DESCRIPTION:
 145 # Call elisp-compile to byte-compile all Emacs Lisp (*.el) files.
 146 # If ELISP_TEXINFO lists any Texinfo sources, call makeinfo to generate
 147 # GNU Info files from them.
 148
 149 elisp_src_compile() {
 150         elisp-compile *.el
 151         if [[ -n ${ELISP_TEXINFO} ]]; then
 152                 makeinfo ${ELISP_TEXINFO} || die
 153         fi
 154 }
 155
 156 # @FUNCTION: elisp_src_install
 157 # @DESCRIPTION:
 158 # Call elisp-install to install all Emacs Lisp (*.el and *.elc) files.
 159 # If the SITEFILE variable specifies a site-init file, install it with
 160 # elisp-site-file-install.  Also install any GNU Info files listed in
 161 # ELISP_TEXINFO and documentation listed in the DOCS variable.
 162
 163 elisp_src_install() {
 164         elisp-install ${PN} *.el *.elc
 165         if [[ -n ${SITEFILE} ]]; then
 166                 elisp-site-file-install "${FILESDIR}/${SITEFILE}"
 167         fi
 168         if [[ -n ${ELISP_TEXINFO} ]]; then
 169                 set -- ${ELISP_TEXINFO}
 170                 set -- ${@##*/}
 171                 doinfo ${@/%.*/.info*}
 172         fi
 173         # install documentation only when explicitly requested
 174         case ${EAPI} in
 175                 4|5) [[ -n ${DOCS} ]] && dodoc ${DOCS} ;;
 176                 *) [[ $(declare -p DOCS 2>/dev/null) == *=* ]] && einstalldocs ;;
 177         esac
 178         if declare -f readme.gentoo_create_doc >/dev/null; then
 179                 readme.gentoo_create_doc
 180         fi
 181 }
 182
 183 # @FUNCTION: elisp_pkg_postinst
 184 # @DESCRIPTION:
 185 # Call elisp-site-regen, in order to collect the site initialisation for
 186 # all installed Emacs Lisp packages in the site-gentoo.el file.
 187
 188 elisp_pkg_postinst() {
 189         elisp-site-regen
 190         if declare -f readme.gentoo_print_elog >/dev/null; then
 191                 readme.gentoo_print_elog
 192         fi
 193 }
 194
 195 # @FUNCTION: elisp_pkg_postrm
 196 # @DESCRIPTION:
 197 # Call elisp-site-regen, in order to collect the site initialisation for
 198 # all installed Emacs Lisp packages in the site-gentoo.el file.
 199
 200 elisp_pkg_postrm() {
 201         elisp-site-regen
 202 }