home *** CD-ROM | disk | FTP | other *** search
/ Education Sampler 1992 [NeXTSTEP] / Education_1992_Sampler.iso / NeXT / GnuSource / emacs-15.0.3 / lisp / debug.el < prev    next >
Lisp/Scheme  |  1990-07-19  |  9KB  |  263 lines
  1. ;; Debuggers and related commands for Emacs
  2. ;; Copyright (C) 1985, 1986 Free Software Foundation, Inc.
  3.  
  4. ;; This file is part of GNU Emacs.
  5.  
  6. ;; GNU Emacs is distributed in the hope that it will be useful,
  7. ;; but WITHOUT ANY WARRANTY.  No author or distributor
  8. ;; accepts responsibility to anyone for the consequences of using it
  9. ;; or for whether it serves any particular purpose or works at all,
  10. ;; unless he says so in writing.  Refer to the GNU Emacs General Public
  11. ;; License for full details.
  12.  
  13. ;; Everyone is granted permission to copy, modify and redistribute
  14. ;; GNU Emacs, but only under the conditions described in the
  15. ;; GNU Emacs General Public License.   A copy of this license is
  16. ;; supposed to have been given to you along with GNU Emacs so you
  17. ;; can know your rights and responsibilities.  It should be in a
  18. ;; file named COPYING.  Among other things, the copyright notice
  19. ;; and this notice must be preserved on all copies.
  20.  
  21.  
  22. (setq debugger 'debug)
  23.  
  24. (defun debug (&rest debugger-args)
  25.   "Enter debugger.  Returns if user says \"continue\".
  26. Arguments are mainly for use when this is called
  27.  from the internals of the evaluator.
  28. You may call with no args, or you may
  29.  pass nil as the first arg and any other args you like.
  30.  In that case, the list of args after the first will 
  31.  be printed into the backtrace buffer."
  32.   (message "Entering debugger...")
  33.   (let (debugger-value
  34.     (debugger-match-data (match-data))
  35.     (debug-on-error nil)
  36.     (debug-on-quit nil)
  37.     (debugger-buffer (let ((default-major-mode 'fundamental-mode))
  38.                (generate-new-buffer "*Backtrace*")))
  39.     (debugger-old-buffer (current-buffer))
  40.     (debugger-step-after-exit nil)
  41.     ;; Don't keep reading from an executing kbd macro!
  42.     (executing-macro nil)
  43.     (cursor-in-echo-area nil))
  44.     (unwind-protect
  45.     (save-excursion
  46.       (save-window-excursion
  47.         (pop-to-buffer debugger-buffer)
  48.         (erase-buffer)
  49.         (let ((standard-output (current-buffer))
  50.           (print-escape-newlines t)
  51.           (print-length 50))
  52.           (backtrace))
  53.         (goto-char (point-min))
  54.         (debugger-mode)
  55.         (delete-region (point)
  56.                (progn
  57.                  (forward-sexp 8)
  58.                  (forward-line 1)
  59.                  (point)))
  60.         (cond ((memq (car debugger-args) '(lambda debug))
  61.            (insert "Entering:\n")
  62.            (if (eq (car debugger-args) 'debug)
  63.                (progn
  64.              (backtrace-debug 4 t)
  65.              (delete-char 1)
  66.              (insert ?*)
  67.              (beginning-of-line))))
  68.           ((eq (car debugger-args) 'exit)
  69.            (insert "Return value: ")
  70.            (setq debugger-value (nth 1 debugger-args))
  71.            (prin1 debugger-value (current-buffer))
  72.            (insert ?\n)
  73.            (delete-char 1)
  74.            (insert ? )
  75.            (beginning-of-line))
  76.           ((eq (car debugger-args) 'error)
  77.            (insert "Signalling: ")
  78.            (prin1 (nth 1 debugger-args) (current-buffer))
  79.            (insert ?\n))
  80.           ((eq (car debugger-args) t)
  81.            (insert "Beginning evaluation of function call form:\n"))
  82.           (t
  83.            (prin1 (if (eq (car debugger-args) 'nil)
  84.                   (cdr debugger-args) debugger-args)
  85.               (current-buffer))
  86.            (insert ?\n)))
  87.         (message "")
  88.         (let ((inhibit-trace t)
  89.           (standard-output nil)
  90.           (buffer-read-only t))
  91.           (message "")
  92.           (recursive-edit))))
  93.       ;; So that users do not try to execute debugger commands
  94.       ;;  in an invalid context
  95.       (kill-buffer debugger-buffer)
  96.       (store-match-data debugger-match-data))
  97.     (setq debug-on-next-call debugger-step-after-exit)
  98.     debugger-value))
  99.  
  100. (defun debugger-step-through ()
  101.   "Proceed, stepping through subexpressions of this expression.
  102. Enter another debugger on next entry to eval, apply or funcall."
  103.   (interactive)
  104.   (setq debugger-step-after-exit t)
  105.   (message "Proceding, will debug on next eval or call.")
  106.   (exit-recursive-edit))
  107.  
  108. (defun debugger-continue ()
  109.   "Continue, evaluating this expression without stopping."
  110.   (interactive)
  111.   (message "Continuing.")
  112.   (exit-recursive-edit))
  113.  
  114. (defun debugger-return-value (val)
  115.   "Continue, specifying value to return.
  116. This is only useful when the value returned from the debugger
  117. will be used, such as in a debug on exit from a frame."
  118.   (interactive "XReturn value (evaluated): ")
  119.   (setq debugger-value val)
  120.   (princ "Returning " t)
  121.   (prin1 debugger-value)
  122.   (exit-recursive-edit))
  123.  
  124. (defun debugger-frame-number ()
  125.   "Return number of frames in backtrace before the one point points at."
  126.   (save-excursion
  127.     (beginning-of-line)
  128.     (let ((opoint (point))
  129.       (count 0))
  130.       (goto-char (point-min))
  131.       (if (or (equal (buffer-substring (point) (+ (point) 6))
  132.              "Signal")
  133.           (equal (buffer-substring (point) (+ (point) 6))
  134.              "Return"))
  135.       (progn
  136.         (search-forward ":")
  137.         (forward-sexp 1)))
  138.       (forward-line 1)
  139.       (while (progn
  140.            (forward-char 2)
  141.            (if (= (following-char) ?\()
  142.            (forward-sexp 1)
  143.          (forward-sexp 2))
  144.            (forward-line 1)
  145.            (<= (point) opoint))
  146.     (setq count (1+ count)))
  147.       count)))
  148.  
  149. ;; Chosen empirically to account for all the frames
  150. ;; that will exist when debugger-frame is called
  151. ;; within the first one that appears in the backtrace buffer.
  152. ;; Assumes debugger-frame is called from a key;
  153. ;; will be wrong if it is called with Meta-x.
  154. (defconst debugger-frame-offset 8 "")
  155.  
  156. (defun debugger-frame ()
  157.   "Request entry to debugger when this frame exits.
  158. Applies to the frame whose line point is on in the backtrace."
  159.   (interactive)
  160.   (beginning-of-line)
  161.   (let ((level (debugger-frame-number)))
  162.     (backtrace-debug (+ level debugger-frame-offset) t))
  163.   (if (= (following-char) ? )
  164.       (let ((buffer-read-only nil))
  165.     (delete-char 1)
  166.     (insert ?*)))
  167.   (beginning-of-line))
  168.  
  169. (defun debugger-frame-clear ()
  170.   "Do not enter to debugger when this frame exits.
  171. Applies to the frame whose line point is on in the backtrace."
  172.   (interactive)
  173.   (beginning-of-line)
  174.   (let ((level (debugger-frame-number)))
  175.     (backtrace-debug (+ level debugger-frame-offset) nil))
  176.   (if (= (following-char) ?*)
  177.       (let ((buffer-read-only nil))
  178.     (delete-char 1)
  179.     (insert ? )))
  180.   (beginning-of-line))
  181.  
  182. (defun debugger-eval-expression (exp)
  183.   (interactive "xEval: ")
  184.   (save-excursion
  185.     (if (null (buffer-name debugger-old-buffer))
  186.     ;; old buffer deleted
  187.     (setq debugger-old-buffer (current-buffer)))
  188.     (set-buffer debugger-old-buffer)
  189.     (eval-expression exp)))
  190.  
  191. (defvar debugger-mode-map nil)
  192. (if debugger-mode-map
  193.     nil
  194.   (let ((loop ? ))
  195.     (setq debugger-mode-map (make-keymap))
  196.     (suppress-keymap debugger-mode-map)
  197.     (define-key debugger-mode-map "-" 'negative-argument)
  198.     (define-key debugger-mode-map "b" 'debugger-frame)
  199.     (define-key debugger-mode-map "c" 'debugger-continue)
  200.     (define-key debugger-mode-map "r" 'debugger-return-value)
  201.     (define-key debugger-mode-map "u" 'debugger-frame-clear)
  202.     (define-key debugger-mode-map "d" 'debugger-step-through)
  203.     (define-key debugger-mode-map "h" 'describe-mode)
  204.     (define-key debugger-mode-map "q" 'top-level)
  205.     (define-key debugger-mode-map "e" 'debugger-eval-expression)
  206.     (define-key debugger-mode-map " " 'next-line)))
  207.  
  208. (put 'debugger-mode 'mode-class 'special)
  209.  
  210. (defun debugger-mode ()
  211.   "Mode for backtrace buffers, selected in debugger.
  212. \\{debugger-mode-map}
  213. For the r command, when in debugger due to frame being exited,
  214.     the value specified here will be used as the value of that frame.
  215.  
  216. Note lines starting with * are frames that will
  217.  enter debugger when exited."
  218.   (kill-all-local-variables)    
  219.   (setq major-mode 'debugger-mode)
  220.   (setq mode-name "Debugger")
  221.   (setq truncate-lines t)
  222.   (set-syntax-table emacs-lisp-mode-syntax-table)
  223.   (use-local-map debugger-mode-map))
  224.  
  225. (defun debug-on-entry (function)
  226.   "Request FUNCTION to invoke debugger each time it is called.
  227. If the user continues, FUNCTION's execution proceeds.
  228. Works by modifying the definition of FUNCTION,
  229. which must be written in Lisp, not predefined.
  230. Use `cancel-debug-on-entry' to cancel the effect of this command.
  231. Redefining FUNCTION also does that."
  232.   (interactive "aDebug on entry (to function): ")
  233.   (let ((defn (symbol-function function)))
  234.     (if (eq (car defn) 'macro)
  235.     (fset function (cons 'macro (debug-on-entry-1 function (cdr defn) t)))
  236.       (fset function (debug-on-entry-1 function defn t))))
  237.   function)
  238.  
  239. (defun cancel-debug-on-entry (function)
  240.   "Undoes effect of debug-on-entry on FUNCTION."
  241.   (interactive "aCancel debug on entry (to function): ")
  242.   (let ((defn (symbol-function function)))
  243.     (if (eq (car defn) 'macro)
  244.     (fset function
  245.           (cons 'macro (debug-on-entry-1 function (cdr defn) nil)))
  246.       (fset function (debug-on-entry-1 function defn nil))))
  247.   function)
  248.  
  249. (defun debug-on-entry-1 (function defn flag)
  250.   (or (eq (car defn) 'lambda)
  251.       (error "%s not user-defined Lisp function." function))
  252.   (let (tail prec)
  253.     (if (stringp (car (nthcdr 2 defn)))
  254.     (setq tail (nthcdr 3 defn)
  255.           prec (list (car defn) (car (cdr defn)) (car (cdr (cdr defn)))))
  256.       (setq tail (nthcdr 2 defn)
  257.         prec (list (car defn) (car (cdr defn)))))
  258.     (if (eq flag (equal (car tail) '(debug 'debug)))
  259.     nil
  260.       (if flag
  261.       (nconc prec (cons '(debug 'debug) tail))
  262.     (nconc prec (cdr tail))))))
  263.