Mercurial > emacs
annotate lisp/emacs-lisp/shadow.el @ 67892:e188efbb47ee
(Using Customize): New node.
author | Romain Francoise <romain@orebokech.com> |
---|---|
date | Thu, 29 Dec 2005 14:08:09 +0000 |
parents | ef7892af4fa7 |
children | 067115a6e738 7beb78bc1f8e |
rev | line source |
---|---|
38436
b174db545cfd
Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents:
22170
diff
changeset
|
1 ;;; shadow.el --- locate Emacs Lisp file shadowings |
14058 | 2 |
64751
5b1a238fcbb4
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
64085
diff
changeset
|
3 ;; Copyright (C) 1995, 2002, 2003, 2004, 2005 Free Software Foundation, Inc. |
14058 | 4 |
5 ;; Author: Terry Jones <terry@santafe.edu> | |
6 ;; Keywords: lisp | |
7 ;; Created: 15 December 1995 | |
8 | |
9 ;; This file is part of GNU Emacs. | |
10 | |
11 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
12 ;; it under the terms of the GNU General Public License as published by | |
13 ;; the Free Software Foundation; either version 2, or (at your option) | |
14 ;; any later version. | |
15 | |
16 ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 ;; GNU General Public License for more details. | |
20 | |
21 ;; You should have received a copy of the GNU General Public License | |
14169 | 22 ;; along with GNU Emacs; see the file COPYING. If not, write to the |
64085 | 23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
24 ;; Boston, MA 02110-1301, USA. | |
14058 | 25 |
26 ;;; Commentary: | |
14169 | 27 |
14058 | 28 ;; The functions in this file detect (`find-emacs-lisp-shadows') |
29 ;; and display (`list-load-path-shadows') potential load-path | |
30 ;; problems that arise when Emacs Lisp files "shadow" each other. | |
31 ;; | |
32 ;; For example, a file XXX.el early in one's load-path will shadow | |
33 ;; a file with the same name in a later load-path directory. When | |
34 ;; this is unintentional, it may result in problems that could have | |
35 ;; been easily avoided. This occurs often (to me) when installing a | |
36 ;; new version of emacs and something in the site-lisp directory | |
37 ;; has been updated and added to the emacs distribution. The old | |
38 ;; version, now outdated, shadows the new one. This is obviously | |
39 ;; undesirable. | |
40 ;; | |
41 ;; The `list-load-path-shadows' function was run when you installed | |
42 ;; this version of emacs. To run it by hand in emacs: | |
43 ;; | |
44 ;; M-x load-library RET shadow RET | |
45 ;; M-x list-load-path-shadows | |
46 ;; | |
47 ;; or run it non-interactively via: | |
48 ;; | |
49 ;; emacs -batch -l shadow.el -f list-load-path-shadows | |
50 ;; | |
51 ;; Thanks to Francesco Potorti` <pot@cnuce.cnr.it> for suggestions, | |
52 ;; rewritings & speedups. | |
53 | |
54 ;;; Code: | |
55 | |
48459
f1f792410820
(defgroup lisp-shadow): New group name. Previous group name shadow is
Markus Rost <rost@math.uni-bielefeld.de>
parents:
44203
diff
changeset
|
56 (defgroup lisp-shadow nil |
21365 | 57 "Locate Emacs Lisp file shadowings." |
58 :prefix "shadows-" | |
59 :group 'lisp) | |
60 | |
61 (defcustom shadows-compare-text-p nil | |
19982 | 62 "*If non-nil, then shadowing files are reported only if their text differs. |
21365 | 63 This is slower, but filters out some innocuous shadowing." |
64 :type 'boolean | |
48459
f1f792410820
(defgroup lisp-shadow): New group name. Previous group name shadow is
Markus Rost <rost@math.uni-bielefeld.de>
parents:
44203
diff
changeset
|
65 :group 'lisp-shadow) |
19982 | 66 |
14058 | 67 (defun find-emacs-lisp-shadows (&optional path) |
68 "Return a list of Emacs Lisp files that create shadows. | |
69 This function does the work for `list-load-path-shadows'. | |
70 | |
71 We traverse PATH looking for shadows, and return a \(possibly empty\) | |
72 even-length list of files. A file in this list at position 2i shadows | |
73 the file in position 2i+1. Emacs Lisp file suffixes \(.el and .elc\) | |
74 are stripped from the file names in the list. | |
75 | |
76 See the documentation for `list-load-path-shadows' for further information." | |
49598
0d8b17d428b5
Trailing whitepace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48459
diff
changeset
|
77 |
14058 | 78 (or path (setq path load-path)) |
79 | |
80 (let (true-names ; List of dirs considered. | |
81 shadows ; List of shadowings, to be returned. | |
82 files ; File names ever seen, with dirs. | |
83 dir ; The dir being currently scanned. | |
84 curr-files ; This dir's Emacs Lisp files. | |
85 orig-dir ; Where the file was first seen. | |
86 files-seen-this-dir ; Files seen so far in this dir. | |
87 file) ; The current file. | |
88 | |
49598
0d8b17d428b5
Trailing whitepace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48459
diff
changeset
|
89 |
14058 | 90 (while path |
91 | |
19982 | 92 (setq dir (directory-file-name (file-truename (or (car path) ".")))) |
14058 | 93 (if (member dir true-names) |
94 ;; We have already considered this PATH redundant directory. | |
95 ;; Show the redundancy if we are interactiver, unless the PATH | |
96 ;; dir is nil or "." (these redundant directories are just a | |
97 ;; result of the current working directory, and are therefore | |
98 ;; not always redundant). | |
99 (or noninteractive | |
100 (and (car path) | |
101 (not (string= (car path) ".")) | |
15736
73a325c414a5
(list-load-path-shadows): Fix ambiguous wording.
Karl Heuer <kwzh@gnu.org>
parents:
14348
diff
changeset
|
102 (message "Ignoring redundant directory %s" (car path)))) |
19982 | 103 |
14058 | 104 (setq true-names (append true-names (list dir))) |
19982 | 105 (setq dir (directory-file-name (or (car path) "."))) |
14058 | 106 (setq curr-files (if (file-accessible-directory-p dir) |
67018 | 107 (directory-files dir nil ".\\.elc?\\(\\.gz\\)?$" t))) |
14058 | 108 (and curr-files |
109 (not noninteractive) | |
15736
73a325c414a5
(list-load-path-shadows): Fix ambiguous wording.
Karl Heuer <kwzh@gnu.org>
parents:
14348
diff
changeset
|
110 (message "Checking %d files in %s..." (length curr-files) dir)) |
19982 | 111 |
14058 | 112 (setq files-seen-this-dir nil) |
113 | |
114 (while curr-files | |
115 | |
116 (setq file (car curr-files)) | |
67018 | 117 (if (string-match "\\.gz$" file) |
118 (setq file (substring file 0 -3))) | |
14058 | 119 (setq file (substring |
120 file 0 (if (string= (substring file -1) "c") -4 -3))) | |
121 | |
19226
c160218de690
(find-emacs-lisp-shadows): Don't mention `subdirs.el'.
Richard M. Stallman <rms@gnu.org>
parents:
15756
diff
changeset
|
122 ;; FILE now contains the current file name, with no suffix. |
c160218de690
(find-emacs-lisp-shadows): Don't mention `subdirs.el'.
Richard M. Stallman <rms@gnu.org>
parents:
15756
diff
changeset
|
123 (unless (or (member file files-seen-this-dir) |
c160218de690
(find-emacs-lisp-shadows): Don't mention `subdirs.el'.
Richard M. Stallman <rms@gnu.org>
parents:
15756
diff
changeset
|
124 ;; Ignore these files. |
c160218de690
(find-emacs-lisp-shadows): Don't mention `subdirs.el'.
Richard M. Stallman <rms@gnu.org>
parents:
15756
diff
changeset
|
125 (member file '("subdirs"))) |
14058 | 126 ;; File has not been seen yet in this directory. |
127 ;; This test prevents us declaring that XXX.el shadows | |
128 ;; XXX.elc (or vice-versa) when they are in the same directory. | |
129 (setq files-seen-this-dir (cons file files-seen-this-dir)) | |
49598
0d8b17d428b5
Trailing whitepace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48459
diff
changeset
|
130 |
14058 | 131 (if (setq orig-dir (assoc file files)) |
132 ;; This file was seen before, we have a shadowing. | |
19982 | 133 ;; Report it unless the files are identical. |
134 (let ((base1 (concat (cdr orig-dir) "/" file)) | |
135 (base2 (concat dir "/" file))) | |
136 (if (not (and shadows-compare-text-p | |
137 (shadow-same-file-or-nonexistent | |
138 (concat base1 ".el") (concat base2 ".el")) | |
139 ;; This is a bit strict, but safe. | |
140 (shadow-same-file-or-nonexistent | |
141 (concat base1 ".elc") (concat base2 ".elc")))) | |
22170 | 142 (setq shadows |
143 (append shadows (list base1 base2))))) | |
14058 | 144 |
145 ;; Not seen before, add it to the list of seen files. | |
146 (setq files (cons (cons file dir) files)))) | |
147 | |
148 (setq curr-files (cdr curr-files)))) | |
149 (setq path (cdr path))) | |
150 | |
151 ;; Return the list of shadowings. | |
152 shadows)) | |
153 | |
19982 | 154 ;; Return true if neither file exists, or if both exist and have identical |
155 ;; contents. | |
156 (defun shadow-same-file-or-nonexistent (f1 f2) | |
157 (let ((exists1 (file-exists-p f1)) | |
158 (exists2 (file-exists-p f2))) | |
159 (or (and (not exists1) (not exists2)) | |
160 (and exists1 exists2 | |
161 (or (equal (file-truename f1) (file-truename f2)) | |
162 ;; As a quick test, avoiding spawning a process, compare file | |
163 ;; sizes. | |
164 (and (= (nth 7 (file-attributes f1)) | |
165 (nth 7 (file-attributes f2))) | |
53477
79093b308520
* progmodes/idlwave.el (idlwave-make-tags):
Eli Zaretskii <eliz@is.elta.co.il>
parents:
52401
diff
changeset
|
166 (eq 0 (call-process "cmp" nil nil nil "-s" f1 f2)))))))) |
14058 | 167 |
168 ;;;###autoload | |
169 (defun list-load-path-shadows () | |
15756
30e9db641e6f
(list-load-path-shadows): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
15736
diff
changeset
|
170 "Display a list of Emacs Lisp files that shadow other files. |
14058 | 171 |
172 This function lists potential load-path problems. Directories in the | |
173 `load-path' variable are searched, in order, for Emacs Lisp | |
15756
30e9db641e6f
(list-load-path-shadows): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
15736
diff
changeset
|
174 files. When a previously encountered file name is found again, a |
30e9db641e6f
(list-load-path-shadows): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
15736
diff
changeset
|
175 message is displayed indicating that the later file is \"hidden\" by |
14058 | 176 the earlier. |
177 | |
178 For example, suppose `load-path' is set to | |
179 | |
180 \(\"/usr/gnu/emacs/site-lisp\" \"/usr/gnu/emacs/share/emacs/19.30/lisp\"\) | |
181 | |
182 and that each of these directories contains a file called XXX.el. Then | |
183 XXX.el in the site-lisp directory is referred to by all of: | |
184 \(require 'XXX\), \(autoload .... \"XXX\"\), \(load-library \"XXX\"\) etc. | |
185 | |
186 The first XXX.el file prevents emacs from seeing the second \(unless | |
187 the second is loaded explicitly via load-file\). | |
188 | |
189 When not intended, such shadowings can be the source of subtle | |
190 problems. For example, the above situation may have arisen because the | |
191 XXX package was not distributed with versions of emacs prior to | |
192 19.30. An emacs maintainer downloaded XXX from elsewhere and installed | |
193 it. Later, XXX was updated and included in the emacs distribution. | |
194 Unless the emacs maintainer checks for this, the new version of XXX | |
195 will be hidden behind the old \(which may no longer work with the new | |
196 emacs version\). | |
197 | |
198 This function performs these checks and flags all possible | |
199 shadowings. Because a .el file may exist without a corresponding .elc | |
200 \(or vice-versa\), these suffixes are essentially ignored. A file | |
201 XXX.elc in an early directory \(that does not contain XXX.el\) is | |
202 considered to shadow a later file XXX.el, and vice-versa. | |
203 | |
204 When run interactively, the shadowings \(if any\) are displayed in a | |
205 buffer called `*Shadows*'. Shadowings are located by calling the | |
206 \(non-interactive\) companion function, `find-emacs-lisp-shadows'." | |
49598
0d8b17d428b5
Trailing whitepace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
48459
diff
changeset
|
207 |
14058 | 208 (interactive) |
19313
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
209 (let* ((path (copy-sequence load-path)) |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
210 (tem path) |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
211 toplevs) |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
212 ;; If we can find simple.el in two places, |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
213 (while tem |
67018 | 214 (if (or (file-exists-p (expand-file-name "simple.el" (car tem))) |
215 (file-exists-p (expand-file-name "simple.el.gz" (car tem)))) | |
19313
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
216 (setq toplevs (cons (car tem) toplevs))) |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
217 (setq tem (cdr tem))) |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
218 (if (> (length toplevs) 1) |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
219 ;; Cut off our copy of load-path right before |
44203
621fbfd0bf87
(list-load-path-shadows): Only ignore last copy of standard Lisp
Richard M. Stallman <rms@gnu.org>
parents:
38436
diff
changeset
|
220 ;; the last directory which has simple.el in it. |
19313
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
221 ;; This avoids loads of duplications between the source dir |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
222 ;; and the dir where these files were copied by installation. |
44203
621fbfd0bf87
(list-load-path-shadows): Only ignore last copy of standard Lisp
Richard M. Stallman <rms@gnu.org>
parents:
38436
diff
changeset
|
223 (let ((break (car toplevs))) |
19313
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
224 (setq tem path) |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
225 (while tem |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
226 (if (eq (nth 1 tem) break) |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
227 (progn |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
228 (setcdr tem nil) |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
229 (setq tem nil))) |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
230 (setq tem (cdr tem))))) |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
231 |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
232 (let* ((shadows (find-emacs-lisp-shadows path)) |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
233 (n (/ (length shadows) 2)) |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
234 (msg (format "%s Emacs Lisp load-path shadowing%s found" |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
235 (if (zerop n) "No" (concat "\n" (number-to-string n))) |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
236 (if (= n 1) " was" "s were")))) |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
237 (if (interactive-p) |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
238 (save-excursion |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
239 ;; We are interactive. |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
240 ;; Create the *Shadows* buffer and display shadowings there. |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
241 (let ((output-buffer (get-buffer-create "*Shadows*"))) |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
242 (display-buffer output-buffer) |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
243 (set-buffer output-buffer) |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
244 (erase-buffer) |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
245 (while shadows |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
246 (insert (format "%s hides %s\n" (car shadows) |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
247 (car (cdr shadows)))) |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
248 (setq shadows (cdr (cdr shadows)))) |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
249 (insert msg "\n"))) |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
250 ;; We are non-interactive, print shadows via message. |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
251 (when shadows |
04175c55c49b
(list-load-path-shadows): Exclude, from the path we search, all but
Richard M. Stallman <rms@gnu.org>
parents:
19226
diff
changeset
|
252 (message "This site has duplicate Lisp libraries with the same name. |
19226
c160218de690
(find-emacs-lisp-shadows): Don't mention `subdirs.el'.
Richard M. Stallman <rms@gnu.org>
parents:
15756
diff
changeset
|
253 If a locally-installed Lisp library overrides a library in the Emacs release, |
c160218de690
(find-emacs-lisp-shadows): Don't mention `subdirs.el'.
Richard M. Stallman <rms@gnu.org>
parents:
15756
diff
changeset
|
254 that can cause trouble, and you should probably remove the locally-installed |
21927
8332fee2c358
(list-load-path-shadows): Don't say
Richard M. Stallman <rms@gnu.org>
parents:
21365
diff
changeset
|
255 version unless you know what you are doing.\n") |
8332fee2c358
(list-load-path-shadows): Don't say
Richard M. Stallman <rms@gnu.org>
parents:
21365
diff
changeset
|
256 (while shadows |
8332fee2c358
(list-load-path-shadows): Don't say
Richard M. Stallman <rms@gnu.org>
parents:
21365
diff
changeset
|
257 (message "%s hides %s" (car shadows) (car (cdr shadows))) |
8332fee2c358
(list-load-path-shadows): Don't say
Richard M. Stallman <rms@gnu.org>
parents:
21365
diff
changeset
|
258 (setq shadows (cdr (cdr shadows)))) |
8332fee2c358
(list-load-path-shadows): Don't say
Richard M. Stallman <rms@gnu.org>
parents:
21365
diff
changeset
|
259 (message "%s" msg)))))) |
14058 | 260 |
261 (provide 'shadow) | |
262 | |
52401 | 263 ;;; arch-tag: 0480e8a7-62ed-4a12-a9f6-f44ded9b0830 |
14058 | 264 ;;; shadow.el ends here |