Reimplementation of in memory profile support

#151 and #147

Author: mitchcapper

SmartCmdArgs/SmartCmdArgs.Shared/CmdArgsOptionPage.cs

@@ -1,4 +1,4 @@
-using Microsoft.VisualStudio.Shell;
+using Microsoft.VisualStudio.Shell;
 using SmartCmdArgs.Helper;
 using System.ComponentModel;
 using System.Linq;
@@ -78,6 +78,7 @@ public CmdArgsOptionPage() : base()
         private bool _manageWorkingDirectories;
         private bool _manageLaunchApplication;
         private bool _vcsSupportEnabled;
+        private bool _useCpsVirtualProfile;
         private bool _useSolutionDir;
         private bool _macroEvaluationEnabled;
 
@@ -111,6 +112,7 @@ public bool UseMonospaceFont
             set => SetAndNotify(value, ref _useMonospaceFont);
         }
 
+
         [Category("Appearance")]
         [DisplayName("Display Tags for CLAs")]
         [Description("If enabled the item tag 'CLA' is displayed for Command Line Arguments. Normally the tag 'ENV' is only displayed for environment varibales.")]
@@ -201,6 +203,16 @@ public bool VcsSupportEnabled
             set => SetAndNotify(value, ref _vcsSupportEnabled);
         }
 
+         [Category("Settings Defaults")]
+        [DisplayName("Use CPS Virtual Profile")]
+        [Description("If enabled a virtual profile is created for CPS projects and only this profile is changed by the extension.")]
+        [DefaultValue(false)]
+        public bool UseCpsVirtualProfile
+        {
+            get => _useCpsVirtualProfile;
+            set => SetAndNotify(value, ref _useCpsVirtualProfile);
+        }
+
         [Category("Settings Defaults")]
         [DisplayName("Use Solution Directory")]
         [Description("If enabled all arguments of every project will be stored in a single file next to the *.sln file. (Only if version control support is enabled)")]

SmartCmdArgs/SmartCmdArgs.Shared/CmdArgsPackage.cs

@@ -1,4 +1,4 @@
-//------------------------------------------------------------------------------
+//------------------------------------------------------------------------------
 // <copyright file="CmdArgsPackage.cs" company="Company">
 //     Copyright (c) Company.  All rights reserved.
 // </copyright>
@@ -69,7 +69,8 @@ public sealed class CmdArgsPackage : AsyncPackage
         private ISuoDataService suoDataService;
         private ILifeCycleService lifeCycleService;
         private IVsEventHandlingService vsEventHandling;
-        private IFileStorageEventHandlingService fileStorageEventHandling;
+        private IFileStorageEventHandlingService fileStorageEventHandling;
+        private ICpsProjectConfigService cpsProjectConfigService;
 
         private ToolWindowViewModel toolWindowViewModel;
         private TreeViewModel treeViewModel;
@@ -105,7 +106,8 @@ public CmdArgsPackage()
             suoDataService = ServiceProvider.GetRequiredService<ISuoDataService>();
             lifeCycleService = ServiceProvider.GetRequiredService<ILifeCycleService>();
             vsEventHandling = ServiceProvider.GetRequiredService<IVsEventHandlingService>();
-            fileStorageEventHandling = ServiceProvider.GetRequiredService<IFileStorageEventHandlingService>();
+            fileStorageEventHandling = ServiceProvider.GetRequiredService<IFileStorageEventHandlingService>();
+            cpsProjectConfigService = ServiceProvider.GetRequiredService<ICpsProjectConfigService>();
         }
 
         protected override void Dispose(bool disposing)
@@ -170,7 +172,8 @@ private ServiceProvider ConfigureServices()
             services.AddLazySingleton(x => GetDialogPage<CmdArgsOptionPage>());
             services.AddLazySingleton<SettingsViewModel>();
             services.AddLazySingleton<ToolWindowViewModel>();
-            services.AddLazySingleton<TreeViewModel>();
+            services.AddLazySingleton<TreeViewModel>();
+            services.AddLazySingleton<ICpsProjectConfigService, CpsProjectConfigService>();
             services.AddLazySingleton<IProjectConfigService, ProjectConfigService>();
             services.AddSingleton<IVisualStudioHelperService, VisualStudioHelperService>();
             services.AddSingleton<IFileStorageService, FileStorageService>();
@@ -264,7 +267,7 @@ public List<string> GetLaunchProfiles(Guid projGuid)
             List<string> launchProfiles = null;
             if (project?.IsCpsProject() == true)
             {
-                launchProfiles = CpsProjectSupport.GetLaunchProfileNames(project.GetProject())?.ToList();
+                launchProfiles = cpsProjectConfigService.GetLaunchProfileNames(project.GetProject())?.ToList();
             }
 
             return launchProfiles ?? new List<string>();

…dArgs.Shared/Helper/CpsProjectSupport.cs …Shared/Helper/CpsProjectConfigService.csSmartCmdArgs/SmartCmdArgs.Shared/Helper/CpsProjectSupport.cs renamed to SmartCmdArgs/SmartCmdArgs.Shared/Helper/CpsProjectConfigService.cs SmartCmdArgs/SmartCmdArgs.Shared/Helper/CpsProjectSupport.cs renamed to SmartCmdArgs/SmartCmdArgs.Shared/Helper/CpsProjectConfigService.cs

@@ -1,4 +1,5 @@
-using Microsoft.VisualStudio.ProjectSystem;
+using EnvDTE;
+using Microsoft.VisualStudio.ProjectSystem;
 using Microsoft.VisualStudio.ProjectSystem.Debug;
 using Microsoft.VisualStudio.ProjectSystem.Properties;
 using SmartCmdArgs.DataSerialization;
@@ -19,11 +20,32 @@
 // As such, ensuring compatibility requires knowledge of the version Visual Studio redirects to, which varies
 // by Visual Studio installation version.
 
-namespace SmartCmdArgs.Helper
+namespace SmartCmdArgs.Services
 {
-    public static class CpsProjectSupport
+    public interface ICpsProjectConfigService
     {
-        private static bool TryGetProjectServices(EnvDTE.Project project, out IUnconfiguredProjectServices unconfiguredProjectServices, out IProjectServices projectServices)
+       string GetActiveLaunchProfileName(Project project);
+        void GetItemsFromConfig(Project project, List<CmdItemJson> allArgs, bool includeArgs, bool includeEnvVars, bool includeWorkDir, bool includeLaunchApp);
+        IEnumerable<string> GetLaunchProfileNames(Project project);
+        IDisposable ListenToLaunchProfileChanges(Project project, Action listener);
+        void SetActiveLaunchProfileByName(Project project, string profileName);
+        void SetActiveLaunchProfileToVirtualProfile(Project project);
+        void SetConfig(Project project, string arguments, IDictionary<string, string> envVars, string workDir, string launchApp);
+    }
+
+    public class CpsProjectConfigService : ICpsProjectConfigService
+    {
+        public static string VirtualProfileName = "Smart CLI Args";
+
+        private readonly IOptionsSettingsService optionsSettingsService;
+
+        public CpsProjectConfigService(
+            IOptionsSettingsService optionsSettingsService)
+        {
+            this.optionsSettingsService = optionsSettingsService;
+        }
+
+        private bool TryGetProjectServices(EnvDTE.Project project, out IUnconfiguredProjectServices unconfiguredProjectServices, out IProjectServices projectServices)
         {
             IVsBrowseObjectContext context = project as IVsBrowseObjectContext;
             if (context == null && project != null)
@@ -55,7 +77,7 @@ private static bool TryGetProjectServices(EnvDTE.Project project, out IUnconfigu
             }
         }
 
-        public static string GetActiveLaunchProfileName(EnvDTE.Project project)
+        public string GetActiveLaunchProfileName(EnvDTE.Project project)
         {
             if (TryGetProjectServices(project, out IUnconfiguredProjectServices unconfiguredProjectServices, out IProjectServices projectServices))
             {
@@ -65,7 +87,21 @@ public static string GetActiveLaunchProfileName(EnvDTE.Project project)
             return null;
         }
 
-        public static IEnumerable<string> GetLaunchProfileNames(EnvDTE.Project project)
+        public void SetActiveLaunchProfileByName(EnvDTE.Project project, string profileName)
+        {
+            if (TryGetProjectServices(project, out IUnconfiguredProjectServices unconfiguredProjectServices, out IProjectServices projectServices))
+            {
+                var launchSettingsProvider = unconfiguredProjectServices.ExportProvider.GetExportedValue<ILaunchSettingsProvider>();
+                projectServices.ThreadingPolicy.ExecuteSynchronously(async () =>
+                {
+                    await launchSettingsProvider.SetActiveProfileAsync(profileName);
+                });
+            }
+        }
+
+        public void SetActiveLaunchProfileToVirtualProfile(EnvDTE.Project project) => SetActiveLaunchProfileByName(project, VirtualProfileName);
+
+        public IEnumerable<string> GetLaunchProfileNames(EnvDTE.Project project)
         {
             if (TryGetProjectServices(project, out IUnconfiguredProjectServices unconfiguredProjectServices, out IProjectServices projectServices))
             {
@@ -75,10 +111,11 @@ public static IEnumerable<string> GetLaunchProfileNames(EnvDTE.Project project)
             return null;
         }
 
-        public static IDisposable ListenToLaunchProfileChanges(EnvDTE.Project project, Action listener)
+        public IDisposable ListenToLaunchProfileChanges(EnvDTE.Project project, Action listener)
         {
             if (TryGetProjectServices(project, out IUnconfiguredProjectServices unconfiguredProjectServices, out IProjectServices projectServices))
             {
+                
                 var launchSettingsProvider = unconfiguredProjectServices.ExportProvider.GetExportedValue<ILaunchSettingsProvider>();
 
                 if (launchSettingsProvider == null)
@@ -92,20 +129,29 @@ public static IDisposable ListenToLaunchProfileChanges(EnvDTE.Project project, A
             return null;
         }
 
-        public static void SetCpsProjectConfig(EnvDTE.Project project, string arguments, IDictionary<string, string> envVars, string workDir, string launchApp)
+        public void SetConfig(EnvDTE.Project project, string arguments, IDictionary<string, string> envVars, string workDir, string launchApp)
         {
             IUnconfiguredProjectServices unconfiguredProjectServices;
             IProjectServices projectServices;
 
             if (TryGetProjectServices(project, out unconfiguredProjectServices, out projectServices))
             {
                 var launchSettingsProvider = unconfiguredProjectServices.ExportProvider.GetExportedValue<ILaunchSettingsProvider>();
-                var activeLaunchProfile = launchSettingsProvider?.ActiveProfile;
+                ILaunchProfile baseLaunchProfile = null;
+                if (optionsSettingsService.UseCpsVirtualProfile)
+                {
+                    baseLaunchProfile = launchSettingsProvider.CurrentSnapshot.Profiles.FirstOrDefault(x => x.Name == VirtualProfileName);
+                }
 
-                if (activeLaunchProfile == null)
+                if (baseLaunchProfile == null)
+                {
+                    baseLaunchProfile = launchSettingsProvider?.ActiveProfile;
+                }
+
+                if (baseLaunchProfile == null)
                     return;
 
-                WritableLaunchProfile writableLaunchProfile = new WritableLaunchProfile(activeLaunchProfile);
+                WritableLaunchProfile writableLaunchProfile = new WritableLaunchProfile(baseLaunchProfile);
 
                 if (arguments != null)
                     writableLaunchProfile.CommandLineArgs = arguments;
@@ -119,30 +165,31 @@ public static void SetCpsProjectConfig(EnvDTE.Project project, string arguments,
                 if (launchApp != null)
                     writableLaunchProfile.CommandName = launchApp;
 
-                // Does not work on VS2015, which should be okay ...
-                // We don't hold references for VS2015, where the interface is called IThreadHandling
-                IProjectThreadingService projectThreadingService = projectServices.ThreadingPolicy;
-                projectThreadingService.ExecuteSynchronously(() =>
+                if (optionsSettingsService.UseCpsVirtualProfile)
+                {
+                    writableLaunchProfile.Name = VirtualProfileName;
+                    writableLaunchProfile.DoNotPersist = true;
+                }
+
+                projectServices.ThreadingPolicy.ExecuteSynchronously(() =>
                 {
                     return launchSettingsProvider.AddOrUpdateProfileAsync(writableLaunchProfile, addToFront: false);
                 });
             }
         }
 
-        public static List<CmdItemJson> GetCpsProjectAllArguments(EnvDTE.Project project, bool includeArgs, bool includeEnvVars, bool includeWorkDir, bool includeLaunchApp)
+        public void GetItemsFromConfig(EnvDTE.Project project, List<CmdItemJson> allArgs, bool includeArgs, bool includeEnvVars, bool includeWorkDir, bool includeLaunchApp)
         {
             IUnconfiguredProjectServices unconfiguredProjectServices;
             IProjectServices projectServices;
 
-            var result = new List<CmdItemJson>();
-
             if (TryGetProjectServices(project, out unconfiguredProjectServices, out projectServices))
             {
                 var launchSettingsProvider = unconfiguredProjectServices.ExportProvider.GetExportedValue<ILaunchSettingsProvider>();
                 var launchProfiles = launchSettingsProvider?.CurrentSnapshot?.Profiles;
 
                 if (launchProfiles == null)
-                    return result;
+                    return;
 
                 foreach (var profile in launchProfiles)
                 {
@@ -173,17 +220,19 @@ public static List<CmdItemJson> GetCpsProjectAllArguments(EnvDTE.Project project
 
                     if (profileGrp.Items.Count > 0)
                     {
-                        result.Add(profileGrp);
+                        allArgs.Add(profileGrp);
                     }
                 }
             }
-
-            return result;
         }
     }
 
     class WritableLaunchProfile : ILaunchProfile
+#if VS17
+        , IPersistOption
+#endif
     {
+        // ILaunchProfile
         public string Name { set; get; }
         public string CommandName { set; get; }
         public string ExecutablePath { set; get; }
@@ -194,8 +243,12 @@ class WritableLaunchProfile : ILaunchProfile
         public ImmutableDictionary<string, string> EnvironmentVariables { set; get; }
         public ImmutableDictionary<string, object> OtherSettings { set; get; }
 
+        // IPersistOption
+        public bool DoNotPersist { get; set; }
+
         public WritableLaunchProfile(ILaunchProfile launchProfile)
         {
+             // ILaunchProfile
             Name = launchProfile.Name;
             ExecutablePath = launchProfile.ExecutablePath;
             CommandName = launchProfile.CommandName;
@@ -205,6 +258,13 @@ public WritableLaunchProfile(ILaunchProfile launchProfile)
             LaunchUrl = launchProfile.LaunchUrl;
             EnvironmentVariables = launchProfile.EnvironmentVariables;
             OtherSettings = launchProfile.OtherSettings;
+#if VS17
+            if (launchProfile is IPersistOption persistOptionLaunchProfile)
+            {
+                // IPersistOption
+                DoNotPersist = persistOptionLaunchProfile.DoNotPersist;
+            }
+#endif
         }
     }
 }

SmartCmdArgs/SmartCmdArgs.Shared/Services/ItemAggregationService.cs

@@ -1,4 +1,4 @@
-using SmartCmdArgs.Helper;
+using SmartCmdArgs.Helper;
 using SmartCmdArgs.ViewModel;
 using SmartCmdArgs.Wrapper;
 using System;
@@ -23,15 +23,19 @@ internal class ItemAggregationService : IItemAggregationService
         private readonly IItemEvaluationService itemEvaluation;
         private readonly IVisualStudioHelperService vsHelper;
         private readonly TreeViewModel treeViewModel;
+        private readonly ICpsProjectConfigService cpsProjectConfigService;
+
 
         public ItemAggregationService(
             IItemEvaluationService itemEvaluation,
             IVisualStudioHelperService vsHelper,
-            TreeViewModel treeViewModel)
+            TreeViewModel treeViewModel,
+            ICpsProjectConfigService cpsProjectConfigService)
         {
             this.itemEvaluation = itemEvaluation;
             this.vsHelper = vsHelper;
             this.treeViewModel = treeViewModel;
+            this.cpsProjectConfigService = cpsProjectConfigService;
         }
 
         private TResult AggregateComamndLineItemsForProject<TResult>(IVsHierarchyWrapper project, Func<IEnumerable<CmdBase>, Func<CmdContainer, TResult>, CmdContainer, TResult> joinItems)
@@ -50,7 +54,7 @@ private TResult AggregateComamndLineItemsForProject<TResult>(IVsHierarchyWrapper
 
             string activeLaunchProfile = null;
             if (project.IsCpsProject())
-                activeLaunchProfile = CpsProjectSupport.GetActiveLaunchProfileName(projectObj);
+                activeLaunchProfile = cpsProjectConfigService.GetActiveLaunchProfileName(projectObj);
 
             TResult JoinContainer(CmdContainer con)
             {

SmartCmdArgs/SmartCmdArgs.Shared/Services/OptionsSettingsEventHandlingService.cs

@@ -1,5 +1,6 @@
-using SmartCmdArgs.ViewModel;
+using SmartCmdArgs.ViewModel;
 using System;
+using System.Linq;
 
 namespace SmartCmdArgs.Services
 {
@@ -18,6 +19,8 @@ internal class OptionsSettingsEventHandlingService : IOptionsSettingsEventHandli
         private readonly IViewModelUpdateService viewModelUpdateService;
         private readonly ToolWindowViewModel toolWindowViewModel;
         private readonly IToolWindowHistory toolWindowHistory;
+        private readonly IProjectConfigService projectConfigService;
+        private readonly ICpsProjectConfigService cpsProjectConfigService;
 
         public OptionsSettingsEventHandlingService(
             IOptionsSettingsService optionsSettings,
@@ -26,7 +29,9 @@ public OptionsSettingsEventHandlingService(
             IVisualStudioHelperService vsHelper,
             IViewModelUpdateService viewModelUpdateService,
             ToolWindowViewModel toolWindowViewModel,
-            IToolWindowHistory toolWindowHistory)
+            IToolWindowHistory toolWindowHistory,
+            IProjectConfigService projectConfigService,
+            ICpsProjectConfigService cpsProjectConfigService)
         {
             this.optionsSettings = optionsSettings;
             this.settingsService = settingsService;
@@ -35,6 +40,8 @@ public OptionsSettingsEventHandlingService(
             this.viewModelUpdateService = viewModelUpdateService;
             this.toolWindowViewModel = toolWindowViewModel;
             this.toolWindowHistory = toolWindowHistory;
+            this.projectConfigService = projectConfigService;
+            this.cpsProjectConfigService = cpsProjectConfigService;
         }
 
         public void Dispose()
@@ -64,6 +71,7 @@ private void OptionsSettings_PropertyChanged(object sender, System.ComponentMode
                 case nameof(IOptionsSettingsService.JsonRootPath): JsonRootPathChanged(); break;
                 case nameof(IOptionsSettingsService.VcsSupportEnabled): VcsSupportChanged(); break;
                 case nameof(IOptionsSettingsService.UseSolutionDir): UseSolutionDirChanged(); break;
+                case nameof(IOptionsSettingsService.UseCpsVirtualProfile): UseCpsVirtualProfileChanged(); break;
                 case nameof(IOptionsSettingsService.ManageCommandLineArgs): viewModelUpdateService.UpdateIsActiveForParamsDebounced(); break;
                 case nameof(IOptionsSettingsService.ManageEnvironmentVars): viewModelUpdateService.UpdateIsActiveForParamsDebounced(); break;
                 case nameof(IOptionsSettingsService.ManageWorkingDirectories): viewModelUpdateService.UpdateIsActiveForParamsDebounced(); break;
@@ -116,5 +124,13 @@ private void UseSolutionDirChanged()
             fileStorage.DeleteAllUnusedArgFiles();
             fileStorage.SaveAllProjects();
         }
+        private void UseCpsVirtualProfileChanged()
+        {
+            foreach (var project in vsHelper.GetSupportedProjects().Where(x => x.IsCpsProject()))
+            {
+                projectConfigService.UpdateProjectConfig(project);
+                cpsProjectConfigService.SetActiveLaunchProfileToVirtualProfile(project.GetProject());
+            }
+        }
     }
 }