Move all wildcards into targets or expand them (#6406)

Wildcards are not allowed in toplevel ItemGroups in vcxproj; they must be generated by targets. We mostly use wildcards for pulling in PRI files that are dumped on disk by the translation tool. We don't want to check those in, so we can't expand references to them. To that end, I've introduced a new target that will take a list of folders containing resw files and expand wildcards under them. All[1] other wildcards have been moved into their respective targets _or_ simply expanded. [1]: Nothing has complained about the resource wildcards in CascadiaResources.build.items, so I haven't exploded it yet. Fixes #6214.
2020-06-08 14:01:47 -07:00 · 2020-06-08 14:01:47 -07:00 · e3ee5838a7
parent ccea66710c
commit e3ee5838a7
13 changed files with 107 additions and 43 deletions
--- a/.github/actions/spell-check/dictionary/dictionary.txt
+++ b/.github/actions/spell-check/dictionary/dictionary.txt
@ -470900,6 +470900,7 @@ wild-born
 wild-brained
 wild-bred
 wildcard
+wildcards
 wildcat
 wildcats
 wildcatted
--- a/.github/actions/spell-check/expect/expect.txt
+++ b/.github/actions/spell-check/expect/expect.txt
@ -1746,6 +1746,7 @@ popup
 POPUPATTR
 PORFLG
 positionals
+posix
 POSTCHARBREAKS
 POSX
 POSXSCROLL
--- a/build/rules/CollectWildcardResources.targets
+++ b/build/rules/CollectWildcardResources.targets
@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project DefaultTargets="Build" ToolsVersion="16.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <PropertyGroup>
+  </PropertyGroup>
+
+  <Target Name="BeforeGenerateProjectPriFile" DependsOnTargets="OpenConsoleCollectWildcardPRIFiles" />
+
+  <!--
+    The vcxproj system does not support wildcards at the root level of a project.
+    This poses a problem, as we want to include resw files that are not checked into the
+    repository. Since they're usually localized and stored in directories named after
+    their languages, we can't exactly explicitly simultaneously list them all and remain
+    sane. We want to use wildcards to make our lives easier.
+
+    This rule takes OCResourceDirectory items and includes all resw files that live
+    underneath them.
+
+    ** TIRED **
+    (does not work because of wildcards)
+    <PRIResource Include="Resources/*/Resources.resw" />
+
+    ** WIRED **
+    (keep the en-US resource in the project, because it is checked in and VS will show it)
+    <PRIResource Include="Resources/en-US/Resources.resw" />
+    <OCResourceDirectory Include="Resources" />
+  -->
+  <Target Name="OpenConsoleCollectWildcardPRIFiles">
+    <CreateItem Include="@(OCResourceDirectory->'%(Identity)\**\*.resw')">
+      <Output TaskParameter="Include" ItemName="_OCFoundPRIFiles" />
+    </CreateItem>
+    <ItemGroup>
+      <_OCFoundPRIFiles Include="@(PRIResource)" />
+      <PRIResource Remove="@(PRIResource)" />
+      <PRIResource Include="@(_OCFoundPRIFiles->Distinct())" />
+    </ItemGroup>
+    <Message Text="$(ProjectName) (wildcard PRIs) -> @(PRIResource)" />
+  </Target>
+</Project>
--- a/src/cascadia/CascadiaPackage/CascadiaPackage.wapproj
+++ b/src/cascadia/CascadiaPackage/CascadiaPackage.wapproj
@ -46,8 +46,9 @@
    <!-- Resources -->
    <!-- This resw only defines things that are used in this package's AppxManifest,
         so it's not in the common resource items. -->
-    <PRIResource Include="Resources\*\Resources.resw" />
+    <PRIResource Include="Resources\en-US\Resources.resw" />
    <PRIResource Include="Resources\Resources.resw" />
+    <OCResourceDirectory Include="Resources" />
  </ItemGroup>

  <!-- This is picked up by CascadiaResources.build.items. -->
@ -148,4 +149,6 @@
    </PropertyGroup>
    <Error Condition="!Exists('..\..\..\packages\Microsoft.UI.Xaml.2.4.2-prerelease.200604001\build\native\Microsoft.UI.Xaml.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\..\..\packages\Microsoft.UI.Xaml.2.4.2-prerelease.200604001\build\native\Microsoft.UI.Xaml.targets'))" />
  </Target>
+
+  <Import Project="$(SolutionDir)build\rules\CollectWildcardResources.targets" />
 </Project>
--- a/src/cascadia/LocalTests_TerminalApp/TestHostApp/TestHostApp.vcxproj
+++ b/src/cascadia/LocalTests_TerminalApp/TestHostApp/TestHostApp.vcxproj
@ -123,27 +123,27 @@

  <Import Project="$(OpenConsoleDir)\packages\Microsoft.UI.Xaml.2.4.2-prerelease.200604001\build\native\Microsoft.UI.Xaml.targets" Condition="Exists('$(OpenConsoleDir)\packages\Microsoft.UI.Xaml.2.4.2-prerelease.200604001\build\native\Microsoft.UI.Xaml.targets')" />

-  <!-- Use this to auto-find all the dll's that TerminalConnection produces. We
-    don't roll these up automatically, so we'll need to copy them manually
-    (below)
-
-    The dependencies from TerminalConnection get rolled up in the
-    GetPackagingOutputs step, when it produces the "appx recipe". This means
-    they only show up when the build produces an AppX\ folder for either running
-    or packaging.
-
-    It is literally impossible to produce an AppX\ folder using MSBuild without
-    packaging an appx, and we don't want to do that anyway, so we use these copy
-    rules instead.
-  -->
-  <ItemGroup>
-      <TerminalConnectionDlls Include="$(_CppWinrtBinRoot)\TerminalConnection\*.dll"/>
-  </ItemGroup>
-
  <Import Project="$(OpenConsoleDir)\src\common.build.post.props" />

  <Target Name="AfterBuild">

+    <!-- Use this to auto-find all the dll's that TerminalConnection produces. We
+      don't roll these up automatically, so we'll need to copy them manually
+      (below)
+
+      The dependencies from TerminalConnection get rolled up in the
+      GetPackagingOutputs step, when it produces the "appx recipe". This means
+      they only show up when the build produces an AppX\ folder for either running
+      or packaging.
+
+      It is literally impossible to produce an AppX\ folder using MSBuild without
+      packaging an appx, and we don't want to do that anyway, so we use these copy
+      rules instead.
+    -->
+    <ItemGroup>
+        <TerminalConnectionDlls Include="$(_CppWinrtBinRoot)\TerminalConnection\*.dll"/>
+    </ItemGroup>
+
    <!-- Copy the AppxManifest.xml to another file, because when TAEF is
      deploying the app, it'll delete the AppxManifest.xml file from this
      directory when it tries to clean up after itself. -->
--- a/src/cascadia/TerminalApp/lib/TerminalAppLib.vcxproj
+++ b/src/cascadia/TerminalApp/lib/TerminalAppLib.vcxproj
@ -233,7 +233,8 @@
  </ItemGroup>
  <!-- ========================= Misc Files ======================== -->
  <ItemGroup>
-    <PRIResource Include="..\Resources\*\Resources.resw" />
+    <PRIResource Include="..\Resources\en-US\Resources.resw" />
+    <OCResourceDirectory Include="../Resources" />
    <None Include="../packages.config" />
  </ItemGroup>
  <!-- ========================= Project References ======================== -->
@ -345,4 +346,6 @@
  <Target Name="_TerminalAppGenerateUserSettingsH" Inputs="..\userDefaults.json" Outputs="Generated Files\userDefaults.h" BeforeTargets="BeforeClCompile">
    <Exec Command="powershell.exe -noprofile –ExecutionPolicy Unrestricted $(OpenConsoleDir)\tools\GenerateHeaderForJson.ps1 -JsonFile ..\userDefaults.json -OutPath '&quot;Generated Files\userDefaults.h&quot;' -VariableName UserSettingsJson" />
  </Target>
+
+  <Import Project="$(SolutionDir)build\rules\CollectWildcardResources.targets" />
 </Project>
--- a/src/cascadia/TerminalConnection/TerminalConnection.vcxproj
+++ b/src/cascadia/TerminalConnection/TerminalConnection.vcxproj
@ -59,7 +59,8 @@
    <Midl Include="TelnetConnection.idl" />
  </ItemGroup>
  <ItemGroup>
-    <PRIResource Include="Resources\*\Resources.resw" />
+    <PRIResource Include="Resources\en-US\Resources.resw" />
+    <OCResourceDirectory Include="Resources" />
    <None Include="packages.config" />
  </ItemGroup>
  <!-- ========================= Project References ======================== -->
@ -95,4 +96,6 @@
    </Link>
  </ItemDefinitionGroup>
  <Import Project="..\..\..\packages\vcpkg-telnetpp.1.0.1\build\native\vcpkg-telnetpp.targets" Condition="Exists('..\..\..\packages\vcpkg-telnetpp.1.0.1\build\native\vcpkg-telnetpp.targets')" />
+
+  <Import Project="$(SolutionDir)build\rules\CollectWildcardResources.targets" />
 </Project>
--- a/src/cascadia/TerminalControl/TerminalControl.vcxproj
+++ b/src/cascadia/TerminalControl/TerminalControl.vcxproj
@ -86,7 +86,8 @@
    <None Include="TerminalControl.def" />
  </ItemGroup>
  <ItemGroup>
-    <PRIResource Include="Resources\*\Resources.resw" />
+    <PRIResource Include="Resources\en-US\Resources.resw" />
+    <OCResourceDirectory Include="Resources" />
  </ItemGroup>
  <!-- ========================= Project References ======================== -->
  <ItemGroup>
@ -133,4 +134,6 @@
      <AdditionalIncludeDirectories>$(OpenConsoleDir)src\cascadia\inc;$(OpenConsoleDir)src\types\inc;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
    </ClCompile>
  </ItemDefinitionGroup>
+
+  <Import Project="$(SolutionDir)build\rules\CollectWildcardResources.targets" />
 </Project>
--- a/src/cascadia/TerminalControl/TerminalControl.vcxproj.filters
+++ b/src/cascadia/TerminalControl/TerminalControl.vcxproj.filters
@ -45,7 +45,7 @@
    <Natvis Include="$(SolutionDir)tools\ConsoleTypes.natvis" />
  </ItemGroup>
  <ItemGroup>
-    <PRIResource Include="Resources\*\Resources.resw">
+    <PRIResource Include="Resources\en-US\Resources.resw">
      <Filter>Resources</Filter>
    </PRIResource>
  </ItemGroup>
--- a/src/cascadia/WindowsTerminal/WindowsTerminal.vcxproj
+++ b/src/cascadia/WindowsTerminal/WindowsTerminal.vcxproj
@ -115,21 +115,6 @@
    <Error Condition="!Exists('..\..\..\packages\Terminal.ThemeHelpers.0.2.200324001\build\native\Terminal.ThemeHelpers.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\..\..\packages\Terminal.ThemeHelpers.0.2.200324001\build\native\Terminal.ThemeHelpers.targets'))" />
  </Target>

-  <!-- **BEGIN VC LIBS HACK** -->
-  <PropertyGroup>
-    <ReasonablePlatform Condition="'$(Platform)'=='Win32'">x86</ReasonablePlatform>
-    <ReasonablePlatform Condition="'$(ReasonablePlatform)'==''">$(Platform)</ReasonablePlatform>
-  </PropertyGroup>
-
-  <ItemGroup Condition="'$(WindowsTerminalOfficialBuild)'=='true'">
-    <!-- Add all the CRT libs as content -->
-    <_OpenConsoleVCLibToCopy Include="$(VCToolsRedistInstallDir)\$(ReasonablePlatform)\Microsoft.VC142.CRT\*.dll">
-      <TargetPath>%(Filename)%(Extension)</TargetPath>
-    </_OpenConsoleVCLibToCopy>
-  </ItemGroup>
-  <!-- **END VC LIBS HACK** -->
-
-
  <!-- Override GetPackagingOutputs to roll up all our dependencies.
       This ensures that when the WAP packaging project asks what files go into
       the package, we tell it.
@ -154,13 +139,25 @@

    <ItemGroup>
      <PackagingOutputs Include="@(_PackagingOutputsFromOtherProjects)" />
-      <!-- (part of the VC LIBS HACK above) -->
+    </ItemGroup>
+
+    <!-- **BEGIN VC LIBS HACK** -->
+    <PropertyGroup>
+      <ReasonablePlatform Condition="'$(Platform)'=='Win32'">x86</ReasonablePlatform>
+      <ReasonablePlatform Condition="'$(ReasonablePlatform)'==''">$(Platform)</ReasonablePlatform>
+    </PropertyGroup>
+
+    <ItemGroup Condition="'$(WindowsTerminalOfficialBuild)'=='true'">
+      <!-- Add all the CRT libs as content; these must be inside a Target as they are wildcards. -->
+      <_OpenConsoleVCLibToCopy Include="$(VCToolsRedistInstallDir)\$(ReasonablePlatform)\Microsoft.VC142.CRT\*.dll" />
+
      <PackagingOutputs Include="@(_OpenConsoleVCLibToCopy)">
        <ProjectName>$(ProjectName)</ProjectName>
        <OutputGroup>BuiltProjectOutputGroup</OutputGroup>
+        <TargetPath>%(Filename)%(Extension)</TargetPath>
      </PackagingOutputs>
    </ItemGroup>
-
+    <!-- **END VC LIBS HACK** -->
  </Target>

  <Import Project="$(OpenConsoleDir)\build\rules\GenerateSxsManifestsFromWinmds.targets" />
--- a/src/cascadia/WindowsTerminalUniversal/WindowsTerminalUniversal.vcxproj
+++ b/src/cascadia/WindowsTerminalUniversal/WindowsTerminalUniversal.vcxproj
@ -123,9 +123,10 @@
    <!-- Resources -->
    <!-- This resw only defines things that are used in this package's AppxManifest,
         so it's not in the common resource items. -->
-    <PRIResource Include="Resources\*\Resources.resw" />
+    <PRIResource Include="Resources\en-US\Resources.resw" />
    <PRIResource Include="Resources\Resources.resw" />
    <PRIResource Include="Resources\Resources.devicefamily-core.resw" />
+    <OCResourceDirectory Include="Resources" />
  </ItemGroup>
  <PropertyGroup>
    <!-- This is picked up by CascadiaResources.build.items. -->
@ -173,4 +174,6 @@
    <Error Condition="!Exists('..\..\..\packages\Microsoft.Toolkit.Win32.UI.XamlApplication.6.0.0\build\native\Microsoft.Toolkit.Win32.UI.XamlApplication.props')" Text="$([System.String]::Format('$(ErrorText)', '..\..\..\packages\Microsoft.Toolkit.Win32.UI.XamlApplication.6.0.0\build\native\Microsoft.Toolkit.Win32.UI.XamlApplication.props'))" />
    <Error Condition="!Exists('..\..\..\packages\Microsoft.Toolkit.Win32.UI.XamlApplication.6.0.0\build\native\Microsoft.Toolkit.Win32.UI.XamlApplication.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\..\..\packages\Microsoft.Toolkit.Win32.UI.XamlApplication.6.0.0\build\native\Microsoft.Toolkit.Win32.UI.XamlApplication.targets'))" />
  </Target>
+
+  <Import Project="$(SolutionDir)build\rules\CollectWildcardResources.targets" />
 </Project>
--- a/src/cascadia/WindowsTerminalUniversal/WindowsTerminalUniversal.vcxproj.filters
+++ b/src/cascadia/WindowsTerminalUniversal/WindowsTerminalUniversal.vcxproj.filters
@ -23,7 +23,7 @@
    <PRIResource Include="Resources.devicefamily-core.resw">
      <Filter>Resources</Filter>
    </PRIResource>
-    <PRIResource Include="Resources\*\Resources.resw">
+    <PRIResource Include="Resources\en-US\Resources.resw">
      <Filter>Resources</Filter>
    </PRIResource>
    <PRIResource Include="Resources.resw">
--- a/src/dep/fmt/fmt.vcxproj
+++ b/src/dep/fmt/fmt.vcxproj
@ -16,10 +16,22 @@
    </ClCompile>
  </ItemDefinitionGroup>
  <ItemGroup>
-    <ClCompile Include="$(SolutionDir)\oss\fmt\src\*.cc" />
+    <ClCompile Include="$(SolutionDir)oss/fmt/src/format.cc" />
+    <ClCompile Include="$(SolutionDir)oss/fmt/src/os.cc" />
  </ItemGroup>
  <ItemGroup>
-    <ClInclude Include="$(SolutionDir)\oss\fmt\include\fmt\*.h" />
+    <ClInclude Include="$(SolutionDir)oss/fmt/include/fmt/chrono.h" />
+    <ClInclude Include="$(SolutionDir)oss/fmt/include/fmt/color.h" />
+    <ClInclude Include="$(SolutionDir)oss/fmt/include/fmt/compile.h" />
+    <ClInclude Include="$(SolutionDir)oss/fmt/include/fmt/core.h" />
+    <ClInclude Include="$(SolutionDir)oss/fmt/include/fmt/format-inl.h" />
+    <ClInclude Include="$(SolutionDir)oss/fmt/include/fmt/format.h" />
+    <ClInclude Include="$(SolutionDir)oss/fmt/include/fmt/locale.h" />
+    <ClInclude Include="$(SolutionDir)oss/fmt/include/fmt/os.h" />
+    <ClInclude Include="$(SolutionDir)oss/fmt/include/fmt/ostream.h" />
+    <ClInclude Include="$(SolutionDir)oss/fmt/include/fmt/posix.h" />
+    <ClInclude Include="$(SolutionDir)oss/fmt/include/fmt/printf.h" />
+    <ClInclude Include="$(SolutionDir)oss/fmt/include/fmt/ranges.h" />
  </ItemGroup>
  <!-- Careful reordering these. Some default props (contained in these files) are order sensitive. -->
  <Import Project="$(SolutionDir)src\common.build.post.props" />