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.54 2011/12/03 08:54:46 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 | |
34 | inherit 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 | |
36 | VERSION=${NEED_EMACS:-21} |
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 eutils |
|
|
69 | |
|
|
70 | case "${EAPI:-0}" in |
|
|
71 | 0|1) EXPORT_FUNCTIONS src_{unpack,compile,install} \ |
|
|
72 | pkg_{setup,postinst,postrm} ;; |
|
|
73 | *) EXPORT_FUNCTIONS src_{unpack,prepare,configure,compile,install} \ |
|
|
74 | pkg_{setup,postinst,postrm} ;; |
|
|
75 | esac |
|
|
76 | |
37 | DEPEND=">=virtual/emacs-${VERSION}" |
77 | DEPEND=">=virtual/emacs-${NEED_EMACS:-21}" |
38 | RDEPEND=">=virtual/emacs-${VERSION}" |
78 | RDEPEND="${DEPEND}" |
39 | IUSE="" |
79 | IUSE="" |
40 | |
80 | |
41 | if [ "${SIMPLE_ELISP}" = 't' ]; then |
81 | # @FUNCTION: elisp_pkg_setup |
42 | S="${WORKDIR}" |
82 | # @DESCRIPTION: |
43 | fi |
83 | # Test if the eselected Emacs version is sufficient to fulfil the major |
|
|
84 | # version requirement of the NEED_EMACS variable. |
44 | |
85 | |
45 | elisp_pkg_setup() { |
86 | elisp_pkg_setup() { |
46 | local emacs_version="$(elisp-emacs-version)" |
87 | elisp-need-emacs "${NEED_EMACS:-21}" || die "Emacs version too low" |
47 | if ! version_is_at_least "${VERSION}" "${emacs_version}"; then |
88 | } |
48 | eerror "This package needs at least Emacs ${VERSION}." |
89 | |
49 | eerror "Use \"eselect emacs\" to select the active version." |
90 | # @FUNCTION: elisp_src_unpack |
50 | die "Emacs version ${emacs_version} is too low." |
91 | # @DESCRIPTION: |
|
|
92 | # Unpack the sources; also handle the case of a single *.el file in |
|
|
93 | # WORKDIR for packages distributed that way. For EAPIs without |
|
|
94 | # src_prepare, call elisp_src_prepare. |
|
|
95 | |
|
|
96 | elisp_src_unpack() { |
|
|
97 | [[ -n ${A} ]] && unpack ${A} |
|
|
98 | if [[ -f ${P}.el ]]; then |
|
|
99 | # the "simple elisp" case with a single *.el file in WORKDIR |
|
|
100 | mv ${P}.el ${PN}.el || die |
|
|
101 | [[ -d ${S} ]] || S=${WORKDIR} |
|
|
102 | fi |
|
|
103 | |
|
|
104 | case "${EAPI:-0}" in |
|
|
105 | 0|1) [[ -d ${S} ]] && cd "${S}" |
|
|
106 | elisp_src_prepare ;; |
|
|
107 | esac |
|
|
108 | } |
|
|
109 | |
|
|
110 | # @FUNCTION: elisp_src_prepare |
|
|
111 | # @DESCRIPTION: |
|
|
112 | # Apply any patches listed in ELISP_PATCHES. Patch files are searched |
|
|
113 | # for in the current working dir, WORKDIR, and FILESDIR. |
|
|
114 | |
|
|
115 | elisp_src_prepare() { |
|
|
116 | local patch |
|
|
117 | for patch in ${ELISP_PATCHES}; do |
|
|
118 | if [[ -f ${patch} ]]; then |
|
|
119 | epatch "${patch}" |
|
|
120 | elif [[ -f ${WORKDIR}/${patch} ]]; then |
|
|
121 | epatch "${WORKDIR}/${patch}" |
|
|
122 | elif [[ -f ${FILESDIR}/${patch} ]]; then |
|
|
123 | epatch "${FILESDIR}/${patch}" |
|
|
124 | else |
|
|
125 | die "Cannot find ${patch}" |
|
|
126 | fi |
|
|
127 | done |
|
|
128 | |
|
|
129 | # apply any user patches |
|
|
130 | epatch_user |
|
|
131 | |
|
|
132 | if [[ -n ${ELISP_REMOVE} ]]; then |
|
|
133 | rm ${ELISP_REMOVE} || die |
51 | fi |
134 | fi |
52 | } |
135 | } |
53 | |
136 | |
54 | elisp_src_unpack() { |
137 | # @FUNCTION: elisp_src_configure |
55 | unpack ${A} |
138 | # @DESCRIPTION: |
56 | if [ "${SIMPLE_ELISP}" = 't' ]; then |
139 | # Do nothing, because Emacs packages seldomly bring a full build system. |
57 | cd "${S}" && mv ${P}.el ${PN}.el |
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 || die |
|
|
151 | if [[ -n ${ELISP_TEXINFO} ]]; then |
|
|
152 | makeinfo ${ELISP_TEXINFO} || die |
58 | fi |
153 | fi |
59 | } |
154 | } |
60 | |
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 | |
61 | elisp_src_compile() { |
163 | elisp_src_install() { |
62 | elisp-compile *.el || die "elisp-compile failed" |
164 | elisp-install ${PN} *.el *.elc || die |
|
|
165 | if [[ -n ${SITEFILE} ]]; then |
|
|
166 | elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die |
|
|
167 | fi |
|
|
168 | if [[ -n ${ELISP_TEXINFO} ]]; then |
|
|
169 | set -- ${ELISP_TEXINFO} |
|
|
170 | set -- ${@##*/} |
|
|
171 | doinfo ${@/%.*/.info*} || die |
|
|
172 | fi |
|
|
173 | if [[ -n ${DOCS} ]]; then |
|
|
174 | dodoc ${DOCS} || die |
|
|
175 | fi |
63 | } |
176 | } |
64 | |
177 | |
65 | elisp_src_install() { |
178 | # @FUNCTION: elisp_pkg_postinst |
66 | elisp-install ${PN} *.el *.elc |
179 | # @DESCRIPTION: |
67 | elisp-site-file-install "${FILESDIR}/${SITEFILE}" |
180 | # Call elisp-site-regen, in order to collect the site initialisation for |
68 | if [ -n "${DOCS}" ]; then |
181 | # all installed Emacs Lisp packages in the site-gentoo.el file. |
69 | dodoc ${DOCS} || die "dodoc failed" |
|
|
70 | fi |
|
|
71 | } |
|
|
72 | |
182 | |
73 | elisp_pkg_postinst() { |
183 | elisp_pkg_postinst() { |
74 | elisp-site-regen |
184 | elisp-site-regen |
75 | } |
185 | } |
76 | |
186 | |
|
|
187 | # @FUNCTION: elisp_pkg_postrm |
|
|
188 | # @DESCRIPTION: |
|
|
189 | # Call elisp-site-regen, in order to collect the site initialisation for |
|
|
190 | # all installed Emacs Lisp packages in the site-gentoo.el file. |
|
|
191 | |
77 | elisp_pkg_postrm() { |
192 | elisp_pkg_postrm() { |
78 | elisp-site-regen |
193 | elisp-site-regen |
79 | } |
194 | } |
80 | |
|
|
81 | EXPORT_FUNCTIONS src_unpack src_compile src_install |
|
|
82 | EXPORT_FUNCTIONS pkg_setup pkg_postinst pkg_postrm |
|
|