Organize, clean up, and improve performance (#674)

* Align doc constant

* Remove duplicate peek function

* Move utility module to just lsp-ui

* Place in line

* Try place on top

* Try remove delete overlay function completely

* Apply no redisplay

* Some cleanup

* Foward declare macro

Author: jcs090218

lsp-ui-doc.el

@@ -30,8 +30,6 @@
 
 ;;; Code:
 
-(require 'lsp-ui-util)
-
 (require 'lsp-protocol)
 (require 'lsp-mode)
 (require 'dash)
@@ -54,6 +52,9 @@
 (declare-function xwidget-webkit-execute-script-rv "ext:xwidget" (xwidget script &optional default))
 (declare-function xwidget-resize "ext:xwidget" (xwidget new-width new-height))
 
+(declare-function lsp-ui--with-no-redisplay 'lsp-ui)
+(declare-function lsp-ui--safe-kill-timer 'lsp-ui)
+
 (defgroup lsp-ui-doc nil
   "Display informations of the current line."
   :group 'tools
@@ -180,29 +181,29 @@ Only the `background' is used in this face."
   :group 'lsp-ui-doc)
 
 (defvar lsp-ui-doc-frame-parameters
-  '((left . -1)
-    (no-focus-on-map . t)
-    (min-width  . 0)
-    (width  . 0)
-    (min-height  . 0)
-    (height  . 0)
-    (internal-border-width . 1)
-    (vertical-scroll-bars . nil)
-    (horizontal-scroll-bars . nil)
-    (right-fringe . 0)
-    (menu-bar-lines . 0)
-    (tool-bar-lines . 0)
-    (line-spacing . 0)
-    (unsplittable . t)
-    (undecorated . t)
-    (top . -1)
-    (visibility . nil)
-    (mouse-wheel-frame . nil)
-    (no-other-frame . t)
+  '((left                     . -1)
+    (no-focus-on-map          . t)
+    (min-width                . 0)
+    (width                    . 0)
+    (min-height               . 0)
+    (height                   . 0)
+    (internal-border-width    . 1)
+    (vertical-scroll-bars     . nil)
+    (horizontal-scroll-bars   . nil)
+    (right-fringe             . 0)
+    (menu-bar-lines           . 0)
+    (tool-bar-lines           . 0)
+    (line-spacing             . 0)
+    (unsplittable             . t)
+    (undecorated              . t)
+    (top                      . -1)
+    (visibility               . nil)
+    (mouse-wheel-frame        . nil)
+    (no-other-frame           . t)
     (inhibit-double-buffering . t)
-    (drag-internal-border . t)
-    (no-special-glyphs . t)
-    (desktop-dont-save . t))
+    (drag-internal-border     . t)
+    (no-special-glyphs        . t)
+    (desktop-dont-save        . t))
   "Frame parameters used to create the frame.")
 
 (defvar lsp-ui-doc-render-function nil
@@ -246,19 +247,14 @@ Because some variables are buffer local.")
 (defmacro lsp-ui-doc--with-buffer (&rest body)
   "Execute BODY in the lsp-ui-doc buffer."
   (declare (indent 0) (debug t))
-  `(let ((parent-vars (list :buffer (current-buffer)
-                            :window (get-buffer-window)))
-         (buffer-list-update-hook nil))
-     (with-current-buffer (get-buffer-create (lsp-ui-doc--make-buffer-name))
-       (setq lsp-ui-doc--parent-vars parent-vars)
-       (prog1 (let ((buffer-read-only nil)
-                    (inhibit-modification-hooks t)
-                    (inhibit-point-motion-hooks t)
-                    (inhibit-redisplay t))
-                ,@body)
-         (setq buffer-read-only t)
-         (let ((text-scale-mode-step 1.1))
-           (text-scale-set lsp-ui-doc-text-scale-level))))))
+  `(lsp-ui--with-no-redisplay
+     (let ((parent-vars (list :buffer (current-buffer) :window (get-buffer-window))))
+       (with-current-buffer (get-buffer-create (lsp-ui-doc--make-buffer-name))
+         (setq lsp-ui-doc--parent-vars parent-vars)
+         (prog1 (let (buffer-read-only) ,@body)
+           (setq buffer-read-only t)
+           (let ((text-scale-mode-step 1.1))
+             (text-scale-set lsp-ui-doc-text-scale-level)))))))
 
 (defmacro lsp-ui-doc--get-parent (var)
   "Return VAR in `lsp-ui-doc--parent-vars'."
@@ -312,7 +308,7 @@ Because some variables are buffer local.")
                              (or (lsp:marked-string-language marked-string)
                                  (lsp:markup-content-kind marked-string)))
                         language))
-          (markdown-hr-display-char nil))
+          markdown-hr-display-char)
      (cond
       (lsp-ui-doc-use-webkit
        (if (and language
@@ -402,8 +398,7 @@ We don't extract the string that `lps-line' is already displaying."
 
 (defun lsp-ui-doc--webkit-get-xwidget ()
   "Return Xwidget instance."
-  (lsp-ui-doc--with-buffer
-    (xwidget-at 1)))
+  (lsp-ui-doc--with-buffer (xwidget-at 1)))
 
 (defun lsp-ui-doc--webkit-execute-script (script &optional fn)
   "Execute SCRIPT in embedded Xwidget and run optional callback FN."
@@ -419,11 +414,10 @@ We don't extract the string that `lps-line' is already displaying."
   "Hide the frame."
   (setq lsp-ui-doc--bounds nil
         lsp-ui-doc--from-mouse nil)
-  (lsp-ui-util-safe-delete-overlay lsp-ui-doc--inline-ov)
-  (lsp-ui-util-safe-delete-overlay lsp-ui-doc--highlight-ov)
+  (when (overlayp lsp-ui-doc--inline-ov) (delete-overlay lsp-ui-doc--inline-ov))
+  (when (overlayp lsp-ui-doc--highlight-ov) (delete-overlay lsp-ui-doc--highlight-ov))
   (when-let ((frame (lsp-ui-doc--get-frame)))
-    (when (frame-visible-p frame)
-      (make-frame-invisible frame))))
+    (when (frame-visible-p frame) (make-frame-invisible frame))))
 
 (defun lsp-ui-doc--buffer-width ()
   "Calcul the max width of the buffer."
@@ -512,59 +506,57 @@ FRAME just below the symbol at point."
 
 (defun lsp-ui-doc--move-frame (frame)
   "Place our FRAME on screen."
-  (-let* (((left top right _bottom) (window-edges nil t nil t))
-          (window (frame-root-window frame))
-          (char-h (frame-char-height frame))
-          (char-w (frame-char-width frame))
-          ((width . height) (window-text-pixel-size window nil nil 10000 10000 t))
-          (width (+ width (* char-w 1))) ;; margins
-          (height (min (- (* lsp-ui-doc-max-height char-h) (/ char-h 2)) height))
-          (width (min width (* lsp-ui-doc-max-width char-w)))
-          (frame-right (pcase lsp-ui-doc-alignment
-                         ('frame (frame-pixel-width))
-                         ('window right)))
-          ((left . top) (if (eq lsp-ui-doc-position 'at-point)
-                            (lsp-ui-doc--mv-at-point width height left top)
-                          (cons (max (- frame-right width char-w) 10)
-                                (pcase lsp-ui-doc-position
-                                  ('top (+ top char-w))
-                                  ('bottom (- (lsp-ui-doc--line-height 'mode-line)
-                                              height
-                                              10))))))
-          (frame-resize-pixelwise t)
-          (move-frame-functions nil)
-          (window-size-change-functions nil)
-          (window-state-change-hook nil)
-          (window-state-change-functions nil)
-          (window-configuration-change-hook nil)
-          (inhibit-redisplay t))
-    ;; Dirty way to fix unused variable in emacs 26
-    (and window-state-change-functions
-         window-state-change-hook)
-    ;; Make frame invisible before moving/resizing it to avoid flickering:
-    ;; We set the position and size in 1 call, modify-frame-parameters, but
-    ;; internally emacs makes 2 different calls, which can be visible
-    ;; to the user
-    (and (frame-visible-p frame)
-         (lsp-ui-doc--size-and-pos-changed frame left top width height)
-         (make-frame-invisible frame))
-    (modify-frame-parameters
-     frame
-     `((width . (text-pixels . ,width))
-       (height . (text-pixels . ,height))
-       (user-size . t)
-       (left . (+ ,left))
-       (top . (+ ,top))
-       (user-position . t)
-       (lsp-ui-doc--window-origin . ,(selected-window))
-       (lsp-ui-doc--buffer-origin . ,(current-buffer))
-       (lsp-ui-doc--no-focus . t)
-       (right-fringe . 0)
-       (left-fringe . 0)))
-    ;; Insert hr lines after width is computed
-    (lsp-ui-doc--fix-hr-props)
-    (unless (frame-visible-p frame)
-      (make-frame-visible frame))))
+  (lsp-ui--with-no-redisplay
+    (-let* (((left top right _bottom) (window-edges nil t nil t))
+            (window (frame-root-window frame))
+            (char-h (frame-char-height frame))
+            (char-w (frame-char-width frame))
+            ((width . height) (window-text-pixel-size window nil nil 10000 10000 t))
+            (width (+ width (* char-w 1))) ;; margins
+            (height (min (- (* lsp-ui-doc-max-height char-h) (/ char-h 2)) height))
+            (width (min width (* lsp-ui-doc-max-width char-w)))
+            (frame-right (pcase lsp-ui-doc-alignment
+                           ('frame (frame-pixel-width))
+                           ('window right)))
+            ((left . top) (if (eq lsp-ui-doc-position 'at-point)
+                              (lsp-ui-doc--mv-at-point width height left top)
+                            (cons (max (- frame-right width char-w) 10)
+                                  (pcase lsp-ui-doc-position
+                                    ('top (+ top char-w))
+                                    ('bottom (- (lsp-ui-doc--line-height 'mode-line)
+                                                height
+                                                10))))))
+            (frame-resize-pixelwise t)
+            move-frame-functions
+            window-size-change-functions
+            window-state-change-hook
+            window-state-change-functions)
+      ;; Dirty way to fix unused variable in emacs 26
+      (and window-state-change-functions
+           window-state-change-hook)
+      ;; Make frame invisible before moving/resizing it to avoid flickering:
+      ;; We set the position and size in 1 call, modify-frame-parameters, but
+      ;; internally emacs makes 2 different calls, which can be visible
+      ;; to the user
+      (and (frame-visible-p frame)
+           (lsp-ui-doc--size-and-pos-changed frame left top width height)
+           (make-frame-invisible frame))
+      (modify-frame-parameters
+       frame
+       `((width                     . (text-pixels . ,width))
+         (height                    . (text-pixels . ,height))
+         (user-size                 . t)
+         (left                      . (+ ,left))
+         (top                       . (+ ,top))
+         (user-position             . t)
+         (lsp-ui-doc--window-origin . ,(selected-window))
+         (lsp-ui-doc--buffer-origin . ,(current-buffer))
+         (lsp-ui-doc--no-focus      . t)
+         (right-fringe              . 0)
+         (left-fringe               . 0)))
+      ;; Insert hr lines after width is computed
+      (lsp-ui-doc--fix-hr-props)
+      (unless (frame-visible-p frame) (make-frame-visible frame)))))
 
 (defun lsp-ui-doc--visit-file (filename)
   "Visit FILENAME in the parent frame."
@@ -913,7 +905,7 @@ HEIGHT is the documentation number of lines."
                          (and (looking-at "[[:graph:]]") (cons (point) (1+ (point))))))
         (unless (equal lsp-ui-doc--bounds bounds)
           (lsp-ui-doc--hide-frame)
-          (lsp-ui-util-safe-kill-timer lsp-ui-doc--timer)
+          (lsp-ui--safe-kill-timer lsp-ui-doc--timer)
           (setq lsp-ui-doc--timer
                 (run-with-idle-timer
                  lsp-ui-doc-delay nil
@@ -1193,8 +1185,7 @@ It is supposed to be called from `lsp-ui--toggle'"
               (visible (lsp-ui-doc--frame-visible-p)))
     (set-frame-parameter frame 'lsp-ui-doc--no-focus nil)
     (set-frame-parameter frame 'cursor-type t)
-    (lsp-ui-doc--with-buffer
-      (setq cursor-type 'box))
+    (lsp-ui-doc--with-buffer (setq cursor-type 'box))
     (select-frame-set-input-focus frame)))
 
 (defun lsp-ui-doc-unfocus-frame ()
@@ -1204,10 +1195,8 @@ It is supposed to be called from `lsp-ui--toggle'"
   (when-let* ((frame (lsp-ui-doc--get-frame)))
     (set-frame-parameter frame 'lsp-ui-doc--no-focus t)
     (set-frame-parameter frame 'cursor-type nil)
-    (lsp-ui-doc--with-buffer
-      (setq cursor-type nil))
-    (when lsp-ui-doc--from-mouse
-      (make-frame-invisible frame))))
+    (lsp-ui-doc--with-buffer (setq cursor-type nil))
+    (when lsp-ui-doc--from-mouse (make-frame-invisible frame))))
 
 (provide 'lsp-ui-doc)
 ;;; lsp-ui-doc.el ends here

lsp-ui-flycheck.el

@@ -50,14 +50,12 @@ whole workspace."
 (defvar-local lsp-ui-flycheck--save-mode nil)
 
 (defun lsp-ui-flycheck-list--post-command ()
-  (when (eobp)
-    (forward-line -1)))
+  (when (eobp) (forward-line -1)))
 
 (defun lsp-ui-flycheck-list--update (window workspace)
   "Update flycheck buffer in WINDOW belonging to WORKSPACE.
 Use `lsp-diagnostics' to receive diagnostics from your LSP server."
-  (let ((buffer-read-only nil)
-        (lsp--cur-workspace workspace))
+  (let ((lsp--cur-workspace workspace) buffer-read-only)
     (erase-buffer)
     (remove-overlays)
     (maphash (lambda (file diagnostic)
@@ -161,8 +159,8 @@ Use `lsp-diagnostics' to receive diagnostics from your LSP server."
 
 (define-derived-mode lsp-ui-flycheck-list-mode special-mode "lsp-ui-flycheck-list"
   "Mode showing flycheck diagnostics for the whole workspace."
-  (setq truncate-lines t)
-  (setq mode-line-format nil)
+  (setq truncate-lines t
+        mode-line-format nil)
   (add-hook 'post-command-hook 'lsp-ui-flycheck-list--post-command nil t))
 
 (declare-function lsp-ui--workspace-path "lsp-ui" (path))

lsp-ui-imenu.el

@@ -35,7 +35,8 @@
 
 (require 'lsp-mode)
 (require 'dash)
-(require 'lsp-ui-util)
+
+(declare-function lsp-ui--safe-kill-timer 'lsp-ui)
 
 (defgroup lsp-ui-imenu nil
   "Display imenu entries."
@@ -379,7 +380,7 @@ ITEMS are used when the kind position is 'left."
 
 (defun lsp-ui-imenu--start-refresh (&rest _)
   "Starts the auto refresh timer."
-  (lsp-ui-util-safe-kill-timer lsp-ui-imenu--refresh-timer)
+  (lsp-ui--safe-kill-timer lsp-ui-imenu--refresh-timer)
   (setq lsp-ui-imenu--refresh-timer
         (run-with-idle-timer lsp-ui-imenu-auto-refresh-delay nil #'lsp-ui-imenu--refresh)))
 

lsp-ui-peek.el

@@ -39,6 +39,8 @@
 (require 'xref)
 (require 'dash)
 
+(declare-function lsp-ui--mute-apply 'lsp-ui)
+
 (defgroup lsp-ui-peek nil
   "Improve version of xref with peek feature."
   :group 'tools
@@ -181,12 +183,12 @@ will cause performances issues.")
   (eval '(progn
            (evil-define-motion lsp-ui-peek-jump-backward (count)
                                (lsp-ui-peek--with-evil-jumps
-                                (evil--jump-backward count)
-                                (run-hooks 'xref-after-return-hook)))
+                                   (evil--jump-backward count)
+                                 (run-hooks 'xref-after-return-hook)))
            (evil-define-motion lsp-ui-peek-jump-forward (count)
                                (lsp-ui-peek--with-evil-jumps
-                                (evil--jump-forward count)
-                                (run-hooks 'xref-after-return-hook))))
+                                   (evil--jump-forward count)
+                                 (run-hooks 'xref-after-return-hook))))
         t))
 
 (defmacro lsp-ui-peek--prop (prop &optional string)
@@ -346,10 +348,8 @@ XREFS is a list of references/definitions."
   (with-temp-buffer
     (insert string)
     (delay-mode-hooks
-      (let ((inhibit-message t))
-        (funcall major))
-      (ignore-errors
-        (font-lock-ensure)))
+      (lsp-ui--mute-apply (funcall major))
+      (ignore-errors (font-lock-ensure)))
     (buffer-string)))
 
 (defun lsp-ui-peek--peek ()
@@ -687,9 +687,9 @@ LOCATION can be either a LSP Location or SymbolInformation."
     (unless buffer-file-name
       (make-local-variable 'delay-mode-hooks)
       (let ((buffer-file-name filename)
-            (enable-local-variables nil)
             (inhibit-message t)
-            (delay-mode-hooks t))
+            (delay-mode-hooks t)
+            enable-local-variables)
         (set-auto-mode)))
     (font-lock-ensure)))