/[gentoo-x86]/eclass/elisp.eclass
Gentoo

Diff of /eclass/elisp.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.22 Revision 1.53
1# Copyright 1999-2007 Gentoo Foundation 1# Copyright 1999-2011 Gentoo Foundation
2# Distributed under the terms of the GNU General Public License v2 2# Distributed under the terms of the GNU General Public License v2
3# $Header: /var/cvsroot/gentoo-x86/eclass/elisp.eclass,v 1.22 2007/08/27 19:41:03 ulm Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/elisp.eclass,v 1.53 2011/10/21 19:16:16 ulm Exp $
4#
5# Copyright 2007 Christian Faulhammer <opfer@gentoo.org>
6# Copyright 2002-2003 Matthew Kennedy <mkennedy@gentoo.org>
7# Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com>
8# Copyright 2007 Ulrich Mueller <ulm@gentoo.org>
9# 4#
10# @ECLASS: elisp.eclass 5# @ECLASS: elisp.eclass
11# @MAINTAINER: 6# @MAINTAINER:
12# emacs@gentoo.org 7# Gentoo Emacs team <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 13# @BLURB: Eclass for Emacs Lisp packages
14# @DESCRIPTION: 14# @DESCRIPTION:
15# 15#
16# This eclass sets the site-lisp directory for Emacs-related packages. 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.
17# 20#
18# Emacs support for other than pure elisp packages is handled by 21# Emacs support for other than pure elisp packages is handled by
19# elisp-common.eclass where you won't have a dependency on Emacs itself. 22# elisp-common.eclass where you won't have a dependency on Emacs itself.
20# All elisp-* functions are documented there. 23# All elisp-* functions are documented there.
21# 24#
22# Setting SIMPLE_ELISP=t in an ebuild means, that the package's source 25# If the package's source is a single (in whatever way) compressed elisp
23# is a single (in whatever way) compressed elisp file with the file name 26# file with the file name ${P}.el, then this eclass will move ${P}.el to
24# ${PN}-${PV}. This eclass will then redefine ${S}, and move
25# ${PN}-${PV}.el to ${PN}.el in src_unpack(). 27# ${PN}.el in src_unpack().
26# 28
27# DOCS="blah.txt ChangeLog" is automatically used to install the given 29# @ECLASS-VARIABLE: NEED_EMACS
28# files by dodoc in src_install(). 30# @DEFAULT_UNSET
29# 31# @DESCRIPTION:
30# If you need anything different from Emacs 21, use the NEED_EMACS 32# If you need anything different from Emacs 21, use the NEED_EMACS
31# variable before inheriting elisp.eclass. Set it to the major version 33# variable before inheriting elisp.eclass. Set it to the major version
32# your package uses and the dependency will be adjusted. 34# your package uses and the dependency will be adjusted.
33 35
34inherit elisp-common versionator 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.
35 42
36VERSION=${NEED_EMACS:-21} 43# @ECLASS-VARIABLE: SITEFILE
44# @DEFAULT_UNSET
45# @DESCRIPTION:
46# Name of package's site-init file. The filename must match the shell
47# pattern "[1-8][0-9]*-gentoo.el"; numbers below 10 and above 89 are
48# reserved for internal use. "50${PN}-gentoo.el" is a reasonable choice
49# in most cases.
50
51# @ECLASS-VARIABLE: ELISP_TEXINFO
52# @DEFAULT_UNSET
53# @DESCRIPTION:
54# Space separated list of Texinfo sources. Respective GNU Info files
55# will be generated in src_compile() and installed in src_install().
56
57# @ECLASS-VARIABLE: DOCS
58# @DEFAULT_UNSET
59# @DESCRIPTION:
60# DOCS="blah.txt ChangeLog" is automatically used to install the given
61# files by dodoc in src_install().
62
63inherit elisp-common eutils
64
65case "${EAPI:-0}" in
66 0|1) EXPORT_FUNCTIONS src_{unpack,compile,install} \
67 pkg_{setup,postinst,postrm} ;;
68 *) EXPORT_FUNCTIONS src_{unpack,prepare,configure,compile,install} \
69 pkg_{setup,postinst,postrm} ;;
70esac
71
37DEPEND=">=virtual/emacs-${VERSION}" 72DEPEND=">=virtual/emacs-${NEED_EMACS:-21}"
38RDEPEND=">=virtual/emacs-${VERSION}" 73RDEPEND="${DEPEND}"
39IUSE="" 74IUSE=""
40 75
41if [ "${SIMPLE_ELISP}" = 't' ]; then 76# @FUNCTION: elisp_pkg_setup
42 S="${WORKDIR}" 77# @DESCRIPTION:
43fi 78# Test if the eselected Emacs version is sufficient to fulfil the major
79# version requirement of the NEED_EMACS variable.
44 80
45elisp_pkg_setup() { 81elisp_pkg_setup() {
46 local emacs_version="$(elisp-emacs-version)" 82 elisp-need-emacs "${NEED_EMACS:-21}" || die "Emacs version too low"
47 if ! version_is_at_least "${VERSION}" "${emacs_version}"; then 83}
48 eerror "This package needs at least Emacs ${VERSION}." 84
49 eerror "Use \"eselect emacs\" to select the active version." 85# @FUNCTION: elisp_src_unpack
50 die "Emacs version ${emacs_version} is too low." 86# @DESCRIPTION:
87# Unpack the sources; also handle the case of a single *.el file in
88# WORKDIR for packages distributed that way. For EAPIs without
89# src_prepare, call elisp_src_prepare.
90
91elisp_src_unpack() {
92 [[ -n ${A} ]] && unpack ${A}
93 if [[ -f ${P}.el ]]; then
94 # the "simple elisp" case with a single *.el file in WORKDIR
95 mv ${P}.el ${PN}.el || die
96 [[ -d ${S} ]] || S=${WORKDIR}
97 fi
98
99 case "${EAPI:-0}" in
100 0|1) [[ -d ${S} ]] && cd "${S}"
101 elisp_src_prepare ;;
102 esac
103}
104
105# @FUNCTION: elisp_src_prepare
106# @DESCRIPTION:
107# Apply any patches listed in ELISP_PATCHES. Patch files are searched
108# for in the current working dir, WORKDIR, and FILESDIR.
109
110elisp_src_prepare() {
111 local patch
112 for patch in ${ELISP_PATCHES}; do
113 if [[ -f ${patch} ]]; then
114 epatch "${patch}"
115 elif [[ -f ${WORKDIR}/${patch} ]]; then
116 epatch "${WORKDIR}/${patch}"
117 elif [[ -f ${FILESDIR}/${patch} ]]; then
118 epatch "${FILESDIR}/${patch}"
119 else
120 die "Cannot find ${patch}"
121 fi
122 done
123}
124
125# @FUNCTION: elisp_src_configure
126# @DESCRIPTION:
127# Do nothing, because Emacs packages seldomly bring a full build system.
128
129elisp_src_configure() { :; }
130
131# @FUNCTION: elisp_src_compile
132# @DESCRIPTION:
133# Call elisp-compile to byte-compile all Emacs Lisp (*.el) files.
134# If ELISP_TEXINFO lists any Texinfo sources, call makeinfo to generate
135# GNU Info files from them.
136
137elisp_src_compile() {
138 elisp-compile *.el || die
139 if [[ -n ${ELISP_TEXINFO} ]]; then
140 makeinfo ${ELISP_TEXINFO} || die
51 fi 141 fi
52} 142}
53 143
144# @FUNCTION: elisp_src_install
145# @DESCRIPTION:
146# Call elisp-install to install all Emacs Lisp (*.el and *.elc) files.
147# If the SITEFILE variable specifies a site-init file, install it with
148# elisp-site-file-install. Also install any GNU Info files listed in
149# ELISP_TEXINFO and documentation listed in the DOCS variable.
150
54elisp_src_unpack() { 151elisp_src_install() {
55 unpack ${A} 152 elisp-install ${PN} *.el *.elc || die
56 if [ "${SIMPLE_ELISP}" = 't' ]; then 153 if [[ -n ${SITEFILE} ]]; then
57 cd "${S}" && mv ${P}.el ${PN}.el 154 elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
155 fi
156 if [[ -n ${ELISP_TEXINFO} ]]; then
157 set -- ${ELISP_TEXINFO}
158 set -- ${@##*/}
159 doinfo ${@/%.*/.info*} || die
160 fi
161 if [[ -n ${DOCS} ]]; then
162 dodoc ${DOCS} || die
58 fi 163 fi
59} 164}
60 165
61elisp_src_compile() { 166# @FUNCTION: elisp_pkg_postinst
62 elisp-compile *.el || die "elisp-compile failed" 167# @DESCRIPTION:
63} 168# Call elisp-site-regen, in order to collect the site initialisation for
64 169# all installed Emacs Lisp packages in the site-gentoo.el file.
65elisp_src_install() {
66 elisp-install ${PN} *.el *.elc
67 elisp-site-file-install "${FILESDIR}/${SITEFILE}"
68 if [ -n "${DOCS}" ]; then
69 dodoc ${DOCS} || die "dodoc failed"
70 fi
71}
72 170
73elisp_pkg_postinst() { 171elisp_pkg_postinst() {
74 elisp-site-regen 172 elisp-site-regen
75} 173}
76 174
175# @FUNCTION: elisp_pkg_postrm
176# @DESCRIPTION:
177# Call elisp-site-regen, in order to collect the site initialisation for
178# all installed Emacs Lisp packages in the site-gentoo.el file.
179
77elisp_pkg_postrm() { 180elisp_pkg_postrm() {
78 elisp-site-regen 181 elisp-site-regen
79} 182}
80
81EXPORT_FUNCTIONS src_unpack src_compile src_install
82EXPORT_FUNCTIONS pkg_setup pkg_postinst pkg_postrm

Legend:
Removed from v.1.22  
changed lines
  Added in v.1.53

  ViewVC Help
Powered by ViewVC 1.1.20