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')

modules/tools/debugger/config.el

@@ -1,21 +1,5 @@
 ;;; tools/debugger/config.el -*- lexical-binding: t; -*-
 
-(defvar +debugger--realgud-alist
-  '((realgud:bashdb    :modes (sh-mode))
-    (realgud:gdb)
-    (realgud:gub       :modes (go-mode))
-    (realgud:kshdb     :modes (sh-mode))
-    (realgud:pdb       :modes (python-mode))
-    (realgud:perldb    :modes (perl-mode perl6-mode))
-    (realgud:rdebug    :modes (ruby-mode))
-    (realgud:remake)
-    (realgud:trepan    :modes (perl-mode perl6-mode))
-    (realgud:trepan2   :modes (python-mode))
-    (realgud:trepan3k  :modes (python-mode))
-    (realgud:trepanjs  :modes (javascript-mode js2-mode js3-mode))
-    (realgud:trepanpl  :modes (perl-mode perl6-mode raku-mode))
-    (realgud:zshdb     :modes (sh-mode))))
-
 (defvar +debugger--dap-alist
   `(((:lang cc +lsp)         :after ccls        :require (dap-lldb dap-gdb-lldb))
     ((:lang elixir +lsp)     :after elixir-mode :require dap-elixir)
@@ -29,86 +13,32 @@
     ((:lang javascript +lsp)
      :after (js2-mode typescript-mode)
      :require (dap-node dap-chrome dap-firefox ,@(if (featurep :system 'windows) '(dap-edge)))))
-  "TODO")
+  "An alist mapping Doom modules to major mode and DAP packages.")
 
 
 ;;
 ;;; Packages
 
-;;;###package gdb
-(setq gdb-show-main t
-      gdb-many-windows t)
-
-(use-package! projectile-variable
+(use-package! dape
   :defer t
-  :commands (projectile-variable-put
-             projectile-variable-get
-             projectile-variable-alist
-             projectile-variable-plist))
-
-(use-package! realgud
-  :defer t
-  :init
-  (use-package! realgud-trepan-ni
-    :defer t
-    :init (add-to-list '+debugger--realgud-alist
-                       '(realgud:trepan-ni :modes (javascript-mode js2-mode js3-mode)
-                                           :package realgud-trepan-ni)))
-
-  ;; Realgud doesn't generate its autoloads properly so we do it ourselves
-  (dolist (debugger +debugger--realgud-alist)
-    (autoload (car debugger)
-      (if-let* ((sym (plist-get (cdr debugger) :package)))
-          (symbol-name sym)
-        "realgud")
-      nil t))
-
+  :preface
+  (setq dape-adapter-dir (file-name-concat doom-user-dir "debug-adapters/"))
   :config
-  (set-popup-rule! "^\\*\\(?:trepanjs:\\(?:g\\|zsh\\|bash\\)db\\|pdb \\)"
-    :size 20 :select nil :quit nil)
+  (set-debug-variable! 'dape-debug t)
+  (setq dape-buffer-window-arrangement 'right
+        dape-inlay-hints t
+        dape-cwd-function #'projectile-project-root)
 
-  (defadvice! +debugger--cleanup-after-realgud-a (&optional buf)
-    "Kill command buffer when debugging session ends (which closes its popup)."
-    :after #'realgud:terminate
-    (when (stringp buf)
-      (setq buf (get-buffer buf)))
-    (when-let (cmdbuf (realgud-get-cmdbuf buf))
-      (let (kill-buffer-hook)
-        (kill-buffer buf))))
+  ;; Mode-line serves no purpose in REPL window.
+  (add-hook 'dape-repl-mode-hook #'hide-mode-line-mode)
 
-  ;; Monkey-patch `realgud:run-process' to run in a popup.
-  ;; TODO Find a more elegant solution
-  ;; FIXME Causes realgud:cmd-* to focus popup on every invocation
-  (defadvice! +debugger--realgud-open-in-other-window-a
-    (debugger-name script-filename cmd-args minibuffer-history-var &optional no-reset)
-    :override #'realgud:run-process
-    (let* ((cmd-buf (apply #'realgud-exec-shell debugger-name script-filename
-                           (car cmd-args) no-reset (cdr cmd-args)))
-           (process (get-buffer-process cmd-buf)))
-      (cond ((and process (eq 'run (process-status process)))
-             (pop-to-buffer cmd-buf)
-             (when (boundp 'evil-emacs-state-local-map)
-               (define-key evil-emacs-state-local-map (kbd "ESC ESC") #'+debugger/quit))
-             (realgud:track-set-debugger debugger-name)
-             (realgud-cmdbuf-info-in-debugger?= 't)
-             (realgud-cmdbuf-info-cmd-args= cmd-args)
-             (when cmd-buf
-               (switch-to-buffer cmd-buf)
-               (when realgud-cmdbuf-info
-                 (let* ((info realgud-cmdbuf-info)
-                        (cmd-args (realgud-cmdbuf-info-cmd-args info))
-                        (cmd-str  (mapconcat #'identity cmd-args " ")))
-                   (if (boundp 'starting-directory)
-                       (realgud-cmdbuf-info-starting-directory= starting-directory))
-                   (set minibuffer-history-var
-                        (cl-remove-duplicates (cons cmd-str (eval minibuffer-history-var))
-                                              :from-end t))))))
-            (t
-             (if cmd-buf (switch-to-buffer cmd-buf))
-             (message "Error running command: %s" (mapconcat #'identity cmd-args " "))))
-      cmd-buf)))
+  ;; Persist breakpoints after closing DAPE.
+  (dape-breakpoint-global-mode +1)
+  (add-hook 'dape-start-hook #'dape-breakpoint-load 0)
+  (add-hook 'dape-stopped-hook #'dape-breakpoint-save 'append))
 
 
+;; DEPRECATED
 (use-package! dap-mode
   :when (modulep! +lsp)
   :when (modulep! :tools lsp -eglot)
@@ -156,6 +86,7 @@
         "d" #'dap-hydra))
 
 
+;; DEPRECATED
 (use-package! dap-ui
   :when (modulep! +lsp)
   :when (modulep! :tools lsp -eglot)