/[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.11 Revision 1.21
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.11 2005/07/06 20:20:03 agriffis Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/elisp-common.eclass,v 1.21 2007/05/26 08:34:08 ulm 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.
10 12#
11INHERITED="$INHERITED $ECLASS" 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# 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.
12 111
13SITELISP=/usr/share/emacs/site-lisp 112SITELISP=/usr/share/emacs/site-lisp
14 113
15elisp-compile() { 114elisp-compile() {
16 /usr/bin/emacs --batch -f batch-byte-compile --no-site-file --no-init-file $* 115 /usr/bin/emacs --batch -f batch-byte-compile --no-site-file --no-init-file $*
17} 116}
18 117
118elisp-make-autoload-file () {
119 local f="${1:-${PN}-autoloads.el}"
120 shift
121 sed 's/^FF/\f/' >"${f}" <<-EOF
122 ;;; ${f##*/} --- autoloads for ${P}
123
124 ;;; Commentary:
125 ;; Automatically generated by elisp-common.eclass
126 ;; DO NOT EDIT THIS FILE
127
128 ;;; Code:
129 FF
130 ;; Local Variables:
131 ;; version-control: never
132 ;; no-byte-compile: t
133 ;; no-update-autoloads: t
134 ;; End:
135 ;;; ${f##*/} ends here
136 EOF
137 emacs --batch -q --no-site-file \
138 --eval "(setq make-backup-files nil)" \
139 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
140 -f batch-update-autoloads "${@-.}"
141}
142
19elisp-install() { 143elisp-install() {
20 local subdir=$1 144 local subdir=$1
21 dodir ${SITELISP}/${subdir} 145 dodir "${SITELISP}/${subdir}"
22 insinto ${SITELISP}/${subdir} 146 insinto "${SITELISP}/${subdir}"
23 shift 147 shift
24 doins $@ 148 doins $@
25} 149}
26 150
27elisp-site-file-install() { 151elisp-site-file-install() {
28 local sitefile=$1 my_pn=${2:-${PN}} 152 local sitefile=$1 my_pn=${2:-${PN}}
29 pushd ${S} 153 pushd "${S}"
30 cp ${sitefile} ${T} 154 cp ${sitefile} "${T}"
31 sed -i "s:@SITELISP@:${SITELISP}/${my_pn}:g" ${T}/$(basename ${sitefile}) 155 sed -i "s:@SITELISP@:${SITELISP}/${my_pn}:g" "${T}/$(basename ${sitefile})"
32 insinto ${SITELISP} 156 insinto ${SITELISP}
33 doins ${T}/$(basename ${sitefile}) || die "failed to install site file" 157 doins "${T}/$(basename ${sitefile})" || die "failed to install site file"
34 popd 158 popd
35} 159}
36 160
37elisp-site-regen() { 161elisp-site-regen() {
38 einfo "Regenerating ${SITELISP}/site-gentoo.el ..." 162 einfo "Regenerating ${SITELISP}/site-gentoo.el ..."
39 einfo "" 163 einfo ""
40 cat <<EOF >${SITELISP}/site-gentoo.el 164 cat <<EOF >${ROOT}${SITELISP}/site-gentoo.el
41;;; DO NOT EDIT THIS FILE -- IT IS GENERATED AUTOMATICALLY BY PORTAGE 165;;; DO NOT EDIT THIS FILE -- IT IS GENERATED AUTOMATICALLY BY PORTAGE
42;;; ----------------------------------------------------------------- 166;;; -----------------------------------------------------------------
43 167
44EOF 168EOF
45 ls ${SITELISP}/[0-9][0-9]*-gentoo.el |sort -n | \ 169 for sf in ${ROOT}${SITELISP}/[0-9][0-9]*-gentoo.el
46 while read sf
47 do 170 do
171 [ -r "${sf}" ] || continue
48 einfo " Adding $(basename $sf) ..." 172 einfo " Adding $(basename ${sf}) ..."
49 # Great for debugging, too noisy and slow for users though
50# echo "(message \"Loading $sf ...\")" >>${SITELISP}/site-start.el
51 cat $sf >>${SITELISP}/site-gentoo.el 173 cat "${sf}" >>${ROOT}${SITELISP}/site-gentoo.el
52 done 174 done
53 while read line; do einfo "${line}"; done <<EOF 175 while read line; do einfo "${line}"; done <<EOF
54 176
55All site initialization for Gentoo-installed packages is now added to 177All site initialization for Gentoo-installed packages is now added to
56/usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer 178/usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer
58site-start.el if there is such a file. 180site-start.el if there is such a file.
59 181
60In order for this site initialization to be loaded for all users 182In order for this site initialization to be loaded for all users
61automatically, as was done previously, you can add a line like this: 183automatically, as was done previously, you can add a line like this:
62 184
63 (load "/usr/share/emacs/site-lisp/site-gentoo") 185 (load "/usr/share/emacs/site-lisp/site-gentoo" nil t)
64 186
65to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line 187to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
66can be added by individual users to their initialization files, or for 188can be added by individual users to their initialization files, or for
67greater flexibility, users can select which of the package-specific 189greater flexibility, users can select which of the package-specific
68initialization files in /usr/share/emacs/site-lisp to load. 190initialization files in /usr/share/emacs/site-lisp to load.
73# The following Emacs Lisp compilation routine is taken from GNU 195# The following Emacs Lisp compilation routine is taken from GNU
74# autotools. 196# autotools.
75 197
76elisp-comp() { 198elisp-comp() {
77# Copyright 1995 Free Software Foundation, Inc. 199# Copyright 1995 Free Software Foundation, Inc.
78# Franois Pinard <pinard@iro.umontreal.ca>, 1995. 200# Franรงois Pinard <pinard@iro.umontreal.ca>, 1995.
79#
80# This program is free software; you can redistribute it and/or modify
81# it under the terms of the GNU General Public License as published by
82# the Free Software Foundation; either version 2, or (at your option)
83# any later version.
84#
85# This program is distributed in the hope that it will be useful,
86# but WITHOUT ANY WARRANTY; without even the implied warranty of
87# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
88# GNU General Public License for more details.
89#
90# You should have received a copy of the GNU General Public License
91# along with this program; if not, write to the Free Software
92# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
93
94# As a special exception to the GNU General Public License, if you
95# distribute this file as part of a program that contains a
96# configuration script generated by Autoconf, you may include it under
97# the same distribution terms that you use for the rest of that program.
98
99# This script byte-compiles all `.el' files which are part of its 201# This script byte-compiles all `.el' files which are part of its
100# arguments, using GNU Emacs, and put the resulting `.elc' files into 202# arguments, using GNU Emacs, and put the resulting `.elc' files into
101# the current directory, so disregarding the original directories used 203# the current directory, so disregarding the original directories used
102# in `.el' arguments. 204# in `.el' arguments.
103# 205#
104# This script manages in such a way that all Emacs LISP files to 206# This script manages in such a way that all Emacs LISP files to
105# be compiled are made visible between themselves, in the event 207# be compiled are made visible between themselves, in the event
106# they require or load-library one another. 208# they require or load-library one another.
107 209
108 if test $# = 0; then 210 if test $# = 0; then
109 echo 1>&2 "No files given to $0"
110 exit 1 211 exit 1
111 else 212 else
112 if test -z "$EMACS" || test "$EMACS" = "t"; then 213 if test -z "${EMACS}" || test "${EMACS}" = "t"; then
113 # Value of "t" means we are running in a shell under Emacs. 214 # Value of "t" means we are running in a shell under Emacs.
114 # Just assume Emacs is called "emacs". 215 # Just assume Emacs is called "emacs".
115 EMACS=emacs 216 EMACS=emacs
116 fi 217 fi
117 218
118 tempdir=elc.$$ 219 tempdir=elc.$$
119 mkdir $tempdir 220 mkdir ${tempdir}
120 cp $* $tempdir 221 cp $* ${tempdir}
121 cd $tempdir 222 cd ${tempdir}
122 223
123 echo "(add-to-list 'load-path \"../\")" > script 224 echo "(add-to-list 'load-path \"../\")" > script
124 $EMACS -batch -q --no-site-file --no-init-file -l script -f batch-byte-compile *.el 225 ${EMACS} -batch -q --no-site-file --no-init-file -l script -f batch-byte-compile *.el
125 mv *.elc .. 226 mv *.elc ..
126 227
127 cd .. 228 cd ..
128 rm -fr $tempdir 229 rm -fr ${tempdir}
129 fi 230 fi
130} 231}
131
132# Local Variables: ***
133# mode: shell-script ***
134# tab-width: 4 ***
135# indent-tabs-mode: t ***
136# End: ***
137

Legend:
Removed from v.1.11  
changed lines
  Added in v.1.21

  ViewVC Help
Powered by ViewVC 1.1.20