[bpt/emacs.git] / lisp / emacs-lisp / disass.el

;;; disass.el --- disassembler for compiled Emacs Lisp code

;; Copyright (C) 1986, 1991, 2002, 2003, 2004,
;;   2005, 2006, 2007, 2008 Free Software Foundation, Inc.

;; Author: Doug Cutting <doug@csli.stanford.edu>
;;	Jamie Zawinski <jwz@lucid.com>
;; Maintainer: FSF
;; Keywords: internal

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 3, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.

;;; Commentary:

;; The single entry point, `disassemble', disassembles a code object generated
;; by the Emacs Lisp byte-compiler.  This doesn't invert the compilation
;; operation, not by a long shot, but it's useful for debugging.

;;
;; Original version by Doug Cutting (doug@csli.stanford.edu)
;; Substantially modified by Jamie Zawinski <jwz@lucid.com> for
;; the new lapcode-based byte compiler.

;;; Code:

;;; The variable byte-code-vector is defined by the new bytecomp.el.
;;; The function byte-decompile-lapcode is defined in byte-opt.el.
;;; Since we don't use byte-decompile-lapcode, let's try not loading byte-opt.
(require 'byte-compile "bytecomp")

(defvar disassemble-column-1-indent 8 "*")
(defvar disassemble-column-2-indent 10 "*")

(defvar disassemble-recursive-indent 3 "*")

;;;###autoload
(defun disassemble (object &optional buffer indent interactive-p)
  "Print disassembled code for OBJECT in (optional) BUFFER.
OBJECT can be a symbol defined as a function, or a function itself
\(a lambda expression or a compiled-function object).
If OBJECT is not already compiled, we compile it, but do not
redefine OBJECT if it is a symbol."
  (interactive (list (intern (completing-read "Disassemble function: "
					      obarray 'fboundp t))
		     nil 0 t))
  (if (and (consp object) (not (eq (car object) 'lambda)))
      (setq object (list 'lambda () object)))
  (or indent (setq indent 0))		;Default indent to zero
  (save-excursion
    (if (or interactive-p (null buffer))
	(with-output-to-temp-buffer "*Disassemble*"
	  (set-buffer "*Disassemble*")
	  (disassemble-internal object indent (not interactive-p)))
      (set-buffer buffer)
      (disassemble-internal object indent nil)))
  nil)


(defun disassemble-internal (obj indent interactive-p)
  (let ((macro 'nil)
	(name 'nil)
	(doc 'nil)
	args)
    (while (symbolp obj)
      (setq name obj
	    obj (symbol-function obj)))
    (if (subrp obj)
	(error "Can't disassemble #<subr %s>" name))
    (if (and (listp obj) (eq (car obj) 'autoload))
	(progn
	  (load (nth 1 obj))
	  (setq obj (symbol-function name))))
    (if (eq (car-safe obj) 'macro)	;handle macros
	(setq macro t
	      obj (cdr obj)))
    (if (and (listp obj) (eq (car obj) 'byte-code))
	(setq obj (list 'lambda nil obj)))
    (if (and (listp obj) (not (eq (car obj) 'lambda)))
	(error "not a function"))
    (if (consp obj)
	(if (assq 'byte-code obj)
	    nil
	  (if interactive-p (message (if name
					 "Compiling %s's definition..."
				       "Compiling definition...")
				     name))
	  (setq obj (byte-compile obj))
	  (if interactive-p (message "Done compiling.  Disassembling..."))))
    (cond ((consp obj)
	   (setq obj (cdr obj))		;throw lambda away
	   (setq args (car obj))	;save arg list
	   (setq obj (cdr obj)))
	  ((byte-code-function-p obj)
	   (setq args (aref obj 0)))
          (t (error "Compilation failed")))
    (if (zerop indent) ; not a nested function
	(progn
	  (indent-to indent)
	  (insert (format "byte code%s%s%s:\n"
			  (if (or macro name) " for" "")
			  (if macro " macro" "")
			  (if name (format " %s" name) "")))))
    (let ((doc (if (consp obj)
		   (and (stringp (car obj)) (car obj))
		 ;; Use documentation to get lazy-loaded doc string
		 (documentation obj t))))
      (if (and doc (stringp doc))
	  (progn (and (consp obj) (setq obj (cdr obj)))
		 (indent-to indent)
		 (princ "  doc:  " (current-buffer))
		 (if (string-match "\n" doc)
		     (setq doc (concat (substring doc 0 (match-beginning 0))
				       " ...")))
		 (insert doc "\n"))))
    (indent-to indent)
    (insert "  args: ")
    (prin1 args (current-buffer))
    (insert "\n")
    (let ((interactive (cond ((consp obj)
			      (assq 'interactive obj))
			     ((> (length obj) 5)
			      (list 'interactive (aref obj 5))))))
      (if interactive
	  (progn
	    (setq interactive (nth 1 interactive))
	    (if (eq (car-safe (car-safe obj)) 'interactive)
		(setq obj (cdr obj)))
	    (indent-to indent)
	    (insert " interactive: ")
	    (if (eq (car-safe interactive) 'byte-code)
		(progn
		  (insert "\n")
		  (disassemble-1 interactive
				 (+ indent disassemble-recursive-indent)))
	      (let ((print-escape-newlines t))
		(prin1 interactive (current-buffer))))
	    (insert "\n"))))
    (cond ((and (consp obj) (assq 'byte-code obj))
	   (disassemble-1 (assq 'byte-code obj) indent))
	  ((byte-code-function-p obj)
	   (disassemble-1 obj indent))
	  (t
	   (insert "Uncompiled body:  ")
	   (let ((print-escape-newlines t))
	     (prin1 (if (cdr obj) (cons 'progn obj) (car obj))
		    (current-buffer))))))
  (if interactive-p
      (message "")))


(defun disassemble-1 (obj indent)
  "Prints the byte-code call OBJ in the current buffer.
OBJ should be a call to BYTE-CODE generated by the byte compiler."
  (let (bytes constvec)
    (if (consp obj)
	(setq bytes (car (cdr obj))		;the byte code
	      constvec (car (cdr (cdr obj))))	;constant vector
      ;; If it is lazy-loaded, load it now
      (fetch-bytecode obj)
      (setq bytes (aref obj 1)
	    constvec (aref obj 2)))
    (let ((lap (byte-decompile-bytecode (string-as-unibyte bytes) constvec))
	  op arg opname pc-value)
      (let ((tagno 0)
	    tmp
	    (lap lap))
	(while (setq tmp (assq 'TAG lap))
	  (setcar (cdr tmp) (setq tagno (1+ tagno)))
	  (setq lap (cdr (memq tmp lap)))))
      (while lap
	;; Take off the pc value of the next thing
	;; and put it in pc-value.
	(setq pc-value nil)
	(if (numberp (car lap))
	    (setq pc-value (car lap)
		  lap (cdr lap)))
	;; Fetch the next op and its arg.
	(setq op (car (car lap))
	      arg (cdr (car lap)))
	(setq lap (cdr lap))
	(indent-to indent)
	(if (eq 'TAG op)
	    (progn
	      ;; We have a label.  Display it, but first its pc value.
	      (if pc-value
		  (insert (format "%d:" pc-value)))
	      (insert (int-to-string (car arg))))
	  ;; We have an instruction.  Display its pc value first.
	  (if pc-value
	      (insert (format "%d" pc-value)))
	  (indent-to (+ indent disassemble-column-1-indent))
	  (if (and op
		   (string-match "^byte-" (setq opname (symbol-name op))))
	      (setq opname (substring opname 5))
	    (setq opname "<not-an-opcode>"))
	  (if (eq op 'byte-constant2)
	      (insert " #### shouldn't have seen constant2 here!\n  "))
	  (insert opname)
	  (indent-to (+ indent disassemble-column-1-indent
			disassemble-column-2-indent
			-1))
	  (insert " ")
	  (cond ((memq op byte-goto-ops)
		 (insert (int-to-string (nth 1 arg))))
		((memq op '(byte-call byte-unbind
			    byte-listN byte-concatN byte-insertN))
		 (insert (int-to-string arg)))
		((memq op '(byte-varref byte-varset byte-varbind))
		 (prin1 (car arg) (current-buffer)))
		((memq op '(byte-constant byte-constant2))
		 ;; it's a constant
		 (setq arg (car arg))
		 ;; but if the value of the constant is compiled code, then
		 ;; recursively disassemble it.
		 (cond ((or (byte-code-function-p arg)
			    (and (eq (car-safe arg) 'lambda)
				 (assq 'byte-code arg))
			    (and (eq (car-safe arg) 'macro)
				 (or (byte-code-function-p (cdr arg))
				     (and (eq (car-safe (cdr arg)) 'lambda)
					  (assq 'byte-code (cdr arg))))))
			(cond ((byte-code-function-p arg)
			       (insert "<compiled-function>\n"))
			      ((eq (car-safe arg) 'lambda)
			       (insert "<compiled lambda>"))
			      (t (insert "<compiled macro>\n")))
			(disassemble-internal
			 arg
			 (+ indent disassemble-recursive-indent 1)
			 nil))
		       ((eq (car-safe arg) 'byte-code)
			(insert "<byte code>\n")
			(disassemble-1	;recurse on byte-code object
			 arg
			 (+ indent disassemble-recursive-indent)))
		       ((eq (car-safe (car-safe arg)) 'byte-code)
			(insert "(<byte code>...)\n")
			(mapc ;recurse on list of byte-code objects
			 '(lambda (obj)
			    (disassemble-1
			     obj
			     (+ indent disassemble-recursive-indent)))
			 arg))
		       (t
			;; really just a constant
			(let ((print-escape-newlines t))
			  (prin1 arg (current-buffer))))))
		)
	  (insert "\n")))))
  nil)

(provide 'disass)

;; arch-tag: 89482fe4-a087-4761-8dc6-d771054e763a
;;; disass.el ends here
Commit	Line	Data
fd7fa35a ER	1	;;; disass.el --- disassembler for compiled Emacs Lisp code
fd7fa35a ER	2
3731a850	3	;; Copyright (C) 1986, 1991, 2002, 2003, 2004,
8b72699e	4	;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
9750e079	5
fd7fa35a ER	6	;; Author: Doug Cutting <doug@csli.stanford.edu>
fd7fa35a ER	7	;; Jamie Zawinski <jwz@lucid.com>
dc0485c4	8	;; Maintainer: FSF
e9571d2a	9	;; Keywords: internal
fd7fa35a	10
1c393159 JB	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
e0085d62	15	;; the Free Software Foundation; either version 3, or (at your option)
1c393159 JB	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
b578f267	24	;; along with GNU Emacs; see the file COPYING. If not, write to the
3a35cf56 LK	25	;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
3a35cf56 LK	26	;; Boston, MA 02110-1301, USA.
1c393159	27
fd7fa35a ER	28	;;; Commentary:
fd7fa35a ER	29
e41b2db1 ER	30	;; The single entry point, `disassemble', disassembles a code object generated
	31	;; by the Emacs Lisp byte-compiler. This doesn't invert the compilation
	32	;; operation, not by a long shot, but it's useful for debugging.
	33
	34	;;
	35	;; Original version by Doug Cutting (doug@csli.stanford.edu)
	36	;; Substantially modified by Jamie Zawinski <jwz@lucid.com> for
	37	;; the new lapcode-based byte compiler.
fd7fa35a ER	38
fd7fa35a ER	39	;;; Code:
1c393159 JB	40
1c393159 JB	41	;;; The variable byte-code-vector is defined by the new bytecomp.el.
c29118da JB	42	;;; The function byte-decompile-lapcode is defined in byte-opt.el.
c29118da JB	43	;;; Since we don't use byte-decompile-lapcode, let's try not loading byte-opt.
d28a1925	44	(require 'byte-compile "bytecomp")
1c393159	45
3c7e6b9d	46	(defvar disassemble-column-1-indent 8 "*")
1c393159 JB	47	(defvar disassemble-column-2-indent 10 "*")
	48
	49	(defvar disassemble-recursive-indent 3 "*")
	50
dbc4e1c1	51	;;;###autoload
1c393159 JB	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))
dc0485c4	61	(if (and (consp object) (not (eq (car object) 'lambda)))
1c393159 JB	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))
a33cb021 RS	84	(if (and (listp obj) (eq (car obj) 'autoload))
	85	(progn
	86	(load (nth 1 obj))
	87	(setq obj (symbol-function name))))
1c393159 JB	88	(if (eq (car-safe obj) 'macro) ;handle macros
	89	(setq macro t
	90	obj (cdr obj)))
8dff74b7	91	(if (and (listp obj) (eq (car obj) 'byte-code))
a1506d29	92	(setq obj (list 'lambda nil obj)))
1c393159 JB	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)))
c757fb07 RS	108	((byte-code-function-p obj)
	109	(setq args (aref obj 0)))
	110	(t (error "Compilation failed")))
1c393159 JB	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))
3fd4909e RS	120	;; Use documentation to get lazy-loaded doc string
3fd4909e RS	121	(documentation obj t))))
1c393159 JB	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))
dbc4e1c1	155	((byte-code-function-p obj)
1c393159 JB	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
3fd4909e RS	173	;; If it is lazy-loaded, load it now
3fd4909e RS	174	(fetch-bytecode obj)
d18a808f	175	(setq bytes (aref obj 1)
1c393159	176	constvec (aref obj 2)))
d18a808f	177	(let ((lap (byte-decompile-bytecode (string-as-unibyte bytes) constvec))
3c7e6b9d	178	op arg opname pc-value)
1c393159 JB	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
3c7e6b9d RS	186	;; Take off the pc value of the next thing
	187	;; and put it in pc-value.
	188	(setq pc-value nil)
	189	(if (numberp (car lap))
	190	(setq pc-value (car lap)
	191	lap (cdr lap)))
	192	;; Fetch the next op and its arg.
1c393159 JB	193	(setq op (car (car lap))
1c393159 JB	194	arg (cdr (car lap)))
3c7e6b9d	195	(setq lap (cdr lap))
1c393159 JB	196	(indent-to indent)
1c393159 JB	197	(if (eq 'TAG op)
3c7e6b9d RS	198	(progn
	199	;; We have a label. Display it, but first its pc value.
	200	(if pc-value
	201	(insert (format "%d:" pc-value)))
	202	(insert (int-to-string (car arg))))
	203	;; We have an instruction. Display its pc value first.
	204	(if pc-value
	205	(insert (format "%d" pc-value)))
1c393159 JB	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.
dbc4e1c1	230	(cond ((or (byte-code-function-p arg)
1c393159 JB	231	(and (eq (car-safe arg) 'lambda)
	232	(assq 'byte-code arg))
	233	(and (eq (car-safe arg) 'macro)
dbc4e1c1	234	(or (byte-code-function-p (cdr arg))
1c393159 JB	235	(and (eq (car-safe (cdr arg)) 'lambda)
1c393159 JB	236	(assq 'byte-code (cdr arg))))))
dbc4e1c1	237	(cond ((byte-code-function-p arg)
1c393159 JB	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")
56a1431a	253	(mapc ;recurse on list of byte-code objects
1c393159 JB	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	)
3c7e6b9d	264	(insert "\n")))))
1c393159	265	nil)
fd7fa35a	266
896546cd RS	267	(provide 'disass)
896546cd RS	268
cbee283d	269	;; arch-tag: 89482fe4-a087-4761-8dc6-d771054e763a
fd7fa35a	270	;;; disass.el ends here