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

Diff of /eclass/elisp-common.eclass

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

Revision 1.24 Revision 1.25
1# Copyright 1999-2007 Gentoo Foundation 1# Copyright 1999-2007 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-common.eclass,v 1.24 2007/07/10 20:14:52 ulm Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.25 2007/07/25 04:46:01 ulm Exp $
4# 4#
5# Copyright 2007 Christian Faulhammer <opfer@gentoo.org> 5# Copyright 2007 Christian Faulhammer <opfer@gentoo.org>
6# Copyright 2002-2004 Matthew Kennedy <mkennedy@gentoo.org> 6# Copyright 2002-2004 Matthew Kennedy <mkennedy@gentoo.org>
7# Copyright 2004-2005 Mamoru Komachi <usata@gentoo.org> 7# Copyright 2004-2005 Mamoru Komachi <usata@gentoo.org>
8# Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com> 8# Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com>
9# Copyright 2007 Ulrich Mueller <ulm@gentoo.org> 9# Copyright 2007 Ulrich Mueller <ulm@gentoo.org>
10# 10#
11# This is not a real eclass, but it does provide Emacs-related installation 11# @ECLASS: elisp-common.eclass
12# utilities. 12# @MAINTAINER:
13# 13# Feel free to contact the Emacs team through emacs@gentoo.org if you have
14# USAGE: 14# problems, suggestions or questions.
15# @BLURB: Emacs-related installation utilities
16# @DESCRIPTION:
15# 17#
16# Usually you want to use this eclass for (optional) GNU Emacs support of 18# Usually you want to use this eclass for (optional) GNU Emacs support of
17# your package. This is NOT for XEmacs! 19# your package. This is NOT for XEmacs!
20#
18# Many of the steps here are sometimes done by the build system of your 21# Many of the steps here are sometimes done by the build system of your
19# package (especially compilation), so this is mainly for standalone elisp 22# package (especially compilation), so this is mainly for standalone elisp
20# files you gathered from somewhere else. 23# files you gathered from somewhere else.
24#
21# When relying on the emacs USE flag, you need to add 25# When relying on the emacs USE flag, you need to add
22# 26#
23# emacs? ( virtual/emacs ) 27# emacs? ( virtual/emacs )
24# 28#
25# to your DEPEND/RDEPEND line and use the functions provided here to bring 29# to your DEPEND/RDEPEND line and use the functions provided here to bring
26# the files to the correct locations. 30# the files to the correct locations.
27# 31#
32# .SS
28# src_compile() usage: 33# src_compile() usage:
29# --------------------
30# 34#
31# An elisp file is compiled by the elisp-compile() function defined here and 35# An elisp file is compiled by the elisp-compile() function defined here and
32# simply takes the source files as arguments. In the case of interdependent 36# simply takes the source files as arguments.
33# elisp files, you can use the elisp-comp() function which makes sure all
34# files are loadable.
35# 37#
36# elisp-compile *.el || die "elisp-compile failed" 38# elisp-compile *.el || die "elisp-compile failed"
37# or 39#
40# In the case of interdependent elisp files, you can use the elisp-comp()
41# function which makes sure all files are loadable.
42#
38# elisp-comp *.el || die "elisp-comp failed" 43# elisp-comp *.el || die "elisp-comp failed"
39# 44#
40# Function elisp-make-autoload-file() can be used to generate a file with 45# Function elisp-make-autoload-file() can be used to generate a file with
41# autoload definitions for the lisp functions. It takes the output file name 46# autoload definitions for the lisp functions. It takes the output file name
42# (default: "${PN}-autoloads.el") and a list of directories (default: working 47# (default: "${PN}-autoloads.el") and a list of directories (default: working
43# directory) as its arguments. Use of this function requires that the elisp 48# directory) as its arguments. Use of this function requires that the elisp
44# source files contain magic ";;;###autoload" comments. See the Emacs Lisp 49# source files contain magic ";;;###autoload" comments. See the Emacs Lisp
45# Reference Manual (node "Autoload") for a detailed explanation. 50# Reference Manual (node "Autoload") for a detailed explanation.
46# 51#
52# .SS
47# src_install() usage: 53# src_install() usage:
48# --------------------
49# 54#
50# The resulting compiled files (.elc) should be put in a subdirectory of 55# The resulting compiled files (.elc) should be put in a subdirectory of
51# /usr/share/emacs/site-lisp/ which is named after the first argument 56# /usr/share/emacs/site-lisp/ which is named after the first argument
52# of elisp-install(). The following parameters are the files to be put in 57# of elisp-install(). The following parameters are the files to be put in
53# that directory. Usually the subdirectory should be ${PN}, you can choose 58# that directory. Usually the subdirectory should be ${PN}, you can choose
54# something else, but remember to tell elisp-site-file-install() (see below) 59# something else, but remember to tell elisp-site-file-install() (see below)
55# the change, as it defaults to ${PN}. 60# the change, as it defaults to ${PN}.
56# 61#
57# elisp-install ${PN} *.el *.elc || die "elisp-install failed" 62# elisp-install ${PN} *.el *.elc || die "elisp-install failed"
58# 63#
59# To let the Emacs support be activated by Emacs on startup, you need 64# To let the Emacs support be activated by Emacs on startup, you need
60# to provide a site file (shipped in ${FILESDIR}) which contains the startup 65# to provide a site file (shipped in ${FILESDIR}) which contains the startup
61# code (have a look in the documentation of your software). Normally this 66# code (have a look in the documentation of your software). Normally this
62# would look like this: 67# would look like this:
63# 68#
69# .nf
64# ;;; csv-mode site-lisp configuration 70# ;;; csv-mode site-lisp configuration
65# 71#
66# (add-to-list 'load-path "@SITELISP@") 72# (add-to-list 'load-path "@SITELISP@")
67# (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode)) 73# (add-to-list 'auto-mode-alist '("\\.csv\\'" . csv-mode))
68# (autoload 'csv-mode "csv-mode" "Major mode for editing csv files." t) 74# (autoload 'csv-mode "csv-mode" "Major mode for csv files." t)
75# .fi
69# 76#
70# If your Emacs support files are installed in a subdirectory of 77# If your Emacs support files are installed in a subdirectory of
71# /usr/share/emacs/site-lisp/ (which is recommended if more than one file is 78# /usr/share/emacs/site-lisp/ (which is recommended if more than one file is
72# installed), you need to extend Emacs' load-path as shown in the first 79# installed), you need to extend Emacs' load-path as shown in the first
73# non-comment. The elisp-site-file-install() function of this eclass will 80# non-comment. The elisp-site-file-install() function of this eclass will
74# replace "@SITELISP@" by the actual path. 81# replace "@SITELISP@" by the actual path.
82#
75# The next line tells Emacs to load the mode opening a file ending with 83# The next line tells Emacs to load the mode opening a file ending with
76# ".csv" and load functions depending on the context and needed features. 84# ".csv" and load functions depending on the context and needed features.
77# Be careful though. Commands as "load-library" or "require" bloat the 85# Be careful though. Commands as "load-library" or "require" bloat the
78# editor as they are loaded on every startup. When having a lot of Emacs 86# editor as they are loaded on every startup. When having a lot of Emacs
79# support files, users may be annoyed by the start-up time. Also avoid 87# support files, users may be annoyed by the start-up time. Also avoid
80# keybindings as they might interfere with the user's settings. Give a hint 88# keybindings as they might interfere with the user's settings. Give a hint
81# in pkg_postinst(), which should be enough. 89# in pkg_postinst(), which should be enough.
90#
82# The naming scheme for this site file is "[0-9][0-9]*-gentoo.el", where the 91# The naming scheme for this site file is "[0-9][0-9]*-gentoo.el", where the
83# two digits at the beginning define the loading order. So if you depend on 92# two digits at the beginning define the loading order. So if you depend on
84# another Emacs package, your site file's number must be higher! 93# another Emacs package, your site file's number must be higher!
94#
85# Best practice is to define a SITEFILE variable in the global scope of your 95# Best practice is to define a SITEFILE variable in the global scope of your
86# ebuild (right after DEPEND e.g.): 96# ebuild (right after DEPEND e.g.):
87# 97#
88# SITEFILE=50${PN}-gentoo.el 98# SITEFILE=50${PN}-gentoo.el
89# 99#
90# Which is then installed by 100# Which is then installed by
91# 101#
92# elisp-site-file-install "${FILESDIR}/${SITEFILE}" 102# elisp-site-file-install "${FILESDIR}/${SITEFILE}"
93# 103#
94# in src_install(). If your subdirectory is not named ${PN}, give the 104# in src_install(). If your subdirectory is not named ${PN}, give the
95# differing name as second argument. 105# differing name as second argument.
96# 106#
107# .SS
97# pkg_postinst() / pkg_postrm() usage: 108# pkg_postinst() / pkg_postrm() usage:
98# ------------------------------------
99# 109#
100# After that you need to recreate the start-up file of Emacs after emerging 110# After that you need to recreate the start-up file of Emacs after emerging
101# and unmerging by using 111# and unmerging by using
102# 112#
113# .nf
103# pkg_postinst() { 114# pkg_postinst() {
104# elisp-site-regen 115# elisp-site-regen
105# } 116# }
106# 117#
107# pkg_postrm() { 118# pkg_postrm() {
108# elisp-site-regen 119# elisp-site-regen
109# } 120# }
121# .fi
110# 122#
111# When having optional Emacs support, you should prepend "use emacs &&" to 123# When having optional Emacs support, you should prepend "use emacs &&" to
112# above calls of elisp-site-regen(). Don't use "has_version virtual/emacs"! 124# above calls of elisp-site-regen(). Don't use "has_version virtual/emacs"!
113# When unmerging the state of the USE flag emacs is taken from the package 125# When unmerging the state of the emacs USE flag is taken from the package
114# database and not from the environment, so it is no problem when you unset 126# database and not from the environment, so it is no problem when you unset
115# USE=emacs between merge und unmerge of a package. 127# USE=emacs between merge and unmerge of a package.
116# 128#
129# .SS
117# Miscellaneous functions: 130# Miscellaneous functions:
118# ------------------------
119# 131#
120# elisp-emacs-version() outputs the version of the currently active Emacs. 132# elisp-emacs-version() outputs the version of the currently active Emacs.
121#
122# As always: Feel free to contact Emacs team through emacs@gentoo.org if you
123# have problems, suggestions or questions.
124 133
125SITELISP=/usr/share/emacs/site-lisp 134SITELISP=/usr/share/emacs/site-lisp
135SITEFILE=50${PN}-gentoo.el
136
137# @FUNCTION: elisp-compile
138# @USAGE: <list of elisp files>
139# @DESCRIPTION:
140# Byte-compile Emacs Lisp files.
126 141
127elisp-compile() { 142elisp-compile() {
128 einfo "Compiling GNU Emacs Elisp files ..." 143 einfo "Compiling GNU Emacs Elisp files ..."
129 /usr/bin/emacs -batch -q --no-site-file -f batch-byte-compile $* 144 /usr/bin/emacs -batch -q --no-site-file -f batch-byte-compile $*
130} 145}
131 146
147# @FUNCTION: elisp-emacs-version
148# @DESCRIPTION:
149# Output version of currently active Emacs.
150
132elisp-emacs-version() { 151elisp-emacs-version() {
133 # Output version of currently active Emacs.
134 # The following will work for at least versions 18-22. 152 # The following will work for at least versions 18-22.
135 echo "(princ emacs-version)" >"${T}"/emacs-version.el 153 echo "(princ emacs-version)" >"${T}"/emacs-version.el
136 /usr/bin/emacs -batch -q --no-site-file -l "${T}"/emacs-version.el 154 /usr/bin/emacs -batch -q --no-site-file -l "${T}"/emacs-version.el
137} 155}
156
157# @FUNCTION: elisp-make-autoload-file
158# @USAGE: [output file] [list of directories]
159# @DESCRIPTION:
160# Generate a file with autoload definitions for the lisp functions.
138 161
139elisp-make-autoload-file () { 162elisp-make-autoload-file () {
140 local f="${1:-${PN}-autoloads.el}" 163 local f="${1:-${PN}-autoloads.el}"
141 shift 164 shift
142 einfo "Generating autoload file for GNU Emacs ..." 165 einfo "Generating autoload file for GNU Emacs ..."
162 --eval "(setq make-backup-files nil)" \ 185 --eval "(setq make-backup-files nil)" \
163 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \ 186 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
164 -f batch-update-autoloads "${@-.}" 187 -f batch-update-autoloads "${@-.}"
165} 188}
166 189
190# @FUNCTION: elisp-install
191# @USAGE: <subdirectory> <list of files>
192# @DESCRIPTION:
193# Install files in SITELISP directory.
194
167elisp-install() { 195elisp-install() {
168 local subdir=$1 196 local subdir=$1
169 einfo "Installing Elisp files for GNU Emacs support ..." 197 einfo "Installing Elisp files for GNU Emacs support ..."
170 dodir "${SITELISP}/${subdir}" 198 dodir "${SITELISP}/${subdir}"
171 insinto "${SITELISP}/${subdir}" 199 insinto "${SITELISP}/${subdir}"
172 shift 200 shift
173 doins $@ 201 doins $@
174} 202}
203
204# @FUNCTION: elisp-site-file-install
205# @USAGE: <site-init file> [subdirectory]
206# @DESCRIPTION:
207# Install Emacs site-init file in SITELISP directory.
175 208
176elisp-site-file-install() { 209elisp-site-file-install() {
177 local sitefile=$1 my_pn=${2:-${PN}} 210 local sitefile=$1 my_pn=${2:-${PN}}
178 einfo "Installing site initialisation file for GNU Emacs ..." 211 einfo "Installing site initialisation file for GNU Emacs ..."
179 pushd "${S}" 212 pushd "${S}"
182 insinto ${SITELISP} 215 insinto ${SITELISP}
183 doins "${T}/$(basename ${sitefile})" || die "failed to install site file" 216 doins "${T}/$(basename ${sitefile})" || die "failed to install site file"
184 popd 217 popd
185} 218}
186 219
220# @FUNCTION: elisp-site-regen
221# @DESCRIPTION:
222# Regenerate site-gentoo.el file.
223
187elisp-site-regen() { 224elisp-site-regen() {
188 local sflist sf line 225 local sflist sf line
189 226
190 einfo "Regenerating ${SITELISP}/site-gentoo.el ..." 227 einfon "Regenerating ${SITELISP}/site-gentoo.el ..."
191 cat <<-EOF >"${T}"/site-gentoo.el 228 cat <<-EOF >"${T}"/site-gentoo.el
192 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages 229 ;;; site-gentoo.el --- site initialisation for Gentoo-installed packages
193 230
194 ;;; Commentary: 231 ;;; Commentary:
195 ;; Automatically generated by elisp-common.eclass 232 ;; Automatically generated by elisp-common.eclass
212 249
213 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${T}"/site-gentoo.el; then 250 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${T}"/site-gentoo.el; then
214 # This prevents outputting unnecessary text when there 251 # This prevents outputting unnecessary text when there
215 # was actually no change 252 # was actually no change
216 # A case is a remerge where we have doubled output 253 # A case is a remerge where we have doubled output
217 einfo "... no changes" 254 echo " no changes."
218 else 255 else
219 mv "${T}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el 256 mv "${T}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
220 einfo "" 257 echo; einfo
221 for sf in ${sflist}; do 258 for sf in ${sflist}; do
222 einfo " Adding ${sf} ..." 259 einfo " Adding ${sf} ..."
223 done 260 done
224 while read line; do einfo "${line}"; done <<EOF 261 while read line; do einfo "${line}"; done <<EOF
225 262
226All site initialisation for Gentoo-installed packages is now added to 263All site initialisation for Gentoo-installed packages is added to
227/usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer 264/usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer
228managed by Gentoo. You are responsible for all maintenance of 265managed by Gentoo. You are responsible for all maintenance of
229site-start.el if there is such a file. 266site-start.el if there is such a file.
230 267
231In order for this site initialisation to be loaded for all users 268In order for this site initialisation to be loaded for all users
232automatically, as was done previously, you can add a line like this: 269automatically, you can add a line like this:
233 270
234 (load "/usr/share/emacs/site-lisp/site-gentoo" nil t) 271 (load "/usr/share/emacs/site-lisp/site-gentoo" nil t)
235 272
236to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line 273to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
237can be added by individual users to their initialisation files, or for 274can be added by individual users to their initialisation files, or for
240EOF 277EOF
241 echo 278 echo
242 fi 279 fi
243} 280}
244 281
245# The following Emacs Lisp compilation routine was originally taken from 282# @FUNCTION: elisp-comp
246# GNU autotools. 283# @USAGE: <list of elisp files>
284# @DESCRIPTION:
285# Byte-compile interdependent Emacs Lisp files.
286# Originally taken from GNU autotools.
247 287
248elisp-comp() { 288elisp-comp() {
249 # Copyright 1995 Free Software Foundation, Inc. 289 # Copyright 1995 Free Software Foundation, Inc.
250 # Fran├žois Pinard <pinard@iro.umontreal.ca>, 1995. 290 # Fran├žois Pinard <pinard@iro.umontreal.ca>, 1995.
251 # This script byte-compiles all `.el' files which are part of its 291 # This script byte-compiles all `.el' files which are part of its

Legend:
Removed from v.1.24  
changed lines
  Added in v.1.25

  ViewVC Help
Powered by ViewVC 1.1.20