Show only latest VS, VC prompts by default

.github/actions/spelling/allow/microsoft.txt

@@ -24,6 +24,7 @@ DTDs
 DWINRT
 enablewttlogging
 Intelli
+IVisual
 LKG
 Lxss
 mfcribbon

.github/actions/spelling/patterns/patterns.txt

@@ -24,3 +24,4 @@ VERIFY_ARE_EQUAL\(L"[^"]+"
 std::memory_order_[\w]+
 D2DERR_SHADER_COMPILE_FAILED
 TIL_FEATURE_[0-9A-Z_]+
+vcvars\w*

src/cascadia/TerminalSettingsModel/CascadiaSettingsSerialization.cpp

@@ -11,8 +11,7 @@
 
 #include "AzureCloudShellGenerator.h"
 #include "PowershellCoreProfileGenerator.h"
-#include "VsDevCmdGenerator.h"
-#include "VsDevShellGenerator.h"
+#include "VisualStudioGenerator.h"
 #include "WslDistroGenerator.h"
 
 // The following files are generated at build time into the "Generated Files" directory.
@@ -131,8 +130,7 @@ void SettingsLoader::GenerateProfiles()
     _executeGenerator(PowershellCoreProfileGenerator{});
     _executeGenerator(WslDistroGenerator{});
     _executeGenerator(AzureCloudShellGenerator{});
-    _executeGenerator(VsDevCmdGenerator{});
-    _executeGenerator(VsDevShellGenerator{});
+    _executeGenerator(VisualStudioGenerator{});
 }
 
 // A new settings.json gets a special treatment:

src/cascadia/TerminalSettingsModel/Microsoft.Terminal.Settings.ModelLib.vcxproj

@@ -14,7 +14,8 @@
   <Import Project="$(OpenConsoleDir)src\cppwinrt.build.pre.props" />
   <!-- ========================= Headers ======================== -->
   <ItemGroup>
-    <ClInclude Include="BaseVisualStudioGenerator.h" />
+    <ClInclude Include="VcDevCmdGenerator.h" />
+    <ClInclude Include="VisualStudioGenerator.h" />
     <ClInclude Include="DefaultTerminal.h">
       <DependentUpon>DefaultTerminal.idl</DependentUpon>
     </ClInclude>
@@ -84,7 +85,8 @@
   </ItemGroup>
   <!-- ========================= Cpp Files ======================== -->
   <ItemGroup>
-    <ClCompile Include="BaseVisualStudioGenerator.cpp" />
+    <ClCompile Include="VcDevCmdGenerator.cpp" />
+    <ClCompile Include="VisualStudioGenerator.cpp" />
     <ClCompile Include="DefaultTerminal.cpp">
       <DependentUpon>DefaultTerminal.idl</DependentUpon>
     </ClCompile>
@@ -241,7 +243,6 @@
   </ItemDefinitionGroup>
   <!-- ========================= Globals ======================== -->
   <Import Project="$(OpenConsoleDir)src\cppwinrt.build.post.props" />
-
   <Import Project="..\..\..\packages\Microsoft.UI.Xaml.2.7.0-prerelease.210913003\build\native\Microsoft.UI.Xaml.targets" Condition="Exists('..\..\..\packages\Microsoft.UI.Xaml.2.7.0-prerelease.210913003\build\native\Microsoft.UI.Xaml.targets')" />
   <Target Name="EnsureNuGetPackageBuildImports" BeforeTargets="PrepareForBuild">
     <PropertyGroup>
@@ -266,4 +267,4 @@
   </Target>
   <Import Project="$(SolutionDir)build\rules\CollectWildcardResources.targets" />
   <Import Project="..\..\..\packages\Microsoft.VisualStudio.Setup.Configuration.Native.2.3.2262\build\native\Microsoft.VisualStudio.Setup.Configuration.Native.targets" Condition="Exists('..\..\..\packages\Microsoft.VisualStudio.Setup.Configuration.Native.2.3.2262\build\native\Microsoft.VisualStudio.Setup.Configuration.Native.targets')" />
-</Project>
+</Project>

src/cascadia/TerminalSettingsModel/Microsoft.Terminal.Settings.ModelLib.vcxproj.filters

@@ -34,7 +34,7 @@
     <ClCompile Include="IconPathConverter.cpp" />
     <ClCompile Include="DefaultTerminal.cpp" />
     <ClCompile Include="FileUtils.cpp" />
-    <ClCompile Include="BaseVisualStudioGenerator.cpp">
+    <ClCompile Include="VisualStudioGenerator.cpp">
       <Filter>profileGeneration</Filter>
     </ClCompile>
     <ClCompile Include="VsDevCmdGenerator.cpp">
@@ -46,6 +46,9 @@
     <ClCompile Include="VsSetupConfiguration.cpp">
       <Filter>profileGeneration</Filter>
     </ClCompile>
+    <ClCompile Include="VcDevCmdGenerator.cpp">
+      <Filter>profileGeneration</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="pch.h" />
@@ -80,7 +83,7 @@
     <ClInclude Include="DefaultTerminal.h" />
     <ClInclude Include="FileUtils.h" />
     <ClInclude Include="HashUtils.h" />
-    <ClInclude Include="BaseVisualStudioGenerator.h">
+    <ClInclude Include="VisualStudioGenerator.h">
       <Filter>profileGeneration</Filter>
     </ClInclude>
     <ClInclude Include="VsDevCmdGenerator.h">
@@ -92,6 +95,9 @@
     <ClInclude Include="VsSetupConfiguration.h">
       <Filter>profileGeneration</Filter>
     </ClInclude>
+    <ClInclude Include="VcDevCmdGenerator.h">
+      <Filter>profileGeneration</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <Midl Include="ActionArgs.idl" />
@@ -123,4 +129,4 @@
       <UniqueIdentifier>{81a6314f-aa5b-4533-a499-13bc3a5c4af0}</UniqueIdentifier>
     </Filter>
   </ItemGroup>
-</Project>
+</Project>

src/cascadia/TerminalSettingsModel/VcDevCmdGenerator.cpp

@@ -0,0 +1,99 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+#include "pch.h"
+#include "DynamicProfileUtils.h"
+#include "VcDevCmdGenerator.h"
+
+using namespace winrt::Microsoft::Terminal::Settings::Model;
+
+void VcDevCmdGenerator::GenerateProfiles(const VsSetupConfiguration::VsSetupInstance& instance, bool hidden, std::vector<winrt::com_ptr<implementation::Profile>>& profiles) const
+{
+    try
+    {
+        if (!IsInstanceValid(instance))
+        {
+            return;
+        }
+
+        const std::filesystem::path root{ GetVcCmdScriptDirectory(instance) };
+        if (!std::filesystem::exists(root))
+        {
+            return;
+        }
+
+// x64 environments only installed on 64-bit machines.
+#ifdef _WIN64
+        const auto vcvars64 = root / L"vcvars64.bat";
+        if (std::filesystem::exists(vcvars64))
+        {
+            auto profile = CreateProfile(instance, L"x64", vcvars64, hidden);
+            profiles.emplace_back(std::move(profile));
+
+            // Only the VC environment for the matching architecture should be shown by default.
+            hidden = true;
+        }
+
+        const auto vcvarsamd64_x86 = root / L"vcvarsamd64_x86.bat";
+        if (std::filesystem::exists(vcvarsamd64_x86))
+        {
+            auto profile = CreateProfile(instance, L"x64_x86", vcvarsamd64_x86, true);
+            profiles.emplace_back(std::move(profile));
+        }
+
+        const auto vcvarsx86_amd64 = root / L"vcvarsx86_amd64.bat";
+        if (std::filesystem::exists(vcvarsx86_amd64))
+        {
+            auto profile = CreateProfile(instance, L"x86_x64", vcvarsx86_amd64, true);
+            profiles.emplace_back(std::move(profile));
+        }
+#endif // _WIN64
+
+        const auto vcvars32 = root / L"vcvars32.bat";
+        if (std::filesystem::exists(vcvars32))
+        {
+            auto profile = CreateProfile(instance, L"x86", vcvars32, hidden);
+            profiles.emplace_back(std::move(profile));
+        }
+    }
+    CATCH_LOG();
+}
+
+winrt::com_ptr<implementation::Profile> VcDevCmdGenerator::CreateProfile(const VsSetupConfiguration::VsSetupInstance& instance, const std::wstring_view& prefix, const std::filesystem::path& path, bool hidden) const
+{
+    const auto seed = GetProfileGuidSeed(instance, path);
+    const winrt::guid profileGuid{ ::Microsoft::Console::Utils::CreateV5Uuid(TERMINAL_PROFILE_NAMESPACE_GUID, gsl::as_bytes(gsl::make_span(seed))) };
+
+    auto profile = winrt::make_self<implementation::Profile>(profileGuid);
+    profile->Name(winrt::hstring{ GetProfileName(instance, prefix) });
+    profile->Commandline(winrt::hstring{ GetProfileCommandLine(path) });
+    profile->StartingDirectory(winrt::hstring{ instance.GetInstallationPath() });
+    profile->Icon(winrt::hstring{ GetProfileIconPath() });
+    profile->Hidden(hidden);
+
+    return profile;
+}
+
+std::wstring VcDevCmdGenerator::GetProfileGuidSeed(const VsSetupConfiguration::VsSetupInstance& instance, const std::filesystem::path& path) const
+{
+    return L"VsDevCmd" + instance.GetInstanceId() + path.native();
+}
+
+std::wstring VcDevCmdGenerator::GetProfileName(const VsSetupConfiguration::VsSetupInstance& instance, const std::wstring_view& prefix) const
+{
+    std::wstring name{ prefix + L" Native Tools Command Prompt for VS " };
+    name.append(instance.GetProfileNameSuffix());
+    return name;
+}
+
+std::wstring VcDevCmdGenerator::GetProfileCommandLine(const std::filesystem::path& path) const
+{
+    std::wstring commandLine{ L"cmd.exe /k \"" + path.native() + L"\"" };
+
+    return commandLine;
+}
+
+std::wstring VcDevCmdGenerator::GetVcCmdScriptDirectory(const VsSetupConfiguration::VsSetupInstance& instance) const
+{
+    return instance.ResolvePath(L"VC\\Auxiliary\\Build\\");
+}

src/cascadia/TerminalSettingsModel/VcDevCmdGenerator.h

@@ -0,0 +1,46 @@
+/*++
+Copyright (c) Microsoft Corporation
+Licensed under the MIT license.
+
+Module Name:
+- VcDevCmdGenerator
+
+Abstract:
+- Dynamic profile generator for Visual C++ development environments.
+
+Author(s):
+- Heath Stewart - September 2021
+
+--*/
+
+#pragma once
+#include "VisualStudioGenerator.h"
+#include "VsSetupConfiguration.h"
+
+namespace winrt::Microsoft::Terminal::Settings::Model
+{
+    class VcDevCmdGenerator final : public VisualStudioGenerator::IVisualStudioProfileGenerator
+    {
+    public:
+        void GenerateProfiles(const VsSetupConfiguration::VsSetupInstance& instance, bool hidden, std::vector<winrt::com_ptr<implementation::Profile>>& profiles) const override;
+
+    private:
+        bool IsInstanceValid(const VsSetupConfiguration::VsSetupInstance&) const
+        {
+            // TODO: Need to determine when these VC environment scripts were added. vcvars32.bat at least was there since 15.0.
+            return true;
+        }
+
+        winrt::com_ptr<implementation::Profile> CreateProfile(const VsSetupConfiguration::VsSetupInstance& instance, const std::wstring_view& prefix, const std::filesystem::path& path, bool hidden) const;
+
+        std::wstring GetProfileIconPath() const
+        {
+            return L"ms-appx:///ProfileIcons/{0caa0dad-35be-5f56-a8ff-afceeeaa6101}.png";
+        }
+
+        std::wstring GetProfileGuidSeed(const VsSetupConfiguration::VsSetupInstance& instance, const std::filesystem::path& path) const;
+        std::wstring GetProfileName(const VsSetupConfiguration::VsSetupInstance& instance, const std::wstring_view& prefix) const;
+        std::wstring GetProfileCommandLine(const std::filesystem::path& path) const;
+        std::wstring GetVcCmdScriptDirectory(const VsSetupConfiguration::VsSetupInstance& instance) const;
+    };
+};

src/cascadia/TerminalSettingsModel/VisualStudioGenerator.cpp

@@ -0,0 +1,36 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+#include "pch.h"
+#include "DynamicProfileUtils.h"
+#include "VisualStudioGenerator.h"
+#include "VcDevCmdGenerator.h"
+#include "VsDevCmdGenerator.h"
+#include "VsDevShellGenerator.h"
+
+using namespace winrt::Microsoft::Terminal::Settings::Model;
+
+std::wstring_view VisualStudioGenerator::GetNamespace() const noexcept
+{
+    return std::wstring_view{ L"Windows.Terminal.VisualStudio" };
+}
+
+void VisualStudioGenerator::GenerateProfiles(std::vector<winrt::com_ptr<implementation::Profile>>& profiles) const
+{
+    const auto instances = VsSetupConfiguration::QueryInstances();
+
+    VsDevCmdGenerator devCmdGenerator;
+    VcDevCmdGenerator vcCmdGenerator;
+    VsDevShellGenerator devShellGenerator;
+
+    // Instances are ordered from latest to oldest. Hide all but the profiles for the latest instance.
+    bool hidden = false;
+    for (auto const& instance : instances)
+    {
+        devCmdGenerator.GenerateProfiles(instance, hidden, profiles);
+        vcCmdGenerator.GenerateProfiles(instance, hidden, profiles);
+        devShellGenerator.GenerateProfiles(instance, hidden, profiles);
+
+        hidden = true;
+    }
+}