Added GtmListener.

jjonescz · jjonescz · commit 24d7faf7d370 · 2018-08-22T21:01:55.000+02:00
diff --git a/src/GtmExtension/GtmPackage.cs b/src/GtmExtension/GtmPackage.cs
@@ -7,8 +7,10 @@
 using Microsoft.VisualStudio.Text;
 using Microsoft.VisualStudio.Text.Editor;
 using Microsoft.VisualStudio.TextManager.Interop;
+using Microsoft.VisualStudio.Utilities;
 using System;
 using System.ComponentModel;
+using System.ComponentModel.Composition;
 using System.Diagnostics.CodeAnalysis;
 using System.Runtime.InteropServices;
 using System.Threading;
@@ -41,16 +43,6 @@ namespace GtmExtension
     [ProvideAutoLoad(UIContextGuids80.SolutionExists, PackageAutoLoadFlags.BackgroundLoad)] // Load the extension when a solution is open.
     public sealed class GtmPackage : AsyncPackage
     {
-        private string gtmExe, prevPath, status;
-        private IVsStatusbar statusBar;
-        private IVsEditorAdaptersFactoryService editor;
-        private WindowEvents windowEvents;
-        private DocumentEvents documentEvents;
-        private IVsTextManager textManager;
-        private IWpfTextView wpfTextView;
-        private DateTime lastUpdate;
-        private static readonly TimeSpan updateInterval = TimeSpan.FromSeconds(30.0);
-
         /// <summary>
         /// GtmPackage GUID string.
         /// </summary>
@@ -67,6 +59,53 @@ public GtmPackage()
             // initialization is the Initialize method.
         }
 
+        #region Package Members
+
+        /// <summary>
+        /// Initialization of the package; this method is called right after the package is sited, so this is the place
+        /// where you can put all the initialization code that rely on services provided by VisualStudio.
+        /// </summary>
+        /// <param name="cancellationToken">A cancellation token to monitor for initialization cancellation, which can occur when VS is shutting down.</param>
+        /// <param name="progress">A provider for progress updates.</param>
+        /// <returns>A task representing the async work of package initialization, or an already completed task if there is none. Do not return null from this method.</returns>
+        protected override async Task InitializeAsync(CancellationToken cancellationToken, IProgress<ServiceProgressData> progress)
+        {
+        }
+
+        #endregion
+    }
+
+    [Export(typeof(IVsTextViewCreationListener))]
+    [ContentType("text")]
+    [TextViewRole(PredefinedTextViewRoles.Editable)]
+    public sealed class AnotherListener : IVsTextViewCreationListener
+    {
+        public void VsTextViewCreated(IVsTextView textViewAdapter)
+        {
+        }
+    }
+
+    [Export(typeof(IVsTextViewCreationListener))]
+    [ContentType("text")]
+    [TextViewRole(PredefinedTextViewRoles.Editable)]
+    public sealed class GtmListener : IVsTextViewCreationListener
+    {
+        private bool initialized;
+        private string gtmExe, prevPath, status;
+        private DateTime lastUpdate;
+        private IVsEditorAdaptersFactoryService editor;
+        private DocumentEvents documentEvents;
+        private DTE dte;
+        private IComponentModel componentModel;
+        private IVsStatusbar statusbar;
+        private IVsUIShell uiShell;
+        private static readonly TimeSpan updateInterval = TimeSpan.FromSeconds(30.0);
+
+        #region Imports
+        [Import]
+        public SVsServiceProvider ServiceProvider { get; set; }
+        #endregion
+
         #region Helper Functions
 
         private static Process ExecuteProcess(string exeName, string arguments)
@@ -107,128 +146,97 @@ private static bool ExistsOnPath(string exeName)
             return Execute("where", exeName) == 0;
         }
 
-        private async Task ShowErrorAsync(string message)
+        private void ShowError(string message)
         {
-            // Switch to UI thread.
-            await JoinableTaskFactory.SwitchToMainThreadAsync();
-
             // Show message box.
-            var uiShell = (IVsUIShell)await GetServiceAsync(typeof(SVsUIShell));
-            if (uiShell == null) { return; }
             Guid clsid = Guid.Empty;
             ErrorHandler.ThrowOnFailure(uiShell.ShowMessageBox(0, ref clsid, "GtmExtension", message, string.Empty, 0,
                 OLEMSGBUTTON.OLEMSGBUTTON_OK, OLEMSGDEFBUTTON.OLEMSGDEFBUTTON_FIRST, OLEMSGICON.OLEMSGICON_CRITICAL, 0, out var result));
         }
 
+        private string GetFilePath(ITextView textView)
+        {
+            return textView.TextBuffer.Properties.GetProperty<ITextDocument>(typeof(ITextDocument)).FilePath;
+        }
+
+        private void GetService<T>(ref T field) { field = GetService<T>(); }
+        private T GetService<T>() => GetService<T, T>();
+        private I GetService<S, I>()
+        {
+            var service = ServiceProvider.GetService(typeof(S));
+            if (service == null) { throw new InvalidOperationException($"No {typeof(S).Name}."); }
+            return (I)service;
+        }
+
         #endregion
 
-        #region Package Members
+        #region Event handlers
 
-        /// <summary>
-        /// Initialization of the package; this method is called right after the package is sited, so this is the place
-        /// where you can put all the initialization code that rely on services provided by VisualStudio.
-        /// </summary>
-        /// <param name="cancellationToken">A cancellation token to monitor for initialization cancellation, which can occur when VS is shutting down.</param>
-        /// <param name="progress">A provider for progress updates.</param>
-        /// <returns>A task representing the async work of package initialization, or an already completed task if there is none. Do not return null from this method.</returns>
-        protected override async Task InitializeAsync(CancellationToken cancellationToken, IProgress<ServiceProgressData> progress)
+        public void VsTextViewCreated(IVsTextView textView)
         {
+            Initialize();
+
+            var wpfTextView = editor.GetWpfTextView(textView);
+            wpfTextView.LayoutChanged += WpfTextView_LayoutChanged;
+            wpfTextView.Caret.PositionChanged += Caret_PositionChanged;
+
+            Update(GetFilePath(wpfTextView));
+        }
+        private void WpfTextView_LayoutChanged(object sender, TextViewLayoutChangedEventArgs e)
+        {
+            Update(GetFilePath((ITextView)sender));
+        }
+        private void Caret_PositionChanged(object sender, CaretPositionChangedEventArgs e)
+        {
+            Update(GetFilePath(e.TextView));
+        }
+        private void DocumentEvents_DocumentSaved(Document Document)
+        {
+            Update(Document.FullName, force: true);
+        }
+
+        #endregion
+
+        private void Initialize()
+        {
+            if (initialized) { return; }
+            initialized = true;
+
+            // Get services.
+            GetService(ref uiShell);
+            GetService(ref statusbar);
+            componentModel = GetService<SComponentModel, IComponentModel>();
+            GetService(ref dte);
+            editor = componentModel.GetService<IVsEditorAdaptersFactoryService>();
+
             // Try to find executable `gtm`.
             if (ExistsOnPath("gtm"))
             {
                 gtmExe = "gtm";
             }
-
-            // When initialized asynchronously, the current thread may be a background thread at this point.
-            // Do any initialization that requires the UI thread after switching to the UI thread.
-            await JoinableTaskFactory.SwitchToMainThreadAsync(cancellationToken);
-
-            // Show error if we don't find `gtm` on PATH.
-            if (gtmExe == null)
+            else
             {
-                await ShowErrorAsync("We couldn't find gtm executable.");
+                ShowError("We couldn't find gtm executable.");
                 return;
             }
 
             // Verify version.
             if (!ExecuteForOutput(gtmExe, "verify \">= 1.1.0\"").Contains("true"))
             {
-                await ShowErrorAsync("Old version of gtm is installed. Please install at least version 1.1.0");
+                ShowError("Old version of gtm is installed. Please install at least version 1.1.0");
                 return;
             }
 
-            // Get the status bar.
-            statusBar = (IVsStatusbar)await GetServiceAsync(typeof(SVsStatusbar));
-            if (statusBar == null) { throw new InvalidOperationException("No status bar."); }
-
-            // Unfroze it if it's frozen.
-            ErrorHandler.ThrowOnFailure(statusBar.IsFrozen(out var frozen));
+            // Unfroze status bar if it's frozen.
+            ErrorHandler.ThrowOnFailure(statusbar.IsFrozen(out var frozen));
             if (frozen != 0)
             {
-                ErrorHandler.ThrowOnFailure(statusBar.FreezeOutput(0));
+                ErrorHandler.ThrowOnFailure(statusbar.FreezeOutput(0));
             }
 
-            // Get DTE.
-            var dte = (DTE)await GetServiceAsync(typeof(DTE));
-            if (dte == null) { throw new InvalidOperationException("No DTE."); }
-
-            // Get text manager.
-            textManager = (IVsTextManager)await GetServiceAsync(typeof(SVsTextManager));
-            if (textManager == null) { throw new InvalidOperationException("No TextManager."); }
-
-            // Get editor adapters.
-            var componentModel = (IComponentModel)await GetServiceAsync(typeof(SComponentModel));
-            if (componentModel == null) { throw new InvalidOperationException("No ComponentModel."); }
-            editor = componentModel.GetService<IVsEditorAdaptersFactoryService>();
-
-            // Subscribe to events. We keep the events objects so that they don't get GC'ed.
-            windowEvents = dte.Events.WindowEvents;
-            windowEvents.WindowActivated += WindowEvents_WindowActivated;
-
+            // Subscribe to events. We keep the events object so that it doesn't get GC'ed.
             documentEvents = dte.Events.DocumentEvents;
             documentEvents.DocumentSaved += DocumentEvents_DocumentSaved;
-
-            Subscribe();
-        }
-
-        private void WindowEvents_WindowActivated(Window GotFocus, Window LostFocus)
-        {
-            Subscribe();
-        }
-        private string GetFilePath(ITextView textView)
-        {
-            return textView.TextBuffer.Properties.GetProperty<ITextDocument>(typeof(ITextDocument)).FilePath;
-        }
-        private void Subscribe()
-        {
-            // Unsubscribe the previously focused window.
-            if (wpfTextView != null)
-            {
-                wpfTextView.Caret.PositionChanged -= Caret_PositionChanged;
-                wpfTextView.LayoutChanged -= WpfTextView_LayoutChanged;
-                wpfTextView = null;
-            }
-
-            // Subsribe the currently focused window.
-            ErrorHandler.ThrowOnFailure(textManager.GetActiveView(0, null, out IVsTextView textView));
-            wpfTextView = editor.GetWpfTextView(textView);
-            wpfTextView.Caret.PositionChanged += Caret_PositionChanged;
-            wpfTextView.LayoutChanged += WpfTextView_LayoutChanged;
-
-            Update(GetFilePath(wpfTextView));
-        }
-
-        private void WpfTextView_LayoutChanged(object sender, TextViewLayoutChangedEventArgs e)
-        {
-            Update(GetFilePath(wpfTextView));
-        }
-        private void Caret_PositionChanged(object sender, CaretPositionChangedEventArgs e)
-        {
-            Update(GetFilePath(e.TextView));
-        }
-        private void DocumentEvents_DocumentSaved(Document Document)
-        {
-            Update(Document.FullName, force: true);
         }
         private void Update(string path, bool force = false)
         {
@@ -240,17 +248,16 @@ private void Update(string path, bool force = false)
                 status = ExecuteForOutput(gtmExe, $"record --status \"{path}\"");
                 if (!string.IsNullOrWhiteSpace(status))
                 {
-                    statusBar.SetText($"GTM: {status}*");
+                    statusbar.SetText($"GTM: {status}*");
                 }
 
                 prevPath = path;
             }
             else if (!string.IsNullOrWhiteSpace(status))
             {
-                statusBar.SetText($"GTM: {status}");
+                statusbar.SetText($"GTM: {status}");
             }
             lastUpdate = time;
         }
-        #endregion
     }
 }
diff --git a/src/GtmExtension/source.extension.vsixmanifest b/src/GtmExtension/source.extension.vsixmanifest
@@ -1,21 +1,22 @@
 ﻿<?xml version="1.0" encoding="utf-8"?>
 <PackageManifest Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vsx-schema/2011" xmlns:d="http://schemas.microsoft.com/developer/vsx-schema-design/2011">
-  <Metadata>
-    <Identity Id="GtmExtension.78062a42-0a99-47d0-a6e2-200a84959b52" Version="1.0" Language="en-US" Publisher="Jan Joneš" />
-    <DisplayName>GtmExtension</DisplayName>
-    <Description>Empty VSIX Project.</Description>
-  </Metadata>
-  <Installation>
-    <InstallationTarget Id="Microsoft.VisualStudio.Community" Version="[15.0, 16.0)" />
-  </Installation>
-  <Dependencies>
-    <Dependency Id="Microsoft.Framework.NDP" DisplayName="Microsoft .NET Framework" d:Source="Manual" Version="[4.5,)" />
-    <Dependency Id="Microsoft.VisualStudio.MPF.15.0" DisplayName="Visual Studio MPF 15.0" d:Source="Installed" Version="[15.0]" />
-  </Dependencies>
-  <Prerequisites>
-    <Prerequisite Id="Microsoft.VisualStudio.Component.CoreEditor" Version="[15.0,16.0)" DisplayName="Visual Studio core editor" />
-  </Prerequisites>
-  <Assets>
-    <Asset Type="Microsoft.VisualStudio.VsPackage" d:Source="Project" d:ProjectName="%CurrentProject%" Path="|%CurrentProject%;PkgdefProjectOutputGroup|" />
-  </Assets>
+    <Metadata>
+        <Identity Id="GtmExtension.78062a42-0a99-47d0-a6e2-200a84959b52" Version="1.0" Language="en-US" Publisher="Jan Joneš" />
+        <DisplayName>GtmExtension</DisplayName>
+        <Description>Empty VSIX Project.</Description>
+    </Metadata>
+    <Installation>
+        <InstallationTarget Id="Microsoft.VisualStudio.Community" Version="[15.0, 16.0)" />
+    </Installation>
+    <Dependencies>
+        <Dependency Id="Microsoft.Framework.NDP" DisplayName="Microsoft .NET Framework" d:Source="Manual" Version="[4.5,)" />
+        <Dependency Id="Microsoft.VisualStudio.MPF.15.0" DisplayName="Visual Studio MPF 15.0" d:Source="Installed" Version="[15.0]" />
+    </Dependencies>
+    <Prerequisites>
+        <Prerequisite Id="Microsoft.VisualStudio.Component.CoreEditor" Version="[15.0,16.0)" DisplayName="Visual Studio core editor" />
+    </Prerequisites>
+    <Assets>
+        <Asset Type="Microsoft.VisualStudio.VsPackage" d:Source="Project" d:ProjectName="%CurrentProject%" Path="|%CurrentProject%;PkgdefProjectOutputGroup|" />
+        <Asset Type="Microsoft.VisualStudio.MefComponent" d:Source="Project" d:ProjectName="%CurrentProject%" Path="|%CurrentProject%|" />
+    </Assets>
 </PackageManifest>
