mirror of
https://github.com/doomemacs/doomemacs
synced 2025-08-17 13:33:36 -05:00
refactor!(debugger): replace realgud with dape
BREAKING CHANGE: Anyone used to realgud will find it missing as of this commit. It's been replaced with Dape (see https://github.com/svaante/dape). This change was made because realgud's implementation was archaic and over-complicated, dap-mode requires lsp-mode (and has a lot of moving parts and points of failure), and dape is straight-forward by comparison; to set up and use. Note that dap-mode and dap-ui is now deprecated and will be removed in the future, but still remains behind the +lsp flag for backwards compatibility, at least until v3. This also adds a '<leader> d' prefix for debugger commands (except for vanilla users, who already have dape's prefix on 'C-x C-a')
This commit is contained in:
Henrik Lissner
@@ -1,134 +1,25 @@
|
||||
;;; tools/debugger/autoload/debugger.el -*- lexical-binding: t; -*-
|
||||
|
||||
(defvar-local +debugger--last-config nil
|
||||
"Configuration of the last debugging session of buffer.")
|
||||
(put '+debugger--last-config 'permanent-local t) ; don't kill on mode change
|
||||
|
||||
(defun +debugger--get-last-config ()
|
||||
"Get last debugging configuration.
|
||||
|
||||
If in a project, returns the configuration of the last debugging session in the
|
||||
project, if any. Else, returns the last debugging configuration of the current
|
||||
buffer, if any."
|
||||
(if (doom-project-p)
|
||||
(doom-store-get (doom-project-root) "+debugger")
|
||||
+debugger--last-config))
|
||||
|
||||
(defun +debugger--set-config (config)
|
||||
"Remember this debugging configuration for `+debugger/start-last'.
|
||||
|
||||
If in a project, sets the project's debugging session configuration. Else, sets
|
||||
the debugging configuration of the current buffer."
|
||||
(if (doom-project-p)
|
||||
(doom-store-put (doom-project-root) config
|
||||
(lambda (key _cfg) (file-directory-p key))
|
||||
"+debugger")
|
||||
(setq +debugger--last-config config)))
|
||||
|
||||
(defun +debugger--list-for-dap ()
|
||||
(and (or (bound-and-true-p lsp-mode)
|
||||
(bound-and-true-p lsp--buffer-deferred))
|
||||
(require 'dap-mode nil t)
|
||||
dap-mode
|
||||
(mapcar (lambda (c) (cons 'dap c))
|
||||
(apply #'append (mapcar #'funcall dap-launch-configuration-providers)))))
|
||||
|
||||
(defun +debugger--list-for-realgud ()
|
||||
(mapcar (lambda (c) (cons 'realgud (list (symbol-name c))))
|
||||
(cl-loop for (sym . plist) in +debugger--realgud-alist
|
||||
for sym-name = (symbol-name sym)
|
||||
for modes = (plist-get plist :modes)
|
||||
if (or (null modes) (apply #'derived-mode-p modes))
|
||||
collect sym)))
|
||||
|
||||
;; Based on dap--completing-read and dap-debug
|
||||
(defun +debugger-completing-read ()
|
||||
"Completing read for debug configuration.
|
||||
|
||||
Presents both dap and realgud configurations, and returns a list of the form
|
||||
\('dap ...) or ('realgud ...) containing the corresponding debug configuration
|
||||
infromation."
|
||||
(let* ((result (mapcar (lambda (c) (cons (cadr c) c))
|
||||
(append (+debugger--list-for-dap)
|
||||
(+debugger--list-for-realgud))))
|
||||
(completion (completing-read "Start debugger: " (mapcar #'car result) nil t)))
|
||||
(if (or (null completion) (string-empty-p completion))
|
||||
(user-error "No debugging configuration specified.")
|
||||
(let ((configuration (cdr (assoc completion result))))
|
||||
(if (eq (car configuration) 'dap)
|
||||
;; get dap debugging arguments
|
||||
(let* ((debug-args (dap-variables-expand-in-launch-configuration
|
||||
(copy-tree (cddr configuration))))
|
||||
(launch-args (or (catch 'is-nil
|
||||
(funcall (or (gethash
|
||||
(or (plist-get debug-args :type)
|
||||
(throw 'is-nil nil)) dap--debug-providers)
|
||||
(throw 'is-nil nil)) debug-args))
|
||||
(user-error "Have you loaded the `%s' specific dap package?"
|
||||
(or (plist-get debug-args :type)
|
||||
(user-error "%s does not specify :type" debug-args))))))
|
||||
(cons 'dap launch-args))
|
||||
(cons 'realgud (intern (cadr configuration))))))))
|
||||
|
||||
;;
|
||||
;;; Interactive commands
|
||||
|
||||
;;;###autoload
|
||||
(defun +debugger/start-last ()
|
||||
"Relaunch the last debugger session."
|
||||
(defun +debugger/start ()
|
||||
"Start a debugger in the current project and buffer."
|
||||
(interactive)
|
||||
(let ((configuration (+debugger--get-last-config)))
|
||||
(unless configuration
|
||||
(user-error "No last debugger%s to invoke"
|
||||
(if (doom-project-p)
|
||||
" of this project"
|
||||
"")))
|
||||
(let ((launch-args (cdr configuration)))
|
||||
(if (eq (car configuration) 'dap)
|
||||
;; start dap configuration
|
||||
(if (functionp launch-args)
|
||||
(funcall launch-args #'dap-start-debugging-noexpand)
|
||||
(dap-start-debugging-noexpand launch-args))
|
||||
;; else start realgud configuration:
|
||||
(call-interactively launch-args)))))
|
||||
|
||||
;;;###autoload
|
||||
(defun +debugger/start (arg)
|
||||
"Launch a debugger session.
|
||||
|
||||
Launches the last used debugger, if one exists. Otherwise, you will be prompted
|
||||
for what debugger to use. If the prefix ARG is set, prompt anyway."
|
||||
(interactive "P")
|
||||
(when (or arg (null (+debugger--get-last-config)))
|
||||
(+debugger--set-config (+debugger-completing-read)))
|
||||
(+debugger/start-last))
|
||||
(call-interactively
|
||||
(if (and (modulep! +lsp)
|
||||
(bound-and-true-p lsp-mode)
|
||||
(require 'dap-mode nil t))
|
||||
#'dap-debug
|
||||
#'dape)))
|
||||
|
||||
;;;###autoload
|
||||
(defun +debugger/quit ()
|
||||
"Quit the active debugger, if any."
|
||||
"Quit the active debugger session."
|
||||
(interactive)
|
||||
(cond ((and (fboundp 'dap--cur-session) (dap--cur-session))
|
||||
(dap-disconnect (dap--cur-session)))
|
||||
((and (fboundp 'realgud-get-cmdbuf) (realgud-get-cmdbuf))
|
||||
(let ((buf (realgud-get-cmdbuf)))
|
||||
(ignore-errors
|
||||
(call-interactively #'realgud:cmd-quit))
|
||||
(let (realgud-safe-mode)
|
||||
(kill-buffer buf))))
|
||||
((user-error "No debugging session to quit"))))
|
||||
|
||||
;; TODO debugger breakpoint commands
|
||||
;; ;;;###autoload
|
||||
;; (defun +debugger/toggle-breakpoint ()
|
||||
;; (interactive)
|
||||
;; (user-error "not implemented yet"))
|
||||
|
||||
;; ;;;###autoload
|
||||
;; (defun +debugger/next-breakpoint ()
|
||||
;; (interactive)
|
||||
;; (user-error "not implemented yet"))
|
||||
|
||||
;; ;;;###autoload
|
||||
;; (defun +debugger/previous-breakpoint ()
|
||||
;; (interactive)
|
||||
;; (user-error "not implemented yet"))
|
||||
(if-let* ((conn (and (modulep! +lsp)
|
||||
(require 'dap-mode nil t)
|
||||
(dap--cur-session))))
|
||||
(dap-disconnect conn)
|
||||
(if-let* ((conn (and (featurep 'dape)
|
||||
(dape--live-connection 'parent t))))
|
||||
(dape-quit conn)
|
||||
(user-error "No debugger session to quit"))))
|
||||
|
||||
Reference in New Issue
Block a user