VS Add-in more properties and improvements

visual_studio/NativeClientVSAddIn/NativeClientVSAddIn/Connect.cs

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 namespace NativeClientVSAddIn
 {
   using System;
 
   using EnvDTE;
   using EnvDTE80;
   using Extensibility;
+  using Microsoft.VisualStudio;
+  using Microsoft.VisualStudio.VCProjectEngine;
 
   /// <summary>The object for implementing an Add-in.</summary>
   /// <seealso class='IDTExtensibility2' />
   public class Connect : IDTExtensibility2
   {
     /// <summary>
     /// Receives events related to starting/stopping debugging.
     /// </summary>
     private DebuggerEvents debuggerEvents_;
 
     /// <summary>
+    /// Receives all generic events from Visual Studio.
+    /// </summary>
+    private CommandEvents commandEvents_;
+
+    /// <summary>
+    /// The main Visual Studio interface.
+    /// </summary>
+    private DTE2 dte_;
+
+    /// <summary>
     /// Holds methods related to running the plug-in and debugging.
     /// </summary>
     private PluginDebuggerHelper debuggerHelper_;
 
     /// <summary>
     /// Implements the OnConnection method of the IDTExtensibility2 interface.
     /// Receives notification that the Add-in is being loaded.
     /// </summary>
     /// <param name="application">Root object of the host application.</param>
     /// <param name="connectMode">
     /// Describes how the Add-in is being loaded (e.g. command line or UI). This is unused since
     /// the add-in functions the same regardless of how it was loaded.
     /// </param>
     /// <param name="addInInst">Object representing this Add-in.</param>
     /// <param name="custom">Unused, but could contain host specific data for the add-in.</param>
     /// <seealso class='IDTExtensibility2' />
     public void OnConnection(
         object application,
         ext_ConnectMode connectMode,
         object addInInst,
         ref Array custom)
     {
-      DTE2 dte = (DTE2)application;
-      debuggerHelper_ = new PluginDebuggerHelper(dte);
+      dte_ = (DTE2)application;
+      debuggerHelper_ = new PluginDebuggerHelper(dte_);
 
-      debuggerEvents_ = dte.Events.DebuggerEvents;
+      debuggerEvents_ = dte_.Events.DebuggerEvents;
       debuggerEvents_.OnEnterDesignMode += DebuggerOnEnterDesignMode;
       debuggerEvents_.OnEnterRunMode += DebuggerOnEnterRunMode;
+
+      commandEvents_ = dte_.Events.CommandEvents;
+      commandEvents_.AfterExecute += CommandEventsAfterExecute;
     }
 
     /// <summary>
-    /// Called when Visual Studio ends a debugging session.
-    /// </summary>
-    /// <param name="reason">The parameter is not used.</param>
-    public void DebuggerOnEnterDesignMode(dbgEventReason reason)
-    {
-      debuggerHelper_.StopDebugging();
-    }
-
-    /// <summary>
-    /// Called when Visual Studio starts a debugging session.
-    /// </summary>
-    /// <param name="reason">Indicates how we are entering run mode (breakpoint or launch).</param>
-    public void DebuggerOnEnterRunMode(dbgEventReason reason)
-    {
-      // If we are starting debugging (not re-entering from a breakpoint)
-      // then load project settings and start the debugger-helper.
-      if (reason == dbgEventReason.dbgEventReasonLaunchProgram &&
-          debuggerHelper_.LoadProjectSettings())
-      {
-        debuggerHelper_.StartDebugging();
-      }
-    }
-
-    /// <summary>
     /// Implements the OnDisconnection method of the IDTExtensibility2
     /// interface. Receives notification that the Add-in is being unloaded.
     /// </summary>
     /// <param name='disconnectMode'>Describes how the Add-in is being unloaded.</param>
     /// <param name='custom'>Array of parameters that are host application specific.</param>
     /// <seealso class='IDTExtensibility2' />
     public void OnDisconnection(ext_DisconnectMode disconnectMode, ref Array custom)
     {
     }
 
@@ skipping 19 matching lines @@
 
     /// <summary>
     /// Implements the OnBeginShutdown method of the IDTExtensibility2 interface.
     /// Receives notification that the host application is being unloaded.
     /// </summary>
     /// <param name='custom'>Array of parameters that are host application specific.</param>
     /// <seealso class='IDTExtensibility2' />
     public void OnBeginShutdown(ref Array custom)
     {
     }
+
+    /// <summary>
+    /// Receives notification after any generic VS command has executed.

[noelallen1, 2012/08/04 01:18:34]

Could you explain why you are doing this in the comment?  It's non-obvious.

[tysand, 2012/08/04 02:07:34]

Done.

+    /// </summary>
+    /// <param name="guid">Guid of the command grouping.</param>
+    /// <param name="id">ID of the command within its grouping.</param>
+    /// <param name="customIn">Command specific input.</param>
+    /// <param name="customOut">Command specific parameter.</param>
+    private void CommandEventsAfterExecute(string guid, int id, object customIn, object customOut)
+    {
+      const string VSStd2KCmdIDEnumGuid = "{1496A755-94DE-11D0-8C3F-00C04FC2AAE2}";
+      if (guid.Equals(VSStd2KCmdIDEnumGuid, StringComparison.OrdinalIgnoreCase))
+      {
+        // If loading a NaCl or Pepper platform, perform property modifications.
+        if (id == (int)VSConstants.VSStd2KCmdID.SolutionPlatform)
+        {
+          string platform = customOut as string;
+          if (Strings.NaClPlatformName.Equals(platform) ||
+              Strings.PepperPlatformName.Equals(platform))
+          {
+            PerformPropertyModifications();
+          }
+        }
+      }
+    }
+
+    /// <summary>
+    /// Goes through all projects in the solution and updates their properties with necessary
+    /// modifications if they are NaCl or Pepper configurations. We add the version information
+    /// here.

[noelallen1, 2012/08/04 01:18:34]

Same... Good to document why in case that reason goes away in the future.

[tysand, 2012/08/04 02:07:34]

Done.

+    /// </summary>
+    private void PerformPropertyModifications()
+    {
+      string naclAddInVersion = GetAddInVersionFromDescription();
+
+      var configs = Utility.GetPlatformVCConfigurations(dte_, Strings.PepperPlatformName);
+      configs.AddRange(Utility.GetPlatformVCConfigurations(dte_, Strings.NaClPlatformName));
+
+      foreach (VCConfiguration config in configs)
+      {
+        IVCRulePropertyStorage general = config.Rules.Item("ConfigurationGeneral");
+        string projectVersionSetting = general.GetEvaluatedPropertyValue("NaClAddInVersion");
+        if (string.IsNullOrEmpty(projectVersionSetting))
+        {
+          general.SetPropertyValue("NaClAddInVersion", naclAddInVersion);
+          PerformPropertyFixes(config);
+        }
+      }
+    }
+
+    /// <summary>
+    /// Takes a project configuration and sets values in the project file to work around some
+    /// problems in Visual Studio.
+    /// </summary>
+    /// <param name="config">A configuration that needs modification.</param>
+    private void PerformPropertyFixes(VCConfiguration config)
+    {
+      string name = config.Platform.Name;

[noelallen1, 2012/08/04 01:18:34]

Is 'name' ever used?

[tysand, 2012/08/04 02:07:34]

Embarrassing, this was debugging code. Removed it. 
On 2012/08/04 01:18:34, noelallen1 wrote:

+      string aaa = config.Name;

[noelallen1, 2012/08/04 01:18:34]

'aaa' what is this variable for?

[tysand, 2012/08/04 02:07:34]

Debugging code. Oops.
On 2012/08/04 01:18:34, noelallen1 wrote:

+      IVCRulePropertyStorage debugger = config.Rules.Item("WindowsLocalDebugger");
+      string evaluatedCommand = debugger.GetEvaluatedPropertyValue("LocalDebuggerCommand");
+      debugger.SetPropertyValue("LocalDebuggerCommand", evaluatedCommand);
+
+      string arguments = debugger.GetUnevaluatedPropertyValue("LocalDebuggerCommandArguments");
+      debugger.SetPropertyValue("LocalDebuggerCommandArguments", arguments);
+    }
+
+    /// <summary>
+    /// During the build process we dynamically put the add-in version number into the add-in
+    /// description.  This function extracts that version number.
+    /// </summary>
+    /// <returns>The add-in version number.</returns>
+    private string GetAddInVersionFromDescription()
+    {
+      string naclAddinVersion = "missing";
+      foreach (AddIn addin in dte_.AddIns)
+      {
+        if (addin.Name.Equals(Strings.AddInName))
+        {
+          string identifier = "Version: [";
+          int start = addin.Description.IndexOf(identifier) + identifier.Length;
+          int end = addin.Description.LastIndexOf(']');
+          if (start >= 0 && end >= 0)
+          {
+            naclAddinVersion = addin.Description.Substring(start, end - start);
+            break;
+          }
+        }
+      }
+
+      return naclAddinVersion;
+    }
+
+    /// <summary>
+    /// Called when Visual Studio ends a debugging session.
+    /// </summary>
+    /// <param name="reason">The parameter is not used.</param>
+    private void DebuggerOnEnterDesignMode(dbgEventReason reason)
+    {
+      debuggerHelper_.StopDebugging();
+    }
+
+    /// <summary>
+    /// Called when Visual Studio starts a debugging session.
+    /// </summary>
+    /// <param name="reason">Indicates how we are entering run mode (breakpoint or launch).</param>
+    private void DebuggerOnEnterRunMode(dbgEventReason reason)
+    {
+      // If we are starting debugging (not re-entering from a breakpoint)
+      // then load project settings and start the debugger-helper.
+      if (reason == dbgEventReason.dbgEventReasonLaunchProgram &&
+          debuggerHelper_.LoadProjectSettings())
+      {
+        debuggerHelper_.StartDebugging();
+      }
+    }
   }
 }