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

Diff of /eclass/elisp.eclass

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

Revision 1.42 Revision 1.54
1# Copyright 1999-2009 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.42 2009/08/25 12:53:55 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 2002-2003 Matthew Kennedy <mkennedy@gentoo.org>
6# Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com>
7# Copyright 2007-2009 Christian Faulhammer <fauli@gentoo.org>
8# Copyright 2007-2009 Ulrich Müller <ulm@gentoo.org>
9# 4#
10# @ECLASS: elisp.eclass 5# @ECLASS: elisp.eclass
11# @MAINTAINER: 6# @MAINTAINER:
12# Feel free to contact the Emacs team through <emacs@gentoo.org> if you 7# Gentoo Emacs team <emacs@gentoo.org>
13# have problems, suggestions or questions. 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>
14# @BLURB: Eclass for Emacs Lisp packages 13# @BLURB: Eclass for Emacs Lisp packages
15# @DESCRIPTION: 14# @DESCRIPTION:
16# 15#
17# This eclass is designed to install elisp files of Emacs related 16# This eclass is designed to install elisp files of Emacs related
18# packages into the site-lisp directory. The majority of elisp packages 17# packages into the site-lisp directory. The majority of elisp packages
19# will only need to define the standard ebuild variables (like SRC_URI) 18# will only need to define the standard ebuild variables (like SRC_URI)
20# and optionally SITEFILE for successful installation. 19# and optionally SITEFILE for successful installation.
21# 20#
22# Emacs support for other than pure elisp packages is handled by 21# Emacs support for other than pure elisp packages is handled by
23# 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.
26# If the package's source is a single (in whatever way) compressed elisp 25# If the package's source is a single (in whatever way) compressed elisp
27# file with the file name ${P}.el, then this eclass will move ${P}.el to 26# file with the file name ${P}.el, then this eclass will move ${P}.el to
28# ${PN}.el in src_unpack(). 27# ${PN}.el in src_unpack().
29 28
30# @ECLASS-VARIABLE: NEED_EMACS 29# @ECLASS-VARIABLE: NEED_EMACS
30# @DEFAULT_UNSET
31# @DESCRIPTION: 31# @DESCRIPTION:
32# 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
33# variable before inheriting elisp.eclass. Set it to the major version 33# variable before inheriting elisp.eclass. Set it to the major version
34# your package uses and the dependency will be adjusted. 34# your package uses and the dependency will be adjusted.
35 35
36# @ECLASS-VARIABLE: DOCS 36# @ECLASS-VARIABLE: ELISP_PATCHES
37# @DEFAULT_UNSET
37# @DESCRIPTION: 38# @DESCRIPTION:
38# DOCS="blah.txt ChangeLog" is automatically used to install the given 39# Space separated list of patches to apply after unpacking the sources.
39# files by dodoc in src_install(). 40# Patch files are searched for in the current working dir, WORKDIR, and
41# FILESDIR.
40 42
41# @ECLASS-VARIABLE: ELISP_PATCHES 43# @ECLASS-VARIABLE: ELISP_REMOVE
44# @DEFAULT_UNSET
42# @DESCRIPTION: 45# @DESCRIPTION:
43# Any patches to apply after unpacking the sources. Patches are searched 46# Space separated list of files to remove after unpacking the sources.
44# both in ${PWD} and ${FILESDIR}.
45 47
46# @ECLASS-VARIABLE: SITEFILE 48# @ECLASS-VARIABLE: SITEFILE
49# @DEFAULT_UNSET
47# @DESCRIPTION: 50# @DESCRIPTION:
48# Name of package's site-init file. The filename must match the shell 51# Name of package's site-init file. The filename must match the shell
49# pattern "[1-8][0-9]*-gentoo.el"; numbers below 10 and above 89 are 52# pattern "[1-8][0-9]*-gentoo.el"; numbers below 10 and above 89 are
50# reserved for internal use. "50${PN}-gentoo.el" is a reasonable choice 53# reserved for internal use. "50${PN}-gentoo.el" is a reasonable choice
51# in most cases. 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().
52 67
53inherit elisp-common eutils 68inherit elisp-common eutils
54 69
55case "${EAPI:-0}" in 70case "${EAPI:-0}" in
56 0|1) EXPORT_FUNCTIONS src_{unpack,compile,install} \ 71 0|1) EXPORT_FUNCTIONS src_{unpack,compile,install} \
61 76
62DEPEND=">=virtual/emacs-${NEED_EMACS:-21}" 77DEPEND=">=virtual/emacs-${NEED_EMACS:-21}"
63RDEPEND="${DEPEND}" 78RDEPEND="${DEPEND}"
64IUSE="" 79IUSE=""
65 80
81# @FUNCTION: elisp_pkg_setup
82# @DESCRIPTION:
83# Test if the eselected Emacs version is sufficient to fulfil the major
84# version requirement of the NEED_EMACS variable.
85
66elisp_pkg_setup() { 86elisp_pkg_setup() {
67 local need_emacs=${NEED_EMACS:-21} 87 elisp-need-emacs "${NEED_EMACS:-21}" || die "Emacs version too low"
68 local have_emacs=$(elisp-emacs-version)
69 if [ "${have_emacs%%.*}" -lt "${need_emacs%%.*}" ]; then
70 eerror "This package needs at least Emacs ${need_emacs%%.*}."
71 eerror "Use \"eselect emacs\" to select the active version."
72 die "Emacs version ${have_emacs} is too low."
73 fi
74 einfo "Emacs version: ${have_emacs}"
75} 88}
76 89
90# @FUNCTION: elisp_src_unpack
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
77elisp_src_unpack() { 96elisp_src_unpack() {
78 [ -n "${A}" ] && unpack ${A} 97 [[ -n ${A} ]] && unpack ${A}
79 if [ -f ${P}.el ]; then 98 if [[ -f ${P}.el ]]; then
80 # the "simple elisp" case with a single *.el file in WORKDIR 99 # the "simple elisp" case with a single *.el file in WORKDIR
81 mv ${P}.el ${PN}.el || die 100 mv ${P}.el ${PN}.el || die
82 [ -d "${S}" ] || S=${WORKDIR} 101 [[ -d ${S} ]] || S=${WORKDIR}
83 fi 102 fi
84 103
85 case "${EAPI:-0}" in 104 case "${EAPI:-0}" in
86 0|1) [ -d "${S}" ] && cd "${S}" 105 0|1) [[ -d ${S} ]] && cd "${S}"
87 elisp_src_prepare ;; 106 elisp_src_prepare ;;
88 esac 107 esac
89} 108}
90 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
91elisp_src_prepare() { 115elisp_src_prepare() {
92 local patch 116 local patch
93 for patch in ${ELISP_PATCHES}; do 117 for patch in ${ELISP_PATCHES}; do
94 if [ -f "${patch}" ]; then 118 if [[ -f ${patch} ]]; then
95 epatch "${patch}" 119 epatch "${patch}"
120 elif [[ -f ${WORKDIR}/${patch} ]]; then
121 epatch "${WORKDIR}/${patch}"
96 elif [ -f "${FILESDIR}/${patch}" ]; then 122 elif [[ -f ${FILESDIR}/${patch} ]]; then
97 epatch "${FILESDIR}/${patch}" 123 epatch "${FILESDIR}/${patch}"
98 else 124 else
99 die "Cannot find ${patch}" 125 die "Cannot find ${patch}"
100 fi 126 fi
101 done 127 done
128
129 # apply any user patches
130 epatch_user
131
132 if [[ -n ${ELISP_REMOVE} ]]; then
133 rm ${ELISP_REMOVE} || die
134 fi
102} 135}
136
137# @FUNCTION: elisp_src_configure
138# @DESCRIPTION:
139# Do nothing, because Emacs packages seldomly bring a full build system.
103 140
104elisp_src_configure() { :; } 141elisp_src_configure() { :; }
105 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
106elisp_src_compile() { 149elisp_src_compile() {
107 elisp-compile *.el || die 150 elisp-compile *.el || die
151 if [[ -n ${ELISP_TEXINFO} ]]; then
152 makeinfo ${ELISP_TEXINFO} || die
153 fi
108} 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.
109 162
110elisp_src_install() { 163elisp_src_install() {
111 elisp-install ${PN} *.el *.elc || die 164 elisp-install ${PN} *.el *.elc || die
112 if [ -n "${SITEFILE}" ]; then 165 if [[ -n ${SITEFILE} ]]; then
113 elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die 166 elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
114 fi 167 fi
168 if [[ -n ${ELISP_TEXINFO} ]]; then
169 set -- ${ELISP_TEXINFO}
170 set -- ${@##*/}
171 doinfo ${@/%.*/.info*} || die
172 fi
115 if [ -n "${DOCS}" ]; then 173 if [[ -n ${DOCS} ]]; then
116 dodoc ${DOCS} || die 174 dodoc ${DOCS} || die
117 fi 175 fi
118} 176}
177
178# @FUNCTION: elisp_pkg_postinst
179# @DESCRIPTION:
180# Call elisp-site-regen, in order to collect the site initialisation for
181# all installed Emacs Lisp packages in the site-gentoo.el file.
119 182
120elisp_pkg_postinst() { 183elisp_pkg_postinst() {
121 elisp-site-regen 184 elisp-site-regen
122} 185}
123 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
124elisp_pkg_postrm() { 192elisp_pkg_postrm() {
125 elisp-site-regen 193 elisp-site-regen
126} 194}

Legend:
Removed from v.1.42  
changed lines
  Added in v.1.54

  ViewVC Help
Powered by ViewVC 1.1.20