Toolset update: VS 2022 17.0 Preview 2 (#2064)

Author: StephanTLavavej

.clang-format

@@ -1,7 +1,7 @@
 # Copyright (c) Microsoft Corporation.
 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 
-# https://releases.llvm.org/11.0.0/tools/clang/docs/ClangFormatStyleOptions.html
+# https://releases.llvm.org/12.0.0/tools/clang/docs/ClangFormatStyleOptions.html
 
 ---
 # Language:        Cpp
@@ -10,12 +10,12 @@ BasedOnStyle:  LLVM
 AccessModifierOffset: -4
 # AlignAfterOpenBracket: Align
 AlignAfterOpenBracket: DontAlign
-# AlignConsecutiveMacros: false
-AlignConsecutiveMacros: true
-# AlignConsecutiveAssignments: false
-AlignConsecutiveAssignments: true
-# AlignConsecutiveBitFields: false
-# AlignConsecutiveDeclarations: false
+# AlignConsecutiveMacros: None
+AlignConsecutiveMacros: Consecutive
+# AlignConsecutiveAssignments: None
+AlignConsecutiveAssignments: Consecutive
+# AlignConsecutiveBitFields: None
+# AlignConsecutiveDeclarations: None
 # AlignEscapedNewlines: Right
 AlignEscapedNewlines: Left
 # AlignOperands:   Align
@@ -38,6 +38,8 @@ AllowShortFunctionsOnASingleLine: Empty
 # AlwaysBreakBeforeMultilineStrings: false
 # AlwaysBreakTemplateDeclarations: MultiLine
 AlwaysBreakTemplateDeclarations: Yes
+# AttributeMacros:
+#   - __capability
 # BinPackArguments: true
 # BinPackParameters: true
 # BraceWrapping:
@@ -61,6 +63,7 @@ AlwaysBreakTemplateDeclarations: Yes
 #   SplitEmptyNamespace: true
 # BreakBeforeBinaryOperators: None
 BreakBeforeBinaryOperators: NonAssignment
+# BreakBeforeConceptDeclarations: true
 # BreakBeforeBraces: Attach
 # BreakBeforeInheritanceComma: false
 # BreakInheritanceList: BeforeColon
@@ -81,24 +84,30 @@ ColumnLimit:     120
 DeriveLineEnding: false
 # DerivePointerAlignment: false
 # DisableFormat:   false
+# EmptyLineBeforeAccessModifier: LogicalBlock
 # ExperimentalAutoDetectBinPacking: false
 # FixNamespaceComments: true
 # ForEachMacros:
 #   - foreach
 #   - Q_FOREACH
 #   - BOOST_FOREACH
+# StatementAttributeLikeMacros:
+#   - Q_EMIT
 # IncludeBlocks:   Preserve
 IncludeBlocks:   Regroup
 # IncludeCategories:
 #   - Regex:           '^"(llvm|llvm-c|clang|clang-c)/'
 #     Priority:        2
 #     SortPriority:    0
+#     CaseSensitive:   false
 #   - Regex:           '^(<|"(gtest|gmock|isl|json)/)'
 #     Priority:        3
 #     SortPriority:    0
+#     CaseSensitive:   false
 #   - Regex:           '.*'
 #     Priority:        1
 #     SortPriority:    0
+#     CaseSensitive:   false
 IncludeCategories:
   - Regex:           '^<yvals(_core)?\.h>$'
     Priority:        1
@@ -122,6 +131,8 @@ IndentCaseBlocks: true
 # IndentGotoLabels: true
 # IndentPPDirectives: None
 # IndentExternBlock: AfterExternBlock
+# IndentRequires:  false
+IndentRequires:  true
 # IndentWidth:     2
 IndentWidth:     4
 # IndentWrappedFunctionNames: false
@@ -150,20 +161,24 @@ NamespaceIndentation: All
 # PenaltyBreakTemplateDeclaration: 10
 # PenaltyExcessCharacter: 1000000
 # PenaltyReturnTypeOnItsOwnLine: 60
+# PenaltyIndentedWhitespace: 0
 # PointerAlignment: Right
 PointerAlignment: Left
 # ReflowComments:  true
 # SortIncludes:    true
+# SortJavaStaticImport: Before
 # SortUsingDeclarations: true
 # SpaceAfterCStyleCast: false
 SpaceAfterCStyleCast: true
 # SpaceAfterLogicalNot: false
 # SpaceAfterTemplateKeyword: true
 # SpaceBeforeAssignmentOperators: true
+# SpaceBeforeCaseColon: false
 # SpaceBeforeCpp11BracedList: false
 # SpaceBeforeCtorInitializerColon: true
 # SpaceBeforeInheritanceColon: true
 # SpaceBeforeParens: ControlStatements
+# SpaceAroundPointerQualifiers: Default
 # SpaceBeforeRangeBasedForLoopColon: true
 # SpaceInEmptyBlock: false
 # SpaceInEmptyParentheses: false
@@ -175,6 +190,7 @@ SpaceAfterCStyleCast: true
 # SpacesInParentheses: false
 # SpacesInSquareBrackets: false
 # SpaceBeforeSquareBrackets: false
+# BitFieldColonSpacing: Both
 # Standard:        Latest
 # StatementMacros:
 #   - Q_UNUSED
@@ -198,4 +214,6 @@ UseCRLF:         true
 #   - STRINGIZE
 #   - PP_STRINGIZE
 #   - BOOST_PP_STRINGIZE
+#   - NS_SWIFT_NAME
+#   - CF_SWIFT_NAME
 ...

README.md

@@ -62,7 +62,7 @@ International Standard. The terms Working Draft (WD) and Working Paper (WP) are
 informally refer to these drafts as "the Standard" while being aware of the difference. (There are other relevant
 Standards; for example, supporting `/std:c++14` and `/std:c++17` involves understanding how the C++14 and C++17
 Standards differ from the Working Paper, and we often need to refer to the C Standard Library and ECMAScript regular
-expression specifications.) We're currently prioritizing C++20 features before starting any work on C++23.
+expression specifications.)
 
 Our primary goals are conformance, performance, usability, and compatibility.
 
@@ -79,8 +79,8 @@ significantly more complicated and fragile. That is, there's a "complexity budge
 debugging checks. For example, we've extensively marked the STL with `[[nodiscard]]` attributes because this helps
 programmers avoid bugs.
 
-* Compatibility: This includes binary compatibility and source compatibility. We're keeping VS 2019 binary-compatible
-with VS 2017 and VS 2015, which restricts what we can change in VS 2019 updates. (We've found that significant changes
+* Compatibility: This includes binary compatibility and source compatibility. We're keeping VS 2022 binary-compatible
+with VS 2015/2017/2019, which restricts what we can change in VS 2022 updates. (We've found that significant changes
 are possible even though other changes are impossible, which we'll be documenting in our Contribution Guidelines soon.)
 While there are a few exceptions to this rule (e.g. if a feature is added to the Working Paper, we implement it, and
 then the feature is significantly changed before the International Standard is finalized, we reserve the right to break
@@ -143,7 +143,7 @@ Just try to follow these rules, so we can spend more time fixing bugs and implem
 The STL uses boost-math headers to provide P0226R1 Mathematical Special Functions. We recommend using [vcpkg][] to
 acquire this dependency.
 
-1. Install Visual Studio 2019 16.11 Preview 2 or later.
+1. Install Visual Studio 2022 17.0 Preview 2 or later.
     * We recommend selecting "C++ CMake tools for Windows" in the VS Installer.
     This will ensure that you're using supported versions of CMake and Ninja.
     * Otherwise, install [CMake][] 3.20 or later, and [Ninja][] 1.10.2 or later.
@@ -158,7 +158,7 @@ acquire this dependency.
 
 # How To Build With A Native Tools Command Prompt
 
-1. Install Visual Studio 2019 16.11 Preview 2 or later.
+1. Install Visual Studio 2022 17.0 Preview 2 or later.
     * We recommend selecting "C++ CMake tools for Windows" in the VS Installer.
     This will ensure that you're using supported versions of CMake and Ninja.
     * Otherwise, install [CMake][] 3.20 or later, and [Ninja][] 1.10.2 or later.
@@ -172,14 +172,14 @@ acquire this dependency.
 
 To build the x86 target:
 
-1. Open an "x86 Native Tools Command Prompt for VS 2019 Preview".
+1. Open an "x86 Native Tools Command Prompt for VS 2022 Preview".
 2. Change directories to the previously cloned `STL` directory.
 3. `cmake -G Ninja -S . -B out\build\x86`
 4. `ninja -C out\build\x86`
 
-To build the x64 target:
+To build the x64 target (recommended):
 
-1. Open an "x64 Native Tools Command Prompt for VS 2019 Preview".
+1. Open an "x64 Native Tools Command Prompt for VS 2022 Preview".
 2. Change directories to the previously cloned `STL` directory.
 3. `cmake -G Ninja -S . -B out\build\x64`
 4. `ninja -C out\build\x64`
@@ -205,7 +205,7 @@ your .exe would "win" over the versions in System32.
 The compiler looks for include directories according to the `INCLUDE` environment variable, and the linker looks for
 import library directories according to the `LIB` environment variable, and the Windows loader will (eventually) look
 for DLL dependencies according to directories in the `PATH` environment variable. From an
-"x64 Native Tools Command Prompt for VS 2019 Preview":
+"x64 Native Tools Command Prompt for VS 2022 Preview":
 
 ```
 C:\Users\username\Desktop>set INCLUDE=C:\Dev\STL\out\build\x64\out\inc;%INCLUDE%
@@ -234,7 +234,7 @@ C:\Users\username\Desktop>dumpbin /IMPORTS .\example.exe | findstr msvcp
 # How To Run The Tests With A Native Tools Command Prompt
 
 1. Follow either [How To Build With A Native Tools Command Prompt][] or [How To Build With The Visual Studio IDE][].
-2. Acquire [Python][] 3.9.5 or newer and have it on the `PATH` (or run it directly using its absolute or relative path).
+2. Acquire [Python][] 3.9.6 or newer and have it on the `PATH` (or run it directly using its absolute or relative path).
 3. Have LLVM's `bin` directory on the `PATH` (so `clang-cl.exe` is available).
     * We recommend selecting "C++ Clang tools for Windows" in the VS Installer. This will automatically add LLVM to the
     `PATH` of the x86 and x64 Native Tools Command Prompts, and will ensure that you're using a supported version.
@@ -354,7 +354,7 @@ those features first the tests will begin passing unexpectedly for us and return
 this it is necessary to add a `PASS` entry to the `expected_results.txt` of the testsuite in question.
 
 The `UNSUPPORTED` result code means that the requirements for a test are not met and so it will not be run. Currently
-all tests which use the `/clr` or `/clr:pure` options are unsupported. Also, the `/BE` option is unsupported for x64.
+all tests which use the `/clr` or `/clr:pure` options are unsupported. Also, the `/BE` option is unsupported for x86.
 
 The `SKIPPED` result code indicates that a given test was explicitly skipped by adding a `SKIPPED` entry to the
 `expected_results.txt`. A test may be skipped for a number of reasons, which include, but are not limited to:
@@ -404,8 +404,8 @@ set PATH=C:\STL\out\build\x64\out\bin\amd64;%PATH%
 
 ### Modify The Visualizer
 
-To modify how components are visualized in the debugger edit the file `stl\debugger\STL.natvis`. For more information on
-how to modify this file check the [natvis documentation][].
+To modify how components are visualized in the debugger, edit the file `stl\debugger\STL.natvis`. For more information
+on how to modify this file, check the [natvis documentation][].
 
 ### Test Your Changes
 

azure-devops/cmake-configure-build.yml

@@ -30,7 +30,7 @@ steps:
     if exist "$(${{ parameters.buildOutputLocationVar }})" (
       rmdir /S /Q "$(${{ parameters.buildOutputLocationVar }})"
     )
-    call "%PROGRAMFILES(X86)%\Microsoft Visual Studio\2019\Preview\Common7\Tools\VsDevCmd.bat" ^
+    call "%ProgramFiles%\Microsoft Visual Studio\2022\Preview\Common7\Tools\VsDevCmd.bat" ^
     -host_arch=${{ parameters.hostArch }} -arch=${{ parameters.targetArch }} -no_logo
     cmake ${{ parameters.cmakeAdditionalFlags}} -G Ninja ^
     -DCMAKE_TOOLCHAIN_FILE=$(${{ parameters.vcpkgLocationVar }})\scripts\buildsystems\vcpkg.cmake ^
@@ -44,7 +44,7 @@ steps:
   timeoutInMinutes: 2
   env: { TMP: $(tmpDir), TEMP: $(tmpDir) }
 - script: |
-    call "%PROGRAMFILES(X86)%\Microsoft Visual Studio\2019\Preview\Common7\Tools\VsDevCmd.bat" ^
+    call "%ProgramFiles%\Microsoft Visual Studio\2022\Preview\Common7\Tools\VsDevCmd.bat" ^
     -host_arch=${{ parameters.hostArch }} -arch=${{ parameters.targetArch }} -no_logo
     cmake --build $(${{ parameters.buildOutputLocationVar }})
   displayName: 'Build the STL'

azure-devops/enforce-clang-format.cmd

@@ -1,6 +1,6 @@
 :: Copyright (c) Microsoft Corporation.
 :: SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
-call "%PROGRAMFILES(X86)%\Microsoft Visual Studio\2019\Preview\Common7\Tools\VsDevCmd.bat" ^
+call "%ProgramFiles%\Microsoft Visual Studio\2022\Preview\Common7\Tools\VsDevCmd.bat" ^
 -host_arch=amd64 -arch=amd64 -no_logo
 "%1" "clang-format.exe -style=file -i" ^
 stl/inc ^

azure-devops/provision-image.ps1

@@ -133,13 +133,14 @@ $Workloads = @(
   'Microsoft.VisualStudio.Component.VC.Tools.ARM',
   'Microsoft.VisualStudio.Component.VC.Tools.ARM64',
   'Microsoft.VisualStudio.Component.VC.Tools.x86.x64',
+  # TRANSITION, LLVM-51128 (Clang 12 targeting ARM64 is incompatible with WinSDK 10.0.20348.0)
   'Microsoft.VisualStudio.Component.Windows10SDK.19041'
 )
 
 $ReleaseInPath = 'Preview'
 $Sku = 'Enterprise'
-$VisualStudioBootstrapperUrl = 'https://aka.ms/vs/16/pre/vs_enterprise.exe'
-$PythonUrl = 'https://www.python.org/ftp/python/3.9.5/python-3.9.5-amd64.exe'
+$VisualStudioBootstrapperUrl = 'https://aka.ms/vs/17/pre/vs_enterprise.exe'
+$PythonUrl = 'https://www.python.org/ftp/python/3.9.6/python-3.9.6-amd64.exe'
 
 # https://docs.microsoft.com/en-us/windows-hardware/drivers/download-the-wdk
 $WindowsDriverKitUrl = 'https://go.microsoft.com/fwlink/?linkid=2128854'

azure-devops/run-tests.yml

@@ -25,7 +25,7 @@ steps:
   inputs:
     workingDirectory: $(${{ parameters.buildOutputLocationVar }})
     script: |
-      call "%PROGRAMFILES(X86)%\Microsoft Visual Studio\2019\Preview\Common7\Tools\VsDevCmd.bat" ^
+      call "%ProgramFiles%\Microsoft Visual Studio\2022\Preview\Common7\Tools\VsDevCmd.bat" ^
       -host_arch=${{ parameters.hostArch }} -arch=${{ parameters.targetArch }} -no_logo
       ctest -V
   env: { TMP: $(tmpDir), TEMP: $(tmpDir) }

azure-pipelines.yml

@@ -8,7 +8,7 @@ variables:
   buildOutputLocation: 'D:\build'
   vcpkgLocation: '$(Build.SourcesDirectory)/vcpkg'
 
-pool: 'StlBuild-2021-06-15'
+pool: 'StlBuild-2021-07-18'
 
 stages:
   - stage: Code_Format
@@ -33,7 +33,7 @@ stages:
               if exist "$(buildOutputLocation)" (
                 rmdir /S /Q "$(buildOutputLocation)"
               )
-              call "%PROGRAMFILES(X86)%\Microsoft Visual Studio\2019\Preview\Common7\Tools\VsDevCmd.bat" ^
+              call "%ProgramFiles%\Microsoft Visual Studio\2022\Preview\Common7\Tools\VsDevCmd.bat" ^
               -host_arch=amd64 -arch=amd64 -no_logo
               cmake -G Ninja -DCMAKE_CXX_COMPILER=cl -DCMAKE_BUILD_TYPE=Release ^
               -S $(Build.SourcesDirectory)\tools -B $(buildOutputLocation)
@@ -59,26 +59,26 @@ stages:
               arguments: '$(buildOutputLocation)/validate/validate.exe'
             env: { TMP: $(tmpDir), TEMP: $(tmpDir) }
 
-  - stage: Build_And_Test_x86
+  - stage: Build_And_Test_x64
     dependsOn: Code_Format
     displayName: 'Build and Test'
     jobs:
       - template: azure-devops/native-build-test.yml
         parameters:
-          targetPlatform: x86
-          vsDevCmdArch: x86
+          targetPlatform: x64
+          vsDevCmdArch: amd64
 
-  - stage: Build_And_Test_x64
-    dependsOn: Build_And_Test_x86
+  - stage: Build_And_Test_x86
+    dependsOn: Build_And_Test_x64
     displayName: 'Build and Test'
     jobs:
       - template: azure-devops/native-build-test.yml
         parameters:
-          targetPlatform: x64
-          vsDevCmdArch: amd64
+          targetPlatform: x86
+          vsDevCmdArch: x86
 
   - stage: Build_ARM
-    dependsOn: Build_And_Test_x86
+    dependsOn: Build_And_Test_x64
     displayName: 'Build'
     jobs:
       - template: azure-devops/cross-build.yml
@@ -87,7 +87,7 @@ stages:
           vsDevCmdArch: arm
 
   - stage: Build_ARM64
-    dependsOn: Build_And_Test_x86
+    dependsOn: Build_And_Test_x64
     displayName: 'Build'
     jobs:
       - template: azure-devops/cross-build.yml