Merge pull request #42 from emacs-lsp/use-hooks-on-features

Use hooks on features

Author: ericdallo

.github/workflows/test.yml

@@ -14,8 +14,6 @@ jobs:
     strategy:
       matrix:
         emacs-version:
-          - 25.2
-          - 25.3
           - 26.1
           - 26.2
           - 26.3

lsp-dart-closing-labels.el

@@ -40,7 +40,7 @@ be sent with information to render editor closing labels."
   :type 'float
   :group 'lsp-dart)
 
-(lsp-defun lsp-dart-closing-labels-handle (_workspace (&ClosingLabelsNotification :uri :labels))
+(lsp-defun lsp-dart--closing-labels-check ((&ClosingLabelsNotification :uri :labels))
   "Closing labels notification handler."
   (when-let (buffer (find-buffer-visiting (lsp--uri-to-path uri)))
     (with-current-buffer buffer
@@ -58,5 +58,16 @@ be sent with information to render editor closing labels."
                                                            'cursor t
                                                            'font-lock-face 'font-lock-comment-face))))))))
 
+(define-minor-mode lsp-dart-closing-labels-mode
+  "Mode for displaying flutter closing labels on the end of methods/contructors."
+  nil nil nil
+  (cond
+   (lsp-dart-closing-labels-mode
+    (add-hook 'lsp-dart-closing-labels-arrived-hook #'lsp-dart--closing-labels-check nil t))
+   (t
+    (progn
+      (remove-overlays (point-min) (point-max) 'lsp-dart-closing-labels t)
+      (remove-hook 'lsp-dart-closing-labels-arrived-hook #'lsp-dart--closing-labels-check t)))))
+
 (provide 'lsp-dart-closing-labels)
 ;;; lsp-dart-closing-labels.el ends here

lsp-dart-code-lens.el

@@ -175,21 +175,18 @@ NAMES arg is optional and are the group of tests representing a test name."
       (unless (seq-empty-p children)
         (lsp-dart-code-lens--add-test buffer children concatened-names)))))
 
-
-;; Public
-
-(lsp-defun lsp-dart-code-lens-check-main (uri (&Outline :children))
+(lsp-defun lsp-dart--main-code-lens-check ((&OutlineNotification :uri :outline (&Outline :children)))
   "Check URI and outline for main method adding lens to it."
   (-let* ((buffer (find-buffer-visiting (lsp--uri-to-path uri)))
           (main-outline (lsp-dart-code-lens--find-main-outline children)))
     (when buffer
       (with-current-buffer buffer
         (remove-overlays (point-min) (point-max) 'lsp-dart-main-code-lens t)
-        (save-excursion
-          (when main-outline
+        (when main-outline
+          (save-excursion
             (lsp-dart-code-lens--build-main-overlay buffer main-outline)))))))
 
-(lsp-defun lsp-dart-code-lens-check-test (uri (&Outline :children))
+(lsp-defun lsp-dart--test-code-lens-check ((&OutlineNotification :uri :outline (&Outline :children)))
   "Check URI and outline for test adding lens to it."
   (when (lsp-dart-test-file-p uri)
     (when-let (buffer (find-buffer-visiting (lsp--uri-to-path uri)))
@@ -198,5 +195,30 @@ NAMES arg is optional and are the group of tests representing a test name."
         (save-excursion
           (lsp-dart-code-lens--add-test buffer children))))))
 
+
+;; Public
+
+(define-minor-mode lsp-dart-main-code-lens-mode
+  "Mode for displaying code lens on main methods."
+  nil nil nil
+  (cond
+   (lsp-dart-main-code-lens-mode
+    (add-hook 'lsp-dart-outline-arrived-hook #'lsp-dart--main-code-lens-check nil t))
+   (t
+    (progn
+      (remove-overlays (point-min) (point-max) 'lsp-dart-main-code-lens t)
+      (remove-hook 'lsp-dart-outline-arrived-hook #'lsp-dart--main-code-lens-check t)))))
+
+(define-minor-mode lsp-dart-test-code-lens-mode
+  "Mode for displaying code lens on main methods."
+  nil nil nil
+  (cond
+   (lsp-dart-test-code-lens-mode
+    (add-hook 'lsp-dart-outline-arrived-hook #'lsp-dart--test-code-lens-check nil t))
+   (t
+    (progn
+      (remove-overlays (point-min) (point-max) 'lsp-dart-test-code-lens t)
+      (remove-hook 'lsp-dart-outline-arrived-hook #'lsp-dart--test-code-lens-check t)))))
+
 (provide 'lsp-dart-code-lens)
 ;;; lsp-dart-code-lens.el ends here

lsp-dart-flutter-daemon.el

@@ -37,9 +37,10 @@
 
 (defun lsp-dart-flutter-daemon--log (level msg &rest args)
   "Log for LEVEL, MSG with ARGS adding lsp-dart-flutter-daemon prefix."
-  (apply #'lsp-dart-custom-log (concat "[FLUTTER " (upcase level) "] ")
-         msg
-         args))
+  (unless (string= "STATUS" (upcase level))
+    (apply #'lsp-dart-custom-log (concat "[FLUTTER " (upcase level) "] ")
+           msg
+           args)))
 
 (defun lsp-dart-flutter-daemon--generate-command-id ()
   "Generate a random command id."

lsp-dart-flutter-fringe.el renamed to lsp-dart-flutter-fringe-colors.el

@@ -1,4 +1,4 @@
-;;; lsp-dart-flutter-fringe.el --- Dart fringe tools -*- lexical-binding: t; -*-
+;;; lsp-dart-flutter-fringe-colors.el --- Flutter fringe colors -*- lexical-binding: t; -*-
 ;;
 ;; This program is free software; you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by
@@ -15,7 +15,7 @@
 
 ;;; Commentary:
 
-;; LSP dart support for fringe
+;; Flutter support for fringe colors
 
 ;;; Code:
 
@@ -102,11 +102,5 @@
       (remove-overlays (point-min) (point-max) 'lsp-dart-flutter-fringe-colors t)
       (remove-hook 'lsp-on-change-hook #'lsp-dart-flutter-fringe--update-colors t)))))
 
-(when lsp-dart-flutter-fringe-colors
-  (add-hook 'lsp-after-open-hook
-            (lambda ()
-              (when (lsp-find-workspace 'dart_analysis_server nil)
-                (lsp-dart-flutter-fringe-colors-mode)))))
-
-(provide 'lsp-dart-flutter-fringe)
-;;; lsp-dart-flutter-fringe.el ends here
+(provide 'lsp-dart-flutter-fringe-colors)
+;;; lsp-dart-flutter-fringe-colors.el ends here

lsp-dart-flutter-widget-guide.el

@@ -50,20 +50,18 @@
 
 (defun lsp-dart-flutter-widget-guide--first-non-whitespace-pos (line)
   "Return the first non whitepaces position at LINE."
-  (save-excursion
-    (goto-char (point-min))
-    (forward-line line)
-    (back-to-indentation)
-    (lsp-make-position :line line
-                       :character (current-column))))
+  (goto-char (point-min))
+  (forward-line line)
+  (back-to-indentation)
+  (lsp-make-position :line line
+                     :character (current-column)))
 
 (defun lsp-dart-flutter-widget-guide--last-col-at (line)
   "Return the last col at LINE."
-  (save-excursion
-    (goto-char (point-min))
-    (forward-line line)
-    (end-of-line)
-    (current-column)))
+  (goto-char (point-min))
+  (forward-line line)
+  (end-of-line)
+  (current-column))
 
 (lsp-defun lsp-dart-flutter-widget-guide--outline->guide ((&FlutterOutline :kind :children :range
                                                                            (&Range :start
@@ -112,7 +110,8 @@ Return nil if the widget guilde does not apply."
 SIZE is the length of the characters list.
 LAST-LINE-CHAR is the last column position of LINE.
 ANCHOR is the anchor point of the widget guide at LINE."
-  (let ((chars (make-list size lsp-dart-flutter-widget-guide-space)))
+  (let ((chars (make-list size lsp-dart-flutter-widget-guide-space))
+        (max-lisp-eval-depth 1800))
     (seq-doseq (guide guide-lines)
       (-let* (((&Range :start (&Position :character start-char)
                        :end (&Position :line end-line :character end-char)) guide)
@@ -141,37 +140,34 @@ ANCHOR is the anchor point of the widget guide at LINE."
 
 (lsp-defun lsp-dart-flutter-widget-guide-check ((&FlutterOutlineNotification :uri :outline))
   "Check if there is any widget guide on buffer from uri of OUTLINE-PARAMS."
-  (-when-let (buffer (find-buffer-visiting (lsp--uri-to-path uri)))
+  (when-let (buffer (find-buffer-visiting (lsp--uri-to-path uri)))
     (with-current-buffer buffer
       (remove-overlays (point-min) (point-max) 'category 'lsp-dart-flutter-widget-guide)
-      (let* ((guides (lsp-dart-flutter-widget-guide--outline->guides outline))
-             (guides-by-line (lsp-dart-flutter-widget-guide--guides->guides-by-line guides)))
-        (lsp-dart-plist-each
-         (lambda (line guide-lines)
-           (let* ((first-guide-char (-min (--map (min (-> it lsp:range-start lsp:position-character)
-                                                      (-> it lsp:range-end lsp:position-character)) guide-lines)))
-                  (last-guide-char (-max (--map (max (-> it lsp:range-start lsp:position-character)
-                                                     (-> it lsp:range-end lsp:position-character)) guide-lines)))
-                  (last-line-char (lsp-dart-flutter-widget-guide--last-col-at line))
-                  (anchor (max 0 (if (< last-line-char first-guide-char) 0 first-guide-char)))
-                  (chars (lsp-dart-flutter-widget-guide--build-chars line guide-lines last-guide-char last-line-char anchor)))
-             (--each-indexed chars (lsp-dart-flutter-widget-guide--add-overlay-to buffer line (+ it-index anchor) it))))
-         guides-by-line)))))
+      (save-excursion
+        (->> outline
+             (lsp-dart-flutter-widget-guide--outline->guides)
+             (lsp-dart-flutter-widget-guide--guides->guides-by-line)
+             (lsp-dart-plist-each
+              (lambda (line guide-lines)
+                (let* ((first-guide-char (-min (--map (min (-> it lsp:range-start lsp:position-character)
+                                                           (-> it lsp:range-end lsp:position-character)) guide-lines)))
+                       (last-guide-char (-max (--map (max (-> it lsp:range-start lsp:position-character)
+                                                          (-> it lsp:range-end lsp:position-character)) guide-lines)))
+                       (last-line-char (lsp-dart-flutter-widget-guide--last-col-at line))
+                       (anchor (max 0 (if (< last-line-char first-guide-char) 0 first-guide-char)))
+                       (chars (lsp-dart-flutter-widget-guide--build-chars line guide-lines last-guide-char last-line-char anchor)))
+                  (--each-indexed chars (lsp-dart-flutter-widget-guide--add-overlay-to buffer line (+ it-index anchor) it))))))))))
 
 (define-minor-mode lsp-dart-flutter-widget-guides-mode
   "Mode for displaying flutter widget guide lines."
   nil nil nil
   (cond
    (lsp-dart-flutter-widget-guides-mode
-    (add-hook 'lsp-dart-outline-arrived-hook #'lsp-dart-flutter-widget-guide-check nil t))
+    (add-hook 'lsp-dart-flutter-outline-arrived-hook #'lsp-dart-flutter-widget-guide-check nil t))
    (t
     (progn
       (remove-overlays (point-min) (point-max) 'category 'lsp-dart-flutter-widget-guide)
-      (remove-hook 'lsp-dart-outline-arrived-hook #'lsp-dart-flutter-widget-guide-check t)))))
-
-(add-hook 'lsp-before-open-hook (lambda ()
-                                  (when lsp-dart-flutter-widget-guides
-                                    (lsp-dart-flutter-widget-guides-mode 1))))
+      (remove-hook 'lsp-dart-flutter-outline-arrived-hook #'lsp-dart-flutter-widget-guide-check t)))))
 
 (provide 'lsp-dart-flutter-widget-guide)
 ;;; lsp-dart-flutter-widget-guide.el ends here

lsp-dart-outline.el

@@ -23,7 +23,6 @@
 
 (require 'lsp-dart-protocol)
 (require 'lsp-dart-utils)
-(require 'lsp-dart-code-lens)
 
 (defcustom lsp-dart-outline t
   "Enable the analysis server outline custom method.
@@ -60,6 +59,12 @@ Defaults to side following treemacs default."
 
 ;;; Internal
 
+(defvar-local lsp-dart-current-outline nil)
+(defvar-local lsp-dart-current-flutter-outline nil)
+
+(defconst lsp-dart--outline-buffer-name "*Dart Outline*")
+(defconst lsp-dart--flutter-outline-buffer-name "*Flutter Outline*")
+
 (defun lsp-dart-outline--set-metadata (workspace params key-prefix)
   "Save in WORKSPACE the PARAMS metadata with KEY-PREFIX.
 The key is composed of the KEY-PREFIX with PARAMS uri path."
@@ -176,7 +181,7 @@ OUTLINES are the outline items."
      (lsp-dart-outline--outlines->tree uri outlines)
      "Outline"
      t
-     "*Dart Outline*")))
+     lsp-dart--outline-buffer-name)))
 
 (defun lsp-dart-outline--render-flutter-outline-tree (uri outlines)
   "Render an Flutter outline view with the source URI and OUTLINES data."
@@ -185,65 +190,84 @@ OUTLINES are the outline items."
      (lsp-dart-outline--flutter-outline->tree uri outlines)
      "Flutter Outline"
      t
-     "*Flutter Outline*")))
+     lsp-dart--flutter-outline-buffer-name)))
 
-(defun lsp-dart-outline--show-outline (buffer ignore-focus?)
+(defun lsp-dart-outline--show-outline (ignore-focus?)
   "Show an outline tree for BUFFER.
 Focus on it if IGNORE-FOCUS? is nil."
-  (-when-let ((&OutlineNotification? :uri :outline (&Outline :children)) (lsp-dart-outline--get-metadata buffer "current-outline"))
+  (-if-let ((&OutlineNotification? :uri :outline (&Outline :children)) lsp-dart-current-outline)
     (-let* ((tree-buffer (lsp-dart-outline--render-outline-tree uri children))
             (window (display-buffer-in-side-window tree-buffer lsp-dart-outline-position-params)))
       (unless ignore-focus?
         (select-window window)
-        (set-window-dedicated-p window t)))))
+        (set-window-dedicated-p window t)))
+    (lsp-dart-log "No Dart outline data found")))
 
-(defun lsp-dart-outline--show-flutter-outline (buffer ignore-focus?)
+(defun lsp-dart-outline--show-flutter-outline (ignore-focus?)
   "Show a Flutter outline tree for BUFFER.
 Focus on it if IGNORE-FOCUS? is nil."
-  (-when-let ((&FlutterOutlineNotification? :uri :outline (&FlutterOutline :children)) (lsp-dart-outline--get-metadata buffer "current-flutter-outline"))
+  (-if-let ((&FlutterOutlineNotification? :uri :outline (&FlutterOutline :children)) lsp-dart-current-flutter-outline)
     (-let* ((tree-buffer (lsp-dart-outline--render-flutter-outline-tree uri children))
             (window (display-buffer-in-side-window tree-buffer lsp-dart-flutter-outline-position-params)))
       (unless ignore-focus?
         (select-window window)
-        (set-window-dedicated-p window t)))))
+        (set-window-dedicated-p window t)))
+    (lsp-dart-log "No Flutter outline data found")))
 
-(lsp-defun lsp-dart-outline-handle-outline (workspace (notification &as &OutlineNotification :uri :outline))
+(lsp-defun lsp-dart--outline-check ((notification &as &OutlineNotification :uri))
   "Outline notification handling from WORKSPACE.
 NOTIFICATION is outline notification data received from server.
 It updates the outline view if it already exists."
-  (lsp-dart-outline--set-metadata workspace notification "current-outline")
-  (when lsp-dart-main-code-lens
-    (lsp-dart-code-lens-check-main uri outline))
-  (when lsp-dart-test-code-lens
-    (lsp-dart-code-lens-check-test uri outline))
-  (when (get-buffer-window "*Dart Outline*")
-    (lsp-dart-outline--show-outline (find-buffer-visiting (lsp--uri-to-path uri)) t)))
-
-(lsp-defun lsp-dart-outline-handle-flutter-outline (workspace (notification &as &FlutterOutlineNotification :uri))
+   (when-let (buffer (find-buffer-visiting (lsp--uri-to-path uri)))
+     (with-current-buffer buffer
+      (setq lsp-dart-current-outline notification)
+       (when (get-buffer-window lsp-dart--outline-buffer-name)
+         (lsp-dart-outline--show-outline t)))))
+
+(lsp-defun lsp-dart--flutter-outline-check ((notification &as &FlutterOutlineNotification :uri))
   "Flutter outline notification handling from WORKSPACE.
 NOTIFICATION is Flutter outline notification data received from server.
 It updates the Flutter outline view if it already exists."
-  (lsp-dart-outline--set-metadata workspace notification "current-flutter-outline")
-  (run-hook-with-args 'lsp-dart-outline-arrived-hook notification)
-  (when (get-buffer-window "*Flutter Outline*")
-    (lsp-dart-outline--show-flutter-outline (find-buffer-visiting (lsp--uri-to-path uri)) t)))
+  (when-let (buffer (find-buffer-visiting (lsp--uri-to-path uri)))
+    (with-current-buffer buffer
+      (setq lsp-dart-current-flutter-outline notification)
+      (when (get-buffer-window lsp-dart--flutter-outline-buffer-name)
+        (lsp-dart-outline--show-flutter-outline t)))))
 
 
 ;;; Public interface
 
+(define-minor-mode lsp-dart-outline-mode
+  "Mode for updating outline."
+  nil nil nil
+  (cond
+   (lsp-dart-outline-mode
+    (add-hook 'lsp-dart-outline-arrived-hook #'lsp-dart--outline-check nil t))
+   (t
+    (remove-hook 'lsp-dart-outline-arrived-hook #'lsp-dart--outline-check t))))
+
+(define-minor-mode lsp-dart-flutter-outline-mode
+  "Mode for updating flutter outline."
+  nil nil nil
+  (cond
+   (lsp-dart-flutter-outline-mode
+    (add-hook 'lsp-dart-flutter-outline-arrived-hook #'lsp-dart--flutter-outline-check nil t))
+   (t
+    (remove-hook 'lsp-dart-flutter-outline-arrived-hook #'lsp-dart--flutter-outline-check t))))
+
 ;;;###autoload
 (defun lsp-dart-show-outline (ignore-focus?)
   "Show an outline tree and focus on it if IGNORE-FOCUS? is nil."
   (interactive "P")
   (lsp-dart-assert-sdk-min-version "2.8.0")
-  (lsp-dart-outline--show-outline (current-buffer) ignore-focus?))
+  (lsp-dart-outline--show-outline ignore-focus?))
 
 ;;;###autoload
 (defun lsp-dart-show-flutter-outline (ignore-focus?)
   "Show a Flutter outline tree and focus on it if IGNORE-FOCUS? is nil."
   (interactive "P")
   (lsp-dart-assert-sdk-min-version "2.8.0")
-  (lsp-dart-outline--show-flutter-outline (current-buffer) ignore-focus?))
+  (lsp-dart-outline--show-flutter-outline ignore-focus?))
 
 (provide 'lsp-dart-outline)
 ;;; lsp-dart-outline.el ends here