Mercurial > hg > xemacs-beta
annotate lisp/loadhist.el @ 4539:061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
lib-src/ChangeLog addition:
2008-12-27 Aidan Kehoe <kehoea@parhasard.net>
* make-docfile.c (main): Allow more than one -d argument, followed
by a directory to change to.
(put_filename): Don't strip directory information; with previous
change, allows retrieval of Lisp function and variable origin
files from #'built-in-symbol-file relative to lisp-directory.
(scan_lisp_file): Don't add an extraneous newline after the file
name, put_filename has added the newline already.
lisp/ChangeLog addition:
2008-12-27 Aidan Kehoe <kehoea@parhasard.net>
* loadup.el (load-history):
Add the contents of current-load-list to load-history before
clearing it. Move the variable declarations earlier in the file to
a format understood by make-docfile.c.
* custom.el (custom-declare-variable): Add the variable's symbol
to the current file's load history entry correctly, don't use a
cons. Eliminate a comment that we don't need to worry about, we
don't need to check the `initialized' C variable in Lisp.
* bytecomp.el (byte-compile-output-file-form):
Merge Andreas Schwab's pre-GPLv3 GNU change of 19970831 here;
treat #'custom-declare-variable correctly, generating the
docstrings in a format understood by make-docfile.c.
* loadhist.el (symbol-file): Correct behaviour for checking
autoloaded macros and functions when supplied with a TYPE
argument. Accept fully-qualified paths from
#'built-in-symbol-file; if a path is not fully-qualified, return
it relative to lisp-directory if the filename corresponds to a
Lisp file, and relative to (concat source-directory "/src/")
otherwise.
* make-docfile.el (preloaded-file-list):
Rationalise some let bindings a little. Use the "-d" argument to
make-docfile.c to supply Lisp paths relative to lisp-directory,
not absolutely. Add in loadup.el explicitly to the list of files
to be processed by make-docfile.c--it doesn't make sense to add it
to preloaded-file-list, since that is used for purposes of
byte-compilation too.
src/ChangeLog addition:
2008-12-27 Aidan Kehoe <kehoea@parhasard.net>
* doc.c (Fbuilt_in_symbol_file):
Return a subr's filename immediately if we've found it. Check for
compiled function and compiled macro docstrings in DOC too, and
return them if they exist.
The branch of the if statement focused on functions may have
executed, but we may still want to check variable bindings; an
else clause isn't appropriate.
author | Aidan Kehoe <kehoea@parhasard.net> |
---|---|
date | Sat, 27 Dec 2008 14:05:50 +0000 |
parents | 69a1eda3da06 |
children | 7e01763ea656 |
rev | line source |
---|---|
428 | 1 ;;; loadhist.el --- lisp functions for working with feature groups |
2 | |
3 ;; Copyright (C) 1995 Free Software Foundation, Inc. | |
4 | |
5 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com> | |
6 ;; Version: 1.0 | |
7 ;; Keywords: internal, dumped | |
8 | |
9 ;; This file is part of XEmacs. | |
10 | |
11 ;; XEmacs is free software; you can redistribute it and/or modify it | |
12 ;; 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 ;; XEmacs is distributed in the hope that it will be useful, but | |
17 ;; WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
19 ;; General Public License for more details. | |
20 | |
21 ;; You should have received a copy of the GNU General Public License | |
22 ;; along with XEmacs; see the file COPYING. If not, write to the Free | |
23 ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA | |
24 ;; 02111-1307, USA. | |
25 | |
26 ;;; Synched up with: FSF 20.2. | |
27 | |
4367
69e6352406f0
Handle macros, autoloads correctly in symbol-file. Add an incomplete TYPE arg.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3511
diff
changeset
|
28 ;; #### Sync this file! |
69e6352406f0
Handle macros, autoloads correctly in symbol-file. Add an incomplete TYPE arg.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3511
diff
changeset
|
29 |
428 | 30 ;;; Commentary: |
31 | |
32 ;; This file is dumped with XEmacs. | |
33 | |
34 ;; These functions exploit the load-history system variable. | |
35 ;; Entry points include `unload-feature', `symbol-file', and `feature-file'. | |
36 | |
37 ;;; Code: | |
38 | |
39 ;; load-history is a list of entries that look like this: | |
40 ;; ("outline" outline-regexp ... (require . wid-edit) ... (provide . outline) ...) | |
41 | |
4539
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
42 ;; XEmacs; this function is in subr.el in GNU, and does not deal with |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
43 ;; built-in symbols. |
4367
69e6352406f0
Handle macros, autoloads correctly in symbol-file. Add an incomplete TYPE arg.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3511
diff
changeset
|
44 (defun symbol-file (sym &optional type) |
428 | 45 "Return the input source from which SYM was loaded. |
4367
69e6352406f0
Handle macros, autoloads correctly in symbol-file. Add an incomplete TYPE arg.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3511
diff
changeset
|
46 This is a file name, or nil if the source was a buffer with no associated file. |
69e6352406f0
Handle macros, autoloads correctly in symbol-file. Add an incomplete TYPE arg.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3511
diff
changeset
|
47 |
69e6352406f0
Handle macros, autoloads correctly in symbol-file. Add an incomplete TYPE arg.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3511
diff
changeset
|
48 If TYPE is nil or omitted, any kind of definition is acceptable. |
69e6352406f0
Handle macros, autoloads correctly in symbol-file. Add an incomplete TYPE arg.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3511
diff
changeset
|
49 If TYPE is `defun', then function, subr, special form or macro definitions |
69e6352406f0
Handle macros, autoloads correctly in symbol-file. Add an incomplete TYPE arg.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3511
diff
changeset
|
50 are acceptable. |
69e6352406f0
Handle macros, autoloads correctly in symbol-file. Add an incomplete TYPE arg.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3511
diff
changeset
|
51 If TYPE is `defvar', then variable definitions are acceptable. |
69e6352406f0
Handle macros, autoloads correctly in symbol-file. Add an incomplete TYPE arg.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3511
diff
changeset
|
52 |
4535
69a1eda3da06
Distinguish vars and functions in #'symbol-file, #'describe-{function,variable}
Aidan Kehoe <kehoea@parhasard.net>
parents:
4367
diff
changeset
|
53 `defface' specifies a face definition only, and for the moment, it won't |
69a1eda3da06
Distinguish vars and functions in #'symbol-file, #'describe-{function,variable}
Aidan Kehoe <kehoea@parhasard.net>
parents:
4367
diff
changeset
|
54 return faces created with `make-face' or `copy-face', just those created |
69a1eda3da06
Distinguish vars and functions in #'symbol-file, #'describe-{function,variable}
Aidan Kehoe <kehoea@parhasard.net>
parents:
4367
diff
changeset
|
55 with `defface' and `custom-declare-face'." |
428 | 56 (interactive "SFind source file for symbol: ") ; XEmacs |
4539
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
57 (let (built-in-file autoload-cons symbol-details) |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
58 (cond ((and (eq 'autoload |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
59 (car-safe |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
60 (setq autoload-cons |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
61 (and (fboundp sym) (symbol-function sym))))) |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
62 (or (and (or (null type) (eq 'defvar type)) |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
63 (eq (fifth autoload-cons) 'keymap)) |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
64 (and (or (null type) (eq 'defun type)) |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
65 (memq (fifth autoload-cons) '(nil macro))))) |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
66 (return (locate-library (second autoload-cons)))) |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
67 ((eq 'defvar type) |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
68 ;; Load history entries corresponding to variables are just |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
69 ;; symbols. |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
70 (dolist (entry load-history) |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
71 (when (memq sym (cdr entry)) |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
72 (return (car entry))))) |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
73 ((not (null type)) |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
74 ;; Non-variables have the type stored as the car of the entry. |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
75 (dolist (entry load-history) |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
76 (when (and (setq symbol-details (rassq sym (cdr entry))) |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
77 (eq type (car symbol-details))) |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
78 (return (car entry))))) |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
79 (t |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
80 ;; If TYPE hasn't been specified, we need to check both for |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
81 ;; variables and other symbols. |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
82 (dolist (entry load-history) |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
83 (when (or (memq sym (cdr entry)) |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
84 (rassq sym (cdr entry))) |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
85 (return (car entry)))))) |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
86 (when (setq built-in-file (built-in-symbol-file sym type)) |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
87 (if (equal built-in-file (file-truename built-in-file)) |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
88 ;; Probably a full path name: |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
89 built-in-file |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
90 ;; This is a bit heuristic, but shouldn't realistically be a |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
91 ;; problem: |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
92 (if (string-match "\.elc?$" built-in-file) |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
93 (concat lisp-directory built-in-file) |
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
94 (concat source-directory "/src/" built-in-file)))))) |
428 | 95 |
96 (defun feature-symbols (feature) | |
97 "Return the file and list of symbols associated with a given FEATURE." | |
98 (let ((pair `(provide . ,feature))) | |
99 (dolist (entry load-history) | |
100 (when (member pair (cdr entry)) | |
101 (return entry))))) | |
102 | |
103 (defun feature-file (feature) | |
104 "Return the file name from which a given FEATURE was loaded. | |
105 Actually, return the load argument, if any; this is sometimes the name of a | |
106 Lisp file without an extension. If the feature came from an eval-buffer on | |
107 a buffer with no associated file, or an eval-region, return nil." | |
108 (unless (featurep feature) | |
109 (error "%s is not a currently loaded feature" (symbol-name feature))) | |
110 (car (feature-symbols feature))) | |
111 | |
112 (defun file-symbols (file) | |
113 "Return the file and list of symbols associated with FILE. | |
114 The file name in the returned list is the string used to load the file, | |
115 and may not be the same string as FILE, but it will be equivalent." | |
116 (or (assoc file load-history) | |
117 (assoc (file-name-sans-extension file) load-history) | |
118 (assoc (concat file ".el") load-history) | |
119 (assoc (concat file ".elc") load-history))) | |
120 | |
121 (defun file-provides (file) | |
122 "Return the list of features provided by FILE." | |
123 (let ((provides nil)) | |
124 (dolist (x (cdr (file-symbols file))) | |
125 (when (eq (car-safe x) 'provide) | |
126 (push (cdr x) provides))) | |
127 provides)) | |
128 | |
129 (defun file-requires (file) | |
130 "Return the list of features required by FILE." | |
131 (let ((requires nil)) | |
132 (dolist (x (cdr (file-symbols file))) | |
133 (when (eq (car-safe x) 'require) | |
134 (push (cdr x) requires))) | |
135 requires)) | |
136 | |
137 (defun file-dependents (file) | |
138 "Return the list of loaded libraries that depend on FILE. | |
139 This can include FILE itself." | |
140 (let ((provides (file-provides file)) | |
141 (dependents nil)) | |
142 (dolist (entry load-history) | |
143 (dolist (x (cdr entry)) | |
144 (when (and (eq (car-safe x) 'require) | |
145 (memq (cdr-safe x) provides)) | |
146 (push (car entry) dependents)))) | |
147 dependents)) | |
148 | |
149 ;; FSFmacs | |
150 ;(defun read-feature (prompt) | |
151 ; "Read a feature name \(string\) from the minibuffer, | |
152 ;prompting with PROMPT and completing from `features', and | |
153 ;return the feature \(symbol\)." | |
154 ; (intern (completing-read prompt | |
155 ; (mapcar #'(lambda (feature) | |
156 ; (list (symbol-name feature))) | |
157 ; features) | |
158 ; nil t))) | |
159 | |
160 ;; ;;;###autoload | |
161 (defun unload-feature (feature &optional force) | |
162 "Unload the library that provided FEATURE, restoring all its autoloads. | |
163 If the feature is required by any other loaded code, and optional FORCE | |
164 is nil, raise an error." | |
165 (interactive "SFeature: ") | |
166 (unless (featurep feature) | |
167 (error "%s is not a currently loaded feature" (symbol-name feature))) | |
168 (when (not force) | |
169 (let* ((file (feature-file feature)) | |
170 (dependents (delete file (copy-sequence (file-dependents file))))) | |
171 (when dependents | |
172 (error "Loaded libraries %s depend on %s" | |
173 (prin1-to-string dependents) file)))) | |
442 | 174 (let* ((flist (feature-symbols feature)) |
996 | 175 (file (car flist)) |
176 (unloading-module nil)) | |
442 | 177 (flet ((reset-aload (x) |
178 (let ((aload (get x 'autoload))) | |
179 (if aload (fset x (cons 'autoload aload)))))) | |
428 | 180 (mapcar |
181 #'(lambda (x) | |
182 (cond ((stringp x) nil) | |
183 ((consp x) | |
184 ;; Remove any feature names that this file provided. | |
185 (if (eq (car x) 'provide) | |
996 | 186 (setq features (delq (cdr x) features)) |
187 (if (eq (car x) 'module) | |
188 (setq unloading-module t)))) | |
442 | 189 ((and (boundp x) |
190 (fboundp x)) | |
191 (makunbound x) | |
192 (fmakunbound x) | |
193 (reset-aload x)) | |
194 ((boundp x) | |
195 (makunbound x)) | |
428 | 196 ((fboundp x) |
197 (fmakunbound x) | |
442 | 198 (reset-aload x)))) |
199 (cdr flist))) | |
428 | 200 ;; Delete the load-history element for this file. |
201 (let ((elt (assoc file load-history))) | |
996 | 202 (setq load-history (delq elt load-history))) |
203 ;; If it is a module, really unload it. | |
204 (if unloading-module | |
1111 | 205 (declare-fboundp (unload-module (symbol-name feature)))))) |
428 | 206 |
207 (provide 'loadhist) | |
208 | |
209 ;;; loadhist.el ends here |