Mercurial > emacs
annotate lisp/emacs-lisp/disass.el @ 87498:566965810b9e
*** empty log message ***
author | Magnus Henoch <mange@freemail.hu> |
---|---|
date | Mon, 31 Dec 2007 00:57:51 +0000 |
parents | 5b112f6186e3 |
children | 107ccd98fa12 bdb3fe0ba9fa |
rev | line source |
---|---|
811
e694e0879463
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
806
diff
changeset
|
1 ;;; disass.el --- disassembler for compiled Emacs Lisp code |
e694e0879463
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
806
diff
changeset
|
2 |
64751
5b1a238fcbb4
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
64085
diff
changeset
|
3 ;; Copyright (C) 1986, 1991, 2002, 2003, 2004, |
75346 | 4 ;; 2005, 2006, 2007 Free Software Foundation, Inc. |
845 | 5 |
811
e694e0879463
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
806
diff
changeset
|
6 ;; Author: Doug Cutting <doug@csli.stanford.edu> |
e694e0879463
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
806
diff
changeset
|
7 ;; Jamie Zawinski <jwz@lucid.com> |
55044
3b81dccc5b32
(disassemble): Handle lambda-exp as arg.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
8 ;; Maintainer: FSF |
2247
2c7997f249eb
Add or correct keywords
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
1821
diff
changeset
|
9 ;; Keywords: internal |
811
e694e0879463
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
806
diff
changeset
|
10 |
757 | 11 ;; This file is part of GNU Emacs. |
12 | |
13 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
14 ;; 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:
75346
diff
changeset
|
15 ;; the Free Software Foundation; either version 3, or (at your option) |
757 | 16 ;; any later version. |
17 | |
18 ;; GNU Emacs is distributed in the hope that it will be useful, | |
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
21 ;; GNU General Public License for more details. | |
22 | |
23 ;; You should have received a copy of the GNU General Public License | |
14169 | 24 ;; along with GNU Emacs; see the file COPYING. If not, write to the |
64085 | 25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
26 ;; Boston, MA 02110-1301, USA. | |
757 | 27 |
811
e694e0879463
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
806
diff
changeset
|
28 ;;; Commentary: |
e694e0879463
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
806
diff
changeset
|
29 |
2307
10e417efb12a
Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2247
diff
changeset
|
30 ;; The single entry point, `disassemble', disassembles a code object generated |
10e417efb12a
Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2247
diff
changeset
|
31 ;; by the Emacs Lisp byte-compiler. This doesn't invert the compilation |
10e417efb12a
Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2247
diff
changeset
|
32 ;; operation, not by a long shot, but it's useful for debugging. |
10e417efb12a
Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2247
diff
changeset
|
33 |
10e417efb12a
Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2247
diff
changeset
|
34 ;; |
10e417efb12a
Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2247
diff
changeset
|
35 ;; Original version by Doug Cutting (doug@csli.stanford.edu) |
10e417efb12a
Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2247
diff
changeset
|
36 ;; Substantially modified by Jamie Zawinski <jwz@lucid.com> for |
10e417efb12a
Added or corrected Commentary sections
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2247
diff
changeset
|
37 ;; the new lapcode-based byte compiler. |
811
e694e0879463
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
806
diff
changeset
|
38 |
e694e0879463
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
806
diff
changeset
|
39 ;;; Code: |
757 | 40 |
41 ;;; The variable byte-code-vector is defined by the new bytecomp.el. | |
802 | 42 ;;; The function byte-decompile-lapcode is defined in byte-opt.el. |
43 ;;; Since we don't use byte-decompile-lapcode, let's try not loading byte-opt. | |
1606
4303c30b29de
* disass.el (byte-compile): Specify that the 'byte-compile feature
Jim Blandy <jimb@redhat.com>
parents:
845
diff
changeset
|
44 (require 'byte-compile "bytecomp") |
757 | 45 |
8293
74218ea236fe
(disassemble-1): Display the pc values.
Richard M. Stallman <rms@gnu.org>
parents:
4789
diff
changeset
|
46 (defvar disassemble-column-1-indent 8 "*") |
757 | 47 (defvar disassemble-column-2-indent 10 "*") |
48 | |
49 (defvar disassemble-recursive-indent 3 "*") | |
50 | |
1821
04fb1d3d6992
JimB's changes since January 18th
Jim Blandy <jimb@redhat.com>
parents:
1606
diff
changeset
|
51 ;;;###autoload |
757 | 52 (defun disassemble (object &optional buffer indent interactive-p) |
53 "Print disassembled code for OBJECT in (optional) BUFFER. | |
54 OBJECT can be a symbol defined as a function, or a function itself | |
55 \(a lambda expression or a compiled-function object). | |
56 If OBJECT is not already compiled, we compile it, but do not | |
57 redefine OBJECT if it is a symbol." | |
58 (interactive (list (intern (completing-read "Disassemble function: " | |
59 obarray 'fboundp t)) | |
60 nil 0 t)) | |
55044
3b81dccc5b32
(disassemble): Handle lambda-exp as arg.
Richard M. Stallman <rms@gnu.org>
parents:
52401
diff
changeset
|
61 (if (and (consp object) (not (eq (car object) 'lambda))) |
757 | 62 (setq object (list 'lambda () object))) |
63 (or indent (setq indent 0)) ;Default indent to zero | |
64 (save-excursion | |
65 (if (or interactive-p (null buffer)) | |
66 (with-output-to-temp-buffer "*Disassemble*" | |
67 (set-buffer "*Disassemble*") | |
68 (disassemble-internal object indent (not interactive-p))) | |
69 (set-buffer buffer) | |
70 (disassemble-internal object indent nil))) | |
71 nil) | |
72 | |
73 | |
74 (defun disassemble-internal (obj indent interactive-p) | |
75 (let ((macro 'nil) | |
76 (name 'nil) | |
77 (doc 'nil) | |
78 args) | |
79 (while (symbolp obj) | |
80 (setq name obj | |
81 obj (symbol-function obj))) | |
82 (if (subrp obj) | |
83 (error "Can't disassemble #<subr %s>" name)) | |
3767
660b7b4e3e40
(disassemble-internal): If function is autoload, load it.
Richard M. Stallman <rms@gnu.org>
parents:
2307
diff
changeset
|
84 (if (and (listp obj) (eq (car obj) 'autoload)) |
660b7b4e3e40
(disassemble-internal): If function is autoload, load it.
Richard M. Stallman <rms@gnu.org>
parents:
2307
diff
changeset
|
85 (progn |
660b7b4e3e40
(disassemble-internal): If function is autoload, load it.
Richard M. Stallman <rms@gnu.org>
parents:
2307
diff
changeset
|
86 (load (nth 1 obj)) |
660b7b4e3e40
(disassemble-internal): If function is autoload, load it.
Richard M. Stallman <rms@gnu.org>
parents:
2307
diff
changeset
|
87 (setq obj (symbol-function name)))) |
757 | 88 (if (eq (car-safe obj) 'macro) ;handle macros |
89 (setq macro t | |
90 obj (cdr obj))) | |
4789
86318d7728f5
(disassemble-internal): Allow a call to byte-code as argument.
Richard M. Stallman <rms@gnu.org>
parents:
3767
diff
changeset
|
91 (if (and (listp obj) (eq (car obj) 'byte-code)) |
49598
0d8b17d428b5
Trailing whitepace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
22995
diff
changeset
|
92 (setq obj (list 'lambda nil obj))) |
757 | 93 (if (and (listp obj) (not (eq (car obj) 'lambda))) |
94 (error "not a function")) | |
95 (if (consp obj) | |
96 (if (assq 'byte-code obj) | |
97 nil | |
98 (if interactive-p (message (if name | |
99 "Compiling %s's definition..." | |
100 "Compiling definition...") | |
101 name)) | |
102 (setq obj (byte-compile obj)) | |
103 (if interactive-p (message "Done compiling. Disassembling...")))) | |
104 (cond ((consp obj) | |
105 (setq obj (cdr obj)) ;throw lambda away | |
106 (setq args (car obj)) ;save arg list | |
107 (setq obj (cdr obj))) | |
14960
8fe7e5e09773
(disassemble-internal): Graceful error if compile failed.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
108 ((byte-code-function-p obj) |
8fe7e5e09773
(disassemble-internal): Graceful error if compile failed.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
109 (setq args (aref obj 0))) |
8fe7e5e09773
(disassemble-internal): Graceful error if compile failed.
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
110 (t (error "Compilation failed"))) |
757 | 111 (if (zerop indent) ; not a nested function |
112 (progn | |
113 (indent-to indent) | |
114 (insert (format "byte code%s%s%s:\n" | |
115 (if (or macro name) " for" "") | |
116 (if macro " macro" "") | |
117 (if name (format " %s" name) ""))))) | |
118 (let ((doc (if (consp obj) | |
119 (and (stringp (car obj)) (car obj)) | |
13340
53bbedbefdb2
(disassemble-internal): Handle lazy-loaded doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
8293
diff
changeset
|
120 ;; Use documentation to get lazy-loaded doc string |
53bbedbefdb2
(disassemble-internal): Handle lazy-loaded doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
8293
diff
changeset
|
121 (documentation obj t)))) |
757 | 122 (if (and doc (stringp doc)) |
123 (progn (and (consp obj) (setq obj (cdr obj))) | |
124 (indent-to indent) | |
125 (princ " doc: " (current-buffer)) | |
126 (if (string-match "\n" doc) | |
127 (setq doc (concat (substring doc 0 (match-beginning 0)) | |
128 " ..."))) | |
129 (insert doc "\n")))) | |
130 (indent-to indent) | |
131 (insert " args: ") | |
132 (prin1 args (current-buffer)) | |
133 (insert "\n") | |
134 (let ((interactive (cond ((consp obj) | |
135 (assq 'interactive obj)) | |
136 ((> (length obj) 5) | |
137 (list 'interactive (aref obj 5)))))) | |
138 (if interactive | |
139 (progn | |
140 (setq interactive (nth 1 interactive)) | |
141 (if (eq (car-safe (car-safe obj)) 'interactive) | |
142 (setq obj (cdr obj))) | |
143 (indent-to indent) | |
144 (insert " interactive: ") | |
145 (if (eq (car-safe interactive) 'byte-code) | |
146 (progn | |
147 (insert "\n") | |
148 (disassemble-1 interactive | |
149 (+ indent disassemble-recursive-indent))) | |
150 (let ((print-escape-newlines t)) | |
151 (prin1 interactive (current-buffer)))) | |
152 (insert "\n")))) | |
153 (cond ((and (consp obj) (assq 'byte-code obj)) | |
154 (disassemble-1 (assq 'byte-code obj) indent)) | |
1821
04fb1d3d6992
JimB's changes since January 18th
Jim Blandy <jimb@redhat.com>
parents:
1606
diff
changeset
|
155 ((byte-code-function-p obj) |
757 | 156 (disassemble-1 obj indent)) |
157 (t | |
158 (insert "Uncompiled body: ") | |
159 (let ((print-escape-newlines t)) | |
160 (prin1 (if (cdr obj) (cons 'progn obj) (car obj)) | |
161 (current-buffer)))))) | |
162 (if interactive-p | |
163 (message ""))) | |
164 | |
165 | |
166 (defun disassemble-1 (obj indent) | |
167 "Prints the byte-code call OBJ in the current buffer. | |
168 OBJ should be a call to BYTE-CODE generated by the byte compiler." | |
169 (let (bytes constvec) | |
170 (if (consp obj) | |
171 (setq bytes (car (cdr obj)) ;the byte code | |
172 constvec (car (cdr (cdr obj)))) ;constant vector | |
13340
53bbedbefdb2
(disassemble-internal): Handle lazy-loaded doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
8293
diff
changeset
|
173 ;; If it is lazy-loaded, load it now |
53bbedbefdb2
(disassemble-internal): Handle lazy-loaded doc strings.
Richard M. Stallman <rms@gnu.org>
parents:
8293
diff
changeset
|
174 (fetch-bytecode obj) |
22995
bc5bd04bf914
(disassemble-1): Move the call to
Richard M. Stallman <rms@gnu.org>
parents:
22055
diff
changeset
|
175 (setq bytes (aref obj 1) |
757 | 176 constvec (aref obj 2))) |
22995
bc5bd04bf914
(disassemble-1): Move the call to
Richard M. Stallman <rms@gnu.org>
parents:
22055
diff
changeset
|
177 (let ((lap (byte-decompile-bytecode (string-as-unibyte bytes) constvec)) |
8293
74218ea236fe
(disassemble-1): Display the pc values.
Richard M. Stallman <rms@gnu.org>
parents:
4789
diff
changeset
|
178 op arg opname pc-value) |
757 | 179 (let ((tagno 0) |
180 tmp | |
181 (lap lap)) | |
182 (while (setq tmp (assq 'TAG lap)) | |
183 (setcar (cdr tmp) (setq tagno (1+ tagno))) | |
184 (setq lap (cdr (memq tmp lap))))) | |
185 (while lap | |
8293
74218ea236fe
(disassemble-1): Display the pc values.
Richard M. Stallman <rms@gnu.org>
parents:
4789
diff
changeset
|
186 ;; Take off the pc value of the next thing |
74218ea236fe
(disassemble-1): Display the pc values.
Richard M. Stallman <rms@gnu.org>
parents:
4789
diff
changeset
|
187 ;; and put it in pc-value. |
74218ea236fe
(disassemble-1): Display the pc values.
Richard M. Stallman <rms@gnu.org>
parents:
4789
diff
changeset
|
188 (setq pc-value nil) |
74218ea236fe
(disassemble-1): Display the pc values.
Richard M. Stallman <rms@gnu.org>
parents:
4789
diff
changeset
|
189 (if (numberp (car lap)) |
74218ea236fe
(disassemble-1): Display the pc values.
Richard M. Stallman <rms@gnu.org>
parents:
4789
diff
changeset
|
190 (setq pc-value (car lap) |
74218ea236fe
(disassemble-1): Display the pc values.
Richard M. Stallman <rms@gnu.org>
parents:
4789
diff
changeset
|
191 lap (cdr lap))) |
74218ea236fe
(disassemble-1): Display the pc values.
Richard M. Stallman <rms@gnu.org>
parents:
4789
diff
changeset
|
192 ;; Fetch the next op and its arg. |
757 | 193 (setq op (car (car lap)) |
194 arg (cdr (car lap))) | |
8293
74218ea236fe
(disassemble-1): Display the pc values.
Richard M. Stallman <rms@gnu.org>
parents:
4789
diff
changeset
|
195 (setq lap (cdr lap)) |
757 | 196 (indent-to indent) |
197 (if (eq 'TAG op) | |
8293
74218ea236fe
(disassemble-1): Display the pc values.
Richard M. Stallman <rms@gnu.org>
parents:
4789
diff
changeset
|
198 (progn |
74218ea236fe
(disassemble-1): Display the pc values.
Richard M. Stallman <rms@gnu.org>
parents:
4789
diff
changeset
|
199 ;; We have a label. Display it, but first its pc value. |
74218ea236fe
(disassemble-1): Display the pc values.
Richard M. Stallman <rms@gnu.org>
parents:
4789
diff
changeset
|
200 (if pc-value |
74218ea236fe
(disassemble-1): Display the pc values.
Richard M. Stallman <rms@gnu.org>
parents:
4789
diff
changeset
|
201 (insert (format "%d:" pc-value))) |
74218ea236fe
(disassemble-1): Display the pc values.
Richard M. Stallman <rms@gnu.org>
parents:
4789
diff
changeset
|
202 (insert (int-to-string (car arg)))) |
74218ea236fe
(disassemble-1): Display the pc values.
Richard M. Stallman <rms@gnu.org>
parents:
4789
diff
changeset
|
203 ;; We have an instruction. Display its pc value first. |
74218ea236fe
(disassemble-1): Display the pc values.
Richard M. Stallman <rms@gnu.org>
parents:
4789
diff
changeset
|
204 (if pc-value |
74218ea236fe
(disassemble-1): Display the pc values.
Richard M. Stallman <rms@gnu.org>
parents:
4789
diff
changeset
|
205 (insert (format "%d" pc-value))) |
757 | 206 (indent-to (+ indent disassemble-column-1-indent)) |
207 (if (and op | |
208 (string-match "^byte-" (setq opname (symbol-name op)))) | |
209 (setq opname (substring opname 5)) | |
210 (setq opname "<not-an-opcode>")) | |
211 (if (eq op 'byte-constant2) | |
212 (insert " #### shouldn't have seen constant2 here!\n ")) | |
213 (insert opname) | |
214 (indent-to (+ indent disassemble-column-1-indent | |
215 disassemble-column-2-indent | |
216 -1)) | |
217 (insert " ") | |
218 (cond ((memq op byte-goto-ops) | |
219 (insert (int-to-string (nth 1 arg)))) | |
220 ((memq op '(byte-call byte-unbind | |
221 byte-listN byte-concatN byte-insertN)) | |
222 (insert (int-to-string arg))) | |
223 ((memq op '(byte-varref byte-varset byte-varbind)) | |
224 (prin1 (car arg) (current-buffer))) | |
225 ((memq op '(byte-constant byte-constant2)) | |
226 ;; it's a constant | |
227 (setq arg (car arg)) | |
228 ;; but if the value of the constant is compiled code, then | |
229 ;; recursively disassemble it. | |
1821
04fb1d3d6992
JimB's changes since January 18th
Jim Blandy <jimb@redhat.com>
parents:
1606
diff
changeset
|
230 (cond ((or (byte-code-function-p arg) |
757 | 231 (and (eq (car-safe arg) 'lambda) |
232 (assq 'byte-code arg)) | |
233 (and (eq (car-safe arg) 'macro) | |
1821
04fb1d3d6992
JimB's changes since January 18th
Jim Blandy <jimb@redhat.com>
parents:
1606
diff
changeset
|
234 (or (byte-code-function-p (cdr arg)) |
757 | 235 (and (eq (car-safe (cdr arg)) 'lambda) |
236 (assq 'byte-code (cdr arg)))))) | |
1821
04fb1d3d6992
JimB's changes since January 18th
Jim Blandy <jimb@redhat.com>
parents:
1606
diff
changeset
|
237 (cond ((byte-code-function-p arg) |
757 | 238 (insert "<compiled-function>\n")) |
239 ((eq (car-safe arg) 'lambda) | |
240 (insert "<compiled lambda>")) | |
241 (t (insert "<compiled macro>\n"))) | |
242 (disassemble-internal | |
243 arg | |
244 (+ indent disassemble-recursive-indent 1) | |
245 nil)) | |
246 ((eq (car-safe arg) 'byte-code) | |
247 (insert "<byte code>\n") | |
248 (disassemble-1 ;recurse on byte-code object | |
249 arg | |
250 (+ indent disassemble-recursive-indent))) | |
251 ((eq (car-safe (car-safe arg)) 'byte-code) | |
252 (insert "(<byte code>...)\n") | |
84896
5b112f6186e3
(disassemble-1): Use `mapc' rather than `mapcar'.
Juanma Barranquero <lekktu@gmail.com>
parents:
78217
diff
changeset
|
253 (mapc ;recurse on list of byte-code objects |
757 | 254 '(lambda (obj) |
255 (disassemble-1 | |
256 obj | |
257 (+ indent disassemble-recursive-indent))) | |
258 arg)) | |
259 (t | |
260 ;; really just a constant | |
261 (let ((print-escape-newlines t)) | |
262 (prin1 arg (current-buffer)))))) | |
263 ) | |
8293
74218ea236fe
(disassemble-1): Display the pc values.
Richard M. Stallman <rms@gnu.org>
parents:
4789
diff
changeset
|
264 (insert "\n"))))) |
757 | 265 nil) |
811
e694e0879463
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
806
diff
changeset
|
266 |
18383 | 267 (provide 'disass) |
268 | |
52401 | 269 ;;; arch-tag: 89482fe4-a087-4761-8dc6-d771054e763a |
811
e694e0879463
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
806
diff
changeset
|
270 ;;; disass.el ends here |