1 ;;; disass.el --- disassembler for compiled Emacs Lisp code
3 ;;; Copyright (C) 1986, 1991 Free Software Foundation, Inc.
5 ;; Author: Doug Cutting <doug@csli.stanford.edu>
6 ;; Jamie Zawinski <jwz@lucid.com>
7 ;; Maintainer: Jamie Zawinski <jwz@lucid.com>
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to
24 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
28 ;;; Original version by Doug Cutting (doug@csli.stanford.edu)
29 ;;; Substantially modified by Jamie Zawinski <jwz@lucid.com> for
30 ;;; the new lapcode-based byte compiler.
34 ;;; The variable byte-code-vector is defined by the new bytecomp.el.
35 ;;; The function byte-decompile-lapcode is defined in byte-opt.el.
36 ;;; Since we don't use byte-decompile-lapcode, let's try not loading byte-opt.
37 (require 'byte-compile "bytecomp")
39 (defvar disassemble-column-1-indent 5 "*")
40 (defvar disassemble-column-2-indent 10 "*")
42 (defvar disassemble-recursive-indent 3 "*")
45 (defun disassemble (object &optional buffer indent interactive-p)
46 "Print disassembled code for OBJECT in (optional) BUFFER.
47 OBJECT can be a symbol defined as a function, or a function itself
48 \(a lambda expression or a compiled-function object).
49 If OBJECT is not already compiled, we compile it, but do not
50 redefine OBJECT if it is a symbol."
51 (interactive (list (intern (completing-read "Disassemble function: "
54 (if (eq (car-safe object) 'byte-code)
55 (setq object (list 'lambda () object)))
56 (or indent (setq indent 0)) ;Default indent to zero
58 (if (or interactive-p (null buffer))
59 (with-output-to-temp-buffer "*Disassemble*"
60 (set-buffer "*Disassemble*")
61 (disassemble-internal object indent (not interactive-p)))
63 (disassemble-internal object indent nil)))
67 (defun disassemble-internal (obj indent interactive-p)
74 obj (symbol-function obj)))
76 (error "Can't disassemble #<subr %s>" name))
77 (if (eq (car-safe obj) 'macro) ;handle macros
80 (if (and (listp obj) (not (eq (car obj) 'lambda)))
81 (error "not a function"))
83 (if (assq 'byte-code obj)
85 (if interactive-p (message (if name
86 "Compiling %s's definition..."
87 "Compiling definition...")
89 (setq obj (byte-compile obj))
90 (if interactive-p (message "Done compiling. Disassembling..."))))
92 (setq obj (cdr obj)) ;throw lambda away
93 (setq args (car obj)) ;save arg list
96 (setq args (aref obj 0))))
97 (if (zerop indent) ; not a nested function
100 (insert (format "byte code%s%s%s:\n"
101 (if (or macro name) " for" "")
102 (if macro " macro" "")
103 (if name (format " %s" name) "")))))
104 (let ((doc (if (consp obj)
105 (and (stringp (car obj)) (car obj))
106 (and (> (length obj) 4) (aref obj 4)))))
107 (if (and doc (stringp doc))
108 (progn (and (consp obj) (setq obj (cdr obj)))
110 (princ " doc: " (current-buffer))
111 (if (string-match "\n" doc)
112 (setq doc (concat (substring doc 0 (match-beginning 0))
117 (prin1 args (current-buffer))
119 (let ((interactive (cond ((consp obj)
120 (assq 'interactive obj))
122 (list 'interactive (aref obj 5))))))
125 (setq interactive (nth 1 interactive))
126 (if (eq (car-safe (car-safe obj)) 'interactive)
127 (setq obj (cdr obj)))
129 (insert " interactive: ")
130 (if (eq (car-safe interactive) 'byte-code)
133 (disassemble-1 interactive
134 (+ indent disassemble-recursive-indent)))
135 (let ((print-escape-newlines t))
136 (prin1 interactive (current-buffer))))
138 (cond ((and (consp obj) (assq 'byte-code obj))
139 (disassemble-1 (assq 'byte-code obj) indent))
140 ((byte-code-function-p obj)
141 (disassemble-1 obj indent))
143 (insert "Uncompiled body: ")
144 (let ((print-escape-newlines t))
145 (prin1 (if (cdr obj) (cons 'progn obj) (car obj))
146 (current-buffer))))))
151 (defun disassemble-1 (obj indent)
152 "Prints the byte-code call OBJ in the current buffer.
153 OBJ should be a call to BYTE-CODE generated by the byte compiler."
154 (let (bytes constvec)
156 (setq bytes (car (cdr obj)) ;the byte code
157 constvec (car (cdr (cdr obj)))) ;constant vector
158 (setq bytes (aref obj 1)
159 constvec (aref obj 2)))
160 (let ((lap (byte-decompile-bytecode bytes constvec))
165 (while (setq tmp (assq 'TAG lap))
166 (setcar (cdr tmp) (setq tagno (1+ tagno)))
167 (setq lap (cdr (memq tmp lap)))))
169 (setq op (car (car lap))
173 (insert (int-to-string (car arg)) ":")
175 (indent-to (+ indent disassemble-column-1-indent))
177 (string-match "^byte-" (setq opname (symbol-name op))))
178 (setq opname (substring opname 5))
179 (setq opname "<not-an-opcode>"))
180 (if (eq op 'byte-constant2)
181 (insert " #### shouldn't have seen constant2 here!\n "))
183 (indent-to (+ indent disassemble-column-1-indent
184 disassemble-column-2-indent
187 (cond ((memq op byte-goto-ops)
188 (insert (int-to-string (nth 1 arg))))
189 ((memq op '(byte-call byte-unbind
190 byte-listN byte-concatN byte-insertN))
191 (insert (int-to-string arg)))
192 ((memq op '(byte-varref byte-varset byte-varbind))
193 (prin1 (car arg) (current-buffer)))
194 ((memq op '(byte-constant byte-constant2))
197 ;; but if the value of the constant is compiled code, then
198 ;; recursively disassemble it.
199 (cond ((or (byte-code-function-p arg)
200 (and (eq (car-safe arg) 'lambda)
201 (assq 'byte-code arg))
202 (and (eq (car-safe arg) 'macro)
203 (or (byte-code-function-p (cdr arg))
204 (and (eq (car-safe (cdr arg)) 'lambda)
205 (assq 'byte-code (cdr arg))))))
206 (cond ((byte-code-function-p arg)
207 (insert "<compiled-function>\n"))
208 ((eq (car-safe arg) 'lambda)
209 (insert "<compiled lambda>"))
210 (t (insert "<compiled macro>\n")))
211 (disassemble-internal
213 (+ indent disassemble-recursive-indent 1)
215 ((eq (car-safe arg) 'byte-code)
216 (insert "<byte code>\n")
217 (disassemble-1 ;recurse on byte-code object
219 (+ indent disassemble-recursive-indent)))
220 ((eq (car-safe (car-safe arg)) 'byte-code)
221 (insert "(<byte code>...)\n")
222 (mapcar ;recurse on list of byte-code objects
226 (+ indent disassemble-recursive-indent)))
229 ;; really just a constant
230 (let ((print-escape-newlines t))
231 (prin1 arg (current-buffer))))))
234 (setq lap (cdr lap)))))
237 ;;; disass.el ends here