Merge pull request #187 from github/shana/new-menu-system

New menu handling system

Author: haacked

src/GitHub.Exports/GitHub.Exports.csproj

@@ -112,6 +112,8 @@
     <Compile Include="Services\Connection.cs" />
     <Compile Include="Services\GitService.cs" />
     <Compile Include="Services\IGitService.cs" />
+    <Compile Include="Services\IMenuHandler.cs" />
+    <Compile Include="Services\IMenuProvider.cs" />
     <Compile Include="Services\ITeamExplorerServiceHolder.cs" />
     <Compile Include="Services\Logger.cs" />
     <Compile Include="Services\Services.cs" />

src/GitHub.Exports/Services/IMenuHandler.cs

@@ -0,0 +1,25 @@
+using System;
+
+namespace GitHub.VisualStudio
+{
+    /// <summary>
+    /// Interface for MEF exports implementing menu handlers
+    /// (top level context, toolbar, etc)
+    /// </summary>
+    public interface IMenuHandler
+    {
+        Guid Guid { get; }
+        int CmdId { get; }
+        void Activate();
+    }
+
+    /// <summary>
+    /// Interface for MEF exports implementing menu handlers
+    /// (top level context, toolbar, etc)
+    /// Allows hiding the menu (requires vsct visibility flags)
+    /// </summary>
+    public interface IDynamicMenuHandler : IMenuHandler
+    {
+        bool CanShow();
+    }
+}

src/GitHub.Exports/Services/IMenuProvider.cs

@@ -0,0 +1,22 @@
+using System;
+using System.Collections.Generic;
+
+namespace GitHub.VisualStudio
+{
+    /// <summary>
+    /// Container for static and dynamic visibility menus (context, toolbar, top, etc)
+    /// Get a reference to this via MEF and register the menus
+    /// </summary>
+    public interface IMenuProvider
+    {
+        /// <summary>
+        /// Registered via AddTopLevelMenuItem
+        /// </summary>
+        IReadOnlyCollection<IMenuHandler> Menus { get; }
+
+        /// <summary>
+        /// Registered via AddDynamicMenuItem
+        /// </summary>
+        IReadOnlyCollection<IDynamicMenuHandler> DynamicMenus { get; }
+    }
+}

src/GitHub.Exports/Services/Services.cs

@@ -81,6 +81,8 @@ public static IVsOutputWindowPane OutputWindowPane
         // ReSharper disable once SuspiciousTypeConversion.Global
         public static DTE2 Dte2 => Dte as DTE2;
 
+        public static IVsUIShell UIShell => GetGlobalService<SVsUIShell, IVsUIShell>();
+
         public static IVsActivityLog GetActivityLog(this IServiceProvider provider)
         {
             return GetGlobalService<SVsActivityLog, IVsActivityLog>(provider);

src/GitHub.VisualStudio/Base/MenuBase.cs

@@ -0,0 +1,19 @@
+using System;
+
+namespace GitHub.VisualStudio
+{
+    public abstract class MenuBase
+    {
+        readonly IServiceProvider serviceProvider;
+        protected IServiceProvider ServiceProvider { get { return serviceProvider; } }
+
+        protected MenuBase()
+        {
+        }
+
+        protected MenuBase(IServiceProvider serviceProvider)
+        {
+            this.serviceProvider = serviceProvider;
+        }
+    }
+}

src/GitHub.VisualStudio/GitHub.VisualStudio.csproj

@@ -27,6 +27,7 @@
     <StartArguments>/rootsuffix Exp</StartArguments>
     <TargetFrameworkVersion>v4.5</TargetFrameworkVersion>
     <ZipPackageCompressionLevel>Normal</ZipPackageCompressionLevel>
+    <OutputPath>..\..\build\$(Configuration)\</OutputPath>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
     <DebugSymbols>true</DebugSymbols>
@@ -39,7 +40,6 @@
     <CodeAnalysisRuleSet>..\common\GitHubVS.ruleset</CodeAnalysisRuleSet>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
     <CodeAnalysisIgnoreGeneratedCode>true</CodeAnalysisIgnoreGeneratedCode>
-    <OutputPath>..\..\build\$(Configuration)\</OutputPath>
     <CreateVsixContainer>True</CreateVsixContainer>
     <DeployExtension>True</DeployExtension>
     <IncludeDebugSymbolsInVSIXContainer>true</IncludeDebugSymbolsInVSIXContainer>
@@ -54,7 +54,6 @@
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
     <CodeAnalysisIgnoreGeneratedCode>true</CodeAnalysisIgnoreGeneratedCode>
     <CodeAnalysisRuleSet>..\common\GitHubVS.ruleset</CodeAnalysisRuleSet>
-    <OutputPath>..\..\build\$(Configuration)\</OutputPath>
     <IncludeDebugSymbolsInVSIXContainer>true</IncludeDebugSymbolsInVSIXContainer>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Publish|AnyCPU' ">
@@ -67,7 +66,6 @@
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
     <CodeAnalysisIgnoreGeneratedCode>true</CodeAnalysisIgnoreGeneratedCode>
     <CodeAnalysisRuleSet>..\common\GitHubVS.ruleset</CodeAnalysisRuleSet>
-    <OutputPath>..\..\build\Release\</OutputPath>
     <DeployExtension>False</DeployExtension>
   </PropertyGroup>
   <PropertyGroup Condition="$(Buildtype) == 'Internal'">
@@ -214,6 +212,10 @@
     <Compile Include="Base\TeamExplorerServiceHolder.cs" />
     <Compile Include="Converters\CountToVisibilityConverter.cs" />
     <Compile Include="Helpers\SharedDictionaryManager.cs" />
+    <Compile Include="Menus\ShowGitHubPane.cs" />
+    <Compile Include="Menus\AddConnection.cs" />
+    <Compile Include="Base\MenuBase.cs" />
+    <Compile Include="Menus\MenuProvider.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="Base\TeamExplorerBase.cs" />
     <Compile Include="Base\TeamExplorerItemBase.cs" />

src/GitHub.VisualStudio/GitHubPackage.cs

@@ -42,29 +42,19 @@ public GitHubPackage()
         public GitHubPackage(IServiceProvider serviceProvider)
             : base(serviceProvider)
         {
-
         }
 
+
         protected override void Initialize()
         {
-
-            ServiceProvider.AddTopLevelMenuItem(GuidList.guidGitHubCmdSet, PkgCmdIDList.addConnectionCommand, (s, e) => StartFlow(UIControllerFlow.Authentication));
-            ServiceProvider.AddTopLevelMenuItem(GuidList.guidGitHubCmdSet, PkgCmdIDList.showGitHubPaneCommand, (s, e) =>
-            {
-                var window = FindToolWindow(typeof(GitHubPane), 0, true);
-                if (window?.Frame == null)
-                    throw new NotSupportedException("Cannot create tool window");
-
-                var windowFrame = (IVsWindowFrame)window.Frame;
-                ErrorHandler.ThrowOnFailure(windowFrame.Show());
-            });
             base.Initialize();
-        }
 
-        void StartFlow(UIControllerFlow controllerFlow)
-        {
-            var uiProvider = ServiceProvider.GetExportedValue<IUIProvider>();
-            uiProvider.RunUI(controllerFlow, null);
+            var menus = ServiceProvider.GetExportedValue<IMenuProvider>();
+            foreach (var menu in menus.Menus)
+                ServiceProvider.AddTopLevelMenuItem(menu.Guid, menu.CmdId, (s, e) => menu.Activate());
+
+            foreach (var menu in menus.DynamicMenus)
+                ServiceProvider.AddDynamicMenuItem(menu.Guid, menu.CmdId, menu.CanShow, menu.Activate);
         }
     }
 }

src/GitHub.VisualStudio/Menus/AddConnection.cs

@@ -0,0 +1,34 @@
+using Microsoft.VisualStudio.Shell;
+using System;
+using System.ComponentModel.Composition;
+using GitHub.Services;
+using GitHub.UI;
+using GitHub.Extensions;
+
+namespace GitHub.VisualStudio.Menus
+{
+    [Export(typeof(IMenuHandler))]
+    [PartCreationPolicy(CreationPolicy.Shared)]
+    public class AddConnection: MenuBase, IMenuHandler
+    {
+        [ImportingConstructor]
+        public AddConnection([Import(typeof(SVsServiceProvider))] IServiceProvider serviceProvider)
+            : base(serviceProvider)
+        {
+        }
+
+        public Guid Guid { get { return GuidList.guidGitHubCmdSet; } }
+        public int CmdId { get { return PkgCmdIDList.addConnectionCommand; } }
+
+        public void Activate()
+        {
+            StartFlow(UIControllerFlow.Authentication);
+        }
+
+        void StartFlow(UIControllerFlow controllerFlow)
+        {
+            var uiProvider = ServiceProvider.GetExportedValue<IUIProvider>();
+            uiProvider.RunUI(controllerFlow, null);
+        }
+    }
+}

src/GitHub.VisualStudio/Menus/MenuProvider.cs

@@ -0,0 +1,23 @@
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using System.ComponentModel.Composition;
+using System.Linq;
+
+namespace GitHub.VisualStudio.Menus
+{
+    [Export(typeof(IMenuProvider))]
+    [PartCreationPolicy(CreationPolicy.Shared)]
+    public class MenuProvider : IMenuProvider
+    {
+        public IReadOnlyCollection<IMenuHandler> Menus { get; private set; }
+
+        public IReadOnlyCollection<IDynamicMenuHandler> DynamicMenus { get; private set; }
+
+        [ImportingConstructor]
+        public MenuProvider([ImportMany] IEnumerable<IMenuHandler> menus, [ImportMany] IEnumerable<IDynamicMenuHandler> dynamicMenus)
+        {
+            Menus = new ReadOnlyCollection<IMenuHandler>(menus.ToList());
+            DynamicMenus = new ReadOnlyCollection<IDynamicMenuHandler>(dynamicMenus.ToList());
+        }
+    }
+}

src/GitHub.VisualStudio/Menus/ShowGitHubPane.cs

@@ -0,0 +1,19 @@
+using GitHub.VisualStudio.UI;
+using System;
+using System.ComponentModel.Composition;
+
+namespace GitHub.VisualStudio
+{
+    [Export(typeof(IMenuHandler))]
+    [PartCreationPolicy(CreationPolicy.Shared)]
+    public class ShowGitHubPane: MenuBase, IMenuHandler
+    {
+        public Guid Guid { get { return GuidList.guidGitHubCmdSet; } }
+        public int CmdId { get { return PkgCmdIDList.showGitHubPaneCommand; } }
+
+        public void Activate()
+        {
+            GitHubPane.Activate();
+        }
+    }
+}

src/GitHub.VisualStudio/UI/GitHubPane.cs

@@ -11,6 +11,7 @@
 using GitHub.VisualStudio.Base;
 using GitHub.ViewModels;
 using System.Diagnostics;
+using Microsoft.VisualStudio;
 
 namespace GitHub.VisualStudio.UI
 {
@@ -26,9 +27,11 @@ namespace GitHub.VisualStudio.UI
     /// implementation of the IVsUIElementPane interface.
     /// </para>
     /// </remarks>
-    [Guid("6b0fdc0a-f28e-47a0-8eed-cc296beff6d2")]
+    [Guid(GitHubPaneGuid)]
     public class GitHubPane : ToolWindowPane
     {
+        const string GitHubPaneGuid = "6b0fdc0a-f28e-47a0-8eed-cc296beff6d2";
+
         [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2214:DoNotCallOverridableMethodsInConstructors")]
         public GitHubPane() : base(null)
         {
@@ -57,5 +60,22 @@ protected override void Initialize()
             Debug.Assert(vm != null);
             vm?.Initialize(this);
         }
+
+        public static bool Activate()
+        {
+            var windowGuid = new Guid(GitHubPaneGuid);
+            IVsWindowFrame frame;
+            if (ErrorHandler.Failed(Services.UIShell.FindToolWindow((uint)__VSCREATETOOLWIN.CTW_fForceCreate, ref windowGuid, out frame)))
+            {
+                VsOutputLogger.WriteLine("Unable to find or create GitHubPane '" + GitHubPaneGuid + "'");
+                return false;
+            }
+            if (ErrorHandler.Failed(frame.Show()))
+            {
+                VsOutputLogger.WriteLine("Unable to show GitHubPane '" + GitHubPaneGuid + "'");
+                return false;
+            }
+            return true;
+        }
     }
 }