home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / gnu / lucid / lemacs-19.6 / lisp / prim / debug.el next >
Encoding:
Text File  |  1992-08-20  |  11.8 KB  |  344 lines
  1. ;; Debuggers and related commands for Emacs
  2. ;; Copyright (C) 1985, 1986, 1992 Free Software Foundation, Inc.
  3.  
  4. ;; This file is part of GNU Emacs.
  5.  
  6. ;; GNU Emacs is free software; you can redistribute it and/or modify
  7. ;; it under the terms of the GNU General Public License as published by
  8. ;; the Free Software Foundation; either version 2, or (at your option)
  9. ;; any later version.
  10.  
  11. ;; GNU Emacs is distributed in the hope that it will be useful,
  12. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14. ;; GNU General Public License for more details.
  15.  
  16. ;; You should have received a copy of the GNU General Public License
  17. ;; along with GNU Emacs; see the file COPYING.  If not, write to
  18. ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  19.  
  20.  
  21. (defvar debug-function-list nil
  22.   "List of functions currently set for debug on entry.")
  23.  
  24. (setq debugger 'debug)
  25.  
  26. (defun debug (&rest debugger-args)
  27.   "Enter debugger.  Returns if user says \"continue\".
  28. Arguments are mainly for use when this is called
  29.  from the internals of the evaluator.
  30. You may call with no args, or you may
  31.  pass nil as the first arg and any other args you like.
  32.  In that case, the list of args after the first will 
  33.  be printed into the backtrace buffer."
  34.   (message "Entering debugger...")
  35.   (let (debugger-value
  36.     (debugger-match-data (match-data))
  37.     (debug-on-error nil)
  38.     (debug-on-quit nil)
  39.     (debugger-buffer (let ((default-major-mode 'fundamental-mode))
  40.                (generate-new-buffer "*Backtrace*")))
  41.     (debugger-old-buffer (current-buffer))
  42.     (debugger-step-after-exit nil)
  43.     ;; Don't keep reading from an executing kbd macro!
  44.     (executing-macro nil)
  45.     (cursor-in-echo-area nil))
  46.     (unwind-protect
  47.     (save-excursion
  48.       (save-window-excursion
  49.         (pop-to-buffer debugger-buffer)
  50.         (erase-buffer)
  51.         (let ((standard-output (current-buffer))
  52.           (print-escape-newlines t)
  53.           (print-length 50))
  54.           (backtrace))
  55.         (goto-char (point-min))
  56.         (debugger-mode)
  57.         (delete-region (point)
  58.                (progn
  59.                  (re-search-forward "\n[* ] debug(")
  60.                  (forward-line 1)
  61.                  (point)))
  62.         (debugger-reenable)
  63.         (cond ((memq (car debugger-args) '(lambda debug))
  64.            (insert "Entering:\n")
  65.            (if (eq (car debugger-args) 'debug)
  66.                (progn
  67.              (backtrace-debug 4 t)
  68.              (delete-char 1)
  69.              (insert ?*)
  70.              (beginning-of-line))))
  71.           ((eq (car debugger-args) 'exit)
  72.            (insert "Return value: ")
  73.            (setq debugger-value (nth 1 debugger-args))
  74.            (prin1 debugger-value (current-buffer))
  75.            (insert ?\n)
  76.            (delete-char 1)
  77.            (insert ? )
  78.            (beginning-of-line))
  79.           ((eq (car debugger-args) 'error)
  80.            (insert "Signalling: ")
  81.            (prin1 (nth 1 debugger-args) (current-buffer))
  82.            (insert ?\n))
  83.           ((eq (car debugger-args) t)
  84.            (insert "Beginning evaluation of function call form:\n"))
  85.           (t
  86.            (prin1 (if (eq (car debugger-args) 'nil)
  87.                   (cdr debugger-args) debugger-args)
  88.               (current-buffer))
  89.            (insert ?\n)))
  90.         (message "")
  91.         (let ((inhibit-trace t)
  92.           (standard-output nil)
  93.           (buffer-read-only t))
  94.           (message "")
  95.           (recursive-edit))))
  96.       ;; So that users do not try to execute debugger commands
  97.       ;;  in an invalid context
  98.       (kill-buffer debugger-buffer)
  99.       (store-match-data debugger-match-data))
  100.     (setq debug-on-next-call debugger-step-after-exit)
  101.     debugger-value))
  102.  
  103. (defun debugger-step-through ()
  104.   "Proceed, stepping through subexpressions of this expression.
  105. Enter another debugger on next entry to eval, apply or funcall."
  106.   (interactive)
  107.   (setq debugger-step-after-exit t)
  108.   (message "Proceding, will debug on next eval or call.")
  109.   (exit-recursive-edit))
  110.  
  111. (defun debugger-continue ()
  112.   "Continue, evaluating this expression without stopping."
  113.   (interactive)
  114.   (message "Continuing.")
  115.   (exit-recursive-edit))
  116.  
  117. (defun debugger-return-value (val)
  118.   "Continue, specifying value to return.
  119. This is only useful when the value returned from the debugger
  120. will be used, such as in a debug on exit from a frame."
  121.   (interactive "XReturn value (evaluated): ")
  122.   (setq debugger-value val)
  123.   (princ "Returning " t)
  124.   (prin1 debugger-value)
  125.   (exit-recursive-edit))
  126.  
  127. (defun debugger-jump ()
  128.   "Continue to exit from this frame, with all debug-on-entry suspended."
  129.   (interactive)
  130.   ;; Compensate for the two extra stack frames for debugger-jump.
  131.   (let ((debugger-frame-offset (+ debugger-frame-offset 2)))
  132.     (debugger-frame))
  133.   ;; Turn off all debug-on-entry functions
  134.   ;; but leave them in the list.
  135.   (let ((list debug-function-list))
  136.     (while list
  137.       (fset (car list)
  138.         (debug-on-entry-1 (car list) (symbol-function (car list)) nil))
  139.       (setq list (cdr list))))
  140.   (message "Continuing through this frame")
  141.   (exit-recursive-edit))
  142.  
  143. (defun debugger-reenable ()
  144.   ;; Turn all debug-on-entry functions back on.
  145.   (let ((list debug-function-list))
  146.     (while list
  147.       (or (consp (symbol-function (car list)))
  148.       (debug-convert-byte-code (car list)))
  149.       (fset (car list)
  150.         (debug-on-entry-1 (car list) (symbol-function (car list)) t))
  151.       (setq list (cdr list)))))
  152.  
  153. (defun debugger-frame-number ()
  154.   "Return number of frames in backtrace before the one point points at."
  155.   (save-excursion
  156.     (beginning-of-line)
  157.     (let ((opoint (point))
  158.       (count 0))
  159.       (goto-char (point-min))
  160.       (if (or (equal (buffer-substring (point) (+ (point) 6))
  161.              "Signal")
  162.           (equal (buffer-substring (point) (+ (point) 6))
  163.              "Return"))
  164.       (progn
  165.         (search-forward ":")
  166.         (forward-sexp 1)))
  167.       (forward-line 1)
  168.       (while (progn
  169.            (forward-char 2)
  170.            (if (= (following-char) ?\()
  171.            (forward-sexp 1)
  172.          (forward-sexp 2))
  173.            (forward-line 1)
  174.            (<= (point) opoint))
  175.     (setq count (1+ count)))
  176.       count)))
  177.  
  178. ;; Chosen empirically to account for all the frames
  179. ;; that will exist when debugger-frame is called
  180. ;; within the first one that appears in the backtrace buffer.
  181. ;; Assumes debugger-frame is called from a key;
  182. ;; will be wrong if it is called with Meta-x.
  183. (defconst debugger-frame-offset 8 "")
  184.  
  185. (defun debugger-frame ()
  186.   "Request entry to debugger when this frame exits.
  187. Applies to the frame whose line point is on in the backtrace."
  188.   (interactive)
  189.   (beginning-of-line)
  190.   (let ((level (debugger-frame-number)))
  191.     (backtrace-debug (+ level debugger-frame-offset) t))
  192.   (if (= (following-char) ? )
  193.       (let ((buffer-read-only nil))
  194.     (delete-char 1)
  195.     (insert ?*)))
  196.   (beginning-of-line))
  197.  
  198. (defun debugger-frame-clear ()
  199.   "Do not enter to debugger when this frame exits.
  200. Applies to the frame whose line point is on in the backtrace."
  201.   (interactive)
  202.   (beginning-of-line)
  203.   (let ((level (debugger-frame-number)))
  204.     (backtrace-debug (+ level debugger-frame-offset) nil))
  205.   (if (= (following-char) ?*)
  206.       (let ((buffer-read-only nil))
  207.     (delete-char 1)
  208.     (insert ? )))
  209.   (beginning-of-line))
  210.  
  211. (defun debugger-eval-expression (exp)
  212.   (interactive "xEval: ")
  213.   (save-excursion
  214.     (if (null (buffer-name debugger-old-buffer))
  215.     ;; old buffer deleted
  216.     (setq debugger-old-buffer (current-buffer)))
  217.     (set-buffer debugger-old-buffer)
  218.     (eval-expression exp)))
  219.  
  220. (defvar debugger-mode-map nil)
  221. (if debugger-mode-map
  222.     nil
  223.   (let ((loop ? ))
  224.     (setq debugger-mode-map (make-keymap))
  225.     (suppress-keymap debugger-mode-map)
  226.     (define-key debugger-mode-map "-" 'negative-argument)
  227.     (define-key debugger-mode-map "b" 'debugger-frame)
  228.     (define-key debugger-mode-map "c" 'debugger-continue)
  229.     (define-key debugger-mode-map "j" 'debugger-jump)
  230.     (define-key debugger-mode-map "r" 'debugger-return-value)
  231.     (define-key debugger-mode-map "u" 'debugger-frame-clear)
  232.     (define-key debugger-mode-map "d" 'debugger-step-through)
  233.     (define-key debugger-mode-map "l" 'debugger-list-functions)
  234.     (define-key debugger-mode-map "h" 'describe-mode)
  235.     (define-key debugger-mode-map "q" 'top-level)
  236.     (define-key debugger-mode-map "e" 'debugger-eval-expression)
  237.     (define-key debugger-mode-map " " 'next-line)))
  238.  
  239. (put 'debugger-mode 'mode-class 'special)
  240.  
  241. (defun debugger-mode ()
  242.   "Mode for backtrace buffers, selected in debugger.
  243. \\<debugger-mode-map>
  244. A line starts with `*' if exiting that frame will call the debugger.
  245. Type \\[debugger-frame] or \\[debugger-frame-clear] to set or remove the `*'.
  246.  
  247. When in debugger due to frame being exited,
  248. use the \\[debugger-return-value] command to override the value
  249. being returned from that frame.
  250.  
  251. Use \\[debug-on-entry] and \\[cancel-debug-on-entry] to control
  252. which functions will enter the debugger when called.
  253.  
  254. Complete list of commands:
  255. \\{debugger-mode-map}"
  256.   (kill-all-local-variables)    
  257.   (setq major-mode 'debugger-mode)
  258.   (setq mode-name "Debugger")
  259.   (setq truncate-lines t)
  260.   (set-syntax-table emacs-lisp-mode-syntax-table)
  261.   (use-local-map debugger-mode-map))
  262.  
  263. (defun debug-on-entry (function)
  264.   "Request FUNCTION to invoke debugger each time it is called.
  265. If the user continues, FUNCTION's execution proceeds.
  266. Works by modifying the definition of FUNCTION,
  267. which must be written in Lisp, not predefined.
  268. Use \\[cancel-debug-on-entry] to cancel the effect of this command.
  269. Redefining FUNCTION also does that."
  270.   (interactive "aDebug on entry (to function): ")
  271.   (debugger-reenable)
  272.   (if (subrp (symbol-function function))
  273.       (error "Function %s is a primitive" function))
  274.   (or (consp (symbol-function function))
  275.       (debug-convert-byte-code function))
  276.   (or (consp (symbol-function function))
  277.       (error "Definition of %s is not a list" function))
  278.   (fset function (debug-on-entry-1 function (symbol-function function) t))
  279.   (or (memq function debug-function-list)
  280.       (setq debug-function-list (cons function debug-function-list)))
  281.   function)
  282.  
  283. (defun cancel-debug-on-entry (&optional function)
  284.   "Undo effect of \\[debug-on-entry] on FUNCTION.
  285. If argument is nil or an empty string, cancel for all functions."
  286.   (interactive "aCancel debug on entry (to function): ")
  287.   (debugger-reenable)
  288.   (if (and function (not (string= function "")))
  289.       (progn
  290.     (fset function
  291.           (debug-on-entry-1 function (symbol-function function) nil))
  292.     (setq debug-function-list (delq function debug-function-list))
  293.     function)
  294.     (message "Cancelling debug-on-entry for all functions")
  295.     (mapcar 'cancel-debug-on-entry debug-function-list)))
  296.  
  297. (defun debug-convert-byte-code (function)
  298.   (let ((defn (symbol-function function)))
  299.     (if (not (consp defn))
  300.     ;; Assume a compiled code object.
  301.     (let* ((contents (append defn nil))
  302.            (body
  303.         (list (list 'byte-code (nth 1 contents)
  304.                 (nth 2 contents) (nth 3 contents)))))
  305.       (if (nthcdr 5 contents)
  306.           (setq body (cons (list 'interactive (nth 5 contents)) body)))
  307.       (if (nth 4 contents)
  308.           (setq body (cons (nth 4 contents) body)))
  309.       (fset function (cons 'lambda (cons (car contents) body)))))))
  310.  
  311. (defun debug-on-entry-1 (function defn flag)
  312.   (if (subrp defn)
  313.       (error "%s is a built-in function" function)
  314.     (if (eq (car defn) 'macro)
  315.     (debug-on-entry-1 function (cdr defn) flag)
  316.       (or (eq (car defn) 'lambda)
  317.       (error "%s not user-defined Lisp function" function))
  318.       (let (tail prec)
  319.     (if (stringp (car (nthcdr 2 defn)))
  320.         (setq tail (nthcdr 3 defn)
  321.           prec (list (car defn) (car (cdr defn)) (car (cdr (cdr defn)))))
  322.       (setq tail (nthcdr 2 defn)
  323.         prec (list (car defn) (car (cdr defn)))))
  324.     (if (eq flag (equal (car tail) '(debug 'debug)))
  325.         defn
  326.       (if flag
  327.           (nconc prec (cons '(debug 'debug) tail))
  328.         (nconc prec (cdr tail))))))))
  329.  
  330. (defun debugger-list-functions ()
  331.   "Display a list of all the functions now set to debug on entry."
  332.   (interactive)
  333.   (with-output-to-temp-buffer "*Help*"
  334.     (if (null debug-function-list)
  335.     (princ "No debug-on-entry functions now\n")
  336.       (princ "Functions set to debug on entry:\n\n")
  337.       (let ((list debug-function-list))
  338.     (while list
  339.       (prin1 (car list))
  340.       (terpri)
  341.       (setq list (cdr list))))
  342.       (princ "Note: if you have redefined a function, then it may no longer\n")
  343.       (princ "be set to debug on entry, even if it is in the list."))))
  344.