Mode line improvements (#29)

* Fix typo

* Add function documentation for autoloaded lsp-treemacs commands

* Improve the way the mode line in lsp-treemacs is handled

In standard mode lines, the custom references title was not shown,
only default " Treeemacs ".

* lsp-treemacs.el (lsp-treemacs--set-mode-line-format): New
function. Sets a Treemacs buffer mode-name or mode-line-format.
(lsp-treemacs--show-references): Call
`lsp-treemacs--set-mode-line-format`.
(lsp-treemacs--do-search): Call `lsp-treemacs--set-mode-line-format`.
(lsp-treemacs-references): Add a space to make the title more legible
in the default mode line format.
(lsp-treemacs-implementations): Add a space to make the title more
legible in the default mode line format.

* Remove unnecessary derived modes

A couple of major modes were derived from `treemacs-mode` just to have
a custom mode line, which seems unnecessary.

* lsp-treemacs.el (lsp-treemacs-errors-mode): Remove major mode.
(lsp-treemacs-java-deps-mode): Remove major mode.
(lsp-treemacs-errors-list): Call `lsp-treemacs--set-mode-line-format`.
(lsp-treemacs-java-deps-list): Call `lsp-treemacs--set-mode-line-format`.

* Add spacing to make "LSP Symbols" look better in standard mode lines

Author: danielmartin

lsp-treemacs.el

@@ -150,7 +150,7 @@
                 (goto-char (point-min))
                 (forward-line (lsp-diagnostic-line diag))
                 (lsp-execute-code-action-by-kind "quickfix")))))
-      (user-error "Not no a diagnostic"))))
+      (user-error "Not on a diagnostic"))))
 
 (defun lsp-treemacs-cycle-severity ()
   "Cycle through the severity levels shown in the errors list"
@@ -331,9 +331,6 @@
   :keymap lsp-treemacs-error-list-mode-map
   :group 'lsp-treeemacs)
 
-(define-derived-mode lsp-treemacs-errors-mode treemacs-mode "LSP Errors View"
-  "A major mode for displaying LSP Errors.")
-
 ;;;###autoload
 (defun lsp-treemacs-errors-list ()
   "Display error list."
@@ -348,7 +345,7 @@
       (select-window window)
       (set-window-dedicated-p window t)
       (treemacs-initialize)
-      (lsp-treemacs-errors-mode)
+      (lsp-treemacs--set-mode-line-format buffer " LSP Errors View ")
       (lsp-treemacs-error-list-mode 1)
 
       (setq-local treemacs-default-visit-action 'treemacs-RET-action)
@@ -559,7 +556,7 @@
    (lsp-treemacs--symbols->tree
     lsp-treemacs--symbols
     nil)
-   "LSP Symbols"
+   " LSP Symbols "
    (and lsp-treemacs--symbols (> 30 (length lsp-treemacs--symbols)))
    "*LSP Symbols List*" ))
 
@@ -780,9 +777,6 @@
           (lsp--info "Refresh completed")))
     (error)))
 
-(define-derived-mode lsp-treemacs-java-deps-mode treemacs-mode "Java Dependencies"
-  "A major mode for displaying Java Dependencies.")
-
 ;;;###autoload
 (defun lsp-treemacs-java-deps-list ()
   "Display error list."
@@ -796,7 +790,7 @@
       (select-window window)
       (set-window-dedicated-p window t)
       (treemacs-initialize)
-      (lsp-treemacs-java-deps-mode)
+      (lsp-treemacs--set-mode-line-format buffer " Java Dependencies ")
       (lsp-treemacs-deps-list-mode t)
 
       (setq-local treemacs-space-between-root-nodes nil)
@@ -1139,52 +1133,72 @@
                                    (lsp-treemacs--open-file-in-mru path)))))))
 
 (defun lsp-treemacs--show-references (tree title expand? &optional buffer-name)
-  (with-current-buffer (get-buffer-create (or buffer-name "*LSP Lookup*"))
-    (lsp-treemacs-initialize)
-    (setq-local lsp-treemacs-tree tree)
-    (setq-local face-remapping-alist '((button . default)))
-    (lsp-treemacs-generic-refresh)
-    (when expand? (lsp-treemacs--expand 'LSP-Generic))
-    (setq-local mode-name title)
-    (current-buffer)))
+  (let ((search-buffer (get-buffer-create (or buffer-name "*LSP Lookup*"))))
+    (with-current-buffer search-buffer
+      (lsp-treemacs-initialize)
+      (lsp-treemacs--set-mode-line-format search-buffer title)
+      (setq-local lsp-treemacs-tree tree)
+      (setq-local face-remapping-alist '((button . default)))
+      (lsp-treemacs-generic-refresh)
+      (when expand? (lsp-treemacs--expand 'LSP-Generic))
+      (current-buffer))))
+
+(defun lsp-treemacs--set-mode-line-format (buffer title)
+  "Set the mode line format of BUFFER to TITLE.
+This function sets the `mode-name' or `mode-line-format'
+depending on if a custom mode line is detected."
+  (with-current-buffer buffer
+    (cond ((or (fboundp 'spaceline-install)
+               (memq 'moody-mode-line-buffer-identification
+                     (default-value 'mode-line-format))
+               (and (fboundp 'doom-modeline)
+                    (fboundp 'doom-modeline-def-modeline)))
+           (setq mode-name title))
+          (t
+           (setq mode-line-format title)))))
 
 (defun lsp-treemacs--do-search (method params title expand?)
-  (display-buffer-in-side-window (get-buffer-create "*LSP Lookup*")
-                                 '((side . bottom)))
-  (lsp-request-async
-   method
-   params
-   (lambda (refs)
-     (setq-local mode-name "Rendering results...")
-     (lsp-with-cached-filetrue-name
-      (let ((lsp-file-truename-cache (ht)))
-        (lsp-treemacs--show-references (lsp-treemacs--handle-references refs)
-                                       (format title (length refs))
-                                       expand?)))
-     (lsp--info "Refresh completed!"))
-   :mode 'detached
-   :cancel-token :treemacs-lookup)
-
-  (with-current-buffer "*LSP Lookup*"
-    (lsp-treemacs-initialize)
-    (setq-local mode-name "Loading...")
-    (setq-local lsp-treemacs-tree nil)
-    (lsp-treemacs-generic-refresh)))
+  (let ((search-buffer (get-buffer-create "*LSP Lookup*")))
+    (display-buffer-in-side-window search-buffer
+                                   '((side . bottom)))
+    (lsp-request-async
+     method
+     params
+     (lambda (refs)
+       (lsp-treemacs--set-mode-line-format search-buffer " Rendering results... ")
+       (lsp-with-cached-filetrue-name
+        (let ((lsp-file-truename-cache (ht)))
+          (lsp-treemacs--show-references (lsp-treemacs--handle-references refs)
+                                         (format title (length refs))
+                                         expand?)))
+       (lsp--info "Refresh completed!"))
+     :mode 'detached
+      :cancel-token :treemacs-lookup)
+
+    (with-current-buffer search-buffer
+      (lsp-treemacs-initialize)
+      (lsp-treemacs--set-mode-line-format search-buffer " Loading... ")
+      (setq-local lsp-treemacs-tree nil)
+      (lsp-treemacs-generic-refresh))))
 
 ;;;###autoload
 (defun lsp-treemacs-references (arg)
+  "Show the references for the symbol at point.
+With a prefix argument, expand the tree of references automatically."
   (interactive "P")
   (lsp-treemacs--do-search "textDocument/references"
                            `(:context (:includeDeclaration t) ,@(lsp--text-document-position-params))
-                           "Found %s references"
+                           " Found %s references "
                            arg))
 
 ;;;###autoload
 (defun lsp-treemacs-implementations (arg)
+  "Show the implementations for the symbol at point.
+With a prefix argument, expand the tree of implementations automatically."
   (interactive "P")
   (lsp-treemacs--do-search "textDocument/implementation"
                            (lsp--text-document-position-params)
-                           "Found %s implementations"
+                           " Found %s implementations "
                            arg))
 
 
@@ -1219,6 +1233,8 @@
 
 ;;;###autoload
 (defun lsp-treemacs-call-hierarchy (outgoing)
+  "Show the incoming call hierarchy for the symbol at point.
+With a prefix argument, show the outgoing call hierarchy."
   (interactive "P")
   (unless (lsp--find-workspaces-for "textDocument/prepareCallHierarchy")
     (user-error "Call hierarchy not supported by the current servers: %s"