Merge pull request #3780 from MDoerner/PimpUiDispatcher

retailcoder · web-flow · commit 552bfc078c50 · 2018-02-27T08:11:51.000-05:00
Moves UiDispatcher to Rubberduck.Parsing.dll
diff --git a/RetailCoder.VBE/API/VBA/ParserState.cs b/RetailCoder.VBE/API/VBA/ParserState.cs
@@ -10,6 +10,7 @@
 using Rubberduck.Parsing.VBA;
 using Rubberduck.UI.Command.MenuItems;
 using Rubberduck.Parsing.Symbols;
+using Rubberduck.Parsing.UIContext;
 using Rubberduck.VBEditor.ComManagement;
 using Rubberduck.VBEditor.Events;
 using Rubberduck.VBEditor.SafeComWrappers.VBA;
diff --git a/RetailCoder.VBE/App.cs b/RetailCoder.VBE/App.cs
@@ -11,6 +11,7 @@
 using System.Globalization;
 using System.Windows.Forms;
 using Rubberduck.Parsing.Inspections.Resources;
+using Rubberduck.Parsing.UIContext;
 using Rubberduck.UI.Command;
 using Rubberduck.VBEditor.SafeComWrappers.Abstract;
 using Rubberduck.VersionCheck;
diff --git a/RetailCoder.VBE/Navigation/CodeExplorer/CodeExplorerViewModel.cs b/RetailCoder.VBE/Navigation/CodeExplorer/CodeExplorerViewModel.cs
@@ -18,6 +18,7 @@
 using Rubberduck.VBEditor;
 using Rubberduck.VBEditor.SafeComWrappers;
 using System.Windows;
+using Rubberduck.Parsing.UIContext;
 
 // ReSharper disable CanBeReplacedWithTryCastAndCheckForNull
 // ReSharper disable ExplicitCallerInfoArgument
diff --git a/RetailCoder.VBE/Rubberduck.csproj b/RetailCoder.VBE/Rubberduck.csproj
@@ -639,7 +639,6 @@
     <Compile Include="UI\Command\MenuItems\RefactorIntroduceParameterCommandMenuItem.cs" />
     <Compile Include="UI\Command\MenuItems\RefactorMoveCloserToUsageCommandMenuItem.cs" />
     <Compile Include="UI\Command\MenuItems\RegexSearchReplaceCommandMenuItem.cs" />
-    <Compile Include="UI\Command\MenuItems\UiDispatcher.cs" />
     <Compile Include="UI\Command\NavigateCommand.cs" />
     <Compile Include="UI\Command\SettingsCommand.cs" />
     <Compile Include="UI\Command\MenuItems\SettingsCommandMenuItem.cs" />
diff --git a/RetailCoder.VBE/UI/Command/FindAllImplementationsCommand.cs b/RetailCoder.VBE/UI/Command/FindAllImplementationsCommand.cs
@@ -7,6 +7,7 @@
 using Rubberduck.Common;
 using Rubberduck.Parsing.Grammar;
 using Rubberduck.Parsing.Symbols;
+using Rubberduck.Parsing.UIContext;
 using Rubberduck.Parsing.VBA;
 using Rubberduck.UI.Command.MenuItems;
 using Rubberduck.UI.Controls;
diff --git a/RetailCoder.VBE/UI/Command/FindAllReferencesCommand.cs b/RetailCoder.VBE/UI/Command/FindAllReferencesCommand.cs
@@ -4,6 +4,7 @@
 using System.Windows.Forms;
 using NLog;
 using Rubberduck.Parsing.Symbols;
+using Rubberduck.Parsing.UIContext;
 using Rubberduck.Parsing.VBA;
 using Rubberduck.UI.Command.MenuItems;
 using Rubberduck.UI.Controls;
diff --git a/RetailCoder.VBE/UI/Command/MenuItems/CommandBars/AppCommandBarBase.cs b/RetailCoder.VBE/UI/Command/MenuItems/CommandBars/AppCommandBarBase.cs
@@ -3,6 +3,7 @@
 using System.Linq;
 using System.Runtime.InteropServices;
 using NLog;
+using Rubberduck.Parsing.UIContext;
 using Rubberduck.Parsing.VBA;
 using Rubberduck.UI.Command.MenuItems.ParentMenus;
 using Rubberduck.VBEditor.SafeComWrappers.Office.Core;
diff --git a/RetailCoder.VBE/UI/Command/MenuItems/CommandBars/RubberduckCommandBar.cs b/RetailCoder.VBE/UI/Command/MenuItems/CommandBars/RubberduckCommandBar.cs
@@ -4,6 +4,7 @@
 using System.Linq;
 using Rubberduck.Parsing;
 using Rubberduck.Parsing.Symbols;
+using Rubberduck.Parsing.UIContext;
 using Rubberduck.Parsing.VBA;
 using Rubberduck.VBEditor.SafeComWrappers.Office.Core;
 
diff --git a/RetailCoder.VBE/UI/Command/MenuItems/UiDispatcher.cs b/RetailCoder.VBE/UI/Command/MenuItems/UiDispatcher.cs
diff --git a/RetailCoder.VBE/UI/Command/ShowParserErrorsCommand.cs b/RetailCoder.VBE/UI/Command/ShowParserErrorsCommand.cs
@@ -5,6 +5,7 @@
 using System.Windows.Input;
 using NLog;
 using Rubberduck.Parsing.Symbols;
+using Rubberduck.Parsing.UIContext;
 using Rubberduck.Parsing.VBA;
 using Rubberduck.UI.Command.MenuItems;
 using Rubberduck.UI.Controls;
diff --git a/RetailCoder.VBE/UI/Inspections/InspectionResultsViewModel.cs b/RetailCoder.VBE/UI/Inspections/InspectionResultsViewModel.cs
@@ -11,6 +11,7 @@
 using Rubberduck.Common;
 using Rubberduck.Parsing.Inspections.Abstract;
 using Rubberduck.Parsing.Inspections.Resources;
+using Rubberduck.Parsing.UIContext;
 using Rubberduck.Parsing.VBA;
 using Rubberduck.Settings;
 using Rubberduck.UI.Command;
diff --git a/Rubberduck.Parsing/Rubberduck.Parsing.csproj b/Rubberduck.Parsing/Rubberduck.Parsing.csproj
@@ -175,6 +175,7 @@
     <Compile Include="Symbols\ParsingExceptions\ParsePassSyntaxErrorInfo.cs" />
     <Compile Include="Symbols\ParsingExceptions\MainParseSyntaxErrorException.cs" />
     <Compile Include="Symbols\ParsingExceptions\PreprosessorSyntaxErrorException.cs" />
+    <Compile Include="UIContext\UiDispatcher.cs" />
     <Compile Include="VBA\RepositoryProjectManager.cs" />
     <Compile Include="VBA\ParsePass.cs" />
     <Compile Include="Inspections\CannotAnnotateAttribute.cs" />
diff --git a/Rubberduck.Parsing/UIContext/UiDispatcher.cs b/Rubberduck.Parsing/UIContext/UiDispatcher.cs
@@ -0,0 +1,117 @@
+﻿using System;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace Rubberduck.Parsing.UIContext
+{
+    public static class UiDispatcher
+    {
+        // thanks to Pellared on http://stackoverflow.com/a/12909070/1188513
+
+        private static SynchronizationContext UiContext { get; set; }
+        private static TaskScheduler UiTaskScheduler { get; set; }
+
+        public static void Initialize()
+        {
+            if (UiContext == null)
+            {
+                UiContext = SynchronizationContext.Current;
+                UiTaskScheduler = TaskScheduler.FromCurrentSynchronizationContext();
+            }
+        }
+
+        /// <summary>
+        /// Invokes an action asynchronously on the UI thread.
+        /// </summary>
+        /// <param name="action">The action that must be executed.</param>
+        public static void InvokeAsync(Action action)
+        {
+            CheckInitialization();
+
+            UiContext.Post(x => action(), null);
+        }
+
+        /// <summary>
+        /// Executes an action on the UI thread. If this method is called
+        /// from the UI thread, the action is executed immendiately. If the
+        /// method is called from another thread, the action will be enqueued
+        /// on the UI thread's dispatcher and executed asynchronously.
+        /// <para>For additional operations on the UI thread, you can get a
+        /// reference to the UI thread's context thanks to the property
+        /// <see cref="UiContext" /></para>.
+        /// </summary>
+        /// <param name="action">The action that will be executed on the UI
+        /// thread</param>
+        public static void Invoke(Action action)
+        {
+            CheckInitialization();
+
+            if (UiContext == SynchronizationContext.Current)
+            {
+                action();
+            }
+            else
+            {
+                InvokeAsync(action);
+            }
+        }
+
+        /// <summary>
+        /// Starts a task on the ui thread.
+        /// </summary>
+        /// <param name="action">The action that will be executed on the UI
+        /// thread.</param>
+        /// <param name="token">Optional cancellation token</param>
+        /// <param name="options">Optional TaskCreationOptions</param>
+        /// <returns></returns>
+        public static Task StartTask(Action action, CancellationToken token, TaskCreationOptions options = TaskCreationOptions.None)
+        {
+            CheckInitialization();
+
+            return Task.Factory.StartNew(action, token, options, UiTaskScheduler);
+        }
+
+        //This separate overload is necessary because CancellationToken.None is not a compile-time constant and thus cannot be used as default value.
+        public static Task StartTask(Action action, TaskCreationOptions options = TaskCreationOptions.None)
+        {
+            return StartTask(action, CancellationToken.None, options);
+        }
+
+
+        /// <summary>
+        /// Starts a task returning a value on the ui thread.
+        /// </summary>
+        /// <param name="func">The function that will be executed on the UI
+        /// thread.</param>
+        /// <param name="token">Optional cancellation token</param>
+        /// <param name="options">Optional TaskCreationOptions</param>
+        /// <returns></returns>
+        public static Task<T> StartTask<T>(Func<T> func, CancellationToken token, TaskCreationOptions options = TaskCreationOptions.None)
+        {
+            CheckInitialization();
+
+            return Task.Factory.StartNew(func, token, options, UiTaskScheduler);
+        }
+
+        //This separate overload is necessary because CancellationToken.None is not a compile-time constant and thus cannot be used as default value.
+        public static Task<T> StartTask<T>(Func<T> func, TaskCreationOptions options = TaskCreationOptions.None)
+        {
+            return StartTask(func, CancellationToken.None, options);
+        }
+
+
+        private static void CheckInitialization()
+        {
+            if (UiContext == null) throw new InvalidOperationException("UiDispatcher is not initialized. Invoke Initialize() from UI thread first.");
+        }
+
+        public static void Shutdown()
+        {
+            //Invoke(() =>
+            //{
+            //    LogManager.GetCurrentClassLogger().Debug("Invoking shutdown on UI thread dispatcher.");
+            //    Dispatcher.CurrentDispatcher.InvokeShutdown();
+            //});
+        }
+    }
+}
