Mercurial > hg > xemacs-beta
annotate lisp/loadhist.el @ 5219:2d0937dc83cf
Tidying of CL files; make docstrings read better, remove commented-out code
2010-05-30 Aidan Kehoe <kehoea@parhasard.net>
* cl.el: Remove extraneous empty lines.
Remove the commented-out Lisp implementation of #'last,
#'copy-list.
Remove #'cl-maclisp-member.
(acons, pairlis): Have the argument list reflect the docstring for
these functions.
* cl-macs.el (defun*): Have the argument list reflect the
docstring.
Document the syntax of keywords in ARGLIST.
(defmacro*): Have the argument list reflect the docstring.
Document &body, &whole and &environment.
(function*): Have the argument list reflect the docstring.
(loop): Have the argument list reflect the docstring.
(eval-when, dolist, dotimes, do-symbols, flet, labels, macrolet,
symbol-macrolet):
Specify the argument list using the arguments: (...) syntax.
(define-setf-method, rotatef, defsubst*): Have the argument list
reflect the docstring.
(letf, letf*):
Specify the argument list using the arguments: (...) syntax.
(svref, acons, pairlis): Add compiler macros for these functions.
* cl-extra.el: Remove the commented-out Lisp implementation of
#'equalp. If we want to look at it, it's in version control.
(cl-expt): Remove this. The subr #'expt is always available.
Call #'cl-float-limits at dump time.
Remove the commented-out Lisp implementation of #'subseq.
(concatenate): Use (error 'invalid-argument ...) here, if TYPE is
not understood.
(list-length): Don't manually get the length of a list, call
#'length and return nil if the list is circular.
* byte-optimize.el (equalp): This needs
byte-optimize-binary-predicate as its optimizer, as do the other
equality predicates.
author | Aidan Kehoe <kehoea@parhasard.net> |
---|---|
date | Sun, 30 May 2010 13:27:36 +0100 |
parents | 39d74978fd32 |
children | 308d34e9f07d |
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. |
4540
7e01763ea656
Correct a misunderstanding of the semantics of #'return in #'symbol-file.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4539
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. |
4905
755ae5b97edb
Change "special form" to "special operator" in our sources.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4783
diff
changeset
|
49 If TYPE is `defun', then function, subr, special operator or macro definitions |
4367
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))))) |
4540
7e01763ea656
Correct a misunderstanding of the semantics of #'return in #'symbol-file.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4539
diff
changeset
|
66 (return-from symbol-file (locate-library (second autoload-cons)))) |
4539
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)) |
4540
7e01763ea656
Correct a misunderstanding of the semantics of #'return in #'symbol-file.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4539
diff
changeset
|
72 (return-from symbol-file (car entry))))) |
4539
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))) |
4540
7e01763ea656
Correct a misunderstanding of the semantics of #'return in #'symbol-file.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4539
diff
changeset
|
78 (return-from symbol-file (car entry))))) |
4539
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))) |
4540
7e01763ea656
Correct a misunderstanding of the semantics of #'return in #'symbol-file.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4539
diff
changeset
|
85 (return-from symbol-file (car entry)))))) |
4539
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: |
5206
39d74978fd32
Keep around file info for dumped functions and variables without docstrings.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4915
diff
changeset
|
92 (if (string-match #r"\.elc?$" built-in-file) |
4915
bedf3747a6d7
Use DOC for dumped Lisp file names; Xref to source-lisp if readable, symbol-file
Aidan Kehoe <kehoea@parhasard.net>
parents:
4905
diff
changeset
|
93 (concat (if (file-readable-p source-lisp) |
bedf3747a6d7
Use DOC for dumped Lisp file names; Xref to source-lisp if readable, symbol-file
Aidan Kehoe <kehoea@parhasard.net>
parents:
4905
diff
changeset
|
94 source-lisp |
bedf3747a6d7
Use DOC for dumped Lisp file names; Xref to source-lisp if readable, symbol-file
Aidan Kehoe <kehoea@parhasard.net>
parents:
4905
diff
changeset
|
95 lisp-directory) |
bedf3747a6d7
Use DOC for dumped Lisp file names; Xref to source-lisp if readable, symbol-file
Aidan Kehoe <kehoea@parhasard.net>
parents:
4905
diff
changeset
|
96 built-in-file) |
4539
061e030e3270
Fix some bugs in load-history construction, built-in symbol file names.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4535
diff
changeset
|
97 (concat source-directory "/src/" built-in-file)))))) |
428 | 98 |
99 (defun feature-symbols (feature) | |
100 "Return the file and list of symbols associated with a given FEATURE." | |
101 (let ((pair `(provide . ,feature))) | |
102 (dolist (entry load-history) | |
103 (when (member pair (cdr entry)) | |
104 (return entry))))) | |
105 | |
106 (defun feature-file (feature) | |
107 "Return the file name from which a given FEATURE was loaded. | |
108 Actually, return the load argument, if any; this is sometimes the name of a | |
109 Lisp file without an extension. If the feature came from an eval-buffer on | |
110 a buffer with no associated file, or an eval-region, return nil." | |
111 (unless (featurep feature) | |
112 (error "%s is not a currently loaded feature" (symbol-name feature))) | |
113 (car (feature-symbols feature))) | |
114 | |
115 (defun file-symbols (file) | |
116 "Return the file and list of symbols associated with FILE. | |
117 The file name in the returned list is the string used to load the file, | |
118 and may not be the same string as FILE, but it will be equivalent." | |
119 (or (assoc file load-history) | |
120 (assoc (file-name-sans-extension file) load-history) | |
121 (assoc (concat file ".el") load-history) | |
122 (assoc (concat file ".elc") load-history))) | |
123 | |
124 (defun file-provides (file) | |
125 "Return the list of features provided by FILE." | |
126 (let ((provides nil)) | |
127 (dolist (x (cdr (file-symbols file))) | |
128 (when (eq (car-safe x) 'provide) | |
129 (push (cdr x) provides))) | |
130 provides)) | |
131 | |
132 (defun file-requires (file) | |
133 "Return the list of features required by FILE." | |
134 (let ((requires nil)) | |
135 (dolist (x (cdr (file-symbols file))) | |
136 (when (eq (car-safe x) 'require) | |
137 (push (cdr x) requires))) | |
138 requires)) | |
139 | |
140 (defun file-dependents (file) | |
141 "Return the list of loaded libraries that depend on FILE. | |
142 This can include FILE itself." | |
143 (let ((provides (file-provides file)) | |
144 (dependents nil)) | |
145 (dolist (entry load-history) | |
146 (dolist (x (cdr entry)) | |
147 (when (and (eq (car-safe x) 'require) | |
148 (memq (cdr-safe x) provides)) | |
149 (push (car entry) dependents)))) | |
150 dependents)) | |
151 | |
152 ;; FSFmacs | |
153 ;(defun read-feature (prompt) | |
154 ; "Read a feature name \(string\) from the minibuffer, | |
155 ;prompting with PROMPT and completing from `features', and | |
156 ;return the feature \(symbol\)." | |
157 ; (intern (completing-read prompt | |
158 ; (mapcar #'(lambda (feature) | |
159 ; (list (symbol-name feature))) | |
160 ; features) | |
161 ; nil t))) | |
162 | |
163 ;; ;;;###autoload | |
164 (defun unload-feature (feature &optional force) | |
165 "Unload the library that provided FEATURE, restoring all its autoloads. | |
166 If the feature is required by any other loaded code, and optional FORCE | |
167 is nil, raise an error." | |
168 (interactive "SFeature: ") | |
169 (unless (featurep feature) | |
170 (error "%s is not a currently loaded feature" (symbol-name feature))) | |
171 (when (not force) | |
172 (let* ((file (feature-file feature)) | |
173 (dependents (delete file (copy-sequence (file-dependents file))))) | |
174 (when dependents | |
175 (error "Loaded libraries %s depend on %s" | |
176 (prin1-to-string dependents) file)))) | |
442 | 177 (let* ((flist (feature-symbols feature)) |
996 | 178 (file (car flist)) |
179 (unloading-module nil)) | |
442 | 180 (flet ((reset-aload (x) |
181 (let ((aload (get x 'autoload))) | |
182 (if aload (fset x (cons 'autoload aload)))))) | |
4783
e29fcfd8df5f
Eliminate most core code byte-compile warnings.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4540
diff
changeset
|
183 (mapc |
428 | 184 #'(lambda (x) |
185 (cond ((stringp x) nil) | |
186 ((consp x) | |
187 ;; Remove any feature names that this file provided. | |
188 (if (eq (car x) 'provide) | |
996 | 189 (setq features (delq (cdr x) features)) |
190 (if (eq (car x) 'module) | |
191 (setq unloading-module t)))) | |
442 | 192 ((and (boundp x) |
193 (fboundp x)) | |
194 (makunbound x) | |
195 (fmakunbound x) | |
196 (reset-aload x)) | |
197 ((boundp x) | |
198 (makunbound x)) | |
428 | 199 ((fboundp x) |
200 (fmakunbound x) | |
442 | 201 (reset-aload x)))) |
202 (cdr flist))) | |
428 | 203 ;; Delete the load-history element for this file. |
204 (let ((elt (assoc file load-history))) | |
996 | 205 (setq load-history (delq elt load-history))) |
206 ;; If it is a module, really unload it. | |
207 (if unloading-module | |
1111 | 208 (declare-fboundp (unload-module (symbol-name feature)))))) |
428 | 209 |
210 (provide 'loadhist) | |
211 | |
212 ;;; loadhist.el ends here |