annotate lisp/emacs-lisp/shadow.el @ 91962:37c6e66c7e57

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