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

Diff of /eclass/elisp.eclass

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

Revision 1.40 Revision 1.53
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.40 2009/03/29 19:49:45 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 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
40 41# FILESDIR.
41# @ECLASS-VARIABLE: ELISP_PATCHES
42# @DESCRIPTION:
43# Any patches to apply after unpacking the sources. Patches are searched
44# both in ${PWD} and ${FILESDIR}.
45 42
46# @ECLASS-VARIABLE: SITEFILE 43# @ECLASS-VARIABLE: SITEFILE
44# @DEFAULT_UNSET
47# @DESCRIPTION: 45# @DESCRIPTION:
48# Name of package's site-init file. The filename must match the shell 46# 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 47# 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 48# reserved for internal use. "50${PN}-gentoo.el" is a reasonable choice
51# in most cases. 49# in most cases.
52 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
53inherit elisp-common eutils versionator 63inherit elisp-common eutils
54 64
55case "${EAPI:-0}" in 65case "${EAPI:-0}" in
56 0|1) EXPORT_FUNCTIONS src_{unpack,compile,install} \ 66 0|1) EXPORT_FUNCTIONS src_{unpack,compile,install} \
57 pkg_{setup,postinst,postrm} ;; 67 pkg_{setup,postinst,postrm} ;;
58 *) EXPORT_FUNCTIONS src_{unpack,prepare,configure,compile,install} \ 68 *) EXPORT_FUNCTIONS src_{unpack,prepare,configure,compile,install} \
61 71
62DEPEND=">=virtual/emacs-${NEED_EMACS:-21}" 72DEPEND=">=virtual/emacs-${NEED_EMACS:-21}"
63RDEPEND="${DEPEND}" 73RDEPEND="${DEPEND}"
64IUSE="" 74IUSE=""
65 75
76# @FUNCTION: elisp_pkg_setup
77# @DESCRIPTION:
78# Test if the eselected Emacs version is sufficient to fulfil the major
79# version requirement of the NEED_EMACS variable.
80
66elisp_pkg_setup() { 81elisp_pkg_setup() {
67 local need_emacs=${NEED_EMACS:-21} 82 elisp-need-emacs "${NEED_EMACS:-21}" || die "Emacs version too low"
68 local have_emacs=$(elisp-emacs-version)
69 if ! version_is_at_least "${need_emacs}" "${have_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} 83}
76 84
85# @FUNCTION: elisp_src_unpack
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
77elisp_src_unpack() { 91elisp_src_unpack() {
78 [ -n "${A}" ] && unpack ${A} 92 [[ -n ${A} ]] && unpack ${A}
79 if [ -f ${P}.el ]; then 93 if [[ -f ${P}.el ]]; then
80 # the "simple elisp" case with a single *.el file in WORKDIR 94 # the "simple elisp" case with a single *.el file in WORKDIR
81 mv ${P}.el ${PN}.el || die 95 mv ${P}.el ${PN}.el || die
82 [ -d "${S}" ] || S=${WORKDIR} 96 [[ -d ${S} ]] || S=${WORKDIR}
83 fi 97 fi
84 98
85 case "${EAPI:-0}" in 99 case "${EAPI:-0}" in
100 0|1) [[ -d ${S} ]] && cd "${S}"
86 0|1) elisp_src_prepare ;; 101 elisp_src_prepare ;;
87 esac 102 esac
88} 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.
89 109
90elisp_src_prepare() { 110elisp_src_prepare() {
91 local patch 111 local patch
92 for patch in ${ELISP_PATCHES}; do 112 for patch in ${ELISP_PATCHES}; do
93 if [ -f "${patch}" ]; then 113 if [[ -f ${patch} ]]; then
94 epatch "${patch}" 114 epatch "${patch}"
115 elif [[ -f ${WORKDIR}/${patch} ]]; then
116 epatch "${WORKDIR}/${patch}"
95 elif [ -f "${FILESDIR}/${patch}" ]; then 117 elif [[ -f ${FILESDIR}/${patch} ]]; then
96 epatch "${FILESDIR}/${patch}" 118 epatch "${FILESDIR}/${patch}"
97 else 119 else
98 die "Cannot find ${patch}" 120 die "Cannot find ${patch}"
99 fi 121 fi
100 done 122 done
101} 123}
102 124
125# @FUNCTION: elisp_src_configure
126# @DESCRIPTION:
127# Do nothing, because Emacs packages seldomly bring a full build system.
128
103elisp_src_configure() { :; } 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.
104 136
105elisp_src_compile() { 137elisp_src_compile() {
106 elisp-compile *.el || die 138 elisp-compile *.el || die
139 if [[ -n ${ELISP_TEXINFO} ]]; then
140 makeinfo ${ELISP_TEXINFO} || die
141 fi
107} 142}
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.
108 150
109elisp_src_install() { 151elisp_src_install() {
110 elisp-install ${PN} *.el *.elc || die 152 elisp-install ${PN} *.el *.elc || die
111 if [ -n "${SITEFILE}" ]; then 153 if [[ -n ${SITEFILE} ]]; then
112 elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die 154 elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
113 fi 155 fi
156 if [[ -n ${ELISP_TEXINFO} ]]; then
157 set -- ${ELISP_TEXINFO}
158 set -- ${@##*/}
159 doinfo ${@/%.*/.info*} || die
160 fi
114 if [ -n "${DOCS}" ]; then 161 if [[ -n ${DOCS} ]]; then
115 dodoc ${DOCS} || die 162 dodoc ${DOCS} || die
116 fi 163 fi
117} 164}
165
166# @FUNCTION: elisp_pkg_postinst
167# @DESCRIPTION:
168# Call elisp-site-regen, in order to collect the site initialisation for
169# all installed Emacs Lisp packages in the site-gentoo.el file.
118 170
119elisp_pkg_postinst() { 171elisp_pkg_postinst() {
120 elisp-site-regen 172 elisp-site-regen
121} 173}
122 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
123elisp_pkg_postrm() { 180elisp_pkg_postrm() {
124 elisp-site-regen 181 elisp-site-regen
125} 182}

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

  ViewVC Help
Powered by ViewVC 1.1.20