1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
|
;;; debug.el --- debuggers and related commands for Emacs
;; Copyright (C) 1985, 1986, 1994 Free Software Foundation, Inc.
;; Maintainer: FSF
;; Keywords: lisp, tools, maint
;; 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 2, 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., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
;;; Commentary:
;; This is a major mode documented in the Emacs manual.
;;; Code:
(defvar debug-function-list nil
"List of functions currently set for debug on entry.")
(defvar debugger-step-after-exit nil
"Non-nil means \"single-step\" after the debugger exits.")
(defvar debugger-value nil
"This is the value for the debugger to return, when it returns.")
(defvar debugger-old-buffer nil
"This is the buffer that was current when the debugger was entered.")
(defvar debugger-outer-match-data)
(defvar debugger-outer-load-read-function)
(defvar debugger-outer-overriding-local-map)
(defvar debugger-outer-track-mouse)
(defvar debugger-outer-last-command)
(defvar debugger-outer-this-command)
(defvar debugger-outer-unread-command-char)
(defvar debugger-outer-unread-command-events)
(defvar debugger-outer-last-input-event)
(defvar debugger-outer-last-command-event)
(defvar debugger-outer-last-nonmenu-event)
(defvar debugger-outer-last-event-frame)
(defvar debugger-outer-standard-input)
(defvar debugger-outer-standard-output)
(defvar debugger-outer-cursor-in-echo-area)
;;;###autoload
(setq debugger 'debug)
;;;###autoload
(defun debug (&rest debugger-args)
"Enter debugger. To return, type \\<debugger-mode-map>`\\[debugger-continue]'.
Arguments are mainly for use when this is called from the internals
of the evaluator.
You may call with no args, or you may pass nil as the first arg and
any other args you like. In that case, the list of args after the
first will be printed into the backtrace buffer."
(interactive)
(message "Entering debugger...")
(let (debugger-value
(debug-on-error nil)
(debug-on-quit nil)
(debugger-buffer (let ((default-major-mode 'fundamental-mode))
(get-buffer-create "*Backtrace*")))
(debugger-old-buffer (current-buffer))
(debugger-step-after-exit nil)
;; Don't keep reading from an executing kbd macro!
(executing-kbd-macro nil)
;; Save the outer values of these vars for the `e' command
;; before we replace the values.
(debugger-outer-match-data (match-data))
(debugger-outer-load-read-function load-read-function)
(debugger-outer-overriding-local-map overriding-local-map)
(debugger-outer-track-mouse track-mouse)
(debugger-outer-last-command last-command)
(debugger-outer-this-command this-command)
(debugger-outer-unread-command-char unread-command-char)
(debugger-outer-unread-command-events unread-command-events)
(debugger-outer-last-input-event last-input-event)
(debugger-outer-last-command-event last-command-event)
(debugger-outer-last-nonmenu-event last-nonmenu-event)
(debugger-outer-last-event-frame last-event-frame)
(debugger-outer-standard-input standard-input)
(debugger-outer-standard-output standard-output)
(debugger-outer-cursor-in-echo-area cursor-in-echo-area))
;; Don't let these magic variables affect the debugger itself.
(let ((last-command nil) this-command track-mouse
(unread-command-char -1) unread-command-events
last-input-event last-command-event last-nonmenu-event
last-event-frame
overriding-local-map
load-read-function
(standard-input t) (standard-output t)
(cursor-in-echo-area nil))
(unwind-protect
(save-excursion
(save-window-excursion
(pop-to-buffer debugger-buffer)
(erase-buffer)
(let ((standard-output (current-buffer))
(print-escape-newlines t)
(print-length 50))
(backtrace))
(goto-char (point-min))
(debugger-mode)
(delete-region (point)
(progn
(search-forward "\n debug(")
(forward-line 1)
(point)))
(debugger-reenable)
;; lambda is for debug-on-call when a function call is next.
;; debug is for debug-on-entry function called.
(cond ((memq (car debugger-args) '(lambda debug))
(insert "Entering:\n")
(if (eq (car debugger-args) 'debug)
(progn
;; Skip the frames for backtrace-debug, byte-code,
;; and debug.
(backtrace-debug 3 t)
(delete-char 1)
(insert ?*)
(beginning-of-line))))
;; Exiting a function.
((eq (car debugger-args) 'exit)
(insert "Return value: ")
(setq debugger-value (nth 1 debugger-args))
(prin1 debugger-value (current-buffer))
(insert ?\n)
(delete-char 1)
(insert ? )
(beginning-of-line))
;; Debugger entered for an error.
((eq (car debugger-args) 'error)
(insert "Signaling: ")
(prin1 (nth 1 debugger-args) (current-buffer))
(insert ?\n))
;; debug-on-call, when the next thing is an eval.
((eq (car debugger-args) t)
(insert "Beginning evaluation of function call form:\n"))
;; User calls debug directly.
(t
(prin1 (if (eq (car debugger-args) 'nil)
(cdr debugger-args) debugger-args)
(current-buffer))
(insert ?\n)))
(message "")
(let ((inhibit-trace t)
(standard-output nil)
(buffer-read-only t))
(message "")
(recursive-edit))))
;; Kill or at least neuter the backtrace buffer, so that users
;; don't try to execute debugger commands in an invalid context.
(if (get-buffer-window debugger-buffer 'visible)
;; Still visible despite the save-window-excursion? Maybe it
;; it's in a pop-up frame. It would be annoying to delete and
;; recreate it every time the debugger stops, so instead we'll
;; erase it but leave it visible.
(save-excursion
(set-buffer debugger-buffer)
(erase-buffer)
(fundamental-mode))
(kill-buffer debugger-buffer))
(store-match-data debugger-outer-match-data)))
;; Put into effect the modified values of these variables
;; in case the user set them with the `e' command.
(setq load-read-function debugger-outer-load-read-function)
(setq overriding-local-map debugger-outer-overriding-local-map)
(setq track-mouse debugger-outer-track-mouse)
(setq last-command debugger-outer-last-command)
(setq this-command debugger-outer-this-command)
(setq unread-command-char debugger-outer-unread-command-char)
(setq unread-command-events debugger-outer-unread-command-events)
(setq last-input-event debugger-outer-last-input-event)
(setq last-command-event debugger-outer-last-command-event)
(setq last-nonmenu-event debugger-outer-last-nonmenu-event)
(setq last-event-frame debugger-outer-last-event-frame)
(setq standard-input debugger-outer-standard-input)
(setq standard-output debugger-outer-standard-output)
(setq cursor-in-echo-area debugger-outer-cursor-in-echo-area)
(setq debug-on-next-call debugger-step-after-exit)
debugger-value))
(defun debugger-step-through ()
"Proceed, stepping through subexpressions of this expression.
Enter another debugger on next entry to eval, apply or funcall."
(interactive)
(setq debugger-step-after-exit t)
(message "Proceeding, will debug on next eval or call.")
(exit-recursive-edit))
(defun debugger-continue ()
"Continue, evaluating this expression without stopping."
(interactive)
(message "Continuing.")
(exit-recursive-edit))
(defun debugger-return-value (val)
"Continue, specifying value to return.
This is only useful when the value returned from the debugger
will be used, such as in a debug on exit from a frame."
(interactive "XReturn value (evaluated): ")
(setq debugger-value val)
(princ "Returning " t)
(prin1 debugger-value)
(exit-recursive-edit))
(defun debugger-jump ()
"Continue to exit from this frame, with all debug-on-entry suspended."
(interactive)
;; Compensate for the two extra stack frames for debugger-jump.
(let ((debugger-frame-offset (+ debugger-frame-offset 2)))
(debugger-frame))
;; Turn off all debug-on-entry functions
;; but leave them in the list.
(let ((list debug-function-list))
(while list
(fset (car list)
(debug-on-entry-1 (car list) (symbol-function (car list)) nil))
(setq list (cdr list))))
(message "Continuing through this frame")
(exit-recursive-edit))
(defun debugger-reenable ()
"Turn all debug-on-entry functions back on."
(let ((list debug-function-list))
(while list
(or (consp (symbol-function (car list)))
(debug-convert-byte-code (car list)))
(fset (car list)
(debug-on-entry-1 (car list) (symbol-function (car list)) t))
(setq list (cdr list)))))
(defun debugger-frame-number ()
"Return number of frames in backtrace before the one point points at."
(save-excursion
(beginning-of-line)
(let ((opoint (point))
(count 0))
(goto-char (point-min))
(if (or (equal (buffer-substring (point) (+ (point) 6))
"Signal")
(equal (buffer-substring (point) (+ (point) 6))
"Return"))
(progn
(search-forward ":")
(forward-sexp 1)))
(forward-line 1)
(while (progn
(forward-char 2)
(if (= (following-char) ?\()
(forward-sexp 1)
(forward-sexp 2))
(forward-line 1)
(<= (point) opoint))
(setq count (1+ count)))
count)))
;; Chosen empirically to account for all the frames
;; that will exist when debugger-frame is called
;; within the first one that appears in the backtrace buffer.
;; Assumes debugger-frame is called from a key;
;; will be wrong if it is called with Meta-x.
(defconst debugger-frame-offset 8 "")
(defun debugger-frame ()
"Request entry to debugger when this frame exits.
Applies to the frame whose line point is on in the backtrace."
(interactive)
(beginning-of-line)
(let ((level (debugger-frame-number)))
(backtrace-debug (+ level debugger-frame-offset) t))
(if (= (following-char) ? )
(let ((buffer-read-only nil))
(delete-char 1)
(insert ?*)))
(beginning-of-line))
(defun debugger-frame-clear ()
"Do not enter to debugger when this frame exits.
Applies to the frame whose line point is on in the backtrace."
(interactive)
(beginning-of-line)
(let ((level (debugger-frame-number)))
(backtrace-debug (+ level debugger-frame-offset) nil))
(if (= (following-char) ?*)
(let ((buffer-read-only nil))
(delete-char 1)
(insert ? )))
(beginning-of-line))
(defun debugger-eval-expression (exp)
"Eval an expression, in an environment like that outside the debugger."
(interactive
(list (read-from-minibuffer "Eval: "
nil read-expression-map t
'read-expression-history)))
(save-excursion
(if (null (buffer-name debugger-old-buffer))
;; old buffer deleted
(setq debugger-old-buffer (current-buffer)))
(set-buffer debugger-old-buffer)
(let ((track-mouse debugger-outer-track-mouse)
(last-command debugger-outer-last-command)
(this-command debugger-outer-this-command)
(unread-command-char debugger-outer-unread-command-char)
(unread-command-events debugger-outer-unread-command-events)
(last-input-event debugger-outer-last-input-event)
(last-command-event debugger-outer-last-command-event)
(last-nonmenu-event debugger-outer-last-nonmenu-event)
(last-event-frame debugger-outer-last-event-frame)
(standard-input debugger-outer-standard-input)
(standard-output debugger-outer-standard-output)
(cursor-in-echo-area debugger-outer-cursor-in-echo-area)
(overriding-local-map debugger-outer-overriding-local-map)
(load-read-function debugger-outer-load-read-function))
(store-match-data debugger-outer-match-data)
(prog1 (eval-expression exp)
(setq debugger-outer-match-data (match-data))
(setq debugger-outer-load-read-function load-read-function)
(setq debugger-outer-overriding-local-map overriding-local-map)
(setq debugger-outer-track-mouse track-mouse)
(setq debugger-outer-last-command last-command)
(setq debugger-outer-this-command this-command)
(setq debugger-outer-unread-command-char unread-command-char)
(setq debugger-outer-unread-command-events unread-command-events)
(setq debugger-outer-last-input-event last-input-event)
(setq debugger-outer-last-command-event last-command-event)
(setq debugger-outer-last-nonmenu-event last-nonmenu-event)
(setq debugger-outer-last-event-frame last-event-frame)
(setq debugger-outer-standard-input standard-input)
(setq debugger-outer-standard-output standard-output)
(setq debugger-outer-cursor-in-echo-area cursor-in-echo-area)))))
(defvar debugger-mode-map nil)
(if debugger-mode-map
nil
(let ((loop ? ))
(setq debugger-mode-map (make-keymap))
(suppress-keymap debugger-mode-map)
(define-key debugger-mode-map "-" 'negative-argument)
(define-key debugger-mode-map "b" 'debugger-frame)
(define-key debugger-mode-map "c" 'debugger-continue)
(define-key debugger-mode-map "j" 'debugger-jump)
(define-key debugger-mode-map "r" 'debugger-return-value)
(define-key debugger-mode-map "u" 'debugger-frame-clear)
(define-key debugger-mode-map "d" 'debugger-step-through)
(define-key debugger-mode-map "l" 'debugger-list-functions)
(define-key debugger-mode-map "h" 'describe-mode)
(define-key debugger-mode-map "q" 'top-level)
(define-key debugger-mode-map "e" 'debugger-eval-expression)
(define-key debugger-mode-map " " 'next-line)))
(put 'debugger-mode 'mode-class 'special)
(defun debugger-mode ()
"Mode for backtrace buffers, selected in debugger.
\\<debugger-mode-map>
A line starts with `*' if exiting that frame will call the debugger.
Type \\[debugger-frame] or \\[debugger-frame-clear] to set or remove the `*'.
When in debugger due to frame being exited,
use the \\[debugger-return-value] command to override the value
being returned from that frame.
Use \\[debug-on-entry] and \\[cancel-debug-on-entry] to control
which functions will enter the debugger when called.
Complete list of commands:
\\{debugger-mode-map}"
(kill-all-local-variables)
(setq major-mode 'debugger-mode)
(setq mode-name "Debugger")
(setq truncate-lines t)
(set-syntax-table emacs-lisp-mode-syntax-table)
(use-local-map debugger-mode-map))
;;;###autoload
(defun debug-on-entry (function)
"Request FUNCTION to invoke debugger each time it is called.
If you tell the debugger to continue, FUNCTION's execution proceeds.
This works by modifying the definition of FUNCTION,
which must be written in Lisp, not predefined.
Use \\[cancel-debug-on-entry] to cancel the effect of this command.
Redefining FUNCTION also cancels it."
(interactive "aDebug on entry (to function): ")
(debugger-reenable)
(if (subrp (symbol-function function))
(error "Function %s is a primitive" function))
(or (consp (symbol-function function))
(debug-convert-byte-code function))
(or (consp (symbol-function function))
(error "Definition of %s is not a list" function))
(fset function (debug-on-entry-1 function (symbol-function function) t))
(or (memq function debug-function-list)
(setq debug-function-list (cons function debug-function-list)))
function)
;;;###autoload
(defun cancel-debug-on-entry (&optional function)
"Undo effect of \\[debug-on-entry] on FUNCTION.
If argument is nil or an empty string, cancel for all functions."
(interactive
(list (let ((name
(completing-read "Cancel debug on entry (to function): "
;; Make an "alist" of the functions
;; that now have debug on entry.
(mapcar 'list
(mapcar 'symbol-name
debug-function-list))
nil t nil)))
(if name (intern name)))))
(debugger-reenable)
(if (and function (not (string= function "")))
(progn
(fset function
(debug-on-entry-1 function (symbol-function function) nil))
(setq debug-function-list (delq function debug-function-list))
function)
(message "Cancelling debug-on-entry for all functions")
(mapcar 'cancel-debug-on-entry debug-function-list)))
(defun debug-convert-byte-code (function)
(let ((defn (symbol-function function)))
(if (not (consp defn))
;; Assume a compiled code object.
(let* ((contents (append defn nil))
(body
(list (list 'byte-code (nth 1 contents)
(nth 2 contents) (nth 3 contents)))))
(if (nthcdr 5 contents)
(setq body (cons (list 'interactive (nth 5 contents)) body)))
(if (nth 4 contents)
;; Use `documentation' here, to get the actual string,
;; in case the compiled function has a reference
;; to the .elc file.
(setq body (cons (documentation function) body)))
(fset function (cons 'lambda (cons (car contents) body)))))))
(defun debug-on-entry-1 (function defn flag)
(if (subrp defn)
(error "%s is a built-in function" function)
(if (eq (car defn) 'macro)
(debug-on-entry-1 function (cdr defn) flag)
(or (eq (car defn) 'lambda)
(error "%s not user-defined Lisp function" function))
(let (tail prec)
(if (stringp (car (nthcdr 2 defn)))
(setq tail (nthcdr 3 defn)
prec (list (car defn) (car (cdr defn))
(car (cdr (cdr defn)))))
(setq tail (nthcdr 2 defn)
prec (list (car defn) (car (cdr defn)))))
(if (eq flag (equal (car tail) '(debug 'debug)))
defn
(if flag
(nconc prec (cons '(debug 'debug) tail))
(nconc prec (cdr tail))))))))
(defun debugger-list-functions ()
"Display a list of all the functions now set to debug on entry."
(interactive)
(with-output-to-temp-buffer "*Help*"
(if (null debug-function-list)
(princ "No debug-on-entry functions now\n")
(princ "Functions set to debug on entry:\n\n")
(let ((list debug-function-list))
(while list
(prin1 (car list))
(terpri)
(setq list (cdr list))))
(princ "Note: if you have redefined a function, then it may no longer\n")
(princ "be set to debug on entry, even if it is in the list."))
(save-excursion
(set-buffer standard-output)
(help-mode))))
;;; debug.el ends here
|