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

Diff of /eclass/elisp.eclass

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

Revision 1.17 Revision 1.52
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.17 2007/04/16 15:35:56 opfer Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/elisp.eclass,v 1.52 2011/08/30 20:10:13 ulm Exp $
4# 4#
5# Copyright 2007 Christian Faulhammer <opfer@gentoo.org> 5# @ECLASS: elisp.eclass
6# @MAINTAINER:
7# Gentoo Emacs team <emacs@gentoo.org>
8# @AUTHOR:
6# Copyright 2002-2007 Matthew Kennedy <mkennedy@gentoo.org> 9# Matthew Kennedy <mkennedy@gentoo.org>
7# Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com> 10# Jeremy Maitin-Shepard <jbms@attbi.com>
11# Christian Faulhammer <fauli@gentoo.org>
8# Copyright 2007 Ulrich Mueller <ulm@gentoo.org> 12# Ulrich M├╝ller <ulm@gentoo.org>
13# @BLURB: Eclass for Emacs Lisp packages
14# @DESCRIPTION:
9# 15#
10# This is not a real eclass, but it does provide Emacs-related installation 16# This eclass is designed to install elisp files of Emacs related
11# utilities. 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.
12# 20#
13# USAGE: 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.
14# 24#
15# Usually you want to use this eclass for (optional) GNU Emacs support of 25# If the package's source is a single (in whatever way) compressed elisp
16# your package. This is NOT for XEmacs! 26# file with the file name ${P}.el, then this eclass will move ${P}.el to
17# Many of the steps here are sometimes done by the build system of your 27# ${PN}.el in src_unpack().
18# package (especially compilation), so this is mainly for standalone elisp
19# files you gathered from somewhere else.
20# When relying on the emacs USE flag, you need to add
21#
22# emacs? ( virtual/emacs )
23#
24# to your DEPEND/RDEPEND line and use the functions provided here to bring
25# the files to the correct locations.
26#
27# src_compile() usage:
28# --------------------
29#
30# An elisp file is compiled by the elisp-compile() function defined here and
31# simply takes the source files as arguments. In the case of interdependent
32# elisp files, you can use the elisp-comp() function which makes sure all
33# files are loadable.
34#
35# elisp-compile *.el || die "elisp-compile failed!"
36# or
37# elisp-comp *.el || die "elisp-comp failed!"
38#
39# Function elisp-make-autoload-file() can be used to generate a file with
40# autoload definitions for the lisp functions. It takes the output file name
41# (default: "${PN}-autoloads.el") and a list of directories (default: working
42# directory) as its arguments. Use of this function requires that the elisp
43# source files contain magic ";;;###autoload" comments. See the Emacs Lisp
44# Reference Manual (node "Autoload") for a detailed explanation.
45#
46# src_install() usage:
47# --------------------
48#
49# The resulting compiled files (.elc) should be put in a subdirectory of
50# /usr/share/emacs/site-lisp/ which is named after the first argument
51# of elisp-install(). The following parameters are the files to be put in
52# that directory. Usually the subdirectory should be ${PN}, you can choose
53# something else, but remember to tell elisp-site-file-install() (see below)
54# the change, as it defaults to ${PN}.
55#
56# elisp-install ${PN} *.elc *.el || die "elisp-install failed!"
57#
58# To let the Emacs support be activated by Emacs on startup, you need
59# to provide a site file (shipped in ${FILESDIR}) which contains the startup
60# code (have a look in the documentation of your software). Normally this
61# would look like this:
62#
63# ;;; csv-mode site-lisp configuration
64#
65# (add-to-list 'load-path "@SITELISP@")
66# (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode))
67# (autoload 'csv-mode "csv-mode" "Major mode for editing csv files." t)
68#
69# If your Emacs support files are installed in a subdirectory of
70# /usr/share/emacs/site-lisp/ (which is recommended if more than one file is
71# installed), you need to extend Emacs' load-path as shown in the first
72# non-comment. The elisp-site-file-install() function of this eclass will
73# replace "@SITELISP@" by the actual path.
74# The next line tells Emacs to load the mode opening a file ending with
75# ".csv" and load functions depending on the context and needed features.
76# Be careful though. Commands as "load-library" or "require" bloat the
77# editor as they are loaded on every startup. When having a lot of Emacs
78# support files, users may be annoyed by the start-up time. Also avoid
79# keybindings as they might interfere with the user's settings. Give a hint
80# in pkg_postinst(), which should be enough.
81# The naming scheme for this site file is "[0-9][0-9]*-gentoo.el", where the
82# two digits at the beginning define the loading order. So if you depend on
83# another Emacs package, your site file's number must be higher!
84# Best practice is to define a SITEFILE variable in the global scope of your
85# ebuild (right after DEPEND e.g.):
86#
87# SITEFILE=50${PN}-gentoo.el
88#
89# Which is then installed by
90#
91# elisp-site-file-install "${FILESDIR}/${SITEFILE}"
92#
93# in src_install(). If your subdirectory is not named ${PN}, give the
94# differing name as second argument.
95#
96# pkg_postinst() / pkg_postrm() usage:
97# ------------------------------------
98#
99# After that you need to recreate the start-up file of Emacs after emerging
100# and unmerging by using
101#
102# pkg_postinst() {
103# elisp-site-regen
104# }
105# pkg_postrm() {
106# elisp-site-regen
107# }
108#
109# As always: Feel free to contact Emacs team through emacs@gentoo.org if you
110# have problems, suggestions or questions.
111 28
112SITELISP=/usr/share/emacs/site-lisp 29# @ECLASS-VARIABLE: NEED_EMACS
30# @DEFAULT_UNSET
31# @DESCRIPTION:
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
34# your package uses and the dependency will be adjusted.
113 35
114elisp-compile() { 36# @ECLASS-VARIABLE: ELISP_PATCHES
115 /usr/bin/emacs --batch -f batch-byte-compile --no-site-file --no-init-file $* 37# @DEFAULT_UNSET
38# @DESCRIPTION:
39# Any patches to apply after unpacking the sources. Patch files are
40# searched for in the current working dir, WORKDIR, and FILESDIR.
41
42# @ECLASS-VARIABLE: SITEFILE
43# @DEFAULT_UNSET
44# @DESCRIPTION:
45# Name of package's site-init file. The filename must match the shell
46# pattern "[1-8][0-9]*-gentoo.el"; numbers below 10 and above 89 are
47# reserved for internal use. "50${PN}-gentoo.el" is a reasonable choice
48# in most cases.
49
50# @ECLASS-VARIABLE: ELISP_TEXINFO
51# @DEFAULT_UNSET
52# @DESCRIPTION:
53# Space separated list of Texinfo sources. Respective GNU Info files
54# will be generated in src_compile() and installed in src_install().
55
56# @ECLASS-VARIABLE: DOCS
57# @DEFAULT_UNSET
58# @DESCRIPTION:
59# DOCS="blah.txt ChangeLog" is automatically used to install the given
60# files by dodoc in src_install().
61
62inherit elisp-common eutils
63
64case "${EAPI:-0}" in
65 0|1) EXPORT_FUNCTIONS src_{unpack,compile,install} \
66 pkg_{setup,postinst,postrm} ;;
67 *) EXPORT_FUNCTIONS src_{unpack,prepare,configure,compile,install} \
68 pkg_{setup,postinst,postrm} ;;
69esac
70
71DEPEND=">=virtual/emacs-${NEED_EMACS:-21}"
72RDEPEND="${DEPEND}"
73IUSE=""
74
75# @FUNCTION: elisp_pkg_setup
76# @DESCRIPTION:
77# Test if the eselected Emacs version is sufficient to fulfil the major
78# version requirement of the NEED_EMACS variable.
79
80elisp_pkg_setup() {
81 elisp-need-emacs "${NEED_EMACS:-21}" || die "Emacs version too low"
116} 82}
117 83
118elisp-make-autoload-file () { 84# @FUNCTION: elisp_src_unpack
119 local f="${1-${PN}-autoloads.el}" 85# @DESCRIPTION:
120 shift 86# Unpack the sources; also handle the case of a single *.el file in
121 echo >"${f}" 87# WORKDIR for packages distributed that way. For EAPIs without
122 emacs --batch -q --no-site-file \ 88# src_prepare, call elisp_src_prepare.
123 --eval "(setq make-backup-files nil)" \ 89
124 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \ 90elisp_src_unpack() {
125 -f batch-update-autoloads "${@-.}" 91 [[ -n ${A} ]] && unpack ${A}
92 if [[ -f ${P}.el ]]; then
93 # the "simple elisp" case with a single *.el file in WORKDIR
94 mv ${P}.el ${PN}.el || die
95 [[ -d ${S} ]] || S=${WORKDIR}
96 fi
97
98 case "${EAPI:-0}" in
99 0|1) [[ -d ${S} ]] && cd "${S}"
100 elisp_src_prepare ;;
101 esac
126} 102}
127 103
128elisp-install() { 104# @FUNCTION: elisp_src_prepare
129 local subdir=$1 105# @DESCRIPTION:
130 dodir "${SITELISP}/${subdir}" 106# Apply any patches listed in ELISP_PATCHES. Patch files are searched
131 insinto "${SITELISP}/${subdir}" 107# for in the current working dir, WORKDIR, and FILESDIR.
132 shift 108
133 doins $@ 109elisp_src_prepare() {
110 local patch
111 for patch in ${ELISP_PATCHES}; do
112 if [[ -f ${patch} ]]; then
113 epatch "${patch}"
114 elif [[ -f ${WORKDIR}/${patch} ]]; then
115 epatch "${WORKDIR}/${patch}"
116 elif [[ -f ${FILESDIR}/${patch} ]]; then
117 epatch "${FILESDIR}/${patch}"
118 else
119 die "Cannot find ${patch}"
120 fi
121 done
134} 122}
135 123
136elisp-site-file-install() { 124# @FUNCTION: elisp_src_configure
137 local sitefile=$1 my_pn=${2:-${PN}} 125# @DESCRIPTION:
138 pushd "${S}" 126# Do nothing, because Emacs packages seldomly bring a full build system.
139 cp ${sitefile} "${T}" 127
140 sed -i "s:@SITELISP@:${SITELISP}/${my_pn}:g" "${T}/$(basename ${sitefile})" 128elisp_src_configure() { :; }
141 insinto ${SITELISP} 129
142 doins "${T}/$(basename ${sitefile})" || die "failed to install site file" 130# @FUNCTION: elisp_src_compile
143 popd 131# @DESCRIPTION:
132# Call elisp-compile to byte-compile all Emacs Lisp (*.el) files.
133# If ELISP_TEXINFO lists any Texinfo sources, call makeinfo to generate
134# GNU Info files from them.
135
136elisp_src_compile() {
137 elisp-compile *.el || die
138 if [[ -n ${ELISP_TEXINFO} ]]; then
139 makeinfo ${ELISP_TEXINFO} || die
140 fi
144} 141}
145 142
146elisp-site-regen() { 143# @FUNCTION: elisp_src_install
147 einfo "Regenerating ${SITELISP}/site-gentoo.el ..." 144# @DESCRIPTION:
148 einfo "" 145# Call elisp-install to install all Emacs Lisp (*.el and *.elc) files.
149 cat <<EOF >${ROOT}${SITELISP}/site-gentoo.el 146# If the SITEFILE variable specifies a site-init file, install it with
150;;; DO NOT EDIT THIS FILE -- IT IS GENERATED AUTOMATICALLY BY PORTAGE 147# elisp-site-file-install. Also install any GNU Info files listed in
151;;; ----------------------------------------------------------------- 148# ELISP_TEXINFO and documentation listed in the DOCS variable.
152 149
153EOF 150elisp_src_install() {
154 ls ${ROOT}${SITELISP}/[0-9][0-9]*-gentoo.el | sort -n | \ 151 elisp-install ${PN} *.el *.elc || die
155 while read sf 152 if [[ -n ${SITEFILE} ]]; then
156 do 153 elisp-site-file-install "${FILESDIR}/${SITEFILE}" || die
157 einfo " Adding $(basename $sf) ..." 154 fi
158 # Great for debugging, too noisy and slow for users though 155 if [[ -n ${ELISP_TEXINFO} ]]; then
159# echo "(message \"Loading $sf ...\")" >>${ROOT}${SITELISP}/site-start.el 156 set -- ${ELISP_TEXINFO}
160 cat $sf >>${ROOT}${SITELISP}/site-gentoo.el 157 set -- ${@##*/}
161 done 158 doinfo ${@/%.*/.info*} || die
162 while read line; do einfo "${line}"; done <<EOF 159 fi
163 160 if [[ -n ${DOCS} ]]; then
164All site initialization for Gentoo-installed packages is now added to 161 dodoc ${DOCS} || die
165/usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer 162 fi
166managed by Gentoo. You are responsible for all maintenance of
167site-start.el if there is such a file.
168
169In order for this site initialization to be loaded for all users
170automatically, as was done previously, you can add a line like this:
171
172 (load "/usr/share/emacs/site-lisp/site-gentoo")
173
174to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
175can be added by individual users to their initialization files, or for
176greater flexibility, users can select which of the package-specific
177initialization files in /usr/share/emacs/site-lisp to load.
178EOF
179 echo
180} 163}
181 164
182# The following Emacs Lisp compilation routine is taken from GNU 165# @FUNCTION: elisp_pkg_postinst
183# autotools. 166# @DESCRIPTION:
167# Call elisp-site-regen, in order to collect the site initialisation for
168# all installed Emacs Lisp packages in the site-gentoo.el file.
184 169
185elisp-comp() { 170elisp_pkg_postinst() {
186# Copyright 1995 Free Software Foundation, Inc. 171 elisp-site-regen
187# Fran├žois Pinard <pinard@iro.umontreal.ca>, 1995. 172}
188# This script byte-compiles all `.el' files which are part of its
189# arguments, using GNU Emacs, and put the resulting `.elc' files into
190# the current directory, so disregarding the original directories used
191# in `.el' arguments.
192#
193# This script manages in such a way that all Emacs LISP files to
194# be compiled are made visible between themselves, in the event
195# they require or load-library one another.
196 173
197 if test $# = 0; then 174# @FUNCTION: elisp_pkg_postrm
198 exit 1 175# @DESCRIPTION:
199 else 176# Call elisp-site-regen, in order to collect the site initialisation for
200 if test -z "${EMACS}" || test "${EMACS}" = "t"; then 177# all installed Emacs Lisp packages in the site-gentoo.el file.
201 # Value of "t" means we are running in a shell under Emacs.
202 # Just assume Emacs is called "emacs".
203 EMACS=emacs
204 fi
205 178
206 tempdir=elc.$$ 179elisp_pkg_postrm() {
207 mkdir ${tempdir} 180 elisp-site-regen
208 cp $* ${tempdir}
209 cd ${tempdir}
210
211 echo "(add-to-list 'load-path \"../\")" > script
212 ${EMACS} -batch -q --no-site-file --no-init-file -l script -f batch-byte-compile *.el
213 mv *.elc ..
214
215 cd ..
216 rm -fr ${tempdir}
217 fi
218} 181}

Legend:
Removed from v.1.17  
changed lines
  Added in v.1.52

  ViewVC Help
Powered by ViewVC 1.1.20