/[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.10 Revision 1.23
1# Copyright 1999-2004 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.10 2005/05/03 09:20:13 usata Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.23 2007/07/09 13:40:58 flameeyes Exp $
4# 4#
5# Copyright 2007 Christian Faulhammer <opfer@gentoo.org>
5# Copyright 2002-2003 Matthew Kennedy <mkennedy@gentoo.org> 6# Copyright 2002-2007 Matthew Kennedy <mkennedy@gentoo.org>
6# Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com> 7# Copyright 2003 Jeremy Maitin-Shepard <jbms@attbi.com>
8# Copyright 2007 Ulrich Mueller <ulm@gentoo.org>
7# 9#
8# This is not an eclass, but it does provide emacs-related 10# This is not a real eclass, but it does provide Emacs-related installation
9# installation utilities. 11# utilities.
12#
13# USAGE:
14#
15# Usually you want to use this eclass for (optional) GNU Emacs support of
16# your package. This is NOT for XEmacs!
17# Many of the steps here are sometimes done by the build system of your
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#
106# pkg_postrm() {
107# elisp-site-regen
108# }
109#
110# When having optional Emacs support, you should prepend "use emacs &&" to
111# above calls of elisp-site-regen(). Don't use "has_version virtual/emacs"!
112# When unmerging the state of the USE flag emacs is taken from the package
113# database and not from the environment, so it is no problem when you unset
114# USE=emacs between merge und unmerge of a package.
115#
116# Miscellaneous functions:
117# ------------------------
118#
119# elisp-emacs-version() outputs the version of the currently active Emacs.
120#
121# As always: Feel free to contact Emacs team through emacs@gentoo.org if you
122# have problems, suggestions or questions.
10 123
11ECLASS=elisp-common 124IUSE="userland_GNU"
12INHERITED="$INHERITED $ECLASS"
13 125
14SITELISP=/usr/share/emacs/site-lisp 126SITELISP=/usr/share/emacs/site-lisp
15 127
16elisp-compile() { 128elisp-compile() {
17 /usr/bin/emacs --batch -f batch-byte-compile --no-site-file --no-init-file $* 129 einfo "Compiling GNU Emacs Elisp files ..."
130 /usr/bin/emacs -batch -q --no-site-file -f batch-byte-compile $*
131}
132
133elisp-emacs-version() {
134 # Output version of currently active Emacs.
135 # The following will work for at least versions 18-22.
136 echo "(princ emacs-version)" >"${T}"/emacs-version.el
137 /usr/bin/emacs -batch -q --no-site-file -l "${T}"/emacs-version.el
138}
139
140elisp-make-autoload-file () {
141 local f="${1:-${PN}-autoloads.el}"
142 shift
143 einfo "Generating autoload file for GNU Emacs ..."
144
145 sed 's/^FF/\f/' >"${f}" <<-EOF
146 ;;; ${f##*/} --- autoloads for ${P}
147
148 ;;; Commentary:
149 ;; Automatically generated by elisp-common.eclass
150 ;; DO NOT EDIT THIS FILE
151
152 ;;; Code:
153 FF
154 ;; Local Variables:
155 ;; version-control: never
156 ;; no-byte-compile: t
157 ;; no-update-autoloads: t
158 ;; End:
159 ;;; ${f##*/} ends here
160 EOF
161
162 /usr/bin/emacs -batch -q --no-site-file \
163 --eval "(setq make-backup-files nil)" \
164 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
165 -f batch-update-autoloads "${@-.}"
18} 166}
19 167
20elisp-install() { 168elisp-install() {
21 local subdir=$1 169 local subdir=$1
170 einfo "Installing Elisp files for GNU Emacs support ..."
22 dodir ${SITELISP}/${subdir} 171 dodir "${SITELISP}/${subdir}"
23 insinto ${SITELISP}/${subdir} 172 insinto "${SITELISP}/${subdir}"
24 shift 173 shift
25 doins $@ 174 doins $@
26} 175}
27 176
28elisp-site-file-install() { 177elisp-site-file-install() {
29 local sitefile=$1 my_pn=${2:-${PN}} 178 local sitefile=$1 my_pn=${2:-${PN}}
179 einfo "Installing site initialisation file for GNU Emacs ..."
30 pushd ${S} 180 pushd "${S}"
31 cp ${sitefile} ${T} 181 cp ${sitefile} "${T}"
32 sed -i "s:@SITELISP@:${SITELISP}/${my_pn}:g" ${T}/$(basename ${sitefile}) 182 sed -i "s:@SITELISP@:${SITELISP}/${my_pn}:g" "${T}/$(basename ${sitefile})"
33 insinto ${SITELISP} 183 insinto ${SITELISP}
34 doins ${T}/$(basename ${sitefile}) || die "failed to install site file" 184 doins "${T}/$(basename ${sitefile})" || die "failed to install site file"
35 popd 185 popd
36} 186}
37 187
38elisp-site-regen() { 188elisp-site-regen() {
189 local sflist sf line
190
39 einfo "Regenerating ${SITELISP}/site-gentoo.el ..." 191 einfo "Regenerating ${SITELISP}/site-gentoo.el ..."
40 einfo ""
41 cat <<EOF >${SITELISP}/site-gentoo.el 192 cat <<EOF >"${T}"/site-gentoo.el
42;;; DO NOT EDIT THIS FILE -- IT IS GENERATED AUTOMATICALLY BY PORTAGE 193;;; DO NOT EDIT THIS FILE -- IT IS GENERATED AUTOMATICALLY BY PORTAGE
43;;; ----------------------------------------------------------------- 194;;; -----------------------------------------------------------------
44 195
45EOF 196EOF
46 ls ${SITELISP}/[0-9][0-9]*-gentoo.el |sort -n | \ 197 for sf in "${ROOT}${SITELISP}"/[0-9][0-9]*-gentoo.el
47 while read sf
48 do 198 do
49 einfo " Adding $(basename $sf) ..." 199 [ -r "${sf}" ] || continue
50 # Great for debugging, too noisy and slow for users though 200 sflist="${sflist} $(basename "${sf}")"
51# echo "(message \"Loading $sf ...\")" >>${SITELISP}/site-start.el
52 cat $sf >>${SITELISP}/site-gentoo.el 201 cat "${sf}" >>"${T}"/site-gentoo.el
53 done 202 done
203
204 if cmp -s "${ROOT}${SITELISP}"/site-gentoo.el "${T}"/site-gentoo.el; then
205 # This prevents outputting unnecessary text when there
206 # was actually no change
207 # A case is a remerge where we have doubled output
208 einfo "... no changes"
209 else
210 local mvopts=""
211 use userland_GNU && mvopts="-b"
212 mv ${mvopts} "${T}"/site-gentoo.el "${ROOT}${SITELISP}"/site-gentoo.el
213 einfo ""
214 for sf in ${sflist}; do
215 einfo " Adding ${sf} ..."
216 done
54 while read line; do einfo "${line}"; done <<EOF 217 while read line; do einfo "${line}"; done <<EOF
55 218
56All site initialization for Gentoo-installed packages is now added to 219All site initialization for Gentoo-installed packages is now added to
57/usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer 220/usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer
58managed by Gentoo. You are responsible for all maintenance of 221managed by Gentoo. You are responsible for all maintenance of
59site-start.el if there is such a file. 222site-start.el if there is such a file.
60 223
61In order for this site initialization to be loaded for all users 224In order for this site initialization to be loaded for all users
62automatically, as was done previously, you can add a line like this: 225automatically, as was done previously, you can add a line like this:
63 226
64 (load "/usr/share/emacs/site-lisp/site-gentoo") 227 (load "/usr/share/emacs/site-lisp/site-gentoo" nil t)
65 228
66to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line 229to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
67can be added by individual users to their initialization files, or for 230can be added by individual users to their initialization files, or for
68greater flexibility, users can select which of the package-specific 231greater flexibility, users can select which of the package-specific
69initialization files in /usr/share/emacs/site-lisp to load. 232initialization files in /usr/share/emacs/site-lisp to load.
70EOF 233EOF
71 echo 234 echo
235 fi
72} 236}
73 237
74# The following Emacs Lisp compilation routine is taken from GNU 238# The following Emacs Lisp compilation routine is taken from GNU
75# autotools. 239# autotools.
76 240
77elisp-comp() { 241elisp-comp() {
78# Copyright 1995 Free Software Foundation, Inc. 242 # Copyright 1995 Free Software Foundation, Inc.
79# Franois Pinard <pinard@iro.umontreal.ca>, 1995. 243 # Franรงois Pinard <pinard@iro.umontreal.ca>, 1995.
80#
81# This program is free software; you can redistribute it and/or modify
82# it under the terms of the GNU General Public License as published by
83# the Free Software Foundation; either version 2, or (at your option)
84# any later version.
85#
86# This program is distributed in the hope that it will be useful,
87# but WITHOUT ANY WARRANTY; without even the implied warranty of
88# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
89# GNU General Public License for more details.
90#
91# You should have received a copy of the GNU General Public License
92# along with this program; if not, write to the Free Software
93# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
94
95# As a special exception to the GNU General Public License, if you
96# distribute this file as part of a program that contains a
97# configuration script generated by Autoconf, you may include it under
98# the same distribution terms that you use for the rest of that program.
99
100# This script byte-compiles all `.el' files which are part of its 244 # This script byte-compiles all `.el' files which are part of its
101# arguments, using GNU Emacs, and put the resulting `.elc' files into 245 # arguments, using GNU Emacs, and put the resulting `.elc' files into
102# the current directory, so disregarding the original directories used 246 # the current directory, so disregarding the original directories used
103# in `.el' arguments. 247 # in `.el' arguments.
104# 248 #
105# This script manages in such a way that all Emacs LISP files to 249 # This script manages in such a way that all Emacs LISP files to
106# be compiled are made visible between themselves, in the event 250 # be compiled are made visible between themselves, in the event
107# they require or load-library one another. 251 # they require or load-library one another.
108 252
109 if test $# = 0; then 253 test $# -gt 0 || return 1
110 echo 1>&2 "No files given to $0" 254
111 exit 1
112 else
113 if test -z "$EMACS" || test "$EMACS" = "t"; then 255 if test -z "${EMACS}" || test "${EMACS}" = "t"; then
114 # Value of "t" means we are running in a shell under Emacs. 256 # Value of "t" means we are running in a shell under Emacs.
115 # Just assume Emacs is called "emacs". 257 # Just assume Emacs is called "emacs".
116 EMACS=emacs 258 EMACS=/usr/bin/emacs
117 fi
118
119 tempdir=elc.$$
120 mkdir $tempdir
121 cp $* $tempdir
122 cd $tempdir
123
124 echo "(add-to-list 'load-path \"../\")" > script
125 $EMACS -batch -q --no-site-file --no-init-file -l script -f batch-byte-compile *.el
126 mv *.elc ..
127
128 cd ..
129 rm -fr $tempdir
130 fi 259 fi
131} 260 einfo "Compiling GNU Emacs Elisp files ..."
132 261
133# Local Variables: *** 262 tempdir=elc.$$
134# mode: shell-script *** 263 mkdir ${tempdir}
135# tab-width: 4 *** 264 cp $* ${tempdir}
136# indent-tabs-mode: t *** 265 pushd ${tempdir}
137# End: ***
138 266
267 echo "(add-to-list 'load-path \"../\")" > script
268 ${EMACS} -batch -q --no-site-file --no-init-file -l script \
269 -f batch-byte-compile *.el
270 local status=$?
271 mv *.elc ..
272
273 popd
274 rm -fr ${tempdir}
275 return ${status}
276}

Legend:
Removed from v.1.10  
changed lines
  Added in v.1.23

  ViewVC Help
Powered by ViewVC 1.1.20