Merge pull request #270 from X-Sharp/master

Added code to limit the # of calls for DocumentEvents.Opened and Docu…

Author: madskristensen

demo/VSSDK.TestExtension/TestExtensionPackage.cs

@@ -37,6 +37,8 @@ protected override async Task InitializeAsync(CancellationToken cancellationToke
             await this.RegisterCommandsAsync();
 
             VS.Events.DocumentEvents.AfterDocumentWindowHide += DocumentEvents_AfterDocumentWindowHide;
+            VS.Events.DocumentEvents.Opened += DocumentEvents_Opened;
+            VS.Events.DocumentEvents.Closed += DocumentEvents_Closed;
             VS.Events.DocumentEvents.BeforeDocumentWindowShow += DocumentEvents_BeforeDocumentWindowShow;
             VS.Events.ProjectItemsEvents.AfterRenameProjectItems += ProjectItemsEvents_AfterRenameProjectItems;
             VS.Events.ProjectItemsEvents.AfterRemoveProjectItems += ProjectItemsEvents_AfterRemoveProjectItems;
@@ -46,6 +48,16 @@ protected override async Task InitializeAsync(CancellationToken cancellationToke
             VS.Events.BuildEvents.SolutionConfigurationChanged += BuildEvents_SolutionConfigurationChanged;
         }
 
+        private void DocumentEvents_Closed(string obj)
+        {
+            VS.StatusBar.ShowMessageAsync("Closed document " + obj ?? "no name").FireAndForget();
+        }
+
+        private void DocumentEvents_Opened(string obj)
+        {
+            VS.StatusBar.ShowMessageAsync("Opened document " + obj ?? "no name").FireAndForget();
+        }
+
         private void BuildEvents_SolutionConfigurationChanged()
         {
             VS.StatusBar.ShowMessageAsync("Solution configuration changed").FireAndForget();

src/toolkit/Community.VisualStudio.Toolkit.Shared/Documents/DocumentEvents.cs

@@ -36,11 +36,25 @@ internal DocumentEvents()
         /// <summary>
         /// Fires after the document was opened in the editor.
         /// </summary>
+        /// <remarks>
+        /// The event is called for documents in the document well but also
+        /// for project files and may also be called for solution files.<br/>
+        /// The document name may also be a special (generated name) in the form of
+        /// RDT_PROJ_MK::{A2FE74E1-B743-11d0-AE1A-00A0C90FFFC3} that is used by 
+        /// Visual Studio for the 'miscellaneous files' project 
+        /// </remarks>
         public event Action<string>? Opened;
 
         /// <summary>
-        /// Fires after the document was closed.s
+        /// Fires after the document was closed.
         /// </summary>
+        /// <remarks>
+        /// The event is called for documents in the document well but also
+        /// for project files and may also be called for solution files. <br/>
+        /// The document name may also be a special (generated name) in the form of
+        /// RDT_PROJ_MK::{A2FE74E1-B743-11d0-AE1A-00A0C90FFFC3} that is used by 
+        /// Visual Studio for the 'miscellaneous files' project 
+        /// </remarks>
         public event Action<string>? Closed;
 
         /// <summary>
@@ -55,24 +69,37 @@ internal DocumentEvents()
 
         int IVsRunningDocTableEvents.OnAfterFirstDocumentLock(uint docCookie, uint dwRDTLockType, uint dwReadLocksRemaining, uint dwEditLocksRemaining)
         {
-            if (Opened != null)
+            // Please note that this event is called multiple times when a document
+            // is opened for editing.
+            // This code tries to only call the Open Event once
+            // 
+            if (dwEditLocksRemaining == 1 && dwReadLocksRemaining == 0)
             {
-                string file = _rdt.GetDocumentInfo(docCookie).Moniker;
-                Opened.Invoke(file);
+                if (Opened != null)
+                {
+                    string file = _rdt.GetDocumentInfo(docCookie).Moniker;
+                    Opened.Invoke(file);
+                }
             }
 
             return VSConstants.S_OK;
         }
 
         int IVsRunningDocTableEvents.OnBeforeLastDocumentUnlock(uint docCookie, uint dwRDTLockType, uint dwReadLocksRemaining, uint dwEditLocksRemaining)
         {
-            if (Closed != null)
+            // Please note that this event is called multiple times when a document
+            // is opened for editing.
+            // This code tries to only call the Close Event once
+            if (dwReadLocksRemaining == 0 && dwEditLocksRemaining == 0)
             {
-                string file = _rdt.GetDocumentInfo(docCookie).Moniker;
-
-                if (!string.IsNullOrEmpty(file))
+                if (Closed != null)
                 {
-                    Closed.Invoke(file);
+                    string file = _rdt.GetDocumentInfo(docCookie).Moniker;
+
+                    if (!string.IsNullOrEmpty(file))
+                    {
+                        Closed.Invoke(file);
+                    }
                 }
             }
 
@@ -97,7 +124,7 @@ int IVsRunningDocTableEvents.OnAfterAttributeChange(uint docCookie, uint grfAttr
 
         int IVsRunningDocTableEvents.OnBeforeDocumentWindowShow(uint docCookie, int fFirstShow, IVsWindowFrame pFrame)
         {
-            if (BeforeDocumentWindowShow != null)
+            if (BeforeDocumentWindowShow != null && fFirstShow == 1)
             {
                 DocumentView docView = new(pFrame);
                 BeforeDocumentWindowShow.Invoke(docView);