Add LspWindowCommand (#1991)

Resolves #1988

Author: jwortmann

plugin/__init__.py

@@ -9,6 +9,8 @@
 from .core.protocol import Request
 from .core.protocol import Response
 from .core.protocol import WorkspaceFolder
+from .core.registry import LspTextCommand
+from .core.registry import LspWindowCommand
 from .core.sessions import AbstractPlugin
 from .core.sessions import register_plugin
 from .core.sessions import Session
@@ -34,6 +36,8 @@
     'FileWatcherEvent',
     'FileWatcherEventType',
     'FileWatcherProtocol',
+    'LspTextCommand',
+    'LspWindowCommand',
     'MarkdownLangMap',
     'matches_pattern',
     'Notification',

plugin/core/registry.py

@@ -38,18 +38,46 @@ def get_position(view: sublime.View, event: Optional[dict] = None, point: Option
         return None
 
 
+class LspWindowCommand(sublime_plugin.WindowCommand):
+    """
+    Inherit from this class to define requests which are not bound to a particular view. This allows to run requests
+    for example from links in HtmlSheets or when an unrelated file has focus.
+    """
+
+    # When this is defined in a derived class, the command is enabled only if there exists a session with the given
+    # capability attached to a view in the window.
+    capability = ''
+
+    # When this is defined in a derived class, the command is enabled only if there exists a session with the given
+    # name attached to a view in the window.
+    session_name = ''
+
+    def is_enabled(self) -> bool:
+        return self.session() is not None
+
+    def session(self) -> Optional[Session]:
+        for session in windows.lookup(self.window).get_sessions():
+            if self.capability and not session.has_capability(self.capability):
+                continue
+            if self.session_name and session.config.name != self.session_name:
+                continue
+            return session
+        else:
+            return None
+
+
 class LspTextCommand(sublime_plugin.TextCommand):
     """
     Inherit from this class to define your requests that should be triggered via the command palette and/or a
     keybinding.
     """
 
-    # When this is defined in a derived class, the command is enabled only if there exists a session attached to the
-    # view that has the given capability.
+    # When this is defined in a derived class, the command is enabled only if there exists a session with the given
+    # capability attached to the active view.
     capability = ''
 
-    # When this is defined in a derived class, the command is enabled only if there exists a session attached to the
-    # view that has the given name.
+    # When this is defined in a derived class, the command is enabled only if there exists a session with the given
+    # name attached to the active view.
     session_name = ''
 
     def is_enabled(self, event: Optional[dict] = None, point: Optional[int] = None) -> bool:

plugin/core/windows.py

@@ -85,6 +85,9 @@ def __init__(
     def get_config_manager(self) -> WindowConfigManager:
         return self._configs
 
+    def get_sessions(self) -> Generator[Session, None, None]:
+        yield from self._sessions
+
     def on_load_project_async(self) -> None:
         self.update_workspace_folders_async()
         self._configs.update()