/[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.19
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.19 2007/04/27 16:10:48 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#
11ECLASS=elisp-common 13# USAGE:
12INHERITED="$INHERITED $ECLASS" 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.
13 111
14SITELISP=/usr/share/emacs/site-lisp 112SITELISP=/usr/share/emacs/site-lisp
15 113
16elisp-compile() { 114elisp-compile() {
17 /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 $*
18} 116}
19 117
118elisp-make-autoload-file () {
119 local f="${1:-${PN}-autoloads.el}"
120 shift
121 echo >"${f}"
122 emacs --batch -q --no-site-file \
123 --eval "(setq make-backup-files nil)" \
124 --eval "(setq generated-autoload-file (expand-file-name \"${f}\"))" \
125 -f batch-update-autoloads "${@-.}"
126}
127
20elisp-install() { 128elisp-install() {
21 local subdir=$1 129 local subdir=$1
22 dodir ${SITELISP}/${subdir} 130 dodir "${SITELISP}/${subdir}"
23 insinto ${SITELISP}/${subdir} 131 insinto "${SITELISP}/${subdir}"
24 shift 132 shift
25 doins $@ 133 doins $@
26} 134}
27 135
28elisp-site-file-install() { 136elisp-site-file-install() {
29 local sitefile=$1 my_pn=${2:-${PN}} 137 local sitefile=$1 my_pn=${2:-${PN}}
30 pushd ${S} 138 pushd "${S}"
31 cp ${sitefile} ${T} 139 cp ${sitefile} "${T}"
32 sed -i "s:@SITELISP@:${SITELISP}/${my_pn}:g" ${T}/$(basename ${sitefile}) 140 sed -i "s:@SITELISP@:${SITELISP}/${my_pn}:g" "${T}/$(basename ${sitefile})"
33 insinto ${SITELISP} 141 insinto ${SITELISP}
34 doins ${T}/$(basename ${sitefile}) || die "failed to install site file" 142 doins "${T}/$(basename ${sitefile})" || die "failed to install site file"
35 popd 143 popd
36} 144}
37 145
38elisp-site-regen() { 146elisp-site-regen() {
39 einfo "Regenerating ${SITELISP}/site-gentoo.el ..." 147 einfo "Regenerating ${SITELISP}/site-gentoo.el ..."
40 einfo "" 148 einfo ""
41 cat <<EOF >${SITELISP}/site-gentoo.el 149 cat <<EOF >${ROOT}${SITELISP}/site-gentoo.el
42;;; DO NOT EDIT THIS FILE -- IT IS GENERATED AUTOMATICALLY BY PORTAGE 150;;; DO NOT EDIT THIS FILE -- IT IS GENERATED AUTOMATICALLY BY PORTAGE
43;;; ----------------------------------------------------------------- 151;;; -----------------------------------------------------------------
44 152
45EOF 153EOF
46 ls ${SITELISP}/[0-9][0-9]*-gentoo.el |sort -n | \ 154 ls ${ROOT}${SITELISP}/[0-9][0-9]*-gentoo.el | sort -n | \
47 while read sf 155 while read sf
48 do 156 do
49 einfo " Adding $(basename $sf) ..." 157 einfo " Adding $(basename $sf) ..."
50 # Great for debugging, too noisy and slow for users though 158 # Great for debugging, too noisy and slow for users though
51# echo "(message \"Loading $sf ...\")" >>${SITELISP}/site-start.el 159# echo "(message \"Loading $sf ...\")" >>${ROOT}${SITELISP}/site-start.el
52 cat $sf >>${SITELISP}/site-gentoo.el 160 cat $sf >>${ROOT}${SITELISP}/site-gentoo.el
53 done 161 done
54 while read line; do einfo "${line}"; done <<EOF 162 while read line; do einfo "${line}"; done <<EOF
55 163
56All site initialization for Gentoo-installed packages is now added to 164All 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 165/usr/share/emacs/site-lisp/site-gentoo.el; site-start.el is no longer
59site-start.el if there is such a file. 167site-start.el if there is such a file.
60 168
61In order for this site initialization to be loaded for all users 169In order for this site initialization to be loaded for all users
62automatically, as was done previously, you can add a line like this: 170automatically, as was done previously, you can add a line like this:
63 171
64 (load "/usr/share/emacs/site-lisp/site-gentoo") 172 (load "/usr/share/emacs/site-lisp/site-gentoo" nil t)
65 173
66to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line 174to /usr/share/emacs/site-lisp/site-start.el. Alternatively, that line
67can be added by individual users to their initialization files, or for 175can be added by individual users to their initialization files, or for
68greater flexibility, users can select which of the package-specific 176greater flexibility, users can select which of the package-specific
69initialization files in /usr/share/emacs/site-lisp to load. 177initialization files in /usr/share/emacs/site-lisp to load.
74# The following Emacs Lisp compilation routine is taken from GNU 182# The following Emacs Lisp compilation routine is taken from GNU
75# autotools. 183# autotools.
76 184
77elisp-comp() { 185elisp-comp() {
78# Copyright 1995 Free Software Foundation, Inc. 186# Copyright 1995 Free Software Foundation, Inc.
79# Franois Pinard <pinard@iro.umontreal.ca>, 1995. 187# 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 188# This script byte-compiles all `.el' files which are part of its
101# arguments, using GNU Emacs, and put the resulting `.elc' files into 189# arguments, using GNU Emacs, and put the resulting `.elc' files into
102# the current directory, so disregarding the original directories used 190# the current directory, so disregarding the original directories used
103# in `.el' arguments. 191# in `.el' arguments.
104# 192#
105# This script manages in such a way that all Emacs LISP files to 193# This script manages in such a way that all Emacs LISP files to
106# be compiled are made visible between themselves, in the event 194# be compiled are made visible between themselves, in the event
107# they require or load-library one another. 195# they require or load-library one another.
108 196
109 if test $# = 0; then 197 if test $# = 0; then
110 echo 1>&2 "No files given to $0"
111 exit 1 198 exit 1
112 else 199 else
113 if test -z "$EMACS" || test "$EMACS" = "t"; then 200 if test -z "${EMACS}" || test "${EMACS}" = "t"; then
114 # Value of "t" means we are running in a shell under Emacs. 201 # Value of "t" means we are running in a shell under Emacs.
115 # Just assume Emacs is called "emacs". 202 # Just assume Emacs is called "emacs".
116 EMACS=emacs 203 EMACS=emacs
117 fi 204 fi
118 205
119 tempdir=elc.$$ 206 tempdir=elc.$$
120 mkdir $tempdir 207 mkdir ${tempdir}
121 cp $* $tempdir 208 cp $* ${tempdir}
122 cd $tempdir 209 cd ${tempdir}
123 210
124 echo "(add-to-list 'load-path \"../\")" > script 211 echo "(add-to-list 'load-path \"../\")" > script
125 $EMACS -batch -q --no-site-file --no-init-file -l script -f batch-byte-compile *.el 212 ${EMACS} -batch -q --no-site-file --no-init-file -l script -f batch-byte-compile *.el
126 mv *.elc .. 213 mv *.elc ..
127 214
128 cd .. 215 cd ..
129 rm -fr $tempdir 216 rm -fr ${tempdir}
130 fi 217 fi
131} 218}
132
133# Local Variables: ***
134# mode: shell-script ***
135# tab-width: 4 ***
136# indent-tabs-mode: t ***
137# End: ***
138

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

  ViewVC Help
Powered by ViewVC 1.1.20