emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

refactor(lib): replace doom-debugger with advice

Browse source 
Writing a debugger for Elisp is too much hassle. `debug` itself isn't
very customizable without a *lot* of boilerplate, so instead of writing
my own, it's more effective to advise debug instead. Certainly, I don't
do anything with it yet, but I will soon.
This commit is contained in:
Henrik Lissner 2022-09-10 17:54:32 +02:00
parent b66ccaeca0
commit d290152a8e
No known key found for this signature in database
GPG key ID: B60957CA074D39A3
3 changed files with 27 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

44
lisp/lib/debug.el
View file

@ -7,13 +7,13 @@
;;;###autoload
(defvar doom-debug-variables
'(;; Doom variables
`(;; Doom variables
(doom-print-level . debug)
(doom-print-message-level . info)
;; Emacs variables
async-debug
debug-on-error
(debugger . doom-debugger)
garbage-collection-messages
gcmh-verbose
init-file-debug
@ -84,10 +84,29 @@ symbol and CDR is the value to set it to when `doom-debug-mode' is activated.")
;;
;;; Custom debuggers
;;; Custom debugger
;; HACK: I advise `debug' instead of changing `debugger' to hide the debugger
;; itself from the backtrace. Doing it manually would require reimplementing
;; most of `debug', which is a lot of unnecessary work, when I only want to
;; decorate the original one slightly.
(defadvice! doom-debugger-a (fn &rest args)
:around #'debug
;; Without `doom-debug-mode', be as vanilla as possible.
(if (not doom-debug-mode)
(apply fn args)
;; Work around Emacs's heuristic (in eval.c) for detecting errors in the
;; debugger, which would run this handler again on subsequent calls. Taken
;; from `ert--run-test-debugger'.
(if (and noninteractive (fboundp 'doom-cli-debugger))
(apply #'doom-cli-debugger args)
;; TODO: Write backtraces to file
;; TODO: Write backtrace to a buffer in case recursive error interupts the
;; debugger (happens more often than it should).
(apply fn args))))
(autoload 'backtrace-get-frames "backtrace")
;;;###autoload
(defun doom-backtrace ()
"Return a stack trace as a list of `backtrace-frame' objects."
;; (let* ((n 0)
@ -134,23 +153,6 @@ symbol and CDR is the value to set it to when `doom-debug-mode' is activated.")
backtrace))
file)))
(defun doom-debugger (&rest args)
"Enter `debugger' in interactive sessions, `doom-cli-debugger' otherwise.
Writes backtraces to file and ensures the backtrace is recorded, so the user can
always access it."
(let ((backtrace (doom-backtrace)))
;; Work around Emacs's heuristic (in eval.c) for detecting errors in the
;; debugger, which would run this handler again on subsequent calls. Taken
;; from `ert--run-test-debugger'.
(cl-incf num-nonmacro-input-events)
(if (and noninteractive (fboundp 'doom-cli-debugger))
(apply #'doom-cli-debugger args)
;; TODO Write backtraces to file
;; TODO Write backtrace to a buffer in case recursive error interupts the
;; debugger (happens more often than it should).
(apply #'debug args))))
;;
;;; Time-stamped *Message* logs